3 * Nucleus: PHP/MySQL Weblog CMS (http://nucleuscms.org/)
4 * Copyright (C) 2002-2009 The Nucleus Group
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 * (see nucleus/documentation/index.html#license for more info)
13 * This is an (abstract) class of which all Nucleus Plugins must inherit
15 * for more information on plugins and how to write your own, see the
16 * plugins.html file that is included with the Nucleus documenation
18 * @license http://nucleuscms.org/license.txt GNU General Public License
19 * @copyright Copyright (C) 2002-2009 The Nucleus Group
20 * @version $Id: PLUGIN.php 1630 2012-01-28 12:16:14Z sakamocchi $
24 // these functions _have_ to be redefined in your plugin
45 function getDescription()
50 // these function _may_ be redefined in your plugin
52 function getMinNucleusVersion()
57 function getMinNucleusPatchLevel()
62 function getEventList()
67 function getTableList()
72 function hasAdminArea()
89 function doSkinVar($skinType)
93 function doTemplateVar(&$item)
95 $args = func_get_args();
97 array_unshift($args, 'template');
98 call_user_func_array(array(&$this,'doSkinVar'),$args);
101 function doTemplateCommentsVar(&$item, &$comment)
103 $args = func_get_args();
106 array_unshift($args, 'template');
107 call_user_func_array(array(&$this,'doSkinVar'),$args);
110 function doAction($type)
112 return _ERROR_PLUGIN_NOSUCHACTION;
115 function doIf($key,$value)
120 function doItemVar (&$item)
125 * Checks if a plugin supports a certain feature.
127 * @returns 1 if the feature is reported, 0 if not
129 * Name of the feature. See plugin documentation for more info
130 * 'SqlTablePrefix' -> if the plugin uses the sql_table() method to get table names
131 * 'HelpPage' -> if the plugin provides a helppage
132 * 'SqlApi' -> if the plugin uses the complete sql_* api (must also require nucleuscms 3.5)
134 function supportsFeature($feature)
140 * Report a list of plugin that is required to function
142 * @returns an array of names of plugin, an empty array indicates no dependency
144 function getPluginDep()
149 // these helper functions should not be redefined in your plugin
152 * Creates a new option for this plugin
155 * A string uniquely identifying your option. (max. length is 20 characters)
157 * A description that will show up in the nucleus admin area (max. length: 255 characters)
159 * Either 'text', 'yesno' or 'password'
160 * This info is used when showing 'edit plugin options' screens
162 * Initial value for the option (max. value length is 128 characters)
164 function createOption($name, $desc, $type, $defValue = '', $typeExtras = '')
166 return $this->_createOption('global', $name, $desc, $type, $defValue, $typeExtras);
169 function createBlogOption($name, $desc, $type, $defValue = '', $typeExtras = '')
171 return $this->_createOption('blog', $name, $desc, $type, $defValue, $typeExtras);
174 function createMemberOption($name, $desc, $type, $defValue = '', $typeExtras = '')
176 return $this->_createOption('member', $name, $desc, $type, $defValue, $typeExtras);
179 function createCategoryOption($name, $desc, $type, $defValue = '', $typeExtras = '')
181 return $this->_createOption('category', $name, $desc, $type, $defValue, $typeExtras);
184 function createItemOption($name, $desc, $type, $defValue = '', $typeExtras = '')
186 return $this->_createOption('item', $name, $desc, $type, $defValue, $typeExtras);
190 * Removes the option from the database
192 * Note: Options get erased automatically on plugin uninstall
194 function deleteOption($name)
196 return $this->_deleteOption('global', $name);
199 function deleteBlogOption($name)
201 return $this->_deleteOption('blog', $name);
204 function deleteMemberOption($name)
206 return $this->_deleteOption('member', $name);
209 function deleteCategoryOption($name)
211 return $this->_deleteOption('category', $name);
214 function deleteItemOption($name)
216 return $this->_deleteOption('item', $name);
220 * Sets the value of an option to something new
222 function setOption($name, $value)
224 return $this->_setOption('global', 0, $name, $value);
227 function setBlogOption($blogid, $name, $value)
229 return $this->_setOption('blog', $blogid, $name, $value);
232 function setMemberOption($memberid, $name, $value)
234 return $this->_setOption('member', $memberid, $name, $value);
237 function setCategoryOption($catid, $name, $value)
239 return $this->_setOption('category', $catid, $name, $value);
242 function setItemOption($itemid, $name, $value) {
243 return $this->_setOption('item', $itemid, $name, $value);
247 * Retrieves the current value for an option
249 function getOption($name)
251 // only request the options the very first time. On subsequent requests
252 // the static collection is used to save SQL queries.
253 if ( $this->plugin_options == 0 )
255 $this->plugin_options = array();
257 'SELECT d.oname as name, o.ovalue as value '.
259 sql_table('plugin_option').' o, '.
260 sql_table('plugin_option_desc').' d '.
261 'WHERE d.opid='. intval($this->getID()).' AND d.oid=o.oid'
263 while ( $row = sql_fetch_object($query) )
265 $this->plugin_options[strtolower($row->name)] = $row->value;
268 if ( isset($this->plugin_options[strtolower($name)]) )
270 return $this->plugin_options[strtolower($name)];
274 return $this->_getOption('global', 0, $name);
278 function getBlogOption($blogid, $name)
280 return $this->_getOption('blog', $blogid, $name);
283 function getMemberOption($memberid, $name)
285 return $this->_getOption('member', $memberid, $name);
288 function getCategoryOption($catid, $name)
290 return $this->_getOption('category', $catid, $name);
293 function getItemOption($itemid, $name)
295 return $this->_getOption('item', $itemid, $name);
299 * Retrieves an associative array with the option value for each
302 function getAllBlogOptions($name)
304 return $this->_getAllOptions('blog', $name);
307 function getAllMemberOptions($name)
309 return $this->_getAllOptions('member', $name);
312 function getAllCategoryOptions($name)
314 return $this->_getAllOptions('category', $name);
317 function getAllItemOptions($name)
319 return $this->_getAllOptions('item', $name);
323 * Retrieves an indexed array with the top (or bottom) of an option
324 * (delegates to _getOptionTop())
326 function getBlogOptionTop($name, $amount = 10, $sort = 'desc')
328 return $this->_getOptionTop('blog', $name, $amount, $sort);
331 function getMemberOptionTop($name, $amount = 10, $sort = 'desc')
333 return $this->_getOptionTop('member', $name, $amount, $sort);
336 function getCategoryOptionTop($name, $amount = 10, $sort = 'desc')
338 return $this->_getOptionTop('category', $name, $amount, $sort);
341 function getItemOptionTop($name, $amount = 10, $sort = 'desc')
343 return $this->_getOptionTop('item', $name, $amount, $sort);
347 * Returns the plugin ID
353 return $this->plugid;
357 * Returns the URL of the admin area for this plugin (in case there's
358 * no such area, the returned information is invalid)
362 function getAdminURL()
365 return $CONF['PluginURL'] . $this->getShortName() . '/';
369 * Returns the directory where the admin directory is located and
370 * where the plugin can maintain his extra files
374 function getDirectory()
377 return $DIR_PLUGINS . $this->getShortName() . '/';
381 * Derives the short name for the plugin from the classname (all
386 function getShortName()
388 return str_replace('np_','',strtolower(get_class($this)));
392 * Clears the option value cache which saves the option values during
393 * the plugin execution. This function is usefull if the options has
394 * changed during the plugin execution (especially in association with
395 * the PrePluginOptionsUpdate and the PostPluginOptionsUpdate events)
399 function clearOptionValueCache()
401 $this->_aOptionValues = array();
402 $this->plugin_options = 0;
405 // internal functions of the class starts here
407 var $_aOptionValues; // oid_contextid => value
408 var $_aOptionToInfo; // context_name => array('oid' => ..., 'default' => ...)
409 var $plugin_options; // see getOption()
410 var $plugid; // plugin id
413 * Class constructor: Initializes some internal data
415 function NucleusPlugin()
417 $this->_aOptionValues = array(); // oid_contextid => value
418 $this->_aOptionToInfo = array(); // context_name => array('oid' => ..., 'default' => ...)
419 $this->plugin_options = 0;
423 * Retrieves an array of the top (or bottom) of an option from a plugin.
425 * @param string $context the context for the option: item, blog, member,...
426 * @param string $name the name of the option
427 * @param int $amount how many rows must be returned
428 * @param string $sort desc or asc
429 * @return array array with both values and contextid's
432 function _getOptionTop($context, $name, $amount = 10, $sort = 'desc')
434 if ( ($sort != 'desc') && ($sort != 'asc') )
439 $oid = $this->_getOID($context, $name);
441 // retrieve the data and return
442 $q = 'SELECT otype, oextra FROM '.sql_table('plugin_option_desc').' WHERE oid = '.$oid;
443 $query = sql_query($q);
445 $o = sql_fetch_array($query);
447 if ( ($this->optionCanBeNumeric($o['otype'])) && ($o['oextra'] == 'number' ) )
449 $orderby = 'CAST(ovalue AS SIGNED)';
455 $q = 'SELECT ovalue value, ocontextid id FROM '.sql_table('plugin_option').' WHERE oid = '.$oid.' ORDER BY '.$orderby.' '.$sort.' LIMIT 0,'.intval($amount);
456 $query = sql_query($q);
461 while( $row = sql_fetch_array($query) )
466 // return the array (duh!)
471 * Creates an option in the database table plugin_option_desc
475 function _createOption($context, $name, $desc, $type, $defValue, $typeExtras = '')
477 // create in plugin_option_desc
478 $query = 'INSERT INTO ' . sql_table('plugin_option_desc')
479 .' (opid, oname, ocontext, odesc, otype, odef, oextra)'
480 .' VALUES ('.intval($this->plugid)
481 .', \''.sql_real_escape_string($name).'\''
482 .', \''.sql_real_escape_string($context).'\''
483 .', \''.sql_real_escape_string($desc).'\''
484 .', \''.sql_real_escape_string($type).'\''
485 .', \''.sql_real_escape_string($defValue).'\''
486 .', \''.sql_real_escape_string($typeExtras).'\')';
488 $oid = sql_insert_id();
490 $key = $context . '_' . $name;
491 $this->_aOptionToInfo[$key] = array('oid' => $oid, 'default' => $defValue);
496 * Deletes an option from the database tables
497 * plugin_option and plugin_option_desc
501 function _deleteOption($context, $name)
503 $oid = $this->_getOID($context, $name);
506 return 0; // no such option
509 // delete all things from plugin_option
510 sql_query('DELETE FROM ' . sql_table('plugin_option') . ' WHERE oid=' . $oid);
512 // delete entry from plugin_option_desc
513 sql_query('DELETE FROM ' . sql_table('plugin_option_desc') . ' WHERE oid=' . $oid);
516 unset($this->_aOptionToInfo[$context . '_' . $name]);
517 $this->_aOptionValues = array();
522 * Update an option in the database table plugin_option
524 * returns: 1 on success, 0 on failure
527 function _setOption($context, $contextid, $name, $value)
531 $oid = $this->_getOID($context, $name);
537 // check if context id exists
541 if ( !MEMBER::existsID($contextid) )
547 if ( !$manager->existsBlogID($contextid) )
553 if ( !$manager->existsCategory($contextid) )
559 if ( !$manager->existsItem($contextid, true, true) )
565 if ( $contextid != 0 )
572 // update plugin_option
573 sql_query('DELETE FROM ' . sql_table('plugin_option') . ' WHERE oid='.intval($oid) . ' and ocontextid='. intval($contextid));
574 sql_query('INSERT INTO ' . sql_table('plugin_option') . ' (ovalue, oid, ocontextid) VALUES (\''.sql_real_escape_string($value).'\', '. intval($oid) . ', ' . intval($contextid) . ')');
577 $this->_aOptionValues[$oid . '_' . $contextid] = $value;
578 if ( $context == 'global' )
580 $this->plugin_options[strtolower($name)] = $value;
587 * Get an option from Cache or database
588 * - if not in the option Cache read it from the database
589 * - if not in the database write default values into the database
593 function _getOption($context, $contextid, $name)
595 $oid = $this->_getOID($context, $name);
601 $key = $oid . '_' . $contextid;
603 if ( isset($this->_aOptionValues[$key]) )
605 return $this->_aOptionValues[$key];
609 $res = sql_query('SELECT ovalue FROM ' . sql_table('plugin_option') . ' WHERE oid='.intval($oid).' and ocontextid=' . intval($contextid));
611 if ( !$res || (sql_num_rows($res) == 0) )
613 $defVal = $this->_getDefVal($context, $name);
614 $this->_aOptionValues[$key] = $defVal;
616 // fill DB with default value
617 $query = 'INSERT INTO ' . sql_table('plugin_option') . ' (oid,ocontextid,ovalue)'
618 .' VALUES ('.intval($oid).', '.intval($contextid).', \''.sql_real_escape_string($defVal).'\')';
623 $o = sql_fetch_object($res);
624 $this->_aOptionValues[$key] = $o->ovalue;
627 return $this->_aOptionValues[$key];
631 * Returns assoc array with all values for a given option
632 * (one option per possible context id)
636 function _getAllOptions($context, $name)
638 $oid = $this->_getOID($context, $name);
643 $defVal = $this->_getDefVal($context, $name);
649 $r = sql_query('SELECT bnumber as contextid FROM ' . sql_table('blog'));
652 $r = sql_query('SELECT catid as contextid FROM ' . sql_table('category'));
655 $r = sql_query('SELECT mnumber as contextid FROM ' . sql_table('member'));
658 $r = sql_query('SELECT inumber as contextid FROM ' . sql_table('item'));
663 while ( $o = sql_fetch_object($r) )
665 $aOptions[$o->contextid] = $defVal;
669 $res = sql_query('SELECT ocontextid, ovalue FROM ' . sql_table('plugin_option') . ' WHERE oid=' . $oid);
670 while ( $o = sql_fetch_object($res) )
672 $aOptions[$o->ocontextid] = $o->ovalue;
679 * NucleusPlugin::_getOID
681 * Gets the 'option identifier' that corresponds to a given option name.
682 * When this method is called for the first time, all the OIDs for the plugin
683 * are loaded into memory, to avoid re-doing the same query all over.
685 * @param string $context option context
686 * @param string $name plugin name
687 * @return integer option id
689 function _getOID($context, $name)
691 $key = $context . '_' . $name;
693 if ( array_key_exists($key, $this->_aOptionToInfo)
694 && array_key_exists('oid', $this->_aOptionToInfo[$key]) )
696 return $this->_aOptionToInfo[$key]['oid'];
699 // load all OIDs for this plugin from the database
700 $this->_aOptionToInfo = array();
701 $query = 'SELECT oid, oname, ocontext, odef FROM ' . sql_table('plugin_option_desc') . ' WHERE opid=' . intval($this->plugid);
702 $res = sql_query($query);
703 while ( $o = sql_fetch_object($res) )
705 $k = $o->ocontext . '_' . $o->oname;
706 $this->_aOptionToInfo[$k] = array('oid' => $o->oid, 'default' => $o->odef);
708 sql_free_result($res);
710 return $this->_aOptionToInfo[$key]['oid'];
712 function _getDefVal($context, $name)
714 $key = $context . '_' . $name;
716 if ( array_key_exists($key, $this->_aOptionToInfo)
717 && array_key_exists('default', $this->_aOptionToInfo[$key]) )
719 return $this->_aOptionToInfo[$key]['default'];
725 * Deletes all option values for a given context and contextid
726 * (used when e.g. a blog, member or category is deleted)
730 function _deleteOptionValues($context, $contextid)
732 // delete all associated plugin options
735 $query = 'SELECT oid FROM '.sql_table('plugin_option_desc') . ' WHERE ocontext=\''.sql_real_escape_string($context).'\'';
736 $res = sql_query($query);
737 while ( $o = sql_fetch_object($res) )
739 array_push($aOIDs, $o->oid);
741 sql_free_result($res);
742 // delete those options. go go go
743 if ( count($aOIDs) > 0 )
745 $query = 'DELETE FROM ' . sql_table('plugin_option') . ' WHERE oid in ('.implode(',',$aOIDs).') and ocontextid=' . intval($contextid);
751 * NucleusPlugin::getOptionMeta()
752 * splits the option's typeextra field (at ;'s) to split the meta collection
755 * @param string $typeExtra the value of the typeExtra field of an option
756 * @return array array of the meta-key/value-pairs
758 function getOptionMeta($typeExtra)
762 /* 1. if $typeExtra includes delimiter ';', split it to tokens */
763 $tokens = i18n::explode(';', $typeExtra);
766 * 2. if each of tokens includes "=", it consists of key => value
767 * else it's 'select' option
769 foreach ( $tokens as $token )
772 if ( preg_match("#^([^=]+)?=([^=]+)?$#", $token, $matches) )
774 $meta[$matches[1]] = $matches[2];
778 $meta['select'] = $token;
785 * NucleusPlugin::getOptionSelectValues()
786 * filters the selectlists out of the meta collection
789 * @param string $typeExtra the value of the typeExtra field of an option
790 * @return string the selectlist
792 function getOptionSelectValues($typeExtra)
794 $meta = NucleusPlugin::getOptionMeta($typeExtra);
796 if ( array_key_exists('select', $meta) )
798 return $meta['select'];
804 * checks if the eventlist in the database is up-to-date
805 * @return bool if it is up-to-date it return true, else false
808 function subscribtionListIsUptodate()
810 $res = sql_query('SELECT event FROM '.sql_table('plugin_event').' WHERE pid = '.$this->getID());
812 while( $a = sql_fetch_array($res) )
814 array_push($ev, $a['event']);
816 if ( count($ev) != count($this->getEventList()) )
820 $d = array_diff($ev, $this->getEventList());
823 // there are differences so the db is not up-to-date
830 * NucleusPlugin::_applyPluginOptions()
831 * Update its entry in database table
834 * @param $aOptions: array ( 'oid' => array( 'contextid' => 'value'))
835 * (taken from request using requestVar())
836 * @param $newContextid: integer (accepts a contextid when it is for a new
837 * contextid there was no id available at the moment of writing the
838 * formcontrols into the page (by ex: itemOptions for new item)
841 function _applyPluginOptions(&$aOptions, $newContextid = 0)
844 if ( !is_array($aOptions) )
849 foreach ( $aOptions as $oid => $values )
851 // get option type info
852 $query = "SELECT opid, oname, ocontext, otype, oextra, odef FROM %s WHERE oid=%d";
853 $query = sprintf($query, sql_table('plugin_option_desc'), (integer) $oid);
854 $result = sql_query($query);
855 if ( $info = sql_fetch_object($result) )
857 foreach ( $values as $key => $value )
859 // avoid overriding the key used by foreach statement
862 // retreive any metadata
863 $meta = NucleusPlugin::getOptionMeta($info->oextra);
865 // if the option is readonly or hidden it may not be saved
866 if ( array_key_exists('access', $meta)
867 && in_array($meta['access'], array('readonly', 'hidden')) )
872 // value comes from request
873 $value = undoMagic($value);
875 /* validation the value according to its type */
876 switch ( $info->otype )
879 if ( ($value != 'yes') && ($value != 'no') )
886 if ( array_key_exists('datatype', $meta)
887 && ($meta['datatype'] == 'numerical') && ($value != (integer) $value) )
889 $value = (integer) $info->odef;
898 // decide wether we are using the contextid of newContextid
899 if ( $newContextid != 0 )
901 $contextid = $newContextid;
905 * trigger event PrePluginOptionsUpdate to give the plugin the
906 * possibility to change/validate the new value for the option
909 'context' => $info->ocontext,
910 'plugid' => $info->opid,
911 'optionname' => $info->oname,
912 'contextid' => $contextid,
914 $manager->notify('PrePluginOptionsUpdate', $data);
916 // delete and insert its fields of table in database
917 $query = "DELETE FROM %s WHERE oid=%d AND ocontextid=%d;";
918 $query = sprintf($query, sql_table('plugin_option'), (integer) $oid, (integer) $contextid);
920 $query = "INSERT INTO %s (oid, ocontextid, ovalue) VALUES (%d, %d, '%s');";
921 $query = sprintf($query, sql_table('plugin_option'), (integer) $oid, (integer) $contextid, sql_real_escape_string($value));
925 // clear option value cache if the plugin object is already loaded
926 if ( is_object($info) )
928 $plugin=& $manager->pidLoaded($info->opid);
931 $plugin->clearOptionValueCache();