[BACK]Return to loncommon.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / interface

Diff for /loncom/interface/loncommon.pm between versions 1.20 and 1.55

version 1.20, 2001/12/25 21:02:35 version 1.55, 2002/08/21 17:18:08
Line 30 Line 30
 # 12/11,12/12,12/17 Scott Harrison  # 12/11,12/12,12/17 Scott Harrison
 # 12/21 Gerd Kortemeyer  # 12/21 Gerd Kortemeyer
 # 12/21 Scott Harrison  # 12/21 Scott Harrison
 # 12/25 Gerd Kortemeyer  # 12/25,12/28 Gerd Kortemeyer
   # YEAR=2002
   # 1/4 Gerd Kortemeyer
   # 6/24,7/2 H. K. Ng
   
 # Makes a table out of the previous attempts  # Makes a table out of the previous attempts
 # Inputs result_from_symbread, user, domain, course_id  # Inputs result_from_symbread, user, domain, course_id
 # Reads in non-network-related .tab files  # Reads in non-network-related .tab files
   
   # POD header:
   
   =pod
   
   =head1 NAME
   
   Apache::loncommon - pile of common routines
   
   =head1 SYNOPSIS
   
   Referenced by other mod_perl Apache modules.
   
   Invocation:
    &Apache::loncommon::SUBROUTINENAME(ARGUMENTS);
   
   =head1 INTRODUCTION
   
   Common collection of used subroutines.  This collection helps remove
   redundancy from other modules and increase efficiency of memory usage.
   
   Current things done:
   
    Makes a table out of the previous homework attempts
    Inputs result_from_symbread, user, domain, course_id
    Reads in non-network-related .tab files
   
   This is part of the LearningOnline Network with CAPA project
   described at http://www.lon-capa.org.
   
   =head2 General Subroutines
   
   =over 4
   
   =cut 
   
   # End of POD header
 package Apache::loncommon;  package Apache::loncommon;
   
 use strict;  use strict;
 use POSIX qw(strftime);  use Apache::lonnet();
   use GDBM_File;
   use POSIX qw(strftime mktime);
 use Apache::Constants qw(:common);  use Apache::Constants qw(:common);
 use Apache::lonmsg();  use Apache::lonmsg();
   my $readit;
   
   =pod 
   
   =item Global Variables
   
   =over 4
   
   =cut
 # ----------------------------------------------- Filetypes/Languages/Copyright  # ----------------------------------------------- Filetypes/Languages/Copyright
 my %language;  my %language;
 my %cprtag;  my %cprtag;
 my %fe; my %fd;  my %fe; my %fd;
 my %fc;  my %category_extensions;
   
   # ---------------------------------------------- Thesaurus variables
   
   =pod
   
   =item %Keywords  
   
   A hash used by &keyword to determine if a word is considered a keyword.
   
   =item $thesaurus_db_file
   
   Scalar containing the full path to the thesaurus database.                 
   
   =cut
   
   my %Keywords;
   my $thesaurus_db_file;
   
   
 # -------------------------------------------------------------- Thesaurus data  =pod
 my @therelated=();  
 my @theword=();  =back
 my @thecount=();  
 my %theindex=();  =cut
 my $thetotalcount=0;  
 my $thefuzzy=2;  
 my $thethreshold=0.1/$thefuzzy;  
 my $theavecount;  
   
 # ----------------------------------------------------------------------- BEGIN  # ----------------------------------------------------------------------- BEGIN
   
   =pod
   
   =item BEGIN() 
   
   Initialize values from language.tab, copyright.tab, filetypes.tab,
   thesaurus.tab, and filecategories.tab.
   
   =cut
   
   # ----------------------------------------------------------------------- BEGIN
   
 BEGIN {  BEGIN {
       # Variable initialization
       $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
       #
       unless ($readit) {
 # ------------------------------------------------------------------- languages  # ------------------------------------------------------------------- languages
     {      {
  my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}.   my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}.
Line 95  BEGIN { Line 174  BEGIN {
     while (<$fh>) {      while (<$fh>) {
  next if /^\#/;   next if /^\#/;
  chomp;   chomp;
  my ($key,$val)=(split(/\s+/,$_,2));   my ($extension,$category)=(split(/\s+/,$_,2));
  push @{$fc{$key}},$val;   push @{$category_extensions{lc($category)}},$extension;
     }      }
  }   }
     }      }
Line 116  BEGIN { Line 195  BEGIN {
     }      }
  }   }
     }      }
 # -------------------------------------------------------------- Thesaurus data      &Apache::lonnet::logthis(
     {                "<font color=yellow>INFO: Read file types</font>");
  my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}.      $readit=1;
        '/thesaurus.dat');      }  # end of unless($readit) 
  if ($fh) {      
             while (<$fh>) {  
                my ($tword,$tindex,$tcount,$trelated)=split(/\@/,$_);  
                $theindex{$tword}=$tindex;  
                $theword[$tindex]=$tword;  
                $thecount[$tindex]=$tcount;  
                $thetotalcount+=$tcount;  
                $therelated[$tindex]=$trelated;  
    }  
         }  
         $theavecount=$thetotalcount/$#thecount;  
     }  
 }  }
 # ============================================================= END BEGIN BLOCK  # ============================================================= END BEGIN BLOCK
   ###############################################################
   ##           HTML and Javascript Helper Functions            ##
   ###############################################################
   
   =pod 
   
 # ---------------------------------------------------------- Is this a keyword?  =item browser_and_searcher_javascript 
   
 sub keyword {  Returns scalar containing javascript to open a browser window
     my $newword=shift;  or a searcher window.  Also creates 
     $newword=~s/\W//g;  
     $newword=~tr/A-Z/a-z/;  =over 4
     my $tindex=$theindex{$newword};  
     if ($tindex) {  =item openbrowser(formname,elementname,only,omit) [javascript]
         if ($thecount[$tindex]>$theavecount) {  
            return 1;  inputs: formname, elementname, only, omit
   
   formname and elementname indicate the name of the html form and name of
   the element that the results of the browsing selection are to be placed in. 
   
   Specifying 'only' will restrict the browser to displaying only files
   with the given extension.  Can be a comma seperated list.
   
   Specifying 'omit' will restrict the browser to NOT displaying files
   with the given extension.  Can be a comma seperated list.
   
   =item opensearcher(formname, elementname) [javascript]
   
   Inputs: formname, elementname
   
   formname and elementname specify the name of the html form and the name
   of the element the selection from the search results will be placed in.
   
   =back
   
   =cut
   
   ###############################################################
   sub browser_and_searcher_javascript {
       return <<END;
       var editbrowser = null;
       function openbrowser(formname,elementname,only,omit) {
           var url = '/res/?';
           if (editbrowser == null) {
               url += 'launch=1&';
           }
           url += 'catalogmode=interactive&';
           url += 'mode=edit&';
           url += 'form=' + formname + '&';
           if (only != null) {
               url += 'only=' + only + '&';
           } 
           if (omit != null) {
               url += 'omit=' + omit + '&';
         }          }
           url += 'element=' + elementname + '';
           var title = 'Browser';
           var options = 'scrollbars=1,resizable=1,menubar=0';
           options += ',width=700,height=600';
           editbrowser = open(url,title,options,'1');
           editbrowser.focus();
     }      }
     return 0;      var editsearcher;
       function opensearcher(formname,elementname) {
           var url = '/adm/searchcat?';
           if (editsearcher == null) {
               url += 'launch=1&';
           }
           url += 'catalogmode=interactive&';
           url += 'mode=edit&';
           url += 'form=' + formname + '&';
           url += 'element=' + elementname + '';
           var title = 'Search';
           var options = 'scrollbars=1,resizable=1,menubar=0';
           options += ',width=700,height=600';
           editsearcher = open(url,title,options,'1');
           editsearcher.focus();
       }
   END
 }  }
 # -------------------------------------------------------- Return related words  
   
 sub related {  
     my $newword=shift;  
     $newword=~s/\W//g;  ###############################################################
     $newword=~tr/A-Z/a-z/;  
     my $tindex=$theindex{$newword};  =pod
     if ($tindex) {  
         my %found=();  =item linked_select_forms(...)
         foreach (split(/\,/,$therelated[$tindex])) {  
 # - Related word found  linked_select_forms returns a string containing a <script></script> block
             my ($ridx,$rcount)=split(/\:/,$_);  and html for two <select> menus.  The select menus will be linked in that
 # - Direct relation index  changing the value of the first menu will result in new values being placed
             my $directrel=$rcount/$thecount[$tindex];  in the second menu.  The values in the select menu will appear in alphabetical
             if ($directrel>$thethreshold) {  order.
                foreach (split(/\,/,$therelated[$ridx])) {  
                   my ($rridx,$rrcount)=split(/\:/,$_);  linked_select_forms takes the following ordered inputs:
                   if ($rridx==$tindex) {  
 # - Determine reverse relation index  =over 4
                      my $revrel=$rrcount/$thecount[$ridx];  
 # - Calculate full index  =item $formname, the name of the <form> tag
                      $found{$ridx}=$directrel*$revrel;  
                      if ($found{$ridx}>$thethreshold) {  =item $middletext, the text which appears between the <select> tags
                         foreach (split(/\,/,$therelated[$ridx])) {  
                             my ($rrridx,$rrrcount)=split(/\:/,$_);  =item $firstdefault, the default value for the first menu
                             unless ($found{$rrridx}) {  
                                my $revrevrel=$rrrcount/$thecount[$ridx];  =item $firstselectname, the name of the first <select> tag
                                if (  
                           $directrel*$revrel*$revrevrel>$thethreshold  =item $secondselectname, the name of the second <select> tag
                                ) {  
                                   $found{$rrridx}=  =item $hashref, a reference to a hash containing the data for the menus.
                                        $directrel*$revrel*$revrevrel;  
                                }  =back 
                             }  
                         }  Below is an example of such a hash.  Only the 'text', 'default', and 
                      }  'select2' keys must appear as stated.  keys(%menu) are the possible 
   values for the first select menu.  The text that coincides with the 
   first menu value is given in $menu{$choice1}->{'text'}.  The values 
   and text for the second menu are given in the hash pointed to by 
   $menu{$choice1}->{'select2'}.  
   
   my %menu = ( A1 => { text =>"Choice A1" ,
                         default => "B3",
                         select2 => { 
                             B1 => "Choice B1",
                             B2 => "Choice B2",
                             B3 => "Choice B3",
                             B4 => "Choice B4"
                             }
                     },
                 A2 => { text =>"Choice A2" ,
                         default => "C2",
                         select2 => { 
                             C1 => "Choice C1",
                             C2 => "Choice C2",
                             C3 => "Choice C3"
                             }
                     },
                 A3 => { text =>"Choice A3" ,
                         default => "D6",
                         select2 => { 
                             D1 => "Choice D1",
                             D2 => "Choice D2",
                             D3 => "Choice D3",
                             D4 => "Choice D4",
                             D5 => "Choice D5",
                             D6 => "Choice D6",
                             D7 => "Choice D7"
                             }
                   }                    }
                }                );
   
   =cut
   
   # ------------------------------------------------
   
   sub linked_select_forms {
       my ($formname,
           $middletext,
           $firstdefault,
           $firstselectname,
           $secondselectname, 
           $hashref
           ) = @_;
       my $second = "document.$formname.$secondselectname";
       my $first = "document.$formname.$firstselectname";
       # output the javascript to do the changing
       my $result = '';
       $result.="<script>\n";
       $result.="var select2data = new Object();\n";
       $" = '","';
       my $debug = '';
       foreach my $s1 (sort(keys(%$hashref))) {
           $result.="select2data.d_$s1 = new Object();\n";        
           $result.="select2data.d_$s1.def = new String('".
               $hashref->{$s1}->{'default'}."');\n";
           $result.="select2data.d_$s1.values = new Array(";        
           my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
           $result.="\"@s2values\");\n";
           $result.="select2data.d_$s1.texts = new Array(";        
           my @s2texts;
           foreach my $value (@s2values) {
               push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
           }
           $result.="\"@s2texts\");\n";
       }
       $"=' ';
       $result.= <<"END";
   
   function select1_changed() {
       // Determine new choice
       var newvalue = "d_" + $first.value;
       // update select2
       var values     = select2data[newvalue].values;
       var texts      = select2data[newvalue].texts;
       var select2def = select2data[newvalue].def;
       var i;
       // out with the old
       for (i = 0; i < $second.options.length; i++) {
           $second.options[i] = null;
       }
       // in with the nuclear
       for (i=0;i<values.length; i++) {
           $second.options[i] = new Option(values[i]);
           $second.options[i].text = texts[i];
           if (values[i] == select2def) {
               $second.options[i].selected = true;
           }
       }
   }
   </script>
   END
       # output the initial values for the selection lists
       $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
       foreach my $value (sort(keys(%$hashref))) {
           $result.="    <option value=\"$value\" ";
           $result.=" selected=\"true\" " if ($value eq $firstdefault);
           $result.=">$hashref->{$value}->{'text'}</option>\n";
       }
       $result .= "</select>\n";
       my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
       $result .= $middletext;
       $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
       my $seconddefault = $hashref->{$firstdefault}->{'default'};
       foreach my $value (sort(keys(%select2))) {
           $result.="    <option value=\"$value\" ";        
           $result.=" selected=\"true\" " if ($value eq $seconddefault);
           $result.=">$select2{$value}</option>\n";
       }
       $result .= "</select>\n";
       #    return $debug;
       return $result;
   }   #  end of sub linked_select_forms {
   
   ###############################################################
   
   =pod
   
   =item help_open_topic($topic, $text, $stayOnPage, $width, $height)
   
   Returns a string corresponding to an HTML link to the given help $topic, where $topic corresponds to the name of a .tex file in /home/httpd/html/adm/help/tex, with underscores replaced by spaces.
   
   $text will optionally be linked to the same topic, allowing you to link text in addition to the graphic. If you do not want to link text, but wish to specify one of the later parameters, pass an empty string.
   
   $stayOnPage is a value that will be interpreted as a boolean. If true, the link will not open a new window. If false, the link will open a new window using Javascript. (Default is false.)
   
   $width and $height are optional numerical parameters that will override the width and height of the popped up window, which may be useful for certain help topics with big pictures included.
   
   =cut
   
   sub help_open_topic {
       my ($topic, $text, $stayOnPage, $width, $height) = @_;
       $text = "" if (not defined $text);
       $stayOnPage = 0 if (not defined $stayOnPage);
       $width = 350 if (not defined $width);
       $height = 400 if (not defined $height);
       my $filename = $topic;
       $filename =~ s/ /_/g;
   
       my $template = "";
       my $link;
   
       if (!$stayOnPage)
       {
    $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height'))";
       }
       else
       {
    $link = "/adm/help/${filename}.hlp";
       }
   
       # Add the text
       if ($text ne "")
       {
    $template .= "<a href=\"$link\">$text</a> ";
       }
   
       # Add the graphic
       $template .= <<"ENDTEMPLATE";
   <a href="$link"><image src="/adm/help/gif/smallHelp.gif" border="0" alt="(Help: $topic)"></a>
   ENDTEMPLATE
   
       return $template;
   
   }
   
   =pod
   
   =item csv_translate($text) 
   
   Translate $text to allow it to be output as a 'comma seperated values' 
   format.
   
   =cut
   
   sub csv_translate {
       my $text = shift;
       $text =~ s/\"/\"\"/g;
       $text =~ s/\n//g;
       return $text;
   }
   
   ###############################################################
   ##        Home server <option> list generating code          ##
   ###############################################################
   #-------------------------------------------
   
   =pod
   
   =item get_domains()
   
   Returns an array containing each of the domains listed in the hosts.tab
   file.
   
   =cut
   
   #-------------------------------------------
   sub get_domains {
       # The code below was stolen from "The Perl Cookbook", p 102, 1st ed.
       my @domains;
       my %seen;
       foreach (sort values(%Apache::lonnet::hostdom)) {
           push (@domains,$_) unless $seen{$_}++;
       }
       return @domains;
   }
   
   #-------------------------------------------
   
   =pod
   
   =item select_dom_form($defdom,$name)
   
   Returns a string containing a <select name='$name' size='1'> form to 
   allow a user to select the domain to preform an operation in.  
   See loncreateuser.pm for an example invocation and use.
   
   =cut
   
   #-------------------------------------------
   sub select_dom_form {
       my ($defdom,$name) = @_;
       my @domains = get_domains();
       my $selectdomain = "<select name=\"$name\" size=\"1\">\n";
       foreach (@domains) {
           $selectdomain.="<option value=\"$_\" ".
               ($_ eq $defdom ? 'selected' : '').
                   ">$_</option>\n";
       }
       $selectdomain.="</select>";
       return $selectdomain;
   }
   
   #-------------------------------------------
   
   =pod
   
   =item get_library_servers($domain)
   
   Returns a hash which contains keys like '103l3' and values like 
   'kirk.lite.msu.edu'.  All of the keys will be for machines in the
   given $domain.
   
   =cut
   
   #-------------------------------------------
   sub get_library_servers {
       my $domain = shift;
       my %library_servers;
       foreach (keys(%Apache::lonnet::libserv)) {
           if ($Apache::lonnet::hostdom{$_} eq $domain) {
               $library_servers{$_} = $Apache::lonnet::hostname{$_};
           }
       }
       return %library_servers;
   }
   
   #-------------------------------------------
   
   =pod
   
   =item home_server_option_list($domain)
   
   returns a string which contains an <option> list to be used in a 
   <select> form input.  See loncreateuser.pm for an example.
   
   =cut
   
   #-------------------------------------------
   sub home_server_option_list {
       my $domain = shift;
       my %servers = &get_library_servers($domain);
       my $result = '';
       foreach (sort keys(%servers)) {
           $result.=
               '<option value="'.$_.'">'.$_.' '.$servers{$_}."</option>\n";
       }
       return $result;
   }
   ###############################################################
   ##    End of home server <option> list generating code       ##
   ###############################################################
   
   ###############################################################
   ##    Authentication changing form generation subroutines    ##
   ###############################################################
   ##
   ## All of the authform_xxxxxxx subroutines take their inputs in a
   ## hash, and have reasonable default values.
   ##
   ##    formname = the name given in the <form> tag.
   #-------------------------------------------
   
   =pod
   
   =item authform_xxxxxx
   
   The authform_xxxxxx subroutines provide javascript and html forms which 
   handle some of the conveniences required for authentication forms.  
   This is not an optimal method, but it works.  
   
   See loncreateuser.pm for invocation and use examples.
   
   =over 4
   
   =item authform_header
   
   =item authform_authorwarning
   
   =item authform_nochange
   
   =item authform_kerberos
   
   =item authform_internal
   
   =item authform_filesystem
   
   =back
   
   =cut
   
   #-------------------------------------------
   sub authform_header{  
       my %in = (
           formname => 'cu',
           kerb_def_dom => 'MSU.EDU',
           @_,
       );
       $in{'formname'} = 'document.' . $in{'formname'};
       my $result='';
       $result.=<<"END";
   var current = new Object();
   current.radiovalue = 'nochange';
   current.argfield = null;
   
   function changed_radio(choice,currentform) {
       var choicearg = choice + 'arg';
       // If a radio button in changed, we need to change the argfield
       if (current.radiovalue != choice) {
           current.radiovalue = choice;
           if (current.argfield != null) {
               currentform.elements[current.argfield].value = '';
           }
           if (choice == 'nochange') {
               current.argfield = null;
           } else {
               current.argfield = choicearg;
               switch(choice) {
                   case 'krb': 
                       currentform.elements[current.argfield].value = 
                           "$in{'kerb_def_dom'}";
                   break;
                 default:
                   break;
             }              }
         }          }
     }      }
     return ();      return;
 }  }
   
   function changed_text(choice,currentform) {
       var choicearg = choice + 'arg';
       if (currentform.elements[choicearg].value !='') {
           switch (choice) {
               case 'krb': currentform.elements[choicearg].value =
                   currentform.elements[choicearg].value.toUpperCase();
                   break;
               default:
           }
           // clear old field
           if ((current.argfield != choicearg) && (current.argfield != null)) {
               currentform.elements[current.argfield].value = '';
           }
           current.argfield = choicearg;
       }
       set_auth_radio_buttons(choice,currentform);
       return;
   }
   
   function set_auth_radio_buttons(newvalue,currentform) {
       var i=0;
       while (i < currentform.login.length) {
           if (currentform.login[i].value == newvalue) { break; }
           i++;
       }
       if (i == currentform.login.length) {
           return;
       }
       current.radiovalue = newvalue;
       currentform.login[i].checked = true;
       return;
   }
   END
       return $result;
   }
   
   sub authform_authorwarning{
       my $result='';
       $result=<<"END";
   <i>As a general rule, only authors or co-authors should be filesystem
   authenticated (which allows access to the server filesystem).</i>
   END
       return $result;
   }
   
   sub authform_nochange{  
       my %in = (
                 formname => 'document.cu',
                 kerb_def_dom => 'MSU.EDU',
                 @_,
             );
       my $result='';
       $result.=<<"END";
   <input type="radio" name="login" value="nochange" checked="checked"
          onclick="javascript:changed_radio('nochange',$in{'formname'});">
   Do not change login data
   END
       return $result;
   }
   
   sub authform_kerberos{  
       my %in = (
                 formname => 'document.cu',
                 kerb_def_dom => 'MSU.EDU',
                 @_,
                 );
       my $result='';
       $result.=<<"END";
   <input type="radio" name="login" value="krb" 
          onclick="javascript:changed_radio('krb',$in{'formname'});"
          onchange="javascript:changed_radio('krb',$in{'formname'});">
   Kerberos authenticated with domain
   <input type="text" size="10" name="krbarg" value=""
          onchange="javascript:changed_text('krb',$in{'formname'});">
   END
       return $result;
   }
   
   sub authform_internal{  
       my %args = (
                   formname => 'document.cu',
                   kerb_def_dom => 'MSU.EDU',
                   @_,
                   );
       my $result='';
       $result.=<<"END";
   <input type="radio" name="login" value="int"
          onchange="javascript:changed_radio('int',$args{'formname'});"
          onclick="javascript:changed_radio('int',$args{'formname'});">
   Internally authenticated (with initial password 
   <input type="text" size="10" name="intarg" value=""
          onchange="javascript:changed_text('int',$args{'formname'});">
   END
       return $result;
   }
   
   sub authform_local{  
       my %in = (
                 formname => 'document.cu',
                 kerb_def_dom => 'MSU.EDU',
                 @_,
                 );
       my $result='';
       $result.=<<"END";
   <input type="radio" name="login" value="loc"
          onchange="javascript:changed_radio('loc',$in{'formname'});"
          onclick="javascript:changed_radio('loc',$in{'formname'});"> 
   Local Authentication with argument
   <input type="text" size="10" name="locarg" value=""
          onchange="javascript:changed_text('loc',$in{'formname'});">
   END
       return $result;
   }
   
   sub authform_filesystem{  
       my %in = (
                 formname => 'document.cu',
                 kerb_def_dom => 'MSU.EDU',
                 @_,
                 );
       my $result='';
       $result.=<<"END";
   <input type="radio" name="login" value="fsys" 
          onchange="javascript:changed_radio('fsys',$in{'formname'});"
          onclick="javascript:changed_radio('fsys',$in{'formname'});"> 
   Filesystem authenticated (with initial password 
   <input type="text" size="10" name="fsysarg" value=""
          onchange="javascript:changed_text('fsys',$in{'formname'});">
   END
       return $result;
   }
   
   ###############################################################
   ##   End Authentication changing form generation functions   ##
   ###############################################################
   
   ###############################################################
   ##                Thesaurus Functions                        ##
   ###############################################################
   
   =pod
   
   =item initialize_keywords
   
   Initializes the package variable %Keywords if it is empty.  Uses the
   package variable $thesaurus_db_file.
   
   =cut
   
   ###################################################
   
   sub initialize_keywords {
       return 1 if (scalar keys(%Keywords));
       # If we are here, %Keywords is empty, so fill it up
       #   Make sure the file we need exists...
       if (! -e $thesaurus_db_file) {
           &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                                    " failed because it does not exist");
           return 0;
       }
       #   Set up the hash as a database
       my %thesaurus_db;
       if (! tie(%thesaurus_db,'GDBM_File',
                 $thesaurus_db_file,&GDBM_READER(),0640)){
           &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                                    $thesaurus_db_file);
           return 0;
       } 
       #  Get the average number of appearances of a word.
       my $avecount = $thesaurus_db{'average.count'};
       #  Put keywords (those that appear > average) into %Keywords
       while (my ($word,$data)=each (%thesaurus_db)) {
           my ($count,undef) = split /:/,$data;
           $Keywords{$word}++ if ($count > $avecount);
       }
       untie %thesaurus_db;
       # Remove special values from %Keywords.
       foreach ('total.count','average.count') {
           delete($Keywords{$_}) if (exists($Keywords{$_}));
       }
       return 1;
   }
   
   ###################################################
   
   =pod
   
   =item keyword($word)
   
   Returns true if $word is a keyword.  A keyword is a word that appears more 
   than the average number of times in the thesaurus database.  Calls 
   &initialize_keywords
   
   =cut
   
   ###################################################
   
   sub keyword {
       return if (!&initialize_keywords());
       my $word=lc(shift());
       $word=~s/\W//g;
       return exists($Keywords{$word});
   }
   
   ###################################################
   #         Old code, to be removed soon            #
   ###################################################
   # -------------------------------------------------------- Return related words
   #sub related {
   #    my $newword=shift;
   #    $newword=~s/\W//g;
   #    $newword=~tr/A-Z/a-z/;
   #    my $tindex=$theindex{$newword};
   #    if ($tindex) {
   #        my %found=();
   #        foreach (split(/\,/,$therelated[$tindex])) {
   ## - Related word found
   #            my ($ridx,$rcount)=split(/\:/,$_);
   ## - Direct relation index
   #            my $directrel=$rcount/$thecount[$tindex];
   #            if ($directrel>$thethreshold) {
   #               foreach (split(/\,/,$therelated[$ridx])) {
   #                  my ($rridx,$rrcount)=split(/\:/,$_);
   #                  if ($rridx==$tindex) {
   ## - Determine reverse relation index
   #                     my $revrel=$rrcount/$thecount[$ridx];
   ## - Calculate full index
   #                     $found{$ridx}=$directrel*$revrel;
   #                     if ($found{$ridx}>$thethreshold) {
   #                        foreach (split(/\,/,$therelated[$ridx])) {
   #                            my ($rrridx,$rrrcount)=split(/\:/,$_);
   #                            unless ($found{$rrridx}) {
   #                               my $revrevrel=$rrrcount/$thecount[$ridx];
   #                               if (
   #                          $directrel*$revrel*$revrevrel>$thethreshold
   #                               ) {
   #                                  $found{$rrridx}=
   #                                       $directrel*$revrel*$revrevrel;
   #                               }
   #                            }
   #                        }
   #                     }
   #                  }
   #               }
   #            }
   #        }
   #    }
   #    return ();
   #}
   
   ###############################################################
   
   =pod 
   
   =item get_related_words
   
   Look up a word in the thesaurus.  Takes a scalar arguement and returns
   an array of words.  If the keyword is not in the thesaurus, an empty array
   will be returned.  The order of the words returned is determined by the
   database which holds them.
   
   Uses global $thesaurus_db_file.
   
   =cut
   
   ###############################################################
   
   sub get_related_words {
       my $keyword = shift;
       my %thesaurus_db;
       if (! -e $thesaurus_db_file) {
           &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                                    "failed because the file does not exist");
           return ();
       }
       if (! tie(%thesaurus_db,'GDBM_File',
                 $thesaurus_db_file,&GDBM_READER(),0640)){
           return ();
       } 
       my @Words=();
       if (exists($thesaurus_db{$keyword})) {
           $_ = $thesaurus_db{$keyword};
           (undef,@Words) = split/:/;  # The first element is the number of times
                                       # the word appears.  We do not need it now.
           for (my $i=0;$i<=$#Words;$i++) {
               ($Words[$i],undef)= split/\,/,$Words[$i];
           }
       }
       untie %thesaurus_db;
       return @Words;
   }
   
   ###############################################################
   ##              End Thesaurus Functions                      ##
   ###############################################################
   
 # ---------------------------------------------------------------- Language IDs  # ---------------------------------------------------------------- Language IDs
 sub languageids {  sub languageids {
     return sort(keys(%language));      return sort(keys(%language));
Line 216  sub copyrightdescription { Line 999  sub copyrightdescription {
   
 # ------------------------------------------------------------- File Categories  # ------------------------------------------------------------- File Categories
 sub filecategories {  sub filecategories {
     return sort(keys(%fc));      return sort(keys(%category_extensions));
 }  }
   
 # -------------------------------------- File Types within a specified category  # -------------------------------------- File Types within a specified category
 sub filecategorytypes {  sub filecategorytypes {
     return @{$fc{lc(shift(@_))}};      return @{$category_extensions{lc($_[0])}};
 }  }
   
 # ------------------------------------------------------------------ File Types  # ------------------------------------------------------------------ File Types
Line 245  sub filedescriptionex { Line 1028  sub filedescriptionex {
     return '.'.$ex.' '.$fd{lc($ex)};      return '.'.$ex.' '.$fd{lc($ex)};
 }  }
   
   # ---- Retrieve attempts by students
   # input
   # $symb             - problem including path
   # $username,$domain - that of the student
   # $course           - course name
   # $getattempt       - leave blank if want all attempts, else put something.
   # $regexp           - regular expression. If string matches regexp send to
   # $gradesub         - routine that process the string if it matches regexp
   # 
   # output
   # formatted as a table all the attempts, if any.
   #
 sub get_previous_attempt {  sub get_previous_attempt {
   my ($symb,$username,$domain,$course)=@_;    my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
   my $prevattempts='';    my $prevattempts='';
     no strict 'refs';
   if ($symb) {    if ($symb) {
     my (%returnhash)=      my (%returnhash)=
       &Apache::lonnet::restore($symb,$course,$domain,$username);        &Apache::lonnet::restore($symb,$course,$domain,$username);
Line 259  sub get_previous_attempt { Line 1055  sub get_previous_attempt {
   $lasthash{$_}=$returnhash{$version.':'.$_};    $lasthash{$_}=$returnhash{$version.':'.$_};
         }          }
       }        }
       $prevattempts='<table border=2></tr><th>History</th>';        $prevattempts='<table border="0" width="100%"><tr><td bgcolor="#777777">';
         $prevattempts.='<table border="0" width="100%"><tr bgcolor="#e6ffff"><td>History</td>';
       foreach (sort(keys %lasthash)) {        foreach (sort(keys %lasthash)) {
         $prevattempts.='<th>'.$_.'</th>';   my ($ign,@parts) = split(/\./,$_);
       }   if ($#parts > 0) {
       for ($version=1;$version<=$returnhash{'version'};$version++) {    my $data=$parts[-1];
         $prevattempts.='</tr><tr><th>Attempt '.$version.'</th>';    pop(@parts);
         foreach (sort(keys %lasthash)) {    $prevattempts.='<td>Part '.join('.',@parts).'<br />'.$data.'&nbsp;</td>';
   my $value;   } else {
   if ($_ =~ /timestamp/) {    if ($#parts == 0) {
     $value=scalar(localtime($returnhash{$version.':'.$_}));      $prevattempts.='<th>'.$parts[0].'</th>';
   } else {    } else {
     $value=$returnhash{$version.':'.$_};      $prevattempts.='<th>'.$ign.'</th>';
   }    }
   $prevattempts.='<td>'.$value.'</td>';      }
         }        }
         if ($getattempt eq '') {
    for ($version=1;$version<=$returnhash{'version'};$version++) {
     $prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Transaction '.$version.'</td>';
       foreach (sort(keys %lasthash)) {
          my $value;
          if ($_ =~ /timestamp/) {
     $value=scalar(localtime($returnhash{$version.':'.$_}));
          } else {
     $value=$returnhash{$version.':'.$_};
          }
          $prevattempts.='<td>'.$value.'&nbsp;</td>';   
       }
    }
       }        }
       $prevattempts.='</tr><tr><th>Current</th>';        $prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Current</td>';
       foreach (sort(keys %lasthash)) {        foreach (sort(keys %lasthash)) {
  my $value;   my $value;
  if ($_ =~ /timestamp/) {   if ($_ =~ /timestamp/) {
Line 283  sub get_previous_attempt { Line 1093  sub get_previous_attempt {
  } else {   } else {
   $value=$lasthash{$_};    $value=$lasthash{$_};
  }   }
  $prevattempts.='<td>'.$value.'</td>';   if ($_ =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
    $prevattempts.='<td>'.$value.'&nbsp;</td>';
       }        }
       $prevattempts.='</tr></table>';        $prevattempts.='</tr></table></td></tr></table>';
     } else {      } else {
       $prevattempts='Nothing submitted - no attempts.';        $prevattempts='Nothing submitted - no attempts.';
     }      }
Line 335  sub get_student_answers { Line 1146  sub get_student_answers {
   foreach my $element (@elements) {    foreach my $element (@elements) {
     $ENV{'form.grade_'.$element}=$old{$element};      $ENV{'form.grade_'.$element}=$old{$element};
   }    }
   $userview=~s/\<body[^\>]*\>//gi;  
   $userview=~s/\<\/body\>//gi;  
   $userview=~s/\<html\>//gi;  
   $userview=~s/\<\/html\>//gi;  
   $userview=~s/\<head\>//gi;  
   $userview=~s/\<\/head\>//gi;  
   $userview=~s/action\s*\=/would_be_action\=/gi;  
   return $userview;    return $userview;
 }  }
   
   ###############################################
   
   
   sub timehash {
       my @ltime=localtime(shift);
       return ( 'seconds' => $ltime[0],
                'minutes' => $ltime[1],
                'hours'   => $ltime[2],
                'day'     => $ltime[3],
                'month'   => $ltime[4]+1,
                'year'    => $ltime[5]+1900,
                'weekday' => $ltime[6],
                'dayyear' => $ltime[7]+1,
                'dlsav'   => $ltime[8] );
   }
   
   sub maketime {
       my %th=@_;
       return POSIX::mktime(
           ($th{'seconds'},$th{'minutes'},$th{'hours'},
            $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,$th{'dlsav'}));
   }
   
   
   sub findallcourses {
       my %courses=();
       my $now=time;
       foreach (keys %ENV) {
    if ($_=~/^user\.role\.\w+\.\/(\w+)\/(\w+)/) {
       my ($starttime,$endtime)=$ENV{$_};
               my $active=1;
               if ($starttime) {
    if ($now<$starttime) { $active=0; }
               }
               if ($endtime) {
                   if ($now>$endtime) { $active=0; }
               }
               if ($active) { $courses{$1.'_'.$2}=1; }
           }
       }
       return keys %courses;
   }
   
   ###############################################
   
   sub bodytag {
       my ($title,$function,$addentries)=@_;
       unless ($function) {
    $function='student';
           if ($ENV{'request.role'}=~/^(cc|in|ta|ep)/) {
       $function='coordinator';
           }
    if ($ENV{'request.role'}=~/^(su|dc|ad|li)/) {
               $function='admin';
           }
           if (($ENV{'request.role'}=~/^(au|ca)/) ||
               ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
               $function='author';
           }
       }
       my $img='';
       my $pgbg='';
       my $tabbg='';
       my $font='';
       my $link='';
       my $alink='#CC0000';
       my $vlink='';
       if ($function eq 'admin') {
           $img='admin';
           $pgbg='#FFFFCC';
           $tabbg='#CCCC99';
           $font='#772200';
           $link='#663300';
           $vlink='#666600';
       } elsif ($function eq 'coordinator') {
           $img='coordinator';
           $pgbg='#CCFFFF';
           $tabbg='#CCCCFF';
           $font='#000044';
           $link='#003333';
           $vlink='#006633';
      } elsif ($function eq 'author') {
           $img='author';
           $pgbg='#CCFFFF';
           $tabbg='#CCFFCC';
           $font='#004400';
           $link='#003333';
           $vlink='#006666';
       } else {
           $img='student';
           $pgbg='#FFFFAA';
           $tabbg='#FF9900';
           $font='#991100';
           $link='#993300';
           $vlink='#996600';
       }
   # role and realm
       my ($role,$realm)
          =&Apache::lonnet::plaintext((split(/\./,$ENV{'request.role'}))[0]);
   # realm
       if ($ENV{'request.course.id'}) {
    $realm=
            $ENV{'course.'.$ENV{'request.course.id'}.'.description'};
       }
       unless ($realm) { $realm='&nbsp;'; }
   # Set messages
       my $messages=localtime();
   # Output
       return(<<ENDBODY);
   <body bgcolor="$pgbg" text="$font" alink="$alink" vlink="$vlink" link="$link"
   $addentries>
   <table width="100%" cellspacing="0" border="0" cellpadding="0">
   <tr><td bgcolor="$font">
   <img src="/adm/lonInterFace/$img.jpg" /></td>
   <td bgcolor="$font"><font color='$pgbg'>$messages</font></td>
   </tr>
   <tr>
   <td rowspan="3" bgcolor="$tabbg">
   &nbsp;<font size="5"><b>$title</b></font>
   <td bgcolor="$tabbg"  align="right">
   <font size="2">
       $ENV{'environment.firstname'}
       $ENV{'environment.middlename'}
       $ENV{'environment.lastname'}
       $ENV{'environment.generation'}
       </font>&nbsp;
   </td>
   </tr>
   <tr><td bgcolor="$tabbg" align="right">
   <font size="2">$role</font>&nbsp;
   </td></tr>
   <tr>
   <td bgcolor="$tabbg" align="right"><font size="2">$realm</font>&nbsp;</td></tr>
   </table><br>
   ENDBODY
   }
   ###############################################
   
 sub get_unprocessed_cgi {  sub get_unprocessed_cgi {
   my ($query)= @_;    my ($query,$possible_names)= @_;
     # $Apache::lonxml::debug=1;
   foreach (split(/&/,$query)) {    foreach (split(/&/,$query)) {
     my ($name, $value) = split(/=/,$_);      my ($name, $value) = split(/=/,$_);
     $value =~ tr/+/ /;      $name = &Apache::lonnet::unescape($name);
     $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;      if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
     if (!defined($ENV{'form.'.$name})) { $ENV{'form.'.$name}=$value; }        $value =~ tr/+/ /;
         $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
         &Apache::lonxml::debug("Seting :$name: to :$value:");
         unless (defined($ENV{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
       }
   }    }
 }  }
   
 sub cacheheader {  sub cacheheader {
     unless ($ENV{'request.method'} eq 'GET') { return ''; }
   my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);    my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
   my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />    my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />                  <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
Line 365  sub cacheheader { Line 1313  sub cacheheader {
   
 sub no_cache {  sub no_cache {
   my ($r) = @_;    my ($r) = @_;
   my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);    unless ($ENV{'request.method'} eq 'GET') { return ''; }
     #my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
   $r->no_cache(1);    $r->no_cache(1);
   $r->header_out("Pragma" => "no-cache");    $r->header_out("Pragma" => "no-cache");
   $r->header_out("Expires" => $date);    #$r->header_out("Expires" => $date);
 }  }
 1;  
 __END__;  
   
   sub add_to_env {
     my ($name,$value)=@_;
     if (defined($ENV{$name})) {
       if (ref($ENV{$name})) {
         #already have multiple values
         push(@{ $ENV{$name} },$value);
       } else {
         #first time seeing multiple values, convert hash entry to an arrayref
         my $first=$ENV{$name};
         undef($ENV{$name});
         push(@{ $ENV{$name} },$first,$value);
       }
     } else {
       $ENV{$name}=$value;
     }
   }
   
 =head1 NAME  =pod
   
 Apache::loncommon - pile of common routines  =back 
   
 =head1 SYNOPSIS  =head2 CSV Upload/Handling functions
   
 Referenced by other mod_perl Apache modules.  =over 4
   
 Invocation:  =item  upfile_store($r)
  &Apache::loncommon::SUBROUTINENAME(ARGUMENTS);  
   
 =head1 INTRODUCTION  Store uploaded file, $r should be the HTTP Request object,
   needs $ENV{'form.upfile'}
   returns $datatoken to be put into hidden field
   
   =cut
   
   sub upfile_store {
       my $r=shift;
       $ENV{'form.upfile'}=~s/\r/\n/gs;
       $ENV{'form.upfile'}=~s/\f/\n/gs;
       $ENV{'form.upfile'}=~s/\n+/\n/gs;
       $ENV{'form.upfile'}=~s/\n+$//gs;
   
 Common collection of used subroutines.  This collection helps remove      my $datatoken=$ENV{'user.name'}.'_'.$ENV{'user.domain'}.
 redundancy from other modules and increase efficiency of memory usage.   '_enroll_'.$ENV{'request.course.id'}.'_'.time.'_'.$$;
       {
    my $fh=Apache::File->new('>'.$r->dir_config('lonDaemons').
    '/tmp/'.$datatoken.'.tmp');
    print $fh $ENV{'form.upfile'};
       }
       return $datatoken;
   }
   
 Current things done:  =item load_tmp_file($r)
   
  Makes a table out of the previous homework attempts  Load uploaded file from tmp, $r should be the HTTP Request object,
  Inputs result_from_symbread, user, domain, course_id  needs $ENV{'form.datatoken'},
  Reads in non-network-related .tab files  sets $ENV{'form.upfile'} to the contents of the file
   
 This is part of the LearningOnline Network with CAPA project  =cut
 described at http://www.lon-capa.org.  
   
 =head1 HANDLER SUBROUTINE  sub load_tmp_file {
       my $r=shift;
       my @studentdata=();
       {
    my $fh;
    if ($fh=Apache::File->new($r->dir_config('lonDaemons').
     '/tmp/'.$ENV{'form.datatoken'}.'.tmp')) {
       @studentdata=<$fh>;
    }
       }
       $ENV{'form.upfile'}=join('',@studentdata);
   }
   
 There is no handler subroutine.  =item upfile_record_sep()
   
 =head1 OTHER SUBROUTINES  Separate uploaded file into records
   returns array of records,
   needs $ENV{'form.upfile'} and $ENV{'form.upfiletype'}
   
 =over 4  =cut
   
 =item *  sub upfile_record_sep {
       if ($ENV{'form.upfiletype'} eq 'xml') {
       } else {
    return split(/\n/,$ENV{'form.upfile'});
       }
   }
   
 BEGIN() : initialize values from language.tab, copyright.tab, filetypes.tab,  =item record_sep($record)
 and filecategories.tab.  
   
 =item *  Separate a record into fields $record should be an item from the upfile_record_sep(), needs $ENV{'form.upfiletype'}
   
 languageids() : returns list of all language ids  =cut
   
 =item *  sub record_sep {
       my $record=shift;
       my %components=();
       if ($ENV{'form.upfiletype'} eq 'xml') {
       } elsif ($ENV{'form.upfiletype'} eq 'space') {
           my $i=0;
           foreach (split(/\s+/,$record)) {
               my $field=$_;
               $field=~s/^(\"|\')//;
               $field=~s/(\"|\')$//;
               $components{$i}=$field;
               $i++;
           }
       } elsif ($ENV{'form.upfiletype'} eq 'tab') {
           my $i=0;
           foreach (split(/\t+/,$record)) {
               my $field=$_;
               $field=~s/^(\"|\')//;
               $field=~s/(\"|\')$//;
               $components{$i}=$field;
               $i++;
           }
       } else {
           my @allfields=split(/\,/,$record);
           my $i=0;
           my $j;
           for ($j=0;$j<=$#allfields;$j++) {
               my $field=$allfields[$j];
               if ($field=~/^\s*(\"|\')/) {
    my $delimiter=$1;
                   while (($field!~/$delimiter$/) && ($j<$#allfields)) {
       $j++;
       $field.=','.$allfields[$j];
    }
                   $field=~s/^\s*$delimiter//;
                   $field=~s/$delimiter\s*$//;
               }
               $components{$i}=$field;
       $i++;
           }
       }
       return %components;
   }
   
 languagedescription() : returns description of a specified language id  =item upfile_select_html()
   
 =item *  return HTML code to select file and specify its type
   
 copyrightids() : returns list of all copyrights  =cut
   
 =item *  sub upfile_select_html {
       return (<<'ENDUPFORM');
   <input type="file" name="upfile" size="50">
   <br />Type: <select name="upfiletype">
   <option value="csv">CSV (comma separated values, spreadsheet)</option>
   <option value="space">Space separated</option>
   <option value="tab">Tabulator separated</option>
   <option value="xml">HTML/XML</option>
   </select>
   ENDUPFORM
   }
   
 copyrightdescription() : returns description of a specified copyright id  =item csv_print_samples($r,$records)
   
 =item *  Prints a table of sample values from each column uploaded $r is an
   Apache Request ref, $records is an arrayref from
   &Apache::loncommon::upfile_record_sep
   
   =cut
   
   sub csv_print_samples {
       my ($r,$records) = @_;
       my (%sone,%stwo,%sthree);
       %sone=&record_sep($$records[0]);
       if (defined($$records[1])) {%stwo=&record_sep($$records[1]);}
       if (defined($$records[2])) {%sthree=&record_sep($$records[2]);}
   
       $r->print('Samples<br /><table border="2"><tr>');
       foreach (sort({$a <=> $b} keys(%sone))) { $r->print('<th>Column&nbsp;'.($_+1).'</th>'); }
       $r->print('</tr>');
       foreach my $hash (\%sone,\%stwo,\%sthree) {
    $r->print('<tr>');
    foreach (sort({$a <=> $b} keys(%sone))) {
       $r->print('<td>');
       if (defined($$hash{$_})) { $r->print($$hash{$_}); }
       $r->print('</td>');
    }
    $r->print('</tr>');
       }
       $r->print('</tr></table><br />'."\n");
   }
   
   =item csv_print_select_table($r,$records,$d)
   
   Prints a table to create associations between values and table columns.
   $r is an Apache Request ref,
   $records is an arrayref from &Apache::loncommon::upfile_record_sep,
   $d is an array of 2 element arrays (internal name, displayed name)
   
   =cut
   
   sub csv_print_select_table {
       my ($r,$records,$d) = @_;
       my $i=0;my %sone;
       %sone=&record_sep($$records[0]);
       $r->print('Associate columns with student attributes.'."\n".
        '<table border="2"><tr><th>Attribute</th><th>Column</th></tr>'."\n");
       foreach (@$d) {
    my ($value,$display)=@{ $_ };
    $r->print('<tr><td>'.$display.'</td>');
   
    $r->print('<td><select name=f'.$i.
     ' onchange="javascript:flip(this.form,'.$i.');">');
    $r->print('<option value="none"></option>');
    foreach (sort({$a <=> $b} keys(%sone))) {
       $r->print('<option value="'.$_.'">Column '.($_+1).'</option>');
    }
    $r->print('</select></td></tr>'."\n");
    $i++;
       }
       $i--;
       return $i;
   }
   
   =item csv_samples_select_table($r,$records,$d)
   
   Prints a table of sample values from the upload and can make associate samples to internal names.
   
   $r is an Apache Request ref,
   $records is an arrayref from &Apache::loncommon::upfile_record_sep,
   $d is an array of 2 element arrays (internal name, displayed name)
   
   =cut
   
   sub csv_samples_select_table {
       my ($r,$records,$d) = @_;
       my %sone; my %stwo; my %sthree;
       my $i=0;
   
       $r->print('<table border=2><tr><th>Field</th><th>Samples</th></tr>');
       %sone=&record_sep($$records[0]);
       if (defined($$records[1])) {%stwo=&record_sep($$records[1]);}
       if (defined($$records[2])) {%sthree=&record_sep($$records[2]);}
   
       foreach (sort keys %sone) {
    $r->print('<tr><td><select name=f'.$i.
     ' onchange="javascript:flip(this.form,'.$i.');">');
    foreach (@$d) {
       my ($value,$display)=@{ $_ };
       $r->print('<option value='.$value.'>'.$display.'</option>');
    }
    $r->print('</select></td><td>');
    if (defined($sone{$_})) { $r->print($sone{$_}."</br>\n"); }
    if (defined($stwo{$_})) { $r->print($stwo{$_}."</br>\n"); }
    if (defined($sthree{$_})) { $r->print($sthree{$_}."</br>\n"); }
    $r->print('</td></tr>');
    $i++;
       }
       $i--;
       return($i);
   }
   1;
   __END__;
   
   =pod
   
   =back
   
   =head2 Access .tab File Data
   
   =over 4
   
   =item languageids() 
   
 filecategories() : returns list of all file categories  returns list of all language ids
   
 =item *  =item languagedescription() 
   
 filecategorytypes() : returns list of file types belonging to a given file  returns description of a specified language id
   
   =item copyrightids() 
   
   returns list of all copyrights
   
   =item copyrightdescription() 
   
   returns description of a specified copyright id
   
   =item filecategories() 
   
   returns list of all file categories
   
   =item filecategorytypes() 
   
   returns list of file types belonging to a given file
 category  category
   
 =item *  =item fileembstyle() 
   
 fileembstyle() : returns embedding style for a specified file type  returns embedding style for a specified file type
   
 =item *  =item filedescription() 
   
 filedescription() : returns description for a specified file type  returns description for a specified file type
   
 =item *  =item filedescriptionex() 
   
 filedescriptionex() : returns description for a specified file type with  returns description for a specified file type with
 extra formatting  extra formatting
   
 =item *  =back
   
 get_previous_attempt() : return string with previous attempt on problem  =head2 Alternate Problem Views
   
   =over 4
   
 =item *  =item get_previous_attempt() 
   
   return string with previous attempt on problem
   
   =item get_student_view() 
   
   show a snapshot of what student was looking at
   
   =item get_student_answers() 
   
   show a snapshot of how student was answering problem
   
   =back
   
   =head2 HTTP Helper
   
   =over 4
   
 get_student_view() : show a snapshot of what student was looking at  =item get_unprocessed_cgi($query,$possible_names)
   
 =item *  Modify the %ENV hash to contain unprocessed CGI form parameters held in
   $query.  The parameters listed in $possible_names (an array reference),
   will be set in $ENV{'form.name'} if they do not already exist.
   
 get_student_answers() : show a snapshot of how student was answering problem  Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
   $possible_names is an ref to an array of form element names.  As an example:
   get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
   will result in $ENV{'form.uname'} and $ENV{'form.udom'} being set.
   
 =item *  =item cacheheader() 
   
 get_unprocessed_cgi() : get unparsed CGI parameters  returns cache-controlling header code
   
 =item *  =item nocache() 
   
 cacheheader() : returns cache-controlling header code  specifies header code to not have cache
   
 =item *  =item add_to_env($name,$value) 
   
 nocache() : specifies header code to not have cache  adds $name to the %ENV hash with value
   $value, if $name already exists, the entry is converted to an array
   reference and $value is added to the array.
   
 =back  =back
   
Removed from v.1.20  
changed lines
  Added in v.1.55

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