3 # Copyright (C) 2008-2009 Rod Roark <rod@sunsetsystems.com>
5 # This program is free software; you can redistribute it and/or
6 # modify it under the terms of the GNU General Public License
7 # as published by the Free Software Foundation; either version 2
8 # of the License, or (at your option) any later version.
10 # This is for restoring a backup created by the "Backup" option
11 # in OpenEMR's administration menu, which invokes
12 # interface/main/backup.php.
14 # Xdialog is supported if available... dialog support is also in
15 # here but is disabled, as it was found to be ugly and clumsy.
21 if [ ! -z "$DISPLAY" -a ! -z "`which Xdialog`" ]; then
23 NOBUTTONS
="--no-buttons"
24 DEFAULTNO
="--default-no"
26 # elif [ ! -z `which dialog` ]; then
31 if [ ! -z "$DLGCMD" ]; then
34 while [ ! -z "$1" ]; do
38 $DLGCMD --title 'OpenEMR Restore' $LEFT --msgbox "$MSG" 0 0
41 while [ ! -z "$1" ]; do
48 if [ ! -z "$DLGCMD" ]; then
49 if [ "$DLGCMD" = "Xdialog" ]; then
52 $DLGCMD --title 'OpenEMR Restore' $LEFT --infobox "$1" 0 0
59 if [ ! -z "$DLGCMD" ]; then
61 RESULT
=`$DLGCMD --title 'OpenEMR Restore' --backtitle "$1" $NOBUTTONS --fselect $HOME/ 0 70 2>&1 1>&3`
64 if [ $CODE -eq 0 ]; then
71 read -e -p "$1: " RESULT
75 if [ ! -z "$DLGCMD" ]; then
78 while [ ! -z "$1" ]; do
82 $DLGCMD --title 'OpenEMR Restore' $DEFAULTNO $LEFT --yesno "$MSG" 0 0
85 if [ $CODE -eq 0 ]; then
87 elif [ $CODE -eq 1 ]; then
95 while [ ! -z "$2" ]; do
99 read -e -p "$1 [N/y] " RESULT
100 RESULT
=`expr "$RESULT" : "[yY]"`
105 if [ ! -z "$DLGCMD" ]; then
107 RESULT
=`$DLGCMD --title 'OpenEMR Restore' $LEFT --inputbox "$1" 0 0 2>&1 1>&3`
110 if [ $CODE -eq 0 ]; then
117 read -e -p "$1 " RESULT
121 if [ -z "$DLGCMD" ]; then
126 dlg_msg
"WARNING: This script is experimental." "It may have serious bugs or omissions." "Use it at your own risk!"
128 BAKDIR
=/tmp
/emr_backup
130 if [ $UID -ne 0 ]; then
131 dlg_msg
"Error: This script must be executed with root privileges."
135 # Create and change to a clean scratch directory.
138 if [ $?
-ne 0 ]; then
139 dlg_msg
"Error: Cannot create directory '$BAKDIR'."
143 dlg_msg
"Now you will be asked for the backup file." "By default this is named emr_backup.tar, although you may have saved it as something else."
146 while [ $LOOKING -eq 1 ]; do
147 dlg_fselect
"Enter path/name of backup file"
150 if [ ! -f $TARFILE ]; then
151 dlg_msg
"Error: '$TARFILE' is not found or is not a file."
153 # Extract the backup tarball into the scratch directory.
154 dlg_info
"Extracting $TARFILE ..."
157 if [ $?
-ne 0 ]; then
158 dlg_msg
"Error: tar could not extract '$TARFILE'."
165 # Extract the OpenEMR web directory tree.
166 dlg_info
"Extracting $BAKDIR/openemr.tar.gz ..."
169 tar zxf ..
/openemr.
tar.gz
170 if [ $?
-ne 0 ]; then
171 dlg_msg
"Error: tar could not extract '$BAKDIR/openemr.tar.gz'."
175 # Get various parameters from the extracted files.
176 OEDIR
=`grep '^\$webserver_root' interface/globals.php | cut -d \" -f 2`
177 OEDBNAME
=`grep '^\$dbase' library/sqlconf.php | cut -d \' -f 2`
178 OEDBUSER
=`grep '^\$login' library/sqlconf.php | cut -d \' -f 2`
179 OEDBPASS
=`grep '^\$pass' library/sqlconf.php | cut -d \' -f 2`
181 if [ -f ..
/sql-ledger.sql
]; then
182 SLDBNAME
=`grep '^\$sl_dbname' interface/globals.php | cut -d \' -f 2`
183 SLDBUSER
=`grep '^\$sl_dbuser' interface/globals.php | cut -d \' -f 2`
184 SLDBPASS
=`grep '^\$sl_dbpass' interface/globals.php | cut -d \' -f 2`
190 if [ -f ..
/phpgacl.
tar.gz
]; then
191 GADIR
=`grep '^\s*\$phpgacl_location' library/acl.inc | cut -d \" -f 2`
195 dlg_info
"Extracting $BAKDIR/phpgacl.tar.gz ..."
196 tar zxf ..
/phpgacl.
tar.gz
197 if [ $?
-ne 0 ]; then
198 dlg_msg
"Error: tar could not extract '$BAKDIR/phpgacl.tar.gz'."
201 if [ -f ..
/phpgacl.sql.gz
]; then
202 GADBNAME
=`grep '^\s*var \$_db_name' gacl.class.php | cut -d \' -f 2`
203 GADBUSER
=`grep '^\s*var \$_db_user' gacl.class.php | cut -d \' -f 2`
204 GADBPASS
=`grep '^\s*var \$_db_password' gacl.class.php | cut -d \' -f 2`
206 elif [ -e gacl
]; then
207 grep '^\s*\$phpgacl_location' library
/acl.inc
> /dev
/null
208 if [ $?
-eq 0 ]; then
209 GACONFIGDIR
="$OEDIR/gacl"
210 if [ -f ..
/phpgacl.sql.gz
]; then
212 GADBNAME
=`grep '^\s*var \$_db_name' gacl.class.php | cut -d \' -f 2`
213 GADBUSER
=`grep '^\s*var \$_db_user' gacl.class.php | cut -d \' -f 2`
214 GADBPASS
=`grep '^\s*var \$_db_password' gacl.class.php | cut -d \' -f 2`
221 if [ -f ..
/sql-ledger.
tar.gz
]; then
222 SLDIR
=`dirname $OEDIR`/sql-ledger
225 dlg_yesno
'Do you want to specify new locations and database names for the restore?'
230 if [ $CHANGES -gt 0 ]; then
231 dlg_msg
"Current values are shown in [brackets]. Just hit Enter to leave them as-is."
232 dlg_input
"OpenEMR database name [$OEDBNAME]? "
233 if [ ! -z "$RESULT" ]; then OEDBNAME
="$RESULT"; fi
234 dlg_input
"OpenEMR database user [$OEDBUSER]? "
235 if [ ! -z "$RESULT" ]; then OEDBUSER
="$RESULT"; fi
236 dlg_input
"OpenEMR database password [$OEDBPASS]? "
237 if [ ! -z "$RESULT" ]; then OEDBPASS
="$RESULT"; fi
238 if [ ! -z "$GADBNAME" ]; then
239 dlg_input
"phpGACL database name [$GADBNAME]? "
240 if [ ! -z "$RESULT" ]; then GADBNAME
="$RESULT"; fi
241 OLDGADBUSER
="$GADBUSER"
243 while [ $LOOKING -eq 1 ]; do
244 dlg_input
"phpGACL database user [$GADBUSER]? "
245 if [ ! -z "$RESULT" ]; then GADBUSER
="$RESULT"; fi
246 if [ "$GADBUSER" = "$SLDBUSER" ]; then
247 dlg_msg
"Error: OpenEMR and phpGACL have separate databases but the same user name." "They must be different user names."
248 GADBUSER
="$OLDGADBUSER"
253 dlg_input
"phpGACL database password [$GADBPASS]? "
254 if [ ! -z "$RESULT" ]; then GADBPASS
="$RESULT"; fi
256 if [ ! -z "$SLDBNAME" ]; then
257 OLDSLDBNAME
="$SLDBNAME"
258 dlg_input
"SQL-Ledger database name [$SLDBNAME]? "
259 if [ ! -z "$RESULT" ]; then SLDBNAME
="$RESULT"; fi
260 dlg_input
"SQL-Ledger database user [$SLDBUSER]? "
261 if [ ! -z "$RESULT" ]; then SLDBUSER
="$RESULT"; fi
262 dlg_input
"SQL-Ledger database password [$SLDBPASS]? "
263 if [ ! -z "$RESULT" ]; then SLDBPASS
="$RESULT"; fi
266 dlg_input
"OpenEMR web directory [$OEDIR]? "
267 if [ ! -z "$RESULT" ]; then OEDIR
="$RESULT"; fi
268 if [ ! -z "$GADIR" ]; then
270 dlg_input
"phpGACL web directory [$GADIR]? "
271 if [ ! -z "$RESULT" ]; then GADIR
="$RESULT"; fi
273 if [ ! -z "$SLDIR" ]; then
275 dlg_input
"SQL-Ledger web directory [$SLDIR]? "
276 if [ ! -z "$RESULT" ]; then SLDIR
="$RESULT"; fi
279 # The following is to figure out the proper value for $web_root.
282 DOCROOT
=`dirname $OEDIR`
283 OEFILE
=`basename $OEDIR`
284 while [ $LOOKING -eq 1 ]; do
285 dlg_yesno
"Is the Apache document root '$DOCROOT'?"
286 if [ $RESULT -eq 1 ]; then
289 OEFILE
=`basename $DOCROOT`/$OEFILE
290 DOCROOT
=`dirname $DOCROOT`
291 if [ "$DOCROOT" = "/" ]; then
293 OEFILE
=`basename $OEDIR`
294 DOCROOT
=`dirname $OEDIR`
295 dlg_msg
"Never mind, I will assume '$DOCROOT'. You may need to manually correct" "the value of \$web_root in '$OEDIR/interface/globals.php'."
303 # Patch up $GACONFIGDIR in case it was changed.
304 if [ -z "$GADIR" ]; then
305 if [ ! -z "$GACONFIGDIR" ]; then
306 GACONFIGDIR
="$OEDIR/gacl"
312 # If phpgacl has its own database, make sure the database user is not the
313 # same as for openemr. This is to prevent screwups caused by persistent
314 # database connections in PHP.
315 if [ ! -z "$GADBNAME" ]; then
316 if [ "$GADBUSER" = "$SLDBUSER" ]; then
317 dlg_msg
"Error: OpenEMR and phpGACL have separate databases but the same user name." "They must be different user names."
322 # The following sanity checks are an attempt to avoid disastrous results
323 # from mistakes in entry of directory path names.
325 TRASH
=`expr "$OEDIR" : "[/]"`
326 if [ $TRASH -ne 1 ]; then
327 dlg_msg
"Error: The OpenEMR directory path '$OEDIR' does not start with '/'."
330 if [ -e "$OEDIR" -a ! -e "$OEDIR/interface/globals.php" ]; then
331 dlg_msg
"Error: $OEDIR already exists but does not look like an OpenEMR directory." "If you are really sure you want to replace it, please remove it first."
335 if [ ! -z "$GADIR" ]; then
336 TRASH
=`expr "$GADIR" : "[/]"`
337 if [ $TRASH -ne 1 ]; then
338 dlg_msg
"Error: The phpGACL directory path '$GADIR' does not start with '/'."
341 if [ -e "$GADIR" -a ! -e "$GADIR/gacl.class.php" ]; then
342 dlg_msg
"Error: $GADIR already exists but does not look like a phpGACL directory." "If you are really sure you want to replace it, please remove it first."
347 if [ ! -z "$SLDIR" ]; then
348 TRASH
=`expr "$SLDIR" : "[/]"`
349 if [ $TRASH -ne 1 ]; then
350 dlg_msg
"Error: The SQL-Ledger directory path '$SLDIR' does not start with '/'."
353 if [ -e "$SLDIR" -a ! -e "$SLDIR/setup.pl" ]; then
354 dlg_msg
"Error: $SLDIR already exists but does not look like a SQL-Ledger directory." "If you are really sure you want to replace it, please remove it first."
359 # Ask the user to do final sanity checking.
361 MARGS
="\"I will restore the OpenEMR database backup to the MySQL database '$OEDBNAME'.\""
362 MARGS
="$MARGS \"The OpenEMR database user will be '$OEDBUSER' with password '$OEDBPASS'.\""
363 if [ ! -z "$GADBNAME" ]; then
364 MARGS
="$MARGS \"I will restore the phpGACL database backup to the MySQL database '$GADBNAME'.\""
365 MARGS
="$MARGS \"The phpGACL database user will be '$GADBUSER' with password '$GADBPASS'.\""
367 if [ ! -z "$SLDBNAME" ]; then
368 MARGS
="$MARGS \"I will restore the SQL-Ledger database backup to the PostgreSQL database '$SLDBNAME'.\""
369 MARGS
="$MARGS \"The SQL-Ledger database user will be '$SLDBUSER' with password '$SLDBPASS'.\""
371 MARGS
="$MARGS \"I will copy the OpenEMR web directory backup to '$OEDIR'.\""
372 if [ ! -z "$GADIR" ]; then
373 MARGS
="$MARGS \"I will copy the phpGACL web directory backup to '$GADIR'.\""
375 if [ ! -z "$SLDIR" ]; then
376 MARGS
="$MARGS \"I will copy the SQL-Ledger web directory backup to '$SLDIR'.\""
379 MARGS
="$MARGS \"Please check the above very carefully!\""
380 MARGS
="$MARGS \"Any existing databases and directories matching these names will be DESTROYED.\""
381 MARGS
="$MARGS \"Do you wish to continue?\""
383 eval "dlg_yesno $MARGS"
384 if [ $RESULT -ne 1 ]; then
390 dlg_msg
"In order to create MySQL databases and users on this computer, I will need to" \
391 "log into MySQL as its 'root' user. The next question asks for the MySQL root" \
392 "user's password for this server, the one that you are restoring to. This is" \
393 "a MySQL password, not a system login password. Often it is blank."
394 dlg_input
'Enter the password, if any, for the MySQL root user:'
399 dlg_info
"Dropping old OpenEMR database if it exists ..."
400 mysqladmin
--password="$MYROOTPASS" --force drop
$OEDBNAME 2> /dev
/null
402 dlg_info
"Restoring OpenEMR database ..."
404 gunzip openemr.sql.gz
405 if [ $?
-ne 0 ]; then
406 dlg_msg
"Error: Could not decompress '$BAKDIR/openemr.sql.gz'."
409 mysqladmin
--password="$MYROOTPASS" create
$OEDBNAME
410 if [ $?
-ne 0 ]; then
411 dlg_msg
"Error: Could not create MySQL database '$OEDBNAME'."
414 mysql
--password="$MYROOTPASS" --execute "GRANT ALL PRIVILEGES ON $OEDBNAME.* TO '$OEDBUSER'@'localhost' IDENTIFIED BY '$OEDBPASS'" $OEDBNAME
415 mysql
--user=$OEDBUSER --password="$OEDBPASS" $OEDBNAME < openemr.sql
416 if [ $?
-ne 0 ]; then
417 dlg_msg
"Error: Restore to database '$OEDBNAME' failed."
421 if [ ! -z "$GADBNAME" ]; then
422 dlg_info
"Dropping old phpGACL database if it exists ..."
423 mysqladmin
--password="$MYROOTPASS" --force drop
$GADBNAME 2> /dev
/null
424 dlg_info
"Restoring phpGACL database ..."
426 gunzip phpgacl.sql.gz
427 if [ $?
-ne 0 ]; then
428 dlg_msg
"Error: Could not decompress '$BAKDIR/phpgacl.sql.gz'."
431 mysqladmin
--password="$MYROOTPASS" create
$GADBNAME
432 if [ $?
-ne 0 ]; then
433 dlg_msg
"Error: Could not create MySQL database '$GADBNAME'."
436 mysql
--password="$MYROOTPASS" --execute "GRANT ALL PRIVILEGES ON $GADBNAME.* TO '$GADBUSER'@'localhost' IDENTIFIED BY '$GADBPASS'" $GADBNAME
437 mysql
--user=$GADBUSER --password="$GADBPASS" $GADBNAME < phpgacl.sql
438 if [ $?
-ne 0 ]; then
439 dlg_msg
"Error: Restore to database '$GADBNAME' failed."
444 if [ ! -z "$SLDBNAME" ]; then
445 # Avoid local domain connections for the sql-ledger user, because a
446 # default postgresql configuration is likely set to require "ident"
447 # authentication for them.
449 if [ ! -z "$PGHOST" ]; then
455 dlg_info
"Restarting Apache to close persistent database connections ..."
457 dlg_info
"Dropping old SQL-Ledger database if it exists ..."
458 sudo
-u postgres psql
--command "DROP DATABASE \"$SLDBNAME\"" template1
2> /dev
/null
459 dlg_info
"Creating procedural language and database user ..."
460 sudo
-u postgres createlang plpgsql template1
2> /dev
/null
461 sudo
-u postgres psql
--command "DROP ROLE \"$SLDBUSER\"" template1
2> /dev
/null
463 # This next part merits some comment. The database is best loaded by the
464 # sql-ledger user, otherwise we will have the nasty task of granting that
465 # user access to all of its tables individually, which PostgreSQL does not
466 # provide a convenient way of doing. However superuser privilege is needed
467 # to properly restore the dump. Therefore we give the new role superuser
468 # privilege now and revoke it after the restore is done.
470 sudo
-u postgres psql
--command "CREATE ROLE \"$SLDBUSER\" PASSWORD '$SLDBPASS' SUPERUSER CREATEDB CREATEROLE INHERIT LOGIN" template1
471 dlg_info
"Creating and restoring SQL-Ledger database ..."
472 export PGUSER
="$SLDBUSER"
473 export PGPASSWORD
="$SLDBPASS"
474 psql
-h $MYPGHOST --command "CREATE DATABASE \"$SLDBNAME\" WITH TEMPLATE template0" template1
475 if [ $?
-ne 0 ]; then
476 dlg_msg
"Error: Could not create PostgreSQL database '$SLDBNAME'."
479 pg_restore
-h $MYPGHOST --no-owner --dbname=$SLDBNAME sql-ledger.sql
480 if [ $?
-ne 0 ]; then
481 dlg_msg
"Error: Restore to database '$SLDBNAME' failed."
486 sudo
-u postgres psql
--command "ALTER ROLE \"$SLDBUSER\" NOSUPERUSER" template1
487 if [ $?
-ne 0 ]; then
488 dlg_info
"Warning: ALTER ROLE failed."
490 sudo
-u postgres psql
--command "ANALYZE" $SLDBNAME
493 dlg_info
"Restoring OpenEMR web directory tree ..."
496 mv $BAKDIR/openemr
$OEDIR
497 if [ $?
-ne 0 ]; then
498 dlg_msg
"Error: Cannot create directory '$OEDIR'."
502 if [ $CHANGES -gt 0 ]; then
503 dlg_info
"Modifying $OEDIR/interface/globals.php ..."
505 mv -f globals.php globals.php.old
506 sed "s^$OLDOEDIR^$OEDIR^" globals.php.old | \
507 sed "/\\\$web_root *=/ c \$web_root = \"/$OEFILE\";" | \
508 sed "s^sl_dbname *= '.*'^sl_dbname = '$SLDBNAME'^" | \
509 sed "s^sl_dbuser *= '.*'^sl_dbuser = '$SLDBUSER'^" | \
510 sed "s^sl_dbpass *= '.*'^sl_dbpass = '$SLDBPASS'^" \
513 dlg_info
"Modifying $OEDIR/library/sqlconf.php ..."
515 mv sqlconf.php sqlconf.php.old
516 sed "s^dbase\t= '.*'^dbase\t= '$OEDBNAME'^" sqlconf.php.old | \
517 sed "s^login\t= '.*'^login\t= '$OEDBUSER'^" | \
518 sed "s^pass\t= '.*'^pass\t= '$OEDBPASS'^" > sqlconf.php
520 dlg_info
"Modifying $OEDIR/includes/config.php ..."
521 SLFILE
=`dirname /$OEFILE`
522 if [ "$SLFILE" = "/" ]; then
525 SLFILE
="$SLFILE/sql-ledger"
528 cp -f config.php config.php.old
529 sed "s^\"/.*/ws_server.pl\"^\"$SLFILE/ws_server.pl\"^" config.php.old
> config.php
532 if [ ! -z "$GADIR" ]; then
533 dlg_info
"Restoring phpGACL web directory tree ..."
536 mv $BAKDIR/phpgacl
$GADIR
537 if [ $?
-ne 0 ]; then
538 dlg_msg
"Error: Cannot create directory '$GADIR'."
542 if [ $CHANGES -gt 0 ]; then
543 dlg_info
"Modifying $OEDIR/library/acl.inc ..."
545 mv -f acl.inc acl.inc.old
546 sed "s^$OLDGADIR^$GADIR^" acl.inc.old
> acl.inc
550 if [ ! -z "$GACONFIGDIR" -a $CHANGES -gt 0 ]; then
551 if [ -z "$GADBNAME" ]; then
557 dlg_info
"Modifying $GACONFIGDIR/gacl.class.php ..."
559 mv -f gacl.class.php gacl.class.php.old
560 sed "s^db_name *= *'.*'^db_name = '$GADBNAME'^" gacl.class.php.old | \
561 sed "s^db_user *= *'.*'^db_user = '$GADBUSER'^" | \
562 sed "s^db_password *= *'.*'^db_password = '$GADBPASS'^" > gacl.class.php
564 dlg_info
"Modifying $GACONFIGDIR/gacl.ini.php ..."
566 mv -f gacl.ini.php gacl.ini.php.old
567 sed "s^db_name[ \t]*= *\".*\"^db_name\t\t\t= \"$GADBNAME\"^" gacl.ini.php.old | \
568 sed "s^db_user[ \t]*= *\".*\"^db_user\t\t\t= \"$GADBUSER\"^" | \
569 sed "s^db_password[ \t]*= *\".*\"^db_password\t\t= \"$GADBPASS\"^" > gacl.ini.php
572 if [ ! -z "$SLDIR" ]; then
573 dlg_info
"Restoring SQL-Ledger web directory tree ..."
578 if [ $?
-ne 0 ]; then
579 dlg_msg
"Error: Creating $SLDIR failed."
582 tar zxf
$BAKDIR/sql-ledger.
tar.gz
583 if [ $?
-ne 0 ]; then
584 dlg_msg
"Error: Extracting '$BAKDIR/sql-ledger.tar.gz' failed."
588 if [ $CHANGES -gt 0 ]; then
589 # SQL-Ledger stores passwords in an obfuscated form.
590 SLDBHASH
=`perl -e "print pack u, '$SLDBPASS'"`
592 dlg_info
"Modifying $SLDIR/ws_server.pl ..."
594 mv -f ws_server.pl ws_server.pl.old
595 sed "s^$OLDSLDIR^$SLDIR^" ws_server.pl.old
> ws_server.pl
596 chmod a
+x ws_server.pl
598 dlg_info
"Modifying $SLDIR/users/admin.conf ..."
600 cp -f admin.conf admin.conf.old
601 sed "s^dbname => '.*'^dbname => '$SLDBNAME'^" admin.conf.old | \
602 sed "s^dbuser => '.*'^dbuser => '$SLDBUSER'^" | \
603 sed "/dbpasswd =>/ c \ dbpasswd => '$SLDBHASH'," | \
604 sed "s^dbname=$OLDSLDBNAME^dbname=$SLDBNAME^" > admin.conf
606 dlg_info
"Modifying $SLDIR/users/members ..."
608 cp -f members members.old
609 sed "s^dbname=.*^dbname=$SLDBNAME^g" members.old | \
610 sed "s^dbuser=.*^dbuser=$SLDBUSER^g" | \
611 sed "/dbpasswd=/ c dbpasswd=$SLDBHASH" > members