2 rcs_id('$Id: CachedMarkup.php,v 1.58 2007-07-14 12:30:53 rurban Exp $');
3 /* Copyright (C) 2002 Geoffrey T. Dairiki <dairiki@dairiki.org>
4 * Copyright (C) 2004,2005,2006,2007 $ThePhpWikiProgrammingTeam
6 * This file is part of PhpWiki.
8 * PhpWiki is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * PhpWiki is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with PhpWiki; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 require_once("lib/Units.php");
25 class CacheableMarkup extends XmlContent {
27 function CacheableMarkup($content, $basepage) {
28 $this->_basepage = $basepage;
30 $this->_content = array();
31 $this->_append($content);
32 if ($this->_buf != '')
33 $this->_content[] = $this->_buf;
38 if (function_exists('gzcompress'))
39 return gzcompress(serialize($this), 9);
40 return serialize($this);
42 // FIXME: probably should implement some sort of "compression"
43 // when no gzcompress is available.
46 function unpack($packed) {
50 // ZLIB format has a five bit checksum in it's header.
51 // Lets check for sanity.
52 if (((ord($packed[0]) * 256 + ord($packed[1])) % 31 == 0)
53 and (substr($packed,0,2) == "\037\213")
54 or (substr($packed,0,2) == "x\332")) // 120, 218
56 if (function_exists('gzuncompress')) {
58 $data = gzuncompress($packed);
59 return unserialize($data);
61 // user our php lib. TESTME
62 include_once("ziplib.php");
63 $zip = new ZipReader($packed);
64 list(,$data,$attrib) = $zip->readFile();
65 return unserialize($data);
68 if (substr($packed,0,2) == "O:") {
69 // Looks like a serialized object
70 return unserialize($packed);
72 if (preg_match("/^\w+$/", $packed))
74 // happened with _BackendInfo problem also.
75 trigger_error("Can't unpack bad cached markup. Probably php_zlib extension not loaded.",
80 /** Get names of wikipages linked to.
82 * @return array of hashes { linkto=>pagename, relation=>pagename }
84 function getWikiPageLinks() {
86 foreach ($this->_content as $item) {
87 if (!isa($item, 'Cached_DynamicContent'))
89 if (!($item_links = $item->getWikiPageLinks($this->_basepage)))
91 $links = array_merge($links, $item_links);
93 // array_unique has a bug with hashes!
94 // set_links checks for duplicates, array_merge does not
95 //return array_unique($links);
101 * This is here to support the XML-RPC listLinks() method.
104 * Returns an array of hashes.
106 function getLinkInfo() {
108 foreach ($this->_content as $link) {
109 if (! isa($link, 'Cached_Link'))
111 $info = $link->getLinkInfo($this->_basepage);
112 $links[$info->href] = $info;
114 return array_values($links);
117 function _append($item) {
118 if (is_array($item)) {
119 foreach ($item as $subitem)
120 $this->_append($subitem);
122 elseif (!is_object($item)) {
123 $this->_buf .= $this->_quote((string) $item);
125 elseif (isa($item, 'Cached_DynamicContent')) {
127 $this->_content[] = $this->_buf;
130 $this->_content[] = $item;
132 elseif (isa($item, 'XmlElement')) {
133 if ($item->isEmpty()) {
134 $this->_buf .= $item->emptyTag();
137 $this->_buf .= $item->startTag();
138 foreach ($item->getContent() as $subitem)
139 $this->_append($subitem);
140 $this->_buf .= "</$item->_tag>";
142 if (!isset($this->_description) and $item->getTag() == 'p')
143 $this->_glean_description($item->asString());
145 if (!$item->isInlineElement())
148 elseif (isa($item, 'XmlContent')) {
149 foreach ($item->getContent() as $item)
150 $this->_append($item);
152 elseif (method_exists($item, 'asXML')) {
153 $this->_buf .= $item->asXML();
155 elseif (method_exists($item, 'asString')) {
156 $this->_buf .= $this->_quote($item->asString());
159 $this->_buf .= sprintf("==Object(%s)==", get_class($item));
163 function _glean_description($text) {
164 static $two_sentences;
165 if (!$two_sentences) {
166 $two_sentences = pcre_fix_posix_classes("[.?!][\")]*\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 () {
191 return isset($this->_description) ? $this->_description : '';
196 $basepage = $this->_basepage;
198 foreach ($this->_content as $item) {
199 if (is_string($item)) {
202 elseif (is_subclass_of($item,
204 ? 'Cached_DynamicContent'
205 : 'cached_dynamiccontent'))
207 $val = $item->expand($basepage, $this);
208 $xml .= $val->asXML();
211 $xml .= $item->asXML();
217 function printXML () {
218 $basepage = $this->_basepage;
219 // _content might be changed from a plugin (CreateToc)
220 for ($i=0; $i < count($this->_content); $i++) {
221 $item = $this->_content[$i];
222 if (is_string($item)) {
225 elseif (is_subclass_of($item,
227 ? 'Cached_DynamicContent'
228 : 'cached_dynamiccontent'))
229 { // give the content the chance to know about itself or even
231 $val = $item->expand($basepage, $this);
242 * The base class for all dynamic content.
244 * Dynamic content is anything that can change even when the original
245 * wiki-text from which it was parsed is unchanged.
247 class Cached_DynamicContent {
249 function cache(&$cache) {
253 function expand($basepage, &$obj) {
254 trigger_error("Pure virtual", E_USER_ERROR);
257 function getWikiPageLinks($basepage) {
262 class XmlRpc_LinkInfo {
263 function XmlRpc_LinkInfo($page, $type, $href, $relation = '') {
267 $this->relation = $relation;
268 //$this->pageref = str_replace("/RPC2.php", "/index.php", $href);
272 class Cached_Link extends Cached_DynamicContent {
274 function isInlineElement() {
278 /** Get link info (for XML-RPC support)
280 * This is here to support the XML-RPC listLinks method.
281 * (See http://www.ecyrd.com/JSPWiki/Wiki.jsp?page=WikiRPCInterface)
283 function getLinkInfo($basepage) {
284 return new XmlRpc_LinkInfo($this->_getName($basepage),
286 $this->_getURL($basepage),
287 $this->_getRelation($basepage));
290 function _getURL($basepage) {
293 function __getRelation($basepage) {
294 return $this->_relation;
298 class Cached_WikiLink extends Cached_Link {
300 function Cached_WikiLink ($page, $label = false, $anchor = false) {
301 $this->_page = $page;
302 /* ":DontStoreLink" */
303 if (substr($this->_page,0,1) == ':') {
304 $this->_page = substr($this->_page,1);
305 $this->_nolink = true;
308 $this->_anchor = $anchor;
309 if ($label and $label != $page)
310 $this->_label = $label;
311 $this->_basepage = false;
314 function _getType() {
318 function getPagename($basepage) {
319 $page = new WikiPageName($this->_page, $basepage);
320 if ($page->isValid()) return $page->name;
324 function getWikiPageLinks($basepage) {
325 if ($basepage == '') return false;
326 if (isset($this->_nolink)) return false;
327 if ($link = $this->getPagename($basepage))
328 return array(array('linkto' => $link, 'relation' => 0));
333 function _getName($basepage) {
334 return $this->getPagename($basepage);
337 function _getURL($basepage) {
338 return WikiURL($this->getPagename($basepage));
339 //return WikiURL($this->getPagename($basepage), false, 'abs_url');
342 function expand($basepage, &$markup) {
343 $this->_basepage = $basepage;
344 $label = isset($this->_label) ? $this->_label : false;
345 $anchor = isset($this->_anchor) ? (string)$this->_anchor : '';
346 $page = new WikiPageName($this->_page, $basepage, $anchor);
347 if ($page->isValid()) return WikiLink($page, 'auto', $label);
348 else return HTML($label);
352 $label = isset($this->_label) ? $this->_label : false;
353 $anchor = isset($this->_anchor) ? (string)$this->_anchor : '';
354 //TODO: need basepage for subpages like /Remove (within CreateTOC)
355 $page = new WikiPageName($this->_page, $this->_basepage, $anchor);
356 $link = WikiLink($page, 'auto', $label);
357 return $link->asXML();
360 function asString() {
361 if (isset($this->_label))
362 return $this->_label;
367 class Cached_WikiLinkIfKnown extends Cached_WikiLink
369 function Cached_WikiLinkIfKnown ($moniker) {
370 $this->_page = $moniker;
373 function expand($basepage, &$markup) {
374 return WikiLink($this->_page, 'if_known');
378 class Cached_SpellCheck extends Cached_WikiLink
380 function Cached_SpellCheck ($word, $suggs) {
381 $this->_page = $word;
382 $this->suggestions = $suggs;
385 function expand($basepage, &$markup) {
386 $link = HTML::a(array('class' => 'spell-wrong',
387 'title' => 'SpellCheck: '.join(', ', $this->suggestions),
388 'name' => $this->_page),
394 class Cached_PhpwikiURL extends Cached_DynamicContent
396 function Cached_PhpwikiURL ($url, $label) {
399 $this->_label = $label;
402 function isInlineElement() {
406 function expand($basepage, &$markup) {
407 $label = isset($this->_label) ? $this->_label : false;
408 return LinkPhpwikiURL($this->_url, $label, $basepage);
412 $label = isset($this->_label) ? $this->_label : false;
413 $link = LinkPhpwikiURL($this->_url, $label);
414 return $link->asXML();
417 function asString() {
418 if (isset($this->_label))
419 return $this->_label;
425 * Relations (::) are named links to pages.
426 * Attributes (:=) are named metadata per page, "named links to numbers with units".
427 * We don't want to exhaust the linktable with numbers,
428 * since this would create empty pages per each value,
429 * so we don't store the attributes as full relationlink.
430 * But we do store the attribute name as relation with an empty pagename
431 * to denote that this is an attribute,
432 * and to enable a fast listRelations mode=attributes
434 class Cached_SemanticLink extends Cached_WikiLink {
436 function Cached_SemanticLink ($url, $label=false) {
438 if ($label && $label != $url)
439 $this->_label = $label;
440 $this->_expandurl($this->_url);
443 function isInlineElement() {
447 function getPagename($basepage) {
448 if (!isset($this->_page)) return false;
449 $page = new WikiPageName($this->_page, $basepage);
450 if ($page->isValid()) return $page->name;
454 /* Add relation to the link table.
455 * attributes have the _relation, but not the _page set.
457 function getWikiPageLinks($basepage) {
458 if ($basepage == '') return false;
459 if (!isset($this->_page) and isset($this->_attribute)) {
460 // An attribute: we store it in the basepage now, to fill the cache for page->save
461 // TODO: side-effect free query
462 $page = $GLOBALS['request']->getPage($basepage);
463 $page->setAttribute($this->_relation, $this->_attribute);
464 $this->_page = $basepage;
465 return array(array('linkto' => '', 'relation' => $this->_relation));
467 if ($link = $this->getPagename($basepage))
468 return array(array('linkto' => $link, 'relation' => $this->_relation));
473 function _expandurl($url) {
475 if (!preg_match('/^ ([^:]+) (:[:=]) (.+) $/x', $url, $m)) {
476 return HTML::strong(array('class' => 'rawurl'),
477 HTML::u(array('class' => 'baduri'),
478 _("BAD semantic relation link")));
480 $this->_relation = urldecode($m[1]);
481 $is_attribute = ($m[2] == ':=');
483 $this->_attribute = urldecode($m[3]);
484 // since this stored in the markup cache, we are extra sensible
485 // not to store false empty stuff.
486 $units = new Units();
487 if (!DISABLE_UNITS and !$units->errcode)
489 $this->_attribute_base = $units->Definition($this->_attribute);
490 $this->_unit = $units->baseunit($this->_attribute);
493 $this->_page = urldecode($m[3]);
498 function _expand($url, $label = false) {
499 $m = $this->_expandurl($url);
501 // do not link to the attribute value, but to the attribute
502 $is_attribute = ($m[2] == ':=');
504 $title = isset($this->_attribute_base)
505 ? sprintf(_("Attribute %s, base value: %s"), $this->_relation, $this->_attribute_base)
506 : sprintf(_("Attribute %s, value: %s"), $this->_relation, $this->_attribute);
510 HTML::a(array('href' => WikiURL($is_attribute ? $this->_relation : $this->_page),
511 'class' => "wiki ".($is_attribute ? "attribute" : "relation"),
512 'title' => $is_attribute
514 : sprintf(_("Relation %s to page %s"), $this->_relation, $this->_page)),
517 } elseif ($is_attribute) {
520 HTML::a(array('href' => WikiURL($this->_relation),
521 'class' => "wiki attribute",
528 HTML::a(array('href' => WikiURL($this->_relation),
529 'class' => "wiki relation"),
531 HTML::span(array('class'=>'relation-symbol'), $m[2]),
532 HTML::a(array('href' => WikiURL($this->_page),
539 function expand($basepage, &$markup) {
540 $label = isset($this->_label) ? $this->_label : false;
541 return $this->_expand($this->_url, $label);
545 $label = isset($this->_label) ? $this->_label : false;
546 $link = $this->_expand($this->_url, $label);
547 return $link->asXML();
550 function asString() {
551 if (isset($this->_label))
552 return $this->_label;
558 * Highlight found search engine terms
560 class Cached_SearchHighlight extends Cached_DynamicContent
562 function Cached_SearchHighlight ($word, $engine) {
563 $this->_word = $word;
564 $this->engine = $engine;
567 function expand($basepage, &$markup) {
568 return HTML::span(array('class' => 'search-term',
569 'title' => _("Found by ") . $this->engine),
574 class Cached_ExternalLink extends Cached_Link {
576 function Cached_ExternalLink($url, $label=false) {
578 if ($label && $label != $url)
579 $this->_label = $label;
582 function _getType() {
586 function _getName($basepage) {
587 $label = isset($this->_label) ? $this->_label : false;
588 return ($label and is_string($label)) ? $label : $this->_url;
591 function expand($basepage, &$markup) {
594 $label = isset($this->_label) ? $this->_label : false;
595 $link = LinkURL($this->_url, $label);
597 if (GOOGLE_LINKS_NOFOLLOW) {
598 // Ignores nofollow when the user who saved the page was authenticated.
599 $page = $request->getPage($basepage);
600 $current = $page->getCurrentRevision(false);
601 if (!$current->get('author_id'))
602 $link->setAttr('rel', 'nofollow');
607 function asString() {
608 if (isset($this->_label))
609 return $this->_label;
614 class Cached_InterwikiLink extends Cached_ExternalLink {
616 function Cached_InterwikiLink($link, $label=false) {
617 $this->_link = $link;
619 $this->_label = $label;
622 function getPagename($basepage) {
623 list ($moniker, $page) = split (":", $this->_link, 2);
624 $page = new WikiPageName($page, $basepage);
625 if ($page->isValid()) return $page->name;
629 function getWikiPageLinks($basepage) {
630 if ($basepage == '') return false;
631 /* ":DontStoreLink" */
632 if (substr($this->_link,0,1) == ':') return false;
633 /* store only links to valid pagenames */
634 if ($link = $this->getPagename($basepage))
635 return array(array('linkto' => $link, 'relation' => 0));
636 else return false; // dont store external links
639 function _getName($basepage) {
640 $label = isset($this->_label) ? $this->_label : false;
641 return ($label and is_string($label)) ? $label : $this->_link;
644 /* there may be internal interwiki links also */
645 function _getType() {
646 return $this->getPagename(false) ? 'internal' : 'external';
649 function _getURL($basepage) {
650 $link = $this->expand($basepage, $this);
651 return $link->getAttr('href');
654 function expand($basepage, &$markup) {
655 $intermap = getInterwikiMap();
656 $label = isset($this->_label) ? $this->_label : false;
657 return $intermap->link($this->_link, $label);
660 function asString() {
661 if (isset($this->_label))
662 return $this->_label;
667 // Needed to put UserPages to backlinks. Special method to markup userpages with icons
668 // Thanks to PhpWiki:DanFr for finding this bug.
669 // Fixed since 1.3.8, prev. versions had no userpages in backlinks
670 class Cached_UserLink extends Cached_WikiLink {
671 function expand($basepage, &$markup) {
672 $label = isset($this->_label) ? $this->_label : false;
673 $anchor = isset($this->_anchor) ? (string)$this->_anchor : '';
674 $page = new WikiPageName($this->_page, $basepage, $anchor);
675 $link = WikiLink($page, 'auto', $label);
676 // $link = HTML::a(array('href' => $PageName));
677 $link->setContent(PossiblyGlueIconToText('wikiuser', $this->_page));
678 $link->setAttr('class', 'wikiuser');
684 * 1.3.13: Previously stored was only _pi.
685 * A fresh generated cache has now ->name and ->args also.
686 * main::isActionPage only checks the raw content.
688 class Cached_PluginInvocation extends Cached_DynamicContent {
690 function Cached_PluginInvocation ($pi) {
692 $loader = $this->_getLoader();
693 if (is_array($plugin_cmdline = $loader->parsePI($pi)) and $plugin_cmdline[1]) {
694 $this->pi_name = $plugin_cmdline[0]; // plugin, plugin-form, plugin-list, plugin-link
695 $this->name = $plugin_cmdline[1]->getName();
696 $this->args = $plugin_cmdline[2];
700 function setTightness($top, $bottom) {
701 $this->_tightenable = 0;
702 if ($top) $this->_tightenable |= 1;
703 if ($bottom) $this->_tightenable |= 2;
706 function isInlineElement() {
710 function expand($basepage, &$markup) {
711 $loader = $this->_getLoader();
713 $xml = $loader->expandPI($this->_pi, $GLOBALS['request'], $markup, $basepage);
714 $div = HTML::div(array('class' => 'plugin'));
715 if (isset($this->name))
716 $id = GenerateId($this->name . 'Plugin');
718 if (isset($this->_tightenable)) {
719 if ($this->_tightenable == 3) {
720 $span = HTML::span(array('class' => 'plugin'), $xml);
722 $span->setAttr('id', $id);
725 $div->setInClass('tightenable');
726 $div->setInClass('top', ($this->_tightenable & 1) != 0);
727 $div->setInClass('bottom', ($this->_tightenable & 2) != 0);
730 $div->setAttr('id', $id);
731 $div->pushContent($xml);
735 function asString() {
740 function getWikiPageLinks($basepage) {
741 $loader = $this->_getLoader();
743 return $loader->getWikiPageLinks($this->_pi, $basepage);
746 function & _getLoader() {
747 static $loader = false;
750 include_once('lib/WikiPlugin.php');
751 $loader = new WikiPluginLoader;
757 // $Log: not supported by cvs2svn $
758 // Revision 1.57 2007/05/28 20:13:46 rurban
759 // Overwrite all attributes at once at page->save to delete dangling meta
761 // Revision 1.56 2007/04/08 16:39:40 rurban
762 // fix when DISABLE_UNITS = true (thanks to Walter Rafelsberger)
763 // simplify title calculation
765 // Revision 1.55 2007/03/18 17:35:14 rurban
766 // Fix :DontStoreLink
768 // Revision 1.54 2007/01/25 07:41:41 rurban
769 // Print attribute in title. Use CSS formatting for ::=
771 // Revision 1.53 2007/01/21 23:26:52 rurban
772 // Translate Found by
774 // Revision 1.52 2007/01/20 15:53:51 rurban
775 // Rewrite of SearchHighlight: through ActionPage and InlineParser
777 // Revision 1.51 2007/01/20 11:24:53 rurban
778 // add SpellCheck support
780 // Revision 1.50 2007/01/07 18:41:51 rurban
781 // Fix fallback ZipReader syntax error. Use label=false. Add parsed plugin names to the stored tree.
783 // Revision 1.49 2007/01/04 16:40:35 rurban
784 // Remove units object from CachedMarkup links, Store parsed linkinfo only: basevalue, baseunit.
786 // Revision 1.48 2007/01/03 21:22:08 rurban
787 // Use Units for attributes. Store the unified base value as Cached_SemanticLink->_attribute_base in the wikimarkup and display it as title.
789 // Revision 1.47 2007/01/02 13:17:57 rurban
790 // fix semantic page links and attributes, esp. attributes. they get stored as link to empty page also. tighten semantic url expander regex, omit want_content if not necessary
792 // Revision 1.46 2006/12/22 00:11:38 rurban
793 // add seperate expandurl method, to simplify pagename parsing
795 // Revision 1.45 2006/10/12 06:33:50 rurban
796 // decide later with which class to render this link (fixes interwiki link layout)
798 // (c-file-style: "gnu")
803 // c-hanging-comment-ender-p: nil
804 // indent-tabs-mode: nil