Merge remote-tracking branch 'kc/new/awaiting_qa/bug_6316' into kcmaster
[koha_fer] / debian / scripts / koha-create
1 #!/bin/sh
2 #
3 # koha-create -- Create a new Koha instance.
4 # Copyright 2010  Catalyst IT, Ltd
5
6 # This program is free software: you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation, either version 3 of the License, or
9 # (at your option) any later version.
10
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 # GNU General Public License for more details.
15
16 # You should have received a copy of the GNU General Public License
17 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
18
19
20 set -e
21
22 usage="Usage: $0 [--create-db|--request-db|--populate-db] \
23     [--marcflavor marc21|normarc|unimarc] \
24     [--zebralang en|nb|fr] \
25     [--defaultsql /path/to/some.sql] \
26     [--configfile /path/to/config] instancename"
27
28 die() {
29     echo "$@" 1>&2
30     exit 1
31 }
32
33 generate_config_file() {
34     touch "$2"
35     chown "root:$username" "$2"
36     chmod 0640 "$2"
37     sed -e "s/__KOHASITE__/$name/g" \
38         -e "s/__OPACPORT__/80/g" \
39         -e "s/__INTRAPORT__/$INTRAPORT/g" \
40         -e "s/__OPACSERVER__/$domain/g" \
41         -e "s/__INTRASERVER__/$intradomain/g" \
42         -e "s/__ZEBRA_PASS__/$zebrapwd/g" \
43         -e "s/__ZEBRA_MARC_FORMAT__/$ZEBRA_MARC_FORMAT/g" \
44         -e "s/__ZEBRA_LANGUAGE__/$ZEBRA_LANGUAGE/g" \
45         -e "s/__DB_NAME__/$mysqldb/g" \
46         -e "s/__DB_HOST__/$mysqlhost/g" \
47         -e "s/__DB_USER__/$mysqluser/g" \
48         -e "s/__DB_PASS__/$mysqlpwd/g" \
49         -e "s/__UNIXUSER__/$username/g" \
50         -e "s/__UNIXGROUP__/$username/g" \
51         "/etc/koha/$1" > "$2"
52 }
53
54 getmysqlhost() {
55     awk '
56         /^\[/ { inclient = 0 }
57         /^\[client\]/ { inclient = 1 }
58         inclient && /^ *host *=/ { print $3 }' \
59         /etc/mysql/koha-common.cnf
60 }
61
62 getinstancemysqlpassword() {
63     sed -n '/<pass>/s:.*>\(.*\)</pass>.*:\1:p' \
64         "/etc/koha/sites/$1/koha-conf.xml"
65 }
66
67 # Set defaults and read config file, if it exists.
68 DOMAIN=""
69 INTRAPORT="8080"
70 INTRAPREFIX=""
71 INTRASUFFIX=""
72 DEFAULTSQL=""
73 ZEBRA_MARC_FORMAT="marc21"
74 ZEBRA_LANGUAGE="en"
75 if [ -e /etc/koha/koha-sites.conf ]
76 then
77     . /etc/koha/koha-sites.conf
78 fi
79
80 [ $# -ge 2 ] && [ $# -le 10 ] || die $usage
81
82 TEMP=`getopt -o crpm:l:d:f: -l create-db,request-db,populate-db,marcflavor:,zebralang:,defaultsql:,configfile: \
83      -n "$0" -- "$@"`
84
85 # Note the quotes around `$TEMP': they are essential!
86 eval set -- "$TEMP"
87
88 # Temporary variables for the command line options
89 CLO_ZEBRA_MARC_FORMAT=""
90 CLO_ZEBRA_LANGUAGE=""
91 CLO_DEFAULTSQL=""
92
93 while true ; do
94         case "$1" in
95                 -c|--create-db) op=create ; shift ;;
96                 -r|--request-db) op=request ; shift ;;
97                 -p|--populate-db) op=populate ; shift ;;
98                 -m|--marcflavor) CLO_ZEBRA_MARC_FORMAT="$2" ; shift 2 ;;
99                 -l|--zebralang) CLO_ZEBRA_LANGUAGE="$2" ; shift 2 ;;
100                 -d|--defaultsql) CLO_DEFAULTSQL="$2" ; shift 2 ;;
101                 -f|--configfile) configfile="$2" ; shift 2 ;;
102                 --) shift ; break ;;
103                 *) die "Internal error processing command line arguments" ;;
104         esac
105 done
106
107 # Load the configfile given on the command line
108 if [ -e "$configfile" ]
109 then
110     . "$configfile"
111 else
112     die "$configfile does not exist.";
113 fi
114
115 # Make sure options from the command line get the highest precedence
116 if [ "$CLO_ZEBRA_MARC_FORMAT" != "" ]
117 then
118     ZEBRA_MARC_FORMAT="$CLO_ZEBRA_MARC_FORMAT"
119 fi
120 if [ "$CLO_ZEBRA_LANGUAGE" != "" ]
121 then
122     ZEBRA_LANGUAGE="$CLO_ZEBRA_LANGUAGE"
123 fi
124 if [ "$CLO_DEFAULTSQL" != "" ]
125 then
126     DEFAULTSQL="$CLO_DEFAULTSQL"
127 fi
128
129 name="$1"
130
131 domain="$name$DOMAIN"
132 if [ "$INTRAPORT" = 80 ] || [ "$INTRAPORT" = "" ]
133 then
134     intradomain="$INTRAPREFIX$name$INTRASUFFIX$DOMAIN"
135 else
136     intradomain="$INTRAPREFIX$name$INTRASUFFIX$DOMAIN:$INTRAPORT"
137 fi
138
139
140 mysqldb="koha_$name"
141 mysqlhost="$(getmysqlhost)"
142 mysqluser="koha_$name"
143
144 if [ "$op" = create ] || [ "$op" = request ]
145 then
146     mysqlpwd="$(pwgen -1)"
147 else
148     mysqlpwd="$(getinstancemysqlpassword $name)"
149 fi
150
151
152 if [ "$op" = create ] || [ "$op" = request ]
153 then
154     # Create new user and group.
155     username="$name-koha"
156     if getent passwd "$username" > /dev/null
157     then
158         die "User $username already exists."
159     fi
160     if getent group "$username" > /dev/null
161     then
162         die "Group $username already exists."
163     fi
164     adduser --no-create-home --disabled-login \
165         --gecos "Koha instance $username" \
166         --home "/var/lib/koha/$name" \
167         --quiet "$username"
168
169     # Create the site-specific directories.
170     koha-create-dirs "$name"
171
172     # Generate Zebra database password.
173     zebrapwd="$(pwgen -1)"
174     # Set up MySQL database for this instance.
175     if [ "$op" = create ]
176     then
177         mysql --defaults-extra-file=/etc/mysql/koha-common.cnf <<eof
178 CREATE DATABASE \`$mysqldb\`;
179 CREATE USER \`$mysqluser\`@'%' IDENTIFIED BY '$mysqlpwd';
180 GRANT ALL PRIVILEGES ON \`$mysqldb\`.* TO \`$mysqluser\`;
181 FLUSH PRIVILEGES;
182 eof
183     fi
184
185     # Generate and install Apache site-available file and log dir.
186     generate_config_file apache-site.conf.in \
187         "/etc/apache2/sites-available/$name"
188     mkdir "/var/log/koha/$name"
189     chown "$username:$username" "/var/log/koha/$name"
190
191
192     # Generate and install main Koha config file.
193     generate_config_file koha-conf-site.xml.in \
194         "/etc/koha/sites/$name/koha-conf.xml"
195
196     # Generate and install Zebra config files.
197     generate_config_file zebra-biblios-site.cfg.in \
198         "/etc/koha/sites/$name/zebra-biblios.cfg"
199     generate_config_file zebra-authorities-site.cfg.in \
200         "/etc/koha/sites/$name/zebra-authorities.cfg"
201     generate_config_file zebra-authorities-dom-site.cfg.in \
202         "/etc/koha/sites/$name/zebra-authorities-dom.cfg"
203     generate_config_file zebra.passwd.in \
204         "/etc/koha/sites/$name/zebra.passwd"
205
206
207     # Create a GPG-encrypted file for requesting a DB to be set up.
208     if [ "$op" = request ]
209     then
210         touch "$name-db-request.txt"
211         chmod 0600 "$name-db-request.txt"
212         cat > "$name-db-request.txt" << eof
213 Please create a MySQL database and user on $mysqlhost as follows:
214
215 database name: $mysqldb
216 database user: $mysqluser
217      password: $mysqlpwd
218
219 Thank you.
220 eof
221
222         echo "See $name-db-request.txt for database creation request."
223         echo "Please forward it to the right person, and then run"
224         echo "$0 --populate-db $name"
225         echo "Thanks."
226     fi
227 fi
228
229
230 if [ "$op" = create ] || [ "$op" = populate ]
231 then
232     # Use the default database content if that exists.
233     if [ -e "$DEFAULTSQL" ]
234     then
235         # Populate the database with default content.
236         zcat "$DEFAULTSQL" |
237         sed "s/__KOHASITE__/$name/g" |
238         mysql --host="$mysqlhost" --user="$mysqluser" --password="$mysqlpwd"
239
240
241         # Change the default user's password.
242         staffpass="$(pwgen -1)"
243         staffdigest=$(echo -n "$staffpass" |
244                       perl -e '
245                             use Digest::MD5 qw(md5_base64); 
246                             while (<>) { print md5_base64($_), "\n"; }')
247         mysql --host="$mysqlhost" --user="$mysqluser" \
248 --password="$mysqlpwd" <<eof
249 USE \`$mysqldb\`;
250 UPDATE borrowers 
251 SET password = '$staffdigest' 
252 WHERE borrowernumber = 3;
253 eof
254
255         echo "staff user password is '$staffpass' but keep that secret"
256
257         # Upgrade the database schema, just in case the dump was from an 
258         # old version.
259         koha-upgrade-schema "$name"
260     else
261         echo "Koha instance is empty, no staff user created."
262     fi
263 fi
264
265
266 if [ "$op" = create ] || [ "$op" = populate ]
267 then
268     # Reconfigure Apache.
269     a2ensite "$name"
270     service apache2 restart
271
272     # Start Zebra.
273     koha-start-zebra "$name"
274 fi
275
276
277 if [ "$op" = request ]
278 then
279     koha-disable "$name"
280 fi
281
282 echo <<eoh
283
284 Email for this instance is disabled. When you're ready to enable it, use:
285 koha-email-enable $name
286 eoh