File:  [LON-CAPA] / loncom / auth / switchserver.pm
Revision 1.35.2.6.2.3: download - view: text, annotated - select for diffs
Tue Aug 30 16:20:17 2022 UTC (20 months, 2 weeks ago) by raeburn
Branches: version_2_11_4_msu
Diff to branchpoint 1.35.2.6: preferred, unified
- For 2.11.4 (modified)
  Include changes in 1.62

    1: # The LearningOnline Network
    2: # Switch Servers Handler
    3: #
    4: # $Id: switchserver.pm,v 1.35.2.6.2.3 2022/08/30 16:20:17 raeburn 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: package Apache::switchserver;
   30: 
   31: use strict;
   32: use Apache::Constants qw(:common :remotehost);
   33: use Apache::lonnet;
   34: use Digest::MD5 qw(md5_hex);
   35: use CGI::Cookie();
   36: use Apache::lonlocal;
   37: use LONCAPA qw(:DEFAULT :match);
   38: 
   39: sub init_env {
   40:     my ($r) = @_;
   41:     
   42:     if (-e $env{'user.environment'}) {
   43: 	return  $env{'user.environment'};
   44:     }
   45:     my $requrl=$r->uri;
   46:     my $handle= &Apache::lonnet::check_for_valid_session($r);
   47:     if ($handle ne '') {
   48: 	return undef;
   49:     }
   50:     my $lonidsdir=$r->dir_config('lonIDsDir');
   51:     &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle);
   52: 
   53:     return $r->dir_config('lonIDsDir')."/$handle.id";
   54: }
   55: 
   56: sub do_redirect {
   57:     my ($r,$url,$only_body,$extra_text,$write_to_opener) = @_;
   58:     $r->send_http_header;
   59:     my $delay = 0.5;
   60:     if ($only_body && !$extra_text) {
   61:         $delay = 0;
   62:     }
   63:     my $start_page = 
   64: 	&Apache::loncommon::start_page('Switching Server ...',undef,
   65: 				       {'redirect'       => [$delay,$url,'',$write_to_opener],
   66: 					'only_body'      => $only_body,});
   67:     my $end_page   = &Apache::loncommon::end_page();
   68:     $r->print($start_page.$extra_text.$end_page);
   69:     unless ($env{'user.name'} eq 'public' && ($env{'user.domain'} eq 'public')) {
   70:         $r->register_cleanup(\&flush_course_logs);
   71:     }
   72:     return OK;
   73: }
   74: 
   75: sub balancer_cookieid {
   76:     my ($r,$desthost,$uname,$udom) = @_;
   77:     my @hosts = &Apache::lonnet::current_machine_ids();
   78:     my $newcookieid;
   79:     unless (grep(/^\Q$desthost\E$/,@hosts)) {
   80:         my $balancedir=$r->dir_config('lonBalanceDir');
   81:         $newcookieid = &md5_hex(&md5_hex(time.{}.rand().$$));
   82:         my $cookie = $udom.'_'.$uname.'_'.$newcookieid;
   83:         my $balcookie = "balanceID=$cookie; path=/; HttpOnly;";
   84:         if (open(my $fh,'>',"$balancedir/$cookie.id")) {
   85:             print $fh $desthost;
   86:             close($fh);
   87:             $r->headers_out->add('Set-cookie' => $balcookie);
   88:         }
   89:     }
   90:     return $newcookieid;
   91: }
   92: 
   93: sub flush_course_logs {
   94:     &Apache::lonnet::flushcourselogs();
   95:     return OK;
   96: }
   97: 
   98: sub handler {
   99:     my ($r) = @_;
  100: 
  101:     my $handle=&init_env($r);
  102:     if (!defined($handle)) { return FORBIDDEN; }
  103: 
  104:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
  105: 				['otherserver','role','origurl','symb','lcssowin']);
  106: 
  107:     my $switch_to=&Apache::lonnet::hostname($env{'form.otherserver'});
  108:     if (! $env{'form.otherserver'}) {
  109: 	$env{'form.otherserver'} =	
  110: 	    &Apache::lonnet::find_existing_session($env{'user.domain'},
  111: 						   $env{'user.name'});
  112: 	if (! $env{'form.otherserver'}) {
  113: 	    $env{'form.otherserver'} = 
  114: 		&Apache::lonnet::spareserver($r,30000,undef,1);
  115: 	}
  116: 	$switch_to=&Apache::lonnet::hostname($env{'form.otherserver'});
  117:     }
  118: 
  119:     if (!defined($switch_to)) { return FORBIDDEN; }
  120: 
  121:     my $protocol = 'http';
  122:     if ($env{'form.otherserver'}) {
  123:         if ($Apache::lonnet::protocol{$env{'form.otherserver'}} eq 'https') {
  124:             $protocol = $Apache::lonnet::protocol{$env{'form.otherserver'}};
  125:         }
  126:         unless ($env{'form.otherserver'} eq $r->dir_config('lonHostID')) {
  127:             my $alias = &Apache::lonnet::use_proxy_alias($r,$env{'form.otherserver'});
  128:             $switch_to = $alias if ($alias ne '');
  129:         }
  130:     }
  131: 
  132:     if ($env{'user.name'} eq 'public'
  133: 	&& $env{'user.domain'} eq 'public') {
  134: 	my $url = $protocol.'://'.$switch_to.$r->uri;
  135:         unlink($handle);
  136:         #expire the cookie
  137:         my $c = new CGI::Cookie(-name    => 'lonPubID',
  138:                                 -value   => '',
  139:                                 -expires => '-10y',);
  140:         $r->header_out('Set-cookie' => $c);
  141: 	return &do_redirect($r,$url,1)
  142:     }
  143: 
  144:     my $skip_canhost_check = '';
  145:     my $now = time;
  146:     if ($env{'form.role'}) {
  147:         if (!exists($env{'user.role.'.$env{'form.role'}})) {
  148:             delete($env{'form.role'});
  149:         } else {
  150:             my ($start,$end) = split(/\./,$env{'user.role.'.$env{'form.role'}});
  151:             if (($start && $start > $now) || ($end && $end < $now)) {
  152:                 delete($env{'form.role'});
  153:             } elsif ($env{'form.role'} eq 'au./'.$env{'user.domain'}.'/') {
  154:                 if (&Apache::lonnet::homeserver($env{'user.name'},$env{'user.domain'}) eq $env{'form.otherserver'}) {
  155:                     $skip_canhost_check = 1;
  156:                 }
  157:             } elsif ($env{'form.role'} =~ m{^[ac]a\./($match_domain)/($match_username)$}) {
  158:                 if (&Apache::lonnet::homeserver($2,$1) eq $env{'form.otherserver'}) {
  159:                     $skip_canhost_check = 1; 
  160:                 }
  161:             }
  162:         }
  163:     }
  164: 
  165:     unless ($skip_canhost_check) {
  166:         my $canhost = 1;
  167:         my $uprimary_id = &Apache::lonnet::domain($env{'user.domain'},'primary');
  168:         my $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
  169:         my @intdoms;
  170:         my $internet_names = &Apache::lonnet::get_internet_names($env{'form.otherserver'});
  171:         if (ref($internet_names) eq 'ARRAY') {
  172:             @intdoms = @{$internet_names};
  173:         }
  174:         unless ($uint_dom ne '' && grep(/^\Q$uint_dom\E$/,@intdoms)) {
  175:             my $serverhomeID = &Apache::lonnet::get_server_homeID($switch_to);
  176:             my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
  177:             my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
  178:             my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
  179:             my $remoterev = &Apache::lonnet::get_server_loncaparev($env{'user.domain'},$env{'form.otherserver'});
  180:             $canhost = 
  181:                 &Apache::lonnet::can_host_session($env{'user.domain'},
  182:                                                   $env{'form.otherserver'},
  183:                                                   $remoterev,
  184:                                                   $udomdefaults{'remotesessions'},
  185:                                                   $defdomdefaults{'hostedsessions'});
  186:         }
  187:         unless ($canhost) { return FORBIDDEN; }
  188:     }
  189: 
  190:     #remove session env, and log event
  191:     if (unlink($handle)) {
  192:         if ($env{'user.linkedenv'} ne '') {
  193:             my $lonidsdir=$r->dir_config('lonIDsDir');
  194:             if (($env{'user.linkedenv'} =~ /^[a-f0-9]+_linked$/) &&
  195:                 (-l "$lonidsdir/$env{'user.linkedenv'}.id") &&
  196:                 (readlink("$lonidsdir/$env{'user.linkedenv'}.id") eq $handle)) {
  197:                 unlink("$lonidsdir/$env{'user.linkedenv'}.id");
  198:             }
  199:         }
  200:     }
  201:     my %temp=('switchserver' => $now.':'.$env{'form.otherserver'},
  202: 	      $env{'form.role'});
  203:     &Apache::lonnet::put('email_status',\%temp);
  204:     my $logmsg = "Switch Server to $env{'form.otherserver'}";
  205:     if ($env{'form.role'}) {
  206:         $logmsg .= " with role: $env{'form.role'}";
  207:     } else {
  208:         $logmsg .= " (no role)";
  209:     }
  210:     my $ip = &Apache::lonnet::get_requestor_ip($r,REMOTE_NOLOOKUP);
  211:     $logmsg .= ' '.$ip;
  212:     &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
  213: 			 $env{'user.home'},$logmsg);
  214: 
  215:     &Apache::loncommon::content_type($r,'text/html');
  216: 
  217:     #expire the cookies
  218:     my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
  219:     foreach my $name (keys(%cookies)) {
  220:         next unless ($name =~ /^lon(|S|Link|Pub)ID$/);
  221:         my $c = new CGI::Cookie(-name    => $name,
  222:                                 -value   => '',
  223:                                 -expires => '-10y',);
  224:         $r->headers_out->add('Set-cookie' => $c);
  225:     }
  226:     if ($r->header_only) {
  227: 	$r->send_http_header;
  228: 	return OK;
  229:     }
  230: # -------------------------------------------------------- Menu script and info
  231: 
  232: # ---------------------------------------------------------------- Get handover
  233: 
  234:     my ($is_balancer,$setcookie,$newcookieid,$otherbalcookie);
  235:     my $only_body = 0;
  236:     ($is_balancer,undef,$setcookie) =
  237:         &Apache::lonnet::check_loadbalancing($env{'user.name'},$env{'user.domain'},'switchserver');
  238:     if ($is_balancer && $setcookie && $env{'form.otherserver'}) {
  239: 
  240:         # Set a balancer cookie unless browser already sent LON-CAPA load balancer
  241:         # cookie which points at the target server
  242:         my ($found_server,$balancer_cookie) = &Apache::lonnet::check_for_balancer_cookie($r,1);
  243: 
  244:         if (($found_server eq $env{'form.otherserver'}) &&
  245:             ($balancer_cookie =~ /^\Q$env{'user.domain'}\E_\Q$env{'user.name'}\E_/)) {
  246:             $only_body = 1;
  247:         } else {
  248:             $newcookieid = &balancer_cookieid($r,$env{'form.otherserver'},
  249:                                               $env{'user.name'},$env{'user.domain'});
  250:         }
  251:     }
  252:     if ((!$is_balancer) && ($env{'request.balancercookie'})) {
  253:         $otherbalcookie = $env{'request.balancercookie'};
  254:     }
  255: 
  256:     my %info=('ip'       => $ip,
  257: 	      'domain'   => $env{'user.domain'},
  258: 	      'username' => $env{'user.name'},
  259: 	      'role'     => $env{'form.role'},
  260: 	      'server'   => $r->dir_config('lonHostID'),
  261: 	      'balancer' => $is_balancer);
  262:     if ($newcookieid) {
  263:         $info{'balcookie'} = $newcookieid;
  264:     } elsif ($otherbalcookie) {
  265:         $info{'otherbalcookie'} = $otherbalcookie;
  266:     }
  267:     if ($env{'form.origurl'}) {
  268:         $info{'origurl'} = $env{'form.origurl'};
  269:     }
  270:     if ($env{'form.symb'}) {
  271:         $info{'symb'} = $env{'form.symb'};
  272:     }
  273:     my $ssologoutscript = '';
  274:     my $write_to_opener;
  275:     if ($env{'request.sso.login'}) {
  276: 	$info{'sso.login'} = $env{'request.sso.login'};
  277:         if (defined($r->dir_config("lonSSOUserLogoutScriptFile_$info{domain}"))) {
  278:             if (open(my $fh,'<',$r->dir_config("lonSSOUserLogoutScriptFile_$info{domain}"))) {
  279:                 $ssologoutscript .= join('',<$fh>);
  280:                 close($fh);
  281:             }
  282:         }
  283:         if (defined($r->dir_config('lonSSOUserLogoutScriptFile'))) {
  284:             if (open(my $fh,'<',$r->dir_config('lonSSOUserLogoutScriptFile'))) {
  285:                 $ssologoutscript .= join('',<$fh>);
  286:                 close($fh);
  287:             }
  288:         }
  289:     }
  290:     if ($env{'request.sso.reloginserver'}) {
  291:         $info{'sso.reloginserver'} = $env{'request.sso.reloginserver'};
  292:     }
  293:     if ($env{'request.linkprot'}) {
  294:         $info{'linkprot'} = $env{'request.linkprot'};
  295:         foreach my $item ('linkprotuser','linkprotexit') {
  296:             if ($env{'request.'.$item}) {
  297:                 $info{$item} = $env{'request.'.$item};
  298:             }
  299:         }
  300:     } elsif ($env{'request.linkkey'} ne '') {
  301:         $info{'linkkey'} = $env{'request.linkkey'};
  302:     }
  303:     if ($env{'request.deeplink.login'}) {
  304:         $info{'deeplink.login'} = $env{'request.deeplink.login'};
  305:     }
  306:     my $token = &Apache::lonnet::tmpput(\%info,$env{'form.otherserver'});
  307:     my @args = ("domain=$env{'user.domain'}",
  308:                 "username=$env{'user.name'}",
  309:                 "token=$token");
  310:     my $url = $protocol.'://'.$switch_to.'/adm/login?';
  311:     if ($env{'form.lcssowin'}) {
  312:         $url .= join('&',@args);
  313:         $only_body = 1;
  314:     } else {
  315:         $url .= join('&amp;',@args);
  316:     }
  317: # --------------------------------------------------------------- Screen Output
  318:     return &do_redirect($r, $url, $only_body, $ssologoutscript, $env{'form.lcssowin'});
  319: }
  320: 
  321: 1;
  322: __END__
  323: 
  324: 
  325: 
  326: 
  327: 
  328: 
  329: 
  330: 

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