lib/CachedMarkup.php

   1 <?php rcs_id('$Id: CachedMarkup.php,v 1.3 2003-02-26 00:10:25 dairiki Exp $');
   2 /* Copyright (C) 2002, Geoffrey T. Dairiki <dairiki@dairiki.org>
   3  *
   4  * This file is part of PhpWiki.
   5  *
   6  * PhpWiki is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * PhpWiki is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with PhpWiki; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 class CacheableMarkup extends XmlContent {
  22
  23     function CacheableMarkup($content, $basepage) {
  24         $this->_basepage = $basepage;
  25         $this->_buf = '';
  26         $this->_content = array();
  27         $this->_append($content);
  28         if ($this->_buf)
  29             $this->_content[] = $this->_buf;
  30         unset($this->_buf);
  31     }
  32
  33     function pack() {
  34         if (function_exists('gzcompress'))
  35             return gzcompress(serialize($this), 9);
  36         return serialize($this);
  37
  38         // FIXME: probably should implement some sort of "compression"
  39         //   when no gzcompress is available.
  40     }
  41
  42     function unpack($packed) {
  43         if (!$packed)
  44             return false;
  45
  46         if (function_exists('gzcompress')) {
  47             // ZLIB format has a five bit checksum in it's header.
  48             // Lets check for sanity.
  49             if ((ord($packed[0]) * 256 + ord($packed[1])) % 31 == 0) {
  50                 // Looks like ZLIB.
  51                 return unserialize(gzuncompress($packed));
  52             }
  53         }
  54         if (substr($packed,0,2) == "O:") {
  55             // Looks like a serialized object
  56             return unserialize($packed);
  57         }
  58         trigger_error("Can't unpack bad cached markup", E_USER_WARNING);
  59         return false;
  60     }
  61
  62     /** Get names of wikipages linked to.
  63      *
  64      * @return array
  65      * A list of wiki page names (strings).
  66      */
  67     function getWikiPageLinks() {
  68         $links = array();
  69         foreach ($this->_content as $link) {
  70             if (! isa($link, 'Cached_WikiLink'))
  71                 continue;
  72             if (($pagename = $link->getPagename($this->_basepage)))
  73                 $links[$pagename] = 1;
  74         }
  75         return array_keys($links);
  76     }
  77
  78     /** Get link info.
  79      *
  80      * This is here to support the XML-RPC listLinks() method.
  81      *
  82      * @return array
  83      * Returns an array of hashes.
  84      */
  85     function getLinkInfo() {
  86         $link = array();
  87         foreach ($this->_content as $link) {
  88             if (! isa($link, 'Cached_Link'))
  89                 continue;
  90             $info = $link->getLinkInfo($this->_basepage);
  91             $links[$info->href] = $info;
  92         }
  93         return array_values($links);
  94     }
  95
  96     function _append($item) {
  97         if (is_array($item)) {
  98             foreach ($item as $subitem)
  99                 $this->_append($subitem);
 100         }
 101         elseif (!is_object($item)) {
 102             $this->_buf .= $this->_quote((string) $item);
 103         }
 104         elseif (isa($item, 'Cached_DynamicContent')) {
 105             if ($this->_buf) {
 106                 $this->_content[] = $this->_buf;
 107                 $this->_buf = '';
 108             }
 109             $this->_content[] = $item;
 110         }
 111         elseif (isa($item, 'XmlElement')) {
 112             if ($item->isEmpty()) {
 113                 $this->_buf .= $item->emptyTag();
 114             }
 115             else {
 116                 $this->_buf .= $item->startTag();
 117                 foreach ($item->getContent() as $subitem)
 118                     $this->_append($subitem);
 119                 $this->_buf .= "</$item->_tag>";
 120             }
 121             if (!$item->isInlineElement())
 122                 $this->_buf .= "\n";
 123         }
 124         elseif (isa($item, 'XmlContent')) {
 125             foreach ($item->getContent() as $item)
 126                 $this->_append($item);
 127         }
 128         elseif (method_exists($item, 'asxml')) {
 129             $this->_buf .= $item->asXML();
 130         }
 131         elseif (method_exists($item, 'asstring')) {
 132             $this->_buf .= $this->_quote($item->asString());
 133         }
 134         else {
 135             $this->_buf .= sprintf("==Object(%s)==", get_class($item));
 136         }
 137     }
 138
 139     function asXML () {
 140         $xml = '';
 141         $basepage = $this->_basepage;
 142
 143         foreach ($this->_content as $item) {
 144             if (is_string($item)) {
 145                 $xml .= $item;
 146             }
 147             elseif (is_subclass_of($item, 'cached_dynamiccontent')) {
 148                 $val = $item->expand($basepage);
 149                 $xml .= $val->asXML();
 150             }
 151             else {
 152                 $xml .= $item->asXML();
 153             }
 154         }
 155         return $xml;
 156     }
 157
 158     function printXML () {
 159         $basepage = $this->_basepage;
 160
 161         foreach ($this->_content as $item) {
 162             if (is_string($item)) {
 163                 print $item;
 164             }
 165             elseif (is_subclass_of($item, 'cached_dynamiccontent')) {
 166                 $val = $item->expand($basepage);
 167                 $val->printXML();
 168             }
 169             else {
 170                 $item->printXML();
 171             }
 172         }
 173     }
 174 }
 175
 176 /**
 177  * The base class for all dynamic content.
 178  *
 179  * Dynamic content is anything that can change even when the original
 180  * wiki-text from which it was parsed is unchanged.
 181  */
 182 class Cached_DynamicContent {
 183
 184     function cache(&$cache) {
 185         $cache[] = $this;
 186     }
 187
 188     function expand($basepage) {
 189         trigger_error("Pure virtual", E_USER_ERROR);
 190     }
 191 }
 192
 193 class XmlRpc_LinkInfo {
 194     function XmlRpc_LinkInfo($page, $type, $href) {
 195         $this->page = $page;
 196         $this->type = $type;
 197         $this->href = $href;
 198     }
 199 }
 200
 201 class Cached_Link extends Cached_DynamicContent {
 202
 203     function isInlineElement() {
 204         return true;
 205     }
 206
 207     /** Get link info (for XML-RPC support)
 208      *
 209      * This is here to support the XML-RPC listLinks method.
 210      * (See http://www.ecyrd.com/JSPWiki/Wiki.jsp?page=WikiRPCInterface)
 211      */
 212     function getLinkInfo($basepage) {
 213         return new XmlRpc_LinkInfo($this->_getName($basepage),
 214                                    $this->_getType(),
 215                                    $this->_getURL($basepage));
 216     }
 217
 218     function _getURL($basepage) {
 219         return $this->_url;
 220     }
 221 }
 222
 223 class Cached_WikiLink extends Cached_Link {
 224
 225     function Cached_WikiLink ($page, $label = false, $anchor = false) {
 226         $this->_page = $page;
 227         if ($anchor)
 228             $this->_anchor = $anchor;
 229         if ($label and $label != $page)
 230             $this->_label = $label;
 231     }
 232
 233     function _getType() {
 234         return 'internal';
 235     }
 236
 237     function getPagename($basepage) {
 238         $page = new WikiPageName($this->_page, $basepage);
 239         return $page->name;
 240     }
 241
 242     function _getName($basepage) {
 243         return $this->getPagename($basepage);
 244     }
 245
 246     function _getURL($basepage) {
 247         return WikiURL($this->getPagename($basepage), false, 'abs_url');
 248     }
 249
 250     function expand($basepage) {
 251         $label = isset($this->_label) ? $this->_label : false;
 252         $anchor = isset($this->_anchor) ? (string)$this->_anchor : '';
 253         $page = new WikiPageName($this->_page, $basepage, $anchor);
 254         return WikiLink($page, 'auto', $label);
 255     }
 256 }
 257
 258 class Cached_WikiLinkIfKnown extends Cached_WikiLink
 259 {
 260     function Cached_WikiLinkIfKnown ($moniker) {
 261         $this->_page = $moniker;
 262     }
 263
 264     function expand($basepage) {
 265         return WikiLink($this->_page, 'if_known');
 266     }
 267 }
 268
 269 class Cached_ExternalLink extends Cached_Link {
 270
 271     function Cached_ExternalLink($url, $label=false) {
 272         $this->_url = $url;
 273         if ($label && $label != $url)
 274             $this->_label = $label;
 275     }
 276
 277     function _getType() {
 278         return 'external';
 279     }
 280
 281     function _getName($basepage) {
 282         $label = isset($this->_label) ? $this->_label : false;
 283         return ($label and is_string($label)) ? $label : $this->_url;
 284     }
 285
 286     function expand($basepage) {
 287         $label = isset($this->_label) ? $this->_label : false;
 288         return LinkURL($this->_url, $label);
 289     }
 290 }
 291
 292 class Cached_InterwikiLink extends Cached_ExternalLink {
 293
 294     function Cached_InterwikiLink($link, $label=false) {
 295         $this->_link = $link;
 296         if ($label)
 297             $this->_label = $label;
 298     }
 299
 300     function _getName($basepage) {
 301         $label = isset($this->_label) ? $this->_label : false;
 302         return ($label and is_string($label)) ? $label : $link;
 303     }
 304
 305     function _getURL($basepage) {
 306         $link = $this->expand($basepage);
 307         return $link->getAttr('href');
 308     }
 309
 310     function expand($basepage) {
 311         include_once('lib/interwiki.php');
 312         $intermap = InterWikiMap::GetMap($GLOBALS['request']);
 313         $label = isset($this->_label) ? $this->_label : false;
 314         return $intermap->link($this->_link, $label);
 315     }
 316 }
 317
 318
 319
 320 class Cached_PluginInvocation extends Cached_DynamicContent {
 321     function Cached_PluginInvocation ($pi) {
 322         $this->_pi = $pi;
 323     }
 324
 325     function setTightness($top, $bottom) {
 326         $this->_tightenable = 0;
 327         if ($top) $this->_tightenable |= 1;
 328         if ($bottom) $this->_tightenable |= 2;
 329     }
 330
 331     function isInlineElement() {
 332         return false;
 333     }
 334
 335     function expand($basepage) {
 336         static $loader = false;
 337
 338         if (!$loader) {
 339             include_once('lib/WikiPlugin.php');
 340             $loader = new WikiPluginLoader;
 341         }
 342
 343         $xml = HTML::div(array('class' => 'plugin'),
 344                          $loader->expandPI($this->_pi, $GLOBALS['request'], $basepage));
 345
 346         if (isset($this->_tightenable)) {
 347             $xml->setInClass('tightenable');
 348             $xml->setInClass('top', ($this->_tightenable & 1) != 0);
 349             $xml->setInClass('bottom', ($this->_tightenable & 2) != 0);
 350         }
 351
 352         return $xml;
 353     }
 354 }
 355
 356 // (c-file-style: "gnu")
 357 // Local Variables:
 358 // mode: php
 359 // tab-width: 8
 360 // c-basic-offset: 4
 361 // c-hanging-comment-ender-p: nil
 362 // indent-tabs-mode: nil
 363 // End:
 364 ?>