-
Notifications
You must be signed in to change notification settings - Fork 1
/
UserJourney.php
332 lines (258 loc) · 10.1 KB
/
UserJourney.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
<?php
/**
* This extension tracks each user's journey as a wiki contributor
*
* Documentation: https://github.com/darenwelsh/UserJourney
* Support: https://github.com/darenwelsh/UserJourney
* Source code: https://github.com/darenwelsh/UserJourney
*
* @file UserJourney.php
* @addtogroup Extensions
* @author Daren Welsh
* @copyright © 2014 by Daren Welsh
* @licence GNU GPL v3+
*/
# Not a valid entry point, skip unless MEDIAWIKI is defined
if (!defined('MEDIAWIKI')) {
die( "UserJourney extension" );
}
// if wfLoadExtension exists (MW 1.25+) use that method of registering extensions
if ( function_exists( 'wfLoadExtension' ) ) {
wfLoadExtension( 'UserJourney' );
// Keep i18n globals so mergeMessageFileList.php doesn't break
$wgMessagesDirs['UserJourney'] = __DIR__ . '/i18n';
$wgExtensionMessagesFiles['UserJourneyMagic'] = __DIR__ . '/Magic.php';
wfWarn(
'Deprecated PHP entry point used for UserJourney extension. ' .
'Please use wfLoadExtension instead, ' .
'see https://www.mediawiki.org/wiki/Extension_registration for more details.'
);
return;
// For MW 1.24 and lower, use normal extension registration
// This should be removed when this extension drops support for <1.25
} else {
$wgExtensionCredits['specialpage'][] = array(
'path' => __FILE__,
'name' => 'UserJourney',
'author'=> array(
'[https://www.mediawiki.org/wiki/User:Darenwelsh Daren Welsh]'
),
'descriptionmsg' => 'userjourney-desc',
'version' => 0.1,
'url' => 'https://www.mediawiki.org/wiki/Extension:UserJourney',
);
}
/*
* Configure global variables
*/
// Number of revisions (in string form used within MySQL queries)
// $wgUJnumRevisionsAlias = "rev_count"; // Alias used for MySQL queries
// Number of pages revised (in string form used within MySQL queries)
// $wgUJnumPagesRevisedAlias = "page_count"; // Alias used for MySQL queries
// How the score is calculated (in string form used within MySQL queries)
// function getScoreDefinition( $scope = "explicit" ){
// global $wgUJnumRevisionsAlias, $wgUJnumPagesRevisedAlias;
// if( $scope === "explicit" ){
// $rev_count = "COUNT(rev_id)";
// $page_count = "COUNT(DISTINCT rev_page)";
// } else {
// $rev_count = $wgUJnumRevisionsAlias;
// $page_count = $wgUJnumPagesRevisedAlias;
// }
// $output = "{$page_count} + SQRT( {$rev_count} - {$page_count} ) * 2";
// return $output;
// }
// $wgUJscoreDefinition = getScoreDefinition( "explicit" );
// $wgUJscoreDefinitionUsingAliases = getScoreDefinition( "relative" );
// Max score counted toward plots with moving averages
// $wgUJscoreCeiling = 100;
// Number of days in which to compare scores of logged-in user against others
// (used to find suitable competitors)
// $wgUJdaysToDetermineCompetitors = 14;
// Number of days to plot for competitions
// $wgUJdaysToPlotCompetition = 30;
/*
STUFF FROM CONTRIBUTION SCORES
*/
/*
define( 'CONTRIBUTIONSCORES_MAXINCLUDELIMIT', 50 );
$wgContribScoreReports = null;
// These settings can be overridden in LocalSettings.php.
// Set to true to exclude bots from the reporting.
$wgContribScoreIgnoreBlockedUsers = false;
// Set to true to exclude blocked users from the reporting.
$wgContribScoreIgnoreBots = false;
// Set to true to use real user names when available. Only for MediaWiki 1.19 and later.
$wgContribScoresUseRealName = false;
// Set to true to disable cache for parser function and inclusion of table.
$wgContribScoreDisableCache = false;
// POSSIBLY MODIFY LATER
// $wgAutoloadClasses['ContributionScores'] = __DIR__ . '/ContributionScores_body.php';
// $wgSpecialPages['ContributionScores'] = 'ContributionScores';
// REMOVE
// $wgMessagesDirs['ContributionScores'] = __DIR__ . '/i18n';
// REMOVE
// $wgExtensionMessagesFiles['ContributionScoresAlias'] = __DIR__ . '/ContributionScores.alias.php';
$wgExtensionMessagesFiles['ContributionScoresMagic'] =
__DIR__ . '/ContributionScores.i18n.magic.php';
$wgHooks['ParserFirstCallInit'][] = 'efContributionScores_Setup';
function efContributionScores_Setup( &$parser ) {
$parser->setFunctionHook( 'cscore', 'efContributionScores_Render' );
return true;
}
function efContributionScores_Render( &$parser, $usertext, $metric = 'score' ) {
global $wgContribScoreDisableCache;
if ( $wgContribScoreDisableCache ) {
$parser->disableCache();
}
$user = User::newFromName( $usertext );
$dbr = wfGetDB( DB_SLAVE );
if ( $user instanceof User && $user->isLoggedIn() ) {
global $wgLang;
if ( $metric == 'score' ) {
$res = $dbr->select( 'revision',
'COUNT(DISTINCT rev_page)+SQRT(COUNT(rev_id)-COUNT(DISTINCT rev_page))*2 AS wiki_rank',
array( 'rev_user' => $user->getID() ) );
$row = $dbr->fetchObject( $res );
$output = $wgLang->formatNum( round( $row->wiki_rank, 0 ) );
} elseif ( $metric == 'changes' ) {
$res = $dbr->select( 'revision',
'COUNT(rev_id) AS rev_count',
array( 'rev_user' => $user->getID() ) );
$row = $dbr->fetchObject( $res );
$output = $wgLang->formatNum( $row->rev_count );
} elseif ( $metric == 'pages' ) {
$res = $dbr->select( 'revision',
'COUNT(DISTINCT rev_page) AS page_count',
array( 'rev_user' => $user->getID() ) );
$row = $dbr->fetchObject( $res );
$output = $wgLang->formatNum( $row->page_count );
} else {
$output = wfMessage( 'contributionscores-invalidmetric' )->text();
}
} else {
$output = wfMessage( 'contributionscores-invalidusername' )->text();
}
return $parser->insertStripItem( $output, $parser->mStripState );
}
*/
/*
ORIGINAL STUFF
*/
/*
$wgExtensionMessagesFiles['UserJourney'] = __DIR__ . '/UserJourney.i18n.php';
$GLOBALS['wgMessagesDirs']['UserJourney'] = __DIR__ . '/i18n';
// Necessary?
$wgExtensionMessagesFiles['UserJourneyAlias'] = __DIR__ . '/UserJourney.alias.php';
// Not currently used
//$wgAutoloadClasses['UserJourney'] = __DIR__ . '/UserJourney.body.php'; // autoload body class
// Special Page
$wgAutoloadClasses['SpecialUserJourney'] = __DIR__ . '/SpecialUserJourney.php'; // autoload special page class
$wgSpecialPages['UserJourney'] = 'SpecialUserJourney'; // register special page
/*
No Longer Used
// 1 of the earliest hooks in page load
// $wgHooks['ArticlePageDataBefore'][] = 'UserJourney::onArticlePageDataBefore';
// collects extension info from hook that provides necessary inputs
// but does not record the information in the database
$wgHooks['BeforeInitialize'][] = 'UserJourney::onBeforeInitialize';
// $wgHooks['ArticleUpdateBeforeRedirect'][] = 'UserJourney::onArticleUpdateBeforeRedirect';
// After save page request has been completed
$wgHooks['PageContentSaveComplete'][] = 'UserJourney::onPageContentSaveComplete';
// records the information at the latest possible time in order to
// record the length of time required to build the page.
$wgHooks['AfterFinalPageOutput'][] = 'UserJourney::recordInDatabase';
// update database (using maintenance/update.php)
$wgHooks['LoadExtensionSchemaUpdates'][] = 'UserJourney::updateDatabase';
// 1 of the last hooks in page load
// $wgHooks['BeforePageDisplay'][] = 'UserJourney::onBeforePageDisplay';
No Longer Used
*/
/*
$userjourneyResourceTemplate = array(
'localBasePath' => __DIR__ . '/modules',
'remoteExtPath' => 'UserJourney/modules',
);
$wgResourceModules += array(
// 'ext.userjourney.charts' => $userjourneyResourceTemplate + array(
// 'position' => 'bottom', // added this since "bottom" was default pre-1.26
// 'styles' => 'charts/ext.userjourney.charts.css',
// 'scripts' => array(
// 'charts/Chart.js',
// 'charts/ext.userjourney.charts.js',
// ),
// ),
// 'ext.userjourney.d3.js' => $userjourneyResourceTemplate + array(
// 'position' => 'bottom', // added this since "bottom" was default pre-1.26
// 'scripts' => array(
// 'd3js/ext.userjourney.d3.js',
// ),
// ),
// For "Overview"
'ext.userjourney.myActivityByYear.nvd3' => $userjourneyResourceTemplate + array(
'position' => 'bottom', // added this since "bottom" was default pre-1.26
'styles' => array(
'nvd3js/nv.d3.css',
// 'nvd3js/ext.userjourney.my-activity-by-year.nvd3.css',
),
'scripts' => array(
'nvd3js/nv.d3.js',
'nvd3js/ext.userjourney.my-activity-by-year.nvd3.js',
),
'dependencies' => array(
// 'ext.userjourney.d3.js',
'd3.js',
),
),
// For "My Activity"
'ext.userjourney.myActivity.nvd3' => $userjourneyResourceTemplate + array(
'position' => 'bottom', // added this since "bottom" was default pre-1.26
'styles' => array(
'nvd3js/nv.d3.css',
'nvd3js/ext.userjourney.my-activity.nvd3.css',
),
'scripts' => array(
'nvd3js/nv.d3.js',
'nvd3js/ext.userjourney.my-activity.nvd3.js',
),
'dependencies' => array(
// 'ext.userjourney.d3.js',
'd3.js',
),
),
// For "Compare Activity"
'ext.userjourney.compare.nvd3' => $userjourneyResourceTemplate + array(
'position' => 'bottom', // added this since "bottom" was default pre-1.26
'styles' => array(
'nvd3js/nv.d3.css',
'nvd3js/ext.userjourney.compare.nvd3.css',
),
'scripts' => array(
'nvd3js/nv.d3.js',
'nvd3js/ext.userjourney.compare-line-with-window.nvd3.js',
'nvd3js/ext.userjourney.compare-stacked.nvd3.js',
// 'nvd3js/ext.userjourney.compare-stream.nvd3.js',
),
'dependencies' => array(
// 'ext.userjourney.d3.js',
'd3.js',
),
),
// For "Compare Scores Stacked Plot"
// 'ext.userjourney.compareScoreStackedPlot.nvd3' => $userjourneyResourceTemplate + array(
// 'position' => 'bottom', // added this since "bottom" was default pre-1.26
// 'styles' => array(
// 'nvd3js/nv.d3.css',
// // 'nvd3js/ext.userjourney.comparescoresstacked.nvd3.css',
// ),
// 'scripts' => array(
// 'nvd3js/nv.d3.js',
// 'nvd3js/ext.userjourney.comparescoresstacked.nvd3.js',
// 'nvd3js/ext.userjourney.comparescoresstackedstream.nvd3.js',
// ),
// 'dependencies' => array(
// // 'ext.userjourney.d3.js',
// 'd3.js',
// ),
// ),
);