tag
=item * $hashref, a reference to a hash containing the data for the menus.
=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.="
END
# output the initial values for the selection lists
$result .= "\n";
foreach my $value (sort(keys(%$hashref))) {
$result.=" {$value}->{'text'})." \n";
}
$result .= " \n";
my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
$result .= $middletext;
$result .= "\n";
my $seconddefault = $hashref->{$firstdefault}->{'default'};
foreach my $value (sort(keys(%select2))) {
$result.=" \n";
}
$result .= " \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);
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;
$filename =~ s/ /_/g;
my $template = "";
my $link;
$topic=~s/\W/\_/g;
if (!$stayOnPage)
{
$link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
}
else
{
$link = "/adm/help/${filename}.hlp";
}
# Add the text
if ($text ne "")
{
$template .=
"".
"$text
' };
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)
.'
';
}
sub general_help {
my $helptopic='Student_Intro';
if ($env{'request.role'}=~/^(ca|au)/) {
$helptopic='Authoring_Intro';
} elsif ($env{'request.role'}=~/^cc/) {
$helptopic='Course_Coordination_Intro';
}
return $helptopic;
}
sub update_help_link {
my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
my $origurl = $ENV{'REQUEST_URI'};
$origurl=~s|^/~|/priv/|;
my $timestamp = time;
foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
$$datum = &escape($$datum);
}
my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
my $output .= <<"ENDOUTPUT";
ENDOUTPUT
return $output;
}
# now just updates the help link and generates a blue icon
sub help_open_menu {
my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
= @_;
$stayOnPage = 0 if (not defined $stayOnPage);
if ($env{'browser.interface'} eq 'textual' ||
$env{'environment.remote'} eq 'off' ) {
$stayOnPage=1;
}
my $output;
if ($component_help) {
if (!$text) {
$output=&help_open_topic($component_help,undef,$stayOnPage,
$width,$height);
} else {
my $help_text;
$help_text=&unescape($topic);
$output=''.
&help_open_topic($component_help,$help_text,$stayOnPage,
$width,$height).'
';
}
}
my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
return $output.$banner_link;
}
sub top_nav_help {
my ($text) = @_;
$text = &mt($text);
my $stayOnPage =
($env{'browser.interface'} eq 'textual' ||
$env{'environment.remote'} eq 'off' );
my $link= ($stayOnPage) ? "javascript:helpMenu('display')"
: "javascript:helpMenu('open')";
my $banner_link = &update_help_link(undef,undef,undef,undef,$stayOnPage);
my $title = &mt('Get help');
return <<"END";
$banner_link
$text
END
}
sub help_menu_js {
my ($text) = @_;
my $stayOnPage =
($env{'browser.interface'} eq 'textual' ||
$env{'environment.remote'} eq 'off' );
my $width = 620;
my $height = 600;
my $helptopic=&general_help();
my $details_link = '/adm/help/'.$helptopic.'.hlp';
my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
my $start_page =
&Apache::loncommon::start_page('Help Menu', undef,
{'frameset' => 1,
'js_ready' => 1,
'add_entries' => {
'border' => '0',
'rows' => "105,*",},});
my $end_page =
&Apache::loncommon::end_page({'frameset' => 1,
'js_ready' => 1,});
my $template .= <<"ENDTEMPLATE";
ENDTEMPLATE
return $template;
}
sub help_open_bug {
my ($topic, $text, $stayOnPage, $width, $height) = @_;
unless ($env{'user.adv'}) { return ''; }
unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
$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 = 600 if (not defined $width);
$height = 600 if (not defined $height);
$topic=~s/\W+/\+/g;
my $link='';
my $template='';
my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
&escape($ENV{'REQUEST_URI'}).'&component='.$topic;
if (!$stayOnPage)
{
$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
}
else
{
$link = $url;
}
# Add the text
if ($text ne "")
{
$template .=
"".
"$text
' };
return $template;
}
sub help_open_faq {
my ($topic, $text, $stayOnPage, $width, $height) = @_;
unless ($env{'user.adv'}) { return ''; }
unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
$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);
$topic=~s/\W+/\+/g;
my $link='';
my $template='';
my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
if (!$stayOnPage)
{
$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
}
else
{
$link = $url;
}
# Add the text
if ($text ne "")
{
$template .=
"".
"$text
' };
return $template;
}
###############################################################
###############################################################
=pod
=item * change_content_javascript():
This and the next function allow you to create small sections of an
otherwise static HTML page that you can update on the fly with
Javascript, even in Netscape 4.
The Javascript fragment returned by this function (no EscriptE tag)
must be written to the HTML page once. It will prove the Javascript
function "change(name, content)". Calling the change function with the
name of the section
you want to update, matching the name passed to C, and
the new content you want to put in there, will put the content into
that area.
B: Netscape 4 only reserves enough space for the changable area
to contain room for the original contents. You need to "make space"
for whatever changes you wish to make, and be B to check your
code in Netscape 4. This feature in Netscape 4 is B powerful;
it's adequate for updating a one-line status display, but little more.
This script will set the space to 100% width, so you only need to
worry about height in Netscape 4.
Modern browsers are much less limiting, and if you can commit to the
user not using Netscape 4, this feature may be used freely with
pretty much any HTML.
=cut
sub change_content_javascript {
# If we're on Netscape 4, we need to use Layer-based code
if ($env{'browser.type'} eq 'netscape' &&
$env{'browser.version'} =~ /^4\./) {
return (<. $name is
the name you will use to reference the area later; do not repeat the
same name on a given HTML page more then once. $origContent is what
the area will originally contain, which can be left blank.
=cut
sub changable_area {
my ($name, $origContent) = @_;
if ($env{'browser.type'} eq 'netscape' &&
$env{'browser.version'} =~ /^4\./) {
# If this is netscape 4, we need to use the Layer tag
return "$origContent $origContent ";
}
}
=pod
=back
=head1 Excel and CSV file utility routines
=over 4
=cut
###############################################################
###############################################################
=pod
=item * csv_translate($text)
Translate $text to allow it to be output as a 'comma separated values'
format.
=cut
###############################################################
###############################################################
sub csv_translate {
my $text = shift;
$text =~ s/\"/\"\"/g;
$text =~ s/\n/ /g;
return $text;
}
###############################################################
###############################################################
=pod
=item * define_excel_formats
Define some commonly used Excel cell formats.
Currently supported formats:
=over 4
=item header
=item bold
=item h1
=item h2
=item h3
=item h4
=item i
=item date
=back
Inputs: $workbook
Returns: $format, a hash reference.
=cut
###############################################################
###############################################################
sub define_excel_formats {
my ($workbook) = @_;
my $format;
$format->{'header'} = $workbook->add_format(bold => 1,
bottom => 1,
align => 'center');
$format->{'bold'} = $workbook->add_format(bold=>1);
$format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
$format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
$format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
$format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
$format->{'i'} = $workbook->add_format(italic=>1);
$format->{'date'} = $workbook->add_format(num_format=>
'mm/dd/yyyy hh:mm:ss');
return $format;
}
###############################################################
###############################################################
=pod
=item * create_workbook
Create an Excel worksheet. If it fails, output message on the
request object and return undefs.
Inputs: Apache request object
Returns (undef) on failure,
Excel worksheet object, scalar with filename, and formats
from &Apache::loncommon::define_excel_formats on success
=cut
###############################################################
###############################################################
sub create_workbook {
my ($r) = @_;
#
# Create the excel spreadsheet
my $filename = '/prtspool/'.
$env{'user.name'}.'_'.$env{'user.domain'}.'_'.
time.'_'.rand(1000000000).'.xls';
my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
if (! defined($workbook)) {
$r->log_error("Error creating excel spreadsheet $filename: $!");
$r->print(''.&mt("Unable to create new Excel file. ".
"This error has been logged. ".
"Please alert your LON-CAPA administrator").
'
');
return (undef);
}
#
$workbook->set_tempdir('/home/httpd/perl/tmp');
#
my $format = &Apache::loncommon::define_excel_formats($workbook);
return ($workbook,$filename,$format);
}
###############################################################
###############################################################
=pod
=item * create_text_file
Create a file to write to and eventually make available to the usre.
If file creation fails, outputs an error message on the request object and
return undefs.
Inputs: Apache request object, and file suffix
Returns (undef) on failure,
Filehandle and filename on success.
=cut
###############################################################
###############################################################
sub create_text_file {
my ($r,$suffix) = @_;
if (! defined($suffix)) { $suffix = 'txt'; };
my $fh;
my $filename = '/prtspool/'.
$env{'user.name'}.'_'.$env{'user.domain'}.'_'.
time.'_'.rand(1000000000).'.'.$suffix;
$fh = Apache::File->new('>/home/httpd'.$filename);
if (! defined($fh)) {
$r->log_error("Couldn't open $filename for output $!");
$r->print("Problems occured in creating the output file. ".
"This error has been logged. ".
"Please alert your LON-CAPA administrator.");
}
return ($fh,$filename)
}
=pod
=back
=cut
###############################################################
## Home server list generating code ##
###############################################################
=pod
=head1 Home Server option list generating code
=over 4
=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 my $dom (sort(values(%Apache::lonnet::hostdom))) {
push(@domains,$dom) unless $seen{$dom}++;
}
return @domains;
}
# ------------------------------------------
sub domain_select {
my ($name,$value,$multiple)=@_;
my %domains=map {
$_ => $_.' '.$Apache::lonnet::domaindescription{$_}
} &get_domains;
if ($multiple) {
$domains{''}=&mt('Any domain');
return &multiple_select_form($name,$value,4,\%domains);
} else {
return &select_form($name,$value,%domains);
}
}
#-------------------------------------------
=pod
=item * multiple_select_form($name,$value,$size,$hash,$order)
Returns a string containing a element int multiple mode
Args:
$name - name of the element
$value - sclara or array ref of values that should already be selected
$size - number of rows long the select element is
$hash - the elements should be 'option' => 'shown text'
(shown text should already have been &mt())
$order - (optional) array ref of the order to show the elments in
=cut
#-------------------------------------------
sub multiple_select_form {
my ($name,$value,$size,$hash,$order)=@_;
my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
my $output='';
if (! defined($size)) {
$size = 4;
if (scalar(keys(%$hash))<4) {
$size = scalar(keys(%$hash));
}
}
$output.="\n";
my @order;
if ($order) {
@order = ref($order) ? @$order
: sort(keys(%$hash));
}
if (exists($$hash{'select_form_order'})) {
@order = @{$$hash{'select_form_order'}};
}
foreach my $key (@order) {
$output.='&').'" ';
$output.='selected="selected" ' if ($selected{$key});
$output.='>'.$hash->{$key}." \n";
}
$output.=" \n";
return $output;
}
#-------------------------------------------
=pod
=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";
my @keys;
if (exists($hash{'select_form_order'})) {
@keys=@{$hash{'select_form_order'}};
} else {
@keys=sort(keys(%hash));
}
foreach my $key (@keys) {
$selectform.=
'&').'" '.
($key eq $def ? 'selected="selected" ' : '').
">".&mt($hash{$key})." \n";
}
$selectform.=" ";
return $selectform;
}
# For display filters
sub display_filter {
if (!$env{'form.show'}) { $env{'form.show'}=10; }
if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
return ''.&mt('Records [_1]',
&Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
(&mt('all'),10,20,50,100,1000,10000))).
' '.
&mt('Filter [_1]',
&select_form($env{'form.displayfilter'},
'displayfilter',
('currentfolder' => 'Current folder/page',
'containing' => 'Containing phrase',
'none' => 'None'))).
' ';
}
sub gradeleveldescription {
my $gradelevel=shift;
my %gradelevels=(0 => 'Not specified',
1 => 'Grade 1',
2 => 'Grade 2',
3 => 'Grade 3',
4 => 'Grade 4',
5 => 'Grade 5',
6 => 'Grade 6',
7 => 'Grade 7',
8 => 'Grade 8',
9 => 'Grade 9',
10 => 'Grade 10',
11 => 'Grade 11',
12 => 'Grade 12',
13 => 'Grade 13',
14 => '100 Level',
15 => '200 Level',
16 => '300 Level',
17 => '400 Level',
18 => 'Graduate Level');
return &mt($gradelevels{$gradelevel});
}
sub select_level_form {
my ($deflevel,$name)=@_;
unless ($deflevel) { $deflevel=0; }
my $selectform = "\n";
for (my $i=0; $i<=18; $i++) {
$selectform.="".&gradeleveldescription($i)." \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,$includeempty) = @_;
my @domains = get_domains();
if ($includeempty) { @domains=('',@domains); }
my $selectdomain = "\n";
foreach my $dom (@domains) {
$selectdomain.="$dom \n";
}
$selectdomain.=" ";
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 my $hostid (keys(%Apache::lonnet::libserv)) {
if ($Apache::lonnet::hostdom{$hostid} eq $domain) {
$library_servers{$hostid} = $Apache::lonnet::hostname{$hostid};
}
}
return %library_servers;
}
#-------------------------------------------
=pod
=item * home_server_option_list($domain)
returns a string which contains an list to be used in a
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 my $hostid (sort(keys(%servers))) {
$result.=
''.
$hostid.' '.$servers{$hostid}." \n";
}
return $result;
}
=pod
=back
=cut
###############################################################
## Decoding User Agent ##
###############################################################
=pod
=head1 Decoding the User Agent
=over 4
=item * &decode_user_agent()
Inputs: $r
Outputs:
=over 4
=item * $httpbrowser
=item * $clientbrowser
=item * $clientversion
=item * $clientmathml
=item * $clientunicode
=item * $clientos
=back
=back
=cut
###############################################################
###############################################################
sub decode_user_agent {
my ($r)=@_;
my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
my $clientbrowser='unknown';
my $clientversion='0';
my $clientmathml='';
my $clientunicode='0';
for (my $i=0;$i<=$#browsertype;$i++) {
my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
$clientbrowser=$bname;
$httpbrowser=~/$vreg/i;
$clientversion=$1;
$clientmathml=($clientversion>=$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 ##
###############################################################
##
## All of the authform_xxxxxxx subroutines take their inputs in a
## hash, and have reasonable default values.
##
## formname = the name given in the
ENDROLE
my $titleinfo = ''.$title.' ';
if ($customtitle) {
$titleinfo = $customtitle;
}
#
# Extra info if you are the DC
my $dc_info = '';
if ($env{'user.adv'} && exists($env{'user.role.dc./'.
$env{'course.'.$env{'request.course.id'}.
'.domain'}.'/'})) {
my $cid = $env{'request.course.id'};
$dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
$dc_info =~ s/\s+$//;
$dc_info = '('.$dc_info.')';
}
if ($env{'environment.remote'} eq 'off') {
# No Remote
if ($env{'request.state'} eq 'construct') {
$forcereg=1;
}
if (!$customtitle && $env{'request.state'} eq 'construct') {
# this is for resources; directories have customtitle, and crumbs
# and select recent are created in lonpubdir.pm
my ($uname,$thisdisfn)=
($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
my $formaction='/priv/'.$uname.'/'.$thisdisfn;
$formaction=~s/\/+/\//g;
my $parentpath = '';
my $lastitem = '';
if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
$parentpath = $1;
$lastitem = $2;
} else {
$lastitem = $thisdisfn;
}
$titleinfo =
&Apache::loncommon::help_open_menu('','',3,'Authoring').
'Construction Space : '.
''
.&Apache::lonmenu::constspaceform();
}
my $titletable;
if (!$notitle) {
$titletable =
''.
" $titleinfo $dc_info ".$roleinfo.
'
';
}
if ($notopbar) {
$bodytag .= $titletable;
} else {
if ($env{'request.state'} eq 'construct') {
$bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
$titletable);
} else {
$bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
$titletable;
}
}
return $bodytag;
}
#
# Top frame rendering, Remote is up
#
my $upperleft=''.&mt('Switch to Inline Menu Mode').' ');
#
if ($notitle) {
return $bodytag;
}
return(<
$upperleft
$messages
$titleinfo $dc_info $menu
$roleinfo
".
&mt('Continue').' '.
$endbodytag;
}
return $endbodytag;
}
=pod
=over 4
=item * &standard_css()
Returns a style sheet
Inputs: (all optional)
domain -> force to color decorate a page for a specific
domain
function -> force usage of a specific rolish color scheme
bgcolor -> override the default page bgcolor
=back
=cut
sub standard_css {
my ($function,$domain,$bgcolor) = @_;
$function = &get_users_function() if (!$function);
my $img = &designparm($function.'.img', $domain);
my $tabbg = &designparm($function.'.tabbg', $domain);
my $font = &designparm($function.'.font', $domain);
my $sidebg = &designparm($function.'.sidebg',$domain);
my $pgbg_or_bgcolor =
$bgcolor ||
&designparm($function.'.pgbg', $domain);
my $pgbg = &designparm($function.'.pgbg', $domain);
my $alink = &designparm($function.'.alink', $domain);
my $vlink = &designparm($function.'.vlink', $domain);
my $link = &designparm($function.'.link', $domain);
my $sans = 'Arial,Helvetica,sans-serif';
my $mono = 'monospace';
my $data_table_head = $tabbg;
my $data_table_light = '#EEEEEE';
my $data_table_dark = '#DDDDDD';
my $data_table_darker = '#CCCCCC';
my $data_table_highlight = '#FFFF00';
my $mail_new = '#FFBB77';
my $mail_new_hover = '#DD9955';
my $mail_read = '#BBBB77';
my $mail_read_hover = '#999944';
my $mail_replied = '#AAAA88';
my $mail_replied_hover = '#888855';
my $mail_other = '#99BBBB';
my $mail_other_hover = '#669999';
my $table_header = '#DDDDDD';
my $feedback_link_bg = '#BBBBBB';
my $border = ($env{'browser.type'} eq 'explorer') ? '0px 2px 0px 2px'
: '0px 3px 0px 4px';
return <
$args - optional arguments
force_register - if is true call registerurl so the remote is
informed
redirect -> array ref of
1- seconds before redirect occurs
2- url to redirect to
3- whether the side effect should occur
(side effect of setting
$env{'internal.head.redirect'} to the url
redirected too)
domain -> force to color decorate a page for a specific
domain
function -> force usage of a specific rolish color scheme
bgcolor -> override the default page bgcolor
no_auto_mt_title
-> prevent &mt()ing the title arg
=back
=cut
sub headtag {
my ($title,$head_extra,$args) = @_;
my $function = $args->{'function'} || &get_users_function();
my $domain = $args->{'domain'} || &determinedomain();
my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
my $url = join(':',$env{'user.name'},$env{'user.domain'},
$Apache::lonnet::perlvar{'lonVersion'},
#time(),
$env{'environment.color.timestamp'},
$function,$domain,$bgcolor);
$url = '/adm/css/'.&escape($url).'.css';
my $result =
''.
&font_settings();
if (!$args->{'frameset'}) {
$result .= &Apache::lonhtmlcommon::htmlareaheaders();
}
if ($args->{'force_register'}) {
$result .= &Apache::lonmenu::registerurl(1);
}
if (!$args->{'no_nav_bar'}
&& !$args->{'only_body'}
&& !$args->{'frameset'}) {
$result .= &help_menu_js();
}
if (ref($args->{'redirect'})) {
my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
$url = &Apache::lonenc::check_encrypt($url);
if (!$inhibit_continue) {
$env{'internal.head.redirect'} = $url;
}
$result.=< LON-CAPA '.$title.' '
.'
rather than
no_title -> if true the title bar won't be shown
skip_phases -> hash ref of
head -> skip the generation
body -> skip all generation
no_inline_link -> if true and in remote mode, don't show the
'Switch To Inline Menu' link
no_auto_mt_title -> prevent &mt()ing the title arg
=back
=cut
sub start_page {
my ($title,$head_extra,$args) = @_;
#&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
my %head_args;
foreach my $arg ('redirect','force_register','domain','function',
'bgcolor','frameset','no_nav_bar','only_body',
'no_auto_mt_title') {
if (defined($args->{$arg})) {
$head_args{$arg} = $args->{$arg};
}
}
$env{'internal.start_page'}++;
my $result;
if (! exists($args->{'skip_phases'}{'head'}) ) {
$result.=
&xml_begin().
&headtag($title,$head_extra,\%head_args).&endheadtag();
}
if (! exists($args->{'skip_phases'}{'body'}) ) {
if ($args->{'frameset'}) {
my $attr_string = &make_attr_string($args->{'force_register'},
$args->{'add_entries'});
$result .= "\n\n";
} else {
$result .=
&bodytag($title,
$args->{'function'}, $args->{'add_entries'},
$args->{'only_body'}, $args->{'domain'},
$args->{'force_register'}, $args->{'body_title'},
$args->{'no_nav_bar'}, $args->{'bgcolor'},
$args->{'no_title'}, $args->{'no_inline_link'},
$args);
}
}
if ($args->{'js_ready'}) {
$result = &js_ready($result);
}
if ($args->{'html_encode'}) {
$result = &html_encode($result);
}
return $result;
}
=pod
=over 4
=item * &head()
Returns a complete section for LON-CAPA web pages.
Inputs: $args - additional optional args supported are:
js_ready -> return a string ready for being used in
a javascript writeln
html_encode -> return a string ready for being used in
a html attribute
frameset -> if true will start with a
rather than
dicsussion -> if true will get discussion from
lonxml::xmlend
(you can pass the target and parser arguments
through optional 'target' and 'parser' args
to this routine)
=cut
sub end_page {
my ($args) = @_;
$env{'internal.end_page'}++;
my $result;
if ($args->{'discussion'}) {
my ($target,$parser);
if (ref($args->{'discussion'})) {
($target,$parser) =($args->{'discussion'}{'target'},
$args->{'discussion'}{'parser'});
}
$result .= &Apache::lonxml::xmlend($target,$parser);
}
if ($args->{'frameset'}) {
$result .= ' ';
} else {
$result .= &endbodytag();
}
$result .= "\n";
if ($args->{'js_ready'}) {
$result = &js_ready($result);
}
if ($args->{'html_encode'}) {
$result = &html_encode($result);
}
return $result;
}
sub html_encode {
my ($result) = @_;
$result = &HTML::Entities::encode($result,'<>&"');
return $result;
}
sub js_ready {
my ($result) = @_;
$result =~ s/[\n\r]/ /xmsg;
$result =~ s/\\/\\\\/xmsg;
$result =~ s/'/\\'/xmsg;
$result =~ s{ 1) {
&Apache::lonnet::logthis('start_page called multiple times '.
$env{'internal.start_page'}.' '.
$ENV{'request.filename'});
}
if ( exists($env{'internal.end_page'})
&& $env{'internal.end_page'} > 1) {
&Apache::lonnet::logthis('end_page called multiple times '.
$env{'internal.end_page'}.' '.
$env{'request.filename'});
}
if ( exists($env{'internal.start_page'})
&& ! exists($env{'internal.end_page'})) {
&Apache::lonnet::logthis('start_page called without end_page '.
$env{'request.filename'});
}
if ( ! exists($env{'internal.start_page'})
&& exists($env{'internal.end_page'})) {
&Apache::lonnet::logthis('end_page called without start_page'.
$env{'request.filename'});
}
}
sub simple_error_page {
my ($r,$title,$msg) = @_;
my $page =
&Apache::loncommon::start_page($title).
&mt($msg).
&Apache::loncommon::end_page();
if (ref($r)) {
$r->print($page);
return;
}
return $page;
}
{
my $row_count;
sub start_data_table {
my ($add_class) = @_;
my $css_class = (join(' ','LC_data_table',$add_class));
undef($row_count);
return ''."\n";
}
sub end_data_table {
undef($row_count);
return '
'."\n";;
}
sub start_data_table_row {
my ($add_class) = @_;
$row_count++;
my $css_class = ($row_count % 2)?'':'LC_even_row';
$css_class = (join(' ',$css_class,$add_class));
return ''."\n";;
}
sub continue_data_table_row {
my ($add_class) = @_;
my $css_class = ($row_count % 2)?'':'LC_even_row';
$css_class = (join(' ',$css_class,$add_class));
return ' '."\n";;
}
sub end_data_table_row {
return ' '."\n";;
}
sub start_data_table_empty_row {
$row_count++;
return ''."\n";;
}
sub end_data_table_empty_row {
return ' '."\n";;
}
sub start_data_table_header_row {
return ''."\n";;
}
}
###############################################
=pod
=item * &get_users_function()
Used by &bodytag to determine the current users primary role.
Returns either 'student','coordinator','admin', or 'author'.
=cut
###############################################
sub get_users_function {
my $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';
}
return $function;
}
###############################################
=pod
=item * &check_user_status
Determines current status of supplied role for a
specific user. Roles can be active, previous or future.
Inputs:
user's domain, user's username, course's domain,
course's number, optional section ID.
Outputs:
role status: active, previous or future.
=cut
sub check_user_status {
my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
my @uroles = keys %userinfo;
my $srchstr;
my $active_chk = 'none';
my $now = time;
if (@uroles > 0) {
if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
$srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
} else {
$srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
}
if (grep/^\Q$srchstr\E$/,@uroles) {
my $role_end = 0;
my $role_start = 0;
$active_chk = 'active';
if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
$role_end = $1;
if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
$role_start = $1;
}
}
if ($role_start > 0) {
if ($now < $role_start) {
$active_chk = 'future';
}
}
if ($role_end > 0) {
if ($now > $role_end) {
$active_chk = 'previous';
}
}
}
}
return $active_chk;
}
###############################################
=pod
=item * &get_sections()
Determines all the sections for a course including
sections with students and sections containing other roles.
Incoming parameters:
1. domain
2. course number
3. reference to array containing roles for which sections should
be gathered (optional).
4. reference to array containing status types for which sections
should be gathered (optional).
If the third argument is undefined, sections are gathered for any role.
If the fourth argument is undefined, sections are gathered for any status.
Permissible values are 'active' or 'future' or 'previous'.
Returns section hash (keys are section IDs, values are
number of users in each section), subject to the
optional roles filter, optional status filter
=cut
###############################################
sub get_sections {
my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
if (!defined($cdom) || !defined($cnum)) {
my $cid = $env{'request.course.id'};
return if (!defined($cid));
$cdom = $env{'course.'.$cid.'.domain'};
$cnum = $env{'course.'.$cid.'.num'};
}
my %sectioncount;
my $now = time;
if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
my $sec_index = &Apache::loncoursedata::CL_SECTION();
my $status_index = &Apache::loncoursedata::CL_STATUS();
my $start_index = &Apache::loncoursedata::CL_START();
my $end_index = &Apache::loncoursedata::CL_END();
my $status;
while (my ($student,$data) = each(%$classlist)) {
my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
$data->[$status_index],
$data->[$start_index],
$data->[$end_index]);
if ($stu_status eq 'Active') {
$status = 'active';
} elsif ($end < $now) {
$status = 'previous';
} elsif ($start > $now) {
$status = 'future';
}
if ($section ne '-1' && $section !~ /^\s*$/) {
if ((!defined($possible_status)) || (($status ne '') &&
(grep/^\Q$status\E$/,@{$possible_status}))) {
$sectioncount{$section}++;
}
}
}
}
my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
foreach my $user (sort(keys(%courseroles))) {
if ($user !~ /^(\w{2})/) { next; }
my ($role) = ($user =~ /^(\w{2})/);
if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
my ($section,$status);
if ($role eq 'cr' &&
$user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
$section=$1;
}
if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
if (!defined($section) || $section eq '-1') { next; }
my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
if ($end == -1 && $start == -1) {
next; #deleted role
}
if (!defined($possible_status)) {
$sectioncount{$section}++;
} else {
if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
$status = 'active';
} elsif ($end < $now) {
$status = 'future';
} elsif ($start > $now) {
$status = 'previous';
}
if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
$sectioncount{$section}++;
}
}
}
return %sectioncount;
}
###############################################
=pod
=item * &get_course_users()
Retrieves usernames:domains for users in the specified course
with specific role(s), and access status.
Incoming parameters:
1. course domain
2. course number
3. access status: users must have - either active,
previous, future, or all.
4. reference to array of permissible roles
5. reference to array of section restrictions (optional)
6. reference to results object (hash of hashes).
7. reference to optional userdata hash
Keys of top level hash are roles.
Keys of inner hashes are username:domain, with
values set to access type.
Optional userdata hash returns an array with arguments in the
same order as loncoursedata::get_classlist() for student data.
Entries for end, start, section and status are blank because
of the possibility of multiple values for non-student roles.
=cut
###############################################
sub get_course_users {
my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata) = @_;
my %idx = ();
my %seclists;
$idx{udom} = &Apache::loncoursedata::CL_SDOM();
$idx{uname} = &Apache::loncoursedata::CL_SNAME();
$idx{end} = &Apache::loncoursedata::CL_END();
$idx{start} = &Apache::loncoursedata::CL_START();
$idx{id} = &Apache::loncoursedata::CL_ID();
$idx{section} = &Apache::loncoursedata::CL_SECTION();
$idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
$idx{status} = &Apache::loncoursedata::CL_STATUS();
if (grep(/^st$/,@{$roles})) {
my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
my $now = time;
foreach my $student (keys(%{$classlist})) {
my $match = 0;
my $secmatch = 0;
my $section = $$classlist{$student}[$idx{section}];
if ($section eq '') {
$section = 'none';
}
if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
if (grep(/^all$/,@{$sections})) {
$secmatch = 1;
} elsif ($$classlist{$student}[$idx{section}] eq '') {
if (grep(/^none$/,@{$sections})) {
$secmatch = 1;
}
} else {
if (grep(/^\Q$section\E$/,@{$sections})) {
$secmatch = 1;
}
}
if (!$secmatch) {
next;
}
}
push(@{$seclists{$student}},$section);
if (defined($$types{'active'})) {
if ($$classlist{$student}[$idx{status}] eq 'Active') {
push(@{$$users{st}{$student}},'active');
$match = 1;
}
}
if (defined($$types{'previous'})) {
if ($$classlist{$student}[$idx{end}] <= $now) {
push(@{$$users{st}{$student}},'previous');
$match = 1;
}
}
if (defined($$types{'future'})) {
if (($$classlist{$student}[$idx{start}] > $now) && ($$classlist{$student}[$idx{end}] > $now) || ($$classlist{$student}[$idx{end}] == 0) || ($$classlist{$student}[$idx{end}] eq '')) {
push(@{$$users{st}{$student}},'future');
$match = 1;
}
}
if ($match && ref($userdata) eq 'HASH') {
$$userdata{$student} = $$classlist{$student};
}
}
}
if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
my $now = time;
foreach my $person (sort(keys(%coursepersonnel))) {
my $match = 0;
my $secmatch = 0;
my $status;
my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
$user =~ s/:$//;
my ($end,$start) = split(/:/,$coursepersonnel{$person});
if ($end == -1 || $start == -1) {
next;
}
if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
(grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
my ($uname,$udom) = split(/:/,$user);
if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
if (grep(/^all$/,@{$sections})) {
$secmatch = 1;
} elsif ($usec eq '') {
if (grep(/^none$/,@{$sections})) {
$secmatch = 1;
}
} else {
if (grep(/^\Q$usec\E$/,@{$sections})) {
$secmatch = 1;
}
}
if (!$secmatch) {
next;
}
}
if ($usec eq '') {
$usec = 'none';
}
if ($uname ne '' && $udom ne '') {
if ($end > 0 && $end < $now) {
$status = 'previous';
} elsif ($start > $now) {
$status = 'future';
} else {
$status = 'active';
}
foreach my $type (keys(%{$types})) {
if ($status eq $type) {
if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
push(@{$$users{$role}{$user}},$type);
}
$match = 1;
}
}
if (($match) && (ref($userdata) eq 'HASH')) {
if (!exists($$userdata{$uname.':'.$udom})) {
&get_user_info($udom,$uname,\%idx,$userdata);
}
if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
push(@{$seclists{$uname.':'.$udom}},$usec);
}
}
}
}
}
if (grep(/^ow$/,@{$roles})) {
if ((defined($cdom)) && (defined($cnum))) {
my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
if ( defined($csettings{'internal.courseowner'}) ) {
my $owner = $csettings{'internal.courseowner'};
if ($owner !~ /^[^:]+:[^:]+$/) {
$owner = $owner.':'.$cdom;
}
@{$$users{'ow'}{$owner}} = 'any';
if (defined($userdata) &&
!exists($$userdata{$owner.':'.$cdom})) {
&get_user_info($cdom,$owner,\%idx,$userdata);
if (!grep(/^none$/,@{$seclists{$owner.':'.$cdom}})) {
push(@{$seclists{$owner.':'.$cdom}},'none');
}
}
}
}
}
foreach my $user (keys(%seclists)) {
@{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
$$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
}
}
return;
}
sub get_user_info {
my ($udom,$uname,$idx,$userdata) = @_;
$$userdata{$uname.':'.$udom}[$$idx{fullname}] =
&plainname($uname,$udom,'lastname');
$$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
$$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
return;
}
###############################################
=pod
=item * &get_user_quota()
Retrieves quota assigned for storage of portfolio files for a user
Incoming parameters:
1. user's username
2. user's domain
Returns:
1. Disk quota (in Mb) assigned to student.
If a value has been stored in the user's environment,
it will return that, otherwise it returns the default
for users in the domain.
=cut
###############################################
sub get_user_quota {
my ($uname,$udom) = @_;
my $quota;
if (!defined($udom)) {
$udom = $env{'user.domain'};
}
if (!defined($uname)) {
$uname = $env{'user.name'};
}
if (($udom eq '' || $uname eq '') ||
($udom eq 'public') && ($uname eq 'public')) {
$quota = 0;
} else {
if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
$quota = $env{'environment.portfolioquota'};
} else {
my %userenv = &Apache::lonnet::dump('environment',$udom,$uname);
my ($tmp) = keys(%userenv);
if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
$quota = $userenv{'portfolioquota'};
} else {
undef(%userenv);
}
}
if ($quota eq '') {
$quota = &default_quota($udom);
}
}
return $quota;
}
###############################################
=pod
=item * &default_quota()
Retrieves default quota assigned for storage of user portfolio files
Incoming parameters:
1. domain
Returns:
1. Default disk quota (in Mb) for user portfolios in the domain.
If a value has been stored in the domain's configuration db,
it will return that, otherwise it returns 20 (for backwards
compatibility with domains which have not set up a configuration
db file; the original statically defined portfolio quota was 20 Mb).
=cut
###############################################
sub default_quota {
my ($udom) = @_;
my %defaults = &Apache::lonnet::get_dom('configuration',
['portfolioquota'],$udom);
if ($defaults{'portfolioquota'} ne '') {
return $defaults{'portfolioquota'};
} else {
return '20';
}
}
sub get_secgrprole_info {
my ($cdom,$cnum,$needroles,$type) = @_;
my %sections_count = &get_sections($cdom,$cnum);
my @sections = (sort {$a <=> $b} keys(%sections_count));
my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
my @groups = sort(keys(%curr_groups));
my $allroles = [];
my $rolehash;
my $accesshash = {
active => 'Currently has access',
future => 'Will have future access',
previous => 'Previously had access',
};
if ($needroles) {
$rolehash = {'all' => 'all'};
my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
if (&Apache::lonnet::error(%user_roles)) {
undef(%user_roles);
}
foreach my $item (keys(%user_roles)) {
my ($role)=split(/\:/,$item,2);
if ($role eq 'cr') { next; }
if ($role =~ /^cr/) {
$$rolehash{$role} = (split('/',$role))[3];
} else {
$$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
}
}
foreach my $key (sort(keys(%{$rolehash}))) {
push(@{$allroles},$key);
}
push (@{$allroles},'st');
$$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
}
return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
}
=pod
=item * get_unprocessed_cgi($query,$possible_names)
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.
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.
=cut
sub get_unprocessed_cgi {
my ($query,$possible_names)= @_;
# $Apache::lonxml::debug=1;
foreach my $pair (split(/&/,$query)) {
my ($name, $value) = split(/=/,$pair);
$name = &unescape($name);
if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
$value =~ tr/+/ /;
$value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
}
}
}
=pod
=item * cacheheader()
returns cache-controlling header code
=cut
sub cacheheader {
unless ($env{'request.method'} eq 'GET') { return ''; }
my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
my $output .='';
foreach my $type (sort(keys(%Types))) {
$Str .= ''.$Types{$type}." \n";
}
$Str .= " \n";
return $Str;
}
sub get_samples {
my ($records,$toget) = @_;
my @samples=({});
my $got=0;
foreach my $rec (@$records) {
my %temp = &record_sep($rec);
if (! grep(/\S/, values(%temp))) { next; }
if (%temp) {
$samples[$got]=\%temp;
$got++;
if ($got == $toget) { last; }
}
}
return \@samples;
}
######################################################
######################################################
=pod
=item * csv_print_samples($r,$records)
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 $samples = &get_samples($records,3);
$r->print(&mt('Samples').'');
foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
$r->print(''.&mt('Column [_1]',($sample+1)).' '); }
$r->print(' ');
foreach my $hash (@$samples) {
$r->print('');
foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
$r->print('');
if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
$r->print(' ');
}
$r->print(' ');
}
$r->print('
'.
''.&mt('Attribute').' '.
''.&mt('Column').' '."\n");
foreach my $array_ref (@$d) {
my ($value,$display,$defaultcol)=@{ $array_ref };
$r->print(''.$display.' ');
$r->print('');
$r->print('Column '.($sample+1).' ');
}
$r->print(' '.
&mt('Field').' '.&mt('Samples').' ');
foreach my $option (@$d) {
my ($value,$display,$defaultcol)=@{ $option };
$r->print(''.
$display.' ');
}
$r->print(' ');
foreach my $line (0..2) {
if (defined($samples->[$line]{$key})) {
$r->print($samples->[$line]{$key}." '.$linktext.' ';
}
#######################################################
#######################################################
=pod
=head1 Course Environment Routines
=over 4
=item &restore_course_settings
=item &store_course_settings
Restores/Store indicated form parameters from the course environment.
Will not overwrite existing values of the form parameters.
Inputs:
a scalar describing the data (e.g. 'chart', 'problem_analysis')
a hash ref describing the data to be stored. For example:
%Save_Parameters = ('Status' => 'scalar',
'chartoutputmode' => 'scalar',
'chartoutputdata' => 'scalar',
'Section' => 'array',
'Group' => 'array',
'StudentData' => 'array',
'Maps' => 'array');
Returns: both routines return nothing
=cut
#######################################################
#######################################################
sub store_course_settings {
return &store_settings($env{'request.course.id'},@_);
}
sub store_settings {
# save to the environment
# appenv the same items, just to be safe
my $udom = $env{'user.domain'};
my $uname = $env{'user.name'};
my ($context,$prefix,$Settings) = @_;
my %SaveHash;
my %AppHash;
while (my ($setting,$type) = each(%$Settings)) {
my $basename = join('.','internal',$context,$prefix,$setting);
my $envname = 'environment.'.$basename;
if (exists($env{'form.'.$setting})) {
# Save this value away
if ($type eq 'scalar' &&
(! exists($env{$envname}) ||
$env{$envname} ne $env{'form.'.$setting})) {
$SaveHash{$basename} = $env{'form.'.$setting};
$AppHash{$envname} = $env{'form.'.$setting};
} elsif ($type eq 'array') {
my $stored_form;
if (ref($env{'form.'.$setting})) {
$stored_form = join(',',
map {
&escape($_);
} sort(@{$env{'form.'.$setting}}));
} else {
$stored_form =
&escape($env{'form.'.$setting});
}
# Determine if the array contents are the same.
if ($stored_form ne $env{$envname}) {
$SaveHash{$basename} = $stored_form;
$AppHash{$envname} = $stored_form;
}
}
}
}
my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
$udom,$uname);
if ($put_result !~ /^(ok|delayed)/) {
&Apache::lonnet::logthis('unable to save form parameters, '.
'got error:'.$put_result);
}
# Make sure these settings stick around in this session, too
&Apache::lonnet::appenv(%AppHash);
return;
}
sub restore_course_settings {
return &restore_settings($env{'request.course.id'},@_);
}
sub restore_settings {
my ($context,$prefix,$Settings) = @_;
while (my ($setting,$type) = each(%$Settings)) {
next if (exists($env{'form.'.$setting}));
my $envname = 'environment.internal.'.$context.'.'.$prefix.
'.'.$setting;
if (exists($env{$envname})) {
if ($type eq 'scalar') {
$env{'form.'.$setting} = $env{$envname};
} elsif ($type eq 'array') {
$env{'form.'.$setting} = [
map {
&unescape($_);
} split(',',$env{$envname})
];
}
}
}
}
############################################################
############################################################
sub commit_customrole {
my ($udom,$uname,$url,$three,$four,$five,$start,$end) = @_;
my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.'@'.$three.' in '.$url.
($start?', '.&mt('starting').' '.localtime($start):'').
($end?', ending '.localtime($end):'').': '.
&Apache::lonnet::assigncustomrole(
$udom,$uname,$url,$three,$four,$five,$end,$start).
' '.$result.' ok '.
&Apache::lonnet::assignrole(
$udom,$uname,$url,$three,$end,$start).
' '.&mt('Attempting to clone non-existing [_1]',$crstype).' '.$cloneid.' ';
} else {
$outcome .=
''.&mt('Cloning [_1] from [_2]',$crstype,$clonehome).' ';
my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
# Copy all files
&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid);
# Restore URL
$cenv{'url'}=$oldcenv{'url'};
# Restore title
$cenv{'description'}=$oldcenv{'description'};
# restore grading mode
if (defined($oldcenv{'grading'})) {
$cenv{'grading'}=$oldcenv{'grading'};
}
# Mark as cloned
$cenv{'clonedfrom'}=$cloneid;
delete($cenv{'default_enrollment_start_date'});
delete($cenv{'default_enrollment_end_date'});
}
}
#
# Set environment (will override cloned, if existing)
#
my @sections = ();
my @xlists = ();
if ($args->{'crstype'}) {
$cenv{'type'}=$args->{'crstype'};
}
if ($args->{'crsid'}) {
$cenv{'courseid'}=$args->{'crsid'};
}
if ($args->{'crscode'}) {
$cenv{'internal.coursecode'}=$args->{'crscode'};
}
if ($args->{'crsquota'} ne '') {
$cenv{'internal.coursequota'}=$args->{'crsquota'};
} else {
$cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
}
if ($args->{'ccuname'}) {
$cenv{'internal.courseowner'} = $args->{'ccuname'}.
':'.$args->{'ccdomain'};
} else {
$cenv{'internal.courseowner'} = $args->{'curruser'};
}
my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
if ($args->{'crssections'}) {
$cenv{'internal.sectionnums'} = '';
if ($args->{'crssections'} =~ m/,/) {
@sections = split/,/,$args->{'crssections'};
} else {
$sections[0] = $args->{'crssections'};
}
if (@sections > 0) {
foreach my $item (@sections) {
my ($sec,$gp) = split/:/,$item;
my $class = $args->{'crscode'}.$sec;
my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
$cenv{'internal.sectionnums'} .= $item.',';
unless ($addcheck eq 'ok') {
push @badclasses, $class;
}
}
$cenv{'internal.sectionnums'} =~ s/,$//;
}
}
# do not hide course coordinator from staff listing,
# even if privileged
$cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
# add crosslistings
if ($args->{'crsxlist'}) {
$cenv{'internal.crosslistings'}='';
if ($args->{'crsxlist'} =~ m/,/) {
@xlists = split/,/,$args->{'crsxlist'};
} else {
$xlists[0] = $args->{'crsxlist'};
}
if (@xlists > 0) {
foreach my $item (@xlists) {
my ($xl,$gp) = split/:/,$item;
my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
$cenv{'internal.crosslistings'} .= $item.',';
unless ($addcheck eq 'ok') {
push @badclasses, $xl;
}
}
$cenv{'internal.crosslistings'} =~ s/,$//;
}
}
if ($args->{'autoadds'}) {
$cenv{'internal.autoadds'}=$args->{'autoadds'};
}
if ($args->{'autodrops'}) {
$cenv{'internal.autodrops'}=$args->{'autodrops'};
}
# check for notification of enrollment changes
my @notified = ();
if ($args->{'notify_owner'}) {
if ($args->{'ccuname'} ne '') {
push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
}
}
if ($args->{'notify_dc'}) {
if ($uname ne '') {
push(@notified,$uname.'@'.$udom);
}
}
if (@notified > 0) {
my $notifylist;
if (@notified > 1) {
$notifylist = join(',',@notified);
} else {
$notifylist = $notified[0];
}
$cenv{'internal.notifylist'} = $notifylist;
}
if (@badclasses > 0) {
my %lt=&Apache::lonlocal::texthash(
'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course. However, if automated course roster updates are enabled for this class, these particular sections/crosslistings will not contribute towards enrollment, because the user identified as the course owner for this LON-CAPA course',
'dnhr' => 'does not have rights to access enrollment in these classes',
'adby' => 'as determined by the policies of your institution on access to official classlists'
);
$outcome .= ''.$lt{'tclb'}.' ('.$cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.' ('.$lt{'adby'}.').'."\n";
foreach (@badclasses) {
$outcome .= "$_ \n";
}
$outcome .= " \n";
}
if ($args->{'no_end_date'}) {
$args->{'endaccess'} = 0;
}
$cenv{'internal.autostart'}=$args->{'enrollstart'};
$cenv{'internal.autoend'}=$args->{'enrollend'};
$cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
$cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
if ($args->{'showphotos'}) {
$cenv{'internal.showphotos'}=$args->{'showphotos'};
}
$cenv{'internal.authtype'} = $args->{'authtype'};
$cenv{'internal.autharg'} = $args->{'autharg'};
if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
$outcome .= ''.
&mt('As you did not include the default Kerberos domain to be used for authentication in this class, the institutional data used by the automated enrollment process must include the Kerberos domain for each new student').' ';
}
}
if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
if ($args->{'setpolicy'}) {
$cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
}
if ($args->{'setcontent'}) {
$cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
}
}
if ($args->{'reshome'}) {
$cenv{'reshome'}=$args->{'reshome'}.'/';
$cenv{'reshome'}=~s/\/+$/\//;
}
#
# course has keyed access
#
if ($args->{'setkeys'}) {
$cenv{'keyaccess'}='yes';
}
# if specified, key authority is not course, but user
# only active if keyaccess is yes
if ($args->{'keyauth'}) {
my ($user,$domain) = split(':',$args->{'keyauth'});
$user = &LONCAPA::clean_username($user);
$domain = &LONCAPA::clean_username($domain);
if ($user ne '' && $domain ne '') {
$cenv{'keyauth'}=$user.':'.$domain;
}
}
if ($args->{'disresdis'}) {
$cenv{'pch.roles.denied'}='st';
}
if ($args->{'disablechat'}) {
$cenv{'plc.roles.denied'}='st';
}
# Record we've not yet viewed the Course Initialization Helper for this
# course
$cenv{'course.helper.not.run'} = 1;
#
# Use new Randomseed
#
$cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
$cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
#
# The encryption code and receipt prefix for this course
#
$cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
$cenv{'internal.encpref'}=100+int(9*rand(99));
#
# By default, use standard grading
if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
$outcome .= ('WARNING: ".
'Could not create environment storage in lonauth: '.$!.' ');
return 'error: '.$!;
}
}
$env{'request.role'}='cm';
$env{'request.role.adv'}=$env{'user.adv'};
$env{'browser.type'}=$clientbrowser;
return $cookie;
}
sub _add_to_env {
my ($idf,$env_data,$prefix) = @_;
while (my ($key,$value) = each(%$env_data)) {
$idf->{$prefix.$key} = $value;
$env{$prefix.$key} = $value;
}
}
=pod
=back
=cut
1;
__END__;