View of /mambo/branches/4.6/administrator/components/com_modules/admin.modules.php
Parent Directory
|
Revision Log
Revision 1754 -
(download)
(annotate)
Tue Feb 17 11:25:53 2009 UTC (4 years, 3 months ago) by andphe
File size: 19547 byte(s)
Tue Feb 17 11:25:53 2009 UTC (4 years, 3 months ago) by andphe
File size: 19547 byte(s)
! Backend Raw Sql annotations for improve the database abstraction layer, thanks to Florian Thiel
<?php
/**
* @package Mambo
* @subpackage Modules
* @author Mambo Foundation Inc see README.php
* @copyright Mambo Foundation Inc.
* See COPYRIGHT.php for copyright notices and details.
* @license GNU/GPL Version 2, see LICENSE.php
* Mambo is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; version 2 of the License.
*/
/** ensure this file is being included by a parent file */
defined( '_VALID_MOS' ) or die( 'Direct Access to this location is not allowed.' );
// ensure user has access to this function
if (!($acl->acl_check( 'administration', 'edit', 'users', $my->usertype, 'modules', 'all' ) | $acl->acl_check( 'administration', 'install', 'users', $my->usertype, 'modules', 'all' ))) {
mosRedirect( 'index2.php', T_('You are not authorized to view this resource.') );
}
require_once( $mainframe->getPath( 'admin_html' ) );
$client = mosGetParam( $_REQUEST, 'client', '' );
$cid = mosGetParam( $_POST, 'cid', array(0) );
$moduleid = mosGetParam( $_REQUEST, 'moduleid', null );
if ($cid[0] == 0 && isset($moduleid) ) {
$cid[0] = $moduleid;
}
switch ( $task ) {
case 'copy':
copyModule( $option, intval( $cid[0] ), $client );
break;
case 'new':
editModule( $option, 0, $client );
break;
case 'edit':
editModule( $option, $cid[0], $client );
break;
case 'editA':
editModule( $option, $id, $client );
break;
case 'save':
case 'apply':
mosCache::cleanCache( 'com_content' );
saveModule( $option, $client, $task );
break;
case 'remove':
removeModule( $cid, $option, $client );
break;
case 'cancel':
cancelModule( $option, $client );
break;
case 'publish':
case 'unpublish':
mosCache::cleanCache( 'com_content' );
publishModule( $cid, ($task == 'publish' ? 1 : 0), $option, $client );
break;
case 'orderup':
case 'orderdown':
orderModule( $cid[0], ($task == 'orderup' ? -1 : 1), $option, $client );
break;
case 'accesspublic':
case 'accessregistered':
case 'accessspecial':
accessMenu( $cid[0], $task, $option, $client );
break;
case 'saveorder':
saveOrder( $cid, $client );
break;
default:
viewModules( $option, $client );
break;
}
/**
* Compiles a list of installed or defined modules
*/
function viewModules( $option, $client ) {
global $database, $my, $mainframe, $mosConfig_list_limit, $mosConfig_absolute_path;
$filter_position = $mainframe->getUserStateFromRequest( "filter_position{$option}{$client}", 'filter_position', 0 );
$filter_type = $mainframe->getUserStateFromRequest( "filter_type{$option}{$client}", 'filter_type', 0 );
$limit = $mainframe->getUserStateFromRequest( "viewlistlimit", 'limit', $mosConfig_list_limit );
$limitstart = $mainframe->getUserStateFromRequest( "view{$option}limitstart", 'limitstart', 0 );
$search = $mainframe->getUserStateFromRequest( "search{$option}{$client}", 'search', '' );
$search = $database->getEscaped( trim( strtolower( $search ) ) );
if ($client == 'admin') {
$where[] = "m.client_id = '1'";
$client_id = 1;
} else {
$where[] = "m.client_id = '0'";
$client_id = 0;
}
// used by filter
if ( $filter_position ) {
$where[] = "m.position = '$filter_position'";
}
if ( $filter_type ) {
$where[] = "m.module = '$filter_type'";
}
if ( $search ) {
$where[] = "LOWER( m.title ) LIKE '%$search%'";
}
// get the total number of records
$query = "SELECT COUNT(*) FROM #__modules AS m ". ( count( $where ) ? "\n WHERE " . implode( ' AND ', $where ) : '' );
$database->setQuery( $query );
$total = $database->loadResult();
require_once( $mosConfig_absolute_path . '/administrator/includes/pageNavigation.php' );
$pageNav = new mosPageNav( $total, $limitstart, $limit );
$database->setQuery( "SELECT m.*, u.name AS editor, g.name AS groupname, MIN(mm.menuid) AS pages"
. "\n FROM #__modules AS m"
. "\n LEFT JOIN #__users AS u ON u.id = m.checked_out"
. "\n LEFT JOIN #__groups AS g ON g.id = m.access"
. "\n LEFT JOIN #__modules_menu AS mm ON mm.moduleid=m.id"
. ( count( $where ) ? "\n WHERE " . implode( ' AND ', $where ) : '' )
. "\n GROUP BY m.id"
. "\n ORDER BY position ASC, ordering ASC"
. "\n LIMIT $pageNav->limitstart,$pageNav->limit"
);
$rows = $database->loadObjectList();
if ($rows) {
foreach($rows as $row) {
$row->title = htmlspecialchars( str_replace( '&', '&', $row->title ) );
}
}
if ($database->getErrorNum()) {
echo $database->stderr();
return false;
}
// get list of Positions for dropdown filter
$query = "SELECT t.position AS value, t.position AS text"
. "\n FROM #__template_positions as t"
. "\n LEFT JOIN #__modules AS m ON m.position = t.position"
. "\n WHERE m.client_id = '$client_id'"
. "\n GROUP BY t.position"
. "\n ORDER BY t.position"
;
$positions[] = mosHTML::makeOption( '0', T_('- All Positions -') );
$database->setQuery( $query );
$positions = array_merge( $positions, $database->loadObjectList() );
$lists['position'] = mosHTML::selectList( $positions, 'filter_position', 'class="inputbox" size="1" onchange="document.adminForm.submit( );"', 'value', 'text', "$filter_position" );
// get list of Positions for dropdown filter
// @RawSQLUse, trivial_implementation, SELECT
$query = "SELECT module AS value, module AS text"
. "\n FROM #__modules"
. "\n WHERE client_id = '$client_id'"
. "\n GROUP BY module"
. "\n ORDER BY module"
;
$types[] = mosHTML::makeOption( '0', T_('- All Types -') );
$database->setQuery( $query );
$types = array_merge( $types, $database->loadObjectList() );
$lists['type'] = mosHTML::selectList( $types, 'filter_type', 'class="inputbox" size="1" onchange="document.adminForm.submit( );"', 'value', 'text', "$filter_type" );
HTML_modules::showModules( $rows, $my->id, $client, $pageNav, $option, $lists, $search );
}
/**
* Compiles information to add or edit a module
* @param string The current GET/POST option
* @param integer The unique id of the record to edit
*/
function copyModule( $option, $uid, $client ) {
global $database, $my;
$row = new mosModule( $database );
// load the row from the db table
$row->load( $uid );
$row->title = 'Copy of '.$row->title;
$row->id = 0;
$row->iscore = 0;
$row->published = 0;
if (!$row->check()) {
echo "<script> alert('".$row->getError()."'); window.history.go(-1); </script>\n";
exit();
}
if (!$row->store()) {
echo "<script> alert('".$row->getError()."'); window.history.go(-1); </script>\n";
exit();
}
$row->checkin();
if ($client == 'admin') {
$where = "client_id='1'";
} else {
$where = "client_id='0'";
}
$row->updateOrder( "position='$row->position' AND ($where)" );
// @RawSQLUse, trivial_implementation, SELECT
$database->setQuery( "SELECT menuid FROM #__modules_menu WHERE moduleid='$uid'" );
$rows = $database->loadResultArray();
foreach($rows as $menuid) {
// @RawSQLUse, trivial_implementation, INSERT
$database->setQuery( "INSERT INTO #__modules_menu"
. "\nSET moduleid='$row->id', menuid='$menuid'"
);
$database->query();
}
$msg = sprintf(T_('Module Copied [%s]'), $row->title);
mosRedirect( 'index2.php?option='. $option .'&client='. $client, $msg );
}
/**
* Saves the module after an edit form submit
*/
function saveModule( $option, $client, $task ) {
global $database;
$params = mosGetParam( $_POST, 'params', '' , _MOS_ALLOWHTML);
if (is_array( $params )) {
$txt = array();
foreach ($params as $k=>$v) {
$txt[] = "$k=$v";
}
$_POST['params'] = mosParameters::textareaHandling( $txt );
}
$row = new mosModule( $database );
if (!$row->bind( $_POST, 'selections' )) {
echo "<script> alert('".$row->getError()."'); window.history.go(-1); </script>\n";
exit();
}
// special access groups
if (is_array($row->groups)) {
$row->groups = implode(',',$row->groups);
} else {
$row->groups = '';
}
if (!$row->check()) {
echo "<script> alert('".$row->getError()."'); window.history.go(-1); </script>\n";
exit();
}
if (!$row->store()) {
echo "<script> alert('".$row->getError()."'); window.history.go(-1); </script>\n";
exit();
}
$row->checkin();
if ($client == 'admin') {
$where = "client_id='1'";
} else {
$where = "client_id='0'";
}
$row->updateOrder( "position='$row->position' AND ($where)" );
$menus = mosGetParam( $_POST, 'selections', array() );
// @RawSQLUse, trivial_implementation, DELETE
$database->setQuery( "DELETE FROM #__modules_menu WHERE moduleid='$row->id'" );
$database->query();
foreach ($menus as $menuid){
// this check for the blank spaces in the select box that have been added for cosmetic reasons
if ( $menuid <> "-999" && $menuid <> "-998") {
// @RawSQLUse, trivial_implementation, INSERT
$query = "INSERT INTO #__modules_menu SET moduleid='$row->id', menuid='$menuid'";
$database->setQuery( $query );
$database->query();
}
}
switch ( $task ) {
case 'apply':
$msg = sprintf(T_('Successfully Saved changes to Module: %s'), $row->title) ;
mosRedirect( 'index2.php?option='. $option .'&client='. $client .'&task=editA&hidemainmenu=1&id='. $row->id, $msg );
break;
case 'save':
default:
$msg = sprintf(T_('Successfully Saved Module: %s'), $row->title);
mosRedirect( 'index2.php?option='. $option .'&client='. $client, $msg );
break;
}
}
/**
* Compiles information to add or edit a module
* @param string The current GET/POST option
* @param integer The unique id of the record to edit
*/
function editModule( $option, $uid, $client ) {
global $database, $my, $mainframe;
global $mosConfig_absolute_path;
$lists = array();
$row = new mosModule( $database );
// load the row from the db table
$row->load( $uid );
// fail if checked out not by 'me'
if ( $row->checked_out && $row->checked_out <> $my->id ) {
echo "<script>alert('".sprintf(T_('The module %s is currently being edited by another administrator'), $row->title)."'); document.location.href='index2.php?option=$option'</script>\n";
exit(0);
}
$row->title = htmlspecialchars( str_replace( '&', '&', $row->title ) );
$row->content = htmlspecialchars( str_replace( '&', '&', $row->content ) );
if ( $uid ) {
$row->checkout( $my->id );
}
// if a new record we must still prime the mosModule object with a default
// position and the order; also add an extra item to the order list to
// place the 'new' record in last position if desired
if ($uid == 0) {
$row->position = 'left';
$row->showtitle = true;
//$row->ordering = $l;
$row->published = 1;
}
if ( $client == 'admin' ) {
$where = "client_id='1'";
$lists['client_id'] = 1;
$path = 'mod1_xml';
} else {
$where = "client_id='0'";
$lists['client_id'] = 0;
$path = 'mod0_xml';
}
// @RawSQLUse, trivial_implementation, SELECT
$query = "SELECT position, ordering, showtitle, title"
. "\n FROM #__modules"
. "\n WHERE ". $where
. "\n ORDER BY ordering"
;
$database->setQuery( $query );
if ( !($orders = $database->loadObjectList()) ) {
echo $database->stderr();
return false;
}
// @RawSQLUse, trivial_implementation, SELECT
$query = "SELECT position, description"
. "\n FROM #__template_positions"
. "\n WHERE position <> ''"
;
$database->setQuery( $query );
// hard code options for now
$positions = $database->loadObjectList();
$orders2 = array();
$pos = array();
foreach ($positions as $position) {
$orders2[$position->position] = array();
$pos[] = mosHTML::makeOption( $position->position, $position->description );
}
$l = 0;
$r = 0;
for ($i=0, $n=count( $orders ); $i < $n; $i++) {
$ord = 0;
if (array_key_exists( $orders[$i]->position, $orders2 )) {
$ord =count( array_keys( $orders2[$orders[$i]->position] ) ) + 1;
}
$orders2[$orders[$i]->position][] = mosHTML::makeOption( $ord, $ord.'::'.addslashes( $orders[$i]->title ) );
}
// build the html select list
$pos_select = 'onchange="changeDynaList(\'ordering\',orders,document.adminForm.position.options[document.adminForm.position.selectedIndex].value, originalPos, originalOrder)"';
$active = ( $row->position ? $row->position : 'left' );
$lists['position'] = mosHTML::selectList( $pos, 'position', 'class="inputbox" size="1" '. $pos_select, 'value', 'text', $active );
// get selected pages for $lists['selections']
if ( $uid ) {
// @RawSQLUse, trivial_implementation, SELECT, CONCEPT
$query = 'SELECT menuid AS value FROM #__modules_menu WHERE moduleid='. $row->id;
$database->setQuery( $query );
$lookup = $database->loadObjectList();
} else {
$lookup = array( mosHTML::makeOption( 0, 'All' ) );
}
if ( $row->access == 99 || $row->client_id == 1 || $lists['client_id'] ) {
$lists['access'] = T_('Administrator').'<input type="hidden" name="access" value="99" />';
$lists['showtitle'] = T_('N/A').' <input type="hidden" name="showtitle" value="1" />';
$lists['selections'] = T_('N/A');
} else {
if ( $client == 'admin' ) {
$lists['access'] = T_('N/A');
$lists['selections'] = T_('N/A');
} else {
$lists['access'] = mosAdminMenus::Access( $row );
$lists['groups'] = mosAdminMenus::groupAccess( $row );
$lists['selections'] = mosAdminMenus::MenuLinks( $lookup, 1, 1 );
}
$lists['showtitle'] = mosHTML::yesnoRadioList( 'showtitle', 'class="inputbox"', $row->showtitle );
}
// build the html select list for published
$lists['published'] = mosAdminMenus::Published( $row );
// xml file for module
$xmlfile = $mainframe->getPath( $path, $row->module );
if ($xmlfile) {
$xmlparser =& new mosXMLDescription ($xmlfile);
$row->description = $xmlparser->getDescription('module');
} else {
$row->description = '';
}
// get params definitions
$params =& new mosAdminParameters( $row->params, $xmlfile, 'module' );
HTML_modules::editModule( $row, $orders2, $lists, $params, $option );
}
/**
* Deletes one or more modules
*
* Also deletes associated entries in the #__module_menu table.
* @param array An array of unique category id numbers
*/
function removeModule( &$cid, $option, $client ) {
global $database, $my;
if (count( $cid ) < 1) {
echo "<script> alert('".T_('Select a module to delete')."'); window.history.go(-1);</script>\n";
exit;
}
$cids = implode( ',', $cid );
// @RawSQLUse, trivial_implementation, SELECT, CONCEPT
$database->setQuery( "SELECT id, module, title, iscore, params FROM #__modules WHERE id IN ($cids)" );
if (!($rows = $database->loadObjectList())) {
echo "<script> alert('".$database->getErrorMsg()."'); window.history.go(-1); </script>\n";
exit;
}
$err = array();
$cid = array();
foreach ($rows as $row) {
if ($row->module == '' || $row->iscore == 0) {
$cid[] = $row->id;
} else {
$err[] = $row->title;
}
// mod_mainmenu modules only deletable via Menu Manager
if ( $row->module == 'mod_mainmenu' ) {
if ( strstr( $row->params, 'mainmenu' ) ) {
echo "<script> alert('".T_('You cannot delete mod_mainmenu module that displays the "mainmenu" as it is a core Menu')."'); window.history.go(-1); </script>\n";
exit;
}
}
}
if (count( $cid )) {
$cids = implode( ',', $cid );
// @RawSQLUse, trivial_implementation, DELETE, CONCEPT
$database->setQuery( "DELETE FROM #__modules WHERE id IN ($cids)" );
if (!$database->query()) {
echo "<script> alert('".$database->getErrorMsg()."'); window.history.go(-1); </script>\n";
exit;
}
// @RawSQLUse, trivial_implementation, DELETE, CONCEPT
$database->setQuery( "DELETE from #__modules_menu WHERE moduleid IN ($cids)" );
if (!$database->query()) {
echo "<script> alert('".$database->getErrorMsg()."');</script>\n";
exit;
}
$mod = new mosModule( $database );
$mod->ordering = 0;
$mod->updateOrder( "position='left'" );
$mod->updateOrder( "position='right'" );
}
if (count( $err )) {
$cids = addslashes( implode( "', '", $err ) );
echo "<script>alert('".sprintf(T_('Module(s): "%s" cannot be deleted they can only be un-installed as they are Mambo modules.'), $cids)."');</script>\n";
}
mosRedirect( 'index2.php?option='. $option .'&client='. $client );
}
/**
* Publishes or Unpublishes one or more modules
* @param array An array of unique record id numbers
* @param integer 0 if unpublishing, 1 if publishing
*/
function publishModule( $cid=null, $publish=1, $option, $client ) {
global $database, $my;
if (count( $cid ) < 1) {
$action = $publish ? T_('publish' ): T_('unpublish');
echo "<script> alert('".sprintf(T_('Select a module to %s'), $action)."'); window.history.go(-1);</script>\n";
exit;
}
$cids = implode( ',', $cid );
$query = "UPDATE #__modules SET published='$publish'"
. "\n WHERE id IN ($cids)"
. "\n AND (checked_out=0 OR (checked_out='$my->id'))"
;
$database->setQuery( $query );
if (!$database->query()) {
echo "<script> alert('".$database->getErrorMsg()."'); window.history.go(-1); </script>\n";
exit();
}
if (count( $cid ) == 1) {
$row = new mosModule( $database );
$row->checkin( $cid[0] );
}
mosRedirect( 'index2.php?option='. $option .'&client='. $client );
}
/**
* Cancels an edit operation
*/
function cancelModule( $option, $client ) {
global $database;
$row = new mosModule( $database );
// ignore array elements
$row->bind( $_POST, 'selections params' );
// sanitize
$row->id = intval($row->id);
$row->checkin();
mosRedirect( 'index2.php?option='. $option .'&client='. $client );
}
/**
* Moves the order of a record
* @param integer The unique id of record
* @param integer The increment to reorder by
*/
function orderModule( $uid, $inc, $option ) {
global $database;
$client = mosGetParam( $_POST, 'client', '' );
$row = new mosModule( $database );
$row->load( $uid );
if ($client == 'admin') {
$where = "client_id='1'";
} else {
$where = "client_id='0'";
}
$row->move( $inc, "position='$row->position' AND ($where)" );
if ( $client ) {
$client = '&client=admin' ;
} else {
$client = '';
}
mosRedirect( 'index2.php?option='. $option .'&client='. $client );
}
/**
* changes the access level of a record
* @param integer The increment to reorder by
*/
function accessMenu( $uid, $access, $option, $client ) {
global $database;
switch ( $access ) {
case 'accesspublic':
$access = 0;
break;
case 'accessregistered':
$access = 1;
break;
case 'accessspecial':
$access = 2;
break;
}
$row = new mosModule( $database );
$row->load( $uid );
$row->access = $access;
if ( !$row->check() ) {
return $row->getError();
}
if ( !$row->store() ) {
return $row->getError();
}
mosRedirect( 'index2.php?option='. $option .'&client='. $client );
}
function saveOrder( &$cid, $client ) {
global $database;
$order = mosGetParam( $_POST, 'order', array(0) );
$row = new mosModule( $database );
$positions = array();
// update ordering values
foreach ($cid as $i=>$ciditem) {
$row->load( $ciditem );
if ($row->ordering != $order[$i]) {
$row->ordering = $order[$i];
if (!$row->store()) {
echo "<script> alert('".$database->getErrorMsg()."'); window.history.go(-1); </script>\n";
exit();
}
// remember to updateOrder this group
$positions[$row->position][$row->client_id] = $row->id;
}
}
// execute updateOrder for each group
foreach ($positions as $position=>$clients) {
foreach ($clients as $client=>$rowid) {
$row->updateOrder("position = '$position' AND client_id = '$client'");
}
} // foreach
$msg = T_('New ordering saved');
mosRedirect( 'index2.php?option=com_modules&client='. $client, $msg );
} // saveOrder
?>
| ViewVC Help | |
| Powered by ViewVC 1.0.0 |

