[5.3] [GSoC 21] Core Enhancement 2 - Incorporation of Modules in Articles-Edit-View

administrator/components/com_content/config.xml

@@ -446,6 +446,17 @@
 			<option value="1">JSHOW</option>
 		</field>
 
+		<field
+			name="show_imported_modules"
+			type="radio"
+			label="COM_CONTENT_SHOW_IMPORTED_MODULES"
+			layout="joomla.form.field.radio.switcher"
+			default="1"
+			>
+			<option value="0">JNO</option>
+			<option value="1">JYES</option>
+		</field>
+
 		<field
 			name="spacer3"
 			type="spacer"

administrator/components/com_content/forms/article.xml

@@ -344,6 +344,7 @@
 					<option value="0">JHIDE</option>
 					<option value="1">JSHOW</option>
 				</field>
+
 			</fieldset>
 
 			<fieldset name="category" label="JCATEGORY">
@@ -599,6 +600,18 @@
 				<option value="0">JNO</option>
 				<option value="1">JYES</option>
 			</field>
+
+			<field
+				name="show_imported_modules"
+				type="list"
+				label="COM_CONTENT_SHOW_IMPORTED_MODULES"
+				useglobal="true"
+				default=""
+				validate="options"
+				>
+				<option value="0">JNO</option>
+				<option value="1">JYES</option>
+			</field>
 		</fieldset>
 
 		<fieldset name="basic-limited" label="COM_CONTENT_ATTRIBS_FIELDSET_LABEL">

administrator/components/com_content/src/Model/ArticleModel.php

@@ -16,6 +16,7 @@
 use Joomla\CMS\Filter\InputFilter;
 use Joomla\CMS\Form\Form;
 use Joomla\CMS\Form\FormFactoryInterface;
+use Joomla\CMS\Helper\ModuleHelper;
 use Joomla\CMS\Helper\TagsHelper;
 use Joomla\CMS\Language\Associations;
 use Joomla\CMS\Language\LanguageHelper;
@@ -446,6 +447,87 @@ public function getItem($pk = null)
             }
         }
 
+        // Expression to search for (positions)
+        $regex = '/{loadposition\s(.*?)}/i';
+
+        // Expression to search for (modules)
+        $regexmod = '/{loadmodule\s(.*?)}/i';
+
+        // Expression to search for (id)
+        $regexmodid = '/{loadmoduleid\s([1-9][0-9]*)}/i';
+
+        /**
+         * Find all instances of plugin and put in $matches for loadposition
+         * $matches[0] is full pattern match, $matches[1] is the position
+         */
+        preg_match_all($regex, $item->articletext, $matches, PREG_SET_ORDER);
+        $item->importedPositions = [];
+
+        // No matches, skip this
+        if ($matches) {
+            foreach ($matches as $match) {
+                $matcheslist = explode(',', $match[1]);
+
+                $position = trim($matcheslist[0]);
+                $style    = array_key_exists(1, $matcheslist) ? trim($matcheslist[1]) : 'none';
+
+                $item->importedPositions[] = array('name' => $position, 'style' => $style, 'editorText' => $match[0]);
+            }
+        }
+
+        // Find all instances of plugin and put in $matchesmod for loadmodule
+        preg_match_all($regexmod, $item->articletext, $matchesmod, PREG_SET_ORDER);
+
+        // If no matches, skip this
+        if ($matchesmod) {
+            foreach ($matchesmod as $matchmod) {
+                $matchesmodlist = explode(',', $matchmod[1]);
+
+                $module = trim($matchesmodlist[0]);
+                $name = array_key_exists(1, $matchesmodlist) ? htmlspecialchars_decode(trim($matchesmodlist[1])) : null;
+
+                $mod = ModuleHelper::getModule($module, $name);
+
+                /**
+                 * If the module without the mod_ isn't found, try it with mod_.
+                 * This allows people to enter it either way in the content
+                 */
+                if (!isset($mod)) {
+                    $mod = ModuleHelper::getModule('mod_' . $module, $name);
+                }
+
+                if (isset($mod)) {
+                    $mod->editorText = $matchmod[0];
+                    $item->importedModuleTypes[] = $mod;
+                }
+            }
+        }
+
+        // Find all instances of loadmoduleid and store it in $matchesmodid
+        preg_match_all($regexmodid, $item->articletext, $matchesmodid, PREG_SET_ORDER);
+        $importedModules = [];
+
+        // If no matches, skip this
+        if ($matchesmodid) {
+            foreach ($matchesmodid as $match) {
+                $importedModules[] = $match[1];
+            }
+
+            $db = $this->getDbo();
+            $query = $db->getQuery(true)
+                ->select(
+                    [
+                        $db->quoteName('id'),
+                        $db->quoteName('title'),
+                        $db->quoteName('published'),
+                    ]
+                )
+                ->from($db->quoteName('#__modules'));
+            $query->where($db->quoteName('id') . ' IN (' . implode(',', $query->bindArray(array_values($importedModules))) . ')');
+
+            $item->importedModules = $db->setQuery($query)->loadObjectList();
+        }
+
         return $item;
     }
 

administrator/components/com_content/tmpl/article/edit.php

@@ -22,6 +22,29 @@
 
 /** @var Joomla\CMS\WebAsset\WebAssetManager $wa */
 $wa = $this->getDocument()->getWebAssetManager();
+
+$wa->useScript('com_content.admin-article-edit');
+
+// Set up the bootstrap modal that will be used for all module editors
+echo HTMLHelper::_(
+    'bootstrap.renderModal',
+    'moduleEditModal',
+    array(
+        'title'       => Text::_('COM_CONTENT_HEADING_IMPORTED_MODULE_EDIT'),
+        'backdrop'    => 'static',
+        'keyboard'    => false,
+        'closeButton' => false,
+        'bodyHeight'  => '70',
+        'modalWidth'  => '80',
+        'footer'      => '<button type="button" class="btn btn-secondary" data-bs-dismiss="modal" data-bs-target="#closeBtn">'
+                . Text::_('JLIB_HTML_BEHAVIOR_CLOSE') . '</button>'
+                . '<button type="button" class="btn btn-primary" data-bs-dismiss="modal" data-bs-target="#saveBtn">'
+                . Text::_('JSAVE') . '</button>'
+                . '<button type="button" class="btn btn-success" data-bs-target="#applyBtn">'
+                . Text::_('JAPPLY') . '</button>',
+    )
+);
+
 $wa->getRegistry()->addExtensionRegistryFile('com_contenthistory');
 $wa->useScript('keepalive')
     ->useScript('form.validate')
@@ -110,6 +133,185 @@
             <?php echo HTMLHelper::_('uitab.endTab'); ?>
         <?php endif; ?>
 
+        <?php // Do not show the publishing options if the edit form is configured not to. ?>
+        <?php if ($params->get('show_imported_modules', 1) == 1 && (!empty($this->item->importedModules) || !empty($this->item->importedPositions))) : ?>
+            <?php echo HTMLHelper::_('uitab.addTab', 'myTab', 'modules', Text::_('COM_CONTENT_FIELDSET_MODULES')); ?>
+            <fieldset id="fieldset-modules" class="options-form">
+                <legend><?php echo Text::_('COM_CONTENT_FIELDSET_MODULES'); ?></legend>
+
+                <?php if (!empty($this->item->importedModules)) : ?>
+                    <h3> <?php echo Text::_('COM_CONTENT_FIELDSET_MODULES'); ?> </h3>
+                    <table class="table mb-4" id="modules_assigned">
+                        <caption class="visually-hidden">
+                            <?php echo Text::_('COM_CONTENT_IMPORTED_MODULES_TABLE_CAPTION'); ?>
+                        </caption>
+                        <thead>
+                            <tr>
+                                <th scope="col" class="w-10">
+                                    <?php echo Text::_('COM_CONTENT_HEADING_IMPORTED_MODULE_ID'); ?>
+                                </th>
+                                <th scope="col">
+                                    <?php echo Text::_('COM_CONTENT_HEADING_IMPORTED_MODULE_TITLE'); ?>
+                                </th>
+                                <th scope="col" class="w-10">
+                                    <?php echo Text::_('JPUBLISHED'); ?>
+                                </th>
+                                <th scope="col" class="w-15">
+                                    <?php echo Text::_('COM_CONTENT_HEADING_IMPORTED_MODULE_EDIT'); ?>
+                                </th>
+                                <th scope="col" class="w-15">
+                                    <?php echo Text::_('COM_CONTENT_HEADING_REMOVE'); ?>
+                                </th>
+                            </tr>
+                        </thead>
+                        <tbody>
+                        <?php foreach ($this->item->importedModules as $module) : ?>
+                            <tr id="tr-<?php echo $module->id; ?>" class="row<?php echo $module->id % 2; ?>">
+                                <td id="mod-<?php echo $module->id; ?>">
+                                    <?php echo $this->escape($module->id); ?>
+                                </td>
+                                <td id="mod-<?php echo $module->title; ?>">
+                                    <?php echo $this->escape($module->title); ?>
+                                </td>
+                                <td id="mod-<?php echo $module->published; ?>">
+                                    <?php if ($module->published) : ?>
+                                        <span class="badge bg-success">
+                                            <?php echo Text::_('JYES'); ?>
+                                        </span>
+                                    <?php else : ?>
+                                        <span class="badge bg-danger">
+                                            <?php echo Text::_('JNO'); ?>
+                                        </span>
+                                    <?php endif; ?>
+                                </td>
+                                <td id="status-<?php echo $module->id; ?>">
+                                    <button type="button"
+                                        data-bs-target="#moduleEditModal"
+                                        class="btn btn-link module-edit-link"
+                                        title="<?php echo Text::_('COM_CONTENT_EDIT_MODULE'); ?>"
+                                        id="title-<?php echo $module->id; ?>"
+                                        data-module-id="<?php echo $module->id; ?>">
+                                        <?php echo Text::_('COM_CONTENT_EDIT_MODULE'); ?>
+                                    </button>
+                                </td>
+                                <td id="status-<?php echo $module->id; ?>">
+                                    <button type="button"
+                                        class="btn btn-link module-remove-link"
+                                        data-module-id="<?php echo $module->id; ?>">
+                                        <?php echo Text::_('COM_CONTENT_REMOVE_FROM_ARTICLE'); ?>
+                                    </button>
+                                </td>
+                            </tr>
+                        <?php endforeach; ?>
+                        </tbody>
+                    </table>
+                <?php endif; ?>
+
+                <?php if (!empty($this->item->importedModuleTypes)) : ?>
+                    <h3> <?php echo Text::_('COM_CONTENT_HEADING_IMPORTED_MODULE_TYPES'); ?> </h3>
+                    <table class="table mb-4" id="modules_assigned">
+                        <caption class="visually-hidden">
+                            <?php echo Text::_('COM_CONTENT_IMPORTED_MODULES_TABLE_CAPTION'); ?>
+                        </caption>
+                        <thead>
+                            <tr>
+                                <th scope="col" class="w-10">
+                                    <?php echo Text::_('COM_CONTENT_HEADING_IMPORTED_MODULE_ID'); ?>
+                                </th>
+                                <th scope="col">
+                                    <?php echo Text::_('COM_CONTENT_HEADING_IMPORTED_MODULE_TYPE'); ?>
+                                </th>
+                                <th scope="col" class="w-20">
+                                    <?php echo Text::_('COM_CONTENT_HEADING_IMPORTED_MODULE_TITLE'); ?>
+                                </th>
+                                <th scope="col" class="w-15">
+                                    <?php echo Text::_('COM_CONTENT_HEADING_IMPORTED_MODULE_EDIT'); ?>
+                                </th>
+                                <th scope="col" class="w-15">
+                                    <?php echo Text::_('COM_CONTENT_HEADING_REMOVE'); ?>
+                                </th>
+                            </tr>
+                        </thead>
+                        <tbody>
+                        <?php foreach ($this->item->importedModuleTypes as $module) : ?>
+                            <tr>
+                                <td>
+                                    <?php echo $this->escape($module->id); ?>
+                                </td>
+                                <td>
+                                    <?php echo $this->escape($module->module); ?>
+                                </td>
+                                <td>
+                                    <?php echo $this->escape($module->title); ?>
+                                </td>
+                                <td>
+                                    <?php if (!empty($module->id)) : ?>
+                                        <button type="button"
+                                            data-bs-target="#moduleEditModal"
+                                            class="btn btn-link module-edit-link"
+                                            title="<?php echo Text::_('COM_CONTENT_EDIT_MODULE'); ?>"
+                                            data-module-id="<?php echo $module->id; ?>">
+                                            <?php echo Text::_('COM_CONTENT_EDIT_MODULE'); ?>
+                                        </button>
+                                    <?php endif; ?>
+                                </td>
+                                <td>
+                                    <button type="button"
+                                        class="btn btn-link import-remove-link"
+                                        data-importText="<?php echo $module->editorText; ?>">
+                                        <?php echo Text::_('COM_CONTENT_REMOVE_FROM_ARTICLE'); ?>
+                                    </button>
+                                </td>
+                            </tr>
+                        <?php endforeach; ?>
+                        </tbody>
+                    </table>
+                <?php endif; ?>
+
+                <?php if (!empty($this->item->importedPositions)) : ?>
+                    <h3> <?php echo Text::_('COM_CONTENT_HEADING_IMPORTED_POSITION'); ?> </h3>
+                    <table class="table" id="positions_assigned">
+                        <caption class="visually-hidden">
+                            <?php echo Text::_('COM_CONTENT_IMPORTED_POSITIONS_TABLE_CAPTION'); ?>
+                        </caption>
+                        <thead>
+                            <tr>
+                                <th scope="col">
+                                    <?php echo Text::_('COM_CONTENT_HEADING_IMPORTED_POSITION_NAME'); ?>
+                                </th>
+                                <th scope="col" class="w-15">
+                                    <?php echo Text::_('COM_CONTENT_HEADING_IMPORTED_POSITION_STYLE'); ?>
+                                </th>
+                                <th scope="col" class="w-15">
+                                    <?php echo Text::_('COM_CONTENT_HEADING_REMOVE'); ?>
+                                </th>
+                            </tr>
+                        </thead>
+                        <tbody>
+                        <?php foreach ($this->item->importedPositions as $position) : ?>
+                            <tr>
+                                <td>
+                                    <?php echo $this->escape($position["name"]); ?>
+                                </td>
+                                <td>
+                                    <?php echo $this->escape($position["style"]); ?>
+                                </td>
+                                <td>
+                                    <button type="button"
+                                        class="btn btn-link import-remove-link"
+                                        data-importText="<?php echo $position["editorText"]; ?>">
+                                        <?php echo Text::_('COM_CONTENT_REMOVE_FROM_ARTICLE'); ?>
+                                    </button>
+                                </td>
+                            </tr>
+                        <?php endforeach; ?>
+                        </tbody>
+                    </table>
+                <?php endif; ?>
+            </fieldset>
+            <?php echo HTMLHelper::_('uitab.endTab'); ?>
+        <?php endif; ?>
+
         <?php echo LayoutHelper::render('joomla.edit.params', $this); ?>
 
         <?php // Do not show the publishing options if the edit form is configured not to. ?>

administrator/components/com_modules/src/View/Module/HtmlView.php

@@ -133,14 +133,17 @@ protected function addToolbar()
         if ($isNew && $canDo->get('core.create')) {
             $toolbar->apply('module.apply');
 
-            $saveGroup = $toolbar->dropdownButton('save-group');
-
-            $saveGroup->configure(
-                function (Toolbar $childBar) {
-                    $childBar->save('module.save');
-                    $childBar->save2new('module.save2new');
-                }
-            );
+            // Hide the Save and Close button for com_content Import Module Modal flow.
+            if (!Factory::getApplication()->input->cookie->get('com_modules_importOnSave')) {
+              $saveGroup = $toolbar->dropdownButton('save-group');
+
+              $saveGroup->configure(
+                  function (Toolbar $childBar) {
+                      $childBar->save('module.save');
+                      $childBar->save2new('module.save2new');
+                  }
+              );
+            }
 
             $toolbar->cancel('module.cancel', 'JTOOLBAR_CANCEL');
         } else {