diff options
Diffstat (limited to 'www/wiki/includes/actions/CreditsAction.php')
-rw-r--r-- | www/wiki/includes/actions/CreditsAction.php | 246 |
1 files changed, 246 insertions, 0 deletions
diff --git a/www/wiki/includes/actions/CreditsAction.php b/www/wiki/includes/actions/CreditsAction.php new file mode 100644 index 00000000..ed58686a --- /dev/null +++ b/www/wiki/includes/actions/CreditsAction.php @@ -0,0 +1,246 @@ +<?php +/** + * 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 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 + * + * @file + * @ingroup Actions + * @author <evan@wikitravel.org> + */ + +use MediaWiki\MediaWikiServices; + +/** + * @ingroup Actions + */ +class CreditsAction extends FormlessAction { + + public function getName() { + return 'credits'; + } + + protected function getDescription() { + return $this->msg( 'creditspage' )->escaped(); + } + + /** + * This is largely cadged from PageHistory::history + * + * @return string HTML + */ + public function onView() { + if ( $this->page->getID() == 0 ) { + $s = $this->msg( 'nocredits' )->parse(); + } else { + $s = $this->getCredits( -1 ); + } + + return Html::rawElement( 'div', [ 'id' => 'mw-credits' ], $s ); + } + + /** + * Get a list of contributors + * + * @param int $cnt Maximum list of contributors to show + * @param bool $showIfMax Whether to contributors if there more than $cnt + * @return string Html + */ + public function getCredits( $cnt, $showIfMax = true ) { + $s = ''; + + if ( $cnt != 0 ) { + $s = $this->getAuthor( $this->page ); + if ( $cnt > 1 || $cnt < 0 ) { + $s .= ' ' . $this->getContributors( $cnt - 1, $showIfMax ); + } + } + + return $s; + } + + /** + * Get the last author with the last modification time + * @param Page $page + * @return string HTML + */ + protected function getAuthor( Page $page ) { + $user = User::newFromName( $page->getUserText(), false ); + + $timestamp = $page->getTimestamp(); + if ( $timestamp ) { + $lang = $this->getLanguage(); + $d = $lang->date( $page->getTimestamp(), true ); + $t = $lang->time( $page->getTimestamp(), true ); + } else { + $d = ''; + $t = ''; + } + + return $this->msg( 'lastmodifiedatby', $d, $t )->rawParams( + $this->userLink( $user ) )->params( $user->getName() )->escaped(); + } + + /** + * Whether we can display the user's real name (not a hidden pref) + * + * @since 1.24 + * @return bool + */ + protected function canShowRealUserName() { + $hiddenPrefs = $this->context->getConfig()->get( 'HiddenPrefs' ); + return !in_array( 'realname', $hiddenPrefs ); + } + + /** + * Get a list of contributors of $article + * @param int $cnt Maximum list of contributors to show + * @param bool $showIfMax Whether to contributors if there more than $cnt + * @return string Html + */ + protected function getContributors( $cnt, $showIfMax ) { + $contributors = $this->page->getContributors(); + + $others_link = false; + + # Hmm... too many to fit! + if ( $cnt > 0 && $contributors->count() > $cnt ) { + $others_link = $this->othersLink(); + if ( !$showIfMax ) { + return $this->msg( 'othercontribs' )->rawParams( + $others_link )->params( $contributors->count() )->escaped(); + } + } + + $real_names = []; + $user_names = []; + $anon_ips = []; + + # Sift for real versus user names + /** @var User $user */ + foreach ( $contributors as $user ) { + $cnt--; + if ( $user->isLoggedIn() ) { + $link = $this->link( $user ); + if ( $this->canShowRealUserName() && $user->getRealName() ) { + $real_names[] = $link; + } else { + $user_names[] = $link; + } + } else { + $anon_ips[] = $this->link( $user ); + } + + if ( $cnt == 0 ) { + break; + } + } + + $lang = $this->getLanguage(); + + if ( count( $real_names ) ) { + $real = $lang->listToText( $real_names ); + } else { + $real = false; + } + + # "ThisSite user(s) A, B and C" + if ( count( $user_names ) ) { + $user = $this->msg( 'siteusers' )->rawParams( $lang->listToText( $user_names ) )->params( + count( $user_names ) )->escaped(); + } else { + $user = false; + } + + if ( count( $anon_ips ) ) { + $anon = $this->msg( 'anonusers' )->rawParams( $lang->listToText( $anon_ips ) )->params( + count( $anon_ips ) )->escaped(); + } else { + $anon = false; + } + + # This is the big list, all mooshed together. We sift for blank strings + $fulllist = []; + foreach ( [ $real, $user, $anon, $others_link ] as $s ) { + if ( $s !== false ) { + array_push( $fulllist, $s ); + } + } + + $count = count( $fulllist ); + + # "Based on work by ..." + return $count + ? $this->msg( 'othercontribs' )->rawParams( + $lang->listToText( $fulllist ) )->params( $count )->escaped() + : ''; + } + + /** + * Get a link to $user's user page + * @param User $user + * @return string Html + */ + protected function link( User $user ) { + if ( $this->canShowRealUserName() && !$user->isAnon() ) { + $real = $user->getRealName(); + if ( $real === '' ) { + $real = $user->getName(); + } + } else { + $real = $user->getName(); + } + + $page = $user->isAnon() + ? SpecialPage::getTitleFor( 'Contributions', $user->getName() ) + : $user->getUserPage(); + + return MediaWikiServices::getInstance() + ->getLinkRenderer()->makeLink( $page, $real ); + } + + /** + * Get a link to $user's user page + * @param User $user + * @return string Html + */ + protected function userLink( User $user ) { + $link = $this->link( $user ); + if ( $user->isAnon() ) { + return $this->msg( 'anonuser' )->rawParams( $link )->parse(); + } else { + if ( $this->canShowRealUserName() && $user->getRealName() ) { + return $link; + } else { + return $this->msg( 'siteuser' )->rawParams( $link )->params( $user->getName() )->escaped(); + } + } + } + + /** + * Get a link to action=credits of $article page + * @return string HTML link + */ + protected function othersLink() { + return MediaWikiServices::getInstance()->getLinkRenderer()->makeKnownLink( + $this->getTitle(), + $this->msg( 'others' )->text(), + [], + [ 'action' => 'credits' ] + ); + } +} |