Changeset 63870 in vbox for trunk/src/VBox/Additions/linux

Timestamp:

Sep 16, 2016 5:42:56 PM (8 years ago)

Author:

vboxsync

Message:

bugref:3809: Linux installer maintenance: clean up logging in the Additions installer init scripts.

Location:

trunk/src/VBox/Additions/linux/installer

Files:

• vboxadd-x11.sh (modified) (17 diffs)
• vboxadd.sh (modified) (23 diffs)

trunk/src/VBox/Additions/linux/installer/vboxadd-x11.sh

@@ -33 +33 @@
 CONFIG_DIR="/var/lib/VBoxGuestAdditions"
 CONFIG="config"
-SCRIPTNAME=vboxadd-x11.sh
 MODPROBE=/sbin/modprobe
 
@@ -80 +79 @@
 fi
 
-begin()
-{
-    test -n "${2}" && echo "${SCRIPTNAME}: ${1}."
-    logger -t "${SCRIPTNAME}" "${1}."
-}
-
-succ_msg()
-{
-    logger -t "${SCRIPTNAME}" "${1}."
-}
-
-fail_msg()
-{
-    echo "${SCRIPTNAME}: ${1}." >&2
-    logger -t "${SCRIPTNAME}" "${1}."
-}
-
 dev=/dev/vboxguest
 userdev=/dev/vboxuser
@@ -104 +86 @@
 fail()
 {
-    echo "${SCRIPTNAME}: failed: ${1}." >&2
-    logger "${SCRIPTNAME}: ${1}."
+    echo "${1}" >&2
     exit 1
 }
@@ -120 +101 @@
     service_name=$3
     alt_command=$4
-    test -r "$app_src" ||
-        { echo >> $LOG "$self: no script given"; return 1; }
-    test -r "$desktop_src" ||
-        { echo >> $LOG "$self: no desktop file given"; return 1; }
-    test -n "$service_name" ||
-        { echo >> $LOG "$self: no service given"; return 1; }
-    test -n "$alt_command" ||
-        { echo >> $LOG "$self: no service given"; return 1; }
+    test -r "$app_src" || fail "$self: no script given"
+    test -r "$desktop_src" || fail "$self: no desktop file given"
+    test -n "$service_name" || fail "$self: no service given"
+    test -n "$alt_command" || fail "$self: no service given"
     app_dest=`basename $app_src sh`
     app_dest_sh=`basename $app_src sh`.sh
@@ -165 +142 @@
         return 0
     fi
-    cat >> $LOG << EOF
+    cat >&2 << EOF
 Could not set up the $service_name desktop service.
 To start it at log-in for a given user, add the command $alt_command
@@ -193 +170 @@
 setup()
 {
-    echo "VirtualBox Guest Additions installation, Window System and desktop setup" > $LOG
-    begin "Installing the Window System drivers"
     lib_dir="$LIB/VBoxGuestAdditions"
     share_dir="/usr/share/VBoxGuestAdditions"
     test -x "$lib_dir" -a -x "$share_dir" ||
-        fail "Invalid Guest Additions configuration found"
+        fail "Invalid Guest Additions configuration found."
     # By default we want to configure X
     dox11config="true"
@@ -244 +219 @@
     test -z "$x_version" -o -z "$modules_dir" &&
         {
-            echo
-            echo "Could not find the X.Org or XFree86 Window System, skipping."
+            echo "Could not find the X.Org or XFree86 Window System, skipping." >&2
             exit 0
         }
 
-    echo
     # openSUSE 10.3 shipped X.Org 7.2 with X.Org Server 1.3, but didn't
     # advertise the fact.
@@ -259 +232 @@
     case $x_version in
         1.*.99.* )
-            echo "Warning: unsupported pre-release version of X.Org Server installed.  Not"
-            echo "installing the X.Org drivers."
+            echo "Warning: unsupported pre-release version of X.Org Server installed.  Not installing the X.Org drivers." >&2
             dox11config=""
             ;;
@@ -363 +335 @@
             test -f "${lib_dir}/${vboxvideo_src}" ||
             {
-                echo "Warning: unknown version of the X Window System installed.  Not installing"
-                echo "X Window System drivers."
+                echo "Warning: unknown version of the X Window System installed.  Not installing X Window System drivers." >&2
                 dox11config=""
                 vboxvideo_src=""
@@ -386 +357 @@
     esac
     test -n "${dox11config}" &&
-        begin "Installing $xserver_version modules"
+        echo "Installing $xserver_version modules" >&2
     case "$vboxvideo_src" in
         ?*)
@@ -401 +372 @@
         rm "$modules_dir/input/vboxmouse_drv$driver_ext" 2>/dev/null
     esac
-    succ_msg "$xserver_version modules installed"
 
     if test -n "$dox11config"; then
-        begin "Setting up the Window System to use the Guest Additions"
         # Certain Ubuntu/Debian versions use a special PCI-id file to identify
         # video drivers.  Some versions have the directory and don't use it.
@@ -442 +411 @@
             fi
         fi
-        succ_msg "Window System set up to use the Guest Additions"
         test -n "$generated" &&
-            cat << EOF
+            cat >&2 << EOF
 The following X.Org/XFree86 configuration files were originally generated by
 the VirtualBox Guest Additions and were not modified:
@@ -451 +419 @@
 
 EOF
-        cat << EOF
+        tty >/dev/null && cat << EOF
 You may need to restart the the Window System (or just restart the guest system)
 to enable the Guest Additions.
@@ -458 +426 @@
     fi
 
-    begin "Installing graphics libraries and desktop services components"
     case "$redhat_release" in
         # Install selinux policy for Fedora 7 and 8 to allow the X server to
@@ -489 +456 @@
         fail "See the log file $LOG for more information."
     ln -s "$lib_dir/98vboxadd-xclient" /usr/bin/VBoxClient-all 2>/dev/null
-    succ_msg "Window system drivers installed"
 }
 
@@ -531 +497 @@
         done
     fi
-    test -n "$newer" && cat << EOF
+    test -n "$newer" && cat >&2 << EOF
 
 The following X.Org/XFree86 configuration files were not restored, as they may
@@ -541 +507 @@
 
 EOF
-    test -n "$failed" && cat << EOF
+    test -n "$failed" && cat >&2 << EOF
 
 The following X.Org/XFree86 configuration files were restored, but still

trunk/src/VBox/Additions/linux/installer/vboxadd.sh

@@ -34 +34 @@
 PATH=$PATH:/bin:/sbin:/usr/sbin
 PACKAGE=VBoxGuestAdditions
-LOG="/var/log/vboxadd-install.log"
+LOG="/var/log/vboxadd-setup.log"
 MODPROBE=/sbin/modprobe
 OLDMODULES="vboxguest vboxadd vboxsf vboxvfs vboxvideo"
-SCRIPTNAME=vboxadd.sh
+SERVICE="VirtualBox Guest Additions"
 QUICKSETUP=
+## systemd logs information about service status, otherwise do that ourselves.
+QUIET=
+
+# Rotate log files
+mv "${LOG}.3" "${LOG}.4" 2>/dev/null
+mv "${LOG}.2" "${LOG}.3" 2>/dev/null
+mv "${LOG}.1" "${LOG}.2" 2>/dev/null
+mv "${LOG}" "${LOG}.1" 2>/dev/null
 
 if $MODPROBE -c 2>/dev/null | grep -q '^allow_unsupported_modules  *0'; then
@@ -72 +80 @@
 begin()
 {
-    test -n "${2}" && echo "${SCRIPTNAME}: ${1}."
-    logger -t "${SCRIPTNAME}" "${1}."
-}
-
-succ_msg()
-{
-    logger -t "${SCRIPTNAME}" "${1}."
-}
-
-show_error()
-{
-    echo "${SCRIPTNAME}: failed: ${1}." >&2
-    logger -t "${SCRIPTNAME}" "${1}."
+    test -z "${QUIET}" && echo "${SERVICE}: ${1}"
+}
+
+info()
+{
+    if test -z "${QUIET}"; then
+        echo "${SERVICE}: $1"
+    else
+        echo "$1"
+    fi
 }
 
 fail()
 {
-    show_error "$1"
+    log "${1}"
+    echo "$1" >&2
+    echo "The log file $LOG may contain further information." >&2
     exit 1
+}
+
+log()
+{
+    echo "${1}" >> "${LOG}"
 }
 
@@ -169 +181 @@
 start()
 {
-    begin "Starting the VirtualBox Guest Additions" console;
+    begin "Starting."
     # If we got this far assume that the slow set-up has been done.
     QUICKSETUP=yes
@@ -194 +206 @@
             setup
             $MODPROBE vboxguest >/dev/null 2>&1 || {
-                /sbin/rcvboxadd-x11 cleanup
+                "$lib_path/$PACKAGE/vboxadd-x11" cleanup 2>> "${LOG}"
                 fail "modprobe vboxguest failed"
             }
@@ -209 +221 @@
         $MODPROBE vboxsf > /dev/null 2>&1 || {
             if dmesg | grep "VbglR0SfConnect failed" > /dev/null 2>&1; then
-                show_error "Unable to start shared folders support.  Make sure that your VirtualBox build"
-                show_error "supports this feature."
+                info "Unable to start shared folders support.  Make sure that your VirtualBox build supports this feature."
             else
-                show_error "modprobe vboxsf failed"
+                info "modprobe vboxsf failed"
             fi
         }
@@ -218 +229 @@
 
     # Put the X.Org driver in place.  This is harmless if it is not needed.
-    /sbin/rcvboxadd-x11 setup
+    "$lib_path/$PACKAGE/vboxadd-x11" setup 2>> "${LOG}"
     # Install the guest OpenGL drivers.  For now we don't support
     # multi-architecture installations
@@ -246 +257 @@
     # mount -a -t vboxsf
 
-    succ_msg
     return 0
 }
@@ -252 +262 @@
 stop()
 {
-    begin "Stopping VirtualBox Additions" console;
+    begin "Stopping."
     if test -r /etc/ld.so.conf.d/00vboxvideo.conf; then
         rm /etc/ld.so.conf.d/00vboxvideo.conf
@@ -262 +272 @@
     modprobe -q -r -a vboxvideo vboxsf vboxguest
     egrep -q 'vboxguest|vboxsf|vboxvideo' /proc/modules &&
-        echo "You may need to restart your guest system to finish removing the guest drivers."
+        info "You may need to restart your guest system to finish removing the guest drivers."
     rm -f $userdev || fail "Cannot unlink $userdev"
     rm -f $dev || fail "Cannot unlink $dev"
-    succ_msg
     return 0
 }
@@ -279 +288 @@
 cleanup_modules()
 {
-    begin "Removing existing VirtualBox kernel modules"
+    log "Removing existing VirtualBox kernel modules."
     for i in ${OLDMODULES}; do
         # We no longer support DKMS, remove any leftovers.
@@ -291 +300 @@
     done
     rm -f /etc/depmod.d/vboxvideo-upstream.conf
-    succ_msg
 }
 
@@ -301 +309 @@
     # This does not work for 2.4 series kernels.  How sad.
     test -n "${QUICKSETUP}" && test -f "${MODULE_DIR}/vboxguest.ko" && return 0
-    begin "Building the VirtualBox Guest Additions kernel modules"
-
-    begin "Building the main Guest Additions module"
+    info "Building the VirtualBox Guest Additions kernel modules."
+
+    log "Building the main Guest Additions module."
     if ! $BUILDINTMP \
         --save-module-symvers /tmp/vboxguest-Module.symvers \
         --module-source $MODULE_SRC/vboxguest \
         --no-print-directory install >> $LOG 2>&1; then
-        show_error "Look at $LOG to find out what went wrong"
+        info "Look at $LOG to find out what went wrong"
         return 1
     fi
-    succ_msg
-    begin "Building the shared folder support module"
+    log "Building the shared folder support module"
     if ! $BUILDINTMP \
         --use-module-symvers /tmp/vboxguest-Module.symvers \
         --module-source $MODULE_SRC/vboxsf \
         --no-print-directory install >> $LOG 2>&1; then
-        show_error  "Look at $LOG to find out what went wrong"
+        info  "Look at $LOG to find out what went wrong"
         return 1
     fi
-    succ_msg
-    begin "Building the graphics driver module"
+    log "Building the graphics driver module"
     if ! $BUILDINTMP \
         --use-module-symvers /tmp/vboxguest-Module.symvers \
         --module-source $MODULE_SRC/vboxvideo \
         --no-print-directory install >> $LOG 2>&1; then
-        show_error "Look at $LOG to find out what went wrong"
-    fi
-    succ_msg
+        info "Look at $LOG to find out what went wrong"
+    fi
     echo "override vboxvideo * misc" > /etc/depmod.d/vboxvideo-upstream.conf
     depmod
@@ -338 +343 @@
 extra_setup()
 {
-    begin "Doing non-kernel setup of the Guest Additions"
-    echo "Creating user for the Guest Additions." >> $LOG
+    log "Creating user for the Guest Additions."
     # This is the LSB version of useradd and should work on recent
     # distributions
@@ -353 +357 @@
     # Create udev description file
     if [ -d /etc/udev/rules.d ]; then
-        echo "Creating udev rule for the Guest Additions kernel module." >> $LOG
+        log "Creating udev rule for the Guest Additions kernel module."
         udev_call=""
         udev_app=`which udevadm 2> /dev/null`
@@ -381 +385 @@
     # And an rc file to re-build the kernel modules and re-set-up the X server.
     ln -sf "$lib_path/$PACKAGE/vboxadd" /sbin/rcvboxadd
-    ln -sf "$lib_path/$PACKAGE/vboxadd-x11" /sbin/rcvboxadd-x11
     # And a post-installation script for rebuilding modules when a new kernel
     # is installed.
@@ -408 +411 @@
         chcon -t mount_exec_t "$lib_path/$PACKAGE/mount.vboxsf"
     fi
-    succ_msg
 }
 
@@ -414 +416 @@
 setup()
 {
-    begin "Building Guest Additions kernel modules" console
+    rm -f $LOG
     if test -r $config; then
       . $config
@@ -425 +427 @@
     export USERNAME
 
-    rm -f $LOG
     MODULE_SRC="$INSTALL_DIR/src/vboxguest-$INSTALL_VER"
     BUILDINTMP="$MODULE_SRC/build_in_tmp"
@@ -434 +435 @@
     else
         mod_succ=1
-        show_error "Please check that you have gcc, make, the header files for your Linux kernel and possibly perl installed."
+        info "Please check that you have gcc, make, the header files for your Linux kernel and possibly perl installed."
     fi
     test -n "${QUICKSETUP}" && return "${mod_succ}"
@@ -440 +441 @@
     if [ "$mod_succ" -eq "0" ]; then
         if running_vboxguest || running_vboxadd; then
-            begin "You should restart your guest to make sure the new modules are actually used" console
+            info "You should restart your guest to make sure the new modules are actually used"
         fi
     fi
@@ -467 +468 @@
 
     # Clean-up X11-related bits
-    /sbin/rcvboxadd-x11 cleanup
+    "$lib_path/$PACKAGE/vboxadd-x11" cleanup 2>> "${LOG}"
 
     # Remove other files
     rm /sbin/mount.vboxsf 2>/dev/null
     rm /sbin/rcvboxadd 2>/dev/null
-    rm /sbin/rcvboxadd-x11 2>/dev/null
     rm -f /etc/kernel/postinst.d/vboxadd /etc/kernel/prerm.d/vboxadd
     rmdir -p /etc/kernel/postinst.d /etc/kernel/prerm.d 2>/dev/null
@@ -487 +487 @@
 }
 
+case "$2" in quiet)
+    QUIET=yes;;
+esac
 case "$1" in
 start)
@@ -511 +514 @@
     ;;
 *)
-    echo "Usage: $0 {start|stop|restart|status|setup|quicksetup|cleanup}"
+    echo "Usage: $0 {start|stop|restart|status|setup|quicksetup|cleanup} [quiet]"
     exit 1
 esac