Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
| Total | |
0.00% |
0 / 1 |
|
0.00% |
0 / 10 |
CRAP | |
0.00% |
0 / 77 |
| Hooks | |
0.00% |
0 / 1 |
|
0.00% |
0 / 10 |
420 | |
0.00% |
0 / 77 |
| onInfoAction | |
0.00% |
0 / 1 |
20 | |
0.00% |
0 / 32 |
|||
| onApiQueryModuleManager | |
0.00% |
0 / 1 |
20 | |
0.00% |
0 / 8 |
|||
| onAPIQuerySiteInfoGeneralInfo | |
0.00% |
0 / 1 |
12 | |
0.00% |
0 / 8 |
|||
| getApiMetricsMap | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 1 |
|||
| getApiScopeMap | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 1 |
|||
| getApiMetricsHelp | |
0.00% |
0 / 1 |
6 | |
0.00% |
0 / 13 |
|||
| getApiDaysHelp | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 7 |
|||
| makeWarningsOnlyStatus | |
0.00% |
0 / 1 |
6 | |
0.00% |
0 / 5 |
|||
| toYmd | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 1 |
|||
| toYmdHis | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 1 |
|||
| <?php | |
| namespace MediaWiki\Extension\PageViewInfo; | |
| use ApiBase; | |
| use ApiModuleManager; | |
| use ApiQuerySiteinfo; | |
| use FormatJson; | |
| use Html; | |
| use IContextSource; | |
| use MediaWiki\MediaWikiServices; | |
| use StatusValue; | |
| use Wikimedia\ParamValidator\ParamValidator; | |
| use Wikimedia\ParamValidator\TypeDef\IntegerDef; | |
| class Hooks { | |
| /** | |
| * Display total pageviews in the last 30 days and show a graph with details when clicked. | |
| * @param IContextSource $ctx | |
| * @param array &$pageInfo | |
| */ | |
| public static function onInfoAction( IContextSource $ctx, array &$pageInfo ) { | |
| /** @var PageViewService $pageViewService */ | |
| $pageViewService = MediaWikiServices::getInstance()->getService( 'PageViewService' ); | |
| if ( !$pageViewService->supports( PageViewService::METRIC_VIEW, | |
| PageViewService::SCOPE_ARTICLE ) | |
| ) { | |
| return; | |
| } | |
| $title = $ctx->getTitle(); | |
| $status = $pageViewService->getPageData( [ $title ], 30, PageViewService::METRIC_VIEW ); | |
| $data = $status->getValue(); | |
| if ( !$status->isOK() ) { | |
| return; | |
| } | |
| $views = $data[$title->getPrefixedDBkey()]; | |
| $total = array_sum( $views ); | |
| reset( $views ); | |
| $start = self::toYmdHis( key( $views ) ); | |
| end( $views ); | |
| $end = self::toYmdHis( key( $views ) ); | |
| $lang = $ctx->getLanguage(); | |
| $formatted = $lang->formatNum( $total ); | |
| $pageInfo['header-basic'][] = [ | |
| $ctx->msg( 'pvi-month-count' ), | |
| Html::element( 'div', [ 'class' => 'mw-pvi-month' ], $formatted ) | |
| ]; | |
| $info = FormatJson::decode( | |
| file_get_contents( __DIR__ . '/../graphs/month.json' ), | |
| true | |
| ); | |
| foreach ( $views as $day => $count ) { | |
| $info['data'][0]['values'][] = [ 'timestamp' => self::toYmd( $day ), 'views' => $count ]; | |
| } | |
| $ctx->getOutput()->addModules( 'ext.pageviewinfo' ); | |
| // Ymd -> YmdHis | |
| $user = $ctx->getUser(); | |
| $ctx->getOutput()->addJsConfigVars( [ | |
| 'wgPageViewInfo' => [ | |
| 'graph' => $info, | |
| 'start' => $lang->userDate( $start, $user ), | |
| 'end' => $lang->userDate( $end, $user ), | |
| ], | |
| ] ); | |
| } | |
| /** | |
| * Limit enabled PageViewInfo API modules to those which are supported by the service. | |
| * @param ApiModuleManager $moduleManager | |
| */ | |
| public static function onApiQueryModuleManager( ApiModuleManager $moduleManager ) { | |
| $moduleMap = [ | |
| 'pageviews' => [ 'pageviews', 'prop', ApiQueryPageViews::class ], | |
| 'siteviews' => [ 'siteviews', 'meta', ApiQuerySiteViews::class ], | |
| 'mostviewed' => [ 'mostviewed', 'list', ApiQueryMostViewed::class ], | |
| ]; | |
| /** @var PageViewService $service */ | |
| $service = MediaWikiServices::getInstance()->getService( 'PageViewService' ); | |
| foreach ( self::getApiScopeMap() as $apiModuleName => $serviceScopeConstant ) { | |
| foreach ( self::getApiMetricsMap() as $serviceMetricConstant ) { | |
| if ( $service->supports( $serviceMetricConstant, $serviceScopeConstant ) ) { | |
| call_user_func_array( [ $moduleManager, 'addModule' ], $moduleMap[$apiModuleName] ); | |
| continue 2; | |
| } | |
| } | |
| } | |
| } | |
| /** | |
| * Add information to the siteinfo API output about which metrics are supported. | |
| * @param ApiQuerySiteinfo $module | |
| * @param array &$result | |
| */ | |
| public static function onAPIQuerySiteInfoGeneralInfo( ApiQuerySiteinfo $module, array &$result ) { | |
| /** @var PageViewService $service */ | |
| $service = MediaWikiServices::getInstance()->getService( 'PageViewService' ); | |
| $supportedMetrics = []; | |
| foreach ( self::getApiScopeMap() as $apiModuleName => $serviceScopeConstant ) { | |
| foreach ( self::getApiMetricsMap() as $apiMetricsName => $serviceMetricConstant ) { | |
| $supportedMetrics[$apiModuleName][$apiMetricsName] = | |
| $service->supports( $serviceMetricConstant, $serviceScopeConstant ); | |
| } | |
| } | |
| $result['pageviewservice-supported-metrics'] = $supportedMetrics; | |
| } | |
| /** | |
| * Maps allowed values of the 'metric' parameter of the pageview-related APIs to service constants. | |
| * @return array | |
| */ | |
| public static function getApiMetricsMap() { | |
| return [ | |
| 'pageviews' => PageViewService::METRIC_VIEW, | |
| 'uniques' => PageViewService::METRIC_UNIQUE, | |
| ]; | |
| } | |
| /** | |
| * Maps API module names to service constants. | |
| * @return array | |
| */ | |
| public static function getApiScopeMap() { | |
| return [ | |
| 'pageviews' => PageViewService::SCOPE_ARTICLE, | |
| 'siteviews' => PageViewService::SCOPE_SITE, | |
| 'mostviewed' => PageViewService::SCOPE_TOP, | |
| ]; | |
| } | |
| /** | |
| * Returns an array suitable for merging into getAllowedParams() | |
| * @param string $scope One of the PageViewService::SCOPE_* constants | |
| * @return array | |
| */ | |
| public static function getApiMetricsHelp( $scope ) { | |
| /** @var PageViewService $service */ | |
| $service = MediaWikiServices::getInstance()->getService( 'PageViewService' ); | |
| $metrics = array_keys( array_filter( self::getApiMetricsMap(), | |
| static function ( $metric ) use ( $scope, $service ) { | |
| return $service->supports( $metric, $scope ); | |
| } ) ); | |
| $reverseMap = array_flip( self::getApiMetricsMap() ); | |
| $default = $reverseMap[PageViewService::METRIC_VIEW] ?? reset( $reverseMap ); | |
| return $default ? [ | |
| 'metric' => [ | |
| ParamValidator::PARAM_TYPE => $metrics, | |
| ParamValidator::PARAM_DEFAULT => $default, | |
| ApiBase::PARAM_HELP_MSG => 'apihelp-pageviewinfo-param-metric', | |
| ApiBase::PARAM_HELP_MSG_PER_VALUE => array_map( static function ( $metric ) { | |
| return 'apihelp-pageviewinfo-paramvalue-metric-' . $metric; | |
| }, array_combine( $metrics, $metrics ) ), | |
| ], | |
| ] : []; | |
| } | |
| /** | |
| * Returns an array suitable for merging into getAllowedParams() | |
| * @return array | |
| */ | |
| public static function getApiDaysHelp() { | |
| $days = MediaWikiServices::getInstance()->getConfigFactory()->makeConfig( 'PageViewInfo' ) | |
| ->get( 'PageViewApiMaxDays' ); | |
| return [ | |
| 'days' => [ | |
| ParamValidator::PARAM_TYPE => 'integer', | |
| ParamValidator::PARAM_DEFAULT => $days, | |
| IntegerDef::PARAM_MAX => $days, | |
| IntegerDef::PARAM_MIN => 1, | |
| ApiBase::PARAM_HELP_MSG => 'apihelp-pageviewinfo-param-days', | |
| ], | |
| ]; | |
| } | |
| /** | |
| * Transform into a status with errors replaced with warnings | |
| * @param StatusValue $status | |
| * @return StatusValue | |
| */ | |
| public static function makeWarningsOnlyStatus( StatusValue $status ) { | |
| list( $errors, $warnings ) = $status->splitByErrorType(); | |
| foreach ( $errors->getErrors() as $error ) { | |
| call_user_func_array( [ $warnings, 'warning' ], | |
| array_merge( [ $error['message'] ], $error['params'] ) ); | |
| } | |
| return $warnings; | |
| } | |
| /** | |
| * Convert YYYY-MM-DD to YYYYMMDD | |
| * @param string $date | |
| * @return string | |
| */ | |
| protected static function toYmd( $date ) { | |
| return substr( $date, 0, 4 ) . substr( $date, 5, 2 ) . substr( $date, 8, 2 ); | |
| } | |
| /** | |
| * Convert YYYY-MM-DD to TS_MW | |
| * @param string $date | |
| * @return string | |
| */ | |
| protected static function toYmdHis( $date ) { | |
| return substr( $date, 0, 4 ) . substr( $date, 5, 2 ) . substr( $date, 8, 2 ) . '000000'; | |
| } | |
| } |