config/create_rc.py

   1 # This Source Code Form is subject to the terms of the Mozilla Public
   2 # License, v. 2.0. If a copy of the MPL was not distributed with this
   3 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
   4
   5 import io
   6 import os
   7 import sys
   8 from datetime import datetime
   9
  10 import buildconfig
  11 from mozbuild.preprocessor import Preprocessor
  12
  13 TEMPLATE = """
  14 // This Source Code Form is subject to the terms of the Mozilla Public
  15 // License, v. 2.0. If a copy of the MPL was not distributed with this
  16 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
  17
  18 #include<winuser.h>
  19 #include<winver.h>
  20
  21 // Note: if you contain versioning information in an included
  22 // RC script, it will be discarded
  23 // Use module.ver to explicitly set these values
  24
  25 // Do not edit this file. Changes won't affect the build.
  26
  27 {include}
  28
  29
  30 /////////////////////////////////////////////////////////////////////////////
  31 //
  32 // Version
  33 //
  34
  35 1 VERSIONINFO
  36  FILEVERSION    {fileversion}
  37  PRODUCTVERSION {productversion}
  38  FILEFLAGSMASK 0x3fL
  39  FILEFLAGS {fileflags}
  40  FILEOS VOS__WINDOWS32
  41  FILETYPE VFT_DLL
  42  FILESUBTYPE 0x0L
  43 BEGIN
  44     BLOCK "StringFileInfo"
  45     BEGIN
  46         BLOCK "000004b0"
  47         BEGIN
  48             VALUE "Comments", "{comment}"
  49             VALUE "LegalCopyright", "{copyright}"
  50             VALUE "CompanyName", "{company}"
  51             VALUE "FileDescription", "{description}"
  52             VALUE "FileVersion", "{mfversion}"
  53             VALUE "ProductVersion", "{mpversion}"
  54             VALUE "InternalName", "{module}"
  55             VALUE "LegalTrademarks", "{trademarks}"
  56             VALUE "OriginalFilename", "{binary}"
  57             VALUE "ProductName", "{productname}"
  58             VALUE "BuildID", "{buildid}"
  59         END
  60     END
  61     BLOCK "VarFileInfo"
  62     BEGIN
  63         VALUE "Translation", 0x0, 1200
  64     END
  65 END
  66
  67 """
  68
  69
  70 def preprocess(path, defines):
  71     pp = Preprocessor(defines=defines, marker="%")
  72     pp.context.update(defines)
  73     pp.out = io.StringIO()
  74     pp.do_filter("substitution")
  75     pp.do_include(io.open(path, "r", encoding="latin1"))
  76     pp.out.seek(0)
  77     return pp.out
  78
  79
  80 def parse_module_ver(path, defines):
  81     result = {}
  82     for line in preprocess(path, defines):
  83         content, *comment = line.split("#", 1)
  84         if not content.strip():
  85             continue
  86         entry, value = content.split("=", 1)
  87         result[entry.strip()] = value.strip()
  88     return result
  89
  90
  91 def get_buildid():
  92     path = os.path.join(buildconfig.topobjdir, "buildid.h")
  93     define, MOZ_BUILDID, buildid = io.open(path, "r", encoding="utf-8").read().split()
  94     return buildid
  95
  96
  97 def days_from_2000_to_buildid(buildid):
  98     start = datetime(2000, 1, 1, 0, 0, 0)
  99     buildid_time = datetime.strptime(buildid, "%Y%m%d%H%M%S")
 100     return (buildid_time - start).days
 101
 102
 103 def digits_only(s):
 104     for l in range(len(s), 0, -1):
 105         if s[:l].isdigit():
 106             return s[:l]
 107     return "0"
 108
 109
 110 def split_and_normalize_version(version, len):
 111     return ([digits_only(x) for x in version.split(".")] + ["0"] * len)[:len]
 112
 113
 114 def has_manifest(module_rc, manifest_id):
 115     for line in module_rc.splitlines():
 116         line = line.split(None, 2)
 117         if len(line) < 2:
 118             continue
 119         id, what, *rest = line
 120         if id == manifest_id and what in ("24", "RT_MANIFEST"):
 121             return True
 122     return False
 123
 124
 125 def generate_module_rc(binary="", rcinclude=None):
 126     deps = set()
 127     buildid = get_buildid()
 128     milestone = buildconfig.substs["GRE_MILESTONE"]
 129     app_version = buildconfig.substs.get("MOZ_APP_VERSION") or milestone
 130     app_winversion = ",".join(split_and_normalize_version(app_version, 4))
 131     milestone_winversion = ",".join(
 132         split_and_normalize_version(milestone, 3)
 133         + [str(days_from_2000_to_buildid(buildid))]
 134     )
 135     display_name = buildconfig.substs.get("MOZ_APP_DISPLAYNAME", "Mozilla")
 136
 137     milestone_string = milestone
 138
 139     flags = ["0"]
 140     if buildconfig.substs.get("MOZ_DEBUG"):
 141         flags.append("VS_FF_DEBUG")
 142         milestone_string += " Debug"
 143     if not buildconfig.substs.get("MOZILLA_OFFICIAL"):
 144         flags.append("VS_FF_PRIVATEBUILD")
 145     if buildconfig.substs.get("NIGHTLY_BUILD"):
 146         flags.append("VS_FF_PRERELEASE")
 147
 148     defines = {
 149         "MOZ_APP_DISPLAYNAME": display_name,
 150         "MOZ_APP_VERSION": app_version,
 151         "MOZ_APP_WINVERSION": app_winversion,
 152     }
 153
 154     relobjdir = os.path.relpath(".", buildconfig.topobjdir)
 155     srcdir = os.path.join(buildconfig.topsrcdir, relobjdir)
 156     module_ver = os.path.join(srcdir, "module.ver")
 157     if os.path.exists(module_ver):
 158         deps.add(module_ver)
 159         overrides = parse_module_ver(module_ver, defines)
 160     else:
 161         overrides = {}
 162
 163     if rcinclude:
 164         include = "// From included resource {}\n{}".format(
 165             rcinclude, preprocess(rcinclude, defines).read()
 166         )
 167     else:
 168         include = ""
 169
 170     data = TEMPLATE.format(
 171         include=include,
 172         fileversion=overrides.get("WIN32_MODULE_FILEVERSION", milestone_winversion),
 173         productversion=overrides.get(
 174             "WIN32_MODULE_PRODUCTVERSION", milestone_winversion
 175         ),
 176         fileflags=" | ".join(flags),
 177         comment=overrides.get("WIN32_MODULE_COMMENT", ""),
 178         copyright=overrides.get("WIN32_MODULE_COPYRIGHT", "License: MPL 2"),
 179         company=overrides.get("WIN32_MODULE_COMPANYNAME", "Mozilla Foundation"),
 180         description=overrides.get("WIN32_MODULE_DESCRIPTION", ""),
 181         mfversion=overrides.get("WIN32_MODULE_FILEVERSION_STRING", milestone_string),
 182         mpversion=overrides.get("WIN32_MODULE_PRODUCTVERSION_STRING", milestone_string),
 183         module=overrides.get("WIN32_MODULE_NAME", ""),
 184         trademarks=overrides.get("WIN32_MODULE_TRADEMARKS", "Mozilla"),
 185         binary=overrides.get("WIN32_MODULE_ORIGINAL_FILENAME", binary),
 186         productname=overrides.get("WIN32_MODULE_PRODUCTNAME", display_name),
 187         buildid=buildid,
 188     )
 189
 190     manifest_id = "2" if binary.lower().endswith(".dll") else "1"
 191     if binary and not has_manifest(data, manifest_id):
 192         manifest_path = os.path.join(srcdir, binary + ".manifest")
 193         if os.path.exists(manifest_path):
 194             manifest_path = manifest_path.replace("\\", "\\\\")
 195             data += '\n{} RT_MANIFEST "{}"\n'.format(manifest_id, manifest_path)
 196
 197     with io.open("{}.rc".format(binary or "module"), "w", encoding="latin1") as fh:
 198         fh.write(data)
 199
 200
 201 if __name__ == "__main__":
 202     generate_module_rc(*sys.argv[1:])