MediaWiki REL1_31
RevDelFileItem.php
Go to the documentation of this file.
1<?php
27 protected $list;
29 protected $file;
30
31 public function __construct( $list, $row ) {
32 parent::__construct( $list, $row );
33 $this->file = RepoGroup::singleton()->getLocalRepo()->newFileFromRow( $row );
34 }
35
36 public function getIdField() {
37 return 'oi_archive_name';
38 }
39
40 public function getTimestampField() {
41 return 'oi_timestamp';
42 }
43
44 public function getAuthorIdField() {
45 return 'oi_user';
46 }
47
48 public function getAuthorNameField() {
49 return 'oi_user_text';
50 }
51
52 public function getAuthorActorField() {
53 return 'oi_actor';
54 }
55
56 public function getId() {
57 $parts = explode( '!', $this->row->oi_archive_name );
58
59 return $parts[0];
60 }
61
62 public function canView() {
63 return $this->file->userCan( File::DELETED_RESTRICTED, $this->list->getUser() );
64 }
65
66 public function canViewContent() {
67 return $this->file->userCan( File::DELETED_FILE, $this->list->getUser() );
68 }
69
70 public function getBits() {
71 return $this->file->getVisibility();
72 }
73
74 public function setBits( $bits ) {
75 # Queue the file op
76 # @todo FIXME: Move to LocalFile.php
77 if ( $this->isDeleted() ) {
78 if ( $bits & File::DELETED_FILE ) {
79 # Still deleted
80 } else {
81 # Newly undeleted
82 $key = $this->file->getStorageKey();
83 $srcRel = $this->file->repo->getDeletedHashPath( $key ) . $key;
84 $this->list->storeBatch[] = [
85 $this->file->repo->getVirtualUrl( 'deleted' ) . '/' . $srcRel,
86 'public',
87 $this->file->getRel()
88 ];
89 $this->list->cleanupBatch[] = $key;
90 }
91 } elseif ( $bits & File::DELETED_FILE ) {
92 # Newly deleted
93 $key = $this->file->getStorageKey();
94 $dstRel = $this->file->repo->getDeletedHashPath( $key ) . $key;
95 $this->list->deleteBatch[] = [ $this->file->getRel(), $dstRel ];
96 }
97
98 # Do the database operations
99 $dbw = wfGetDB( DB_MASTER );
100 $dbw->update( 'oldimage',
101 [ 'oi_deleted' => $bits ],
102 [
103 'oi_name' => $this->row->oi_name,
104 'oi_timestamp' => $this->row->oi_timestamp,
105 'oi_deleted' => $this->getBits()
106 ],
107 __METHOD__
108 );
109
110 return (bool)$dbw->affectedRows();
111 }
112
113 public function isDeleted() {
114 return $this->file->isDeleted( File::DELETED_FILE );
115 }
116
122 protected function getLink() {
123 $date = $this->list->getLanguage()->userTimeAndDate(
124 $this->file->getTimestamp(), $this->list->getUser() );
125
126 if ( !$this->isDeleted() ) {
127 # Regular files...
128 return Html::element( 'a', [ 'href' => $this->file->getUrl() ], $date );
129 }
130
131 # Hidden files...
132 if ( !$this->canViewContent() ) {
133 $link = htmlspecialchars( $date );
134 } else {
135 $link = $this->getLinkRenderer()->makeLink(
136 SpecialPage::getTitleFor( 'Revisiondelete' ),
137 $date,
138 [],
139 [
140 'target' => $this->list->title->getPrefixedText(),
141 'file' => $this->file->getArchiveName(),
142 'token' => $this->list->getUser()->getEditToken(
143 $this->file->getArchiveName() )
144 ]
145 );
146 }
147
148 return '<span class="history-deleted">' . $link . '</span>';
149 }
150
155 protected function getUserTools() {
156 if ( $this->file->userCan( Revision::DELETED_USER, $this->list->getUser() ) ) {
157 $uid = $this->file->getUser( 'id' );
158 $name = $this->file->getUser( 'text' );
159 $link = Linker::userLink( $uid, $name ) . Linker::userToolLinks( $uid, $name );
160 } else {
161 $link = $this->list->msg( 'rev-deleted-user' )->escaped();
162 }
163 if ( $this->file->isDeleted( Revision::DELETED_USER ) ) {
164 return '<span class="history-deleted">' . $link . '</span>';
165 }
166
167 return $link;
168 }
169
176 protected function getComment() {
177 if ( $this->file->userCan( File::DELETED_COMMENT, $this->list->getUser() ) ) {
178 $block = Linker::commentBlock( $this->file->getDescription() );
179 } else {
180 $block = ' ' . $this->list->msg( 'rev-deleted-comment' )->escaped();
181 }
182 if ( $this->file->isDeleted( File::DELETED_COMMENT ) ) {
183 return "<span class=\"history-deleted\">$block</span>";
184 }
185
186 return $block;
187 }
188
189 public function getHTML() {
190 $data =
191 $this->list->msg( 'widthheight' )->numParams(
192 $this->file->getWidth(), $this->file->getHeight() )->text() .
193 ' (' . $this->list->msg( 'nbytes' )->numParams( $this->file->getSize() )->text() . ')';
194
195 return '<li>' . $this->getLink() . ' ' . $this->getUserTools() . ' ' .
196 $data . ' ' . $this->getComment() . '</li>';
197 }
198
199 public function getApiData( ApiResult $result ) {
200 $file = $this->file;
201 $user = $this->list->getUser();
202 $ret = [
203 'title' => $this->list->title->getPrefixedText(),
204 'archivename' => $file->getArchiveName(),
205 'timestamp' => wfTimestamp( TS_ISO_8601, $file->getTimestamp() ),
206 'width' => $file->getWidth(),
207 'height' => $file->getHeight(),
208 'size' => $file->getSize(),
209 'userhidden' => (bool)$file->isDeleted( Revision::DELETED_USER ),
210 'commenthidden' => (bool)$file->isDeleted( Revision::DELETED_COMMENT ),
211 'contenthidden' => (bool)$this->isDeleted(),
212 ];
213 if ( !$this->isDeleted() ) {
214 $ret += [
215 'url' => $file->getUrl(),
216 ];
217 } elseif ( $this->canViewContent() ) {
218 $ret += [
219 'url' => SpecialPage::getTitleFor( 'Revisiondelete' )->getLinkURL(
220 [
221 'target' => $this->list->title->getPrefixedText(),
222 'file' => $file->getArchiveName(),
223 'token' => $user->getEditToken( $file->getArchiveName() )
224 ]
225 ),
226 ];
227 }
228 if ( $file->userCan( Revision::DELETED_USER, $user ) ) {
229 $ret += [
230 'userid' => $file->user,
231 'user' => $file->user_text,
232 ];
233 }
234 if ( $file->userCan( Revision::DELETED_COMMENT, $user ) ) {
235 $ret += [
236 'comment' => $file->description,
237 ];
238 }
239
240 return $ret;
241 }
242
243 public function lock() {
244 return $this->file->acquireFileLock();
245 }
246
247 public function unlock() {
248 return $this->file->releaseFileLock();
249 }
250}
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
This class represents the result of the API operations.
Definition ApiResult.php:33
const DELETED_COMMENT
Definition File.php:54
const DELETED_RESTRICTED
Definition File.php:56
const DELETED_FILE
Definition File.php:53
getUrl()
Return the URL of the file.
Definition File.php:348
static userLink( $userId, $userName, $altUserName=false)
Make user link (or user contributions for unregistered users)
Definition Linker.php:893
static commentBlock( $comment, $title=null, $local=false, $wikiId=null)
Wrap a comment in standard punctuation and formatting if it's non-empty, otherwise return empty strin...
Definition Linker.php:1455
static userToolLinks( $userId, $userText, $redContribsWhenNoEdits=false, $flags=0, $edits=null)
Generate standard user tool links (talk, contributions, block link, etc.)
Definition Linker.php:931
Class to represent a file in the oldimage table.
static singleton()
Get a RepoGroup instance.
Definition RepoGroup.php:59
Item class for an oldimage table row.
getTimestampField()
Get the DB field name storing timestamps.
getComment()
Wrap and format the file's comment block, if the current user is allowed to view it.
getLink()
Get the link to the file.
RevDelFileList $list
canViewContent()
Returns true if the current user can view the item text/file.
getId()
Get the ID, as it would appear in the ids URL parameter.
getIdField()
Get the DB field name associated with the ID list.
getBits()
Get the current deletion bitfield value.
getAuthorIdField()
Get the DB field name storing user ids.
getHTML()
Get the HTML of the list item.
getUserTools()
Generate a user tool link cluster if the current user is allowed to view it.
__construct( $list, $row)
unlock()
Unlock the item against changes outside of the DB.
getAuthorNameField()
Get the DB field name storing user names.
lock()
Lock the item against changes outside of the DB.
canView()
Returns true if the current user can view the item.
getAuthorActorField()
Get the DB field name storing actor ids.
setBits( $bits)
Set the visibility of the item.
OldLocalFile $file
getApiData(ApiResult $result)
Get the return information about the revision for the API.
List for oldimage table items.
Abstract base class for deletable items.
$row
The database result row.
getLinkRenderer()
Returns an instance of LinkRenderer.
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition deferred.txt:11
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition hooks.txt:2005
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition hooks.txt:3021
const DB_MASTER
Definition defines.php:29