lib/plugin/PageDump.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id$');
   3 /*
   4  * Copyright (C) 2003 $ThePhpWikiProgrammingTeam
   5  *
   6  * This file is part of PhpWiki.
   7  *
   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.
  12  *
  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.
  17  *
  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
  21  */
  22
  23 /**
  24  * PhpWikiPlugin for PhpWiki developers to generate single page dumps
  25  * for checking into cvs, or for users or the admin to produce a
  26  * downloadable page dump of a single page.
  27  *
  28  * This plugin will also be useful to (semi-)automatically sync pages
  29  * directly between two wikis. First the LoadFile function of
  30  * PhpWikiAdministration needs to be updated to handle URLs again, and
  31  * add loading capability from InterWiki addresses.
  32  *
  33  * Multiple revisions in one file handled by format=backup
  34  *
  35  * TODO: What about comments/summary field? quoted-printable?
  36  *
  37  * Usage:
  38  *  Direct URL access:
  39  *   http://...phpwiki/PageDump?page=HomePage?format=forcvs
  40  *   http://...phpwiki/index.php?PageDump&page=HomePage
  41  *   http://...phpwiki/index.php?PageDump&page=HomePage&download=1
  42  *  Static:
  43  *   <?plugin PageDump page=HomePage?>
  44  *  Dynamic form (put both on the page):
  45  *   <?plugin PageDump?>
  46  *   <?plugin-form PageDump?>
  47  *  Typical usage: as actionbar button
  48  */
  49
  50 class WikiPlugin_PageDump
  51 extends WikiPlugin
  52 {
  53     var $MessageId;
  54
  55     function getName() {
  56         return _("PageDump");
  57     }
  58     function getDescription() {
  59         return _("View a single page dump online.");
  60     }
  61
  62     function getVersion() {
  63         return preg_replace("/[Revision: $]/", '',
  64                             "\$Revision$");
  65     }
  66
  67     function getDefaultArguments() {
  68         return array('s'    => false,
  69                      'page' => '[pagename]',
  70                      //'encoding' => 'binary', // 'binary', 'quoted-printable'
  71                      'format' => false, // 'normal', 'forcvs', 'backup'
  72                      // display within WikiPage or give a downloadable
  73                      // raw pgsrc?
  74                      'download' => false);
  75     }
  76
  77     function run($dbi, $argstr, &$request, $basepage) {
  78         extract($this->getArgs($argstr, $request));
  79         // allow plugin-form
  80         if (!empty($s))
  81             $page = $s;
  82         if (!$page)
  83             return '';
  84         if (! $dbi->isWikiPage($page) )
  85             return fmt("Page %s not found.",
  86                        WikiLink($page, 'unknown'));
  87
  88         // Check if user is allowed to get the Page.
  89         if (!mayAccessPage ('view', $page)) {
  90                 return $this->error(sprintf(_("Illegal access to page %s: no read access"),
  91                                         $page));
  92         }
  93
  94         $p = $dbi->getPage($page);
  95         include_once("lib/loadsave.php");
  96         $mailified = MailifyPage($p, ($format == 'backup') ? 99 : 1);
  97
  98         // fixup_headers massages the page dump headers depending on
  99         // the 'format' argument, 'normal'(default) or 'forcvs'.
 100         //
 101         // Normal: Don't add X-Rcs-Id, add unique Message-Id, don't
 102         // strip any fields from Content-Type.
 103         //
 104         // ForCVS: Add empty X-Rcs-Id, strip attributes from
 105         // Content-Type field: "author", "version", "lastmodified",
 106         // "author_id", "hits".
 107
 108         $this->pagename = $page;
 109         $this->generateMessageId($mailified);
 110         if ($format == 'forcvs')
 111             $this->fixup_headers_forcvs($mailified);
 112         else // backup or normal
 113             $this->fixup_headers($mailified);
 114
 115         if ($download) {
 116             // TODO: we need a way to hook into the generated headers, to override
 117             // Content-Type, Set-Cookie, Cache-control, ...
 118             $request->discardOutput(); // Hijack the http request from PhpWiki.
 119             ob_end_clean();            // clean up after hijacking $request
 120             //ob_end_flush(); //debugging
 121             $filename = FilenameForPage($page);
 122             Header("Content-disposition: attachment; filename=\""
 123                    . $filename . "\"");
 124             // Read charset from generated page itself.
 125             // Inconsequential at the moment, since loadsave.php
 126             // always generates headers.
 127             $charset = $p->get('charset');
 128             if (!$charset) $charset = $GLOBALS['charset'];
 129             // We generate 3 Content-Type headers! first in loadsave,
 130             // then here and the mimified string $mailified also has it!
 131             // This one is correct and overwrites the others.
 132             Header("Content-Type: application/octet-stream; name=\""
 133                    . $filename . "\"; charset=\"" . $charset
 134                    . "\"");
 135             $request->checkValidators();
 136             // let $request provide last modified & etag
 137             Header("Content-Id: <" . $this->MessageId . ">");
 138             // be nice to http keepalive~s
 139             Header("Content-Length: " . strlen($mailified));
 140
 141             // Here comes our prepared mime file
 142             echo $mailified;
 143             exit; // noreturn! php exits.
 144             return;
 145         }
 146         // We are displaing inline preview in a WikiPage, so wrap the
 147         // text if it is too long--unless quoted-printable (TODO).
 148         $mailified = safe_wordwrap($mailified, 70);
 149
 150         $dlcvs = Button(array(//'page' => $page,
 151                               'action' => $this->getName(),
 152                               'format'=> 'forcvs',
 153                               'download'=> true),
 154                         _("Download for CVS"),
 155                         $page);
 156         $dl = Button(array(//'page' => $page,
 157                            'action' => $this->getName(),
 158                            'download'=> true),
 159                      _("Download for backup"),
 160                      $page);
 161         $dlall = Button(array(//'page' => $page,
 162                            'action' => $this->getName(),
 163                            'format'=> 'backup',
 164                            'download'=> true),
 165                      _("Download all revisions for backup"),
 166                      $page);
 167
 168         $h2 = HTML::h2(fmt("Preview: Page dump of %s",
 169                            WikiLink($page, 'auto')));
 170         global $WikiTheme;
 171         if (!$Sep = $WikiTheme->getButtonSeparator())
 172             $Sep = " ";
 173
 174         if ($format == 'forcvs') {
 175             $desc = _("(formatted for PhpWiki developers as pgsrc template, not for backing up)");
 176             $altpreviewbuttons = HTML(
 177                                       Button(array('action' => $this->getName()),
 178                                              _("Preview as normal format"),
 179                                              $page),
 180                                       $Sep,
 181                                       Button(array(
 182                                                    'action' => $this->getName(),
 183                                                    'format'=> 'backup'),
 184                                              _("Preview as backup format"),
 185                                              $page));
 186         }
 187         elseif ($format == 'backup') {
 188             $desc = _("(formatted for backing up: all revisions)"); // all revisions
 189             $altpreviewbuttons = HTML(
 190                                       Button(array('action' => $this->getName(),
 191                                                    'format'=> 'forcvs'),
 192                                              _("Preview as developer format"),
 193                                              $page),
 194                                       $Sep,
 195                                       Button(array(
 196                                                    'action' => $this->getName(),
 197                                                    'format'=> ''),
 198                                              _("Preview as normal format"),
 199                                              $page));
 200         } else {
 201             $desc = _("(normal formatting: latest revision only)");
 202             $altpreviewbuttons = HTML(
 203                                       Button(array('action' => $this->getName(),
 204                                                    'format'=> 'forcvs'),
 205                                              _("Preview as developer format"),
 206                                              $page),
 207                                       $Sep,
 208                                       Button(array(
 209                                                    'action' => $this->getName(),
 210                                                    'format'=> 'backup'),
 211                                              _("Preview as backup format"),
 212                                              $page));
 213         }
 214         $warning = HTML(
 215 _("Please use one of the downloadable versions rather than copying and pasting from the above preview.")
 216 . " " .
 217 _("The wordwrap of the preview doesn't take nested markup or list indentation into consideration!")
 218 . " ",
 219 HTML::em(
 220 _("PhpWiki developers should manually inspect the downloaded file for nested markup before rewrapping with emacs and checking into CVS.")
 221          )
 222                         );
 223
 224         return HTML($h2, HTML::em($desc),
 225                     HTML::pre($mailified),
 226                     $altpreviewbuttons,
 227                     HTML::div(array('class' => 'errors'),
 228                               HTML::strong(_("Warning:")),
 229                               " ", $warning),
 230                     $dl, $Sep, $dlall, $Sep, $dlcvs
 231                     );
 232     }
 233
 234     // function handle_plugin_args_cruft(&$argstr, &$args) {
 235     // }
 236
 237     function generateMessageId($mailified) {
 238         $array = explode("\n", $mailified);
 239         // Extract lastmodifed from mailified document for Content-Id
 240         // and/or Message-Id header, NOT from DB (page could have been
 241         // edited by someone else since we started).
 242         $m1 = preg_grep("/^\s+lastmodified\=(.*);/", $array);
 243         $m1 = array_values($m1); //reset resulting keys
 244         unset($array);
 245         $m2 = preg_split("/(^\s+lastmodified\=)|(;)/", $m1[0], 2,
 246                          PREG_SPLIT_NO_EMPTY);
 247
 248         // insert message id into actual message when appropriate, NOT
 249         // into http header should be part of fixup_headers, in the
 250         // format:
 251         // <abbrphpwikiversion.mtimeepochTZ%InterWikiLinktothispage@hostname>
 252         // Hopefully this provides a unique enough identifier without
 253         // using md5. Even though this particular wiki may not
 254         // actually be part of InterWiki, including this info provides
 255         // the wiki name and name of the page which is being
 256         // represented as a text message.
 257         $this->MessageId = implode('', explode('.', PHPWIKI_VERSION))
 258             . "-" . $m2[0] . date("O")
 259             //. "-". rawurlencode(WIKI_NAME.":" . $request->getURLtoSelf())
 260             . "-". rawurlencode(WIKI_NAME.":" . $this->pagename)
 261             . "@". rawurlencode(SERVER_NAME);
 262     }
 263
 264     function fixup_headers(&$mailified) {
 265         $return = explode("\n", $mailified);
 266
 267         // Leave message intact for backing up, just add Message-Id header before transmitting.
 268         $item_to_insert = "Message-Id: <" . $this->MessageId .">";
 269         $insert_into_key_position = 2;
 270         $returnval_ignored = array_splice($return,
 271                                           $insert_into_key_position,
 272                                           0, $item_to_insert);
 273
 274         $mailified = implode("\n", array_values($return));
 275     }
 276
 277     function fixup_headers_forcvs(&$mailified) {
 278         $array = explode("\n", $mailified);
 279
 280         // Massage headers to prepare for developer checkin to CVS.
 281         $item_to_insert = "X-Rcs-Id: \$Id\$";
 282         $insert_into_key_position = 2;
 283         $returnval_ignored = array_splice($array,
 284                                           $insert_into_key_position,
 285                                           0, $item_to_insert);
 286
 287         $item_to_insert = "  pgsrc_version=\"2 \$Revision\$\";";
 288         $insert_into_key_position = 5;
 289         $returnval_ignored = array_splice($array,
 290                                           $insert_into_key_position,
 291                                           0, $item_to_insert);
 292         /*
 293             Strip out all this junk:
 294             author=MeMe;
 295             version=74;
 296             lastmodified=1041561552;
 297             author_id=127.0.0.1;
 298             hits=146;
 299         */
 300         $killme = array("author", "version", "lastmodified",
 301                         "author_id", "hits", "owner", "acl");
 302         // UltraNasty, fixme:
 303         foreach ($killme as $pattern) {
 304             $array = preg_replace("/^\s\s$pattern\=.*;/",
 305                                   /*$replacement =*/"zzzjunk", $array);
 306         }
 307         // remove deleted values from array
 308         for ($i = 0; $i < count($array); $i++ ) {
 309             if(trim($array[$i]) != "zzzjunk") { //nasty, fixme
 310             //trigger_error("'$array[$i]'");//debugging
 311                 $return[] = $array[$i];
 312             }
 313         }
 314
 315         $mailified = implode("\n", $return);
 316     }
 317 };
 318
 319 // For emacs users
 320 // Local Variables:
 321 // mode: php
 322 // tab-width: 8
 323 // c-basic-offset: 4
 324 // c-hanging-comment-ender-p: nil
 325 // indent-tabs-mode: nil
 326 // End:
 327 ?>