File:  [LON-CAPA] / loncom / interface / lonmanagekeys.pm
Revision 1.3: download - view: text, annotated - select for diffs
Wed Apr 23 01:55:52 2003 UTC (21 years ago) by www
Branches: MAIN
CVS tags: HEAD
Continued work on key access.

    1: # The LearningOnline Network with CAPA
    2: # Handler to manage course access keys 
    3: #
    4: # $Id: lonmanagekeys.pm,v 1.3 2003/04/23 01:55:52 www Exp $
    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"  
   51:       action="/adm/managekeys" name="keyform">
   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: # 
   65:     my $cid=$ENV{'form.cid'};
   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.'">'.
  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') {
  125:        return 'Removing key access: '.
  126:        &Apache::lonnet::del('environment',['keyaccess'],
  127: 			    $cenv{'domain'},$cenv{'num'});
  128:    } else {
  129:       return 'Establishing key access: '.
  130:        &Apache::lonnet::put('environment',{'keyaccess' => 'yes'},
  131: 			    $cenv{'domain'},$cenv{'num'});
  132:     }
  133: }
  134: 
  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
  144:     ($num,$cenv{'domain'},$cenv{'number'},$comments).' access keys.';
  145: }
  146: 
  147: ###################################################################
  148: ###################################################################
  149: sub handler {
  150:     my $r=shift;
  151:     if ($r->header_only) {
  152:         $r->content_type('text/html');
  153:         $r->send_http_header;
  154:         return OK;
  155:     }
  156:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
  157: 					    ['state','cid']);
  158:     if (($ENV{'form.domain'}) && ($ENV{'form.course'})) {
  159: 	$ENV{'form.cid'}=$ENV{'form.domain'}.'_'.$ENV{'form.course'};
  160:     }
  161: 
  162:     unless (&Apache::lonnet::allowed('mky',$ENV{'request.role.domain'})) {
  163:         $ENV{'user.error.msg'}=
  164:             "/adm/managekeys:mky:0:0:Cannot manage access keys";
  165:         return HTTP_NOT_ACCEPTABLE; 
  166:     }
  167:     if ($ENV{'form.cid'}) {
  168:         my %cenv=&Apache::lonnet::coursedescription($ENV{'form.cid'});
  169: 	if (exists($ENV{'form.state'}) && ($ENV{'form.state'} eq 'csv')) {
  170: #
  171: # CSV Output
  172: #
  173: 	    $r->content_type('text/csv');
  174: #
  175: # Do CSV
  176: #
  177: 	} else {
  178: #
  179: # Normal web stuff
  180: #
  181: 	    $r->content_type('text/html');
  182: 	    $r->send_http_header;
  183: 	    $r->print(&header());
  184: 	
  185: 	    $r->print(
  186: 	    '<input type="hidden" name="cid" value="'.$ENV{'form.cid'}.'" />');
  187: # --- Actions
  188: 	    if ($ENV{'form.toggle'}) {
  189: 		$r->print(&togglekeyaccess(%cenv).'<br />');
  190: 		%cenv=&Apache::lonnet::coursedescription($ENV{'form.cid'});
  191: 	    }
  192: 	    if ($ENV{'form.genkeys'}) {
  193: 		$r->print(
  194: 	      &genkeys($ENV{'form.num'},$ENV{'form.comments'},%cenv).'<br />');
  195: 	    }
  196: # --- Menu
  197: 	    $r->print('<h3>Key Access</h3>');
  198: 	    if ($cenv{'keyaccess'} eq 'yes') {
  199: 		$r->print('Access to this course is key controlled. <input type="submit" name="toggle" value="Open Access" />')
  200: 		} else {
  201: 		    $r->print('Access to this course is open, no access keys. <input type="submit" name="toggle" value="Control Access" />');
  202: 	    }
  203: 	    $r->print(<<ENDKEYGEN);
  204: <hr /><h3>Generate New Keys</h3>
  205: Number of keys to be generated: <input type="text" name="num" size="6" /><br />
  206: Comments/Remarks/Notes: <input type="text" name="comments" size="30" /><br />
  207: <input type="submit" name="genkeys" value="Generate Keys" />
  208: ENDKEYGEN
  209: 	    $r->print('</form></body></html>');
  210: 	}
  211:     } else {
  212: 	# Start page no course id
  213: 	$r->content_type('text/html');
  214: 	$r->send_http_header;
  215: 	$r->print(&header().&Apache::loncommon::coursebrowser_javascript());
  216:         $r->print(
  217:    'Course ID: <input input type="text" size="25" name="course" value="" />');
  218:         $r->print('Domain: '.&Apache::loncommon::select_dom_form(
  219:                $ENV{'request.role.domain'},'domain'));
  220:         $r->print(&Apache::loncommon::selectcourse_link(
  221: 					        'keyform','course','domain'));
  222:         $r->print('<br /><input type="submit" value="Manage Access Keys" />');
  223: 	$r->print('</form></body></html>');
  224:     }
  225:     return OK;
  226: }
  227: 
  228: ###################################################################
  229: ###################################################################
  230: 
  231: 1;
  232: __END__
  233: 
  234: 

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