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