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
|
# Copyright (c) 2017 The NetBSD Foundation, Inc.
# All rights reserved.
#
# This code is derived from software contributed to The NetBSD Foundation
# by Johnny C. Lam.
#
# 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
#
# NAME
# groups.subr -- group management for packages
#
# SYNOPSIS
# task_groups [-s] add | remove
# task_groups check-add | check-remove
#
# DESCRIPTION
# The task_groups function supports four actions: "add", "remove",
# "check-add", and "check-remove".
#
# The available options are as follows:
#
# -s Silent; don't write to standard output.
#
# The task_groups function reads standard input line by line and
# looks for lines of the form:
#
# # GROUP: <name>[:<groupid>]
#
# Only the group is required; the groupid is optional.
#
# The "add" action creates the group with the given name if it is
# missing, with the given group ID, if ${PKG_CREATE_USERGROUP} is
# "yes". A reference count for the group will be error for the
# package.
#
# The "remove" action removes a reference count for the group by
# the package. This function shall not remove any group on the
# system.
#
# The "check-add" action will check whether the groups exist with
# the optional group IDs if they are given, or otherwise writes a
# message to standard output noting the missing groups.
#
# The "check-remove" action will check whether the groups have been
# removed, or otherwise writes a message to standard output noting
# the groups still exists.
#
# RETURN VALUES
# The "add" and "remove" actions return 0 if they are successful
# for all groups, and >0 if an error occurs.
#
# The "check-add" and "check-remove" actions return >0 if they
# write informative messages, and return 0 otherwise.
#
# ENVIRONMENT
# The following variables are used if they are set:
#
# PKGNAME
# The name of the package.
#
# PKG_CREATE_USERGROUP
# If ${PKG_CREATE_USERGROUP} is a "truthy" value, then the
# "add" and "remove" actions are allowed to create and
# remove groups from the system.
#
# TASK_MSG
# String prepended to all normal message written to
# standard output.
#
__task_groups__="yes"
__task_groups_init__="_task_groups_init"
task_load cleanup
task_load echo
task_load quote
task_load refcount
task_load truthy
task_load usergroup
task_load usergroup_exists
task_groups()
{
: ${PKGNAME:=${0##*/}}
: ${PKG_CREATE_USERGROUP:=yes}
: ${TASK_MSG:=""}
local arg
local echo="task_echo"
local OPTIND=1
while getopts ":s" arg "$@"; do
case $arg in
s) echo=":" ;;
*) return 127 ;;
esac
done
shift $(( ${OPTIND} - 1 ))
[ $# -gt 0 ] || return 127
local action="$1"; shift
case $action in
add|remove|check-add|check-remove)
: "valid action" ;;
*) return 0 ;;
esac
local create="yes"
task_is_truthy "${PKG_CREATE_USERGROUP}" || create=
local result line_result
local save_IFS group gid msg
result=0
local hash tag entry
while read hash tag entry; do
# Filter for "# GROUP:".
case $hash/$tag in
"#/GROUP:")
: "use this line" ;;
*) continue ;;
esac
save_IFS=$IFS; IFS=:
set -o noglob; set -- $entry; set +o noglob
group=$1; gid=$2
IFS=$save_IFS
[ -n "$group" ] || continue
if [ -n "$gid" ]; then
msg="$group (gid = $gid)"
else
msg="$group"
fi
line_result=0
case $action in
add) if task_refcount add groups "$group"; then
task_group_exists "$group" "$gid"
case $? in
0) # $group exists and has gid $gid
$echo "${TASK_MSG}! group already exists: $msg" ;;
1) # neither $group nor $gid exist
if [ -z "$create" ]; then
$echo "${TASK_MSG}! group creation skipped: $msg"
elif task_addgroup "$group" "$gid"; then
$echo "${TASK_MSG}> group created: $msg"
# Keep track of groups added in case of error later.
task_quote "$group"
__task_groups_error__="$__task_groups_error__ $_quoted"
else
$echo "${TASK_MSG}! group not created: $msg"
line_result=1
fi ;;
2) $echo "${TASK_MSG}! group conflict: $msg"
result=1
break ;;
*) $echo "${TASK_MSG}! group not created: $msg"
line_result=1 ;;
esac
else
# add refcount failed; skip to next line
$echo "${TASK_MSG}! refcount add failure: groups $msg"
result=1
continue
fi ;;
remove) if task_refcount remove groups "$group"; then
if task_refcount exists groups "$group"; then
: "refcount is not zero"
else
# delete the reference count
task_refcount delete groups "$group"
fi
else
# remove refcount failed
$echo "${TASK_MSG}! refcount remove failure: groups $msg"
line_result=1
fi ;;
check-add)
if task_group_exists "$group" "$gid"; then
: "group already exists"
else
task_echo "!!! INFO: ${PKGNAME}: Create group: $msg"
line_result=1
fi ;;
check-remove)
if task_group_exists "$group" "$gid"; then
task_echo "!!! INFO: ${PKGNAME}: Remove group if unused: $group"
line_result=1
fi ;;
esac
[ $line_result -eq 0 ] || result=1
done
# Clear groups to remove in case of error if all groups added
# successfully.
#
[ $result -gt 0 ] || __task_groups_error__=
return $result
}
_task_groups_cleanup()
{
eval set -- $__task_groups_error__
local group
for group; do
if task_group_exists "$group"; then
task_echo "!!! ERROR: ${PKGNAME}: Group created before error: $group"
fi
done
__task_groups_error__=
}
_task_groups_init()
{
task_cleanup_add_hook _task_groups_cleanup
}
# Static variable for groups that should be removed if an error occurs.
__task_groups_error__=
|
