lib/plugin/WikiFormRich.php

   1 <?php // -*-php-*-
   2 // $Id$
   3 /*
   4  * Copyright 2004,2006,2007 $ThePhpWikiProgrammingTeam
   5  *
   6  * This file is part of PhpWiki.
   7  *
   8  * PhpWiki is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * PhpWiki is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21  */
  22
  23 /**
  24  * This is another replacement for MagicPhpWikiURL forms.
  25  * Previously encoded with the "phpwiki:" syntax.
  26  *
  27  * Enhanced WikiForm to be more generic:
  28  * - editbox[]                 name=.. value=.. text=.. autocomplete=1
  29  * - checkbox[]         name=.. value=0|1 checked text=..
  30  * - radio[]                 name=.. value=.. text=..
  31  * - pulldown[]                name=.. value=.. selected=.. text=.. autocomplete=1
  32  * - combobox[]                name=.. value=.. text=.. method=.. args=..
  33  * - hidden[]                name=.. value=..
  34  * - submit[]
  35  * - action, submit buttontext, optional cancel button (bool)
  36  * - method=get or post, Default: post.
  37
  38  * Valid arguments for pulldown and editbox: autocomplete=1, Default: 0
  39  * If autocomplete=1, additional arguments method and args may be used.
  40  * If no method is given, value will be used to fill in the valid values.
  41  * method="xmlrpc:server:name" or "url:http://server/wiki/method" or "array:jsvariable"
  42  * or "plugin:pluginname"
  43  * args are optional arguments, space seperated, for the method.
  44  * A combobox is a pulldown with autocomplete=1.
  45  *
  46  * @Author: Reini Urban
  47
  48  * Values which are constants are evaluated.
  49  * The cancel button must be supported by the action.
  50  *   (just some wikiadmin actions so far)
  51  * improve layout by: nobr=1
  52  * some allow values as list from from <!plugin-list !>
  53
  54  Samples:
  55    <<WikiFormRich action=dumpserial method=get
  56             checkbox[] name=include value="all"
  57             editbox[] name=directory value=DEFAULT_DUMP_DIR
  58             editbox[] name=pages value=*
  59             editbox[] name=exclude value="" >>
  60    <<WikiFormRich action=dumphtml method=get
  61             editbox[] name=directory value=HTML_DUMP_DIR
  62             editbox[] name=pages value="*"
  63             editbox[] name=exclude value="" >>
  64    <<WikiFormRich action=loadfile method=get
  65             editbox[]  name=source value=DEFAULT_WIKI_PGSRC
  66             checkbox[] name=overwrite value=1
  67             editbox[]  name=exclude value="" >>
  68   <<WikiFormRich action=TitleSearch method=get class=wikiadmin nobr=1
  69              editbox[] name=s text=""
  70            submit[]
  71              checkbox[] name=case_exact
  72              checkbox[] name=regex >>
  73   <<WikiFormRich action=FullTextSearch method=get class=wikiadmin nobr=1
  74              editbox[] name=s text=""
  75            submit[]
  76              checkbox[] name=case_exact
  77              checkbox[] name=regex >>
  78   <<WikiFormRich action=FuzzyPages method=get class=wikiadmin nobr=1
  79              editbox[] name=s text=""
  80            submit[]
  81              checkbox[] name=case_exact ?>
  82   <<WikiFormRich action=AppendText buttontext="AddPlugin"
  83              radio[] name=s value=<!plugin-list BackLinks page=WikiPlugin limit=10 !>
  84              ?>
  85   <<WikiFormRich action=AppendText buttontext="AddPlugin"
  86              pulldown[] name=s text="Plugins: " value=<!plugin-list BackLinks page=WikiPlugin !>
  87              ?>
  88   <<WikiFormRich action=AppendText buttontext="AddCategory"
  89              pulldown[] name=s text="Categories: " value=<!plugin-list TitleSearch s=Category !>
  90              ?>
  91   <<WikiFormRich action=SemanticSearch buttontext="AddRelation"
  92              combobox[] name=relation text="Relation: " method=listRelations
  93              ?>
  94   <<WikiFormRich action=AppendText buttontext="InsertTemplate"
  95              combobox[] name=s text="Template: " method=titleSearch args="Template/"
  96              ?>
  97 */
  98
  99 class WikiPlugin_WikiFormRich
 100 extends WikiPlugin
 101 {
 102     function getName () {
 103         return "WikiFormRich";
 104     }
 105     function getDescription () {
 106         return _("Provide generic WikiForm input buttons");
 107     }
 108     function getDefaultArguments() {
 109         return array('action' => false,     // required argument
 110                      'method' => 'post',    // or get
 111                      'class'  => 'wikiaction',
 112                      'buttontext' => false, // for the submit button. default: action
 113                      'cancel' => false,     // boolean if the action supports cancel also
 114                      'nobr' => false,       // "no break": linebreaks or not
 115                      );
 116     }
 117
 118     /* TODO: support better block alignment: <br>, tables, indent
 119      */
 120     function handle_plugin_args_cruft($argstr, $args) {
 121             $allowed = array("editbox", "hidden", "checkbox", "radiobutton"/*deprecated*/,
 122                              "radio", "pulldown", "submit", "reset", "combobox");
 123             // no editbox[] = array(...) allowed (space)
 124             $arg_array = preg_split("/\n/", $argstr);
 125             // for security we should check this better
 126         $arg = '';
 127             for ($i = 0; $i < count($arg_array); $i++) {
 128                 //TODO: we require an name=value pair here, but submit may go without also.
 129                 if (preg_match("/^\s*(".join("|",$allowed).")\[\](.*)$/", $arg_array[$i], $m)) {
 130                         $name = $m[1]; // one of the allowed input types
 131                 $this->inputbox[][$name] = array(); $j = count($this->inputbox) - 1;
 132                 $curargs = trim($m[2]);
 133                 // must match name=NAME and also value=<!plugin-list name !>
 134                 while (preg_match("/^(\w+?)=((?:\".*?\")|(?:\w+)|(?:\"?<!plugin-list.+?!>\"?))\s*/",
 135                                   $curargs, $m)) {
 136                     $attr = $m[1]; $value = $m[2];
 137                     $curargs = substr($curargs, strlen($m[0]));
 138                     if (preg_match("/^\"(.*)\"$/", $value, $m))
 139                         $value = $m[1];
 140                     if (in_array($name, array("pulldown","checkbox","radio","radiobutton","combobox"))
 141                             and preg_match('/^<!plugin-list.+!>$/', $value, $m))
 142                         // like pulldown[] name=test value=<!plugin-list BackLinks page=HomePage!>
 143                     {
 144                             $loader = new WikiPluginLoader();
 145                             $markup = null;
 146                             $basepage = null;
 147                             $plugin_str = preg_replace(array("/^<!/","/!>$/"),array("<?","?>"), $value);
 148                             // will return a pagelist object! pulldown,checkbox,radiobutton
 149                             $value = $loader->expandPI($plugin_str, $GLOBALS['request'], $markup, $basepage);
 150                             if (isa($value, 'PageList'))
 151                                 $value = $value->pageNames(); // apply limit
 152                             elseif (!is_array($value))
 153                                     trigger_error(sprintf("Invalid argument %s ignored", htmlentities($arg_array[$i])),
 154                                                   E_USER_WARNING);
 155                     }
 156                     elseif (defined($value))
 157                         $value = constant($value);
 158                     $this->inputbox[$j][$name][$attr] = $value;
 159                 }
 160                         //trigger_error("not yet finished");
 161                 //eval('$this->inputbox[]["'.$m[1].'"]='.$m[2].';');
 162             } else {
 163                         trigger_error(sprintf("Invalid argument %s ignored", htmlentities($arg_array[$i])),
 164                                       E_USER_WARNING);
 165             }
 166             }
 167         return;
 168     }
 169
 170     function run($dbi, $argstr, &$request, $basepage) {
 171         extract($this->getArgs($argstr, $request));
 172         if (empty($action)) {
 173             return $this->error(fmt("A required argument '%s' is missing.", "action"));
 174         }
 175
 176         $form = HTML::form(array('action' => $request->getPostURL(),
 177                                  'method' => strtolower($method),
 178                                  'class'  => 'wikiformrich',
 179                                  'accept-charset' => $GLOBALS['charset']),
 180                            HiddenInputs(array('action' => $action)));
 181         $nbsp = HTML::Raw('&nbsp;');
 182         $already_submit = 0;
 183         foreach ($this->inputbox as $inputbox) {
 184             foreach ($inputbox as $inputtype => $input) {
 185               if ($inputtype == 'radiobutton') $inputtype = 'radio'; // convert from older versions
 186               $input['type'] = $inputtype;
 187               $text = '';
 188               if ($inputtype != 'submit') {
 189                   if (empty($input['name']))
 190                       return $this->error(fmt("A required argument '%s' is missing.",
 191                                             $inputtype."[][name]"));
 192                   if (!isset($input['text'])) $input['text'] = gettext($input['name']);
 193                   $text = $input['text'];
 194                   unset($input['text']);
 195               }
 196               switch($inputtype) {
 197               case 'checkbox': // text right
 198               case 'radio':
 199                 if (empty($input['value'])) $input['value'] = 1;
 200                 if (is_array($input['value'])) {
 201                     $div = HTML::div(array('class' => $class));
 202                     $values = $input['value'];
 203                     $name = $input['name'];
 204                     $input['name'] = $inputtype == 'checkbox' ? $name."[]" : $name;
 205                     foreach ($values as $val) {
 206                         $input['value'] = $val;
 207                         if ($request->getArg($name)) {
 208                             if ($request->getArg($name) == $val)
 209                                 $input['checked'] = 'checked';
 210                             else
 211                                 unset($input['checked']);
 212                         }
 213                         $div->pushContent(HTML::input($input), $nbsp, $val, $nbsp, "\n");
 214                         if (!$nobr)
 215                             $div->pushContent(HTML::br());
 216                     }
 217                     $form->pushContent($div);
 218                 } else {
 219                     if (empty($input['checked'])) {
 220                         if ($request->getArg($input['name']))
 221                             $input['checked'] = 'checked';
 222                     } else {
 223                         $input['checked'] = 'checked';
 224                     }
 225                     if ($nobr)
 226                         $form->pushContent(HTML::input($input), $nbsp, $text, $nbsp);
 227                     else
 228                         $form->pushContent(HTML::div(array('class' => $class), HTML::input($input), $nbsp, $text));
 229                 }
 230                 break;
 231               case 'editbox': // text left
 232                   $input['type'] = 'text';
 233                   if (empty($input['value']) and ($s = $request->getArg($input['name'])))
 234                       $input['value'] = $s;
 235                   if (!empty($input['autocomplete']))
 236                       $this->_doautocomplete($form, $inputtype, $input, $input['value']);
 237                   if ($nobr)
 238                       $form->pushContent($text, $nbsp, HTML::input($input));
 239                   else
 240                       $form->pushContent(HTML::div(array('class' => $class), $text, $nbsp, HTML::input($input)));
 241                   break;
 242               case 'combobox': // text left
 243                   $input['autocomplete'] = 1;
 244               case 'pulldown':
 245                   $values = isset($input['value']) ? $input['value'] : '';
 246                   unset($input['value']);
 247                   unset($input['type']);
 248                   if (is_string($values)) $values = explode(",", $values);
 249                   if (!empty($input['autocomplete']))
 250                       $this->_doautocomplete($form, $inputtype, $input, $values);
 251                   $select = HTML::select($input);
 252                   if (empty($values) and ($s = $request->getArg($input['name']))) {
 253                       $select->pushContent(HTML::option(array('value'=> $s), $s));
 254                   } elseif (is_array($values)) {
 255                       $name = $input['name'];
 256                       unset($input['name']);
 257                       foreach ($values as $val) {
 258                           $input = array('value' => $val);
 259                           if ($request->getArg($name)) {
 260                               if ($request->getArg($name) == $val)
 261                                   $input['selected'] = 'selected';
 262                               else
 263                                   unset($input['selected']);
 264                           }
 265                           //TODO: filter uneeded attributes
 266                           $select->pushContent(HTML::option($input, $val));
 267                       }
 268                   } else { // force empty option
 269                       $select->pushContent(HTML::option(array(), ''));
 270                   }
 271                   $form->pushContent($text, $nbsp, $select);
 272                   break;
 273               case 'reset':
 274               case 'hidden':
 275                   $form->pushContent(HTML::input($input));
 276                   break;
 277               // change the order of inputs, by explicitly placing a submit button here.
 278               case 'submit': // text right (?)
 279                   //$input['type'] = 'submit';
 280                   if (empty($input['value'])) $input['value'] = $buttontext ? $buttontext : $action;
 281                   unset($input['text']);
 282                   if (empty($input['class'])) $input['class'] = $class;
 283                   if ($nobr)
 284                       $form->pushContent(HTML::input($input), $nbsp, $text, $nbsp);
 285                   else
 286                       $form->pushContent(HTML::div(array('class' => $class), HTML::input($input), $text));
 287                   // unset the default submit button
 288                   $already_submit = 1;
 289                   break;
 290               }
 291             }
 292         }
 293         if ($request->getArg('start_debug'))
 294             $form->pushContent(HTML::input
 295                                (array('name' => 'start_debug',
 296                                       'value' =>  $request->getArg('start_debug'),
 297                                       'type'  => 'hidden')));
 298         if (!USE_PATH_INFO)
 299             $form->pushContent(HiddenInputs(array('pagename' => $basepage)));
 300         if (!$already_submit) {
 301             if (empty($buttontext)) $buttontext = $action;
 302             $submit = Button('submit:', $buttontext, $class);
 303             if ($cancel) {
 304                 $form->pushContent(HTML::span
 305                                    (array('class' => $class),
 306                                     $submit,
 307                                     Button('submit:cancel', _("Cancel"), $class)));
 308             } else {
 309                 $form->pushContent(HTML::span(array('class' => $class),
 310                                               $submit));
 311             }
 312         }
 313         return $form;
 314     }
 315
 316     function _doautocomplete(&$form, $inputtype, &$input, &$values) {
 317         global $request;
 318         $input['class'] = "dropdown";
 319         $input['acdropdown'] = "true";
 320         //$input['autocomplete'] = "OFF";
 321         $input['autocomplete_complete'] = "true";
 322         // only match begin: autocomplete_matchbegin, or
 323         $input['autocomplete_matchsubstring'] = "true";
 324         if (empty($values)) {
 325             if (isset($input['method']) && $input['method']) {
 326                 if (empty($input['args'])) {
 327                     if (preg_match("/^(.*?) (.*)$/",$input['method'],$m)) {
 328                         $input['method'] = $m[1];
 329                         $input['args'] = $m[2];
 330                     } else
 331                         $input['args'] = null;
 332                 }
 333                 static $tmpArray = 'tmpArray00';
 334                 // deferred remote xmlrpc call
 335                 if (string_starts_with($input['method'], "dynxmlrpc:")) {
 336                     // how is server + method + args encoding parsed by acdropdown?
 337                     $input['autocomplete_list'] = substr($input['method'],3);
 338                     if ($input['args'])
 339                         $input['autocomplete_list'] .= (" ".$input['args']);
 340                 // static xmlrpc call, local only
 341                 } elseif (string_starts_with($input['method'], "xmlrpc:")) {
 342                     include_once("lib/XmlRpcClient.php");
 343                     $values = wiki_xmlrpc_post(substr($input['method'],7), $input['args']);
 344                 } elseif (string_starts_with($input['method'], "url:")) {
 345                     include_once("lib/HttpClient.php");
 346                     $html = HttpClient::quickGet(substr($input['method'],4));
 347                     //TODO: how to parse the HTML result into a list?
 348                 } elseif (string_starts_with($input['method'], "dynurl:")) {
 349                     $input['autocomplete_list'] = substr($input['method'],3);
 350                 } elseif (string_starts_with($input['method'], "plugin:")) {
 351                     $dbi = $request->getDbh();
 352                     $pluginName = substr($input['method'],7);
 353                     $basepage = '';
 354                     require_once("lib/WikiPlugin.php");
 355                     $w = new WikiPluginLoader;
 356                     $p = $w->getPlugin($pluginName, false); // second arg?
 357                     if (!is_object($p))
 358                         trigger_error("invalid input['method'] ".$input['method'], E_USER_WARNING);
 359                     $pagelist = $p->run($dbi, @$input['args'], $request, $basepage);
 360                     $values = array();
 361                     if (is_object($pagelist) and isa($pagelist, 'PageList')) {
 362                         foreach ($pagelist->_pages as $page) {
 363                             if (is_object($page))
 364                                 $values[] = $page->getName();
 365                             else
 366                                 $values[] = (string)$page;
 367                         }
 368                     }
 369                 } elseif (string_starts_with($input['method'], "array:")) {
 370                     // some predefined values (e.g. in a template or themeinfo.php)
 371                     $input['autocomplete_list'] = $input['method'];
 372                 } else {
 373                     trigger_error("invalid input['method'] ".$input['method'], E_USER_WARNING);
 374                 }
 375                 if (empty($input['autocomplete_list']))
 376                 {
 377                     $tmpArray++;
 378                     $input['autocomplete_list']="array:".$tmpArray;
 379                     $svalues = empty($values) ? "" : join("','", $values);
 380                     $form->pushContent(JavaScript("var $tmpArray = new Array('".$svalues."')"));
 381                 }
 382                 if (count($values) == 1)
 383                     $input['value'] = $values[0];
 384                 else
 385                     $input['value'] = "";
 386                 unset($input['method']);
 387                 unset($input['args']);
 388                 //unset($input['autocomplete']);
 389             }
 390             elseif ($s = $request->getArg($input['name']))
 391                 $input['value'] = $s;
 392         }
 393         return true;
 394     }
 395 };
 396
 397 // Local Variables:
 398 // mode: php
 399 // tab-width: 8
 400 // c-basic-offset: 4
 401 // c-hanging-comment-ender-p: nil
 402 // indent-tabs-mode: nil
 403 // End:
 404 ?>