summaryrefslogtreecommitdiff
path: root/contrib/paccache.sh.in
blob: 71aee237862101df0ac24646004ea9f26612620c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
#!/bin/bash
#
# pacache - flexible pacman cache cleaning
#
# Copyright (C) 2011 Dave Reisner <dreisner@archlinux.org>
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.


shopt -s extglob

declare -r myname='paccache'
declare -r myver='@PACKAGE_VERSION@'

declare -a cachedirs=() candidates=() cmdopts=() whitelist=() blacklist=()
declare -i delete=0 dryrun=0 filecount=0 move=0 needsroot=0 totalsaved=0 verbose=0
declare    delim=$'\n' keep=3 movedir= scanarch=

USE_COLOR='y'

m4_include(../scripts/library/output_format.sh)
m4_include(../scripts/library/parseopts.sh)

die() {
        error "$@"
        exit 1
}

get_cachedir_from_config() {
        local key value

        while IFS=$'= \t' read -r key value _; do
                if [[ $key = CacheDir ]]; then
                        echo "$value"
                        return 0
                fi
        done <"$1"

        return 1
}

# reads a list of files on stdin and prints out deletion candidates
pkgfilter() {
        # there's whitelist and blacklist parameters passed to this
        # script after the block of awk.

        awk -v keep="$1" -v scanarch="$2" '
        function basename(str) {
                sub(".*/", "", str);
                return str;
        }

        function parse_filename(filename,     parts, count, i, pkgname, arch) {

                count = split(basename(filename), parts, "-")

                i = 1
                pkgname = parts[i++]
                while (i <= count - 3) {
                        pkgname = pkgname "-" parts[i++]
                }

                arch = substr(parts[count], 1, index(parts[count], ".") - 1)

                # filter on whitelist or blacklist
                if (wlen && !whitelist[pkgname]) return
                if (blen && blacklist[pkgname]) return

                if ("" == packages[pkgname,arch]) {
                        packages[pkgname,arch] = filename
                } else {
                        packages[pkgname,arch] = packages[pkgname,arch] SUBSEP filename
                }
        }

        BEGIN {
                # create whitelist
                wlen = ARGV[1]; delete ARGV[1]
                for (i = 2; i < 2 + wlen; i++) {
                        whitelist[ARGV[i]] = 1
                        delete ARGV[i]
                }

                # create blacklist
                blen = ARGV[i]; delete ARGV[i]
                while (i++ < ARGC) {
                        blacklist[ARGV[i]] = 1
                        delete ARGV[i]
                }

                # read package filenames
                while (getline < "/dev/stdin") {
                        parse_filename($0)
                }

                for (pkglist in packages) {
                        # idx[1,2] = idx[pkgname,arch]
                        split(pkglist, idx, SUBSEP)

                        # enforce architecture match if specified
                        if (!scanarch || scanarch == idx[2]) {
                                count = split(packages[idx[1], idx[2]], pkgs, SUBSEP)
                                for(i = 1; i <= count - keep; i++) {
                                        print pkgs[i]
                                }
                        }
                }
        }' "${@:3}"
}

m4_include(../scripts/library/size_to_human.sh)

runcmd() {
        if (( needsroot && EUID != 0 )); then
                msg "Privilege escalation required"
                if sudo -v &>/dev/null && sudo -l &>/dev/null; then
                        sudo "$@"
                else
                        die 'Unable to escalate privileges using sudo'
                fi
        else
                "$@"
        fi
}

summarize() {
        local -i filecount=$1; shift
        local seenarch= seen= arch= name=
        local -r pkg_re='(.+)-[^-]+-[0-9]+-([^.]+)\.pkg.*'

        if (( delete )); then
                printf -v output 'finished: %d packages removed' "$filecount"
        elif (( move )); then
                printf -v output "finished: %d packages moved to '%s'" "$filecount" "$movedir"
        elif (( dryrun )); then
                if (( verbose )); then
                        msg "Candidate packages:"
                        while read -r pkg; do
                                if (( verbose >= 3 )); then
                                        [[ $pkg =~ $pkg_re ]] && name=${BASH_REMATCH[1]} arch=${BASH_REMATCH[2]}
                                        if [[ -z $seen || $seenarch != "$arch" || $seen != "$name" ]]; then
                                                seen=$name seenarch=$arch
                                                printf '%s (%s):\n' "${name##*/}" "$arch"
                                        fi
                                        printf '  %s\n' "${pkg##*/}"
                                elif (( verbose >= 2 )); then
                                        printf "%s$delim" "$pkg"
                                else
                                        printf "%s$delim" "${pkg##*/}"
                                fi
                        done < <(printf '%s\n' "$@" | pacsort --files)
                fi
                printf -v output 'finished dry run: %d candidates' "$filecount"
        fi

        printf '\n' >&2
        msg "$output (disk space saved: %s)" "$(size_to_human "$totalsaved")"
}

usage() {
        cat <<EOF
${myname} (pacman) v${myver}

A flexible pacman cache cleaning utility.

Usage: ${myname} <operation> [options] [targets...]

  Operations:
    -d, --dryrun          perform a dry run, only finding candidate packages.
    -m, --move <dir>      move candidate packages to "dir".
    -r, --remove          remove candidate packages.

  Options:
    -a, --arch <arch>     scan for "arch" (default: all architectures).
    -c, --cachedir <dir>  scan "dir" for packages. can be used more than once.
                          (default: read from @sysconfdir@/pacman.conf).
    -f, --force           apply force to mv(1) and rm(1) operations.
    -h, --help            display this help message and exit.
    -i, --ignore <pkgs>   ignore "pkgs", comma-separated. Alternatively, specify
                          "-" to read package names from stdin, newline-
                          delimited.
    -k, --keep <num>      keep "num" of each package in the cache (default: 3).
        --nocolor         remove color from output.
    -u, --uninstalled     target uninstalled packages.
    -v, --verbose         increase verbosity. specify up to 3 times.
    -z, --null            use null delimiters for candidate names (only with -v
                          and -vv).

EOF
}

version() {
        printf "%s %s\n" "$myname" "$myver"
        echo 'Copyright (C) 2011 Dave Reisner <dreisner@archlinux.org>'
}

OPT_SHORT=':a:c:dfhi:k:m:rsuVvz'
OPT_LONG=('arch:' 'cachedir:' 'dryrun' 'force' 'help' 'ignore:' 'keep:' 'move'
          'nocolor' 'remove' 'uninstalled' 'version' 'verbose' 'null')

if ! parseopts "$OPT_SHORT" "${OPT_LONG[@]}" -- "$@"; then
        exit 1
fi
set -- "${OPTRET[@]}"
unset OPT_SHORT OPT_LONG OPTRET

while :; do
        case $1 in
                -a|--arch)
                        scanarch=$2
                        shift ;;
                -c|--cachedir)
                        cachedirs+=("$2")
                        shift ;;
                -d|--dryrun)
                        dryrun=1 ;;
                -f|--force)
                        cmdopts=(-f) ;;
                -h|--help)
                        usage
                        exit 0 ;;
                -i|--ignore)
                        if [[ $2 = '-' ]]; then
                                [[ ! -t 0 ]] && IFS=$'\n' read -r -d '' -a ign
                        else
                                IFS=',' read -r -a ign <<< "$2"
                        fi
                        blacklist+=("${ign[@]}")
                        unset i ign
                        shift ;;
                -k|--keep)
                        keep=$2
                        if [[ -z $keep || -n ${keep//[0-9]/} ]]; then
                                die 'argument to option -k must be a non-negative integer'
                        else
                                keep=$(( 10#$keep ))
                        fi
                        shift ;;
                --nocolor)
                        USE_COLOR='n' ;;
                -m|--move)
                        move=1 movedir=$2
                        shift ;;
                -r|--remove)
                        delete=1 ;;
                -u|--uninstalled)
                        IFS=$'\n' read -r -d '' -a ign < <(pacman -Qq)
                        blacklist+=("${ign[@]}")
                        unset ign ;;
                -V|--version)
                        version
                        exit 0 ;;
                -v|--verbose)
                        (( ++verbose )) ;;
                -z|--null)
                        delim='\0' ;;
                --)
                        shift
                        break 2 ;;
        esac
        shift
done

m4_include(../scripts/library/term_colors.sh)

# setting default cachedir
if [[ -z $cachedirs ]]; then
        if cachedir=$(get_cachedir_from_config "@sysconfdir@/pacman.conf"); then
                cachedirs=("$cachedir")
        else
                cachedirs=("${cachedirs[@]:-@localstatedir@/cache/pacman/pkg}")
        fi
fi

# remaining args are a whitelist
whitelist=("$@")

# sanity checks
case $(( dryrun+delete+move )) in
        0) die "no operation specified (use -h for help)" ;;
        [^1]) die "only one operation may be used at a time" ;;
esac

[[ $movedir && ! -d $movedir ]] &&
        die "destination directory '%s' does not exist or is not a directory" "$movedir"

if (( move || delete )); then
        # make it an absolute path since we're about to chdir
        [[ $movedir && ${movedir:0:1} != '/' ]] && movedir=$PWD/$movedir
        [[ $movedir && ! -w $movedir ]] && needsroot=1
fi

for cachedir in "${cachedirs[@]}"; do
        [[ -d $cachedir ]] ||
                die "cachedir '%s' does not exist or is not a directory" "$cachedir"

        if (( move || delete )); then
                [[ ! -w $cachedir ]] && needsroot=1
        fi

        # unlikely that this will fail, but better make sure
        pushd "$cachedir" &>/dev/null || die "failed to chdir to '%s'" "$cachedir"

        # note that these results are returned in an arbitrary order from awk, but
        # they'll be resorted (in summarize) iff we have a verbosity level set.
        IFS=$'\n' read -r -d '' -a cand < \
                <(printf '%s\n' "$PWD"/*.pkg.tar?(.+([^.])) | pacsort --files |
                        pkgfilter "$keep" "$scanarch" \
                                "${#whitelist[*]}" "${whitelist[@]}" \
                                "${#blacklist[*]}" "${blacklist[@]}")

        candidates+=("${cand[@]}")
        unset cand

        popd &>/dev/null
done

if (( ! ${#candidates[*]} )); then
        msg 'no candidate packages found for pruning'
        exit 1
fi

# grab this prior to signature scavenging
pkgcount=${#candidates[*]}

# copy the list, merging in any found sigs
for cand in "${candidates[@]}"; do
        candtemp+=("$cand")
        [[ -f $cand.sig ]] && candtemp+=("$cand.sig")
done
candidates=("${candtemp[@]}")
unset candtemp

# do this before we destroy anything
totalsaved=$(@SIZECMD@ "${candidates[@]}" | awk '{ sum += $1 } END { print sum }')

# crush. kill. destroy.
(( verbose )) && cmdopts+=(-v)
if (( delete )); then
        printf '%s\0' "${candidates[@]}" | runcmd xargs -0 rm "${cmdopts[@]}"
elif (( move )); then
        printf '%s\0' "${candidates[@]}" | runcmd xargs -0 mv "${cmdopts[@]}" -t "$movedir"
fi

summarize "$pkgcount" "${candidates[@]}"

# vim: set noet: