melanie

#!/usr/bin/env python

# General purpose package removal tool for ftpmaster
# Copyright (C) 2000, 2001  James Troup <james@nocrew.org>
# $Id: melanie,v 1.21 2002-01-28 18:53:01 troup Exp $

# This program 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 2 of the License, or
# (at your option) any later version.

# This program 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 this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

# X-Listening-To: Astronomy, Metallica - Garage Inc.

################################################################################

import commands, os, pg, pwd, re, string, sys, tempfile
import utils, db_access
import apt_pkg, apt_inst;

################################################################################

re_strip_source_version = re.compile (r'\s+.*$');

################################################################################

Cnf = None;
projectB = None;

################################################################################

def usage (exit_code=0):
    print """Usage: melanie [OPTIONS] PACKAGE[...]
Remove PACKAGE(s) from suite(s).

  -a, --architecture=ARCH    only act on this architecture
  -b, --binary               remove binaries only
  -c, --component=COMPONENT  act on this component
  -C, --carbon-copy=EMAIL    send a CC of removal message to EMAIL
  -d, --done=BUG#            send removal message as closure to bug#
  -m, --reason=MSG           reason for removal
  -n, --no-action            don't do anything
  -p, --partial              don't affect override files
  -s, --suite=SUITE          act on this suite
  -S, --source-only          remove source only
  -h, --help                 show this help and exit

ARCH, BUG#, COMPONENT and SUITE can be space seperated lists, e.g.
    --architecture=\"m68k i386\""""

    sys.exit(exit_code)

################################################################################

# "That's just fucking great!  Game over, man!  What the fuck are we
#  going to do now?"

def game_over():
    print "Continue (y/N)? ",
    answer = string.lower(utils.our_raw_input());
    if answer != "y":
        print "Aborted."
        sys.exit(1);

################################################################################

def main ():
    global Cnf, projectB;

    Cnf = utils.get_conf()

    Arguments = [('h',"help","Melanie::Options::Help"),
                 ('a',"architecture","Melanie::Options::Architecture", "HasArg"),
                 ('b',"binary", "Melanie::Options::Binary-Only"),
                 ('c',"component", "Melanie::Options::Component", "HasArg"),
                 ('C',"carbon-copy", "Melanie::Options::Carbon-Copy", "HasArg"), # Bugs to Cc
                 ('d',"done","Melanie::Options::Done", "HasArg"), # Bugs fixed
                 ('m',"reason", "Melanie::Options::Reason", "HasArg"), # Hysterical raisins; -m is old-dinstall option for rejection reason
                 ('n',"no-action","Melanie::Options::No-Action"),
                 ('p',"partial", "Melanie::Options::Partial"),
                 ('s',"suite","Melanie::Options::Suite", "HasArg"),
                 ('S',"source-only", "Melanie::Options::Source-Only"),
                 ];

    for i in ["help", "architecture", "binary-only", "component", "carbon-copy", "done", "reason", "no-action", "partial", "source-only" ]:
	if not Cnf.has_key("Melanie::Options::%s" % (i)):
	    Cnf["Melanie::Options::%s" % (i)] = "";
    if not Cnf.has_key("Melanie::Options::Suite"):
	Cnf["Melanie::Options::Suite"] = "unstable";

    arguments = apt_pkg.ParseCommandLine(Cnf,Arguments,sys.argv);
    Options = Cnf.SubTree("Melanie::Options")

    if Options["Help"]:
	usage();

    projectB = pg.connect(Cnf["DB::Name"], Cnf["DB::Host"], int(Cnf["DB::Port"]));
    db_access.init(Cnf, projectB);

    # Sanity check options
    if not arguments:
        utils.fubar("need at least one package name as an argument.");
    if Options["Architecture"] and Options["Source-Only"]:
        utils.fubar("can't use -a/--architecutre and -S/--source-only options simultaneously.");
    if Options["Binary-Only"] and Options["Source-Only"]:
        utils.fubar("can't use -b/--binary-only and -S/--source-only options simultaneously.");
    if Options.has_key("Carbon-Copy") and not Options.has_key("Done"):
        utils.fubar("can't use -C/--carbon-copy without also using -d/--done option.");
    if Options["Architecture"] and not Options["Partial"]:
        utils.warn("-a/--architecture implies -p/--partial.");
        Options["Partial"] = "true";

    # Process -C/--carbon-copy
    #
    # Accept 3 types of arguments (space separated):
    #  1) a number - assumed to be a bug number, i.e. nnnnn@bugs.debian.org
    #  2) the keyword 'package' - cc's $package@packages.debian.org for every argument
    #  3) contains a '@' - assumed to be an email address, used unmofidied
    #
    carbon_copy = [];
    for copy_to in string.split(Options.get("Carbon-Copy")):
        if utils.str_isnum(copy_to):
            carbon_copy.append(copy_to + "@" + Cnf["Dinstall::BugServer"]);
        elif copy_to == 'package':
            for package in arguments:
                carbon_copy.append(package + "@" + Cnf["Dinstall::PackagesServer"]);
                if Cnf.has_key("Dinstall::TrackingServer"):
                    carbon_copy.append(package + "@" + Cnf["Dinstall::TrackingServer"]);
        elif '@' in copy_to:
            carbon_copy.append(copy_to);
        else:
            utils.fubar("Invalid -C/--carbon-copy argument '%s'; not a bug number, 'package' or email address." % (copy_to));

    packages = {};
    if Options["Binary-Only"]:
        field = "b.package";
    else:
        field = "s.source";
    quoted_packages_list = []
    for package in arguments:
        quoted_packages_list.append("'%s'" % package)
        packages[package] = "";
    con_packages = "AND %s IN (%s)" % (field, string.join(quoted_packages_list, ", "));
    suites = [];
    suite_ids_list = [];
    for suite in string.split(Options["Suite"]):

        if not Options["No-Action"] and suite == "stable":
            print "**WARNING** About to remove from the stable suite!"
            print "This should only be done just prior to a (point) release and not at"
            print "any other time."
            game_over();
        elif not Options["No-Action"] and suite == "testing":
            print "**WARNING About to remove from the testing suite!"
            print "There's no need to do this normally as removals from unstable will"
            print "propogate to testing automagically."
            game_over();

        suite_id = db_access.get_suite_id(suite);
        if suite_id == -1:
            utils.warn("suite '%s' not recognised." % (suite));
        else:
            suites.append(suite);
            suite_ids_list.append(suite_id);
    if suite_ids_list:
        suites_list = string.join(suites, ", ")
        con_suites = "AND su.id IN (%s)" % string.join(map(str, suite_ids_list), ", ");
    else:
        utils.fubar("No correct suite given.");
    if Options["Component"]:
        components_ids_list = [];
        for component in string.split(Options["Component"]):
            component_id = db_access.get_component_id(component);
            if component_id == -1:
                utils.warn("component '%s' not recognised." % (component));
            else:
                components_ids_list.append(component_id);
        con_components = "AND c.id IN (%s)" % string.join(map(str, components_ids_list), ", ");
        over_con_components = "AND component IN (%s)" % string.join(map(str, components_ids_list), ", ");
    else:
        con_components = "";
        over_con_components = "";

    if Options["Architecture"]:
        arch_ids_list = [];
        for architecture in string.split(Options["Architecture"]):
            architecture_id = db_access.get_architecture_id(architecture);
            if architecture_id == -1:
                utils.warn("architecture '%s' not recognised." % (architecture));
            else:
                arch_ids_list.append(architecture_id);
        if arch_ids_list:
            con_architectures = "AND a.id IN (%s)" % string.join(map(str, arch_ids_list), ", ");
        else:
            utils.fubar("No correct architecture given");
    else:
        con_architectures = "";


    print "Working...",
    sys.stdout.flush();
    to_remove = [];
    maintainers = {};

    # We have 3 modes of package selection: binary-only, source-only
    # and source+binary.  The first two are trivial and obvious; the
    # latter is a nasty mess, but very nice from a UI perspective so
    # we try to support it.

    if Options["Binary-Only"]:
        # Binary-only
        q = projectB.query("SELECT b.package, b.version, a.arch_string, b.id, b.maintainer FROM binaries b, bin_associations ba, architecture a, suite su, files f, location l, component c WHERE ba.bin = b.id AND ba.suite = su.id AND b.architecture = a.id AND b.file = f.id AND f.location = l.id AND l.component = c.id %s %s %s %s" % (con_packages, con_suites, con_components, con_architectures));
        for i in q.getresult():
            to_remove.append(i);
    else:
        # Source-only
        source_packages = {};
        q = projectB.query("SELECT l.path, f.filename, s.source, s.version, 'source', s.id, s.maintainer FROM source s, src_associations sa, suite su, files f, location l, component c WHERE sa.source = s.id AND sa.suite = su.id AND s.file = f.id AND f.location = l.id AND l.component = c.id %s %s %s" % (con_packages, con_suites, con_components));
        for i in q.getresult():
            source_packages[i[2]] = i[:2];
            to_remove.append(i[2:]);
        if not Options["Source-Only"]:
            # Source + Binary
            binary_packages = {};
            # First get a list of binary package names we suspect are linked to the source
            q = projectB.query("SELECT DISTINCT package FROM binaries WHERE EXISTS (SELECT s.source, s.version, l.path, f.filename FROM source s, src_associations sa, suite su, files f, location l, component c WHERE binaries.source = s.id AND sa.source = s.id AND sa.suite = su.id AND s.file = f.id AND f.location = l.id AND l.component = c.id %s %s %s)" % (con_packages, con_suites, con_components));
            for i in q.getresult():
                binary_packages[i[0]] = "";
            # Then parse each .dsc that we found earlier to see what binary packages it thinks it produces
            for i in source_packages.keys():
                filename = string.join(source_packages[i], '/');
                try:
                    dsc = utils.parse_changes(filename, 0);
                except utils.cant_open_exc:
                    utils.warn("couldn't open '%s'." % (filename));
                    continue;
                for package in string.split(dsc.get("binary"), ','):
                    package = string.strip(package);
                    binary_packages[package] = "";
            # Then for each binary package: find any version in
            # unstable, check the Source: field in the deb matches our
            # source package and if so add it to the list of packages
            # to be removed.
            for package in binary_packages.keys():
                q = projectB.query("SELECT l.path, f.filename, b.package, b.version, a.arch_string, b.id, b.maintainer FROM binaries b, bin_associations ba, architecture a, suite su, files f, location l, component c WHERE ba.bin = b.id AND ba.suite = su.id AND b.architecture = a.id AND b.file = f.id AND f.location = l.id AND l.component = c.id %s %s %s AND b.package = '%s'" % (con_suites, con_components, con_architectures, package));
                for i in q.getresult():
                    filename = string.join(i[:2], '/');
                    control = apt_pkg.ParseSection(apt_inst.debExtractControl(utils.open_file(filename)))
                    source = control.Find("Source", control.Find("Package"));
                    source = re_strip_source_version.sub('', source);
                    if source_packages.has_key(source):
                        to_remove.append(i[2:]);
    print "done."

    # If we don't have a reason; spawn an editor so the user can add one
    # Write the rejection email out as the <foo>.reason file
    if not Options["Reason"] and not Options["No-Action"]:
        temp_filename = tempfile.mktemp();
        fd = os.open(temp_filename, os.O_RDWR|os.O_CREAT|os.O_EXCL, 0700);
        os.close(fd);
        editor = os.environ.get("EDITOR","vi")
        result = os.system("%s %s" % (editor, temp_filename))
        if result != 0:
            utils.fubar ("vi invocation failed for `%s'!" % (temp_filename), result)
        file = utils.open_file(temp_filename);
        for line in file.readlines():
            Options["Reason"] = Options["Reason"] + line;
        os.unlink(temp_filename);

    # Generate the summary of what's to be removed
    d = {};
    for i in to_remove:
        package = i[0];
        version = i[1];
        architecture = i[2];
        maintainer = i[4];
        maintainers[maintainer] = "";
        if not d.has_key(package):
            d[package] = {};
        if not d[package].has_key(version):
            d[package][version] = [];
        if architecture not in d[package][version]:
            d[package][version].append(architecture);

    maintainer_list = [];
    for maintainer_id in maintainers.keys():
        maintainer_list.append(db_access.get_maintainer(maintainer_id));
    summary = "";
    packages = d.keys();
    packages.sort();
    for package in packages:
        versions = d[package].keys();
        versions.sort();
        for version in versions:
            summary = summary + "%10s | %10s | %s\n" % (package, version, string.join(d[package][version], ", "));
    print "Will remove the following packages from %s:" % (suites_list);
    print
    print summary
    print "Maintainer: %s" % string.join(maintainer_list, ", ")
    if Options["Done"]:
        print "Will also close bugs: "+Options["Done"];
    if carbon_copy:
        print "Will also send CCs to:" + string.join(carbon_copy, ", ")
    print
    print "------------------- Reason -------------------"
    print Options["Reason"];
    print "----------------------------------------------"
    print

    # If -n/--no-action, drop out here
    if Options["No-Action"]:
        sys.exit(0);

    game_over();

    whoami = utils.whoami();
    date = commands.getoutput('date -R');

    # Log first; if it all falls apart I want a record that we at least tried.
    logfile = utils.open_file(Cnf["Melanie::LogFile"], 'a');
    logfile.write("=========================================================================\n");
    logfile.write("[Date: %s] [ftpmaster: %s]\n" % (date, whoami));
    logfile.write("Removed the following packages from %s:\n\n%s" % (suites_list, summary));
    if Options["Done"]:
        logfile.write("Closed bugs: %s\n" % (Options["Done"]));
    logfile.write("\n------------------- Reason -------------------\n%s\n" % (Options["Reason"]));
    logfile.write("----------------------------------------------\n");
    logfile.flush();

    dsc_type_id = db_access.get_override_type_id('dsc');
    deb_type_id = db_access.get_override_type_id('deb');

    # Do the actual deletion
    print "Deleting...",
    sys.stdout.flush();
    projectB.query("BEGIN WORK");
    for i in to_remove:
        package = i[0];
        architecture = i[2];
        package_id = i[3];
        for suite_id in suite_ids_list:
            if architecture == "source":
                projectB.query("DELETE FROM src_associations WHERE source = %s AND suite = %s" % (package_id, suite_id));
                #print "DELETE FROM src_associations WHERE source = %s AND suite = %s" % (package_id, suite_id);
            else:
                projectB.query("DELETE FROM bin_associations WHERE bin = %s AND suite = %s" % (package_id, suite_id));
                #print "DELETE FROM bin_associations WHERE bin = %s AND suite = %s" % (package_id, suite_id);
            # Delete from the override file
            if not Options["Partial"]:
                if architecture == "source":
                    type_id = dsc_type_id;
                else:
                    type_id = deb_type_id;
                projectB.query("DELETE FROM override WHERE package = '%s' AND type = %s AND suite = %s %s" % (package, type_id, suite_id, over_con_components));
    projectB.query("COMMIT WORK");
    print "done."

    # Send the bug closing messages
    if Options["Done"]:
        Subst = {};
        Subst["__MELANIE_ADDRESS__"] = Cnf["Melanie::MyEmailAddress"];
        Subst["__BUG_SERVER__"] = Cnf["Dinstall::BugServer"];
        bcc = [];
        if Cnf.Find("Dinstall::Bcc") != "":
            bcc.append(Cnf["Dinstall::Bcc"]);
        if Cnf.Find("Melanie::Bcc") != "":
            bcc.append(Cnf["Melanie::Bcc"]);
        if bcc:
            Subst["__BCC__"] = "Bcc: " + string.join(bcc, ", ");
        else:
            Subst["__BCC__"] = "X-Filler: 42";
        Subst["__CC__"] = "X-Melanie: $Revision: 1.21 $";
        if carbon_copy:
            Subst["__CC__"] = Subst["__CC__"] + "\nCc: " + string.join(carbon_copy, ", ");
        Subst["__SUITE_LIST__"] = suites_list;
        Subst["__SUMMARY__"] = summary;
        Subst["__ADMIN_ADDRESS__"] = Cnf["Dinstall::MyAdminAddress"];
        Subst["__DISTRO__"] = Cnf["Dinstall::MyDistribution"];
        Subst["__WHOAMI__"] = whoami;
        whereami = utils.where_am_i();
        Archive = Cnf.SubTree("Archive::%s" % (whereami));
        Subst["__MASTER_ARCHIVE__"] = Archive["OriginServer"];
        Subst["__PRIMARY_MIRROR__"] = Archive["PrimaryMirror"];
        for bug in string.split(Options["Done"]):
            Subst["__BUG_NUMBER__"] = bug;
            mail_message = utils.TemplateSubst(Subst,open(Cnf["Dir::TemplatesDir"]+"/melanie.bug-close","r").read());
            utils.send_mail (mail_message, "")

    logfile.write("=========================================================================\n");
    logfile.close();

#######################################################################################

if __name__ == '__main__':
    main()