MS Office creates vulnerabilities also, per comment on r72890.
[lhc/web/wiklou.git] / includes / Credits.php
index 6721687..e4c8be5 100644 (file)
 <?php
 /**
- * Credits.php -- formats credits for articles
+ * Formats credits for articles
+ *
  * Copyright 2004, Evan Prodromou <evan@wikitravel.org>.
  *
- *  This program is free software; you can redistribute it and/or modify
- *  it under the terms of the GNU General Public License as published by
- *  the Free Software Foundation; either version 2 of the License, or
- *  (at your option) any later version.
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
  *
- *  This program is distributed in the hope that it will be useful,
- *  but WITHOUT ANY WARRANTY; without even the implied warranty of
- *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *  GNU General Public License for more details.
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
  *
- *  You should have received a copy of the GNU General Public License
- *  along with this program; if not, write to the Free Software
- *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  *
+ * @file
  * @author <evan@wikitravel.org>
- * @package MediaWiki
  */
 
-/**
- * This is largely cadged from PageHistory::history
- */
 class Credits {
-       function showCreditsPage($article) {
+       /**
+        * This is largely cadged from PageHistory::history
+        * @param $article Article object
+        */
+       public static function showPage( Article $article ) {
                global $wgOut;
 
-               $fname = 'Credits::showCreditsPage';
+               wfProfileIn( __METHOD__ );
 
-               wfProfileIn( $fname );
-       
                $wgOut->setPageTitle( $article->mTitle->getPrefixedText() );
                $wgOut->setSubtitle( wfMsg( 'creditspage' ) );
                $wgOut->setArticleFlag( false );
                $wgOut->setArticleRelated( true );
-               $wgOut->setRobotpolicy( 'noindex,nofollow' );
+               $wgOut->setRobotPolicy( 'noindex,nofollow' );
 
-               if( $article->mTitle->getArticleID() == 0 ) {
+               if ( $article->mTitle->getArticleID() == 0 ) {
                        $s = wfMsg( 'nocredits' );
                } else {
-                       $s = Credits::getCredits($article, -1);
+                       $s = self::getCredits( $article, -1 );
                }
 
                $wgOut->addHTML( $s );
 
-               wfProfileOut( $fname );
+               wfProfileOut( __METHOD__ );
        }
 
-       function getCredits($article, $cnt, $showIfMax=true) {
-               $fname = 'Credits::getCredits';
-               wfProfileIn( $fname );
+       /**
+        * Get a list of contributors of $article
+        * @param $article Article object
+        * @param $cnt Int: maximum list of contributors to show
+        * @param $showIfMax Bool: whether to contributors if there more than $cnt
+        * @return String: html
+        */
+       public static function getCredits( Article $article, $cnt, $showIfMax = true ) {
+               wfProfileIn( __METHOD__ );
                $s = '';
 
-               if (isset($cnt) && $cnt != 0) {
-                       $s = Credits::getAuthorCredits($article);
-                       if ($cnt > 1 || $cnt < 0) {
-                               $s .= ' ' . Credits::getContributorCredits($article, $cnt - 1, $showIfMax);
+               if ( isset( $cnt ) && $cnt != 0 ) {
+                       $s = self::getAuthor( $article );
+                       if ( $cnt > 1 || $cnt < 0 ) {
+                               $s .= ' ' . self::getContributors( $article, $cnt - 1, $showIfMax );
                        }
                }
 
-               wfProfileOut( $fname );
+               wfProfileOut( __METHOD__ );
                return $s;
        }
 
        /**
-        *
+        * Get the last author with the last modification time
+        * @param $article Article object
         */
-       function getAuthorCredits($article) {
-               global $wgLang, $wgAllowRealName;
-
-               $last_author = $article->getUser();
+       protected static function getAuthor( Article $article ) {
+               global $wgLang;
 
-               if ($last_author == 0) {
-                       $author_credit = wfMsg('anonymous');
-               } else {
-                       if($wgAllowRealName) { $real_name = User::whoIsReal($last_author); }
-                       $user_name = User::whoIs($last_author);
-
-                       if (!empty($real_name)) {
-                               $author_credit = Credits::creditLink($user_name, $real_name);
-                       } else {
-                               $author_credit = wfMsg('siteuser', Credits::creditLink($user_name));
-                       }
-               }
+               $user = User::newFromId( $article->getUser() );
 
                $timestamp = $article->getTimestamp();
-               if ($timestamp) {
-                       $d = $wgLang->timeanddate($article->getTimestamp(), true);
+               if ( $timestamp ) {
+                       $d = $wgLang->date( $article->getTimestamp(), true );
+                       $t = $wgLang->time( $article->getTimestamp(), true );
                } else {
                        $d = '';
+                       $t = '';
                }
-               return wfMsg('lastmodifiedby', $d, $author_credit);
+               return wfMsgExt( 'lastmodifiedatby', 'parsemag', $d, $t, self::userLink( $user ), $user->getName() );
        }
 
        /**
-        *
+        * Get a list of contributors of $article
+        * @param $article Article object
+        * @param $cnt Int: maximum list of contributors to show
+        * @param $showIfMax Bool: whether to contributors if there more than $cnt
+        * @return String: html
         */
-       function getContributorCredits($article, $cnt, $showIfMax) {
-
-               global $wgLang, $wgAllowRealName;
+       protected static function getContributors( Article $article, $cnt, $showIfMax ) {
+               global $wgLang, $wgHiddenPrefs;
 
                $contributors = $article->getContributors();
 
-               $others_link = '';
+               $others_link = false;
 
                # Hmm... too many to fit!
-
-               if ($cnt > 0 && count($contributors) > $cnt) {
-                       $others_link = Credits::creditOthersLink($article);
-                       if (!$showIfMax) {
-                               return wfMsg('othercontribs', $others_link);
-                       } else {
-                               $contributors = array_slice($contributors, 0, $cnt);
-                       }
+               if ( $cnt > 0 && $contributors->count() > $cnt ) {
+                       $others_link = self::othersLink( $article );
+                       if ( !$showIfMax )
+                               return wfMsgExt( 'othercontribs', 'parsemag', $others_link, $contributors->count() );
                }
 
                $real_names = array();
                $user_names = array();
-
-               $anon = '';
+               $anon_ips = array();
 
                # Sift for real versus user names
-
-               foreach ($contributors as $user_parts) {
-                       if ($user_parts[0] != 0) {
-                               if ($wgAllowRealName && !empty($user_parts[2])) {
-                                       $real_names[] = Credits::creditLink($user_parts[1], $user_parts[2]);
+               foreach ( $contributors as $user ) {
+                       $cnt--;
+                       if ( $user->isLoggedIn() ) {
+                               $link = self::link( $user );
+                               if ( !in_array( 'realname', $wgHiddenPrefs ) && $user->getRealName() ) {
+                                       $real_names[] = $link;
                                } else {
-                                       $user_names[] = Credits::creditLink($user_parts[1]);
+                                       $user_names[] = $link;
                                }
                        } else {
-                               $anon = wfMsg('anonymous');
+                               $anon_ips[] = self::link( $user );
                        }
-               }
 
-               # Two strings: real names, and user names
+                       if ( $cnt == 0 ) {
+                               break;
+                       }
+               }
 
-               $real = $wgLang->listToText($real_names);
-               $user = $wgLang->listToText($user_names);
+               if ( count( $real_names ) ) {
+                       $real = $wgLang->listToText( $real_names );
+               } else {
+                       $real = false;
+               }
 
                # "ThisSite user(s) A, B and C"
+               if ( count( $user_names ) ) {
+                       $user = wfMsgExt(
+                               'siteusers',
+                               'parsemag',
+                               $wgLang->listToText( $user_names ), count( $user_names )
+                       );
+               } else {
+                       $user = false;
+               }
 
-               if (!empty($user)) {
-                       $user = wfMsg('siteusers', $user);
+               if ( count( $anon_ips ) ) {
+                       $anon = wfMsgExt(
+                               'anonusers',
+                               'parsemag',
+                               $wgLang->listToText( $anon_ips ), count( $anon_ips )
+                       );
+               } else {
+                       $anon = false;
                }
 
                # This is the big list, all mooshed together. We sift for blank strings
-
                $fulllist = array();
-
-               foreach (array($real, $user, $anon, $others_link) as $s) {
-                       if (!empty($s)) {
-                               array_push($fulllist, $s);
+               foreach ( array( $real, $user, $anon, $others_link ) as $s ) {
+                       if ( $s ) {
+                               array_push( $fulllist, $s );
                        }
                }
 
                # Make the list into text...
-
-               $creds = $wgLang->listToText($fulllist);
+               $creds = $wgLang->listToText( $fulllist );
 
                # "Based on work by ..."
-
-               return (empty($creds)) ? '' : wfMsg('othercontribs', $creds);
+               return strlen( $creds )
+                       ? wfMsgExt( 'othercontribs', 'parsemag', $creds, count( $fulllist ) )
+                       : '';
        }
 
        /**
-        *
+        * Get a link to $user's user page
+        * @param $user User object
+        * @return String: html
         */
-       function creditLink($user_name, $link_text = '') {
-               global $wgUser, $wgContLang;
+       protected static function link( User $user ) {
+               global $wgUser, $wgHiddenPrefs;
+               if ( !in_array( 'realname', $wgHiddenPrefs ) && !$user->isAnon() ) {
+                       $real = $user->getRealName();
+               } else {
+                       $real = false;
+               }
+
                $skin = $wgUser->getSkin();
-               return $skin->makeLink($wgContLang->getNsText(NS_USER) . ':' . $user_name,
-                                      htmlspecialchars( (empty($link_text)) ? $user_name : $link_text ));
+               $page = $user->isAnon() ?
+                       SpecialPage::getTitleFor( 'Contributions', $user->getName() ) :
+                       $user->getUserPage();
+
+               return $skin->link( $page, htmlspecialchars( $real ? $real : $user->getName() ) );
+       }
+
+       /**
+        * Get a link to $user's user page
+        * @param $user User object
+        * @return String: html
+        */
+       protected static function userLink( User $user ) {
+               $link = self::link( $user );
+               if ( $user->isAnon() ) {
+                       return wfMsgExt( 'anonuser', array( 'parseinline', 'replaceafter' ), $link );
+               } else {
+                       global $wgHiddenPrefs;
+                       if ( !in_array( 'realname', $wgHiddenPrefs ) && $user->getRealName() ) {
+                               return $link;
+                       } else {
+                               return wfMsgExt( 'siteuser', 'parsemag', $link, $user->getName() );
+                       }
+               }
        }
 
        /**
-        *
+        * Get a link to action=credits of $article page
+        * @param $article Article object
+        * @return String: html
         */
-       function creditOthersLink($article) {
+       protected static function othersLink( Article $article ) {
                global $wgUser;
                $skin = $wgUser->getSkin();
-               return $skin->makeKnownLink($article->mTitle->getPrefixedText(), wfMsg('others'), 'action=credits');
+               return $skin->link(
+                       $article->getTitle(),
+                       wfMsgHtml( 'others' ),
+                       array(),
+                       array( 'action' => 'credits' ),
+                       array( 'known' )
+               );
        }
 }
-?>