brave-core/script/lib/util.py

# Copyright (c) 2021 The Brave Authors. All rights reserved.
# 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/.

from __future__ import print_function

import atexit
import contextlib
import errno
import shutil
import ssl
import subprocess
import sys
import tarfile
import tempfile
try:
    from urllib.request import urlopen
except ImportError:
    from urllib2 import urlopen
import os
import zipfile

from .config import is_verbose_mode


def tempdir(prefix=''):
    directory = tempfile.mkdtemp(prefix=prefix)
    atexit.register(shutil.rmtree, directory)
    return directory


@contextlib.contextmanager
def scoped_cwd(path):
    cwd = os.getcwd()
    os.chdir(path)
    try:
        yield
    finally:
        os.chdir(cwd)


@contextlib.contextmanager
def scoped_env(key, value):
    origin = ''
    if key in os.environ:
        origin = os.environ[key]
    os.environ[key] = value
    try:
        yield
    finally:
        os.environ[key] = origin


def extract_tarball(tarball_path, member, destination):
    with tarfile.open(tarball_path) as tarball:
        tarball.extract(member, destination)


def get_lzma_exec():
    root_src_dir = os.path.abspath(
        os.path.join(os.path.dirname(__file__), *[os.pardir] * 3))
    if sys.platform == 'win32':
        lzma_exec = os.path.join(root_src_dir, "third_party", "lzma_sdk",
                                 "bin", "win64", "7za.exe")
    elif sys.platform == 'darwin':
        lzma_exec = os.path.join(root_src_dir, "..", "..", "third_party",
                                 "lzma_sdk", "bin", "mac64", "7zz")
    else:
        lzma_exec = '7zr'  # Use system 7zr.
    return lzma_exec


def extract_zip(zip_path, destination, path_prefix=None):
    if sys.platform in ('darwin', 'linux'):
        # Use the unzip command to properly handle symbolic links.
        args = ['unzip', zip_path]
        if path_prefix:
            args.append(path_prefix + '*')
        args.extend(['-d', destination])
        execute(args)
    else:
        with zipfile.ZipFile(zip_path) as z:
            members = None
            if path_prefix is not None:
                members = [
                    m for m in z.namelist() if m.startswith(path_prefix)
                ]
            z.extractall(destination, members=members)


def make_zip(zip_file_path, files, dirs):
    safe_unlink(zip_file_path)
    # This code originally comes from Electron. It is not entirely clear why the
    # implementation has a special case for macOS. It seems likely that it is to
    # support symlinks. The special macOS implementation has one subtle
    # difference to the pure-Python one further below: It does not error out for
    # missing files.
    if sys.platform == 'darwin':
        files += dirs
        execute(['zip', '-r', '-y', zip_file_path] + files)
    else:
        zip_file = zipfile.ZipFile(zip_file_path, "w", zipfile.ZIP_DEFLATED,
                                   allowZip64=True)
        for filename in files:
            zip_file.write(filename, filename)
        for dirname in dirs:
            for root, _, filenames in os.walk(dirname):
                for f in filenames:
                    zip_file.write(os.path.join(root, f))
        zip_file.close()


def make_7z(archive_file_path, files, dirs):
    safe_unlink(archive_file_path)
    files += dirs
    execute([get_lzma_exec(), 'a', '-t7z', '-mx7', archive_file_path] + files)


def rm_rf(path):
    try:
        shutil.rmtree(path)
    except OSError:
        pass


def safe_unlink(path):
    try:
        os.unlink(path)
    except OSError as e:
        if e.errno != errno.ENOENT:
            raise


def safe_mkdir(path):
    try:
        os.makedirs(path)
    except OSError as e:
        if e.errno != errno.EEXIST:
            raise


def execute(argv, env=os.environ):  # pylint: disable=dangerous-default-value
    if is_verbose_mode():
        print(' '.join(argv))
    argv_string = argv if isinstance(argv, str) else ' '.join(argv)
    try:
        if sys.version_info.major == 2:
            process = subprocess.Popen(
                argv, env=env, stdout=subprocess.PIPE, stderr=subprocess.PIPE,
                universal_newlines=True)
        else:
            process = subprocess.Popen(argv,
                                       env=env,
                                       stdout=subprocess.PIPE,
                                       stderr=subprocess.PIPE,
                                       encoding='utf-8',
                                       universal_newlines=True)
        stdout, stderr = process.communicate()
        if is_verbose_mode() or process.returncode != 0:
            if sys.version_info.major == 2:
                printable_stdout = stdout
            else:
                # Fix any unsupported characters in print encoder.
                printable_stdout = stdout.encode(  # pylint: disable=no-member
                    sys.stdout.encoding,
                    'backslashreplace').decode(sys.stdout.encoding)
            # Print the output instead of raising it, so that we get pretty
            # output. Most useful erroroutput from typescript / webpack is in
            # stdout and not stderr.
            print(printable_stdout)
            if process.returncode != 0:
                raise RuntimeError('Command \'%s\' failed' % (argv_string),
                                   stderr)
        return stdout
    except subprocess.CalledProcessError as e:
        print('Error in subprocess:')
        print(argv_string)
        if sys.version_info.major > 2:
            print(e.stderr)  # pylint: disable=no-member
        raise e


# pylint: disable=dangerous-default-value
def execute_stdout(argv, env=os.environ):
    if is_verbose_mode():
        print(' '.join(argv))
        try:
            subprocess.check_call(argv, env=env)
        except subprocess.CalledProcessError as e:
            print(e.output)
            raise e
    else:
        execute(argv, env)