--- loncom/debugging_tools/modify_config_files.pl 2004/08/11 17:32:53 1.3 +++ loncom/debugging_tools/modify_config_files.pl 2021/12/21 13:57:47 1.22 @@ -2,7 +2,7 @@ # # The LearningOnline Network # -# $Id: modify_config_files.pl,v 1.3 2004/08/11 17:32:53 matthew Exp $ +# $Id: modify_config_files.pl,v 1.22 2021/12/21 13:57:47 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -36,14 +36,26 @@ B =head1 SYNOPSIS -This script modifies /etc/yum.conf and /etc/my.cnf. +This script modifies /etc/my.cnf and one of: /etc/yum.conf +(for CentOS/Scientific Linux/RHEL >=5 and <8), /etc/apt/sources.list +(for Debian/Ubuntu), /etc/sysconfig/rhn/sources (for RHEL4), +and /etc/yum.repos.d/loncapa.repo (Fedora >= 21; Oracle Linux; +CentOS/RHEL >= 8). =head1 DESCRIPTION -This script modifies /etc/yum.conf and /etc/my.cnf to ensure certain parameters -are set properly. The LON-CAPA yum repositories are added to /etc/yum.conf. +This script modifies /etc/my.cnf, /etc/yum.conf, /etc/yum.repos.d/loncapa.repo, +/etc/apt/sources, or /etc/sysconfig/rhn/sources to ensure certain +parameters are set properly. + +The LON-CAPA yum repositories are added to /etc/yum.conf, +/etc/yum.repos.d/loncapa.repo, /etc/sysconfig/rhn/sources +and the LON-CAPA apt repositories are added to +/etc/apt/sources.list. + The /etc/my.cnf file is modified to set the wait_timeout to 1 year. Backup -copies of each file are made in /etc. +copies of each file are made in /etc, /etc/apt, and /etc/sysconfig/rhn, as +appropriate. =cut @@ -53,35 +65,243 @@ use lib '/home/httpd/lib/perl/'; use LONCAPA::Configuration; my $loncapa_config=LONCAPA::Configuration::read_conf('loncapa.conf'); -&update_file('/etc/yum.conf', - [{section => 'loncapa-updates-i386', +open(DSH,"$$loncapa_config{'lonDaemons'}/distprobe |"); +my $dist = ; +chomp($dist); +close(DSH); + +my $yum_status; +my $loninst = 'http://install.loncapa.org'; +my $loninst_re = 'http://install\.loncapa\.org'; +if ($dist =~ /^fedora(\d+)$/) { + my $file = '/etc/yum.conf'; + my $ver = $1; + my $gpgchk = '0'; + my $gpg = "$loninst/versions/fedora/RPM-GPG-KEY-loncapa"; + my $nobackup; + if ($ver > 6) { + $gpgchk = '1'; + } + if ($ver >= 21) { + $file = '/etc/yum.repos.d/loncapa.repo'; + $nobackup = 1; + } + $yum_status = + &update_file($file, + [{section => 'loncapa-updates-basearch', key => 'name=', - value => 'Fedora Core $releasever LON-CAPA i386 Updates', - }, {section => 'loncapa-updates-i386', + value => 'Fedora Core $releasever LON-CAPA $basearch Updates', + }, {section => 'loncapa-updates-basearch', key => 'baseurl=', - value => 'http://install.loncapa.org/fedora/linux/loncapa/'. - '$releasever/i386', + value => $loninst.'/fedora/linux/loncapa/$releasever/$basearch', + }, {section => 'loncapa-updates-basearch', + key => 'gpgcheck=', + value => $gpgchk, + }, {section => 'loncapa-updates-basearch', + key => 'gpgkey=', + value => $gpg, }, {section => 'loncapa-updates-noarch', key => 'name=', value => 'Fedora Core $releasever LON-CAPA noarch Updates', }, {section => 'loncapa-updates-noarch', key => 'baseurl=', - value => 'http://install.loncapa.org/fedora/linux/loncapa/'. - '$releasever/noarch', - }]); - -&update_file('/etc/my.cnf', - [{section =>'mysqld', - key =>'set-variable=wait_timeout=', - value =>'31536000', }]); + value => $loninst.'/fedora/linux/loncapa/$releasever/noarch', + }, {section => 'loncapa-updates-noarch', + key => 'gpgcheck=', + value => $gpgchk, + }, {section => 'loncapa-updates-noarch', + key => 'gpgkey=', + value => $gpg, + }],$nobackup); +} elsif ($dist =~ /^(rhes|centos|scientific|oracle|rocky|alma)(\d+)(|\-stream)$/) { + my $type = $1; + my $ver = $2; + my $stream = $3; + my $longver = $ver; + my $nobackup; + if ($type eq 'rhes') { + if ($ver == 4) { + $longver = '4ES'; + } elsif ($ver == 5) { + $longver = '5Server'; + } + } elsif ($type eq 'centos') { + $type .= $stream; + } + my %info = ( + rhes => { + title => 'RHEL', + path => 'redhat/linux/enterprise/loncapa', + gpg => 'versions/redhat/RPM-GPG-KEY-loncapa', + gpgchk => 1, + }, + centos => { + title => 'CentOS', + path => 'centos/loncapa', + gpg => 'versions/centos/RPM-GPG-KEY-loncapa', + gpgchk => 1, + }, + scientific => { + title => 'Scientific Linux', + path => 'scientific/loncapa', + gpg => 'versions/scientific/RPM-GPG-KEY-loncapa', + gpgchk => 1, + }, + oracle => { + title => 'Oracle Linux', + path => 'oracle/loncapa', + gpg => 'versions/oracle/RPM-GPG-KEY-loncapa', + gpgchk => 1, + }, + rocky => { + title => 'Rocky Linux', + path => 'rocky/loncapa', + gpg => 'versions/rocky/RPM-GPG-KEY-loncapa', + gpgchk => 1, + }, + alma => { + title => 'AlmaLinux', + path => 'alma/loncapa', + gpg => 'versions/alma/RPM-GPG-KEY-loncapa', + gpgchk => 1, + }, + centos-stream => { + title => 'CentOS Stream', + path => 'centos/loncapa', + gpg => 'versions/centos/RPM-GPG-KEY-loncapa', + gpgchk => 1, + }, + ); + if (ref($info{$type}) eq 'HASH') { + if ($ver > 4) { + my $file = '/etc/yum.conf'; + if (($ver > 7) || ($type eq 'oracle') || ($type eq 'rocky') || + ($type eq 'alma') || ($type eq 'centos-stream')) { + $file = '/etc/yum.repos.d/loncapa.repo'; + $nobackup = 1; + } + my $release = '$releasever'; + if ($type eq 'centos-stream') { + $release .= '-stream'; + } + $yum_status = + &update_file($file, + [{section => 'loncapa-updates-basearch', + key => 'name=', + value => $info{$type}{title}.' $releasever LON-CAPA $basearch Updates', + }, {section => "loncapa-updates-basearch", + key => 'baseurl=', + value => "$loninst/$info{$type}{path}/$release/".'$basearch', + }, {section => 'loncapa-updates-basearch', + key => 'gpgcheck=', + value => $info{$type}{gpgchk}, + }, {section => 'loncapa-updates-basearch', + key => 'gpgkey=', + value => "$loninst/$info{$type}{gpg}", + }, {section => 'loncapa-updates-noarch', + key => 'name=', + value => $info{$type}{title}.' $releasever LON-CAPA noarch Updates', + }, {section => 'loncapa-updates-noarch', + key => 'baseurl=', + value => "$loninst/$info{$type}{path}/$release/noarch", + }, {section => 'loncapa-updates-noarch', + key => 'gpgcheck=', + value => $info{$type}{gpgchk}, + }, {section => 'loncapa-updates-noarch', + key => 'gpgkey=', + value => "$loninst/$info{$type}{gpg}", + }],$nobackup); + } elsif (($type eq 'rhes') && ($ver == 4)) { + my %rhn = ( + basearch => { + regexp => '\s*yum\s+loncapa\-updates\-basearch\s+'.$loninst_re.'/'.$info{$type}{path}.'/'.$longver.'/\$ARCH', + text => "yum loncapa-updates-basearch $loninst/$info{$type}{path}/$longver/".'$ARCH', + }, + noarch => { + regexp => '\s*yum\s+loncapa\-updates\-noarch\s+'.$loninst_re.'/'.$info{$type}{path}.'/'.$longver.'/noarch', + text => "yum loncapa-updates-noarch $loninst/$info{$type}{path}/$longver/noarch", + }, + ); + $yum_status = &update_rhn_source(\%rhn); + } + } +} elsif ($dist =~ /^(debian|ubuntu)\d+$/) { + my %apt_get_source = ( + debian5 => { + regexp => '\s*deb\s+'.$loninst_re.'/debian/?\s+lenny\s+main', + text => "deb $loninst/debian lenny main", + }, + ubuntu6 => { + regexp => '\s*deb\s+'.$loninst_re.'/ubuntu/?\s+dapper\s+main', + text => "deb $loninst/ubuntu dapper main", + }, + ubuntu8 => { + regexp => '\s*deb\s+'.$loninst_re.'/ubuntu/?\s+hardy\s+main', + text => "deb $loninst/ubuntu hardy main", + }, + ubuntu10 => { + regexp => '\s*deb\s+'.$loninst_re.'/ubuntu/?\s+lucid\s+main', + text => "deb $loninst/ubuntu lucid main", + }, + ubuntu12 => { + regexp => '\s*deb\s+'.$loninst_re.'/ubuntu/?\s+precise\s+main', + text => "deb $loninst/ubuntu precise main", + }, + ubuntu14 => { + regexp => '\s*deb\s+'.$loninst_re.'/ubuntu/?\s+trusty\s+main', + text => "deb $loninst/ubuntu trusty main", + }, + ubuntu16 => { + regexp => '\s*deb\s+'.$loninst_re.'/ubuntu/?\s+xenial\s+main', + text => "deb $loninst/ubuntu xenial main", + }, + ubuntu18 => { + regexp => '\s*deb\s+'.$loninst_re.'/ubuntu/?\s+bionic\s+main', + text => "deb $loninst/ubuntu bionic main", + }, + ubuntu20 => { + regexp => '\s*deb\s+'.$loninst_re.'/ubuntu/?\s+focal\s+main', + text => "deb $loninst/ubuntu focal main", + }, + ); + my $apt_status; + if (defined($apt_get_source{$dist})) { + $apt_status = &update_apt_source($apt_get_source{$dist},); + } +} + +my $mysqlfile = '/etc/my.cnf'; +my $mysqlconf = [{section =>'mysqld', + key =>'wait_timeout=', + value =>'31536000'}]; +if ($dist =~ /^ubuntu(\d+)$/) { + my $version = $1; + $mysqlfile = '/etc/mysql/my.cnf'; + if ($version > 14) { + $mysqlfile = '/etc/mysql/mysql.conf.d/mysqld.cnf'; + if ($version < 20) { + push(@{$mysqlconf}, + {section =>'mysqld', + key =>'sql_mode=', + value =>'"STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"'}); + } else { + push(@{$mysqlconf}, + {section =>'mysqld', + key =>'sql_mode=', + value =>'"STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION"'}); + } + } +} +my $mysql_global_status = &update_file($mysqlfile,$mysqlconf); my $local_my_cnf = '/home/www/.my.cnf'; if (! -e $local_my_cnf) { -# # Create a file so we can do something with it... + # Create a file so we can do something with it... system("touch $local_my_cnf"); } -&update_file($local_my_cnf, +my $mysql_www_status = + &update_file($local_my_cnf, [{section =>'client', key =>'user=', value =>'www',}, @@ -89,40 +309,38 @@ if (! -e $local_my_cnf) { key =>'password=', value =>$loncapa_config->{'lonSqlAccess'}},]); -exit; +my $exitvalue = 0; +if ($mysql_global_status) { $exitvalue = 1; } +exit $exitvalue; -################################################################# -################################################################# - -=pod - -=over 4 -=cut - -################################################################# -################################################################# sub update_file { - my ($file,$newdata) = @_; + my ($file,$newdata,$nobackup) = @_; return 1 if (! -e $file); - my $backup = $file.'.backup'; - if (! copy($file,$backup)) { - warn "Error: Unable to make backup of $file"; - return 0; + unless ($nobackup) { + my $backup = $file.'.backup'; + if (! copy($file,$backup)) { + warn "**** Error: Unable to make backup of $file"; + return 0; + } } my ($filedata) = &parse_config_file($file); - if (! ref($filedata)) { warn "Error: $filedata"; return 0;} + if (! ref($filedata)) { warn "**** Error: $filedata"; return 0;} + my $modified = 0; foreach my $data (@$newdata) { my $section = $data->{'section'}; my $key = $data->{'key'}; my $value = $data->{'value'}; - &modify_config_file($filedata,$section,$key,$value) + my $result = &modify_config_file($filedata,$section,$key,$value); + if ($result) { $modified = 1; } + } + if ($modified) { + my $result = &write_config_file($file,$filedata); + if (defined($result)) { warn 'Error:'.$result; return 0; } } - my $result = &write_config_file($file,$filedata); - if (defined($result)) { warn 'Error:'.$result; return 0; } - return 1; + return $modified; } ################################################################# @@ -130,7 +348,9 @@ sub update_file { =pod -=item &parse_config_file +=over 4 + +=item &parse_config_file() Read a configuration file in and parse it into an internal data structure. @@ -138,6 +358,8 @@ Input: filename Output: array ref $filedata OR scalar error message +=back + =cut ################################################################# @@ -155,6 +377,7 @@ sub parse_config_file { my $section_id = $1; push(@Structure,'__section__'.$section_id); while ($line = shift(@Input)) { + chomp($line); if ($line =~ /^\[([^\]]*)\]/) { unshift(@Input,$line); last; @@ -175,6 +398,8 @@ sub parse_config_file { =pod +=over 4 + =item Write a configuration file out based on the internal data structure returned @@ -184,6 +409,8 @@ Inputs: filename, $filedata (the return Returns: undef on success, scalar error message on failure. +=back + =cut ################################################################# @@ -194,7 +421,7 @@ sub write_config_file { if (! defined($structure) || ! ref($structure)) { return 'Bad subroutine inputs'; } - open(OUTPUT,'>'.$file) || return('Unable to open '.$file.' for writing'); + open(OUTPUT,'>',$file) || return('Unable to open '.$file.' for writing'); for (my $i=0;$i[$i]; chomp($line); @@ -225,7 +452,9 @@ sub write_config_file { =pod -=item &modify_config_file +=over 4 + +=item &modify_config_file() Modifies the internal data structure of a configuration file to include new sections and/or new configuration directives. @@ -237,12 +466,17 @@ value prepended). $newkey: A line which matches this will be replaced with $newkey.$newvalue $newvalue: The new value to be placed with the new key. +Returns: 0 or 1, indicating if the file was modified(1) or not(0). + +=back + =cut ################################################################# ################################################################# sub modify_config_file { my ($filedata,$section,$newkey,$newvalue)=@_; + my $modified = 0; # returned value - set to true if the file is modified my ($structure,$sections) = @$filedata; if (! defined($newvalue)) { $newvalue = ''; @@ -264,9 +498,11 @@ sub modify_config_file { # Put the item in or update it. my $key_is_new = 1; for (my $i=0;$i[$i] =~/^$newkey/) { - $target->[$i]=$newline; + if ($target->[$i] ne $newline) { + $target->[$i]=$newline; + $modified = 1; + } $key_is_new = 0; last; } @@ -278,23 +514,151 @@ sub modify_config_file { # No need to put things after a blank line. if (defined($target->[-1]) && $target->[-1] =~ /^\s*$/) { $target->[-1] = $newline; + $modified = 1; } else { push(@$target,$newline); + $modified = 1; } } } - return ($filedata); + return $modified; } +################################################################# +################################################################# + +=pod + +=over 4 + +=item &update_rhn_source() + +Modifies the Red Hat 4 sources file which includes repositories used by up2date + +Inputs: +$rhn_items - a reference to hash of a hash containing the regular expression +to test for, and the text string to append to the file, if an entry for the +LON-CAPA RHEL repository is missing for two cases: + +(a) basearch +(b) noarch + +Returns: 0 or 1, indicating if the file was modified(1) or not(0). + +=back + +=cut + +################################################################# +################################################################# +sub update_rhn_source { + my ($rhn_items) = @_; + return 0 if (ref($rhn_items) ne 'HASH'); + return 0 if ((ref($rhn_items->{basearch}) ne 'HASH') || (ref($rhn_items->{noarch}) ne 'HASH')); + my $file = '/etc/sysconfig/rhn/sources'; + return 0 if (! -e $file); + my $backup = $file.'.backup'; + if (! copy($file,$backup)) { + warn "**** Error: Unable to make backup of $file"; + return 0; + } + my $result = 0; + my $fh; + if (open($fh,'<',$file)) { + my $total = 0; + my %found; + foreach my $item (keys(%{$rhn_items})) { + $found{$item} = 0; + } + while(<$fh>) { + foreach my $item (keys(%{$rhn_items})) { + if (ref($rhn_items->{$item}) eq 'HASH') { + my $pattern = $rhn_items->{$item}->{regexp}; + if ($pattern ne '') { + if (m{^$pattern}) { + $found{$item} = 1; + $total ++; + } + } + } + } + last if $total == 2; + } + close($fh); + if ($total < 2) { + if (open($fh,'>>',$file)) { + foreach my $item (keys(%{$rhn_items})) { + unless ($found{$item}) { + if (ref($rhn_items->{$item}) eq 'HASH') { + if ($rhn_items->{$item}->{text} ne '') { + print $fh "\n".$rhn_items->{$item}->{text}."\n"; + $result = 1; + } + } + } + } + close($fh); + } + } + } + return $result; +} ################################################################# ################################################################# =pod +=over 4 + +=item &update_apt_source() + +Modifies the source.list file which includes repositories used by apt-get + +Inputs: +$deb_row - a reference to containing the regular expression +to test for, and the text string to append to the file, if an entry for the +LON-CAPA Debian/ or Ubuntu repository is missing. + +Returns: 0 or 1, indicating if the file was modified(1) or not(0). + =back =cut ################################################################# ################################################################# +sub update_apt_source { + my ($deb_row) = @_; + return 0 if (ref($deb_row) ne 'HASH'); + return 0 if (($deb_row->{regexp} eq '') || ($deb_row->{text} eq '')); + my $file = '/etc/apt/sources.list'; + return 0 if (! -e $file); + my $backup = $file.'.backup'; + if (! copy($file,$backup)) { + warn "**** Error: Unable to make backup of $file"; + return 0; + } + my $result = 0; + my $fh; + if (open($fh,'<',$file)) { + my $found = 0; + my $pattern = $deb_row->{regexp}; + while(<$fh>) { + if (m{^$pattern}) { + $found = 1; + last; + } + } + close($fh); + if (!$found) { + if (open($fh,'>>',$file)) { + print $fh "\n".$deb_row->{text}."\n"; + close($fh); + $result = 1; + } + } + } + return $result; +} +