<h2>Edit File: flatpak-bisect</h2><form method="post"><textarea name="content" rows="20" cols="80">#!/usr/bin/python3

import re
import argparse
import os
import gi
import json
import subprocess

gi.require_version(&#039;Flatpak&#039;, &#039;1.0&#039;)
from gi.repository import Flatpak
from gi.repository import GLib

def get_bisection_data():
        return {&#039;ref&#039;: None, &#039;good&#039;: None, &#039;bad&#039;: None,
                &#039;refs&#039;: None, &#039;log&#039;: None, &#039;messages&#039;: None}

class Bisector():
    def load_cache(self):
        try:
            os.makedirs(os.path.join(GLib.get_user_cache_dir(), &#039;flatpak&#039;))
        except FileExistsError:
            pass

        self.cache_path = os.path.join(GLib.get_user_cache_dir(),
                                       &#039;flatpak&#039;, &#039;%s-%s-bisect.status&#039; % (
                                       self.name, self.branch))
        try:
            with open(self.cache_path, &#039;rb&#039;) as f:
                self.data = json.load(f)
        except FileNotFoundError:
            self.data = None

    def dump_data(self):
        with open(self.cache_path, &#039;w&#039;) as f:
            json.dump(self.data, f)

    def setup_flatpak_app(self):
        self.installation = Flatpak.Installation.new_user()
        kind = Flatpak.RefKind.APP
        if self.runtime:
            kind = Flatpak.RefKind.RUNTIME
        try:
            self.cref = self.installation.get_installed_ref(kind, self.name, None, self.branch, None)
        except GLib.Error as e:
            print(&quot;%s\n\nMake sure %s is installed as a &quot;
                  &quot;user (flatpak install --user) and specify `--runtime`&quot;
                  &quot; if it is a runtime.&quot; % (e, self.name))
            return -1
        return 0

    def run(self):
        self.name = self.name[0]
        self.load_cache()
        res = self.setup_flatpak_app()
        if res:
            return res

        try:
            func = getattr(self, self.subparser_name)
        except AttributeError:
            print(&#039;No action called %s&#039; % self.subparser_name)

            return -1

        res = func()

        if self.data:
            self.dump_data()

        return res

    def set_reference_commits(self, set_name, check_name):
        if not self.data:
            print(&quot;You need to first start the bisection&quot;)
            return -1
        ref = self.cref.get_latest_commit()

        if self.data[check_name] == ref:
            print(&#039;Commit %s is already set as %s...&#039; % (
                ref, check_name))
            return 1

        if ref not in self.data[&#039;refs&#039;]:
            print(&quot;%s is not a known commit.&quot; % ref)
            return -1

        print(&quot;Setting %s as %s commit&quot; % (ref, set_name))
        self.data[set_name] = ref

        if self.data[set_name] and self.data[check_name]:
            x1 = self.data[&#039;refs&#039;].index(self.data[&#039;good&#039;])
            x2 = self.data[&#039;refs&#039;].index(self.data[&#039;bad&#039;])

            refs = self.data[&#039;refs&#039;][x1:x2]
            if not refs:
                print(&quot;==========================&quot;
                      &quot;First bad commit is:\n%s&quot;
                      &quot;==========================&quot; % self.data[&#039;message&#039;][self.data[&#039;bad&#039;]])
                exit(0)
            ref = refs[int(len(refs) / 2)]
            if self.data[&#039;good&#039;] == ref:
                print(&quot;\n==========================\n&quot;
                      &quot;First bad commit is:\n\n%s&quot;
                      &quot;==========================&quot; % self.data[&#039;messages&#039;][self.data[&#039;bad&#039;]])
                exit(0)

            return self.checkout(ref)

        return -1

    def load_refs(self):
        repodir, refname = self.download_history()
        history = subprocess.check_output([&#039;ostree&#039;, &#039;log&#039;, &#039;--repo&#039;, repodir, refname]).decode()

        refs = []
        messages = {}
        message = &quot;&quot;
        _hash = &#039;&#039;
        for l in history.split(&#039;\n&#039;):
            rehash = re.search(&#039;(?&lt;=^commit )\w+&#039;, l)
            if rehash:
                if message:
                    messages[_hash] = message
                _hash = rehash.group(0)
                refs.insert(0, _hash)
                message = &quot;&quot;
            message += l + &#039;\n&#039;

        if message:
            messages[_hash] = message

        self.data[&#039;refs&#039;] = refs
        self.data[&#039;log&#039;] = history
        self.data[&#039;messages&#039;] = messages

    def good(self):
        if not self.data[&#039;bad&#039;]:
            print(&quot;Set the bad commit first&quot;)
            exit(-1)
        return self.set_reference_commits(&#039;good&#039;, &#039;bad&#039;)

    def bad(self):
        return self.set_reference_commits(&#039;bad&#039;, &#039;good&#039;)

    def start(self):
        if self.data:
            print(&#039;Bisection already started&#039;)
            return -1

        print(&quot;Updating to %s latest commit&quot; % self.name)
        self.reset(False)
        self.data = get_bisection_data()
        self.load_refs()

    def download_history(self):
        print(&quot;Getting history&quot;)
        appidir = os.path.abspath(os.path.join(self.cref.get_deploy_dir(), &#039;..&#039;))
        dirname = &quot;app&quot;
        if self.runtime:
            dirname = &quot;runtime&quot;
        appidir = appidir.split(&#039;/%s/&#039; % dirname)
        repodir = os.path.join(appidir[0], &#039;repo&#039;)
        refname = self.cref.get_origin() + &#039;:&#039; + dirname + &#039;/&#039; + self.cref.get_name() + &#039;/&#039; + self.cref.get_arch() + &#039;/&#039; + self.cref.get_branch()
        # FIXME Getting `error: Exceeded maximum recursion` in ostree if using --depth=-1 (or &gt; 250)
        subprocess.call([&#039;ostree&#039;, &#039;pull&#039;, &#039;--depth=250&#039;, &#039;--commit-metadata-only&#039;, &#039;--repo&#039;, repodir, refname])

        return repodir, refname

    def log(self):
        if self.data:
            cmd = [&#039;echo&#039;, self.data[&#039;log&#039;]]
        else:
            repodir, refname = self.download_history()
            cmd = [&#039;ostree&#039;, &#039;log&#039;, &#039;--repo&#039;, repodir, refname]
        pager = os.environ.get(&#039;PAGER&#039;)
        if pager:
            stdout = subprocess.PIPE
        else:
            stdout = None
        p = subprocess.Popen(cmd, stdout=stdout)
        if pager:
            subprocess.check_call((pager), stdin=p.stdout)
        p.wait()

    def checkout(self, commit=None):
        if not commit:
            commit = self.commit[0]
        refname = self.cref.get_name() + &#039;/&#039; + self.cref.get_arch() + &#039;/&#039; + self.cref.get_branch()
        print(&quot;Checking out %s&quot; % commit)
        return subprocess.call([&#039;flatpak&#039;, &#039;update&#039;, &#039;--user&#039;, refname, &#039;--commit&#039;, commit])

    def reset(self, v=True):
        if not self.data:
            if v:
                print(&quot;Not bisecting, nothing to reset&quot;)
            return -1

        refname = self.cref.get_name() + &#039;/&#039; + self.cref.get_arch() + &#039;/&#039; + self.cref.get_branch()
        print(&quot;Removing %s&quot; % self.cache_path)
        os.remove(self.cache_path)
        self.data = None
        return subprocess.call([&#039;flatpak&#039;, &#039;update&#039;, &#039;--user&#039;, refname])

if __name__ == &quot;__main__&quot;:
    parser = argparse.ArgumentParser()
    parser.add_argument(&#039;name&#039;, nargs=1, help=&#039;Application/Runtime to bisect&#039;)
    parser.add_argument(&#039;-b&#039;, &#039;--branch&#039;, default=&#039;master&#039;, help=&#039;The branch to bisect&#039;)
    parser.add_argument(&#039;-r&#039;, &#039;--runtime&#039;,  action=&quot;store_true&quot;, help=&#039;Bisecting a runtime not an app&#039;)

    subparsers = parser.add_subparsers(dest=&#039;subparser_name&#039;)
    subparsers.required = True
    start_parser = subparsers.add_parser(&#039;start&#039;, help=&quot;Start bisection&quot;)
    bad_parser = subparsers.add_parser(&#039;bad&#039;, help=&quot;Set current version as bad&quot;)
    good_parser = subparsers.add_parser(&#039;good&#039;, help=&quot;Set current version as good&quot;)
    log_parser = subparsers.add_parser(&#039;log&#039;, help=&quot;Download and print application commit history&quot;)

    checkout_parser = subparsers.add_parser(&#039;checkout&#039;, help=&quot;Checkout defined commit&quot;)
    checkout_parser.add_argument(&#039;commit&#039;, nargs=1, help=&#039;The commit hash to checkout&#039;)

    reset_parser = subparsers.add_parser(&#039;reset&#039;, help=&quot;Reset all bisecting data and go back to latest commit&quot;)

    bisector = Bisector()
    options = parser.parse_args(namespace=bisector)
    bisector.run()
</textarea><br><input type="hidden" name="edit_file" value="flatpak-bisect"><input type="submit" value="Save"></form>