MediaWiki  REL1_31
ApiSetNotificationTimestamp.php
Go to the documentation of this file.
1 <?php
2 
26 
32 
33  private $mPageSet = null;
34 
35  public function execute() {
36  $user = $this->getUser();
37 
38  if ( $user->isAnon() ) {
39  $this->dieWithError( 'watchlistanontext', 'notloggedin' );
40  }
41  $this->checkUserRightsAny( 'editmywatchlist' );
42 
43  $params = $this->extractRequestParams();
44  $this->requireMaxOneParameter( $params, 'timestamp', 'torevid', 'newerthanrevid' );
45 
46  $continuationManager = new ApiContinuationManager( $this, [], [] );
47  $this->setContinuationManager( $continuationManager );
48 
49  $pageSet = $this->getPageSet();
50  if ( $params['entirewatchlist'] && $pageSet->getDataSource() !== null ) {
51  $this->dieWithError(
52  [
53  'apierror-invalidparammix-cannotusewith',
54  $this->encodeParamName( 'entirewatchlist' ),
55  $pageSet->encodeParamName( $pageSet->getDataSource() )
56  ],
57  'multisource'
58  );
59  }
60 
61  $dbw = wfGetDB( DB_MASTER, 'api' );
62 
63  $timestamp = null;
64  if ( isset( $params['timestamp'] ) ) {
65  $timestamp = $dbw->timestamp( $params['timestamp'] );
66  }
67 
68  if ( !$params['entirewatchlist'] ) {
69  $pageSet->execute();
70  }
71 
72  if ( isset( $params['torevid'] ) ) {
73  if ( $params['entirewatchlist'] || $pageSet->getGoodTitleCount() > 1 ) {
74  $this->dieWithError( [ 'apierror-multpages', $this->encodeParamName( 'torevid' ) ] );
75  }
76  $title = reset( $pageSet->getGoodTitles() );
77  if ( $title ) {
78  $timestamp = Revision::getTimestampFromId(
79  $title, $params['torevid'], Revision::READ_LATEST );
80  if ( $timestamp ) {
81  $timestamp = $dbw->timestamp( $timestamp );
82  } else {
83  $timestamp = null;
84  }
85  }
86  } elseif ( isset( $params['newerthanrevid'] ) ) {
87  if ( $params['entirewatchlist'] || $pageSet->getGoodTitleCount() > 1 ) {
88  $this->dieWithError( [ 'apierror-multpages', $this->encodeParamName( 'newerthanrevid' ) ] );
89  }
90  $title = reset( $pageSet->getGoodTitles() );
91  if ( $title ) {
92  $revid = $title->getNextRevisionID(
93  $params['newerthanrevid'], Title::GAID_FOR_UPDATE );
94  if ( $revid ) {
95  $timestamp = $dbw->timestamp( Revision::getTimestampFromId( $title, $revid ) );
96  } else {
97  $timestamp = null;
98  }
99  }
100  }
101 
102  $watchedItemStore = MediaWikiServices::getInstance()->getWatchedItemStore();
103  $apiResult = $this->getResult();
104  $result = [];
105  if ( $params['entirewatchlist'] ) {
106  // Entire watchlist mode: Just update the thing and return a success indicator
107  $watchedItemStore->setNotificationTimestampsForUser(
108  $user,
109  $timestamp
110  );
111 
112  $result['notificationtimestamp'] = is_null( $timestamp )
113  ? ''
114  : wfTimestamp( TS_ISO_8601, $timestamp );
115  } else {
116  // First, log the invalid titles
117  foreach ( $pageSet->getInvalidTitlesAndReasons() as $r ) {
118  $r['invalid'] = true;
119  $result[] = $r;
120  }
121  foreach ( $pageSet->getMissingPageIDs() as $p ) {
122  $page = [];
123  $page['pageid'] = $p;
124  $page['missing'] = true;
125  $page['notwatched'] = true;
126  $result[] = $page;
127  }
128  foreach ( $pageSet->getMissingRevisionIDs() as $r ) {
129  $rev = [];
130  $rev['revid'] = $r;
131  $rev['missing'] = true;
132  $rev['notwatched'] = true;
133  $result[] = $rev;
134  }
135 
136  if ( $pageSet->getTitles() ) {
137  // Now process the valid titles
138  $watchedItemStore->setNotificationTimestampsForUser(
139  $user,
140  $timestamp,
141  $pageSet->getTitles()
142  );
143 
144  // Query the results of our update
145  $timestamps = $watchedItemStore->getNotificationTimestampsBatch(
146  $user,
147  $pageSet->getTitles()
148  );
149 
150  // Now, put the valid titles into the result
152  foreach ( $pageSet->getTitles() as $title ) {
153  $ns = $title->getNamespace();
154  $dbkey = $title->getDBkey();
155  $r = [
156  'ns' => intval( $ns ),
157  'title' => $title->getPrefixedText(),
158  ];
159  if ( !$title->exists() ) {
160  $r['missing'] = true;
161  if ( $title->isKnown() ) {
162  $r['known'] = true;
163  }
164  }
165  if ( isset( $timestamps[$ns] ) && array_key_exists( $dbkey, $timestamps[$ns] ) ) {
166  $r['notificationtimestamp'] = '';
167  if ( $timestamps[$ns][$dbkey] !== null ) {
168  $r['notificationtimestamp'] = wfTimestamp( TS_ISO_8601, $timestamps[$ns][$dbkey] );
169  }
170  } else {
171  $r['notwatched'] = true;
172  }
173  $result[] = $r;
174  }
175  }
176 
178  }
179  $apiResult->addValue( null, $this->getModuleName(), $result );
180 
181  $this->setContinuationManager( null );
182  $continuationManager->setContinuationIntoResult( $apiResult );
183  }
184 
189  private function getPageSet() {
190  if ( $this->mPageSet === null ) {
191  $this->mPageSet = new ApiPageSet( $this );
192  }
193 
194  return $this->mPageSet;
195  }
196 
197  public function mustBePosted() {
198  return true;
199  }
200 
201  public function isWriteMode() {
202  return true;
203  }
204 
205  public function needsToken() {
206  return 'csrf';
207  }
208 
209  public function getAllowedParams( $flags = 0 ) {
210  $result = [
211  'entirewatchlist' => [
212  ApiBase::PARAM_TYPE => 'boolean'
213  ],
214  'timestamp' => [
215  ApiBase::PARAM_TYPE => 'timestamp'
216  ],
217  'torevid' => [
218  ApiBase::PARAM_TYPE => 'integer'
219  ],
220  'newerthanrevid' => [
221  ApiBase::PARAM_TYPE => 'integer'
222  ],
223  'continue' => [
224  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
225  ],
226  ];
227  if ( $flags ) {
228  $result += $this->getPageSet()->getFinalParams( $flags );
229  }
230 
231  return $result;
232  }
233 
234  protected function getExamplesMessages() {
235  return [
236  'action=setnotificationtimestamp&entirewatchlist=&token=123ABC'
237  => 'apihelp-setnotificationtimestamp-example-all',
238  'action=setnotificationtimestamp&titles=Main_page&token=123ABC'
239  => 'apihelp-setnotificationtimestamp-example-page',
240  'action=setnotificationtimestamp&titles=Main_page&' .
241  'timestamp=2012-01-01T00:00:00Z&token=123ABC'
242  => 'apihelp-setnotificationtimestamp-example-pagetimestamp',
243  'action=setnotificationtimestamp&generator=allpages&gapnamespace=2&token=123ABC'
244  => 'apihelp-setnotificationtimestamp-example-allpages',
245  ];
246  }
247 
248  public function getHelpUrls() {
249  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:SetNotificationTimestamp';
250  }
251 }
$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:247
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
ApiContinuationManager
This manages continuation state.
Definition: ApiContinuationManager.php:26
ApiBase\dieWithError
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1895
ApiBase\PARAM_HELP_MSG
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:124
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1980
ApiBase\PARAM_TYPE
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition: ApiBase.php:87
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:641
ApiSetNotificationTimestamp\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiSetNotificationTimestamp.php:234
ApiBase\checkUserRightsAny
checkUserRightsAny( $rights, $user=null)
Helper function for permission-denied errors.
Definition: ApiBase.php:2006
ApiSetNotificationTimestamp\mustBePosted
mustBePosted()
Indicates whether this module must be called with a POST request.
Definition: ApiSetNotificationTimestamp.php:197
ApiBase\setContinuationManager
setContinuationManager(ApiContinuationManager $manager=null)
Set the continuation manager.
Definition: ApiBase.php:695
$params
$params
Definition: styleTest.css.php:40
$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. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. '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 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name '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:1993
ContextSource\getUser
getUser()
Definition: ContextSource.php:120
ApiPageSet
This class contains a list of pages that the client has requested.
Definition: ApiPageSet.php:40
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:37
ApiBase
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:37
Revision\getTimestampFromId
static getTimestampFromId( $title, $id, $flags=0)
Get rev_timestamp from rev_id, without loading the rest of the row.
Definition: Revision.php:1225
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2812
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
ApiSetNotificationTimestamp\getPageSet
getPageSet()
Get a cached instance of an ApiPageSet object.
Definition: ApiSetNotificationTimestamp.php:189
DB_MASTER
const DB_MASTER
Definition: defines.php:26
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:749
ApiResult\setIndexedTagName
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:616
ApiBase\encodeParamName
encodeParamName( $paramName)
This method mangles parameter name based on the prefix supplied to the constructor.
Definition: ApiBase.php:730
Title\GAID_FOR_UPDATE
const GAID_FOR_UPDATE
Used to be GAID_FOR_UPDATE define.
Definition: Title.php:54
ApiBase\requireMaxOneParameter
requireMaxOneParameter( $params, $required)
Die if more than one of a certain set of parameters is set and not false.
Definition: ApiBase.php:823
$rev
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:1777
ApiSetNotificationTimestamp\$mPageSet
$mPageSet
Definition: ApiSetNotificationTimestamp.php:33
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:22
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:521
ApiSetNotificationTimestamp\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiSetNotificationTimestamp.php:35
ApiSetNotificationTimestamp
API interface for setting the wl_notificationtimestamp field.
Definition: ApiSetNotificationTimestamp.php:31
ApiSetNotificationTimestamp\needsToken
needsToken()
Returns the token type this module requires in order to execute.
Definition: ApiSetNotificationTimestamp.php:205
MediaWikiServices
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:25
ApiSetNotificationTimestamp\getAllowedParams
getAllowedParams( $flags=0)
Definition: ApiSetNotificationTimestamp.php:209
ApiSetNotificationTimestamp\isWriteMode
isWriteMode()
Indicates whether this module requires write mode.
Definition: ApiSetNotificationTimestamp.php:201
ApiSetNotificationTimestamp\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiSetNotificationTimestamp.php:248