stepmake/bin/add-html-footer.py

   1 #!@PYTHON@
   2
   3 """
   4 Print a nice footer.  add the top of the ChangeLog file (up to the ********)
   5 """
   6 import re
   7 import sys
   8 import os
   9 import time
  10 import string
  11 import getopt
  12
  13 index_url=''
  14 top_url=''
  15 changelog_file=''
  16 content_negotiation = False
  17 package_name = ''
  18 package_version = ''
  19
  20 mail_address = '(address unknown)'
  21 try:
  22     mail_address= os.environ['MAILADDRESS']
  23 except KeyError:
  24     pass
  25
  26 mail_address_url= 'mailto:' + mail_address
  27 if re.search ("http://", mail_address):
  28     mail_address_url = mail_address
  29
  30 webmaster= mail_address
  31 try:
  32     webmaster= os.environ['WEBMASTER']
  33 except KeyError:
  34     pass
  35
  36 header_file = ''
  37 footer_file = ''
  38 default_header = r"""
  39 """
  40
  41
  42 #wiki_base = 'http://afavant.elte.hu/lywiki/'
  43 wiki_base = None
  44
  45
  46 default_footer = r"""<hr>Please take me <a href=@INDEX@>back to the index</a>
  47 of @PACKAGE_NAME@
  48 """
  49
  50 built = r'''
  51 <div style="background-color: #e8ffe8; padding: 2; border: #c0ffc0 1px solid;">
  52 %(wiki_string)s
  53 <p>
  54 <font size="-1">
  55 This page is for %(package_name)s-%(package_version)s (%(branch_str)s). <br>
  56 </font>
  57 <address><font size="-1">
  58 Report errors to <a href="%(mail_address_url)s">%(mail_address)s</a>.</font></address>
  59 </p>
  60 </div>
  61 '''
  62
  63
  64
  65
  66 def help ():
  67     sys.stdout.write (r"""Usage: add-html-footer [OPTIONS]... HTML-FILE
  68 Add header, footer and top of ChangLog file (up to the ********) to HTML-FILE
  69
  70 Options:
  71  --changelog=FILE          use FILE as ChangeLog [ChangeLog]
  72  --content-negotiation     strip .html and .png from urls
  73  --footer=FILE             use FILE as footer
  74  --header=FILE             use FILE as header
  75  -h, --help                print this help
  76  --index=URL               set homepage to URL
  77  --name=NAME               set package_name to NAME
  78  --version=VERSION         set package version to VERSION
  79
  80 """)
  81     sys.exit (0)
  82
  83 (options, files) = getopt.getopt(sys.argv[1:], 'h', [
  84     'changelog=', 'footer=', 'header=', 'help', 'index=',
  85     'name=', 'content-negotiation', 'version='])
  86
  87 for opt in options:
  88     o = opt[0]
  89     a = opt[1]
  90     if o == '--changelog':
  91         changelog_file = a
  92     elif o == '--content-negotiation':
  93         content_negotiation = True
  94     elif o == '--footer':
  95         footer_file = a
  96     elif o == '--header':
  97         header_file = a
  98     elif o == '-h' or o == '--help':
  99         help ()
 100     # urg, this is top!
 101     elif o == '--index':
 102         index_url = a
 103     elif o == '--name':
 104         package_name = a
 105     elif o == '--version':
 106         package_version = a
 107     else:
 108         raise 'unknown opt ', o
 109
 110
 111 def compose (default, file):
 112     s = default
 113     if file:
 114         s = open (file).read ()
 115     return s
 116
 117 localtime = time.strftime ('%c %Z', time.localtime (time.time ()))
 118
 119 if os.path.basename (index_url) != "index.html":
 120     index_url = os.path.join (index_url , "index.html")
 121 top_url = os.path.dirname (index_url) + "/"
 122
 123 header = compose (default_header, header_file)
 124
 125 # compose (default_footer, footer_file)
 126 footer =  built
 127 header_tag = '<!-- header_tag -->'
 128 footer_tag = '<!-- footer_tag -->'
 129
 130 # Python < 1.5.2 compatibility
 131 #
 132 # On most platforms, this is equivalent to
 133 #`normpath(join(os.getcwd()), PATH)'.  *Added in Python version 1.5.2*
 134 if os.path.__dict__.has_key ('abspath'):
 135     abspath = os.path.abspath
 136 else:
 137     def abspath (path):
 138         return os.path.normpath (os.path.join (os.getcwd (), path))
 139
 140
 141 def remove_self_ref (s):
 142     self_url = abspath (os.getcwd () + '/' + f)
 143     #sys.stderr.write ('url0: %s\n' % self_url)
 144
 145     # self_url = re.sub ('.*?' + string.lower (package_name) + '[^/]*/',
 146     #                 '', self_url)
 147     # URG - this only works when source tree is unpacked in `src/' dir
 148     # For some reason, .*? still eats away
 149     #     /home/fred/usr/src/lilypond-1.5.14/Documentation/user/out-www/lilypond/
 150     # instead of just
 151     #
 152     #     /home/fred/usr/src/lilypond-1.5.14/
 153     #
 154     #     Tutorial.html
 155     self_url = re.sub ('.*?src/' + string.lower (package_name) + '[^/]*/',
 156             '', self_url)
 157
 158     #sys.stderr.write ('url1: %s\n' % self_url)
 159
 160     #urg, ugly lily-specific toplevel index hack
 161     self_url = re.sub ('.*topdocs/out-www/index.html', 'index.html', self_url)
 162     #sys.stderr.write ('url2: %s\n' % self_url)
 163
 164     # ugh, python2.[12] re is broken.
 165     ## pat = re.compile ('.*?(<a href="[\./]*' + self_url + '#?[^"]*">)([^<]*)(</a>)', re.DOTALL)
 166     pat = re.compile ('[.\n]*?(<a href="[\./]*' + self_url + '#?[^"]*">)([^<]*)(</a>)')
 167     m = pat.search (s)
 168     while m:
 169         #sys.stderr.write ('self: %s\n' % m.group (2))
 170         s = s[:m.start (1)] + m.group (2) + s[m.end (3):]
 171         m = pat.search (s)
 172     return s
 173
 174 def do_file (f):
 175     s = open (f).read()
 176     s = re.sub ('%', '%%', s)
 177
 178
 179     if re.search (header_tag, s) == None:
 180         body = '<BODY BGCOLOR=WHITE TEXT=BLACK>'
 181         s = re.sub ('(?i)<body>', body, s)
 182         if re.search ('(?i)<BODY', s):
 183             s = re.sub ('(?i)<body[^>]*>', body + header, s, 1)
 184         elif re.search ('(?i)<html', s):
 185             s = re.sub ('(?i)<html>', '<HTML>' + header, s, 1)
 186         else:
 187             s = header + s
 188
 189         s = header_tag + '\n' + s
 190
 191         if re.search ('(?i)<!DOCTYPE', s) == None:
 192             doctype = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">\n'
 193             s = doctype + s
 194
 195     if re.search (footer_tag, s) == None:
 196         if re.search ('(?i)</body', s):
 197             s = re.sub ('(?i)</body>', footer_tag + footer + '\n' + '</BODY>', s, 1)
 198         elif re.search ('(?i)</html', s):
 199             s = re.sub ('(?i)</html>', footer_tag + footer + '\n' + '</HTML>', s, 1)
 200         else:
 201             s = s + footer_tag + footer + '\n'
 202
 203         s = i18n (f, s)
 204
 205     #URUGRGOUSNGUOUNRIU
 206     index = index_url
 207     top = top_url
 208     if os.path.basename (f) == "index.html":
 209         cwd = os.getcwd ()
 210         if os.path.basename (cwd) == "topdocs":
 211             index = "index.html"
 212             top = ""
 213
 214         # don't cause ///////index.html entries in log files.
 215         #        index = "./index.html"
 216         #        top = "./"
 217
 218     versiontup = string.split(package_version, '.')
 219     branch_str = 'stable-branch'
 220     if string.atoi ( versiontup[1]) %  2:
 221         branch_str = 'development-branch'
 222
 223     wiki_page = ('v%s.%s-' % (versiontup[0], versiontup[1]) +  f)
 224     wiki_page = re.sub ('out-www/', '', wiki_page)
 225     wiki_page = re.sub ('/', '-', wiki_page)
 226     wiki_page = re.sub (r'\.-', '', wiki_page)
 227     wiki_page = re.sub ('.html', '', wiki_page)
 228
 229     wiki_string = ''
 230
 231     if wiki_base:
 232         wiki_string = (r'''<a href="%(wiki_base)s%(wiki_page)s">Read </a> comments on this page, or
 233         <a href="%(wiki_base)s%(wiki_page)s?action=edit">add</a> one.''' %
 234                { 'wiki_base': wiki_base,
 235                 'wiki_page': wiki_page})
 236
 237     subst = globals ()
 238     subst.update (locals())
 239     s = s % subst
 240
 241     # urg
 242     # maybe find first node?
 243     fallback_web_title = '-- --'
 244
 245     # ugh, python2.[12] re is broken.
 246     #m = re.match ('.*?<title>\(.*?\)</title>', s, re.DOTALL)
 247     m = re.match ('[.\n]*?<title>([.\n]*?)</title>', s)
 248     if m:
 249         fallback_web_title = m.group (1)
 250     s = re.sub ('@WEB-TITLE@', fallback_web_title, s)
 251
 252     s = remove_self_ref (s)
 253
 254     # remove info's annoying's indication of referencing external document
 255     s = re.sub (' \((lilypond|lilypond-internals|music-glossary)\)</a>',
 256           '</a>', s)
 257
 258     open (f, 'w').write (s)
 259
 260
 261
 262 localedir = 'out/locale'
 263 try:
 264     import gettext
 265     gettext.bindtextdomain ('newweb', localedir)
 266     gettext.textdomain ('newweb')
 267     _ = gettext.gettext
 268 except:
 269     def _ (s):
 270         return s
 271 underscore = _
 272
 273 C = 'site'
 274 LANGUAGES = (
 275     (C, 'English'),
 276     ('nl', 'Nederlands'),
 277     ('fr', 'French')
 278     )
 279
 280 language_available = _ ("Other languages: %s.") % "%(language_menu)s"
 281 browser_language = _ ("Using <A HREF='%s'>automatic language selection</A>.") \
 282            % "%(root_url)sabout/browser-language"
 283
 284 LANGUAGES_TEMPLATE = '''\
 285 <P>
 286  %(language_available)s
 287  <BR>
 288  %(browser_language)s
 289 </P>
 290 ''' % vars ()
 291
 292 def file_lang (file, lang):
 293     (base, ext) = os.path.splitext (file)
 294     base = os.path.splitext (base)[0]
 295     if lang and lang != C:
 296         return base + '.' + lang + ext
 297     return base + ext
 298
 299
 300 def i18n (file_name, page):
 301     # ugh
 302     root_url = "/web/"
 303
 304     base_name = os.path.basename (file_name)
 305
 306     lang = C
 307     m = re.match ('.*[.]([^/.]*).html', file_name)
 308     if m:
 309         lang = m.group (1)
 310
 311     # Find available translations of this page.
 312     available = filter (lambda x: lang != x[0] \
 313               and os.path.exists (file_lang (file_name, x[0])),
 314               LANGUAGES)
 315
 316     # Strip .html, .png suffix for auto language selection (content
 317     # negotiation).  The menu must keep the full extension, so do
 318     # this before adding the menu.
 319     if content_negotiation:
 320         page = re.sub ('''(href|src)=[\'"]([^/][.]*[^.:\'"]*)(.html|.png)(#[^"\']*|)[\'"]''',
 321                        '\\1="\\2\\4"', page)
 322
 323     # Add menu after stripping: must not have autoselection for language menu.
 324     language_menu = ''
 325     for (prefix, name) in available:
 326         lang_file = file_lang (base_name, prefix)
 327         if language_menu != '':
 328             language_menu += ', '
 329         language_menu += '<a href="%(lang_file)s">%(name)s</a>' % vars ()
 330
 331     languages = ''
 332     if language_menu:
 333         languages = LANGUAGES_TEMPLATE % vars ()
 334
 335     # Put language menu before '</body>' and '</html>' tags
 336     if re.search ('(?i)</body', page):
 337         page = re.sub ('(?i)</body>', languages + '</BODY>', page, 1)
 338     elif re.search ('(?i)</html', page):
 339         page = re.sub ('(?i)</html>', languages + '</HTML>', page, 1)
 340     else:
 341         page = page + languages
 342
 343     return page
 344
 345 for f in files:
 346     do_file (f)
 347