forked from joomla/Component-Builder
631 lines
17 KiB
PHP
631 lines
17 KiB
PHP
<?php
|
|
/**
|
|
* @package Joomla.Component.Builder
|
|
*
|
|
* @created 30th April, 2015
|
|
* @author Llewellyn van der Merwe <https://dev.vdm.io>
|
|
* @git Joomla Component Builder <https://git.vdm.dev/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
|
|
*/
|
|
namespace VDM\Component\Componentbuilder\Administrator\Model;
|
|
|
|
use Joomla\CMS\Factory;
|
|
use Joomla\CMS\Language\Text;
|
|
use Joomla\CMS\Application\CMSApplicationInterface;
|
|
use Joomla\CMS\Component\ComponentHelper;
|
|
use Joomla\CMS\MVC\Model\ListModel;
|
|
use Joomla\CMS\MVC\Factory\MVCFactoryInterface;
|
|
use Joomla\CMS\Plugin\PluginHelper;
|
|
use Joomla\CMS\Router\Route;
|
|
use Joomla\CMS\User\User;
|
|
use Joomla\Utilities\ArrayHelper;
|
|
use Joomla\Input\Input;
|
|
use VDM\Component\Componentbuilder\Administrator\Helper\ComponentbuilderHelper;
|
|
use Joomla\CMS\Helper\TagsHelper;
|
|
use VDM\Joomla\Utilities\ArrayHelper as UtilitiesArrayHelper;
|
|
use VDM\Joomla\Utilities\ObjectHelper;
|
|
use VDM\Joomla\Utilities\StringHelper;
|
|
|
|
// No direct access to this file
|
|
\defined('_JEXEC') or die;
|
|
|
|
/**
|
|
* Templates List Model
|
|
*
|
|
* @since 1.6
|
|
*/
|
|
class TemplatesModel extends ListModel
|
|
{
|
|
/**
|
|
* The application object.
|
|
*
|
|
* @var CMSApplicationInterface The application instance.
|
|
* @since 3.2.0
|
|
*/
|
|
protected CMSApplicationInterface $app;
|
|
|
|
/**
|
|
* The styles array.
|
|
*
|
|
* @var array
|
|
* @since 4.3
|
|
*/
|
|
protected array $styles = [
|
|
'administrator/components/com_componentbuilder/assets/css/admin.css',
|
|
'administrator/components/com_componentbuilder/assets/css/templates.css'
|
|
];
|
|
|
|
/**
|
|
* The scripts array.
|
|
*
|
|
* @var array
|
|
* @since 4.3
|
|
*/
|
|
protected array $scripts = [
|
|
'administrator/components/com_componentbuilder/assets/js/admin.js'
|
|
];
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param array $config An array of configuration options (name, state, dbo, table_path, ignore_request).
|
|
* @param ?MVCFactoryInterface $factory The factory.
|
|
*
|
|
* @since 1.6
|
|
* @throws \Exception
|
|
*/
|
|
public function __construct($config = [], MVCFactoryInterface $factory = null)
|
|
{
|
|
if (empty($config['filter_fields']))
|
|
{
|
|
$config['filter_fields'] = array(
|
|
'a.id','id',
|
|
'a.published','published',
|
|
'a.access','access',
|
|
'a.ordering','ordering',
|
|
'a.created_by','created_by',
|
|
'a.modified_by','modified_by',
|
|
'g.name','dynamic_get',
|
|
'a.add_php_view','add_php_view',
|
|
'a.name','name',
|
|
'a.description','description'
|
|
);
|
|
}
|
|
|
|
parent::__construct($config, $factory);
|
|
|
|
$this->app ??= Factory::getApplication();
|
|
}
|
|
|
|
/**
|
|
* Method to auto-populate the model state.
|
|
*
|
|
* Note. Calling getState in this method will result in recursion.
|
|
*
|
|
* @param string $ordering An optional ordering field.
|
|
* @param string $direction An optional direction (asc|desc).
|
|
*
|
|
* @return void
|
|
* @since 1.7.0
|
|
*/
|
|
protected function populateState($ordering = null, $direction = null)
|
|
{
|
|
$app = $this->app;
|
|
|
|
// Adjust the context to support modal layouts.
|
|
if ($layout = $app->input->get('layout'))
|
|
{
|
|
$this->context .= '.' . $layout;
|
|
}
|
|
|
|
// Check if the form was submitted
|
|
$formSubmited = $app->input->post->get('form_submited');
|
|
|
|
$access = $this->getUserStateFromRequest($this->context . '.filter.access', 'filter_access', 0, 'int');
|
|
if ($formSubmited)
|
|
{
|
|
$access = $app->input->post->get('access');
|
|
$this->setState('filter.access', $access);
|
|
}
|
|
|
|
$published = $this->getUserStateFromRequest($this->context . '.filter.published', 'filter_published', '');
|
|
$this->setState('filter.published', $published);
|
|
|
|
$created_by = $this->getUserStateFromRequest($this->context . '.filter.created_by', 'filter_created_by', '');
|
|
$this->setState('filter.created_by', $created_by);
|
|
|
|
$created = $this->getUserStateFromRequest($this->context . '.filter.created', 'filter_created');
|
|
$this->setState('filter.created', $created);
|
|
|
|
$sorting = $this->getUserStateFromRequest($this->context . '.filter.sorting', 'filter_sorting', 0, 'int');
|
|
$this->setState('filter.sorting', $sorting);
|
|
|
|
$search = $this->getUserStateFromRequest($this->context . '.filter.search', 'filter_search');
|
|
$this->setState('filter.search', $search);
|
|
|
|
$dynamic_get = $this->getUserStateFromRequest($this->context . '.filter.dynamic_get', 'filter_dynamic_get');
|
|
if ($formSubmited)
|
|
{
|
|
$dynamic_get = $app->input->post->get('dynamic_get');
|
|
$this->setState('filter.dynamic_get', $dynamic_get);
|
|
}
|
|
|
|
$add_php_view = $this->getUserStateFromRequest($this->context . '.filter.add_php_view', 'filter_add_php_view');
|
|
if ($formSubmited)
|
|
{
|
|
$add_php_view = $app->input->post->get('add_php_view');
|
|
$this->setState('filter.add_php_view', $add_php_view);
|
|
}
|
|
|
|
$name = $this->getUserStateFromRequest($this->context . '.filter.name', 'filter_name');
|
|
if ($formSubmited)
|
|
{
|
|
$name = $app->input->post->get('name');
|
|
$this->setState('filter.name', $name);
|
|
}
|
|
|
|
$description = $this->getUserStateFromRequest($this->context . '.filter.description', 'filter_description');
|
|
if ($formSubmited)
|
|
{
|
|
$description = $app->input->post->get('description');
|
|
$this->setState('filter.description', $description);
|
|
}
|
|
|
|
// List state information.
|
|
parent::populateState($ordering, $direction);
|
|
}
|
|
|
|
/**
|
|
* Method to get an array of data items.
|
|
*
|
|
* @return mixed An array of data items on success, false on failure.
|
|
* @since 1.6
|
|
*/
|
|
public function getItems()
|
|
{
|
|
// Check in items
|
|
$this->checkInNow();
|
|
|
|
// load parent items
|
|
$items = parent::getItems();
|
|
|
|
// Set values to display correctly.
|
|
if (UtilitiesArrayHelper::check($items))
|
|
{
|
|
// Get the user object if not set.
|
|
if (!isset($user) || !ObjectHelper::check($user))
|
|
{
|
|
$user = $this->getCurrentUser();
|
|
}
|
|
foreach ($items as $nr => &$item)
|
|
{
|
|
// Remove items the user can't access.
|
|
$access = ($user->authorise('template.access', 'com_componentbuilder.template.' . (int) $item->id) && $user->authorise('template.access', 'com_componentbuilder'));
|
|
if (!$access)
|
|
{
|
|
unset($items[$nr]);
|
|
continue;
|
|
}
|
|
|
|
}
|
|
}
|
|
|
|
// set selection value to a translatable value
|
|
if (UtilitiesArrayHelper::check($items))
|
|
{
|
|
foreach ($items as $nr => &$item)
|
|
{
|
|
// convert add_php_view
|
|
$item->add_php_view = $this->selectionTranslation($item->add_php_view, 'add_php_view');
|
|
}
|
|
}
|
|
|
|
|
|
// return items
|
|
return $items;
|
|
}
|
|
|
|
/**
|
|
* Method to convert selection values to translatable string.
|
|
*
|
|
* @return string The translatable string.
|
|
*/
|
|
public function selectionTranslation($value,$name)
|
|
{
|
|
// Array of add_php_view language strings
|
|
if ($name === 'add_php_view')
|
|
{
|
|
$add_php_viewArray = array(
|
|
1 => 'COM_COMPONENTBUILDER_TEMPLATE_YES',
|
|
0 => 'COM_COMPONENTBUILDER_TEMPLATE_NO'
|
|
);
|
|
// Now check if value is found in this array
|
|
if (isset($add_php_viewArray[$value]) && StringHelper::check($add_php_viewArray[$value]))
|
|
{
|
|
return $add_php_viewArray[$value];
|
|
}
|
|
}
|
|
return $value;
|
|
}
|
|
|
|
/**
|
|
* Method to build an SQL query to load the list data.
|
|
*
|
|
* @return string An SQL query
|
|
* @since 1.6
|
|
*/
|
|
protected function getListQuery()
|
|
{
|
|
// Get the user object.
|
|
$user = $this->getCurrentUser();
|
|
// Create a new query object.
|
|
$db = $this->getDatabase();
|
|
$query = $db->getQuery(true);
|
|
|
|
// Select some fields
|
|
$query->select('a.*');
|
|
|
|
// From the componentbuilder_item table
|
|
$query->from($db->quoteName('#__componentbuilder_template', 'a'));
|
|
|
|
// From the componentbuilder_dynamic_get table.
|
|
$query->select($db->quoteName('g.name','dynamic_get_name'));
|
|
$query->join('LEFT', $db->quoteName('#__componentbuilder_dynamic_get', 'g') . ' ON (' . $db->quoteName('a.dynamic_get') . ' = ' . $db->quoteName('g.id') . ')');
|
|
|
|
// Filter by published state
|
|
$published = $this->getState('filter.published');
|
|
if (is_numeric($published))
|
|
{
|
|
$query->where('a.published = ' . (int) $published);
|
|
}
|
|
elseif ($published === '')
|
|
{
|
|
$query->where('(a.published = 0 OR a.published = 1)');
|
|
}
|
|
|
|
// Join over the asset groups.
|
|
$query->select('ag.title AS access_level');
|
|
$query->join('LEFT', '#__viewlevels AS ag ON ag.id = a.access');
|
|
// Filter by access level.
|
|
$_access = $this->getState('filter.access');
|
|
if ($_access && is_numeric($_access))
|
|
{
|
|
$query->where('a.access = ' . (int) $_access);
|
|
}
|
|
elseif (UtilitiesArrayHelper::check($_access))
|
|
{
|
|
// Secure the array for the query
|
|
$_access = ArrayHelper::toInteger($_access);
|
|
// Filter by the Access Array.
|
|
$query->where('a.access IN (' . implode(',', $_access) . ')');
|
|
}
|
|
// Implement View Level Access
|
|
if (!$user->authorise('core.options', 'com_componentbuilder'))
|
|
{
|
|
$groups = implode(',', $user->getAuthorisedViewLevels());
|
|
$query->where('a.access IN (' . $groups . ')');
|
|
}
|
|
// Filter by search.
|
|
$search = $this->getState('filter.search');
|
|
if (!empty($search))
|
|
{
|
|
if (stripos($search, 'id:') === 0)
|
|
{
|
|
$query->where('a.id = ' . (int) substr($search, 3));
|
|
}
|
|
else
|
|
{
|
|
$search = $db->quote('%' . $db->escape($search) . '%');
|
|
$query->where('(a.name LIKE '.$search.' OR a.description LIKE '.$search.' OR a.dynamic_get LIKE '.$search.' OR g.name LIKE '.$search.' OR a.alias LIKE '.$search.')');
|
|
}
|
|
}
|
|
|
|
// Filter by Dynamic_get.
|
|
$_dynamic_get = $this->getState('filter.dynamic_get');
|
|
if (is_numeric($_dynamic_get))
|
|
{
|
|
if (is_float($_dynamic_get))
|
|
{
|
|
$query->where('a.dynamic_get = ' . (float) $_dynamic_get);
|
|
}
|
|
else
|
|
{
|
|
$query->where('a.dynamic_get = ' . (int) $_dynamic_get);
|
|
}
|
|
}
|
|
elseif (StringHelper::check($_dynamic_get))
|
|
{
|
|
$query->where('a.dynamic_get = ' . $db->quote($db->escape($_dynamic_get)));
|
|
}
|
|
// Filter by Add_php_view.
|
|
$_add_php_view = $this->getState('filter.add_php_view');
|
|
if (is_numeric($_add_php_view))
|
|
{
|
|
if (is_float($_add_php_view))
|
|
{
|
|
$query->where('a.add_php_view = ' . (float) $_add_php_view);
|
|
}
|
|
else
|
|
{
|
|
$query->where('a.add_php_view = ' . (int) $_add_php_view);
|
|
}
|
|
}
|
|
elseif (StringHelper::check($_add_php_view))
|
|
{
|
|
$query->where('a.add_php_view = ' . $db->quote($db->escape($_add_php_view)));
|
|
}
|
|
|
|
// Add the list ordering clause.
|
|
$orderCol = $this->getState('list.ordering', 'a.id');
|
|
$orderDirn = $this->getState('list.direction', 'desc');
|
|
if ($orderCol != '')
|
|
{
|
|
// Check that the order direction is valid encase we have a field called direction as part of filers.
|
|
$orderDirn = (is_string($orderDirn) && in_array(strtolower($orderDirn), ['asc', 'desc'])) ? $orderDirn : 'desc';
|
|
$query->order($db->escape($orderCol . ' ' . $orderDirn));
|
|
}
|
|
|
|
return $query;
|
|
}
|
|
|
|
/**
|
|
* Method to get list export data.
|
|
*
|
|
* @param array $pks The ids of the items to get
|
|
* @param JUser $user The user making the request
|
|
*
|
|
* @return mixed An array of data items on success, false on failure.
|
|
*/
|
|
public function getExportData($pks, $user = null)
|
|
{
|
|
// setup the query
|
|
if (($pks_size = UtilitiesArrayHelper::check($pks)) !== false || 'bulk' === $pks)
|
|
{
|
|
// Set a value to know this is export method. (USE IN CUSTOM CODE TO ALTER OUTCOME)
|
|
$_export = true;
|
|
// Get the user object if not set.
|
|
if (!isset($user) || !ObjectHelper::check($user))
|
|
{
|
|
$user = $this->getCurrentUser();
|
|
}
|
|
// Create a new query object.
|
|
$db = $this->getDatabase();
|
|
$query = $db->getQuery(true);
|
|
|
|
// Select some fields
|
|
$query->select('a.*');
|
|
|
|
// From the componentbuilder_template table
|
|
$query->from($db->quoteName('#__componentbuilder_template', 'a'));
|
|
// The bulk export path
|
|
if ('bulk' === $pks)
|
|
{
|
|
$query->where('a.id > 0');
|
|
}
|
|
// A large array of ID's will not work out well
|
|
elseif ($pks_size > 500)
|
|
{
|
|
// Use lowest ID
|
|
$query->where('a.id >= ' . (int) min($pks));
|
|
// Use highest ID
|
|
$query->where('a.id <= ' . (int) max($pks));
|
|
}
|
|
// The normal default path
|
|
else
|
|
{
|
|
$query->where('a.id IN (' . implode(',',$pks) . ')');
|
|
}
|
|
// Implement View Level Access
|
|
if (!$user->authorise('core.options', 'com_componentbuilder'))
|
|
{
|
|
$groups = implode(',', $user->getAuthorisedViewLevels());
|
|
$query->where('a.access IN (' . $groups . ')');
|
|
}
|
|
|
|
// Order the results by ordering
|
|
$query->order('a.id desc');
|
|
|
|
// Load the items
|
|
$db->setQuery($query);
|
|
$db->execute();
|
|
if ($db->getNumRows())
|
|
{
|
|
$items = $db->loadObjectList();
|
|
|
|
// Set values to display correctly.
|
|
if (UtilitiesArrayHelper::check($items))
|
|
{
|
|
foreach ($items as $nr => &$item)
|
|
{
|
|
// Remove items the user can't access.
|
|
$access = ($user->authorise('template.access', 'com_componentbuilder.template.' . (int) $item->id) && $user->authorise('template.access', 'com_componentbuilder'));
|
|
if (!$access)
|
|
{
|
|
unset($items[$nr]);
|
|
continue;
|
|
}
|
|
|
|
// decode php_view
|
|
$item->php_view = base64_decode($item->php_view);
|
|
// decode template
|
|
$item->template = base64_decode($item->template);
|
|
// unset the values we don't want exported.
|
|
unset($item->asset_id);
|
|
unset($item->checked_out);
|
|
unset($item->checked_out_time);
|
|
}
|
|
}
|
|
// Add headers to items array.
|
|
$headers = $this->getExImPortHeaders();
|
|
if (ObjectHelper::check($headers))
|
|
{
|
|
array_unshift($items,$headers);
|
|
}
|
|
return $items;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Method to get header.
|
|
*
|
|
* @return mixed An array of data items on success, false on failure.
|
|
*/
|
|
public function getExImPortHeaders()
|
|
{
|
|
// Get a db connection.
|
|
$db = Factory::getDbo();
|
|
// get the columns
|
|
$columns = $db->getTableColumns("#__componentbuilder_template");
|
|
if (UtilitiesArrayHelper::check($columns))
|
|
{
|
|
// remove the headers you don't import/export.
|
|
unset($columns['asset_id']);
|
|
unset($columns['checked_out']);
|
|
unset($columns['checked_out_time']);
|
|
$headers = new \stdClass();
|
|
foreach ($columns as $column => $type)
|
|
{
|
|
$headers->{$column} = $column;
|
|
}
|
|
return $headers;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Method to get a store id based on model configuration state.
|
|
*
|
|
* @return string A store id.
|
|
* @since 1.6
|
|
*/
|
|
protected function getStoreId($id = '')
|
|
{
|
|
// Compile the store id.
|
|
$id .= ':' . $this->getState('filter.id');
|
|
$id .= ':' . $this->getState('filter.search');
|
|
$id .= ':' . $this->getState('filter.published');
|
|
// Check if the value is an array
|
|
$_access = $this->getState('filter.access');
|
|
if (UtilitiesArrayHelper::check($_access))
|
|
{
|
|
$id .= ':' . implode(':', $_access);
|
|
}
|
|
// Check if this is only an number or string
|
|
elseif (is_numeric($_access)
|
|
|| StringHelper::check($_access))
|
|
{
|
|
$id .= ':' . $_access;
|
|
}
|
|
$id .= ':' . $this->getState('filter.ordering');
|
|
$id .= ':' . $this->getState('filter.created_by');
|
|
$id .= ':' . $this->getState('filter.modified_by');
|
|
$id .= ':' . $this->getState('filter.dynamic_get');
|
|
$id .= ':' . $this->getState('filter.add_php_view');
|
|
$id .= ':' . $this->getState('filter.name');
|
|
$id .= ':' . $this->getState('filter.description');
|
|
|
|
return parent::getStoreId($id);
|
|
}
|
|
|
|
/**
|
|
* Method to get the styles that have to be included on the view
|
|
*
|
|
* @return array styles files
|
|
* @since 4.3
|
|
*/
|
|
public function getStyles(): array
|
|
{
|
|
return $this->styles;
|
|
}
|
|
|
|
/**
|
|
* Method to set the styles that have to be included on the view
|
|
*
|
|
* @return void
|
|
* @since 4.3
|
|
*/
|
|
public function setStyles(string $path): void
|
|
{
|
|
$this->styles[] = $path;
|
|
}
|
|
|
|
/**
|
|
* Method to get the script that have to be included on the view
|
|
*
|
|
* @return array script files
|
|
* @since 4.3
|
|
*/
|
|
public function getScripts(): array
|
|
{
|
|
return $this->scripts;
|
|
}
|
|
|
|
/**
|
|
* Method to set the script that have to be included on the view
|
|
*
|
|
* @return void
|
|
* @since 4.3
|
|
*/
|
|
public function setScript(string $path): void
|
|
{
|
|
$this->scripts[] = $path;
|
|
}
|
|
|
|
/**
|
|
* Build an SQL query to checkin all items left checked out longer then a set time.
|
|
*
|
|
* @return bool
|
|
* @since 3.2.0
|
|
*/
|
|
protected function checkInNow(): bool
|
|
{
|
|
// Get set check in time
|
|
$time = ComponentHelper::getParams('com_componentbuilder')->get('check_in');
|
|
|
|
if ($time)
|
|
{
|
|
// Get a db connection.
|
|
$db = $this->getDatabase();
|
|
// Reset query.
|
|
$query = $db->getQuery(true);
|
|
$query->select('*');
|
|
$query->from($db->quoteName('#__componentbuilder_template'));
|
|
// Only select items that are checked out.
|
|
$query->where($db->quoteName('checked_out') . '!=0');
|
|
$db->setQuery($query, 0, 1);
|
|
$db->execute();
|
|
if ($db->getNumRows())
|
|
{
|
|
// Get Yesterdays date.
|
|
$date = Factory::getDate()->modify($time)->toSql();
|
|
// Reset query.
|
|
$query = $db->getQuery(true);
|
|
|
|
// Fields to update.
|
|
$fields = array(
|
|
$db->quoteName('checked_out_time') . '=\'0000-00-00 00:00:00\'',
|
|
$db->quoteName('checked_out') . '=0'
|
|
);
|
|
|
|
// Conditions for which records should be updated.
|
|
$conditions = array(
|
|
$db->quoteName('checked_out') . '!=0',
|
|
$db->quoteName('checked_out_time') . '<\''.$date.'\''
|
|
);
|
|
|
|
// Check table.
|
|
$query->update($db->quoteName('#__componentbuilder_template'))->set($fields)->where($conditions);
|
|
|
|
$db->setQuery($query);
|
|
|
|
return $db->execute();
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
}
|