MediaWiki  1.23.2
ApiWatch.php
Go to the documentation of this file.
1 <?php
32 class ApiWatch extends ApiBase {
33  private $mPageSet = null;
34 
35  public function execute() {
36  $user = $this->getUser();
37  if ( !$user->isLoggedIn() ) {
38  $this->dieUsage( 'You must be logged-in to have a watchlist', 'notloggedin' );
39  }
40 
41  if ( !$user->isAllowed( 'editmywatchlist' ) ) {
42  $this->dieUsage( 'You don\'t have permission to edit your watchlist', 'permissiondenied' );
43  }
44 
45  $params = $this->extractRequestParams();
46  $pageSet = $this->getPageSet();
47  // by default we use pageset to extract the page to work on.
48  // title is still supported for backward compatibility
49  if ( !isset( $params['title'] ) ) {
50  $pageSet->execute();
51  $res = $pageSet->getInvalidTitlesAndRevisions( array(
52  'invalidTitles',
53  'special',
54  'missingIds',
55  'missingRevIds',
56  'interwikiTitles'
57  ) );
58 
59  foreach ( $pageSet->getMissingTitles() as $title ) {
60  $r = $this->watchTitle( $title, $user, $params );
61  $r['missing'] = 1;
62  $res[] = $r;
63  }
64 
65  foreach ( $pageSet->getGoodTitles() as $title ) {
66  $r = $this->watchTitle( $title, $user, $params );
67  $res[] = $r;
68  }
69  $this->getResult()->setIndexedTagName( $res, 'w' );
70  } else {
71  // dont allow use of old title parameter with new pageset parameters.
72  $extraParams = array_keys( array_filter( $pageSet->extractRequestParams(), function ( $x ) {
73  return $x !== null && $x !== false;
74  } ) );
75 
76  if ( $extraParams ) {
77  $p = $this->getModulePrefix();
78  $this->dieUsage(
79  "The parameter {$p}title can not be used with " . implode( ", ", $extraParams ),
80  'invalidparammix'
81  );
82  }
83 
84  $title = Title::newFromText( $params['title'] );
85  if ( !$title || !$title->isWatchable() ) {
86  $this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
87  }
88  $res = $this->watchTitle( $title, $user, $params, true );
89  }
90  $this->getResult()->addValue( null, $this->getModuleName(), $res );
91  }
92 
93  private function watchTitle( Title $title, User $user, array $params,
94  $compatibilityMode = false
95  ) {
96  if ( !$title->isWatchable() ) {
97  return array( 'title' => $title->getPrefixedText(), 'watchable' => 0 );
98  }
99 
100  $res = array( 'title' => $title->getPrefixedText() );
101 
102  // Currently unnecessary, code to act as a safeguard against any change
103  // in current behavior of uselang.
104  // Copy from ApiParse
105  $oldLang = null;
106  if ( isset( $params['uselang'] ) &&
107  $params['uselang'] != $this->getContext()->getLanguage()->getCode()
108  ) {
109  $oldLang = $this->getContext()->getLanguage(); // Backup language
110  $this->getContext()->setLanguage( Language::factory( $params['uselang'] ) );
111  }
112 
113  if ( $params['unwatch'] ) {
114  $status = UnwatchAction::doUnwatch( $title, $user );
115  if ( $status->isOK() ) {
116  $res['unwatched'] = '';
117  $res['message'] = $this->msg( 'removedwatchtext', $title->getPrefixedText() )
118  ->title( $title )->parseAsBlock();
119  }
120  } else {
121  $status = WatchAction::doWatch( $title, $user );
122  if ( $status->isOK() ) {
123  $res['watched'] = '';
124  $res['message'] = $this->msg( 'addedwatchtext', $title->getPrefixedText() )
125  ->title( $title )->parseAsBlock();
126  }
127  }
128 
129  if ( !is_null( $oldLang ) ) {
130  $this->getContext()->setLanguage( $oldLang ); // Reset language to $oldLang
131  }
132 
133  if ( !$status->isOK() ) {
134  if ( $compatibilityMode ) {
135  $this->dieStatus( $status );
136  }
137  $res['error'] = $this->getErrorFromStatus( $status );
138  }
139 
140  return $res;
141  }
142 
147  private function getPageSet() {
148  if ( $this->mPageSet === null ) {
149  $this->mPageSet = new ApiPageSet( $this );
150  }
151 
152  return $this->mPageSet;
153  }
154 
155  public function mustBePosted() {
156  return true;
157  }
158 
159  public function isWriteMode() {
160  return true;
161  }
162 
163  public function needsToken() {
164  return true;
165  }
166 
167  public function getTokenSalt() {
168  return 'watch';
169  }
170 
171  public function getAllowedParams( $flags = 0 ) {
172  $result = array(
173  'title' => array(
174  ApiBase::PARAM_TYPE => 'string',
176  ),
177  'unwatch' => false,
178  'uselang' => null,
179  'token' => array(
180  ApiBase::PARAM_TYPE => 'string',
182  ),
183  );
184  if ( $flags ) {
185  $result += $this->getPageSet()->getFinalParams( $flags );
186  }
187 
188  return $result;
189  }
190 
191  public function getParamDescription() {
192  $psModule = $this->getPageSet();
193 
194  return $psModule->getParamDescription() + array(
195  'title' => 'The page to (un)watch. use titles instead',
196  'unwatch' => 'If set the page will be unwatched rather than watched',
197  'uselang' => 'Language to show the message in',
198  'token' => 'A token previously acquired via prop=info',
199  );
200  }
201 
202  public function getResultProperties() {
203  return array(
204  '' => array(
205  'title' => 'string',
206  'unwatched' => 'boolean',
207  'watched' => 'boolean',
208  'message' => 'string'
209  )
210  );
211  }
212 
213  public function getDescription() {
214  return 'Add or remove pages from/to the current user\'s watchlist.';
215  }
216 
217  public function getPossibleErrors() {
218  return array_merge( parent::getPossibleErrors(), array(
219  array( 'code' => 'notloggedin', 'info' => 'You must be logged-in to have a watchlist' ),
220  array( 'invalidtitle', 'title' ),
221  array( 'hookaborted' ),
222  ) );
223  }
224 
225  public function getExamples() {
226  return array(
227  'api.php?action=watch&titles=Main_Page' => 'Watch the page "Main Page"',
228  'api.php?action=watch&titles=Main_Page&unwatch=' => 'Unwatch the page "Main Page"',
229  );
230  }
231 
232  public function getHelpUrls() {
233  return 'https://www.mediawiki.org/wiki/API:Watch';
234  }
235 }
ApiBase\dieStatus
dieStatus( $status)
Throw a UsageException based on the errors in the Status object.
Definition: ApiBase.php:1419
$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. $reader:XMLReader object $logInfo:Array of information Return false to stop further processing of the tag 'ImportHandlePageXMLTag':When parsing a XML tag in a page. $reader:XMLReader object $pageInfo:Array of information Return false to stop further processing of the tag 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information Return false to stop further processing of the tag 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. $reader:XMLReader object Return false to stop further processing of the tag 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. $reader:XMLReader object $revisionInfo:Array of information Return false to stop further processing of the tag '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 '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. '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 '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 '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 wfIsTrustedProxy() $ip:IP being check $result:Change this value to override the result of wfIsTrustedProxy() '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 User::isValidEmailAddr(), 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. '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 '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) '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. '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:1528
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:189
ContextSource\getContext
getContext()
Get the RequestContext object.
Definition: ContextSource.php:40
php
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
Definition: skin.txt:62
ApiBase\PARAM_REQUIRED
const PARAM_REQUIRED
Definition: ApiBase.php:62
ContextSource\msg
msg()
Get a Message object with context set Parameters are the same as wfMessage()
Definition: ContextSource.php:175
ApiWatch\getPageSet
getPageSet()
Get a cached instance of an ApiPageSet object.
Definition: ApiWatch.php:147
ApiWatch\getHelpUrls
getHelpUrls()
Definition: ApiWatch.php:232
ApiWatch
API module to allow users to watch a page.
Definition: ApiWatch.php:32
WatchAction\doUnwatch
static doUnwatch(Title $title, User $user)
Unwatch a page.
Definition: WatchAction.php:158
ApiBase\dieUsageMsg
dieUsageMsg( $error)
Output the error message related to a certain array.
Definition: ApiBase.php:1929
ApiWatch\$mPageSet
$mPageSet
Definition: ApiWatch.php:33
ApiBase\PARAM_TYPE
const PARAM_TYPE
Definition: ApiBase.php:50
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:205
Title\getPrefixedText
getPrefixedText()
Get the prefixed title with spaces.
Definition: Title.php:1369
ApiWatch\getParamDescription
getParamDescription()
Returns an array of parameter descriptions.
Definition: ApiWatch.php:191
$params
$params
Definition: styleTest.css.php:40
$flags
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition: hooks.txt:2113
ContextSource\getUser
getUser()
Get the User object.
Definition: ContextSource.php:132
ApiWatch\getAllowedParams
getAllowedParams( $flags=0)
Definition: ApiWatch.php:171
ApiPageSet
This class contains a list of pages that the client has requested.
Definition: ApiPageSet.php:41
ApiBase
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:42
ApiWatch\getExamples
getExamples()
Returns usage examples for this module.
Definition: ApiWatch.php:225
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:2703
ApiBase\PARAM_DEPRECATED
const PARAM_DEPRECATED
Definition: ApiBase.php:60
ApiWatch\mustBePosted
mustBePosted()
Indicates whether this module must be called with a POST request.
Definition: ApiWatch.php:155
ApiWatch\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiWatch.php:35
ApiWatch\getPossibleErrors
getPossibleErrors()
Returns a list of all possible errors returned by the module.
Definition: ApiWatch.php:217
array
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
ApiWatch\watchTitle
watchTitle(Title $title, User $user, array $params, $compatibilityMode=false)
Definition: ApiWatch.php:93
ApiWatch\getResultProperties
getResultProperties()
Returns possible properties in the result, grouped by the value of the prop parameter that shows them...
Definition: ApiWatch.php:202
ApiBase\getModulePrefix
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition: ApiBase.php:165
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:687
$title
presenting them properly to the user as errors is done by the caller $title
Definition: hooks.txt:1324
ApiBase\dieUsage
dieUsage( $description, $errorCode, $httpRespCode=0, $extradata=null)
Throw a UsageException, which will (if uncaught) call the main module's error handler and die with an...
Definition: ApiBase.php:1363
$user
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 account $user
Definition: hooks.txt:237
Title
Represents a title within MediaWiki.
Definition: Title.php:35
ApiBase\getErrorFromStatus
getErrorFromStatus( $status)
Get error (as code, string) from a Status object.
Definition: ApiBase.php:1380
ApiWatch\isWriteMode
isWriteMode()
Indicates whether this module requires write mode.
Definition: ApiWatch.php:159
ApiWatch\needsToken
needsToken()
Returns whether this module requires a token to execute It is used to show possible errors in action=...
Definition: ApiWatch.php:163
as
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
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:148
ApiWatch\getDescription
getDescription()
Returns the description string for this module.
Definition: ApiWatch.php:213
Language\factory
static factory( $code)
Get a cached or new language object for a given language code.
Definition: Language.php:184
ApiWatch\getTokenSalt
getTokenSalt()
Returns the token salt if there is one, '' if the module doesn't require a salt, else false if the mo...
Definition: ApiWatch.php:167
WatchAction\doWatch
static doWatch(Title $title, User $user, $checkRights=WatchedItem::CHECK_USER_RIGHTS)
Watch a page.
Definition: WatchAction.php:130
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:59
$res
$res
Definition: database.txt:21