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