# The LearningOnline Network
# Create a course
#
# $Id: loncreatecourse.pm,v 1.78 2005/04/07 06:56:23 albertel 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/
#
###
package Apache::loncreatecourse;
use strict;
use Apache::Constants qw(:common :http);
use Apache::lonnet;
use Apache::loncommon;
use Apache::lonratedt;
use Apache::londocs;
use Apache::lonlocal;
use Apache::londropadd;
use lib '/home/httpd/lib/perl';
# ================================================ Get course directory listing
my @output=();
sub crsdirlist {
my ($courseid,$which)=@_;
@output=();
return &innercrsdirlist($courseid,$which);
}
sub innercrsdirlist {
my ($courseid,$which,$path)=@_;
my $dirptr=16384;
unless ($which) { $which=''; } else { $which.='/'; }
unless ($path) { $path=''; } else { $path.='/'; }
my %crsdata=&Apache::lonnet::coursedescription($courseid);
my @listing=&Apache::lonnet::dirlist
($which,$crsdata{'domain'},$crsdata{'num'},
&Apache::loncommon::propath($crsdata{'domain'},$crsdata{'num'}));
foreach (@listing) {
unless ($_=~/^\./) {
my @unpackline = split (/\&/,$_);
if ($unpackline[3]&$dirptr) {
# is a directory, recurse
&innercrsdirlist($courseid,$which.$unpackline[0],
$path.$unpackline[0]);
} else {
# is a file, put into output
push (@output,$path.$unpackline[0]);
}
}
}
return @output;
}
# ============================================================= Read a userfile
sub readfile {
my ($courseid,$which)=@_;
my %crsdata=&Apache::lonnet::coursedescription($courseid);
return &Apache::lonnet::getfile('/uploaded/'.$crsdata{'domain'}.'/'.
$crsdata{'num'}.'/'.$which);
}
# ============================================================ Write a userfile
sub writefile {
(my $courseid, my $which,$env{'form.output'})=@_;
my %crsdata=&Apache::lonnet::coursedescription($courseid);
return &Apache::lonnet::finishuserfileupload(
$crsdata{'num'},$crsdata{'domain'},
$crsdata{'home'},
'output',$which);
}
# ===================================================================== Rewrite
sub rewritefile {
my ($contents,%rewritehash)=@_;
foreach (keys %rewritehash) {
my $pattern=$_;
$pattern=~s/(\W)/\\$1/gs;
my $new=$rewritehash{$_};
$contents=~s/$pattern/$new/gs;
}
return $contents;
}
# ============================================================= Copy a userfile
sub copyfile {
my ($origcrsid,$newcrsid,$which)=@_;
unless ($which=~/\.sequence$/) {
return &writefile($newcrsid,$which,
&readfile($origcrsid,$which));
} else {
my %origcrsdata=&Apache::lonnet::coursedescription($origcrsid);
my %newcrsdata= &Apache::lonnet::coursedescription($newcrsid);
return &writefile($newcrsid,$which,
&rewritefile(
&readfile($origcrsid,$which),
(
'/uploaded/'.$origcrsdata{'domain'}.'/'.$origcrsdata{'num'}.'/'
=> '/uploaded/'. $newcrsdata{'domain'}.'/'. $newcrsdata{'num'}.'/',
'/public/'.$origcrsdata{'domain'}.'/'.$origcrsdata{'num'}.'/'
=> '/public/'. $newcrsdata{'domain'}.'/'. $newcrsdata{'num'}.'/'
)));
}
}
# =============================================================== Copy a dbfile
sub copydb {
my ($origcrsid,$newcrsid,$which)=@_;
$which=~s/\.db$//;
my %origcrsdata=&Apache::lonnet::coursedescription($origcrsid);
my %newcrsdata= &Apache::lonnet::coursedescription($newcrsid);
my %data=&Apache::lonnet::dump
($which,$origcrsdata{'domain'},$origcrsdata{'num'});
foreach my $key (keys(%data)) {
if ($key=~/^internal./) { delete($data{$key}); }
}
return &Apache::lonnet::put
($which,\%data,$newcrsdata{'domain'},$newcrsdata{'num'});
}
# ========================================================== Copy resourcesdata
sub copyresourcedb {
my ($origcrsid,$newcrsid)=@_;
my %origcrsdata=&Apache::lonnet::coursedescription($origcrsid);
my %newcrsdata= &Apache::lonnet::coursedescription($newcrsid);
my %data=&Apache::lonnet::dump
('resourcedata',$origcrsdata{'domain'},$origcrsdata{'num'});
$origcrsid=~s/^\///;
$origcrsid=~s/\//\_/;
$newcrsid=~s/^\///;
$newcrsid=~s/\//\_/;
my %newdata=();
undef %newdata;
my $startdate=$data{$origcrsid.'.0.opendate'};
my $today=time;
my $delta=0;
if ($startdate) {
my $oneday=60*60*24;
$delta=$today-$startdate;
$delta=int($delta/$oneday)*$oneday;
}
# ugly retro fix for broken version of types
foreach (keys %data) {
if ($_=~/\wtype$/) {
my $newkey=$_;
$newkey=~s/type$/\.type/;
$data{$newkey}=$data{$_};
delete $data{$_};
}
}
# adjust symbs
my $pattern='uploaded/'.$origcrsdata{'domain'}.'/'.$origcrsdata{'num'}.'/';
$pattern=~s/(\W)/\\$1/gs;
my $new= 'uploaded/'. $newcrsdata{'domain'}.'/'. $newcrsdata{'num'}.'/';
foreach (keys %data) {
if ($_=~/$pattern/) {
my $newkey=$_;
$newkey=~s/$pattern/$new/;
$data{$newkey}=$data{$_};
delete $data{$_};
}
}
# adjust dates
foreach (keys %data) {
my $thiskey=$_;
$thiskey=~s/^$origcrsid/$newcrsid/;
$newdata{$thiskey}=$data{$_};
if ($data{$_.'.type'}=~/^date_(start|end)$/) {
$newdata{$thiskey}=$newdata{$thiskey}+$delta;
}
}
return &Apache::lonnet::put
('resourcedata',\%newdata,$newcrsdata{'domain'},$newcrsdata{'num'});
}
# ========================================================== Copy all userfiles
sub copyuserfiles {
my ($origcrsid,$newcrsid)=@_;
foreach (&crsdirlist($origcrsid,'userfiles')) {
if ($_ !~m|^scantron_|) {
©file($origcrsid,$newcrsid,$_);
}
}
}
# ========================================================== Copy all userfiles
sub copydbfiles {
my ($origcrsid,$newcrsid)=@_;
foreach (&crsdirlist($origcrsid)) {
if ($_=~/\.db$/) {
unless
($_=~/^(nohist\_|discussiontimes|classlist|versionupdate|resourcedata)/) {
©db($origcrsid,$newcrsid,$_);
}
}
}
}
# ======================================================= Copy all course files
sub copycoursefiles {
my ($origcrsid,$newcrsid)=@_;
©userfiles($origcrsid,$newcrsid);
©dbfiles($origcrsid,$newcrsid);
©resourcedb($origcrsid,$newcrsid);
}
# ===================================================== Phase one: fill-in form
sub print_course_creation_page {
my $r=shift;
my $defdom=$env{'request.role.domain'};
my %host_servers = &Apache::loncommon::get_library_servers($defdom);
my $course_home = '\n";
my $domform = &Apache::loncommon::select_dom_form($defdom,'ccdomain');
my $bodytag=&Apache::loncommon::bodytag('Create a New Course');
my $helplink=&Apache::loncommon::help_open_topic('Create_Course',&mt('Help on Creating Courses'));
my $cloneform=&Apache::loncommon::select_dom_form
($env{'request.role.domain'},'clonedomain').
&Apache::loncommon::selectcourse_link
('ccrs','clonecourse','clonedomain');
my $coursebrowserjs=&Apache::loncommon::coursebrowser_javascript($env{'request.role.domain'});
my $starttime = time;
my $endtime = time+(6*30*24*60*60); # 6 months from now, approx
my $enroll_table = &Apache::londropadd::date_setting_table($starttime,$endtime,'create_enrolldates');
my $access_table = &Apache::londropadd::date_setting_table($starttime,$endtime,'create_defaultdates');
my ($krbdef,$krbdefdom) =
&Apache::loncommon::get_kerberos_defaults($defdom);
my $javascript_validations=&Apache::londropadd::javascript_validations('createcourse',$krbdefdom);
my %param = ( formname => 'document.ccrs',
kerb_def_dom => $krbdefdom,
kerb_def_auth => $krbdef
);
my $krbform = &Apache::loncommon::authform_kerberos(%param);
my $intform = &Apache::loncommon::authform_internal(%param);
my $locform = &Apache::loncommon::authform_local(%param);
my %lt=&Apache::lonlocal::texthash(
'cinf' => "Course Information",
'ctit' => "Course Title",
'chsr' => "Course Home Server",
'cidn' => "Course ID/Number",
'opt' => "optional",
'iinf' => "Institutional Information",
'stat' => "The following entries will be used to identify the course according to the naming scheme adopted by your institution. Your choices will be used to map an internal LON-CAPA course ID to the corresponding course section ID(s) used by the office responsible for providing official class lists for courses at your institution. This mapping is required if you choose to employ automatic population of class lists.",
'ccod' => "Course Code",
'toin' => "to interface with institutional data, e.g., fs03glg231 for Fall 2003 Geology 231",
'snid' => "Section Numbers and corresponding LON-CAPA section/group IDs",
'csli' => "a comma separated list of institutional section numbers, each separated by a colon from the (optional) corresponding section/group ID to be used in LON-CAPA e.g., 001:1,002:2",
'crcs' => "Crosslisted courses",
'cscs' => "a comma separated list of course sections crosslisted with the current course, with each entry including the institutional course section name followed by a colon and then the (optional) groupID to be used in LON-CAPA, e.g., fs03ent231001:ent1,fs03bot231001:bot1,fs03zol231002:zol2",
'crco' => "Course Content",
'cncr' => "Completely new course",
'cecr' => "Clone an existing course",
'map' => "Map",
'smap' => "Select Map",
'sacr' => "Do NOT generate as standard course",
'ocik' => "only check if you know what you are doing",
'fres' => "First Resource",
'stco' => "standard courses only",
'blnk' => "Blank",
'sllb' => "Syllabus",
'navi' => "Navigate",
'cid' => "Course ID",
'dmn' => "Domain",
'asov' => "Additional settings, if specified below, will override cloned settings",
'assp' => "Assessment Parameters",
'oaas' => "Open all assessments",
'mssg' => "Messaging",
'scpf' => "Set course policy feedback to Course Coordinator",
'scfc' => "Set content feedback to Course Coordinator",
'cmmn' => "Communication",
'dsrd' => "Disable student resource discussion",
'dsuc' => "Disable student use of chatrooms",
'acco' => "Access Control",
'snak' => "Students need access key to enter course",
'kaut' =>
'Key authority (id@domain) if other than course',
'cc' => "Course Coordinator",
'user' => "Username",
'ierc' => "Immediately expire own role as Course Coordinator",
'aens' => "Automated enrollment settings",
'aesc' => "The following settings control automatic enrollment of students in this class based on information available for this specific course from your institution's official classlists.",
'aadd' => "Automated adds",
'yes' => "Yes",
'no' => "No",
'audr' => "Automated drops",
'dacu' => "Duration of automated classlist updates",
'dacc' => "Default start and end dates for student access",
'psam' => "Please select the authentication mechanism",
'pcda' => "Please choose the default authentication method to be used by new users added to this LON-CAPA domain by the automated enrollment process",
'nech' => "Notification of enrollment changes",
'nccl' => "Notification to course coordinator via LON-CAPA message when enrollment changes occur during the automated update?",
'ndcl' => "Notification to domain coordinator via LON-CAPA message when enrollment changes occur during the automated update?",
'irsp' => "Include retrieval of student photographs?",
'rshm' => 'Resource Space Home',
'opco' => "Open Course"
);
my $html=&Apache::lonxml::xmlbegin();
$r->print(<
$lt{'aadd'}
$lt{'audr'}
$lt{'dacu'} $enroll_table
$lt{'dacc'} $access_table
$lt{'psam'}.
$krbform
$intform
$locform
$lt{'nech'}
$lt{'nccl'}
$lt{'ndcl'}
$lt{'irsp'}