* @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 */ 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\Form\Form; use Joomla\CMS\Filter\InputFilter; use Joomla\CMS\Filter\OutputFilter; use Joomla\CMS\MVC\Model\AdminModel; use Joomla\CMS\MVC\Factory\MVCFactoryInterface; use Joomla\CMS\Table\Table; use Joomla\CMS\UCM\UCMType; use Joomla\CMS\Versioning\VersionableModelTrait; use Joomla\CMS\User\User; use Joomla\Registry\Registry; use Joomla\String\StringHelper; use Joomla\Utilities\ArrayHelper; use Joomla\Input\Input; use VDM\Component\Componentbuilder\Administrator\Helper\ComponentbuilderHelper; use Joomla\CMS\Helper\TagsHelper; use VDM\Joomla\Utilities\StringHelper as UtilitiesStringHelper; use VDM\Joomla\Utilities\ObjectHelper; use VDM\Joomla\Utilities\GuidHelper; use VDM\Joomla\Utilities\ArrayHelper as UtilitiesArrayHelper; // No direct access to this file \defined('_JEXEC') or die; /** * Componentbuilder Validation_rule Admin Model * * @since 1.6 */ class Validation_ruleModel extends AdminModel { use VersionableModelTrait; /** * The tab layout fields array. * * @var array * @since 3.0.0 */ protected $tabLayoutFields = array( 'extends_formrule' => array( 'left' => array( 'name' ), 'right' => array( 'short_description' ), 'fullwidth' => array( 'php' ), 'above' => array( 'inherit' ) ) ); /** * 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/validation_rule.css' ]; /** * The scripts array. * * @var array * @since 4.3 */ protected array $scripts = [ 'administrator/components/com_componentbuilder/assets/js/admin.js', 'media/com_componentbuilder/js/validation_rule.js' ]; /** * @var string The prefix to use with controller messages. * @since 1.6 */ protected $text_prefix = 'COM_COMPONENTBUILDER'; /** * The type alias for this content type. * * @var string * @since 3.2 */ public $typeAlias = 'com_componentbuilder.validation_rule'; /** * Returns a Table object, always creating it * * @param type $type The table type to instantiate * @param string $prefix A prefix for the table class name. Optional. * @param array $config Configuration array for model. Optional. * * @return Table A database object * @since 3.0 * @throws \Exception */ public function getTable($type = 'validation_rule', $prefix = 'Administrator', $config = []) { // get instance of the table return parent::getTable($type, $prefix, $config); } /** * get VDM internal session key * * @return string the session key * */ public function getVDM() { if (!isset($this->vastDevMod)) { $_id = 0; // new item probably (since it was not set in the getItem method) if (empty($_id)) { $id = 0; } else { $id = $_id; } // set the id and view name to session if ($vdm = ComponentbuilderHelper::get('validation_rule__'.$id)) { $this->vastDevMod = $vdm; } else { // set the vast development method key $this->vastDevMod = UtilitiesStringHelper::random(50); ComponentbuilderHelper::set($this->vastDevMod, 'validation_rule__'.$id); ComponentbuilderHelper::set('validation_rule__'.$id, $this->vastDevMod); // set a return value if found $jinput = Factory::getApplication()->input; $return = $jinput->get('return', null, 'base64'); ComponentbuilderHelper::set($this->vastDevMod . '__return', $return); // set a GUID value if found if (isset($item) && ObjectHelper::check($item) && isset($item->guid) && GuidHelper::valid($item->guid)) { ComponentbuilderHelper::set($this->vastDevMod . '__guid', $item->guid); } } } return $this->vastDevMod; } /** * Method to get a single record. * * @param integer $pk The id of the primary key. * * @return mixed Object on success, false on failure. * @since 1.6 */ public function getItem($pk = null) { if ($item = parent::getItem($pk)) { if (!empty($item->params) && !is_array($item->params)) { // Convert the params field to an array. $registry = new Registry; $registry->loadString($item->params); $item->params = $registry->toArray(); } if (!empty($item->metadata)) { // Convert the metadata field to an array. $registry = new Registry; $registry->loadString($item->metadata); $item->metadata = $registry->toArray(); } if (!empty($item->php)) { // base64 Decode php. $item->php = base64_decode($item->php); } if (empty($item->id)) { $id = 0; } else { $id = $item->id; } // set the id and view name to session if ($vdm = ComponentbuilderHelper::get('validation_rule__'.$id)) { $this->vastDevMod = $vdm; } else { // set the vast development method key $this->vastDevMod = UtilitiesStringHelper::random(50); ComponentbuilderHelper::set($this->vastDevMod, 'validation_rule__'.$id); ComponentbuilderHelper::set('validation_rule__'.$id, $this->vastDevMod); // set a return value if found $jinput = Factory::getApplication()->input; $return = $jinput->get('return', null, 'base64'); ComponentbuilderHelper::set($this->vastDevMod . '__return', $return); // set a GUID value if found if (isset($item) && ObjectHelper::check($item) && isset($item->guid) && GuidHelper::valid($item->guid)) { ComponentbuilderHelper::set($this->vastDevMod . '__guid', $item->guid); } } } return $item; } /** * Method to get the record form. * * @param array $data Data for the form. * @param boolean $loadData True if the form is to load its own data (default case), false if not. * @param array $options Optional array of options for the form creation. * * @return Form|boolean A Form object on success, false on failure * @since 1.6 */ public function getForm($data = [], $loadData = true, $options = ['control' => 'jform']) { // set load data option $options['load_data'] = $loadData; // check if xpath was set in options $xpath = false; if (isset($options['xpath'])) { $xpath = $options['xpath']; unset($options['xpath']); } // check if clear form was set in options $clear = false; if (isset($options['clear'])) { $clear = $options['clear']; unset($options['clear']); } // Get the form. $form = $this->loadForm('com_componentbuilder.validation_rule', 'validation_rule', $options, $clear, $xpath); if (empty($form)) { return false; } $jinput = Factory::getApplication()->input; // The front end calls this model and uses a_id to avoid id clashes so we need to check for that first. if ($jinput->get('a_id')) { $id = $jinput->get('a_id', 0, 'INT'); } // The back end uses id so we use that the rest of the time and set it to 0 by default. else { $id = $jinput->get('id', 0, 'INT'); } $user = Factory::getApplication()->getIdentity(); // Check for existing item. // Modify the form based on Edit State access controls. if ($id != 0 && (!$user->authorise('validation_rule.edit.state', 'com_componentbuilder.validation_rule.' . (int) $id)) || ($id == 0 && !$user->authorise('validation_rule.edit.state', 'com_componentbuilder'))) { // Disable fields for display. $form->setFieldAttribute('ordering', 'disabled', 'true'); $form->setFieldAttribute('published', 'disabled', 'true'); // Disable fields while saving. $form->setFieldAttribute('ordering', 'filter', 'unset'); $form->setFieldAttribute('published', 'filter', 'unset'); } // If this is a new item insure the greated by is set. if (0 == $id) { // Set the created_by to this user $form->setValue('created_by', null, $user->id); } // Modify the form based on Edit Creaded By access controls. if (!$user->authorise('core.edit.created_by', 'com_componentbuilder')) { // Disable fields for display. $form->setFieldAttribute('created_by', 'disabled', 'true'); // Disable fields for display. $form->setFieldAttribute('created_by', 'readonly', 'true'); // Disable fields while saving. $form->setFieldAttribute('created_by', 'filter', 'unset'); } // Modify the form based on Edit Creaded Date access controls. if (!$user->authorise('core.edit.created', 'com_componentbuilder')) { // Disable fields for display. $form->setFieldAttribute('created', 'disabled', 'true'); // Disable fields while saving. $form->setFieldAttribute('created', 'filter', 'unset'); } // Only load these values if no id is found if (0 == $id) { // Set redirected view name $redirectedView = $jinput->get('ref', null, 'STRING'); // Set field name (or fall back to view name) $redirectedField = $jinput->get('field', $redirectedView, 'STRING'); // Set redirected view id $redirectedId = $jinput->get('refid', 0, 'INT'); // Set field id (or fall back to redirected view id) $redirectedValue = $jinput->get('field_id', $redirectedId, 'INT'); if (0 != $redirectedValue && $redirectedField) { // Now set the local-redirected field default value $form->setValue($redirectedField, null, $redirectedValue); } } return $form; } /** * 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; } /** * Method to test whether a record can be deleted. * * @param object $record A record object. * * @return boolean True if allowed to delete the record. Defaults to the permission set in the component. * @since 1.6 */ protected function canDelete($record) { if (empty($record->id) || ($record->published != -2)) { return false; } // The record has been set. Check the record permissions. return $this->getCurrentUser()->authorise('validation_rule.delete', 'com_componentbuilder.validation_rule.' . (int) $record->id); } /** * Method to test whether a record can have its state edited. * * @param object $record A record object. * * @return boolean True if allowed to change the state of the record. Defaults to the permission set in the component. * @since 1.6 */ protected function canEditState($record) { $user = $this->getCurrentUser(); $recordId = $record->id ?? 0; if ($recordId) { // The record has been set. Check the record permissions. $permission = $user->authorise('validation_rule.edit.state', 'com_componentbuilder.validation_rule.' . (int) $recordId); if (!$permission && !is_null($permission)) { return false; } } // In the absence of better information, revert to the component permissions. return $user->authorise('validation_rule.edit.state', 'com_componentbuilder'); } /** * Method override to check if you can edit an existing record. * * @param array $data An array of input data. * @param string $key The name of the key for the primary key. * * @return boolean * @since 2.5 */ protected function allowEdit($data = [], $key = 'id') { // Check specific edit permission then general edit permission. $user = Factory::getApplication()->getIdentity(); return $user->authorise('validation_rule.edit', 'com_componentbuilder.validation_rule.'. ((int) isset($data[$key]) ? $data[$key] : 0)) or $user->authorise('validation_rule.edit', 'com_componentbuilder'); } /** * Prepare and sanitise the table data prior to saving. * * @param Table $table A Table object. * * @return void * @since 1.6 */ protected function prepareTable($table) { $date = Factory::getDate(); $user = $this->getCurrentUser(); if (isset($table->name)) { $table->name = \htmlspecialchars_decode($table->name, ENT_QUOTES); } if (isset($table->alias) && empty($table->alias)) { $table->generateAlias(); } if (empty($table->id)) { $table->created = $date->toSql(); // set the user if ($table->created_by == 0 || empty($table->created_by)) { $table->created_by = $user->id; } // Set ordering to the last item if not set if (empty($table->ordering)) { $db = $this->getDatabase(); $query = $db->getQuery(true) ->select('MAX(ordering)') ->from($db->quoteName('#__componentbuilder_validation_rule')); $db->setQuery($query); $max = $db->loadResult(); $table->ordering = $max + 1; } } else { $table->modified = $date->toSql(); $table->modified_by = $user->id; } if (!empty($table->id)) { // Increment the items version number. $table->version++; } } /** * Method to get the data that should be injected in the form. * * @return mixed The data for the form. * @since 1.6 */ protected function loadFormData() { // Check the session for previously entered form data. $data = Factory::getApplication()->getUserState('com_componentbuilder.edit.validation_rule.data', []); if (empty($data)) { $data = $this->getItem(); } // run the perprocess of the data $this->preprocessData('com_componentbuilder.validation_rule', $data); return $data; } /** * Method to get the unique fields of this table. * * @return mixed An array of field names, boolean false if none is set. * * @since 3.0 */ protected function getUniqueFields() { return false; } /** * Method to delete one or more records. * * @param array &$pks An array of record primary keys. * * @return boolean True if successful, false if an error occurs * @since 12.2 */ public function delete(&$pks) { if (!parent::delete($pks)) { return false; } return true; } /** * Method to change the published state of one or more records. * * @param array &$pks A list of the primary keys to change. * @param integer $value The value of the published state. * * @return boolean True on success. * @since 12.2 */ public function publish(&$pks, $value = 1) { if (!parent::publish($pks, $value)) { return false; } return true; } /** * Method to perform batch operations on an item or a set of items. * * @param array $commands An array of commands to perform. * @param array $pks An array of item ids. * @param array $contexts An array of item contexts. * * @return boolean Returns true on success, false on failure. * @since 12.2 */ public function batch($commands, $pks, $contexts) { // Sanitize ids. $pks = array_unique($pks); ArrayHelper::toInteger($pks); // Remove any values of zero. if (array_search(0, $pks, true)) { unset($pks[array_search(0, $pks, true)]); } if (empty($pks)) { $this->setError(Text::_('JGLOBAL_NO_ITEM_SELECTED')); return false; } $done = false; // Set some needed variables. $this->user ??= $this->getCurrentUser(); $this->table = $this->getTable(); $this->tableClassName = get_class($this->table); $this->contentType = new UCMType; $this->type = $this->contentType->getTypeByTable($this->tableClassName); $this->canDo = ComponentbuilderHelper::getActions('validation_rule'); $this->batchSet = true; if (!$this->canDo->get('core.batch')) { $this->setError(Text::_('JLIB_APPLICATION_ERROR_INSUFFICIENT_BATCH_INFORMATION')); return false; } if ($this->type == false) { $type = new UCMType; $this->type = $type->getTypeByAlias($this->typeAlias); } $this->tagsObserver = $this->table->getObserverOfClass('JTableObserverTags'); if (!empty($commands['move_copy'])) { $cmd = ArrayHelper::getValue($commands, 'move_copy', 'c'); if ($cmd == 'c') { $result = $this->batchCopy($commands, $pks, $contexts); if (is_array($result)) { foreach ($result as $old => $new) { $contexts[$new] = $contexts[$old]; } $pks = array_values($result); } else { return false; } } elseif ($cmd == 'm' && !$this->batchMove($commands, $pks, $contexts)) { return false; } $done = true; } if (!$done) { $this->setError(Text::_('JLIB_APPLICATION_ERROR_INSUFFICIENT_BATCH_INFORMATION')); return false; } // Clear the cache $this->cleanCache(); return true; } /** * Batch copy items to a new category or current. * * @param integer $values The new values. * @param array $pks An array of row IDs. * @param array $contexts An array of item contexts. * * @return mixed An array of new IDs on success, boolean false on failure. * * @since 12.2 */ protected function batchCopy($values, $pks, $contexts) { if (empty($this->batchSet)) { // Set some needed variables. $this->user = Factory::getApplication()->getIdentity(); $this->table = $this->getTable(); $this->tableClassName = get_class($this->table); $this->canDo = ComponentbuilderHelper::getActions('validation_rule'); } if (!$this->canDo->get('validation_rule.create') && !$this->canDo->get('validation_rule.batch')) { return false; } // get list of unique fields $uniqueFields = $this->getUniqueFields(); // remove move_copy from array unset($values['move_copy']); // make sure published is set if (!isset($values['published'])) { $values['published'] = 0; } elseif (isset($values['published']) && !$this->canDo->get('validation_rule.edit.state')) { $values['published'] = 0; } $newIds = []; // Parent exists so let's proceed while (!empty($pks)) { // Pop the first ID off the stack $pk = array_shift($pks); $this->table->reset(); // only allow copy if user may edit this item. if (!$this->user->authorise('validation_rule.edit', $contexts[$pk])) { // Not fatal error $this->setError(Text::sprintf('JLIB_APPLICATION_ERROR_BATCH_MOVE_ROW_NOT_FOUND', $pk)); continue; } // Check that the row actually exists if (!$this->table->load($pk)) { if ($error = $this->table->getError()) { // Fatal error $this->setError($error); return false; } else { // Not fatal error $this->setError(Text::sprintf('JLIB_APPLICATION_ERROR_BATCH_MOVE_ROW_NOT_FOUND', $pk)); continue; } } // Only for strings if (UtilitiesStringHelper::check($this->table->name) && !is_numeric($this->table->name)) { $this->table->name = $this->generateUnique('name',$this->table->name); } // insert all set values if (UtilitiesArrayHelper::check($values)) { foreach ($values as $key => $value) { if (strlen($value) > 0 && isset($this->table->$key)) { $this->table->$key = $value; } } } // update all unique fields if (UtilitiesArrayHelper::check($uniqueFields)) { foreach ($uniqueFields as $uniqueField) { $this->table->$uniqueField = $this->generateUnique($uniqueField,$this->table->$uniqueField); } } // Reset the ID because we are making a copy $this->table->id = 0; // TODO: Deal with ordering? // $this->table->ordering = 1; // Check the row. if (!$this->table->check()) { $this->setError($this->table->getError()); return false; } if (!empty($this->type)) { $this->createTagsHelper($this->tagsObserver, $this->type, $pk, $this->typeAlias, $this->table); } // Store the row. if (!$this->table->store()) { $this->setError($this->table->getError()); return false; } // Get the new item ID $newId = $this->table->get('id'); // Add the new ID to the array $newIds[$pk] = $newId; } // Clean the cache $this->cleanCache(); return $newIds; } /** * Batch move items to a new category * * @param integer $value The new category ID. * @param array $pks An array of row IDs. * @param array $contexts An array of item contexts. * * @return boolean True if successful, false otherwise and internal error is set. * * @since 12.2 */ protected function batchMove($values, $pks, $contexts) { if (empty($this->batchSet)) { // Set some needed variables. $this->user = Factory::getApplication()->getIdentity(); $this->table = $this->getTable(); $this->tableClassName = get_class($this->table); $this->canDo = ComponentbuilderHelper::getActions('validation_rule'); } if (!$this->canDo->get('validation_rule.edit') && !$this->canDo->get('validation_rule.batch')) { $this->setError(Text::_('JLIB_APPLICATION_ERROR_BATCH_CANNOT_EDIT')); return false; } // make sure published only updates if user has the permission. if (isset($values['published']) && !$this->canDo->get('validation_rule.edit.state')) { unset($values['published']); } // remove move_copy from array unset($values['move_copy']); // Parent exists so we proceed foreach ($pks as $pk) { if (!$this->user->authorise('validation_rule.edit', $contexts[$pk])) { $this->setError(Text::_('JLIB_APPLICATION_ERROR_BATCH_CANNOT_EDIT')); return false; } // Check that the row actually exists if (!$this->table->load($pk)) { if ($error = $this->table->getError()) { // Fatal error $this->setError($error); return false; } else { // Not fatal error $this->setError(Text::sprintf('JLIB_APPLICATION_ERROR_BATCH_MOVE_ROW_NOT_FOUND', $pk)); continue; } } // insert all set values. if (UtilitiesArrayHelper::check($values)) { foreach ($values as $key => $value) { // Do special action for access. if ('access' === $key && strlen($value) > 0) { $this->table->$key = $value; } elseif (strlen($value) > 0 && isset($this->table->$key)) { $this->table->$key = $value; } } } // Check the row. if (!$this->table->check()) { $this->setError($this->table->getError()); return false; } if (!empty($this->type)) { $this->createTagsHelper($this->tagsObserver, $this->type, $pk, $this->typeAlias, $this->table); } // Store the row. if (!$this->table->store()) { $this->setError($this->table->getError()); return false; } } // Clean the cache $this->cleanCache(); return true; } /** * Method to save the form data. * * @param array $data The form data. * * @return boolean True on success. * @since 1.6 */ public function save($data) { $input = Factory::getApplication()->getInput(); $filter = InputFilter::getInstance(); // set the metadata to the Item Data if (isset($data['metadata']) && isset($data['metadata']['author'])) { $data['metadata']['author'] = $filter->clean($data['metadata']['author'], 'TRIM'); $metadata = new Registry; $metadata->loadArray($data['metadata']); $data['metadata'] = (string) $metadata; } // Set the php string to base64 string. if (isset($data['php'])) { $data['php'] = base64_encode($data['php']); } // Set the Params Items to data if (isset($data['params']) && is_array($data['params'])) { $params = new Registry; $params->loadArray($data['params']); $data['params'] = (string) $params; } // Alter the unique field for save as copy if ($input->get('task') === 'save2copy') { // Automatic handling of other unique fields $uniqueFields = $this->getUniqueFields(); if (UtilitiesArrayHelper::check($uniqueFields)) { foreach ($uniqueFields as $uniqueField) { $data[$uniqueField] = $this->generateUnique($uniqueField,$data[$uniqueField]); } } } if (parent::save($data)) { return true; } return false; } /** * Method to generate a unique value. * * @param string $field name. * @param string $value data. * * @return string New value. * @since 3.0 */ protected function generateUnique($field, $value) { // set field value unique $table = $this->getTable(); while ($table->load([$field => $value])) { $value = StringHelper::increment($value); } return $value; } /** * Method to change the title * * @param string $title The title. * * @return array Contains the modified title and alias. * */ protected function _generateNewTitle($title) { // Alter the title $table = $this->getTable(); while ($table->load(['title' => $title])) { $title = StringHelper::increment($title); } return $title; } }