MediaWiki  master
RevDelFileItem.php
Go to the documentation of this file.
1 <?php
23 
27 class RevDelFileItem extends RevDelItem {
29  protected $list;
31  protected $file;
32 
33  public function __construct( $list, $row ) {
34  parent::__construct( $list, $row );
35  $this->file = static::initFile( $list, $row );
36  }
37 
45  protected static function initFile( $list, $row ) {
46  return RepoGroup::singleton()->getLocalRepo()->newFileFromRow( $row );
47  }
48 
49  public function getIdField() {
50  return 'oi_archive_name';
51  }
52 
53  public function getTimestampField() {
54  return 'oi_timestamp';
55  }
56 
57  public function getAuthorIdField() {
58  return 'oi_user';
59  }
60 
61  public function getAuthorNameField() {
62  return 'oi_user_text';
63  }
64 
65  public function getAuthorActorField() {
66  return 'oi_actor';
67  }
68 
69  public function getId() {
70  $parts = explode( '!', $this->row->oi_archive_name );
71 
72  return $parts[0];
73  }
74 
75  public function canView() {
76  return $this->file->userCan( File::DELETED_RESTRICTED, $this->list->getUser() );
77  }
78 
79  public function canViewContent() {
80  return $this->file->userCan( File::DELETED_FILE, $this->list->getUser() );
81  }
82 
83  public function getBits() {
84  return $this->file->getVisibility();
85  }
86 
87  public function setBits( $bits ) {
88  # Queue the file op
89  # @todo FIXME: Move to LocalFile.php
90  if ( $this->isDeleted() ) {
91  if ( $bits & File::DELETED_FILE ) {
92  # Still deleted
93  } else {
94  # Newly undeleted
95  $key = $this->file->getStorageKey();
96  $srcRel = $this->file->repo->getDeletedHashPath( $key ) . $key;
97  $this->list->storeBatch[] = [
98  $this->file->repo->getVirtualUrl( 'deleted' ) . '/' . $srcRel,
99  'public',
100  $this->file->getRel()
101  ];
102  $this->list->cleanupBatch[] = $key;
103  }
104  } elseif ( $bits & File::DELETED_FILE ) {
105  # Newly deleted
106  $key = $this->file->getStorageKey();
107  $dstRel = $this->file->repo->getDeletedHashPath( $key ) . $key;
108  $this->list->deleteBatch[] = [ $this->file->getRel(), $dstRel ];
109  }
110 
111  # Do the database operations
112  $dbw = wfGetDB( DB_MASTER );
113  $dbw->update( 'oldimage',
114  [ 'oi_deleted' => $bits ],
115  [
116  'oi_name' => $this->row->oi_name,
117  'oi_timestamp' => $this->row->oi_timestamp,
118  'oi_deleted' => $this->getBits()
119  ],
120  __METHOD__
121  );
122 
123  return (bool)$dbw->affectedRows();
124  }
125 
126  public function isDeleted() {
127  return $this->file->isDeleted( File::DELETED_FILE );
128  }
129 
135  protected function getLink() {
136  $date = $this->list->getLanguage()->userTimeAndDate(
137  $this->file->getTimestamp(), $this->list->getUser() );
138 
139  if ( !$this->isDeleted() ) {
140  # Regular files...
141  return Html::element( 'a', [ 'href' => $this->file->getUrl() ], $date );
142  }
143 
144  # Hidden files...
145  if ( !$this->canViewContent() ) {
146  $link = htmlspecialchars( $date );
147  } else {
148  $link = $this->getLinkRenderer()->makeLink(
149  SpecialPage::getTitleFor( 'Revisiondelete' ),
150  $date,
151  [],
152  [
153  'target' => $this->list->title->getPrefixedText(),
154  'file' => $this->file->getArchiveName(),
155  'token' => $this->list->getUser()->getEditToken(
156  $this->file->getArchiveName() )
157  ]
158  );
159  }
160 
161  return '<span class="history-deleted">' . $link . '</span>';
162  }
163 
168  protected function getUserTools() {
169  if ( $this->file->userCan( RevisionRecord::DELETED_USER, $this->list->getUser() ) ) {
170  $uid = $this->file->getUser( 'id' );
171  $name = $this->file->getUser( 'text' );
173  } else {
174  $link = $this->list->msg( 'rev-deleted-user' )->escaped();
175  }
176  if ( $this->file->isDeleted( RevisionRecord::DELETED_USER ) ) {
177  return '<span class="history-deleted">' . $link . '</span>';
178  }
179 
180  return $link;
181  }
182 
189  protected function getComment() {
190  if ( $this->file->userCan( File::DELETED_COMMENT, $this->list->getUser() ) ) {
191  $block = Linker::commentBlock( $this->file->getDescription() );
192  } else {
193  $block = ' ' . $this->list->msg( 'rev-deleted-comment' )->escaped();
194  }
195  if ( $this->file->isDeleted( File::DELETED_COMMENT ) ) {
196  return "<span class=\"history-deleted\">$block</span>";
197  }
198 
199  return $block;
200  }
201 
202  public function getHTML() {
203  $data =
204  $this->list->msg( 'widthheight' )->numParams(
205  $this->file->getWidth(), $this->file->getHeight() )->text() .
206  ' (' . $this->list->msg( 'nbytes' )->numParams( $this->file->getSize() )->text() . ')';
207 
208  return '<li>' . $this->getLink() . ' ' . $this->getUserTools() . ' ' .
209  $data . ' ' . $this->getComment() . '</li>';
210  }
211 
212  public function getApiData( ApiResult $result ) {
213  $file = $this->file;
214  $user = $this->list->getUser();
215  $ret = [
216  'title' => $this->list->title->getPrefixedText(),
217  'archivename' => $file->getArchiveName(),
218  'timestamp' => wfTimestamp( TS_ISO_8601, $file->getTimestamp() ),
219  'width' => $file->getWidth(),
220  'height' => $file->getHeight(),
221  'size' => $file->getSize(),
222  'userhidden' => (bool)$file->isDeleted( RevisionRecord::DELETED_USER ),
223  'commenthidden' => (bool)$file->isDeleted( RevisionRecord::DELETED_COMMENT ),
224  'contenthidden' => (bool)$this->isDeleted(),
225  ];
226  if ( !$this->isDeleted() ) {
227  $ret += [
228  'url' => $file->getUrl(),
229  ];
230  } elseif ( $this->canViewContent() ) {
231  $ret += [
232  'url' => SpecialPage::getTitleFor( 'Revisiondelete' )->getLinkURL(
233  [
234  'target' => $this->list->title->getPrefixedText(),
235  'file' => $file->getArchiveName(),
236  'token' => $user->getEditToken( $file->getArchiveName() )
237  ]
238  ),
239  ];
240  }
241  if ( $file->userCan( RevisionRecord::DELETED_USER, $user ) ) {
242  $ret += [
243  'userid' => $file->user,
244  'user' => $file->user_text,
245  ];
246  }
247  if ( $file->userCan( RevisionRecord::DELETED_COMMENT, $user ) ) {
248  $ret += [
249  'comment' => $file->description,
250  ];
251  }
252 
253  return $ret;
254  }
255 
256  public function lock() {
257  return $this->file->acquireFileLock();
258  }
259 
260  public function unlock() {
261  return $this->file->releaseFileLock();
262  }
263 }
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
const DELETED_COMMENT
Definition: File.php:64
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:231
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:1972
getUserTools()
Generate a user tool link cluster if the current user is allowed to view it.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
getLink()
Get the link to the file.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
getSize()
Returns the size of the image file, in bytes.
Definition: LocalFile.php:949
Item class for an oldimage table row.
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
const DB_MASTER
Definition: defines.php:26
const DELETED_FILE
Definition: File.php:63
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\*-\*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1970
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:3039
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
userCan( $field, User $user=null)
Determine if the current user is allowed to view a particular field of this image file...
$row
The database result row.
Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing we can concentrate it all in an extension file
Definition: hooks.txt:91
Abstract base class for deletable items.
Definition: RevDelItem.php:25
static userToolLinks( $userId, $userText, $redContribsWhenNoEdits=false, $flags=0, $edits=null, $useParentheses=true)
Generate standard user tool links (talk, contributions, block link, etc.)
Definition: Linker.php:940
static singleton()
Definition: RepoGroup.php:60
getApiData(ApiResult $result)
This class represents the result of the API operations.
Definition: ApiResult.php:35
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don&#39;t need a full Title object...
Definition: SpecialPage.php:83
static userLink( $userId, $userName, $altUserName=false)
Make user link (or user contributions for unregistered users)
Definition: Linker.php:895
const DELETED_RESTRICTED
Definition: File.php:66
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
getUrl()
Return the URL of the file.
Definition: File.php:358
getLinkRenderer()
Returns an instance of LinkRenderer.
OldLocalFile $file
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
getHeight( $page=1)
Return the height of the image.
Definition: LocalFile.php:861
RevDelFileList $list
static initFile( $list, $row)
Create file object from $row sourced from $list.
getWidth( $page=1)
Return the width of the image.
Definition: LocalFile.php:829
static commentBlock( $comment, $title=null, $local=false, $wikiId=null, $useParentheses=true)
Wrap a comment in standard punctuation and formatting if it&#39;s non-empty, otherwise return empty strin...
Definition: Linker.php:1542
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1454
__construct( $list, $row)
isDeleted( $field)
getComment()
Wrap and format the file&#39;s comment block, if the current user is allowed to view it.