diff --git a/Tools/scripts/rmport b/Tools/scripts/rmport index 4e6b771e3658..221ff4d329b7 100755 --- a/Tools/scripts/rmport +++ b/Tools/scripts/rmport @@ -1,559 +1,485 @@ #!/bin/sh -e # # rmport - remove port(s) from the FreeBSD Ports Collection. # # Copyright 2006-2007 Vasil Dimov # Copyright 2012-2018 Chris Rees -# Copyright 2016-2018 Rene Ladan +# 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 # Others: # Chris Rees -# Rene Ladan -# -# $FreeBSD$ +# René Ladan # # MAINTAINER= crees@FreeBSD.org # EDITOR=${EDITOR:-/usr/bin/vi} PORTSDIR=${PORTSDIR:-/usr/ports} -INDEX=${PORTSDIR}/`make -C ${PORTSDIR} -V INDEXFILE` +INDEX=${PORTSDIR}/$(make -C ${PORTSDIR} -V INDEXFILE) -TODAY=`date -u -v+0d +%Y-%m-%d` +TODAY=$(date -u +%Y-%m-%d) SED="sed -i .orig -E" # use ~/.ssh/config to set up the desired username if different than $LOGNAME -SVNREPO=${SVNREPO:-svn+ssh://repo.FreeBSD.org/ports} +GITREPO=${GITREPO:-git@gitrepo.FreeBSD.org:ports.git} -if [ -n "$(command -v svn 2>/dev/null)" ]; then - SVN=svn -elif [ -n "$(command -v svnlite 2>/dev/null)" ]; then - SVN=svnlite +if [ -n "$(command -v git 2>/dev/null)" ]; then + GIT=git else - echo "Neither svn(1) nor svnlite(1) found. Please install devel/subversion." + echo "git(1) not found. Please install devel/git." exit 1 fi - -if ! CDIFF=$(which cdiff) ; then - CDIFF=${PAGER} -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" -a "${answer}" != "n" ] ; do - read -p "${question} [yn] " answer + 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}` + rp=$(realpath ${arg}) - category=`basename \`dirname ${rp}\`` - port=`basename ${rp}` + category=$(basename $(dirname ${rp})) + port=$(basename ${rp}) echo ${category}/${port} else - echo "What do you mean by \`${arg}'?" >&2 + echo "What do you mean by '${arg}'?" >&2 exit 1 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)" - if [ -n "${DATE}" -a ! "${DATE}" \> "${TODAY}" ] ; then + # 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 } -# create temporary checkout directory -mkcodir() -{ - log "creating temporary directory" - d=`mktemp -d -t rmport` - echo "This is the commit message, please edit it." >> ${d}/svnlog - log "created ${d}" - echo "${d}" -} - -# checkout common files from the repository -co_common() -{ - log "getting ports/MOVED and ports/LEGAL from repository" - ${SVN} co --depth empty ${SVNREPO}/head ports - ${SVN} up ports/MOVED ports/LEGAL -} - # 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}` + pkgname=$(pkgname ${catport}) rmpkgs="" rmcatports="" for torm in ${alltorm} ; do - torm="`echo ${torm} | sed 's/\/$//'`" - rmpkgs="${rmpkgs:+${rmpkgs}|}`pkgname ${torm}`" + 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})" || :` + 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="`find -H ${PORTSDIR} -mindepth 2 -maxdepth 3 \ - \( -name "Makefile*" -or -path "*Mk/*.mk" \) \ - |xargs grep -EH "${portdir_grep}" \ - |grep -vE "^(${rmcatports})" || :`" + 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 + 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}?"` + answer=$(ask "do you want to skip ${catport}") if [ "${answer}" = "y" ] ; then return 1 else return 0 fi } -# query GNATS via Bugzilla, format and return the result -get_PRs_www() +# 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}"`" + raw="$(fetch -q -T 20 -o - "${url}")" if [ -z "${raw}" ] ; then log "${catport}: empty result from URL: ${url}" exit 1 fi printf "%s" "${raw}" \ |sed -ne 's,^[[:space:]]*.a href="show_bug.cgi?id=\([0-9][0-9]*\)".\([^0-9][^<]*\).*,\1: \2,p' \ |sort } -# query GNATS and return the result -get_PRs() -{ - catport=${1} - synopsis=${2} - - get_PRs_www ${catport} ${synopsis} -} - # check if any PRs exist that are related to the port check_PRs() { catport=${1} synopsis=${2} - PRs="`get_PRs ${catport} "${synopsis}"`" || exit + 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}?"` + answer=$(ask "do you want to skip ${catport}") if [ "${answer}" = "y" ] ; then return 1 else return 0 fi fi return 0 } -# checkout port's specific files from the repository -co_port() -{ - cat=${1} - port=${2} - - log "${cat}/${port}: getting ${cat}/Makefile and port's files from repository" - ${SVN} up --depth empty ports/${cat} ports/$cat/Makefile - ${SVN} up ports/${cat}/${port} -} - # check if anything about the port is mentioned in ports/LEGAL check_LEGAL() { catport=${1} pkgname=${2} for checkstr in ${pkgname} ${catport} ; do msg="${catport}: checking if ${checkstr} is in ports/LEGAL" log "${msg}" - while grep -i ${checkstr} ports/LEGAL ; do + while grep -i ${checkstr} LEGAL ; do echo "" >&2 - echo "${checkstr} is in ${PWD}/ports/LEGAL" >&2 + echo "${checkstr} is in ports/LEGAL" >&2 echo "remove it and hit when ready" >&2 - echo "or hit \`s' to skip this issue and continue anyway" >&2 + echo "or hit 's' to skip this issue and continue anyway" >&2 read answer if [ "${answer}" = "s" ] ; then break fi log "${msg}" done done + ${GIT} add LEGAL } # add port's entry to ports/MOVED edit_MOVED() { catport=${1} - DEPRECATED="`make -C ${PORTSDIR}/${catport} -V DEPRECATED`" + DEPRECATED="$(make -C ${PORTSDIR}/${catport} -V DEPRECATED)" DEPRECATED=${DEPRECATED:+: ${DEPRECATED}} - if [ -n "`make -C ${PORTSDIR}/${catport} -V EXPIRATION_DATE`" ] ; then + 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}" >> 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}` + portesc=$(escape ${port}) - ${SED} -e "/^[[:space:]]*SUBDIR[[:space:]]*\+=[[:space:]]*${portesc}([[:space:]]+#.*)?$/d" \ - ports/${cat}/Makefile + ${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}: removing port's files" - ${SVN} rm ports/${catport} + ${GIT} rm -r ${catport} } append_Template() { catport=${1} msg=${catport} - EXPIRATION_DATE=`make -C ${PORTSDIR}/${catport} -V EXPIRATION_DATE` + 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`" + 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}" >> ./svnlog + echo "${msg}" >> ${gitlog} } -# diff -diff() -{ - log "creating diff" - - diffout=${codir}/diff - - ${SVN} diff --no-diff-deleted ports > ${diffout} 2>&1 || : - - read -p "hit to view svn diff output" dummy - - # give this to the outside world so it can be showed to the committer - # and removed when we are done - echo ${diffout} -} - -# update, ask for confirmation and commit +# update, ask for confirmation and make a commit commit() { - log "running svn update" - ${SVN} up --quiet ports 2>&1 |${PAGER:-less} - - echo >> svnlog - echo - $EDITOR svnlog - - log "Your commit message is:" - cat svnlog - - answer=y - while [ "${answer}" = "y" ] ; do - answer=`ask "Do you want to edit your commit message again?"` - if [ "${answer}" = "y" ] ; then - $EDITOR svnlog - fi - done - - answer=`ask "Do you want to commit now?"` - + ${GIT} commit --file=${gitlog} + answer=$(ask "Do you want to merge and tweak the commit message") if [ "${answer}" = "y" ] ; then - ${SVN} ci --file svnlog ports + ${GIT} checkout main 2>&1 + ${GIT} pull --ff-only 2>&1 + ${GIT} merge --squash ${branch} 2>&1 # history remains linear + ${GIT} commit 2>&1 # modify final commit message + echo "All done, check the result and push when everything is OK." fi } cleanup() { - diffout=${1} - codir=${2} - log "cleaning up" - rm ${diffout} - - rm svnlog - - # release ports directories - rm -rf ports - - cd / - rmdir ${codir} + rm -f ${gitlog} + ${GIT} checkout main + ${GIT} branch -D ${branch} } 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 [ ${#} -eq 0 -o "${1}" = "-h" -o "${1}" = "--help" ] ; then +if ! ${GIT} diff --exit-code remotes/origin/main ; then + echo "you have local commits, exiting" >&2 + exit +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 [ ${#} -eq 0 ] || [ "${1}" = "-h" ] || [ "${1}" = "--help" ] ; then usage fi if [ ${1} = "-d" ] ; then if [ ${#} -ne 2 ] ; then usage fi - catport=`find_catport ${2}` + 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` + ${0} $(find_expired 0) exit fi -codir=`mkcodir` -cd ${codir} - -co_common +branch="rmport-$(date +%s)" +${GIT} checkout -b ${branch} remotes/origin/main +gitlog=$(mktemp -t gitlog) for catport in $* ; do # convert to category/port - catport=`find_catport ${catport}` - cat=`dirname ${catport}` - port=`basename ${catport}` + catport=$(find_catport ${catport}) + cat=$(dirname ${catport}) + port=$(basename ${catport}) # remove any trailing slashes catport="${cat}/${port}" - pkgname=`pkgname ${catport}` + pkgname=$(pkgname ${catport}) if ! check_dep ${catport} 1 "${*}" ; then continue fi if ! check_PRs ${catport} ${port} ; then continue fi - co_port ${cat} ${port} - check_LEGAL ${catport} ${pkgname} # everything seems ok, edit the files edit_MOVED ${catport} edit_Makefile ${cat} ${port} rm_port ${catport} append_Template ${catport} done # give a chance to the committer to edit files by hand and recreate/review # the diff afterwards answer=y while [ "${answer}" = "y" ] ; do - diffout=$(diff) - - ${CDIFF} < ${diffout} + ${GIT} diff --staged --irreversible-delete echo "" >&2 - echo "you can now edit files under ${codir}/ by hand" >&2 - answer=`ask "do you want to recreate the diff?"` + echo "you can now edit files by hand" >&2 + answer=$(ask "do you want to recreate the diff") + if [ "${answer}" = "y" ] ; then + ${GIT} add LEGAL MOVED + fi done commit -cleanup ${diffout} ${codir} +cleanup # EOF