includes/RecentChange.php

   1 <?php
   2 /**
   3  *
   4  * @package MediaWiki
   5  */
   6
   7 /**
   8  * Various globals
   9  */
  10 define( 'RC_EDIT', 0);
  11 define( 'RC_NEW', 1);
  12 define( 'RC_MOVE', 2);
  13 define( 'RC_LOG', 3);
  14 define( 'RC_MOVE_OVER_REDIRECT', 4);
  15
  16
  17 /**
  18  * Utility class for creating new RC entries
  19  * mAttribs:
  20  *      rc_id           id of the row in the recentchanges table
  21  *      rc_timestamp    time the entry was made
  22  *      rc_cur_time     timestamp on the cur row
  23  *      rc_namespace    namespace #
  24  *      rc_title        non-prefixed db key
  25  *      rc_type         is new entry, used to determine whether updating is necessary
  26  *      rc_minor        is minor
  27  *      rc_cur_id       page_id of associated page entry
  28  *      rc_user         user id who made the entry
  29  *      rc_user_text    user name who made the entry
  30  *      rc_comment      edit summary
  31  *      rc_this_oldid   rev_id associated with this entry (or zero)
  32  *      rc_last_oldid   rev_id associated with the entry before this one (or zero)
  33  *      rc_bot          is bot, hidden
  34  *      rc_ip           IP address of the user in dotted quad notation
  35  *      rc_new          obsolete, use rc_type==RC_NEW
  36  *      rc_patrolled    boolean whether or not someone has marked this edit as patrolled
  37  *
  38  * mExtra:
  39  *      prefixedDBkey   prefixed db key, used by external app via msg queue
  40  *      lastTimestamp   timestamp of previous entry, used in WHERE clause during update
  41  *      lang            the interwiki prefix, automatically set in save()
  42  *  oldSize         text size before the change
  43  *  newSize         text size after the change
  44  *
  45  * temporary:           not stored in the database
  46  *      notificationtimestamp
  47  *      numberofWatchingusers
  48  *
  49  * @todo document functions and variables
  50  * @package MediaWiki
  51  */
  52 class RecentChange
  53 {
  54         var $mAttribs = array(), $mExtra = array();
  55         var $mTitle = false, $mMovedToTitle = false;
  56
  57         # Factory methods
  58
  59         /* static */ function newFromRow( $row )
  60         {
  61                 $rc = new RecentChange;
  62                 $rc->loadFromRow( $row );
  63                 return $rc;
  64         }
  65
  66         /* static */ function newFromCurRow( $row )
  67         {
  68                 $rc = new RecentChange;
  69                 $rc->loadFromCurRow( $row );
  70                 $rc->notificationtimestamp = false;
  71                 $rc->numberofWatchingusers = false;
  72                 return $rc;
  73         }
  74
  75         # Accessors
  76
  77         function setAttribs( $attribs )
  78         {
  79                 $this->mAttribs = $attribs;
  80         }
  81
  82         function setExtra( $extra )
  83         {
  84                 $this->mExtra = $extra;
  85         }
  86
  87         function &getTitle()
  88         {
  89                 if ( $this->mTitle === false ) {
  90                         $this->mTitle = Title::makeTitle( $this->mAttribs['rc_namespace'], $this->mAttribs['rc_title'] );
  91                 }
  92                 return $this->mTitle;
  93         }
  94
  95         function getMovedToTitle()
  96         {
  97                 if ( $this->mMovedToTitle === false ) {
  98                         $this->mMovedToTitle = Title::makeTitle( $this->mAttribs['rc_moved_to_ns'],
  99                                 $this->mAttribs['rc_moved_to_title'] );
 100                 }
 101                 return $this->mMovedToTitle;
 102         }
 103
 104         # Writes the data in this object to the database
 105         function save()
 106         {
 107                 global $wgLocalInterwiki, $wgPutIPinRC, $wgRC2UDPAddress, $wgRC2UDPPort, $wgRC2UDPPrefix;
 108                 $fname = 'RecentChange::save';
 109
 110                 $dbw =& wfGetDB( DB_MASTER );
 111                 if ( !is_array($this->mExtra) ) {
 112                         $this->mExtra = array();
 113                 }
 114                 $this->mExtra['lang'] = $wgLocalInterwiki;
 115
 116                 if ( !$wgPutIPinRC ) {
 117                         $this->mAttribs['rc_ip'] = '';
 118                 }
 119
 120                 # Fixup database timestamps
 121                 $this->mAttribs['rc_timestamp']=$dbw->timestamp($this->mAttribs['rc_timestamp']);
 122                 $this->mAttribs['rc_cur_time']=$dbw->timestamp($this->mAttribs['rc_cur_time']);
 123
 124                 # Insert new row
 125                 $dbw->insert( 'recentchanges', $this->mAttribs, $fname );
 126
 127                 # Update old rows, if necessary
 128                 if ( $this->mAttribs['rc_type'] == RC_EDIT ) {
 129                         $oldid = $this->mAttribs['rc_last_oldid'];
 130                         $ns = $this->mAttribs['rc_namespace'];
 131                         $title = $this->mAttribs['rc_title'];
 132                         $lastTime = $this->mExtra['lastTimestamp'];
 133                         $now = $this->mAttribs['rc_timestamp'];
 134                         $curId = $this->mAttribs['rc_cur_id'];
 135
 136                         # Don't bother looking for entries that have probably
 137                         # been purged, it just locks up the indexes needlessly.
 138                         global $wgRCMaxAge;
 139                         $age = time() - wfTimestamp( TS_UNIX, $lastTime );
 140                         if( $age < $wgRCMaxAge ) {
 141                                 # Update rc_this_oldid for the entries which were current
 142                                 $dbw->update( 'recentchanges',
 143                                         array( /* SET */
 144                                                 'rc_this_oldid' => $oldid
 145                                         ), array( /* WHERE */
 146                                                 'rc_namespace' => $ns,
 147                                                 'rc_title' => $title,
 148                                                 'rc_timestamp' => $dbw->timestamp( $lastTime )
 149                                         ), $fname
 150                                 );
 151                         }
 152
 153                         # Update rc_cur_time
 154                         $dbw->update( 'recentchanges', array( 'rc_cur_time' => $now ),
 155                                 array( 'rc_cur_id' => $curId ), $fname );
 156                 }
 157
 158                 # Notify external application via UDP
 159                 if ( $wgRC2UDPAddress ) {
 160                         $conn = socket_create( AF_INET, SOCK_DGRAM, SOL_UDP );
 161                         if ( $conn ) {
 162                                 $line = $wgRC2UDPPrefix . $this->getIRCLine();
 163                                 socket_sendto( $conn, $line, strlen($line), 0, $wgRC2UDPAddress, $wgRC2UDPPort );
 164                                 socket_close( $conn );
 165                         }
 166                 }
 167         }
 168
 169         # Marks a certain row as patrolled
 170         function markPatrolled( $rcid )
 171         {
 172                 $fname = 'RecentChange::markPatrolled';
 173
 174                 $dbw =& wfGetDB( DB_MASTER );
 175
 176                 $dbw->update( 'recentchanges',
 177                         array( /* SET */
 178                                 'rc_patrolled' => 1
 179                         ), array( /* WHERE */
 180                                 'rc_id' => $rcid
 181                         ), $fname
 182                 );
 183         }
 184
 185         # Makes an entry in the database corresponding to an edit
 186         /*static*/ function notifyEdit( $timestamp, &$title, $minor, &$user, $comment,
 187                 $oldId, $lastTimestamp, $bot = "default", $ip = '', $oldSize = 0, $newSize = 0 )
 188         {
 189                 if ( $bot == 'default ' ) {
 190                         $bot = $user->isBot();
 191                 }
 192
 193                 if ( !$ip ) {
 194                         global $wgIP;
 195                         $ip = empty( $wgIP ) ? '' : $wgIP;
 196                 }
 197
 198                 $rc = new RecentChange;
 199                 $rc->mAttribs = array(
 200                         'rc_timestamp'  => $timestamp,
 201                         'rc_cur_time'   => $timestamp,
 202                         'rc_namespace'  => $title->getNamespace(),
 203                         'rc_title'      => $title->getDBkey(),
 204                         'rc_type'       => RC_EDIT,
 205                         'rc_minor'      => $minor ? 1 : 0,
 206                         'rc_cur_id'     => $title->getArticleID(),
 207                         'rc_user'       => $user->getID(),
 208                         'rc_user_text'  => $user->getName(),
 209                         'rc_comment'    => $comment,
 210                         'rc_this_oldid' => 0,
 211                         'rc_last_oldid' => $oldId,
 212                         'rc_bot'        => $bot ? 1 : 0,
 213                         'rc_moved_to_ns'        => 0,
 214                         'rc_moved_to_title'     => '',
 215                         'rc_ip' => $ip,
 216                         'rc_patrolled' => 0,
 217                         'rc_new'        => 0 # obsolete
 218                 );
 219
 220                 $rc->mExtra =  array(
 221                         'prefixedDBkey' => $title->getPrefixedDBkey(),
 222                         'lastTimestamp' => $lastTimestamp,
 223                         'oldSize'       => $oldSize,
 224                         'newSize'       => $newSize,
 225                 );
 226                 $rc->save();
 227         }
 228
 229         # Makes an entry in the database corresponding to page creation
 230         # Note: the title object must be loaded with the new id using resetArticleID()
 231         /*static*/ function notifyNew( $timestamp, &$title, $minor, &$user, $comment, $bot = "default",
 232           $ip='', $size = 0 )
 233         {
 234                 if ( !$ip ) {
 235                         global $wgIP;
 236                         $ip = empty( $wgIP ) ? '' : $wgIP;
 237                 }
 238                 if ( $bot == 'default' ) {
 239                         $bot = $user->isBot();
 240                 }
 241
 242                 $rc = new RecentChange;
 243                 $rc->mAttribs = array(
 244                         'rc_timestamp'      => $timestamp,
 245                         'rc_cur_time'       => $timestamp,
 246                         'rc_namespace'      => $title->getNamespace(),
 247                         'rc_title'          => $title->getDBkey(),
 248                         'rc_type'           => RC_NEW,
 249                         'rc_minor'          => $minor ? 1 : 0,
 250                         'rc_cur_id'         => $title->getArticleID(),
 251                         'rc_user'           => $user->getID(),
 252                         'rc_user_text'      => $user->getName(),
 253                         'rc_comment'        => $comment,
 254                         'rc_this_oldid'     => 0,
 255                         'rc_last_oldid'     => 0,
 256                         'rc_bot'            => $bot ? 1 : 0,
 257                         'rc_moved_to_ns'    => 0,
 258                         'rc_moved_to_title' => '',
 259                         'rc_ip'             => $ip,
 260                         'rc_patrolled'      => 0,
 261                         'rc_new'        => 1 # obsolete
 262                 );
 263
 264                 $rc->mExtra =  array(
 265                         'prefixedDBkey' => $title->getPrefixedDBkey(),
 266                         'lastTimestamp' => 0,
 267                         'oldSize' => 0,
 268                         'newSize' => $size
 269                 );
 270                 $rc->save();
 271         }
 272
 273         # Makes an entry in the database corresponding to a rename
 274         /*static*/ function notifyMove( $timestamp, &$oldTitle, &$newTitle, &$user, $comment, $ip='', $overRedir = false )
 275         {
 276                 if ( !$ip ) {
 277                         global $wgIP;
 278                         $ip = empty( $wgIP ) ? '' : $wgIP;
 279                 }
 280                 $rc = new RecentChange;
 281                 $rc->mAttribs = array(
 282                         'rc_timestamp'  => $timestamp,
 283                         'rc_cur_time'   => $timestamp,
 284                         'rc_namespace'  => $oldTitle->getNamespace(),
 285                         'rc_title'      => $oldTitle->getDBkey(),
 286                         'rc_type'       => $overRedir ? RC_MOVE_OVER_REDIRECT : RC_MOVE,
 287                         'rc_minor'      => 0,
 288                         'rc_cur_id'     => $oldTitle->getArticleID(),
 289                         'rc_user'       => $user->getID(),
 290                         'rc_user_text'  => $user->getName(),
 291                         'rc_comment'    => $comment,
 292                         'rc_this_oldid' => 0,
 293                         'rc_last_oldid' => 0,
 294                         'rc_bot'        => $user->isBot() ? 1 : 0,
 295                         'rc_moved_to_ns'        => $newTitle->getNamespace(),
 296                         'rc_moved_to_title'     => $newTitle->getDBkey(),
 297                         'rc_ip'         => $ip,
 298                         'rc_new'        => 0, # obsolete
 299                         'rc_patrolled' => 1
 300                 );
 301
 302                 $rc->mExtra = array(
 303                         'prefixedDBkey' => $oldTitle->getPrefixedDBkey(),
 304                         'lastTimestamp' => 0,
 305                         'prefixedMoveTo'        => $newTitle->getPrefixedDBkey()
 306                 );
 307                 $rc->save();
 308         }
 309
 310         /* static */ function notifyMoveToNew( $timestamp, &$oldTitle, &$newTitle, &$user, $comment, $ip='' ) {
 311                 RecentChange::notifyMove( $timestamp, $oldTitle, $newTitle, $user, $comment, $ip, false );
 312         }
 313
 314         /* static */ function notifyMoveOverRedirect( $timestamp, &$oldTitle, &$newTitle, &$user, $comment, $ip='' ) {
 315                 RecentChange::notifyMove( $timestamp, $oldTitle, $newTitle, $user, $comment, $ip='', true );
 316         }
 317
 318         # A log entry is different to an edit in that previous revisions are
 319         # not kept
 320         /*static*/ function notifyLog( $timestamp, &$title, &$user, $comment, $ip='' )
 321         {
 322                 if ( !$ip ) {
 323                         global $wgIP;
 324                         $ip = empty( $wgIP ) ? '' : $wgIP;
 325                 }
 326                 $rc = new RecentChange;
 327                 $rc->mAttribs = array(
 328                         'rc_timestamp'  => $timestamp,
 329                         'rc_cur_time'   => $timestamp,
 330                         'rc_namespace'  => $title->getNamespace(),
 331                         'rc_title'      => $title->getDBkey(),
 332                         'rc_type'       => RC_LOG,
 333                         'rc_minor'      => 0,
 334                         'rc_cur_id'     => $title->getArticleID(),
 335                         'rc_user'       => $user->getID(),
 336                         'rc_user_text'  => $user->getName(),
 337                         'rc_comment'    => $comment,
 338                         'rc_this_oldid' => 0,
 339                         'rc_last_oldid' => 0,
 340                         'rc_bot'        => 0,
 341                         'rc_moved_to_ns'        => 0,
 342                         'rc_moved_to_title'     => '',
 343                         'rc_ip' => $ip,
 344                         'rc_patrolled' => 1,
 345                         'rc_new'        => 0 # obsolete
 346                 );
 347                 $rc->mExtra =  array(
 348                         'prefixedDBkey' => $title->getPrefixedDBkey(),
 349                         'lastTimestamp' => 0
 350                 );
 351                 $rc->save();
 352         }
 353
 354         # Initialises the members of this object from a mysql row object
 355         function loadFromRow( $row )
 356         {
 357                 $this->mAttribs = get_object_vars( $row );
 358                 $this->mExtra = array();
 359         }
 360
 361         # Makes a pseudo-RC entry from a cur row, for watchlists and things
 362         function loadFromCurRow( $row )
 363         {
 364                 $this->mAttribs = array(
 365                         'rc_timestamp' => $row->rev_timestamp,
 366                         'rc_cur_time' => $row->rev_timestamp,
 367                         'rc_user' => $row->rev_user,
 368                         'rc_user_text' => $row->rev_user_text,
 369                         'rc_namespace' => $row->page_namespace,
 370                         'rc_title' => $row->page_title,
 371                         'rc_comment' => $row->rev_comment,
 372                         'rc_minor' => $row->rev_minor_edit ? 1 : 0,
 373                         'rc_type' => $row->page_is_new ? RC_NEW : RC_EDIT,
 374                         'rc_cur_id' => $row->page_id,
 375                         'rc_this_oldid' => (int)$row->rev_id,
 376                         'rc_last_oldid' => 0,
 377                         'rc_bot'        => 0,
 378                         'rc_moved_to_ns'        => 0,
 379                         'rc_moved_to_title'     => '',
 380                         'rc_ip' => '',
 381                         'rc_patrolled' => '1',  # we can't support patrolling on the Watchlist
 382                                                 # currently because it uses cur, not recentchanges
 383                         'rc_new' => $row->page_is_new # obsolete
 384                 );
 385
 386                 $this->mExtra = array();
 387         }
 388
 389
 390         /**
 391          * Gets the end part of the diff URL assoicated with this object
 392          * Blank if no diff link should be displayed
 393          */
 394         function diffLinkTrail( $forceCur )
 395         {
 396                 if ( $this->mAttribs['rc_type'] == RC_EDIT ) {
 397                         $trail = "curid=" . (int)($this->mAttribs['rc_cur_id']) .
 398                                 "&oldid=" . (int)($this->mAttribs['rc_last_oldid']);
 399                         if ( $forceCur ) {
 400                                 $trail .= '&diff=0' ;
 401                         } else {
 402                                 $trail .= '&diff=' . (int)($this->mAttribs['rc_this_oldid']);
 403                         }
 404                 } else {
 405                         $trail = '';
 406                 }
 407                 return $trail;
 408         }
 409
 410         function getIRCLine() {
 411                 extract($this->mAttribs);
 412                 extract($this->mExtra);
 413
 414                 $titleObj =& $this->getTitle();
 415
 416                 $bad = array("\n", "\r");
 417                 $empty = array("", "");
 418                 $title = $titleObj->getPrefixedText();
 419                 $title = str_replace($bad, $empty, $title);
 420
 421                 if ( $rc_new ) {
 422                         $url = $titleObj->getFullURL();
 423                 } else {
 424                         $url = $titleObj->getFullURL("diff=0&oldid=$rc_last_oldid");
 425                 }
 426
 427                 if ( isset( $oldSize ) && isset( $newSize ) ) {
 428                         $szdiff = $newSize - $oldSize;
 429                         if ($szdiff < -500)
 430                                 $szdiff = "\002$szdiff\002";
 431                         else if ($szdiff >= 0)
 432                                 $szdiff = "+$szdiff";
 433                         $szdiff = "($szdiff)";
 434                 } else {
 435                         $szdiff = '';
 436                 }
 437
 438                 $comment = str_replace($bad, $empty, $rc_comment);
 439                 $user = str_replace($bad, $empty, $rc_user_text);
 440                 $flag = ($rc_minor ? "M" : "") . ($rc_new ? "N" : "");
 441                 # see http://www.irssi.org/?page=docs&doc=formats for some colour codes. prefix is \003,
 442                 # no colour (\003) switches back to the term default
 443                 $comment = preg_replace("/\/\* (.*) \*\/(.*)/", "\00315\$1\003 - \00310\$2\003", $comment);
 444                 $fullString = "\00314[[\00307$title\00314]]\0034 $flag\00310 " .
 445                               "\00302$url\003 \0035*\003 \00303$user\003 \0035*\003 $szdiff \00310$comment\003\n";
 446
 447                 return $fullString;
 448         }
 449 }
 450 ?>