lib/stdlib.php

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