-<?php\r
- /*\r
- * Nucleus: PHP/MySQL Weblog CMS (http://nucleuscms.org/)\r
- * Copyright (C) 2002-2005 The Nucleus Group\r
- *\r
- * This program is free software; you can redistribute it and/or\r
- * modify it under the terms of the GNU General Public License\r
- * as published by the Free Software Foundation; either version 2\r
- * of the License, or (at your option) any later version.\r
- * (see nucleus/documentation/index.html#license for more info)\r
- */\r
- /**\r
- * This is an (abstract) class of which all Nucleus Plugins must inherit\r
- *\r
- * for more information on plugins and how to write your own, see the\r
- * plugins.html file that is included with the Nucleus documenation\r
- *\r
- * @license http://nucleuscms.org/license.txt GNU General Public License\r
- * @copyright Copyright (C) 2002-2005 The Nucleus Group\r
- * @version $Id: PLUGIN.php,v 1.4 2005-08-13 07:33:02 kimitake Exp $\r
- * $NucleusJP: PLUGIN.php,v 1.3 2005/03/12 06:19:05 kimitake Exp $\r
- */\r
- class NucleusPlugin {\r
-\r
- // these functions _have_ to be redefined in your plugin\r
-\r
- function getName() { return 'Undefined'; }\r
- function getAuthor() { return 'Undefined'; }\r
- function getURL() { return 'Undefined'; }\r
- function getVersion() { return '0.0'; }\r
- function getDescription() { return 'Undefined';}\r
-\r
- // these function _may_ be redefined in your plugin\r
-\r
- function getMinNucleusVersion() { return 150; }\r
- function getMinNucleusPatchLevel() { return 0; }\r
- function getEventList() { return array(); }\r
- function getTableList() { return array(); }\r
- function hasAdminArea() { return 0; }\r
-\r
- function install() {}\r
- function unInstall() {}\r
-\r
- function init() {}\r
-\r
- function doSkinVar($skinType) {}\r
- function doTemplateVar(&$item) {\r
- $args = func_get_args();\r
- array_shift($args);\r
- array_unshift($args, 'template');\r
- call_user_func_array(array(&$this,'doSkinVar'),$args);\r
- }\r
- function doTemplateCommentsVar(&$item, &$comment) {\r
- $args = func_get_args();\r
- array_shift($args);\r
- array_shift($args);\r
- array_unshift($args, 'template');\r
- call_user_func_array(array(&$this,'doSkinVar'),$args);\r
- }\r
- function doAction($type) { return 'No Such Action'; }\r
-\r
- /**\r
- * Checks if a plugin supports a certain feature.\r
- *\r
- * @returns 1 if the feature is reported, 0 if not\r
- * @param $feature\r
- * Name of the feature. See plugin documentation for more info\r
- * 'SqlTablePrefix' -> if the plugin uses the sql_table() method to get table names\r
- * 'HelpPage' -> if the plugin provides a helppage\r
- */\r
- function supportsFeature($feature) {\r
- return 0;\r
- }\r
-\r
- /**\r
- * Report a list of plugin that is required to function\r
- * \r
- * @returns an array of names of plugin, an empty array indicates no dependency\r
- */\r
- function getPluginDep() { return array(); }\r
-\r
- // these helper functions should not be redefined in your plugin\r
-\r
- /**\r
- * Creates a new option for this plugin\r
- *\r
- * @param name\r
- * A string uniquely identifying your option. (max. length is 20 characters)\r
- * @param description\r
- * A description that will show up in the nucleus admin area (max. length: 255 characters)\r
- * @param type\r
- * Either 'text', 'yesno' or 'password'\r
- * This info is used when showing 'edit plugin options' screens\r
- * @param value\r
- * Initial value for the option (max. value length is 128 characters)\r
- */\r
- function createOption($name, $desc, $type, $defValue = '', $typeExtras = '') {\r
- return $this->_createOption('global', $name, $desc, $type, $defValue, $typeExtras);\r
- }\r
- function createBlogOption($name, $desc, $type, $defValue = '', $typeExtras = '') {\r
- return $this->_createOption('blog', $name, $desc, $type, $defValue, $typeExtras);\r
- }\r
- function createMemberOption($name, $desc, $type, $defValue = '', $typeExtras = '') {\r
- return $this->_createOption('member', $name, $desc, $type, $defValue, $typeExtras);\r
- }\r
- function createCategoryOption($name, $desc, $type, $defValue = '', $typeExtras = '') {\r
- return $this->_createOption('category', $name, $desc, $type, $defValue, $typeExtras);\r
- }\r
- function createItemOption($name, $desc, $type, $defValue = '', $typeExtras = '') {\r
- return $this->_createOption('item', $name, $desc, $type, $defValue, $typeExtras);\r
- }\r
-\r
- /**\r
- * Removes the option from the database\r
- *\r
- * Note: Options get erased automatically on plugin uninstall\r
- */\r
- function deleteOption($name) {\r
- return $this->_deleteOption('global', $name);\r
- }\r
- function deleteBlogOption($name) {\r
- return $this->_deleteOption('blog', $name);\r
- }\r
- function deleteMemberOption($name) {\r
- return $this->_deleteOption('member', $name);\r
- }\r
- function deleteCategoryOption($name) {\r
- return $this->_deleteOption('category', $name);\r
- }\r
- function deleteItemOption($name) {\r
- return $this->_deleteOption('item', $name);\r
- }\r
-\r
- /**\r
- * Sets the value of an option to something new\r
- */\r
- function setOption($name, $value) {\r
- return $this->_setOption('global', 0, $name, $value);\r
- }\r
- function setBlogOption($blogid, $name, $value) {\r
- return $this->_setOption('blog', $blogid, $name, $value);\r
- }\r
- function setMemberOption($memberid, $name, $value) {\r
- return $this->_setOption('member', $memberid, $name, $value);\r
- }\r
- function setCategoryOption($catid, $name, $value) {\r
- return $this->_setOption('category', $catid, $name, $value);\r
- }\r
- function setItemOption($itemid, $name, $value) {\r
- return $this->_setOption('item', $itemid, $name, $value);\r
- }\r
-\r
- /**\r
- * Retrieves the current value for an option\r
- */\r
- function getOption($name)\r
- {\r
- // only request the options the very first time. On subsequent requests\r
- // the static collection is used to save SQL queries.\r
- if ($this->plugin_options == 0)\r
- {\r
- $this->plugin_options = array(); \r
- $query = mysql_query(\r
- 'SELECT d.oname as name, o.ovalue as value '.\r
- 'FROM '.\r
- sql_table('plugin_option').' o, '.\r
- sql_table('plugin_option_desc').' d '.\r
- 'WHERE d.opid='. intval($this->getID()).' AND d.oid=o.oid'\r
- );\r
- while ($row = mysql_fetch_object($query))\r
- $this->plugin_options[strtolower($row->name)] = $row->value;\r
- }\r
- if (isset($this->plugin_options[strtolower($name)]))\r
- return $this->plugin_options[strtolower($name)];\r
- else\r
- return $this->_getOption('global', 0, $name);\r
- } \r
-\r
- function getBlogOption($blogid, $name) {\r
- return $this->_getOption('blog', $blogid, $name);\r
- }\r
- function getMemberOption($memberid, $name) {\r
- return $this->_getOption('member', $memberid, $name);\r
- }\r
- function getCategoryOption($catid, $name) {\r
- return $this->_getOption('category', $catid, $name);\r
- }\r
- function getItemOption($itemid, $name) {\r
- return $this->_getOption('item', $itemid, $name);\r
- }\r
-\r
- /**\r
- * Retrieves an associative array with the option value for each\r
- * context id\r
- */\r
- function getAllBlogOptions($name) {\r
- return $this->_getAllOptions('blog', $name);\r
- }\r
- function getAllMemberOptions($name) {\r
- return $this->_getAllOptions('member', $name);\r
- }\r
- function getAllCategoryOptions($name) {\r
- return $this->_getAllOptions('category', $name);\r
- }\r
- function getAllItemOptions($name) {\r
- return $this->_getAllOptions('item', $name);\r
- }\r
- \r
- /**\r
- * Retrieves an indexed array with the top (or bottom) of an option\r
- * (delegates to _getOptionTop())\r
- */\r
- function getBlogOptionTop($name, $amount = 10, $sort = 'desc') {\r
- return $this->_getOptionTop('blog', $name, $amount, $sort);\r
- }\r
- function getMemberOptionTop($name, $amount = 10, $sort = 'desc') {\r
- return $this->_getOptionTop('member', $name, $amount, $sort);\r
- }\r
- function getCategoryOptionTop($name, $amount = 10, $sort = 'desc') {\r
- return $this->_getOptionTop('category', $name, $amount, $sort);\r
- }\r
- function getItemOptionTop($name, $amount = 10, $sort = 'desc') {\r
- return $this->_getOptionTop('item', $name, $amount, $sort);\r
- }\r
- \r
- /**\r
- * Retrieves an array of the top (or bottom) of an option from a plugin.\r
- * @author TeRanEX\r
- * @param string $context the context for the option: item, blog, member,...\r
- * @param string $name the name of the option\r
- * @param int $amount how many rows must be returned\r
- * @param string $sort desc or asc\r
- * @return array array with both values and contextid's\r
- * @access private\r
- */\r
- function _getOptionTop($context, $name, $amount = 10, $sort = 'desc') {\r
- if (($sort != 'desc') && ($sort != 'asc')) {\r
- $sort= 'desc';\r
- }\r
-\r
- $oid = $this->_getOID($context, $name);\r
-\r
- // retrieve the data and return\r
- $q = 'SELECT otype, oextra FROM '.sql_table('plugin_option_desc').' WHERE oid = '.$oid;\r
- $query = mysql_query($q);\r
-\r
- $o = mysql_fetch_array($query);\r
-\r
- if (($this->optionCanBeNumeric($o['otype'])) && ($o['oextra'] == 'number' )) {\r
- $orderby = 'CAST(ovalue AS SIGNED)';\r
- } else {\r
- $orderby = 'ovalue';\r
- }\r
- $q = 'SELECT ovalue value, ocontextid id FROM '.sql_table('plugin_option').' WHERE oid = '.$oid.' ORDER BY '.$orderby.' '.$sort.' LIMIT 0,'.$amount;\r
- $query = mysql_query($q);\r
- \r
- // create the array\r
- $i = 0;\r
- $top = array();\r
- while($row = mysql_fetch_array($query)) {\r
- $top[$i++] = $row;\r
- }\r
- \r
- // return the array (duh!)\r
- return $top;\r
- }\r
-\r
- /**\r
- * Returns the plugin ID\r
- */\r
- function getID() {\r
- return $this->plugid;\r
- }\r
-\r
- /**\r
- * returns the URL of the admin area for this plugin (in case there's\r
- * no such area, the returned information is invalid)\r
- */\r
- function getAdminURL() {\r
- global $CONF;\r
- return $CONF['PluginURL'] . $this->getShortName() . '/';\r
- }\r
-\r
- /**\r
- * Returns the directory where the admin directory is located and\r
- * where the plugin can maintain his extra files\r
- */\r
- function getDirectory() {\r
- global $DIR_PLUGINS;\r
- return $DIR_PLUGINS . $this->getShortName() . '/';\r
- }\r
-\r
- /**\r
- * Derives the short name for the plugin from the classname (all lowercase)\r
- */\r
- function getShortName() {\r
- return str_replace('np_','',strtolower(get_class($this)));\r
- }\r
-\r
- var $_aOptionValues; // oid_contextid => value\r
- var $_aOptionToInfo; // context_name => array('oid' => ..., 'default' => ...)\r
- var $plugin_options; // see getOption()\r
- var $plugid; // plugin id\r
-\r
-\r
- // constructor. Initializes some internal data\r
- function NucleusPlugin() {\r
- $this->_aOptionValues = array(); // oid_contextid => value\r
- $this->_aOptionToInfo = array(); // context_name => array('oid' => ..., 'default' => ...)\r
- $this->plugin_options = 0;\r
- }\r
-\r
- // private\r
- function _createOption($context, $name, $desc, $type, $defValue, $typeExtras = '') {\r
- // create in plugin_option_desc\r
- $query = 'INSERT INTO ' . sql_table('plugin_option_desc')\r
- .' (opid, oname, ocontext, odesc, otype, odef, oextra)'\r
- .' VALUES ('.intval($this->plugid)\r
- .', \''.addslashes($name).'\''\r
- .', \''.addslashes($context).'\''\r
- .', \''.addslashes($desc).'\''\r
- .', \''.addslashes($type).'\''\r
- .', \''.addslashes($defValue).'\''\r
- .', \''.addslashes($typeExtras).'\')';\r
- sql_query($query);\r
- $oid = mysql_insert_id();\r
-\r
- $key = $context . '_' . $name;\r
- $this->_aOptionToInfo[$key] = array('oid' => $oid, 'default' => $defValue);\r
- return 1;\r
- }\r
-\r
-\r
- // private\r
- function _deleteOption($context, $name) {\r
- $oid = $this->_getOID($context, $name);\r
- if (!$oid) return 0; // no such option\r
-\r
- // delete all things from plugin_option\r
- sql_query('DELETE FROM ' . sql_table('plugin_option') . ' WHERE oid=' . $oid);\r
-\r
- // delete entry from plugin_option_desc\r
- sql_query('DELETE FROM ' . sql_table('plugin_option_desc') . ' WHERE oid=' . $oid);\r
-\r
- // clear from cache\r
- unset($this->_aOptionToInfo[$context . '_' . $name]);\r
- $this->_aOptionValues = array();\r
- return 1;\r
- }\r
-\r
- /**\r
- * private\r
- * returns: 1 on success, 0 on failure\r
- */\r
- function _setOption($context, $contextid, $name, $value) {\r
- global $manager;\r
-\r
- $oid = $this->_getOID($context, $name);\r
- if (!$oid) return 0;\r
-\r
- // check if context id exists\r
- switch ($context) {\r
- case 'member':\r
- if (!MEMBER::existsID($contextid)) return 0;\r
- break;\r
- case 'blog':\r
- if (!$manager->existsBlogID($contextid)) return 0;\r
- break;\r
- case 'category':\r
- if (!$manager->existsCategory($contextid)) return 0;\r
- break;\r
- case 'item':\r
- if (!$manager->existsItem($contextid, true, true)) return 0;\r
- break;\r
- case 'global':\r
- if ($contextid != 0) return 0;\r
- break;\r
- }\r
-\r
-\r
- // update plugin_option\r
- sql_query('DELETE FROM ' . sql_table('plugin_option') . ' WHERE oid='.intval($oid) . ' and ocontextid='. intval($contextid));\r
- sql_query('INSERT INTO ' . sql_table('plugin_option') . ' (ovalue, oid, ocontextid) VALUES (\''.addslashes($value).'\', '. intval($oid) . ', ' . intval($contextid) . ')');\r
-\r
- // update cache\r
- $this->_aOptionValues[$oid . '_' . $contextid] = $value;\r
-\r
- return 1;\r
- }\r
-\r
- // private\r
- function _getOption($context, $contextid, $name) {\r
- $oid = $this->_getOID($context, $name);\r
- if (!$oid) return '';\r
-\r
-\r
- $key = $oid . '_' . $contextid;\r
-\r
- if (isset($this->_aOptionValues[$key]))\r
- return $this->_aOptionValues[$key];\r
-\r
- // get from DB\r
- $res = sql_query('SELECT ovalue FROM ' . sql_table('plugin_option') . ' WHERE oid='.intval($oid).' and ocontextid=' . intval($contextid));\r
-\r
- if (!$res || (mysql_num_rows($res) == 0)) {\r
- $defVal = $this->_getDefVal($context, $name);\r
- $this->_aOptionValues[$key] = $defVal;\r
-\r
- // fill DB with default value\r
- $query = 'INSERT INTO ' . sql_table('plugin_option') . ' (oid,ocontextid,ovalue)'\r
- .' VALUES ('.intval($oid).', '.intval($contextid).', \''.addslashes($defVal).'\')';\r
- sql_query($query);\r
- }\r
- else {\r
- $o = mysql_fetch_object($res);\r
- $this->_aOptionValues[$key] = $o->ovalue;\r
- }\r
-\r
- return $this->_aOptionValues[$key];\r
- }\r
-\r
- /**\r
- * Returns assoc array with all values for a given option (one option per\r
- * possible context id)\r
- */\r
- function _getAllOptions($context, $name) {\r
- $oid = $this->_getOID($context, $name);\r
- if (!$oid) return array();\r
- $defVal = $this->_getDefVal($context, $name);\r
-\r
- $aOptions = array();\r
- switch ($context) {\r
- case 'blog':\r
- $r = sql_query('SELECT bnumber as contextid FROM ' . sql_table('blog'));\r
- break;\r
- case 'category':\r
- $r = sql_query('SELECT catid as contextid FROM ' . sql_table('category'));\r
- break;\r
- case 'member':\r
- $r = sql_query('SELECT mnumber as contextid FROM ' . sql_table('member'));\r
- break;\r
- }\r
- if ($r) {\r
- while ($o = mysql_fetch_object($r))\r
- $aOptions[$o->contextid] = $defVal;\r
- }\r
-\r
- $res = sql_query('SELECT ocontextid, ovalue FROM ' . sql_table('plugin_option') . ' WHERE oid=' . $oid);\r
- while ($o = mysql_fetch_object($res))\r
- $aOptions[$o->ocontextid] = $o->ovalue;\r
-\r
- return $aOptions;\r
- }\r
-\r
- /**\r
- * Gets the 'option identifier' that corresponds to a given option name.\r
- * When this method is called for the first time, all the OIDs for the plugin\r
- * are loaded into memory, to avoid re-doing the same query all over.\r
- */\r
- function _getOID($context, $name) {\r
- $key = $context . '_' . $name;\r
- $info = $this->_aOptionToInfo[$key];\r
- if (is_array($info)) return $info['oid'];\r
-\r
- // load all OIDs for this plugin from the database\r
- $this->_aOptionToInfo = array();\r
- $query = 'SELECT oid, oname, ocontext, odef FROM ' . sql_table('plugin_option_desc') . ' WHERE opid=' . intval($this->plugid);\r
- $res = sql_query($query);\r
- while ($o = mysql_fetch_object($res)) {\r
- $k = $o->ocontext . '_' . $o->oname;\r
- $this->_aOptionToInfo[$k] = array('oid' => $o->oid, 'default' => $o->odef);\r
- }\r
- mysql_free_result($res);\r
-\r
- return $this->_aOptionToInfo[$key]['oid'];\r
- }\r
- function _getDefVal($context, $name) {\r
- $key = $context . '_' . $name;\r
- $info = $this->_aOptionToInfo[$key];\r
- if (is_array($info)) return $info['default'];\r
- }\r
-\r
-\r
- /**\r
- * Deletes all option values for a given context and contextid\r
- * (used when e.g. a blog, member or category is deleted)\r
- *\r
- * (static method)\r
- */\r
- function _deleteOptionValues($context, $contextid) {\r
- // delete all associated plugin options\r
- $aOIDs = array();\r
- // find ids\r
- $query = 'SELECT oid FROM '.sql_table('plugin_option_desc') . ' WHERE ocontext=\''.addslashes($context).'\'';\r
- $res = sql_query($query);\r
- while ($o = mysql_fetch_object($res))\r
- array_push($aOIDs, $o->oid);\r
- mysql_free_result($res);\r
- // delete those options. go go go\r
- if (count($aOIDs) > 0) {\r
- $query = 'DELETE FROM ' . sql_table('plugin_option') . ' WHERE oid in ('.implode(',',$aOIDs).') and ocontextid=' . intval($contextid);\r
- sql_query($query);\r
- }\r
- }\r
-\r
- /**\r
- * splits the option's typeextra field (at ;'s) to split the meta collection\r
- * @param string $typeExtra the value of the typeExtra field of an option\r
- * @return array array of the meta-key/value-pairs\r
- * @author TeRanEX\r
- * @static\r
- */\r
- function getOptionMeta($typeExtra) {\r
- $tmpMeta = explode(';', $typeExtra);\r
- $meta = array();\r
- for ($i = 0; $i < count($tmpMeta); $i++) {\r
- if (($i == 0) && (!strstr($tmpMeta[0], '='))) {\r
- // we have the select-list\r
- $meta['select'] = $tmpMeta[0];\r
- } else {\r
- $tmp = explode('=', $tmpMeta[$i]);\r
- $meta[$tmp[0]] = $tmp[1];\r
- }\r
- }\r
- return $meta;\r
- }\r
-\r
- /**\r
- * filters the selectlists out of the meta collection\r
- * @param string $typeExtra the value of the typeExtra field of an option\r
- * @return string the selectlist\r
- * @author TeRanEX\r
- */\r
- function getOptionSelectValues($typeExtra) {\r
- $meta = NucleusPlugin::getOptionMeta($typeExtra);\r
- //the select list must always be the first part\r
- return $meta['select'];\r
- }\r
- \r
- /**\r
- * checks if the eventlist in the database is up-to-date\r
- * @return bool if it is up-to-date it return true, else false\r
- * @author TeRanEX\r
- */\r
- function subscribtionListIsUptodate() {\r
- $res = sql_query('SELECT event FROM '.sql_table('plugin_event').' WHERE pid = '.$this->getID());\r
- $ev = array();\r
- while($a = mysql_fetch_array($res)) {\r
- array_push($ev, $a['event']);\r
- }\r
- if (count($ev) != count($this->getEventList())) {\r
- return false;\r
- }\r
- $d = array_diff($ev, $this->getEventList());\r
- if (count($d) > 0) {\r
- // there are differences so the db is not up-to-date\r
- return false;\r
- }\r
- return true;\r
- }\r
- \r
- /**\r
- * @param $aOptions: array ( 'oid' => array( 'contextid' => 'value'))\r
- * (taken from request using requestVar())\r
- * @param $newContextid: integer (accepts a contextid when it is for a new \r
- * contextid there was no id available at the moment of writing the\r
- * formcontrols into the page (by ex: itemOptions for new item)\r
- * @static \r
- */\r
- function _applyPluginOptions(&$aOptions, $newContextid = 0) {\r
- global $manager;\r
- if (!is_array($aOptions)) return;\r
-\r
- foreach ($aOptions as $oid => $values) {\r
-\r
- // get option type info\r
- $query = 'SELECT opid, oname, ocontext, otype, oextra, odef FROM ' . sql_table('plugin_option_desc') . ' WHERE oid=' . intval($oid);\r
- $res = sql_query($query);\r
- if ($o = mysql_fetch_object($res))\r
- {\r
- foreach ($values as $contextid => $value) {\r
- // retreive any metadata\r
- $meta = NucleusPlugin::getOptionMeta($o->oextra);\r
- \r
- // if the option is readonly or hidden it may not be saved\r
- if (($meta['access'] != 'readonly') && ($meta['access'] != 'hidden')) {\r
- \r
- $value = undoMagic($value); // value comes from request\r
- \r
- switch($o->otype) {\r
- case 'yesno':\r
- if (($value != 'yes') && ($value != 'no')) $value = 'no';\r
- break;\r
- default:\r
- break;\r
- }\r
- \r
- // check the validity of numerical options\r
- if (($meta['datatype'] == 'numerical') && (!is_numeric($value))) { \r
- //the option must be numeric, but the it isn't\r
- //use the default for this option\r
- $value = $o->odef;\r
- }\r
- \r
- // decide wether we are using the contextid of newContextid\r
- if ($newContextid != 0) {\r
- $contextid = $newContextid;\r
- }\r
- \r
- //trigger event PrePluginOptionsUpdate to give the plugin the\r
- //possibility to change/validate the new value for the option\r
- $manager->notify('PrePluginOptionsUpdate',array('context' => $o->ocontext, 'plugid' => $o->opid, 'optionname' => $o->oname, 'contextid' => $contextid, 'value' => &$value));\r
- \r
- // delete the old value for the option\r
- sql_query('DELETE FROM '.sql_table('plugin_option').' WHERE oid='.intval($oid).' AND ocontextid='.intval($contextid));\r
- sql_query('INSERT INTO '.sql_table('plugin_option')." (oid, ocontextid, ovalue) VALUES (".intval($oid).",".intval($contextid).",'" . addslashes($value) . "')");\r
- }\r
- }\r
- }\r
- }\r
- }\r
- \r
- }\r
-?>\r
+<?php
+ /*
+ * Nucleus: PHP/MySQL Weblog CMS (http://nucleuscms.org/)
+ * Copyright (C) 2002-2007 The Nucleus Group
+ *
+ * This program 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; either version 2
+ * of the License, or (at your option) any later version.
+ * (see nucleus/documentation/index.html#license for more info)
+ */
+ /**
+ * This is an (abstract) class of which all Nucleus Plugins must inherit
+ *
+ * for more information on plugins and how to write your own, see the
+ * plugins.html file that is included with the Nucleus documenation
+ *
+ * @license http://nucleuscms.org/license.txt GNU General Public License
+ * @copyright Copyright (C) 2002-2007 The Nucleus Group
+ * @version $Id: PLUGIN.php,v 1.13 2008-02-08 09:31:22 kimitake Exp $
+ * $NucleusJP: PLUGIN.php,v 1.12.2.3 2007/12/03 02:22:42 kmorimatsu Exp $
+ */
+ class NucleusPlugin {
+
+ // these functions _have_ to be redefined in your plugin
+
+ function getName() { return 'Undefined'; }
+ function getAuthor() { return 'Undefined'; }
+ function getURL() { return 'Undefined'; }
+ function getVersion() { return '0.0'; }
+ function getDescription() { return 'Undefined';}
+
+ // these function _may_ be redefined in your plugin
+
+ function getMinNucleusVersion() { return 150; }
+ function getMinNucleusPatchLevel() { return 0; }
+ function getEventList() { return array(); }
+ function getTableList() { return array(); }
+ function hasAdminArea() { return 0; }
+
+ function install() {}
+ function unInstall() {}
+
+ function init() {}
+
+ function doSkinVar($skinType) {}
+ function doTemplateVar(&$item) {
+ $args = func_get_args();
+ array_shift($args);
+ array_unshift($args, 'template');
+ call_user_func_array(array(&$this,'doSkinVar'),$args);
+ }
+ function doTemplateCommentsVar(&$item, &$comment) {
+ $args = func_get_args();
+ array_shift($args);
+ array_shift($args);
+ array_unshift($args, 'template');
+ call_user_func_array(array(&$this,'doSkinVar'),$args);
+ }
+ function doAction($type) { return 'No Such Action'; }
+ function doIf($key,$value) { return false; }
+ function doItemVar () {}
+
+ /**
+ * Checks if a plugin supports a certain feature.
+ *
+ * @returns 1 if the feature is reported, 0 if not
+ * @param $feature
+ * Name of the feature. See plugin documentation for more info
+ * 'SqlTablePrefix' -> if the plugin uses the sql_table() method to get table names
+ * 'HelpPage' -> if the plugin provides a helppage
+ */
+ function supportsFeature($feature) {
+ return 0;
+ }
+
+ /**
+ * Report a list of plugin that is required to function
+ *
+ * @returns an array of names of plugin, an empty array indicates no dependency
+ */
+ function getPluginDep() { return array(); }
+
+ // these helper functions should not be redefined in your plugin
+
+ /**
+ * Creates a new option for this plugin
+ *
+ * @param name
+ * A string uniquely identifying your option. (max. length is 20 characters)
+ * @param description
+ * A description that will show up in the nucleus admin area (max. length: 255 characters)
+ * @param type
+ * Either 'text', 'yesno' or 'password'
+ * This info is used when showing 'edit plugin options' screens
+ * @param value
+ * Initial value for the option (max. value length is 128 characters)
+ */
+ function createOption($name, $desc, $type, $defValue = '', $typeExtras = '') {
+ return $this->_createOption('global', $name, $desc, $type, $defValue, $typeExtras);
+ }
+ function createBlogOption($name, $desc, $type, $defValue = '', $typeExtras = '') {
+ return $this->_createOption('blog', $name, $desc, $type, $defValue, $typeExtras);
+ }
+ function createMemberOption($name, $desc, $type, $defValue = '', $typeExtras = '') {
+ return $this->_createOption('member', $name, $desc, $type, $defValue, $typeExtras);
+ }
+ function createCategoryOption($name, $desc, $type, $defValue = '', $typeExtras = '') {
+ return $this->_createOption('category', $name, $desc, $type, $defValue, $typeExtras);
+ }
+ function createItemOption($name, $desc, $type, $defValue = '', $typeExtras = '') {
+ return $this->_createOption('item', $name, $desc, $type, $defValue, $typeExtras);
+ }
+
+ /**
+ * Removes the option from the database
+ *
+ * Note: Options get erased automatically on plugin uninstall
+ */
+ function deleteOption($name) {
+ return $this->_deleteOption('global', $name);
+ }
+ function deleteBlogOption($name) {
+ return $this->_deleteOption('blog', $name);
+ }
+ function deleteMemberOption($name) {
+ return $this->_deleteOption('member', $name);
+ }
+ function deleteCategoryOption($name) {
+ return $this->_deleteOption('category', $name);
+ }
+ function deleteItemOption($name) {
+ return $this->_deleteOption('item', $name);
+ }
+
+ /**
+ * Sets the value of an option to something new
+ */
+ function setOption($name, $value) {
+ return $this->_setOption('global', 0, $name, $value);
+ }
+ function setBlogOption($blogid, $name, $value) {
+ return $this->_setOption('blog', $blogid, $name, $value);
+ }
+ function setMemberOption($memberid, $name, $value) {
+ return $this->_setOption('member', $memberid, $name, $value);
+ }
+ function setCategoryOption($catid, $name, $value) {
+ return $this->_setOption('category', $catid, $name, $value);
+ }
+ function setItemOption($itemid, $name, $value) {
+ return $this->_setOption('item', $itemid, $name, $value);
+ }
+
+ /**
+ * Retrieves the current value for an option
+ */
+ function getOption($name)
+ {
+ // only request the options the very first time. On subsequent requests
+ // the static collection is used to save SQL queries.
+ if ($this->plugin_options == 0)
+ {
+ $this->plugin_options = array();
+ $query = sql_query(
+ 'SELECT d.oname as name, o.ovalue as value '.
+ 'FROM '.
+ sql_table('plugin_option').' o, '.
+ sql_table('plugin_option_desc').' d '.
+ 'WHERE d.opid='. intval($this->getID()).' AND d.oid=o.oid'
+ );
+ while ($row = mysql_fetch_object($query))
+ $this->plugin_options[strtolower($row->name)] = $row->value;
+ }
+ if (isset($this->plugin_options[strtolower($name)]))
+ return $this->plugin_options[strtolower($name)];
+ else
+ return $this->_getOption('global', 0, $name);
+ }
+
+ function getBlogOption($blogid, $name) {
+ return $this->_getOption('blog', $blogid, $name);
+ }
+ function getMemberOption($memberid, $name) {
+ return $this->_getOption('member', $memberid, $name);
+ }
+ function getCategoryOption($catid, $name) {
+ return $this->_getOption('category', $catid, $name);
+ }
+ function getItemOption($itemid, $name) {
+ return $this->_getOption('item', $itemid, $name);
+ }
+
+ /**
+ * Retrieves an associative array with the option value for each
+ * context id
+ */
+ function getAllBlogOptions($name) {
+ return $this->_getAllOptions('blog', $name);
+ }
+ function getAllMemberOptions($name) {
+ return $this->_getAllOptions('member', $name);
+ }
+ function getAllCategoryOptions($name) {
+ return $this->_getAllOptions('category', $name);
+ }
+ function getAllItemOptions($name) {
+ return $this->_getAllOptions('item', $name);
+ }
+
+ /**
+ * Retrieves an indexed array with the top (or bottom) of an option
+ * (delegates to _getOptionTop())
+ */
+ function getBlogOptionTop($name, $amount = 10, $sort = 'desc') {
+ return $this->_getOptionTop('blog', $name, $amount, $sort);
+ }
+ function getMemberOptionTop($name, $amount = 10, $sort = 'desc') {
+ return $this->_getOptionTop('member', $name, $amount, $sort);
+ }
+ function getCategoryOptionTop($name, $amount = 10, $sort = 'desc') {
+ return $this->_getOptionTop('category', $name, $amount, $sort);
+ }
+ function getItemOptionTop($name, $amount = 10, $sort = 'desc') {
+ return $this->_getOptionTop('item', $name, $amount, $sort);
+ }
+
+ /**
+ * Retrieves an array of the top (or bottom) of an option from a plugin.
+ * @author TeRanEX
+ * @param string $context the context for the option: item, blog, member,...
+ * @param string $name the name of the option
+ * @param int $amount how many rows must be returned
+ * @param string $sort desc or asc
+ * @return array array with both values and contextid's
+ * @access private
+ */
+ function _getOptionTop($context, $name, $amount = 10, $sort = 'desc') {
+ if (($sort != 'desc') && ($sort != 'asc')) {
+ $sort= 'desc';
+ }
+
+ $oid = $this->_getOID($context, $name);
+
+ // retrieve the data and return
+ $q = 'SELECT otype, oextra FROM '.sql_table('plugin_option_desc').' WHERE oid = '.$oid;
+ $query = sql_query($q);
+
+ $o = mysql_fetch_array($query);
+
+ if (($this->optionCanBeNumeric($o['otype'])) && ($o['oextra'] == 'number' )) {
+ $orderby = 'CAST(ovalue AS SIGNED)';
+ } else {
+ $orderby = 'ovalue';
+ }
+ $q = 'SELECT ovalue value, ocontextid id FROM '.sql_table('plugin_option').' WHERE oid = '.$oid.' ORDER BY '.$orderby.' '.$sort.' LIMIT 0,'.intval($amount);
+ $query = sql_query($q);
+
+ // create the array
+ $i = 0;
+ $top = array();
+ while($row = mysql_fetch_array($query)) {
+ $top[$i++] = $row;
+ }
+
+ // return the array (duh!)
+ return $top;
+ }
+
+ /**
+ * Returns the plugin ID
+ */
+ function getID() {
+ return $this->plugid;
+ }
+
+ /**
+ * returns the URL of the admin area for this plugin (in case there's
+ * no such area, the returned information is invalid)
+ */
+ function getAdminURL() {
+ global $CONF;
+ return $CONF['PluginURL'] . $this->getShortName() . '/';
+ }
+
+ /**
+ * Returns the directory where the admin directory is located and
+ * where the plugin can maintain his extra files
+ */
+ function getDirectory() {
+ global $DIR_PLUGINS;
+ return $DIR_PLUGINS . $this->getShortName() . '/';
+ }
+
+ /**
+ * Derives the short name for the plugin from the classname (all lowercase)
+ */
+ function getShortName() {
+ return str_replace('np_','',strtolower(get_class($this)));
+ }
+
+ var $_aOptionValues; // oid_contextid => value
+ var $_aOptionToInfo; // context_name => array('oid' => ..., 'default' => ...)
+ var $plugin_options; // see getOption()
+ var $plugid; // plugin id
+
+
+ // constructor. Initializes some internal data
+ function NucleusPlugin() {
+ $this->_aOptionValues = array(); // oid_contextid => value
+ $this->_aOptionToInfo = array(); // context_name => array('oid' => ..., 'default' => ...)
+ $this->plugin_options = 0;
+ }
+
+ function clearOptionValueCache(){
+ $this->_aOptionValues = array();
+ }
+
+ // private
+ function _createOption($context, $name, $desc, $type, $defValue, $typeExtras = '') {
+ // create in plugin_option_desc
+ $query = 'INSERT INTO ' . sql_table('plugin_option_desc')
+ .' (opid, oname, ocontext, odesc, otype, odef, oextra)'
+ .' VALUES ('.intval($this->plugid)
+ .', \''.addslashes($name).'\''
+ .', \''.addslashes($context).'\''
+ .', \''.addslashes($desc).'\''
+ .', \''.addslashes($type).'\''
+ .', \''.addslashes($defValue).'\''
+ .', \''.addslashes($typeExtras).'\')';
+ sql_query($query);
+ $oid = mysql_insert_id();
+
+ $key = $context . '_' . $name;
+ $this->_aOptionToInfo[$key] = array('oid' => $oid, 'default' => $defValue);
+ return 1;
+ }
+
+
+ // private
+ function _deleteOption($context, $name) {
+ $oid = $this->_getOID($context, $name);
+ if (!$oid) return 0; // no such option
+
+ // delete all things from plugin_option
+ sql_query('DELETE FROM ' . sql_table('plugin_option') . ' WHERE oid=' . $oid);
+
+ // delete entry from plugin_option_desc
+ sql_query('DELETE FROM ' . sql_table('plugin_option_desc') . ' WHERE oid=' . $oid);
+
+ // clear from cache
+ unset($this->_aOptionToInfo[$context . '_' . $name]);
+ $this->_aOptionValues = array();
+ return 1;
+ }
+
+ /**
+ * private
+ * returns: 1 on success, 0 on failure
+ */
+ function _setOption($context, $contextid, $name, $value) {
+ global $manager;
+
+ $oid = $this->_getOID($context, $name);
+ if (!$oid) return 0;
+
+ // check if context id exists
+ switch ($context) {
+ case 'member':
+ if (!MEMBER::existsID($contextid)) return 0;
+ break;
+ case 'blog':
+ if (!$manager->existsBlogID($contextid)) return 0;
+ break;
+ case 'category':
+ if (!$manager->existsCategory($contextid)) return 0;
+ break;
+ case 'item':
+ if (!$manager->existsItem($contextid, true, true)) return 0;
+ break;
+ case 'global':
+ if ($contextid != 0) return 0;
+ break;
+ }
+
+
+ // update plugin_option
+ sql_query('DELETE FROM ' . sql_table('plugin_option') . ' WHERE oid='.intval($oid) . ' and ocontextid='. intval($contextid));
+ sql_query('INSERT INTO ' . sql_table('plugin_option') . ' (ovalue, oid, ocontextid) VALUES (\''.addslashes($value).'\', '. intval($oid) . ', ' . intval($contextid) . ')');
+
+ // update cache
+ $this->_aOptionValues[$oid . '_' . $contextid] = $value;
+
+ return 1;
+ }
+
+ // private
+ function _getOption($context, $contextid, $name) {
+ $oid = $this->_getOID($context, $name);
+ if (!$oid) return '';
+
+
+ $key = $oid . '_' . $contextid;
+
+ if (isset($this->_aOptionValues[$key]))
+ return $this->_aOptionValues[$key];
+
+ // get from DB
+ $res = sql_query('SELECT ovalue FROM ' . sql_table('plugin_option') . ' WHERE oid='.intval($oid).' and ocontextid=' . intval($contextid));
+
+ if (!$res || (mysql_num_rows($res) == 0)) {
+ $defVal = $this->_getDefVal($context, $name);
+ $this->_aOptionValues[$key] = $defVal;
+
+ // fill DB with default value
+ $query = 'INSERT INTO ' . sql_table('plugin_option') . ' (oid,ocontextid,ovalue)'
+ .' VALUES ('.intval($oid).', '.intval($contextid).', \''.addslashes($defVal).'\')';
+ sql_query($query);
+ }
+ else {
+ $o = mysql_fetch_object($res);
+ $this->_aOptionValues[$key] = $o->ovalue;
+ }
+
+ return $this->_aOptionValues[$key];
+ }
+
+ /**
+ * Returns assoc array with all values for a given option (one option per
+ * possible context id)
+ */
+ function _getAllOptions($context, $name) {
+ $oid = $this->_getOID($context, $name);
+ if (!$oid) return array();
+ $defVal = $this->_getDefVal($context, $name);
+
+ $aOptions = array();
+ switch ($context) {
+ case 'blog':
+ $r = sql_query('SELECT bnumber as contextid FROM ' . sql_table('blog'));
+ break;
+ case 'category':
+ $r = sql_query('SELECT catid as contextid FROM ' . sql_table('category'));
+ break;
+ case 'member':
+ $r = sql_query('SELECT mnumber as contextid FROM ' . sql_table('member'));
+ break;
+ case 'item':
+ $r = sql_query('SELECT inumber as contextid FROM ' . sql_table('item'));
+ break;
+ }
+ if ($r) {
+ while ($o = mysql_fetch_object($r))
+ $aOptions[$o->contextid] = $defVal;
+ }
+
+ $res = sql_query('SELECT ocontextid, ovalue FROM ' . sql_table('plugin_option') . ' WHERE oid=' . $oid);
+ while ($o = mysql_fetch_object($res))
+ $aOptions[$o->ocontextid] = $o->ovalue;
+
+ return $aOptions;
+ }
+
+ /**
+ * Gets the 'option identifier' that corresponds to a given option name.
+ * When this method is called for the first time, all the OIDs for the plugin
+ * are loaded into memory, to avoid re-doing the same query all over.
+ */
+ function _getOID($context, $name) {
+ $key = $context . '_' . $name;
+ $info = @$this->_aOptionToInfo[$key];
+ if (is_array($info)) return $info['oid'];
+
+ // load all OIDs for this plugin from the database
+ $this->_aOptionToInfo = array();
+ $query = 'SELECT oid, oname, ocontext, odef FROM ' . sql_table('plugin_option_desc') . ' WHERE opid=' . intval($this->plugid);
+ $res = sql_query($query);
+ while ($o = mysql_fetch_object($res)) {
+ $k = $o->ocontext . '_' . $o->oname;
+ $this->_aOptionToInfo[$k] = array('oid' => $o->oid, 'default' => $o->odef);
+ }
+ mysql_free_result($res);
+
+ return @$this->_aOptionToInfo[$key]['oid'];
+ }
+ function _getDefVal($context, $name) {
+ $key = $context . '_' . $name;
+ $info = $this->_aOptionToInfo[$key];
+ if (is_array($info)) return $info['default'];
+ }
+
+
+ /**
+ * Deletes all option values for a given context and contextid
+ * (used when e.g. a blog, member or category is deleted)
+ *
+ * (static method)
+ */
+ function _deleteOptionValues($context, $contextid) {
+ // delete all associated plugin options
+ $aOIDs = array();
+ // find ids
+ $query = 'SELECT oid FROM '.sql_table('plugin_option_desc') . ' WHERE ocontext=\''.addslashes($context).'\'';
+ $res = sql_query($query);
+ while ($o = mysql_fetch_object($res))
+ array_push($aOIDs, $o->oid);
+ mysql_free_result($res);
+ // delete those options. go go go
+ if (count($aOIDs) > 0) {
+ $query = 'DELETE FROM ' . sql_table('plugin_option') . ' WHERE oid in ('.implode(',',$aOIDs).') and ocontextid=' . intval($contextid);
+ sql_query($query);
+ }
+ }
+
+ /**
+ * splits the option's typeextra field (at ;'s) to split the meta collection
+ * @param string $typeExtra the value of the typeExtra field of an option
+ * @return array array of the meta-key/value-pairs
+ * @author TeRanEX
+ * @static
+ */
+ function getOptionMeta($typeExtra) {
+ $tmpMeta = explode(';', $typeExtra);
+ $meta = array();
+ for ($i = 0; $i < count($tmpMeta); $i++) {
+ if (($i == 0) && (!strstr($tmpMeta[0], '='))) {
+ // we have the select-list
+ $meta['select'] = $tmpMeta[0];
+ } else {
+ $tmp = explode('=', $tmpMeta[$i]);
+ $meta[$tmp[0]] = $tmp[1];
+ }
+ }
+ return $meta;
+ }
+
+ /**
+ * filters the selectlists out of the meta collection
+ * @param string $typeExtra the value of the typeExtra field of an option
+ * @return string the selectlist
+ * @author TeRanEX
+ */
+ function getOptionSelectValues($typeExtra) {
+ $meta = NucleusPlugin::getOptionMeta($typeExtra);
+ //the select list must always be the first part
+ return $meta['select'];
+ }
+
+ /**
+ * checks if the eventlist in the database is up-to-date
+ * @return bool if it is up-to-date it return true, else false
+ * @author TeRanEX
+ */
+ function subscribtionListIsUptodate() {
+ $res = sql_query('SELECT event FROM '.sql_table('plugin_event').' WHERE pid = '.$this->getID());
+ $ev = array();
+ while($a = mysql_fetch_array($res)) {
+ array_push($ev, $a['event']);
+ }
+ if (count($ev) != count($this->getEventList())) {
+ return false;
+ }
+ $d = array_diff($ev, $this->getEventList());
+ if (count($d) > 0) {
+ // there are differences so the db is not up-to-date
+ return false;
+ }
+ return true;
+ }
+
+ /**
+ * @param $aOptions: array ( 'oid' => array( 'contextid' => 'value'))
+ * (taken from request using requestVar())
+ * @param $newContextid: integer (accepts a contextid when it is for a new
+ * contextid there was no id available at the moment of writing the
+ * formcontrols into the page (by ex: itemOptions for new item)
+ * @static
+ */
+ function _applyPluginOptions(&$aOptions, $newContextid = 0) {
+ global $manager;
+ if (!is_array($aOptions)) return;
+
+ foreach ($aOptions as $oid => $values) {
+
+ // get option type info
+ $query = 'SELECT opid, oname, ocontext, otype, oextra, odef FROM ' . sql_table('plugin_option_desc') . ' WHERE oid=' . intval($oid);
+ $res = sql_query($query);
+ if ($o = mysql_fetch_object($res))
+ {
+ foreach ($values as $key => $value) {
+ // avoid overriding the key used by foreach statement
+ $contextid=$key;
+
+ // retreive any metadata
+ $meta = NucleusPlugin::getOptionMeta($o->oextra);
+
+ // if the option is readonly or hidden it may not be saved
+ if ((@$meta['access'] != 'readonly') && (@$meta['access'] != 'hidden')) {
+
+ $value = undoMagic($value); // value comes from request
+
+ switch($o->otype) {
+ case 'yesno':
+ if (($value != 'yes') && ($value != 'no')) $value = 'no';
+ break;
+ default:
+ break;
+ }
+
+ // check the validity of numerical options
+ if ((@$meta['datatype'] == 'numerical') && (!is_numeric($value))) {
+ //the option must be numeric, but the it isn't
+ //use the default for this option
+ $value = $o->odef;
+ }
+
+ // decide wether we are using the contextid of newContextid
+ if ($newContextid != 0) {
+ $contextid = $newContextid;
+ }
+
+ //trigger event PrePluginOptionsUpdate to give the plugin the
+ //possibility to change/validate the new value for the option
+ $manager->notify('PrePluginOptionsUpdate',array('context' => $o->ocontext, 'plugid' => $o->opid, 'optionname' => $o->oname, 'contextid' => $contextid, 'value' => &$value));
+
+ // delete the old value for the option
+ sql_query('DELETE FROM '.sql_table('plugin_option').' WHERE oid='.intval($oid).' AND ocontextid='.intval($contextid));
+ sql_query('INSERT INTO '.sql_table('plugin_option')." (oid, ocontextid, ovalue) VALUES (".intval($oid).",".intval($contextid).",'" . addslashes($value) . "')");
+ }
+ }
+ }
+ // clear option value cache if the plugin object is already loaded
+ if (is_object($o)) {
+ $plugin=& $manager->pidLoaded($o->opid);
+ if ($plugin) $plugin->clearOptionValueCache();
+ }
+ }
+ }
+ }
+?>
OSDN Git Service
