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 require_once('lib/PageList.php');
  60
  61 class WikiPlugin_AuthorHistory
  62 extends WikiPlugin
  63 {
  64     function getName() {
  65         return _("AuthorHistory");
  66     }
  67
  68     function getDescription() {
  69         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."));
  70     }
  71
  72     function getDefaultArguments() {
  73         global $request;
  74         return array('exclude'      => '',
  75                      'noheader'     => false,
  76                      'includeminor' => false,
  77                      'includedeleted' => false,
  78                      'author'       => $request->_user->UserName(),
  79                      'page'         => '[pagename]',
  80                      'info'         => 'version,minor,author,summary,mtime'
  81                      );
  82     }
  83     // info arg allows multiple columns
  84     // info=mtime,hits,summary,version,author,locked,minor
  85     // exclude arg allows multiple pagenames exclude=HomePage,RecentChanges
  86
  87     function run($dbi, $argstr, &$request, $basepage) {
  88         $this->_args = $this->getArgs($argstr, $request);
  89         extract($this->_args);
  90         //trigger_error("1 p= $page a= $author");
  91         if ($page && $page == 'username') //FIXME: use [username]!!!!!
  92             $page = $author;
  93         //trigger_error("2 p= $page a= $author");
  94         if (!$page || !$author) //user not signed in or no author specified
  95             return '';
  96         //$pagelist = new PageList($info, $exclude);
  97         ///////////////////////////
  98
  99         $nbsp = HTML::raw('&nbsp;');
 100
 101         global $WikiTheme; // date & time formatting
 102
 103         $table = HTML::table(array('class'=> 'pagelist'));
 104         $thead = HTML::thead();
 105         $tbody = HTML::tbody();
 106
 107         if (! ($page == 'all')) {
 108             $p = $dbi->getPage($page);
 109
 110             $thead->pushContent(HTML::tr(HTML::th(array('align'=> 'right'),
 111                                                _("Version")),
 112                                       $includeminor ? HTML::th(_("Minor")) : "",
 113                                       HTML::th(_("Author")),
 114                                       HTML::th(_("Summary")),
 115                                       HTML::th(_("Modified"))
 116                                       ));
 117
 118             $allrevisions_iter = $p->getAllRevisions();
 119             while ($rev = $allrevisions_iter->next()) {
 120
 121                 $isminor = $rev->get('is_minor_edit');
 122                 $authordoesmatch = $author == $rev->get('author');
 123
 124                 if ($authordoesmatch && (!$isminor || ($includeminor && $isminor))) {
 125                     $difflink = Button(array('action' => 'diff',
 126                                              'previous' => 'minor'),
 127                                        $rev->getversion(), $rev);
 128                     $tr = HTML::tr(HTML::td(array('align'=> 'right'),
 129                                             $difflink, $nbsp),
 130                                    $includeminor ? (HTML::td($nbsp, ($isminor ? "minor" : "major"), $nbsp)) : "",
 131                                    HTML::td($nbsp, WikiLink($rev->get('author'),
 132                                                             'if_known'), $nbsp),
 133                                    HTML::td($nbsp, $rev->get('summary')),
 134                                    HTML::td(array('align'=> 'right'),
 135                                             $WikiTheme->formatdatetime($rev->get('mtime')))
 136                                    );
 137
 138                     $class = $isminor ? 'evenrow' : 'oddrow';
 139                     $tr->setAttr('class', $class);
 140                     $tbody->pushContent($tr);
 141                     //$pagelist->addPage($rev->getPage());
 142                 }
 143             }
 144             $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." ,
 145                            WikiLink($author, 'auto'),
 146                            WikiLink($page, 'auto'));
 147         }
 148         else {
 149
 150             //search all pages for all edits by this author
 151
 152             $thead->pushContent(HTML::tr(HTML::th(_("Page Name")),
 153                                       HTML::th(array('align'=> 'right'),
 154                                                _("Version")),
 155                                       $includeminor ? HTML::th(_("Minor")) : "",
 156                                       HTML::th(_("Summary")),
 157                                       HTML::th(_("Modified"))
 158                                       ));
 159
 160             $allpages_iter = $dbi->getAllPages($includedeleted);
 161             while ($p = $allpages_iter->next()) {
 162
 163                 $allrevisions_iter = $p->getAllRevisions();
 164                 while ($rev = $allrevisions_iter->next()) {
 165                     $isminor = $rev->get('is_minor_edit');
 166                     $authordoesmatch = $author == $rev->get('author');
 167                     if ($authordoesmatch && (!$isminor || ($includeminor && $isminor))) {
 168                         $difflink = Button(array('action' => 'diff',
 169                                                  'previous' => 'minor'),
 170                                            $rev->getversion(), $rev);
 171                         $tr = HTML::tr(
 172                                        HTML::td($nbsp,
 173                                                 ($isminor ? $rev->_pagename : WikiLink($rev->_pagename, 'auto'))
 174                                                 ),
 175                                        HTML::td(array('align'=> 'right'),
 176                                                 $difflink, $nbsp),
 177                                        $includeminor ? (HTML::td($nbsp, ($isminor ? "minor" : "major"), $nbsp)) : "",
 178                                        HTML::td($nbsp, $rev->get('summary')),
 179                                        HTML::td(array('align'=> 'right'),
 180                                                 $WikiTheme->formatdatetime($rev->get('mtime')), $nbsp)
 181                                        );
 182
 183                         $class = $isminor ? 'evenrow' : 'oddrow';
 184                         $tr->setAttr('class', $class);
 185                         $tbody->pushContent($tr);
 186                         //$pagelist->addPage($rev->getPage());
 187                     }
 188                 }
 189             }
 190
 191             $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." ,
 192                            WikiLink($author, 'auto'));
 193         }
 194
 195         $table->pushContent(HTML::caption($captext));
 196         $table->pushContent($thead, $tbody);
 197
 198         //        if (!$noheader) {
 199         // total minor, major edits. if include minoredits was specified
 200         //        }
 201         return $table;
 202
 203         //        if (!$noheader) {
 204         //            $pagelink = WikiLink($page, 'auto');
 205         //
 206         //            if ($pagelist->isEmpty())
 207         //                return HTML::p(fmt("No pages link to %s.", $pagelink));
 208         //
 209         //            if ($pagelist->getTotal() == 1)
 210         //                $pagelist->setCaption(fmt("One page links to %s:",
 211         //                                          $pagelink));
 212         //            else
 213         //                $pagelist->setCaption(fmt("%s pages link to %s:",
 214         //                                          $pagelist->getTotal(), $pagelink));
 215         //        }
 216         //
 217         //        return $pagelist;
 218     }
 219
 220 };
 221
 222 // For emacs users
 223 // Local Variables:
 224 // mode: php
 225 // tab-width: 8
 226 // c-basic-offset: 4
 227 // c-hanging-comment-ender-p: nil
 228 // indent-tabs-mode: nil
 229 // End:
 230 ?>