MediaWiki  master
ApiSetNotificationTimestamp.php
Go to the documentation of this file.
1 <?php
2 
27 
33 
34  private $mPageSet = null;
35 
36  public function execute() {
37  $user = $this->getUser();
38 
39  if ( $user->isAnon() ) {
40  $this->dieWithError( 'watchlistanontext', 'notloggedin' );
41  }
42  $this->checkUserRightsAny( 'editmywatchlist' );
43 
44  $params = $this->extractRequestParams();
45  $this->requireMaxOneParameter( $params, 'timestamp', 'torevid', 'newerthanrevid' );
46 
47  $continuationManager = new ApiContinuationManager( $this, [], [] );
48  $this->setContinuationManager( $continuationManager );
49 
50  $pageSet = $this->getPageSet();
51  if ( $params['entirewatchlist'] && $pageSet->getDataSource() !== null ) {
52  $this->dieWithError(
53  [
54  'apierror-invalidparammix-cannotusewith',
55  $this->encodeParamName( 'entirewatchlist' ),
56  $pageSet->encodeParamName( $pageSet->getDataSource() )
57  ],
58  'multisource'
59  );
60  }
61 
62  $dbw = wfGetDB( DB_MASTER, 'api' );
63 
64  $timestamp = null;
65  if ( isset( $params['timestamp'] ) ) {
66  $timestamp = $dbw->timestamp( $params['timestamp'] );
67  }
68 
69  if ( !$params['entirewatchlist'] ) {
70  $pageSet->execute();
71  }
72 
73  if ( isset( $params['torevid'] ) ) {
74  if ( $params['entirewatchlist'] || $pageSet->getGoodTitleCount() > 1 ) {
75  $this->dieWithError( [ 'apierror-multpages', $this->encodeParamName( 'torevid' ) ] );
76  }
77  $titles = $pageSet->getGoodTitles();
78  $title = reset( $titles );
79  if ( $title ) {
80  $timestamp = MediaWikiServices::getInstance()->getRevisionStore()
81  ->getTimestampFromId( $title, $params['torevid'], IDBAccessObject::READ_LATEST );
82  if ( $timestamp ) {
83  $timestamp = $dbw->timestamp( $timestamp );
84  } else {
85  $timestamp = null;
86  }
87  }
88  } elseif ( isset( $params['newerthanrevid'] ) ) {
89  if ( $params['entirewatchlist'] || $pageSet->getGoodTitleCount() > 1 ) {
90  $this->dieWithError( [ 'apierror-multpages', $this->encodeParamName( 'newerthanrevid' ) ] );
91  }
92  $titles = $pageSet->getGoodTitles();
93  $title = reset( $titles );
94  if ( $title ) {
95  $revid = $title->getNextRevisionID( $params['newerthanrevid'], Title::GAID_FOR_UPDATE );
96  if ( $revid ) {
97  $timestamp = $dbw->timestamp(
98  MediaWikiServices::getInstance()->getRevisionStore()->getTimestampFromId( $title, $revid )
99  );
100  } else {
101  $timestamp = null;
102  }
103  }
104  }
105 
106  $watchedItemStore = MediaWikiServices::getInstance()->getWatchedItemStore();
107  $apiResult = $this->getResult();
108  $result = [];
109  if ( $params['entirewatchlist'] ) {
110  // Entire watchlist mode: Just update the thing and return a success indicator
111  $watchedItemStore->resetAllNotificationTimestampsForUser( $user, $timestamp );
112 
113  $result['notificationtimestamp'] = is_null( $timestamp )
114  ? ''
115  : wfTimestamp( TS_ISO_8601, $timestamp );
116  } else {
117  // First, log the invalid titles
118  foreach ( $pageSet->getInvalidTitlesAndReasons() as $r ) {
119  $r['invalid'] = true;
120  $result[] = $r;
121  }
122  foreach ( $pageSet->getMissingPageIDs() as $p ) {
123  $page = [];
124  $page['pageid'] = $p;
125  $page['missing'] = true;
126  $page['notwatched'] = true;
127  $result[] = $page;
128  }
129  foreach ( $pageSet->getMissingRevisionIDs() as $r ) {
130  $rev = [];
131  $rev['revid'] = $r;
132  $rev['missing'] = true;
133  $rev['notwatched'] = true;
134  $result[] = $rev;
135  }
136 
137  if ( $pageSet->getTitles() ) {
138  // Now process the valid titles
139  $watchedItemStore->setNotificationTimestampsForUser(
140  $user,
141  $timestamp,
142  $pageSet->getTitles()
143  );
144 
145  // Query the results of our update
146  $timestamps = $watchedItemStore->getNotificationTimestampsBatch(
147  $user,
148  $pageSet->getTitles()
149  );
150 
151  // Now, put the valid titles into the result
153  foreach ( $pageSet->getTitles() as $title ) {
154  $ns = $title->getNamespace();
155  $dbkey = $title->getDBkey();
156  $r = [
157  'ns' => (int)$ns,
158  'title' => $title->getPrefixedText(),
159  ];
160  if ( !$title->exists() ) {
161  $r['missing'] = true;
162  if ( $title->isKnown() ) {
163  $r['known'] = true;
164  }
165  }
166  if ( isset( $timestamps[$ns] ) && array_key_exists( $dbkey, $timestamps[$ns] ) ) {
167  $r['notificationtimestamp'] = '';
168  if ( $timestamps[$ns][$dbkey] !== null ) {
169  $r['notificationtimestamp'] = wfTimestamp( TS_ISO_8601, $timestamps[$ns][$dbkey] );
170  }
171  } else {
172  $r['notwatched'] = true;
173  }
174  $result[] = $r;
175  }
176  }
177 
179  }
180  $apiResult->addValue( null, $this->getModuleName(), $result );
181 
182  $this->setContinuationManager( null );
183  $continuationManager->setContinuationIntoResult( $apiResult );
184  }
185 
190  private function getPageSet() {
191  if ( $this->mPageSet === null ) {
192  $this->mPageSet = new ApiPageSet( $this );
193  }
194 
195  return $this->mPageSet;
196  }
197 
198  public function mustBePosted() {
199  return true;
200  }
201 
202  public function isWriteMode() {
203  return true;
204  }
205 
206  public function needsToken() {
207  return 'csrf';
208  }
209 
210  public function getAllowedParams( $flags = 0 ) {
211  $result = [
212  'entirewatchlist' => [
213  ApiBase::PARAM_TYPE => 'boolean'
214  ],
215  'timestamp' => [
216  ApiBase::PARAM_TYPE => 'timestamp'
217  ],
218  'torevid' => [
219  ApiBase::PARAM_TYPE => 'integer'
220  ],
221  'newerthanrevid' => [
222  ApiBase::PARAM_TYPE => 'integer'
223  ],
224  'continue' => [
225  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
226  ],
227  ];
228  if ( $flags ) {
229  $result += $this->getPageSet()->getFinalParams( $flags );
230  }
231 
232  return $result;
233  }
234 
235  protected function getExamplesMessages() {
236  return [
237  'action=setnotificationtimestamp&entirewatchlist=&token=123ABC'
238  => 'apihelp-setnotificationtimestamp-example-all',
239  'action=setnotificationtimestamp&titles=Main_page&token=123ABC'
240  => 'apihelp-setnotificationtimestamp-example-page',
241  'action=setnotificationtimestamp&titles=Main_page&' .
242  'timestamp=2012-01-01T00:00:00Z&token=123ABC'
243  => 'apihelp-setnotificationtimestamp-example-pagetimestamp',
244  'action=setnotificationtimestamp&generator=allpages&gapnamespace=2&token=123ABC'
245  => 'apihelp-setnotificationtimestamp-example-allpages',
246  ];
247  }
248 
249  public function getHelpUrls() {
250  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:SetNotificationTimestamp';
251  }
252 }
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:88
getResult()
Get the result object.
Definition: ApiBase.php:633
This class contains a list of pages that the client has requested.
Definition: ApiPageSet.php:40
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
This manages continuation state.
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1991
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:744
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:23
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:616
const DB_MASTER
Definition: defines.php:26
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 '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. '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 '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 since 1.28! 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:1980
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
const GAID_FOR_UPDATE
Used to be GAID_FOR_UPDATE define.
Definition: Title.php:55
setContinuationManager(ApiContinuationManager $manager=null)
Set the continuation manager.
Definition: ApiBase.php:687
$params
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:513
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:1766
API interface for setting the wl_notificationtimestamp field.
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
requireMaxOneParameter( $params, $required)
Die if more than one of a certain set of parameters is set and not false.
Definition: ApiBase.php:914
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:125
encodeParamName( $paramName)
This method mangles parameter name based on the prefix supplied to the constructor.
Definition: ApiBase.php:722
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
linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in so the link cache is mostly useful for short snippets of parsed and for links in the navigation areas of the skin The link cache was formerly used to track links used in a document for the purposes of updating the link tables This application is now deprecated To create a you can use the following $titles
Definition: linkcache.txt:17
This abstract class implements many basic API functions, and is the base of all API classes...
Definition: ApiBase.php:38
checkUserRightsAny( $rights, $user=null)
Helper function for permission-denied errors.
Definition: ApiBase.php:2106
getPageSet()
Get a cached instance of an ApiPageSet object.
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1473