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

Diff for /loncom/interface/loncommon.pm between versions 1.44 and 1.56

version 1.44, 2002/07/05 16:12:31 version 1.56, 2002/08/22 13:39:42
Line 41 Line 41
   
 # POD header:  # POD header:
   
   =pod
   
 =head1 NAME  =head1 NAME
   
 Apache::loncommon - pile of common routines  Apache::loncommon - pile of common routines
Line 77  package Apache::loncommon; Line 79  package Apache::loncommon;
   
 use strict;  use strict;
 use Apache::lonnet();  use Apache::lonnet();
 use POSIX qw(strftime);  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;  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 %category_extensions;  my %category_extensions;
   
 # -------------------------------------------------------------- Thesaurus data  # ---------------------------------------------- Thesaurus variables
 my @therelated;  
 my @theword;  =pod
 my @thecount;  
 my %theindex;  =item %Keywords  
 my $thetotalcount;  
 my $thefuzzy=2;  A hash used by &keyword to determine if a word is considered a keyword.
 my $thethreshold=0.1/$thefuzzy;  
 my $theavecount;  =item $thesaurus_db_file
   
   Scalar containing the full path to the thesaurus database.                 
   
   =cut
   
   my %Keywords;
   my $thesaurus_db_file;
   
   
   =pod
   
   =back
   
   =cut
   
 # ----------------------------------------------------------------------- BEGIN  # ----------------------------------------------------------------------- BEGIN
   
Line 105  my $theavecount; Line 129  my $theavecount;
 =item BEGIN()   =item BEGIN() 
   
 Initialize values from language.tab, copyright.tab, filetypes.tab,  Initialize values from language.tab, copyright.tab, filetypes.tab,
 and filecategories.tab.  thesaurus.tab, and filecategories.tab.
   
 =cut  =cut
   
 # ----------------------------------------------------------------------- BEGIN  # ----------------------------------------------------------------------- BEGIN
   
 BEGIN {  BEGIN {
       # Variable initialization
       $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
       #
     unless ($readit) {      unless ($readit) {
 # ------------------------------------------------------------------- languages  # ------------------------------------------------------------------- languages
     {      {
Line 168  BEGIN { Line 195  BEGIN {
     }      }
  }   }
     }      }
 # -------------------------------------------------------------- Thesaurus data  
     {  
  my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}.  
        '/thesaurus.dat');  
  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;  
     }  
     &Apache::lonnet::logthis(      &Apache::lonnet::logthis(
               "<font color=yellow>INFO: Read file types and thesaurus</font>");                "<font color=yellow>INFO: Read file types</font>");
     $readit=1;      $readit=1;
 }      }  # end of unless($readit) 
           
 }  }
 # ============================================================= END BEGIN BLOCK  # ============================================================= END BEGIN BLOCK
Line 231  of the element the selection from the se Line 242  of the element the selection from the se
 ###############################################################  ###############################################################
 sub browser_and_searcher_javascript {  sub browser_and_searcher_javascript {
     return <<END;      return <<END;
     var editbrowser;      var editbrowser = null;
     function openbrowser(formname,elementname,only,omit) {      function openbrowser(formname,elementname,only,omit) {
         var url = '/res/?';          var url = '/res/?';
         if (editbrowser == null) {          if (editbrowser == null) {
Line 342  my %menu = ( A1 => { text =>"Choice A1" Line 353  my %menu = ( A1 => { text =>"Choice A1"
                   }                    }
               );                );
   
 =back  
   
 =cut  =cut
   
 # ------------------------------------------------  # ------------------------------------------------
Line 428  END Line 437  END
   
 ###############################################################  ###############################################################
   
   =pod
   
 =item help_open_topic($topic, $stayOnPage, $width, $height)  =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.  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.)  $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.  $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.
Line 440  $width and $height are optional numerica Line 452  $width and $height are optional numerica
 =cut  =cut
   
 sub help_open_topic {  sub help_open_topic {
     my ($topic, $stayOnPage, $width, $height) = @_;      my ($topic, $text, $stayOnPage, $width, $height) = @_;
       $text = "" if (not defined $text);
     $stayOnPage = 0 if (not defined $stayOnPage);      $stayOnPage = 0 if (not defined $stayOnPage);
     $width = 350 if (not defined $width);      $width = 350 if (not defined $width);
     $height = 400 if (not defined $height);      $height = 400 if (not defined $height);
     my $filename = $topic;      my $filename = $topic;
     $filename =~ s/ /_/g;      $filename =~ s/ /_/g;
   
     my $template;      my $template = "";
       my $link;
   
     if (!$stayOnPage)      if (!$stayOnPage)
     {      {
         $template = <<"ENDTEMPLATE";   $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height'))";
 <a href="javascript:void(open('/adm/help/${filename}.hlp', 'Help for $topic', 'menubar=0,s  
 crollbars=1,width=$width,height=$height'))"><image  
   src="/adm/help/gif/smallHelp.gif"  
   border="0" alt="(Help: $topic)"></a>  
 ENDTEMPLATE  
     }      }
     else      else
     {      {
         $template = <<"ENDTEMPLATE";   $link = "/adm/help/${filename}.hlp";
 <a href="/adm/help/${filename}.hlp"><image      }
   src="/adm/help/gif/smallHelp.gif"  
   border="0" alt="(Help: $topic)"></a>      # Add the text
 ENDTEMPLATE      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;      return $template;
   
 }  }
   
   =pod
   
 =item csv_translate($text)   =item csv_translate($text) 
   
 Translate $text to allow it to be output as a 'comma seperated values'   Translate $text to allow it to be output as a 'comma seperated values' 
Line 486  sub csv_translate { Line 504  sub csv_translate {
 }  }
   
 ###############################################################  ###############################################################
   
 ###############################################################  
 ##        Home server <option> list generating code          ##  ##        Home server <option> list generating code          ##
 ###############################################################  ###############################################################
 #-------------------------------------------  #-------------------------------------------
   
   =pod
   
 =item get_domains()  =item get_domains()
   
 Returns an array containing each of the domains listed in the hosts.tab  Returns an array containing each of the domains listed in the hosts.tab
Line 512  sub get_domains { Line 530  sub get_domains {
   
 #-------------------------------------------  #-------------------------------------------
   
   =pod
   
 =item select_dom_form($defdom,$name)  =item select_dom_form($defdom,$name)
   
 Returns a string containing a <select name='$name' size='1'> form to   Returns a string containing a <select name='$name' size='1'> form to 
Line 536  sub select_dom_form { Line 556  sub select_dom_form {
   
 #-------------------------------------------  #-------------------------------------------
   
 =item get_home_servers($domain)  =pod
   
   =item get_library_servers($domain)
   
 Returns a hash which contains keys like '103l3' and values like   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  'kirk.lite.msu.edu'.  All of the keys will be for machines in the
Line 545  given $domain. Line 567  given $domain.
 =cut  =cut
   
 #-------------------------------------------  #-------------------------------------------
 sub get_home_servers {  sub get_library_servers {
     my $domain = shift;      my $domain = shift;
     my %home_servers;      my %library_servers;
     foreach (keys(%Apache::lonnet::libserv)) {      foreach (keys(%Apache::lonnet::libserv)) {
         if ($Apache::lonnet::hostdom{$_} eq $domain) {          if ($Apache::lonnet::hostdom{$_} eq $domain) {
             $home_servers{$_} = $Apache::lonnet::hostname{$_};              $library_servers{$_} = $Apache::lonnet::hostname{$_};
         }          }
     }      }
     return %home_servers;      return %library_servers;
 }  }
   
 #-------------------------------------------  #-------------------------------------------
   
   =pod
   
 =item home_server_option_list($domain)  =item home_server_option_list($domain)
   
 returns a string which contains an <option> list to be used in a   returns a string which contains an <option> list to be used in a 
Line 568  returns a string which contains an <opti Line 592  returns a string which contains an <opti
 #-------------------------------------------  #-------------------------------------------
 sub home_server_option_list {  sub home_server_option_list {
     my $domain = shift;      my $domain = shift;
     my %servers = &get_home_servers($domain);      my %servers = &get_library_servers($domain);
     my $result = '';      my $result = '';
     foreach (sort keys(%servers)) {      foreach (sort keys(%servers)) {
         $result.=          $result.=
Line 590  sub home_server_option_list { Line 614  sub home_server_option_list {
 ##    formname = the name given in the <form> tag.  ##    formname = the name given in the <form> tag.
 #-------------------------------------------  #-------------------------------------------
   
   =pod
   
 =item authform_xxxxxx  =item authform_xxxxxx
   
 The authform_xxxxxx subroutines provide javascript and html forms which   The authform_xxxxxx subroutines provide javascript and html forms which 
Line 791  END Line 817  END
 ##   End Authentication changing form generation functions   ##  ##   End Authentication changing form generation functions   ##
 ###############################################################  ###############################################################
   
   ###############################################################
   ##                Thesaurus Functions                        ##
   ###############################################################
   
   =pod
   
   =item initialize_keywords
   
 # ---------------------------------------------------------- Is this a keyword?  Initializes the package variable %Keywords if it is empty.  Uses the
   package variable $thesaurus_db_file.
   
 sub keyword {  =cut
     my $newword=shift;  
     $newword=~s/\W//g;  ###################################################
     $newword=~tr/A-Z/a-z/;  
     my $tindex=$theindex{$newword};  sub initialize_keywords {
     if ($tindex) {      return 1 if (scalar keys(%Keywords));
         if ($thecount[$tindex]>$theavecount) {      # If we are here, %Keywords is empty, so fill it up
            return 1;      #   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 0;      return 1;
 }  }
 # -------------------------------------------------------- Return related words  
   
 sub related {  ###################################################
     my $newword=shift;  
     $newword=~s/\W//g;  =pod
     $newword=~tr/A-Z/a-z/;  
     my $tindex=$theindex{$newword};  =item keyword($word)
     if ($tindex) {  
         my %found=();  Returns true if $word is a keyword.  A keyword is a word that appears more 
         foreach (split(/\,/,$therelated[$tindex])) {  than the average number of times in the thesaurus database.  Calls 
 # - Related word found  &initialize_keywords
             my ($ridx,$rcount)=split(/\:/,$_);  
 # - Direct relation index  =cut
             my $directrel=$rcount/$thecount[$tindex];  
             if ($directrel>$thethreshold) {  ###################################################
                foreach (split(/\,/,$therelated[$ridx])) {  
                   my ($rridx,$rrcount)=split(/\:/,$_);  sub keyword {
                   if ($rridx==$tindex) {      return if (!&initialize_keywords());
 # - Determine reverse relation index      my $word=lc(shift());
                      my $revrel=$rrcount/$thecount[$ridx];      $word=~s/\W//g;
 # - Calculate full index      return exists($Keywords{$word});
                      $found{$ridx}=$directrel*$revrel;  }
                      if ($found{$ridx}>$thethreshold) {  
                         foreach (split(/\,/,$therelated[$ridx])) {  ###############################################################
                             my ($rrridx,$rrrcount)=split(/\:/,$_);  
                             unless ($found{$rrridx}) {  =pod 
                                my $revrevrel=$rrrcount/$thecount[$ridx];  
                                if (  =item get_related_words
                           $directrel*$revrel*$revrevrel>$thethreshold  
                                ) {  Look up a word in the thesaurus.  Takes a scalar arguement and returns
                                   $found{$rrridx}=  an array of words.  If the keyword is not in the thesaurus, an empty array
                                        $directrel*$revrel*$revrevrel;  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];
         }          }
     }      }
     return ();      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 967  sub get_previous_attempt { Line 1046  sub get_previous_attempt {
  } else {   } else {
   $value=$lasthash{$_};    $value=$lasthash{$_};
  }   }
  if ($_ =~/$regexp$/) {$value = &$gradesub($value)}   if ($_ =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
  $prevattempts.='<td>'.$value.'&nbsp;</td>';   $prevattempts.='<td>'.$value.'&nbsp;</td>';
       }        }
       $prevattempts.='</tr></table></td></tr></table>';        $prevattempts.='</tr></table></td></tr></table>';
Line 1025  sub get_student_answers { Line 1104  sub get_student_answers {
   
 ###############################################  ###############################################
   
   
   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 {
Line 1079  sub add_to_env { Line 1292  sub add_to_env {
   
 =pod  =pod
   
   =back 
   
 =head2 CSV Upload/Handling functions  =head2 CSV Upload/Handling functions
   
 =over 4  =over 4
Line 1108  sub upfile_store { Line 1323  sub upfile_store {
     return $datatoken;      return $datatoken;
 }  }
   
   =pod
   
 =item load_tmp_file($r)  =item load_tmp_file($r)
   
 Load uploaded file from tmp, $r should be the HTTP Request object,  Load uploaded file from tmp, $r should be the HTTP Request object,
Line 1129  sub load_tmp_file { Line 1346  sub load_tmp_file {
     $ENV{'form.upfile'}=join('',@studentdata);      $ENV{'form.upfile'}=join('',@studentdata);
 }  }
   
   =pod
   
 =item upfile_record_sep()  =item upfile_record_sep()
   
 Separate uploaded file into records  Separate uploaded file into records
Line 1144  sub upfile_record_sep { Line 1363  sub upfile_record_sep {
     }      }
 }  }
   
   =pod
   
 =item record_sep($record)  =item record_sep($record)
   
 Separate a record into fields $record should be an item from the upfile_record_sep(), needs $ENV{'form.upfiletype'}  Separate a record into fields $record should be an item from the upfile_record_sep(), needs $ENV{'form.upfiletype'}
Line 1194  sub record_sep { Line 1415  sub record_sep {
     return %components;      return %components;
 }  }
   
   =pod
   
 =item upfile_select_html()  =item upfile_select_html()
   
 return HTML code to select file and specify its type  return HTML code to select file and specify its type
Line 1212  sub upfile_select_html { Line 1435  sub upfile_select_html {
 ENDUPFORM  ENDUPFORM
 }  }
   
   =pod
   
 =item csv_print_samples($r,$records)  =item csv_print_samples($r,$records)
   
 Prints a table of sample values from each column uploaded $r is an  Prints a table of sample values from each column uploaded $r is an
Line 1242  sub csv_print_samples { Line 1467  sub csv_print_samples {
     $r->print('</tr></table><br />'."\n");      $r->print('</tr></table><br />'."\n");
 }  }
   
   =pod
   
 =item csv_print_select_table($r,$records,$d)  =item csv_print_select_table($r,$records,$d)
   
 Prints a table to create associations between values and table columns.  Prints a table to create associations between values and table columns.
Line 1274  sub csv_print_select_table { Line 1501  sub csv_print_select_table {
     return $i;      return $i;
 }  }
   
   =pod
   
 =item csv_samples_select_table($r,$records,$d)  =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.  Prints a table of sample values from the upload and can make associate samples to internal names.
Removed from v.1.44  
changed lines
  Added in v.1.56

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