-
Notifications
You must be signed in to change notification settings - Fork 9
/
bot.ts
1926 lines (1786 loc) · 54.1 KB
/
bot.ts
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
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
*
* mwn: a MediaWiki bot framework for Node.js
*
* Copyright (C) 2020 Siddharth VP
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
*/
/**
* Attributions:
* Parts of the code are adapted from MWBot <https://github.com/Fannon/mwbot/src/index.js>
* released under the MIT license. Copyright (c) 2015-2018 Simon Heimler.
*
* Some parts are copied from the mediawiki.api module in mediawiki core
* <https://gerrit.wikimedia.org/r/plugins/gitiles/mediawiki/core/+/master/resources/src/mediawiki.api>
* released under GNU GPL v2.
*
*/
// Node internal modules
import * as fs from 'fs';
import * as path from 'path';
import * as crypto from 'crypto';
import * as stream from 'stream';
import * as http from 'http';
import * as https from 'https';
// NPM modules
import axios, { AxiosResponse } from 'axios';
import * as tough from 'tough-cookie';
import * as OAuth from 'oauth-1.0a';
// Nested classes of mwn
import MwnDateFactory, { MwnDate } from './date';
import MwnTitleFactory, { MwnTitle, SiteInfoQueryResponse } from './title';
import MwnPageFactory, { MwnPage } from './page';
import MwnWikitextFactory, { MwnWikitext } from './wikitext';
import MwnUserFactory, { MwnUser } from './user';
import MwnCategoryFactory, { MwnCategory } from './category';
import MwnFileFactory, { MwnFile } from './file';
import { RawRequestParams, Request, Response } from './core';
import { log, updateLoggingConfig } from './log';
import { MwnError, rejectWithError, rejectWithErrorCode } from './error';
import { link, Table, template, util } from './static_utils';
import { arrayChunk, ispromise, makeTitle, makeTitles, merge, mergeDeep1, sleep } from './utils';
import type {
ApiDeleteParams,
ApiEditPageParams,
ApiMoveParams,
ApiParseParams,
ApiPurgeParams,
ApiQueryAllMessagesParams,
ApiQueryAllPagesParams,
ApiQueryCategoryMembersParams,
ApiQuerySearchParams,
ApiQueryUserInfoParams,
ApiRollbackParams,
ApiUndeleteParams,
ApiUploadParams,
} from './api_params';
import {
ApiDeleteResponse,
ApiEditResponse,
ApiMoveResponse,
ApiPage,
ApiResponse,
ApiRevision,
ApiRollbackResponse,
ApiSearchResult,
ApiResponseSubType,
ApiUndeleteResponse,
ApiUploadResponse,
} from './api_response_types';
export { MwnDate, MwnTitle, MwnPage, MwnFile, MwnCategory, MwnWikitext, MwnUser, ApiPage, ApiRevision };
// Export, if only for the sake of getting generated documentation
export * from './api_response_types';
export type { PageViewData, PageViewOptions } from './page';
export type { TemplateConfig, Template, MwnWikitextStatic } from './wikitext';
export interface MwnOptions {
silent?: boolean;
apiUrl?: string;
userAgent?: string;
username?: string;
password?: string;
OAuthCredentials?: {
consumerToken: string;
consumerSecret: string;
accessToken: string;
accessSecret: string;
};
OAuth2AccessToken?: string;
maxRetries?: number;
retryPause?: number;
shutoff?: {
intervalDuration?: number;
page?: string;
condition?: RegExp | ((text: string) => boolean);
onShutoff?: (text: string) => void;
};
defaultParams?: ApiParams;
suppressAPIWarnings?: boolean;
editConfig?: editConfigType;
suppressInvalidDateWarning?: boolean;
}
export type EditTransform = (rev: {
content: string;
timestamp: string;
}) => string | ApiEditPageParams | Promise<string | ApiEditPageParams>;
type editConfigType = {
conflictRetries?: number;
suppressNochangeWarning?: boolean;
exclusionRegex?: RegExp;
};
export type ApiParams = {
[param: string]:
| string
| string[]
| boolean
| number
| number[]
| Date
| File
| {
stream: NodeJS.ReadableStream;
name: string;
};
};
export class Mwn {
/**
* Bot instance Login State
* Is received from the MW Login API and contains token, userid, etc.
*/
state: any = {};
/**
* Bot instance is logged in or not
*/
loggedIn = false;
/**
* Bot instance's edit token. Initially set as an invalid token string
* so that the badtoken handling logic is invoked if the token is
* not set before a query is sent.
* @type {string}
*/
csrfToken = '%notoken%';
/**
* Default options.
* Should be immutable
*/
readonly defaultOptions: MwnOptions = {
// suppress messages, except for error messages and warnings
silent: false,
// site API url, example "https://en.wikipedia.org/w/api.php"
apiUrl: null,
// User agent string
userAgent: 'mwn',
// bot login username and password, setup using Special:BotPasswords
username: null,
password: null,
// OAuth credentials
OAuthCredentials: {
consumerToken: null,
consumerSecret: null,
accessToken: null,
accessSecret: null,
},
// max number of times to retry the same request on errors due to
// maxlag, wiki being in readonly mode, and other transient errors
maxRetries: 3,
// milliseconds to pause before retrying after a transient error
retryPause: 5000,
// Bot emergency shutoff options
shutoff: {
intervalDuration: 10000,
page: null,
condition: /^\s*$/,
onShutoff() {},
},
// default parameters included in every API request
defaultParams: {
format: 'json',
formatversion: '2',
maxlag: 5,
},
// suppress logging of warnings received from the API
suppressAPIWarnings: false,
// options for the edit() function
editConfig: {
// max number of retries on edit conflicts
conflictRetries: 2,
// suppress warning on an edit resulting in no change to the page
suppressNochangeWarning: false,
// abort edit if exclusionRegex matches on the page content
exclusionRegex: null,
},
};
/**
* Actual, current options of the bot instance
* Mix of the default options, the custom options and later changes
* @type {Object}
*/
options: MwnOptions;
/**
* Cookie jar for the bot instance - holds session and login cookies
* @type {tough.CookieJar}
*/
cookieJar: tough.CookieJar = new tough.CookieJar();
static requestDefaults: RawRequestParams = {
headers: {
'Accept-Encoding': 'gzip',
},
// keep-alive pools and reuses TCP connections, for better performance
httpAgent: new http.Agent({ keepAlive: true }),
httpsAgent: new https.Agent({ keepAlive: true }),
timeout: 60000, // 60 seconds
};
/**
* Request options for the axios library.
* Change the defaults using setRequestOptions()
* @type {Object}
*/
requestOptions: RawRequestParams = mergeDeep1(
{
responseType: 'json',
},
Mwn.requestDefaults
);
/**
* Emergency shutoff config
* @type {{hook: NodeJS.Timeout, state: boolean}}
*/
shutoff: { state: boolean; hook: NodeJS.Timeout } = {
state: false,
hook: null,
};
hasApiHighLimit = false;
oauth: OAuth;
usingOAuth: boolean;
usingOAuth2: boolean;
static Error = MwnError;
// Expose logger
static log = log;
static setLoggingConfig = updateLoggingConfig;
static link = link;
static template = template;
static Table = Table;
/** @deprecated Use {@link Table} instead **/
static table = Table;
static util = util;
/** @deprecated Use {@link Title} instead */
title = MwnTitleFactory();
/**
* Title class associated with the bot instance.
* See {@link MwnTitle} interface for methods on title objects.
*/
Title = MwnTitleFactory();
/** @deprecated Use {@link Page} instead */
page = MwnPageFactory(this);
/**
* Page class associated with the bot instance.
* See {@link MwnPage} interface for methods on page objects.
*/
Page = MwnPageFactory(this);
/** @deprecated Use {@link Category} instead */
category = MwnCategoryFactory(this);
/**
* Category class associated with the bot instance.
* See {@link MwnCategory} interface for methods on category objects.
*/
Category = MwnCategoryFactory(this);
/** @deprecated Use {@link File} instead */
file = MwnFileFactory(this);
/**
* File class associated with the bot instance.
* See {@link MwnFile} interface for methods on file objects.
*/
File = MwnFileFactory(this);
/** @deprecated Use {@link User} instead */
user = MwnUserFactory(this);
/**
* User class associated with the bot instance.
* See {@link MwnUser} interface for methods on user objects.
*/
User = MwnUserFactory(this);
/** @deprecated Use {@link Wikitext} instead */
wikitext = MwnWikitextFactory(this);
/**
* Wikitext class associated with the bot instance.
* See {@link MwnWikitext} interface for methods on wikitext objects.
*/
Wikitext = MwnWikitextFactory(this);
/** @deprecated Use {@link Date} instead */
date = MwnDateFactory(this);
/**
* Date class associated with the bot instance.
* See {@link MwnDate} interface for methods on date objects.
*/
Date = MwnDateFactory(this);
/**
* Constructs a new bot instance
* It is advised to create one bot instance for every API to use
* A bot instance has its own state (e.g. tokens) that is necessary for some operations
*
* @param [customOptions] - Custom options
*/
constructor(customOptions?: MwnOptions | string) {
if (process.versions.node) {
let majorVersion = parseInt(process.versions.node);
if (majorVersion < 10) {
log(
`[W] Detected node version v${process.versions.node}, but mwn is supported only on node v10.x and above`
);
}
}
if (typeof customOptions === 'string') {
// Read options from file (JSON):
try {
customOptions = JSON.parse(fs.readFileSync(customOptions).toString());
} catch (err) {
throw new Error(`Failed to read or parse JSON config file: ` + err);
}
}
this.options = mergeDeep1(this.defaultOptions, customOptions);
}
/**
* Initialize a bot object. Login to the wiki and fetch editing tokens. If OAuth
* credentials are provided, they will be used over BotPassword credentials.
* Also fetches the site data needed for parsing and constructing title objects.
* @param {Object} config - Bot configurations, including apiUrl, and either the
* username and password or the OAuth credentials
* @returns {Promise<Mwn>} bot object
*/
static async init(config: MwnOptions): Promise<Mwn> {
const bot = new Mwn(config);
if (bot.options.OAuth2AccessToken || bot._usingOAuth()) {
bot.initOAuth();
await bot.getTokensAndSiteInfo();
} else {
await bot.login();
}
return bot;
}
/**
* Set and overwrite mwn options
* @param {Object} customOptions
*/
setOptions(customOptions: MwnOptions) {
this.options = mergeDeep1(this.options, customOptions);
}
/**
* Sets the API URL for MediaWiki requests
* This can be uses instead of a login, if no actions are used that require login.
* @param {string} apiUrl - API url to MediaWiki, e.g. https://en.wikipedia.org/w/api.php
*/
setApiUrl(apiUrl: string) {
this.options.apiUrl = apiUrl;
}
/**
* Sets and overwrites the raw request options, used by the axios library
* See https://www.npmjs.com/package/axios
*/
setRequestOptions(customRequestOptions: RawRequestParams) {
return mergeDeep1(this.requestOptions, customRequestOptions);
}
/**
* Set the default parameters to be sent in API calls.
* @param {Object} params - default parameters
*/
setDefaultParams(params: ApiParams) {
this.options.defaultParams = merge(this.options.defaultParams, params);
}
/**
* Set your API user agent. See https://meta.wikimedia.org/wiki/User-Agent_policy
* Required for WMF wikis.
* @param {string} userAgent
*/
setUserAgent(userAgent: string) {
this.options.userAgent = userAgent;
}
/**
* @private
* Determine if we're going to use OAuth for authentication
*/
private _usingOAuth(): boolean {
const creds = this.options.OAuthCredentials;
if (typeof creds !== 'object') {
return false;
}
if (!creds.consumerToken || !creds.consumerSecret || !creds.accessToken || !creds.accessSecret) {
return false;
}
return true;
}
/**
* Initialize OAuth instance
*/
initOAuth() {
if (this.options.OAuth2AccessToken) {
this.usingOAuth2 = true;
return;
}
if (!this._usingOAuth()) {
// without this, the API would return a confusing
// mwoauth-invalid-authorization invalid consumer error
throw new Error('[mwn] Invalid OAuth config');
}
try {
this.oauth = new OAuth({
consumer: {
key: this.options.OAuthCredentials.consumerToken,
secret: this.options.OAuthCredentials.consumerSecret,
},
signature_method: 'HMAC-SHA1',
// based on example at https://www.npmjs.com/package/oauth-1.0a
hash_function(base_string, key) {
return crypto.createHmac('sha1', key).update(base_string).digest('base64');
},
});
this.usingOAuth = true;
} catch (err) {
throw new Error('Failed to construct OAuth object. ' + err);
}
}
/************ CORE REQUESTS ***************/
/**
* Executes a raw request
* Uses the axios library
* @param {Object} requestOptions
* @returns {Promise}
*/
async rawRequest(requestOptions: RawRequestParams): Promise<AxiosResponse> {
if (!requestOptions.url) {
return rejectWithError({
code: 'mwn_nourl',
info: 'No URL provided for API request!',
disableRetry: true,
request: requestOptions,
});
}
return axios(
mergeDeep1(
{},
Mwn.requestDefaults,
{
method: 'get',
headers: {
'User-Agent': this.options.userAgent,
},
},
requestOptions
)
);
}
/**
* Executes a request with the ability to use custom parameters and custom
* request options
* @param {Object} params
* @param {Object} [customRequestOptions={}]
* @returns {Promise}
*/
async request(params: ApiParams, customRequestOptions: RawRequestParams = {}): Promise<ApiResponse> {
if (this.shutoff.state) {
return rejectWithError({
code: 'bot-shutoff',
info: `Bot was shut off (check ${this.options.shutoff.page})`,
});
}
const req = new Request(this, params, customRequestOptions);
await req.process();
return this.rawRequest(req.requestParams).then(
(fullResponse: AxiosResponse<ApiResponse>) =>
new Response(this, req.apiParams, req.requestParams).process(fullResponse),
(error) => new Response(this, req.apiParams, req.requestParams).handleRequestFailure(error)
);
}
async query(params: ApiParams, customRequestOptions: RawRequestParams = {}): Promise<ApiResponse> {
return this.request(Object.assign({ action: 'query' }, params), customRequestOptions);
}
/************** CORE FUNCTIONS *******************/
/**
* Executes a Login
* @see https://www.mediawiki.org/wiki/API:Login
* @returns {Promise}
*/
async login(loginOptions?: { username?: string; password?: string; apiUrl?: string }): Promise<ApiResponse> {
this.options = merge(this.options, loginOptions);
if (!this.options.username || !this.options.password || !this.options.apiUrl) {
return rejectWithError({
code: 'mwn_nologincredentials',
info: 'Incomplete login credentials!',
});
}
let loginString = this.options.username + '@' + this.options.apiUrl;
// Step 1: Fetch login token
const loginTokenResponse = await this.request({
action: 'query',
meta: 'tokens',
type: 'login',
// unset the assert parameter (in case it's given by the user as a default
// option), as it will invariably fail until login is performed.
assert: undefined,
});
if (!loginTokenResponse?.query?.tokens?.logintoken) {
log('[E] [mwn] Login failed with invalid response: ' + loginString);
return rejectWithError({
code: 'mwn_notoken',
info: 'Failed to get login token',
response: loginTokenResponse,
});
}
Object.assign(this.state, loginTokenResponse.query.tokens);
// Step 2: Post login request
const loginResponse = await this.request({
action: 'login',
lgname: this.options.username,
lgpassword: this.options.password,
lgtoken: loginTokenResponse.query.tokens.logintoken,
assert: undefined, // as above, assert won't work till the user is logged in
});
let reason;
let data = loginResponse.login;
if (data) {
if (data.result === 'Success') {
Object.assign(this.state, data);
this.loggedIn = true;
if (!this.options.silent) {
log('[S] [mwn] Login successful: ' + loginString);
}
// Step 3: fetch tokens for editing, and info about namespaces for MwnTitle
await this.getTokensAndSiteInfo().catch((err) => {
log(`[W] Failed fetching tokens and siteinfo: ${err}`);
});
return data;
} else if (data.result === 'Aborted') {
if (
data.reason === 'Cannot log in when using MediaWiki\\Session\\BotPasswordSessionProvider sessions.'
) {
reason = `Already logged in as ${this.options.username}, logout first to re-login`;
} else if (
data.reason === 'Cannot log in when using MediaWiki\\Extension\\OAuth\\SessionProvider sessions.'
) {
reason = `Cannot use login/logout while using OAuth`;
} else if (data.reason) {
reason = data.result + ': ' + data.reason;
}
} else if (data.result && data.reason) {
reason = data.result + ': ' + data.reason;
}
}
return rejectWithError({
code: 'mwn_failedlogin',
info: reason || 'Login failed',
response: loginResponse,
});
}
/**
* Log out of the account. Flushes the cookie jar and clears the saved tokens.
* Should not be used if authenticating via OAuth.
* @returns {Promise<void>}
*/
async logout(): Promise<void> {
if (this.usingOAuth) {
throw new Error("Can't use logout() while using OAuth");
}
return this.request({
action: 'logout',
token: this.csrfToken,
}).then(() => {
// returns an empty response ({}) if successful
this.loggedIn = false;
this.state = {};
this.csrfToken = '%notoken%';
return this.cookieJar.removeAllCookies();
});
}
/**
* Create an account. Only works on wikis without extensions like
* ConfirmEdit enabled (hence doesn't work on WMF wikis).
* @param username
* @param password
*/
async createAccount(username: string, password: string): Promise<any> {
if (!this.state.createaccounttoken) {
// not logged in
await this.getTokens();
}
return this.request({
action: 'createaccount',
createreturnurl: 'https://example.com',
createtoken: this.state.createaccounttoken,
username: username,
password: password,
retype: password,
}).then((json) => {
let data = json.createaccount;
if (data.status === 'FAIL') {
return rejectWithError({
code: data.messagecode,
info: data.message,
...data,
});
} else {
// status === 'PASS' or other value
return data;
}
});
}
/**
* Get basic info about the logged-in user
* @param [options]
* @returns {Promise}
*/
async userinfo(options: ApiQueryUserInfoParams = {}): Promise<any> {
return this.request({
action: 'query',
meta: 'userinfo',
...options,
}).then((response) => response.query.userinfo);
}
/**
* Gets namespace-related information for use in title nested class.
* This need not be used if login() is being used. This is for cases
* where mwn needs to be used without logging in.
* @returns {Promise<void>}
*/
async getSiteInfo(): Promise<void> {
return this.request({
action: 'query',
meta: 'siteinfo',
siprop: 'general|namespaces|namespacealiases',
}).then((result: SiteInfoQueryResponse) => {
this.title.processNamespaceData(result);
this.Title.processNamespaceData(result);
});
}
/**
* Get tokens and saves them in this.state
* @returns {Promise<void>}
*/
async getTokens(): Promise<void> {
return this.request({
action: 'query',
meta: 'tokens',
type: 'csrf|createaccount|login|patrol|rollback|userrights|watch',
}).then((response: ApiResponse) => {
if (response.query && response.query.tokens) {
this.csrfToken = response.query.tokens.csrftoken;
this.state = merge(this.state, response.query.tokens);
} else {
return rejectWithError({
code: 'mwn_notoken',
info: 'Could not get token',
response,
});
}
});
}
/**
* Gets an edit token (also used for most other actions
* such as moving and deleting)
* This is only compatible with MW >= 1.24
* @returns {Promise<string>}
*/
async getCsrfToken(): Promise<string> {
return this.getTokens().then(() => this.csrfToken);
}
/**
* Get tokens and siteinfo (using a single API request) and save them in the bot state.
* @returns {Promise<void>}
*/
async getTokensAndSiteInfo(): Promise<void> {
return this.request({
action: 'query',
meta: 'tokens|siteinfo|userinfo',
type: 'csrf|createaccount|login|patrol|rollback|userrights|watch',
siprop: 'general|namespaces|namespacealiases',
uiprop: 'rights',
}).then((response: ApiResponse & SiteInfoQueryResponse) => {
this.title.processNamespaceData(response);
this.Title.processNamespaceData(response);
if (response.query.userinfo.rights.includes('apihighlimits')) {
this.hasApiHighLimit = true;
}
if (response.query && response.query.tokens) {
this.csrfToken = response.query.tokens.csrftoken;
this.state = merge(this.state, response.query.tokens);
} else {
return rejectWithError({
code: 'mwn_notoken',
info: 'Could not get token',
response,
});
}
});
}
/**
* Get type of token to be used with an API action
* @param {string} action - API action parameter
* @returns {Promise<string>}
*/
async getTokenType(action: string): Promise<string> {
return this.request({
action: 'paraminfo',
modules: action,
}).then((response) => {
return response.paraminfo.modules[0].parameters.find((p: ApiResponseSubType) => p.name === 'token')
.tokentype;
});
}
/**
* Login and fetch edit tokens. Deprecated in favour of login(), which
* also fetches tokens from mwn v0.10
* @deprecated
* @param [loginOptions]
* @returns {Promise<void>}
*/
async loginGetToken(loginOptions?: MwnOptions): Promise<void> {
return this.login(loginOptions).then();
}
/**
* Get the wiki's server time
* @returns {Promise<string>}
*/
async getServerTime(): Promise<string> {
return this.request({
action: 'query',
curtimestamp: true,
}).then((data) => {
return data.curtimestamp;
});
}
/**
* Fetch and parse a JSON wikipage
* @param {string} title - page title
* @returns {Promise<Object>} parsed JSON object
*/
async parseJsonPage(title: string): Promise<any> {
return this.read(title).then((data) => {
try {
return JSON.parse(data.revisions[0].content);
} catch (e) {
return rejectWithErrorCode('invalidjson');
}
});
}
/**
* Fetch MediaWiki messages
* @param messages
* @param options
*/
async getMessages(messages: string | string[], options: ApiQueryAllMessagesParams = {}) {
return this.request({
action: 'query',
meta: 'allmessages',
ammessages: messages,
...options,
}).then((data) => {
let result: Record<string, string> = {};
data.query.allmessages.forEach((obj: ApiResponseSubType) => {
if (!obj.missing) {
result[obj.name] = obj.content;
}
});
return result;
});
}
/**
* Enable bot emergency shutoff
*/
enableEmergencyShutoff(shutoffOptions?: {
page?: string;
intervalDuration?: number;
condition?: RegExp | ((text: string) => boolean);
onShutoff?: (text: string) => void;
}): void {
Object.assign(this.options.shutoff, shutoffOptions);
this.shutoff.hook = setInterval(async () => {
let text = await new this.Page(this.options.shutoff.page).text();
let cond = this.options.shutoff.condition;
if ((cond instanceof RegExp && !cond.test(text)) || (cond instanceof Function && !cond(text))) {
this.shutoff.state = true;
this.disableEmergencyShutoff();
// user callback executed last, so that an error thrown by
// it doesn't prevent the the above from being run
this.options.shutoff.onShutoff(text);
}
}, this.options.shutoff.intervalDuration);
}
/**
* Disable emergency shutoff detection.
* Use this only if it was ever enabled.
*/
disableEmergencyShutoff(): void {
clearInterval(this.shutoff.hook);
}
/***************** HELPER FUNCTIONS ******************/
/**
* Reads the content and and meta-data of one (or many) pages.
* Content from the "main" slot is copied over to every revision object
* for easier referencing (`pg.revisions[0].content` can be used instead of
* `pg.revisions[0].slots.main.content`).
*
* @param {string|string[]|number|number[]} titles - for multiple pages use an array
* @param {Object} [options]
* @returns {Promise<ApiPage>}
*/
read(titles: string | number | MwnTitle, options?: ApiParams): Promise<ApiPage>;
read(titles: string[] | number[] | MwnTitle[], options?: ApiParams): Promise<ApiPage[]>;
read(titles: any, options?: any): any {
let pages = Array.isArray(titles) ? titles : [titles];
let batchFieldName = typeof pages[0] === 'number' ? 'pageids' : 'titles';
return this.massQuery(
{
action: 'query',
...makeTitles(titles),
prop: 'revisions',
rvprop: 'content|timestamp',
rvslots: 'main',
redirects: true,
...options,
},
batchFieldName
).then((jsons: Array<ApiResponse>) => {
let data = jsons.reduce((data, json) => {
json.query.pages.forEach((pg: ApiPage) => {
if (pg.revisions) {
pg.revisions.forEach((rev: ApiRevision) => {
Object.assign(rev, rev.slots.main);
});
}
});
return data.concat(json.query.pages);
}, []);
return data.length === 1 ? data[0] : data;
});
}
async *readGen(titles: string[], options?: ApiParams, batchSize?: number): AsyncGenerator<ApiPage> {
let massQueryResponses = this.massQueryGen(
{
action: 'query',
...makeTitles(titles),
prop: 'revisions',
rvprop: 'content|timestamp',
rvslots: 'main',
redirects: true,
...options,
},
typeof titles[0] === 'number' ? 'pageids' : 'titles',
batchSize
);
for await (let response of massQueryResponses) {
if (response && response.query && response.query.pages) {
for (let pg of response.query.pages) {
if (pg.revisions) {
pg.revisions.forEach((rev: ApiRevision) => {
Object.assign(rev, rev.slots.main);
});
}
yield pg;
}
}
}
}
// adapted from mw.Api().edit
/**
* @param {string|number|MwnTitle} title - Page title or page ID or MwnTitle object
* @param {Function} transform - Callback that prepares the edit. It takes one
* argument that is an { content: 'string: page content', timestamp: 'string:
* time of last edit' } object. This function should return an object with
* edit API parameters or just the updated text, or a promise providing one of
* those.
* @param {Object} [editConfig] - Overridden edit options. Available options:
* conflictRetries, suppressNochangeWarning, exclusionRegex
* @config conflictRetries - maximum number of times to retry edit after encountering edit
* conflicts.
* @config suppressNochangeWarning - don't show the warning when no change is actually
* made to the page on an successful edit
* @config exclusionRegex - don't edit if the page text matches this regex. Used for bot
* per-page exclusion compliance.
* @return {Promise<Object>} Edit API response
*/
async edit(
title: string | number,
transform: EditTransform,
editConfig?: editConfigType
): Promise<ApiEditResponse> {
editConfig = editConfig || this.options.editConfig;
// TODO: use baserevid instead of basetimestamp for conflict handling
let basetimestamp: string, curtimestamp: string;
return this.request({
action: 'query',
...makeTitles(title),
prop: 'revisions',
rvprop: ['content', 'timestamp'],
rvslots: 'main',
formatversion: '2',
curtimestamp: true,
})