* (bug 33483) One space to much in header of auto-generated documentation
[lhc/web/wiklou.git] / includes / RecentChange.php
index a3deb91..6463ad0 100644 (file)
@@ -58,12 +58,20 @@ class RecentChange {
 
        # Factory methods
 
+       /**
+        * @param $row
+        * @return RecentChange
+        */
        public static function newFromRow( $row ) {
                $rc = new RecentChange;
                $rc->loadFromRow( $row );
                return $rc;
        }
 
+       /**
+        * @staticw
+        * @return RecentChange
+        */
        public static function newFromCurRow( $row ) {
                $rc = new RecentChange;
                $rc->loadFromCurRow( $row );
@@ -137,6 +145,9 @@ class RecentChange {
                return $this->mTitle;
        }
 
+       /**
+        * @return bool|\Title
+        */
        public function getMovedToTitle() {
                if( $this->mMovedToTitle === false ) {
                        $this->mMovedToTitle = Title::makeTitle( $this->mAttribs['rc_moved_to_ns'],
@@ -145,10 +156,12 @@ class RecentChange {
                return $this->mMovedToTitle;
        }
 
-       # Writes the data in this object to the database
-       public function save() {
-               global $wgLocalInterwiki, $wgPutIPinRC, $wgRC2UDPAddress, $wgRC2UDPOmitBots;
-               $fname = 'RecentChange::save';
+       /**
+        * Writes the data in this object to the database
+        * @param $noudp bool 
+        */
+       public function save( $noudp = false ) {
+               global $wgLocalInterwiki, $wgPutIPinRC;
 
                $dbw = wfGetDB( DB_MASTER );
                if( !is_array($this->mExtra) ) {
@@ -176,17 +189,17 @@ class RecentChange {
                }
 
                # Insert new row
-               $dbw->insert( 'recentchanges', $this->mAttribs, $fname );
+               $dbw->insert( 'recentchanges', $this->mAttribs, __METHOD__ );
 
                # Set the ID
                $this->mAttribs['rc_id'] = $dbw->insertId();
-               
+
                # Notify extensions
                wfRunHooks( 'RecentChange_save', array( &$this ) );
 
                # Notify external application via UDP
-               if( $wgRC2UDPAddress && ( !$this->mAttribs['rc_bot'] || !$wgRC2UDPOmitBots ) ) {
-                       self::sendToUDP( $this->getIRCLine() );
+               if ( !$noudp ) {
+                       $this->notifyRC2UDP();
                }
 
                # E-mail notifications
@@ -194,11 +207,11 @@ class RecentChange {
                if( $wgUseEnotif || $wgShowUpdatedMarker ) {
                        // Users
                        if( $this->mAttribs['rc_user'] ) {
-                               $editor = ($wgUser->getId() == $this->mAttribs['rc_user']) ? 
+                               $editor = ($wgUser->getId() == $this->mAttribs['rc_user']) ?
                                        $wgUser : User::newFromID( $this->mAttribs['rc_user'] );
                        // Anons
                        } else {
-                               $editor = ($wgUser->getName() == $this->mAttribs['rc_user_text']) ? 
+                               $editor = ($wgUser->getName() == $this->mAttribs['rc_user_text']) ?
                                        $wgUser : User::newFromName( $this->mAttribs['rc_user_text'], false );
                        }
                        # @todo FIXME: This would be better as an extension hook
@@ -211,7 +224,7 @@ class RecentChange {
                                $this->mAttribs['rc_last_oldid'] );
                }
        }
-       
+
        public function notifyRC2UDP() {
                global $wgRC2UDPAddress, $wgRC2UDPOmitBots;
                # Notify external application via UDP
@@ -250,7 +263,7 @@ class RecentChange {
                }
                return false;
        }
-       
+
        /**
         * Remove newlines, carriage returns and decode html entites
         * @param $text String
@@ -279,7 +292,7 @@ class RecentChange {
                }
                return $change->doMarkPatrolled( $wgUser, $auto );
        }
-       
+
        /**
         * Mark this RecentChange as patrolled
         *
@@ -321,7 +334,7 @@ class RecentChange {
                wfRunHooks( 'MarkPatrolledComplete', array($this->getAttribute('rc_id'), &$user, false) );
                return array();
        }
-       
+
        /**
         * Mark this RecentChange patrolled, without error checking
         * @return Integer: number of affected rows
@@ -467,75 +480,24 @@ class RecentChange {
                        'newSize' => $size
                );
                $rc->save();
-               return $rc;     
+               return $rc;
        }
 
-       # Makes an entry in the database corresponding to a rename
-
        /**
         * @param $timestamp
-        * @param $oldTitle Title
-        * @param $newTitle Title
-        * @param $user User
-        * @param $comment
+        * @param $title
+        * @param $user
+        * @param $actionComment
         * @param $ip string
-        * @param $overRedir bool
-        * @return void
+        * @param $type
+        * @param $action
+        * @param $target
+        * @param $logComment
+        * @param $params
+        * @param $newId int
+        * @return bool
         */
-       public static function notifyMove( $timestamp, &$oldTitle, &$newTitle, &$user, $comment, $ip='',
-               $overRedir = false ) {
-               global $wgRequest;
-               if( !$ip ) {
-                       $ip = $wgRequest->getIP();
-                       if( !$ip ) $ip = '';
-               }
-
-               $rc = new RecentChange;
-               $rc->mAttribs = array(
-                       'rc_timestamp'  => $timestamp,
-                       'rc_cur_time'   => $timestamp,
-                       'rc_namespace'  => $oldTitle->getNamespace(),
-                       'rc_title'      => $oldTitle->getDBkey(),
-                       'rc_type'       => $overRedir ? RC_MOVE_OVER_REDIRECT : RC_MOVE,
-                       'rc_minor'      => 0,
-                       'rc_cur_id'     => $oldTitle->getArticleID(),
-                       'rc_user'       => $user->getId(),
-                       'rc_user_text'  => $user->getName(),
-                       'rc_comment'    => $comment,
-                       'rc_this_oldid' => 0,
-                       'rc_last_oldid' => 0,
-                       'rc_bot'        => $user->isAllowed( 'bot' ) ? $wgRequest->getBool( 'bot' , true ) : 0,
-                       'rc_moved_to_ns' => $newTitle->getNamespace(),
-                       'rc_moved_to_title' => $newTitle->getDBkey(),
-                       'rc_ip'         => $ip,
-                       'rc_new'        => 0, # obsolete
-                       'rc_patrolled'  => 1,
-                       'rc_old_len'    => null,
-                       'rc_new_len'    => null,
-                       'rc_deleted'    => 0,
-                       'rc_logid'      => 0, # notifyMove not used anymore
-                       'rc_log_type'   => null,
-                       'rc_log_action' => '',
-                       'rc_params'     => ''
-               );
-
-               $rc->mExtra = array(
-                       'prefixedDBkey' => $oldTitle->getPrefixedDBkey(),
-                       'lastTimestamp' => 0,
-                       'prefixedMoveTo' => $newTitle->getPrefixedDBkey()
-               );
-               $rc->save();
-       }
-
-       public static function notifyMoveToNew( $timestamp, &$oldTitle, &$newTitle, &$user, $comment, $ip='' ) {
-               RecentChange::notifyMove( $timestamp, $oldTitle, $newTitle, $user, $comment, $ip, false );
-       }
-
-       public static function notifyMoveOverRedirect( $timestamp, &$oldTitle, &$newTitle, &$user, $comment, $ip='' ) {
-               RecentChange::notifyMove( $timestamp, $oldTitle, $newTitle, $user, $comment, $ip, true );
-       }
-
-       public static function notifyLog( $timestamp, &$title, &$user, $actionComment, $ip='', $type, 
+       public static function notifyLog( $timestamp, &$title, &$user, $actionComment, $ip='', $type,
                $action, $target, $logComment, $params, $newId=0 )
        {
                global $wgLogRestrictions;
@@ -609,14 +571,22 @@ class RecentChange {
                return $rc;
        }
 
-       # Initialises the members of this object from a mysql row object
+       /**
+        * Initialises the members of this object from a mysql row object
+        *
+        * @param $row
+        */
        public function loadFromRow( $row ) {
                $this->mAttribs = get_object_vars( $row );
                $this->mAttribs['rc_timestamp'] = wfTimestamp(TS_MW, $this->mAttribs['rc_timestamp']);
                $this->mAttribs['rc_deleted'] = $row->rc_deleted; // MUST be set
        }
 
-       # Makes a pseudo-RC entry from a cur row
+       /**
+        * Makes a pseudo-RC entry from a cur row
+        *
+        * @param $row
+        */
        public function loadFromCurRow( $row ) {
                $this->mAttribs = array(
                        'rc_timestamp' => wfTimestamp(TS_MW, $row->rev_timestamp),
@@ -658,6 +628,9 @@ class RecentChange {
                return isset( $this->mAttribs[$name] ) ? $this->mAttribs[$name] : null;
        }
 
+       /**
+        * @return array
+        */
        public function getAttributes() {
                return $this->mAttribs;
        }
@@ -665,6 +638,8 @@ class RecentChange {
        /**
         * Gets the end part of the diff URL associated with this object
         * Blank if no diff link should be displayed
+        * @param $forceCur
+        * @return string
         */
        public function diffLinkTrail( $forceCur ) {
                if( $this->mAttribs['rc_type'] == RC_EDIT ) {
@@ -681,11 +656,15 @@ class RecentChange {
                return $trail;
        }
 
+       /**
+        * @return string
+        */
        public function getIRCLine() {
-               global $wgUseRCPatrol, $wgUseNPPatrol, $wgRC2UDPInterwikiPrefix, $wgLocalInterwiki;
+               global $wgUseRCPatrol, $wgUseNPPatrol, $wgRC2UDPInterwikiPrefix, $wgLocalInterwiki,
+                       $wgCanonicalServer, $wgScript;
 
                if( $this->mAttribs['rc_type'] == RC_LOG ) {
-                       $titleObj = Title::newFromText( 'Log/' . $this->mAttribs['rc_log_type'], NS_SPECIAL );
+                       $titleObj = SpecialPage::getTitleFor( 'Log', $this->mAttribs['rc_log_type'] );
                } else {
                        $titleObj =& $this->getTitle();
                }
@@ -695,25 +674,22 @@ class RecentChange {
                if( $this->mAttribs['rc_type'] == RC_LOG ) {
                        $url = '';
                } else {
+                       $url = $wgCanonicalServer . $wgScript;
                        if( $this->mAttribs['rc_type'] == RC_NEW ) {
-                               $url = 'oldid=' . $this->mAttribs['rc_this_oldid'];
+                               $query = '?oldid=' . $this->mAttribs['rc_this_oldid'];
                        } else {
-                               $url = 'diff=' . $this->mAttribs['rc_this_oldid'] . '&oldid=' . $this->mAttribs['rc_last_oldid'];
+                               $query = '?diff=' . $this->mAttribs['rc_this_oldid'] . '&oldid=' . $this->mAttribs['rc_last_oldid'];
                        }
                        if ( $wgUseRCPatrol || ( $this->mAttribs['rc_type'] == RC_NEW && $wgUseNPPatrol ) ) {
-                               $url .= '&rcid=' . $this->mAttribs['rc_id'];
+                               $query .= '&rcid=' . $this->mAttribs['rc_id'];
                        }
-                       // XXX: *HACK* this should use getFullURL(), hacked for SSL madness --brion 2005-12-26
-                       // XXX: *HACK^2* the preg_replace() undoes much of what getInternalURL() does, but we 
-                       // XXX: need to call it so that URL paths on the Wikimedia secure server can be fixed
-                       // XXX: by a custom GetInternalURL hook --vyznev 2008-12-10
-                       // XXX: Also, getInternalUrl() may return a protocol-relative URL.
-                       // XXX: In that case, expand it to an HTTP URL, even if this is an HTTPS request --catrope 2011-08-17
-                       $url = preg_replace( '/title=[^&]*&/', '', wfExpandUrl( $titleObj->getInternalURL( $url ), PROTO_HTTP ) );
+                       // HACK: We need this hook for WMF's secure server setup
+                       wfRunHooks( 'IRCLineURL', array( &$url, &$query ) );
+                       $url .= $query;
                }
 
-               if( isset( $this->mExtra['oldSize'] ) && isset( $this->mExtra['newSize'] ) ) {
-                       $szdiff = $this->mExtra['newSize'] - $this->mExtra['oldSize'];
+               if( $this->mAttribs['rc_old_len'] !== null && $this->mAttribs['rc_new_len'] !== null ) {
+                       $szdiff = $this->mAttribs['rc_new_len'] - $this->mAttribs['rc_old_len'];
                        if($szdiff < -500) {
                                $szdiff = "\002$szdiff\002";
                        } elseif($szdiff >= 0) {
@@ -751,18 +727,21 @@ class RecentChange {
                } else {
                        $titleString = "\00314[[\00307$title\00314]]";
                }
-               
+
                # see http://www.irssi.org/documentation/formats for some colour codes. prefix is \003,
                # no colour (\003) switches back to the term default
                $fullString = "$titleString\0034 $flag\00310 " .
                              "\00302$url\003 \0035*\003 \00303$user\003 \0035*\003 $szdiff \00310$comment\003\n";
-                       
+
                return $fullString;
        }
 
        /**
         * Returns the change size (HTML).
         * The lengths can be given optionally.
+        * @param $old int
+        * @param $new int
+        * @return string
         */
        public function getCharacterDifference( $old = 0, $new = 0 ) {
                if( $old === 0 ) {