lib/stdlib.php

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