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