OSDN Git Service

sync the original code
[nucleus-jp/nucleus-jp-ancient.git] / utf8 / nucleus / libs / PLUGIN.php
1 <?php\r
2         /*\r
3          * Nucleus: PHP/MySQL Weblog CMS (http://nucleuscms.org/)\r
4          * Copyright (C) 2002-2005 The Nucleus Group\r
5          *\r
6          * This program is free software; you can redistribute it and/or\r
7          * modify it under the terms of the GNU General Public License\r
8          * as published by the Free Software Foundation; either version 2\r
9          * of the License, or (at your option) any later version.\r
10          * (see nucleus/documentation/index.html#license for more info)\r
11          */\r
12         /**\r
13          * This is an (abstract) class of which all Nucleus Plugins must inherit\r
14          *\r
15          * for more information on plugins and how to write your own, see the\r
16          * plugins.html file that is included with the Nucleus documenation\r
17          *\r
18          * @license http://nucleuscms.org/license.txt GNU General Public License\r
19          * @copyright Copyright (C) 2002-2005 The Nucleus Group\r
20          * @version $Id: PLUGIN.php,v 1.4 2005-08-13 07:33:02 kimitake Exp $\r
21          * $NucleusJP: PLUGIN.php,v 1.3 2005/03/12 06:19:05 kimitake Exp $\r
22          */\r
23         class NucleusPlugin {\r
24 \r
25                 // these functions _have_ to be redefined in your plugin\r
26 \r
27                 function getName() { return 'Undefined'; }\r
28                 function getAuthor()  { return 'Undefined'; }\r
29                 function getURL()  { return 'Undefined'; }\r
30                 function getVersion() { return '0.0'; }\r
31                 function getDescription() { return 'Undefined';}\r
32 \r
33                 // these function _may_ be redefined in your plugin\r
34 \r
35                 function getMinNucleusVersion() { return 150; }\r
36                 function getMinNucleusPatchLevel() { return 0; }\r
37                 function getEventList() { return array(); }\r
38                 function getTableList() { return array(); }\r
39                 function hasAdminArea() { return 0; }\r
40 \r
41                 function install() {}\r
42                 function unInstall() {}\r
43 \r
44                 function init() {}\r
45 \r
46                 function doSkinVar($skinType) {}\r
47                 function doTemplateVar(&$item) {\r
48                         $args = func_get_args();\r
49                         array_shift($args);\r
50                         array_unshift($args, 'template');\r
51                         call_user_func_array(array(&$this,'doSkinVar'),$args);\r
52                 }\r
53                 function doTemplateCommentsVar(&$item, &$comment) {\r
54                         $args = func_get_args();\r
55                         array_shift($args);\r
56                         array_shift($args);\r
57                         array_unshift($args, 'template');\r
58                         call_user_func_array(array(&$this,'doSkinVar'),$args);\r
59                 }\r
60                 function doAction($type) { return 'No Such Action'; }\r
61 \r
62                 /**\r
63                  * Checks if a plugin supports a certain feature.\r
64                  *\r
65                  * @returns 1 if the feature is reported, 0 if not\r
66                  * @param $feature\r
67                  *              Name of the feature. See plugin documentation for more info\r
68                  *                      'SqlTablePrefix' -> if the plugin uses the sql_table() method to get table names\r
69                  *                      'HelpPage' -> if the plugin provides a helppage\r
70                  */\r
71                 function supportsFeature($feature) {\r
72                         return 0;\r
73                 }\r
74 \r
75                 /**\r
76                  * Report a list of plugin that is required to function\r
77                  * \r
78                  * @returns an array of names of plugin, an empty array indicates no dependency\r
79                  */\r
80                 function getPluginDep() { return array(); }\r
81 \r
82                 // these helper functions should not be redefined in your plugin\r
83 \r
84                 /**\r
85                   * Creates a new option for this plugin\r
86                   *\r
87                   * @param name\r
88                   *             A string uniquely identifying your option. (max. length is 20 characters)\r
89                   * @param description\r
90                   *             A description that will show up in the nucleus admin area (max. length: 255 characters)\r
91                   * @param type\r
92                   *             Either 'text', 'yesno' or 'password'\r
93                   *             This info is used when showing 'edit plugin options' screens\r
94                   * @param value\r
95                   *             Initial value for the option (max. value length is 128 characters)\r
96                   */\r
97                 function createOption($name, $desc, $type, $defValue = '', $typeExtras = '') {\r
98                         return $this->_createOption('global', $name, $desc, $type, $defValue, $typeExtras);\r
99                 }\r
100                 function createBlogOption($name, $desc, $type, $defValue = '', $typeExtras = '') {\r
101                         return $this->_createOption('blog', $name, $desc, $type, $defValue, $typeExtras);\r
102                 }\r
103                 function createMemberOption($name, $desc, $type, $defValue = '', $typeExtras = '') {\r
104                         return $this->_createOption('member', $name, $desc, $type, $defValue, $typeExtras);\r
105                 }\r
106                 function createCategoryOption($name, $desc, $type, $defValue = '', $typeExtras = '') {\r
107                         return $this->_createOption('category', $name, $desc, $type, $defValue, $typeExtras);\r
108                 }\r
109         function createItemOption($name, $desc, $type, $defValue = '', $typeExtras = '') {\r
110                         return $this->_createOption('item', $name, $desc, $type, $defValue, $typeExtras);\r
111                 }\r
112 \r
113                 /**\r
114                   * Removes the option from the database\r
115                   *\r
116                   * Note: Options get erased automatically on plugin uninstall\r
117                   */\r
118                 function deleteOption($name) {\r
119                         return $this->_deleteOption('global', $name);\r
120                 }\r
121                 function deleteBlogOption($name) {\r
122                         return $this->_deleteOption('blog', $name);\r
123                 }\r
124                 function deleteMemberOption($name) {\r
125                         return $this->_deleteOption('member', $name);\r
126                 }\r
127                 function deleteCategoryOption($name) {\r
128                         return $this->_deleteOption('category', $name);\r
129                 }\r
130         function deleteItemOption($name) {\r
131                         return $this->_deleteOption('item', $name);\r
132                 }\r
133 \r
134                 /**\r
135                   * Sets the value of an option to something new\r
136                   */\r
137                 function setOption($name, $value) {\r
138                         return $this->_setOption('global', 0, $name, $value);\r
139                 }\r
140                 function setBlogOption($blogid, $name, $value) {\r
141                         return $this->_setOption('blog', $blogid, $name, $value);\r
142                 }\r
143                 function setMemberOption($memberid, $name, $value) {\r
144                         return $this->_setOption('member', $memberid, $name, $value);\r
145                 }\r
146                 function setCategoryOption($catid, $name, $value) {\r
147                         return $this->_setOption('category', $catid, $name, $value);\r
148                 }\r
149         function setItemOption($itemid, $name, $value) {\r
150                         return $this->_setOption('item', $itemid, $name, $value);\r
151                 }\r
152 \r
153                 /**\r
154                   * Retrieves the current value for an option\r
155                   */\r
156                 function getOption($name)\r
157                 {\r
158                         // only request the options the very first time. On subsequent requests\r
159                         // the static collection is used to save SQL queries.\r
160                         if ($this->plugin_options == 0)\r
161                         {\r
162                                 $this->plugin_options = array();        \r
163                                 $query = mysql_query(\r
164                                          'SELECT d.oname as name, o.ovalue as value '.\r
165                                          'FROM '.\r
166                                          sql_table('plugin_option').' o, '.\r
167                                          sql_table('plugin_option_desc').' d '.\r
168                                          'WHERE d.opid='. intval($this->getID()).' AND d.oid=o.oid'\r
169                                 );\r
170                                 while ($row = mysql_fetch_object($query))\r
171                                         $this->plugin_options[strtolower($row->name)] = $row->value;\r
172                   }\r
173                   if (isset($this->plugin_options[strtolower($name)]))\r
174                                 return $this->plugin_options[strtolower($name)];\r
175                   else\r
176                                 return $this->_getOption('global', 0, $name);\r
177                 }                 \r
178 \r
179                 function getBlogOption($blogid, $name) {\r
180                         return $this->_getOption('blog', $blogid, $name);\r
181                 }\r
182                 function getMemberOption($memberid, $name) {\r
183                         return $this->_getOption('member', $memberid, $name);\r
184                 }\r
185                 function getCategoryOption($catid, $name) {\r
186                         return $this->_getOption('category', $catid, $name);\r
187                 }\r
188         function getItemOption($itemid, $name) {\r
189                         return $this->_getOption('item', $itemid, $name);\r
190                 }\r
191 \r
192                 /**\r
193                  * Retrieves an associative array with the option value for each\r
194                  * context id\r
195                  */\r
196                 function getAllBlogOptions($name) {\r
197                         return $this->_getAllOptions('blog', $name);\r
198                 }\r
199                 function getAllMemberOptions($name) {\r
200                         return $this->_getAllOptions('member', $name);\r
201                 }\r
202                 function getAllCategoryOptions($name) {\r
203                         return $this->_getAllOptions('category', $name);\r
204                 }\r
205         function getAllItemOptions($name) {\r
206                         return $this->_getAllOptions('item', $name);\r
207                 }\r
208                 \r
209                 /**\r
210          * Retrieves an indexed array with the top (or bottom) of an option\r
211                  * (delegates to _getOptionTop())\r
212          */\r
213                 function getBlogOptionTop($name, $amount = 10, $sort = 'desc') {\r
214                         return $this->_getOptionTop('blog', $name, $amount, $sort);\r
215                 }\r
216                 function getMemberOptionTop($name, $amount = 10, $sort = 'desc') {\r
217                         return $this->_getOptionTop('member', $name, $amount, $sort);\r
218                 }\r
219                 function getCategoryOptionTop($name, $amount = 10, $sort = 'desc') {\r
220                         return $this->_getOptionTop('category', $name, $amount, $sort);\r
221                 }\r
222                 function getItemOptionTop($name, $amount = 10, $sort = 'desc') {\r
223                         return $this->_getOptionTop('item', $name, $amount, $sort);\r
224                 }\r
225                 \r
226                 /**\r
227                  * Retrieves an array of the top (or bottom) of an option from a plugin.\r
228                  * @author TeRanEX\r
229                  * @param  string $context the context for the option: item, blog, member,...\r
230                  * @param  string $name    the name of the option\r
231                  * @param  int    $amount  how many rows must be returned\r
232                  * @param  string $sort    desc or asc\r
233                  * @return array           array with both values and contextid's\r
234                  * @access private\r
235                  */\r
236         function _getOptionTop($context, $name, $amount = 10, $sort = 'desc') {\r
237                         if (($sort != 'desc') && ($sort != 'asc')) {\r
238                                 $sort= 'desc';\r
239                         }\r
240 \r
241                         $oid = $this->_getOID($context, $name);\r
242 \r
243                         // retrieve the data and return\r
244                         $q = 'SELECT otype, oextra FROM '.sql_table('plugin_option_desc').' WHERE oid = '.$oid;\r
245                         $query = mysql_query($q);\r
246 \r
247                         $o = mysql_fetch_array($query);\r
248 \r
249                         if (($this->optionCanBeNumeric($o['otype'])) && ($o['oextra'] == 'number' )) {\r
250                                 $orderby = 'CAST(ovalue AS SIGNED)';\r
251                         } else {\r
252                                 $orderby = 'ovalue';\r
253                         }\r
254                         $q = 'SELECT ovalue value, ocontextid id FROM '.sql_table('plugin_option').' WHERE oid = '.$oid.' ORDER BY '.$orderby.' '.$sort.' LIMIT 0,'.$amount;\r
255                         $query = mysql_query($q);\r
256                         \r
257                         // create the array\r
258                         $i = 0;\r
259                         $top = array();\r
260                         while($row = mysql_fetch_array($query)) {\r
261                                 $top[$i++] = $row;\r
262                         }\r
263                         \r
264                         // return the array (duh!)\r
265                         return $top;\r
266                 }\r
267 \r
268                 /**\r
269                   * Returns the plugin ID\r
270                   */\r
271                 function getID() {\r
272                         return $this->plugid;\r
273                 }\r
274 \r
275                 /**\r
276                   * returns the URL of the admin area for this plugin (in case there's\r
277                   * no such area, the returned information is invalid)\r
278                   */\r
279                 function getAdminURL() {\r
280                         global $CONF;\r
281                         return $CONF['PluginURL'] . $this->getShortName() . '/';\r
282                 }\r
283 \r
284                 /**\r
285                   * Returns the directory where the admin directory is located and\r
286                   * where the plugin can maintain his extra files\r
287                   */\r
288                 function getDirectory() {\r
289                         global $DIR_PLUGINS;\r
290                         return $DIR_PLUGINS . $this->getShortName() . '/';\r
291                 }\r
292 \r
293                 /**\r
294                   * Derives the short name for the plugin from the classname (all lowercase)\r
295                   */\r
296                 function getShortName() {\r
297                         return str_replace('np_','',strtolower(get_class($this)));\r
298                 }\r
299 \r
300                 var $_aOptionValues;    // oid_contextid => value\r
301                 var $_aOptionToInfo;    // context_name => array('oid' => ..., 'default' => ...)\r
302                 var $plugin_options;    // see getOption()\r
303                 var $plugid;                    // plugin id\r
304 \r
305 \r
306                 // constructor. Initializes some internal data\r
307                 function NucleusPlugin() {\r
308                         $this->_aOptionValues = array();        // oid_contextid => value\r
309                         $this->_aOptionToInfo = array();        // context_name => array('oid' => ..., 'default' => ...)\r
310                         $this->plugin_options = 0;\r
311                 }\r
312 \r
313                 // private\r
314                 function _createOption($context, $name, $desc, $type, $defValue, $typeExtras = '') {\r
315                         // create in plugin_option_desc\r
316                         $query = 'INSERT INTO ' . sql_table('plugin_option_desc')\r
317                                .' (opid, oname, ocontext, odesc, otype, odef, oextra)'\r
318                                .' VALUES ('.intval($this->plugid)\r
319                              .', \''.addslashes($name).'\''\r
320                              .', \''.addslashes($context).'\''\r
321                              .', \''.addslashes($desc).'\''\r
322                              .', \''.addslashes($type).'\''\r
323                              .', \''.addslashes($defValue).'\''\r
324                                          .', \''.addslashes($typeExtras).'\')';\r
325                         sql_query($query);\r
326                         $oid = mysql_insert_id();\r
327 \r
328                         $key = $context . '_' . $name;\r
329                         $this->_aOptionToInfo[$key] = array('oid' => $oid, 'default' => $defValue);\r
330                         return 1;\r
331                 }\r
332 \r
333 \r
334                 // private\r
335                 function _deleteOption($context, $name) {\r
336                         $oid = $this->_getOID($context, $name);\r
337                         if (!$oid) return 0; // no such option\r
338 \r
339                         // delete all things from plugin_option\r
340                         sql_query('DELETE FROM ' . sql_table('plugin_option') . ' WHERE oid=' . $oid);\r
341 \r
342                         // delete entry from plugin_option_desc\r
343                         sql_query('DELETE FROM ' . sql_table('plugin_option_desc') . ' WHERE oid=' . $oid);\r
344 \r
345                         // clear from cache\r
346                         unset($this->_aOptionToInfo[$context . '_' . $name]);\r
347                         $this->_aOptionValues = array();\r
348                         return 1;\r
349                 }\r
350 \r
351                 /**\r
352                  * private\r
353                  * returns: 1 on success, 0 on failure\r
354                  */\r
355                 function _setOption($context, $contextid, $name, $value) {\r
356                         global $manager;\r
357 \r
358                         $oid = $this->_getOID($context, $name);\r
359                         if (!$oid) return 0;\r
360 \r
361                         // check if context id exists\r
362                         switch ($context) {\r
363                                 case 'member':\r
364                                         if (!MEMBER::existsID($contextid)) return 0;\r
365                                         break;\r
366                                 case 'blog':\r
367                                         if (!$manager->existsBlogID($contextid)) return 0;\r
368                                         break;\r
369                                 case 'category':\r
370                                         if (!$manager->existsCategory($contextid)) return 0;\r
371                                         break;\r
372                 case 'item':\r
373                     if (!$manager->existsItem($contextid, true, true)) return 0;\r
374                                         break;\r
375                                 case 'global':\r
376                                         if ($contextid != 0) return 0;\r
377                                         break;\r
378                         }\r
379 \r
380 \r
381                         // update plugin_option\r
382                         sql_query('DELETE FROM ' . sql_table('plugin_option') . ' WHERE oid='.intval($oid) . ' and ocontextid='. intval($contextid));\r
383                         sql_query('INSERT INTO ' . sql_table('plugin_option') . ' (ovalue, oid, ocontextid) VALUES (\''.addslashes($value).'\', '. intval($oid) . ', ' . intval($contextid) . ')');\r
384 \r
385                         // update cache\r
386                         $this->_aOptionValues[$oid . '_' . $contextid] = $value;\r
387 \r
388                         return 1;\r
389                 }\r
390 \r
391                 // private\r
392                 function _getOption($context, $contextid, $name) {\r
393                         $oid = $this->_getOID($context, $name);\r
394                         if (!$oid) return '';\r
395 \r
396 \r
397                         $key = $oid . '_' . $contextid;\r
398 \r
399                         if (isset($this->_aOptionValues[$key]))\r
400                                 return $this->_aOptionValues[$key];\r
401 \r
402                         // get from DB\r
403                         $res = sql_query('SELECT ovalue FROM ' . sql_table('plugin_option') . ' WHERE oid='.intval($oid).' and ocontextid=' . intval($contextid));\r
404 \r
405                         if (!$res || (mysql_num_rows($res) == 0)) {\r
406                                 $defVal = $this->_getDefVal($context, $name);\r
407                                 $this->_aOptionValues[$key] = $defVal;\r
408 \r
409                                 // fill DB with default value\r
410                                 $query = 'INSERT INTO ' . sql_table('plugin_option') . ' (oid,ocontextid,ovalue)'\r
411                                        .' VALUES ('.intval($oid).', '.intval($contextid).', \''.addslashes($defVal).'\')';\r
412                                 sql_query($query);\r
413                         }\r
414                         else {\r
415                                 $o = mysql_fetch_object($res);\r
416                                 $this->_aOptionValues[$key] = $o->ovalue;\r
417                         }\r
418 \r
419                         return $this->_aOptionValues[$key];\r
420                 }\r
421 \r
422                 /**\r
423                  * Returns assoc array with all values for a given option (one option per\r
424                  * possible context id)\r
425                  */\r
426                 function _getAllOptions($context, $name) {\r
427                         $oid = $this->_getOID($context, $name);\r
428                         if (!$oid) return array();\r
429                         $defVal = $this->_getDefVal($context, $name);\r
430 \r
431                         $aOptions = array();\r
432                         switch ($context) {\r
433                                 case 'blog':\r
434                                         $r = sql_query('SELECT bnumber as contextid FROM ' . sql_table('blog'));\r
435                                         break;\r
436                                 case 'category':\r
437                                         $r = sql_query('SELECT catid as contextid FROM ' . sql_table('category'));\r
438                                         break;\r
439                                 case 'member':\r
440                                         $r = sql_query('SELECT mnumber as contextid FROM ' . sql_table('member'));\r
441                                         break;\r
442                         }\r
443                         if ($r) {\r
444                                 while ($o = mysql_fetch_object($r))\r
445                                         $aOptions[$o->contextid] = $defVal;\r
446                         }\r
447 \r
448                         $res = sql_query('SELECT ocontextid, ovalue FROM ' . sql_table('plugin_option') . ' WHERE oid=' . $oid);\r
449                         while ($o = mysql_fetch_object($res))\r
450                                 $aOptions[$o->ocontextid] = $o->ovalue;\r
451 \r
452                         return $aOptions;\r
453                 }\r
454 \r
455                 /**\r
456                  * Gets the 'option identifier' that corresponds to a given option name.\r
457                  * When this method is called for the first time, all the OIDs for the plugin\r
458                  * are loaded into memory, to avoid re-doing the same query all over.\r
459                  */\r
460                 function _getOID($context, $name) {\r
461                         $key = $context . '_' . $name;\r
462                         $info = $this->_aOptionToInfo[$key];\r
463                         if (is_array($info)) return $info['oid'];\r
464 \r
465                         // load all OIDs for this plugin from the database\r
466                         $this->_aOptionToInfo = array();\r
467                         $query = 'SELECT oid, oname, ocontext, odef FROM ' . sql_table('plugin_option_desc') . ' WHERE opid=' . intval($this->plugid);\r
468                         $res = sql_query($query);\r
469                         while ($o = mysql_fetch_object($res)) {\r
470                                 $k = $o->ocontext . '_' . $o->oname;\r
471                                 $this->_aOptionToInfo[$k] = array('oid' => $o->oid, 'default' => $o->odef);\r
472                         }\r
473                         mysql_free_result($res);\r
474 \r
475                         return $this->_aOptionToInfo[$key]['oid'];\r
476                 }\r
477                 function _getDefVal($context, $name) {\r
478                         $key = $context . '_' . $name;\r
479                         $info = $this->_aOptionToInfo[$key];\r
480                         if (is_array($info)) return $info['default'];\r
481                 }\r
482 \r
483 \r
484                 /**\r
485                  * Deletes all option values for a given context and contextid\r
486                  * (used when e.g. a blog, member or category is deleted)\r
487                  *\r
488                  * (static method)\r
489                  */\r
490                 function _deleteOptionValues($context, $contextid) {\r
491                         // delete all associated plugin options\r
492                         $aOIDs = array();\r
493                                 // find ids\r
494                         $query = 'SELECT oid FROM '.sql_table('plugin_option_desc') . ' WHERE ocontext=\''.addslashes($context).'\'';\r
495                         $res = sql_query($query);\r
496                         while ($o = mysql_fetch_object($res))\r
497                                 array_push($aOIDs, $o->oid);\r
498                         mysql_free_result($res);\r
499                                 // delete those options. go go go\r
500                         if (count($aOIDs) > 0) {\r
501                                 $query = 'DELETE FROM ' . sql_table('plugin_option') . ' WHERE oid in ('.implode(',',$aOIDs).') and ocontextid=' . intval($contextid);\r
502                                 sql_query($query);\r
503                         }\r
504                 }\r
505 \r
506                 /**\r
507                  * splits the option's typeextra field (at ;'s) to split the meta collection\r
508                  * @param string $typeExtra the value of the typeExtra field of an option\r
509                  * @return array array of the meta-key/value-pairs\r
510                  * @author TeRanEX\r
511                  * @static\r
512                  */\r
513                 function getOptionMeta($typeExtra) {\r
514                         $tmpMeta = explode(';', $typeExtra);\r
515                         $meta = array();\r
516                         for ($i = 0; $i < count($tmpMeta); $i++) {\r
517                                 if (($i == 0) && (!strstr($tmpMeta[0], '='))) {\r
518                                         // we have the select-list\r
519                                         $meta['select'] = $tmpMeta[0];\r
520                                 } else {\r
521                                         $tmp = explode('=', $tmpMeta[$i]);\r
522                                         $meta[$tmp[0]] = $tmp[1];\r
523                                 }\r
524                         }\r
525                         return $meta;\r
526                 }\r
527 \r
528                 /**\r
529                  * filters the selectlists out of the meta collection\r
530                  * @param string $typeExtra the value of the typeExtra field of an option\r
531                  * @return string the selectlist\r
532                  * @author TeRanEX\r
533                  */\r
534                 function getOptionSelectValues($typeExtra) {\r
535                         $meta = NucleusPlugin::getOptionMeta($typeExtra);\r
536                         //the select list must always be the first part\r
537                         return $meta['select'];\r
538                 }\r
539                 \r
540                 /**\r
541                  * checks if the eventlist in the database is up-to-date\r
542                  * @return bool if it is up-to-date it return true, else false\r
543                  * @author TeRanEX\r
544                  */\r
545                 function subscribtionListIsUptodate() {\r
546                         $res = sql_query('SELECT event FROM '.sql_table('plugin_event').' WHERE pid = '.$this->getID());\r
547                         $ev = array();\r
548                         while($a = mysql_fetch_array($res)) {\r
549                                 array_push($ev, $a['event']);\r
550                         }\r
551                         if (count($ev) != count($this->getEventList())) {\r
552                                 return false;\r
553                         }\r
554                         $d = array_diff($ev, $this->getEventList());\r
555                         if (count($d) > 0) {\r
556                                 // there are differences so the db is not up-to-date\r
557                                 return false;\r
558                         }\r
559                         return true;\r
560                 }\r
561                 \r
562                 /**\r
563                  * @param $aOptions: array ( 'oid' => array( 'contextid' => 'value'))\r
564                  *        (taken from request using requestVar())\r
565                  * @param $newContextid: integer (accepts a contextid when it is for a new \r
566                  *        contextid there was no id available at the moment of writing the\r
567                  *        formcontrols into the page (by ex: itemOptions for new item)\r
568                  * @static \r
569                  */\r
570                 function _applyPluginOptions(&$aOptions, $newContextid = 0) {\r
571                         global $manager;\r
572                         if (!is_array($aOptions)) return;\r
573 \r
574                         foreach ($aOptions as $oid => $values) {\r
575 \r
576                                 // get option type info\r
577                                 $query = 'SELECT opid, oname, ocontext, otype, oextra, odef FROM ' . sql_table('plugin_option_desc') . ' WHERE oid=' . intval($oid);\r
578                                 $res = sql_query($query);\r
579                                 if ($o = mysql_fetch_object($res))\r
580                                 {\r
581                                         foreach ($values as $contextid => $value) {\r
582                                                 // retreive any metadata\r
583                                                 $meta = NucleusPlugin::getOptionMeta($o->oextra);\r
584                                                 \r
585                                                 // if the option is readonly or hidden it may not be saved\r
586                                                 if (($meta['access'] != 'readonly') && ($meta['access'] != 'hidden')) {\r
587                                                         \r
588                                                         $value = undoMagic($value);     // value comes from request\r
589         \r
590                                                         switch($o->otype) {\r
591                                                                 case 'yesno':\r
592                                                                         if (($value != 'yes') && ($value != 'no')) $value = 'no';\r
593                                                                         break;\r
594                                                                 default:\r
595                                                                         break;\r
596                                                         }\r
597                                                         \r
598                                                         // check the validity of numerical options\r
599                                                         if (($meta['datatype'] == 'numerical') && (!is_numeric($value))) { \r
600                                                                 //the option must be numeric, but the it isn't\r
601                                                                 //use the default for this option\r
602                                                                 $value = $o->odef;\r
603                                                         }\r
604         \r
605                                                         // decide wether we are using the contextid of newContextid\r
606                                                         if ($newContextid != 0) {\r
607                                                                 $contextid = $newContextid;\r
608                                                         }\r
609                                                         \r
610                                                         //trigger event PrePluginOptionsUpdate to give the plugin the\r
611                                                         //possibility to change/validate the new value for the option\r
612                                                         $manager->notify('PrePluginOptionsUpdate',array('context' => $o->ocontext, 'plugid' => $o->opid, 'optionname' => $o->oname, 'contextid' => $contextid, 'value' => &$value));\r
613                                                         \r
614                                                         // delete the old value for the option\r
615                                                         sql_query('DELETE FROM '.sql_table('plugin_option').' WHERE oid='.intval($oid).' AND ocontextid='.intval($contextid));\r
616                                                         sql_query('INSERT INTO '.sql_table('plugin_option')." (oid, ocontextid, ovalue) VALUES (".intval($oid).",".intval($contextid).",'" . addslashes($value) . "')");\r
617                                                 }\r
618                                         }\r
619                                 }\r
620                         }\r
621                 }\r
622                 \r
623         }\r
624 ?>\r