-
Notifications
You must be signed in to change notification settings - Fork 2
/
pywiki.py
621 lines (558 loc) · 20.2 KB
/
pywiki.py
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
#!/usr/bin/python2.7
# -*- coding: utf-8 -*-
#Autor: Antoine "0x010C" Lamielle
#Date: 18 March 2016
#License: GNU GPL v3
import sys
import os
import time
import json
import requests
NS_MAIN = 0
NS_TALK = 1
NS_USER = 2
NS_USER_TALK = 3
NS_WIKIPEDIA = 4
NS_WIKIPEDIA_TALK = 5
NS_FILE = 6
NS_FILE = 7
NS_MEDIAWIKI = 8
NS_MEDIAWIKI_TALK = 9
NS_TEMPLATE = 10
NS_TEMPLATE_TALK = 11
NS_HELP = 12
NS_HELP_TALK = 13
NS_CATEGORY = 14
NS_CATEGORY_TALK = 15
NS_PORTAL = 100
NS_PORTAL_TALK = 101
NS_PROJECT = 102
NS_PROJECT_TALK = 103
NS_REFERENCE = 104
NS_REFERENCE_TALK = 105
NS_MODULE = 828
NS_MODULE_TALK = 829
class Pywiki:
def __init__(self, config_name):
user_path = os.path.dirname(os.path.realpath(__file__)) + "/users/"
if not os.path.exists(user_path):
os.makedirs(user_path)
if(os.path.isfile(user_path+config_name+".py") == False):
print "The user configuration file called '"+config_name+"' seems missing. Don't worry, we will create it yet :\n"
print "user:"
print "> ",;user = sys.stdin.readline().split("\n")[0]
print "password:"
print "> ",;password = sys.stdin.readline().split("\n")[0]
print "assertion ('user' or 'bot'):"
print "> ",;assertion = sys.stdin.readline().split("\n")[0]
print "api endpoint (ex. 'https://en.wikipedia.org/w/api.php'):"
print "> ",;api_endpoint = sys.stdin.readline().split("\n")[0]
file = open("users/"+config_name+".py", "w")
file.write("# -*- coding: utf-8 -*-\nuser = u'"+user+"'\npassword = u'"+password+"'\nassertion = u'"+assertion+"'\napi_endpoint = u'"+api_endpoint+"'")
file.close()
sys.path.append(user_path)
config = __import__(config_name, globals(), locals(), [], -1)
self.user = config.user
self.basic_user_name = self.user.split("@")[0]
self.password = config.password
self.api_endpoint = config.api_endpoint
self.assertion = config.assertion
if self.assertion == "bot":
self.limit = 5000
else:
self.limit = 500
self.session = requests.Session()
"""
Perform a given request with a simple but usefull error managment
"""
def request(self, data, files=None):
relogin = 3
while relogin:
try:
if files == None:
r = self.session.post(self.api_endpoint, data=data)
else:
r = self.session.post(self.api_endpoint, data=data, files=files)
print r.text
response = json.loads(r.text)
if response.has_key("error"):
if response['error']['code'] == 'assertuserfailed':
self.login()
relogin -= 1
continue
break
return response
except requests.exceptions.ConnectionError,OpenSSL.SSL.ZeroReturnError:
time.sleep(5)
self.session = requests.Session()
self.login()
relogin -= 1
raise Exception('API error', response['error'])
"""
Login into the wiki
"""
def login(self):
r = self.session.post(self.api_endpoint, data={
"action":"login",
"lgname":self.user,
"lgpassword":self.password,
"format":"json"
})
token = json.loads(r.text)["login"]["token"];
r = self.session.post(self.api_endpoint, data={
"action":"login",
"lgname":self.user,
"lgpassword":self.password,
"lgtoken":token,
"format":"json"
})
if json.loads(r.text)["login"]["result"] != "Success":
return -1
return 0
"""
Get a crsf token from frwiki to be able to edit a page
"""
def get_csrf_token(self):
r = self.request({
"action":"query",
"meta":"tokens",
"type":"csrf",
"assert":self.assertion,
"format":"json"
})
return r["query"]["tokens"]["csrftoken"]
"""
Revert a given diff, if possible
"""
def revert(self, title, rev_id, summary):
token = self.get_csrf_token()
if self.assertion == "bot":
prepare["bot"] = "1"
r = self.session.post(self.api_endpoint, data={
"action":"edit",
"title":title,
"undo":rev_id,
"summary":summary,
"nocreate":"",
"token":token,
"assert":self.assertion,
"format":"json"
})
"""
Get N pages of a category, starting at offset gcm_continue if given
"""
def get_pages_in_cat(self, category, ns=None, gcm_type="subcat|page|file", gcm_continue=""):
if ns == None:
ns = ""
elif isinstance(ns, list):
ns = "|".join(str(i) for i in ns)
r = self.session.post(self.api_endpoint, data={
"action":"query",
"format":"json",
"generator":"categorymembers",
"gcmtitle":category,
"gcmtype":gcm_type,
"gcmlimit":self.limit,
"gcmcontinue":gcm_continue,
})
response = json.loads(r.text)
if "continue" in response:
gcm_continue = response["continue"]["gcmcontinue"]
else:
gcm_continue = None
titles = []
if "query" in response:
for i in response["query"]["pages"]:
titles += [response["query"]["pages"][i]["title"]]
return (titles,gcm_continue)
"""
Get all pages of a category
@param string category : The category name, including the prefixed namespace (ex: "Category:Python")
@param list ns : A list of the numeric value of the namespaces to work on, will ignore all the others (ex: [0,1,4]) ; if None is given, it will include all the namespaces
"""
def get_all_pages_in_cat(self, category, ns=None, recursive=False):
all_titles = set()
all_cats = set([category])
if recursive:
to_search = set([category])
while to_search:
gcm_continue = ""
current_cat = to_search.pop()
while gcm_continue != None:
(cats, gcm_continue) = self.get_pages_in_cat(current_cat, NS_CATEGORY, gcm_continue)
for cat in cats:
if cat not in all_cats:
to_search.add(cat)
all_cats.add(cat)
for cat in all_cats:
gcm_continue = ""
while gcm_continue != None:
(titles, gcm_continue) = self.get_pages_in_cat(cat, ns, gcm_continue)
all_titles.update(titles)
return all_titles
"""
Get N pages that transclude a template
"""
def get_transcluded_pages(self, title, ns=None, ti_continue=""):
if ns == None:
ns = ""
elif isinstance(ns, list):
ns = "|".join(str(i) for i in ns)
r = self.session.post(self.api_endpoint, data={
"action":"query",
"format":"json",
"prop":"transcludedin",
"titles":title,
"tiprop":"title",
"tinamespace":ns,
"tilimit":self.limit,
"ticontinue":ti_continue,
})
response = json.loads(r.text)
if "continue" in response:
ti_continue = response["continue"]["ticontinue"]
else:
ti_continue = None
titles = []
if "query" in response:
raw_titles = response["query"]["pages"].itervalues().next()["transcludedin"]
for title in raw_titles:
titles += [title["title"]]
return (titles,ti_continue)
"""
Get all pages that transclude a template
"""
def get_all_transcluded_pages(self, title, ns=None):
ti_continue = ""
all_titles = []
while ti_continue != None:
(titles, ti_continue) = self.get_transcluded_pages(title, ns, ti_continue)
all_titles += titles
return all_titles
"""
Get N pages that links to a page
"""
def get_linking_pages(self, title, ns=None, lh_continue=""):
if ns == None:
ns = ""
elif isinstance(ns, list):
ns = "|".join(str(i) for i in ns)
r = self.session.post(self.api_endpoint, data={
"action":"query",
"format":"json",
"prop":"linkshere",
"titles":title,
"lhprop":"title",
"lhnamespace":ns,
"lhlimit":self.limit,
"lhcontinue":lh_continue,
})
print r.status_code
response = json.loads(r.text)
if "continue" in response:
lh_continue = response["continue"]["lhcontinue"]
else:
lh_continue = None
print response
titles = []
if "query" in response:
raw_titles = response["query"]["pages"].itervalues().next()["linkshere"]
for title in raw_titles:
titles += [title["title"]]
return (titles,lh_continue)
"""
Get all pages that links to a page
"""
def get_all_linking_pages(self, title, ns=None):
lh_continue = ""
all_titles = []
while lh_continue != None:
(titles, lh_continue) = self.get_linking_pages(title, ns, lh_continue)
all_titles += titles
return all_titles
"""
Get the N first redirect pages of the wiki
"""
def get_pages(self, ns=None, gap_continue=""):
data = {
"action":"query",
"format":"json",
"generator":"allpages",
"gaplimit":self.limit,
"assert":self.assertion,
}
if ns != None:
data["gapnamespace"] = ns
if gap_continue != "":
data["gapcontinue"] = gap_continue
response = self.request(data)
if "continue" in response:
gap_continue = response["continue"]["gapcontinue"]
else:
gap_continue = None
page_list = response["query"]["pages"]
titles = []
for id in page_list:
if page_list[id].has_key("title"):
titles += [page_list[id]["title"]]
return (titles,gap_continue)
"""
Get all redirect pages of the wiki
"""
def get_all_pages(self, ns=None):
gap_continue = ""
all_titles = []
while gap_continue != None:
(titles, gap_continue) = self.get_pages(ns, gap_continue)
all_titles += titles
return all_titles
"""
Get the N first redirect pages of the wiki
"""
def get_redirects(self, ns=None, gar_continue=""):
data = {
"action":"query",
"format":"json",
"generator":"allredirects",
"garlimit":self.limit,
"assert":self.assertion,
}
if ns != None:
data["garnamespace"] = ns
if gar_continue != "":
data["garcontinue"] = gar_continue
response = self.request(data)
if "continue" in response:
gar_continue = response["continue"]["garcontinue"]
else:
gar_continue = None
page_list = response["query"]["pages"]
titles = []
for id in page_list:
if page_list[id].has_key("title"):
titles += [page_list[id]["title"]]
return (titles,gar_continue)
"""
Get all redirect pages of the wiki
"""
def get_all_redirects(self, ns=None):
gar_continue = ""
all_titles = []
while gar_continue != None:
(titles, gar_continue) = self.get_redirects(ns, gar_continue)
all_titles += titles
return all_titles
"""
Append the given text to a page, or a list of pages
@param list/string titles : A list of pages to append the text (if only a page has to be processed, it could be passed as a string)
@param string text : The text to append ; all the "$(title)" will be replaced by the title of the page.
@param string summary : the summary of the edit; all the "$(title)" will be replaced by the title of the page.
@param bool nocreate : if it's set to True, the edit will fail when the page doesn't exist
@param bool createonly : if it's set to True, the edit will fail when the page already exists
"""
def append(self, titles, text, summary, nocreate=False, createonly=False):
if isinstance(titles, basestring):
titles = [titles]
data={
"action":"edit",
"assert":self.assertion,
"format":"json"
}
if self.assertion == "bot":
data["bot"] = 1
if nocreate:
data["nocreate"] = ""
elif createonly:
data["createonly"] = ""
for title in titles:
data["title"] = title
data["appendtext"] = text.replace("$(title)", title)
data["summary"] = summary.replace("$(title)", title)
data["token"] = self.get_csrf_token()
r = self.session.post(self.api_endpoint, data=data)
"""
Prepend the given text to a page, or a list of pages
@param list/string titles : A list of pages onto the text should be prepend (if only a page has to be processed, it could be passed as a string)
@param string text : The text to prepend ; all the "$(title)" will be replaced by the title of the page.
@param string summary : the summary of the edit; all the "$(title)" will be replaced by the title of the page.
@param bool nocreate : if it's set to True, the edit will fail when the page doesn't exist
@param bool createonly : if it's set to True, the edit will fail when the page already exists
"""
def prepend(self, titles, text, summary, nocreate=False, createonly=False):
if isinstance(titles, basestring):
titles = [titles]
data={
"action":"edit",
"assert":self.assertion,
"format":"json"
}
if self.assertion == "bot":
data["bot"] = 1
if nocreate:
data["nocreate"] = ""
elif createonly:
data["createonly"] = ""
for title in titles:
data["title"] = title
data["prependtext"] = text.replace("$(title)", title)
data["summary"] = summary.replace("$(title)", title)
data["token"] = self.get_csrf_token()
r = self.session.post(self.api_endpoint, data=data)
"""
Replace the content of a page (or a list of pages) with the given text
@param list/string titles : A list of pages to append the text (if only a page has to be processed, it could be passed as a string)
@param string text : The text to append ; all the "$(title)" will be replaced by the title of the page.
@param string summary : the summary of the edit; all the "$(title)" will be replaced by the title of the page.
@param bool nocreate : if it's set to True, the edit will fail when the page doesn't exist
@param bool createonly : if it's set to True, the edit will fail when the page already exists
"""
def replace(self, titles, text, summary, nocreate=False, createonly=False, use_ids=False):
if isinstance(titles, (int, basestring)):
titles = [titles]
prepare={
"action":"edit",
"assert":self.assertion,
"format":"json",
}
if self.assertion == "bot":
prepare["bot"] = 1
if nocreate:
prepare["nocreate"] = ""
elif createonly:
prepare["createonly"] = ""
for title in titles:
data = prepare
if use_ids:
data['pageid'] = title
else:
data["title"] = title
data["text"] = text.replace("$(title)", title)
data["summary"] = summary.replace("$(title)", title)
data["token"] = self.get_csrf_token()
r = self.request(data)
"""
Get the number of notification of the currently-logged user
"""
def get_notifications_count(self):
r = self.session.post(self.api_endpoint, data={
"action":"query",
"meta":"notifications",
"notsections":"alert",
"notprop":"count",
"assert":self.assertion,
"format":"json"
})
response = json.loads(r.text)
return response["query"]["notifications"]["count"]
def exist(self, titles, invert=False):
r = self.session.post(self.api_endpoint, data={
"action":"query",
"format":"json",
"titles":"|".join(titles),
"prop":"info",
"assert":self.assertion,
})
response = json.loads(r.text)
page_list = response["query"]["pages"]
result = []
for id in page_list:
if int(id) > 0 and not invert:
result += [page_list[id]["title"]]
elif int(id) < 0 and invert:
result += [page_list[id]["title"]]
return result
"""
Delete some pages
TODO: Check rights and raise an error if needed
"""
def delete(self, titles, reason):
if isinstance(titles, basestring):
titles = [titles]
data = {
"action":"delete",
"format":"json",
"reason":reason,
}
for title in titles:
data["title"] = title
data["token"] = self.get_csrf_token()
r = self.session.post(self.api_endpoint, data=data)
"""
Move some pages
TODO: Raise an error when len(old_titles) != len(new_titles)
TODO: Check rights and raise an error if needed
"""
def move(self, old_titles, new_titles, reason, no_redirect=False, move_talk=False, ignore_warnings=False):
if isinstance(old_titles, basestring):
old_titles = [old_titles]
if isinstance(new_titles, basestring):
new_titles = [new_titles]
data = {
"action":"move",
"format":"json",
"reason":reason,
}
if no_redirect:
data["noredirect"] = "1"
if move_talk:
data["movetalk"] = "1"
if ignore_warnings:
data["ignorewarnings"] = "1"
for i in xrange(len(old_titles)):
data["from"] = old_titles[i]
data["to"] = new_titles[i]
data["token"] = self.get_csrf_token()
r = self.session.post(self.api_endpoint, data=data)
def get_content(self, title):
response = self.request({
"action":"query",
"format":"json",
"prop":"revisions",
"titles":title,
"rvprop":"content",
"rvlimit":"1",
"assert":self.assertion,
})["query"]["pages"]
return response[response.keys()[0]]["revisions"][0]["*"]
def get_content_list(self, titles):
if isinstance(titles, basestring):
titles = [titles]
result = []
while titles:
response = self.request({
"action":"query",
"format":"json",
"prop":"revisions",
"titles":"|".join(titles[:self.limit]),
"rvprop":"content",
"assert":self.assertion,
})["query"]["pages"]
for id in response:
result += [[response[id]["title"], response[id]["revisions"][0]["*"]]]
titles = titles[self.limit:]
return result
def upload(self, filename, path, text, summary=""):
response = self.request({
"action": "upload",
"format": "json",
"filename": filename,
"comment": summary,
"text": text,
"token": self.get_csrf_token(),
},
{
"file": open(path, 'rb')
})
"""
def chuncked_upload(self, ):
def url_upload(self, ):
{
"action": "upload",
"format": "json",
"filename": "Image.jpg",
"comment": "upload via pywiki.py",
"text": "Text de la page",
"url": "http://images1.bonhams.com/image?src=Images/live/2016-11/21/24068865-4-1.jpg&tile=1:1",
"token": "14c0e81166da6b3d6f805c113ab4f04658a846cd+\\"
}
"""