-
Notifications
You must be signed in to change notification settings - Fork 1
/
WikimediaEventsHooks.php
657 lines (591 loc) · 19.9 KB
/
WikimediaEventsHooks.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
<?php
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\MediaWikiServices;
/**
* Hooks used for Wikimedia-related logging
*
* @author Ori Livneh <ori@wikimedia.org>
* @author Matthew Flaschen <mflaschen@wikimedia.org>
* @author Benny Situ <bsitu@wikimedia.org>
*/
class WikimediaEventsHooks {
/**
* @param OutputPage &$out
* @param Skin &$skin
*/
public static function onBeforePageDisplay( &$out, &$skin ) {
$out->addModules( 'ext.wikimediaEvents' );
if ( $out->getUser()->isLoggedIn() ) {
$out->addModules( 'ext.wikimediaEvents.loggedin' );
}
}
/**
* On XAnalyticsHeader
*
* When adding new headers here please update the docs:
* https://wikitech.wikimedia.org/wiki/X-Analytics
*
* Insert a 'page_id' key with the page ID as value (if the request is for a page with a pageid)
* Insert a 'ns' key with the namespace ID as value (if the request is for a valid title)
* Insert a 'special' key with the resolved name of the special page (if the request is for a
* special page)
*
* Add a 'loggedIn' key with the value of 1 if the user is logged in
*/
public static function onXAnalyticsHeader( OutputPage $out, array &$headerItems ) {
$title = $out->getTitle();
if ( $title !== null ) {
$pageId = $title->getArticleID();
$headerItems['ns'] = $title->getNamespace();
if ( is_int( $pageId ) && $pageId > 0 ) {
$headerItems['page_id'] = $pageId;
}
if ( $title->isSpecialPage() ) {
list( $name, /* $subpage */ ) = SpecialPageFactory::resolveAlias( $title->getDBkey() );
if ( $name !== null ) {
$headerItems['special'] = $name;
}
}
}
if ( $out->getUser()->isLoggedIn() ) {
$headerItems['loggedIn'] = 1;
}
}
/**
* Log server-side event on successful page edit.
*
* Imported from EventLogging extension
*
* @param WikiPage $article
* @param User $user
* @param Content $content
* @param string $summary
* @param bool $isMinor
* @param bool $isWatch
* @param string $section
* @param int $flags
* @see https://www.mediawiki.org/wiki/Manual:Hooks/PageContentSaveComplete
* @see https://meta.wikimedia.org/wiki/Schema:PageContentSaveComplete
*/
public static function onPageContentSaveComplete(
$article, $user, $content, $summary,
$isMinor, $isWatch, $section, $flags, $revision, $status, $baseRevId
) {
if ( !$revision ) {
return;
}
$stats = MediaWikiServices::getInstance()->getStatsdDataFactory();
if ( PHP_SAPI !== 'cli' ) {
$size = $content->getSize();
DeferredUpdates::addCallableUpdate( function () use ( $stats, $size ) {
$timing = RequestContext::getMain()->getTiming();
$measure = $timing->measure( 'editResponseTime', 'requestStart', 'requestShutdown' );
if ( $measure !== false ) {
$stats->timing( 'timing.editResponseTime', $measure['duration'] * 1000 );
}
$stats->gauge( 'edit.newContentSize', $size );
} );
}
$isAPI = defined( 'MW_API' );
$isMobile = class_exists( 'MobileContext' )
&& MobileContext::singleton()->shouldDisplayMobileView();
$revId = $revision->getId();
$title = $article->getTitle();
$event = [
'revisionId' => $revId,
'isAPI' => $isAPI,
'isMobile' => $isMobile,
];
if ( isset( $_SERVER[ 'HTTP_USER_AGENT' ] ) ) {
$event[ 'userAgent' ] = $_SERVER[ 'HTTP_USER_AGENT' ];
}
EventLogging::logEvent( 'PageContentSaveComplete', 5588433, $event );
if ( $user->isAnon() ) {
return;
}
// Get the user's age, measured in seconds since registration.
$age = time() - wfTimestampOrNull( TS_UNIX, $user->getRegistration() );
$editCount = $user->getEditCount();
// Check if this edit brings the user's total edit count to a value
// that is a factor of ten. We consider these 'milestones'. The rate
// at which editors are hitting such milestones and the time it takes
// are important indicators of community health.
if ( $editCount === 0 || preg_match( '/^9+$/', "$editCount" ) ) {
$milestone = $editCount + 1;
$stats->increment( "editor.milestones.{$milestone}" );
$stats->timing( "editor.milestones.timing.{$milestone}", $age );
}
// If the editor signed up in the last thirty days, and if this is an
// NS_MAIN edit, log a NewEditorEdit event.
if ( $age <= 2592000 && $title->inNamespace( NS_MAIN ) ) {
EventLogging::logEvent( 'NewEditorEdit', 6792669, [
'userId' => $user->getId(),
'userAge' => $age,
'editCount' => $editCount,
'pageId' => $article->getId(),
'revId' => $revId,
'isAPI' => $isAPI,
'isMobile' => $isMobile,
] );
}
}
/**
* Log and update statistics whenever an editor reaches the active editor
* threshold for this month.
*
* @see https://meta.wikimedia.org/wiki/Schema:EditorActivation
* @see https://www.mediawiki.org/wiki/Analytics/Metric_definitions#Active_editor
*
* @param Revision &$revision
* @param string $data
* @param array $flags
*/
public static function onRevisionInsertComplete( &$revision, $data, $flags ) {
$user = User::newFromId( $revision->getUser( Revision::RAW ) );
// Anonymous users and bots don't count (sorry!)
if ( $user->isAnon() || $user->isAllowed( 'bot' ) ) {
return;
}
// Only mainspace edits qualify
if ( !$revision->getTitle()->inNamespace( NS_MAIN ) ) {
return;
}
// Check if this is the user's fifth mainspace edit this month.
// If it is, then this editor has just made the cut as an active
// editor for this wiki for this month.
DeferredUpdates::addCallableUpdate( function () use ( $user ) {
$db = wfGetDB( DB_MASTER );
$since = date( 'Ym' ) . '00000000';
$numMainspaceEditsThisMonth = $db->selectRowCount(
[ 'revision', 'page' ],
'1',
[
'rev_user' => $user->getId(),
'rev_timestamp >= ' . $db->addQuotes( $db->timestamp( $since ) ),
'page_namespace' => NS_MAIN,
],
__FILE__ . ':' . __LINE__,
[ 'LIMIT' => 6 ],
[ 'page' => [ 'INNER JOIN', 'rev_page = page_id' ] ]
);
if ( $numMainspaceEditsThisMonth === 5 ) {
$month = date( 'm-Y' );
MediaWikiServices::getInstance()
->getStatsdDataFactory()->increment( 'editor.activation.' . $month );
EventLogging::logEvent( 'EditorActivation', 14208837, [
'userId' => $user->getId(),
'month' => $month,
] );
}
} );
}
/**
* Handler for UserSaveOptions hook.
* @see http://www.mediawiki.org/wiki/Manual:Hooks/UserSaveOptions
* @param User $user user whose options are being saved
* @param array $options Options being saved
* @return bool true in all cases
*/
// Modified version of original method from the Echo extension
public static function onUserSaveOptions( $user, &$options ) {
global $wgOut;
// Capture user options saved via Special:Preferences or ApiOptions
// TODO (mattflaschen, 2013-06-13): Ideally this would be done more cleanly without
// looking explicitly at page names and URL parameters.
// Maybe a userInitiated flag passed to saveSettings would work.
if ( ( $wgOut && $wgOut->getTitle() && $wgOut->getTitle()->isSpecial( 'Preferences' ) )
|| ( defined( 'MW_API' ) && $wgOut->getRequest()->getVal( 'action' ) === 'options' )
) {
// $clone is the current user object before the new option values are set
$clone = User::newFromId( $user->getId() );
$commonData = [
'version' => '1',
'userId' => $user->getId(),
'saveTimestamp' => wfTimestampNow(),
];
foreach ( $options as $optName => $optValue ) {
// loose comparision is required since some of the values
// are not consistent in the two variables, eg, '' vs false
if ( $clone->getOption( $optName ) != $optValue ) {
$event = [
'property' => $optName,
// Encode value as JSON.
// This is parseable and allows a consistent type for validation.
'value' => FormatJson::encode( $optValue ),
'isDefault' => User::getDefaultOption( $optName ) == $optValue,
] + $commonData;
EventLogging::logEvent( 'PrefUpdate', 5563398, $event );
}
}
}
return true;
}
/**
* Logs article deletions using the PageDeletion schema.
*
* @see https://www.mediawiki.org/wiki/Manual:Hooks/ArticleDeleteComplete
* @see https://meta.wikimedia.org/wiki/Schema:PageDeletion
* @param WikiPage $article The article that was deleted
* @param User $user The user that deleted the article
* @param string $reason The reason that the article was deleted
* @param integer $id The ID of the article that was deleted
*/
public static function onArticleDeleteComplete( WikiPage $article, User $user, $reason, $id ) {
$title = $article->getTitle();
EventLogging::logEvent( 'PageDeletion', 7481655, [
'userId' => $user->getId(),
'userText' => $user->getName(),
'pageId' => $id,
'namespace' => $title->getNamespace(),
'title' => $title->getDBkey(),
'comment' => $reason,
] );
return true;
}
/**
* Logs article undelete using pageRestored schema
*
* @see http://www.mediawiki.org/wiki/Manual:Hooks/ArticleUndelete
* @see https://meta.wikimedia.org/wiki/Schema:PageRestoration
* @param Title $title Title of article restored
* @param boolean $created whether the revision created the page (default false)
* @param string $comment Reason for undeleting the page
* @param integer $oldPageId The ID of the article that was deleted
*/
public static function onArticleUndelete( $title, $created, $comment, $oldPageId ) {
global $wgUser;
EventLogging::logEvent( 'PageRestoration', 7758372, [
'userId' => $wgUser->getId(),
'userText' => $wgUser->getName(),
'oldPageId' => $oldPageId,
'newPageId' => $title->getArticleID(),
'namespace' => $title->getNamespace(),
'title' => $title->getDBkey(),
'comment' => $comment,
] );
}
/**
* Logs a page creation event, based on the given parameters.
*
* Currently, this is either a normal page creation, or an automatic creation
* of a redirect when a page is moved.
*
* @see https://meta.wikimedia.org/wiki/Schema:PageCreation
*
* @param User $user user creating the page
* @param int $pageId page ID of new page
* @param Title $title title of created page
* @param int $revId revision ID of first revision of created page
*/
protected static function logPageCreation( User $user, $pageId, Title $title,
$revId ) {
EventLogging::logEvent( 'PageCreation', 7481635, [
'userId' => $user->getId(),
'userText' => $user->getName(),
'pageId' => $pageId,
'namespace' => $title->getNamespace(),
'title' => $title->getDBkey(),
'revId' => $revId,
] );
}
/**
* Logs title moves with the PageMove schema.
*
* @see https://www.mediawiki.org/wiki/Manual:Hooks/TitleMoveComplete
* @see https://meta.wikimedia.org/wiki/Schema:PageMove
* @param Title $oldTitle The title of the old article (moved from)
* @param Title $newTitle The title of the new article (moved to)
* @param User $user The user who moved the article
* @param integer $pageId The page ID of the old article
* @param integer $redirectId The page ID of the redirect, 0 if a redirect wasn't
* created
* @param string $reason The reason that the title was moved
* @return bool true in all cases
*/
public static function onTitleMoveComplete( Title $oldTitle, Title $newTitle, User $user,
$pageId, $redirectId, $reason
) {
EventLogging::logEvent( 'PageMove', 7495717, [
'userId' => $user->getId(),
'userText' => $user->getName(),
'pageId' => $pageId,
'oldNamespace' => $oldTitle->getNamespace(),
'oldTitle' => $oldTitle->getDBkey(),
'newNamespace' => $newTitle->getNamespace(),
'newTitle' => $newTitle->getDBkey(),
'redirectId' => $redirectId,
'comment' => $reason,
] );
if ( $redirectId !== 0 ) {
// The redirect was not suppressed, so log its creation.
self::logPageCreation( $user, $redirectId, $oldTitle, $oldTitle->getLatestRevID() );
}
return true;
}
/**
* Logs page creations with the PageCreation schema.
*
* @see https://www.mediawiki.org/wiki/Manual:Hooks/PageContentInsertComplete
* @see https://meta.wikimedia.org/wiki/Schema:PageCreation
* @param WikiPage $wikipage page just created
* @param User $user user who created the page
* @param Content $content content of new page
* @param string $summary summary given by creating user
* @param bool $isMinor whether the edit is marked as minor (not actually possible for new
* pages)
* @param $isWatch not used
* @param $section not used
* @param int $flags bit flags about page creation
* @param Revision $revision first revision of new page
*/
public static function onPageContentInsertComplete( WikiPage $wikiPage, User $user,
Content $content, $summary, $isMinor, $isWatch, $section, $flags, Revision $revision ) {
$title = $wikiPage->getTitle();
self::logPageCreation( $user, $wikiPage->getId(), $title, $revision->getId() );
return true;
}
/**
* Logs edit conflicts with the EditConflict schema.
*
* @see https://www.mediawiki.org/wiki/Manual:Hooks/EditPageBeforeConflictDiff
* @see https://meta.wikimedia.org/wiki/Schema:EditConflict
* @param EditPage &$editor
* @param OutputPage &$out
* @return bool true in all cases
*/
public static function onEditPageBeforeConflictDiff( &$editor, &$out ) {
$user = $out->getUser();
$title = $out->getTitle();
EventLogging::logEvent( 'EditConflict', 8860941, [
'userId' => $user->getId(),
'userText' => $user->getName(),
'pageId' => $title->getArticleID(),
'namespace' => $title->getNamespace(),
'title' => $title->getDBkey(),
'revId' => (int)$title->getLatestRevID(),
] );
return true;
}
public static function onResourceLoaderGetConfigVars( &$vars ) {
global $wgWMEStatsdBaseUri, $wgWMEReadingDepthSamplingRate, $wgWMEReadingDepthEnabled;
$vars['wgWMEStatsdBaseUri'] = $wgWMEStatsdBaseUri;
$vars['wgWMEReadingDepthSamplingRate'] = $wgWMEReadingDepthSamplingRate;
$vars['wgWMEReadingDepthEnabled'] = $wgWMEReadingDepthEnabled;
}
/**
* Register change tags.
*
* @param array &$tags
* @return bool
*/
public static function onListDefinedTags( &$tags ) {
$tags[] = 'HHVM';
if ( wfWikiID() === 'commonswiki' ) {
$tags[] = 'cross-wiki-upload';
// For A/B test
$tags[] = 'cross-wiki-upload-1';
$tags[] = 'cross-wiki-upload-2';
$tags[] = 'cross-wiki-upload-3';
$tags[] = 'cross-wiki-upload-4';
}
return true;
}
/**
* Mark active change tags.
*
* @param array &$tags
* @return bool
*/
public static function onChangeTagsListActive( &$tags ) {
if ( wfWikiID() === 'commonswiki' ) {
$tags[] = 'cross-wiki-upload';
// For A/B test
$tags[] = 'cross-wiki-upload-1';
$tags[] = 'cross-wiki-upload-2';
$tags[] = 'cross-wiki-upload-3';
$tags[] = 'cross-wiki-upload-4';
}
return true;
}
public static function onSpecialSearchGoResult( $term, Title $title, &$url ) {
$request = RequestContext::getMain()->getRequest();
$wprov = $request->getVal( 'wprov' );
if ( $wprov ) {
$url = $title->getFullURL( [ 'wprov' => $wprov ] );
}
return true;
}
/**
* The javascript that records search metrics needs to know if it is on a
* SERP or not. This ends up being non-trivial due to localization, so
* make it trivial by injecting a boolean value to check.
*/
public static function onSpecialSearchResults( $term, $titleMatches, $textMatches ) {
global $wgOut;
$wgOut->addJsConfigVars( [
'wgIsSearchResultPage' => true,
] );
return true;
}
/**
* Add a change tag 'cross-wiki-upload' to cross-wiki uploads to Commons, to track usage of the
* new feature. (Both to track adoption, and to let Commons editors review the uploads.) (T115328)
*
* @param $recentChange RecentChange
* @return bool
*/
public static function onRecentChangeSave( RecentChange $recentChange ) {
if ( !defined( 'MW_API' ) ) {
return true;
}
if ( wfWikiID() !== 'commonswiki' ) {
return true;
}
if ( !(
$recentChange->getAttribute( 'rc_log_type' ) === 'upload' &&
$recentChange->getAttribute( 'rc_log_action' ) === 'upload'
) ) {
return true;
}
$request = RequestContext::getMain()->getRequest();
if ( !$request->response()->getHeader( 'Access-Control-Allow-Origin' ) ) {
return true;
}
// A/B test
$bucket = $request->getVal( 'bucket' );
if ( !in_array( $bucket, [ '1', '2', '3', '4' ] ) ) {
$bucket = null;
}
$tags = [ 'cross-wiki-upload' ];
if ( $bucket ) {
$tags[] = "cross-wiki-upload-$bucket";
}
$recentChange->addTags( $tags );
return true;
}
public static function onArticleViewHeader() {
DeferredUpdates::addCallableUpdate( function () {
$context = RequestContext::getMain();
$timing = $context->getTiming();
if ( class_exists( 'MobileContext' )
&& MobileContext::singleton()->shouldDisplayMobileView()
) {
$platform = 'mobile';
} else {
$platform = 'desktop';
}
$measure = $timing->measure( 'viewResponseTime', 'requestStart', 'requestShutdown' );
if ( $measure !== false ) {
MediaWikiServices::getInstance()->getStatsdDataFactory()->timing(
"timing.viewResponseTime.{$platform}", $measure['duration'] * 1000 );
}
} );
}
/**
* AbuseFilter-GenerateUserVars hook handler
*
* @param AbuseFilterVariableHolder $vars
* @param User $user object
*/
public static function onAbuseFilterGenerateUserVars( $vars, $user ) {
global $wgRequest;
$vars->setVar(
'user_wpzero',
$wgRequest->getHeader( 'X-Carrier' ) !== false
);
}
/**
* AbuseFilter-builder hook handler
*
* @param array $builder
* @return bool
*/
public static function onAbuseFilterBuilder( &$builder ) {
$builder['vars']['user_wpzero'] = 'user-wpzero';
}
/**
* Called after building form options on pages inheriting from
* ChangesListSpecialPage (in core: RecentChanges, RecentChangesLinked
* and Watchlist).
*
* @param ChangesListSpecialPage $special Special page
*/
public static function onChangesListSpecialPageStructuredFilters( $special ) {
// For volume/capacity reasons, only log this for logged-in users
if ( $special->getUser()->isAnon() ) {
return;
}
$logData = [
'pagename' => $special->getName(),
'enhancedFiltersEnabled' => (bool)$special->getUser()->getOption( 'rcenhancedfilters' ),
'userId' => $special->getUser()->getId(),
];
$knownFilters = [
'hideminor' => 'bool',
'hidemajor' => 'bool',
'hidebots' => 'bool',
'hidehumans' => 'bool',
'hideanons' => 'bool',
'hidepatrolled' => 'bool',
'hideunpatrolled' => 'bool',
'hidemyself' => 'bool',
'hidebyothers' => 'bool',
'hideliu' => 'bool',
'hidecategorization' => 'bool',
'hidepageedits' => 'bool',
'hidenewpages' => 'bool',
'hidelog' => 'bool',
'invert' => 'bool',
'associated' => 'bool',
'namespace' => 'integer',
'tagfilter' => 'string',
'userExpLevel' => 'string',
// Extension:Wikidata
'hideWikibase' => 'bool',
// Extension:FlaggedRevs
'hideReviewed' => 'bool',
// Extension:ORES
'hidenondamaging' => 'bool',
'damaging' => 'string',
'goodfaith' => 'string',
];
$webParams = $special->getRequest()->getQueryValues();
foreach ( $webParams as $param => $value ) {
if ( array_key_exists( $param, $knownFilters ) && $value !== '' && $value !== null ) {
if ( $knownFilters[ $param ] === 'bool' ) {
$logData[ $param ] = (bool)$value;
} elseif ( $knownFilters[ $param ] === 'integer' ) {
$logData[ $param ] = (int)$value;
} else {
$logData[ $param ] = (string)$value;
}
}
}
// Log the existing filters
EventLogging::logEvent(
'ChangesListFilters',
16837986,
$logData
);
}
/**
* Called when User::getBlockedStatus() has been set
*
* @param $user User object
*/
public static function onGetBlockedStatus( $user ) {
$blocked = $user->mBlock instanceof Block;
$rc = RequestContext::getMain();
$request = $rc->getRequest();
$isCookieSetOnAutoblock = $rc->getConfig()->get( 'CookieSetOnAutoblock' );
$blockCookieVal = $request->getCookie( 'BlockID' );
$trigger = $user->blockTrigger;
if ( $isCookieSetOnAutoblock && $blockCookieVal > 0 && $blocked ) {
$logData = [
'ip' => $request->getIP(),
'is_cookie_block' => $trigger === 'cookie-block'
];
EventLogging::logEvent( 'CookieBlock', 16241436, $logData );
}
}
}