MediaWiki  1.27.2
RevDelFileItem.php
Go to the documentation of this file.
1 <?php
25 class RevDelFileItem extends RevDelItem {
27  public $file;
28 
29  public function __construct( $list, $row ) {
30  parent::__construct( $list, $row );
31  $this->file = RepoGroup::singleton()->getLocalRepo()->newFileFromRow( $row );
32  }
33 
34  public function getIdField() {
35  return 'oi_archive_name';
36  }
37 
38  public function getTimestampField() {
39  return 'oi_timestamp';
40  }
41 
42  public function getAuthorIdField() {
43  return 'oi_user';
44  }
45 
46  public function getAuthorNameField() {
47  return 'oi_user_text';
48  }
49 
50  public function getId() {
51  $parts = explode( '!', $this->row->oi_archive_name );
52 
53  return $parts[0];
54  }
55 
56  public function canView() {
57  return $this->file->userCan( File::DELETED_RESTRICTED, $this->list->getUser() );
58  }
59 
60  public function canViewContent() {
61  return $this->file->userCan( File::DELETED_FILE, $this->list->getUser() );
62  }
63 
64  public function getBits() {
65  return $this->file->getVisibility();
66  }
67 
68  public function setBits( $bits ) {
69  # Queue the file op
70  # @todo FIXME: Move to LocalFile.php
71  if ( $this->isDeleted() ) {
72  if ( $bits & File::DELETED_FILE ) {
73  # Still deleted
74  } else {
75  # Newly undeleted
76  $key = $this->file->getStorageKey();
77  $srcRel = $this->file->repo->getDeletedHashPath( $key ) . $key;
78  $this->list->storeBatch[] = [
79  $this->file->repo->getVirtualUrl( 'deleted' ) . '/' . $srcRel,
80  'public',
81  $this->file->getRel()
82  ];
83  $this->list->cleanupBatch[] = $key;
84  }
85  } elseif ( $bits & File::DELETED_FILE ) {
86  # Newly deleted
87  $key = $this->file->getStorageKey();
88  $dstRel = $this->file->repo->getDeletedHashPath( $key ) . $key;
89  $this->list->deleteBatch[] = [ $this->file->getRel(), $dstRel ];
90  }
91 
92  # Do the database operations
93  $dbw = wfGetDB( DB_MASTER );
94  $dbw->update( 'oldimage',
95  [ 'oi_deleted' => $bits ],
96  [
97  'oi_name' => $this->row->oi_name,
98  'oi_timestamp' => $this->row->oi_timestamp,
99  'oi_deleted' => $this->getBits()
100  ],
101  __METHOD__
102  );
103 
104  return (bool)$dbw->affectedRows();
105  }
106 
107  public function isDeleted() {
108  return $this->file->isDeleted( File::DELETED_FILE );
109  }
110 
116  protected function getLink() {
117  $date = htmlspecialchars( $this->list->getLanguage()->userTimeAndDate(
118  $this->file->getTimestamp(), $this->list->getUser() ) );
119 
120  if ( !$this->isDeleted() ) {
121  # Regular files...
122  return Html::rawElement( 'a', [ 'href' => $this->file->getUrl() ], $date );
123  }
124 
125  # Hidden files...
126  if ( !$this->canViewContent() ) {
127  $link = $date;
128  } else {
130  SpecialPage::getTitleFor( 'Revisiondelete' ),
131  $date,
132  [],
133  [
134  'target' => $this->list->title->getPrefixedText(),
135  'file' => $this->file->getArchiveName(),
136  'token' => $this->list->getUser()->getEditToken(
137  $this->file->getArchiveName() )
138  ]
139  );
140  }
141 
142  return '<span class="history-deleted">' . $link . '</span>';
143  }
144 
149  protected function getUserTools() {
150  if ( $this->file->userCan( Revision::DELETED_USER, $this->list->getUser() ) ) {
151  $uid = $this->file->getUser( 'id' );
152  $name = $this->file->getUser( 'text' );
154  } else {
155  $link = $this->list->msg( 'rev-deleted-user' )->escaped();
156  }
157  if ( $this->file->isDeleted( Revision::DELETED_USER ) ) {
158  return '<span class="history-deleted">' . $link . '</span>';
159  }
160 
161  return $link;
162  }
163 
170  protected function getComment() {
171  if ( $this->file->userCan( File::DELETED_COMMENT, $this->list->getUser() ) ) {
172  $block = Linker::commentBlock( $this->file->getDescription() );
173  } else {
174  $block = ' ' . $this->list->msg( 'rev-deleted-comment' )->escaped();
175  }
176  if ( $this->file->isDeleted( File::DELETED_COMMENT ) ) {
177  return "<span class=\"history-deleted\">$block</span>";
178  }
179 
180  return $block;
181  }
182 
183  public function getHTML() {
184  $data =
185  $this->list->msg( 'widthheight' )->numParams(
186  $this->file->getWidth(), $this->file->getHeight() )->text() .
187  ' (' . $this->list->msg( 'nbytes' )->numParams( $this->file->getSize() )->text() . ')';
188 
189  return '<li>' . $this->getLink() . ' ' . $this->getUserTools() . ' ' .
190  $data . ' ' . $this->getComment() . '</li>';
191  }
192 
193  public function getApiData( ApiResult $result ) {
194  $file = $this->file;
195  $user = $this->list->getUser();
196  $ret = [
197  'title' => $this->list->title->getPrefixedText(),
198  'archivename' => $file->getArchiveName(),
199  'timestamp' => wfTimestamp( TS_ISO_8601, $file->getTimestamp() ),
200  'width' => $file->getWidth(),
201  'height' => $file->getHeight(),
202  'size' => $file->getSize(),
203  ];
204  $ret += $file->isDeleted( Revision::DELETED_USER ) ? [ 'userhidden' => '' ] : [];
205  $ret += $file->isDeleted( Revision::DELETED_COMMENT ) ? [ 'commenthidden' => '' ] : [];
206  $ret += $this->isDeleted() ? [ 'contenthidden' => '' ] : [];
207  if ( !$this->isDeleted() ) {
208  $ret += [
209  'url' => $file->getUrl(),
210  ];
211  } elseif ( $this->canViewContent() ) {
212  $ret += [
213  'url' => SpecialPage::getTitleFor( 'Revisiondelete' )->getLinkURL(
214  [
215  'target' => $this->list->title->getPrefixedText(),
216  'file' => $file->getArchiveName(),
217  'token' => $user->getEditToken( $file->getArchiveName() )
218  ],
219  false, PROTO_RELATIVE
220  ),
221  ];
222  }
224  $ret += [
225  'userid' => $file->user,
226  'user' => $file->user_text,
227  ];
228  }
230  $ret += [
231  'comment' => $file->description,
232  ];
233  }
234 
235  return $ret;
236  }
237 }
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
wfGetDB($db, $groups=[], $wiki=false)
Get a Database object.
const DELETED_COMMENT
Definition: File.php:53
magic word the default is to use $key to get the and $key value or $key value text $key value html to format the value $key
Definition: hooks.txt:2321
RevisionListBase $list
The parent.
userCan($field, User $user=null)
Determine if the current user is allowed to view a particular field of this file, if it's marked as d...
Definition: File.php:2147
getUserTools()
Generate a user tool link cluster if the current user is allowed to view it.
static getTitleFor($name, $subpage=false, $fragment= '')
Get a localised Title object for a specified special page name.
Definition: SpecialPage.php:75
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:1798
static rawElement($element, $attribs=[], $contents= '')
Returns an HTML element in a string.
Definition: Html.php:210
getLink()
Get the link to the file.
Item class for an oldimage table row.
const DELETED_FILE
Definition: File.php:52
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. '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 '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. 'LanguageGetMagic':DEPRECATED!Use $magicWords in a file listed in $wgExtensionMessagesFiles instead.Use this to define synonyms of magic words depending of the language &$magicExtensions:associative array of magic words synonyms $lang:language code(string) '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 'LanguageGetSpecialPageAliases':DEPRECATED!Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead.Use to define aliases of special pages names depending of the language &$specialPageAliases:associative array of magic words synonyms $lang:language code(string) '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:Associative array mapping language codes to prefixed links of the form"language:title".&$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':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:1796
the value to return A Title object or null for latest to be modified or replaced by the hook handler or if authentication is not possible after cache objects are set for highlighting & $link
Definition: hooks.txt:2581
wfTimestamp($outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
$row
The database result row.
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:93
getSize()
Return the size of the image file, in bytes Overridden by LocalFile, UnregisteredLocalFile STUB...
Definition: File.php:695
Abstract base class for deletable items.
Definition: RevDelItem.php:25
isDeleted($field)
Is this file a "deleted" file in a private archive? STUB.
Definition: File.php:1875
const TS_ISO_8601
ISO 8601 format with no timezone: 1986-02-09T20:00:00Z.
static singleton()
Get a RepoGroup instance.
Definition: RepoGroup.php:59
getApiData(ApiResult $result)
This class represents the result of the API operations.
Definition: ApiResult.php:33
const PROTO_RELATIVE
Definition: Defines.php:263
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition: design.txt:12
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition: hooks.txt:242
static link($target, $html=null, $customAttribs=[], $query=[], $options=[])
This function returns an HTML link to the given target.
Definition: Linker.php:195
const DELETED_RESTRICTED
Definition: File.php:55
getHeight($page=1)
Return the height of the image.
Definition: File.php:476
static userLink($userId, $userName, $altUserName=false)
Make user link (or user contributions for unregistered users)
Definition: Linker.php:1102
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
getWidth($page=1)
Return the width of the image.
Definition: File.php:462
const DELETED_USER
Definition: Revision.php:78
getTimestamp()
Get the 14-character timestamp of the file upload.
Definition: File.php:2095
getUrl()
Return the URL of the file.
Definition: File.php:347
static userToolLinks($userId, $userText, $redContribsWhenNoEdits=false, $flags=0, $edits=null)
Generate standard user tool links (talk, contributions, block link, etc.)
Definition: Linker.php:1133
__construct($list, $row)
const DB_MASTER
Definition: Defines.php:47
const DELETED_COMMENT
Definition: Revision.php:77
!html< table >< tr >< tdstyle="color:red;"></td >< tdstyle="color:blue;"></td ></tr >< tr >< td ></td >< td ></td >< td ></td >< td ></td >< td ></td >< td ></td ></tr >< tr >< td ></td >< td ></td ></tr ></table >!end!test Table rowspan row</td >< tdrowspan="2"> row(and 2)</td >< td > Cell 3
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:1632
getComment()
Wrap and format the file's comment block, if the current user is allowed to view it.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:310