--- loncom/interface/lonrequestcourse.pm 2009/08/06 20:40:59 1.7 +++ loncom/interface/lonrequestcourse.pm 2009/08/12 12:40:33 1.10 @@ -1,7 +1,7 @@ # The LearningOnline Network # Request a course # -# $Id: lonrequestcourse.pm,v 1.7 2009/08/06 20:40:59 raeburn Exp $ +# $Id: lonrequestcourse.pm,v 1.10 2009/08/12 12:40:33 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -55,6 +55,7 @@ use Apache::Constants qw(:common :http); use Apache::lonnet; use Apache::loncommon; use Apache::lonlocal; +use Apache::loncoursequeueadmin; use LONCAPA qw(:DEFAULT :match); sub handler { @@ -113,13 +114,14 @@ sub handler { } my %trail = ( - crstype => 'Course Request Action', - codepick => 'Category', - courseinfo => 'Description', - enrollment => 'Enrollment', - personnel => 'Personnel', - review => 'Review', - process => 'Result', + crstype => 'Course Request Action', + codepick => 'Category', + courseinfo => 'Description', + enrollment => 'Enrollment', + personnel => 'Personnel', + review => 'Review', + process => 'Result', + pick_request => 'Display Summary', ); my $page = 0; @@ -178,7 +180,11 @@ sub handler { ''.&Apache::loncommon::end_page()); } } elsif ($action eq 'view') { - &print_request_status($jscript,$loaditems,$crumb); + if ($state eq 'crstype') { + &print_main_menu($r,\%can_request,\%states,$dom,$jscript,'',$crumb); + } elsif ($state eq 'pick_request') { + $r->print(&print_request_status($dom,$crumb)); + } } elsif ($action eq 'log') { &print_request_logs($jscript,$loaditems,$crumb); } else { @@ -469,7 +475,7 @@ END '
'. '
'. &Apache::lonhtmlcommon::start_pick_box(). - &Apache::lonhtmlcommon::row_title('Domain'). + &Apache::lonhtmlcommon::row_title('Course Domain'). &Apache::loncommon::select_dom_form($dom,'showdom','',1,$onchange)); if (!$onchange) { $r->print(' print(&header('Request a course',$js.$jscript,$loaditems,$jsextra).$crumb); - if ($state eq 'process') { - &print_request_outcome($r,$state,$dom); - } else { - &print_request_form($r,$action,$state,$page,$states,$dom); - } + &print_request_form($r,$action,$state,$page,$states,$dom); } elsif ($action eq 'view') { $r->print(&header('Manage course requests',$js.$jscript,$loaditems).$crumb); } elsif ($action eq 'log') { @@ -557,7 +559,7 @@ sub print_request_form { $prev = $states->{$action}[$page-1]; $next = $states->{$action}[$page+1]; my %navtxt = &Apache::lonlocal::texthash ( - prev => 'Previous', + prev => 'Back', next => 'Next', ); $crstype = $env{'form.crstype'}; @@ -632,13 +634,19 @@ sub print_request_form { $r->print(&print_enrollment_menu($formname,$instcode,$dom,\@codetitles, \%cat_titles,\%cat_order,\@code_order)); } elsif ($state eq 'personnel') { - $r->print(&print_personnel_menu($dom,$formname)); + $r->print(&print_personnel_menu($dom,$formname,$crstype)); } elsif ($state eq 'review') { &Apache::lonnet::auto_possible_instcodes($dom,\@codetitles,\%cat_titles, \%cat_order,\@code_order); $r->print(&print_review($formname,$dom,\@codetitles,\%cat_titles,\%cat_order, \@code_order)); $navtxt{'next'} = &mt('Submit course request'); + } elsif ($state eq 'process') { + if ($crstype eq 'official') { + &Apache::lonnet::auto_possible_instcodes($dom,\@codetitles,\%cat_titles, + \%cat_order,\@code_order); + } + my $result = &print_request_outcome($dom,\@codetitles,\@code_order); } my @excluded = ('counter'); my %elements = &form_elements($dom); @@ -797,7 +805,7 @@ sub date_setting_table { } sub print_personnel_menu { - my ($dom,$formname) = @_; + my ($dom,$formname,$crstype) = @_; my $output = '
'.&Apache::lonhtmlcommon::start_pick_box(); my $persontotal = $env{'form.persontotal'}; if (!defined($persontotal)) { @@ -811,8 +819,12 @@ sub print_personnel_menu { my $roleoptions; my @roles = &Apache::lonuserutils::roles_by_context('course'); + my $type = 'Course'; + if ($crstype eq 'community') { + $type = 'Community'; + } foreach my $role (@roles) { - my $plrole=&Apache::lonnet::plaintext($role); + my $plrole=&Apache::lonnet::plaintext($role,$type); $roleoptions .= ' '."\n"; } my %customroles=&Apache::lonuserutils::my_custom_roles(); @@ -908,10 +920,101 @@ sub print_personnel_menu { } sub print_request_status { - return; + my ($dom,$crumb) = @_; + my $js = < $b} (keys(%queue_by_date)); + $output .= ''."\n". + ''."\n". + ''."\n". + ''."\n"; + if (@sortedtimes > 0) { + $output .= &Apache::loncommon::start_data_table(). + &Apache::loncommon::start_data_table_header_row(). + ''.&mt('Action').''. + ''.&mt('Description').''; + if ($env{'form.crstype'} eq 'all') { + $output .= ''.&mt('Type').''; + } + if (($env{'form.crstype'} eq 'all') || ($env{'form.crstype'} eq 'official')) { + $output .= ''.&mt('Institutional Code').''; + } + $output .= ''.&mt('Date requested').''. + &Apache::loncommon::end_data_table_header_row(); + my $count = 0; + foreach my $item (@sortedtimes) { + my $showtime = &Apache::lonlocal::locallocaltime($item); + if (ref($queue_by_date{$item}) eq 'ARRAY') { + foreach my $request (sort(@{$queue_by_date{$item}})) { + my ($key,$type,$desc,$instcode) = split(':',$request); + my ($cdom,$cnum) = split('_',$key); + $output .= &Apache::loncommon::start_data_table_row(). + ''. + ''.$desc.''; + if ($env{'form.crstype'} eq 'all') { + $output .= ''.&course_types($type).''; + } + if (($env{'form.crstype'} eq 'all') || + ($env{'form.crstype'} eq 'official')) { + $output .= ''.$instcode.''; + } + $output .= ''.$showtime.''. + &Apache::loncommon::end_data_table_row(); + } + } + } + $output .= &Apache::loncommon::end_data_table(); + } else { + $output .= '
'.&mt('You have no course requests pending approval by a Domain Coordinator or held in a queue pending administrative action at your institution.').'
'; + } + $output .= ' + +'. + &Apache::loncommon::end_page(); + return $output; } sub print_request_logs { + my ($jscript,$loaditems,$crumb) = @_; return; } @@ -1120,6 +1223,8 @@ sub print_review { $personnel_values.''."\n". &Apache::lonhtmlcommon::row_closure(1). &Apache::lonhtmlcommon::end_pick_box(); + my $cnum = &Apache::lonnet::generate_coursenum($dom); + $output .= ''; return $output; } @@ -1313,9 +1418,341 @@ sub display_navbuttons { } sub print_request_outcome { + my ($dom,$codetitles,$code_order) = @_; + my ($output,$cnum,$now,$req_notifylist,$crstype,$startenroll,$endenroll, + %sections,%crosslistings,%personnel,@baduname,@missingdom,%domconfig,); + $cnum = $env{'form.cnum'}; + unless ($cnum =~ /^$match_courseid$/) { + $output = &mt('Invalid LON-CAPA course number for the new course')."\n"; + return $output; + } + %domconfig = &Apache::lonnet::get_dom('configuration',['requestcourses'],$dom); + if (ref($domconfig{'requestcourses'}) eq 'HASH') { + if (ref($domconfig{'requestcourses'}{'notify'}) eq 'HASH') { + $req_notifylist = $domconfig{'requestcourses'}{'notify'}{'approval'}; + } + } + $now = time; + $crstype = $env{'form.crstype'}; + if ($crstype eq 'official') { + if (&Apache::lonnet::auto_run('',$dom)) { + ($startenroll,$endenroll)=&dates_from_form('startenroll','endenroll'); + } + for (my $i=0; $i<$env{'form.sectotal'}; $i++) { + if ($env{'form.sec_'.$i}) { + if ($env{'form.secnum_'.$i} ne '') { + $sections{$env{'form.secnum_'.$i}} = $env{'form.loncapasec_'.$i}; + } + } + } + for (my $i=0; $i<$env{'form.crosslisttotal'}; $i++) { + if ($env{'form.crosslist_'.$i}) { + my $xlistinfo = ''; + if (ref($code_order) eq 'ARRAY') { + if (@{$code_order} > 0) { + foreach my $item (@{$code_order}) { + $xlistinfo .= $env{'form.crosslist_'.$i.'_'.$item}; + } + } + } + $xlistinfo .= $env{'form.crosslist_'.$i.'_instsec'}; + $crosslistings{$xlistinfo} = $env{'form.crosslist_'.$i.'_lcsec'}; + } + } + } + + for (my $i=0; $i<$env{'form.persontotal'}; $i++) { + my $uname = $env{'form.person_'.$i.'_uname'}; + my $udom = $env{'form.person_'.$i.'_uname'}; + if (($uname =~ /^$match_username$/) && ($udom =~ /^$match_domain$/)) { + if (&Apache::lonnet::domain($udom) ne '') { + $personnel{$uname.':'.$udom} = { + first => $env{'form.person_'.$i.'_first'}, + last => $env{'form.person_'.$i.'_last'}, + email => $env{'form.person_'.$i.'_email'}, + role => $env{'form.person_'.$i.'_role'}, + sections => $env{'form.person_'.$i.'_sections'}, + }; + } else { + push(@missingdom,$uname.':'.$udom); + } + } else { + push(@baduname,$uname.':'.$udom); + } + } + + my ($startaccess,$endaccess) = &dates_from_form('startaccess','endacess'); + my $details = { + owner => $env{'user.name'}, + domain => $env{'user.domain'}, + cdom => $dom, + cnum => $cnum, + cdesc => $env{'form.cdesc'}, + crstype => $env{'form.crstype'}, + instcode => $env{'form.instcode'}, + clonedomain => $env{'form.clonedomain'}, + clonecourse => $env{'form.clonecourse'}, + datemode => $env{'form.datemode'}, + dateshift => $env{'form.datshift'}, + sectotal => $env{'form.sectotal'}, + sections => \%sections, + crosslisttotal => $env{'form.crosslisttotal'}, + crosslistings => \%crosslistings, + autoadds => $env{'form.autoadds'}, + autodrops => $env{'form.autodrops'}, + startenroll => $startenroll, + endenroll => $endenroll, + startaccess => $startaccess, + endaccess => $endaccess, + personnel => \%personnel, + }; + my @inststatuses; + my $val = &get_processtype($dom,$crstype,\@inststatuses,\%domconfig); + if ($val eq '') { + if ($crstype eq 'official') { + $output = &mt('You are not permitted to request creation of official courses'); + } elsif ($crstype eq 'unofficial') { + $output = &mt('You are not permitted to request creation of unofficial courses'); + } elsif ($crstype eq 'community') { + $output = &mt('You are not permitted to request creation of communities'); + } else { + $output = &mt('Unrecognized course type: [_1]',$crstype); + } + } else { + my ($disposition,$message); + my %reqhash = ( + timestamp => $now, + crstype => $crstype, + details => $details, + ); + my $requestkey = $dom.'_'.$cnum; + if ($val eq 'autolimit=') { + $disposition = 'process'; + } elsif ($val =~ /^autolimit=(\d+)$/) { + my $limit = $1; + $disposition = &check_autolimit($env{'user.name'},$env{'user.domain'}, + $dom,$crstype,$limit,\$message); + } elsif ($val eq 'validate') { + $disposition = + &Apache::lonnet::auto_courserequest_validation($dom,$details, + \@inststatuses,\$message); + } else { + $disposition = 'approval'; + } + $reqhash{'status'} = $disposition; + if ($disposition eq 'rejected') { + $output = &mt('Your course request was rejected.'); + if ($message) { + $output .= '
'.$message.'
'; + } + } elsif ($disposition eq 'process') { + my $type = 'Course'; + if ($crstype eq 'community') { + $type = 'Community'; + } + my ($logmsg,$newusermsg,$addresult,$enrollcount,$output,$keysmsg,%longroles); + my @roles = &Apache::lonuserutils::roles_by_context('course'); + foreach my $role (@roles) { + $longroles{$role}=&Apache::lonnet::plaintext($role,$type); + } + my %reqdetails = &build_batchcreatehash($details); + my $cid = &LONCAPA::batchcreatecourse::build_course($dom,$cnum,'request',\%reqdetails,\%longroles,\$logmsg,\$newusermsg,\$addresult,\$enrollcount,\$output,\$keysmsg,$env{'user.domain'},$env{'user.name'},$cnum); + $disposition = 'created'; + if ($cid eq $cnum) { + $disposition = 'created'; + $output = &mt('Your course request has been processed and the course has been created.').'
'.&mt('You will need to logout and log-in again to be able to select a role in the course.'); + } else { + $output = &mt('An error occurred when processing your course request.').'
'.&mt('You may want to review the request details and submit the request again.'); + } + } else { + my $requestid = $cnum.'_'.$disposition; + my $request = { + $requestid => { + timestamp => $now, + crstype => $crstype, + ownername => $env{'user.name'}, + ownerdom => $env{'user.domain'}, + description => $env{'form.cdesc'}, + }, + }; + my $putresult = &Apache::lonnet::newput_dom('courserequestqueue',$request, + $dom); + if ($putresult eq 'ok') { + my %emails = &Apache::loncommon::getemails(); + my $address; + if (($emails{'permanentemail'} ne '') || ($emails{'notification'} ne '')) { + $address = $emails{'permanentemail'}; + if ($address eq '') { + $address = $emails{'notification'}; + } + } + $output = &mt('Your course request has been recorded.').'
'; + if ($disposition eq 'approval') { + $output .= &mt('Your course request has been recorded.').'
'. + &mt('A message will be sent to your LON-CAPA account when a domain coordinator takes action on your request.').'
'. + &mt('To access your LON-CAPA message, go to the Main Menu and click on "Send and Receive Messages".').'
'; + if ($address ne '') { + $output.= &mt('An e-mail will also be sent to: [_1] when this occurs.',$address).'
'; + } + if ($req_notifylist) { + my $fullname = &Apache::loncommon::plainname($env{'user.name'}, + $env{'user.domain'}); + &Apache::loncoursequeueadmin::send_selfserve_notification($req_notifylist,$fullname,$now,$dom,$details); + } + } else { + $output .= '
'. +&mt('Your request has been placed in a queue pending administrative action.').'
'. +&mt("Usually this means that your institution's information systems do not list you among the instructional personnel for this course.").'
'. +&mt('The list of instructional personnel for the course will be automatically checked daily, and once you are listed the request will be processed.'). + '
'; + } + } else { + $reqhash{'status'} = 'domainerror'; + $reqhash{'disposition'} = $disposition; + my $warning = &mt('An error occurred saving your request in the pending requests queue.'); + $output = ''.$warning.'
'; + + } + } + my $storeresult; + if ($requestkey =~ /^($match_domain)_($match_courseid)$/) { + $storeresult = &Apache::lonnet::store_userdata(\%reqhash,$requestkey, + 'courserequests'); + } else { + $storeresult = 'error: invalid requestkey format'; + } + if ($storeresult ne 'ok') { + $output .= ''.&mt('An error occurred saving a record of the details of your request.').'
'; + &logthis("Error saving course request - $requestkey for $env{'user.name'}:$env{'user.domain'} - $storeresult"); + } + } + return $output; +} + +sub get_processtype { + my ($dom,$crstype,$inststatuses,$domconfig) = @_; + return unless ((ref($inststatuses) eq 'ARRAY') && (ref($domconfig) eq 'HASH')); + my (%userenv,%settings,$val); + my @options = ('autolimit','validate','approve'); + if ($dom eq $env{'user.domain'}) { + %userenv = + &Apache::lonnet::userenvironment($env{'user.domain'},$env{'user.name'}, + 'requestcourses.'.$crstype,'inststatus'); + if ($userenv{'requestcourses.'.$crstype}) { + $val = $userenv{'requestcourses.'.$crstype}; + @{$inststatuses} = ('_custom_'); + } else { + my ($task,%alltasks); + if (ref($domconfig->{'requestcourses'}) eq 'HASH') { + %settings = %{$domconfig->{'requestcourses'}}; + if (ref($settings{$crstype}) eq 'HASH') { + if (($env{'user.adv'}) && (exists($settings{$crstype}{'_LC_adv'}))) { + $val = $settings{$crstype}{'_LC_adv'}; + @{$inststatuses} = ('_LC_adv_'); + } else { + if ($userenv{'inststatus'} ne '') { + @{$inststatuses} = split(',',$userenv{'inststatus'}); + } else { + @{$inststatuses} = ('other'); + } + foreach my $status (@{$inststatuses}) { + if (exists($settings{$crstype}{$status})) { + my $value = $settings{$crstype}{$status}; + next unless ($value); + unless (exists($alltasks{$value})) { + if (ref($alltasks{$value}) eq 'ARRAY') { + unless(grep(/^\Q$status\E$/,@{$alltasks{$value}})) { + push(@{$alltasks{$value}},$status); + } + } else { + @{$alltasks{$value}} = ($status); + } + } + } + } + my $maxlimit = 0; + foreach my $key (sort(keys(%alltasks))) { + if ($key =~ /^autolimit=(\d*)$/) { + if ($1 eq '') { + $val ='autolimit='; + last; + } elsif ($1 > $maxlimit) { + $maxlimit = $1; + } + } + } + if ($maxlimit) { + $val = 'autolimit='.$maxlimit; + } else { + foreach my $option (@options) { + if ($alltasks{$option}) { + $val = $option; + last; + } + } + } + } + } + } + } + } else { + %userenv = &Apache::lonnet::userenvironment($env{'user.domain'}, + $env{'user.name'},'reqcrsotherdom.'.$env{'form.crstype'}); + if ($userenv{'reqcrsotherdom'}) { + my @doms = split(',',$userenv{'reqcrsotherdom'}); + my $optregex = join('|',@options); + if (grep(/^\Q$dom\E:($optregex=?\d*)/,@doms)) { + $val = $1; + } + @{$inststatuses} = ('_external_'); + } + } + return $val; +} + +sub check_autolimit { + my ($uname,$udom,$dom,$crstype,$limit,$message) = @_; + my %crsroles = &Apache::lonnet::get_my_roles($env{'user.name'},$env{'user.domain'}, + 'userroles',['active','future'],['cc'],[$dom]); + my ($types,$typename) = &course_types(); + my %requests = &Apache::lonnet::dumpstore('courserequests',$udom,$uname); + my %count; + if (ref($types) eq 'ARRAY') { + foreach my $type (@{$types}) { + $count{$type} = 0; + } + } + foreach my $key (keys(%requests)) { + my ($cdom,$cnum) = split('_',$key); + if (exists($crsroles{$cnum.':'.$cdom.':cc'})) { + if (ref($requests{$key}) eq 'HASH') { + my $type = $requests{$key}{'crstype'}; + if ($type =~ /^official|unofficial|community$/) { + $count{$type} ++; + } + } + } + } + if ($count{$crstype} < $limit) { + return 'process'; + } else { + if (ref($typename) eq 'HASH') { + $$message = &mt('Your request has not been processed because you have reached the limit for the number of courses of this type.').'
'.&mt("Your $typename->{$crstype} limit is [_1].",$limit); + } + return 'rejected'; + } return; } +sub build_batchcreatehash { + my ($details) = @_; + my %batchhash; + if (ref($details) eq 'HASH') { + + } + return %batchhash; +} + sub retrieve_settings { my ($dom,$request_id) = @_; my %reqinfo = &get_request_settings($request_id,$dom);