File Source for pnadmin.php

<?php
/**
* Zikula Application Framework
*
* @copyright (c) 2002, Zikula Development Team
* @link http://www.zikula.org
* @version $Id: pnadmin.php 24342 2008-06-06 12:03:14Z markwest $
* @license GNU/GPL - http://www.gnu.org/copyleft/gpl.html
* @package Zikula_System_Modules
* @subpackage Admin
*/
/**
* the main administration function
* This function is the default function, and is called whenever the
* module is initiated without defining arguments. As such it can
* be used for a number of things, but most commonly it either just
* shows the module menu and returns or calls whatever the module
* designer feels should be the default function (often this is the
* view() function)
* @author Mark West
* @return string HTML string
*/
function Admin_admin_main()
{
return Admin_admin_view();
}
/**
* Add a new admin category
* This is a standard function that is called whenever an administrator
* wishes to create a new module item
* @author Mark West
* @return string HTML string
*/
function Admin_admin_new()
{
if (!SecurityUtil::checkPermission('Admin::Item', '::', ACCESS_ADD)) {
return LogUtil::registerError(_MODULENOAUTH, 403);
}
$pnRender = pnRender::getInstance('Admin', false);
// Return the output that has been generated by this function
return $pnRender->fetch('admin_admin_new.htm');
}
/**
* This is a standard function that is called with the results of the
* form supplied by admin_admin_new() to create a new category
* @author Mark West
* @see Admin_admin_new()
* @param string $args['catname'] the name of the category to be created
* @param string $args['description'] the description of the category to be created
* @return mixed category id if create successful, false otherwise
*/
function Admin_admin_create($args)
{
$category = FormUtil::getPassedValue('category', isset($args['category']) ? $args['category'] : null, 'POST');
if (!SecurityUtil::confirmAuthKey()) {
return LogUtil::registerAuthidError (pnModURL('Admin', 'admin', 'view'));
}
$cid = pnModAPIFunc('Admin', 'admin', 'create',
array('catname' => $category['catname'],
'description' => $category['description']));
if ($cid != false) {
// Success
LogUtil::registerStatus (pnML('_CREATEITEMSUCCEDED', array('i' => _CATEGORY)));
}
return pnRedirect(pnModURL('Admin', 'admin', 'view'));
}
/**
* Modify a category
* This is a standard function that is called whenever an administrator
* wishes to modify an admin category
* @author Mark West
* @param int $args['cid'] category id
* @param int $args['objectid'] generic object id maps to cid if present
* @return string HTML string
*/
function Admin_admin_modify($args)
{
$cid = FormUtil::getPassedValue('cid', isset($args['cid']) ? $args['cid'] : null, 'GET');
$objectid = FormUtil::getPassedValue('objectid', isset($args['objectid']) ? $args['objectid'] : null, 'GET');
if (!empty($objectid)) {
$cid = $objectid;
}
$pnRender = pnRender::getInstance('Admin', false);
$item = pnModAPIFunc('Admin', 'admin', 'get', array('cid' => $cid));
if ($item == false) {
return LogUtil::registerError(pnML('_NOSUCHITEMFOUND', array('i' => _CATEGORY)), 404);
}
if (!SecurityUtil::checkPermission('Admin::Category', "$item[catname]::$cid", ACCESS_EDIT)) {
return LogUtil::registerError(_MODULENOAUTH, 403);
}
$pnRender->assign($item);
return $pnRender->fetch('admin_admin_modify.htm');
}
/**
* This is a standard function that is called with the results of the
* form supplied by template_admin_modify() to update a current item
* @author Mark West
* @see Admin_admin_modify()
* @param int $args['cid'] the id of the item to be updated
* @param int $args['objectid'] generic object id maps to cid if present
* @param string $args['catname'] the name of the category to be updated
* @param string $args['description'] the description of the item to be updated
* @return bool true if update successful, false otherwise
*/
function Admin_admin_update($args)
{
$category = FormUtil::getPassedValue('category', isset($args['category']) ? $args['category'] : null, 'POST');
if (!empty($category['objectid'])) {
$category['cid'] = $category['objectid'];
}
if (!SecurityUtil::confirmAuthKey()) {
return LogUtil::registerAuthidError (pnModURL('Admin', 'admin', 'view'));
}
if (pnModAPIFunc('Admin', 'admin', 'update',
array('cid' => $category['cid'],
'catname' => $category['catname'],
'description' => $category['description']))) {
// Success
LogUtil::registerStatus (pnML('_UPDATEITEMSUCCEDED', array('i' => _CATEGORY)));
}
return pnRedirect(pnModURL('Admin', 'admin', 'view'));
}
/**
* delete item
* This is a standard function that is called whenever an administrator
* wishes to delete a current module item. Note that this function is
* the equivalent of both of the modify() and update() functions above as
* it both creates a form and processes its output. This is fine for
* simpler functions, but for more complex operations such as creation and
* modification it is generally easier to separate them into separate
* functions. There is no requirement in the Zikula MDG to do one or the
* other, so either or both can be used as seen appropriate by the module
* developer
* @author Mark West
* @param int $args['cid'] the id of the category to be deleted
* @param int $args['objectid'] generic object id maps to cid if present
* @param bool $args['confirmation'] confirmation that this item can be deleted
* @return mixed HTML string if confirmation is null, true if delete successful, false otherwise
*/
function Admin_admin_delete($args)
{
$cid = FormUtil::getPassedValue('cid', isset($args['cid']) ? $args['cid'] : null, 'REQUEST');
$objectid = FormUtil::getPassedValue('objectid', isset($args['objectid']) ? $args['objectid'] : null, 'REQUEST');
$confirmation = FormUtil::getPassedValue('confirmation', null, 'POST');
if (!empty($objectid)) {
$cid = $objectid;
}
$item = pnModAPIFunc('Admin', 'admin', 'get', array('cid' => $cid));
if ($item == false) {
return LogUtil::registerError(pnML('_NOSUCHITEMFOUND', array('i' => _CATEGORY)), 404);
}
if (!SecurityUtil::checkPermission('Admin::Category', "$item[catname]::$cid", ACCESS_DELETE)) {
return LogUtil::registerError(_MODULENOAUTH, 403);
}
// Check for confirmation.
if (empty($confirmation)) {
// No confirmation yet - display a suitable form to obtain confirmation
// of this action from the user
$pnRender = pnRender::getInstance('Admin', false);
$pnRender->assign('cid', $cid);
return $pnRender->fetch('admin_admin_delete.htm');
}
if (!SecurityUtil::confirmAuthKey()) {
return LogUtil::registerAuthidError (pnModURL('Admin', 'admin', 'view'));
}
if (pnModAPIFunc('Admin', 'admin', 'delete', array('cid' => $cid))) {
// Success
LogUtil::registerStatus (pnML('_DELETEITEMSUCCEDED', array('i' => _CATEGORY)));
}
return pnRedirect(pnModURL('Admin', 'admin', 'view'));
}
/**
* View all admin categories
* @author Mark West
* @param int $startnum the starting id to view from - optional
* @return string HTML string
*/
function Admin_admin_view($args = array())
{
if (!SecurityUtil::checkPermission('Admin::', '::', ACCESS_EDIT)) {
return LogUtil::registerError(_MODULENOAUTH, 403);
}
$startnum = FormUtil::getPassedValue('startnum', isset($args['startnum']) ? $args['startnum'] : null, 'GET');
$pnRender = pnRender::getInstance('Admin', false);
$items = pnModAPIFunc('Admin', 'admin', 'getall',
array('startnum' => $startnum,
'numitems' => pnModGetVar('Admin', 'itemsperpage')));
$rows = array();
foreach ($items as $item) {
if (SecurityUtil::checkPermission('Admin::', "$item[catname]::$item[cid]", ACCESS_READ)) {
// Options for the item.
$options = array();
if (SecurityUtil::checkPermission('Admin::', "$item[catname]::$item[cid]", ACCESS_EDIT)) {
$options[] = array('url' => pnModURL('Admin', 'admin', 'modify', array('cid' => $item['cid'])),
'image' => 'xedit.gif',
'title' => _EDIT);
if (SecurityUtil::checkPermission('Admin::', "$item[catname]::$item[cid]", ACCESS_DELETE)) {
$options[] = array('url' => pnModURL('Admin', 'admin', 'delete', array('cid' => $item['cid'])),
'image' => '14_layer_deletelayer.gif',
'title' => _DELETE);
}
}
$item['options'] = $options;
$rows[] = $item;
}
}
$pnRender->assign('items', $rows);
$pnRender->assign('pager', array('numitems' => pnModAPIFunc('Admin', 'admin', 'countitems'),
'itemsperpage' => pnModGetVar('Admin', 'itemsperpage')));
// Return the output that has been generated by this function
return $pnRender->fetch('admin_admin_view.htm');
}
/**
* Display main admin panel for a category
* @author Mark West
* @param int $args['acid'] the id of the category to be displayed
* @return string HTML string
*/
function Admin_admin_adminpanel($args)
{
if (!SecurityUtil::checkPermission('::', '::', ACCESS_EDIT)) {
// suppress admin display - return to index.
return pnRedirect(pnConfigGetVar('entrypoint', 'index.php'));
}
// Create output object
$pnRender = pnRender::getInstance('Admin', false);
if (!pnModGetVar('Admin', 'ignoreinstallercheck') && pnConfigGetVar('development') == 0) {
// check if install.php or install folder exist
$installexists = file_exists('install.php') || file_exists('install');
// check if the Zikula Swiss Army Knife exists
$psakexists = file_exists('psak.php');
// if either one them is true we show a warning and do not let the admin go to
// the admin panel
if ($installexists==true || $psakexists==true) {
$pnRender->assign('installexists', $installexists);
$pnRender->assign('psakexists', $psakexists);
$pnRender->assign('adminpanellink', pnModURL('Admin','admin', 'adminpanel'));
return $pnRender->fetch('admin_admin_warning.htm');
}
}
// Now prepare the display of the admin panel by getting the relevant info.
// Get parameters from whatever input we need.
$acid = FormUtil::getPassedValue('acid', (isset($args['acid']) ? $args['acid'] : null), 'GET');
// cid isn't set, so we check the last session var lastcid to see where the admin has been before.
if (empty($acid)) {
$acid = SessionUtil::getVar('lastacid');
if (empty($acid)) {
// cid is still not set, go to the default category
$acid = pnModGetVar('Admin', 'startcategory');
}
}
// now we know where we are or where the admin wants us to go to, lets store it in a
// session var for later use
SessionUtil::setVar('lastacid', $acid);
// Add category menu to output
$pnRender->assign('menu', Admin_admin_categorymenu(array('acid' => $acid)));
// Admin_admin_categorymenu may have changed the acid. In this case it has been
// stored to lastacid so we need to read it again now
$acid = SessionUtil::getVar('lastacid');
// Handle the case where the current/default category does not contain any accessible items
// (the current user may just have admin access to a single module)
if (empty($acid)) {
$acid = pnModGetVar('Admin', 'startcategory');
}
// Get Datails on the selected category
$category = pnModAPIFunc('Admin', 'admin', 'get',
array('cid' => $acid));
if (!$category) {
// get the default category
$acid = pnModGetVar('Admin', 'startcategory');
$category = pnModAPIFunc('Admin', 'admin', 'get',
array('cid' => $acid));
}
// assign the category
$pnRender->assign('category', $category);
// assign all module vars
$pnRender->assign(pnModGetVar('Admin'));
// get admin capable modules
$adminmodules = pnModGetAdminMods();
$adminlinks = array();
foreach ($adminmodules as $adminmodule) {
if (SecurityUtil::checkPermission("$adminmodule[name]::", '::', ACCESS_EDIT)) {
$catid = pnModAPIFunc('Admin', 'admin', 'getmodcategory',
array('mid' => pnModGetIDFromName($adminmodule['name'])));
if (($catid == $acid) || (($catid == false) && ($acid == pnModGetVar('Admin', 'defaultcategory')))) {
$modinfo = pnModGetInfo(pnModGetIDFromName($adminmodule['name']));
if ($modinfo['type'] == 2 || $modinfo['type'] == 3) {
$menutexturl = pnModURL($modinfo['name'], 'admin');
$menutext = $modinfo['displayname'];
$menutexttitle = $modinfo['description'];
$modpath = ($modinfo['type'] == 3) ? 'system' : 'modules';
} else {
$menutexturl = 'admin.php?module=' . $modinfo['name'];
$menutext = $modinfo['displayname'];
$menutexttitle = $modinfo['description'];
$modpath = 'modules';
}
$osmoddir = DataUtil::formatForOS($modinfo['directory']);
$adminicons = array($modpath . '/' . $osmoddir . '/pnimages/admin.gif',
$modpath . '/' . $osmoddir . '/pnimages/admin.jpg',
$modpath . '/' . $osmoddir . '/pnimages/admin.jpeg',
$modpath . '/' . $osmoddir . '/pnimages/admin.png',
$modpath . '/' . $osmoddir . '/images/admin.gif',
'system/Admin/pnimages/default.gif');
foreach($adminicons as $adminicon) {
if(file_exists($adminicon) && is_readable($adminicon)) {
break;
}
}
$adminlinks[] = array('menutexturl' => $menutexturl,
'menutext' => $menutext,
'menutexttitle' => $menutexttitle,
'modname' => $modinfo['name'],
'adminicon' => $adminicon);
}
}
}
$pnRender->assign('adminlinks', $adminlinks);
// work out what stylesheet is being used to render to the admin panel
$css = pnModGetVar('Admin', 'modulestylesheet');
$cssfile = explode('.', $css);
// Return the output that has been generated by this function
if ($pnRender->template_exists('admin_admin_adminpanel_'.$cssfile[0].'.htm')) {
return $pnRender->fetch('admin_admin_adminpanel_'.$cssfile[0].'.htm');
} else {
return $pnRender->fetch('admin_admin_adminpanel.htm');
}
}
/**
* This is a standard function to modify the configuration parameters of the
* module
* @author Mark West
* @return string HTML string
*/
function Admin_admin_modifyconfig()
{
if (!SecurityUtil::checkPermission('Admin::', '::', ACCESS_ADMIN)) {
return LogUtil::registerError(_MODULENOAUTH, 403);
}
// Create output object
$pnRender = pnRender::getInstance('Admin', false);
// get admin capable mods
$adminmodules = pnModGetAdminMods();
// Get all categories
$categories = pnModAPIFunc('Admin', 'admin', 'getall');
$pnRender->assign('categories', $categories);
// assign all the module vars
$pnRender->assign(pnModGetVar('Admin'));
$modulecatories = array();
foreach ($adminmodules as $adminmodule) {
// Get the category assigned to this module
$category = pnModAPIFunc('Admin', 'admin', 'getmodcategory',
array('mid' => pnModGetIDFromName($adminmodule['name'])));
if ($category === false) {
// it's not set, so we use the default category
$category = pnModGetVar('Admin', 'defaultcategory');
}
// output module category selection
$modulecategories[] = array('displayname' => $adminmodule['displayname'],
'name' => $adminmodule['name'],
'category' => $category);
}
$pnRender->assign('modulecategories', $modulecategories);
// Return the output that has been generated by this function
return $pnRender->fetch('admin_admin_modifyconfig.htm');
}
/**
* This is a standard function to update the configuration parameters of the
* module given the information passed back by the modification form
* @author Mark West
* @see Admin_admin_modifyconfig()
* @param int $modulesperrow the number of modules to display per row in the admin panel
* @param int $admingraphic switch for display of admin icons
* @param int $modulename,... the id of the category to set for each module
* @return string HTML string
*/
function Admin_admin_updateconfig()
{
if (!SecurityUtil::checkPermission('Admin::', '::', ACCESS_ADMIN)) {
return LogUtil::registerError(_MODULENOAUTH, 403);
}
if (!SecurityUtil::confirmAuthKey()) {
return LogUtil::registerAuthidError (pnModURL('Admin', 'admin', 'view'));
}
// set modules per row module var
$modulesperrow = FormUtil::getPassedValue('modulesperrow', 5, 'POST');
if (!is_numeric($modulesperrow)) {
LogUtil::registerError (pnML('_MUSTBENUMERIC', array('s' => _ADMIN_MODULESPERROW)));
} else {
pnModSetVar('Admin', 'modulesperrow', $modulesperrow);
}
// set the ignore installer check module var
$ignoreinstallercheck = FormUtil::getPassedValue('ignoreinstallercheck', false, 'POST');
pnModSetVar('Admin', 'ignoreinstallercheck', $ignoreinstallercheck);
// set modules per row module var
$itemsperpage = FormUtil::getPassedValue('itemsperpage', 5, 'POST');
if (!is_numeric($itemsperpage)) {
LogUtil::registerError (pnML('_MUSTBENUMERIC', array('s' => _ADMIN_MODULESPERPAGE)));
} else {
pnModSetVar('Admin', 'itemsperpage', $itemsperpage);
}
// set stylesheet to render module
$modulestylesheet = FormUtil::getPassedValue('modulestylesheet', 'navtabs.css', 'POST');
pnModSetVar('Admin', 'modulestylesheet', $modulestylesheet);
// set admin icons config var (should be moved to module var at some point)
$admingraphic = FormUtil::getPassedValue('admingraphic', 0, 'POST');
pnModSetVar('Admin', 'admingraphic', $admingraphic);
// set start category module var
$startcategory = FormUtil::getPassedValue('startcategory', 1, 'POST');
pnModSetVar('Admin', 'startcategory', $startcategory);
// set default category module var
$defaultcategory = FormUtil::getPassedValue('defaultcategory', 1, 'POST');
pnModSetVar('Admin', 'defaultcategory', $defaultcategory);
// set the admin theme module var
$admintheme = FormUtil::getPassedValue('admintheme', null, 'POST');
pnModSetVar('Admin', 'admintheme', $admintheme);
// get admin modules
$adminmodules = pnModGetAdminMods();
foreach ($adminmodules as $adminmodule) {
$category = FormUtil::getPassedValue($adminmodule['name'], null, 'POST');
if ($category) {
// Add the module to the category
$result = pnModAPIFunc('Admin', 'admin', 'addmodtocategory',
array('module' => $adminmodule['name'],
'category' => $category));
if ($result == false) {
LogUtil::registerError (_ADMIN_FAILEDADDMODTOCAT);
return pnRedirect(pnModURL('Admin', 'admin', 'view'));
}
}
}
// Let any other modules know that the modules configuration has been updated
pnModCallHooks('module','updateconfig','Admin', array('module' => 'Admin'));
// the module configuration has been updated successfuly
LogUtil::registerStatus (_CONFIGUPDATED);
// This function generated no output, and so now it is complete we redirect
// the user to an appropriate page for them to carry on their work
return pnRedirect(pnModURL('Admin', 'admin', 'main'));
}
/**
* Main category menu
* @author Mark West
* @return string HTML string
*/
function Admin_admin_categorymenu($args)
{
$pnRender = pnRender::getInstance('Admin', false);
// get the current category
$acid = FormUtil::getPassedValue('acid', isset($args['acid']) ? $args['acid'] : SessionUtil::getVar('lastacid'), 'GET');
if (empty($acid)) {
// cid is still not set, go to the default category
$acid = pnModGetVar('Admin', 'startcategory');
}
// Get all categories
$items = pnModAPIFunc('Admin', 'admin', 'getall');
// get admin capable modules
$adminmodules = pnModGetAdminMods();
$adminlinks = array();
foreach ($adminmodules as $adminmodule) {
if (SecurityUtil::checkPermission("$adminmodule[name]::", '::', ACCESS_EDIT)) {
$catid = pnModAPIFunc('Admin', 'admin', 'getmodcategory', array('mid' => $adminmodule['id']));
if ($adminmodule['type'] == 2 || $adminmodule['type'] == 3) {
$menutexturl = pnModURL($adminmodule['name'], 'admin');
$menutext = $adminmodule['displayname'];
$menutexttitle = $adminmodule['description'];
} else {
$menutexturl = 'admin.php?module=' . $adminmodule['name'];
$menutext = $adminmodule['displayname'];
$menutexttitle = $adminmodule['description'];
}
$adminlinks[$catid][] = array('menutexturl' => $menutexturl,
'menutext' => $menutext,
'menutexttitle' => $menutexttitle,
'modname' => $adminmodule['name']);
}
}
$menuoptions = array();
$possible_cids = array();
$permission = false;
if (isset($items) && is_array($items)) {
foreach($items as $item) {
// only categories containing modules where the current user has permissions will
// be shown, all others will be hidden
// admin will see all categories
if ( (isset($adminlinks[$item['cid']]) && count($adminlinks[$item['cid']]) )
|| SecurityUtil::checkPermission('.*', '.*', ACCESS_ADMIN) ) {
$menuoption = array('url' => pnModURL('Admin','admin','adminpanel', array('acid' => $item['cid'])),
'title' => $item['catname'],
'description' => $item['description'],
'cid' => $item['cid']);
if (isset($adminlinks[$item['cid']])) {
$menuoption['items'] = $adminlinks[$item['cid']];
} else {
$menuoption['items'] = array();
}
$menuoptions[] = $menuoption;
$possible_cids[] = $item['cid'];
if ($acid==$item['cid']) {
$permission =true;
}
}
}
}
// if permission is false we are not allowed to see this category because its
// empty and we are not admin
if ($permission==false) {
// show the first category
$acid = (int)$possible_cids[0];
}
// store it
SessionUtil::setVar('lastcid', $acid);
$pnRender->assign('currentcat', $acid);
$pnRender->assign('menuoptions', $menuoptions);
// zikula baseline security analyzer
// check for magic_quotes
$pnRender->assign('magic_quotes_gpc', DataUtil::getBooleanIniValue('magic_quotes_gpc'));
// check for register_globals
$pnRender->assign('register_globals', DataUtil::getBooleanIniValue('register_globals'));
// check for config.php beeing writable
// cannot rely on is_writable() because it falsely reports a number of cases - drak
$config_php = @fopen('config/config.php', 'a');
if ($config_php === true) {
fclose($config_php);
}
$pnRender->assign('config_php', (bool)$config_php);
// check for upgrade.php
$upgrade_php = (bool) file_exists('upgrade.php');
$pnRender->assign('upgrade_php', $upgrade_php);
// check for legacy mode
$legacy_mode = (bool) pnConfigGetVar('loadlegacy');
$pnRender->assign('legacy_mode', $legacy_mode);
// check for .htaccess in /pnTemp
if ($GLOBALS['PNConfig']['System']['temp']) {
// default installation, check for .htaccess
$pntemp_htaccess = (bool) file_exists($GLOBALS['PNConfig']['System']['temp'].'/.htaccess');
} else {
// already customized, admin should know about what he's doing...
$pntemp_htaccess = true;
}
$pnRender->assign('pntemp_htaccess', $pntemp_htaccess);
// check for anticracker
$scactive = (bool) pnModAvailable('SecurityCenter');
$scenabled = (bool) pnConfigGetVar('enableanticracker');
$pnRender->assign('scactive', $scactive);
$pnRender->assign('scenabled', $scenabled);
// check for safehtml outputfilter
$safehtml = (bool) (pnModAvailable('SecurityCenter') && pnConfigGetVar('outputfilter') == 1);
$pnRender->assign('safehtml', $safehtml);
// work out what stylesheet is being used to render to the admin panel
$css = pnModGetVar('Admin', 'modulestylesheet');
$cssfile = explode('.', $css);
// Return the output that has been generated by this function
if ($pnRender->template_exists('admin_admin_categorymenu_'.$cssfile[0].'.htm')) {
return $pnRender->fetch('admin_admin_categorymenu_'.$cssfile[0].'.htm');
} else {
return $pnRender->fetch('admin_admin_categorymenu.htm');
}
}
/**
* display the module help page
*
*/
function Admin_admin_help()
{
if (!SecurityUtil::checkPermission('Admin::', '::', ACCESS_ADMIN)) {
return LogUtil::registerError(_MODULENOAUTH, 403);
}
$pnRender = pnRender::getInstance('Admin', false);
return $pnRender->fetch('admin_admin_help.htm');
}

Source for file pnadmin.php