[LON-CAPA-cvs] cvs: loncom /interface loncreatecourse.pm
raeburn
lon-capa-cvs@mail.lon-capa.org
Wed, 08 Dec 2004 23:27:30 -0000
This is a MIME encoded message
--raeburn1102548450
Content-Type: text/plain
raeburn Wed Dec 8 18:27:30 2004 EDT
Modified files:
/loncom/interface loncreatecourse.pm
Log:
Most functionality in create_course() now moved to new subroutine - construct_course(), so that loncreatecourse::construct_course() can be called by a batch process to create course(s) based on an XML file(s) describing course attributes. See bug #1273.
--raeburn1102548450
Content-Type: text/plain
Content-Disposition: attachment; filename="raeburn-20041208182730.txt"
Index: loncom/interface/loncreatecourse.pm
diff -u loncom/interface/loncreatecourse.pm:1.73 loncom/interface/loncreatecourse.pm:1.74
--- loncom/interface/loncreatecourse.pm:1.73 Mon Dec 6 20:31:17 2004
+++ loncom/interface/loncreatecourse.pm Wed Dec 8 18:27:29 2004
@@ -1,7 +1,7 @@
# The LearningOnline Network
# Create a course
#
-# $Id: loncreatecourse.pm,v 1.73 2004/12/07 01:31:17 raeburn Exp $
+# $Id: loncreatecourse.pm,v 1.74 2004/12/08 23:27:29 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -567,14 +567,36 @@
sub create_course {
my $r=shift;
- my $topurl='/res/'.&Apache::lonnet::declutter($ENV{'form.topmap'});
- my $this_server = $Apache::lonnet::perlvar{'lonHostID'};
my $ccuname=$ENV{'form.ccuname'};
my $ccdomain=$ENV{'form.ccdomain'};
$ccuname=~s/\W//g;
$ccdomain=~s/\W//g;
- my $cdescr=$ENV{'form.title'};
- my $curl=$ENV{'form.topmap'};
+
+ my $enrollstart = &Apache::lonhtmlcommon::get_date_from_form('startenroll');
+ my $enrollend = &Apache::lonhtmlcommon::get_date_from_form('endenroll');
+ my $startaccess = &Apache::lonhtmlcommon::get_date_from_form('startaccess');
+ my $endaccess = &Apache::lonhtmlcommon::get_date_from_form('endaccess');
+
+ my $autharg;
+ my $authtype;
+
+ if ($ENV{'form.login'} eq 'krb') {
+ $authtype = 'krb';
+ $authtype .=$ENV{'form.krbver'};
+ $autharg = $ENV{'form.krbarg'};
+ } elsif ($ENV{'form.login'} eq 'int') {
+ $authtype ='internal';
+ if ((defined($ENV{'form.intarg'})) && ($ENV{'form.intarg'})) {
+ $autharg = $ENV{'form.intarg'};
+ }
+ } elsif ($ENV{'form.login'} eq 'loc') {
+ $authtype = 'localauth';
+ if ((defined($ENV{'form.locarg'})) && ($ENV{'form.locarg'})) {
+ $autharg = $ENV{'form.locarg'};
+ }
+ }
+
+ my $logmsg;
my $bodytag=&Apache::loncommon::bodytag('Create a New Course');
$r->print(<<ENDENHEAD);
<html>
@@ -583,6 +605,44 @@
</head>
$bodytag
ENDENHEAD
+
+ my $args = {
+ ccuname => $ccuname,
+ ccdomain => $ccdomain,
+ cdescr => $ENV{'form.title'},
+ curl => $ENV{'form.topmap'},
+ course_domain => $ENV{'request.role.domain'},
+ course_home => $ENV{'form.course_home'},
+ nonstandard => $ENV{'form.nonstandard'},
+ crscode => $ENV{'form.crscode'},
+ clonecourse => $ENV{'form.clonecourse'},
+ clonedomain => $ENV{'form.clonedomain'},
+ crsid => $ENV{'form.crsid'},
+ curruser => $ENV{'user.name'},
+ crssections => $ENV{'form.crssections'},
+ crsxlist => $ENV{'form.crsxlist'},
+ autoadds => $ENV{'form.autoadds'},
+ autodrops => $ENV{'form.autodrops'},
+ notify => $ENV{'form.notify'},
+ no_end_date => $ENV{'form.no_end_date'},
+ showphotos => $ENV{'form.showphotos'},
+ authtype => $authtype,
+ autharg => $autharg,
+ enrollstart => $enrollstart,
+ enrollend => $enrollend,
+ startaccess => $startaccess,
+ endaccess => $endaccess,
+ setpolicy => $ENV{'form.setpolicy'},
+ setcontent => $ENV{'form.setcontent'},
+ reshome => $ENV{'form.reshome'},
+ setkeys => $ENV{'form.setkeys'},
+ keyauth => $ENV{'form.keyauth'},
+ disresdis => $ENV{'form.disresdis'},
+ disablechat => $ENV{'form.disablechat'},
+ openall => $ENV{'form.openall'},
+ firstres => $ENV{'form.firstres'}
+ };
+
#
# Verify data
#
@@ -608,45 +668,79 @@
$ENV{'form.course_home'}.'</body></html>');
return;
}
+ my ($courseid,$crsudom,$crsunum);
+ $r->print(&construct_course($args,\$logmsg,\$courseid,\$crsudom,\$crsunum));
+
+#
+# Make current user course adminstrator
+#
+ my $end=undef;
+ my $addition='';
+ if ($ENV{'form.expireown'}) { $end=time+5; $addition='expired'; }
+ $r->print(&mt('Assigning').' '.$addition.' '.&mt('role of course coordinator to self').': '.
+ &Apache::lonnet::assignrole(
+ $ENV{'user.domain'},$ENV{'user.name'},$courseid,'cc',$end).'<br>');
+#
+# Make additional user course administrator
+#
+ if (($ccdomain) && ($ccuname)) {
+ $r->print(&mt('Assigning role of course coordinator to').' '.
+ $ccuname.' at '.$ccdomain.': '.
+ &Apache::lonnet::assignrole($ccdomain,$ccuname,$courseid,'cc').'<p>');
+ }
+ if ($ENV{'form.setkeys'}) {
+ $r->print(
+ '<p><a href="/adm/managekeys?cid='.$crsudom.'_'.$crsunum.'">'.&mt('Manage Access Keys').'</a></p>');
+ }
+# Flush the course logs so reverse user roles immediately updated
+ &Apache::lonnet::flushcourselogs();
+ $r->print('<p>'.&mt('Roles will be active at next login').'.</p></body></html>');
+}
+
+sub construct_course {
+ my ($args,$logmsg,$courseid,$crsudom,$crsunum) = @_;
+ my $outcome;
+
#
# Open course
#
my %cenv=();
- my $courseid=&Apache::lonnet::createcourse($ENV{'request.role.domain'},
- $cdescr,$curl,
- $ENV{'form.course_home'},
- $ENV{'form.nonstandard'},
- $ENV{'form.crscode'},
- $ENV{'form.ccuname'});
+ $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
+ $args->{'cdescr'},
+ $args->{'curl'},
+ $args->{'course_home'},
+ $args->{'nonstandard'},
+ $args->{'crscode'},
+ $args->{'ccuname'});
# 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.
- $r->print('New LON-CAPA Course ID: '.$courseid.'<br>');
+ $outcome .= 'New LON-CAPA Course ID: '.$$courseid.'<br>';
#
# Check if created correctly
#
- my ($crsudom,$crsunum)=($courseid=~/^\/(\w+)\/(\w+)$/);
- my $crsuhome=&Apache::lonnet::homeserver($crsunum,$crsudom);
- $r->print(&mt('Created on').': '.$crsuhome.'<br>');
+ ($$crsudom,$$crsunum)=($$courseid=~/^\/(\w+)\/(\w+)$/);
+ my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
+ $outcome .= &mt('Created on').': '.$crsuhome.'<br>';
#
# Are we cloning?
#
my $cloneid='';
- if (($ENV{'form.clonecourse'}) && ($ENV{'form.clonedomain'})) {
- $cloneid='/'.$ENV{'form.clonedomain'}.'/'.$ENV{'form.clonecourse'};
+ if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
+ $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
my ($clonecrsudom,$clonecrsunum)=($cloneid=~/^\/(\w+)\/(\w+)$/);
my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
if ($clonehome eq 'no_host') {
- $r->print(
- '<br /><font color="red">'.&mt('Attempting to clone non-existing course').' '.$cloneid.'</font>');
+ $outcome .=
+ '<br /><font color="red">'.&mt('Attempting to clone non-existing course').' '.$cloneid.'</font>';
} else {
- $r->print(
- '<br /><font color="green">'.&mt('Cloning course from').' '.$clonehome.'</font>');
- my %oldcenv=&Apache::lonnet::dump('environment',$crsudom,$crsunum);
+ $outcome .=
+ '<br /><font color="green">'.&mt('Cloning course from').' '.$clonehome.'</font>';
+ my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
# Copy all files
- ©coursefiles($cloneid,$courseid);
+ ©coursefiles($cloneid,$$courseid);
# Restore URL
$cenv{'url'}=$oldcenv{'url'};
# Restore title
@@ -666,30 +760,30 @@
#
my @sections = ();
my @xlists = ();
- if ($ENV{'form.crsid'}) {
- $cenv{'courseid'}=$ENV{'form.crsid'};
+ if ($args->{'crsid'}) {
+ $cenv{'courseid'}=$args->{'crsid'};
}
- if ($ENV{'form.crscode'}) {
- $cenv{'internal.coursecode'}=$ENV{'form.crscode'};
+ if ($args->{'crscode'}) {
+ $cenv{'internal.coursecode'}=$args->{'crscode'};
}
- if ($ccuname) {
- $cenv{'internal.courseowner'} = $ccuname;
+ if ($args->{'ccuname'}) {
+ $cenv{'internal.courseowner'} = $args->{'ccuname'};
} else {
- $cenv{'internal.courseowner'} = $ENV{'user.name'};
+ $cenv{'internal.courseowner'} = $args->{'curruser'};
}
my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
- if ($ENV{'form.crssections'}) {
+ if ($args->{'crssections'}) {
$cenv{'internal.sectionnums'} = '';
- if ($ENV{'form.crssections'} =~ m/,/) {
- @sections = split/,/,$ENV{'form.crssections'};
+ if ($args->{'crssections'} =~ m/,/) {
+ @sections = split/,/,$args->{'crssections'};
} else {
- $sections[0] = $ENV{'form.crssections'};
+ $sections[0] = $args->{'crssections'};
}
if (@sections > 0) {
foreach my $item (@sections) {
my ($sec,$gp) = split/:/,$item;
- my $class = $ENV{'form.crscode'}.$sec;
+ 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') {
@@ -701,18 +795,19 @@
}
# do not hide course coordinator from staff listing,
# even if privileged
- $cenv{'nothideprivileged'}=$ccuname.':'.$ccdomain;
- if ($ENV{'form.crsxlist'}) {
+ $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
+# add crosslistings
+ if ($args->{'crsxlist'}) {
$cenv{'internal.crosslistings'}='';
- if ($ENV{'form.crsxlist'} =~ m/,/) {
- @xlists = split/,/,$ENV{'form.crsxlist'};
+ if ($args->{'crsxlist'} =~ m/,/) {
+ @xlists = split/,/,$args->{'crsxlist'};
} else {
- $xlists[0] = $ENV{'form.crsxlist'};
+ $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'});
+ my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
$cenv{'internal.crosslistings'} .= $item.',';
unless ($addcheck eq 'ok') {
push @badclasses, $xl;
@@ -721,15 +816,15 @@
$cenv{'internal.crosslistings'} =~ s/,$//;
}
}
- if ($ENV{'form.autoadds'}) {
- $cenv{'internal.autoadds'}=$ENV{'form.autoadds'};
+ if ($args->{'autoadds'}) {
+ $cenv{'internal.autoadds'}=$args->{'autoadds'};
}
- if ($ENV{'form.autodrops'}) {
- $cenv{'internal.autodrops'}=$ENV{'form.autodrops'};
+ if ($args->{'autodrops'}) {
+ $cenv{'internal.autodrops'}=$args->{'autodrops'};
}
- if ($ENV{'form.notify'}) {
- if ($ccuname) {
- $cenv{'internal.notifylist'} = $ccuname.'@'.$ccdomain;
+ if ($args->{'notify'}) {
+ if ($args->{'ccuname'}) {
+ $cenv{'internal.notifylist'} = $args->{'ccuname'}.'@'.$args->{'ccdomain'};
}
}
if (@badclasses > 0) {
@@ -738,78 +833,61 @@
'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'
);
- $r->print('<font color="red">'.$lt{'tclb'}.' ('.$cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.' ('.$lt{'adby'}.').<br /><ul>'."\n");
+ $outcome .= '<font color="red">'.$lt{'tclb'}.' ('.$cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.' ('.$lt{'adby'}.').<br /><ul>'."\n";
foreach (@badclasses) {
- $r->print("<li>$_</li>\n");
+ $outcome .= "<li>$_</li>\n";
}
- $r->print ("</ul><br /><br /></font>\n");
- }
- my $enrollstart = &Apache::lonhtmlcommon::get_date_from_form('startenroll');
- my $enrollend = &Apache::lonhtmlcommon::get_date_from_form('endenroll');
- my $startaccess = &Apache::lonhtmlcommon::get_date_from_form('startaccess');
- my $endaccess = &Apache::lonhtmlcommon::get_date_from_form('endaccess');
- if ($ENV{'form.no_end_date'}) {
- $endaccess = 0;
+ $outcome .= "</ul><br /><br /></font>\n";
}
- $cenv{'internal.autostart'}=$enrollstart;
- $cenv{'internal.autoend'}=$enrollend;
- $cenv{'default_enrollment_start_date'}=$startaccess;
- $cenv{'default_enrollment_end_date'}=$endaccess;
- if ($ENV{'form.showphotos'}) {
- $cenv{'internal.showphotos'}=$ENV{'form.showphotos'};
+ if ($args->{'no_end_date'}) {
+ $args->{'endaccess'} = 0;
}
- if ($ENV{'form.login'} eq 'krb') {
- $cenv{'internal.authtype'} = 'krb';
- $cenv{'internal.authtype'} .=$ENV{'form.krbver'};
- $cenv{'internal.autharg'} = $ENV{'form.krbarg'};
- } elsif ($ENV{'form.login'} eq 'int') {
- $cenv{'internal.authtype'} ='internal';
- if ((defined($ENV{'form.intarg'})) && ($ENV{'form.intarg'})) {
- $cenv{'internal.autharg'} = $ENV{'form.intarg'};
- }
- } elsif ($ENV{'form.login'} eq 'loc') {
- $cenv{'internal.authtype'} = 'localauth';
- if ((defined($ENV{'form.locarg'})) && ($ENV{'form.locarg'})) {
- $cenv{'internal.autharg'} = $ENV{'form.locarg'};
- }
+ $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 '') {
- $r->print('<font color="red" size="+1">'.
- &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').'</font></p>');
+ $outcome .= '<font color="red" size="+1">'.
+ &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').'</font></p>';
}
}
- if (($ccdomain) && ($ccuname)) {
- if ($ENV{'form.setpolicy'}) {
- $cenv{'policy.email'}=$ccuname.':'.$ccdomain;
+ if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
+ if ($args->{'setpolicy'}) {
+ $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
}
- if ($ENV{'form.setcontent'}) {
- $cenv{'question.email'}=$ccuname.':'.$ccdomain;
+ if ($args->{'setcontent'}) {
+ $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
}
}
- if ($ENV{'form.reshome'}) {
- $cenv{'reshome'}=$ENV{'form.reshome'}.'/';
+ if ($args->{'reshome'}) {
+ $cenv{'reshome'}=$args->{'reshome'}.'/';
$cenv{'reshome'}=~s/\/+$/\//;
}
#
# course has keyed access
#
- if ($ENV{'form.setkeys'}) {
+ if ($args->{'setkeys'}) {
$cenv{'keyaccess'}='yes';
}
# if specified, key authority is not course, but user
# only active if keyaccess is yes
- if ($ENV{'form.keyauth'}) {
- $ENV{'form.keyauth'}=~s/[^\w\@]//g;
- if ($ENV{'form.keyauth'}) {
- $cenv{'keyauth'}=$ENV{'form.keyauth'};
+ if ($args->{'keyauth'}) {
+ $args->{'keyauth'}=~s/[^\w\@]//g;
+ if ($args->{'keyauth'}) {
+ $cenv{'keyauth'}=$args->{'keyauth'};
}
}
- if ($ENV{'form.disresdis'}) {
+ if ($args->{'disresdis'}) {
$cenv{'pch.roles.denied'}='st';
}
- if ($ENV{'form.disablechat'}) {
+ if ($args->{'disablechat'}) {
$cenv{'plc.roles.denied'}='st';
}
@@ -830,65 +908,42 @@
# By default, use standard grading
if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
- $r->print('<br />'.&mt('Setting environment').': '.
- &Apache::lonnet::put('environment',\%cenv,$crsudom,$crsunum).'<br>');
+ $outcome .= ('<br />'.&mt('Setting environment').': '.
+ &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).'<br>');
#
# Open all assignments
#
- if ($ENV{'form.openall'}) {
- my $storeunder=$crsudom.'_'.$crsunum.'.0.opendate';
+ if ($args->{'openall'}) {
+ my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
my %storecontent = ($storeunder => time,
$storeunder.'.type' => 'date_start');
- $r->print(&mt('Opening all assignments').': '.&Apache::lonnet::cput
- ('resourcedata',\%storecontent,$crsudom,$crsunum).'<br>');
+ $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
+ ('resourcedata',\%storecontent,$$crsudom,$$crsunum).'<br>';
}
#
# Set first page
#
- unless (($ENV{'form.nonstandard'}) || ($ENV{'form.firstres'} eq 'blank')
+ unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
|| ($cloneid)) {
- $r->print(&mt('Setting first resource').': ');
+ $outcome .= &mt('Setting first resource').': ';
my ($errtext,$fatal)=
- &Apache::londocs::mapread($crsunum,$crsudom,'default.sequence');
- $r->print(($fatal?$errtext:'read ok').' - ');
+ &Apache::londocs::mapread($$crsunum,$$crsudom,'default.sequence');
+ $outcome .= ($fatal?$errtext:'read ok').' - ';
my $title; my $url;
- if ($ENV{'form.firstres'} eq 'syl') {
+ if ($args->{'firstres'} eq 'syl') {
$title='Syllabus';
- $url='/public/'.$crsudom.'/'.$crsunum.'/syllabus';
+ $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
} else {
$title='Navigate Contents';
$url='/adm/navmaps';
}
$Apache::lonratedt::resources[1]=$title.':'.$url.':false:start:res';
($errtext,$fatal)=
- &Apache::londocs::storemap($crsunum,$crsudom,'default.sequence');
- $r->print(($fatal?$errtext:'write ok').'<br>');
- }
-#
-# Make current user course adminstrator
-#
- my $end=undef;
- my $addition='';
- if ($ENV{'form.expireown'}) { $end=time+5; $addition='expired'; }
- $r->print(&mt('Assigning').' '.$addition.' '.&mt('role of course coordinator to self').': '.
- &Apache::lonnet::assignrole(
- $ENV{'user.domain'},$ENV{'user.name'},$courseid,'cc',$end).'<br>');
-#
-# Make additional user course administrator
-#
- if (($ccdomain) && ($ccuname)) {
- $r->print(&mt('Assigning role of course coordinator to').' '.
- $ccuname.' at '.$ccdomain.': '.
- &Apache::lonnet::assignrole($ccdomain,$ccuname,$courseid,'cc').'<p>');
- }
- if ($ENV{'form.setkeys'}) {
- $r->print(
- '<p><a href="/adm/managekeys?cid='.$crsudom.'_'.$crsunum.'">'.&mt('Manage Access Keys').'</a></p>');
+ &Apache::londocs::storemap($$crsunum,$$crsudom,'default.sequence');
+ $outcome .= ($fatal?$errtext:'write ok').'<br>';
}
-# Flush the course logs so reverse user roles immediately updated
- &Apache::lonnet::flushcourselogs();
- $r->print('<p>'.&mt('Roles will be active at next login').'.</p></body></html>');
+ return $outcome;
}
# ===================================================================== Handler
--raeburn1102548450--