--- loncom/interface/lonmodifycourse.pm 2003/12/28 01:37:02 1.2 +++ loncom/interface/lonmodifycourse.pm 2006/07/11 02:28:22 1.26 @@ -1,3 +1,30 @@ +# The LearningOnline Network with CAPA +# automated enrollment course setup handler +# +# $Id: lonmodifycourse.pm,v 1.26 2006/07/11 02:28:22 raeburn Exp $ +# +# Copyright Michigan State University Board of Trustees +# +# This file is part of the LearningOnline Network with CAPA (LON-CAPA). +# +# LON-CAPA is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# LON-CAPA is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with LON-CAPA; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# /home/httpd/html/adm/gpl.txt +# +# http://www.lon-capa.org/ +# package Apache::lonmodifycourse; use strict; @@ -8,11 +35,11 @@ use Apache::lonlocal; use Apache::londropadd; use LONCAPA::Enrollment; use lib '/home/httpd/lib/perl'; -use localenroll; +use LONCAPA; sub print_course_selection_page { my ($r,$tasklongref) = @_; - my $dom = $ENV{'user.domain'}; + my $dom = $env{'request.role.domain'}; my %lt=&Apache::lonlocal::texthash( 'csae' => "Course settings for automated enrollment", 'unst' => "Unlike standard LON-CAPA course parameters, such as course description, feedback addresses, and top level map, which are displayed and/or modified using the 'Course Environment Parameters' screen, settings that control automated enrollment based on classlist data available from your institution's student information system are handled differently. Automated enrollment settings fall into two groups: (a) settings that can be modified by a Course Coordinator using the Automated Enrollment Manager and (b) settings that may only be modified by a Domain Coordinator via the 'View/Modify Course settings' menu accessed from this page.", @@ -24,11 +51,11 @@ sub print_course_selection_page { ); # Determine the courses - my %courseIDs = &Apache::lonnet::courseiddump($dom,'.',1); + my %courseIDs = &Apache::lonnet::courseiddump($dom,'.',1,'.','.','.',undef,undef,'.'); &print_header($r,$tasklongref); $r->print(< -

$lt{'csae'}

+

$lt{'csae'}

$lt{'unst'}

$lt{'chcs'}
$lt{'eaen'} @@ -44,23 +71,19 @@ ENDBLOCK foreach my $key (sort keys %courseIDs) { # Get current code my $crs; - my $currcode; - if ($key =~ m/^($dom)_(\w+)$/) { + my ($description,$currcode,$owner); + if ($courseIDs{$key} =~ m/^([^:]*):([^:]+)/ ) { + $currcode = $2; + } elsif ($key =~ m/^($dom)_(\w+)$/) { $crs = $2; my %settings = &Apache::lonnet::get('environment',['internal.coursecode'],$dom,$crs); if (defined($settings{'internal.coursecode'}) ) { $currcode = $settings{'internal.coursecode'}; - if ($currcode eq '') { - $currcode = "___".$iter; - $iter ++; - } - } else { - $currcode = "___".$iter; - $iter ++; } - } else { + } + if ($currcode eq '') { $currcode = "___".$iter; - $iter ++; + $iter ++; } unless (grep/^$currcode$/,@codes) { push @codes,$currcode; @@ -78,12 +101,35 @@ ENDBLOCK unless ($code =~m/^___\d+$/) { $showcode = $code; } if ($item =~ m/^($dom)_(\w+)$/) { $crs = $2; - $description = $courseIDs{$item}; + if ($courseIDs{$item} =~ /^([^:]*):([^:]*):([^:]*)/) { + $description = &unescape($1); + $owner = &unescape($3); + if (($owner ne '') && ($owner !~ /^([^:]+):([^:]+)$/)) { + $owner = $owner.':'.$dom; + } + } elsif ($courseIDs{$item} =~ /^([^:]*):([^:]*)$/) { + $description = &unescape($1); + } else { + $description = &unescape($courseIDs{$item}); + } # Get course owner - my %settings = &Apache::lonnet::get('environment',['internal.courseowner'],$dom,$crs); - if ( defined($settings{'internal.courseowner'}) ) { - $owner = $settings{'internal.courseowner'}; - $ownername = &Apache::loncommon::plainname($owner,$dom); + if ($owner eq '') { + my %settings = &Apache::lonnet::get('environment',['internal.courseowner'],$dom,$crs); + if ( defined($settings{'internal.courseowner'}) ) { + $owner = $settings{'internal.courseowner'}; + } + } + unless ($owner eq '') { + my ($owneruname,$ownerdom); + if ($owner =~ /^([^:]+):([^:]+)$/) { + $owneruname = $1; + $ownerdom = $2; + } else { + $owneruname = $owner; + $ownerdom = $dom; + } + $ownername = &Apache::loncommon::plainname($owneruname, + $ownerdom); } $r->print("

$lt{'aecs'}

+

$lt{'aecs'}

$lt{'cose'}$lt{'aenm'}$lt{'andb'}

@@ -377,12 +473,21 @@ $disp_table
ENDDOCUMENT &print_footer($r); + return; } sub modify_course { my ($r,$tasklongref,$typeref) = @_; - my $dom = $ENV{'user.domain'}; - my $crs = $ENV{'form.course'}; + my $dom = $env{'user.domain'}; + my $crs = $env{'form.course'}; + unless ( &check_course($dom,$crs) eq 'ok' ) { + &print_header($r,$tasklongref); + my $reply = "
".&mt("The LON-CAPA course selected was not a valid course for this domain"); + $r->print($reply); + &print_footer($r); + return; + } + my %settings = &Apache::lonnet::get('environment',['internal.courseowner','internal.coursecode','internal.authtype','internal.autharg','internal.sectionnums','internal.crosslistings','description'],$dom,$crs); my %currattr = (); my %newattr = (); @@ -422,20 +527,19 @@ sub modify_course { my $description = $settings{'description'}; my %cenv = (); - if ($ENV{'form.login'} eq 'krb') { - $newattr{'authtype'} = $ENV{'form.login'}; - $newattr{'authtype'} .= $ENV{'form.krbver'}; - $newattr{'autharg'} = $ENV{'form.krbarg'}; - $newattr{'autharg'} =~ tr/a-z/A-Z/; - } elsif ($ENV{'form.login'} eq 'int') { + if ($env{'form.login'} eq 'krb') { + $newattr{'authtype'} = $env{'form.login'}; + $newattr{'authtype'} .= $env{'form.krbver'}; + $newattr{'autharg'} = $env{'form.krbarg'}; + } elsif ($env{'form.login'} eq 'int') { $newattr{'authtype'} ='internal'; - if ((defined($ENV{'form.intarg'})) && ($ENV{'form.intarg'})) { - $newattr{'autharg'} = $ENV{'form.intarg'}; + if ((defined($env{'form.intarg'})) && ($env{'form.intarg'})) { + $newattr{'autharg'} = $env{'form.intarg'}; } - } elsif ($ENV{'form.login'} eq 'loc') { + } elsif ($env{'form.login'} eq 'loc') { $newattr{'authtype'} = 'localauth'; - if ((defined($ENV{'form.locarg'})) && ($ENV{'form.locarg'})) { - $newattr{'autharg'} = $ENV{'form.locarg'}; + if ((defined($env{'form.locarg'})) && ($env{'form.locarg'})) { + $newattr{'autharg'} = $env{'form.locarg'}; } } if ( $newattr{'authtype'}=~ /^krb/) { @@ -445,22 +549,23 @@ sub modify_course { } } - if ( exists($ENV{'form.courseowner'}) ) { - my $ownerparam = 'username_'.$ENV{'form.courseowner'}; - if ( exists($ENV{"form.$ownerparam"}) ) { - $newattr{'courseowner'}=$ENV{"form.$ownerparam"}; - unless ( $newattr{'courseowner'} eq $currattr{'courseowner'} ) { - $changeowner = 1; - } + if ( exists($env{'form.courseowner'}) ) { + $newattr{'courseowner'}=$env{'form.courseowner'}; + unless ( $newattr{'courseowner'} eq $currattr{'courseowner'} ) { + $changeowner = 1; } } - if ( exists($ENV{'form.coursecode'}) ) { - $newattr{'coursecode'}=$ENV{'form.coursecode'}; + if ( exists($env{'form.coursecode'}) ) { + $newattr{'coursecode'}=$env{'form.coursecode'}; unless ( $newattr{'coursecode'} eq $currattr{'coursecode'} ) { $changecode = 1; } } + if ($changeowner == 1 || $changecode == 1) { + my $courseid_entry = &escape($dom.'_'.$crs).'='.&escape($description).':'.&escape($env{'form.coursecode'}).':'.&escape($env{'form.courseowner'}); + &Apache::lonnet::courseidput($dom,$courseid_entry,&Apache::lonnet::homeserver($crs,$dom)); + } foreach (@params) { if ($currattr{$_} eq $newattr{$_}) { @@ -498,12 +603,10 @@ sub modify_course { if ($changecode) { foreach my $sec (@sections) { if ($sec =~ m/^(.+):/) { - my $course_id = $newattr{'coursecode'}.$1; -# my $course_check = &localenroll::validate_courseID($course_id); - my $course_check = 'ok'; - if ($course_check eq 'ok') { -# my $outcome = &localenroll::new_course($course_id,$newattr{'courseowner'}); - my $outcome = 'ok'; + my $inst_course_id = $newattr{'coursecode'}.$1; + my $course_check = &Apache::lonnet::auto_validate_courseID($crs,$dom,$inst_course_id); + if ($course_check eq 'ok') { + my $outcome = &Apache::lonnet::auto_new_course($crs,$dom,$inst_course_id,$newattr{'courseowner'}); unless ($outcome eq 'ok') { $warning .= &mt("If automatic enrollment is enabled for LON-CAPA course: ").$description.&mt(", automated enrollment may fail for ").$newattr{'coursecode'}.&mt(" - section $1 for the following reason: $outcome.
"); } @@ -514,15 +617,26 @@ sub modify_course { $warning .= &mt("If automatic enrollment is enabled for LON-CAPA course: ").$description.&mt(", automated enrollment may fail for ").$newattr{'coursecode'}.&mt(" - section $sec because this is not a valid section entry.
"); } } - } + } elsif ($changeowner) { + foreach my $sec (@sections) { + if ($sec =~ m/^(.+):/) { + my $inst_course_id = $newattr{'coursecode'}.$1; + my $outcome = &Apache::lonnet::auto_new_course($crs,$dom,$inst_course_id,$newattr{'courseowner'}); + unless ($outcome eq 'ok') { + $warning .= &mt("If automatic enrollment is enabled for LON-CAPA course: ").$description.&mt(", automated enrollment may fail for ").$newattr{'coursecode'}.&mt(" - section $1 for the following reason: $outcome.
"); + } + } else { + $warning .= &mt("If automatic enrollment is enabled for LON-CAPA course: ").$description.&mt(", automated enrollment may fail for ").$newattr{'coursecode'}.&mt(" - section $sec because this is not a valid section entry.
"); + } + } + } } else { $warning .= &mt("As no section numbers are currently listed for LON-CAPA course: ").$description.&mt(", automated enrollment will not occur for any sections of coursecode: ").$newattr{'coursecode'}."
"; } if ( (@xlists > 0) && ($changeowner) ) { foreach my $xlist (@xlists) { if ($xlist =~ m/^(.+):/) { -# my $outcome = &localenroll::new_course($1,$newattr{'courseowner'}); - my $outcome = 'ok'; + my $outcome = &Apache::lonnet::auto_new_course($crs,$dom,$1,$newattr{'courseowner'}); unless ($outcome eq 'ok') { $warning .= &mt("If automatic enrollment is enabled for LON-CAPA course: ").$description.&mt(", automated enrollment may fail for crosslisted class: ").$1.&mt(" for the following reason: $outcome.
"); } @@ -534,7 +648,7 @@ sub modify_course { } } else { foreach my $attr (@params) { - $nochgresponse .= "
  • $$typeref{$attr} ".&mt("still set to \"").$currattr{$attr}."\".
    • "; + $nochgresponse .= "
  • $$typeref{$attr} ".&mt("still set to")." \"".$currattr{$attr}."\".
    • "; } } @@ -554,7 +668,8 @@ sub modify_course { $reply = $response; } &print_header($r,$tasklongref,$description); - $r->print("
    $reply
    ".$reply."
    "; + $r->print($reply); &print_footer($r); return; } @@ -562,44 +677,40 @@ sub modify_course { sub print_header { my ($r,$tasklongref,$description,$javascriptref) = @_; my %lt =&Apache::lonlocal::texthash( - 'vmcs' => 'View/Modify Course Settings', 'chco' => 'Choose a course', 'main' => 'Main Menu', 'comg' => 'Course Manager', ); my $action = "start"; - if ( exists($ENV{'form.action'}) ) { - $action = $ENV{'form.action'}; + if ( exists($env{'form.action'}) ) { + $action = $env{'form.action'}; } if ( ($description eq '') || (!defined($description)) ) { $description = $lt{'comg'}; } my $page = ''; - my $bodytag=&Apache::loncommon::bodytag($lt{'vmcs'}); + if ($action eq 'start') { $page = "$lt{'chco'}"; } else { $page = ''.$lt{'chco'}.''; if ( $action eq 'process' ) { - my $course = $ENV{'form.course'}; + my $course = $env{'form.course'}; $page .= "-> ".$$tasklongref{'display'}." -> $$tasklongref{$action} "; } else { $page .= " -> ".$$tasklongref{$action}.""; } } - $r->print(" - -"); + + my $js; if ($action eq 'display') { - $r->print(" -"); + $js = ''; } + $r->print(&Apache::loncommon::start_page('View/Modify Course Settings', + $js)); $r->print(<The LearningOnline Network with CAPA - -$bodytag
    @@ -611,15 +722,26 @@ $bodytag
    ENDTHIS + return; } sub print_footer { - my $r = shift; - $r->print(< - - -ENDBASE + my ($r) = @_; + $r->print('
    '.&Apache::loncommon::end_page()); + return; +} + +sub check_course { + my ($dom,$course) = @_; + my %courseIDs = &Apache::lonnet::courseiddump($dom,'.',1,'.','.','.',undef,undef,'.'); + foreach my $key (sort keys %courseIDs) { + if ($key =~ m/^($dom)_(\w+)$/) { + if ($2 eq $course) { + return 'ok'; + } + } + } + return 'invalid course'; } @@ -631,21 +753,23 @@ sub handler { return OK; } - if (&Apache::lonnet::allowed('ccc',$ENV{'request.role.domain'})) { + if (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'})) { &Apache::loncommon::content_type($r,'text/html'); $r->send_http_header; &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['action','course']); - my $dom = $ENV{'user.domain'}; + my $dom = $env{'user.domain'}; my %longtype=&Apache::lonlocal::texthash( 'authtype' => 'Default authentication method', 'autharg' => 'Default authentication parameter', 'autoadds' => 'Automated adds', 'autodrops' => 'Automated drops', - 'autostart' => 'Date of first enrollment', - 'autoend' => 'Date of last enrollment', + 'autostart' => 'Date of first automated enrollment', + 'autoend' => 'Date of last automated enrollment', + 'default_enrollment_start_date' => 'Date of first student access', + 'default_enrollment_end_date' => 'Date of last student access', 'coursecode' => 'Official course code', - 'courseowner' => "Username of course owner (\@$dom)", + 'courseowner' => "Username:domain of course owner", 'notifylist' => 'Course Coordinators to be notified of enrollment changes', 'sectionnums' => 'Course section number(:groupID)', 'crosslistings' => 'Crosslisted class(:groupID)', @@ -656,15 +780,15 @@ sub handler { 'process' => 'Results of changes', ); - if ($ENV{'form.action'} eq 'process') { + if ($env{'form.action'} eq 'process') { &modify_course($r,\%tasklong,\%longtype); - } elsif ($ENV{'form.action'} eq 'display') { + } elsif ($env{'form.action'} eq 'display') { &print_course_modification_page($r,\%tasklong,\%longtype); } else { &print_course_selection_page($r,\%tasklong); } } else { - $ENV{'user.error.msg'}= + $env{'user.error.msg'}= "/adm/modifycourse:ccc:0:0:Cannot modify course settings"; return HTTP_NOT_ACCEPTABLE; }