Add pmbootstrap bootimg_analyze / prompt during new device wizard (#905)

pmb/parse/__init__.py

@@ -21,4 +21,5 @@ from pmb.parse.apkbuild import apkbuild
 from pmb.parse.binfmt_info import binfmt_info
 from pmb.parse.deviceinfo import deviceinfo
 from pmb.parse.kconfig import check
+from pmb.parse.bootimg import bootimg
 import pmb.parse.arch

pmb/parse/arguments.py

@@ -316,6 +316,11 @@ def arguments():
     config.add_argument("name", nargs="?", help="variable name")
     config.add_argument("value", nargs="?", help="set variable to value")
 
+    # Action: bootimg_analyze
+    bootimg_analyze = sub.add_parser("bootimg_analyze", help="Extract all the"
+                                     " information from an existing boot.img")
+    bootimg_analyze.add_argument("path", help="path to the boot.img")
+
     # Use defaults from the user's config file
     args = parser.parse_args()
     cfg = pmb.config.load(args)
@@ -346,7 +351,7 @@ def arguments():
                             "find_aport": {}})
 
     # Add and verify the deviceinfo (only after initialization)
-    if args.action not in ("init", "config"):
+    if args.action not in ("init", "config", "bootimg_analyze"):
         setattr(args, "deviceinfo", pmb.parse.deviceinfo(args))
         arch = args.deviceinfo["arch"]
         if (arch != args.arch_native and

pmb/parse/bootimg.py

@@ -0,0 +1,73 @@
+"""
+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 os
+import logging
+import pmb
+
+
+def bootimg(args, path):
+    if not os.path.exists(path):
+        raise RuntimeError("Could not find file '" + path + "'")
+
+    logging.info("NOTE: You will be prompted for your sudo password, so we can set"
+                 " up a chroot to extract and analyze your boot.img file")
+    pmb.chroot.apk.install(args, ["file", "unpackbootimg"])
+
+    temp_path = pmb.chroot.other.tempfolder(args, "/tmp/bootimg_parser")
+    bootimg_path = args.work + "/chroot_native" + temp_path + "/boot.img"
+
+    # Copy the boot.img into the chroot temporary folder
+    pmb.helpers.run.root(args, ["cp", path, bootimg_path])
+
+    file_output = pmb.chroot.user(args, ["file", "-b", "boot.img"], working_dir=temp_path,
+                                  return_stdout=True).rstrip()
+    if "android bootimg" not in file_output.lower():
+        if "linux kernel" in file_output.lower():
+            raise RuntimeError("File is a Kernel image, you might need the 'heimdall-isorec'"
+                               " flash method. See also: "
+                               "<https://wiki.postmarketos.org/wiki/Deviceinfo_flash_methods>")
+        else:
+            raise RuntimeError("File is not an Android bootimg. (" + file_output + ")")
+
+    # Extract all the files
+    pmb.chroot.user(args, ["unpackbootimg", "-i", "boot.img"], working_dir=temp_path)
+
+    output = {}
+    # Get base, offsets, pagesize, cmdline and qcdt info
+    with open(bootimg_path + "-base", 'r') as f:
+        output["base"] = ("0x%08x" % int(f.read().replace('\n', ''), 16))
+    with open(bootimg_path + "-kernel_offset", 'r') as f:
+        output["kernel_offset"] = ("0x%08x" % int(f.read().replace('\n', ''), 16))
+    with open(bootimg_path + "-ramdisk_offset", 'r') as f:
+        output["ramdisk_offset"] = ("0x%08x" % int(f.read().replace('\n', ''), 16))
+    with open(bootimg_path + "-second_offset", 'r') as f:
+        output["second_offset"] = ("0x%08x" % int(f.read().replace('\n', ''), 16))
+    with open(bootimg_path + "-tags_offset", 'r') as f:
+        output["tags_offset"] = ("0x%08x" % int(f.read().replace('\n', ''), 16))
+    with open(bootimg_path + "-pagesize", 'r') as f:
+        output["pagesize"] = f.read().replace('\n', '')
+    with open(bootimg_path + "-cmdline", 'r') as f:
+        output["cmdline"] = f.read().replace('\n', '')
+    output["qcdt"] = ("true" if os.path.isfile(bootimg_path + "-dt") and
+                      os.path.getsize(bootimg_path + "-dt") > 0 else "false")
+
+    # Cleanup
+    pmb.chroot.root(args, ["rm", "-r", temp_path])
+
+    return output