handle risk of orphan blur event listeners by making sure tourId is set

Geraint2 · Geraint2 · commit 0cd24e369800 · 2023-07-06T13:08:33.000+01:00
config option to decide if we should focus on target element when the step is visible
allow custom focus target
Fire custom events guided-tour-show-step,  guided-tour-before-show-step on focus or main target element
Allow setting pre step display and on step display mouse/pointer events to simulate user performing actions prior to undertaking the step - useful for ensuring elements such as sub menu items are visible
New unique tour alias/identifier
Start of work on context specific tour triggers
Parameters tab when editing a step only shows if its relevant
diff --git a/administrator/components/com_guidedtours/forms/step.xml b/administrator/components/com_guidedtours/forms/step.xml
@@ -227,7 +227,123 @@
 				</field>
 
 			</fieldset>
+
+		<fieldset name="speciaactions" label="COM_GUIDEDTOURS_FIELD_SPECIAL_ACTIONS_LABEL">
+
+			<field
+					name="setfocus"
+					type="radio"
+					label="COM_GUIDEDTOURS_SET_FOCUS_LABEL"
+					description="COM_GUIDEDTOURS_SET_FOCUS_DESC"
+					showon=".type:0,2"
+					layout="joomla.form.field.radio.switcher"
+					filter="integer"
+					validate="options"
+					default="1"
+			>
+				<option value="0">JNO</option>
+				<option value="1">JYES</option>
+			</field>
+
+			<field
+					name="customfocustarget"
+					type="radio"
+					label="COM_GUIDEDTOURS_CUSTOM_FOCUS_TARGET_LABEL"
+					description="COM_GUIDEDTOURS_CUSTOM_FOCUS_TARGET_DESC"
+					showon=".type:0,2[AND]setfocus:1"
+					layout="joomla.form.field.radio.switcher"
+					filter="integer"
+					validate="options"
+					default="0"
+			>
+				<option value="0">JNO</option>
+				<option value="1">JYES</option>
+			</field>
+			<field
+					name="focustarget"
+					type="text"
+					label="COM_GUIDEDTOURS_FOCUS_TARGET_LABEL"
+					description="COM_GUIDEDTOURS_FOCUS_TARGET_DESC"
+					showon=".type:0,2[AND]customfocustarget:1[AND]setfocus:1"
+					default=""
+			/>
+
+			<field
+					name="predisplayevents"
+					type="subform"
+					label="COM_GUIDEDTOURS_PRE_DISPLAY_EVENTS_LABEL"
+					description="COM_GUIDEDTOURS_PRE_DISPLAY_EVENTS_DESC"
+					showon=".type:0,2"
+					multiple="true"
+					layout="joomla.form.field.subform.repeatable-table"
+			>
+				<form>
+					<field
+							name="predisplayeventelement"
+							type="test"
+							label="COM_GUIDEDTOURS_PRE_DISPLAY_EVENT_ELEMENT_LABEL"
+							description="COM_GUIDEDTOURS_PRE_DISPLAY_EVENT_ELEMENT_DESC"
+							default=""
+							required="true"
+					/>
+					<field
+							name="predisplayevent"
+							type="list"
+							label="COM_GUIDEDTOURS_PRE_DISPLAY_EVENT_LABEL"
+							description="COM_GUIDEDTOURS_PRE_DISPLAY_EVENT_DESC"
+							multiple="true"
+							required="true"
+							layout="joomla.form.field.list-fancy-select"
+							default=""
+							showon="predisplayeventelement!:"
+					>
+						<option value="click">COM_GUIDEDTOURS_CLICK</option>
+						<option value="dblclick">COM_GUIDEDTOURS_DOUBLE_CLICK</option>
+						<option value="pointerenter">COM_GUIDEDTOURS_POINTERENTER</option>
+						<option value="mouseover">COM_GUIDEDTOURS_MOUSEOVER</option>
+					</field>
+				</form>
+			</field>
+
+			<field
+					name="ondisplayevents"
+					type="subform"
+					label="COM_GUIDEDTOURS_ON_DISPLAY_EVENTS_LABEL"
+					description="COM_GUIDEDTOURS_ON_DISPLAY_EVENTS_DESC"
+					showon=".type:0,2"
+					multiple="true"
+					layout="joomla.form.field.subform.repeatable-table"
+			>
+				<form>
+					<field
+							name="ondisplayeventelement"
+							type="test"
+							label="COM_GUIDEDTOURS_ON_DISPLAY_EVENT_ELEMENT_LABEL"
+							description="COM_GUIDEDTOURS_ON_DISPLAY_EVENT_ELEMENT_DESC"
+							default=""
+							required="true"
+					/>
+					<field
+							name="ondisplayevent"
+							type="list"
+							label="COM_GUIDEDTOURS_ON_DISPLAY_EVENT_LABEL"
+							description="COM_GUIDEDTOURS_ON_DISPLAY_EVENT_DESC"
+							multiple="true"
+							required="true"
+							layout="joomla.form.field.list-fancy-select"
+							default=""
+							showon="ondisplayeventelement!:"
+					>
+						<option value="click">COM_GUIDEDTOURS_CLICK</option>
+						<option value="dblclick">COM_GUIDEDTOURS_DOUBLE_CLICK</option>
+						<option value="pointerenter">COM_GUIDEDTOURS_POINTERENTER</option>
+						<option value="mouseover">COM_GUIDEDTOURS_MOUSEOVER</option>
+					</field>
+				</form>
+			</field>
+
 		</fieldset>
+	</fieldset>
 	</fields>
 
 </form>
diff --git a/administrator/components/com_guidedtours/forms/tour.xml b/administrator/components/com_guidedtours/forms/tour.xml
@@ -27,11 +27,12 @@
 	/>
 
 	<field
-			name="alias"
-			type="text"
-			label="COM_GUIDEDTOURS_TOUR_ALIAS"
-			description="COM_GUIDEDTOURS_TOUR_ALIAS_DESC"
-			required="false"
+		name="alias"
+		type="text"
+		label="COM_GUIDEDTOURS_TOUR_ALIAS_LABEL"
+		description="COM_GUIDEDTOURS_TOUR_ALIAS_DESC"
+		hint="COM_GUIDEDTOURS_TOUR_ALIAS_HINT"
+		required="false"
 	/>
 
 	<field
@@ -159,4 +160,50 @@
 		>
 		<option value="*">JALL</option>
 	</field>
+<!--
+	<fields name="params">
+
+		<fieldset name="options">
+
+			<fieldset name="requiredvalues" label="COM_GUIDEDTOURS_CONTEXT_SENSITIVE_FILTERING_LABEL">
+
+				<field
+					name="matchingcriteria_note"
+					type="note"
+					label="COM_GUIDEDTOURS_MATCHING_CRITERIA_NOTE_LABEL"
+					description="COM_GUIDEDTOURS_MATCHING_CRITERIA_NOTE_DESC"
+				/>
+
+				<field
+					name="matchingcriteria"
+					type="subform"
+					label="COM_GUIDEDTOURS_MATCHING_CRITERIA_LABEL"
+					description="COM_GUIDEDTOURS_MATCHING_CRITERIA_DESC"
+					multiple="true"
+					layout="joomla.form.field.subform.repeatable-table"
+				>
+					<form>
+						<field
+							name="key"
+							type="text"
+							size="20"
+							filter="safehtml"
+							label="COM_GUIDEDTOURS_MATCHING_CRITERIA_GET_OR_POST_KEY_LABEL"
+							description="COM_GUIDEDTOURS_MATCHING_CRITERIA_GET_OR_POST_KEY_DESC"
+							validate="options"
+						/>
+						<field
+							name="value"
+							type="text"
+							size="20"
+							filter="safehtml"
+							label="COM_GUIDEDTOURS_MATCHING_CRITERIA_GET_OR_POST_VALUE_LABEL"
+							description="COM_GUIDEDTOURS_MATCHING_CRITERIA_GET_OR_POST_VALUE_DESC"
+						/>
+					</form>
+				</field>
+			</fieldset>
+		</fieldset>
+	</fields>
+-->
 </form>
diff --git a/administrator/components/com_guidedtours/src/Model/TourModel.php b/administrator/components/com_guidedtours/src/Model/TourModel.php
@@ -238,7 +238,7 @@ public function getItem($pk = null)
             $result->description_translation = Text::_($result->description);
         }
 
-        if (empty($result->alias)) {
+        if (empty($result->alias) && (int) $pk > 0) {
             $app        = Factory::getApplication();
             $uri        = Uri::getInstance();
             $host       = $uri->toString(['host']);
diff --git a/administrator/components/com_guidedtours/src/Model/ToursModel.php b/administrator/components/com_guidedtours/src/Model/ToursModel.php
@@ -15,6 +15,7 @@
 use Joomla\CMS\MVC\Model\ListModel;
 use Joomla\Database\ParameterType;
 use Joomla\Registry\Registry;
+use Joomla\CMS\Uri\Uri;
 use Joomla\Utilities\ArrayHelper;
 
 // phpcs:disable PSR1.Files.SideEffects
@@ -82,6 +83,9 @@ protected function populateState($ordering = 'a.ordering', $direction = 'ASC')
 
         $this->setState('filter.extension', $extension);
 
+        // By default we don't constrain tours by context
+        $this->setState('filter.contextspecific', 0);
+
         parent::populateState($ordering, $direction);
     }
 
@@ -166,11 +170,13 @@ public function getListQuery()
 
         // Filter by extension
         if ($extensionfilter = $this->getState('filter.extensionfilter')) {
+            //$query->where(':extensions MEMBER OF(' . $db->quoteName('a.extensions') . ')')->bind([':extensions'], $extensionfilter);
             $extension = '%' . $extensionfilter . '%';
             $query->where(
                 $db->quoteName('a.extensions') . ' LIKE :extensions'
             )
                   ->bind([':extensions'], $extension);
+
         } elseif ($extension = $this->getState('filter.extension')) {
             $extension = '%' . $extension . '%';
             $all       = '%*%';
@@ -212,6 +218,17 @@ public function getListQuery()
             $query->whereIn($db->quoteName('a.language'), $language, ParameterType::STRING);
         }
 
+        // Filter by context
+        /*
+        $contextspecific = $this->getState('filter.contextspecific');
+        if ($contextspecific) {
+            $uri = Uri::getInstance();
+            $url = trim($uri->toString(['path', 'query']), '/');
+            $url = "administrator/index.php?option=com_content&view=articles";
+            $query->where($db->quoteName('a.url') . ' = :context')
+                ->bind(':context', $url, ParameterType::STRING);
+        }
+        */
         // Filter by search in title.
         $search = $this->getState('filter.search');
 
diff --git a/administrator/components/com_guidedtours/tmpl/step/edit.php b/administrator/components/com_guidedtours/tmpl/step/edit.php
@@ -20,7 +20,7 @@
 $wa = $this->document->getWebAssetManager();
 $wa->useScript('keepalive')
    ->useScript('form.validate')
-    ->useScript('com_guidedtours.tour-edit');
+   ->useScript('com_guidedtours.tour-edit');
 
 if (empty($this->item->tour_id)) {
     throw new GenericDataException("\nThe Tour id was not set!\n", 500);
diff --git a/administrator/components/com_guidedtours/tmpl/tour/edit.php b/administrator/components/com_guidedtours/tmpl/tour/edit.php
@@ -24,7 +24,10 @@
 /** @var Joomla\CMS\WebAsset\WebAssetManager $wa */
 $wa = $this->document->getWebAssetManager();
 $wa->useScript('keepalive')
-    ->useScript('form.validate');
+    ->useScript('form.validate')
+    ->useScript('com_guidedtours.tour-edit');
+
+$this->useCoreUI = true;
 ?>
 
 <form action="<?php echo Route::_('index.php?option=com_guidedtours&view=tour&layout=edit&id=' .
@@ -76,6 +79,8 @@
         </div>
         <?php echo HTMLHelper::_('uitab.endTab'); ?>
 
+        <?php echo LayoutHelper::render('joomla.edit.params', $this); ?>
+
         <?php echo HTMLHelper::_('uitab.addTab', 'myTab', 'publishing', Text::_('JGLOBAL_FIELDSET_PUBLISHING')); ?>
         <div class="row">
             <div class="col-12 col-lg-8">
diff --git a/administrator/language/en-GB/com_guidedtours.ini b/administrator/language/en-GB/com_guidedtours.ini
@@ -52,8 +52,9 @@ COM_GUIDEDTOURS_STEP_NEW_STEP="New Step"
 COM_GUIDEDTOURS_STEP_POSITION_DESC="Select the position of the step popup, relative to the element it points to."
 COM_GUIDEDTOURS_STEP_POSITION_LABEL="Position"
 COM_GUIDEDTOURS_STEP_TITLE="Title"
-COM_GUIDEDTOURS_TOUR_ALIAS="Tour Identifier"
+COM_GUIDEDTOURS_TOUR_ALIAS_LABEL="Tour Identifier"
 COM_GUIDEDTOURS_TOUR_ALIAS_DESC="If you are sharing your tour on any other websites then the Tour Identifier needs to be unique.<br>We suggest a format such as AUTHORNAME-TOURNAME, COMPANYNAME-TOURNAME, SITEDOMAIN-TOURNAME.<br/>If no identifier is provided a value will be computed for you."
+COM_GUIDEDTOURS_TOUR_ALIAS_HINT="Unique identifier e.g. tour-author-site-domain-tour-name"
 COM_GUIDEDTOURS_STEP_TITLE_TRANSLATION="Title (%s)"
 COM_GUIDEDTOURS_STEP_TARGET_DESC="The target element the step will be attached to. Options: .classname, #id, any selector following the CSS syntax (make sure it is a focusable element if the step is interactive), or leave blank for a centered step."
 COM_GUIDEDTOURS_STEP_TARGET_LABEL="Target"
@@ -88,4 +89,30 @@ COM_GUIDEDTOURS_URL_DESC="Enter the relative URL of the page from where you want
 COM_GUIDEDTOURS_XML_DESCRIPTION="Component for managing Guided Tours functionality."
 COM_GUIDEDTOURS_FILTER_EXTENSION_LABEL="Selected Component"
 COM_GUIDEDTOURS_FILTER_EXTENSION_DESC="Component that restrict a tour to be displayed only when the selected component is active."
-COM_GUIDEDTOURS_FILTER_SELECT_TOUR_COMPONENT="Select Component"
+COM_GUIDEDTOURS_FILTER_SELECT_TOUR_COMPONENT="Select Component"
+COM_GUIDEDTOURS_CONTEXT_SENSITIVE_FILTERING_LABEL="Additional Context Specific Criteria"
+COM_GUIDEDTOURS_MATCHING_CRITERIA_NOTE_LABEL="Criteria to match the tour to the user's site actions/page"
+COM_GUIDEDTOURS_MATCHING_CRITERIA_NOTE_DESC="You can set a series additional key/value pairs that will be used to match tours that are most relevant to the page being viewed/action undertaken.<br>Key/Value pairs will be taken from the tour URL and added to the list below when matching context sensitive tours.<br>You can add as many criteria as you wish but they must all be matched to take effect."
+COM_GUIDEDTOURS_MATCHING_CRITERIA_LABEL="Criteria to match"
+COM_GUIDEDTOURS_MATCHING_CRITERIA_DESC="These criteria must all be matched for this tour to be highlights are relevant to the user's actions."
+COM_GUIDEDTOURS_MATCHING_CRITERIA_GET_OR_POST_KEY_LABEL="Form or URL key"
+COM_GUIDEDTOURS_MATCHING_CRITERIA_GET_OR_POST_KEY_DESC="The variable name to match in the URL or POST variables.  The matching takes place after a SET URL has been converted to a native Joomla URL"
+COM_GUIDEDTOURS_MATCHING_CRITERIA_GET_OR_POST_VALUE_LABEL="Form or URL key"
+COM_GUIDEDTOURS_MATCHING_CRITERIA_GET_OR_POST_VALUE_DESC="The variable value to match in the URL or POST variables."
+COM_GUIDEDTOURS_FIELD_SPECIAL_ACTIONS_LABEL="Special Actions"
+COM_GUIDEDTOURS_SET_FOCUS_LABEL="Set Focus on Target Element When Step is Displayed"
+COM_GUIDEDTOURS_SET_FOCUS_DESC="When the step is displayed sets the browser focus on the target element (or custom target element set below)"
+COM_GUIDEDTOURS_CUSTOM_FOCUS_TARGET_LABEL="Custom Focus/Required Value Element"
+COM_GUIDEDTOURS_CUSTOM_FOCUS_TARGET_DESC="You can set the focus on a DOM element different to main the target element by specifying a CSS selector here.  If a required action or value is set then this will apply to this custom focus element as opposed to the display target element."
+COM_GUIDEDTOURS_FOCUS_TARGET_LABEL="Focus/Required Value Target"
+COM_GUIDEDTOURS_FOCUS_TARGET_DESC="The DOM Element that should receive focus on this step if different to the main target element.  If left blank then the main target element will receive the DOM focus when the step dis displayed"
+COM_GUIDEDTOURS_PRE_DISPLAY_EVENTS_LABEL="Pre Step Display Event Triggers"
+COM_GUIDEDTOURS_PRE_DISPLAY_EVENTS_DESC="If you wish to trigger DOM events prior to displaying the step you can specify the event element and the DOM event to fire.  These should NOT cause a form submission or the page to redirect otherwise the tour will lose its position."
+COM_GUIDEDTOURS_PRE_DISPLAY_EVENT_ELEMENT_LABEL="Element on which to trigger an event"
+COM_GUIDEDTOURS_PRE_DISPLAY_EVENT_ELEMENT_DESC="CSS selector for the element on which the event should be fired"
+COM_GUIDEDTOURS_PRE_DISPLAY_EVENT_LABEL="Event(s) to trigger on the specified element"
+COM_GUIDEDTOURS_PRE_DISPLAY_EVENT_DESC="Select one or more DOM events to fire on the specified element"
+COM_GUIDEDTOURS_CLICK="Click"
+COM_GUIDEDTOURS_DOUBLE_CLICK="Double Click"
+COM_GUIDEDTOURS_MOUSEOVER="Mouse Over"
+COM_GUIDEDTOURS_POINTERENTER="Pointer Enter"
diff --git a/administrator/modules/mod_guidedtours/src/Helper/GuidedToursHelper.php b/administrator/modules/mod_guidedtours/src/Helper/GuidedToursHelper.php
@@ -52,6 +52,11 @@ public function getTours(Registry $params, AdministratorApplication $app)
             $tourModel->setState('filter.language', ['*', $app->getLanguage()->getTag()]);
         }
 
+        $hideLinks = $app->getInput()->getBool('hidemainmenu');
+        if ($hideLinks) {
+            $tourModel->setState('filter.contextspecific', 1);
+        }
+        
         $items = $tourModel->getItems();
 
         foreach ($items as $key => $item) {
diff --git a/administrator/modules/mod_guidedtours/tmpl/default.php b/administrator/modules/mod_guidedtours/tmpl/default.php
@@ -14,9 +14,7 @@
 use Joomla\CMS\Language\Text;
 use Joomla\CMS\Uri\Uri;
 
-$hideLinks = $app->getInput()->getBool('hidemainmenu');
-
-if ($hideLinks || !$tours) {
+if (!$tours) {
     return;
 }
 
diff --git a/build/media_source/com_guidedtours/js/tour-edit.es6.js b/build/media_source/com_guidedtours/js/tour-edit.es6.js
@@ -15,7 +15,13 @@
           return;
         }
         const visibleChildren = fieldset.querySelectorAll(':scope .control-group:not(.hidden)');
-        if (visibleChildren.length) {
+        let countVisible = 0;
+        visibleChildren.forEach((visibleChild) => {
+          if (!visibleChild.closest('.control-group.hidden')) {
+            countVisible += 1;
+          }
+        });
+        if (countVisible) {
           fieldset.classList.remove('hidden');
         } else {
           fieldset.classList.add('hidden');
@@ -25,7 +31,13 @@
         const tabLabel = document.querySelector(`button[aria-controls="${tabelement.id}"]`);
         if (tabLabel) {
           const visibleChildren = tabelement.querySelectorAll(':scope .control-group:not(.hidden)');
-          if (visibleChildren.length) {
+          let countVisible = 0;
+          visibleChildren.forEach((visibleChild) => {
+            if (!visibleChild.closest('.control-group.hidden')) {
+              countVisible += 1;
+            }
+          });
+          if (countVisible) {
             tabLabel.removeAttribute('hidden');
           } else {
             tabLabel.setAttribute('hidden', 'hidden');
diff --git a/build/media_source/plg_system_guidedtours/js/guidedtours.es6.js b/build/media_source/plg_system_guidedtours/js/guidedtours.es6.js

Original file line number	Diff line number	Diff line change
`@@ -238,7 +238,7 @@ public function getItem($pk = null)`
`238`	`238`	`$result->description_translation = Text::_($result->description);`
`239`	`239`	`}`
`240`	`240`
`241`		`- if (empty($result->alias)) {`
	`241`	`+ if (empty($result->alias) && (int) $pk > 0) {`
`242`	`242`	`$app = Factory::getApplication();`
`243`	`243`	`$uri = Uri::getInstance();`
`244`	`244`	`$host = $uri->toString(['host']);`
Original file line number	Diff line number	Diff line change
`@@ -14,9 +14,7 @@`
`14`	`14`	`use Joomla\CMS\Language\Text;`
`15`	`15`	`use Joomla\CMS\Uri\Uri;`
`16`	`16`
`17`		`-$hideLinks = $app->getInput()->getBool('hidemainmenu');`
`18`		`-`
`19`		`-if ($hideLinks \|\| !$tours) {`
	`17`	`+if (!$tours) {`
`20`	`18`	`return;`
`21`	`19`	`}`
`22`	`20`