contrib/paccache.in

   1 #!/bin/bash
   2 #
   3 # pacache - flexible pacman cache cleaning
   4 #
   5 # Copyright (C) 2011 Dave Reisner <dreisner@archlinux.org>
   6 #
   7 # This program is free software; you can redistribute it and/or
   8 # modify it under the terms of the GNU General Public License
   9 # as published by the Free Software Foundation; either version 2
  10 # of the License, or (at your option) any later version.
  11 #
  12 # This program is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20
  21 shopt -s extglob
  22
  23 declare -r myname='paccache'
  24
  25 declare -a candidates=() cmdopts=() whitelist=() blacklist=()
  26 declare -i delete=0 dryrun=0 filecount=0 move=0 needsroot=0 totalsaved=0 verbose=0
  27 declare    cachedir=@localstatedir@/cache/pacman/pkg delim=$'\n' keep=3 movedir= scanarch=
  28
  29 msg() {
  30         local mesg=$1; shift
  31         printf "==> $mesg\n" "$@"
  32 } >&2
  33
  34 error() {
  35         local mesg=$1; shift
  36         printf "==> ERROR: $mesg\n" "$@"
  37 } >&2
  38
  39 die() {
  40         error "$@"
  41         exit 1
  42 }
  43
  44 # reads a list of files on stdin and prints out deletion candidates
  45 pkgfilter() {
  46         # there's whitelist and blacklist parameters passed to this
  47         # script after the block of awk.
  48
  49         awk -v keep="$1" -v scanarch="$2" '
  50         function parse_filename(filename,     parts, count, i, pkgname, arch) {
  51
  52                 count = split(filename, parts, "-")
  53
  54                 i = 1
  55                 pkgname = parts[i++]
  56                 while (i <= count - 3) {
  57                         pkgname = pkgname "-" parts[i++]
  58                 }
  59
  60                 arch = substr(parts[count], 1, index(parts[count], ".") - 1)
  61
  62                 # filter on whitelist or blacklist
  63                 if (wlen && !whitelist[pkgname]) return
  64                 if (blen && blacklist[pkgname]) return
  65
  66                 if ("" == packages[pkgname,arch]) {
  67                         packages[pkgname,arch] = filename
  68                 } else {
  69                         packages[pkgname,arch] = packages[pkgname,arch] SUBSEP filename
  70                 }
  71         }
  72
  73         BEGIN {
  74                 # create whitelist
  75                 wlen = ARGV[1]; delete ARGV[1]
  76                 for (i = 2; i < 2 + wlen; i++) {
  77                         whitelist[ARGV[i]] = 1
  78                         delete ARGV[i]
  79                 }
  80
  81                 # create blacklist
  82                 blen = ARGV[i]; delete ARGV[i]
  83                 while (i++ < ARGC) {
  84                         blacklist[ARGV[i]] = 1
  85                         delete ARGV[i]
  86                 }
  87
  88                 # read package filenames
  89                 while (getline < "/dev/stdin") {
  90                         parse_filename($0)
  91                 }
  92
  93                 for (pkglist in packages) {
  94                         # idx[1,2] = idx[pkgname,arch]
  95                         split(pkglist, idx, SUBSEP)
  96
  97                         # enforce architecture match if specified
  98                         if (!scanarch || scanarch == idx[2]) {
  99                                 count = split(packages[idx[1], idx[2]], pkgs, SUBSEP)
 100                                 for(i = 1; i <= count - keep; i++) {
 101                                         print pkgs[i]
 102                                 }
 103                         }
 104                 }
 105         }' "${@:3}"
 106 }
 107
 108 size_to_human() {
 109         awk -v size="$1" '
 110         BEGIN {
 111                 suffix[1] = "B"
 112                 suffix[2] = "KiB"
 113                 suffix[3] = "MiB"
 114                 suffix[4] = "GiB"
 115                 suffix[5] = "TiB"
 116                 count = 1
 117
 118                 while (size > 1024) {
 119                         size /= 1024
 120                         count++
 121                 }
 122
 123                 sizestr = sprintf("%.2f", size)
 124                 sub(/\.?0+$/, "", sizestr)
 125                 printf("%s %s", sizestr, suffix[count])
 126         }'
 127 }
 128
 129 runcmd() {
 130         if (( needsroot )); then
 131                 msg "Privilege escalation required"
 132                 if sudo -v &>/dev/null && sudo -l &>/dev/null; then
 133                         sudo "$@"
 134                 else
 135                         printf '%s ' 'root'
 136                         su -c "$(printf '%q ' "$@")"
 137                 fi
 138         else
 139                 "$@"
 140         fi
 141 }
 142
 143 summarize() {
 144         local -i filecount=$1; shift
 145         local seenarch= seen= arch= name=
 146         local -r pkg_re='(.+)-[^-]+-[0-9]+-([^.]+)\.pkg.*'
 147
 148         if (( delete )); then
 149                 printf -v output 'finished: %d packages removed' "$filecount"
 150         elif (( move )); then
 151                 printf -v output "finished: %d packages moved to \`%s'" "$filecount" "$movedir"
 152         elif (( dryrun )); then
 153                 if (( verbose )); then
 154                         msg "Candidate packages:"
 155                         while read -r pkg; do
 156                                 if (( verbose >= 3 )); then
 157                                         [[ $pkg =~ $pkg_re ]] && name=${BASH_REMATCH[1]} arch=${BASH_REMATCH[2]}
 158                                         if [[ -z $seen || $seenarch != "$arch" || $seen != "$name" ]]; then
 159                                                 seen=$name seenarch=$arch
 160                                                 printf '%s (%s):\n' "$name" "$arch"
 161                                         fi
 162                                         printf '  %s\n' "$pkg"
 163                                 elif (( verbose >= 2 )); then
 164                                         printf "$PWD/%s$delim" "$pkg"
 165                                 else
 166                                         printf "%s$delim" "$pkg"
 167                                 fi
 168                         done < <(printf '%s\n' "$@" | pacsort)
 169                 fi
 170                 printf -v output 'finished dry run: %d candidates' "$filecount"
 171         fi
 172
 173         printf '\n' >&2
 174         msg "$output (diskspace saved: %s)" "$(size_to_human "$totalsaved")"
 175 }
 176
 177 usage() {
 178         cat <<EOF
 179 usage: $myname <operation> [options] [targets...]
 180
 181 $myname is a flexible pacman cache cleaning utility, which has numerous
 182 options to help control how much, and what, is deleted from any directory
 183 containing pacman package tarballs.
 184
 185   Operations:
 186     -d               perform a dry run, only finding candidate packages.
 187     -m  <movedir>    move candidate packages to 'movedir'.
 188     -r               remove candidate packages.
 189
 190   Options:
 191     -a  <arch>       scan for 'arch' (default: all architectures).
 192     -c  <cachedir>   scan 'cachedir' for packages (default: @localstatedir@/cache/pacman/pkg).
 193     -f               apply force to mv(1) and rm(1) operations.
 194     -h               display this help message.
 195     -i  <pkgs>       ignore 'pkgs', which is a comma separated. Alternatively,
 196                      specify '-' to read package names from stdin, newline delimited.
 197     -k  <num>        keep 'num' of each package in 'cachedir' (default: 3).
 198     -u               target uninstalled packages.
 199     -v               increase verbosity. specify up to 3 times.
 200     -z               use null delimiters for candidate names (only with -v and -vv)
 201
 202 EOF
 203 }
 204
 205 if (( ! UID )); then
 206         error "Do not run this script as root. You will be prompted for privilege escalation."
 207         exit 42
 208 fi
 209
 210 while getopts ':a:c:dfhi:k:m:rsuvz' opt; do
 211         case $opt in
 212                 a) scanarch=$OPTARG ;;
 213                 c) cachedir=$OPTARG ;;
 214                 d) dryrun=1 ;;
 215                 f) cmdopts=(-f) ;;
 216                 h) usage
 217                         exit 0 ;;
 218                 i) if [[ $OPTARG = '-' ]]; then
 219                                  [[ ! -t 0 ]] && IFS=$'\n' read -r -d '' -a ign
 220                          else
 221                                  IFS=',' read -r -a ign <<< "$OPTARG"
 222                          fi
 223                          blacklist+=("${ign[@]}")
 224                         unset i ign ;;
 225                 k) keep=$OPTARG
 226                         if [[ -z $keep || -n ${keep//[0-9]/} ]]; then
 227                                 die 'argument to option -k must be a non-negative integer'
 228                         else
 229                                 keep=$(( 10#$keep ))
 230                         fi ;;
 231                 m) move=1 movedir=$OPTARG ;;
 232                 r) delete=1 ;;
 233                 u) IFS=$'\n' read -r -d '' -a ign < <(pacman -Qq)
 234                          blacklist+=("${ign[@]}")
 235                          unset ign ;;
 236                 v) (( ++verbose )) ;;
 237                 z) delim='\0' ;;
 238                 :) die "option '--%s' requires an argument" "$OPTARG" ;;
 239                 ?) die "invalid option -- '%s'" "$OPTARG" ;;
 240         esac
 241 done
 242 shift $(( OPTIND - 1 ))
 243
 244 # remaining args are a whitelist
 245 whitelist=("$@")
 246
 247 # sanity checks
 248 case $(( dryrun+delete+move )) in
 249         0) die "no operation specified (use -h for help)" ;;
 250         [^1]) die "only one operation may be used at a time" ;;
 251 esac
 252
 253 [[ -d $cachedir ]] ||
 254         die "cachedir \`%s' does not exist or is not a directory" "$cachedir"
 255
 256 [[ $movedir && ! -d $movedir ]] &&
 257         die "move-to directory \`%s' does not exist or is not a directory" "$movedir"
 258
 259 if (( move || delete )); then
 260         # make it an absolute path since we're about to chdir
 261         [[ ${movedir:0:1} != '/' ]] && movedir=$PWD/$movedir
 262         [[ ! -w $cachedir || ( $movedir && ! -w $movedir ) ]] && needsroot=1
 263 fi
 264
 265 # unlikely that this will fail, but better make sure
 266 cd "$cachedir" || die "failed to chdir to \`%s'" "$cachedir"
 267
 268 # note that these results are returned in an arbitrary order from awk, but
 269 # they'll be resorted (in summarize) iff we have a verbosity level set.
 270 IFS=$'\n' read -r -d '' -a candidates < \
 271         <(printf '%s\n' *.pkg.tar?(.+([^.])) | pacsort |
 272                 pkgfilter "$keep" "$scanarch" \
 273                         "${#whitelist[*]}" "${whitelist[@]}" \
 274                         "${#blacklist[*]}" "${blacklist[@]}")
 275
 276 if (( ! ${#candidates[*]} )); then
 277         msg 'no candidate packages found for pruning'
 278         exit 1
 279 fi
 280
 281 # grab this prior to signature scavenging
 282 pkgcount=${#candidates[*]}
 283
 284 # copy the list, merging in any found sigs
 285 for cand in "${candidates[@]}"; do
 286   candtemp+=("$cand")
 287   [[ -f $cand.sig ]] && candtemp+=("$cand.sig")
 288 done
 289 candidates=("${candtemp[@]}")
 290 unset candtemp
 291
 292 # do this before we destroy anything
 293 totalsaved=$(@SIZECMD@ "${candidates[@]}" | awk '{ sum += $1 } END { print sum }')
 294
 295 # crush. kill. destroy.
 296 (( verbose )) && cmdopts+=(-v)
 297 if (( delete )); then
 298         runcmd rm "${cmdopts[@]}" "${candidates[@]}"
 299 elif (( move )); then
 300         runcmd mv "${cmdopts[@]}" "${candidates[@]}" "$movedir"
 301 fi
 302
 303 summarize "$pkgcount" "${candidates[@]}"
 304
 305 # vim: set ts=2 sw=2 noet: