--- doc/loncapafiles/updatequery.piml	2005/03/23 18:43:24	1.36
+++ doc/loncapafiles/updatequery.piml	2006/12/10 23:38:35	1.51
@@ -1,6 +1,6 @@
 <!-- updatequery.piml -->
 
-<!-- $Id: updatequery.piml,v 1.36 2005/03/23 18:43:24 albertel Exp $ -->
+<!-- $Id: updatequery.piml,v 1.51 2006/12/10 23:38:35 albertel Exp $ -->
 
 <!--
 
@@ -70,10 +70,10 @@ you must contact lon-capa\@lon-capa.org.
 3) DEVELOPMENT - you want to do software (not content!) development with
                  this workstation and eventually link it with the
                  workstations of other LON-CAPA software developers.
-4) PRESERVE the existing hosts.tab and domain.tab
-                (/home/httpd/lonTabs/hosts.tab and
-                 /home/httpd/lonTabs/domain.tab)
-
+4) RUNNING YOUR OWN CLUSTER - this machine is not in the standard LON-CAPA
+                 clusters and won't be in the future and you want the existing
+                 hosts.tab and domain.tab files to be left alone.
+                 (This choice is unlikely what you want to select.)
 END
 # Option number 26 will install rawhide_hosts.tab, but
 # the typical user does not want to be part of an intensive
@@ -129,6 +129,8 @@ END
 $|=1;
 my $domainDescription;
 my $domainTabExtras;
+my $primaryLibServer;
+my @libservers = ();
 unless (-e "<TARGET />") {
   print(&lt;&lt;END);
            WELCOME TO LON-CAPA!
@@ -141,7 +143,7 @@ The following 4 values are needed to con
 * Machine Role
 * LON-CAPA Domain Name
 * LON-CAPA Machine ID Name, and
-* System Administration E-mail Address.
+* Server Administration E-mail Address.
 ===============================================================================
 
 In addition, a Support E-mail Address can also be included. If
@@ -205,8 +207,24 @@ if ($hostname=~/([^\.]*)\.([^\.]*)$/) {
   print(&lt;&lt;END);
 
 **** Domain ****
-[this does NOT need to correspond to internet address domains,
- examples might be "msu" or "bionet" or "vermontcc"]
+[This does NOT need to correspond to internet address domains.
+ Please make this name short AND descriptive of your organization.
+ Domain names are close to impossible to change later!!!
+ Good examples might be "msu" or "bionet" or "vermontcc".
+ Bad examples are "physics" (too general)
+   or "michiganstateuniversity" (too long)
+   or "msuedu" (internet domain, just make it "msu")
+   or "msuphysics" (only if there is a good reason to limit to department
+                    - we don't know of one)
+   or "mydomain" (what is that?)
+ Avoid multiple domains at the same institution, even if it means that you 
+ have to actually work together with your colleagues. You can still run
+ multiple library servers within the same domain.
+ If this domain is eventually going to be part of the main production
+ cluster, you MUST contact the LON-CAPA group at MSU (loncapa@loncapa.org)
+ to have a domain name assigned, and then use it exactly as given. This is
+ also true for test installs that might eventually turn into production setups.
+ Stop now if you didn't do so.]
 END
 
 # get domain name
@@ -227,10 +245,14 @@ END
   my $choice=&lt;&gt;;
   chomp($choice);
   my $bad_domain_flag=0;
-  my @bad_domain_names=('raw','userfiles','priv','adm','uploaded');
+  my @bad_domain_names=('res','raw','userfiles','priv','adm','uploaded',
+	'editupload');
   foreach my $bad (@bad_domain_names) {
     $bad_domain_flag=1 if $choice eq $bad;
   }
+  if ($choice=~/capa/i) {
+     $bad_domain_flag=1;
+  }
   if ($ipdomain and $choice=~/^\s*$/) {
     $choice=$ipdomain;
     open(OUT,'&gt;&gt;/tmp/loncapa_updatequery.out');
@@ -238,21 +260,22 @@ END
     close(OUT);
     $lonDefDomain=$choice;
     $flag=1;
-  }
-  elsif ($choice!~/\_/ and $choice=~/^\w+$/) {
+  } elsif (length($choice)>35) {
+    print "Name too long\n";
+  } elsif (length($choice)<2) {
+    print "Name too short\n";
+  } elsif ($bad_domain_flag) {
+    print "Invalid input ('$choice' conflicts with LON-CAPA namespace).\n";
+    print "Please try something different than '$choice'\n";
+  } elsif ($choice!~/\_/ and $choice=~/^[\w\-.]+$/) {
     open(OUT,'&gt;&gt;/tmp/loncapa_updatequery.out');
     print(OUT 'lonDefDomain'."\t".$choice."\n");
     close(OUT);
     $lonDefDomain=$choice;
     $r='l';
     $flag=1;
-  }
-  elsif ($bad_domain_flag) {
-    print "Invalid input ('$choice' conflicts with LON-CAPA namespace).\n";
-    print "Please try something different than '$choice'\n";
-  }
-  else {
-    print "Invalid input (only alphanumeric characters supported).\n";
+  } else {
+    print "Invalid input (only alphanumeric characters, '-', and '.' supported).\n";
   }
 }
 
@@ -293,11 +316,12 @@ if ($lonDefDomain) {
   print(&lt;&lt;END);
 
 **** Machine ID Name ****
-[this does NOT need to correspond to internet address names;
+[This does NOT need to correspond to internet address names;
  this name MUST be unique to the whole LON-CAPA network;
- we recommend that you use a name based off of your institution;
- good examples: "msul1" or "bionetl1";
- bad examples: "loncapabox" or "studentsinside"]
+ we recommend that you use a name based off of your institution.
+ Good examples: "msul1" or "bioneta2".
+ Bad examples: "loncapabox" or "studentsinside".
+ Note that machine names are very hard to change later.]
 END
 # get machine name
 # accept if valid, if not valid, tell user and repeat
@@ -315,26 +339,87 @@ END
 }
   my $choice=&lt;&gt;;
   chomp($choice);
-  if ($lonHostID and $choice=~/^\s*$/) {
+  if ($choice=~/capa/i) {
+    print "Invalid input (names containing 'capa' are reserved).\n";
+  } elsif ($lonHostID and $choice=~/^\s*$/) {
     $choice=$lonHostID;
     open(OUT,'&gt;&gt;/tmp/loncapa_updatequery.out');
     print(OUT 'lonHostID'."\t".$choice."\n");
     close(OUT);
     $lonHostID=$choice;
     $flag=1;
-  }
-  elsif ($choice!~/\_/ and $choice=~/^\w+$/) {
+  } elsif (length($choice)>45) {
+    print "Name too long\n";
+  } elsif (length($choice)<4) {
+    print "Name too short\n";
+  } elsif ($choice!~/\_/ and $choice=~/^[\w\-.]+$/) {
     open(OUT,'&gt;&gt;/tmp/loncapa_updatequery.out');
     print(OUT 'lonHostID'."\t".$choice."\n");
     close(OUT);
     $lonHostID=$choice;
     $flag=1;
+  } else {
+    print "Invalid input (only alphanumeric characters, '-', and '.' supported).\n";
   }
-  else {
-    print "Invalid input (only alphanumeric characters supported).\n";
-  }
 }
 
+# get primary library server in domain
+if ($lonRole eq 'library') {
+    if (!grep/^\Q$lonHostID\E$/,@libservers) {
+        push(@libservers,$lonHostID);
+    } 
+    if (@libservers == 1) {
+        $primaryLibServer = $libservers[0];
+    }
+}
+while (!$flag) {
+  print(&lt;&lt;END);
+**** Domain's Primary Library Server ID ****
+This should be the LON-CAPA machine ID of a library server in your 
+domain.  If you only have a single library server in your domain, then
+the Primary Library server ID will be the machine ID of that server. 
+This server will be where domain data which are not associated with any
+specific home library server will be stored (e.g., e-mail broadcast by
+administrators to users in the domain).
+END
+    if (defined($primaryLibServer)) {
+        print(&lt;&lt;END);
+ENTER DOMAIN'S PRIMARY LIBRARY SERVER ID [$primaryLibServer]:
+END
+    } elsif (@libservers > 0) {
+        print(&lt;&lt;END);
+ENTER DOMAIN'S PRIMARY LIBRARY SERVER ID [$libservers[0]]
+END
+    } else {
+        print (&lt;&lt;END);
+No library servers could be identified for this domain.  If you have already installed LON-CAPA on a different server (designated as a library server) in this domain, please enter the LONCAPA MACHINE ID of that server.  If not, you will need to install a LON-CAPA library server.  Enter the MACHINE ID of the server you plan to designate as a library server.
+END
+    }
+
+    my $choice=&lt;&gt;;
+    chomp($choice);
+    if ($primaryLibServer and $choice=~/^\s*$/) {
+        $choice=$primaryLibServer;
+        open(OUT,'&gt;&gt;/tmp/loncapa_updatequery.out');
+        print(OUT 'primaryLibServer'."\t".$choice."\n");
+        close(OUT);
+        $flag=1;
+    } elsif (length($choice)>35) {
+        print "Name too long\n";
+    } elsif (length($choice)<4) {
+        print "Name too short\n";
+    } elsif ($choice!~/\_/ and $choice=~/^[\w\-.]+$/) {
+        open(OUT,'&gt;&gt;/tmp/loncapa_updatequery.out');
+        print(OUT 'primaryLibServer'."\t".$choice."\n");
+        close(OUT);
+        $primaryLibServer=$choice;
+        $flag=1;
+    } else {
+        print "Invalid input (only alphanumeric characters, '-', and '.' supported).\n";
+    }
+}
+
+
 # get admin e-mail address
 # accept if valid, if not valid, tell user and repeat
 $flag=0;
@@ -342,7 +427,7 @@ my $lonAdmEMail;
 while (!$flag) {
   print(&lt;&lt;END);
 
-**** System Administrator's E-mail ****
+**** Server Administrator's E-mail ****
 E-mail address of the person who will manage this machine
 [should be in the form somebody\@somewhere]
 ENTER ADMIN E-MAIL ADDRESS:
@@ -397,8 +482,10 @@ END
 
 
 # update loncapa.conf
-my $confdir='/etc/httpd/conf/';
-#my $confdir='';
+my $confdir = '/etc/httpd/conf/';
+if ('<DIST />' eq 'sles10' || '<DIST />' eq 'suse10.1') {
+     $confdir = '/etc/apache2/';
+}   
 my $filename='loncapa.conf';
 my %perlvar;
     if (-e "$confdir$filename") {
@@ -439,8 +526,12 @@ my %perlvar;
       die("Cannot output to $confdir$filename\n");
     foreach my $key (keys %perlvar) {
       my $value=$perlvar{$key};
+      my $line = "PerlSetVar     $key      $value"; 
+      if ($value eq '') {
+          $line = '#'.$line;
+      }
       print(OUT &lt;&lt;END);
-PerlSetVar     $key      $value
+$line
 END
     }
     close(OUT);
@@ -448,7 +539,8 @@ END
 </perlscript>
 </file>
 <file>
-<target dist='default'>/</target>
+<target dist='default'>/etc/httpd/conf/</target>
+<target dist='sles10 suse10.1'>/etc/apache2/</target>
 <perlscript mode='fg'>
 sub securesetting {
     my (%perlvar)=@_;
@@ -466,7 +558,7 @@ sub securesetting {
     return ($securestatus,$securenum);
 }
 # read values from loncapa.conf
-my $confdir='/etc/httpd/conf/';
+my $confdir = "<TARGET />";
 my $filename='loncapa.conf';
 my %perlvar;
 my ($securestatus,$securenum);
@@ -527,6 +619,8 @@ my %perlvarstatic;
 	     (undef,$domainDescription,$domainTabExtras)=split(/:/,$_,3);
 	     chomp($domainDescription);
 	     chomp($domainTabExtras);
+	     # the remianing field (primary lib server) is handled later
+	     $domainTabExtras = join(':',(split(/:/,$domainTabExtras))[0..5]);
              last;
           }
        }
@@ -539,14 +633,62 @@ my %perlvarstatic;
 	     (undef,$domainDescription,$domainTabExtras)=split(/:/,$_,3);
 	     chomp($domainDescription);
 	     chomp($domainTabExtras);
+	     # the remianing field (primary lib server) is handled later
+	     $domainTabExtras = join(':',(split(/:/,$domainTabExtras))[0..5]);
              last;
           }
        }
        close(IN);
     }
+    if (!$primaryLibServer and $lonCluster ne 'existing') {
+        open(IN,'&lt;../'.$lonCluster.'_domain.tab');
+        while(&lt;IN&gt;) {
+            if (/^$perlvar{'lonDefDomain'}\:/) {
+                (undef,undef,undef,undef,undef,undef,undef,undef,
+                                              $primaryLibServer)=split(/:/,$_);
+                chomp($primaryLibServer);
+            }
+        }
+        close(IN);
+        if (!$primaryLibServer) {
+            open(IN,'&lt;../'.$lonCluster.'_hosts.tab');
+            while(&lt;IN&gt;) {
+                if (/^([^\:]+)\:\Q$perlvar{'lonDefDomain'}\E\:library\:/) {
+                    push(@libservers,$1);
+                }
+            }
+            close(IN);
+            if (@libservers == 1) {
+                $primaryLibServer = $libservers[0];
+            }
+        }
+    }
+    if (!$primaryLibServer) {
+        open(IN,'&lt;/home/httpd/lonTabs/domain.tab');
+        while(&lt;IN&gt;) {
+            if (/^$perlvar{'lonDefDomain'}\:/) {
+                (undef,undef,undef,undef,undef,undef,undef,undef,
+                                              $primaryLibServer)=split(/:/,$_);
+                chomp($primaryLibServer);
+            }
+            close(IN);
+        }
+        if (!$primaryLibServer) {
+            open(IN,'&lt;/home/httpd/lonTabs/hosts.tab');
+            while(&lt;IN&gt;) {
+                if (/^([^\:]+)\:\Q$perlvar{'lonDefDomain'}\E\:library\:/) {
+                    push(@libservers,$1);
+                }
+            }
+            close(IN);
+            if (@libservers == 1) {
+                $primaryLibServer = $libservers[0];
+            }
+        }
+    }
    
 # implement editing logic below, interactively
-# update loncapa.conf until 8 is entered
+# update loncapa.conf until 12 is entered
 
 $flag=0;
 
@@ -558,41 +700,69 @@ This is now the current configuration of
  1) Domain Name: $perlvar{'lonDefDomain'}
  2) Domain Description: $domainDescription
  3) Machine Name: $perlvar{'lonHostID'}
- 4) System Administrator's E-mail Address: $perlvar{'lonAdmEMail'}
- 5) Support E-mail Address: $perlvar{'lonSupportEMail'}
- 6) Role: $perlvar{'lonRole'}
- 7) Cache Expiration Time: $perlvar{'lonExpire'}
- 8) Server Load: $perlvar{'lonLoadLim'}
- 9) User Load: $perlvar{'lonUserLoadLim'}
-10) Allow only secure connections: $securestatus 
-11) Everything is correct up above
-END
-my $hbug=-1;
-my $dbug=-1;
-{
-  my $v=$perlvar{'lonHostID'};
-  $hbug=0;
-  $hbug=1 if $v=~/\W/;
-  $hbug=1 if $v=~/\_/;
-}
-{
-  my $v=$1;
-  $dbug=0;
-  $dbug=1 if $v=~/\W/;
-  $dbug=1 if $v=~/\_/;
-}
-
-if ($hbug) {
-  print "**** ERROR **** ".
-	"Invalid lonHostID (should only be letters and/or digits)\n";
-}
-if ($dbug) {
-  print "**** ERROR **** ".
-	"Invalid lonDefDomain (should only be letters and/or digits)\n";
+ 4) ID of primary library server for domain: $primaryLibServer
+ 5) Server Administrator's E-mail Address: $perlvar{'lonAdmEMail'}
+ 6) Support E-mail Address: $perlvar{'lonSupportEMail'}
+ 7) Role: $perlvar{'lonRole'}
+ 8) Cache Expiration Time: $perlvar{'lonExpire'}
+ 9) Server Load: $perlvar{'lonLoadLim'}
+10) User Load: $perlvar{'lonUserLoadLim'}
+11) Allow only secure connections: $securestatus 
+12) Everything is correct up above
+END
+
+my $error='';
+foreach my $v ($perlvar{'lonDefDomain'},$perlvar{'lonHostID'}) {
+   if (length($v)>35) { $error.="\nName $v too long"; }		
+   if (length($v)<2) { $error.="\nName $v too short"; }
+   if ($v=~/capa/i) {
+	if ($v!~/^oucapa\d+$/ && 
+	    ($v!~/^capa\d+$/ && $perlvar{'lonDefDomain'} eq 'uwsp')) {
+		 $error.="\nName $v contains 'capa'"; 
+	}
+   }
+   foreach my $bad ('res','raw','userfiles','priv','adm','uploaded',
+	'editupload') {
+      $error.="\nName $v reserved." if $v eq $bad;
+   }
+   if ($v=~/[^\w\-.]/) { $error.="\nName $v contains special characters"; }
+}
+if ($domainDescription!~/^[\(\)\-\w\s,]+$/) {
+   $error.="\nDomain Description contains special characters";
+} 
+foreach my $v ($perlvar{'lonExpire'},$perlvar{'lonLoadLim'}) {
+   unless ($v=~/^[\d+\.]+$/) { $error.="\nNumber expected instead of $v"; }
+}
+unless (($perlvar{'lonRole'} eq 'library') || ($perlvar{'lonRole'} eq 'access')) {
+   $error.="\nInvalid Role";
+}
+
+if (!defined($primaryLibServer)) {
+   if (@libservers > 0) {
+       $error .= "No primary library server ID designated. Choose from: ".join(',',sort(@libservers));
+   } else {
+       $error .= "No library servers in this domain (including current server)";
+   }
+} else {
+   if (length($primaryLibServer)>35) { $error.="\nPrimary Library Server ID:  $primaryLibServer too long"; }
+   if (length($primaryLibServer)<2) { $error.="\nPrimary Library Server ID:  $primaryLibServer too short"; }
+   if ($primaryLibServer =~/capa/i) {
+        if ($primaryLibServer!~/^oucapa\d+$/ &&
+            ($primaryLibServer!~/^capa\d+$/ && $perlvar{'lonDefDomain'} eq 'uwsp')) {
+                 $error.="\nPrimary library server ID $primaryLibServer contains 'capa'";
+        }
+   }
+   foreach my $bad ('res','raw','userfiles','priv','adm','uploaded',
+        'editupload') {
+      $error.="\nPrimary library server ID $primaryLibServer reserved." if $primaryLibServer eq $bad;
+   }
+   if ($primaryLibServer=~/[^\w\-.]/) { $error.="\nPrimary library server ID $primaryLibServer contains special characters"; }
 }
 
+
+if ($error) { print "\n*** ERRORS: $error\n"; }
   print(&lt;&lt;END);
-ENTER A CHOICE OF 1-10 TO CHANGE, otherwise ENTER 11:
+ENTER A CHOICE OF 1-11 TO CHANGE, otherwise ENTER 12:
 END
 my $choice=&lt;&gt;;
 chomp($choice);
@@ -632,25 +802,39 @@ END
   }
   elsif ($choice==4) {
   print(&lt;&lt;END);
-4) System Administrator's E-mail Address: $perlvar{'lonAdmEMail'}
+4) ID of primary library server for domain: $primaryLibServer
+ENTER NEW VALUE (this will be the LON-CAPA Machine ID of a library server in
+                 your domain; it cannot contain any of '_' '-' '.' or ':'. 
+                 This server will be where domain data which are not 
+                 associated with any specific home library server
+                 will be stored (e.g., e-mail broadcast by Domain Coordinators
+                 to users in the domain).
+END
+    my $choice2=&lt;&gt;;
+    chomp($choice2);
+    $primaryLibServer=$choice2;
+  }
+  elsif ($choice==5) {
+  print(&lt;&lt;END);
+5) Server Administrator's E-mail Address: $perlvar{'lonAdmEMail'}
 ENTER NEW VALUE:
 END
     my $choice2=&lt;&gt;;
     chomp($choice2);
     $perlvar{'lonAdmEMail'}=$choice2;
   }
-  elsif ($choice==5) {
+  elsif ($choice==6) {
   print(&lt;&lt;END);
-5) Support E-mail Address: $perlvar{'lonSupportEMail'}
+6) Support E-mail Address: $perlvar{'lonSupportEMail'}
 ENTER NEW VALUE:
 END
     my $choice2=&lt;&gt;;
     chomp($choice2);
     $perlvar{'lonSupportEMail'}=$choice2;
   }
-  elsif ($choice==6) {
+  elsif ($choice==7) {
   print(&lt;&lt;END);
-6) Role: $perlvar{'lonRole'}
+7) Role: $perlvar{'lonRole'}
 ENTER NEW VALUE (this should be either 'access' or 'library' 
                  if in doubt select 'library'):
 END
@@ -658,27 +842,27 @@ END
     chomp($choice2);
     $perlvar{'lonRole'}=$choice2;
   }
-  elsif ($choice==7) {
+  elsif ($choice==8) {
   print(&lt;&lt;END);
-7) Cache Expiration Time: $perlvar{'lonExpire'}
+8) Cache Expiration Time: $perlvar{'lonExpire'}
 ENTER NEW VALUE (in seconds, 86400 is a reasonable value):
 END
     my $choice2=&lt;&gt;;
     chomp($choice2);
     $perlvar{'lonExpire'}=$choice2;
   }
-  elsif ($choice==8) {
+  elsif ($choice==9) {
   print(&lt;&lt;END);
-8) Server Load: $perlvar{'lonLoadLim'}
+9) Server Load: $perlvar{'lonLoadLim'}
 ENTER NEW VALUE:
 END
     my $choice2=&lt;&gt;;
     chomp($choice2);
     $perlvar{'lonLoadLim'}=$choice2;
   }
-  elsif ($choice==9) {
+  elsif ($choice==10) {
   print(&lt;&lt;END);
-9) User Load: $perlvar{'lonUserLoadLim'}
+10) User Load: $perlvar{'lonUserLoadLim'}
 Numer of users that can login before machine is 'overloaded'
 ENTER NEW VALUE (integer value, 0 means there is no limit):
 END
@@ -686,9 +870,9 @@ END
     chomp($choice2);
     $perlvar{'lonUserLoadLim'}=$choice2;
   }
-  elsif ($choice==10) {
+  elsif ($choice==11) {
   print(&lt;&lt;END);
-10) Allow only secure connections: $securestatus 
+11) Allow only secure connections: $securestatus 
 The Lon-CAPA communication daemons lonc and lond can be configured to
 allow only secure connections by default.
 
@@ -715,19 +899,23 @@ END
     }
     ($securestatus,$securenum)=&securesetting(%perlvar);
   }
-  elsif ($choice==11) {
+  elsif (($choice==12) && (!$error)) {
     $flag=1;
   }
   else {
-
+    print "Invalid input.\n";
   }
 }
     open(OUT,"&gt;$confdir$filename") or
       die("Cannot output to $confdir$filename\n");
     foreach my $key (keys %perlvar) {
       my $value=$perlvar{$key};
+      my $line = "PerlSetVar     $key      $value";
+      if ($value eq '') {
+          $line = '#'.$line;
+      }
       print(OUT &lt;&lt;END) unless $perlvarstatic{$key};
-PerlSetVar     $key      $value
+$line
 END
     }
     close(OUT);
@@ -740,13 +928,13 @@ unless (-l "<TARGET />") {
   my $hostname=`hostname -f`;chomp($hostname);
   $date=`date -I`; chomp($date);
   $lonHostID=$perlvar{'lonHostID'};
-  $lonHostID=~s/\W//g;
+  $lonHostID=~s/[^\w\-.]//g;
   $lineexistflag=0;
   $hostidexistflag=0;
   $line2insert=&lt;&lt;END;
 $perlvar{'lonHostID'}:$perlvar{'lonDefDomain'}:$perlvar{'lonRole'}:$hostname
 END
-  $domaininsert="$perlvar{'lonDefDomain'}:$domainDescription:$domainTabExtras\n";
+  $domaininsert="$perlvar{'lonDefDomain'}:$domainDescription:$domainTabExtras:$primaryLibServer\n";
   if ($lonCluster eq 'standalone') {
     open(OUT,'&gt;../'.$lonCluster.'_hosts.tab') or
       die('file generation error');