1 <?php // rcs_id('$Id$');
3 * Copyright 1999-2008 $ThePhpWikiProgrammingTeam
4 * Copyright 2008-2009 Marc-Etienne Vargenau, Alcatel-Lucent
6 * This file is part of PhpWiki.
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.
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.
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
24 Standard functions for Wiki functionality
25 WikiURL ($pagename, $args, $get_abs_url)
27 IconForLink ($protocol_or_url)
28 PossiblyGlueIconToText($proto_or_url, $text)
30 LinkURL ($url, $linktext)
31 LinkImage ($url, $alt)
32 ImgObject ($img, $url)
34 SplitQueryArgs ($query_args)
35 LinkPhpwikiURL ($url, $text, $basepage)
36 ConvertOldMarkup ($content, $markup_type = "block")
37 MangleXmlIdentifier($str)
38 UnMangleXmlIdentifier($str)
40 class Stack { push($item), pop(), cnt(), top() }
41 class Alert { show() }
42 class WikiPageName {getParent(),isValid(),getWarnings() }
44 expand_tabs($str, $tab_width = 8)
46 NoSuchRevision ($request, $page, $version)
47 TimezoneOffset ($time, $no_colon)
48 Iso8601DateTime ($time)
49 Rfc2822DateTime ($time)
50 ParseRfc1123DateTime ($timestr)
52 ByteFormatter ($bytes = 0, $longformat = false)
55 __vsprintf ($fmt, $args)
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) }
65 glob_match ($glob, $against, $case_sensitive = true)
66 explodeList ($input, $allnames, $glob_style = true, $case_sensitive = true)
67 explodePageList ($input, $perm = false)
69 can ($object, $method)
70 function_usable ($function_name)
72 better_srand ($seed = '')
75 subPageSlice ($pagename, $pos)
76 isActionPage ($filename)
80 obj2hash ($obj, $exclude = false, $fields = false)
83 url_get_contents ($uri)
85 firstNWordsOfContent ($n, $content)
86 extractSection ($section, $content, $page, $quiet = false, $sectionhead = false)
89 charset_convert($from, $to, $data)
90 string_starts_with($string, $prefix)
91 string_ends_with($string, $suffix)
92 array_remove($arr,$value)
93 longer_timeout($secs=30)
96 binary_search($needle, $haystack)
98 javascript_quote_string($s)
100 parse_attributes($line)
103 compute_tablecell ($table, $i, $j, $imax, $jmax)
105 function: LinkInterWikiLink($link, $linktext)
106 moved to: lib/interwiki.php
107 function: linkExistingWikiWord($wikiword, $linktext, $version)
108 moved to: lib/WikiTheme.php
109 function: LinkUnknownWikiWord($wikiword, $linktext)
110 moved to: lib/WikiTheme.php
111 function: UpdateRecentChanges($dbi, $pagename, $isnewpage)
112 gone see: lib/plugin/RecentChanges.php
114 if (defined('_PHPWIKI_STDLIB_LOADED')) return;
115 else define('_PHPWIKI_STDLIB_LOADED', true);
117 define('MAX_PAGENAME_LENGTH', 100);
120 * Convert string to a valid XML identifier.
122 * XML 1.0 identifiers are of the form: [A-Za-z][A-Za-z0-9:_.-]*
124 * We would like to have, e.g. named anchors within wiki pages
125 * names like "Table of Contents" --- clearly not a valid XML
126 * fragment identifier.
128 * This function implements a one-to-one map from {any string}
129 * to {valid XML identifiers}.
132 * converting all bytes not in [A-Za-z0-9:_-],
133 * and any leading byte not in [A-Za-z] to 'xbb.',
134 * where 'bb' is the hexadecimal representation of the
137 * As a special case, the empty string is converted to 'empty.'
142 function MangleXmlIdentifier($str) {
146 return preg_replace('/[^-_:A-Za-z0-9]|(?<=^)[^A-Za-z]/e',
147 "'x' . sprintf('%02x', ord('\\0')) . '.'",
151 function UnMangleXmlIdentifier($str) {
152 if ($str == 'empty.')
154 return preg_replace('/x(\w\w)\./e',
155 "sprintf('%c', hex('\\0'))",
160 * Returns a name for the WIKI_ID cookie that should be unique on the host.
161 * But for it to be unique you must have set a unique WIKI_NAME in your
162 * configuration file.
163 * @return string The name of the WIKI_ID cookie to use for this wiki.
165 function GetCookieName() {
166 return preg_replace("/[^\d\w]/", "_", WIKI_NAME) . "_WIKI_ID";
170 * Generates a valid URL for a given Wiki pagename.
171 * @param mixed $pagename If a string this will be the name of the Wiki page to link to.
172 * If a WikiDB_Page object function will extract the name to link to.
173 * If a WikiDB_PageRevision object function will extract the name to link to.
175 * @param boolean $get_abs_url Default value is false.
176 * @return string The absolute URL to the page passed as $pagename.
178 function WikiURL($pagename, $args = '', $get_abs_url = false) {
179 global $request, $WikiTheme;
182 if (is_object($pagename)) {
183 if (isa($pagename, 'WikiDB_Page')) {
184 $pagename = $pagename->getName();
186 elseif (isa($pagename, 'WikiDB_PageRevision')) {
187 $page = $pagename->getPage();
188 $args['version'] = $pagename->getVersion();
189 $pagename = $page->getName();
191 elseif (isa($pagename, 'WikiPageName')) {
192 $anchor = $pagename->anchor;
193 $pagename = $pagename->name;
195 $anchor = $pagename->anchor;
196 $pagename = $pagename->name;
199 if (!$get_abs_url and DEBUG and $request->getArg('start_debug')) {
201 $args = 'start_debug=' . $request->getArg('start_debug');
202 elseif (is_array($args))
203 $args['start_debug'] = $request->getArg('start_debug');
205 $args .= '&start_debug=' . $request->getArg('start_debug');
207 if (is_array($args)) {
209 foreach ($args as $key => $val) {
210 // avoid default args
211 if (USE_PATH_INFO and $key == 'pagename')
213 elseif ($key == 'action' and $val == 'browse')
215 elseif (!is_array($val)) // ugly hack for getURLtoSelf() which also takes POST vars
216 $enc_args[] = urlencode($key) . '=' . urlencode($val);
218 $args = join('&', $enc_args);
221 if (USE_PATH_INFO or !empty($WikiTheme->HTML_DUMP_SUFFIX)) {
222 $url = $get_abs_url ? (SERVER_URL . VIRTUAL_PATH . "/") : "";
223 $base = preg_replace('/%2f/i', '/', rawurlencode($pagename));
225 if (!empty($WikiTheme->HTML_DUMP_SUFFIX)) {
226 if (!empty($WikiTheme->VALID_LINKS) and $request->getArg('action') == 'pdf') {
227 if (!in_array($pagename, $WikiTheme->VALID_LINKS))
230 $url = $base . $WikiTheme->HTML_DUMP_SUFFIX;
232 $url .= $WikiTheme->HTML_DUMP_SUFFIX;
242 $url = $get_abs_url ? SERVER_URL . SCRIPT_NAME : basename(SCRIPT_NAME);
243 $url .= "?pagename=" . rawurlencode($pagename);
248 $url .= "#" . MangleXmlIdentifier($anchor);
252 /** Convert relative URL to absolute URL.
254 * This converts a relative URL to one of PhpWiki's support files
255 * to an absolute one.
258 * @return string Absolute URL
260 function AbsoluteURL ($url) {
261 if (preg_match('/^https?:/', $url))
263 if ($url[0] != '/') {
264 $base = USE_PATH_INFO ? VIRTUAL_PATH : dirname(SCRIPT_NAME);
265 while ($base != '/' and substr($url, 0, 3) == "../") {
266 $url = substr($url, 3);
267 $base = dirname($base);
273 return SERVER_URL . $url;
276 function DataURL ($url) {
277 if (preg_match('/^https?:/', $url))
279 $url = NormalizeWebFileName($url);
280 if (DEBUG and $GLOBALS['request']->getArg('start_debug') and substr($url,-4,4) == '.php')
281 $url .= "?start_debug=1"; // XMLRPC and SOAP debugging helper.
282 return AbsoluteURL($url);
286 * Generates icon in front of links.
288 * @param string $protocol_or_url URL or protocol to determine which icon to use.
290 * @return HtmlElement HtmlElement object that contains data to create img link to
291 * icon for use with url or protocol passed to the function. False if no img to be
294 function IconForLink($protocol_or_url) {
296 if (0 and $filename_suffix == false) {
297 // display apache style icon for file type instead of protocol icon
298 // - archive: unix:gz,bz2,tgz,tar,z; mac:dmg,dmgz,bin,img,cpt,sit; pc:zip;
299 // - document: html, htm, text, txt, rtf, pdf, doc
300 // - non-inlined image: jpg,jpeg,png,gif,tiff,tif,swf,pict,psd,eps,ps
301 // - audio: mp3,mp2,aiff,aif,au
302 // - multimedia: mpeg,mpg,mov,qt
304 list ($proto) = explode(':', $protocol_or_url, 2);
305 $src = $WikiTheme->getLinkIconURL($proto);
307 return HTML::img(array('src' => $src, 'alt' => "", 'class' => 'linkicon', 'border' => 0));
314 * Glue icon in front of or after text.
315 * Pref: 'noLinkIcons' - ignore icon if set
316 * WikiTheme: 'LinkIcons' - 'yes' at front
317 * - 'no' display no icon
318 * - 'front' display at left
319 * - 'after' display at right
321 * @param string $protocol_or_url Protocol or URL. Used to determine the
323 * @param string $text The text.
324 * @return XmlContent.
326 function PossiblyGlueIconToText($proto_or_url, $text) {
327 global $request, $WikiTheme;
328 if ($request->getPref('noLinkIcons'))
330 $icon = IconForLink($proto_or_url);
333 if ($where = $WikiTheme->getLinkIconAttr()) {
334 if ($where == 'no') return $text;
335 if ($where != 'after') $where = 'front';
339 if ($where == 'after') {
340 // span the icon only to the last word (tie them together),
341 // to let the previous words wrap on line breaks.
342 if (!is_object($text)) {
343 preg_match('/^(\s*\S*)(\s*)$/', $text, $m);
344 list (, $prefix, $last_word) = $m;
350 $text = HTML::span(array('style' => 'white-space: nowrap'),
351 $last_word, HTML::Raw(' '), $icon);
353 $text = HTML($prefix, $text);
356 // span the icon only to the first word (tie them together),
357 // to let the next words wrap on line breaks
358 if (!is_object($text)) {
359 preg_match('/^\s*(\S*)(.*?)\s*$/', $text, $m);
360 list (, $first_word, $tail) = $m;
366 $text = HTML::span(array('style' => 'white-space: nowrap'),
369 $text = HTML($text, $tail);
374 * Determines if the url passed to function is safe, by detecting if the characters
375 * '<', '>', or '"' are present.
376 * Check against their urlencoded values also.
378 * @param string $url URL to check for unsafe characters.
379 * @return boolean True if same, false else.
381 function IsSafeURL($url) {
382 return !preg_match('/([<>"])|(%3C)|(%3E)|(%22)/', $url);
386 * Generates an HtmlElement object to store data for a link.
388 * @param string $url URL that the link will point to.
389 * @param string $linktext Text to be displayed as link.
390 * @return HtmlElement HtmlElement object that contains data to construct an html link.
392 function LinkURL($url, $linktext = '') {
393 // FIXME: Is this needed (or sufficient?)
394 if(! IsSafeURL($url)) {
395 $link = HTML::span(array('class' => 'error'), _("BAD URL -- remove all of <, >, \""));
400 $linktext = preg_replace("/mailto:/A", "", $url);
401 $args = array('href' => $url);
402 if ( defined('EXTERNAL_LINK_TARGET') ) // can also be set in the css
403 $args['target'] = (is_string(EXTERNAL_LINK_TARGET) and (EXTERNAL_LINK_TARGET != "")) ? EXTERNAL_LINK_TARGET : "_blank";
404 $link = HTML::a($args, PossiblyGlueIconToText($url, $linktext));
406 $link->setAttr('class', $linktext ? 'namedurl' : 'rawurl');
413 * Syntax: [image.png size=50% border=n align= hspace= vspace= width= height=]
414 * Disallows sizes which are too small.
415 * Spammers may use such (typically invisible) image attributes to raise their GoogleRank.
417 * Handle embeddable objects, like svg, class, vrml, swf, svgz, pdf, avi, wmv especially.
419 function LinkImage($url, $alt = "") {
420 $force_img = "png|jpg|gif|jpeg|bmp|pl|cgi";
421 // Disallow tags in img src urls. Typical CSS attacks.
422 // FIXME: Is this needed (or sufficient?)
423 // FIXED: This was broken for moniker:TP30 test/image.png => url="moniker:TP30" attr="test/image.png"
425 // support new syntax: [prefix/image.jpg size=50% border=n]
426 if (empty($alt)) $alt = "";
429 $arr = explode(' ',$url);
430 if (!empty($arr)) $url = $arr[0];
431 if (! IsSafeURL($url)) {
432 $link = HTML::span(array('class' => 'error'), _("BAD URL -- remove all of <, >, \""));
435 // spaces in inline images must be %20 encoded!
436 $link = HTML::img(array('src' => $url));
438 // Extract attributes
439 $arr = parse_attributes(strstr($ori_url, " "));
440 foreach ($arr as $attr => $value) {
441 // These attributes take strings: lang, id, title, alt
442 if (($attr == "lang")
444 || ($attr == "title")
445 || ($attr == "alt")) {
446 $link->setAttr($attr, $value);
448 // align = bottom|middle|top|left|right
449 elseif (($attr == "align")
450 && (($value == "bottom")
451 || ($value == "middle")
453 || ($value == "left")
454 || ($value == "right"))) {
455 $link->setAttr($attr, $value);
457 // These attributes take a number (pixels): border, hspace, vspace
458 elseif ((($attr == "border") || ($attr == "hspace") || ($attr == "vspace"))
459 && (is_numeric($value))) {
460 $link->setAttr($attr, (int)$value);
462 // These attributes take a number (pixels) or a percentage: height, width
463 elseif ((($attr == "height") || ($attr == "width"))
464 && (preg_match('/\d+[%p]?x?/', $value))) {
465 $link->setAttr($attr, $value);
467 // We allow size=50% and size=20x30
468 // We replace this with "width" and "height" HTML attributes
469 elseif ($attr == "size") {
470 if (preg_match('/(\d+%)/', $value, $m)) {
471 $link->setAttr('width',$m[1]);
472 $link->setAttr('height',$m[1]);
473 } elseif (preg_match('/(\d+)x(\d+)/', $value, $m)) {
474 $link->setAttr('width',$m[1]);
475 $link->setAttr('height',$m[2]);
479 $link = HTML::span(array('class' => 'error'),
480 sprintf(_("Invalid image attribute \"%s\" %s=%s"),
481 $url, $attr, $value));
485 // Correct silently the most common error
486 if ($url != $ori_url and empty($arr) and !preg_match("/^http/",$url)) {
487 // space belongs to the path
488 $file = NormalizeLocalFileName($ori_url);
489 if (file_exists($file)) {
490 $link = HTML::img(array('src' => $ori_url));
492 sprintf(_("Invalid image link fixed %s => %s. Spaces must be quoted with %%20."),
493 $url, $ori_url), E_USER_WARNING);
494 } elseif (string_starts_with($ori_url, getUploadDataPath())) {
495 $file = substr($file, strlen(getUploadDataPath()));
496 $path = getUploadFilePath().$file;
497 if (file_exists($path)) {
498 trigger_error(sprintf(_("Invalid image link fixed \"%s\" => \"%s\".\n Spaces must be quoted with %%20."),
499 $url, $ori_url), E_USER_WARNING);
500 $link->setAttr('src', getUploadDataPath() . $file);
505 if (!$link->getAttr('alt')) {
506 $link->setAttr('alt', $alt);
508 // Check width and height as spam countermeasure
509 if (($width = $link->getAttr('width')) and ($height = $link->getAttr('height'))) {
510 //$width = (int) $width; // px or % or other suffix
511 //$height = (int) $height;
512 if (($width < 3 and $height < 10) or
513 ($height < 3 and $width < 20) or
514 ($height < 7 and $width < 7))
516 $link = HTML::span(array('class' => 'error'),
517 _("Invalid image size"));
522 // Prepare for getimagesize($url)
523 // $url only valid for external urls, otherwise local path
524 // Older php versions crash here with certain png's:
525 // confirmed for 4.1.2, 4.1.3, 4.2.3; 4.3.2 and 4.3.7 are ok
526 // http://phpwiki.sourceforge.net/demo/themes/default/images/http.png
527 // See http://bugs.php.net/search.php?cmd=display&search_for=getimagesize
528 if (DISABLE_GETIMAGESIZE)
530 elseif (! preg_match("/\.$force_img$/i", $url))
531 ; // only valid image extensions or scripts assumed to generate images
532 elseif (!check_php_version(4,3) and preg_match("/^http.+\.png$/i",$url))
533 ; // it's safe to assume that this will fail.
534 elseif (preg_match("/^http/",$url)) { // external url
535 $size = @getimagesize($url);
536 } else { // local file
537 if (file_exists($file = NormalizeLocalFileName($url))) { // here
538 $size = @getimagesize($file);
539 } elseif (file_exists(NormalizeLocalFileName(urldecode($url)))) {
540 $size = @getimagesize($file);
541 $link->setAttr('src', rawurldecode($url));
542 } elseif (string_starts_with($url, getUploadDataPath())) { // there
543 $file = substr($file, strlen(getUploadDataPath()));
544 $path = getUploadFilePath().rawurldecode($file);
545 $size = @getimagesize($path);
546 $link->setAttr('src', getUploadDataPath() . rawurldecode($file));
547 } else { // elsewhere
548 $size = @getimagesize($request->get('DOCUMENT_ROOT').urldecode($url));
554 if (($width < 3 and $height < 10)
555 or ($height < 3 and $width < 20)
556 or ($height < 7 and $width < 7))
558 $link = HTML::span(array('class' => 'error'),
559 _("Invalid image size"));
564 $link->setAttr('class', 'inlineimage');
566 /* Check for inlined objects. Everything allowed in INLINE_IMAGES besides
567 * png|jpg|gif|jpeg|bmp|pl|cgi. If no image it is an object to embed.
568 * Note: Allow cgi's (pl,cgi) returning images.
570 if (!preg_match("/\.(".$force_img.")/i", $url)) {
571 // HTML::img(array('src' => $url, 'alt' => $alt, 'title' => $alt));
572 // => HTML::object(array('src' => $url)) ...;
573 return ImgObject($link, $ori_url);
579 * <object> / <embed> tags instead of <img> for all non-image extensions
581 * Called by LinkImage(), not directly.
582 * Syntax: [image.svg size=50% alt=image.gif border=n align= hspace= vspace= width= height=]
583 * Samples: [Upload:song.mp3 type=audio/mpeg width=200 height=10]
584 * $alt may be an alternate img
585 * TODO: Need to unify with WikiPluginCached::embedObject()
587 * Note that Safari 1.0 will crash with <object>, so use only <embed>
588 * http://www.alleged.org.uk/pdc/2002/svg-object.html
590 * Allowed object tags:
591 * DATA=URI (object data)
592 * CLASSID=URI (location of implementation)
593 * ARCHIVE=CDATA (archive files)
594 * CODEBASE=URI (base URI for CLASSID, DATA, ARCHIVE)
595 * WIDTH=Length (object width)
596 * HEIGHT=Length (object height)
597 * NAME=CDATA (name for form submission)
598 * USEMAP=URI (client-side image map)
599 * TYPE=ContentType (content-type of object)
600 * CODETYPE=ContentType (content-type of code)
601 * STANDBY=Text (message to show while loading)
602 * TABINDEX=NUMBER (position in tabbing order)
603 * DECLARE (do not instantiate object)
604 * The rest is added as <param name="" value="" /> tags
606 function ImgObject($img, $url) {
607 // get the url args: data="sample.svgz" type="image/svg+xml" width="400" height="300"
608 $params = explode(",","data,classid,archive,codebase,name,usemap,type,".
609 "codetype,standby,tabindex,declare");
610 if (is_array($url)) {
613 foreach ($args as $attr => $value) {
614 foreach ($params as $param) {
615 if ($param == $attr) {
616 $img->setAttr($param, $value);
617 if (isset($found[$param])) $found[$param]++;
618 else $found[$param] = 1;
623 // now all remaining args are added as <param> to the object
625 foreach ($args as $attr => $value) {
626 if (!isset($found[$attr])) {
627 $params[] = HTML::param(array('name' => $attr,
631 $url = $img->getAttr('src');
632 $force_img = "png|jpg|gif|jpeg|bmp";
633 if (!preg_match("/\.(".$force_img.")/i", $url)) {
634 $img->setAttr('src', false);
637 $args = explode(' ', $url);
638 if (count($args) >= 1) {
639 $url = array_shift($args);
641 foreach ($args as $attr) {
642 foreach ($params as $param) {
643 if (preg_match("/^$param=(\S+)$/i",$attr,$m)) {
644 $img->setAttr($param, $m[1]);
645 if (isset($found[$param])) $found[$param]++;
646 else $found[$param] = 1;
651 // now all remaining args are added as <param> to the object
653 foreach ($args as $attr) {
654 if (!isset($found[$attr]) and preg_match("/^(\S+)=(\S+)$/i",$attr,$m)) {
655 $params[] = HTML::param(array('name' => $m[1],
661 $type = $img->getAttr('type');
663 // TODO: map extension to mime-types if type is not given and php < 4.3
664 if (function_exists('mime_content_type'))
665 $type = mime_content_type($url);
667 $object = HTML::object(array_merge($img->_attr,
668 array('type' => $type)), //'src' => $url
670 $object->setAttr('class', 'inlineobject');
672 foreach ($params as $param) $object->pushContent($param);
674 if (isBrowserSafari() and !isBrowserSafari(532)) { // recent chrome can do OBJECT
675 return HTML::embed($object->_attr, $object->_content);
677 $object->pushContent(HTML::embed($object->_attr));
684 // var in php5 deprecated
686 $this->items = array();
689 function push($item) {
690 $this->items[$this->size] = $item;
696 if ($this->size == 0) {
697 return false; // stack is empty
700 return $this->items[$this->size];
709 return $this->items[$this->size - 1];
715 // end class definition
717 function SplitQueryArgs ($query_args = '')
719 // FIXME: use the arg-seperator which might not be &
720 $split_args = explode('&', $query_args);
722 while (list($key, $val) = each($split_args))
723 if (preg_match('/^ ([^=]+) =? (.*) /x', $val, $m))
724 $args[$m[1]] = $m[2];
728 function LinkPhpwikiURL($url, $text = '', $basepage = false) {
731 if (!preg_match('/^ phpwiki: ([^?]*) [?]? (.*) $/x', $url, $m)) {
732 return HTML::span(array('class' => 'error'), _("BAD phpwiki: URL"));
736 $pagename = urldecode($m[1]);
739 if (empty($pagename) &&
740 preg_match('/^(diff|edit|links|info)=([^&]+)$/', $qargs, $m)) {
741 // Convert old style links (to not break diff links in
743 $pagename = urldecode($m[2]);
744 $args = array("action" => $m[1]);
747 $args = SplitQueryArgs($qargs);
750 if (empty($pagename))
751 $pagename = $GLOBALS['request']->getArg('pagename');
753 if (isset($args['action']) && $args['action'] == 'browse')
754 unset($args['action']);
757 if (empty($args['action']))
759 else if (is_safe_action($args['action']))
760 $class = 'wikiaction';
762 if (empty($args['action']) || is_safe_action($args['action']))
763 $class = 'wikiaction';
765 // Don't allow administrative links on unlocked pages.
766 $dbi = $GLOBALS['request']->getDbh();
767 $page = $dbi->getPage($basepage ? $basepage : $pagename);
768 if (!$page->get('locked'))
769 return HTML::span(array('class' => 'wikiunsafe'),
770 HTML::u(_("Lock page to enable link")));
771 $class = 'wikiadmin';
775 $text = HTML::span(array('class' => 'rawurl'), $url);
777 $wikipage = new WikiPageName($pagename);
778 if (!$wikipage->isValid()) {
780 return $WikiTheme->linkBadWikiWord($wikipage, $url);
783 return HTML::a(array('href' => WikiURL($pagename, $args),
789 * A class to assist in parsing wiki pagenames.
791 * Now with subpages and anchors, parsing and passing around
792 * pagenames is more complicated. This should help.
796 /** Short name for page.
798 * This is the value of $name passed to the constructor.
799 * (For use, e.g. as a default label for links to the page.)
803 /** The full page name.
805 * This is the full name of the page (without anchor).
811 * This is the referenced anchor within the page, or the empty string.
817 * @param mixed $name Page name.
818 * WikiDB_Page, WikiDB_PageRevision, or string.
819 * This can be a relative subpage name (like '/SubPage'),
820 * or can be the empty string to refer to the $basename.
822 * @param string $anchor For links to anchors in page.
824 * @param mixed $basename Page name from which to interpret
825 * relative or other non-fully-specified page names.
827 function WikiPageName($name, $basename=false, $anchor=false) {
828 if (is_string($name)) {
829 $this->shortName = $name;
830 if (strstr($name, ':')) {
831 list($moniker, $shortName) = explode (":", $name, 2);
832 $map = getInterwikiMap(); // allow overrides to custom maps
833 if (isset($map->_map[$moniker])) {
834 $url = $map->_map[$moniker];
835 if (strstr($url, '%s'))
836 $url = sprintf($url, $shortName);
840 // expand Talk or User, but not to absolute urls!
841 if (strstr($url, '//')) {
842 if ($moniker == 'Talk')
843 $name = $name . SUBPAGE_SEPARATOR . _("Discussion");
844 elseif ($moniker == 'User')
849 if (strstr($shortName, '?')) {
850 list($shortName, $dummy) = explode("\?", $shortName, 2);
852 $this->shortName = $shortName;
855 // FIXME: We should really fix the cause for "/PageName" in the WikiDB
856 if ($name == '' or $name[0] == SUBPAGE_SEPARATOR) {
858 $name = $this->_pagename($basename) . $name;
860 $name = $this->_normalize_bad_pagename($name);
861 $this->shortName = $name;
866 $name = $this->_pagename($name);
867 $this->shortName = $name;
870 $this->name = $this->_check($name);
871 $this->anchor = (string)$anchor;
878 function getParent() {
880 if (!($tail = strrchr($name, SUBPAGE_SEPARATOR)))
882 return substr($name, 0, -strlen($tail));
885 function isValid($strict = false) {
887 return !isset($this->_errors);
888 return (is_string($this->name) and $this->name != '');
891 function getWarnings() {
893 if (isset($this->_warnings))
894 $warnings = array_merge($warnings, $this->_warnings);
895 if (isset($this->_errors))
896 $warnings = array_merge($warnings, $this->_errors);
900 return sprintf(_("'%s': Bad page name: %s"),
901 $this->shortName, join(', ', $warnings));
904 function _pagename($page) {
905 if (isa($page, 'WikiDB_Page'))
906 return $page->getName();
907 elseif (isa($page, 'WikiDB_PageRevision'))
908 return $page->getPageName();
909 elseif (isa($page, 'WikiPageName'))
911 // '0' or e.g. '1984' should be allowed though
912 if (!is_string($page) and !is_integer($page)) {
913 trigger_error(sprintf("Non-string pagename '%s' (%s)(%s)",
914 $page, gettype($page), get_class($page)),
917 //assert(is_string($page));
921 function _normalize_bad_pagename($name) {
922 trigger_error("Bad pagename: " . $name, E_USER_WARNING);
924 // Punt... You really shouldn't get here.
927 return $request->getArg('pagename');
929 assert($name[0] == SUBPAGE_SEPARATOR);
930 $this->_errors[] = sprintf(_("Leading %s not allowed"), SUBPAGE_SEPARATOR);
931 return substr($name, 1);
935 * Compress internal white-space to single space character.
937 * This leads to problems with loading a foreign charset pagename,
938 * which cannot be deleted anymore, because unknown chars are compressed.
939 * So BEFORE importing a file _check must be done !!!
941 function _check($pagename) {
942 // Compress internal white-space to single space character.
943 $pagename = preg_replace('/[\s\xa0]+/', ' ', $orig = $pagename);
944 if ($pagename != $orig)
945 $this->_warnings[] = _("White space converted to single space");
947 // Delete any control characters.
948 if (DATABASE_TYPE == 'cvs' or DATABASE_TYPE == 'file' or DATABASE_TYPE == 'flatfile') {
949 $pagename = preg_replace('/[\x00-\x1f\x7f\x80-\x9f]/', '', $orig = $pagename);
950 if ($pagename != $orig)
951 $this->_errors[] = _("Control characters not allowed");
954 // Strip leading and trailing white-space.
955 $pagename = trim($pagename);
958 while ($pagename and $pagename[0] == SUBPAGE_SEPARATOR)
959 $pagename = substr($pagename, 1);
960 if ($pagename != $orig)
961 $this->_errors[] = sprintf(_("Leading %s not allowed"), SUBPAGE_SEPARATOR);
963 // ";" is urlencoded, so safe from php arg-delim problems
964 /*if (strstr($pagename, ';')) {
965 $this->_warnings[] = _("';' is deprecated");
966 $pagename = str_replace(';', '', $pagename);
969 // not only for SQL, also to restrict url length
970 if (strlen($pagename) > MAX_PAGENAME_LENGTH) {
971 $pagename = substr($pagename, 0, MAX_PAGENAME_LENGTH);
972 $this->_errors[] = _("too long");
975 // disallow some chars only on file and cvs
976 if ((DATABASE_TYPE == 'cvs'
977 or DATABASE_TYPE == 'file'
978 or DATABASE_TYPE == 'flatfile')
979 and preg_match('/(:|\.\.)/', $pagename, $m))
981 $this->_warnings[] = sprintf(_("Illegal chars %s removed"), $m[1]);
982 $pagename = str_replace('..', '', $pagename);
983 $pagename = str_replace(':', '', $pagename);
991 * Convert old page markup to new-style markup.
993 * @param string $text Old-style wiki markup.
995 * @param string $markup_type
997 * <dt><code>"block"</code> <dd>Convert all markup.
998 * <dt><code>"inline"</code> <dd>Convert only inline markup.
999 * <dt><code>"links"</code> <dd>Convert only link markup.
1002 * @return string New-style wiki markup.
1004 * @bugs Footnotes don't work quite as before (esp if there are
1005 * multiple references to the same footnote. But close enough,
1006 * probably for now....
1007 * @bugs Apache2 and IIS crash with OldTextFormattingRules or
1008 * AnciennesR%E8glesDeFormatage. (at the 2nd attempt to do the anchored block regex)
1009 * It only crashes with CreateToc so far, but other pages (not in pgsrc) are
1010 * also known to crash, even with Apache1.
1012 function ConvertOldMarkup ($text, $markup_type = "block") {
1018 // Trying to detect why the 2nd paragraph of OldTextFormattingRules or
1019 // AnciennesR%E8glesDeFormatage crashes.
1020 // It only crashes with CreateToc so far, but other pages (not in pgsrc) are
1021 // also known to crash, even with Apache1.
1022 $debug_skip = false;
1023 // I suspect this only to crash with Apache2 and IIS.
1024 if (in_array(php_sapi_name(),array('apache2handler','apache2filter','isapi'))
1025 and preg_match("/plugin CreateToc/", $text))
1027 trigger_error(_("The CreateTocPlugin is not yet old markup compatible! ")
1028 ._("Please remove the CreateToc line to be able to reformat this page to old markup. ")
1029 ._("Skipped."), E_USER_WARNING);
1031 //if (!DEBUG) return $text;
1036 /*****************************************************************
1037 * Conversions for inline markup:
1044 // escape escaped brackets
1048 // change ! escapes to ~'s.
1049 global $WikiNameRegexp, $request;
1050 $bang_esc[] = "(?:" . ALLOWED_PROTOCOLS . "):[^\s<>\[\]\"'()]*[^\s<>\[\]\"'(),.?]";
1051 // before 4.3.9 pcre had a memory release bug, which might hit us here. so be safe.
1052 if (check_php_version(4,3,9)) {
1053 $map = getInterwikiMap();
1054 if ($map_regex = $map->getRegexp())
1055 $bang_esc[] = $map_regex . ":[^\\s.,;?()]+"; // FIXME: is this really needed?
1057 $bang_esc[] = $WikiNameRegexp;
1058 $orig[] = '/!((?:' . join(')|(', $bang_esc) . '))/';
1061 $subs["links"] = array($orig, $repl);
1063 // Temporarily URL-encode pairs of underscores in links to hide
1064 // them from the re for bold markup.
1065 $orig[] = '/\[[^\[\]]*?__[^\[\]]*?\]/e';
1066 $repl[] = 'str_replace(\'__\', \'%5F%5F\', \'\\0\')';
1069 //$orig[] = '/<(?!\?plugin)|(?<!^)</m';
1072 // Convert footnote references.
1073 $orig[] = '/(?<=.)(?<!~)\[\s*(\d+)\s*\]/m';
1074 $repl[] = '#[|ftnt_ref_\\1]<sup>~[[\\1|#ftnt_\\1]~]</sup>';
1076 // Convert old style emphases to HTML style emphasis.
1077 $orig[] = '/__(.*?)__/';
1078 $repl[] = '<strong>\\1</strong>';
1079 $orig[] = "/''(.*?)''/";
1080 $repl[] = '<em>\\1</em>';
1082 // Escape nestled markup.
1083 $orig[] = '/^(?<=^|\s)[=_](?=\S)|(?<=\S)[=_*](?=\s|$)/m';
1086 // in old markup headings only allowed at beginning of line
1090 // Convert URL-encoded pairs of underscores in links back to
1091 // real underscores after bold markup has been converted.
1092 $orig = '/\[[^\[\]]*?%5F%5F[^\[\]]*?\]/e';
1093 $repl = 'str_replace(\'%5F%5F\', \'__\', \'\\0\')';
1095 $subs["inline"] = array($orig, $repl);
1097 /*****************************************************************
1098 * Patterns which match block markup constructs which take
1099 * special handling...
1103 $blockpats[] = '[ \t]+\S(?:.*\s*\n[ \t]+\S)*';
1105 $blockpats[] = '\|(?:.*\n\|)*';
1108 $blockpats[] = '[#*;]*(?:[*#]|;.*?:)';
1110 // Footnote definitions
1111 $blockpats[] = '\[\s*(\d+)\s*\]';
1115 $blockpats[] = '<\?plugin(?:-form)?\b.*\?>\s*$';
1119 $blockpats[] = '!{1,3}[^!]';
1121 removed .|\n in the anchor not to crash on /m because with /m "." already includes \n
1122 this breaks headings but it doesn't crash anymore (crash on non-cgi, non-cli only)
1124 $block_re = ( '/\A((?:.|\n)*?)(^(?:'
1125 . join("|", $blockpats)
1130 if ($markup_type != "block") {
1131 list ($orig, $repl) = $subs[$markup_type];
1132 return preg_replace($orig, $repl, $text);
1135 list ($orig, $repl) = $subs['inline'];
1138 // php crashes here in the 2nd paragraph of OldTextFormattingRules,
1139 // AnciennesR%E8glesDeFormatage and more
1140 // See http://www.pcre.org/pcre.txt LIMITATIONS
1141 while (preg_match($block_re, $text, $m)) {
1142 $text = substr($text, strlen($m[0]));
1143 list (,$leading_text, $block) = $m;
1146 if (strchr(" \t", $block[0])) {
1148 $prefix = "<pre>\n";
1149 $suffix = "\n</pre>\n";
1151 elseif ($block[0] == '|') {
1153 $prefix = "<?plugin OldStyleTable\n";
1156 elseif (strchr("#*;", $block[0])) {
1157 // Old-style list item
1158 preg_match('/^([#*;]*)([*#]|;.*?:) */', $block, $m);
1159 list (,$ind,$bullet) = $m;
1160 $block = substr($block, strlen($m[0]));
1162 $indent = str_repeat(' ', strlen($ind));
1163 if ($bullet[0] == ';') {
1164 //$term = ltrim(substr($bullet, 1));
1165 //return $indent . $term . "\n" . $indent . ' ';
1166 $prefix = $ind . $bullet;
1169 $prefix = $indent . $bullet . ' ';
1171 elseif ($block[0] == '[') {
1172 // Footnote definition
1173 preg_match('/^\[\s*(\d+)\s*\]/', $block, $m);
1175 $block = substr($block, strlen($m[0]));
1176 $prefix = "#[|ftnt_".${footnum}."]~[[".${footnum}."|#ftnt_ref_".${footnum}."]~] ";
1178 elseif ($block[0] == '<') {
1180 // HACK: no inline markup...
1184 elseif ($block[0] == '!') {
1186 preg_match('/^!{1,3}/', $block, $m);
1188 $block = substr($block, strlen($m[0]));
1194 if ($leading_text) $leading_text = preg_replace($orig, $repl, $leading_text);
1195 if ($block) $block = preg_replace($orig, $repl, $block);
1196 $out .= $leading_text;
1201 return $out . preg_replace($orig, $repl, $text);
1207 * Expand tabs in string.
1209 * Converts all tabs to (the appropriate number of) spaces.
1211 * @param string $str
1212 * @param integer $tab_width
1215 function expand_tabs($str, $tab_width = 8) {
1216 $split = explode("\t", $str);
1217 $tail = array_pop($split);
1219 foreach ($split as $hunk) {
1221 $pos = strlen(strrchr($expanded, "\n")) - 1;
1222 $expanded .= str_repeat(" ", ($tab_width - $pos % $tab_width));
1224 return substr($expanded, 1) . $tail;
1228 * Split WikiWords in page names.
1230 * It has been deemed useful to split WikiWords (into "Wiki Words") in
1231 * places like page titles. This is rumored to help search engines
1234 * @param $page string The page name.
1236 * @return string The split name.
1238 function SplitPagename ($page) {
1240 if (preg_match("/\s/", $page))
1241 return $page; // Already split --- don't split any more.
1243 // This algorithm is specialized for several languages.
1244 // (Thanks to Pierrick MEIGNEN)
1245 // Improvements for other languages welcome.
1248 // This mess splits between a lower-case letter followed by
1249 // either an upper-case or a numeral; except that it wont
1250 // split the prefixes 'Mc', 'De', or 'Di' off of their tails.
1251 switch ($GLOBALS['LANG']) {
1256 $RE[] = '/([[:lower:]])((?<!Mc|De|Di)[[:upper:]]|\d)/';
1259 $RE[] = '/([[:lower:]])((?<!Mc|Di)[[:upper:]]|\d)/';
1262 $sep = preg_quote(SUBPAGE_SEPARATOR, '/');
1263 // This the single-letter words 'I' and 'A' from any following
1264 // capitalized words.
1265 switch ($GLOBALS['LANG']) {
1267 $RE[] = "/(?<= |${sep}|^)([AI])([[:upper:]][[:lower:]])/";
1270 $RE[] = "/(?<= |${sep}|^)([À])([[:upper:]][[:lower:]])/";
1273 // Split at underscore
1274 $RE[] = '/(_)([[:alpha:]])/';
1275 $RE[] = '/([[:alpha:]])(_)/';
1276 // Split numerals from following letters.
1277 $RE[] = '/(\d)([[:alpha:]])/';
1278 // Split at subpage seperators. TBD in WikiTheme.php
1279 $RE[] = "/([^${sep}]+)(${sep})/";
1280 $RE[] = "/(${sep})([^${sep}]+)/";
1282 foreach ($RE as $key)
1286 foreach ($RE as $regexp) {
1287 $page = preg_replace($regexp, '\\1 \\2', $page);
1292 function NoSuchRevision (&$request, $page, $version) {
1293 $html = HTML(HTML::h2(_("Revision Not Found")),
1294 HTML::p(fmt("I'm sorry. Version %d of %s is not in the database.",
1295 $version, WikiLink($page, 'auto'))));
1296 include_once('lib/Template.php');
1297 GeneratePage($html, _("Bad Version"), $page->getCurrentRevision());
1303 * Get time offset for local time zone.
1305 * @param $time time_t Get offset for this time. Default: now.
1306 * @param $no_colon boolean Don't put colon between hours and minutes.
1307 * @return string Offset as a string in the format +HH:MM.
1309 function TimezoneOffset ($time = false, $no_colon = false) {
1310 if ($time === false)
1312 $secs = date('Z', $time);
1321 $colon = $no_colon ? '' : ':';
1322 $mins = intval(($secs + 30) / 60);
1323 return sprintf("%s%02d%s%02d",
1324 $sign, $mins / 60, $colon, $mins % 60);
1329 * Format time in ISO-8601 format.
1331 * @param $time time_t Time. Default: now.
1332 * @return string Date and time in ISO-8601 format.
1334 function Iso8601DateTime ($time = false) {
1335 if ($time === false)
1337 $tzoff = TimezoneOffset($time);
1338 $date = date('Y-m-d', $time);
1339 $time = date('H:i:s', $time);
1340 return $date . 'T' . $time . $tzoff;
1344 * Format time in RFC-2822 format.
1346 * @param $time time_t Time. Default: now.
1347 * @return string Date and time in RFC-2822 format.
1349 function Rfc2822DateTime ($time = false) {
1350 if ($time === false)
1352 return date('D, j M Y H:i:s ', $time) . TimezoneOffset($time, 'no colon');
1356 * Format time in RFC-1123 format.
1358 * @param $time time_t Time. Default: now.
1359 * @return string Date and time in RFC-1123 format.
1361 function Rfc1123DateTime ($time = false) {
1362 if ($time === false)
1364 return gmdate('D, d M Y H:i:s \G\M\T', $time);
1367 /** Parse date in RFC-1123 format.
1369 * According to RFC 1123 we must accept dates in the following
1372 * Sun, 06 Nov 1994 08:49:37 GMT ; RFC 822, updated by RFC 1123
1373 * Sunday, 06-Nov-94 08:49:37 GMT ; RFC 850, obsoleted by RFC 1036
1374 * Sun Nov 6 08:49:37 1994 ; ANSI C's asctime() format
1376 * (Though we're only allowed to generate dates in the first format.)
1378 function ParseRfc1123DateTime ($timestr) {
1379 $timestr = trim($timestr);
1380 if (preg_match('/^ \w{3},\s* (\d{1,2}) \s* (\w{3}) \s* (\d{4}) \s*'
1381 .'(\d\d):(\d\d):(\d\d) \s* GMT $/ix',
1383 list(, $mday, $mon, $year, $hh, $mm, $ss) = $m;
1385 elseif (preg_match('/^ \w+,\s* (\d{1,2})-(\w{3})-(\d{2}|\d{4}) \s*'
1386 .'(\d\d):(\d\d):(\d\d) \s* GMT $/ix',
1388 list(, $mday, $mon, $year, $hh, $mm, $ss) = $m;
1389 if ($year < 70) $year += 2000;
1390 elseif ($year < 100) $year += 1900;
1392 elseif (preg_match('/^\w+\s* (\w{3}) \s* (\d{1,2}) \s*'
1393 .'(\d\d):(\d\d):(\d\d) \s* (\d{4})$/ix',
1395 list(, $mon, $mday, $hh, $mm, $ss, $year) = $m;
1402 $time = strtotime("$mday $mon $year ${hh}:${mm}:${ss} GMT");
1404 return false; // failed
1409 * Format time to standard 'ctime' format.
1411 * @param $time time_t Time. Default: now.
1412 * @return string Date and time.
1414 function CTime ($time = false)
1416 if ($time === false)
1418 return date("D M j H:i:s Y", $time);
1423 * Format number as kilobytes or bytes.
1424 * Short format is used for PageList
1425 * Long format is used in PageInfo
1427 * @param $bytes int. Default: 0.
1428 * @param $longformat bool. Default: false.
1429 * @return class FormattedText (XmlElement.php).
1431 function ByteFormatter ($bytes = 0, $longformat = false) {
1434 if ($bytes < 1024) {
1436 $size = fmt("%s b", $bytes);
1438 $size = fmt("%s bytes", $bytes);
1441 $kb = round($bytes / 1024, 1);
1443 $size = fmt("%s k", $kb);
1445 $size = fmt("%s Kb (%s bytes)", $kb, $bytes);
1451 * Internationalized printf.
1453 * This is essentially the same as PHP's built-in printf
1454 * with the following exceptions:
1456 * <li> It passes the format string through gettext().
1457 * <li> It supports the argument reordering extensions.
1464 * __printf("Differences between versions %s and %s of %s",
1465 * $new_link, $old_link, $page_link);
1468 * Then in locale/po/de.po, one can reorder the printf arguments:
1471 * msgid "Differences between %s and %s of %s."
1472 * msgstr "Der Unterschiedsergebnis von %3$s, zwischen %1$s und %2$s."
1475 * (Note that while PHP tries to expand $vars within double-quotes,
1476 * the values in msgstr undergo no such expansion, so the '$'s
1479 * One shouldn't use reordered arguments in the default format string.
1480 * Backslashes in the default string would be necessary to escape the
1481 * '$'s, and they'll cause all kinds of trouble....
1483 function __printf ($fmt) {
1484 $args = func_get_args();
1486 echo __vsprintf($fmt, $args);
1490 * Internationalized sprintf.
1492 * This is essentially the same as PHP's built-in printf with the
1493 * following exceptions:
1496 * <li> It passes the format string through gettext().
1497 * <li> It supports the argument reordering extensions.
1502 function __sprintf ($fmt) {
1503 $args = func_get_args();
1505 return __vsprintf($fmt, $args);
1509 * Internationalized vsprintf.
1511 * This is essentially the same as PHP's built-in printf with the
1512 * following exceptions:
1515 * <li> It passes the format string through gettext().
1516 * <li> It supports the argument reordering extensions.
1521 function __vsprintf ($fmt, $args) {
1522 $fmt = gettext($fmt);
1523 // PHP's sprintf doesn't support variable with specifiers,
1524 // like sprintf("%*s", 10, "x"); --- so we won't either.
1526 if (preg_match_all('/(?<!%)%(\d+)\$/x', $fmt, $m)) {
1527 // Format string has '%2$s' style argument reordering.
1528 // PHP doesn't support this.
1529 if (preg_match('/(?<!%)%[- ]?\d*[^- \d$]/x', $fmt))
1530 // literal variable name substitution only to keep locale
1531 // strings uncluttered
1532 trigger_error(sprintf(_("Can't mix '%s' with '%s' type format strings"),
1533 '%1\$s','%s'), E_USER_WARNING); //php+locale error
1535 $fmt = preg_replace('/(?<!%)%\d+\$/x', '%', $fmt);
1538 // Reorder arguments appropriately.
1539 foreach($m[1] as $argnum) {
1540 if ($argnum < 1 || $argnum > count($args))
1541 trigger_error(sprintf(_("%s: argument index out of range"),
1542 $argnum), E_USER_WARNING);
1543 $newargs[] = $args[$argnum - 1];
1548 // Not all PHP's have vsprintf, so...
1549 array_unshift($args, $fmt);
1550 return call_user_func_array('sprintf', $args);
1553 function file_mtime ($filename) {
1554 if ($stat = @stat($filename))
1560 function sort_file_mtime ($a, $b) {
1561 $ma = file_mtime($a);
1562 $mb = file_mtime($b);
1563 if (!$ma or !$mb or $ma == $mb) return 0;
1564 return ($ma > $mb) ? -1 : 1;
1569 * Build an array in $this->_fileList of files from $dirname.
1570 * Subdirectories are not traversed.
1572 * (This was a function LoadDir in lib/loadsave.php)
1573 * See also http://www.php.net/manual/en/function.readdir.php
1575 function getFiles($exclude='', $sortby='', $limit='') {
1576 $list = $this->_fileList;
1579 require_once('lib/PageList.php');
1580 switch (Pagelist::sortby($sortby, 'db')) {
1581 case 'pagename ASC': break;
1582 case 'pagename DESC':
1583 $list = array_reverse($list);
1586 usort($list,'sort_file_mtime');
1589 usort($list,'sort_file_mtime');
1590 $list = array_reverse($list);
1595 return array_splice($list, 0, $limit);
1599 function _filenameSelector($filename) {
1600 if (! $this->_pattern )
1603 if (! $this->_pcre_pattern )
1604 $this->_pcre_pattern = glob_to_pcre($this->_pattern);
1605 return preg_match('/' . $this->_pcre_pattern . ($this->_case ? '/' : '/i'),
1610 function fileSet($directory, $filepattern = false) {
1611 $this->_fileList = array();
1612 $this->_pattern = $filepattern;
1614 $this->_pcre_pattern = glob_to_pcre($this->_pattern);
1616 $this->_case = !isWindows();
1617 $this->_pathsep = '/';
1619 if (empty($directory)) {
1620 trigger_error(sprintf(_("%s is empty."), 'directoryname'),
1622 return; // early return
1625 @ $dir_handle = opendir($dir=$directory);
1626 if (empty($dir_handle)) {
1627 trigger_error(sprintf(_("Unable to open directory '%s' for reading"),
1628 $dir), E_USER_NOTICE);
1629 return; // early return
1632 while ($filename = readdir($dir_handle)) {
1633 if ($filename[0] == '.' || filetype($dir . $this->_pathsep . $filename) != 'file')
1635 if ($this->_filenameSelector($filename)) {
1636 array_push($this->_fileList, "$filename");
1637 //trigger_error(sprintf(_("found file %s"), $filename),
1638 // E_USER_NOTICE); //debugging
1641 closedir($dir_handle);
1647 // expands a list containing regex's to its matching entries
1648 class ListRegexExpand {
1649 //var $match, $list, $index, $case_sensitive;
1650 function ListRegexExpand (&$list, $match, $case_sensitive = true) {
1651 $this->match = $match;
1652 $this->list = &$list;
1653 $this->case_sensitive = $case_sensitive;
1654 //$this->index = false;
1656 function listMatchCallback ($item, $key) {
1657 $quoted = str_replace('/','\/',$item);
1658 if (preg_match('/' . $this->match . ($this->case_sensitive ? '/' : '/i'),
1660 unset($this->list[$this->index]);
1661 $this->list[] = $item;
1664 function expandRegex ($index, &$pages) {
1665 $this->index = $index;
1666 array_walk($pages, array($this, 'listMatchCallback'));
1671 // Convert fileglob to regex style:
1672 // Convert some wildcards to pcre style, escape the rest
1673 // Escape . \\ + * ? [ ^ ] $ ( ) { } = ! < > | : /
1674 // Fixed bug #994994: "/" in $glob.
1675 function glob_to_pcre ($glob) {
1676 // check simple case: no need to escape
1677 $escape = '\[](){}=!<>|:/';
1678 if (strcspn($glob, $escape . ".+*?^$") == strlen($glob))
1680 // preg_replace cannot handle "\\\\\\2" so convert \\ to \xff
1681 $glob = strtr($glob, "\\", "\xff");
1682 $glob = str_replace("/", "\\/", $glob);
1683 // first convert some unescaped expressions to pcre style: . => \.
1685 $re = preg_replace('/([^\xff])?(['.preg_quote($special).'])/',
1686 "\\1\xff\\2", $glob);
1689 $re = preg_replace('/([^\xff])?\*/', '$1.*', $re);
1690 $re = preg_replace('/([^\xff])?\?/', '$1.', $re);
1691 if (!preg_match('/^[\?\*]/', $glob))
1693 if (!preg_match('/[\?\*]$/', $glob))
1696 // Fixes Bug 1182997
1697 // .*? handled above, now escape the rest
1698 //while (strcspn($re, $escape) != strlen($re)) // loop strangely needed
1699 $re = preg_replace('/([^\xff])(['.preg_quote($escape, "/").'])/',
1701 // Problem with 'Date/Time' => 'Date\/Time' => 'Date\xff\/Time' => 'Date\/Time'
1703 $re = preg_replace('/\xff/', '', $re);
1707 function glob_match ($glob, $against, $case_sensitive = true) {
1708 return preg_match('/' . glob_to_pcre($glob) . ($case_sensitive ? '/' : '/i'),
1712 function explodeList($input, $allnames, $glob_style = true, $case_sensitive = true) {
1713 $list = explode(',',$input);
1714 // expand wildcards from list of $allnames
1715 if (preg_match('/[\?\*]/',$input)) {
1716 // Optimizing loop invariants:
1717 // http://phplens.com/lens/php-book/optimizing-debugging-php.php
1718 for ($i = 0, $max = sizeof($list); $i < $max; $i++) {
1720 if (preg_match('/[\?\*]/',$f)) {
1722 $expand = new ListRegexExpand($list,
1723 $glob_style ? glob_to_pcre($f) : $f, $case_sensitive);
1724 $expand->expandRegex($i, $allnames);
1731 // echo implode(":",explodeList("Test*",array("xx","Test1","Test2")));
1732 function explodePageList($input, $include_empty=false, $sortby='pagename',
1733 $limit='', $exclude='') {
1734 include_once("lib/PageList.php");
1735 return PageList::explodePageList($input, $include_empty, $sortby, $limit, $exclude);
1738 // Class introspections
1741 * Determine whether object is of a specified type.
1742 * In PHP builtin since 4.2.0 as is_a()
1743 * is_a() deprecated in PHP 5, in favor of instanceof operator
1745 * @param $object object An object.
1746 * @param $class string Class name.
1747 * @return bool True iff $object is a $class
1748 * or a sub-type of $class.
1750 function isa ($object, $class) {
1751 //if (check_php_version(5))
1752 // return $object instanceof $class;
1753 if (check_php_version(4,2) and !check_php_version(5))
1754 return is_a($object, $class);
1756 $lclass = check_php_version(5) ? $class : strtolower($class);
1757 return is_object($object)
1758 && ( strtolower(get_class($object)) == strtolower($class)
1759 || is_subclass_of($object, $lclass) );
1762 /** Determine whether (possible) object has method.
1764 * @param $object mixed Object
1765 * @param $method string Method name
1766 * @return bool True iff $object is an object with has method $method.
1768 function can ($object, $method) {
1769 return is_object($object) && method_exists($object, strtolower($method));
1772 /** Determine whether a function is okay to use.
1774 * Some providers (e.g. Lycos) disable some of PHP functions for
1775 * "security reasons." This makes those functions, of course,
1776 * unusable, despite the fact the function_exists() says they
1779 * This function test to see if a function exists and is not
1780 * disallowed by PHP's disable_functions config setting.
1782 * @param string $function_name Function name
1783 * @return bool True iff function can be used.
1785 function function_usable($function_name) {
1787 if (!is_array($disabled)) {
1788 $disabled = array();
1789 // Use get_cfg_var since ini_get() is one of the disabled functions
1790 // (on Lycos, at least.)
1791 $split = preg_split('/\s*,\s*/', trim(get_cfg_var('disable_functions')));
1792 foreach ($split as $f)
1793 $disabled[strtolower($f)] = true;
1796 return ( function_exists($function_name)
1797 and ! isset($disabled[strtolower($function_name)])
1804 * This is used for generating ETags.
1806 function wikihash ($x) {
1807 if (is_scalar($x)) {
1810 elseif (is_array($x)) {
1812 return md5(serialize($x));
1814 elseif (is_object($x)) {
1817 trigger_error("Can't hash $x", E_USER_ERROR);
1822 * Seed the random number generator.
1824 * better_srand() ensures the randomizer is seeded only once.
1826 * How random do you want it? See:
1827 * http://www.php.net/manual/en/function.srand.php
1828 * http://www.php.net/manual/en/function.mt-srand.php
1830 function better_srand($seed = '') {
1831 static $wascalled = FALSE;
1833 $seed = $seed === '' ? (double) microtime() * 1000000 : $seed;
1834 function_exists('mt_srand') ? mt_srand($seed) : srand($seed);
1836 //trigger_error("new random seed", E_USER_NOTICE); //debugging
1840 function rand_ascii($length = 1) {
1843 for ($i = 1; $i <= $length; $i++) {
1844 // return only typeable 7 bit ascii, avoid quotes
1845 if (function_exists('mt_rand'))
1846 $s .= chr(mt_rand(40, 126));
1848 // the usually bad glibc srand()
1849 $s .= chr(rand(40, 126));
1854 /* by Dan Frankowski.
1856 function rand_ascii_readable ($length = 6) {
1857 // Pick a few random letters or numbers
1860 // Don't use 1lI0O, because they're hard to read
1861 $letters = "abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789";
1862 $letter_len = strlen($letters);
1863 for ($i=0; $i < $length; $i++) {
1864 if (function_exists('mt_rand'))
1865 $word .= $letters[mt_rand(0, $letter_len-1)];
1867 $word .= $letters[rand(0, $letter_len-1)];
1873 * Recursively count all non-empty elements
1874 * in array of any dimension or mixed - i.e.
1875 * array('1' => 2, '2' => array('1' => 3, '2' => 4))
1876 * See http://www.php.net/manual/en/function.count.php
1878 function count_all($arg) {
1879 // skip if argument is empty
1881 //print_r($arg); //debugging
1883 // not an array, return 1 (base case)
1886 // else call recursively for all elements $arg
1887 foreach($arg as $key => $val)
1888 $count += count_all($val);
1893 function isSubPage($pagename) {
1894 return (strstr($pagename, SUBPAGE_SEPARATOR));
1897 function subPageSlice($pagename, $pos) {
1898 $pages = explode(SUBPAGE_SEPARATOR,$pagename);
1899 $pages = array_slice($pages,$pos,1);
1903 function isActionPage($filename) {
1905 global $AllActionPages;
1907 return (in_array($filename, $AllActionPages));
1913 * Class for "popping up" and alert box. (Except that right now, it doesn't
1917 * This is a hackish and needs to be refactored. However it would be nice to
1918 * unify all the different methods we use for showing Alerts and Dialogs.
1919 * (E.g. "Page deleted", login form, ...)
1924 * @param object $request
1925 * @param mixed $head Header ("title") for alert box.
1926 * @param mixed $body The text in the alert box.
1927 * @param hash $buttons An array mapping button labels to URLs.
1928 * The default is a single "Okay" button pointing to $request->getURLtoSelf().
1930 function Alert($head, $body, $buttons=false) {
1931 if ($buttons === false)
1934 if (is_array($body)) {
1936 foreach ($body as $li) {
1937 $html->pushContent(HTML::li($li));
1941 $this->_tokens = array('HEADER' => $head, 'CONTENT' => $body);
1942 $this->_buttons = $buttons;
1946 * Show the alert box.
1951 $tokens = $this->_tokens;
1952 $tokens['BUTTONS'] = $this->_getButtons();
1954 $request->discardOutput();
1955 $tmpl = new Template('dialog', $request, $tokens);
1961 function _getButtons() {
1964 $buttons = $this->_buttons;
1966 $buttons = array(_("Okay") => $request->getURLtoSelf());
1969 foreach ($buttons as $label => $url)
1970 print "$label $url\n";
1971 $out[] = $WikiTheme->makeButton($label, $url, 'wikiaction');
1972 return new XmlContent($out);
1977 // 1.3.9-p1 => 1030.091
1978 // 1.3.10pre => 1030.099
1979 // 1.3.11pre-20041120 => 1030.1120041120
1980 // 1.3.12-rc1 => 1030.119
1981 function phpwiki_version() {
1982 static $PHPWIKI_VERSION;
1983 if (!isset($PHPWIKI_VERSION)) {
1984 $arr = explode('.',preg_replace('/\D+$/','', PHPWIKI_VERSION)); // remove the pre
1985 $arr[2] = preg_replace('/\.+/','.',preg_replace('/\D/','.',$arr[2]));
1986 $PHPWIKI_VERSION = $arr[0]*1000 + $arr[1]*10 + 0.01*$arr[2];
1987 if (strstr(PHPWIKI_VERSION, 'pre') or strstr(PHPWIKI_VERSION, 'rc'))
1988 $PHPWIKI_VERSION -= 0.01;
1990 return $PHPWIKI_VERSION;
1993 function phpwiki_gzhandler($ob) {
1994 if (function_exists('gzencode'))
1995 $ob = gzencode($ob);
1996 $GLOBALS['request']->_ob_get_length = strlen($ob);
1997 if (!headers_sent()) {
1998 header(sprintf("Content-Length: %d", $GLOBALS['request']->_ob_get_length));
2003 function isWikiWord($word) {
2004 global $WikiNameRegexp;
2005 //or preg_match('/\A' . $WikiNameRegexp . '\z/', $word) ??
2006 return preg_match("/^$WikiNameRegexp\$/",$word);
2009 // needed to store serialized objects-values only (perm, pref)
2010 function obj2hash ($obj, $exclude = false, $fields = false) {
2012 if (! $fields ) $fields = get_object_vars($obj);
2013 foreach ($fields as $key => $val) {
2014 if (is_array($exclude)) {
2015 if (in_array($key, $exclude)) continue;
2023 * isAsciiString($string)
2025 function isAsciiString($s) {
2026 $ptrASCII = '[\x00-\x7F]';
2027 return preg_match("/^($ptrASCII)*$/s", $s);
2031 * isUtf8String($string) - cheap utf-8 detection
2033 * segfaults for strings longer than 10kb!
2034 * Use http://www.phpdiscuss.com/article.php?id=565&group=php.i18n or
2035 * checkTitleEncoding() at http://cvs.sourceforge.net/viewcvs.py/wikipedia/phase3/languages/Language.php
2037 function isUtf8String( $s ) {
2038 $ptrASCII = '[\x00-\x7F]';
2039 $ptr2Octet = '[\xC2-\xDF][\x80-\xBF]';
2040 $ptr3Octet = '[\xE0-\xEF][\x80-\xBF]{2}';
2041 $ptr4Octet = '[\xF0-\xF4][\x80-\xBF]{3}';
2042 $ptr5Octet = '[\xF8-\xFB][\x80-\xBF]{4}';
2043 $ptr6Octet = '[\xFC-\xFD][\x80-\xBF]{5}';
2044 return preg_match("/^($ptrASCII|$ptr2Octet|$ptr3Octet|$ptr4Octet|$ptr5Octet|$ptr6Octet)*$/s", $s);
2048 * Check for UTF-8 URLs; Internet Explorer produces these if you
2049 * type non-ASCII chars in the URL bar or follow unescaped links.
2050 * Requires urldecoded pagename.
2051 * Fixes sf.net bug #953949
2053 * src: languages/Language.php:checkTitleEncoding() from mediawiki
2055 function fixTitleEncoding( $s ) {
2060 if (empty($s)) return $s;
2062 $ishigh = preg_match( '/[\x80-\xff]/', $s);
2064 $isutf = ($ishigh ? preg_match( '/^([\x00-\x7f]|[\xc0-\xdf][\x80-\xbf]|' .
2065 '[\xe0-\xef][\x80-\xbf]{2}|[\xf0-\xf7][\x80-\xbf]{3})+$/', $s ) : true );
2067 $isutf = ($ishigh ? isUtf8String($s) : true);
2068 $locharset = strtolower($charset);
2070 if( $locharset != "utf-8" and $ishigh and $isutf )
2071 $s = charset_convert('UTF-8', $locharset, $s);
2072 if ($locharset == "utf-8" and $ishigh and !$isutf )
2073 return utf8_encode( $s );
2075 // Other languages can safely leave this function, or replace
2076 // it with one to detect and convert another legacy encoding.
2081 * MySQL fulltext index doesn't grok utf-8, so we
2082 * need to fold cases and convert to hex.
2083 * src: languages/Language.php:stripForSearch() from mediawiki
2086 function stripForSearch( $string ) {
2087 global $wikiLowerChars;
2088 // '/(?:[a-z]|\xc3[\x9f-\xbf]|\xc4[\x81\x83\x85\x87])/' => "a-z\xdf-\xf6\xf8-\xff"
2089 return preg_replace(
2090 "/([\\xc0-\\xff][\\x80-\\xbf]*)/e",
2091 "'U8' . bin2hex( strtr( \"\$1\", \$wikiLowerChars ) )",
2097 * Workaround for allow_url_fopen, to get the content of an external URI.
2098 * It returns the contents in one slurp. Parsers might want to check for allow_url_fopen
2099 * and use fopen, fread chunkwise. (see lib/XmlParser.php)
2101 function url_get_contents( $uri ) {
2102 if (get_cfg_var('allow_url_fopen')) { // was ini_get('allow_url_fopen'))
2103 return @file_get_contents($uri);
2105 require_once("lib/HttpClient.php");
2106 $bits = parse_url($uri);
2107 $host = $bits['host'];
2108 $port = isset($bits['port']) ? $bits['port'] : 80;
2109 $path = isset($bits['path']) ? $bits['path'] : '/';
2110 if (isset($bits['query'])) {
2111 $path .= '?'.$bits['query'];
2113 $client = new HttpClient($host, $port);
2114 $client->use_gzip = false;
2115 if (!$client->get($path)) {
2118 return $client->getContent();
2124 * Generate consecutively named strings:
2125 * Name, Name2, Name3, ...
2127 function GenerateId($name) {
2128 static $ids = array();
2129 if (empty($ids[$name])) {
2134 return $name . $ids[$name];
2138 // from IncludePage. To be of general use.
2139 // content: string or array of strings
2140 function firstNWordsOfContent( $n, $content ) {
2141 if ($content and $n > 0) {
2142 if (is_array($content)) {
2143 // fixme: return a list of lines then?
2144 //$content = join("\n", $content);
2145 //$return_array = true;
2147 foreach ($content as $line) {
2148 $words = explode(' ', $line);
2149 if ($wordcount + count($words) > $n) {
2150 $new[] = implode(' ', array_slice($words, 0, $n - $wordcount))
2151 . sprintf(_("... (first %s words)"), $n);
2154 $wordcount += count($words);
2160 // fixme: use better whitespace/word seperators
2161 $words = explode(' ', $content);
2162 if (count($words) > $n) {
2163 return join(' ', array_slice($words, 0, $n))
2164 . sprintf(_("... (first %s words)"), $n);
2174 // moved from lib/plugin/IncludePage.php
2175 function extractSection ($section, $content, $page, $quiet = false, $sectionhead = false) {
2176 $qsection = preg_replace('/\s+/', '\s+', preg_quote($section, '/'));
2178 if (preg_match("/ ^(!{1,}|={2,})\\s*$qsection\s*=*" // section header
2179 . " \\s*$\\n?" // possible blank lines
2180 . " ( (?: ^.*\\n? )*? )" // some lines
2181 . " (?= ^\\1 | \\Z)/xm", // sec header (same or higher level) (or EOF)
2182 implode("\n", $content),
2184 // Strip trailing blanks lines and ---- <hr>s
2185 $text = preg_replace("/\\s*^-{4,}\\s*$/m", "", $match[2]);
2187 $text = $match[1] . $section ."\n". $text;
2188 return explode("\n", $text);
2191 $mesg = $page ." ". $section;
2194 return array(sprintf(_("<%s: no such section>"), $mesg));
2197 // Extract the first $sections sections of the page
2198 function extractSections ($sections, $content, $page, $quiet = false, $sectionhead = false) {
2200 $mycontent = $content;
2203 while ($sections > 0) {
2205 if (preg_match("/ ^(!{1,}|={2,})\\s*(.*)\\n" // section header
2206 . " \\s*$\\n?" // possible blank lines
2207 . " ( (?: ^.*\\n? )*? )" // some lines
2208 . " ( ^\\1 (.|\\n)* | \\Z)/xm", // sec header (same or higher level) (or EOF)
2209 implode("\n", $mycontent),
2211 $section = $match[2];
2212 // Strip trailing blanks lines and ---- <hr>s
2213 $text = preg_replace("/\\s*^-{4,}\\s*$/m", "", $match[3]);
2215 $text = $match[1] . $section ."\n". $text;
2218 $mycontent = explode("\n", $match[4]);
2220 if ($sections === 0) {
2221 return explode("\n", $result);
2227 // use this faster version: only load ExternalReferrer if we came from an external referrer
2228 function isExternalReferrer(&$request) {
2229 if ($referrer = $request->get('HTTP_REFERER')) {
2230 $home = SERVER_URL; // SERVER_URL or SCRIPT_NAME, if we want to check sister wiki's also
2231 if (string_starts_with(strtolower($referrer), strtolower($home))) return false;
2232 require_once("lib/ExternalReferrer.php");
2233 $se = new SearchEngines();
2234 return $se->parseSearchQuery($referrer);
2236 //if (DEBUG) return array('query' => 'wiki');
2241 * Useful for PECL overrides: cvsclient, ldap, soap, xmlrpc, pdo, pdo_<driver>
2243 function loadPhpExtension($extension) {
2244 if (!extension_loaded($extension)) {
2245 $isWindows = (substr(PHP_OS,0,3) == 'WIN');
2246 $soname = ($isWindows ? 'php_' : '')
2248 . ($isWindows ? '.dll' : '.so');
2252 return extension_loaded($extension);
2255 function charset_convert($from, $to, $data) {
2257 //$wikicharset = strtolower($CHARSET);
2258 //$systemcharset = strtolower(get_cfg_var('iconv.internal_encoding')); // 'iso-8859-1';
2259 if (strtolower($from) == 'utf-8' and strtolower($to) == 'iso-8859-1')
2260 return utf8_decode($data);
2261 if (strtolower($to) == 'utf-8' and strtolower($from) == 'iso-8859-1')
2262 return utf8_encode($data);
2264 if (loadPhpExtension("iconv")) {
2265 $tmpdata = iconv($from, $to, $data);
2267 trigger_error("charset conversion $from => $to failed. Wrong source charset?", E_USER_WARNING);
2271 trigger_error("The iconv extension cannot be loaded", E_USER_WARNING);
2276 function string_starts_with($string, $prefix) {
2277 return (substr($string, 0, strlen($prefix)) == $prefix);
2279 function string_ends_with($string, $suffix) {
2280 return (substr($string, -strlen($suffix)) == $suffix);
2282 function array_remove($arr,$value) {
2283 return array_values(array_diff($arr,array($value)));
2287 * Ensure that the script will have another $secs time left.
2288 * Works only if safe_mode is off.
2289 * For example not to timeout on waiting socket connections.
2290 * Use the socket timeout as arg.
2292 function longer_timeout($secs = 30) {
2293 $timeout = @ini_get("max_execution_time") ? ini_get("max_execution_time") : 30;
2294 $timeleft = $timeout - $GLOBALS['RUNTIMER']->getTime();
2295 if ($timeleft < $secs)
2296 @set_time_limit(max($timeout,(integer)($secs + $timeleft)));
2299 function printSimpleTrace($bt) {
2301 echo "\nTraceback:\n";
2302 if (function_exists('debug_print_backtrace')) { // >= 5
2303 debug_print_backtrace();
2305 foreach ($bt as $i => $elem) {
2306 if (!array_key_exists('file', $elem)) {
2309 //echo join(" ",array_values($elem)),"\n";
2310 echo " ",$elem['file'],':',$elem['line']," ",$elem['function'],"\n";
2316 * Return the used process memory, in bytes.
2317 * Enable the section which will work for you. They are very slow.
2318 * Special quirks for Windows: Requires cygwin.
2320 function getMemoryUsage() {
2321 //if (!(DEBUG & _DEBUG_VERBOSE)) return;
2322 if (function_exists('memory_get_usage') and memory_get_usage()) {
2323 return memory_get_usage();
2324 } elseif (function_exists('getrusage') and ($u = @getrusage()) and !empty($u['ru_maxrss'])) {
2325 $mem = $u['ru_maxrss'];
2326 } elseif (substr(PHP_OS,0,3) == 'WIN') { // may require a newer cygwin
2327 // what we want is the process memory only: apache or php (if CGI)
2330 // win32_ps_stat_proc, win32_ps_stat_mem
2331 if (function_exists('win32_ps_list_procs')) {
2332 $info = win32_ps_stat_proc($pid);
2333 $memstr = $info['mem']['working_set_size'];
2335 // This works only if it's a cygwin process (apache or php).
2336 // Requires a newer cygwin
2337 $memstr = exec("cat /proc/$pid/statm |cut -f1");
2339 // if it's native windows use something like this:
2340 // (requires pslist from sysinternals.com, grep, sed and perl)
2341 //$memstr = exec("pslist $pid|grep -A1 Mem|sed 1d|perl -ane\"print \$"."F[5]\"");
2343 return (integer) trim($memstr);
2346 //%MEM: Percentage of total memory in use by this process
2347 //VSZ: Total virtual memory size, in 1K blocks.
2348 //RSS: Real Set Size, the actual amount of physical memory allocated to this process.
2349 //CPU time used by process since it started.
2350 //echo "%",`ps -o%mem,vsz,rss,time -p $pid|sed 1d`,"\n";
2351 $memstr = exec("ps -orss -p $pid|sed 1d");
2352 return (integer) trim($memstr);
2357 * @param var $needle
2358 * @param array $haystack one-dimensional numeric array only, no hash
2360 * @desc Feed a sorted array to $haystack and a value to search for to $needle.
2361 It will return false if not found or the index where it was found.
2362 From dennis.decoene@moveit.be http://www.php.net/array_search
2364 function binary_search($needle, $haystack) {
2365 $high = count($haystack);
2368 while (($high - $low) > 1) {
2369 $probe = floor(($high + $low) / 2);
2370 if ($haystack[$probe] < $needle) {
2372 } elseif ($haystack[$probe] == $needle) {
2373 $high = $low = $probe;
2379 if ($high == count($haystack) || $haystack[$high] != $needle) {
2386 function is_localhost($url = false) {
2388 global $HTTP_SERVER_VARS;
2389 return $HTTP_SERVER_VARS['SERVER_ADDR'] == '127.0.0.1';
2394 * Take a string and quote it sufficiently to be passed as a Javascript
2395 * string between ''s
2397 function javascript_quote_string($s) {
2398 return str_replace("'", "\'", $s);
2401 function isSerialized($s) {
2402 return (!empty($s) and (strlen($s) > 3) and (substr($s,1,1) == ':'));
2406 * Take a string and return an array of pairs (attribute name, attribute value)
2408 * We allow attributes with or without double quotes (")
2409 * Attribute-value pairs may be separated by space or comma
2410 * Space is normal HTML attributes, comma is for RichTable compatibility
2411 * border=1, cellpadding="5"
2412 * border=1 cellpadding="5"
2413 * style="font-family: sans-serif; border-top:1px solid #dddddd;"
2414 * style="font-family: Verdana, Arial, Helvetica, sans-serif"
2416 function parse_attributes($line) {
2420 if (empty($line)) return $options;
2421 $line = trim($line);
2422 if (empty($line)) return $options;
2423 $line = trim($line, ",");
2424 if (empty($line)) return $options;
2426 // First we have an attribute name.
2431 while (($i < strlen($line)) && ($line[$i] != '=')) {
2434 $attribute = substr($line, 0, $i);
2435 $attribute = strtolower($attribute);
2437 $line = substr($line, $i+1);
2438 $line = trim ($line);
2439 $line = trim ($line, "=");
2440 $line = trim ($line);
2442 if (empty($line)) return $options;
2444 // Then we have the attribute value.
2447 // Attribute value might be between double quotes
2448 // In that case we have to find the closing double quote
2449 if ($line[0] == '"') {
2450 $i++; // skip first '"'
2451 while (($i < strlen($line)) && ($line[$i] != '"')) {
2454 $value = substr($line, 0, $i);
2455 $value = trim ($value, '"');
2456 $value = trim ($value);
2458 // If there are no double quotes, we have to find the next space or comma
2460 while (($i < strlen($line)) && (($line[$i] != ' ') && ($line[$i] != ','))) {
2463 $value = substr($line, 0, $i);
2464 $value = trim ($value);
2465 $value = trim ($value, ",");
2466 $value = trim ($value);
2469 $options[$attribute] = $value;
2471 $line = substr($line, $i+1);
2472 $line = trim ($line);
2473 $line = trim ($line, ",");
2474 $line = trim ($line);
2476 return $options + parse_attributes($line);
2480 * Returns true if the filename ends with an image suffix.
2481 * Uses INLINE_IMAGES if defined, else "png|jpg|jpeg|gif"
2483 function is_image ($filename) {
2485 if (defined('INLINE_IMAGES')) {
2486 $inline_images = INLINE_IMAGES;
2488 $inline_images = "png|jpg|jpeg|gif";
2491 foreach (explode("|", $inline_images) as $suffix) {
2492 if (string_ends_with(strtolower($filename), "." . $suffix)) {
2500 * Returns true if the filename ends with an video suffix.
2501 * Currently only FLV and OGG
2503 function is_video ($filename) {
2505 return string_ends_with(strtolower($filename), ".flv")
2506 or string_ends_with(strtolower($filename), ".ogg");
2510 * Compute cell in spreadsheet table
2511 * $table: two-dimensional table
2512 * $i and $j: indexes of cell to compute
2513 * $imax and $jmax: table dimensions
2515 function compute_tablecell ($table, $i, $j, $imax, $jmax) {
2517 // What is implemented:
2518 // @@=SUM(R)@@ : sum of cells in current row
2519 // @@=SUM(C)@@ : sum of cells in current column
2520 // @@=AVERAGE(R)@@ : average of cells in current row
2521 // @@=AVERAGE(C)@@ : average of cells in current column
2522 // @@=MAX(R)@@ : maximum value of cells in current row
2523 // @@=MAX(C)@@ : maximum value of cells in current column
2524 // @@=MIN(R)@@ : minimum value of cells in current row
2525 // @@=MIN(C)@@ : minimum value of cells in current column
2526 // @@=COUNT(R)@@ : number of cells in current row
2527 // (numeric or not, excluding headers and current cell)
2528 // @@=COUNT(C)@@ : number of cells in current column
2529 // (numeric or not, excluding headers and current cell)
2535 if (strpos($table[$i][$j], "@@=SUM(C)@@") !== false) {
2536 for ($index=0; $index<$imax; $index++) {
2537 if (is_numeric($table[$index][$j])) {
2538 $result += $table[$index][$j];
2541 return str_replace("@@=SUM(C)@@", $result, $table[$i][$j]);
2543 } else if (strpos($table[$i][$j], "@@=SUM(R)@@") !== false) {
2544 for ($index=0; $index<$jmax; $index++) {
2545 if (is_numeric($table[$i][$index])) {
2546 $result += $table[$i][$index];
2549 return str_replace("@@=SUM(R)@@", $result, $table[$i][$j]);
2551 } else if (strpos($table[$i][$j], "@@=AVERAGE(C)@@") !== false) {
2552 for ($index=0; $index<$imax; $index++) {
2553 if (is_numeric($table[$index][$j])) {
2554 $result += $table[$index][$j];
2558 $result=$result/$counter;
2559 return str_replace("@@=AVERAGE(C)@@", $result, $table[$i][$j]);
2561 } else if (strpos($table[$i][$j], "@@=AVERAGE(R)@@") !== false) {
2562 for ($index=0; $index<$jmax; $index++) {
2563 if (is_numeric($table[$i][$index])) {
2564 $result += $table[$i][$index];
2568 $result=$result/$counter;
2569 return str_replace("@@=AVERAGE(R)@@", $result, $table[$i][$j]);
2571 } else if (strpos($table[$i][$j], "@@=MAX(C)@@") !== false) {
2572 for ($index=0; $index<$imax; $index++) {
2573 if (is_numeric($table[$index][$j])) {
2576 $result=$table[$index][$j];
2578 $result = max($result, $table[$index][$j]);
2585 return str_replace("@@=MAX(C)@@", $result, $table[$i][$j]);
2587 } else if (strpos($table[$i][$j], "@@=MAX(R)@@") !== false) {
2588 for ($index=0; $index<$jmax; $index++) {
2589 if (is_numeric($table[$i][$index])) {
2592 $result=$table[$i][$index];
2594 $result = max($result, $table[$i][$index]);
2601 return str_replace("@@=MAX(R)@@", $result, $table[$i][$j]);
2603 } else if (strpos($table[$i][$j], "@@=MIN(C)@@") !== false) {
2604 for ($index=0; $index<$imax; $index++) {
2605 if (is_numeric($table[$index][$j])) {
2608 $result=$table[$index][$j];
2610 $result = min($result, $table[$index][$j]);
2617 return str_replace("@@=MIN(C)@@", $result, $table[$i][$j]);
2619 } else if (strpos($table[$i][$j], "@@=MIN(R)@@") !== false) {
2620 for ($index=0; $index<$jmax; $index++) {
2621 if (is_numeric($table[$i][$index])) {
2624 $result=$table[$i][$index];
2626 $result = min($result, $table[$i][$index]);
2633 return str_replace("@@=MIN(R)@@", $result, $table[$i][$j]);
2635 } else if (strpos($table[$i][$j], "@@=COUNT(C)@@") !== false) {
2636 for ($index=0; $index<$imax; $index++) {
2637 if (!string_starts_with(trim($table[$index][$j]), "=")) { // exclude header
2641 $result = $counter-1; // exclude self
2642 return str_replace("@@=COUNT(C)@@", $result, $table[$i][$j]);
2644 } else if (strpos($table[$i][$j], "@@=COUNT(R)@@") !== false) {
2645 for ($index=0; $index<$jmax; $index++) {
2646 if (!string_starts_with(trim($table[$i][$index]), "=")) { // exclude header
2650 $result = $counter-1; // exclude self
2651 return str_replace("@@=COUNT(R)@@", $result, $table[$i][$j]);
2654 return $table[$i][$j];
2658 * Remove accents from given text.
2660 function strip_accents($text) {
2661 $res = utf8_decode($text);
2663 utf8_decode('àáâãäçèéêëìíîïñòóôõöùúûüýÿÀÁÂÃÄÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝ'),
2664 'aaaaaceeeeiiiinooooouuuuyyAAAAACEEEEIIIINOOOOOUUUUY');
2665 return utf8_encode($res);
2668 // (c-file-style: "gnu")
2672 // c-basic-offset: 4
2673 // c-hanging-comment-ender-p: nil
2674 // indent-tabs-mode: nil