libraries/plugin_interface.lib.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Generic plugin interface.
   5  *
   6  * @version $Id$
   7  * @package phpMyAdmin
   8  */
   9
  10 /**
  11  * array PMA_getPlugins(string $plugins_dir, mixed $plugin_param)
  12  *
  13  * Reads all plugin information from directory $plugins_dir.
  14  *
  15  * @uses    ksort()
  16  * @uses    opendir()
  17  * @uses    readdir()
  18  * @uses    is_file()
  19  * @uses    preg_match()
  20  * @param   string  $plugins_dir    directrory with plugins
  21  * @param   mixed   $plugin_param   parameter to plugin by which they can decide whether they can work
  22  * @return  array                   list of plugins
  23  */
  24 function PMA_getPlugins($plugins_dir, $plugin_param)
  25 {
  26     /* Scan for plugins */
  27     $plugin_list = array();
  28     if ($handle = @opendir($plugins_dir)) {
  29         $is_first = 0;
  30         while ($file = @readdir($handle)) {
  31             // In some situations, Mac OS creates a new file for each file
  32             // (for example ._csv.php) so the following regexp
  33             // matches a file which does not start with a dot but ends
  34             // with ".php"
  35             if (is_file($plugins_dir . $file) && preg_match('@^[^\.](.)*\.php$@i', $file)) {
  36                 include $plugins_dir . $file;
  37             }
  38         }
  39     }
  40     ksort($plugin_list);
  41     return $plugin_list;
  42 }
  43
  44 /**
  45  * string PMA_getString(string $name)
  46  *
  47  * returns locale string for $name or $name if no locale is found
  48  *
  49  * @uses    $GLOBALS
  50  * @param   string  $name   for local string
  51  * @return  string          locale string for $name
  52  */
  53 function PMA_getString($name)
  54 {
  55     return isset($GLOBALS[$name]) ? $GLOBALS[$name] : $name;
  56 }
  57
  58 /**
  59  * string PMA_pluginCheckboxCheck(string $section, string $opt)
  60  *
  61  * returns html input tag option 'checked' if plugin $opt should be set by config or request
  62  *
  63  * @uses    $_REQUEST
  64  * @uses    $GLOBALS['cfg']
  65  * @uses    $GLOBALS['timeout_passed']
  66  * @param   string  $section    name of config section in
  67  *                              $GLOBALS['cfg'][$section] for plugin
  68  * @param   string  $opt        name of option
  69  * @return  string              hmtl input tag option 'checked'
  70  */
  71 function PMA_pluginCheckboxCheck($section, $opt)
  72 {
  73     if ((isset($GLOBALS['timeout_passed']) && $GLOBALS['timeout_passed'] && isset($_REQUEST[$opt])) ||
  74         (isset($GLOBALS['cfg'][$section][$opt]) && $GLOBALS['cfg'][$section][$opt])) {
  75         return ' checked="checked"';
  76     }
  77     return '';
  78 }
  79
  80 /**
  81  * string PMA_pluginGetDefault(string $section, string $opt)
  82  *
  83  * returns default value for option $opt
  84  *
  85  * @uses    htmlspecialchars()
  86  * @uses    $_REQUEST
  87  * @uses    $GLOBALS['cfg']
  88  * @uses    $GLOBALS['timeout_passed']
  89  * @param   string  $section    name of config section in
  90  *                              $GLOBALS['cfg'][$section] for plugin
  91  * @param   string  $opt        name of option
  92  * @return  string              default value for option $opt
  93  */
  94 function PMA_pluginGetDefault($section, $opt)
  95 {
  96     if (isset($GLOBALS['timeout_passed']) && $GLOBALS['timeout_passed'] && isset($_REQUEST[$opt])) {
  97         return htmlspecialchars($_REQUEST[$opt]);
  98     } elseif (isset($GLOBALS['cfg'][$section][$opt])) {
  99         $matches = array();
 100         /* Possibly replace localised texts */
 101         if (preg_match_all('/(str[A-Z][A-Za-z0-9]*)/', $GLOBALS['cfg'][$section][$opt], $matches)) {
 102             $val = $GLOBALS['cfg'][$section][$opt];
 103             foreach($matches[0] as $match) {
 104                 if (isset($GLOBALS[$match])) {
 105                     $val = str_replace($match, $GLOBALS[$match], $val);
 106                 }
 107             }
 108             return htmlspecialchars($val);
 109         } else {
 110             return htmlspecialchars($GLOBALS['cfg'][$section][$opt]);
 111         }
 112     }
 113     return '';
 114 }
 115
 116 /**
 117  * string PMA_pluginIsActive(string $section, string $opt, string $val)
 118  *
 119  * returns html input tag option 'checked' if option $opt should be set by config or request
 120  *
 121  * @uses    $_REQUEST
 122  * @uses    $GLOBALS['cfg']
 123  * @uses    $GLOBALS['timeout_passed']
 124  * @param   string  $section    name of config section in
 125  *                              $GLOBALS['cfg'][$section] for plugin
 126  * @param   string  $opt        name of option
 127  * @param   string  $val        value of option to check against
 128  * @return  string              html input tag option 'checked'
 129  */
 130 function PMA_pluginIsActive($section, $opt, $val)
 131 {
 132     if (! empty($GLOBALS['timeout_passed']) && isset($_REQUEST[$opt])) {
 133         if ($_REQUEST[$opt] == $val) {
 134             return ' checked="checked"';
 135         }
 136     } elseif (isset($GLOBALS['cfg'][$section][$opt]) &&  $GLOBALS['cfg'][$section][$opt] == $val) {
 137         return ' checked="checked"';
 138     }
 139     return '';
 140 }
 141
 142 /**
 143  * string PMA_pluginGetChoice(string $section, string $name, array &$list, string $cfgname)
 144  *
 145  * returns html radio form element for plugin choice
 146  *
 147  * @uses    PMA_pluginIsActive()
 148  * @uses    PMA_getString()
 149  * @param   string  $section    name of config section in
 150  *                              $GLOBALS['cfg'][$section] for plugin
 151  * @param   string  $name       name of radio element
 152  * @param   array   &$list      array with plugin configuration defined in plugin file
 153  * @param   string  $cfgname    name of config value, if none same as $name
 154  * @return  string              html input radio tag
 155  */
 156 function PMA_pluginGetChoice($section, $name, &$list, $cfgname = NULL)
 157 {
 158     if (!isset($cfgname)) {
 159         $cfgname = $name;
 160     }
 161     $ret = '';
 162     foreach ($list as $plugin_name => $val) {
 163         $ret .= '<!-- ' . $plugin_name . ' -->' . "\n";
 164         $ret .= '<input type="radio" name="' . $name . '" value="' . $plugin_name . '"'
 165             . ' id="radio_plugin_' . $plugin_name . '"'
 166             . ' onclick="if(this.checked) { hide_them_all();';
 167         if (isset($val['force_file'])) {
 168             $ret .= 'document.getElementById(\'checkbox_dump_asfile\').checked = true;';
 169         }
 170         $ret .= ' document.getElementById(\'' . $plugin_name . '_options\').style.display = \'block\'; };'
 171                 .' return true"'
 172             . PMA_pluginIsActive($section, $cfgname, $plugin_name) . '/>' . "\n";
 173         $ret .= '<label for="radio_plugin_' . $plugin_name . '">'
 174             . PMA_getString($val['text']) . '</label>' . "\n";
 175         $ret .= '<br />' . "\n";
 176     }
 177     return $ret;
 178 }
 179
 180 /**
 181  * string PMA_pluginGetOneOption(string $section, string $plugin_name, string $id, array &$opt)
 182  *
 183  * returns single option in a table row
 184  *
 185  * @uses    PMA_getString()
 186  * @uses    PMA_pluginCheckboxCheck()
 187  * @uses    PMA_pluginGetDefault()
 188  * @param   string  $section        name of config section in
 189  *                                  $GLOBALS['cfg'][$section] for plugin
 190  * @param   string  $plugin_name    unique plugin name
 191  * @param   string  $id             option id
 192  * @param   array   &$opt           plugin option details
 193  * @return  string                  table row with option
 194  */
 195 function PMA_pluginGetOneOption($section, $plugin_name, $id, &$opt)
 196 {
 197     $ret = "\n";
 198     if ($opt['type'] == 'bool') {
 199         $ret .= '<div class="formelementrow">' . "\n";
 200         $ret .= '<input type="checkbox" name="' . $plugin_name . '_' . $opt['name'] . '"'
 201             . ' value="something" id="checkbox_' . $plugin_name . '_' . $opt['name'] . '"'
 202             . ' ' . PMA_pluginCheckboxCheck($section, $plugin_name . '_' . $opt['name']);
 203         if (isset($opt['force'])) {
 204             /* Same code is also few lines lower, update both if needed */
 205             $ret .= ' onclick="if (!this.checked &amp;&amp; '
 206                 . '(!document.getElementById(\'checkbox_' . $plugin_name . '_' .$opt['force'] . '\') '
 207                 . '|| !document.getElementById(\'checkbox_' . $plugin_name . '_' .$opt['force'] . '\').checked)) '
 208                 . 'return false; else return true;"';
 209         }
 210         $ret .= ' />';
 211         $ret .= '<label for="checkbox_' . $plugin_name . '_' . $opt['name'] . '">'
 212             . PMA_getString($opt['text']) . '</label>';
 213         $ret .= '</div>' . "\n";
 214     } elseif ($opt['type'] == 'text') {
 215         $ret .= '<div class="formelementrow">' . "\n";
 216         $ret .= '<label for="text_' . $plugin_name . '_' . $opt['name'] . '" class="desc">'
 217             . PMA_getString($opt['text']) . '</label>';
 218         $ret .= '<input type="text" name="' . $plugin_name . '_' . $opt['name'] . '"'
 219             . ' value="' . PMA_pluginGetDefault($section, $plugin_name . '_' . $opt['name']) . '"'
 220             . ' id="text_' . $plugin_name . '_' . $opt['name'] . '"'
 221             . (isset($opt['size']) ? ' size="' . $opt['size'] . '"' : '')
 222             . (isset($opt['len']) ? ' maxlength="' . $opt['len'] . '"' : '') . ' />';
 223         $ret .= '</div>' . "\n";
 224     } elseif ($opt['type'] == 'message_only') {
 225         $ret .= '<div class="formelementrow">' . "\n";
 226         $ret .= '<p class="desc">' . PMA_getString($opt['text']) . '</p>';
 227         $ret .= '</div>' . "\n";
 228     } elseif ($opt['type'] == 'select') {
 229         $ret .= '<div class="formelementrow">' . "\n";
 230         $ret .= '<label for="select_' . $plugin_name . '_' . $opt['name'] . '" class="desc">'
 231             . PMA_getString($opt['text']) . '</label>';
 232         $ret .= '<select name="' . $plugin_name . '_' . $opt['name'] . '"'
 233             . ' id="select_' . $plugin_name . '_' . $opt['name'] . '">';
 234         $default = PMA_pluginGetDefault($section, $plugin_name . '_' . $opt['name']);
 235         foreach($opt['values'] as $key => $val) {
 236             $ret .= '<option value="' . $key . '"';
 237             if ($key == $default) {
 238                 $ret .= ' selected="selected"';
 239             }
 240             $ret .= '>' . PMA_getString($val) . '</option>';
 241         }
 242         $ret .= '</select>';
 243         $ret .= '</div>' . "\n";
 244     } elseif ($opt['type'] == 'hidden') {
 245         $ret .= '<input type="hidden" name="' . $plugin_name . '_' . $opt['name'] . '"'
 246             . ' value="' . PMA_pluginGetDefault($section, $plugin_name . '_' . $opt['name']) . '"' . ' />';
 247     } elseif ($opt['type'] == 'bgroup') {
 248         $ret .= '<fieldset><legend>';
 249         /* No checkbox without name */
 250         if (!empty($opt['name'])) {
 251             $ret .= '<input type="checkbox" name="' . $plugin_name . '_' . $opt['name'] . '"'
 252                 . ' value="something" id="checkbox_' . $plugin_name . '_' . $opt['name'] . '"'
 253                 . ' ' . PMA_pluginCheckboxCheck($section, $plugin_name . '_' . $opt['name']);
 254             if (isset($opt['force'])) {
 255                 /* Same code is also few lines higher, update both if needed */
 256                 $ret .= ' onclick="if (!this.checked &amp;&amp; '
 257                     . '(!document.getElementById(\'checkbox_' . $plugin_name . '_' .$opt['force'] . '\') '
 258                     . '|| !document.getElementById(\'checkbox_' . $plugin_name . '_' .$opt['force'] . '\').checked)) '
 259                     . 'return false; else return true;"';
 260             }
 261             $ret .= ' />';
 262             $ret .= '<label for="checkbox_' . $plugin_name . '_' . $opt['name'] . '">'
 263                 . PMA_getString($opt['text']) . '</label>';
 264         } else {
 265             $ret .= PMA_getString($opt['text']);
 266         }
 267         $ret .= '</legend>';
 268     } elseif ($opt['type'] == 'egroup') {
 269         $ret .= '</fieldset>';
 270     } else {
 271         /* This should be seen only by plugin writers, so I do not thing this
 272          * needs translation. */
 273         $ret .= 'UNKNOWN OPTION ' . $opt['type'] . ' IN IMPORT PLUGIN ' . $plugin_name . '!';
 274     }
 275     if (isset($opt['doc'])) {
 276         if (count($opt['doc']) == 3) {
 277             $ret .= PMA_showMySQLDocu($opt['doc'][0], $opt['doc'][1], false, $opt['doc'][2]);
 278         } else {
 279             $ret .= PMA_showMySQLDocu($opt['doc'][0], $opt['doc'][1]);
 280         }
 281     }
 282     $ret .= "\n";
 283     return $ret;
 284 }
 285
 286 /**
 287  * string PMA_pluginGetOptions(string $section, array &$list)
 288  *
 289  * return html fieldset with editable options for plugin
 290  *
 291  * @uses    PMA_getString()
 292  * @uses    PMA_pluginGetOneOption()
 293  * @param   string  $section    name of config section in $GLOBALS['cfg'][$section]
 294  * @param   array   &$list      array with plugin configuration defined in plugin file
 295  * @return  string              html fieldset with plugin options
 296  */
 297 function PMA_pluginGetOptions($section, &$list)
 298 {
 299     $ret = '';
 300     // Options for plugins that support them
 301     foreach ($list as $plugin_name => $val) {
 302         $ret .= '<fieldset id="' . $plugin_name . '_options" class="options">';
 303         $ret .= '<legend>' . PMA_getString($val['options_text']) . '</legend>';
 304         $count = 0;
 305         if (isset($val['options']) && count($val['options']) > 0) {
 306             foreach ($val['options'] as $id => $opt) {
 307                 if ($opt['type'] != 'hidden') $count++;
 308                 $ret .= PMA_pluginGetOneOption($section, $plugin_name, $id, $opt);
 309             }
 310         }
 311         if ($count == 0) {
 312             $ret .= __('This format has no options');
 313         }
 314         $ret .= '</fieldset>';
 315     }
 316     return $ret;
 317 }
 318
 319 /**
 320  * string PMA_pluginGetJavascript(array &$list)
 321  *
 322  * return html/javascript code which is needed for handling plugin stuff
 323  *
 324  * @param   array   &$list      array with plugin configuration defined in plugin file
 325  * @return  string              html fieldset with plugin options
 326  */
 327 function PMA_pluginGetJavascript(&$list) {
 328     $ret = '
 329     <script type="text/javascript">
 330     //<![CDATA[
 331     function hide_them_all() {
 332         ';
 333     foreach ($list as $plugin_name => $val) {
 334         $ret .= 'document.getElementById("' . $plugin_name . '_options").style.display = "none";' . "\n";
 335     }
 336     $ret .= '
 337     }
 338
 339     function init_options() {
 340         hide_them_all();
 341         ';
 342     foreach ($list as $plugin_name => $val) {
 343         $ret .= 'if (document.getElementById("radio_plugin_' . $plugin_name . '").checked) {' . "\n";
 344         if (isset($val['force_file'])) {
 345             $ret .= 'document.getElementById(\'checkbox_dump_asfile\').checked = true;' . "\n";
 346         }
 347         $ret .= 'document.getElementById("' . $plugin_name . '_options").style.display = "block";' . "\n";
 348         $ret .= ' } else ' . "\n";
 349     }
 350     $ret .= '
 351         {
 352             ;
 353         }
 354     }
 355
 356     function match_file(fname) {
 357         farr = fname.toLowerCase().split(".");
 358         if (farr.length != 0) {
 359             len = farr.length
 360             if (farr[len - 1] == "gz" || farr[len - 1] == "bz2" || farr[len -1] == "zip") len--;
 361             switch (farr[len - 1]) {
 362                 ';
 363     foreach ($list as $plugin_name => $val) {
 364         $ret .= 'case "' . $val['extension'] . '" :';
 365         $ret .= 'document.getElementById("radio_plugin_' . $plugin_name . '").checked = true;';
 366         $ret .= 'init_options();';
 367         $ret .= 'break;' . "\n";
 368     }
 369     $ret .='
 370             }
 371         }
 372     }
 373
 374     $(document).ready(init_options);
 375     //]]>
 376     </script>
 377     ';
 378     return $ret;
 379 }
 380 ?>