lib/plugin/WikiBlog.php

   1 <?php
   2
   3 /*
   4  * Copyright 2002,2003,2007,2009 $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 along
  19  * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21  */
  22 /**
  23  * @author: MichaelVanDam, major refactor by JeffDairiki (as AddComment)
  24  * @author: Changed as baseclass to AddComment and WikiForum and EditToolbar integration by ReiniUrban.
  25  */
  26
  27 require_once 'lib/TextSearchQuery.php';
  28
  29 /**
  30  * This plugin shows 'blogs' (comments/news) associated with a
  31  * particular page and provides an input form for adding a new blog.
  32  *
  33  * TODO:
  34  *
  35  * It also works as an action-page if you create a page called 'WikiBlog'
  36  * containing this plugin.  This allows adding comments to any page
  37  * by linking "PageName?action=WikiBlog".  Maybe a nice feature in
  38  * lib/display.php would be to automatically check if there are
  39  * blogs for the given page, then provide a link to them somewhere on
  40  * the page.  Or maybe this just creates a huge mess...
  41  *
  42  * Maybe it would be a good idea to ENABLE blogging of only certain
  43  * pages by setting metadata or something...?  If a page is non-bloggable
  44  * the plugin is ignored (perhaps with a warning message).
  45  *
  46  * Should blogs be by default filtered out of RecentChanges et al???
  47  *
  48  * Think of better name for this module: Blog? WikiLog? WebLog? WikiDot?
  49  *
  50  * Have other 'styles' for the plugin?... e.g. 'quiet'.  Display only
  51  * 'This page has 23 associated comments. Click here to view / add.'
  52  *
  53  * For admin user, put checkboxes beside comments to allow for bulk removal.
  54  *
  55  * Permissions for who can add blogs?  Display entry box only if
  56  * user meets these requirements...?
  57  *
  58  * Code cleanup: break into functions, use templates (or at least remove CSS)
  59  */
  60
  61 class WikiPlugin_WikiBlog
  62     extends WikiPlugin
  63 {
  64     function getDescription()
  65     {
  66         return sprintf(_("Show and add blogs for %s."), '[pagename]');
  67     }
  68
  69     // Arguments:
  70     // TODO:
  71     //
  72     // - arguments to allow selection of time range to display
  73     // - arguments to display only XX blogs per page (can this 'paging'
  74     //    co-exist with the wiki??  difficult)
  75     // - arguments to allow comments outside this range to be
  76     //    display as e.g. June 2002 archive, July 2002 archive, etc..
  77     // - captions for 'show' and 'add' sections
  78
  79     function getDefaultArguments()
  80     {
  81         return array('pagename' => '[pagename]',
  82             'order' => 'normal',
  83             'mode' => 'show,add',
  84             'noheader' => false
  85         );
  86     }
  87
  88     function run($dbi, $argstr, &$request, $basepage)
  89     {
  90         $args = $this->getArgs($argstr, $request);
  91         // allow empty pagenames for ADMIN_USER style blogs: "Blog/day"
  92         //if (!$args['pagename'])
  93         //    return $this->error(_("No pagename specified"));
  94
  95         // Get our form args.
  96         $blog = $request->getArg("edit");
  97         $request->setArg("edit", false);
  98
  99         if ($request->isPost() and !empty($blog['save'])) {
 100             $this->add($request, $blog, 'wikiblog', $basepage); // noreturn
 101         }
 102         //TODO: preview
 103
 104         // Now we display previous comments and/or provide entry box
 105         // for new comments
 106         $html = HTML();
 107         foreach (explode(',', $args['mode']) as $show) {
 108             if (!empty($seen[$show]))
 109                 continue;
 110             $seen[$show] = 1;
 111
 112             switch ($show) {
 113                 case 'show':
 114                     $html->pushContent($this->showAll($request, $args));
 115                     break;
 116                 case 'add':
 117                     $html->pushContent($this->showForm($request, $args));
 118                     break;
 119                 default:
 120                     return $this->error(sprintf("Bad mode (“%s”)", $show));
 121             }
 122         }
 123         return $html;
 124     }
 125
 126     /**
 127      * posted: required: pagename, content. optional: summary
 128      */
 129     function add(&$request, $posted, $type = 'wikiblog')
 130     {
 131         // This is similar to editpage. Shouldn't we use just this for preview?
 132         $parent = $posted['pagename'];
 133         if (empty($parent)) {
 134             $prefix = ""; // allow empty parent for default "Blog/day"
 135             $parent = HOME_PAGE;
 136         } elseif (($parent == 'Blog' or $parent == 'WikiBlog') and $type == 'wikiblog') { // avoid Blog/Blog/2003-01-11/14:03:02+00:00
 137             $prefix = "";
 138             $parent = ''; // 'Blog';
 139         } elseif ($parent == 'Comment' and $type == "comment") {
 140             $prefix = "";
 141             $parent = ''; // 'Comment';
 142         } elseif ($parent == 'Forum' and $type == "wikiforum") {
 143             $prefix = "";
 144             $parent = ''; // 'Forum';
 145         } else {
 146             $prefix = $parent . SUBPAGE_SEPARATOR;
 147         }
 148         //$request->finish(fmt("No pagename specified for %s",$type));
 149
 150         $now = time();
 151         $dbi = $request->getDbh();
 152         $user = $request->getUser();
 153
 154         /*
 155          * Page^H^H^H^H Blog meta-data
 156          * This method is reused for all attachable pagetypes: wikiblog, comment and wikiforum
 157          *
 158          * This is info that won't change for each revision.
 159          * Nevertheless, it's now stored in the revision meta-data.
 160          * Several reasons:
 161          *  o It's more convenient to have all information required
 162          *    to render a page revision in the revision meta-data.
 163          *  o We can avoid a race condition, since version meta-data
 164          *    updates are atomic with the version creation.
 165          */
 166
 167         $blog_meta = array('ctime' => $now,
 168             'creator' => $user->getId(),
 169             'creator_id' => $user->getAuthenticatedId(),
 170         );
 171
 172         // Version meta-data
 173         $summary = trim($posted['summary']);
 174         // edit: private only
 175         $perm = new PagePermission();
 176         $perm->perm['edit'] = $perm->perm['remove'];
 177         $version_meta = array('author' => $blog_meta['creator'],
 178             'author_id' => $blog_meta['creator_id'],
 179             'summary' => $summary ? $summary : _("New comment."),
 180             'mtime' => $now,
 181             'pagetype' => $type,
 182             $type => $blog_meta,
 183             'perm' => $perm->perm,
 184         );
 185         if ($type == 'comment')
 186             unset($version_meta['summary']);
 187
 188         // Comment body.
 189         $body = trim($posted['content']);
 190
 191         $saved = false;
 192         if ($type != 'wikiforum')
 193             $pagename = $this->blogPrefix($type);
 194         else {
 195             $pagename = substr($summary, 0, 12);
 196             if (empty($pagename)) {
 197                 $saved = true;
 198                 trigger_error("Empty title", E_USER_WARNING);
 199             }
 200         }
 201         while (!$saved) {
 202             // Generate the page name.  For now, we use the format:
 203             //   Rootname/Blog/2003-01-11/14:03:02+00:00
 204             // Rootname = $prefix, Blog = $pagename,
 205             // This gives us natural chronological order when sorted
 206             // alphabetically. "Rootname/" is optional.
 207             // Esp. if Rootname is named Blog, it is omitted.
 208
 209             $time = Iso8601DateTime();
 210             // Check intermediate pages. If not existing they should RedirectTo the parent page.
 211             // Maybe add the BlogArchives plugin instead for the new interim subpage.
 212             $redirected = $prefix . $pagename;
 213             if (!$dbi->isWikiPage($redirected)) {
 214                 if (!$parent) $parent = HOME_PAGE;
 215                 require_once 'lib/loadsave.php';
 216                 $pageinfo = array('pagename' => $redirected,
 217                     'content' => '<<RedirectTo page="' . $parent . '">>',
 218                     'pagedata' => array(),
 219                     'versiondata' => array('author' => $blog_meta['creator'], 'is_minor_edit' => 1),
 220                 );
 221                 SavePage($request, $pageinfo, '', '');
 222             }
 223             $redirected = $prefix . $pagename . SUBPAGE_SEPARATOR . preg_replace("/T.*/", "", "$time");
 224             if (!$dbi->isWikiPage($redirected)) {
 225                 if (!$parent) $parent = HOME_PAGE;
 226                 require_once 'lib/loadsave.php';
 227                 $pageinfo = array('pagename' => $redirected,
 228                     'content' => '<<RedirectTo page="' . $parent . '">>',
 229                     'pagedata' => array(),
 230                     'versiondata' => array('author' => $blog_meta['creator'], 'is_minor_edit' => 1),
 231                 );
 232                 SavePage($request, $pageinfo, '', '');
 233             }
 234
 235             $p = $dbi->getPage($prefix . $pagename . SUBPAGE_SEPARATOR
 236                 . str_replace("T", SUBPAGE_SEPARATOR, "$time"));
 237             $pr = $p->getCurrentRevision();
 238
 239             // Version should be zero.  If not, page already exists
 240             // so increment timestamp and try again.
 241             if ($pr->getVersion() > 0) {
 242                 $now++;
 243                 continue;
 244             }
 245
 246             // FIXME: there's a slight, but currently unimportant
 247             // race condition here.  If someone else happens to
 248             // have just created a blog with the same name,
 249             // we'll have locked it before we discover that the name
 250             // is taken.
 251             $saved = $p->save($body, 1, $version_meta);
 252
 253             $now++;
 254         }
 255
 256         $dbi->touch();
 257         $request->setArg("mode", "show");
 258         $request->redirect($request->getURLtoSelf()); // noreturn
 259
 260         // FIXME: when submit a comment from preview mode,
 261         // adds the comment properly but jumps to browse mode.
 262         // Any way to jump back to preview mode???
 263     }
 264
 265     function showAll(&$request, $args, $type = "wikiblog")
 266     {
 267         // FIXME: currently blogSearch uses WikiDB->titleSearch to
 268         // get results, so results are in alphabetical order.
 269         // When PageTypes fully implemented, could have smarter
 270         // blogSearch implementation / naming scheme.
 271
 272         $dbi = $request->getDbh();
 273         $basepage = $args['pagename'];
 274         $blogs = $this->findBlogs($dbi, $basepage, $type);
 275         $html = HTML();
 276         if ($blogs) {
 277             // First reorder
 278             usort($blogs, array("WikiPlugin_WikiBlog",
 279                 "cmp"));
 280             if ($args['order'] == 'reverse')
 281                 $blogs = array_reverse($blogs);
 282
 283             $name = $this->blogPrefix($type);
 284             if (!$args['noheader'])
 285                 $html->pushContent(HTML::h4(array('class' => "$type-heading"),
 286                     fmt("%s on %s:", $name, WikiLink($basepage))));
 287             foreach ($blogs as $rev) {
 288                 if (!$rev->get($type)) {
 289                     // Ack! this is an old-style blog with data ctime in page meta-data.
 290                     $content = $this->transformOldFormatBlog($rev, $type);
 291                 } else {
 292                     $content = $rev->getTransformedContent($type);
 293                 }
 294                 $html->pushContent($content);
 295             }
 296
 297         }
 298         return $html;
 299     }
 300
 301     // Subpage for the basepage. All Blogs/Forum/Comment entries are
 302     // Subpages under this pagename, to find them faster.
 303     protected function blogPrefix($type = 'wikiblog')
 304     {
 305         if ($type == 'wikiblog')
 306             $basepage = "Blog";
 307         elseif ($type == 'comment')
 308             $basepage = "Comment"; elseif ($type == 'wikiforum')
 309             $basepage = substr($summary, 0, 12);
 310         //$basepage = _("Message"); // FIXME: we use now the first 12 chars of the summary
 311         return $basepage;
 312     }
 313
 314     private function transformOldFormatBlog($rev, $type = 'wikiblog')
 315     {
 316         $page = $rev->getPage();
 317         $metadata = array();
 318         foreach (array('ctime', 'creator', 'creator_id') as $key)
 319             $metadata[$key] = $page->get($key);
 320         if (empty($metadata) and $type != 'wikiblog')
 321             $metadata[$key] = $page->get('wikiblog');
 322         $meta = $rev->getMetaData();
 323         $meta[$type] = $metadata;
 324         return new TransformedText($page, $rev->getPackedContent(), $meta, $type);
 325     }
 326
 327     function findBlogs(&$dbi, $basepage = '', $type = 'wikiblog')
 328     {
 329         $prefix = (empty($basepage)
 330             ? ""
 331             : $basepage . SUBPAGE_SEPARATOR) . $this->blogPrefix($type);
 332         $pages = $dbi->titleSearch(new TextSearchQuery('"' . $prefix . '"', true, 'none'));
 333
 334         $blogs = array();
 335         while ($page = $pages->next()) {
 336             if (!string_starts_with($page->getName(), $prefix))
 337                 continue;
 338             $current = $page->getCurrentRevision();
 339             if ($current->get('pagetype') == $type) {
 340                 $blogs[] = $current;
 341             }
 342         }
 343         return $blogs;
 344     }
 345
 346     function cmp($a, $b)
 347     {
 348         return (strcmp($a->get('mtime'),
 349             $b->get('mtime')));
 350     }
 351
 352     function showForm(&$request, $args, $template = 'blogform')
 353     {
 354         // Show blog-entry form.
 355         $args = array('PAGENAME' => $args['pagename'],
 356             'HIDDEN_INPUTS' =>
 357             HiddenInputs($request->getArgs()));
 358         if (ENABLE_EDIT_TOOLBAR and !ENABLE_WYSIWYG and ($template != 'addcomment')) {
 359             include_once 'lib/EditToolbar.php';
 360             $toolbar = new EditToolbar();
 361             $args = array_merge($args, $toolbar->getTokens());
 362         }
 363         return new Template($template, $request, $args);
 364     }
 365
 366     // "2004-12" => "December 2004"
 367     protected function monthTitle($month)
 368     {
 369         if (!$month) $month = strftime("%Y-%m");
 370         //list($year,$mon) = explode("-",$month);
 371         return strftime("%B %Y", strtotime($month . "-01"));
 372     }
 373
 374     // "UserName/Blog/2004-12-13/12:28:50+01:00" => array('month' => "2004-12", ...)
 375     protected function _blog($rev_or_page)
 376     {
 377         $pagename = $rev_or_page->getName();
 378         if (preg_match("/^(.*Blog)\/(\d\d\d\d-\d\d)-(\d\d)\/(.*)/", $pagename, $m))
 379             list(, $prefix, $month, $day, $time) = $m;
 380         return array('pagename' => $pagename,
 381             // page (list pages per month) or revision (list months)?
 382             //'title' => isa($rev_or_page,'WikiDB_PageRevision') ? $rev_or_page->get('summary') : '',
 383             //'monthtitle' => $this->monthTitle($month),
 384             'month' => $month,
 385             'day' => $day,
 386             'time' => $time,
 387             'prefix' => $prefix);
 388     }
 389
 390     protected function nonDefaultArgs($args)
 391     {
 392         return array_diff_assoc($args, $this->getDefaultArguments());
 393     }
 394
 395 }
 396
 397 // Local Variables:
 398 // mode: php
 399 // tab-width: 8
 400 // c-basic-offset: 4
 401 // c-hanging-comment-ender-p: nil
 402 // indent-tabs-mode: nil
 403 // End: