--- loncom/interface/loncommon.pm 2003/03/28 01:53:55 1.92 +++ loncom/interface/loncommon.pm 2003/11/04 21:21:35 1.143 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # a pile of common routines # -# $Id: loncommon.pm,v 1.92 2003/03/28 01:53:55 www Exp $ +# $Id: loncommon.pm,v 1.143 2003/11/04 21:21:35 matthew Exp $ # # Copyright Michigan State University Board of Trustees # @@ -47,29 +47,15 @@ Apache::loncommon - pile of common routi =head1 SYNOPSIS -Referenced by other mod_perl Apache modules. +Common routines for manipulating connections, student answers, + domains, common Javascript fragments, etc. -Invocation: - &Apache::loncommon::SUBROUTINENAME(ARGUMENTS); +=head1 OVERVIEW -=head1 INTRODUCTION - -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 General Subroutines - -=over 4 - =cut # End of POD header @@ -79,20 +65,23 @@ use strict; use Apache::lonnet(); use GDBM_File; use POSIX qw(strftime mktime); -use Apache::Constants qw(:common); +use Apache::Constants qw(:common :http :methods); use Apache::lonmsg(); use Apache::lonmenu(); +use Apache::lonlocal; +use HTML::Entities; + my $readit; =pod -=item Global Variables - -=over 4 +=head1 Global Variables =cut + # ----------------------------------------------- Filetypes/Languages/Copyright my %language; +my %supported_language; my %cprtag; my %fe; my %fd; my %category_extensions; @@ -103,37 +92,45 @@ my %designhash; # ---------------------------------------------- Thesaurus variables +# FIXME: I don't think it's necessary to document these things; +# they're privately used - Jeremy + =pod -=item %Keywords +=over 4 + +=item * %Keywords A hash used by &keyword to determine if a word is considered a keyword. -=item $thesaurus_db_file +=item * $thesaurus_db_file Scalar containing the full path to the thesaurus database. +=back + =cut my %Keywords; my $thesaurus_db_file; +# ----------------------------------------------------------------------- BEGIN +# FIXME: I don't think this needs to be documented, it prepares +# private data structures - Jeremy =pod -=back - -=cut - -# ----------------------------------------------------------------------- BEGIN +=head1 General Subroutines -=pod +=over 4 -=item BEGIN() +=item * BEGIN() Initialize values from language.tab, copyright.tab, filetypes.tab, thesaurus.tab, and filecategories.tab. +=back + =cut # ----------------------------------------------------------------------- BEGIN @@ -151,8 +148,11 @@ BEGIN { while (<$fh>) { next if /^\#/; chomp; - my ($key,$val)=(split(/\s+/,$_,2)); - $language{$key}=$val; + my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$_)); + $language{$key}=$val.' - '.$enc; + if ($sup) { + $supported_language{$key}=$sup; + } } } } @@ -228,21 +228,27 @@ BEGIN { } # end of unless($readit) } -# ============================================================= END BEGIN BLOCK + ############################################################### ## HTML and Javascript Helper Functions ## ############################################################### =pod -=item browser_and_searcher_javascript +=head1 HTML and Javascript Functions + +=over 4 + +=item * browser_and_searcher_javascript () -Returns scalar containing javascript to open a browser window -or a searcher window. Also creates +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] +=item * openbrowser(formname,elementname,only,omit) [javascript] inputs: formname, elementname, only, omit @@ -255,7 +261,7 @@ with the given extension. Can be a comm 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] +=item * opensearcher(formname, elementname) [javascript] Inputs: formname, elementname @@ -266,11 +272,10 @@ of the element the selection from the se =cut -############################################################### sub browser_and_searcher_javascript { return < var stdeditbrowser; - function openstdbrowser(formname,uname,udom) { + function openstdbrowser(formname,uname,udom,roleflag) { var url = '/adm/pickstudent?'; var filter; eval('filter=document.'+formname+'.'+uname+'.value;'); @@ -329,7 +341,8 @@ sub studentbrowser_javascript { } url += 'form=' + formname + '&unameelement='+uname+ '&udomelement='+udom; - var title = 'Student Browser'; + 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'); @@ -340,17 +353,24 @@ ENDSTDBRW } sub selectstudent_link { - my ($form,$unameele,$udomele)=@_; - unless ($ENV{'request.course.id'}) { return ''; } - unless (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})) { - return ''; + my ($form,$unameele,$udomele)=@_; + if ($ENV{'request.course.id'}) { + unless (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})) { + return ''; + } + return "".&mt('Select User').""; } - return "Select User"; + if ($ENV{'request.role'}=~/^(au|dc|su)/) { + return "".&mt('Select User').""; + } + return ''; } sub coursebrowser_javascript { - return (<<'ENDSTDBRW'); + my ($domainfilter)=@_; + return (< var stdeditbrowser; function opencrsbrowser(formname,uname,udom) { @@ -361,9 +381,15 @@ sub coursebrowser_javascript { url += 'filter='+filter+'&'; } } + var domainfilter='$domainfilter'; + if (domainfilter != null) { + if (domainfilter != '') { + url += 'domainfilter='+domainfilter+'&'; + } + } url += 'form=' + formname + '&cnumelement='+uname+ '&cdomelement='+udom; - var title = 'Course Browser'; + var title = 'Course_Browser'; var options = 'scrollbars=1,resizable=1,menubar=0'; options += ',width=700,height=600'; stdeditbrowser = open(url,title,options,'1'); @@ -376,14 +402,12 @@ ENDSTDBRW sub selectcourse_link { my ($form,$unameele,$udomele)=@_; return "Select Course"; + '","'.$udomele.'");'."'>".&mt('Select Course').""; } -############################################################### - =pod -=item linked_select_forms(...) +=item * linked_select_forms(...) linked_select_forms returns a string containing a block and html for two tags +=item * $middletext, the text which appears between the tag +=item * $firstselectname, the name of the first tag +=item * $secondselectname, the name of the second \n"; my %select2 = %{$hashref->{$firstdefault}->{'select2'}}; @@ -522,26 +545,34 @@ END foreach my $value (sort(keys(%select2))) { $result.=" \n"; } $selectform.=""; return $selectform; @@ -657,7 +803,7 @@ sub select_form { =pod -=item select_dom_form($defdom,$name,$includeempty) +=item * select_dom_form($defdom,$name,$includeempty) Returns a string containing a form input. See loncreateuser.pm for an example. @@ -729,16 +875,24 @@ sub home_server_option_list { } return $result; } -############################################################### -## End of home server