-
Notifications
You must be signed in to change notification settings - Fork 446
/
utils.py
1906 lines (1580 loc) · 66.8 KB
/
utils.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
# -*- coding: utf-8 -*-
# Copyright © 2012-2016 Roberto Alsina and others.
# Permission is hereby granted, free of charge, to any
# person obtaining a copy of this software and associated
# documentation files (the "Software"), to deal in the
# Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the
# Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice
# shall be included in all copies or substantial portions of
# the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
# PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
# OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
"""Utility functions."""
from __future__ import print_function, unicode_literals, absolute_import
import calendar
import datetime
import dateutil.tz
import hashlib
import husl
import io
import locale
import logging
import natsort
import os
import re
import json
import shutil
import socket
import subprocess
import sys
import dateutil.parser
import dateutil.tz
import logbook
try:
from urllib import quote as urlquote
from urllib import unquote as urlunquote
from urlparse import urlparse, urlunparse
except ImportError:
from urllib.parse import quote as urlquote # NOQA
from urllib.parse import unquote as urlunquote # NOQA
from urllib.parse import urlparse, urlunparse # NOQA
import warnings
import PyRSS2Gen as rss
from collections import defaultdict, Callable, OrderedDict
from logbook.compat import redirect_logging
from logbook.more import ExceptionHandler, ColorizedStderrHandler
from pygments.formatters import HtmlFormatter
from zipfile import ZipFile as zipf
from doit import tools
from unidecode import unidecode
from unicodedata import normalize as unicodenormalize
from pkg_resources import resource_filename
from doit.cmdparse import CmdParse
from nikola import DEBUG
__all__ = ('CustomEncoder', 'get_theme_path', 'get_theme_chain', 'load_messages', 'copy_tree',
'copy_file', 'slugify', 'unslugify', 'to_datetime', 'apply_filters',
'config_changed', 'get_crumbs', 'get_tzname', 'get_asset_path',
'_reload', 'unicode_str', 'bytes_str', 'unichr', 'Functionary',
'TranslatableSetting', 'TemplateHookRegistry', 'LocaleBorg',
'sys_encode', 'sys_decode', 'makedirs', 'get_parent_theme_name',
'demote_headers', 'get_translation_candidate', 'write_metadata',
'ask', 'ask_yesno', 'options2docstring', 'os_path_split',
'get_displayed_page_number', 'adjust_name_for_index_path_list',
'adjust_name_for_index_path', 'adjust_name_for_index_link',
'NikolaPygmentsHTML', 'create_redirect', 'TreeNode',
'flatten_tree_structure', 'parse_escaped_hierarchical_category_name',
'join_hierarchical_category_path', 'clean_before_deployment', 'indent')
# Are you looking for 'generic_rss_renderer'?
# It's defined in nikola.nikola.Nikola (the site object).
if sys.version_info[0] == 3:
# Python 3
bytes_str = bytes
unicode_str = str
unichr = chr
raw_input = input
from imp import reload as _reload
else:
bytes_str = str
unicode_str = unicode # NOQA
_reload = reload # NOQA
unichr = unichr
class ApplicationWarning(Exception):
pass
class ColorfulStderrHandler(ColorizedStderrHandler):
"""Stream handler with colors."""
_colorful = False
def should_colorize(self, record):
"""Inform about colorization using the value obtained from Nikola."""
return self._colorful
def get_logger(name, handlers):
"""Get a logger with handlers attached."""
l = logbook.Logger(name)
for h in handlers:
if isinstance(h, list):
l.handlers += h
else:
l.handlers.append(h)
return l
STDERR_HANDLER = [ColorfulStderrHandler(
level=logbook.INFO if not DEBUG else logbook.DEBUG,
format_string=u'[{record.time:%Y-%m-%dT%H:%M:%SZ}] {record.level_name}: {record.channel}: {record.message}'
)]
LOGGER = get_logger('Nikola', STDERR_HANDLER)
STRICT_HANDLER = ExceptionHandler(ApplicationWarning, level='WARNING')
USE_SLUGIFY = True
redirect_logging()
if DEBUG:
logging.basicConfig(level=logging.DEBUG)
else:
logging.basicConfig(level=logging.INFO)
def showwarning(message, category, filename, lineno, file=None, line=None):
"""Show a warning (from the warnings module) to the user."""
try:
n = category.__name__
except AttributeError:
n = str(category)
get_logger(n, STDERR_HANDLER).warn('{0}:{1}: {2}'.format(filename, lineno, message))
warnings.showwarning = showwarning
def req_missing(names, purpose, python=True, optional=False):
"""Log that we are missing some requirements.
`names` is a list/tuple/set of missing things.
`purpose` is a string, specifying the use of the missing things.
It completes the sentence:
In order to {purpose}, you must install ...
`python` specifies whether the requirements are Python packages
or other software.
`optional` specifies whether the things are required
(this is an error and we exit with code 5)
or not (this is just a warning).
Returns the message shown to the user (which you can usually discard).
If no names are specified, False is returned and nothing is shown
to the user.
"""
if not (isinstance(names, tuple) or isinstance(names, list) or isinstance(names, set)):
names = (names,)
if not names:
return False
if python:
whatarethey_s = 'Python package'
whatarethey_p = 'Python packages'
else:
whatarethey_s = whatarethey_p = 'software'
if len(names) == 1:
msg = 'In order to {0}, you must install the "{1}" {2}.'.format(
purpose, names[0], whatarethey_s)
else:
most = '", "'.join(names[:-1])
pnames = most + '" and "' + names[-1]
msg = 'In order to {0}, you must install the "{1}" {2}.'.format(
purpose, pnames, whatarethey_p)
if optional:
LOGGER.warn(msg)
else:
LOGGER.error(msg)
LOGGER.error('Exiting due to missing dependencies.')
sys.exit(5)
return msg
from nikola import filters as task_filters # NOQA
ENCODING = sys.getfilesystemencoding() or sys.stdin.encoding
def sys_encode(thing):
"""Return bytes encoded in the system's encoding."""
if isinstance(thing, unicode_str):
return thing.encode(ENCODING)
return thing
def sys_decode(thing):
"""Return Unicode."""
if isinstance(thing, bytes_str):
return thing.decode(ENCODING)
return thing
def makedirs(path):
"""Create a folder and its parents if needed (mkdir -p)."""
if not path:
return
if os.path.exists(path):
if not os.path.isdir(path):
raise OSError('Path {0} already exists and is not a folder.'.format(path))
else:
return
try:
os.makedirs(path)
return
except Exception:
if os.path.isdir(path):
return
raise
class Functionary(defaultdict):
"""Class that looks like a function, but is a defaultdict."""
def __init__(self, default, default_lang):
"""Initialize a functionary."""
super(Functionary, self).__init__(default)
self.default_lang = default_lang
def __call__(self, key, lang=None):
"""When called as a function, take an optional lang and return self[lang][key]."""
if lang is None:
lang = LocaleBorg().current_lang
return self[lang][key]
class TranslatableSetting(object):
"""A setting that can be translated.
You can access it via: SETTING(lang). You can omit lang, in which
case Nikola will ask LocaleBorg, unless you set SETTING.lang,
which overrides that call.
You can also stringify the setting and you will get something
sensible (in what LocaleBorg claims the language is, can also be
overriden by SETTING.lang). Note that this second method is
deprecated. It is kept for backwards compatibility and
safety. It is not guaranteed.
The underlying structure is a defaultdict. The language that
is the default value of the dict is provided with __init__().
"""
# WARNING: This is generally not used and replaced with a call to
# LocaleBorg(). Set this to a truthy value to override that.
lang = None
# Note that this setting is global. DO NOT set on a per-instance basis!
default_lang = 'en'
def __getattribute__(self, attr):
"""Return attributes, falling back to string attributes."""
try:
return super(TranslatableSetting, self).__getattribute__(attr)
except AttributeError:
return self().__getattribute__(attr)
def __dir__(self):
"""Return the available methods of TranslatableSettings and strings."""
return list(set(self.__dict__).union(set(dir(str))))
def __init__(self, name, inp, translations):
"""Initialize a translated setting.
Valid inputs include:
* a string -- the same will be used for all languages
* a dict ({lang: value}) -- each language will use the value specified;
if there is none, default_lang is used.
"""
self.name = name
self._inp = inp
self.translations = translations
self.overriden_default = False
self.values = defaultdict()
if isinstance(inp, dict) and inp:
self.translated = True
self.values.update(inp)
if self.default_lang not in self.values.keys():
self.default_lang = list(self.values.keys())[0]
self.overridden_default = True
self.values.default_factory = lambda: self.values[self.default_lang]
for k in translations.keys():
if k not in self.values.keys():
self.values[k] = inp[self.default_lang]
else:
self.translated = False
self.values[self.default_lang] = inp
self.values.default_factory = lambda: inp
def get_lang(self):
"""Return the language that should be used to retrieve settings."""
if self.lang:
return self.lang
elif not self.translated:
return self.default_lang
else:
try:
return LocaleBorg().current_lang
except AttributeError:
return self.default_lang
def __call__(self, lang=None):
"""Return the value in the requested language.
While lang is None, self.lang (currently set language) is used.
Otherwise, the standard algorithm is used (see above).
"""
if lang is None:
return self.values[self.get_lang()]
else:
return self.values[lang]
def __str__(self):
"""Return the value in the currently set language (deprecated)."""
return self.values[self.get_lang()]
def __unicode__(self):
"""Return the value in the currently set language (deprecated)."""
return self.values[self.get_lang()]
def __repr__(self):
"""Provide a representation for programmers."""
return '<TranslatableSetting: {0!r}>'.format(self.name)
def format(self, *args, **kwargs):
"""Format ALL the values in the setting the same way."""
for l in self.values:
self.values[l] = self.values[l].format(*args, **kwargs)
self.values.default_factory = lambda: self.values[self.default_lang]
return self
def langformat(self, formats):
"""Format ALL the values in the setting, on a per-language basis."""
if not formats:
# Input is empty.
return self
else:
# This is a little tricky.
# Basically, we have some things that may very well be dicts. Or
# actually, TranslatableSettings in the original unprocessed dict
# form. We need to detect them.
# First off, we need to check what languages we have and what
# should we use as the default.
keys = list(formats)
if self.default_lang in keys:
d = formats[self.default_lang]
else:
d = formats[keys[0]]
# Discovering languages of the settings here.
langkeys = []
for f in formats.values():
for a in f[0] + tuple(f[1].values()):
if isinstance(a, dict):
langkeys += list(a)
# Now that we know all this, we go through all the languages we have.
allvalues = set(keys + langkeys + list(self.values))
self.values['__orig__'] = self.values[self.default_lang]
for l in allvalues:
if l in keys:
oargs, okwargs = formats[l]
else:
oargs, okwargs = d
args = []
kwargs = {}
for a in oargs:
# We create temporary TranslatableSettings and replace the
# values with them.
if isinstance(a, dict):
a = TranslatableSetting('NULL', a, self.translations)
args.append(a(l))
else:
args.append(a)
for k, v in okwargs.items():
if isinstance(v, dict):
v = TranslatableSetting('NULL', v, self.translations)
kwargs.update({k: v(l)})
else:
kwargs.update({k: v})
if l in self.values:
self.values[l] = self.values[l].format(*args, **kwargs)
else:
self.values[l] = self.values['__orig__'].format(*args, **kwargs)
self.values.default_factory = lambda: self.values[self.default_lang]
return self
def __getitem__(self, key):
"""Provide an alternate interface via __getitem__."""
return self.values[key]
def __setitem__(self, key, value):
"""Set values for translations."""
self.values[key] = value
def __eq__(self, other):
"""Test whether two TranslatableSettings are equal."""
try:
return self.values == other.values
except AttributeError:
return self(self.default_lang) == other
def __ne__(self, other):
"""Test whether two TranslatableSettings are inequal."""
try:
return self.values != other.values
except AttributeError:
return self(self.default_lang) != other
class TemplateHookRegistry(object):
r"""A registry for template hooks.
Usage:
>>> r = TemplateHookRegistry('foo', None)
>>> r.append('Hello!')
>>> r.append(lambda x: 'Hello ' + x + '!', False, 'world')
>>> str(r()) # str() call is not recommended in real use
'Hello!\nHello world!'
>>>
"""
def __init__(self, name, site):
"""Initialize a hook registry."""
self._items = []
self.name = name
self.site = site
self.context = None
def generate(self):
"""Generate items."""
for c, inp, site, args, kwargs in self._items:
if c:
if site:
kwargs['site'] = self.site
kwargs['context'] = self.context
yield inp(*args, **kwargs)
else:
yield inp
def __call__(self):
"""Return items, in a string, separated by newlines."""
return '\n'.join(self.generate())
def append(self, inp, wants_site_and_context=False, *args, **kwargs):
"""
Register an item.
`inp` can be a string or a callable returning one.
`wants_site` tells whether there should be a `site` keyword
argument provided, for accessing the site.
Further positional and keyword arguments are passed as-is to the
callable.
`wants_site`, args and kwargs are ignored (but saved!) if `inp`
is not callable. Callability of `inp` is determined only once.
"""
c = callable(inp)
self._items.append((c, inp, wants_site_and_context, args, kwargs))
def __hash__(self):
"""Return hash of a registry."""
return hash(config_changed({self.name: self._items})._calc_digest())
def __str__(self):
"""Stringify a registry."""
return '<TemplateHookRegistry: {0}>'.format(self._items)
def __repr__(self):
"""Provide the representation of a registry."""
return '<TemplateHookRegistry: {0}>'.format(self.name)
class CustomEncoder(json.JSONEncoder):
"""Custom JSON encoder."""
def default(self, obj):
"""Default encoding handler."""
try:
return super(CustomEncoder, self).default(obj)
except TypeError:
if isinstance(obj, (set, frozenset)):
return self.encode(sorted(list(obj)))
else:
s = repr(obj).split('0x', 1)[0]
return s
class config_changed(tools.config_changed):
"""A copy of doit's config_changed, using pickle instead of serializing manually."""
def __init__(self, config, identifier=None):
"""Initialize config_changed."""
super(config_changed, self).__init__(config)
self.identifier = '_config_changed'
if identifier is not None:
self.identifier += ':' + identifier
def _calc_digest(self):
"""Calculate a config_changed digest."""
if isinstance(self.config, str):
return self.config
elif isinstance(self.config, dict):
data = json.dumps(self.config, cls=CustomEncoder, sort_keys=True)
if isinstance(data, str): # pragma: no cover # python3
byte_data = data.encode("utf-8")
else:
byte_data = data
digest = hashlib.md5(byte_data).hexdigest()
# LOGGER.debug('{{"{0}": {1}}}'.format(digest, byte_data))
# Humanized format:
# LOGGER.debug('[Digest {0} for {2}]\n{1}\n[Digest {0} for {2}]'.format(digest, byte_data, self.identifier))
return digest
else:
raise Exception('Invalid type of config_changed parameter -- got '
'{0}, must be string or dict'.format(type(
self.config)))
def configure_task(self, task):
"""Configure a task with a digest."""
task.value_savers.append(lambda: {self.identifier: self._calc_digest()})
def __call__(self, task, values):
"""Return True if config values are unchanged."""
last_success = values.get(self.identifier)
if last_success is None:
return False
return (last_success == self._calc_digest())
def __repr__(self):
"""Provide a representation of config_changed."""
return "Change with config: {0}".format(json.dumps(self.config,
cls=CustomEncoder,
sort_keys=True))
def get_theme_path(theme, themes_dirs=['themes']):
"""Return the path where the given theme's files are located.
Looks in ./themes and in the place where themes go when installed.
"""
for themes_dir in themes_dirs:
dir_name = os.path.join(themes_dir, theme)
if os.path.isdir(dir_name):
return dir_name
dir_name = resource_filename('nikola', os.path.join('data', 'themes', theme))
if os.path.isdir(dir_name):
return dir_name
raise Exception("Can't find theme '{0}'".format(theme))
def get_template_engine(themes, themes_dirs=['themes']):
"""Get template engine used by a given theme."""
for theme_name in themes:
engine_path = os.path.join(get_theme_path(theme_name, themes_dirs), 'engine')
if os.path.isfile(engine_path):
with open(engine_path) as fd:
return fd.readlines()[0].strip()
# default
return 'mako'
def get_parent_theme_name(theme_name, themes_dirs=['themes']):
"""Get name of parent theme."""
parent_path = os.path.join(get_theme_path(theme_name, themes_dirs), 'parent')
if os.path.isfile(parent_path):
with open(parent_path) as fd:
return fd.readlines()[0].strip()
return None
def get_theme_chain(theme, themes_dirs=['themes']):
"""Create the full theme inheritance chain."""
themes = [theme]
while True:
parent = get_parent_theme_name(themes[-1], themes_dirs)
# Avoid silly loops
if parent is None or parent in themes:
break
themes.append(parent)
return themes
language_incomplete_warned = []
class LanguageNotFoundError(Exception):
"""An exception thrown if language is not found."""
def __init__(self, lang, orig):
"""Initialize exception."""
self.lang = lang
self.orig = orig
def __str__(self):
"""Stringify the exception."""
return 'cannot find language {0}'.format(self.lang)
def load_messages(themes, translations, default_lang, themes_dirs=['themes']):
"""Load theme's messages into context.
All the messages from parent themes are loaded,
and "younger" themes have priority.
"""
messages = Functionary(dict, default_lang)
oldpath = list(sys.path)
for theme_name in themes[::-1]:
msg_folder = os.path.join(get_theme_path(theme_name, themes_dirs), 'messages')
default_folder = os.path.join(get_theme_path('base', themes_dirs), 'messages')
sys.path.insert(0, default_folder)
sys.path.insert(0, msg_folder)
english = __import__('messages_en')
# If we don't do the reload, the module is cached
_reload(english)
for lang in list(translations.keys()):
try:
translation = __import__('messages_' + lang)
# If we don't do the reload, the module is cached
_reload(translation)
if sorted(translation.MESSAGES.keys()) !=\
sorted(english.MESSAGES.keys()) and \
lang not in language_incomplete_warned:
language_incomplete_warned.append(lang)
LOGGER.warn("Incomplete translation for language "
"'{0}'.".format(lang))
messages[lang].update(english.MESSAGES)
for k, v in translation.MESSAGES.items():
if v:
messages[lang][k] = v
del(translation)
except ImportError as orig:
raise LanguageNotFoundError(lang, orig)
del(english)
sys.path = oldpath
return messages
def copy_tree(src, dst, link_cutoff=None):
"""Copy a src tree to the dst folder.
Example:
src = "themes/default/assets"
dst = "output/assets"
should copy "themes/defauts/assets/foo/bar" to
"output/assets/foo/bar"
if link_cutoff is set, then the links pointing at things
*inside* that folder will stay as links, and links
pointing *outside* that folder will be copied.
"""
ignore = set(['.svn'])
base_len = len(src.split(os.sep))
for root, dirs, files in os.walk(src, followlinks=True):
root_parts = root.split(os.sep)
if set(root_parts) & ignore:
continue
dst_dir = os.path.join(dst, *root_parts[base_len:])
makedirs(dst_dir)
for src_name in files:
if src_name in ('.DS_Store', 'Thumbs.db'):
continue
dst_file = os.path.join(dst_dir, src_name)
src_file = os.path.join(root, src_name)
yield {
'name': dst_file,
'file_dep': [src_file],
'targets': [dst_file],
'actions': [(copy_file, (src_file, dst_file, link_cutoff))],
'clean': True,
}
def copy_file(source, dest, cutoff=None):
"""Copy a file from source to dest. If link target starts with `cutoff`, symlinks are used."""
dst_dir = os.path.dirname(dest)
makedirs(dst_dir)
if os.path.islink(source):
link_target = os.path.relpath(
os.path.normpath(os.path.join(dst_dir, os.readlink(source))))
# Now we have to decide if we copy the link target or the
# link itself.
if cutoff is None or not link_target.startswith(cutoff):
# We copy
shutil.copy2(source, dest)
else:
# We link
if os.path.exists(dest) or os.path.islink(dest):
os.unlink(dest)
os.symlink(os.readlink(source), dest)
else:
shutil.copy2(source, dest)
def remove_file(source):
"""Remove file or directory."""
if os.path.isdir(source):
shutil.rmtree(source)
elif os.path.isfile(source) or os.path.islink(source):
os.remove(source)
# slugify is adopted from
# http://code.activestate.com/recipes/
# 577257-slugify-make-a-string-usable-in-a-url-or-filename/
_slugify_strip_re = re.compile(r'[^+\w\s-]')
_slugify_hyphenate_re = re.compile(r'[-\s]+')
def slugify(value, lang=None, force=False):
u"""Normalize string, convert to lowercase, remove non-alpha characters, convert spaces to hyphens.
From Django's "django/template/defaultfilters.py".
>>> print(slugify('áéí.óú', lang='en'))
aeiou
>>> print(slugify('foo/bar', lang='en'))
foobar
>>> print(slugify('foo bar', lang='en'))
foo-bar
"""
if lang is None: # TODO: remove in v8
LOGGER.warn("slugify() called without language!")
if not isinstance(value, unicode_str):
raise ValueError("Not a unicode object: {0}".format(value))
if USE_SLUGIFY or force:
# This is the standard state of slugify, which actually does some work.
# It is the preferred style, especially for Western languages.
value = unicode_str(unidecode(value))
value = _slugify_strip_re.sub('', value, re.UNICODE).strip().lower()
return _slugify_hyphenate_re.sub('-', value, re.UNICODE)
else:
# This is the “disarmed” state of slugify, which lets the user
# have any character they please (be it regular ASCII with spaces,
# or another alphabet entirely). This might be bad in some
# environments, and as such, USE_SLUGIFY is better off being True!
# We still replace some characters, though. In particular, we need
# to replace ? and #, which should not appear in URLs, and some
# Windows-unsafe characters. This list might be even longer.
rc = '/\\?#"\'\r\n\t*:<>|'
for c in rc:
value = value.replace(c, '-')
return value
def unslugify(value, lang=None, discard_numbers=True):
"""Given a slug string (as a filename), return a human readable string.
If discard_numbers is True, numbers right at the beginning of input
will be removed.
"""
if lang is None: # TODO: remove in v8
LOGGER.warn("unslugify() called without language!")
if discard_numbers:
value = re.sub('^[0-9]+', '', value)
value = re.sub('([_\-\.])', ' ', value)
value = value.strip().capitalize()
return value
def encodelink(iri):
"""Given an encoded or unencoded link string, return an encoded string suitable for use as a link in HTML and XML."""
iri = unicodenormalize('NFC', iri)
link = OrderedDict(urlparse(iri)._asdict())
link['path'] = urlquote(urlunquote(link['path']).encode('utf-8'), safe="/~")
try:
link['netloc'] = link['netloc'].encode('utf-8').decode('idna').encode('idna').decode('utf-8')
except UnicodeDecodeError:
link['netloc'] = link['netloc'].encode('idna').decode('utf-8')
encoded_link = urlunparse(link.values())
return encoded_link
# A very slightly safer version of zip.extractall that works on
# python < 2.6
class UnsafeZipException(Exception):
"""Exception for unsafe zip files."""
pass
def extract_all(zipfile, path='themes'):
"""Extract all files from a zip file."""
pwd = os.getcwd()
makedirs(path)
os.chdir(path)
z = zipf(zipfile)
namelist = z.namelist()
for f in namelist:
if f.endswith('/') and '..' in f:
raise UnsafeZipException('The zip file contains ".." and is '
'not safe to expand.')
for f in namelist:
if f.endswith('/'):
makedirs(f)
else:
z.extract(f)
z.close()
os.chdir(pwd)
def to_datetime(value, tzinfo=None):
"""Convert string to datetime."""
try:
if not isinstance(value, datetime.datetime):
# dateutil does bad things with TZs like UTC-03:00.
dateregexp = re.compile(r' UTC([+-][0-9][0-9]:[0-9][0-9])')
value = re.sub(dateregexp, r'\1', value)
value = dateutil.parser.parse(value)
if not value.tzinfo:
value = value.replace(tzinfo=tzinfo)
return value
except Exception:
raise ValueError('Unrecognized date/time: {0!r}'.format(value))
def get_tzname(dt):
"""Given a datetime value, find the name of the time zone.
DEPRECATED: This thing returned basically the 1st random zone
that matched the offset.
"""
return dt.tzname()
def current_time(tzinfo=None):
"""Get current time."""
if tzinfo is not None:
dt = datetime.datetime.now(tzinfo)
else:
dt = datetime.datetime.now(dateutil.tz.tzlocal())
return dt
def apply_filters(task, filters, skip_ext=None):
"""Apply filters to a task.
If any of the targets of the given task has a filter that matches,
adds the filter commands to the commands of the task,
and the filter itself to the uptodate of the task.
"""
if '.php' in filters.keys():
if task_filters.php_template_injection not in filters['.php']:
filters['.php'].append(task_filters.php_template_injection)
else:
filters['.php'] = [task_filters.php_template_injection]
def filter_matches(ext):
for key, value in list(filters.items()):
if isinstance(key, (tuple, list)):
if ext in key:
return value
elif isinstance(key, (bytes_str, unicode_str)):
if ext == key:
return value
else:
assert False, key
for target in task.get('targets', []):
ext = os.path.splitext(target)[-1].lower()
if skip_ext and ext in skip_ext:
continue
filter_ = filter_matches(ext)
if filter_:
for action in filter_:
def unlessLink(action, target):
if not os.path.islink(target):
if isinstance(action, Callable):
action(target)
else:
subprocess.check_call(action % target, shell=True)
task['actions'].append((unlessLink, (action, target)))
return task
def get_crumbs(path, is_file=False, index_folder=None, lang=None):
"""Create proper links for a crumb bar.
index_folder is used if you want to use title from index file
instead of folder name as breadcrumb text.
>>> crumbs = get_crumbs('galleries')
>>> len(crumbs)
1
>>> print('|'.join(crumbs[0]))
#|galleries
>>> crumbs = get_crumbs(os.path.join('galleries','demo'))
>>> len(crumbs)
2
>>> print('|'.join(crumbs[0]))
..|galleries
>>> print('|'.join(crumbs[1]))
#|demo
>>> crumbs = get_crumbs(os.path.join('listings','foo','bar'), is_file=True)
>>> len(crumbs)
3
>>> print('|'.join(crumbs[0]))
..|listings
>>> print('|'.join(crumbs[1]))
.|foo
>>> print('|'.join(crumbs[2]))
#|bar
"""
crumbs = path.split(os.sep)
_crumbs = []
if is_file:
for i, crumb in enumerate(crumbs[-3::-1]): # Up to parent folder only
_path = '/'.join(['..'] * (i + 1))
_crumbs.append([_path, crumb])
if len(crumbs) >= 2:
_crumbs.insert(0, ['.', crumbs[-2]]) # file's folder
if len(crumbs) >= 1:
_crumbs.insert(0, ['#', crumbs[-1]]) # file itself
else:
for i, crumb in enumerate(crumbs[::-1]):
_path = '/'.join(['..'] * i) or '#'
_crumbs.append([_path, crumb])
if index_folder and hasattr(index_folder, 'parse_index'):
folder = path
for i, crumb in enumerate(crumbs[::-1]):
if folder[-1] == os.sep:
folder = folder[:-1]
# We don't care about the created Post() object except for its title;
# hence, the input_folder and output_folder given to
# index_folder.parse_index() don't matter
index_post = index_folder.parse_index(folder, '', '')
folder = folder.replace(crumb, '')
if index_post:
crumb = index_post.title(lang) or crumb
_crumbs[i][1] = crumb
return list(reversed(_crumbs))
def get_asset_path(path, themes, files_folders={'files': ''}, themes_dirs=['themes'], output_dir='output'):
"""Return the "real", absolute path to the asset.
By default, it checks which theme provides the asset.
If the asset is not provided by a theme, then it will be checked for
in the FILES_FOLDERS.
If it's not provided by either, it will be chacked in output, where
it may have been created by another plugin.
>>> print(get_asset_path('assets/css/rst.css', ['bootstrap3', 'base']))
/.../nikola/data/themes/base/assets/css/rst.css
>>> print(get_asset_path('assets/css/theme.css', ['bootstrap3', 'base']))
/.../nikola/data/themes/bootstrap3/assets/css/theme.css
>>> print(get_asset_path('nikola.py', ['bootstrap3', 'base'], {'nikola': ''}))
/.../nikola/nikola.py
>>> print(get_asset_path('nikola.py', ['bootstrap3', 'base'], {'nikola': 'nikola'}))