[LON-CAPA-cvs] cvs: loncom /interface lonrequestcourse.pm /lonnet/perl lonnet.pm
raeburn
raeburn@source.lon-capa.org
Tue, 11 Aug 2009 01:39:45 -0000
This is a MIME encoded message
--raeburn1249954785
Content-Type: text/plain
raeburn Tue Aug 11 01:39:45 2009 EDT
Modified files:
/loncom/interface lonrequestcourse.pm
/loncom/lonnet/perl lonnet.pm
Log:
- Course Requests
lonrequestcourse.pm
- &print_review() which displays details of a course request prior to submissi
on now includes a call to &Apache::lonnet::generate_coursenum() to retrieve a un
ique course number to be used for the requested course.
- &print_request_outcome() determines how a request should be processed, based on course type, and domain setting for requestor's instiutional affiliations(s), (overridden by user-specific settings), and performs the required actions.
- &get_processtype() retrieves the setting: norequest, approval, validate, or autolimit=N (N is requests per user).
- &check_autolimit() will check if requests per user limit reached.
- Call to &Apache::lonnet::auto_courserequest_validation() to perform institutional check - response is either process or pending.
- $disposition indicates how request should be handled
- approval, rejected, process, or pending.
- case: approval and pending - place in a queue (domain's courserequestqueue.db); approval means DC needs to approve; pending means institutional change ne
eded (e.g., assign owner as instructor of record)
- case: process - create the course using &build_course() in batchcreatecourse.pm
- case: rejected - course request not allowed
lonnet.pm
- &store_coursereq() is used to store (versioned) course requests in a courserequests.db file which belongs to the requestor. The unique key is the course number assigned to the (yet to be created) course.
Work in progress.
--raeburn1249954785
Content-Type: text/plain
Content-Disposition: attachment; filename="raeburn-20090811013945.txt"
Index: loncom/interface/lonrequestcourse.pm
diff -u loncom/interface/lonrequestcourse.pm:1.7 loncom/interface/lonrequestcourse.pm:1.8
--- loncom/interface/lonrequestcourse.pm:1.7 Thu Aug 6 20:40:59 2009
+++ loncom/interface/lonrequestcourse.pm Tue Aug 11 01:39:34 2009
@@ -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.8 2009/08/11 01:39:34 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -55,6 +55,7 @@
use Apache::lonnet;
use Apache::loncommon;
use Apache::lonlocal;
+use Apache::loncoursequeueadmin;
use LONCAPA qw(:DEFAULT :match);
sub handler {
@@ -469,7 +470,7 @@
'<div>'.
'<form name="domforcourse" method="post" action="/adm/requestcourse">'.
&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(' <input type="submit" name="godom" value="'.
@@ -536,11 +537,7 @@
$jsextra = "\n".&Apache::loncommon::coursebrowser_javascript($dom);
}
$r->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') {
@@ -632,13 +629,15 @@
$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 '') {
+ my $result = &print_request_outcome($dom);
}
my @excluded = ('counter');
my %elements = &form_elements($dom);
@@ -797,7 +796,7 @@
}
sub print_personnel_menu {
- my ($dom,$formname) = @_;
+ my ($dom,$formname,$crstype) = @_;
my $output = '<div>'.&Apache::lonhtmlcommon::start_pick_box();
my $persontotal = $env{'form.persontotal'};
if (!defined($persontotal)) {
@@ -811,8 +810,12 @@
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 .= ' <option value="'.$role.'">'.$plrole.'</option>'."\n";
}
my %customroles=&Apache::lonuserutils::my_custom_roles();
@@ -1120,6 +1123,8 @@
$personnel_values.'</table>'."\n".
&Apache::lonhtmlcommon::row_closure(1).
&Apache::lonhtmlcommon::end_pick_box();
+ my $cnum = &Apache::lonnet::generate_coursenum($dom);
+ $output .= '<input type="hidden" name="cnum" value="'.$cnum.'" />';
return $output;
}
@@ -1313,9 +1318,258 @@
}
sub print_request_outcome {
+ my ($dom) = @_;
+ my $output;
+ my $cnum = $env{'form.cnum'};
+ unless ($cnum =~ /^$match_courseid$/) {
+ $output = &mt('Invalid LON-CAPA course number for the new course')."\n";
+ return $output;
+ }
+ my $req_notifylist = &Apache::lonnet::get_dom('configuration',['requestcourses'],
+ $dom);
+ my $now = time;
+ my $crstype = $env{'form.crstype'};
+ my ($startenroll,$endenroll,%sections,%crosslistings,%personnel);
+ if ($crstype eq 'official') {
+ if (&Apache::lonnet::auto_run('',$dom)) {
+ ($startenroll,$endenroll)=&dates_from_form('startenroll','endenroll');
+ }
+ %sections = ();
+ %crosslistings = ();
+ }
+ 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,
+ crosstotal => $env{'form.crosstotal'},
+ 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);
+ 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 = (
+ crstype => $crstype,
+ details => $details,
+ );
+ my $requestkey = $dom.'_'.$cnum;
+ if ($val =~ /^autolimit=/) {
+ $disposition = &check_autolimit($env{'user.name'},$env{'user.domain'},
+ $dom,$crstype,$val,\$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 .= '<div class="LC_warning">'.$message.'</div>';
+ }
+ } 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.').'<br />'.&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.').'<br />'.&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.').'<br />';
+ if ($disposition eq 'approval') {
+ $output .= &mt('Your course request has been recorded.').'<br />'.
+ &mt('A message will be sent to your LON-CAPA account when a domain coordinator takes action on your request.').'<br />'.
+ &mt('To access your LON-CAPA message, go to the Main Menu and click on "Send and Receive Messages".').'<br />';
+ if ($address ne '') {
+ $output.= &mt('An e-mail will also be sent to: [_1] when this occurs.',$address).'<br />';
+ }
+ 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 .= '<div class="LC_info">'.
+&mt('Your request has been placed in a queue pending administrative action.').'<br />'.
+&mt("Usually this means that your institution's information systems do not list you among the instructional personnel for this course.").'<br />'.
+&mt('The list of instructional personnel for the course will be automatically checked daily, and once you are listed the request will be processed.').
+ '</div>';
+ }
+ } else {
+ $reqhash{'status'} = 'domainerror';
+ $reqhash{'disposition'} = $disposition;
+ my $warning = &mt('An error occurred saving your request in the pending requests queue.');
+ $output = '<span class"LC_warning">'.$warning.'</span><br />';
+
+ }
+ }
+ my $storeresult = &Apache::lonnet::store_coursereq($requestkey,\%reqhash);
+ if ($storeresult ne 'ok') {
+ $output .= '<span class="LC_warning">'.&mt('An error occurred saving a record of the details of your request.').'</span><br />';
+ &logthis("Error saving course request - $requestkey for $env{'user.name'}:$env{'user.domain'} - $storeresult");
+ }
+ }
+ return $output;
+}
+
+sub get_processtype {
+ my ($dom,$crstype,$inststatuses) = @_;
+ return unless (ref($inststatuses) eq 'ARRAY');
+ 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 %domconfig = &Apache::lonnet::get_dom('configuration',['requestcourses'],$dom);
+ 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 {
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);
Index: loncom/lonnet/perl/lonnet.pm
diff -u loncom/lonnet/perl/lonnet.pm:1.1012 loncom/lonnet/perl/lonnet.pm:1.1013
--- loncom/lonnet/perl/lonnet.pm:1.1012 Mon Aug 10 23:32:35 2009
+++ loncom/lonnet/perl/lonnet.pm Tue Aug 11 01:39:44 2009
@@ -1,7 +1,7 @@
# The LearningOnline Network
# TCP networking package
#
-# $Id: lonnet.pm,v 1.1012 2009/08/10 23:32:35 raeburn Exp $
+# $Id: lonnet.pm,v 1.1013 2009/08/11 01:39:44 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -5878,6 +5878,11 @@
return %validations;
}
+sub auto_courserequest_validation {
+ my ($dom,$details,$inststatuses,$message) = @_;
+ return 'pending';
+}
+
sub auto_validate_class_sec {
my ($cdom,$cnum,$owners,$inst_class) = @_;
my $homeserver = &homeserver($cnum,$cdom);
@@ -6524,6 +6529,36 @@
return 0;
}
+sub store_coursereq {
+ my ($requestkey,$storehash) = @_;
+ my $result;
+ if ($requestkey =~ /^($match_domain)_($match_courseid)$/) {
+ if (ref($storehash) eq 'HASH') {
+ my $namespace = 'courserequests';
+ my $uhome=&homeserver();
+ if (($uhome eq '') || ($uhome eq 'no_host')) {
+ $result = 'error: no_host';
+ } else {
+ $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
+ $storehash->{'host'} = $perlvar{'lonHostID'};
+
+ my $namevalue='';
+ foreach my $key (keys(%{$storehash})) {
+ $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
+ }
+ $namevalue=~s/\&$//;
+ $result = &reply("store:$env{'user.domain'}:$env{'user.name'}:".
+ "$namespace:$requestkey:$namevalue",$uhome);
+ }
+ } else {
+ $result = 'error: data to store was not a hash reference';
+ }
+ } else {
+ $result= 'error: invalid requestkey';
+ }
+ return $result;
+}
+
# ---------------------------------------------------------- Assign Custom Role
sub assigncustomrole {
--raeburn1249954785--