--- loncom/interface/Attic/londropadd.pm 2004/01/15 19:27:05 1.99
+++ loncom/interface/Attic/londropadd.pm 2005/02/17 08:29:42 1.125
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Handler to drop and add students in courses
#
-# $Id: londropadd.pm,v 1.99 2004/01/15 19:27:05 matthew Exp $
+# $Id: londropadd.pm,v 1.125 2005/02/17 08:29:42 albertel Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -37,17 +37,17 @@ use Apache::loncommon();
use Apache::lonhtmlcommon();
use Apache::Constants qw(:common :http REDIRECT);
use Spreadsheet::WriteExcel;
+use Apache::lonstathelpers();
use Apache::lonlocal;
###############################################################
###############################################################
sub header {
- my $bodytag=&Apache::loncommon::bodytag('Enrollment Manager').
- &Apache::loncommon::help_open_faq(9).
- &Apache::loncommon::help_open_bug('Instructor Interface');
+ my $html=&Apache::lonxml::xmlbegin();
+ my $bodytag=&Apache::loncommon::bodytag('Enrollment Manager');
my $title = &mt('LON-CAPA Enrollment Manager');
return(<
+$html
$title
@@ -137,47 +137,61 @@ sub domain_form {
###############################################################
# Menu Phase One
sub print_main_menu {
- my $r=shift;
- my %Text = &Apache::lonlocal::texthash
- ('upload' => 'Upload a class list',
- 'enrollone' => 'Enroll a single student',
- 'modify' => 'Modify student data',
- 'view' => 'View Class List',
- 'drop' => 'Drop Students',
- 'populate' => 'Automated Enrollment Manager');
- my %help=();
- foreach ('Course_Drop_Student','Course_Add_Student',
- 'Course_Modify_Student_Data','Course_View_Class_List',
- 'Course_Create_Class_List') {
- $help{$_}=&Apache::loncommon::help_open_topic($_);
+ my ($r,$enrl_permission,$view_permission)=@_;
+ #
+ my ($cdom,$cnum) = split/_/,$ENV{'request.course.id'};
+ my @menu =
+ (
+ { text => 'Upload a class list',
+ help => 'Course_Create_Class_List',
+ action => 'upload',
+ permission => $enrl_permission,
+ },
+ { text => 'Enroll a single student',
+ help => 'Course_Add_Student',
+ action => 'enrollstudent',
+ permission => $enrl_permission,
+ },
+ { text => 'Modify student data',
+ help => 'Course_Modify_Student_Data',
+ action => 'modifystudent',
+ permission => $enrl_permission,
+ },
+ { text => 'View Class List',
+ help => 'Course_View_Class_List',
+ action => 'classlist',
+ permission => $view_permission,
+ },
+ { text => 'Drop Students',
+ help => 'Course_Drop_Student',
+ action => 'drop',
+ permission => $enrl_permission,
+ },
+ { text => 'Automated Enrollment Manager',
+ permission => &Apache::lonnet::auto_run($cnum,$cdom),
+ url => '/adm/populate',
+ },
+ );
+ my $menu_html = '';
+ foreach my $menu_item (@menu) {
+ next if (! $menu_item->{'permission'});
+ $menu_html.='';
+ $menu_html.='';
+ if (exists($menu_item->{'url'})) {
+ $menu_html.=qq{};
+ } else {
+ $menu_html.=
+ qq{ };
+ }
+ $menu_html.= &mt($menu_item->{'text'}).' ';
+ if (exists($menu_item->{'help'})) {
+ $menu_html.=
+ &Apache::loncommon::help_open_topic($menu_item->{'help'});
+ }
+ $menu_html.='
'.$/;
}
-
- $r->print(<
-
-$Text{'upload'}
- $help{'Course_Create_Class_List'}
-
-
- $Text{'enrollone'}
- $help{'Course_Add_Student'}
-
-
- $Text{'modify'}
- $help{'Course_Modify_Student_Data'}
-
-
- $Text{'view'}
- $help{'Course_View_Class_List'}
-
-
- $Text{'drop'}
- $help{'Course_Drop_Student'}
-
-
- $Text{'populate'}
-
-END
+ $r->print($menu_html);
+ return;
}
###############################################################
@@ -305,7 +319,7 @@ END
return;
}
// alert('current.radiovalue = '+current.radiovalue);
- if (current.radiovalue == null || current.radiovalue == 'nochange') {
+ if (current.radiovalue == null || current.radiovalue == '' || current.radiovalue == 'nochange') {
// They did not check any of the login radiobuttons.
alert('$alert{'authen'}');
return;
@@ -701,7 +715,7 @@ sub enroll_single_student {
$ENV{'form.csec'}=~s/\W//g;
#
# We do the dates first because the action of making them the defaul
- # in the course is entirely seperate from the action of enrolling the
+ # in the course is entirely separate from the action of enrolling the
# student. Also, a failure in setting the dates as default is not fatal
# to the process of enrolling / modifying a student.
my ($startdate,$enddate) = &get_dates_from_form();
@@ -757,7 +771,7 @@ sub enroll_single_student {
$ENV{'form.clast'},$ENV{'form.cgen'},
$ENV{'form.csec'},$enddate,
$startdate,$ENV{'form.forceid'},
- $desiredhost);
+ $desiredhost,$ENV{'form.emailaddress'});
if ($login_result =~ /^ok/) {
$r->print($login_result);
$r->print("
".&mt('If active, the new role will be available when the student next logs in to LON-CAPA.')."
");
@@ -782,7 +796,7 @@ sub setup_date_selectors {
my ($starttime,$endtime,$mode) = @_;
if (! defined($starttime)) {
$starttime = time;
- unless ($mode eq 'createcourse') {
+ unless ($mode eq 'create_enrolldates' || $mode eq 'create_defaultdates') {
if (exists($ENV{'course.'.$ENV{'request.course.id'}.
'.default_enrollment_start_date'})) {
$starttime = $ENV{'course.'.$ENV{'request.course.id'}.
@@ -806,12 +820,20 @@ sub setup_date_selectors {
my $enddateform = &Apache::lonhtmlcommon::date_setter('studentform',
'enddate',
$endtime);
- if ($mode eq 'createcourse') {
+ if ($mode eq 'create_enrolldates') {
$startdateform = &Apache::lonhtmlcommon::date_setter('ccrs',
- 'startdate',
+ 'startenroll',
$starttime);
$enddateform = &Apache::lonhtmlcommon::date_setter('ccrs',
- 'enddate',
+ 'endenroll',
+ $endtime);
+ }
+ if ($mode eq 'create_defaultdates') {
+ $startdateform = &Apache::lonhtmlcommon::date_setter('ccrs',
+ 'startaccess',
+ $starttime);
+ $enddateform = &Apache::lonhtmlcommon::date_setter('ccrs',
+ 'endaccess',
$endtime);
}
return ($startdateform,$enddateform);
@@ -832,7 +854,7 @@ sub date_setting_table {
my $dateDefault = ''.
' '.
&mt('make these dates the default for future enrollment');
- if ($mode eq 'createcourse') {
+ if ($mode eq 'create_enrolldates' || $mode eq 'create_defaultdates') {
$dateDefault = ' ';
}
my $perpetual = ' '.&mt('no ending date').' ';
+ if ($mode eq 'create_enrolldates') {
+ $perpetual = ' ';
+ }
my $result = '';
$result .= "
+
END
return;
}
@@ -909,6 +938,8 @@ sub print_enroll_single_student_form {
#
my $username = $ENV{'form.cuname'};
my $domain = $ENV{'form.cudomain'};
+ $username=~s/\W//gs;
+ $domain=~s/\W//gs;
my $home = &Apache::lonnet::homeserver($username,$domain);
# $new_user flags whether we are creating a new user or using an old one
my $new_user = 1;
@@ -953,6 +984,7 @@ sub print_enroll_single_student_form {
'hs' => "Home Server",
'pswd' => "Password",
'psam' => "Please select an authentication mechanism",
+ 'mail' => "Email Address"
);
$user_data_html = <$lt{'udf'} $username\@$domain
@@ -967,6 +999,8 @@ sub print_enroll_single_student_form {
$lt{'hs'}:
$homeserver_form
+$lt{'mail'}:
+
$lt{'pswd'}
$lt{'psam'}
@@ -989,6 +1023,7 @@ END
'mn' => "Middle Name",
'ln' => "Last Name",
'gen' => "Generation",
+ 'mail' => "Email Address",
);
$user_data_html = <$lt{'udf'} $username\@$domain
@@ -1010,6 +1045,10 @@ END
+$lt{'mail'}:
+
+
+
END
}
@@ -1102,7 +1141,7 @@ sub print_drop_menu {
# ============================================== view classlist
sub print_html_classlist {
- my $r=shift;
+ my ($r,$mode) = @_;
if (! exists($ENV{'form.sortby'})) {
$ENV{'form.sortby'} = 'username';
}
@@ -1110,94 +1149,136 @@ sub print_html_classlist {
$ENV{'form.Status'} = 'Active';
}
my $status_select = &Apache::lonhtmlcommon::StatusOptions
- ($ENV{'form.Status'},'studentform');
- my $CCL=&mt('Current Class List');
- $r->print(<
-
-
-$CCL
-
-END
+ ($ENV{'form.Status'});
+ my $cid=$ENV{'request.course.id'};
+ my $cdom=$ENV{'course.'.$cid.'.domain'};
+ my $cnum=$ENV{'course.'.$cid.'.num'};
+ #
+ # List course personnel
+ my %coursepersonnel=&Apache::lonnet::get_course_adv_roles($cdom.'/'.$cnum);
+ #
+ if (! defined($ENV{'form.output'}) ||
+ $ENV{'form.output'} !~ /^(csv|excel|html)$/ ) {
+ $ENV{'form.output'} = 'html';
+ }
+ #
+ $r->print('
');
+ foreach my $role (sort keys %coursepersonnel) {
+ next if ($role =~ /^\s*$/);
+ $r->print(''.$role.' ');
+ foreach my $user (split(',',$coursepersonnel{$role})) {
+ my ($puname,$pudom)=split(':',$user);
+ $r->print(' '.&Apache::loncommon::aboutmewrapper(
+ &Apache::loncommon::plainname($puname,
+ $pudom),
+ $puname,$pudom));
+ }
+ $r->print(' ');
+ }
+ $r->print('
');
+ #
+ # Interface output
+ $r->print(' ');
+ $r->print("\n");
if ($ENV{'form.action'} ne 'modifystudent') {
- my %lt=&Apache::lonlocal::texthash(
- 'ef' => "Excel format",
- 'ss' => "Student Status",
- );
- $r->print(<
-CSV format
-
-$lt{'ef'}
-
-
-$lt{'ss'}:
-END
+ my %lt=&Apache::lonlocal::texthash('csv' => "CSV",
+ 'excel' => "Excel",
+ 'html' => 'HTML');
+ my $output_selector = '';
+ foreach my $outputformat ('html','csv','excel') {
+ my $option = '';
+ $output_selector .= "\n".$option;
+ }
+ $output_selector .= ' ';
+ $r->print(&mt('Output Format: [_1]',$output_selector).(' 'x3));
}
- $r->print($status_select."
\n");
- my $cid=$ENV{'request.course.id'};
+ $r->print(&mt('Student Status: [_1]',$status_select)."\n");
+ $r->print(' '.
+ "\n\n");
+ #
+ # Print the classlist
+ $r->print(''.&mt('Current Class List').' ');
my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist();
if (! defined($classlist)) {
$r->print(&mt('There are no students currently enrolled.')."\n");
} else {
# Print out the available choices
if ($ENV{'form.action'} eq 'modifystudent') {
- &show_class_list($r,'view','modify','modifystudent',
+ &show_class_list($r,'view','modify',
$ENV{'form.Status'},$classlist,$keylist);
} else {
- &show_class_list($r,'view','aboutme','classlist',
+ &show_class_list($r,$ENV{'form.output'},'aboutme',
$ENV{'form.Status'},$classlist,$keylist);
}
}
}
-# ============================================== view classlist
-sub print_formatted_classlist {
- my $r=shift;
- my $mode = shift;
- my $cid=$ENV{'request.course.id'};
- my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist();
- if (! defined($classlist)) {
- $r->print(&mt('There are no students currently enrolled.')."\n");
- } else {
- &show_class_list($r,$mode,'nolink','csv',
- $ENV{'form.Status'},$classlist,$keylist);
- }
-}
-
# =================================================== Show student list to drop
sub show_class_list {
- my ($r,$mode,$linkto,$action,$statusmode,$classlist,$keylist)=@_;
+ my ($r,$mode,$linkto,$statusmode,$classlist,$keylist)=@_;
my $cid=$ENV{'request.course.id'};
#
# Variables for excel output
- my ($excel_workbook, $excel_sheet, $excel_filename,$row);
+ my ($excel_workbook, $excel_sheet, $excel_filename,$row,$format);
+ #
+ # Variables for csv output
+ my ($CSVfile,$CSVfilename);
#
my $sortby = $ENV{'form.sortby'};
- if ($sortby !~ /^(username|domain|section|fullname|id)$/) {
+ if ($sortby !~ /^(username|domain|section|fullname|id|start|end|type)$/) {
$sortby = 'username';
}
# Print out header
- if ($mode eq 'view') {
+ unless ($mode eq 'autoenroll') {
+ $r->print(<
+END
+ }
+ $r->print(<
+END
+ if ($mode eq 'html' || $mode eq 'view' || $mode eq 'autoenroll') {
if ($linkto eq 'aboutme') {
$r->print(&mt('Select a user name to view the users personal page.'));
} elsif ($linkto eq 'modify') {
$r->print(&mt('Select a user name to modify the students information'));
}
my %lt=&Apache::lonlocal::texthash(
- 'usrn' => "username",
- 'dom' => "domain",
- 'sn' => "student name",
- 'sec' => "section",
+ 'usrn' => "username",
+ 'dom' => "domain",
+ 'sn' => "student name",
+ 'sec' => "section",
+ 'start' => "start date",
+ 'end' => "end date",
+ 'type' => "enroll type/action"
);
- $r->print(<
+ unless ($mode eq 'autoenroll') {
+ $r->print(<
+END
+ }
+ $r->print("
-
+
+ ");
+ if ($mode eq 'autoenroll') {
+ $r->print("
+ $lt{'type'}
+ ");
+ } else {
+ $r->print("
+Count
+ ");
+ }
+ $r->print(<
$lt{'usrn'}
$lt{'dom'}
@@ -1207,20 +1288,41 @@ sub show_class_list {
$lt{'sn'}
$lt{'sec'}
+
+ $lt{'start'}
+
+ $lt{'end'}
-
+
END
} elsif ($mode eq 'csv') {
+ #
+ # Open a file
+ $CSVfilename = '/prtspool/'.
+ $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'.
+ time.'_'.rand(1000000000).'.csv';
+ unless ($CSVfile = Apache::File->new('>/home/httpd'.$CSVfilename)) {
+ $r->log_error("Couldn't open $CSVfilename for output $!");
+ $r->print("Problems occured in writing the csv file. ".
+ "This error has been logged. ".
+ "Please alert your LON-CAPA administrator.");
+ $CSVfile = undef;
+ }
+ #
+ # Write headers and data to file
if($statusmode eq 'Expired') {
- $r->print(&mt('Students with expired roles'));
+ print $CSVfile '"'.&mt('Students with expired roles').'"'."\n";
}
if ($statusmode eq 'Any') {
- $r->print('"'.join('","',(&mt("username"),&mt("domain"),"ID",
- &mt("student name"),&mt("section"),&mt("status"))).
- '"'."\n");
+ print $CSVfile '"'.join('","',map {
+ &Apache::loncommon::csv_translate(&mt($_))
+ } ("username","domain","ID","student name",
+ "section","start date","end date","status")).'"'."\n";
} else {
- $r->print('"'.join('","',(&mt("username"),&mt("domain"),"ID",
- &mt("student name"),&mt("section"))).'"'."\n");
+ print $CSVfile '"'.join('","',map {
+ &Apache::loncommon::csv_translate(&mt($_))
+ } ("username","domain","ID","student name",
+ "section","start date","end date")).'"'."\n";
}
} elsif ($mode eq 'excel') {
# Create the excel spreadsheet
@@ -1230,14 +1332,18 @@ END
$excel_workbook = Spreadsheet::WriteExcel->new('/home/httpd'.
$excel_filename);
$excel_workbook->set_tempdir('/home/httpd/perl/tmp');
+ #
+ $format = &Apache::loncommon::define_excel_formats($excel_workbook);
$excel_sheet = $excel_workbook->addworksheet('classlist');
#
my $description = 'Class List for '.
$ENV{'course.'.$ENV{'request.course.id'}.'.description'};
- $excel_sheet->write($row++,0,$description);
+ $excel_sheet->write($row++,0,$description,$format->{'h1'});
#
$excel_sheet->write($row++,0,["username","domain","ID",
- "student name","section","status"]);
+ "student name","section",
+ "start date","end date","status"],
+ $format->{'bold'});
}
#
# Sort the students
@@ -1256,16 +1362,58 @@ END
||
lc($classlist->{$a}->[$third]) cmp lc($classlist->{$b}->[$third])
} (keys(%$classlist));
+ my $studentcount = 0;
+ my $autocount = 0;
+ my $manualcount = 0;
+ my $unlockcount = 0;
+ my $lockcount = 0;
foreach my $student (@Sorted_Students) {
- my $username = $classlist->{$student}->[$index{'username'}];
- my $domain = $classlist->{$student}->[$index{'domain'}];
- my $section = $classlist->{$student}->[$index{'section'}];
- my $name = $classlist->{$student}->[$index{'fullname'}];
- my $id = $classlist->{$student}->[$index{'id'}];
- my $status = $classlist->{$student}->[$index{'status'}];
+ my $sdata = $classlist->{$student};
+ my $username = $sdata->[$index{'username'}];
+ my $domain = $sdata->[$index{'domain'}];
+ my $section = $sdata->[$index{'section'}];
+ my $name = $sdata->[$index{'fullname'}];
+ my $id = $sdata->[$index{'id'}];
+ my $status = $sdata->[$index{'status'}];
+ my $start = $sdata->[$index{'start'}];
+ my $end = $sdata->[$index{'end'}];
+ my $type = $sdata->[$index{'type'}];
next if (($statusmode ne 'Any') && ($status ne $statusmode));
- if ($mode eq 'view') {
- $r->print("\n \n ");
+ if ($mode eq 'view' || $mode eq 'html' || $mode eq 'autoenroll') {
+ if (! defined($start) || $start == 0) {
+ $start = &mt('none');
+ } else {
+ $start = &Apache::lonlocal::locallocaltime($start);
+ }
+ if (! defined($end) || $end == 0) {
+ $end = &mt('none');
+ } else {
+ $end = &Apache::lonlocal::locallocaltime($end);
+ }
+ $r->print(" \n ");
+ if ($mode eq 'autoenroll') {
+ my $lockedtype = $sdata->[$index{'lockedtype'}];
+ $studentcount++;
+ my $cellentry;
+ if ($type eq 'auto') {
+ $cellentry = ''.&mt('auto').' Change';
+ $autocount ++;
+ } else {
+ $cellentry = '';
+ }
+ $r->print("$cellentry \n ");
+ } else {
+ $r->print(" ".(++$studentcount)." \n ");
+ }
if ($linkto eq 'nothing') {
$r->print($username);
} elsif ($linkto eq 'aboutme') {
@@ -1287,33 +1435,61 @@ END
$id
$name
$section
-
+ $start
+ $end
+
END
} elsif ($mode eq 'csv') {
+ next if (! defined($CSVfile));
# no need to bother with $linkto
+ if (! defined($start) || $start == 0) {
+ $start = &mt('none');
+ } else {
+ $start = &Apache::lonlocal::locallocaltime($start);
+ }
+ if (! defined($end) || $end == 0) {
+ $end = &mt('none');
+ } else {
+ $end = &Apache::lonlocal::locallocaltime($end);
+ }
my @line = ();
- foreach ($username,$domain,$id,$name,$section) {
+ foreach ($username,$domain,$id,$name,$section,$start,$end) {
push @line,&Apache::loncommon::csv_translate($_);
}
if ($statusmode eq 'Any') {
push @line,&Apache::loncommon::csv_translate($status);
}
- my $tmp = $";
- $" = '","';
- $r->print("\"@line\"\n");
- $" = $tmp;
+ print $CSVfile '"'.join('","',@line).'"'."\n";
} elsif ($mode eq 'excel') {
- $excel_sheet->write($row++,0,[$username,$domain,$id,
- $name,$section,$status]);
+ $excel_sheet->write($row,0,[$username,$domain,$id,
+ $name,$section]);
+ my $col = 5;
+ foreach my $time ($start,$end) {
+ $excel_sheet->write($row,$col++,
+ &Apache::lonstathelpers::calc_serial($time),
+ $format->{'date'});
+ }
+ $excel_sheet->write($row,$col++,$status);
+ $row++;
}
}
- if ($mode eq 'view') {
+ if ($mode eq 'view' || $mode eq 'html' || $mode eq 'autoenroll') {
$r->print('
');
} elsif ($mode eq 'excel') {
$excel_workbook->close();
$r->print(''.
&mt('Your Excel spreadsheet').' '.&mt('is ready for download').'.
'."\n");
+ } elsif ($mode eq 'csv') {
+ close($CSVfile);
+ $r->print(''.
+ &mt('Your CSV file').' is ready for download.'.
+ "\n");
+ $r->rflush();
}
+ if ($mode eq 'autoenroll') {
+ return ($studentcount,$autocount,$manualcount,$lockcount,$unlockcount);
+ }
+ return;
}
@@ -1348,7 +1524,28 @@ sub print_modify_student_form {
$r->print(''.$starttime.'
');
return;
}
+ #
# Deal with date forms
+ my $current_date_description = '';
+ my $textdate = '';
+
+ if (! defined($starttime) || $starttime == 0) {
+ $current_date_description = &mt('Current Starting Date: not set').
+ ' ';
+ } else {
+ $current_date_description =
+ &mt('Current Starting Date: [_1]',
+ &Apache::lonlocal::locallocaltime($starttime)).' ';
+ }
+ if (! defined($endtime) || $endtime == 0) {
+ $current_date_description.= &mt('Current Ending Date: not set').
+ ' ';
+ } else {
+ $current_date_description.=
+ &mt('Current Ending Date: [_1]',
+ &Apache::lonlocal::locallocaltime($endtime)).' ';
+
+ }
my $date_table = &date_setting_table($starttime,$endtime);
#
if (! exists($ENV{'form.Status'}) ||
@@ -1381,7 +1578,6 @@ $lt{'odcc'}
-
$lt{'mef'} $info{'firstname'} $info{'middlename'}
$info{'lastname'} $info{'generation'}, $sname\@$sdom
@@ -1400,8 +1596,9 @@ $info{'lastname'} $info{'generation'}, $
$lt{'disn'}
-$lt{'sec'} :
+$lt{'sec'} :
+$current_date_description
$date_table