includes/revisiondelete/RevDelFileItem.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  * @ingroup RevisionDelete
  20  */
  21
  22 /**
  23  * Item class for an oldimage table row
  24  */
  25 class RevDelFileItem extends RevDelItem {
  26         /** @var RevDelFileList */
  27         protected $list;
  28         /** @var OldLocalFile */
  29         protected $file;
  30
  31         public function __construct( $list, $row ) {
  32                 parent::__construct( $list, $row );
  33                 $this->file = static::initFile( $list, $row );
  34         }
  35
  36         /**
  37          * Create file object from $row sourced from $list
  38          *
  39          * @param RevDelFileList $list
  40          * @param mixed $row
  41          * @return mixed
  42          */
  43         protected static function initFile( $list, $row ) {
  44                 return RepoGroup::singleton()->getLocalRepo()->newFileFromRow( $row );
  45         }
  46
  47         public function getIdField() {
  48                 return 'oi_archive_name';
  49         }
  50
  51         public function getTimestampField() {
  52                 return 'oi_timestamp';
  53         }
  54
  55         public function getAuthorIdField() {
  56                 return 'oi_user';
  57         }
  58
  59         public function getAuthorNameField() {
  60                 return 'oi_user_text';
  61         }
  62
  63         public function getAuthorActorField() {
  64                 return 'oi_actor';
  65         }
  66
  67         public function getId() {
  68                 $parts = explode( '!', $this->row->oi_archive_name );
  69
  70                 return $parts[0];
  71         }
  72
  73         public function canView() {
  74                 return $this->file->userCan( File::DELETED_RESTRICTED, $this->list->getUser() );
  75         }
  76
  77         public function canViewContent() {
  78                 return $this->file->userCan( File::DELETED_FILE, $this->list->getUser() );
  79         }
  80
  81         public function getBits() {
  82                 return $this->file->getVisibility();
  83         }
  84
  85         public function setBits( $bits ) {
  86                 # Queue the file op
  87                 # @todo FIXME: Move to LocalFile.php
  88                 if ( $this->isDeleted() ) {
  89                         if ( $bits & File::DELETED_FILE ) {
  90                                 # Still deleted
  91                         } else {
  92                                 # Newly undeleted
  93                                 $key = $this->file->getStorageKey();
  94                                 $srcRel = $this->file->repo->getDeletedHashPath( $key ) . $key;
  95                                 $this->list->storeBatch[] = [
  96                                         $this->file->repo->getVirtualUrl( 'deleted' ) . '/' . $srcRel,
  97                                         'public',
  98                                         $this->file->getRel()
  99                                 ];
 100                                 $this->list->cleanupBatch[] = $key;
 101                         }
 102                 } elseif ( $bits & File::DELETED_FILE ) {
 103                         # Newly deleted
 104                         $key = $this->file->getStorageKey();
 105                         $dstRel = $this->file->repo->getDeletedHashPath( $key ) . $key;
 106                         $this->list->deleteBatch[] = [ $this->file->getRel(), $dstRel ];
 107                 }
 108
 109                 # Do the database operations
 110                 $dbw = wfGetDB( DB_MASTER );
 111                 $dbw->update( 'oldimage',
 112                         [ 'oi_deleted' => $bits ],
 113                         [
 114                                 'oi_name' => $this->row->oi_name,
 115                                 'oi_timestamp' => $this->row->oi_timestamp,
 116                                 'oi_deleted' => $this->getBits()
 117                         ],
 118                         __METHOD__
 119                 );
 120
 121                 return (bool)$dbw->affectedRows();
 122         }
 123
 124         public function isDeleted() {
 125                 return $this->file->isDeleted( File::DELETED_FILE );
 126         }
 127
 128         /**
 129          * Get the link to the file.
 130          * Overridden by RevDelArchivedFileItem.
 131          * @return string
 132          */
 133         protected function getLink() {
 134                 $date = $this->list->getLanguage()->userTimeAndDate(
 135                         $this->file->getTimestamp(), $this->list->getUser() );
 136
 137                 if ( !$this->isDeleted() ) {
 138                         # Regular files...
 139                         return Html::element( 'a', [ 'href' => $this->file->getUrl() ], $date );
 140                 }
 141
 142                 # Hidden files...
 143                 if ( !$this->canViewContent() ) {
 144                         $link = htmlspecialchars( $date );
 145                 } else {
 146                         $link = $this->getLinkRenderer()->makeLink(
 147                                 SpecialPage::getTitleFor( 'Revisiondelete' ),
 148                                 $date,
 149                                 [],
 150                                 [
 151                                         'target' => $this->list->title->getPrefixedText(),
 152                                         'file' => $this->file->getArchiveName(),
 153                                         'token' => $this->list->getUser()->getEditToken(
 154                                                 $this->file->getArchiveName() )
 155                                 ]
 156                         );
 157                 }
 158
 159                 return '<span class="history-deleted">' . $link . '</span>';
 160         }
 161
 162         /**
 163          * Generate a user tool link cluster if the current user is allowed to view it
 164          * @return string HTML
 165          */
 166         protected function getUserTools() {
 167                 if ( $this->file->userCan( Revision::DELETED_USER, $this->list->getUser() ) ) {
 168                         $uid = $this->file->getUser( 'id' );
 169                         $name = $this->file->getUser( 'text' );
 170                         $link = Linker::userLink( $uid, $name ) . Linker::userToolLinks( $uid, $name );
 171                 } else {
 172                         $link = $this->list->msg( 'rev-deleted-user' )->escaped();
 173                 }
 174                 if ( $this->file->isDeleted( Revision::DELETED_USER ) ) {
 175                         return '<span class="history-deleted">' . $link . '</span>';
 176                 }
 177
 178                 return $link;
 179         }
 180
 181         /**
 182          * Wrap and format the file's comment block, if the current
 183          * user is allowed to view it.
 184          *
 185          * @return string HTML
 186          */
 187         protected function getComment() {
 188                 if ( $this->file->userCan( File::DELETED_COMMENT, $this->list->getUser() ) ) {
 189                         $block = Linker::commentBlock( $this->file->getDescription() );
 190                 } else {
 191                         $block = ' ' . $this->list->msg( 'rev-deleted-comment' )->escaped();
 192                 }
 193                 if ( $this->file->isDeleted( File::DELETED_COMMENT ) ) {
 194                         return "<span class=\"history-deleted\">$block</span>";
 195                 }
 196
 197                 return $block;
 198         }
 199
 200         public function getHTML() {
 201                 $data =
 202                         $this->list->msg( 'widthheight' )->numParams(
 203                                 $this->file->getWidth(), $this->file->getHeight() )->text() .
 204                         ' (' . $this->list->msg( 'nbytes' )->numParams( $this->file->getSize() )->text() . ')';
 205
 206                 return '<li>' . $this->getLink() . ' ' . $this->getUserTools() . ' ' .
 207                         $data . ' ' . $this->getComment() . '</li>';
 208         }
 209
 210         public function getApiData( ApiResult $result ) {
 211                 $file = $this->file;
 212                 $user = $this->list->getUser();
 213                 $ret = [
 214                         'title' => $this->list->title->getPrefixedText(),
 215                         'archivename' => $file->getArchiveName(),
 216                         'timestamp' => wfTimestamp( TS_ISO_8601, $file->getTimestamp() ),
 217                         'width' => $file->getWidth(),
 218                         'height' => $file->getHeight(),
 219                         'size' => $file->getSize(),
 220                         'userhidden' => (bool)$file->isDeleted( Revision::DELETED_USER ),
 221                         'commenthidden' => (bool)$file->isDeleted( Revision::DELETED_COMMENT ),
 222                         'contenthidden' => (bool)$this->isDeleted(),
 223                 ];
 224                 if ( !$this->isDeleted() ) {
 225                         $ret += [
 226                                 'url' => $file->getUrl(),
 227                         ];
 228                 } elseif ( $this->canViewContent() ) {
 229                         $ret += [
 230                                 'url' => SpecialPage::getTitleFor( 'Revisiondelete' )->getLinkURL(
 231                                         [
 232                                                 'target' => $this->list->title->getPrefixedText(),
 233                                                 'file' => $file->getArchiveName(),
 234                                                 'token' => $user->getEditToken( $file->getArchiveName() )
 235                                         ]
 236                                 ),
 237                         ];
 238                 }
 239                 if ( $file->userCan( Revision::DELETED_USER, $user ) ) {
 240                         $ret += [
 241                                 'userid' => $file->user,
 242                                 'user' => $file->user_text,
 243                         ];
 244                 }
 245                 if ( $file->userCan( Revision::DELETED_COMMENT, $user ) ) {
 246                         $ret += [
 247                                 'comment' => $file->description,
 248                         ];
 249                 }
 250
 251                 return $ret;
 252         }
 253
 254         public function lock() {
 255                 return $this->file->acquireFileLock();
 256         }
 257
 258         public function unlock() {
 259                 return $this->file->releaseFileLock();
 260         }
 261 }