# The LearningOnline Network with CAPA
# a pile of common routines
#
# $Id: loncommon.pm,v 1.1075.2.171 2024/10/06 00:30:26 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
# This file is part of the LearningOnline Network with CAPA (LON-CAPA).
#
# LON-CAPA is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# LON-CAPA is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with LON-CAPA; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# /home/httpd/html/adm/gpl.txt
#
# http://www.lon-capa.org/
#
# Makes a table out of the previous attempts
# Inputs result_from_symbread, user, domain, course_id
# Reads in non-network-related .tab files
# POD header:
=pod
=head1 NAME
Apache::loncommon - pile of common routines
=head1 SYNOPSIS
Common routines for manipulating connections, student answers,
domains, common Javascript fragments, etc.
=head1 OVERVIEW
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.
=cut
# End of POD header
package Apache::loncommon;
use strict;
use Apache::lonnet;
use GDBM_File;
use POSIX qw(strftime mktime);
use Apache::lonmenu();
use Apache::lonenc();
use Apache::lonlocal;
use HTML::Entities;
use Apache::lonhtmlcommon();
use Apache::loncoursedata();
use Apache::lontexconvert();
use Apache::lonclonecourse();
use Apache::lonuserutils();
use Apache::lonuserstate();
use Apache::courseclassifier();
use LONCAPA qw(:DEFAULT :match);
use HTTP::Request;
use DateTime::TimeZone;
use DateTime::Locale;
use Encode();
use Authen::Captcha;
use Captcha::reCAPTCHA;
use JSON::DWIW;
use LWP::UserAgent;
use Crypt::DES;
use DynaLoader; # for Crypt::DES version
use File::Copy();
use File::Path();
# ---------------------------------------------- Designs
use vars qw(%defaultdesign);
my $readit;
##
## Global Variables
##
# ----------------------------------------------- SSI with retries:
#
=pod
=head1 Server Side include with retries:
=over 4
=item * &ssi_with_retries(resource,retries form)
Performs an ssi with some number of retries. Retries continue either
until the result is ok or until the retry count supplied by the
caller is exhausted.
Inputs:
=over 4
resource - Identifies the resource to insert.
retries - Count of the number of retries allowed.
form - Hash that identifies the rendering options.
=back
Returns:
=over 4
content - The content of the response. If retries were exhausted this is empty.
response - The response from the last attempt (which may or may not have been successful.
=back
=back
=cut
sub ssi_with_retries {
my ($resource, $retries, %form) = @_;
my $ok = 0; # True if we got a good response.
my $content;
my $response;
# Try to get the ssi done. within the retries count:
do {
($content, $response) = &Apache::lonnet::ssi($resource, %form);
$ok = $response->is_success;
if (!$ok) {
&Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
}
$retries--;
} while (!$ok && ($retries > 0));
if (!$ok) {
$content = ''; # On error return an empty content.
}
return ($content, $response);
}
# ----------------------------------------------- Filetypes/Languages/Copyright
my %language;
my %supported_language;
my %latex_language; # For choosing hyphenation in
my %latex_language_bykey; # for choosing hyphenation from metadata
my %cprtag;
my %scprtag;
my %fe; my %fd; my %fm;
my %category_extensions;
# ---------------------------------------------- Thesaurus variables
#
# %Keywords:
# A hash used by &keyword to determine if a word is considered a keyword.
# $thesaurus_db_file
# Scalar containing the full path to the thesaurus database.
my %Keywords;
my $thesaurus_db_file;
#
# Initialize values from language.tab, copyright.tab, filetypes.tab,
# thesaurus.tab, and filecategories.tab.
#
BEGIN {
# Variable initialization
$thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
#
unless ($readit) {
# ------------------------------------------------------------------- languages
{
my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
'/language.tab';
if ( open(my $fh,'<',$langtabfile) ) {
while (my $line = <$fh>) {
next if ($line=~/^\#/);
chomp($line);
my ($key,$two,$country,$three,$enc,$val,$sup,$latex)=(split(/\t/,$line));
$language{$key}=$val.' - '.$enc;
if ($sup) {
$supported_language{$key}=$sup;
}
if ($latex) {
$latex_language_bykey{$key} = $latex;
$latex_language{$two} = $latex;
}
}
close($fh);
}
}
# ------------------------------------------------------------------ copyrights
{
my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
'/copyright.tab';
if ( open (my $fh,'<',$copyrightfile) ) {
while (my $line = <$fh>) {
next if ($line=~/^\#/);
chomp($line);
my ($key,$val)=(split(/\s+/,$line,2));
$cprtag{$key}=$val;
}
close($fh);
}
}
# ----------------------------------------------------------- source copyrights
{
my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
'/source_copyright.tab';
if ( open (my $fh,'<',$sourcecopyrightfile) ) {
while (my $line = <$fh>) {
next if ($line =~ /^\#/);
chomp($line);
my ($key,$val)=(split(/\s+/,$line,2));
$scprtag{$key}=$val;
}
close($fh);
}
}
# -------------------------------------------------------------- default domain designs
my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
my $designfile = $designdir.'/default.tab';
if ( open (my $fh,'<',$designfile) ) {
while (my $line = <$fh>) {
next if ($line =~ /^\#/);
chomp($line);
my ($key,$val)=(split(/\=/,$line));
if ($val) { $defaultdesign{$key}=$val; }
}
close($fh);
}
# ------------------------------------------------------------- file categories
{
my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
'/filecategories.tab';
if ( open (my $fh,'<',$categoryfile) ) {
while (my $line = <$fh>) {
next if ($line =~ /^\#/);
chomp($line);
my ($extension,$category)=(split(/\s+/,$line,2));
push(@{$category_extensions{lc($category)}},$extension);
}
close($fh);
}
}
# ------------------------------------------------------------------ file types
{
my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
'/filetypes.tab';
if ( open (my $fh,'<',$typesfile) ) {
while (my $line = <$fh>) {
next if ($line =~ /^\#/);
chomp($line);
my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
if ($descr ne '') {
$fe{$ending}=lc($emb);
$fd{$ending}=$descr;
if ($mime ne 'unk') { $fm{$ending}=$mime; }
}
}
close($fh);
}
}
&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.
=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 separated list.
Specifying 'omit' will restrict the browser to NOT displaying files
with the given extension. Can be a comma separated 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.
=cut
sub browser_and_searcher_javascript {
my ($mode)=@_;
if (!defined($mode)) { $mode='edit'; }
my $resurl=&escape_single(&lastresurl());
return <
END
}
sub lastresurl {
if ($env{'environment.lastresurl'}) {
return $env{'environment.lastresurl'}
} else {
return '/res';
}
}
sub storeresurl {
my $resurl=&Apache::lonnet::clutter(shift);
unless ($resurl=~/^\/res/) { return 0; }
$resurl=~s/\/$//;
&Apache::lonnet::put('environment',{'lastresurl' => $resurl});
&Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
return 1;
}
sub studentbrowser_javascript {
unless (
(($env{'request.course.id'}) &&
(&Apache::lonnet::allowed('srm',$env{'request.course.id'})
|| &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
'/'.$env{'request.course.sec'})
))
|| ($env{'request.role'}=~/^(au|dc|su)/)
) { return ''; }
return (<<'ENDSTDBRW');
ENDSTDBRW
}
sub resourcebrowser_javascript {
unless ($env{'request.course.id'}) { return ''; }
return (<<'ENDRESBRW');
ENDRESBRW
}
sub selectstudent_link {
my ($form,$unameele,$udomele,$courseadv,$clickerid)=@_;
my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
&Apache::lonhtmlcommon::entity_encode($unameele)."','".
&Apache::lonhtmlcommon::entity_encode($udomele)."'";
if ($env{'request.course.id'}) {
if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
&& !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
'/'.$env{'request.course.sec'})) {
return '';
}
$callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
if ($courseadv eq 'only') {
$callargs .= ",'',1,'$courseadv'";
} elsif ($courseadv eq 'none') {
$callargs .= ",'','','$courseadv'";
} elsif ($courseadv eq 'condition') {
$callargs .= ",'','','$courseadv'";
}
return ''.
''.
&mt('Select User').'';
}
if ($env{'request.role'}=~/^(au|dc|su)/) {
$callargs .= ",'',1";
return ''.
''.
&mt('Select User').'';
}
return '';
}
sub selectresource_link {
my ($form,$reslink,$arg)=@_;
my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
&Apache::lonhtmlcommon::entity_encode($reslink)."'";
unless ($env{'request.course.id'}) { return $arg; }
return ''.
''.
$arg.'';
}
sub authorbrowser_javascript {
return <<"ENDAUTHORBRW";
ENDAUTHORBRW
}
sub coursebrowser_javascript {
my ($domainfilter,$sec_element,$formname,$role_element,$crstype,
$credits_element,$instcode) = @_;
my $wintitle = 'Course_Browser';
if ($crstype eq 'Community') {
$wintitle = 'Community_Browser';
}
my $id_functions = &javascript_index_functions();
my $output = '
';
return $output;
}
sub javascript_index_functions {
return <<"ENDJS";
function getFormIdByName(formname) {
for (var i=0;i -1) {
var domid = getIndexByName(formid,udom);
if (domid > -1) {
if (document.forms[formid].elements[domid].type == 'select-one') {
userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
}
if (document.forms[formid].elements[domid].type == 'hidden') {
userdom=document.forms[formid].elements[domid].value;
}
}
}
return userdom;
}
ENDJS
}
sub javascript_array_indexof {
return <
// >> 0;
if (len === 0) {
return -1;
}
var n = 0;
if (arguments.length > 0) {
n = Number(arguments[1]);
if (n !== n) { // shortcut for verifying if it's NaN
n = 0;
} else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
n = (n > 0 || -1) * Math.floor(Math.abs(n));
}
}
if (n >= len) {
return -1;
}
var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
for (; k < len; k++) {
if (k in t && t[k] === searchElement) {
return k;
}
}
return -1;
}
}
// ]]>
ENDJS
}
sub userbrowser_javascript {
my $id_functions = &javascript_index_functions();
return <<"ENDUSERBRW";
function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
var url = '/adm/pickuser?';
var userdom = getDomainFromSelectbox(formname,udom);
if (userdom != null) {
if (userdom != '') {
url += 'srchdom='+userdom+'&';
}
}
url += 'form=' + formname + '&unameelement='+uname+
'&udomelement='+udom+
'&ulastelement='+ulast+
'&ufirstelement='+ufirst+
'&uemailelement='+uemail+
'&hideudomelement='+hideudom+
'&coursedom='+crsdom;
if ((caller != null) && (caller != undefined)) {
url += '&caller='+caller;
}
var title = 'User_Browser';
var options = 'scrollbars=1,resizable=1,menubar=0';
options += ',width=700,height=600';
var stdeditbrowser = open(url,title,options,'1');
stdeditbrowser.focus();
}
function fix_domain (formname,udom,origdom,uname) {
var formid = getFormIdByName(formname);
if (formid > -1) {
var unameid = getIndexByName(formid,uname);
var domid = getIndexByName(formid,udom);
var hidedomid = getIndexByName(formid,origdom);
if (hidedomid > -1) {
var fixeddom = document.forms[formid].elements[hidedomid].value;
var unameval = document.forms[formid].elements[unameid].value;
if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
if (domid > -1) {
var slct = document.forms[formid].elements[domid];
if (slct.type == 'select-one') {
var i;
for (i=0;i'
."".$linktext.''
.'';
}
sub selectauthor_link {
my ($form,$udom)=@_;
return ''.
&mt('Select Author').'';
}
sub selectuser_link {
my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
$coursedom,$linktext,$caller) = @_;
return ''.$linktext.'';
}
sub check_uncheck_jscript {
my $jscript = <<"ENDSCRT";
function checkAll(field) {
if (field.length > 0) {
for (i = 0; i < field.length; i++) {
if (!field[i].disabled) {
field[i].checked = true;
}
}
} else {
if (!field.disabled) {
field.checked = true;
}
}
}
function uncheckAll(field) {
if (field.length > 0) {
for (i = 0; i < field.length; i++) {
field[i].checked = false ;
}
} else {
field.checked = false ;
}
}
ENDSCRT
return $jscript;
}
sub select_timezone {
my ($name,$selected,$onchange,$includeempty,$disabled)=@_;
my $output='";
return $output;
}
sub select_datelocale {
my ($name,$selected,$onchange,$includeempty,$disabled)=@_;
my $output='";
return $output;
}
sub select_language {
my ($name,$selected,$includeempty,$noedit) = @_;
my %langchoices;
if ($includeempty) {
%langchoices = ('' => 'No language preference');
}
foreach my $id (&languageids()) {
my $code = &supportedlanguagecode($id);
if ($code) {
$langchoices{$code} = &plainlanguagedescription($id);
}
}
%langchoices = &Apache::lonlocal::texthash(%langchoices);
return &select_form($selected,$name,\%langchoices,undef,$noedit);
}
=pod
=item * &linked_select_forms(...)
linked_select_forms returns a string containing a block
and html for two
'."\n".'
'.
&mt('LON-CAPA can make the required changes to your HTML file.').'
'.&mt('Updated [quant,_1,reference] in [_2].',
$count,''.
$container.'').'
';
} else {
$output = '
'.
&mt('Error: could not update [_1].',
''.
$container.'').'
';
}
}
}
if (($context eq 'syllabus') && (!$skiprewrites)) {
my ($actionurl,$state);
$actionurl = "/public/$udom/$uname/syllabus";
my ($ignore,$num,$numpathchanges,$existing,$mapping) =
&ask_for_embedded_content($actionurl,$state,\%allfiles,
\%codebase,
{'context' => 'rewrites',
'ignore_remote_references' => 1,});
if (ref($mapping) eq 'HASH') {
my $rewrites = 0;
foreach my $key (keys(%{$mapping})) {
next if ($key =~ m{^https?://});
my $ref = $mapping->{$key};
my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
my $attrib;
if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
$attrib = join('|',@{$allfiles{$mapping->{$key}}});
}
if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
$rewrites += $numchg;
}
}
if ($rewrites) {
my $saveresult;
my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
if ($url eq $container) {
my ($fname) = ($container =~ m{/([^/]+)$});
$output .= '
'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
$count,''.
$fname.'').'
';
} else {
$output .= '
'.
&mt('Error: could not update links in [_1].',
''.
$container.'').'
';
}
}
}
}
} else {
&logthis('Failed to parse '.$container.
' to modify references: '.$parse_result);
}
}
if (wantarray) {
return ($output,$count,$codebasecount);
} else {
return $output;
}
}
sub check_for_existing {
my ($path,$fname,$element) = @_;
my ($state,$msg);
if (-d $path.'/'.$fname) {
$state = 'exists';
$msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].',''.$fname.'',$path);
} elsif (-e $path.'/'.$fname) {
$state = 'exists';
$msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].',''.$fname.'',$path);
}
if ($state eq 'exists') {
$msg = ''.$msg.' ';
}
return ($state,$msg);
}
sub check_for_upload {
my ($path,$fname,$group,$element,$portfolio_root,$port_path,
$disk_quota,$current_disk_usage,$uname,$udom) = @_;
my $filesize = length($env{'form.'.$element});
if (!$filesize) {
my $msg = ''.
&mt('Unable to upload [_1]. (size = [_2] bytes)',
''.$fname.'',
$filesize).' '.
&mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').' '.
'';
return ('zero_bytes',$msg);
}
$filesize = $filesize/1000; #express in k (1024?)
my $getpropath = 1;
my ($dirlistref,$listerror) =
&Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
my $found_file = 0;
my $locked_file = 0;
my @lockers;
my $navmap;
if ($env{'request.course.id'}) {
$navmap = Apache::lonnavmaps::navmap->new();
}
if (ref($dirlistref) eq 'ARRAY') {
foreach my $line (@{$dirlistref}) {
my ($file_name,$rest)=split(/\&/,$line,2);
if ($file_name eq $fname){
$file_name = $path.$file_name;
if ($group ne '') {
$file_name = $group.$file_name;
}
$found_file = 1;
if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
foreach my $lock (@lockers) {
if (ref($lock) eq 'ARRAY') {
my ($symb,$crsid) = @{$lock};
if ($crsid eq $env{'request.course.id'}) {
if (ref($navmap)) {
my $res = $navmap->getBySymb($symb);
foreach my $part (@{$res->parts()}) {
my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
unless (($slot_status == $res->RESERVED) ||
($slot_status == $res->RESERVED_LOCATION)) {
$locked_file = 1;
}
}
} else {
$locked_file = 1;
}
} else {
$locked_file = 1;
}
}
}
} else {
my @info = split(/\&/,$rest);
my $currsize = $info[6]/1000;
if ($currsize < $filesize) {
my $extra = $filesize - $currsize;
if (($current_disk_usage + $extra) > $disk_quota) {
my $msg = '
'.
&mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded if existing (smaller) file with same name (size = [_3] kilobytes) is replaced.',
''.$fname.'',$filesize,$currsize).'
'.
'
'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
$disk_quota,$current_disk_usage).'
';
return ('will_exceed_quota',$msg);
}
}
}
}
}
}
if (($current_disk_usage + $filesize) > $disk_quota){
my $msg = '
'.
&mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.',''.$fname.'',$filesize).'
'.
'
'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'
';
return ('will_exceed_quota',$msg);
} elsif ($found_file) {
if ($locked_file) {
my $msg = '
';
$msg .= &mt('Unable to upload [_1]. A locked file by that name was found in [_2].',''.$fname.'',''.$port_path.$env{'form.currentpath'}.'');
$msg .= '
';
$msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.',''.$fname.'');
return ('file_locked',$msg);
} else {
my $msg = '
';
$msg .= &mt(' A file by that name: [_1] was found in [_2].',''.$fname.'',$port_path.$env{'form.currentpath'});
$msg .= '
';
return ('existingfile',$msg);
}
}
}
sub check_for_traversal {
my ($path,$url,$toplevel) = @_;
my @parts=split(/\//,$path);
my $cleanpath;
my $fullpath = $url;
for (my $i=0;$i<@parts;$i++) {
next if ($parts[$i] eq '.');
if ($parts[$i] eq '..') {
$fullpath =~ s{([^/]+/)$}{};
} else {
$fullpath .= $parts[$i].'/';
}
}
if ($fullpath =~ /^\Q$url\E(.*)$/) {
$cleanpath = $1;
} elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
my $curr_toprel = $1;
my @parts = split(/\//,$curr_toprel);
my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
my @urlparts = split(/\//,$url_toprel);
my $doubledots;
my $startdiff = -1;
for (my $i=0; $i<@urlparts; $i++) {
if ($startdiff == -1) {
unless ($urlparts[$i] eq $parts[$i]) {
$startdiff = $i;
$doubledots .= '../';
}
} else {
$doubledots .= '../';
}
}
if ($startdiff > -1) {
$cleanpath = $doubledots;
for (my $i=$startdiff; $i<@parts; $i++) {
$cleanpath .= $parts[$i].'/';
}
}
}
$cleanpath =~ s{(/)$}{};
return $cleanpath;
}
sub is_archive_file {
my ($mimetype) = @_;
if (($mimetype eq 'application/octet-stream') ||
($mimetype eq 'application/x-stuffit') ||
($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
return 1;
}
return;
}
sub decompress_form {
my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
my %lt = &Apache::lonlocal::texthash (
this => 'This file is an archive file.',
camt => 'This file is a Camtasia archive file.',
itsc => 'Its contents are as follows:',
youm => 'You may wish to extract its contents.',
extr => 'Extract contents',
auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
proa => 'Process automatically?',
yes => 'Yes',
no => 'No',
fold => 'Title for folder containing movie',
movi => 'Title for page containing embedded movie',
);
my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
my ($is_camtasia,$topdir,%toplevel,@paths);
my $info = &list_archive_contents($fileloc,\@paths);
if (@paths) {
foreach my $path (@paths) {
$path =~ s{^/}{};
if ($path =~ m{^([^/]+)/$}) {
$topdir = $1;
}
if ($path =~ m{^([^/]+)/}) {
$toplevel{$1} = $path;
} else {
$toplevel{$path} = $path;
}
}
}
if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
my @camtasia6 = ("$topdir/","$topdir/index.html",
"$topdir/media/",
"$topdir/media/$topdir.mp4",
"$topdir/media/FirstFrame.png",
"$topdir/media/player.swf",
"$topdir/media/swfobject.js",
"$topdir/media/expressInstall.swf");
my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
"$topdir/$topdir.mp4",
"$topdir/$topdir\_config.xml",
"$topdir/$topdir\_controller.swf",
"$topdir/$topdir\_embed.css",
"$topdir/$topdir\_First_Frame.png",
"$topdir/$topdir\_player.html",
"$topdir/$topdir\_Thumbnails.png",
"$topdir/playerProductInstall.swf",
"$topdir/scripts/",
"$topdir/scripts/config_xml.js",
"$topdir/scripts/handlebars.js",
"$topdir/scripts/jquery-1.7.1.min.js",
"$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
"$topdir/scripts/modernizr.js",
"$topdir/scripts/player-min.js",
"$topdir/scripts/swfobject.js",
"$topdir/skins/",
"$topdir/skins/configuration_express.xml",
"$topdir/skins/express_show/",
"$topdir/skins/express_show/player-min.css",
"$topdir/skins/express_show/spritesheet.png");
my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
"$topdir/$topdir.mp4",
"$topdir/$topdir\_config.xml",
"$topdir/$topdir\_controller.swf",
"$topdir/$topdir\_embed.css",
"$topdir/$topdir\_First_Frame.png",
"$topdir/$topdir\_player.html",
"$topdir/$topdir\_Thumbnails.png",
"$topdir/playerProductInstall.swf",
"$topdir/scripts/",
"$topdir/scripts/config_xml.js",
"$topdir/scripts/techsmith-smart-player.min.js",
"$topdir/skins/",
"$topdir/skins/configuration_express.xml",
"$topdir/skins/express_show/",
"$topdir/skins/express_show/spritesheet.min.css",
"$topdir/skins/express_show/spritesheet.png",
"$topdir/skins/express_show/techsmith-smart-player.min.css");
my @diffs = &compare_arrays(\@paths,\@camtasia6);
if (@diffs == 0) {
$is_camtasia = 6;
} else {
@diffs = &compare_arrays(\@paths,\@camtasia8_1);
if (@diffs == 0) {
$is_camtasia = 8;
} else {
@diffs = &compare_arrays(\@paths,\@camtasia8_4);
if (@diffs == 0) {
$is_camtasia = 8;
}
}
}
}
my $output;
if ($is_camtasia) {
$output = <<"ENDCAM";
$lt{'camt'}
ENDCAM
} else {
$output = '
'.$lt{'this'};
if ($info eq '') {
$output .= ' '.$lt{'youm'}.'
'."\n";
my $duplicates;
my $num = 0;
if (ref($dirlist) eq 'ARRAY') {
foreach my $item (@{$dirlist}) {
if (ref($item) eq 'ARRAY') {
if (exists($toplevel{$item->[0]})) {
$duplicates .=
&start_data_table_row().
'
';
}
$output .=
''.
''.
"\n";
if ($duplicates ne '') {
$output .= '
'.
&mt('Warning: decompression of the archive will overwrite the following items which already exist:').' '.
&start_data_table().
&start_data_table_header_row().
'
'."\n".
&end_data_table_row();
return $output;
}
sub archive_options_form {
my ($form,$display,$count,$hiddenelem) = @_;
my %lt = &Apache::lonlocal::texthash(
perm => 'Permanently remove archive file?',
hows => 'How should each extracted item be incorporated in the course?',
cont => 'Content actions for all',
addf => 'Add as folder/file',
incd => 'Include as dependency for a displayed file',
disc => 'Discard',
no => 'No',
yes => 'Yes',
save => 'Save',
);
my $output = <<"END";
';
}
sub archive_javascript {
my ($startcount,$numitems,$titles,$children) = @_;
return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
my $maintitle = $env{'form.comment'};
my $scripttag = <
// 0) {
var startelement = $startcount + ((count-1) * 7);
for (var j=1; j<6; j++) {
if ((j != 2) && (j != 4)) {
var item = startelement + j;
if (form.elements[item].type == 'radio') {
if (form.elements[item].checked) {
containerCheck(form,count,j);
break;
}
}
}
}
}
}
numitems = $numitems
var titles = new Array(numitems);
var parents = new Array(numitems);
for (var i=0; i $b } (keys(%{$children}))) {
my @contents = split(/:/,$children->{$container});
for (my $i=0; $i<@contents; $i ++) {
$scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
}
}
foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
$scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
}
$scripttag .= < 0) {
dependencyCheck(form,count,offset);
var item = (offset+$startcount)+7*(count-1);
form.elements[item].checked = true;
if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
if (parents[count].length > 0) {
for (var j=0; j 0) {
var chosen = (offset+$startcount)+7*(count-1);
var depitem = $startcount + ((count-1) * 7) + 4;
var currtype = form.elements[depitem].type;
if (form.elements[chosen].value == 'dependency') {
document.getElementById('arc_depon_'+count).style.display='block';
form.elements[depitem].options.length = 0;
form.elements[depitem].options[0] = new Option('Select','',true,true);
for (var i=1; i<=numitems; i++) {
if (i == count) {
continue;
}
var startelement = $startcount + (i-1) * 7;
for (var j=1; j<6; j++) {
if ((j != 2) && (j!= 4)) {
var item = startelement + j;
if (form.elements[item].type == 'radio') {
if (form.elements[item].checked) {
if (form.elements[item].value == 'display') {
var n = form.elements[depitem].options.length;
form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
}
}
}
}
}
}
} else {
document.getElementById('arc_depon_'+count).style.display='none';
form.elements[depitem].options.length = 0;
form.elements[depitem].options[0] = new Option('Select','',true,true);
}
titleCheck(form,count,offset);
}
}
function propagateSelect(form,count,offset) {
if (count > 0) {
var item = (1+offset+$startcount)+7*(count-1);
var picked = form.elements[item].options[form.elements[item].selectedIndex].value;
if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
if (parents[count].length > 0) {
for (var j=0; j 0) {
var item = (offset+$startcount)+7*(count-1);
if (form.elements[item].type == 'radio') {
if (form.elements[item].value == 'dependency') {
if (form.elements[item+1].type == 'select-one') {
for (var i=0; i 0) {
for (var j=0; j 0) {
var chosen = (offset+$startcount)+7*(count-1);
var depitem = $startcount + ((count-1) * 7) + 2;
var currtype = form.elements[depitem].type;
if (form.elements[chosen].value == 'display') {
document.getElementById('arc_title_'+count).style.display='block';
if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
document.getElementById('archive_title_'+count).value=maintitle;
}
} else {
document.getElementById('arc_title_'+count).style.display='none';
if (currtype == 'text') {
document.getElementById('archive_title_'+count).value='';
}
}
}
return;
}
// ]]>
END
return $scripttag;
}
sub process_extracted_files {
my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
my $numitems = $env{'form.archive_count'};
return if ((!$numitems) || ($numitems =~ /\D/));
my @ids=&Apache::lonnet::current_machine_ids();
my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
%folders,%containers,%mapinner,%prompttofetch);
my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
if (grep(/^\Q$docuhome\E$/,@ids)) {
$prefix = &LONCAPA::propath($docudom,$docuname);
$pathtocheck = "$dir_root/$destination";
$dir = $dir_root;
$ishome = 1;
} else {
$prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
$pathtocheck = "$dir_root/$docudom/$docuname/$destination";
$dir = "$dir_root/$docudom/$docuname";
}
my $currdir = "$dir_root/$destination";
(my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
if ($env{'form.folderpath'}) {
my @items = split('&',$env{'form.folderpath'});
$folders{'0'} = $items[-2];
if ($env{'form.folderpath'} =~ /\:1$/) {
$containers{'0'}='page';
} else {
$containers{'0'}='sequence';
}
}
my @archdirs = &get_env_multiple('form.archive_directory');
if ($numitems) {
for (my $i=1; $i<=$numitems; $i++) {
my $path = $env{'form.archive_content_'.$i};
if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
my $item = $1;
$toplevelitems{$item} = $i;
if (grep(/^\Q$i\E$/,@archdirs)) {
$is_dir{$item} = 1;
}
}
}
}
my ($output,%children,%parent,%titles,%dirorder,$result);
if (keys(%toplevelitems) > 0) {
my @contents = sort(keys(%toplevelitems));
(my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
\%parent,\@contents,\%dirorder,\%titles);
}
my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
if ($numitems) {
for (my $i=1; $i<=$numitems; $i++) {
next if ($env{'form.archive_'.$i} eq 'dependency');
my $path = $env{'form.archive_content_'.$i};
if ($path =~ /^\Q$pathtocheck\E/) {
if ($env{'form.archive_'.$i} eq 'discard') {
if ($prefix ne '' && $path ne '') {
if (-e $prefix.$path) {
if ((@archdirs > 0) &&
(grep(/^\Q$i\E$/,@archdirs))) {
$todeletedir{$prefix.$path} = 1;
} else {
$todelete{$prefix.$path} = 1;
}
}
}
} elsif ($env{'form.archive_'.$i} eq 'display') {
my ($docstitle,$title,$url,$outer);
($title) = ($path =~ m{/([^/]+)$});
$docstitle = $env{'form.archive_title_'.$i};
if ($docstitle eq '') {
$docstitle = $title;
}
$outer = 0;
if (ref($dirorder{$i}) eq 'ARRAY') {
if (@{$dirorder{$i}} > 0) {
foreach my $item (reverse(@{$dirorder{$i}})) {
if ($env{'form.archive_'.$item} eq 'display') {
$outer = $item;
last;
}
}
}
}
my ($errtext,$fatal) =
&LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
'/'.$folders{$outer}.'.'.
$containers{$outer});
next if ($fatal);
if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
if ($context eq 'coursedocs') {
$mapinner{$i} = time;
$folders{$i} = 'default_'.$mapinner{$i};
$containers{$i} = 'sequence';
my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
$folders{$i}.'.'.$containers{$i};
my $newidx = &LONCAPA::map::getresidx();
$LONCAPA::map::resources[$newidx]=
$docstitle.':'.$url.':false:normal:res';
push(@LONCAPA::map::order,$newidx);
my ($outtext,$errtext) =
&LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
$docuname.'/'.$folders{$outer}.
'.'.$containers{$outer},1,1);
$newseqid{$i} = $newidx;
unless ($errtext) {
$result .= '
'.&mt('Folder: [_1] added to course',
&HTML::Entities::encode($docstitle,'<>&"'))..
'
'."\n";
}
}
} else {
if ($context eq 'coursedocs') {
my $newidx=&LONCAPA::map::getresidx();
my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
$docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
$title;
if (($outer !~ /\D/) &&
(($mapinner{$outer} eq 'default') || ($mapinner{$outer} !~ /\D/)) &&
($newidx !~ /\D/)) {
if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
}
if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
}
if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
$newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
unless ($ishome) {
my $fetch = "$newdest{$i}/$title";
$fetch =~ s/^\Q$prefix$dir\E//;
$prompttofetch{$fetch} = 1;
}
}
}
$LONCAPA::map::resources[$newidx]=
$docstitle.':'.$url.':false:normal:res';
push(@LONCAPA::map::order, $newidx);
my ($outtext,$errtext)=
&LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
$docuname.'/'.$folders{$outer}.
'.'.$containers{$outer},1,1);
unless ($errtext) {
if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
$result .= '
'.&mt('File: [_1] added to course',
&HTML::Entities::encode($docstitle,'<>&"')).
'
'."\n";
}
}
} else {
$warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
&HTML::Entities::encode($path,'<>&"')).' ';
}
}
}
}
} else {
$warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
&HTML::Entities::encode($path,'<>&"')).' ';
}
}
for (my $i=1; $i<=$numitems; $i++) {
next unless ($env{'form.archive_'.$i} eq 'dependency');
my $path = $env{'form.archive_content_'.$i};
if ($path =~ /^\Q$pathtocheck\E/) {
my ($title) = ($path =~ m{/([^/]+)$});
$referrer{$i} = $env{'form.archive_dependent_on_'.$i};
if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
if (ref($dirorder{$i}) eq 'ARRAY') {
my ($itemidx,$fullpath,$relpath);
if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
my $container = $dirorder{$referrer{$i}}->[-1];
for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
if ($dirorder{$i}->[$j] eq $container) {
$itemidx = $j;
}
}
}
if ($itemidx eq '') {
$itemidx = 0;
}
if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
if ($mapinner{$referrer{$i}}) {
$fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
unless (defined($newseqid{$dirorder{$i}->[$j]})) {
$fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
$relpath .= '/'.$titles{$dirorder{$i}->[$j]};
if (!-e $fullpath) {
mkdir($fullpath,0755);
}
}
} else {
last;
}
}
}
} elsif ($newdest{$referrer{$i}}) {
$fullpath = $newdest{$referrer{$i}};
for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
$orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
last;
} elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
unless (defined($newseqid{$dirorder{$i}->[$j]})) {
$fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
$relpath .= '/'.$titles{$dirorder{$i}->[$j]};
if (!-e $fullpath) {
mkdir($fullpath,0755);
}
}
} else {
last;
}
}
}
if ($fullpath ne '') {
if (-e "$prefix$path") {
unless (rename("$prefix$path","$fullpath/$title")) {
$warning .= &mt('Failed to rename dependency').' ';
}
}
if (-e "$fullpath/$title") {
my $showpath;
if ($relpath ne '') {
$showpath = "$relpath/$title";
} else {
$showpath = "/$title";
}
$result .= '
'.&mt('[_1] included as a dependency',
&HTML::Entities::encode($showpath,'<>&"')).
'
'."\n";
unless ($ishome) {
my $fetch = "$fullpath/$title";
$fetch =~ s/^\Q$prefix$dir\E//;
$prompttofetch{$fetch} = 1;
}
}
}
}
} elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
$warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
&HTML::Entities::encode($path,'<>&"'),
&HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
' ';
}
} else {
$warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
&HTML::Entities::encode($path)).' ';
}
}
if (keys(%todelete)) {
foreach my $key (keys(%todelete)) {
unlink($key);
}
}
if (keys(%todeletedir)) {
foreach my $key (keys(%todeletedir)) {
rmdir($key);
}
}
foreach my $dir (sort(keys(%is_dir))) {
if (($pathtocheck ne '') && ($dir ne '')) {
&cleanup_empty_dirs($prefix."$pathtocheck/$dir");
}
}
if ($result ne '') {
$output .= '
'."\n".
$result."\n".
'
';
}
unless ($ishome) {
my $replicationfail;
foreach my $item (keys(%prompttofetch)) {
my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
unless ($fetchresult eq 'ok') {
$replicationfail .= '
'.$item.'
'."\n";
}
}
if ($replicationfail) {
$output .= '
'.
&mt('Course home server failed to retrieve:').'
'.
$replicationfail.
'
';
}
}
} else {
$warning = &mt('No items found in archive.');
}
if ($error) {
$output .= '
'.&mt('Not extracted.').' '.
$error.'
'."\n";
}
if ($warning) {
$output .= '
'.$warning.'
'."\n";
}
return $output;
}
sub cleanup_empty_dirs {
my ($path) = @_;
if (($path ne '') && (-d $path)) {
if (opendir(my $dirh,$path)) {
my @dircontents = grep(!/^\./,readdir($dirh));
my $numitems = 0;
foreach my $item (@dircontents) {
if (-d "$path/$item") {
&cleanup_empty_dirs("$path/$item");
if (-e "$path/$item") {
$numitems ++;
}
} else {
$numitems ++;
}
}
if ($numitems == 0) {
rmdir($path);
}
closedir($dirh);
}
}
return;
}
=pod
=item * &get_folder_hierarchy()
Provides hierarchy of names of folders/sub-folders containing the current
item,
Inputs: 3
- $navmap - navmaps object
- $map - url for map (either the trigger itself, or map containing
the resource, which is the trigger).
- $showitem - 1 => show title for map itself; 0 => do not show.
Outputs: 1 @pathitems - array of folder/subfolder names.
=cut
sub get_folder_hierarchy {
my ($navmap,$map,$showitem) = @_;
my @pathitems;
if (ref($navmap)) {
my $mapres = $navmap->getResourceByUrl($map);
if (ref($mapres)) {
my $pcslist = $mapres->map_hierarchy();
if ($pcslist ne '') {
my @pcs = split(/,/,$pcslist);
foreach my $pc (@pcs) {
if ($pc == 1) {
push(@pathitems,&mt('Main Content'));
} else {
my $res = $navmap->getByMapPc($pc);
if (ref($res)) {
my $title = $res->compTitle();
$title =~ s/\W+/_/g;
if ($title ne '') {
push(@pathitems,$title);
}
}
}
}
}
if ($showitem) {
if ($mapres->{ID} eq '0.0') {
push(@pathitems,&mt('Main Content'));
} else {
my $maptitle = $mapres->compTitle();
$maptitle =~ s/\W+/_/g;
if ($maptitle ne '') {
push(@pathitems,$maptitle);
}
}
}
}
}
return @pathitems;
}
=pod
=item * &get_turnedin_filepath()
Determines path in a user's portfolio file for storage of files uploaded
to a specific essayresponse or dropbox item.
Inputs: 3 required + 1 optional.
$symb is symb for resource, $uname and $udom are for current user (required).
$caller is optional (can be "submission", if routine is called when storing
an upoaded file when "Submit Answer" button was pressed).
Returns array containing $path and $multiresp.
$path is path in portfolio. $multiresp is 1 if this resource contains more
than one file upload item. Callers of routine should append partid as a
subdirectory to $path in cases where $multiresp is 1.
Called by: homework/essayresponse.pm and homework/structuretags.pm
=cut
sub get_turnedin_filepath {
my ($symb,$uname,$udom,$caller) = @_;
my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
my $turnindir;
my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
$turnindir = $userhash{'turnindir'};
my ($path,$multiresp);
if ($turnindir eq '') {
if ($caller eq 'submission') {
$turnindir = &mt('turned in');
$turnindir =~ s/\W+/_/g;
my %newhash = (
'turnindir' => $turnindir,
);
&Apache::lonnet::put('environment',\%newhash,$udom,$uname);
}
}
if ($turnindir ne '') {
$path = '/'.$turnindir.'/';
my ($multipart,$turnin,@pathitems);
my $navmap = Apache::lonnavmaps::navmap->new();
if (defined($navmap)) {
my $mapres = $navmap->getResourceByUrl($map);
if (ref($mapres)) {
my $pcslist = $mapres->map_hierarchy();
if ($pcslist ne '') {
foreach my $pc (split(/,/,$pcslist)) {
my $res = $navmap->getByMapPc($pc);
if (ref($res)) {
my $title = $res->compTitle();
$title =~ s/\W+/_/g;
if ($title ne '') {
if (($pc > 1) && (length($title) > 12)) {
$title = substr($title,0,12);
}
push(@pathitems,$title);
}
}
}
}
my $maptitle = $mapres->compTitle();
$maptitle =~ s/\W+/_/g;
if ($maptitle ne '') {
if (length($maptitle) > 12) {
$maptitle = substr($maptitle,0,12);
}
push(@pathitems,$maptitle);
}
unless ($env{'request.state'} eq 'construct') {
my $res = $navmap->getBySymb($symb);
if (ref($res)) {
my $partlist = $res->parts();
my $totaluploads = 0;
if (ref($partlist) eq 'ARRAY') {
foreach my $part (@{$partlist}) {
my @types = $res->responseType($part);
my @ids = $res->responseIds($part);
for (my $i=0; $i < scalar(@ids); $i++) {
if ($types[$i] eq 'essay') {
my $partid = $part.'_'.$ids[$i];
if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
$totaluploads ++;
}
}
}
}
if ($totaluploads > 1) {
$multiresp = 1;
}
}
}
}
} else {
return;
}
} else {
return;
}
my $restitle=&Apache::lonnet::gettitle($symb);
$restitle =~ s/\W+/_/g;
if ($restitle eq '') {
$restitle = ($resurl =~ m{/[^/]+$});
if ($restitle eq '') {
$restitle = time;
}
}
if (length($restitle) > 12) {
$restitle = substr($restitle,0,12);
}
push(@pathitems,$restitle);
$path .= join('/',@pathitems);
}
return ($path,$multiresp);
}
=pod
=back
=head1 CSV Upload/Handling functions
=over 4
=item * &upfile_store($r)
Store uploaded file, $r should be the HTTP Request object,
needs $env{'form.upfile'}
returns $datatoken to be put into hidden field
=cut
sub upfile_store {
my $r=shift;
$env{'form.upfile'}=~s/\r/\n/gs;
$env{'form.upfile'}=~s/\f/\n/gs;
$env{'form.upfile'}=~s/\n+/\n/gs;
$env{'form.upfile'}=~s/\n+$//gs;
my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
'_enroll_'.$env{'request.course.id'}.'_'.
time.'_'.$$);
return if ($datatoken eq '');
{
my $datafile = $r->dir_config('lonDaemons').
'/tmp/'.$datatoken.'.tmp';
if ( open(my $fh,'>',$datafile) ) {
print $fh $env{'form.upfile'};
close($fh);
}
}
return $datatoken;
}
=pod
=item * &load_tmp_file($r,$datatoken)
Load uploaded file from tmp, $r should be the HTTP Request object,
$datatoken is the name to assign to the temporary file.
sets $env{'form.upfile'} to the contents of the file
=cut
sub load_tmp_file {
my ($r,$datatoken) = @_;
return if ($datatoken eq '');
my @studentdata=();
{
my $studentfile = $r->dir_config('lonDaemons').
'/tmp/'.$datatoken.'.tmp';
if ( open(my $fh,'<',$studentfile) ) {
@studentdata=<$fh>;
close($fh);
}
}
$env{'form.upfile'}=join('',@studentdata);
}
sub valid_datatoken {
my ($datatoken) = @_;
if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
return $datatoken;
}
return;
}
=pod
=item * &upfile_record_sep()
Separate uploaded file into records
returns array of records,
needs $env{'form.upfile'} and $env{'form.upfiletype'}
=cut
sub upfile_record_sep {
if ($env{'form.upfiletype'} eq 'xml') {
} else {
my @records;
foreach my $line (split(/\n/,$env{'form.upfile'})) {
if ($line=~/^\s*$/) { next; }
push(@records,$line);
}
return @records;
}
}
=pod
=item * &record_sep($record)
Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
=cut
sub takeleft {
my $index=shift;
return substr('0000'.$index,-4,4);
}
sub record_sep {
my $record=shift;
my %components=();
if ($env{'form.upfiletype'} eq 'xml') {
} elsif ($env{'form.upfiletype'} eq 'space') {
my $i=0;
foreach my $field (split(/\s+/,$record)) {
$field=~s/^(\"|\')//;
$field=~s/(\"|\')$//;
$components{&takeleft($i)}=$field;
$i++;
}
} elsif ($env{'form.upfiletype'} eq 'tab') {
my $i=0;
foreach my $field (split(/\t/,$record)) {
$field=~s/^(\"|\')//;
$field=~s/(\"|\')$//;
$components{&takeleft($i)}=$field;
$i++;
}
} else {
my $separator=',';
if ($env{'form.upfiletype'} eq 'semisv') {
$separator=';';
}
my $i=0;
# the character we are looking for to indicate the end of a quote or a record
my $looking_for=$separator;
# do not add the characters to the fields
my $ignore=0;
# we just encountered a separator (or the beginning of the record)
my $just_found_separator=1;
# store the field we are working on here
my $field='';
# work our way through all characters in record
foreach my $character ($record=~/(.)/g) {
if ($character eq $looking_for) {
if ($character ne $separator) {
# Found the end of a quote, again looking for separator
$looking_for=$separator;
$ignore=1;
} else {
# Found a separator, store away what we got
$components{&takeleft($i)}=$field;
$i++;
$just_found_separator=1;
$ignore=0;
$field='';
}
next;
}
# single or double quotation marks after a separator indicate beginning of a quote
# we are now looking for the end of the quote and need to ignore separators
if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
$looking_for=$character;
next;
}
# ignore would be true after we reached the end of a quote
if ($ignore) { next; }
if (($just_found_separator) && ($character=~/\s/)) { next; }
$field.=$character;
$just_found_separator=0;
}
# catch the very last entry, since we never encountered the separator
$components{&takeleft($i)}=$field;
}
return %components;
}
######################################################
######################################################
=pod
=item * &upfile_select_html()
Return HTML code to select a file from the users machine and specify
the file type.
=cut
######################################################
######################################################
sub upfile_select_html {
my %Types = (
csv => &mt('CSV (comma separated values, spreadsheet)'),
semisv => &mt('Semicolon separated values'),
space => &mt('Space separated'),
tab => &mt('Tabulator separated'),
# xml => &mt('HTML/XML'),
);
my $Str = ''.
' '.&mt('Type').': \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,5);
$r->print(&mt('Samples').' '.&start_data_table().
&start_data_table_header_row());
foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
$r->print('
'.&mt('Column [_1]',($sample+1)).'
'); }
$r->print(&end_data_table_header_row());
foreach my $hash (@$samples) {
$r->print(&start_data_table_row());
foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
$r->print('
');
if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
$r->print('
');
}
$r->print(&end_data_table_row());
}
$r->print(&end_data_table().' '."\n");
}
######################################################
######################################################
=pod
=item * &csv_print_select_table($r,$records,$d)
Prints a table to create associations between values and table columns.
$r is an Apache Request ref,
$records is an arrayref from &Apache::loncommon::upfile_record_sep,
$d is an array of 2 element arrays (internal name, displayed name,defaultcol)
=cut
######################################################
######################################################
sub csv_print_select_table {
my ($r,$records,$d) = @_;
my $i=0;
my $samples = &get_samples($records,1);
$r->print(&mt('Associate columns with student attributes.')."\n".
&start_data_table().&start_data_table_header_row().
'
'.&mt('Attribute').'
'.
'
'.&mt('Column').'
'.
&end_data_table_header_row()."\n");
foreach my $array_ref (@$d) {
my ($value,$display,$defaultcol)=@{ $array_ref };
$r->print(&start_data_table_row().'
'.$display.'
');
$r->print('
'.&end_data_table_row()."\n");
$i++;
}
$r->print(&end_data_table());
$i--;
return $i;
}
######################################################
######################################################
=pod
=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.
$r is an Apache Request ref,
$records is an arrayref from &Apache::loncommon::upfile_record_sep,
$d is an array of 2 element arrays (internal name, displayed name)
=cut
######################################################
######################################################
sub csv_samples_select_table {
my ($r,$records,$d) = @_;
my $i=0;
#
my $max_samples = 5;
my $samples = &get_samples($records,$max_samples);
$r->print(&start_data_table().
&start_data_table_header_row().'
'.
&mt('Field').'
'.&mt('Samples').'
'.
&end_data_table_header_row());
foreach my $key (sort(keys(%{ $samples->[0] }))) {
$r->print(&start_data_table_row().'
');
foreach my $line (0..($max_samples-1)) {
if (defined($samples->[$line]{$key})) {
$r->print($samples->[$line]{$key}." \n");
}
}
$r->print('
'.&end_data_table_row());
$i++;
}
$r->print(&end_data_table());
$i--;
return($i);
}
######################################################
######################################################
=pod
=item * &clean_excel_name($name)
Returns a replacement for $name which does not contain any illegal characters.
=cut
######################################################
######################################################
sub clean_excel_name {
my ($name) = @_;
$name =~ s/[:\*\?\/\\]//g;
if (length($name) > 31) {
$name = substr($name,0,31);
}
return $name;
}
=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.hiddenparts',
$symb,$udom,$uname);
my $truth=1;
#if the string starts with !, then the list is the list to show not hide
if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
my @hiddenlist=split(/,/,$hiddenparts);
foreach my $checkid (@hiddenlist) {
if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
}
return !$truth;
}
############################################################
############################################################
=pod
=back
=head1 cgi-bin script and graphing routines
=over 4
=item * &get_cgi_id()
Inputs: none
Returns an id which can be used to pass environment variables
to various cgi-bin scripts. These environment variables will
be removed from the users environment after a given time by
the routine &Apache::lonnet::transfer_profile_to_env.
=cut
############################################################
############################################################
my $uniq=0;
sub get_cgi_id {
$uniq=($uniq+1)%100000;
return (time.'_'.$$.'_'.$uniq);
}
############################################################
############################################################
=pod
=item * &DrawBarGraph()
Facilitates the plotting of data in a (stacked) bar graph.
Puts plot definition data into the users environment in order for
graph.png to plot it. Returns an tag for the plot.
The bars on the plot are labeled '1','2',...,'n'.
Inputs:
=over 4
=item $Title: string, the title of the plot
=item $xlabel: string, text describing the X-axis of the plot
=item $ylabel: string, text describing the Y-axis of the plot
=item $Max: scalar, the maximum Y value to use in the plot
If $Max is < any data point, the graph will not be rendered.
=item $colors: array ref holding the colors to be used for the data sets when
they are plotted. If undefined, default values will be used.
=item $labels: array ref holding the labels to use on the x-axis for the bars.
=item @Values: An array of array references. Each array reference holds data
to be plotted in a stacked bar chart.
=item If the final element of @Values is a hash reference the key/value
pairs will be added to the graph definition.
=back
Returns:
An tag which references graph.png and the appropriate identifying
information for the plot.
=cut
############################################################
############################################################
sub DrawBarGraph {
my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
#
if (! defined($colors)) {
$colors = ['#33ff00',
'#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
'#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
];
}
my $extra_settings = {};
if (ref($Values[-1]) eq 'HASH') {
$extra_settings = pop(@Values);
}
#
my $identifier = &get_cgi_id();
my $id = 'cgi.'.$identifier;
if (! @Values || ref($Values[0]) ne 'ARRAY') {
return '';
}
#
my @Labels;
if (defined($labels)) {
@Labels = @$labels;
} else {
for (my $i=0;$i<@{$Values[0]};$i++) {
push(@Labels,$i+1);
}
}
#
my $NumBars = scalar(@{$Values[0]});
if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
my %ValuesHash;
my $NumSets=1;
foreach my $array (@Values) {
next if (! ref($array));
$ValuesHash{$id.'.data.'.$NumSets++} =
join(',',@$array);
}
#
my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
if ($NumBars < 3) {
$width = 120+$NumBars*32;
$xskip = 1;
$bar_width = 30;
} elsif ($NumBars < 5) {
$width = 120+$NumBars*20;
$xskip = 1;
$bar_width = 20;
} elsif ($NumBars < 10) {
$width = 120+$NumBars*15;
$xskip = 1;
$bar_width = 15;
} elsif ($NumBars <= 25) {
$width = 120+$NumBars*11;
$xskip = 5;
$bar_width = 8;
} elsif ($NumBars <= 50) {
$width = 120+$NumBars*8;
$xskip = 5;
$bar_width = 4;
} else {
$width = 120+$NumBars*8;
$xskip = 5;
$bar_width = 4;
}
#
$Max = 1 if ($Max < 1);
if ( int($Max) < $Max ) {
$Max++;
$Max = int($Max);
}
$Title = '' if (! defined($Title));
$xlabel = '' if (! defined($xlabel));
$ylabel = '' if (! defined($ylabel));
$ValuesHash{$id.'.title'} = &escape($Title);
$ValuesHash{$id.'.xlabel'} = &escape($xlabel);
$ValuesHash{$id.'.ylabel'} = &escape($ylabel);
$ValuesHash{$id.'.y_max_value'} = $Max;
$ValuesHash{$id.'.NumBars'} = $NumBars;
$ValuesHash{$id.'.NumSets'} = $NumSets;
$ValuesHash{$id.'.PlotType'} = 'bar';
$ValuesHash{$id.'.Colors'} = join(',',@{$colors});
$ValuesHash{$id.'.height'} = $height;
$ValuesHash{$id.'.width'} = $width;
$ValuesHash{$id.'.xskip'} = $xskip;
$ValuesHash{$id.'.bar_width'} = $bar_width;
$ValuesHash{$id.'.labels'} = join(',',@Labels);
#
# Deal with other parameters
while (my ($key,$value) = each(%$extra_settings)) {
$ValuesHash{$id.'.'.$key} = $value;
}
#
&Apache::lonnet::appenv(\%ValuesHash);
return '';
}
############################################################
############################################################
=pod
=item * &DrawXYGraph()
Facilitates the plotting of data in an XY graph.
Puts plot definition data into the users environment in order for
graph.png to plot it. Returns an tag for the plot.
Inputs:
=over 4
=item $Title: string, the title of the plot
=item $xlabel: string, text describing the X-axis of the plot
=item $ylabel: string, text describing the Y-axis of the plot
=item $Max: scalar, the maximum Y value to use in the plot
If $Max is < any data point, the graph will not be rendered.
=item $colors: Array ref containing the hex color codes for the data to be
plotted in. If undefined, default values will be used.
=item $Xlabels: Array ref containing the labels to be used for the X-axis.
=item $Ydata: Array ref containing Array refs.
Each of the contained arrays will be plotted as a separate curve.
=item %Values: hash indicating or overriding any default values which are
passed to graph.png.
Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
=back
Returns:
An tag which references graph.png and the appropriate identifying
information for the plot.
=cut
############################################################
############################################################
sub DrawXYGraph {
my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
#
# Create the identifier for the graph
my $identifier = &get_cgi_id();
my $id = 'cgi.'.$identifier;
#
$Title = '' if (! defined($Title));
$xlabel = '' if (! defined($xlabel));
$ylabel = '' if (! defined($ylabel));
my %ValuesHash =
(
$id.'.title' => &escape($Title),
$id.'.xlabel' => &escape($xlabel),
$id.'.ylabel' => &escape($ylabel),
$id.'.y_max_value'=> $Max,
$id.'.labels' => join(',',@$Xlabels),
$id.'.PlotType' => 'XY',
);
#
if (defined($colors) && ref($colors) eq 'ARRAY') {
$ValuesHash{$id.'.Colors'} = join(',',@{$colors});
}
#
if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
return '';
}
my $NumSets=1;
foreach my $array (@{$Ydata}){
next if (! ref($array));
$ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
}
$ValuesHash{$id.'.NumSets'} = $NumSets-1;
#
# Deal with other parameters
while (my ($key,$value) = each(%Values)) {
$ValuesHash{$id.'.'.$key} = $value;
}
#
&Apache::lonnet::appenv(\%ValuesHash);
return '';
}
############################################################
############################################################
=pod
=item * &DrawXYYGraph()
Facilitates the plotting of data in an XY graph with two Y axes.
Puts plot definition data into the users environment in order for
graph.png to plot it. Returns an tag for the plot.
Inputs:
=over 4
=item $Title: string, the title of the plot
=item $xlabel: string, text describing the X-axis of the plot
=item $ylabel: string, text describing the Y-axis of the plot
=item $colors: Array ref containing the hex color codes for the data to be
plotted in. If undefined, default values will be used.
=item $Xlabels: Array ref containing the labels to be used for the X-axis.
=item $Ydata1: The first data set
=item $Min1: The minimum value of the left Y-axis
=item $Max1: The maximum value of the left Y-axis
=item $Ydata2: The second data set
=item $Min2: The minimum value of the right Y-axis
=item $Max2: The maximum value of the left Y-axis
=item %Values: hash indicating or overriding any default values which are
passed to graph.png.
Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
=back
Returns:
An tag which references graph.png and the appropriate identifying
information for the plot.
=cut
############################################################
############################################################
sub DrawXYYGraph {
my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
$Ydata2,$Min2,$Max2,%Values)=@_;
#
# Create the identifier for the graph
my $identifier = &get_cgi_id();
my $id = 'cgi.'.$identifier;
#
$Title = '' if (! defined($Title));
$xlabel = '' if (! defined($xlabel));
$ylabel = '' if (! defined($ylabel));
my %ValuesHash =
(
$id.'.title' => &escape($Title),
$id.'.xlabel' => &escape($xlabel),
$id.'.ylabel' => &escape($ylabel),
$id.'.labels' => join(',',@$Xlabels),
$id.'.PlotType' => 'XY',
$id.'.NumSets' => 2,
$id.'.two_axes' => 1,
$id.'.y1_max_value' => $Max1,
$id.'.y1_min_value' => $Min1,
$id.'.y2_max_value' => $Max2,
$id.'.y2_min_value' => $Min2,
);
#
if (defined($colors) && ref($colors) eq 'ARRAY') {
$ValuesHash{$id.'.Colors'} = join(',',@{$colors});
}
#
if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
return '';
}
my $NumSets=1;
foreach my $array ($Ydata1,$Ydata2){
next if (! ref($array));
$ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
}
#
# Deal with other parameters
while (my ($key,$value) = each(%Values)) {
$ValuesHash{$id.'.'.$key} = $value;
}
#
&Apache::lonnet::appenv(\%ValuesHash);
return '';
}
############################################################
############################################################
=pod
=back
=head1 Statistics helper routines?
Bad place for them but what the hell.
=over 4
=item * &chartlink()
Returns a link to the chart for a specific student.
Inputs:
=over 4
=item $linktext: The text of the link
=item $sname: The students username
=item $sdomain: The students domain
=back
=back
=cut
############################################################
############################################################
sub chartlink {
my ($linktext, $sname, $sdomain) = @_;
my $link = ''.$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
=back
=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})
];
}
}
}
}
#######################################################
#######################################################
=pod
=head1 Domain E-mail Routines
=over 4
=item * &build_recipient_list()
Build recipient lists for following types of e-mail:
(a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
(d) Help requests, (e) Course requests needing approval, (f) loncapa
module change checking, student/employee ID conflict checks, as
generated by lonerrorhandler.pm, CHECKRPMS, loncron,
lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
Inputs:
defmail (scalar - email address of default recipient),
mailing type (scalar: errormail, packagesmail, helpdeskmail,
requestsmail, updatesmail, or idconflictsmail).
defdom (domain for which to retrieve configuration settings),
origmail (scalar - email address of recipient from loncapa.conf,
i.e., predates configuration by DC via domainprefs.pm
$requname username of requester (if mailing type is helpdeskmail)
$requdom domain of requester (if mailing type is helpdeskmail)
$reqemail e-mail address of requester (if mailing type is helpdeskmail)
Returns: comma separated list of addresses to which to send e-mail.
=back
=cut
############################################################
############################################################
sub build_recipient_list {
my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
my @recipients;
my ($otheremails,$lastresort,$allbcc,$addtext);
my %domconfig =
&Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
if (ref($domconfig{'contacts'}) eq 'HASH') {
if (exists($domconfig{'contacts'}{$mailing})) {
if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
my @contacts = ('adminemail','supportemail');
foreach my $item (@contacts) {
if ($domconfig{'contacts'}{$mailing}{$item}) {
my $addr = $domconfig{'contacts'}{$item};
if (!grep(/^\Q$addr\E$/,@recipients)) {
push(@recipients,$addr);
}
}
}
$otheremails = $domconfig{'contacts'}{$mailing}{'others'};
if ($mailing eq 'helpdeskmail') {
if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
my @ok_bccs;
foreach my $bcc (@bccs) {
$bcc =~ s/^\s+//g;
$bcc =~ s/\s+$//g;
if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
push(@ok_bccs,$bcc);
}
}
}
if (@ok_bccs > 0) {
$allbcc = join(', ',@ok_bccs);
}
}
$addtext = $domconfig{'contacts'}{$mailing}{'include'};
}
}
} elsif ($origmail ne '') {
$lastresort = $origmail;
}
if ($mailing eq 'helpdeskmail') {
if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
(keys(%{$domconfig{'contacts'}{'overrides'}}))) {
my ($inststatus,$inststatus_checked);
if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
($env{'user.domain'} ne 'public')) {
$inststatus_checked = 1;
$inststatus = $env{'environment.inststatus'};
}
unless ($inststatus_checked) {
if (($requname ne '') && ($requdom ne '')) {
if (($requname =~ /^$match_username$/) &&
($requdom =~ /^$match_domain$/) &&
(&Apache::lonnet::domain($requdom))) {
my $requhome = &Apache::lonnet::homeserver($requname,
$requdom);
unless ($requhome eq 'no_host') {
my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
$inststatus = $userenv{'inststatus'};
$inststatus_checked = 1;
}
}
}
}
unless ($inststatus_checked) {
if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
my %srch = (srchby => 'email',
srchdomain => $defdom,
srchterm => $reqemail,
srchtype => 'exact');
my %srch_results = &Apache::lonnet::usersearch(\%srch);
foreach my $uname (keys(%srch_results)) {
if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
$inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
$inststatus_checked = 1;
last;
}
}
unless ($inststatus_checked) {
my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
if ($dirsrchres eq 'ok') {
foreach my $uname (keys(%srch_results)) {
if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
$inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
$inststatus_checked = 1;
last;
}
}
}
}
}
}
if ($inststatus ne '') {
foreach my $status (split(/\:/,$inststatus)) {
if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
my @contacts = ('adminemail','supportemail');
foreach my $item (@contacts) {
if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
my $addr = $domconfig{'contacts'}{'overrides'}{$status};
if (!grep(/^\Q$addr\E$/,@recipients)) {
push(@recipients,$addr);
}
}
}
$otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
my @ok_bccs;
foreach my $bcc (@bccs) {
$bcc =~ s/^\s+//g;
$bcc =~ s/\s+$//g;
if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
push(@ok_bccs,$bcc);
}
}
}
if (@ok_bccs > 0) {
$allbcc = join(', ',@ok_bccs);
}
}
$addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
last;
}
}
}
}
}
} elsif ($origmail ne '') {
$lastresort = $origmail;
}
if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
my %what = (
perlvar => 1,
);
my $primary = &Apache::lonnet::domain($defdom,'primary');
if ($primary) {
my $gotaddr;
my ($result,$returnhash) =
&Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
$lastresort = $returnhash->{'lonSupportEMail'};
$gotaddr = 1;
}
}
unless ($gotaddr) {
my $uintdom = &Apache::lonnet::internet_dom($primary);
my $intdom = &Apache::lonnet::internet_dom($lonhost);
unless ($uintdom eq $intdom) {
my %domconfig =
&Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
if (ref($domconfig{'contacts'}) eq 'HASH') {
if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
my @contacts = ('adminemail','supportemail');
foreach my $item (@contacts) {
if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
my $addr = $domconfig{'contacts'}{$item};
if (!grep(/^\Q$addr\E$/,@recipients)) {
push(@recipients,$addr);
}
}
}
if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
$otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
}
if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
my @ok_bccs;
foreach my $bcc (@bccs) {
$bcc =~ s/^\s+//g;
$bcc =~ s/\s+$//g;
if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
push(@ok_bccs,$bcc);
}
}
}
if (@ok_bccs > 0) {
$allbcc = join(', ',@ok_bccs);
}
}
$addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
}
}
}
}
}
}
}
if (defined($defmail)) {
if ($defmail ne '') {
push(@recipients,$defmail);
}
}
if ($otheremails) {
my @others;
if ($otheremails =~ /,/) {
@others = split(/,/,$otheremails);
} else {
push(@others,$otheremails);
}
foreach my $addr (@others) {
if (!grep(/^\Q$addr\E$/,@recipients)) {
push(@recipients,$addr);
}
}
}
if ($mailing eq 'helpdeskmail') {
if ((!@recipients) && ($lastresort ne '')) {
push(@recipients,$lastresort);
}
} elsif ($lastresort ne '') {
if (!grep(/^\Q$lastresort\E$/,@recipients)) {
push(@recipients,$lastresort);
}
}
my $recipientlist = join(',',@recipients);
if (wantarray) {
return ($recipientlist,$allbcc,$addtext);
} else {
return $recipientlist;
}
}
############################################################
############################################################
=pod
=head1 Course Catalog Routines
=over 4
=item * &gather_categories()
Converts category definitions - keys of categories hash stored in
coursecategories in configuration.db on the primary library server in a
domain - to an array. Also generates javascript and idx hash used to
generate Domain Coordinator interface for editing Course Categories.
Inputs:
categories (reference to hash of category definitions).
cats (reference to array of arrays/hashes which encapsulates hierarchy of
categories and subcategories).
idx (reference to hash of counters used in Domain Coordinator interface for
editing Course Categories).
jsarray (reference to array of categories used to create Javascript arrays for
Domain Coordinator interface for editing Course Categories).
Returns: nothing
Side effects: populates cats, idx and jsarray.
=cut
sub gather_categories {
my ($categories,$cats,$idx,$jsarray) = @_;
my %counters;
my $num = 0;
foreach my $item (keys(%{$categories})) {
my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
if ($container eq '' && $depth == 0) {
$cats->[$depth][$categories->{$item}] = $cat;
} else {
$cats->[$depth]{$container}[$categories->{$item}] = $cat;
}
my ($escitem,$tail) = split(/:/,$item,2);
if ($counters{$tail} eq '') {
$counters{$tail} = $num;
$num ++;
}
if (ref($idx) eq 'HASH') {
$idx->{$item} = $counters{$tail};
}
if (ref($jsarray) eq 'ARRAY') {
push(@{$jsarray->[$counters{$tail}]},$item);
}
}
return;
}
=pod
=item * &extract_categories()
Used to generate breadcrumb trails for course categories.
Inputs:
categories (reference to hash of category definitions).
cats (reference to array of arrays/hashes which encapsulates hierarchy of
categories and subcategories).
trails (reference to array of breacrumb trails for each category).
allitems (reference to hash - key is category key
(format: escaped(name):escaped(parent category):depth in hierarchy).
idx (reference to hash of counters used in Domain Coordinator interface for
editing Course Categories).
jsarray (reference to array of categories used to create Javascript arrays for
Domain Coordinator interface for editing Course Categories).
subcats (reference to hash of arrays containing all subcategories within each
category, -recursive)
maxd (reference to hash used to hold max depth for all top-level categories).
Returns: nothing
Side effects: populates trails and allitems hash references.
=cut
sub extract_categories {
my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
if (ref($categories) eq 'HASH') {
&gather_categories($categories,$cats,$idx,$jsarray);
if (ref($cats->[0]) eq 'ARRAY') {
for (my $i=0; $i<@{$cats->[0]}; $i++) {
my $name = $cats->[0][$i];
my $item = &escape($name).'::0';
my $trailstr;
if ($name eq 'instcode') {
$trailstr = &mt('Official courses (with institutional codes)');
} elsif ($name eq 'communities') {
$trailstr = &mt('Communities');
} else {
$trailstr = $name;
}
if ($allitems->{$item} eq '') {
push(@{$trails},$trailstr);
$allitems->{$item} = scalar(@{$trails})-1;
}
my @parents = ($name);
if (ref($cats->[1]{$name}) eq 'ARRAY') {
for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
my $category = $cats->[1]{$name}[$j];
if (ref($subcats) eq 'HASH') {
push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
}
&recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
}
} else {
if (ref($subcats) eq 'HASH') {
$subcats->{$item} = [];
}
if (ref($maxd) eq 'HASH') {
$maxd->{$name} = 1;
}
}
}
}
}
return;
}
=pod
=item * &recurse_categories()
Recursively used to generate breadcrumb trails for course categories.
Inputs:
cats (reference to array of arrays/hashes which encapsulates hierarchy of
categories and subcategories).
depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
category (current course category, for which breadcrumb trail is being generated).
trails (reference to array of breadcrumb trails for each category).
allitems (reference to hash - key is category key
(format: escaped(name):escaped(parent category):depth in hierarchy).
parents (array containing containers directories for current category,
back to top level).
Returns: nothing
Side effects: populates trails and allitems hash references
=cut
sub recurse_categories {
my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
my $shallower = $depth - 1;
if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
my $name = $cats->[$depth]{$category}[$k];
my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
my $trailstr = join(' » ',(@{$parents},$category));
if ($allitems->{$item} eq '') {
push(@{$trails},$trailstr);
$allitems->{$item} = scalar(@{$trails})-1;
}
my $deeper = $depth+1;
push(@{$parents},$category);
if (ref($subcats) eq 'HASH') {
my $subcat = &escape($name).':'.$category.':'.$depth;
for (my $j=@{$parents}; $j>=0; $j--) {
my $higher;
if ($j > 0) {
$higher = &escape($parents->[$j]).':'.
&escape($parents->[$j-1]).':'.$j;
} else {
$higher = &escape($parents->[$j]).'::'.$j;
}
push(@{$subcats->{$higher}},$subcat);
}
}
&recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
$subcats,$maxd);
pop(@{$parents});
}
} else {
my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
my $trailstr = join(' » ',(@{$parents},$category));
if ($allitems->{$item} eq '') {
push(@{$trails},$trailstr);
$allitems->{$item} = scalar(@{$trails})-1;
}
if (ref($maxd) eq 'HASH') {
if ($depth > $maxd->{$parents->[0]}) {
$maxd->{$parents->[0]} = $depth;
}
}
}
return;
}
=pod
=item * &assign_categories_table()
Create a datatable for display of hierarchical categories in a domain,
with checkboxes to allow a course to be categorized.
Inputs:
cathash - reference to hash of categories defined for the domain (from
configuration.db)
currcat - scalar with an & separated list of categories assigned to a course.
type - scalar contains course type (Course or Community).
disabled - scalar (optional) contains disabled="disabled" if input elements are
to be readonly (e.g., Domain Helpdesk role viewing course settings).
Returns: $output (markup to be displayed)
=cut
sub assign_categories_table {
my ($cathash,$currcat,$type,$disabled) = @_;
my $output;
if (ref($cathash) eq 'HASH') {
my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
&extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
$maxdepth = scalar(@cats);
if (@cats > 0) {
my $itemcount = 0;
if (ref($cats[0]) eq 'ARRAY') {
my @currcategories;
if ($currcat ne '') {
@currcategories = split('&',$currcat);
}
my $table;
for (my $i=0; $i<@{$cats[0]}; $i++) {
my $parent = $cats[0][$i];
next if ($parent eq 'instcode');
if ($type eq 'Community') {
next unless ($parent eq 'communities');
} else {
next if ($parent eq 'communities');
}
my $css_class = $itemcount%2?' class="LC_odd_row"':'';
my $item = &escape($parent).'::0';
my $checked = '';
if (@currcategories > 0) {
if (grep(/^\Q$item\E$/,@currcategories)) {
$checked = ' checked="checked"';
}
}
my $parent_title = $parent;
if ($parent eq 'communities') {
$parent_title = &mt('Communities');
}
$table .= '
';
$itemcount ++;
}
if ($itemcount) {
$output = &Apache::loncommon::start_data_table().
$table.
&Apache::loncommon::end_data_table();
}
}
}
}
return $output;
}
=pod
=item * &assign_category_rows()
Create a datatable row for display of nested categories in a domain,
with checkboxes to allow a course to be categorized,called recursively.
Inputs:
itemcount - track row number for alternating colors
cats - reference to array of arrays/hashes which encapsulates hierarchy of
categories and subcategories.
depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
parent - parent of current category item
path - Array containing all categories back up through the hierarchy from the
current category to the top level.
currcategories - reference to array of current categories assigned to the course
disabled - scalar (optional) contains disabled="disabled" if input elements are
to be readonly (e.g., Domain Helpdesk role viewing course settings).
Returns: $output (markup to be displayed).
=cut
sub assign_category_rows {
my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
my ($text,$name,$item,$chgstr);
if (ref($cats) eq 'ARRAY') {
my $maxdepth = scalar(@{$cats});
if (ref($cats->[$depth]) eq 'HASH') {
if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
my $numchildren = @{$cats->[$depth]{$parent}};
my $css_class = $itemcount%2?' class="LC_odd_row"':'';
$text .= '
';
for (my $j=0; $j<$numchildren; $j++) {
$name = $cats->[$depth]{$parent}[$j];
$item = &escape($name).':'.&escape($parent).':'.$depth;
my $deeper = $depth+1;
my $checked = '';
if (ref($currcategories) eq 'ARRAY') {
if (@{$currcategories} > 0) {
if (grep(/^\Q$item\E$/,@{$currcategories})) {
$checked = ' checked="checked"';
}
}
}
$text .= '
';
}
}
}
return $text;
}
=pod
=back
=cut
############################################################
############################################################
sub commit_customrole {
my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
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,undef,undef,$context).
' ';
return $output;
}
sub commit_standardrole {
my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits) = @_;
my ($output,$logmsg,$linefeed);
if ($context eq 'auto') {
$linefeed = "\n";
} else {
$linefeed = " \n";
}
if ($three eq 'st') {
my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
$one,$two,$sec,$context,$credits);
if (($result =~ /^error/) || ($result eq 'not_in_class') ||
($result eq 'unknown_course') || ($result eq 'refused')) {
$output = $logmsg.' '.&mt('Error: ').$result."\n";
} else {
$output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
($start?', '.&mt('starting').' '.localtime($start):'').
($end?', '.&mt('ending').' '.localtime($end):'').': ';
if ($context eq 'auto') {
$output .= $result.$linefeed.&mt('Add to classlist').': ok';
} else {
$output .= ''.$result.''.$linefeed.
&mt('Add to classlist').': ok';
}
$output .= $linefeed;
}
} else {
$output = &mt('Assigning').' '.$three.' in '.$url.
($start?', '.&mt('starting').' '.localtime($start):'').
($end?', '.&mt('ending').' '.localtime($end):'').': ';
my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
if ($context eq 'auto') {
$output .= $result.$linefeed;
} else {
$output .= ''.$result.''.$linefeed;
}
}
return $output;
}
sub commit_studentrole {
my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
$credits) = @_;
my ($result,$linefeed,$oldsecurl,$newsecurl);
if ($context eq 'auto') {
$linefeed = "\n";
} else {
$linefeed = ' '."\n";
}
if (defined($one) && defined($two)) {
my $cid=$one.'_'.$two;
my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
my $secchange = 0;
my $expire_role_result;
my $modify_section_result;
if ($oldsec ne '-1') {
if ($oldsec ne $sec) {
$secchange = 1;
my $now = time;
my $uurl='/'.$cid;
$uurl=~s/\_/\//g;
if ($oldsec) {
$uurl.='/'.$oldsec;
}
$oldsecurl = $uurl;
$expire_role_result =
&Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,
'','','',$context);
if ($env{'request.course.sec'} ne '') {
if ($expire_role_result eq 'refused') {
my @roles = ('st');
my @statuses = ('previous');
my @roledoms = ($one);
my $withsec = 1;
my %roleshash =
&Apache::lonnet::get_my_roles($uname,$udom,'userroles',
\@statuses,\@roles,\@roledoms,$withsec);
if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
my ($oldstart,$oldend) =
split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
if ($oldend > 0 && $oldend <= $now) {
$expire_role_result = 'ok';
}
}
}
}
$result = $expire_role_result;
}
}
if (($expire_role_result eq 'ok') || ($secchange == 0)) {
$modify_section_result =
&Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
undef,undef,undef,$sec,
$end,$start,'','',$cid,
'',$context,$credits);
if ($modify_section_result =~ /^ok/) {
if ($secchange == 1) {
if ($sec eq '') {
$$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
} else {
$$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
}
} elsif ($oldsec eq '-1') {
if ($sec eq '') {
$$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
} else {
$$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
}
} else {
if ($sec eq '') {
$$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
} else {
$$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
}
}
} else {
if ($secchange) {
$$logmsg .= &mt('Error when attempting section change for [_1] from old section "[_2]" to new section: "[_3]" in course [_4] -error:',$uname,$oldsec,$sec,$cid).' '.$modify_section_result.$linefeed;
} else {
$$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
}
}
$result = $modify_section_result;
} elsif ($secchange == 1) {
if ($oldsec eq '') {
$$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_2] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
} else {
$$logmsg .= &mt('Error when attempting to expire existing role for [_1] in section [_2] in course [_3] -error: ',$uname,$oldsec,$cid).' '.$expire_role_result.$linefeed;
}
if ($expire_role_result eq 'refused') {
my $newsecurl = '/'.$cid;
$newsecurl =~ s/\_/\//g;
if ($sec ne '') {
$newsecurl.='/'.$sec;
}
if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
if ($sec eq '') {
$$logmsg .= &mt('Although your current role has privileges to add students to section "[_1]", you do not have privileges to modify existing enrollments unaffiliated with any section.',$sec).$linefeed;
} else {
$$logmsg .= &mt('Although your current role has privileges to add students to section "[_1]", you do not have privileges to modify existing enrollments in other sections.',$sec).$linefeed;
}
}
}
}
} else {
$$logmsg .= &mt('Incomplete course id defined.').$linefeed.&mt('Addition of user [_1] from domain [_2] to course [_3], section [_4] not completed.',$uname,$udom,$one.'_'.$two,$sec).$linefeed;
$result = "error: incomplete course id\n";
}
return $result;
}
sub show_role_extent {
my ($scope,$context,$role) = @_;
$scope =~ s{^/}{};
my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
push(@courseroles,'co');
my @authorroles = &Apache::lonuserutils::roles_by_context('author');
if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
$scope =~ s{/}{_};
return ''.$env{'course.'.$scope.'.description'}.'';
} elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
my ($audom,$auname) = split(/\//,$scope);
return &mt('[_1] Author Space',''.
&Apache::loncommon::plainname($auname,$audom).'');
} else {
$scope =~ s{/$}{};
return &mt('Domain: [_1]',''.
&Apache::lonnet::domain($scope,'description').'');
}
}
############################################################
############################################################
sub check_clone {
my ($args,$linefeed) = @_;
my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
my $clonemsg;
my $can_clone = 0;
my $lctype = lc($args->{'crstype'});
if ($lctype ne 'community') {
$lctype = 'course';
}
if ($clonehome eq 'no_host') {
if ($args->{'crstype'} eq 'Community') {
$clonemsg = &mt('No new community created.').$linefeed.&mt('A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
} else {
$clonemsg = &mt('No new course created.').$linefeed.&mt('A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
}
} else {
my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
if ($args->{'crstype'} eq 'Community') {
if ($clonedesc{'type'} ne 'Community') {
$clonemsg = &mt('No new community created.').$linefeed.&mt('A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
return ($can_clone, $clonemsg, $cloneid, $clonehome);
}
}
if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
(&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
$can_clone = 1;
} else {
my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
$args->{'clonedomain'},$args->{'clonecourse'});
if ($clonehash{'cloners'} eq '') {
my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
if ($domdefs{'canclone'}) {
unless ($domdefs{'canclone'} eq 'none') {
if ($domdefs{'canclone'} eq 'domain') {
if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
$can_clone = 1;
}
} elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
($args->{'clonedomain'} eq $args->{'course_domain'})) {
if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
$clonehash{'internal.coursecode'},$args->{'crscode'})) {
$can_clone = 1;
}
}
}
}
} else {
my @cloners = split(/,/,$clonehash{'cloners'});
if (grep(/^\*$/,@cloners)) {
$can_clone = 1;
} elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
$can_clone = 1;
} elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
$can_clone = 1;
}
unless ($can_clone) {
if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
($args->{'clonedomain'} eq $args->{'course_domain'})) {
my (%gotdomdefaults,%gotcodedefaults);
foreach my $cloner (@cloners) {
if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
my (%codedefaults,@code_order);
if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
%codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
}
if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
@code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
}
} else {
&Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
\%codedefaults,
\@code_order);
$gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
$gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
}
if (@code_order > 0) {
if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
$cloner,$clonehash{'internal.coursecode'},
$args->{'crscode'})) {
$can_clone = 1;
last;
}
}
}
}
}
}
}
unless ($can_clone) {
my $ccrole = 'cc';
if ($args->{'crstype'} eq 'Community') {
$ccrole = 'co';
}
my %roleshash =
&Apache::lonnet::get_my_roles($args->{'ccuname'},
$args->{'ccdomain'},
'userroles',['active'],[$ccrole],
[$args->{'clonedomain'}]);
if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
$can_clone = 1;
} elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
$args->{'ccuname'},$args->{'ccdomain'})) {
$can_clone = 1;
}
}
unless ($can_clone) {
if ($args->{'crstype'} eq 'Community') {
$clonemsg = &mt('No new community created.').$linefeed.&mt('The new community could not be cloned from the existing community because the new community owner ([_1]) does not have cloning rights in the existing community ([_2]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'});
} else {
$clonemsg = &mt('No new course created.').$linefeed.&mt('The new course could not be cloned from the existing course because the new course owner ([_1]) does not have cloning rights in the existing course ([_2]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'});
}
}
}
}
return ($can_clone, $clonemsg, $cloneid, $clonehome);
}
sub construct_course {
my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
$cnum,$category,$coderef) = @_;
my $outcome;
my $linefeed = ' '."\n";
if ($context eq 'auto') {
$linefeed = "\n";
}
#
# Are we cloning?
#
my ($can_clone, $clonemsg, $cloneid, $clonehome);
if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
if ($context ne 'auto') {
if ($clonemsg ne '') {
$clonemsg = ''.$clonemsg.'';
}
}
$outcome .= $clonemsg.$linefeed;
if (!$can_clone) {
return (0,$outcome);
}
}
#
# Open course
#
my $crstype = lc($args->{'crstype'});
my %cenv=();
$$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
$args->{'cdescr'},
$args->{'curl'},
$args->{'course_home'},
$args->{'nonstandard'},
$args->{'crscode'},
$args->{'ccuname'}.':'.
$args->{'ccdomain'},
$args->{'crstype'},
$cnum,$context,$category);
# Note: The testing routines depend on this being output; see
# Utils::Course. This needs to at least be output as a comment
# if anyone ever decides to not show this, and Utils::Course::new
# will need to be suitably modified.
$outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
if ($$courseid =~ /^error:/) {
return (0,$outcome);
}
#
# Check if created correctly
#
($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
if ($crsuhome eq 'no_host') {
$outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
return (0,$outcome);
}
$outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
#
# Do the cloning
#
if ($can_clone && $cloneid) {
$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
if ($context ne 'auto') {
$clonemsg = ''.$clonemsg.'';
}
$outcome .= $clonemsg.$linefeed;
my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
# Copy all files
&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
# Restore URL
$cenv{'url'}=$oldcenv{'url'};
# Restore title
$cenv{'description'}=$oldcenv{'description'};
# Restore creation date, creator and creation context.
$cenv{'internal.created'}=$oldcenv{'internal.created'};
$cenv{'internal.creator'}=$oldcenv{'internal.creator'};
$cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
# Mark as cloned
$cenv{'clonedfrom'}=$cloneid;
# Need to clone grading mode
my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
$cenv{'grading'}=$newenv{'grading'};
# Do not clone these environment entries
&Apache::lonnet::del('environment',
['default_enrollment_start_date',
'default_enrollment_end_date',
'question.email',
'policy.email',
'comment.email',
'pch.users.denied',
'plc.users.denied',
'hidefromcat',
'checkforpriv',
'categories'],
$$crsudom,$$crsunum);
if ($args->{'textbook'}) {
$cenv{'internal.textbook'} = $args->{'textbook'};
}
}
#
# 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'};
}
if ($args->{'defaultcredits'}) {
$cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
}
my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
my @oklcsecs = (); # Used to accumulate LON-CAPA sections for validated institutional sections.
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.',';
if ($addcheck eq 'ok') {
unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
push(@oklcsecs,$gp);
}
} else {
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 course coordinator's domain to domains to check for privileged users
# if different to course domain
if ($$crsudom ne $args->{'ccdomain'}) {
$cenv{'checkforpriv'} = $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.',';
if ($addcheck eq 'ok') {
unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
push(@oklcsecs,$gp);
}
} else {
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.',
'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
);
my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
&mt('That is because the user identified as the course owner ([_1]) does not have rights to access enrollment in these classes, as determined by the policies of your institution on access to official classlists',$cenv{'internal.courseowner'}).$linefeed.$lt{'itis'};
if ($context eq 'auto') {
$outcome .= $badclass_msg.$linefeed;
} else {
$outcome .= '
\n";
}
}
if ($args->{'no_end_date'}) {
$args->{'endaccess'} = 0;
}
# If an official course with institutional sections is created by cloning
# an existing course, section-specific hiding of course totals in student's
# view of grades as copied from cloned course, will be checked for valid
# sections.
if (($can_clone && $cloneid) &&
($cenv{'internal.coursecode'} ne '') &&
($cenv{'grading'} eq 'standard') &&
($cenv{'hidetotals'} ne '') &&
($cenv{'hidetotals'} ne 'all')) {
my @hidesecs;
my $deletehidetotals;
if (@oklcsecs) {
foreach my $sec (split(/,/,$cenv{'hidetotals'})) {
if (grep(/^\Q$sec$/,@oklcsecs)) {
push(@hidesecs,$sec);
}
}
if (@hidesecs) {
$cenv{'hidetotals'} = join(',',@hidesecs);
} else {
$deletehidetotals = 1;
}
} else {
$deletehidetotals = 1;
}
if ($deletehidetotals) {
delete($cenv{'hidetotals'});
&Apache::lonnet::del('environment',['hidetotals'],$$crsudom,$$crsunum);
}
}
$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 '') {
my $krb_msg = &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 ($context eq 'auto') {
$outcome .= $krb_msg;
} else {
$outcome .= ''.$krb_msg.'';
}
$outcome .= $linefeed;
}
}
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->{'setcomment'}) {
$cenv{'comment.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;
}
}
#
# generate and store uniquecode (available to course requester), if course should have one.
#
if ($args->{'uniquecode'}) {
my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
if ($code) {
$cenv{'internal.uniquecode'} = $code;
my %crsinfo =
&Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
$crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
}
if (ref($coderef)) {
$$coderef = $code;
}
}
}
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 .= $linefeed.&mt('Setting environment').': '.
&Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
#
# Open all assignments
#
if ($args->{'openall'}) {
my $opendate = time;
if ($args->{'openallfrom'} =~ /^\d+$/) {
$opendate = $args->{'openallfrom'};
}
my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
my %storecontent = ($storeunder => $opendate,
$storeunder.'.type' => 'date_start');
$outcome .= &mt('All assignments open starting [_1]',
&Apache::lonlocal::locallocaltime($opendate)).': '.
&Apache::lonnet::cput
('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
}
#
# Set first page
#
unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
|| ($cloneid)) {
use LONCAPA::map;
$outcome .= &mt('Setting first resource').': ';
my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
$outcome .= ($fatal?$errtext:'read ok').' - ';
my $title; my $url;
if ($args->{'firstres'} eq 'syl') {
$title=&mt('Syllabus');
$url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
} else {
$title=&mt('Table of Contents');
$url='/adm/navmaps';
}
$LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
if ($errtext) { $fatal=2; }
$outcome .= ($fatal?$errtext:'write ok').$linefeed;
}
return (1,$outcome);
}
sub make_unique_code {
my ($cdom,$cnum) = @_;
# get lock on uniquecodes db
my $lockhash = {
$cnum."\0".'uniquecodes' => $env{'user.name'}.
':'.$env{'user.domain'},
};
my $tries = 0;
my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
my ($code,$error);
while (($gotlock ne 'ok') && ($tries<3)) {
$tries ++;
sleep 1;
$gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
}
if ($gotlock eq 'ok') {
my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
my $gotcode;
my $attempts = 0;
while ((!$gotcode) && ($attempts < 100)) {
$code = &generate_code();
if (!exists($currcodes{$code})) {
$gotcode = 1;
unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
$error = 'nostore';
}
}
$attempts ++;
}
my @del_lock = ($cnum."\0".'uniquecodes');
my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
} else {
$error = 'nolock';
}
return ($code,$error);
}
sub generate_code {
my $code;
my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
for (my $i=0; $i<6; $i++) {
my $lettnum = int (rand 2);
my $item = '';
if ($lettnum) {
$item = $letts[int( rand(18) )];
} else {
$item = 1+int( rand(8) );
}
$code .= $item;
}
return $code;
}
############################################################
############################################################
#SD
# only Community and Course, or anything else?
sub course_type {
my ($cid) = @_;
if (!defined($cid)) {
$cid = $env{'request.course.id'};
}
if (defined($env{'course.'.$cid.'.type'})) {
return $env{'course.'.$cid.'.type'};
} else {
return 'Course';
}
}
sub group_term {
my $crstype = &course_type();
my %names = (
'Course' => 'group',
'Community' => 'group',
);
return $names{$crstype};
}
sub course_types {
my @types = ('official','unofficial','community','textbook');
my %typename = (
official => 'Official course',
unofficial => 'Unofficial course',
community => 'Community',
textbook => 'Textbook course',
);
return (\@types,\%typename);
}
sub icon {
my ($file)=@_;
my $curfext = lc((split(/\./,$file))[-1]);
my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
my $embstyle = &Apache::loncommon::fileembstyle($curfext);
if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
$curfext.".gif") {
$iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
$curfext.".gif";
}
}
return &lonhttpdurl($iconname);
}
sub lonhttpdurl {
#
# Had been used for "small fry" static images on separate port 8080.
# Modify here if lightweight http functionality desired again.
# Currently eliminated due to increasing firewall issues.
#
my ($url)=@_;
return $url;
}
sub connection_aborted {
my ($r)=@_;
$r->print(" ");$r->rflush();
my $c = $r->connection;
return $c->aborted();
}
# Escapes strings that may have embedded 's that will be put into
# strings as 'strings'.
sub escape_single {
my ($input) = @_;
$input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
$input =~ s/\'/\\\'/g; # Esacpe the 's....
return $input;
}
# Same as escape_single, but escape's "'s This
# can be used for "strings"
sub escape_double {
my ($input) = @_;
$input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
$input =~ s/\"/\\\"/g; # Esacpe the "s....
return $input;
}
# Escapes the last element of a full URL.
sub escape_url {
my ($url) = @_;
my @urlslices = split(/\//, $url,-1);
my $lastitem = &escape(pop(@urlslices));
return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
}
sub compare_arrays {
my ($arrayref1,$arrayref2) = @_;
my (@difference,%count);
@difference = ();
%count = ();
if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
foreach my $element (keys(%count)) {
if ($count{$element} == 1) {
push(@difference,$element);
}
}
}
return @difference;
}
sub lon_status_items {
my %defaults = (
E => 100,
W => 4,
N => 1,
U => 5,
threshold => 200,
sysmail => 2500,
);
my %names = (
E => 'Errors',
W => 'Warnings',
N => 'Notices',
U => 'Unsent',
);
return (\%defaults,\%names);
}
# -------------------------------------------------------- Initialize user login
sub init_user_environment {
my ($r, $username, $domain, $authhost, $form, $args) = @_;
my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
my $public=($username eq 'public' && $domain eq 'public');
# See if old ID present, if so, remove
my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
my $now=time;
if ($public) {
my $max_public=100;
my $oldest;
my $oldest_time=0;
for(my $next=1;$next<=$max_public;$next++) {
if (-e $lonids."/publicuser_$next.id") {
my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
if ($mtime<$oldest_time || !$oldest_time) {
$oldest_time=$mtime;
$oldest=$next;
}
} else {
$cookie="publicuser_$next";
last;
}
}
if (!$cookie) { $cookie="publicuser_$oldest"; }
} else {
# if this isn't a robot, kill any existing non-robot sessions
if (!$args->{'robot'}) {
opendir(DIR,$lonids);
while ($filename=readdir(DIR)) {
if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
&GDBM_READER(),0640)) {
my $linkedfile;
if (exists($oldenv{'user.linkedenv'})) {
$linkedfile = $oldenv{'user.linkedenv'};
}
untie(%oldenv);
if (unlink("$lonids/$filename")) {
if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
if (-l "$lonids/$linkedfile.id") {
unlink("$lonids/$linkedfile.id");
}
}
}
} else {
unlink($lonids.'/'.$filename);
}
}
}
closedir(DIR);
# If there is a undeleted lockfile for the user's paste buffer remove it.
my $namespace = 'nohist_courseeditor';
my $lockingkey = 'paste'."\0".'locked_num';
my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
$domain,$username);
if (exists($lockhash{$lockingkey})) {
my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
unless ($delresult eq 'ok') {
&Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
}
}
}
# Give them a new cookie
my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
: $now.$$.int(rand(10000)));
$cookie="$username\_$id\_$domain\_$authhost";
# Initialize roles
($userroles,$firstaccenv,$timerintenv) =
&Apache::lonnet::rolesinit($domain,$username,$authhost);
}
# ------------------------------------ Check browser type and MathML capability
my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
$clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
# ------------------------------------------------------------- Get environment
my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
my ($tmp) = keys(%userenv);
if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
} else {
undef(%userenv);
}
if (($userenv{'interface'}) && (!$form->{'interface'})) {
$form->{'interface'}=$userenv{'interface'};
}
if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
# --------------- Do not trust query string to be put directly into environment
foreach my $option ('interface','localpath','localres') {
$form->{$option}=~s/[\n\r\=]//gs;
}
# --------------------------------------------------------- Write first profile
{
my $ip = &Apache::lonnet::get_requestor_ip();
my %initial_env =
("user.name" => $username,
"user.domain" => $domain,
"user.home" => $authhost,
"browser.type" => $clientbrowser,
"browser.version" => $clientversion,
"browser.mathml" => $clientmathml,
"browser.unicode" => $clientunicode,
"browser.os" => $clientos,
"browser.mobile" => $clientmobile,
"browser.info" => $clientinfo,
"browser.osversion" => $clientosversion,
"server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
"request.course.fn" => '',
"request.course.uri" => '',
"request.course.sec" => '',
"request.role" => 'cm',
"request.role.adv" => $env{'user.adv'},
"request.host" => $ip,);
if ($form->{'localpath'}) {
$initial_env{"browser.localpath"} = $form->{'localpath'};
$initial_env{"browser.localres"} = $form->{'localres'};
}
if ($form->{'interface'}) {
$form->{'interface'}=~s/\W//gs;
$initial_env{"browser.interface"} = $form->{'interface'};
$env{'browser.interface'}=$form->{'interface'};
}
if ($form->{'iptoken'}) {
my $lonhost = $r->dir_config('lonHostID');
$initial_env{"user.noloadbalance"} = $lonhost;
$env{'user.noloadbalance'} = $lonhost;
}
if ($form->{'noloadbalance'}) {
my @hosts = &Apache::lonnet::current_machine_ids();
my $hosthere = $form->{'noloadbalance'};
if (grep(/^\Q$hosthere\E$/,@hosts)) {
$initial_env{"user.noloadbalance"} = $hosthere;
$env{'user.noloadbalance'} = $hosthere;
}
}
unless ($domain eq 'public') {
my %is_adv = ( is_adv => $env{'user.adv'} );
my %domdef = &Apache::lonnet::get_domain_defaults($domain);
foreach my $tool ('aboutme','blog','webdav','portfolio') {
$userenv{'availabletools.'.$tool} =
&Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
undef,\%userenv,\%domdef,\%is_adv);
}
foreach my $crstype ('official','unofficial','community','textbook') {
$userenv{'canrequest.'.$crstype} =
&Apache::lonnet::usertools_access($username,$domain,$crstype,
'reload','requestcourses',
\%userenv,\%domdef,\%is_adv);
}
$userenv{'canrequest.author'} =
&Apache::lonnet::usertools_access($username,$domain,'requestauthor',
'reload','requestauthor',
\%userenv,\%domdef,\%is_adv);
my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
$domain,$username);
my $reqstatus = $reqauthor{'author_status'};
if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
if (ref($reqauthor{'author'}) eq 'HASH') {
$userenv{'requestauthorqueued'} = $reqstatus.':'.
$reqauthor{'author'}{'timestamp'};
}
}
}
$env{'user.environment'} = "$lonids/$cookie.id";
if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
&GDBM_WRCREAT(),0640)) {
&_add_to_env(\%disk_env,\%initial_env);
&_add_to_env(\%disk_env,\%userenv,'environment.');
&_add_to_env(\%disk_env,$userroles);
if (ref($firstaccenv) eq 'HASH') {
&_add_to_env(\%disk_env,$firstaccenv);
}
if (ref($timerintenv) eq 'HASH') {
&_add_to_env(\%disk_env,$timerintenv);
}
if (ref($args->{'extra_env'})) {
&_add_to_env(\%disk_env,$args->{'extra_env'});
}
untie(%disk_env);
} else {
&Apache::lonnet::logthis("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) = @_;
if (ref($env_data) eq 'HASH') {
while (my ($key,$value) = each(%$env_data)) {
$idf->{$prefix.$key} = $value;
$env{$prefix.$key} = $value;
}
}
}
# --- Get the symbolic name of a problem and the url
sub get_symb {
my ($request,$silent) = @_;
(my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
if ($symb eq '') {
if (!$silent) {
if (ref($request)) {
$request->print("Unable to handle ambiguous references:$url:.");
}
return ();
}
}
&Apache::lonenc::check_decrypt(\$symb);
return ($symb);
}
# --------------------------------------------------------------Get annotation
sub get_annotation {
my ($symb,$enc) = @_;
my $key = $symb;
if (!$enc) {
$key =
&Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
}
my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
return $annotation{$key};
}
sub clean_symb {
my ($symb,$delete_enc) = @_;
&Apache::lonenc::check_decrypt(\$symb);
my $enc = $env{'request.enc'};
if ($delete_enc) {
delete($env{'request.enc'});
}
return ($symb,$enc);
}
############################################################
############################################################
=pod
=head1 Routines for building display used to search for courses
=over 4
=item * &build_filters()
Create markup for a table used to set filters to use when selecting
courses in a domain. Used by lonpickcourse.pm, lonmodifycourse.pm
and quotacheck.pl
Inputs:
filterlist - anonymous array of fields to include as potential filters
crstype - course type
roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
to pop-open a course selector (will contain "extra element").
multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
filter - anonymous hash of criteria and their values
action - form action
numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
cloneruname - username of owner of new course who wants to clone
clonerudom - domain of owner of new course who wants to clone
typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
codetitlesref - reference to array of titles of components in institutional codes (official courses)
codedom - domain
formname - value of form element named "form".
fixeddom - domain, if fixed.
prevphase - value to assign to form element named "phase" when going back to the previous screen
cnameelement - name of form element in form on opener page which will receive title of selected course
cnumelement - name of form element in form on opener page which will receive courseID of selected course
cdomelement - name of form element in form on opener page which will receive domain of selected course
setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
clonewarning - warning message about missing information for intended course owner when DC creates a course
Returns: $output - HTML for display of search criteria, and hidden form elements.
Side Effects: None
=cut
# ---------------------------------------------- search for courses based on last activity etc.
sub build_filters {
my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
$numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
$codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
$cnameelement,$cnumelement,$cdomelement,$setroles,
$clonetext,$clonewarning) = @_;
my ($list,$jscript);
my $onchange = 'javascript:updateFilters(this)';
my ($domainselectform,$sincefilterform,$createdfilterform,
$ownerdomselectform,$persondomselectform,$instcodeform,
$typeselectform,$instcodetitle);
if ($formname eq '') {
$formname = $caller;
}
foreach my $item (@{$filterlist}) {
unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
($item eq 'sincefilter') || ($item eq 'createdfilter')) {
if ($item eq 'domainfilter') {
$filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
} elsif ($item eq 'coursefilter') {
$filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
} elsif ($item eq 'ownerfilter') {
$filter->{$item} = &LONCAPA::clean_username($filter->{$item});
} elsif ($item eq 'ownerdomfilter') {
$filter->{'ownerdomfilter'} =
&LONCAPA::clean_domain($filter->{$item});
$ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
'ownerdomfilter',1);
} elsif ($item eq 'personfilter') {
$filter->{$item} = &LONCAPA::clean_username($filter->{$item});
} elsif ($item eq 'persondomfilter') {
$persondomselectform = &select_dom_form($filter->{'persondomfilter'},
'persondomfilter',1);
} else {
$filter->{$item} =~ s/\W//g;
}
if (!$filter->{$item}) {
$filter->{$item} = '';
}
}
if ($item eq 'domainfilter') {
my $allow_blank = 1;
if ($formname eq 'portform') {
$allow_blank=0;
} elsif ($formname eq 'studentform') {
$allow_blank=0;
}
if ($fixeddom) {
$domainselectform = ''.
&Apache::lonnet::domain($codedom,'description');
} else {
$domainselectform = &select_dom_form($filter->{$item},
'domainfilter',
$allow_blank,'',$onchange);
}
} else {
$list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
}
}
# last course activity filter and selection
$sincefilterform = &timebased_select_form('sincefilter',$filter);
# course created filter and selection
if (exists($filter->{'createdfilter'})) {
$createdfilterform = &timebased_select_form('createdfilter',$filter);
}
my %lt = &Apache::lonlocal::texthash(
'cac' => "$crstype Activity",
'ccr' => "$crstype Created",
'cde' => "$crstype Title",
'cdo' => "$crstype Domain",
'ins' => 'Institutional Code',
'inc' => 'Institutional Categorization',
'cow' => "$crstype Owner/Co-owner",
'cop' => "$crstype Personnel Includes",
'cog' => 'Type',
);
if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
my $typeval = 'Course';
if ($crstype eq 'Community') {
$typeval = 'Community';
}
$typeselectform = '';
} else {
$typeselectform = '";
}
my ($cloneableonlyform,$cloneabletitle);
if (exists($filter->{'cloneableonly'})) {
my $cloneableon = '';
my $cloneableoff = ' checked="checked"';
if ($filter->{'cloneableonly'}) {
$cloneableon = $cloneableoff;
$cloneableoff = '';
}
$cloneableonlyform = ''.(' 'x3).'';
if ($formname eq 'ccrs') {
$cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
} else {
$cloneabletitle = &mt('Cloneable by you');
}
}
my $officialjs;
if ($crstype eq 'Course') {
if (exists($filter->{'instcodefilter'})) {
# if (($fixeddom) || ($formname eq 'requestcrs') ||
# ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
if ($codedom) {
$officialjs = 1;
($instcodeform,$jscript,$$numtitlesref) =
&Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
$officialjs,$codetitlesref);
if ($jscript) {
$jscript = ''."\n";
}
}
if ($instcodeform eq '') {
$instcodeform =
'';
$instcodetitle = $lt{'ins'};
} else {
$instcodetitle = $lt{'inc'};
}
if ($fixeddom) {
$instcodetitle .= ' ('.$codedom.')';
}
}
}
my $output = qq|
'."\n".''."\n";
return $jscript.$clonewarning.$output;
}
=pod
=item * &timebased_select_form()
Create markup for a dropdown list used to select a time-based
filter e.g., Course Activity, Course Created, when searching for courses
or communities
Inputs:
item - name of form element (sincefilter or createdfilter)
filter - anonymous hash of criteria and their values
Returns: HTML for a select box contained a blank, then six time selections,
with value set in incoming form variables currently selected.
Side Effects: None
=cut
sub timebased_select_form {
my ($item,$filter) = @_;
if (ref($filter) eq 'HASH') {
$filter->{$item} =~ s/[^\d-]//g;
if (!$filter->{$item}) { $filter->{$item}=-1; }
return &select_form(
$filter->{$item},
$item,
{ '-1' => '',
'86400' => &mt('today'),
'604800' => &mt('last week'),
'2592000' => &mt('last month'),
'7776000' => &mt('last three months'),
'15552000' => &mt('last six months'),
'31104000' => &mt('last year'),
'select_form_order' =>
['-1','86400','604800','2592000','7776000',
'15552000','31104000']});
}
}
=pod
=item * &js_changer()
Create script tag containing Javascript used to submit course search form
when course type or domain is changed, and also to hide 'Searching ...' on
page load completion for page showing search result.
Inputs: None
Returns: markup containing updateFilters() and hideSearching() javascript functions.
Side Effects: None
=cut
sub js_changer {
return <
//
ENDJS
}
=pod
=item * &search_courses()
Process selected filters form course search form and pass to lonnet::courseiddump
to retrieve a hash for which keys are courseIDs which match the selected filters.
Inputs:
dom - domain being searched
type - course type ('Course' or 'Community' or '.' if any).
filter - anonymous hash of criteria and their values
numtitles - for institutional codes - number of categories
cloneruname - optional username of new course owner
clonerudom - optional domain of new course owner
domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
(used when DC is using course creation form)
codetitles - reference to array of titles of components in institutional codes (official courses).
cc_clone - escaped comma separated list of courses for which course cloner has active CC role
(and so can clone automatically)
reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
reqinstcode - institutional code of new course, where search_courses is used to identify potential
courses to clone
Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
Side Effects: None
=cut
sub search_courses {
my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
$cc_clone,$reqcrsdom,$reqinstcode) = @_;
my (%courses,%showcourses,$cloner);
if (($filter->{'ownerfilter'} ne '') ||
($filter->{'ownerdomfilter'} ne '')) {
$filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
$filter->{'ownerdomfilter'};
}
foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
if (!$filter->{$item}) {
$filter->{$item}='.';
}
}
my $now = time;
my $timefilter =
($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
my ($createdbefore,$createdafter);
if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
$createdbefore = $now;
$createdafter = $now-$filter->{'createdfilter'};
}
my ($instcodefilter,$regexpok);
if ($numtitles) {
if ($env{'form.official'} eq 'on') {
$instcodefilter =
&Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
$regexpok = 1;
} elsif ($env{'form.official'} eq 'off') {
$instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
unless ($instcodefilter eq '') {
$regexpok = -1;
}
}
} else {
$instcodefilter = $filter->{'instcodefilter'};
}
if ($instcodefilter eq '') { $instcodefilter = '.'; }
if ($type eq '') { $type = '.'; }
if (($clonerudom ne '') && ($cloneruname ne '')) {
$cloner = $cloneruname.':'.$clonerudom;
}
%courses = &Apache::lonnet::courseiddump($dom,
$filter->{'descriptfilter'},
$timefilter,
$instcodefilter,
$filter->{'combownerfilter'},
$filter->{'coursefilter'},
undef,undef,$type,$regexpok,undef,undef,
undef,undef,$cloner,$cc_clone,
$filter->{'cloneableonly'},
$createdbefore,$createdafter,undef,
$domcloner,undef,$reqcrsdom,$reqinstcode);
if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
my $ccrole;
if ($type eq 'Community') {
$ccrole = 'co';
} else {
$ccrole = 'cc';
}
my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
$filter->{'persondomfilter'},
'userroles',undef,
[$ccrole,'in','ad','ep','ta','cr'],
$dom);
foreach my $role (keys(%rolehash)) {
my ($cnum,$cdom,$courserole) = split(':',$role);
my $cid = $cdom.'_'.$cnum;
if (exists($courses{$cid})) {
if (ref($courses{$cid}) eq 'HASH') {
if (ref($courses{$cid}{roles}) eq 'ARRAY') {
if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
push(@{$courses{$cid}{roles}},$courserole);
}
} else {
$courses{$cid}{roles} = [$courserole];
}
$showcourses{$cid} = $courses{$cid};
}
}
}
%courses = %showcourses;
}
return %courses;
}
=pod
=back
=head1 Routines for version requirements for current course.
=over 4
=item * &check_release_required()
Compares required LON-CAPA version with version on server, and
if required version is newer looks for a server with the required version.
Looks first at servers in user's owen domain; if none suitable, looks at
servers in course's domain are permitted to host sessions for user's domain.
Inputs:
$loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
$courseid - Course ID of current course
$rolecode - User's current role in course (for switchserver query string).
$required - LON-CAPA version needed by course (format: Major.Minor).
Returns:
$switchserver - query string tp append to /adm/switchserver call (if
current server's LON-CAPA version is too old.
$warning - Message is displayed if no suitable server could be found.
=cut
sub check_release_required {
my ($loncaparev,$courseid,$rolecode,$required) = @_;
my ($switchserver,$warning);
if ($required ne '') {
my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
if ($reqdmajor ne '' && $reqdminor ne '') {
my $otherserver;
if (($major eq '' && $minor eq '') ||
(($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
my $switchlcrev =
&Apache::lonnet::get_server_loncaparev($env{'user.domain'},
$userdomserver);
my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
(($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
my $cdom = $env{'course.'.$courseid.'.domain'};
if ($cdom ne $env{'user.domain'}) {
my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
my $canhost =
&Apache::lonnet::can_host_session($env{'user.domain'},
$coursedomserver,
$remoterev,
$udomdefaults{'remotesessions'},
$defdomdefaults{'hostedsessions'});
if ($canhost) {
$otherserver = $coursedomserver;
} else {
$warning = &mt('Requires LON-CAPA version [_1].',$env{'course.'.$courseid.'.internal.releaserequired'}).' '. &mt("No suitable server could be found amongst servers in either your own domain or in the course's domain.");
}
} else {
$warning = &mt('Requires LON-CAPA version [_1].',$env{'course.'.$courseid.'.internal.releaserequired'}).' '.&mt("No suitable server could be found amongst servers in your own domain (which is also the course's domain).");
}
} else {
$otherserver = $userdomserver;
}
}
if ($otherserver ne '') {
$switchserver = 'otherserver='.$otherserver.'&role='.$rolecode;
}
}
}
return ($switchserver,$warning);
}
=pod
=item * &check_release_result()
Inputs:
$switchwarning - Warning message if no suitable server found to host session.
$switchserver - query string to append to /adm/switchserver containing lonHostID
and current role.
Returns: HTML to display with information about requirement to switch server.
Either displaying warning with link to Roles/Courses screen or
display link to switchserver.
=cut
sub check_release_result {
my ($switchwarning,$switchserver) = @_;
my $output = &start_page('Selected course unavailable on this server').
'