dak/clean_queues.py

   1 #!/usr/bin/env python
   2
   3 """ Clean incoming of old unused files """
   4 # Copyright (C) 2000, 2001, 2002, 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 # <aj> Bdale, a ham-er, and the leader,
  23 # <aj> Willy, a GCC maintainer,
  24 # <aj> Lamont-work, 'cause he's the top uploader....
  25 # <aj>         Penguin Puff' save the day!
  26 # <aj> Porting code, trying to build the world,
  27 # <aj> Here they come just in time...
  28 # <aj>         The Penguin Puff' Guys!
  29 # <aj> [repeat]
  30 # <aj> Penguin Puff'!
  31 # <aj> willy: btw, if you don't maintain gcc you need to start, since
  32 #      the lyrics fit really well that way
  33
  34 ################################################################################
  35
  36 import os, os.path, stat, sys, time
  37 from datetime import datetime, timedelta
  38 import apt_pkg
  39 from daklib import utils
  40 from daklib import daklog
  41 from daklib.config import Config
  42
  43 ################################################################################
  44
  45 Options = None
  46 Logger = None
  47 del_dir = None
  48 delete_date = None
  49
  50 ################################################################################
  51
  52 def usage (exit_code=0):
  53     print """Usage: dak clean-queues [OPTIONS]
  54 Clean out incoming directories.
  55
  56   -d, --days=DAYS            remove anything older than DAYS old
  57   -i, --incoming=INCOMING    the incoming directory to clean
  58   -n, --no-action            don't do anything
  59   -v, --verbose              explain what is being done
  60   -h, --help                 show this help and exit"""
  61
  62     sys.exit(exit_code)
  63
  64 ################################################################################
  65
  66 def init (cnf):
  67     global delete_date, del_dir
  68
  69     # Used for directory naming
  70     now_date = datetime.now()
  71
  72     # Used for working out times
  73     delete_date = int(time.time())-(int(Options["Days"])*84600)
  74
  75     morguedir = cnf.get("Dir::Morgue", os.path.join("Dir::Pool", 'morgue'))
  76     morguesubdir = cnf.get("Clean-Queues::MorgueSubDir", 'queue')
  77
  78     # Build directory as morguedir/morguesubdir/year/month/day
  79     del_dir = os.path.join(morguedir,
  80                            morguesubdir,
  81                            str(now_date.year),
  82                            '%.2d' % now_date.month,
  83                            '%.2d' % now_date.day)
  84
  85     # Ensure a directory exists to remove files to
  86     if not Options["No-Action"]:
  87         if not os.path.exists(del_dir):
  88             os.makedirs(del_dir, 0o2775)
  89         if not os.path.isdir(del_dir):
  90             utils.fubar("%s must be a directory." % (del_dir))
  91
  92     # Move to the directory to clean
  93     incoming = Options.get("Incoming")
  94     if not incoming:
  95         incoming = cnf.get('Dir::Unchecked')
  96         if not incoming:
  97             utils.fubar("Cannot find 'unchecked' directory")
  98
  99     try:
 100         os.chdir(incoming)
 101     except OSError as e:
 102         utils.fubar("Cannot chdir to %s" % incoming)
 103
 104 # Remove a file to the morgue
 105 def remove (from_dir, f):
 106     fname = os.path.basename(f)
 107     if os.access(f, os.R_OK):
 108         Logger.log(["move file to morgue", from_dir, fname, del_dir])
 109         if Options["Verbose"]:
 110             print "Removing '%s' (to '%s')."  % (fname, del_dir)
 111         if Options["No-Action"]:
 112             return
 113
 114         dest_filename = os.path.join(del_dir, fname)
 115         # If the destination file exists; try to find another filename to use
 116         if os.path.exists(dest_filename):
 117             dest_filename = utils.find_next_free(dest_filename, 10)
 118             Logger.log(["change destination file name", os.path.basename(dest_filename)])
 119         utils.move(f, dest_filename, 0o660)
 120     else:
 121         Logger.log(["skipping file because of permission problem", fname])
 122         utils.warn("skipping '%s', permission denied." % fname)
 123
 124 # Removes any old files.
 125 # [Used for Incoming/REJECT]
 126 #
 127 def flush_old ():
 128     Logger.log(["check Incoming/REJECT for old files", os.getcwd()])
 129     for f in os.listdir('.'):
 130         if os.path.isfile(f):
 131             if os.stat(f)[stat.ST_MTIME] < delete_date:
 132                 remove('Incoming/REJECT', f)
 133             else:
 134                 if Options["Verbose"]:
 135                     print "Skipping, too new, '%s'." % (os.path.basename(f))
 136
 137 # Removes any files which are old orphans (not associated with a valid .changes file).
 138 # [Used for Incoming]
 139 #
 140 def flush_orphans ():
 141     all_files = {}
 142     changes_files = []
 143
 144     Logger.log(["check Incoming for old orphaned files", os.getcwd()])
 145     # Build up the list of all files in the directory
 146     for i in os.listdir('.'):
 147         if os.path.isfile(i):
 148             all_files[i] = 1
 149             if i.endswith(".changes"):
 150                 changes_files.append(i)
 151
 152     # Proces all .changes and .dsc files.
 153     for changes_filename in changes_files:
 154         try:
 155             changes = utils.parse_changes(changes_filename)
 156             files = utils.build_file_list(changes)
 157         except:
 158             utils.warn("error processing '%s'; skipping it. [Got %s]" % (changes_filename, sys.exc_info()[0]))
 159             continue
 160
 161         dsc_files = {}
 162         for f in files.keys():
 163             if f.endswith(".dsc"):
 164                 try:
 165                     dsc = utils.parse_changes(f, dsc_file=1)
 166                     dsc_files = utils.build_file_list(dsc, is_a_dsc=1)
 167                 except:
 168                     utils.warn("error processing '%s'; skipping it. [Got %s]" % (f, sys.exc_info()[0]))
 169                     continue
 170
 171         # Ensure all the files we've seen aren't deleted
 172         keys = []
 173         for i in (files.keys(), dsc_files.keys(), [changes_filename]):
 174             keys.extend(i)
 175         for key in keys:
 176             if all_files.has_key(key):
 177                 if Options["Verbose"]:
 178                     print "Skipping, has parents, '%s'." % (key)
 179                 del all_files[key]
 180
 181     # Anthing left at this stage is not referenced by a .changes (or
 182     # a .dsc) and should be deleted if old enough.
 183     for f in all_files.keys():
 184         if os.stat(f)[stat.ST_MTIME] < delete_date:
 185             remove('Incoming', f)
 186         else:
 187             if Options["Verbose"]:
 188                 print "Skipping, too new, '%s'." % (os.path.basename(f))
 189
 190 ################################################################################
 191
 192 def main ():
 193     global Options, Logger
 194
 195     cnf = Config()
 196
 197     for i in ["Help", "Incoming", "No-Action", "Verbose" ]:
 198         if not cnf.has_key("Clean-Queues::Options::%s" % (i)):
 199             cnf["Clean-Queues::Options::%s" % (i)] = ""
 200     if not cnf.has_key("Clean-Queues::Options::Days"):
 201         cnf["Clean-Queues::Options::Days"] = "14"
 202
 203     Arguments = [('h',"help","Clean-Queues::Options::Help"),
 204                  ('d',"days","Clean-Queues::Options::Days", "IntLevel"),
 205                  ('i',"incoming","Clean-Queues::Options::Incoming", "HasArg"),
 206                  ('n',"no-action","Clean-Queues::Options::No-Action"),
 207                  ('v',"verbose","Clean-Queues::Options::Verbose")]
 208
 209     apt_pkg.parse_commandline(cnf.Cnf,Arguments,sys.argv)
 210     Options = cnf.subtree("Clean-Queues::Options")
 211
 212     if Options["Help"]:
 213         usage()
 214
 215     Logger = daklog.Logger('clean-queues', Options['No-Action'])
 216
 217     init(cnf)
 218
 219     if Options["Verbose"]:
 220         print "Processing incoming..."
 221     flush_orphans()
 222
 223     reject = cnf["Dir::Reject"]
 224     if os.path.exists(reject) and os.path.isdir(reject):
 225         if Options["Verbose"]:
 226             print "Processing reject directory..."
 227         os.chdir(reject)
 228         flush_old()
 229
 230     Logger.close()
 231
 232 #######################################################################################
 233
 234 if __name__ == '__main__':
 235     main()