Merge lp:~jontai/openvista-gtm-integration/bug519041 into lp:openvista-gtm-integration

[Jon Tai]

[lp:~jontai/openvista-gtm-integration/bug519041]

125. By Jon Tai on 2010-02-09

move the temporary gtmroutines setting into the subshell for consistency -- in the futurei, if ovcompile needs to do more stuff after the compile, gtmroutines will go back to "normal" after the subshell

[jeff.apple (jeff-apple)]

review: Approve

=== added file 'docs/man1/ovcompile.1'
--- docs/man1/ovcompile.1	1970-01-01 00:00:00 +0000
+++ docs/man1/ovcompile.1	2010-02-10 00:00:35 +0000
@@ -0,0 +1,43 @@
+.TH ovcompile 1 "9 Feb 2010" Linux "User Manuals"
+.SH NAME
+ovcompile \- (re)compile routines in an OpenVista instance
+.SH SYNOPSIS
+.B ovcompile [-h] [-V]
+.I instance_name
+.SH DESCRIPTION
+.B ovcompile
+(re)compiles all routines in an OpenVista instance.
+.PP
+Routines should be compiled before users access the system, otherwise
+compilation errors will be shown to the user.
+.B ovimport
+and
+.B ovrestore
+both compile routines automatically when they are run.  If routines are
+manually copied into an OpenVista instance, or if the version of GT.M an
+instance is using is upgraded,
+.B ovcompile
+should be used to force all routines to be recompiled.
+.SH OPTIONS
+.IP -h
+display help text and exit
+.IP -V
+display version information and exit
+.SH "EXIT VALUES"
+.IP 0
+Success
+.IP 1
+Permission denied
+.IP 2
+Invalid command syntax
+.IP 3
+Invalid argument to option
+.SH "REPORTING BUGS"
+Please report any bugs you encounter at
+.PP
+https://bugs.launchpad.net/openvista-gtm-integration
+.SH AUTHOR
+Jonathan Tai <[e-mail]>
+.SH "SEE ALSO"
+.BR ovimport (1)
+.BR ovrestore (8)

=== modified file 'packages/deb/Ubuntu/10.04/openvista-gtm-integration/debian/openvista-utils.manpages'
--- packages/deb/Ubuntu/10.04/openvista-gtm-integration/debian/openvista-utils.manpages	2010-01-16 22:24:12 +0000
+++ packages/deb/Ubuntu/10.04/openvista-gtm-integration/debian/openvista-utils.manpages	2010-02-10 00:00:35 +0000
@@ -12,3 +12,4 @@
 docs/man1/ovimport.1
 docs/man1/ovcheckperms.1
 docs/man1/ovgetvar.1
+docs/man1/ovcompile.1

=== modified file 'packages/deb/Ubuntu/9.04/openvista-gtm-integration/debian/openvista-utils.manpages'
--- packages/deb/Ubuntu/9.04/openvista-gtm-integration/debian/openvista-utils.manpages	2009-12-12 01:28:35 +0000
+++ packages/deb/Ubuntu/9.04/openvista-gtm-integration/debian/openvista-utils.manpages	2010-02-10 00:00:35 +0000
@@ -12,3 +12,4 @@
 docs/man1/ovimport.1
 docs/man1/ovcheckperms.1
 docs/man1/ovgetvar.1
+docs/man1/ovcompile.1

=== modified file 'packages/deb/Ubuntu/9.10/openvista-gtm-integration/debian/openvista-utils.manpages'
--- packages/deb/Ubuntu/9.10/openvista-gtm-integration/debian/openvista-utils.manpages	2009-12-12 01:28:35 +0000
+++ packages/deb/Ubuntu/9.10/openvista-gtm-integration/debian/openvista-utils.manpages	2010-02-10 00:00:35 +0000
@@ -12,3 +12,4 @@
 docs/man1/ovimport.1
 docs/man1/ovcheckperms.1
 docs/man1/ovgetvar.1
+docs/man1/ovcompile.1

=== modified file 'scripts/etc/bash_completion.d/openvista'
--- scripts/etc/bash_completion.d/openvista	2009-12-17 01:09:28 +0000
+++ scripts/etc/bash_completion.d/openvista	2010-02-10 00:00:35 +0000
@@ -80,6 +80,7 @@
 complete -F _openvista ovpurgejournals
 complete -F _openvista ovswitchjournals
 complete -F _openvista ovcheckperms
+complete -F _openvista ovcompile
 
 # ovbackup [-h] [-V] [-q] INSTANCE_NAME
 _ovbackup()

=== added file 'scripts/usr/bin/ovcompile'
--- scripts/usr/bin/ovcompile	1970-01-01 00:00:00 +0000
+++ scripts/usr/bin/ovcompile	2010-02-10 00:00:35 +0000
@@ -0,0 +1,113 @@
+#!/bin/bash
+
+# This script (re)compiles all routines in an OpenVista instance.
+
+
+# Copyright (C) 2010 Medsphere Systems Corporation
+#
+# This program is free software; you can redistribute it and/or modify it solely
+# under the terms of the GNU Affero General Public License version 3 as published
+# by the Free Software Foundation.
+# 
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License
+# for more details.
+# 
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses>.
+# 
+# You can contact Medsphere Systems Corporation headquarters at 1917 Palomar 
+# Oaks Way, Suite 200, Carlsbad, CA 92008 or at [e-mail].
+
+
+# common functions
+. /usr/lib/openvista/functions
+
+# parse arguments
+while getopts hV option; do
+    case $option in
+        h)
+            cat <<EOF
+Usage: ovcompile INSTANCE_NAME
+   or  ovcompile -h
+   or  ovcompile -V
+
+  -h  display this help text and exit
+  -V  display version information and exit
+EOF
+            exit 0
+            ;;
+        V)
+            cat <<EOF
+ovcompile 0.8.7
+Copyright (C) 2010 Medsphere Systems Corporation
+
+ovcompile is powered by Medsphere and part of a suite of open source 
+utilities licensed under the AGPL, available at http://medsphere.org.  
+EOF
+            exit 0
+            ;;
+    esac
+done
+shift `expr $OPTIND - 1`
+
+# check command syntax
+if [ -z "$1" ]; then
+    echo "ovcompile: missing OpenVista instance name" >&2
+    echo "Try 'ovcompile -h' for more information" >&2
+    exit 2
+fi
+
+# check permissions
+in_groups || {
+    echo "ovcompile: permission denied" >&2
+    exit 1
+}
+
+# check for for valid arguments (requires correct permissions to do; must happen after permission checks)
+set_gtm_env "$1" || {
+    echo "ovcompile: $instance: Not an OpenVista instance" >&2
+    exit 3
+}
+
+tempdir=`mktemp -d -p "$root/$instance/tmp" .ovcompile.XXXXXXXXXX` ||
+exit_with_error "ovcompile" "Unable to create temporary directory"
+
+# the EXIT handler may or may not run if we're interrupted or killed depending
+# on the shell used (from what I've read, it does run on bash, but not on
+# dash); use $exit to exit with the correct status in both cases
+trap 'rm -rf "$tempdir"; exit ${exit:-0}' EXIT
+
+trap 'rm -rf "$tempdir"; exit ${exit:=130}' INT
+trap 'rm -rf "$tempdir"; exit ${exit:=143}' TERM
+
+# we use mumps to compile all the files via auto-zlink; this will ensure that
+# the correct version of the routine is compiled if more than one version
+# exists in a different tier and that the object file is compiled to the right
+# place.
+
+(
+    umask 007
+
+    # create a temporary mumps routine to do the compilation.  we used to do this
+    # all one one line, but then we couldn't handle errors in the FOR loop.
+    cat > "$tempdir/MSCOVCOMPILE.m" <<EOF
+MSCOVCOMPILE
+	N %ZR D SILENT^%RSEL("*")
+	N \$ETRAP S \$ETRAP="S \$ECODE="""" Q"
+	N R S R=""
+	F  S R=\$O(%ZR(R)) Q:R=""  D
+	. ZLINK \$S(\$E(R)="%":"_"_\$E(R,2,\$L(R)),1:R)
+EOF
+
+    # prepend the temporary directory to gtmroutines
+    gtmroutines="$tempdir $gtmroutines"
+    export gtmroutines
+
+    # call the temporary routine
+    echo -e 'D ^MSCOVCOMPILE\nH\n' | mumps -dir 2>&1 \
+      | grep -v '^$' | grep -v '>$' \
+      | logger -p user.info -t "ovcompile[$$]"
+)
+

=== modified file 'scripts/usr/bin/ovimport'
--- scripts/usr/bin/ovimport	2010-01-11 20:58:19 +0000
+++ scripts/usr/bin/ovimport	2010-02-10 00:00:35 +0000
@@ -278,15 +278,8 @@
             # -t target) that %RSEL will come up empty and no routines will be
             # compiled.
 
-            # use mumps to compile all the files via auto-zlink; this will ensure that the
-            # correct version of the routine is compiled if more than one version exists
-            # in a different tier and that the object file is compiled to the right place.
-            (
-                umask 007
-                echo -e 'D SILENT^%RSEL("*") S R="" F  S R=$O(%ZR(R)) Q:R=""  ZLINK $S($E(R)="%":"_"_$E(R,2,$L(R)),1:R)\nH\n' | mumps -dir 2>&1 \
-                  | grep -v '^$' | grep -v '>$' \
-                  | logger -p user.info -t "ovimport[$$]"
-            )
+            # call ovcompile to do the actual work
+            ovcompile "$instance"
             ;;
         none)
             print_status "ovimport" "Skipping routine compilation" "$skip_status"
@@ -296,8 +289,26 @@
 
             (
                 umask 007
+
+                # create a temporary mumps routine to do the compilation.  we used to do this
+                # all one one line, but then we couldn't handle errors in the FOR loop.
+                cat > "$tempdir/MSCOVIMPORT.m" <<EOF
+MSCOVIMPORT
+	N LIST S LIST="$tempdir/ovimport.compile.uniq"
+	O LIST:(readonly) U LIST
+	N \$ETRAP S \$ETRAP="S \$ECODE="""" Q"
+	N ROUTINE F  R ROUTINE Q:ROUTINE=""  D
+	. ZLINK ROUTINE
+	C LIST
+	U \$P
+EOF
+
+                # prepend the temporary directory to gtmroutines
+                gtmroutines="$tempdir $gtmroutines"
+                export gtmroutines
+
                 cat "$tempdir/ovimport.compile" | sort | uniq > "$tempdir/ovimport.compile.uniq"
-                echo -e 'S LIST="'"$tempdir/ovimport.compile.uniq"'"\nO LIST:(readonly) U LIST F  R ROUTINE Q:ROUTINE=""  ZLINK ROUTINE\nC LIST U $P\nH\n' | mumps -dir 2>&1 \
+                echo -e 'D ^MSCOVIMPORT\nH\n' | mumps -dir 2>&1 \
                   | tee "$tempdir/ovimport.zlink" \
                   | grep -v '^$' | grep -v '>$' \
                   | logger -p user.info -t "ovimport[$$]"

=== modified file 'scripts/usr/sbin/ovrestore'
--- scripts/usr/sbin/ovrestore	2010-01-11 20:58:19 +0000
+++ scripts/usr/sbin/ovrestore	2010-02-10 00:00:35 +0000
@@ -292,15 +292,8 @@
 find "$root/$instance/objects/" -type f -name '*.o' -exec rm -f {} \; || 
 exit_with_error "ovrestore" "Unable to remove existing object files"
 
-# use mumps to compile all the files via auto-zlink; this will ensure that the
-# correct version of the routine is compiled if more than one version exists
-# in more than one tier and that the object file is compiled to the right place.
-(
-    umask 007
-    echo -e 'D SILENT^%RSEL("*") S R="" F  S R=$O(%ZR(R)) Q:R=""  ZLINK $S($E(R)="%":"_"_$E(R,2,$L(R)),1:R)\nH\n' | mumps -dir 2>&1 \
-      | grep -v '^$' | grep -v '>$' \
-      | logger -p user.info -t "ovrestore[$$]"
-)
+# call ovcompile to do the actual work
+ovcompile "$instance"
 
 # if we're not applying journals, shut off journaling on the old database so
 # that there's a clean break, then move the journal file out of the way