forked from Charcoal-SE/SmokeDetector
-
Notifications
You must be signed in to change notification settings - Fork 0
/
datahandling.py
687 lines (545 loc) · 24 KB
/
datahandling.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
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
# coding=utf-8
import os
import pickle
import sys
import zlib
import base64
from datetime import datetime
import metasmoke
import requests
import json
import time
import math
# noinspection PyCompatibility
import regex
from parsing import api_parameter_from_link, post_id_from_link
from globalvars import GlobalVars
import blacklists
from helpers import ErrorLogs, log, log_exception, redact_passwords
last_feedbacked = None
PICKLE_STORAGE = "pickles/"
queue_timings_data = list()
FLUSH_TIMINGS_THRES = 128
class Any:
def __eq__(self, _):
return True
def _save_problem_pickle(path):
# Keep the most recent copy of a pickle file which had an error.
errorpath = path + '-error'
if os.path.isfile(errorpath):
os.remove(errorpath)
if os.path.isfile(path):
os.rename(path, errorpath)
def load_pickle(path, encoding='utf-8'):
newpath = os.path.join(PICKLE_STORAGE, path)
if os.path.isfile(newpath):
path = newpath
try:
with open(path, mode="rb") as f:
return pickle.load(f, encoding=encoding)
except UnicodeDecodeError:
_save_problem_pickle(path)
if "apicalls" in path.lower():
return {}
if "bodyfetcher" in path.lower():
return {}
except EOFError:
_save_problem_pickle(path)
raise
except pickle.UnpicklingError as err:
if 'pickle data was truncated' in str(err).lower():
_save_problem_pickle(path)
raise
def dump_pickle(path, item, protocol=pickle.HIGHEST_PROTOCOL):
if not os.path.isdir(PICKLE_STORAGE):
os.mkdir(PICKLE_STORAGE)
if os.path.isfile(path): # Remove old one
os.remove(path)
newpath = os.path.join(PICKLE_STORAGE, path)
with open(newpath, "wb") as f:
pickle.dump(item, f, protocol=protocol)
def remove_pickle(path):
try:
os.remove(path)
except OSError:
pass
path = os.path.join(PICKLE_STORAGE, path)
try:
os.remove(path)
except OSError:
pass
def has_pickle(path):
newpath = os.path.join(PICKLE_STORAGE, path)
return os.path.isfile(newpath) or os.path.isfile(path)
# methods to load files and filter data in them:
# load_blacklists() is defined in a separate module blacklists.py, though
def load_files():
if has_pickle("falsePositives.p"):
GlobalVars.false_positives = load_pickle("falsePositives.p", encoding='utf-8')
if has_pickle("whitelistedUsers.p"):
GlobalVars.whitelisted_users = load_pickle("whitelistedUsers.p", encoding='utf-8')
if not isinstance(GlobalVars.whitelisted_users, set):
GlobalVars.whitelisted_users = set(GlobalVars.whitelisted_users)
if has_pickle("blacklistedUsers.p"):
GlobalVars.blacklisted_users = load_pickle("blacklistedUsers.p", encoding='utf-8')
if not isinstance(GlobalVars.blacklisted_users, dict):
GlobalVars.blacklisted_users = {data[0]: data[1:] for data in GlobalVars.blacklisted_users}
if has_pickle("ignoredPosts.p"):
GlobalVars.ignored_posts = load_pickle("ignoredPosts.p", encoding='utf-8')
if has_pickle("autoIgnoredPosts.p"):
GlobalVars.auto_ignored_posts = load_pickle("autoIgnoredPosts.p", encoding='utf-8')
if has_pickle("notifications.p"):
GlobalVars.notifications = load_pickle("notifications.p", encoding='utf-8')
if has_pickle("whyData.p"):
GlobalVars.why_data = load_pickle("whyData.p", encoding='utf-8')
# Switch from apiCalls.pickle to apiCalls.p
# Correction was on 2020-11-02. Handling the apiCalls.pickle file should be able to be removed shortly thereafter.
if has_pickle("apiCalls.pickle"):
GlobalVars.api_calls_per_site = load_pickle("apiCalls.pickle", encoding='utf-8')
# Remove the incorrectly named pickle file.
remove_pickle("apiCalls.pickle")
# Put the pickle in the "correct" file, from which it will be immediately reloaded.
dump_pickle("apiCalls.p", GlobalVars.api_calls_per_site)
if has_pickle("apiCalls.p"):
GlobalVars.api_calls_per_site = load_pickle("apiCalls.p", encoding='utf-8')
if has_pickle("bodyfetcherQueue.p"):
GlobalVars.bodyfetcher.queue = load_pickle("bodyfetcherQueue.p", encoding='utf-8')
if has_pickle("bodyfetcherMaxIds.p"):
GlobalVars.bodyfetcher.previous_max_ids = load_pickle("bodyfetcherMaxIds.p", encoding='utf-8')
if has_pickle("codePrivileges.p"):
GlobalVars.code_privileged_users = load_pickle("codePrivileges.p", encoding='utf-8')
if has_pickle("reasonWeights.p"):
GlobalVars.reason_weights = load_pickle("reasonWeights.p", encoding='utf-8')
if has_pickle("cookies.p"):
GlobalVars.cookies = load_pickle("cookies.p", encoding='utf-8')
if has_pickle("metasmokePostIds.p"):
GlobalVars.metasmoke_ids = load_pickle("metasmokePostIds.p", encoding='utf-8')
blacklists.load_blacklists()
def filter_auto_ignored_posts():
today_date = datetime.today()
to_remove = []
for aip in GlobalVars.auto_ignored_posts:
day_ignored = aip[2]
day_diff = (today_date - day_ignored).days
if day_diff > 7:
to_remove.append(aip)
for tr in to_remove:
GlobalVars.auto_ignored_posts.remove(tr)
dump_pickle("autoIgnoredPosts.p", GlobalVars.auto_ignored_posts)
# methods to check whether a post/user is whitelisted/blacklisted/...
# noinspection PyMissingTypeHints
def is_false_positive(postid_site_tuple):
return postid_site_tuple in GlobalVars.false_positives
# noinspection PyMissingTypeHints
def is_whitelisted_user(user):
return user in GlobalVars.whitelisted_users
# noinspection PyMissingTypeHints
def is_blacklisted_user(user):
return user in GlobalVars.blacklisted_users
def get_blacklisted_user_data(user):
try:
return (user,) + tuple(GlobalVars.blacklisted_users[user])
except KeyError:
return ()
# noinspection PyMissingTypeHints
def is_ignored_post(postid_site_tuple):
return postid_site_tuple in GlobalVars.ignored_posts
# noinspection PyMissingTypeHints
def is_auto_ignored_post(postid_site_tuple):
for p in GlobalVars.auto_ignored_posts:
if p[0] == postid_site_tuple[0] and p[1] == postid_site_tuple[1]:
return True
return False
def update_code_privileged_users_list():
metasmoke.Metasmoke.update_code_privileged_users_list()
# GlobalVars.code_privileged_users can now be a set, or may still be None.
if GlobalVars.code_privileged_users is None:
if len(GlobalVars.config_blacklisters) > 0:
# Only change away from None if there are pre-configured blacklisters
GlobalVars.code_privileged_users = set(GlobalVars.config_blacklisters)
else:
# Add the users in the config file, if any
GlobalVars.code_privileged_users.update(GlobalVars.config_blacklisters)
dump_pickle("codePrivileges.p", GlobalVars.code_privileged_users)
def is_code_privileged(site, user_id):
if GlobalVars.code_privileged_users is None:
update_code_privileged_users_list()
try:
# For now, disable the moderator override on code/blacklist changes
return (site, user_id) in GlobalVars.code_privileged_users
except TypeError:
return False
def update_reason_weights():
d = {'last_updated': datetime.utcnow().date()}
items = metasmoke.Metasmoke.get_reason_weights()
if not items:
return # No update
for item in items:
d[item['reason_name'].lower()] = item['weight']
GlobalVars.reason_weights = d
dump_pickle("reasonWeights.p", GlobalVars.reason_weights)
def resolve_ms_link(post_url):
identifier = (api_parameter_from_link(post_url), post_id_from_link(post_url))
if identifier in GlobalVars.metasmoke_ids:
if isinstance(GlobalVars.metasmoke_ids[identifier], int):
ms_url = (GlobalVars.metasmoke_host.rstrip("/") + "/post/{}").format(
GlobalVars.metasmoke_ids[identifier])
return ms_url
else:
del GlobalVars.metasmoke_ids[identifier]
ms_posts = metasmoke.Metasmoke.get_post_bodies_from_ms(post_url)
if not ms_posts: # Empty
ms_post_id = None
ms_url = None
else:
ms_post_id = max([post['id'] for post in ms_posts])
ms_url = (GlobalVars.metasmoke_host.rstrip("/") + "/post/{}").format(ms_post_id)
GlobalVars.metasmoke_ids[identifier] = ms_post_id # Store numeric IDs, strings are hard to handle
dump_pickle("metasmokePostIds.p", GlobalVars.metasmoke_ids)
return ms_url
# methods to add/remove whitelisted/blacklisted users, ignored posts, ...
# noinspection PyMissingTypeHints
def add_whitelisted_user(user):
if user in GlobalVars.whitelisted_users or user is None:
return
GlobalVars.whitelisted_users.add(user)
dump_pickle("whitelistedUsers.p", GlobalVars.whitelisted_users)
def add_blacklisted_user(user, message_url, post_url):
if is_blacklisted_user(user) or user is None:
return
GlobalVars.blacklisted_users[user] = (message_url, post_url)
dump_pickle("blacklistedUsers.p", GlobalVars.blacklisted_users)
def add_auto_ignored_post(postid_site_tuple):
if postid_site_tuple is None or is_auto_ignored_post(postid_site_tuple):
return
GlobalVars.auto_ignored_posts.append(postid_site_tuple)
dump_pickle("autoIgnoredPosts.p", GlobalVars.auto_ignored_posts)
def add_false_positive(site_post_id_tuple):
if site_post_id_tuple is None or site_post_id_tuple in GlobalVars.false_positives:
return
GlobalVars.false_positives.append(site_post_id_tuple)
dump_pickle("falsePositives.p", GlobalVars.false_positives)
global last_feedbacked
last_feedbacked = (site_post_id_tuple, time.time() + 60)
# noinspection PyMissingTypeHints
def add_ignored_post(postid_site_tuple):
if postid_site_tuple is None or postid_site_tuple in GlobalVars.ignored_posts:
return
GlobalVars.ignored_posts.append(postid_site_tuple)
dump_pickle("ignoredPosts.p", GlobalVars.ignored_posts)
global last_feedbacked
last_feedbacked = (postid_site_tuple, time.time() + 60)
def remove_blacklisted_user(user):
blacklisted_user_data = get_blacklisted_user_data(user)
if not blacklisted_user_data:
return False
GlobalVars.blacklisted_users.pop(blacklisted_user_data[0])
dump_pickle("blacklistedUsers.p", GlobalVars.blacklisted_users)
return True
# noinspection PyMissingTypeHints
def remove_whitelisted_user(user):
if user not in GlobalVars.whitelisted_users:
return False
GlobalVars.whitelisted_users.remove(user)
dump_pickle("whitelistedUsers.p", GlobalVars.whitelisted_users)
return True
def add_why(site, post_id, why):
key = site + "/" + str(post_id)
why_data_tuple = (key, why)
GlobalVars.why_data.append(why_data_tuple)
filter_why()
dump_pickle("whyData.p", GlobalVars.why_data)
def get_why(site, post_id):
key = site + "/" + str(post_id)
for post in GlobalVars.why_data:
if post[0] == key:
return post[1]
return None
def filter_why(max_size=50):
GlobalVars.why_data = GlobalVars.why_data[-max_size:]
def add_post_site_id_link(post_site_id, question_id):
GlobalVars.post_site_id_to_question[post_site_id] = question_id
def get_post_site_id_link(post_site_id):
if post_site_id in GlobalVars.post_site_id_to_question:
return GlobalVars.post_site_id_to_question[post_site_id]
return None
def add_or_update_api_data(site):
if site in GlobalVars.api_calls_per_site:
GlobalVars.api_calls_per_site[site] += 1
else:
GlobalVars.api_calls_per_site[site] = 1
dump_pickle("apiCalls.p", GlobalVars.api_calls_per_site)
def clear_api_data():
GlobalVars.api_calls_per_site = {}
dump_pickle("apiCalls.p", GlobalVars.api_calls_per_site)
def store_bodyfetcher_queue():
dump_pickle("bodyfetcherQueue.p", GlobalVars.bodyfetcher.queue)
def store_bodyfetcher_max_ids():
dump_pickle("bodyfetcherMaxIds.p", GlobalVars.bodyfetcher.previous_max_ids)
def add_queue_timing_data(site, time_in_queue):
global queue_timings_data
queue_timings_data.append("{} {}".format(site, time_in_queue))
# time_in_queue comes first as it is an integer
# and hence won't contain any whitespace or trailing ones
if len(queue_timings_data) >= FLUSH_TIMINGS_THRES:
actually_add_queue_timings_data()
queue_timings_data = list()
def actually_add_queue_timings_data():
# Use .txt for cross platform compatibility
with open("pickles/bodyfetcherQueueTimings.txt", mode="a", encoding="utf-8") as stat_file:
stat_file.write("\n".join(queue_timings_data) + "\n")
# methods that help avoiding reposting alerts:
def append_to_latest_questions(host, post_id, title):
GlobalVars.latest_questions.insert(0, (host, str(post_id), title))
if len(GlobalVars.latest_questions) > 50:
GlobalVars.latest_questions.pop()
# noinspection PyMissingTypeHints
def has_already_been_posted(host, post_id, title):
for post in GlobalVars.latest_questions:
if post[0] == host and post[1] == str(post_id):
return True
return False
# method to get data from the error log:
# noinspection PyUnusedLocal
def fetch_lines_from_error_log(count):
if not os.path.isfile("errorLogs.db"):
return "The error log database does not exist."
if count <= 0:
return "Please request an exception count greater than zero."
logs = ErrorLogs.fetch_last(count)
s = '\n'.join([
"### {2} on {0} at {1}Z: {3}\n{4}".format(
GlobalVars.location, datetime.utcfromtimestamp(time).isoformat()[:-7],
name, message, tb)
for time, name, message, tb in logs])
if s:
return redact_passwords(s)
else:
return "The fetched log is empty."
# method to check whether a SE site exists:
# noinspection PyMissingTypeHints
def refresh_sites():
has_more = True
page = 1
url = "https://api.stackexchange.com/2.2/sites"
while has_more:
params = {
'filter': '!)Qpa1bTB_jCkeaZsqiQ8pDwI',
'key': 'IAkbitmze4B8KpacUfLqkw((',
'page': page,
'pagesize': 500
}
response = requests.get(url, params=params)
data = response.json()
if "error_message" in data:
return False, data["error_message"]
if "items" not in data:
return False, "`items` not in JSON data"
if "has_more" not in data:
return False, "`has_more` not in JSON data"
GlobalVars.se_sites.extend(data["items"])
has_more = data["has_more"]
page += 1
return True, "OK"
# noinspection PyMissingTypeHints
def check_site_and_get_full_name(site):
if len(GlobalVars.se_sites) == 0:
refreshed, msg = refresh_sites()
if not refreshed:
return False, "Could not fetch sites: " + msg
for item in GlobalVars.se_sites:
full_name = regex.sub(r'https?://', '', item['site_url'])
short_name = item["api_site_parameter"]
if site == full_name or site == short_name:
return True, full_name
return False, "Could not find the given site."
# methods to add/remove/check users on the "notification" list
# (that is, being pinged when Smokey reports something on a specific site)
# noinspection PyMissingTypeHints
def add_to_notification_list(user_id, chat_site, room_id, se_site, always_ping=True):
if se_site[0] != "/":
exists, se_site = check_site_and_get_full_name(se_site)
if not exists:
return -2, None
notification_tuple = (int(user_id), chat_site, int(room_id), se_site, Any())
if notification_tuple in GlobalVars.notifications:
return -1, None
GlobalVars.notifications.append((int(user_id), chat_site, int(room_id), se_site, always_ping))
dump_pickle("notifications.p", GlobalVars.notifications)
return 0, se_site
# noinspection PyMissingTypeHints
def remove_from_notification_list(user_id, chat_site, room_id, se_site):
if se_site[0] != "/":
exists, se_site = check_site_and_get_full_name(se_site)
if not exists:
return False
notification_tuple = (int(user_id), chat_site, int(room_id), se_site, Any())
if notification_tuple not in GlobalVars.notifications:
return False
GlobalVars.notifications.remove(notification_tuple)
dump_pickle("notifications.p", GlobalVars.notifications)
return True
# noinspection PyMissingTypeHints
def will_i_be_notified(user_id, chat_site, room_id, se_site):
exists, site = check_site_and_get_full_name(se_site)
if not exists:
return False
notification_tuple = (int(user_id), chat_site, int(room_id), site, Any())
return notification_tuple in GlobalVars.notifications
# noinspection PyMissingTypeHints
def remove_all_from_notification_list(user_id):
user_id = int(user_id)
my_notifications = []
for notification in GlobalVars.notifications:
if notification[0] == user_id:
my_notifications.append(notification[:4])
for notification in my_notifications:
remove_from_notification_list(*notification)
def get_all_notification_sites(user_id, chat_site, room_id):
sites = []
for notification in GlobalVars.notifications:
if notification[0] == int(user_id) and notification[1] == chat_site and notification[2] == int(room_id):
sites.append(notification[3])
return sorted(sites)
def get_user_ids_on_notification_list(chat_site, room_id, se_site):
uids = []
for notification in GlobalVars.notifications:
if notification[1] == chat_site and notification[2] == int(room_id) and notification[3] == se_site:
uids.append((notification[0], notification[4]))
return uids
def get_user_names_on_notification_list(chat_site, room_id, se_site, client):
names = []
try:
current_users = client._br.get_current_users_in_room(room_id)
except Exception:
# ChatExchange had a problem getting the current users. This shouldn't be allowed to
# cause us to crash, as it's on the path we take for going into standby.
# It should be noted that this *could* be caused by a discontinuity between room_id and
# client.
log_exception(*sys.exc_info())
log('warn', 'ChatExchange failed to get current users. See Error log for more details. Tried '
'client.host: {}:: room: {}:: passed chat_site: {}'.format(client.host, room_id, chat_site))
current_users = []
for i, always in get_user_ids_on_notification_list(chat_site, room_id, se_site):
if always:
names.append(client.get_user(i).name)
else:
try:
names.append(current_users[current_users.index((i, Any()))][1])
except ValueError: # user not in room
pass
return names
# noinspection PyMissingTypeHints
def append_pings(original_message, names):
if len(names) != 0:
new_message = u"{0} ({1})".format(original_message, " ".join("@" + x.replace(" ", "") for x in names))
if len(new_message) <= 500:
return new_message
return original_message
# method to check if a post has been bumped by Community
def has_community_bumped_post(post_url, post_content):
try:
ms_posts = metasmoke.Metasmoke.get_post_bodies_from_ms(post_url)
if not ms_posts:
return False
return any(post['body'] == post_content for post in ms_posts)
except (requests.exceptions.ConnectionError, ValueError):
return False # MS is down, so assume it is not bumped
# methods to check if someone waited long enough to use another !!/report with multiple URLs
# (to avoid SmokeDetector's chat messages to be rate-limited too much)
def add_or_update_multiple_reporter(user_id, chat_host, time_integer):
user_id = str(user_id)
for i in range(len(GlobalVars.multiple_reporters)):
if GlobalVars.multiple_reporters[i][0] == user_id and GlobalVars.multiple_reporters[i][1] == chat_host:
GlobalVars.multiple_reporters[i] = (GlobalVars.multiple_reporters[i][0],
GlobalVars.multiple_reporters[i][1], time_integer)
return 1
GlobalVars.multiple_reporters.append((user_id, chat_host, time_integer))
def can_report_now(user_id, chat_host):
user_id = str(user_id)
for reporter in GlobalVars.multiple_reporters:
if reporter[0] == user_id and reporter[1] == chat_host:
now = time.time()
latest_report = reporter[2]
can_report_again = latest_report + 30
if now > can_report_again:
return True, True
return False, math.ceil(can_report_again - now)
return True, True
def dump_cookies():
dump_pickle("cookies.p", GlobalVars.cookies)
class SmokeyTransfer:
HEADER = "-----BEGIN SMOKEY DATA BLOCK-----"
ENDING = "-----END SMOKEY DATA BLOCK-----"
ITEMS = [
# (dict_key, object, attr, type, post_processing)
('blacklisted_users', GlobalVars, 'blacklisted_users', None, None),
('whitelisted_users', GlobalVars, 'whitelisted_users', None, None),
('ignored_posts', GlobalVars, 'ignored_posts', None, None),
('notifications', GlobalVars, 'notifications', None, None),
]
@classmethod
def dump(cls):
# Trust Python's GIL here
data = {'_metadata': {
'time': time.time(),
'location': GlobalVars.location,
'rev': GlobalVars.commit.id_full,
'lengths': {}, # can be used for validation
}} # some metadata, in case they're useful
for item_info in cls.ITEMS:
key, obj, attr, obj_type, _ = item_info
item = getattr(obj, attr)
data[key] = item
try:
length = len(item)
except TypeError:
length = None # len() is inapplicable
data['_metadata']['lengths'][key] = length
# hopefully the pickle won't be more than a few MiB
raw_data = pickle.dumps(data, protocol=pickle.HIGHEST_PROTOCOL)
# let's save some traffic
z_data = zlib.compress(raw_data, 9)
# need to transfer via chat, so text only
b64_s = base64.b64encode(z_data).decode('ascii')
chunk_size = 64 # The same value as GnuPG armored output
s = "{}\n\n{}\n\n{}".format(
cls.HEADER,
'\n'.join([b64_s[i:i + chunk_size] for i in range(0, len(b64_s), chunk_size)]),
cls.ENDING)
return s, data['_metadata']
@classmethod
def load(cls, s, merge=False):
try:
# While it generates a blank line after the header and before the ending,
# it should also accept data that does not contain the blank lines
lbound, rbound = s.index(cls.HEADER + "\n"), s.rindex("\n" + cls.ENDING)
s = s[lbound + len(cls.HEADER):rbound].strip()
except ValueError:
raise ValueError("Invalid data (invalid header or ending)")
s = ''.join(s.split()) # Clear whitespaces
try:
z_data = base64.b64decode(s.encode('ascii'))
raw_data = zlib.decompress(z_data)
data = pickle.loads(raw_data, encoding='utf-8')
if type(data) is not dict:
raise ValueError("Invalid data (data type is not dict)")
# happy extracting
warnings = []
for item_info in cls.ITEMS:
key, obj, attr, obj_type, proc = item_info
if key not in data:
continue # Allow partial transfer
item = data[key]
try:
length = len(item)
except TypeError:
length = None
if length != data['_metadata']['lengths'][key]:
warnings.append("Length of {!r} mismatch (recorded {}, actual {})".format(
key, data['_metadata']['lengths'][key], length))
setattr(obj, attr, item)
if warnings:
raise Warning("Warning: " + ', '.join(warnings))
except (ValueError, zlib.error) as e:
raise ValueError(str(e)) from None