MediaWiki  master
MediaWiki\Rest\Handler\PageHistoryCountHandler Class Reference

Handler class for Core REST API endpoints that perform operations on revisions. More...

Inheritance diagram for MediaWiki\Rest\Handler\PageHistoryCountHandler:
Collaboration diagram for MediaWiki\Rest\Handler\PageHistoryCountHandler:

Public Member Functions

 __construct (RevisionStore $revisionStore, NameTableStoreFactory $nameTableStoreFactory, GroupPermissionsLookup $groupPermissionsLookup, ILoadBalancer $loadBalancer, WANObjectCache $cache, PageLookup $pageLookup, ActorMigration $actorMigration)
 
 getParamSettings ()
 Fetch ParamValidator settings for parameters. More...
 
 needsWriteAccess ()
 Indicates whether this route requires write access. More...
 
 run ( $title, $type)
 
- Public Member Functions inherited from MediaWiki\Rest\SimpleHandler
 execute ()
 Execute the handler. More...
 
- Public Member Functions inherited from MediaWiki\Rest\Handler
 applyConditionalResponseHeaders (ResponseInterface $response)
 Modify the response, adding Last-Modified and ETag headers as indicated the values previously returned by ETag and getLastModified(). More...
 
 checkPreconditions ()
 Check the conditional request headers and generate a response if appropriate. More...
 
 getAuthority ()
 Get the current acting authority. More...
 
 getBodyValidator ( $contentType)
 Fetch the BodyValidator. More...
 
 getConfig ()
 Get the configuration array for the current route. More...
 
 getRequest ()
 Get the current request. More...
 
 getResponseFactory ()
 Get the ResponseFactory which can be used to generate Response objects. More...
 
 getValidatedBody ()
 Fetch the validated body. More...
 
 getValidatedParams ()
 Fetch the validated parameters. More...
 
 init (Router $router, RequestInterface $request, array $config, Authority $authority, ResponseFactory $responseFactory, HookContainer $hookContainer)
 Initialise with dependencies from the Router. More...
 
 needsReadAccess ()
 Indicates whether this route requires read rights. More...
 
 validate (Validator $restValidator)
 Validate the request parameters/attributes and body. More...
 

Protected Member Functions

 getAnonCount ( $pageId, RevisionRecord $fromRev=null)
 
 getBotCount ( $pageId, RevisionRecord $fromRev=null)
 
 getEditorsCount ( $pageId, RevisionRecord $fromRev=null, RevisionRecord $toRev=null)
 
 getEditsCount ( $pageId, RevisionRecord $fromRev=null, RevisionRecord $toRev=null)
 
 getEtag ()
 Choosing to not implement etags in this handler. More...
 
 getLastModified ()
 Returns latest of 2 timestamps: More...
 
 getLastModifiedTimes ()
 Returns array with 2 timestamps: More...
 
 getMinorCount ( $pageId, RevisionRecord $fromRev=null)
 
 getRevertedCount ( $pageId, RevisionRecord $fromRev=null)
 
- Protected Member Functions inherited from MediaWiki\Rest\Handler
 getConditionalHeaderUtil ()
 Get a ConditionalHeaderUtil object. More...
 
 getETag ()
 The subclass should override this to provide an ETag for the current request. More...
 
 getHookContainer ()
 Get a HookContainer, for running extension hooks or for hook metadata. More...
 
 getHookRunner ()
 Get a HookRunner for running core hooks. More...
 
 getRouter ()
 Get the Router. More...
 
 getRouteUrl ( $pathParams=[], $queryParams=[])
 Get the URL of this handler's endpoint. More...
 
 hasRepresentation ()
 The subclass should override this to indicate whether the resource exists. More...
 
 postInitSetup ()
 The handler can override this to do any necessary setup after init() is called to inject the dependencies. More...
 
 postValidationSetup ()
 The handler can override this to do any necessary setup after validate() has been called. More...
 
 urlEncodeTitle ( $title)
 URL-encode titles in a "pretty" way. More...
 

Private Member Functions

 getCachedCount ( $type, callable $fetchCount)
 
 getCount ( $type)
 
 getCurrentRevision ()
 
 getPage ()
 
 getRevisionOrThrow ( $revId)
 
 loggingTableTime ( $pageId)
 Return timestamp of latest entry in logging table for given page id. More...
 
 normalizeType ( $type)
 
 orderRevisions (RevisionRecord $fromRev=null, RevisionRecord $toRev=null)
 Reorders revisions if they are present. More...
 
 validateParameterCombination ( $type)
 Validates that the provided parameter combination is supported. More...
 

Private Attributes

ActorMigration $actorMigration
 
WANObjectCache $cache
 
NameTableStore $changeTagDefStore
 
GroupPermissionsLookup $groupPermissionsLookup
 
array $lastModifiedTimes
 
ILoadBalancer $loadBalancer
 
ExistingPageRecord false null $page = false
 
PageLookup $pageLookup
 
RevisionRecord false null $revision = false
 
RevisionStore $revisionStore
 
const COUNT_LIMITS
 The maximum number of counts to return per type of revision. More...
 
const DEPRECATED_COUNT_TYPES
 
const MAX_AGE_200 = 60
 

Additional Inherited Members

- Public Attributes inherited from MediaWiki\Rest\Handler
const PARAM_SOURCE = 'rest-param-source'
 (string) ParamValidator constant to specify the source of the parameter. More...
 

Detailed Description

Handler class for Core REST API endpoints that perform operations on revisions.

Definition at line 28 of file PageHistoryCountHandler.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Rest\Handler\PageHistoryCountHandler::__construct ( RevisionStore  $revisionStore,
NameTableStoreFactory  $nameTableStoreFactory,
GroupPermissionsLookup  $groupPermissionsLookup,
ILoadBalancer  $loadBalancer,
WANObjectCache  $cache,
PageLookup  $pageLookup,
ActorMigration  $actorMigration 
)

Member Function Documentation

◆ getAnonCount()

MediaWiki\Rest\Handler\PageHistoryCountHandler::getAnonCount (   $pageId,
RevisionRecord  $fromRev = null 
)
protected
Parameters
int$pageIdthe id of the page to load history for
RevisionRecord | null$fromRev
Returns
int the count

Definition at line 423 of file PageHistoryCountHandler.php.

References $dbr, $revQuery, DB_REPLICA, MediaWiki\Revision\RevisionRecord\DELETED_TEXT, and MediaWiki\Revision\RevisionRecord\DELETED_USER.

Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getCount().

◆ getBotCount()

MediaWiki\Rest\Handler\PageHistoryCountHandler::getBotCount (   $pageId,
RevisionRecord  $fromRev = null 
)
protected
Parameters
int$pageIdthe id of the page to load history for
RevisionRecord | null$fromRev
Returns
int the count

Definition at line 466 of file PageHistoryCountHandler.php.

References $dbr, $revQuery, DB_REPLICA, MediaWiki\Revision\RevisionRecord\DELETED_TEXT, and MediaWiki\Revision\RevisionRecord\DELETED_USER.

Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getCount().

◆ getCachedCount()

MediaWiki\Rest\Handler\PageHistoryCountHandler::getCachedCount (   $type,
callable  $fetchCount 
)
private

◆ getCount()

◆ getCurrentRevision()

MediaWiki\Rest\Handler\PageHistoryCountHandler::getCurrentRevision ( )
private

◆ getEditorsCount()

MediaWiki\Rest\Handler\PageHistoryCountHandler::getEditorsCount (   $pageId,
RevisionRecord  $fromRev = null,
RevisionRecord  $toRev = null 
)
protected
Parameters
int$pageIdthe id of the page to load history for
RevisionRecord | null$fromRev
RevisionRecord | null$toRev
Returns
int the count

Definition at line 520 of file PageHistoryCountHandler.php.

References MediaWiki\Rest\Handler\getAuthority(), and MediaWiki\Rest\Handler\PageHistoryCountHandler\orderRevisions().

Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getCount().

◆ getEditsCount()

MediaWiki\Rest\Handler\PageHistoryCountHandler::getEditsCount (   $pageId,
RevisionRecord  $fromRev = null,
RevisionRecord  $toRev = null 
)
protected
Parameters
int$pageIdthe id of the page to load history for
RevisionRecord | null$fromRev
RevisionRecord | null$toRev
Returns
int the count

Definition at line 616 of file PageHistoryCountHandler.php.

References MediaWiki\Rest\Handler\PageHistoryCountHandler\orderRevisions().

Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getCount().

◆ getEtag()

MediaWiki\Rest\Handler\PageHistoryCountHandler::getEtag ( )
protected

Choosing to not implement etags in this handler.

Generating an etag when getting revision counts must account for things like visibility settings (e.g. rev_deleted bit) which requires hitting the database anyway. The response for these requests are so small that we wouldn't be gaining much efficiency. Etags are strong validators and if provided would take precendence over last modified time, a weak validator. We want to ensure only last modified time is used since it is more efficient than using etags for this particular case.

Returns
null

Definition at line 365 of file PageHistoryCountHandler.php.

◆ getLastModified()

MediaWiki\Rest\Handler\PageHistoryCountHandler::getLastModified ( )
protected

Returns latest of 2 timestamps:

  1. Current revision
  2. OR entry from the DB logging table for the given page
    Returns
    int|null

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 310 of file PageHistoryCountHandler.php.

References MediaWiki\Rest\Handler\PageHistoryCountHandler\$lastModifiedTimes, and MediaWiki\Rest\Handler\PageHistoryCountHandler\getLastModifiedTimes().

Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getCachedCount().

◆ getLastModifiedTimes()

MediaWiki\Rest\Handler\PageHistoryCountHandler::getLastModifiedTimes ( )
protected

◆ getMinorCount()

MediaWiki\Rest\Handler\PageHistoryCountHandler::getMinorCount (   $pageId,
RevisionRecord  $fromRev = null 
)
protected
Parameters
int$pageIdthe id of the page to load history for
RevisionRecord | null$fromRev
Returns
int the count

Definition at line 589 of file PageHistoryCountHandler.php.

References $dbr, DB_REPLICA, and MediaWiki\Revision\RevisionRecord\DELETED_TEXT.

Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getCount().

◆ getPage()

◆ getParamSettings()

MediaWiki\Rest\Handler\PageHistoryCountHandler::getParamSettings ( )

Fetch ParamValidator settings for parameters.

Every setting must include self::PARAM_SOURCE to specify which part of the request is to contain the parameter.

Can be used for validating parameters inside an application/x-www-form-urlencoded or multipart/form-data POST body (i.e. parameters which would be present in PHP's $_POST array). For validating other kinds of request bodies, override getBodyValidator().

Stability: stable
to override
Returns
array[] Associative array mapping parameter names to ParamValidator settings arrays

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 670 of file PageHistoryCountHandler.php.

◆ getRevertedCount()

MediaWiki\Rest\Handler\PageHistoryCountHandler::getRevertedCount (   $pageId,
RevisionRecord  $fromRev = null 
)
protected
Parameters
int$pageIdthe id of the page to load history for
RevisionRecord | null$fromRev
Returns
int the count

Definition at line 534 of file PageHistoryCountHandler.php.

References $dbr, DB_REPLICA, MediaWiki\Revision\RevisionRecord\DELETED_TEXT, and ChangeTags\REVERT_TAGS.

Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getCount().

◆ getRevisionOrThrow()

MediaWiki\Rest\Handler\PageHistoryCountHandler::getRevisionOrThrow (   $revId)
private
Parameters
int$revId
Returns
RevisionRecord
Exceptions
LocalizedHttpException

Definition at line 635 of file PageHistoryCountHandler.php.

Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getCount().

◆ loggingTableTime()

MediaWiki\Rest\Handler\PageHistoryCountHandler::loggingTableTime (   $pageId)
private

Return timestamp of latest entry in logging table for given page id.

Parameters
int$pageId
Returns
int|null

Definition at line 345 of file PageHistoryCountHandler.php.

References $res, DB_REPLICA, and wfTimestamp().

Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getLastModifiedTimes().

◆ needsWriteAccess()

MediaWiki\Rest\Handler\PageHistoryCountHandler::needsWriteAccess ( )

Indicates whether this route requires write access.

The handler should override this if the route does not need to write to the database.

This should return true for routes that may require synchronous database writes. Modules that do not need such writes should also not rely on primary database access, since only read queries are needed and each primary DB is a single point of failure.

Stability: stable
to override
Returns
bool

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 666 of file PageHistoryCountHandler.php.

◆ normalizeType()

MediaWiki\Rest\Handler\PageHistoryCountHandler::normalizeType (   $type)
private

Definition at line 104 of file PageHistoryCountHandler.php.

References $type.

Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\run().

◆ orderRevisions()

MediaWiki\Rest\Handler\PageHistoryCountHandler::orderRevisions ( RevisionRecord  $fromRev = null,
RevisionRecord  $toRev = null 
)
private

Reorders revisions if they are present.

Parameters
RevisionRecord | null$fromRev
RevisionRecord | null$toRev
Returns
array

Definition at line 653 of file PageHistoryCountHandler.php.

Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\getEditorsCount(), and MediaWiki\Rest\Handler\PageHistoryCountHandler\getEditsCount().

◆ run()

◆ validateParameterCombination()

MediaWiki\Rest\Handler\PageHistoryCountHandler::validateParameterCombination (   $type)
private

Validates that the provided parameter combination is supported.

Parameters
string$type
Exceptions
LocalizedHttpException

Definition at line 114 of file PageHistoryCountHandler.php.

References $type, and MediaWiki\Rest\Handler\getValidatedParams().

Referenced by MediaWiki\Rest\Handler\PageHistoryCountHandler\run().

Member Data Documentation

◆ $actorMigration

ActorMigration MediaWiki\Rest\Handler\PageHistoryCountHandler::$actorMigration
private

◆ $cache

WANObjectCache MediaWiki\Rest\Handler\PageHistoryCountHandler::$cache
private

◆ $changeTagDefStore

NameTableStore MediaWiki\Rest\Handler\PageHistoryCountHandler::$changeTagDefStore
private

Definition at line 51 of file PageHistoryCountHandler.php.

◆ $groupPermissionsLookup

GroupPermissionsLookup MediaWiki\Rest\Handler\PageHistoryCountHandler::$groupPermissionsLookup
private

◆ $lastModifiedTimes

array MediaWiki\Rest\Handler\PageHistoryCountHandler::$lastModifiedTimes
private

◆ $loadBalancer

ILoadBalancer MediaWiki\Rest\Handler\PageHistoryCountHandler::$loadBalancer
private

◆ $page

◆ $pageLookup

PageLookup MediaWiki\Rest\Handler\PageHistoryCountHandler::$pageLookup
private

◆ $revision

RevisionRecord false null MediaWiki\Rest\Handler\PageHistoryCountHandler::$revision = false
private

◆ $revisionStore

RevisionStore MediaWiki\Rest\Handler\PageHistoryCountHandler::$revisionStore
private

◆ COUNT_LIMITS

const MediaWiki\Rest\Handler\PageHistoryCountHandler::COUNT_LIMITS
private
Initial value:
= [
'anonymous' => 10000,
'bot' => 10000,
'editors' => 25000,
'edits' => 30000,
'minor' => 1000,
'reverted' => 30000
]

The maximum number of counts to return per type of revision.

Definition at line 30 of file PageHistoryCountHandler.php.

◆ DEPRECATED_COUNT_TYPES

const MediaWiki\Rest\Handler\PageHistoryCountHandler::DEPRECATED_COUNT_TYPES
private
Initial value:
= [
'anonedits' => 'anonymous',
'botedits' => 'bot',
'revertededits' => 'reverted'
]

Definition at line 39 of file PageHistoryCountHandler.php.

◆ MAX_AGE_200

const MediaWiki\Rest\Handler\PageHistoryCountHandler::MAX_AGE_200 = 60
private

Definition at line 45 of file PageHistoryCountHandler.php.


The documentation for this class was generated from the following file: