omaha_version_utils.py

#!/usr/bin/python2.4
#
# Copyright 2010 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ========================================================================

"""Constants and utilities related to Omaha versions."""

_ONECLICK_PLUGIN_NAME = 'npGoogleOneClick'
_UPDATE_PLUGIN_NAME = 'npGoogleUpdate'
_BHO_NAME = 'GoopdateBho'
_CRASH_HANDLER_NAME = 'GoogleCrashHandler'

# List of languages that are fully supported in the current build.
_OMAHA_LANGUAGES = [
    'am',
    'ar',
    'bg',
    'bn',
    'ca',
    'cs',
    'da',
    'de',
    'el',
    'en',
    'en-GB',
    'es',
    'es-419',
    'et',
    'fa',
    'fi',
    'fil',
    'fr',
    'gu',
    'hi',
    'hr',
    'hu',
    'id',
    'is',
    'it',
    'iw',
    'ja',
    'kn',
    'ko',
    'lt',
    'lv',
    'ml',
    'mr',
    'ms',
    'nl',
    'no',
    'pl',
    'pt-BR',
    'pt-PT',
    'ro',
    'ru',
    'sk',
    'sl',
    'sr',
    'sv',
    'sw',
    'ta',
    'te',
    'th',
    'tr',
    'uk',
    'ur',
    'vi',
    'zh-CN',
    'zh-TW',
    ]

# The shell and goopdate.dll contain additional languages.
# 'userdefault' addresses apps that don't look up the resource for the OS
# language. See http://b/1328652.
_ADDITIONAL_SHELL_LANGUAGES = [
    'or',
    'userdefault',
    'zh-HK',
    ]


def _IsSupportedOmaha2Version(omaha_version):
  """Returns true if omaha_version is an Omaha 2 version and is supported."""
  return (omaha_version[0] == 1 and
          omaha_version[1] == 2 and
          omaha_version[2] >= 183)


# All languages supported by this script currently have the same set of
# languages, so the omaha_version_info parameter is unused.
def _GetMetainstallerPayloadFilenames(prefix,
                                      update_plugin_filename,
                                      bho_filename,
                                      languages,
                                      omaha_version):
  """Returns list of metainstaller payload files for specified Omaha version."""
  plugin_dll_name = '%s%s' % (prefix, update_plugin_filename)
  bho_dll_name = '%s%s' % (prefix, bho_filename)

  # The list of files below needs to be kept in sync with the list in
  # SetupFiles::BuildFileLists().
  # TODO(omaha): Move the other filename defines in main.scons into this file
  # and allow all filenames to be customized.  At the moment, while the plugin
  # names are generated in one place due to version numbers, most of the other
  # files (googleupdate.exe, goopdateres_*.dll, etc.) are hardcoded all over
  # the place, and require a ton of point fixes to customize.
  payload_files = [
      'GoogleUpdate.exe',
      '%s.exe' % _CRASH_HANDLER_NAME,
      '%sgoopdate.dll' % (prefix),
      plugin_dll_name,
      bho_dll_name,
      'GoogleUpdateHelper.msi',
      'GoogleUpdateBroker.exe',
      'GoogleUpdateOnDemand.exe',
      '%spsmachine.dll' % (prefix),
      '%spsuser.dll' % (prefix),
      ]

  if (omaha_version[0] == 1 and
      omaha_version[1] == 3 and
      omaha_version[2] >= 13):
    # The BHO is not built yet.
    payload_files.remove(bho_dll_name)
  elif _IsSupportedOmaha2Version(omaha_version):
    payload_files.remove(plugin_dll_name)
    payload_files.remove('GoogleUpdateBroker.exe')
    payload_files.remove('GoogleUpdateOnDemand.exe')
    payload_files.remove('psmachine.dll')
    payload_files.remove('psuser.dll')
  else:
    raise Exception('Unsupported version: ' +
                    ConvertVersionToString(omaha_version))

  for language in languages:
    payload_files += ['%sgoopdateres_%s.dll' % (prefix, language)]

  return payload_files


def ConvertVersionToString(version):
  """Converts a four-element version list to a version string."""
  return '%d.%d.%d.%d' % (version[0], version[1], version[2], version[3])


def GetONECLICK_PLUGIN_NAME():  # pylint: disable-msg=C6409
  """Returns the value of the ONECLICK_PLUGIN_NAME define for the C++ code."""
  return _ONECLICK_PLUGIN_NAME


def GetUPDATE_PLUGIN_NAME():  # pylint: disable-msg=C6409
  """Returns the value of the UPDATE_PLUGIN_NAME define for the C++ code."""
  return _UPDATE_PLUGIN_NAME


def GetBHO_NAME():  # pylint: disable-msg=C6409
  """Returns the value of the BHO_NAME define for the C++ code."""
  return _BHO_NAME


def GetCRASH_HANDLER_NAME():  # pylint: disable-msg=C6409
  """Returns the value of the CRASH_HANDLER_NAME define for the C++ code."""
  return _CRASH_HANDLER_NAME


def GetLanguagesForVersion(omaha_version):
  """Returns a list of languages supported by omaha_version."""
  # Make a copy in case the list is modified below.
  supported_languages = list(_OMAHA_LANGUAGES)

  # When languages are added, add a version check for older versions without the
  # new languages and remove the new languages from supported_languages.

  if (omaha_version[0] == 1 and
      omaha_version[1] == 3 and
      omaha_version[2] >= 21):
    # All languages are supported.
    pass
  elif _IsSupportedOmaha2Version(omaha_version):
    # All current languages are supported. 'or' was also supported.
    supported_languages += ['or']
    supported_languages.remove('am')
    supported_languages.remove('sw')
  else:
    raise Exception('Unsupported version: ' +
                    ConvertVersionToString(omaha_version))

  return supported_languages


def GetShellLanguagesForVersion(omaha_version):
  """Returns a list of languages supported by the omaha_version shell."""

  # Silence PyLint. All languages supported by this script currently have the
  # same set of languages, so this variable is unused.
  omaha_version = omaha_version

  return _OMAHA_LANGUAGES + _ADDITIONAL_SHELL_LANGUAGES


class OmahaVersionInfo(object):
  """Contains information about a specific version of Omaha.

  Attributes:
    filename_prefix: Prefix to use for all output files.
    version_major: Major version.
    version_minor: Minor version.
    version_build: Build version.
    version_patch: Patch version.
    oneclick_plugin_version: Version of the OneClick plug-in.
    oneclick_plugin_filename: Name of the signed OneClick DLL.
    update_plugin_version: Version of the Omaha 3 plug-in.
    update_plugin_filename: Name of the signed Omaha 3 plug-in DLL.
    bho_filename:  Name of the signed BHO DLL.
    crash_handler_filename: Name of the Crash Handler EXE.
    oneclick_signed_file_info: SignedFileInfo object for the OneClick DLL.
    bho_signed_file_info: SignedFileInfo object for the BHO DLL.

  """

  def __init__(self, version_file):
    """Initializes the class based on data from a VERSION file."""
    self._ReadFile(version_file)

    self.filename_prefix = ''

    # Objects containing more properties used to build the file.
    self.oneclick_signed_file_info = SignedFileInfo(
        _ONECLICK_PLUGIN_NAME,
        'dll',
        self.oneclick_plugin_version)
    self.plugin_signed_file_info = SignedFileInfo(
        _UPDATE_PLUGIN_NAME,
        'dll',
        self.update_plugin_version)
    self.bho_signed_file_info = SignedFileInfo(_BHO_NAME, 'dll')

    # Simple properties for callers that only need the final filename. Not
    # affected by internal build changes.
    self.oneclick_plugin_filename = self.oneclick_signed_file_info.filename
    self.update_plugin_filename = self.plugin_signed_file_info.filename
    self.bho_filename = self.bho_signed_file_info.filename
    self.crash_handler_filename = _CRASH_HANDLER_NAME

  def _ReadFile(self, version_file):
    """Reads and stores data from a VERSION file."""

    execfile(version_file, globals())

    # Silence Pylint. Values from version_file are not defined in this file.
    # E0602: Undefined variable.
    # pylint: disable-msg=E0602

    if version_patch > 0:
      incrementing_value = version_patch
      incrementing_value_name = 'patch'
    else:
      incrementing_value = version_build
      incrementing_value_name = 'build'
    if 0 == incrementing_value % 2:
      raise Exception('ERROR: By convention, the %s number in VERSION '
                      '(currently %d) should be odd.' %
                      (incrementing_value_name, incrementing_value))

    self.version_major = version_major
    self.version_minor = version_minor
    self.version_build = version_build
    self.version_patch = version_patch

    self.oneclick_plugin_version = oneclick_plugin_version

    # update_plugin_version does not exist in Omaha 2 VERSION file. Handle this.
    try:
      self.update_plugin_version = update_plugin_version
    except NameError:
      if _IsSupportedOmaha2Version(self.GetVersion()):
        self.update_plugin_version = -1
      else:
        raise

    # pylint: enable-msg=E0602

  def MakeTestVersion(self, delta=1):
    """Changes this object to be for a TEST version of Omaha."""

    if delta <= 0:
      raise Exception('Delta must be greater than 0.')

    # If we're doing a patch, increment patch; else, increment build.
    if self.version_patch > 0:
      self.version_patch += delta
    else:
      self.version_build += delta

    self.filename_prefix = 'TEST_'

  def GetVersion(self):
    """Returns the version elements as a list."""
    return [self.version_major,
            self.version_minor,
            self.version_build,
            self.version_patch
           ]

  def GetVersionString(self):
    """Returns the version as a string."""
    return ConvertVersionToString(self.GetVersion())

  def GetSupportedLanguages(self):
    """Returns a list of languages supported by this version."""
    return GetLanguagesForVersion(self.GetVersion())

  def GetMetainstallerPayloadFilenames(self):
    """Returns list of metainstaller payload files for this version of Omaha."""
    return _GetMetainstallerPayloadFilenames(self.filename_prefix,
                                             self.update_plugin_filename,
                                             self.bho_filename,
                                             self.GetSupportedLanguages(),
                                             self.GetVersion())


class SignedFileInfo(object):
  """Contains information, including intermediate names, for signed file."""

  def __init__(self, unversioned_name, extension, file_version=None):
    """Initializes the class members based on the parameters."""

    if file_version:
      base_name = '%s%d' % (unversioned_name, file_version)
    else:
      base_name = unversioned_name

    self.filename_base = base_name
    self.filename = '%s.%s' % (self.filename_base, extension)

    self.unsigned_filename_base = '%s_unsigned' % base_name
    self.unsigned_filename = '%s.%s' % (self.unsigned_filename_base, extension)