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 along
19 * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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 is_whole_number($var)
101 parse_attributes($line)
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 if (!defined('MAX_PAGENAME_LENGTH')) {
112 define('MAX_PAGENAME_LENGTH', 100);
116 * Convert string to a valid XML identifier.
118 * XML 1.0 identifiers are of the form: [A-Za-z][A-Za-z0-9:_.-]*
120 * We would like to have, e.g. named anchors within wiki pages
121 * names like "Table of Contents" --- clearly not a valid XML
122 * fragment identifier.
124 * This function implements a one-to-one map from {any string}
125 * to {valid XML identifiers}.
128 * converting all bytes not in [A-Za-z0-9:_-],
129 * and any leading byte not in [A-Za-z] to 'xbb.',
130 * where 'bb' is the hexadecimal representation of the
133 * As a special case, the empty string is converted to 'empty.'
138 function MangleXmlIdentifier($str)
143 return preg_replace('/[^-_:A-Za-z0-9]|(?<=^)[^A-Za-z]/e',
144 "'x' . sprintf('%02x', ord('\\0')) . '.'",
148 function UnMangleXmlIdentifier($str)
150 if ($str == 'empty.')
152 return preg_replace('/x(\w\w)\./e',
153 "sprintf('%c', hex('\\0'))",
158 * Returns a name for the WIKI_ID cookie that should be unique on the host.
159 * But for it to be unique you must have set a unique WIKI_NAME in your
160 * configuration file.
161 * @return string The name of the WIKI_ID cookie to use for this wiki.
163 function getCookieName()
165 return preg_replace("/[^\d\w]/", "_", WIKI_NAME) . "_WIKI_ID";
169 * Generates a valid URL for a given Wiki pagename.
170 * @param mixed $pagename If a string this will be the name of the Wiki page to link to.
171 * If a WikiDB_Page object function will extract the name to link to.
172 * If a WikiDB_PageRevision object function will extract the name to link to.
174 * @param boolean $get_abs_url Default value is false.
175 * @return string The absolute URL to the page passed as $pagename.
177 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();
185 } elseif (isa($pagename, 'WikiDB_PageRevision')) {
186 $page = $pagename->getPage();
187 $args['version'] = $pagename->getVersion();
188 $pagename = $page->getName();
189 } elseif (isa($pagename, 'WikiPageName')) {
190 $anchor = $pagename->anchor;
191 $pagename = $pagename->name;
193 $anchor = $pagename->anchor;
194 $pagename = $pagename->name;
197 if (!$get_abs_url and DEBUG and $request->getArg('start_debug')) {
199 $args = 'start_debug=' . $request->getArg('start_debug');
200 elseif (is_array($args))
201 $args['start_debug'] = $request->getArg('start_debug'); else
202 $args .= '&start_debug=' . $request->getArg('start_debug');
204 if (is_array($args)) {
206 foreach ($args as $key => $val) {
207 // avoid default args
208 if (USE_PATH_INFO and $key == 'pagename')
210 elseif ($key == 'action' and $val == 'browse')
211 ; elseif (!is_array($val)) // ugly hack for getURLtoSelf() which also takes POST vars
212 $enc_args[] = urlencode($key) . '=' . urlencode($val);
214 $args = join('&', $enc_args);
217 if (USE_PATH_INFO or !empty($WikiTheme->HTML_DUMP_SUFFIX)) {
218 $url = $get_abs_url ? (SERVER_URL . VIRTUAL_PATH . "/") : "";
219 $base = preg_replace('/%2f/i', '/', rawurlencode($pagename));
221 if (!empty($WikiTheme->HTML_DUMP_SUFFIX)) {
222 if (!empty($WikiTheme->VALID_LINKS) and $request->getArg('action') == 'pdf') {
223 if (!in_array($pagename, $WikiTheme->VALID_LINKS))
226 $url = $base . $WikiTheme->HTML_DUMP_SUFFIX;
228 $url .= $WikiTheme->HTML_DUMP_SUFFIX;
237 $url = $get_abs_url ? SERVER_URL . SCRIPT_NAME : basename(SCRIPT_NAME);
238 $url .= "?pagename=" . rawurlencode($pagename);
243 $url .= "#" . MangleXmlIdentifier($anchor);
247 /** Convert relative URL to absolute URL.
249 * This converts a relative URL to one of PhpWiki's support files
250 * to an absolute one.
253 * @return string Absolute URL
255 function AbsoluteURL($url)
257 if (preg_match('/^https?:/', $url))
259 if ($url[0] != '/') {
260 $base = USE_PATH_INFO ? VIRTUAL_PATH : dirname(SCRIPT_NAME);
261 while ($base != '/' and substr($url, 0, 3) == "../") {
262 $url = substr($url, 3);
263 $base = dirname($base);
269 return SERVER_URL . $url;
272 function DataURL($url)
274 if (preg_match('/^https?:/', $url))
276 $url = NormalizeWebFileName($url);
277 if (DEBUG and $GLOBALS['request']->getArg('start_debug') and substr($url, -4, 4) == '.php')
278 $url .= "?start_debug=1"; // XMLRPC and SOAP debugging helper.
279 return AbsoluteURL($url);
283 * Generates icon in front of links.
285 * @param string $protocol_or_url URL or protocol to determine which icon to use.
287 * @return HtmlElement HtmlElement object that contains data to create img link to
288 * icon for use with url or protocol passed to the function. False if no img to be
291 function IconForLink($protocol_or_url)
294 if (0 and $filename_suffix == false) {
295 // display apache style icon for file type instead of protocol icon
296 // - archive: unix:gz,bz2,tgz,tar,z; mac:dmg,dmgz,bin,img,cpt,sit; pc:zip;
297 // - document: html, htm, text, txt, rtf, pdf, doc
298 // - non-inlined image: jpg,jpeg,png,gif,tiff,tif,swf,pict,psd,eps,ps
299 // - audio: mp3,mp2,aiff,aif,au
300 // - multimedia: mpeg,mpg,mov,qt
302 list ($proto) = explode(':', $protocol_or_url, 2);
303 $src = $WikiTheme->getLinkIconURL($proto);
305 return HTML::img(array('src' => $src, 'alt' => "", 'class' => 'linkicon'));
312 * Glue icon in front of or after text.
313 * Pref: 'noLinkIcons' - ignore icon if set
314 * WikiTheme: 'LinkIcons' - 'yes' at front
315 * - 'no' display no icon
316 * - 'front' display at left
317 * - 'after' display at right
319 * @param string $protocol_or_url Protocol or URL. Used to determine the
321 * @param string $text The text.
322 * @return XmlContent.
324 function PossiblyGlueIconToText($proto_or_url, $text)
326 global $request, $WikiTheme;
327 if ($request->getPref('noLinkIcons'))
329 $icon = IconForLink($proto_or_url);
332 if ($where = $WikiTheme->getLinkIconAttr()) {
333 if ($where == 'no') return $text;
334 if ($where != 'after') $where = 'front';
338 if ($where == 'after') {
339 // span the icon only to the last word (tie them together),
340 // to let the previous words wrap on line breaks.
341 if (!is_object($text)) {
342 preg_match('/^(\s*\S*)(\s*)$/', $text, $m);
343 list (, $prefix, $last_word) = $m;
348 $text = HTML::span(array('style' => 'white-space: nowrap'),
349 $last_word, HTML::Raw(' '), $icon);
351 $text = HTML($prefix, $text);
354 // span the icon only to the first word (tie them together),
355 // to let the next words wrap on line breaks
356 if (!is_object($text)) {
357 preg_match('/^\s*(\S*)(.*?)\s*$/', $text, $m);
358 list (, $first_word, $tail) = $m;
363 $text = HTML::span(array('style' => 'white-space: nowrap'),
366 $text = HTML($text, $tail);
371 * Determines if the url passed to function is safe, by detecting if the characters
372 * '<', '>', or '"' are present.
373 * Check against their urlencoded values also.
375 * @param string $url URL to check for unsafe characters.
376 * @return boolean True if same, false else.
378 function IsSafeURL($url)
380 return !preg_match('/([<>"])|(%3C)|(%3E)|(%22)/', $url);
384 * Generates an HtmlElement object to store data for a link.
386 * @param string $url URL that the link will point to.
387 * @param string $linktext Text to be displayed as link.
388 * @return HtmlElement HtmlElement object that contains data to construct an html link.
390 function LinkURL($url, $linktext = '')
392 // FIXME: Is this needed (or sufficient?)
393 if (!IsSafeURL($url)) {
394 $link = HTML::span(array('class' => 'error'), _('Bad URL -- remove all of <, >, "'));
398 $linktext = preg_replace("/mailto:/A", "", $url);
399 $args = array('href' => $url);
400 if (defined('EXTERNAL_LINK_TARGET')) // can also be set in the css
401 $args['target'] = (is_string(EXTERNAL_LINK_TARGET) and (EXTERNAL_LINK_TARGET != "")) ? EXTERNAL_LINK_TARGET : "_blank";
402 $link = HTML::a($args, PossiblyGlueIconToText($url, $linktext));
404 $link->setAttr('class', $linktext ? 'namedurl' : 'rawurl');
411 * Syntax: [image.png size=50% border=n align= hspace= vspace= width= height=]
412 * Disallows sizes which are too small.
413 * Spammers may use such (typically invisible) image attributes to raise their GoogleRank.
415 * Handle embeddable objects, like svg, class, vrml, swf, svgz, pdf, avi, wmv especially.
417 function LinkImage($url, $alt = "")
419 $force_img = "png|jpg|gif|jpeg|bmp|pl|cgi";
420 // Disallow tags in img src urls. Typical CSS attacks.
421 // FIXME: Is this needed (or sufficient?)
422 // FIXED: This was broken for moniker:TP30 test/image.png => url="moniker:TP30" attr="test/image.png"
424 // support new syntax: [prefix/image.jpg size=50% border=n]
428 if (!IsSafeURL($url)) {
429 $link = HTML::span(array('class' => 'error'), _('Bad URL for image -- remove all of <, >, "'));
432 // spaces in inline images must be %20 encoded!
433 $link = HTML::img(array('src' => $url));
435 // Extract attributes and shorten url
436 $arr = parse_attributes(strstr($url, " "));
437 foreach ($arr as $attr => $value) {
438 // strip attr=... url suffix
439 $link->setAttr('src', $url);
440 $i = strpos($url, $attr);
441 $url = substr($url, 0, $i - 1);
442 // These attributes take strings: lang, id, title, alt
443 if (($attr == "lang")
445 || ($attr == "title")
448 $link->setAttr($attr, $value);
449 } // align = bottom|middle|top|left|right
450 // we allow "center" as synonym for "middle"
451 elseif (($attr == "align")
452 && (($value == "bottom")
453 || ($value == "middle")
454 || ($value == "center")
456 || ($value == "left")
457 || ($value == "right"))
459 if ($value == "center") {
462 $link->setAttr($attr, $value);
463 } // These attributes take a number (pixels): border, hspace, vspace
464 elseif ((($attr == "border") || ($attr == "hspace") || ($attr == "vspace"))
465 && (is_numeric($value))
467 $link->setAttr($attr, (int)$value);
468 } // These attributes take a number (pixels) or a percentage: height, width
469 elseif ((($attr == "height") || ($attr == "width"))
470 && (preg_match('/\d+[%p]?x?/', $value))
472 $link->setAttr($attr, $value);
473 } // We allow size=50% and size=20x30
474 // We replace this with "width" and "height" HTML attributes
475 elseif ($attr == "size") {
476 if (preg_match('/(\d+%)/', $value, $m)) {
477 $link->setAttr('width', $m[1]);
478 $link->setAttr('height', $m[1]);
479 } elseif (preg_match('/(\d+)x(\d+)/', $value, $m)) {
480 $link->setAttr('width', $m[1]);
481 $link->setAttr('height', $m[2]);
484 $url = substr(strrchr($ori_url, "/"), 1);
485 $link = HTML::span(array('class' => 'error'),
486 sprintf(_("Invalid attribute %s=%s for image %s"),
487 $attr, $value, $url));
491 // Correct silently the most common error
492 if (strstr($ori_url, " ") and !preg_match("/^http/", $url)) {
493 // space belongs to the path
494 $file = NormalizeLocalFileName($ori_url);
495 if (file_exists($file)) {
496 $link = HTML::img(array('src' => $ori_url));
498 sprintf(_("Invalid image link fixed %s => %s. Spaces must be quoted with %%20."),
499 $url, $ori_url), E_USER_WARNING);
500 } elseif (string_starts_with($ori_url, getUploadDataPath())) {
501 $file = substr($file, strlen(getUploadDataPath()));
502 $path = getUploadFilePath() . $file;
503 if (file_exists($path)) {
504 trigger_error(sprintf(_("Invalid image link fixed \"%s\" => \"%s\".\n Spaces must be quoted with %%20."),
505 $url, $ori_url), E_USER_WARNING);
506 $link->setAttr('src', getUploadDataPath() . $file);
511 if (!$link->getAttr('alt')) {
512 $link->setAttr('alt', $alt);
514 // Check width and height as spam countermeasure
515 if (($width = $link->getAttr('width')) and ($height = $link->getAttr('height'))) {
516 //$width = (int) $width; // px or % or other suffix
517 //$height = (int) $height;
518 if (($width < 3 and $height < 10) or
519 ($height < 3 and $width < 20) or
520 ($height < 7 and $width < 7)
522 $link = HTML::span(array('class' => 'error'),
523 _("Invalid image size"));
528 // Prepare for getimagesize($url)
529 // $url only valid for external urls, otherwise local path
530 if (DISABLE_GETIMAGESIZE)
532 elseif (!preg_match("/\.$force_img$/i", $url))
533 ; // only valid image extensions or scripts assumed to generate images
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
549 $size = @getimagesize($request->get('DOCUMENT_ROOT') . urldecode($url));
555 if (($width < 3 and $height < 10)
556 or ($height < 3 and $width < 20)
557 or ($height < 7 and $width < 7)
559 $link = HTML::span(array('class' => 'error'),
560 _("Invalid image size"));
565 $link->setAttr('class', 'inlineimage');
567 /* Check for inlined objects. Everything allowed in INLINE_IMAGES besides
568 * png|jpg|gif|jpeg|bmp|pl|cgi. If no image it is an object to embed.
569 * Note: Allow cgi's (pl,cgi) returning images.
571 if (!preg_match("/\.(" . $force_img . ")/i", $ori_url)) {
572 // HTML::img(array('src' => $url, 'alt' => $alt, 'title' => $alt));
573 // => HTML::object(array('src' => $url)) ...;
574 return ImgObject($link, $ori_url);
580 * <object> / <embed> tags instead of <img> for all non-image extensions
582 * Called by LinkImage(), not directly.
583 * Syntax: [image.svg size=50% alt=image.gif border=n align= hspace= vspace= width= height=]
584 * Samples: [Upload:song.mp3 type=audio/mpeg width=200 height=10]
585 * $alt may be an alternate img
586 * TODO: Need to unify with WikiPluginCached::embedObject()
588 * Note that Safari 1.0 will crash with <object>, so use only <embed>
589 * http://www.alleged.org.uk/pdc/2002/svg-object.html
591 * Allowed object tags:
593 * DATA=URI (object data)
594 * CLASSID=URI (location of implementation)
595 * ARCHIVE=CDATA (archive files)
596 * CODEBASE=URI (base URI for CLASSID, DATA, ARCHIVE)
597 * WIDTH=Length (object width)
598 * HEIGHT=Length (object height)
599 * NAME=CDATA (name for form submission)
600 * USEMAP=URI (client-side image map)
601 * TYPE=ContentType (content-type of object)
602 * CODETYPE=ContentType (content-type of code)
603 * STANDBY=Text (message to show while loading)
604 * TABINDEX=NUMBER (position in tabbing order)
605 * DECLARE (do not instantiate object)
606 * The rest is added as <param name="" value="" /> tags
608 function ImgObject($img, $url)
610 // get the url args: data="sample.svgz" type="image/svg+xml" width="400" height="300"
611 $params = explode(",", "id,width,height,data,classid,archive,codebase,name,usemap,type," .
612 "codetype,standby,tabindex,declare");
613 if (is_array($url)) {
616 foreach ($args as $attr => $value) {
617 foreach ($params as $param) {
618 if ($param == $attr) {
619 $img->setAttr($param, $value);
620 if (isset($found[$param])) $found[$param]++;
621 else $found[$param] = 1;
626 // now all remaining args are added as <param> to the object
628 foreach ($args as $attr => $value) {
629 if (!isset($found[$attr])) {
630 $params[] = HTML::param(array('name' => $attr,
634 $url = $img->getAttr('src');
635 $force_img = "png|jpg|gif|jpeg|bmp";
636 if (!preg_match("/\.(" . $force_img . ")/i", $url)) {
637 $img->setAttr('src', false);
640 $args = explode(' ', $url);
641 if (count($args) >= 1) {
642 $url = array_shift($args);
644 foreach ($args as $attr) {
645 foreach ($params as $param) {
646 if (preg_match("/^$param=(\S+)$/i", $attr, $m)) {
647 $img->setAttr($param, $m[1]);
648 if (isset($found[$param])) $found[$param]++;
649 else $found[$param] = 1;
654 // now all remaining args are added as <param> to the object
656 foreach ($args as $attr) {
657 if (!isset($found[$attr]) and preg_match("/^(\S+)=(\S+)$/i", $attr, $m)) {
658 $params[] = HTML::param(array('name' => $m[1],
664 $type = $img->getAttr('type');
666 if (function_exists('mime_content_type') && file_exists($url)) {
667 $type = mime_content_type($url);
670 $object = HTML::object(array_merge($img->_attr,
671 array('type' => $type)), //'src' => $url
673 $object->setAttr('class', 'inlineobject');
675 foreach ($params as $param) $object->pushContent($param);
677 if (isBrowserSafari() and !isBrowserSafari(532)) { // recent chrome can do OBJECT
678 return HTML::embed($object->_attr, $object->_content);
680 $object->pushContent(HTML::embed($object->_attr));
687 // var in php5 deprecated
690 $this->items = array();
696 $this->items[$this->size] = $item;
703 if ($this->size == 0) {
704 return false; // stack is empty
707 return $this->items[$this->size];
718 return $this->items[$this->size - 1];
725 // end class definition
727 function SplitQueryArgs($query_args = '')
729 // FIXME: use the arg-seperator which might not be &
730 $split_args = explode('&', $query_args);
732 while (list($key, $val) = each($split_args))
733 if (preg_match('/^ ([^=]+) =? (.*) /x', $val, $m))
734 $args[$m[1]] = $m[2];
738 function LinkPhpwikiURL($url, $text = '', $basepage = false)
742 if (!preg_match('/^ phpwiki: ([^?]*) [?]? (.*) $/x', $url, $m)) {
743 return HTML::span(array('class' => 'error'), _("BAD phpwiki: URL"));
747 $pagename = urldecode($m[1]);
750 if (empty($pagename) &&
751 preg_match('/^(diff|edit|links|info)=([^&]+)$/', $qargs, $m)
753 // Convert old style links (to not break diff links in
755 $pagename = urldecode($m[2]);
756 $args = array("action" => $m[1]);
758 $args = SplitQueryArgs($qargs);
761 if (empty($pagename))
762 $pagename = $GLOBALS['request']->getArg('pagename');
764 if (isset($args['action']) && $args['action'] == 'browse')
765 unset($args['action']);
768 if (empty($args['action']))
770 else if (is_safe_action($args['action']))
771 $class = 'wikiaction';
773 if (empty($args['action']) || is_safe_action($args['action']))
774 $class = 'wikiaction';
776 // Don't allow administrative links on unlocked pages.
777 $dbi = $GLOBALS['request']->getDbh();
778 $page = $dbi->getPage($basepage ? $basepage : $pagename);
779 if (!$page->get('locked'))
780 return HTML::span(array('class' => 'wikiunsafe'),
781 HTML::u(_("Lock page to enable link")));
782 $class = 'wikiadmin';
786 $text = HTML::span(array('class' => 'rawurl'), $url);
788 $wikipage = new WikiPageName($pagename);
789 if (!$wikipage->isValid()) {
791 return $WikiTheme->linkBadWikiWord($wikipage, $url);
794 return HTML::a(array('href' => WikiURL($pagename, $args),
800 * A class to assist in parsing wiki pagenames.
802 * Now with subpages and anchors, parsing and passing around
803 * pagenames is more complicated. This should help.
807 /** Short name for page.
809 * This is the value of $name passed to the constructor.
810 * (For use, e.g. as a default label for links to the page.)
814 /** The full page name.
816 * This is the full name of the page (without anchor).
822 * This is the referenced anchor within the page, or the empty string.
828 * @param mixed $name Page name.
829 * WikiDB_Page, WikiDB_PageRevision, or string.
830 * This can be a relative subpage name (like '/SubPage'),
831 * or can be the empty string to refer to the $basename.
833 * @param string $anchor For links to anchors in page.
835 * @param mixed $basename Page name from which to interpret
836 * relative or other non-fully-specified page names.
838 function WikiPageName($name, $basename = false, $anchor = false)
840 if (is_string($name)) {
841 $this->shortName = $name;
842 if (strstr($name, ':')) {
843 list($moniker, $shortName) = explode(":", $name, 2);
844 $map = getInterwikiMap(); // allow overrides to custom maps
845 if (isset($map->_map[$moniker])) {
846 $url = $map->_map[$moniker];
847 if (strstr($url, '%s'))
848 $url = sprintf($url, $shortName);
852 // expand Talk or User, but not to absolute urls!
853 if (strstr($url, '//')) {
854 if ($moniker == 'Talk')
855 $name = $name . SUBPAGE_SEPARATOR . _("Discussion");
856 elseif ($moniker == 'User')
861 if (strstr($shortName, '?')) {
862 list($shortName, $dummy) = explode("\?", $shortName, 2);
864 $this->shortName = $shortName;
867 // FIXME: We should really fix the cause for "/PageName" in the WikiDB
868 if ($name == '' or $name[0] == SUBPAGE_SEPARATOR) {
870 $name = $this->_pagename($basename) . $name;
872 $name = $this->_normalize_bad_pagename($name);
873 $this->shortName = $name;
877 $name = $this->_pagename($name);
878 $this->shortName = $name;
881 $this->name = $this->_check($name);
882 $this->anchor = (string)$anchor;
893 if (!($tail = strrchr($name, SUBPAGE_SEPARATOR)))
895 return substr($name, 0, -strlen($tail));
898 function isValid($strict = false)
901 return !isset($this->_errors);
902 return (is_string($this->name) and $this->name != '');
905 function getWarnings()
908 if (isset($this->_warnings))
909 $warnings = array_merge($warnings, $this->_warnings);
910 if (isset($this->_errors))
911 $warnings = array_merge($warnings, $this->_errors);
915 return sprintf(_("'%s': Bad page name: %s"),
916 $this->shortName, join(', ', $warnings));
919 function _pagename($page)
921 if (isa($page, 'WikiDB_Page'))
922 return $page->getName();
923 elseif (isa($page, 'WikiDB_PageRevision'))
924 return $page->getPageName(); elseif (isa($page, 'WikiPageName'))
926 // '0' or e.g. '1984' should be allowed though
927 if (!is_string($page) and !is_integer($page)) {
928 trigger_error(sprintf("Non-string pagename '%s' (%s)(%s)",
929 $page, gettype($page), get_class($page)),
932 //assert(is_string($page));
936 function _normalize_bad_pagename($name)
938 trigger_error("Bad pagename: " . $name, E_USER_WARNING);
940 // Punt... You really shouldn't get here.
943 return $request->getArg('pagename');
945 assert($name[0] == SUBPAGE_SEPARATOR);
946 $this->_errors[] = sprintf(_("Leading %s not allowed"), SUBPAGE_SEPARATOR);
947 return substr($name, 1);
951 * Compress internal white-space to single space character.
953 * This leads to problems with loading a foreign charset pagename,
954 * which cannot be deleted anymore, because unknown chars are compressed.
955 * So BEFORE importing a file _check must be done !!!
957 function _check($pagename)
959 // Compress internal white-space to single space character.
960 $pagename = preg_replace('/[\s\xa0]+/', ' ', $orig = $pagename);
961 if ($pagename != $orig)
962 $this->_warnings[] = _("White space converted to single space");
964 // Delete any control characters.
965 if (DATABASE_TYPE == 'cvs' or DATABASE_TYPE == 'file' or DATABASE_TYPE == 'flatfile') {
966 $pagename = preg_replace('/[\x00-\x1f\x7f\x80-\x9f]/', '', $orig = $pagename);
967 if ($pagename != $orig)
968 $this->_errors[] = _("Control characters not allowed");
971 // Strip leading and trailing white-space.
972 $pagename = trim($pagename);
975 while ($pagename and $pagename[0] == SUBPAGE_SEPARATOR)
976 $pagename = substr($pagename, 1);
977 if ($pagename != $orig)
978 $this->_errors[] = sprintf(_("Leading %s not allowed"), SUBPAGE_SEPARATOR);
980 // ";" is urlencoded, so safe from php arg-delim problems
981 /*if (strstr($pagename, ';')) {
982 $this->_warnings[] = _("';' is deprecated");
983 $pagename = str_replace(';', '', $pagename);
986 // not only for SQL, also to restrict url length
987 if (strlen($pagename) > MAX_PAGENAME_LENGTH) {
988 $pagename = substr($pagename, 0, MAX_PAGENAME_LENGTH);
989 $this->_errors[] = _("Page name too long");
992 // disallow some chars only on file and cvs
993 if ((DATABASE_TYPE == 'cvs'
994 or DATABASE_TYPE == 'file'
995 or DATABASE_TYPE == 'flatfile')
996 and preg_match('/(:|\.\.)/', $pagename, $m)
998 $this->_warnings[] = sprintf(_("Illegal chars %s removed"), $m[1]);
999 $pagename = str_replace('..', '', $pagename);
1000 $pagename = str_replace(':', '', $pagename);
1008 * Convert old page markup to new-style markup.
1010 * @param string $text Old-style wiki markup.
1012 * @param string $markup_type
1014 * <dt><code>"block"</code> <dd>Convert all markup.
1015 * <dt><code>"inline"</code> <dd>Convert only inline markup.
1016 * <dt><code>"links"</code> <dd>Convert only link markup.
1019 * @return string New-style wiki markup.
1021 * @bugs Footnotes don't work quite as before (esp if there are
1022 * multiple references to the same footnote. But close enough,
1023 * probably for now....
1024 * @bugs Apache2 and IIS crash with OldTextFormattingRules or
1025 * AnciennesR%E8glesDeFormatage. (at the 2nd attempt to do the anchored block regex)
1026 * It only crashes with CreateToc so far, but other pages (not in pgsrc) are
1027 * also known to crash, even with Apache1.
1029 function ConvertOldMarkup($text, $markup_type = "block")
1036 // Trying to detect why the 2nd paragraph of OldTextFormattingRules or
1037 // AnciennesR%E8glesDeFormatage crashes.
1038 // It only crashes with CreateToc so far, but other pages (not in pgsrc) are
1039 // also known to crash, even with Apache1.
1040 $debug_skip = false;
1041 // I suspect this only to crash with Apache2 and IIS.
1042 if (in_array(php_sapi_name(), array('apache2handler', 'apache2filter', 'isapi'))
1043 and preg_match("/plugin CreateToc/", $text)
1045 trigger_error(_("The CreateTocPlugin is not yet old markup compatible! ")
1046 . _("Please remove the CreateToc line to be able to reformat this page to old markup. ")
1047 . _("Skipped."), E_USER_WARNING);
1049 //if (!DEBUG) return $text;
1054 /*****************************************************************
1055 * Conversions for inline markup:
1062 // escape escaped brackets
1066 // change ! escapes to ~'s.
1067 global $WikiNameRegexp, $request;
1068 $bang_esc[] = "(?:" . ALLOWED_PROTOCOLS . "):[^\s<>\[\]\"'()]*[^\s<>\[\]\"'(),.?]";
1069 // before 4.3.9 pcre had a memory release bug, which might hit us here. so be safe.
1070 $map = getInterwikiMap();
1071 if ($map_regex = $map->getRegexp())
1072 $bang_esc[] = $map_regex . ":[^\\s.,;?()]+"; // FIXME: is this really needed?
1073 $bang_esc[] = $WikiNameRegexp;
1074 $orig[] = '/!((?:' . join(')|(', $bang_esc) . '))/';
1077 $subs["links"] = array($orig, $repl);
1079 // Temporarily URL-encode pairs of underscores in links to hide
1080 // them from the re for bold markup.
1081 $orig[] = '/\[[^\[\]]*?__[^\[\]]*?\]/e';
1082 $repl[] = 'str_replace(\'__\', \'%5F%5F\', \'\\0\')';
1085 //$orig[] = '/<(?!\?plugin)|(?<!^)</m';
1088 // Convert footnote references.
1089 $orig[] = '/(?<=.)(?<!~)\[\s*(\d+)\s*\]/m';
1090 $repl[] = '#[|ftnt_ref_\\1]<sup>~[[\\1|#ftnt_\\1]~]</sup>';
1092 // Convert old style emphases to HTML style emphasis.
1093 $orig[] = '/__(.*?)__/';
1094 $repl[] = '<strong>\\1</strong>';
1095 $orig[] = "/''(.*?)''/";
1096 $repl[] = '<em>\\1</em>';
1098 // Escape nestled markup.
1099 $orig[] = '/^(?<=^|\s)[=_](?=\S)|(?<=\S)[=_*](?=\s|$)/m';
1102 // in old markup headings only allowed at beginning of line
1106 // Convert URL-encoded pairs of underscores in links back to
1107 // real underscores after bold markup has been converted.
1108 $orig = '/\[[^\[\]]*?%5F%5F[^\[\]]*?\]/e';
1109 $repl = 'str_replace(\'%5F%5F\', \'__\', \'\\0\')';
1111 $subs["inline"] = array($orig, $repl);
1113 /*****************************************************************
1114 * Patterns which match block markup constructs which take
1115 * special handling...
1119 $blockpats[] = '[ \t]+\S(?:.*\s*\n[ \t]+\S)*';
1121 $blockpats[] = '\|(?:.*\n\|)*';
1124 $blockpats[] = '[#*;]*(?:[*#]|;.*?:)';
1126 // Footnote definitions
1127 $blockpats[] = '\[\s*(\d+)\s*\]';
1131 $blockpats[] = '<\?plugin(?:-form)?\b.*\?>\s*$';
1135 $blockpats[] = '!{1,3}[^!]';
1137 removed .|\n in the anchor not to crash on /m because with /m "." already includes \n
1138 this breaks headings but it doesn't crash anymore (crash on non-cgi, non-cli only)
1140 $block_re = ('/\A((?:.|\n)*?)(^(?:'
1141 . join("|", $blockpats)
1146 if ($markup_type != "block") {
1147 list ($orig, $repl) = $subs[$markup_type];
1148 return preg_replace($orig, $repl, $text);
1150 list ($orig, $repl) = $subs['inline'];
1153 // php crashes here in the 2nd paragraph of OldTextFormattingRules,
1154 // AnciennesR%E8glesDeFormatage and more
1155 // See http://www.pcre.org/pcre.txt LIMITATIONS
1156 while (preg_match($block_re, $text, $m)) {
1157 $text = substr($text, strlen($m[0]));
1158 list (, $leading_text, $block) = $m;
1161 if (strchr(" \t", $block[0])) {
1163 $prefix = "<pre>\n";
1164 $suffix = "\n</pre>\n";
1165 } elseif ($block[0] == '|') {
1167 $prefix = "<?plugin OldStyleTable\n";
1169 } elseif (strchr("#*;", $block[0])) {
1170 // Old-style list item
1171 preg_match('/^([#*;]*)([*#]|;.*?:) */', $block, $m);
1172 list (, $ind, $bullet) = $m;
1173 $block = substr($block, strlen($m[0]));
1175 $indent = str_repeat(' ', strlen($ind));
1176 if ($bullet[0] == ';') {
1177 //$term = ltrim(substr($bullet, 1));
1178 //return $indent . $term . "\n" . $indent . ' ';
1179 $prefix = $ind . $bullet;
1181 $prefix = $indent . $bullet . ' ';
1182 } elseif ($block[0] == '[') {
1183 // Footnote definition
1184 preg_match('/^\[\s*(\d+)\s*\]/', $block, $m);
1186 $block = substr($block, strlen($m[0]));
1187 $prefix = "#[|ftnt_" . ${footnum} . "]~[[" . ${footnum} . "|#ftnt_ref_" . ${footnum} . "]~] ";
1188 } elseif ($block[0] == '<') {
1190 // HACK: no inline markup...
1193 } elseif ($block[0] == '!') {
1195 preg_match('/^!{1,3}/', $block, $m);
1197 $block = substr($block, strlen($m[0]));
1202 if ($leading_text) $leading_text = preg_replace($orig, $repl, $leading_text);
1203 if ($block) $block = preg_replace($orig, $repl, $block);
1204 $out .= $leading_text;
1209 return $out . preg_replace($orig, $repl, $text);
1215 * Expand tabs in string.
1217 * Converts all tabs to (the appropriate number of) spaces.
1219 * @param string $str
1220 * @param integer $tab_width
1223 function expand_tabs($str, $tab_width = 8)
1225 $split = explode("\t", $str);
1226 $tail = array_pop($split);
1228 foreach ($split as $hunk) {
1230 $pos = strlen(strrchr($expanded, "\n")) - 1;
1231 $expanded .= str_repeat(" ", ($tab_width - $pos % $tab_width));
1233 return substr($expanded, 1) . $tail;
1237 * Split WikiWords in page names.
1239 * It has been deemed useful to split WikiWords (into "Wiki Words") in
1240 * places like page titles. This is rumored to help search engines
1243 * @param $page string The page name.
1245 * @return string The split name.
1247 function SplitPagename($page)
1250 if (preg_match("/\s/", $page))
1251 return $page; // Already split --- don't split any more.
1253 // This algorithm is specialized for several languages.
1254 // (Thanks to Pierrick MEIGNEN)
1255 // Improvements for other languages welcome.
1258 // This mess splits between a lower-case letter followed by
1259 // either an upper-case or a numeral; except that it wont
1260 // split the prefixes 'Mc', 'De', or 'Di' off of their tails.
1261 switch ($GLOBALS['LANG']) {
1266 $RE[] = '/([[:lower:]])((?<!Mc|De|Di)[[:upper:]]|\d)/';
1269 $RE[] = '/([[:lower:]])((?<!Mc|Di)[[:upper:]]|\d)/';
1272 $sep = preg_quote(SUBPAGE_SEPARATOR, '/');
1273 // This the single-letter words 'I' and 'A' from any following
1274 // capitalized words.
1275 switch ($GLOBALS['LANG']) {
1277 $RE[] = "/(?<= |${sep}|^)([AI])([[:upper:]][[:lower:]])/";
1280 $RE[] = "/(?<= |${sep}|^)([À])([[:upper:]][[:lower:]])/";
1283 // Split at underscore
1284 $RE[] = '/(_)([[:alpha:]])/';
1285 $RE[] = '/([[:alpha:]])(_)/';
1286 // Split numerals from following letters.
1287 $RE[] = '/(\d)([[:alpha:]])/';
1288 // Split at subpage seperators. TBD in WikiTheme.php
1289 $RE[] = "/([^${sep}]+)(${sep})/";
1290 $RE[] = "/(${sep})([^${sep}]+)/";
1292 foreach ($RE as $key)
1296 foreach ($RE as $regexp) {
1297 $page = preg_replace($regexp, '\\1 \\2', $page);
1302 function NoSuchRevision(&$request, $page, $version)
1304 $html = HTML(HTML::h2(_("Revision Not Found")),
1305 HTML::p(fmt("I'm sorry. Version %d of %s is not in the database.",
1306 $version, WikiLink($page, 'auto'))));
1307 include_once 'lib/Template.php';
1308 GeneratePage($html, _("Bad Version"), $page->getCurrentRevision());
1313 * Get time offset for local time zone.
1315 * @param $time time_t Get offset for this time. Default: now.
1316 * @param $no_colon boolean Don't put colon between hours and minutes.
1317 * @return string Offset as a string in the format +HH:MM.
1319 function TimezoneOffset($time = false, $no_colon = false)
1321 if ($time === false)
1323 $secs = date('Z', $time);
1331 $colon = $no_colon ? '' : ':';
1332 $mins = intval(($secs + 30) / 60);
1333 return sprintf("%s%02d%s%02d",
1334 $sign, $mins / 60, $colon, $mins % 60);
1339 * Format time in ISO-8601 format.
1341 * @param $time time_t Time. Default: now.
1342 * @return string Date and time in ISO-8601 format.
1344 function Iso8601DateTime($time = false)
1346 if ($time === false)
1348 $tzoff = TimezoneOffset($time);
1349 $date = date('Y-m-d', $time);
1350 $time = date('H:i:s', $time);
1351 return $date . 'T' . $time . $tzoff;
1355 * Format time in RFC-2822 format.
1357 * @param $time time_t Time. Default: now.
1358 * @return string Date and time in RFC-2822 format.
1360 function Rfc2822DateTime($time = false)
1362 if ($time === false)
1364 return date('D, j M Y H:i:s ', $time) . TimezoneOffset($time, 'no colon');
1368 * Format time in RFC-1123 format.
1370 * @param $time time_t Time. Default: now.
1371 * @return string Date and time in RFC-1123 format.
1373 function Rfc1123DateTime($time = false)
1375 if ($time === false)
1377 return gmdate('D, d M Y H:i:s \G\M\T', $time);
1380 /** Parse date in RFC-1123 format.
1382 * According to RFC 1123 we must accept dates in the following
1385 * Sun, 06 Nov 1994 08:49:37 GMT ; RFC 822, updated by RFC 1123
1386 * Sunday, 06-Nov-94 08:49:37 GMT ; RFC 850, obsoleted by RFC 1036
1387 * Sun Nov 6 08:49:37 1994 ; ANSI C's asctime() format
1389 * (Though we're only allowed to generate dates in the first format.)
1391 function ParseRfc1123DateTime($timestr)
1393 $timestr = trim($timestr);
1394 if (preg_match('/^ \w{3},\s* (\d{1,2}) \s* (\w{3}) \s* (\d{4}) \s*'
1395 . '(\d\d):(\d\d):(\d\d) \s* GMT $/ix',
1398 list(, $mday, $mon, $year, $hh, $mm, $ss) = $m;
1399 } elseif (preg_match('/^ \w+,\s* (\d{1,2})-(\w{3})-(\d{2}|\d{4}) \s*'
1400 . '(\d\d):(\d\d):(\d\d) \s* GMT $/ix',
1403 list(, $mday, $mon, $year, $hh, $mm, $ss) = $m;
1404 if ($year < 70) $year += 2000;
1405 elseif ($year < 100) $year += 1900;
1406 } elseif (preg_match('/^\w+\s* (\w{3}) \s* (\d{1,2}) \s*'
1407 . '(\d\d):(\d\d):(\d\d) \s* (\d{4})$/ix',
1410 list(, $mon, $mday, $hh, $mm, $ss, $year) = $m;
1416 $time = strtotime("$mday $mon $year ${hh}:${mm}:${ss} GMT");
1418 return false; // failed
1423 * Format time to standard 'ctime' format.
1425 * @param $time time_t Time. Default: now.
1426 * @return string Date and time.
1428 function CTime($time = false)
1430 if ($time === false)
1432 return date("D M j H:i:s Y", $time);
1437 * Format number as kibibytes or bytes.
1438 * Short format is used for PageList
1439 * Long format is used in PageInfo
1441 * @param $bytes int. Default: 0.
1442 * @param $longformat bool. Default: false.
1443 * @return class FormattedText (XmlElement.php).
1445 function ByteFormatter($bytes = 0, $longformat = false)
1449 if ($bytes < 1024) {
1451 $size = fmt("%s B", $bytes);
1453 $size = fmt("%s bytes", $bytes);
1455 $kb = round($bytes / 1024, 1);
1457 $size = fmt("%s KiB", $kb);
1459 $size = fmt("%s KiB (%s bytes)", $kb, $bytes);
1465 * Internationalized printf.
1467 * This is essentially the same as PHP's built-in printf
1468 * with the following exceptions:
1470 * <li> It passes the format string through gettext().
1471 * <li> It supports the argument reordering extensions.
1478 * __printf("Differences between versions %s and %s of %s",
1479 * $new_link, $old_link, $page_link);
1482 * Then in locale/po/de.po, one can reorder the printf arguments:
1485 * msgid "Differences between %s and %s of %s."
1486 * msgstr "Der Unterschiedsergebnis von %3$s, zwischen %1$s und %2$s."
1489 * (Note that while PHP tries to expand $vars within double-quotes,
1490 * the values in msgstr undergo no such expansion, so the '$'s
1493 * One shouldn't use reordered arguments in the default format string.
1494 * Backslashes in the default string would be necessary to escape the
1495 * '$'s, and they'll cause all kinds of trouble....
1497 function __printf($fmt)
1499 $args = func_get_args();
1501 echo __vsprintf($fmt, $args);
1505 * Internationalized sprintf.
1507 * This is essentially the same as PHP's built-in printf with the
1508 * following exceptions:
1511 * <li> It passes the format string through gettext().
1512 * <li> It supports the argument reordering extensions.
1517 function __sprintf($fmt)
1519 $args = func_get_args();
1521 return __vsprintf($fmt, $args);
1525 * Internationalized vsprintf.
1527 * This is essentially the same as PHP's built-in printf with the
1528 * following exceptions:
1531 * <li> It passes the format string through gettext().
1532 * <li> It supports the argument reordering extensions.
1537 function __vsprintf($fmt, $args)
1539 $fmt = gettext($fmt);
1540 // PHP's sprintf doesn't support variable with specifiers,
1541 // like sprintf("%*s", 10, "x"); --- so we won't either.
1543 if (preg_match_all('/(?<!%)%(\d+)\$/x', $fmt, $m)) {
1544 // Format string has '%2$s' style argument reordering.
1545 // PHP doesn't support this.
1546 if (preg_match('/(?<!%)%[- ]?\d*[^- \d$]/x', $fmt))
1547 // literal variable name substitution only to keep locale
1548 // strings uncluttered
1549 trigger_error(sprintf(_("Can't mix '%s' with '%s' type format strings"),
1550 '%1\$s', '%s'), E_USER_WARNING); //php+locale error
1552 $fmt = preg_replace('/(?<!%)%\d+\$/x', '%', $fmt);
1555 // Reorder arguments appropriately.
1556 foreach ($m[1] as $argnum) {
1557 if ($argnum < 1 || $argnum > count($args))
1558 trigger_error(sprintf(_("%s: argument index out of range"),
1559 $argnum), E_USER_WARNING);
1560 $newargs[] = $args[$argnum - 1];
1565 // Not all PHP's have vsprintf, so...
1566 array_unshift($args, $fmt);
1567 return call_user_func_array('sprintf', $args);
1570 function file_mtime($filename)
1572 if ($stat = @stat($filename))
1578 function sort_file_mtime($a, $b)
1580 $ma = file_mtime($a);
1581 $mb = file_mtime($b);
1582 if (!$ma or !$mb or $ma == $mb) return 0;
1583 return ($ma > $mb) ? -1 : 1;
1589 * Build an array in $this->_fileList of files from $dirname.
1590 * Subdirectories are not traversed.
1592 * (This was a function LoadDir in lib/loadsave.php)
1593 * See also http://www.php.net/manual/en/function.readdir.php
1595 function getFiles($exclude = '', $sortby = '', $limit = '')
1597 $list = $this->_fileList;
1600 require_once 'lib/PageList.php';
1601 switch (Pagelist::sortby($sortby, 'db')) {
1602 case 'pagename ASC':
1604 case 'pagename DESC':
1605 $list = array_reverse($list);
1608 usort($list, 'sort_file_mtime');
1611 usort($list, 'sort_file_mtime');
1612 $list = array_reverse($list);
1617 return array_splice($list, 0, $limit);
1621 function _filenameSelector($filename)
1623 if (!$this->_pattern)
1626 if (!$this->_pcre_pattern)
1627 $this->_pcre_pattern = glob_to_pcre($this->_pattern);
1628 return preg_match('/' . $this->_pcre_pattern . ($this->_case ? '/' : '/i'),
1633 function fileSet($directory, $filepattern = false)
1635 $this->_fileList = array();
1636 $this->_pattern = $filepattern;
1638 $this->_pcre_pattern = glob_to_pcre($this->_pattern);
1640 $this->_case = !isWindows();
1641 $this->_pathsep = '/';
1643 if (empty($directory)) {
1644 trigger_error(sprintf(_("%s is empty."), 'directoryname'),
1646 return; // early return
1649 @ $dir_handle = opendir($dir = $directory);
1650 if (empty($dir_handle)) {
1651 trigger_error(sprintf(_("Unable to open directory '%s' for reading"),
1652 $dir), E_USER_NOTICE);
1653 return; // early return
1656 while ($filename = readdir($dir_handle)) {
1657 if ($filename[0] == '.' || filetype($dir . $this->_pathsep . $filename) != 'file')
1659 if ($this->_filenameSelector($filename)) {
1660 array_push($this->_fileList, "$filename");
1661 //trigger_error(sprintf(_("found file %s"), $filename),
1662 // E_USER_NOTICE); //debugging
1665 closedir($dir_handle);
1673 // expands a list containing regex's to its matching entries
1674 class ListRegexExpand
1676 //var $match, $list, $index, $case_sensitive;
1677 function ListRegexExpand(&$list, $match, $case_sensitive = true)
1679 $this->match = $match;
1680 $this->list = &$list;
1681 $this->case_sensitive = $case_sensitive;
1682 //$this->index = false;
1685 function listMatchCallback($item, $key)
1687 $quoted = str_replace('/', '\/', $item);
1688 if (preg_match('/' . $this->match . ($this->case_sensitive ? '/' : '/i'),
1691 unset($this->list[$this->index]);
1692 $this->list[] = $item;
1696 function expandRegex($index, &$pages)
1698 $this->index = $index;
1699 array_walk($pages, array($this, 'listMatchCallback'));
1704 // Convert fileglob to regex style:
1705 // Convert some wildcards to pcre style, escape the rest
1706 // Escape . \\ + * ? [ ^ ] $ ( ) { } = ! < > | : /
1707 // Fixed bug #994994: "/" in $glob.
1708 function glob_to_pcre($glob)
1710 // check simple case: no need to escape
1711 $escape = '\[](){}=!<>|:/';
1712 if (strcspn($glob, $escape . ".+*?^$") == strlen($glob))
1714 // preg_replace cannot handle "\\\\\\2" so convert \\ to \xff
1715 $glob = strtr($glob, "\\", "\xff");
1716 $glob = str_replace("/", "\\/", $glob);
1717 // first convert some unescaped expressions to pcre style: . => \.
1719 $re = preg_replace('/([^\xff])?([' . preg_quote($special) . '])/',
1720 "\\1\xff\\2", $glob);
1723 $re = preg_replace('/([^\xff])?\*/', '$1.*', $re);
1724 $re = preg_replace('/([^\xff])?\?/', '$1.', $re);
1725 if (!preg_match('/^[\?\*]/', $glob))
1727 if (!preg_match('/[\?\*]$/', $glob))
1730 // Fixes Bug 1182997
1731 // .*? handled above, now escape the rest
1732 //while (strcspn($re, $escape) != strlen($re)) // loop strangely needed
1733 $re = preg_replace('/([^\xff])([' . preg_quote($escape, "/") . '])/',
1735 // Problem with 'Date/Time' => 'Date\/Time' => 'Date\xff\/Time' => 'Date\/Time'
1737 $re = preg_replace('/\xff/', '', $re);
1741 function glob_match($glob, $against, $case_sensitive = true)
1743 return preg_match('/' . glob_to_pcre($glob) . ($case_sensitive ? '/' : '/i'),
1747 function explodeList($input, $allnames, $glob_style = true, $case_sensitive = true)
1749 $list = explode(',', $input);
1750 // expand wildcards from list of $allnames
1751 if (preg_match('/[\?\*]/', $input)) {
1752 // Optimizing loop invariants:
1753 // http://phplens.com/lens/php-book/optimizing-debugging-php.php
1754 for ($i = 0, $max = sizeof($list); $i < $max; $i++) {
1756 if (preg_match('/[\?\*]/', $f)) {
1758 $expand = new ListRegexExpand($list,
1759 $glob_style ? glob_to_pcre($f) : $f, $case_sensitive);
1760 $expand->expandRegex($i, $allnames);
1767 // echo implode(":",explodeList("Test*",array("xx","Test1","Test2")));
1768 function explodePageList($input, $include_empty = false, $sortby = 'pagename',
1769 $limit = '', $exclude = '')
1771 include_once 'lib/PageList.php';
1772 return PageList::explodePageList($input, $include_empty, $sortby, $limit, $exclude);
1775 // Class introspections
1778 * Determine whether object is of a specified type.
1779 * In PHP builtin since 4.2.0 as is_a()
1780 * is_a() deprecated in PHP 5, in favor of instanceof operator
1781 * @param $object object An object.
1782 * @param $class string Class name.
1783 * @return bool True iff $object is a $class
1784 * or a sub-type of $class.
1786 function isa($object, $class)
1788 //if (check_php_version(5))
1789 // return $object instanceof $class;
1790 if (!check_php_version(5))
1791 return is_a($object, $class);
1793 $lclass = check_php_version(5) ? $class : strtolower($class);
1794 return is_object($object)
1795 && (strtolower(get_class($object)) == strtolower($class)
1796 || is_subclass_of($object, $lclass));
1799 /** Determine whether a function is okay to use.
1801 * Some providers (e.g. Lycos) disable some of PHP functions for
1802 * "security reasons." This makes those functions, of course,
1803 * unusable, despite the fact the function_exists() says they
1806 * This function test to see if a function exists and is not
1807 * disallowed by PHP's disable_functions config setting.
1809 * @param string $function_name Function name
1810 * @return bool True iff function can be used.
1812 function function_usable($function_name)
1815 if (!is_array($disabled)) {
1816 $disabled = array();
1817 // Use get_cfg_var since ini_get() is one of the disabled functions
1818 // (on Lycos, at least.)
1819 $split = preg_split('/\s*,\s*/', trim(get_cfg_var('disable_functions')));
1820 foreach ($split as $f)
1821 $disabled[strtolower($f)] = true;
1824 return (function_exists($function_name)
1825 and !isset($disabled[strtolower($function_name)])
1832 * This is used for generating ETags.
1834 function wikihash($x)
1836 if (is_scalar($x)) {
1838 } elseif (is_array($x)) {
1840 return md5(serialize($x));
1841 } elseif (is_object($x)) {
1844 trigger_error("Can't hash $x", E_USER_ERROR);
1849 * Seed the random number generator.
1851 * better_srand() ensures the randomizer is seeded only once.
1853 * How random do you want it? See:
1854 * http://www.php.net/manual/en/function.srand.php
1855 * http://www.php.net/manual/en/function.mt-srand.php
1857 function better_srand($seed = '')
1859 static $wascalled = FALSE;
1861 $seed = $seed === '' ? (double)microtime() * 1000000 : $seed;
1862 function_exists('mt_srand') ? mt_srand($seed) : srand($seed);
1864 //trigger_error("new random seed", E_USER_NOTICE); //debugging
1868 function rand_ascii($length = 1)
1872 for ($i = 1; $i <= $length; $i++) {
1873 // return only typeable 7 bit ascii, avoid quotes
1874 if (function_exists('mt_rand'))
1875 $s .= chr(mt_rand(40, 126));
1877 // the usually bad glibc srand()
1878 $s .= chr(rand(40, 126));
1883 /* by Dan Frankowski.
1885 function rand_ascii_readable($length = 6)
1887 // Pick a few random letters or numbers
1890 // Don't use 1lI0O, because they're hard to read
1891 $letters = "abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789";
1892 $letter_len = strlen($letters);
1893 for ($i = 0; $i < $length; $i++) {
1894 if (function_exists('mt_rand'))
1895 $word .= $letters[mt_rand(0, $letter_len - 1)];
1897 $word .= $letters[rand(0, $letter_len - 1)];
1903 * Recursively count all non-empty elements
1904 * in array of any dimension or mixed - i.e.
1905 * array('1' => 2, '2' => array('1' => 3, '2' => 4))
1906 * See http://www.php.net/manual/en/function.count.php
1908 function count_all($arg)
1910 // skip if argument is empty
1912 //print_r($arg); //debugging
1914 // not an array, return 1 (base case)
1915 if (!is_array($arg))
1917 // else call recursively for all elements $arg
1918 foreach ($arg as $key => $val)
1919 $count += count_all($val);
1924 function isSubPage($pagename)
1926 return (strstr($pagename, SUBPAGE_SEPARATOR));
1929 function subPageSlice($pagename, $pos)
1931 $pages = explode(SUBPAGE_SEPARATOR, $pagename);
1932 $pages = array_slice($pages, $pos, 1);
1936 function isActionPage($filename)
1939 global $AllActionPages;
1941 $localizedAllActionPages = array_map("__", $AllActionPages);
1943 return (in_array($filename, $localizedAllActionPages));
1949 * Class for "popping up" and alert box. (Except that right now, it doesn't
1953 * This is a hackish and needs to be refactored. However it would be nice to
1954 * unify all the different methods we use for showing Alerts and Dialogs.
1955 * (E.g. "Page deleted", login form, ...)
1961 * @param object $request
1962 * @param mixed $head Header ("title") for alert box.
1963 * @param mixed $body The text in the alert box.
1964 * @param hash $buttons An array mapping button labels to URLs.
1965 * The default is a single "Okay" button pointing to $request->getURLtoSelf().
1967 function Alert($head, $body, $buttons = false)
1969 if ($buttons === false)
1972 if (is_array($body)) {
1974 foreach ($body as $li) {
1975 $html->pushContent(HTML::li($li));
1979 $this->_tokens = array('HEADER' => $head, 'CONTENT' => $body);
1980 $this->_buttons = $buttons;
1984 * Show the alert box.
1990 $tokens = $this->_tokens;
1991 $tokens['BUTTONS'] = $this->_getButtons();
1993 $request->discardOutput();
1994 $tmpl = new Template('dialog', $request, $tokens);
2000 function _getButtons()
2004 $buttons = $this->_buttons;
2006 $buttons = array(_("OK") => $request->getURLtoSelf());
2009 foreach ($buttons as $label => $url)
2010 print "$label $url\n";
2011 $out[] = $WikiTheme->makeButton($label, $url, 'wikiaction');
2012 return new XmlContent($out);
2017 // 1.3.9-p1 => 1030.091
2018 // 1.3.10pre => 1030.099
2019 // 1.3.11pre-20041120 => 1030.1120041120
2020 // 1.3.12-rc1 => 1030.119
2021 function phpwiki_version()
2023 static $PHPWIKI_VERSION;
2024 if (!isset($PHPWIKI_VERSION)) {
2025 $arr = explode('.', preg_replace('/\D+$/', '', PHPWIKI_VERSION)); // remove the pre
2026 $arr[2] = preg_replace('/\.+/', '.', preg_replace('/\D/', '.', $arr[2]));
2027 $PHPWIKI_VERSION = $arr[0] * 1000 + $arr[1] * 10 + 0.01 * $arr[2];
2028 if (strstr(PHPWIKI_VERSION, 'pre') or strstr(PHPWIKI_VERSION, 'rc'))
2029 $PHPWIKI_VERSION -= 0.01;
2031 return $PHPWIKI_VERSION;
2034 function phpwiki_gzhandler($ob)
2036 if (function_exists('gzencode'))
2037 $ob = gzencode($ob);
2038 $GLOBALS['request']->_ob_get_length = strlen($ob);
2039 if (!headers_sent()) {
2040 header(sprintf("Content-Length: %d", $GLOBALS['request']->_ob_get_length));
2045 function isWikiWord($word)
2047 global $WikiNameRegexp;
2048 //or preg_match('/\A' . $WikiNameRegexp . '\z/', $word) ??
2049 return preg_match("/^$WikiNameRegexp\$/", $word);
2052 // needed to store serialized objects-values only (perm, pref)
2053 function obj2hash($obj, $exclude = false, $fields = false)
2056 if (!$fields) $fields = get_object_vars($obj);
2057 foreach ($fields as $key => $val) {
2058 if (is_array($exclude)) {
2059 if (in_array($key, $exclude)) continue;
2067 * isAsciiString($string)
2069 function isAsciiString($s)
2071 $ptrASCII = '[\x00-\x7F]';
2072 return preg_match("/^($ptrASCII)*$/s", $s);
2076 * isUtf8String($string) - cheap utf-8 detection
2078 * segfaults for strings longer than 10kb!
2079 * Use http://www.phpdiscuss.com/article.php?id=565&group=php.i18n or
2080 * checkTitleEncoding() at http://cvs.sourceforge.net/viewcvs.py/wikipedia/phase3/languages/Language.php
2082 function isUtf8String($s)
2084 $ptrASCII = '[\x00-\x7F]';
2085 $ptr2Octet = '[\xC2-\xDF][\x80-\xBF]';
2086 $ptr3Octet = '[\xE0-\xEF][\x80-\xBF]{2}';
2087 $ptr4Octet = '[\xF0-\xF4][\x80-\xBF]{3}';
2088 $ptr5Octet = '[\xF8-\xFB][\x80-\xBF]{4}';
2089 $ptr6Octet = '[\xFC-\xFD][\x80-\xBF]{5}';
2090 return preg_match("/^($ptrASCII|$ptr2Octet|$ptr3Octet|$ptr4Octet|$ptr5Octet|$ptr6Octet)*$/s", $s);
2094 * Check for UTF-8 URLs; Internet Explorer produces these if you
2095 * type non-ASCII chars in the URL bar or follow unescaped links.
2096 * Requires urldecoded pagename.
2097 * Fixes sf.net bug #953949
2099 * src: languages/Language.php:checkTitleEncoding() from mediawiki
2101 function fixTitleEncoding($s)
2107 if (empty($s)) return $s;
2109 $ishigh = preg_match('/[\x80-\xff]/', $s);
2111 $isutf = ($ishigh ? preg_match( '/^([\x00-\x7f]|[\xc0-\xdf][\x80-\xbf]|' .
2112 '[\xe0-\xef][\x80-\xbf]{2}|[\xf0-\xf7][\x80-\xbf]{3})+$/', $s ) : true );
2114 $isutf = ($ishigh ? isUtf8String($s) : true);
2115 $locharset = strtolower($charset);
2117 if ($locharset != "utf-8" and $ishigh and $isutf)
2118 $s = charset_convert('UTF-8', $locharset, $s);
2119 if ($locharset == "utf-8" and $ishigh and !$isutf)
2120 return utf8_encode($s);
2122 // Other languages can safely leave this function, or replace
2123 // it with one to detect and convert another legacy encoding.
2128 * MySQL fulltext index doesn't grok utf-8, so we
2129 * need to fold cases and convert to hex.
2130 * src: languages/Language.php:stripForSearch() from mediawiki
2133 function stripForSearch( $string ) {
2134 global $wikiLowerChars;
2135 // '/(?:[a-z]|\xc3[\x9f-\xbf]|\xc4[\x81\x83\x85\x87])/' => "a-z\xdf-\xf6\xf8-\xff"
2136 return preg_replace(
2137 "/([\\xc0-\\xff][\\x80-\\xbf]*)/e",
2138 "'U8' . bin2hex( strtr( \"\$1\", \$wikiLowerChars ) )",
2144 * Workaround for allow_url_fopen, to get the content of an external URI.
2145 * It returns the contents in one slurp. Parsers might want to check for allow_url_fopen
2146 * and use fopen, fread chunkwise. (see lib/XmlParser.php)
2148 function url_get_contents($uri)
2150 if (get_cfg_var('allow_url_fopen')) { // was ini_get('allow_url_fopen'))
2151 return @file_get_contents($uri);
2153 require_once 'lib/HttpClient.php';
2154 $bits = parse_url($uri);
2155 $host = $bits['host'];
2156 $port = isset($bits['port']) ? $bits['port'] : 80;
2157 $path = isset($bits['path']) ? $bits['path'] : '/';
2158 if (isset($bits['query'])) {
2159 $path .= '?' . $bits['query'];
2161 $client = new HttpClient($host, $port);
2162 $client->use_gzip = false;
2163 if (!$client->get($path)) {
2166 return $client->getContent();
2172 * Generate consecutively named strings:
2173 * Name, Name2, Name3, ...
2175 function GenerateId($name)
2177 static $ids = array();
2178 if (empty($ids[$name])) {
2183 return $name . $ids[$name];
2187 // from IncludePage. To be of general use.
2188 // content: string or array of strings
2189 function firstNWordsOfContent($n, $content)
2191 if ($content and $n > 0) {
2192 if (is_array($content)) {
2193 // fixme: return a list of lines then?
2194 //$content = join("\n", $content);
2195 //$return_array = true;
2197 foreach ($content as $line) {
2198 $words = explode(' ', $line);
2199 if ($wordcount + count($words) > $n) {
2200 $new[] = implode(' ', array_slice($words, 0, $n - $wordcount))
2201 . sprintf(_("... (first %s words)"), $n);
2204 $wordcount += count($words);
2210 // fixme: use better whitespace/word seperators
2211 $words = explode(' ', $content);
2212 if (count($words) > $n) {
2213 return join(' ', array_slice($words, 0, $n))
2214 . sprintf(_("... (first %s words)"), $n);
2224 // moved from lib/plugin/IncludePage.php
2225 function extractSection($section, $content, $page, $quiet = false, $sectionhead = false)
2227 $qsection = preg_replace('/\s+/', '\s+', preg_quote($section, '/'));
2229 if (preg_match("/ ^(!{1,}|={2,})\\s*$qsection\s*=*" // section header
2230 . " \\s*$\\n?" // possible blank lines
2231 . " ( (?: ^.*\\n? )*? )" // some lines
2232 . " (?= ^\\1 | \\Z)/xm", // sec header (same or higher level) (or EOF)
2233 implode("\n", $content),
2236 // Strip trailing blanks lines and ---- <hr>s
2237 $text = preg_replace("/\\s*^-{4,}\\s*$/m", "", $match[2]);
2239 $text = $match[1] . $section . "\n" . $text;
2240 return explode("\n", $text);
2243 $mesg = $page . " " . $section;
2246 return array(sprintf(_("<%s: no such section>"), $mesg));
2249 // Extract the first $sections sections of the page
2250 function extractSections($sections, $content, $page, $quiet = false, $sectionhead = false)
2253 $mycontent = $content;
2256 while ($sections > 0) {
2258 if (preg_match("/ ^(!{1,}|={2,})\\s*(.*)\\n" // section header
2259 . " \\s*$\\n?" // possible blank lines
2260 . " ( (?: ^.*\\n? )*? )" // some lines
2261 . " ( ^\\1 (.|\\n)* | \\Z)/xm", // sec header (same or higher level) (or EOF)
2262 implode("\n", $mycontent),
2265 $section = $match[2];
2266 // Strip trailing blanks lines and ---- <hr>s
2267 $text = preg_replace("/\\s*^-{4,}\\s*$/m", "", $match[3]);
2269 $text = $match[1] . $section . "\n" . $text;
2272 $mycontent = explode("\n", $match[4]);
2274 if ($sections === 0) {
2275 return explode("\n", $result);
2281 // use this faster version: only load ExternalReferrer if we came from an external referrer
2282 function isExternalReferrer(&$request)
2284 if ($referrer = $request->get('HTTP_REFERER')) {
2285 $home = SERVER_URL; // SERVER_URL or SCRIPT_NAME, if we want to check sister wiki's also
2286 if (string_starts_with(strtolower($referrer), strtolower($home))) return false;
2287 require_once 'lib/ExternalReferrer.php';
2288 $se = new SearchEngines();
2289 return $se->parseSearchQuery($referrer);
2291 //if (DEBUG) return array('query' => 'wiki');
2296 * Useful for PECL overrides: cvsclient, ldap, soap, xmlrpc, pdo, pdo_<driver>
2298 function loadPhpExtension($extension)
2300 if (!extension_loaded($extension)) {
2301 $isWindows = (substr(PHP_OS, 0, 3) == 'WIN');
2302 $soname = ($isWindows ? 'php_' : '')
2304 . ($isWindows ? '.dll' : '.so');
2308 return extension_loaded($extension);
2311 function charset_convert($from, $to, $data)
2314 //$wikicharset = strtolower($CHARSET);
2315 //$systemcharset = strtolower(get_cfg_var('iconv.internal_encoding')); // 'iso-8859-1';
2316 if (strtolower($from) == 'utf-8' and strtolower($to) == 'iso-8859-1')
2317 return utf8_decode($data);
2318 if (strtolower($to) == 'utf-8' and strtolower($from) == 'iso-8859-1')
2319 return utf8_encode($data);
2321 if (loadPhpExtension("iconv")) {
2322 $tmpdata = iconv($from, $to, $data);
2324 trigger_error("charset conversion $from => $to failed. Wrong source charset?", E_USER_WARNING);
2328 trigger_error("The iconv extension cannot be loaded", E_USER_WARNING);
2333 function string_starts_with($string, $prefix)
2335 return (substr($string, 0, strlen($prefix)) == $prefix);
2338 function string_ends_with($string, $suffix)
2340 return (substr($string, -strlen($suffix)) == $suffix);
2343 function array_remove($arr, $value)
2345 return array_values(array_diff($arr, array($value)));
2349 * Ensure that the script will have another $secs time left.
2350 * Works only if safe_mode is off.
2351 * For example not to timeout on waiting socket connections.
2352 * Use the socket timeout as arg.
2354 function longer_timeout($secs = 30)
2356 $timeout = @ini_get("max_execution_time") ? ini_get("max_execution_time") : 30;
2357 $timeleft = $timeout - $GLOBALS['RUNTIMER']->getTime();
2358 if ($timeleft < $secs)
2359 @set_time_limit(max($timeout, (integer)($secs + $timeleft)));
2362 function printSimpleTrace($bt)
2365 echo "\nTraceback:\n";
2366 if (function_exists('debug_print_backtrace')) { // >= 5
2367 debug_print_backtrace();
2369 foreach ($bt as $i => $elem) {
2370 if (!array_key_exists('file', $elem)) {
2373 //echo join(" ",array_values($elem)),"\n";
2374 echo " ", $elem['file'], ':', $elem['line'], " ", $elem['function'], "\n";
2380 * Return the used process memory, in bytes.
2381 * Enable the section which will work for you. They are very slow.
2382 * Special quirks for Windows: Requires cygwin.
2384 function getMemoryUsage()
2386 //if (!(DEBUG & _DEBUG_VERBOSE)) return;
2387 if (function_exists('memory_get_usage') and memory_get_usage()) {
2388 return memory_get_usage();
2389 } elseif (function_exists('getrusage') and ($u = @getrusage()) and !empty($u['ru_maxrss'])) {
2390 $mem = $u['ru_maxrss'];
2391 } elseif (substr(PHP_OS, 0, 3) == 'WIN') { // may require a newer cygwin
2392 // what we want is the process memory only: apache or php (if CGI)
2395 // win32_ps_stat_proc, win32_ps_stat_mem
2396 if (function_exists('win32_ps_list_procs')) {
2397 $info = win32_ps_stat_proc($pid);
2398 $memstr = $info['mem']['working_set_size'];
2400 // This works only if it's a cygwin process (apache or php).
2401 // Requires a newer cygwin
2402 $memstr = exec("cat /proc/$pid/statm |cut -f1");
2404 // if it's native windows use something like this:
2405 // (requires pslist from sysinternals.com, grep, sed and perl)
2406 //$memstr = exec("pslist $pid|grep -A1 Mem|sed 1d|perl -ane\"print \$"."F[5]\"");
2408 return (integer)trim($memstr);
2411 //%MEM: Percentage of total memory in use by this process
2412 //VSZ: Total virtual memory size, in 1K blocks.
2413 //RSS: Real Set Size, the actual amount of physical memory allocated to this process.
2414 //CPU time used by process since it started.
2415 //echo "%",`ps -o%mem,vsz,rss,time -p $pid|sed 1d`,"\n";
2416 $memstr = exec("ps -orss -p $pid|sed 1d");
2417 return (integer)trim($memstr);
2422 * @param var $needle
2423 * @param array $haystack one-dimensional numeric array only, no hash
2425 * @desc Feed a sorted array to $haystack and a value to search for to $needle.
2426 It will return false if not found or the index where it was found.
2427 From dennis.decoene@moveit.be http://www.php.net/array_search
2429 function binary_search($needle, $haystack)
2431 $high = count($haystack);
2434 while (($high - $low) > 1) {
2435 $probe = floor(($high + $low) / 2);
2436 if ($haystack[$probe] < $needle) {
2438 } elseif ($haystack[$probe] == $needle) {
2439 $high = $low = $probe;
2445 if ($high == count($haystack) || $haystack[$high] != $needle) {
2452 function is_localhost()
2454 return $_SERVER['SERVER_ADDR'] == '127.0.0.1';
2458 * Take a string and quote it sufficiently to be passed as a Javascript
2459 * string between ''s
2461 function javascript_quote_string($s)
2463 return str_replace("'", "\'", $s);
2466 function isSerialized($s)
2468 return (!empty($s) and (strlen($s) > 3) and (substr($s, 1, 1) == ':'));
2472 * Determine if a variable represents a whole number
2475 function is_whole_number($var)
2477 return (is_numeric($var) && (intval($var) == floatval($var)));
2481 * Take a string and return an array of pairs (attribute name, attribute value)
2483 * We allow attributes with or without double quotes (")
2484 * Attribute-value pairs may be separated by space or comma
2485 * Space is normal HTML attributes, comma is for RichTable compatibility
2486 * border=1, cellpadding="5"
2487 * border=1 cellpadding="5"
2488 * style="font-family: sans-serif; border-top:1px solid #dddddd;"
2489 * style="font-family: Verdana, Arial, Helvetica, sans-serif"
2491 function parse_attributes($line)
2496 if (empty($line)) return $options;
2497 $line = trim($line);
2498 if (empty($line)) return $options;
2499 $line = trim($line, ",");
2500 if (empty($line)) return $options;
2502 // First we have an attribute name.
2507 while (($i < strlen($line)) && ($line[$i] != '=')) {
2510 $attribute = substr($line, 0, $i);
2511 $attribute = strtolower($attribute);
2513 $line = substr($line, $i + 1);
2514 $line = trim($line);
2515 $line = trim($line, "=");
2516 $line = trim($line);
2518 if (empty($line)) return $options;
2520 // Then we have the attribute value.
2523 // Attribute value might be between double quotes
2524 // In that case we have to find the closing double quote
2525 if ($line[0] == '"') {
2526 $i++; // skip first '"'
2527 while (($i < strlen($line)) && ($line[$i] != '"')) {
2530 $value = substr($line, 0, $i);
2531 $value = trim($value, '"');
2532 $value = trim($value);
2534 // If there are no double quotes, we have to find the next space or comma
2536 while (($i < strlen($line)) && (($line[$i] != ' ') && ($line[$i] != ','))) {
2539 $value = substr($line, 0, $i);
2540 $value = trim($value);
2541 $value = trim($value, ",");
2542 $value = trim($value);
2545 $options[$attribute] = $value;
2547 $line = substr($line, $i + 1);
2548 $line = trim($line);
2549 $line = trim($line, ",");
2550 $line = trim($line);
2552 return $options + parse_attributes($line);
2556 * Returns true if the filename ends with an image suffix.
2557 * Uses INLINE_IMAGES if defined, else "png|jpg|jpeg|gif"
2559 function is_image($filename)
2562 if (defined('INLINE_IMAGES')) {
2563 $inline_images = INLINE_IMAGES;
2565 $inline_images = "png|jpg|jpeg|gif";
2568 foreach (explode("|", $inline_images) as $suffix) {
2569 if (string_ends_with(strtolower($filename), "." . $suffix)) {
2577 * Returns true if the filename ends with an video suffix.
2578 * Currently only FLV and OGG
2580 function is_video($filename)
2583 return string_ends_with(strtolower($filename), ".flv")
2584 or string_ends_with(strtolower($filename), ".ogg");
2588 * Remove accents from given text.
2590 function strip_accents($text)
2592 $res = utf8_decode($text);
2594 utf8_decode('àáâãäçèéêëìíîïñòóôõöùúûüýÿÀÁÂÃÄÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝ'),
2595 'aaaaaceeeeiiiinooooouuuuyyAAAAACEEEEIIIINOOOOOUUUUY');
2596 return utf8_encode($res);
2602 // c-basic-offset: 4
2603 // c-hanging-comment-ender-p: nil
2604 // indent-tabs-mode: nil