[5.0] Tours alias language

administrator/components/com_admin/script.php

@@ -10,6 +10,7 @@
  * @phpcs:disable PSR1.Classes.ClassDeclaration.MissingNamespace
  */
 
+use Joomla\CMS\Application\ApplicationHelper;
 use Joomla\CMS\Extension\ExtensionHelper;
 use Joomla\CMS\Factory;
 use Joomla\CMS\Filesystem\File;
@@ -18,6 +19,7 @@
 use Joomla\CMS\Language\Text;
 use Joomla\CMS\Log\Log;
 use Joomla\CMS\Table\Table;
+use Joomla\CMS\Uri\Uri;
 use Joomla\Database\ParameterType;
 
 // phpcs:disable PSR1.Files.SideEffects
@@ -2252,6 +2254,8 @@ public function postflight($action, $installer)
             return false;
         }
 
+        $this->setGuidedToursUid();
+
         return true;
     }
 
@@ -2359,6 +2363,68 @@ private function migrateTinymceConfiguration(): bool
         return true;
     }
 
+    /**
+     * setup Guided Tours Unique Identifiers
+     *
+     * @return  boolean  True on success
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    private function setGuidedToursUid()
+    {
+        /** @var \Joomla\Component\Cache\Administrator\Model\CacheModel $model */
+        $model = Factory::getApplication()->bootComponent('com_guidedtours')->getMVCFactory()
+                        ->createModel('Tours', 'Administrator', ['ignore_request' => true]);
+
+        $items = $model->getItems();
+
+        foreach ($items as $item) {
+            // Set uid for tours where it is empty
+            if (empty($item->uid)) {
+                $tourItem = $model->getTable('Tour');
+                $tourItem->load($item->id);
+
+                // Tour follows Joomla naming convention
+                if (str_starts_with($tourItem->title, 'COM_GUIDEDTOURS_TOUR_') && str_ends_with($tourItem->title, '_TITLE')) {
+                    $uidTitle = 'joomla_' . str_replace('COM_GUIDEDTOURS_TOUR_', '', $tourItem->title);
+
+                    // Remove the last _TITLE part
+                    $pos = strrpos($uidTitle, '_TITLE');
+                    if ($pos !== false) {
+                        $uidTitle = substr($uidTitle, 0, $pos);
+                    }
+                } elseif (preg_match('#COM_(\w+)_TOUR_#', $tourItem->title) && str_ends_with($tourItem->title, '_TITLE')) {
+                    // Tour follows component naming pattern
+                    $uidTitle = preg_replace('#COM_(\w+)_TOUR_#', '$1.', $tourItem->title);
+
+                    // Remove the last _TITLE part
+                    $pos = strrpos($uidTitle, "_TITLE");
+                    if ($pos !== false) {
+                        $uidTitle = substr($uidTitle, 0, $pos);
+                    }
+                } else {
+                    $uri      = Uri::getInstance();
+                    $host     = $uri->toString(['host']);
+                    $host     = ApplicationHelper::stringURLSafe($host, $tourItem->language);
+                    $uidTitle = $host . ' ' . str_replace('COM_GUIDEDTOURS_TOUR_', '', $tourItem->title);
+                    // Remove the last _TITLE part
+                    if (str_ends_with($uidTitle, '_TITLE')) {
+                        $pos      = strrpos($uidTitle, '_TITLE');
+                        $uidTitle = substr($uidTitle, 0, $pos);
+                    }
+                }
+                // ApplicationHelper::stringURLSafe will replace a period (.) separator so we split the construction into multiple parts
+                $uidTitleParts = explode('.', $uidTitle);
+                array_walk($uidTitleParts, function (&$value, $key, $tourLanguage) {
+                    $value = ApplicationHelper::stringURLSafe($value, $tourLanguage);
+                }, $tourItem->language);
+                $tourItem->uid = implode('.', $uidTitleParts);
+
+                $tourItem->store();
+            }
+        }
+    }
+
     /**
      * Renames or removes incorrectly cased files.
      *

administrator/components/com_admin/sql/updates/mysql/5.0.0-2023-08-29.sql

@@ -0,0 +1,14 @@
+ALTER TABLE `#__guidedtours` ADD COLUMN `uid` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_bin NOT NULL AFTER `title`/** CAN FAIL **/;
+ALTER TABLE `#__guidedtours` ADD INDEX `idx_uid` (`uid`(191)) /** CAN FAIL **/;
+
+UPDATE `#__guidedtours` SET `uid` = 'joomla-guidedtours' WHERE `title` = 'COM_GUIDEDTOURS_TOUR_GUIDEDTOURS_TITLE';
+UPDATE `#__guidedtours` SET `uid` = 'joomla-guidedtoursteps' WHERE `title` = 'COM_GUIDEDTOURS_TOUR_GUIDEDTOURSTEPS_TITLE';
+UPDATE `#__guidedtours` SET `uid` = 'joomla-articles'  WHERE `title` = 'COM_GUIDEDTOURS_TOUR_ARTICLES_TITLE';
+UPDATE `#__guidedtours` SET `uid` = 'joomla-categories' WHERE `title` = 'COM_GUIDEDTOURS_TOUR_CATEGORIES_TITLE';
+UPDATE `#__guidedtours` SET `uid` = 'joomla-menus' WHERE `title` = 'COM_GUIDEDTOURS_TOUR_MENUS_TITLE';
+UPDATE `#__guidedtours` SET `uid` = 'joomla-tags' WHERE `title` = 'COM_GUIDEDTOURS_TOUR_TAGS_TITLE';
+UPDATE `#__guidedtours` SET `uid` = 'joomla-banners' WHERE `title` = 'COM_GUIDEDTOURS_TOUR_BANNERS_TITLE';
+UPDATE `#__guidedtours` SET `uid` = 'joomla-contacts' WHERE `title` = 'COM_GUIDEDTOURS_TOUR_CONTACTS_TITLE';
+UPDATE `#__guidedtours` SET `uid` = 'joomla-newsfeeds' WHERE `title` = 'COM_GUIDEDTOURS_TOUR_NEWSFEEDS_TITLE';
+UPDATE `#__guidedtours` SET `uid` = 'joomla-smartsearch' WHERE `title` = 'COM_GUIDEDTOURS_TOUR_SMARTSEARCH_TITLE';
+UPDATE `#__guidedtours` SET `uid` = 'joomla-users' WHERE `title` = 'COM_GUIDEDTOURS_TOUR_USERS_TITLE';

administrator/components/com_admin/sql/updates/postgresql/5.0.0-2023-08-29.sql

@@ -0,0 +1,14 @@
+ALTER TABLE "#__guidedtours" ADD COLUMN "uid" varchar(255) DEFAULT '' NOT NULL /** CAN FAIL **/;
+CREATE INDEX "#__guidedtours_idx_uid" ON "#__guidedtours" ("uid") /** CAN FAIL **/;
+
+UPDATE "#__guidedtours" SET "uid" = 'joomla-guidedtours' WHERE "title" = 'COM_GUIDEDTOURS_TOUR_GUIDEDTOURS_TITLE';
+UPDATE "#__guidedtours" SET "uid" = 'joomla-guidedtoursteps' WHERE "title" = 'COM_GUIDEDTOURS_TOUR_GUIDEDTOURSTEPS_TITLE';
+UPDATE "#__guidedtours" SET "uid" = 'joomla-articles'  WHERE "title" = 'COM_GUIDEDTOURS_TOUR_ARTICLES_TITLE';
+UPDATE "#__guidedtours" SET "uid" = 'joomla-categories' WHERE "title" = 'COM_GUIDEDTOURS_TOUR_CATEGORIES_TITLE';
+UPDATE "#__guidedtours" SET "uid" = 'joomla-menus' WHERE "title" = 'COM_GUIDEDTOURS_TOUR_MENUS_TITLE';
+UPDATE "#__guidedtours" SET "uid" = 'joomla-tags' WHERE "title" = 'COM_GUIDEDTOURS_TOUR_TAGS_TITLE';
+UPDATE "#__guidedtours" SET "uid" = 'joomla-banners' WHERE "title" = 'COM_GUIDEDTOURS_TOUR_BANNERS_TITLE';
+UPDATE "#__guidedtours" SET "uid" = 'joomla-contacts' WHERE "title" = 'COM_GUIDEDTOURS_TOUR_CONTACTS_TITLE';
+UPDATE "#__guidedtours" SET "uid" = 'joomla-newsfeeds' WHERE "title" = 'COM_GUIDEDTOURS_TOUR_NEWSFEEDS_TITLE';
+UPDATE "#__guidedtours" SET "uid" = 'joomla-smartsearch' WHERE "title" = 'COM_GUIDEDTOURS_TOUR_SMARTSEARCH_TITLE';
+UPDATE "#__guidedtours" SET "uid" = 'joomla-users' WHERE "title" = 'COM_GUIDEDTOURS_TOUR_USERS_TITLE';

administrator/components/com_guidedtours/forms/tour.xml

@@ -26,6 +26,15 @@
 		readonly="true"
 	/>
 
+	<field
+		name="uid"
+		type="text"
+		label="COM_GUIDEDTOURS_TOUR_UID_LABEL"
+		description="COM_GUIDEDTOURS_TOUR_UID_DESC"
+		hint="COM_GUIDEDTOURS_TOUR_UID_HINT"
+		required="false"
+	/>
+
 	<field
 		name="description"
 		type="editor"

administrator/components/com_guidedtours/src/Helper/GuidedtoursHelper.php

@@ -0,0 +1,104 @@
+<?php
+
+/**
+ * @package     Joomla.Administrator
+ * @subpackage  com_actionlogs
+ *
+ * @copyright   (C) 2018 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+namespace Joomla\Component\Guidedtours\Administrator\Helper;
+
+use Joomla\CMS\Factory;
+
+// phpcs:disable PSR1.Files.SideEffects
+\defined('_JEXEC') or die;
+// phpcs:enable PSR1.Files.SideEffects
+
+/**
+ * Guidedtours component helper.
+ *
+ * @since  __DEPLOY_VERSION__
+ */
+class GuidedtoursHelper
+{
+    /**
+     * Load the translation files for an Guided Tour
+     *
+     * @param   string  $uid    Guided Tour Unique Identifier
+     * @param   boolean $steps  Should tour steps language file be loaded
+     *
+     * @return  void
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    public static function loadTranslationFiles($uid, bool $steps = false)
+    {
+        static $cache = [];
+        $uid          = strtolower($uid);
+
+        if (isset($cache[$uid])) {
+            return;
+        }
+
+        $lang   = Factory::getLanguage();
+
+        // The uid has an extension separator so we need to check the extension language files
+        if (strpos($uid, '.') > 0) {
+            list($extension, $tourid) = explode('.', $uid, 2);
+
+            $source = '';
+
+            switch (substr($extension, 0, 3)) {
+                case 'com':
+                    $source = JPATH_ADMINISTRATOR . '/components/' . $extension;
+                    break;
+
+                case 'lib':
+                    $source = JPATH_LIBRARIES . '/' . substr($extension, 4);
+                    break;
+
+                case 'mod':
+                    $source = JPATH_SITE . '/modules/' . $extension;
+                    break;
+
+                case 'plg':
+                    $parts = explode('_', $extension, 3);
+
+                    if (\count($parts) > 2) {
+                        $source = JPATH_PLUGINS . '/' . $parts[1] . '/' . $parts[2];
+                    }
+                    break;
+
+                case 'pkg':
+                    $source = JPATH_SITE;
+                    break;
+
+                case 'tpl':
+                    $source = JPATH_BASE . '/templates/' . substr($extension, 4);
+                    break;
+
+                default:
+                    $source = JPATH_ADMINISTRATOR . '/components/com_' . $extension;
+                    break;
+            }
+
+            $lang->load($extension . '.' . str_replace('-', '_', $tourid), JPATH_ADMINISTRATOR)
+                || $lang->load($extension . '.' . str_replace('-', '_', $tourid), $source);
+            if ($steps) {
+                $lang->load($extension . '.' . str_replace('-', '_', $tourid) . '_steps', JPATH_ADMINISTRATOR)
+                    || $lang->load($extension . '.' . str_replace('-', '_', $tourid) . '_steps', JPATH_ADMINISTRATOR);
+            }
+        } else {
+            $lang->load('guidedtours.' . str_replace('-', '_', $uid), JPATH_ADMINISTRATOR);
+            if ($steps) {
+                $lang->load('guidedtours.' . str_replace('-', '_', $uid) . '_steps', JPATH_ADMINISTRATOR);
+            }
+        }
+
+        $cache[$uid] = true;
+
+        return;
+    }
+}

administrator/components/com_guidedtours/src/Model/StepModel.php

@@ -15,6 +15,7 @@
 use Joomla\CMS\MVC\Model\AdminModel;
 use Joomla\CMS\Object\CMSObject;
 use Joomla\CMS\Table\Table;
+use Joomla\Component\Guidedtours\Administrator\Helper\GuidedtoursHelper;
 
 // phpcs:disable PSR1.Files.SideEffects
 \defined('_JEXEC') or die;
@@ -237,25 +238,28 @@ protected function loadFormData()
      */
     public function getItem($pk = null)
     {
-        Factory::getLanguage()->load('com_guidedtours.sys', JPATH_ADMINISTRATOR);
-
         if ($result = parent::getItem($pk)) {
+            $app = Factory::getApplication();
+
+            /** @var \Joomla\Component\Guidedtours\Administrator\Model\TourModel $tourModel */
+            $tourModel = $app->bootComponent('com_guidedtours')
+            ->getMVCFactory()->createModel('Tour', 'Administrator', ['ignore_request' => true]);
+
             if (!empty($result->id)) {
+                // Editing an existing step
+                $tour = $tourModel->getItem($result->tour_id);
+
+                GuidedtoursHelper::loadTranslationFiles($tour->uid, true);
+
                 $result->title_translation       = Text::_($result->title);
                 $result->description_translation = Text::_($result->description);
             } else {
-                $app    = Factory::getApplication();
+                // Creating a new step so we get the tour id from the session data
                 $tourId = $app->getUserState('com_guidedtours.tour_id');
-
-                /** @var \Joomla\Component\Guidedtours\Administrator\Model\TourModel $tourModel */
-                $tourModel = $app->bootComponent('com_guidedtours')
-                    ->getMVCFactory()->createModel('Tour', 'Administrator', ['ignore_request' => true]);
-
-                $tour         = $tourModel->getItem($tourId);
-                $tourLanguage = !empty($tour->language) ? $tour->language : '*';
+                $tour   = $tourModel->getItem($tourId);
 
                 // Sets step language to parent tour language
-                $result->language = $tourLanguage;
+                $result->language = !empty($tour->language) ? $tour->language : '*';
 
                 // Set the step's tour id
                 $result->tour_id = $tourId;

administrator/components/com_guidedtours/src/Model/StepsModel.php

@@ -13,6 +13,7 @@
 use Joomla\CMS\Factory;
 use Joomla\CMS\Language\Text;
 use Joomla\CMS\MVC\Model\ListModel;
+use Joomla\Component\Guidedtours\Administrator\Helper\GuidedtoursHelper;
 use Joomla\Database\DatabaseQuery;
 use Joomla\Database\ParameterType;
 use Joomla\Utilities\ArrayHelper;
@@ -228,9 +229,23 @@ public function getItems()
     {
         $items = parent::getItems();
 
-        Factory::getLanguage()->load('com_guidedtours.sys', JPATH_ADMINISTRATOR);
-
+        $tourLanguageLoaded = false;
         foreach ($items as $item) {
+            if (!$tourLanguageLoaded) {
+                $app    = Factory::getApplication();
+                $tourId = $item->tour_id;
+
+                /** @var \Joomla\Component\Guidedtours\Administrator\Model\TourModel $tourModel */
+                $tourModel = $app->bootComponent('com_guidedtours')
+                                 ->getMVCFactory()->createModel('Tour', 'Administrator', [ 'ignore_request' => true ]);
+
+                $tour = $tourModel->getItem($tourId);
+
+                GuidedtoursHelper::loadTranslationFiles($tour->uid, true);
+
+                $tourLanguageLoaded = true;
+            }
+
             $item->title       = Text::_($item->title);
             $item->description = Text::_($item->description);
         }