-
Notifications
You must be signed in to change notification settings - Fork 0
/
pwic_lib.py
1085 lines (988 loc) · 48.6 KB
/
pwic_lib.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
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
# Pwic.wiki server running on Python and SQLite
# Copyright (C) 2020-2024 Alexandre Bréard
#
# https://pwic.wiki
# https://github.com/gitbra/pwic
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
from typing import Any, Dict, List, Optional, Tuple, Union
import sqlite3
import re
from collections import namedtuple, OrderedDict
from datetime import datetime, timedelta
from time import time
from os import urandom
from os.path import splitext
from hashlib import sha256
from base64 import b64encode
from string import ascii_lowercase, ascii_uppercase
from aiohttp import web
TyEnv = namedtuple('TyEnv', 'pindep, pdep, online, private')
TyMime = namedtuple('TyMime', 'exts, mimes, magic, compressed')
TyRobotsDict = Dict[str, Optional[bool]]
CFBF = ['\xD0\xCF\x11\xE0\xA1\xB1\x1A\xE1']
MATROSKA = ['\x1A\x45\xDF\xA3']
XML = ['<']
ZIP = ['PK']
class PwicConst:
''' Constants used by Pwic.wiki '''
# ========
# System
# ========
VERSION = '1.1'
DB = './db'
DB_SQLITE = DB + '/pwic.sqlite'
DB_SQLITE_BACKUP = DB + '/pwic_%s.sqlite'
DB_SQLITE_AUDIT = DB + '/pwic_audit.sqlite'
DOCUMENTS_PATH = DB + '/documents/%s/'
LOCALE_PATH = './locale/'
TEMPLATES_PATH = './templates/'
BOOL_COLUMNS = ['admin', 'manager', 'editor', 'validator', 'reader', 'disabled', # roles
'initial', # users
'latest', 'draft', 'final', 'header', 'protection'] # pages
# ==========
# Security
# ==========
SALT = '' # Random string to secure the generated hashes for the passwords
PRIVATE_KEY = 'db/pwic_https.key'
PUBLIC_KEY = 'db/pwic_https.crt'
CHARS_UNSAFE = '\\/:;%*?=&#\'"!<>(){}[]|' # Various signs incompatible with filesystem, HTML, SQL...
MAGIC_OAUTH = 'OAuth'
NOT_PROJECT = ['', 'admin', 'api', 'bugs', 'issues', 'special', 'static', 'tracker']
NOT_PAGE = ['', 'special']
# ========
# Packed
# ========
USERS = {'anonymous': 'pwic_anonymous', # Account for the random visitors
'ghost': 'pwic_ghost', # Account for the deleted users (not implemented)
'system': 'pwic_system'} # Account for the technical operations
DEFAULTS = {'dt_mask': '%Y-%m-%d %H:%M:%S', # Fixed format of the datetime
'heading': '1.1.1.1.1.1.', # Default format of the paragraphs
'kb_mask': 'kb%06d', # Format for the KB pages
'language': 'en', # Default language-dependent template for the UI
'limit_filename': '128', # Max length for the file names
'limit_field': '2048', # Max length for the submitted inline strings
'logging_format': '%a %t "%r" %s %b', # HTTP log format
'odt_img_defpix': '150', # Unknown size of a picture for the export to ODT
'page': 'home', # Root page of every project
'password': 'initial', # Default password for the new accounts
'port': '8080', # Default HTTP port
}
REGEXES = {'document': re.compile(r'\]\(\/special\/document\/([0-9]+)(\)|\/|\#|\?| ")'), # Find a document in Markdown
'document_imgsrc': re.compile(r'^\/?special\/document\/([0-9]+)([\#\?].*)?$'), # Find the picture ID in IMG.SRC
'empty_tag': re.compile(r'<\b(\w+)\b(?<!table)\b(?<!tr|th|td)><\/\1>', re.IGNORECASE), # Removable blank HTML tags, except table elements
'empty_tag_with_attrs': re.compile(r'<(\w+(?<!th|td))(\s+\w+="?\w+"?)*>(\s*)<\/\1>', re.IGNORECASE), # Removable blank HTML tags, except table elements
'adjacent_tag': re.compile(r'<\/(b|big|em|i|small|span|strong|sub|sup)[ \t]*>([ \t]*)<\1[ \t]*>', re.IGNORECASE), # Removable adjacent inline HTML tags
'kb_mask': re.compile(r'^kb[0-9]{6}$'), # Name of the pages KB
'length': re.compile(r'^(\d+(.\d*)?)(cm|mm|in|pt|pc|px|em)?$'), # Length in XML
'mime': re.compile(r'^[a-z]+\/[a-z0-9\.\+\-]+$', re.IGNORECASE), # Check the format of the mime
'page': re.compile(r'\]\((\.|\/[^\/\#\?\)"]+)\/([^\/\#\?\)"]+)(\/rev[0-9]+)?(\#|\?|\)| ")'), # Find a page in Markdown
'protocol': re.compile(r'^https?:\/\/', re.IGNORECASE), # Valid protocols for the links
'search_terms': re.compile(r'(-?)("[^"\n]+"|[^ \n]+)[\t ]*', re.IGNORECASE), # Split the search terms
'tag_name': re.compile(r'<\/?([a-z]+)[ >]', re.IGNORECASE), # Find the HTML tags
'tag_all': re.compile(r'<\/?\w+( [^>]+)?>', re.IGNORECASE), # Tag in HTML
'tag_comment': re.compile(r'<!--.*-->', re.IGNORECASE), # Comment in HTML
}
# =========
# Options
# =========
ENV = {'api_cors': TyEnv(True, False, False, False),
'api_expose_markdown': TyEnv(True, True, False, False),
'audit_range': TyEnv(True, True, True, False),
'auto_join': TyEnv(False, True, True, False),
'base_url': TyEnv(True, False, False, False),
'client_size_max': TyEnv(True, False, False, False),
'compressed_cache': TyEnv(True, False, False, False),
'css': TyEnv(True, True, False, False),
'css_dark': TyEnv(True, True, False, False),
'css_printing': TyEnv(True, True, False, False),
'dark_theme': TyEnv(True, True, True, False),
'db_async': TyEnv(True, False, False, False),
'document_name_regex': TyEnv(True, True, False, False),
'document_pixels_max': TyEnv(True, True, True, False),
'document_size_max': TyEnv(True, True, False, False),
'edit_time_min': TyEnv(True, True, False, False),
'emojis': TyEnv(True, True, True, False),
'export_project_revisions': TyEnv(True, True, False, False),
'feed_size': TyEnv(True, True, True, False),
'file_formats_disabled': TyEnv(True, True, True, False),
'fixed_templates': TyEnv(True, False, False, False),
'heading_mask': TyEnv(True, True, True, False),
'http_log_file': TyEnv(True, False, False, False),
'http_log_format': TyEnv(True, False, False, False),
'http_referer': TyEnv(True, False, False, False),
'https': TyEnv(True, False, False, False),
'ip_filter': TyEnv(True, False, False, False),
'kbid': TyEnv(True, True, False, False),
'keep_drafts': TyEnv(True, True, True, False),
'keep_sessions': TyEnv(True, False, False, False),
'language': TyEnv(True, True, True, False),
'legal_notice': TyEnv(True, True, False, False),
'link_new_tab': TyEnv(True, True, True, False),
'link_nofollow': TyEnv(True, True, True, False),
'magic_bytes': TyEnv(True, False, False, False),
'maintenance': TyEnv(True, False, False, False),
'mathjax': TyEnv(True, True, True, False),
'mde': TyEnv(True, True, True, False),
'message': TyEnv(True, True, True, False),
'no_cache': TyEnv(True, True, False, False),
'no_copy_code': TyEnv(True, True, True, False),
'no_document_conversion': TyEnv(True, True, True, False),
'no_export_project': TyEnv(True, True, False, False),
'no_feed': TyEnv(True, True, True, False),
'no_graph': TyEnv(True, True, True, False),
'no_heading': TyEnv(True, True, True, False),
'no_help': TyEnv(True, True, True, False),
'no_highlight': TyEnv(True, False, False, False),
'no_history': TyEnv(True, True, True, False),
'no_link_review': TyEnv(True, True, True, False),
'no_login': TyEnv(True, False, False, False),
'no_new_user': TyEnv(True, True, False, False),
'no_printing': TyEnv(True, True, True, False),
'no_search': TyEnv(True, True, True, False),
'no_sitemap': TyEnv(True, True, True, False),
'no_sort_table': TyEnv(True, True, True, False),
'no_space_page': TyEnv(True, True, True, False),
'no_table_csv': TyEnv(True, True, True, False),
'no_text_selection': TyEnv(True, True, True, False),
'oauth_domains': TyEnv(True, False, False, False),
'oauth_identifier': TyEnv(True, False, False, False),
'oauth_provider': TyEnv(True, False, False, False),
'oauth_secret': TyEnv(True, False, False, True),
'oauth_tenant': TyEnv(True, False, False, False),
'odata': TyEnv(True, False, False, False),
'odt_image_height_max': TyEnv(True, True, True, False),
'odt_image_width_max': TyEnv(True, True, True, False),
'odt_page_height': TyEnv(True, True, True, False),
'odt_page_landscape': TyEnv(True, True, True, False),
'odt_page_margin': TyEnv(True, True, True, False),
'odt_page_width': TyEnv(True, True, True, False),
'page_count_max': TyEnv(True, True, False, False),
'password_regex': TyEnv(True, False, False, False),
'project_size_max': TyEnv(True, True, False, False),
'pwic_audit_id': TyEnv(True, False, False, True),
'pwic_session': TyEnv(True, False, False, True),
'quick_fix': TyEnv(True, True, True, False),
'registration_link': TyEnv(True, False, False, False),
'revision_count_max': TyEnv(True, True, False, False),
'revision_size_max': TyEnv(True, True, False, False),
'robots': TyEnv(True, True, False, False),
'rstrip': TyEnv(True, True, True, False),
'seo_hide_revs': TyEnv(True, True, False, False),
'session_expiry': TyEnv(True, False, False, False),
'show_members_max': TyEnv(True, True, True, False),
'skipped_tags': TyEnv(True, True, False, False),
'strict_cookies': TyEnv(True, False, False, False),
'support_email': TyEnv(True, True, True, False),
'support_phone': TyEnv(True, True, True, False),
'support_text': TyEnv(True, True, True, False),
'support_url': TyEnv(True, True, True, False),
'title': TyEnv(True, True, True, False),
'totp': TyEnv(True, False, False, False),
'validated_only': TyEnv(True, True, True, False),
'zip_no_exec': TyEnv(True, True, False, False),
}
# ===============
# Miscellaneous
# ===============
DPI = 120. # Pixels per inch
RTL = ['ar', 'fa', 'he'] # RTL languages
VOID_HTML = ['area', 'base', 'br', 'col', 'embed',
'hr', 'img', 'input', 'link', 'meta',
'source', 'track', 'wbr'] # Self-closing HTML tags
# ========
# Emojis
# ========
EMOJIS = {'alien': '👽',
'atom': '⚛️',
'bang': '💥',
'brick': '🧱',
'calendar': '📅',
'camera': '🎥', # 1F4F9
'chains': '🔗',
'check': '✔️',
'clamp': '🗜️',
'clock': '⏰',
'cloud': '☁️',
'curved_left_arrow': '↩️',
'dice': '🎲',
'door': '🚪',
'double': '⚋',
'eye': '👁️',
'finger_left': '👈',
'finger_up': '☝️',
'flag': '🏁',
'gemini': '♊',
'glasses': '👓',
'globe': '🌐',
'green_check': '✅',
'hammer': '🔨',
'headphone': '🎧',
'help': '📚',
'home': '🏠',
'hourglass': '⏳',
'id': '🆔',
'image': '🖼️',
'inbox': '📥',
'key': '🔑',
'laptop': '💻',
'left': '≪',
'locked': '🔒',
'map': '🗺️',
'noblank': '⋛',
'notes': '📋',
'oneline': '⪥',
'outbox': '📤',
'padlock': '🔐',
'paperclip': '📎',
'pill': '💊',
'pin': '📌',
'plug': '🔌',
'plus': '➕',
'printer': '🖨️',
'recycle': '♻️',
'red_check': '❌',
'refresh': '🔄',
'right': '≫',
'rss': '🔊',
'save': '💾',
'scroll': '📜',
'search': '🔍',
'server': '🖥️',
'set_square': '📐',
'sheet': '📄',
'slot': '🎰',
'sparkles': '✨',
'star': '⭐',
'top': '🔝',
'trashcan': '🗑️',
'truck': '🚚',
'unlocked': '🔓',
'updown': '🔃',
'users': '👥',
'validate': '👌',
'warning': '⚠️',
'watch': '⌚',
}
# =======
# Mimes
# https://www.iana.org/assignments/media-types/media-types.xhtml
# ./pa show-mime
# =======
MIMES = [TyMime([''], ['application/octet-stream'], None, False),
TyMime(['7z'], ['application/x-7z-compressed'], ['7z'], True),
TyMime(['aac'], ['audio/vnd.dlna.adts'], None, True),
TyMime(['abw'], ['application/x-abiword'], None, False),
TyMime(['accdb'], ['application/msaccess'], ['\x00\x01\x00\x00Standard ACE DB'], False), # NUL SOH NUL NUL
TyMime(['aif', 'aifc', 'aiff'], ['audio/aiff', 'audio/x-aiff'], ['AIFF', 'FORM'], True),
TyMime(['apk'], ['application/vnd.android.package-archive'], ZIP, True),
TyMime(['atom'], ['application/atom+xml'], XML, True),
TyMime(['avi'], ['video/avi', 'video/x-msvideo'], ['AVI', 'RIFF'], True),
TyMime(['avif'], ['image/avif'], None, True),
TyMime(['bin'], ['application/octet-stream'], None, True),
TyMime(['bmp'], ['image/bmp'], ['BM'], False),
TyMime(['bz'], ['application/x-bzip'], ['BZ'], True),
TyMime(['bz2'], ['application/x-bzip2'], ['BZ'], True),
TyMime(['cab'], ['application/vnd.ms-cab-compressed'], None, True),
TyMime(['cer'], ['application/x-x509-ca-cert', 'application/pkix-cert'], None, False),
TyMime(['chm'], ['application/vnd.ms-htmlhelp'], ['ITSM'], False),
TyMime(['crt'], ['application/x-x509-ca-cert'], None, False),
TyMime(['css'], ['text/css'], None, False),
TyMime(['csv'], ['text/csv', 'application/vnd.ms-excel'], None, False),
TyMime(['deb'], ['application/x-debian-package'], ZIP, True),
TyMime(['der'], ['application/x-x509-ca-cert'], None, False),
TyMime(['dll'], ['application/x-msdownload', 'application/x-msdos-program'], ['MZ'], False),
TyMime(['doc'], ['application/msword'], CFBF, False),
TyMime(['docm'], ['application/vnd.ms-word.document.macroEnabled.12'], ZIP, True),
TyMime(['docx'], ['application/vnd.openxmlformats-officedocument.wordprocessingml.document'], ZIP, True),
TyMime(['dotm'], ['application/vnd.ms-word.template.macroEnabled.12'], ZIP, True),
TyMime(['dotx'], ['application/vnd.openxmlformats-officedocument.wordprocessingml.template'], ZIP, True),
TyMime(['dwg'], ['image/vnd.dwg'], None, False),
TyMime(['dxf'], ['image/vnd.dxf'], None, False),
TyMime(['emf'], ['image/x-emf', 'image/emf'], None, False),
TyMime(['eml'], ['message/rfc822'], None, False),
TyMime(['eps'], ['application/postscript'], None, False),
TyMime(['epub'], ['application/epub+zip'], ZIP, True),
TyMime(['exe'], ['application/x-msdownload', 'application/x-ms-dos-executable'], ['MZ'], False),
TyMime(['flac'], ['audio/x-flac', 'audio/flac'], ['fLaC'], True),
TyMime(['flv'], ['video/x-flv'], ['FLV'], False),
TyMime(['gif'], ['image/gif'], ['GIF87a', 'GIF89a'], True),
TyMime(['gv'], ['text/vnd.graphviz'], None, False),
TyMime(['gz', 'gzip'], ['application/x-gzip', 'application/gzip'], ['\x1F\x8B'], True),
TyMime(['heif'], ['image/heif'], None, True),
TyMime(['hlp'], ['application/winhlp'], None, False),
TyMime(['htm', 'html'], ['text/html'], None, False),
TyMime(['ico'], ['image/x-icon', 'image/vnd.microsoft.icon'], ['\x00\x00\x01\x00'], False),
TyMime(['ics'], ['text/calendar'], None, False),
TyMime(['jar'], ['application/java-archive'], ZIP, True),
TyMime(['jp2'], ['image/jp2'], ['\x00\x00\x00\xFFjP'], True),
TyMime(['jpg', 'jpeg'], ['image/jpeg'], ['\xFF\xD8\xFF'], True),
TyMime(['js'], ['application/javascript'], None, False),
TyMime(['json'], ['application/json'], None, False),
TyMime(['kml'], ['application/vnd.google-earth.kml+xml'], None, False),
TyMime(['kmz'], ['application/vnd.google-earth.kmz'], ZIP, True),
TyMime(['latex'], ['application/x-latex'], None, False),
TyMime(['m4a'], ['audio/mp4'], None, True),
TyMime(['md'], ['text/markdown'], None, False),
TyMime(['mdb'], ['application/msaccess'], ['\x00\x01\x00\x00Standard Jet DB'], False), # NUL SOH NUL NUL
TyMime(['mid', 'midi'], ['audio/mid', 'audio/sp-midi'], ['MThd'], False),
TyMime(['mka', 'mkv'], ['video/x-matroska'], MATROSKA, True),
TyMime(['mov'], ['video/quicktime'], None, True),
TyMime(['mp3'], ['audio/mpeg'], ['\xFF\xFB', '\xFF\xF3', '\xFF\xF2'], True),
TyMime(['mp4'], ['video/mp4'], ['ftypisom'], True),
TyMime(['mpg', 'mpeg'], ['video/mpeg'], ['\x00\x00\x01\xB3'], True),
TyMime(['mpp'], ['application/vnd.ms-project'], None, False),
TyMime(['oda'], ['application/oda'], None, False),
TyMime(['odf'], ['application/vnd.oasis.opendocument.formula'], ZIP, True),
TyMime(['odg'], ['application/vnd.oasis.opendocument.graphics'], ZIP, True),
TyMime(['odi'], ['application/vnd.oasis.opendocument.image'], None, False),
TyMime(['odp'], ['application/vnd.oasis.opendocument.presentation'], ZIP, True),
TyMime(['ods'], ['application/vnd.oasis.opendocument.spreadsheet'], ZIP, True),
TyMime(['odt'], ['application/vnd.oasis.opendocument.text'], ZIP, True),
TyMime(['oga', 'ogg'], ['audio/ogg'], None, True),
TyMime(['ogv'], ['video/ogg'], None, True),
TyMime(['one'], ['application/msonenote'], None, False),
TyMime(['otf'], ['application/x-font-otf'], None, False),
TyMime(['otp'], ['application/vnd.oasis.opendocument.presentation-template'], ZIP, True),
TyMime(['pdf'], ['application/pdf'], ['%PDF-'], False),
TyMime(['pdfxml'], ['application/vnd.adobe.pdfxml'], None, False),
TyMime(['png'], ['image/png'], ['\x89PNG'], True),
TyMime(['pot', 'pps', 'ppt'], ['application/vnd.ms-powerpoint'], CFBF, False),
TyMime(['potm'], ['application/vnd.ms-powerpoint.template.macroEnabled.12'], ZIP, True),
TyMime(['potx'], ['application/vnd.openxmlformats-officedocument.presentationml.template'], ZIP, True),
TyMime(['ppsm'], ['application/vnd.ms-powerpoint.slideshow.macroEnabled.12'], ZIP, True),
TyMime(['ppsx'], ['application/vnd.openxmlformats-officedocument.presentationml.slideshow'], ZIP, True),
TyMime(['pptm'], ['application/vnd.ms-powerpoint.presentation.macroEnabled.12'], ZIP, True),
TyMime(['pptx'], ['application/vnd.openxmlformats-officedocument.presentationml.presentation'], ZIP, True),
TyMime(['ps'], ['application/postscript'], ['%!PS'], False),
TyMime(['psd'], ['image/vnd.adobe.photoshop'], None, False),
TyMime(['pub'], ['application/vnd.ms-publisher'], CFBF, False),
TyMime(['rar'], ['application/x-rar-compressed', 'application/vnd.rar'], ['Rar!\x1A\x07\x00', 'Rar!\x1A\x07\x01'], True),
TyMime(['rss'], ['application/rss+xml', 'application/x-rss+xml'], XML, False),
TyMime(['rtf'], ['application/rtf'], ['{\rtf1'], False),
TyMime(['sqlite'], ['application/vnd.sqlite3'], ['SQLite format 3\x00'], False),
TyMime(['stc'], ['application/vnd.sun.xml.calc.template'], None, False),
TyMime(['std'], ['application/vnd.sun.xml.draw.template'], None, False),
TyMime(['sti'], ['application/vnd.sun.xml.impress.template'], None, False),
TyMime(['svg'], ['image/svg+xml'], XML, False),
TyMime(['swf'], ['application/x-shockwave-flash', 'application/vnd.adobe.flash.movie'], ['CWS', 'FWS'], False),
TyMime(['sxc'], ['application/vnd.sun.xml.calc'], None, False),
TyMime(['sxd'], ['application/vnd.sun.xml.draw'], None, False),
TyMime(['sxi'], ['application/vnd.sun.xml.impress'], None, False),
TyMime(['sxm'], ['application/vnd.sun.xml.math'], None, False),
TyMime(['sxw'], ['application/vnd.sun.xml.writer'], None, False),
TyMime(['tar'], ['application/x-tar'], ['ustar\x0000', 'ustar \x00'], True),
TyMime(['tgz'], ['application/x-compressed'], ['\x1F\x8B'], True),
TyMime(['tif', 'tiff'], ['image/tiff'], ['II*\x00', 'II\x00*'], False),
TyMime(['tsv'], ['text/tab-separated-values'], None, False),
TyMime(['ttf'], ['application/x-font-ttf', 'font/ttf'], None, False),
TyMime(['txt'], ['text/plain'], None, False),
TyMime(['vcf'], ['text/x-vcard', 'text/vcard'], None, False),
TyMime(['vsd'], ['application/vnd.ms-visio.viewer'], CFBF, False),
TyMime(['vsdm', 'vsdx'], ['application/vnd.ms-visio.viewer'], ZIP, True),
TyMime(['wav'], ['audio/wav', 'audio/x-wav'], ['WAV', 'RIFF'], False),
TyMime(['weba'], ['audio/webm'], None, True),
TyMime(['webm'], ['video/webm'], MATROSKA, True),
TyMime(['webp'], ['image/webp'], ['WEBP', 'RIFF'], True),
TyMime(['wma'], ['audio/x-ms-wma'], None, True),
TyMime(['wmf'], ['image/x-wmf', 'image/wmf'], None, False),
TyMime(['wmv'], ['video/x-ms-wmv'], None, True),
TyMime(['woff'], ['application/x-font-woff', 'font/woff'], None, False),
TyMime(['woff2'], ['application/x-font-woff', 'font/woff2'], ['wOF2'], True),
TyMime(['xaml'], ['application/xaml+xml'], None, False),
TyMime(['xla', 'xls', 'xlm'], ['application/vnd.ms-excel'], CFBF, False),
TyMime(['xlsb'], ['application/vnd.ms-excel.sheet.binary.macroEnabled.12'], ZIP, True),
TyMime(['xlsm'], ['application/vnd.ms-excel.sheet.macroEnabled.12'], ZIP, True),
TyMime(['xlsx'], ['application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'], ZIP, True),
TyMime(['xml'], ['text/xml', 'application/xml'], XML, False),
TyMime(['xsl', 'xslt'], ['text/xml', 'application/xslt+xml'], XML, False),
TyMime(['yaml'], ['text/yaml'], None, False),
TyMime(['z'], ['application/x-compress'], ['\x1F\xA0'], True),
TyMime(['zip'], ['application/x-zip-compressed', 'application/zip'], ZIP, True),
]
EXECS = ['bat', 'cat', 'cmd', 'com', 'dll', 'docm', 'drv', 'exe', 'potm', 'ppsm', 'pptm', 'ps1', 'scr', 'sh', 'sys', 'vbs', 'xlsm', 'zsh']
class PwicError(Exception):
''' Generic exception for Pwic.wiki '''
class PwicLib:
# ========
# System
# ========
@staticmethod
def audit(sql: sqlite3.Cursor, obj: Dict[str, Union[str, int]], request: Optional[web.Request] = None) -> None:
''' Save an event into the audit log '''
from pwic_extension import PwicExtension
# Check
if obj.get('event') in [None, '']:
raise PwicError
if request is not None:
obj['ip'] = PwicExtension.on_ip_header(request)
if PwicExtension.on_audit_skip(sql, request, obj):
return
# Log the event
dt = PwicLib.dt()
sql.execute(''' INSERT INTO audit.audit (date, time, author, event, user, project, page, reference, string, ip)
VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?) ''',
(str(obj.get('date', dt['date'])),
str(obj.get('time', dt['time'])),
str(obj.get('author', PwicConst.USERS['anonymous'])),
str(obj.get('event', '')),
str(obj.get('user', '')),
str(obj.get('project', '')),
str(obj.get('page', '')),
PwicLib.intval(obj.get('reference', 0)),
str(obj.get('string', '')),
str(obj.get('ip', '')),
))
if sql.rowcount != 1:
raise PwicError
# Specific event
try:
PwicExtension.on_audit(sql, request, obj)
except Exception: # nosec B110
pass
@staticmethod
def connect(dbfile: str = PwicConst.DB_SQLITE,
dbaudit: Optional[str] = PwicConst.DB_SQLITE_AUDIT,
trace: bool = False,
in_memory: bool = True,
asynchronous: bool = False,
vacuum: bool = False,
) -> Tuple[sqlite3.Connection, sqlite3.Cursor]:
''' Connect to the database with the relevant options '''
# Connection
db = sqlite3.connect(dbfile)
db.row_factory = PwicLib.row_factory
if trace:
db.set_trace_callback(PwicLib.sql_print)
# Cursor and options
sql = db.cursor()
attached = dbaudit is not None
if attached:
sql.execute(''' ATTACH DATABASE ? AS audit''', (dbaudit, ))
if in_memory:
sql.execute(''' PRAGMA main.journal_mode = MEMORY''')
if attached:
sql.execute(''' PRAGMA audit.journal_mode = MEMORY''')
if asynchronous or (PwicLib.option(sql, '', 'db_async') is not None):
sql.execute(''' PRAGMA main.synchronous = OFF''')
if attached:
sql.execute(''' PRAGMA audit.synchronous = OFF''')
if vacuum:
sql.execute(''' VACUUM main''')
if attached:
sql.execute(''' VACUUM audit''')
return db, sql
@staticmethod
def detect_language(request: web.Request, allowed_langs: List[str], sso: bool = False) -> str:
''' Detect the default language of the user from the HTTP headers '''
# Detect from the HTTP headers
head = request.headers.get('Accept-Language', '')
langs = PwicLib.list(head.replace(',', ' ').replace(';', ' '))
result = PwicConst.DEFAULTS['language']
for e in langs:
if '-' in e:
e = e[:2]
if e in allowed_langs:
result = e
break
# Custom detection
from pwic_extension import PwicExtension
return PwicExtension.on_language_detected(request, result, allowed_langs, sso)
# ====================
# Reusable functions
# ====================
@staticmethod
def attachment_name(name: str) -> str:
''' Return the file name for a proper download '''
return "=?utf-8?B?%s?=" % (b64encode(name.encode()).decode())
@staticmethod
def convert_length(value: Optional[Union[str, int, float]], target_unit: str, precision: int, dpi: float = PwicConst.DPI) -> str:
''' Convert a length from a unit to another one '''
# Conversion factors
factors = {'cm': (dpi / 2.54, 'px'),
'mm': (0.1, 'cm'),
'in': (2.54, 'cm'),
'pt': (1. / 72., 'in'),
'pc': (12., 'pt'),
'px': (1., 'px'),
'em': (0., 'px'), # Relative length
'': (1., '')}
# Read the input value
if (value is None) or (target_unit not in factors):
return '0'
if not isinstance(value, str):
length = float(value)
unit = 'px'
else:
value = value.strip().replace(' ', '').replace(',', '.').lower()
m = PwicConst.REGEXES['length'].match(value)
if m is None:
return '0'
try:
length = float(m.group(1))
except ValueError:
return '0'
unit = m.group(3) or 'px'
# Convert to pixels
while True:
(k, unit) = factors[unit]
length *= k
if unit == 'px':
break
# Convert to the target unit
length /= factors[target_unit][0]
return str(round(length, precision)) + target_unit
@staticmethod
def dt(days: int = 0) -> Dict[str, str]:
''' Return some key dates and time '''
from pwic_extension import PwicExtension
curtime = datetime.now(tz=PwicExtension.on_timezone())
return {'date': str(curtime)[:10],
'date-30d': str(curtime - timedelta(days=30))[:10],
'date-90d': str(curtime - timedelta(days=90))[:10],
'date-nd': str(curtime - timedelta(days=days))[:10],
'time': str(curtime)[11:19]}
@staticmethod
def dt_diff(date1: str, date2: str) -> int:
''' Calculate the number of days between 2 dates '''
if date1 > date2:
date1, date2 = date2, date1
d1 = datetime.strptime(date1 + ' 00:00:00', PwicConst.DEFAULTS['dt_mask'])
d2 = datetime.strptime(date2 + ' 00:00:00', PwicConst.DEFAULTS['dt_mask'])
return (d2 - d1).days
@staticmethod
def dt2rfc822(sdate: str, stime: str) -> str:
''' Convert a local date&time or a complete date/time to RFC 822
The time zone may be provided by PwicExtension.on_timezone()
'''
from pwic_extension import PwicExtension
curtime = datetime.strptime(f'{sdate} {stime}', PwicConst.DEFAULTS['dt_mask'])
curtime = curtime.replace(tzinfo=PwicExtension.on_timezone())
return datetime.strftime(curtime, '%a, %d %b %Y %H:%M:%S %Z').replace('UTC', 'UT').strip()
@staticmethod
def intval(value: Any, base=10) -> int:
''' Safe conversion to integer in the chosen base '''
try:
if base != 10:
return int(value, base)
return int(float(value) if '.' in str(value) else value)
except (ValueError, TypeError):
return 0
@staticmethod
def ishex(value: str) -> bool:
''' Check if the value is a non-zero hexadecimal value '''
return PwicLib.intval(str(value), base=16) > 0
@staticmethod
def flag(flag: str) -> str:
''' Convert a country in ISO format to emoji '''
# Check the parameter
flag = flag.strip().lower()
if len(flag) != 2:
return ''
# Build the unicode flag
emoji = ''
for i in range(2):
if flag[i] in ascii_lowercase:
emoji += chr(ascii_lowercase.find(flag[i]) + 0x1F1E6)
else:
return ''
return emoji
@staticmethod
def list(inputstr: Optional[str], do_sort: bool = False) -> List[str]:
''' Build a list of unique values from a string and keep the initial order (by default) '''
if inputstr is None:
inputstr = ''
inputstr = PwicLib.recursive_replace(inputstr.replace('\r', ' ').replace('\n', ' ').replace('\t', ' '), ' ', ' ').strip()
values = [] if inputstr == '' else list(OrderedDict((e, None) for e in inputstr.split(' ')))
if do_sort:
values.sort()
return values
@staticmethod
def list_tags(tags: str) -> str:
''' Reorder a list of tags written as a string '''
return ' '.join(PwicLib.list(tags.replace('#', '').lower(), do_sort=True))
@staticmethod
def nns(value: Optional[str]) -> str:
''' Return a non-null string '''
return str('' if value is None else value)
@staticmethod
def notag(value: str) -> str:
''' Remove the HTML tags from a string '''
while True:
i = len(value)
value = PwicConst.REGEXES['tag_all'].sub('', value)
value = PwicConst.REGEXES['tag_comment'].sub('', value)
if len(value) == i:
break
return value
@staticmethod
def option(sql: Optional[sqlite3.Cursor],
project: Optional[str],
name: str,
default: Optional[str] = None,
) -> Optional[str]:
''' Read a variable from the table ENV that can be project-dependent or not '''
if (sql is None) or (name not in PwicConst.ENV):
return default
try:
query = ''' SELECT value
FROM env
WHERE project = ?
AND key = ?
AND value <> '' '''
if project is None:
project = ''
# Read by project
if not PwicConst.ENV[name].pdep:
project = ''
if project == '':
row = None
else:
row = sql.execute(query, (project, name)).fetchone()
# Read globally
if (row is None) and PwicConst.ENV[name].pindep:
project = ''
row = sql.execute(query, (project, name)).fetchone()
# Result
result = default if row is None else row['value']
if isinstance(result, str):
result = result.replace('\r', '')
return result
except sqlite3.OperationalError: # During init-db
return default
@staticmethod
def random_hash() -> str:
''' Generate a random 64-char-long string '''
return PwicLib.sha256(str(urandom(64)))[:32] + PwicLib.sha256(str(urandom(64)))[32:]
@staticmethod
def read_attr(attrs: List[Tuple[str, Optional[str]]], key: str, default: str = '') -> str:
''' Read a list of tuples by the first field and return the value in the second field '''
for (k, v) in attrs:
if k == key:
return PwicLib.nns(v)
return default
@staticmethod
def read_attr_key(attrs: List[Tuple[str, Optional[str]]], key: str) -> bool:
''' Check a list of tuples by the first field '''
for k in attrs:
if k[0] == key:
return True
return False
@staticmethod
def recursive_replace(text: str, search: Any, replace: str, strip: bool = True) -> str:
''' Replace a string recursively '''
while True:
curlen = len(text)
text = text.replace(search, replace)
if len(text) == curlen:
break
if strip:
text = text.strip()
return text
@staticmethod
def robots2str(robots: TyRobotsDict) -> str:
''' Convert structured boolean values into a meta string robots '''
return ' '.join([('' if robots[k] else 'no') + k for k in robots if robots[k] is not None])
@staticmethod
def row_factory(cursor: sqlite3.Cursor, row: Tuple[Any, ...]):
''' Assign names to the SQL output '''
d = {}
for idx, col in enumerate(cursor.description):
if col[0] in PwicConst.BOOL_COLUMNS:
d[col[0]] = PwicLib.xb(row[idx])
else:
d[col[0]] = row[idx]
return d
@staticmethod
def safe_file_name(name: str) -> str:
''' Ensure that a file name is acceptable '''
name = PwicLib.safe_name(name, extra='').replace(' ', '_').replace('\t', '_')
name = PwicLib.recursive_replace(name, '..', '.')
name = PwicLib.recursive_replace(name, '__', '_')
return '' if name[:1] == '.' else name
@staticmethod
def safe_name(name: Optional[str], extra: str = '.@') -> str:
''' Ensure that a string will not collide with the reserved characters of the operating system '''
if name is None:
return ''
chars = PwicConst.CHARS_UNSAFE + extra
for c in chars:
name = name.replace(c, '')
return name.strip().lower()[:PwicLib.intval(PwicConst.DEFAULTS['limit_filename'])]
@staticmethod
def safe_user_name(name: Optional[str]) -> str:
''' Ensure that a user name is acceptable '''
return PwicLib.safe_name(name, extra='')
@staticmethod
def sha256(value: Union[str, bytearray], salt: bool = True) -> str:
''' Calculate the SHA256 as string for the given value '''
if isinstance(value, bytearray):
if salt:
raise PwicError
return sha256(value).hexdigest()
text = (PwicConst.SALT if salt else '') + str(value)
return sha256(text.encode()).hexdigest()
@staticmethod
def sha256_file(filename: str) -> str:
''' Calculate the SHA256 as string for the given file '''
try:
hashval = sha256()
with open(filename, 'rb') as f:
for block in iter(lambda: f.read(4096), b''):
hashval.update(block)
return hashval.hexdigest()
except FileNotFoundError:
return ''
@staticmethod
def shrink(value: Optional[str]) -> str:
''' Convert a string into its shortest value in lower case '''
if value is None:
return ''
return value.replace('\r', '').replace('\n', '').replace('\t', '').replace(' ', '').strip().lower()
@staticmethod
def size2str(size: Union[int, float]) -> str:
''' Convert a size to a readable format '''
units = ' kMGTPEZ'
for i in range(len(units)):
if size < 1024:
break
size /= 1024
return ('%.1f %sB' % (size, units[i].strip())).replace('.0 ', ' ')
@staticmethod
def sql_print(query: Optional[str]) -> None:
''' Quick and dirty callback to print the SQL queries on a single line for debugging purposes '''
if query is not None:
dt = PwicLib.dt()
print('[%s %s] %s' % (dt['date'],
dt['time'],
' '.join([PwicLib.recursive_replace(q.strip().replace('\r', '').replace('\t', ' '), ' ', ' ') for q in query.split('\n')])))
@staticmethod
def str2bytearray(inputstr: str) -> bytearray:
''' Convert string to bytearray '''
barr = bytearray() # =bytearray(bytes.encode()) breaks the bytes sequence due to the encoding
for c in inputstr:
barr.append(ord(c))
return barr
@staticmethod
def str2robots(robots: str) -> TyRobotsDict:
''' Convert a meta string robots into structured boolean values '''
values = PwicLib.list(robots)
result: TyRobotsDict = {}
for k in ['archive', 'follow', 'index', 'snippet']:
if 'no' + k in values:
result[k] = False
elif k in values:
result[k] = True
else:
result[k] = None
return result
@staticmethod
def timestamp() -> int:
''' Returns the current time stamp '''
return PwicLib.intval(time())
@staticmethod
def x(value: Any) -> str:
''' Reduce an input value to a boolean string '''
return '' if value in [None, '', 0, '0', False, 'false', 'False', 'FALSE', '-', '~', 'no', 'No', 'NO', 'off', 'Off', 'OFF'] else 'X'
@staticmethod
def xb(value: str) -> bool:
''' Convert 'X' to a boolean value '''
return value == 'X'
# =======
# Mimes
# =======
@staticmethod
def file_ext(filename: str) -> str:
''' Return the file extension of the file '''
return splitext(filename)[1][1:].strip().lower()
@staticmethod
def magic_bytes(ext: str) -> Optional[List[str]]:
''' Return the magic bytes that corresponds to the file extension '''
ext = ext.strip().lower()
for item in PwicConst.MIMES:
if ext in item.exts:
return item.magic
return None
@staticmethod
def mime(ext: str) -> Optional[str]:
''' Return the default mime that corresponds to the file extension '''
values = PwicLib.mime_list(ext)
return None if len(values) == 0 else values[0]
@staticmethod
def mime_list(ext: str) -> List[str]:
''' Return the possible mimes that correspond to the file extension '''
ext = ext.strip().lower()
for item in PwicConst.MIMES:
if ext in item.exts:
return item.mimes
return []
@staticmethod
def mime_compressed(ext: str) -> bool:
''' Return the possible state of compression based on the file extension '''
ext = ext.strip().lower()
for item in PwicConst.MIMES:
if ext in item.exts:
return item.compressed
return False
@staticmethod
def mime2icon(mime: str) -> str:
''' Return the emoji that corresponds to the MIME '''
if mime[:6] == 'image/':
return PwicConst.EMOJIS['image']
if mime[:6] == 'video/':
return PwicConst.EMOJIS['camera']
if mime[:6] == 'audio/':
return PwicConst.EMOJIS['headphone']
if mime[:12] == 'application/':
return PwicConst.EMOJIS['server']
return PwicConst.EMOJIS['sheet']
# ===============
# Search engine
# ===============
@staticmethod
def search_parse(query: str, case_sensitive: bool) -> Dict[str, List[str]]:
''' Build a search object from a string '''
included = []
excluded = []
terms = PwicConst.REGEXES['search_terms'].findall(query.replace('\r', '').strip())
for negative, term in terms:
if term.startswith('"') and term.endswith('"'):
term = term[1:-1]
if not case_sensitive:
term = term.lower()
if negative == '-':
excluded.append(term)
else:
included.append(term)
included.sort(key=lambda v: v.lower())
excluded.sort(key=lambda v: v.lower())
return {'included': included,
'excluded': excluded}
@staticmethod
def search2string(query: Dict[str, List[str]]) -> str:
''' Convert a search object back to string '''
if query is None:
return ''
result = ''
for q in query['included']:
quote = '"' if ' ' in q else ''
result += f' {quote}{q}{quote}'
for q in query['excluded']:
quote = '"' if ' ' in q else ''
result += f' -{quote}{q}{quote}'
return result.strip()
# ========
# Editor
# ========
@staticmethod
def extended_syntax(markdown: str, mask: Optional[str], headerNumbering: bool = True) -> Tuple[str, List[Dict]]:
''' Automatic numbering of the MD headers '''
# Local functions
def _numeric(value: int) -> str:
return str(value)
def _roman(value: int) -> str:
if value < 1 or value > 4999:
return '0'
buffer = ''
for letter, threshold in (('M', 1000),
('CM', 900),
('D', 500),
('CD', 400),
('C', 100),
('XC', 90),
('L', 50),
('XL', 40),
('X', 10),
('IX', 9),
('V', 5),
('IV', 4),
('I', 1)):
while value >= threshold:
buffer += letter
value -= threshold
return buffer