gentoo-x86/eclass/user.eclass

# Copyright 1999-2012 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: /var/cvsroot/gentoo-x86/eclass/user.eclass,v 1.21 2012/06/22 18:57:33 axs Exp $

# @ECLASS: user.eclass
# @MAINTAINER:
# base-system@gentoo.org (Linux)
# Joe Jezak <josejx@gmail.com> (OS X)
# usata@gentoo.org (OS X)
# Aaron Walker <ka0ttic@gentoo.org> (FreeBSD)
# @BLURB: user management in ebuilds
# @DESCRIPTION:
# The user eclass contains a suite of functions that allow ebuilds
# to quickly make sure users in the installed system are sane.

if [[ ${___ECLASS_ONCE_USER} != "recur -_+^+_- spank" ]] ; then
___ECLASS_ONCE_USER="recur -_+^+_- spank"

# @FUNCTION: _assert_pkg_ebuild_phase
# @INTERNAL
# @USAGE: <calling func name>
_assert_pkg_ebuild_phase() {
        case ${EBUILD_PHASE} in
        setup|preinst|postinst) ;;
        *)
                eerror "'$1()' called from '${EBUILD_PHASE}' phase which is not OK:"
                eerror "You may only call from pkg_{setup,preinst,postinst} functions."
                eerror "Package fails at QA and at life.  Please file a bug."
                die "Bad package!  $1 is only for use in some pkg_* functions!"
        esac
}

# @FUNCTION: egetent
# @USAGE: <database> <key>
# @DESCRIPTION:
# Small wrapper for getent (Linux), nidump (< Mac OS X 10.5),
# dscl (Mac OS X 10.5), and pw (FreeBSD) used in enewuser()/enewgroup().
#
# Supported databases: group passwd
egetent() {
        local db=$1 key=$2

        [[ $# -ge 3 ]] && die "usage: egetent <database> <key>"

        case ${db} in
        passwd|group) ;;
        *) die "sorry, database '${db}' not yet supported; file a bug" ;;
        esac

        case ${CHOST} in
        *-darwin[678])
                case ${key} in
                *[!0-9]*) # Non numeric
                        nidump ${db} . | awk -F: "(\$1 ~ /^${key}\$/) {print;exit;}"
                        ;;
                *)      # Numeric
                        nidump ${db} . | awk -F: "(\$3 == ${key}) {print;exit;}"
                        ;;
                esac
                ;;
        *-darwin*)
                local mykey
                case ${db} in
                passwd) db="Users"  mykey="UniqueID" ;;
                group)  db="Groups" mykey="PrimaryGroupID" ;;
                esac

                case ${key} in
                *[!0-9]*) # Non numeric
                        dscl . -read /${db}/${key} 2>/dev/null |grep RecordName
                        ;;
                *)      # Numeric
                        dscl . -search /${db} ${mykey} ${key} 2>/dev/null
                        ;;
                esac
                ;;
        *-freebsd*|*-dragonfly*)
                case ${db} in
                passwd) db="user" ;;
                *) ;;
                esac

                # lookup by uid/gid
                local opts
                if [[ ${key} == [[:digit:]]* ]] ; then
                        [[ ${db} == "user" ]] && opts="-u" || opts="-g"
                fi

                pw show ${db} ${opts} "${key}" -q
                ;;
        *-netbsd*|*-openbsd*)
                grep "${key}:\*:" /etc/${db}
                ;;
        *)
                # ignore output if nscd doesn't exist, or we're not running as root
                nscd -i "${db}" 2>/dev/null
                getent "${db}" "${key}"
                ;;
        esac
}

# @FUNCTION: enewuser
# @USAGE: <user> [uid] [shell] [homedir] [groups]
# @DESCRIPTION:
# Same as enewgroup, you are not required to understand how to properly add
# a user to the system.  The only required parameter is the username.
# Default uid is (pass -1 for this) next available, default shell is
# /bin/false, default homedir is /dev/null, and there are no default groups.
enewuser() {
        _assert_pkg_ebuild_phase ${FUNCNAME}

        # get the username
        local euser=$1; shift
        if [[ -z ${euser} ]] ; then
                eerror "No username specified !"
                die "Cannot call enewuser without a username"
        fi

        # lets see if the username already exists
        if [[ -n $(egetent passwd "${euser}") ]] ; then
                return 0
        fi
        einfo "Adding user '${euser}' to your system ..."

        # options to pass to useradd
        local opts=()

        # handle uid
        local euid=$1; shift
        if [[ -n ${euid} && ${euid} != -1 ]] ; then
                if [[ ${euid} -gt 0 ]] ; then
                        if [[ -n $(egetent passwd ${euid}) ]] ; then
                                euid="next"
                        fi
                else
                        eerror "Userid given but is not greater than 0 !"
                        die "${euid} is not a valid UID"
                fi
        else
                euid="next"
        fi
        if [[ ${euid} == "next" ]] ; then
                for ((euid = 101; euid <= 999; euid++)); do
                        [[ -z $(egetent passwd ${euid}) ]] && break
                done
        fi
        opts+=( -u ${euid} )
        einfo " - Userid: ${euid}"

        # handle shell
        local eshell=$1; shift
        if [[ ! -z ${eshell} ]] && [[ ${eshell} != "-1" ]] ; then
                if [[ ! -e ${ROOT}${eshell} ]] ; then
                        eerror "A shell was specified but it does not exist !"
                        die "${eshell} does not exist in ${ROOT}"
                fi
                if [[ ${eshell} == */false || ${eshell} == */nologin ]] ; then
                        eerror "Do not specify ${eshell} yourself, use -1"
                        die "Pass '-1' as the shell parameter"
                fi
        else
                for eshell in /sbin/nologin /usr/sbin/nologin /bin/false /usr/bin/false /dev/null ; do
                        [[ -x ${ROOT}${eshell} ]] && break
                done

                if [[ ${eshell} == "/dev/null" ]] ; then
                        eerror "Unable to identify the shell to use, proceeding with userland default."
                        case ${USERLAND} in
                                GNU)    eshell="/bin/false" ;;
                                BSD)    eshell="/sbin/nologin" ;;
                                Darwin) eshell="/usr/sbin/nologin" ;;
                                *) die "Unable to identify the default shell for userland ${USERLAND}"
                        esac
                fi
        fi
        einfo " - Shell: ${eshell}"
        opts+=( -s "${eshell}" )

        # handle homedir
        local ehome=$1; shift
        if [[ -z ${ehome} ]] || [[ ${ehome} == "-1" ]] ; then
                ehome="/dev/null"
        fi
        einfo " - Home: ${ehome}"
        opts+=( -d "${ehome}" )

        # handle groups
        local egroups=$1; shift
        local g egroups_arr
        IFS="," read -r -a egroups_arr <<<"${egroups}"
        shift
        if [[ ${#egroups_arr[@]} -gt 0 ]] ; then
                local defgroup exgroups
                for g in "${egroups_arr[@]}" ; do
                        if [[ -z $(egetent group "${g}") ]] ; then
                                eerror "You must add group ${g} to the system first"
                                die "${g} is not a valid GID"
                        fi
                        if [[ -z ${defgroup} ]] ; then
                                defgroup=${g}
                        else
                                exgroups+=",${g}"
                        fi
                done
                opts+=( -g "${defgroup}" )
                if [[ ! -z ${exgroups} ]] ; then
                        opts+=( -G "${exgroups:1}" )
                fi
        fi
        einfo " - Groups: ${egroups:-(none)}"

        # handle extra args
        if [[ $# -gt 0 ]] ; then
                die "extra arguments no longer supported; please file a bug"
        else
                local comment="added by portage for ${PN}"
                opts+=( -c "${comment}" )
                einfo " - GECOS: ${comment}"
        fi

        # add the user
        case ${CHOST} in
        *-darwin*)
                ### Make the user
                dscl . create "/users/${euser}" uid ${euid}
                dscl . create "/users/${euser}" shell "${eshell}"
                dscl . create "/users/${euser}" home "${ehome}"
                dscl . create "/users/${euser}" realname "added by portage for ${PN}"
                ### Add the user to the groups specified
                for g in "${egroups_arr[@]}" ; do
                        dscl . merge "/groups/${g}" users "${euser}"
                done
                ;;

        *-freebsd*|*-dragonfly*)
                pw useradd "${euser}" "${opts[@]}" || die
                ;;

        *-netbsd*)
                useradd "${opts[@]}" "${euser}" || die
                ;;

        *-openbsd*)
                # all ops the same, except the -g vs -g/-G ...
                useradd -u ${euid} -s "${eshell}" \
                        -d "${ehome}" -g "${egroups}" "${euser}" || die
                ;;

        *)
                useradd -r "${opts[@]}" "${euser}" || die
                ;;
        esac

        if [[ ! -e ${ROOT}/${ehome} ]] ; then
                einfo " - Creating ${ehome} in ${ROOT}"
                mkdir -p "${ROOT}/${ehome}"
                chown "${euser}" "${ROOT}/${ehome}"
                chmod 755 "${ROOT}/${ehome}"
        fi
}

# @FUNCTION: enewgroup
# @USAGE: <group> [gid]
# @DESCRIPTION:
# This function does not require you to understand how to properly add a
# group to the system.  Just give it a group name to add and enewgroup will
# do the rest.  You may specify the gid for the group or allow the group to
# allocate the next available one.
enewgroup() {
        _assert_pkg_ebuild_phase ${FUNCNAME}

        # get the group
        local egroup=$1; shift
        if [[ -z ${egroup} ]] ; then
                eerror "No group specified !"
                die "Cannot call enewgroup without a group"
        fi

        # see if group already exists
        if [[ -n $(egetent group "${egroup}") ]] ; then
                return 0
        fi
        einfo "Adding group '${egroup}' to your system ..."

        # handle gid
        local egid=$1; shift
        if [[ ! -z ${egid} ]] ; then
                if [[ ${egid} -gt 0 ]] ; then
                        if [[ -n $(egetent group ${egid}) ]] ; then
                                egid="next available; requested gid taken"
                        fi
                else
                        eerror "Groupid given but is not greater than 0 !"
                        die "${egid} is not a valid GID"
                fi
        else
                egid="next available"
        fi
        einfo " - Groupid: ${egid}"

        # handle extra
        if [[ $# -gt 0 ]] ; then
                die "extra arguments no longer supported; please file a bug"
        fi

        # Some targets need to find the next available GID manually
        _enewgroup_next_gid() {
                if [[ ${egid} == *[!0-9]* ]] ; then
                        # Non numeric
                        for ((egid = 101; egid <= 999; egid++)) ; do
                                [[ -z $(egetent group ${egid}) ]] && break
                        done
                fi
        }

        # add the group
        case ${CHOST} in
        *-darwin*)
                _enewgroup_next_gid
                dscl . create "/groups/${egroup}" gid ${egid}
                dscl . create "/groups/${egroup}" passwd '*'
                ;;

        *-freebsd*|*-dragonfly*)
                _enewgroup_next_gid
                pw groupadd "${egroup}" -g ${egid} || die
                ;;

        *-netbsd*)
                _enewgroup_next_gid
                groupadd -g ${egid} "${egroup}" || die
                ;;

        *)
                local opts
                if [[ ${egid} == *[!0-9]* ]] ; then
                        # Non numeric; let groupadd figure out a GID for us
                        opts=""
                else
                        opts="-g ${egid}"
                fi
                # We specify -r so that we get a GID in the system range from login.defs
                groupadd -r ${opts} "${egroup}" || die
                ;;
        esac
}

# @FUNCTION: egethome
# @USAGE: <user>
# @DESCRIPTION:
# Gets the home directory for the specified user.
egethome() {
        local pos

        [[ $# -eq 1 ]] || die "usage: egethome <user>"

        case ${CHOST} in
        *-darwin*|*-freebsd*|*-dragonfly*)
                pos=9
                ;;
        *)      # Linux, NetBSD, OpenBSD, etc...
                pos=6
                ;;
        esac

        egetent passwd "$1" | cut -d: -f${pos}
}

# @FUNCTION: egetshell
# @USAGE: <user>
# @DESCRIPTION:
# Gets the shell for the specified user.
egetshell() {
        local pos

        [[ $# -eq 1 ]] || die "usage: egetshell <user>"

        case ${CHOST} in
        *-darwin*|*-freebsd*|*-dragonfly*)
                pos=10
                ;;
        *)      # Linux, NetBSD, OpenBSD, etc...
                pos=7
                ;;
        esac

        egetent passwd "$1" | cut -d: -f${pos}
}

# @FUNCTION: esethome
# @USAGE: <user> <homedir>
# @DESCRIPTION:
# Update the home directory in a platform-agnostic way.
# Required parameters is the username and the new home directory.
# Specify -1 if you want to set home to the enewuser default 
# of /dev/null.
# If the new home directory does not exist, it is created.
# Any previously existing home directory is NOT moved.
esethome() {
        _assert_pkg_ebuild_phase ${FUNCNAME}

        # get the username
        local euser=$1; shift
        if [[ -z ${euser} ]] ; then
                eerror "No username specified !"
                die "Cannot call esethome without a username"
        fi

        # lets see if the username already exists
        if [[ -z $(egetent passwd "${euser}") ]] ; then
                ewarn "User does not exist, cannot set home dir -- skipping."
                return 1
        fi

        # handle homedir
        local ehome=$1; shift
        if [[ -z ${ehome} ]] ; then
                eerror "No home directory specified !"
                die "Cannot call esethome without a home directory or '-1'"
        fi

        if [[ ${ehome} == "-1" ]] ; then
                ehome="/dev/null"
        fi

        # exit with no message if home dir is up to date
        if [[ $(egethome "${euser}") == ${ehome} ]]; then
                return 0
        fi

        einfo "Updating home for user '${euser}' ..."
        einfo " - Home: ${ehome}"

        # ensure home directory exists, otherwise update will fail
        if [[ ! -e ${ROOT}/${ehome} ]] ; then
                einfo " - Creating ${ehome} in ${ROOT}"
                mkdir -p "${ROOT}/${ehome}"
                chown "${euser}" "${ROOT}/${ehome}"
                chmod 755 "${ROOT}/${ehome}"
        fi

        # update the home directory
        case ${CHOST} in
        *-darwin*)
                dscl . change "/users/${euser}" home "${ehome}"
                ;;

        *-freebsd*|*-dragonfly*)
                pw usermod "${euser}" -d "${ehome}" && return 0
                [[ $? == 8 ]] && eerror "${euser} is in use, cannot update home"
                eerror "There was an error when attempting to update the home directory for ${euser}"
                eerror "Please update it manually on your system:"
                eerror "\t pw usermod \"${euser}\" -d \"${ehome}\""
                ;;

        *)
                usermod -d "${ehome}" "${euser}" && return 0
                [[ $? == 8 ]] && eerror "${euser} is in use, cannot update home"
                eerror "There was an error when attempting to update the home directory for ${euser}"
                eerror "Please update it manually on your system (as root):"
                eerror "\t usermod -d \"${ehome}\" \"${euser}\""
                ;;
        esac
}

fi
1	axs	1.19	# Copyright 1999-2012 Gentoo Foundation
2	vapier	1.1	# Distributed under the terms of the GNU General Public License v2
3	axs	1.22	# $Header: /var/cvsroot/gentoo-x86/eclass/user.eclass,v 1.21 2012/06/22 18:57:33 axs Exp $
4	vapier	1.1
5			# @ECLASS: user.eclass
6			# @MAINTAINER:
7			# base-system@gentoo.org (Linux)
8			# Joe Jezak <josejx@gmail.com> (OS X)
9			# usata@gentoo.org (OS X)
10			# Aaron Walker <ka0ttic@gentoo.org> (FreeBSD)
11			# @BLURB: user management in ebuilds
12			# @DESCRIPTION:
13			# The user eclass contains a suite of functions that allow ebuilds
14			# to quickly make sure users in the installed system are sane.
15
16	vapier	1.18	if [[ ${___ECLASS_ONCE_USER} != "recur -_+^+_- spank" ]] ; then
17			___ECLASS_ONCE_USER="recur -_+^+_- spank"
18
19	vapier	1.2	# @FUNCTION: _assert_pkg_ebuild_phase
20			# @INTERNAL
21			# @USAGE: <calling func name>
22			_assert_pkg_ebuild_phase() {
23			case ${EBUILD_PHASE} in
24	vapier	1.11	setup\|preinst\|postinst) ;;
25			*)
26	vapier	1.15	eerror "'$1()' called from '${EBUILD_PHASE}' phase which is not OK:"
27			eerror "You may only call from pkg_{setup,preinst,postinst} functions."
28	vapier	1.2	eerror "Package fails at QA and at life. Please file a bug."
29	vapier	1.15	die "Bad package! $1 is only for use in some pkg_* functions!"
30	vapier	1.2	esac
31			}
32
33	vapier	1.1	# @FUNCTION: egetent
34			# @USAGE: <database> <key>
35			# @DESCRIPTION:
36			# Small wrapper for getent (Linux), nidump (< Mac OS X 10.5),
37			# dscl (Mac OS X 10.5), and pw (FreeBSD) used in enewuser()/enewgroup().
38	vapier	1.5	#
39			# Supported databases: group passwd
40	vapier	1.1	egetent() {
41	vapier	1.5	local db=$1 key=$2
42
43			[[ $# -ge 3 ]] && die "usage: egetent <database> <key>"
44
45			case ${db} in
46			passwd\|group) ;;
47			*) die "sorry, database '${db}' not yet supported; file a bug" ;;
48			esac
49
50	vapier	1.1	case ${CHOST} in
51			*-darwin[678])
52	vapier	1.5	case ${key} in
53	vapier	1.1	[!0-9]) # Non numeric
54	vapier	1.5	nidump ${db} . \| awk -F: "(\$1 ~ /^${key}\$/) {print;exit;}"
55	vapier	1.1	;;
56			*) # Numeric
57	vapier	1.5	nidump ${db} . \| awk -F: "(\$3 == ${key}) {print;exit;}"
58	vapier	1.1	;;
59			esac
60			;;
61			-darwin)
62	vapier	1.5	local mykey
63			case ${db} in
64			passwd) db="Users" mykey="UniqueID" ;;
65			group) db="Groups" mykey="PrimaryGroupID" ;;
66			esac
67
68			case ${key} in
69	vapier	1.1	[!0-9]) # Non numeric
70	vapier	1.5	dscl . -read /${db}/${key} 2>/dev/null \|grep RecordName
71	vapier	1.1	;;
72			*) # Numeric
73	vapier	1.5	dscl . -search /${db} ${mykey} ${key} 2>/dev/null
74	vapier	1.1	;;
75			esac
76			;;
77			-freebsd\|-dragonfly)
78	vapier	1.5	case ${db} in
79			passwd) db="user" ;;
80			*) ;;
81			esac
82	vapier	1.1
83			# lookup by uid/gid
84	vapier	1.5	local opts
85			if [[ ${key} == [[:digit:]]* ]] ; then
86	naota	1.10	[[ ${db} == "user" ]] && opts="-u" \|\| opts="-g"
87	vapier	1.1	fi
88
89	naota	1.10	pw show ${db} ${opts} "${key}" -q
90	vapier	1.1	;;
91			-netbsd\|-openbsd)
92	vapier	1.5	grep "${key}:\*:" /etc/${db}
93	vapier	1.1	;;
94			*)
95	vapier	1.3	# ignore output if nscd doesn't exist, or we're not running as root
96	vapier	1.5	nscd -i "${db}" 2>/dev/null
97			getent "${db}" "${key}"
98	vapier	1.1	;;
99			esac
100			}
101
102			# @FUNCTION: enewuser
103	vapier	1.9	# @USAGE: <user> [uid] [shell] [homedir] [groups]
104	vapier	1.1	# @DESCRIPTION:
105			# Same as enewgroup, you are not required to understand how to properly add
106			# a user to the system. The only required parameter is the username.
107			# Default uid is (pass -1 for this) next available, default shell is
108	vapier	1.9	# /bin/false, default homedir is /dev/null, and there are no default groups.
109	vapier	1.1	enewuser() {
110	vapier	1.15	_assert_pkg_ebuild_phase ${FUNCNAME}
111	vapier	1.1
112			# get the username
113			local euser=$1; shift
114			if [[ -z ${euser} ]] ; then
115			eerror "No username specified !"
116			die "Cannot call enewuser without a username"
117			fi
118
119			# lets see if the username already exists
120			if [[ -n $(egetent passwd "${euser}") ]] ; then
121			return 0
122			fi
123			einfo "Adding user '${euser}' to your system ..."
124
125			# options to pass to useradd
126	vapier	1.14	local opts=()
127	vapier	1.1
128			# handle uid
129			local euid=$1; shift
130			if [[ -n ${euid} && ${euid} != -1 ]] ; then
131			if [[ ${euid} -gt 0 ]] ; then
132			if [[ -n $(egetent passwd ${euid}) ]] ; then
133			euid="next"
134			fi
135			else
136			eerror "Userid given but is not greater than 0 !"
137			die "${euid} is not a valid UID"
138			fi
139			else
140			euid="next"
141			fi
142			if [[ ${euid} == "next" ]] ; then
143			for ((euid = 101; euid <= 999; euid++)); do
144			[[ -z $(egetent passwd ${euid}) ]] && break
145			done
146			fi
147	vapier	1.14	opts+=( -u ${euid} )
148	vapier	1.1	einfo " - Userid: ${euid}"
149
150			# handle shell
151			local eshell=$1; shift
152			if [[ ! -z ${eshell} ]] && [[ ${eshell} != "-1" ]] ; then
153			if [[ ! -e ${ROOT}${eshell} ]] ; then
154			eerror "A shell was specified but it does not exist !"
155			die "${eshell} does not exist in ${ROOT}"
156			fi
157			if [[ ${eshell} == /false \|\| ${eshell} == /nologin ]] ; then
158			eerror "Do not specify ${eshell} yourself, use -1"
159			die "Pass '-1' as the shell parameter"
160			fi
161			else
162	vapier	1.13	for eshell in /sbin/nologin /usr/sbin/nologin /bin/false /usr/bin/false /dev/null ; do
163			[[ -x ${ROOT}${eshell} ]] && break
164	vapier	1.1	done
165
166	vapier	1.13	if [[ ${eshell} == "/dev/null" ]] ; then
167	vapier	1.1	eerror "Unable to identify the shell to use, proceeding with userland default."
168			case ${USERLAND} in
169	vapier	1.13	GNU) eshell="/bin/false" ;;
170			BSD) eshell="/sbin/nologin" ;;
171			Darwin) eshell="/usr/sbin/nologin" ;;
172	vapier	1.1	*) die "Unable to identify the default shell for userland ${USERLAND}"
173			esac
174			fi
175			fi
176			einfo " - Shell: ${eshell}"
177	vapier	1.14	opts+=( -s "${eshell}" )
178	vapier	1.1
179			# handle homedir
180			local ehome=$1; shift
181			if [[ -z ${ehome} ]] \|\| [[ ${ehome} == "-1" ]] ; then
182			ehome="/dev/null"
183			fi
184			einfo " - Home: ${ehome}"
185	vapier	1.14	opts+=( -d "${ehome}" )
186	vapier	1.1
187			# handle groups
188			local egroups=$1; shift
189	vapier	1.16	local g egroups_arr
190			IFS="," read -r -a egroups_arr <<<"${egroups}"
191			shift
192			if [[ ${#egroups_arr[@]} -gt 0 ]] ; then
193			local defgroup exgroups
194			for g in "${egroups_arr[@]}" ; do
195	vapier	1.1	if [[ -z $(egetent group "${g}") ]] ; then
196			eerror "You must add group ${g} to the system first"
197			die "${g} is not a valid GID"
198			fi
199			if [[ -z ${defgroup} ]] ; then
200			defgroup=${g}
201			else
202	vapier	1.16	exgroups+=",${g}"
203	vapier	1.1	fi
204			done
205	vapier	1.14	opts+=( -g "${defgroup}" )
206	vapier	1.1	if [[ ! -z ${exgroups} ]] ; then
207	vapier	1.14	opts+=( -G "${exgroups:1}" )
208	vapier	1.1	fi
209			fi
210	vapier	1.16	einfo " - Groups: ${egroups:-(none)}"
211	vapier	1.1
212	vapier	1.9	# handle extra args
213			if [[ $# -gt 0 ]] ; then
214			die "extra arguments no longer supported; please file a bug"
215			else
216	vapier	1.14	local comment="added by portage for ${PN}"
217			opts+=( -c "${comment}" )
218			einfo " - GECOS: ${comment}"
219	vapier	1.9	fi
220
221			# add the user
222	vapier	1.1	case ${CHOST} in
223			-darwin)
224			### Make the user
225	vapier	1.14	dscl . create "/users/${euser}" uid ${euid}
226			dscl . create "/users/${euser}" shell "${eshell}"
227			dscl . create "/users/${euser}" home "${ehome}"
228			dscl . create "/users/${euser}" realname "added by portage for ${PN}"
229	vapier	1.9	### Add the user to the groups specified
230	vapier	1.16	for g in "${egroups_arr[@]}" ; do
231	vapier	1.14	dscl . merge "/groups/${g}" users "${euser}"
232	vapier	1.9	done
233	vapier	1.1	;;
234	vapier	1.9
235	vapier	1.1	-freebsd\|-dragonfly)
236	vapier	1.14	pw useradd "${euser}" "${opts[@]}" \|\| die
237	vapier	1.1	;;
238
239			-netbsd)
240	vapier	1.14	useradd "${opts[@]}" "${euser}" \|\| die
241	vapier	1.1	;;
242
243			-openbsd)
244	vapier	1.9	# all ops the same, except the -g vs -g/-G ...
245	vapier	1.14	useradd -u ${euid} -s "${eshell}" \
246			-d "${ehome}" -g "${egroups}" "${euser}" \|\| die
247	vapier	1.1	;;
248
249			*)
250	vapier	1.14	useradd -r "${opts[@]}" "${euser}" \|\| die
251	vapier	1.1	;;
252			esac
253
254			if [[ ! -e ${ROOT}/${ehome} ]] ; then
255			einfo " - Creating ${ehome} in ${ROOT}"
256			mkdir -p "${ROOT}/${ehome}"
257	vapier	1.14	chown "${euser}" "${ROOT}/${ehome}"
258	vapier	1.1	chmod 755 "${ROOT}/${ehome}"
259			fi
260			}
261
262			# @FUNCTION: enewgroup
263			# @USAGE: <group> [gid]
264			# @DESCRIPTION:
265			# This function does not require you to understand how to properly add a
266			# group to the system. Just give it a group name to add and enewgroup will
267			# do the rest. You may specify the gid for the group or allow the group to
268			# allocate the next available one.
269			enewgroup() {
270	vapier	1.15	_assert_pkg_ebuild_phase ${FUNCNAME}
271	vapier	1.1
272			# get the group
273	vapier	1.14	local egroup=$1; shift
274			if [[ -z ${egroup} ]] ; then
275	vapier	1.1	eerror "No group specified !"
276			die "Cannot call enewgroup without a group"
277			fi
278
279			# see if group already exists
280	vapier	1.14	if [[ -n $(egetent group "${egroup}") ]] ; then
281	vapier	1.1	return 0
282			fi
283			einfo "Adding group '${egroup}' to your system ..."
284
285			# handle gid
286	vapier	1.14	local egid=$1; shift
287			if [[ ! -z ${egid} ]] ; then
288			if [[ ${egid} -gt 0 ]] ; then
289			if [[ -n $(egetent group ${egid}) ]] ; then
290	vapier	1.1	egid="next available; requested gid taken"
291			fi
292			else
293			eerror "Groupid given but is not greater than 0 !"
294			die "${egid} is not a valid GID"
295			fi
296			else
297			egid="next available"
298			fi
299			einfo " - Groupid: ${egid}"
300
301			# handle extra
302	vapier	1.14	if [[ $# -gt 0 ]] ; then
303	vapier	1.9	die "extra arguments no longer supported; please file a bug"
304			fi
305	vapier	1.1
306	vapier	1.14	# Some targets need to find the next available GID manually
307			_enewgroup_next_gid() {
308			if [[ ${egid} == [!0-9] ]] ; then
309	vapier	1.17	# Non numeric
310	vapier	1.14	for ((egid = 101; egid <= 999; egid++)) ; do
311			[[ -z $(egetent group ${egid}) ]] && break
312			done
313			fi
314			}
315
316	vapier	1.1	# add the group
317			case ${CHOST} in
318			-darwin)
319	vapier	1.14	_enewgroup_next_gid
320			dscl . create "/groups/${egroup}" gid ${egid}
321			dscl . create "/groups/${egroup}" passwd '*'
322	vapier	1.1	;;
323
324			-freebsd\|-dragonfly)
325	vapier	1.14	_enewgroup_next_gid
326			pw groupadd "${egroup}" -g ${egid} \|\| die
327	vapier	1.1	;;
328
329			-netbsd)
330	vapier	1.14	_enewgroup_next_gid
331			groupadd -g ${egid} "${egroup}" \|\| die
332	vapier	1.1	;;
333
334			*)
335	vapier	1.14	local opts
336			if [[ ${egid} == [!0-9] ]] ; then
337	vapier	1.17	# Non numeric; let groupadd figure out a GID for us
338	vapier	1.14	opts=""
339			else
340			opts="-g ${egid}"
341			fi
342	vapier	1.1	# We specify -r so that we get a GID in the system range from login.defs
343	vapier	1.14	groupadd -r ${opts} "${egroup}" \|\| die
344	vapier	1.1	;;
345			esac
346			}
347	vapier	1.6
348			# @FUNCTION: egethome
349			# @USAGE: <user>
350			# @DESCRIPTION:
351			# Gets the home directory for the specified user.
352			egethome() {
353			local pos
354
355	vapier	1.7	[[ $# -eq 1 ]] \|\| die "usage: egethome <user>"
356
357	vapier	1.6	case ${CHOST} in
358			-darwin\|-freebsd\|-dragonfly)
359			pos=9
360			;;
361			*) # Linux, NetBSD, OpenBSD, etc...
362			pos=6
363			;;
364			esac
365
366	vapier	1.14	egetent passwd "$1" \| cut -d: -f${pos}
367	vapier	1.6	}
368	vapier	1.8
369			# @FUNCTION: egetshell
370			# @USAGE: <user>
371			# @DESCRIPTION:
372			# Gets the shell for the specified user.
373			egetshell() {
374			local pos
375
376			[[ $# -eq 1 ]] \|\| die "usage: egetshell <user>"
377
378			case ${CHOST} in
379			-darwin\|-freebsd\|-dragonfly)
380			pos=10
381			;;
382			*) # Linux, NetBSD, OpenBSD, etc...
383			pos=7
384			;;
385			esac
386
387			egetent passwd "$1" \| cut -d: -f${pos}
388			}
389	vapier	1.18
390	axs	1.19	# @FUNCTION: esethome
391			# @USAGE: <user> <homedir>
392			# @DESCRIPTION:
393			# Update the home directory in a platform-agnostic way.
394			# Required parameters is the username and the new home directory.
395			# Specify -1 if you want to set home to the enewuser default
396			# of /dev/null.
397			# If the new home directory does not exist, it is created.
398			# Any previously existing home directory is NOT moved.
399			esethome() {
400			_assert_pkg_ebuild_phase ${FUNCNAME}
401
402			# get the username
403			local euser=$1; shift
404			if [[ -z ${euser} ]] ; then
405			eerror "No username specified !"
406			die "Cannot call esethome without a username"
407			fi
408
409			# lets see if the username already exists
410			if [[ -z $(egetent passwd "${euser}") ]] ; then
411			ewarn "User does not exist, cannot set home dir -- skipping."
412			return 1
413			fi
414
415			# handle homedir
416			local ehome=$1; shift
417			if [[ -z ${ehome} ]] ; then
418			eerror "No home directory specified !"
419			die "Cannot call esethome without a home directory or '-1'"
420			fi
421
422			if [[ ${ehome} == "-1" ]] ; then
423			ehome="/dev/null"
424			fi
425	axs	1.22
426			# exit with no message if home dir is up to date
427			if [[ $(egethome "${euser}") == ${ehome} ]]; then
428			return 0
429			fi
430
431			einfo "Updating home for user '${euser}' ..."
432	axs	1.19	einfo " - Home: ${ehome}"
433
434	axs	1.20	# ensure home directory exists, otherwise update will fail
435			if [[ ! -e ${ROOT}/${ehome} ]] ; then
436			einfo " - Creating ${ehome} in ${ROOT}"
437			mkdir -p "${ROOT}/${ehome}"
438			chown "${euser}" "${ROOT}/${ehome}"
439			chmod 755 "${ROOT}/${ehome}"
440			fi
441
442	axs	1.19	# update the home directory
443			case ${CHOST} in
444			-darwin)
445			dscl . change "/users/${euser}" home "${ehome}"
446			;;
447
448			-freebsd\|-dragonfly)
449	axs	1.21	pw usermod "${euser}" -d "${ehome}" && return 0
450			[[ $? == 8 ]] && eerror "${euser} is in use, cannot update home"
451			eerror "There was an error when attempting to update the home directory for ${euser}"
452			eerror "Please update it manually on your system:"
453			eerror "\t pw usermod \"${euser}\" -d \"${ehome}\""
454	axs	1.19	;;
455
456			*)
457	axs	1.21	usermod -d "${ehome}" "${euser}" && return 0
458			[[ $? == 8 ]] && eerror "${euser} is in use, cannot update home"
459			eerror "There was an error when attempting to update the home directory for ${euser}"
460			eerror "Please update it manually on your system (as root):"
461			eerror "\t usermod -d \"${ehome}\" \"${euser}\""
462	axs	1.19	;;
463			esac
464			}
465
466	vapier	1.18	fi