* @git Joomla Component Builder * @copyright Copyright (C) 2015 Vast Development Method. All rights reserved. * @license GNU General Public License version 2 or later; see LICENSE.txt */ // No direct access to this file defined('_JEXEC') or die('Restricted access'); use Joomla\CMS\Application\CMSApplication; use Joomla\CMS\Plugin\CMSPlugin; use Joomla\Registry\Registry; JLoader::register('ComponentbuilderHelper', JPATH_ADMINISTRATOR . '/components/com_componentbuilder/helpers/componentbuilder.php'); use VDM\Joomla\Componentbuilder\Compiler\Factory as CFactory; use VDM\Joomla\Componentbuilder\Compiler\Utilities\Placefix; use VDM\Joomla\Componentbuilder\Compiler\Utilities\Indent; use VDM\Joomla\Componentbuilder\Compiler\Utilities\Line; /** * Extension - Componentbuilder ActionLog Compiler plugin. * * @package ComponentbuilderActionLogCompiler * @since 1.1.0 */ class PlgExtensionComponentbuilderActionLogCompiler extends CMSPlugin { /** * Affects constructor behavior. If true, language files will be loaded automatically. * * @var boolean * @since 1.0.0 */ protected $autoloadLanguage = true; /** * The language string builder * * @var array */ protected $languageArray = array(); /** * The Scripts * * @var array */ protected $scriptsArray = array('POSTINSTALLSCRIPT' => array(), 'POSTUPDATESCRIPT' => array(), 'UNINSTALLSCRIPT' => array()); /** * Event Triggered in the compiler [on After Get Component Data] * * @return void * * @since 1.0 */ public function jcb_ce_onAfterGetComponentData(&$context, $compiler) { if ($this->componentActive($context) && ComponentbuilderHelper::checkArray($this->languageArray)) { foreach($this->languageArray as $key => $string) { CFactory::_('Language')->set('admin', $key, $string); } } } /** * Event Triggered in the compiler [on After Build Files Content] * * @return void * * @since 1.0 */ public function jcb_ce_onAfterBuildFilesContent(&$context, &$componentData, &$fileContentStatic, &$fileContentDynamic, &$placeholders, &$hhh) { if ($this->componentActive($context)) { // now load the script strings to the component foreach ($this->scriptsArray as $target => &$bucket) { // add the component main target script CFactory::_('Content')->add($target, $this->{'getMain' . $target}()); // add the component views target scripts if (ComponentbuilderHelper::checkArray($bucket)) { CFactory::_('Content')->add($target, implode('', $bucket)); } } } } /** * Event Triggered in the compiler [on After Model View Data] * * @return void * * @since 1.0 */ public function jcb_ce_onAfterModelViewData(&$context, &$view, &$placeholders) { // add the better integration with action log if ($this->componentActive($context) &&ComponentbuilderHelper::checkArray($view->fields)) { foreach ($view->fields as $field) { if (isset($field['title']) && $field['title'] == 1) { $title_holder = $field['base_name']; break; } } // if not found try again if (!isset($title_holder)) { foreach ($view->fields as $field) { if (isset($field['list']) && $field['list'] == 1 && isset($field['order_list']) && $field['order_list'] == 1 && isset($field['link']) && $field['link'] == 1) { $title_holder = $field['base_name']; break; } } } // if found update placeholder if (isset($title_holder)) { // set main title CFactory::_('Placeholder')->set('<<>>', $title_holder, false); } else { // fall back on ID CFactory::_('Placeholder')->set('<<>>', 'id', false); } // now load the script strings foreach ($this->scriptsArray as $target => &$bucket) { $bucket[] = $this->{'getView' . $target}(); } // just remove it again CFactory::_('Placeholder')->remove('<<>>'); // set language string $this->languageArray[CFactory::_('Placeholder')->get_("LANG_PREFIX") . '_TYPE_' . CFactory::_('Placeholder')->get_("VIEW")] = $view->name_single; } } /** * get the Main Post Install Script * * @return string * */ protected function getMainPOSTINSTALLSCRIPT() { $script = PHP_EOL . PHP_EOL . Indent::_(3) . "//" . Line::_(__Line__, __Class__) . " Set db if not set already."; $script .= PHP_EOL . Indent::_(3) . "if (!isset(\$db))"; $script .= PHP_EOL . Indent::_(3) . "{"; $script .= PHP_EOL . Indent::_(4) . "\$db = JFactory::getDbo();"; $script .= PHP_EOL . Indent::_(3) . "}"; $script .= PHP_EOL . Indent::_(3) . "//" . Line::_(__Line__, __Class__) . " Create the " . Placefix::_("component") . " action logs extensions object."; $script .= PHP_EOL . Indent::_(3) . "\$" . Placefix::_("component") . "_action_logs_extensions = new stdClass();"; $script .= PHP_EOL . Indent::_(3) . "\$" . Placefix::_("component") . "_action_logs_extensions->extension = 'com_" . Placefix::_("component") . "';"; $script .= PHP_EOL . PHP_EOL . Indent::_(3) . "//" . Line::_(__Line__, __Class__) . " Set the object into the action logs extensions table."; $script .= PHP_EOL . Indent::_(3) . "\$" . Placefix::_("component") . "_action_logs_extensions_Inserted = \$db->insertObject('#__action_logs_extensions', \$" . Placefix::_("component") . "_action_logs_extensions);"; return CFactory::_('Placeholder')->update_($script); } /** * get the View Post Install Script * * @return string * */ protected function getViewPOSTINSTALLSCRIPT() { $script = PHP_EOL . PHP_EOL . Indent::_(3) . "//" . Line::_(__Line__, __Class__) . " Set db if not set already."; $script .= PHP_EOL . Indent::_(3) . "if (!isset(\$db))"; $script .= PHP_EOL . Indent::_(3) . "{"; $script .= PHP_EOL . Indent::_(4) . "\$db = JFactory::getDbo();"; $script .= PHP_EOL . Indent::_(3) . "}"; $script .= PHP_EOL . Indent::_(3) . "//" . Line::_(__Line__, __Class__) . " Create the " . Placefix::_("view") . " action log config object."; $script .= PHP_EOL . Indent::_(3) . "\$" . Placefix::_("view") . "_action_log_config = new stdClass();"; $script .= PHP_EOL . Indent::_(3) . "\$" . Placefix::_("view") . "_action_log_config->type_title = '" . Placefix::_("VIEW") . "';"; $script .= PHP_EOL . Indent::_(3) . "\$" . Placefix::_("view") . "_action_log_config->type_alias = 'com_" . Placefix::_("component") . "." . Placefix::_("view") . "';"; $script .= PHP_EOL . Indent::_(3) . "\$" . Placefix::_("view") . "_action_log_config->id_holder = 'id';"; $script .= PHP_EOL . Indent::_(3) . "\$" . Placefix::_("view") . "_action_log_config->title_holder = '<<>>';"; $script .= PHP_EOL . Indent::_(3) . "\$" . Placefix::_("view") . "_action_log_config->table_name = '#__" . Placefix::_("component") . "_" . Placefix::_("view") . "';"; $script .= PHP_EOL . Indent::_(3) . "\$" . Placefix::_("view") . "_action_log_config->text_prefix = '" . Placefix::_("LANG_PREFIX") . "';"; $script .= PHP_EOL . PHP_EOL . Indent::_(3) . "//" . Line::_(__Line__, __Class__) . " Set the object into the action log config table."; $script .= PHP_EOL . Indent::_(3) . "\$" . Placefix::_("view") . "_Inserted = \$db->insertObject('#__action_log_config', \$" . Placefix::_("view") . "_action_log_config);"; return CFactory::_('Placeholder')->update_($script); } /** * get the Main Post Update Script * * @return string * */ protected function getMainPOSTUPDATESCRIPT() { $script = PHP_EOL . PHP_EOL . Indent::_(3) . "//" . Line::_(__Line__, __Class__) . " Set db if not set already."; $script .= PHP_EOL . Indent::_(3) . "if (!isset(\$db))"; $script .= PHP_EOL . Indent::_(3) . "{"; $script .= PHP_EOL . Indent::_(4) . "\$db = JFactory::getDbo();"; $script .= PHP_EOL . Indent::_(3) . "}"; $script .= PHP_EOL . Indent::_(3) . "//" . Line::_(__Line__, __Class__) . " Create the " . Placefix::_("component") . " action logs extensions object."; $script .= PHP_EOL . Indent::_(3) . "\$" . Placefix::_("component") . "_action_logs_extensions = new stdClass();"; $script .= PHP_EOL . Indent::_(3) . "\$" . Placefix::_("component") . "_action_logs_extensions->extension = 'com_" . Placefix::_("component") . "';"; $script .= PHP_EOL . PHP_EOL . Indent::_(3) . "//" . Line::_(__Line__, __Class__) . " Check if " . Placefix::_("component") . " action log extension is already in action logs extensions DB."; $script .= PHP_EOL . Indent::_(3) . "\$query = \$db->getQuery(true);"; $script .= PHP_EOL . Indent::_(3) . "\$query->select(\$db->quoteName(array('id')));"; $script .= PHP_EOL . Indent::_(3) . "\$query->from(\$db->quoteName('#__action_logs_extensions'));"; $script .= PHP_EOL . Indent::_(3) . "\$query->where(\$db->quoteName('extension') . ' LIKE '. \$db->quote(\$" . Placefix::_("component") . "_action_logs_extensions->extension));"; $script .= PHP_EOL . Indent::_(3) . "\$db->setQuery(\$query);"; $script .= PHP_EOL . Indent::_(3) . "\$db->execute();"; $script .= PHP_EOL . PHP_EOL . Indent::_(3) . "//" . Line::_(__Line__, __Class__) . " Set the object into the action logs extensions table if not found."; $script .= PHP_EOL . Indent::_(3) . "if (!\$db->getNumRows())"; $script .= PHP_EOL . Indent::_(3) . "{"; $script .= PHP_EOL . Indent::_(4) . "\$" . Placefix::_("component") . "_action_logs_extensions_Inserted = \$db->insertObject('#__action_logs_extensions', \$" . Placefix::_("component") . "_action_logs_extensions);"; $script .= PHP_EOL . Indent::_(3) . "}"; return CFactory::_('Placeholder')->update_($script); } /** * get the View Post Update Script * * @return string * */ protected function getViewPOSTUPDATESCRIPT() { $script = PHP_EOL . PHP_EOL . Indent::_(3) . "//" . Line::_(__Line__, __Class__) . " Set db if not set already."; $script .= PHP_EOL . Indent::_(3) . "if (!isset(\$db))"; $script .= PHP_EOL . Indent::_(3) . "{"; $script .= PHP_EOL . Indent::_(4) . "\$db = JFactory::getDbo();"; $script .= PHP_EOL . Indent::_(3) . "}"; $script .= PHP_EOL . Indent::_(3) . "//" . Line::_(__Line__, __Class__) . " Create the " . Placefix::_("view") . " action log config object."; $script .= PHP_EOL . Indent::_(3) . "\$" . Placefix::_("view") . "_action_log_config = new stdClass();"; $script .= PHP_EOL . Indent::_(3) . "\$" . Placefix::_("view") . "_action_log_config->id = null;"; $script .= PHP_EOL . Indent::_(3) . "\$" . Placefix::_("view") . "_action_log_config->type_title = '" . Placefix::_("VIEW") . "';"; $script .= PHP_EOL . Indent::_(3) . "\$" . Placefix::_("view") . "_action_log_config->type_alias = 'com_" . Placefix::_("component") . "." . Placefix::_("view") . "';"; $script .= PHP_EOL . Indent::_(3) . "\$" . Placefix::_("view") . "_action_log_config->id_holder = 'id';"; $script .= PHP_EOL . Indent::_(3) . "\$" . Placefix::_("view") . "_action_log_config->title_holder = '<<>>';"; $script .= PHP_EOL . Indent::_(3) . "\$" . Placefix::_("view") . "_action_log_config->table_name = '#__" . Placefix::_("component") . "_" . Placefix::_("view") . "';"; $script .= PHP_EOL . Indent::_(3) . "\$" . Placefix::_("view") . "_action_log_config->text_prefix = '" . Placefix::_("LANG_PREFIX") . "';"; $script .= PHP_EOL . PHP_EOL . Indent::_(3) . "//" . Line::_(__Line__, __Class__) . " Check if " . Placefix::_("view") . " action log config is already in action_log_config DB."; $script .= PHP_EOL . Indent::_(3) . "\$query = \$db->getQuery(true);"; $script .= PHP_EOL . Indent::_(3) . "\$query->select(\$db->quoteName(array('id')));"; $script .= PHP_EOL . Indent::_(3) . "\$query->from(\$db->quoteName('#__action_log_config'));"; $script .= PHP_EOL . Indent::_(3) . "\$query->where(\$db->quoteName('type_alias') . ' LIKE '. \$db->quote(\$" . Placefix::_("view") . "_action_log_config->type_alias));"; $script .= PHP_EOL . Indent::_(3) . "\$db->setQuery(\$query);"; $script .= PHP_EOL . Indent::_(3) . "\$db->execute();"; $script .= PHP_EOL . PHP_EOL . Indent::_(3) . "//" . Line::_(__Line__, __Class__) . " Set the object into the content types table."; $script .= PHP_EOL . Indent::_(3) . "if (\$db->getNumRows())"; $script .= PHP_EOL . Indent::_(3) . "{"; $script .= PHP_EOL . Indent::_(4) . "\$" . Placefix::_("view") . "_action_log_config->id = \$db->loadResult();"; $script .= PHP_EOL . Indent::_(4) . "\$" . Placefix::_("view") . "_action_log_config_Updated = \$db->updateObject('#__action_log_config', \$" . Placefix::_("view") . "_action_log_config, 'id');"; $script .= PHP_EOL . Indent::_(3) . "}"; $script .= PHP_EOL . Indent::_(3) . "else"; $script .= PHP_EOL . Indent::_(3) . "{"; $script .= PHP_EOL . Indent::_(4) . "\$" . Placefix::_("view") . "_action_log_config_Inserted = \$db->insertObject('#__action_log_config', \$" . Placefix::_("view") . "_action_log_config);"; $script .= PHP_EOL . Indent::_(3) . "}"; return CFactory::_('Placeholder')->update_($script); } /** * get the Main Uninstall Script * * @return string * */ protected function getMainUNINSTALLSCRIPT() { $script = PHP_EOL . PHP_EOL . Indent::_(2) . "//" . Line::_(__Line__, __Class__) . " Set db if not set already."; $script .= PHP_EOL . Indent::_(2) . "if (!isset(\$db))"; $script .= PHP_EOL . Indent::_(2) . "{"; $script .= PHP_EOL . Indent::_(3) . "\$db = JFactory::getDbo();"; $script .= PHP_EOL . Indent::_(2) . "}"; $script .= PHP_EOL . Indent::_(2) . "//" . Line::_(__Line__, __Class__) . " Set app if not set already."; $script .= PHP_EOL . Indent::_(2) . "if (!isset(\$app))"; $script .= PHP_EOL . Indent::_(2) . "{"; $script .= PHP_EOL . Indent::_(3) . "\$app = JFactory::getApplication();"; $script .= PHP_EOL . Indent::_(2) . "}"; $script .= PHP_EOL . Indent::_(2) . "//" . Line::_(__Line__, __Class__) . " Remove " . Placefix::_("Component") . " from the action_logs_extensions table"; $script .= PHP_EOL . Indent::_(2) . "\$" . Placefix::_("component") . "_action_logs_extensions = array( \$db->quoteName('extension') . ' = ' . \$db->quote('com_" . Placefix::_("component") . "') );"; $script .= PHP_EOL . Indent::_(2) . "//" . Line::_(__Line__, __Class__) . " Create a new query object."; $script .= PHP_EOL . Indent::_(2) . "\$query = \$db->getQuery(true);"; $script .= PHP_EOL . Indent::_(2) . "\$query->delete(\$db->quoteName('#__action_logs_extensions'));"; $script .= PHP_EOL . Indent::_(2) . "\$query->where(\$" . Placefix::_("component") . "_action_logs_extensions);"; $script .= PHP_EOL . Indent::_(2) . "\$db->setQuery(\$query);"; $script .= PHP_EOL . Indent::_(2) . "//" . Line::_(__Line__, __Class__) . " Execute the query to remove " . Placefix::_("Component") . ""; $script .= PHP_EOL . Indent::_(2) . "\$" . Placefix::_("component") . "_removed_done = \$db->execute();"; $script .= PHP_EOL . Indent::_(2) . "if (\$" . Placefix::_("component") . "_removed_done)"; $script .= PHP_EOL . Indent::_(2) . "{"; $script .= PHP_EOL . Indent::_(3) . "//" . Line::_(__Line__, __Class__) . " If successfully remove " . Placefix::_("Component") . " add queued success message."; $script .= PHP_EOL . Indent::_(3) . "\$app->enqueueMessage(JTe" . "xt::_('The com_" . Placefix::_("component") . " extension was removed from the #__action_logs_extensions table'));"; $script .= PHP_EOL . Indent::_(2) . "}"; return CFactory::_('Placeholder')->update_($script); } /** * get the View Uninstall Script * * @return string * */ protected function getViewUNINSTALLSCRIPT() { $script = PHP_EOL . PHP_EOL . Indent::_(2) . "//" . Line::_(__Line__, __Class__) . " Set db if not set already."; $script .= PHP_EOL . Indent::_(2) . "if (!isset(\$db))"; $script .= PHP_EOL . Indent::_(2) . "{"; $script .= PHP_EOL . Indent::_(3) . "\$db = JFactory::getDbo();"; $script .= PHP_EOL . Indent::_(2) . "}"; $script .= PHP_EOL . Indent::_(2) . "//" . Line::_(__Line__, __Class__) . " Set app if not set already."; $script .= PHP_EOL . Indent::_(2) . "if (!isset(\$app))"; $script .= PHP_EOL . Indent::_(2) . "{"; $script .= PHP_EOL . Indent::_(3) . "\$app = JFactory::getApplication();"; $script .= PHP_EOL . Indent::_(2) . "}"; $script .= PHP_EOL . Indent::_(2) . "//" . Line::_(__Line__, __Class__) . " Remove " . Placefix::_("Component") . " " . Placefix::_("View") . " from the action_log_config table"; $script .= PHP_EOL . Indent::_(2) . "\$" . Placefix::_("view") . "_action_log_config = array( \$db->quoteName('type_alias') . ' = '. \$db->quote('com_" . Placefix::_("component") . "." . Placefix::_("view") . "') );"; $script .= PHP_EOL . Indent::_(2) . "//" . Line::_(__Line__, __Class__) . " Create a new query object."; $script .= PHP_EOL . Indent::_(2) . "\$query = \$db->getQuery(true);"; $script .= PHP_EOL . Indent::_(2) . "\$query->delete(\$db->quoteName('#__action_log_config'));"; $script .= PHP_EOL . Indent::_(2) . "\$query->where(\$" . Placefix::_("view") . "_action_log_config);"; $script .= PHP_EOL . Indent::_(2) . "\$db->setQuery(\$query);"; $script .= PHP_EOL . Indent::_(2) . "//" . Line::_(__Line__, __Class__) . " Execute the query to remove com_" . Placefix::_("component") . "." . Placefix::_("view") . ""; $script .= PHP_EOL . Indent::_(2) . "\$" . Placefix::_("view") . "_action_log_config_done = \$db->execute();"; $script .= PHP_EOL . Indent::_(2) . "if (\$" . Placefix::_("view") . "_action_log_config_done)"; $script .= PHP_EOL . Indent::_(2) . "{"; $script .= PHP_EOL . Indent::_(3) . "//" . Line::_(__Line__, __Class__) . " If successfully removed " . Placefix::_("Component") . " " . Placefix::_("View") . " add queued success message."; $script .= PHP_EOL . Indent::_(3) . "\$app->enqueueMessage(JTe" . "xt::_('The com_" . Placefix::_("component") . "." . Placefix::_("view") . " type alias was removed from the #__action_log_config table'));"; $script .= PHP_EOL . Indent::_(2) . "}"; return CFactory::_('Placeholder')->update_($script); } /** * The array of active components * * @var array */ protected $componentsActive; /** * The activate option * * @var int */ protected $activateOption = 0; /** * Set the line number in comments * * @param string $context The context of the current executing component * * @return bool * */ protected function componentActive(&$context) { // check the active option if (!$this->activateOption) { $this->activateOption = $this->params->get('activate_option', 1); } // active for all components if ($this->activateOption == 1) { return true; } // first check is we have the active components set if ($this->activateOption == 2 && !ComponentbuilderHelper::checkArray($this->componentsActive)) { $this->componentsActive = $this->params->get('components'); } // only check if there are active if (ComponentbuilderHelper::checkArray($this->componentsActive)) { return in_array((int) filter_var($context, FILTER_SANITIZE_NUMBER_INT), $this->componentsActive); } return false; } }