nucleus/libs/PLUGINADMIN.php

   1 <?php\r
   2 \r
   3 /*\r
   4  * Nucleus: PHP/MySQL Weblog CMS (http://nucleuscms.org/)\r
   5  * Copyright (C) 2002-2012 The Nucleus Group\r
   6  *\r
   7  * This program is free software; you can redistribute it and/or\r
   8  * modify it under the terms of the GNU General Public License\r
   9  * as published by the Free Software Foundation; either version 2\r
  10  * of the License, or (at your option) any later version.\r
  11  * (see nucleus/documentation/index.html#license for more info)\r
  12  */\r
  13 /**\r
  14  * code to make it easier to create plugin admin areas\r
  15  *\r
  16  * @license http://nucleuscms.org/license.txt GNU General Public License\r
  17  * @copyright Copyright (C) 2002-2012 The Nucleus Group\r
  18  * @version $Id: PLUGINADMIN.php 1626 2012-01-09 15:46:54Z sakamocchi $\r
  19  */\r
  20 \r
  21 class PluginAdmin\r
  22 {\r
  23         public $strFullName;    // NP_SomeThing\r
  24         public $plugin;         // ref. to plugin object\r
  25         public $bValid;         // evaluates to true when object is considered valid\r
  26         public $admin;                  // ref to an admin object\r
  27 \r
  28         private $skinContents;  // PluginAdmin contents\r
  29         private $extrahead;             // extrahead\r
  30 \r
  31         public function __construct($pluginName)\r
  32         {\r
  33                 global $manager, $DIR_LIBS;\r
  34                 \r
  35                 if ( !class_exists('Admin', FALSE) )\r
  36                 {\r
  37                         include($DIR_LIBS . 'ADMIN.php');\r
  38                 }\r
  39                 \r
  40                 $this->strFullName = "NP_{$pluginName}";\r
  41                 \r
  42                 // check if plugin exists and is installed\r
  43                 if ( !$manager->pluginInstalled($this->strFullName) )\r
  44                 {\r
  45                         doError(_ERROR_INVALID_PLUGIN);\r
  46                 }\r
  47                 \r
  48                 $this->plugin = &$manager->getPlugin($this->strFullName);\r
  49                 $this->bValid =  $this->plugin;\r
  50                 \r
  51                 if ( !$this->bValid )\r
  52                 {\r
  53                         doError(_ERROR_INVALID_PLUGIN);\r
  54                 }\r
  55                 \r
  56                 Admin::initialize();\r
  57                 Admin::setAdminAction("plugin_{$pluginName}");\r
  58                 \r
  59                 return;\r
  60         }\r
  61         \r
  62         /**\r
  63          * PluginAdmin::start()\r
  64          * \r
  65          * @param       string  $extraHead      child elements for header element\r
  66          * @return      void\r
  67          */\r
  68         public function start($extraHead = '')\r
  69         {\r
  70                 global $CONF;\r
  71                 $this->extrahead = $extraHead . '<base href="' . Entity::hsc($CONF['AdminURL']) . '" />' . "\n";\r
  72                 ob_start();\r
  73                 return;\r
  74         }\r
  75         \r
  76         /**\r
  77          * PluginAdmin::end()\r
  78          * \r
  79          * @param       void\r
  80          * @return      void\r
  81          */\r
  82         public function end()\r
  83         {\r
  84                 $this->AddTicketByJS();\r
  85                 $contents = ob_get_contents();\r
  86                 ob_end_clean();\r
  87                 $this->skinContents = '<%pagehead%>' . $contents . '<%pagefoot%>';\r
  88                 Admin::action_PluginAdmin($this->skinContents, $this->extrahead);\r
  89                 return;\r
  90         }\r
  91         \r
  92         /**\r
  93          * PluginAdmin::_AddTicketByJS()\r
  94          * Add ticket when not used in plugin's admin page\r
  95          * to avoid CSRF.\r
  96          * \r
  97          * @param       void\r
  98          * @return      void\r
  99          */\r
 100         private function AddTicketByJS()\r
 101         {\r
 102                 global $CONF,$ticketforplugin;\r
 103                 if ( !($ticket = $ticketforplugin['ticket']) )\r
 104                 {\r
 105                         return;\r
 106                 }\r
 107                 $ticket=Entity::hsc($ticket);\r
 108 \r
 109 ?><script type="text/javascript">\r
 110 /*<![CDATA[*/\r
 111 /* Add tickets for available links (outside blog excluded) */\r
 112 for (i=0;document.links[i];i++){\r
 113   if (document.links[i].href.indexOf('<?php echo $CONF['PluginURL']; ?>',0)<0\r
 114     && !(document.links[i].href.indexOf('//',0)<0)) continue;\r
 115   if ((j=document.links[i].href.indexOf('?',0))<0) continue;\r
 116   if (document.links[i].href.indexOf('ticket=',j)>=0) continue;\r
 117   document.links[i].href=document.links[i].href.substring(0,j+1)+'ticket=<?php echo $ticket; ?>&'+document.links[i].href.substring(j+1);\r
 118 }\r
 119 /* Add tickets for forms (outside blog excluded) */\r
 120 for (i=0;document.forms[i];i++){\r
 121   /* check if ticket is already used */\r
 122   for (j=0;document.forms[i].elements[j];j++) {\r
 123     if (document.forms[i].elements[j].name=='ticket') {\r
 124       j=-1;\r
 125       break;\r
 126     }\r
 127   }\r
 128   if (j==-1) continue;\r
 129  \r
 130   /* check if the modification works */\r
 131   try{document.forms[i].innerHTML+='';}catch(e){\r
 132     /* Modificaion falied: this sometime happens on IE */\r
 133     if (!document.forms[i].action.name && document.forms[i].method.toUpperCase()=="POST") {\r
 134       /* <input name="action"/> is not used for POST method*/\r
 135       if (document.forms[i].action.indexOf('<?php echo $CONF['PluginURL']; ?>',0)<0\r
 136         && !(document.forms[i].action.indexOf('//',0)<0)) continue;\r
 137       if (0<(j=document.forms[i].action.indexOf('?',0))) if (0<document.forms[i].action.indexOf('ticket=',j)) continue;\r
 138       if (j<0) document.forms[i].action+='?'+'ticket=<?php echo $ticket; ?>';\r
 139       else document.forms[i].action+='&'+'ticket=<?php echo $ticket; ?>';\r
 140       continue;\r
 141     }\r
 142     document.write('<?php echo _PLUGINADMIN_TICKETS_JAVASCRIPT ?>');\r
 143     j=document.forms[i].outerHTML;\r
 144     while (j!=j.replace('<','&lt;')) j=j.replace('<','&lt;');\r
 145     document.write('<p>'+j+'</p>');\r
 146     continue;\r
 147   }\r
 148   /* check the action paramer in form tag */\r
 149   /* note that <input name="action"/> may be used here */\r
 150   j=document.forms[i].innerHTML;\r
 151   document.forms[i].innerHTML='';\r
 152   if ((document.forms[i].action+'').indexOf('<?php echo $CONF['PluginURL']; ?>',0)<0\r
 153       && !((document.forms[i].action+'').indexOf('//',0)<0)) {\r
 154     document.forms[i].innerHTML=j;\r
 155     continue;\r
 156   }\r
 157   /* add ticket */\r
 158   document.forms[i].innerHTML=j+'<input type="hidden" name="ticket" value="<?php echo $ticket; ?>"/>';\r
 159 }\r
 160 /*]]>*/\r
 161 </script><?php\r
 162         return;\r
 163         }\r
 164 }\r
 165 \r