summaryrefslogtreecommitdiff
path: root/pkgtools/pkgtasks/files/preinstall.subr
blob: c1296052cb8a5568255c30f1cf3731e67bec4fdf (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
# 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
#	preinstall.subr -- pre-installation actions for packages
#
# SYNOPSIS
#	task_preinstall <datafile>
#
# DESCRIPTION
#	The task_preinstall function performs actions that MUST occur
#	successfully BEFORE the package files are installed into their
#	final location for the installation to be successful:
#
#	    o Ensure that all required groups and users exist.
#	    o Create required directories.
#
#	The datafile contains lines of the form:
#
#	    # <keyword>: <arg> ...
#
#	These lines are used as input to the various script functions.
#
# RETURN VALUES
#	Returns 0 on success, and >0 if an error occurs.
#
# ENVIRONMENT
#	The following variables are used if they are set:
#
#	TASK_VERBOSE
#		List of package tasks that should emit verbose output.
#		If ${TASK_VERBOSE} is "all", then all tasks are verbose.
#		If ${TASK_VERBOSE} is "none", then no tasks are verbose.
#		Otherwise, if one of the tasks is "default", then the
#		default list of tasks are verbose.
#

__task_preinstall__="yes"

task_load directories
task_load groups
task_load sort
task_load taskfunc
task_load users

task_preinstall()
{
	: ${TASK_VERBOSE:=default}

	[ $# -gt 0 ] || return 127
	local datafile="$1"; shift

	[ -f "$datafile" ] || return 1

	local stage="preinstall"

	# $verbose are the package tasks that give verbose output.
	# Expand "all", "default" and "none" to a fixed list of tasks.
	#
	local verbose="${TASK_VERBOSE}"
	case " $verbose " in
	" all "|*" default "*)
		verbose="directories function groups users" ;;
	" none ")
		verbose= ;;
	esac

	local silent

	# Require necessary groups and users before actions that may
	# set permissions.
	#
	case " $verbose " in
	*" groups "*)
		silent= ;;
	*)	silent="-s" ;;
	esac
	task_groups $silent add $stage < $datafile
	if task_groups check-add $stage < $datafile; then
		: "groups exist"
	else
		# Fatal error: groups are missing.
		return 1
	fi

	case " $verbose " in
	*" users "*)
		silent= ;;
	*)	silent="-s" ;;
	esac
	task_users $silent add $stage < $datafile
	if task_users check-add $stage < $datafile; then
		: "users exist"
	else
		# Fatal error: users are missing.
		return 1
	fi

	# Create directories so that pre-existing directories can be
	# correctly identified.  Sort the entries prior to creation to
	# create path components in order.  Any errors in creating
	# directories are non-fatal.
	#
	case " $verbose " in
	*" directories "*)
		silent= ;;
	*)	silent="-s" ;;
	esac
	task_sort < $datafile | task_directories $silent add $stage

	# Run the generic package tasks.
	case " $verbose " in
	*" function "*)
		silent= ;;
	*)	silent="-s" ;;
	esac
	if task_function $silent add $stage < $datafile; then
		: "success"
	else
		# Fatal error: failures in generic package tasks.
		return 1
	fi

	return 0
}