# The LearningOnline Network with CAPA
# a pile of common routines
#
# $Id: loncommon.pm,v 1.1034 2011/12/09 01:04:27 www 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 Apache::lonnet();
use HTML::Entities;
use Apache::lonhtmlcommon();
use Apache::loncoursedata();
use Apache::lontexconvert();
use Apache::lonclonecourse();
use LONCAPA qw(:DEFAULT :match);
use DateTime::TimeZone;
use DateTime::Locale::Catalog;
# ---------------------------------------------- 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 %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)=(split(/\t/,$line));
$language{$key}=$val.' - '.$enc;
if ($sup) {
$supported_language{$key}=$sup;
}
}
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,$courseadvonly,$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 ($courseadvonly) {
$callargs .= ",'',1,1";
}
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) = @_;
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++) {
field[i].checked = true ;
}
} else {
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)=@_;
my $output='";
return $output;
}
sub select_datelocale {
my ($name,$selected,$onchange,$includeempty)=@_;
my $output='";
return $output;
}
sub select_language {
my ($name,$selected,$includeempty) = @_;
my %langchoices;
if ($includeempty) {
%langchoices = ('' => 'No language preference');
}
foreach my $id (&languageids()) {
my $code = &supportedlanguagecode($id);
if ($code) {
$langchoices{$code} = &plainlanguagedescription($id);
}
}
return &select_form($selected,$name,\%langchoices);
}
=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.'').'
';
}
}
}
} else {
&logthis('Failed to parse '.$container.
' to modify references: '.$parse_result);
}
}
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;
}
=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 '') {
push(@pathitems,$title);
}
}
}
}
my $maptitle = $mapres->compTitle();
$maptitle =~ s/\W+/_/g;
if ($maptitle ne '') {
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;
}
}
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=$env{'user.name'}.'_'.$env{'user.domain'}.
'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
{
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)
Load uploaded file from tmp, $r should be the HTTP Request object,
needs $env{'form.datatoken'},
sets $env{'form.upfile'} to the contents of the file
=cut
sub load_tmp_file {
my $r=shift;
my @studentdata=();
{
my $studentfile = $r->dir_config('lonDaemons').
'/tmp/'.$env{'form.datatoken'}.'.tmp';
if ( open(my $fh,"<$studentfile") ) {
@studentdata=<$fh>;
close($fh);
}
}
$env{'form.upfile'}=join('',@studentdata);
}
=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 five types of e-mail:
(a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
(d) Help requests, (e) Course requests needing approval, generated by
lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
loncoursequeueadmin.pm respectively.
Inputs:
defmail (scalar - email address of default recipient),
mailing type (scalar - errormail, packagesmail, or helpdeskmail),
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
Returns: comma separated list of addresses to which to send e-mail.
=back
=cut
############################################################
############################################################
sub build_recipient_list {
my ($defmail,$mailing,$defdom,$origmail) = @_;
my @recipients;
my $otheremails;
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'};
}
}
} elsif ($origmail ne '') {
push(@recipients,$origmail);
}
} elsif ($origmail ne '') {
push(@recipients,$origmail);
}
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);
}
}
}
my $recipientlist = join(',',@recipients);
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)
Returns: nothing
Side effects: populates trails and allitems hash references.
=cut
sub extract_categories {
my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
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);
}
} else {
if (ref($subcats) eq 'HASH') {
$subcats->{$item} = [];
}
}
}
}
}
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) = @_;
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);
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;
}
}
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).
Returns: $output (markup to be displayed)
=cut
sub assign_categories_table {
my ($cathash,$currcat,$type) = @_;
my $output;
if (ref($cathash) eq 'HASH') {
my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
&extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
$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
Returns: $output (markup to be displayed).
=cut
sub assign_category_rows {
my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
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;
}
############################################################
############################################################
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) = @_;
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);
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) = @_;
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);
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 [_3] -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 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'],
$args->{'clonedomain'},$args->{'clonecourse'});
my @cloners = split(/,/,$clonehash{'cloners'});
if (grep(/^\*$/,@cloners)) {
$can_clone = 1;
} elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
$can_clone = 1;
} else {
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}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
$can_clone = 1;
} elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) {
$can_clone = 1;
} else {
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) = @_;
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',
'categories'],
$$crsudom,$$crsunum);
}
#
# Set environment (will override cloned, if existing)
#
my @sections = ();
my @xlists = ();
if ($args->{'crstype'}) {
$cenv{'type'}=$args->{'crstype'};
}
if ($args->{'crsid'}) {
$cenv{'courseid'}=$args->{'crsid'};
}
if ($args->{'crscode'}) {
$cenv{'internal.coursecode'}=$args->{'crscode'};
}
if ($args->{'crsquota'} ne '') {
$cenv{'internal.coursequota'}=$args->{'crsquota'};
} else {
$cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
}
if ($args->{'ccuname'}) {
$cenv{'internal.courseowner'} = $args->{'ccuname'}.
':'.$args->{'ccdomain'};
} else {
$cenv{'internal.courseowner'} = $args->{'curruser'};
}
my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
if ($args->{'crssections'}) {
$cenv{'internal.sectionnums'} = '';
if ($args->{'crssections'} =~ m/,/) {
@sections = split/,/,$args->{'crssections'};
} else {
$sections[0] = $args->{'crssections'};
}
if (@sections > 0) {
foreach my $item (@sections) {
my ($sec,$gp) = split/:/,$item;
my $class = $args->{'crscode'}.$sec;
my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
$cenv{'internal.sectionnums'} .= $item.',';
unless ($addcheck eq 'ok') {
push @badclasses, $class;
}
}
$cenv{'internal.sectionnums'} =~ s/,$//;
}
}
# do not hide course coordinator from staff listing,
# even if privileged
$cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
# add crosslistings
if ($args->{'crsxlist'}) {
$cenv{'internal.crosslistings'}='';
if ($args->{'crsxlist'} =~ m/,/) {
@xlists = split/,/,$args->{'crsxlist'};
} else {
$xlists[0] = $args->{'crsxlist'};
}
if (@xlists > 0) {
foreach my $item (@xlists) {
my ($xl,$gp) = split/:/,$item;
my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
$cenv{'internal.crosslistings'} .= $item.',';
unless ($addcheck eq 'ok') {
push @badclasses, $xl;
}
}
$cenv{'internal.crosslistings'} =~ s/,$//;
}
}
if ($args->{'autoadds'}) {
$cenv{'internal.autoadds'}=$args->{'autoadds'};
}
if ($args->{'autodrops'}) {
$cenv{'internal.autodrops'}=$args->{'autodrops'};
}
# check for notification of enrollment changes
my @notified = ();
if ($args->{'notify_owner'}) {
if ($args->{'ccuname'} ne '') {
push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
}
}
if ($args->{'notify_dc'}) {
if ($uname ne '') {
push(@notified,$uname.':'.$udom);
}
}
if (@notified > 0) {
my $notifylist;
if (@notified > 1) {
$notifylist = join(',',@notified);
} else {
$notifylist = $notified[0];
}
$cenv{'internal.notifylist'} = $notifylist;
}
if (@badclasses > 0) {
my %lt=&Apache::lonlocal::texthash(
'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course. However, if automated course roster updates are enabled for this class, these particular sections/crosslistings will not contribute towards enrollment, because the user identified as the course owner for this LON-CAPA course',
'dnhr' => 'does not have rights to access enrollment in these classes',
'adby' => 'as determined by the policies of your institution on access to official classlists'
);
my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
' ('.$lt{'adby'}.')';
if ($context eq 'auto') {
$outcome .= $badclass_msg.$linefeed;
$outcome .= '
\n";
}
}
}
if ($args->{'no_end_date'}) {
$args->{'endaccess'} = 0;
}
$cenv{'internal.autostart'}=$args->{'enrollstart'};
$cenv{'internal.autoend'}=$args->{'enrollend'};
$cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
$cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
if ($args->{'showphotos'}) {
$cenv{'internal.showphotos'}=$args->{'showphotos'};
}
$cenv{'internal.authtype'} = $args->{'authtype'};
$cenv{'internal.autharg'} = $args->{'autharg'};
if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
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->{'reshome'}) {
$cenv{'reshome'}=$args->{'reshome'}.'/';
$cenv{'reshome'}=~s/\/+$/\//;
}
#
# course has keyed access
#
if ($args->{'setkeys'}) {
$cenv{'keyaccess'}='yes';
}
# if specified, key authority is not course, but user
# only active if keyaccess is yes
if ($args->{'keyauth'}) {
my ($user,$domain) = split(':',$args->{'keyauth'});
$user = &LONCAPA::clean_username($user);
$domain = &LONCAPA::clean_username($domain);
if ($user ne '' && $domain ne '') {
$cenv{'keyauth'}=$user.':'.$domain;
}
}
if ($args->{'disresdis'}) {
$cenv{'pch.roles.denied'}='st';
}
if ($args->{'disablechat'}) {
$cenv{'plc.roles.denied'}='st';
}
# Record we've not yet viewed the Course Initialization Helper for this
# course
$cenv{'course.helper.not.run'} = 1;
#
# Use new Randomseed
#
$cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
$cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
#
# The encryption code and receipt prefix for this course
#
$cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
$cenv{'internal.encpref'}=100+int(9*rand(99));
#
# By default, use standard grading
if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
$outcome .= $linefeed.&mt('Setting environment').': '.
&Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
#
# Open all assignments
#
if ($args->{'openall'}) {
my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
my %storecontent = ($storeunder => time,
$storeunder.'.type' => 'date_start');
$outcome .= &mt('Opening all assignments').': '.&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);
}
############################################################
############################################################
#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');
my %typename = (
official => 'Official course',
unofficial => 'Unofficial course',
community => 'Community',
);
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 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;
}
# -------------------------------------------------------- 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);
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$/) {
unlink($lonids.'/'.$filename);
}
}
closedir(DIR);
}
# Give them a new cookie
my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
: $now.$$.int(rand(10000)));
$cookie="$username\_$id\_$domain\_$authhost";
# Initialize roles
$userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
}
# ------------------------------------ Check browser type and MathML capability
my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
$clientunicode,$clientos) = &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 %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,
"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" => $ENV{'REMOTE_ADDR'},);
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'};
}
my %is_adv = ( is_adv => $env{'user.adv'} );
my %domdef;
unless ($domain eq 'public') {
%domdef = &Apache::lonnet::get_domain_defaults($domain);
}
foreach my $tool ('aboutme','blog','portfolio') {
$userenv{'availabletools.'.$tool} =
&Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
undef,\%userenv,\%domdef,\%is_adv);
}
foreach my $crstype ('official','unofficial','community') {
$userenv{'canrequest.'.$crstype} =
&Apache::lonnet::usertools_access($username,$domain,$crstype,
'reload','requestcourses',
\%userenv,\%domdef,\%is_adv);
}
$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($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) {
$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);
}
sub build_release_hashes {
my ($checkparms,$checkresponsetypes,$checkcrstypes,$anonsurvey,$randomizetry) = @_;
return unless((ref($checkparms) eq 'HASH') && (ref($checkresponsetypes) eq 'HASH') &&
(ref($checkcrstypes) eq 'HASH') && (ref($anonsurvey) eq 'HASH') &&
(ref($randomizetry) eq 'HASH'));
foreach my $key (keys(%Apache::lonnet::needsrelease)) {
my ($item,$name,$value) = split(/:/,$key);
if ($item eq 'parameter') {
if (ref($checkparms->{$name}) eq 'ARRAY') {
unless(grep(/^\Q$name\E$/,@{$checkparms->{$name}})) {
push(@{$checkparms->{$name}},$value);
}
} else {
push(@{$checkparms->{$name}},$value);
}
} elsif ($item eq 'resourcetag') {
if ($name eq 'responsetype') {
$checkresponsetypes->{$value} = $Apache::lonnet::needsrelease{$key}
}
} elsif ($item eq 'course') {
if ($name eq 'crstype') {
$checkcrstypes->{$value} = $Apache::lonnet::needsrelease{$key};
}
}
}
($anonsurvey->{major},$anonsurvey->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:anonsurvey'});
($randomizetry->{major},$randomizetry->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:randomizetry'});
return;
}
=pod
=back
=cut
1;
__END__;