- md5
- e689fd3ee8ee19eb1a867f967c772c00
- sha1
- 57e7f9f1c71cc7a5d3ea59cfd06be57afbf8a1ea
- sha256
- 0ddb115bfafaf7b5b18191af930b0e267394c47974d0f9adec39d35134a98eb4
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428
<?php
/**
* @package Joomla.Administrator
* @subpackage com_menus
*
* @copyright Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
// No direct access.
defined('_JEXEC') or die;
// Include dependencies.
jimport('joomla.application.component.modeladmin');
jimport('joomla.filesystem.file');
jimport('joomla.filesystem.folder');
jimport('joomla.tablenested');
require_once JPATH_COMPONENT.'/helpers/menus.php';
/**
* Menu Item Model for Menus.
*
* @package Joomla.Administrator
* @subpackage com_menus
* @since 1.6
*/
class MenusModelItem extends JModelAdmin
{
/**
* @var string The prefix to use with controller messages.
* @since 1.6
*/
protected $text_prefix = 'COM_MENUS_ITEM';
/**
* @var string The help screen key for the menu item.
* @since 1.6
*/
protected $helpKey = 'JHELP_MENUS_MENU_ITEM_MANAGER_EDIT';
/**
* @var string The help screen base URL for the menu item.
* @since 1.6
*/
protected $helpURL;
/**
* @var boolean True to use local lookup for the help screen.
* @since 1.6
*/
protected $helpLocal = false;
/**
* Method to test whether a record can be deleted.
*
* @param object 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)) {
if ($record->published != -2) {
return ;
}
$user = JFactory::getUser();
return $user->authorise('core.delete', 'com_menus.item.'.(int) $record->id);
}
}
/**
* Method to test whether a record can have its state edited.
*
* @param object 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 = JFactory::getUser();
if (!empty($record->id)) {
return $user->authorise('core.edit.state', 'com_menus.item.'.(int) $record->id);
}
// Default to component settings if menu item not known.
else {
return parent::canEditState($record);
}
}
/**
* 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 1.6
*/
public function batch($commands, $pks, $contexts)
{
// Sanitize user ids.
$pks = array_unique($pks);
JArrayHelper::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(JText::_('COM_MENUS_NO_ITEM_SELECTED'));
return false;
}
$done = false;
if (!empty($commands['menu_id']))
{
$cmd = JArrayHelper::getValue($commands, 'move_copy', 'c');
if ($cmd == 'c')
{
$result = $this->batchCopy($commands['menu_id'], $pks, $contexts);
if (is_array($result))
{
$pks = $result;
}
else
{
return false;
}
}
elseif ($cmd == 'm' && !$this->batchMove($commands['menu_id'], $pks, $contexts))
{
return false;
}
$done = true;
}
if (!empty($commands['assetgroup_id']))
{
if (!$this->batchAccess($commands['assetgroup_id'], $pks, $contexts))
{
return false;
}
$done = true;
}
if (!empty($commands['language_id']))
{
if (!$this->batchLanguage($commands['language_id'], $pks, $contexts))
{
return false;
}
$done = true;
}
if (!$done)
{
$this->setError(JText::_('JLIB_APPLICATION_ERROR_INSUFFICIENT_BATCH_INFORMATION'));
return false;
}
return true;
}
/**
* Batch copy menu items to a new menu or parent.
*
* @param integer $value The new menu or sub-item.
* @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 1.6
*/
protected function batchCopy($value, $pks, $contexts)
{
// $value comes as {menutype}.{parent_id}
$parts = explode('.', $value);
$menuType = $parts[0];
$parentId = (int) JArrayHelper::getValue($parts, 1, 0);
$table = $this->getTable();
$db = $this->getDbo();
$query = $db->getQuery(true);
$i = 0;
// Check that the parent exists
if ($parentId)
{
if (!$table->load($parentId))
{
if ($error = $table->getError())
{
// Fatal error
$this->setError($error);
return false;
}
else
{
// Non-fatal error
$this->setError(JText::_('JGLOBAL_BATCH_MOVE_PARENT_NOT_FOUND'));
$parentId = 0;
}
}
}
// If the parent is 0, set it to the ID of the root item in the tree
if (empty($parentId))
{
if (!$parentId = $table->getRootId())
{
$this->setError($db->getErrorMsg());
return false;
}
}
// Check that user has create permission for menus
$user = JFactory::getUser();
if (!$user->authorise('core.create', 'com_menus'))
{
$this->setError(JText::_('COM_MENUS_BATCH_MENU_ITEM_CANNOT_CREATE'));
return false;
}
// We need to log the parent ID
$parents = array();
// Calculate the emergency stop count as a precaution against a runaway loop bug
$query->select('COUNT(id)');
$query->from($db->quoteName('#__menu'));
$db->setQuery($query);
$count = $db->loadResult();
if ($error = $db->getErrorMsg())
{
$this->setError($error);
return false;
}
// Parent exists so we let's proceed
while (!empty($pks) && $count > 0)
{
// Pop the first id off the stack
$pk = array_shift($pks);
$table->reset();
// Check that the row actually exists
if (!$table->load($pk))
{
if ($error = $table->getError())
{
// Fatal error
$this->setError($error);
return false;
}
else
{
// Not fatal error
$this->setError(JText::sprintf('JGLOBAL_BATCH_MOVE_ROW_NOT_FOUND', $pk));
continue;
}
}
// Copy is a bit tricky, because we also need to copy the children
$query->clear();
$query->select('id');
$query->from($db->quoteName('#__menu'));
$query->where('lft > ' . (int) $table->lft);
$query->where('rgt < ' . (int) $table->rgt);
$db->setQuery($query);
$childIds = $db->loadColumn();
// Add child ID's to the array only if they aren't already there.
foreach ($childIds as $childId)
{
if (!in_array($childId, $pks))
{
array_push($pks, $childId);
}
}
// Make a copy of the old ID and Parent ID
$oldId = $table->id;
$oldParentId = $table->parent_id;
// Reset the id because we are making a copy.
$table->id = 0;
// If we a copying children, the Old ID will turn up in the parents list
// otherwise it's a new top level item
$table->parent_id = isset($parents[$oldParentId]) ? $parents[$oldParentId] : $parentId;
$table->menutype = $menuType;
// Set the new location in the tree for the node.
$table->setLocation($table->parent_id, 'last-child');
// TODO: Deal with ordering?
//$table->ordering = 1;
$table->level = null;
$table->lft = null;
$table->rgt = null;
$table->home = 0;
// Alter the title & alias
list($title, $alias) = $this->generateNewTitle($table->parent_id, $table->alias, $table->title);
$table->title = $title;
$table->alias = $alias;
// Check the row.
if (!$table->check())
{
$this->setError($table->getError());
return false;
}
// Store the row.
if (!$table->store())
{
$this->setError($table->getError());
return false;
}
// Get the new item ID
$newId = $table->get('id');
// Add the new ID to the array
$newIds[$i] = $newId;
$i++;
// Now we log the old 'parent' to the new 'parent'
$parents[$oldId] = $table->id;
$count--;
}
// Rebuild the hierarchy.
if (!$table->rebuild())
{
$this->setError($table->getError());
return false;
}
// Rebuild the tree path.
if (!$table->rebuildPath($table->id))
{
$this->setError($table->getError());
return false;
}
// Clean the cache
$this->cleanCache();
return $newIds;
}
/**
* Batch move menu items to a new menu or parent.
*
* @param integer $value The new menu or sub-item.
* @param array $pks An array of row IDs.
* @param array $contexts An array of item contexts.
*
* @return boolean True on success.
*
* @since 1.6
*/
protected function batchMove($value, $pks, $contexts)
{
// $value comes as {menutype}.{parent_id}
$parts = explode('.', $value);
$menuType = $parts[0];
$parentId = (int) JArrayHelper::getValue($parts, 1, 0);
$table = $this->getTable();
$db = $this->getDbo();
$query = $db->getQuery(true);
// Check that the parent exists.
if ($parentId)
{
if (!$table->load($parentId))
{
if ($error = $table->getError())
{
// Fatal error
$this->setError($error);
return false;
}
else
{
// Non-fatal error
$this->setError(JText::_('JGLOBAL_BATCH_MOVE_PARENT_NOT_FOUND'));
$parentId = 0;
}
}
}
// Check that user has create and edit permission for menus
$user = JFactory::getUser();
if (!$user->authorise('core.create', 'com_menus'))
{
$this->setError(JText::_('COM_MENUS_BATCH_MENU_ITEM_CANNOT_CREATE'));
return false;
}
if (!$user->authorise('core.edit', 'com_menus'))
{
$this->setError(JText::_('COM_MENUS_BATCH_MENU_ITEM_CANNOT_EDIT'));
return false;
}
// We are going to store all the children and just moved the menutype
$children = array();
// Parent exists so we let's proceed
foreach ($pks as $pk)
{
// Check that the row actually exists
if (!$table->load($pk))
{
if ($error = $table->getError())
{
// Fatal error
$this->setError($error);
return false;
}
else
{
// Not fatal error
$this->setError(JText::sprintf('JGLOBAL_BATCH_MOVE_ROW_NOT_FOUND', $pk));
continue;
}
}
// Set the new location in the tree for the node.
$table->setLocation($parentId, 'last-child');
// Set the new Parent Id
$table->parent_id = $parentId;
// Check if we are moving to a different menu
if ($menuType != $table->menutype)
{
// Add the child node ids to the children array.
$query->clear();
$query->select($db->quoteName('id'));
$query->from($db->quoteName('#__menu'));
$query->where($db->quoteName('lft') .' BETWEEN ' . (int) $table->lft . ' AND ' . (int) $table->rgt);
$db->setQuery($query);
$children = array_merge($children, (array) $db->loadColumn());
}
// Check the row.
if (!$table->check())
{
$this->setError($table->getError());
return false;
}
// Store the row.
if (!$table->store())
{
$this->setError($table->getError());
return false;
}
// Rebuild the tree path.
if (!$table->rebuildPath())
{
$this->setError($table->getError());
return false;
}
}
// Process the child rows
if (!empty($children))
{
// Remove any duplicates and sanitize ids.
$children = array_unique($children);
JArrayHelper::toInteger($children);
// Update the menutype field in all nodes where necessary.
$query->clear();
$query->update($db->quoteName('#__menu'));
$query->set($db->quoteName('menutype') . ' = ' . $db->quote($menuType));
$query->where($db->quoteName('id') . ' IN (' . implode(',', $children) . ')');
$db->setQuery($query);
$db->query();
// Check for a database error.
if ($db->getErrorNum())
{
$this->setError($db->getErrorMsg());
return false;
}
}
// Clean the cache
$this->cleanCache();
return true;
}
/**
* Method to check if you can save a record.
*
* @param array $data An array of input data.
* @param string $key The name of the key for the primary key.
*
* @return boolean
* @since 1.6
*/
protected function canSave($data = array(), $key = 'id')
{
return JFactory::getUser()->authorise('core.edit', $this->option);
}
/**
* Method to get the row 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.
* @return mixed A JForm object on success, false on failure
* @since 1.6
*/
public function getForm($data = array(), $loadData = true)
{
// The folder and element vars are passed when saving the form.
if (empty($data)) {
$item = $this->getItem();
$this->setState('item.link', $item->link);
// The type should already be set.
}
else {
$this->setState('item.link', JArrayHelper::getValue($data, 'link'));
$this->setState('item.type', JArrayHelper::getValue($data, 'type'));
}
// Get the form.
$form = $this->loadForm('com_menus.item', 'item', array('control' => 'jform', 'load_data' => $loadData), true);
if (empty($form)) {
return false;
}
// Modify the form based on access controls.
if (!$this->canEditState((object) $data)) {
// Disable fields for display.
$form->setFieldAttribute('menuordering', 'disabled', 'true');
$form->setFieldAttribute('published', 'disabled', 'true');
// Disable fields while saving.
// The controller has already verified this is an article you can edit.
$form->setFieldAttribute('menuordering', 'filter', 'unset');
$form->setFieldAttribute('published', 'filter', 'unset');
}
return $form;
}
/**
* 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.
return array_merge((array)$this->getItem(), (array)JFactory::getApplication()->getUserState('com_menus.edit.item.data', array()));
}
/**
* Get the necessary data to load an item help screen.
*
* @return object An object with key, url, and local properties for loading the item help screen.
* @since 1.6
*/
public function getHelp()
{
return (object) array('key' => $this->helpKey, 'url' => $this->helpURL, 'local' => $this->helpLocal);
}
/**
* Method to get a menu item.
*
* @param integer $pk An optional id of the object to get, otherwise the id from the model state is used.
*
* @return mixed Menu item data object on success, false on failure.
* @since 1.6
*/
public function getItem($pk = null)
{
// Initialise variables.
$pk = (!empty($pk)) ? $pk : (int)$this->getState('item.id');
// Get a level row instance.
$table = $this->getTable();
// Attempt to load the row.
$table->load($pk);
// Check for a table object error.
if ($error = $table->getError()) {
$this->setError($error);
$false = false;
return $false;
}
// Prime required properties.
if ($type = $this->getState('item.type')) {
$table->type = $type;
}
if (empty($table->id)) {
$table->parent_id = $this->getState('item.parent_id');
$table->menutype = $this->getState('item.menutype');
$table->params = '{}';
}
// If the link has been set in the state, possibly changing link type.
if ($link = $this->getState('item.link')) {
// Check if we are changing away from the actual link type.
if (MenusHelper::getLinkKey($table->link) != MenusHelper::getLinkKey($link)) {
$table->link = $link;
}
}
switch ($table->type)
{
case 'alias':
$table->component_id = 0;
$args = array();
parse_str(parse_url($table->link, PHP_URL_QUERY), $args);
break;
case 'separator':
$table->link = '';
$table->component_id = 0;
break;
case 'url':
$table->component_id = 0;
parse_str(parse_url($table->link, PHP_URL_QUERY));
break;
case 'component':
default:
// Enforce a valid type.
$table->type = 'component';
// Ensure the integrity of the component_id field is maintained, particularly when changing the menu item type.
$args = array();
parse_str(parse_url($table->link, PHP_URL_QUERY), $args);
if (isset($args['option'])) {
// Load the language file for the component.
$lang = JFactory::getLanguage();
$lang->load($args['option'], JPATH_ADMINISTRATOR, null, false, true)
|| $lang->load($args['option'], JPATH_ADMINISTRATOR . '/components/' . $args['option'], null, false, true);
// Determine the component id.
$component = JComponentHelper::getComponent($args['option']);
if (isset($component->id)) {
$table->component_id = $component->id;
}
}
break;
}
// We have a valid type, inject it into the state for forms to use.
$this->setState('item.type', $table->type);
// Convert to the JObject before adding the params.
$properties = $table->getProperties(1);
$result = JArrayHelper::toObject($properties, 'JObject');
// Convert the params field to an array.
$registry = new JRegistry;
$registry->loadString($table->params);
$result->params = $registry->toArray();
// Merge the request arguments in to the params for a component.
if ($table->type == 'component') {
// Note that all request arguments become reserved parameter names.
$result->request = $args;
$result->params = array_merge($result->params, $args);
}
if ($table->type == 'alias') {
// Note that all request arguments become reserved parameter names.
$args = array();
parse_str(parse_url($table->link, PHP_URL_QUERY), $args);
$result->params = array_merge($result->params, $args);
}
if ($table->type == 'url') {
// Note that all request arguments become reserved parameter names.
$args = array();
parse_str(parse_url($table->link, PHP_URL_QUERY), $args);
$result->params = array_merge($result->params, $args);
}
// Load associated menu items
if (JFactory::getApplication()->get('menu_associations', 0)) {
if ($pk != null) {
$result->associations = MenusHelper::getAssociations($pk);
}
else {
$result->associations = array();
}
}
$result->menuordering = $pk;
return $result;
}
/**
* Get the list of modules not in trash.
*
* @return mixed An array of module records (id, title, position), or false on error.
* @since 1.6
*/
public function getModules()
{
$db = $this->getDbo();
$query = $db->getQuery(true);
// Join on the module-to-menu mapping table.
// We are only interested if the module is displayed on ALL or THIS menu item (or the inverse ID number).
//sqlsrv changes for modulelink to menu manager
$query->select('a.id, a.title, a.position, a.published, map.menuid');
$query->from('#__modules AS a');
$query->join('LEFT', sprintf('#__modules_menu AS map ON map.moduleid = a.id AND map.menuid IN (0, %1$d, -%1$d)', $this->getState('item.id')));
$query->select('(SELECT COUNT(*) FROM #__modules_menu WHERE moduleid = a.id AND menuid < 0) AS ' . $db->qn('except'));
// Join on the asset groups table.
$query->select('ag.title AS access_title');
$query->join('LEFT', '#__viewlevels AS ag ON ag.id = a.access');
$query->where('a.published >= 0');
$query->where('a.client_id = 0');
$query->order('a.position, a.ordering');
$db->setQuery($query);
$result = $db->loadObjectList();
if ($db->getErrorNum()) {
$this->setError($db->getErrorMsg());
return false;
}
return $result;
}
/**
* A protected method to get the where clause for the reorder
* This ensures that the row will be moved relative to a row with the same menutype
*
* @param JTableMenu $table instance
*
* @return array An array of conditions to add to add to ordering queries.
* @since 1.6
*/
protected function getReorderConditions($table)
{
return 'menutype = ' . $this->_db->Quote($table->menutype);
}
/**
* 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 JTable A database object
* @since 1.6
*/
public function getTable($type = 'Menu', $prefix = 'MenusTable', $config = array())
{
return JTable::getInstance($type, $prefix, $config);
}
/**
* Auto-populate the model state.
*
* Note. Calling getState in this method will result in recursion.
*
* @return void
* @since 1.6
*/
protected function populateState()
{
$app = JFactory::getApplication('administrator');
// Load the User state.
$pk = (int) JRequest::getInt('id');
$this->setState('item.id', $pk);
if (!($parentId = $app->getUserState('com_menus.edit.item.parent_id'))) {
$parentId = JRequest::getInt('parent_id');
}
$this->setState('item.parent_id', $parentId);
$menuType = $app->getUserState('com_menus.edit.item.menutype');
if (JRequest::getCmd('menutype', false)) {
$menuType = JRequest::getCmd('menutype', 'mainmenu');
}
$this->setState('item.menutype', $menuType);
if (!($type = $app->getUserState('com_menus.edit.item.type'))){
$type = JRequest::getCmd('type');
// Note a new menu item will have no field type.
// The field is required so the user has to change it.
}
$this->setState('item.type', $type);
if ($link = $app->getUserState('com_menus.edit.item.link')) {
$this->setState('item.link', $link);
}
// Load the parameters.
$params = JComponentHelper::getParams('com_menus');
$this->setState('params', $params);
}
/**
* @param object $form A form object.
* @param mixed $data The data expected for the form.
*
* @return void
* @since 1.6
* @throws Exception if there is an error in the form event.
*/
protected function preprocessForm(JForm $form, $data, $group = 'content')
{
// Initialise variables.
$link = $this->getState('item.link');
$type = $this->getState('item.type');
$formFile = false;
// Initialise form with component view params if available.
if ($type == 'component') {
$link = htmlspecialchars_decode($link);
// Parse the link arguments.
$args = array();
parse_str(parse_url(htmlspecialchars_decode($link), PHP_URL_QUERY), $args);
// Confirm that the option is defined.
$option = '';
$base = '';
if (isset($args['option'])) {
// The option determines the base path to work with.
$option = $args['option'];
$base = JPATH_SITE.'/components/'.$option;
}
// Confirm a view is defined.
$formFile = false;
if (isset($args['view'])) {
$view = $args['view'];
// Determine the layout to search for.
if (isset($args['layout'])) {
$layout = $args['layout'];
}
else {
$layout = 'default';
}
$formFile = false;
// Check for the layout XML file. Use standard xml file if it exists.
$path = JPath::clean($base.'/views/'.$view.'/tmpl/'.$layout.'.xml');
if (JFile::exists($path)) {
$formFile = $path;
}
// if custom layout, get the xml file from the template folder
// template folder is first part of file name -- template:folder
if (!$formFile && (strpos($layout, ':') > 0 ))
{
$temp = explode(':', $layout);
$templatePath = JPATH::clean(JPATH_SITE.'/templates/'.$temp[0].'/html/'.$option.'/'.$view.'/'.$temp[1].'.xml');
if (JFile::exists($templatePath))
{
$formFile = $templatePath;
}
}
}
//Now check for a view manifest file
if (!$formFile)
{
if (isset($view) && JFile::exists($path = JPath::clean($base.'/views/'.$view.'/metadata.xml')))
{
$formFile = $path;
}
else
{
//Now check for a component manifest file
$path = JPath::clean($base.'/metadata.xml');
if (JFile::exists($path))
{
$formFile = $path;
}
}
}
}
if ($formFile)
{
// If an XML file was found in the component, load it first.
// We need to qualify the full path to avoid collisions with component file names.
if ($form->loadFile($formFile, true, '/metadata') == false) {
throw new Exception(JText::_('JERROR_LOADFILE_FAILED'));
}
// Attempt to load the xml file.
if (!$xml = simplexml_load_file($formFile)) {
throw new Exception(JText::_('JERROR_LOADFILE_FAILED'));
}
// Get the help data from the XML file if present.
$help = $xml->xpath('/metadata/layout/help');
}
else
{
// We don't have a component. Load the form XML to get the help path
$xmlFile = JPath::find(JPATH_ROOT . '/administrator/components/com_menus/models/forms', 'item_' . $type . '.xml');
// Attempt to load the xml file.
if ($xmlFile && !$xml = simplexml_load_file($xmlFile))
{
throw new Exception(JText::_('JERROR_LOADFILE_FAILED'));
}
// Get the help data from the XML file if present.
$help = $xml->xpath('/form/help');
}
if (!empty($help))
{
$helpKey = trim((string) $help[0]['key']);
$helpURL = trim((string) $help[0]['url']);
$helpLoc = trim((string) $help[0]['local']);
$this->helpKey = $helpKey ? $helpKey : $this->helpKey;
$this->helpURL = $helpURL ? $helpURL : $this->helpURL;
$this->helpLocal = (($helpLoc == 'true') || ($helpLoc == '1') || ($helpLoc == 'local')) ? true : false;
}
// Now load the component params.
// TODO: Work out why 'fixing' this breaks JForm
if ($isNew = false) {
$path = JPath::clean(JPATH_ADMINISTRATOR.'/components/'.$option.'/config.xml');
}
else {
$path='null';
}
if (JFile::exists($path)) {
// Add the component params last of all to the existing form.
if (!$form->load($path, true, '/config')) {
throw new Exception(JText::_('JERROR_LOADFILE_FAILED'));
}
}
// Load the specific type file
if (!$form->loadFile('item_'.$type, false, false)) {
throw new Exception(JText::_('JERROR_LOADFILE_FAILED'));
}
// Association menu items
if (JFactory::getApplication()->get('menu_associations', 0)) {
$languages = JLanguageHelper::getLanguages('lang_code');
$addform = new JXMLElement('<form />');
$fields = $addform->addChild('fields');
$fields->addAttribute('name', 'associations');
$fieldset = $fields->addChild('fieldset');
$fieldset->addAttribute('name', 'item_associations');
$fieldset->addAttribute('description', 'COM_MENUS_ITEM_ASSOCIATIONS_FIELDSET_DESC');
$add = false;
foreach ($languages as $tag => $language)
{
if ($tag != $data['language']) {
$add = true;
$field = $fieldset->addChild('field');
$field->addAttribute('name', $tag);
$field->addAttribute('type', 'menuitem');
$field->addAttribute('language', $tag);
$field->addAttribute('label', $language->title);
$field->addAttribute('translate_label', 'false');
$option = $field->addChild('option', 'COM_MENUS_ITEM_FIELD_ASSOCIATION_NO_VALUE');
$option->addAttribute('value', '');
}
}
if ($add) {
$form->load($addform, false);
}
}
// Trigger the default form events.
parent::preprocessForm($form, $data, $group);
}
/**
* Method rebuild the entire nested set tree.
*
* @return boolean False on failure or error, true otherwise.
* @since 1.6
*/
public function rebuild()
{
// Initialiase variables.
$db = $this->getDbo();
$table = $this->getTable();
if (!$table->rebuild()) {
$this->setError($table->getError());
return false;
}
// Convert the parameters not in JSON format.
$db->setQuery(
'SELECT id, params' .
' FROM #__menu' .
' WHERE params NOT LIKE '.$db->quote('{%') .
' AND params <> '.$db->quote('')
);
$items = $db->loadObjectList();
if ($error = $db->getErrorMsg()) {
$this->setError($error);
return false;
}
foreach ($items as &$item)
{
$registry = new JRegistry;
$registry->loadString($item->params);
$params = (string)$registry;
$db->setQuery(
'UPDATE #__menu' .
' SET params = '.$db->quote($params).
' WHERE id = '.(int) $item->id
);
if (!$db->query()) {
$this->setError($error);
return false;
}
unset($registry);
}
// 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)
{
// Initialise variables.
$pk = (!empty($data['id'])) ? $data['id'] : (int)$this->getState('item.id');
$isNew = true;
$db = $this->getDbo();
$table = $this->getTable();
// Load the row if saving an existing item.
if ($pk > 0) {
$table->load($pk);
$isNew = false;
}
if (!$isNew && $table->menutype == $data['menutype']) {
if ($table->parent_id == $data['parent_id'] ) {
// If first is chosen make the item the first child of the selected parent.
if ($data['menuordering'] == -1) {
$table->setLocation($data['parent_id'], 'first-child');
}
// If last is chosen make it the last child of the selected parent.
elseif ($data['menuordering'] == -2) {
$table->setLocation($data['parent_id'], 'last-child');
}
// Don't try to put an item after itself. All other ones put after the selected item.
// $data['id'] is empty means it's a save as copy
elseif ($data['menuordering'] && $table->id != $data['menuordering'] || empty($data['id']))
{
$table->setLocation($data['menuordering'], 'after');
}
// Just leave it where it is if no change is made.
elseif ( $data['menuordering'] && $table->id == $data['menuordering'])
{
unset( $data['menuordering']);
}
}
// Set the new parent id if parent id not matched and put in last position
else {
$table->setLocation($data['parent_id'], 'last-child');
}
}
// We have a new item, so it is not a change.
elseif ($isNew) {
$table->setLocation($data['parent_id'], 'last-child');
}
// The menu type has changed so we need to just put this at the bottom
// of the root level.
else {
$table->setLocation(1, 'last-child');
}
// Bind the data.
if (!$table->bind($data)) {
$this->setError($table->getError());
return false;
}
// Alter the title & alias for save as copy. Also, unset the home record.
if(!$isNew && $data['id'] == 0){
list($title, $alias) = $this->generateNewTitle($table->parent_id, $table->alias, $table->title);
$table->title = $title;
$table->alias = $alias;
$table->home = 0;
}
// Check the data.
if (!$table->check()) {
$this->setError($table->getError());
return false;
}
// Store the data.
if (!$table->store()) {
$this->setError($table->getError());
return false;
}
// Rebuild the tree path.
if (!$table->rebuildPath($table->id)) {
$this->setError($table->getError());
return false;
}
$this->setState('item.id', $table->id);
$this->setState('item.menutype', $table->menutype);
// Load associated menu items
if (JFactory::getApplication()->get('menu_associations', 0)) {
// Adding self to the association
$associations = $data['associations'];
foreach ($associations as $tag=>$id) {
if (empty($id)) {
unset($associations[$tag]);
}
}
// Detecting all item menus
$all_language = $table->language == '*';
if ($all_language && !empty($associations)) {
JError::raiseNotice(403, JText::_('COM_MENUS_ERROR_ALL_LANGUAGE_ASSOCIATED'));
}
$associations[$table->language]=$table->id;
// Deleting old association for these items
$db = JFactory::getDbo();
$query = $db->getQuery(true);
$query->delete('#__associations');
$query->where('context='.$db->quote('com_menus.item'));
$query->where('id IN ('.implode(',', $associations).')');
$db->setQuery($query);
$db->query();
if ($error = $db->getErrorMsg()) {
$this->setError($error);
return false;
}
if (!$all_language && count($associations)>1) {
// Adding new association for these items
$key = md5(json_encode($associations));
$query->clear();
$query->insert('#__associations');
foreach ($associations as $tag=>$id) {
$query->values($id.','.$db->quote('com_menus.item').','.$db->quote($key));
}
$db->setQuery($query);
$db->query();
if ($error = $db->getErrorMsg()) {
$this->setError($error);
return false;
}
}
}
// Clean the cache
$this->cleanCache();
if (isset($data['link'])) {
$base = JURI::base();
$juri = JURI::getInstance($base.$data['link']);
$option = $juri->getVar('option');
// Clean the cache
parent::cleanCache($option);
}
return true;
}
/**
* Method to save the reordered nested set tree.
* First we save the new order values in the lft values of the changed ids.
* Then we invoke the table rebuild to implement the new ordering.
*
* @param array $idArray id's of rows to be reordered
* @param array $lft_array lft values of rows to be reordered
*
* @return boolean false on failuer or error, true otherwise
* @since 1.6
*/
public function saveorder($idArray = null, $lft_array = null)
{
// Get an instance of the table object.
$table = $this->getTable();
if (!$table->saveorder($idArray, $lft_array)) {
$this->setError($table->getError());
return false;
}
// Clean the cache
$this->cleanCache();
return true;
}
/**
* Method to change the home state of one or more items.
*
* @param array $pks A list of the primary keys to change.
* @param int $value The value of the home state.
*
* @return boolean True on success.
* @since 1.6
*/
function setHome(&$pks, $value = 1)
{
// Initialise variables.
$table = $this->getTable();
$pks = (array) $pks;
$user = JFactory::getUser();
$languages = array();
$onehome = false;
// Remember that we can set a home page for different languages,
// so we need to loop through the primary key array.
foreach ($pks as $i => $pk)
{
if ($table->load($pk)) {
if (!array_key_exists($table->language, $languages)) {
$languages[$table->language] = true;
if ($table->home == $value) {
unset($pks[$i]);
JError::raiseNotice(403, JText::_('COM_MENUS_ERROR_ALREADY_HOME'));
}
else {
$table->home = $value;
if ($table->language == '*') {
$table->published = 1;
}
if (!$this->canSave($table)) {
// Prune items that you can't change.
unset($pks[$i]);
JError::raiseWarning(403, JText::_('JLIB_APPLICATION_ERROR_SAVE_NOT_PERMITTED'));
}
elseif (!$table->check()) {
// Prune the items that failed pre-save checks.
unset($pks[$i]);
JError::raiseWarning(403, $table->getError());
}
elseif (!$table->store()) {
// Prune the items that could not be stored.
unset($pks[$i]);
JError::raiseWarning(403, $table->getError());
}
}
}
else {
unset($pks[$i]);
if (!$onehome) {
$onehome = true;
JError::raiseNotice(403, JText::sprintf('COM_MENUS_ERROR_ONE_HOME'));
}
}
}
}
// Clean the cache
$this->cleanCache();
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 int $value The value of the published state.
*
* @return boolean True on success.
* @since 1.6
*/
function publish(&$pks, $value = 1)
{
// Initialise variables.
$table = $this->getTable();
$pks = (array) $pks;
// Default menu item existence checks.
if ($value != 1) {
foreach ($pks as $i => $pk)
{
if ($table->load($pk) && $table->home && $table->language == '*') {
// Prune items that you can't change.
JError::raiseWarning(403, JText::_('JLIB_DATABASE_ERROR_MENU_UNPUBLISH_DEFAULT_HOME'));
unset($pks[$i]);
break;
}
}
}
// Clean the cache
$this->cleanCache();
return parent::publish($pks, $value);
}
/**
* Method to change the title & alias.
*
* @param integer $parent_id The id of the parent.
* @param string $alias The alias.
* @param string $title The title.
*
* @return array Contains the modified title and alias.
*
* @since 1.6
*/
protected function generateNewTitle($parent_id, $alias, $title)
{
// Alter the title & alias
$table = $this->getTable();
while ($table->load(array('alias' => $alias, 'parent_id' => $parent_id)))
{
if ($title == $table->title)
{
$title = JString::increment($title);
}
$alias = JString::increment($alias, 'dash');
}
return array($title, $alias);
}
/**
* Custom clean cache method
*
* @since 1.6
*/
protected function cleanCache($group = null, $client_id = 0)
{
parent::cleanCache('com_modules');
parent::cleanCache('mod_menu');
}
}
The same content is in 10 releases, Joomla 2.5.19 to 2.5.28. See them all, or every version of this file.