summaryrefslogtreecommitdiff
path: root/src/lib/libreblacklist
blob: 5cfb4100d22c4ea6f3a3fa6070b938759288aedc (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
#!/bin/bash -euE
#!/bin/bash
#   Copyright (c) 2013 by Luke Shumaker <lukeshu@sbcglobal.net>
#
#   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 3 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/>.

# make sure XDG_CACHE_HOME is set
. $(librelib conf.sh)

# Usage: blacklist-normalize <$file
# Normalizes the syntax of the blacklist on stdin
blacklist-normalize() {
	sed -e 's/^[^:]*$/&::/' -e 's/^[^:]*:[^:]*$/&:/'
}

# Usage: blacklist-cat
# Prints the blacklist.
# Uses the chache, but downloads it if it doesn't exist. Also normalizes the
# blacklist for easier parsing.
blacklist-cat() {
	local file="$XDG_CACHE_HOME/libretools/blacklist.txt"
	if ! [[ -e $file ]]; then
		# exit on failure, whether set -e or not
		blacklist-update || return $?
	fi
	blacklist-normalize < "$file"
}

# Usage: blacklist-update
# Updates (or creates) the cached copy of the blacklist
blacklist-update() (
	set -euE # allow it to not be set globally
	. libremessages
	load_files libretools
	check_vars libretools BLACKLIST

	local remote_blacklist="$BLACKLIST"
	local local_blacklist="$XDG_CACHE_HOME/libretools/blacklist.txt"

	stat_busy "Downloading blacklist of proprietary software packages"

	mkdir -p "${local_blacklist%/*}"
	if wget -N -q -O "${local_blacklist}.part" "$remote_blacklist" 2>/dev/null; then
		stat_done
		mv "${local_blacklist}.part" "$local_blacklist"
	else
		stat_done
		rm "${local_blacklist}.part"
		if [[ -e "$local_blacklist" ]]; then
			warning "Using local copy of blacklist"
		else
			error "Download failed, exiting"
			return 1
		fi

	fi
)

# Usage: blacklist-cat | blacklist-lookup $pkgname
# Filters to obtain the line for $pkgname from the blacklist on stdin.
# Exits successfully whether a line is found or not.
blacklist-lookup() {
	local pkg=$1
	# we accept that $pkg contains no regex-nes
	blacklist-normalize | grep "^$pkg:" || true
}

# Usage: blacklist-cat | blacklist-get-pkg
# Prints only the package name field of the blacklist line(s) on stdin.
blacklist-get-pkg() {
	blacklist-normalize | cut -d: -f1
}

# Usage: blacklist-cat | blacklist-get-rep
# Prints only the replacement package field of the blacklist line(s) on stdin.
blacklist-get-rep() {
	blacklist-normalize | cut -d: -f2
}

# Usage: blacklist-cat | blacklist-get-reason
# Prints only the reason field of the blacklist line(s) on stdin.
blacklist-get-reason() {
	blacklist-normalize | cut -d: -f3-
}

if [[ "${0##*/}" == libreblacklist ]]; then
	usage-outside() {
		sed -n '/^# Usage:/,/()/p' $0 |
		tr '\n' '\r' | sed 's/\s*()\s*[{(]/\n/g'
	}
	usage-inside() {
		sed 's/\r/\n/g'<<<"$1"|sed '/^$/d'
	}
	usage() {
		if [[ $# -eq 0 ]]; then
			printf "Usage: %s [-h] COMMAND [ARGUMENTS]\n" "${0##*/}"
			echo "Tool for working with the nonfree software blacklist"
			echo
			echo "Commands:"
			usage-outside | while read -r sec; do sec="$(usage-inside "$sec")"
				<<<"$sec" sed -n \
					-e 's/blacklist-//g' \
					-e 's/^# //' \
					-e '2p;$p' |
				tac|tr '\n' '\t'
				echo
			done|column -t -s"$(printf '\t')"|sed 's/^/  /'
		else
			usage-outside | while read -r sec; do sec="$(usage-inside "$sec")"
				cmd=$(<<<"$sec" sed -n 's/.*blacklist[ -]//;$p')
				if [[ "$cmd" == "$1" ]]; then
					<<<"$sec" sed -n \
						-e "s/blacklist-/${0##*/} /g" \
						-e 's/^# //p'
				fi
			done
		fi
	}

	if [[ $# -eq 0 ]]; then
		usage >/dev/stderr
		exit 1
	fi
	_blacklist_cmd=$1
	shift
	if [[ $_blacklist_cmd == -h ]]; then
		usage "$@"
	else
		"blacklist-$_blacklist_cmd" "$@"
	fi
fi