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 1575 2011-08-03 14:58:04Z ftruscot $
24 // these functions _have_ to be redefined in your plugin
46 function getDescription()
51 // these function _may_ be redefined in your plugin
53 function getMinNucleusVersion()
58 function getMinNucleusPatchLevel()
63 function getEventList()
68 function getTableList()
73 function hasAdminArea()
90 function doSkinVar($skinType)
94 function doTemplateVar(&$item)
96 $args = func_get_args();
98 array_unshift($args, 'template');
99 call_user_func_array(array(&$this,'doSkinVar'),$args);
102 function doTemplateCommentsVar(&$item, &$comment)
104 $args = func_get_args();
107 array_unshift($args, 'template');
108 call_user_func_array(array(&$this,'doSkinVar'),$args);
111 function doAction($type)
113 return _ERROR_PLUGIN_NOSUCHACTION;
116 function doIf($key,$value)
121 function doItemVar (&$item)
126 * Checks if a plugin supports a certain feature.
128 * @returns 1 if the feature is reported, 0 if not
130 * Name of the feature. See plugin documentation for more info
131 * 'SqlTablePrefix' -> if the plugin uses the sql_table() method to get table names
132 * 'HelpPage' -> if the plugin provides a helppage
133 * 'SqlApi' -> if the plugin uses the complete sql_* api (must also require nucleuscms 3.5)
135 function supportsFeature($feature)
141 * Report a list of plugin that is required to function
143 * @returns an array of names of plugin, an empty array indicates no dependency
145 function getPluginDep()
150 // these helper functions should not be redefined in your plugin
153 * Creates a new option for this plugin
156 * A string uniquely identifying your option. (max. length is 20 characters)
158 * A description that will show up in the nucleus admin area (max. length: 255 characters)
160 * Either 'text', 'yesno' or 'password'
161 * This info is used when showing 'edit plugin options' screens
163 * Initial value for the option (max. value length is 128 characters)
165 function createOption($name, $desc, $type, $defValue = '', $typeExtras = '')
167 return $this->_createOption('global', $name, $desc, $type, $defValue, $typeExtras);
170 function createBlogOption($name, $desc, $type, $defValue = '', $typeExtras = '')
172 return $this->_createOption('blog', $name, $desc, $type, $defValue, $typeExtras);
175 function createMemberOption($name, $desc, $type, $defValue = '', $typeExtras = '')
177 return $this->_createOption('member', $name, $desc, $type, $defValue, $typeExtras);
180 function createCategoryOption($name, $desc, $type, $defValue = '', $typeExtras = '')
182 return $this->_createOption('category', $name, $desc, $type, $defValue, $typeExtras);
185 function createItemOption($name, $desc, $type, $defValue = '', $typeExtras = '')
187 return $this->_createOption('item', $name, $desc, $type, $defValue, $typeExtras);
191 * Removes the option from the database
193 * Note: Options get erased automatically on plugin uninstall
195 function deleteOption($name)
197 return $this->_deleteOption('global', $name);
200 function deleteBlogOption($name)
202 return $this->_deleteOption('blog', $name);
205 function deleteMemberOption($name)
207 return $this->_deleteOption('member', $name);
210 function deleteCategoryOption($name)
212 return $this->_deleteOption('category', $name);
215 function deleteItemOption($name)
217 return $this->_deleteOption('item', $name);
221 * Sets the value of an option to something new
223 function setOption($name, $value)
225 return $this->_setOption('global', 0, $name, $value);
228 function setBlogOption($blogid, $name, $value)
230 return $this->_setOption('blog', $blogid, $name, $value);
233 function setMemberOption($memberid, $name, $value)
235 return $this->_setOption('member', $memberid, $name, $value);
238 function setCategoryOption($catid, $name, $value)
240 return $this->_setOption('category', $catid, $name, $value);
243 function setItemOption($itemid, $name, $value) {
244 return $this->_setOption('item', $itemid, $name, $value);
248 * Retrieves the current value for an option
250 function getOption($name)
252 // only request the options the very first time. On subsequent requests
253 // the static collection is used to save SQL queries.
254 if ( $this->plugin_options == 0 )
256 $this->plugin_options = array();
258 'SELECT d.oname as name, o.ovalue as value '.
260 sql_table('plugin_option').' o, '.
261 sql_table('plugin_option_desc').' d '.
262 'WHERE d.opid='. intval($this->getID()).' AND d.oid=o.oid'
264 while ( $row = sql_fetch_object($query) )
266 $this->plugin_options[strtolower($row->name)] = $row->value;
269 if ( isset($this->plugin_options[strtolower($name)]) )
271 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
414 * Class constructor: Initializes some internal data
416 function NucleusPlugin()
418 $this->_aOptionValues = array(); // oid_contextid => value
419 $this->_aOptionToInfo = array(); // context_name => array('oid' => ..., 'default' => ...)
420 $this->plugin_options = 0;
424 * Retrieves an array of the top (or bottom) of an option from a plugin.
426 * @param string $context the context for the option: item, blog, member,...
427 * @param string $name the name of the option
428 * @param int $amount how many rows must be returned
429 * @param string $sort desc or asc
430 * @return array array with both values and contextid's
433 function _getOptionTop($context, $name, $amount = 10, $sort = 'desc')
435 if ( ($sort != 'desc') && ($sort != 'asc') )
440 $oid = $this->_getOID($context, $name);
442 // retrieve the data and return
443 $q = 'SELECT otype, oextra FROM '.sql_table('plugin_option_desc').' WHERE oid = '.$oid;
444 $query = sql_query($q);
446 $o = sql_fetch_array($query);
448 if ( ($this->optionCanBeNumeric($o['otype'])) && ($o['oextra'] == 'number' ) )
450 $orderby = 'CAST(ovalue AS SIGNED)';
456 $q = 'SELECT ovalue value, ocontextid id FROM '.sql_table('plugin_option').' WHERE oid = '.$oid.' ORDER BY '.$orderby.' '.$sort.' LIMIT 0,'.intval($amount);
457 $query = sql_query($q);
462 while( $row = sql_fetch_array($query) )
467 // return the array (duh!)
472 * Creates an option in the database table plugin_option_desc
476 function _createOption($context, $name, $desc, $type, $defValue, $typeExtras = '')
478 // create in plugin_option_desc
479 $query = 'INSERT INTO ' . sql_table('plugin_option_desc')
480 .' (opid, oname, ocontext, odesc, otype, odef, oextra)'
481 .' VALUES ('.intval($this->plugid)
482 .', \''.sql_real_escape_string($name).'\''
483 .', \''.sql_real_escape_string($context).'\''
484 .', \''.sql_real_escape_string($desc).'\''
485 .', \''.sql_real_escape_string($type).'\''
486 .', \''.sql_real_escape_string($defValue).'\''
487 .', \''.sql_real_escape_string($typeExtras).'\')';
489 $oid = sql_insert_id();
491 $key = $context . '_' . $name;
492 $this->_aOptionToInfo[$key] = array('oid' => $oid, 'default' => $defValue);
498 * Deletes an option from the database tables
499 * plugin_option and plugin_option_desc
503 function _deleteOption($context, $name)
505 $oid = $this->_getOID($context, $name);
508 return 0; // no such option
511 // delete all things from plugin_option
512 sql_query('DELETE FROM ' . sql_table('plugin_option') . ' WHERE oid=' . $oid);
514 // delete entry from plugin_option_desc
515 sql_query('DELETE FROM ' . sql_table('plugin_option_desc') . ' WHERE oid=' . $oid);
518 unset($this->_aOptionToInfo[$context . '_' . $name]);
519 $this->_aOptionValues = array();
524 * Update an option in the database table plugin_option
526 * returns: 1 on success, 0 on failure
529 function _setOption($context, $contextid, $name, $value)
533 $oid = $this->_getOID($context, $name);
539 // check if context id exists
543 if ( !MEMBER::existsID($contextid) )
549 if ( !$manager->existsBlogID($contextid) )
555 if ( !$manager->existsCategory($contextid) )
561 if ( !$manager->existsItem($contextid, true, true) )
567 if ( $contextid != 0 )
575 // update plugin_option
576 sql_query('DELETE FROM ' . sql_table('plugin_option') . ' WHERE oid='.intval($oid) . ' and ocontextid='. intval($contextid));
577 sql_query('INSERT INTO ' . sql_table('plugin_option') . ' (ovalue, oid, ocontextid) VALUES (\''.sql_real_escape_string($value).'\', '. intval($oid) . ', ' . intval($contextid) . ')');
580 $this->_aOptionValues[$oid . '_' . $contextid] = $value;
581 if ( $context == 'global')
583 $this->plugin_options[strtolower($name)] = $value;
590 * Get an option from Cache or database
591 * - if not in the option Cache read it from the database
592 * - if not in the database write default values into the database
596 function _getOption($context, $contextid, $name)
598 $oid = $this->_getOID($context, $name);
605 $key = $oid . '_' . $contextid;
607 if ( isset($this->_aOptionValues[$key]) )
609 return $this->_aOptionValues[$key];
613 $res = sql_query('SELECT ovalue FROM ' . sql_table('plugin_option') . ' WHERE oid='.intval($oid).' and ocontextid=' . intval($contextid));
615 if ( !$res || (sql_num_rows($res) == 0) )
617 $defVal = $this->_getDefVal($context, $name);
618 $this->_aOptionValues[$key] = $defVal;
620 // fill DB with default value
621 $query = 'INSERT INTO ' . sql_table('plugin_option') . ' (oid,ocontextid,ovalue)'
622 .' VALUES ('.intval($oid).', '.intval($contextid).', \''.sql_real_escape_string($defVal).'\')';
627 $o = sql_fetch_object($res);
628 $this->_aOptionValues[$key] = $o->ovalue;
631 return $this->_aOptionValues[$key];
635 * Returns assoc array with all values for a given option
636 * (one option per possible context id)
640 function _getAllOptions($context, $name)
642 $oid = $this->_getOID($context, $name);
647 $defVal = $this->_getDefVal($context, $name);
653 $r = sql_query('SELECT bnumber as contextid FROM ' . sql_table('blog'));
656 $r = sql_query('SELECT catid as contextid FROM ' . sql_table('category'));
659 $r = sql_query('SELECT mnumber as contextid FROM ' . sql_table('member'));
662 $r = sql_query('SELECT inumber as contextid FROM ' . sql_table('item'));
667 while ( $o = sql_fetch_object($r) )
669 $aOptions[$o->contextid] = $defVal;
673 $res = sql_query('SELECT ocontextid, ovalue FROM ' . sql_table('plugin_option') . ' WHERE oid=' . $oid);
674 while ( $o = sql_fetch_object($res) )
676 $aOptions[$o->ocontextid] = $o->ovalue;
683 * Gets the 'option identifier' that corresponds to a given option name.
684 * When this method is called for the first time, all the OIDs for the plugin
685 * are loaded into memory, to avoid re-doing the same query all over.
687 function _getOID($context, $name)
689 $key = $context . '_' . $name;
690 $info = $this->_aOptionToInfo[$key];
691 if ( is_array($info) )
696 // load all OIDs for this plugin from the database
697 $this->_aOptionToInfo = array();
698 $query = 'SELECT oid, oname, ocontext, odef FROM ' . sql_table('plugin_option_desc') . ' WHERE opid=' . intval($this->plugid);
699 $res = sql_query($query);
700 while ( $o = sql_fetch_object($res) )
702 $k = $o->ocontext . '_' . $o->oname;
703 $this->_aOptionToInfo[$k] = array('oid' => $o->oid, 'default' => $o->odef);
705 sql_free_result($res);
707 return $this->_aOptionToInfo[$key]['oid'];
709 function _getDefVal($context, $name)
711 $key = $context . '_' . $name;
712 $info = $this->_aOptionToInfo[$key];
713 if ( is_array($info) )
715 return $info['default'];
721 * Deletes all option values for a given context and contextid
722 * (used when e.g. a blog, member or category is deleted)
726 function _deleteOptionValues($context, $contextid)
728 // delete all associated plugin options
731 $query = 'SELECT oid FROM '.sql_table('plugin_option_desc') . ' WHERE ocontext=\''.sql_real_escape_string($context).'\'';
732 $res = sql_query($query);
733 while ( $o = sql_fetch_object($res) )
735 array_push($aOIDs, $o->oid);
737 sql_free_result($res);
738 // delete those options. go go go
739 if ( count($aOIDs) > 0 )
741 $query = 'DELETE FROM ' . sql_table('plugin_option') . ' WHERE oid in ('.implode(',',$aOIDs).') and ocontextid=' . intval($contextid);
747 * splits the option's typeextra field (at ;'s) to split the meta collection
748 * @param string $typeExtra the value of the typeExtra field of an option
749 * @return array array of the meta-key/value-pairs
753 function getOptionMeta($typeExtra)
755 $tmpMeta = i18n::explode(';', $typeExtra);
757 for ( $i = 0; $i < count($tmpMeta); $i++ )
759 if ( ($i == 0) && (!strstr($tmpMeta[0], '=')) )
761 // we have the select-list
762 $meta['select'] = $tmpMeta[0];
766 $tmp = i18n::explode('=', $tmpMeta[$i]);
767 $meta[$tmp[0]] = $tmp[1];
774 * filters the selectlists out of the meta collection
775 * @param string $typeExtra the value of the typeExtra field of an option
776 * @return string the selectlist
779 function getOptionSelectValues($typeExtra)
781 $meta = NucleusPlugin::getOptionMeta($typeExtra);
782 //the select list must always be the first part
783 return $meta['select'];
787 * checks if the eventlist in the database is up-to-date
788 * @return bool if it is up-to-date it return true, else false
791 function subscribtionListIsUptodate()
793 $res = sql_query('SELECT event FROM '.sql_table('plugin_event').' WHERE pid = '.$this->getID());
795 while( $a = sql_fetch_array($res) )
797 array_push($ev, $a['event']);
799 if ( count($ev) != count($this->getEventList()) )
803 $d = array_diff($ev, $this->getEventList());
806 // there are differences so the db is not up-to-date
813 * @param $aOptions: array ( 'oid' => array( 'contextid' => 'value'))
814 * (taken from request using requestVar())
815 * @param $newContextid: integer (accepts a contextid when it is for a new
816 * contextid there was no id available at the moment of writing the
817 * formcontrols into the page (by ex: itemOptions for new item)
820 function _applyPluginOptions(&$aOptions, $newContextid = 0)
823 if ( !is_array($aOptions) )
828 foreach ( $aOptions as $oid => $values )
831 // get option type info
832 $query = 'SELECT opid, oname, ocontext, otype, oextra, odef FROM ' . sql_table('plugin_option_desc') . ' WHERE oid=' . intval($oid);
833 $res = sql_query($query);
834 if ( $o = sql_fetch_object($res) )
836 foreach ( $values as $key => $value )
838 // avoid overriding the key used by foreach statement
841 // retreive any metadata
842 $meta = NucleusPlugin::getOptionMeta($o->oextra);
844 // if the option is readonly or hidden it may not be saved
845 if ( ($meta['access'] != 'readonly') && ($meta['access'] != 'hidden') )
848 $value = undoMagic($value); // value comes from request
853 if ( ($value != 'yes') && ($value != 'no') )
862 // check the validity of numerical options
863 if ( ($meta['datatype'] == 'numerical') && (!is_numeric($value)) )
865 //the option must be numeric, but the it isn't
866 //use the default for this option
870 // decide wether we are using the contextid of newContextid
871 if ( $newContextid != 0 )
873 $contextid = $newContextid;
876 //trigger event PrePluginOptionsUpdate to give the plugin the
877 //possibility to change/validate the new value for the option
878 $manager->notify('PrePluginOptionsUpdate',array('context' => $o->ocontext, 'plugid' => $o->opid, 'optionname' => $o->oname, 'contextid' => $contextid, 'value' => &$value));
880 // delete the old value for the option
881 sql_query('DELETE FROM '.sql_table('plugin_option').' WHERE oid='.intval($oid).' AND ocontextid='.intval($contextid));
882 sql_query('INSERT INTO '.sql_table('plugin_option')." (oid, ocontextid, ovalue) VALUES (".intval($oid).",".intval($contextid).",'" . sql_real_escape_string($value) . "')");
886 // clear option value cache if the plugin object is already loaded
889 $plugin=& $manager->pidLoaded($o->opid);
892 $plugin->clearOptionValueCache();