lib/plugin/AuthorHistory.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id$');
   3 /**
   4  Copyright 1999, 2000, 2001, 2002 $ThePhpWikiProgrammingTeam
   5  Copyright 2009 Marc-Etienne Vargenau, Alcatel-Lucent
   6
   7  This file is part of PhpWiki.
   8
   9  PhpWiki is free software; you can redistribute it and/or modify
  10  it under the terms of the GNU General Public License as published by
  11  the Free Software Foundation; either version 2 of the License, or
  12  (at your option) any later version.
  13
  14  PhpWiki is distributed in the hope that it will be useful,
  15  but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  GNU General Public License for more details.
  18
  19  You should have received a copy of the GNU General Public License
  20  along with PhpWiki; if not, write to the Free Software
  21  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22  */
  23
  24 /*
  25  *** EXPERIMENTAL PLUGIN ******************
  26  Needs a lot of work! Use at your own risk.
  27  ******************************************
  28
  29  try this in a page called AuthorHistory:
  30
  31 <?plugin AuthorHistory page=username includeminor=true ?>
  32 ----
  33 <?plugin AuthorHistory page=all ?>
  34
  35
  36  try this in a subpage of your UserName: (UserName/AuthorHistory)
  37
  38 <?plugin AuthorHistory page=all includeminor=true ?>
  39
  40
  41 * Displays a list of revision edits by one particular user, for the
  42 * current page, a specified page, or all pages.
  43
  44 * This is a big hack to create a PageList like table. (PageList
  45 * doesn't support page revisions yet, only pages.)
  46
  47 * Make a new subclass of PageHistory to filter changes of one (or all)
  48 * page(s) by a single author?
  49
  50 */
  51
  52 /*
  53  reference
  54  _PageHistory_PageRevisionIter
  55  WikiDB_PageIterator(&$wikidb, &$pages
  56  WikiDB_PageRevisionIterator(&$wikidb, &$revisions)
  57 */
  58
  59
  60 /**
  61  */
  62 require_once('lib/PageList.php');
  63
  64 //include_once('lib/debug.php');
  65
  66 class WikiPlugin_AuthorHistory
  67 extends WikiPlugin
  68 {
  69     function getName() {
  70         return _("AuthorHistory");
  71     }
  72
  73     function getDescription() {
  74         return sprintf(_("List all page revisions edited by one user with diff links, or show a PageHistory-like list of a single page for only one user."));
  75     }
  76
  77     function getVersion() {
  78         return preg_replace("/[Revision: $]/", '',
  79                             "\$Revision$");
  80     }
  81
  82     function getDefaultArguments() {
  83         global $request;
  84         return array('exclude'      => '',
  85                      'noheader'     => false,
  86                      'includeminor' => false,
  87                      'includedeleted' => false,
  88                      'author'       => $request->_user->UserName(),
  89                      'page'         => '[pagename]',
  90                      'info'         => 'version,minor,author,summary,mtime'
  91                      );
  92     }
  93     // info arg allows multiple columns
  94     // info=mtime,hits,summary,version,author,locked,minor
  95     // exclude arg allows multiple pagenames exclude=HomePage,RecentChanges
  96
  97     function run($dbi, $argstr, &$request, $basepage) {
  98         $this->_args = $this->getArgs($argstr, $request);
  99         extract($this->_args);
 100         //trigger_error("1 p= $page a= $author");
 101         if ($page && $page == 'username') //FIXME: use [username]!!!!!
 102             $page = $author;
 103         //trigger_error("2 p= $page a= $author");
 104         if (!$page || !$author) //user not signed in or no author specified
 105             return '';
 106         //$pagelist = new PageList($info, $exclude);
 107         ///////////////////////////
 108
 109         $nbsp = HTML::raw('&nbsp;');
 110
 111         global $WikiTheme; // date & time formatting
 112
 113         $table = HTML::table(array('class'=> 'pagelist'));
 114         $thead = HTML::thead();
 115         $tbody = HTML::tbody();
 116
 117         if (! ($page == 'all')) {
 118             $p = $dbi->getPage($page);
 119
 120             $thead->pushContent(HTML::tr(HTML::th(array('align'=> 'right'),
 121                                                _("Version")),
 122                                       $includeminor ? HTML::th(_("Minor")) : "",
 123                                       HTML::th(_("Author")),
 124                                       HTML::th(_("Summary")),
 125                                       HTML::th(_("Modified"))
 126                                       ));
 127
 128             $allrevisions_iter = $p->getAllRevisions();
 129             while ($rev = $allrevisions_iter->next()) {
 130
 131                 $isminor = $rev->get('is_minor_edit');
 132                 $authordoesmatch = $author == $rev->get('author');
 133
 134                 if ($authordoesmatch && (!$isminor || ($includeminor && $isminor))) {
 135                     $difflink = Button(array('action' => 'diff',
 136                                              'previous' => 'minor'),
 137                                        $rev->getversion(), $rev);
 138                     $tr = HTML::tr(HTML::td(array('align'=> 'right'),
 139                                             $difflink, $nbsp),
 140                                    $includeminor ? (HTML::td($nbsp, ($isminor ? "minor" : "major"), $nbsp)) : "",
 141                                    HTML::td($nbsp, WikiLink($rev->get('author'),
 142                                                             'if_known'), $nbsp),
 143                                    HTML::td($nbsp, $rev->get('summary')),
 144                                    HTML::td(array('align'=> 'right'),
 145                                             $WikiTheme->formatdatetime($rev->get('mtime')))
 146                                    );
 147
 148                     $class = $isminor ? 'evenrow' : 'oddrow';
 149                     $tr->setAttr('class', $class);
 150                     $tbody->pushContent($tr);
 151                     //$pagelist->addPage($rev->getPage());
 152                 }
 153             }
 154             $captext = fmt($includeminor ? "History of all major and minor edits by %s to page %s."  : "History of all major edits by %s to page %s." ,
 155                            WikiLink($author, 'auto'),
 156                            WikiLink($page, 'auto'));
 157         }
 158         else {
 159
 160             //search all pages for all edits by this author
 161
 162             $thead->pushContent(HTML::tr(HTML::th(_("Page Name")),
 163                                       HTML::th(array('align'=> 'right'),
 164                                                _("Version")),
 165                                       $includeminor ? HTML::th(_("Minor")) : "",
 166                                       HTML::th(_("Summary")),
 167                                       HTML::th(_("Modified"))
 168                                       ));
 169
 170             $allpages_iter = $dbi->getAllPages($includedeleted);
 171             while ($p = $allpages_iter->next()) {
 172
 173                 $allrevisions_iter = $p->getAllRevisions();
 174                 while ($rev = $allrevisions_iter->next()) {
 175                     $isminor = $rev->get('is_minor_edit');
 176                     $authordoesmatch = $author == $rev->get('author');
 177                     if ($authordoesmatch && (!$isminor || ($includeminor && $isminor))) {
 178                         $difflink = Button(array('action' => 'diff',
 179                                                  'previous' => 'minor'),
 180                                            $rev->getversion(), $rev);
 181                         $tr = HTML::tr(
 182                                        HTML::td($nbsp,
 183                                                 ($isminor ? $rev->_pagename : WikiLink($rev->_pagename, 'auto'))
 184                                                 ),
 185                                        HTML::td(array('align'=> 'right'),
 186                                                 $difflink, $nbsp),
 187                                        $includeminor ? (HTML::td($nbsp, ($isminor ? "minor" : "major"), $nbsp)) : "",
 188                                        HTML::td($nbsp, $rev->get('summary')),
 189                                        HTML::td(array('align'=> 'right'),
 190                                                 $WikiTheme->formatdatetime($rev->get('mtime')), $nbsp)
 191                                        );
 192
 193                         $class = $isminor ? 'evenrow' : 'oddrow';
 194                         $tr->setAttr('class', $class);
 195                         $tbody->pushContent($tr);
 196                         //$pagelist->addPage($rev->getPage());
 197                     }
 198                 }
 199             }
 200
 201             $captext = fmt($includeminor ? "History of all major and minor modifications for any page edited by %s."  : "History of major modifications for any page edited by %s." ,
 202                            WikiLink($author, 'auto'));
 203         }
 204
 205         $table->pushContent(HTML::caption($captext));
 206         $table->pushContent($thead, $tbody);
 207
 208         //        if (!$noheader) {
 209         // total minor, major edits. if include minoredits was specified
 210         //        }
 211         return $table;
 212
 213         //        if (!$noheader) {
 214         //            $pagelink = WikiLink($page, 'auto');
 215         //
 216         //            if ($pagelist->isEmpty())
 217         //                return HTML::p(fmt("No pages link to %s.", $pagelink));
 218         //
 219         //            if ($pagelist->getTotal() == 1)
 220         //                $pagelist->setCaption(fmt("One page links to %s:",
 221         //                                          $pagelink));
 222         //            else
 223         //                $pagelist->setCaption(fmt("%s pages link to %s:",
 224         //                                          $pagelist->getTotal(), $pagelink));
 225         //        }
 226         //
 227         //        return $pagelist;
 228     }
 229
 230 };
 231
 232 // For emacs users
 233 // Local Variables:
 234 // mode: php
 235 // tab-width: 8
 236 // c-basic-offset: 4
 237 // c-hanging-comment-ender-p: nil
 238 // indent-tabs-mode: nil
 239 // End:
 240 ?>