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_Value_Addons
* @subpackage Feeds
*/
/**
* the main administration function
*/
function feeds_admin_main()
{
// Security check
if (!SecurityUtil::checkPermission( 'Feeds::Item', '::', ACCESS_EDIT)) {
return LogUtil::registerPermissionError();
}
// Create output object
$pnRender = pnRender::getInstance('Feeds', false);
// Return the output that has been generated by this function
return $pnRender->fetch('feeds_admin_main.htm');
}
/**
* add new item
* This is a standard function that is called whenever an administrator
* wishes to create a new module item
*/
function feeds_admin_new()
{
// Security check
if (!SecurityUtil::checkPermission( 'Feeds::Item', '::', ACCESS_ADD)) {
return LogUtil::registerPermissionError();
}
// load the categories system
if (!($class = Loader::loadClass('CategoryRegistryUtil'))) {
pn_exit (pnML('_UNABLETOLOADCLASS', array('s' => 'CategoryRegistryUtil')));
}
$categories = CategoryRegistryUtil::getRegisteredModuleCategories ('Feeds', 'feeds');
// Create output object
$pnRender = pnRender::getInstance('Feeds', false);
$pnRender->assign('categories', $categories);
$pnRender->assign('enablecategorization', pnModGetVar('Feeds', 'enablecategorization'));
// Return the output that has been generated by this function
return $pnRender->fetch('feeds_admin_new.htm');
}
/**
* This is a standard function that is called with the results of the
* form supplied by feeds_admin_new() to create a new item
* @param 'feedname' the name of the item to be created
* @param 'url' the url of the item to be created
*/
function feeds_admin_create($args)
{
// Get parameters from whatever input we need
$feed = FormUtil::getPassedValue('feed', isset($args['feed']) ? $args['feed'] : null, 'POST');
// Confirm authorisation code
if (!SecurityUtil::confirmAuthKey()) {
return LogUtil::registerAuthidError (pnModURL('Feeds', 'admin', 'view'));
}
// Notable by its absence there is no security check here.
// Create the feed
$fid = pnModAPIFunc('Feeds', 'admin', 'create', $feed);
if ($fid != false) {
// Success
LogUtil::registerStatus (_CREATESUCCEDED);
}
return pnRedirect(pnModURL('Feeds', 'admin', 'view'));
}
/**
* modify an item
* This is a standard function that is called whenever an administrator
* wishes to modify a current module item
* @param 'fid' the id of the item to be modified
*/
function feeds_admin_modify($args)
{
$fid = FormUtil::getPassedValue('fid', isset($args['fid']) ? $args['fid'] : null, 'GET');
$objectid = FormUtil::getPassedValue('objectid', isset($args['objectid']) ? $args['objectid'] : null, 'GET');
if (!empty($objectid)) {
$fid = $objectid;
}
// Get the feeds feed
$item = pnModAPIFunc('Feeds', 'user', 'get', array('fid' => $fid));
if ($item == false) {
return LogUtil::registerError (_NOSUCHITEM, 404);
}
// Security check
if (!SecurityUtil::checkPermission( 'Feeds::Item', "$item[name]::$fid", ACCESS_EDIT)) {
return LogUtil::registerPermissionError();
}
// load the categories system
if (!($class = Loader::loadClass('CategoryRegistryUtil'))) {
pn_exit (pnML('_UNABLETOLOADCLASS', array('s' => 'CategoryRegistryUtil')));
}
$categories = CategoryRegistryUtil::getRegisteredModuleCategories ('Feeds', 'feeds');
// Create output object
$pnRender = pnRender::getInstance('Feeds', false);
$pnRender->assign('categories', $categories);
// Assign the item
$pnRender->assign($item);
$pnRender->assign('enablecategorization', pnModGetVar('Feeds', 'enablecategorization'));
// Return the output that has been generated by this function
return $pnRender->fetch('feeds_admin_modify.htm');
}
/**
* This is a standard function that is called with the results of the
* form supplied by RSS_admin_modify() to update a current item
* @param 'fid' the id of the item to be updated
* @param 'feedname' the name of the item to be updated
* @param 'url' the url of the item to be updated
*/
function feeds_admin_update($args)
{
$feed = FormUtil::getPassedValue('feed', isset($args['feed']) ? $args['feed'] : null, 'POST');
if (!empty($feed['objectid'])) {
$feed['fid'] = $feed['objectid'];
}
// Confirm authorisation code
if (!SecurityUtil::confirmAuthKey()) {
return LogUtil::registerAuthidError (pnModURL('Feeds', 'admin', 'view'));
}
// Notable by its absence there is no security check here
// Update the feeds feed
if (pnModAPIFunc('Feeds', 'admin', 'update', $feed)) {
// Success
LogUtil::registerStatus (_UPDATESUCCEDED);
}
return pnRedirect(pnModURL('Feeds', '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
* @param 'fid' the id of the item to be deleted
* @param 'confirmation' confirmation that this item can be deleted
*/
function feeds_admin_delete($args)
{
$fid = FormUtil::getPassedValue('fid', isset($args['fid']) ? $args['fid'] : null, 'REQUEST');
$objectid = FormUtil::getPassedValue('objectid', isset($args['objectid']) ? $args['objectid'] : null, 'REQUEST');
$confirmation = FormUtil::getPassedValue('confirmation', null, 'POST');
if (!empty($objectid)) {
$fid = $objectid;
}
// Get the feed
$item = pnModAPIFunc('Feeds', 'user', 'get', array('fid' => $fid));
if ($item == false) {
return LogUtil::registerError (_NOSUCHITEM, 404);
}
// Security check
if (!SecurityUtil::checkPermission( 'Feeds::Item', "$item[name]::$fid", ACCESS_DELETE)) {
return LogUtil::registerPermissionError();
}
// Check for confirmation.
if (empty($confirmation)) {
// No confirmation yet
// Create output object
$pnRender = pnRender::getInstance('Feeds', false);
// assign the item id.
$pnRender->assign('fid', $fid);
// Return the output that has been generated by this function
return $pnRender->fetch('feeds_admin_delete.htm');
}
// If we get here it means that the user has confirmed the action
// Confirm authorisation code
if (!SecurityUtil::confirmAuthKey()) {
return LogUtil::registerAuthidError (pnModURL('Feeds', 'admin', 'view'));
}
// Delete the feed
if (pnModAPIFunc('Feeds', 'admin', 'delete',
array('fid' => $fid))) {
// Success
LogUtil::registerStatus (_DELETESUCCEDED);
}
return pnRedirect(pnModURL('Feeds', 'admin', 'view'));
}
/**
* view items
*/
function feeds_admin_view($args)
{
// Security check
if (!SecurityUtil::checkPermission( 'Feeds::', '::', ACCESS_EDIT)) {
return LogUtil::registerPermissionError();
}
$startnum = FormUtil::getPassedValue('startnum', isset($args['startnum']) ? $args['startnum'] : null, 'GET');
$property = FormUtil::getPassedValue('feeds_property', isset($args['feeds_property']) ? $args['feeds_property'] : null, 'POST');
$category = FormUtil::getPassedValue("feeds_{$property}_category", isset($args["feeds_{$property}_category"]) ? $args["feeds_{$property}_category"] : null, 'POST');
$clear = FormUtil::getPassedValue('clear', false, 'POST');
if ($clear) {
$property = null;
$category = null;
}
// get module vars for later use
$modvars = pnModGetVar('Feeds');
if ($modvars['enablecategorization']) {
// load the category registry util
if (!($class = Loader::loadClass('CategoryRegistryUtil'))) {
pn_exit (pnML('_UNABLETOLOADCLASS', array('s' => 'CategoryRegistryUtil')));
}
$catregistry = CategoryRegistryUtil::getRegisteredModuleCategories('Feeds', 'feeds');
$properties = array_keys($catregistry);
// Validate and build the category filter - mateo
if (!empty($property) && in_array($property, $properties) && !empty($category)) {
$catFilter = array($property => $category);
}
// Assign a default property - mateo
if (empty($property) || !in_array($property, $properties)) {
$property = $properties[0];
}
// plan ahead for ML features
$propArray = array();
foreach ($properties as $prop) {
$propArray[$prop] = $prop;
}
}
// Get all the feeds
$items = pnModAPIFunc('Feeds', 'user', 'getall',
array('startnum' => $startnum,
'numitems' => $modvars['itemsperpage'],
'order' => 'fid',
'category' => isset($catFilter) ? $catFilter : null,
'catregistry' => isset($catregistry) ? $catregistry : null));
$feedsitems = array();
foreach ($items as $item) {
if (SecurityUtil::checkPermission('Feeds::', "$item[name]::$item[fid]", ACCESS_READ)) {
// Options for the item
$options = array();
if (SecurityUtil::checkPermission( 'Feeds::', "$item[name]::$item[fid]", ACCESS_EDIT)) {
$options[] = array('url' => pnModURL('Feeds', 'admin', 'modify', array('fid' => $item['fid'])),
'image' => 'xedit.gif',
'title' => _EDIT);
if (SecurityUtil::checkPermission( 'Feeds::', "$item[name]::$item[fid]", ACCESS_DELETE)) {
$options[] = array('url' => pnModURL('Feeds', 'admin', 'delete', array('fid' => $item['fid'])),
'image' => '14_layer_deletelayer.gif',
'title' => _DELETE);
}
}
$item['options'] = $options;
$feedsitems[] = $item;
}
}
// Create output object
$pnRender = pnRender::getInstance('Feeds', false);
// Assign the items and modvars to the template
$pnRender->assign('feedsitems', $feedsitems);
$pnRender->assign($modvars);
// Assign the default language
$pnRender->assign('lang', pnUserGetLang());
// Assign the categories information if enabled
if ($modvars['enablecategorization']) {
$pnRender->assign('catregistry', $catregistry);
$pnRender->assign('numproperties', count($propArray));
$pnRender->assign('properties', $propArray);
$pnRender->assign('property', $property);
$pnRender->assign("category", $category);
}
// Assign the values for the smarty plugin to produce a pager
$pnRender->assign('pager', array('numitems' => pnModAPIFunc('Feeds', 'user', 'countitems', array('category' => isset($catFilter) ? $catFilter : null)),
'itemsperpage' => $modvars['itemsperpage']));
// Return the output that has been generated by this function
return $pnRender->fetch('feeds_admin_view.htm');
}
/**
* This is a standard function to modify the configuration parameters of the
* module
*/
function feeds_admin_modifyconfig()
{
// Security check
if (!SecurityUtil::checkPermission( 'Feeds::', '::', ACCESS_ADMIN)) {
return LogUtil::registerPermissionError();
}
// Create output object
$pnRender = pnRender::getInstance('Feeds', false);
// Assign all module vars
$pnRender->assign(pnModGetVar('Feeds'));
// Return the output that has been generated by this function
return $pnRender->fetch('feeds_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
*/
function feeds_admin_updateconfig()
{
// Security check
if (!SecurityUtil::checkPermission( 'Feeds::', '::', ACCESS_ADMIN)) {
return LogUtil::registerPermissionError();
}
// Confirm authorisation code
if (!SecurityUtil::confirmAuthKey()) {
return LogUtil::registerAuthidError (pnModURL('Feeds', 'admin', 'view'));
}
// Update module variables
$enablecategorization = (bool)FormUtil::getPassedValue('enablecategorization', false, 'POST');
pnModSetVar('Feeds', 'enablecategorization', $enablecategorization);
$bold = (bool)FormUtil::getPassedValue('bold', 0, 'POST');
pnModSetVar('Feeds', 'bold', $bold);
$openinnewwindow = (bool)FormUtil::getPassedValue('openinnewwindow', 0, 'POST');
pnModSetVar('Feeds', 'openinnewwindow', $openinnewwindow);
$itemsperpage = (int)FormUtil::getPassedValue('itemsperpage', 10, 'POST');
pnModSetVar('Feeds', 'itemsperpage', $itemsperpage);
$cacheinterval = (int)FormUtil::getPassedValue('cacheinterval', 180, 'POST');
pnModSetVar('Feeds', 'cacheinterval', $cacheinterval);
$cachedirectory = (string)FormUtil::getPassedValue('cachedirectory', 'feeds', 'POST');
pnModSetVar('Feeds', 'cachedirectory', $cachedirectory);
// Let any other modules know that the modules configuration has been updated
pnModCallHooks('module','updateconfig','Feeds', array('module' => 'Feeds'));
// the module configuration has been updated successfuly
LogUtil::registerStatus (_CONFIGUPDATED);
return pnRedirect(pnModURL('Feeds', 'admin', 'view'));
}

Source for file pnadmin.php