lib/stdlib.php

   1 <?php // $Id$
   2 /*
   3  * Copyright 1999-2008 $ThePhpWikiProgrammingTeam
   4  * Copyright 2008-2009 Marc-Etienne Vargenau, Alcatel-Lucent
   5  *
   6  * This file is part of PhpWiki.
   7  *
   8  * PhpWiki is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * PhpWiki is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21  */
  22
  23 /*
  24   Standard functions for Wiki functionality
  25     WikiURL ($pagename, $args, $get_abs_url)
  26     AbsoluteURL ($url)
  27     IconForLink ($protocol_or_url)
  28     PossiblyGlueIconToText($proto_or_url, $text)
  29     IsSafeURL($url)
  30     LinkURL ($url, $linktext)
  31     LinkImage ($url, $alt)
  32     ImgObject ($img, $url)
  33
  34     SplitQueryArgs ($query_args)
  35     LinkPhpwikiURL ($url, $text, $basepage)
  36     ConvertOldMarkup ($content, $markup_type = "block")
  37     MangleXmlIdentifier($str)
  38     UnMangleXmlIdentifier($str)
  39
  40     class Stack { push($item), pop(), cnt(), top() }
  41     class Alert { show() }
  42     class WikiPageName {getParent(),isValid(),getWarnings() }
  43
  44     expand_tabs($str, $tab_width = 8)
  45     SplitPagename ($page)
  46     NoSuchRevision ($request, $page, $version)
  47     TimezoneOffset ($time, $no_colon)
  48     Iso8601DateTime ($time)
  49     Rfc2822DateTime ($time)
  50     ParseRfc1123DateTime ($timestr)
  51     CTime ($time)
  52     ByteFormatter ($bytes = 0, $longformat = false)
  53     __printf ($fmt)
  54     __sprintf ($fmt)
  55     __vsprintf ($fmt, $args)
  56
  57     file_mtime ($filename)
  58     sort_file_mtime ($a, $b)
  59     class fileSet {fileSet($directory, $filepattern = false),
  60                    getFiles($exclude='', $sortby='', $limit='') }
  61     class ListRegexExpand { listMatchCallback($item, $key),
  62                             expandRegex ($index, &$pages) }
  63
  64     glob_to_pcre ($glob)
  65     glob_match ($glob, $against, $case_sensitive = true)
  66     explodeList ($input, $allnames, $glob_style = true, $case_sensitive = true)
  67     explodePageList ($input, $perm = false)
  68     isa ($object, $class)
  69     can ($object, $method)
  70     function_usable ($function_name)
  71     wikihash ($x)
  72     better_srand ($seed = '')
  73     count_all ($arg)
  74     isSubPage ($pagename)
  75     subPageSlice ($pagename, $pos)
  76     isActionPage ($filename)
  77
  78     phpwiki_version ()
  79     isWikiWord ($word)
  80     obj2hash ($obj, $exclude = false, $fields = false)
  81     isUtf8String ($s)
  82     fixTitleEncoding ($s)
  83     url_get_contents ($uri)
  84     GenerateId ($name)
  85     firstNWordsOfContent ($n, $content)
  86     extractSection ($section, $content, $page, $quiet = false, $sectionhead = false)
  87     isExternalReferrer()
  88
  89     charset_convert($from, $to, $data)
  90     string_starts_with($string, $prefix)
  91     string_ends_with($string, $suffix)
  92     array_remove($arr,$value)
  93     longer_timeout($secs=30)
  94     printSimpleTrace($bt)
  95     getMemoryUsage()
  96     binary_search($needle, $haystack)
  97     is_localhost($url)
  98     javascript_quote_string($s)
  99     isSerialized($s)
 100     is_whole_number($var)
 101     parse_attributes($line)
 102     is_image ($filename)
 103     is_video ($filename)
 104
 105   function: linkExistingWikiWord($wikiword, $linktext, $version)
 106   moved to: lib/WikiTheme.php
 107 */
 108 if (defined('_PHPWIKI_STDLIB_LOADED')) return;
 109 else define('_PHPWIKI_STDLIB_LOADED', true);
 110
 111 if (!defined('MAX_PAGENAME_LENGTH')) {
 112     define('MAX_PAGENAME_LENGTH', 100);
 113 }
 114
 115 /**
 116  * Convert string to a valid XML identifier.
 117  *
 118  * XML 1.0 identifiers are of the form: [A-Za-z][A-Za-z0-9:_.-]*
 119  *
 120  * We would like to have, e.g. named anchors within wiki pages
 121  * names like "Table of Contents" --- clearly not a valid XML
 122  * fragment identifier.
 123  *
 124  * This function implements a one-to-one map from {any string}
 125  * to {valid XML identifiers}.
 126  *
 127  * It does this by
 128  * converting all bytes not in [A-Za-z0-9:_-],
 129  * and any leading byte not in [A-Za-z] to 'xbb.',
 130  * where 'bb' is the hexadecimal representation of the
 131  * character.
 132  *
 133  * As a special case, the empty string is converted to 'empty.'
 134  *
 135  * @param string $str
 136  * @return string
 137  */
 138 function MangleXmlIdentifier($str) {
 139     if (!$str)
 140         return 'empty.';
 141
 142     return preg_replace('/[^-_:A-Za-z0-9]|(?<=^)[^A-Za-z]/e',
 143                         "'x' . sprintf('%02x', ord('\\0')) . '.'",
 144                         $str);
 145 }
 146
 147 function UnMangleXmlIdentifier($str) {
 148     if ($str == 'empty.')
 149         return '';
 150     return preg_replace('/x(\w\w)\./e',
 151                         "sprintf('%c', hex('\\0'))",
 152                         $str);
 153 }
 154
 155 /**
 156 * Returns a name for the WIKI_ID cookie that should be unique on the host.
 157 * But for it to be unique you must have set a unique WIKI_NAME in your
 158 * configuration file.
 159 * @return string The name of the WIKI_ID cookie to use for this wiki.
 160 */
 161 function getCookieName() {
 162     return preg_replace("/[^\d\w]/", "_", WIKI_NAME) . "_WIKI_ID";
 163 }
 164
 165 /**
 166  * Generates a valid URL for a given Wiki pagename.
 167  * @param mixed $pagename If a string this will be the name of the Wiki page to link to.
 168  *               If a WikiDB_Page object function will extract the name to link to.
 169  *               If a WikiDB_PageRevision object function will extract the name to link to.
 170  * @param array $args
 171  * @param boolean $get_abs_url Default value is false.
 172  * @return string The absolute URL to the page passed as $pagename.
 173  */
 174 function WikiURL($pagename, $args = '', $get_abs_url = false) {
 175     global $request, $WikiTheme;
 176     $anchor = false;
 177
 178     if (is_object($pagename)) {
 179         if (isa($pagename, 'WikiDB_Page')) {
 180             $pagename = $pagename->getName();
 181         }
 182         elseif (isa($pagename, 'WikiDB_PageRevision')) {
 183             $page = $pagename->getPage();
 184             $args['version'] = $pagename->getVersion();
 185             $pagename = $page->getName();
 186         }
 187         elseif (isa($pagename, 'WikiPageName')) {
 188             $anchor = $pagename->anchor;
 189             $pagename = $pagename->name;
 190         } else { // php5
 191             $anchor = $pagename->anchor;
 192             $pagename = $pagename->name;
 193         }
 194     }
 195     if (!$get_abs_url and DEBUG and $request->getArg('start_debug')) {
 196         if (!$args)
 197             $args = 'start_debug=' . $request->getArg('start_debug');
 198         elseif (is_array($args))
 199             $args['start_debug'] = $request->getArg('start_debug');
 200         else
 201             $args .= '&start_debug=' . $request->getArg('start_debug');
 202     }
 203     if (is_array($args)) {
 204         $enc_args = array();
 205         foreach ($args as $key => $val) {
 206             // avoid default args
 207             if (USE_PATH_INFO and $key == 'pagename')
 208                 ;
 209             elseif ($key == 'action' and $val == 'browse')
 210             ;
 211             elseif (!is_array($val)) // ugly hack for getURLtoSelf() which also takes POST vars
 212               $enc_args[] = urlencode($key) . '=' . urlencode($val);
 213         }
 214         $args = join('&', $enc_args);
 215     }
 216
 217     if (USE_PATH_INFO or !empty($WikiTheme->HTML_DUMP_SUFFIX)) {
 218         $url = $get_abs_url ? (SERVER_URL . VIRTUAL_PATH . "/") : "";
 219     $base = preg_replace('/%2f/i', '/', rawurlencode($pagename));
 220     $url .= $base;
 221         if (!empty($WikiTheme->HTML_DUMP_SUFFIX)) {
 222         if (!empty($WikiTheme->VALID_LINKS) and $request->getArg('action') == 'pdf') {
 223             if (!in_array($pagename, $WikiTheme->VALID_LINKS))
 224                 $url = '';
 225             else
 226             $url = $base . $WikiTheme->HTML_DUMP_SUFFIX;
 227         } else {
 228         $url .= $WikiTheme->HTML_DUMP_SUFFIX;
 229         if ($args)
 230             $url .= "?$args";
 231         }
 232         } else {
 233         if ($args)
 234         $url .= "?$args";
 235     }
 236     }
 237     else {
 238         $url = $get_abs_url ? SERVER_URL . SCRIPT_NAME : basename(SCRIPT_NAME);
 239         $url .= "?pagename=" . rawurlencode($pagename);
 240         if ($args)
 241             $url .= "&$args";
 242     }
 243     if ($anchor)
 244         $url .= "#" . MangleXmlIdentifier($anchor);
 245     return $url;
 246 }
 247
 248 /** Convert relative URL to absolute URL.
 249  *
 250  * This converts a relative URL to one of PhpWiki's support files
 251  * to an absolute one.
 252  *
 253  * @param string $url
 254  * @return string Absolute URL
 255  */
 256 function AbsoluteURL ($url) {
 257     if (preg_match('/^https?:/', $url))
 258         return $url;
 259     if ($url[0] != '/') {
 260         $base = USE_PATH_INFO ? VIRTUAL_PATH : dirname(SCRIPT_NAME);
 261         while ($base != '/' and substr($url, 0, 3) == "../") {
 262             $url = substr($url, 3);
 263             $base = dirname($base);
 264         }
 265         if ($base != '/')
 266             $base .= '/';
 267         $url = $base . $url;
 268     }
 269     return SERVER_URL . $url;
 270 }
 271
 272 function DataURL ($url) {
 273     if (preg_match('/^https?:/', $url))
 274         return $url;
 275     $url = NormalizeWebFileName($url);
 276     if (DEBUG and $GLOBALS['request']->getArg('start_debug') and substr($url,-4,4) == '.php')
 277         $url .= "?start_debug=1"; // XMLRPC and SOAP debugging helper.
 278     return AbsoluteURL($url);
 279 }
 280
 281 /**
 282  * Generates icon in front of links.
 283  *
 284  * @param string $protocol_or_url URL or protocol to determine which icon to use.
 285  *
 286  * @return HtmlElement HtmlElement object that contains data to create img link to
 287  * icon for use with url or protocol passed to the function. False if no img to be
 288  * displayed.
 289  */
 290 function IconForLink($protocol_or_url) {
 291     global $WikiTheme;
 292     if (0 and $filename_suffix == false) {
 293         // display apache style icon for file type instead of protocol icon
 294         // - archive: unix:gz,bz2,tgz,tar,z; mac:dmg,dmgz,bin,img,cpt,sit; pc:zip;
 295         // - document: html, htm, text, txt, rtf, pdf, doc
 296         // - non-inlined image: jpg,jpeg,png,gif,tiff,tif,swf,pict,psd,eps,ps
 297         // - audio: mp3,mp2,aiff,aif,au
 298         // - multimedia: mpeg,mpg,mov,qt
 299     } else {
 300         list ($proto) = explode(':', $protocol_or_url, 2);
 301         $src = $WikiTheme->getLinkIconURL($proto);
 302         if ($src)
 303             return HTML::img(array('src' => $src, 'alt' => "", 'class' => 'linkicon'));
 304         else
 305             return false;
 306     }
 307 }
 308
 309 /**
 310  * Glue icon in front of or after text.
 311  * Pref: 'noLinkIcons'      - ignore icon if set
 312  * WikiTheme: 'LinkIcons'   - 'yes'   at front
 313  *                          - 'no'    display no icon
 314  *                          - 'front' display at left
 315  *                          - 'after' display at right
 316  *
 317  * @param string $protocol_or_url Protocol or URL.  Used to determine the
 318  * proper icon.
 319  * @param string $text The text.
 320  * @return XmlContent.
 321  */
 322 function PossiblyGlueIconToText($proto_or_url, $text) {
 323     global $request, $WikiTheme;
 324     if ($request->getPref('noLinkIcons'))
 325         return $text;
 326     $icon = IconForLink($proto_or_url);
 327     if (!$icon)
 328         return $text;
 329     if ($where = $WikiTheme->getLinkIconAttr()) {
 330         if ($where == 'no') return $text;
 331         if ($where != 'after') $where = 'front';
 332     } else {
 333         $where = 'front';
 334     }
 335     if ($where == 'after') {
 336         // span the icon only to the last word (tie them together),
 337         // to let the previous words wrap on line breaks.
 338         if (!is_object($text)) {
 339             preg_match('/^(\s*\S*)(\s*)$/', $text, $m);
 340             list (, $prefix, $last_word) = $m;
 341         }
 342         else {
 343             $last_word = $text;
 344             $prefix = false;
 345         }
 346         $text = HTML::span(array('style' => 'white-space: nowrap'),
 347                            $last_word, HTML::Raw('&nbsp;'), $icon);
 348         if ($prefix)
 349             $text = HTML($prefix, $text);
 350         return $text;
 351     }
 352     // span the icon only to the first word (tie them together),
 353     // to let the next words wrap on line breaks
 354     if (!is_object($text)) {
 355         preg_match('/^\s*(\S*)(.*?)\s*$/', $text, $m);
 356         list (, $first_word, $tail) = $m;
 357     }
 358     else {
 359         $first_word = $text;
 360         $tail = false;
 361     }
 362     $text = HTML::span(array('style' => 'white-space: nowrap'),
 363                        $icon, $first_word);
 364     if ($tail)
 365         $text = HTML($text, $tail);
 366     return $text;
 367 }
 368
 369 /**
 370  * Determines if the url passed to function is safe, by detecting if the characters
 371  * '<', '>', or '"' are present.
 372  * Check against their urlencoded values also.
 373  *
 374  * @param string $url URL to check for unsafe characters.
 375  * @return boolean True if same, false else.
 376  */
 377 function IsSafeURL($url) {
 378     return !preg_match('/([<>"])|(%3C)|(%3E)|(%22)/', $url);
 379 }
 380
 381 /**
 382  * Generates an HtmlElement object to store data for a link.
 383  *
 384  * @param string $url URL that the link will point to.
 385  * @param string $linktext Text to be displayed as link.
 386  * @return HtmlElement HtmlElement object that contains data to construct an html link.
 387  */
 388 function LinkURL($url, $linktext = '') {
 389     // FIXME: Is this needed (or sufficient?)
 390     if(! IsSafeURL($url)) {
 391         $link = HTML::span(array('class' => 'error'), _('Bad URL -- remove all of <, >, "'));
 392         return $link;
 393     }
 394     else {
 395         if (!$linktext)
 396             $linktext = preg_replace("/mailto:/A", "", $url);
 397         $args = array('href' => $url);
 398         if ( defined('EXTERNAL_LINK_TARGET') ) // can also be set in the css
 399             $args['target'] = (is_string(EXTERNAL_LINK_TARGET) and (EXTERNAL_LINK_TARGET != ""))  ? EXTERNAL_LINK_TARGET : "_blank";
 400         $link = HTML::a($args, PossiblyGlueIconToText($url, $linktext));
 401     }
 402     $link->setAttr('class', $linktext ? 'namedurl' : 'rawurl');
 403     return $link;
 404 }
 405
 406 /**
 407  * Inline Images
 408  *
 409  * Syntax: [image.png size=50% border=n align= hspace= vspace= width= height=]
 410  * Disallows sizes which are too small.
 411  * Spammers may use such (typically invisible) image attributes to raise their GoogleRank.
 412  *
 413  * Handle embeddable objects, like svg, class, vrml, swf, svgz, pdf, avi, wmv especially.
 414  */
 415 function LinkImage($url, $alt = "") {
 416     $force_img = "png|jpg|gif|jpeg|bmp|pl|cgi";
 417     // Disallow tags in img src urls. Typical CSS attacks.
 418     // FIXME: Is this needed (or sufficient?)
 419     // FIXED: This was broken for moniker:TP30 test/image.png => url="moniker:TP30" attr="test/image.png"
 420     $ori_url = $url;
 421     // support new syntax: [prefix/image.jpg size=50% border=n]
 422     if (empty($alt)) $alt = "";
 423
 424     if (! IsSafeURL($url)) {
 425         $link = HTML::span(array('class' => 'error'), _('Bad URL for image -- remove all of <, >, "'));
 426         return $link;
 427     }
 428     // spaces in inline images must be %20 encoded!
 429     $link = HTML::img(array('src' => $url));
 430
 431     // Extract attributes and shorten url
 432     $arr = parse_attributes(strstr($url, " "));
 433     foreach ($arr as $attr => $value) {
 434         // strip attr=... url suffix
 435         $link->setAttr('src', $url);
 436         $i = strpos($url, $attr);
 437         $url = substr($url, 0, $i-1);
 438         // These attributes take strings: lang, id, title, alt
 439         if (($attr == "lang")
 440           || ($attr == "id")
 441           || ($attr == "title")
 442           || ($attr == "alt")) {
 443             $link->setAttr($attr, $value);
 444         }
 445         // align = bottom|middle|top|left|right
 446         // we allow "center" as synonym for "middle"
 447         elseif (($attr == "align")
 448           && (($value == "bottom")
 449             || ($value == "middle")
 450             || ($value == "center")
 451             || ($value == "top")
 452             || ($value == "left")
 453             || ($value == "right"))) {
 454             if ($value == "center") {
 455                 $value = "middle";
 456             }
 457             $link->setAttr($attr, $value);
 458         }
 459         // These attributes take a number (pixels): border, hspace, vspace
 460         elseif ((($attr == "border") || ($attr == "hspace") || ($attr == "vspace"))
 461            && (is_numeric($value))) {
 462             $link->setAttr($attr, (int)$value);
 463         }
 464         // These attributes take a number (pixels) or a percentage: height, width
 465         elseif ((($attr == "height") || ($attr == "width"))
 466            && (preg_match('/\d+[%p]?x?/', $value))) {
 467             $link->setAttr($attr, $value);
 468         }
 469         // We allow size=50% and size=20x30
 470         // We replace this with "width" and "height" HTML attributes
 471         elseif ($attr == "size") {
 472             if (preg_match('/(\d+%)/', $value, $m)) {
 473                 $link->setAttr('width',$m[1]);
 474                 $link->setAttr('height',$m[1]);
 475             } elseif (preg_match('/(\d+)x(\d+)/', $value, $m)) {
 476                 $link->setAttr('width',$m[1]);
 477                 $link->setAttr('height',$m[2]);
 478             }
 479         }
 480         else {
 481             $url = substr(strrchr($ori_url, "/"), 1);
 482             $link = HTML::span(array('class' => 'error'),
 483                           sprintf(_("Invalid attribute %s=%s for image %s"),
 484                                   $attr, $value, $url));
 485             return $link;
 486         }
 487     }
 488     // Correct silently the most common error
 489     if (strstr($ori_url, " ") and !preg_match("/^http/",$url)) {
 490     // space belongs to the path
 491     $file = NormalizeLocalFileName($ori_url);
 492         if (file_exists($file)) {
 493              $link = HTML::img(array('src' => $ori_url));
 494              trigger_error(
 495                sprintf(_("Invalid image link fixed %s => %s. Spaces must be quoted with %%20."),
 496                                        $url, $ori_url), E_USER_WARNING);
 497         } elseif (string_starts_with($ori_url, getUploadDataPath())) {
 498              $file = substr($file, strlen(getUploadDataPath()));
 499              $path = getUploadFilePath().$file;
 500              if (file_exists($path)) {
 501                   trigger_error(sprintf(_("Invalid image link fixed \"%s\" => \"%s\".\n Spaces must be quoted with %%20."),
 502                                        $url, $ori_url), E_USER_WARNING);
 503                  $link->setAttr('src', getUploadDataPath() . $file);
 504                  $url = $ori_url;
 505              }
 506         }
 507     }
 508     if (!$link->getAttr('alt')) {
 509         $link->setAttr('alt', $alt);
 510     }
 511     // Check width and height as spam countermeasure
 512     if (($width  = $link->getAttr('width')) and ($height = $link->getAttr('height'))) {
 513         //$width  = (int) $width; // px or % or other suffix
 514         //$height = (int) $height;
 515         if (($width < 3 and $height < 10) or
 516             ($height < 3 and $width < 20) or
 517             ($height < 7 and $width < 7))
 518         {
 519             $link = HTML::span(array('class' => 'error'),
 520                                _("Invalid image size"));
 521             return $link;
 522         }
 523     } else {
 524         $size = 0;
 525         // Prepare for getimagesize($url)
 526         // $url only valid for external urls, otherwise local path
 527         if (DISABLE_GETIMAGESIZE)
 528             ;
 529         elseif (! preg_match("/\.$force_img$/i", $url))
 530             ;  // only valid image extensions or scripts assumed to generate images
 531         elseif (preg_match("/^http/",$url)) { // external url
 532             $size = @getimagesize($url);
 533         } else { // local file
 534             if (file_exists($file = NormalizeLocalFileName($url))) {  // here
 535                 $size = @getimagesize($file);
 536             } elseif (file_exists(NormalizeLocalFileName(urldecode($url)))) {
 537                 $size = @getimagesize($file);
 538                 $link->setAttr('src', rawurldecode($url));
 539             } elseif (string_starts_with($url, getUploadDataPath())) { // there
 540                 $file = substr($file, strlen(getUploadDataPath()));
 541                 $path = getUploadFilePath().rawurldecode($file);
 542                 $size = @getimagesize($path);
 543                 $link->setAttr('src', getUploadDataPath() . rawurldecode($file));
 544             } else { // elsewhere
 545                 global $request;
 546                 $size = @getimagesize($request->get('DOCUMENT_ROOT').urldecode($url));
 547             }
 548         }
 549         if ($size) {
 550             $width  = $size[0];
 551             $height = $size[1];
 552             if (($width < 3 and $height < 10)
 553                 or ($height < 3 and $width < 20)
 554                 or ($height < 7 and $width < 7))
 555             {
 556                 $link = HTML::span(array('class' => 'error'),
 557                                    _("Invalid image size"));
 558                 return $link;
 559             }
 560         }
 561     }
 562     $link->setAttr('class', 'inlineimage');
 563
 564     /* Check for inlined objects. Everything allowed in INLINE_IMAGES besides
 565      * png|jpg|gif|jpeg|bmp|pl|cgi.  If no image it is an object to embed.
 566      * Note: Allow cgi's (pl,cgi) returning images.
 567      */
 568     if (!preg_match("/\.(".$force_img.")/i", $ori_url)) {
 569         // HTML::img(array('src' => $url, 'alt' => $alt, 'title' => $alt));
 570         // => HTML::object(array('src' => $url)) ...;
 571         return ImgObject($link, $ori_url);
 572     }
 573     return $link;
 574 }
 575
 576 /**
 577  * <object> / <embed> tags instead of <img> for all non-image extensions
 578  * in INLINE_IMAGES.
 579  * Called by LinkImage(), not directly.
 580  * Syntax:  [image.svg size=50% alt=image.gif border=n align= hspace= vspace= width= height=]
 581  * Samples: [Upload:song.mp3 type=audio/mpeg width=200 height=10]
 582  *   $alt may be an alternate img
 583  * TODO: Need to unify with WikiPluginCached::embedObject()
 584  *
 585  * Note that Safari 1.0 will crash with <object>, so use only <embed>
 586  *   http://www.alleged.org.uk/pdc/2002/svg-object.html
 587  *
 588  * Allowed object tags:
 589  *   ID
 590  *   DATA=URI (object data)
 591  *   CLASSID=URI (location of implementation)
 592  *   ARCHIVE=CDATA (archive files)
 593  *   CODEBASE=URI (base URI for CLASSID, DATA, ARCHIVE)
 594  *   WIDTH=Length (object width)
 595  *   HEIGHT=Length (object height)
 596  *   NAME=CDATA (name for form submission)
 597  *   USEMAP=URI (client-side image map)
 598  *   TYPE=ContentType (content-type of object)
 599  *   CODETYPE=ContentType (content-type of code)
 600  *   STANDBY=Text (message to show while loading)
 601  *   TABINDEX=NUMBER (position in tabbing order)
 602  *   DECLARE (do not instantiate object)
 603  * The rest is added as <param name="" value="" /> tags
 604  */
 605 function ImgObject($img, $url) {
 606     // get the url args: data="sample.svgz" type="image/svg+xml" width="400" height="300"
 607     $params = explode(",","id,width,height,data,classid,archive,codebase,name,usemap,type,".
 608               "codetype,standby,tabindex,declare");
 609     if (is_array($url)) {
 610         $args = $url;
 611      $found = array();
 612         foreach ($args as $attr => $value) {
 613         foreach ($params as $param) {
 614         if ($param == $attr) {
 615             $img->setAttr($param, $value);
 616             if (isset($found[$param])) $found[$param]++;
 617             else $found[$param] = 1;
 618             break;
 619         }
 620         }
 621         }
 622     // now all remaining args are added as <param> to the object
 623     $params = array();
 624         foreach ($args as $attr => $value) {
 625         if (!isset($found[$attr])) {
 626         $params[] = HTML::param(array('name'  => $attr,
 627                                               'value' => $value));
 628         }
 629     }
 630     $url = $img->getAttr('src');
 631         $force_img = "png|jpg|gif|jpeg|bmp";
 632         if (!preg_match("/\.(".$force_img.")/i", $url)) {
 633             $img->setAttr('src', false);
 634         }
 635     } else {
 636         $args = explode(' ', $url);
 637         if (count($args) >= 1) {
 638           $url = array_shift($args);
 639           $found = array();
 640           foreach ($args as $attr) {
 641         foreach ($params as $param) {
 642         if (preg_match("/^$param=(\S+)$/i",$attr,$m)) {
 643             $img->setAttr($param, $m[1]);
 644             if (isset($found[$param])) $found[$param]++;
 645             else $found[$param] = 1;
 646             break;
 647         }
 648         }
 649         }
 650     // now all remaining args are added as <param> to the object
 651     $params = array();
 652         foreach ($args as $attr) {
 653         if (!isset($found[$attr]) and preg_match("/^(\S+)=(\S+)$/i",$attr,$m)) {
 654         $params[] = HTML::param(array('name'  => $m[1],
 655                                               'value' => $m[2]));
 656         }
 657     }
 658       }
 659     }
 660     $type = $img->getAttr('type');
 661     if (!$type) {
 662         if (function_exists('mime_content_type') && file_exists($url)) {
 663             $type = mime_content_type($url);
 664         }
 665     }
 666     $object = HTML::object(array_merge($img->_attr,
 667                                        array('type' => $type)), //'src' => $url
 668                 $img->_content);
 669     $object->setAttr('class', 'inlineobject');
 670     if ($params) {
 671     foreach ($params as $param) $object->pushContent($param);
 672     }
 673     if (isBrowserSafari() and !isBrowserSafari(532)) { // recent chrome can do OBJECT
 674         return HTML::embed($object->_attr, $object->_content);
 675     }
 676     $object->pushContent(HTML::embed($object->_attr));
 677     return $object;
 678 }
 679
 680
 681 class Stack {
 682
 683     // var in php5 deprecated
 684     function Stack() {
 685         $this->items = array();
 686         $this->size = 0;
 687     }
 688     function push($item) {
 689         $this->items[$this->size] = $item;
 690         $this->size++;
 691         return true;
 692     }
 693
 694     function pop() {
 695         if ($this->size == 0) {
 696             return false; // stack is empty
 697         }
 698         $this->size--;
 699         return $this->items[$this->size];
 700     }
 701
 702     function cnt() {
 703         return $this->size;
 704     }
 705
 706     function top() {
 707         if($this->size)
 708             return $this->items[$this->size - 1];
 709         else
 710             return '';
 711     }
 712
 713 }
 714 // end class definition
 715
 716 function SplitQueryArgs ($query_args = '')
 717 {
 718     // FIXME: use the arg-seperator which might not be &
 719     $split_args = explode('&', $query_args);
 720     $args = array();
 721     while (list($key, $val) = each($split_args))
 722         if (preg_match('/^ ([^=]+) =? (.*) /x', $val, $m))
 723             $args[$m[1]] = $m[2];
 724     return $args;
 725 }
 726
 727 function LinkPhpwikiURL($url, $text = '', $basepage = false) {
 728     $args = array();
 729
 730     if (!preg_match('/^ phpwiki: ([^?]*) [?]? (.*) $/x', $url, $m)) {
 731         return HTML::span(array('class' => 'error'), _("BAD phpwiki: URL"));
 732     }
 733
 734     if ($m[1])
 735         $pagename = urldecode($m[1]);
 736     $qargs = $m[2];
 737
 738     if (empty($pagename) &&
 739         preg_match('/^(diff|edit|links|info)=([^&]+)$/', $qargs, $m)) {
 740         // Convert old style links (to not break diff links in
 741         // RecentChanges).
 742         $pagename = urldecode($m[2]);
 743         $args = array("action" => $m[1]);
 744     }
 745     else {
 746         $args = SplitQueryArgs($qargs);
 747     }
 748
 749     if (empty($pagename))
 750         $pagename = $GLOBALS['request']->getArg('pagename');
 751
 752     if (isset($args['action']) && $args['action'] == 'browse')
 753         unset($args['action']);
 754
 755     /*FIXME:
 756       if (empty($args['action']))
 757       $class = 'wikilink';
 758       else if (is_safe_action($args['action']))
 759       $class = 'wikiaction';
 760     */
 761     if (empty($args['action']) || is_safe_action($args['action']))
 762         $class = 'wikiaction';
 763     else {
 764         // Don't allow administrative links on unlocked pages.
 765         $dbi = $GLOBALS['request']->getDbh();
 766         $page = $dbi->getPage($basepage ? $basepage : $pagename);
 767         if (!$page->get('locked'))
 768             return HTML::span(array('class' => 'wikiunsafe'),
 769                               HTML::u(_("Lock page to enable link")));
 770         $class = 'wikiadmin';
 771     }
 772
 773     if (!$text)
 774         $text = HTML::span(array('class' => 'rawurl'), $url);
 775
 776     $wikipage = new WikiPageName($pagename);
 777     if (!$wikipage->isValid()) {
 778         global $WikiTheme;
 779         return $WikiTheme->linkBadWikiWord($wikipage, $url);
 780     }
 781
 782     return HTML::a(array('href'  => WikiURL($pagename, $args),
 783                          'class' => $class),
 784                    $text);
 785 }
 786
 787 /**
 788  * A class to assist in parsing wiki pagenames.
 789  *
 790  * Now with subpages and anchors, parsing and passing around
 791  * pagenames is more complicated.  This should help.
 792  */
 793 class WikiPageName
 794 {
 795     /** Short name for page.
 796      *
 797      * This is the value of $name passed to the constructor.
 798      * (For use, e.g. as a default label for links to the page.)
 799      */
 800     //var $shortName;
 801
 802     /** The full page name.
 803      *
 804      * This is the full name of the page (without anchor).
 805      */
 806     //var $name;
 807
 808     /** The anchor.
 809      *
 810      * This is the referenced anchor within the page, or the empty string.
 811      */
 812     //var $anchor;
 813
 814     /** Constructor
 815      *
 816      * @param mixed $name Page name.
 817      * WikiDB_Page, WikiDB_PageRevision, or string.
 818      * This can be a relative subpage name (like '/SubPage'),
 819      * or can be the empty string to refer to the $basename.
 820      *
 821      * @param string $anchor For links to anchors in page.
 822      *
 823      * @param mixed $basename Page name from which to interpret
 824      * relative or other non-fully-specified page names.
 825      */
 826     function WikiPageName($name, $basename=false, $anchor=false) {
 827         if (is_string($name)) {
 828             $this->shortName = $name;
 829             if (strstr($name, ':')) {
 830                 list($moniker, $shortName) = explode (":", $name, 2);
 831                 $map = getInterwikiMap(); // allow overrides to custom maps
 832                 if (isset($map->_map[$moniker])) {
 833                     $url = $map->_map[$moniker];
 834                     if (strstr($url, '%s'))
 835                         $url = sprintf($url, $shortName);
 836                     else
 837                         $url .= $shortName;
 838                     $this->url = $url;
 839                     // expand Talk or User, but not to absolute urls!
 840                     if (strstr($url, '//')) {
 841                         if ($moniker == 'Talk')
 842                             $name = $name . SUBPAGE_SEPARATOR . _("Discussion");
 843                         elseif ($moniker == 'User')
 844                             $name = $name;
 845                     } else {
 846                         $name = $url;
 847                     }
 848                     if (strstr($shortName, '?')) {
 849                         list($shortName, $dummy) = explode("\?", $shortName, 2);
 850                     }
 851                     $this->shortName = $shortName;
 852                 }
 853             }
 854             // FIXME: We should really fix the cause for "/PageName" in the WikiDB
 855             if ($name == '' or $name[0] == SUBPAGE_SEPARATOR) {
 856                 if ($basename)
 857                     $name = $this->_pagename($basename) . $name;
 858                 else {
 859                     $name = $this->_normalize_bad_pagename($name);
 860                     $this->shortName = $name;
 861                 }
 862             }
 863         }
 864         else {
 865             $name = $this->_pagename($name);
 866             $this->shortName = $name;
 867         }
 868
 869         $this->name = $this->_check($name);
 870         $this->anchor = (string)$anchor;
 871     }
 872
 873     function getName() {
 874         return $this->name;
 875     }
 876
 877     function getParent() {
 878         $name = $this->name;
 879         if (!($tail = strrchr($name, SUBPAGE_SEPARATOR)))
 880             return false;
 881         return substr($name, 0, -strlen($tail));
 882     }
 883
 884     function isValid($strict = false) {
 885         if ($strict)
 886             return !isset($this->_errors);
 887         return (is_string($this->name) and $this->name != '');
 888     }
 889
 890     function getWarnings() {
 891         $warnings = array();
 892         if (isset($this->_warnings))
 893             $warnings = array_merge($warnings, $this->_warnings);
 894         if (isset($this->_errors))
 895             $warnings = array_merge($warnings, $this->_errors);
 896         if (!$warnings)
 897             return false;
 898
 899         return sprintf(_("'%s': Bad page name: %s"),
 900                        $this->shortName, join(', ', $warnings));
 901     }
 902
 903     function _pagename($page) {
 904         if (isa($page, 'WikiDB_Page'))
 905             return $page->getName();
 906         elseif (isa($page, 'WikiDB_PageRevision'))
 907             return $page->getPageName();
 908         elseif (isa($page, 'WikiPageName'))
 909             return $page->name;
 910         // '0' or e.g. '1984' should be allowed though
 911         if (!is_string($page) and !is_integer($page)) {
 912             trigger_error(sprintf("Non-string pagename '%s' (%s)(%s)",
 913                                   $page, gettype($page), get_class($page)),
 914                           E_USER_NOTICE);
 915         }
 916         //assert(is_string($page));
 917         return $page;
 918     }
 919
 920     function _normalize_bad_pagename($name) {
 921         trigger_error("Bad pagename: " . $name, E_USER_WARNING);
 922
 923         // Punt...  You really shouldn't get here.
 924         if (empty($name)) {
 925             global $request;
 926             return $request->getArg('pagename');
 927         }
 928         assert($name[0] == SUBPAGE_SEPARATOR);
 929         $this->_errors[] = sprintf(_("Leading %s not allowed"), SUBPAGE_SEPARATOR);
 930         return substr($name, 1);
 931     }
 932
 933     /**
 934      * Compress internal white-space to single space character.
 935      *
 936      * This leads to problems with loading a foreign charset pagename,
 937      * which cannot be deleted anymore, because unknown chars are compressed.
 938      * So BEFORE importing a file _check must be done !!!
 939      */
 940     function _check($pagename) {
 941         // Compress internal white-space to single space character.
 942         $pagename = preg_replace('/[\s\xa0]+/', ' ', $orig = $pagename);
 943         if ($pagename != $orig)
 944             $this->_warnings[] = _("White space converted to single space");
 945
 946         // Delete any control characters.
 947         if (DATABASE_TYPE == 'cvs' or DATABASE_TYPE == 'file' or DATABASE_TYPE == 'flatfile') {
 948             $pagename = preg_replace('/[\x00-\x1f\x7f\x80-\x9f]/', '', $orig = $pagename);
 949             if ($pagename != $orig)
 950                 $this->_errors[] = _("Control characters not allowed");
 951         }
 952
 953         // Strip leading and trailing white-space.
 954         $pagename = trim($pagename);
 955
 956         $orig = $pagename;
 957         while ($pagename and $pagename[0] == SUBPAGE_SEPARATOR)
 958             $pagename = substr($pagename, 1);
 959         if ($pagename != $orig)
 960             $this->_errors[] = sprintf(_("Leading %s not allowed"), SUBPAGE_SEPARATOR);
 961
 962         // ";" is urlencoded, so safe from php arg-delim problems
 963         /*if (strstr($pagename, ';')) {
 964             $this->_warnings[] = _("';' is deprecated");
 965             $pagename = str_replace(';', '', $pagename);
 966         }*/
 967
 968         // not only for SQL, also to restrict url length
 969         if (strlen($pagename) > MAX_PAGENAME_LENGTH) {
 970             $pagename = substr($pagename, 0, MAX_PAGENAME_LENGTH);
 971             $this->_errors[] = _("Page name too long");
 972         }
 973
 974         // disallow some chars only on file and cvs
 975         if ((DATABASE_TYPE == 'cvs'
 976             or DATABASE_TYPE == 'file'
 977             or DATABASE_TYPE == 'flatfile')
 978             and preg_match('/(:|\.\.)/', $pagename, $m))
 979         {
 980             $this->_warnings[] = sprintf(_("Illegal chars %s removed"), $m[1]);
 981             $pagename = str_replace('..', '', $pagename);
 982             $pagename = str_replace(':', '', $pagename);
 983         }
 984
 985         return $pagename;
 986     }
 987 }
 988
 989 /**
 990  * Convert old page markup to new-style markup.
 991  *
 992  * @param string $text Old-style wiki markup.
 993  *
 994  * @param string $markup_type
 995  * One of: <dl>
 996  * <dt><code>"block"</code>  <dd>Convert all markup.
 997  * <dt><code>"inline"</code> <dd>Convert only inline markup.
 998  * <dt><code>"links"</code>  <dd>Convert only link markup.
 999  * </dl>
1000  *
1001  * @return string New-style wiki markup.
1002  *
1003  * @bugs Footnotes don't work quite as before (esp if there are
1004  *   multiple references to the same footnote.  But close enough,
1005  *   probably for now....
1006  * @bugs  Apache2 and IIS crash with OldTextFormattingRules or
1007  *   AnciennesR%E8glesDeFormatage. (at the 2nd attempt to do the anchored block regex)
1008  *   It only crashes with CreateToc so far, but other pages (not in pgsrc) are
1009  *   also known to crash, even with Apache1.
1010  */
1011 function ConvertOldMarkup ($text, $markup_type = "block") {
1012
1013     static $subs;
1014     static $block_re;
1015
1016     // FIXME:
1017     // Trying to detect why the 2nd paragraph of OldTextFormattingRules or
1018     // AnciennesR%E8glesDeFormatage crashes.
1019     // It only crashes with CreateToc so far, but other pages (not in pgsrc) are
1020     // also known to crash, even with Apache1.
1021     $debug_skip = false;
1022     // I suspect this only to crash with Apache2 and IIS.
1023     if (in_array(php_sapi_name(),array('apache2handler','apache2filter','isapi'))
1024         and preg_match("/plugin CreateToc/", $text))
1025     {
1026         trigger_error(_("The CreateTocPlugin is not yet old markup compatible! ")
1027                      ._("Please remove the CreateToc line to be able to reformat this page to old markup. ")
1028                      ._("Skipped."), E_USER_WARNING);
1029         $debug_skip = true;
1030         //if (!DEBUG) return $text;
1031         return $text;
1032     }
1033
1034     if (empty($subs)) {
1035         /*****************************************************************
1036          * Conversions for inline markup:
1037          */
1038
1039         // escape tilde's
1040         $orig[] = '/~/';
1041         $repl[] = '~~';
1042
1043         // escape escaped brackets
1044         $orig[] = '/\[\[/';
1045         $repl[] = '~[';
1046
1047         // change ! escapes to ~'s.
1048         global $WikiNameRegexp, $request;
1049         $bang_esc[] = "(?:" . ALLOWED_PROTOCOLS . "):[^\s<>\[\]\"'()]*[^\s<>\[\]\"'(),.?]";
1050         // before 4.3.9 pcre had a memory release bug, which might hit us here. so be safe.
1051         $map = getInterwikiMap();
1052         if ($map_regex = $map->getRegexp())
1053             $bang_esc[] = $map_regex . ":[^\\s.,;?()]+"; // FIXME: is this really needed?
1054         $bang_esc[] = $WikiNameRegexp;
1055         $orig[] = '/!((?:' . join(')|(', $bang_esc) . '))/';
1056         $repl[] = '~\\1';
1057
1058         $subs["links"] = array($orig, $repl);
1059
1060         // Temporarily URL-encode pairs of underscores in links to hide
1061         // them from the re for bold markup.
1062         $orig[] = '/\[[^\[\]]*?__[^\[\]]*?\]/e';
1063         $repl[] = 'str_replace(\'__\', \'%5F%5F\', \'\\0\')';
1064
1065         // Escape '<'s
1066         //$orig[] = '/<(?!\?plugin)|(?<!^)</m';
1067         //$repl[] = '~<';
1068
1069         // Convert footnote references.
1070         $orig[] = '/(?<=.)(?<!~)\[\s*(\d+)\s*\]/m';
1071         $repl[] = '#[|ftnt_ref_\\1]<sup>~[[\\1|#ftnt_\\1]~]</sup>';
1072
1073         // Convert old style emphases to HTML style emphasis.
1074         $orig[] = '/__(.*?)__/';
1075         $repl[] = '<strong>\\1</strong>';
1076         $orig[] = "/''(.*?)''/";
1077         $repl[] = '<em>\\1</em>';
1078
1079         // Escape nestled markup.
1080         $orig[] = '/^(?<=^|\s)[=_](?=\S)|(?<=\S)[=_*](?=\s|$)/m';
1081         $repl[] = '~\\0';
1082
1083         // in old markup headings only allowed at beginning of line
1084         $orig[] = '/!/';
1085         $repl[] = '~!';
1086
1087         // Convert URL-encoded pairs of underscores in links back to
1088         // real underscores after bold markup has been converted.
1089         $orig = '/\[[^\[\]]*?%5F%5F[^\[\]]*?\]/e';
1090         $repl = 'str_replace(\'%5F%5F\', \'__\', \'\\0\')';
1091
1092         $subs["inline"] = array($orig, $repl);
1093
1094         /*****************************************************************
1095          * Patterns which match block markup constructs which take
1096          * special handling...
1097          */
1098
1099         // Indented blocks
1100         $blockpats[] = '[ \t]+\S(?:.*\s*\n[ \t]+\S)*';
1101         // Tables
1102         $blockpats[] = '\|(?:.*\n\|)*';
1103
1104         // List items
1105         $blockpats[] = '[#*;]*(?:[*#]|;.*?:)';
1106
1107         // Footnote definitions
1108         $blockpats[] = '\[\s*(\d+)\s*\]';
1109
1110         if (!$debug_skip) {
1111         // Plugins
1112         $blockpats[] = '<\?plugin(?:-form)?\b.*\?>\s*$';
1113         }
1114
1115         // Section Title
1116         $blockpats[] = '!{1,3}[^!]';
1117         /*
1118     removed .|\n in the anchor not to crash on /m because with /m "." already includes \n
1119     this breaks headings but it doesn't crash anymore (crash on non-cgi, non-cli only)
1120     */
1121         $block_re = ( '/\A((?:.|\n)*?)(^(?:'
1122                       . join("|", $blockpats)
1123                       . ').*$)\n?/m' );
1124
1125     }
1126
1127     if ($markup_type != "block") {
1128         list ($orig, $repl) = $subs[$markup_type];
1129         return preg_replace($orig, $repl, $text);
1130     }
1131     else {
1132         list ($orig, $repl) = $subs['inline'];
1133         $out = '';
1134     //FIXME:
1135     // php crashes here in the 2nd paragraph of OldTextFormattingRules,
1136     // AnciennesR%E8glesDeFormatage and more
1137     // See http://www.pcre.org/pcre.txt LIMITATIONS
1138      while (preg_match($block_re, $text, $m)) {
1139             $text = substr($text, strlen($m[0]));
1140             list (,$leading_text, $block) = $m;
1141             $suffix = "\n";
1142
1143             if (strchr(" \t", $block[0])) {
1144                 // Indented block
1145                 $prefix = "<pre>\n";
1146                 $suffix = "\n</pre>\n";
1147             }
1148             elseif ($block[0] == '|') {
1149                 // Old-style table
1150                 $prefix = "<?plugin OldStyleTable\n";
1151                 $suffix = "\n?>\n";
1152             }
1153             elseif (strchr("#*;", $block[0])) {
1154                 // Old-style list item
1155                 preg_match('/^([#*;]*)([*#]|;.*?:) */', $block, $m);
1156                 list (,$ind,$bullet) = $m;
1157                 $block = substr($block, strlen($m[0]));
1158
1159                 $indent = str_repeat('     ', strlen($ind));
1160                 if ($bullet[0] == ';') {
1161                     //$term = ltrim(substr($bullet, 1));
1162                     //return $indent . $term . "\n" . $indent . '     ';
1163                     $prefix = $ind . $bullet;
1164                 }
1165                 else
1166                     $prefix = $indent . $bullet . ' ';
1167             }
1168             elseif ($block[0] == '[') {
1169                 // Footnote definition
1170                 preg_match('/^\[\s*(\d+)\s*\]/', $block, $m);
1171                 $footnum = $m[1];
1172                 $block = substr($block, strlen($m[0]));
1173                 $prefix = "#[|ftnt_".${footnum}."]~[[".${footnum}."|#ftnt_ref_".${footnum}."]~] ";
1174             }
1175             elseif ($block[0] == '<') {
1176                 // Plugin.
1177                 // HACK: no inline markup...
1178                 $prefix = $block;
1179                 $block = '';
1180             }
1181             elseif ($block[0] == '!') {
1182                 // Section heading
1183                 preg_match('/^!{1,3}/', $block, $m);
1184                 $prefix = $m[0];
1185                 $block = substr($block, strlen($m[0]));
1186             }
1187             else {
1188                 // AAck!
1189                 assert(0);
1190             }
1191             if ($leading_text) $leading_text = preg_replace($orig, $repl, $leading_text);
1192             if ($block) $block = preg_replace($orig, $repl, $block);
1193             $out .= $leading_text;
1194             $out .= $prefix;
1195             $out .= $block;
1196             $out .= $suffix;
1197         }
1198         return $out . preg_replace($orig, $repl, $text);
1199     }
1200 }
1201
1202
1203 /**
1204  * Expand tabs in string.
1205  *
1206  * Converts all tabs to (the appropriate number of) spaces.
1207  *
1208  * @param string $str
1209  * @param integer $tab_width
1210  * @return string
1211  */
1212 function expand_tabs($str, $tab_width = 8) {
1213     $split = explode("\t", $str);
1214     $tail = array_pop($split);
1215     $expanded = "\n";
1216     foreach ($split as $hunk) {
1217         $expanded .= $hunk;
1218         $pos = strlen(strrchr($expanded, "\n")) - 1;
1219         $expanded .= str_repeat(" ", ($tab_width - $pos % $tab_width));
1220     }
1221     return substr($expanded, 1) . $tail;
1222 }
1223
1224 /**
1225  * Split WikiWords in page names.
1226  *
1227  * It has been deemed useful to split WikiWords (into "Wiki Words") in
1228  * places like page titles. This is rumored to help search engines
1229  * quite a bit.
1230  *
1231  * @param $page string The page name.
1232  *
1233  * @return string The split name.
1234  */
1235 function SplitPagename ($page) {
1236
1237     if (preg_match("/\s/", $page))
1238         return $page;           // Already split --- don't split any more.
1239
1240     // This algorithm is specialized for several languages.
1241     // (Thanks to Pierrick MEIGNEN)
1242     // Improvements for other languages welcome.
1243     static $RE;
1244     if (!isset($RE)) {
1245         // This mess splits between a lower-case letter followed by
1246         // either an upper-case or a numeral; except that it wont
1247         // split the prefixes 'Mc', 'De', or 'Di' off of their tails.
1248         switch ($GLOBALS['LANG']) {
1249         case 'en':
1250         case 'it':
1251         case 'es':
1252         case 'de':
1253             $RE[] = '/([[:lower:]])((?<!Mc|De|Di)[[:upper:]]|\d)/';
1254             break;
1255         case 'fr':
1256             $RE[] = '/([[:lower:]])((?<!Mc|Di)[[:upper:]]|\d)/';
1257             break;
1258         }
1259     $sep = preg_quote(SUBPAGE_SEPARATOR, '/');
1260         // This the single-letter words 'I' and 'A' from any following
1261         // capitalized words.
1262         switch ($GLOBALS['LANG']) {
1263         case 'en':
1264             $RE[] = "/(?<= |${sep}|^)([AI])([[:upper:]][[:lower:]])/";
1265             break;
1266         case 'fr':
1267             $RE[] = "/(?<= |${sep}|^)([À])([[:upper:]][[:lower:]])/";
1268             break;
1269         }
1270         // Split at underscore
1271         $RE[] = '/(_)([[:alpha:]])/';
1272         $RE[] = '/([[:alpha:]])(_)/';
1273         // Split numerals from following letters.
1274         $RE[] = '/(\d)([[:alpha:]])/';
1275         // Split at subpage seperators. TBD in WikiTheme.php
1276         $RE[] = "/([^${sep}]+)(${sep})/";
1277         $RE[] = "/(${sep})([^${sep}]+)/";
1278
1279         foreach ($RE as $key)
1280             $RE[$key] = $key;
1281     }
1282
1283     foreach ($RE as $regexp) {
1284     $page = preg_replace($regexp, '\\1 \\2', $page);
1285     }
1286     return $page;
1287 }
1288
1289 function NoSuchRevision (&$request, $page, $version) {
1290     $html = HTML(HTML::h2(_("Revision Not Found")),
1291                  HTML::p(fmt("I'm sorry.  Version %d of %s is not in the database.",
1292                              $version, WikiLink($page, 'auto'))));
1293     include_once('lib/Template.php');
1294     GeneratePage($html, _("Bad Version"), $page->getCurrentRevision());
1295     $request->finish();
1296 }
1297
1298
1299 /**
1300  * Get time offset for local time zone.
1301  *
1302  * @param $time time_t Get offset for this time. Default: now.
1303  * @param $no_colon boolean Don't put colon between hours and minutes.
1304  * @return string Offset as a string in the format +HH:MM.
1305  */
1306 function TimezoneOffset ($time = false, $no_colon = false) {
1307     if ($time === false)
1308         $time = time();
1309     $secs = date('Z', $time);
1310
1311     if ($secs < 0) {
1312         $sign = '-';
1313         $secs = -$secs;
1314     }
1315     else {
1316         $sign = '+';
1317     }
1318     $colon = $no_colon ? '' : ':';
1319     $mins = intval(($secs + 30) / 60);
1320     return sprintf("%s%02d%s%02d",
1321                    $sign, $mins / 60, $colon, $mins % 60);
1322 }
1323
1324
1325 /**
1326  * Format time in ISO-8601 format.
1327  *
1328  * @param $time time_t Time.  Default: now.
1329  * @return string Date and time in ISO-8601 format.
1330  */
1331 function Iso8601DateTime ($time = false) {
1332     if ($time === false)
1333         $time = time();
1334     $tzoff = TimezoneOffset($time);
1335     $date  = date('Y-m-d', $time);
1336     $time  = date('H:i:s', $time);
1337     return $date . 'T' . $time . $tzoff;
1338 }
1339
1340 /**
1341  * Format time in RFC-2822 format.
1342  *
1343  * @param $time time_t Time.  Default: now.
1344  * @return string Date and time in RFC-2822 format.
1345  */
1346 function Rfc2822DateTime ($time = false) {
1347     if ($time === false)
1348         $time = time();
1349     return date('D, j M Y H:i:s ', $time) . TimezoneOffset($time, 'no colon');
1350 }
1351
1352 /**
1353  * Format time in RFC-1123 format.
1354  *
1355  * @param $time time_t Time.  Default: now.
1356  * @return string Date and time in RFC-1123 format.
1357  */
1358 function Rfc1123DateTime ($time = false) {
1359     if ($time === false)
1360         $time = time();
1361     return gmdate('D, d M Y H:i:s \G\M\T', $time);
1362 }
1363
1364 /** Parse date in RFC-1123 format.
1365  *
1366  * According to RFC 1123 we must accept dates in the following
1367  * formats:
1368  *
1369  *   Sun, 06 Nov 1994 08:49:37 GMT  ; RFC 822, updated by RFC 1123
1370  *   Sunday, 06-Nov-94 08:49:37 GMT ; RFC 850, obsoleted by RFC 1036
1371  *   Sun Nov  6 08:49:37 1994       ; ANSI C's asctime() format
1372  *
1373  * (Though we're only allowed to generate dates in the first format.)
1374  */
1375 function ParseRfc1123DateTime ($timestr) {
1376     $timestr = trim($timestr);
1377     if (preg_match('/^ \w{3},\s* (\d{1,2}) \s* (\w{3}) \s* (\d{4}) \s*'
1378                    .'(\d\d):(\d\d):(\d\d) \s* GMT $/ix',
1379                    $timestr, $m)) {
1380         list(, $mday, $mon, $year, $hh, $mm, $ss) = $m;
1381     }
1382     elseif (preg_match('/^ \w+,\s* (\d{1,2})-(\w{3})-(\d{2}|\d{4}) \s*'
1383                        .'(\d\d):(\d\d):(\d\d) \s* GMT $/ix',
1384                        $timestr, $m)) {
1385         list(, $mday, $mon, $year, $hh, $mm, $ss) = $m;
1386         if ($year < 70) $year += 2000;
1387         elseif ($year < 100) $year += 1900;
1388     }
1389     elseif (preg_match('/^\w+\s* (\w{3}) \s* (\d{1,2}) \s*'
1390                        .'(\d\d):(\d\d):(\d\d) \s* (\d{4})$/ix',
1391                        $timestr, $m)) {
1392         list(, $mon, $mday, $hh, $mm, $ss, $year) = $m;
1393     }
1394     else {
1395         // Parse failed.
1396         return false;
1397     }
1398
1399     $time = strtotime("$mday $mon $year ${hh}:${mm}:${ss} GMT");
1400     if ($time == -1)
1401         return false;           // failed
1402     return $time;
1403 }
1404
1405 /**
1406  * Format time to standard 'ctime' format.
1407  *
1408  * @param $time time_t Time.  Default: now.
1409  * @return string Date and time.
1410  */
1411 function CTime ($time = false)
1412 {
1413     if ($time === false)
1414         $time = time();
1415     return date("D M j H:i:s Y", $time);
1416 }
1417
1418
1419 /**
1420  * Format number as kibibytes or bytes.
1421  * Short format is used for PageList
1422  * Long format is used in PageInfo
1423  *
1424  * @param $bytes       int.  Default: 0.
1425  * @param $longformat  bool. Default: false.
1426  * @return class FormattedText (XmlElement.php).
1427  */
1428 function ByteFormatter ($bytes = 0, $longformat = false) {
1429     if ($bytes < 0)
1430         return fmt("-???");
1431     if ($bytes < 1024) {
1432         if (! $longformat)
1433             $size = fmt("%s B", $bytes);
1434         else
1435             $size = fmt("%s bytes", $bytes);
1436     }
1437     else {
1438         $kb = round($bytes / 1024, 1);
1439         if (! $longformat)
1440             $size = fmt("%s KiB", $kb);
1441         else
1442             $size = fmt("%s KiB (%s bytes)", $kb, $bytes);
1443     }
1444     return $size;
1445 }
1446
1447 /**
1448  * Internationalized printf.
1449  *
1450  * This is essentially the same as PHP's built-in printf
1451  * with the following exceptions:
1452  * <ol>
1453  * <li> It passes the format string through gettext().
1454  * <li> It supports the argument reordering extensions.
1455  * </ol>
1456  *
1457  * Example:
1458  *
1459  * In php code, use:
1460  * <pre>
1461  *    __printf("Differences between versions %s and %s of %s",
1462  *             $new_link, $old_link, $page_link);
1463  * </pre>
1464  *
1465  * Then in locale/po/de.po, one can reorder the printf arguments:
1466  *
1467  * <pre>
1468  *    msgid "Differences between %s and %s of %s."
1469  *    msgstr "Der Unterschiedsergebnis von %3$s, zwischen %1$s und %2$s."
1470  * </pre>
1471  *
1472  * (Note that while PHP tries to expand $vars within double-quotes,
1473  * the values in msgstr undergo no such expansion, so the '$'s
1474  * okay...)
1475  *
1476  * One shouldn't use reordered arguments in the default format string.
1477  * Backslashes in the default string would be necessary to escape the
1478  * '$'s, and they'll cause all kinds of trouble....
1479  */
1480 function __printf ($fmt) {
1481     $args = func_get_args();
1482     array_shift($args);
1483     echo __vsprintf($fmt, $args);
1484 }
1485
1486 /**
1487  * Internationalized sprintf.
1488  *
1489  * This is essentially the same as PHP's built-in printf with the
1490  * following exceptions:
1491  *
1492  * <ol>
1493  * <li> It passes the format string through gettext().
1494  * <li> It supports the argument reordering extensions.
1495  * </ol>
1496  *
1497  * @see __printf
1498  */
1499 function __sprintf ($fmt) {
1500     $args = func_get_args();
1501     array_shift($args);
1502     return __vsprintf($fmt, $args);
1503 }
1504
1505 /**
1506  * Internationalized vsprintf.
1507  *
1508  * This is essentially the same as PHP's built-in printf with the
1509  * following exceptions:
1510  *
1511  * <ol>
1512  * <li> It passes the format string through gettext().
1513  * <li> It supports the argument reordering extensions.
1514  * </ol>
1515  *
1516  * @see __printf
1517  */
1518 function __vsprintf ($fmt, $args) {
1519     $fmt = gettext($fmt);
1520     // PHP's sprintf doesn't support variable with specifiers,
1521     // like sprintf("%*s", 10, "x"); --- so we won't either.
1522
1523     if (preg_match_all('/(?<!%)%(\d+)\$/x', $fmt, $m)) {
1524         // Format string has '%2$s' style argument reordering.
1525         // PHP doesn't support this.
1526         if (preg_match('/(?<!%)%[- ]?\d*[^- \d$]/x', $fmt))
1527             // literal variable name substitution only to keep locale
1528             // strings uncluttered
1529             trigger_error(sprintf(_("Can't mix '%s' with '%s' type format strings"),
1530                                   '%1\$s','%s'), E_USER_WARNING); //php+locale error
1531
1532         $fmt = preg_replace('/(?<!%)%\d+\$/x', '%', $fmt);
1533         $newargs = array();
1534
1535         // Reorder arguments appropriately.
1536         foreach($m[1] as $argnum) {
1537             if ($argnum < 1 || $argnum > count($args))
1538                 trigger_error(sprintf(_("%s: argument index out of range"),
1539                                       $argnum), E_USER_WARNING);
1540             $newargs[] = $args[$argnum - 1];
1541         }
1542         $args = $newargs;
1543     }
1544
1545     // Not all PHP's have vsprintf, so...
1546     array_unshift($args, $fmt);
1547     return call_user_func_array('sprintf', $args);
1548 }
1549
1550 function file_mtime ($filename) {
1551     if ($stat = @stat($filename))
1552         return $stat[9];
1553     else
1554         return false;
1555 }
1556
1557 function sort_file_mtime ($a, $b) {
1558     $ma = file_mtime($a);
1559     $mb = file_mtime($b);
1560     if (!$ma or !$mb or $ma == $mb) return 0;
1561     return ($ma > $mb) ? -1 : 1;
1562 }
1563
1564 class fileSet {
1565     /**
1566      * Build an array in $this->_fileList of files from $dirname.
1567      * Subdirectories are not traversed.
1568      *
1569      * (This was a function LoadDir in lib/loadsave.php)
1570      * See also http://www.php.net/manual/en/function.readdir.php
1571      */
1572     function getFiles($exclude='', $sortby='', $limit='') {
1573         $list = $this->_fileList;
1574
1575         if ($sortby) {
1576             require_once('lib/PageList.php');
1577             switch (Pagelist::sortby($sortby, 'db')) {
1578             case 'pagename ASC': break;
1579             case 'pagename DESC':
1580                 $list = array_reverse($list);
1581                 break;
1582             case 'mtime ASC':
1583                 usort($list,'sort_file_mtime');
1584                 break;
1585             case 'mtime DESC':
1586                 usort($list,'sort_file_mtime');
1587                 $list = array_reverse($list);
1588                 break;
1589             }
1590         }
1591         if ($limit)
1592             return array_splice($list, 0, $limit);
1593         return $list;
1594     }
1595
1596     function _filenameSelector($filename) {
1597         if (! $this->_pattern )
1598             return true;
1599         else {
1600             if (! $this->_pcre_pattern )
1601                 $this->_pcre_pattern = glob_to_pcre($this->_pattern);
1602             return preg_match('/' . $this->_pcre_pattern . ($this->_case ? '/' : '/i'),
1603                               $filename);
1604         }
1605     }
1606
1607     function fileSet($directory, $filepattern = false) {
1608         $this->_fileList = array();
1609         $this->_pattern = $filepattern;
1610         if ($filepattern) {
1611             $this->_pcre_pattern = glob_to_pcre($this->_pattern);
1612         }
1613         $this->_case = !isWindows();
1614         $this->_pathsep = '/';
1615
1616         if (empty($directory)) {
1617             trigger_error(sprintf(_("%s is empty."), 'directoryname'),
1618                           E_USER_NOTICE);
1619             return; // early return
1620         }
1621
1622         @ $dir_handle = opendir($dir=$directory);
1623         if (empty($dir_handle)) {
1624             trigger_error(sprintf(_("Unable to open directory '%s' for reading"),
1625                                   $dir), E_USER_NOTICE);
1626             return; // early return
1627         }
1628
1629         while ($filename = readdir($dir_handle)) {
1630             if ($filename[0] == '.' || filetype($dir . $this->_pathsep . $filename) != 'file')
1631                 continue;
1632             if ($this->_filenameSelector($filename)) {
1633                 array_push($this->_fileList, "$filename");
1634                 //trigger_error(sprintf(_("found file %s"), $filename),
1635                 //                      E_USER_NOTICE); //debugging
1636             }
1637         }
1638         closedir($dir_handle);
1639     }
1640 };
1641
1642 // File globbing
1643
1644 // expands a list containing regex's to its matching entries
1645 class ListRegexExpand {
1646     //var $match, $list, $index, $case_sensitive;
1647     function ListRegexExpand (&$list, $match, $case_sensitive = true) {
1648         $this->match = $match;
1649         $this->list = &$list;
1650         $this->case_sensitive = $case_sensitive;
1651         //$this->index = false;
1652     }
1653     function listMatchCallback ($item, $key) {
1654         $quoted = str_replace('/','\/',$item);
1655         if (preg_match('/' . $this->match . ($this->case_sensitive ? '/' : '/i'),
1656                        $quoted)) {
1657         unset($this->list[$this->index]);
1658             $this->list[] = $item;
1659         }
1660     }
1661     function expandRegex ($index, &$pages) {
1662         $this->index = $index;
1663         array_walk($pages, array($this, 'listMatchCallback'));
1664         return $this->list;
1665     }
1666 }
1667
1668 // Convert fileglob to regex style:
1669 // Convert some wildcards to pcre style, escape the rest
1670 // Escape . \\ + * ? [ ^ ] $ ( ) { } = ! < > | : /
1671 // Fixed bug #994994: "/" in $glob.
1672 function glob_to_pcre ($glob) {
1673     // check simple case: no need to escape
1674     $escape = '\[](){}=!<>|:/';
1675     if (strcspn($glob, $escape . ".+*?^$") == strlen($glob))
1676         return $glob;
1677     // preg_replace cannot handle "\\\\\\2" so convert \\ to \xff
1678     $glob = strtr($glob, "\\", "\xff");
1679     $glob = str_replace("/", "\\/", $glob);
1680     // first convert some unescaped expressions to pcre style: . => \.
1681     $special = '.^$';
1682     $re = preg_replace('/([^\xff])?(['.preg_quote($special).'])/',
1683                        "\\1\xff\\2", $glob);
1684
1685     // * => .*, ? => .
1686     $re = preg_replace('/([^\xff])?\*/', '$1.*', $re);
1687     $re = preg_replace('/([^\xff])?\?/', '$1.', $re);
1688     if (!preg_match('/^[\?\*]/', $glob))
1689         $re = '^' . $re;
1690     if (!preg_match('/[\?\*]$/', $glob))
1691         $re = $re . '$';
1692
1693     // Fixes Bug 1182997
1694     // .*? handled above, now escape the rest
1695     //while (strcspn($re, $escape) != strlen($re)) // loop strangely needed
1696     $re = preg_replace('/([^\xff])(['.preg_quote($escape, "/").'])/',
1697                        "\\1\xff\\2", $re);
1698     // Problem with 'Date/Time' => 'Date\/Time' => 'Date\xff\/Time' => 'Date\/Time'
1699     // 'plugin/*.php'
1700     $re = preg_replace('/\xff/', '', $re);
1701     return $re;
1702 }
1703
1704 function glob_match ($glob, $against, $case_sensitive = true) {
1705     return preg_match('/' . glob_to_pcre($glob) . ($case_sensitive ? '/' : '/i'),
1706                       $against);
1707 }
1708
1709 function explodeList($input, $allnames, $glob_style = true, $case_sensitive = true) {
1710     $list = explode(',',$input);
1711     // expand wildcards from list of $allnames
1712     if (preg_match('/[\?\*]/',$input)) {
1713         // Optimizing loop invariants:
1714         // http://phplens.com/lens/php-book/optimizing-debugging-php.php
1715         for ($i = 0, $max = sizeof($list); $i < $max; $i++) {
1716             $f = $list[$i];
1717             if (preg_match('/[\?\*]/',$f)) {
1718                 reset($allnames);
1719                 $expand = new ListRegexExpand($list,
1720                     $glob_style ? glob_to_pcre($f) : $f, $case_sensitive);
1721                 $expand->expandRegex($i, $allnames);
1722             }
1723         }
1724     }
1725     return $list;
1726 }
1727
1728 // echo implode(":",explodeList("Test*",array("xx","Test1","Test2")));
1729 function explodePageList($input, $include_empty=false, $sortby='pagename',
1730              $limit='', $exclude='') {
1731     include_once("lib/PageList.php");
1732     return PageList::explodePageList($input, $include_empty, $sortby, $limit, $exclude);
1733 }
1734
1735 // Class introspections
1736
1737 /**
1738  * Determine whether object is of a specified type.
1739  * In PHP builtin since 4.2.0 as is_a()
1740  * is_a() deprecated in PHP 5, in favor of instanceof operator
1741
1742  * @param $object object An object.
1743  * @param $class string Class name.
1744  * @return bool True iff $object is a $class
1745  * or a sub-type of $class.
1746  */
1747 function isa ($object, $class) {
1748     //if (check_php_version(5))
1749     //    return $object instanceof $class;
1750     if (!check_php_version(5))
1751         return is_a($object, $class);
1752
1753     $lclass = check_php_version(5) ? $class : strtolower($class);
1754     return is_object($object)
1755         && ( strtolower(get_class($object)) == strtolower($class)
1756              || is_subclass_of($object, $lclass) );
1757 }
1758
1759 /** Determine whether a function is okay to use.
1760  *
1761  * Some providers (e.g. Lycos) disable some of PHP functions for
1762  * "security reasons."  This makes those functions, of course,
1763  * unusable, despite the fact the function_exists() says they
1764  * exist.
1765  *
1766  * This function test to see if a function exists and is not
1767  * disallowed by PHP's disable_functions config setting.
1768  *
1769  * @param string $function_name  Function name
1770  * @return bool  True iff function can be used.
1771  */
1772 function function_usable($function_name) {
1773     static $disabled;
1774     if (!is_array($disabled)) {
1775         $disabled = array();
1776         // Use get_cfg_var since ini_get() is one of the disabled functions
1777         // (on Lycos, at least.)
1778         $split = preg_split('/\s*,\s*/', trim(get_cfg_var('disable_functions')));
1779         foreach ($split as $f)
1780             $disabled[strtolower($f)] = true;
1781     }
1782
1783     return ( function_exists($function_name)
1784              and ! isset($disabled[strtolower($function_name)])
1785              );
1786 }
1787
1788
1789 /** Hash a value.
1790  *
1791  * This is used for generating ETags.
1792  */
1793 function wikihash ($x) {
1794     if (is_scalar($x)) {
1795         return $x;
1796     }
1797     elseif (is_array($x)) {
1798         ksort($x);
1799         return md5(serialize($x));
1800     }
1801     elseif (is_object($x)) {
1802         return $x->hash();
1803     }
1804     trigger_error("Can't hash $x", E_USER_ERROR);
1805 }
1806
1807
1808 /**
1809  * Seed the random number generator.
1810  *
1811  * better_srand() ensures the randomizer is seeded only once.
1812  *
1813  * How random do you want it? See:
1814  * http://www.php.net/manual/en/function.srand.php
1815  * http://www.php.net/manual/en/function.mt-srand.php
1816  */
1817 function better_srand($seed = '') {
1818     static $wascalled = FALSE;
1819     if (!$wascalled) {
1820         $seed = $seed === '' ? (double) microtime() * 1000000 : $seed;
1821         function_exists('mt_srand') ? mt_srand($seed) : srand($seed);
1822         $wascalled = TRUE;
1823         //trigger_error("new random seed", E_USER_NOTICE); //debugging
1824     }
1825 }
1826
1827 function rand_ascii($length = 1) {
1828     better_srand();
1829     $s = "";
1830     for ($i = 1; $i <= $length; $i++) {
1831         // return only typeable 7 bit ascii, avoid quotes
1832         if (function_exists('mt_rand'))
1833             $s .= chr(mt_rand(40, 126));
1834         else
1835             // the usually bad glibc srand()
1836             $s .= chr(rand(40, 126));
1837     }
1838     return $s;
1839 }
1840
1841 /* by Dan Frankowski.
1842  */
1843 function rand_ascii_readable ($length = 6) {
1844     // Pick a few random letters or numbers
1845     $word = "";
1846     better_srand();
1847     // Don't use 1lI0O, because they're hard to read
1848     $letters = "abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789";
1849     $letter_len = strlen($letters);
1850     for ($i=0; $i < $length; $i++) {
1851         if (function_exists('mt_rand'))
1852             $word .= $letters[mt_rand(0, $letter_len-1)];
1853         else
1854             $word .= $letters[rand(0, $letter_len-1)];
1855     }
1856     return $word;
1857 }
1858
1859 /**
1860  * Recursively count all non-empty elements
1861  * in array of any dimension or mixed - i.e.
1862  * array('1' => 2, '2' => array('1' => 3, '2' => 4))
1863  * See http://www.php.net/manual/en/function.count.php
1864  */
1865 function count_all($arg) {
1866     // skip if argument is empty
1867     if ($arg) {
1868         //print_r($arg); //debugging
1869         $count = 0;
1870         // not an array, return 1 (base case)
1871         if(!is_array($arg))
1872             return 1;
1873         // else call recursively for all elements $arg
1874         foreach($arg as $key => $val)
1875             $count += count_all($val);
1876         return $count;
1877     }
1878 }
1879
1880 function isSubPage($pagename) {
1881     return (strstr($pagename, SUBPAGE_SEPARATOR));
1882 }
1883
1884 function subPageSlice($pagename, $pos) {
1885     $pages = explode(SUBPAGE_SEPARATOR,$pagename);
1886     $pages = array_slice($pages,$pos,1);
1887     return $pages[0];
1888 }
1889
1890 function isActionPage($filename) {
1891
1892     global $AllActionPages;
1893
1894     $localizedAllActionPages = array_map("gettext", $AllActionPages);
1895
1896     return (in_array($filename, $localizedAllActionPages));
1897 }
1898
1899 /**
1900  * Alert
1901  *
1902  * Class for "popping up" and alert box.  (Except that right now, it doesn't
1903  * pop up...)
1904  *
1905  * FIXME:
1906  * This is a hackish and needs to be refactored.  However it would be nice to
1907  * unify all the different methods we use for showing Alerts and Dialogs.
1908  * (E.g. "Page deleted", login form, ...)
1909  */
1910 class Alert {
1911     /** Constructor
1912      *
1913      * @param object $request
1914      * @param mixed $head  Header ("title") for alert box.
1915      * @param mixed $body  The text in the alert box.
1916      * @param hash $buttons  An array mapping button labels to URLs.
1917      *    The default is a single "Okay" button pointing to $request->getURLtoSelf().
1918      */
1919     function Alert($head, $body, $buttons=false) {
1920         if ($buttons === false)
1921             $buttons = array();
1922
1923     if (is_array($body)) {
1924         $html = HTML::ol();
1925         foreach ($body as $li) {
1926         $html->pushContent(HTML::li($li));
1927         }
1928         $body = $html;
1929     }
1930         $this->_tokens = array('HEADER' => $head, 'CONTENT' => $body);
1931         $this->_buttons = $buttons;
1932     }
1933
1934     /**
1935      * Show the alert box.
1936      */
1937     function show() {
1938         global $request;
1939
1940         $tokens = $this->_tokens;
1941         $tokens['BUTTONS'] = $this->_getButtons();
1942
1943         $request->discardOutput();
1944         $tmpl = new Template('dialog', $request, $tokens);
1945         $tmpl->printXML();
1946         $request->finish();
1947     }
1948
1949
1950     function _getButtons() {
1951         global $request;
1952
1953         $buttons = $this->_buttons;
1954         if (!$buttons)
1955             $buttons = array(_("OK") => $request->getURLtoSelf());
1956
1957         global $WikiTheme;
1958         foreach ($buttons as $label => $url)
1959             print "$label $url\n";
1960             $out[] = $WikiTheme->makeButton($label, $url, 'wikiaction');
1961         return new XmlContent($out);
1962     }
1963 }
1964
1965 // 1.3.8     => 1030.08
1966 // 1.3.9-p1  => 1030.091
1967 // 1.3.10pre => 1030.099
1968 // 1.3.11pre-20041120 => 1030.1120041120
1969 // 1.3.12-rc1 => 1030.119
1970 function phpwiki_version() {
1971     static $PHPWIKI_VERSION;
1972     if (!isset($PHPWIKI_VERSION)) {
1973         $arr = explode('.',preg_replace('/\D+$/','', PHPWIKI_VERSION)); // remove the pre
1974         $arr[2] = preg_replace('/\.+/','.',preg_replace('/\D/','.',$arr[2]));
1975         $PHPWIKI_VERSION = $arr[0]*1000 + $arr[1]*10 + 0.01*$arr[2];
1976         if (strstr(PHPWIKI_VERSION, 'pre') or strstr(PHPWIKI_VERSION, 'rc'))
1977             $PHPWIKI_VERSION -= 0.01;
1978     }
1979     return $PHPWIKI_VERSION;
1980 }
1981
1982 function phpwiki_gzhandler($ob) {
1983     if (function_exists('gzencode'))
1984         $ob = gzencode($ob);
1985         $GLOBALS['request']->_ob_get_length = strlen($ob);
1986     if (!headers_sent()) {
1987         header(sprintf("Content-Length: %d", $GLOBALS['request']->_ob_get_length));
1988     }
1989     return $ob;
1990 }
1991
1992 function isWikiWord($word) {
1993     global $WikiNameRegexp;
1994     //or preg_match('/\A' . $WikiNameRegexp . '\z/', $word) ??
1995     return preg_match("/^$WikiNameRegexp\$/",$word);
1996 }
1997
1998 // needed to store serialized objects-values only (perm, pref)
1999 function obj2hash ($obj, $exclude = false, $fields = false) {
2000     $a = array();
2001     if (! $fields ) $fields = get_object_vars($obj);
2002     foreach ($fields as $key => $val) {
2003         if (is_array($exclude)) {
2004             if (in_array($key, $exclude)) continue;
2005         }
2006         $a[$key] = $val;
2007     }
2008     return $a;
2009 }
2010
2011 /**
2012  * isAsciiString($string)
2013  */
2014 function isAsciiString($s) {
2015     $ptrASCII  = '[\x00-\x7F]';
2016     return preg_match("/^($ptrASCII)*$/s", $s);
2017 }
2018
2019 /**
2020  * isUtf8String($string) - cheap utf-8 detection
2021  *
2022  * segfaults for strings longer than 10kb!
2023  * Use http://www.phpdiscuss.com/article.php?id=565&group=php.i18n or
2024  * checkTitleEncoding() at http://cvs.sourceforge.net/viewcvs.py/wikipedia/phase3/languages/Language.php
2025  */
2026 function isUtf8String( $s ) {
2027     $ptrASCII  = '[\x00-\x7F]';
2028     $ptr2Octet = '[\xC2-\xDF][\x80-\xBF]';
2029     $ptr3Octet = '[\xE0-\xEF][\x80-\xBF]{2}';
2030     $ptr4Octet = '[\xF0-\xF4][\x80-\xBF]{3}';
2031     $ptr5Octet = '[\xF8-\xFB][\x80-\xBF]{4}';
2032     $ptr6Octet = '[\xFC-\xFD][\x80-\xBF]{5}';
2033     return preg_match("/^($ptrASCII|$ptr2Octet|$ptr3Octet|$ptr4Octet|$ptr5Octet|$ptr6Octet)*$/s", $s);
2034 }
2035
2036 /**
2037  * Check for UTF-8 URLs; Internet Explorer produces these if you
2038  * type non-ASCII chars in the URL bar or follow unescaped links.
2039  * Requires urldecoded pagename.
2040  * Fixes sf.net bug #953949
2041  *
2042  * src: languages/Language.php:checkTitleEncoding() from mediawiki
2043  */
2044 function fixTitleEncoding( $s ) {
2045     global $charset;
2046
2047     $s = trim($s);
2048     // print a warning?
2049     if (empty($s)) return $s;
2050
2051     $ishigh = preg_match( '/[\x80-\xff]/', $s);
2052     /*
2053     $isutf = ($ishigh ? preg_match( '/^([\x00-\x7f]|[\xc0-\xdf][\x80-\xbf]|' .
2054                                     '[\xe0-\xef][\x80-\xbf]{2}|[\xf0-\xf7][\x80-\xbf]{3})+$/', $s ) : true );
2055     */
2056     $isutf = ($ishigh ? isUtf8String($s) : true);
2057     $locharset = strtolower($charset);
2058
2059     if( $locharset != "utf-8" and $ishigh and $isutf )
2060     $s = charset_convert('UTF-8', $locharset, $s);
2061     if ($locharset == "utf-8" and $ishigh and !$isutf )
2062         return utf8_encode( $s );
2063
2064     // Other languages can safely leave this function, or replace
2065     // it with one to detect and convert another legacy encoding.
2066     return $s;
2067 }
2068
2069 /**
2070  * MySQL fulltext index doesn't grok utf-8, so we
2071  * need to fold cases and convert to hex.
2072  * src: languages/Language.php:stripForSearch() from mediawiki
2073  */
2074 /*
2075 function stripForSearch( $string ) {
2076     global $wikiLowerChars;
2077     // '/(?:[a-z]|\xc3[\x9f-\xbf]|\xc4[\x81\x83\x85\x87])/' => "a-z\xdf-\xf6\xf8-\xff"
2078     return preg_replace(
2079                         "/([\\xc0-\\xff][\\x80-\\xbf]*)/e",
2080                         "'U8' . bin2hex( strtr( \"\$1\", \$wikiLowerChars ) )",
2081                         $string );
2082 }
2083 */
2084
2085 /**
2086  * Workaround for allow_url_fopen, to get the content of an external URI.
2087  * It returns the contents in one slurp. Parsers might want to check for allow_url_fopen
2088  * and use fopen, fread chunkwise. (see lib/XmlParser.php)
2089  */
2090 function url_get_contents( $uri ) {
2091     if (get_cfg_var('allow_url_fopen')) { // was ini_get('allow_url_fopen'))
2092         return @file_get_contents($uri);
2093     } else {
2094         require_once("lib/HttpClient.php");
2095         $bits = parse_url($uri);
2096         $host = $bits['host'];
2097         $port = isset($bits['port']) ? $bits['port'] : 80;
2098         $path = isset($bits['path']) ? $bits['path'] : '/';
2099         if (isset($bits['query'])) {
2100             $path .= '?'.$bits['query'];
2101         }
2102         $client = new HttpClient($host, $port);
2103         $client->use_gzip = false;
2104         if (!$client->get($path)) {
2105             return false;
2106         } else {
2107             return $client->getContent();
2108         }
2109     }
2110 }
2111
2112 /**
2113  * Generate consecutively named strings:
2114  *   Name, Name2, Name3, ...
2115  */
2116 function GenerateId($name) {
2117     static $ids = array();
2118     if (empty($ids[$name])) {
2119         $ids[$name] = 1;
2120         return $name;
2121     } else {
2122         $ids[$name]++;
2123         return $name . $ids[$name];
2124     }
2125 }
2126
2127 // from IncludePage. To be of general use.
2128 // content: string or array of strings
2129 function firstNWordsOfContent( $n, $content ) {
2130     if ($content and $n > 0) {
2131         if (is_array($content)) {
2132             // fixme: return a list of lines then?
2133             //$content = join("\n", $content);
2134             //$return_array = true;
2135             $wordcount = 0;
2136             foreach ($content as $line) {
2137                 $words = explode(' ', $line);
2138                 if ($wordcount + count($words) > $n) {
2139                     $new[] = implode(' ', array_slice($words, 0, $n - $wordcount))
2140                            . sprintf(_("... (first %s words)"), $n);
2141                     return $new;
2142                 } else {
2143                     $wordcount += count($words);
2144                     $new[] = $line;
2145                 }
2146             }
2147             return $new;
2148         } else {
2149             // fixme: use better whitespace/word seperators
2150             $words = explode(' ', $content);
2151             if (count($words) > $n) {
2152                 return join(' ', array_slice($words, 0, $n))
2153                        . sprintf(_("... (first %s words)"), $n);
2154             } else {
2155                 return $content;
2156             }
2157         }
2158     } else {
2159         return '';
2160     }
2161 }
2162
2163 // moved from lib/plugin/IncludePage.php
2164 function extractSection ($section, $content, $page, $quiet = false, $sectionhead = false) {
2165     $qsection = preg_replace('/\s+/', '\s+', preg_quote($section, '/'));
2166
2167     if (preg_match("/ ^(!{1,}|={2,})\\s*$qsection\s*=*" // section header
2168                    . "  \\s*$\\n?"           // possible blank lines
2169                    . "  ( (?: ^.*\\n? )*? )" // some lines
2170                    . "  (?= ^\\1 | \\Z)/xm", // sec header (same or higher level) (or EOF)
2171                    implode("\n", $content),
2172                    $match)) {
2173         // Strip trailing blanks lines and ---- <hr>s
2174         $text = preg_replace("/\\s*^-{4,}\\s*$/m", "", $match[2]);
2175         if ($sectionhead)
2176             $text = $match[1] . $section ."\n". $text;
2177         return explode("\n", $text);
2178     }
2179     if ($quiet)
2180         $mesg = $page ." ". $section;
2181     else
2182         $mesg = $section;
2183     return array(sprintf(_("<%s: no such section>"), $mesg));
2184 }
2185
2186 // Extract the first $sections sections of the page
2187 function extractSections ($sections, $content, $page, $quiet = false, $sectionhead = false) {
2188
2189     $mycontent = $content;
2190     $result = "";
2191
2192     while ($sections > 0) {
2193
2194         if (preg_match("/ ^(!{1,}|={2,})\\s*(.*)\\n"   // section header
2195                        . "  \\s*$\\n?"           // possible blank lines
2196                        . "  ( (?: ^.*\\n? )*? )" // some lines
2197                        . "  ( ^\\1 (.|\\n)* | \\Z)/xm", // sec header (same or higher level) (or EOF)
2198                        implode("\n", $mycontent),
2199                        $match)) {
2200             $section = $match[2];
2201             // Strip trailing blanks lines and ---- <hr>s
2202             $text = preg_replace("/\\s*^-{4,}\\s*$/m", "", $match[3]);
2203             if ($sectionhead)
2204                 $text = $match[1] . $section ."\n". $text;
2205             $result .= $text;
2206
2207             $mycontent = explode("\n", $match[4]);
2208             $sections--;
2209             if ($sections === 0) {
2210                 return explode("\n", $result);
2211             }
2212         }
2213     }
2214 }
2215
2216 // use this faster version: only load ExternalReferrer if we came from an external referrer
2217 function isExternalReferrer(&$request) {
2218     if ($referrer = $request->get('HTTP_REFERER')) {
2219         $home = SERVER_URL; // SERVER_URL or SCRIPT_NAME, if we want to check sister wiki's also
2220         if (string_starts_with(strtolower($referrer), strtolower($home))) return false;
2221         require_once("lib/ExternalReferrer.php");
2222         $se = new SearchEngines();
2223         return $se->parseSearchQuery($referrer);
2224     }
2225     //if (DEBUG) return array('query' => 'wiki');
2226     return false;
2227 }
2228
2229 /**
2230  * Useful for PECL overrides: cvsclient, ldap, soap, xmlrpc, pdo, pdo_<driver>
2231  */
2232 function loadPhpExtension($extension) {
2233     if (!extension_loaded($extension)) {
2234     $isWindows = (substr(PHP_OS,0,3) == 'WIN');
2235         $soname = ($isWindows ? 'php_' : '')
2236             . $extension
2237             . ($isWindows ? '.dll' : '.so');
2238         if (!@dl($soname))
2239             return false;
2240     }
2241     return extension_loaded($extension);
2242 }
2243
2244 function charset_convert($from, $to, $data) {
2245     //global $CHARSET;
2246     //$wikicharset = strtolower($CHARSET);
2247     //$systemcharset = strtolower(get_cfg_var('iconv.internal_encoding')); // 'iso-8859-1';
2248     if (strtolower($from) == 'utf-8' and strtolower($to) == 'iso-8859-1')
2249     return utf8_decode($data);
2250     if (strtolower($to) == 'utf-8' and strtolower($from) == 'iso-8859-1')
2251     return utf8_encode($data);
2252
2253     if (loadPhpExtension("iconv")) {
2254     $tmpdata = iconv($from, $to, $data);
2255     if (!$tmpdata)
2256         trigger_error("charset conversion $from => $to failed. Wrong source charset?", E_USER_WARNING);
2257     else
2258         $data = $tmpdata;
2259     } else {
2260     trigger_error("The iconv extension cannot be loaded", E_USER_WARNING);
2261     }
2262     return $data;
2263 }
2264
2265 function string_starts_with($string, $prefix) {
2266     return (substr($string, 0, strlen($prefix)) == $prefix);
2267 }
2268 function string_ends_with($string, $suffix) {
2269     return (substr($string, -strlen($suffix)) == $suffix);
2270 }
2271 function array_remove($arr,$value) {
2272    return array_values(array_diff($arr,array($value)));
2273 }
2274
2275 /**
2276  * Ensure that the script will have another $secs time left.
2277  * Works only if safe_mode is off.
2278  * For example not to timeout on waiting socket connections.
2279  *   Use the socket timeout as arg.
2280  */
2281 function longer_timeout($secs = 30) {
2282     $timeout = @ini_get("max_execution_time") ? ini_get("max_execution_time") : 30;
2283     $timeleft = $timeout - $GLOBALS['RUNTIMER']->getTime();
2284     if ($timeleft < $secs)
2285         @set_time_limit(max($timeout,(integer)($secs + $timeleft)));
2286 }
2287
2288 function printSimpleTrace($bt) {
2289     //print_r($bt);
2290     echo "\nTraceback:\n";
2291     if (function_exists('debug_print_backtrace')) { // >= 5
2292     debug_print_backtrace();
2293     } else {
2294     foreach ($bt as $i => $elem) {
2295         if (!array_key_exists('file', $elem)) {
2296         continue;
2297         }
2298         //echo join(" ",array_values($elem)),"\n";
2299         echo "  ",$elem['file'],':',$elem['line']," ",$elem['function'],"\n";
2300     }
2301     }
2302 }
2303
2304 /**
2305  * Return the used process memory, in bytes.
2306  * Enable the section which will work for you. They are very slow.
2307  * Special quirks for Windows: Requires cygwin.
2308  */
2309 function getMemoryUsage() {
2310     //if (!(DEBUG & _DEBUG_VERBOSE)) return;
2311     if (function_exists('memory_get_usage') and memory_get_usage()) {
2312         return memory_get_usage();
2313     } elseif (function_exists('getrusage') and ($u = @getrusage()) and !empty($u['ru_maxrss'])) {
2314         $mem = $u['ru_maxrss'];
2315     } elseif (substr(PHP_OS,0,3) == 'WIN') { // may require a newer cygwin
2316         // what we want is the process memory only: apache or php (if CGI)
2317         $pid = getmypid();
2318         $memstr = '';
2319     // win32_ps_stat_proc, win32_ps_stat_mem
2320      if (function_exists('win32_ps_list_procs')) {
2321         $info = win32_ps_stat_proc($pid);
2322         $memstr = $info['mem']['working_set_size'];
2323     } elseif(0) {
2324         // This works only if it's a cygwin process (apache or php).
2325         // Requires a newer cygwin
2326         $memstr = exec("cat /proc/$pid/statm |cut -f1");
2327
2328         // if it's native windows use something like this:
2329         //   (requires pslist from sysinternals.com, grep, sed and perl)
2330         //$memstr = exec("pslist $pid|grep -A1 Mem|sed 1d|perl -ane\"print \$"."F[5]\"");
2331         }
2332         return (integer) trim($memstr);
2333     } elseif (1) {
2334         $pid = getmypid();
2335         //%MEM: Percentage of total memory in use by this process
2336         //VSZ: Total virtual memory size, in 1K blocks.
2337         //RSS: Real Set Size, the actual amount of physical memory allocated to this process.
2338         //CPU time used by process since it started.
2339         //echo "%",`ps -o%mem,vsz,rss,time -p $pid|sed 1d`,"\n";
2340         $memstr = exec("ps -orss -p $pid|sed 1d");
2341         return (integer) trim($memstr);
2342     }
2343 }
2344
2345 /**
2346  * @param var $needle
2347  * @param array $haystack one-dimensional numeric array only, no hash
2348  * @return integer
2349  * @desc Feed a sorted array to $haystack and a value to search for to $needle.
2350              It will return false if not found or the index where it was found.
2351   From dennis.decoene@moveit.be http://www.php.net/array_search
2352 */
2353 function binary_search($needle, $haystack) {
2354     $high = count($haystack);
2355     $low = 0;
2356
2357     while (($high - $low) > 1) {
2358         $probe = floor(($high + $low) / 2);
2359         if ($haystack[$probe] < $needle) {
2360             $low = $probe;
2361         } elseif ($haystack[$probe] == $needle) {
2362             $high = $low = $probe;
2363         } else {
2364             $high = $probe;
2365         }
2366     }
2367
2368     if ($high == count($haystack) || $haystack[$high] != $needle) {
2369         return false;
2370     } else {
2371         return $high;
2372     }
2373 }
2374
2375 function is_localhost($url = false) {
2376     if (!$url) {
2377         global $HTTP_SERVER_VARS;
2378         return $HTTP_SERVER_VARS['SERVER_ADDR'] == '127.0.0.1';
2379     }
2380 }
2381
2382 /**
2383  * Take a string and quote it sufficiently to be passed as a Javascript
2384  * string between ''s
2385  */
2386 function javascript_quote_string($s) {
2387     return str_replace("'", "\'", $s);
2388 }
2389
2390 function isSerialized($s) {
2391     return (!empty($s) and (strlen($s) > 3) and (substr($s,1,1) == ':'));
2392 }
2393
2394 /**
2395  * Determine if a variable represents a whole number
2396  */
2397
2398 function is_whole_number($var) {
2399   return (is_numeric($var) && (intval($var)==floatval($var)));
2400 }
2401
2402 /**
2403  * Take a string and return an array of pairs (attribute name, attribute value)
2404  *
2405  * We allow attributes with or without double quotes (")
2406  * Attribute-value pairs may be separated by space or comma
2407  * Space is normal HTML attributes, comma is for RichTable compatibility
2408  * border=1, cellpadding="5"
2409  * border=1 cellpadding="5"
2410  * style="font-family: sans-serif; border-top:1px solid #dddddd;"
2411  * style="font-family: Verdana, Arial, Helvetica, sans-serif"
2412  */
2413 function parse_attributes($line) {
2414
2415     $options = array();
2416
2417     if (empty($line)) return $options;
2418     $line = trim($line);
2419     if (empty($line)) return $options;
2420     $line = trim($line, ",");
2421     if (empty($line)) return $options;
2422
2423     // First we have an attribute name.
2424     $attribute = "";
2425     $value = "";
2426
2427     $i = 0;
2428     while (($i < strlen($line)) && ($line[$i] != '=')) {
2429         $i++;
2430     }
2431     $attribute = substr($line, 0, $i);
2432     $attribute = strtolower($attribute);
2433
2434     $line = substr($line, $i+1);
2435     $line = trim ($line);
2436     $line = trim ($line, "=");
2437     $line = trim ($line);
2438
2439     if (empty($line)) return $options;
2440
2441     // Then we have the attribute value.
2442
2443     $i = 0;
2444     // Attribute value might be between double quotes
2445     // In that case we have to find the closing double quote
2446     if ($line[0] == '"') {
2447         $i++; // skip first '"'
2448         while (($i < strlen($line)) && ($line[$i] != '"')) {
2449             $i++;
2450         }
2451         $value = substr($line, 0, $i);
2452         $value = trim ($value, '"');
2453         $value = trim ($value);
2454
2455     // If there are no double quotes, we have to find the next space or comma
2456     } else {
2457         while (($i < strlen($line)) && (($line[$i] != ' ') && ($line[$i] != ','))) {
2458             $i++;
2459         }
2460         $value = substr($line, 0, $i);
2461         $value = trim ($value);
2462         $value = trim ($value, ",");
2463         $value = trim ($value);
2464     }
2465
2466     $options[$attribute] = $value;
2467
2468     $line = substr($line, $i+1);
2469     $line = trim ($line);
2470     $line = trim ($line, ",");
2471     $line = trim ($line);
2472
2473     return $options + parse_attributes($line);
2474 }
2475
2476 /**
2477  * Returns true if the filename ends with an image suffix.
2478  * Uses INLINE_IMAGES if defined, else "png|jpg|jpeg|gif"
2479  */
2480 function is_image ($filename) {
2481
2482     if (defined('INLINE_IMAGES')) {
2483         $inline_images = INLINE_IMAGES;
2484     } else {
2485         $inline_images = "png|jpg|jpeg|gif";
2486     }
2487
2488     foreach (explode("|", $inline_images) as $suffix) {
2489         if (string_ends_with(strtolower($filename), "." . $suffix)) {
2490             return true;
2491         }
2492     }
2493     return false;
2494 }
2495
2496 /**
2497  * Returns true if the filename ends with an video suffix.
2498  * Currently only FLV and OGG
2499  */
2500 function is_video ($filename) {
2501
2502     return string_ends_with(strtolower($filename), ".flv")
2503         or string_ends_with(strtolower($filename), ".ogg");
2504 }
2505
2506 /**
2507  * Remove accents from given text.
2508  */
2509 function strip_accents($text) {
2510     $res = utf8_decode($text);
2511     $res = strtr($res,
2512                  utf8_decode('àáâãäçèéêëìíîïñòóôõöùúûüýÿÀÁÂÃÄÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝ'),
2513                              'aaaaaceeeeiiiinooooouuuuyyAAAAACEEEEIIIINOOOOOUUUUY');
2514     return utf8_encode($res);
2515 }
2516
2517 // Local Variables:
2518 // mode: php
2519 // tab-width: 8
2520 // c-basic-offset: 4
2521 // c-hanging-comment-ender-p: nil
2522 // indent-tabs-mode: nil
2523 // End:
2524 ?>