pmbootstrap/pmb/flasher/export.py

"""
Copyright 2017 Oliver Smith

This file is part of pmbootstrap.

pmbootstrap is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

pmbootstrap is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with pmbootstrap.  If not, see <http://www.gnu.org/licenses/>.
"""
import logging
import os
import glob

import pmb.build
import pmb.chroot.apk
import pmb.config
import pmb.flasher
import pmb.helpers.file


def export(args, flavor, folder):
    logging.info("Export symlinks to: " + folder)
    if args.odin_flashable_tar:
        odin_flashable_tar(args, flavor, folder)
    symlinks(args, flavor, folder)


def symlinks(args, flavor, folder):
    """
    Create convenience symlinks to the system image and boot files.
    """

    # File descriptions
    info = {
        "boot.img-" + flavor: "Fastboot compatible boot.img file,"
        " contains initramfs and kernel",
        "initramfs-" + flavor: "Initramfs",
        "uInitrd-" + flavor: "Initramfs, legacy u-boot image format",
        "uImage-" + flavor: "Kernel, legacy u-boot image format",
        "vmlinuz-" + flavor: "Linux kernel",
        args.device + ".img": "System partition",
        "pmos-" + args.device + ".zip": "Android recovery flashable zip",
    }

    # Generate a list of patterns
    path_native = args.work + "/chroot_native"
    path_boot = args.work + "/chroot_rootfs_" + args.device + "/boot"
    path_buildroot = args.work + "/chroot_buildroot_" + args.deviceinfo["arch"]
    patterns = [path_boot + "/*-" + flavor,
                path_native + "/home/user/rootfs/" + args.device + ".img",
                path_buildroot +
                "/var/lib/postmarketos-android-recovery-installer/pmos-" +
                args.device + ".zip"]

    # Generate a list of files from the patterns
    files = []
    for pattern in patterns:
        files += glob.glob(pattern)

    # Iterate through all files
    for file in files:
        basename = os.path.basename(file)
        link = folder + "/" + basename

        # Display a readable message
        msg = " * " + basename
        if basename in info:
            msg += " (" + info[basename] + ")"
        logging.info(msg)

        pmb.helpers.file.symlink(args, file, link)


def odin_flashable_tar(args, flavor, folder):
    """
    Create Odin flashable tar file with kernel and initramfs for devices configured with
    the flasher method 'heimdall-isorec' and with boot.img for devices with 'heimdall-bootimg'
    """
    pmb.flasher.init(args)
    suffix = "rootfs_" + args.device

    # Validate method
    method = args.deviceinfo["flash_methods"]
    if not method.startswith("heimdall-"):
        raise RuntimeError("An odin flashable tar is not supported for the flash"
                           " method '" + method + "' specified in the current configuration."
                           " Only 'heimdall' methods are supported.")

    # Partitions
    partition_kernel = args.deviceinfo["flash_heimdall_partition_kernel"]
    partition_initfs = args.deviceinfo["flash_heimdall_partition_initfs"]

    # Temporary folder
    temp_folder = "/tmp/odin-flashable-tar"

    # Odin flashable tar generation script (because redirecting stdin/stdout is not allowed
    # in pmbootstrap's chroot/shell functions for security reasons)
    with open(args.work + "/chroot_rootfs_" + args.device + "/tmp/_odin.sh", "w") as handle:
        odin_kernel_md5 = partition_kernel + ".bin.md5"
        odin_initfs_md5 = partition_initfs + ".bin.md5"
        odin_device_tar = args.device + ".tar"
        odin_device_tar_md5 = args.device + ".tar.md5"

        handle.write(
            "#!/bin/sh\n"
            "cd " + temp_folder + "\n")
        if method == "heimdall-isorec":
            handle.write(
                # Kernel: copy and append md5
                "cp /boot/vmlinuz-" + flavor + " " + odin_kernel_md5 + "\n"
                "md5sum -t " + odin_kernel_md5 + " >> " + odin_kernel_md5 + "\n"
                # Initramfs: recompress with lzop, append md5
                "gunzip -c /boot/initramfs-" + flavor + " | lzop > " + odin_initfs_md5 + "\n"
                "md5sum -t " + odin_initfs_md5 + " >> " + odin_initfs_md5 + "\n")
        elif method == "heimdall-bootimg":
            handle.write(
                # boot.img: copy and append md5
                "cp /boot/boot.img-" + flavor + " " + odin_kernel_md5 + "\n"
                "md5sum -t " + odin_kernel_md5 + " >> " + odin_kernel_md5 + "\n")
        handle.write(
            # Create tar, remove included files and append md5
            "tar -c -f " + odin_device_tar + " *.bin.md5\n"
            "rm *.bin.md5\n"
            "md5sum -t " + odin_device_tar + " >> " + odin_device_tar + "\n"
            "mv " + odin_device_tar + " " + odin_device_tar_md5 + "\n")

    commands = [["mkdir", "-p", temp_folder],
                ["cat", "/tmp/_odin.sh"],  # for the log
                ["sh", "/tmp/_odin.sh"],
                ["rm", "/tmp/_odin.sh"]
                ]
    for command in commands:
        pmb.chroot.root(args, command, suffix)

    # Move Odin flashable tar to native chroot and cleanup temp folder
    pmb.chroot.user(args, ["mkdir", "-p", "/home/user/rootfs"])
    pmb.chroot.root(args, ["mv", "/mnt/rootfs_" + args.device + temp_folder +
                           "/" + odin_device_tar_md5, "/home/user/rootfs/"]),
    pmb.chroot.root(args, ["chown", "user:user",
                           "/home/user/rootfs/" + odin_device_tar_md5])
    pmb.chroot.root(args, ["rmdir", temp_folder], suffix)

    # Create the symlink
    file = args.work + "/chroot_native/home/user/rootfs/" + odin_device_tar_md5
    link = folder + "/" + odin_device_tar_md5
    pmb.helpers.file.symlink(args, file, link)

    # Display a readable message
    msg = " * " + odin_device_tar_md5
    if method == "heimdall-isorec":
        msg += " (Odin flashable file, contains initramfs and kernel)"
    elif method == "heimdall-bootimg":
        msg += " (Odin flashable file, contains boot.img)"
    logging.info(msg)