buildtools/wafsamba/samba_version.py

   1 import os
   2 import Utils
   3 import samba_utils
   4 import sys
   5
   6 def bzr_version_summary(path):
   7     try:
   8         import bzrlib
   9     except ImportError:
  10         return ("BZR-UNKNOWN", {})
  11
  12     import bzrlib.ui
  13     bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
  14         sys.stdin, sys.stdout, sys.stderr)
  15     from bzrlib import branch, osutils, workingtree
  16     from bzrlib.plugin import load_plugins
  17     load_plugins()
  18
  19     b = branch.Branch.open(path)
  20     (revno, revid) = b.last_revision_info()
  21     rev = b.repository.get_revision(revid)
  22
  23     fields = {
  24         "BZR_REVISION_ID": revid,
  25         "BZR_REVNO": revno,
  26         "COMMIT_DATE": osutils.format_date_with_offset_in_original_timezone(rev.timestamp,
  27             rev.timezone or 0),
  28         "COMMIT_TIME": int(rev.timestamp),
  29         "BZR_BRANCH": rev.properties.get("branch-nick", ""),
  30         }
  31
  32     # If possible, retrieve the git sha
  33     try:
  34         from bzrlib.plugins.git.object_store import get_object_store
  35     except ImportError:
  36         # No git plugin
  37         ret = "BZR-%d" % revno
  38     else:
  39         store = get_object_store(b.repository)
  40         full_rev = store._lookup_revision_sha1(revid)
  41         fields["GIT_COMMIT_ABBREV"] = full_rev[:7]
  42         fields["GIT_COMMIT_FULLREV"] = full_rev
  43         ret = "GIT-" + fields["GIT_COMMIT_ABBREV"]
  44
  45     if workingtree.WorkingTree.open(path).has_changes():
  46         fields["COMMIT_IS_CLEAN"] = 0
  47         ret += "+"
  48     else:
  49         fields["COMMIT_IS_CLEAN"] = 1
  50     return (ret, fields)
  51
  52
  53 def git_version_summary(path, env=None):
  54     # Get version from GIT
  55     if not 'GIT' in env and os.path.exists("/usr/bin/git"):
  56         # this is useful when doing make dist without configuring
  57         env.GIT = "/usr/bin/git"
  58
  59     if not 'GIT' in env:
  60         return ("GIT-UNKNOWN", {})
  61
  62     environ = dict(os.environ)
  63     environ["GIT_DIR"] = '%s/.git' % path
  64     environ["GIT_WORK_TREE"] = path
  65     git = Utils.cmd_output(env.GIT + ' show --pretty=format:"%h%n%ct%n%H%n%cd" --stat HEAD', silent=True, env=environ)
  66
  67     lines = git.splitlines()
  68     if not lines or len(lines) < 4:
  69         return ("GIT-UNKNOWN", {})
  70
  71     fields = {
  72             "GIT_COMMIT_ABBREV": lines[0],
  73             "GIT_COMMIT_FULLREV": lines[2],
  74             "COMMIT_TIME": int(lines[1]),
  75             "COMMIT_DATE": lines[3],
  76             }
  77
  78     ret = "GIT-" + fields["GIT_COMMIT_ABBREV"]
  79
  80     if env.GIT_LOCAL_CHANGES:
  81         clean = Utils.cmd_output('%s diff HEAD | wc -l' % env.GIT, silent=True).strip()
  82         if clean == "0":
  83             fields["COMMIT_IS_CLEAN"] = 1
  84         else:
  85             fields["COMMIT_IS_CLEAN"] = 0
  86             ret += "+"
  87
  88     return (ret, fields)
  89
  90
  91 class SambaVersion(object):
  92
  93     def __init__(self, version_dict, path, env=None, is_install=True):
  94         '''Determine the version number of samba
  95
  96 See VERSION for the format.  Entries on that file are
  97 also accepted as dictionary entries here
  98         '''
  99
 100         self.MAJOR=None
 101         self.MINOR=None
 102         self.RELEASE=None
 103         self.REVISION=None
 104         self.TP_RELEASE=None
 105         self.ALPHA_RELEASE=None
 106         self.PRE_RELEASE=None
 107         self.RC_RELEASE=None
 108         self.IS_SNAPSHOT=True
 109         self.RELEASE_NICKNAME=None
 110         self.VENDOR_SUFFIX=None
 111         self.VENDOR_PATCH=None
 112
 113         for a, b in version_dict.iteritems():
 114             if a.startswith("SAMBA_VERSION_"):
 115                 setattr(self, a[14:], b)
 116             else:
 117                 setattr(self, a, b)
 118
 119         if self.IS_GIT_SNAPSHOT == "yes":
 120             self.IS_SNAPSHOT=True
 121         elif self.IS_GIT_SNAPSHOT == "no":
 122             self.IS_SNAPSHOT=False
 123         else:
 124             raise Exception("Unknown value for IS_GIT_SNAPSHOT: %s" % self.IS_GIT_SNAPSHOT)
 125
 126  ##
 127  ## start with "3.0.22"
 128  ##
 129         self.MAJOR=int(self.MAJOR)
 130         self.MINOR=int(self.MINOR)
 131         self.RELEASE=int(self.RELEASE)
 132
 133         SAMBA_VERSION_STRING = ("%u.%u.%u" % (self.MAJOR, self.MINOR, self.RELEASE))
 134
 135 ##
 136 ## maybe add "3.0.22a" or "4.0.0tp11" or "4.0.0alpha1" or "3.0.22pre1" or "3.0.22rc1"
 137 ## We do not do pre or rc version on patch/letter releases
 138 ##
 139         if self.REVISION is not None:
 140             SAMBA_VERSION_STRING += self.REVISION
 141         if self.TP_RELEASE is not None:
 142             self.TP_RELEASE = int(self.TP_RELEASE)
 143             SAMBA_VERSION_STRING += "tp%u" % self.TP_RELEASE
 144         if self.ALPHA_RELEASE is not None:
 145             self.ALPHA_RELEASE = int(self.ALPHA_RELEASE)
 146             SAMBA_VERSION_STRING += ("alpha%u" % self.ALPHA_RELEASE)
 147         if self.PRE_RELEASE is not None:
 148             self.PRE_RELEASE = int(self.PRE_RELEASE)
 149             SAMBA_VERSION_STRING += ("pre%u" % self.PRE_RELEASE)
 150         if self.RC_RELEASE is not None:
 151             self.RC_RELEASE = int(self.RC_RELEASE)
 152             SAMBA_VERSION_STRING += ("rc%u" % self.RC_RELEASE)
 153
 154         if self.IS_SNAPSHOT:
 155             if not is_install:
 156                 suffix = "DEVELOPERBUILD"
 157                 self.vcs_fields = {}
 158             elif os.path.exists(os.path.join(path, ".git")):
 159                 suffix, self.vcs_fields = git_version_summary(path, env=env)
 160             elif os.path.exists(os.path.join(path, ".bzr")):
 161                 suffix, self.vcs_fields = bzr_version_summary(path)
 162             else:
 163                 suffix = "UNKNOWN"
 164                 self.vcs_fields = {}
 165             SAMBA_VERSION_STRING += "-" + suffix
 166         else:
 167             self.vcs_fields = {}
 168
 169         self.OFFICIAL_STRING = SAMBA_VERSION_STRING
 170
 171         if self.VENDOR_SUFFIX is not None:
 172             SAMBA_VERSION_STRING += ("-" + self.VENDOR_SUFFIX)
 173             self.VENDOR_SUFFIX = self.VENDOR_SUFFIX
 174
 175             if self.VENDOR_PATCH is not None:
 176                 SAMBA_VERSION_STRING += ("-" + self.VENDOR_PATCH)
 177                 self.VENDOR_PATCH = self.VENDOR_PATCH
 178
 179         self.STRING = SAMBA_VERSION_STRING
 180
 181         if self.RELEASE_NICKNAME is not None:
 182             self.STRING_WITH_NICKNAME = "%s (%s)" % (self.STRING, self.RELEASE_NICKNAME)
 183         else:
 184             self.STRING_WITH_NICKNAME = self.STRING
 185
 186     def __str__(self):
 187         string="/* Autogenerated by waf */\n"
 188         string+="#define SAMBA_VERSION_MAJOR %u\n" % self.MAJOR
 189         string+="#define SAMBA_VERSION_MINOR %u\n" % self.MINOR
 190         string+="#define SAMBA_VERSION_RELEASE %u\n" % self.RELEASE
 191         if self.REVISION is not None:
 192             string+="#define SAMBA_VERSION_REVISION %u\n" % self.REVISION
 193
 194         if self.TP_RELEASE is not None:
 195             string+="#define SAMBA_VERSION_TP_RELEASE %u\n" % self.TP_RELEASE
 196
 197         if self.ALPHA_RELEASE is not None:
 198             string+="#define SAMBA_VERSION_ALPHA_RELEASE %u\n" % self.ALPHA_RELEASE
 199
 200         if self.PRE_RELEASE is not None:
 201             string+="#define SAMBA_VERSION_PRE_RELEASE %u\n" % self.PRE_RELEASE
 202
 203         if self.RC_RELEASE is not None:
 204             string+="#define SAMBA_VERSION_RC_RELEASE %u\n" % self.RC_RELEASE
 205
 206         for name in sorted(self.vcs_fields.keys()):
 207             string+="#define SAMBA_VERSION_%s " % name
 208             value = self.vcs_fields[name]
 209             if isinstance(value, basestring):
 210                 string += "\"%s\"" % value
 211             elif type(value) is int:
 212                 string += "%d" % value
 213             else:
 214                 raise Exception("Unknown type for %s: %r" % (name, value))
 215             string += "\n"
 216
 217         string+="#define SAMBA_VERSION_OFFICIAL_STRING \"" + self.OFFICIAL_STRING + "\"\n"
 218
 219         if self.VENDOR_SUFFIX is not None:
 220             string+="#define SAMBA_VERSION_VENDOR_SUFFIX " + self.VENDOR_SUFFIX + "\n"
 221             if self.VENDOR_PATCH is not None:
 222                 string+="#define SAMBA_VERSION_VENDOR_PATCH " + self.VENDOR_PATCH + "\n"
 223
 224         if self.RELEASE_NICKNAME is not None:
 225             string+="#define SAMBA_VERSION_RELEASE_NICKNAME " + self.RELEASE_NICKNAME + "\n"
 226
 227         # We need to put this #ifdef in to the headers so that vendors can override the version with a function
 228         string+='''
 229 #ifdef SAMBA_VERSION_VENDOR_FUNCTION
 230 #  define SAMBA_VERSION_STRING SAMBA_VERSION_VENDOR_FUNCTION
 231 #else /* SAMBA_VERSION_VENDOR_FUNCTION */
 232 #  define SAMBA_VERSION_STRING "''' + self.STRING_WITH_NICKNAME + '''"
 233 #endif
 234 '''
 235         string+="/* Version for mkrelease.sh: \nSAMBA_VERSION_STRING=" + self.STRING_WITH_NICKNAME + "\n */\n"
 236
 237         return string
 238
 239
 240 def samba_version_file(version_file, path, env=None, is_install=True):
 241     '''Parse the version information from a VERSION file'''
 242
 243     f = open(version_file, 'r')
 244     version_dict = {}
 245     for line in f:
 246         line = line.strip()
 247         if line == '':
 248             continue
 249         if line.startswith("#"):
 250             continue
 251         try:
 252             split_line = line.split("=")
 253             if split_line[1] != "":
 254                 value = split_line[1].strip('"')
 255                 version_dict[split_line[0]] = value
 256         except:
 257             print("Failed to parse line %s from %s" % (line, version_file))
 258             raise
 259
 260     return SambaVersion(version_dict, path, env=env, is_install=is_install)
 261
 262
 263
 264 def load_version(env=None, is_install=True):
 265     '''load samba versions either from ./VERSION or git
 266     return a version object for detailed breakdown'''
 267     if not env:
 268         env = samba_utils.LOAD_ENVIRONMENT()
 269
 270     version = samba_version_file("./VERSION", ".", env, is_install=is_install)
 271     Utils.g_module.VERSION = version.STRING
 272     return version