StatProofBookTools/report_links.py at master · StatProofBook/StatProofBookTools · GitHub

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
#!/usr/bin/env python
"""
Report dead links in the StatProofBook
_
This script loads all content from the proof and definition directories and
lists proof and definition pages which are referenced but non-existing.

Author: Joram Soch, BCCN Berlin
E-Mail: joram.soch@bccn-berlin.de

First edit: 2020-04-14 06:27:00
 Last edit: 2020-08-26 15:48:00
"""


# Import modules
#-----------------------------------------------------------------------------#
import os
import BookTools as spbt
from datetime import datetime
from shutil import copyfile

# Set repository directory
#-----------------------------------------------------------------------------#
rep_dir = spbt.get_rep_dir('offline')

# Prepare page references
#-----------------------------------------------------------------------------#
filenames = []                  # list of referenced files
linktexts = []                  # list of reference texts
srcefiles = []                  # list of files referenced from

# Browse through proofs
#-----------------------------------------------------------------------------#
files = os.listdir(rep_dir + '/P/')
for file in files:
    if '.md' in file:

        # Read proof file
        #---------------------------------------------------------------------#
        file_obj = open(rep_dir + '/P/' + file, 'r')
        file_txt = file_obj.readlines()
        file_obj.close()

        # Search proof body
        #---------------------------------------------------------------------#
        body_txt = spbt.extract_body(file_txt)
        for line in body_txt:
            while line.find('](/') > -1:
                # get bracket/parantheses indices
                i2 = line.find('](/')
                i3 = i2 + 1
                i4 = line.find(')', i2)
                i1 = line.rfind('[', 0, i2)
                # get shortcut/filename
                file_md  = line[i3+1:i4] + '.md'
                linktext = line[i1+1:i2]
                # if file does not exist
                if not os.path.isfile(rep_dir + file_md):
                    filenames.append(file_md)
                    linktexts.append(linktext)
                    srcefiles.append('/P/'+file)
                # shorten the file line
                line = line[i4+1:]

# Browse through definitions
#-----------------------------------------------------------------------------#
files = os.listdir(rep_dir + '/D/')
for file in files:
    if '.md' in file:

        # Read proof file
        #---------------------------------------------------------------------#
        file_obj = open(rep_dir + '/D/' + file, 'r')
        file_txt = file_obj.readlines()
        file_obj.close()

        # Search proof body
        #---------------------------------------------------------------------#
        body_txt = spbt.extract_body(file_txt)
        for line in body_txt:
            while line.find('](/') > -1:
                # get bracket/parantheses indices
                i2 = line.find('](/')
                i3 = i2 + 1
                i4 = line.find(')', i2)
                i1 = line.rfind('[', 0, i2)
                # get shortcut/filename
                file_md  = line[i3+1:i4] + '.md'
                linktext = line[i1+1:i2]
                # if file does not exist
                if not os.path.isfile(rep_dir + file_md):
                    filenames.append(file_md)
                    linktexts.append(linktext)
                    srcefiles.append('/D/'+file)
                # shorten the file line
                line = line[i4+1:]

# Prepare unique references
#-----------------------------------------------------------------------------#
unique_filenames = []           # list of unique referenced files
unique_linktexts = []           # list of unique reference texts
unique_srcefiles = []           # list of unique files referenced from

# Browse through references
#-----------------------------------------------------------------------------#
sort_ind  = [i for (v, i) in sorted([(v, i) for (i, v) in enumerate(filenames)])]
last_file = 'last_file'
ults = False
for i in range(0,len(filenames)):
    filename = filenames[sort_ind[i]]
    if filename != last_file:
        if ults:
            unique_filenames.append(last_file)
            unique_linktexts.append(sorted(ults))
        ults = []
        ults.append(linktexts[sort_ind[i]])
    else:
        if linktexts[sort_ind[i]] not in ults:
            ults.append(linktexts[sort_ind[i]])
    last_file = filename
unique_filenames.append(last_file)
unique_linktexts.append(sorted(ults))

# Extract source files
#-----------------------------------------------------------------------------#
for i in range(0,len(unique_filenames)):                # filenames
    usfs_i = []
    for j in range(0,len(unique_linktexts[i])):         # link texts
        usfs_j = []
        for k in range(0,len(srcefiles)):               # source files
            if filenames[k] == unique_filenames[i] and linktexts[k] == unique_linktexts[i][j] and srcefiles[k] not in usfs_j:
                usfs_j.append(srcefiles[k])
        usfs_i.append(sorted(usfs_j))
    unique_srcefiles.append(usfs_i)

# Open protocol file
#-----------------------------------------------------------------------------#
today_day = datetime.now().strftime('%Y_%m_%d')
today_now = datetime.now().strftime('%Y-%m-%d, %H:%M')
protocol  = open('report_links/Dead_Links_' + today_day + '.txt', 'w')

# Display non-existing pages
#-----------------------------------------------------------------------------#
print('\n-> Pages which are referenced but non-existing:')
protocol.write('-> Pages which are referenced but non-existing (' + today_now + '):\n')
for i in range(0,len(unique_filenames)):
    filename = unique_filenames[i]
    shortcut = filename[3:-3]
    if filename.find('/P/') > -1:
        protocol.write('   - Proof "' + shortcut + '" ("' + filename[0:-3] + '"), referenced as\n')
    if filename.find('/D/') > -1:
        protocol.write('   - Definition "' + shortcut + '" ("' + filename[0:-3] + '"), referenced as\n')
    for j in range(0,len(unique_linktexts[i])):
        linktext = unique_linktexts[i][j]
        protocol.write('     - "' + linktext + '", referenced in\n')
        for k in range(0,len(unique_srcefiles[i][j])):
            srcefile = unique_srcefiles[i][j][k]
            protocol.write('       - "' + srcefile[0:-3] + '"\n')

# Close protocol file
#-----------------------------------------------------------------------------#
protocol.close()
print('   - written into "' + protocol.name + '"')
copyfile('report_links/Dead_Links_' + today_day + '.txt', 'report_links/Dead_Links.txt')