Spade
Mini Shell
| Directory:~$ /proc/self/root/home/lmsyaran/www/joomla5/components/com_fabrik/models/ |
| [Home] [System Details] [Kill Me] |
<?php
/**
* Fabrik Plugin Manager Class
*
* @package Joomla
* @subpackage Fabrik
* @copyright Copyright (C) 2005-2020 Media A-Team, Inc. - All rights
reserved.
* @license GNU/GPL http://www.gnu.org/copyleft/gpl.html
*/
// No direct access
defined('_JEXEC') or die('Restricted access');
use Joomla\CMS\Language\Text;
use Joomla\CMS\Application\ApplicationHelper;
use Joomla\CMS\Plugin\PluginHelper;
use Joomla\CMS\Profiler\Profiler;
use Joomla\CMS\Factory;
use Joomla\CMS\Filesystem\File;
use Joomla\CMS\Filesystem\Folder;
use Joomla\String\StringHelper;
//use Joomla\CMS\Dispatcher\Dispatcher;
use Joomla\Event\Dispatcher as EventDispatcher;
use Joomla\CMS\HTML\HTMLHelper;
jimport('joomla.application.component.model');
jimport('joomla.filesystem.file');
/**
* Fabrik Plugin Manager Class
*
* @package Fabrik
* @since 3.0
*/
class FabrikFEModelPluginmanager extends FabModel
{
/**
* plugins
*
* @var array
*/
public $plugIns = array();
/**
* Groups
*
* @var array
*/
protected $group = null;
/**
* # of plugins run
*
* @var int
*/
protected $runPlugins = 0;
/**
* Element lists
*
* @var array
*/
protected $elementLists = array();
/**
* Contains out put from run plugins
*
* @var array
*/
public $data = array();
/**
* Contains plugin model
*
* @var array
*/
public $dataModels = array();
/**
* Array of array of form plugins - keyed on group id
*
* @var array
*/
protected $formPlugins = array();
/**
* @var array
*/
protected $_AbstractplugIns = array();
/**
* Get a html drop down list of the element types with this objs element
type selected as default
*
* @param string $default Selected option
* @param string $name Html name for drop down
* @param string $extra Extra info for drop down
* @param string $defaultLabel Html element type list
*
* @return string
*/
public function getElementTypeDd($default, $name = 'plugin',
$extra = 'class="inputbox elementtype"
size="1"', $defaultLabel = '')
{
$hash = $default . $name . $extra . $defaultLabel;
if (!array_key_exists($hash, $this->elementLists))
{
if ($defaultLabel == '')
{
$defaultLabel = Text::_('COM_FABRIK_PLEASE_SELECT');
}
$a = array(HTMLHelper::_('select.option', '',
$defaultLabel));
$elementsTypes = $this->_getList();
$elementsTypes = array_merge($a, $elementsTypes);
$this->elementLists[$hash] =
HTMLHelper::_('select.genericlist', $elementsTypes, $name,
$extra, 'value', 'text', $default);
}
return $this->elementLists[$hash];
}
/**
* Can the pluginmanager be used
*
* @deprecated
*
* @return true
*/
public function canUse()
{
return true;
}
/**
* Get an unordered list (<ul>) of plugins
*
* @param string $group Plugin group
* @param string $id Ul id
*
* @return string <ul>
*/
public function getList($group, $id)
{
$str = '<ul id="' . $id . '">';
$elementsTypes = $this->_getList();
foreach ($elementsTypes as $plugin)
{
$str .= '<li>' . $plugin->text .
'</li>';
}
$str .= '</ul>';
return $str;
}
/**
* Get a list of plugin ids/names for us in in a drop down list
* if no group set defaults to element list
*
* @param object $query Query
* @param int $limitstart Limit start
* @param int $limit # of records to return
*
* @return array plugin list
*/
protected function _getList($query = null, $limitstart = 0, $limit = 0)
{
$db = FabrikWorker::getDbo(true);
if (is_null($this->group))
{
$this->group = 'element';
}
$query = $db->getQuery(true);
$folder = $db->q('fabrik_' . $this->group);
$query->select('element AS value, name AS
text')->from('#__extensions')->where('folder
=' . $folder);
$db->setQuery($query);
$elementsTypes = $db->loadObjectList();
return $elementsTypes;
}
/**
* Get a certain group of plugins
*
* @param string $group Plugin group to load
*
* @return array Plugins
*/
public function &getPlugInGroup($group)
{
if (array_key_exists($group, $this->plugIns))
{
return $this->plugIns[$group];
}
else
{
return $this->loadPlugInGroup($group);
}
}
/**
* Add to the document head all element js files
* used in calendar to ensure all element js files are loaded from
unserialized form
*
* @return void
*/
public function loadJS()
{
$plugins = Folder::folders(JPATH_SITE .
'/plugins/fabrik_element', '.', false, false);
$files = array();
foreach ($plugins as $plugin)
{
$files[] = JPATH_SITE . '/plugins/fabrik_element/' . $plugin .
'/' . $plugin . '.js';
}
foreach ($files as $f)
{
$f = str_replace("\\", "/", str_replace(JPATH_SITE,
'', $f));
$file = basename($f);
$folder = dirname($f);
$folder = FabrikString::ltrimword($folder, '/') .
'/';
FabrikHelperHTML::script($folder . $file);
}
}
/**
* Loads ABSTRACT version of a plugin group
*
* @param string $group Plugin type -
element/form/list/cron/validationrule supported
*
* @return array
*/
protected function &loadPlugInGroup($group)
{
// $$$ rob 16/12/2011 - this was setting $this->plugIns, but if you
had 2 lists as admin modules
// and the first list had plugins, then the second list would remove that
plugin when this method was run
$folder = 'fabrik_' . $group;
$this->_AbstractplugIns[$group] = array();
$plugins = PluginHelper::getPlugin($folder);
foreach ($plugins as $plugin)
{
$this->_AbstractplugIns[$group][$plugin->name] = $plugin;
}
return $this->_AbstractplugIns[$group];
}
/**
* Load an individual plugin
*
* @param string $className Plugin name e.g. fabrikfield
* @param string $group Plugin type element/ form or list
*
* @return object Plugin
*/
public function getPlugIn($className = '', $group =
'')
{
if ($className != '' && (array_key_exists($group,
$this->plugIns) && array_key_exists($className,
$this->plugIns[$group])))
{
return $this->plugIns[$group][$className];
}
else
{
// $$$ rob 04/06/2011 hmm this was never caching the plugin so we were
always loading it
// return $this->loadPlugIn($className, $group);
$this->plugIns[$group][$className] = $this->loadPlugIn($className,
$group);
return $this->plugIns[$group][$className];
}
}
/**
* Load in the actual plugin objects for a given group
*
* @param string $group Plugin group
*
* @return array Plugins
*/
public function getPlugInGroupPlugins($group)
{
$plugins = $this->getPlugInGroup($group);
$r = array();
foreach ($plugins as $plugin)
{
$r[] = $this->loadPlugIn($plugin->name, $group);
}
return $r;
}
/**
* Load plugin
*
* @param string $className Plugin name e.g. fabrikfield
* @param string $group Plugin type element/ form or list
*
* @throws RuntimeException
*
* @return FabrikPlugin Plugin object
*/
public function loadPlugIn($className = '', $group =
'')
{
if ($group == 'table')
{
$group = 'list';
}
$group = StringHelper::strtolower($group);
if (!PluginHelper::isEnabled('fabrik_' . $group, $className))
{
throw new RuntimeException('plugin manager: plugin is
disabled or ACL protected: ' . $className);
}
PluginHelper::importPlugin('fabrik_' . $group, $className);
//H $dispatcher = JEventDispatcher::getInstance();
$dispatcher = Factory::getApplication()->getDispatcher();
if ($className != '')
{
$file = JPATH_PLUGINS . '/fabrik_' . $group . '/' .
$className . '/' . $className . '.php';
if (File::exists($file))
{
require_once $file;
}
else
{
$file = JPATH_PLUGINS . '/fabrik_' . $group . '/' .
$className . '/models/' . $className . '.php';
if (File::exists($file))
{
require_once $file;
}
else
{
throw new RuntimeException('plugin manager: did not load ' .
$file);
}
}
}
$class = 'plgFabrik_' . (!empty($group) ?
StringHelper::ucfirst($group) : '') . (!empty($className) ?
StringHelper::ucfirst($className) : '');
$conf = array();
$conf['name'] = !empty($className) ?
StringHelper::strtolower($className) : '';
$conf['type'] = StringHelper::strtolower('fabrik_' .
$group);
$plugIn = null;
if (class_exists($class))
{
$plugIn = new $class($dispatcher, $conf);//H don't know if this is
correct
}
else
{
// Allow for namespaced plugins
$class = 'Fabrik\\Plugins\\' . StringHelper::ucfirst($group) .
'\\' . StringHelper::ucfirst($className);
$plugIn = new $class($dispatcher, $conf);
}
// Needed for viz
$client = ApplicationHelper::getClientInfo(0);
$lang = $this->lang;
$folder = 'fabrik_' . $group;
$langFile = 'plg_' . $folder . '_' . $className;
$langPath = $client->path . '/plugins/' . $folder .
'/' . $className;
// load both default and current, so untranslated strings fall back to
default
$lang->load($langFile, $langPath, $lang->getDefault(), false,
false);
$lang->load($langFile, $langPath, null, false, false);
// Load system ini file
$langFile .= '.sys';
$lang->load($langFile, $langPath, $lang->getDefault(), false,
false);
$lang->load($langFile, $langPath, null, false, false);
if (!is_object($plugIn))
{
throw new RuntimeException('plugin manager: did not load ' .
$group . '.' . $className);
}
return $plugIn;
}
/**
* Unset a form's element plugins
*
* @param JModel $formModel Form model
*
* @since 3.1b
*
* @return void
*/
public function clearFormPlugins($formModel)
{
$sig = $this->package . '.' .
$formModel->get('id');
unset($this->formPlugins[$sig]);
}
/**
* Load all the forms element plugins
*
* @param object &$form Form model
*
* @return array Group objects with plugin objects loaded in
group->elements
*/
public function getFormPlugins(&$form)
{
$profiler = Profiler::getInstance('Application');
if (!isset($this->formPlugins))
{
$this->formPlugins = array();
}
// Ensure packages load their own form
$sig = $this->package . '.' . $form->get('id');
JDEBUG ? $profiler->mark('pluginmanager:getFormPlugins:start -
' . $sig) : null;
if (!array_key_exists($sig, $this->formPlugins))
{
$this->formPlugins[$sig] = array();
$lang = $this->lang;
$folder = 'fabrik_element';
$client = ApplicationHelper::getClientInfo(0);
$groupIds = $form->getGroupIds();
if (empty($groupIds))
{
// New form
return array();
}
/**
* Changed this code to use two separate queries, rather than joining
#__extensions on the
* plugin name, as the J! 3.5 release changed collation of J! table, and
this breaks the
* for some sites with older MySQL or non-standard collation
*/
// build list of plugins used on this form ...
$db = FabrikWorker::getDbo(true);
$query = $db->getQuery(true);
$select = '*, e.name AS name, e.id AS id, e.published AS published,
e.label AS label,'
. 'e.plugin, e.params AS params, e.access AS access, e.ordering AS
ordering';
$query->select($select);
$query->from('#__fabrik_elements AS e');
$query->where('group_id IN (' . implode(',',
$groupIds) . ')');
// Ignore trashed elements
$query->where('e.published != -2');
$query->order("group_id, e.ordering");
$db->setQuery($query);
$elements = $db->loadObjectList();
// now build list of all available Fabrik plugins ...
$query->clear();
$query
->select('element')
->from('#__extensions')
->where('folder = "fabrik_element"')
->where('enabled = "1"', 'AND');
$db->setQuery($query);
$extensions = $db->loadObjectList('element');
// Don't assign the elements into Joomla's main dispatcher as
this causes out of memory errors in J1.6rc1
//H $dispatcher = new JDispatcher;
$dispatcher = Factory::getApplication()->getDispatcher();
$groupModels = $form->getGroups();
$group = 'element';
foreach ($elements as $element)
{
// see if this plugin has been uninstalled or unpubished in J!
if (!array_key_exists($element->plugin, $extensions))
{
continue;
}
JDEBUG ? $profiler->mark('pluginmanager:getFormPlugins:' .
$element->id . '' . $element->plugin) : null;
require_once JPATH_PLUGINS . '/fabrik_element/' .
$element->plugin . '/' . $element->plugin .
'.php';
$class = 'PlgFabrik_Element' . $element->plugin;
if (class_exists($class))
{
$pluginModel = new $class($dispatcher, array());
//bootPlugin($plugin, $type) where $type = fabrik_element and $plugin
= field
//H $pluginModel =
Factory::getApplication()->bootPlugin($element->plugin,
'PlgFabrik_Element');
}
else
{
// Allow for namespaced plugins
$class = 'Fabrik\\Plugins\\' . StringHelper::ucfirst($group)
. '\\' . StringHelper::ucfirst($element->plugin);
$pluginModel = new $class($dispatcher, array());
//H $pluginModel =
Factory::getApplication()->bootPlugin($element->plugin,
'PlgFabrik_Element');
}
if (!is_object($pluginModel))
{
continue;
}
$pluginModel->xmlPath = COM_FABRIK_FRONTEND . '/plugins/'
. $group . '/' . $element->plugin . '/' .
$element->plugin . '.xml';
$pluginModel->setId($element->id);
$groupModel = $groupModels[$element->group_id];
$langFile = 'plg_' . $folder . '_' .
$element->plugin;
$langPath = $client->path . '/plugins/' . $folder .
'/' . $element->plugin;
// load both default and current, so untranslated strings fall back to
default
$lang->load($langFile, $langPath, $lang->getDefault(), false,
false);
$lang->load($langFile, $langPath, null, false, false);
$listModel = $form->getListModel();
$pluginModel->setContext($groupModel, $form, $listModel);
$pluginModel->bindToElement($element);
$groupModel->elements[$pluginModel->getId()] = $pluginModel;
}
foreach ($groupModels as $groupId => $g)
{
$this->formPlugins[$sig][$groupId] = $g;
}
}
return $this->formPlugins[$sig];
}
/**
* Short cut to get an element plugin
*
* @param int $id Element id
*
* @return PlgFabrik_Element Element plugin
*/
public function getElementPlugin($id)
{
return $this->getPluginFromId($id);
}
/**
* Get a plugin based on its id
*
* @param int $id Plugin id
* @param string $type Plugin type
*
* @return PlgFabrik_Element|? plugin
*/
public function getPluginFromId($id, $type = 'Element')
{
$el = FabTable::getInstance($type, 'FabrikTable');
$el->load($id);
$o = $this->loadPlugIn($el->plugin, $type);
$o->setId($id);
switch ($type)
{
default:
$o->getTable();
break;
case 'Element':
$o->getElement();
break;
}
return $o;
}
/**
* not used
*
* @param string $group Name of plugin group to load
* @param array $lists List of default element lists
* @param array &$elementModel List of default and plugin element
lists
*
* @deprecated
*
* @return void
*/
protected function loadLists($group, $lists, &$elementModel)
{
}
/**
* Run form & element plugins - yeah!
*
* @param string $method To check and call - corresponds to
stage of form processing
* @param object &$parentModel Model calling the plugin form/list
* @param string $type Plugin type to call form/list
*
* @return array of bools: false if error found and processed, otherwise
true
*/
public function runPlugins($method, &$parentModel, $type =
'form')
{
$profiler = Profiler::getInstance('Application');
JDEBUG ? $profiler->mark("runPlugins: start: $method") :
null;
if ($type == 'form')
{
/**
* $$$ rob allow for list plugins to hook into form plugin calls -
methods are mapped as:
* form method = 'onLoad' => list method =>
'onFormLoad'
*/
$tmethod = 'onForm' . FabrikString::ltrimword($method,
'on');
$listModel = $parentModel->getListModel();
$this->runPlugins($tmethod, $listModel, 'list');
}
$params = $parentModel->getParams();
$return = array();
$usedPlugins = (array) $params->get('plugins');
$usedLocations = (array) $params->get('plugin_locations');
$usedEvents = (array) $params->get('plugin_events');
$states = (array) $params->get('plugin_state');
$this->data = array();
if ($type != 'list')
{
if (method_exists($parentModel, 'getGroupsHiarachy'))
{
$groups = $parentModel->getGroupsHiarachy();
foreach ($groups as $groupModel)
{
$elementModels = $groupModel->getPublishedElements();
foreach ($elementModels as $elementModel)
{
if (method_exists($elementModel, $method))
{
JDEBUG ? $profiler->mark("runPlugins: start element method:
$method") : null;
$elementModel->$method($parentModel);
}
}
}
}
}
$c = 0;
$runPlugins = 0;
/**
* if true then a plugin has returned true from runAway()
* which means that any other plugin in the same group should not be run.
*/
$runningAway = false;
$mainData = array();
foreach ($usedPlugins as $usedPlugin)
{
if ($runningAway)
{
// "I soiled my armour I was so scared!"
break;
}
$state = FArrayHelper::getValue($states, $c, 1);
if ($state == false)
{
$c++;
continue;
}
if ($usedPlugin != '')
{
$plugin = $this->getPlugIn($usedPlugin, $type);
// Testing this if statement as onLoad was being called on form email
plugin when no method available
if (method_exists($plugin, $method))
{
JDEBUG ? $profiler->mark("runPlugins: method_exists:
$usedPlugin, $method") : null;
$plugin->renderOrder = $c;
$modelTable = $parentModel->getTable();
$pluginParams = $plugin->setParams($params, $c);
$location = FArrayHelper::getValue($usedLocations, $c);
$event = FArrayHelper::getValue($usedEvents, $c);
$plugin->setModel($parentModel);
if ($plugin->canUse($location, $event))
{
$pluginArgs = array();
if (func_num_args() > 3)
{
$t = func_get_args();
$pluginArgs = array_splice($t, 3);
}
$preflightMethod = $method . '_preflightCheck';
$preflightCheck = method_exists($plugin, $preflightMethod) ?
$plugin->$preflightMethod($pluginArgs)
: true;
if ($preflightCheck)
{
JDEBUG ? $profiler->mark("runPlugins: preflight OK,
starting: $usedPlugin, $method") : null;
$ok = $plugin->$method($pluginArgs);
if ($ok === false)
{
$return[] = false;
// if we were processing and it errored out, we need to pick up any
error messages
if ($method === 'process')
{
$m = $method . '_result';
if (method_exists($plugin, $m))
{
$this->data[] = $mainData[] = $plugin->$m($c);
$this->dataModels[] = $plugin;
}
}
}
else
{
$thisReturn = $plugin->customProcessResult($method);
$return[] = $thisReturn;
$m = $method . '_result';
if (method_exists($plugin, $m))
{
$this->data[] = $mainData[] = $plugin->$m($c);
$this->dataModels[] = $plugin;
}
}
$runPlugins++;
if ($plugin->runAway($method))
{
$runningAway = true;
}
//$mainData = $this->data;
if ($type == 'list' && $method !==
'observe')
{
$this->runPlugins('observe', $parentModel,
'list', $plugin, $method);
}
//$this->data = $mainData;
}
}
}
$c++;
}
}
$this->data = $mainData;
$this->runPlugins = $runPlugins;
JDEBUG ? $profiler->mark("runPlugins: end: $method") : null;
return array_unique($return);
}
/**
* Test if a plugin is installed
*
* @param string $group Plugin group
* @param string $plugin Plugin name
*
* @return bool
*/
public function pluginExists($group, $plugin)
{
$plugins = $this->loadPlugInGroup($group);
if (in_array($plugin, array_keys($plugins)))
{
return true;
}
return false;
}
}