--- loncom/interface/lonmanagekeys.pm 2003/04/12 15:57:30 1.1 +++ loncom/interface/lonmanagekeys.pm 2004/05/09 00:45:01 1.15 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Handler to manage course access keys # -# $Id: lonmanagekeys.pm,v 1.1 2003/04/12 15:57:30 www Exp $ +# $Id: lonmanagekeys.pm,v 1.15 2004/05/09 00:45:01 www Exp $ # # Copyright Michigan State University Board of Trustees # @@ -36,6 +36,7 @@ use Apache::loncommon(); use Apache::lonhtmlcommon(); use Apache::Constants qw(:common :http REDIRECT); use Spreadsheet::WriteExcel; +use Apache::lonlocal; ############################################################### ############################################################### @@ -48,108 +49,240 @@ sub header { $bodytag
+ action="/adm/managekeys" name="keyform"> ENDHEAD } # =================================================== Show student list to drop sub show_key_list { - my ($r,$mode,$linkto,$action,$statusmode,$classlist,$keylist)=@_; -# -# Just junk so that this compiles -# - my ($username,$domain,$id,$name,$section,$status,@Sorted_Students); -# -# -# - my $cid=$ENV{'request.course.id'}; - # - # Variables for excel output - my ($excel_workbook, $excel_sheet, $excel_filename,$row); - # - - # Print out header - if ($mode eq 'view') { - } elsif ($mode eq 'excel') { - # Create the excel spreadsheet - $excel_filename = '/prtspool/'. - $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'. - time.'_'.rand(1000000000).'.xls'; - $excel_workbook = Spreadsheet::WriteExcel->new('/home/httpd'. - $excel_filename); - $excel_workbook->set_tempdir('/home/httpd/perl/tmp'); - $excel_sheet = $excel_workbook->addworksheet('classlist'); - # - my $description = 'Classlist for '. - $ENV{'course.'.$ENV{'request.course.id'}.'.description'}; - $excel_sheet->write($row++,0,$description); - # - $excel_sheet->write($row++,0,["username","domain","ID", - "student name","section","status"]); - } - foreach my $student (@Sorted_Students) { - if ($mode eq 'view') { - } elsif ($mode eq 'csv') { - # no need to bother with $linkto - my @line = (); - foreach ($username,$domain,$id,$name,$section) { - push @line,&Apache::loncommon::csv_translate($_); - } - if ($statusmode eq 'Any') { - push @line,&Apache::loncommon::csv_translate($status); + my ($r,$csvlist,$comment,$newonly,$checkonly,%cenv)=@_; + $comment=~s/\W/\./g; + my %accesskeys=&Apache::lonnet::dump + ('accesskeys',$cenv{'domain'},$cenv{'num'}); + unless ($csvlist) { + $r->print(< + function copyallcom(tf) { + for (i=0; iprint("\"@line\"\n"); - $" = $tmp; - } elsif ($mode eq 'excel') { - $excel_sheet->write($row++,0,[$username,$domain,$id, - $name,$section,$status]); } + + } + +

List of Keys/Enter New Comments

+ + + +ENDTABLEHEADER + } + foreach (keys %accesskeys) { + if ($_=~/^error\:/) { + $r->print(''); + } elsif ($accesskeys{$_}=~/$comment/) { + my ($checkout,$com)=split(/\s*\#\s*/,$accesskeys{$_}); + unless ($checkout) { + if ($checkonly) { next; } + } else { + if ($newonly) { next; } + } + unless ($csvlist) { + $r->print("\n'); + } else { + my @line = (); + push @line,&Apache::loncommon::csv_translate($_); + push @line,&Apache::loncommon::csv_translate($checkout); + foreach (split(/\s*\;\s*/,$com)) { + push @line,&Apache::loncommon::csv_translate($_); + } + my $tmp = $"; + $" = '","'; + $r->print("\"@line\"\n"); + $" = $tmp; + } + } } - if ($mode eq 'view') { - } elsif ($mode eq 'excel') { - $excel_workbook->close(); - $r->print('

'. - 'Your Excel spreadsheet is ready for download.

'."\n"); + unless ($csvlist) { + $r->print('
KeyChecked OutComments/Remarks/NotesEnter Additional Comments/Remarks/Notes
+ + +
No keys have been generated yet.
".$_.''.($checkout? + $checkout:'-').''. + join('
',split(/\s*\;\s*/,$com)). + '
'); + $r->print('
'); } + return ''; } + +# ----------------------------------------------------------- Toggle Key Access + +sub togglekeyaccess { + my %cenv=@_; + unless ($cenv{'domain'}) { return; } + if ($cenv{'keyaccess'} eq 'yes') { + return 'Removing key access: '. + &Apache::lonnet::del('environment',['keyaccess'], + $cenv{'domain'},$cenv{'num'}); + } else { + return 'Establishing key access: '. + &Apache::lonnet::put('environment',{'keyaccess' => 'yes'}, + $cenv{'domain'},$cenv{'num'}); + } +} + +# --------------------------------------------------------------- Generate Keys + +sub genkeys { + my ($num,$comments,%cenv)=@_; + unless ($comments) { $comments=''; } + $comments=~s/\#/ /g; + $comments=~s/\;/ /g; + unless ($num) { return 'No number of keys given.'; } + unless (($num=~/^\d+$/) && ($num>0)) { + return 'Invalid number of keys given.'; + } + my $batchnumber='BATCH_'.time().'_'.$$; + return 'Generated '.&Apache::lonnet::generate_access_keys + ($num,$cenv{'domain'},$cenv{'num'},$batchnumber.'; '.$comments).' of '. + $num.' access keys (Batch Number: '.$batchnumber.')',$batchnumber; +} + +# ---------------------------------------------------------------- Add comments + +sub addcom { + my %cenv=@_; + my %newcomment=(); + undef %newcomment; + foreach (keys %ENV) { + if ($_=~/^form\.com\_(.+)$/) { + my $key=$1; + my $comment=$ENV{$_}; + $comment=~s/^\s+//gs; + if ($comment) { + &Apache::lonnet::comment_access_key + ($key,$cenv{'domain'},$cenv{'num'},$comment); + } + } + } + return ''; +} ################################################################### ################################################################### 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; } - &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['state']); + &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, + ['state','cid']); + if (($ENV{'form.domain'}) && ($ENV{'form.course'})) { + $ENV{'form.cid'}=$ENV{'form.domain'}.'_'.$ENV{'form.course'}; + } unless (&Apache::lonnet::allowed('mky',$ENV{'request.role.domain'})) { $ENV{'user.error.msg'}= "/adm/managekeys:mky:0:0:Cannot manage access keys"; return HTTP_NOT_ACCEPTABLE; } - # - # Only output the header information if they did not request csv format - # - if (exists($ENV{'form.state'}) && ($ENV{'form.state'} eq 'csv')) { - $r->content_type('text/csv'); - } else { - # Start page - $r->content_type('text/html'); - $r->send_http_header; - $r->print(&header()); - } + if ($ENV{'form.cid'}) { + my %cenv=&Apache::lonnet::coursedescription($ENV{'form.cid'}); + my $keytype=''; + if ($cenv{'url'} eq '/res/') { + ($cenv{'domain'},$cenv{'num'})=split(/\_/,$ENV{'form.cid'}); + $keytype='auth'; + } elsif ($cenv{'keyauth'}) { + ($cenv{'num'},$cenv{'domain'})=split(/\W/,$cenv{'keyauth'}); + $keytype='auth'; + } else { + $keytype='course'; + } + if ($ENV{'form.listkeyscsv'}) { +# +# CSV Output # -# do stuff here. + $r->content_type('text/csv'); + $r->send_http_header; # +# Do CSV +# + &show_key_list($r,1,$ENV{'form.listcom'}, + $ENV{'form.newonly'},$ENV{'form.checkonly'},%cenv); - if (exists($ENV{'form.state'}) && ($ENV{'form.state'} eq 'csv')) { - $r->print("\n"); + } else { +# +# Normal web stuff +# + &Apache::loncommon::content_type($r,'text/html'); + $r->send_http_header; + $r->print(&header()); + + $r->print( + ''); +# --- Actions + if ($ENV{'form.toggle'}) { + $r->print(&togglekeyaccess(%cenv).'
'); + %cenv=&Apache::lonnet::coursedescription($ENV{'form.cid'}); + } + my $batchnumber=''; + if ($ENV{'form.genkeys'}) { + (my $msg,$batchnumber)= + &genkeys($ENV{'form.num'},$ENV{'form.comments'},%cenv); + $r->print($msg.'
'); + } + if ($ENV{'form.listkeys'}) { + &show_key_list($r,0,$ENV{'form.listcom'}, + $ENV{'form.newonly'},$ENV{'form.checkonly'},%cenv); + } + if ($ENV{'form.addcom'}) { + &addcom(%cenv); + } +# --- Menu + if ($keytype eq 'course') { + $r->print('

'.&mt('Key Access').'

'); + if ($cenv{'keyaccess'} eq 'yes') { + $r->print(&mt('Access to this course is key controlled.'). +'
') + } else { + $r->print(&mt('Access to this course is open, no access keys').'
'); + } + } else { + $r->print('

'.&mt('Key Authority'). + ' '.$cenv{'num'}.'@'.$cenv{'domain'}.'

'); + } + $r->print(<

Generate New Keys

+Number of keys to be generated:
+Comments/Remarks/Notes:
+ +

List Keys

+Comments/Remarks/Notes/User/Batch Number Filter: +
+ Unused keys only
+ Used keys only
+ + +ENDKEYMENU + $r->print(''); + } } else { - $r->print(''); + # Start page no course id + &Apache::loncommon::content_type($r,'text/html'); + $r->send_http_header; + $r->print(&header().&Apache::loncommon::coursebrowser_javascript()); + $r->print( + &mt('Course ID of Key Authority').': '); + $r->print(&mt('Domain').': '.&Apache::loncommon::select_dom_form( + $ENV{'request.role.domain'},'domain')); + $r->print(&Apache::loncommon::selectcourse_link( + 'keyform','course','domain')); + $r->print('
'); + $r->print(''); } return OK; }