home *** CD-ROM | disk | FTP | other *** search
/ SGI Hot Mix 12 / Silicon_Graphics_Developer_Magic_Soft_Dev_812-8101-012.iso / .all / httpd_ncsa / cgi-bin / AT-config.cgi < prev    next >
Encoding:
Text File  |  1995-11-10  |  16.4 KB  |  470 lines
  1. #!/bin/sh
  2. perl=/usr/local/etc/architext/perl
  3. eval "exec $perl -x $0 $*"
  4. #!perl
  5. ## Copyright Architext Software, 1994 (c)
  6. ##
  7. ## This CGI script allows users to configure Architext databases
  8. ## through a WWW interface. Naturally, there are plenty of security
  9. ## concerns associated with this scheme.
  10. ##
  11. ## This script appears as several different web pages, depending on
  12. ## its invocation. If invoked with a 'db=<database>' argument, the
  13. ## script prints out the configuration information for a particular
  14. ## database and then allows the user to change it. If invoked with
  15. ## 'new=<database>', the user is allowed to create a new database. If
  16. ## invoked with 'Update=Update' and 'dbname=<database>', it updates an
  17. ## existing database configuration file. Without any of these
  18. ## arguments, it displays a list of currently existing database.conf
  19. ## files, and also allows the user to create a new database.conf file.
  20.  
  21. $root = "/usr/local/etc/architext";
  22.  
  23. die "Invalid root directory '$root'\n" unless -d $root;
  24.  
  25. unshift(@INC, "$root/perllib");
  26. require 'architext.pl';
  27. require 'architextConf.pl';
  28.  
  29. %form = &Architext'readFormArgs;
  30. %attr = &ArchitextConf'readConfig("$root/Architext.conf", $form{'db'});
  31.  
  32. if (&Architext'remoteMode($root)) {
  33.     $helppath = &Architext'helpPath();
  34. } else {
  35.     $helppath = $attr{'ArchitextURL'};
  36. }
  37.  
  38. $scriptname = "AT-config.cgi";
  39.  
  40. ## check for password, if one is specified in Architext.conf
  41. ## if it doesn't appear as a form arg, present password page
  42. &Architext'password($attr{'ArchitextURL'},
  43.             $scriptname,
  44.             $attr{'Password'}, 
  45.             $form{'password'});
  46.  
  47. $attr{'Password'} =~ tr/a-zA-Z/n-za-mN-ZA-M/;
  48. $postpass = 
  49.     "<INPUT TYPE=\"hidden\" NAME=\"password\" VALUE=\"$attr{'Password'}\">" if
  50.     ($attr{'Password'});
  51. $getpass = "?password=$attr{'Password'}" if $postpass;
  52.  
  53. if ($form{'Update'}) {
  54.     ## Assuming all the relevant configuration options are specified
  55.     ## as form arguments, this mode actually writes the db.conf file.
  56.     ## will notify user if required information is missing from
  57.     ## the form by passing a message to the next page
  58.     ## Header again
  59.     if (! ($error_str = &createDbConf())) {
  60.     &Architext'printHeader($attr{'ArchitextURL'}, "Collection Configuration");
  61.  
  62.     if (!$form{'dbname'}) { 
  63.         &Architext'exitError($attr{'ArchitextURL'},
  64.                  "Configure specified with no dbname."); }
  65.     
  66.     ## Let the user know the update was a success.
  67.     print "<H2>Configuration successful</H2>\n";
  68.     print "<p><hr>\n";
  69.     if ($getpass) {
  70.         $getpass .= "&";
  71.     } else {
  72.         $getpass = "?";
  73.     }
  74.     $getpass .= "db=$form{'dbname'}";
  75.     print <<EOF;
  76. <b>Next steps:</b>
  77. <p> <FORM ACTION="AT-index.cgi" METHOD=POST>
  78. <INPUT TYPE="submit" NAME="Indexing" VALUE="Index">
  79. Create an index for this collection.
  80. <INPUT TYPE="hidden" NAME="db" VALUE="$form{'dbname'}">
  81. $postpass
  82. </FORM>
  83.  
  84. <p> 
  85. <FORM ACTION="AT-generate.cgi" METHOD=POST>
  86. <INPUT TYPE="submit" NAME="Generation" VALUE="Generate">
  87. Generate search pages for this collection.
  88. <INPUT TYPE="hidden" NAME="db" VALUE="$form{'dbname'}">
  89. $postpass
  90. </FORM>
  91.  
  92. <p> 
  93. <FORM ACTION="AT-admin.cgi" METHOD=POST>
  94. <INPUT TYPE="hidden" NAME="db" VALUE="$form{'dbname'}">
  95. <INPUT TYPE="submit" NAME="Admin" VALUE="Admin">
  96. Go back to the main admin page for this collection.
  97. $postpass
  98. </FORM>
  99. EOF
  100.     ;
  101.  
  102.     &Architext'Copyright($attr{'ArchitextURL'}); 
  103.     exit(0);
  104.     } else {
  105.     ## required elements were not passed in...
  106.     $message = $error_str;
  107.     $form{'db'} = $form{'dbname'};
  108.     }
  109. }
  110.  
  111. if ($form{'new'}) {
  112.     ## Print out a form to allow the user to create a new database.
  113.     $form{'new'} =~ s/\W+/_/g;
  114.  
  115.     ## check to see if user has entered name of existing db
  116.     opendir(CONF, "$root/collections");
  117.     @dbconf = grep(/\.conf$/, readdir(CONF));
  118.     for (@dbconf) {
  119.     s|\.conf$||;
  120.     $preexist = 1 if ($form{'new'} eq $_);
  121.     last if $preexist;
  122.     }
  123.  
  124.     if (! $preexist) {
  125.     ## Our standard header
  126.     &Architext'printHeader($attr{'ArchitextURL'}, 
  127.                    "Configure New Collection: $form{'new'}");
  128.     print "<p><b>ATTENTION: $message Try again.</b>" if $message;
  129.     
  130.     ## Read the default configuration information.
  131.     ##%attr = &ArchitextConf'readConfig("$root/Architext.conf");
  132.     
  133.     ## Print the form.
  134.     &printForm($form{'new'}, $form{'new'});
  135.     &Architext'Copyright($attr{'ArchitextURL'});
  136.     exit(0);
  137.     } else {
  138.     $form{'db'} = $form{'new'};
  139.     $message = "<b>You chose a name for the new collection that was already in use by an existing collection.</b>  Go back if you want to create a new collection, otherwise, you can now configure the collection whose name you specified.";
  140.     %attr = &ArchitextConf'readConfig("$root/Architext.conf", $form{'db'});
  141.     }
  142.     
  143. }  
  144. if ($form{'db'}) {
  145.     ## Print out configuration options for an already-existing
  146.     ## database, and allow the user to update the options.
  147.  
  148.     ## Dump our standard header
  149.     &Architext'printHeader($attr{'ArchitextURL'}, 
  150.                "Collection Configuration: $form{'db'}");
  151.  
  152.     ## print a message from the Update mode if something was missing
  153.     print "<b>ATTENTION: $message</b>" if $message;
  154.  
  155.     ## Check for the desired database.conf file.
  156.     $dbconfig = $root . "/collections/" . $form{'db'} . ".conf";
  157.     if (! -r $dbconfig) { 
  158.     &Architext'exitFileError($dbconfig, "does not exist"); 
  159.     }
  160.  
  161.     ## Read all the configuration information.
  162.     ##%attr = &ArchitextConf'readConfig("$root/Architext.conf", $form{'db'});
  163.  
  164.     ## Print the form.
  165.     &printForm($form{'db'});
  166.     &Architext'Copyright($attr{'ArchitextURL'});
  167.     
  168. } else { 
  169.   ## Print out the top-level screen: scan the root directory for 
  170.   ## db.conf files, and allow the user to initialize a new db.conf file.
  171.  
  172.     opendir(CONF, "$root/collections");
  173.     @dbconf = grep(/\.conf$/, readdir(CONF));
  174.  
  175.     &Architext'printHeader($attr{'ArchitextURL'}, "Collection Configuration");
  176.     print <<EOF;
  177. <FORM ACTION="http:AT-config.cgi" METHOD=POST>
  178. Choose a document collection to configure, or enter a new collection:<P>
  179. <DL>
  180. <DT> Existing 
  181. <a href="${helppath}AT-helpdoc.html#Document Collections">
  182. document collections:</a> <DD>
  183. EOF
  184.     ;
  185.     if ($#dbconf > -1) {
  186.     print "<SELECT NAME=\"db\" SIZE=5>"; 
  187.  
  188.     for (@dbconf) {
  189.         s|\.conf$||;
  190.         next if $_ eq 'Architext';
  191.         print "<OPTION> $_\n";
  192.     }
  193.     print "</SELECT><P>\n";
  194.     } else {
  195.     print "<p>(No document collections found)<p>\n";
  196.     }
  197.  
  198.     print <<EOF;        
  199. <DT> If you wish to configure a 
  200. <a href="${helppath}AT-helpdoc.html#New Collection">
  201. new collection</a> 
  202. please supply a name for it here. <DD> <INPUT NAME="new">
  203. </DL>
  204. <INPUT TYPE="submit" NAME="Configure" VALUE="Configure">
  205. $postpass
  206. </FORM>
  207. EOF
  208.     ;
  209.  
  210.     &Architext'Copyright($attr{'ArchitextURL'});
  211. }
  212.  
  213. ## Prints an input line for a form.
  214. sub printInputLine {
  215.     local($name, $text, $db) = @_;
  216.     local($val);
  217.     local($size);
  218.     $text = $name unless $text;
  219.     $val = eval "\$attr{$name}";
  220.     $val = "$attr{'ArchitextRoot'}/collections/" if $db;
  221.     $size=40;
  222.     $size = (length($val) +10) unless ((length($val) +10) < 40);
  223.     print <<EOF;
  224. <a href="${helppath}AT-helpdoc.html#$text">$text:</a> 
  225. <INPUT NAME="$name" VALUE="$val" SIZE=$size><P>
  226. EOF
  227.     ;
  228. }
  229.  
  230. ## Prints out the Architext form. Uses dynamic scoping to ensure that
  231. ## the values in the %attr array are properly set.
  232. sub printForm {
  233.     local($db, $new) = @_;
  234.     local($files, $rules);
  235.     local($fileval, $ruleval, $filter_html, $filter_both);
  236.     print "<p>Please use absolute pathnames for filenames.\n";
  237.     print qq(<FORM ACTION="http:AT-config.cgi" METHOD=POST>\n);
  238.     &printHiddenLine('IndexExecutable');
  239.     &printHiddenLine('SearchExecutable');
  240.     &printHiddenLine('StemTable');
  241.     &printHiddenLine('StopTable');
  242.     &printHiddenLine('CollectionInfo', 'CollectionInfo', "$db.cf");    
  243.     if ($new) {
  244.     print qq(<INPUT TYPE="hidden" NAME="new" VALUE="$new">);
  245.     }
  246.     print "Designate the directory where the index files will be stored.<br>";
  247.     &printInputLine('CollectionIndex', 'CollectionIndex', $db);
  248.     if ($attr{'IndexFilter'} =~ /^Text/) {
  249.     $filter_both = "CHECKED";
  250.     } else {
  251.     $filter_html = "CHECKED";
  252.     }
  253.     $files = "CHECKED" if ($attr{'CollectionContents'} =~ /^\+/);
  254.     $rules = "CHECKED" if (! ($attr{'CollectionContents'} =~ /^\+/));
  255.     if ($files) {
  256.     $fileval = $attr{'CollectionContents'};
  257.     $fileval =~ s/^\+//;
  258.     }
  259.     $ruleval = join("\n", split(/[:,;\s]+/,
  260.                 $attr{'CollectionContents'})) if $rules;
  261. print <<EOF;
  262. <p> Describe the <a href="${helppath}AT-helpdoc.html#CollectionContents">
  263. CollectionContents</a> (the files you wish to index): <br>
  264. Only HTML and ASCII files are recognized by the indexer.<hr>
  265. <INPUT TYPE="radio" NAME="FileSource" VALUE="FileList" $files>
  266. <b> Index Using Explicit List </b><ul>
  267. Index files listed in the following file:
  268. <INPUT NAME="FileList" VALUE="$fileval" SIZE=30><br>
  269. Filenames must be listed using absolute pathnames, with one
  270. filename per line.
  271.  
  272. </ul>
  273. <hr> 
  274. <INPUT TYPE="radio" NAME="FileSource" VALUE="Files" $rules>
  275. <b> Index Using Rules </b><ul>
  276. Using the options below, index the files and directories listed here: <br>
  277. <TEXTAREA NAME="Files" ROWS=4 COLS=60>$ruleval</TEXTAREA>
  278. <p>Select the types of files to include in the index.<br>
  279. <a href="${helppath}AT-helpdoc.html#IndexFilter">IndexFilter:</a>
  280. <INPUT TYPE="radio" NAME="IndexFilter" VALUE="HTML Files Only"
  281. $filter_html> HTML Files Only
  282. <INPUT TYPE="radio" NAME="IndexFilter" VALUE="Text And HTML Files" $filter_both> 
  283. Text And Html Files (non-binary files)
  284. <p>
  285. EOF
  286.     ;
  287.     print "Optionally designate a file that contains regular expressions which match filenames that you wish to exclude from the index.<br>";
  288.     &printInputLine('ExclusionRules');
  289.     print "</ul>";
  290.     print "<hr>";
  291.     
  292.     print "<p>If you would like to receive email notification when the indexing process completes, provide an address here.<br>";
  293.     &printInputLine('AdminMail');
  294.     print <<EOF;
  295. <p><INPUT TYPE="submit" NAME="Set" VALUE="Save">
  296. Save the configuration characteristics for this collection.
  297. <INPUT TYPE="hidden" NAME="Update" VALUE="Update">
  298. <INPUT TYPE="hidden" NAME="dbname" VALUE="$db">
  299. <INPUT TYPE="hidden" NAME="db" VALUE="$db">
  300. $postpass
  301. </FORM>
  302. EOF
  303.     ;
  304.  
  305.     if (-e "$root/collections/$db.conf") {
  306.     $dbline = "<INPUT TYPE=\"hidden\" NAME=\"db\" VALUE=\"$db\">";
  307.     }
  308.     print <<EOF;
  309. <p> 
  310. <FORM ACTION="AT-admin.cgi" METHOD=POST>
  311. $dbline
  312. <INPUT TYPE="submit" NAME="Admin" VALUE="Admin">
  313. Don't save, go back to the admin page.
  314. $postpass
  315. </FORM>
  316. EOF
  317.     ;
  318. }
  319.  
  320. ## pass around all the parameters that user doesn't need to see
  321. sub printHiddenLine {
  322.     local($name, $value, $dummy) = @_;
  323.     if (!&Architext'debugMode())
  324.     {
  325.     $val = eval "\$attr{$name}";
  326.     $val = "$attr{'ArchitextRoot'}/collections/$dummy" if $dummy;
  327.     print qq(<INPUT TYPE="hidden" NAME="$name" VALUE="$val">);
  328.     }
  329.     else
  330.     {
  331.     &printInputLine($name, $value, $dummy);
  332.     }                
  333. }
  334.  
  335.  
  336. ## writes a db conf file to disk and does some error checking
  337. ## to make sure that the user has entered sensible values.
  338. ## also adds the AdminMail field to Architext.conf if it is
  339. ## not already there, so that it will be defaulted in the
  340. ## future
  341. sub createDbConf {
  342.     local($dbconfig, $message, $collection_root, $exit, @index);
  343.     if (!$form{'CollectionIndex'}) {
  344.     return "You cannot leave the 'CollectionIndex' field blank.";
  345.     } 
  346.     if ($form{'FileSource'} eq 'FileList') {
  347.     return "You must supply a filename for the file list." 
  348.         unless $form{'FileList'};
  349.     }
  350.     if ($form{'FileSource'} eq 'Files') {
  351.     return "You must supply filenames for the files you wish to index."
  352.         unless $form{'Files'};
  353.     ##return "You can't specify a file list if you are using the 'Index Using Rules' option." if $form{'FileList'};
  354.     }
  355.     ## add rootnmame to collection index path
  356.     $dbconfig = $root . "/collections/" . $form{'dbname'} . ".conf";
  357.     $form{'CollectionIndex'} .= "/" unless $form{'CollectionIndex'} =~ /\/$/;
  358.     $collection_root = "$form{'CollectionIndex'}$form{'dbname'}";
  359.     ## Can we write to the db.conf file?
  360.     if (-e $dbconfig && ! -w $dbconfig) {
  361.     &Architext'exitFileError($attr{'ArchitextURL'}, 
  362.                  $dbconfig, "is not writable.");
  363.     }
  364.  
  365.     ## test user's entries to make sure they are valid
  366.     ## makes sense and will not be likely to kill the indexing
  367.     ## process.
  368.     return "The index binary '$form{'IndexExecutable'}' does not exist."
  369.     if (! -e $form{'IndexExecutable'});
  370.     return "The index binary '$form{'IndexExecutable'}' is not executable."
  371.     if (! -x $form{'IndexExecutable'});
  372.     return "The  search binary '$form{'SearchExecutable'}' does not exist."
  373.     if (! -e $form{'SearchExecutable'}); 
  374.     return "The  search binary '$form{'SearchExecutable'}' is not executable."
  375.     if (! -x $form{'SearchExecutable'}); 
  376.     return "The stem table '$form{'StemTable'}' is not readable."
  377.     if (! -r $form{'StemTable'}); 
  378.     return "The stop table '$form{'StopTable'}.key' is not readable."
  379.     if (! -r "$form{'StopTable'}.key");  
  380.     return "The stop table '$form{'StopTable'}.ptr' is not readable."
  381.     if (! -r "$form{'StopTable'}.ptr"); 
  382.     return "The CollectionIndex directory you specified ($form{'CollectionIndex'}) does not exist."
  383.     if (! -e $form{'CollectionIndex'});
  384.     return "The CollectionIndex directory you specified ($form{'CollectionIndex'}) is not a directory."
  385.     if (! -d $form{'CollectionIndex'});
  386.     return "The CollectionIndex directory you specified ($form{'CollectionIndex'}) is not writeable."
  387.     if (! -w $form{'CollectionIndex'});
  388.     if ($form{'ExclusionRules'}) {
  389.     return "The ExclusionRules file you specified ($form{'ExclusionRules'}) does not exist."
  390.         if (! -e $form{'ExclusionRules'});
  391.     return "The ExclusionRules file you specified ($form{'ExclusionRules'}) is not readable."
  392.         if (! -r $form{'ExclusionRules'});
  393.     }
  394.     if ($form{'FileSource'} eq 'FileList') {
  395.     $form{'FileList'} =~ s/^\s+//;
  396.     $form{'FileList'} =~ s/\s+$//;
  397.     return "Please specify only one file list file." if ($form{'FileList'} =~ /\S\s\S/);
  398.     $form{'CollectionContents'} = "+$form{'FileList'}";
  399.     } else {
  400.     $form{'CollectionContents'} = join(" ", split(/[:,;\s]+/, 
  401.                               $form{'Files'}));
  402.     }
  403.     @index = split(/[:,;\s]+/, $form{'CollectionContents'});
  404.     for (@index) {
  405.     if (/^\+/) {
  406.         if ($form{'FileSource'} eq 'Files') {
  407.         return "Bad filename given.  ($_) Please use absolute pathnames.";
  408.         }
  409.         s/^\+//;
  410.         return "Could not find file list '$_'.  Please re-enter the file list filename."
  411.         if (! -e $_);
  412.         return "Could not read from file list '$_'.  Please re-enter the file list filename."
  413.         if (! -r $_);
  414.         ## check to to enforce files in file list appear under html root
  415.         open(FLIST, "$_");
  416.         while (<FLIST>) {
  417.         if (! &underHtmlRoot($attr{'HtmlRoot'}, $_)) {
  418.             close(FLIST);
  419.             return "The file '$_' specified in the file list does not appear under your html root.  Please specify files that appear under your html root, or your Web server will not have access to them.";
  420.         }
  421.         }
  422.         close(FLIST);
  423.     } else {
  424.         ## check here to enforce that files appear under html root
  425.         return "Specified file or directory '$_'  does not appear under your html root.  Please specify files that appear under your html root, or your Web server will not have access to them." unless &underHtmlRoot($attr{'HtmlRoot'}, $_);
  426.         return "Specified file or directory '$_' does not exist.  Please re-enter the list of files to index."
  427.         if (! -e $_);
  428.         return "Could not read from the specified file or directory '$_'.  Please re-enter the list of files to index."
  429.         if (! -r $_);
  430.     }
  431.     }
  432.     if (! open(DBCONF, ">$dbconfig")) {
  433.     &Architext'exitFileError($attr{'ArchitextURL'}, 
  434.                  $dbconfig, 
  435.                  "could not be opened for writing."); 
  436.     }
  437.  
  438.     ## now that everything has been tested for accuracy, write to disk
  439.     print DBCONF "<Collection $form{'dbname'}>\n";
  440.     for ('IndexExecutable', 'SearchExecutable', 'StemTable', 'StopTable',
  441.      'CollectionContents', 'CollectionIndex', 'CollectionInfo',
  442.      'IndexFilter') {
  443.     print DBCONF "$_ $form{$_}\n";
  444.     }
  445.     print DBCONF "CollectionRoot $collection_root\n";
  446.     print DBCONF "AdminMail $form{'AdminMail'}\n";
  447.     print DBCONF "ExclusionRules $form{'ExclusionRules'}\n" if $form{'ExclusionRules'};
  448.     print DBCONF "</Collection>\n";
  449.     close(DBCONF);
  450.     ## put AdminMail in Architext.conf if it is not already there
  451.     if ($form{'AdminMail'} && (! $attr{'AdminMail'})) {
  452.     $command = "echo AdminMail $form{'AdminMail'} >> $root/Architext.conf";
  453.     $exit = system($command);
  454.     &Architext'exitError($attr{'ArchitextURL'},
  455.                  "Error updating Architext.conf with AdminMail - $!") if $exit;
  456.     }
  457.     return($message);
  458. }
  459.  
  460. sub underHtmlRoot {
  461.     local($root, $file) = @_;
  462.     local($prefix);
  463.     $root =~ s|\/$|| if ($root =~ /\/$/);
  464.     $prefix = substr($file, 0, length($root));
  465.     return 1 if ($prefix eq $root);
  466.     return 0;
  467. }
  468.  
  469.  
  470.