1 <?php rcs_id('$Id: loadsave.php,v 1.63 2002-02-25 15:57:11 carstenklapp Exp $');
3 require_once("lib/ziplib.php");
4 require_once("lib/Template.php");
6 function StartLoadDump(&$request, $title, $html = '')
8 // FIXME: This is a hack
9 $tmpl = Template('top', array('TITLE' => $title,
11 'CONTENT' => '%BODY%'));
12 echo ereg_replace('%BODY%.*', '', $tmpl->getExpansion($html));
15 function EndLoadDump(&$request)
17 // FIXME: This is a hack
18 $pagelink = WikiLink($request->getPage());
20 PrintXML(HTML::p(HTML::strong(_("Complete."))),
21 HTML::p(fmt("Return to %s", $pagelink)));
22 echo "</body></html>\n";
26 ////////////////////////////////////////////////////////////////
28 // Functions for dumping.
30 ////////////////////////////////////////////////////////////////
34 * http://www.nacs.uci.edu/indiv/ehood/MIME/2045/rfc2045.html
35 * http://www.faqs.org/rfcs/rfc2045.html
36 * (RFC 1521 has been superceeded by RFC 2045 & others).
38 * Also see http://www.faqs.org/rfcs/rfc2822.html
40 function MailifyPage ($page, $nversions = 1)
42 $current = $page->getCurrentRevision();
45 if (STRICT_MAILABLE_PAGEDUMPS) {
46 $from = defined('SERVER_ADMIN') ? SERVER_ADMIN : 'foo@bar';
47 //This is for unix mailbox format: (not RFC (2)822)
48 // $head .= "From $from " . CTime(time()) . "\r\n";
49 $head .= "Subject: " . rawurlencode($page->getName()) . "\r\n";
50 $head .= "From: $from (PhpWiki)\r\n";
51 // RFC 2822 requires only a Date: and originator (From:)
52 // field, however the obsolete standard RFC 822 also
53 // requires a destination field.
54 $head .= "To: $from (PhpWiki)\r\n";
56 $head .= "Date: " . Rfc2822DateTime($current->get('mtime')) . "\r\n";
57 $head .= sprintf("Mime-Version: 1.0 (Produced by PhpWiki %s)\r\n",
60 // This should just be entered by hand (or by script?)
61 // in the actual pgsrc files, since only they should have
63 //$head .= "X-Rcs-Id: \$Id\$\r\n";
65 $iter = $page->getAllRevisions();
67 while ($revision = $iter->next()) {
68 $parts[] = MimeifyPageRevision($revision);
69 if ($nversions > 0 && count($parts) >= $nversions)
72 if (count($parts) > 1)
73 return $head . MimeMultipart($parts);
75 return $head . $parts[0];
79 * Compute filename to used for storing contents of a wiki page.
81 * Basically we do a rawurlencode() which encodes everything except
82 * ASCII alphanumerics and '.', '-', and '_'.
84 * But we also want to encode leading dots to avoid filenames like
85 * '.', and '..'. (Also, there's no point in generating "hidden" file
86 * names, like '.foo'.)
88 * @param $pagename string Pagename.
89 * @return string Filename for page.
91 function FilenameForPage ($pagename)
93 $enc = rawurlencode($pagename);
94 return preg_replace('/^\./', '%2e', $enc);
98 * The main() function which generates a zip archive of a PhpWiki.
100 * If $include_archive is false, only the current version of each page
101 * is included in the zip file; otherwise all archived versions are
104 function MakeWikiZip (&$request)
106 if ($request->getArg('include') == 'all') {
107 $zipname = "wikidb.zip";
108 $include_archive = true;
111 $zipname = "wiki.zip";
112 $include_archive = false;
117 $zip = new ZipWriter("Created by PhpWiki", $zipname);
119 $dbi = $request->getDbh();
120 $pages = $dbi->getAllPages();
121 while ($page = $pages->next()) {
122 if (! get_cfg_var('safe_mode'))
123 set_time_limit(30); // Reset watchdog.
125 $current = $page->getCurrentRevision();
126 if ($current->getVersion() == 0)
130 $attrib = array('mtime' => $current->get('mtime'),
132 if ($page->get('locked'))
133 $attrib['write_protected'] = 1;
135 if ($include_archive)
136 $content = MailifyPage($page, 0);
138 $content = MailifyPage($page);
140 $zip->addRegularFile( FilenameForPage($page->getName()),
146 function DumpToDir (&$request)
148 $directory = $request->getArg('directory');
149 if (empty($directory))
150 $request->finish(_("You must specify a directory to dump to"));
152 // see if we can access the directory the user wants us to use
153 if (! file_exists($directory)) {
154 if (! mkdir($directory, 0755))
155 $request->finish(fmt("Cannot create directory '%s'", $directory));
157 $html = HTML::p(fmt("Created directory '%s' for the page dump...",
160 $html = HTML::p(fmt("Using directory '%s'", $directory));
163 StartLoadDump($request, _("Dumping Pages"), $html);
165 $dbi = $request->getDbh();
166 $pages = $dbi->getAllPages();
168 while ($page = $pages->next()) {
169 if (! get_cfg_var('safe_mode'))
170 set_time_limit(30); // Reset watchdog.
172 $filename = FilenameForPage($page->getName());
174 $msg = HTML(HTML::br(), $page->getName(), ' ... ');
176 if($page->getName() != $filename) {
177 $msg->pushContent(HTML::small(fmt("saved as %s", $filename)),
181 if ($request->getArg('include') == 'all')
182 $data = MailifyPage($page, 0);
184 $data = MailifyPage($page);
186 if ( !($fd = fopen("$directory/$filename", "w")) ) {
187 $msg->pushContent(HTML::strong(fmt("couldn't open file '%s' for writing",
188 "$directory/$filename")));
189 $request->finish($msg);
192 $num = fwrite($fd, $data, strlen($data));
193 $msg->pushContent(HTML::small(fmt("%s bytes written", $num)));
197 assert($num == strlen($data));
201 EndLoadDump($request);
205 function DumpHtmlToDir (&$request)
207 $directory = $request->getArg('directory');
208 if (empty($directory))
209 $request->finish(_("You must specify a directory to dump to"));
211 // see if we can access the directory the user wants us to use
212 if (! file_exists($directory)) {
213 if (! mkdir($directory, 0755))
214 $request->finish(fmt("Cannot create directory '%s'", $directory));
216 $html = HTML::p(fmt("Created directory '%s' for the page dump...",
219 $html = HTML::p(fmt("Using directory '%s'", $directory));
222 StartLoadDump($request, _("Dumping Pages"), $html);
224 $dbi = $request->getDbh();
225 $pages = $dbi->getAllPages();
227 while ($page = $pages->next()) {
228 if (! get_cfg_var('safe_mode'))
229 set_time_limit(30); // Reset watchdog.
231 $filename = FilenameForPage($page->getName()); /* . ".html";*/
233 $msg = HTML(HTML::br(), $page->getName(), ' ... ');
235 if($page->getName() != $filename) {
236 $msg->pushContent(HTML::small(fmt("saved as %s", $filename)),
240 $revision = $page->getCurrentRevision();
242 require_once('lib/PageType.php');
243 $transformedContent = PageType($revision);
245 $template = new Template('browse', $request,
246 array('revision' => $revision, 'CONTENT' => $transformedContent));
248 $data = GeneratePageasXML($template, $page->getName());
250 if ( !($fd = fopen("$directory/$filename", "w")) ) {
251 $msg->pushContent(HTML::strong(fmt("couldn't open file '%s' for writing",
252 "$directory/$filename")));
253 $request->finish($msg);
256 $num = fwrite($fd, $data, strlen($data));
257 $msg->pushContent(HTML::small(fmt("%s bytes written", $num)));
261 assert($num == strlen($data));
265 //CopyImageFiles() will go here;
267 EndLoadDump($request);
270 function MakeWikiZipHtml (&$request)
272 $zipname = "wikihtml.zip";
273 $zip = new ZipWriter("Created by PhpWiki", $zipname);
274 $dbi = $request->getDbh();
275 $pages = $dbi->getAllPages();
276 while ($page = $pages->next()) {
277 if (! get_cfg_var('safe_mode'))
278 set_time_limit(30); // Reset watchdog.
280 $current = $page->getCurrentRevision();
281 if ($current->getVersion() == 0)
284 $attrib = array('mtime' => $current->get('mtime'),
286 if ($page->get('locked'))
287 $attrib['write_protected'] = 1;
289 $pagename = $page->getName();
290 $filename = FilenameForPage($pagename);
291 //$filename = $filename . ".html";
293 $revision = $page->getCurrentRevision();
295 require_once('lib/PageType.php');
296 $transformedContent = PageType($revision);
298 $template = new Template('browse', $request,
299 array('revision' => $revision,
300 'CONTENT' => $transformedContent));
302 $data = GeneratePageasXML($template, $pagename);
304 $zip->addRegularFile( $filename, $data, $attrib);
306 // FIXME: Deal with images here.
311 ////////////////////////////////////////////////////////////////
313 // Functions for restoring.
315 ////////////////////////////////////////////////////////////////
317 function SavePage (&$request, $pageinfo, $source, $filename)
319 $pagedata = $pageinfo['pagedata']; // Page level meta-data.
320 $versiondata = $pageinfo['versiondata']; // Revision level meta-data.
322 if (empty($pageinfo['pagename'])) {
323 PrintXML(HTML::dt(HTML::strong(_("Empty pagename!"))));
327 if (empty($versiondata['author_id']))
328 $versiondata['author_id'] = $versiondata['author'];
330 $pagename = $pageinfo['pagename'];
331 $content = $pageinfo['content'];
333 if ($pagename ==_("InterWikiMap"))
334 $content = _tryinsertInterWikiMap($content);
336 $dbi = $request->getDbh();
337 $page = $dbi->getPage($pagename);
339 foreach ($pagedata as $key => $value) {
341 $page->set($key, $value);
347 $mesg->pushContent(' ', fmt("from %s", $source));
350 $current = $page->getCurrentRevision();
351 if ($current->getVersion() == 0) {
352 $mesg->pushContent(' ', _("new page"));
356 if ($current->getPackedContent() == $content
357 && $current->get('author') == $versiondata['author']) {
358 $mesg->pushContent(' ',
359 fmt("is identical to current version %d - skipped",
360 $current->getVersion()));
367 $new = $page->createRevision(WIKIDB_FORCE_CREATE, $content,
369 ExtractWikiPageLinks($content));
371 $mesg->pushContent(' ', fmt("- saved to database as version %d",
372 $new->getVersion()));
375 PrintXML(HTML::dt(WikiLink($pagename)), $mesg);
379 function _tryinsertInterWikiMap($content) {
381 if (strpos($content, "<verbatim>")) {
382 //$error_html = " The newly loaded pgsrc already contains a verbatim block.";
385 if (!$goback && !defined('INTERWIKI_MAP_FILE')) {
386 $error_html = sprintf(" "._("%s: not defined"), "INTERWIKI_MAP_FILE");
389 if (!$goback && !file_exists(INTERWIKI_MAP_FILE)) {
390 $error_html = sprintf(" "._("%s: file not found"), INTERWIKI_MAP_FILE);
394 if (!empty($error_html))
395 trigger_error(_("Default InterWiki map file not loaded.")
396 . $error_html, E_USER_NOTICE);
401 $filename = INTERWIKI_MAP_FILE;
402 trigger_error(sprintf(_("Loading InterWikiMap from external file %s."),
403 $filename), E_USER_NOTICE);
405 $fd = fopen ($filename, "rb");
406 $data = fread ($fd, filesize($filename));
408 $content = $content . "\n<verbatim>\n$data</verbatim>\n";
412 function ParseSerializedPage($text, $default_pagename, $user)
414 if (!preg_match('/^a:\d+:{[si]:\d+/', $text))
417 $pagehash = unserialize($text);
419 // Split up pagehash into four parts:
422 // page-level meta-data
423 // revision-level meta-data
425 if (!defined('FLAG_PAGE_LOCKED'))
426 define('FLAG_PAGE_LOCKED', 1);
427 $pageinfo = array('pagedata' => array(),
428 'versiondata' => array());
430 $pagedata = &$pageinfo['pagedata'];
431 $versiondata = &$pageinfo['versiondata'];
434 if (empty($pagehash['pagename']))
435 $pagehash['pagename'] = $default_pagename;
436 if (empty($pagehash['author'])) {
437 $pagehash['author'] = $user->getId();
440 foreach ($pagehash as $key => $value) {
445 $pageinfo[$key] = $value;
448 $pageinfo[$key] = join("\n", $value);
451 if (($value & FLAG_PAGE_LOCKED) != 0)
452 $pagedata['locked'] = 'yes';
455 $pagedata[$key] = $value;
458 $versiondata['mtime'] = $value;
463 $versiondata[$key] = $value;
470 function SortByPageVersion ($a, $b) {
471 return $a['version'] - $b['version'];
474 function LoadFile (&$request, $filename, $text = false, $mtime = false)
476 if (!is_string($text)) {
478 $stat = stat($filename);
480 $text = implode("", file($filename));
483 if (! get_cfg_var('safe_mode'))
484 set_time_limit(30); // Reset watchdog.
486 // FIXME: basename("filewithnoslashes") seems to return garbage sometimes.
487 $basename = basename("/dummy/" . $filename);
490 $mtime = time(); // Last resort.
492 $default_pagename = rawurldecode($basename);
494 if ( ($parts = ParseMimeifiedPages($text)) ) {
495 usort($parts, 'SortByPageVersion');
496 foreach ($parts as $pageinfo)
497 SavePage($request, $pageinfo, sprintf(_("MIME file %s"),
498 $filename), $basename);
500 else if ( ($pageinfo = ParseSerializedPage($text, $default_pagename,
501 $request->getUser())) ) {
502 SavePage($request, $pageinfo, sprintf(_("Serialized file %s"),
503 $filename), $basename);
506 $user = $request->getUser();
508 // Assume plain text file.
509 $pageinfo = array('pagename' => $default_pagename,
510 'pagedata' => array(),
512 => array('author' => $user->getId()),
513 'content' => preg_replace('/[ \t\r]*\n/', "\n",
516 SavePage($request, $pageinfo, sprintf(_("plain file %s"), $filename),
521 function LoadZip (&$request, $zipfile, $files = false, $exclude = false) {
522 $zip = new ZipReader($zipfile);
523 while (list ($fn, $data, $attrib) = $zip->readFile()) {
524 // FIXME: basename("filewithnoslashes") seems to return
525 // garbage sometimes.
526 $fn = basename("/dummy/" . $fn);
527 if ( ($files && !in_array($fn, $files)) || ($exclude && in_array($fn, $exclude)) ) {
529 PrintXML(HTML::dt(WikiLink($fn)),
530 HTML::dd(_("Skipping")));
534 LoadFile($request, $fn, $data, $attrib['mtime']);
538 function LoadDir (&$request, $dirname, $files = false, $exclude = false) {
539 $fileset = new LimitedFileSet($dirname, $files, $exclude);
541 if (($skiplist = $fileset->getSkippedFiles())) {
542 PrintXML(HTML::dt(HTML::strong(_("Skipping"))));
544 foreach ($skiplist as $file)
545 $list->pushContent(HTML::li(WikiLink($file)));
546 PrintXML(HTML::dd($list));
549 // Defer HomePage loading until the end. If anything goes wrong
550 // the pages can still be loaded again.
551 $files = $fileset->getFiles();
552 if (in_array(HomePage, $files)) {
553 $files = array_diff($files, array(HomePage));
556 foreach ($files as $file)
557 LoadFile($request, "$dirname/$file");
560 class LimitedFileSet extends FileSet {
561 function LimitedFileSet($dirname, $_include, $exclude) {
562 $this->_includefiles = $_include;
563 $this->_exclude = $exclude;
564 $this->_skiplist = array();
565 parent::FileSet($dirname);
568 function _filenameSelector($fn) {
569 $incl = &$this->_include;
570 $excl = &$this->_exclude;
572 if (($incl && !in_array($fn, $incl)) || ($excl && in_array($fn, $excl))) {
573 $this->_skiplist[] = $fn;
580 function getSkippedFiles () {
581 return $this->_skiplist;
586 function IsZipFile ($filename_or_fd)
588 // See if it looks like zip file
589 if (is_string($filename_or_fd))
591 $fd = fopen($filename_or_fd, "rb");
592 $magic = fread($fd, 4);
597 $fpos = ftell($filename_or_fd);
598 $magic = fread($filename_or_fd, 4);
599 fseek($filename_or_fd, $fpos);
602 return $magic == ZIP_LOCHEAD_MAGIC || $magic == ZIP_CENTHEAD_MAGIC;
606 function LoadAny (&$request, $file_or_dir, $files = false, $exclude = false)
608 // Try urlencoded filename for accented characters.
609 if (!file_exists($file_or_dir)) {
610 // Make sure there are slashes first to avoid confusing phps
611 // with broken dirname or basename functions.
612 // FIXME: windows uses \ and :
613 if (is_integer(strpos($file_or_dir, "/"))) {
614 $file_or_dir = dirname($file_or_dir) ."/".
615 urlencode(basename($file_or_dir));
617 // This is probably just a file.
618 $file_or_dir = urlencode($file_or_dir);
622 $type = filetype($file_or_dir);
623 if ($type == 'link') {
624 // For symbolic links, use stat() to determine
625 // the type of the underlying file.
626 list(,,$mode) = stat($file_or_dir);
627 $type = ($mode >> 12) & 017;
630 elseif ($type == 004)
634 if ($type == 'dir') {
635 LoadDir($request, $file_or_dir, $files, $exclude);
637 else if ($type != 'file' && !preg_match('/^(http|ftp):/', $file_or_dir))
639 $request->finish(fmt("Bad file type: %s", $type));
641 else if (IsZipFile($file_or_dir)) {
642 LoadZip($request, $file_or_dir, $files, $exclude);
644 else /* if (!$files || in_array(basename($file_or_dir), $files)) */
646 LoadFile($request, $file_or_dir);
650 function LoadFileOrDir (&$request)
652 $source = $request->getArg('source');
653 StartLoadDump($request, sprintf(_("Loading '%s'"), $source));
655 LoadAny($request, $source);
657 EndLoadDump($request);
660 function SetupWiki (&$request)
662 global $GenericPages, $LANG;
665 //FIXME: This is a hack (err, "interim solution")
666 // This is a bogo-bogo-login: Login without
667 // saving login information in session state.
668 // This avoids logging in the unsuspecting
669 // visitor as "The PhpWiki programming team".
671 // This really needs to be cleaned up...
672 // (I'm working on it.)
673 $real_user = $request->_user;
674 $request->_user = new WikiUser(_("The PhpWiki programming team"),
677 StartLoadDump($request, _("Loading up virgin wiki"));
680 LoadAny($request, FindLocalizedFile(WIKI_PGSRC));
682 LoadAny($request, FindFile(DEFAULT_WIKI_PGSRC),
686 EndLoadDump($request);
689 function LoadPostFile (&$request)
691 $upload = $request->getUploadedFile('file');
694 $request->finish(_("No uploaded file to upload?")); // FIXME: more concise message
697 // Dump http headers.
698 StartLoadDump($request, sprintf(_("Uploading %s"), $upload->getName()));
701 $fd = $upload->open();
703 LoadZip($request, $fd, false, array(_("RecentChanges")));
705 LoadFile($request, $upload->getName(), $upload->getContents());
708 EndLoadDump($request);
716 // c-hanging-comment-ender-p: nil
717 // indent-tabs-mode: nil