MediaWiki  1.28.0
SpecialRecentchangeslinked.php
Go to the documentation of this file.
1 <?php
31  protected $rclTargetTitle;
32 
33  function __construct() {
34  parent::__construct( 'Recentchangeslinked' );
35  }
36 
37  public function getDefaultOptions() {
38  $opts = parent::getDefaultOptions();
39  $opts->add( 'target', '' );
40  $opts->add( 'showlinkedto', false );
41 
42  return $opts;
43  }
44 
45  public function parseParameters( $par, FormOptions $opts ) {
46  $opts['target'] = $par;
47  }
48 
49  public function doMainQuery( $conds, $opts ) {
50  $target = $opts['target'];
51  $showlinkedto = $opts['showlinkedto'];
52  $limit = $opts['limit'];
53 
54  if ( $target === '' ) {
55  return false;
56  }
57  $outputPage = $this->getOutput();
58  $title = Title::newFromText( $target );
59  if ( !$title || $title->isExternal() ) {
60  $outputPage->addHTML( '<div class="errorbox">' . $this->msg( 'allpagesbadtitle' )
61  ->parse() . '</div>' );
62 
63  return false;
64  }
65 
66  $outputPage->setPageTitle( $this->msg( 'recentchangeslinked-title', $title->getPrefixedText() ) );
67 
68  /*
69  * Ordinary links are in the pagelinks table, while transclusions are
70  * in the templatelinks table, categorizations in categorylinks and
71  * image use in imagelinks. We need to somehow combine all these.
72  * Special:Whatlinkshere does this by firing multiple queries and
73  * merging the results, but the code we inherit from our parent class
74  * expects only one result set so we use UNION instead.
75  */
76 
77  $dbr = wfGetDB( DB_REPLICA, 'recentchangeslinked' );
78  $id = $title->getArticleID();
79  $ns = $title->getNamespace();
80  $dbkey = $title->getDBkey();
81 
82  $tables = [ 'recentchanges' ];
83  $select = RecentChange::selectFields();
84  $join_conds = [];
85  $query_options = [];
86 
87  // left join with watchlist table to highlight watched rows
88  $uid = $this->getUser()->getId();
89  if ( $uid && $this->getUser()->isAllowed( 'viewmywatchlist' ) ) {
90  $tables[] = 'watchlist';
91  $select[] = 'wl_user';
92  $join_conds['watchlist'] = [ 'LEFT JOIN', [
93  'wl_user' => $uid,
94  'wl_title=rc_title',
95  'wl_namespace=rc_namespace'
96  ] ];
97  }
98  if ( $this->getUser()->isAllowed( 'rollback' ) ) {
99  $tables[] = 'page';
100  $join_conds['page'] = [ 'LEFT JOIN', 'rc_cur_id=page_id' ];
101  $select[] = 'page_latest';
102  }
104  $tables,
105  $select,
106  $conds,
107  $join_conds,
108  $query_options,
109  $opts['tagfilter']
110  );
111 
112  if ( !$this->runMainQueryHook( $tables, $select, $conds, $query_options, $join_conds,
113  $opts )
114  ) {
115  return false;
116  }
117 
118  if ( $ns == NS_CATEGORY && !$showlinkedto ) {
119  // special handling for categories
120  // XXX: should try to make this less kludgy
121  $link_tables = [ 'categorylinks' ];
122  $showlinkedto = true;
123  } else {
124  // for now, always join on these tables; really should be configurable as in whatlinkshere
125  $link_tables = [ 'pagelinks', 'templatelinks' ];
126  // imagelinks only contains links to pages in NS_FILE
127  if ( $ns == NS_FILE || !$showlinkedto ) {
128  $link_tables[] = 'imagelinks';
129  }
130  }
131 
132  if ( $id == 0 && !$showlinkedto ) {
133  return false; // nonexistent pages can't link to any pages
134  }
135 
136  // field name prefixes for all the various tables we might want to join with
137  $prefix = [
138  'pagelinks' => 'pl',
139  'templatelinks' => 'tl',
140  'categorylinks' => 'cl',
141  'imagelinks' => 'il'
142  ];
143 
144  $subsql = []; // SELECT statements to combine with UNION
145 
146  foreach ( $link_tables as $link_table ) {
147  $pfx = $prefix[$link_table];
148 
149  // imagelinks and categorylinks tables have no xx_namespace field,
150  // and have xx_to instead of xx_title
151  if ( $link_table == 'imagelinks' ) {
152  $link_ns = NS_FILE;
153  } elseif ( $link_table == 'categorylinks' ) {
154  $link_ns = NS_CATEGORY;
155  } else {
156  $link_ns = 0;
157  }
158 
159  if ( $showlinkedto ) {
160  // find changes to pages linking to this page
161  if ( $link_ns ) {
162  if ( $ns != $link_ns ) {
163  continue;
164  } // should never happen, but check anyway
165  $subconds = [ "{$pfx}_to" => $dbkey ];
166  } else {
167  $subconds = [ "{$pfx}_namespace" => $ns, "{$pfx}_title" => $dbkey ];
168  }
169  $subjoin = "rc_cur_id = {$pfx}_from";
170  } else {
171  // find changes to pages linked from this page
172  $subconds = [ "{$pfx}_from" => $id ];
173  if ( $link_table == 'imagelinks' || $link_table == 'categorylinks' ) {
174  $subconds["rc_namespace"] = $link_ns;
175  $subjoin = "rc_title = {$pfx}_to";
176  } else {
177  $subjoin = [ "rc_namespace = {$pfx}_namespace", "rc_title = {$pfx}_title" ];
178  }
179  }
180 
181  if ( $dbr->unionSupportsOrderAndLimit() ) {
182  $order = [ 'ORDER BY' => 'rc_timestamp DESC' ];
183  } else {
184  $order = [];
185  }
186 
187  $query = $dbr->selectSQLText(
188  array_merge( $tables, [ $link_table ] ),
189  $select,
190  $conds + $subconds,
191  __METHOD__,
192  $order + $query_options,
193  $join_conds + [ $link_table => [ 'INNER JOIN', $subjoin ] ]
194  );
195 
196  if ( $dbr->unionSupportsOrderAndLimit() ) {
197  $query = $dbr->limitResult( $query, $limit );
198  }
199 
200  $subsql[] = $query;
201  }
202 
203  if ( count( $subsql ) == 0 ) {
204  return false; // should never happen
205  }
206  if ( count( $subsql ) == 1 && $dbr->unionSupportsOrderAndLimit() ) {
207  $sql = $subsql[0];
208  } else {
209  // need to resort and relimit after union
210  $sql = $dbr->unionQueries( $subsql, false ) . ' ORDER BY rc_timestamp DESC';
211  $sql = $dbr->limitResult( $sql, $limit, false );
212  }
213 
214  $res = $dbr->query( $sql, __METHOD__ );
215 
216  if ( $res->numRows() == 0 ) {
217  $this->mResultEmpty = true;
218  }
219 
220  return $res;
221  }
222 
223  function setTopText( FormOptions $opts ) {
224  $target = $this->getTargetTitle();
225  if ( $target ) {
226  $this->getOutput()->addBacklinkSubtitle( $target );
227  $this->getSkin()->setRelevantTitle( $target );
228  }
229  }
230 
237  function getExtraOptions( $opts ) {
238  $extraOpts = parent::getExtraOptions( $opts );
239 
240  $opts->consumeValues( [ 'showlinkedto', 'target' ] );
241 
242  $extraOpts['target'] = [ $this->msg( 'recentchangeslinked-page' )->escaped(),
243  Xml::input( 'target', 40, str_replace( '_', ' ', $opts['target'] ) ) .
244  Xml::check( 'showlinkedto', $opts['showlinkedto'], [ 'id' => 'showlinkedto' ] ) . ' ' .
245  Xml::label( $this->msg( 'recentchangeslinked-to' )->text(), 'showlinkedto' ) ];
246 
247  $this->addHelpLink( 'Help:Related changes' );
248  return $extraOpts;
249  }
250 
254  function getTargetTitle() {
255  if ( $this->rclTargetTitle === null ) {
256  $opts = $this->getOptions();
257  if ( isset( $opts['target'] ) && $opts['target'] !== '' ) {
258  $this->rclTargetTitle = Title::newFromText( $opts['target'] );
259  } else {
260  $this->rclTargetTitle = false;
261  }
262  }
263 
264  return $this->rclTargetTitle;
265  }
266 
275  public function prefixSearchSubpages( $search, $limit, $offset ) {
276  return $this->prefixSearchString( $search, $limit, $offset );
277  }
278 }
Helper class to keep track of options when mixing links and form elements.
Definition: FormOptions.php:35
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:1555
static input($name, $size=false, $value=false, $attribs=[])
Convenience function to build an HTML text input field.
Definition: Xml.php:275
A special page that lists last changes made to the wiki.
msg()
Wrapper around wfMessage that sets the current context.
getOutput()
Get the OutputPage being used for this instance.
static check($name, $checked=false, $attribs=[])
Convenience function to build an HTML checkbox.
Definition: Xml.php:324
static newFromText($text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:262
getOptions()
Get the current FormOptions for this request.
addHelpLink($to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist & $tables
Definition: hooks.txt:1007
static label($label, $id, $attribs=[])
Convenience function to build an HTML form label.
Definition: Xml.php:359
parseParameters($par, FormOptions $opts)
$res
Definition: database.txt:21
getExtraOptions($opts)
Get options to be displayed in a form.
const NS_CATEGORY
Definition: Defines.php:70
getSkin()
Shortcut to get the skin being used for this instance.
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:953
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
const NS_FILE
Definition: Defines.php:62
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
static selectFields()
Return the list of recentchanges fields that should be selected to create a new recentchanges object...
static modifyDisplayQuery(&$tables, &$fields, &$conds, &$join_conds, &$options, $filter_tag=false)
Applies all tags-related changes to a query.
Definition: ChangeTags.php:629
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
getUser()
Shortcut to get the User executing this instance.
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:1046
const DB_REPLICA
Definition: defines.php:22
This is to display changes made to all articles linked in an article.
runMainQueryHook(&$tables, &$fields, &$conds, &$query_options, &$join_conds, $opts)
prefixSearchSubpages($search, $limit, $offset)
Return an array of subpages beginning with $search that this special page will accept.
prefixSearchString($search, $limit, $offset)
Perform a regular substring search for prefixSearchSubpages.