MediaWiki  master
ImageHistoryList.php
Go to the documentation of this file.
1 <?php
22 
29 
33  protected $title;
34 
38  protected $img;
39 
43  protected $imagePage;
44 
48  protected $current;
49 
50  protected $repo, $showThumb;
51  protected $preventClickjacking = false;
52 
56  public function __construct( $imagePage ) {
58  $this->current = $imagePage->getPage()->getFile();
59  $this->img = $imagePage->getDisplayedFile();
60  $this->title = $imagePage->getTitle();
61  $this->imagePage = $imagePage;
62  $this->showThumb = $context->getConfig()->get( 'ShowArchiveThumbnails' ) &&
63  $this->img->canRender();
64  $this->setContext( $context );
65  }
66 
70  public function getImagePage() {
71  return $this->imagePage;
72  }
73 
77  public function getFile() {
78  return $this->img;
79  }
80 
85  public function beginImageHistoryList( $navLinks = '' ) {
86  return Xml::element( 'h2', [ 'id' => 'filehistory' ], $this->msg( 'filehist' )->text() )
87  . "\n"
88  . "<div id=\"mw-imagepage-section-filehistory\">\n"
89  . $this->msg( 'filehist-help' )->parseAsBlock()
90  . $navLinks . "\n"
91  . Xml::openElement( 'table', [ 'class' => 'wikitable filehistory' ] ) . "\n"
92  . '<tr><th></th>'
93  . ( $this->current->isLocal()
94  && ( $this->getUser()->isAllowedAny( 'delete', 'deletedhistory' ) ) ? '<th></th>' : '' )
95  . '<th>' . $this->msg( 'filehist-datetime' )->escaped() . '</th>'
96  . ( $this->showThumb ? '<th>' . $this->msg( 'filehist-thumb' )->escaped() . '</th>' : '' )
97  . '<th>' . $this->msg( 'filehist-dimensions' )->escaped() . '</th>'
98  . '<th>' . $this->msg( 'filehist-user' )->escaped() . '</th>'
99  . '<th>' . $this->msg( 'filehist-comment' )->escaped() . '</th>'
100  . "</tr>\n";
101  }
102 
107  public function endImageHistoryList( $navLinks = '' ) {
108  return "</table>\n$navLinks\n</div>\n";
109  }
110 
116  public function imageHistoryLine( $iscur, $file ) {
117  $user = $this->getUser();
118  $lang = $this->getLanguage();
119  $timestamp = wfTimestamp( TS_MW, $file->getTimestamp() );
120  $img = $iscur ? $file->getName() : $file->getArchiveName();
121  $userId = $file->getUser( 'id' );
122  $userText = $file->getUser( 'text' );
123  $description = $file->getDescription( File::FOR_THIS_USER, $user );
124 
125  $local = $this->current->isLocal();
126  $row = $selected = '';
127 
128  // Deletion link
129  if ( $local && ( $user->isAllowedAny( 'delete', 'deletedhistory' ) ) ) {
130  $row .= '<td>';
131  # Link to remove from history
132  if ( $user->isAllowed( 'delete' ) ) {
133  $q = [ 'action' => 'delete' ];
134  if ( !$iscur ) {
135  $q['oldimage'] = $img;
136  }
137  $row .= Linker::linkKnown(
138  $this->title,
139  $this->msg( $iscur ? 'filehist-deleteall' : 'filehist-deleteone' )->escaped(),
140  [], $q
141  );
142  }
143  # Link to hide content. Don't show useless link to people who cannot hide revisions.
144  $canHide = $user->isAllowed( 'deleterevision' );
145  if ( $canHide || ( $user->isAllowed( 'deletedhistory' ) && $file->getVisibility() ) ) {
146  if ( $user->isAllowed( 'delete' ) ) {
147  $row .= '<br />';
148  }
149  // If file is top revision or locked from this user, don't link
150  if ( $iscur || !$file->userCan( File::DELETED_RESTRICTED, $user ) ) {
151  $del = Linker::revDeleteLinkDisabled( $canHide );
152  } else {
153  list( $ts, ) = explode( '!', $img, 2 );
154  $query = [
155  'type' => 'oldimage',
156  'target' => $this->title->getPrefixedText(),
157  'ids' => $ts,
158  ];
160  $file->isDeleted( File::DELETED_RESTRICTED ), $canHide );
161  }
162  $row .= $del;
163  }
164  $row .= '</td>';
165  }
166 
167  // Reversion link/current indicator
168  $row .= '<td>';
169  if ( $iscur ) {
170  $row .= $this->msg( 'filehist-current' )->escaped();
171  } elseif ( $local && $this->title->quickUserCan( 'edit', $user )
172  && $this->title->quickUserCan( 'upload', $user )
173  ) {
174  if ( $file->isDeleted( File::DELETED_FILE ) ) {
175  $row .= $this->msg( 'filehist-revert' )->escaped();
176  } else {
177  $row .= Linker::linkKnown(
178  $this->title,
179  $this->msg( 'filehist-revert' )->escaped(),
180  [],
181  [
182  'action' => 'revert',
183  'oldimage' => $img,
184  ]
185  );
186  }
187  }
188  $row .= '</td>';
189 
190  // Date/time and image link
191  if ( $file->getTimestamp() === $this->img->getTimestamp() ) {
192  $selected = "class='filehistory-selected'";
193  }
194  $row .= "<td $selected style='white-space: nowrap;'>";
195  if ( !$file->userCan( File::DELETED_FILE, $user ) ) {
196  # Don't link to unviewable files
197  $row .= '<span class="history-deleted">'
198  . $lang->userTimeAndDate( $timestamp, $user ) . '</span>';
199  } elseif ( $file->isDeleted( File::DELETED_FILE ) ) {
200  if ( $local ) {
201  $this->preventClickjacking();
202  $revdel = SpecialPage::getTitleFor( 'Revisiondelete' );
203  # Make a link to review the image
204  $url = Linker::linkKnown(
205  $revdel,
206  $lang->userTimeAndDate( $timestamp, $user ),
207  [],
208  [
209  'target' => $this->title->getPrefixedText(),
210  'file' => $img,
211  'token' => $user->getEditToken( $img )
212  ]
213  );
214  } else {
215  $url = $lang->userTimeAndDate( $timestamp, $user );
216  }
217  $row .= '<span class="history-deleted">' . $url . '</span>';
218  } elseif ( !$file->exists() ) {
219  $row .= '<span class="mw-file-missing">'
220  . $lang->userTimeAndDate( $timestamp, $user ) . '</span>';
221  } else {
222  $url = $iscur ? $this->current->getUrl() : $this->current->getArchiveUrl( $img );
223  $row .= Xml::element(
224  'a',
225  [ 'href' => $url ],
226  $lang->userTimeAndDate( $timestamp, $user )
227  );
228  }
229  $row .= "</td>";
230 
231  // Thumbnail
232  if ( $this->showThumb ) {
233  $row .= '<td>' . $this->getThumbForLine( $file ) . '</td>';
234  }
235 
236  // Image dimensions + size
237  $row .= '<td>';
238  $row .= htmlspecialchars( $file->getDimensionsString() );
239  $row .= $this->msg( 'word-separator' )->escaped();
240  $row .= '<span style="white-space: nowrap;">';
241  $row .= $this->msg( 'parentheses' )->sizeParams( $file->getSize() )->escaped();
242  $row .= '</span>';
243  $row .= '</td>';
244 
245  // Uploading user
246  $row .= '<td>';
247  // Hide deleted usernames
248  if ( $file->isDeleted( File::DELETED_USER ) ) {
249  $row .= '<span class="history-deleted">'
250  . $this->msg( 'rev-deleted-user' )->escaped() . '</span>';
251  } else {
252  if ( $local ) {
253  $row .= Linker::userLink( $userId, $userText );
254  $row .= '<span style="white-space: nowrap;">';
255  $row .= Linker::userToolLinks( $userId, $userText );
256  $row .= '</span>';
257  } else {
258  $row .= htmlspecialchars( $userText );
259  }
260  }
261  $row .= '</td>';
262 
263  // Don't show deleted descriptions
264  if ( $file->isDeleted( File::DELETED_COMMENT ) ) {
265  $row .= '<td><span class="history-deleted">' .
266  $this->msg( 'rev-deleted-comment' )->escaped() . '</span></td>';
267  } else {
268  $row .=
269  '<td dir="' . MediaWikiServices::getInstance()->getContentLanguage()->getDir() .
270  '">' . Linker::formatComment( $description, $this->title ) . '</td>';
271  }
272 
273  $rowClass = null;
274  Hooks::run( 'ImagePageFileHistoryLine', [ $this, $file, &$row, &$rowClass ] );
275  $classAttr = $rowClass ? " class='$rowClass'" : '';
276 
277  return "<tr{$classAttr}>{$row}</tr>\n";
278  }
279 
284  protected function getThumbForLine( $file ) {
285  $lang = $this->getLanguage();
286  $user = $this->getUser();
287  if ( $file->allowInlineDisplay() && $file->userCan( File::DELETED_FILE, $user )
288  && !$file->isDeleted( File::DELETED_FILE )
289  ) {
290  $params = [
291  'width' => '120',
292  'height' => '120',
293  ];
294  $timestamp = wfTimestamp( TS_MW, $file->getTimestamp() );
295 
296  $thumbnail = $file->transform( $params );
297  $options = [
298  'alt' => $this->msg( 'filehist-thumbtext',
299  $lang->userTimeAndDate( $timestamp, $user ),
300  $lang->userDate( $timestamp, $user ),
301  $lang->userTime( $timestamp, $user ) )->text(),
302  'file-link' => true,
303  ];
304 
305  if ( !$thumbnail ) {
306  return $this->msg( 'filehist-nothumb' )->escaped();
307  }
308 
309  return $thumbnail->toHtml( $options );
310  } else {
311  return $this->msg( 'filehist-nothumb' )->escaped();
312  }
313  }
314 
318  protected function preventClickjacking( $enable = true ) {
319  $this->preventClickjacking = $enable;
320  }
321 
325  public function getPreventClickjacking() {
327  }
328 }
setContext(IContextSource $context)
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:54
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1598
const FOR_THIS_USER
Definition: File.php:70
beginImageHistoryList( $navLinks='')
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
The simplest way of implementing IContextSource is to hold a RequestContext as a member variable and ...
getPage()
Get the WikiPage object of this instance.
Definition: Article.php:231
if(!isset( $args[0])) $lang
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 MediaWikiServices
Definition: injection.txt:23
getName()
Return the name of this file.
Definition: File.php:297
msg( $key)
Get a Message object with context set Parameters are the same as wfMessage()
endImageHistoryList( $navLinks='')
title
IContextSource $context
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
Builds the image revision log shown on image pages.
const DELETED_FILE
Definition: File.php:53
getContext()
Gets the context this Article is executed in.
Definition: Article.php:2238
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
getConfig()
Get the site configuration.
static formatComment( $comment, $title=null, $local=false, $wikiId=null)
This function is called by all recent changes variants, by the page history, and by the user contribu...
Definition: Linker.php:1100
static openElement( $element, $attribs=null)
This opens an XML element.
Definition: Xml.php:110
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:916
getTitle()
Get the title object of the article.
Definition: Article.php:221
$params
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 & $options
Definition: hooks.txt:1995
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
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:82
const DELETED_USER
Definition: File.php:55
static userLink( $userId, $userName, $altUserName=false)
Make user link (or user contributions for unregistered users)
Definition: Linker.php:877
const DELETED_RESTRICTED
Definition: File.php:56
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
static linkKnown( $target, $html=null, $customAttribs=[], $query=[], $options=[ 'known'])
Identical to link(), except $options defaults to &#39;known&#39;.
Definition: Linker.php:141
static revDeleteLink( $query=[], $restricted=false, $delete=true)
Creates a (show/hide) link for deleting revisions/log entries.
Definition: Linker.php:2123
__construct( $imagePage)
imageHistoryLine( $iscur, $file)
static element( $element, $attribs=null, $contents='', $allowShortTag=true)
Format an XML element with given attributes and, optionally, text content.
Definition: Xml.php:41
getDisplayedFile()
Definition: ImagePage.php:214
preventClickjacking( $enable=true)
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1486
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
static revDeleteLinkDisabled( $delete=true)
Creates a dead (show/hide) link for deleting revisions/log entries.
Definition: Linker.php:2145