archive_images.py

#!/usr/bin/env python
# Copyright 2015 The Chromium OS Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""
Usage:
  ./archive_images.py -a path_to_archiver -d input_output_dir

  input_output_dir should points to the directory where images are created by
  build_images.py. The script outputs archives to input_output_dir.

  path_to_archiver should points to the tool which bundles files into a blob,
  which can be unpacked by Depthcharge.
"""

from collections import defaultdict
import getopt
import glob
import os
import subprocess
import sys

LOCALE_DIR = 'locale'
LOCALE_RO_DIR = os.path.join(LOCALE_DIR, 'ro')
LOCALE_RW_DIR = os.path.join(LOCALE_DIR, 'rw')


def archive_images(archiver, output, name, files):
    """Archives files.

    Args:
        archiver: path to the archive tool
        output: path to the output directory
        name: name of the archive file
        files: list of files to be archived
    """
    archive = os.path.join(output, name)
    args = ' '.join(files)
    command = '%s %s create %s' % (archiver, archive, args)
    subprocess.check_call(command, shell=True)


def archive_base(archiver, output):
    """Archives base (locale-independent) images.

    Args:
        archiver: path to the archive tool
        output: path to the output directory
    """
    base_images = glob.glob(os.path.join(output, '*.bmp'))

    # create archive of base images
    archive_images(archiver, output, 'vbgfx.bin', base_images)


def archive_localized(archiver, output, pattern):
    """Archives localized images.

    Args:
        archiver: path to the archive tool
        output: path to the output directory
        pattern: filename with a '%s' to fill in the locale code
    """
    locale_images = defaultdict(lambda: [])

    for path in glob.glob(os.path.join(output, '*')):
        files = glob.glob(os.path.join(path, '*.bmp'))
        locale = os.path.basename(path)
        for file in files:
            locale_images[locale].append(file)

    # create archives of localized images
    for locale, images in locale_images.items():
        archive_images(archiver, output, pattern % locale, images)


def main(args):
    """Archives images."""
    opts, args = getopt.getopt(args, 'a:d:')
    archiver = ''
    output = ''

    for opt, arg in opts:
        if opt == '-a':
            archiver = arg
        elif opt == '-d':
            output = arg
        else:
            assert False, 'Invalid option'
    if args or not archiver or not output:
        assert False, 'Invalid usage'

    print('Archiving vbfgx.bin', file=sys.stderr, flush=True)
    archive_base(archiver, output)
    print('Archiving locales for RO', file=sys.stderr, flush=True)
    ro_locale_dir = os.path.join(output, LOCALE_RO_DIR)
    rw_locale_dir = os.path.join(output, LOCALE_RW_DIR)
    archive_localized(archiver, ro_locale_dir, 'locale_%s.bin')
    if os.path.exists(rw_locale_dir):
        print('Archiving locales for RW', file=sys.stderr, flush=True)
        archive_localized(archiver, rw_locale_dir, 'rw_locale_%s.bin')


if __name__ == '__main__':
    main(sys.argv[1:])