0byt3m1n1

Path: /data/applications/aps/tikiwiki/7.0-0/standard/htdocs/lib/wiki-plugins/ [ Home ]
File: wikiplugin_pluginmanager.php
<?php
// (c) Copyright 2002-2011 by authors of the Tiki Wiki CMS Groupware Project
// 
// All Rights Reserved. See copyright.txt for details and a complete list of authors.
// Licensed under the GNU LESSER GENERAL PUBLIC LICENSE. See license.txt for details.
// $Id: wikiplugin_pluginmanager.php 34427 2011-05-15 04:03:20Z lindonb $

require_once 'lib/wiki/pluginslib.php';

class WikiPluginPluginManager extends PluginsLib
{
    var $expanded_params = array('info');
    function getDefaultArguments() {
        return array(
					'info' => 'description|parameters|paraminfo', 
					'plugin' => '', 
        			'module' => '',
					'singletitle' => 'none',
        			'titletag' => 'h3',
        			'start' => '',
        			'limit' => '',
        		);
    }
    function getName() {
        return 'PluginManager';
    }
    function getVersion() {
        return preg_replace("/[Revision: $]/", '',
            "\$Revision: 1.11 $");
    }
    function getDescription() {
        return wikiplugin_pluginmanager_help();
    }
    function run($data, $params) {
        global $wikilib, $helpurl, $tikilib;
        if (!is_dir(PLUGINS_DIR)) {
            return $this->error('No plugin directory defined');
        }
        if (empty($helpurl)) {
        	$helpurl = 'http://doc.tiki.org/';
        }
        
        $params = $this->getParams($params);
        extract($params,EXTR_SKIP);

        if (!empty($module) && !empty($plugin)) {
			return $this->error(tra('The module or plugin parameter must be set, but not both.'));
        } elseif (!empty($module)) {
        	$aPrincipalField = array('field' => 'plugin', 'name' => 'Module');
			$helppath = $helpurl . $aPrincipalField['name'] . ' ';
        	$filepath = 'mod-func-';
        	global $modlib;
        	include_once 'lib/modules/modlib.php';
        	$aPlugins = $modlib->list_module_files();
        	$mod = true;
        	$plugin = $module;
        } else {
			$aPrincipalField = array('field' => 'plugin', 'name' => 'Plugin');
			$helppath = $helpurl . $aPrincipalField['name'];
			$filepath = 'wikiplugin_';
        	$aPlugins = $wikilib->list_plugins();
        	$mod = false;
        }
        //if the user set $module, that setting has now been moved to $plugin so that one code set is used
        //$aPlugins now has the complete list of plugin or module file names - code below modifies $aPlugins
        //if necessary based on user settings
        if (!empty($plugin)) {
	        if (strpos($plugin, '|') !== false) {
	        	$aPlugins = array();
	        	$userlist = explode('|',$plugin);
	        	foreach ($userlist as $useritem) {
	        		$aPlugins[] = $filepath . $useritem . '.php';
	        	}
        	} elseif (strpos($plugin, '-') !== false) {
        		$userrange = explode('-',$plugin);
        		$begin = array_search($filepath . $userrange[0] . '.php', $aPlugins);
        		$end = array_search($filepath . $userrange[1] . '.php', $aPlugins);
        		$beginerror = '';
        		$enderror = '';
        		if ($begin === false || $end === false) {
        			if ($begin === false) {
        				$beginerror = $userrange[0];
        			} 
        			if ($end === false) {
        				$enderror = $userrange[1];
        				!empty($beginerror) ? $and = ' and ' : $and = '';
        			}
        			return '^' . tra('^Plugin Manager error: ') . $beginerror . $and . $enderror . tra(' not found') . '^';
        		} elseif ($end > $begin) {
        			$aPlugins = array_slice($aPlugins, $begin, $end-$begin+1);
        		} else {
        			$aPlugins = array_slice($aPlugins, $end, $begin-$end+1);
        		}     		
			} elseif (!empty($limit)) { 
        		$begin = array_search($filepath . $plugin . '.php', $aPlugins); 
        		if ($begin === false) {
        			return '^' . tra('Plugin manager error: ') . $begin . tra(' not found') . '^';
        		} else {
        			$aPlugins = array_slice($aPlugins, $begin, $limit);
        		}
        	} elseif ($plugin != 'all') {
	        	$aPlugins = array();
        		$aPlugins[] = $filepath . $plugin . '.php';
        	}
        } else {
        	if (!empty($start) || !empty($limit)) {
        		if (!empty($start) && !empty($limit)) {
        			$aPlugins = array_slice($aPlugins, $start-1, $limit);
        		} elseif (!empty($start)) {
        			$aPlugins = array_slice($aPlugins, $start-1);
        		} else {			
        			$aPlugins = array_slice($aPlugins, 0, $limit);
        		}
        	}
        }
        //Set all data variables needed for separate code used to generate the display table
        $aData=array();
        if ($singletitle == 'table' || count($aPlugins) > 1) {
        	foreach($aPlugins as $sPluginFile) {
	        	global $sPlugin, $numparams;
	        	if ($mod) {
	        		$infoPlugin = get_module_params($sPluginFile);
	        		$namepath = $sPlugin;
	        	} else {
	        		$infoPlugin = get_plugin_info($sPluginFile);
	        		$namepath = ucfirst($sPlugin);
	        	}
	    		if (in_array('description',$info)) {
					if (isset($infoPlugin['description'])) {
						if ($numparams > 1) {
		    				$aData[$sPlugin]['description']['onekey'] = $infoPlugin['description'];
						} else {
							$aData[$sPlugin]['description'] = $infoPlugin['description'];
						}
					} else {
						$aData[$sPlugin]['description'] = ' --- ';
					}
	    		}
		   		if (in_array('parameters',$info)) {
	    			if ($numparams > 0) {
		    			if ($aPrincipalField['field'] == 'plugin' && !in_array('options',$info) && $numparams > 1) {
		    				$aData[$sPlugin][$aPrincipalField['field']]['rowspan'] = $numparams;
		    				if (in_array('description',$info)) {
		    					$aData[$sPlugin]['description']['rowspan'] = $numparams;
		    				}
		    			}
		    			foreach($infoPlugin['params'] as $paramname => $param) {
		    				if (isset($infoPlugin['params'][$paramname]['description'])) {
		    					$paramblock = '~np~' . $infoPlugin['params'][$paramname]['description'] . '~/np~';
		    				}
		    				if (isset($param['options']) && is_array($param['options'])) {
		    					$paramblock .= '<br /><em>' . tra('Options:') . '</em> ';
		    					$i = 0;
								foreach($param['options'] as $oplist => $opitem) {
									if (isset($opitem['value'])) {
										$paramblock .= $opitem['value'];
									} else {
										$paramblock .=  $opitem['text'];
									}
									$paramblock .= ' | ';
									$i++;
								}
								$paramblock = substr($paramblock, 0, -3);
							}
		    				if (isset($infoPlugin['params'][$paramname]['required']) && $infoPlugin['params'][$paramname]['required'] == true) {
		    					$aData[$sPlugin]['parameters']['<b>' . $paramname . '</b>'] = $paramblock;
		    				} else {
		    					$aData[$sPlugin]['parameters'][$paramname] = $paramblock;
		    				}
		    			}
					} else {
						$aData[$sPlugin]['parameters']['<em>no parameters</em>'] = '<em>' . tra('n/a') . '</em>';
					}
				}
				$aData[$sPlugin]['plugin']['plugin'] = '[' . $helppath . $namepath . '|' . ucfirst($sPlugin) . ']';
	        } // Plugins Loop
        	return PluginsLibUtil::createTable($aData, $info, $aPrincipalField);
        } else {
        	//Replicates a documentation table for parameters for a single plugin or module
        	//Not using plugin lib table to avoid making custom modifications
			global $sPlugin, $numparams;
        	if ($mod) {
        		$infoPlugin = get_module_params($aPlugins[0]);
        		$namepath = $sPlugin;
        	} else {
        		$infoPlugin = get_plugin_info($aPlugins[0]);
        		$namepath = ucfirst($sPlugin);
        	}
			if ($singletitle == 'top') {
        		$title = '<' . $titletag . '>['. $helppath . $namepath 
        			. '|' . ucfirst($sPlugin) . ']</' . $titletag . '>';
        		$title .= $infoPlugin['description'] . '<br />';
        		if (isset($infoPlugin['introduced'])) {
        			$title .= '<em>' . tra('Introduced in Tiki version') . ' ' . $infoPlugin['introduced'] . '</em><br />';
        		}
        		$title .= '<br />';
        	} else {
        		$title = '';
        	}
        	$headbegin = "\n\t\t" . '<td class="heading">';
        	$cellbegin = "\n\t\t" . '<td>';
        	$header =  "\n\t" . '<tr class="heading">' . $headbegin . 'Parameters</td>';
        	$rows = '';
        	if (isset($numparams) && $numparams > 0) {
        		$header .= $headbegin . tra('Accepted Values') . '</td>';
 		       	$header .= $headbegin . tra('Description') . '</td>';
        		$rowCounter = 1;
        		foreach ($infoPlugin['params'] as $paramname => $paraminfo) {
        			$class = ($rowCounter%2) ? 'odd' : 'even';
        			$rows .= "\n\t" . '<tr class="' . $class . '">' . $cellbegin;
        			//Parameters column
        			if (isset($paraminfo['required']) && $paraminfo['required'] == true) {
        				$rows .= '<b><em>' . $paramname . '</em></b>';
        			} else {
        				$rows .= '<em>' . $paramname . '</em>' ;
        			}
        			$rows .= '</td>';
        			$rows .= $cellbegin;
        			//Accepted Values column
        			if (isset($paraminfo['accepted'])) {
        				$rows .= $paraminfo['accepted'] . '</td>';
        			} elseif (isset($paraminfo['options'])) {
        				$optcounter = 1;
        				$numoptions = count($paraminfo['options']);
						foreach($paraminfo['options'] as $oplist => $opitem) {
							if ((isset($opitem['value']) && !empty($opitem['value'])) &&
									(isset($opitem['text']) && !empty($opitem['text'])))
							{
								if (isset($opitem['value']) && !empty($opitem['value'])) {
									$rows .= $opitem['value'];
								} else {
									$rows .=  $opitem['text'];
								}
								if ($optcounter < $numoptions) {	
									if ($numoptions > 10) {
										$rows .= ' | ';
									} else {
										$rows .= '<br />';
									}
								}
							}
							$optcounter++;
						}
						$rows .= '</td>';
        			} elseif (isset($paraminfo['filter'])) {
        				if ($paraminfo['filter'] == 'striptags') {
        					$rows .= tra('any string except for HTML and PHP tags');
        				} else {
        					$rows .= $paraminfo['filter'];
        				}
        				$rows .= '</td>';
        			} else {
        				$rows .= '</td>';
        			}
        			//Description column
        			$rows .= $cellbegin . $paraminfo['description'] . '</td>';
        			//Default column
        			if ($rowCounter == 1) {
        				$header .= $headbegin . tra('Default') . '</td>';
        			}
        			if (!isset($paraminfo['default'])) {
        				$paraminfo['default'] = '';
        			}
					$rows .= $cellbegin . $paraminfo['default'] . '</td>';
					//Since column
        			if ($rowCounter == 1) {
        				$header .= $headbegin . tra('Since') . '</td>';
        			}
					$rows .= $cellbegin . $paraminfo['since'] . '</td>';
 		       		$rows .= "\n\t" . '</tr>';
 		       		$rowCounter++;
        		}
        	} else {
        		$rows .= "\n\t" . '<tr class="odd">' . $cellbegin . '<em>' . tra('no parameters') . '</em></td>';
        	}
        	$header .= "\n\t" . '</tr>';
        	if (!empty($infoPlugin['prefs'])) {
        		$pluginprefs = '<em>' . tra('Preferences required:') . '</em> ' . implode(', ', $infoPlugin['prefs']). '<br/>';
        	} else {
        		$pluginprefs = '';
        	}
        	$sOutput = $title . '<em>' . tra('Required parameters are in</em> <b>bold</b>') . '<br />' . 
        				$pluginprefs . '<table class="normal">' . $header . $rows . '</table>' . "\n";
        	return $sOutput;
        }
    }
    function processDescription($sDescription) {
        $sDescription=str_replace(',',', ',$sDescription);
        $sDescription=str_replace('|','| ',$sDescription);
        $sDescription=strip_tags(wordwrap($sDescription,35));
        return $sDescription;
    }
}

function wikiplugin_pluginmanager_info() {
    return array(
    	'name' => tra('Plugin Manager'),
    	'documentation' => 'PluginPluginManager',
    	'description' => tra('List wiki plugin or module information for the site'),
    	'prefs' => array( 'wikiplugin_pluginmanager' ),
    	'introduced' => 3,
		'icon' => 'pics/icons/plugin_link.png',
    	'params' => array(
    		'info' => array(
    			'required' => false,
    			'name' => tra('Information'),
    			'description' => tra('Determines what information is shown. Values separated with | . Ignored when singletitle is set to top or none.'),
   				'filter' => 'striptags',
    			'accepted' => tra('One or more of: description | parameters | paraminfo'),
    			'default' => 'description | parameters | paraminfo ',
    			'since' => '',    
				'options' => array(
					array('text' => '', 'value' => ''), 
					array('text' => tra('Description'), 'value' => 'description'), 
					array('text' => tra('Description & Parameters'), 'value' => 'description|parameters'), 
					array('text' => tra('Description & Parameter Info'), 'value' => 'description|paraminfo'), 
					array('text' => tra('Parameters & Parameter Info'), 'value' => 'parameters|paraminfo'), 
					array('text' => tra('All'), 'value' => 'description|parameters|paraminfo')
				)
    		),
			'plugin' => array(
    			'required' => false,
    			'name' => tra('Plugin'),
    			'description' => tra('Name of a plugin (e.g., backlinks), or list separated by |, or range separated by "-". Single plugin can be used with limit parameter.'),
    			'filter' => 'striptags',
    			'default' => '',
    			'since' => '5.0',    				
    		),
			'module' => array(
    			'required' => false,
    			'name' => tra('Module'),
    			'description' => tra('Name of a module (e.g., calendar_new), or list separated by |, or range separated by "-". Single module can be used with limit parameter.'),
    			'filter' => 'striptags',
    			'default' => '',
    			'since' => '6.1',    				
    		),
    		'singletitle' => array(
    			'required' => false,
    			'name' => tra('Single Title'),
    			'description' => tra('Set placement of plugin name and description when displaying information for only one plugin'),
    			'filter' => 'alpha', 
    			'default' => 'none',
    			'since' => '5.0', 
    			'options' => array(
					array('text' => tra(''), 'value' => ''), 
    				array('text' => tra('Top'), 'value' => 'top'), 
					array('text' => tra('Table'), 'value' => 'table'), 
				),  				
    		),
    		'titletag' => array(
    			'required' => false,
    			'name' => tra('Title Heading'),
    			'description' => tra('Sets the heading size for the title, e.g., h2.'),
    			'filter' => 'striptags',
    			'default' => 'h3',
    			'since' => '5.0',    				
    		),
    		'start' => array(
    			'required' => false,
    			'name' => tra('Start'),
    			'description' => tra('Start with this plugin record number (must be an integer 1 or greater).'),
    			'filter' => 'digits',
    			'default' => '',
    			'since' => '5.0',    				
    		),
    		'limit' => array(
    			'required' => false,
    			'name' => tra('Limit'),
    			'description' => tra('Number of plugins to show. Can be used either with start or plugin as the starting point. Must be an integer 1 or greater.'),
    			'filter' => 'digits',
    			'default' => '',
    			'since' => '5.0',    				
    		),
    	),
    );
}

function get_plugin_info($sPluginFile) {
	preg_match("/wikiplugin_(.*)\.php/i", $sPluginFile, $match);
	global $sPlugin, $numparams;
	$sPlugin= $match[1];
	include_once(PLUGINS_DIR.'/'.$sPluginFile);
	global $tikilib;
	$infoPlugin = $tikilib->plugin_info($sPlugin);
	$numparams = isset($infoPlugin['params']) ? count($infoPlugin['params']) : 0;
	return $infoPlugin;
}

function get_module_params($sPluginFile) {
	preg_match("/mod-func-(.*)\.php/i", $sPluginFile, $match);
	global $sPlugin, $numparams;
	$sPlugin= $match[1];
	include_once('modules/' . $sPluginFile);
	$info_func = "module_{$sPlugin}_info";
	$infoPlugin = $info_func();
	$numparams = isset($infoPlugin['params']) ? count($infoPlugin['params']) : 0;
	return $infoPlugin;
}

function wikiplugin_pluginmanager($data, $params) {
    $plugin = new WikiPluginPluginManager();
    return $plugin->run($data, $params);
}