MediaWiki  1.27.2
DeletedContribsPager.php
Go to the documentation of this file.
1 <?php
26 
28  public $messages;
29  public $target;
30  public $namespace = '';
31  public $mDb;
32 
36  protected $mNavigationBar;
37 
39  parent::__construct( $context );
40  $msgs = [ 'deletionlog', 'undeleteviewlink', 'diff' ];
41  foreach ( $msgs as $msg ) {
42  $this->messages[$msg] = $this->msg( $msg )->escaped();
43  }
44  $this->target = $target;
45  $this->namespace = $namespace;
46  $this->mDb = wfGetDB( DB_SLAVE, 'contributions' );
47  }
48 
49  function getDefaultQuery() {
50  $query = parent::getDefaultQuery();
51  $query['target'] = $this->target;
52 
53  return $query;
54  }
55 
56  function getQueryInfo() {
57  list( $index, $userCond ) = $this->getUserCond();
58  $conds = array_merge( $userCond, $this->getNamespaceCond() );
59  $user = $this->getUser();
60  // Paranoia: avoid brute force searches (bug 17792)
61  if ( !$user->isAllowed( 'deletedhistory' ) ) {
62  $conds[] = $this->mDb->bitAnd( 'ar_deleted', Revision::DELETED_USER ) . ' = 0';
63  } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
64  $conds[] = $this->mDb->bitAnd( 'ar_deleted', Revision::SUPPRESSED_USER ) .
66  }
67 
68  return [
69  'tables' => [ 'archive' ],
70  'fields' => [
71  'ar_rev_id', 'ar_namespace', 'ar_title', 'ar_timestamp', 'ar_comment',
72  'ar_minor_edit', 'ar_user', 'ar_user_text', 'ar_deleted'
73  ],
74  'conds' => $conds,
75  'options' => [ 'USE INDEX' => $index ]
76  ];
77  }
78 
88  function reallyDoQuery( $offset, $limit, $descending ) {
89  $data = [ parent::reallyDoQuery( $offset, $limit, $descending ) ];
90 
91  // This hook will allow extensions to add in additional queries, nearly
92  // identical to ContribsPager::reallyDoQuery.
93  Hooks::run(
94  'DeletedContribsPager::reallyDoQuery',
95  [ &$data, $this, $offset, $limit, $descending ]
96  );
97 
98  $result = [];
99 
100  // loop all results and collect them in an array
101  foreach ( $data as $query ) {
102  foreach ( $query as $i => $row ) {
103  // use index column as key, allowing us to easily sort in PHP
104  $result[$row->{$this->getIndexField()} . "-$i"] = $row;
105  }
106  }
107 
108  // sort results
109  if ( $descending ) {
110  ksort( $result );
111  } else {
112  krsort( $result );
113  }
114 
115  // enforce limit
116  $result = array_slice( $result, 0, $limit );
117 
118  // get rid of array keys
119  $result = array_values( $result );
120 
121  return new FakeResultWrapper( $result );
122  }
123 
124  function getUserCond() {
125  $condition = [];
126 
127  $condition['ar_user_text'] = $this->target;
128  $index = 'usertext_timestamp';
129 
130  return [ $index, $condition ];
131  }
132 
133  function getIndexField() {
134  return 'ar_timestamp';
135  }
136 
137  function getStartBody() {
138  return "<ul>\n";
139  }
140 
141  function getEndBody() {
142  return "</ul>\n";
143  }
144 
145  function getNavigationBar() {
146  if ( isset( $this->mNavigationBar ) ) {
147  return $this->mNavigationBar;
148  }
149 
150  $linkTexts = [
151  'prev' => $this->msg( 'pager-newer-n' )->numParams( $this->mLimit )->escaped(),
152  'next' => $this->msg( 'pager-older-n' )->numParams( $this->mLimit )->escaped(),
153  'first' => $this->msg( 'histlast' )->escaped(),
154  'last' => $this->msg( 'histfirst' )->escaped()
155  ];
156 
157  $pagingLinks = $this->getPagingLinks( $linkTexts );
158  $limitLinks = $this->getLimitLinks();
159  $lang = $this->getLanguage();
160  $limits = $lang->pipeList( $limitLinks );
161 
162  $firstLast = $lang->pipeList( [ $pagingLinks['first'], $pagingLinks['last'] ] );
163  $firstLast = $this->msg( 'parentheses' )->rawParams( $firstLast )->escaped();
164  $prevNext = $this->msg( 'viewprevnext' )
165  ->rawParams(
166  $pagingLinks['prev'],
167  $pagingLinks['next'],
168  $limits
169  )->escaped();
170  $separator = $this->msg( 'word-separator' )->escaped();
171  $this->mNavigationBar = $firstLast . $separator . $prevNext;
172 
173  return $this->mNavigationBar;
174  }
175 
176  function getNamespaceCond() {
177  if ( $this->namespace !== '' ) {
178  return [ 'ar_namespace' => (int)$this->namespace ];
179  } else {
180  return [];
181  }
182  }
183 
191  function formatRow( $row ) {
192  $ret = '';
193  $classes = [];
194 
195  /*
196  * There may be more than just revision rows. To make sure that we'll only be processing
197  * revisions here, let's _try_ to build a revision out of our row (without displaying
198  * notices though) and then trying to grab data from the built object. If we succeed,
199  * we're definitely dealing with revision data and we may proceed, if not, we'll leave it
200  * to extensions to subscribe to the hook to parse the row.
201  */
202  MediaWiki\suppressWarnings();
203  try {
205  $validRevision = (bool)$rev->getId();
206  } catch ( Exception $e ) {
207  $validRevision = false;
208  }
209  MediaWiki\restoreWarnings();
210 
211  if ( $validRevision ) {
212  $ret = $this->formatRevisionRow( $row );
213  }
214 
215  // Let extensions add data
216  Hooks::run( 'DeletedContributionsLineEnding', [ $this, &$ret, $row, &$classes ] );
217 
218  if ( $classes === [] && $ret === '' ) {
219  wfDebug( "Dropping Special:DeletedContribution row that could not be formatted\n" );
220  $ret = "<!-- Could not format Special:DeletedContribution row. -->\n";
221  } else {
222  $ret = Html::rawElement( 'li', [ 'class' => $classes ], $ret ) . "\n";
223  }
224 
225  return $ret;
226  }
227 
240  function formatRevisionRow( $row ) {
241  $page = Title::makeTitle( $row->ar_namespace, $row->ar_title );
242 
243  $rev = new Revision( [
244  'title' => $page,
245  'id' => $row->ar_rev_id,
246  'comment' => $row->ar_comment,
247  'user' => $row->ar_user,
248  'user_text' => $row->ar_user_text,
249  'timestamp' => $row->ar_timestamp,
250  'minor_edit' => $row->ar_minor_edit,
251  'deleted' => $row->ar_deleted,
252  ] );
253 
254  $undelete = SpecialPage::getTitleFor( 'Undelete' );
255 
256  $logs = SpecialPage::getTitleFor( 'Log' );
257  $dellog = Linker::linkKnown(
258  $logs,
259  $this->messages['deletionlog'],
260  [],
261  [
262  'type' => 'delete',
263  'page' => $page->getPrefixedText()
264  ]
265  );
266 
267  $reviewlink = Linker::linkKnown(
268  SpecialPage::getTitleFor( 'Undelete', $page->getPrefixedDBkey() ),
269  $this->messages['undeleteviewlink']
270  );
271 
272  $user = $this->getUser();
273 
274  if ( $user->isAllowed( 'deletedtext' ) ) {
276  $undelete,
277  $this->messages['diff'],
278  [],
279  [
280  'target' => $page->getPrefixedText(),
281  'timestamp' => $rev->getTimestamp(),
282  'diff' => 'prev'
283  ]
284  );
285  } else {
286  $last = $this->messages['diff'];
287  }
288 
290  $date = $this->getLanguage()->userTimeAndDate( $rev->getTimestamp(), $user );
291  $date = htmlspecialchars( $date );
292 
293  if ( !$user->isAllowed( 'undelete' ) || !$rev->userCan( Revision::DELETED_TEXT, $user ) ) {
294  $link = $date; // unusable link
295  } else {
297  $undelete,
298  $date,
299  [ 'class' => 'mw-changeslist-date' ],
300  [
301  'target' => $page->getPrefixedText(),
302  'timestamp' => $rev->getTimestamp()
303  ]
304  );
305  }
306  // Style deleted items
307  if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
308  $link = '<span class="history-deleted">' . $link . '</span>';
309  }
310 
311  $pagelink = Linker::link(
312  $page,
313  null,
314  [ 'class' => 'mw-changeslist-title' ]
315  );
316 
317  if ( $rev->isMinor() ) {
318  $mflag = ChangesList::flag( 'minor' );
319  } else {
320  $mflag = '';
321  }
322 
323  // Revision delete link
325  if ( $del ) {
326  $del .= ' ';
327  }
328 
329  $tools = Html::rawElement(
330  'span',
331  [ 'class' => 'mw-deletedcontribs-tools' ],
332  $this->msg( 'parentheses' )->rawParams( $this->getLanguage()->pipeList(
333  [ $last, $dellog, $reviewlink ] ) )->escaped()
334  );
335 
336  $separator = '<span class="mw-changeslist-separator">. .</span>';
337  $ret = "{$del}{$link} {$tools} {$separator} {$mflag} {$pagelink} {$comment}";
338 
339  # Denote if username is redacted for this edit
340  if ( $rev->isDeleted( Revision::DELETED_USER ) ) {
341  $ret .= " <strong>" . $this->msg( 'rev-deleted-user-contribs' )->escaped() . "</strong>";
342  }
343 
344  return $ret;
345  }
346 
352  public function getDatabase() {
353  return $this->mDb;
354  }
355 }
const DIR_DESCENDING
Definition: IndexPager.php:73
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
Interface for objects which can provide a MediaWiki context on request.
static revComment(Revision $rev, $local=false, $isPublic=false)
Wrap and format the given revision's comment block, if the current user is allowed to view it...
Definition: Linker.php:1656
wfGetDB($db, $groups=[], $wiki=false)
Get a Database object.
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:1418
static linkKnown($target, $html=null, $customAttribs=[], $query=[], $options=[ 'known', 'noclasses'])
Identical to link(), except $options defaults to 'known'.
Definition: Linker.php:264
static getRevDeleteLink(User $user, Revision $rev, Title $title)
Get a revision-deletion link, or disabled link, or nothing, depending on user permissions & the setti...
Definition: Linker.php:2256
static getTitleFor($name, $subpage=false, $fragment= '')
Get a localised Title object for a specified special page name.
Definition: SpecialPage.php:75
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException'returning false will NOT prevent logging $e
Definition: hooks.txt:1932
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
if(!isset($args[0])) $lang
formatRevisionRow($row)
Generates each row in the contributions list for archive entries.
$comment
getDatabase()
Get the Database object in use.
IContextSource $context
wfDebug($text, $dest= 'all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
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
formatRow($row)
Generates each row in the contributions list.
$last
IndexPager is an efficient pager which uses a (roughly unique) index in the data set to implement pag...
Definition: IndexPager.php:66
msg()
Get a Message object with context set Parameters are the same as wfMessage()
__construct(IContextSource $context, $target, $namespace=false)
reallyDoQuery($offset, $limit, $descending)
This method basically executes the exact same code as the parent class, though with a hook added...
const DB_SLAVE
Definition: Defines.php:46
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
Definition: hooks.txt:1584
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
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_TEXT
Definition: Revision.php:76
const SUPPRESSED_USER
Definition: Revision.php:80
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok inclusive false for true for descending in case the handler function wants to provide a converted Content object Note that $result getContentModel() must return $toModel. 'CustomEditor'you ll need to handle error messages
Definition: hooks.txt:1099
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
const DELETED_USER
Definition: Revision.php:78
Overloads the relevant methods of the real ResultsWrapper so it doesn't go anywhere near an actual da...
string $mNavigationBar
Navigation bar with paging links.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok inclusive $limit
Definition: hooks.txt:1004
static flag($flag, IContextSource $context=null)
Make an "" element for a given change flag.
static newFromArchiveRow($row, $overrides=[])
Make a fake revision object from an archive table row.
Definition: Revision.php:172
getUser()
Get the User object.
static & makeTitle($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:524
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached $page
Definition: hooks.txt:2338