-
Notifications
You must be signed in to change notification settings - Fork 308
/
editor.py
546 lines (450 loc) · 16.7 KB
/
editor.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
import os
import posixpath
import shutil
import warnings
from collections import ChainMap
from collections import OrderedDict
from collections.abc import ItemsView
from collections.abc import KeysView
from collections.abc import Mapping
from collections.abc import MutableMapping
from collections.abc import ValuesView
from contextlib import suppress
from functools import wraps
from itertools import chain
from lektor.constants import PRIMARY_ALT
from lektor.metaformat import serialize
from lektor.utils import atomic_open
from lektor.utils import cleanup_path
from lektor.utils import increment_filename
from lektor.utils import is_valid_id
from lektor.utils import parse_path
from lektor.utils import secure_filename
implied_keys = {"_id", "_path", "_gid", "_alt", "_source_alt", "_attachment_for"}
possibly_implied_keys = {"_model", "_template", "_attachment_type"}
class BadEdit(Exception):
pass
class BadDelete(BadEdit):
pass
def _is_valid_path(path: str) -> bool:
split_path = path.strip("/").split("/")
if split_path == [""]:
split_path = []
return parse_path(path) == split_path
def make_editor_session(pad, path, is_attachment=None, alt=PRIMARY_ALT, datamodel=None):
"""Creates an editor session for the given path object."""
if not _is_valid_path(path):
raise BadEdit("Invalid path")
path = cleanup_path(path)
if alt != PRIMARY_ALT and not pad.db.config.is_valid_alternative(alt):
raise BadEdit("Attempted to edit an invalid alternative (%s)" % alt)
raw_data = pad.db.load_raw_data(path, cls=OrderedDict, alt=alt, fallback=False)
raw_data_fallback = None
if alt != PRIMARY_ALT:
raw_data_fallback = pad.db.load_raw_data(path, cls=OrderedDict)
all_data = OrderedDict()
all_data.update(raw_data_fallback or ())
all_data.update(raw_data or ())
else:
all_data = raw_data
id = posixpath.basename(path)
if not is_valid_id(id):
raise BadEdit("Invalid ID")
record = None
exists = raw_data is not None or raw_data_fallback is not None
if raw_data is None:
raw_data = OrderedDict()
if is_attachment is None:
if not exists:
is_attachment = False
else:
is_attachment = bool(all_data.get("_attachment_for"))
elif bool(all_data.get("_attachment_for")) != is_attachment:
raise BadEdit(
"The attachment flag passed is conflicting with the "
"record's attachment flag."
)
if exists:
# XXX: what about changing the datamodel after the fact?
if datamodel is not None:
raise BadEdit(
"When editing an existing record, a datamodel must not be provided."
)
datamodel = pad.db.get_datamodel_for_raw_data(all_data, pad)
else:
if datamodel is None:
datamodel = pad.db.get_implied_datamodel(path, is_attachment, pad)
elif isinstance(datamodel, str):
datamodel = pad.db.datamodels[datamodel]
if exists:
record = pad.instance_from_data(dict(all_data), datamodel)
for key in implied_keys:
raw_data.pop(key, None)
if raw_data_fallback:
raw_data_fallback.pop(key, None)
return EditorSession(
pad,
id,
str(path),
raw_data,
raw_data_fallback,
datamodel,
record,
exists,
is_attachment,
alt,
)
def _deprecated_data_proxy(wrapped):
"""Issue warning when deprecated mapping methods are used directly on
EditorSession.
"""
name = wrapped.__name__
newname = name[4:] if name.startswith("iter") else name
@wraps(wrapped)
def wrapper(self, *args, **kwargs):
warnings.warn(
f"EditorSession.{name} has been deprecated as of Lektor 3.3.2. "
f"Please use EditorSession.data.{newname} instead.",
DeprecationWarning,
stacklevel=2,
)
return wrapped(self, *args, **kwargs)
return wrapper
class EditorSession:
def __init__(
self,
pad,
id,
path,
original_data,
fallback_data,
datamodel,
record,
exists=True,
is_attachment=False,
alt=PRIMARY_ALT,
):
self.id = id
self.pad = pad
self.path = path
self.record = record
self.exists = exists
self.datamodel = datamodel
self.is_root = path.strip("/") == ""
self.alt = alt
slug_format = None
parent_name = posixpath.dirname(path)
if parent_name != path:
parent = pad.get(parent_name)
if parent is not None:
slug_format = parent.datamodel.child_config.slug_format
if slug_format is None:
slug_format = "{{ this._id }}"
self.slug_format = slug_format
self.implied_attachment_type = None
if is_attachment:
self.implied_attachment_type = pad.db.get_attachment_type(path)
self.data = MutableEditorData(original_data, fallback_data)
self._delete_this = False
self._recursive_delete = False
self._master_delete = False
self.is_attachment = is_attachment
self.closed = False
def to_json(self):
label = None
label_i18n = None
url_path = None
if self.record is not None:
label = self.record.record_label
label_i18n = self.record.get_record_label_i18n()
url_path = self.record.url_path
else:
label = self.id
can_be_deleted = not self.datamodel.protected and not self.is_root
return {
"data": dict(self.data.items()),
"record_info": {
"id": self.id,
"path": self.path,
"exists": self.exists,
"label": label,
"label_i18n": label_i18n,
"url_path": url_path,
"alt": self.alt,
"is_attachment": self.is_attachment,
"can_be_deleted": can_be_deleted,
"slug_format": self.slug_format,
"implied_attachment_type": self.implied_attachment_type,
"default_template": self.datamodel.get_default_template_name(),
},
"datamodel": self.datamodel.to_json(self.pad, self.record, self.alt),
}
def __enter__(self):
return self
def __exit__(self, exc_type, exc_value, tb):
if exc_type is not None:
self.rollback()
else:
self.commit()
def get_fs_path(self, alt=PRIMARY_ALT):
"""The path to the record file on the file system."""
base = self.pad.db.to_fs_path(self.path)
suffix = ".lr"
if alt != PRIMARY_ALT:
suffix = f"+{alt}{suffix}"
if self.is_attachment:
return base + suffix
return os.path.join(base, "contents" + suffix)
@property
def fs_path(self):
"""The file system path of the content file on disk."""
return self.get_fs_path(self.alt)
@property
def attachment_fs_path(self):
"""The file system path of the actual attachment."""
if self.is_attachment:
return self.pad.db.to_fs_path(self.path)
return None
def rollback(self):
"""Ignores all changes and rejects them."""
if self.closed:
return
self.closed = True
def commit(self):
"""Saves changes back to the file system."""
if not self.closed:
if self._delete_this:
self._delete_impl()
else:
self._save_impl()
self.closed = True
def delete(self, recursive=None, delete_master=False):
"""Deletes the record. How the delete works depends on what is being
deleted:
* delete attachment: recursive mode is silently ignored. If
`delete_master` is set then the attachment is deleted, otherwise
only the metadata is deleted.
* delete page: in recursive mode everything is deleted in which
case `delete_master` must be set to `True` or an error is
generated. In fact, the default is to perform a recursive
delete in that case. If `delete_master` is False, then only the
contents file of the current alt is deleted.
If a delete cannot be performed, an error is generated.
"""
if self.closed:
return
if recursive is None:
recursive = not self.is_attachment and delete_master
self._delete_this = True
self._recursive_delete = recursive
self._master_delete = delete_master
def add_attachment(self, filename, fp):
"""Stores a new attachment. Returns `None` if the file already"""
if not self.exists:
raise BadEdit("Record does not exist.")
if self.is_attachment:
raise BadEdit("Cannot attach something to an attachment.")
if not self.datamodel.has_own_attachments:
raise BadEdit("Attachments are disabled for this page.")
directory = self.pad.db.to_fs_path(self.path)
safe_filename = secure_filename(filename)
while 1:
fn = os.path.join(directory, safe_filename)
if not os.path.isfile(fn):
break
safe_filename = increment_filename(fn)
with atomic_open(fn, "wb") as f:
shutil.copyfileobj(fp, f)
return safe_filename
def _attachment_delete_impl(self):
files = [self.fs_path]
if self._master_delete:
files.append(self.attachment_fs_path)
for alt in self.pad.db.config.list_alternatives():
files.append(self.get_fs_path(alt))
for fn in files:
try:
os.unlink(fn)
except OSError:
pass
def _page_delete_impl(self):
directory = os.path.dirname(self.fs_path)
if self._recursive_delete:
with suppress(OSError):
shutil.rmtree(directory)
return
if self._master_delete:
raise BadDelete(
"Master deletes of pages require that recursive deleting is enabled."
)
for fn in self.fs_path, directory:
try:
os.unlink(fn)
except OSError:
pass
def _delete_impl(self):
if self.alt != PRIMARY_ALT:
if self._master_delete:
raise BadDelete(
"Master deletes need to be done from the primary "
'alt. Tried to delete from "%s"' % self.alt
)
if self._recursive_delete:
raise BadDelete(
"Cannot perform recursive delete from a non "
'primary alt. Tried to delete from "%s"' % self.alt
)
if self.is_attachment:
self._attachment_delete_impl()
else:
self._page_delete_impl()
def _save_impl(self):
# When creating a new alt from a primary self.exists is True but
# the file does not exist yet. In this case we want to explicitly
# create it anyways instead of bailing.
if not self.data.ischanged() and self.exists and os.path.exists(self.fs_path):
return
try:
os.makedirs(os.path.dirname(self.fs_path))
except OSError:
pass
with atomic_open(self.fs_path, "wb") as f:
for chunk in serialize(self.data.items(fallback=False), encoding="utf-8"):
f.write(chunk)
def __repr__(self):
return "<{} {!r}{}{}>".format(
self.__class__.__name__,
self.path,
self.alt != PRIMARY_ALT and " alt=%r" % self.alt or "",
not self.exists and " new" or "",
)
# The mapping methods used to access the page data have been moved
# to EditorSession.data.
#
# We have left behind these proxy methods so as not to break any existing
# external code.
@_deprecated_data_proxy
def revert_key(self, key):
self.data.revert_key(key)
@_deprecated_data_proxy
def __contains__(self, key):
return key in self.data
@_deprecated_data_proxy
def __getitem__(self, key):
return self.data[key]
@_deprecated_data_proxy
def __len__(self):
return len(self.data)
@_deprecated_data_proxy
def __iter__(self):
return iter(self.data)
@_deprecated_data_proxy
def items(self, fallback=True):
return self.data.items(fallback)
@_deprecated_data_proxy
def keys(self, fallback=True):
return self.data.keys(fallback)
@_deprecated_data_proxy
def values(self, fallback=True):
return self.data.values(fallback)
@_deprecated_data_proxy
def iteritems(self, fallback=True):
return self.data.items(fallback)
@_deprecated_data_proxy
def iterkeys(self, fallback=True):
return self.data.keys(fallback)
@_deprecated_data_proxy
def itervalues(self, fallback=True):
return self.data.values(fallback)
@_deprecated_data_proxy
def __setitem__(self, key, value):
self.data[key] = value
@_deprecated_data_proxy
def update(self, *args, **kwargs):
self.data.update(*args, **kwargs)
del _deprecated_data_proxy
class EditorData(Mapping):
"""A read-only view of edited data.
This is a chained dict with (possibly) mutated data overlaid on
the original data for the record.
"""
def __init__(self, original_data, fallback_data=None, _changed_data=None):
if _changed_data is None:
_changed_data = {}
self.fallback_data = fallback_data
if fallback_data:
self._orig_data = ChainMap(original_data, fallback_data)
self._data = ChainMap(_changed_data, original_data, fallback_data)
else:
self._orig_data = original_data
self._data = ChainMap(_changed_data, original_data)
@property
def _changed_data(self):
return self._data.maps[0]
@property
def original_data(self):
return self._data.maps[1]
def ischanged(self):
return len(self._changed_data) > 0
def __getitem__(self, key):
rv = self._data.get(key)
if rv is None:
raise KeyError(key)
return rv
def __iter__(self):
data = self._data
fallback_data = self.fallback_data or {}
for key in _uniq(chain(self.original_data, fallback_data, sorted(data))):
if key not in implied_keys:
if data[key] is not None:
yield key
def __len__(self):
data = self._data
return sum(
1 for key in data if key not in implied_keys and data[key] is not None
)
def keys(self, fallback=True): # pylint: disable=arguments-differ
return KeysView(self if fallback else self._without_fallback())
def items(self, fallback=True): # pylint: disable=arguments-differ
return ItemsView(self if fallback else self._without_fallback())
def values(self, fallback=True): # pylint: disable=arguments-differ
return ValuesView(self if fallback else self._without_fallback())
def _without_fallback(self):
"""Return a copy of self, with fallback_data set to None."""
if not self.fallback_data:
return self
return EditorData(self.original_data, _changed_data=self._changed_data)
class MutableEditorData(EditorData, MutableMapping):
"""A mutable view of edited data.
This is a chained dict with (possibly) mutated data overlaid on
the original data for the record.
"""
def __setitem__(self, key, value):
if key in implied_keys:
raise KeyError(f"Can not set implied key {key!r}")
orig_value = self._orig_data.get(key)
if value != orig_value:
self._data[key] = value
elif key in possibly_implied_keys:
# If the key is in the possibly implied key set and set to
# that value, we will set it to changed anyways. This allows
# overriding of such special keys.
self._data[key] = value
else:
self._data.pop(key, None)
def __delitem__(self, key):
if key in implied_keys or self._data.get(key) is None:
raise KeyError(key)
self[key] = None
def revert_key(self, key):
"""Reverts a key to the implied value."""
self._data.pop(key, None)
def _uniq(seq):
"""Return items from iterable in order, skipping items that have already been seen.
The items in ``seq`` must be hashable.
"""
seen = set()
for item in seq:
if item not in seen:
seen.add(item)
yield item