1 <?php //rcs_id('$Id: stdlib.php,v 1.217 2004-11-16 17:31:03 rurban Exp $');
4 Standard functions for Wiki functionality
5 WikiURL ($pagename, $args, $get_abs_url)
7 IconForLink ($protocol_or_url)
8 PossiblyGlueIconToText($proto_or_url, $text)
10 LinkURL ($url, $linktext)
11 LinkImage ($url, $alt)
13 SplitQueryArgs ($query_args)
14 LinkPhpwikiURL ($url, $text, $basepage)
15 ConvertOldMarkup ($content, $markup_type = "block")
16 MangleXmlIdentifier($str)
17 UnMangleXmlIdentifier($str)
19 class Stack { push($item), pop(), cnt(), top() }
20 class Alert { show() }
21 class WikiPageName {getParent(),isValid(),getWarnings() }
23 expand_tabs($str, $tab_width = 8)
25 NoSuchRevision ($request, $page, $version)
26 TimezoneOffset ($time, $no_colon)
27 Iso8601DateTime ($time)
28 Rfc2822DateTime ($time)
29 ParseRfc1123DateTime ($timestr)
31 ByteFormatter ($bytes = 0, $longformat = false)
34 __vsprintf ($fmt, $args)
36 file_mtime ($filename)
37 sort_file_mtime ($a, $b)
38 class fileSet {fileSet($directory, $filepattern = false), getFiles($exclude=false, $sortby=false, $limit=false) }
39 class ListRegexExpand { listMatchCallback($item, $key), expandRegex ($index, &$pages) }
42 glob_match ($glob, $against, $case_sensitive = true)
43 explodeList ($input, $allnames, $glob_style = true, $case_sensitive = true)
44 explodePageList ($input, $perm = false)
46 can ($object, $method)
47 function_usable ($function_name)
49 better_srand ($seed = '')
52 subPageSlice ($pagename, $pos)
56 obj2hash ($obj, $exclude = false, $fields = false)
59 url_get_contents ($uri)
61 firstNWordsOfContent ($n, $content)
62 extractSection ($section, $content, $page, $quiet = false, $sectionhead = false)
65 function: LinkInterWikiLink($link, $linktext)
66 moved to: lib/interwiki.php
67 function: linkExistingWikiWord($wikiword, $linktext, $version)
68 moved to: lib/Theme.php
69 function: LinkUnknownWikiWord($wikiword, $linktext)
70 moved to: lib/Theme.php
71 function: UpdateRecentChanges($dbi, $pagename, $isnewpage)
72 gone see: lib/plugin/RecentChanges.php
74 if (defined('_PHPWIKI_STDLIB_LOADED')) return;
75 else define('_PHPWIKI_STDLIB_LOADED', true);
77 define('MAX_PAGENAME_LENGTH', 100);
81 * Convert string to a valid XML identifier.
83 * XML 1.0 identifiers are of the form: [A-Za-z][A-Za-z0-9:_.-]*
85 * We would like to have, e.g. named anchors within wiki pages
86 * names like "Table of Contents" --- clearly not a valid XML
87 * fragment identifier.
89 * This function implements a one-to-one map from {any string}
90 * to {valid XML identifiers}.
93 * converting all bytes not in [A-Za-z0-9:_-],
94 * and any leading byte not in [A-Za-z] to 'xbb.',
95 * where 'bb' is the hexadecimal representation of the
98 * As a special case, the empty string is converted to 'empty.'
103 function MangleXmlIdentifier($str) {
107 return preg_replace('/[^-_:A-Za-z0-9]|(?<=^)[^A-Za-z]/e',
108 "'x' . sprintf('%02x', ord('\\0')) . '.'",
112 function UnMangleXmlIdentifier($str) {
113 if ($str == 'empty.')
115 return preg_replace('/x(\w\w)\./e',
116 "sprintf('%c', hex('\\0'))",
121 * Generates a valid URL for a given Wiki pagename.
122 * @param mixed $pagename If a string this will be the name of the Wiki page to link to.
123 * If a WikiDB_Page object function will extract the name to link to.
124 * If a WikiDB_PageRevision object function will extract the name to link to.
126 * @param boolean $get_abs_url Default value is false.
127 * @return string The absolute URL to the page passed as $pagename.
129 function WikiURL($pagename, $args = '', $get_abs_url = false) {
132 if (is_object($pagename)) {
133 if (isa($pagename, 'WikiDB_Page')) {
134 $pagename = $pagename->getName();
136 elseif (isa($pagename, 'WikiDB_PageRevision')) {
137 $page = $pagename->getPage();
138 $args['version'] = $pagename->getVersion();
139 $pagename = $page->getName();
141 elseif (isa($pagename, 'WikiPageName')) {
142 $anchor = $pagename->anchor;
143 $pagename = $pagename->name;
145 $anchor = $pagename->anchor;
146 $pagename = $pagename->name;
149 if (!$get_abs_url and DEBUG and $GLOBALS['request']->getArg('start_debug')) {
151 $args = 'start_debug=' . $GLOBALS['request']->getArg('start_debug');
152 elseif (is_array($args))
153 $args['start_debug'] = $GLOBALS['request']->getArg('start_debug');
155 $args .= '&start_debug=' . $GLOBALS['request']->getArg('start_debug');
157 if (is_array($args)) {
159 foreach ($args as $key => $val) {
160 if (!is_array($val)) // ugly hack for getURLtoSelf() which also takes POST vars
161 $enc_args[] = urlencode($key) . '=' . urlencode($val);
163 $args = join('&', $enc_args);
166 if (USE_PATH_INFO or !empty($GLOBALS['WikiTheme']->HTML_DUMP_SUFFIX)) {
167 $url = $get_abs_url ? SERVER_URL . VIRTUAL_PATH . "/" : "";
168 $url .= preg_replace('/%2f/i', '/', rawurlencode($pagename));
169 if (!empty($GLOBALS['WikiTheme']->HTML_DUMP_SUFFIX))
170 $url .= $GLOBALS['WikiTheme']->HTML_DUMP_SUFFIX;
175 $url = $get_abs_url ? SERVER_URL . SCRIPT_NAME : basename(SCRIPT_NAME);
176 $url .= "?pagename=" . rawurlencode($pagename);
181 $url .= "#" . MangleXmlIdentifier($anchor);
185 /** Convert relative URL to absolute URL.
187 * This converts a relative URL to one of PhpWiki's support files
188 * to an absolute one.
191 * @return string Absolute URL
193 function AbsoluteURL ($url) {
194 if (preg_match('/^https?:/', $url))
196 if ($url[0] != '/') {
197 $base = USE_PATH_INFO ? VIRTUAL_PATH : dirname(SCRIPT_NAME);
198 while ($base != '/' and substr($url, 0, 3) == "../") {
199 $url = substr($url, 3);
200 $base = dirname($base);
206 return SERVER_URL . $url;
210 * Generates icon in front of links.
212 * @param string $protocol_or_url URL or protocol to determine which icon to use.
214 * @return HtmlElement HtmlElement object that contains data to create img link to
215 * icon for use with url or protocol passed to the function. False if no img to be
218 function IconForLink($protocol_or_url) {
220 if (0 and $filename_suffix == false) {
221 // display apache style icon for file type instead of protocol icon
222 // - archive: unix:gz,bz2,tgz,tar,z; mac:dmg,dmgz,bin,img,cpt,sit; pc:zip;
223 // - document: html, htm, text, txt, rtf, pdf, doc
224 // - non-inlined image: jpg,jpeg,png,gif,tiff,tif,swf,pict,psd,eps,ps
225 // - audio: mp3,mp2,aiff,aif,au
226 // - multimedia: mpeg,mpg,mov,qt
228 list ($proto) = explode(':', $protocol_or_url, 2);
229 $src = $WikiTheme->getLinkIconURL($proto);
231 return HTML::img(array('src' => $src, 'alt' => "", 'class' => 'linkicon', 'border' => 0));
238 * Glue icon in front of or after text.
239 * Pref: 'noLinkIcons' - ignore icon if set
240 * Theme: 'LinkIcons' - 'yes' at front
241 * - 'no' display no icon
242 * - 'front' display at left
243 * - 'after' display at right
245 * @param string $protocol_or_url Protocol or URL. Used to determine the
247 * @param string $text The text.
248 * @return XmlContent.
250 function PossiblyGlueIconToText($proto_or_url, $text) {
251 global $request, $WikiTheme;
252 if ($request->getPref('noLinkIcons'))
254 $icon = IconForLink($proto_or_url);
257 if ($where = $WikiTheme->getLinkIconAttr()) {
258 if ($where == 'no') return $text;
259 if ($where != 'after') $where = 'front';
263 if ($where == 'after') {
264 // span the icon only to the last word (tie them together),
265 // to let the previous words wrap on line breaks.
266 if (!is_object($text)) {
267 preg_match('/^(\s*\S*)(\s*)$/', $text, $m);
268 list (, $prefix, $last_word) = $m;
274 $text = HTML::span(array('style' => 'white-space: nowrap'),
275 $last_word, HTML::Raw(' '), $icon);
277 $text = HTML($prefix, $text);
280 // span the icon only to the first word (tie them together),
281 // to let the next words wrap on line breaks
282 if (!is_object($text)) {
283 preg_match('/^\s*(\S*)(.*?)\s*$/', $text, $m);
284 list (, $first_word, $tail) = $m;
290 $text = HTML::span(array('style' => 'white-space: nowrap'),
293 $text = HTML($text, $tail);
298 * Determines if the url passed to function is safe, by detecting if the characters
299 * '<', '>', or '"' are present.
301 * @param string $url URL to check for unsafe characters.
302 * @return boolean True if same, false else.
304 function IsSafeURL($url) {
305 return !preg_match('/[<>"]/', $url);
309 * Generates an HtmlElement object to store data for a link.
311 * @param string $url URL that the link will point to.
312 * @param string $linktext Text to be displayed as link.
313 * @return HtmlElement HtmlElement object that contains data to construct an html link.
315 function LinkURL($url, $linktext = '') {
316 // FIXME: Is this needed (or sufficient?)
317 if(! IsSafeURL($url)) {
318 $link = HTML::strong(HTML::u(array('class' => 'baduri'),
319 _("BAD URL -- remove all of <, >, \"")));
323 $linktext = preg_replace("/mailto:/A", "", $url);
325 $link = HTML::a(array('href' => $url),
326 PossiblyGlueIconToText($url, $linktext));
329 $link->setAttr('class', $linktext ? 'namedurl' : 'rawurl');
334 * FIXME: disallow sizes which are too small.
335 * Spammers may use such (typically invisible) image attributes to higher their GoogleRank.
337 function LinkImage($url, $alt = false) {
338 // FIXME: Is this needed (or sufficient?)
339 if(! IsSafeURL($url)) {
340 $link = HTML::strong(HTML::u(array('class' => 'baduri'),
341 _("BAD URL -- remove all of <, >, \"")));
343 // support new syntax: [image.jpg size=50% border=n]
344 $arr = split(' ',$url);
345 if (count($arr) > 1) {
348 if (empty($alt)) $alt = basename($url);
349 $link = HTML::img(array('src' => $url, 'alt' => $alt));
350 if (count($arr) > 1) {
352 foreach ($arr as $attr) {
353 if (preg_match('/^size=(\d+%)$/',$attr,$m)) {
354 $link->setAttr('width',$m[1]);
355 $link->setAttr('height',$m[1]);
357 if (preg_match('/^size=(\d+)x(\d+)$/',$attr,$m)) {
358 $link->setAttr('width',$m[1]);
359 $link->setAttr('height',$m[2]);
361 if (preg_match('/^border=(\d+)$/',$attr,$m))
362 $link->setAttr('border',$m[1]);
363 if (preg_match('/^align=(\w+)$/',$attr,$m))
364 $link->setAttr('align',$m[1]);
365 if (preg_match('/^hspace=(\d+)$/',$attr,$m))
366 $link->setAttr('hspace',$m[1]);
367 if (preg_match('/^vspace=(\d+)$/',$attr,$m))
368 $link->setAttr('vspace',$m[1]);
371 // check width and height as spam countermeasure
372 if (($width = $link->getAttr('width')) and ($height = $link->getAttr('height'))) {
373 //$width = (int) $width; // px or % or other suffix
374 //$height = (int) $height;
375 if (($width < 3 and $height < 10) or
376 ($height < 3 and $width < 20) or
377 ($height < 7 and $width < 7))
379 trigger_error(_("Invalid image size"), E_USER_NOTICE);
383 // Older php versions crash here with certain png's:
384 // confirmed for 4.1.2, 4.1.3, 4.2.3; 4.3.2 and 4.3.7 are ok
385 // http://phpwiki.sourceforge.net/demo/themes/default/images/http.png
386 // See http://bugs.php.net/search.php?cmd=display&search_for=getimagesize
387 if (!check_php_version(4,3) and preg_match("/^http.+\.png$/i",$url))
388 ; // it's safe to assume that this will fail.
389 elseif (!DISABLE_GETIMAGESIZE and ($size = @getimagesize($url))) {
392 if (($width < 3 and $height < 10)
393 or ($height < 3 and $width < 20)
394 or ($height < 7 and $width < 7))
396 trigger_error(_("Invalid image size"), E_USER_NOTICE);
402 $link->setAttr('class', 'inlineimage');
410 // var in php5 deprecated
412 $this->items = array();
415 function push($item) {
416 $this->items[$this->size] = $item;
422 if ($this->size == 0) {
423 return false; // stack is empty
426 return $this->items[$this->size];
435 return $this->items[$this->size - 1];
441 // end class definition
443 function SplitQueryArgs ($query_args = '')
445 $split_args = split('&', $query_args);
447 while (list($key, $val) = each($split_args))
448 if (preg_match('/^ ([^=]+) =? (.*) /x', $val, $m))
449 $args[$m[1]] = $m[2];
453 function LinkPhpwikiURL($url, $text = '', $basepage = false) {
456 if (!preg_match('/^ phpwiki: ([^?]*) [?]? (.*) $/x', $url, $m)) {
457 return HTML::strong(array('class' => 'rawurl'),
458 HTML::u(array('class' => 'baduri'),
459 _("BAD phpwiki: URL")));
463 $pagename = urldecode($m[1]);
466 if (empty($pagename) &&
467 preg_match('/^(diff|edit|links|info)=([^&]+)$/', $qargs, $m)) {
468 // Convert old style links (to not break diff links in
470 $pagename = urldecode($m[2]);
471 $args = array("action" => $m[1]);
474 $args = SplitQueryArgs($qargs);
477 if (empty($pagename))
478 $pagename = $GLOBALS['request']->getArg('pagename');
480 if (isset($args['action']) && $args['action'] == 'browse')
481 unset($args['action']);
484 if (empty($args['action']))
486 else if (is_safe_action($args['action']))
487 $class = 'wikiaction';
489 if (empty($args['action']) || is_safe_action($args['action']))
490 $class = 'wikiaction';
492 // Don't allow administrative links on unlocked pages.
493 $dbi = $GLOBALS['request']->getDbh();
494 $page = $dbi->getPage($basepage ? $basepage : $pagename);
495 if (!$page->get('locked'))
496 return HTML::span(array('class' => 'wikiunsafe'),
497 HTML::u(_("Lock page to enable link")));
498 $class = 'wikiadmin';
502 $text = HTML::span(array('class' => 'rawurl'), $url);
504 $wikipage = new WikiPageName($pagename);
505 if (!$wikipage->isValid()) {
507 return $WikiTheme->linkBadWikiWord($wikipage, $url);
510 return HTML::a(array('href' => WikiURL($pagename, $args),
516 * A class to assist in parsing wiki pagenames.
518 * Now with subpages and anchors, parsing and passing around
519 * pagenames is more complicated. This should help.
523 /** Short name for page.
525 * This is the value of $name passed to the constructor.
526 * (For use, e.g. as a default label for links to the page.)
530 /** The full page name.
532 * This is the full name of the page (without anchor).
538 * This is the referenced anchor within the page, or the empty string.
544 * @param mixed $name Page name.
545 * WikiDB_Page, WikiDB_PageRevision, or string.
546 * This can be a relative subpage name (like '/SubPage'),
547 * or can be the empty string to refer to the $basename.
549 * @param string $anchor For links to anchors in page.
551 * @param mixed $basename Page name from which to interpret
552 * relative or other non-fully-specified page names.
554 function WikiPageName($name, $basename=false, $anchor=false) {
555 if (is_string($name)) {
556 $this->shortName = $name;
558 if ($name == '' or $name[0] == SUBPAGE_SEPARATOR) {
560 $name = $this->_pagename($basename) . $name;
562 $name = $this->_normalize_bad_pagename($name);
566 $name = $this->_pagename($name);
567 $this->shortName = $name;
570 $this->name = $this->_check($name);
571 $this->anchor = (string)$anchor;
574 function getParent() {
576 if (!($tail = strrchr($name, SUBPAGE_SEPARATOR)))
578 return substr($name, 0, -strlen($tail));
581 function isValid($strict = false) {
583 return !isset($this->_errors);
584 return (is_string($this->name) and $this->name != '');
587 function getWarnings() {
589 if (isset($this->_warnings))
590 $warnings = array_merge($warnings, $this->_warnings);
591 if (isset($this->_errors))
592 $warnings = array_merge($warnings, $this->_errors);
596 return sprintf(_("'%s': Bad page name: %s"),
597 $this->shortName, join(', ', $warnings));
600 function _pagename($page) {
601 if (isa($page, 'WikiDB_Page'))
602 return $page->getName();
603 elseif (isa($page, 'WikiDB_PageRevision'))
604 return $page->getPageName();
605 elseif (isa($page, 'WikiPageName'))
607 if (!is_string($page)) {
608 trigger_error(sprintf("Non-string pagename '%s' (%s)(%s)",
609 $page, gettype($page), get_class($page)),
612 //assert(is_string($page));
616 function _normalize_bad_pagename($name) {
617 trigger_error("Bad pagename: " . $name, E_USER_WARNING);
619 // Punt... You really shouldn't get here.
622 return $request->getArg('pagename');
624 assert($name[0] == SUBPAGE_SEPARATOR);
625 return substr($name, 1);
629 function _check($pagename) {
630 // Compress internal white-space to single space character.
631 $pagename = preg_replace('/[\s\xa0]+/', ' ', $orig = $pagename);
632 if ($pagename != $orig)
633 $this->_warnings[] = _("White space converted to single space");
635 // Delete any control characters.
636 $pagename = preg_replace('/[\x00-\x1f\x7f\x80-\x9f]/', '', $orig = $pagename);
637 if ($pagename != $orig)
638 $this->_errors[] = _("Control characters not allowed");
640 // Strip leading and trailing white-space.
641 $pagename = trim($pagename);
644 while ($pagename and $pagename[0] == SUBPAGE_SEPARATOR)
645 $pagename = substr($pagename, 1);
646 if ($pagename != $orig)
647 $this->_errors[] = sprintf(_("Leading %s not allowed"), SUBPAGE_SEPARATOR);
649 if (preg_match('/[:;]/', $pagename)) {
650 $this->_warnings[] = _("';' and ':' are deprecated");
651 $pagename = str_replace(':', '', $pagename);
652 $pagename = str_replace(';', '', $pagename);
655 if (strlen($pagename) > MAX_PAGENAME_LENGTH) {
656 $pagename = substr($pagename, 0, MAX_PAGENAME_LENGTH);
657 $this->_errors[] = _("too long");
660 if (strstr($pagename, '..')) {
661 $this->_warnings[] = sprintf(_("illegal .. removed"), $pagename);
662 $pagename = str_replace('..', '', $pagename);
670 * Convert old page markup to new-style markup.
672 * @param string $text Old-style wiki markup.
674 * @param string $markup_type
676 * <dt><code>"block"</code> <dd>Convert all markup.
677 * <dt><code>"inline"</code> <dd>Convert only inline markup.
678 * <dt><code>"links"</code> <dd>Convert only link markup.
681 * @return string New-style wiki markup.
683 * @bugs Footnotes don't work quite as before (esp if there are
684 * multiple references to the same footnote. But close enough,
685 * probably for now....
686 * @bugs Apache2 and IIS crash with OldTextFormattingRules or
687 * AnciennesR%E8glesDeFormatage. (at the 2nd attempt to do the anchored block regex)
688 * It only crashes with CreateToc so far, but other pages (not in pgsrc) are
689 * also known to crash, even with Apache1.
691 function ConvertOldMarkup ($text, $markup_type = "block") {
697 // Trying to detect why the 2nd paragraph of OldTextFormattingRules or
698 // AnciennesR%E8glesDeFormatage crashes.
699 // It only crashes with CreateToc so far, but other pages (not in pgsrc) are
700 // also known to crash, even with Apache1.
702 // I suspect this only to crash with Apache2 and IIS.
703 if (in_array(php_sapi_name(),array('apache2handler','apache2filter','isapi'))
704 and preg_match("/plugin CreateToc/", $text))
706 trigger_error(_("The CreateTocPlugin is not yet old markup compatible! ")
707 ._("Please remove the CreateToc line to be able to reformat this page to old markup. ")
708 ._("Skipped."), E_USER_WARNING);
710 //if (!DEBUG) return $text;
715 /*****************************************************************
716 * Conversions for inline markup:
723 // escape escaped brackets
727 // change ! escapes to ~'s.
728 global $WikiNameRegexp, $request;
729 $bang_esc[] = "(?:" . ALLOWED_PROTOCOLS . "):[^\s<>\[\]\"'()]*[^\s<>\[\]\"'(),.?]";
730 // before 4.3.9 pcre had a memory release bug, which might hit us here. so be safe.
731 if (check_php_version(4,3,9)) {
732 $map = getInterwikiMap();
733 if ($map_regex = $map->getRegexp())
734 $bang_esc[] = $map_regex . ":[^\\s.,;?()]+"; // FIXME: is this really needed?
736 $bang_esc[] = $WikiNameRegexp;
737 $orig[] = '/!((?:' . join(')|(', $bang_esc) . '))/';
740 $subs["links"] = array($orig, $repl);
743 //$orig[] = '/<(?!\?plugin)|(?<!^)</m';
746 // Convert footnote references.
747 $orig[] = '/(?<=.)(?<!~)\[\s*(\d+)\s*\]/m';
748 $repl[] = '#[|ftnt_ref_\\1]<sup>~[[\\1|#ftnt_\\1]~]</sup>';
750 // Convert old style emphases to HTML style emphasis.
751 $orig[] = '/__(.*?)__/';
752 $repl[] = '<strong>\\1</strong>';
753 $orig[] = "/''(.*?)''/";
754 $repl[] = '<em>\\1</em>';
756 // Escape nestled markup.
757 $orig[] = '/^(?<=^|\s)[=_](?=\S)|(?<=\S)[=_*](?=\s|$)/m';
760 // in old markup headings only allowed at beginning of line
764 $subs["inline"] = array($orig, $repl);
766 /*****************************************************************
767 * Patterns which match block markup constructs which take
768 * special handling...
772 $blockpats[] = '[ \t]+\S(?:.*\s*\n[ \t]+\S)*';
774 $blockpats[] = '\|(?:.*\n\|)*';
777 $blockpats[] = '[#*;]*(?:[*#]|;.*?:)';
779 // Footnote definitions
780 $blockpats[] = '\[\s*(\d+)\s*\]';
784 $blockpats[] = '<\?plugin(?:-form)?\b.*\?>\s*$';
788 $blockpats[] = '!{1,3}[^!]';
790 removed .|\n in the anchor not to crash on /m because with /m "." already includes \n
791 this breaks headings but it doesn't crash anymore (crash on non-cgi, non-cli only)
793 $block_re = ( '/\A((?:.|\n)*?)(^(?:'
794 . join("|", $blockpats)
799 if ($markup_type != "block") {
800 list ($orig, $repl) = $subs[$markup_type];
801 return preg_replace($orig, $repl, $text);
804 list ($orig, $repl) = $subs['inline'];
807 // php crashes here in the 2nd paragraph of OldTextFormattingRules,
808 // AnciennesR%E8glesDeFormatage and more
809 // See http://www.pcre.org/pcre.txt LIMITATIONS
810 while (preg_match($block_re, $text, $m)) {
811 $text = substr($text, strlen($m[0]));
812 list (,$leading_text, $block) = $m;
815 if (strchr(" \t", $block[0])) {
818 $suffix = "\n</pre>\n";
820 elseif ($block[0] == '|') {
822 $prefix = "<?plugin OldStyleTable\n";
825 elseif (strchr("#*;", $block[0])) {
826 // Old-style list item
827 preg_match('/^([#*;]*)([*#]|;.*?:) */', $block, $m);
828 list (,$ind,$bullet) = $m;
829 $block = substr($block, strlen($m[0]));
831 $indent = str_repeat(' ', strlen($ind));
832 if ($bullet[0] == ';') {
833 //$term = ltrim(substr($bullet, 1));
834 //return $indent . $term . "\n" . $indent . ' ';
835 $prefix = $ind . $bullet;
838 $prefix = $indent . $bullet . ' ';
840 elseif ($block[0] == '[') {
841 // Footnote definition
842 preg_match('/^\[\s*(\d+)\s*\]/', $block, $m);
844 $block = substr($block, strlen($m[0]));
845 $prefix = "#[|ftnt_${footnum}]~[[${footnum}|#ftnt_ref_${footnum}]~] ";
847 elseif ($block[0] == '<') {
849 // HACK: no inline markup...
853 elseif ($block[0] == '!') {
855 preg_match('/^!{1,3}/', $block, $m);
857 $block = substr($block, strlen($m[0]));
863 if ($leading_text) $leading_text = preg_replace($orig, $repl, $leading_text);
864 if ($block) $block = preg_replace($orig, $repl, $block);
865 $out .= $leading_text;
870 return $out . preg_replace($orig, $repl, $text);
876 * Expand tabs in string.
878 * Converts all tabs to (the appropriate number of) spaces.
881 * @param integer $tab_width
884 function expand_tabs($str, $tab_width = 8) {
885 $split = split("\t", $str);
886 $tail = array_pop($split);
888 foreach ($split as $hunk) {
890 $pos = strlen(strrchr($expanded, "\n")) - 1;
891 $expanded .= str_repeat(" ", ($tab_width - $pos % $tab_width));
893 return substr($expanded, 1) . $tail;
897 * Split WikiWords in page names.
899 * It has been deemed useful to split WikiWords (into "Wiki Words") in
900 * places like page titles. This is rumored to help search engines
903 * @param $page string The page name.
905 * @return string The split name.
907 function SplitPagename ($page) {
909 if (preg_match("/\s/", $page))
910 return $page; // Already split --- don't split any more.
912 // This algorithm is specialized for several languages.
913 // (Thanks to Pierrick MEIGNEN)
914 // Improvements for other languages welcome.
917 // This mess splits between a lower-case letter followed by
918 // either an upper-case or a numeral; except that it wont
919 // split the prefixes 'Mc', 'De', or 'Di' off of their tails.
920 switch ($GLOBALS['LANG']) {
925 $RE[] = '/([[:lower:]])((?<!Mc|De|Di)[[:upper:]]|\d)/';
928 $RE[] = '/([[:lower:]])((?<!Mc|Di)[[:upper:]]|\d)/';
931 $sep = preg_quote(SUBPAGE_SEPARATOR, '/');
932 // This the single-letter words 'I' and 'A' from any following
933 // capitalized words.
934 switch ($GLOBALS['LANG']) {
936 $RE[] = "/(?<= |${sep}|^)([AI])([[:upper:]][[:lower:]])/";
939 $RE[] = "/(?<= |${sep}|^)([À])([[:upper:]][[:lower:]])/";
942 // Split numerals from following letters.
943 $RE[] = '/(\d)([[:alpha:]])/';
944 // Split at subpage seperators. TBD in Theme.php
945 $RE[] = "/([^${sep}]+)(${sep})/";
947 foreach ($RE as $key)
948 $RE[$key] = pcre_fix_posix_classes($key);
951 foreach ($RE as $regexp) {
952 $page = preg_replace($regexp, '\\1 \\2', $page);
957 function NoSuchRevision (&$request, $page, $version) {
958 $html = HTML(HTML::h2(_("Revision Not Found")),
959 HTML::p(fmt("I'm sorry. Version %d of %s is not in the database.",
960 $version, WikiLink($page, 'auto'))));
961 include_once('lib/Template.php');
962 GeneratePage($html, _("Bad Version"), $page->getCurrentRevision());
968 * Get time offset for local time zone.
970 * @param $time time_t Get offset for this time. Default: now.
971 * @param $no_colon boolean Don't put colon between hours and minutes.
972 * @return string Offset as a string in the format +HH:MM.
974 function TimezoneOffset ($time = false, $no_colon = false) {
977 $secs = date('Z', $time);
986 $colon = $no_colon ? '' : ':';
987 $mins = intval(($secs + 30) / 60);
988 return sprintf("%s%02d%s%02d",
989 $sign, $mins / 60, $colon, $mins % 60);
994 * Format time in ISO-8601 format.
996 * @param $time time_t Time. Default: now.
997 * @return string Date and time in ISO-8601 format.
999 function Iso8601DateTime ($time = false) {
1000 if ($time === false)
1002 $tzoff = TimezoneOffset($time);
1003 $date = date('Y-m-d', $time);
1004 $time = date('H:i:s', $time);
1005 return $date . 'T' . $time . $tzoff;
1009 * Format time in RFC-2822 format.
1011 * @param $time time_t Time. Default: now.
1012 * @return string Date and time in RFC-2822 format.
1014 function Rfc2822DateTime ($time = false) {
1015 if ($time === false)
1017 return date('D, j M Y H:i:s ', $time) . TimezoneOffset($time, 'no colon');
1021 * Format time in RFC-1123 format.
1023 * @param $time time_t Time. Default: now.
1024 * @return string Date and time in RFC-1123 format.
1026 function Rfc1123DateTime ($time = false) {
1027 if ($time === false)
1029 return gmdate('D, d M Y H:i:s \G\M\T', $time);
1032 /** Parse date in RFC-1123 format.
1034 * According to RFC 1123 we must accept dates in the following
1037 * Sun, 06 Nov 1994 08:49:37 GMT ; RFC 822, updated by RFC 1123
1038 * Sunday, 06-Nov-94 08:49:37 GMT ; RFC 850, obsoleted by RFC 1036
1039 * Sun Nov 6 08:49:37 1994 ; ANSI C's asctime() format
1041 * (Though we're only allowed to generate dates in the first format.)
1043 function ParseRfc1123DateTime ($timestr) {
1044 $timestr = trim($timestr);
1045 if (preg_match('/^ \w{3},\s* (\d{1,2}) \s* (\w{3}) \s* (\d{4}) \s*'
1046 .'(\d\d):(\d\d):(\d\d) \s* GMT $/ix',
1048 list(, $mday, $mon, $year, $hh, $mm, $ss) = $m;
1050 elseif (preg_match('/^ \w+,\s* (\d{1,2})-(\w{3})-(\d{2}|\d{4}) \s*'
1051 .'(\d\d):(\d\d):(\d\d) \s* GMT $/ix',
1053 list(, $mday, $mon, $year, $hh, $mm, $ss) = $m;
1054 if ($year < 70) $year += 2000;
1055 elseif ($year < 100) $year += 1900;
1057 elseif (preg_match('/^\w+\s* (\w{3}) \s* (\d{1,2}) \s*'
1058 .'(\d\d):(\d\d):(\d\d) \s* (\d{4})$/ix',
1060 list(, $mon, $mday, $hh, $mm, $ss, $year) = $m;
1067 $time = strtotime("$mday $mon $year ${hh}:${mm}:${ss} GMT");
1069 return false; // failed
1074 * Format time to standard 'ctime' format.
1076 * @param $time time_t Time. Default: now.
1077 * @return string Date and time.
1079 function CTime ($time = false)
1081 if ($time === false)
1083 return date("D M j H:i:s Y", $time);
1088 * Format number as kilobytes or bytes.
1089 * Short format is used for PageList
1090 * Long format is used in PageInfo
1092 * @param $bytes int. Default: 0.
1093 * @param $longformat bool. Default: false.
1094 * @return class FormattedText (XmlElement.php).
1096 function ByteFormatter ($bytes = 0, $longformat = false) {
1099 if ($bytes < 1024) {
1101 $size = fmt("%s b", $bytes);
1103 $size = fmt("%s bytes", $bytes);
1106 $kb = round($bytes / 1024, 1);
1108 $size = fmt("%s k", $kb);
1110 $size = fmt("%s Kb (%s bytes)", $kb, $bytes);
1116 * Internationalized printf.
1118 * This is essentially the same as PHP's built-in printf
1119 * with the following exceptions:
1121 * <li> It passes the format string through gettext().
1122 * <li> It supports the argument reordering extensions.
1129 * __printf("Differences between versions %s and %s of %s",
1130 * $new_link, $old_link, $page_link);
1133 * Then in locale/po/de.po, one can reorder the printf arguments:
1136 * msgid "Differences between %s and %s of %s."
1137 * msgstr "Der Unterschiedsergebnis von %3$s, zwischen %1$s und %2$s."
1140 * (Note that while PHP tries to expand $vars within double-quotes,
1141 * the values in msgstr undergo no such expansion, so the '$'s
1144 * One shouldn't use reordered arguments in the default format string.
1145 * Backslashes in the default string would be necessary to escape the
1146 * '$'s, and they'll cause all kinds of trouble....
1148 function __printf ($fmt) {
1149 $args = func_get_args();
1151 echo __vsprintf($fmt, $args);
1155 * Internationalized sprintf.
1157 * This is essentially the same as PHP's built-in printf with the
1158 * following exceptions:
1161 * <li> It passes the format string through gettext().
1162 * <li> It supports the argument reordering extensions.
1167 function __sprintf ($fmt) {
1168 $args = func_get_args();
1170 return __vsprintf($fmt, $args);
1174 * Internationalized vsprintf.
1176 * This is essentially the same as PHP's built-in printf with the
1177 * following exceptions:
1180 * <li> It passes the format string through gettext().
1181 * <li> It supports the argument reordering extensions.
1186 function __vsprintf ($fmt, $args) {
1187 $fmt = gettext($fmt);
1188 // PHP's sprintf doesn't support variable with specifiers,
1189 // like sprintf("%*s", 10, "x"); --- so we won't either.
1191 if (preg_match_all('/(?<!%)%(\d+)\$/x', $fmt, $m)) {
1192 // Format string has '%2$s' style argument reordering.
1193 // PHP doesn't support this.
1194 if (preg_match('/(?<!%)%[- ]?\d*[^- \d$]/x', $fmt))
1195 // literal variable name substitution only to keep locale
1196 // strings uncluttered
1197 trigger_error(sprintf(_("Can't mix '%s' with '%s' type format strings"),
1198 '%1\$s','%s'), E_USER_WARNING); //php+locale error
1200 $fmt = preg_replace('/(?<!%)%\d+\$/x', '%', $fmt);
1203 // Reorder arguments appropriately.
1204 foreach($m[1] as $argnum) {
1205 if ($argnum < 1 || $argnum > count($args))
1206 trigger_error(sprintf(_("%s: argument index out of range"),
1207 $argnum), E_USER_WARNING);
1208 $newargs[] = $args[$argnum - 1];
1213 // Not all PHP's have vsprintf, so...
1214 array_unshift($args, $fmt);
1215 return call_user_func_array('sprintf', $args);
1218 function file_mtime ($filename) {
1219 if ($stat = @stat($filename))
1225 function sort_file_mtime ($a, $b) {
1226 $ma = file_mtime($a);
1227 $mb = file_mtime($b);
1228 if (!$ma or !$mb or $ma == $mb) return 0;
1229 return ($ma > $mb) ? -1 : 1;
1234 * Build an array in $this->_fileList of files from $dirname.
1235 * Subdirectories are not traversed.
1237 * (This was a function LoadDir in lib/loadsave.php)
1238 * See also http://www.php.net/manual/en/function.readdir.php
1240 function getFiles($exclude=false, $sortby=false, $limit=false) {
1241 $list = $this->_fileList;
1244 require_once('lib/PageList.php');
1245 switch (Pagelist::sortby($sortby, 'db')) {
1246 case 'pagename ASC': break;
1247 case 'pagename DESC':
1248 $list = array_reverse($list);
1251 usort($list,'sort_file_mtime');
1254 usort($list,'sort_file_mtime');
1255 $list = array_reverse($list);
1260 return array_splice($list, 0, $limit);
1264 function _filenameSelector($filename) {
1265 if (! $this->_pattern)
1268 return glob_match ($this->_pattern, $filename, $this->_case);
1272 function fileSet($directory, $filepattern = false) {
1273 $this->_fileList = array();
1274 $this->_pattern = $filepattern;
1275 $this->_case = !isWindows();
1276 $this->_pathsep = '/';
1278 if (empty($directory)) {
1279 trigger_error(sprintf(_("%s is empty."), 'directoryname'),
1281 return; // early return
1284 @ $dir_handle = opendir($dir=$directory);
1285 if (empty($dir_handle)) {
1286 trigger_error(sprintf(_("Unable to open directory '%s' for reading"),
1287 $dir), E_USER_NOTICE);
1288 return; // early return
1291 while ($filename = readdir($dir_handle)) {
1292 if ($filename[0] == '.' || filetype($dir . $this->_pathsep . $filename) != 'file')
1294 if ($this->_filenameSelector($filename)) {
1295 array_push($this->_fileList, "$filename");
1296 //trigger_error(sprintf(_("found file %s"), $filename),
1297 // E_USER_NOTICE); //debugging
1300 closedir($dir_handle);
1306 // expands a list containing regex's to its matching entries
1307 class ListRegexExpand {
1308 //var $match, $list, $index, $case_sensitive;
1309 function ListRegexExpand (&$list, $match, $case_sensitive = true) {
1310 $this->match = str_replace('/','\/',$match);
1311 $this->list = &$list;
1312 $this->case_sensitive = $case_sensitive;
1313 //$this->index = false;
1315 function listMatchCallback ($item, $key) {
1316 if (preg_match('/' . $this->match . ($this->case_sensitive ? '/' : '/i'), $item)) {
1317 unset($this->list[$this->index]);
1318 $this->list[] = $item;
1321 function expandRegex ($index, &$pages) {
1322 $this->index = $index;
1323 array_walk($pages, array($this, 'listMatchCallback'));
1328 // convert fileglob to regex style
1329 function glob_to_pcre ($glob) {
1330 $re = preg_replace('/\./', '\\.', $glob);
1331 $re = preg_replace(array('/\*/','/\?/'), array('.*','.'), $glob);
1332 if (!preg_match('/^[\?\*]/',$glob))
1334 if (!preg_match('/[\?\*]$/',$glob))
1339 function glob_match ($glob, $against, $case_sensitive = true) {
1340 return preg_match('/' . glob_to_pcre($glob) . ($case_sensitive ? '/' : '/i'), $against);
1343 function explodeList($input, $allnames, $glob_style = true, $case_sensitive = true) {
1344 $list = explode(',',$input);
1345 // expand wildcards from list of $allnames
1346 if (preg_match('/[\?\*]/',$input)) {
1347 // Optimizing loop invariants:
1348 // http://phplens.com/lens/php-book/optimizing-debugging-php.php
1349 for ($i = 0, $max = sizeof($list); $i < $max; $i++) {
1351 if (preg_match('/[\?\*]/',$f)) {
1353 $expand = new ListRegexExpand($list, $glob_style ? glob_to_pcre($f) : $f, $case_sensitive);
1354 $expand->expandRegex($i, $allnames);
1361 // echo implode(":",explodeList("Test*",array("xx","Test1","Test2")));
1362 function explodePageList($input, $perm=false, $sortby='pagename', $limit=false) {
1363 include_once("lib/PageList.php");
1364 return PageList::explodePageList($input,$perm,$sortby,$limit);
1367 // Class introspections
1370 * Determine whether object is of a specified type.
1371 * In PHP builtin since 4.2.0 as is_a()
1373 * @param $object object An object.
1374 * @param $class string Class name.
1375 * @return bool True iff $object is a $class
1376 * or a sub-type of $class.
1378 function isa ($object, $class) {
1379 $lclass = strtolower($class);
1381 return is_object($object)
1382 && ( strtolower(get_class($object)) == $lclass
1383 || is_subclass_of($object, $lclass) );
1386 /** Determine whether (possible) object has method.
1388 * @param $object mixed Object
1389 * @param $method string Method name
1390 * @return bool True iff $object is an object with has method $method.
1392 function can ($object, $method) {
1393 return is_object($object) && method_exists($object, strtolower($method));
1396 /** Determine whether a function is okay to use.
1398 * Some providers (e.g. Lycos) disable some of PHP functions for
1399 * "security reasons." This makes those functions, of course,
1400 * unusable, despite the fact the function_exists() says they
1403 * This function test to see if a function exists and is not
1404 * disallowed by PHP's disable_functions config setting.
1406 * @param string $function_name Function name
1407 * @return bool True iff function can be used.
1409 function function_usable($function_name) {
1411 if (!is_array($disabled)) {
1412 $disabled = array();
1413 // Use get_cfg_var since ini_get() is one of the disabled functions
1414 // (on Lycos, at least.)
1415 $split = preg_split('/\s*,\s*/', trim(get_cfg_var('disable_functions')));
1416 foreach ($split as $f)
1417 $disabled[strtolower($f)] = true;
1420 return ( function_exists($function_name)
1421 and ! isset($disabled[strtolower($function_name)])
1428 * This is used for generating ETags.
1430 function hash ($x) {
1431 if (is_scalar($x)) {
1434 elseif (is_array($x)) {
1436 return md5(serialize($x));
1438 elseif (is_object($x)) {
1441 trigger_error("Can't hash $x", E_USER_ERROR);
1446 * Seed the random number generator.
1448 * better_srand() ensures the randomizer is seeded only once.
1450 * How random do you want it? See:
1451 * http://www.php.net/manual/en/function.srand.php
1452 * http://www.php.net/manual/en/function.mt-srand.php
1454 function better_srand($seed = '') {
1455 static $wascalled = FALSE;
1457 $seed = $seed === '' ? (double) microtime() * 1000000 : $seed;
1460 //trigger_error("new random seed", E_USER_NOTICE); //debugging
1465 * Recursively count all non-empty elements
1466 * in array of any dimension or mixed - i.e.
1467 * array('1' => 2, '2' => array('1' => 3, '2' => 4))
1468 * See http://www.php.net/manual/en/function.count.php
1470 function count_all($arg) {
1471 // skip if argument is empty
1473 //print_r($arg); //debugging
1475 // not an array, return 1 (base case)
1478 // else call recursively for all elements $arg
1479 foreach($arg as $key => $val)
1480 $count += count_all($val);
1485 function isSubPage($pagename) {
1486 return (strstr($pagename, SUBPAGE_SEPARATOR));
1489 function subPageSlice($pagename, $pos) {
1490 $pages = explode(SUBPAGE_SEPARATOR,$pagename);
1491 $pages = array_slice($pages,$pos,1);
1498 * Class for "popping up" and alert box. (Except that right now, it doesn't
1502 * This is a hackish and needs to be refactored. However it would be nice to
1503 * unify all the different methods we use for showing Alerts and Dialogs.
1504 * (E.g. "Page deleted", login form, ...)
1509 * @param object $request
1510 * @param mixed $head Header ("title") for alert box.
1511 * @param mixed $body The text in the alert box.
1512 * @param hash $buttons An array mapping button labels to URLs.
1513 * The default is a single "Okay" button pointing to $request->getURLtoSelf().
1515 function Alert($head, $body, $buttons=false) {
1516 if ($buttons === false)
1519 $this->_tokens = array('HEADER' => $head, 'CONTENT' => $body);
1520 $this->_buttons = $buttons;
1524 * Show the alert box.
1529 $tokens = $this->_tokens;
1530 $tokens['BUTTONS'] = $this->_getButtons();
1532 $request->discardOutput();
1533 $tmpl = new Template('dialog', $request, $tokens);
1539 function _getButtons() {
1542 $buttons = $this->_buttons;
1544 $buttons = array(_("Okay") => $request->getURLtoSelf());
1547 foreach ($buttons as $label => $url)
1548 print "$label $url\n";
1549 $out[] = $WikiTheme->makeButton($label, $url, 'wikiaction');
1550 return new XmlContent($out);
1555 // 1.3.9-p1 => 1030.091
1556 // 1.3.10pre => 1030.099
1557 function phpwiki_version() {
1558 static $PHPWIKI_VERSION;
1559 if (!isset($PHPWIKI_VERSION)) {
1560 $arr = explode('.',preg_replace('/\D+$/','', PHPWIKI_VERSION)); // remove the pre
1561 $arr[2] = preg_replace('/\.+/','.',preg_replace('/\D/','.',$arr[2]));
1562 $PHPWIKI_VERSION = $arr[0]*1000 + $arr[1]*10 + 0.01*$arr[2];
1563 if (substr(PHPWIKI_VERSION,-3,3) == 'pre')
1564 $PHPWIKI_VERSION -= 0.001;
1566 return $PHPWIKI_VERSION;
1569 function isWikiWord($word) {
1570 global $WikiNameRegexp;
1571 //or preg_match('/\A' . $WikiNameRegexp . '\z/', $word) ??
1572 return preg_match("/^$WikiNameRegexp\$/",$word);
1575 // needed to store serialized objects-values only (perm, pref)
1576 function obj2hash ($obj, $exclude = false, $fields = false) {
1578 if (! $fields ) $fields = get_object_vars($obj);
1579 foreach ($fields as $key => $val) {
1580 if (is_array($exclude)) {
1581 if (in_array($key,$exclude)) continue;
1589 * isUtf8String($string) - cheap utf-8 detection
1591 * segfaults for strings longer than 10kb!
1592 * Use http://www.phpdiscuss.com/article.php?id=565&group=php.i18n or
1593 * checkTitleEncoding() at http://cvs.sourceforge.net/viewcvs.py/wikipedia/phase3/languages/Language.php
1595 function isUtf8String( $s ) {
1596 $ptrASCII = '[\x00-\x7F]';
1597 $ptr2Octet = '[\xC2-\xDF][\x80-\xBF]';
1598 $ptr3Octet = '[\xE0-\xEF][\x80-\xBF]{2}';
1599 $ptr4Octet = '[\xF0-\xF4][\x80-\xBF]{3}';
1600 $ptr5Octet = '[\xF8-\xFB][\x80-\xBF]{4}';
1601 $ptr6Octet = '[\xFC-\xFD][\x80-\xBF]{5}';
1602 return preg_match("/^($ptrASCII|$ptr2Octet|$ptr3Octet|$ptr4Octet|$ptr5Octet|$ptr6Octet)*$/s", $s);
1606 * Check for UTF-8 URLs; Internet Explorer produces these if you
1607 * type non-ASCII chars in the URL bar or follow unescaped links.
1608 * Requires urldecoded pagename.
1609 * Fixes sf.net bug #953949
1611 * src: languages/Language.php:checkTitleEncoding() from mediawiki
1613 function fixTitleEncoding( $s ) {
1618 if (empty($s)) return $s;
1620 $ishigh = preg_match( '/[\x80-\xff]/', $s);
1622 $isutf = ($ishigh ? preg_match( '/^([\x00-\x7f]|[\xc0-\xdf][\x80-\xbf]|' .
1623 '[\xe0-\xef][\x80-\xbf]{2}|[\xf0-\xf7][\x80-\xbf]{3})+$/', $s ) : true );
1625 $isutf = ($ishigh ? isUtf8String($s) : true);
1626 $locharset = strtolower($charset);
1628 if( $locharset != "utf-8" and $ishigh and $isutf )
1629 // if charset == 'iso-8859-1' then simply use utf8_decode()
1630 if ($locharset == 'iso-8859-1')
1631 return utf8_decode( $s );
1633 // TODO: check for iconv support
1634 return iconv( "UTF-8", $charset, $s );
1636 if ($locharset == "utf-8" and $ishigh and !$isutf )
1637 return utf8_encode( $s );
1639 // Other languages can safely leave this function, or replace
1640 // it with one to detect and convert another legacy encoding.
1645 * MySQL fulltext index doesn't grok utf-8, so we
1646 * need to fold cases and convert to hex.
1647 * src: languages/Language.php:stripForSearch() from mediawiki
1650 function stripForSearch( $string ) {
1651 global $wikiLowerChars;
1652 // '/(?:[a-z]|\xc3[\x9f-\xbf]|\xc4[\x81\x83\x85\x87])/' => "a-z\xdf-\xf6\xf8-\xff"
1653 return preg_replace(
1654 "/([\\xc0-\\xff][\\x80-\\xbf]*)/e",
1655 "'U8' . bin2hex( strtr( \"\$1\", \$wikiLowerChars ) )",
1661 * Workaround for allow_url_fopen, to get the content of an external URI.
1662 * It returns the contents in one slurp. Parsers might want to check for allow_url_fopen
1663 * and use fopen, fread chunkwise. (see lib/XmlParser.php)
1665 function url_get_contents( $uri ) {
1666 if (get_cfg_var('allow_url_fopen')) { // was ini_get('allow_url_fopen'))
1667 return @file_get_contents($uri);
1669 require_once("lib/HttpClient.php");
1670 $bits = parse_url($uri);
1671 $host = $bits['host'];
1672 $port = isset($bits['port']) ? $bits['port'] : 80;
1673 $path = isset($bits['path']) ? $bits['path'] : '/';
1674 if (isset($bits['query'])) {
1675 $path .= '?'.$bits['query'];
1677 $client = new HttpClient($host, $port);
1678 $client->use_gzip = false;
1679 if (!$client->get($path)) {
1682 return $client->getContent();
1688 * Generate consecutively named strings:
1689 * Name, Name2, Name3, ...
1691 function GenerateId($name) {
1692 static $ids = array();
1693 if (empty($ids[$name])) {
1698 return $name . $ids[$name];
1702 // from IncludePage. To be of general use.
1703 // content: string or array of strings
1704 function firstNWordsOfContent( $n, $content ) {
1705 if ($content and $n > 0) {
1706 if (is_array($content)) {
1707 // fixme: return a list of lines then?
1708 $content = join("\n", $content);
1709 $return_array = true;
1711 foreach ($content as $line) {
1712 $words = explode(' ', $line);
1713 if ($wordcount + count($words) > $n) {
1714 $new[] = implode(' ', array_slice($words, 0, $n - $wordcount))
1715 . sprintf(_("... (first %s words)"), $n);
1718 $wordcount += count($words);
1724 // fixme: use better whitespace/word seperators
1725 $words = explode(' ', $content);
1726 if (count($words) > $n) {
1727 return join(' ', array_slice($words, 0, $n))
1728 . sprintf(_("... (first %s words)"), $n);
1738 // moved from lib/plugin/IncludePage.php
1739 function extractSection ($section, $content, $page, $quiet = false, $sectionhead = false) {
1740 $qsection = preg_replace('/\s+/', '\s+', preg_quote($section, '/'));
1742 if (preg_match("/ ^(!{1,})\\s*$qsection" // section header
1743 . " \\s*$\\n?" // possible blank lines
1744 . " ( (?: ^.*\\n? )*? )" // some lines
1745 . " (?= ^\\1 | \\Z)/xm", // sec header (same or higher level) (or EOF)
1746 implode("\n", $content),
1748 // Strip trailing blanks lines and ---- <hr>s
1749 $text = preg_replace("/\\s*^-{4,}\\s*$/m", "", $match[2]);
1751 $text = $match[1] . $section ."\n". $text;
1752 return explode("\n", $text);
1755 $mesg = $page ." ". $section;
1758 return array(sprintf(_("<%s: no such section>"), $mesg));
1761 function isExternalReferrer(&$request) {
1762 if ($referrer = $request->get('HTTP_REFERER')) {
1763 $home = SCRIPT_NAME; // was SERVER_URL, but we want to check sister wiki's also
1764 if (substr(strtolower($referrer),0,strlen($home)) == strtolower($home)) return false;
1765 require_once("lib/ExternalReferrer.php");
1766 $se = new SearchEngines();
1767 return $se->parseSearchQuery($referrer);
1773 * useful for PECL overrides: cvsclient, ldap, soap.
1775 function loadPhpExtension($extension) {
1776 if (!extension_loaded($extension)) {
1777 $soname = (isWindows() ? 'php_' : '') . $extension . (isWindows() ? '.dll' : '.so');
1781 return extension_loaded($extension);
1784 function string_starts_with($string, $prefix) {
1785 return (substr($string, 0, strlen($prefix)) == $prefix);
1789 * Ensure that the script will have another $secs time left.
1790 * Works only if safe_mode is off.
1791 * For example not to timeout on waiting socket connections.
1792 * Use the socket timeout as arg.
1794 function longer_timeout($secs = 30) {
1795 $timeout = @ini_get("max_execution_time") ? ini_get("max_execution_time") : 30;
1796 $timeleft = $timeout - $GLOBALS['RUNTIMER']->getTime();
1797 if ($timeleft < $secs)
1798 @set_time_limit(max($timeout,(integer)($secs + $timeleft)));
1801 function printSimpleTrace($bt) {
1803 echo "Traceback:\n";
1804 foreach ($bt as $i => $elem) {
1805 if (!array_key_exists('file', $elem)) {
1808 echo join(" ",array_values($elem)),"\n";
1809 //print " " . $elem['file'] . ':' . $elem['line'] . " " .$elem['function']"\n";
1813 // $Log: not supported by cvs2svn $
1814 // Revision 1.216 2004/11/11 18:31:26 rurban
1815 // add simple backtrace on such general failures to get at least an idea where
1817 // Revision 1.215 2004/11/11 14:34:12 rurban
1818 // minor clarifications
1820 // Revision 1.214 2004/11/11 11:01:20 rurban
1821 // fix loadPhpExtension
1823 // Revision 1.213 2004/11/01 10:43:57 rurban
1824 // seperate PassUser methods into seperate dir (memory usage)
1825 // fix WikiUser (old) overlarge data session
1826 // remove wikidb arg from various page class methods, use global ->_dbi instead
1829 // Revision 1.212 2004/10/22 09:15:39 rurban
1830 // Alert::show has no arg anymore
1832 // Revision 1.211 2004/10/22 09:05:11 rurban
1833 // added longer_timeout (HttpClient)
1836 // Revision 1.210 2004/10/14 21:06:02 rurban
1837 // fix dumphtml with USE_PATH_INFO (again). fix some PageList refs
1839 // Revision 1.209 2004/10/14 19:19:34 rurban
1840 // loadsave: check if the dumped file will be accessible from outside.
1841 // and some other minor fixes. (cvsclient native not yet ready)
1843 // Revision 1.208 2004/10/12 13:13:20 rurban
1844 // php5 compatibility (5.0.1 ok)
1846 // Revision 1.207 2004/09/26 12:21:40 rurban
1847 // removed old log entries.
1848 // added persistent start_debug on internal links and DEBUG
1849 // added isExternalReferrer (not yet used)
1851 // Revision 1.206 2004/09/25 16:28:36 rurban
1852 // added to TOC, firstNWordsOfContent is now plugin compatible, added extractSection
1854 // Revision 1.205 2004/09/23 13:59:35 rurban
1855 // Before removing a page display a sample of 100 words.
1857 // Revision 1.204 2004/09/17 13:19:15 rurban
1858 // fix LinkPhpwikiURL bug reported in http://phpwiki.sourceforge.net/phpwiki/KnownBugs
1861 // Revision 1.203 2004/09/16 08:00:52 rurban
1862 // just some comments
1864 // Revision 1.202 2004/09/14 10:11:44 rurban
1865 // start 2nd Id with ...Plugin2
1867 // Revision 1.201 2004/09/14 10:06:42 rurban
1868 // generate iterated plugin ids, set plugin span id also
1870 // Revision 1.200 2004/08/05 17:34:26 rurban
1871 // move require to sortby branch
1873 // Revision 1.199 2004/08/05 10:38:15 rurban
1874 // fix Bug #993692: Making Snapshots or Backups doesn't work anymore
1877 // Revision 1.198 2004/07/02 10:30:36 rurban
1878 // always disable getimagesize for < php-4.3 with external png's
1880 // Revision 1.197 2004/07/02 09:55:58 rurban
1881 // more stability fixes: new DISABLE_GETIMAGESIZE if your php crashes when loading LinkIcons: failing getimagesize in old phps; blockparser stabilized
1883 // Revision 1.196 2004/07/01 08:51:22 rurban
1884 // dumphtml: added exclude, print pagename before processing
1886 // Revision 1.195 2004/06/29 08:52:22 rurban
1887 // Use ...version() $need_content argument in WikiDB also:
1888 // To reduce the memory footprint for larger sets of pagelists,
1889 // we don't cache the content (only true or false) and
1890 // we purge the pagedata (_cached_html) also.
1891 // _cached_html is only cached for the current pagename.
1892 // => Vastly improved page existance check, ACL check, ...
1894 // Now only PagedList info=content or size needs the whole content, esp. if sortable.
1896 // Revision 1.194 2004/06/29 06:48:04 rurban
1897 // Improve LDAP auth and GROUP_LDAP membership:
1898 // no error message on false password,
1899 // added two new config vars: LDAP_OU_USERS and LDAP_OU_GROUP with GROUP_METHOD=LDAP
1900 // fixed two group queries (this -> user)
1901 // stdlib: ConvertOldMarkup still flawed
1903 // Revision 1.193 2004/06/28 13:27:03 rurban
1904 // CreateToc disabled for old markup and Apache2 only
1906 // Revision 1.192 2004/06/28 12:47:43 rurban
1907 // skip if non-DEBUG and old markup with CreateToc
1909 // Revision 1.191 2004/06/25 14:31:56 rurban
1910 // avoid debug_skip warning
1912 // Revision 1.190 2004/06/25 14:29:20 rurban
1913 // WikiGroup refactoring:
1914 // global group attached to user, code for not_current user.
1915 // improved helpers for special groups (avoid double invocations)
1916 // new experimental config option ENABLE_XHTML_XML (fails with IE, and document.write())
1917 // fixed a XHTML validation error on userprefs.tmpl
1919 // Revision 1.189 2004/06/20 09:45:35 rurban
1920 // php5 isa fix (wrong strtolower)
1922 // Revision 1.188 2004/06/16 10:38:58 rurban
1923 // Disallow refernces in calls if the declaration is a reference
1924 // ("allow_call_time_pass_reference clean").
1925 // PhpWiki is now allow_call_time_pass_reference = Off clean,
1926 // but several external libraries may not.
1927 // In detail these libs look to be affected (not tested):
1931 // Revision 1.187 2004/06/14 11:31:37 rurban
1932 // renamed global $Theme to $WikiTheme (gforge nameclash)
1933 // inherit PageList default options from PageList
1934 // default sortby=pagename
1935 // use options in PageList_Selectable (limit, sortby, ...)
1936 // added action revert, with button at action=diff
1937 // added option regex to WikiAdminSearchReplace
1939 // Revision 1.186 2004/06/13 13:54:25 rurban
1940 // Catch fatals on the four dump calls (as file and zip, as html and mimified)
1941 // FoafViewer: Check against external requirements, instead of fatal.
1942 // Change output for xhtmldumps: using file:// urls to the local fs.
1943 // Catch SOAP fatal by checking for GOOGLE_LICENSE_KEY
1944 // Import GOOGLE_LICENSE_KEY and FORTUNE_DIR from config.ini.
1946 // Revision 1.185 2004/06/11 09:07:30 rurban
1947 // support theme-specific LinkIconAttr: front or after or none
1949 // Revision 1.184 2004/06/04 20:32:53 rurban
1950 // Several locale related improvements suggested by Pierrick Meignen
1951 // LDAP fix by John Cole
1952 // reanable admin check without ENABLE_PAGEPERM in the admin plugins
1954 // Revision 1.183 2004/06/01 10:22:56 rurban
1955 // added url_get_contents() used in XmlParser and elsewhere
1957 // Revision 1.182 2004/05/25 12:40:48 rurban
1958 // trim the pagename
1960 // Revision 1.181 2004/05/25 10:18:44 rurban
1961 // Check for UTF-8 URLs; Internet Explorer produces these if you
1962 // type non-ASCII chars in the URL bar or follow unescaped links.
1963 // Fixes sf.net bug #953949
1964 // src: languages/Language.php:checkTitleEncoding() from mediawiki
1966 // Revision 1.180 2004/05/18 16:23:39 rurban
1967 // rename split_pagename to SplitPagename
1969 // Revision 1.179 2004/05/18 16:18:37 rurban
1970 // AutoSplit at subpage seperators
1971 // RssFeed stability fix for empty feeds or broken connections
1973 // Revision 1.178 2004/05/12 10:49:55 rurban
1974 // require_once fix for those libs which are loaded before FileFinder and
1975 // its automatic include_path fix, and where require_once doesn't grok
1976 // dirname(__FILE__) != './lib'
1977 // upgrade fix with PearDB
1978 // navbar.tmpl: remove spaces for IE button alignment
1980 // Revision 1.177 2004/05/08 14:06:12 rurban
1981 // new support for inlined image attributes: [image.jpg size=50x30 align=right]
1982 // minor stability and portability fixes
1984 // Revision 1.176 2004/05/08 11:25:15 rurban
1987 // Revision 1.175 2004/05/06 17:30:38 rurban
1988 // CategoryGroup: oops, dos2unix eol
1989 // improved phpwiki_version:
1990 // pre -= .0001 (1.3.10pre: 1030.099)
1991 // -p1 += .001 (1.3.9-p1: 1030.091)
1992 // improved InstallTable for mysql and generic SQL versions and all newer tables so far.
1993 // abstracted more ADODB/PearDB methods for action=upgrade stuff:
1994 // backend->backendType(), backend->database(),
1995 // backend->listOfFields(),
1996 // backend->listOfTables(),
1998 // Revision 1.174 2004/05/06 12:02:05 rurban
1999 // fix sf.net bug#949002: [ Link | ] assertion
2001 // Revision 1.173 2004/05/03 15:00:31 rurban
2002 // added more database upgrading: session.sess_ip, page.id autp_increment
2004 // Revision 1.172 2004/04/26 20:44:34 rurban
2005 // locking table specific for better databases
2007 // Revision 1.171 2004/04/19 23:13:03 zorloc
2008 // Connect the rest of PhpWiki to the IniConfig system. Also the keyword regular expression is not a config setting
2010 // Revision 1.170 2004/04/19 18:27:45 rurban
2011 // Prevent from some PHP5 warnings (ref args, no :: object init)
2012 // php5 runs now through, just one wrong XmlElement object init missing
2013 // Removed unneccesary UpgradeUser lines
2014 // Changed WikiLink to omit version if current (RecentChanges)
2016 // Revision 1.169 2004/04/15 21:29:48 rurban
2017 // allow [0] with new markup: link to page "0"
2019 // Revision 1.168 2004/04/10 02:30:49 rurban
2020 // Fixed gettext problem with VIRTUAL_PATH scripts (Windows only probably)
2021 // Fixed "cannot setlocale..." (sf.net problem)
2023 // Revision 1.167 2004/04/02 15:06:55 rurban
2024 // fixed a nasty ADODB_mysql session update bug
2025 // improved UserPreferences layout (tabled hints)
2026 // fixed UserPreferences auth handling
2027 // improved auth stability
2028 // improved old cookie handling: fixed deletion of old cookies with paths
2030 // Revision 1.166 2004/04/01 15:57:10 rurban
2031 // simplified Sidebar theme: table, not absolute css positioning
2032 // added the new box methods.
2033 // remaining problems: large left margin, how to override _autosplitWikiWords in Template only
2035 // Revision 1.165 2004/03/24 19:39:03 rurban
2036 // php5 workaround code (plus some interim debugging code in XmlElement)
2037 // php5 doesn't work yet with the current XmlElement class constructors,
2038 // WikiUserNew does work better than php4.
2039 // rewrote WikiUserNew user upgrading to ease php5 update
2040 // fixed pref handling in WikiUserNew
2041 // added Email Notification
2042 // added simple Email verification
2043 // removed emailVerify userpref subclass: just a email property
2044 // changed pref binary storage layout: numarray => hash of non default values
2045 // print optimize message only if really done.
2046 // forced new cookie policy: delete pref cookies, use only WIKI_ID as plain string.
2047 // prefs should be stored in db or homepage, besides the current session.
2049 // Revision 1.164 2004/03/18 21:41:09 rurban
2050 // fixed sqlite support
2051 // WikiUserNew: PHP5 fixes: don't assign $this (untested)
2053 // Revision 1.163 2004/03/17 18:41:49 rurban
2054 // just reformatting
2056 // Revision 1.162 2004/03/16 15:43:08 rurban
2057 // make fileSet sortable to please PageList
2059 // Revision 1.161 2004/03/12 15:48:07 rurban
2060 // fixed explodePageList: wrong sortby argument order in UnfoldSubpages
2061 // simplified lib/stdlib.php:explodePageList
2063 // Revision 1.160 2004/02/28 21:14:08 rurban
2064 // generally more PHPDOC docs
2065 // see http://xarch.tu-graz.ac.at/home/rurban/phpwiki/xref/
2066 // fxied WikiUserNew pref handling: empty theme not stored, save only
2067 // changed prefs, sql prefs improved, fixed password update,
2068 // removed REPLACE sql (dangerous)
2069 // moved gettext init after the locale was guessed
2070 // + some minor changes
2073 // (c-file-style: "gnu")
2077 // c-basic-offset: 4
2078 // c-hanging-comment-ender-p: nil
2079 // indent-tabs-mode: nil