3 /* Copyright (C) 2002 Geoffrey T. Dairiki <dairiki@dairiki.org>
4 * Copyright (C) 2004-2010 $ThePhpWikiProgrammingTeam
5 * Copyright (C) 2008-2009 Marc-Etienne Vargenau, Alcatel-Lucent
7 * This file is part of PhpWiki.
9 * PhpWiki is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * PhpWiki is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 require_once 'lib/Units.php';
26 class CacheableMarkup extends XmlContent
28 function __construct($content, $basepage)
30 $this->_basepage = $basepage;
32 $this->_content = array();
33 $this->_append($content);
34 if ($this->_buf != '')
35 $this->_content[] = $this->_buf;
42 // This causes a strange bug when a comment containing
43 // a single quote is entered in the Summary box:
44 // - the history is wrong (user and comment missing)
45 // - the table of contents plugin no longer works
47 if (is_a($WikiTheme, 'WikiTheme_fusionforge')) {
48 return serialize($this);
51 return gzcompress(serialize($this), 9);
54 static function unpack($packed)
59 // ZLIB format has a five bit checksum in its header.
60 // Lets check for sanity.
61 if (((ord($packed[0]) * 256 + ord($packed[1])) % 31 == 0)
62 and (substr($packed, 0, 2) == "\037\213")
63 or (substr($packed, 0, 2) == "x\332")
67 $data = gzuncompress($packed);
68 return unserialize($data);
70 if (substr($packed, 0, 2) == "O:") {
71 // Looks like a serialized object
72 return unserialize($packed);
74 if (preg_match("/^\w+$/", $packed))
76 // happened with DebugBackendInfo problem also.
77 trigger_error("Can't unpack bad cached markup. Probably php_zlib extension not loaded.",
82 /** Get names of wikipages linked to.
84 * @return array of hashes { linkto=>pagename, relation=>pagename }
86 function getWikiPageLinks()
89 foreach ($this->_content as $item) {
90 if (!is_a($item, 'Cached_DynamicContent'))
92 if (!($item_links = $item->getWikiPageLinks($this->_basepage)))
94 $links = array_merge($links, $item_links);
96 // array_unique has a bug with hashes!
97 // set_links checks for duplicates, array_merge does not
98 //return array_unique($links);
104 * This is here to support the XML-RPC listLinks() method.
107 * Returns an array of hashes.
109 function getLinkInfo()
112 foreach ($this->_content as $link) {
113 if (!is_a($link, 'Cached_Link'))
115 $info = $link->getLinkInfo($this->_basepage);
116 $links[$info->href] = $info;
118 return array_values($links);
121 function _append($item)
123 if (is_array($item)) {
124 foreach ($item as $subitem)
125 $this->_append($subitem);
126 } elseif (!is_object($item)) {
127 $this->_buf .= $this->_quote((string)$item);
128 } elseif (is_a($item, 'Cached_DynamicContent')) {
130 $this->_content[] = $this->_buf;
133 $this->_content[] = $item;
134 } elseif (is_a($item, 'XmlElement')) {
135 if ($item->isEmpty()) {
136 $this->_buf .= $item->emptyTag();
138 $this->_buf .= $item->startTag();
139 foreach ($item->getContent() as $subitem)
140 $this->_append($subitem);
141 $this->_buf .= "</$item->_tag>";
143 if (!$this->getDescription() and $item->getTag() == 'p') {
144 // performance: when is this really needed?
145 $this->_glean_description($item->asString());
148 if (!$item->isInlineElement())
150 } elseif (is_a($item, 'XmlContent')) {
151 foreach ($item->getContent() as $item)
152 $this->_append($item);
153 } elseif (method_exists($item, 'asXML')) {
154 $this->_buf .= $item->asXML();
155 } elseif (method_exists($item, 'asString')) {
156 $this->_buf .= $this->_quote($item->asString());
158 $this->_buf .= sprintf("==Object(%s)==", get_class($item));
162 function _glean_description($text)
164 static $two_sentences;
165 if (!$two_sentences) {
166 $two_sentences = "[.?!][\")]*\s+[\"(]*[[:upper:])]"
168 . "[.?!][\")]*\s*[\"(]*([[:upper:])]|$)";
171 if (!isset($this->_description) and preg_match("/$two_sentences/sx", $text))
172 $this->_description = preg_replace("/\s*\n\s*/", " ", trim($text));
176 * Guess a short description of the page.
180 * This algorithm was suggested on MeatballWiki by
181 * Alex Schroeder <kensanata@yahoo.com>.
183 * Use the first paragraph in the page which contains at least two
186 * @see http://www.usemod.com/cgi-bin/mb.pl?MeatballWikiSuggestions
190 function getDescription()
192 return isset($this->_description) ? $this->_description : '';
198 $basepage = $this->_basepage;
200 foreach ($this->_content as $item) {
201 if (is_string($item)) {
203 } elseif (is_subclass_of($item, 'Cached_DynamicContent')
205 $val = $item->expand($basepage, $this);
206 $xml .= $val->asXML();
208 $xml .= $item->asXML();
216 $basepage = $this->_basepage;
217 // _content might be changed from a plugin (CreateToc)
218 for ($i = 0; $i < count($this->_content); $i++) {
219 $item = $this->_content[$i];
220 if (is_string($item)) {
222 } elseif (is_subclass_of($item, 'Cached_DynamicContent')
223 ) { // give the content the chance to know about itself or even
225 $val = $item->expand($basepage, $this);
237 * The base class for all dynamic content.
239 * Dynamic content is anything that can change even when the original
240 * wiki-text from which it was parsed is unchanged.
242 abstract class Cached_DynamicContent
244 function cache(&$cache)
249 abstract protected function expand($basepage, &$obj);
251 function getWikiPageLinks($basepage)
257 class XmlRpc_LinkInfo
259 function XmlRpc_LinkInfo($page, $type, $href, $relation = '')
264 $this->relation = $relation;
265 //$this->pageref = str_replace("/RPC2.php", "/index.php", $href);
269 abstract class Cached_Link extends Cached_DynamicContent
274 function isInlineElement()
279 /** Get link info (for XML-RPC support)
281 * This is here to support the XML-RPC listLinks method.
282 * (See http://www.ecyrd.com/JSPWiki/Wiki.jsp?page=WikiRPCInterface)
284 function getLinkInfo($basepage)
286 return new XmlRpc_LinkInfo($this->_getName($basepage),
288 $this->_getURL($basepage),
289 $this->_getRelation($basepage));
292 function _getURL($basepage)
299 * Defer interwiki inline links. img src=upload:xx.png
300 * LinkImage($url, $alt = false)
302 class Cached_InlinedImage extends Cached_DynamicContent
307 function isInlineElement()
312 function _getURL($basepage)
317 // TODO: fix interwiki inline links in case of static dumps
318 function expand($basepage, &$markup)
321 $this->_basepage = $basepage;
322 $label = isset($this->_label) ? $this->_label : false;
323 if ($WikiTheme->DUMP_MODE) {
324 // In case of static dumps we need to check if we should
325 // inline the image or not: external: keep link, internal: copy locally
326 return LinkImage($label);
328 return LinkImage($label);
333 class Cached_WikiLink extends Cached_Link
337 * @param string $page
338 * @param string $label
339 * @param string $anchor
341 function __construct($page, $label = '', $anchor = '')
343 $this->_page = $page;
344 /* ":DontStoreLink" */
345 if (substr($this->_page, 0, 1) == ':') {
346 $this->_page = substr($this->_page, 1);
347 $this->_nolink = true;
350 $this->_anchor = $anchor;
351 if ($label and $label != $page)
352 $this->_label = $label;
353 $this->_basepage = false;
361 function getPagename($basepage)
363 $page = new WikiPageName($this->_page, $basepage);
364 if ($page->isValid())
370 function getWikiPageLinks($basepage)
374 if (isset($this->_nolink))
376 if ($link = $this->getPagename($basepage))
377 return array(array('linkto' => $link));
382 function _getName($basepage)
384 return $this->getPagename($basepage);
387 function _getURL($basepage)
389 return WikiURL($this->getPagename($basepage));
390 //return WikiURL($this->getPagename($basepage), false, 'abs_url');
393 function expand($basepage, &$markup)
396 $this->_basepage = $basepage;
397 $label = isset($this->_label) ? $this->_label : false;
398 $anchor = isset($this->_anchor) ? (string)$this->_anchor : '';
399 $page = new WikiPageName($this->_page, $basepage, $anchor);
400 if ($WikiTheme->DUMP_MODE and !empty($WikiTheme->VALID_LINKS)) {
401 if (!in_array($this->_page, $WikiTheme->VALID_LINKS))
402 return HTML($label ? $label : $page->getName());
404 if ($page->isValid()) return WikiLink($page, 'auto', $label);
405 else return HTML($label);
411 $label = isset($this->_label) ? $this->_label : false;
412 $anchor = isset($this->_anchor) ? (string)$this->_anchor : '';
413 //TODO: need basepage for subpages like /Remove (within CreateTOC)
414 $page = new WikiPageName($this->_page, $this->_basepage, $anchor);
415 if ($WikiTheme->DUMP_MODE and $WikiTheme->VALID_LINKS) {
416 if (!in_array($this->_page, $WikiTheme->VALID_LINKS))
417 return $label ? $label : $page->getName();
419 $link = WikiLink($page, 'auto', $label);
420 return $link->asXML();
425 if (isset($this->_label))
426 return $this->_label;
431 class Cached_WikiLinkIfKnown extends Cached_WikiLink
433 function __construct($moniker)
435 $this->_page = $moniker;
438 function expand($basepage, &$markup)
441 if ($WikiTheme->DUMP_MODE and $WikiTheme->VALID_LINKS) {
442 if (!in_array($this->_page, $WikiTheme->VALID_LINKS))
443 return HTML($label ? $label : $page->getName());
445 return WikiLink($this->_page, 'if_known');
449 class Cached_SpellCheck extends Cached_WikiLink
451 function __construct($word, $suggs)
453 $this->_page = $word;
454 $this->suggestions = $suggs;
457 function expand($basepage, &$markup)
459 $link = HTML::a(array('class' => 'spell-wrong',
460 'title' => 'SpellCheck: ' . join(', ', $this->suggestions),
461 'name' => $this->_page),
467 class Cached_PhpwikiURL extends Cached_DynamicContent
471 function __construct($url, $label)
475 $this->_label = $label;
478 function isInlineElement()
483 function expand($basepage, &$markup)
486 $label = isset($this->_label) ? $this->_label : false;
487 if ($WikiTheme->DUMP_MODE and $WikiTheme->VALID_LINKS) {
488 if (!in_array($this->_page, $WikiTheme->VALID_LINKS))
489 return HTML($label ? $label : $page->getName());
491 return LinkPhpwikiURL($this->_url, $label, $basepage);
496 $label = isset($this->_label) ? $this->_label : false;
497 $link = LinkPhpwikiURL($this->_url, $label);
498 return $link->asXML();
503 if (isset($this->_label))
504 return $this->_label;
510 * Relations (::) are named links to pages.
511 * Attributes (:=) are named metadata per page, "named links to numbers with units".
512 * We don't want to exhaust the linktable with numbers,
513 * since this would create empty pages per each value,
514 * so we don't store the attributes as full relationlink.
515 * But we do store the attribute name as relation with an empty pagename
516 * to denote that this is an attribute,
517 * and to enable a fast listRelations mode=attributes
519 class Cached_SemanticLink extends Cached_WikiLink
522 public $_attribute_base;
525 function __construct($url, $label = false)
528 if ($label && $label != $url)
529 $this->_label = $label;
530 $this->_expandurl($this->_url);
533 function isInlineElement()
538 function getPagename($basepage)
540 if (!isset($this->_page)) return false;
541 $page = new WikiPageName($this->_page, $basepage);
542 if ($page->isValid()) return $page->name;
546 /* Add relation to the link table.
547 * attributes have the _relation, but not the _page set.
549 function getWikiPageLinks($basepage)
552 * @var WikiRequest $request
556 if ($basepage == '') return false;
557 if (!isset($this->_page) and isset($this->_attribute)) {
558 // An attribute: we store it in the basepage now, to fill the cache for page->save
559 // TODO: side-effect free query
560 $page = $request->getPage($basepage);
561 $page->setAttribute($this->_relation, $this->_attribute);
562 $this->_page = $basepage;
563 return array(array('linkto' => '', 'relation' => $this->_relation));
565 if ($link = $this->getPagename($basepage))
566 return array(array('linkto' => $link, 'relation' => $this->_relation));
571 function _expandurl($url)
574 if (!preg_match('/^ ([^:]+) (:[:=]) (.+) $/x', $url, $m)) {
575 return HTML::span(array('class' => 'error'), _("BAD semantic relation link"));
577 $this->_relation = urldecode($m[1]);
578 $is_attribute = ($m[2] == ':=');
580 $this->_attribute = urldecode($m[3]);
581 // since this stored in the markup cache, we are extra sensible
582 // not to store false empty stuff.
583 $units = new Units();
584 if (!DISABLE_UNITS and !$units->errcode) {
585 $this->_attribute_base = $units->Definition($this->_attribute);
586 $this->_unit = $units->baseunit($this->_attribute);
589 $this->_page = urldecode($m[3]);
594 function _expand($url, $label = false)
597 $m = $this->_expandurl($url);
598 // do not link to the attribute value, but to the attribute
599 $is_attribute = ($m[2] == ':=');
600 if ($WikiTheme->DUMP_MODE and $WikiTheme->VALID_LINKS) {
601 if (isset($this->_page) and !in_array($this->_page, $WikiTheme->VALID_LINKS))
602 return HTML($label ? $label : ($is_attribute ? $this->_relation : $this->_page));
605 $title = isset($this->_attribute_base)
606 ? sprintf(_("Attribute %s, base value: %s"), $this->_relation, $this->_attribute_base)
607 : sprintf(_("Attribute %s, value: %s"), $this->_relation, $this->_attribute);
610 HTML::a(array('href' => WikiURL($is_attribute ? $this->_relation : $this->_page),
611 'class' => "wiki " . ($is_attribute ? "attribute" : "relation"),
612 'title' => $is_attribute
614 : sprintf(_("Relation %s to page %s"), $this->_relation, $this->_page)),
617 } elseif ($is_attribute) {
620 HTML::a(array('href' => WikiURL($this->_relation),
621 'class' => "wiki attribute",
628 HTML::a(array('href' => WikiURL($this->_relation),
629 'class' => "wiki relation"),
631 HTML::span(array('class' => 'relation-symbol'), $m[2]),
632 HTML::a(array('href' => WikiURL($this->_page),
639 function expand($basepage, &$markup)
641 $label = isset($this->_label) ? $this->_label : false;
642 return $this->_expand($this->_url, $label);
647 $label = isset($this->_label) ? $this->_label : false;
648 $link = $this->_expand($this->_url, $label);
649 return $link->asXML();
654 if (isset($this->_label))
655 return $this->_label;
661 * Highlight found search engine terms
663 class Cached_SearchHighlight extends Cached_DynamicContent
665 function __construct($word, $engine)
667 $this->_word = $word;
668 $this->engine = $engine;
671 function expand($basepage, &$markup)
673 return HTML::span(array('class' => 'search-term',
674 'title' => _("Found by ") . $this->engine),
679 class Cached_ExternalLink extends Cached_Link
682 function __construct($url, $label = false)
685 if ($label && $label != $url)
686 $this->_label = $label;
694 function _getName($basepage)
696 $label = isset($this->_label) ? $this->_label : false;
697 return ($label and is_string($label)) ? $label : $this->_url;
700 function expand($basepage, &$markup)
704 $label = isset($this->_label) ? $this->_label : false;
705 $link = LinkURL($this->_url, $label);
707 if (GOOGLE_LINKS_NOFOLLOW) {
708 // Ignores nofollow when the user who saved the page was authenticated.
709 $page = $request->getPage($basepage);
710 $current = $page->getCurrentRevision(false);
711 if (!$current->get('author_id'))
712 $link->setAttr('rel', 'nofollow');
719 if (isset($this->_label) and is_string($this->_label))
720 return $this->_label;
725 class Cached_InterwikiLink extends Cached_ExternalLink
728 function __construct($link, $label = false)
730 $this->_link = $link;
732 $this->_label = $label;
735 function getPagename($basepage)
737 list ($moniker, $page) = explode(":", $this->_link, 2);
738 $page = new WikiPageName($page, $basepage);
739 if ($page->isValid()) {
746 function getWikiPageLinks($basepage)
749 * @var WikiRequest $request
753 if ($basepage == '') return false;
754 /* ":DontStoreLink" */
755 if (substr($this->_link, 0, 1) == ':') return false;
756 /* store only links to valid pagenames */
757 $dbi = $request->getDbh();
758 if ($link = $this->getPagename($basepage) and $dbi->isWikiPage($link)) {
759 return array(array('linkto' => $link));
761 return false; // dont store external links
765 function _getName($basepage)
767 $label = isset($this->_label) ? $this->_label : false;
768 return ($label and is_string($label)) ? $label : $this->_link;
771 /* there may be internal interwiki links also */
774 return $this->getPagename(false) ? 'internal' : 'external';
777 function _getURL($basepage)
779 $link = $this->expand($basepage, $this);
780 return $link->getAttr('href');
783 function expand($basepage, &$markup)
786 $intermap = getInterwikiMap();
787 $label = isset($this->_label) ? $this->_label : false;
788 //FIXME: check Upload: inlined images
789 if ($WikiTheme->DUMP_MODE and !empty($WikiTheme->VALID_LINKS)) {
790 if (!in_array($this->_link, $WikiTheme->VALID_LINKS))
791 return HTML($label ? $label : $this->_link);
793 return $intermap->link($this->_link, $label);
798 if (isset($this->_label))
799 return $this->_label;
804 // Needed to put UserPages to backlinks. Special method to markup userpages with icons
805 // Thanks to Dan Frankowski for finding this bug.
806 // Fixed since 1.3.8, prev. versions had no userpages in backlinks
807 class Cached_UserLink extends Cached_WikiLink
809 function expand($basepage, &$markup)
811 $label = isset($this->_label) ? $this->_label : false;
812 $anchor = isset($this->_anchor) ? (string)$this->_anchor : '';
813 $page = new WikiPageName($this->_page, $basepage, $anchor);
814 $link = WikiLink($page, 'auto', $label);
815 // $link = HTML::a(array('href' => $PageName));
816 $link->setContent(PossiblyGlueIconToText('wikiuser', $this->_page));
817 $link->setAttr('class', 'wikiuser');
823 * 1.3.13: Previously stored was only _pi.
824 * A fresh generated cache has now ->name and ->args also.
825 * main::isActionPage only checks the raw content.
827 class Cached_PluginInvocation extends Cached_DynamicContent
830 function __construct($pi)
833 $loader = $this->_getLoader();
834 if (is_array($plugin_cmdline = $loader->parsePI($pi)) and $plugin_cmdline[1]) {
835 $this->pi_name = $plugin_cmdline[0]; // plugin, plugin-form, plugin-list
836 $this->name = $plugin_cmdline[1]->getName();
837 $this->args = $plugin_cmdline[2];
841 function isInlineElement()
846 function expand($basepage, &$markup)
849 * @var WikiRequest $request
853 $loader = $this->_getLoader();
854 $xml = $loader->expandPI($this->_pi, $request, $markup, $basepage);
863 function getWikiPageLinks($basepage)
865 $loader = $this->_getLoader();
867 return $loader->getWikiPageLinks($this->_pi, $basepage);
870 function & _getLoader()
872 static $loader = false;
875 include_once 'lib/WikiPlugin.php';
876 $loader = new WikiPluginLoader();
886 // c-hanging-comment-ender-p: nil
887 // indent-tabs-mode: nil