scripts/dl_cleanup.py

   1 #!/usr/bin/env python3
   2 """
   3 # OpenWrt download directory cleanup utility.
   4 # Delete all but the very last version of the program tarballs.
   5 #
   6 # Copyright (C) 2010-2015 Michael Buesch <m@bues.ch>
   7 # Copyright (C) 2013-2015 OpenWrt.org
   8 """
   9
  10 from __future__ import print_function
  11
  12 import sys
  13 import os
  14 import re
  15 import getopt
  16 import shutil
  17
  18 # Commandline options
  19 opt_dryrun = False
  20
  21
  22 def parseVer_1234(match, filepath):
  23     progname = match.group(1)
  24     progversion = (
  25         (int(match.group(2)) << 64)
  26         | (int(match.group(3)) << 48)
  27         | (int(match.group(4)) << 32)
  28         | (int(match.group(5)) << 16)
  29     )
  30     return (progname, progversion)
  31
  32
  33 def parseVer_123(match, filepath):
  34     progname = match.group(1)
  35     try:
  36         patchlevel = match.group(5)
  37     except IndexError as e:
  38         patchlevel = None
  39     if patchlevel:
  40         patchlevel = ord(patchlevel[0])
  41     else:
  42         patchlevel = 0
  43     progversion = (
  44         (int(match.group(2)) << 64)
  45         | (int(match.group(3)) << 48)
  46         | (int(match.group(4)) << 32)
  47         | patchlevel
  48     )
  49     return (progname, progversion)
  50
  51
  52 def parseVer_12(match, filepath):
  53     progname = match.group(1)
  54     try:
  55         patchlevel = match.group(4)
  56     except IndexError as e:
  57         patchlevel = None
  58     if patchlevel:
  59         patchlevel = ord(patchlevel[0])
  60     else:
  61         patchlevel = 0
  62     progversion = (int(match.group(2)) << 64) | (int(match.group(3)) << 48) | patchlevel
  63     return (progname, progversion)
  64
  65
  66 def parseVer_r(match, filepath):
  67     progname = match.group(1)
  68     progversion = int(match.group(2)) << 64
  69     return (progname, progversion)
  70
  71
  72 def parseVer_ymd_GIT_SHASUM(match, filepath):
  73     progname = match.group(1)
  74     progversion = (
  75         (int(match.group(2)) << 64)
  76         | (int(match.group(3)) << 48)
  77         | (int(match.group(4)) << 32)
  78     )
  79     return (progname, progversion)
  80
  81
  82 def parseVer_ymd(match, filepath):
  83     progname = match.group(1)
  84     progversion = (
  85         (int(match.group(2)) << 64)
  86         | (int(match.group(3)) << 48)
  87         | (int(match.group(4)) << 32)
  88     )
  89     return (progname, progversion)
  90
  91
  92 def parseVer_GIT(match, filepath):
  93     progname = match.group(1)
  94     st = os.stat(filepath)
  95     progversion = int(st.st_mtime) << 64
  96     return (progname, progversion)
  97
  98
  99 extensions = (
 100     ".tar.gz",
 101     ".tar.bz2",
 102     ".tar.xz",
 103     ".orig.tar.gz",
 104     ".orig.tar.bz2",
 105     ".orig.tar.xz",
 106     ".zip",
 107     ".tgz",
 108     ".tbz",
 109     ".txz",
 110 )
 111
 112 versionRegex = (
 113     (re.compile(r"(gcc[-_]\d+)\.(\d+)\.(\d+)"), parseVer_12),  # gcc.1.2
 114     (re.compile(r"(linux[-_]\d+\.\d+)\.(\d+)"), parseVer_r),  # linux.1
 115     (re.compile(r"(.+)[-_](\d+)\.(\d+)\.(\d+)\.(\d+)"), parseVer_1234),  # xxx-1.2.3.4
 116     (
 117         re.compile(r"(.+)[-_](\d\d\d\d)-?(\d\d)-?(\d\d)-"),
 118         parseVer_ymd_GIT_SHASUM,
 119     ),  # xxx-YYYY-MM-DD-GIT_SHASUM
 120     (re.compile(r"(.+)[-_](\d\d\d\d)-?(\d\d)-?(\d\d)"), parseVer_ymd),  # xxx-YYYY-MM-DD
 121     (re.compile(r"(.+)[-_]([0-9a-fA-F]{40,40})"), parseVer_GIT),  # xxx-GIT_SHASUM
 122     (re.compile(r"(.+)[-_](\d+)\.(\d+)\.(\d+)(\w?)"), parseVer_123),  # xxx-1.2.3a
 123     (re.compile(r"(.+)[-_]v(\d+)\.(\d+)\.(\d+)(\w?)"), parseVer_123),  # xxx-v1.2.3a
 124     (re.compile(r"(.+)[-_](\d+)_(\d+)_(\d+)"), parseVer_123),  # xxx-1_2_3
 125     (re.compile(r"(.+)[-_](\d+)\.(\d+)(\w?)"), parseVer_12),  # xxx-1.2a
 126     (re.compile(r"(.+)[-_]v(\d+)\.(\d+)(\w?)"), parseVer_12),  # xxx-v1.2a
 127     (re.compile(r"(.+)[-_]r?(\d+)"), parseVer_r),  # xxx-r1111
 128 )
 129
 130 blacklist = [
 131     ("wl_apsta", re.compile(r"wl_apsta.*")),
 132     (".fw", re.compile(r".*\.fw")),
 133     (".arm", re.compile(r".*\.arm")),
 134     (".bin", re.compile(r".*\.bin")),
 135     ("rt-firmware", re.compile(r"RT[\d\w]+_Firmware.*")),
 136 ]
 137
 138
 139 class EntryParseError(Exception):
 140     pass
 141
 142
 143 class Entry:
 144     def __init__(self, directory, builddir, filename):
 145         self.directory = directory
 146         self.filename = filename
 147         self.builddir = builddir
 148         self.progname = ""
 149         self.fileext = ""
 150         self.filenoext = ""
 151
 152         for ext in extensions:
 153             if filename.endswith(ext):
 154                 filename = filename[0 : 0 - len(ext)]
 155                 self.filenoext = filename
 156                 self.fileext = ext
 157                 break
 158         else:
 159             print(self.filename, "has an unknown file-extension")
 160             raise EntryParseError("ext")
 161         for (regex, parseVersion) in versionRegex:
 162             match = regex.match(filename)
 163             if match:
 164                 (self.progname, self.version) = parseVersion(
 165                     match, directory + "/" + filename + self.fileext
 166                 )
 167                 break
 168         else:
 169             print(self.filename, "has an unknown version pattern")
 170             raise EntryParseError("ver")
 171
 172     def getPath(self):
 173         return (self.directory + "/" + self.filename).replace("//", "/")
 174
 175     def getBuildPaths(self):
 176         paths = []
 177         for subdir in os.scandir(self.builddir):
 178             package_build_dir = os.path.join(subdir.path, self.filenoext)
 179             if os.path.exists(package_build_dir):
 180                 paths.append(package_build_dir)
 181         return paths
 182
 183     def deleteFile(self):
 184         path = self.getPath()
 185         print("Deleting", path)
 186         if not opt_dryrun:
 187             os.unlink(path)
 188
 189     def deleteBuildDir(self):
 190         paths = self.getBuildPaths()
 191         for path in paths:
 192             print("Deleting BuildDir", path)
 193             if not opt_dryrun:
 194                     shutil.rmtree(path)
 195
 196     def __ge__(self, y):
 197         return self.version >= y.version
 198
 199
 200 def usage():
 201     print("OpenWrt download directory cleanup utility")
 202     print("Usage: " + sys.argv[0] + " [OPTIONS] <path/to/dl>")
 203     print("")
 204     print(" -d|--dry-run            Do a dry-run. Don't delete any files")
 205     print(" -B|--show-blacklist     Show the blacklist and exit")
 206     print(" -w|--whitelist ITEM     Remove ITEM from blacklist")
 207     print(
 208         " -D|--download-dir       Provide path to dl dir to clean also the build directory"
 209     )
 210     print(
 211         " -b|--build-dir          Provide path to build dir to clean also the build directory"
 212     )
 213
 214
 215 def main(argv):
 216     global opt_dryrun
 217
 218     try:
 219         (opts, args) = getopt.getopt(
 220             argv[1:],
 221             "hdBwDb:",
 222             [
 223                 "help",
 224                 "dry-run",
 225                 "show-blacklist",
 226                 "whitelist=",
 227                 "download-dir=",
 228                 "build-dir=",
 229             ],
 230         )
 231     except getopt.GetoptError as e:
 232         usage()
 233         return 1
 234
 235     directory = "dl/"
 236     builddir = "build_dir/"
 237
 238     for (o, v) in opts:
 239         if o in ("-h", "--help"):
 240             usage()
 241             return 0
 242         if o in ("-d", "--dry-run"):
 243             opt_dryrun = True
 244         if o in ("-w", "--whitelist"):
 245             for i in range(0, len(blacklist)):
 246                 (name, regex) = blacklist[i]
 247                 if name == v:
 248                     del blacklist[i]
 249                     break
 250             else:
 251                 print("Whitelist error: Item", v, "is not in blacklist")
 252                 return 1
 253         if o in ("-B", "--show-blacklist"):
 254             for (name, regex) in blacklist:
 255                 sep = "\t\t"
 256                 if len(name) >= 8:
 257                     sep = "\t"
 258                 print("%s%s(%s)" % (name, sep, regex.pattern))
 259             return 0
 260         if o in ("-D", "--download-dir"):
 261             directory = v
 262         if o in ("-b", "--build-dir"):
 263             builddir = v
 264
 265     if not os.path.exists(directory):
 266         print("Can't find dl path", directory)
 267         return 1
 268
 269     if not os.path.exists(builddir):
 270         print("Can't find dl path", builddir)
 271         return 1
 272
 273     # Create a directory listing and parse the file names.
 274     entries = []
 275     for filename in os.listdir(directory):
 276         if filename == "." or filename == "..":
 277             continue
 278         for (name, regex) in blacklist:
 279             if regex.match(filename):
 280                 if opt_dryrun:
 281                     print(filename, "is blacklisted")
 282                 break
 283         else:
 284             try:
 285                 entries.append(Entry(directory, builddir, filename))
 286             except EntryParseError as e:
 287                 pass
 288
 289     # Create a map of programs
 290     progmap = {}
 291     for entry in entries:
 292         if entry.progname in progmap.keys():
 293             progmap[entry.progname].append(entry)
 294         else:
 295             progmap[entry.progname] = [
 296                 entry,
 297             ]
 298
 299     # Traverse the program map and delete everything but the last version
 300     for prog in progmap:
 301         lastVersion = None
 302         versions = progmap[prog]
 303         for version in versions:
 304             if lastVersion is None or version >= lastVersion:
 305                 lastVersion = version
 306         if lastVersion:
 307             for version in versions:
 308                 if version is not lastVersion:
 309                     version.deleteFile()
 310                     if builddir:
 311                         version.deleteBuildDir()
 312             if opt_dryrun:
 313                 print("Keeping", lastVersion.getPath())
 314
 315     return 0
 316
 317
 318 if __name__ == "__main__":
 319     sys.exit(main(sys.argv))