Annotation of loncom/interface/lonmanagekeys.pm, revision 1.4

1.1       www         1: # The LearningOnline Network with CAPA
                      2: # Handler to manage course access keys 
                      3: #
1.4     ! www         4: # $Id: lonmanagekeys.pm,v 1.3 2003/04/23 01:55:52 www Exp $
1.1       www         5: #
                      6: # Copyright Michigan State University Board of Trustees
                      7: #
                      8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
                      9: #
                     10: # LON-CAPA is free software; you can redistribute it and/or modify
                     11: # it under the terms of the GNU General Public License as published by
                     12: # the Free Software Foundation; either version 2 of the License, or
                     13: # (at your option) any later version.
                     14: #
                     15: # LON-CAPA is distributed in the hope that it will be useful,
                     16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
                     17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     18: # GNU General Public License for more details.
                     19: #
                     20: # You should have received a copy of the GNU General Public License
                     21: # along with LON-CAPA; if not, write to the Free Software
                     22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                     23: #
                     24: # /home/httpd/html/adm/gpl.txt
                     25: #
                     26: # http://www.lon-capa.org/
                     27: #
                     28: ###############################################################
                     29: ###############################################################
                     30: 
                     31: package Apache::lonmanagekeys;
                     32: 
                     33: use strict;
                     34: use Apache::lonnet();
                     35: use Apache::loncommon();
                     36: use Apache::lonhtmlcommon();
                     37: use Apache::Constants qw(:common :http REDIRECT);
                     38: use Spreadsheet::WriteExcel;
                     39: 
                     40: ###############################################################
                     41: ###############################################################
                     42: sub header {
                     43:     my $bodytag=&Apache::loncommon::bodytag('Access Key Management');
                     44:     return(<<ENDHEAD);
                     45: <html>
                     46: <head>
                     47: <title>LON-CAPA Access Key Management</title>
                     48: </head>
                     49: $bodytag
                     50: <form method="post" enctype="multipart/form-data"  
1.2       www        51:       action="/adm/managekeys" name="keyform">
1.1       www        52: ENDHEAD
                     53: }
                     54: 
                     55: # =================================================== Show student list to drop
                     56: sub show_key_list {
                     57:     my ($r,$mode,$linkto,$action,$statusmode,$classlist,$keylist)=@_;
                     58: #
                     59: # Just junk so that this compiles
                     60: #
                     61:     my ($username,$domain,$id,$name,$section,$status,@Sorted_Students);
                     62: #
                     63: # 
                     64: # 
1.2       www        65:     my $cid=$ENV{'form.cid'};
1.1       www        66:     #
                     67:     # Variables for excel output
                     68:     my ($excel_workbook, $excel_sheet, $excel_filename,$row);
                     69:     #
                     70: 
                     71:     # Print out header 
                     72:     if ($mode eq 'view') {
                     73:     } elsif ($mode eq 'excel') {
                     74:         # Create the excel spreadsheet
                     75:         $excel_filename = '/prtspool/'.
                     76:             $ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'.
                     77:                 time.'_'.rand(1000000000).'.xls';
                     78:         $excel_workbook = Spreadsheet::WriteExcel->new('/home/httpd'.
                     79:                                                        $excel_filename);
                     80:         $excel_workbook->set_tempdir('/home/httpd/perl/tmp');
                     81:         $excel_sheet = $excel_workbook->addworksheet('classlist');
                     82:         #
                     83:         my $description = 'Classlist for '.
                     84:             $ENV{'course.'.$ENV{'request.course.id'}.'.description'};
                     85:         $excel_sheet->write($row++,0,$description);
                     86:         #
                     87:         $excel_sheet->write($row++,0,["username","domain","ID",
                     88:                                       "student name","section","status"]);
                     89:     }
                     90:     foreach my $student (@Sorted_Students) {
                     91:         if ($mode eq 'view') {
                     92:         } elsif ($mode eq 'csv') {
                     93:             # no need to bother with $linkto
                     94:             my @line = ();
                     95:             foreach ($username,$domain,$id,$name,$section) {
                     96:                 push @line,&Apache::loncommon::csv_translate($_);
                     97:             }
                     98:             if ($statusmode eq 'Any') {
                     99:                 push @line,&Apache::loncommon::csv_translate($status);
                    100:             }
                    101:             my $tmp = $";
                    102:             $" = '","';
                    103:             $r->print("\"@line\"\n");
                    104:             $" = $tmp;
                    105:         } elsif ($mode eq 'excel') {
                    106:             $excel_sheet->write($row++,0,[$username,$domain,$id,
                    107:                                           $name,$section,$status]);
                    108:         }
                    109:     }
                    110:     if ($mode eq 'view') {
                    111:     } elsif ($mode eq 'excel') {
                    112:         $excel_workbook->close();
                    113:         $r->print('<p><a href="'.$excel_filename.'">'.
1.2       www       114:                'Your Excel spreadsheet</a> is ready for download.</p>'."\n");
                    115:     }
                    116: }
                    117: 
                    118: 
                    119: # ----------------------------------------------------------- Toggle Key Access
                    120: 
                    121: sub togglekeyaccess {
                    122:     my %cenv=@_;
                    123:     unless ($cenv{'domain'}) { return; }
                    124:     if ($cenv{'keyaccess'} eq 'yes') {
1.3       www       125:        return 'Removing key access: '.
1.2       www       126:        &Apache::lonnet::del('environment',['keyaccess'],
                    127: 			    $cenv{'domain'},$cenv{'num'});
                    128:    } else {
1.3       www       129:       return 'Establishing key access: '.
1.2       www       130:        &Apache::lonnet::put('environment',{'keyaccess' => 'yes'},
                    131: 			    $cenv{'domain'},$cenv{'num'});
1.1       www       132:     }
                    133: }
                    134: 
1.3       www       135: # --------------------------------------------------------------- Generate Keys
                    136: 
                    137: sub genkeys {
                    138:     my ($num,$comments,%cenv)=@_;
                    139:     unless ($num) { return 'No number of keys given.'; }
                    140:     unless (($num=~/^\d+$/) && ($num>0)) { 
                    141: 	return 'Invalid number of keys given.'; 
                    142:     }
                    143:     return 'Generated '.&Apache::lonnet::generate_access_keys
1.4     ! www       144:     ($num,$cenv{'domain'},$cenv{'num'},$comments).' of '.$num.
        !           145:     ' access keys.';
1.3       www       146: }
                    147: 
1.1       www       148: ###################################################################
                    149: ###################################################################
                    150: sub handler {
                    151:     my $r=shift;
                    152:     if ($r->header_only) {
                    153:         $r->content_type('text/html');
                    154:         $r->send_http_header;
                    155:         return OK;
                    156:     }
1.2       www       157:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
                    158: 					    ['state','cid']);
                    159:     if (($ENV{'form.domain'}) && ($ENV{'form.course'})) {
                    160: 	$ENV{'form.cid'}=$ENV{'form.domain'}.'_'.$ENV{'form.course'};
                    161:     }
1.1       www       162: 
                    163:     unless (&Apache::lonnet::allowed('mky',$ENV{'request.role.domain'})) {
                    164:         $ENV{'user.error.msg'}=
                    165:             "/adm/managekeys:mky:0:0:Cannot manage access keys";
                    166:         return HTTP_NOT_ACCEPTABLE; 
                    167:     }
1.2       www       168:     if ($ENV{'form.cid'}) {
1.3       www       169:         my %cenv=&Apache::lonnet::coursedescription($ENV{'form.cid'});
1.2       www       170: 	if (exists($ENV{'form.state'}) && ($ENV{'form.state'} eq 'csv')) {
1.3       www       171: #
                    172: # CSV Output
                    173: #
1.2       www       174: 	    $r->content_type('text/csv');
1.3       www       175: #
                    176: # Do CSV
                    177: #
1.2       www       178: 	} else {
1.3       www       179: #
                    180: # Normal web stuff
                    181: #
1.2       www       182: 	    $r->content_type('text/html');
                    183: 	    $r->send_http_header;
                    184: 	    $r->print(&header());
1.3       www       185: 	
                    186: 	    $r->print(
                    187: 	    '<input type="hidden" name="cid" value="'.$ENV{'form.cid'}.'" />');
                    188: # --- Actions
                    189: 	    if ($ENV{'form.toggle'}) {
                    190: 		$r->print(&togglekeyaccess(%cenv).'<br />');
                    191: 		%cenv=&Apache::lonnet::coursedescription($ENV{'form.cid'});
                    192: 	    }
                    193: 	    if ($ENV{'form.genkeys'}) {
                    194: 		$r->print(
                    195: 	      &genkeys($ENV{'form.num'},$ENV{'form.comments'},%cenv).'<br />');
                    196: 	    }
                    197: # --- Menu
                    198: 	    $r->print('<h3>Key Access</h3>');
                    199: 	    if ($cenv{'keyaccess'} eq 'yes') {
                    200: 		$r->print('Access to this course is key controlled. <input type="submit" name="toggle" value="Open Access" />')
                    201: 		} else {
                    202: 		    $r->print('Access to this course is open, no access keys. <input type="submit" name="toggle" value="Control Access" />');
1.2       www       203: 	    }
1.3       www       204: 	    $r->print(<<ENDKEYGEN);
                    205: <hr /><h3>Generate New Keys</h3>
                    206: Number of keys to be generated: <input type="text" name="num" size="6" /><br />
                    207: Comments/Remarks/Notes: <input type="text" name="comments" size="30" /><br />
                    208: <input type="submit" name="genkeys" value="Generate Keys" />
                    209: ENDKEYGEN
1.2       www       210: 	    $r->print('</form></body></html>');
                    211: 	}
1.1       www       212:     } else {
1.2       www       213: 	# Start page no course id
                    214: 	$r->content_type('text/html');
                    215: 	$r->send_http_header;
                    216: 	$r->print(&header().&Apache::loncommon::coursebrowser_javascript());
                    217:         $r->print(
                    218:    'Course ID: <input input type="text" size="25" name="course" value="" />');
                    219:         $r->print('Domain: '.&Apache::loncommon::select_dom_form(
                    220:                $ENV{'request.role.domain'},'domain'));
                    221:         $r->print(&Apache::loncommon::selectcourse_link(
                    222: 					        'keyform','course','domain'));
                    223:         $r->print('<br /><input type="submit" value="Manage Access Keys" />');
                    224: 	$r->print('</form></body></html>');
1.1       www       225:     }
                    226:     return OK;
                    227: }
                    228: 
                    229: ###################################################################
                    230: ###################################################################
                    231: 
                    232: 1;
                    233: __END__
                    234: 
                    235: 

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>