Return to lonuploadedacc.pm CVS log

Up to [LON-CAPA] / loncom / auth

Added/modified POD documentation

    1: # The LearningOnline Network
    2: # Access Handler for User Files
    3: #
    4: # $Id: lonuploadedacc.pm,v 1.14 2008/11/12 20:01:09 jms 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: =head1 NAME
   30: 
   31: Apache::lonuploadedacc
   32: 
   33: =head1 SYNOPSIS
   34: 
   35: The way this is supposed to work:
   36: 
   37:  User A has client machine C 
   38:  User A is logged into LON-CAPA server S
   39:  needs file from user B
   40:  homeserver for user B is H
   41: 
   42: This is part of the LearningOnline Network with CAPA project
   43: described at http://www.lon-capa.org.
   44: 
   45: =head1 HANDLER SUBROUTINE
   46: 
   47: This handler runs on H
   48: To access a userfile:
   49: Server S generates a token and puts it into the query string of URL for H
   50: Client box C asks H for file with token issued by C
   51: H now must ask S if token is valid, uses S's lond-command tokenauthuserfile
   52: 
   53: =cut
   54: 
   55: package Apache::lonuploadedacc;
   56: 
   57: 
   58: use strict;
   59: use Apache::Constants qw(:common :http);
   60: use Apache::lonnet;
   61: 
   62: sub handler {
   63:     my $r = shift;
   64:     my $args=$r->args;
   65:     &Apache::loncommon::get_unprocessed_cgi($args,['token','tokenissued']); 
   66:     my (undef,undef,$udom,$uname,$ufile)=split(/\//,$r->uri,5);
   67:     $ufile=~s/^[\~\.]+//;
   68:     my $remoteserver=$env{'form.tokenissued'};
   69:     my $reply=&Apache::lonnet::reply('tokenauthuserfile:'.
   70:                  $udom.'/'.$uname.'/'.$ufile.':'.$env{'form.token'},
   71: 				     $remoteserver);
   72:     if ($reply eq 'ok') {
   73:        return OK;
   74:    } elsif ($reply eq 'con_lost' || $reply eq 'no_such_host') {
   75:        &Apache::lonnet::logthis("Server unavailable for userfile access $uname at $udom for $ufile with $remoteserver token $env{'form.token'}: $reply");
   76:        return HTTP_SERVICE_UNAVAILABLE;
   77:    } else {
   78:        &Apache::lonnet::logthis("Refused userfile access $uname at $udom for $ufile with $remoteserver token $env{'form.token'}: $reply");
   79:        return FORBIDDEN;
   80:    }
   81: }
   82: 
   83: sub skip_phase {
   84:     return OK;
   85: }
   86: 
   87: 1;
   88: __END__
   89: 
   90: 
   91: 
   92: 
   93: 
   94: 
   95: