lib/stdlib.php

   1 <?php //rcs_id('$Id: stdlib.php,v 1.187 2004-06-14 11:31:37 rurban Exp $');
   2
   3 /*
   4   Standard functions for Wiki functionality
   5     WikiURL($pagename, $args, $get_abs_url)
   6     IconForLink($protocol_or_url)
   7     LinkURL($url, $linktext)
   8     LinkImage($url, $alt)
   9
  10     SplitQueryArgs ($query_args)
  11     LinkPhpwikiURL($url, $text)
  12     ConvertOldMarkup($content)
  13
  14     class Stack { push($item), pop(), cnt(), top() }
  15
  16     SplitPagename ($page)
  17     NoSuchRevision ($request, $page, $version)
  18     TimezoneOffset ($time, $no_colon)
  19     Iso8601DateTime ($time)
  20     Rfc2822DateTime ($time)
  21     CTime ($time)
  22     __printf ($fmt)
  23     __sprintf ($fmt)
  24     __vsprintf ($fmt, $args)
  25     better_srand($seed = '')
  26     count_all($arg)
  27     isSubPage($pagename)
  28     subPageSlice($pagename, $pos)
  29     explodePageList($input, $perm = false)
  30
  31   function: LinkInterWikiLink($link, $linktext)
  32   moved to: lib/interwiki.php
  33   function: linkExistingWikiWord($wikiword, $linktext, $version)
  34   moved to: lib/Theme.php
  35   function: LinkUnknownWikiWord($wikiword, $linktext)
  36   moved to: lib/Theme.php
  37   function: UpdateRecentChanges($dbi, $pagename, $isnewpage)
  38   gone see: lib/plugin/RecentChanges.php
  39 */
  40 if (defined('_PHPWIKI_STDLIB_LOADED')) return;
  41 else define('_PHPWIKI_STDLIB_LOADED',true);
  42
  43 define('MAX_PAGENAME_LENGTH', 100);
  44
  45
  46 /**
  47  * Convert string to a valid XML identifier.
  48  *
  49  * XML 1.0 identifiers are of the form: [A-Za-z][A-Za-z0-9:_.-]*
  50  *
  51  * We would like to have, e.g. named anchors within wiki pages
  52  * names like "Table of Contents" --- clearly not a valid XML
  53  * fragment identifier.
  54  *
  55  * This function implements a one-to-one map from {any string}
  56  * to {valid XML identifiers}.
  57  *
  58  * It does this by
  59  * converting all bytes not in [A-Za-z0-9:_-],
  60  * and any leading byte not in [A-Za-z] to 'xbb.',
  61  * where 'bb' is the hexadecimal representation of the
  62  * character.
  63  *
  64  * As a special case, the empty string is converted to 'empty.'
  65  *
  66  * @param string $str
  67  * @return string
  68  */
  69 function MangleXmlIdentifier($str) {
  70     if (!$str)
  71         return 'empty.';
  72
  73     return preg_replace('/[^-_:A-Za-z0-9]|(?<=^)[^A-Za-z]/e',
  74                         "'x' . sprintf('%02x', ord('\\0')) . '.'",
  75                         $str);
  76 }
  77
  78 function UnMangleXmlIdentifier($str) {
  79     if ($str == 'empty.')
  80         return '';
  81     return preg_replace('/x(\w\w)\./e',
  82                         "sprintf('%c', hex('\\0'))",
  83                         $str);
  84 }
  85
  86 /**
  87  * Generates a valid URL for a given Wiki pagename.
  88  * @param mixed $pagename If a string this will be the name of the Wiki page to link to.
  89  *                        If a WikiDB_Page object function will extract the name to link to.
  90  *                        If a WikiDB_PageRevision object function will extract the name to link to.
  91  * @param array $args
  92  * @param boolean $get_abs_url Default value is false.
  93  * @return string The absolute URL to the page passed as $pagename.
  94  */
  95 function WikiURL($pagename, $args = '', $get_abs_url = false) {
  96     $anchor = false;
  97
  98     if (is_object($pagename)) {
  99         if (isa($pagename, 'WikiDB_Page')) {
 100             $pagename = $pagename->getName();
 101         }
 102         elseif (isa($pagename, 'WikiDB_PageRevision')) {
 103             $page = $pagename->getPage();
 104             $args['version'] = $pagename->getVersion();
 105             $pagename = $page->getName();
 106         }
 107         elseif (isa($pagename, 'WikiPageName')) {
 108             $anchor = $pagename->anchor;
 109             $pagename = $pagename->name;
 110         } else { // php5
 111             $anchor = $pagename->anchor;
 112             $pagename = $pagename->name;
 113         }
 114     }
 115
 116     if (is_array($args)) {
 117         $enc_args = array();
 118         foreach  ($args as $key => $val) {
 119             if (!is_array($val)) // ugly hack for getURLtoSelf() which also takes POST vars
 120               $enc_args[] = urlencode($key) . '=' . urlencode($val);
 121         }
 122         $args = join('&', $enc_args);
 123     }
 124
 125     if (USE_PATH_INFO) {
 126         $url = $get_abs_url ? SERVER_URL . VIRTUAL_PATH . "/" : "";
 127         $url .= preg_replace('/%2f/i', '/', rawurlencode($pagename));
 128         if ($args)
 129             $url .= "?$args";
 130     }
 131     else {
 132         $url = $get_abs_url ? SERVER_URL . SCRIPT_NAME : basename(SCRIPT_NAME);
 133         $url .= "?pagename=" . rawurlencode($pagename);
 134         if ($args)
 135             $url .= "&$args";
 136     }
 137     if ($anchor)
 138         $url .= "#" . MangleXmlIdentifier($anchor);
 139     return $url;
 140 }
 141
 142 /** Convert relative URL to absolute URL.
 143  *
 144  * This converts a relative URL to one of PhpWiki's support files
 145  * to an absolute one.
 146  *
 147  * @param string $url
 148  * @return string Absolute URL
 149  */
 150 function AbsoluteURL ($url) {
 151     if (preg_match('/^https?:/', $url))
 152         return $url;
 153     if ($url[0] != '/') {
 154         $base = USE_PATH_INFO ? VIRTUAL_PATH : dirname(SCRIPT_NAME);
 155         while ($base != '/' and substr($url, 0, 3) == "../") {
 156             $url = substr($url, 3);
 157             $base = dirname($base);
 158         }
 159         if ($base != '/')
 160             $base .= '/';
 161         $url = $base . $url;
 162     }
 163     return SERVER_URL . $url;
 164 }
 165
 166 /**
 167  * Generates icon in front of links.
 168  *
 169  * @param string $protocol_or_url URL or protocol to determine which icon to use.
 170  *
 171  * @return HtmlElement HtmlElement object that contains data to create img link to
 172  * icon for use with url or protocol passed to the function. False if no img to be
 173  * displayed.
 174  */
 175 function IconForLink($protocol_or_url) {
 176     global $WikiTheme;
 177     if (0 and $filename_suffix == false) {
 178         // display apache style icon for file type instead of protocol icon
 179         // - archive: unix:gz,bz2,tgz,tar,z; mac:dmg,dmgz,bin,img,cpt,sit; pc:zip;
 180         // - document: html, htm, text, txt, rtf, pdf, doc
 181         // - non-inlined image: jpg,jpeg,png,gif,tiff,tif,swf,pict,psd,eps,ps
 182         // - audio: mp3,mp2,aiff,aif,au
 183         // - multimedia: mpeg,mpg,mov,qt
 184     } else {
 185         list ($proto) = explode(':', $protocol_or_url, 2);
 186         $src = $WikiTheme->getLinkIconURL($proto);
 187         if ($src)
 188             return HTML::img(array('src' => $src, 'alt' => "", 'class' => 'linkicon', 'border' => 0));
 189         else
 190             return false;
 191     }
 192 }
 193
 194 /**
 195  * Glue icon in front of or after text.
 196  * Pref: 'noLinkIcons'  - ignore icon if set
 197  * Theme: 'LinkIcons'   - 'yes'   at front
 198  *                      - 'no'    display no icon
 199  *                      - 'front' display at left
 200  *                      - 'after' display at right
 201  *
 202  * @param string $protocol_or_url Protocol or URL.  Used to determine the
 203  * proper icon.
 204  * @param string $text The text.
 205  * @return XmlContent.
 206  */
 207 function PossiblyGlueIconToText($proto_or_url, $text) {
 208     global $request, $WikiTheme;
 209     if ($request->getPref('noLinkIcons'))
 210         return $text;
 211     $icon = IconForLink($proto_or_url);
 212     if (!$icon)
 213         return $text;
 214     if ($where = $WikiTheme->getLinkIconAttr()) {
 215         if ($where == 'no') return $text;
 216         if ($where != 'after') $where = 'front';
 217     } else {
 218         $where = 'front';
 219     }
 220     if ($where == 'after') {
 221         // span the icon only to the last word (tie them together),
 222         // to let the previous words wrap on line breaks.
 223         if (!is_object($text)) {
 224             preg_match('/^(\s*\S*)(\s*)$/', $text, $m);
 225             list (, $prefix, $last_word) = $m;
 226         }
 227         else {
 228             $last_word = $text;
 229             $prefix = false;
 230         }
 231         $text = HTML::span(array('style' => 'white-space: nowrap'),
 232                            $last_word, HTML::Raw('&nbsp;'), $icon);
 233         if ($prefix)
 234             $text = HTML($prefix, $text);
 235         return $text;
 236     }
 237     // span the icon only to the first word (tie them together),
 238     // to let the next words wrap on line breaks
 239     if (!is_object($text)) {
 240         preg_match('/^\s*(\S*)(.*?)\s*$/', $text, $m);
 241         list (, $first_word, $tail) = $m;
 242     }
 243     else {
 244         $first_word = $text;
 245         $tail = false;
 246     }
 247     $text = HTML::span(array('style' => 'white-space: nowrap'),
 248                        $icon, $first_word);
 249     if ($tail)
 250         $text = HTML($text, $tail);
 251     return $text;
 252 }
 253
 254 /**
 255  * Determines if the url passed to function is safe, by detecting if the characters
 256  * '<', '>', or '"' are present.
 257  *
 258  * @param string $url URL to check for unsafe characters.
 259  * @return boolean True if same, false else.
 260  */
 261 function IsSafeURL($url) {
 262     return !ereg('[<>"]', $url);
 263 }
 264
 265 /**
 266  * Generates an HtmlElement object to store data for a link.
 267  *
 268  * @param string $url URL that the link will point to.
 269  * @param string $linktext Text to be displayed as link.
 270  * @return HtmlElement HtmlElement object that contains data to construct an html link.
 271  */
 272 function LinkURL($url, $linktext = '') {
 273     // FIXME: Is this needed (or sufficient?)
 274     if(! IsSafeURL($url)) {
 275         $link = HTML::strong(HTML::u(array('class' => 'baduri'),
 276                                      _("BAD URL -- remove all of <, >, \"")));
 277     }
 278     else {
 279         if (!$linktext)
 280             $linktext = preg_replace("/mailto:/A", "", $url);
 281
 282         $link = HTML::a(array('href' => $url),
 283                         PossiblyGlueIconToText($url, $linktext));
 284
 285     }
 286     $link->setAttr('class', $linktext ? 'namedurl' : 'rawurl');
 287     return $link;
 288 }
 289
 290 /**
 291  * FIXME: disallow sizes which are too small.
 292  * Spammers may use such (typically invisible) image attributes to higher their GoogleRank.
 293  */
 294 function LinkImage($url, $alt = false) {
 295     // FIXME: Is this needed (or sufficient?)
 296     if(! IsSafeURL($url)) {
 297         $link = HTML::strong(HTML::u(array('class' => 'baduri'),
 298                                      _("BAD URL -- remove all of <, >, \"")));
 299     } else {
 300         // support new syntax: [image.jpg size=50% border=n]
 301         $arr = split(' ',$url);
 302         if (count($arr) > 1) {
 303             $url = $arr[0];
 304         }
 305         if (empty($alt)) $alt = basename($url);
 306         $link = HTML::img(array('src' => $url, 'alt' => $alt));
 307         if (count($arr) > 1) {
 308             array_shift($arr);
 309             foreach ($arr as $attr) {
 310                 if (preg_match('/^size=(\d+%)$/',$attr,$m)) {
 311                     $link->setAttr('width',$m[1]);
 312                     $link->setAttr('height',$m[1]);
 313                 }
 314                 if (preg_match('/^size=(\d+)x(\d+)$/',$attr,$m)) {
 315                     $link->setAttr('width',$m[1]);
 316                     $link->setAttr('height',$m[2]);
 317                 }
 318                 if (preg_match('/^border=(\d+)$/',$attr,$m))
 319                     $link->setAttr('border',$m[1]);
 320                 if (preg_match('/^align=(\w+)$/',$attr,$m))
 321                     $link->setAttr('align',$m[1]);
 322                 if (preg_match('/^hspace=(\d+)$/',$attr,$m))
 323                     $link->setAttr('hspace',$m[1]);
 324                 if (preg_match('/^vspace=(\d+)$/',$attr,$m))
 325                     $link->setAttr('vspace',$m[1]);
 326             }
 327         }
 328         // check width and height as spam countermeasure
 329         if (($width = $link->getAttr('width')) and ($height = $link->getAttr('height'))) {
 330             $width  = (integer) $width; // px or % or other suffix
 331             $height = (integer) $height;
 332             if (($width < 3 and $height < 10) or
 333                 ($height < 3 and $width < 20) or
 334                 ($height < 7 and $width < 7))
 335             {
 336                 trigger_error(_("Invalid image size"), E_USER_NOTICE);
 337                 return '';
 338             }
 339         } elseif ($size = @getimagesize($url)) {
 340             $width = $size[0];
 341             $height = $size[1];
 342             if (($width < 3 and $height < 10) or
 343                 ($height < 3 and $width < 20) or
 344                 ($height < 7 and $width < 7))
 345             {
 346                 trigger_error(_("Invalid image size"), E_USER_NOTICE);
 347                 return '';
 348             }
 349         }
 350     }
 351     $link->setAttr('class', 'inlineimage');
 352     return $link;
 353 }
 354
 355
 356
 357 class Stack {
 358     var $items = array();
 359     var $size = 0;
 360     // var in php5.0.0.rc1 deprecated
 361
 362     function push($item) {
 363         $this->items[$this->size] = $item;
 364         $this->size++;
 365         return true;
 366     }
 367
 368     function pop() {
 369         if ($this->size == 0) {
 370             return false; // stack is empty
 371         }
 372         $this->size--;
 373         return $this->items[$this->size];
 374     }
 375
 376     function cnt() {
 377         return $this->size;
 378     }
 379
 380     function top() {
 381         if($this->size)
 382             return $this->items[$this->size - 1];
 383         else
 384             return '';
 385     }
 386
 387 }
 388 // end class definition
 389
 390 function SplitQueryArgs ($query_args = '')
 391 {
 392     $split_args = split('&', $query_args);
 393     $args = array();
 394     while (list($key, $val) = each($split_args))
 395         if (preg_match('/^ ([^=]+) =? (.*) /x', $val, $m))
 396             $args[$m[1]] = $m[2];
 397     return $args;
 398 }
 399
 400 function LinkPhpwikiURL($url, $text = '', $basepage) {
 401     $args = array();
 402
 403     if (!preg_match('/^ phpwiki: ([^?]*) [?]? (.*) $/x', $url, $m)) {
 404         return HTML::strong(array('class' => 'rawurl'),
 405                             HTML::u(array('class' => 'baduri'),
 406                                     _("BAD phpwiki: URL")));
 407     }
 408
 409     if ($m[1])
 410         $pagename = urldecode($m[1]);
 411     $qargs = $m[2];
 412
 413     if (empty($pagename) &&
 414         preg_match('/^(diff|edit|links|info)=([^&]+)$/', $qargs, $m)) {
 415         // Convert old style links (to not break diff links in
 416         // RecentChanges).
 417         $pagename = urldecode($m[2]);
 418         $args = array("action" => $m[1]);
 419     }
 420     else {
 421         $args = SplitQueryArgs($qargs);
 422     }
 423
 424     if (empty($pagename))
 425         $pagename = $GLOBALS['request']->getArg('pagename');
 426
 427     if (isset($args['action']) && $args['action'] == 'browse')
 428         unset($args['action']);
 429
 430     /*FIXME:
 431       if (empty($args['action']))
 432       $class = 'wikilink';
 433       else if (is_safe_action($args['action']))
 434       $class = 'wikiaction';
 435     */
 436     if (empty($args['action']) || is_safe_action($args['action']))
 437         $class = 'wikiaction';
 438     else {
 439         // Don't allow administrative links on unlocked pages.
 440         $dbi = $GLOBALS['request']->getDbh();
 441         $page = $dbi->getPage($basepage);
 442         if (!$page->get('locked'))
 443             return HTML::span(array('class' => 'wikiunsafe'),
 444                               HTML::u(_("Lock page to enable link")));
 445         $class = 'wikiadmin';
 446     }
 447
 448     if (!$text)
 449         $text = HTML::span(array('class' => 'rawurl'), $url);
 450
 451     $wikipage = new WikiPageName($pagename);
 452     if (!$wikipage->isValid()) {
 453         global $WikiTheme;
 454         return $WikiTheme->linkBadWikiWord($wikipage, $url);
 455     }
 456
 457     return HTML::a(array('href'  => WikiURL($pagename, $args),
 458                          'class' => $class),
 459                    $text);
 460 }
 461
 462 /**
 463  * A class to assist in parsing wiki pagenames.
 464  *
 465  * Now with subpages and anchors, parsing and passing around
 466  * pagenames is more complicated.  This should help.
 467  */
 468 class WikiPageName
 469 {
 470     /** Short name for page.
 471      *
 472      * This is the value of $name passed to the constructor.
 473      * (For use, e.g. as a default label for links to the page.)
 474      */
 475     var $shortName;
 476
 477     /** The full page name.
 478      *
 479      * This is the full name of the page (without anchor).
 480      */
 481     var $name;
 482
 483     /** The anchor.
 484      *
 485      * This is the referenced anchor within the page, or the empty string.
 486      */
 487     var $anchor;
 488
 489     /** Constructor
 490      *
 491      * @param mixed $name Page name.
 492      * WikiDB_Page, WikiDB_PageRevision, or string.
 493      * This can be a relative subpage name (like '/SubPage'),
 494      * or can be the empty string to refer to the $basename.
 495      *
 496      * @param string $anchor For links to anchors in page.
 497      *
 498      * @param mixed $basename Page name from which to interpret
 499      * relative or other non-fully-specified page names.
 500      */
 501     function WikiPageName($name, $basename=false, $anchor=false) {
 502         if (is_string($name)) {
 503             $this->shortName = $name;
 504
 505             if ($name == '' or $name[0] == SUBPAGE_SEPARATOR) {
 506                 if ($basename)
 507                     $name = $this->_pagename($basename) . $name;
 508                 else
 509                     $name = $this->_normalize_bad_pagename($name);
 510             }
 511         }
 512         else {
 513             $name = $this->_pagename($name);
 514             $this->shortName = $name;
 515         }
 516
 517         $this->name = $this->_check($name);
 518         $this->anchor = (string)$anchor;
 519     }
 520
 521     function getParent() {
 522         $name = $this->name;
 523         if (!($tail = strrchr($name, SUBPAGE_SEPARATOR)))
 524             return false;
 525         return substr($name, 0, -strlen($tail));
 526     }
 527
 528     function isValid($strict = false) {
 529         if ($strict)
 530             return !isset($this->_errors);
 531         return (is_string($this->name) and $this->name != '');
 532     }
 533
 534     function getWarnings() {
 535         $warnings = array();
 536         if (isset($this->_warnings))
 537             $warnings = array_merge($warnings, $this->_warnings);
 538         if (isset($this->_errors))
 539             $warnings = array_merge($warnings, $this->_errors);
 540         if (!$warnings)
 541             return false;
 542
 543         return sprintf(_("'%s': Bad page name: %s"),
 544                        $this->shortName, join(', ', $warnings));
 545     }
 546
 547     function _pagename($page) {
 548         if (isa($page, 'WikiDB_Page'))
 549             return $page->getName();
 550         elseif (isa($page, 'WikiDB_PageRevision'))
 551             return $page->getPageName();
 552         elseif (isa($page, 'WikiPageName'))
 553             return $page->name;
 554         if (!is_string($page)) {
 555             trigger_error(sprintf("Non-string pagename '%s' (%s)(%s)",
 556                                   $page, gettype($page), get_class($page)),
 557                           E_USER_NOTICE);
 558         }
 559         //assert(is_string($page));
 560         return $page;
 561     }
 562
 563     function _normalize_bad_pagename($name) {
 564         trigger_error("Bad pagename: " . $name, E_USER_WARNING);
 565
 566         // Punt...  You really shouldn't get here.
 567         if (empty($name)) {
 568             global $request;
 569             return $request->getArg('pagename');
 570         }
 571         assert($name[0] == SUBPAGE_SEPARATOR);
 572         return substr($name, 1);
 573     }
 574
 575
 576     function _check($pagename) {
 577         // Compress internal white-space to single space character.
 578         $pagename = preg_replace('/[\s\xa0]+/', ' ', $orig = $pagename);
 579         if ($pagename != $orig)
 580             $this->_warnings[] = _("White space converted to single space");
 581
 582         // Delete any control characters.
 583         $pagename = preg_replace('/[\x00-\x1f\x7f\x80-\x9f]/', '', $orig = $pagename);
 584         if ($pagename != $orig)
 585             $this->_errors[] = _("Control characters not allowed");
 586
 587         // Strip leading and trailing white-space.
 588         $pagename = trim($pagename);
 589
 590         $orig = $pagename;
 591         while ($pagename and $pagename[0] == SUBPAGE_SEPARATOR)
 592             $pagename = substr($pagename, 1);
 593         if ($pagename != $orig)
 594             $this->_errors[] = sprintf(_("Leading %s not allowed"), SUBPAGE_SEPARATOR);
 595
 596         if (preg_match('/[:;]/', $pagename))
 597             $this->_warnings[] = _("';' and ':' in pagenames are deprecated");
 598
 599         if (strlen($pagename) > MAX_PAGENAME_LENGTH) {
 600             $pagename = substr($pagename, 0, MAX_PAGENAME_LENGTH);
 601             $this->_errors[] = _("too long");
 602         }
 603
 604
 605         if ($pagename == '.' or $pagename == '..') {
 606             $this->_errors[] = sprintf(_("illegal pagename"), $pagename);
 607             $pagename = '';
 608         }
 609
 610         return $pagename;
 611     }
 612 }
 613
 614 /**
 615  * Convert old page markup to new-style markup.
 616  *
 617  * @param string $text Old-style wiki markup.
 618  *
 619  * @param string $markup_type
 620  * One of: <dl>
 621  * <dt><code>"block"</code>  <dd>Convert all markup.
 622  * <dt><code>"inline"</code> <dd>Convert only inline markup.
 623  * <dt><code>"links"</code>  <dd>Convert only link markup.
 624  * </dl>
 625  *
 626  * @return string New-style wiki markup.
 627  *
 628  * @bugs Footnotes don't work quite as before (esp if there are
 629  *   multiple references to the same footnote.  But close enough,
 630  *   probably for now....
 631  */
 632 function ConvertOldMarkup ($text, $markup_type = "block") {
 633
 634     static $subs;
 635     static $block_re;
 636
 637     if (empty($subs)) {
 638         /*****************************************************************
 639          * Conversions for inline markup:
 640          */
 641
 642         // escape tilde's
 643         $orig[] = '/~/';
 644         $repl[] = '~~';
 645
 646         // escape escaped brackets
 647         $orig[] = '/\[\[/';
 648         $repl[] = '~[';
 649
 650         // change ! escapes to ~'s.
 651         global $WikiNameRegexp, $request;
 652         //include_once('lib/interwiki.php');
 653         $map = getInterwikiMap();
 654         $bang_esc[] = "(?:" . ALLOWED_PROTOCOLS . "):[^\s<>\[\]\"'()]*[^\s<>\[\]\"'(),.?]";
 655         $bang_esc[] = $map->getRegexp() . ":[^\\s.,;?()]+"; // FIXME: is this really needed?
 656         $bang_esc[] = $WikiNameRegexp;
 657         $orig[] = '/!((?:' . join(')|(', $bang_esc) . '))/';
 658         $repl[] = '~\\1';
 659
 660         $subs["links"] = array($orig, $repl);
 661
 662         // Escape '<'s
 663         //$orig[] = '/<(?!\?plugin)|(?<!^)</m';
 664         //$repl[] = '~<';
 665
 666         // Convert footnote references.
 667         $orig[] = '/(?<=.)(?<!~)\[\s*(\d+)\s*\]/m';
 668         $repl[] = '#[|ftnt_ref_\\1]<sup>~[[\\1|#ftnt_\\1]~]</sup>';
 669
 670         // Convert old style emphases to HTML style emphasis.
 671         $orig[] = '/__(.*?)__/';
 672         $repl[] = '<strong>\\1</strong>';
 673         $orig[] = "/''(.*?)''/";
 674         $repl[] = '<em>\\1</em>';
 675
 676         // Escape nestled markup.
 677         $orig[] = '/^(?<=^|\s)[=_](?=\S)|(?<=\S)[=_*](?=\s|$)/m';
 678         $repl[] = '~\\0';
 679
 680         // in old markup headings only allowed at beginning of line
 681         $orig[] = '/!/';
 682         $repl[] = '~!';
 683
 684         $subs["inline"] = array($orig, $repl);
 685
 686         /*****************************************************************
 687          * Patterns which match block markup constructs which take
 688          * special handling...
 689          */
 690
 691         // Indented blocks
 692         $blockpats[] = '[ \t]+\S(?:.*\s*\n[ \t]+\S)*';
 693
 694         // Tables
 695         $blockpats[] = '\|(?:.*\n\|)*';
 696
 697         // List items
 698         $blockpats[] = '[#*;]*(?:[*#]|;.*?:)';
 699
 700         // Footnote definitions
 701         $blockpats[] = '\[\s*(\d+)\s*\]';
 702
 703         // Plugins
 704         $blockpats[] = '<\?plugin(?:-form)?\b.*\?>\s*$';
 705
 706         // Section Title
 707         $blockpats[] = '!{1,3}[^!]';
 708
 709         $block_re = ( '/\A((?:.|\n)*?)(^(?:'
 710                       . join("|", $blockpats)
 711                       . ').*$)\n?/m' );
 712
 713     }
 714
 715     if ($markup_type != "block") {
 716         list ($orig, $repl) = $subs[$markup_type];
 717         return preg_replace($orig, $repl, $text);
 718     }
 719     else {
 720         list ($orig, $repl) = $subs['inline'];
 721         $out = '';
 722         while (preg_match($block_re, $text, $m)) {
 723             $text = substr($text, strlen($m[0]));
 724             list (,$leading_text, $block) = $m;
 725             $suffix = "\n";
 726
 727             if (strchr(" \t", $block[0])) {
 728                 // Indented block
 729                 $prefix = "<pre>\n";
 730                 $suffix = "\n</pre>\n";
 731             }
 732             elseif ($block[0] == '|') {
 733                 // Old-style table
 734                 $prefix = "<?plugin OldStyleTable\n";
 735                 $suffix = "\n?>\n";
 736             }
 737             elseif (strchr("#*;", $block[0])) {
 738                 // Old-style list item
 739                 preg_match('/^([#*;]*)([*#]|;.*?:) */', $block, $m);
 740                 list (,$ind,$bullet) = $m;
 741                 $block = substr($block, strlen($m[0]));
 742
 743                 $indent = str_repeat('     ', strlen($ind));
 744                 if ($bullet[0] == ';') {
 745                     //$term = ltrim(substr($bullet, 1));
 746                     //return $indent . $term . "\n" . $indent . '     ';
 747                     $prefix = $ind . $bullet;
 748                 }
 749                 else
 750                     $prefix = $indent . $bullet . ' ';
 751             }
 752             elseif ($block[0] == '[') {
 753                 // Footnote definition
 754                 preg_match('/^\[\s*(\d+)\s*\]/', $block, $m);
 755                 $footnum = $m[1];
 756                 $block = substr($block, strlen($m[0]));
 757                 $prefix = "#[|ftnt_${footnum}]~[[${footnum}|#ftnt_ref_${footnum}]~] ";
 758             }
 759             elseif ($block[0] == '<') {
 760                 // Plugin.
 761                 // HACK: no inline markup...
 762                 $prefix = $block;
 763                 $block = '';
 764             }
 765             elseif ($block[0] == '!') {
 766                 // Section heading
 767                 preg_match('/^!{1,3}/', $block, $m);
 768                 $prefix = $m[0];
 769                 $block = substr($block, strlen($m[0]));
 770             }
 771             else {
 772                 // AAck!
 773                 assert(0);
 774             }
 775
 776             $out .= ( preg_replace($orig, $repl, $leading_text)
 777                       . $prefix
 778                       . preg_replace($orig, $repl, $block)
 779                       . $suffix );
 780         }
 781         return $out . preg_replace($orig, $repl, $text);
 782     }
 783 }
 784
 785
 786 /**
 787  * Expand tabs in string.
 788  *
 789  * Converts all tabs to (the appropriate number of) spaces.
 790  *
 791  * @param string $str
 792  * @param integer $tab_width
 793  * @return string
 794  */
 795 function expand_tabs($str, $tab_width = 8) {
 796     $split = split("\t", $str);
 797     $tail = array_pop($split);
 798     $expanded = "\n";
 799     foreach ($split as $hunk) {
 800         $expanded .= $hunk;
 801         $pos = strlen(strrchr($expanded, "\n")) - 1;
 802         $expanded .= str_repeat(" ", ($tab_width - $pos % $tab_width));
 803     }
 804     return substr($expanded, 1) . $tail;
 805 }
 806
 807 /**
 808  * Split WikiWords in page names.
 809  *
 810  * It has been deemed useful to split WikiWords (into "Wiki Words") in
 811  * places like page titles. This is rumored to help search engines
 812  * quite a bit.
 813  *
 814  * @param $page string The page name.
 815  *
 816  * @return string The split name.
 817  */
 818 function SplitPagename ($page) {
 819
 820     if (preg_match("/\s/", $page))
 821         return $page;           // Already split --- don't split any more.
 822
 823     // This algorithm is specialized for several languages.
 824     // (Thanks to Pierrick MEIGNEN)
 825     // Improvements for other languages welcome.
 826     static $RE;
 827     if (!isset($RE)) {
 828         // This mess splits between a lower-case letter followed by
 829         // either an upper-case or a numeral; except that it wont
 830         // split the prefixes 'Mc', 'De', or 'Di' off of their tails.
 831         switch ($GLOBALS['LANG']) {
 832         case 'en':
 833         case 'it':
 834         case 'es':
 835         case 'de':
 836             $RE[] = '/([[:lower:]])((?<!Mc|De|Di)[[:upper:]]|\d)/';
 837             break;
 838         case 'fr':
 839             $RE[] = '/([[:lower:]])((?<!Mc|Di)[[:upper:]]|\d)/';
 840             break;
 841         }
 842         $sep = preg_quote(SUBPAGE_SEPARATOR, '/');
 843         // This the single-letter words 'I' and 'A' from any following
 844         // capitalized words.
 845         switch ($GLOBALS['LANG']) {
 846         case 'en':
 847             $RE[] = "/(?<= |${sep}|^)([AI])([[:upper:]][[:lower:]])/";
 848             break;
 849         case 'fr':
 850             $RE[] = "/(?<= |${sep}|^)([À])([[:upper:]][[:lower:]])/";
 851             break;
 852         }
 853         // Split numerals from following letters.
 854         $RE[] = '/(\d)([[:alpha:]])/';
 855         // Split at subpage seperators. TBD in Theme.php
 856         $RE[] = "/([^${sep}]+)(${sep})/";
 857
 858         foreach ($RE as $key)
 859             $RE[$key] = pcre_fix_posix_classes($key);
 860     }
 861
 862     foreach ($RE as $regexp) {
 863         $page = preg_replace($regexp, '\\1 \\2', $page);
 864     }
 865     return $page;
 866 }
 867
 868 function NoSuchRevision (&$request, $page, $version) {
 869     $html = HTML(HTML::h2(_("Revision Not Found")),
 870                  HTML::p(fmt("I'm sorry.  Version %d of %s is not in the database.",
 871                              $version, WikiLink($page, 'auto'))));
 872     include_once('lib/Template.php');
 873     GeneratePage($html, _("Bad Version"), $page->getCurrentRevision());
 874     $request->finish();
 875 }
 876
 877
 878 /**
 879  * Get time offset for local time zone.
 880  *
 881  * @param $time time_t Get offset for this time. Default: now.
 882  * @param $no_colon boolean Don't put colon between hours and minutes.
 883  * @return string Offset as a string in the format +HH:MM.
 884  */
 885 function TimezoneOffset ($time = false, $no_colon = false) {
 886     if ($time === false)
 887         $time = time();
 888     $secs = date('Z', $time);
 889
 890     if ($secs < 0) {
 891         $sign = '-';
 892         $secs = -$secs;
 893     }
 894     else {
 895         $sign = '+';
 896     }
 897     $colon = $no_colon ? '' : ':';
 898     $mins = intval(($secs + 30) / 60);
 899     return sprintf("%s%02d%s%02d",
 900                    $sign, $mins / 60, $colon, $mins % 60);
 901 }
 902
 903
 904 /**
 905  * Format time in ISO-8601 format.
 906  *
 907  * @param $time time_t Time.  Default: now.
 908  * @return string Date and time in ISO-8601 format.
 909  */
 910 function Iso8601DateTime ($time = false) {
 911     if ($time === false)
 912         $time = time();
 913     $tzoff = TimezoneOffset($time);
 914     $date  = date('Y-m-d', $time);
 915     $time  = date('H:i:s', $time);
 916     return $date . 'T' . $time . $tzoff;
 917 }
 918
 919 /**
 920  * Format time in RFC-2822 format.
 921  *
 922  * @param $time time_t Time.  Default: now.
 923  * @return string Date and time in RFC-2822 format.
 924  */
 925 function Rfc2822DateTime ($time = false) {
 926     if ($time === false)
 927         $time = time();
 928     return date('D, j M Y H:i:s ', $time) . TimezoneOffset($time, 'no colon');
 929 }
 930
 931 /**
 932  * Format time in RFC-1123 format.
 933  *
 934  * @param $time time_t Time.  Default: now.
 935  * @return string Date and time in RFC-1123 format.
 936  */
 937 function Rfc1123DateTime ($time = false) {
 938     if ($time === false)
 939         $time = time();
 940     return gmdate('D, d M Y H:i:s \G\M\T', $time);
 941 }
 942
 943 /** Parse date in RFC-1123 format.
 944  *
 945  * According to RFC 1123 we must accept dates in the following
 946  * formats:
 947  *
 948  *   Sun, 06 Nov 1994 08:49:37 GMT  ; RFC 822, updated by RFC 1123
 949  *   Sunday, 06-Nov-94 08:49:37 GMT ; RFC 850, obsoleted by RFC 1036
 950  *   Sun Nov  6 08:49:37 1994       ; ANSI C's asctime() format
 951  *
 952  * (Though we're only allowed to generate dates in the first format.)
 953  */
 954 function ParseRfc1123DateTime ($timestr) {
 955     $timestr = trim($timestr);
 956     if (preg_match('/^ \w{3},\s* (\d{1,2}) \s* (\w{3}) \s* (\d{4}) \s*'
 957                    .'(\d\d):(\d\d):(\d\d) \s* GMT $/ix',
 958                    $timestr, $m)) {
 959         list(, $mday, $mon, $year, $hh, $mm, $ss) = $m;
 960     }
 961     elseif (preg_match('/^ \w+,\s* (\d{1,2})-(\w{3})-(\d{2}|\d{4}) \s*'
 962                        .'(\d\d):(\d\d):(\d\d) \s* GMT $/ix',
 963                        $timestr, $m)) {
 964         list(, $mday, $mon, $year, $hh, $mm, $ss) = $m;
 965         if ($year < 70) $year += 2000;
 966         elseif ($year < 100) $year += 1900;
 967     }
 968     elseif (preg_match('/^\w+\s* (\w{3}) \s* (\d{1,2}) \s*'
 969                        .'(\d\d):(\d\d):(\d\d) \s* (\d{4})$/ix',
 970                        $timestr, $m)) {
 971         list(, $mon, $mday, $hh, $mm, $ss, $year) = $m;
 972     }
 973     else {
 974         // Parse failed.
 975         return false;
 976     }
 977
 978     $time = strtotime("$mday $mon $year ${hh}:${mm}:${ss} GMT");
 979     if ($time == -1)
 980         return false;           // failed
 981     return $time;
 982 }
 983
 984 /**
 985  * Format time to standard 'ctime' format.
 986  *
 987  * @param $time time_t Time.  Default: now.
 988  * @return string Date and time.
 989  */
 990 function CTime ($time = false)
 991 {
 992     if ($time === false)
 993         $time = time();
 994     return date("D M j H:i:s Y", $time);
 995 }
 996
 997
 998 /**
 999  * Format number as kilobytes or bytes.
1000  * Short format is used for PageList
1001  * Long format is used in PageInfo
1002  *
1003  * @param $bytes       int.  Default: 0.
1004  * @param $longformat  bool. Default: false.
1005  * @return class FormattedText (XmlElement.php).
1006  */
1007 function ByteFormatter ($bytes = 0, $longformat = false) {
1008     if ($bytes < 0)
1009         return fmt("-???");
1010     if ($bytes < 1024) {
1011         if (! $longformat)
1012             $size = fmt("%s b", $bytes);
1013         else
1014             $size = fmt("%s bytes", $bytes);
1015     }
1016     else {
1017         $kb = round($bytes / 1024, 1);
1018         if (! $longformat)
1019             $size = fmt("%s k", $kb);
1020         else
1021             $size = fmt("%s Kb (%s bytes)", $kb, $bytes);
1022     }
1023     return $size;
1024 }
1025
1026 /**
1027  * Internationalized printf.
1028  *
1029  * This is essentially the same as PHP's built-in printf
1030  * with the following exceptions:
1031  * <ol>
1032  * <li> It passes the format string through gettext().
1033  * <li> It supports the argument reordering extensions.
1034  * </ol>
1035  *
1036  * Example:
1037  *
1038  * In php code, use:
1039  * <pre>
1040  *    __printf("Differences between versions %s and %s of %s",
1041  *             $new_link, $old_link, $page_link);
1042  * </pre>
1043  *
1044  * Then in locale/po/de.po, one can reorder the printf arguments:
1045  *
1046  * <pre>
1047  *    msgid "Differences between %s and %s of %s."
1048  *    msgstr "Der Unterschiedsergebnis von %3$s, zwischen %1$s und %2$s."
1049  * </pre>
1050  *
1051  * (Note that while PHP tries to expand $vars within double-quotes,
1052  * the values in msgstr undergo no such expansion, so the '$'s
1053  * okay...)
1054  *
1055  * One shouldn't use reordered arguments in the default format string.
1056  * Backslashes in the default string would be necessary to escape the
1057  * '$'s, and they'll cause all kinds of trouble....
1058  */
1059 function __printf ($fmt) {
1060     $args = func_get_args();
1061     array_shift($args);
1062     echo __vsprintf($fmt, $args);
1063 }
1064
1065 /**
1066  * Internationalized sprintf.
1067  *
1068  * This is essentially the same as PHP's built-in printf with the
1069  * following exceptions:
1070  *
1071  * <ol>
1072  * <li> It passes the format string through gettext().
1073  * <li> It supports the argument reordering extensions.
1074  * </ol>
1075  *
1076  * @see __printf
1077  */
1078 function __sprintf ($fmt) {
1079     $args = func_get_args();
1080     array_shift($args);
1081     return __vsprintf($fmt, $args);
1082 }
1083
1084 /**
1085  * Internationalized vsprintf.
1086  *
1087  * This is essentially the same as PHP's built-in printf with the
1088  * following exceptions:
1089  *
1090  * <ol>
1091  * <li> It passes the format string through gettext().
1092  * <li> It supports the argument reordering extensions.
1093  * </ol>
1094  *
1095  * @see __printf
1096  */
1097 function __vsprintf ($fmt, $args) {
1098     $fmt = gettext($fmt);
1099     // PHP's sprintf doesn't support variable with specifiers,
1100     // like sprintf("%*s", 10, "x"); --- so we won't either.
1101
1102     if (preg_match_all('/(?<!%)%(\d+)\$/x', $fmt, $m)) {
1103         // Format string has '%2$s' style argument reordering.
1104         // PHP doesn't support this.
1105         if (preg_match('/(?<!%)%[- ]?\d*[^- \d$]/x', $fmt))
1106             // literal variable name substitution only to keep locale
1107             // strings uncluttered
1108             trigger_error(sprintf(_("Can't mix '%s' with '%s' type format strings"),
1109                                   '%1\$s','%s'), E_USER_WARNING); //php+locale error
1110
1111         $fmt = preg_replace('/(?<!%)%\d+\$/x', '%', $fmt);
1112         $newargs = array();
1113
1114         // Reorder arguments appropriately.
1115         foreach($m[1] as $argnum) {
1116             if ($argnum < 1 || $argnum > count($args))
1117                 trigger_error(sprintf(_("%s: argument index out of range"),
1118                                       $argnum), E_USER_WARNING);
1119             $newargs[] = $args[$argnum - 1];
1120         }
1121         $args = $newargs;
1122     }
1123
1124     // Not all PHP's have vsprintf, so...
1125     array_unshift($args, $fmt);
1126     return call_user_func_array('sprintf', $args);
1127 }
1128
1129 function file_mtime ($filename) {
1130     if ($stat = stat($filename))
1131         return $stat[9];
1132     else
1133         return false;
1134 }
1135
1136 function sort_file_mtime ($a, $b) {
1137     $ma = file_mtime($a);
1138     $mb = file_mtime($b);
1139     if (!$ma or !$mb or $ma == $mb) return 0;
1140     return ($ma > $mb) ? -1 : 1;
1141 }
1142
1143 class fileSet {
1144     /**
1145      * Build an array in $this->_fileList of files from $dirname.
1146      * Subdirectories are not traversed.
1147      *
1148      * (This was a function LoadDir in lib/loadsave.php)
1149      * See also http://www.php.net/manual/en/function.readdir.php
1150      */
1151     function getFiles($exclude=false,$sortby=false,$limit=false) {
1152         $list = $this->_fileList;
1153         if ($sortby) {
1154             switch (Pagelist::sortby($sortby,'db')) {
1155             case 'pagename ASC': break;
1156             case 'pagename DESC':
1157                 $list = array_reverse($list);
1158                 break;
1159             case 'mtime ASC':
1160                 usort($list,'sort_file_mtime');
1161                 break;
1162             case 'mtime DESC':
1163                 usort($list,'sort_file_mtime');
1164                 $list = array_reverse($list);
1165                 break;
1166             }
1167         }
1168         if ($limit)
1169             return array_splice($list,0,$limit);
1170         return $list;
1171     }
1172
1173     function _filenameSelector($filename) {
1174         if (! $this->_pattern)
1175             return true;
1176         else {
1177             return glob_match ($this->_pattern, $filename, $this->_case);
1178         }
1179     }
1180
1181     function fileSet($directory, $filepattern = false) {
1182         $this->_fileList = array();
1183         $this->_pattern = $filepattern;
1184         $this->_case = !isWindows();
1185         $this->_pathsep = '/';
1186
1187         if (empty($directory)) {
1188             trigger_error(sprintf(_("%s is empty."), 'directoryname'),
1189                           E_USER_NOTICE);
1190             return; // early return
1191         }
1192
1193         @ $dir_handle = opendir($dir=$directory);
1194         if (empty($dir_handle)) {
1195             trigger_error(sprintf(_("Unable to open directory '%s' for reading"),
1196                                   $dir), E_USER_NOTICE);
1197             return; // early return
1198         }
1199
1200         while ($filename = readdir($dir_handle)) {
1201             if ($filename[0] == '.' || filetype($dir . $this->_pathsep . $filename) != 'file')
1202                 continue;
1203             if ($this->_filenameSelector($filename)) {
1204                 array_push($this->_fileList, "$filename");
1205                 //trigger_error(sprintf(_("found file %s"), $filename),
1206                 //                      E_USER_NOTICE); //debugging
1207             }
1208         }
1209         closedir($dir_handle);
1210     }
1211 };
1212
1213 // File globbing
1214
1215 // expands a list containing regex's to its matching entries
1216 class ListRegexExpand {
1217     var $match, $list, $index, $case_sensitive;
1218     function ListRegexExpand (&$list, $match, $case_sensitive = true) {
1219         $this->match = str_replace('/','\/',$match);
1220         $this->list = &$list;
1221         $this->case_sensitive = $case_sensitive;
1222         //$this->index = false;
1223     }
1224     function listMatchCallback ($item, $key) {
1225         if (preg_match('/' . $this->match . ($this->case_sensitive ? '/' : '/i'), $item)) {
1226             unset($this->list[$this->index]);
1227             $this->list[] = $item;
1228         }
1229     }
1230     function expandRegex ($index, &$pages) {
1231         $this->index = $index;
1232         array_walk($pages, array($this, 'listMatchCallback'));
1233         return $this->list;
1234     }
1235 }
1236
1237 // convert fileglob to regex style
1238 function glob_to_pcre ($glob) {
1239     $re = preg_replace('/\./', '\\.', $glob);
1240     $re = preg_replace(array('/\*/','/\?/'), array('.*','.'), $glob);
1241     if (!preg_match('/^[\?\*]/',$glob))
1242         $re = '^' . $re;
1243     if (!preg_match('/[\?\*]$/',$glob))
1244         $re = $re . '$';
1245     return $re;
1246 }
1247
1248 function glob_match ($glob, $against, $case_sensitive = true) {
1249     return preg_match('/' . glob_to_pcre($glob) . ($case_sensitive ? '/' : '/i'), $against);
1250 }
1251
1252 function explodeList($input, $allnames, $glob_style = true, $case_sensitive = true) {
1253     $list = explode(',',$input);
1254     // expand wildcards from list of $allnames
1255     if (preg_match('/[\?\*]/',$input)) {
1256         // Optimizing loop invariants:
1257         // http://phplens.com/lens/php-book/optimizing-debugging-php.php
1258         for ($i = 0, $max = sizeof($list); $i < $max; $i++) {
1259             $f = $list[$i];
1260             if (preg_match('/[\?\*]/',$f)) {
1261                 reset($allnames);
1262                 $expand = new ListRegexExpand($list, $glob_style ? glob_to_pcre($f) : $f, $case_sensitive);
1263                 $expand->expandRegex($i, $allnames);
1264             }
1265         }
1266     }
1267     return $list;
1268 }
1269
1270 // echo implode(":",explodeList("Test*",array("xx","Test1","Test2")));
1271 function explodePageList($input, $perm=false, $sortby='pagename', $limit=false) {
1272     include_once("lib/PageList.php");
1273     return PageList::explodePageList($input,$perm,$sortby,$limit);
1274 }
1275
1276 // Class introspections
1277
1278 /**
1279  * Determine whether object is of a specified type.
1280  * In PHP builtin since 4.2.0 as is_a()
1281  *
1282  * @param $object object An object.
1283  * @param $class string Class name.
1284  * @return bool True iff $object is a $class
1285  * or a sub-type of $class.
1286  */
1287 function isa ($object, $class) {
1288     $lclass = strtolower($class);
1289
1290     return is_object($object)
1291         && ( get_class($object) == strtolower($lclass)
1292              || is_subclass_of($object, $lclass) );
1293 }
1294
1295 /** Determine whether (possible) object has method.
1296  *
1297  * @param $object mixed Object
1298  * @param $method string Method name
1299  * @return bool True iff $object is an object with has method $method.
1300  */
1301 function can ($object, $method) {
1302     return is_object($object) && method_exists($object, strtolower($method));
1303 }
1304
1305 /** Determine whether a function is okay to use.
1306  *
1307  * Some providers (e.g. Lycos) disable some of PHP functions for
1308  * "security reasons."  This makes those functions, of course,
1309  * unusable, despite the fact the function_exists() says they
1310  * exist.
1311  *
1312  * This function test to see if a function exists and is not
1313  * disallowed by PHP's disable_functions config setting.
1314  *
1315  * @param string $function_name  Function name
1316  * @return bool  True iff function can be used.
1317  */
1318 function function_usable($function_name) {
1319     static $disabled;
1320     if (!is_array($disabled)) {
1321         $disabled = array();
1322         // Use get_cfg_var since ini_get() is one of the disabled functions
1323         // (on Lycos, at least.)
1324         $split = preg_split('/\s*,\s*/', trim(get_cfg_var('disable_functions')));
1325         foreach ($split as $f)
1326             $disabled[strtolower($f)] = true;
1327     }
1328
1329     return ( function_exists($function_name)
1330              and ! isset($disabled[strtolower($function_name)])
1331              );
1332 }
1333
1334
1335 /** Hash a value.
1336  *
1337  * This is used for generating ETags.
1338  */
1339 function hash ($x) {
1340     if (is_scalar($x)) {
1341         return $x;
1342     }
1343     elseif (is_array($x)) {
1344         ksort($x);
1345         return md5(serialize($x));
1346     }
1347     elseif (is_object($x)) {
1348         return $x->hash();
1349     }
1350     trigger_error("Can't hash $x", E_USER_ERROR);
1351 }
1352
1353
1354 /**
1355  * Seed the random number generator.
1356  *
1357  * better_srand() ensures the randomizer is seeded only once.
1358  *
1359  * How random do you want it? See:
1360  * http://www.php.net/manual/en/function.srand.php
1361  * http://www.php.net/manual/en/function.mt-srand.php
1362  */
1363 function better_srand($seed = '') {
1364     static $wascalled = FALSE;
1365     if (!$wascalled) {
1366         $seed = $seed === '' ? (double) microtime() * 1000000 : $seed;
1367         srand($seed);
1368         $wascalled = TRUE;
1369         //trigger_error("new random seed", E_USER_NOTICE); //debugging
1370     }
1371 }
1372
1373 /**
1374  * Recursively count all non-empty elements
1375  * in array of any dimension or mixed - i.e.
1376  * array('1' => 2, '2' => array('1' => 3, '2' => 4))
1377  * See http://www.php.net/manual/en/function.count.php
1378  */
1379 function count_all($arg) {
1380     // skip if argument is empty
1381     if ($arg) {
1382         //print_r($arg); //debugging
1383         $count = 0;
1384         // not an array, return 1 (base case)
1385         if(!is_array($arg))
1386             return 1;
1387         // else call recursively for all elements $arg
1388         foreach($arg as $key => $val)
1389             $count += count_all($val);
1390         return $count;
1391     }
1392 }
1393
1394 function isSubPage($pagename) {
1395     return (strstr($pagename, SUBPAGE_SEPARATOR));
1396 }
1397
1398 function subPageSlice($pagename, $pos) {
1399     $pages = explode(SUBPAGE_SEPARATOR,$pagename);
1400     $pages = array_slice($pages,$pos,1);
1401     return $pages[0];
1402 }
1403
1404 /**
1405  * Alert
1406  *
1407  * Class for "popping up" and alert box.  (Except that right now, it doesn't
1408  * pop up...)
1409  *
1410  * FIXME:
1411  * This is a hackish and needs to be refactored.  However it would be nice to
1412  * unify all the different methods we use for showing Alerts and Dialogs.
1413  * (E.g. "Page deleted", login form, ...)
1414  */
1415 class Alert {
1416     /** Constructor
1417      *
1418      * @param object $request
1419      * @param mixed $head  Header ("title") for alert box.
1420      * @param mixed $body  The text in the alert box.
1421      * @param hash $buttons  An array mapping button labels to URLs.
1422      *    The default is a single "Okay" button pointing to $request->getURLtoSelf().
1423      */
1424     function Alert($head, $body, $buttons=false) {
1425         if ($buttons === false)
1426             $buttons = array();
1427
1428         $this->_tokens = array('HEADER' => $head, 'CONTENT' => $body);
1429         $this->_buttons = $buttons;
1430     }
1431
1432     /**
1433      * Show the alert box.
1434      */
1435     function show(&$request) {
1436         global $request;
1437
1438         $tokens = $this->_tokens;
1439         $tokens['BUTTONS'] = $this->_getButtons();
1440
1441         $request->discardOutput();
1442         $tmpl = new Template('dialog', $request, $tokens);
1443         $tmpl->printXML();
1444         $request->finish();
1445     }
1446
1447
1448     function _getButtons() {
1449         global $request;
1450
1451         $buttons = $this->_buttons;
1452         if (!$buttons)
1453             $buttons = array(_("Okay") => $request->getURLtoSelf());
1454
1455         global $WikiTheme;
1456         foreach ($buttons as $label => $url)
1457             print "$label $url\n";
1458             $out[] = $WikiTheme->makeButton($label, $url, 'wikiaction');
1459         return new XmlContent($out);
1460     }
1461 }
1462
1463 // 1.3.8     => 1030.08
1464 // 1.3.9-p1  => 1030.091
1465 // 1.3.10pre => 1030.099
1466 function phpwiki_version() {
1467     static $PHPWIKI_VERSION;
1468     if (!isset($PHPWIKI_VERSION)) {
1469         $arr = explode('.',preg_replace('/\D+$/','', PHPWIKI_VERSION)); // remove the pre
1470         $arr[2] = preg_replace('/\.+/','.',preg_replace('/\D/','.',$arr[2]));
1471         $PHPWIKI_VERSION = $arr[0]*1000 + $arr[1]*10 + 0.01*$arr[2];
1472         if (substr(PHPWIKI_VERSION,-3,3) == 'pre')
1473             $PHPWIKI_VERSION -= 0.001;
1474     }
1475     return $PHPWIKI_VERSION;
1476 }
1477
1478 function isWikiWord($word) {
1479     global $WikiNameRegexp;
1480     //or preg_match('/\A' . $WikiNameRegexp . '\z/', $word) ??
1481     return preg_match("/^$WikiNameRegexp\$/",$word);
1482 }
1483
1484 // needed to store serialized objects-values only (perm, pref)
1485 function obj2hash ($obj, $exclude = false, $fields = false) {
1486     $a = array();
1487     if (! $fields ) $fields = get_object_vars($obj);
1488     foreach ($fields as $key => $val) {
1489         if (is_array($exclude)) {
1490             if (in_array($key,$exclude)) continue;
1491         }
1492         $a[$key] = $val;
1493     }
1494     return $a;
1495 }
1496
1497 /**
1498  * isUtf8String($string) - cheap utf-8 detection
1499  *
1500  * segfaults for strings longer than 10kb!
1501  * Use http://www.phpdiscuss.com/article.php?id=565&group=php.i18n or
1502  * checkTitleEncoding() at http://cvs.sourceforge.net/viewcvs.py/wikipedia/phase3/languages/Language.php
1503  */
1504 function isUtf8String( $s ) {
1505     $ptrASCII  = '[\x00-\x7F]';
1506     $ptr2Octet = '[\xC2-\xDF][\x80-\xBF]';
1507     $ptr3Octet = '[\xE0-\xEF][\x80-\xBF]{2}';
1508     $ptr4Octet = '[\xF0-\xF4][\x80-\xBF]{3}';
1509     $ptr5Octet = '[\xF8-\xFB][\x80-\xBF]{4}';
1510     $ptr6Octet = '[\xFC-\xFD][\x80-\xBF]{5}';
1511     return preg_match("/^($ptrASCII|$ptr2Octet|$ptr3Octet|$ptr4Octet|$ptr5Octet|$ptr6Octet)*$/s", $s);
1512 }
1513
1514 /**
1515  * Check for UTF-8 URLs; Internet Explorer produces these if you
1516  * type non-ASCII chars in the URL bar or follow unescaped links.
1517  * Requires urldecoded pagename.
1518  * Fixes sf.net bug #953949
1519  *
1520  * src: languages/Language.php:checkTitleEncoding() from mediawiki
1521  */
1522 function fixTitleEncoding( $s ) {
1523     global $charset;
1524
1525     $s = trim($s);
1526     // print a warning?
1527     if (empty($s)) return $s;
1528
1529     $ishigh = preg_match( '/[\x80-\xff]/', $s);
1530     /*
1531     $isutf = ($ishigh ? preg_match( '/^([\x00-\x7f]|[\xc0-\xdf][\x80-\xbf]|' .
1532                                     '[\xe0-\xef][\x80-\xbf]{2}|[\xf0-\xf7][\x80-\xbf]{3})+$/', $s ) : true );
1533     */
1534     $isutf = ($ishigh ? isUtf8String($s) : true);
1535
1536     if( (strtolower($charset) != "utf-8") and $ishigh and $isutf )
1537         // if charset == 'iso-8859-1' then simply use utf8_decode()
1538         if (strtolower($charset) == 'iso-8859-1')
1539             return utf8_decode( $s );
1540         else
1541             // TODO: check for iconv support
1542             return iconv( "UTF-8", $charset, $s );
1543
1544     if( (strtolower($charset) == "utf-8") and $ishigh and !$isutf )
1545         return utf8_encode( $s );
1546
1547     // Other languages can safely leave this function, or replace
1548     // it with one to detect and convert another legacy encoding.
1549     return $s;
1550 }
1551
1552 /**
1553  * MySQL fulltext index doesn't grok utf-8, so we
1554  * need to fold cases and convert to hex.
1555  * src: languages/Language.php:stripForSearch() from mediawiki
1556  */
1557 /*
1558 function stripForSearch( $string ) {
1559     global $wikiLowerChars;
1560     // '/(?:[a-z]|\xc3[\x9f-\xbf]|\xc4[\x81\x83\x85\x87])/' => "a-z\xdf-\xf6\xf8-\xff"
1561     return preg_replace(
1562                         "/([\\xc0-\\xff][\\x80-\\xbf]*)/e",
1563                         "'U8' . bin2hex( strtr( \"\$1\", \$wikiLowerChars ) )",
1564                         $string );
1565 }
1566 */
1567
1568 /**
1569  * Workaround for allow_url_fopen, to get the content of an external URI.
1570  * It returns the contents in one slurp. Parsers might want to check for allow_url_fopen
1571  * and use fopen, fread chunkwise. (see lib/XmlParser.php)
1572  */
1573 function url_get_contents( $uri ) {
1574     if (get_cfg_var('allow_url_fopen')) { // was ini_get('allow_url_fopen'))
1575         return @file_get_contents($uri);
1576     } else {
1577         require_once("lib/HttpClient.php");
1578         $bits = parse_url($uri);
1579         $host = $bits['host'];
1580         $port = isset($bits['port']) ? $bits['port'] : 80;
1581         $path = isset($bits['path']) ? $bits['path'] : '/';
1582         if (isset($bits['query'])) {
1583             $path .= '?'.$bits['query'];
1584         }
1585         $client = new HttpClient($host, $port);
1586         $client->use_gzip = false;
1587         if (!$client->get($path)) {
1588             return false;
1589         } else {
1590             return $client->getContent();
1591         }
1592     }
1593 }
1594
1595
1596 // $Log: not supported by cvs2svn $
1597 // Revision 1.186  2004/06/13 13:54:25  rurban
1598 // Catch fatals on the four dump calls (as file and zip, as html and mimified)
1599 // FoafViewer: Check against external requirements, instead of fatal.
1600 // Change output for xhtmldumps: using file:// urls to the local fs.
1601 // Catch SOAP fatal by checking for GOOGLE_LICENSE_KEY
1602 // Import GOOGLE_LICENSE_KEY and FORTUNE_DIR from config.ini.
1603 //
1604 // Revision 1.185  2004/06/11 09:07:30  rurban
1605 // support theme-specific LinkIconAttr: front or after or none
1606 //
1607 // Revision 1.184  2004/06/04 20:32:53  rurban
1608 // Several locale related improvements suggested by Pierrick Meignen
1609 // LDAP fix by John Cole
1610 // reanable admin check without ENABLE_PAGEPERM in the admin plugins
1611 //
1612 // Revision 1.183  2004/06/01 10:22:56  rurban
1613 // added url_get_contents() used in XmlParser and elsewhere
1614 //
1615 // Revision 1.182  2004/05/25 12:40:48  rurban
1616 // trim the pagename
1617 //
1618 // Revision 1.181  2004/05/25 10:18:44  rurban
1619 // Check for UTF-8 URLs; Internet Explorer produces these if you
1620 // type non-ASCII chars in the URL bar or follow unescaped links.
1621 // Fixes sf.net bug #953949
1622 // src: languages/Language.php:checkTitleEncoding() from mediawiki
1623 //
1624 // Revision 1.180  2004/05/18 16:23:39  rurban
1625 // rename split_pagename to SplitPagename
1626 //
1627 // Revision 1.179  2004/05/18 16:18:37  rurban
1628 // AutoSplit at subpage seperators
1629 // RssFeed stability fix for empty feeds or broken connections
1630 //
1631 // Revision 1.178  2004/05/12 10:49:55  rurban
1632 // require_once fix for those libs which are loaded before FileFinder and
1633 //   its automatic include_path fix, and where require_once doesn't grok
1634 //   dirname(__FILE__) != './lib'
1635 // upgrade fix with PearDB
1636 // navbar.tmpl: remove spaces for IE &nbsp; button alignment
1637 //
1638 // Revision 1.177  2004/05/08 14:06:12  rurban
1639 // new support for inlined image attributes: [image.jpg size=50x30 align=right]
1640 // minor stability and portability fixes
1641 //
1642 // Revision 1.176  2004/05/08 11:25:15  rurban
1643 // php-4.0.4 fixes
1644 //
1645 // Revision 1.175  2004/05/06 17:30:38  rurban
1646 // CategoryGroup: oops, dos2unix eol
1647 // improved phpwiki_version:
1648 //   pre -= .0001 (1.3.10pre: 1030.099)
1649 //   -p1 += .001 (1.3.9-p1: 1030.091)
1650 // improved InstallTable for mysql and generic SQL versions and all newer tables so far.
1651 // abstracted more ADODB/PearDB methods for action=upgrade stuff:
1652 //   backend->backendType(), backend->database(),
1653 //   backend->listOfFields(),
1654 //   backend->listOfTables(),
1655 //
1656 // Revision 1.174  2004/05/06 12:02:05  rurban
1657 // fix sf.net bug#949002: [ Link | ] assertion
1658 //
1659 // Revision 1.173  2004/05/03 15:00:31  rurban
1660 // added more database upgrading: session.sess_ip, page.id autp_increment
1661 //
1662 // Revision 1.172  2004/04/26 20:44:34  rurban
1663 // locking table specific for better databases
1664 //
1665 // Revision 1.171  2004/04/19 23:13:03  zorloc
1666 // Connect the rest of PhpWiki to the IniConfig system.  Also the keyword regular expression is not a config setting
1667 //
1668 // Revision 1.170  2004/04/19 18:27:45  rurban
1669 // Prevent from some PHP5 warnings (ref args, no :: object init)
1670 //   php5 runs now through, just one wrong XmlElement object init missing
1671 // Removed unneccesary UpgradeUser lines
1672 // Changed WikiLink to omit version if current (RecentChanges)
1673 //
1674 // Revision 1.169  2004/04/15 21:29:48  rurban
1675 // allow [0] with new markup: link to page "0"
1676 //
1677 // Revision 1.168  2004/04/10 02:30:49  rurban
1678 // Fixed gettext problem with VIRTUAL_PATH scripts (Windows only probably)
1679 // Fixed "cannot setlocale..." (sf.net problem)
1680 //
1681 // Revision 1.167  2004/04/02 15:06:55  rurban
1682 // fixed a nasty ADODB_mysql session update bug
1683 // improved UserPreferences layout (tabled hints)
1684 // fixed UserPreferences auth handling
1685 // improved auth stability
1686 // improved old cookie handling: fixed deletion of old cookies with paths
1687 //
1688 // Revision 1.166  2004/04/01 15:57:10  rurban
1689 // simplified Sidebar theme: table, not absolute css positioning
1690 // added the new box methods.
1691 // remaining problems: large left margin, how to override _autosplitWikiWords in Template only
1692 //
1693 // Revision 1.165  2004/03/24 19:39:03  rurban
1694 // php5 workaround code (plus some interim debugging code in XmlElement)
1695 //   php5 doesn't work yet with the current XmlElement class constructors,
1696 //   WikiUserNew does work better than php4.
1697 // rewrote WikiUserNew user upgrading to ease php5 update
1698 // fixed pref handling in WikiUserNew
1699 // added Email Notification
1700 // added simple Email verification
1701 // removed emailVerify userpref subclass: just a email property
1702 // changed pref binary storage layout: numarray => hash of non default values
1703 // print optimize message only if really done.
1704 // forced new cookie policy: delete pref cookies, use only WIKI_ID as plain string.
1705 //   prefs should be stored in db or homepage, besides the current session.
1706 //
1707 // Revision 1.164  2004/03/18 21:41:09  rurban
1708 // fixed sqlite support
1709 // WikiUserNew: PHP5 fixes: don't assign $this (untested)
1710 //
1711 // Revision 1.163  2004/03/17 18:41:49  rurban
1712 // just reformatting
1713 //
1714 // Revision 1.162  2004/03/16 15:43:08  rurban
1715 // make fileSet sortable to please PageList
1716 //
1717 // Revision 1.161  2004/03/12 15:48:07  rurban
1718 // fixed explodePageList: wrong sortby argument order in UnfoldSubpages
1719 // simplified lib/stdlib.php:explodePageList
1720 //
1721 // Revision 1.160  2004/02/28 21:14:08  rurban
1722 // generally more PHPDOC docs
1723 //   see http://xarch.tu-graz.ac.at/home/rurban/phpwiki/xref/
1724 // fxied WikiUserNew pref handling: empty theme not stored, save only
1725 //   changed prefs, sql prefs improved, fixed password update,
1726 //   removed REPLACE sql (dangerous)
1727 // moved gettext init after the locale was guessed
1728 // + some minor changes
1729 //
1730 // Revision 1.158  2004/02/19 21:54:17  rurban
1731 // moved initerwiki code to PageType.php
1732 // re-enabled and fixed InlineImages support, now also for InterWiki Urls
1733 //      * [File:my_image.gif] inlines the image,
1734 //      * File:my_image.gif shows a plain inter-wiki link,
1735 //      * [what a pic|File:my_image.gif] shows a named inter-wiki link to the gif
1736 //      * [File:my_image.gif|what a pic] shows a inlimed image linked to the page "what a pic"
1737 //
1738 // Revision 1.157  2004/02/09 03:58:12  rurban
1739 // for now default DB_SESSION to false
1740 // PagePerm:
1741 //   * not existing perms will now query the parent, and not
1742 //     return the default perm
1743 //   * added pagePermissions func which returns the object per page
1744 //   * added getAccessDescription
1745 // WikiUserNew:
1746 //   * added global ->prepare (not yet used) with smart user/pref/member table prefixing.
1747 //   * force init of authdbh in the 2 db classes
1748 // main:
1749 //   * fixed session handling (not triple auth request anymore)
1750 //   * don't store cookie prefs with sessions
1751 // stdlib: global obj2hash helper from _AuthInfo, also needed for PagePerm
1752 //
1753 // Revision 1.156  2004/01/26 09:17:49  rurban
1754 // * changed stored pref representation as before.
1755 //   the array of objects is 1) bigger and 2)
1756 //   less portable. If we would import packed pref
1757 //   objects and the object definition was changed, PHP would fail.
1758 //   This doesn't happen with an simple array of non-default values.
1759 // * use $prefs->retrieve and $prefs->store methods, where retrieve
1760 //   understands the interim format of array of objects also.
1761 // * simplified $prefs->get() and fixed $prefs->set()
1762 // * added $user->_userid and class '_WikiUser' portability functions
1763 // * fixed $user object ->_level upgrading, mostly using sessions.
1764 //   this fixes yesterdays problems with loosing authorization level.
1765 // * fixed WikiUserNew::checkPass to return the _level
1766 // * fixed WikiUserNew::isSignedIn
1767 // * added explodePageList to class PageList, support sortby arg
1768 // * fixed UserPreferences for WikiUserNew
1769 // * fixed WikiPlugin for empty defaults array
1770 // * UnfoldSubpages: added pagename arg, renamed pages arg,
1771 //   removed sort arg, support sortby arg
1772 //
1773 // Revision 1.155  2004/01/25 10:52:22  rurban
1774 // added sortby support to explodePageList() and UnfoldSubpages
1775 // fixes [ 758044 ] Plugin UnfoldSubpages does not sort (includes fix)
1776 //
1777 // Revision 1.154  2004/01/25 03:49:03  rurban
1778 // added isWikiWord() to avoid redundancy
1779 // added check_php_version() to check for older php versions.
1780 //   e.g. object::method calls, ...
1781 //
1782 // Revision 1.153  2003/11/30 18:43:18  carstenklapp
1783 // Fixed careless mistakes in my last optimization commit.
1784 //
1785 // Revision 1.152  2003/11/30 18:20:34  carstenklapp
1786 // Minor code optimization: reduce invariant loops
1787 //
1788 // Revision 1.151  2003/11/29 19:30:01  carstenklapp
1789 // New function ByteFormatter.
1790 //
1791 // Revision 1.150  2003/09/13 22:43:00  carstenklapp
1792 // New preference to hide LinkIcons.
1793 //
1794 // Revision 1.149  2003/03/26 19:37:08  dairiki
1795 // Fix "object to string conversion" bug with external image links.
1796 //
1797 // Revision 1.148  2003/03/25 21:03:02  dairiki
1798 // Cleanup debugging output.
1799 //
1800 // Revision 1.147  2003/03/13 20:17:05  dairiki
1801 // Bug fix: Fix linking of pages whose names contain a hash ('#').
1802 //
1803 // Revision 1.146  2003/03/07 02:46:24  dairiki
1804 // function_usable(): New function.
1805 //
1806 // Revision 1.145  2003/03/04 01:55:05  dairiki
1807 // Fix to ensure absolute URL for logo in RSS recent changes.
1808 //
1809 // Revision 1.144  2003/02/26 00:39:30  dairiki
1810 // Bug fix: for magic PhpWiki URLs, "lock page to enable link" message was
1811 // being displayed at incorrect times.
1812 //
1813 // Revision 1.143  2003/02/26 00:10:26  dairiki
1814 // More/better/different checks for bad page names.
1815 //
1816 // Revision 1.142  2003/02/25 22:19:46  dairiki
1817 // Add some sanity checking for pagenames.
1818 //
1819 // Revision 1.141  2003/02/22 20:49:55  dairiki
1820 // Fixes for "Call-time pass by reference has been deprecated" errors.
1821 //
1822 // Revision 1.140  2003/02/21 23:33:29  dairiki
1823 // Set alt="" on the link icon image tags.
1824 // (See SF bug #675141.)
1825 //
1826 // Revision 1.139  2003/02/21 22:16:27  dairiki
1827 // Get rid of MakeWikiForm, and form-style MagicPhpWikiURLs.
1828 // These have been obsolete for quite awhile (I hope).
1829 //
1830 // Revision 1.138  2003/02/21 04:12:36  dairiki
1831 // WikiPageName: fixes for new cached links.
1832 //
1833 // Alert: new class for displaying alerts.
1834 //
1835 // ExtractWikiPageLinks and friends are now gone.
1836 //
1837 // LinkBracketLink moved to InlineParser.php
1838 //
1839 // Revision 1.137  2003/02/18 23:13:40  dairiki
1840 // Wups again.  Typo fix.
1841 //
1842 // Revision 1.136  2003/02/18 21:52:07  dairiki
1843 // Fix so that one can still link to wiki pages with # in their names.
1844 // (This was made difficult by the introduction of named tags, since
1845 // '[Page #1]' is now a link to anchor '1' in page 'Page'.
1846 //
1847 // Now the ~ escape for page names should work: [Page ~#1].
1848 //
1849 // Revision 1.135  2003/02/18 19:17:04  dairiki
1850 // SplitPagename():
1851 //     Bug fix. 'ThisIsABug' was being split to 'This IsA Bug'.
1852 //     Cleanup up subpage splitting code.
1853 //
1854 // Revision 1.134  2003/02/16 19:44:20  dairiki
1855 // New function hash().  This is a helper, primarily for generating
1856 // HTTP ETags.
1857 //
1858 // Revision 1.133  2003/02/16 04:50:09  dairiki
1859 // New functions:
1860 // Rfc1123DateTime(), ParseRfc1123DateTime()
1861 // for converting unix timestamps to and from strings.
1862 //
1863 // These functions produce and grok the time strings
1864 // in the format specified by RFC 2616 for use in HTTP headers
1865 // (like Last-Modified).
1866 //
1867 // Revision 1.132  2003/01/04 22:19:43  carstenklapp
1868 // Bugfix UnfoldSubpages: "Undefined offset: 1" error when plugin invoked
1869 // on a page with no subpages (explodeList(): array 0-based, sizeof 1-based).
1870 //
1871
1872 // (c-file-style: "gnu")
1873 // Local Variables:
1874 // mode: php
1875 // tab-width: 8
1876 // c-basic-offset: 4
1877 // c-hanging-comment-ender-p: nil
1878 // indent-tabs-mode: nil
1879 // End:
1880 ?>