--- loncom/interface/loncommon.pm 2002/04/26 18:57:27 1.36
+++ loncom/interface/loncommon.pm 2003/09/19 15:06:42 1.121
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# a pile of common routines
#
-# $Id: loncommon.pm,v 1.36 2002/04/26 18:57:27 matthew Exp $
+# $Id: loncommon.pm,v 1.121 2003/09/19 15:06:42 albertel Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -27,12 +27,11 @@
#
# YEAR=2001
# 2/13-12/7 Guy Albertelli
-# 12/11,12/12,12/17 Scott Harrison
# 12/21 Gerd Kortemeyer
-# 12/21 Scott Harrison
# 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
# Inputs result_from_symbread, user, domain, course_id
@@ -40,35 +39,23 @@
# 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);
+Common routines for manipulating connections, student answers,
+ domains, common Javascript fragments, etc.
-=head1 INTRODUCTION
+=head1 OVERVIEW
-Common collection of used subroutines. This collection helps remove
+A collection of commonly used subroutines that don't have a natural
+home anywhere else. 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 Subroutines
-
-=over 4
-
=cut
# End of POD header
@@ -76,39 +63,80 @@ package Apache::loncommon;
use strict;
use Apache::lonnet();
-use POSIX qw(strftime);
-use Apache::Constants qw(:common);
+use GDBM_File;
+use POSIX qw(strftime mktime);
+use Apache::Constants qw(:common :http :methods);
use Apache::lonmsg();
+use Apache::lonmenu();
+use Apache::lonlocal;
my $readit;
+=pod
+
+=head1 Global Variables
+
+=cut
+
# ----------------------------------------------- Filetypes/Languages/Copyright
my %language;
my %cprtag;
my %fe; my %fd;
-my %fc;
+my %category_extensions;
-# -------------------------------------------------------------- Thesaurus data
-my @therelated;
-my @theword;
-my @thecount;
-my %theindex;
-my $thetotalcount;
-my $thefuzzy=2;
-my $thethreshold=0.1/$thefuzzy;
-my $theavecount;
+# ---------------------------------------------- Designs
+
+my %designhash;
+
+# ---------------------------------------------- Thesaurus variables
+
+# FIXME: I don't think it's necessary to document these things;
+# they're privately used - Jeremy
+
+=pod
+
+=over 4
+
+=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.
+
+=back
+
+=cut
+
+my %Keywords;
+my $thesaurus_db_file;
# ----------------------------------------------------------------------- BEGIN
-=item BEGIN()
+
+# FIXME: I don't think this needs to be documented, it prepares
+# private data structures - Jeremy
+=pod
+
+=head1 General Subroutines
+
+=over 4
+
+=item * BEGIN()
Initialize values from language.tab, copyright.tab, filetypes.tab,
-and filecategories.tab.
+thesaurus.tab, and filecategories.tab.
+
+=back
=cut
+
# ----------------------------------------------------------------------- BEGIN
BEGIN {
-
+ # Variable initialization
+ $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
+ #
unless ($readit) {
# ------------------------------------------------------------------- languages
{
@@ -118,8 +146,8 @@ BEGIN {
while (<$fh>) {
next if /^\#/;
chomp;
- my ($key,$val)=(split(/\s+/,$_,2));
- $language{$key}=$val;
+ my ($key,$two,$country,$three,$enc,$val)=(split(/\t/,$_));
+ $language{$key}=$val.' - '.$enc;
}
}
}
@@ -136,6 +164,30 @@ BEGIN {
}
}
}
+
+# -------------------------------------------------------------- domain designs
+
+ my $filename;
+ my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
+ opendir(DIR,$designdir);
+ while ($filename=readdir(DIR)) {
+ my ($domain)=($filename=~/^(\w+)\./);
+ {
+ my $fh=Apache::File->new($designdir.'/'.$filename);
+ if ($fh) {
+ while (<$fh>) {
+ next if /^\#/;
+ chomp;
+ my ($key,$val)=(split(/\=/,$_));
+ if ($val) { $designhash{$domain.'.'.$key}=$val; }
+ }
+ }
+ }
+
+ }
+ closedir(DIR);
+
+
# ------------------------------------------------------------- file categories
{
my $fh=Apache::File->new($Apache::lonnet::perlvar{'lonTabDir'}.
@@ -144,8 +196,8 @@ BEGIN {
while (<$fh>) {
next if /^\#/;
chomp;
- my ($key,$val)=(split(/\s+/,$_,2));
- push @{$fc{$key}},$val;
+ my ($extension,$category)=(split(/\s+/,$_,2));
+ push @{$category_extensions{lc($category)}},$extension;
}
}
}
@@ -165,31 +217,179 @@ 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;
+ &Apache::lonnet::logthis(
+ "INFO: Read file types");
+ $readit=1;
+ } # end of unless($readit)
+
+}
+
+###############################################################
+## HTML and Javascript Helper Functions ##
+###############################################################
+
+=pod
+
+=head1 HTML and Javascript Functions
+
+=over 4
+
+=item * browser_and_searcher_javascript ()
+
+XXReturns a string
+containing javascript with two functions, C and
+C. Returned string does not contain EscriptE
+tags.
+
+=over 4
+
+=item * openbrowser(formname,elementname,only,omit) [javascript]
+
+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 <
+ var stdeditbrowser;
+ function openstdbrowser(formname,uname,udom,roleflag) {
+ var url = '/adm/pickstudent?';
+ var filter;
+ eval('filter=document.'+formname+'.'+uname+'.value;');
+ if (filter != null) {
+ if (filter != '') {
+ url += 'filter='+filter+'&';
}
}
- $theavecount=$thetotalcount/$#thecount;
+ url += 'form=' + formname + '&unameelement='+uname+
+ '&udomelement='+udom;
+ if (roleflag) { url+="&roles=1"; }
+ var title = 'Student_Browser';
+ var options = 'scrollbars=1,resizable=1,menubar=0';
+ options += ',width=700,height=600';
+ stdeditbrowser = open(url,title,options,'1');
+ stdeditbrowser.focus();
}
- &Apache::lonnet::logthis(
- "INFO: Read file types and thesaurus");
- $readit=1;
+
+ENDSTDBRW
}
-
+
+sub selectstudent_link {
+ my ($form,$unameele,$udomele)=@_;
+ if ($ENV{'request.course.id'}) {
+ unless (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})) {
+ return '';
+ }
+ return "".&mt('Select User')."";
+ }
+ if ($ENV{'request.role'}=~/^(au|dc|su)/) {
+ return "".&mt('Select User')."";
+ }
+ return '';
+}
+
+sub coursebrowser_javascript {
+ return (<<'ENDSTDBRW');
+
+ENDSTDBRW
+}
+
+sub selectcourse_link {
+ my ($form,$unameele,$udomele)=@_;
+ return "".&mt('Select Course')."";
}
-# ============================================================= END BEGIN BLOCK
-=item linked_select_forms(...)
+=pod
+
+=item * linked_select_forms(...)
linked_select_forms returns a string containing a block
and html for two