includes/SpecialLog.php

   1 <?php
   2 # Copyright (C) 2004 Brion Vibber <brion@pobox.com>
   3 # http://www.mediawiki.org/
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 2 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License along
  16 # with this program; if not, write to the Free Software Foundation, Inc.,
  17 # 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18 # http://www.gnu.org/copyleft/gpl.html
  19
  20 /**
  21  *
  22  * @package MediaWiki
  23  * @subpackage SpecialPage
  24  */
  25
  26 /**
  27  * constructor
  28  */
  29 function wfSpecialLog( $par = '' ) {
  30         global $wgRequest;
  31         $logReader =& new LogReader( $wgRequest );
  32         if( '' == $wgRequest->getVal( 'type' ) && !empty( $par ) ) {
  33                 $logReader->limitType( $par );
  34         }
  35         $logViewer =& new LogViewer( $logReader );
  36         $logViewer->show();
  37 }
  38
  39 /**
  40  *
  41  * @package MediaWiki
  42  * @subpackage SpecialPage
  43  */
  44 class LogReader {
  45         var $db, $joinClauses, $whereClauses;
  46         var $type = '', $user = '', $title = null;
  47
  48         /**
  49          * @param WebRequest $request For internal use use a FauxRequest object to pass arbitrary parameters.
  50          */
  51         function LogReader( $request ) {
  52                 $this->db =& wfGetDB( DB_SLAVE );
  53                 $this->setupQuery( $request );
  54         }
  55
  56         /**
  57          * Basic setup and applies the limiting factors from the WebRequest object.
  58          * @param WebRequest $request
  59          * @private
  60          */
  61         function setupQuery( $request ) {
  62                 $cur = $this->db->tableName( 'cur' );
  63                 $user = $this->db->tableName( 'user' );
  64                 $this->joinClauses = array( "LEFT OUTER JOIN $cur ON log_namespace=cur_namespace AND log_title=cur_title" );
  65                 $this->whereClauses = array( 'user_id=log_user' );
  66
  67                 $this->limitType( $request->getVal( 'type' ) );
  68                 $this->limitUser( $request->getText( 'user' ) );
  69                 $this->limitTitle( $request->getText( 'page' ) );
  70                 $this->limitTime( $request->getVal( 'from' ), '>=' );
  71                 $this->limitTime( $request->getVal( 'until' ), '<=' );
  72
  73                 list( $this->limit, $this->offset ) = $request->getLimitOffset();
  74         }
  75
  76         /**
  77          * Set the log reader to return only entries of the given type.
  78          * @param string $type A log type ('upload', 'delete', etc)
  79          * @private
  80          */
  81         function limitType( $type ) {
  82                 if( empty( $type ) ) {
  83                         return false;
  84                 }
  85                 $this->type = $type;
  86                 $safetype = $this->db->strencode( $type );
  87                 $this->whereClauses[] = "log_type='$safetype'";
  88         }
  89
  90         /**
  91          * Set the log reader to return only entries by the given user.
  92          * @param string $name Valid user name
  93          * @private
  94          */
  95         function limitUser( $name ) {
  96                 $title = Title::makeTitle( NS_USER, $name );
  97                 if( empty( $name ) || is_null( $title ) ) {
  98                         return false;
  99                 }
 100                 $this->user = str_replace( '_', ' ', $title->getDBkey() );
 101                 $safename = $this->db->strencode( $this->user );
 102                 $user = $this->db->tableName( 'user' );
 103                 $this->whereClauses[] = "user_name='$safename'";
 104         }
 105
 106         /**
 107          * Set the log reader to return only entries affecting the given page.
 108          * (For the block and rights logs, this is a user page.)
 109          * @param string $page Title name as text
 110          * @private
 111          */
 112         function limitTitle( $page ) {
 113                 $title = Title::newFromText( $page );
 114                 if( empty( $page ) || is_null( $title )  ) {
 115                         return false;
 116                 }
 117                 $this->title =& $title;
 118                 $safetitle = $this->db->strencode( $title->getDBkey() );
 119                 $ns = $title->getNamespace();
 120                 $this->whereClauses[] = "log_namespace=$ns AND log_title='$safetitle'";
 121         }
 122
 123         /**
 124          * Set the log reader to return only entries in a given time range.
 125          * @param string $time Timestamp of one endpoint
 126          * @param string $direction either ">=" or "<=" operators
 127          * @private
 128          */
 129         function limitTime( $time, $direction ) {
 130                 # Direction should be a comparison operator
 131                 if( empty( $time ) ) {
 132                         return false;
 133                 }
 134                 $safetime = $this->db->strencode( wfTimestamp( TS_MW, $time ) );
 135                 $this->whereClauses[] = "log_timestamp $direction '$safetime'";
 136         }
 137
 138         /**
 139          * Build an SQL query from all the set parameters.
 140          * @return string the SQL query
 141          * @private
 142          */
 143         function getQuery() {
 144                 $logging = $this->db->tableName( "logging" );
 145                 $user = $this->db->tableName( 'user' );
 146                 $sql = "SELECT log_type, log_action, log_timestamp,
 147                         log_user, user_name,
 148                         log_namespace, log_title, cur_id,
 149                         log_comment FROM $user, $logging ";
 150                 if( !empty( $this->joinClauses ) ) {
 151                         $sql .= implode( ',', $this->joinClauses );
 152                 }
 153                 if( !empty( $this->whereClauses ) ) {
 154                         $sql .= " WHERE " . implode( ' AND ', $this->whereClauses );
 155                 }
 156                 $sql .= " ORDER BY log_timestamp DESC ";
 157                 $sql .= $this->db->limitResult( $this->limit, $this->offset );
 158                 return $sql;
 159         }
 160
 161         /**
 162          * Execute the query and start returning results.
 163          * @return ResultWrapper result object to return the relevant rows
 164          */
 165         function getRows() {
 166                 return $this->db->resultObject( $this->db->query( $this->getQuery() ) );
 167         }
 168
 169         /**
 170          * @return string The query type that this LogReader has been limited to.
 171          */
 172         function queryType() {
 173                 return $this->type;
 174         }
 175
 176         /**
 177          * @return string The username type that this LogReader has been limited to, if any.
 178          */
 179         function queryUser() {
 180                 return $this->user;
 181         }
 182
 183         /**
 184          * @return string The text of the title that this LogReader has been limited to.
 185          */
 186         function queryTitle() {
 187                 if( is_null( $this->title ) ) {
 188                         return '';
 189                 } else {
 190                         return $this->title->getPrefixedText();
 191                 }
 192         }
 193 }
 194
 195 /**
 196  *
 197  * @package MediaWiki
 198  * @subpackage SpecialPage
 199  */
 200 class LogViewer {
 201         /**
 202          * @var LogReader $reader
 203          */
 204         var $reader;
 205
 206         /**
 207          * @param LogReader &$reader where to get our data from
 208          */
 209         function LogViewer( &$reader ) {
 210                 global $wgUser;
 211                 $this->skin =& $wgUser->getSkin();
 212                 $this->reader =& $reader;
 213         }
 214
 215         /**
 216          * Take over the whole output page in $wgOut with the log display.
 217          */
 218         function show() {
 219                 global $wgOut;
 220                 $this->showHeader( $wgOut );
 221                 $this->showOptions( $wgOut );
 222                 $this->showPrevNext( $wgOut );
 223                 $this->showList( $wgOut );
 224                 $this->showPrevNext( $wgOut );
 225         }
 226
 227         /**
 228          * Output just the list of entries given by the linked LogReader,
 229          * with extraneous UI elements. Use for displaying log fragments in
 230          * another page (eg at Special:Undelete)
 231          * @param OutputPage $out where to send output
 232          */
 233         function showList( &$out ) {
 234                 $html = "";
 235                 $result = $this->reader->getRows();
 236                 while( $s = $result->fetchObject() ) {
 237                         $html .= $this->logLine( $s );
 238                 }
 239                 $result->free();
 240                 $out->addHTML( $html );
 241         }
 242
 243         /**
 244          * @param Object $s a single row from the result set
 245          * @return string Formatted HTML list item
 246          * @private
 247          */
 248         function logLine( $s ) {
 249                 global $wgLang;
 250                 $title = Title::makeTitle( $s->log_namespace, $s->log_title );
 251                 $user = Title::makeTitleSafe( NS_USER, $s->user_name );
 252                 $time = $wgLang->timeanddate( $s->log_timestamp );
 253                 if( $s->cur_id ) {
 254                         $titleLink = $this->skin->makeKnownLinkObj( $title );
 255                 } else {
 256                         $titleLink = $this->skin->makeBrokenLinkObj( $title );
 257                 }
 258                 $userLink = $this->skin->makeLinkObj( $user, htmlspecialchars( $s->user_name ) );
 259                 if( '' === $s->log_comment ) {
 260                         $comment = '';
 261                 } else {
 262                         $comment = '(<em>' . $this->skin->formatComment( $s->log_comment ) . '</em>)';
 263                 }
 264
 265                 $action = LogPage::actionText( $s->log_type, $s->log_action, $titleLink );
 266                 $out = "<li>$time $userLink $action $comment</li>\n";
 267                 return $out;
 268         }
 269
 270         /**
 271          * @param OutputPage &$out where to send output
 272          * @private
 273          */
 274         function showHeader( &$out ) {
 275                 $type = $this->reader->queryType();
 276                 if( LogPage::isLogType( $type ) ) {
 277                         $out->setPageTitle( LogPage::logName( $type ) );
 278                         $out->addWikiText( LogPage::logHeader( $type ) );
 279                 }
 280         }
 281
 282         /**
 283          * @param OutputPage &$out where to send output
 284          * @private
 285          */
 286         function showOptions( &$out ) {
 287                 global $wgScript;
 288                 $action = htmlspecialchars( $wgScript );
 289                 $title = Title::makeTitle( NS_SPECIAL, 'Log' );
 290                 $special = htmlspecialchars( $title->getPrefixedDBkey() );
 291                 $out->addHTML( "<form action=\"$action\" method=\"get\">\n" .
 292                         "<input type='hidden' name='title' value=\"$special\" />\n" .
 293                         $this->getTypeMenu() .
 294                         $this->getUserInput() .
 295                         $this->getTitleInput() .
 296                         "<input type='submit' />" .
 297                         "</form>" );
 298         }
 299
 300         /**
 301          * @return string Formatted HTML
 302          * @private
 303          */
 304         function getTypeMenu() {
 305                 $out = "<select name='type'>\n";
 306                 foreach( LogPage::validTypes() as $type ) {
 307                         $text = htmlspecialchars( LogPage::logName( $type ) );
 308                         $selected = ($type == $this->reader->queryType()) ? ' selected="selected"' : '';
 309                         $out .= "<option value=\"$type\"$selected>$text</option>\n";
 310                 }
 311                 $out .= "</select>\n";
 312                 return $out;
 313         }
 314
 315         /**
 316          * @return string Formatted HTML
 317          * @private
 318          */
 319         function getUserInput() {
 320                 $user = htmlspecialchars( $this->reader->queryUser() );
 321                 return "User: <input type='text' name='user' size='12' value=\"$user\" />\n";
 322         }
 323
 324         /**
 325          * @return string Formatted HTML
 326          * @private
 327          */
 328         function getTitleInput() {
 329                 $title = htmlspecialchars( $this->reader->queryTitle() );
 330                 return "Title: <input type='text' name='page' size='20' value=\"$title\" />\n";
 331         }
 332
 333         /**
 334          * @param OutputPage &$out where to send output
 335          * @private
 336          */
 337         function showPrevNext( &$out ) {
 338                 global $wgContLang;
 339                 $pieces = array();
 340                 $pieces[] = 'type=' . htmlspecialchars( $this->reader->queryType() );
 341                 $pieces[] = 'user=' . htmlspecialchars( $this->reader->queryUser() );
 342                 $pieces[] = 'page=' . htmlspecialchars( $this->reader->queryTitle() );
 343                 $bits = implode( '&', $pieces );
 344                 $offset = 0; $limit = 50;
 345
 346                 # TODO: use timestamps instead of offsets to make it more natural
 347                 # to go huge distances in time
 348                 $html = wfViewPrevNext( $offset, $limit,
 349                         $wgContLang->specialpage( 'Log' ),
 350                         $bits,
 351                         false);
 352                 $out->addHTML( '<p>' . $html . '</p>' );
 353         }
 354 }
 355
 356
 357 ?>