mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/Echo
synced 2024-11-14 19:28:31 +00:00
83 lines
2.3 KiB
PHP
83 lines
2.3 KiB
PHP
<?php
|
|
|
|
use MediaWiki\Extension\EventLogging\EventLogging;
|
|
use MediaWiki\MediaWikiServices;
|
|
use MediaWiki\User\UserIdentity;
|
|
|
|
/**
|
|
* Static class for handling all kinds of event logging
|
|
*
|
|
* TODO: consider making this a service with dependencies injected
|
|
*/
|
|
class MWEchoEventLogging {
|
|
|
|
/** @var array */
|
|
private static $revisionIds = [
|
|
// Keep in sync with extension.json
|
|
'EchoMail' => '/analytics/legacy/echomail/1.0.0',
|
|
'EchoInteraction' => '/analytics/legacy/echointeraction/1.0.0'
|
|
];
|
|
|
|
/**
|
|
* This is the only function that interacts with EventLogging
|
|
*
|
|
* Adds common fields, and logs if logging is enabled for the given $schema.
|
|
*
|
|
* @param string $schema
|
|
* @param array $data
|
|
*/
|
|
protected static function logEvent( $schema, array $data ) {
|
|
global $wgEchoEventLoggingSchemas, $wgEchoEventLoggingVersion;
|
|
|
|
$schemaConfig = $wgEchoEventLoggingSchemas[$schema];
|
|
if ( !ExtensionRegistry::getInstance()->isLoaded( 'EventLogging' )
|
|
|| !$schemaConfig['enabled']
|
|
) {
|
|
// If logging for this schema is disabled, it's a no-op.
|
|
return;
|
|
}
|
|
|
|
$revision = self::$revisionIds[$schema];
|
|
$data['version'] = $wgEchoEventLoggingVersion;
|
|
|
|
EventLogging::logEvent( $schema, $revision, $data );
|
|
}
|
|
|
|
/**
|
|
* Function for logging the event for Schema:EchoEmail
|
|
* @param UserIdentity $userIdentity
|
|
* @param string $emailDeliveryMode 'single' (default), 'daily_digest', or 'weekly_digest'
|
|
*/
|
|
public static function logSchemaEchoMail( UserIdentity $userIdentity, $emailDeliveryMode = 'single' ) {
|
|
$data = [
|
|
'recipientUserId' => $userIdentity->getId(),
|
|
'emailDeliveryMode' => $emailDeliveryMode
|
|
];
|
|
|
|
self::logEvent( 'EchoMail', $data );
|
|
}
|
|
|
|
/**
|
|
* @param UserIdentity $userIdentity
|
|
* @param string $skinName
|
|
*/
|
|
public static function logSpecialPageVisit( UserIdentity $userIdentity, $skinName ) {
|
|
$userEditCount = (int)MediaWikiServices::getInstance()
|
|
->getUserEditTracker()
|
|
->getUserEditCount( $userIdentity );
|
|
self::logEvent(
|
|
'EchoInteraction',
|
|
[
|
|
'context' => 'archive',
|
|
'action' => 'special-page-visit',
|
|
'userId' => $userIdentity->getId(),
|
|
'editCount' => $userEditCount,
|
|
'notifWiki' => WikiMap::getCurrentWikiId(),
|
|
// Hack: Figure out if we are in the mobile skin
|
|
'mobile' => $skinName === 'minerva',
|
|
]
|
|
);
|
|
}
|
|
|
|
}
|