File Source for pnadminapi.php

<?php
/**
* Zikula Application Framework
*
* @copyright (c) 2002, Zikula Development Team
* @link http://www.zikula.org
* @version $Id: pnadminapi.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
*/
/**
* create a admin category
* @author Mark West
* @param string $args['catname'] name of the category
* @param string $args['description'] description of the category
* @return mixed admin category ID on success, false on failure
*/
function Admin_adminapi_create($args)
{
// Argument check
if (!isset($args['catname']) ||
!strlen($args['catname']) ||
!isset($args['description'])) {
return LogUtil::registerError (_MODARGSERROR);
}
// Security check
if (!SecurityUtil::checkPermission('Admin::Category', "$args[catname]::", ACCESS_ADD)) {
return LogUtil::registerPermissionError ();
}
$item = array('catname' => $args['catname'], 'description' => $args['description']);
if (!DBUtil::insertObject($item, 'admin_category', 'cid')) {
return LogUtil::registerError (_CREATEFAILED);
}
// Let other modules know an item has been created
pnModCallHooks('item', 'create', $item['cid'], array('module' => 'Admin'));
// Return the id of the newly created item to the calling process
return $item['cid'];
}
/**
* delete a admin category
* @author Mark West
* @param int $args['cid'] ID of the category
* @return bool true on success, false on failure
*/
function Admin_adminapi_delete($args)
{
if (!isset($args['cid']) || !is_numeric($args['cid'])) {
return LogUtil::registerError (_MODARGSERROR);
}
$item = pnModAPIFunc('Admin', 'admin', 'get', array('cid' => $args['cid']));
if ($item == false) {
return LogUtil::registerError (_NOSUCHITEM);
}
if (!SecurityUtil::checkPermission('Admin::Category', "$item[catname]::$args[cid]", ACCESS_DELETE)) {
return LogUtil::registerPermissionError ();
}
// Avoid deletion of the default category
$defaultcategory = pnModGetVar('Admin', 'defaultcategory');
if ($args['cid'] == $defaultcategory) {
return LogUtil::registerError (_ADMIN_DELETEFAILEDDEFAULT);
}
// Avoid deletion of the start category
$startcategory = pnModGetVar('Admin', 'startcategory');
if ($args['cid'] == $startcategory) {
return LogUtil::registerError (_ADMIN_DELETEFAILEDSTART);
}
// move all modules from the category to be deleted into the
// default category. We can't do this via a simple DBUtil call
// because it's a non-object based mass update of the key field.
$pntable = pnDBGetTables();
$column = $pntable['admin_module_column'];
$where = "WHERE $column[cid] = '" . (int)DataUtil::formatForStore($args['cid']) . "'";
$obj = array();
$obj['cid'] = $defaultcategory;
$res = DBUtil::updateObject ($obj, 'admin_module', $where);
if (!$res) {
return LogUtil::registerError (_DELETEFAILED);
}
// Now actually delete the category
if (!DBUtil::deleteObjectByID ('admin_category', $args['cid'], 'cid')) {
return LogUtil::registerError (_DELETEFAILED);
}
// Let any hooks know that we have deleted an item.
pnModCallHooks('item', 'delete', $args['cid'], array('module' => 'Admin'));
// Let the calling process know that we have finished successfully
return true;
}
/**
* update a admin category
* @author Mark West
* @param int $args['cid'] the ID of the category
* @param string $args['catname'] the new name of the category
* @param string $args['description'] the new description of the category
* @return bool true on success, false on failure
*/
function Admin_adminapi_update($args)
{
// Argument check
if (!isset($args['cid']) ||
!is_numeric($args['cid']) ||
!isset($args['catname']) ||
!strlen($args['catname']) ||
!isset($args['description'])) {
return LogUtil::registerError (_MODARGSERROR);
}
// Get the existing item
$item = pnModAPIFunc('Admin', 'admin', 'get', array('cid' => $args['cid']));
if ($item == false) {
return LogUtil::registerError (_NOSUCHITEM);
}
// Security checks (both old item and updated item)
if (!SecurityUtil::checkPermission('Admin::Category', "$item[catname]::$args[cid]", ACCESS_EDIT)) {
return LogUtil::registerPermissionError ();
}
if (!SecurityUtil::checkPermission('Admin::Category', "$args[catname]:$args[cid]", ACCESS_EDIT)) {
return LogUtil::registerPermissionError ();
}
$item = array('cid' => $args['cid'], 'catname' => $args['catname'], 'description' => $args['description']);
if (!DBUtil::updateObject($item, 'admin_category', '', 'cid')) {
return LogUtil::registerError (_UPDATEFAILED);
}
// New hook functions
pnModCallHooks('item', 'update', $args['cid'], array('module' => 'Admin'));
// Let the calling process know that we have finished successfully
return true;
}
/**
* get all admin categories
* @author Mark West
* @param int $args['startnum'] starting record number
* @param int $args['numitems'] number of items to get
* @return mixed array of items, or false on failure
*/
function Admin_adminapi_getall($args)
{
// Optional arguments.
if (!isset($args['startnum']) || !is_numeric($args['startnum'])) {
$args['startnum'] = 1;
}
if (!isset($args['numitems']) || !is_numeric($args['numitems'])) {
$args['numitems'] = -1;
}
// argument check
if (!isset($args['startnum']) ||
!isset($args['numitems'])) {
return LogUtil::registerError (_MODARGSERROR);
}
$items = array();
// Security check
if (!SecurityUtil::checkPermission('Admin::', '::', ACCESS_READ)) {
return $items;
}
// get the necessary db information
pnModDBInfoLoad('Admin', 'Admin');
$pntable = pnDBGetTables();
$admincategorycolumn = &$pntable['admin_category_column'];
// get all categories the user has permission to see
$orderBy = "ORDER BY $admincategorycolumn[catname]";
$permFilter = array(array('realm' => 0,
'component_left' => 'Admin',
'instance_left' => 'catname',
'instance_right' => 'cid',
'level' => ACCESS_READ));
$result = DBUtil::selectObjectArray('admin_category', '', $orderBy, $args['startnum']-1, $args['numitems'], '', $permFilter);
if (!$result) {
return false;
}
return $result;
}
/**
* get a specific category
* @author Mark West
* @param int $args['cid'] id of example item to get
* @return mixed item array, or false on failure
*/
function Admin_adminapi_get($args)
{
// Argument check
if (!isset($args['cid'])) {
return LogUtil::registerError (_MODARGSERROR);
}
// retrieve the category object
$result = DBUtil::selectObjectByID('admin_category', (int)$args['cid'], 'cid');
if (!$result) {
return false;
}
if (!SecurityUtil::checkPermission('Admin::', "$result[catname]::$result[cid]", ACCESS_READ)) {
return LogUtil::registerPermissionError ();
}
// Return the item array
return $result;
}
/**
* utility function to count the number of items held by this module
* @author Mark West
* @return int number of items held by this module
*/
function Admin_adminapi_countitems()
{
return DBUtil::selectObjectCount('admin_category');
}
/**
* add a module to a category
* @author Mark West
* @param string $args['module'] name of the module
* @param int $args['category'] number of the category
* @return mixed admin category ID on success, false on failure
*/
function Admin_adminapi_addmodtocategory($args)
{
if (!isset($args['module']) ||
!isset($args['category'])) {
return LogUtil::registerError (_MODARGSERROR);
}
// this function is called durung the init process so we have to check in _PNINSTALLVER
// is set as alternative to the correct permission check
if (!defined('_PNINSTALLVER') && !SecurityUtil::checkPermission('Admin::Category', "::", ACCESS_ADD)) {
return LogUtil::registerPermissionError ();
}
// get module id
$mid = pnModGetIDFromName($args['module']);
if (!DBUtil::deleteObjectByID ('admin_module', $mid, 'mid')) {
return false;
}
$values = array();
$values['cid'] = $args['category'];
$values['mid'] = $mid;
if (!DBUtil::insertObject($values, 'admin_module')) {
return false;
}
// Return success
return true;
}
/**
* Get the category a module belongs to
* @author Mark West
* @param int $args['mid'] id of the module
* @return mixed category id, or false on failure
*/
function Admin_adminapi_getmodcategory($args)
{
// create a static result set to prevent multiple sql queries
static $catitems = array();
// Argument check
if (!isset($args['mid'])) {
return LogUtil::registerError (_MODARGSERROR);
}
// check if we've already worked this query out
if (isset($catitems[$args['mid']])) {
return $catitems[$args['mid']];
}
// retrieve the admin module object array
$result = DBUtil::selectObjectArray('admin_module', '', '', -1, -1, 'mid');
if (!$result) {
return false;
}
$ak = array_keys($result);
foreach ($ak as $val) {
$catitems[$val] = $result[$val]['cid'];
}
// Return the category id
if (isset($catitems[$args['mid']])) {
return $catitems[$args['mid']];
}
return false;
}
/**
* Get the category a module belongs to
* @author Mark West
* @param int $args['mid'] id of the module
* @return mixed array of styles if successful, or false on failure
*/
function Admin_adminapi_getmodstyles($args)
{
// check our input and get the module information
if (!isset($args['modname']) ||
!is_string($args['modname']) ||
!is_array($modinfo = pnModGetInfo(pnModGetIDFromName($args['modname'])))) {
SessionUtil::setVar(_MODARGSERROR);
return false;
}
if (!isset($args['exclude']) || !is_array($args['exclude'])) {
$args['exclude'] = array();
}
// create an empty result set
$styles = array();
$osmoddir = DataUtil::formatForOS($modinfo['directory']);
if (is_dir($dir = "modules/$osmoddir/pnstyle")) {
$handle = opendir($dir);
while (false !== ($file = readdir($handle))) {
if (stristr($file, '.css') && !in_array($file, $args['exclude'])) {
$styles[] = $file;
}
}
} else if (is_dir($dir = "system/$osmoddir/pnstyle")) {
$handle = opendir($dir);
while (false !== ($file = readdir($handle))) {
if (stristr($file, '.css') && !in_array($file, $args['exclude'])) {
$styles[] = $file;
}
}
}
// return our results
return $styles;
}
/**
* get available admin panel links
*
* @author Mark West
* @return array array of admin links
*/
function admin_adminapi_getlinks()
{
$links = array();
pnModLangLoad('Admin', 'admin');
if (SecurityUtil::checkPermission('Admin::', '::', ACCESS_READ)) {
$links[] = array('url' => pnModURL('Admin', 'admin', 'view'), 'text' => _MODULECATEGORIESLISTVIEW);
}
if (SecurityUtil::checkPermission('Admin::', '::', ACCESS_ADD)) {
$links[] = array('url' => pnModURL('Admin', 'admin', 'new'), 'text' => _NEWMODULECATEGORY);
}
if (SecurityUtil::checkPermission('Admin::', '::', ACCESS_ADMIN)) {
$links[] = array('url' => pnModURL('Admin', 'admin', 'modifyconfig'), 'text' => _MODIFYADMINPANELCONFIG);
}
return $links;
}

Source for file pnadminapi.php