useradd.bbclass: add a new base class and code refactor

Add a new base class, useradd_base.bbclass, which is mainly a
collection of basic functions for user/group settings.

The useradd_base.bbclass is intended to be inherited by useradd.bbclass
and the extrausers.bbclass to avoid code cuplication.

[YOCTO #4074]

(From OE-Core rev: 2a57bb7e9a7e154578aa7cb9aeebdf398a54ec00)

Signed-off-by: Chen Qi <Qi.Chen@windriver.com>
Signed-off-by: Saul Wold <sgw@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

1 files changed, 230 insertions, 0 deletions

diff --git a/meta/classes/useradd_base.bbclass b/meta/classes/useradd_base.bbclass
new file mode 100644
index 0000000000..7aafe29a4a
--- /dev/null
+++ b/meta/classes/useradd_base.bbclass
@@ -0,0 +1,230 @@
+# This bbclass provides basic functionality for user/group settings.
+# This bbclass is intended to be inherited by useradd.bbclass and
+# extrausers.bbclass.
+
+# The following functions basically have similar logic.
+# *) Perform necessary checks before invoking the actual command
+# *) Invoke the actual command, make retries if necessary
+# *) Error out if an error occurs.
+
+# Note that before invoking these functions, make sure the global variable
+# PSEUDO is set up correctly.
+
+perform_groupadd () {
+        local rootdir="$1"
+        local opts="$2"
+        local retries="$3"
+        bbnote "Performing groupadd with [$opts] and $retries times of retry"
+        local groupname=`echo "$opts" | awk '{ print $NF }'`
+        local group_exists="`grep "^$groupname:" $rootdir/etc/group || true`"
+        if test "x$group_exists" = "x"; then
+                local count=0
+                while true; do
+                        eval $PSEUDO groupadd $opts || true
+                        group_exists="`grep "^$groupname:" $rootdir/etc/group || true`"
+                        if test "x$group_exists" = "x"; then
+                                bbwarn "groupadd command did not succeed. Retrying..."
+                                sleep 1
+                        else
+                                break
+                        fi
+                        count=`expr $count + 1`
+                        if test $count = $retries; then
+                                bbfatal "Tried running groupadd command $retries times without scucess, giving up"
+                        fi
+                done
+        else
+                bbwarn "group $groupname already exists, not re-creating it"
+        fi
+}
+
+perform_useradd () {
+        local rootdir="$1"
+        local opts="$2"
+        local retries="$3"
+        bbnote "Performing useradd with [$opts] and $retries times of retry"
+        local username=`echo "$opts" | awk '{ print $NF }'`
+        local user_exists="`grep "^$username:" $rootdir/etc/passwd || true`"
+        if test "x$user_exists" = "x"; then
+               local count=0
+               while true; do
+                       eval $PSEUDO useradd $opts || true
+                       user_exists="`grep "^$username:" $rootdir/etc/passwd || true`"
+                       if test "x$user_exists" = "x"; then
+                               bbwarn "useradd command did not succeed. Retrying..."
+                               sleep 1
+                       else
+                               break
+                       fi
+                       count=`expr $count + 1`
+                       if test $count = $retries; then
+                                bbfatal "Tried running useradd command $retries times without scucess, giving up"
+                       fi
+               done
+        else
+                bbwarn "user $username already exists, not re-creating it"
+        fi
+}
+
+perform_groupmems () {
+        local rootdir="$1"
+        local opts="$2"
+        local retries="$3"
+        bbnote "Performing groupmems with [$opts] and $retries times of retry"
+        local groupname=`echo "$opts" | awk '{ for (i = 1; i < NF; i++) if ($i == "-g" || $i == "--group") print $(i+1) }'`
+        local username=`echo "$opts" | awk '{ for (i = 1; i < NF; i++) if ($i == "-a" || $i == "--add") print $(i+1) }'`
+        bbnote "Running groupmems command with group $groupname and user $username"
+        # groupmems fails if /etc/gshadow does not exist
+        local gshadow=""
+        if [ -f $rootdir${sysconfdir}/gshadow ]; then
+                gshadow="yes"
+        else
+                gshadow="no"
+                touch $rootdir${sysconfdir}/gshadow
+        fi
+        local mem_exists="`grep "^$groupname:[^:]*:[^:]*:\([^,]*,\)*$username\(,[^,]*\)*" $rootdir/etc/group || true`"
+        if test "x$mem_exists" = "x"; then
+                local count=0
+                while true; do
+                        eval $PSEUDO groupmems $opts || true
+                        mem_exists="`grep "^$groupname:[^:]*:[^:]*:\([^,]*,\)*$username\(,[^,]*\)*" $rootdir/etc/group || true`"
+                        if test "x$mem_exists" = "x"; then
+                                bbwarn "groupmems command did not succeed. Retrying..."
+                                sleep 1
+                        else
+                                break
+                        fi
+                        count=`expr $count + 1`
+                        if test $count = $retries; then
+                                if test "x$gshadow" = "xno"; then
+                                        rm -f $rootdir${sysconfdir}/gshadow
+                                        rm -f $rootdir${sysconfdir}/gshadow-
+                                fi
+                                bbfatal "Tried running groupmems command $retries times without scucess, giving up"
+                        fi
+                done
+        else
+                bbwarn "group $groupname already contains $username, not re-adding it"
+        fi
+        if test "x$gshadow" = "xno"; then
+                rm -f $rootdir${sysconfdir}/gshadow
+                rm -f $rootdir${sysconfdir}/gshadow-
+        fi
+}
+
+perform_groupdel () {
+        local rootdir="$1"
+        local opts="$2"
+        local retries="$3"
+        bbnote "Performing groupdel with [$opts] and $retries times of retry"
+        local groupname=`echo "$opts" | awk '{ print $NF }'`
+        local group_exists="`grep "^$groupname:" $rootdir/etc/group || true`"
+        if test "x$group_exists" != "x"; then
+                local count=0
+                while true; do
+                        eval $PSEUDO groupdel $opts || true
+                        group_exists="`grep "^$groupname:" $rootdir/etc/group || true`"
+                        if test "x$group_exists" != "x"; then
+                                bbwarn "groupdel command did not succeed. Retrying..."
+                                sleep 1
+                        else
+                                break
+                        fi
+                        count=`expr $count + 1`
+                        if test $count = $retries; then
+                                bbfatal "Tried running groupdel command $retries times without scucess, giving up"
+                        fi
+                done
+        else
+                bbwarn "group $groupname doesn't exist, not removing it"
+        fi
+}
+
+perform_userdel () {
+        local rootdir="$1"
+        local opts="$2"
+        local retries="$3"
+        bbnote "Performing userdel with [$opts] and $retries times of retry"
+        local username=`echo "$opts" | awk '{ print $NF }'`
+        local user_exists="`grep "^$username:" $rootdir/etc/passwd || true`"
+        if test "x$user_exists" != "x"; then
+               local count=0
+               while true; do
+                       eval $PSEUDO userdel $opts || true
+                       user_exists="`grep "^$username:" $rootdir/etc/passwd || true`"
+                       if test "x$user_exists" != "x"; then
+                               bbwarn "userdel command did not succeed. Retrying..."
+                               sleep 1
+                       else
+                               break
+                       fi
+                       count=`expr $count + 1`
+                       if test $count = $retries; then
+                                bbfatal "Tried running userdel command $retries times without scucess, giving up"
+                       fi
+               done
+        else
+                bbwarn "user $username doesn't exist, not removing it"
+        fi
+}
+
+perform_groupmod () {
+        # Other than the return value of groupmod, there's no simple way to judge whether the command
+        # succeeds, so we disable -e option temporarily
+        set +e
+        local rootdir="$1"
+        local opts="$2"
+        local retries="$3"
+        bbnote "Performing groupmod with [$opts] and $retries times of retry"
+        local groupname=`echo "$opts" | awk '{ print $NF }'`
+        local group_exists="`grep "^$groupname:" $rootdir/etc/group || true`"
+        if test "x$group_exists" != "x"; then
+                local count=0
+                while true; do
+                        eval $PSEUDO groupmod $opts
+                        if test $? != 0; then
+                                bbwarn "groupmod command did not succeed. Retrying..."
+                                sleep 1
+                        else
+                                break
+                        fi
+                        count=`expr $count + 1`
+                        if test $count = $retries; then
+                                bbfatal "Tried running groupmod command $retries times without scucess, giving up"
+                        fi
+                done
+        else
+                bbwarn "group $groupname doesn't exist, unable to modify it"
+        fi
+        set -e
+}
+
+perform_usermod () {
+        # Same reason with groupmod, temporarily disable -e option
+        set +e
+        local rootdir="$1"
+        local opts="$2"
+        local retries="$3"
+        bbnote "Performing usermod with [$opts] and $retries times of retry"
+        local username=`echo "$opts" | awk '{ print $NF }'`
+        local user_exists="`grep "^$username:" $rootdir/etc/passwd || true`"
+        if test "x$user_exists" != "x"; then
+               local count=0
+               while true; do
+                       eval $PSEUDO usermod $opts
+                       if test $? != 0; then
+                               bbwarn "usermod command did not succeed. Retrying..."
+                               sleep 1
+                       else
+                               break
+                       fi
+                       count=`expr $count + 1`
+                       if test $count = $retries; then
+                                bbfatal "Tried running usermod command $retries times without scucess, giving up"
+                       fi
+               done
+        else
+                bbwarn "user $username doesn't exist, unable to modify it"
+        fi
+        set -e
+}