3 /* Copyright (C) 2002 Geoffrey T. Dairiki <dairiki@dairiki.org>
4 * Copyright (C) 2004-2008 $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
20 * along with PhpWiki; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 require_once("lib/Units.php");
26 class CacheableMarkup extends XmlContent {
28 function CacheableMarkup($content, $basepage) {
29 $this->_basepage = $basepage;
31 $this->_content = array();
32 $this->_append($content);
33 if ($this->_buf != '')
34 $this->_content[] = $this->_buf;
41 // This causes a strange bug when a comment containing
42 // a single quote is entered in the Summary box:
43 // - the history is wrong (user and comment missing)
44 // - the table of contents plugin no longer works
45 if (defined('GFORGE') and GFORGE) {
46 return serialize($this);
49 if (function_exists('gzcompress'))
50 return gzcompress(serialize($this), 9);
51 return serialize($this);
53 // FIXME: probably should implement some sort of "compression"
54 // when no gzcompress is available.
57 function unpack($packed) {
61 // ZLIB format has a five bit checksum in it's header.
62 // Lets check for sanity.
63 if (((ord($packed[0]) * 256 + ord($packed[1])) % 31 == 0)
64 and (substr($packed,0,2) == "\037\213")
65 or (substr($packed,0,2) == "x\332")) // 120, 218
67 if (function_exists('gzuncompress')) {
69 $data = gzuncompress($packed);
70 return unserialize($data);
72 // user our php lib. TESTME
73 include_once("ziplib.php");
74 $zip = new ZipReader($packed);
75 list(,$data,$attrib) = $zip->readFile();
76 return unserialize($data);
79 if (substr($packed,0,2) == "O:") {
80 // Looks like a serialized object
81 return unserialize($packed);
83 if (preg_match("/^\w+$/", $packed))
85 // happened with _BackendInfo problem also.
86 trigger_error("Can't unpack bad cached markup. Probably php_zlib extension not loaded.",
91 /** Get names of wikipages linked to.
93 * @return array of hashes { linkto=>pagename, relation=>pagename }
95 function getWikiPageLinks() {
97 foreach ($this->_content as $item) {
98 if (!isa($item, 'Cached_DynamicContent'))
100 if (!($item_links = $item->getWikiPageLinks($this->_basepage)))
102 $links = array_merge($links, $item_links);
104 // array_unique has a bug with hashes!
105 // set_links checks for duplicates, array_merge does not
106 //return array_unique($links);
112 * This is here to support the XML-RPC listLinks() method.
115 * Returns an array of hashes.
117 function getLinkInfo() {
119 foreach ($this->_content as $link) {
120 if (! isa($link, 'Cached_Link'))
122 $info = $link->getLinkInfo($this->_basepage);
123 $links[$info->href] = $info;
125 return array_values($links);
128 function _append($item) {
129 if (is_array($item)) {
130 foreach ($item as $subitem)
131 $this->_append($subitem);
133 elseif (!is_object($item)) {
134 $this->_buf .= $this->_quote((string) $item);
136 elseif (isa($item, 'Cached_DynamicContent')) {
138 $this->_content[] = $this->_buf;
141 $this->_content[] = $item;
143 elseif (isa($item, 'XmlElement')) {
144 if ($item->isEmpty()) {
145 $this->_buf .= $item->emptyTag();
148 $this->_buf .= $item->startTag();
149 foreach ($item->getContent() as $subitem)
150 $this->_append($subitem);
151 $this->_buf .= "</$item->_tag>";
153 if (!$this->getDescription() and $item->getTag() == 'p') {
154 // performance: when is this really needed?
155 $this->_glean_description($item->asString());
158 if (!$item->isInlineElement())
161 elseif (isa($item, 'XmlContent')) {
162 foreach ($item->getContent() as $item)
163 $this->_append($item);
165 elseif (method_exists($item, 'asXML')) {
166 $this->_buf .= $item->asXML();
168 elseif (method_exists($item, 'asString')) {
169 $this->_buf .= $this->_quote($item->asString());
172 $this->_buf .= sprintf("==Object(%s)==", get_class($item));
176 function _glean_description($text) {
177 static $two_sentences;
178 if (!$two_sentences) {
179 $two_sentences = pcre_fix_posix_classes("[.?!][\")]*\s+[\"(]*[[:upper:])]"
181 . "[.?!][\")]*\s*[\"(]*([[:upper:])]|$)");
184 if (!isset($this->_description) and preg_match("/$two_sentences/sx", $text))
185 $this->_description = preg_replace("/\s*\n\s*/", " ", trim($text));
189 * Guess a short description of the page.
193 * This algorithm was suggested on MeatballWiki by
194 * Alex Schroeder <kensanata@yahoo.com>.
196 * Use the first paragraph in the page which contains at least two
199 * @see http://www.usemod.com/cgi-bin/mb.pl?MeatballWikiSuggestions
203 function getDescription () {
204 return isset($this->_description) ? $this->_description : '';
209 $basepage = $this->_basepage;
211 foreach ($this->_content as $item) {
212 if (is_string($item)) {
215 elseif (is_subclass_of($item,
217 ? 'Cached_DynamicContent'
218 : 'cached_dynamiccontent'))
220 $val = $item->expand($basepage, $this);
221 $xml .= $val->asXML();
224 $xml .= $item->asXML();
230 function printXML () {
231 $basepage = $this->_basepage;
232 // _content might be changed from a plugin (CreateToc)
233 for ($i=0; $i < count($this->_content); $i++) {
234 $item = $this->_content[$i];
235 if (is_string($item)) {
238 elseif (is_subclass_of($item,
240 ? 'Cached_DynamicContent'
241 : 'cached_dynamiccontent'))
242 { // give the content the chance to know about itself or even
244 $val = $item->expand($basepage, $this);
245 if ($val) $val->printXML();
246 else trigger_error("empty item $item");
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 {
263 function cache(&$cache) {
267 function expand($basepage, &$obj) {
268 trigger_error("Pure virtual", E_USER_ERROR);
271 function getWikiPageLinks($basepage) {
276 class XmlRpc_LinkInfo {
277 function XmlRpc_LinkInfo($page, $type, $href, $relation = '') {
281 $this->relation = $relation;
282 //$this->pageref = str_replace("/RPC2.php", "/index.php", $href);
286 class Cached_Link extends Cached_DynamicContent {
288 function isInlineElement() {
292 /** Get link info (for XML-RPC support)
294 * This is here to support the XML-RPC listLinks method.
295 * (See http://www.ecyrd.com/JSPWiki/Wiki.jsp?page=WikiRPCInterface)
297 function getLinkInfo($basepage) {
298 return new XmlRpc_LinkInfo($this->_getName($basepage),
300 $this->_getURL($basepage),
301 $this->_getRelation($basepage));
304 function _getURL($basepage) {
307 function __getRelation($basepage) {
308 return $this->_relation;
312 * Defer interwiki inline links. img src=upload:xx.png
313 * LinkImage($url, $alt = false)
315 class Cached_InlinedImage extends Cached_DynamicContent {
316 function isInlineElement() {
319 function _getURL($basepage) {
322 // TODO: fix interwiki inline links in case of static dumps
323 function expand($basepage, &$markup) {
325 $this->_basepage = $basepage;
326 $label = isset($this->_label) ? $this->_label : false;
327 if ($WikiTheme->DUMP_MODE) {
328 // In case of static dumps we need to check if we should
329 // inline the image or not: external: keep link, internal: copy locally
330 return LinkImage($label);
332 return LinkImage($label);
337 class Cached_WikiLink extends Cached_Link {
339 function Cached_WikiLink ($page, $label = false, $anchor = false) {
340 $this->_page = $page;
341 /* ":DontStoreLink" */
342 if (substr($this->_page,0,1) == ':') {
343 $this->_page = substr($this->_page,1);
344 $this->_nolink = true;
347 $this->_anchor = $anchor;
348 if ($label and $label != $page)
349 $this->_label = $label;
350 $this->_basepage = false;
353 function _getType() {
357 function getPagename($basepage) {
358 $page = new WikiPageName($this->_page, $basepage);
359 if ($page->isValid()) return $page->name;
363 function getWikiPageLinks($basepage) {
364 if ($basepage == '') return false;
365 if (isset($this->_nolink)) return false;
366 if ($link = $this->getPagename($basepage))
367 return array(array('linkto' => $link, 'relation' => 0));
372 function _getName($basepage) {
373 return $this->getPagename($basepage);
376 function _getURL($basepage) {
377 return WikiURL($this->getPagename($basepage));
378 //return WikiURL($this->getPagename($basepage), false, 'abs_url');
381 function expand($basepage, &$markup) {
383 $this->_basepage = $basepage;
384 $label = isset($this->_label) ? $this->_label : false;
385 $anchor = isset($this->_anchor) ? (string)$this->_anchor : '';
386 $page = new WikiPageName($this->_page, $basepage, $anchor);
387 if ($WikiTheme->DUMP_MODE and !empty($WikiTheme->VALID_LINKS)) {
388 if (!in_array($this->_page, $WikiTheme->VALID_LINKS))
389 return HTML($label ? $label : $page->getName());
391 if ($page->isValid()) return WikiLink($page, 'auto', $label);
392 else return HTML($label);
397 $label = isset($this->_label) ? $this->_label : false;
398 $anchor = isset($this->_anchor) ? (string)$this->_anchor : '';
399 //TODO: need basepage for subpages like /Remove (within CreateTOC)
400 $page = new WikiPageName($this->_page, $this->_basepage, $anchor);
401 if ($WikiTheme->DUMP_MODE and $WikiTheme->VALID_LINKS) {
402 if (!in_array($this->_page, $WikiTheme->VALID_LINKS))
403 return $label ? $label : $page->getName();
405 $link = WikiLink($page, 'auto', $label);
406 return $link->asXML();
409 function asString() {
410 if (isset($this->_label))
411 return $this->_label;
416 class Cached_WikiLinkIfKnown extends Cached_WikiLink
418 function Cached_WikiLinkIfKnown ($moniker) {
419 $this->_page = $moniker;
422 function expand($basepage, &$markup) {
424 if ($WikiTheme->DUMP_MODE and $WikiTheme->VALID_LINKS) {
425 if (!in_array($this->_page, $WikiTheme->VALID_LINKS))
426 return HTML($label ? $label : $page->getName());
428 return WikiLink($this->_page, 'if_known');
432 class Cached_SpellCheck extends Cached_WikiLink
434 function Cached_SpellCheck ($word, $suggs) {
435 $this->_page = $word;
436 $this->suggestions = $suggs;
439 function expand($basepage, &$markup) {
440 $link = HTML::a(array('class' => 'spell-wrong',
441 'title' => 'SpellCheck: '.join(', ', $this->suggestions),
442 'name' => $this->_page),
448 class Cached_PhpwikiURL extends Cached_DynamicContent
450 function Cached_PhpwikiURL ($url, $label) {
453 $this->_label = $label;
456 function isInlineElement() {
460 function expand($basepage, &$markup) {
462 $label = isset($this->_label) ? $this->_label : false;
463 if ($WikiTheme->DUMP_MODE and $WikiTheme->VALID_LINKS) {
464 if (!in_array($this->_page, $WikiTheme->VALID_LINKS))
465 return HTML($label ? $label : $page->getName());
467 return LinkPhpwikiURL($this->_url, $label, $basepage);
471 $label = isset($this->_label) ? $this->_label : false;
472 $link = LinkPhpwikiURL($this->_url, $label);
473 return $link->asXML();
476 function asString() {
477 if (isset($this->_label))
478 return $this->_label;
484 * Relations (::) are named links to pages.
485 * Attributes (:=) are named metadata per page, "named links to numbers with units".
486 * We don't want to exhaust the linktable with numbers,
487 * since this would create empty pages per each value,
488 * so we don't store the attributes as full relationlink.
489 * But we do store the attribute name as relation with an empty pagename
490 * to denote that this is an attribute,
491 * and to enable a fast listRelations mode=attributes
493 class Cached_SemanticLink extends Cached_WikiLink {
495 function Cached_SemanticLink ($url, $label=false) {
497 if ($label && $label != $url)
498 $this->_label = $label;
499 $this->_expandurl($this->_url);
502 function isInlineElement() {
506 function getPagename($basepage) {
507 if (!isset($this->_page)) return false;
508 $page = new WikiPageName($this->_page, $basepage);
509 if ($page->isValid()) return $page->name;
513 /* Add relation to the link table.
514 * attributes have the _relation, but not the _page set.
516 function getWikiPageLinks($basepage) {
517 if ($basepage == '') return false;
518 if (!isset($this->_page) and isset($this->_attribute)) {
519 // An attribute: we store it in the basepage now, to fill the cache for page->save
520 // TODO: side-effect free query
521 $page = $GLOBALS['request']->getPage($basepage);
522 $page->setAttribute($this->_relation, $this->_attribute);
523 $this->_page = $basepage;
524 return array(array('linkto' => '', 'relation' => $this->_relation));
526 if ($link = $this->getPagename($basepage))
527 return array(array('linkto' => $link, 'relation' => $this->_relation));
532 function _expandurl($url) {
534 if (!preg_match('/^ ([^:]+) (:[:=]) (.+) $/x', $url, $m)) {
535 return HTML::strong(array('class' => 'rawurl'),
536 HTML::u(array('class' => 'baduri'),
537 _("BAD semantic relation link")));
539 $this->_relation = urldecode($m[1]);
540 $is_attribute = ($m[2] == ':=');
542 $this->_attribute = urldecode($m[3]);
543 // since this stored in the markup cache, we are extra sensible
544 // not to store false empty stuff.
545 $units = new Units();
546 if (!DISABLE_UNITS and !$units->errcode)
548 $this->_attribute_base = $units->Definition($this->_attribute);
549 $this->_unit = $units->baseunit($this->_attribute);
552 $this->_page = urldecode($m[3]);
557 function _expand($url, $label = false) {
559 $m = $this->_expandurl($url);
561 // do not link to the attribute value, but to the attribute
562 $is_attribute = ($m[2] == ':=');
563 if ($WikiTheme->DUMP_MODE and $WikiTheme->VALID_LINKS) {
564 if (isset($this->_page) and !in_array($this->_page, $WikiTheme->VALID_LINKS))
565 return HTML($label ? $label : ($is_attribute ? $this->_relation : $this->_page));
568 $title = isset($this->_attribute_base)
569 ? sprintf(_("Attribute %s, base value: %s"), $this->_relation, $this->_attribute_base)
570 : sprintf(_("Attribute %s, value: %s"), $this->_relation, $this->_attribute);
574 HTML::a(array('href' => WikiURL($is_attribute ? $this->_relation : $this->_page),
575 'class' => "wiki ".($is_attribute ? "attribute" : "relation"),
576 'title' => $is_attribute
578 : sprintf(_("Relation %s to page %s"), $this->_relation, $this->_page)),
581 } elseif ($is_attribute) {
584 HTML::a(array('href' => WikiURL($this->_relation),
585 'class' => "wiki attribute",
592 HTML::a(array('href' => WikiURL($this->_relation),
593 'class' => "wiki relation"),
595 HTML::span(array('class'=>'relation-symbol'), $m[2]),
596 HTML::a(array('href' => WikiURL($this->_page),
603 function expand($basepage, &$markup) {
604 $label = isset($this->_label) ? $this->_label : false;
605 return $this->_expand($this->_url, $label);
609 $label = isset($this->_label) ? $this->_label : false;
610 $link = $this->_expand($this->_url, $label);
611 return $link->asXML();
614 function asString() {
615 if (isset($this->_label))
616 return $this->_label;
622 * Highlight found search engine terms
624 class Cached_SearchHighlight extends Cached_DynamicContent
626 function Cached_SearchHighlight ($word, $engine) {
627 $this->_word = $word;
628 $this->engine = $engine;
631 function expand($basepage, &$markup) {
632 return HTML::span(array('class' => 'search-term',
633 'title' => _("Found by ") . $this->engine),
638 class Cached_ExternalLink extends Cached_Link {
640 function Cached_ExternalLink($url, $label=false) {
642 if ($label && $label != $url)
643 $this->_label = $label;
646 function _getType() {
650 function _getName($basepage) {
651 $label = isset($this->_label) ? $this->_label : false;
652 return ($label and is_string($label)) ? $label : $this->_url;
655 function expand($basepage, &$markup) {
658 $label = isset($this->_label) ? $this->_label : false;
659 $link = LinkURL($this->_url, $label);
661 if (GOOGLE_LINKS_NOFOLLOW) {
662 // Ignores nofollow when the user who saved the page was authenticated.
663 $page = $request->getPage($basepage);
664 $current = $page->getCurrentRevision(false);
665 if (!$current->get('author_id'))
666 $link->setAttr('rel', 'nofollow');
671 function asString() {
672 if (isset($this->_label) and is_string($this->_label))
673 return $this->_label;
678 class Cached_InterwikiLink extends Cached_ExternalLink {
680 function Cached_InterwikiLink($link, $label=false) {
681 $this->_link = $link;
683 $this->_label = $label;
686 function getPagename($basepage) {
687 list ($moniker, $page) = split (":", $this->_link, 2);
688 $page = new WikiPageName($page, $basepage);
689 if ($page->isValid()) return $page->name;
693 function getWikiPageLinks($basepage) {
694 if ($basepage == '') return false;
695 /* ":DontStoreLink" */
696 if (substr($this->_link,0,1) == ':') return false;
697 /* store only links to valid pagenames */
698 if ($link = $this->getPagename($basepage))
699 return array(array('linkto' => $link, 'relation' => 0));
700 else return false; // dont store external links
703 function _getName($basepage) {
704 $label = isset($this->_label) ? $this->_label : false;
705 return ($label and is_string($label)) ? $label : $this->_link;
708 /* there may be internal interwiki links also */
709 function _getType() {
710 return $this->getPagename(false) ? 'internal' : 'external';
713 function _getURL($basepage) {
714 $link = $this->expand($basepage, $this);
715 return $link->getAttr('href');
718 function expand($basepage, &$markup) {
720 $intermap = getInterwikiMap();
721 $label = isset($this->_label) ? $this->_label : false;
722 //FIXME: check Upload: inlined images
723 if ($WikiTheme->DUMP_MODE and !empty($WikiTheme->VALID_LINKS)) {
724 if (!in_array($this->_link, $WikiTheme->VALID_LINKS))
725 return HTML($label ? $label : $this->_link);
727 return $intermap->link($this->_link, $label);
730 function asString() {
731 if (isset($this->_label))
732 return $this->_label;
737 // Needed to put UserPages to backlinks. Special method to markup userpages with icons
738 // Thanks to PhpWiki:DanFr for finding this bug.
739 // Fixed since 1.3.8, prev. versions had no userpages in backlinks
740 class Cached_UserLink extends Cached_WikiLink {
741 function expand($basepage, &$markup) {
742 $label = isset($this->_label) ? $this->_label : false;
743 $anchor = isset($this->_anchor) ? (string)$this->_anchor : '';
744 $page = new WikiPageName($this->_page, $basepage, $anchor);
745 $link = WikiLink($page, 'auto', $label);
746 // $link = HTML::a(array('href' => $PageName));
747 $link->setContent(PossiblyGlueIconToText('wikiuser', $this->_page));
748 $link->setAttr('class', 'wikiuser');
754 * 1.3.13: Previously stored was only _pi.
755 * A fresh generated cache has now ->name and ->args also.
756 * main::isActionPage only checks the raw content.
758 class Cached_PluginInvocation extends Cached_DynamicContent {
760 function Cached_PluginInvocation ($pi) {
762 $loader = $this->_getLoader();
763 if (is_array($plugin_cmdline = $loader->parsePI($pi)) and $plugin_cmdline[1]) {
764 $this->pi_name = $plugin_cmdline[0]; // plugin, plugin-form, plugin-list, plugin-link
765 $this->name = $plugin_cmdline[1]->getName();
766 $this->args = $plugin_cmdline[2];
770 function setTightness($top, $bottom) {
773 function isInlineElement() {
777 function expand($basepage, &$markup) {
778 $loader = $this->_getLoader();
779 $xml = $loader->expandPI($this->_pi, $GLOBALS['request'], $markup, $basepage);
783 function asString() {
787 function getWikiPageLinks($basepage) {
788 $loader = $this->_getLoader();
790 return $loader->getWikiPageLinks($this->_pi, $basepage);
793 function & _getLoader() {
794 static $loader = false;
797 include_once('lib/WikiPlugin.php');
798 $loader = new WikiPluginLoader;
804 // (c-file-style: "gnu")
809 // c-hanging-comment-ender-p: nil
810 // indent-tabs-mode: nil