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: linkExistingWikiWord($wikiword, $linktext, $version)
106 moved to: lib/WikiTheme.php
108 if (defined('_PHPWIKI_STDLIB_LOADED')) return;
109 else define('_PHPWIKI_STDLIB_LOADED', true);
111 define('MAX_PAGENAME_LENGTH', 100);
114 * Convert string to a valid XML identifier.
116 * XML 1.0 identifiers are of the form: [A-Za-z][A-Za-z0-9:_.-]*
118 * We would like to have, e.g. named anchors within wiki pages
119 * names like "Table of Contents" --- clearly not a valid XML
120 * fragment identifier.
122 * This function implements a one-to-one map from {any string}
123 * to {valid XML identifiers}.
126 * converting all bytes not in [A-Za-z0-9:_-],
127 * and any leading byte not in [A-Za-z] to 'xbb.',
128 * where 'bb' is the hexadecimal representation of the
131 * As a special case, the empty string is converted to 'empty.'
136 function MangleXmlIdentifier($str) {
140 return preg_replace('/[^-_:A-Za-z0-9]|(?<=^)[^A-Za-z]/e',
141 "'x' . sprintf('%02x', ord('\\0')) . '.'",
145 function UnMangleXmlIdentifier($str) {
146 if ($str == 'empty.')
148 return preg_replace('/x(\w\w)\./e',
149 "sprintf('%c', hex('\\0'))",
154 * Returns a name for the WIKI_ID cookie that should be unique on the host.
155 * But for it to be unique you must have set a unique WIKI_NAME in your
156 * configuration file.
157 * @return string The name of the WIKI_ID cookie to use for this wiki.
159 function GetCookieName() {
160 return preg_replace("/[^\d\w]/", "_", WIKI_NAME) . "_WIKI_ID";
164 * Generates a valid URL for a given Wiki pagename.
165 * @param mixed $pagename If a string this will be the name of the Wiki page to link to.
166 * If a WikiDB_Page object function will extract the name to link to.
167 * If a WikiDB_PageRevision object function will extract the name to link to.
169 * @param boolean $get_abs_url Default value is false.
170 * @return string The absolute URL to the page passed as $pagename.
172 function WikiURL($pagename, $args = '', $get_abs_url = false) {
173 global $request, $WikiTheme;
176 if (is_object($pagename)) {
177 if (isa($pagename, 'WikiDB_Page')) {
178 $pagename = $pagename->getName();
180 elseif (isa($pagename, 'WikiDB_PageRevision')) {
181 $page = $pagename->getPage();
182 $args['version'] = $pagename->getVersion();
183 $pagename = $page->getName();
185 elseif (isa($pagename, 'WikiPageName')) {
186 $anchor = $pagename->anchor;
187 $pagename = $pagename->name;
189 $anchor = $pagename->anchor;
190 $pagename = $pagename->name;
193 if (!$get_abs_url and DEBUG and $request->getArg('start_debug')) {
195 $args = 'start_debug=' . $request->getArg('start_debug');
196 elseif (is_array($args))
197 $args['start_debug'] = $request->getArg('start_debug');
199 $args .= '&start_debug=' . $request->getArg('start_debug');
201 if (is_array($args)) {
203 foreach ($args as $key => $val) {
204 // avoid default args
205 if (USE_PATH_INFO and $key == 'pagename')
207 elseif ($key == 'action' and $val == 'browse')
209 elseif (!is_array($val)) // ugly hack for getURLtoSelf() which also takes POST vars
210 $enc_args[] = urlencode($key) . '=' . urlencode($val);
212 $args = join('&', $enc_args);
215 if (USE_PATH_INFO or !empty($WikiTheme->HTML_DUMP_SUFFIX)) {
216 $url = $get_abs_url ? (SERVER_URL . VIRTUAL_PATH . "/") : "";
217 $base = preg_replace('/%2f/i', '/', rawurlencode($pagename));
219 if (!empty($WikiTheme->HTML_DUMP_SUFFIX)) {
220 if (!empty($WikiTheme->VALID_LINKS) and $request->getArg('action') == 'pdf') {
221 if (!in_array($pagename, $WikiTheme->VALID_LINKS))
224 $url = $base . $WikiTheme->HTML_DUMP_SUFFIX;
226 $url .= $WikiTheme->HTML_DUMP_SUFFIX;
236 $url = $get_abs_url ? SERVER_URL . SCRIPT_NAME : basename(SCRIPT_NAME);
237 $url .= "?pagename=" . rawurlencode($pagename);
242 $url .= "#" . MangleXmlIdentifier($anchor);
246 /** Convert relative URL to absolute URL.
248 * This converts a relative URL to one of PhpWiki's support files
249 * to an absolute one.
252 * @return string Absolute URL
254 function AbsoluteURL ($url) {
255 if (preg_match('/^https?:/', $url))
257 if ($url[0] != '/') {
258 $base = USE_PATH_INFO ? VIRTUAL_PATH : dirname(SCRIPT_NAME);
259 while ($base != '/' and substr($url, 0, 3) == "../") {
260 $url = substr($url, 3);
261 $base = dirname($base);
267 return SERVER_URL . $url;
270 function DataURL ($url) {
271 if (preg_match('/^https?:/', $url))
273 $url = NormalizeWebFileName($url);
274 if (DEBUG and $GLOBALS['request']->getArg('start_debug') and substr($url,-4,4) == '.php')
275 $url .= "?start_debug=1"; // XMLRPC and SOAP debugging helper.
276 return AbsoluteURL($url);
280 * Generates icon in front of links.
282 * @param string $protocol_or_url URL or protocol to determine which icon to use.
284 * @return HtmlElement HtmlElement object that contains data to create img link to
285 * icon for use with url or protocol passed to the function. False if no img to be
288 function IconForLink($protocol_or_url) {
290 if (0 and $filename_suffix == false) {
291 // display apache style icon for file type instead of protocol icon
292 // - archive: unix:gz,bz2,tgz,tar,z; mac:dmg,dmgz,bin,img,cpt,sit; pc:zip;
293 // - document: html, htm, text, txt, rtf, pdf, doc
294 // - non-inlined image: jpg,jpeg,png,gif,tiff,tif,swf,pict,psd,eps,ps
295 // - audio: mp3,mp2,aiff,aif,au
296 // - multimedia: mpeg,mpg,mov,qt
298 list ($proto) = explode(':', $protocol_or_url, 2);
299 $src = $WikiTheme->getLinkIconURL($proto);
301 return HTML::img(array('src' => $src, 'alt' => "", 'class' => 'linkicon', 'border' => 0));
308 * Glue icon in front of or after text.
309 * Pref: 'noLinkIcons' - ignore icon if set
310 * WikiTheme: 'LinkIcons' - 'yes' at front
311 * - 'no' display no icon
312 * - 'front' display at left
313 * - 'after' display at right
315 * @param string $protocol_or_url Protocol or URL. Used to determine the
317 * @param string $text The text.
318 * @return XmlContent.
320 function PossiblyGlueIconToText($proto_or_url, $text) {
321 global $request, $WikiTheme;
322 if ($request->getPref('noLinkIcons'))
324 $icon = IconForLink($proto_or_url);
327 if ($where = $WikiTheme->getLinkIconAttr()) {
328 if ($where == 'no') return $text;
329 if ($where != 'after') $where = 'front';
333 if ($where == 'after') {
334 // span the icon only to the last word (tie them together),
335 // to let the previous words wrap on line breaks.
336 if (!is_object($text)) {
337 preg_match('/^(\s*\S*)(\s*)$/', $text, $m);
338 list (, $prefix, $last_word) = $m;
344 $text = HTML::span(array('style' => 'white-space: nowrap'),
345 $last_word, HTML::Raw(' '), $icon);
347 $text = HTML($prefix, $text);
350 // span the icon only to the first word (tie them together),
351 // to let the next words wrap on line breaks
352 if (!is_object($text)) {
353 preg_match('/^\s*(\S*)(.*?)\s*$/', $text, $m);
354 list (, $first_word, $tail) = $m;
360 $text = HTML::span(array('style' => 'white-space: nowrap'),
363 $text = HTML($text, $tail);
368 * Determines if the url passed to function is safe, by detecting if the characters
369 * '<', '>', or '"' are present.
370 * Check against their urlencoded values also.
372 * @param string $url URL to check for unsafe characters.
373 * @return boolean True if same, false else.
375 function IsSafeURL($url) {
376 return !preg_match('/([<>"])|(%3C)|(%3E)|(%22)/', $url);
380 * Generates an HtmlElement object to store data for a link.
382 * @param string $url URL that the link will point to.
383 * @param string $linktext Text to be displayed as link.
384 * @return HtmlElement HtmlElement object that contains data to construct an html link.
386 function LinkURL($url, $linktext = '') {
387 // FIXME: Is this needed (or sufficient?)
388 if(! IsSafeURL($url)) {
389 $link = HTML::span(array('class' => 'error'), _("BAD URL -- remove all of <, >, \""));
394 $linktext = preg_replace("/mailto:/A", "", $url);
395 $args = array('href' => $url);
396 if ( defined('EXTERNAL_LINK_TARGET') ) // can also be set in the css
397 $args['target'] = (is_string(EXTERNAL_LINK_TARGET) and (EXTERNAL_LINK_TARGET != "")) ? EXTERNAL_LINK_TARGET : "_blank";
398 $link = HTML::a($args, PossiblyGlueIconToText($url, $linktext));
400 $link->setAttr('class', $linktext ? 'namedurl' : 'rawurl');
407 * Syntax: [image.png size=50% border=n align= hspace= vspace= width= height=]
408 * Disallows sizes which are too small.
409 * Spammers may use such (typically invisible) image attributes to raise their GoogleRank.
411 * Handle embeddable objects, like svg, class, vrml, swf, svgz, pdf, avi, wmv especially.
413 function LinkImage($url, $alt = "") {
414 $force_img = "png|jpg|gif|jpeg|bmp|pl|cgi";
415 // Disallow tags in img src urls. Typical CSS attacks.
416 // FIXME: Is this needed (or sufficient?)
417 // FIXED: This was broken for moniker:TP30 test/image.png => url="moniker:TP30" attr="test/image.png"
419 // support new syntax: [prefix/image.jpg size=50% border=n]
420 if (empty($alt)) $alt = "";
423 $arr = explode(' ',$url);
424 if (!empty($arr)) $url = $arr[0];
425 if (! IsSafeURL($url)) {
426 $link = HTML::span(array('class' => 'error'), _("BAD URL -- remove all of <, >, \""));
429 // spaces in inline images must be %20 encoded!
430 $link = HTML::img(array('src' => $url));
432 // Extract attributes
433 $arr = parse_attributes(strstr($ori_url, " "));
434 foreach ($arr as $attr => $value) {
435 // These attributes take strings: lang, id, title, alt
436 if (($attr == "lang")
438 || ($attr == "title")
439 || ($attr == "alt")) {
440 $link->setAttr($attr, $value);
442 // align = bottom|middle|top|left|right
443 elseif (($attr == "align")
444 && (($value == "bottom")
445 || ($value == "middle")
447 || ($value == "left")
448 || ($value == "right"))) {
449 $link->setAttr($attr, $value);
451 // These attributes take a number (pixels): border, hspace, vspace
452 elseif ((($attr == "border") || ($attr == "hspace") || ($attr == "vspace"))
453 && (is_numeric($value))) {
454 $link->setAttr($attr, (int)$value);
456 // These attributes take a number (pixels) or a percentage: height, width
457 elseif ((($attr == "height") || ($attr == "width"))
458 && (preg_match('/\d+[%p]?x?/', $value))) {
459 $link->setAttr($attr, $value);
461 // We allow size=50% and size=20x30
462 // We replace this with "width" and "height" HTML attributes
463 elseif ($attr == "size") {
464 if (preg_match('/(\d+%)/', $value, $m)) {
465 $link->setAttr('width',$m[1]);
466 $link->setAttr('height',$m[1]);
467 } elseif (preg_match('/(\d+)x(\d+)/', $value, $m)) {
468 $link->setAttr('width',$m[1]);
469 $link->setAttr('height',$m[2]);
473 $link = HTML::span(array('class' => 'error'),
474 sprintf(_("Invalid image attribute \"%s\" %s=%s"),
475 $url, $attr, $value));
479 // Correct silently the most common error
480 if ($url != $ori_url and empty($arr) and !preg_match("/^http/",$url)) {
481 // space belongs to the path
482 $file = NormalizeLocalFileName($ori_url);
483 if (file_exists($file)) {
484 $link = HTML::img(array('src' => $ori_url));
486 sprintf(_("Invalid image link fixed %s => %s. Spaces must be quoted with %%20."),
487 $url, $ori_url), E_USER_WARNING);
488 } elseif (string_starts_with($ori_url, getUploadDataPath())) {
489 $file = substr($file, strlen(getUploadDataPath()));
490 $path = getUploadFilePath().$file;
491 if (file_exists($path)) {
492 trigger_error(sprintf(_("Invalid image link fixed \"%s\" => \"%s\".\n Spaces must be quoted with %%20."),
493 $url, $ori_url), E_USER_WARNING);
494 $link->setAttr('src', getUploadDataPath() . $file);
499 if (!$link->getAttr('alt')) {
500 $link->setAttr('alt', $alt);
502 // Check width and height as spam countermeasure
503 if (($width = $link->getAttr('width')) and ($height = $link->getAttr('height'))) {
504 //$width = (int) $width; // px or % or other suffix
505 //$height = (int) $height;
506 if (($width < 3 and $height < 10) or
507 ($height < 3 and $width < 20) or
508 ($height < 7 and $width < 7))
510 $link = HTML::span(array('class' => 'error'),
511 _("Invalid image size"));
516 // Prepare for getimagesize($url)
517 // $url only valid for external urls, otherwise local path
518 if (DISABLE_GETIMAGESIZE)
520 elseif (! preg_match("/\.$force_img$/i", $url))
521 ; // only valid image extensions or scripts assumed to generate images
522 elseif (preg_match("/^http/",$url)) { // external url
523 $size = @getimagesize($url);
524 } else { // local file
525 if (file_exists($file = NormalizeLocalFileName($url))) { // here
526 $size = @getimagesize($file);
527 } elseif (file_exists(NormalizeLocalFileName(urldecode($url)))) {
528 $size = @getimagesize($file);
529 $link->setAttr('src', rawurldecode($url));
530 } elseif (string_starts_with($url, getUploadDataPath())) { // there
531 $file = substr($file, strlen(getUploadDataPath()));
532 $path = getUploadFilePath().rawurldecode($file);
533 $size = @getimagesize($path);
534 $link->setAttr('src', getUploadDataPath() . rawurldecode($file));
535 } else { // elsewhere
537 $size = @getimagesize($request->get('DOCUMENT_ROOT').urldecode($url));
543 if (($width < 3 and $height < 10)
544 or ($height < 3 and $width < 20)
545 or ($height < 7 and $width < 7))
547 $link = HTML::span(array('class' => 'error'),
548 _("Invalid image size"));
553 $link->setAttr('class', 'inlineimage');
555 /* Check for inlined objects. Everything allowed in INLINE_IMAGES besides
556 * png|jpg|gif|jpeg|bmp|pl|cgi. If no image it is an object to embed.
557 * Note: Allow cgi's (pl,cgi) returning images.
559 if (!preg_match("/\.(".$force_img.")/i", $url)) {
560 // HTML::img(array('src' => $url, 'alt' => $alt, 'title' => $alt));
561 // => HTML::object(array('src' => $url)) ...;
562 return ImgObject($link, $ori_url);
568 * <object> / <embed> tags instead of <img> for all non-image extensions
570 * Called by LinkImage(), not directly.
571 * Syntax: [image.svg size=50% alt=image.gif border=n align= hspace= vspace= width= height=]
572 * Samples: [Upload:song.mp3 type=audio/mpeg width=200 height=10]
573 * $alt may be an alternate img
574 * TODO: Need to unify with WikiPluginCached::embedObject()
576 * Note that Safari 1.0 will crash with <object>, so use only <embed>
577 * http://www.alleged.org.uk/pdc/2002/svg-object.html
579 * Allowed object tags:
580 * DATA=URI (object data)
581 * CLASSID=URI (location of implementation)
582 * ARCHIVE=CDATA (archive files)
583 * CODEBASE=URI (base URI for CLASSID, DATA, ARCHIVE)
584 * WIDTH=Length (object width)
585 * HEIGHT=Length (object height)
586 * NAME=CDATA (name for form submission)
587 * USEMAP=URI (client-side image map)
588 * TYPE=ContentType (content-type of object)
589 * CODETYPE=ContentType (content-type of code)
590 * STANDBY=Text (message to show while loading)
591 * TABINDEX=NUMBER (position in tabbing order)
592 * DECLARE (do not instantiate object)
593 * The rest is added as <param name="" value="" /> tags
595 function ImgObject($img, $url) {
596 // get the url args: data="sample.svgz" type="image/svg+xml" width="400" height="300"
597 $params = explode(",","data,classid,archive,codebase,name,usemap,type,".
598 "codetype,standby,tabindex,declare");
599 if (is_array($url)) {
602 foreach ($args as $attr => $value) {
603 foreach ($params as $param) {
604 if ($param == $attr) {
605 $img->setAttr($param, $value);
606 if (isset($found[$param])) $found[$param]++;
607 else $found[$param] = 1;
612 // now all remaining args are added as <param> to the object
614 foreach ($args as $attr => $value) {
615 if (!isset($found[$attr])) {
616 $params[] = HTML::param(array('name' => $attr,
620 $url = $img->getAttr('src');
621 $force_img = "png|jpg|gif|jpeg|bmp";
622 if (!preg_match("/\.(".$force_img.")/i", $url)) {
623 $img->setAttr('src', false);
626 $args = explode(' ', $url);
627 if (count($args) >= 1) {
628 $url = array_shift($args);
630 foreach ($args as $attr) {
631 foreach ($params as $param) {
632 if (preg_match("/^$param=(\S+)$/i",$attr,$m)) {
633 $img->setAttr($param, $m[1]);
634 if (isset($found[$param])) $found[$param]++;
635 else $found[$param] = 1;
640 // now all remaining args are added as <param> to the object
642 foreach ($args as $attr) {
643 if (!isset($found[$attr]) and preg_match("/^(\S+)=(\S+)$/i",$attr,$m)) {
644 $params[] = HTML::param(array('name' => $m[1],
650 $type = $img->getAttr('type');
652 // TODO: map extension to mime-types if type is not given and php < 4.3
653 if (function_exists('mime_content_type'))
654 $type = mime_content_type($url);
656 $object = HTML::object(array_merge($img->_attr,
657 array('type' => $type)), //'src' => $url
659 $object->setAttr('class', 'inlineobject');
661 foreach ($params as $param) $object->pushContent($param);
663 if (isBrowserSafari() and !isBrowserSafari(532)) { // recent chrome can do OBJECT
664 return HTML::embed($object->_attr, $object->_content);
666 $object->pushContent(HTML::embed($object->_attr));
673 // var in php5 deprecated
675 $this->items = array();
678 function push($item) {
679 $this->items[$this->size] = $item;
685 if ($this->size == 0) {
686 return false; // stack is empty
689 return $this->items[$this->size];
698 return $this->items[$this->size - 1];
704 // end class definition
706 function SplitQueryArgs ($query_args = '')
708 // FIXME: use the arg-seperator which might not be &
709 $split_args = explode('&', $query_args);
711 while (list($key, $val) = each($split_args))
712 if (preg_match('/^ ([^=]+) =? (.*) /x', $val, $m))
713 $args[$m[1]] = $m[2];
717 function LinkPhpwikiURL($url, $text = '', $basepage = false) {
720 if (!preg_match('/^ phpwiki: ([^?]*) [?]? (.*) $/x', $url, $m)) {
721 return HTML::span(array('class' => 'error'), _("BAD phpwiki: URL"));
725 $pagename = urldecode($m[1]);
728 if (empty($pagename) &&
729 preg_match('/^(diff|edit|links|info)=([^&]+)$/', $qargs, $m)) {
730 // Convert old style links (to not break diff links in
732 $pagename = urldecode($m[2]);
733 $args = array("action" => $m[1]);
736 $args = SplitQueryArgs($qargs);
739 if (empty($pagename))
740 $pagename = $GLOBALS['request']->getArg('pagename');
742 if (isset($args['action']) && $args['action'] == 'browse')
743 unset($args['action']);
746 if (empty($args['action']))
748 else if (is_safe_action($args['action']))
749 $class = 'wikiaction';
751 if (empty($args['action']) || is_safe_action($args['action']))
752 $class = 'wikiaction';
754 // Don't allow administrative links on unlocked pages.
755 $dbi = $GLOBALS['request']->getDbh();
756 $page = $dbi->getPage($basepage ? $basepage : $pagename);
757 if (!$page->get('locked'))
758 return HTML::span(array('class' => 'wikiunsafe'),
759 HTML::u(_("Lock page to enable link")));
760 $class = 'wikiadmin';
764 $text = HTML::span(array('class' => 'rawurl'), $url);
766 $wikipage = new WikiPageName($pagename);
767 if (!$wikipage->isValid()) {
769 return $WikiTheme->linkBadWikiWord($wikipage, $url);
772 return HTML::a(array('href' => WikiURL($pagename, $args),
778 * A class to assist in parsing wiki pagenames.
780 * Now with subpages and anchors, parsing and passing around
781 * pagenames is more complicated. This should help.
785 /** Short name for page.
787 * This is the value of $name passed to the constructor.
788 * (For use, e.g. as a default label for links to the page.)
792 /** The full page name.
794 * This is the full name of the page (without anchor).
800 * This is the referenced anchor within the page, or the empty string.
806 * @param mixed $name Page name.
807 * WikiDB_Page, WikiDB_PageRevision, or string.
808 * This can be a relative subpage name (like '/SubPage'),
809 * or can be the empty string to refer to the $basename.
811 * @param string $anchor For links to anchors in page.
813 * @param mixed $basename Page name from which to interpret
814 * relative or other non-fully-specified page names.
816 function WikiPageName($name, $basename=false, $anchor=false) {
817 if (is_string($name)) {
818 $this->shortName = $name;
819 if (strstr($name, ':')) {
820 list($moniker, $shortName) = explode (":", $name, 2);
821 $map = getInterwikiMap(); // allow overrides to custom maps
822 if (isset($map->_map[$moniker])) {
823 $url = $map->_map[$moniker];
824 if (strstr($url, '%s'))
825 $url = sprintf($url, $shortName);
829 // expand Talk or User, but not to absolute urls!
830 if (strstr($url, '//')) {
831 if ($moniker == 'Talk')
832 $name = $name . SUBPAGE_SEPARATOR . _("Discussion");
833 elseif ($moniker == 'User')
838 if (strstr($shortName, '?')) {
839 list($shortName, $dummy) = explode("\?", $shortName, 2);
841 $this->shortName = $shortName;
844 // FIXME: We should really fix the cause for "/PageName" in the WikiDB
845 if ($name == '' or $name[0] == SUBPAGE_SEPARATOR) {
847 $name = $this->_pagename($basename) . $name;
849 $name = $this->_normalize_bad_pagename($name);
850 $this->shortName = $name;
855 $name = $this->_pagename($name);
856 $this->shortName = $name;
859 $this->name = $this->_check($name);
860 $this->anchor = (string)$anchor;
867 function getParent() {
869 if (!($tail = strrchr($name, SUBPAGE_SEPARATOR)))
871 return substr($name, 0, -strlen($tail));
874 function isValid($strict = false) {
876 return !isset($this->_errors);
877 return (is_string($this->name) and $this->name != '');
880 function getWarnings() {
882 if (isset($this->_warnings))
883 $warnings = array_merge($warnings, $this->_warnings);
884 if (isset($this->_errors))
885 $warnings = array_merge($warnings, $this->_errors);
889 return sprintf(_("'%s': Bad page name: %s"),
890 $this->shortName, join(', ', $warnings));
893 function _pagename($page) {
894 if (isa($page, 'WikiDB_Page'))
895 return $page->getName();
896 elseif (isa($page, 'WikiDB_PageRevision'))
897 return $page->getPageName();
898 elseif (isa($page, 'WikiPageName'))
900 // '0' or e.g. '1984' should be allowed though
901 if (!is_string($page) and !is_integer($page)) {
902 trigger_error(sprintf("Non-string pagename '%s' (%s)(%s)",
903 $page, gettype($page), get_class($page)),
906 //assert(is_string($page));
910 function _normalize_bad_pagename($name) {
911 trigger_error("Bad pagename: " . $name, E_USER_WARNING);
913 // Punt... You really shouldn't get here.
916 return $request->getArg('pagename');
918 assert($name[0] == SUBPAGE_SEPARATOR);
919 $this->_errors[] = sprintf(_("Leading %s not allowed"), SUBPAGE_SEPARATOR);
920 return substr($name, 1);
924 * Compress internal white-space to single space character.
926 * This leads to problems with loading a foreign charset pagename,
927 * which cannot be deleted anymore, because unknown chars are compressed.
928 * So BEFORE importing a file _check must be done !!!
930 function _check($pagename) {
931 // Compress internal white-space to single space character.
932 $pagename = preg_replace('/[\s\xa0]+/', ' ', $orig = $pagename);
933 if ($pagename != $orig)
934 $this->_warnings[] = _("White space converted to single space");
936 // Delete any control characters.
937 if (DATABASE_TYPE == 'cvs' or DATABASE_TYPE == 'file' or DATABASE_TYPE == 'flatfile') {
938 $pagename = preg_replace('/[\x00-\x1f\x7f\x80-\x9f]/', '', $orig = $pagename);
939 if ($pagename != $orig)
940 $this->_errors[] = _("Control characters not allowed");
943 // Strip leading and trailing white-space.
944 $pagename = trim($pagename);
947 while ($pagename and $pagename[0] == SUBPAGE_SEPARATOR)
948 $pagename = substr($pagename, 1);
949 if ($pagename != $orig)
950 $this->_errors[] = sprintf(_("Leading %s not allowed"), SUBPAGE_SEPARATOR);
952 // ";" is urlencoded, so safe from php arg-delim problems
953 /*if (strstr($pagename, ';')) {
954 $this->_warnings[] = _("';' is deprecated");
955 $pagename = str_replace(';', '', $pagename);
958 // not only for SQL, also to restrict url length
959 if (strlen($pagename) > MAX_PAGENAME_LENGTH) {
960 $pagename = substr($pagename, 0, MAX_PAGENAME_LENGTH);
961 $this->_errors[] = _("too long");
964 // disallow some chars only on file and cvs
965 if ((DATABASE_TYPE == 'cvs'
966 or DATABASE_TYPE == 'file'
967 or DATABASE_TYPE == 'flatfile')
968 and preg_match('/(:|\.\.)/', $pagename, $m))
970 $this->_warnings[] = sprintf(_("Illegal chars %s removed"), $m[1]);
971 $pagename = str_replace('..', '', $pagename);
972 $pagename = str_replace(':', '', $pagename);
980 * Convert old page markup to new-style markup.
982 * @param string $text Old-style wiki markup.
984 * @param string $markup_type
986 * <dt><code>"block"</code> <dd>Convert all markup.
987 * <dt><code>"inline"</code> <dd>Convert only inline markup.
988 * <dt><code>"links"</code> <dd>Convert only link markup.
991 * @return string New-style wiki markup.
993 * @bugs Footnotes don't work quite as before (esp if there are
994 * multiple references to the same footnote. But close enough,
995 * probably for now....
996 * @bugs Apache2 and IIS crash with OldTextFormattingRules or
997 * AnciennesR%E8glesDeFormatage. (at the 2nd attempt to do the anchored block regex)
998 * It only crashes with CreateToc so far, but other pages (not in pgsrc) are
999 * also known to crash, even with Apache1.
1001 function ConvertOldMarkup ($text, $markup_type = "block") {
1007 // Trying to detect why the 2nd paragraph of OldTextFormattingRules or
1008 // AnciennesR%E8glesDeFormatage crashes.
1009 // It only crashes with CreateToc so far, but other pages (not in pgsrc) are
1010 // also known to crash, even with Apache1.
1011 $debug_skip = false;
1012 // I suspect this only to crash with Apache2 and IIS.
1013 if (in_array(php_sapi_name(),array('apache2handler','apache2filter','isapi'))
1014 and preg_match("/plugin CreateToc/", $text))
1016 trigger_error(_("The CreateTocPlugin is not yet old markup compatible! ")
1017 ._("Please remove the CreateToc line to be able to reformat this page to old markup. ")
1018 ._("Skipped."), E_USER_WARNING);
1020 //if (!DEBUG) return $text;
1025 /*****************************************************************
1026 * Conversions for inline markup:
1033 // escape escaped brackets
1037 // change ! escapes to ~'s.
1038 global $WikiNameRegexp, $request;
1039 $bang_esc[] = "(?:" . ALLOWED_PROTOCOLS . "):[^\s<>\[\]\"'()]*[^\s<>\[\]\"'(),.?]";
1040 // before 4.3.9 pcre had a memory release bug, which might hit us here. so be safe.
1041 $map = getInterwikiMap();
1042 if ($map_regex = $map->getRegexp())
1043 $bang_esc[] = $map_regex . ":[^\\s.,;?()]+"; // FIXME: is this really needed?
1044 $bang_esc[] = $WikiNameRegexp;
1045 $orig[] = '/!((?:' . join(')|(', $bang_esc) . '))/';
1048 $subs["links"] = array($orig, $repl);
1050 // Temporarily URL-encode pairs of underscores in links to hide
1051 // them from the re for bold markup.
1052 $orig[] = '/\[[^\[\]]*?__[^\[\]]*?\]/e';
1053 $repl[] = 'str_replace(\'__\', \'%5F%5F\', \'\\0\')';
1056 //$orig[] = '/<(?!\?plugin)|(?<!^)</m';
1059 // Convert footnote references.
1060 $orig[] = '/(?<=.)(?<!~)\[\s*(\d+)\s*\]/m';
1061 $repl[] = '#[|ftnt_ref_\\1]<sup>~[[\\1|#ftnt_\\1]~]</sup>';
1063 // Convert old style emphases to HTML style emphasis.
1064 $orig[] = '/__(.*?)__/';
1065 $repl[] = '<strong>\\1</strong>';
1066 $orig[] = "/''(.*?)''/";
1067 $repl[] = '<em>\\1</em>';
1069 // Escape nestled markup.
1070 $orig[] = '/^(?<=^|\s)[=_](?=\S)|(?<=\S)[=_*](?=\s|$)/m';
1073 // in old markup headings only allowed at beginning of line
1077 // Convert URL-encoded pairs of underscores in links back to
1078 // real underscores after bold markup has been converted.
1079 $orig = '/\[[^\[\]]*?%5F%5F[^\[\]]*?\]/e';
1080 $repl = 'str_replace(\'%5F%5F\', \'__\', \'\\0\')';
1082 $subs["inline"] = array($orig, $repl);
1084 /*****************************************************************
1085 * Patterns which match block markup constructs which take
1086 * special handling...
1090 $blockpats[] = '[ \t]+\S(?:.*\s*\n[ \t]+\S)*';
1092 $blockpats[] = '\|(?:.*\n\|)*';
1095 $blockpats[] = '[#*;]*(?:[*#]|;.*?:)';
1097 // Footnote definitions
1098 $blockpats[] = '\[\s*(\d+)\s*\]';
1102 $blockpats[] = '<\?plugin(?:-form)?\b.*\?>\s*$';
1106 $blockpats[] = '!{1,3}[^!]';
1108 removed .|\n in the anchor not to crash on /m because with /m "." already includes \n
1109 this breaks headings but it doesn't crash anymore (crash on non-cgi, non-cli only)
1111 $block_re = ( '/\A((?:.|\n)*?)(^(?:'
1112 . join("|", $blockpats)
1117 if ($markup_type != "block") {
1118 list ($orig, $repl) = $subs[$markup_type];
1119 return preg_replace($orig, $repl, $text);
1122 list ($orig, $repl) = $subs['inline'];
1125 // php crashes here in the 2nd paragraph of OldTextFormattingRules,
1126 // AnciennesR%E8glesDeFormatage and more
1127 // See http://www.pcre.org/pcre.txt LIMITATIONS
1128 while (preg_match($block_re, $text, $m)) {
1129 $text = substr($text, strlen($m[0]));
1130 list (,$leading_text, $block) = $m;
1133 if (strchr(" \t", $block[0])) {
1135 $prefix = "<pre>\n";
1136 $suffix = "\n</pre>\n";
1138 elseif ($block[0] == '|') {
1140 $prefix = "<?plugin OldStyleTable\n";
1143 elseif (strchr("#*;", $block[0])) {
1144 // Old-style list item
1145 preg_match('/^([#*;]*)([*#]|;.*?:) */', $block, $m);
1146 list (,$ind,$bullet) = $m;
1147 $block = substr($block, strlen($m[0]));
1149 $indent = str_repeat(' ', strlen($ind));
1150 if ($bullet[0] == ';') {
1151 //$term = ltrim(substr($bullet, 1));
1152 //return $indent . $term . "\n" . $indent . ' ';
1153 $prefix = $ind . $bullet;
1156 $prefix = $indent . $bullet . ' ';
1158 elseif ($block[0] == '[') {
1159 // Footnote definition
1160 preg_match('/^\[\s*(\d+)\s*\]/', $block, $m);
1162 $block = substr($block, strlen($m[0]));
1163 $prefix = "#[|ftnt_".${footnum}."]~[[".${footnum}."|#ftnt_ref_".${footnum}."]~] ";
1165 elseif ($block[0] == '<') {
1167 // HACK: no inline markup...
1171 elseif ($block[0] == '!') {
1173 preg_match('/^!{1,3}/', $block, $m);
1175 $block = substr($block, strlen($m[0]));
1181 if ($leading_text) $leading_text = preg_replace($orig, $repl, $leading_text);
1182 if ($block) $block = preg_replace($orig, $repl, $block);
1183 $out .= $leading_text;
1188 return $out . preg_replace($orig, $repl, $text);
1194 * Expand tabs in string.
1196 * Converts all tabs to (the appropriate number of) spaces.
1198 * @param string $str
1199 * @param integer $tab_width
1202 function expand_tabs($str, $tab_width = 8) {
1203 $split = explode("\t", $str);
1204 $tail = array_pop($split);
1206 foreach ($split as $hunk) {
1208 $pos = strlen(strrchr($expanded, "\n")) - 1;
1209 $expanded .= str_repeat(" ", ($tab_width - $pos % $tab_width));
1211 return substr($expanded, 1) . $tail;
1215 * Split WikiWords in page names.
1217 * It has been deemed useful to split WikiWords (into "Wiki Words") in
1218 * places like page titles. This is rumored to help search engines
1221 * @param $page string The page name.
1223 * @return string The split name.
1225 function SplitPagename ($page) {
1227 if (preg_match("/\s/", $page))
1228 return $page; // Already split --- don't split any more.
1230 // This algorithm is specialized for several languages.
1231 // (Thanks to Pierrick MEIGNEN)
1232 // Improvements for other languages welcome.
1235 // This mess splits between a lower-case letter followed by
1236 // either an upper-case or a numeral; except that it wont
1237 // split the prefixes 'Mc', 'De', or 'Di' off of their tails.
1238 switch ($GLOBALS['LANG']) {
1243 $RE[] = '/([[:lower:]])((?<!Mc|De|Di)[[:upper:]]|\d)/';
1246 $RE[] = '/([[:lower:]])((?<!Mc|Di)[[:upper:]]|\d)/';
1249 $sep = preg_quote(SUBPAGE_SEPARATOR, '/');
1250 // This the single-letter words 'I' and 'A' from any following
1251 // capitalized words.
1252 switch ($GLOBALS['LANG']) {
1254 $RE[] = "/(?<= |${sep}|^)([AI])([[:upper:]][[:lower:]])/";
1257 $RE[] = "/(?<= |${sep}|^)([À])([[:upper:]][[:lower:]])/";
1260 // Split at underscore
1261 $RE[] = '/(_)([[:alpha:]])/';
1262 $RE[] = '/([[:alpha:]])(_)/';
1263 // Split numerals from following letters.
1264 $RE[] = '/(\d)([[:alpha:]])/';
1265 // Split at subpage seperators. TBD in WikiTheme.php
1266 $RE[] = "/([^${sep}]+)(${sep})/";
1267 $RE[] = "/(${sep})([^${sep}]+)/";
1269 foreach ($RE as $key)
1273 foreach ($RE as $regexp) {
1274 $page = preg_replace($regexp, '\\1 \\2', $page);
1279 function NoSuchRevision (&$request, $page, $version) {
1280 $html = HTML(HTML::h2(_("Revision Not Found")),
1281 HTML::p(fmt("I'm sorry. Version %d of %s is not in the database.",
1282 $version, WikiLink($page, 'auto'))));
1283 include_once('lib/Template.php');
1284 GeneratePage($html, _("Bad Version"), $page->getCurrentRevision());
1290 * Get time offset for local time zone.
1292 * @param $time time_t Get offset for this time. Default: now.
1293 * @param $no_colon boolean Don't put colon between hours and minutes.
1294 * @return string Offset as a string in the format +HH:MM.
1296 function TimezoneOffset ($time = false, $no_colon = false) {
1297 if ($time === false)
1299 $secs = date('Z', $time);
1308 $colon = $no_colon ? '' : ':';
1309 $mins = intval(($secs + 30) / 60);
1310 return sprintf("%s%02d%s%02d",
1311 $sign, $mins / 60, $colon, $mins % 60);
1316 * Format time in ISO-8601 format.
1318 * @param $time time_t Time. Default: now.
1319 * @return string Date and time in ISO-8601 format.
1321 function Iso8601DateTime ($time = false) {
1322 if ($time === false)
1324 $tzoff = TimezoneOffset($time);
1325 $date = date('Y-m-d', $time);
1326 $time = date('H:i:s', $time);
1327 return $date . 'T' . $time . $tzoff;
1331 * Format time in RFC-2822 format.
1333 * @param $time time_t Time. Default: now.
1334 * @return string Date and time in RFC-2822 format.
1336 function Rfc2822DateTime ($time = false) {
1337 if ($time === false)
1339 return date('D, j M Y H:i:s ', $time) . TimezoneOffset($time, 'no colon');
1343 * Format time in RFC-1123 format.
1345 * @param $time time_t Time. Default: now.
1346 * @return string Date and time in RFC-1123 format.
1348 function Rfc1123DateTime ($time = false) {
1349 if ($time === false)
1351 return gmdate('D, d M Y H:i:s \G\M\T', $time);
1354 /** Parse date in RFC-1123 format.
1356 * According to RFC 1123 we must accept dates in the following
1359 * Sun, 06 Nov 1994 08:49:37 GMT ; RFC 822, updated by RFC 1123
1360 * Sunday, 06-Nov-94 08:49:37 GMT ; RFC 850, obsoleted by RFC 1036
1361 * Sun Nov 6 08:49:37 1994 ; ANSI C's asctime() format
1363 * (Though we're only allowed to generate dates in the first format.)
1365 function ParseRfc1123DateTime ($timestr) {
1366 $timestr = trim($timestr);
1367 if (preg_match('/^ \w{3},\s* (\d{1,2}) \s* (\w{3}) \s* (\d{4}) \s*'
1368 .'(\d\d):(\d\d):(\d\d) \s* GMT $/ix',
1370 list(, $mday, $mon, $year, $hh, $mm, $ss) = $m;
1372 elseif (preg_match('/^ \w+,\s* (\d{1,2})-(\w{3})-(\d{2}|\d{4}) \s*'
1373 .'(\d\d):(\d\d):(\d\d) \s* GMT $/ix',
1375 list(, $mday, $mon, $year, $hh, $mm, $ss) = $m;
1376 if ($year < 70) $year += 2000;
1377 elseif ($year < 100) $year += 1900;
1379 elseif (preg_match('/^\w+\s* (\w{3}) \s* (\d{1,2}) \s*'
1380 .'(\d\d):(\d\d):(\d\d) \s* (\d{4})$/ix',
1382 list(, $mon, $mday, $hh, $mm, $ss, $year) = $m;
1389 $time = strtotime("$mday $mon $year ${hh}:${mm}:${ss} GMT");
1391 return false; // failed
1396 * Format time to standard 'ctime' format.
1398 * @param $time time_t Time. Default: now.
1399 * @return string Date and time.
1401 function CTime ($time = false)
1403 if ($time === false)
1405 return date("D M j H:i:s Y", $time);
1410 * Format number as kilobytes or bytes.
1411 * Short format is used for PageList
1412 * Long format is used in PageInfo
1414 * @param $bytes int. Default: 0.
1415 * @param $longformat bool. Default: false.
1416 * @return class FormattedText (XmlElement.php).
1418 function ByteFormatter ($bytes = 0, $longformat = false) {
1421 if ($bytes < 1024) {
1423 $size = fmt("%s b", $bytes);
1425 $size = fmt("%s bytes", $bytes);
1428 $kb = round($bytes / 1024, 1);
1430 $size = fmt("%s k", $kb);
1432 $size = fmt("%s Kb (%s bytes)", $kb, $bytes);
1438 * Internationalized printf.
1440 * This is essentially the same as PHP's built-in printf
1441 * with the following exceptions:
1443 * <li> It passes the format string through gettext().
1444 * <li> It supports the argument reordering extensions.
1451 * __printf("Differences between versions %s and %s of %s",
1452 * $new_link, $old_link, $page_link);
1455 * Then in locale/po/de.po, one can reorder the printf arguments:
1458 * msgid "Differences between %s and %s of %s."
1459 * msgstr "Der Unterschiedsergebnis von %3$s, zwischen %1$s und %2$s."
1462 * (Note that while PHP tries to expand $vars within double-quotes,
1463 * the values in msgstr undergo no such expansion, so the '$'s
1466 * One shouldn't use reordered arguments in the default format string.
1467 * Backslashes in the default string would be necessary to escape the
1468 * '$'s, and they'll cause all kinds of trouble....
1470 function __printf ($fmt) {
1471 $args = func_get_args();
1473 echo __vsprintf($fmt, $args);
1477 * Internationalized sprintf.
1479 * This is essentially the same as PHP's built-in printf with the
1480 * following exceptions:
1483 * <li> It passes the format string through gettext().
1484 * <li> It supports the argument reordering extensions.
1489 function __sprintf ($fmt) {
1490 $args = func_get_args();
1492 return __vsprintf($fmt, $args);
1496 * Internationalized vsprintf.
1498 * This is essentially the same as PHP's built-in printf with the
1499 * following exceptions:
1502 * <li> It passes the format string through gettext().
1503 * <li> It supports the argument reordering extensions.
1508 function __vsprintf ($fmt, $args) {
1509 $fmt = gettext($fmt);
1510 // PHP's sprintf doesn't support variable with specifiers,
1511 // like sprintf("%*s", 10, "x"); --- so we won't either.
1513 if (preg_match_all('/(?<!%)%(\d+)\$/x', $fmt, $m)) {
1514 // Format string has '%2$s' style argument reordering.
1515 // PHP doesn't support this.
1516 if (preg_match('/(?<!%)%[- ]?\d*[^- \d$]/x', $fmt))
1517 // literal variable name substitution only to keep locale
1518 // strings uncluttered
1519 trigger_error(sprintf(_("Can't mix '%s' with '%s' type format strings"),
1520 '%1\$s','%s'), E_USER_WARNING); //php+locale error
1522 $fmt = preg_replace('/(?<!%)%\d+\$/x', '%', $fmt);
1525 // Reorder arguments appropriately.
1526 foreach($m[1] as $argnum) {
1527 if ($argnum < 1 || $argnum > count($args))
1528 trigger_error(sprintf(_("%s: argument index out of range"),
1529 $argnum), E_USER_WARNING);
1530 $newargs[] = $args[$argnum - 1];
1535 // Not all PHP's have vsprintf, so...
1536 array_unshift($args, $fmt);
1537 return call_user_func_array('sprintf', $args);
1540 function file_mtime ($filename) {
1541 if ($stat = @stat($filename))
1547 function sort_file_mtime ($a, $b) {
1548 $ma = file_mtime($a);
1549 $mb = file_mtime($b);
1550 if (!$ma or !$mb or $ma == $mb) return 0;
1551 return ($ma > $mb) ? -1 : 1;
1556 * Build an array in $this->_fileList of files from $dirname.
1557 * Subdirectories are not traversed.
1559 * (This was a function LoadDir in lib/loadsave.php)
1560 * See also http://www.php.net/manual/en/function.readdir.php
1562 function getFiles($exclude='', $sortby='', $limit='') {
1563 $list = $this->_fileList;
1566 require_once('lib/PageList.php');
1567 switch (Pagelist::sortby($sortby, 'db')) {
1568 case 'pagename ASC': break;
1569 case 'pagename DESC':
1570 $list = array_reverse($list);
1573 usort($list,'sort_file_mtime');
1576 usort($list,'sort_file_mtime');
1577 $list = array_reverse($list);
1582 return array_splice($list, 0, $limit);
1586 function _filenameSelector($filename) {
1587 if (! $this->_pattern )
1590 if (! $this->_pcre_pattern )
1591 $this->_pcre_pattern = glob_to_pcre($this->_pattern);
1592 return preg_match('/' . $this->_pcre_pattern . ($this->_case ? '/' : '/i'),
1597 function fileSet($directory, $filepattern = false) {
1598 $this->_fileList = array();
1599 $this->_pattern = $filepattern;
1601 $this->_pcre_pattern = glob_to_pcre($this->_pattern);
1603 $this->_case = !isWindows();
1604 $this->_pathsep = '/';
1606 if (empty($directory)) {
1607 trigger_error(sprintf(_("%s is empty."), 'directoryname'),
1609 return; // early return
1612 @ $dir_handle = opendir($dir=$directory);
1613 if (empty($dir_handle)) {
1614 trigger_error(sprintf(_("Unable to open directory '%s' for reading"),
1615 $dir), E_USER_NOTICE);
1616 return; // early return
1619 while ($filename = readdir($dir_handle)) {
1620 if ($filename[0] == '.' || filetype($dir . $this->_pathsep . $filename) != 'file')
1622 if ($this->_filenameSelector($filename)) {
1623 array_push($this->_fileList, "$filename");
1624 //trigger_error(sprintf(_("found file %s"), $filename),
1625 // E_USER_NOTICE); //debugging
1628 closedir($dir_handle);
1634 // expands a list containing regex's to its matching entries
1635 class ListRegexExpand {
1636 //var $match, $list, $index, $case_sensitive;
1637 function ListRegexExpand (&$list, $match, $case_sensitive = true) {
1638 $this->match = $match;
1639 $this->list = &$list;
1640 $this->case_sensitive = $case_sensitive;
1641 //$this->index = false;
1643 function listMatchCallback ($item, $key) {
1644 $quoted = str_replace('/','\/',$item);
1645 if (preg_match('/' . $this->match . ($this->case_sensitive ? '/' : '/i'),
1647 unset($this->list[$this->index]);
1648 $this->list[] = $item;
1651 function expandRegex ($index, &$pages) {
1652 $this->index = $index;
1653 array_walk($pages, array($this, 'listMatchCallback'));
1658 // Convert fileglob to regex style:
1659 // Convert some wildcards to pcre style, escape the rest
1660 // Escape . \\ + * ? [ ^ ] $ ( ) { } = ! < > | : /
1661 // Fixed bug #994994: "/" in $glob.
1662 function glob_to_pcre ($glob) {
1663 // check simple case: no need to escape
1664 $escape = '\[](){}=!<>|:/';
1665 if (strcspn($glob, $escape . ".+*?^$") == strlen($glob))
1667 // preg_replace cannot handle "\\\\\\2" so convert \\ to \xff
1668 $glob = strtr($glob, "\\", "\xff");
1669 $glob = str_replace("/", "\\/", $glob);
1670 // first convert some unescaped expressions to pcre style: . => \.
1672 $re = preg_replace('/([^\xff])?(['.preg_quote($special).'])/',
1673 "\\1\xff\\2", $glob);
1676 $re = preg_replace('/([^\xff])?\*/', '$1.*', $re);
1677 $re = preg_replace('/([^\xff])?\?/', '$1.', $re);
1678 if (!preg_match('/^[\?\*]/', $glob))
1680 if (!preg_match('/[\?\*]$/', $glob))
1683 // Fixes Bug 1182997
1684 // .*? handled above, now escape the rest
1685 //while (strcspn($re, $escape) != strlen($re)) // loop strangely needed
1686 $re = preg_replace('/([^\xff])(['.preg_quote($escape, "/").'])/',
1688 // Problem with 'Date/Time' => 'Date\/Time' => 'Date\xff\/Time' => 'Date\/Time'
1690 $re = preg_replace('/\xff/', '', $re);
1694 function glob_match ($glob, $against, $case_sensitive = true) {
1695 return preg_match('/' . glob_to_pcre($glob) . ($case_sensitive ? '/' : '/i'),
1699 function explodeList($input, $allnames, $glob_style = true, $case_sensitive = true) {
1700 $list = explode(',',$input);
1701 // expand wildcards from list of $allnames
1702 if (preg_match('/[\?\*]/',$input)) {
1703 // Optimizing loop invariants:
1704 // http://phplens.com/lens/php-book/optimizing-debugging-php.php
1705 for ($i = 0, $max = sizeof($list); $i < $max; $i++) {
1707 if (preg_match('/[\?\*]/',$f)) {
1709 $expand = new ListRegexExpand($list,
1710 $glob_style ? glob_to_pcre($f) : $f, $case_sensitive);
1711 $expand->expandRegex($i, $allnames);
1718 // echo implode(":",explodeList("Test*",array("xx","Test1","Test2")));
1719 function explodePageList($input, $include_empty=false, $sortby='pagename',
1720 $limit='', $exclude='') {
1721 include_once("lib/PageList.php");
1722 return PageList::explodePageList($input, $include_empty, $sortby, $limit, $exclude);
1725 // Class introspections
1728 * Determine whether object is of a specified type.
1729 * In PHP builtin since 4.2.0 as is_a()
1730 * is_a() deprecated in PHP 5, in favor of instanceof operator
1732 * @param $object object An object.
1733 * @param $class string Class name.
1734 * @return bool True iff $object is a $class
1735 * or a sub-type of $class.
1737 function isa ($object, $class) {
1738 //if (check_php_version(5))
1739 // return $object instanceof $class;
1740 if (!check_php_version(5))
1741 return is_a($object, $class);
1743 $lclass = check_php_version(5) ? $class : strtolower($class);
1744 return is_object($object)
1745 && ( strtolower(get_class($object)) == strtolower($class)
1746 || is_subclass_of($object, $lclass) );
1749 /** Determine whether a function is okay to use.
1751 * Some providers (e.g. Lycos) disable some of PHP functions for
1752 * "security reasons." This makes those functions, of course,
1753 * unusable, despite the fact the function_exists() says they
1756 * This function test to see if a function exists and is not
1757 * disallowed by PHP's disable_functions config setting.
1759 * @param string $function_name Function name
1760 * @return bool True iff function can be used.
1762 function function_usable($function_name) {
1764 if (!is_array($disabled)) {
1765 $disabled = array();
1766 // Use get_cfg_var since ini_get() is one of the disabled functions
1767 // (on Lycos, at least.)
1768 $split = preg_split('/\s*,\s*/', trim(get_cfg_var('disable_functions')));
1769 foreach ($split as $f)
1770 $disabled[strtolower($f)] = true;
1773 return ( function_exists($function_name)
1774 and ! isset($disabled[strtolower($function_name)])
1781 * This is used for generating ETags.
1783 function wikihash ($x) {
1784 if (is_scalar($x)) {
1787 elseif (is_array($x)) {
1789 return md5(serialize($x));
1791 elseif (is_object($x)) {
1794 trigger_error("Can't hash $x", E_USER_ERROR);
1799 * Seed the random number generator.
1801 * better_srand() ensures the randomizer is seeded only once.
1803 * How random do you want it? See:
1804 * http://www.php.net/manual/en/function.srand.php
1805 * http://www.php.net/manual/en/function.mt-srand.php
1807 function better_srand($seed = '') {
1808 static $wascalled = FALSE;
1810 $seed = $seed === '' ? (double) microtime() * 1000000 : $seed;
1811 function_exists('mt_srand') ? mt_srand($seed) : srand($seed);
1813 //trigger_error("new random seed", E_USER_NOTICE); //debugging
1817 function rand_ascii($length = 1) {
1820 for ($i = 1; $i <= $length; $i++) {
1821 // return only typeable 7 bit ascii, avoid quotes
1822 if (function_exists('mt_rand'))
1823 $s .= chr(mt_rand(40, 126));
1825 // the usually bad glibc srand()
1826 $s .= chr(rand(40, 126));
1831 /* by Dan Frankowski.
1833 function rand_ascii_readable ($length = 6) {
1834 // Pick a few random letters or numbers
1837 // Don't use 1lI0O, because they're hard to read
1838 $letters = "abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789";
1839 $letter_len = strlen($letters);
1840 for ($i=0; $i < $length; $i++) {
1841 if (function_exists('mt_rand'))
1842 $word .= $letters[mt_rand(0, $letter_len-1)];
1844 $word .= $letters[rand(0, $letter_len-1)];
1850 * Recursively count all non-empty elements
1851 * in array of any dimension or mixed - i.e.
1852 * array('1' => 2, '2' => array('1' => 3, '2' => 4))
1853 * See http://www.php.net/manual/en/function.count.php
1855 function count_all($arg) {
1856 // skip if argument is empty
1858 //print_r($arg); //debugging
1860 // not an array, return 1 (base case)
1863 // else call recursively for all elements $arg
1864 foreach($arg as $key => $val)
1865 $count += count_all($val);
1870 function isSubPage($pagename) {
1871 return (strstr($pagename, SUBPAGE_SEPARATOR));
1874 function subPageSlice($pagename, $pos) {
1875 $pages = explode(SUBPAGE_SEPARATOR,$pagename);
1876 $pages = array_slice($pages,$pos,1);
1880 function isActionPage($filename) {
1882 global $AllActionPages;
1884 return (in_array($filename, $AllActionPages));
1890 * Class for "popping up" and alert box. (Except that right now, it doesn't
1894 * This is a hackish and needs to be refactored. However it would be nice to
1895 * unify all the different methods we use for showing Alerts and Dialogs.
1896 * (E.g. "Page deleted", login form, ...)
1901 * @param object $request
1902 * @param mixed $head Header ("title") for alert box.
1903 * @param mixed $body The text in the alert box.
1904 * @param hash $buttons An array mapping button labels to URLs.
1905 * The default is a single "Okay" button pointing to $request->getURLtoSelf().
1907 function Alert($head, $body, $buttons=false) {
1908 if ($buttons === false)
1911 if (is_array($body)) {
1913 foreach ($body as $li) {
1914 $html->pushContent(HTML::li($li));
1918 $this->_tokens = array('HEADER' => $head, 'CONTENT' => $body);
1919 $this->_buttons = $buttons;
1923 * Show the alert box.
1928 $tokens = $this->_tokens;
1929 $tokens['BUTTONS'] = $this->_getButtons();
1931 $request->discardOutput();
1932 $tmpl = new Template('dialog', $request, $tokens);
1938 function _getButtons() {
1941 $buttons = $this->_buttons;
1943 $buttons = array(_("Okay") => $request->getURLtoSelf());
1946 foreach ($buttons as $label => $url)
1947 print "$label $url\n";
1948 $out[] = $WikiTheme->makeButton($label, $url, 'wikiaction');
1949 return new XmlContent($out);
1954 // 1.3.9-p1 => 1030.091
1955 // 1.3.10pre => 1030.099
1956 // 1.3.11pre-20041120 => 1030.1120041120
1957 // 1.3.12-rc1 => 1030.119
1958 function phpwiki_version() {
1959 static $PHPWIKI_VERSION;
1960 if (!isset($PHPWIKI_VERSION)) {
1961 $arr = explode('.',preg_replace('/\D+$/','', PHPWIKI_VERSION)); // remove the pre
1962 $arr[2] = preg_replace('/\.+/','.',preg_replace('/\D/','.',$arr[2]));
1963 $PHPWIKI_VERSION = $arr[0]*1000 + $arr[1]*10 + 0.01*$arr[2];
1964 if (strstr(PHPWIKI_VERSION, 'pre') or strstr(PHPWIKI_VERSION, 'rc'))
1965 $PHPWIKI_VERSION -= 0.01;
1967 return $PHPWIKI_VERSION;
1970 function phpwiki_gzhandler($ob) {
1971 if (function_exists('gzencode'))
1972 $ob = gzencode($ob);
1973 $GLOBALS['request']->_ob_get_length = strlen($ob);
1974 if (!headers_sent()) {
1975 header(sprintf("Content-Length: %d", $GLOBALS['request']->_ob_get_length));
1980 function isWikiWord($word) {
1981 global $WikiNameRegexp;
1982 //or preg_match('/\A' . $WikiNameRegexp . '\z/', $word) ??
1983 return preg_match("/^$WikiNameRegexp\$/",$word);
1986 // needed to store serialized objects-values only (perm, pref)
1987 function obj2hash ($obj, $exclude = false, $fields = false) {
1989 if (! $fields ) $fields = get_object_vars($obj);
1990 foreach ($fields as $key => $val) {
1991 if (is_array($exclude)) {
1992 if (in_array($key, $exclude)) continue;
2000 * isAsciiString($string)
2002 function isAsciiString($s) {
2003 $ptrASCII = '[\x00-\x7F]';
2004 return preg_match("/^($ptrASCII)*$/s", $s);
2008 * isUtf8String($string) - cheap utf-8 detection
2010 * segfaults for strings longer than 10kb!
2011 * Use http://www.phpdiscuss.com/article.php?id=565&group=php.i18n or
2012 * checkTitleEncoding() at http://cvs.sourceforge.net/viewcvs.py/wikipedia/phase3/languages/Language.php
2014 function isUtf8String( $s ) {
2015 $ptrASCII = '[\x00-\x7F]';
2016 $ptr2Octet = '[\xC2-\xDF][\x80-\xBF]';
2017 $ptr3Octet = '[\xE0-\xEF][\x80-\xBF]{2}';
2018 $ptr4Octet = '[\xF0-\xF4][\x80-\xBF]{3}';
2019 $ptr5Octet = '[\xF8-\xFB][\x80-\xBF]{4}';
2020 $ptr6Octet = '[\xFC-\xFD][\x80-\xBF]{5}';
2021 return preg_match("/^($ptrASCII|$ptr2Octet|$ptr3Octet|$ptr4Octet|$ptr5Octet|$ptr6Octet)*$/s", $s);
2025 * Check for UTF-8 URLs; Internet Explorer produces these if you
2026 * type non-ASCII chars in the URL bar or follow unescaped links.
2027 * Requires urldecoded pagename.
2028 * Fixes sf.net bug #953949
2030 * src: languages/Language.php:checkTitleEncoding() from mediawiki
2032 function fixTitleEncoding( $s ) {
2037 if (empty($s)) return $s;
2039 $ishigh = preg_match( '/[\x80-\xff]/', $s);
2041 $isutf = ($ishigh ? preg_match( '/^([\x00-\x7f]|[\xc0-\xdf][\x80-\xbf]|' .
2042 '[\xe0-\xef][\x80-\xbf]{2}|[\xf0-\xf7][\x80-\xbf]{3})+$/', $s ) : true );
2044 $isutf = ($ishigh ? isUtf8String($s) : true);
2045 $locharset = strtolower($charset);
2047 if( $locharset != "utf-8" and $ishigh and $isutf )
2048 $s = charset_convert('UTF-8', $locharset, $s);
2049 if ($locharset == "utf-8" and $ishigh and !$isutf )
2050 return utf8_encode( $s );
2052 // Other languages can safely leave this function, or replace
2053 // it with one to detect and convert another legacy encoding.
2058 * MySQL fulltext index doesn't grok utf-8, so we
2059 * need to fold cases and convert to hex.
2060 * src: languages/Language.php:stripForSearch() from mediawiki
2063 function stripForSearch( $string ) {
2064 global $wikiLowerChars;
2065 // '/(?:[a-z]|\xc3[\x9f-\xbf]|\xc4[\x81\x83\x85\x87])/' => "a-z\xdf-\xf6\xf8-\xff"
2066 return preg_replace(
2067 "/([\\xc0-\\xff][\\x80-\\xbf]*)/e",
2068 "'U8' . bin2hex( strtr( \"\$1\", \$wikiLowerChars ) )",
2074 * Workaround for allow_url_fopen, to get the content of an external URI.
2075 * It returns the contents in one slurp. Parsers might want to check for allow_url_fopen
2076 * and use fopen, fread chunkwise. (see lib/XmlParser.php)
2078 function url_get_contents( $uri ) {
2079 if (get_cfg_var('allow_url_fopen')) { // was ini_get('allow_url_fopen'))
2080 return @file_get_contents($uri);
2082 require_once("lib/HttpClient.php");
2083 $bits = parse_url($uri);
2084 $host = $bits['host'];
2085 $port = isset($bits['port']) ? $bits['port'] : 80;
2086 $path = isset($bits['path']) ? $bits['path'] : '/';
2087 if (isset($bits['query'])) {
2088 $path .= '?'.$bits['query'];
2090 $client = new HttpClient($host, $port);
2091 $client->use_gzip = false;
2092 if (!$client->get($path)) {
2095 return $client->getContent();
2101 * Generate consecutively named strings:
2102 * Name, Name2, Name3, ...
2104 function GenerateId($name) {
2105 static $ids = array();
2106 if (empty($ids[$name])) {
2111 return $name . $ids[$name];
2115 // from IncludePage. To be of general use.
2116 // content: string or array of strings
2117 function firstNWordsOfContent( $n, $content ) {
2118 if ($content and $n > 0) {
2119 if (is_array($content)) {
2120 // fixme: return a list of lines then?
2121 //$content = join("\n", $content);
2122 //$return_array = true;
2124 foreach ($content as $line) {
2125 $words = explode(' ', $line);
2126 if ($wordcount + count($words) > $n) {
2127 $new[] = implode(' ', array_slice($words, 0, $n - $wordcount))
2128 . sprintf(_("... (first %s words)"), $n);
2131 $wordcount += count($words);
2137 // fixme: use better whitespace/word seperators
2138 $words = explode(' ', $content);
2139 if (count($words) > $n) {
2140 return join(' ', array_slice($words, 0, $n))
2141 . sprintf(_("... (first %s words)"), $n);
2151 // moved from lib/plugin/IncludePage.php
2152 function extractSection ($section, $content, $page, $quiet = false, $sectionhead = false) {
2153 $qsection = preg_replace('/\s+/', '\s+', preg_quote($section, '/'));
2155 if (preg_match("/ ^(!{1,}|={2,})\\s*$qsection\s*=*" // section header
2156 . " \\s*$\\n?" // possible blank lines
2157 . " ( (?: ^.*\\n? )*? )" // some lines
2158 . " (?= ^\\1 | \\Z)/xm", // sec header (same or higher level) (or EOF)
2159 implode("\n", $content),
2161 // Strip trailing blanks lines and ---- <hr>s
2162 $text = preg_replace("/\\s*^-{4,}\\s*$/m", "", $match[2]);
2164 $text = $match[1] . $section ."\n". $text;
2165 return explode("\n", $text);
2168 $mesg = $page ." ". $section;
2171 return array(sprintf(_("<%s: no such section>"), $mesg));
2174 // Extract the first $sections sections of the page
2175 function extractSections ($sections, $content, $page, $quiet = false, $sectionhead = false) {
2177 $mycontent = $content;
2180 while ($sections > 0) {
2182 if (preg_match("/ ^(!{1,}|={2,})\\s*(.*)\\n" // section header
2183 . " \\s*$\\n?" // possible blank lines
2184 . " ( (?: ^.*\\n? )*? )" // some lines
2185 . " ( ^\\1 (.|\\n)* | \\Z)/xm", // sec header (same or higher level) (or EOF)
2186 implode("\n", $mycontent),
2188 $section = $match[2];
2189 // Strip trailing blanks lines and ---- <hr>s
2190 $text = preg_replace("/\\s*^-{4,}\\s*$/m", "", $match[3]);
2192 $text = $match[1] . $section ."\n". $text;
2195 $mycontent = explode("\n", $match[4]);
2197 if ($sections === 0) {
2198 return explode("\n", $result);
2204 // use this faster version: only load ExternalReferrer if we came from an external referrer
2205 function isExternalReferrer(&$request) {
2206 if ($referrer = $request->get('HTTP_REFERER')) {
2207 $home = SERVER_URL; // SERVER_URL or SCRIPT_NAME, if we want to check sister wiki's also
2208 if (string_starts_with(strtolower($referrer), strtolower($home))) return false;
2209 require_once("lib/ExternalReferrer.php");
2210 $se = new SearchEngines();
2211 return $se->parseSearchQuery($referrer);
2213 //if (DEBUG) return array('query' => 'wiki');
2218 * Useful for PECL overrides: cvsclient, ldap, soap, xmlrpc, pdo, pdo_<driver>
2220 function loadPhpExtension($extension) {
2221 if (!extension_loaded($extension)) {
2222 $isWindows = (substr(PHP_OS,0,3) == 'WIN');
2223 $soname = ($isWindows ? 'php_' : '')
2225 . ($isWindows ? '.dll' : '.so');
2229 return extension_loaded($extension);
2232 function charset_convert($from, $to, $data) {
2234 //$wikicharset = strtolower($CHARSET);
2235 //$systemcharset = strtolower(get_cfg_var('iconv.internal_encoding')); // 'iso-8859-1';
2236 if (strtolower($from) == 'utf-8' and strtolower($to) == 'iso-8859-1')
2237 return utf8_decode($data);
2238 if (strtolower($to) == 'utf-8' and strtolower($from) == 'iso-8859-1')
2239 return utf8_encode($data);
2241 if (loadPhpExtension("iconv")) {
2242 $tmpdata = iconv($from, $to, $data);
2244 trigger_error("charset conversion $from => $to failed. Wrong source charset?", E_USER_WARNING);
2248 trigger_error("The iconv extension cannot be loaded", E_USER_WARNING);
2253 function string_starts_with($string, $prefix) {
2254 return (substr($string, 0, strlen($prefix)) == $prefix);
2256 function string_ends_with($string, $suffix) {
2257 return (substr($string, -strlen($suffix)) == $suffix);
2259 function array_remove($arr,$value) {
2260 return array_values(array_diff($arr,array($value)));
2264 * Ensure that the script will have another $secs time left.
2265 * Works only if safe_mode is off.
2266 * For example not to timeout on waiting socket connections.
2267 * Use the socket timeout as arg.
2269 function longer_timeout($secs = 30) {
2270 $timeout = @ini_get("max_execution_time") ? ini_get("max_execution_time") : 30;
2271 $timeleft = $timeout - $GLOBALS['RUNTIMER']->getTime();
2272 if ($timeleft < $secs)
2273 @set_time_limit(max($timeout,(integer)($secs + $timeleft)));
2276 function printSimpleTrace($bt) {
2278 echo "\nTraceback:\n";
2279 if (function_exists('debug_print_backtrace')) { // >= 5
2280 debug_print_backtrace();
2282 foreach ($bt as $i => $elem) {
2283 if (!array_key_exists('file', $elem)) {
2286 //echo join(" ",array_values($elem)),"\n";
2287 echo " ",$elem['file'],':',$elem['line']," ",$elem['function'],"\n";
2293 * Return the used process memory, in bytes.
2294 * Enable the section which will work for you. They are very slow.
2295 * Special quirks for Windows: Requires cygwin.
2297 function getMemoryUsage() {
2298 //if (!(DEBUG & _DEBUG_VERBOSE)) return;
2299 if (function_exists('memory_get_usage') and memory_get_usage()) {
2300 return memory_get_usage();
2301 } elseif (function_exists('getrusage') and ($u = @getrusage()) and !empty($u['ru_maxrss'])) {
2302 $mem = $u['ru_maxrss'];
2303 } elseif (substr(PHP_OS,0,3) == 'WIN') { // may require a newer cygwin
2304 // what we want is the process memory only: apache or php (if CGI)
2307 // win32_ps_stat_proc, win32_ps_stat_mem
2308 if (function_exists('win32_ps_list_procs')) {
2309 $info = win32_ps_stat_proc($pid);
2310 $memstr = $info['mem']['working_set_size'];
2312 // This works only if it's a cygwin process (apache or php).
2313 // Requires a newer cygwin
2314 $memstr = exec("cat /proc/$pid/statm |cut -f1");
2316 // if it's native windows use something like this:
2317 // (requires pslist from sysinternals.com, grep, sed and perl)
2318 //$memstr = exec("pslist $pid|grep -A1 Mem|sed 1d|perl -ane\"print \$"."F[5]\"");
2320 return (integer) trim($memstr);
2323 //%MEM: Percentage of total memory in use by this process
2324 //VSZ: Total virtual memory size, in 1K blocks.
2325 //RSS: Real Set Size, the actual amount of physical memory allocated to this process.
2326 //CPU time used by process since it started.
2327 //echo "%",`ps -o%mem,vsz,rss,time -p $pid|sed 1d`,"\n";
2328 $memstr = exec("ps -orss -p $pid|sed 1d");
2329 return (integer) trim($memstr);
2334 * @param var $needle
2335 * @param array $haystack one-dimensional numeric array only, no hash
2337 * @desc Feed a sorted array to $haystack and a value to search for to $needle.
2338 It will return false if not found or the index where it was found.
2339 From dennis.decoene@moveit.be http://www.php.net/array_search
2341 function binary_search($needle, $haystack) {
2342 $high = count($haystack);
2345 while (($high - $low) > 1) {
2346 $probe = floor(($high + $low) / 2);
2347 if ($haystack[$probe] < $needle) {
2349 } elseif ($haystack[$probe] == $needle) {
2350 $high = $low = $probe;
2356 if ($high == count($haystack) || $haystack[$high] != $needle) {
2363 function is_localhost($url = false) {
2365 global $HTTP_SERVER_VARS;
2366 return $HTTP_SERVER_VARS['SERVER_ADDR'] == '127.0.0.1';
2371 * Take a string and quote it sufficiently to be passed as a Javascript
2372 * string between ''s
2374 function javascript_quote_string($s) {
2375 return str_replace("'", "\'", $s);
2378 function isSerialized($s) {
2379 return (!empty($s) and (strlen($s) > 3) and (substr($s,1,1) == ':'));
2383 * Take a string and return an array of pairs (attribute name, attribute value)
2385 * We allow attributes with or without double quotes (")
2386 * Attribute-value pairs may be separated by space or comma
2387 * Space is normal HTML attributes, comma is for RichTable compatibility
2388 * border=1, cellpadding="5"
2389 * border=1 cellpadding="5"
2390 * style="font-family: sans-serif; border-top:1px solid #dddddd;"
2391 * style="font-family: Verdana, Arial, Helvetica, sans-serif"
2393 function parse_attributes($line) {
2397 if (empty($line)) return $options;
2398 $line = trim($line);
2399 if (empty($line)) return $options;
2400 $line = trim($line, ",");
2401 if (empty($line)) return $options;
2403 // First we have an attribute name.
2408 while (($i < strlen($line)) && ($line[$i] != '=')) {
2411 $attribute = substr($line, 0, $i);
2412 $attribute = strtolower($attribute);
2414 $line = substr($line, $i+1);
2415 $line = trim ($line);
2416 $line = trim ($line, "=");
2417 $line = trim ($line);
2419 if (empty($line)) return $options;
2421 // Then we have the attribute value.
2424 // Attribute value might be between double quotes
2425 // In that case we have to find the closing double quote
2426 if ($line[0] == '"') {
2427 $i++; // skip first '"'
2428 while (($i < strlen($line)) && ($line[$i] != '"')) {
2431 $value = substr($line, 0, $i);
2432 $value = trim ($value, '"');
2433 $value = trim ($value);
2435 // If there are no double quotes, we have to find the next space or comma
2437 while (($i < strlen($line)) && (($line[$i] != ' ') && ($line[$i] != ','))) {
2440 $value = substr($line, 0, $i);
2441 $value = trim ($value);
2442 $value = trim ($value, ",");
2443 $value = trim ($value);
2446 $options[$attribute] = $value;
2448 $line = substr($line, $i+1);
2449 $line = trim ($line);
2450 $line = trim ($line, ",");
2451 $line = trim ($line);
2453 return $options + parse_attributes($line);
2457 * Returns true if the filename ends with an image suffix.
2458 * Uses INLINE_IMAGES if defined, else "png|jpg|jpeg|gif"
2460 function is_image ($filename) {
2462 if (defined('INLINE_IMAGES')) {
2463 $inline_images = INLINE_IMAGES;
2465 $inline_images = "png|jpg|jpeg|gif";
2468 foreach (explode("|", $inline_images) as $suffix) {
2469 if (string_ends_with(strtolower($filename), "." . $suffix)) {
2477 * Returns true if the filename ends with an video suffix.
2478 * Currently only FLV and OGG
2480 function is_video ($filename) {
2482 return string_ends_with(strtolower($filename), ".flv")
2483 or string_ends_with(strtolower($filename), ".ogg");
2487 * Compute cell in spreadsheet table
2488 * $table: two-dimensional table
2489 * $i and $j: indexes of cell to compute
2490 * $imax and $jmax: table dimensions
2492 function compute_tablecell ($table, $i, $j, $imax, $jmax) {
2494 // What is implemented:
2495 // @@=SUM(R)@@ : sum of cells in current row
2496 // @@=SUM(C)@@ : sum of cells in current column
2497 // @@=AVERAGE(R)@@ : average of cells in current row
2498 // @@=AVERAGE(C)@@ : average of cells in current column
2499 // @@=MAX(R)@@ : maximum value of cells in current row
2500 // @@=MAX(C)@@ : maximum value of cells in current column
2501 // @@=MIN(R)@@ : minimum value of cells in current row
2502 // @@=MIN(C)@@ : minimum value of cells in current column
2503 // @@=COUNT(R)@@ : number of cells in current row
2504 // (numeric or not, excluding headers and current cell)
2505 // @@=COUNT(C)@@ : number of cells in current column
2506 // (numeric or not, excluding headers and current cell)
2512 if (strpos($table[$i][$j], "@@=SUM(C)@@") !== false) {
2513 for ($index=0; $index<$imax; $index++) {
2514 if (is_numeric($table[$index][$j])) {
2515 $result += $table[$index][$j];
2518 return str_replace("@@=SUM(C)@@", $result, $table[$i][$j]);
2520 } else if (strpos($table[$i][$j], "@@=SUM(R)@@") !== false) {
2521 for ($index=0; $index<$jmax; $index++) {
2522 if (is_numeric($table[$i][$index])) {
2523 $result += $table[$i][$index];
2526 return str_replace("@@=SUM(R)@@", $result, $table[$i][$j]);
2528 } else if (strpos($table[$i][$j], "@@=AVERAGE(C)@@") !== false) {
2529 for ($index=0; $index<$imax; $index++) {
2530 if (is_numeric($table[$index][$j])) {
2531 $result += $table[$index][$j];
2535 $result=$result/$counter;
2536 return str_replace("@@=AVERAGE(C)@@", $result, $table[$i][$j]);
2538 } else if (strpos($table[$i][$j], "@@=AVERAGE(R)@@") !== false) {
2539 for ($index=0; $index<$jmax; $index++) {
2540 if (is_numeric($table[$i][$index])) {
2541 $result += $table[$i][$index];
2545 $result=$result/$counter;
2546 return str_replace("@@=AVERAGE(R)@@", $result, $table[$i][$j]);
2548 } else if (strpos($table[$i][$j], "@@=MAX(C)@@") !== false) {
2549 for ($index=0; $index<$imax; $index++) {
2550 if (is_numeric($table[$index][$j])) {
2553 $result=$table[$index][$j];
2555 $result = max($result, $table[$index][$j]);
2562 return str_replace("@@=MAX(C)@@", $result, $table[$i][$j]);
2564 } else if (strpos($table[$i][$j], "@@=MAX(R)@@") !== false) {
2565 for ($index=0; $index<$jmax; $index++) {
2566 if (is_numeric($table[$i][$index])) {
2569 $result=$table[$i][$index];
2571 $result = max($result, $table[$i][$index]);
2578 return str_replace("@@=MAX(R)@@", $result, $table[$i][$j]);
2580 } else if (strpos($table[$i][$j], "@@=MIN(C)@@") !== false) {
2581 for ($index=0; $index<$imax; $index++) {
2582 if (is_numeric($table[$index][$j])) {
2585 $result=$table[$index][$j];
2587 $result = min($result, $table[$index][$j]);
2594 return str_replace("@@=MIN(C)@@", $result, $table[$i][$j]);
2596 } else if (strpos($table[$i][$j], "@@=MIN(R)@@") !== false) {
2597 for ($index=0; $index<$jmax; $index++) {
2598 if (is_numeric($table[$i][$index])) {
2601 $result=$table[$i][$index];
2603 $result = min($result, $table[$i][$index]);
2610 return str_replace("@@=MIN(R)@@", $result, $table[$i][$j]);
2612 } else if (strpos($table[$i][$j], "@@=COUNT(C)@@") !== false) {
2613 for ($index=0; $index<$imax; $index++) {
2614 if (!string_starts_with(trim($table[$index][$j]), "=")) { // exclude header
2618 $result = $counter-1; // exclude self
2619 return str_replace("@@=COUNT(C)@@", $result, $table[$i][$j]);
2621 } else if (strpos($table[$i][$j], "@@=COUNT(R)@@") !== false) {
2622 for ($index=0; $index<$jmax; $index++) {
2623 if (!string_starts_with(trim($table[$i][$index]), "=")) { // exclude header
2627 $result = $counter-1; // exclude self
2628 return str_replace("@@=COUNT(R)@@", $result, $table[$i][$j]);
2631 return $table[$i][$j];
2635 * Remove accents from given text.
2637 function strip_accents($text) {
2638 $res = utf8_decode($text);
2640 utf8_decode('àáâãäçèéêëìíîïñòóôõöùúûüýÿÀÁÂÃÄÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝ'),
2641 'aaaaaceeeeiiiinooooouuuuyyAAAAACEEEEIIIINOOOOOUUUUY');
2642 return utf8_encode($res);
2645 // (c-file-style: "gnu")
2649 // c-basic-offset: 4
2650 // c-hanging-comment-ender-p: nil
2651 // indent-tabs-mode: nil