# 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/.
import os import re import subprocess import sys from pathlib import Path
from mach.util import to_optional_path, win_to_msys_path from mozbuild.bootstrap import bootstrap_all_toolchains_for, bootstrap_toolchain from mozfile import which from packaging.version import Version
from mozboot import rust from mozboot.util import (
MINIMUM_RUST_VERSION,
http_download_and_save,
)
NO_MERCURIAL = """
Could not find Mercurial (hg) in the current shell's path. Try starting a new
shell and running the bootstrapper again. """
MERCURIAL_UNABLE_UPGRADE = """
You are currently running Mercurial %s. Running %s or newer is
recommended for performance and stability reasons.
Unfortunately, this bootstrapper currently does not know how to automatically
upgrade Mercurial on your machine.
You can usually install Mercurial through your package manager or by
downloading a package fromhttp://mercurial.selenic.com/. """
MERCURIAL_UPGRADE_FAILED = """
We attempted to upgrade Mercurial to a modern version (%s or newer).
However, you appear to have version %s still.
It's possible your package manager doesn't support a modern version of
Mercurial. It's also possible Mercurial is not being installed in the search
path for this shell. Try creating a new shell and run this bootstrapper again.
If it continues to fail, consider installing Mercurial by following the
instructions at http://mercurial.selenic.com/. """
MERCURIAL_INSTALL_PROMPT = """
Mercurial releases a new version every 3 months and your distro's package
may become out of date. This may cause incompatibility with some
Mercurial extensions that rely on new Mercurial features. As a result,
you may not have an optimal version control experience.
To have the best Mercurial experience possible, we recommend installing
Mercurial via the "pip" Python packaging utility. This will likely result in files being placed in /usr/local/bin and /usr/local/lib.
How would you like to continue?
1. Install a modern Mercurial via pip [default]
2. Install a legacy Mercurial via the distro package manager
3. Do not install Mercurial
Your choice: """
PYTHON_UNABLE_UPGRADE = """
You are currently running Python %s. Running %s or newer (but not 3.x) is required.
Unfortunately, this bootstrapper does not currently know how to automatically
upgrade Python on your machine.
Please search the Internet for how to upgrade your Python andtry running this
bootstrapper again to ensure your machine is up to date. """
RUST_INSTALL_COMPLETE = """
Rust installation complete. You should now have rustc and cargo in %(cargo_bin)s
The installer tries to add these to your default shell PATH, so
restarting your shell and running this script again may work. If it doesn't, you'll need to add the new command location
manually.
If restarting doesn't work, edit your shell initialization
script, which may be called ~/.bashrc or ~/.bash_profile or
~/.profile, and add the following line:
%(cmd)s
Then restart your shell and run the bootstrap script again. """
RUST_NOT_IN_PATH = """
You have some rust files in %(cargo_bin)s
but they're not part of this shell's PATH.
To add these to the PATH, edit your shell initialization
script, which may be called ~/.bashrc or ~/.bash_profile or
~/.profile, and add the following line:
%(cmd)s
Then restart your shell and run the bootstrap script again. """
RUSTUP_OLD = """
We found an executable called `rustup` which we normally use to install and upgrade Rust programming language support, but we didn't understand
its output. It may be an old version, ornot be the installer from https://rustup.rs/
Please move it out of the way and run the bootstrap script again. Orif you prefer and know how, use the current rustup to install
a compatible version of the Rust programming language yourself. """
RUST_UPGRADE_FAILED = """
We attempted to upgrade Rust to a modern version (%s or newer).
However, you appear to still have version %s.
It's possible rustup failed. It's also possible the new Rust isnot being
installed in the search path for this shell. Try creating a new shell and
run this bootstrapper again.
If this continues to fail and you are sure you have a modern Rust on your
system, ensure it is on the $PATH andtry again. If that fails, you'll need to
install Rust manually.
We recommend the installer fromhttps://rustup.rs/for installing Rust,
but you may be able to get a recent enough version from a software install
tool or package manager on your system, or directly fromhttps://rust-lang.org/ """
BROWSER_ARTIFACT_MODE_MOZCONFIG = """ # Automatically download and use compiled C++ components:
ac_add_options --enable-artifact-builds """.strip()
JS_MOZCONFIG_TEMPLATE = """\ # Build only the SpiderMonkey JS test shell
ac_add_options --enable-project=js """
# Upgrade Mercurial older than this. # This should match the OLDEST_NON_LEGACY_VERSION in # version-control-tools/hgext/configwizard/__init__.py.
MODERN_MERCURIAL_VERSION = Version("4.9")
# Upgrade rust older than this.
MODERN_RUST_VERSION = Version(MINIMUM_RUST_VERSION)
class BaseBootstrapper(object): """Base class for system bootstrappers."""
def validate_environment(self): """
Called once the current firefox checkout has been detected.
Platform-specific implementations should check the environment and offer advice/warnings
to the user, if necessary. """
def suggest_install_pip3(self): """Called if pip3 can't be found."""
print( "Try installing pip3 with your system's package manager.", file=sys.stderr
)
def install_system_packages(self): """
Install packages shared by all applications. These are usually
packages required by the development (like mercurial) or the
build system (like autoconf). """ raise NotImplementedError( "%s must implement install_system_packages()" % __name__
)
def install_browser_packages(self, mozconfig_builder): """
Install packages required to build Firefox for Desktop (application 'browser'). """ raise NotImplementedError( "Cannot bootstrap Firefox for Desktop: " "%s does not yet implement install_browser_packages()" % __name__
)
def ensure_browser_packages(self): """
Install pre-built packages needed to build Firefox for Desktop (application 'browser')
Currently this isnot needed and kept for compatibility with Firefox for Android. """ pass
def generate_js_mozconfig(self): """
Create a reasonable starting point for a JS shell build. """ return JS_MOZCONFIG_TEMPLATE
def install_browser_artifact_mode_packages(self, mozconfig_builder): """
Install packages required to build Firefox for Desktop (application 'browser') in Artifact Mode. """ raise NotImplementedError( "Cannot bootstrap Firefox for Desktop Artifact Mode: " "%s does not yet implement install_browser_artifact_mode_packages()"
% __name__
)
def generate_browser_artifact_mode_mozconfig(self): """
Print a message to the console detailing what the user's mozconfig
should contain.
Firefox for Desktop Artifact Mode needs to enable artifact builds and
a path where the build artifacts will be written to. """ return BROWSER_ARTIFACT_MODE_MOZCONFIG
def install_mobile_android_packages(self, mozconfig_builder): """
Install packages required to build GeckoView (application 'mobile/android'). """ raise NotImplementedError( "Cannot bootstrap GeckoView/Firefox for Android: " "%s does not yet implement install_mobile_android_packages()" % __name__
)
def ensure_mobile_android_packages(self): """
Install pre-built packages required to run GeckoView (application 'mobile/android') """ raise NotImplementedError( "Cannot bootstrap GeckoView/Firefox for Android: " "%s does not yet implement ensure_mobile_android_packages()" % __name__
)
def ensure_mobile_android_artifact_mode_packages(self): """
Install pre-built packages required to run GeckoView Artifact Build
(application 'mobile/android') """
self.ensure_mobile_android_packages()
def generate_mobile_android_mozconfig(self): """
Print a message to the console detailing what the user's mozconfig
should contain.
GeckoView/Firefox for Android needs an application and an ABI set, and it needs
paths to the Android SDK and NDK. """ raise NotImplementedError( "%s does not yet implement generate_mobile_android_mozconfig()" % __name__
)
def install_mobile_android_artifact_mode_packages(self, mozconfig_builder): """
Install packages required to build GeckoView/Firefox for Android (application 'mobile/android', also known as Fennec) in Artifact Mode. """ raise NotImplementedError( "Cannot bootstrap GeckoView/Firefox for Android Artifact Mode: " "%s does not yet implement install_mobile_android_artifact_mode_packages()"
% __name__
)
def generate_mobile_android_artifact_mode_mozconfig(self): """
Print a message to the console detailing what the user's mozconfig
should contain.
GeckoView/Firefox for Android Artifact Mode needs an application and an ABI set, and it needs paths to the Android SDK. """ raise NotImplementedError( "%s does not yet implement generate_mobile_android_artifact_mode_mozconfig()"
% __name__
)
def auto_bootstrap(self, application, exclude=[]):
args = ["--with-ccache=sccache"] if application.endswith("_artifact_mode"):
args.append("--enable-artifact-builds")
application = application[: -len("_artifact_mode")]
args.append("--enable-project={}".format(application.replace("_", "/"))) if exclude:
args.append( "--enable-bootstrap={}".format(",".join(f"-{x}"for x in exclude))
)
bootstrap_all_toolchains_for(args)
def run_as_root(self, command, may_use_sudo=True): if os.geteuid() != 0: if may_use_sudo and which("sudo"):
command.insert(0, "sudo") else:
command = ["su", "root", "-c", " ".join(command)]
print("Executing as root:", subprocess.list2cmdline(command))
subprocess.check_call(command, stdin=sys.stdin)
def prompt_int(self, prompt, low, high, default=None): """Prompts the user with prompt and requires an integer between low and high.
If the user doesn't select an option and a default isn't provided, then
the lowest option is used. This is because some option must be implicitly
selected if mach is invoked with"--no-interactive" """ if default isnotNone: assert isinstance(default, int) assert low <= default <= high else:
default = low
if self.no_interactive:
print(prompt)
print('Selecting "{}" because context is not interactive.'.format(default)) return default
whileTrue:
choice = input(prompt) if choice == ""and default isnotNone: return default try:
choice = int(choice) if low <= choice <= high: return choice except ValueError: pass
print("ERROR! Please enter a valid option!")
def prompt_yesno(self, prompt): """Prompts the user with prompt and requires a yes/no answer.""" if self.no_interactive:
print(prompt)
print('Selecting "Y" because context is not interactive.') returnTrue
def _update_package_manager(self): """Updates the package manager's manifests/package list.
This should be defined in child classes. """
def _parse_version_impl(self, path: Path, name, env, version_param): """Execute the given path, returning the version.
Invokes the path argument with the --version switch and returns a Version representing the output if successful. Ifnot, returns None.
An optional name argument gives the expected program
name returned as part of the version string, if it's
different from the basename of the executable.
An optional env argument allows modifying environment
variable during the invocation to set options, PATH,
etc. """ ifnot name:
name = path.name if name.lower().endswith(".exe"):
name = name[:-4]
process = subprocess.run(
[str(path), version_param],
env=env,
universal_newlines=True,
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT,
) if process.returncode != 0: # This can happen e.g. if the user has an inactive pyenv shim in # their path. Just silently treat this as a failure to parse the # path and move on. returnNone
match = re.search(name + r" ([a-z0-9\.]+)", process.stdout) ifnot match:
print("ERROR! Unable to identify %s version." % name) returnNone
def _hg_cleanenv(self, load_hgrc=False): """Returns a copy of the current environment updated with the HGPLAIN and HGRCPATH environment variables.
HGPLAIN prevents Mercurial from applying locale variations to the output
making it suitable for use in scripts.
HGRCPATH controls the loading of hgrc files. Setting it to the empty
string forces that no user or system hgrc file is used. """
env = os.environ.copy()
env["HGPLAIN"] = "1" ifnot load_hgrc:
env["HGRCPATH"] = ""
def ensure_mercurial_modern(self):
installed, modern, version = self.is_mercurial_modern()
if modern:
print("Your version of Mercurial (%s) is sufficiently modern." % version) return installed, modern
self._ensure_package_manager_updated()
if installed:
print("Your version of Mercurial (%s) is not modern enough." % version)
print( "(Older versions of Mercurial have known security vulnerabilities. " "Unless you are running a patched Mercurial version, you may be " "vulnerable."
) else:
print("You do not have Mercurial installed")
if self.upgrade_mercurial(version) isFalse: return installed, modern
installed, modern, after = self.is_mercurial_modern()
if installed andnot modern:
print(MERCURIAL_UPGRADE_FAILED % (MODERN_MERCURIAL_VERSION, after))
ReturnFalse to not perform a version check after the upgrade is
performed. """
print(MERCURIAL_UNABLE_UPGRADE % (current, MODERN_MERCURIAL_VERSION))
def warn_if_pythonpath_is_set(self): if"PYTHONPATH"in os.environ:
print( "WARNING: Your PYTHONPATH environment variable is set. This can " "cause flaky installations of the requirements, and other unexpected " "issues with mach. It is recommended to unset this variable."
)
def is_rust_modern(self, cargo_bin: Path):
rustc = to_optional_path(which("rustc", extra_search_dirs=[str(cargo_bin)])) ifnot rustc:
print("Could not find a Rust compiler.") returnFalse, None
def print_rust_path_advice(self, template, cargo_home: Path, cargo_bin: Path): # Suggest ~/.cargo/env if it exists. if (cargo_home / "env").exists():
cmd = f"source {cargo_home}/env" else: # On Windows rustup doesn't write out ~/.cargo/env # so fall back to a manual PATH update. Bootstrap # only runs under msys, so a unix-style shell command # is appropriate there.
cargo_bin = win_to_msys_path(cargo_bin)
cmd = f"export PATH={cargo_bin}:$PATH"
print(template % {"cargo_bin": cargo_bin, "cmd": cmd})
def ensure_rust_modern(self):
cargo_home, cargo_bin = self.cargo_home()
modern, version = self.is_rust_modern(cargo_bin)
if modern:
print("Your version of Rust (%s) is new enough." % version)
elif version:
print("Your version of Rust (%s) is too old." % version)
if rustup andnot modern:
rustup_version = self._parse_version(rustup) ifnot rustup_version:
print(RUSTUP_OLD)
sys.exit(1)
print("Found rustup. Will try to upgrade.")
self.upgrade_rust(rustup)
modern, after = self.is_rust_modern(cargo_bin) ifnot modern:
print(RUST_UPGRADE_FAILED % (MODERN_RUST_VERSION, after))
sys.exit(1) elifnot rustup: # No rustup. Download and run the installer.
print("Will try to install Rust.")
self.install_rust()
modern, version = self.is_rust_modern(cargo_bin)
rustup = to_optional_path(
which("rustup", extra_search_dirs=[str(cargo_bin)])
)
self.ensure_rust_targets(rustup, version)
def ensure_rust_targets(self, rustup: Path, rust_version): """Make sure appropriate cross target libraries are installed."""
target_list = subprocess.check_output(
[str(rustup), "target", "list"], universal_newlines=True
)
targets = [
line.split()[0] for line in target_list.splitlines() if"installed"in line or"default"in line
]
print("Rust supports %s targets." % ", ".join(targets))
# Support 32-bit Windows on 64-bit Windows.
win32 = "i686-pc-windows-msvc"
win64 = "x86_64-pc-windows-msvc" if rust.platform() == win64 and win32 notin targets:
subprocess.check_call([str(rustup), "target", "add", win32])
if"mobile_android"in self.application: # Let's add the most common targets. if rust_version < Version("1.33"):
arm_target = "armv7-linux-androideabi" else:
arm_target = "thumbv7neon-linux-androideabi"
android_targets = (
arm_target, "aarch64-linux-android", "i686-linux-android", "x86_64-linux-android",
) for target in android_targets: if target notin targets:
subprocess.check_call([str(rustup), "target", "add", target])
Invoke rustup from the given path to update the rust install."""
subprocess.check_call([str(rustup), "update"]) # This installs rustfmt when not already installed, or nothing # otherwise, while the update above would have taken care of upgrading # it.
subprocess.check_call([str(rustup), "component", "add", "rustfmt"])
def install_rust(self): """Download and run the rustup installer.""" import errno import stat import tempfile
Die Informationen auf dieser Webseite wurden
nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit,
noch Qualität der bereit gestellten Informationen zugesichert.
Bemerkung:
Die farbliche Syntaxdarstellung ist noch experimentell.