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                         'rev_id,rev_page,rev_text_id,rev_timestamp,rev_comment,rev_minor_edit,rev_user,rev_user_text,'.
 162                         'rev_deleted ' .
 163                         "FROM $page,$revision $use_index " .
 164                         "WHERE page_id=rev_page AND $userCond $nscond $offsetQuery " .
 165                         'ORDER BY rev_timestamp DESC';
 166                 $sql = $this->dbr->limitResult( $sql, $this->limit, 0 );
 167                 return $sql;
 168         }
 169
 170         /**
 171          * This do the search for the user given when creating the object.
 172          * It should probably be the only public function in this class.
 173          * @return Array of contributions.
 174         */
 175         function find() {
 176                 $contribs = array();
 177                 $res = $this->dbr->query( $this->makeSql(), __METHOD__ );
 178                 while ( $c = $this->dbr->fetchObject( $res ) )
 179                         $contribs[] = $c;
 180                 $this->dbr->freeResult( $res );
 181                 return $contribs;
 182         }
 183 };
 184
 185 /**
 186  * Special page "user contributions".
 187  * Shows a list of the contributions of a user.
 188  *
 189  * @return      none
 190  * @param       $par    String: (optional) user name of the user for which to show the contributions
 191  */
 192 function wfSpecialContributions( $par = null ) {
 193         global $wgUser, $wgOut, $wgLang, $wgRequest;
 194
 195         $options = array();
 196
 197         if ( isset( $par ) && $par == 'newbies' ) {
 198                 $target = 'newbies';
 199                 $options['contribs'] = 'newbie';
 200         } elseif ( isset( $par ) ) {
 201                 $target = $par;
 202         } else {
 203                 $target = ucfirst( $wgRequest->getVal( 'target' ) );
 204         }
 205
 206         // check for radiobox
 207         if ( $wgRequest->getVal( 'contribs' ) == 'newbie' ) {
 208                 $target = 'newbies';
 209                 $options['contribs'] = 'newbie';
 210         }
 211
 212         if ( !strlen( $target ) ) {
 213                 $wgOut->addHTML( contributionsForm( '' ) );
 214                 return;
 215         }
 216
 217         $nt = Title::newFromURL( $target );
 218         if ( !$nt ) {
 219                 $wgOut->addHTML( contributionsForm( '' ) );
 220                 return;
 221         }
 222
 223         list( $options['limit'], $options['offset']) = wfCheckLimits();
 224         $options['offset'] = $wgRequest->getVal( 'offset' );
 225         /* Offset must be an integral. */
 226         if ( !strlen( $options['offset'] ) || !preg_match( '/^[0-9]+$/', $options['offset'] ) ) {
 227                 $options['offset'] = '';
 228         }
 229
 230         $title = SpecialPage::getTitleFor( 'Contributions' );
 231         $options['target'] = $target;
 232
 233         $nt = Title::makeTitle( NS_USER, $nt->getDBkey() );
 234         $finder = new ContribsFinder( ( $target == 'newbies' ) ? 'newbies' : $nt->getText() );
 235         $finder->setLimit( $options['limit'] );
 236         $finder->setOffset( $options['offset'] );
 237
 238         if ( ( $ns = $wgRequest->getVal( 'namespace', null ) ) !== null && $ns !== '' ) {
 239                 $options['namespace'] = intval( $ns );
 240                 $finder->setNamespace( $options['namespace'] );
 241         } else {
 242                 $options['namespace'] = '';
 243         }
 244
 245         if ( $wgUser->isAllowed( 'rollback' ) && $wgRequest->getBool( 'bot' ) ) {
 246                 $options['bot'] = '1';
 247         }
 248
 249         if ( $wgRequest->getText( 'go' ) == 'prev' ) {
 250                 $offset = $finder->getPreviousOffsetForPaging();
 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 ( $wgRequest->getText( 'go' ) == 'first' && $target != 'newbies') {
 260                 $offset = $finder->getFirstOffsetForPaging();
 261                 if ( $offset !== false ) {
 262                         $options['offset'] = $offset;
 263                         $prevurl = $title->getLocalURL( wfArrayToCGI( $options ) );
 264                         $wgOut->redirect( $prevurl );
 265                         return;
 266                 }
 267         }
 268
 269         if ( $target == 'newbies' ) {
 270                 $wgOut->setSubtitle( wfMsgHtml( 'sp-contributions-newbies-sub') );
 271         } else {
 272                 $wgOut->setSubtitle( wfMsgHtml( 'contribsub', contributionsSub( $nt ) ) );
 273         }
 274
 275         $id = User::idFromName( $nt->getText() );
 276         wfRunHooks( 'SpecialContributionsBeforeMainOutput', $id );
 277
 278         $wgOut->addHTML( contributionsForm( $options) );
 279
 280         $contribs = $finder->find();
 281
 282         if ( count( $contribs ) == 0) {
 283                 $wgOut->addWikiText( wfMsg( 'nocontribs' ) );
 284                 return;
 285         }
 286
 287         list( $early, $late ) = $finder->getEditLimits();
 288         $lastts = count( $contribs ) ? wfTimestamp( TS_MW, $contribs[count( $contribs ) - 1]->rev_timestamp ) : 0;
 289         $atstart = ( !count( $contribs ) || $late == wfTimestamp( TS_MW, $contribs[0]->rev_timestamp ) );
 290         $atend = ( !count( $contribs ) || $early == $lastts );
 291
 292         // These four are defaults
 293         $newestlink = wfMsgHtml( 'sp-contributions-newest' );
 294         $oldestlink = wfMsgHtml( 'sp-contributions-oldest' );
 295         $newerlink  = wfMsgHtml( 'sp-contributions-newer', $options['limit'] );
 296         $olderlink  = wfMsgHtml( 'sp-contributions-older', $options['limit'] );
 297
 298         if ( !$atstart ) {
 299                 $stuff = $title->escapeLocalURL( wfArrayToCGI( array( 'offset' => '' ), $options ) );
 300                 $newestlink = "<a href=\"$stuff\">$newestlink</a>";
 301                 $stuff = $title->escapeLocalURL( wfArrayToCGI( array( 'go' => 'prev' ), $options ) );
 302                 $newerlink = "<a href=\"$stuff\">$newerlink</a>";
 303         }
 304
 305         if ( !$atend ) {
 306                 $stuff = $title->escapeLocalURL( wfArrayToCGI( array( 'go' => 'first' ), $options ) );
 307                 $oldestlink = "<a href=\"$stuff\">$oldestlink</a>";
 308                 $stuff = $title->escapeLocalURL( wfArrayToCGI( array( 'offset' => $lastts ), $options ) );
 309                 $olderlink = "<a href=\"$stuff\">$olderlink</a>";
 310         }
 311
 312         if ( $target == 'newbies' ) {
 313                 $firstlast ="($newestlink)";
 314         } else {
 315                 $firstlast = "($newestlink | $oldestlink)";
 316         }
 317
 318         $urls = array();
 319         foreach ( array( 20, 50, 100, 250, 500 ) as $num ) {
 320                 $stuff = $title->escapeLocalURL( wfArrayToCGI( array( 'limit' => $num ), $options ) );
 321                 $urls[] = "<a href=\"$stuff\">".$wgLang->formatNum( $num )."</a>";
 322         }
 323         $bits = implode( $urls, ' | ' );
 324
 325         $prevnextbits = $firstlast .' '. wfMsgHtml( 'viewprevnext', $newerlink, $olderlink, $bits );
 326
 327         $wgOut->addHTML( "<p>{$prevnextbits}</p>\n" );
 328
 329         $wgOut->addHTML( "<ul>\n" );
 330
 331         $sk = $wgUser->getSkin();
 332         foreach ( $contribs as $contrib )
 333                 $wgOut->addHTML( ucListEdit( $sk, $contrib ) );
 334
 335         $wgOut->addHTML( "</ul>\n" );
 336         $wgOut->addHTML( "<p>{$prevnextbits}</p>\n" );
 337
 338         # If there were contributions, and it was a valid user or IP, show
 339         # the appropriate "footer" message - WHOIS tools, etc.
 340         if( count( $contribs ) > 0 && $target != 'newbies' && $nt instanceof Title ) {
 341                 $message = IP::isIPAddress( $target )
 342                         ? 'sp-contributions-footer-anon'
 343                         : 'sp-contributions-footer';
 344                 $text = wfMsg( $message, $target );
 345                 if( !wfEmptyMsg( $message, $text ) && $text != '-' ) {
 346                         $wgOut->addHtml( '<div class="mw-contributions-footer">' );
 347                         $wgOut->addWikiText( wfMsg( $message, $target ) );
 348                         $wgOut->addHtml( '</div>' );
 349                 }
 350         }
 351
 352 }
 353
 354 /**
 355  * Generates the subheading with links
 356  * @param $nt @see Title object for the target
 357  */
 358 function contributionsSub( $nt ) {
 359         global $wgSysopUserBans, $wgLang, $wgUser;
 360
 361         $sk = $wgUser->getSkin();
 362         $id = User::idFromName( $nt->getText() );
 363
 364         if ( 0 == $id ) {
 365                 $ul = $nt->getText();
 366         } else {
 367                 $ul = $sk->makeLinkObj( $nt, htmlspecialchars( $nt->getText() ) );
 368         }
 369         $talk = $nt->getTalkPage();
 370         if( $talk ) {
 371                 # Talk page link
 372                 $tools[] = $sk->makeLinkObj( $talk, $wgLang->getNsText( NS_TALK ) );
 373                 if( ( $id != 0 && $wgSysopUserBans ) || ( $id == 0 && User::isIP( $nt->getText() ) ) ) {
 374                         # Block link
 375                         if( $wgUser->isAllowed( 'block' ) )
 376                                 $tools[] = $sk->makeKnownLinkObj( SpecialPage::getTitleFor( 'Blockip', $nt->getDBkey() ), wfMsgHtml( 'blocklink' ) );
 377                         # Block log link
 378                         $tools[] = $sk->makeKnownLinkObj( SpecialPage::getTitleFor( 'Log' ), wfMsgHtml( 'sp-contributions-blocklog' ), 'type=block&page=' . $nt->getPrefixedUrl() );
 379                 }
 380                 # Other logs link
 381                 $tools[] = $sk->makeKnownLinkObj( SpecialPage::getTitleFor( 'Log' ), wfMsgHtml( 'log' ), 'user=' . $nt->getPartialUrl() );
 382                 $ul .= ' (' . implode( ' | ', $tools ) . ')';
 383         }
 384         return $ul;
 385 }
 386
 387 /**
 388  * Generates the namespace selector form with hidden attributes.
 389  * @param $options Array: the options to be included.
 390  */
 391 function contributionsForm( $options ) {
 392         global $wgScript, $wgTitle, $wgRequest;
 393
 394         $options['title'] = $wgTitle->getPrefixedText();
 395         if ( !isset( $options['target'] ) ) {
 396                 $options['target'] = '';
 397         } else {
 398                 $options['target'] = str_replace( '_' , ' ' , $options['target'] );
 399         }
 400
 401         if ( !isset( $options['namespace'] ) ) {
 402                 $options['namespace'] = '';
 403         }
 404
 405         if ( !isset( $options['contribs'] ) ) {
 406                 $options['contribs'] = 'user';
 407         }
 408
 409         if ( $options['contribs'] == 'newbie' ) {
 410                 $options['target'] = '';
 411         }
 412
 413         $f = Xml::openElement( 'form', array( 'method' => 'get', 'action' => $wgScript ) );
 414
 415         foreach ( $options as $name => $value ) {
 416                 if( $name === 'namespace' || $name === 'target' || $name === 'contribs' ) continue;
 417                 $f .= "\t" . Xml::hidden( $name, $value ) . "\n";
 418         }
 419
 420         $f .= '<fieldset>' .
 421                 Xml::element( 'legend', array(), wfMsg( 'sp-contributions-search' ) ) .
 422                 Xml::radioLabel( wfMsgExt( 'sp-contributions-newbies', array( 'parseinline' ) ), 'contribs' , 'newbie' , 'newbie', $options['contribs'] == 'newbie' ? true : false ) . '<br />' .
 423                 Xml::radioLabel( wfMsgExt( 'sp-contributions-username', array( 'parseinline' ) ), 'contribs' , 'user', 'user', $options['contribs'] == 'user' ? true : false ) . ' ' .
 424                 Xml::input( 'target', 20, $options['target']) . ' '.
 425                 Xml::label( wfMsg( 'namespace' ), 'namespace' ) .
 426                 Xml::namespaceSelector( $options['namespace'], '' ) .
 427                 Xml::submitButton( wfMsg( 'sp-contributions-submit' ) ) .
 428                 '</fieldset>' .
 429                 Xml::closeElement( 'form' );
 430         return $f;
 431 }
 432
 433 /**
 434  * Generates each row in the contributions list.
 435  *
 436  * Contributions which are marked "top" are currently on top of the history.
 437  * For these contributions, a [rollback] link is shown for users with sysop
 438  * privileges. The rollback link restores the most recent version that was not
 439  * written by the target user.
 440  *
 441  * @todo This would probably look a lot nicer in a table.
 442  */
 443 function ucListEdit( $sk, $row ) {
 444         $fname = 'ucListEdit';
 445         wfProfileIn( $fname );
 446
 447         global $wgLang, $wgUser, $wgRequest;
 448         static $messages;
 449         if( !isset( $messages ) ) {
 450                 foreach( explode( ' ', 'uctop diff newarticle rollbacklink diff hist minoreditletter' ) as $msg ) {
 451                         $messages[$msg] = wfMsgExt( $msg, array( 'escape') );
 452                 }
 453         }
 454
 455         $rev = new Revision( $row );
 456
 457         $page = Title::makeTitle( $row->page_namespace, $row->page_title );
 458         $link = $sk->makeKnownLinkObj( $page );
 459         $difftext = $topmarktext = '';
 460         if( $row->rev_id == $row->page_latest ) {
 461                 $topmarktext .= '<strong>' . $messages['uctop'] . '</strong>';
 462                 if( !$row->page_is_new ) {
 463                         $difftext .= '(' . $sk->makeKnownLinkObj( $page, $messages['diff'], 'diff=0' ) . ')';
 464                 } else {
 465                         $difftext .= $messages['newarticle'];
 466                 }
 467
 468                 if( $wgUser->isAllowed( 'rollback' ) ) {
 469                         $topmarktext .= ' '.$sk->generateRollback( $rev );
 470                 }
 471
 472         }
 473         if( $rev->userCan( Revision::DELETED_TEXT ) ) {
 474                 $difftext = '(' . $sk->makeKnownLinkObj( $page, $messages['diff'], 'diff=prev&oldid='.$row->rev_id ) . ')';
 475         } else {
 476                 $difftext = '(' . $messages['diff'] . ')';
 477         }
 478         $histlink='('.$sk->makeKnownLinkObj( $page, $messages['hist'], 'action=history' ) . ')';
 479
 480         $comment = $sk->revComment( $rev );
 481         $d = $wgLang->timeanddate( wfTimestamp( TS_MW, $row->rev_timestamp ), true );
 482
 483         if( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
 484                 $d = '<span class="history-deleted">' . $d . '</span>';
 485         }
 486
 487         if( $row->rev_minor_edit ) {
 488                 $mflag = '<span class="minor">' . $messages['minoreditletter'] . '</span> ';
 489         } else {
 490                 $mflag = '';
 491         }
 492
 493         $ret = "{$d} {$histlink} {$difftext} {$mflag} {$link} {$comment} {$topmarktext}";
 494         if( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
 495                 $ret .= ' ' . wfMsgHtml( 'deletedrev' );
 496         }
 497         $ret = "<li>$ret</li>\n";
 498         wfProfileOut( $fname );
 499         return $ret;
 500 }
 501
 502 ?>