includes/specials/SpecialDeletedContributions.php

   1 <?php
   2 /**
   3  * Implements Special:DeletedContributions
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup SpecialPage
  22  */
  23
  24 use MediaWiki\Block\DatabaseBlock;
  25 use MediaWiki\MediaWikiServices;
  26
  27 /**
  28  * Implements Special:DeletedContributions to display archived revisions
  29  * @ingroup SpecialPage
  30  */
  31 class DeletedContributionsPage extends SpecialPage {
  32         /** @var FormOptions */
  33         protected $mOpts;
  34
  35         function __construct() {
  36                 parent::__construct( 'DeletedContributions', 'deletedhistory' );
  37         }
  38
  39         /**
  40          * Special page "deleted user contributions".
  41          * Shows a list of the deleted contributions of a user.
  42          *
  43          * @param string $par (optional) user name of the user for which to show the contributions
  44          */
  45         function execute( $par ) {
  46                 $this->setHeaders();
  47                 $this->outputHeader();
  48                 $this->checkPermissions();
  49
  50                 $out = $this->getOutput();
  51                 $out->setPageTitle( $this->msg( 'deletedcontributions-title' ) );
  52
  53                 $opts = new FormOptions();
  54
  55                 $opts->add( 'target', '' );
  56                 $opts->add( 'namespace', '' );
  57                 $opts->add( 'limit', 20 );
  58
  59                 $opts->fetchValuesFromRequest( $this->getRequest() );
  60                 $opts->validateIntBounds( 'limit', 0, $this->getConfig()->get( 'QueryPageDefaultLimit' ) );
  61
  62                 if ( $par !== null ) {
  63                         // Beautify the username
  64                         $par = User::getCanonicalName( $par, false );
  65                         $opts->setValue( 'target', (string)$par );
  66                 }
  67
  68                 $ns = $opts->getValue( 'namespace' );
  69                 if ( $ns !== null && $ns !== '' ) {
  70                         $opts->setValue( 'namespace', intval( $ns ) );
  71                 }
  72
  73                 $this->mOpts = $opts;
  74
  75                 $target = trim( $opts->getValue( 'target' ) );
  76                 if ( !strlen( $target ) ) {
  77                         $this->getForm();
  78
  79                         return;
  80                 }
  81
  82                 $userObj = User::newFromName( $target, false );
  83                 if ( !$userObj ) {
  84                         $this->getForm();
  85
  86                         return;
  87                 }
  88                 $this->getSkin()->setRelevantUser( $userObj );
  89
  90                 $target = $userObj->getName();
  91                 $out->addSubtitle( $this->getSubTitle( $userObj ) );
  92
  93                 $this->getForm();
  94
  95                 $pager = new DeletedContribsPager( $this->getContext(), $target, $opts->getValue( 'namespace' ) );
  96                 if ( !$pager->getNumRows() ) {
  97                         $out->addWikiMsg( 'nocontribs' );
  98
  99                         return;
 100                 }
 101
 102                 # Show a message about replica DB lag, if applicable
 103                 $lag = $pager->getDatabase()->getSessionLagStatus()['lag'];
 104                 if ( $lag > 0 ) {
 105                         $out->showLagWarning( $lag );
 106                 }
 107
 108                 $out->addHTML(
 109                         '<p>' . $pager->getNavigationBar() . '</p>' .
 110                                 $pager->getBody() .
 111                                 '<p>' . $pager->getNavigationBar() . '</p>' );
 112
 113                 # If there were contributions, and it was a valid user or IP, show
 114                 # the appropriate "footer" message - WHOIS tools, etc.
 115                 if ( $target != 'newbies' ) {
 116                         $message = IP::isIPAddress( $target ) ?
 117                                 'sp-contributions-footer-anon' :
 118                                 'sp-contributions-footer';
 119
 120                         if ( !$this->msg( $message )->isDisabled() ) {
 121                                 $out->wrapWikiMsg(
 122                                         "<div class='mw-contributions-footer'>\n$1\n</div>",
 123                                         [ $message, $target ]
 124                                 );
 125                         }
 126                 }
 127         }
 128
 129         /**
 130          * Generates the subheading with links
 131          * @param User $userObj User object for the target
 132          * @return string Appropriately-escaped HTML to be output literally
 133          */
 134         function getSubTitle( $userObj ) {
 135                 $linkRenderer = $this->getLinkRenderer();
 136                 if ( $userObj->isAnon() ) {
 137                         $user = htmlspecialchars( $userObj->getName() );
 138                 } else {
 139                         $user = $linkRenderer->makeLink( $userObj->getUserPage(), $userObj->getName() );
 140                 }
 141                 $links = '';
 142                 $nt = $userObj->getUserPage();
 143                 $talk = $nt->getTalkPage();
 144                 if ( $talk ) {
 145                         $tools = SpecialContributions::getUserLinks( $this, $userObj );
 146
 147                         $contributionsLink = $linkRenderer->makeKnownLink(
 148                                 SpecialPage::getTitleFor( 'Contributions', $nt->getDBkey() ),
 149                                 $this->msg( 'sp-deletedcontributions-contribs' )->text()
 150                         );
 151                         if ( isset( $tools['deletedcontribs'] ) ) {
 152                                 // Swap out the deletedcontribs link for our contribs one
 153                                 $tools = wfArrayInsertAfter(
 154                                         $tools, [ 'contribs' => $contributionsLink ], 'deletedcontribs' );
 155                                 unset( $tools['deletedcontribs'] );
 156                         } else {
 157                                 $tools['contribs'] = $contributionsLink;
 158                         }
 159
 160                         $links = $this->getLanguage()->pipeList( $tools );
 161
 162                         // Show a note if the user is blocked and display the last block log entry.
 163                         $block = DatabaseBlock::newFromTarget( $userObj, $userObj );
 164                         if ( !is_null( $block ) && $block->getType() != DatabaseBlock::TYPE_AUTO ) {
 165                                 if ( $block->getType() == DatabaseBlock::TYPE_RANGE ) {
 166                                         $nt = MediaWikiServices::getInstance()->getNamespaceInfo()->
 167                                                 getCanonicalName( NS_USER ) . ':' . $block->getTarget();
 168                                 }
 169
 170                                 // LogEventsList::showLogExtract() wants the first parameter by ref
 171                                 $out = $this->getOutput();
 172                                 LogEventsList::showLogExtract(
 173                                         $out,
 174                                         'block',
 175                                         $nt,
 176                                         '',
 177                                         [
 178                                                 'lim' => 1,
 179                                                 'showIfEmpty' => false,
 180                                                 'msgKey' => [
 181                                                         'sp-contributions-blocked-notice',
 182                                                         $userObj->getName() # Support GENDER in 'sp-contributions-blocked-notice'
 183                                                 ],
 184                                                 'offset' => '' # don't use $this->getRequest() parameter offset
 185                                         ]
 186                                 );
 187                         }
 188                 }
 189
 190                 return $this->msg( 'contribsub2' )->rawParams( $user, $links )->params( $userObj->getName() );
 191         }
 192
 193         /**
 194          * Generates the namespace selector form with hidden attributes.
 195          */
 196         function getForm() {
 197                 $opts = $this->mOpts;
 198
 199                 $formDescriptor = [
 200                         'target' => [
 201                                 'type' => 'user',
 202                                 'name' => 'target',
 203                                 'label-message' => 'sp-contributions-username',
 204                                 'default' => $opts->getValue( 'target' ),
 205                                 'ipallowed' => true,
 206                         ],
 207
 208                         'namespace' => [
 209                                 'type' => 'namespaceselect',
 210                                 'name' => 'namespace',
 211                                 'label-message' => 'namespace',
 212                                 'all' => '',
 213                         ],
 214                 ];
 215
 216                 HTMLForm::factory( 'ooui', $formDescriptor, $this->getContext() )
 217                         ->setWrapperLegendMsg( 'sp-contributions-search' )
 218                         ->setSubmitTextMsg( 'sp-contributions-submit' )
 219                         // prevent setting subpage and 'target' parameter at the same time
 220                         ->setAction( $this->getPageTitle()->getLocalURL() )
 221                         ->setMethod( 'get' )
 222                         ->prepareForm()
 223                         ->displayForm( false );
 224         }
 225
 226         /**
 227          * Return an array of subpages beginning with $search that this special page will accept.
 228          *
 229          * @param string $search Prefix to search for
 230          * @param int $limit Maximum number of results to return (usually 10)
 231          * @param int $offset Number of results to skip (usually 0)
 232          * @return string[] Matching subpages
 233          */
 234         public function prefixSearchSubpages( $search, $limit, $offset ) {
 235                 $user = User::newFromName( $search );
 236                 if ( !$user ) {
 237                         // No prefix suggestion for invalid user
 238                         return [];
 239                 }
 240                 // Autocomplete subpage as user list - public to allow caching
 241                 return UserNamePrefixSearch::search( 'public', $search, $limit, $offset );
 242         }
 243
 244         protected function getGroupName() {
 245                 return 'users';
 246         }
 247 }