Shamusworld >> Repos - ardour-manual/blob - build.py

   1 #!/usr/bin/python3
   2 #
   3 # Script to take the master document and ancillary files and create the
   4 # finished manual/website.
   5 #
   6 # by James Hammons
   7 # (C) 2017 Underground Software
   8 #
   9
  10 # Remnants (could go into the master document as the first header)
  11
  12 #bootstrap_path: /bootstrap-3.3.7
  13 #page_title: The Ardour Manual
  14
  15 import os
  16 import re
  17 import shutil
  18 import argparse
  19
  20
  21 # Global vars
  22 # This matches all *non* letter/number, ' ', '.', '-', and '_' chars
  23 cleanString = re.compile(r'[^a-zA-Z0-9 \._-]+')
  24 # This matches new 'unbreakable' links, up to the closing quote or anchor
  25 findLinks = re.compile(r'"@@[^#"]*[#"]')
  26 githuburl = 'https://github.com/Ardour/manual/edit/master/include/'
  27
  28 #
  29 # Create an all lowercase filename without special characters and with spaces
  30 # replaced with dashes.
  31 #
  32 def MakeFilename(s):
  33         global cleanString
  34         # Clean up the file name, removing all non letter/number or " .-_" chars.
  35         # Also, convert to lower case and replace all spaces with dashes.
  36         fn = cleanString.sub('', s).lower().replace(' ', '-')
  37         # Double dashes can creep in from the above replacement, so we check for
  38         # that here.
  39         fn = fn.replace('--', '-')
  40
  41         return fn
  42
  43
  44 #
  45 # Parse headers into a dictionary
  46 #
  47 def ParseHeader(fileObj):
  48         header = {}
  49
  50         while (True):
  51                 hdrLine = fileObj.readline().rstrip('\r\n')
  52
  53                 # Break out of the loop if we hit the end of header marker
  54                 if hdrLine.startswith('---'):
  55                         break
  56
  57                 # Check to see that we have a well-formed header construct
  58                 match = re.findall(': ', hdrLine)
  59
  60                 if match:
  61                         # Parse out foo: bar pairs & put into header dictionary
  62                         a = re.split(': ', hdrLine, 1)
  63                         header[a[0]] = a[1]
  64
  65         return header
  66
  67
  68 #
  69 # Turn a "part" name into an int
  70 #
  71 def PartToLevel(s):
  72         level = -1
  73
  74         if s == 'part':
  75                 level = 0
  76         elif s == 'chapter':
  77                 level = 1
  78         elif s == 'subchapter':
  79                 level = 2
  80         elif s == 'section':
  81                 level = 3
  82         elif s == 'subsection':
  83                 level = 4
  84
  85         return level
  86
  87 #
  88 # Converts a integer to a roman number
  89 #
  90 def num2roman(num):
  91         num_map = [(1000, 'M'), (900, 'CM'), (500, 'D'), (400, 'CD'), (100, 'C'), (90, 'XC'), (50, 'L'), (40, 'XL'), (10, 'X'), (9, 'IX'), (5, 'V'), (4, 'IV'), (1, 'I')]
  92         roman = ''
  93
  94         while num > 0:
  95                 for i, r in num_map:
  96                         while num >= i:
  97                                 roman += r
  98                                 num -= i
  99
 100         return roman
 101
 102 #
 103 # Capture the master document's structure (and content, if any) in a list
 104 #
 105 def GetFileStructure():
 106         fs = []
 107         fnames = [None]*6
 108         content = ''
 109         grab = False
 110         mf = open('master-doc.txt')
 111
 112         for ln in mf:
 113                 if ln.startswith('---'):
 114                         # First, stuff any content that we may have read into the current
 115                         # header's dictionary
 116                         if grab:
 117                                 fs[-1]['content'] = content
 118                                 grab = False
 119                                 content = ''
 120
 121                         # Then, get the new header and do things to it
 122                         hdr = ParseHeader(mf)
 123                         level = PartToLevel(hdr['part'])
 124                         hdr['level'] = level
 125                         fnames[level] = MakeFilename(hdr['title'])
 126
 127                         # Ickyness--user specified URIs
 128                         if 'uri' in hdr:
 129                                 hdr['filename'] = hdr['uri']
 130                         else:
 131                                 fullName = ''
 132
 133                                 for i in range(level + 1):
 134                                         fullName = fullName + fnames[i] + '/'
 135
 136                                 # Strip trailing '/' on filename
 137                                 hdr['filename'] = fullName[:-1]
 138
 139                         fs.append(hdr)
 140
 141                         if ('include' not in hdr) and (level > 0):
 142                                 grab = True
 143                 else:
 144                         if grab:
 145                                 content = content + ln
 146
 147         # Catch the last file, since it would be missed above
 148         if grab:
 149                 fs[-1]['content'] = content
 150
 151         mf.close()
 152         return fs
 153
 154
 155 #
 156 # Determine if a particular node has child nodes
 157 #
 158 def HaveChildren(fs, pos):
 159         # If we're at the end of the list, there can be no children
 160         if pos == len(fs) - 1:
 161                 return False
 162
 163         # If the next node is at a lower level than the current node, we have
 164         # children.
 165         if fs[pos]['level'] < fs[pos + 1]['level']:
 166                 return True
 167
 168         # Otherwise, no children at this node.
 169         return False
 170
 171
 172 #
 173 # Get the children at this level, and return them in a list
 174 #
 175 def GetChildren(fs, pos):
 176         children = []
 177         pos = pos + 1
 178         childLevel =  fs[pos]['level']
 179
 180         while fs[pos]['level'] >= childLevel:
 181                 if fs[pos]['level'] == childLevel:
 182                         children.append(pos)
 183
 184                 pos = pos + 1
 185
 186                 # Sanity check
 187                 if pos == len(fs):
 188                         break
 189
 190         return children
 191
 192
 193 #
 194 # Get the parent at this level
 195 #
 196 def GetParent(fs, pos):
 197         thisLevel =  fs[pos]['level']
 198         pos = pos - 1
 199
 200         while pos >= 0 and fs[pos]['level'] >= thisLevel:
 201                 pos = pos - 1
 202
 203         return pos
 204
 205
 206 #
 207 # Creates the BreadCrumbs
 208 #
 209 def GetBreadCrumbs(fs, pos):
 210         # The <span class="divider">&gt;</span> is for Bootstrap pre-3.0
 211         breadcrumbs = '<li class="active">'+ fs[pos]['title'] + '</li>'
 212
 213         while pos >= 0:
 214                 pos = GetParent(fs, pos)
 215
 216                 if pos >= 0:
 217                         breadcrumbs='<li><a href="/' + fs[pos]['filename'] + '/">'+ fs[pos]['title'] + '</a></li>'+ breadcrumbs
 218
 219         breadcrumbs = '<ul class="breadcrumb"><li><a href="/toc/index.html">Home</a></li>' + breadcrumbs + '</ul>'
 220         return breadcrumbs
 221
 222
 223 #
 224 # Make an array of children attached to each node in the file structure
 225 # (It's a quasi-tree structure, and can be traversed as such.)
 226 #
 227 def FindChildren(fs):
 228         childArray = []
 229
 230         for i in range(len(fs)):
 231                 if HaveChildren(fs, i):
 232                         childArray.append(GetChildren(fs, i))
 233                 else:
 234                         childArray.append([])
 235
 236         return childArray
 237
 238
 239 #
 240 # Make an array of the top level nodes in the file structure
 241 #
 242 def FindTopLevelNodes(fs):
 243         level0 = []
 244
 245         for i in range(len(fs)):
 246                 if fs[i]['level'] == 0:
 247                         level0.append(i)
 248
 249         return level0
 250
 251
 252 #
 253 # Find all header links and create a dictionary out of them
 254 #
 255 def FindInternalLinks(fs):
 256         linkDict = {}
 257
 258         for hdr in fs:
 259                 if 'link' in hdr:
 260                         linkDict['"@@' + hdr['link'] + '"'] = '"/' + hdr['filename'] + '/"'
 261                         linkDict['"@@' + hdr['link'] + '#'] = '"/' + hdr['filename'] + '/index.html#'
 262
 263         return linkDict
 264
 265
 266 #
 267 # Internal links are of the form '@@link-name', which are references to the
 268 # 'link:' field in the part header. We have to find all occurrences and replace
 269 # them with the appropriate link.
 270 #
 271 def FixInternalLinks(links, content, title):
 272         global findLinks
 273         match = findLinks.findall(content)
 274         missing = []
 275
 276         if len(match) > 0:
 277                 for s in match:
 278                         if s in links:
 279                                 content = content.replace(s, links[s])
 280                         else:
 281                                 missing.append(s)
 282
 283         # Report missing link targets to the user (if any)
 284         if len(missing) > 0:
 285                 print('\nMissing link target' + ('s' if len(missing) > 1 else '') + ' in "' + title + '":')
 286
 287                 for s in missing:
 288                         print('  ' + s)
 289
 290                 print()
 291
 292         return content
 293
 294
 295 #
 296 # Recursively build a list of links based on the location of the page we're
 297 # looking at currently
 298 #
 299 def BuildList(lst, fs, pagePos, cList):
 300         content = '\n\n<dl>\n'
 301
 302         for i in range(len(lst)):
 303                 curPos = lst[i]
 304                 nextPos = lst[i + 1] if i + 1 < len(lst)  else len(fs)
 305
 306                 active = ' class=active' if curPos == pagePos else ''
 307                 menuTitle = fs[curPos]['menu_title'] if 'menu_title' in fs[curPos] else fs[curPos]['title']
 308                 content = content + '<dt' + active + '><a href="/' + fs[curPos]['filename'] + '/">' + menuTitle + '</a></dt><dd' + active + '>'
 309
 310                 # If the current page is our page, and it has children, enumerate them
 311                 if curPos == pagePos:
 312                         if len(cList[curPos]) > 0:
 313                                 content = content + BuildList(cList[curPos], fs, -1, cList)
 314
 315                 # Otherwise, if our page lies between the current one and the next,
 316                 # build a list of links from those nodes one level down.
 317                 elif (pagePos > curPos) and (pagePos < nextPos):
 318                         content = content + BuildList(cList[curPos], fs, pagePos, cList)
 319
 320                 content = content + '</dd>\n'
 321
 322         content = content + '</dl>\n'
 323
 324         return content
 325
 326 #
 327 # Create link sidebar given a position in the list.
 328 #
 329 def CreateLinkSidebar(fs, pos, childList):
 330
 331         # Build the list recursively from the top level nodes
 332         content = BuildList(FindTopLevelNodes(fs), fs, pos, childList)
 333         # Shove the TOC link in the top...
 334         content = content[:7] + '<dt><a href="/toc/">Table of Contents</a></dt><dd></dd>\n' + content[7:]
 335
 336         return content
 337
 338
 339 # Preliminaries
 340
 341 # We have command line arguments now, so deal with them
 342 parser = argparse.ArgumentParser(description='A build script for the Ardour Manual')
 343 parser.add_argument('-v', '--verbose', action='store_true', help='Display the high-level structure of the manual')
 344 parser.add_argument('-q', '--quiet', action='store_true', help='Suppress all output (overrides -v)')
 345 parser.add_argument('-d', '--devmode', action='store_true', help='Add content to pages to help developers debug them')
 346 args = parser.parse_args()
 347 verbose = args.verbose
 348 quiet = args.quiet
 349 devmode = args.devmode
 350
 351 if quiet:
 352         verbose = False
 353
 354 level = 0
 355 fileCount = 0
 356 levelNums = [0]*6
 357 lastFile = ''
 358 page = ''
 359 toc = ''
 360 pageNumber = 0
 361
 362 siteDir = './website/'
 363
 364 if not quiet and devmode:
 365         print('Devmode active: scribbling extra junk to the manual...')
 366
 367 if os.access(siteDir, os.F_OK):
 368         if not quiet:
 369                 print('Removing stale HTML data...')
 370
 371         shutil.rmtree(siteDir)
 372
 373 shutil.copytree('./source', siteDir)
 374
 375
 376 # Read the template, and fix the stuff that's fixed for all pages
 377 temp = open('page-template.txt')
 378 template = temp.read()
 379 temp.close()
 380
 381 template = template.replace('{{page.bootstrap_path}}', '/bootstrap-3.3.7')
 382 template = template.replace('{{page.page_title}}', 'The Ardour Manual')
 383
 384
 385 # Parse out the master docuemnt's structure into a dictionary list
 386 fileStruct = GetFileStructure()
 387
 388 # Build a quasi-tree structure listing children at level + 1 for each node
 389 nodeChildren = FindChildren(fileStruct)
 390
 391 # Create a dictionary for translation of internal links to real links
 392 links = FindInternalLinks(fileStruct)
 393
 394 if not quiet:
 395         print('Found ' + str(len(links)) + ' internal link target', end='')
 396         print('.') if len(links) == 1 else print('s.')
 397
 398 if not quiet:
 399         master = open('master-doc.txt')
 400         firstLine = master.readline().rstrip('\r\n')
 401         master.close()
 402
 403         if firstLine == '<!-- exploded -->':
 404                 print('Parsing exploded file...')
 405         elif firstLine == '<!-- imploded -->':
 406                 print('Parsing imploded file...')
 407         else:
 408                 print('Parsing unknown type...')
 409
 410 # Here we go!
 411
 412 for header in fileStruct:
 413         fileCount = fileCount + 1
 414         content = ''
 415         more = ''
 416
 417         lastLevel = level
 418         level = header['level']
 419
 420         # Handle Part/Chapter/subchapter/section/subsection numbering
 421         if level == 0:
 422                 levelNums[2] = 0
 423         elif level == 1:
 424                 levelNums[2] = 0
 425         elif level == 2:
 426                 levelNums[3] = 0
 427         elif level == 3:
 428                 levelNums[4] = 0
 429
 430         levelNums[level] = levelNums[level] + 1;
 431
 432         # This is totally unnecessary, but nice; besides which, you can capture
 433         # the output to a file to look at later if you like :-)
 434         if verbose:
 435                 for i in range(level):
 436                         print('\t', end='')
 437
 438                 if (level == 0):
 439                         print('\nPart ' + num2roman(levelNums[0]) + ': ', end='')
 440                 elif (level == 1):
 441                         print('\n\tChapter ' + str(levelNums[1]) + ': ', end='')
 442
 443                 print(header['title'])
 444
 445         # Handle TOC scriblings...
 446         if level == 0:
 447                 toc = toc + '<h2>Part ' + num2roman(levelNums[level]) + ': ' + header['title'] + '</h2>\n';
 448         elif level == 1:
 449                 toc = toc + '  <p class="chapter">Ch. ' + str(levelNums[level]) + ':&nbsp;&nbsp;<a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\n'
 450         elif level == 2:
 451                 toc = toc + '    <p class="subchapter"><a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\n'
 452         elif level == 3:
 453                 toc = toc + '      <p class="section"><a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\n'
 454         elif level == 4:
 455                 toc = toc + '      <p class="subsection"><a href="/' + header['filename'] + '/">' + header['title'] + '</a></p>\n'
 456
 457         # Make the 'this thing contains...' stuff
 458         if HaveChildren(fileStruct, pageNumber):
 459                 pages = GetChildren(fileStruct, pageNumber)
 460
 461                 for pg in pages:
 462                         more = more + '<li>' + '<a href="/' + fileStruct[pg]['filename'] + '/">' + fileStruct[pg]['title'] + '</a>' + '</li>\n'
 463
 464                 more = '<div id=subtopics>\n' + '<h2>This section contains the following topics:</h2>\n' + '<ul>\n' + more + '</ul>\n' + '</div>\n'
 465
 466         parent = GetParent(fileStruct, pageNumber)
 467
 468         # Make the 'Previous', 'Up' & 'Next' content
 469         nLink = ''
 470         pLink = ''
 471         uLink = ''
 472
 473         if pageNumber > 0:
 474                 pLink = '<li class="previous"><a title="' + fileStruct[pageNumber - 1]['title'] + '" href="/' + fileStruct[pageNumber - 1]['filename'] + '/" class="previous"> &larr; Previous </a></li>'
 475
 476         if pageNumber < len(fileStruct) - 1:
 477                 nLink = '<li class="next"><a title="' + fileStruct[pageNumber + 1]['title'] + '" href="/' + fileStruct[pageNumber + 1]['filename'] + '/" class="next"> Next &rarr; </a></li>'
 478
 479         if level > 0:
 480                 uLink = '<li><a title="' + fileStruct[parent]['title'] + '" href="/' + fileStruct[parent]['filename'] + '/" class="active"> &uarr; Up </a></li>'
 481         else:
 482                 uLink = '<li><a title="Ardour Table of Contents" href="/toc/index.html" class="active"> &uarr; Up </a></li>'
 483
 484         prevnext = '<ul class="pager">' + pLink + uLink + nLink + '</ul>'
 485
 486         # Make the BreadCrumbs
 487         breadcrumbs = GetBreadCrumbs(fileStruct, pageNumber)
 488
 489         # Create the link sidebar
 490         sidebar = CreateLinkSidebar(fileStruct, pageNumber, nodeChildren)
 491
 492         # Parts DO NOT have any content, they are ONLY an organizing construct!
 493         # Chapters, subchapters, sections & subsections can all have content,
 494         # but the basic fundamental organizing unit WRT content is still the
 495         # chapter.
 496         githubedit = ''
 497         if level > 0:
 498                 if 'include' in header:
 499                         srcFile = open('include/' + header['include'])
 500                         githubedit = '<span style="float:right;"><a title="Edit in GitHub" href="' + githuburl + header['include'] + '"><img src="/images/github.png" alt="Edit on GitHub"/></a></span>'
 501                         content = srcFile.read()
 502                         srcFile.close()
 503
 504                         # Get rid of any extant header in the include file
 505                         # (once this is accepted, we can nuke this bit, as content files
 506                         # will not have any headers or footers in them)
 507                         content = re.sub('---.*\n(.*\n)*---.*\n', '', content)
 508                         content = content.replace('{% children %}', '')
 509
 510                 else:
 511                         if 'content' in header:
 512                                 content = header['content']
 513                         else:
 514                                 content = '[something went wrong]'
 515
 516         # Fix up any internal links
 517         content = FixInternalLinks(links, content, header['title'])
 518
 519         # Add header information to the page if in dev mode
 520         if devmode:
 521                 devnote ='<aside style="background-color:indigo; color:white;">'
 522                 if 'filename' in header:
 523                         devnote = devnote + 'filename: ' + header['filename'] + '<br>'
 524                 if 'include' in header:
 525                         devnote = devnote + 'include: ' + header['include'] + '<br>'
 526                 if 'link' in header:
 527                         devnote = devnote + 'link: ' + header['link'] + '<br>'
 528                 content = devnote + '</aside>' + content
 529
 530         # Set up the actual page from the template
 531         if 'style' not in header:
 532                 page = re.sub("{% if page.style %}.*\n.*\n{% endif %}.*\n", "", template)
 533         else:
 534                 page = template.replace('{{page.style}}', header['style'])
 535                 page = page.replace('{% if page.style %}', '')
 536                 page = page.replace('{% endif %}', '')
 537
 538         page = page.replace('{{ page.title }}', header['title'])
 539         page = page.replace('{% tree %}', sidebar)
 540         page = page.replace('{% prevnext %}', prevnext)
 541         page = page.replace('{% githubedit %}', githubedit)
 542         page = page.replace('{% breadcrumbs %}', breadcrumbs)
 543         page = page.replace('{{ content }}', content + more)
 544
 545         # Create the directory for the index.html file to go into (we use makedirs,
 546         # because we have to in order to accomodate the 'uri' keyword)
 547         os.makedirs(siteDir + header['filename'], 0o775, exist_ok=True)
 548
 549         # Finally, write the file!
 550         destFile = open(siteDir + header['filename'] + '/index.html', 'w')
 551         destFile.write(page)
 552         destFile.close()
 553
 554         # Save filename for next header...
 555         lastFile = header['filename']
 556         pageNumber = pageNumber + 1
 557
 558 # Finally, create the TOC
 559 sidebar = CreateLinkSidebar(fileStruct, -1, nodeChildren)
 560
 561 page = re.sub("{% if page.style %}.*\n.*\n{% endif %}.*\n", "", template)
 562 page = page.replace('{{ page.title }}', 'Ardour Table of Contents')
 563 page = page.replace('{% tree %}', sidebar)
 564 page = page.replace('{{ content }}', toc)
 565 page = page.replace('{% prevnext %}', '')
 566 page = page.replace('{% githubedit %}', '')
 567 page = page.replace('{% breadcrumbs %}', '')
 568
 569 os.mkdir(siteDir + 'toc', 0o775)
 570 tocFile = open(siteDir + 'toc/index.html', 'w')
 571 tocFile.write(page)
 572 tocFile.close()
 573
 574 if not quiet:
 575         print('Processed ' + str(fileCount) + ' files.')