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