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
|
from __future__ import annotations
import json
import re
import subprocess
from os.path import relpath
from pathlib import Path, PurePosixPath, PureWindowsPath
from jinja2 import Environment, FileSystemLoader, Template
from sphinx.builders import Builder
from sphinx.builders.dirhtml import DirectoryHTMLBuilder
from sphinx.builders.html import StandaloneHTMLBuilder
from sphinx.builders.linkcheck import CheckExternalLinksBuilder
from sphinx.errors import ExtensionError
from sphinx.util import logging
from sphinx.util.console import green, red, yellow # pylint: disable=no-name-in-module
TYPE_CHECKING = False
if TYPE_CHECKING:
from sphinx.application import Sphinx
from sphinx.util.typing import ExtensionMetadata
__version__ = '0.3.0'
version_info = (0, 3, 0)
logger = logging.getLogger(__name__)
DEFAULT_REDIRAFFE_TEMPLATE = Template(
"""
<html>
<head>
<noscript>
<meta http-equiv="refresh" content="0; url={{rel_url}}"/>
</noscript>
</head>
<body>
<script>
window.location.href = '{{rel_url}}' + (window.location.search || '') + (window.location.hash || '');
</script>
<p>You should have been redirected.</p>
<a href="{{rel_url}}">If not, click here to continue.</a>
</body>
</html>
"""
)
REDIRECT_JSON_NAME = '_rediraffe_redirected.json'
RE_OBJ = re.compile(r"(?:(\"|')(.*?)\1|(\S+))\s+(?:(\"|')(.*?)\4|(\S+))")
READTHEDOCS_BUILDERS = ['readthedocs', 'readthedocsdirhtml']
def create_graph(path: Path) -> dict[str, str]:
"""
Convert a file containing a whitespace delimited edge list (key value pairs) to a dict. Throws error on duplicate keys.
"""
graph_edges = {}
broken = False
with path.open(encoding='utf-8') as file:
lines = file.readlines()
for line_num, line in enumerate(lines, start=1):
line = line.strip()
if len(line) == 0 or line.startswith('#'):
continue
match = RE_OBJ.fullmatch(line)
if match is None:
logger.error(
red(f'rediraffe: line {line_num} of the redirects is invalid!')
)
broken = True
continue
edge_from = match.group(2) or match.group(3)
edge_to = match.group(5) or match.group(6)
if edge_from in graph_edges:
# Duplicate vertices not allowed / Vertices can only have 1 outgoing edge
logger.error(
red(
f'rediraffe: {edge_from} is redirected multiple times in the rediraffe_redirects file!'
)
)
broken = True
graph_edges[edge_from] = edge_to
if broken:
err_msg = 'rediraffe: Error(s) in parsing the redirects file.'
logger.error(err_msg)
raise ExtensionError(err_msg)
return graph_edges
def create_simple_redirects(graph_edges: dict) -> dict:
"""
Ensures that a graph is a acyclic and reconnects every vertex to its leaf vertex.
"""
redirects = {}
broken_vertices = set()
for vertex in graph_edges:
if vertex in broken_vertices:
continue
visited = []
while vertex in graph_edges:
if vertex in visited:
# Ensure graph is a DAG
logger.error(
red(
'rediraffe: A circular redirect exists. Links involved: '
+ ' -> '.join(visited + [vertex])
)
)
broken_vertices.update(visited)
break
visited.append(vertex)
vertex = graph_edges[vertex]
# vertex is now a leaf
for visited_vertex in visited:
redirects[visited_vertex] = vertex
if broken_vertices:
err_msg = (
'rediraffe: At least 1 circular redirect detected. All involved links: '
+ ', '.join(broken_vertices)
)
logger.error(err_msg)
raise ExtensionError(err_msg)
return redirects
def remove_suffix(docname: str, suffixes: list[str]) -> str:
"""Remove any known suffixes for a file path."""
for suffix in suffixes:
if docname.endswith(suffix):
return docname[: -len(suffix)]
return docname
def build_redirects(app: Sphinx, exception: Exception | None) -> None:
"""
Build amd write redirects
"""
redirect_json_file = Path(app.outdir) / REDIRECT_JSON_NAME
if redirect_json_file.exists():
redirect_record = json.loads(redirect_json_file.read_bytes())
else:
redirect_record = {}
if exception is not None:
return
if isinstance(app.builder, CheckExternalLinksBuilder):
logger.info('rediraffe: Redirect generation skipped for linkcheck builders.')
return
if (
type(app.builder) not in (StandaloneHTMLBuilder, DirectoryHTMLBuilder)
and app.builder.name not in READTHEDOCS_BUILDERS
):
logger.info(
'rediraffe: Redirect generation skipped for unsupported builders. Supported builders: html, dirhtml, readthedocs, readthedocsdirhtml.'
)
return
rediraffe_template = app.config.rediraffe_template
if isinstance(rediraffe_template, str):
# path
template_path = Path(app.srcdir) / rediraffe_template
if template_path.exists():
file_loader = FileSystemLoader(template_path.parent)
env = Environment(loader=file_loader)
rediraffe_template = env.get_template(template_path.name)
else:
logger.warning(
'rediraffe: rediraffe_template does not exist. The default will be used.'
)
rediraffe_template = DEFAULT_REDIRAFFE_TEMPLATE
else:
rediraffe_template = DEFAULT_REDIRAFFE_TEMPLATE
graph_edges = {}
rediraffe_redirects = app.config.rediraffe_redirects
if isinstance(rediraffe_redirects, dict):
# dict in conf.py
graph_edges = rediraffe_redirects
elif isinstance(rediraffe_redirects, str):
# filename
path = Path(app.srcdir) / rediraffe_redirects
if not path.is_file():
logger.error(
red(
'rediraffe: rediraffe_redirects file does not exist. Redirects will not be generated.'
)
)
app.statuscode = 1
return
try:
graph_edges = create_graph(path)
except ExtensionError as e:
app.statuscode = 1
raise e
else:
logger.warning(
'rediraffe: rediraffe was not given redirects to process. Redirects will not be generated.'
)
return
try:
redirects = create_simple_redirects(graph_edges)
except ExtensionError as e:
app.statuscode = 1
raise e
logger.info('Writing redirects...')
# write redirects
for src_redirect_from, src_redirect_to in redirects.items():
# Normalize path - src_redirect_.* is relative so drive letters aren't an issue.
src_redirect_from = Path(PureWindowsPath(src_redirect_from))
src_redirect_to = Path(PureWindowsPath(src_redirect_to))
# remove extensions
redirect_from_name = remove_suffix(
src_redirect_from.name, app.config.source_suffix
)
redirect_to_name = remove_suffix(src_redirect_to.name, app.config.source_suffix)
redirect_from = src_redirect_from.parent / f'{redirect_from_name}.html'
redirect_to = src_redirect_to.parent / f'{redirect_to_name}.html'
if type(app.builder) is DirectoryHTMLBuilder:
if redirect_from_name != 'index':
redirect_from = (
src_redirect_from.parent / redirect_from_name / 'index.html'
)
if redirect_to_name != 'index':
redirect_to = src_redirect_to.parent / redirect_to_name / 'index.html'
# absolute paths into the build dir
build_redirect_from = Path(app.outdir) / redirect_from
build_redirect_to = Path(app.outdir) / redirect_to
if (
build_redirect_from.exists()
and src_redirect_from.as_posix() in redirect_record
):
# if it is still pointing to the same source, continue
if (
redirect_record[src_redirect_from.as_posix()]
== src_redirect_to.as_posix()
):
continue
# otherwise remove and rewrite
build_redirect_from.unlink()
if build_redirect_from.exists():
logger.warning(
'%s %s redirects to %s but %s already exists!',
yellow('(broken)'),
redirect_from,
redirect_to,
build_redirect_from,
)
app.statuscode = 1
continue
if not build_redirect_to.exists():
logger.warning(
'%s %s redirects to %s but %s does not exist!',
yellow('(broken)'),
redirect_from,
redirect_to,
build_redirect_to,
)
app.statuscode = 1
continue
build_redirect_from.parent.mkdir(parents=True, exist_ok=True)
with build_redirect_from.open('w', encoding='utf-8') as f:
f.write(
rediraffe_template.render(
rel_url=str(
PurePosixPath(
PureWindowsPath(
relpath(build_redirect_to, build_redirect_from.parent)
)
)
),
from_file=src_redirect_from,
to_file=src_redirect_to,
from_url=redirect_from,
to_url=redirect_to,
)
)
logger.info(
'%s %s %s %s', green('(good)'), redirect_from, green('-->'), redirect_to
)
redirect_record[src_redirect_from.as_posix()] = src_redirect_to.as_posix()
redirect_json_file.write_text(json.dumps(redirect_record), encoding='utf8')
class CheckRedirectsDiffBuilder(Builder):
name = 'rediraffecheckdiff'
def init(self) -> None:
super().init()
source_suffixes = set(self.app.config.source_suffix)
src_path = Path(self.app.srcdir)
rediraffe_redirects = self.app.config.rediraffe_redirects
redirects_path = None
if isinstance(rediraffe_redirects, dict):
pass
elif isinstance(rediraffe_redirects, str):
redirects_path = Path(src_path) / rediraffe_redirects
if not redirects_path.is_file():
logger.error(red('rediraffe: rediraffe_redirects file does not exist.'))
self.app.statuscode = 1
return
try:
rediraffe_redirects = create_graph(redirects_path)
except ExtensionError:
self.app.statuscode = 1
return
else:
logger.error('rediraffe: rediraffe was not given redirects to process.')
self.app.statuscode = 1
return
absolute_redirects = {
(src_path / redirect_from).resolve(): (src_path / redirect_to).resolve()
for redirect_from, redirect_to in rediraffe_redirects.items()
}
path_to_git_repo = subprocess.check_output(
('git', 'rev-parse', '--show-toplevel'),
cwd=self.app.srcdir,
encoding='utf-8',
)
def abs_path_in_src_dir_w_src_suffix(filename: str) -> Path | None:
abs_path = (Path(path_to_git_repo.strip()) / filename.strip()).resolve()
if not str(abs_path).startswith(str(src_path)):
return None
if abs_path.suffix not in source_suffixes:
return None
return abs_path
# run git diff
cmd = ('git', 'diff', '--name-status', '--diff-filter=R')
if rediraffe_branch := self.app.config.rediraffe_branch:
cmd += (rediraffe_branch.strip(),)
renamed_files_out = subprocess.check_output(
cmd, cwd=self.app.srcdir, encoding='utf-8'
).splitlines()
rename_hints = {}
for line in renamed_files_out:
line = line.strip()
r_perc, rename_from, rename_to = re.split(r'\t', line)
perc = int(r_perc[1:])
path_rename_from = abs_path_in_src_dir_w_src_suffix(rename_from)
path_rename_to = abs_path_in_src_dir_w_src_suffix(rename_to)
if path_rename_from is None:
continue
if path_rename_to is None:
continue
rename_hints[path_rename_from] = (path_rename_to, perc)
# run git diff
cmd = ('git', 'diff', '--diff-filter=D', '--name-only')
if rediraffe_branch := self.app.config.rediraffe_branch:
cmd += (rediraffe_branch.strip(),)
deleted_files = subprocess.check_output(
cmd, cwd=self.app.srcdir, encoding='utf-8'
).splitlines()
# to absolute path + filter out
deleted_files = [
abs_path_in_src_dir_w_src_suffix(filename) for filename in deleted_files
]
deleted_files = list(filter(lambda x: x is not None, deleted_files))
for deleted_file in deleted_files:
if deleted_file in absolute_redirects:
logger.info(
'deleted file %s redirects to %s.',
deleted_file,
absolute_redirects[deleted_file],
)
else:
err_msg = f'{red("(broken)")} {deleted_file} was deleted but is not redirected!'
logger.error(err_msg)
self.app.statuscode = 1
for renamed_file in rename_hints:
hint_to, perc = rename_hints[renamed_file]
if renamed_file in absolute_redirects:
logger.info(
'renamed file %s redirects to %s.',
renamed_file,
absolute_redirects[renamed_file],
)
continue
if self.name == 'rediraffewritediff':
if perc >= self.app.config.rediraffe_auto_redirect_perc:
rel_rename_from = (
f'"{str(PurePosixPath(renamed_file.relative_to(src_path)))}"'
)
rel_rename_to = (
f'"{str(PurePosixPath(hint_to.relative_to(src_path)))}"'
)
with redirects_path.open('a', encoding='utf-8') as redirects_file:
redirects_file.write(f'{rel_rename_from} {rel_rename_to}\n')
logger.info(
'%s Renamed file %s has been redirected to %s in your redirects file!',
green('(okay)'),
rel_rename_from,
rel_rename_to,
)
continue
err_msg = (
f'{red("(broken)")} {renamed_file} was deleted but is not redirected!'
f' Hint: This file was renamed to {hint_to} with a similarity of {perc}%.'
)
logger.error(err_msg)
self.app.statuscode = 1
def get_outdated_docs(self):
return []
def prepare_writing(self=None, docnames=None):
pass
def write_doc(self, docname=None, doctree=None):
pass
def get_target_uri(self, docname=None, typ=None):
return ''
def read(self):
return []
class WriteRedirectsDiffBuilder(CheckRedirectsDiffBuilder):
name = 'rediraffewritediff'
def init(self) -> None:
rediraffe_redirects = self.app.config.rediraffe_redirects
if not isinstance(rediraffe_redirects, str):
logger.error(
'%s Automatic redirects is only available with a redirects file.',
red('(broken)'),
)
self.app.statuscode = 1
return
super().init()
def setup(app: Sphinx) -> ExtensionMetadata:
app.add_config_value('rediraffe_redirects', None, None)
app.add_config_value('rediraffe_branch', '', None)
app.add_config_value('rediraffe_template', None, None)
app.add_config_value('rediraffe_auto_redirect_perc', 100, None)
app.add_builder(CheckRedirectsDiffBuilder)
app.add_builder(WriteRedirectsDiffBuilder)
app.connect('build-finished', build_redirects)
return {
'version': __version__,
'env_version': 1,
'parallel_read_safe': True,
'parallel_write_safe': True,
}
|
