Gitlab is now using https://gitlab.lcsb.uni.lu as it's primary address. Please update your bookmarks. FAQ.

generateIndex.py 6.62 KB
Newer Older
1
import os, re
Laurent Heirendt's avatar
Laurent Heirendt committed
2
from os import path
Laurent Heirendt's avatar
Laurent Heirendt committed
3
from natsort import natsorted
Laurent Heirendt's avatar
Laurent Heirendt committed
4

5 6 7 8 9 10
def line_prepender(filename, line):
    with open(filename, 'r+') as f:
        content = f.read()
        f.seek(0, 0)
        f.write(line.rstrip('\r\n') + '\n' + content)

Jacek Lebioda's avatar
Jacek Lebioda committed
11 12 13 14
def build_link(title, href):
    return f'\t\t\t<li><a href="{href}">{title}</a></li>\n'

def build_section_start(title):
Laurent Heirendt's avatar
Laurent Heirendt committed
15 16

    title = title.replace("Gdpr", "GDPR")
Laurent Heirendt's avatar
Laurent Heirendt committed
17 18
    title = title.replace("Handbook", "PI Handbook")
    title = title.replace("Covid 19", "COVID-19")
Laurent Heirendt's avatar
Laurent Heirendt committed
19

Jacek Lebioda's avatar
Jacek Lebioda committed
20 21 22 23 24
    return f'\n\t<div class="index-box">\n\t\t<h3>{title}</h3>\n\t\t<ul>\n'

def build_section_end():
    return "\t\t</ul>\n\t</div>"

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
def remove_header(localroot, root, filename, n=5):
    nfirstlines = []

    #cwd = os.getcwd()

    os.chdir(localroot)
    #print("Local root folder:" + os.getcwd())

    os.chdir(root)
    #print("Local folder:" + os.getcwd())

    # count the number of lines
    count = 0
    headerCheck = False
    with open(filename, 'r') as f:
        for line in f:
            count += 1

            # check if the header is actually a header
            if (count == 0 or count == n) and line[0:3] == "---":
                headerCheck = True

    # remove the header
    if count > n and headerCheck:
        with open(filename) as f, open("tmp"+filename, "w") as out:
            for _ in range(n):
                nfirstlines.append(next(f))
            for line in f:
                out.write(line)

        os.remove(filename)
        os.rename("tmp"+filename, filename)
57
        print(" - Old header removed.")
58 59 60 61 62 63 64

    # change back to the local root
    os.chdir(localroot)
    #print("exit folder:" + os.getcwd())

# loop through the entire internal tree
localroot = os.getcwd()
65

Laurent Heirendt's avatar
Laurent Heirendt committed
66 67

# generate the index properly speaking
Laurent Heirendt's avatar
Laurent Heirendt committed
68
cardDirs = ["internal", "external", "policies"]
Laurent Heirendt's avatar
Laurent Heirendt committed
69 70 71 72
sections = []

# determine first the directories
for direct in cardDirs:
Laurent Heirendt's avatar
Laurent Heirendt committed
73 74
    if path.isdir(direct):
        dirs = os.listdir(direct)
Laurent Heirendt's avatar
Laurent Heirendt committed
75
        dirs = natsorted(dirs)
Laurent Heirendt's avatar
Laurent Heirendt committed
76

Laurent Heirendt's avatar
Laurent Heirendt committed
77 78 79
        for d in dirs:
            if d[0] != ".":
                sections.append(d)
Laurent Heirendt's avatar
Laurent Heirendt committed
80

Laurent Heirendt's avatar
Laurent Heirendt committed
81
sections = list(set(sections))
Laurent Heirendt's avatar
Laurent Heirendt committed
82
sections = natsorted(sections)
Laurent Heirendt's avatar
Laurent Heirendt committed
83

Jacek Lebioda's avatar
Jacek Lebioda committed
84
# Index contains the generated content, init it with an empty container
Jacek Lebioda's avatar
Jacek Lebioda committed
85
index = ''
Jacek Lebioda's avatar
Jacek Lebioda committed
86 87
index += '\n<div class="index-box-container">\n'

Laurent Heirendt's avatar
Laurent Heirendt committed
88 89 90
localIndexArr = [[]] * len(sections)
for folder in cardDirs:

Laurent Heirendt's avatar
Laurent Heirendt committed
91 92 93
    # check if folder exists
    if path.isdir(folder):
        dirs = os.listdir(folder)
Laurent Heirendt's avatar
Laurent Heirendt committed
94
        dirs = natsorted(dirs)
Laurent Heirendt's avatar
Laurent Heirendt committed
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

        for d in dirs:
            if d[0] != ".":
                # set the header of the section
                #index += "\n### " + d.replace("-", " ").capitalize() + "\n"


                # get the index of the section
                indexS = sections.index(d)

                #print(indexS)
                if len(localIndexArr[indexS]) == 0:
                    localIndexArr[indexS] = ["\n"]

                # walk through the folders with all the cards
                for root, dirs, files in os.walk(folder+"/"+d):
                    for file in files:
                        if file.endswith(".md"):
                            fileName = os.path.join(root, file)

                            # ignore subsections (.md files that start with _)
                            if file[0] != "_":
                                print(" > Generating header for: " + fileName)

                                # remove the previous header
                                remove_header(localroot, root, file, 8)

                                # generate a permalink
                                permalink = "/" + root + "/"

                                # generate the shortcut
                                shortcut = re.sub(folder, '', root)

                                # remove the first /
                                shortcut = shortcut[1:]

                                # replace the / with a :
                                shortcut = re.sub('/', ':', shortcut)

                                # define the header for each card
                                header = "---\n"
                                header += "layout: page\n"
                                header += "permalink: " + permalink + "\n"
                                header += "shortcut: " + shortcut + "\n"
                                header += "redirect_from:\n"
                                header += "  - /cards/" + shortcut + "\n"
141
                                header += "  - /" + folder + "/cards/" + shortcut + "\n"
Laurent Heirendt's avatar
Laurent Heirendt committed
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
                                header += "---"

                                # add the header properly speaking
                                line_prepender(fileName, header)

                                # open file and get the title after the header
                                count = 0
                                title = ""
                                bp = 9
                                with open(fileName, 'r') as f:
                                    for line in f:
                                        count += 1
                                        if count == bp:
                                            if len(line) > 2:
                                                title = line
                                                break
                                            else:
                                                bp += 1

                                # remove first and last chars
                                title = title.rstrip("\n\r")
                                title = title[2:]

Jacek Lebioda's avatar
Jacek Lebioda committed
165
                                localIndexArr[indexS].append(build_link(title, root))
Laurent Heirendt's avatar
Laurent Heirendt committed
166 167 168 169 170 171

                                # output
                                print(" + New header added.")
                                print("-----------------------")

                # join all subcategories to the index
Laurent Heirendt's avatar
Laurent Heirendt committed
172
                localIndexArr[indexS] = natsorted(localIndexArr[indexS])
Laurent Heirendt's avatar
Laurent Heirendt committed
173 174 175 176 177 178

print(localIndexArr)

# determine the index
k = 0
for s in sections:
Jacek Lebioda's avatar
Jacek Lebioda committed
179
    index += build_section_start(s.replace("-", " ").capitalize())
Laurent Heirendt's avatar
Laurent Heirendt committed
180
    index += ''.join(localIndexArr[k])
Jacek Lebioda's avatar
Jacek Lebioda committed
181
    index += build_section_end()
Laurent Heirendt's avatar
Laurent Heirendt committed
182
    k += 1
Laurent Heirendt's avatar
Laurent Heirendt committed
183

Jacek Lebioda's avatar
Jacek Lebioda committed
184 185 186
# Close the container
index += "\n</div>"

187
# output the index
Laurent Heirendt's avatar
Laurent Heirendt committed
188 189 190
#print(index)
# Read in the file
indexFile = "index.md"
191
filedata = ""
Laurent Heirendt's avatar
Laurent Heirendt committed
192
with open(indexFile, 'r') as file :
193 194 195 196 197 198 199
    for line in file:
        filedata += line

        # stop reading once the index place holder has been reached
        if re.search("<!-- index -->", line):
            filedata += "[[ index ]]"
            break
Laurent Heirendt's avatar
Laurent Heirendt committed
200 201 202 203 204 205

# Replace the target string
filedata = filedata.replace('[[ index ]]', index)

# Write the file out again
with open(indexFile, 'w') as file:
Laurent Heirendt's avatar
Laurent Heirendt committed
206 207
  file.write(filedata)

Jacek Lebioda's avatar
Jacek Lebioda committed
208
print("\n > New index generated and saved in " + indexFile)