dl_cleanup: Allow removing items from blacklist
[openwrt.git] / scripts / dl_cleanup.py
1 #!/usr/bin/env python
2 """
3 # OpenWRT download directory cleanup utility.
4 # Delete all but the very last version of the program tarballs.
5 #
6 # Copyright (c) 2010 Michael Buesch <mb@bu3sch.de>
7 """
8
9 import sys
10 import os
11 import re
12 import getopt
13
14 DEBUG = 0
15
16 # Commandline options
17 opt_dryrun = False
18
19
20 def parseVer_1234(match):
21         progname = match.group(1)
22         progversion = (int(match.group(2)) << 64) |\
23                       (int(match.group(3)) << 48) |\
24                       (int(match.group(4)) << 32) |\
25                       (int(match.group(5)) << 16)
26         return (progname, progversion)
27
28 def parseVer_123(match):
29         progname = match.group(1)
30         patchlevel = match.group(5)
31         if patchlevel:
32                 patchlevel = ord(patchlevel[0])
33         else:
34                 patchlevel = 0
35         progversion = (int(match.group(2)) << 64) |\
36                       (int(match.group(3)) << 48) |\
37                       (int(match.group(4)) << 32) |\
38                       patchlevel
39         return (progname, progversion)
40
41 def parseVer_12(match):
42         progname = match.group(1)
43         patchlevel = match.group(4)
44         if patchlevel:
45                 patchlevel = ord(patchlevel[0])
46         else:
47                 patchlevel = 0
48         progversion = (int(match.group(2)) << 64) |\
49                       (int(match.group(3)) << 48) |\
50                       patchlevel
51         return (progname, progversion)
52
53 def parseVer_r(match):
54         progname = match.group(1)
55         progversion = (int(match.group(2)) << 64)
56         return (progname, progversion)
57
58 def parseVer_ymd(match):
59         progname = match.group(1)
60         progversion = (int(match.group(2)) << 64) |\
61                       (int(match.group(3)) << 48) |\
62                       (int(match.group(4)) << 32)
63         return (progname, progversion)
64
65 extensions = (
66         ".tar.gz",
67         ".tar.bz2",
68         ".orig.tar.gz",
69         ".orig.tar.bz2",
70         ".zip",
71         ".tgz",
72         ".tbz",
73 )
74
75 versionRegex = (
76         (re.compile(r"(.+)[-_](\d+)\.(\d+)\.(\d+)\.(\d+)"), parseVer_1234),     # xxx-1.2.3.4
77         (re.compile(r"(.+)[-_](\d\d\d\d)-?(\d\d)-?(\d\d)"), parseVer_ymd),      # xxx-YYYY-MM-DD
78         (re.compile(r"(.+)[-_](\d+)\.(\d+)\.(\d+)(\w?)"), parseVer_123),        # xxx-1.2.3a
79         (re.compile(r"(.+)[-_](\d+)\.(\d+)(\w?)"), parseVer_12),                # xxx-1.2a
80         (re.compile(r"(.+)[-_]r?(\d+)"), parseVer_r),                           # xxx-r1111
81 )
82
83 blacklist = [
84         ("linux",               re.compile(r"linux-.*")),
85         ("gcc",                 re.compile(r"gcc-.*")),
86         ("boost",               re.compile(r"boost.*")),
87         ("wl_apsta",            re.compile(r"wl_apsta.*")),
88         (".fw",                 re.compile(r".*\.fw")),
89         (".arm",                re.compile(r".*\.arm")),
90         (".bin",                re.compile(r".*\.bin")),
91         ("rt-firmware",         re.compile(r"RT\d+_Firmware.*")),
92 ]
93
94 class EntryParseError(Exception): pass
95
96 class Entry:
97         def __init__(self, directory, filename):
98                 self.directory = directory
99                 self.filename = filename
100                 self.progname = ""
101
102                 for ext in extensions:
103                         if filename.endswith(ext):
104                                 filename = filename[0:0-len(ext)]
105                                 break
106                 else:
107                         if DEBUG:
108                                 print "Extension did not match on", filename
109                         raise EntryParseError("ext")
110                 for (regex, parseVersion) in versionRegex:
111                         match = regex.match(filename)
112                         if match:
113                                 (self.progname, self.version) = parseVersion(match)
114                                 break
115                 else:
116                         if DEBUG:
117                                 print "Version regex did not match on", filename
118                         raise EntryParseError("ver")
119
120         def deleteFile(self):
121                 path = (self.directory + "/" + self.filename).replace("//", "/")
122                 print "Deleting", path
123                 if not opt_dryrun:
124                         os.unlink(path)
125
126         def __eq__(self, y):
127                 return self.filename == y.filename
128
129         def __ge__(self, y):
130                 return self.version >= y.version
131
132 def usage():
133         print "OpenWRT download directory cleanup utility"
134         print "Usage: " + sys.argv[0] + " [OPTIONS] <path/to/dl>"
135         print ""
136         print " -d|--dry-run            Do a dry-run. Don't delete any files"
137         print " -B|--show-blacklist     Show the blacklist and exit"
138         print " -w|--whitelist ITEM     Remove ITEM from blacklist"
139
140 def main(argv):
141         global opt_dryrun
142
143         try:
144                 (opts, args) = getopt.getopt(argv[1:],
145                         "hdBw:",
146                         [ "help", "dry-run", "show-blacklist", "whitelist=", ])
147                 if len(args) != 1:
148                         raise getopt.GetoptError()
149         except getopt.GetoptError:
150                 usage()
151                 return 1
152         directory = args[0]
153         for (o, v) in opts:
154                 if o in ("-h", "--help"):
155                         usage()
156                         return 0
157                 if o in ("-d", "--dry-run"):
158                         opt_dryrun = True
159                 if o in ("-w", "--whitelist"):
160                         for i in range(0, len(blacklist)):
161                                 (name, regex) = blacklist[i]
162                                 if name == v:
163                                         del blacklist[i]
164                                         break
165                         else:
166                                 print "Whitelist error: Item", v,\
167                                       "is not in blacklist"
168                                 return 1
169                 if o in ("-B", "--show-blacklist"):
170                         for (name, regex) in blacklist:
171                                 print name
172                         return 0
173
174         # Create a directory listing and parse the file names.
175         entries = []
176         for filename in os.listdir(directory):
177                 if filename == "." or filename == "..":
178                         continue
179                 for (name, regex) in blacklist:
180                         if regex.match(filename):
181                                 if opt_dryrun:
182                                         print filename, "is blacklisted"
183                                 break
184                 else:
185                         try:
186                                 entries.append(Entry(directory, filename))
187                         except (EntryParseError), e: pass
188
189         # Create a map of programs
190         progmap = {}
191         for entry in entries:
192                 if entry.progname in progmap.keys():
193                         progmap[entry.progname].append(entry)
194                 else:
195                         progmap[entry.progname] = [entry,]
196
197         # Traverse the program map and delete everything but the last version
198         for prog in progmap:
199                 lastVersion = None
200                 versions = progmap[prog]
201                 for version in versions:
202                         if lastVersion is None or version >= lastVersion:
203                                 lastVersion = version
204                 if lastVersion:
205                         for version in versions:
206                                 if version != lastVersion:
207                                         version.deleteFile()
208                         if opt_dryrun:
209                                 print "Keeping", lastVersion.filename
210
211         return 0
212
213 if __name__ == "__main__":
214         sys.exit(main(sys.argv))