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 docindex_link_re = re.compile (r'href="index.html"')
 103
 104
 105 ## Windows does not support symlinks.
 106 # This function avoids creating symlinks for splitted HTML manuals
 107 # Get rid of symlinks in GNUmakefile.in (local-WWW-post)
 108 # this also fixes missing PNGs only present in translated docs
 109 def hack_urls (s, prefix):
 110     if splitted_docs_re.match (prefix):
 111         s = re.sub ('(href|src)="(../lily-.*?|.*?[.]png)"', '\\1="../\\2"', s)
 112
 113     # fix xrefs between documents in different directories ad hoc
 114     if 'user/out-www/lilypond' in prefix:
 115         s = snippets_ref_re.sub ('href="source/input/lsr/lilypond-snippets', s)
 116     elif 'input/lsr' in prefix:
 117         s = user_ref_re.sub ('href="source/Documentation/user/lilypond\\1', s)
 118     elif 'input/regression' in prefix or 'Documentation/topdocs' in prefix:
 119         # fix the link from the regtest pages to the doc index (rewrite the prefix
 120         # name to obtain the relative path of the doc index page)
 121         rel_link = re.sub (r'out-www/.*$', '', prefix)
 122         rel_link = re.sub (r'[^/]*/', '../', rel_link)
 123         if 'Documentation/topdocs' in prefix:
 124             targetfile = "index"
 125         else:
 126             targetfile = "Documentation/devel"
 127         s = docindex_link_re.sub ('href="' + rel_link + targetfile + '.html\"', s)
 128
 129     source_path = os.path.join (os.path.dirname (prefix), 'source')
 130     if not os.path.islink (source_path):
 131         return s
 132     source_val = os.readlink (source_path)
 133     return re.sub ('href="source/(.*?)"', lambda m: source_links_replace (m, source_val), s)
 134
 135 body_tag_re = re.compile ('(?i)<body([^>]*)>')
 136 html_tag_re = re.compile ('(?i)<html>')
 137 doctype_re = re.compile ('(?i)<!DOCTYPE')
 138 doctype = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">\n'
 139 css_re = re.compile ('(?i)<link rel="stylesheet" type="text/css" ([^>]*)href="[^">]*?lilypond.*\.css"([^>]*)>')
 140 end_head_tag_re = re.compile ('(?i)</head>')
 141 css_link = """    <link rel="stylesheet" type="text/css" title="Patrick McCarty's design" href="%(rel)sDocumentation/lilypond-mccarty.css">
 142     <link rel="alternate stylesheet" type="text/css" href="%(rel)sDocumentation/lilypond.css" title="Andrew Hawryluk's design">
 143     <link rel="alternate stylesheet" type="text/css" href="%(rel)sDocumentation/lilypond-blue.css" title="Kurt Kroon's blue design">
 144     <!--[if lte IE 7]>
 145     <link href="%(rel)sDocumentation/lilypond-ie-fixes.css" rel="stylesheet" type="text/css">
 146     <![endif]-->
 147 """
 148
 149
 150 def add_header (s, prefix):
 151     """Add header (<body>, doctype and CSS)"""
 152     if header_tag_re.search (s) == None:
 153         body = '<body\\1>'
 154         (s, n) = body_tag_re.subn (body + header, s, 1)
 155         if not n:
 156             (s, n) = html_tag_re.subn ('<html>' + header, s, 1)
 157             if not n:
 158                 s = header + s
 159
 160         s = header_tag + '\n' + s
 161
 162         if doctype_re.search (s) == None:
 163             s = doctype + s
 164
 165         if css_re.search (s) == None:
 166             depth = (prefix.count ('/') - 1) * '../'
 167             s = end_head_tag_re.sub ((css_link % {'rel': depth}) + '</head>', s)
 168     return s
 169
 170 title_tag_re = re.compile ('.*?<title>(.*?)</title>', re.DOTALL)
 171 AT_web_title_re = re.compile ('@WEB-TITLE@')
 172
 173 def add_title (s):
 174     # urg
 175     # maybe find first node?
 176     fallback_web_title = '-- --'
 177     m = title_tag_re.match (s)
 178     if m:
 179         fallback_web_title = m.group (1)
 180     s = AT_web_title_re.sub (fallback_web_title, s)
 181     return s
 182
 183 footer_insert_re = re.compile ('<!--\s*FOOTER\s*-->')
 184 end_body_re = re.compile ('(?i)</body>')
 185 end_html_re = re.compile ('(?i)</html>')
 186
 187 def add_footer (s, footer_text):
 188     """add footer"""
 189     (s, n) = footer_insert_re.subn (footer_text + '\n' + '<!-- FOOTER -->', s, 1)
 190     if not n:
 191         (s, n) = end_body_re.subn (footer_text + '\n' + '</body>', s, 1)
 192     if not n:
 193         (s, n) = end_html_re.subn (footer_text + '\n' + '</html>', s, 1)
 194     if not n:
 195         s += footer_text + '\n'
 196     return s
 197
 198 def find_translations (prefix, lang_ext):
 199     """find available translations of a page"""
 200     available = []
 201     missing = []
 202     for l in langdefs.LANGUAGES:
 203         e = l.webext
 204         if lang_ext != e:
 205             if e in pages_dict[prefix]:
 206                 available.append (l)
 207             elif lang_ext == '' and l.enabled and reduce (operator.and_,
 208                                                           [not prefix.startswith (s)
 209                                                            for s in non_copied_pages]):
 210                 # English version of missing translated pages will be written
 211                 missing.append (e)
 212     return available, missing
 213
 214 online_links_re = re.compile ('''(href|src)=['"]\
 215 ((?!Compiling-from-source.html")[^/][.]*[^.:'"]*)\
 216 ([.]html)(#[^"']*|)['"]''')
 217 offline_links_re = re.compile ('href=[\'"]\
 218 ((?!Compiling-from-source.html")[^/][.]*[^.:\'"]*)([.]html)(#[^"\']*|)[\'"]')
 219 big_page_name_re = re.compile ('''(.+?)-big-page''')
 220
 221 def process_i18n_big_page_links (match, prefix, lang_ext):
 222     big_page_name = big_page_name_re.match (match.group (1))
 223     if big_page_name:
 224         destination_path = os.path.normpath (os.path.join (os.path.dirname (prefix),
 225                                                            big_page_name.group (0)))
 226         if not lang_ext in pages_dict[destination_path]:
 227             return match.group (0)
 228     return 'href="' + match.group (1) + '.' + lang_ext \
 229         + match.group (2) + match.group (3) + '"'
 230
 231 def process_links (s, prefix, lang_ext, file_name, missing, target):
 232     page_flavors = {}
 233     if target == 'online':
 234         # Strip .html, suffix for auto language selection (content
 235         # negotiation).  The menu must keep the full extension, so do
 236         # this before adding the menu.
 237         page_flavors[file_name] = \
 238             [lang_ext, online_links_re.sub ('\\1="\\2\\4"', s)]
 239     elif target == 'offline':
 240         # in LANG doc index: don't rewrite .html suffixes
 241         # as not all .LANG.html pages exist;
 242         # the doc index should be translated and contain links with the right suffixes
 243         if prefix == 'Documentation/out-www/index':
 244             page_flavors[file_name] = [lang_ext, s]
 245         elif lang_ext == '':
 246             page_flavors[file_name] = [lang_ext, s]
 247             for e in missing:
 248                 page_flavors[langdefs.lang_file_name (prefix, e, '.html')] = \
 249                     [e, offline_links_re.sub ('href="\\1.' + e + '\\2\\3"', s)]
 250         else:
 251             # For saving bandwidth and disk space, we don't duplicate big pages
 252             # in English, so we must process translated big pages links differently.
 253             if 'big-page' in prefix:
 254                 page_flavors[file_name] = \
 255                     [lang_ext,
 256                      offline_links_re.sub \
 257                          (lambda match: process_i18n_big_page_links (match, prefix, lang_ext),
 258                           s)]
 259             else:
 260                 page_flavors[file_name] = \
 261                     [lang_ext,
 262                      offline_links_re.sub ('href="\\1.' + lang_ext + '\\2\\3"', s)]
 263     return page_flavors
 264
 265 def add_menu (page_flavors, prefix, available, target, translation):
 266     for k in page_flavors:
 267         language_menu = ''
 268         languages = ''
 269         if page_flavors[k][0] != '':
 270             t = translation[page_flavors[k][0]]
 271         else:
 272             t = _doc
 273         for lang in available:
 274             lang_file = lang.file_name (os.path.basename (prefix), '.html')
 275             if language_menu != '':
 276                 language_menu += ', '
 277             language_menu += '<a href="%s">%s</a>' % (lang_file, t (lang.name))
 278         if target == 'offline':
 279             browser_language = ''
 280         elif target == 'online':
 281             browser_language = t (browser_lang) % browser_language_url
 282         if language_menu:
 283             language_available = t (lang_available) % language_menu
 284             languages = LANGUAGES_TEMPLATE % vars ()
 285         page_flavors[k][1] = add_footer (page_flavors[k][1], languages)
 286     return page_flavors
 287
 288
 289 def process_html_files (package_name = '',
 290                         package_version = '',
 291                         target = 'offline',
 292                         name_filter = lambda s: s):
 293     """Add header, footer and tweak links to a number of HTML files
 294
 295     Arguments:
 296      package_name=NAME         set package_name to NAME
 297      package_version=VERSION   set package version to VERSION
 298      targets=offline|online    set page processing depending on the target
 299           offline is for reading HTML pages locally
 300           online is for hosting the HTML pages on a website with content
 301             negotiation
 302      name_filter               a HTML file name filter
 303     """
 304     translation = langdefs.translation
 305     localtime = time.strftime ('%c %Z', time.localtime (time.time ()))
 306
 307     if "http://" in mail_address:
 308         mail_address_url = mail_address
 309     else:
 310         mail_address_url= 'mailto:' + mail_address
 311
 312     versiontup = package_version.split ('.')
 313     branch_str = _doc ('stable-branch')
 314     if int (versiontup[1]) %  2:
 315         branch_str = _doc ('development-branch')
 316
 317     # Initialize dictionaries for string formatting
 318     subst = {}
 319     subst[''] = dict ([i for i in globals ().items() if type (i[1]) is str])
 320     subst[''].update (dict ([i for i in locals ().items() if type (i[1]) is str]))
 321     for l in translation:
 322         e = langdefs.LANGDICT[l].webext
 323         if e:
 324             subst[e] = {}
 325             for name in subst['']:
 326                 subst[e][name] = translation[l] (subst[''][name])
 327     # Do deeper string formatting as early as possible,
 328     # so only one '%' formatting pass is needed later
 329     for e in subst:
 330         subst[e]['footer_name_version'] = subst[e]['footer_name_version'] % subst[e]
 331         subst[e]['footer_report_links'] = subst[e]['footer_report_links'] % subst[e]
 332
 333     for prefix, ext_list in pages_dict.items ():
 334         for lang_ext in ext_list:
 335             file_name = langdefs.lang_file_name (prefix, lang_ext, '.html')
 336             in_f = open (file_name)
 337             s = in_f.read()
 338             in_f.close()
 339
 340             s = s.replace ('%', '%%')
 341             s = hack_urls (s, prefix)
 342             s = add_header (s, prefix)
 343
 344             ### add footer
 345             if footer_tag_re.search (s) == None:
 346                 s = add_footer (s, footer_tag + footer)
 347
 348                 available, missing = find_translations (prefix, lang_ext)
 349                 page_flavors = process_links (s, prefix, lang_ext, file_name, missing, target)
 350                 # Add menu after stripping: must not have autoselection for language menu.
 351                 page_flavors = add_menu (page_flavors, prefix, available, target, translation)
 352             for k in page_flavors:
 353                 page_flavors[k][1] = page_flavors[k][1] % subst[page_flavors[k][0]]
 354                 out_f = open (name_filter (k), 'w')
 355                 out_f.write (page_flavors[k][1])
 356                 out_f.close()
 357         # if the page is translated, a .en.html symlink is necessary for content negotiation
 358         if target == 'online' and ext_list != ['']:
 359             os.symlink (os.path.basename (prefix) + '.html', name_filter (prefix + '.en.html'))