summaryrefslogtreecommitdiffstats
path: root/tools/update-packaging/generatesnippet.py
blob: 15b7edf58865972e2a8534653aa39a1d97f58a36 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.

"""
This script generates the complete snippet for a given locale or en-US
Most of the parameters received are to generate the MAR's download URL
and determine the MAR's filename
"""
import sys, os, platform, sha
from optparse import OptionParser
from ConfigParser import ConfigParser
from stat import ST_SIZE

def main():
    error = False
    parser = OptionParser(
        usage="%prog [options]")
    parser.add_option("--mar-path",
                      action="store",
                      dest="marPath",
                      help="[Required] Specify the absolute path where the MAR file is found.")
    parser.add_option("--application-ini-file",
                      action="store",
                      dest="applicationIniFile",
                      help="[Required] Specify the absolute path to the application.ini file.")
    parser.add_option("-l",
                      "--locale",
                      action="store",
                      dest="locale",
                      help="[Required] Specify which locale we are generating the snippet for.")
    parser.add_option("-p",
                      "--product",
                      action="store",
                      dest="product",
                      help="[Required] This option is used to generate the URL to download the MAR file.")
    parser.add_option("--platform",
                      action="store",
                      dest="platform",
                      help="[Required] This option is used to indicate which target platform.")
    parser.add_option("--branch",
                      action="store",
                      dest="branch",
                      help="This option is used to indicate which branch name to use for FTP file names.")
    parser.add_option("--download-base-URL",
                      action="store",
                      dest="downloadBaseURL",
                      help="This option indicates under which.")
    parser.add_option("-v",
                      "--verbose",
                      action="store_true",
                      dest="verbose",
                      default=False,
                      help="This option increases the output of the script.")
    (options, args) = parser.parse_args()
    for req, msg in (('marPath', "the absolute path to the where the MAR file is"),
                     ('applicationIniFile', "the absolute path to the application.ini file."),
                     ('locale', "a locale."),
                     ('product', "specify a product."),
                     ('platform', "specify the platform.")):
        if not hasattr(options, req):
            parser.error('You must specify %s' % msg)

    if not options.downloadBaseURL or options.downloadBaseURL == '':
        options.downloadBaseURL = 'http://ftp.mozilla.org/pub/mozilla.org/%s/nightly' % options.product

    if not options.branch or options.branch == '':
        options.branch = None

    snippet = generateSnippet(options.marPath,
                              options.applicationIniFile,
                              options.locale,
                              options.downloadBaseURL,
                              options.product,
                              options.platform,
                              options.branch)
    f = open(os.path.join(options.marPath, 'complete.update.snippet'), 'wb')
    f.write(snippet)
    f.close()

    if options.verbose:
        # Show in our logs what the contents of the snippet are
        print snippet

def generateSnippet(abstDistDir, applicationIniFile, locale,
                    downloadBaseURL, product, platform, branch):
    # Let's extract information from application.ini
    c = ConfigParser()
    try:
        c.readfp(open(applicationIniFile))
    except IOError, (stderror):
       sys.exit(stderror)
    buildid = c.get("App", "BuildID")
    appVersion = c.get("App", "Version")
    branchName = branch or c.get("App", "SourceRepository").split('/')[-1]

    marFileName = '%s-%s.%s.%s.complete.mar' % (
        product,
        appVersion,
        locale,
        platform)
    # Let's determine the hash and the size of the MAR file
    # This function exits the script if the file does not exist
    (completeMarHash, completeMarSize) = getFileHashAndSize(
        os.path.join(abstDistDir, marFileName))
    # Construct the URL to where the MAR file will exist
    interfix = ''
    if locale == 'en-US':
        interfix = ''
    else:
        interfix = '-l10n'
    marDownloadURL = "%s/%s%s/%s" % (downloadBaseURL,
                                     datedDirPath(buildid, branchName),
                                     interfix,
                                     marFileName)

    snippet = """complete
%(marDownloadURL)s
sha1
%(completeMarHash)s
%(completeMarSize)s
%(buildid)s
%(appVersion)s
%(appVersion)s
""" % dict( marDownloadURL=marDownloadURL,
            completeMarHash=completeMarHash,
            completeMarSize=completeMarSize,
            buildid=buildid,
            appVersion=appVersion)

    return snippet

def getFileHashAndSize(filepath):
    sha1Hash = 'UNKNOWN'
    size = 'UNKNOWN'

    try:
        # open in binary mode to make sure we get consistent results
        # across all platforms
        f = open(filepath, "rb")
        shaObj = sha.new(f.read())
        sha1Hash = shaObj.hexdigest()
        size = os.stat(filepath)[ST_SIZE]
    except IOError, (stderror):
       sys.exit(stderror)

    return (sha1Hash, size)

def datedDirPath(buildid, milestone):
    """
    Returns a string that will look like:
    2009/12/2009-12-31-09-mozilla-central
    """
    year  = buildid[0:4]
    month = buildid[4:6]
    day   = buildid[6:8]
    hour  = buildid[8:10]
    datedDir = "%s-%s-%s-%s-%s" % (year,
                                   month,
                                   day,
                                   hour,
                                   milestone)
    return "%s/%s/%s" % (year, month, datedDir)

if __name__ == '__main__':
    main()