Zarafa create user script for the DB plugin

From Zarafa wiki

Latest revision as of 12:10, 14 February 2011

Article information
Applies to:
Zarafa Version(s)	6.40.x
OS version(s)	Any recent Linux version
Tested on	Ubuntu 10.04.1

This is a script that can be used to create users in a more friendly way for people who are new to Linux or have trouble remembering the various zarafa-admin variables.

The script will ask what values you want to give to a user, like:

• User name
• Password
• full name
• email address
• administrator or not
• and if the user is non-active or active.

Also when a non-active user is created the resource attributes will be asked. (auto accept meeting request and declining recurring and/or conflicting).

To use the script, copy paste the text below into a new file, give the file executable rights (chmod +x). Then, run it as root (Zarafa-server needs to be running).

Feel free to improve the script (there are still some TODO's in there!).

The script:

#!/usr/bin/env bash

# Script to create a user in Zarafa with the DB user plugin.
# Version (date / time): 20110114-13:00
#
# WARNING: DO NOT use this script when using the UNIX, LDAP or
# Active Directory plugin!

# Check if the user is root (required to run the zarafa-admin tool).
if [ $USER != 'root' ]
then
echo
echo "You need root privileges to run this script. Exiting."
exit 0
fi

echo 'This script will help you creating a new Zarafa user.'
echo 'DISCLAIMER: This script is only suitable for use with the DB plugin.'
echo ' '
echo 'Creating a new Zarafa user. Please enter the details of the user.'

#The user name. Input needed is the user name.
echo
while [ -z $username ] ;do 
	echo -n 'User name of the new user: '
	read username
done

#
# TODO: create check if username is valid (doesn't exist, has valid characters etc.). 
# If valid, continue. If not valid, provide relevant feedback and return to previous step.
#

#The password.
while [ -z $password ] ;do
       	echo -n 'Password (will not be visible on input): '
	read -s password
	echo ' '
done

#
# TODO: create check if password is valid (meets security policies etc.). 
# If valid, continue. If not valid, provide relevant feedback and return to previous step.
#


#The full name. No " "  needed for full names with spaces
while [ -z "$full" ] ;do
        echo -n 'Full name of the new user (without quotes, can have spaces): '
        read full
done

#The email address. 
while [ -z $email ] ;do
	echo -n 'Email address of the new user: '
	read email
done

#
# TODO: create check if email address is valid (doesn't exist, has valid format etc.). 
# If valid, continue. If not valid, provide relevant feedback and return to previous step.
#

#The admin attribute 1 for admin or 0 for no admin role. 2 can also be given, this will make the user a system admin.
while [ -z $admin ] ;do
	echo 'Should the user have administrator rights?'
	echo 'Enter 1 for yes, 0 for no (The default is no): '
	read admin
	admin="${admin:-0}"
done

#The non-active attribute for non-active users (resources) 
while [ -z $non ] ;do
	echo 'Should the non active bit be set for this user? This is common for resources.'
	echo 'Enter 1 for yes, 0 for no (The default is no): '
	read non
	non="${non:-0}"
done

#
# TODO: create option to add the user to extra groups, besides 'Everyone'. 
# If answer is no, continue. If answer is yes, display (a numbered list of?) currently available groups.
# To select a group, input it's number. After hitting enter, display the list of groups the user is now in, and the list of remaining groups.
# This 'loop' can be continued until user has been added to all desired groups.
# Also provide option to create a new group if the desired group is not in the list.
# When done, provide a way to exit the loop and continue
#

#
# TODO: create option to add quotas (warn / soft / hard quotas and override sytem quota, if set) to user. 
# 

#
# TODO: create option to set user's visibility in address book. 
# 


#The zarafa-admin command to create the user with the input given by the user.
echo 'Creating user... '
zarafa-admin -c "$username" -p "$password" -f "$full" -e "$email" -a "$admin" -n "'$non"

#
# TODO: create check if zarafa-admin exited successfully. 
# If yes, continue. If no, provide relevant feedback and exit.
#

# Here we add the resource attributes if the user is non-active.
if [ $non == "1" -o $non == "1" ]; then
  echo  'This user is non active. Please set the resource attributes as well.'
  echo  'Would you like to use this resource as a bookable room? Yes/No: '
  read accept

# If the resource is set to auto accept you might want to set these options aswell.
   if [ $accept == "yes" ]; then
     echo -n 'Would you like to make the resource decline recurring appointments? Yes/No: '
     read recurring
     echo -n 'Would you like to make the resource decline conflicting appointments? Yes/No: '
     read conflict
     zarafa-admin -u "$username" --mr-accept "$accept" --mr-decline-conflict "$conflict" --mr-decline-recurring "$recurring" 

  fi
  echo "Done."

fi


#Show the details of the newly created user
echo 'User created with the following details:'
zarafa-admin --details "$username"

#
# TODO: create option to restart the script if another user should be created.
#

exit;