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     ".tar.zst",
 104     ".orig.tar.gz",
 105     ".orig.tar.bz2",
 106     ".orig.tar.xz",
 107     ".zip",
 108     ".tgz",
 109     ".tbz",
 110     ".txz",
 111 )
 112
 113 versionRegex = (
 114     (re.compile(r"(gcc[-_]\d+)\.(\d+)\.(\d+)"), parseVer_12),  # gcc.1.2
 115     (re.compile(r"(linux[-_]\d+\.\d+)\.(\d+)"), parseVer_r),  # linux.1
 116     (re.compile(r"(.+)[-_](\d+)\.(\d+)\.(\d+)\.(\d+)"), parseVer_1234),  # xxx-1.2.3.4
 117     (
 118         re.compile(r"(.+)[-_](\d\d\d\d)-?(\d\d)-?(\d\d)-"),
 119         parseVer_ymd_GIT_SHASUM,
 120     ),  # xxx-YYYY-MM-DD-GIT_SHASUM
 121     (re.compile(r"(.+)[-_](\d\d\d\d)-?(\d\d)-?(\d\d)"), parseVer_ymd),  # xxx-YYYY-MM-DD
 122     (re.compile(r"(.+)[-_]([0-9a-fA-F]{40,40})"), parseVer_GIT),  # xxx-GIT_SHASUM
 123     (re.compile(r"(.+)[-_](\d+)\.(\d+)\.(\d+)(\w?)"), parseVer_123),  # xxx-1.2.3a
 124     (re.compile(r"(.+)[-_]v(\d+)\.(\d+)\.(\d+)(\w?)"), parseVer_123),  # xxx-v1.2.3a
 125     (re.compile(r"(.+)[-_](\d+)_(\d+)_(\d+)"), parseVer_123),  # xxx-1_2_3
 126     (re.compile(r"(.+)[-_](\d+)\.(\d+)(\w?)"), parseVer_12),  # xxx-1.2a
 127     (re.compile(r"(.+)[-_]v(\d+)\.(\d+)(\w?)"), parseVer_12),  # xxx-v1.2a
 128     (re.compile(r"(.+)[-_]r?(\d+)"), parseVer_r),  # xxx-r1111
 129 )
 130
 131 blacklist = [
 132     ("wl_apsta", re.compile(r"wl_apsta.*")),
 133     (".fw", re.compile(r".*\.fw")),
 134     (".arm", re.compile(r".*\.arm")),
 135     (".bin", re.compile(r".*\.bin")),
 136     ("rt-firmware", re.compile(r"RT[\d\w]+_Firmware.*")),
 137 ]
 138
 139
 140 class EntryParseError(Exception):
 141     pass
 142
 143
 144 class Entry:
 145     def __init__(self, directory, builddir, filename):
 146         self.directory = directory
 147         self.filename = filename
 148         self.builddir = builddir
 149         self.progname = ""
 150         self.fileext = ""
 151         self.filenoext = ""
 152
 153         if os.path.isdir(self.getPath()):
 154             self.filenoext = filename
 155         else:
 156             for ext in extensions:
 157                 if filename.endswith(ext):
 158                     filename = filename[0 : 0 - len(ext)]
 159                     self.filenoext = filename
 160                     self.fileext = ext
 161                     break
 162             else:
 163                 print(self.filename, "has an unknown file-extension")
 164                 raise EntryParseError("ext")
 165         for (regex, parseVersion) in versionRegex:
 166             match = regex.match(filename)
 167             if match:
 168                 (self.progname, self.version) = parseVersion(
 169                     match, directory + "/" + filename + self.fileext
 170                 )
 171                 break
 172         else:
 173             print(self.filename, "has an unknown version pattern")
 174             raise EntryParseError("ver")
 175
 176     def getPath(self):
 177         return (self.directory + "/" + self.filename).replace("//", "/")
 178
 179     def getBuildPaths(self):
 180         paths = []
 181         for subdir in os.scandir(self.builddir):
 182             package_build_dir = os.path.join(subdir.path, self.filenoext)
 183             if os.path.exists(package_build_dir):
 184                 paths.append(package_build_dir)
 185         return paths
 186
 187     def deleteFile(self):
 188         path = self.getPath()
 189         print("Deleting", path)
 190         if not opt_dryrun:
 191             if os.path.isdir(path):
 192                 shutil.rmtree(path)
 193             else:
 194                 os.unlink(path)
 195
 196     def deleteBuildDir(self):
 197         paths = self.getBuildPaths()
 198         for path in paths:
 199             print("Deleting BuildDir", path)
 200             if not opt_dryrun:
 201                     shutil.rmtree(path)
 202
 203     def __ge__(self, y):
 204         return self.version >= y.version
 205
 206
 207 def usage():
 208     print("OpenWrt download directory cleanup utility")
 209     print("Usage: " + sys.argv[0] + " [OPTIONS] <path/to/dl>")
 210     print("")
 211     print(" -d|--dry-run            Do a dry-run. Don't delete any files")
 212     print(" -B|--show-blacklist     Show the blacklist and exit")
 213     print(" -w|--whitelist ITEM     Remove ITEM from blacklist")
 214     print(
 215         " -D|--download-dir       Provide path to dl dir to clean also the build directory"
 216     )
 217     print(
 218         " -b|--build-dir          Provide path to build dir to clean also the build directory"
 219     )
 220
 221
 222 def main(argv):
 223     global opt_dryrun
 224
 225     try:
 226         (opts, args) = getopt.getopt(
 227             argv[1:],
 228             "hdBw:D:b:",
 229             [
 230                 "help",
 231                 "dry-run",
 232                 "show-blacklist",
 233                 "whitelist=",
 234                 "download-dir=",
 235                 "build-dir=",
 236             ],
 237         )
 238     except getopt.GetoptError as e:
 239         usage()
 240         return 1
 241
 242     directory = "dl/"
 243     builddir = "build_dir/"
 244
 245     for (o, v) in opts:
 246         if o in ("-h", "--help"):
 247             usage()
 248             return 0
 249         if o in ("-d", "--dry-run"):
 250             opt_dryrun = True
 251         if o in ("-w", "--whitelist"):
 252             for i in range(0, len(blacklist)):
 253                 (name, regex) = blacklist[i]
 254                 if name == v:
 255                     del blacklist[i]
 256                     break
 257             else:
 258                 print("Whitelist error: Item", v, "is not in blacklist")
 259                 return 1
 260         if o in ("-B", "--show-blacklist"):
 261             for (name, regex) in blacklist:
 262                 sep = "\t\t"
 263                 if len(name) >= 8:
 264                     sep = "\t"
 265                 print("%s%s(%s)" % (name, sep, regex.pattern))
 266             return 0
 267         if o in ("-D", "--download-dir"):
 268             directory = v
 269         if o in ("-b", "--build-dir"):
 270             builddir = v
 271
 272     if args:
 273         directory = args[0]
 274
 275     if not os.path.exists(directory):
 276         print("Can't find download directory", directory)
 277         return 1
 278
 279     if not os.path.exists(builddir):
 280         print("Can't find build directory", builddir)
 281         return 1
 282
 283     # Create a directory listing and parse the file names.
 284     entries = []
 285     for filename in os.listdir(directory):
 286         if filename == "." or filename == "..":
 287             continue
 288         for (name, regex) in blacklist:
 289             if regex.match(filename):
 290                 if opt_dryrun:
 291                     print(filename, "is blacklisted")
 292                 break
 293         else:
 294             try:
 295                 entries.append(Entry(directory, builddir, filename))
 296             except EntryParseError as e:
 297                 pass
 298
 299     # Create a map of programs
 300     progmap = {}
 301     for entry in entries:
 302         if entry.progname in progmap.keys():
 303             progmap[entry.progname].append(entry)
 304         else:
 305             progmap[entry.progname] = [
 306                 entry,
 307             ]
 308
 309     # Traverse the program map and delete everything but the last version
 310     for prog in progmap:
 311         lastVersion = None
 312         versions = progmap[prog]
 313         for version in versions:
 314             if lastVersion:
 315                 if os.path.isdir(lastVersion.getPath()) and not os.path.isdir(version.getPath()):
 316                     continue
 317             if lastVersion is None or version >= lastVersion:
 318                 lastVersion = version
 319         if lastVersion:
 320             for version in versions:
 321                 if version is not lastVersion:
 322                     version.deleteFile()
 323                     if builddir:
 324                         version.deleteBuildDir()
 325             if opt_dryrun:
 326                 print("Keeping", lastVersion.getPath())
 327
 328     return 0
 329
 330
 331 if __name__ == "__main__":
 332     sys.exit(main(sys.argv))