VirtualBox

source: vbox/trunk/src/VBox/Installer/linux/install.sh

Last change on this file was 106061, checked in by vboxsync, 3 weeks ago

Copyright year updates by scm.

  • Property svn:eol-style set to LF
  • Property svn:keywords set to Author Date Id Revision
File size: 15.8 KB
Line 
1#!/bin/sh
2#
3# Oracle VirtualBox
4# VirtualBox linux installation script
5
6#
7# Copyright (C) 2007-2024 Oracle and/or its affiliates.
8#
9# This file is part of VirtualBox base platform packages, as
10# available from https://www.virtualbox.org.
11#
12# This program is free software; you can redistribute it and/or
13# modify it under the terms of the GNU General Public License
14# as published by the Free Software Foundation, in version 3 of the
15# License.
16#
17# This program is distributed in the hope that it will be useful, but
18# WITHOUT ANY WARRANTY; without even the implied warranty of
19# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20# General Public License for more details.
21#
22# You should have received a copy of the GNU General Public License
23# along with this program; if not, see <https://www.gnu.org/licenses>.
24#
25# SPDX-License-Identifier: GPL-3.0-only
26#
27
28# Testing:
29# * After successful installation, 0 is returned if the vboxdrv module version
30# built matches the one loaded.
31# * If the kernel modules cannot be built (run the installer with KERN_VER=none)
32# or loaded (run with KERN_VER=<installed non-current version>)
33# then 1 is returned.
34
35PATH=$PATH:/bin:/sbin:/usr/sbin
36
37# Include routines and utilities needed by the installer
38. ./routines.sh
39
40LOG="/var/log/vbox-install.log"
41VERSION="_VERSION_"
42SVNREV="_SVNREV_"
43BUILD="_BUILD_"
44ARCH="_ARCH_"
45HARDENED="_HARDENED_"
46# The "BUILD_" prefixes prevent the variables from being overwritten when we
47# read the configuration from the previous installation.
48BUILD_VBOX_KBUILD_TYPE="_BUILDTYPE_"
49BUILD_USERNAME="_USERNAME_"
50CONFIG_DIR="/etc/vbox"
51CONFIG="vbox.cfg"
52CONFIG_FILES="filelist"
53DEFAULT_FILES=`pwd`/deffiles
54GROUPNAME="vboxusers"
55INSTALLATION_DIR="_INSTALLATION_DIR_"
56LICENSE_ACCEPTED=""
57PREV_INSTALLATION=""
58PYTHON="_PYTHON_"
59ACTION=""
60SELF=$1
61RC_SCRIPT=0
62if [ -n "$HARDENED" ]; then
63 VBOXDRV_MODE=0600
64 VBOXDRV_GRP="root"
65else
66 VBOXDRV_MODE=0660
67 VBOXDRV_GRP=$GROUPNAME
68fi
69VBOXUSB_MODE=0664
70VBOXUSB_GRP=$GROUPNAME
71
72## Were we able to stop any previously running Additions kernel modules?
73MODULES_STOPPED=1
74
75
76##############################################################################
77# Helper routines #
78##############################################################################
79
80usage() {
81 info ""
82 info "Usage: install | uninstall"
83 info ""
84 info "Example:"
85 info "$SELF install"
86 exit 1
87}
88
89module_loaded() {
90 lsmod | grep -q "vboxdrv[^_-]"
91}
92
93# This routine makes sure that there is no previous installation of
94# VirtualBox other than one installed using this install script or a
95# compatible method. We do this by checking for any of the VirtualBox
96# applications in /usr/bin. If these exist and are not symlinks into
97# the installation directory, then we assume that they are from an
98# incompatible previous installation.
99
100## Helper routine: test for a particular VirtualBox binary and see if it
101## is a link into a previous installation directory
102##
103## Arguments: 1) the binary to search for and
104## 2) the installation directory (if any)
105## Returns: false if an incompatible version was detected, true otherwise
106check_binary() {
107 binary=$1
108 install_dir=$2
109 test ! -e $binary 2>&1 > /dev/null ||
110 ( test -n "$install_dir" &&
111 readlink $binary 2>/dev/null | grep "$install_dir" > /dev/null
112 )
113}
114
115## Main routine
116##
117## Argument: the directory where the previous installation should be
118## located. If this is empty, then we will assume that any
119## installation of VirtualBox found is incompatible with this one.
120## Returns: false if an incompatible installation was found, true otherwise
121check_previous() {
122 install_dir=$1
123 # These should all be symlinks into the installation folder
124 check_binary "/usr/bin/VirtualBox" "$install_dir" &&
125 check_binary "/usr/bin/VBoxManage" "$install_dir" &&
126 check_binary "/usr/bin/VBoxSDL" "$install_dir" &&
127 check_binary "/usr/bin/VBoxVRDP" "$install_dir" &&
128 check_binary "/usr/bin/VBoxHeadless" "$install_dir" &&
129 check_binary "/usr/bin/VBoxDTrace" "$install_dir" &&
130 check_binary "/usr/bin/VBoxBugReport" "$install_dir" &&
131 check_binary "/usr/bin/VBoxBalloonCtrl" "$install_dir" &&
132 check_binary "/usr/bin/VBoxAutostart" "$install_dir" &&
133 check_binary "/usr/bin/vboxwebsrv" "$install_dir" &&
134 check_binary "/usr/bin/vbox-img" "$install_dir" &&
135 check_binary "/usr/bin/vboximg-mount" "$install_dir" &&
136 check_binary "/sbin/rcvboxdrv" "$install_dir"
137}
138
139##############################################################################
140# Main script #
141##############################################################################
142
143info "VirtualBox Version $VERSION r$SVNREV ($BUILD) installer"
144
145
146# Make sure that we were invoked as root...
147check_root
148
149# Set up logging before anything else
150create_log $LOG
151
152log "VirtualBox $VERSION r$SVNREV installer, built $BUILD."
153log ""
154log "Testing system setup..."
155
156# Sanity check: figure out whether build arch matches uname arch
157cpu=`uname -m`;
158case "$cpu" in
159 i[3456789]86|x86)
160 cpu="x86"
161 ;;
162 x86_64)
163 cpu="amd64"
164 ;;
165 aarch64|arm64)
166 cpu="arm64"
167 ;;
168esac
169if [ "$cpu" != "$ARCH" ]; then
170 info "Detected unsupported $cpu environment."
171 log "Detected unsupported $cpu environment."
172 exit 1
173fi
174
175# Sensible default actions
176ACTION="install"
177BUILD_MODULE="true"
178unset FORCE_UPGRADE
179while true
180do
181 if [ "$2" = "" ]; then
182 break
183 fi
184 shift
185 case "$1" in
186 install|--install)
187 ACTION="install"
188 ;;
189
190 uninstall|--uninstall)
191 ACTION="uninstall"
192 ;;
193
194 force|--force)
195 FORCE_UPGRADE=1
196 ;;
197 license_accepted_unconditionally|--license_accepted_unconditionally)
198 # Legacy option
199 ;;
200 no_module|--no_module)
201 BUILD_MODULE=""
202 ;;
203 *)
204 if [ "$ACTION" = "" ]; then
205 info "Unknown command '$1'."
206 usage
207 fi
208 info "Specifying an installation path is not allowed -- using _INSTALLATION_DIR_!"
209 ;;
210 esac
211done
212
213if [ "$ACTION" = "install" ]; then
214 # Choose a proper umask
215 umask 022
216
217 # Find previous installation
218 if test -r "$CONFIG_DIR/$CONFIG"; then
219 . $CONFIG_DIR/$CONFIG
220 PREV_INSTALLATION=$INSTALL_DIR
221 fi
222 if ! check_previous $INSTALL_DIR && test -z "$FORCE_UPGRADE"
223 then
224 info
225 info "You appear to have a version of VirtualBox on your system which was installed"
226 info "from a different source or using a different type of installer (or a damaged"
227 info "installation of VirtualBox). We strongly recommend that you remove it before"
228 info "installing this version of VirtualBox."
229 info
230 info "Do you wish to continue anyway? [yes or no]"
231 read reply dummy
232 if ! expr "$reply" : [yY] && ! expr "$reply" : [yY][eE][sS]
233 then
234 info
235 info "Cancelling installation."
236 log "User requested cancellation of the installation"
237 exit 1
238 fi
239 fi
240
241 # Do additional clean-up in case some-one is running from a build folder.
242 ./prerm-common.sh || exit 1
243
244 # Remove previous installation
245 test "${BUILD_MODULE}" = true || VBOX_DONT_REMOVE_OLD_MODULES=1
246
247 if [ -n "$PREV_INSTALLATION" ]; then
248 [ -n "$INSTALL_REV" ] && INSTALL_REV=" r$INSTALL_REV"
249 info "Removing previous installation of VirtualBox $INSTALL_VER$INSTALL_REV from $PREV_INSTALLATION"
250 log "Removing previous installation of VirtualBox $INSTALL_VER$INSTALL_REV from $PREV_INSTALLATION"
251 log ""
252
253 VBOX_NO_UNINSTALL_MESSAGE=1
254 # This also checks $BUILD_MODULE and $VBOX_DONT_REMOVE_OLD_MODULES
255 . ./uninstall.sh
256 fi
257
258 mkdir -p -m 755 $CONFIG_DIR
259 touch $CONFIG_DIR/$CONFIG
260
261 info "Installing VirtualBox to $INSTALLATION_DIR"
262 log "Installing VirtualBox to $INSTALLATION_DIR"
263 log ""
264
265 # Verify the archive
266 mkdir -p -m 755 $INSTALLATION_DIR
267 bzip2 -d -c VirtualBox.tar.bz2 > VirtualBox.tar
268 if ! tar -tf VirtualBox.tar > $CONFIG_DIR/$CONFIG_FILES; then
269 rmdir $INSTALLATION_DIR 2> /dev/null
270 rm -f $CONFIG_DIR/$CONFIG 2> /dev/null
271 rm -f $CONFIG_DIR/$CONFIG_FILES 2> /dev/null
272 log 'Error running "bzip2 -d -c VirtualBox.tar.bz2" or "tar -tf VirtualBox.tar".'
273 abort "Error installing VirtualBox. Installation aborted"
274 fi
275
276 # Create installation directory and install
277 if ! tar -xf VirtualBox.tar -C $INSTALLATION_DIR; then
278 cwd=`pwd`
279 cd $INSTALLATION_DIR
280 rm -f `cat $CONFIG_DIR/$CONFIG_FILES` 2> /dev/null
281 cd $pwd
282 rmdir $INSTALLATION_DIR 2> /dev/null
283 rm -f $CONFIG_DIR/$CONFIG 2> /dev/null
284 log 'Error running "tar -xf VirtualBox.tar -C '"$INSTALLATION_DIR"'".'
285 abort "Error installing VirtualBox. Installation aborted"
286 fi
287
288 cp uninstall.sh $INSTALLATION_DIR
289 echo "uninstall.sh" >> $CONFIG_DIR/$CONFIG_FILES
290
291 # Hardened build: Mark selected binaries set-user-ID-on-execution,
292 # create symlinks for working around unsupported $ORIGIN/.. in VBoxC.so (setuid),
293 # and finally make sure the directory is only writable by the user (paranoid).
294 if [ -n "$HARDENED" ]; then
295 # Note! Update vboxdrv.sh if the VirtualBoxVM entry changes (bugref:10642).
296 test -e $INSTALLATION_DIR/VirtualBoxVM && chmod 4511 $INSTALLATION_DIR/VirtualBoxVM
297 test -e $INSTALLATION_DIR/VBoxSDL && chmod 4511 $INSTALLATION_DIR/VBoxSDL
298 test -e $INSTALLATION_DIR/VBoxHeadless && chmod 4511 $INSTALLATION_DIR/VBoxHeadless
299 test -e $INSTALLATION_DIR/VBoxNetDHCP && chmod 4511 $INSTALLATION_DIR/VBoxNetDHCP
300 test -e $INSTALLATION_DIR/VBoxNetNAT && chmod 4511 $INSTALLATION_DIR/VBoxNetNAT
301
302 ln -sf $INSTALLATION_DIR/VBoxVMM.so $INSTALLATION_DIR/components/VBoxVMM.so
303 ln -sf $INSTALLATION_DIR/VBoxRT.so $INSTALLATION_DIR/components/VBoxRT.so
304
305 chmod go-w $INSTALLATION_DIR
306 fi
307
308 # This binaries need to be suid root in any case, even if not hardened
309 test -e $INSTALLATION_DIR/VBoxNetAdpCtl && chmod 4511 $INSTALLATION_DIR/VBoxNetAdpCtl
310 test -e $INSTALLATION_DIR/VBoxVolInfo && chmod 4511 $INSTALLATION_DIR/VBoxVolInfo
311
312 # Write the configuration. Needs to be done before the vboxdrv service is
313 # started.
314 echo "# VirtualBox installation directory" > $CONFIG_DIR/$CONFIG
315 echo "INSTALL_DIR='$INSTALLATION_DIR'" >> $CONFIG_DIR/$CONFIG
316 echo "# VirtualBox version" >> $CONFIG_DIR/$CONFIG
317 echo "INSTALL_VER='$VERSION'" >> $CONFIG_DIR/$CONFIG
318 echo "INSTALL_REV='$SVNREV'" >> $CONFIG_DIR/$CONFIG
319 echo "# Build type and user name for logging purposes" >> $CONFIG_DIR/$CONFIG
320 echo "VBOX_KBUILD_TYPE='$BUILD_VBOX_KBUILD_TYPE'" >> $CONFIG_DIR/$CONFIG
321 echo "USERNAME='$BUILD_USERNAME'" >> $CONFIG_DIR/$CONFIG
322
323 # Create users group
324 groupadd -r -f $GROUPNAME 2> /dev/null
325
326 # Create symlinks to start binaries
327 ln -sf $INSTALLATION_DIR/VBox.sh /usr/bin/VirtualBox
328 ln -sf $INSTALLATION_DIR/VBox.sh /usr/bin/VirtualBoxVM
329 ln -sf $INSTALLATION_DIR/VBox.sh /usr/bin/VBoxManage
330 ln -sf $INSTALLATION_DIR/VBox.sh /usr/bin/VBoxSDL
331 ln -sf $INSTALLATION_DIR/VBox.sh /usr/bin/VBoxVRDP
332 ln -sf $INSTALLATION_DIR/VBox.sh /usr/bin/VBoxHeadless
333 if [ -f $INSTALLATION_DIR/VBoxBalloonCtrl ]; then
334 ln -sf $INSTALLATION_DIR/VBox.sh /usr/bin/VBoxBalloonCtrl
335 fi
336 if [ -f $INSTALLATION_DIR/VBoxBugReport ]; then
337 ln -sf $INSTALLATION_DIR/VBox.sh /usr/bin/VBoxBugReport
338 fi
339 ln -sf $INSTALLATION_DIR/VBox.sh /usr/bin/VBoxAutostart
340 if [ -f $INSTALLATION_DIR/vboxwebsrv ]; then
341 ln -sf $INSTALLATION_DIR/VBox.sh /usr/bin/vboxwebsrv
342 fi
343 ln -sf $INSTALLATION_DIR/vbox-img /usr/bin/vbox-img
344 ln -sf $INSTALLATION_DIR/vboximg-mount /usr/bin/vboximg-mount
345 if [ -d /usr/share/pixmaps/ ]; then
346 ln -sf $INSTALLATION_DIR/VBox.png /usr/share/pixmaps/VBox.png
347 fi
348 if [ -f $INSTALLATION_DIR/VBoxDTrace ]; then
349 ln -sf $INSTALLATION_DIR/VBox.sh /usr/bin/VBoxDTrace
350 fi
351 if [ -f $INSTALLATION_DIR/VBoxAudioTest ]; then
352 ln -sf $INSTALLATION_DIR/VBox.sh /usr/bin/VBoxAudioTest
353 fi
354 # Unity and Nautilus seem to look here for their icons
355 if [ -d /usr/share/pixmaps/ ]; then
356 ln -sf $INSTALLATION_DIR/icons/128x128/virtualbox.png /usr/share/pixmaps/virtualbox.png
357 fi
358 if [ -d /usr/share/applications/ ]; then
359 ln -sf $INSTALLATION_DIR/virtualbox.desktop /usr/share/applications/virtualbox.desktop
360 ln -sf $INSTALLATION_DIR/virtualboxvm.desktop /usr/share/applications/virtualboxvm.desktop
361 fi
362 if [ -d /usr/share/mime/packages/ ]; then
363 ln -sf $INSTALLATION_DIR/virtualbox.xml /usr/share/mime/packages/virtualbox.xml
364 fi
365 ln -sf $INSTALLATION_DIR/src/vboxhost /usr/src/vboxhost-_VERSION_
366
367 # Convenience symlinks. The creation fails if the FS is not case sensitive
368 ln -sf VirtualBox /usr/bin/virtualbox > /dev/null 2>&1
369 ln -sf VirtualBoxVM /usr/bin/virtualboxvm > /dev/null 2>&1
370 ln -sf VBoxManage /usr/bin/vboxmanage > /dev/null 2>&1
371 ln -sf VBoxSDL /usr/bin/vboxsdl > /dev/null 2>&1
372 ln -sf VBoxHeadless /usr/bin/vboxheadless > /dev/null 2>&1
373 if [ -f $INSTALLATION_DIR/VBoxBugReport ]; then
374 ln -sf VBoxBugReport /usr/bin/vboxbugreport > /dev/null 2>&1
375 fi
376 if [ -f $INSTALLATION_DIR/VBoxDTrace ]; then
377 ln -sf VBoxDTrace /usr/bin/vboxdtrace > /dev/null 2>&1
378 fi
379 if [ -f $INSTALLATION_DIR/VBoxAudioTest ]; then
380 ln -sf VBoxAudioTest /usr/bin/vboxaudiotest > /dev/null 2>&1
381 fi
382
383 # Icons
384 cur=`pwd`
385 cd $INSTALLATION_DIR/icons
386 for i in *; do
387 cd $i
388 if [ -d /usr/share/icons/hicolor/$i ]; then
389 for j in *; do
390 if expr "$j" : "virtualbox\..*" > /dev/null; then
391 dst=apps
392 else
393 dst=mimetypes
394 fi
395 if [ -d /usr/share/icons/hicolor/$i/$dst ]; then
396 ln -s $INSTALLATION_DIR/icons/$i/$j /usr/share/icons/hicolor/$i/$dst/$j
397 echo /usr/share/icons/hicolor/$i/$dst/$j >> $CONFIG_DIR/$CONFIG_FILES
398 fi
399 done
400 fi
401 cd -
402 done
403 cd $cur
404
405 # Update the MIME database
406 update-mime-database /usr/share/mime 2>/dev/null
407
408 # Update the desktop database
409 update-desktop-database -q 2>/dev/null
410
411 # If Python is available, install Python bindings
412 if [ -n "$PYTHON" ]; then
413 maybe_run_python_bindings_installer $INSTALLATION_DIR $CONFIG_DIR $CONFIG_FILES
414 fi
415
416 # Do post-installation common to all installer types, currently service
417 # script set-up.
418 if test "${BUILD_MODULE}" = "true"; then
419 START_SERVICES=
420 else
421 START_SERVICES="--nostart"
422 fi
423 "${INSTALLATION_DIR}/prerm-common.sh" >> "${LOG}"
424
425 # Now check whether the kernel modules were stopped.
426 lsmod | grep -q vboxdrv && MODULES_STOPPED=
427
428 "${INSTALLATION_DIR}/postinst-common.sh" ${START_SERVICES} >> "${LOG}"
429
430 info ""
431 info "VirtualBox has been installed successfully."
432 info ""
433 info "You will find useful information about using VirtualBox in the user manual"
434 info " $INSTALLATION_DIR/UserManual.pdf"
435 info "and in the user FAQ"
436 info " http://www.virtualbox.org/wiki/User_FAQ"
437 info ""
438 info "We hope that you enjoy using VirtualBox."
439 info ""
440
441 # And do a final test as to whether the kernel modules were properly created
442 # and loaded. Return 0 if both are true, 1 if not.
443 test -n "${MODULES_STOPPED}" &&
444 modinfo vboxdrv >/dev/null 2>&1 &&
445 lsmod | grep -q vboxdrv ||
446 abort "The installation log file is at ${LOG}."
447
448 log "Installation successful"
449elif [ "$ACTION" = "uninstall" ]; then
450 . ./uninstall.sh
451fi
452exit $RC_SCRIPT
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette