#!/usr/bin/perl # -*- cperl -*- # # Copyright (c) 2007, 2012, Oracle and/or its affiliates. All rights reserved. # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; version 2 of the License. # # 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 General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program; if not, write to the Free Software # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA ############################################################################## # # This scripts creates the MySQL Server system tables. # # This script try to match the shell script version as close as possible, # but in addition being compatible with ActiveState Perl on Windows. # # All unrecognized arguments to this script are passed to mysqld. # # NOTE: This script in 5.0 doesn't really match the shell script # version 100%, it is more close to the 5.1 version. # # NOTE: This script was deliberately written to be as close to the shell # script as possible, to make the maintenance of both in parallel # easier. # ############################################################################## use Fcntl; use File::Basename; use File::Copy; use Getopt::Long; use Sys::Hostname; use Data::Dumper; use strict; Getopt::Long::Configure("pass_through"); my @args; # Argument list filled in my $basedir; ############################################################################## # # Usage information # ############################################################################## sub usage { print <{help}; if ( $opt->{'no-defaults'} && ( $opt->{'defaults-extra-file'} || $opt->{'defaults-file'} ) ) { error($opt, "Cannot use both --no-defaults and --defaults-[extra-]file"); } @args = @ARGV if $pick_args; @ARGV = @saved_ARGV; # Set back ARGV } ############################################################################## # # Try to find a specific file within --basedir which can either be a binary # release or installed source directory and return the path. # ############################################################################## sub find_in_basedir { my $opt = shift; my $mode = shift; # "dir" or "file" my $files = shift; foreach my $file ( @{ref($files) ? $files : [$files]} ) { foreach my $dir ( @_ ) { foreach my $part ( "$file","$file.exe","release/$file.exe", "debug/$file.exe","relwithdebinfo/$file.exe" ) { my $path = "$basedir/$dir/$part"; if ( -f $path ) { return $mode eq "dir" ? dirname($path) : $path; } } } } } ############################################################################## # # Just a function to write out an error report # ############################################################################## sub cannot_find_file { my $file = shift; print "FATAL ERROR: Could not find $file\n"; print "\n"; print "If you compiled from source, you need to run 'make install' to\n"; print "copy the software into the correct location ready for operation.\n"; print "\n"; print "If you are using a binary release, you must either be at the top\n"; print "level of the extracted archive, or pass the --basedir option\n"; print "pointing to that location.\n"; print "\n"; exit 1; } ############################################################################## # # Form a command line that can handle spaces in paths and arguments # ############################################################################## # FIXME this backslash escaping needed if using '"..."' ? # This regexp makes sure that any special chars are quoted, # so the arg gets passed exactly to the server. # XXX: This is broken; true fix requires using eval and proper # quoting of every single arg ($opt->{basedir}, $opt->{ldata}, etc.) # join(" ", map {s/([^\w\_\.\-])/\\$1/g} sub quote_options { my @cmd; foreach my $opt ( @_ ) { next unless $opt; # If undefined or empty, just skip push(@cmd, "\"$opt\""); # Quote argument } return join(" ", @cmd); } ############################################################################## # # Simple escape mechanism (\-escape any ' and \), suitable for two contexts: # - single-quoted SQL strings # - single-quoted option values on the right hand side of = in my.cnf # ############################################################################## # (Function and comment copied from 'mysql_secure_installation') # These two contexts don't handle escapes identically. SQL strings allow # quoting any character (\C => C, for any C), but my.cnf parsing allows # quoting only \, ' or ". For example, password='a\b' quotes a 3-character # string in my.cnf, but a 2-character string in SQL. # # This simple escape works correctly in both places. # FIXME: What about double quote in password? Not handled here - not needed? sub basic_single_escape { my ($str) = @_; # Inside a character class, \ is not special; this escapes both \ and ' $str =~ s/([\'])/\\$1/g; return $str; } ############################################################################## # # Handle the files with confidential contents # ############################################################################## my $secret_file; # full path name of the confidential file my $escaped_password; # the password, with special characters escaped sub ensure_secret_file { $secret_file = $ENV{HOME} . "/.mysql_secret"; # Create safe files to avoid leaking info to other users # Loop may be extended if we need more ... foreach my $file ( $secret_file ) { next if -f $file; # Already exists local *FILE; sysopen(FILE, $file, O_CREAT, 0600) or die "ERROR: can't create $file: $!"; close FILE; } } ############################################################################## # # Append an arbitrary number of lines to an existing file # ############################################################################## sub append_file { my $file = shift; -f $file or die "ERROR: file is missing \"$file\": $!"; open(FILE, ">>$file") or die "ERROR: can't append to file \"$file\": $!"; foreach my $line ( @_ ) { print FILE $line, "\n"; # Add EOL char } close FILE; } ############################################################################## # # Inform the user about the generated random password # ############################################################################## sub tell_root_password { my $now = localtime(); # scalar context = printable string # Now, we need to tell the user the new root password. # We use "append_file" to protect the user in case they are doing multiple # installations intermixed with backups and restores. # While this would be really bad practice, it still might happen. # As long as this file is not destroyed, the time stamps may rescue them. # Having the comment and the password on the same line makes it easier # to automatically extract the password (automated testing!), and the final # empty line is for better redability. append_file($secret_file, "# The random password set for the root user at $now (local time): " . $escaped_password, ""); print "A random root password has been set. You will find it in '$secret_file'.\n"; } ############################################################################## # # Generate a random password # ############################################################################## sub generate_random_password { # On (at least) Linux and Solaris, a "random" device is available, use it: # cat /dev/urandom | LC_ALL=C tr -dc "[:alnum:]" | fold -w 8 | head -1 # Without LC_ALL, "tr" may not know the "alnum" character class - # and there are user profiles which do not have this set. # my $password = `cat /dev/urandom | LC_ALL=C tr -dc "[:alnum:]" | fold -w 8 | head -1`; chomp ($password); return $password; } ############################################################################## # # Ok, let's go. We first need to parse arguments which are required by # my_print_defaults so that we can execute it first, then later re-parse # the command line to add any extra bits that we need. # ############################################################################## my $opt = {}; parse_arguments($opt, 'PICK-ARGS-FROM-ARGV', @ARGV); # ---------------------------------------------------------------------- # Actual basedir, not to be confused with --basedir option # ---------------------------------------------------------------------- if ( $opt->{srcdir} ) { $basedir= $opt->{builddir}; } else { $basedir= $opt->{basedir}; } $basedir= "/usr" if ! $basedir; # Default # ---------------------------------------------------------------------- # We can now find my_print_defaults. This script supports: # # --srcdir=path pointing to compiled source tree # --basedir=path pointing to installed binary location # # or default to compiled-in locations. # ---------------------------------------------------------------------- my $print_defaults; if ( $opt->{srcdir} and $opt->{basedir} ) { error($opt, "Specify either --basedir or --srcdir, not both"); } if ( $opt->{srcdir} ) { $opt->{builddir} = $opt->{srcdir} unless $opt->{builddir}; $print_defaults = "$opt->{builddir}/extra/my_print_defaults"; } else { $print_defaults = find_in_basedir($opt,"file","my_print_defaults","bin","extra"); } if ( ! $print_defaults ) { $print_defaults='/usr/bin/my_print_defaults'; } -x $print_defaults or -f "$print_defaults.exe" or cannot_find_file($print_defaults); my $config_file; my $copy_cfg_file; # ---------------------------------------------------------------------- # This will be the default config file # ---------------------------------------------------------------------- $config_file= "$basedir/my.cnf"; my $cfg_template= find_in_basedir($opt,"file","my-default.cnf", "share","share/mysql","support-files"); -e $cfg_template or cannot_find_file("my-default.cnf"); $copy_cfg_file= $config_file; if (-e $copy_cfg_file) { $copy_cfg_file =~ s/my.cnf/my-new.cnf/; # Too early to print warning here, the user may not notice } open (TEMPL, $cfg_template) or error($opt, "Could not open config template"); open (CFG, "> $copy_cfg_file") or error($opt, "Could not open config file"); while () { # Remove lines beginning with # *** which are template comments print CFG $_ unless /^# \*\*\*/; } close CFG; close TEMPL; # ---------------------------------------------------------------------- # Now we can get arguments from the groups [mysqld] and [mysql_install_db] # in the my.cfg file, then re-run to merge with command line arguments. # ---------------------------------------------------------------------- my $print_def_file; if ( $opt->{'defaults-file'} ) { $print_def_file= $opt->{'defaults-file'}; } else { $print_def_file= $config_file; } my @default_options; my $cmd = quote_options($print_defaults,"--defaults-file=$print_def_file", "mysqld","mysql_install_db"); open(PIPE, "$cmd |") or error($opt,"can't run $cmd: $!"); while ( ) { chomp; next unless /\S/; push(@default_options, $_); } close PIPE; $opt = {}; # Reset the arguments FIXME ? parse_arguments($opt, @default_options); parse_arguments($opt, 'PICK-ARGS-FROM-ARGV', @ARGV); # ---------------------------------------------------------------------- # Create a random password for root, if requested and implemented # ---------------------------------------------------------------------- if ( $opt->{'random-passwords'} ) { # Add other non-working OS like this: $^O =~ m/^(solaris|linux|freebsd|darwin)$/ # and maintain "usage()". # Issue 1: random password creation # Issue 2: confidential file if ( $^O =~ m/^(MSWin32|cygwin)$/ ) { print "Random password not yet implemented for $^O - option will be ignored\n"; delete $opt->{'random-passwords'}; } else { ensure_secret_file(); my $password = generate_random_password(); if ( $password ) { # "true" means "string is non-empty" $escaped_password = basic_single_escape($password); } else { # Whatever the reason (missing "/dev/urandom"), an empty password is bad print "Could not generate a random password - not setting one\n"; delete $opt->{'random-passwords'}; } } } # ---------------------------------------------------------------------- # Configure paths to support files # ---------------------------------------------------------------------- # FIXME $extra_bindir is not used my ($bindir,$extra_bindir,$mysqld,$pkgdatadir,$mysqld_opt,$scriptdir); if ( $opt->{srcdir} ) { $bindir = "$basedir/client"; $extra_bindir = "$basedir/extra"; $mysqld = "$basedir/sql/mysqld"; $mysqld_opt = "--language=$opt->{srcdir}/sql/share/english"; $pkgdatadir = "$opt->{srcdir}/scripts"; $scriptdir = "$opt->{srcdir}/scripts"; } elsif ( $opt->{basedir} ) { $bindir = "$opt->{basedir}/bin"; $extra_bindir = $bindir; $mysqld = find_in_basedir($opt,"file",["mysqld-nt","mysqld"], "libexec","sbin","bin") || # ,"sql" find_in_basedir($opt,"file","mysqld-nt", "bin"); # ,"sql" $pkgdatadir = find_in_basedir($opt,"dir","fill_help_tables.sql", "share","share/mysql"); # ,"scripts" $scriptdir = "$opt->{basedir}/scripts"; } else { $bindir = '/usr/bin'; $extra_bindir = $bindir; $mysqld = '/usr/sbin/mysqld'; $pkgdatadir = '/usr/share/mysql'; $scriptdir = '/usr/bin'; } unless ( $opt->{ldata} ) { $opt->{ldata} = '/var/lib/mysql'; } if ( $opt->{srcdir} ) { $pkgdatadir = "$opt->{srcdir}/scripts"; } # ---------------------------------------------------------------------- # Set up paths to SQL scripts required for bootstrap # ---------------------------------------------------------------------- my $fill_help_tables = "$pkgdatadir/fill_help_tables.sql"; my $create_system_tables = "$pkgdatadir/mysql_system_tables.sql"; my $fill_system_tables = "$pkgdatadir/mysql_system_tables_data.sql"; my $security_commands = "$pkgdatadir/mysql_security_commands.sql"; foreach my $f ( $fill_help_tables, $create_system_tables, $fill_system_tables, $security_commands ) { -f $f or cannot_find_file($f); } -x $mysqld or -f "$mysqld.exe" or cannot_find_file($mysqld); # Try to determine the hostname my $hostname = hostname(); # ---------------------------------------------------------------------- # Check if hostname is valid # ---------------------------------------------------------------------- my $resolved; if ( !$opt->{'cross-bootstrap'} and !$opt->{rpm} and !$opt->{force} ) { my $resolveip = "$extra_bindir/resolveip"; $resolved = `$resolveip $hostname 2>&1`; if ( $? != 0 ) { $resolved=`$resolveip localhost 2>&1`; if ( $? != 0 ) { error($opt, "Neither host '$hostname' nor 'localhost' could be looked up with", "$resolveip", "Please configure the 'hostname' command to return a correct", "hostname.", "If you want to solve this at a later stage, restart this script", "with the --force option"); } warning($opt, "The host '$hostname' could not be looked up with $resolveip.", "This probably means that your libc libraries are not 100 % compatible", "with this binary MySQL version. The MySQL daemon, mysqld, should work", "normally with the exception that host name resolving will not work.", "This means that you should use IP addresses instead of hostnames", "when specifying MySQL privileges !"); } } # FIXME what does this really mean.... if ( $opt->{'skip-name-resolve'} and $resolved and $resolved =~ /\s/ ) { $hostname = (split(' ', $resolved))[5]; } # ---------------------------------------------------------------------- # Create database directories mysql & test # ---------------------------------------------------------------------- # FIXME The shell variant uses "mkdir -p": # - because it is silent if the target exists, or # - because it will cerate the path? # Path creation is demanded by testers in bug# 14731457, but that might be risky # in case of typos as this is run by root. # For now, give an error message: my $parent = dirname ( $opt->{ldata} ); if ( ! -d $parent ) { error($opt, "The parent directory for the data directory '$opt->{ldata}' does not exist.", "If that path was really intended, please create that directory path and then", "restart this script.", "If some other path was intended, please use the correct path when restarting this script."); } my $opt_user= $opt->{user}; my @pwnam; if ($opt_user) { if ( $^O =~ m/^(MSWin32|cygwin)$/ ) { warning($opt, "The --user option is not supported on Windows, ignoring"); $opt_user= undef; } else { @pwnam= getpwnam($opt_user); } } foreach my $dir ( $opt->{ldata}, "$opt->{ldata}/mysql", "$opt->{ldata}/test" ) { mkdir($dir, 0700) unless -d $dir; if ($opt_user and -w "/") { chown($pwnam[2], $pwnam[3], $dir) or error($opt, "Could not chown directory $dir"); } } push(@args, "--user=$opt->{user}") if $opt->{user}; # ---------------------------------------------------------------------- # Configure mysqld command line # ---------------------------------------------------------------------- # FIXME use --init-file instead of --bootstrap ?! my $defaults_option = ""; if ( $opt->{'no-defaults'} ) { $defaults_option= "--no-defaults"; } elsif ( $opt->{'defaults-file'} ) { $defaults_option= "--defaults-file=$opt->{'defaults-file'}"; } my $defaults_extra= "--defaults-extra-file=$opt->{'defaults-extra-file'}" if $opt->{'defaults-extra-file'}; my $mysqld_bootstrap = $ENV{MYSQLD_BOOTSTRAP} || $mysqld; my $mysqld_install_cmd_line = quote_options($mysqld_bootstrap, $defaults_option, $defaults_extra, $mysqld_opt, "--bootstrap", "--basedir=$basedir", "--datadir=$opt->{ldata}", "--log-warnings=0", "--loose-skip-ndbcluster", "--max_allowed_packet=8M", "--default-storage-engine=MyISAM", "--net_buffer_length=16K", @args, ); # ---------------------------------------------------------------------- # Create the system and help tables by passing them to "mysqld --bootstrap" # ---------------------------------------------------------------------- report_verbose_wait($opt,"Installing MySQL system tables..."); open(SQL, $create_system_tables) or error($opt,"can't open $create_system_tables for reading: $!"); open(SQL2, $fill_system_tables) or error($opt,"can't open $fill_system_tables for reading: $!"); # FIXME > /dev/null ? if ( open(PIPE, "| $mysqld_install_cmd_line") ) { print PIPE "use mysql;\n"; while ( ) { # When doing a "cross bootstrap" install, no reference to the current # host should be added to the system tables. So we filter out any # lines which contain the current host name. next if $opt->{'cross-bootstrap'} and /\@current_hostname/; print PIPE $_; } while ( ) { # When doing a "cross bootstrap" install, no reference to the current # host should be added to the system tables. So we filter out any # lines which contain the current host name. next if $opt->{'cross-bootstrap'} and /\@current_hostname/; print PIPE $_; } if ( $opt->{'random-passwords'} ) { open(SQL3, $security_commands) or error($opt,"can't open $security_commands for reading: $!"); while ( ) { # using the implicit variable $_ ! s/ABC123xyz/$escaped_password/e ; # Replace placeholder by random password print PIPE $_; } close SQL3; tell_root_password(); } close PIPE; close SQL; close SQL2; report_verbose($opt,"OK"); # ---------------------------------------------------------------------- # Pipe fill_help_tables.sql to "mysqld --bootstrap" # ---------------------------------------------------------------------- report_verbose_wait($opt,"Filling help tables..."); open(SQL, $fill_help_tables) or error($opt,"can't open $fill_help_tables for reading: $!"); # FIXME > /dev/null ? if ( open(PIPE, "| $mysqld_install_cmd_line") ) { print PIPE "use mysql;\n"; while ( ) { print PIPE $_; } close PIPE; close SQL; report_verbose($opt,"OK"); } else { warning($opt,"HELP FILES ARE NOT COMPLETELY INSTALLED!", "The \"HELP\" command might not work properly"); } report_verbose($opt,"To start mysqld at boot time you have to copy", "support-files/mysql.server to the right place " . "for your system"); if ( !$opt->{'cross-bootstrap'} ) { # This is not a true installation on a running system. The end user must # set a password after installing the data files on the real host system. # At this point, there is no end user, so it does not make sense to print # this reminder. if ( $opt->{'random-passwords'} ) { report($opt, "A RANDOM PASSWORD HAS BEEN SET FOR THE MySQL root USER !", "You will find that password in '$secret_file'.", "", "You must change that password on your first connect,", "no other statement but 'SET PASSWORD' will be accepted.", "See the manual for the semantics of the 'password expired' flag.", "", "Also, the account for the anonymous user has been removed.", "", "In addition, you can run:", "", " $bindir/mysql_secure_installation", "", "which will also give you the option of removing the test database.", "This is strongly recommended for production servers.", "", "See the manual for more instructions."); } else { report($opt, "PLEASE REMEMBER TO SET A PASSWORD FOR THE MySQL root USER !", "To do so, start the server, then issue the following commands:", "", " $bindir/mysqladmin -u root password 'new-password'", " $bindir/mysqladmin -u root -h $hostname password 'new-password'", "", "Alternatively you can run:", "", " $bindir/mysql_secure_installation", "", "which will also give you the option of removing the test", "databases and anonymous user created by default. This is", "strongly recommended for production servers.", "", "See the manual for more instructions."); } if ( !$opt->{rpm} ) { report($opt, "You can start the MySQL daemon with:", "", " cd " . '/usr' . " ; $bindir/mysqld_safe &", "", "You can test the MySQL daemon with mysql-test-run.pl", "", " cd mysql-test ; perl mysql-test-run.pl"); } report($opt, "Please report any problems with the " . '/usr/bin' . "/mysqlbug script!", "", "The latest information about MySQL is available on the web at", "", " http://www.mysql.com", "", "Support MySQL by buying support/licenses at http://shop.mysql.com"); if ($copy_cfg_file eq $config_file) { report($opt, "New default config file was created as $config_file and", "will be used by default by the server when you start it.", "You may edit this file to change server settings"); } else { warning($opt, "Found existing config file $config_file on the system.", "Because this file might be in use, it was not replaced,", "but was used in bootstrap (unless you used --defaults-file)", "and when you later start the server.", "The new default config file was created as $copy_cfg_file,", "please compare it with your file and take the changes you need."); } foreach my $cfg ( "/etc/my.cnf", "/etc/mysql/my.cnf" ) { check_sys_cfg_file ($opt, $cfg); } } exit 0 } else { error($opt, "Installation of system tables failed!", "", "Examine the logs in $opt->{ldata} for more information.", "You can try to start the mysqld daemon with:", "$mysqld --skip-grant-tables &", "and use the command line tool", "$bindir/mysql to connect to the mysql", "database and look at the grant tables:", "", "shell> $bindir/mysql -u root mysql", "mysql> show tables", "", "Try 'mysqld --help' if you have problems with paths. Using --log", "gives you a log in $opt->{ldata} that may be helpful.", "", "The latest information about MySQL is available on the web at", "http://www.mysql.com", "Please consult the MySQL manual section: 'Problems running mysql_install_db',", "and the manual section that describes problems on your OS.", "Another information source is the MySQL email archive.", "Please check all of the above before mailing us!", "And if you do mail us, you MUST use the " . '/usr/bin' . "/mysqlbug script!") } ############################################################################## # # Misc # ############################################################################## sub check_sys_cfg_file { my $opt= shift; my $fname= shift; if ( -e $fname ) { warning($opt, "Default config file $fname exists on the system", "This file will be read by default by the MySQL server", "If you do not want to use this, either remove it, or use the", "--defaults-file argument to mysqld_safe when starting the server"); } } sub report_verbose { my $opt = shift; my $text = shift; report_verbose_wait($opt, $text, @_); print "\n\n"; } sub report_verbose_wait { my $opt = shift; my $text = shift; if ( $opt->{verbose} or (!$opt->{rpm} and !$opt->{'cross-bootstrap'}) ) { print "$text"; map {print "\n$_"} @_; } } sub report { my $opt = shift; my $text = shift; print "$text\n"; map {print "$_\n"} @_; print "\n"; } sub error { my $opt = shift; my $text = shift; print "FATAL ERROR: $text\n"; map {print "$_\n"} @_; exit 1; } sub warning { my $opt = shift; my $text = shift; print "WARNING: $text\n"; map {print "$_\n"} @_; print "\n"; } # Include dummy lines with patterns that generalized pkgadd script expects my $_pkgadd_fodder= " basedir=foo datadir=bar ";