]> gitweb.michael.orlitzky.com - mjo-overlay.git/blobdiff - eclass/sys-user.eclass
sys-user.eclass: drop LICENSE and use the GLEP as HOMEPAGE.
[mjo-overlay.git] / eclass / sys-user.eclass
index 92c782974da8897a2a347ba3b0ceb325d56fd465..bf2f7a7a61419c8ab104e842762157d7742bd1b1 100644 (file)
@@ -9,14 +9,13 @@
 # This eclass does most of the work for the sys-user/ packages that
 # supply system user accounts.
 
-# Needed for egetshell and egethome
+# Needed for egetshell and egethome.
 inherit user
 
 EXPORT_FUNCTIONS pkg_pretend src_unpack src_configure src_compile src_install src_test pkg_preinst pkg_postinst pkg_prerm
 
-: ${HOMEPAGE:="https://www.gentoo.org/"}
+: ${HOMEPAGE:="https://wiki.gentoo.org/wiki/User:Mjo/GLEP:User_packages"}
 : ${DESCRIPTION:="The ${PN} system user"}
-: ${LICENSE:="GPL-2"}
 
 # If you want a different username, use a different package name. This
 # prevents different people from claiming the same username.
@@ -32,8 +31,11 @@ SYS_USER_NAME="${PN}"
 # @ECLASS-VARIABLE: SYS_USER_UID
 # @REQUIRED
 # @DESCRIPTION:
-# etc.
-
+# This should be set to the "fixed" UID that your user should have.
+# We may have to fall back to an arbitrary UID, but you still need
+# to specify a real, valid UID here. At the very least because our
+# SLOT variable needs it.
+[[ -z "${SYS_USER_UID}" ]] && die "SYS_USER_UID must be set"
 
 # @ECLASS-VARIABLE: SYS_USER_UID_IMPORTANT
 # @REQUIRED
@@ -77,13 +79,19 @@ sys-user_src_compile() { :; }
 sys-user_src_test() { :; }
 
 sys-user_getuid() {
-       [[ $# -eq 1 ]] || die "usage: sys-user_getuid <username>"
-
        # Output the real UID of the given user, or the empty string if the
        # user does not exist on the system.
+       [[ $# -eq 1 ]] || die "usage: sys-user_getuid <username>"
        echo $(id --real --user "${1}")
 }
 
+sys-user_getname() {
+       # Output the username associated with the given UID, or the empty string
+       # if the given UID is still available.
+       [[ $# -eq 1 ]] || die "usage: sys-user_getname <uid>"
+       echo $(egetent passwd "${1}" | cut -f1 -d':')
+}
+
 sys-user_create() {
        # Create the user whose information is contained in the following
        # variables:
@@ -105,22 +113,30 @@ sys-user_create() {
 }
 
 
+sys-user_modify() {
+       # Modify the existing user named $SYS_USER_NAME to match the values
+       # contained in the following variables:
+       #
+       #  * SYS_USER_UID
+       #  * SYS_USER_SHELL
+       #  * SYS_USER_HOME
+       #  * SYS_USER_GROUPS
+       #
+       usermod ${SYS_USER_UID:+--uid }"${SYS_USER_UID}" \
+                       ${SYS_USER_GROUPS:+--append --groups }"${SYS_USER_GROUPS}" \
+                       --shell "${SYS_USER_SHELL}" \
+                       --home-dir "${SYS_USER_HOME}" \
+                       "${SYS_USER_NAME}"
+}
+
 sys-user_pkg_pretend() {
        # Sanity checks that would otherwise run code in global scope.
-       #
-       # First ensure that the user didn't say his UID is important and
-       # then fail to specify one.
-       if [[ -z "${SYS_USER_UID}" ]] &&
-                  [[ "${SYS_USER_UID_IMPORTANT}" == "true" ]]; then
-               # Don't make no damn sense.
-               die "arbitrary UID requested with SYS_USER_UID_IMPORTANT=true"
-       fi
 
        # Next ensure that no other username owns an important UID.
        if [[ "${SYS_USER_UID_IMPORTANT}" == "true" ]]; then
                # Ok, the UID is important. Make sure nobody else has it. Or
                # rather, nobody else *with a different username* has it.
-               local oldname=$(egetent passwd "${SYS_USER_UID}" | cut -f1 -d':')
+               local oldname=$(sys-user_getname "${SYS_USER_UID}")
                if [[ "${SYS_USER_NAME}" != "${oldname}" ]]; then
                        die "important UID ${SYS_USER_UID} already belongs to ${oldname}"
                fi
@@ -162,6 +178,14 @@ sys-user_src_configure() {
                fi
        fi
 
+       local current_name=$(sys-user_getname "${SYS_USER_UID}")
+       if [[ "${current_name}" != "${SYS_USER_NAME}" ]]; then
+               # This UID is already taken by another user, but this
+               # specific UID was not important (we checked in
+               # pkg_pretend), so fall back to an arbitrary one.
+               unset SYS_USER_UID
+       fi
+
        # The "useradd" and "usermod" tools expect a comma-separated list,
        # so change our spaces to commas. Having duplicates in the list is
        # not a problem for those two tools.
@@ -176,13 +200,21 @@ sys-user_src_install() {
        # be possible.
        #
        # Beware, this only works if SYS_USER_UID is guaranteed to have a
-       # real UID and not, for example, -1.
+       # real UID and not be e.g. the empty string.
        #
-       # TODO: this is a problem now!
+       # Our sys-user_create() function makes sure to set SYS_USER_UID to
+       # something useful, and the only place that sys-user_create() is
+       # called from is sys-user_pkg_preinst(), which takes place before
+       # this sys-user_src_install().
        #
-       #touch "${T}/${SYS_USER_UID}" || die
-       #insinto "/var/lib/sys-user"
-       #doins "${T}/${SYS_USER_UID}"
+       # The other way that SYS_USER_UID could be empty is during an
+       # upgrade; however, if you're doing an upgrade and the new UID isn't
+       # important, then you'll get the same old UID that exists on the
+       # system from the old package. That old UID is assigned to SYS_USER_UID
+       # in sys-user_src_configure(), so that case is handled too.
+       touch "${T}/${SYS_USER_UID}" || die
+       insinto "/var/lib/sys-user"
+       doins "${T}/${SYS_USER_UID}"
 }
 
 sys-user_pkg_preinst() {
@@ -226,8 +258,9 @@ sys-user_pkg_preinst() {
                fi
 
                # The user already exists, so all we have left to do is to try
-               # to append SYS_USER_GROUPS to the existing groups.
-               usermod --append --groups "${SYS_USER_GROUPS}" \
+               # to append SYS_USER_GROUPS to the existing groups. The home
+               # dir, shell, and uid should all match already.
+               sys-user_modify \
                        || die "failed to append groups to existing user ${SYS_USER_NAME}"
        fi
 }
@@ -243,7 +276,7 @@ sys-user_pkg_postinst() {
           if [[ -n $(sys-user_getuid "${SYS_USER_NAME}") ]]; then
                   die "User ${SYS_USER_NAME} already exists during an upgrade."
           else
-                  sys-user_create || die "failed to add user ${SYS_USER_NAME}"
+                  sys-user_modify || die "failed to add user ${SYS_USER_NAME}"
           fi
        fi
 }
@@ -252,9 +285,15 @@ sys-user_pkg_prerm() {
        if [[ -z $(sys-user_getuid "${SYS_USER_NAME}") ]]; then
                # We have successfully done nothing.
                ewarn "Tried to remove nonexistent user ${SYS_USER_NAME}."
-       else
+       elif [[ -z "${REPLACING_VERSIONS}" ]]; then
+               # The user to remove exists, and this is not an upgrade, so
+               # we really do remove him.
                userdel "${SYS_USER_NAME}" || \
                        die "failed to remove user ${SYS_USER_NAME}"
                einfo "Removed user ${SYS_USER_NAME} from the system."
+
+               # The missing case: if the user exista and this is an upgrade,
+               # we leave the user alone to be modified in
+               # sys-user_pkg_postinst().
        fi
 }