[BACK]Return to webserver.piml CVS log [TXT] [DIR] Up to [LON-CAPA] / doc / loncapafiles

Diff for /doc/loncapafiles/webserver.piml between versions 1.9 and 1.62

version 1.9, 2002/05/12 19:02:18 version 1.62, 2024/08/05 15:45:16
Line 1 Line 1
 <!DOCTYPE piml PUBLIC "-//TUX/DTD piml 1.0 Final//EN"   <!DOCTYPE piml PUBLIC "-//TUX/DTD piml 1.0 Final//EN" 
  "http://lpml.sourceforge.net/DTD/piml.dtd">   "http://lpml.sourceforge.net/DTD/piml.dtd">
 <!-- webserver.piml -->  <!-- webserver.piml -->
 <!-- Scott Harrison -->  
   
 <!-- $Id$ -->  <!-- $Id$ -->
   
Line 46  http://www.lon-capa.org/ Line 45  http://www.lon-capa.org/
 <files>  <files>
 <file>  <file>
 <target dist='default'>/etc/httpd/conf/httpd.conf</target>  <target dist='default'>/etc/httpd/conf/httpd.conf</target>
 <note>This is always expected for any version of Apache</note>  <target dist='suse9.2 suse9.3 sles9'>/etc/httpd/httpd.conf</target>
   <target dist='sles10 sles11 sles12 sles15 suse10.1 suse10.2 suse10.3 suse11.1 suse11.2 suse11.3 suse11.4 suse12.1 suse12.2 suse12.3 suse13.1 suse13.2'>/etc/apache2/default-server.conf</target>
   <target dist='debian5 debian6 ubuntu6 ubuntu8 ubuntu10 ubuntu12'>/etc/apache2/sites-available/loncapa</target>
   <target dist='debian10 debian11 debian12 ubuntu14 ubuntu16 ubuntu18 ubuntu20 ubuntu22 ubuntu24'>/etc/apache2/conf-available/loncapa.conf</target>
   <note>This is for Apache 1.X for Red Hat 4ES, Fedora 2, 3 and 4, SusSE 9.2 and 9.3, and SLES 9 distributions. This is for Apache 2.X for Fedora 5, Red Hat 5, CentOS 5, Scientific Linux 5, Oracle Linux 5, SuSE 10.1, SLES 10, Debian 5, Ubuntu LTS 8 and later distributions</note>
 <dependencies dist='default'>  <dependencies dist='default'>
 /etc/httpd/conf/httpd.conf  /etc/httpd/conf/httpd.conf
 </dependencies>  </dependencies>
 <perlscript mode='fg'>  <dependencies dist='suse9.2 suse9.3 sles9'>
   /etc/httpd/httpd.conf
   </dependencies>
   <dependencies dist='debian5 debian6 ubuntu6 ubuntu8 ubuntu10 ubuntu12'>
   /etc/apache2/sites-available/loncapa
   </dependencies>
   <dependencies dist='debian10 debian11 debian12 ubuntu14 ubuntu16 ubuntu18 ubuntu20 ubuntu22 ubuntu24'>
   /etc/apache2/conf-available/loncapa.conf
   </dependencies>
   <dependencies dist='sles10 sles11 sles12 sles15 suse10.1 suse10.2 suse10.3 suse11.1 suse11.2 suse11.3 suse11.4 suse12.1 suse12.2 suse12.3 suse13.1 suse13.2'>
   /etc/apache2/default-server.conf
   </dependencies>
   <perlscript mode='fg' dist="default">
   # Generated from doc/loncapafiles/webserver.piml
   use Socket;
   use Sys::Hostname::FQDN();
   use File::Spec;
   use Cwd();
   
   # For ubuntu 14 and later check for loncapa.conf in sites-available,
   # and conf-available, and for symlinks in sites-enabled, and conf-enabled
   if ('<DIST />' =~ /^ubuntu(\d+)$/) {
       my $version = $1;
       if ($version &gt; 12) {
           if (-l '/etc/apache2/conf-enabled/loncapa.conf') {
               my $linkfname = readlink('/etc/apache2/conf-enabled/loncapa.conf');
               if ($linkfname ne '') {
                   $linkfname = Cwd::abs_path(File::Spec->rel2abs($linkfname,'/etc/apache2/conf-enabled'));
               }
               unless ($linkfname eq '/etc/apache2/conf-available/loncapa.conf') {
                   unlink('/etc/apache2/conf-enabled/loncapa.conf');
               }
           }
           if (-e '/etc/apache2/conf-available/loncapa') {
               system('mv /etc/apache2/conf-available/loncapa /etc/apache2/conf-available/loncapa.conf');
           }
           unless (-l '/etc/apache2/conf-enabled/loncapa.conf') {
               if (-e '/etc/apache2/conf-available/loncapa.conf') {
                   my $currdir = Cwd::getcwd();
                   if ($currdir ne '') {
                       chdir('/etc/apache2/conf-enabled');
                       symlink('../conf-available/loncapa.conf','loncapa.conf');
                       chdir($currdir);
                   }
               }
           }
           if (-l '/etc/apache2/sites-enabled/000-default.conf') {
               my $linkfname = readlink('/etc/apache2/sites-enabled/000-default.conf');
               if ($linkfname ne '') {
                   $linkfname = Cwd::abs_path(File::Spec->rel2abs($linkfname,'/etc/apache2/sites-enabled'));
               }
               if (($linkfname eq '/etc/apache2/sites-available/loncapa') ||
                   ($linkfname eq '/etc/apache2/sites-available/000-default.conf')) {
                   unlink('/etc/apache2/sites-enabled/000-default.conf');
               }
           }
           if (-e '/etc/apache2/sites-available/loncapa') {
               system('mv /etc/apache2/sites-available/loncapa /etc/apache2/sites-available/loncapa.conf');
           }
           if (-l '/etc/apache2/sites-enabled/loncapa.conf') {
               my $linkfname = readlink('/etc/apache2/sites-enabled/loncapa.conf');
               if ($linkfname ne '') {
                   $linkfname = Cwd::abs_path(File::Spec->rel2abs($linkfname,'/etc/apache2/sites-enabled'));
               }
               unless ($linkfname eq '/etc/apache2/sites-available/loncapa.conf') {
                   unlink('/etc/apache2/sites-enabled/loncapa.conf');
               }
           }
           unless (-l '/etc/apache2/sites-enabled/loncapa.conf') {
               if (-e '/etc/apache2/sites-available/loncapa.conf') {
                   my $currdir = Cwd::getcwd();
                   if ($currdir ne '') {
                       chdir('/etc/apache2/sites-enabled');
                       symlink('../sites-available/loncapa.conf','loncapa.conf');
                       chdir($currdir);
                   }
               }
           }
       }
   }
   
 unless (-e "<TARGET />") {  unless (-e "<TARGET />") {
  print 'ERROR! httpd.conf should exist! Are you missing the Apache '.    print '**** ERROR! <TARGET /> should exist! Are you missing the Apache '.
  'software package';      'software package?';
     exit(1);
 }  }
 else {  else {
   $flag=0;    # Append loncapa_apache.conf inclusion to httpd.conf 
   open IN, "&lt;<TARGET />";    # (or sites-available/loncapa or conf-available/loncapa.conf) if not present.
   while (&lt;IN&gt;) { if (/^\s*Include\s+conf\/srm.conf/) { $flag=1; } }    my $absolute_link;
   close IN;    if ('<DIST />' =~ /^sles(\d+)$/) {
   unless ($flag==1) {      my $version = $1;
  open OUT,"&gt;&gt;<TARGET />";      if ($version &gt; 11) {
  print OUT 'Include conf/srm.conf'."\n";        $absolute_link = 1;
  close OUT;      }
   }    }
   $flag=0;    if ($absolute_link) {
   open IN, "&lt;<TARGET />";      # For SuSE and SLES /etc/apache2/default-server.conf needs to include:
   while (&lt;IN&gt;) { if (/^\s*Include\s+conf\/access.conf/) { $flag=1; } }      # Include /etc/apache2/loncapa_apache.conf
   close IN;      # instead of:
   unless ($flag==1) {      # Include conf/loncapa_apache.conf
  open OUT,"&gt;&gt;<TARGET />";      my $delflag=0;
  print OUT 'Include conf/access.conf'."\n";      my $addflag=1;
  close OUT;      open(IN,'&lt;<TARGET />');
       while (&lt;IN&gt;) {
         if (/^\s*Include\s+conf\/loncapa_apache.conf/) {
           $delflag=1;
         }
         if (/^\s*Include\s+\/etc\/apache2\/loncapa_apache.conf/) {
           $addflag = 0;
         }
       }
       close(IN);
       if ($addflag) {
         open(OUT,'&gt;&gt;<TARGET />');
         print(OUT 'Include /etc/apache2/loncapa_apache.conf'."\n");
         close(OUT);
       }
       if ($delflag==1) {
         my $in='';
         open(IN,'&lt;<TARGET />');
         while(&lt;IN&gt;) {
           $in.=$_ unless /^\s*Include\s+conf\/loncapa_apache.conf/;
         }
         close(IN);
         open(OUT,'&gt;<TARGET />');
         print(OUT $in);
         close(OUT);
       }
     } else {
       $flag=0;
       open(IN,'&lt;<TARGET />');
       while (&lt;IN&gt;) { 
         if (/^\s*Include\s+conf\/loncapa_apache.conf/) {
           $flag=1; 
         }
       }
       close(IN);
       unless ($flag==1) {
         open(OUT,'&gt;&gt;<TARGET />');
         print(OUT 'Include conf/loncapa_apache.conf'."\n");
         close(OUT);
       }
   }    }
   my $eflag=0;    # Remove loncapa.conf inclusion from httpd.conf 
     # (or sites-available/loncapa or conf-available/loncapa.conf) if present.
   $flag=0;    $flag=0;
   open IN, "&lt;<TARGET />";    open(IN,'&lt;<TARGET />');
   while (&lt;IN&gt;) {     while (&lt;IN&gt;) {
     if (/^\s*Include\s+conf\/loncapa_apache.conf/) {      if (/^\s*Include\s+conf\/loncapa.conf/) {
       $flag=1;         $flag=1;
     }      }
   }    }
   close IN;    close(IN);
   unless ($flag==1) {    $in='';
  open OUT,"&gt;&gt;<TARGET />";    if ($flag==1) {
  print OUT 'Include conf/loncapa_apache.conf'."\n";      open(IN,'&lt;<TARGET />');
  close OUT;      while(&lt;IN&gt;) {
         $in.=$_ unless /^\s*Include\s+conf\/loncapa.conf/;
       }
       close(IN);
       open(OUT,'&gt;<TARGET />');
       print(OUT $in."\n");
       close(OUT);
   }    }
   $flag=0;  
   open IN, "&lt;<TARGET />";  # Checking for overlapping ScriptAlias and DocumentRoot definitions.
   while (&lt;IN&gt;) {     $scriptalias_flag=0;
     if (/^\s*Include\s+conf\/loncapa.conf/) {    $documentroot_flag=0;
       $flag=1;     my $scriptalias;
     my $documentroot;
     open(IN,'&lt;<TARGET />');
     while (&lt;IN&gt;) {
       if (m!^\s*ScriptAlias\s+/cgi-bin/\s+(.*)$!) {
         $scriptalias = $1;
         if ($scriptalias !~ m!home/httpd/cgi-bin!) {
           $scriptalias_flag = 1;
         }
       }
       if (m!^\s*DocumentRoot\s+(.*)$!) {
         $documentroot = $1;
         if ($documentroot !~ m!home/httpd/html!) {
           $documentroot_flag = 1;
         }
     }      }
   }    }
   close IN;    close(IN);
   unless ($flag==1) {    if ($scriptalias_flag==1) {
  open OUT,"&gt;&gt;<TARGET />";        my $conffile = '/etc/httpd/conf/httpd.conf';
  print OUT 'Include conf/loncapa.conf'."\n";        if ('<DIST />' eq 'suse9.2' || '<DIST />' eq 'suse9.3' 
  close OUT;            || '<DIST />' eq 'sles9') {
             $conffile =  '/etc/httpd/httpd.conf';
         } elsif ('<DIST />' =~ /^(suse|sles)/) {
             $conffile = '/etc/apache2/default-server.conf';
         } elsif ('<DIST />' =~ /^(debian|ubuntu)/) {
             $conffile = '/etc/apache2/sites-available/loncapa';
             if ('<DIST />' =~ /^ubuntu(\d+)$/) {
                 my $version = $1;
                 if ($version &gt; 12) {
                     $conffile = '/etc/apache2/conf-available/loncapa.conf';
                 }
             }
         }
         print('**** ERROR **** '.$conffile.' has an overlapping definition of '.
               'ScriptAlias (it is incorrectly set to '.$scriptalias.').'."\n".
               'This conflicts with loncapa_apache.conf.'."\n");
   }    }
 }    if ($documentroot_flag==1) {
 </perlscript>        print('**** ERROR **** '.$conffile.' has an overlapping definition of '.
 </file>              'DocumentRoot (it is incorrectly set to '.$documentroot.').'."\n".
 <file>              'This conflicts with loncapa_apache.conf.'."\n");
 <target dist='default'>/etc/httpd/conf/access.conf</target>    }
 <note>This may or may not exist on a system depending on the version of  
 Apache</note>  # Checking for rewrites of http:// to https://
 <dependencies dist='default'>      my $rewrite_dir = '/etc/httpd/conf/rewrites';
 /etc/httpd/conf/access.conf      my $curr_rewrite = '/etc/httpd/conf/loncapa_rewrite.conf';
 </dependencies>      if ('<DIST />' eq 'suse9.2' || '<DIST />' eq 'suse9.3'
 <perlscript mode='fg'>          || '<DIST />' eq 'sles9') {
 unless (-e "<TARGET />") {          $rewrite_dir = '/etc/httpd/rewrites/';
  print &lt;&lt;END;          $curr_rewrite = '/etc/httpd/loncapa_rewrite.conf';
 WARNING! access.conf is not currently present on your system.      } elsif ('<DIST />' =~ /^(suse|sles|debian|ubuntu)/) {
 This is either due to           $rewrite_dir = '/etc/apache2/rewrites';
 * you are missing the Apache software package,          $curr_rewrite = '/etc/apache2/loncapa_rewrite.conf';
 * you have a newer version of Apache that does not      }
   ordinarily install an access.conf      my $rewrite_off = $rewrite_dir.'/loncapa_rewrite_off.conf';
 * configuration files are installed in a directory location      my $rewrite_on = $rewrite_dir.'/loncapa_rewrite_on.conf';
   different than for <TARGET />      if (!-e $curr_rewrite) { 
 For backwards compatibility,          system("cp $rewrite_off $curr_rewrite");
 <TARGET /> is being generated.          chmod(0644, $curr_rewrite);
 END      } else {
 }          my ($not_rewrite_on,$not_rewrite_off,$rewrite_state);
 my $flag=0;          if (open(PIPE, "diff --brief $rewrite_off $curr_rewrite |")) {
 open IN, "&lt;<TARGET />";              my $diffres = &lt;PIPE&gt; ;
 while (&lt;IN&gt;) { if (/^\s*Include\s+conf\/loncapa_apache.conf/)              close(PIPE);
  { $flag=1; } }              chomp($diffres);
 close IN;              if ($diffres) {
 unless ($flag==1) {                  $not_rewrite_off = 1;
 open OUT,"&gt;&gt;<TARGET />";              } else {
 print OUT 'Include conf/loncapa_apache.conf'."\n";                  $rewrite_state = 'off';
 close OUT;              }
 $flag=0;          }
 open IN, "&lt;<TARGET />";          if (open(PIPE, "diff --brief $rewrite_on $curr_rewrite |")) {
 while (&lt;IN&gt;) { if (/^\s*Include\s+conf\/loncapa.conf/) { $flag=1; } }              my $diffres = &lt;PIPE&gt; ;
 close IN;              close(PIPE);
 unless ($flag==1) {              chomp($diffres);
 open OUT,"&gt;&gt;<TARGET />";              if ($diffres) {
 print OUT 'Include conf/loncapa.conf'."\n";                  $not_rewrite_on = 1;
 close OUT;              } else {
 }                  $rewrite_state = 'on';
 </perlscript>              }
 </file>          }
 <file>          if ($not_rewrite_off && $not_rewrite_on) {
 <target dist='default'>/etc/httpd/conf/srm.conf</target>              print('**** WARNING **** '."\n".$curr_rewrite.' does not match '.
 <note>This may or may not exist on a system depending on the version of              'either:'."\n".$rewrite_on.' - the file used to enable rewriting '.
 Apache</note>              'of requests for http:// to https:// '."\n".'or:'."\n".$rewrite_off.
 <dependencies dist='default'>              ' - the file used to disable such rewriting'."\n\n".
 /etc/httpd/conf/srm.conf              'This may be because '. $curr_rewrite.' has been '. 
 </dependencies>              'previously customized,'."\n".'or it may be because of a change '.  
 <perlscript mode='fg'>              'to the files in '.$rewrite_dir."\n");
 unless (-e "<TARGET />") {              if (open(my $fh,'&lt;',$curr_rewrite)) {
  print &lt;&lt;END;                  while(&lt;$fh&gt;) {
 WARNING! srm.conf is not currently present on your system.                      if (/^\s*RewriteEngine\s+(on|off)\s*$/i) {
 This is either due to                           if ($1 eq 'on') {
 * you are missing the Apache software package,                              $rewrite_state = 'on';
 * you have a newer version of Apache that does not                          } else {
   ordinarily install an srm.conf                              $rewrite_state = 'off';
 * configuration files are installed in a directory location                          }
   different than for <TARGET />                          last;
 For backwards compatibility,                      }
 <TARGET /> is being generated.                  }
 END              }
 }          }
 my $flag=0;          if ($rewrite_state eq 'on') {
 open IN, "&lt;<TARGET />";          # Checking for rewrites of https:// to http://
 while (&lt;IN&gt;) { if (/^\s*Include\s+conf\/loncapa_apache.conf/)              my ($gotrules,$rulestr,$ssldir);
  { $flag=1; } }              if ('<DIST />' eq 'suse9.2' || '<DIST />' eq 'suse9.3'
 close IN;                  || '<DIST />' eq 'sles9') {
 unless ($flag==1) {                  $ssldir = '/etc/apache/vhosts.d';
 open OUT,"&gt;&gt;<TARGET />";              } elsif ('<DIST />' =~ /^(suse|sles)/) {
 print OUT 'Include conf/loncapa_apache.conf'."\n";                  $ssldir = '/etc/apache2/vhosts.d';
 close OUT;              } elsif ('<DIST />' =~ /^(debian|ubuntu)/) {
 $flag=0;                  $ssldir = '/etc/apache2/sites-available';
 open IN, "&lt;<TARGET />";              } else {
 while (&lt;IN&gt;) { if (/^\s*Include\s+conf\/loncapa.conf/) { $flag=1; } }                  $ssldir = '/etc/httpd/conf.d';
 close IN;              }
 unless ($flag==1) {              my $hostname = Sys::Hostname::FQDN::fqdn();
 open OUT,"&gt;&gt;<TARGET />";              my $hostip = Socket::inet_ntoa(scalar(gethostbyname($hostname)) || 'localhost');
 print OUT 'Include conf/loncapa.conf'."\n";              my @expected = ('RewriteEngine on',
 close OUT;                              'RewriteCond %{HTTPS} =on',
                               'RewriteCond %{REQUEST_URI} ^/adm/wrapper/ext/(?!https:)',
                               'RewriteCond %{QUERY_STRING} (^|&(|amp;))usehttp=1($|&)',
                               'RewriteRule ^/adm/wrapper/ext/(?!https:) http://%{HTTP_HOST}%{REQUEST_URI} [R,L,NE]',
                               'RewriteCond %{REMOTE_ADDR} 127.0.0.1',
                               'RewriteRule (.*) - [L]');
               if (($hostip ne '') && ($hostip ne '127.0.0.1')) {
                   push(@expected,('RewriteCond %{REMOTE_ADDR} '.$hostip,
                                   'RewriteRule (.*) - [L]'));
               }
               push(@expected,('RewriteCond %{REQUEST_URI} ^/public/.*/syllabus$',
                               'RewriteCond %{QUERY_STRING} (^|&(|amp;))usehttp=1($|&)',
                               'RewriteRule ^/public/.*/syllabus$ http://%{HTTP_HOST}%{REQUEST_URI} [R,L,NE]'));
               if (-d $ssldir) {
                   my @rewrites;
                   if (opendir(my $dir,$ssldir)) {
                       my @sslconf_files;
                       foreach my $file (grep(!/^\./,readdir($dir))) {
                           next if ($file =~ /\.rpmnew$/);
                           if (open(my $fh,'&lt;',"$ssldir/$file")) {
                               while (&lt;$fh&gt;) {
                                   if (/^\s*&lt;VirtualHost\s+[^:]*\:443&gt;\s*$/) {
                                       push(@sslconf_files,$file);
                                       last;
                                   }
                               }
                               close($fh);
                           }
                       }
                       if (@sslconf_files) {
                           foreach my $file (@sslconf_files) {
                               if (open(my $fh,'&lt;',"$ssldir/$file")) {
                                   my ($rewrite,$num) = (0,0);
                                   while (&lt;$fh&gt;) {
                                       if ($rewrite) {
                                           if (/^\s*&lt;\/IfModule&gt;/) {
                                               $rewrite = 0;
                                               $num ++;
                                           } else {
                                               chomp();
                                               s/^\s+|\s+$//g;
                                               push(@{$rewrites[$num]},$_);
                                           }
                                       } elsif (/^\s*&lt;IfModule\s+mod_rewrite.c&gt;/) {
                                           $rewrite = 1;
                                       }
                                   }
                                   close($fh);
                               }
                           }
                       }
                       closedir($dir);
                   }
                   if (@rewrites) {
                       foreach my $item (@rewrites) {
                           if (ref($item) eq 'ARRAY') {
                               my $found = 0;
                               foreach my $line (@{$item}) {
                                   foreach my $match (@expected) {
                                       if ($match eq $line) {
                                           $found ++;
                                           last;
                                       }
                                   }
                               }
                               if ($found &gt;= scalar(@expected)) {
                                   $gotrules = 1;
                                   last;
                               }
                           }
                       }
                   }
               }
               unless ($gotrules) {
                   print('**** WARNING **** '."\n".$curr_rewrite.' is currently set so rewrites '.
                         'of http to https are enabled for most URLs.'."\n".
                         'Unless your Apache configuration includes Strict-Transport-Security '.
                         '(with max-age > 0), it is recommended to also set rewrites from https to http '.
                         'for specific URLs in a file in '.$ssldir.' by including the following:'."\n".
                         "&lt;IfModule mod_rewrite.c&gt;\n".'  '.
                         join("\n  ",@expected)."\n".
                         "&lt;/IfModule&gt;\n");
               }
           }
       }
 }  }
 </perlscript>  </perlscript>
 </file>  </file>
Removed from v.1.9  
changed lines
  Added in v.1.62

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>