includes/SpecialContributions.php

   1 <?php
   2 /**
   3  * @addtogroup SpecialPage
   4  */
   5
   6 class ContribsFinder {
   7         var $username, $offset, $limit, $namespace;
   8         var $dbr;
   9
  10         /**
  11          * Constructor
  12          * @param $username Username as a string
  13         */
  14         function ContribsFinder( $username ) {
  15                 $this->username = $username;
  16                 $this->namespace = false;
  17                 $this->dbr = wfGetDB( DB_SLAVE, 'contributions' );
  18         }
  19
  20         function setNamespace( $ns ) {
  21                 $this->namespace = $ns;
  22         }
  23
  24         function setLimit( $limit ) {
  25                 $this->limit = $limit;
  26         }
  27
  28         function setOffset( $offset ) {
  29                 $this->offset = $offset;
  30         }
  31
  32         /**
  33          * Get timestamp of either first or last contribution made by the user.
  34          * @todo Maybe it should be private ?
  35          * @param $dir string 'ASC' or 'DESC'.
  36          * @return Revision timestamp (rev_timestamp).
  37         */
  38         function getEditLimit( $dir ) {
  39                 list( $index, $usercond ) = $this->getUserCond();
  40                 $nscond = $this->getNamespaceCond();
  41                 $use_index = $this->dbr->useIndexClause( $index );
  42                 list( $revision, $page) = $this->dbr->tableNamesN( 'revision', 'page' );
  43                 $sql =  "SELECT rev_timestamp " .
  44                         " FROM $page,$revision $use_index " .
  45                         " WHERE rev_page=page_id AND $usercond $nscond" .
  46                         " ORDER BY rev_timestamp $dir LIMIT 1";
  47
  48                 $res = $this->dbr->query( $sql, __METHOD__ );
  49                 $row = $this->dbr->fetchObject( $res );
  50                 if ( $row ) {
  51                         return wfTimestamp( TS_MW, $row->rev_timestamp );
  52                 } else {
  53                         return false;
  54                 }
  55         }
  56
  57         /**
  58          * Get timestamps of first and last contributions made by the user.
  59          * @return Array containing first rev_timestamp and last rev_timestamp.
  60         */
  61         function getEditLimits() {
  62                 return array(
  63                         $this->getEditLimit( "ASC" ),
  64                         $this->getEditLimit( "DESC" )
  65                 );
  66         }
  67
  68         function getUserCond() {
  69                 $condition = '';
  70
  71                 if ( $this->username == 'newbies' ) {
  72                         $max = $this->dbr->selectField( 'user', 'max(user_id)', false, 'make_sql' );
  73                         $condition = '>' . (int)($max - $max / 100);
  74                 }
  75
  76                 if ( $condition == '' ) {
  77                         $condition = ' rev_user_text=' . $this->dbr->addQuotes( $this->username );
  78                         $index = 'usertext_timestamp';
  79                 } else {
  80                         $condition = ' rev_user '.$condition ;
  81                         $index = 'user_timestamp';
  82                 }
  83                 return array( $index, $condition );
  84         }
  85
  86         function getNamespaceCond() {
  87                 if ( $this->namespace !== false )
  88                         return ' AND page_namespace = ' . (int)$this->namespace;
  89                 return '';
  90         }
  91
  92         /**
  93          * @return Timestamp of first entry in previous page.
  94         */
  95         function getPreviousOffsetForPaging() {
  96                 list( $index, $usercond ) = $this->getUserCond();
  97                 $nscond = $this->getNamespaceCond();
  98
  99                 $use_index = $this->dbr->useIndexClause( $index );
 100                 list( $page, $revision ) = $this->dbr->tableNamesN( 'page', 'revision' );
 101
 102                 $sql =  "SELECT rev_timestamp FROM $page, $revision $use_index " .
 103                         "WHERE page_id = rev_page AND rev_timestamp > '" . $this->dbr->timestamp( $this->offset ) . "' AND " .
 104                         $usercond . $nscond;
 105                 $sql .= " ORDER BY rev_timestamp ASC";
 106                 $sql = $this->dbr->limitResult( $sql, $this->limit, 0 );
 107                 $res = $this->dbr->query( $sql );
 108
 109                 $numRows = $this->dbr->numRows( $res );
 110                 if ( $numRows ) {
 111                         $this->dbr->dataSeek( $res, $numRows - 1 );
 112                         $row = $this->dbr->fetchObject( $res );
 113                         $offset = wfTimestamp( TS_MW, $row->rev_timestamp );
 114                 } else {
 115                         $offset = false;
 116                 }
 117                 $this->dbr->freeResult( $res );
 118                 return $offset;
 119         }
 120
 121         /**
 122          * @return Timestamp of first entry in next page.
 123         */
 124         function getFirstOffsetForPaging() {
 125                 list( $index, $usercond ) = $this->getUserCond();
 126                 $use_index = $this->dbr->useIndexClause( $index );
 127                 list( $page, $revision ) = $this->dbr->tableNamesN( 'page', 'revision' );
 128                 $nscond = $this->getNamespaceCond();
 129                 $sql =  "SELECT rev_timestamp FROM $page, $revision $use_index " .
 130                         "WHERE page_id = rev_page AND " .
 131                         $usercond . $nscond;
 132                 $sql .= " ORDER BY rev_timestamp ASC";
 133                 $sql = $this->dbr->limitResult( $sql, $this->limit, 0 );
 134                 $res = $this->dbr->query( $sql );
 135
 136                 $numRows = $this->dbr->numRows( $res );
 137                 if ( $numRows ) {
 138                         $this->dbr->dataSeek( $res, $numRows - 1 );
 139                         $row = $this->dbr->fetchObject( $res );
 140                         $offset = wfTimestamp( TS_MW, $row->rev_timestamp );
 141                 } else {
 142                         $offset = false;
 143                 }
 144                 $this->dbr->freeResult( $res );
 145                 return $offset;
 146         }
 147
 148         /* private */ function makeSql() {
 149                 $offsetQuery = '';
 150
 151                 list( $page, $revision ) = $this->dbr->tableNamesN( 'page', 'revision' );
 152                 list( $index, $userCond ) = $this->getUserCond();
 153
 154                 if ( $this->offset )
 155                         $offsetQuery = "AND rev_timestamp < '" . $this->dbr->timestamp($this->offset) . "'";
 156
 157                 $nscond = $this->getNamespaceCond();
 158                 $use_index = $this->dbr->useIndexClause( $index );
 159                 $sql = 'SELECT ' .
 160                         'page_namespace,page_title,page_is_new,page_latest,'.
 161                         join(',', Revision::selectFields()) .
 162                         " FROM $page,$revision $use_index " .
 163                         "WHERE page_id=rev_page AND $userCond $nscond $offsetQuery " .
 164                         'ORDER BY rev_timestamp DESC';
 165                 $sql = $this->dbr->limitResult( $sql, $this->limit, 0 );
 166                 return $sql;
 167         }
 168
 169         /**
 170          * This do the search for the user given when creating the object.
 171          * It should probably be the only public function in this class.
 172          * @return Array of contributions.
 173         */
 174         function find() {
 175                 $contribs = array();
 176                 $res = $this->dbr->query( $this->makeSql(), __METHOD__ );
 177                 while ( $c = $this->dbr->fetchObject( $res ) )
 178                         $contribs[] = $c;
 179                 $this->dbr->freeResult( $res );
 180                 return $contribs;
 181         }
 182 };
 183
 184 /**
 185  * Special page "user contributions".
 186  * Shows a list of the contributions of a user.
 187  *
 188  * @return      none
 189  * @param       $par    String: (optional) user name of the user for which to show the contributions
 190  */
 191 function wfSpecialContributions( $par = null ) {
 192         global $wgUser, $wgOut, $wgLang, $wgRequest;
 193
 194         $target = isset( $par ) ? $par : $wgRequest->getVal( 'target' );
 195         $radiobox = $wgRequest->getVal( 'newbie' );
 196
 197         // check for radiobox
 198         if ( $radiobox == 'contribs-newbie' ) $target = 'newbies';
 199
 200         if ( !strlen( $target ) ) {
 201                 $wgOut->addHTML( contributionsForm( '' ) );
 202                 return;
 203         }
 204
 205         $nt = Title::newFromURL( $target );
 206         if ( !$nt ) {
 207                 $wgOut->addHTML( contributionsForm( '' ) );
 208                 return;
 209         }
 210
 211         $options = array();
 212
 213         list( $options['limit'], $options['offset']) = wfCheckLimits();
 214         $options['offset'] = $wgRequest->getVal( 'offset' );
 215         /* Offset must be an integral. */
 216         if ( !strlen( $options['offset'] ) || !preg_match( '/^[0-9]+$/', $options['offset'] ) ) {
 217                 $options['offset'] = '';
 218         }
 219
 220         $title = SpecialPage::getTitleFor( 'Contributions' );
 221         $options['target'] = $target;
 222
 223         $nt = Title::makeTitle( NS_USER, $nt->getDBkey() );
 224         $finder = new ContribsFinder( ( $target == 'newbies' ) ? 'newbies' : $nt->getText() );
 225         $finder->setLimit( $options['limit'] );
 226         $finder->setOffset( $options['offset'] );
 227
 228         if ( ( $ns = $wgRequest->getVal( 'namespace', null ) ) !== null && $ns !== '' ) {
 229                 $options['namespace'] = intval( $ns );
 230                 $finder->setNamespace( $options['namespace'] );
 231         } else {
 232                 $options['namespace'] = '';
 233         }
 234
 235         if ( $wgUser->isAllowed( 'rollback' ) && $wgRequest->getBool( 'bot' ) ) {
 236                 $options['bot'] = '1';
 237         }
 238
 239         if ( $wgRequest->getText( 'go' ) == 'prev' ) {
 240                 $offset = $finder->getPreviousOffsetForPaging();
 241                 if ( $offset !== false ) {
 242                         $options['offset'] = $offset;
 243                         $prevurl = $title->getLocalURL( wfArrayToCGI( $options ) );
 244                         $wgOut->redirect( $prevurl );
 245                         return;
 246                 }
 247         }
 248
 249         if ( $wgRequest->getText( 'go' ) == 'first' && $target != 'newbies') {
 250                 $offset = $finder->getFirstOffsetForPaging();
 251                 if ( $offset !== false ) {
 252                         $options['offset'] = $offset;
 253                         $prevurl = $title->getLocalURL( wfArrayToCGI( $options ) );
 254                         $wgOut->redirect( $prevurl );
 255                         return;
 256                 }
 257         }
 258
 259         if ( $target == 'newbies' ) {
 260                 $wgOut->setSubtitle( wfMsgHtml( 'sp-contributions-newbies-sub') );
 261         } else {
 262                 $wgOut->setSubtitle( wfMsgHtml( 'contribsub', contributionsSub( $nt ) ) );
 263         }
 264
 265         $id = User::idFromName( $nt->getText() );
 266         wfRunHooks( 'SpecialContributionsBeforeMainOutput', $id );
 267
 268         $wgOut->addHTML( contributionsForm( $options) );
 269
 270         $contribs = $finder->find();
 271
 272         if ( count( $contribs ) == 0) {
 273                 $wgOut->addWikiText( wfMsg( 'nocontribs' ) );
 274                 return;
 275         }
 276
 277         list( $early, $late ) = $finder->getEditLimits();
 278         $lastts = count( $contribs ) ? wfTimestamp( TS_MW, $contribs[count( $contribs ) - 1]->rev_timestamp ) : 0;
 279         $atstart = ( !count( $contribs ) || $late == wfTimestamp( TS_MW, $contribs[0]->rev_timestamp ) );
 280         $atend = ( !count( $contribs ) || $early == $lastts );
 281
 282         // These four are defaults
 283         $newestlink = wfMsgHtml( 'sp-contributions-newest' );
 284         $oldestlink = wfMsgHtml( 'sp-contributions-oldest' );
 285         $newerlink  = wfMsgHtml( 'sp-contributions-newer', $options['limit'] );
 286         $olderlink  = wfMsgHtml( 'sp-contributions-older', $options['limit'] );
 287
 288         if ( !$atstart ) {
 289                 $stuff = $title->escapeLocalURL( wfArrayToCGI( array( 'offset' => '' ), $options ) );
 290                 $newestlink = "<a href=\"$stuff\">$newestlink</a>";
 291                 $stuff = $title->escapeLocalURL( wfArrayToCGI( array( 'go' => 'prev' ), $options ) );
 292                 $newerlink = "<a href=\"$stuff\">$newerlink</a>";
 293         }
 294
 295         if ( !$atend ) {
 296                 $stuff = $title->escapeLocalURL( wfArrayToCGI( array( 'go' => 'first' ), $options ) );
 297                 $oldestlink = "<a href=\"$stuff\">$oldestlink</a>";
 298                 $stuff = $title->escapeLocalURL( wfArrayToCGI( array( 'offset' => $lastts ), $options ) );
 299                 $olderlink = "<a href=\"$stuff\">$olderlink</a>";
 300         }
 301
 302         if ( $target == 'newbies' ) {
 303                 $firstlast ="($newestlink)";
 304         } else {
 305                 $firstlast = "($newestlink | $oldestlink)";
 306         }
 307
 308         $urls = array();
 309         foreach ( array( 20, 50, 100, 250, 500 ) as $num ) {
 310                 $stuff = $title->escapeLocalURL( wfArrayToCGI( array( 'limit' => $num ), $options ) );
 311                 $urls[] = "<a href=\"$stuff\">".$wgLang->formatNum( $num )."</a>";
 312         }
 313         $bits = implode( $urls, ' | ' );
 314
 315         $prevnextbits = $firstlast .' '. wfMsgHtml( 'viewprevnext', $newerlink, $olderlink, $bits );
 316
 317         $wgOut->addHTML( "<p>{$prevnextbits}</p>\n" );
 318
 319         $wgOut->addHTML( "<ul>\n" );
 320
 321         $sk = $wgUser->getSkin();
 322         foreach ( $contribs as $contrib )
 323                 $wgOut->addHTML( ucListEdit( $sk, $contrib ) );
 324
 325         $wgOut->addHTML( "</ul>\n" );
 326         $wgOut->addHTML( "<p>{$prevnextbits}</p>\n" );
 327
 328         # If there were contributions, and it was a valid user or IP, show
 329         # the appropriate "footer" message - WHOIS tools, etc.
 330         if( count( $contribs ) > 0 && $target != 'newbies' && $nt instanceof Title ) {
 331                 $message = IP::isIPAddress( $target )
 332                         ? 'sp-contributions-footer-anon'
 333                         : 'sp-contributions-footer';
 334                 $text = wfMsg( $message, $target );
 335                 if( !wfEmptyMsg( $message, $text ) && $text != '-' ) {
 336                         $wgOut->addHtml( '<div class="mw-contributions-footer">' );
 337                         $wgOut->addWikiText( wfMsg( $message, $target ) );
 338                         $wgOut->addHtml( '</div>' );
 339                 }
 340         }
 341
 342 }
 343
 344 /**
 345  * Generates the subheading with links
 346  * @param $nt @see Title object for the target
 347  */
 348 function contributionsSub( $nt ) {
 349         global $wgSysopUserBans, $wgLang, $wgUser;
 350
 351         $sk = $wgUser->getSkin();
 352         $id = User::idFromName( $nt->getText() );
 353
 354         if ( 0 == $id ) {
 355                 $ul = $nt->getText();
 356         } else {
 357                 $ul = $sk->makeLinkObj( $nt, htmlspecialchars( $nt->getText() ) );
 358         }
 359         $talk = $nt->getTalkPage();
 360         if( $talk ) {
 361                 # Talk page link
 362                 $tools[] = $sk->makeLinkObj( $talk, $wgLang->getNsText( NS_TALK ) );
 363                 if( ( $id != 0 && $wgSysopUserBans ) || ( $id == 0 && User::isIP( $nt->getText() ) ) ) {
 364                         # Block link
 365                         if( $wgUser->isAllowed( 'block' ) )
 366                                 $tools[] = $sk->makeKnownLinkObj( SpecialPage::getTitleFor( 'Blockip', $nt->getDBkey() ), wfMsgHtml( 'blocklink' ) );
 367                         # Block log link
 368                         $tools[] = $sk->makeKnownLinkObj( SpecialPage::getTitleFor( 'Log' ), wfMsgHtml( 'sp-contributions-blocklog' ), 'type=block&page=' . $nt->getPrefixedUrl() );
 369                 }
 370                 # Other logs link
 371                 $tools[] = $sk->makeKnownLinkObj( SpecialPage::getTitleFor( 'Log' ), wfMsgHtml( 'log' ), 'user=' . $nt->getPartialUrl() );
 372                 $ul .= ' (' . implode( ' | ', $tools ) . ')';
 373         }
 374         return $ul;
 375 }
 376
 377 /**
 378  * Generates the namespace selector form with hidden attributes.
 379  * @param $options Array: the options to be included.
 380  */
 381 function contributionsForm( $options ) {
 382         global $wgScript, $wgTitle, $wgRequest;
 383
 384         $options['title'] = $wgTitle->getPrefixedText();
 385         if (!isset($options['target']))
 386                 $options['target'] = '';
 387         if (!isset($options['namespace']))
 388                 $options['namespace'] = 0;
 389
 390         $f = Xml::openElement( 'form', array( 'method' => 'get', 'action' => $wgScript ) );
 391
 392         foreach ( $options as $name => $value ) {
 393                 if( $name === 'namespace') continue;
 394                 $f .= "\t" . Xml::hidden( $name, $value ) . "\n";
 395         }
 396
 397         $f .= '<fieldset>' .
 398                 Xml::element( 'legend', array(), wfMsg( 'sp-contributions-search' ) ) .
 399                 Xml::radioLabel( wfMsgExt( 'sp-contributions-newbies', array( 'parseinline' ) ), 'newbie' , 'contribs-newbie' , 'contribs-newbie', 'contribs-newbie' ) . '<br />' .
 400                 Xml::radioLabel( wfMsgExt( 'sp-contributions-username', array( 'parseinline' ) ), 'newbie' , 'contribs-all', 'contribs-all', 'contribs-all' ) . ' ' .
 401                 Xml::input( 'target', 20, $options['target']) . ' '.
 402                 Xml::label( wfMsg( 'namespace' ), 'namespace' ) .
 403                 Xml::namespaceSelector( $options['namespace'], '' ) .
 404                 Xml::submitButton( wfMsg( 'sp-contributions-submit' ) ) .
 405                 '</fieldset>' .
 406                 Xml::closeElement( 'form' );
 407         return $f;
 408 }
 409
 410 /**
 411  * Generates each row in the contributions list.
 412  *
 413  * Contributions which are marked "top" are currently on top of the history.
 414  * For these contributions, a [rollback] link is shown for users with sysop
 415  * privileges. The rollback link restores the most recent version that was not
 416  * written by the target user.
 417  *
 418  * @todo This would probably look a lot nicer in a table.
 419  */
 420 function ucListEdit( $sk, $row ) {
 421         $fname = 'ucListEdit';
 422         wfProfileIn( $fname );
 423
 424         global $wgLang, $wgUser, $wgRequest;
 425         static $messages;
 426         if( !isset( $messages ) ) {
 427                 foreach( explode( ' ', 'uctop diff newarticle rollbacklink diff hist minoreditletter' ) as $msg ) {
 428                         $messages[$msg] = wfMsgExt( $msg, array( 'escape') );
 429                 }
 430         }
 431
 432         $rev = new Revision( $row );
 433
 434         $page = Title::makeTitle( $row->page_namespace, $row->page_title );
 435         $link = $sk->makeKnownLinkObj( $page );
 436         $difftext = $topmarktext = '';
 437         if( $row->rev_id == $row->page_latest ) {
 438                 $topmarktext .= '<strong>' . $messages['uctop'] . '</strong>';
 439                 if( !$row->page_is_new ) {
 440                         $difftext .= '(' . $sk->makeKnownLinkObj( $page, $messages['diff'], 'diff=0' ) . ')';
 441                 } else {
 442                         $difftext .= $messages['newarticle'];
 443                 }
 444
 445                 if( $wgUser->isAllowed( 'rollback' ) ) {
 446                         $topmarktext .= ' '.$sk->generateRollback( $rev );
 447                 }
 448
 449         }
 450         if( $rev->userCan( Revision::DELETED_TEXT ) ) {
 451                 $difftext = '(' . $sk->makeKnownLinkObj( $page, $messages['diff'], 'diff=prev&oldid='.$row->rev_id ) . ')';
 452         } else {
 453                 $difftext = '(' . $messages['diff'] . ')';
 454         }
 455         $histlink='('.$sk->makeKnownLinkObj( $page, $messages['hist'], 'action=history' ) . ')';
 456
 457         $comment = $sk->revComment( $rev );
 458         $d = $wgLang->timeanddate( wfTimestamp( TS_MW, $row->rev_timestamp ), true );
 459
 460         if( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
 461                 $d = '<span class="history-deleted">' . $d . '</span>';
 462         }
 463
 464         if( $row->rev_minor_edit ) {
 465                 $mflag = '<span class="minor">' . $messages['minoreditletter'] . '</span> ';
 466         } else {
 467                 $mflag = '';
 468         }
 469
 470         $ret = "{$d} {$histlink} {$difftext} {$mflag} {$link} {$comment} {$topmarktext}";
 471         if( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
 472                 $ret .= ' ' . wfMsgHtml( 'deletedrev' );
 473         }
 474         $ret = "<li>$ret</li>\n";
 475         wfProfileOut( $fname );
 476         return $ret;
 477 }
 478
 479 ?>