buildscripts/postprocess_html.py

   1 #!@PYTHON@
   2
   3 """
   4 Postprocess HTML files:
   5 add footer, tweak links, add language selection menu.
   6 """
   7 import re
   8 import os
   9 import time
  10 import operator
  11
  12 import langdefs
  13
  14 # This is to try to make the docball not too big with almost duplicate files
  15 # see process_links()
  16 non_copied_pages = ['Documentation/user/out-www/lilypond-big-page',
  17                     'Documentation/user/out-www/lilypond-internals-big-page',
  18                     'Documentation/user/out-www/lilypond-learning-big-page',
  19                     'Documentation/user/out-www/lilypond-program-big-page',
  20                     'Documentation/user/out-www/music-glossary-big-page',
  21                     'out-www/examples',
  22                     'Documentation/topdocs',
  23                     'Documentation/bibliography',
  24                     'Documentation/out-www/THANKS',
  25                     'Documentation/out-www/DEDICATION',
  26                     'Documentation/out-www/devel',
  27                     'input/']
  28
  29 def _doc (s):
  30     return s
  31
  32 header = r"""
  33 """
  34
  35 footer = '''
  36 <div class="footer">
  37 <p class="footer_version">
  38 %(footer_name_version)s
  39 </p>
  40 <p class="footer_report">
  41 %(footer_report_links)s
  42 </p>
  43 </div>
  44 '''
  45 footer_name_version = _doc ('This page is for %(package_name)s-%(package_version)s (%(branch_str)s).')
  46 # ugh, must not have "_doc" in strings because it is naively replaced with "_" in hacked gettext process
  47 footer_report_links = _doc ('Your <a href="%(suggest_Docs_url)s">suggestions for the documentation</a> are welcome, please report errors to our <a href="%(mail_address_url)s">bug list</a>.')
  48
  49
  50 mail_address = 'http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs'
  51 suggest_Docs_url = 'http://lilypond.org/web/devel/participating/documentation-adding'
  52
  53 header_tag = '<!-- header_tag -->'
  54 header_tag_re = re.compile (header_tag)
  55
  56 footer_tag = '<!-- footer_tag -->'
  57 footer_tag_re = re.compile (footer_tag)
  58
  59 lang_available = _doc ("Other languages: %s.")
  60 browser_lang = _doc ('About <A HREF="%s">automatic language selection</A>.')
  61 browser_language_url = "/web/about/browser-language"
  62
  63 LANGUAGES_TEMPLATE = '''
  64 <p id="languages">
  65  %(language_available)s
  66  <br/>
  67  %(browser_language)s
  68 </p>
  69 '''
  70
  71
  72 html_re = re.compile ('(.*?)(?:[.]([^/.]*))?[.]html$')
  73 pages_dict = {}
  74
  75 def build_pages_dict (filelist):
  76     """Build dictionary of available translations of each page"""
  77     global pages_dict
  78     for f in filelist:
  79         m = html_re.match (f)
  80         if m:
  81             g = m.groups()
  82             if len (g) <= 1 or g[1] == None:
  83                 e = ''
  84             else:
  85                 e = g[1]
  86             if not g[0] in pages_dict:
  87                 pages_dict[g[0]] = [e]
  88             else:
  89                 pages_dict[g[0]].append (e)
  90
  91 def source_links_replace (m, source_val):
  92     return 'href="' + os.path.join (source_val, m.group (1)) + '"'
  93
  94 splitted_docs_re = re.compile ('(input/lsr/out-www/lilypond-snippets|\
  95 Documentation/user/out-www/(lilypond|music-glossary|lilypond-program|\
  96 lilypond-learning))/')
  97
  98 snippets_ref_re = re.compile (r'href="(\.\./)?lilypond-snippets')
  99 user_ref_re = re.compile ('href="(?:\.\./)?lilypond\
 100 (-internals|-learning|-program|(?!-snippets))')
 101
 102 ## Windows does not support symlinks.
 103 # This function avoids creating symlinks for splitted HTML manuals
 104 # Get rid of symlinks in GNUmakefile.in (local-WWW-post)
 105 # this also fixes missing PNGs only present in translated docs
 106 def hack_urls (s, prefix):
 107     if splitted_docs_re.match (prefix):
 108         s = re.sub ('(href|src)="(../lily-.*?|.*?[.]png)"', '\\1="../\\2"', s)
 109
 110     # fix xrefs between documents in different directories ad hoc
 111     if 'user/out-www/lilypond' in prefix:
 112         s = snippets_ref_re.sub ('href="source/input/lsr/lilypond-snippets', s)
 113     elif 'input/lsr' in prefix:
 114         s = user_ref_re.sub ('href="source/Documentation/user/lilypond\\1', s)
 115
 116     source_path = os.path.join (os.path.dirname (prefix), 'source')
 117     if not os.path.islink (source_path):
 118         return s
 119     source_val = os.readlink (source_path)
 120     return re.sub ('href="source/(.*?)"', lambda m: source_links_replace (m, source_val), s)
 121
 122 body_tag_re = re.compile ('(?i)<body([^>]*)>')
 123 html_tag_re = re.compile ('(?i)<html>')
 124 doctype_re = re.compile ('(?i)<!DOCTYPE')
 125 doctype = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">\n'
 126 css_re = re.compile ('(?i)<link rel="stylesheet" type="text/css" href="[^">]*?lilypond.css">')
 127 end_head_tag_re = re.compile ('(?i)</head>')
 128 css_link = '<link rel="stylesheet" type="text/css" href="%sDocumentation/lilypond.css">\n'
 129
 130 def add_header (s, prefix):
 131     """Add header (<body>, doctype and CSS)"""
 132     if header_tag_re.search (s) == None:
 133         body = '<body\\1>'
 134         (s, n) = body_tag_re.subn (body + header, s, 1)
 135         if not n:
 136             (s, n) = html_tag_re.subn ('<html>' + header, s, 1)
 137             if not n:
 138                 s = header + s
 139
 140         s = header_tag + '\n' + s
 141
 142         if doctype_re.search (s) == None:
 143             s = doctype + s
 144
 145         if css_re.search (s) == None:
 146             depth = (prefix.count ('/') - 1) * '../'
 147             s = end_head_tag_re.sub ((css_link % depth) + '</head>', s)
 148     return s
 149
 150 title_tag_re = re.compile ('.*?<title>(.*?)</title>', re.DOTALL)
 151 AT_web_title_re = re.compile ('@WEB-TITLE@')
 152
 153 def add_title (s):
 154     # urg
 155     # maybe find first node?
 156     fallback_web_title = '-- --'
 157     m = title_tag_re.match (s)
 158     if m:
 159         fallback_web_title = m.group (1)
 160     s = AT_web_title_re.sub (fallback_web_title, s)
 161     return s
 162
 163 footer_insert_re = re.compile ('<!--\s*FOOTER\s*-->')
 164 end_body_re = re.compile ('(?i)</body>')
 165 end_html_re = re.compile ('(?i)</html>')
 166
 167 def add_footer (s, footer_text):
 168     """add footer"""
 169     (s, n) = footer_insert_re.subn (footer_text + '\n' + '<!-- FOOTER -->', s, 1)
 170     if not n:
 171         (s, n) = end_body_re.subn (footer_text + '\n' + '</body>', s, 1)
 172     if not n:
 173         (s, n) = end_html_re.subn (footer_text + '\n' + '</html>', s, 1)
 174     if not n:
 175         s += footer_text + '\n'
 176     return s
 177
 178 def find_translations (prefix, lang_ext):
 179     """find available translations of a page"""
 180     available = []
 181     missing = []
 182     for l in langdefs.LANGUAGES:
 183         e = l.webext
 184         if lang_ext != e:
 185             if e in pages_dict[prefix]:
 186                 available.append (l)
 187             elif lang_ext == '' and l.enabled and reduce (operator.and_,
 188                                                           [not prefix.startswith (s)
 189                                                            for s in non_copied_pages]):
 190                 # English version of missing translated pages will be written
 191                 missing.append (e)
 192     return available, missing
 193
 194 online_links_re = re.compile ('''(href|src)=['"]\
 195 ((?!Compiling-from-source.html")[^/][.]*[^.:'"]*)\
 196 ([.]html)(#[^"']*|)['"]''')
 197 offline_links_re = re.compile ('href=[\'"]\
 198 ((?!Compiling-from-source.html")[^/][.]*[^.:\'"]*)([.]html)(#[^"\']*|)[\'"]')
 199 big_page_name_re = re.compile ('''(.+?)-big-page''')
 200
 201 def process_i18n_big_page_links (match, prefix, lang_ext):
 202     big_page_name = big_page_name_re.match (match.group (1))
 203     if big_page_name:
 204         destination_path = os.path.normpath (os.path.join (os.path.dirname (prefix),
 205                                                            big_page_name.group (0)))
 206         if not lang_ext in pages_dict[destination_path]:
 207             return match.group (0)
 208     return 'href="' + match.group (1) + '.' + lang_ext \
 209         + match.group (2) + match.group (3) + '"'
 210
 211 def process_links (s, prefix, lang_ext, file_name, missing, target):
 212     page_flavors = {}
 213     if target == 'online':
 214         # Strip .html, suffix for auto language selection (content
 215         # negotiation).  The menu must keep the full extension, so do
 216         # this before adding the menu.
 217         page_flavors[file_name] = \
 218             [lang_ext, online_links_re.sub ('\\1="\\2\\4"', s)]
 219     elif target == 'offline':
 220         # in LANG doc index: don't rewrite .html suffixes
 221         # as not all .LANG.html pages exist;
 222         # the doc index should be translated and contain links with the right suffixes
 223         if prefix == 'Documentation/out-www/index':
 224             page_flavors[file_name] = [lang_ext, s]
 225         elif lang_ext == '':
 226             page_flavors[file_name] = [lang_ext, s]
 227             for e in missing:
 228                 page_flavors[langdefs.lang_file_name (prefix, e, '.html')] = \
 229                     [e, offline_links_re.sub ('href="\\1.' + e + '\\2\\3"', s)]
 230         else:
 231             # For saving bandwidth and disk space, we don't duplicate big pages
 232             # in English, so we must process translated big pages links differently.
 233             if 'big-page' in prefix:
 234                 page_flavors[file_name] = \
 235                     [lang_ext,
 236                      offline_links_re.sub \
 237                          (lambda match: process_i18n_big_page_links (match, prefix, lang_ext),
 238                           s)]
 239             else:
 240                 page_flavors[file_name] = \
 241                     [lang_ext,
 242                      offline_links_re.sub ('href="\\1.' + lang_ext + '\\2\\3"', s)]
 243     return page_flavors
 244
 245 def add_menu (page_flavors, prefix, available, target, translation):
 246     for k in page_flavors:
 247         language_menu = ''
 248         languages = ''
 249         if page_flavors[k][0] != '':
 250             t = translation[page_flavors[k][0]]
 251         else:
 252             t = _doc
 253         for lang in available:
 254             lang_file = lang.file_name (os.path.basename (prefix), '.html')
 255             if language_menu != '':
 256                 language_menu += ', '
 257             language_menu += '<a href="%s">%s</a>' % (lang_file, t (lang.name))
 258         if target == 'offline':
 259             browser_language = ''
 260         elif target == 'online':
 261             browser_language = t (browser_lang) % browser_language_url
 262         if language_menu:
 263             language_available = t (lang_available) % language_menu
 264             languages = LANGUAGES_TEMPLATE % vars ()
 265         page_flavors[k][1] = add_footer (page_flavors[k][1], languages)
 266     return page_flavors
 267
 268
 269 def process_html_files (package_name = '',
 270                         package_version = '',
 271                         target = 'offline',
 272                         name_filter = lambda s: s):
 273     """Add header, footer and tweak links to a number of HTML files
 274
 275     Arguments:
 276      package_name=NAME         set package_name to NAME
 277      package_version=VERSION   set package version to VERSION
 278      targets=offline|online    set page processing depending on the target
 279           offline is for reading HTML pages locally
 280           online is for hosting the HTML pages on a website with content
 281             negotiation
 282      name_filter               a HTML file name filter
 283     """
 284     translation = langdefs.translation
 285     localtime = time.strftime ('%c %Z', time.localtime (time.time ()))
 286
 287     if "http://" in mail_address:
 288         mail_address_url = mail_address
 289     else:
 290         mail_address_url= 'mailto:' + mail_address
 291
 292     versiontup = package_version.split ('.')
 293     branch_str = _doc ('stable-branch')
 294     if int (versiontup[1]) %  2:
 295         branch_str = _doc ('development-branch')
 296
 297     # Initialize dictionaries for string formatting
 298     subst = {}
 299     subst[''] = dict ([i for i in globals ().items() if type (i[1]) is str])
 300     subst[''].update (dict ([i for i in locals ().items() if type (i[1]) is str]))
 301     for l in translation:
 302         e = langdefs.LANGDICT[l].webext
 303         if e:
 304             subst[e] = {}
 305             for name in subst['']:
 306                 subst[e][name] = translation[l] (subst[''][name])
 307     # Do deeper string formatting as early as possible,
 308     # so only one '%' formatting pass is needed later
 309     for e in subst:
 310         subst[e]['footer_name_version'] = subst[e]['footer_name_version'] % subst[e]
 311         subst[e]['footer_report_links'] = subst[e]['footer_report_links'] % subst[e]
 312
 313     for prefix, ext_list in pages_dict.items ():
 314         for lang_ext in ext_list:
 315             file_name = langdefs.lang_file_name (prefix, lang_ext, '.html')
 316             in_f = open (file_name)
 317             s = in_f.read()
 318             in_f.close()
 319
 320             s = s.replace ('%', '%%')
 321             s = hack_urls (s, prefix)
 322             s = add_header (s, prefix)
 323
 324             ### add footer
 325             if footer_tag_re.search (s) == None:
 326                 s = add_footer (s, footer_tag + footer)
 327
 328                 available, missing = find_translations (prefix, lang_ext)
 329                 page_flavors = process_links (s, prefix, lang_ext, file_name, missing, target)
 330                 # Add menu after stripping: must not have autoselection for language menu.
 331                 page_flavors = add_menu (page_flavors, prefix, available, target, translation)
 332             for k in page_flavors:
 333                 page_flavors[k][1] = page_flavors[k][1] % subst[page_flavors[k][0]]
 334                 out_f = open (name_filter (k), 'w')
 335                 out_f.write (page_flavors[k][1])
 336                 out_f.close()
 337         # if the page is translated, a .en.html symlink is necessary for content negotiation
 338         if target == 'online' and ext_list != ['']:
 339             os.symlink (os.path.basename (prefix) + '.html', name_filter (prefix + '.en.html'))