build/i18n/scripts/dojo_resource.py

   1 #!/usr/bin/env python
   2 # dojo_resource.py
   3 """
   4 This class enables translation of Dojo resource bundles using gettext format.
   5
   6 Requires polib from http://polib.googlecode.com
   7
   8 Source event definitions are structured as follows:
   9 {
  10     "MSG_ID1": "This is a message with 1 variable - ${0}.",
  11     "MSG_ID2": "This is a message with two variables: ${0} and ${1}."
  12 }
  13
  14 Note that this is a deliberately limited subset of the variable substitution
  15 allowed by http://api.dojotoolkit.org/jsdoc/dojo/1.2/dojo.string.substitute
  16
  17 """
  18 # Copyright 2007 Dan Scott <dscott@laurentian.ca>
  19 #
  20 # This program is free software; you can redistribute it and/or
  21 # modify it under the terms of the GNU General Public License
  22 # as published by the Free Software Foundation; either version 2
  23 # of the License, or (at your option) any later version.
  24 #
  25 # This program is distributed in the hope that it will be useful,
  26 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  27 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  28 # GNU General Public License for more details.
  29
  30 import basel10n
  31 import codecs
  32 import optparse
  33 import polib
  34 import re
  35 import sys
  36 import simplejson
  37 import os.path
  38 import os
  39
  40 class DojoResource (basel10n.BaseL10N):
  41     """
  42     This class provides methods for extracting translatable strings from
  43     Evergreen's Dojo resource bundle files, generating translatable POT files,
  44     reading translated PO files, and generating an updated Dojo resource bundle
  45     files with additional or changed strings.
  46     """
  47
  48     def __init__(self):
  49         self.pot = None
  50         basel10n.BaseL10N.__init__(self)
  51         self.msgs = {}
  52
  53     def get_strings(self, source):
  54         """
  55         Extracts translatable strings from Evergreen's Dojo resource bundles.
  56         """
  57         self.pothead()
  58
  59         # Avoid generating duplicate entries by keeping track of msgids
  60         msgids = dict()
  61
  62         try:
  63             bundle = simplejson.load(codecs.open(source, encoding='utf-8', mode='r'))
  64         except ValueError:
  65             print("Reading Dojo resource file %s" % (source))
  66             raise
  67
  68         for key, value in bundle.iteritems():
  69             if value in msgids:
  70                 msgids[unicode(value)].occurrences.append((os.path.basename(source), str(key)))
  71             else:
  72                 poe = polib.POEntry()
  73                 poe.occurrences = [(os.path.basename(source), str(key))]
  74                 poe.msgid = unicode(value)
  75                 msgids[unicode(value)] = poe
  76
  77         # Now add the POEntries to our POFile
  78         for poe in msgids.values():
  79             self.pot.append(poe)
  80
  81     def create_bundle(self):
  82         """
  83         Creates a Dojo resource bundle file based on a translated PO file.
  84         """
  85
  86         for entry in self.pot:
  87             for occurrence in entry.occurrences:
  88                 # Ack. Horrible hack because polib started insisting
  89                 # that occurrences use integers for line numbers. The nerve!
  90                 filename, msgkey = occurrence[0].split('.js');
  91                 if entry.msgstr == '':
  92                     # No translation available; use the en-US definition
  93                     self.msgs[msgkey] = entry.msgid
  94                 else:
  95                     self.msgs[msgkey] = entry.msgstr
  96
  97 def main():
  98     """
  99     Determine what action to take
 100     """
 101     opts = optparse.OptionParser()
 102     opts.add_option('-p', '--pot', action='store', \
 103         help='Create a POT file from the specified Dojo resource bundle file', \
 104         metavar='FILE')
 105     opts.add_option('-c', '--create', action='store', \
 106         help='Create a Dojo resource bundle file from a translated PO FILE', \
 107         metavar='FILE')
 108     opts.add_option('-o', '--output', dest='outfile', \
 109         help='Write output to FILE (defaults to STDOUT)', metavar='FILE')
 110     (options, args) = opts.parse_args()
 111
 112     pot = DojoResource()
 113
 114     # Generate a new POT file from the Dojo resource bundle file
 115     if options.pot:
 116         pot.get_strings(options.pot)
 117         if options.outfile:
 118             if not os.path.exists(os.path.dirname(options.outfile)):
 119                 os.makedirs(os.path.dirname(options.outfile))
 120             pot.savepot(options.outfile)
 121         else:
 122             sys.stdout.write(pot.pot.__str__())
 123
 124     # Generate an Dojo resource bundle file from a PO file
 125     elif options.create:
 126         pot.loadpo(options.create)
 127         pot.create_bundle()
 128         if options.outfile:
 129             if not os.path.exists(os.path.dirname(options.outfile)):
 130                 os.makedirs(os.path.dirname(options.outfile))
 131             outfile = codecs.open(options.outfile, encoding='utf-8', mode='w')
 132             simplejson.dump(pot.msgs, outfile, indent=4)
 133         else:
 134             print(simplejson.dumps(pot.msgs, indent=4))
 135
 136     # No options were recognized - print help and bail
 137     else:
 138         opts.print_help()
 139
 140 if __name__ == '__main__':
 141     main()