<?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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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
*/
-function showCreditsPage($article) {
- global $wgOut;
- $fname = 'showCreditsPage';
+class Credits {
+ /**
+ * This is largely cadged from PageHistory::history
+ * @param $article Article object
+ */
+ public static function showPage( Article $article ) {
+ global $wgOut;
- wfProfileIn( $fname );
+ wfProfileIn( __METHOD__ );
- $wgOut->setPageTitle( $article->mTitle->getPrefixedText() );
- $wgOut->setSubtitle( wfMsg( 'creditspage' ) );
- $wgOut->setArticleFlag( false );
- $wgOut->setArticleRelated( true );
- $wgOut->setRobotpolicy( 'noindex,nofollow' );
-
- if( $article->mTitle->getArticleID() == 0 ) {
- $s = wfMsg( 'nocredits' );
- } else {
- $s = getCredits($article, -1);
- }
-
- $wgOut->addHTML( $s );
-
- wfProfileOut( $fname );
-}
+ $wgOut->setPageTitle( $article->mTitle->getPrefixedText() );
+ $wgOut->setSubtitle( wfMsg( 'creditspage' ) );
+ $wgOut->setArticleFlag( false );
+ $wgOut->setArticleRelated( true );
+ $wgOut->setRobotPolicy( 'noindex,nofollow' );
-function getCredits($article, $cnt, $showIfMax=true) {
- $fname = 'getCredits';
- wfProfileIn( $fname );
- $s = '';
-
- if (isset($cnt) && $cnt != 0) {
- $s = getAuthorCredits($article);
- if ($cnt > 1 || $cnt < 0) {
- $s .= ' ' . getContributorCredits($article, $cnt - 1, $showIfMax);
+ if ( $article->mTitle->getArticleID() == 0 ) {
+ $s = wfMsg( 'nocredits' );
+ } else {
+ $s = self::getCredits( $article, -1 );
}
- }
- wfProfileOut( $fname );
- return $s;
-}
+ $wgOut->addHTML( $s );
+
+ wfProfileOut( __METHOD__ );
+ }
+
+ /**
+ * 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 = self::getAuthor( $article );
+ if ( $cnt > 1 || $cnt < 0 ) {
+ $s .= ' ' . self::getContributors( $article, $cnt - 1, $showIfMax );
+ }
+ }
-/**
- *
- */
-function getAuthorCredits($article) {
- global $wgLang, $wgAllowRealName;
+ wfProfileOut( __METHOD__ );
+ return $s;
+ }
- $last_author = $article->getUser();
+ /**
+ * Get the last author with the last modification time
+ * @param $article Article object
+ */
+ 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);
+ $user = User::newFromId( $article->getUser() );
- if (!empty($real_name)) {
- $author_credit = creditLink($user_name, $real_name);
+ $timestamp = $article->getTimestamp();
+ if ( $timestamp ) {
+ $d = $wgLang->date( $article->getTimestamp(), true );
+ $t = $wgLang->time( $article->getTimestamp(), true );
} else {
- $author_credit = wfMsg('siteuser', creditLink($user_name));
+ $d = '';
+ $t = '';
+ }
+ 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
+ */
+ protected static function getContributors( Article $article, $cnt, $showIfMax ) {
+ global $wgLang, $wgHiddenPrefs;
+
+ $contributors = $article->getContributors();
+
+ $others_link = false;
+
+ # Hmm... too many to fit!
+ if ( $cnt > 0 && $contributors->count() > $cnt ) {
+ $others_link = self::othersLink( $article );
+ if ( !$showIfMax )
+ return wfMsgExt( 'othercontribs', 'parsemag', $others_link, $contributors->count() );
}
- }
-
- $timestamp = $article->getTimestamp();
- if ($timestamp) {
- $d = $wgLang->timeanddate($article->getTimestamp(), true);
- } else {
- $d = '';
- }
- return wfMsg('lastmodifiedby', $d, $author_credit);
-}
-
-/**
- *
- */
-function getContributorCredits($article, $cnt, $showIfMax) {
-
- global $wgLang, $wgAllowRealName;
-
- $contributors = $article->getContributors();
- $others_link = '';
+ $real_names = array();
+ $user_names = array();
+ $anon_ips = array();
+
+ # Sift for real versus user names
+ 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[] = $link;
+ }
+ } else {
+ $anon_ips[] = self::link( $user );
+ }
- # Hmm... too many to fit!
+ if ( $cnt == 0 ) {
+ break;
+ }
+ }
- if ($cnt > 0 && count($contributors) > $cnt) {
- $others_link = creditOthersLink($article);
- if (!$showIfMax) {
- return wfMsg('othercontribs', $others_link);
+ if ( count( $real_names ) ) {
+ $real = $wgLang->listToText( $real_names );
} else {
- $contributors = array_slice($contributors, 0, $cnt);
+ $real = false;
}
- }
-
- $real_names = array();
- $user_names = array();
-
- $anon = '';
- # Sift for real versus user names
-
- foreach ($contributors as $user_parts) {
- if ($user_parts[0] != 0) {
- if ($wgAllowRealName && !empty($user_parts[2])) {
- $real_names[] = creditLink($user_parts[1], $user_parts[2]);
- } else {
- $user_names[] = creditLink($user_parts[1]);
- }
+ # "ThisSite user(s) A, B and C"
+ if ( count( $user_names ) ) {
+ $user = wfMsgExt(
+ 'siteusers',
+ 'parsemag',
+ $wgLang->listToText( $user_names ), count( $user_names )
+ );
} else {
- $anon = wfMsg('anonymous');
+ $user = false;
}
- }
-
- # Two strings: real names, and user names
-
- $real = $wgLang->listToText($real_names);
- $user = $wgLang->listToText($user_names);
-
- # "ThisSite user(s) A, B and C"
-
- if (!empty($user)) {
- $user = wfMsg('siteusers', $user);
- }
-
- # 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);
+ if ( count( $anon_ips ) ) {
+ $anon = wfMsgExt(
+ 'anonusers',
+ 'parsemag',
+ $wgLang->listToText( $anon_ips ), count( $anon_ips )
+ );
+ } else {
+ $anon = false;
}
- }
-
- # Make the list into text...
-
- $creds = $wgLang->listToText($fulllist);
- # "Based on work by ..."
-
- return (empty($creds)) ? '' : wfMsg('othercontribs', $creds);
-}
+ # 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 ( $s ) {
+ array_push( $fulllist, $s );
+ }
+ }
-/**
- *
- */
-function creditLink($user_name, $link_text = '') {
- global $wgUser, $wgContLang;
- $skin = $wgUser->getSkin();
- return $skin->makeLink($wgContLang->getNsText(NS_USER) . ':' . $user_name,
- htmlspecialchars( (empty($link_text)) ? $user_name : $link_text ));
-}
+ # Make the list into text...
+ $creds = $wgLang->listToText( $fulllist );
+
+ # "Based on work by ..."
+ return strlen( $creds )
+ ? wfMsgExt( 'othercontribs', 'parsemag', $creds, count( $fulllist ) )
+ : '';
+ }
+
+ /**
+ * Get a link to $user's user page
+ * @param $user User object
+ * @return String: html
+ */
+ protected static function link( User $user ) {
+ global $wgUser, $wgHiddenPrefs;
+ if ( !in_array( 'realname', $wgHiddenPrefs ) && !$user->isAnon() ) {
+ $real = $user->getRealName();
+ } else {
+ $real = false;
+ }
-/**
- *
- */
-function creditOthersLink($article) {
- global $wgUser, $wgLang;
- $skin = $wgUser->getSkin();
- return $skin->makeKnownLink($article->mTitle->getPrefixedText(), wfMsg('others'), 'action=credits');
+ $skin = $wgUser->getSkin();
+ $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
+ */
+ protected static function othersLink( Article $article ) {
+ global $wgUser;
+ $skin = $wgUser->getSkin();
+ return $skin->link(
+ $article->getTitle(),
+ wfMsgHtml( 'others' ),
+ array(),
+ array( 'action' => 'credits' ),
+ array( 'known' )
+ );
+ }
}
-
-?>
scripts.mit.edu / autoinstallsdev / mediawiki.git / blobdiff