ISSUE-23: New Panorama Builder Webform Element

[DiegoPino]

What is new panorama?

See #24 23

There is just too much here:

• New WALL-OF-JS to deal with adding hotspots, keeping track, etc.
• CSS
• The new Webform Element.
• Writes and reads JSON structures for Panorama Tours. And it does it well.
  Example:

{
 "panorama_tour": [
        {
            "scene": "18",
            "hotspots": [
                {
                    "id": "panorama_tour_1",
                    "yaw": "78.53138342389244",
                    "text": "To the Other scene by the lake",
                    "type": "scene",
                    "pitch": "-0.7553843066484961",
                    "sceneId": "17"
                }
            ]
        },
        {
            "scene": "17",
            "hotspots": [
                {
                    "id": "panorama_tour_6",
                    "yaw": "98.9895801803955",
                    "text": "Path Down",
                    "type": "scene",
                    "pitch": "-23.966429397715082",
                    "sceneId": "18"
                },
                {
                    "id": "panorama_tour_7",
                    "yaw": "-60.1068717869932",
                    "text": "Path Up",
                    "type": "info",
                    "pitch": "3.4297621386408266"
                },
                {
                    "id": "panorama_tour_8",
                    "yaw": "-6.4162014764956865",
                    "text": "Base of the path by the lake",
                    "type": "info",
                    "pitch": "-13.273733747760536"
                },
                {
                    "id": "panorama_tour_10",
                    "yaw": "78.53138342389244",
                    "text": "back to another Scene",
                    "type": "scene",
                    "pitch": "-0.7553843066484961",
                    "sceneId": "16"
                }
            ]
        },
        {
            "scene": "16",
            "hotspots": [
                {
                    "id": "panorama_tour_11",
                    "yaw": "78.53138342389244",
                    "text": "To the Other scene by the lake",
                    "type": "scene",
                    "pitch": "-0.7553843066484961",
                    "sceneId": "17"
                }
            ]
        }
    ]
}

• You can add Hospots of 3 types, Text, Other ADOs, To Other Panoramas as Scenes.
• New Drupal Ajax Command to add hotspots on the fly
• This brings also an improvement to the Entity Reference View Display we had. Now we can render out Thumbnails! Means visual auto autoselect! See ISSUE-20: SearchAPI/Views driven Entity Reference Autocomplete #21 Also, this fixes something that has been open in Core D8 for years (at least for us, us that like Solr)
• Sadly it requires a patch in Webforms (see commented piece)
  if ($element['#selection_handler'] != 'views') { //$options = self::translateOptions($options, $element); }

This should become a patch for archipelago-deployment. Best solution would be to actually check if the #selection_handler set is an actual views, even a custom one. Instead of assuming all is provided by core. We are not CORE!

at \Drupal\webform\Element\WebformEntityTrait::setOptions
Because it assumes that views is the only views selection handler possible. Leaving our custom Solr Views Work out! And we did a great job convincing D8 that ours is legit and follows the path to greatness! But not webfoms... webforms does not like it.

Finally. Found out that Webforms module can only Save Submissions (no worries, not our SBF, those are handled by us!) like the ones that go into logs and its own Database that are 2 levels deep. Another big bug. So yeah.... 2 AM. We should force disable that option (override settings) when using our own Webform Handler. I need to sleep.

@todo (next iteration since this is a beta2 and its already too large).

• Check validation callbacks for each tiny little field. We have many
• Check Delete scenes on existing large panoramas. Should work in every case
• Check if we can add a second UUID key to the panorama in case something needs to be reingested. This can really just be done when serializing things out and not in live data. Just an idea
• Make code smaller. Its HUGE.

There were quite some issues on the fact i was building a Full app inside a single Form element, so the solution is over worked and required tapping into the whole formBuilder class and looking at the exact data flow inside the form states. For security, consistency, we keep now the full 'All Scenes' complex array inside a Form State Value but also as an input Value, serialized as a JSON string in a hidden field. Feels over-engineered, but for some Webform reason, Value elements don't play well/nor are seeing by the ValueCallback and the Composite Webform base class.

[DiegoPino]

Note to myself. This is affecting the Webform interaction when using them as ingest method. If this element is in any other step that the first, when pressed it resets the step counter (which Webform provides) and we go to step 1.

[DiegoPino]

@marlo-longley i need this in for this iteration of Beta2. I know this has details all over the place but nothing serious breaking. So i will move forward merging. Please give this a look anyway and give it a general code reading. THERE IS A LOT! so feel free to comment inline and make questions. There is next-level code here (like the better Entity Selection View Handler) and also good old known friends. Beta2 process will mean we have 2-3 weeks for fix issues and then pack and move to Beta3. So nothing is final until it is. Thanks

[DiegoPino]

@giancarlobi i know you are so busy. But if you could (after merge, no pressure) just look at the files that changed here it would be great, mostly so you know where we are going. We will be constructing on some of this work for runners and also for IIIF (entity selection piece to push data of collection members into the IIIF Collection manifest Twig). I also know not this weekend, you have a quite heavy week. But i can't help myself mentioning you here!!

[DiegoPino]

Lastly @marlo-longley and @giancarlobi, since i never do such large pull requests i will not squash me merge here. I will keep each individual (including my failures) commits around so we can go back to each piece if needed. Feels better so. Thanks (now you are free of me!)