[4.1] [GSoC 21] Core Enhancement 1 - Improve Menu-Module Assignment

administrator/components/com_admin/sql/updates/mysql/4.1.0-2021-06-27.sql

@@ -0,0 +1,2 @@
+INSERT INTO `#__extensions` (`package_id`, `name`, `type`, `element`, `folder`, `client_id`, `enabled`, `access`, `protected`, `locked`, `manifest_cache`, `params`, `custom_data`, `checked_out`, `checked_out_time`, `ordering`, `state`) VALUES
+(0, 'plg_system_addmodulebutton', 'plugin', 'addmodulebutton', 'system', 0, 1, 1, 0, 1, '', '', '', NULL, NULL, 0, 0);

administrator/components/com_admin/sql/updates/postgresql/4.1.0-2021-06-27.sql

@@ -0,0 +1,2 @@
+INSERT INTO `#__extensions` (`package_id`, `name`, `type`, `element`, `folder`, `client_id`, `enabled`, `access`, `protected`, `locked`, `manifest_cache`, `params`, `custom_data`, `checked_out`, `checked_out_time`, `ordering`, `state`) VALUES
+(0, 'plg_system_addmodulebutton', 'plugin', 'addmodulebutton', 'system', 0, 1, 1, 0, 1, '', '', '', NULL, NULL, 0, 0);

administrator/components/com_modules/forms/preview_positions.xml

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="utf-8"?>
+<form>
+	<fieldset addfieldprefix="Joomla\Component\Modules\Administrator\Field">
+		<field
+			name="template_style_site"
+			id="template-style-select"
+			type="templatestyle"
+			client="site"
+			label="COM_MODULES_MODULE_TEMPLATE_SELECT"
+			>
+			<option value="">JOPTION_USE_DEFAULT</option>
+		</field>
+
+		<field
+			name="template_style_admin"
+			id="template-style-select"
+			type="templatestyle"
+			client="administrator"
+			label="COM_MODULES_MODULE_TEMPLATE_SELECT"
+			>
+			<option value="">JOPTION_USE_DEFAULT</option>
+		</field>
+	</fieldset>
+</form>

administrator/components/com_modules/layouts/joomla/form/field/modulespositionedit.php

@@ -76,13 +76,38 @@
 	->usePreset('choicesjs')
 	->useScript('webcomponent.field-fancy-select');
 
-?>
-<joomla-field-fancy-select <?php echo implode(' ', $attributes); ?>><?php
-	echo HTMLHelper::_('select.groupedlist', $positions, $name, array(
-			'id'          => $id,
-			'list.select' => $value,
-			'list.attr'   => implode(' ', $selectAttr),
-		)
-	);
-?></joomla-field-fancy-select>
+$app = Factory::getApplication();
+$clientId = $app->input->getBool('client_id', 0);
+
+$modalUrl = 'index.php?option=com_modules&view=module&layout=preview_positions&id=1&client_id=' . $clientId;
+
+// &tmpl=component doesn't redirect if the user isn't logged into backend hence we are adding it conditionally
+$modalUrl = $app->isClient('site') ? 'administrator/' . $modalUrl : $modalUrl . '&tmpl=component';
 
+?>
+<joomla-field-fancy-select <?php echo implode(' ', $attributes); ?>>
+<?php
+echo HTMLHelper::_('select.groupedlist', $positions, $name, array(
+		'id'          => $id,
+		'list.select' => $value,
+		'list.attr'   => implode(' ', $selectAttr),
+	)
+);
+?>
+</joomla-field-fancy-select>
+<?php
+echo HTMLHelper::_(
+	'bootstrap.renderModal',
+	'Modal_position',
+	array(
+		'title'       => Text::_('COM_MODULES_MODULE_SELECT_POSITION'),
+		'url'         => $modalUrl,
+		'bodyHeight'  => 70,
+		'modalWidth'  => 95,
+		'footer'      => '<button type="button" class="btn btn-secondary" data-bs-dismiss="modal">' . Text::_('JLIB_HTML_BEHAVIOR_CLOSE') . '</button>',
+	)
+);
+?>
+<button data-bs-toggle="modal" type="button" data-bs-target="#Modal_position" class="btn btn-primary mt-1 w-100">
+<?php echo Text::_('COM_MODULES_MODULE_SELECT_POSITION_BUTTON'); ?>
+</button>

administrator/components/com_modules/src/Controller/ModuleController.php

@@ -68,6 +68,38 @@ public function add()
 		$app->setUserState('com_modules.add.module.params', $params);
 	}
 
+	/**
+	 * Set Position and Menu ID in State for the New Module in Frontend Module Placement.
+	 *
+	 * @return  void
+	 *
+	 * @since   __DEPLOY_VERSION__
+	 */
+	public function selectPosition()
+	{
+		$app = $this->app;
+
+		// Get the Menu ID and Position.
+		$menuId = $this->input->getInt('menu', 0);
+		$position = $this->input->get('position');
+
+		if (empty($position))
+		{
+			$redirectUrl = $this->input->server->getString('HTTP_REFERER');
+
+			$this->setRedirect(Route::_($redirectUrl, false));
+
+			$app->enqueueMessage(Text::_('COM_MODULES_ERROR_INVALID_POSITION'), 'warning');
+		}
+
+		$app->setUserState('com_modules.add.module.menu_id', $menuId);
+		$app->setUserState('com_modules.add.module.position', $position);
+
+		// Select Position is only used in the Frontend Module Placement so we pass client_id as 0
+		$redirectUrl = 'index.php?option=com_modules&view=select&client_id=0';
+		$this->setRedirect(Route::_($redirectUrl, false));
+	}
+
 	/**
 	 * Override parent cancel method to reset the add module state.
 	 *
@@ -82,7 +114,9 @@ public function cancel($key = null)
 		$result = parent::cancel();
 
 		$this->app->setUserState('com_modules.add.module.extension_id', null);
+		$this->app->setUserState('com_modules.add.module.menu_id', null);
 		$this->app->setUserState('com_modules.add.module.params', null);
+		$this->app->setUserState('com_modules.add.module.position', null);
 
 		if ($return = $this->input->get('return', '', 'BASE64'))
 		{
@@ -205,7 +239,9 @@ protected function postSaveHook(BaseDatabaseModel $model, $validData = array())
 				break;
 		}
 
+		$this->app->setUserState('com_modules.add.module.menu_id', null);
 		$this->app->setUserState('com_modules.add.module.params', null);
+		$this->app->setUserState('com_modules.add.module.position', null);
 	}
 
 	/**

administrator/components/com_modules/src/Model/ModuleModel.php

@@ -548,6 +548,8 @@ public function &getClient()
 	 */
 	public function getForm($data = array(), $loadData = true)
 	{
+		$app = Factory::getApplication();
+
 		// The folder and element vars are passed when saving the form.
 		if (empty($data))
 		{
@@ -572,19 +574,26 @@ public function getForm($data = array(), $loadData = true)
 		$this->setState('item.module', $module);
 
 		// Get the form.
-		if ($clientId == 1)
+		if ($app->input->getCMD('layout') == 'preview_positions')
 		{
-			$form = $this->loadForm('com_modules.module.admin', 'moduleadmin', array('control' => 'jform', 'load_data' => $loadData), true);
-
-			// Display language field to filter admin custom menus per language
-			if (!ModuleHelper::isAdminMultilang())
-			{
-				$form->setFieldAttribute('language', 'type', 'hidden');
-			}
+			$form = $this->loadForm('com_modules.preview_positions', 'preview_positions', array('control' => 'jform', 'load_data' => $loadData), true);
 		}
 		else
 		{
-			$form = $this->loadForm('com_modules.module', 'module', array('control' => 'jform', 'load_data' => $loadData), true);
+			if ($clientId == 1)
+			{
+				$form = $this->loadForm('com_modules.module.admin', 'moduleadmin', array('control' => 'jform', 'load_data' => $loadData), true);
+
+				// Display language field to filter admin custom menus per language
+				if (!ModuleHelper::isAdminMultilang())
+				{
+					$form->setFieldAttribute('language', 'type', 'hidden');
+				}
+			}
+			else
+			{
+				$form = $this->loadForm('com_modules.module', 'module', array('control' => 'jform', 'load_data' => $loadData), true);
+			}
 		}
 
 		if (empty($form))
@@ -642,7 +651,17 @@ protected function loadFormData()
 				$clientId = $app->input->getInt('client_id', 0);
 				$filters  = (array) $app->getUserState('com_modules.modules.' . $clientId . '.filter');
 				$data->set('published', $app->input->getInt('published', ((isset($filters['state']) && $filters['state'] !== '') ? $filters['state'] : null)));
-				$data->set('position', $app->input->getInt('position', (!empty($filters['position']) ? $filters['position'] : null)));
+
+				// Pre-select Module Position set by Frontend Placement if it exists.
+				if ($position = $app->getUserState('com_modules.add.module.position'))
+				{
+					$data->set('position', $position);
+				}
+				else
+				{
+					$data->set('position', $app->input->getInt('position', (!empty($filters['position']) ? $filters['position'] : null)));
+				}
+
 				$data->set('language', $app->input->getString('language', (!empty($filters['language']) ? $filters['language'] : null)));
 				$data->set('access', $app->input->getInt('access', (!empty($filters['access']) ? $filters['access'] : $app->get('access'))));
 			}
@@ -676,6 +695,7 @@ protected function loadFormData()
 	 */
 	public function getItem($pk = null)
 	{
+		$app = Factory::getApplication();
 		$pk = (!empty($pk)) ? (int) $pk : (int) $this->getState('module.id');
 		$db = $this->getDbo();
 
@@ -757,8 +777,17 @@ public function getItem($pk = null)
 
 			if (empty($pk))
 			{
-				// If this is a new module, assign to all pages.
-				$assignment = 0;
+				if ($menuId = (int) $app->getUserState('com_modules.add.module.menu_id'))
+				{
+					// If a Menu ID is selected via Frontend Placements then use that.
+					$assignment = 1;
+					$assigned[] = $menuId;
+				}
+				else
+				{
+					// If this is a new module, assign to all pages.
+					$assignment = 0;
+				}
 			}
 			elseif (empty($assigned))
 			{

administrator/components/com_modules/tmpl/module/preview_positions.php

@@ -0,0 +1,43 @@
+<?php
+/**
+ * @package     Joomla.Administrator
+ * @subpackage  com_modules
+ *
+ * @copyright   (C) 2021 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+defined('_JEXEC') or die;
+
+use Joomla\CMS\Factory;
+use Joomla\CMS\Language\Text;
+use Joomla\CMS\Uri\Uri;
+
+/** @var Joomla\CMS\WebAsset\WebAssetManager $wa */
+$wa = $this->document->getWebAssetManager();
+$wa->useScript('com_modules.admin-modules-preview_positions');
+
+$isAdmin = Factory::getApplication()->input->get('client_id');
+
+// Get the URL of the iframe that displays template preview.
+$iframeBaseURL = Uri::root();
+$iframeBaseURL .= $isAdmin ? 'administrator' : '';
+
+// Conditionally render the admin or site template select field.
+$templateField = 'template_style_';
+$templateField .= $isAdmin ? 'admin' : 'site';
+
+// Render the template select field.
+$this->fieldsets = $this->form->getFieldsets();
+echo $this->form->renderField($templateField);
+?>
+<div class="jviewport-height90">
+	<iframe 
+		src="<?php echo $iframeBaseURL . '?pm=1&edit=1&templateStyle='; ?>
+		id="module-position-select" 
+		name="module-position-select" 
+		title="module-position-select"
+		height="100%"
+		width="100%">
+	</iframe>
+</div>

administrator/components/com_modules/tmpl/modules/default.php

@@ -132,7 +132,7 @@
 									<?php echo HTMLHelper::_('jgrid.checkedout', $i, $item->editor, $item->checked_out_time, 'modules.', $canCheckin); ?>
 								<?php endif; ?>
 								<?php if ($canEdit) : ?>
-									<a href="<?php echo Route::_('index.php?option=com_modules&task=module.edit&id=' . (int) $item->id); ?>" title="<?php echo Text::_('JACTION_EDIT'); ?> <?php echo $this->escape($item->title); ?>">
+									<a href="<?php echo Route::_('index.php?option=com_modules&task=module.edit&id=' . (int) $item->id . '&client_id=' . $clientId); ?>" title="<?php echo Text::_('JACTION_EDIT'); ?> <?php echo $this->escape($item->title); ?>">
 										<?php echo $this->escape($item->title); ?></a>
 								<?php else : ?>
 									<?php echo $this->escape($item->title); ?>

administrator/language/en-GB/com_modules.ini

@@ -32,6 +32,7 @@ COM_MODULES_EMPTYSTATE_TITLE_SITE="No Site Modules have been created yet."
 COM_MODULES_ERR_XML="Module XML data not available"
 COM_MODULES_ERROR_CANNOT_FIND_MODULE="Can't find module"
 COM_MODULES_ERROR_INVALID_EXTENSION="Invalid module"
+COM_MODULES_ERROR_INVALID_POSITION="Invalid position"
 COM_MODULES_ERROR_NO_MODULES_SELECTED="No module selected."
 COM_MODULES_EXPAND="Expand"
 COM_MODULES_EXTENSION_PUBLISHED_DISABLED="Module disabled and published."
@@ -90,7 +91,10 @@ COM_MODULES_MENU_ITEM_URL="URL"
 COM_MODULES_MODULE="Module"
 COM_MODULES_MODULE_ASSIGN="Module Assignment"
 COM_MODULES_MODULE_DESCRIPTION="Module Description"
+COM_MODULES_MODULE_SELECT_POSITION="Select Module Position from Template Preview"
+COM_MODULES_MODULE_SELECT_POSITION_BUTTON="Select from Template Preview"
 COM_MODULES_MODULE_TEMPLATE_POSITION="%1$s (%2$s)"
+COM_MODULES_MODULE_TEMPLATE_SELECT="Select Template to Preview"
 COM_MODULES_MODULES="Modules"
 COM_MODULES_MODULES_FILTER_SEARCH_DESC="Search in module title and note. Prefix with ID: to search for a module ID."
 COM_MODULES_MODULES_FILTER_SEARCH_LABEL="Search Modules"

administrator/language/en-GB/joomla.ini

@@ -567,6 +567,8 @@ JGLOBAL_PASSWORD="Password"
 JGLOBAL_PASSWORD_RESET_REQUIRED="You are required to reset your password before proceeding."
 JGLOBAL_PERMISSIONS_ANCHOR="Set Permissions"
 JGLOBAL_PREVIEW="Preview"
+JGLOBAL_PREVIEW_PLACE_MODULE="Place Module Here"
+JGLOBAL_PREVIEW_PLACE_MODULE_POSITION="in Position: %s"
 JGLOBAL_PREVIEW_POSITION="<span>Position:</span> %s"
 JGLOBAL_PREVIEW_STYLE="<span>Style:</span> %s"
 JGLOBAL_PUBLISHED_DATE="Published Date"

administrator/language/en-GB/plg_system_addmodulebutton.ini

@@ -0,0 +1,11 @@
+; Joomla! Project
+; (C) 2021 Open Source Matters, Inc. <https://www.joomla.org>
+; License GNU General Public License version 2 or later; see LICENSE.txt
+; Note : All ini files need to be saved as UTF-8
+
+PLG_SYSTEM_ADDMODULEBUTTON="System - Add Module Button"
+PLG_SYSTEM_ADD_MODULE_BUTTON_LABEL="Create a Module"
+PLG_SYSTEM_ADD_MODULE_BUTTON_DESCRIPTION="Add a new module here"
+PLG_ADD_MODULE_BUTTON_XML_DESCRIPTION="Displays a button to insert a module in a menu directly from the Frontend."
+PLG_SYSTEM_ADD_MODULE_BUTTON_CREATE_MODULE_PERMISSIONS_WARNING="Please login with an account having permission to Select Module Position"
+PLG_SYSTEM_ADD_MODULE_BUTTON_EDIT_MODULE_PERMISSIONS_WARNING="Please login with an account having permission to Edit Module Position"

administrator/language/en-GB/plg_system_addmodulebutton.sys.ini

@@ -0,0 +1,7 @@
+; Joomla! Project
+; (C) 2021 Open Source Matters, Inc. <https://www.joomla.org>
+; License GNU General Public License version 2 or later; see LICENSE.txt
+; Note : All ini files need to be saved as UTF-8
+
+PLG_SYSTEM_ADDMODULEBUTTON="System - Add Module Button"
+PLG_ADD_MODULE_BUTTON_XML_DESCRIPTION="Displays a button to insert a module in a menu directly from the Frontend."

api/language/en-GB/joomla.ini

@@ -561,6 +561,8 @@ JGLOBAL_PASSWORD="Password"
 JGLOBAL_PASSWORD_RESET_REQUIRED="You are required to reset your password before proceeding."
 JGLOBAL_PERMISSIONS_ANCHOR="Set Permissions"
 JGLOBAL_PREVIEW="Preview"
+JGLOBAL_PREVIEW_PLACE_MODULE="Place Module Here"
+JGLOBAL_PREVIEW_PLACE_MODULE_POSITION="in Position: %s"
 JGLOBAL_PREVIEW_POSITION="<span>Position:</span> %s"
 JGLOBAL_PREVIEW_STYLE="<span>Style:</span> %s"
 JGLOBAL_PUBLISHED_DATE="Published Date"

build/media_source/com_modules/joomla.asset.json

@@ -97,6 +97,29 @@
         "type": "module"
       }
     },
+    {
+      "name": "com_modules.admin-modules-preview_positions.es5",
+      "type": "script",
+      "uri": "com_modules/admin-modules-preview_positions-es5.min.js",
+      "dependencies": [
+        "core"
+      ],
+      "attributes": {
+        "nomodule": true,
+        "defer": true
+      }
+    },
+    {
+      "name": "com_modules.admin-modules-preview_positions",
+      "type": "script",
+      "uri": "com_modules/admin-modules-preview_positions.min.js",
+      "dependencies": [
+        "com_modules.admin-modules-preview_positions.es5"
+      ],
+      "attributes": {
+        "type": "module"
+      }
+    },
     {
       "name": "com_modules.admin-select-modal.es5",
       "type": "script",

build/media_source/com_modules/js/admin-modules-preview_positions.es6.js

@@ -0,0 +1,20 @@
+/**
+  * @copyright  (C) 2021 Open Source Matters, Inc. <https://www.joomla.org>
+  * @license    GNU General Public License version 2 or later; see LICENSE.txt
+  */
+
+/**
+ * Add a keyboard event listener to the Select Template Style element.
+ *
+ * This script is meant to be loaded deferred. This means that it's non-blocking
+ * (the browser can load it whenever) and it doesn't need an on DOMContentLoaded event handler
+ * because the browser is guaranteed to execute it only after the DOM content has loaded, the
+ * whole point of it being deferred.
+ */
+
+const elIframe = document.getElementById('module-position-select');
+const elTemplateSelect = document.getElementById('jform_template_style_select');
+
+elTemplateSelect.addEventListener('change', (event) => {
+  elIframe.src = elIframe.src.substring(0, elIframe.src.indexOf('templateStyle=') + 14) + event.target.value;
+});