lib/Theme.php

   1 <?php rcs_id('$Id: Theme.php,v 1.132 2005-07-24 09:51:22 rurban Exp $');
   2 /* Copyright (C) 2002,2004,2005 $ThePhpWikiProgrammingTeam
   3  *
   4  * This file is part of PhpWiki.
   5  *
   6  * PhpWiki is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * PhpWiki is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with PhpWiki; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 /**
  22  * Customize output by themes: templates, css, special links functions,
  23  * and more formatting.
  24  */
  25
  26 require_once(dirname(__FILE__).'/HtmlElement.php');
  27
  28 /**
  29  * Make a link to a wiki page (in this wiki).
  30  *
  31  * This is a convenience function.
  32  *
  33  * @param mixed $page_or_rev
  34  * Can be:<dl>
  35  * <dt>A string</dt><dd>The page to link to.</dd>
  36  * <dt>A WikiDB_Page object</dt><dd>The page to link to.</dd>
  37  * <dt>A WikiDB_PageRevision object</dt><dd>A specific version of the page to link to.</dd>
  38  * </dl>
  39  *
  40  * @param string $type
  41  * One of:<dl>
  42  * <dt>'unknown'</dt><dd>Make link appropriate for a non-existant page.</dd>
  43  * <dt>'known'</dt><dd>Make link appropriate for an existing page.</dd>
  44  * <dt>'auto'</dt><dd>Either 'unknown' or 'known' as appropriate.</dd>
  45  * <dt>'button'</dt><dd>Make a button-style link.</dd>
  46  * <dt>'if_known'</dt><dd>Only linkify if page exists.</dd>
  47  * </dl>
  48  * Unless $type of of the latter form, the link will be of class 'wiki', 'wikiunknown',
  49  * 'named-wiki', or 'named-wikiunknown', as appropriate.
  50  *
  51  * @param mixed $label (string or XmlContent object)
  52  * Label for the link.  If not given, defaults to the page name.
  53  *
  54  * @return XmlContent The link
  55  */
  56 function WikiLink ($page_or_rev, $type = 'known', $label = false) {
  57     global $WikiTheme, $request;
  58
  59     if ($type == 'button') {
  60         return $WikiTheme->makeLinkButton($page_or_rev, $label);
  61     }
  62
  63     $version = false;
  64
  65     if (isa($page_or_rev, 'WikiDB_PageRevision')) {
  66         $version = $page_or_rev->getVersion();
  67         if ($page_or_rev->isCurrent())
  68             $version = false;
  69         $page = $page_or_rev->getPage();
  70         $pagename = $page->getName();
  71         $wikipage = $pagename;
  72         $exists = true;
  73     }
  74     elseif (isa($page_or_rev, 'WikiDB_Page')) {
  75         $page = $page_or_rev;
  76         $pagename = $page->getName();
  77         $wikipage = $pagename;
  78     }
  79     elseif (isa($page_or_rev, 'WikiPageName')) {
  80         $wikipage = $page_or_rev;
  81         $pagename = $wikipage->name;
  82         if (!$wikipage->isValid('strict'))
  83             return $WikiTheme->linkBadWikiWord($wikipage, $label);
  84     }
  85     else {
  86         $wikipage = new WikiPageName($page_or_rev, $request->getPage());
  87         $pagename = $wikipage->name;
  88         if (!$wikipage->isValid('strict'))
  89             return $WikiTheme->linkBadWikiWord($wikipage, $label);
  90     }
  91
  92     if ($type == 'auto' or $type == 'if_known') {
  93         if (isset($page)) {
  94             $exists = $page->exists();
  95         }
  96         else {
  97             $dbi =& $request->_dbi;
  98             $exists = $dbi->isWikiPage($wikipage->name);
  99         }
 100     }
 101     elseif ($type == 'unknown') {
 102         $exists = false;
 103     }
 104     else {
 105         $exists = true;
 106     }
 107
 108     // FIXME: this should be somewhere else, if really needed.
 109     // WikiLink makes A link, not a string of fancy ones.
 110     // (I think that the fancy split links are just confusing.)
 111     // Todo: test external ImageLinks http://some/images/next.gif
 112     if (isa($wikipage, 'WikiPageName') and
 113         ! $label and
 114         strchr(substr($wikipage->shortName,1), SUBPAGE_SEPARATOR))
 115     {
 116         $parts = explode(SUBPAGE_SEPARATOR, $wikipage->shortName);
 117         $last_part = array_pop($parts);
 118         $sep = '';
 119         $link = HTML::span();
 120         foreach ($parts as $part) {
 121             $path[] = $part;
 122             $parent = join(SUBPAGE_SEPARATOR, $path);
 123             if ($WikiTheme->_autosplitWikiWords)
 124                 $part = " " . $part;
 125             if ($part)
 126                 $link->pushContent($WikiTheme->linkExistingWikiWord($parent, $sep . $part));
 127             $sep = $WikiTheme->_autosplitWikiWords
 128                    ? ' ' . SUBPAGE_SEPARATOR : SUBPAGE_SEPARATOR;
 129         }
 130         if ($exists)
 131             $link->pushContent($WikiTheme->linkExistingWikiWord($wikipage, $sep . $last_part,
 132                                                                 $version));
 133         else
 134             $link->pushContent($WikiTheme->linkUnknownWikiWord($wikipage, $sep . $last_part));
 135         return $link;
 136     }
 137
 138     if ($exists) {
 139         return $WikiTheme->linkExistingWikiWord($wikipage, $label, $version);
 140     }
 141     elseif ($type == 'if_known') {
 142         if (!$label && isa($wikipage, 'WikiPageName'))
 143             $label = $wikipage->shortName;
 144         return HTML($label ? $label : $pagename);
 145     }
 146     else {
 147         return $WikiTheme->linkUnknownWikiWord($wikipage, $label);
 148     }
 149 }
 150
 151
 152
 153 /**
 154  * Make a button.
 155  *
 156  * This is a convenience function.
 157  *
 158  * @param $action string
 159  * One of <dl>
 160  * <dt>[action]</dt><dd>Perform action (e.g. 'edit') on the selected page.</dd>
 161  * <dt>[ActionPage]</dt><dd>Run the actionpage (e.g. 'BackLinks') on the selected page.</dd>
 162  * <dt>'submit:'[name]</dt><dd>Make a form submission button with the given name.
 163  *      ([name] can be blank for a nameless submit button.)</dd>
 164  * <dt>a hash</dt><dd>Query args for the action. E.g.<pre>
 165  *      array('action' => 'diff', 'previous' => 'author')
 166  * </pre></dd>
 167  * </dl>
 168  *
 169  * @param $label string
 170  * A label for the button.  If ommited, a suitable default (based on the valued of $action)
 171  * will be picked.
 172  *
 173  * @param $page_or_rev mixed
 174  * Which page (& version) to perform the action on.
 175  * Can be one of:<dl>
 176  * <dt>A string</dt><dd>The pagename.</dd>
 177  * <dt>A WikiDB_Page object</dt><dd>The page.</dd>
 178  * <dt>A WikiDB_PageRevision object</dt><dd>A specific version of the page.</dd>
 179  * </dl>
 180  * ($Page_or_rev is ignored for submit buttons.)
 181  */
 182 function Button ($action, $label = false, $page_or_rev = false) {
 183     global $WikiTheme;
 184
 185     if (!is_array($action) && preg_match('/^submit:(.*)/', $action, $m))
 186         return $WikiTheme->makeSubmitButton($label, $m[1], $page_or_rev);
 187     else
 188         return $WikiTheme->makeActionButton($action, $label, $page_or_rev);
 189 }
 190
 191
 192 class Theme {
 193     var $HTML_DUMP_SUFFIX = '';
 194     var $DUMP_MODE = false, $dumped_images, $dumped_css;
 195
 196     function Theme ($theme_name = 'default') {
 197         $this->_name = $theme_name;
 198         $this->_themes_dir = NormalizeLocalFileName("themes");
 199         $this->_path  = defined('PHPWIKI_DIR') ? NormalizeLocalFileName("") : "";
 200         $this->_theme = "themes/$theme_name";
 201
 202         if ($theme_name != 'default')
 203             $this->_default_theme = new Theme;
 204
 205         // by pixels
 206         if ((is_object($GLOBALS['request']) // guard against unittests
 207              and $GLOBALS['request']->getPref('doubleClickEdit'))
 208             or ENABLE_DOUBLECLICKEDIT)
 209             $this->initDoubleClickEdit();
 210
 211         // will be replaced by acDropDown
 212         if (ENABLE_LIVESEARCH) { // by bitflux.ch
 213             $this->initLiveSearch();
 214         }
 215         // replaces external LiveSearch
 216         if (defined("ENABLE_ACDROPDOWN") and ENABLE_ACDROPDOWN) {
 217             $this->initMoAcDropDown();
 218         }
 219         $this->_css = array();
 220     }
 221
 222     function file ($file) {
 223         return $this->_path . "$this->_theme/$file";
 224    }
 225
 226     function _findFile ($file, $missing_okay = false) {
 227         if (file_exists($this->file($file)))
 228             return "$this->_theme/$file";
 229
 230         // FIXME: this is a short-term hack.  Delete this after all files
 231         // get moved into themes/...
 232         if (file_exists($this->_path . $file))
 233             return $file;
 234
 235         if (isset($this->_default_theme)) {
 236             return $this->_default_theme->_findFile($file, $missing_okay);
 237         }
 238         else if (!$missing_okay) {
 239             if (DEBUG & function_exists('debug_backtrace')) { // >= 4.3.0
 240                 echo "<pre>", printSimpleTrace(debug_backtrace()), "</pre>\n";
 241             }
 242             trigger_error("$this->_theme/$file: not found", E_USER_NOTICE);
 243         }
 244         return false;
 245     }
 246
 247     function _findData ($file, $missing_okay = false) {
 248         $path = $this->_findFile($file, $missing_okay);
 249         if (!$path)
 250             return false;
 251
 252         if (defined('DATA_PATH'))
 253             return DATA_PATH . "/$path";
 254         return $path;
 255     }
 256
 257     ////////////////////////////////////////////////////////////////
 258     //
 259     // Date and Time formatting
 260     //
 261     ////////////////////////////////////////////////////////////////
 262
 263     // Note:  Windows' implemetation of strftime does not include certain
 264         // format specifiers, such as %e (for date without leading zeros).  In
 265         // general, see:
 266         // http://msdn.microsoft.com/library/default.asp?url=/library/en-us/vclib/html/_crt_strftime.2c_.wcsftime.asp
 267         // As a result, we have to use %d, and strip out leading zeros ourselves.
 268
 269     var $_dateFormat = "%B %d, %Y";
 270     var $_timeFormat = "%I:%M %p";
 271
 272     var $_showModTime = true;
 273
 274     /**
 275      * Set format string used for dates.
 276      *
 277      * @param $fs string Format string for dates.
 278      *
 279      * @param $show_mod_time bool If true (default) then times
 280      * are included in the messages generated by getLastModifiedMessage(),
 281      * otherwise, only the date of last modification will be shown.
 282      */
 283     function setDateFormat ($fs, $show_mod_time = true) {
 284         $this->_dateFormat = $fs;
 285         $this->_showModTime = $show_mod_time;
 286     }
 287
 288     /**
 289      * Set format string used for times.
 290      *
 291      * @param $fs string Format string for times.
 292      */
 293     function setTimeFormat ($fs) {
 294         $this->_timeFormat = $fs;
 295     }
 296
 297     /**
 298      * Format a date.
 299      *
 300      * Any time zone offset specified in the users preferences is
 301      * taken into account by this method.
 302      *
 303      * @param $time_t integer Unix-style time.
 304      *
 305      * @return string The date.
 306      */
 307     function formatDate ($time_t) {
 308         global $request;
 309
 310         $offset_time = $time_t + 3600 * $request->getPref('timeOffset');
 311         // strip leading zeros from date elements (ie space followed by zero)
 312         return preg_replace('/ 0/', ' ',
 313                             strftime($this->_dateFormat, $offset_time));
 314     }
 315
 316     /**
 317      * Format a date.
 318      *
 319      * Any time zone offset specified in the users preferences is
 320      * taken into account by this method.
 321      *
 322      * @param $time_t integer Unix-style time.
 323      *
 324      * @return string The time.
 325      */
 326     function formatTime ($time_t) {
 327         //FIXME: make 24-hour mode configurable?
 328         global $request;
 329         $offset_time = $time_t + 3600 * $request->getPref('timeOffset');
 330         return preg_replace('/^0/', ' ',
 331                             strtolower(strftime($this->_timeFormat, $offset_time)));
 332     }
 333
 334     /**
 335      * Format a date and time.
 336      *
 337      * Any time zone offset specified in the users preferences is
 338      * taken into account by this method.
 339      *
 340      * @param $time_t integer Unix-style time.
 341      *
 342      * @return string The date and time.
 343      */
 344     function formatDateTime ($time_t) {
 345         return $this->formatDate($time_t) . ' ' . $this->formatTime($time_t);
 346     }
 347
 348     /**
 349      * Format a (possibly relative) date.
 350      *
 351      * If enabled in the users preferences, this method might
 352      * return a relative day (e.g. 'Today', 'Yesterday').
 353      *
 354      * Any time zone offset specified in the users preferences is
 355      * taken into account by this method.
 356      *
 357      * @param $time_t integer Unix-style time.
 358      *
 359      * @return string The day.
 360      */
 361     function getDay ($time_t) {
 362         global $request;
 363
 364         if ($request->getPref('relativeDates') && ($date = $this->_relativeDay($time_t))) {
 365             return ucfirst($date);
 366         }
 367         return $this->formatDate($time_t);
 368     }
 369
 370     /**
 371      * Format the "last modified" message for a page revision.
 372      *
 373      * @param $revision object A WikiDB_PageRevision object.
 374      *
 375      * @param $show_version bool Should the page version number
 376      * be included in the message.  (If this argument is omitted,
 377      * then the version number will be shown only iff the revision
 378      * is not the current one.
 379      *
 380      * @return string The "last modified" message.
 381      */
 382     function getLastModifiedMessage ($revision, $show_version = 'auto') {
 383         global $request;
 384         if (!$revision) return '';
 385
 386         // dates >= this are considered invalid.
 387         if (! defined('EPOCH'))
 388             define('EPOCH', 0); // seconds since ~ January 1 1970
 389
 390         $mtime = $revision->get('mtime');
 391         if ($mtime <= EPOCH)
 392             return fmt("Never edited");
 393
 394         if ($show_version == 'auto')
 395             $show_version = !$revision->isCurrent();
 396
 397         if ($request->getPref('relativeDates') && ($date = $this->_relativeDay($mtime))) {
 398             if ($this->_showModTime)
 399                 $date =  sprintf(_("%s at %s"),
 400                                  $date, $this->formatTime($mtime));
 401
 402             if ($show_version)
 403                 return fmt("Version %s, saved %s", $revision->getVersion(), $date);
 404             else
 405                 return fmt("Last edited %s", $date);
 406         }
 407
 408         if ($this->_showModTime)
 409             $date = $this->formatDateTime($mtime);
 410         else
 411             $date = $this->formatDate($mtime);
 412
 413         if ($show_version)
 414             return fmt("Version %s, saved on %s", $revision->getVersion(), $date);
 415         else
 416             return fmt("Last edited on %s", $date);
 417     }
 418
 419     function _relativeDay ($time_t) {
 420         global $request;
 421
 422         if (is_numeric($request->getPref('timeOffset')))
 423           $offset = 3600 * $request->getPref('timeOffset');
 424         else
 425           $offset = 0;
 426
 427         $now = time() + $offset;
 428         $today = localtime($now, true);
 429         $time = localtime($time_t + $offset, true);
 430
 431         if ($time['tm_yday'] == $today['tm_yday'] && $time['tm_year'] == $today['tm_year'])
 432             return _("today");
 433
 434         // Note that due to daylight savings chages (and leap seconds), $now minus
 435         // 24 hours is not guaranteed to be yesterday.
 436         $yesterday = localtime($now - (12 + $today['tm_hour']) * 3600, true);
 437         if ($time['tm_yday'] == $yesterday['tm_yday']
 438             and $time['tm_year'] == $yesterday['tm_year'])
 439             return _("yesterday");
 440
 441         return false;
 442     }
 443
 444     /**
 445      * Format the "Author" and "Owner" messages for a page revision.
 446      */
 447     function getOwnerMessage ($page) {
 448         if (!ENABLE_PAGEPERM or !class_exists("PagePermission"))
 449             return '';
 450         $dbi =& $GLOBALS['request']->_dbi;
 451         $owner = $page->getOwner();
 452         if ($owner) {
 453             /*
 454             if ( mayAccessPage('change',$page->getName()) )
 455                 return fmt("Owner: %s", $this->makeActionButton(array('action'=>_("chown"),
 456                                                                       's' => $page->getName()),
 457                                                                 $owner, $page));
 458             */
 459             if ( $dbi->isWikiPage($owner) )
 460                 return fmt("Owner: %s", WikiLink($owner));
 461             else
 462                 return fmt("Owner: %s", '"'.$owner.'"');
 463         }
 464     }
 465
 466     function getAuthorMessage ($revision, $only_authenticated = true) {
 467         if (!$revision) return '';
 468         $dbi =& $GLOBALS['request']->_dbi;
 469         $author = $revision->get('author_id');
 470         if ( $author or $only_authenticated ) {
 471             if (!$author) $author = $revision->get('author');
 472             if (!$author) return '';
 473             if ( $dbi->isWikiPage($author) )
 474                 return fmt("by %s", WikiLink($author));
 475             else
 476                 return fmt("by %s", '"'.$author.'"');
 477         }
 478     }
 479
 480     ////////////////////////////////////////////////////////////////
 481     //
 482     // Hooks for other formatting
 483     //
 484     ////////////////////////////////////////////////////////////////
 485
 486     //FIXME: PHP 4.1 Warnings
 487     //lib/Theme.php:84: Notice[8]: The call_user_method() function is deprecated,
 488     //use the call_user_func variety with the array(&$obj, "method") syntax instead
 489
 490     function getFormatter ($type, $format) {
 491         $method = strtolower("get${type}Formatter");
 492         if (method_exists($this, $method))
 493             return $this->{$method}($format);
 494         return false;
 495     }
 496
 497     ////////////////////////////////////////////////////////////////
 498     //
 499     // Links
 500     //
 501     ////////////////////////////////////////////////////////////////
 502
 503     var $_autosplitWikiWords = false;
 504     function setAutosplitWikiWords($autosplit=true) {
 505         $this->_autosplitWikiWords = $autosplit ? true : false;
 506     }
 507
 508     function maybeSplitWikiWord ($wikiword) {
 509         if ($this->_autosplitWikiWords)
 510             return SplitPagename($wikiword);
 511         else
 512             return $wikiword;
 513     }
 514
 515     var $_anonEditUnknownLinks = true;
 516     function setAnonEditUnknownLinks($anonedit=true) {
 517         $this->_anonEditUnknownLinks = $anonedit ? true : false;
 518     }
 519
 520     function linkExistingWikiWord($wikiword, $linktext = '', $version = false) {
 521         global $request;
 522
 523         if ($version !== false and !$this->HTML_DUMP_SUFFIX)
 524             $url = WikiURL($wikiword, array('version' => $version));
 525         else
 526             $url = WikiURL($wikiword);
 527
 528         // Extra steps for dumping page to an html file.
 529         if ($this->HTML_DUMP_SUFFIX) {
 530             $url = preg_replace('/^\./', '%2e', $url); // dot pages
 531         }
 532
 533         $link = HTML::a(array('href' => $url));
 534
 535         if (isa($wikiword, 'WikiPageName'))
 536              $default_text = $wikiword->shortName;
 537          else
 538              $default_text = $wikiword;
 539
 540         if (!empty($linktext)) {
 541             $link->pushContent($linktext);
 542             $link->setAttr('class', 'named-wiki');
 543             $link->setAttr('title', $this->maybeSplitWikiWord($default_text));
 544         }
 545         else {
 546             $link->pushContent($this->maybeSplitWikiWord($default_text));
 547             $link->setAttr('class', 'wiki');
 548         }
 549         if ($request->getArg('frame'))
 550             $link->setAttr('target', '_top');
 551         return $link;
 552     }
 553
 554     function linkUnknownWikiWord($wikiword, $linktext = '') {
 555         global $request;
 556
 557         // Get rid of anchors on unknown wikiwords
 558         if (isa($wikiword, 'WikiPageName')) {
 559             $default_text = $wikiword->shortName;
 560             $wikiword = $wikiword->name;
 561         }
 562         else {
 563             $default_text = $wikiword;
 564         }
 565
 566         if ($this->DUMP_MODE) { // HTML, PDF or XML
 567             $link = HTML::u( empty($linktext) ? $wikiword : $linktext);
 568             $link->addTooltip(sprintf(_("Empty link to: %s"), $wikiword));
 569             $link->setAttr('class', empty($linktext) ? 'wikiunknown' : 'named-wikiunknown');
 570             return $link;
 571         } else {
 572             // if AnonEditUnknownLinks show "?" only users which are allowed to edit this page
 573             if (! $this->_anonEditUnknownLinks and
 574                 ( ! $request->_user->isSignedIn()
 575                   or ! mayAccessPage('edit', $request->getArg('pagename'))))
 576             {
 577                 $text = HTML::span( empty($linktext) ? $wikiword : $linktext);
 578                 $text->setAttr('class', empty($linktext) ? 'wikiunknown' : 'named-wikiunknown');
 579                 return $text;
 580             } else {
 581                 $url = WikiURL($wikiword, array('action' => 'create'));
 582                 $button = $this->makeButton('?', $url);
 583                 $button->addTooltip(sprintf(_("Create: %s"), $wikiword));
 584             }
 585         }
 586
 587         $link = HTML::span();
 588         if (!empty($linktext)) {
 589             $link->pushContent(HTML::u($linktext));
 590             $link->setAttr('class', 'named-wikiunknown');
 591         }
 592         else {
 593             $link->pushContent(HTML::u($this->maybeSplitWikiWord($default_text)));
 594             $link->setAttr('class', 'wikiunknown');
 595         }
 596         if (!isa($button, "ImageButton"))
 597             $button->setAttr('rel', 'nofollow');
 598         $link->pushContent($button);
 599         if ($request->getPref('googleLink')) {
 600             $gbutton = $this->makeButton('G', "http://www.google.com/search?q="
 601                                          . urlencode($wikiword));
 602             $gbutton->addTooltip(sprintf(_("Google:%s"), $wikiword));
 603             $link->pushContent($gbutton);
 604         }
 605         if ($request->getArg('frame'))
 606             $link->setAttr('target', '_top');
 607
 608         return $link;
 609     }
 610
 611     function linkBadWikiWord($wikiword, $linktext = '') {
 612         global $ErrorManager;
 613
 614         if ($linktext) {
 615             $text = $linktext;
 616         }
 617         elseif (isa($wikiword, 'WikiPageName')) {
 618             $text = $wikiword->shortName;
 619         }
 620         else {
 621             $text = $wikiword;
 622         }
 623
 624         if (isa($wikiword, 'WikiPageName'))
 625             $message = $wikiword->getWarnings();
 626         else
 627             $message = sprintf(_("'%s': Bad page name"), $wikiword);
 628         $ErrorManager->warning($message);
 629
 630         return HTML::span(array('class' => 'badwikiword'), $text);
 631     }
 632
 633     ////////////////////////////////////////////////////////////////
 634     //
 635     // Images and Icons
 636     //
 637     ////////////////////////////////////////////////////////////////
 638     var $_imageAliases = array();
 639     var $_imageAlt = array();
 640
 641     /**
 642      *
 643      * (To disable an image, alias the image to <code>false</code>.
 644      */
 645     function addImageAlias ($alias, $image_name) {
 646         // fall back to the PhpWiki-supplied image if not found
 647         if ($this->_findFile("images/$image_name", true))
 648             $this->_imageAliases[$alias] = $image_name;
 649     }
 650
 651     function addImageAlt ($alias, $alt_text) {
 652         $this->_imageAlt[$alias] = $alt_text;
 653     }
 654     function getImageAlt ($alias) {
 655         return $this->_imageAlt[$alias];
 656     }
 657
 658     function getImageURL ($image) {
 659         $aliases = &$this->_imageAliases;
 660
 661         if (isset($aliases[$image])) {
 662             $image = $aliases[$image];
 663             if (!$image)
 664                 return false;
 665         }
 666
 667         // If not extension, default to .png.
 668         if (!preg_match('/\.\w+$/', $image))
 669             $image .= '.png';
 670
 671         // FIXME: this should probably be made to fall back
 672         //        automatically to .gif, .jpg.
 673         //        Also try .gif before .png if browser doesn't like png.
 674
 675         $path = $this->_findData("images/$image", 'missing okay');
 676         if (!$path) // search explicit images/ or button/ links also
 677             $path = $this->_findData("$image", 'missing okay');
 678
 679         if ($this->DUMP_MODE) {
 680             if (empty($this->dumped_images)) $this->dumped_images = array();
 681             $path = "images/". basename($path);
 682             if (!in_array($path,$this->dumped_images))
 683                 $this->dumped_images[] = $path;
 684         }
 685         return $path;
 686     }
 687
 688     function setLinkIcon($proto, $image = false) {
 689         if (!$image)
 690             $image = $proto;
 691
 692         $this->_linkIcons[$proto] = $image;
 693     }
 694
 695     function getLinkIconURL ($proto) {
 696         $icons = &$this->_linkIcons;
 697         if (!empty($icons[$proto]))
 698             return $this->getImageURL($icons[$proto]);
 699         elseif (!empty($icons['*']))
 700             return $this->getImageURL($icons['*']);
 701         return false;
 702     }
 703
 704     var $_linkIcon = 'front'; // or 'after' or 'no'.
 705     // maybe also 'spanall': there is a scheme currently in effect with front, which
 706     // spans the icon only to the first, to let the next words wrap on line breaks
 707     // see stdlib.php:PossiblyGlueIconToText()
 708     function getLinkIconAttr () {
 709         return $this->_linkIcon;
 710     }
 711     function setLinkIconAttr ($where) {
 712         $this->_linkIcon = $where;
 713     }
 714
 715     function addButtonAlias ($text, $alias = false) {
 716         $aliases = &$this->_buttonAliases;
 717
 718         if (is_array($text))
 719             $aliases = array_merge($aliases, $text);
 720         elseif ($alias === false)
 721             unset($aliases[$text]);
 722         else
 723             $aliases[$text] = $alias;
 724     }
 725
 726     function getButtonURL ($text) {
 727         $aliases = &$this->_buttonAliases;
 728         if (isset($aliases[$text]))
 729             $text = $aliases[$text];
 730
 731         $qtext = urlencode($text);
 732         $url = $this->_findButton("$qtext.png");
 733         if ($url && strstr($url, '%')) {
 734             $url = preg_replace('|([^/]+)$|e', 'urlencode("\\1")', $url);
 735         }
 736         if (!$url) {// Jeff complained about png not supported everywhere.
 737                     // This was not PC until 2005.
 738             $url = $this->_findButton("$qtext.gif");
 739             if ($url && strstr($url, '%')) {
 740                 $url = preg_replace('|([^/]+)$|e', 'urlencode("\\1")', $url);
 741             }
 742         }
 743         if ($url and $this->DUMP_MODE) {
 744             if (empty($this->dumped_buttons)) $this->dumped_buttons = array();
 745             $file = $url;
 746             if (defined('DATA_PATH'))
 747                 $file = substr($url,strlen(DATA_PATH)+1);
 748             $url = "images/buttons/".basename($file);
 749             if (!array_key_exists($text, $this->dumped_buttons))
 750                 $this->dumped_buttons[$text] = $file;
 751         }
 752         return $url;
 753     }
 754
 755     function _findButton ($button_file) {
 756         if (empty($this->_button_path))
 757             $this->_button_path = $this->_getButtonPath();
 758
 759         foreach ($this->_button_path as $dir) {
 760             if ($path = $this->_findData("$dir/$button_file", 1))
 761                 return $path;
 762         }
 763         return false;
 764     }
 765
 766     function _getButtonPath () {
 767         $button_dir = $this->_findFile("buttons");
 768         $path_dir = $this->_path . $button_dir;
 769         if (!file_exists($path_dir) || !is_dir($path_dir))
 770             return array();
 771         $path = array($button_dir);
 772
 773         $dir = dir($path_dir);
 774         while (($subdir = $dir->read()) !== false) {
 775             if ($subdir[0] == '.')
 776                 continue;
 777             if ($subdir == 'CVS')
 778                 continue;
 779             if (is_dir("$path_dir/$subdir"))
 780                 $path[] = "$button_dir/$subdir";
 781         }
 782         $dir->close();
 783         // add default buttons
 784         $path[] = "themes/default/buttons";
 785         $path_dir = $this->_path . "themes/default/buttons";
 786         $dir = dir($path_dir);
 787         while (($subdir = $dir->read()) !== false) {
 788             if ($subdir[0] == '.')
 789                 continue;
 790             if ($subdir == 'CVS')
 791                 continue;
 792             if (is_dir("$path_dir/$subdir"))
 793                 $path[] = "themes/default/buttons/$subdir";
 794         }
 795         $dir->close();
 796
 797         return $path;
 798     }
 799
 800     ////////////////////////////////////////////////////////////////
 801     //
 802     // Button style
 803     //
 804     ////////////////////////////////////////////////////////////////
 805
 806     function makeButton ($text, $url, $class = false) {
 807         // FIXME: don't always try for image button?
 808
 809         // Special case: URLs like 'submit:preview' generate form
 810         // submission buttons.
 811         if (preg_match('/^submit:(.*)$/', $url, $m))
 812             return $this->makeSubmitButton($text, $m[1], $class);
 813
 814         $imgurl = $this->getButtonURL($text);
 815         if ($imgurl)
 816             return new ImageButton($text, $url, $class, $imgurl);
 817         else
 818             return new Button($this->maybeSplitWikiWord($text), $url, $class);
 819     }
 820
 821     function makeSubmitButton ($text, $name, $class = false) {
 822         $imgurl = $this->getButtonURL($text);
 823
 824         if ($imgurl)
 825             return new SubmitImageButton($text, $name, $class, $imgurl);
 826         else
 827             return new SubmitButton($text, $name, $class);
 828     }
 829
 830     /**
 831      * Make button to perform action.
 832      *
 833      * This constructs a button which performs an action on the
 834      * currently selected version of the current page.
 835      * (Or anotherpage or version, if you want...)
 836      *
 837      * @param $action string The action to perform (e.g. 'edit', 'lock').
 838      * This can also be the name of an "action page" like 'LikePages'.
 839      * Alternatively you can give a hash of query args to be applied
 840      * to the page.
 841      *
 842      * @param $label string Textual label for the button.  If left empty,
 843      * a suitable name will be guessed.
 844      *
 845      * @param $page_or_rev mixed  The page to link to.  This can be
 846      * given as a string (the page name), a WikiDB_Page object, or as
 847      * WikiDB_PageRevision object.  If given as a WikiDB_PageRevision
 848      * object, the button will link to a specific version of the
 849      * designated page, otherwise the button links to the most recent
 850      * version of the page.
 851      *
 852      * @return object A Button object.
 853      */
 854     function makeActionButton ($action, $label = false, $page_or_rev = false) {
 855         extract($this->_get_name_and_rev($page_or_rev));
 856
 857         if (is_array($action)) {
 858             $attr = $action;
 859             $action = isset($attr['action']) ? $attr['action'] : 'browse';
 860         }
 861         else
 862             $attr['action'] = $action;
 863
 864         $class = is_safe_action($action) ? 'wikiaction' : 'wikiadmin';
 865         if ( !$label )
 866             $label = $this->_labelForAction($action);
 867
 868         if ($version)
 869             $attr['version'] = $version;
 870
 871         if ($action == 'browse')
 872             unset($attr['action']);
 873
 874         return $this->makeButton($label, WikiURL($pagename, $attr), $class);
 875     }
 876
 877     /**
 878      * Make a "button" which links to a wiki-page.
 879      *
 880      * These are really just regular WikiLinks, possibly
 881      * disguised (e.g. behind an image button) by the theme.
 882      *
 883      * This method should probably only be used for links
 884      * which appear in page navigation bars, or similar places.
 885      *
 886      * Use linkExistingWikiWord, or LinkWikiWord for normal links.
 887      *
 888      * @param $page_or_rev mixed The page to link to.  This can be
 889      * given as a string (the page name), a WikiDB_Page object, or as
 890      * WikiDB_PageRevision object.  If given as a WikiDB_PageRevision
 891      * object, the button will link to a specific version of the
 892      * designated page, otherwise the button links to the most recent
 893      * version of the page.
 894      *
 895      * @return object A Button object.
 896      */
 897     function makeLinkButton ($page_or_rev, $label = false, $action = false) {
 898         extract($this->_get_name_and_rev($page_or_rev));
 899
 900         $args = $version ? array('version' => $version) : false;
 901         if ($action) $args['action'] = $action;
 902
 903         return $this->makeButton($label ? $label : $pagename,
 904                                  WikiURL($pagename, $args), 'wiki');
 905     }
 906
 907     function _get_name_and_rev ($page_or_rev) {
 908         $version = false;
 909
 910         if (empty($page_or_rev)) {
 911             global $request;
 912             $pagename = $request->getArg("pagename");
 913             $version = $request->getArg("version");
 914         }
 915         elseif (is_object($page_or_rev)) {
 916             if (isa($page_or_rev, 'WikiDB_PageRevision')) {
 917                 $rev = $page_or_rev;
 918                 $page = $rev->getPage();
 919                 if (!$rev->isCurrent()) $version = $rev->getVersion();
 920             }
 921             else {
 922                 $page = $page_or_rev;
 923             }
 924             $pagename = $page->getName();
 925         }
 926         elseif (is_numeric($page_or_rev)) {
 927             $version = $page_or_rev;
 928         }
 929         else {
 930             $pagename = (string) $page_or_rev;
 931         }
 932         return compact('pagename', 'version');
 933     }
 934
 935     function _labelForAction ($action) {
 936         switch ($action) {
 937             case 'edit':   return _("Edit");
 938             case 'diff':   return _("Diff");
 939             case 'logout': return _("Sign Out");
 940             case 'login':  return _("Sign In");
 941             case 'lock':   return _("Lock Page");
 942             case 'unlock': return _("Unlock Page");
 943             case 'remove': return _("Remove Page");
 944             default:
 945                 // I don't think the rest of these actually get used.
 946                 // 'setprefs'
 947                 // 'upload' 'dumpserial' 'loadfile' 'zip'
 948                 // 'save' 'browse'
 949                 return gettext(ucfirst($action));
 950         }
 951     }
 952
 953     //----------------------------------------------------------------
 954     var $_buttonSeparator = "\n | ";
 955
 956     function setButtonSeparator($separator) {
 957         $this->_buttonSeparator = $separator;
 958     }
 959
 960     function getButtonSeparator() {
 961         return $this->_buttonSeparator;
 962     }
 963
 964
 965     ////////////////////////////////////////////////////////////////
 966     //
 967     // CSS
 968     //
 969     // Notes:
 970     //
 971     // Based on testing with Galeon 1.2.7 (Mozilla 1.2):
 972     // Automatic media-based style selection (via <link> tags) only
 973     // seems to work for the default style, not for alternate styles.
 974     //
 975     // Doing
 976     //
 977     //  <link rel="stylesheet" type="text/css" href="phpwiki.css" />
 978     //  <link rel="stylesheet" type="text/css" href="phpwiki-printer.css" media="print" />
 979     //
 980     // works to make it so that the printer style sheet get used
 981     // automatically when printing (or print-previewing) a page
 982     // (but when only when the default style is selected.)
 983     //
 984     // Attempts like:
 985     //
 986     //  <link rel="alternate stylesheet" title="Modern"
 987     //        type="text/css" href="phpwiki-modern.css" />
 988     //  <link rel="alternate stylesheet" title="Modern"
 989     //        type="text/css" href="phpwiki-printer.css" media="print" />
 990     //
 991     // Result in two "Modern" choices when trying to select alternate style.
 992     // If one selects the first of those choices, one gets phpwiki-modern
 993     // both when browsing and printing.  If one selects the second "Modern",
 994     // one gets no CSS when browsing, and phpwiki-printer when printing.
 995     //
 996     // The Real Fix?
 997     // =============
 998     //
 999     // We should probably move to doing the media based style
1000     // switching in the CSS files themselves using, e.g.:
1001     //
1002     //  @import url(print.css) print;
1003     //
1004     ////////////////////////////////////////////////////////////////
1005
1006     function _CSSlink($title, $css_file, $media, $is_alt = false) {
1007         // Don't set title on default style.  This makes it clear to
1008         // the user which is the default (i.e. most supported) style.
1009         if ($is_alt and isBrowserKonqueror())
1010             return HTML();
1011         $link = HTML::link(array('rel'     => $is_alt ? 'alternate stylesheet' : 'stylesheet',
1012                                  'type'    => 'text/css',
1013                                  'charset' => $GLOBALS['charset'],
1014                                  'href'    => $this->_findData($css_file)));
1015         if ($is_alt)
1016             $link->setAttr('title', $title);
1017
1018         if ($media)
1019             $link->setAttr('media', $media);
1020         if ($this->DUMP_MODE) {
1021             if (empty($this->dumped_css)) $this->dumped_css = array();
1022             if (!in_array($css_file,$this->dumped_css)) $this->dumped_css[] = $css_file;
1023             $link->setAttr('href', basename($link->getAttr('href')));
1024         }
1025
1026         return $link;
1027     }
1028
1029     /** Set default CSS source for this theme.
1030      *
1031      * To set styles to be used for different media, pass a
1032      * hash for the second argument, e.g.
1033      *
1034      * $theme->setDefaultCSS('default', array('' => 'normal.css',
1035      *                                        'print' => 'printer.css'));
1036      *
1037      * If you call this more than once, the last one called takes
1038      * precedence as the default style.
1039      *
1040      * @param string $title Name of style (currently ignored, unless
1041      * you call this more than once, in which case, some of the style
1042      * will become alternate (rather than default) styles, and then their
1043      * titles will be used.
1044      *
1045      * @param mixed $css_files Name of CSS file, or hash containing a mapping
1046      * between media types and CSS file names.  Use a key of '' (the empty string)
1047      * to set the default CSS for non-specified media.  (See above for an example.)
1048      */
1049     function setDefaultCSS ($title, $css_files) {
1050         if (!is_array($css_files))
1051             $css_files = array('' => $css_files);
1052         // Add to the front of $this->_css
1053         unset($this->_css[$title]);
1054         $this->_css = array_merge(array($title => $css_files), $this->_css);
1055     }
1056
1057     /** Set alternate CSS source for this theme.
1058      *
1059      * @param string $title Name of style.
1060      * @param string $css_files Name of CSS file.
1061      */
1062     function addAlternateCSS ($title, $css_files) {
1063         if (!is_array($css_files))
1064             $css_files = array('' => $css_files);
1065         $this->_css[$title] = $css_files;
1066     }
1067
1068     /**
1069      * @return string HTML for CSS.
1070      */
1071     function getCSS () {
1072         $css = array();
1073         $is_alt = false;
1074         foreach ($this->_css as $title => $css_files) {
1075             ksort($css_files); // move $css_files[''] to front.
1076             foreach ($css_files as $media => $css_file) {
1077                 $css[] = $this->_CSSlink($title, $css_file, $media, $is_alt);
1078                 if ($is_alt) break;
1079
1080             }
1081             $is_alt = true;
1082         }
1083         return HTML($css);
1084     }
1085
1086     function findTemplate ($name) {
1087         if ($tmp = $this->_findFile("templates/$name.tmpl", 1))
1088             return $this->_path . $tmp;
1089         else {
1090             $f1 = $this->file("templates/$name.tmpl");
1091             trigger_error("pwd: ".getcwd(), E_USER_ERROR);
1092             if (isset($this->_default_theme)) {
1093                $f2 = $this->_default_theme->file("templates/$name.tmpl");
1094                trigger_error("$f1 nor $f2 found", E_USER_ERROR);
1095             } else
1096                trigger_error("$f1 not found", E_USER_ERROR);
1097             return false;
1098         }
1099     }
1100
1101     var $_MoreHeaders = array();
1102     function addMoreHeaders ($element) {
1103         array_push($this->_MoreHeaders, $element);
1104     }
1105     function getMoreHeaders () {
1106         if (empty($this->_MoreHeaders))
1107             return '';
1108         $out = '';
1109         //$out = "<!-- More Headers -->\n";
1110         foreach ($this->_MoreHeaders as $h) {
1111             if (is_object($h))
1112                 $out .= printXML($h);
1113             else
1114                 $out .= "$h\n";
1115         }
1116         return $out;
1117     }
1118
1119     var $_MoreAttr = array();
1120     // new arg: named elements to be able to remove them. such as DoubleClickEdit for htmldumps
1121     function addMoreAttr ($tag, $name, $element) {
1122         // protect from duplicate attr (body jscript: themes, prefs, ...)
1123         static $_attr_cache = array();
1124         $hash = md5($tag."/".$element);
1125         if (!empty($_attr_cache[$hash])) return;
1126         $_attr_cache[$hash] = 1;
1127
1128         if (empty($this->_MoreAttr) or !is_array($this->_MoreAttr[$tag]))
1129             $this->_MoreAttr[$tag] = array($name => $element);
1130         else
1131             $this->_MoreAttr[$tag][$name] = $element;
1132     }
1133
1134     function getMoreAttr ($tag) {
1135         if (empty($this->_MoreAttr[$tag]))
1136             return '';
1137         $out = '';
1138         foreach ($this->_MoreAttr[$tag] as $name => $element) {
1139             if (is_object($element))
1140                 $out .= printXML($element);
1141             else
1142                 $out .= "$element";
1143         }
1144         return $out;
1145     }
1146
1147     /**
1148      * Custom UserPreferences:
1149      * A list of name => _UserPreference class pairs.
1150      * Rationale: Certain themes should be able to extend the predefined list
1151      * of preferences. Display/editing is done in the theme specific userprefs.tmpl
1152      * but storage/sanification/update/... must be extended to the Get/SetPreferences methods.
1153      * These values are just ignored if another theme is used.
1154      */
1155     function customUserPreferences($array) {
1156         global $customUserPreferenceColumns; // FIXME: really a global?
1157         if (empty($customUserPreferenceColumns)) $customUserPreferenceColumns = array();
1158         //array('wikilens' => new _UserPreference_wikilens());
1159         foreach ($array as $field => $prefobj) {
1160             $customUserPreferenceColumns[$field] = $prefobj;
1161         }
1162     }
1163
1164     /** addPageListColumn(array('rating' => new _PageList_Column_rating('rating', _("Rate"))))
1165      *  Register custom PageList types for special themes, like
1166      *  'rating' for wikilens
1167      */
1168     function addPageListColumn ($array) {
1169         global $customPageListColumns;
1170         if (empty($customPageListColumns)) $customPageListColumns = array();
1171         foreach ($array as $column => $obj) {
1172             $customPageListColumns[$column] = $obj;
1173         }
1174     }
1175
1176     // Works only on action=browse. Patch #970004 by pixels
1177     // Usage: call $WikiTheme->initDoubleClickEdit() from theme init or
1178     // define ENABLE_DOUBLECLICKEDIT
1179     function initDoubleClickEdit() {
1180         if (!$this->HTML_DUMP_SUFFIX)
1181             $this->addMoreAttr('body', 'DoubleClickEdit', HTML::Raw(" ondblclick=\"url = document.URL; url2 = url; if (url.indexOf('?') != -1) url2 = url.slice(0, url.indexOf('?')); if ((url.indexOf('action') == -1) || (url.indexOf('action=browse') != -1)) document.location = url2 + '?action=edit';\""));
1182     }
1183
1184     // Immediate title search results via XMLHTML(HttpRequest
1185     // by Bitflux GmbH, bitflux.ch. You need to install the livesearch.js seperately.
1186     // Google's or acdropdown is better.
1187     function initLiveSearch() {
1188         if (!$this->HTML_DUMP_SUFFIX) {
1189             $this->addMoreAttr('body', 'LiveSearch',
1190                                HTML::Raw(" onload=\"liveSearchInit()"));
1191             $this->addMoreHeaders(JavaScript('var liveSearchURI="'
1192                                              .WikiURL(_("TitleSearch"),false,true).'";'));
1193             $this->addMoreHeaders(JavaScript('', array
1194                                              ('src' => $this->_findData('livesearch.js'))));
1195         }
1196     }
1197
1198     // Immediate title search results via XMLHttpRequest
1199     // using the shipped moacdropdown js-lib
1200     function initMoAcDropDown() {
1201         if (!$this->HTML_DUMP_SUFFIX) {
1202             $dir = $this->_findData('moacdropdown');
1203             // if autocomplete_remote is used:
1204             foreach (array("mobrowser.js","modomevent.js","modomt.js",
1205                            "modomext.js","xmlextras.js") as $js)
1206             {
1207                 $this->addMoreHeaders(JavaScript('', array('src' => "$dir/js/$js")));
1208             }
1209             $this->addMoreHeaders(JavaScript('', array('src' => "$dir/js/acdropdown.js")));
1210             //$this->addMoreHeaders($this->_CSSlink(0,
1211             //                      $this->_findFile('moacdropdown/css/dropdown.css'), 'all'));
1212             $this->addMoreHeaders(HTML::style("  @import url( $dir/css/dropdown.css );\n"));
1213         }
1214     }
1215 };
1216
1217
1218 /**
1219  * A class representing a clickable "button".
1220  *
1221  * In it's simplest (default) form, a "button" is just a link associated
1222  * with some sort of wiki-action.
1223  */
1224 class Button extends HtmlElement {
1225     /** Constructor
1226      *
1227      * @param $text string The text for the button.
1228      * @param $url string The url (href) for the button.
1229      * @param $class string The CSS class for the button.
1230      */
1231     function Button ($text, $url, $class = false) {
1232         global $request;
1233         //php5 workaround
1234         if (check_php_version(5)) {
1235             $this->_init('a', array('href' => $url));
1236         } else {
1237             $this->__construct('a', array('href' => $url));
1238         }
1239         if ($class)
1240             $this->setAttr('class', $class);
1241         if ($request->getArg('frame'))
1242             $this->setAttr('target', '_top');
1243         // Google honors this
1244         if (in_array(strtolower($text), array('edit','create','diff','pdf'))
1245             and !$request->_user->isAuthenticated())
1246             $this->setAttr('rel', 'nofollow');
1247         $this->pushContent($GLOBALS['WikiTheme']->maybeSplitWikiWord($text));
1248     }
1249
1250 };
1251
1252
1253 /**
1254  * A clickable image button.
1255  */
1256 class ImageButton extends Button {
1257     /** Constructor
1258      *
1259      * @param $text string The text for the button.
1260      * @param $url string The url (href) for the button.
1261      * @param $class string The CSS class for the button.
1262      * @param $img_url string URL for button's image.
1263      * @param $img_attr array Additional attributes for the &lt;img&gt; tag.
1264      */
1265     function ImageButton ($text, $url, $class, $img_url, $img_attr = false) {
1266         $this->__construct('a', array('href' => $url));
1267         if ($class)
1268             $this->setAttr('class', $class);
1269         // Google honors this
1270         if (in_array(strtolower($text), array('edit','create','diff','pdf'))
1271             and !$GLOBALS['request']->_user->isAuthenticated())
1272             $this->setAttr('rel', 'nofollow');
1273
1274         if (!is_array($img_attr))
1275             $img_attr = array();
1276         $img_attr['src'] = $img_url;
1277         $img_attr['alt'] = $text;
1278         $img_attr['class'] = 'wiki-button';
1279         $img_attr['border'] = 0;
1280         $this->pushContent(HTML::img($img_attr));
1281     }
1282 };
1283
1284 /**
1285  * A class representing a form <samp>submit</samp> button.
1286  */
1287 class SubmitButton extends HtmlElement {
1288     /** Constructor
1289      *
1290      * @param $text string The text for the button.
1291      * @param $name string The name of the form field.
1292      * @param $class string The CSS class for the button.
1293      */
1294     function SubmitButton ($text, $name = false, $class = false) {
1295         $this->__construct('input', array('type' => 'submit',
1296                                           'value' => $text));
1297         if ($name)
1298             $this->setAttr('name', $name);
1299         if ($class)
1300             $this->setAttr('class', $class);
1301     }
1302
1303 };
1304
1305
1306 /**
1307  * A class representing an image form <samp>submit</samp> button.
1308  */
1309 class SubmitImageButton extends SubmitButton {
1310     /** Constructor
1311      *
1312      * @param $text string The text for the button.
1313      * @param $name string The name of the form field.
1314      * @param $class string The CSS class for the button.
1315      * @param $img_url string URL for button's image.
1316      * @param $img_attr array Additional attributes for the &lt;img&gt; tag.
1317      */
1318     function SubmitImageButton ($text, $name = false, $class = false, $img_url) {
1319         $this->__construct('input', array('type'  => 'image',
1320                                           'src'   => $img_url,
1321                                           'value' => $text,
1322                                           'alt'   => $text));
1323         if ($name)
1324             $this->setAttr('name', $name);
1325         if ($class)
1326             $this->setAttr('class', $class);
1327     }
1328
1329 };
1330
1331 /**
1332  * A sidebar box with title and body, narrow fixed-width.
1333  * To represent abbrevated content of plugins, links or forms,
1334  * like "Getting Started", "Search", "Sarch Pagename",
1335  * "Login", "Menu", "Recent Changes", "Last comments", "Last Blogs"
1336  * "Calendar"
1337  * ... See http://tikiwiki.org/
1338  *
1339  * Usage:
1340  * sidebar.tmpl:
1341  *   $menu = SidebarBox("Menu",HTML::dl(HTML::dt(...))); $menu->format();
1342  *   $menu = PluginSidebarBox("RecentChanges",array('limit'=>10)); $menu->format();
1343  */
1344 class SidebarBox {
1345
1346     function SidebarBox($title, $body) {
1347         require_once('lib/WikiPlugin.php');
1348         $this->title = $title;
1349         $this->body = $body;
1350     }
1351     function format() {
1352         return WikiPlugin::makeBox($this->title, $this->body);
1353     }
1354 }
1355
1356 /**
1357  * A sidebar box for plugins.
1358  * Any plugin may provide a box($args=false, $request=false, $basepage=false)
1359  * method, with the help of WikiPlugin::makeBox()
1360  */
1361 class PluginSidebarBox extends SidebarBox {
1362
1363     var $_plugin, $_args = false, $_basepage = false;
1364
1365     function PluginSidebarBox($name, $args = false, $basepage = false) {
1366         $loader = new WikiPluginLoader();
1367         $plugin = $loader->getPlugin($name);
1368         if (!$plugin) {
1369             return $loader->_error(sprintf(_("Plugin %s: undefined"),
1370                                           $name));
1371         }/*
1372         if (!method_exists($plugin, 'box')) {
1373             return $loader->_error(sprintf(_("%s: has no box method"),
1374                                            get_class($plugin)));
1375         }*/
1376         $this->_plugin   =& $plugin;
1377         $this->_args     = $args ? $args : array();
1378         $this->_basepage = $basepage;
1379     }
1380
1381     function format($args = false) {
1382         return $this->_plugin->box($args ? array_merge($this->_args, $args) : $this->_args,
1383                                    $GLOBALS['request'],
1384                                    $this->_basepage);
1385     }
1386 }
1387
1388 // Various boxes which are no plugins
1389 class RelatedLinksBox extends SidebarBox {
1390     function RelatedLinksBox($title = false, $body = '', $limit = 20) {
1391         global $request;
1392         $this->title = $title ? $title : _("Related Links");
1393         $this->body = HTML($body);
1394         $page = $request->getPage($request->getArg('pagename'));
1395         $revision = $page->getCurrentRevision();
1396         $page_content = $revision->getTransformedContent();
1397         //$cache = &$page->_wikidb->_cache;
1398         $counter = 0;
1399         $sp = HTML::Raw('&middot; ');
1400         foreach ($page_content->getWikiPageLinks() as $link) {
1401             if (!$request->_dbi->isWikiPage($link)) continue;
1402             $this->body->pushContent($sp, WikiLink($link), HTML::br());
1403             $counter++;
1404             if ($limit and $counter > $limit) continue;
1405         }
1406     }
1407 }
1408
1409 class RelatedExternalLinksBox extends SidebarBox {
1410     function RelatedExternalLinksBox($title = false, $body = '', $limit = 20) {
1411         global $request;
1412         $this->title = $title ? $title : _("External Links");
1413         $this->body = HTML($body);
1414         $page = $request->getPage($request->getArg('pagename'));
1415         $cache = &$page->_wikidb->_cache;
1416         $counter = 0;
1417         $sp = HTML::Raw('&middot; ');
1418         foreach ($cache->getWikiPageLinks() as $link) {
1419             if ($link) {
1420                 $this->body->pushContent($sp, WikiLink($link), HTML::br());
1421                 $counter++;
1422                 if ($limit and $counter > $limit) continue;
1423             }
1424         }
1425     }
1426 }
1427
1428 function listAvailableThemes() {
1429     $available_themes = array();
1430     $dir_root = 'themes';
1431     if (defined('PHPWIKI_DIR'))
1432         $dir_root = PHPWIKI_DIR . "/$dir_root";
1433     $dir = dir($dir_root);
1434     if ($dir) {
1435         while($entry = $dir->read()) {
1436             if (is_dir($dir_root.'/'.$entry)
1437                 && (substr($entry,0,1) != '.')
1438                 && $entry != 'CVS') {
1439                 array_push($available_themes, $entry);
1440             }
1441         }
1442         $dir->close();
1443     }
1444     return $available_themes;
1445 }
1446
1447 function listAvailableLanguages() {
1448     $available_languages = array('en');
1449     $dir_root = 'locale';
1450     if (defined('PHPWIKI_DIR'))
1451         $dir_root = PHPWIKI_DIR . "/$dir_root";
1452     if ($dir = dir($dir_root)) {
1453         while($entry = $dir->read()) {
1454             if (is_dir($dir_root."/".$entry)
1455                 && (substr($entry,0,1) != '.')
1456                 && $entry != 'po'
1457                 && $entry != 'CVS')
1458             {
1459                 array_push($available_languages, $entry);
1460             }
1461         }
1462         $dir->close();
1463     }
1464     return $available_languages;
1465 }
1466
1467 // $Log: not supported by cvs2svn $
1468 // Revision 1.131  2005/06/10 06:09:06  rurban
1469 // enable getPref('doubleClickEdit')
1470 //
1471 // Revision 1.130  2005/05/06 16:43:35  rurban
1472 // split long lines
1473 //
1474 // Revision 1.129  2005/05/05 08:57:26  rurban
1475 // support action=revert
1476 //
1477 // Revision 1.128  2005/04/23 11:23:49  rurban
1478 // improve semantics in the setAutosplitWikiWords method: switch to true if no args
1479 //
1480 // Revision 1.127  2005/02/11 14:45:44  rurban
1481 // support ENABLE_LIVESEARCH, enable PDO sessions
1482 //
1483 // Revision 1.126  2005/02/04 11:43:18  rurban
1484 // update comments
1485 //
1486 // Revision 1.125  2005/02/03 05:09:56  rurban
1487 // livesearch.js support
1488 //
1489 // Revision 1.124  2005/01/27 16:28:15  rurban
1490 // especially for Google: nofollow on unauthenticated edit,diff,create,pdf
1491 //
1492 // Revision 1.123  2005/01/25 07:03:02  rurban
1493 // change addMoreAttr() to support named attr, to remove DoubleClickEdit for htmldumps
1494 //
1495 // Revision 1.122  2005/01/21 11:51:22  rurban
1496 // changed (c)
1497 //
1498 // Revision 1.121  2005/01/20 10:14:37  rurban
1499 // rel=nofollow on edit/create page links
1500 //
1501 // Revision 1.120  2004/12/20 13:20:23  rurban
1502 // fix problem described in patch #1088131. SidebarBox may be used before lib/WikiPlugin.php
1503 // is loaded.
1504 //
1505 // Revision 1.119  2004/12/14 21:38:12  rurban
1506 // just aesthetics
1507 //
1508 // Revision 1.118  2004/12/13 14:34:46  rurban
1509 // box parent method exists
1510 //
1511 // Revision 1.117  2004/11/30 17:44:54  rurban
1512 // revisison neutral
1513 //
1514 // Revision 1.116  2004/11/21 11:59:16  rurban
1515 // remove final \n to be ob_cache independent
1516 //
1517 // Revision 1.115  2004/11/17 17:24:02  rurban
1518 // more verbose on fatal template not found
1519 //
1520 // Revision 1.114  2004/11/11 18:31:26  rurban
1521 // add simple backtrace on such general failures to get at least an idea where
1522 //
1523 // Revision 1.113  2004/11/09 17:11:04  rurban
1524 // * revert to the wikidb ref passing. there's no memory abuse there.
1525 // * use new wikidb->_cache->_id_cache[] instead of wikidb->_iwpcache, to effectively
1526 //   store page ids with getPageLinks (GleanDescription) of all existing pages, which
1527 //   are also needed at the rendering for linkExistingWikiWord().
1528 //   pass options to pageiterator.
1529 //   use this cache also for _get_pageid()
1530 //   This saves about 8 SELECT count per page (num all pagelinks).
1531 // * fix passing of all page fields to the pageiterator.
1532 // * fix overlarge session data which got broken with the latest ACCESS_LOG_SQL changes
1533 //
1534 // Revision 1.112  2004/11/03 16:50:31  rurban
1535 // some new defaults and constants, renamed USE_DOUBLECLICKEDIT to ENABLE_DOUBLECLICKEDIT
1536 //
1537 // Revision 1.111  2004/10/21 20:20:53  rurban
1538 // From patch #970004 "Double clic to edit" by pixels.
1539 //
1540 // Revision 1.110  2004/10/15 11:05:10  rurban
1541 // fix yesterdays premature dumphtml fix for $default_text (thanks John Shen)
1542 //
1543 // Revision 1.109  2004/10/14 21:06:02  rurban
1544 // fix dumphtml with USE_PATH_INFO (again). fix some PageList refs
1545 //
1546 // Revision 1.108  2004/09/26 12:24:02  rurban
1547 // no anchor (PCRE memory), explicit ^ instead
1548 //
1549 // Revision 1.107  2004/06/21 16:22:29  rurban
1550 // add DEFAULT_DUMP_DIR and HTML_DUMP_DIR constants, for easier cmdline dumps,
1551 // fixed dumping buttons locally (images/buttons/),
1552 // support pages arg for dumphtml,
1553 // optional directory arg for dumpserial + dumphtml,
1554 // fix a AllPages warning,
1555 // show dump warnings/errors on DEBUG,
1556 // don't warn just ignore on wikilens pagelist columns, if not loaded.
1557 // RateIt pagelist column is called "rating", not "ratingwidget" (Dan?)
1558 //
1559 // Revision 1.106  2004/06/20 14:42:54  rurban
1560 // various php5 fixes (still broken at blockparser)
1561 //
1562 // Revision 1.105  2004/06/14 11:31:36  rurban
1563 // renamed global $Theme to $WikiTheme (gforge nameclash)
1564 // inherit PageList default options from PageList
1565 //   default sortby=pagename
1566 // use options in PageList_Selectable (limit, sortby, ...)
1567 // added action revert, with button at action=diff
1568 // added option regex to WikiAdminSearchReplace
1569 //
1570 // Revision 1.104  2004/06/11 09:07:30  rurban
1571 // support theme-specific LinkIconAttr: front or after or none
1572 //
1573 // Revision 1.103  2004/06/07 22:44:14  rurban
1574 // added simplified chown, setacl actions
1575 //
1576 // Revision 1.102  2004/06/07 18:59:28  rurban
1577 // added Chown link to Owner in statusbar
1578 //
1579 // Revision 1.101  2004/06/03 12:59:40  rurban
1580 // simplify translation
1581 // NS4 wrap=virtual only
1582 //
1583 // Revision 1.100  2004/06/03 10:18:19  rurban
1584 // fix FileUser locking issues, new config ENABLE_PAGEPERM
1585 //
1586 // Revision 1.99  2004/06/01 15:27:59  rurban
1587 // AdminUser only ADMIN_USER not member of Administrators
1588 // some RateIt improvements by dfrankow
1589 // edit_toolbar buttons
1590 //
1591 // Revision 1.98  2004/05/27 17:49:05  rurban
1592 // renamed DB_Session to DbSession (in CVS also)
1593 // added WikiDB->getParam and WikiDB->getAuthParam method to get rid of globals
1594 // remove leading slash in error message
1595 // added force_unlock parameter to File_Passwd (no return on stale locks)
1596 // fixed adodb session AffectedRows
1597 // added FileFinder helpers to unify local filenames and DATA_PATH names
1598 // editpage.php: new edit toolbar javascript on ENABLE_EDIT_TOOLBAR
1599 //
1600 // Revision 1.97  2004/05/18 16:23:39  rurban
1601 // rename split_pagename to SplitPagename
1602 //
1603 // Revision 1.96  2004/05/13 13:48:34  rurban
1604 // doc update for the new 1.3.10 release
1605 //
1606 // Revision 1.94  2004/05/13 11:52:34  rurban
1607 // search also default buttons
1608 //
1609 // Revision 1.93  2004/05/12 10:49:55  rurban
1610 // require_once fix for those libs which are loaded before FileFinder and
1611 //   its automatic include_path fix, and where require_once doesn't grok
1612 //   dirname(__FILE__) != './lib'
1613 // upgrade fix with PearDB
1614 // navbar.tmpl: remove spaces for IE &nbsp; button alignment
1615 //
1616 // Revision 1.92  2004/05/03 21:57:47  rurban
1617 // locale updates: we previously lost some words because of wrong strings in
1618 //   PhotoAlbum, german rewording.
1619 // fixed $_SESSION registering (lost session vars, esp. prefs)
1620 // fixed ending slash in listAvailableLanguages/Themes
1621 //
1622 // Revision 1.91  2004/05/03 11:40:42  rurban
1623 // put listAvailableLanguages() and listAvailableThemes() from SystemInfo and
1624 // UserPreferences into Themes.php
1625 //
1626 // Revision 1.90  2004/05/02 19:12:14  rurban
1627 // fix sf.net bug #945154 Konqueror alt css
1628 //
1629 // Revision 1.89  2004/04/29 21:25:45  rurban
1630 // default theme navbar consistency: linkButtons instead of action buttons
1631 //   3rd makeLinkButtin arg for action support
1632 //
1633 // Revision 1.88  2004/04/19 18:27:45  rurban
1634 // Prevent from some PHP5 warnings (ref args, no :: object init)
1635 //   php5 runs now through, just one wrong XmlElement object init missing
1636 // Removed unneccesary UpgradeUser lines
1637 // Changed WikiLink to omit version if current (RecentChanges)
1638 //
1639 // Revision 1.87  2004/04/19 09:13:23  rurban
1640 // new pref: googleLink
1641 //
1642 // Revision 1.86  2004/04/18 01:11:51  rurban
1643 // more numeric pagename fixes.
1644 // fixed action=upload with merge conflict warnings.
1645 // charset changed from constant to global (dynamic utf-8 switching)
1646 //
1647 // Revision 1.85  2004/04/12 13:04:50  rurban
1648 // added auth_create: self-registering Db users
1649 // fixed IMAP auth
1650 // removed rating recommendations
1651 // ziplib reformatting
1652 //
1653 // Revision 1.84  2004/04/10 02:30:49  rurban
1654 // Fixed gettext problem with VIRTUAL_PATH scripts (Windows only probably)
1655 // Fixed "cannot setlocale..." (sf.net problem)
1656 //
1657 // Revision 1.83  2004/04/09 17:49:03  rurban
1658 // Added PhpWiki RssFeed to Sidebar
1659 // sidebar formatting
1660 // some browser dependant fixes (old-browser support)
1661 //
1662 // Revision 1.82  2004/04/06 20:00:10  rurban
1663 // Cleanup of special PageList column types
1664 // Added support of plugin and theme specific Pagelist Types
1665 // Added support for theme specific UserPreferences
1666 // Added session support for ip-based throttling
1667 //   sql table schema change: ALTER TABLE session ADD sess_ip CHAR(15);
1668 // Enhanced postgres schema
1669 // Added DB_Session_dba support
1670 //
1671 // Revision 1.81  2004/04/01 15:57:10  rurban
1672 // simplified Sidebar theme: table, not absolute css positioning
1673 // added the new box methods.
1674 // remaining problems: large left margin, how to override _autosplitWikiWords in Template only
1675 //
1676 // Revision 1.80  2004/03/30 02:14:03  rurban
1677 // fixed yet another Prefs bug
1678 // added generic PearDb_iter
1679 // $request->appendValidators no so strict as before
1680 // added some box plugin methods
1681 // PageList commalist for condensed output
1682 //
1683 // Revision 1.79  2004/03/24 19:39:02  rurban
1684 // php5 workaround code (plus some interim debugging code in XmlElement)
1685 //   php5 doesn't work yet with the current XmlElement class constructors,
1686 //   WikiUserNew does work better than php4.
1687 // rewrote WikiUserNew user upgrading to ease php5 update
1688 // fixed pref handling in WikiUserNew
1689 // added Email Notification
1690 // added simple Email verification
1691 // removed emailVerify userpref subclass: just a email property
1692 // changed pref binary storage layout: numarray => hash of non default values
1693 // print optimize message only if really done.
1694 // forced new cookie policy: delete pref cookies, use only WIKI_ID as plain string.
1695 //   prefs should be stored in db or homepage, besides the current session.
1696 //
1697 // Revision 1.78  2004/03/18 22:32:33  rurban
1698 // work to make it php5 compatible
1699 //
1700 // Revision 1.77  2004/03/08 19:30:01  rurban
1701 // fixed Theme->getButtonURL
1702 // AllUsers uses now WikiGroup (also DB User and DB Pref users)
1703 // PageList fix for empty pagenames
1704 //
1705 // Revision 1.76  2004/03/08 18:17:09  rurban
1706 // added more WikiGroup::getMembersOf methods, esp. for special groups
1707 // fixed $LDAP_SET_OPTIONS
1708 // fixed _AuthInfo group methods
1709 //
1710 // Revision 1.75  2004/03/01 09:34:37  rurban
1711 // fixed button path logic: now fallback to default also
1712 //
1713 // Revision 1.74  2004/02/28 21:14:08  rurban
1714 // generally more PHPDOC docs
1715 //   see http://xarch.tu-graz.ac.at/home/rurban/phpwiki/xref/
1716 // fxied WikiUserNew pref handling: empty theme not stored, save only
1717 //   changed prefs, sql prefs improved, fixed password update,
1718 //   removed REPLACE sql (dangerous)
1719 // moved gettext init after the locale was guessed
1720 // + some minor changes
1721 //
1722 // Revision 1.73  2004/02/26 03:22:05  rurban
1723 // also copy css and images with XHTML Dump
1724 //
1725 // Revision 1.72  2004/02/26 02:25:53  rurban
1726 // fix empty and #-anchored links in XHTML Dumps
1727 //
1728 // Revision 1.71  2004/02/15 21:34:37  rurban
1729 // PageList enhanced and improved.
1730 // fixed new WikiAdmin... plugins
1731 // editpage, Theme with exp. htmlarea framework
1732 //   (htmlarea yet committed, this is really questionable)
1733 // WikiUser... code with better session handling for prefs
1734 // enhanced UserPreferences (again)
1735 // RecentChanges for show_deleted: how should pages be deleted then?
1736 //
1737 // Revision 1.70  2004/01/26 09:17:48  rurban
1738 // * changed stored pref representation as before.
1739 //   the array of objects is 1) bigger and 2)
1740 //   less portable. If we would import packed pref
1741 //   objects and the object definition was changed, PHP would fail.
1742 //   This doesn't happen with an simple array of non-default values.
1743 // * use $prefs->retrieve and $prefs->store methods, where retrieve
1744 //   understands the interim format of array of objects also.
1745 // * simplified $prefs->get() and fixed $prefs->set()
1746 // * added $user->_userid and class '_WikiUser' portability functions
1747 // * fixed $user object ->_level upgrading, mostly using sessions.
1748 //   this fixes yesterdays problems with loosing authorization level.
1749 // * fixed WikiUserNew::checkPass to return the _level
1750 // * fixed WikiUserNew::isSignedIn
1751 // * added explodePageList to class PageList, support sortby arg
1752 // * fixed UserPreferences for WikiUserNew
1753 // * fixed WikiPlugin for empty defaults array
1754 // * UnfoldSubpages: added pagename arg, renamed pages arg,
1755 //   removed sort arg, support sortby arg
1756 //
1757 // Revision 1.69  2003/12/05 01:32:28  carstenklapp
1758 // New feature: Easier to run multiple wiks off of one set of code. Name
1759 // your logo and signature image files "YourWikiNameLogo.png" and
1760 // "YourWikiNameSignature.png" and put them all into
1761 // themes/default/images. YourWikiName should match what is defined as
1762 // WIKI_NAME in index.php. In case the image is not found, the default
1763 // shipped with PhpWiki will be used.
1764 //
1765 // Revision 1.68  2003/03/04 01:53:30  dairiki
1766 // Inconsequential decrufting.
1767 //
1768 // Revision 1.67  2003/02/26 03:40:22  dairiki
1769 // New action=create.  Essentially the same as action=edit, except that if the
1770 // page already exists, it falls back to action=browse.
1771 //
1772 // This is for use in the "question mark" links for unknown wiki words
1773 // to avoid problems and confusion when following links from stale pages.
1774 // (If the "unknown page" has been created in the interim, the user probably
1775 // wants to view the page before editing it.)
1776 //
1777 // Revision 1.66  2003/02/26 00:10:26  dairiki
1778 // More/better/different checks for bad page names.
1779 //
1780 // Revision 1.65  2003/02/24 22:41:57  dairiki
1781 // Fix stupid typo.
1782 //
1783 // Revision 1.64  2003/02/24 22:06:14  dairiki
1784 // Attempts to fix auto-selection of printer CSS when printing.
1785 // See new comments lib/Theme.php for more details.
1786 // Also see SF patch #669563.
1787 //
1788 // Revision 1.63  2003/02/23 03:37:05  dairiki
1789 // Stupid typo/bug fix.
1790 //
1791 // Revision 1.62  2003/02/21 04:14:52  dairiki
1792 // New WikiLink type 'if_known'.  This gives linkified name if page
1793 // exists, otherwise, just plain text.
1794 //
1795 // Revision 1.61  2003/02/18 21:52:05  dairiki
1796 // Fix so that one can still link to wiki pages with # in their names.
1797 // (This was made difficult by the introduction of named tags, since
1798 // '[Page #1]' is now a link to anchor '1' in page 'Page'.
1799 //
1800 // Now the ~ escape for page names should work: [Page ~#1].
1801 //
1802 // Revision 1.60  2003/02/15 01:59:47  dairiki
1803 // Theme::getCSS():  Add Default-Style HTTP(-eqiv) header in attempt
1804 // to fix default stylesheet selection on some browsers.
1805 // For details on the Default-Style header, see:
1806 //  http://home.dairiki.org/docs/html4/present/styles.html#h-14.3.2
1807 //
1808 // Revision 1.59  2003/01/04 22:30:16  carstenklapp
1809 // New: display a "Never edited." message instead of an invalid epoch date.
1810 //
1811
1812 // (c-file-style: "gnu")
1813 // Local Variables:
1814 // mode: php
1815 // tab-width: 8
1816 // c-basic-offset: 4
1817 // c-hanging-comment-ender-p: nil
1818 // indent-tabs-mode: nil
1819 // End:
1820 ?>