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