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 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18 # http://www.gnu.org/copyleft/gpl.html
  19
  20 /**
  21  *
  22  * @addtogroup SpecialPage
  23  */
  24
  25 /**
  26  * constructor
  27  */
  28 function wfSpecialLog( $par = '' ) {
  29         global $wgRequest;
  30         $logReader = new LogReader( $wgRequest );
  31         if( $wgRequest->getVal( 'type' ) == '' && $par != '' ) {
  32                 $logReader->limitType( $par );
  33         }
  34         $logViewer = new LogViewer( $logReader );
  35         $logViewer->show();
  36 }
  37
  38 /**
  39  *
  40  * @addtogroup SpecialPage
  41  */
  42 class LogReader {
  43         var $db, $joinClauses, $whereClauses;
  44         var $type = '', $user = '', $title = null;
  45
  46         /**
  47          * @param WebRequest $request For internal use use a FauxRequest object to pass arbitrary parameters.
  48          */
  49         function LogReader( $request ) {
  50                 $this->db = wfGetDB( DB_SLAVE );
  51                 $this->setupQuery( $request );
  52         }
  53
  54         /**
  55          * Basic setup and applies the limiting factors from the WebRequest object.
  56          * @param WebRequest $request
  57          * @private
  58          */
  59         function setupQuery( $request ) {
  60                 $page = $this->db->tableName( 'page' );
  61                 $user = $this->db->tableName( 'user' );
  62                 $this->joinClauses = array(
  63                         "LEFT OUTER JOIN $page ON log_namespace=page_namespace AND log_title=page_title",
  64                         "INNER JOIN $user ON user_id=log_user" );
  65                 $this->whereClauses = array();
  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 (In)valid user name
  93          * @private
  94          */
  95         function limitUser( $name ) {
  96                 if ( $name == '' )
  97                         return false;
  98                 $usertitle = Title::makeTitleSafe( NS_USER, $name );
  99                 if ( is_null( $usertitle ) )
 100                         return false;
 101                 $this->user = $usertitle->getText();
 102
 103                 /* Fetch userid at first, if known, provides awesome query plan afterwards */
 104                 $userid = $this->db->selectField('user','user_id',array('user_name'=>$this->user));
 105                 if (!$userid)
 106                         /* It should be nicer to abort query at all,
 107                            but for now it won't pass anywhere behind the optimizer */
 108                         $this->whereClauses[] = "NULL";
 109                 else
 110                         $this->whereClauses[] = "log_user=$userid";
 111         }
 112
 113         /**
 114          * Set the log reader to return only entries affecting the given page.
 115          * (For the block and rights logs, this is a user page.)
 116          * @param string $page Title name as text
 117          * @private
 118          */
 119         function limitTitle( $page ) {
 120                 $title = Title::newFromText( $page );
 121                 if( empty( $page ) || is_null( $title )  ) {
 122                         return false;
 123                 }
 124                 $this->title =& $title;
 125                 $safetitle = $this->db->strencode( $title->getDBkey() );
 126                 $ns = $title->getNamespace();
 127                 $this->whereClauses[] = "log_namespace=$ns AND log_title='$safetitle'";
 128         }
 129
 130         /**
 131          * Set the log reader to return only entries in a given time range.
 132          * @param string $time Timestamp of one endpoint
 133          * @param string $direction either ">=" or "<=" operators
 134          * @private
 135          */
 136         function limitTime( $time, $direction ) {
 137                 # Direction should be a comparison operator
 138                 if( empty( $time ) ) {
 139                         return false;
 140                 }
 141                 $safetime = $this->db->strencode( wfTimestamp( TS_MW, $time ) );
 142                 $this->whereClauses[] = "log_timestamp $direction '$safetime'";
 143         }
 144
 145         /**
 146          * Build an SQL query from all the set parameters.
 147          * @return string the SQL query
 148          * @private
 149          */
 150         function getQuery() {
 151                 $logging = $this->db->tableName( "logging" );
 152                 $sql = "SELECT /*! STRAIGHT_JOIN */ log_type, log_action, log_timestamp,
 153                         log_user, user_name,
 154                         log_namespace, log_title, page_id,
 155                         log_comment, log_params FROM $logging ";
 156                 if( !empty( $this->joinClauses ) ) {
 157                         $sql .= implode( ' ', $this->joinClauses );
 158                 }
 159                 if( !empty( $this->whereClauses ) ) {
 160                         $sql .= " WHERE " . implode( ' AND ', $this->whereClauses );
 161                 }
 162                 $sql .= " ORDER BY log_timestamp DESC ";
 163                 $sql = $this->db->limitResult($sql, $this->limit, $this->offset );
 164                 return $sql;
 165         }
 166
 167         /**
 168          * Execute the query and start returning results.
 169          * @return ResultWrapper result object to return the relevant rows
 170          */
 171         function getRows() {
 172                 $res = $this->db->query( $this->getQuery(), 'LogReader::getRows' );
 173                 return $this->db->resultObject( $res );
 174         }
 175
 176         /**
 177          * @return string The query type that this LogReader has been limited to.
 178          */
 179         function queryType() {
 180                 return $this->type;
 181         }
 182
 183         /**
 184          * @return string The username type that this LogReader has been limited to, if any.
 185          */
 186         function queryUser() {
 187                 return $this->user;
 188         }
 189
 190         /**
 191          * @return string The text of the title that this LogReader has been limited to.
 192          */
 193         function queryTitle() {
 194                 if( is_null( $this->title ) ) {
 195                         return '';
 196                 } else {
 197                         return $this->title->getPrefixedText();
 198                 }
 199         }
 200 }
 201
 202 /**
 203  *
 204  * @addtogroup SpecialPage
 205  */
 206 class LogViewer {
 207         /**
 208          * @var LogReader $reader
 209          */
 210         var $reader;
 211         var $numResults = 0;
 212
 213         /**
 214          * @param LogReader &$reader where to get our data from
 215          */
 216         function LogViewer( &$reader ) {
 217                 global $wgUser;
 218                 $this->skin = $wgUser->getSkin();
 219                 $this->reader =& $reader;
 220         }
 221
 222         /**
 223          * Take over the whole output page in $wgOut with the log display.
 224          */
 225         function show() {
 226                 global $wgOut;
 227                 $this->showHeader( $wgOut );
 228                 $this->showOptions( $wgOut );
 229                 $result = $this->getLogRows();
 230                 $this->showPrevNext( $wgOut );
 231                 $this->doShowList( $wgOut, $result );
 232                 $this->showPrevNext( $wgOut );
 233         }
 234
 235         /**
 236          * Load the data from the linked LogReader
 237          * Preload the link cache
 238          * Initialise numResults
 239          *
 240          * Must be called before calling showPrevNext
 241          *
 242          * @return object database result set
 243          */
 244         function getLogRows() {
 245                 $result = $this->reader->getRows();
 246                 $this->numResults = 0;
 247
 248                 // Fetch results and form a batch link existence query
 249                 $batch = new LinkBatch;
 250                 while ( $s = $result->fetchObject() ) {
 251                         // User link
 252                         $batch->addObj( Title::makeTitleSafe( NS_USER, $s->user_name ) );
 253                         $batch->addObj( Title::makeTitleSafe( NS_USER_TALK, $s->user_name ) );
 254
 255                         // Move destination link
 256                         if ( $s->log_type == 'move' ) {
 257                                 $paramArray = LogPage::extractParams( $s->log_params );
 258                                 $title = Title::newFromText( $paramArray[0] );
 259                                 $batch->addObj( $title );
 260                         }
 261                         ++$this->numResults;
 262                 }
 263                 $batch->execute();
 264
 265                 return $result;
 266         }
 267
 268
 269         /**
 270          * Output just the list of entries given by the linked LogReader,
 271          * with extraneous UI elements. Use for displaying log fragments in
 272          * another page (eg at Special:Undelete)
 273          * @param OutputPage $out where to send output
 274          */
 275         function showList( &$out ) {
 276                 $this->doShowList( $out, $this->getLogRows() );
 277         }
 278
 279         function doShowList( &$out, $result ) {
 280                 // Rewind result pointer and go through it again, making the HTML
 281                 if ($this->numResults > 0) {
 282                         $html = "\n<ul>\n";
 283                         $result->seek( 0 );
 284                         while( $s = $result->fetchObject() ) {
 285                                 $html .= $this->logLine( $s );
 286                         }
 287                         $html .= "\n</ul>\n";
 288                         $out->addHTML( $html );
 289                 } else {
 290                         $out->addWikiText( wfMsg( 'logempty' ) );
 291                 }
 292                 $result->free();
 293         }
 294
 295         /**
 296          * @param Object $s a single row from the result set
 297          * @return string Formatted HTML list item
 298          * @private
 299          */
 300         function logLine( $s ) {
 301                 global $wgLang;
 302                 $title = Title::makeTitle( $s->log_namespace, $s->log_title );
 303                 $time = $wgLang->timeanddate( wfTimestamp(TS_MW, $s->log_timestamp), true );
 304
 305                 // Enter the existence or non-existence of this page into the link cache,
 306                 // for faster makeLinkObj() in LogPage::actionText()
 307                 $linkCache =& LinkCache::singleton();
 308                 if( $s->page_id ) {
 309                         $linkCache->addGoodLinkObj( $s->page_id, $title );
 310                 } else {
 311                         $linkCache->addBadLinkObj( $title );
 312                 }
 313
 314                 $userLink = $this->skin->userLink( $s->log_user, $s->user_name ) . $this->skin->userToolLinksRedContribs( $s->log_user, $s->user_name );
 315                 $comment = $this->skin->commentBlock( $s->log_comment );
 316                 $paramArray = LogPage::extractParams( $s->log_params );
 317                 $revert = '';
 318                 if ( $s->log_type == 'move' && isset( $paramArray[0] ) ) {
 319                         $specialTitle = SpecialPage::getTitleFor( 'Movepage' );
 320                         $destTitle = Title::newFromText( $paramArray[0] );
 321                         if ( $destTitle ) {
 322                                 $revert = '(' . $this->skin->makeKnownLinkObj( $specialTitle, wfMsg( 'revertmove' ),
 323                                         'wpOldTitle=' . urlencode( $destTitle->getPrefixedDBkey() ) .
 324                                         '&wpNewTitle=' . urlencode( $title->getPrefixedDBkey() ) .
 325                                         '&wpReason=' . urlencode( wfMsgForContent( 'revertmove' ) ) .
 326                                         '&wpMovetalk=0' ) . ')';
 327                         }
 328                 }
 329
 330                 $action = LogPage::actionText( $s->log_type, $s->log_action, $title, $this->skin, $paramArray, true, true );
 331                 $out = "<li>$time $userLink $action $comment $revert</li>\n";
 332                 return $out;
 333         }
 334
 335         /**
 336          * @param OutputPage &$out where to send output
 337          * @private
 338          */
 339         function showHeader( &$out ) {
 340                 $type = $this->reader->queryType();
 341                 if( LogPage::isLogType( $type ) ) {
 342                         $out->setPageTitle( LogPage::logName( $type ) );
 343                         $out->addWikiText( LogPage::logHeader( $type ) );
 344                 }
 345         }
 346
 347         /**
 348          * @param OutputPage &$out where to send output
 349          * @private
 350          */
 351         function showOptions( &$out ) {
 352                 global $wgScript;
 353                 $action = htmlspecialchars( $wgScript );
 354                 $title = SpecialPage::getTitleFor( 'Log' );
 355                 $special = htmlspecialchars( $title->getPrefixedDBkey() );
 356                 $out->addHTML( "<form action=\"$action\" method=\"get\">\n" .
 357                         Xml::hidden( 'title', $special ) . "\n" .
 358                         $this->getTypeMenu() . "\n" .
 359                         $this->getUserInput() . "\n" .
 360                         $this->getTitleInput() . "\n" .
 361                         Xml::submitButton( wfMsg( 'allpagessubmit' ) ) . "\n" .
 362                         "</form>" );
 363         }
 364
 365         /**
 366          * @return string Formatted HTML
 367          * @private
 368          */
 369         function getTypeMenu() {
 370                 $out = "<select name='type'>\n";
 371
 372                 $validTypes = LogPage::validTypes();
 373                 $m = array(); // Temporary array
 374
 375                 // First pass to load the log names
 376                 foreach( $validTypes as $type ) {
 377                         $text = LogPage::logName( $type );
 378                         $m[$text] = $type;
 379                 }
 380
 381                 // Second pass to sort by name
 382                 ksort($m);
 383
 384                 // Third pass generates sorted XHTML content
 385                 foreach( $m as $text => $type ) {
 386                         $selected = ($type == $this->reader->queryType());
 387                         $out .= Xml::option( $text, $type, $selected ) . "\n";
 388                 }
 389
 390                 $out .= '</select>';
 391                 return $out;
 392         }
 393
 394         /**
 395          * @return string Formatted HTML
 396          * @private
 397          */
 398         function getUserInput() {
 399                 $user =  $this->reader->queryUser();
 400                 return Xml::inputLabel( wfMsg( 'specialloguserlabel' ), 'user', 'user', 12, $user );
 401         }
 402
 403         /**
 404          * @return string Formatted HTML
 405          * @private
 406          */
 407         function getTitleInput() {
 408                 $title = $this->reader->queryTitle();
 409                 return Xml::inputLabel( wfMsg( 'speciallogtitlelabel' ), 'page', 'page', 20, $title );
 410         }
 411
 412         /**
 413          * @param OutputPage &$out where to send output
 414          * @private
 415          */
 416         function showPrevNext( &$out ) {
 417                 global $wgContLang,$wgRequest;
 418                 $pieces = array();
 419                 $pieces[] = 'type=' . urlencode( $this->reader->queryType() );
 420                 $pieces[] = 'user=' . urlencode( $this->reader->queryUser() );
 421                 $pieces[] = 'page=' . urlencode( $this->reader->queryTitle() );
 422                 $bits = implode( '&', $pieces );
 423                 list( $limit, $offset ) = $wgRequest->getLimitOffset();
 424
 425                 # TODO: use timestamps instead of offsets to make it more natural
 426                 # to go huge distances in time
 427                 $html = wfViewPrevNext( $offset, $limit,
 428                         $wgContLang->specialpage( 'Log' ),
 429                         $bits,
 430                         $this->numResults < $limit);
 431                 $out->addHTML( '<p>' . $html . '</p>' );
 432         }
 433 }
 434
 435
 436 ?>