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                 $page = $this->db->tableName( 'page' );
  63                 $user = $this->db->tableName( 'user' );
  64                 $this->joinClauses = array( "LEFT OUTER JOIN $page ON log_namespace=page_namespace AND log_title=page_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, page_id,
 149                         log_comment, log_params 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         var $numResults = 0;
 206
 207         /**
 208          * @param LogReader &$reader where to get our data from
 209          */
 210         function LogViewer( &$reader ) {
 211                 global $wgUser;
 212                 $this->skin =& $wgUser->getSkin();
 213                 $this->reader =& $reader;
 214         }
 215
 216         /**
 217          * Take over the whole output page in $wgOut with the log display.
 218          */
 219         function show() {
 220                 global $wgOut;
 221                 $this->showHeader( $wgOut );
 222                 $this->showOptions( $wgOut );
 223                 $result = $this->getLogRows();
 224                 $this->showPrevNext( $wgOut );
 225                 $this->showList( $wgOut, $result );
 226                 $this->showPrevNext( $wgOut );
 227         }
 228
 229         /**
 230          * Load the data from the linked LogReader
 231          * Preload the link cache
 232          * Initialise numResults
 233          *
 234          * Must be called before calling showPrevNext
 235          *
 236          * @return object database result set
 237          */
 238         function getLogRows() {
 239                 global $wgLinkCache;
 240                 $result = $this->reader->getRows();
 241                 $this->numResults = 0;
 242
 243                 // Fetch results and form a batch link existence query
 244                 $batch = new LinkBatch;
 245                 while ( $s = $result->fetchObject() ) {
 246                         // User link
 247                         $title = Title::makeTitleSafe( NS_USER, $s->user_name );
 248                         $batch->addObj( $title );
 249
 250                         // Move destination link
 251                         if ( $s->log_type == 'move' ) {
 252                                 $paramArray = LogPage::extractParams( $s->log_params );
 253                                 $title = Title::newFromText( $paramArray[0] );
 254                                 $batch->addObj( $title );
 255                         }
 256                         $this->numResults++;
 257                 }
 258                 $batch->execute( $wgLinkCache );
 259
 260                 return $result;
 261         }
 262
 263
 264         /**
 265          * Output just the list of entries given by the linked LogReader,
 266          * with extraneous UI elements. Use for displaying log fragments in
 267          * another page (eg at Special:Undelete)
 268          * @param OutputPage $out where to send output
 269          */
 270         function showList( &$out, $result ) {
 271                 // Rewind result pointer and go through it again, making the HTML
 272                 $html='';
 273                 if ($this->numResults > 0) {
 274                         $html = "\n<ul>\n";
 275                         $result->seek( 0 );
 276                         while( $s = $result->fetchObject() ) {
 277                                 $html .= $this->logLine( $s );
 278                         }
 279                         $html .= "\n</ul>\n";
 280                 }
 281                 $result->free();
 282                 $out->addHTML( $html );
 283         }
 284
 285         /**
 286          * @param Object $s a single row from the result set
 287          * @return string Formatted HTML list item
 288          * @private
 289          */
 290         function logLine( $s ) {
 291                 global $wgLang, $wgLinkCache;
 292                 $title = Title::makeTitle( $s->log_namespace, $s->log_title );
 293                 $user = Title::makeTitleSafe( NS_USER, $s->user_name );
 294                 $time = $wgLang->timeanddate( $s->log_timestamp, true );
 295
 296                 // Enter the existence or non-existence of this page into the link cache,
 297                 // for faster makeLinkObj() in LogPage::actionText()
 298                 if( $s->page_id ) {
 299                         $wgLinkCache->addGoodLink( $s->page_id, $title->getPrefixedText() );
 300                 } else {
 301                         $wgLinkCache->addBadLink( $title->getPrefixedText() );
 302                 }
 303
 304                 $userLink = $this->skin->makeLinkObj( $user, htmlspecialchars( $s->user_name ) );
 305                 $comment = $this->skin->commentBlock( $s->log_comment );
 306                 $paramArray = LogPage::extractParams( $s->log_params );
 307                 $revert = '';
 308                 if ( $s->log_type == 'move' && isset( $paramArray[0] ) ) {
 309                         $specialTitle = Title::makeTitle( NS_SPECIAL, 'Movepage' );
 310                         $destTitle = Title::newFromText( $paramArray[0] );
 311                         if ( $destTitle ) {
 312                                 $revert = '(' . $this->skin->makeKnownLinkObj( $specialTitle, wfMsg( 'revertmove' ),
 313                                         'wpOldTitle=' . urlencode( $destTitle->getPrefixedDBkey() ) .
 314                                         '&wpNewTitle=' . urlencode( $title->getPrefixedDBkey() ) .
 315                                         '&wpReason=' . urlencode( wfMsgForContent( 'revertmove' ) ) .
 316                                         '&wpMovetalk=0' ) . ')';
 317                         }
 318                 }
 319
 320                 $action = LogPage::actionText( $s->log_type, $s->log_action, $title, $this->skin, $paramArray, true );
 321                 $out = "<li>$time $userLink $action $comment $revert</li>\n";
 322                 return $out;
 323         }
 324
 325         /**
 326          * @param OutputPage &$out where to send output
 327          * @private
 328          */
 329         function showHeader( &$out ) {
 330                 $type = $this->reader->queryType();
 331                 if( LogPage::isLogType( $type ) ) {
 332                         $out->setPageTitle( LogPage::logName( $type ) );
 333                         $out->addWikiText( LogPage::logHeader( $type ) );
 334                 }
 335         }
 336
 337         /**
 338          * @param OutputPage &$out where to send output
 339          * @private
 340          */
 341         function showOptions( &$out ) {
 342                 global $wgScript;
 343                 $action = htmlspecialchars( $wgScript );
 344                 $title = Title::makeTitle( NS_SPECIAL, 'Log' );
 345                 $special = htmlspecialchars( $title->getPrefixedDBkey() );
 346                 $out->addHTML( "<form action=\"$action\" method=\"get\">\n" .
 347                         "<input type='hidden' name='title' value=\"$special\" />\n" .
 348                         $this->getTypeMenu() .
 349                         $this->getUserInput() .
 350                         $this->getTitleInput() .
 351                         "<input type='submit' value=\"" . wfMsg( 'querybtn' ) . "\" />" .
 352                         "</form>" );
 353         }
 354
 355         /**
 356          * @return string Formatted HTML
 357          * @private
 358          */
 359         function getTypeMenu() {
 360                 $out = "<select name='type'>\n";
 361                 foreach( LogPage::validTypes() as $type ) {
 362                         $text = htmlspecialchars( LogPage::logName( $type ) );
 363                         $selected = ($type == $this->reader->queryType()) ? ' selected="selected"' : '';
 364                         $out .= "<option value=\"$type\"$selected>$text</option>\n";
 365                 }
 366                 $out .= "</select>\n";
 367                 return $out;
 368         }
 369
 370         /**
 371          * @return string Formatted HTML
 372          * @private
 373          */
 374         function getUserInput() {
 375                 $user = htmlspecialchars( $this->reader->queryUser() );
 376                 return wfMsg('specialloguserlabel') . "<input type='text' name='user' size='12' value=\"$user\" />\n";
 377         }
 378
 379         /**
 380          * @return string Formatted HTML
 381          * @private
 382          */
 383         function getTitleInput() {
 384                 $title = htmlspecialchars( $this->reader->queryTitle() );
 385                 return wfMsg('speciallogtitlelabel') . "<input type='text' name='page' size='20' value=\"$title\" />\n";
 386         }
 387
 388         /**
 389          * @param OutputPage &$out where to send output
 390          * @private
 391          */
 392         function showPrevNext( &$out ) {
 393                 global $wgContLang,$wgRequest;
 394                 $pieces = array();
 395                 $pieces[] = 'type=' . htmlspecialchars( $this->reader->queryType() );
 396                 $pieces[] = 'user=' . htmlspecialchars( $this->reader->queryUser() );
 397                 $pieces[] = 'page=' . htmlspecialchars( $this->reader->queryTitle() );
 398                 $bits = implode( '&', $pieces );
 399                 list( $limit, $offset ) = $wgRequest->getLimitOffset();
 400
 401                 # TODO: use timestamps instead of offsets to make it more natural
 402                 # to go huge distances in time
 403                 $html = wfViewPrevNext( $offset, $limit,
 404                         $wgContLang->specialpage( 'Log' ),
 405                         $bits,
 406                         $this->numResults < $limit);
 407                 $out->addHTML( '<p>' . $html . '</p>' );
 408         }
 409 }
 410
 411
 412 ?>