--- loncom/interface/loncommon.pm 2002/10/29 20:57:31 1.71
+++ loncom/interface/loncommon.pm 2003/07/16 14:21:56 1.108
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# a pile of common routines
#
-# $Id: loncommon.pm,v 1.71 2002/10/29 20:57:31 www Exp $
+# $Id: loncommon.pm,v 1.108 2003/07/16 14:21:56 bowersj2 Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -27,9 +27,7 @@
#
# 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
@@ -81,8 +79,9 @@ 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();
my $readit;
=pod
@@ -152,8 +151,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;
}
}
}
@@ -311,7 +310,74 @@ sub browser_and_searcher_javascript {
END
}
+sub studentbrowser_javascript {
+ unless ($ENV{'request.course.id'}) { return ''; }
+ unless (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})) {
+ return '';
+ }
+ return (<<'ENDSTDBRW');
+
+ENDSTDBRW
+}
+
+sub selectstudent_link {
+ my ($form,$unameele,$udomele)=@_;
+ unless ($ENV{'request.course.id'}) { return ''; }
+ unless (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})) {
+ return '';
+ }
+ return "Select User ";
+}
+
+sub coursebrowser_javascript {
+ return (<<'ENDSTDBRW');
+
+ENDSTDBRW
+}
+sub selectcourse_link {
+ my ($form,$unameele,$udomele)=@_;
+ return "Select Course ";
+}
###############################################################
@@ -483,6 +549,10 @@ sub help_open_topic {
my ($topic, $text, $stayOnPage, $width, $height) = @_;
$text = "" if (not defined $text);
$stayOnPage = 0 if (not defined $stayOnPage);
+ if ($ENV{'browser.interface'} eq 'textual' ||
+ $ENV{'environment.remote'} eq 'off' ) {
+ $stayOnPage=1;
+ }
$width = 350 if (not defined $width);
$height = 400 if (not defined $height);
my $filename = $topic;
@@ -493,7 +563,7 @@ sub help_open_topic {
if (!$stayOnPage)
{
- $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height'))";
+ $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
}
else
{
@@ -503,18 +573,40 @@ sub help_open_topic {
# Add the text
if ($text ne "")
{
- $template .= "$text ";
+ $template .=
+ "
".
+ "$text ";
}
# Add the graphic
$template .= <<"ENDTEMPLATE";
-
+
ENDTEMPLATE
-
+ if ($text ne '') { $template.='
' };
return $template;
}
+# This is a quicky function for Latex cheatsheet editing, since it
+# appears in at least four places
+sub helpLatexCheatsheet {
+ my $other = shift;
+ my $addOther = '';
+ if ($other) {
+ $addOther = Apache::loncommon::help_open_topic($other, shift,
+ undef, undef, 600) .
+ '';
+ }
+ return ''.
+ $addOther .
+ &Apache::loncommon::help_open_topic("Greek_Symbols",'Greek Symbols',
+ undef,undef,600)
+ .' '.
+ &Apache::loncommon::help_open_topic("Other_Symbols",'Other Symbols',
+ undef,undef,600)
+ .'
';
+}
+
=pod
=item csv_translate($text)
@@ -560,18 +652,48 @@ sub get_domains {
=pod
-=item select_dom_form($defdom,$name)
+=item select_form($defdom,$name,%hash)
+
+Returns a string containing a form to
+allow a user to select options from a hash option_name => displayed text.
+See lonrights.pm for an example invocation and use.
+
+=cut
+
+#-------------------------------------------
+sub select_form {
+ my ($def,$name,%hash) = @_;
+ my $selectform = "\n";
+ foreach (sort keys %hash) {
+ $selectform.="".$hash{$_}." \n";
+ }
+ $selectform.=" ";
+ return $selectform;
+}
+
+
+#-------------------------------------------
+
+=pod
+
+=item select_dom_form($defdom,$name,$includeempty)
Returns a string containing a form to
allow a user to select the domain to preform an operation in.
See loncreateuser.pm for an example invocation and use.
+If the $includeempty flag is set, it also includes an empty choice ("no domain
+selected");
+
=cut
#-------------------------------------------
sub select_dom_form {
- my ($defdom,$name) = @_;
+ my ($defdom,$name,$includeempty) = @_;
my @domains = get_domains();
+ if ($includeempty) { @domains=('',@domains); }
my $selectdomain = "\n";
foreach (@domains) {
$selectdomain.="=$minv);
+ $clientunicode=($clientversion>=$univ);
+ }
+ }
+ my $clientos='unknown';
+ if (($httpbrowser=~/linux/i) ||
+ ($httpbrowser=~/unix/i) ||
+ ($httpbrowser=~/ux/i) ||
+ ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
+ if (($httpbrowser=~/vax/i) ||
+ ($httpbrowser=~/vms/i)) { $clientos='vms'; }
+ if ($httpbrowser=~/next/i) { $clientos='next'; }
+ if (($httpbrowser=~/mac/i) ||
+ ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
+ if ($httpbrowser=~/win/i) { $clientos='win'; }
+ if ($httpbrowser=~/embed/i) { $clientos='pda'; }
+ return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
+ $clientunicode,$clientos,);
+}
+
+###############################################################
+###############################################################
+
+
+###############################################################
## Authentication changing form generation subroutines ##
###############################################################
##
@@ -674,11 +865,27 @@ See loncreateuser.pm for invocation and
sub authform_header{
my %in = (
formname => 'cu',
- kerb_def_dom => 'MSU.EDU',
+ kerb_def_dom => '',
@_,
);
$in{'formname'} = 'document.' . $in{'formname'};
my $result='';
+
+#---------------------------------------------- Code for upper case translation
+ my $Javascript_toUpperCase;
+ unless ($in{kerb_def_dom}) {
+ $Javascript_toUpperCase =<<"END";
+ switch (choice) {
+ case 'krb': currentform.elements[choicearg].value =
+ currentform.elements[choicearg].value.toUpperCase();
+ break;
+ default:
+ }
+END
+ } else {
+ $Javascript_toUpperCase = "";
+ }
+
$result.=<<"END";
var current = new Object();
current.radiovalue = 'nochange';
@@ -712,12 +919,7 @@ function changed_radio(choice,currentfor
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:
- }
+ $Javascript_toUpperCase
// clear old field
if ((current.argfield != choicearg) && (current.argfield != null)) {
currentform.elements[current.argfield].value = '';
@@ -773,18 +975,26 @@ sub authform_kerberos{
my %in = (
formname => 'document.cu',
kerb_def_dom => 'MSU.EDU',
+ kerb_def_auth => 'krb4',
@_,
);
my $result='';
+ my $check4;
+ my $check5;
+ if ($in{'kerb_def_auth'} eq 'krb5') {
+ $check5 = " checked=\"on\"";
+ } else {
+ $check4 = " checked=\"on\"";
+ }
$result.=<<"END";
Kerberos authenticated with domain
-
- Version 4
- Version 5
+ Version 4
+ Version 5
END
return $result;
}
@@ -802,7 +1012,7 @@ sub authform_internal{
onclick="javascript:changed_radio('int',$args{'formname'});" />
Internally authenticated (with initial password
+ onchange="javascript:changed_text('int',$args{'formname'});" />)
END
return $result;
}
@@ -838,7 +1048,7 @@ sub authform_filesystem{
onclick="javascript:changed_radio('fsys',$in{'formname'});" />
Filesystem authenticated (with initial password
+ onchange="javascript:changed_text('fsys',$in{'formname'});">)
END
return $result;
}
@@ -848,6 +1058,89 @@ END
###############################################################
###############################################################
+## Get Authentication Defaults for Domain ##
+###############################################################
+##
+## Returns default authentication type and an associated argument
+## as listed in file domain.tab
+##
+#-------------------------------------------
+
+=pod
+
+=item get_auth_defaults
+
+get_auth_defaults($target_domain) returns the default authentication
+type and an associated argument (initial password or a kerberos domain).
+These values are stored in lonTabs/domain.tab
+
+($def_auth, $def_arg) = &get_auth_defaults($target_domain);
+
+If target_domain is not found in domain.tab, returns nothing ('').
+
+=over 4
+
+=item get_auth_defaults
+
+=back
+
+=cut
+
+#-------------------------------------------
+sub get_auth_defaults {
+ my $domain=shift;
+ return ($Apache::lonnet::domain_auth_def{$domain},$Apache::lonnet::domain_auth_arg_def{$domain});
+}
+###############################################################
+## End Get Authentication Defaults for Domain ##
+###############################################################
+
+###############################################################
+## Get Kerberos Defaults for Domain ##
+###############################################################
+##
+## Returns default kerberos version and an associated argument
+## as listed in file domain.tab. If not listed, provides
+## appropriate default domain and kerberos version.
+##
+#-------------------------------------------
+
+=pod
+
+=item get_kerberos_defaults
+
+get_kerberos_defaults($target_domain) returns the default kerberos
+version and domain. If not found in domain.tabs, it defaults to
+version 4 and the domain of the server.
+
+($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
+
+=over 4
+
+=item get_kerberos_defaults
+
+=back
+
+=cut
+
+#-------------------------------------------
+sub get_kerberos_defaults {
+ my $domain=shift;
+ my ($krbdef,$krbdefdom) =
+ &Apache::loncommon::get_auth_defaults($domain);
+ unless ($krbdef =~/^krb/ && $krbdefdom) {
+ $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
+ my $krbdefdom=$1;
+ $krbdefdom=~tr/a-z/A-Z/;
+ $krbdef = "krb4";
+ }
+ return ($krbdef,$krbdefdom);
+}
+###############################################################
+## End Get Kerberos Defaults for Domain ##
+###############################################################
+
+###############################################################
## Thesaurus Functions ##
###############################################################
@@ -961,7 +1254,17 @@ sub get_related_words {
###############################################################
# -------------------------------------------------------------- Plaintext name
+=pod
+=item plainname($uname,$udom)
+
+Gets a users name and returns it as a string in
+"first middle last generation"
+form
+
+=cut
+
+###############################################################
sub plainname {
my ($uname,$udom)=@_;
my %names=&Apache::lonnet::get('environment',
@@ -975,7 +1278,21 @@ sub plainname {
}
# -------------------------------------------------------------------- Nickname
+=pod
+
+=item nickname($uname,$udom)
+Gets a users name and returns it as a string as
+
+""nickname""
+
+if the user has a nickname or
+
+"first middle last generation"
+
+if the user does not
+
+=cut
sub nickname {
my ($uname,$udom)=@_;
@@ -996,6 +1313,14 @@ sub nickname {
# ------------------------------------------------------------------ Screenname
+=pod
+
+=item screenname($uname,$udom)
+
+Gets a users screenname and returns it as a string
+
+=cut
+
sub screenname {
my ($uname,$udom)=@_;
my %names=
@@ -1010,6 +1335,13 @@ sub messagewrapper {
return
"$link ";
}
+# --------------------------------------------------------------- Notes Wrapper
+
+sub noteswrapper {
+ my ($link,$un,$do)=@_;
+ return
+"$link ";
+}
# ------------------------------------------------------------- Aboutme Wrapper
sub aboutmewrapper {
@@ -1021,7 +1353,8 @@ sub aboutmewrapper {
sub syllabuswrapper {
- my ($link,$un,$do)=@_;
+ my ($link,$un,$do,$tf)=@_;
+ if ($tf) { $link=''.$link.' '; }
return "$link ";
}
@@ -1035,6 +1368,32 @@ sub languagedescription {
return $language{shift(@_)};
}
+# ----------------------------------------------------------- Display Languages
+# returns a hash with all desired display languages
+#
+
+sub display_languages {
+ my %languages=();
+ if ($ENV{'environment.languages'}) {
+ foreach (split(/\s*(\,|\;|\:)\s*/,$ENV{'environment.languages'})) {
+ $languages{$_}=1;
+ }
+ }
+ if ($ENV{'course.'.$ENV{'request.course.id'}.'.languages'}) {
+ foreach (split(/\s*(\,|\;|\:)\s*/,
+ $ENV{'course.'.$ENV{'request.course.id'}.'.languages'})) {
+ $languages{$_}=1;
+ }
+ }
+ &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
+ if ($ENV{'form.displaylanguage'}) {
+ foreach (split(/\s*(\,|\;|\:)\s*/,$ENV{'form.displaylanguage'})) {
+ $languages{$_}=1;
+ }
+ }
+ return %languages;
+}
+
# --------------------------------------------------------------- Copyright IDs
sub copyrightids {
return sort(keys(%cprtag));
@@ -1153,6 +1512,41 @@ sub get_previous_attempt {
}
}
+sub relative_to_absolute {
+ my ($url,$output)=@_;
+ my $parser=HTML::TokeParser->new(\$output);
+ my $token;
+ my $thisdir=$url;
+ my @rlinks=();
+ while ($token=$parser->get_token) {
+ if ($token->[0] eq 'S') {
+ if ($token->[1] eq 'a') {
+ if ($token->[2]->{'href'}) {
+ $rlinks[$#rlinks+1]=$token->[2]->{'href'};
+ }
+ } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
+ $rlinks[$#rlinks+1]=$token->[2]->{'src'};
+ } elsif ($token->[1] eq 'base') {
+ $thisdir=$token->[2]->{'href'};
+ }
+ }
+ }
+ $thisdir=~s-/[^/]*$--;
+ foreach (@rlinks) {
+ unless (($_=~/^http:\/\//i) ||
+ ($_=~/^\//) ||
+ ($_=~/^javascript:/i) ||
+ ($_=~/^mailto:/i) ||
+ ($_=~/^\#/)) {
+ my $newlocation=&Apache::lonnet::hreflocation($thisdir,$_);
+ $output=~s/(\"|\'|\=\s*)$_(\"|\'|\s|\>)/$1$newlocation$2/;
+ }
+ }
+# -------------------------------------------------- Deal with Applet codebases
+ $output=~s/(\]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
+ return $output;
+}
+
sub get_student_view {
my ($symb,$username,$domain,$courseid,$target) = @_;
my ($map,$id,$feedurl) = split(/___/,$symb);
@@ -1164,7 +1558,8 @@ sub get_student_view {
}
if ($target eq 'tex') {$moreenv{'form.grade_target'} = 'tex';}
&Apache::lonnet::appenv(%moreenv);
- my $userview=&Apache::lonnet::ssi('/res/'.$feedurl);
+ $feedurl=&Apache::lonnet::clutter($feedurl);
+ my $userview=&Apache::lonnet::ssi_body($feedurl);
&Apache::lonnet::delenv('form.grade_');
foreach my $element (@elements) {
$ENV{'form.grade_'.$element}=$old{$element};
@@ -1176,11 +1571,12 @@ sub get_student_view {
$userview=~s/\//gi;
$userview=~s/\<\/head\>//gi;
$userview=~s/action\s*\=/would_be_action\=/gi;
+ $userview=&relative_to_absolute($feedurl,$userview);
return $userview;
}
sub get_student_answers {
- my ($symb,$username,$domain,$courseid) = @_;
+ my ($symb,$username,$domain,$courseid,%form) = @_;
my ($map,$id,$feedurl) = split(/___/,$symb);
my (%old,%moreenv);
my @elements=('symb','courseid','domain','username');
@@ -1190,7 +1586,7 @@ sub get_student_answers {
}
$moreenv{'form.grade_target'}='answer';
&Apache::lonnet::appenv(%moreenv);
- my $userview=&Apache::lonnet::ssi('/res/'.$feedurl);
+ my $userview=&Apache::lonnet::ssi('/res/'.$feedurl,%form);
&Apache::lonnet::delenv('form.grade_');
foreach my $element (@elements) {
$ENV{'form.grade_'.$element}=$old{$element};
@@ -1299,8 +1695,10 @@ sub domainlogo {
my $domain = &determinedomain(shift);
# See if there is a logo
if (-e '/home/httpd/html/adm/lonDomLogos/'.$domain.'.gif') {
- return ' ';
+ my $lonhttpdPort=$Apache::lonnet::perlvar{'lonhttpdPort'};
+ if (!defined($lonhttpdPort)) { $lonhttpdPort='8080'; }
+ return ' ';
} elsif(exists($Apache::lonnet::domaindescription{$domain})) {
return $Apache::lonnet::domaindescription{$domain};
} else {
@@ -1321,6 +1719,9 @@ Returns: value of designparamter $which
##############################################
sub designparm {
my ($which,$domain)=@_;
+ if ($ENV{'environment.color.'.$which}) {
+ return $ENV{'environment.color.'.$which};
+ }
$domain=&determinedomain($domain);
if ($designhash{$domain.'.'.$which}) {
return $designhash{$domain.'.'.$which};
@@ -1345,6 +1746,8 @@ Inputs:
$addentries, extra parameters for the tag.
$bodyonly, if defined, only return the tag.
$domain, if defined, force a given domain.
+ $forcereg, if page should register as content page (relevant for
+ text interface only)
Returns: A uniform header for LON-CAPA web pages.
If $bodyonly is nonzero, a string containing a tag will be returned.
@@ -1358,7 +1761,7 @@ other decorations will be returned.
###############################################
sub bodytag {
- my ($title,$function,$addentries,$bodyonly,$domain)=@_;
+ my ($title,$function,$addentries,$bodyonly,$domain,$forcereg)=@_;
unless ($function) {
$function='student';
if ($ENV{'request.role'}=~/^(cc|in|ta|ep)/) {
@@ -1392,20 +1795,40 @@ sub bodytag {
unless ($realm) { $realm=' '; }
# Set messages
my $messages=&domainlogo($domain);
-# Output
+# Port for miniserver
+ my $lonhttpdPort=$Apache::lonnet::perlvar{'lonhttpdPort'};
+ if (!defined($lonhttpdPort)) { $lonhttpdPort='8080'; }
+# construct main body tag
my $bodytag = <
END
+ my $upperleft=' ';
if ($bodyonly) {
return $bodytag;
- } else {
- return(<LON-CAPA: '.$title.'';
+ } elsif ($ENV{'environment.remote'} eq 'off') {
+# No Remote
+ return $bodytag.&Apache::lonmenu::menubuttons($forcereg,'web',
+ $forcereg).
+ '';
+ }
+
+#
+# Top frame rendering, Remote is up
+#
+ return(<
-
-
-$messages
+
+$upperleft
+$messages
@@ -1426,8 +1849,79 @@ $bodytag
$realm
ENDBODY
+}
+
+###############################################
+
+sub get_posted_cgi {
+ my $r=shift;
+
+ my $buffer;
+
+ $r->read($buffer,$r->header_in('Content-length'),0);
+ unless ($buffer=~/^(\-+\w+)\s+Content\-Disposition\:\s*form\-data/si) {
+ my @pairs=split(/&/,$buffer);
+ my $pair;
+ foreach $pair (@pairs) {
+ my ($name,$value) = split(/=/,$pair);
+ $value =~ tr/+/ /;
+ $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
+ $name =~ tr/+/ /;
+ $name =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
+ &add_to_env("form.$name",$value);
+ }
+ } else {
+ my $contentsep=$1;
+ my @lines = split (/\n/,$buffer);
+ my $name='';
+ my $value='';
+ my $fname='';
+ my $fmime='';
+ my $i;
+ for ($i=0;$i<=$#lines;$i++) {
+ if ($lines[$i]=~/^$contentsep/) {
+ if ($name) {
+ chomp($value);
+ if ($fname) {
+ $ENV{"form.$name.filename"}=$fname;
+ $ENV{"form.$name.mimetype"}=$fmime;
+ } else {
+ $value=~s/\s+$//s;
+ }
+ &add_to_env("form.$name",$value);
+ }
+ if ($i<$#lines) {
+ $i++;
+ $lines[$i]=~
+ /Content\-Disposition\:\s*form\-data\;\s*name\=\"([^\"]+)\"/i;
+ $name=$1;
+ $value='';
+ if ($lines[$i]=~/filename\=\"([^\"]+)\"/i) {
+ $fname=$1;
+ if
+ ($lines[$i+1]=~/Content\-Type\:\s*([\w\-\/]+)/i) {
+ $fmime=$1;
+ $i++;
+ } else {
+ $fmime='';
+ }
+ } else {
+ $fname='';
+ $fmime='';
+ }
+ $i++;
+ }
+ } else {
+ $value.=$lines[$i]."\n";
+ }
+ }
}
+ $ENV{'request.method'}=$ENV{'REQUEST_METHOD'};
+ $r->method_number(M_GET);
+ $r->method('GET');
+ $r->headers_in->unset('Content-length');
}
+
###############################################
sub get_unprocessed_cgi {
@@ -1730,6 +2224,37 @@ sub csv_samples_select_table {
$i--;
return($i);
}
+
+=pod
+
+=item check_if_partid_hidden($id,$symb,$udom,$uname)
+
+Returns either 1 or undef
+
+1 if the part is to be hidden, undef if it is to be shown
+
+Arguments are:
+
+$id the id of the part to be checked
+$symb, optional the symb of the resource to check
+$udom, optional the domain of the user to check for
+$uname, optional the username of the user to check for
+
+=cut
+
+sub check_if_partid_hidden {
+ my ($id,$symb,$udom,$uname) = @_;
+ my $hiddenparts=&Apache::lonnet::EXT('resource.0.parameter_hiddenparts',
+ $symb,$udom,$uname);
+ my @hiddenlist=split(/,/,$hiddenparts);
+ foreach my $checkid (@hiddenlist) {
+ if ($checkid =~ /^\s*\Q$id\E\s*$/) { return 1; }
+ }
+ return undef;
+}
+
+
+
1;
__END__;