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
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
|
#!/bin/sh -e
#
# rmport - remove port(s) from the FreeBSD Ports Collection.
#
# Copyright 2006-2007 Vasil Dimov
# Copyright 2012-2018 Chris Rees
# Copyright 2016-2021 René Ladan
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
# Authors:
# Originally written by Vasil Dimov <vd@FreeBSD.org>
# Others:
# Chris Rees <crees@FreeBSD.org>
# René Ladan <rene@FreeBSD.org>
#
# MAINTAINER= crees@FreeBSD.org
#
EDITOR=${EDITOR:-/usr/bin/vi}
PORTSDIR=${PORTSDIR:-/usr/ports}
INDEX=${PORTSDIR}/$(make -C ${PORTSDIR} -V INDEXFILE)
TODAY=$(date -u +%Y-%m-%d)
SED="sed -i .orig -E"
# use ~/.ssh/config to set up the desired username if different than $LOGNAME
GITREPO=${GITREPO:-git@gitrepo.FreeBSD.org:ports.git}
if [ -n "$(command -v git 2>/dev/null)" ]; then
GIT=git
else
echo "git(1) not found. Please install devel/git."
exit 66
fi
log()
{
echo "==> $*" >&2
}
escape()
{
# escape characters that may appear in ports' names and
# break regular expressions
echo "${1}" |sed -E 's/(\+|\.)/\\\1/g'
}
pkgname()
{
make -C ${PORTSDIR}/${1} -V PKGNAME
}
ask()
{
question=${1}
answer=x
while [ "${answer}" != "y" ] && [ "${answer}" != "n" ] ; do
read -p "${question}? [yn]" answer
done
echo ${answer}
}
# return category/port if arg is directly port's directory on the filesystem
find_catport()
{
arg=${1}
if [ -d "${PORTSDIR}/${arg}" ] ; then
# arg is category/port
echo ${arg}
elif [ -d "${arg}" ] ; then
# arg is the port's directory somewhere in the filesystem
# either absolute or relative
# get the full path
rp=$(realpath ${arg})
category=$(basename $(dirname ${rp}))
port=$(basename ${rp})
echo ${category}/${port}
else
echo "What do you mean by '${arg}'?" >&2
exit 64
fi
}
find_expired()
{
for category in $(make -C ${PORTSDIR} -V SUBDIR); do
for port in $(make -C ${PORTSDIR}/${category} -V SUBDIR); do
DATE="$(make -C ${PORTSDIR}/${category}/${port} -V EXPIRATION_DATE)"
# shellcheck disable=SC2039
if [ -n "${DATE}" ] && [ ! "${DATE}" \> "$${TODAY}" ] ; then
if [ "$1" = 1 ] ; then
echo -n "${DATE} ${category}/${port}: "
make -C ${PORTSDIR}/${category}/${port} -V DEPRECATED
else
echo "${category}/${port}"
fi
fi
done
done
}
# check if some ports depend on the given port
# XXX Very Little Chance (tm) for breaking INDEX exists:
# /usr/ports/INDEX may be outdated and not contain recently added dependencies
check_dep_core()
{
catport=${1}
alltorm=${2}
pkgname=$(pkgname ${catport})
rmpkgs=""
rmcatports=""
for torm in ${alltorm} ; do
torm="$(echo ${torm} | sed 's/\/$//')"
rmpkgs="${rmpkgs:+${rmpkgs}|}$(pkgname ${torm})"
rmcatports="${rmcatports:+${rmcatports}|}${PORTSDIR}/${torm}/"
done
err=0
deps=$(grep -E "${pkgname}" ${INDEX} |grep -vE "^(${rmpkgs})" || :)
if [ -n "${deps}" ] ; then
log "${catport}: some port(s) depend on ${pkgname}:"
echo "${deps}" >&2
err=1
fi
# check if some Makefiles mention the port to be deleted
portdir_grep="^[^#].*/$(basename ${catport})([[:space:]]|@|/|$)"
r="$(${GIT} grep '${portdir_grep}' -- '**Makefile*' 'Mk/' \
|grep -vE "^(${rmcatports})" || :)"
if [ -n "${r}" ] ; then
if [ ${err} -eq 1 ] ; then
echo >&2
fi
log "${catport}: some Makefiles mention ${portdir_grep}:"
echo "${r}" >&2
err=1
fi
return ${err}
}
check_dep()
{
catport=${1}
persist=${2}
alltorm=${3}
log "${catport}: checking dependencies"
err=0
res="$(check_dep_core ${catport} "${alltorm}" 2>&1)" || err=1
if [ ${err} -eq 0 ] ; then
return 0
fi
echo "${res}" |${PAGER:-less}
if [ ${persist} -eq 0 ] ; then
return 0
fi
echo "" >&2
echo "you can skip ${catport} and continue with the rest or remove it anyway" >&2
answer=$(ask "do you want to skip ${catport}")
if [ "${answer}" = "y" ] ; then
return 1
else
return 0
fi
}
# query Bugzilla and return the result
get_PRs()
{
catport=${1}
synopsis=${2}
log "${catport}: getting PRs having ${synopsis} in the synopsis"
url="https://bugs.freebsd.org/bugzilla/buglist.cgi?quicksearch=${synopsis}"
raw="$(fetch -q -T 20 -o - "${url}")"
if [ -z "${raw}" ] ; then
log "${catport}: empty result from URL: ${url}"
exit 67
fi
printf "%s" "${raw}" \
|sed -ne 's,^[[:space:]]*.a href="show_bug.cgi?id=\([0-9][0-9]*\)".\([^0-9][^<]*\).*,\1: \2,p' \
|sort
}
# check if any PRs exist that are related to the port
check_PRs()
{
catport=${1}
synopsis=${2}
PRs="$(get_PRs ${catport} "${synopsis}")" || exit
if [ -n "${PRs}" ] ; then
log "${catport}: PRs found, related to ${synopsis}:"
printf "%s\n" "${PRs}" >&2
echo "you can skip ${catport} and continue with the rest or remove it anyway" >&2
answer=$(ask "do you want to skip ${catport}")
if [ "${answer}" = "y" ] ; then
return 1
else
return 0
fi
fi
return 0
}
# add port's entry to ports/MOVED
edit_MOVED()
{
catport=${1}
DEPRECATED="$(make -C ${PORTSDIR}/${catport} -V DEPRECATED)"
DEPRECATED=${DEPRECATED:+: ${DEPRECATED}}
if [ -n "$(make -C ${PORTSDIR}/${catport} -V EXPIRATION_DATE)" ] ; then
REASON="Has expired${DEPRECATED}"
else
REASON="Removed${DEPRECATED}"
fi
log "${catport}: adding entry to ports/MOVED"
echo "${catport}||${TODAY}|${REASON}" >> MOVED
${GIT} add MOVED
}
# remove port from category/Makefile
edit_Makefile()
{
cat=${1}
port=${2}
log "${cat}/${port}: removing from ${cat}/Makefile"
portesc=$(escape ${port})
${SED} -e "/^[[:space:]]*SUBDIR[[:space:]]*\+=[[:space:]]*${portesc}([[:space:]]+#.*)?$/d" ${cat}/Makefile
${GIT} add ${cat}/Makefile
}
# remove port's files
rm_port()
{
catport=${1}
log "${catport}: scheduling port removal"
echo ${catport} >> ${gitrmlist}
}
append_Template()
{
catport=${1}
msg=${catport}
EXPIRATION_DATE=$(make -C ${PORTSDIR}/${catport} -V EXPIRATION_DATE)
if [ -n "${EXPIRATION_DATE}" ] ; then
msg="${EXPIRATION_DATE} ${msg}"
fi
DEPRECATED="$(make -C ${PORTSDIR}/${catport} -V DEPRECATED)"
if [ -n "${DEPRECATED}" ] ; then
msg="${msg}: ${DEPRECATED}"
fi
log "${catport}: adding entry to commit message template"
echo "${msg}" >> ${gitlog}
}
# update, ask for confirmation and make a commit
commit()
{
${GIT} commit --file=${gitlog}
answer=$(ask "Do you want to tweak the commit message")
if [ "${answer}" = "y" ] ; then
${GIT} pull --ff-only --rebase 2>&1
${GIT} commit 2>&1 # modify final commit message
echo "All done, check the result and push when everything is OK."
fi
}
cleanup()
{
log "cleaning up"
rm -f ${gitlog} ${gitrmlist}
}
usage()
{
echo "Usage:" >&2
echo "" >&2
echo "find expired ports:" >&2
echo "${0} -F" >&2
echo "" >&2
echo "remove port(s):" >&2
echo "${0} category1/port1 [ category2/port2 ... ]" >&2
echo "" >&2
echo "remove all expired ports (as returned by -F):" >&2
echo "${0} -a" >&2
echo "" >&2
echo "just check dependencies:" >&2
echo "${0} -d category/port" >&2
echo "" >&2
echo "just check if any related PRs exist:" >&2
echo "${0} -p synopsis" >&2
exit 64
}
# main
if [ ! -r ${INDEX} ] ; then
echo "${INDEX} not readable, exiting" >&2
exit 66
fi
git_dir="$(${GIT} rev-parse --git-dir)"
exitcode=$?
if [ ${exitcode} -ne 0 ] ; then
echo "not at a git boundary" >&2
exit
else
cd "${git_dir}/.." || exit 1
fi
if ! ${GIT} diff --exit-code remotes/origin/main ; then
echo "you have local commits, exiting" >&2
exit 65
fi
if [ ${#} -eq 0 ] || [ "${1}" = "-h" ] || [ "${1}" = "--help" ] ; then
usage
fi
if [ ${1} = "-d" ] ; then
if [ ${#} -ne 2 ] ; then
usage
fi
catport=$(find_catport ${2})
check_dep ${catport} 0 ${catport}
exit
fi
if [ ${1} = "-p" ] ; then
if [ ${#} -ne 2 ] ; then
usage
fi
get_PRs "dummy" ${2}
exit
fi
if [ ${1} = "-F" ] ; then
if [ ${#} -ne 1 ] ; then
usage
fi
find_expired 1
exit
fi
if [ ${1} = "-a" ] ; then
if [ ${#} -ne 1 ] ; then
usage
fi
${0} $(find_expired 0)
exit
fi
gitlog=$(mktemp -t gitlog)
gitrmlist=$(mktemp -t gitrmlist)
echo "cleanup: Remove expired ports:" > ${gitlog}
echo "" >> ${gitlog}
for catport in $* ; do
# convert to category/port
catport=$(find_catport ${catport})
cat=$(dirname ${catport})
port=$(basename ${catport})
# remove any trailing slashes
catport="${cat}/${port}"
pkgname=$(pkgname ${catport})
if ! check_dep ${catport} 1 "${*}" ; then
continue
fi
if ! check_PRs ${catport} ${port} ; then
continue
fi
# everything seems ok, edit the files
edit_MOVED ${catport}
edit_Makefile ${cat} ${port}
append_Template ${catport}
rm_port ${catport}
done
if [ -s ${gitrmlist} ] ; then
${GIT} rm -r $(cat ${gitrmlist})
else
log "No port directories to remove"
fi
# give a chance to the committer to edit files by hand and recreate/review
# the diff afterwards
answer=y
while [ "${answer}" = "y" ] ; do
${GIT} diff --staged --irreversible-delete
echo "" >&2
echo "you can now edit files by hand" >&2
answer=$(ask "do you want to recreate the diff")
if [ "${answer}" = "y" ] ; then
${GIT} add MOVED
fi
done
commit
cleanup
# EOF
|