dak/clean_suites.py

   1 #!/usr/bin/env python
   2
   3 """ Cleans up unassociated binary and source packages """
   4 # Copyright (C) 2000, 2001, 2002, 2003, 2006  James Troup <james@nocrew.org>
   5
   6 # This program is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 2 of the License, or
   9 # (at your option) any later version.
  10
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program; if not, write to the Free Software
  18 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19
  20 ################################################################################
  21
  22 # 07:05|<elmo> well.. *shrug*.. no, probably not.. but to fix it,
  23 #      |       we're going to have to implement reference counting
  24 #      |       through dependencies.. do we really want to go down
  25 #      |       that road?
  26 #
  27 # 07:05|<Culus> elmo: Augh! <brain jumps out of skull>
  28
  29 ################################################################################
  30
  31 import os, stat, sys, time
  32 import apt_pkg
  33 from datetime import datetime, timedelta
  34
  35 from daklib.config import Config
  36 from daklib.dbconn import *
  37 from daklib import utils
  38 from daklib import daklog
  39
  40 ################################################################################
  41
  42 Options = None
  43 Logger = None
  44
  45 ################################################################################
  46
  47 def usage (exit_code=0):
  48     print """Usage: dak clean-suites [OPTIONS]
  49 Clean old packages from suites.
  50
  51   -n, --no-action            don't do anything
  52   -h, --help                 show this help and exit
  53   -m, --maximum              maximum number of files to remove"""
  54     sys.exit(exit_code)
  55
  56 ################################################################################
  57
  58 def check_binaries(now_date, delete_date, max_delete, session):
  59     print "Checking for orphaned binary packages..."
  60
  61     # Get the list of binary packages not in a suite and mark them for
  62     # deletion.
  63
  64     q = session.execute("""
  65 SELECT b.file, f.filename FROM binaries b, files f
  66  WHERE f.last_used IS NULL AND b.file = f.id
  67    AND NOT EXISTS (SELECT 1 FROM bin_associations ba WHERE ba.bin = b.id)""")
  68
  69     for i in q.fetchall():
  70         Logger.log(["set lastused", i[1]])
  71         session.execute("UPDATE files SET last_used = :lastused WHERE id = :fileid AND last_used IS NULL",
  72                         {'lastused': now_date, 'fileid': i[0]})
  73     session.commit()
  74
  75     # Check for any binaries which are marked for eventual deletion
  76     # but are now used again.
  77
  78     q = session.execute("""
  79 SELECT b.file, f.filename FROM binaries b, files f
  80    WHERE f.last_used IS NOT NULL AND f.id = b.file
  81     AND EXISTS (SELECT 1 FROM bin_associations ba WHERE ba.bin = b.id)""")
  82
  83     for i in q.fetchall():
  84         Logger.log(["unset lastused", i[1]])
  85         session.execute("UPDATE files SET last_used = NULL WHERE id = :fileid", {'fileid': i[0]})
  86     session.commit()
  87
  88 ########################################
  89
  90 def check_sources(now_date, delete_date, max_delete, session):
  91     print "Checking for orphaned source packages..."
  92
  93     # Get the list of source packages not in a suite and not used by
  94     # any binaries.
  95     q = session.execute("""
  96 SELECT s.id, s.file, f.filename FROM source s, files f
  97   WHERE f.last_used IS NULL AND s.file = f.id
  98     AND NOT EXISTS (SELECT 1 FROM src_associations sa WHERE sa.source = s.id)
  99     AND NOT EXISTS (SELECT 1 FROM binaries b WHERE b.source = s.id)""")
 100
 101     #### XXX: this should ignore cases where the files for the binary b
 102     ####      have been marked for deletion (so the delay between bins go
 103     ####      byebye and sources go byebye is 0 instead of StayOfExecution)
 104
 105     for i in q.fetchall():
 106         source_id = i[0]
 107         dsc_file_id = i[1]
 108         dsc_fname = i[2]
 109
 110         # Mark the .dsc file for deletion
 111         Logger.log(["set lastused", dsc_fname])
 112         session.execute("""UPDATE files SET last_used = :last_used
 113                                     WHERE id = :dscfileid AND last_used IS NULL""",
 114                         {'last_used': now_date, 'dscfileid': dsc_file_id})
 115
 116         # Mark all other files references by .dsc too if they're not used by anyone else
 117         x = session.execute("""SELECT f.id, f.filename FROM files f, dsc_files d
 118                               WHERE d.source = :sourceid AND d.file = f.id""",
 119                              {'sourceid': source_id})
 120         for j in x.fetchall():
 121             file_id = j[0]
 122             file_name = j[1]
 123             y = session.execute("SELECT id FROM dsc_files d WHERE d.file = :fileid", {'fileid': file_id})
 124             if len(y.fetchall()) == 1:
 125                 Logger.log(["set lastused", file_name])
 126                 session.execute("""UPDATE files SET last_used = :lastused
 127                                   WHERE id = :fileid AND last_used IS NULL""",
 128                                 {'lastused': now_date, 'fileid': file_id})
 129
 130     session.commit()
 131
 132     # Check for any sources which are marked for deletion but which
 133     # are now used again.
 134
 135     q = session.execute("""
 136 SELECT f.id, f.filename FROM source s, files f, dsc_files df
 137   WHERE f.last_used IS NOT NULL AND s.id = df.source AND df.file = f.id
 138     AND ((EXISTS (SELECT 1 FROM src_associations sa WHERE sa.source = s.id))
 139       OR (EXISTS (SELECT 1 FROM binaries b WHERE b.source = s.id)))""")
 140
 141     #### XXX: this should also handle deleted binaries specially (ie, not
 142     ####      reinstate sources because of them
 143
 144     for i in q.fetchall():
 145         Logger.log(["unset lastused", i[1]])
 146         session.execute("UPDATE files SET last_used = NULL WHERE id = :fileid",
 147                         {'fileid': i[0]})
 148
 149     session.commit()
 150
 151 ########################################
 152
 153 def check_files(now_date, delete_date, max_delete, session):
 154     # FIXME: this is evil; nothing should ever be in this state.  if
 155     # they are, it's a bug.
 156
 157     # However, we've discovered it happens sometimes so we print a huge warning
 158     # and then mark the file for deletion.  This probably masks a bug somwhere
 159     # else but is better than collecting cruft forever
 160
 161     print "Checking for unused files..."
 162     q = session.execute("""
 163 SELECT id, filename FROM files f
 164   WHERE NOT EXISTS (SELECT 1 FROM binaries b WHERE b.file = f.id)
 165     AND NOT EXISTS (SELECT 1 FROM dsc_files df WHERE df.file = f.id)
 166     AND last_used IS NULL
 167     ORDER BY filename""")
 168
 169     ql = q.fetchall()
 170     if len(ql) > 0:
 171         utils.warn("check_files found something it shouldn't")
 172         for x in ql:
 173             utils.warn("orphaned file: %s" % x)
 174             Logger.log(["set lastused", x[1], "ORPHANED FILE"])
 175             session.execute("UPDATE files SET last_used = :lastused WHERE id = :fileid",
 176                             {'lastused': now_date, 'fileid': x[0]})
 177
 178         session.commit()
 179
 180 def clean_binaries(now_date, delete_date, max_delete, session):
 181     # We do this here so that the binaries we remove will have their
 182     # source also removed (if possible).
 183
 184     # XXX: why doesn't this remove the files here as well? I don't think it
 185     #      buys anything keeping this separate
 186     print "Cleaning binaries from the DB..."
 187     print "Deleting from binaries table... "
 188     for bin in session.query(DBBinary).join(DBBinary.poolfile).filter(PoolFile.last_used <= delete_date):
 189         Logger.log(["delete binary", bin.poolfile.filename])
 190         if not Options["No-Action"]:
 191             session.delete(bin)
 192     if not Options["No-Action"]:
 193         session.commit()
 194
 195 ########################################
 196
 197 def clean(now_date, delete_date, max_delete, session):
 198     cnf = Config()
 199
 200     count = 0
 201     size = 0
 202
 203     print "Cleaning out packages..."
 204
 205     cur_date = now_date.strftime("%Y-%m-%d")
 206     dest = os.path.join(cnf["Dir::Morgue"], cnf["Clean-Suites::MorgueSubDir"], cur_date)
 207     if not os.path.exists(dest):
 208         os.mkdir(dest)
 209
 210     # Delete from source
 211     print "Deleting from source table... "
 212     q = session.execute("""
 213 SELECT s.id, f.filename FROM source s, files f
 214   WHERE f.last_used <= :deletedate
 215         AND s.file = f.id""", {'deletedate': delete_date})
 216     for s in q.fetchall():
 217         Logger.log(["delete source", s[1], s[0]])
 218         if not Options["No-Action"]:
 219             session.execute("DELETE FROM dsc_files WHERE source = :s_id", {"s_id":s[0]})
 220             session.execute("DELETE FROM source WHERE id = :s_id", {"s_id":s[0]})
 221
 222     if not Options["No-Action"]:
 223         session.commit()
 224
 225     # Delete files from the pool
 226     old_files = session.query(PoolFile).filter(PoolFile.last_used <= delete_date)
 227     if max_delete is not None:
 228         old_files = old_files.limit(max_delete)
 229         print "Limiting removals to %d" % max_delete
 230
 231     for pf in old_files:
 232         filename = os.path.join(pf.location.path, pf.filename)
 233         if not os.path.exists(filename):
 234             utils.warn("can not find '%s'." % (filename))
 235             continue
 236         Logger.log(["delete pool file", filename])
 237         if os.path.isfile(filename):
 238             if os.path.islink(filename):
 239                 count += 1
 240                 Logger.log(["delete symlink", filename])
 241                 if not Options["No-Action"]:
 242                     os.unlink(filename)
 243             else:
 244                 size += os.stat(filename)[stat.ST_SIZE]
 245                 count += 1
 246
 247                 dest_filename = dest + '/' + os.path.basename(filename)
 248                 # If the destination file exists; try to find another filename to use
 249                 if os.path.exists(dest_filename):
 250                     dest_filename = utils.find_next_free(dest_filename)
 251
 252                 Logger.log(["move to morgue", filename, dest_filename])
 253                 if not Options["No-Action"]:
 254                     utils.move(filename, dest_filename)
 255
 256             if not Options["No-Action"]:
 257                 session.delete(pf)
 258
 259         else:
 260             utils.fubar("%s is neither symlink nor file?!" % (filename))
 261
 262     if not Options["No-Action"]:
 263         session.commit()
 264
 265     if count > 0:
 266         Logger.log(["total", count, utils.size_type(size)])
 267         print "Cleaned %d files, %s." % (count, utils.size_type(size))
 268
 269 ################################################################################
 270
 271 def clean_maintainers(now_date, delete_date, max_delete, session):
 272     print "Cleaning out unused Maintainer entries..."
 273
 274     # TODO Replace this whole thing with one SQL statement
 275     q = session.execute("""
 276 SELECT m.id, m.name FROM maintainer m
 277   WHERE NOT EXISTS (SELECT 1 FROM binaries b WHERE b.maintainer = m.id)
 278     AND NOT EXISTS (SELECT 1 FROM source s WHERE s.maintainer = m.id OR s.changedby = m.id)
 279     AND NOT EXISTS (SELECT 1 FROM src_uploaders u WHERE u.maintainer = m.id)""")
 280
 281     count = 0
 282
 283     for i in q.fetchall():
 284         maintainer_id = i[0]
 285         Logger.log(["delete maintainer", i[1]])
 286         if not Options["No-Action"]:
 287             session.execute("DELETE FROM maintainer WHERE id = :maint", {'maint': maintainer_id})
 288         count += 1
 289
 290     if not Options["No-Action"]:
 291         session.commit()
 292
 293     if count > 0:
 294         Logger.log(["total", count])
 295         print "Cleared out %d maintainer entries." % (count)
 296
 297 ################################################################################
 298
 299 def clean_fingerprints(now_date, delete_date, max_delete, session):
 300     print "Cleaning out unused fingerprint entries..."
 301
 302     # TODO Replace this whole thing with one SQL statement
 303     q = session.execute("""
 304 SELECT f.id, f.fingerprint FROM fingerprint f
 305   WHERE f.keyring IS NULL
 306     AND NOT EXISTS (SELECT 1 FROM binaries b WHERE b.sig_fpr = f.id)
 307     AND NOT EXISTS (SELECT 1 FROM source s WHERE s.sig_fpr = f.id)""")
 308
 309     count = 0
 310
 311     for i in q.fetchall():
 312         fingerprint_id = i[0]
 313         Logger.log(["delete fingerprint", i[1]])
 314         if not Options["No-Action"]:
 315             session.execute("DELETE FROM fingerprint WHERE id = :fpr", {'fpr': fingerprint_id})
 316         count += 1
 317
 318     if not Options["No-Action"]:
 319         session.commit()
 320
 321     if count > 0:
 322         Logger.log(["total", count])
 323         print "Cleared out %d fingerprint entries." % (count)
 324
 325 ################################################################################
 326
 327 def clean_queue_build(now_date, delete_date, max_delete, session):
 328
 329     cnf = Config()
 330
 331     if not cnf.ValueList("Dinstall::QueueBuildSuites") or Options["No-Action"]:
 332         return
 333
 334     print "Cleaning out queue build symlinks..."
 335
 336     our_delete_date = now_date - timedelta(seconds = int(cnf["Clean-Suites::QueueBuildStayOfExecution"]))
 337     count = 0
 338
 339     for qf in session.query(QueueBuild).filter(QueueBuild.last_used <= our_delete_date):
 340         if not os.path.exists(qf.filename):
 341             utils.warn("%s (from queue_build) doesn't exist." % (qf.filename))
 342             continue
 343
 344         if not cnf.FindB("Dinstall::SecurityQueueBuild") and not os.path.islink(qf.filename):
 345             utils.fubar("%s (from queue_build) should be a symlink but isn't." % (qf.filename))
 346
 347         Logger.log(["delete queue build", qf.filename])
 348         if not Options["No-Action"]:
 349             os.unlink(qf.filename)
 350             session.delete(qf)
 351         count += 1
 352
 353     if not Options["No-Action"]:
 354         session.commit()
 355
 356     if count:
 357         Logger.log(["total", count])
 358         print "Cleaned %d queue_build files." % (count)
 359
 360 ################################################################################
 361
 362 def clean_empty_directories(session):
 363     """
 364     Removes empty directories from pool directories.
 365     """
 366
 367     count = 0
 368
 369     cursor = session.execute(
 370         "SELECT DISTINCT(path) FROM location WHERE type = :type",
 371         {'type': 'pool'},
 372     )
 373     bases = [x[0] for x in cursor.fetchall()]
 374
 375     for base in bases:
 376         for dirpath, dirnames, filenames in os.walk(base, topdown=False):
 377             if not filenames and not dirnames:
 378                 to_remove = os.path.join(base, dirpath)
 379                 if not Options["No-Action"]:
 380                     Logger.log(["removing directory", to_remove])
 381                     os.removedirs(to_remove)
 382                 count += 1
 383
 384     if count:
 385         Logger.log(["total removed directories", count])
 386
 387 ################################################################################
 388
 389 def main():
 390     global Options, Logger
 391
 392     cnf = Config()
 393
 394     for i in ["Help", "No-Action", "Maximum" ]:
 395         if not cnf.has_key("Clean-Suites::Options::%s" % (i)):
 396             cnf["Clean-Suites::Options::%s" % (i)] = ""
 397
 398     Arguments = [('h',"help","Clean-Suites::Options::Help"),
 399                  ('n',"no-action","Clean-Suites::Options::No-Action"),
 400                  ('m',"maximum","Clean-Suites::Options::Maximum", "HasArg")]
 401
 402     apt_pkg.ParseCommandLine(cnf.Cnf, Arguments, sys.argv)
 403     Options = cnf.SubTree("Clean-Suites::Options")
 404
 405     if cnf["Clean-Suites::Options::Maximum"] != "":
 406         try:
 407             # Only use Maximum if it's an integer
 408             max_delete = int(cnf["Clean-Suites::Options::Maximum"])
 409             if max_delete < 1:
 410                 utils.fubar("If given, Maximum must be at least 1")
 411         except ValueError, e:
 412             utils.fubar("If given, Maximum must be an integer")
 413     else:
 414         max_delete = None
 415
 416     if Options["Help"]:
 417         usage()
 418
 419     Logger = daklog.Logger(cnf, "clean-suites", debug=Options["No-Action"])
 420
 421     session = DBConn().session()
 422
 423     now_date = datetime.now()
 424     delete_date = now_date - timedelta(seconds=int(cnf['Clean-Suites::StayOfExecution']))
 425
 426     check_binaries(now_date, delete_date, max_delete, session)
 427     clean_binaries(now_date, delete_date, max_delete, session)
 428     check_sources(now_date, delete_date, max_delete, session)
 429     check_files(now_date, delete_date, max_delete, session)
 430     clean(now_date, delete_date, max_delete, session)
 431     clean_maintainers(now_date, delete_date, max_delete, session)
 432     clean_fingerprints(now_date, delete_date, max_delete, session)
 433     clean_queue_build(now_date, delete_date, max_delete, session)
 434     clean_empty_directories(session)
 435
 436     Logger.close()
 437
 438 ################################################################################
 439
 440 if __name__ == '__main__':
 441     main()