MediaWiki  1.30.0
SpecialCiteThisPage.php
Go to the documentation of this file.
1 <?php
2 
4 
8  private $citationParser;
9 
13  protected $title = false;
14 
15  public function __construct() {
16  parent::__construct( 'CiteThisPage' );
17  }
18 
22  public function execute( $par ) {
23  $this->setHeaders();
25  if ( $this->title instanceof Title ) {
26  $id = $this->getRequest()->getInt( 'id' );
27  $this->showCitations( $this->title, $id );
28  }
29  }
30 
31  protected function alterForm( HTMLForm $form ) {
32  $form->setMethod( 'get' );
33  }
34 
35  protected function getFormFields() {
36  if ( isset( $this->par ) ) {
37  $default = $this->par;
38  } else {
39  $default = '';
40  }
41  return [
42  'page' => [
43  'name' => 'page',
44  'type' => 'title',
45  'default' => $default,
46  'label-message' => 'citethispage-change-target'
47  ]
48  ];
49  }
50 
51  public function onSubmit( array $data ) {
52  // GET forms are "submitted" on every view, so check
53  // that some data was put in for page, as empty string
54  // will pass validation
55  if ( strlen( $data['page'] ) ) {
56  $this->title = Title::newFromText( $data['page'] );
57  }
58  }
59 
68  public function prefixSearchSubpages( $search, $limit, $offset ) {
69  $title = Title::newFromText( $search );
70  if ( !$title || !$title->canExist() ) {
71  // No prefix suggestion in special and media namespace
72  return [];
73  }
74  // Autocomplete subpage the same as a normal search
75  $prefixSearcher = new StringPrefixSearch;
76  $result = $prefixSearcher->search( $search, $limit, [], $offset );
77  return $result;
78  }
79 
80  protected function getGroupName() {
81  return 'pagetools';
82  }
83 
84  private function showCitations( Title $title, $revId ) {
85  if ( !$revId ) {
86  $revId = $title->getLatestRevID();
87  }
88 
89  $out = $this->getOutput();
90 
91  $revision = Revision::newFromTitle( $title, $revId );
92  if ( !$revision ) {
93  $out->wrapWikiMsg( '<div class="errorbox">$1</div>',
94  [ 'citethispage-badrevision', $title->getPrefixedText(), $revId ] );
95  return;
96  }
97 
98  $parserOptions = $this->getParserOptions();
99  // Set the overall timestamp to the revision's timestamp
100  $parserOptions->setTimestamp( $revision->getTimestamp() );
101 
102  $parser = $this->getParser();
103  // Register our <citation> tag which just parses using a different
104  // context
105  $parser->setHook( 'citation', [ $this, 'citationTag' ] );
106  // Also hold on to a separate Parser instance for <citation> tag parsing
107  // since we can't parse in a parse using the same Parser
108  $this->citationParser = $this->getParser();
109 
110  $ret = $parser->parse(
111  $this->getContentText(),
112  $title,
113  $parserOptions,
114  /* $linestart = */ false,
115  /* $clearstate = */ true,
116  $revId
117  );
118 
119  $this->getOutput()->addModuleStyles( 'ext.citeThisPage' );
120  $this->getOutput()->addParserOutputContent( $ret );
121  }
122 
126  private function getParser() {
127  $parserConf = $this->getConfig()->get( 'ParserConf' );
128  return new $parserConf['class']( $parserConf );
129  }
130 
136  private function getContentText() {
137  $msg = $this->msg( 'citethispage-content' )->inContentLanguage()->plain();
138  if ( $msg == '' ) {
139  # With MediaWiki 1.20 the plain text files were deleted
140  # and the text moved into SpecialCite.i18n.php
141  # This code is kept for b/c in case an installation has its own file "citethispage-content-xx"
142  # for a previously not supported language.
144  $dir = __DIR__ . DIRECTORY_SEPARATOR;
146  if ( file_exists( "${dir}citethispage-content-$code" ) ) {
147  $msg = file_get_contents( "${dir}citethispage-content-$code" );
148  } elseif ( file_exists( "${dir}citethispage-content" ) ) {
149  $msg = file_get_contents( "${dir}citethispage-content" );
150  }
151  }
152 
153  return $msg;
154  }
155 
161  private function getParserOptions() {
162  $parserOptions = ParserOptions::newFromUser( $this->getUser() );
163  $parserOptions->setDateFormat( 'default' );
164  $parserOptions->setEditSection( false );
165 
166  // Having tidy on causes whitespace and <pre> tags to
167  // be generated around the output of the CiteThisPageOutput
168  // class TODO FIXME.
169  $parserOptions->setTidy( false );
170 
171  return $parserOptions;
172  }
173 
186  public function citationTag( $text, $params, Parser $parser ) {
187  $ret = $this->citationParser->parse(
188  $text,
189  $this->getPageTitle(),
190  $this->getParserOptions(),
191  /* $linestart = */ false
192  );
193 
194  return $ret->getText();
195  }
196 
197  protected function getDisplayFormat() {
198  return 'ooui';
199  }
200 
201  public function requiresUnblock() {
202  return false;
203  }
204 
205  public function requiresWrite() {
206  return false;
207  }
208 }
SpecialPage\getPageTitle
getPageTitle( $subpage=false)
Get a self-referential title object.
Definition: SpecialPage.php:628
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:268
SpecialCiteThisPage\getParser
getParser()
Definition: SpecialCiteThisPage.php:126
SpecialPage\msg
msg( $key)
Wrapper around wfMessage that sets the current context.
Definition: SpecialPage.php:746
SpecialPage\getOutput
getOutput()
Get the OutputPage being used for this instance.
Definition: SpecialPage.php:675
SpecialCiteThisPage\showCitations
showCitations(Title $title, $revId)
Definition: SpecialCiteThisPage.php:84
SpecialCiteThisPage\getContentText
getContentText()
Get the content to parse.
Definition: SpecialCiteThisPage.php:136
$result
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: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! 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:1963
SpecialCiteThisPage\citationTag
citationTag( $text, $params, Parser $parser)
Implements the <citation> tag.
Definition: SpecialCiteThisPage.php:186
$wgContLanguageCode
$wgContLanguageCode
Definition: Setup.php:437
Title\getPrefixedText
getPrefixedText()
Get the prefixed title with spaces.
Definition: Title.php:1550
SpecialCiteThisPage\onSubmit
onSubmit(array $data)
Process the form on POST submission.
Definition: SpecialCiteThisPage.php:51
$params
$params
Definition: styleTest.css.php:40
FormSpecialPage
Special page which uses an HTMLForm to handle processing.
Definition: FormSpecialPage.php:31
SpecialCiteThisPage\requiresWrite
requiresWrite()
Whether this action requires the wiki not to be locked.
Definition: SpecialCiteThisPage.php:205
HTMLForm\setMethod
setMethod( $method='post')
Set the method used to submit the form.
Definition: HTMLForm.php:1593
php
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
title
to move a page</td >< td > &*You are moving the page across *A non empty talk page already exists under the new or *You uncheck the box below In those you will have to move or merge the page manually if desired</td >< td > be sure to &You are responsible for making sure that links continue to point where they are supposed to go Note that the page will &a page at the new title
Definition: All_system_messages.txt:2696
Revision\newFromTitle
static newFromTitle(LinkTarget $linkTarget, $id=0, $flags=0)
Load either the current, or a specified, revision that's attached to a given link target.
Definition: Revision.php:134
SpecialPage\getConfig
getConfig()
Shortcut to get main config object.
Definition: SpecialPage.php:714
PrefixSearch\search
search( $search, $limit, $namespaces=[], $offset=0)
Do a prefix search of titles and return a list of matching page names.
Definition: PrefixSearch.php:55
SpecialCiteThisPage
Definition: SpecialCiteThisPage.php:3
SpecialCiteThisPage\getDisplayFormat
getDisplayFormat()
Get display format for the form.
Definition: SpecialCiteThisPage.php:197
$parser
do that in ParserLimitReportFormat instead $parser
Definition: hooks.txt:2572
SpecialPage\setHeaders
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
Definition: SpecialPage.php:484
SpecialPage\getUser
getUser()
Shortcut to get the User executing this instance.
Definition: SpecialPage.php:685
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
SpecialCiteThisPage\requiresUnblock
requiresUnblock()
Whether this action cannot be executed by a blocked user.
Definition: SpecialCiteThisPage.php:201
Title\canExist
canExist()
Is this in a namespace that allows actual pages?
Definition: Title.php:1104
SpecialCiteThisPage\getFormFields
getFormFields()
Get an HTMLForm descriptor array.
Definition: SpecialCiteThisPage.php:35
$dir
$dir
Definition: Autoload.php:8
execute
$batch execute()
SpecialCiteThisPage\$title
Title bool $title
Definition: SpecialCiteThisPage.php:13
FormSpecialPage\$par
string $par
The sub-page of the special page.
Definition: FormSpecialPage.php:36
Title\getLatestRevID
getLatestRevID( $flags=0)
What is the page_latest field for this page?
Definition: Title.php:3420
SpecialPage\getRequest
getRequest()
Get the WebRequest being used for this instance.
Definition: SpecialPage.php:665
$ret
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:1965
SpecialCiteThisPage\__construct
__construct()
Definition: SpecialCiteThisPage.php:15
SpecialCiteThisPage\getParserOptions
getParserOptions()
Get the common ParserOptions for both parses.
Definition: SpecialCiteThisPage.php:161
Title
Represents a title within MediaWiki.
Definition: Title.php:39
SpecialCiteThisPage\$citationParser
Parser $citationParser
Definition: SpecialCiteThisPage.php:8
$code
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
Definition: hooks.txt:781
SpecialCiteThisPage\execute
execute( $par)
Definition: SpecialCiteThisPage.php:22
SpecialCiteThisPage\getGroupName
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Definition: SpecialCiteThisPage.php:80
StringPrefixSearch
Performs prefix search, returning strings.
Definition: PrefixSearch.php:395
SpecialCiteThisPage\prefixSearchSubpages
prefixSearchSubpages( $search, $limit, $offset)
Return an array of subpages beginning with $search that this special page will accept.
Definition: SpecialCiteThisPage.php:68
SpecialCiteThisPage\alterForm
alterForm(HTMLForm $form)
Play with the HTMLForm if you need to more substantially.
Definition: SpecialCiteThisPage.php:31
array
the array() calling protocol came about after MediaWiki 1.4rc1.
ParserOptions\newFromUser
static newFromUser( $user)
Get a ParserOptions object from a given user.
Definition: ParserOptions.php:978
$wgContLang
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the content language as $wgContLang
Definition: design.txt:56
HTMLForm
Object handling generic submission, CSRF protection, layout and other logic for UI forms.
Definition: HTMLForm.php:128
$out
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:781