buildscripts/add_html_footer.py

   1 #!@PYTHON@
   2
   3 """
   4 Print a nice footer.
   5 """
   6 import re
   7 import os
   8 import time
   9
  10 import langdefs
  11
  12 header = r"""
  13 """
  14
  15 footer = r'''
  16 <div style="background-color: #e8ffe8; padding: 2; border: #c0ffc0 1px solid;">
  17 <p>
  18 <font size="-1">
  19 This page is for %(package_name)s-%(package_version)s (%(branch_str)s). <br>
  20 </font>
  21 <address><font size="-1">
  22 Report errors to <a href="%(mail_address_url)s">%(mail_address)s</a>.</font></address>
  23 </p>
  24 </div>
  25 '''
  26
  27 mail_address = 'http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs'
  28
  29 header_tag = '<!-- header_tag -->'
  30 footer_tag = '<!-- footer_tag -->'
  31
  32 def _ (s):
  33     return s
  34
  35 language_available = _ ("Other languages: %s.") % "%(language_menu)s"
  36 browser_language = _ ("Using <A HREF='%s'>automatic language selection</A>.") \
  37            % "/web/about/browser-language"
  38
  39 LANGUAGES_TEMPLATE = '''\
  40 <P>
  41  %(language_available)s
  42  <BR>
  43  %(browser_language)s
  44 </P>
  45 ''' % vars ()
  46
  47
  48 html_re = re.compile ('(.*?)(?:[.]([^/.]*))?[.]html$')
  49 pages_dict = {}
  50
  51 def build_pages_dict (filelist):
  52     """Build dictionnary of available translations of each page"""
  53     global pages_dict
  54     for f in filelist:
  55         m = html_re.match (f)
  56         if m:
  57             g = m.groups()
  58             if len (g) <= 1 or g[1] == None:
  59                 e = ''
  60             else:
  61                 e = g[1]
  62             if not g[0] in pages_dict.keys():
  63                 pages_dict[g[0]] = [e]
  64             else:
  65                 pages_dict[g[0]].append (e)
  66
  67 def add_header (s):
  68     """Add header (<BODY> and doctype)"""
  69     if re.search (header_tag, s) == None:
  70         body = '<BODY BGCOLOR=WHITE TEXT=BLACK>'
  71         s = re.sub ('(?i)<body>', body, s)
  72         if re.search ('(?i)<BODY', s):
  73             s = re.sub ('(?i)<body[^>]*>', body + header, s, 1)
  74         elif re.search ('(?i)<html', s):
  75             s = re.sub ('(?i)<html>', '<HTML>' + header, s, 1)
  76         else:
  77             s = header + s
  78
  79         s = header_tag + '\n' + s
  80
  81         if re.search ('(?i)<!DOCTYPE', s) == None:
  82             doctype = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">\n'
  83             s = doctype + s
  84         return s
  85
  86 def info_external_ref_remove (s):
  87     """Remove info's annoying's indication of referencing external document"""
  88     return re.sub (' \((lilypond|lilypond-internals|music-glossary)\)</a>', '</a>', s)
  89
  90 def add_title (s):
  91     # urg
  92     # maybe find first node?
  93     fallback_web_title = '-- --'
  94     m = re.match ('.*?<title>(.*?)</title>', s, re.DOTALL)
  95     if m:
  96         fallback_web_title = m.group (1)
  97     s = re.sub ('@WEB-TITLE@', fallback_web_title, s)
  98     return s
  99
 100 info_nav_bar = re.compile (r'<div class="node">\s*<p>\s*<a name=".+?"></a>(.+?)<hr>\s*</div>', re.M | re.S)
 101
 102 def add_footer (s):
 103     """add footer
 104
 105 also add navigation bar to bottom of Info HTML pages"""
 106     m = info_nav_bar.search (s)
 107     if m:
 108         custom_footer = '<br><hr>\n<div class="node">\n<p>' + m.group (1) + '</div>\n' + footer
 109     else:
 110         custom_footer = footer
 111     if re.search ('(?i)</body', s):
 112         s = re.sub ('(?i)</body>', footer_tag + custom_footer + '\n' + '</BODY>', s, 1)
 113     elif re.search ('(?i)</html', s):
 114         s = re.sub ('(?i)</html>', footer_tag + custom_footer + '\n' + '</HTML>', s, 1)
 115     else:
 116         s += footer_tag + custom_footer + '\n'
 117     return s
 118
 119 def find_translations (prefix, lang_ext):
 120     """find available translations of a page"""
 121     available = []
 122     missing = []
 123     for l in langdefs.LANGUAGES:
 124         e = l.webext
 125         if lang_ext != e:
 126             if e in pages_dict[prefix]:
 127                 available.append (l)
 128             elif lang_ext == '' and l.enabled and \
 129                      ('lilypond/' in prefix or 'lilypond-internals/' in prefix or 'music-glossary/' in prefix or 'input/' in prefix):
 130                 # English version of missing translated pages in the splitted docs will be written
 131                 missing.append (e)
 132     return available, missing
 133
 134 def process_links (s, prefix, lang_ext, file_name, missing, target):
 135     page_flavors = {}
 136     if target == 'online':
 137         # Strip .html, .png suffix for auto language selection (content
 138         # negotiation).  The menu must keep the full extension, so do
 139         # this before adding the menu.
 140         page_flavors[file_name] = re.sub (
 141             '''(href|src)=[\'"]([^/][.]*[^.:\'"]*)(.html|.png)(#[^"\']*|)[\'"]''',
 142             '\\1="\\2\\4"', s)
 143     elif target == 'offline':
 144         # in LANG doc index: don't rewrite .html suffixes as not all .LANG.html pages exist
 145         # the doc index should be translated and contain the right links
 146         if prefix == 'Documentation/out-www/index':
 147             page_flavors[file_name] = s
 148         elif lang_ext == '':
 149             page_flavors[file_name] = s
 150             for e in missing:
 151                 page_flavors[langdefs.lang_file_name (prefix, e, '.html')] = re.sub (
 152                     '''href=[\'"]([^/][.]*[^.:\'"]*)(.html)(#[^"\']*|)[\'"]''',
 153                     'href="\\1.' + e + '\\2\\3"', s)
 154         else:
 155             page_flavors[file_name] = re.sub (
 156                 '''href=[\'"]([^/][.]*[^.:\'"]*)(.html)(#[^"\']*|)[\'"]''',
 157                 'href="\\1.' + lang_ext + '\\2\\3"', s)
 158     return page_flavors
 159
 160 def add_menu (page_flavors, prefix, available):
 161     language_menu = ''
 162     for lang in available:
 163         lang_file = lang.file_name (os.path.basename (prefix), '.html')
 164         if language_menu != '':
 165             language_menu += ', '
 166         language_menu += '<a href="%s">%s</a>' % (lang_file, lang.name)
 167
 168     languages = ''
 169     if language_menu:
 170         languages = LANGUAGES_TEMPLATE % vars ()
 171
 172     # put language menu before '</body>' and '</html>' tags
 173     for k in page_flavors.keys():
 174         if re.search ('(?i)</body', page_flavors[k]):
 175             page_flavors[k] = re.sub ('(?i)</body>', languages + '</BODY>', page_flavors[k], 1)
 176         elif re.search ('(?i)</html', page_flavors[k]):
 177             page_flavors[k] = re.sub ('(?i)</html>', languages + '</HTML>', page_flavors[k], 1)
 178         else:
 179             page_flavors[k] += languages
 180     return page_flavors
 181
 182
 183 def add_html_footer (package_name = '',
 184                      package_version = '',
 185                      target = 'offline',
 186                      name_filter = lambda s: s):
 187     """Add header, footer to a number of HTML files
 188
 189     Arguments:
 190      package_name=NAME         set package_name to NAME
 191      package_version=VERSION   set package version to VERSION
 192      targets=offline|online    set page processing depending on the target
 193           offline is for reading HTML pages locally
 194           online is for hosting the HTML pages on a website with content
 195             negotiation
 196      name_filter               a HTML file name filter
 197     """
 198     localtime = time.strftime ('%c %Z', time.localtime (time.time ()))
 199
 200     if re.search ("http://", mail_address):
 201         mail_address_url = mail_address
 202     else:
 203         mail_address_url= 'mailto:' + mail_address
 204
 205     versiontup = package_version.split ('.')
 206     branch_str = 'stable-branch'
 207     if int ( versiontup[1]) %  2:
 208         branch_str = 'development-branch'
 209
 210     for prefix, ext_list in pages_dict.items ():
 211         for lang_ext in ext_list:
 212             file_name = langdefs.lang_file_name (prefix, lang_ext, '.html')
 213             in_f = open (file_name)
 214             s = in_f.read()
 215             in_f.close()
 216
 217             s = re.sub ('%', '%%', s)
 218             s = add_header (s)
 219             # seems to be no more needed
 220             # s = info_external_ref_remove (s)
 221
 222             ### add footer
 223             if re.search (footer_tag, s) == None:
 224                 s = add_footer (s)
 225                 available, missing = find_translations (prefix, lang_ext)
 226                 page_flavors = process_links (s, prefix, lang_ext, file_name, missing, target)
 227                 # Add menu after stripping: must not have autoselection for language menu.
 228                 page_flavors = add_menu (page_flavors, prefix, available)
 229             # urg, this stuff is oudated and seems useless, let's disable it
 230             #else:
 231             #    for e in [l.webext for l in langdefs.LANGUAGES]:
 232             #        if not e in pages_dict[prefix]:
 233             #            page_flavors[langdefs.lang_file_name (prefix, e, '.html')] = s
 234
 235             subst = globals ()
 236             subst.update (locals())
 237             for k in page_flavors.keys():
 238                 page_flavors[k] = page_flavors[k] % subst
 239
 240                 out_f = open (name_filter (k), 'w')
 241                 out_f.write (page_flavors[k])
 242                 out_f.close()
 243         # if the page is translated, a .en.html symlink is necessary for content negotiation
 244         if target == 'online' and ext_list != ['']:
 245             os.symlink (os.path.basename (prefix) + '.html', name_filter (prefix + '.en.html'))