lib/stdlib.php

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