Per comments on r88145: unlink file if it is broken
[lhc/web/wiklou.git] / includes / ChangesList.php
index 59bb7b2..f25678d 100644 (file)
@@ -37,8 +37,11 @@ class ChangesList {
         * @var Skin
         */
        public $skin;
+
        protected $watchlist = false;
-       
+
+       protected $message;
+
        /**
        * Changeslist contructor
        * @param $skin Skin
@@ -53,7 +56,7 @@ class ChangesList {
         * Some users might want to use an enhanced list format, for instance
         *
         * @param $user User to fetch the list class for
-        * @return ChangesList derivative
+        * @return ChangesList|EnhancedChangesList|OldChangesList derivative
         */
        public static function newFromUser( $user ) {
                global $wgRequest;
@@ -67,7 +70,7 @@ class ChangesList {
                        return $list;
                }
        }
-       
+
        /**
         * Sets the list to use a <li class="watchlist-(namespace)-(page)"> tag
         * @param $value Boolean
@@ -111,17 +114,17 @@ class ChangesList {
         * unpatrolled edit.  By default in English it will contain "N", "m", "b",
         * "!" respectively, plus it will have an appropriate title and class.
         *
-        * @param $key String: 'newpage', 'unpatrolled', 'minor', or 'bot'
+        * @param $flag String: 'newpage', 'unpatrolled', 'minor', or 'bot'
         * @return String: Raw HTML
         */
        public static function flag( $flag ) {
                static $messages = null;
                if ( is_null( $messages ) ) {
-                       $messages = array( 
+                       $messages = array(
                                'newpage' => array( 'newpageletter', 'recentchanges-label-newpage' ),
                                'minoredit' => array( 'minoreditletter', 'recentchanges-label-minor' ),
                                'botedit' => array( 'boteditletter', 'recentchanges-label-bot' ),
-                               'unpatrolled' => array( 'unpatrolledletter', 'recentchanges-label-unpatrolled' ), 
+                               'unpatrolled' => array( 'unpatrolledletter', 'recentchanges-label-unpatrolled' ),
                        );
                        foreach( $messages as &$value ) {
                                $value[0] = wfMsgExt( $value[0], 'escapenoentities' );
@@ -155,12 +158,12 @@ class ChangesList {
                $this->rclistOpen = false;
                return '';
        }
-       
+
        /**
         * Show formatted char difference
         * @param $old Integer: bytes
         * @param $new Integer: bytes
-        * @returns String
+        * @return String
         */
        public static function showCharacterDifference( $old, $new ) {
                global $wgRCChangedSizeThreshold, $wgLang, $wgMiserMode;
@@ -171,29 +174,29 @@ class ChangesList {
                if ( !isset($fastCharDiff[$code]) ) {
                        $fastCharDiff[$code] = $wgMiserMode || wfMsgNoTrans( 'rc-change-size' ) === '$1';
                }
-                       
+
                $formatedSize = $wgLang->formatNum($szdiff);
 
                if ( !$fastCharDiff[$code] ) {
                        $formatedSize = wfMsgExt( 'rc-change-size', array( 'parsemag', 'escape' ), $formatedSize );
                }
-                       
+
                if( abs( $szdiff ) > abs( $wgRCChangedSizeThreshold ) ) {
                        $tag = 'strong';
                } else {
-                   $tag = 'span';
+                       $tag = 'span';
                }
                if( $szdiff === 0 ) {
                        return "<$tag class='mw-plusminus-null'>($formatedSize)</$tag>";
                } elseif( $szdiff > 0 ) {
                        return "<$tag class='mw-plusminus-pos'>(+$formatedSize)</$tag>";
-           } else {
+               } else {
                        return "<$tag class='mw-plusminus-neg'>($formatedSize)</$tag>";
                }
        }
 
        /**
-        * Returns text for the end of RC
+        * Returns text for the end of RC
         * @return String
         */
        public function endRecentChangesList() {
@@ -276,7 +279,7 @@ class ChangesList {
                # Diff link
                if( $rc->mAttribs['rc_type'] == RC_NEW || $rc->mAttribs['rc_type'] == RC_LOG ) {
                        $diffLink = $this->message['diff'];
-               } else if( !self::userCan($rc,Revision::DELETED_TEXT) ) {
+               } elseif( !self::userCan($rc,Revision::DELETED_TEXT) ) {
                        $diffLink = $this->message['diff'];
                } else {
                        $query = array(
@@ -367,7 +370,7 @@ class ChangesList {
         */
        public function insertTimestamp( &$s, $rc ) {
                global $wgLang;
-               $s .= $this->message['semicolon-separator'] . 
+               $s .= $this->message['semicolon-separator'] .
                        $wgLang->time( $rc->mAttribs['rc_timestamp'], true, true ) . ' . . ';
        }
 
@@ -471,7 +474,7 @@ class ChangesList {
                        return '<span class="mw-rc-unwatched">' . $link . '</span>';
                }
        }
-       
+
        /** Inserts a rollback link
         *
         * @param $s
@@ -506,7 +509,7 @@ class ChangesList {
        public function insertTags( &$s, &$rc, &$classes ) {
                if ( empty($rc->mAttribs['ts_tags']) )
                        return;
-                       
+
                list($tagSummary, $newClasses) = ChangeTags::formatSummaryRow( $rc->mAttribs['ts_tags'], 'changeslist' );
                $classes = array_merge( $classes, $newClasses );
                $s .= ' ' . $tagSummary;
@@ -565,11 +568,11 @@ class OldChangesList extends ChangesList {
                } else {
                        $this->insertDiffHist( $s, $rc, $unpatrolled );
                        # M, N, b and ! (minor, new, bot and unpatrolled)
-                       $s .= $this->recentChangesFlags( 
+                       $s .= $this->recentChangesFlags(
                                array(
                                        'newpage' => $rc->mAttribs['rc_new'],
                                        'minor' => $rc->mAttribs['rc_minor'],
-                                       'unpatrolled' => $unpatrolled, 
+                                       'unpatrolled' => $unpatrolled,
                                        'bot' => $rc->mAttribs['rc_bot']
                                ),
                                ''
@@ -597,17 +600,17 @@ class OldChangesList extends ChangesList {
                $this->insertRollback( $s, $rc );
                # For subclasses
                $this->insertExtra( $s, $rc, $classes );
-               
+
                # How many users watch this page
                if( $rc->numberofWatchingusers > 0 ) {
-                       $s .= ' ' . wfMsgExt( 'number_of_watching_users_RCview', 
+                       $s .= ' ' . wfMsgExt( 'number_of_watching_users_RCview',
                                array( 'parsemag', 'escape' ), $wgLang->formatNum( $rc->numberofWatchingusers ) );
                }
-               
+
                if( $this->watchlist ) {
                        $classes[] = Sanitizer::escapeClass( 'watchlist-'.$rc->mAttribs['rc_namespace'].'-'.$rc->mAttribs['rc_title'] );
                }
-               
+
                wfRunHooks( 'OldChangesListRecentChangesLine', array(&$this, &$s, $rc) );
 
                wfProfileOut( __METHOD__ );
@@ -638,10 +641,13 @@ class EnhancedChangesList extends ChangesList {
         * Format a line for enhanced recentchange (aka with javascript and block of lines).
         *
         * @param $baseRC RecentChange
+        * @param $watched bool
+        *
+        * @return string
         */
        public function recentChangesLine( &$baseRC, $watched = false ) {
                global $wgLang, $wgUser;
-               
+
                wfProfileIn( __METHOD__ );
 
                # Create a specialised object
@@ -662,7 +668,7 @@ class EnhancedChangesList extends ChangesList {
 
                # Should patrol-related stuff be shown?
                if( $wgUser->useRCPatrol() ) {
-                       $rc->unpatrolled = !$rc->mAttribs['rc_patrolled'];
+                       $rc->unpatrolled = !$rc->mAttribs['rc_patrolled'];
                } else {
                        $rc->unpatrolled = false;
                }
@@ -678,14 +684,14 @@ class EnhancedChangesList extends ChangesList {
                                array(), array( 'redirect' => 'no' ) ),
                                $this->skin->linkKnown( $rc->getMovedToTitle() ) );
                // New unpatrolled pages
-               } else if( $rc->unpatrolled && $type == RC_NEW ) {
+               } elseif( $rc->unpatrolled && $type == RC_NEW ) {
                        $clink = $this->skin->linkKnown( $rc->getTitle(), null, array(),
                                array( 'rcid' => $rc->mAttribs['rc_id'] ) );
                // Log entries
-               } else if( $type == RC_LOG ) {
+               } elseif( $type == RC_LOG ) {
                        if( $logType ) {
                                $logtitle = SpecialPage::getTitleFor( 'Log', $logType );
-                               $clink = '(' . $this->skin->linkKnown( $logtitle, 
+                               $clink = '(' . $this->skin->linkKnown( $logtitle,
                                        LogPage::logName( $logType ) ) . ')';
                        } else {
                                $clink = $this->skin->link( $rc->getTitle() );
@@ -734,7 +740,7 @@ class EnhancedChangesList extends ChangesList {
                if( !$showdifflinks ) {
                        $curLink = $this->message['cur'];
                        $diffLink = $this->message['diff'];
-               } else if( in_array( $type, array( RC_NEW, RC_LOG, RC_MOVE, RC_MOVE_OVER_REDIRECT ) ) ) {
+               } elseif( in_array( $type, array( RC_NEW, RC_LOG, RC_MOVE, RC_MOVE_OVER_REDIRECT ) ) ) {
                        if ( $type != RC_NEW ) {
                                $curLink = $this->message['cur'];
                        } else {
@@ -752,7 +758,7 @@ class EnhancedChangesList extends ChangesList {
                # Make "last" link
                if( !$showdifflinks || !$lastOldid ) {
                        $lastLink = $this->message['last'];
-               } else if( in_array( $type, array( RC_LOG, RC_MOVE, RC_MOVE_OVER_REDIRECT ) ) ) {
+               } elseif( in_array( $type, array( RC_LOG, RC_MOVE, RC_MOVE_OVER_REDIRECT ) ) ) {
                        $lastLink = $this->message['last'];
                } else {
                        $lastLink = $this->skin->linkKnown( $rc->getTitle(), $this->message['last'],
@@ -868,7 +874,7 @@ class EnhancedChangesList extends ChangesList {
                        array_push( $users, $text );
                }
 
-               $users = ' <span class="changedby">[' . 
+               $users = ' <span class="changedby">[' .
                        implode( $this->message['semicolon-separator'], $users ) . ']</span>';
 
                # Title for <a> tags
@@ -887,7 +893,7 @@ class EnhancedChangesList extends ChangesList {
                $r .= '<td class="mw-enhanced-rc">' . $this->recentChangesFlags( array(
                        'newpage' => $isnew,
                        'minor' => false,
-                       'unpatrolled' => $unpatrolled, 
+                       'unpatrolled' => $unpatrolled,
                        'bot' => $bot ,
                ) );
 
@@ -897,7 +903,7 @@ class EnhancedChangesList extends ChangesList {
                # Article link
                if( $namehidden ) {
                        $r .= ' <span class="history-deleted">' . wfMsgHtml( 'rev-deleted-event' ) . '</span>';
-               } else if( $allLogs ) {
+               } elseif( $allLogs ) {
                        $r .= $this->maybeWatchedLink( $block[0]->link, $block[0]->watched );
                } else {
                        $this->insertArticleLink( $r, $block[0], $block[0]->unpatrolled, $block[0]->watched );
@@ -918,13 +924,13 @@ class EnhancedChangesList extends ChangesList {
                        $r .= '(';
                        if( !ChangesList::userCan( $rcObj, Revision::DELETED_TEXT ) ) {
                                $r .= $nchanges[$n];
-                       } else if( $isnew ) {
+                       } elseif( $isnew ) {
                                $r .= $nchanges[$n];
                        } else {
                                $params = $queryParams;
                                $params['diff'] = $currentRevision;
                                $params['oldid'] = $oldid;
-                               
+
                                $r .= $this->skin->link(
                                        $block[0]->getTitle(),
                                        $nchanges[$n],
@@ -938,7 +944,7 @@ class EnhancedChangesList extends ChangesList {
                # History
                if( $allLogs ) {
                        // don't show history link for logs
-               } else if( $namehidden || !$block[0]->getTitle()->exists() ) {
+               } elseif( $namehidden || !$block[0]->getTitle()->exists() ) {
                        $r .= $this->message['pipe-separator'] . $this->message['hist'] . ')';
                } else {
                        $params = $queryParams;
@@ -991,7 +997,7 @@ class EnhancedChangesList extends ChangesList {
                        $r .= $this->recentChangesFlags( array(
                                'newpage' => $rcObj->mAttribs['rc_new'],
                                'minor' => $rcObj->mAttribs['rc_minor'],
-                               'unpatrolled' => $rcObj->unpatrolled, 
+                               'unpatrolled' => $rcObj->unpatrolled,
                                'bot' => $rcObj->mAttribs['rc_bot'],
                        ) );
                        $r .= '&#160;</td><td class="mw-enhanced-rc-nested"><span class="mw-enhanced-rc-time">';
@@ -1006,7 +1012,7 @@ class EnhancedChangesList extends ChangesList {
                        if( $type == RC_LOG ) {
                                $link = $rcObj->timestamp;
                        # Revision link
-                       } else if( !ChangesList::userCan($rcObj,Revision::DELETED_TEXT) ) {
+                       } elseif( !ChangesList::userCan($rcObj,Revision::DELETED_TEXT) ) {
                                $link = '<span class="history-deleted">'.$rcObj->timestamp.'</span> ';
                        } else {
                                if ( $rcObj->unpatrolled && $type == RC_NEW) {
@@ -1136,7 +1142,7 @@ class EnhancedChangesList extends ChangesList {
                        $r .= $this->recentChangesFlags( array(
                                'newpage' => $type == RC_NEW,
                                'mino' => $rcObj->mAttribs['rc_minor'],
-                               'unpatrolled' => $rcObj->unpatrolled, 
+                               'unpatrolled' => $rcObj->unpatrolled,
                                'bot' => $rcObj->mAttribs['rc_bot'],
                        ) );
                }
@@ -1201,6 +1207,8 @@ class EnhancedChangesList extends ChangesList {
        /**
         * If enhanced RC is in use, this function takes the previously cached
         * RC lines, arranges them, and outputs the HTML
+        *
+        * @return string
         */
        protected function recentChangesBlock() {
                if( count ( $this->rc_cache ) == 0 ) {
@@ -1224,7 +1232,7 @@ class EnhancedChangesList extends ChangesList {
        }
 
        /**
-        * Returns text for the end of RC
+        * Returns text for the end of RC
         * If enhanced RC is in use, returns pretty much all the text
         */
        public function endRecentChangesList() {