Return to switchserver.pm CVS log

Up to [LON-CAPA] / loncom / auth

- Control hosting of user sessions.
  - To accommodate multi-domain library servers, use internet domain names (e.g., msu.edu)
    instead of LON-CAPA domains in interface DC uses to set options for session hosting.

  - Provide mechanism to retrieve lonHostID for a hostname, so we can tell which
    domain determines session hosting config for external users on a multi-domain
    machine.

  - New routines in lonnet.pm:
     &get_server_homeID()  -- gets lonHostID for a hostname
     &internet_dom() -- gets internet domain name for a LON-CAPA Host ID
     &get_internet_names() -- gets internet domain names for all domains
                              for a server given one of the LC host IDs for the server.

   - New file in /home/httpd/lonTabs:
     - serverhomeIDs.tab (populated by loncron). : paired hostname:lonHostID

   - New subroutine in loncron: &write_serverhomeIDs() -- populates serverhomeIDs.tab
   - New subroutine in lond: &server_homeID_handler() -- returns LON-CAPA Host ID of server
   - New scalar in lond: $clienthomedom -- set to domain of LON-CAPA Host ID of client
   - New subroutine in domainprefs.pm: &build_location_hashes()
       -- used to set up options for session hosting as internet domain names
           - where two names (e.g., msu.edu, loncapa.org) are controlled by the same
             institution these will receive a single checkbox.

# The LearningOnline Network
# Switch Servers Handler
#
# $Id: switchserver.pm,v 1.27 2010/07/20 02:42:33 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
# This file is part of the LearningOnline Network with CAPA (LON-CAPA).
#
# LON-CAPA is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# LON-CAPA is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with LON-CAPA; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#
# /home/httpd/html/adm/gpl.txt
#
# http://www.lon-capa.org/
#

package Apache::switchserver;

use strict;
use Apache::Constants qw(:common);
use Apache::lonnet;
use Apache::lonmenu;
use CGI::Cookie();
use Apache::lonlocal;

sub init_env {
    my ($r) = @_;
    
    if (-e $env{'user.environment'}) {
	return  $env{'user.environment'};
    }
    my $requrl=$r->uri;
    my $handle= &Apache::lonnet::check_for_valid_session($r);
    if ($handle ne '') {
	return undef;
    }
    my $lonidsdir=$r->dir_config('lonIDsDir');
    &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle);
    
    return $r->dir_config('lonIDsDir')."/$handle.id";
}

sub do_redirect {
    my ($r,$url,$only_body,$extra_text) = @_;
    $r->send_http_header;
    my $start_page = 
	&Apache::loncommon::start_page('Switching Server ...',undef,
				       {'redirect'       => [0.5,$url],
					'only_body'      => $only_body,});
    my $end_page   = &Apache::loncommon::end_page();
    $r->print($start_page.$extra_text.$end_page);
    return OK;

}

sub handler {
    my ($r) = @_;
    
    my $handle=&init_env($r);
    if (!defined($handle)) { return FORBIDDEN; }

    &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
				['otherserver','role','origurl','symb']);

    my $switch_to=&Apache::lonnet::hostname($env{'form.otherserver'});
    if (! $env{'form.otherserver'}) {
	$env{'form.otherserver'} =	
	    &Apache::lonnet::find_existing_session($env{'user.domain'},
						   $env{'user.name'});
	if (! $env{'form.otherserver'}) {
	    $env{'form.otherserver'} = 
		&Apache::lonnet::spareserver(30000,undef,1);
	}
        
	$switch_to=&Apache::lonnet::hostname($env{'form.otherserver'});
    }

    if (!defined($switch_to)) { return FORBIDDEN; }

    if ($env{'user.name'} eq 'public'
	&& $env{'user.domain'} eq 'public') {
	my $url = 'http://'.$switch_to.$r->uri;
	return &do_redirect($r,$url,1)
    }

    my $canhost = 1;
    my $uprimary_id = &Apache::lonnet::domain($env{'user.domain'},'primary');
    my $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
    my @intdoms = &Apache::lonnet::get_internet_names($env{'form.otherserver'});
    unless ($uint_dom ne '' && grep(/^\Q$uint_dom\E$/,@intdoms)) {
        my $serverhomeID = &Apache::lonnet::get_server_homeID($switch_to);
        my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
        my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
        my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
        my $remoterev = &Apache::lonnet::get_server_loncaparev($env{'user.domain'},$env{'form.otherserver'});
        $canhost = 
            &Apache::lonnet::can_host_session($env{'user.domain'},
                                              $env{'form.otherserver'},
                                              $remoterev,
                                              $udomdefaults{'remotesessions'},
                                              $defdomdefaults{'hostedsessions'});
    }

    unless ($canhost) { return FORBIDDEN; }

    if ($env{'form.role'} && 
	!exists($env{'user.role.'.$env{'form.role'}})) { return FORBIDDEN; }

    #remove session env, and log event
    unlink($handle);
    my %temp=('switchserver' => time.':'.$env{'form.otherserver'},
	      $env{'form.role'});
    &Apache::lonnet::put('email_status',\%temp);
    &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
			 $env{'user.home'},
			 "Switch Server to $env{'form.otherserver'} with role $env{'form.role'} $ENV{'REMOTE_ADDR'}");

    &Apache::loncommon::content_type($r,'text/html');

    #expire the cookie
    my $c = new CGI::Cookie(-name    => 'lonID',
			    -value   => '',
			    -expires => '-10y',);
    $r->header_out('Set-cookie' => $c);

    if ($r->header_only) {
	$r->send_http_header;
	return OK;
    }
# -------------------------------------------------------- Menu script and info
	   
# ---------------------------------------------------------------- Get handover

    my %info=('ip'       => $ENV{'REMOTE_ADDR'},
	      'domain'   => $env{'user.domain'},
	      'username' => $env{'user.name'},
	      'role'     => $env{'form.role'},
	      'server'   => $r->dir_config('lonHostID'));
    if ($env{'form.origurl'}) {
        $info{'origurl'} = $env{'form.origurl'};
    }
    if ($env{'form.symb'}) {
        $info{'symb'} = $env{'form.symb'};
    }
    if ($env{'request.sso.login'}) {
	$info{'sso.login'} = $env{'request.sso.login'};
    }
    if ($env{'request.sso.reloginserver'}) {
        $info{'sso.reloginserver'} = $env{'request.sso.reloginserver'};
    }
    my $token = &Apache::lonnet::tmpput(\%info,$env{'form.otherserver'});
    my $url ='http://'.$switch_to.'/adm/login?'.
	'domain='.$env{'user.domain'}.
	'&username='.$env{'user.name'}.
	'&token='.$token;
# --------------------------------------------------------------- Screen Output
    &Apache::lonnet::flushcourselogs();
    return &do_redirect($r, $url, 0);
}

1;
__END__