--- loncom/interface/loncreatecourse.pm 2001/12/19 17:17:46 1.5 +++ loncom/interface/loncreatecourse.pm 2007/06/01 18:07:47 1.101.2.1 @@ -1,7 +1,7 @@ # The LearningOnline Network # Create a course # -# $Id: loncreatecourse.pm,v 1.5 2001/12/19 17:17:46 albertel Exp $ +# $Id: loncreatecourse.pm,v 1.101.2.1 2007/06/01 18:07:47 albertel Exp $ # # Copyright Michigan State University Board of Trustees # @@ -25,119 +25,778 @@ # # http://www.lon-capa.org/ # -# (My Desk -# -# (Internal Server Error Handler -# -# (Login Screen -# 5/21/99,5/22,5/25,5/26,5/31,6/2,6/10,7/12,7/14, -# 1/14/00,5/29,5/30,6/1,6/29,7/1,11/9 Gerd Kortemeyer) -# -# 3/1/1 Gerd Kortemeyer) -# -# 3/1 Gerd Kortemeyer) -# -# 2/14,2/16,2/17,7/6 Gerd Kortemeyer -# +### + package Apache::loncreatecourse; use strict; use Apache::Constants qw(:common :http); use Apache::lonnet; +use Apache::loncommon; +use Apache::londocs; +use Apache::lonlocal; +use Apache::londropadd; +use Apache::lonclonecourse; +use LONCAPA::batchcreatecourse; +use LONCAPA; # ===================================================== Phase one: fill-in form -sub phase_one { +sub print_course_creation_page { my $r=shift; - - my $defdom=$ENV{'user.domain'}; - $r->print(< - -The LearningOnline Network with CAPA - - - -

Create a new Course

-
-

Course Title

- -

Top-level Map

- -

Course ID/Number (optional)

- -

Course Cooordinator

-Username:
-Domain: -

- + my $crstype = 'Course'; +# my $crstype = 'Group'; +# if ($env{'form.phase'} eq 'courseone') { +# $crstype = 'Course'; +# } + my $defdom=$env{'request.role.domain'}; + my %host_servers = &Apache::lonnet::get_servers($defdom,'library'); + my $course_home = '\n"; + my $domform = &Apache::loncommon::select_dom_form($defdom,'ccdomain'); + my $cloneform=&Apache::loncommon::select_dom_form + ($env{'request.role.domain'},'clonedomain'). + &Apache::loncommon::selectcourse_link + ('ccrs','clonecourse','clonedomain',undef,undef,undef,$crstype); + my $coursebrowserjs=&Apache::loncommon::coursebrowser_javascript($env{'request.role.domain'}); + my ($enroll_table,$access_table,$krbdef,$krbdefdom,$krbform,$intform,$locform, + $javascript_validations); + if ($crstype eq 'Course') { + my $starttime = time; + my $endtime = time+(6*30*24*60*60); # 6 months from now, approx + $enroll_table = &Apache::londropadd::date_setting_table($starttime, + $endtime,'create_enrolldates'); + $access_table = &Apache::londropadd::date_setting_table($starttime, + $endtime,'create_defaultdates'); + ($krbdef,$krbdefdom) = + &Apache::loncommon::get_kerberos_defaults($defdom); + $javascript_validations=&Apache::londropadd::javascript_validations( + 'createcourse',$krbdefdom); + my %param = ( formname => 'document.ccrs', + kerb_def_dom => $krbdefdom, + kerb_def_auth => $krbdef + ); + $krbform = &Apache::loncommon::authform_kerberos(%param); + $intform = &Apache::loncommon::authform_internal(%param); + $locform = &Apache::loncommon::authform_local(%param); + } else { + $javascript_validations = qq| +function validate(formname) { + if (formname.title == '') { + alert("A group title is required"); + return; + } + if (formname.ccuname == '') { + alert("The username of the group coordinator is required"); + } + formname.submit(); +} + |; + } + 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 IDs", + 'csli' => "a comma separated list of institutional section numbers, each separated by a colon from the (optional) corresponding section 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) sectionID 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", + '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', + 'cgrs' => "Course Group Settings", + 'cgrq' => "Set a quota for the total disk space available for storage of course group portfolio files.", + 'opco' => "Open Course", + 'ginf' => "Group Information", + 'gtit' => "Group Title", + 'ghsr' => "Group Home Server", + 'gidn' => "Group ID/Number", + 'grco' => "Group Content", + 'cngr' => "Completely new group", + 'cegr' => "Clone an existing group", + 'sagr' => "Do NOT generate as standard group", + 'stgo' => "standard groups only", + 'sgpf' => "Set group policy feedback to Group Coordinator", + 'scfg' => "Set content feedback to Group Coordinator", + 'dmrd' => "Disable member resource discussion", + 'dmuc' => "Disable member use of chatrooms", + 'mnak' => "Members need access key to enter group", + 'kaug' => + 'Key authority (id@domain) if other than group', + 'gc' => "Group Coordinator", + 'gid' => "Group ID", + 'crgr' => "Create Group", + 'grts' => "Group Teams Settings", + 'grtq' => "Set a quota for the total disk space available for storage of group team portfolio files.", + + ); + my $js = < +var editbrowser = null; +function openbrowser(formname,elementname) { + var url = '/res/?'; + if (editbrowser == null) { + url += 'launch=1&'; + } + url += 'catalogmode=interactive&'; + url += 'mode=edit&'; + url += 'form=' + formname + '&'; + url += 'element=' + elementname + '&'; + url += 'only=sequence' + ''; + var title = 'Browser'; + var options = 'scrollbars=1,resizable=1,menubar=0'; + options += ',width=700,height=600'; + editbrowser = open(url,title,options,'1'); + editbrowser.focus(); +} +$javascript_validations + +$coursebrowserjs +END + + my %titles = &Apache::lonlocal::texthash( + courseone => 'Create a New Course', + groupone => 'Create a New Group', + ); + my $start_page = + &Apache::loncommon::start_page($titles{$env{'form.phase'}},$js); + my $end_page = + &Apache::loncommon::end_page(); + my $crumbs = + &Apache::lonhtmlcommon::breadcrumbs($crstype.' Information', + 'Create_Course',undef, + 'Create_Courses'); + $r->print($start_page.$crumbs); + if ($crstype eq 'Course') { + $r->print(< +

$lt{'cinf'}

+

+ +

+ +

+ +

+

$lt{'iinf'}

+

+$lt{'stat'} +

+ +
+($lt{'toin'}) +

+ +
+($lt{'csli'}) +

+ +
+($lt{'cscs'}) +

+

$lt{'crco'}

+ + + +
$lt{'cncr'}$lt{'cecr'}
+

+ +$lt{'smap'} +

+ +
+($lt{'ocik'}): + +

+$lt{'fres'}
($lt{'stco'}): + +  + +  + +

+
+ +
+ +

+$lt{'asov'}. +
+

$lt{'assp'}

+

+ +

+

$lt{'mssg'}

+

+ +
+ +

+

$lt{'cmmn'}

+

+ +
+ +

+

$lt{'acco'}

+

+ +
+ +

+

$lt{'rshm'}

+

+ +

+

+

$lt{'aens'}

+$lt{'aesc'} +

+

+$lt{'aadd'} + + +

+$lt{'audr'} + + +

+$lt{'dacu'} +$enroll_table +

+$lt{'dacc'} +$access_table +

+$lt{'psam'}.
+$lt{'pcda'}. +

+$krbform +
+$intform +
+$locform +

+$lt{'nech'}
+$lt{'nccl'}
+ + +
+$lt{'ndcl'}
+ + +

+$lt{'irsp'} + + +

+

+

$lt{'cgrs'}

+$lt{'cgrq'} +Mb +

+
+

$lt{'cc'}

+

+ +

+ +

+

+ + + +

+
+ENDDOCUMENT + } elsif ($crstype eq 'Group') { + $r->print(< +

$lt{'ginf'}

+

+ +

+ +

+ +

+

$lt{'grco'}

+ + + +
$lt{'cngr'}$lt{'cegr'}
+

+ +$lt{'smap'} +

+ +
+($lt{'ocik'}): + +

+$lt{'fres'}
($lt{'stgo'}): + +  + +  + +

+
+ +
+ +

+$lt{'asov'}. +
+

+

+

$lt{'mssg'}

+

+ +
+ +

+

$lt{'cmmn'}

+

+ +
+ +

+

$lt{'acco'}

+

+ +
+ +

+

$lt{'rshm'}

+

+ +

+

+

$lt{'grts'}

+$lt{'grtq'} +Mb +

+
+

$lt{'gc'}

+

+ +

+ +

+

+ + + +

- - ENDDOCUMENT + } + $r->print($end_page); } # ====================================================== Phase two: make course -sub phase_two { +sub create_course { my $r=shift; - my $topurl='/res/'.&Apache::lonnet::declutter($ENV{'form.topmap'}); - 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'}; - $r->print(< - -The LearningOnline Network with CAPA - - - -

Create a new Course

-ENDENHEAD -# -# Verify data -# + my $ccuname =&LONCAPA::clean_username($env{'form.ccuname'}); + my $ccdomain=&LONCAPA::clean_domain($env{'form.ccdomain'}); + my $crstype = 'Group'; + my ($enrollstart,$enrollend,$startaccess,$endaccess); + + if ($env{'form.phase'} eq 'coursetwo') { + $crstype='Course'; + $enrollstart=&Apache::lonhtmlcommon::get_date_from_form('startenroll'); + $enrollend=&Apache::lonhtmlcommon::get_date_from_form('endenroll'); + + } + $startaccess = &Apache::lonhtmlcommon::get_date_from_form('startaccess'); + $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 $start_page=&Apache::loncommon::start_page('Create a New '.$crstype); + my $crumbs = &Apache::lonhtmlcommon::breadcrumbs('Creation Outcome','Create_Course',undef,'Create_Courses'); + + $r->print($start_page.$crumbs); + + my $args = { + crstype => $crstype, + 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'}, + crsquota => $env{'form.crsquota'}, + clonecourse => $env{'form.clonecourse'}, + clonedomain => $env{'form.clonedomain'}, + crsid => $env{'form.crsid'}, + curruser => $env{'user.name'}.':'.$env{'user.domain'}, + crssections => $env{'form.crssections'}, + crsxlist => $env{'form.crsxlist'}, + autoadds => $env{'form.autoadds'}, + autodrops => $env{'form.autodrops'}, + notify_owner => $env{'form.notify_owner'}, + notify_dc => $env{'form.notify_dc'}, + 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 + # + # Check the veracity of the course coordinator if (&Apache::lonnet::homeserver($ccuname,$ccdomain) eq 'no_host') { - $r->print('No such user '.$ccuname.' at '.$ccdomain.''); + $r->print('
'); + $r->print(&mt('No such user').' '.$ccuname.' '.&mt('at').' '.$ccdomain.'.
'); + $r->print(&mt("Please click Back on your browser and select another user, or ")); + $r->print(' + + + + +
'.&Apache::loncommon::end_page()); return; } + # Check the proposed home server for the course + my %host_servers = + &Apache::lonnet::get_servers($env{'request.role.domain'},'library'); + if (! exists($host_servers{$env{'form.course_home'}})) { + $r->print(&mt('Invalid home server for course').': '. + $env{'form.course_home'}.&Apache::loncommon::end_page()); + return; + } + my ($courseid,$crsudom,$crsunum); + $r->print(&Apache::loncommon::construct_course($args,\$logmsg,\$courseid,\$crsudom,\$crsunum,$env{'user.domain'},$env{'user.name'})); # -# Open course +# Make the requested user a course coordinator or group coordinator # - my $courseid=&Apache::lonnet::createcourse($ENV{'user.domain'}, - $cdescr,$curl); + if (($ccdomain) && ($ccuname)) { + $r->print(&mt('Assigning role of [_1] Coordinator to [_2] at [_3]:', + $crstype,$ccuname,$ccdomain). + &Apache::lonnet::assignrole($ccdomain,$ccuname,$courseid, + 'cc').'

'); + } + if ($env{'form.setkeys'}) { + $r->print( + '

'.&mt('Manage Access Keys').'

'); + } +# Flush the course logs so reverse user roles immediately updated + &Apache::lonnet::flushcourselogs(); + $r->print('

'.&mt('Roles will be active at next login').'.

'. + '

'. + &mt('Create Another [_1]',$crstype).'

'. + &Apache::loncommon::end_page()); +} - $r->print('New LON-CAPA Course ID: '.$courseid.'
'); -# -# Set optional courseid -# - my ($crsudom,$crsunum)=($courseid=~/^\/(\w+)\/(\w+)$/); - my $crsuhome=&Apache::lonnet::homeserver($crsunum,$crsudom); - $r->print('Created on: '.$crsuhome.'
'); - if ($ENV{'form.crsid'}) { - $r->print('Setting optional Course ID/Number: '. - &Apache::lonnet::reply('put:'.$crsudom.':'. - $crsunum.':environment:courseid='. - &Apache::lonnet::escape($ENV{'form.crsid'}), - $crsuhome).'
'); +sub print_intro_page { + my $r = shift; + my $start_page = + &Apache::loncommon::start_page('Create a New Course'); + my $crumbs = &Apache::lonhtmlcommon::breadcrumbs('Creation Options','Create_Course',undef,'Create_Courses'); + my $end_page = + &Apache::loncommon::end_page(); + my $helplink=&Apache::loncommon::help_open_topic('Create_Course_GroupSpace',&mt('Help on Creating Courses and Groups')); + + my @choices = ({ internal_name => 'courseone', + name => &mt('Create a single course'), + short_description => + &mt('Create a new course by completing an online form.'), + }, +# { internal_name => 'groupone', +# name => &mt('Create a single collaborative group space '), +# short_description => +# &mt('Create a new group space for non-course use by completing an online form .'), +# }, + { internal_name => 'batchone', + name => &mt('Create courses/groups by uploading an attributes file'), + short_description => + &mt('Upload an attributes file containing specifications for one or more courses or groups in XML format'), + help => 'Batch_Creation', + }, + ); + my $options; + foreach my $choice (@choices) { + $options .='

'. + $choice->{'name'}.''; + if (exists($choice->{'help'})) { + $options .= &Apache::loncommon::help_open_topic($choice->{'help'}); + } + $options .= "

\n".' '.(' 'x8).$choice->{'short_description'}. + "\n"; } -# -# Make current user course adminstrator -# - $r->print('Assigning role of course coordinator to self: '. - &Apache::lonnet::assignrole( - $ENV{'user.domain'},$ENV{'user.name'},$courseid,'cc').'
'); -# -# Make additional user course administrator -# - $r->print('Assigning role of course coordinator to '. - $ccuname.' at '.$ccdomain.': '. - &Apache::lonnet::assignrole($ccdomain,$ccuname,$courseid,'cc').'

'); - $r->print('Roles will be active at next login.'); + + $r->print(<print($start_page.$crumbs); + $r->print('

'.&mt('Upload a courses attributes file').'

'); + $r->print('
'. + ''. + '

'. + '
'); + $r->print($end_page); + return; +} + +sub process_batchfile { + my $r = shift; + my $start_page = + &Apache::loncommon::start_page('Create a New Course or Group Space'); + my $crumbs = &Apache::lonhtmlcommon::breadcrumbs('Creation Outcome','Create_Course',undef,'Create_Courses'); + my $end_page = + &Apache::loncommon::end_page(); + my $defdom=$env{'request.role.domain'}; + my $batchfilepath=&Apache::lonnet::userfileupload('coursecreatorxml',undef, + 'batchupload',undef,undef, + undef,undef,$defdom); + my ($batchdir,$filename) = ($batchfilepath =~ m-^(.+)/pending/([^/]+)$-); + my ($result,$logmsg); + if (-e "$batchfilepath") { + open(FILE,"<$batchfilepath"); + my @buffer = ; + close(FILE); + if ((defined($filename)) && (defined($batchdir))) { + my @requests = ($filename); + my %courseids = (); + ($result,$logmsg) = &LONCAPA::batchcreatecourse::create_courses( + \@requests,\%courseids,'web',$defdom, + $env{'user.name'},$env{'user.domain'}); + if ($result) { + if (!-e "$batchdir/processed") { + mkdir("$batchdir/processed", 0755); + open(FILE,">$batchdir/processed/$filename"); + print FILE @buffer; + close(FILE); + if (-e "$batchdir/processed/$filename") { + unlink("$batchdir/pending/$filename"); + } + } + } + } + } + $r->print($start_page.$crumbs.$result.$end_page); + } # ===================================================================== Handler @@ -145,27 +804,66 @@ sub handler { my $r = shift; if ($r->header_only) { - $r->content_type('text/html'); + &Apache::loncommon::content_type($r,'text/html'); $r->send_http_header; return OK; } - if (&Apache::lonnet::allowed('ccc',$ENV{'user.domain'})) { - $r->content_type('text/html'); + if (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'})) { + &Apache::loncommon::content_type($r,'text/html'); $r->send_http_header; - if ($ENV{'form.phase'} eq 'two') { - &phase_two($r); + &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, + ['phase']); + &Apache::lonhtmlcommon::clear_breadcrumbs(); + &Apache::lonhtmlcommon::add_breadcrumb + ({href=>"/adm/createcourse", + text=>"Creation Options", + faq=>79,bug=>'Dom Coord Interface',}); + if (($env{'form.phase'} eq 'coursetwo') || + ($env{'form.phase'} eq 'grouptwo')) { + &Apache::lonhtmlcommon::add_breadcrumb + ({href=>"/adm/createcourse?phase=$env{'form.prevphase'}", + text=>&mt('[_1] Creation Settings',), + faq=>9,bug=>'Dom Coord Interface',}); + &Apache::lonhtmlcommon::add_breadcrumb + ({href=>"/adm/createcourse?phase=$env{'form.phase'}", + text=>"Creation Outcome", + faq=>9,bug=>'Dom Coord Interface',}); + &create_course($r); + } elsif (($env{'form.phase'} eq 'courseone') || + ($env{'form.phase'} eq 'groupone')) { + &Apache::lonhtmlcommon::add_breadcrumb + ({href=>"/adm/createcourse?phase=$env{'form.phase'}", + text=>&mt('[_1] Creation Settings',), + faq=>9,bug=>'Dom Coord Interface',}); + &print_course_creation_page($r); + } elsif ($env{'form.phase'} eq 'batchone') { + &Apache::lonhtmlcommon::add_breadcrumb + ({href=>"/adm/createcourse?phase=$env{'form.phase'}", + text=>"Upload Description File", + faq=>9,bug=>'Dom Coord Interface',}); + &upload_batchfile($r); + } elsif ($env{'form.phase'} eq 'batchtwo') { + &Apache::lonhtmlcommon::add_breadcrumb + ({href=>"/adm/createcourse?phase=$env{'form.prevphase'}", + text=>"Upload Description File", + faq=>9,bug=>'Dom Coord Interface',}); + &Apache::lonhtmlcommon::add_breadcrumb + ({href=>"/adm/createcourse?phase=$env{'form.phase'}", + text=>"Creation Outcome", + faq=>9,bug=>'Dom Coord Interface',}); + &process_batchfile($r); } else { - &phase_one($r); + &print_intro_page($r); } } else { - $ENV{'user.error.msg'}= - "/adm/createcourse:ccc:0:0:Cannot create courses"; + $env{'user.error.msg'}= + "/adm/createcourse:ccc:0:0:Cannot create courses or groups"; return HTTP_NOT_ACCEPTABLE; } return OK; -} +} 1; __END__