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
29 function CacheableMarkup($content, $basepage)
31 $this->_basepage = $basepage;
33 $this->_content = array();
34 $this->_append($content);
35 if ($this->_buf != '')
36 $this->_content[] = $this->_buf;
43 // This causes a strange bug when a comment containing
44 // a single quote is entered in the Summary box:
45 // - the history is wrong (user and comment missing)
46 // - the table of contents plugin no longer works
48 if (isa($WikiTheme, 'WikiTheme_fusionforge')) {
49 return serialize($this);
52 if (function_exists('gzcompress'))
53 return gzcompress(serialize($this), 9);
54 return serialize($this);
56 // FIXME: probably should implement some sort of "compression"
57 // when no gzcompress is available.
60 function unpack($packed)
65 // ZLIB format has a five bit checksum in it's header.
66 // Lets check for sanity.
67 if (((ord($packed[0]) * 256 + ord($packed[1])) % 31 == 0)
68 and (substr($packed, 0, 2) == "\037\213")
69 or (substr($packed, 0, 2) == "x\332")
72 if (function_exists('gzuncompress')) {
74 $data = gzuncompress($packed);
75 return unserialize($data);
77 // user our php lib. TESTME
78 include_once 'ziplib.php';
79 $zip = new ZipReader($packed);
80 list(, $data, $attrib) = $zip->readFile();
81 return unserialize($data);
84 if (substr($packed, 0, 2) == "O:") {
85 // Looks like a serialized object
86 return unserialize($packed);
88 if (preg_match("/^\w+$/", $packed))
90 // happened with _BackendInfo problem also.
91 trigger_error("Can't unpack bad cached markup. Probably php_zlib extension not loaded.",
96 /** Get names of wikipages linked to.
98 * @return array of hashes { linkto=>pagename, relation=>pagename }
100 function getWikiPageLinks()
103 foreach ($this->_content as $item) {
104 if (!isa($item, 'Cached_DynamicContent'))
106 if (!($item_links = $item->getWikiPageLinks($this->_basepage)))
108 $links = array_merge($links, $item_links);
110 // array_unique has a bug with hashes!
111 // set_links checks for duplicates, array_merge does not
112 //return array_unique($links);
118 * This is here to support the XML-RPC listLinks() method.
121 * Returns an array of hashes.
123 function getLinkInfo()
126 foreach ($this->_content as $link) {
127 if (!isa($link, 'Cached_Link'))
129 $info = $link->getLinkInfo($this->_basepage);
130 $links[$info->href] = $info;
132 return array_values($links);
135 function _append($item)
137 if (is_array($item)) {
138 foreach ($item as $subitem)
139 $this->_append($subitem);
140 } elseif (!is_object($item)) {
141 $this->_buf .= $this->_quote((string)$item);
142 } elseif (isa($item, 'Cached_DynamicContent')) {
144 $this->_content[] = $this->_buf;
147 $this->_content[] = $item;
148 } elseif (isa($item, 'XmlElement')) {
149 if ($item->isEmpty()) {
150 $this->_buf .= $item->emptyTag();
152 $this->_buf .= $item->startTag();
153 foreach ($item->getContent() as $subitem)
154 $this->_append($subitem);
155 $this->_buf .= "</$item->_tag>";
157 if (!$this->getDescription() and $item->getTag() == 'p') {
158 // performance: when is this really needed?
159 $this->_glean_description($item->asString());
162 if (!$item->isInlineElement())
164 } elseif (isa($item, 'XmlContent')) {
165 foreach ($item->getContent() as $item)
166 $this->_append($item);
167 } elseif (method_exists($item, 'asXML')) {
168 $this->_buf .= $item->asXML();
169 } elseif (method_exists($item, 'asString')) {
170 $this->_buf .= $this->_quote($item->asString());
172 $this->_buf .= sprintf("==Object(%s)==", get_class($item));
176 function _glean_description($text)
178 static $two_sentences;
179 if (!$two_sentences) {
180 $two_sentences = "[.?!][\")]*\s+[\"(]*[[:upper:])]"
182 . "[.?!][\")]*\s*[\"(]*([[:upper:])]|$)";
185 if (!isset($this->_description) and preg_match("/$two_sentences/sx", $text))
186 $this->_description = preg_replace("/\s*\n\s*/", " ", trim($text));
190 * Guess a short description of the page.
194 * This algorithm was suggested on MeatballWiki by
195 * Alex Schroeder <kensanata@yahoo.com>.
197 * Use the first paragraph in the page which contains at least two
200 * @see http://www.usemod.com/cgi-bin/mb.pl?MeatballWikiSuggestions
204 function getDescription()
206 return isset($this->_description) ? $this->_description : '';
212 $basepage = $this->_basepage;
214 foreach ($this->_content as $item) {
215 if (is_string($item)) {
217 } elseif (is_subclass_of($item,
219 ? 'Cached_DynamicContent'
220 : 'cached_dynamiccontent')
222 $val = $item->expand($basepage, $this);
223 $xml .= $val->asXML();
225 $xml .= $item->asXML();
233 $basepage = $this->_basepage;
234 // _content might be changed from a plugin (CreateToc)
235 for ($i = 0; $i < count($this->_content); $i++) {
236 $item = $this->_content[$i];
237 if (is_string($item)) {
239 } elseif (is_subclass_of($item,
241 ? 'Cached_DynamicContent'
242 : 'cached_dynamiccontent')
243 ) { // give the content the chance to know about itself or even
245 $val = $item->expand($basepage, $this);
246 if ($val) $val->printXML();
247 else trigger_error('empty item ' . print_r($item, true));
256 * The base class for all dynamic content.
258 * Dynamic content is anything that can change even when the original
259 * wiki-text from which it was parsed is unchanged.
261 class Cached_DynamicContent
264 function cache(&$cache)
269 function expand($basepage, &$obj)
271 trigger_error("Pure virtual", E_USER_ERROR);
274 function getWikiPageLinks($basepage)
280 class XmlRpc_LinkInfo
282 function XmlRpc_LinkInfo($page, $type, $href, $relation = '')
287 $this->relation = $relation;
288 //$this->pageref = str_replace("/RPC2.php", "/index.php", $href);
292 class Cached_Link extends Cached_DynamicContent
295 function isInlineElement()
300 /** Get link info (for XML-RPC support)
302 * This is here to support the XML-RPC listLinks method.
303 * (See http://www.ecyrd.com/JSPWiki/Wiki.jsp?page=WikiRPCInterface)
305 function getLinkInfo($basepage)
307 return new XmlRpc_LinkInfo($this->_getName($basepage),
309 $this->_getURL($basepage),
310 $this->_getRelation($basepage));
313 function _getURL($basepage)
318 function __getRelation($basepage)
320 return $this->_relation;
325 * Defer interwiki inline links. img src=upload:xx.png
326 * LinkImage($url, $alt = false)
328 class Cached_InlinedImage extends Cached_DynamicContent
330 function isInlineElement()
335 function _getURL($basepage)
340 // TODO: fix interwiki inline links in case of static dumps
341 function expand($basepage, &$markup)
344 $this->_basepage = $basepage;
345 $label = isset($this->_label) ? $this->_label : false;
346 if ($WikiTheme->DUMP_MODE) {
347 // In case of static dumps we need to check if we should
348 // inline the image or not: external: keep link, internal: copy locally
349 return LinkImage($label);
351 return LinkImage($label);
356 class Cached_WikiLink extends Cached_Link
359 function Cached_WikiLink($page, $label = false, $anchor = false)
361 $this->_page = $page;
362 /* ":DontStoreLink" */
363 if (substr($this->_page, 0, 1) == ':') {
364 $this->_page = substr($this->_page, 1);
365 $this->_nolink = true;
368 $this->_anchor = $anchor;
369 if ($label and $label != $page)
370 $this->_label = $label;
371 $this->_basepage = false;
379 function getPagename($basepage)
381 $page = new WikiPageName($this->_page, $basepage);
382 if ($page->isValid()) return $page->name;
386 function getWikiPageLinks($basepage)
388 if ($basepage == '') return false;
389 if (isset($this->_nolink)) return false;
390 if ($link = $this->getPagename($basepage))
391 return array(array('linkto' => $link));
396 function _getName($basepage)
398 return $this->getPagename($basepage);
401 function _getURL($basepage)
403 return WikiURL($this->getPagename($basepage));
404 //return WikiURL($this->getPagename($basepage), false, 'abs_url');
407 function expand($basepage, &$markup)
410 $this->_basepage = $basepage;
411 $label = isset($this->_label) ? $this->_label : false;
412 $anchor = isset($this->_anchor) ? (string)$this->_anchor : '';
413 $page = new WikiPageName($this->_page, $basepage, $anchor);
414 if ($WikiTheme->DUMP_MODE and !empty($WikiTheme->VALID_LINKS)) {
415 if (!in_array($this->_page, $WikiTheme->VALID_LINKS))
416 return HTML($label ? $label : $page->getName());
418 if ($page->isValid()) return WikiLink($page, 'auto', $label);
419 else return HTML($label);
425 $label = isset($this->_label) ? $this->_label : false;
426 $anchor = isset($this->_anchor) ? (string)$this->_anchor : '';
427 //TODO: need basepage for subpages like /Remove (within CreateTOC)
428 $page = new WikiPageName($this->_page, $this->_basepage, $anchor);
429 if ($WikiTheme->DUMP_MODE and $WikiTheme->VALID_LINKS) {
430 if (!in_array($this->_page, $WikiTheme->VALID_LINKS))
431 return $label ? $label : $page->getName();
433 $link = WikiLink($page, 'auto', $label);
434 return $link->asXML();
439 if (isset($this->_label))
440 return $this->_label;
445 class Cached_WikiLinkIfKnown extends Cached_WikiLink
447 function Cached_WikiLinkIfKnown($moniker)
449 $this->_page = $moniker;
452 function expand($basepage, &$markup)
455 if ($WikiTheme->DUMP_MODE and $WikiTheme->VALID_LINKS) {
456 if (!in_array($this->_page, $WikiTheme->VALID_LINKS))
457 return HTML($label ? $label : $page->getName());
459 return WikiLink($this->_page, 'if_known');
463 class Cached_SpellCheck extends Cached_WikiLink
465 function Cached_SpellCheck($word, $suggs)
467 $this->_page = $word;
468 $this->suggestions = $suggs;
471 function expand($basepage, &$markup)
473 $link = HTML::a(array('class' => 'spell-wrong',
474 'title' => 'SpellCheck: ' . join(', ', $this->suggestions),
475 'name' => $this->_page),
481 class Cached_PhpwikiURL extends Cached_DynamicContent
483 function Cached_PhpwikiURL($url, $label)
487 $this->_label = $label;
490 function isInlineElement()
495 function expand($basepage, &$markup)
498 $label = isset($this->_label) ? $this->_label : false;
499 if ($WikiTheme->DUMP_MODE and $WikiTheme->VALID_LINKS) {
500 if (!in_array($this->_page, $WikiTheme->VALID_LINKS))
501 return HTML($label ? $label : $page->getName());
503 return LinkPhpwikiURL($this->_url, $label, $basepage);
508 $label = isset($this->_label) ? $this->_label : false;
509 $link = LinkPhpwikiURL($this->_url, $label);
510 return $link->asXML();
515 if (isset($this->_label))
516 return $this->_label;
522 * Relations (::) are named links to pages.
523 * Attributes (:=) are named metadata per page, "named links to numbers with units".
524 * We don't want to exhaust the linktable with numbers,
525 * since this would create empty pages per each value,
526 * so we don't store the attributes as full relationlink.
527 * But we do store the attribute name as relation with an empty pagename
528 * to denote that this is an attribute,
529 * and to enable a fast listRelations mode=attributes
531 class Cached_SemanticLink extends Cached_WikiLink
534 function Cached_SemanticLink($url, $label = false)
537 if ($label && $label != $url)
538 $this->_label = $label;
539 $this->_expandurl($this->_url);
542 function isInlineElement()
547 function getPagename($basepage)
549 if (!isset($this->_page)) return false;
550 $page = new WikiPageName($this->_page, $basepage);
551 if ($page->isValid()) return $page->name;
555 /* Add relation to the link table.
556 * attributes have the _relation, but not the _page set.
558 function getWikiPageLinks($basepage)
560 if ($basepage == '') return false;
561 if (!isset($this->_page) and isset($this->_attribute)) {
562 // An attribute: we store it in the basepage now, to fill the cache for page->save
563 // TODO: side-effect free query
564 $page = $GLOBALS['request']->getPage($basepage);
565 $page->setAttribute($this->_relation, $this->_attribute);
566 $this->_page = $basepage;
567 return array(array('linkto' => '', 'relation' => $this->_relation));
569 if ($link = $this->getPagename($basepage))
570 return array(array('linkto' => $link, 'relation' => $this->_relation));
575 function _expandurl($url)
578 if (!preg_match('/^ ([^:]+) (:[:=]) (.+) $/x', $url, $m)) {
579 return HTML::span(array('class' => 'error'), _("BAD semantic relation link"));
581 $this->_relation = urldecode($m[1]);
582 $is_attribute = ($m[2] == ':=');
584 $this->_attribute = urldecode($m[3]);
585 // since this stored in the markup cache, we are extra sensible
586 // not to store false empty stuff.
587 $units = new Units();
588 if (!DISABLE_UNITS and !$units->errcode) {
589 $this->_attribute_base = $units->Definition($this->_attribute);
590 $this->_unit = $units->baseunit($this->_attribute);
593 $this->_page = urldecode($m[3]);
598 function _expand($url, $label = false)
601 $m = $this->_expandurl($url);
603 // do not link to the attribute value, but to the attribute
604 $is_attribute = ($m[2] == ':=');
605 if ($WikiTheme->DUMP_MODE and $WikiTheme->VALID_LINKS) {
606 if (isset($this->_page) and !in_array($this->_page, $WikiTheme->VALID_LINKS))
607 return HTML($label ? $label : ($is_attribute ? $this->_relation : $this->_page));
610 $title = isset($this->_attribute_base)
611 ? sprintf(_("Attribute %s, base value: %s"), $this->_relation, $this->_attribute_base)
612 : sprintf(_("Attribute %s, value: %s"), $this->_relation, $this->_attribute);
615 HTML::a(array('href' => WikiURL($is_attribute ? $this->_relation : $this->_page),
616 'class' => "wiki " . ($is_attribute ? "attribute" : "relation"),
617 'title' => $is_attribute
619 : sprintf(_("Relation %s to page %s"), $this->_relation, $this->_page)),
622 } elseif ($is_attribute) {
625 HTML::a(array('href' => WikiURL($this->_relation),
626 'class' => "wiki attribute",
633 HTML::a(array('href' => WikiURL($this->_relation),
634 'class' => "wiki relation"),
636 HTML::span(array('class' => 'relation-symbol'), $m[2]),
637 HTML::a(array('href' => WikiURL($this->_page),
644 function expand($basepage, &$markup)
646 $label = isset($this->_label) ? $this->_label : false;
647 return $this->_expand($this->_url, $label);
652 $label = isset($this->_label) ? $this->_label : false;
653 $link = $this->_expand($this->_url, $label);
654 return $link->asXML();
659 if (isset($this->_label))
660 return $this->_label;
666 * Highlight found search engine terms
668 class Cached_SearchHighlight extends Cached_DynamicContent
670 function Cached_SearchHighlight($word, $engine)
672 $this->_word = $word;
673 $this->engine = $engine;
676 function expand($basepage, &$markup)
678 return HTML::span(array('class' => 'search-term',
679 'title' => _("Found by ") . $this->engine),
684 class Cached_ExternalLink extends Cached_Link
687 function Cached_ExternalLink($url, $label = false)
690 if ($label && $label != $url)
691 $this->_label = $label;
699 function _getName($basepage)
701 $label = isset($this->_label) ? $this->_label : false;
702 return ($label and is_string($label)) ? $label : $this->_url;
705 function expand($basepage, &$markup)
709 $label = isset($this->_label) ? $this->_label : false;
710 $link = LinkURL($this->_url, $label);
712 if (GOOGLE_LINKS_NOFOLLOW) {
713 // Ignores nofollow when the user who saved the page was authenticated.
714 $page = $request->getPage($basepage);
715 $current = $page->getCurrentRevision(false);
716 if (!$current->get('author_id'))
717 $link->setAttr('rel', 'nofollow');
724 if (isset($this->_label) and is_string($this->_label))
725 return $this->_label;
730 class Cached_InterwikiLink extends Cached_ExternalLink
733 function Cached_InterwikiLink($link, $label = false)
735 $this->_link = $link;
737 $this->_label = $label;
740 function getPagename($basepage)
742 list ($moniker, $page) = explode(":", $this->_link, 2);
743 $page = new WikiPageName($page, $basepage);
744 if ($page->isValid()) return $page->name;
748 function getWikiPageLinks($basepage)
750 if ($basepage == '') return false;
751 /* ":DontStoreLink" */
752 if (substr($this->_link, 0, 1) == ':') return false;
753 /* store only links to valid pagenames */
754 $dbi = $GLOBALS['request']->getDbh();
755 if ($link = $this->getPagename($basepage) and $dbi->isWikiPage($link)) {
756 return array(array('linkto' => $link));
758 return false; // dont store external links
762 function _getName($basepage)
764 $label = isset($this->_label) ? $this->_label : false;
765 return ($label and is_string($label)) ? $label : $this->_link;
768 /* there may be internal interwiki links also */
771 return $this->getPagename(false) ? 'internal' : 'external';
774 function _getURL($basepage)
776 $link = $this->expand($basepage, $this);
777 return $link->getAttr('href');
780 function expand($basepage, &$markup)
783 $intermap = getInterwikiMap();
784 $label = isset($this->_label) ? $this->_label : false;
785 //FIXME: check Upload: inlined images
786 if ($WikiTheme->DUMP_MODE and !empty($WikiTheme->VALID_LINKS)) {
787 if (!in_array($this->_link, $WikiTheme->VALID_LINKS))
788 return HTML($label ? $label : $this->_link);
790 return $intermap->link($this->_link, $label);
795 if (isset($this->_label))
796 return $this->_label;
801 // Needed to put UserPages to backlinks. Special method to markup userpages with icons
802 // Thanks to PhpWiki:DanFr for finding this bug.
803 // Fixed since 1.3.8, prev. versions had no userpages in backlinks
804 class Cached_UserLink extends Cached_WikiLink
806 function expand($basepage, &$markup)
808 $label = isset($this->_label) ? $this->_label : false;
809 $anchor = isset($this->_anchor) ? (string)$this->_anchor : '';
810 $page = new WikiPageName($this->_page, $basepage, $anchor);
811 $link = WikiLink($page, 'auto', $label);
812 // $link = HTML::a(array('href' => $PageName));
813 $link->setContent(PossiblyGlueIconToText('wikiuser', $this->_page));
814 $link->setAttr('class', 'wikiuser');
820 * 1.3.13: Previously stored was only _pi.
821 * A fresh generated cache has now ->name and ->args also.
822 * main::isActionPage only checks the raw content.
824 class Cached_PluginInvocation extends Cached_DynamicContent
827 function Cached_PluginInvocation($pi)
830 $loader = $this->_getLoader();
831 if (is_array($plugin_cmdline = $loader->parsePI($pi)) and $plugin_cmdline[1]) {
832 $this->pi_name = $plugin_cmdline[0]; // plugin, plugin-form, plugin-list
833 $this->name = $plugin_cmdline[1]->getName();
834 $this->args = $plugin_cmdline[2];
838 function setTightness($top, $bottom)
842 function isInlineElement()
847 function expand($basepage, &$markup)
849 $loader = $this->_getLoader();
850 $xml = $loader->expandPI($this->_pi, $GLOBALS['request'], $markup, $basepage);
859 function getWikiPageLinks($basepage)
861 $loader = $this->_getLoader();
863 return $loader->getWikiPageLinks($this->_pi, $basepage);
866 function & _getLoader()
868 static $loader = false;
871 include_once 'lib/WikiPlugin.php';
872 $loader = new WikiPluginLoader;
882 // c-hanging-comment-ender-p: nil
883 // indent-tabs-mode: nil