Annotation of loncom/auth/switchserver.pm, revision 1.62

1.1       albertel    1: # The LearningOnline Network
                      2: # Switch Servers Handler
                      3: #
1.62    ! raeburn     4: # $Id: switchserver.pm,v 1.61 2022/06/30 21:04:13 raeburn Exp $
1.1       albertel    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;
1.55      raeburn    32: use Apache::Constants qw(:common :remotehost);
1.1       albertel   33: use Apache::lonnet;
1.42      raeburn    34: use Digest::MD5 qw(md5_hex);
1.1       albertel   35: use CGI::Cookie();
                     36: use Apache::lonlocal;
1.28      raeburn    37: use LONCAPA qw(:DEFAULT :match);
1.1       albertel   38: 
                     39: sub init_env {
                     40:     my ($r) = @_;
1.5       albertel   41:     
                     42:     if (-e $env{'user.environment'}) {
                     43: 	return  $env{'user.environment'};
                     44:     }
1.1       albertel   45:     my $requrl=$r->uri;
1.18      albertel   46:     my $handle= &Apache::lonnet::check_for_valid_session($r);
                     47:     if ($handle ne '') {
1.1       albertel   48: 	return undef;
                     49:     }
1.18      albertel   50:     my $lonidsdir=$r->dir_config('lonIDsDir');
1.1       albertel   51:     &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle);
1.42      raeburn    52: 
1.5       albertel   53:     return $r->dir_config('lonIDsDir')."/$handle.id";
1.1       albertel   54: }
                     55: 
1.14      albertel   56: sub do_redirect {
1.62    ! raeburn    57:     my ($r,$url,$only_body,$extra_text,$write_to_opener) = @_;
1.14      albertel   58:     $r->send_http_header;
1.49      raeburn    59:     my $delay = 0.5;
1.56      raeburn    60:     if ($only_body && !$extra_text) {
1.49      raeburn    61:         $delay = 0;
                     62:     }
1.14      albertel   63:     my $start_page = 
1.16      raeburn    64: 	&Apache::loncommon::start_page('Switching Server ...',undef,
1.62    ! raeburn    65: 				       {'redirect'       => [$delay,$url,'',$write_to_opener],
1.14      albertel   66: 					'only_body'      => $only_body,});
                     67:     my $end_page   = &Apache::loncommon::end_page();
                     68:     $r->print($start_page.$extra_text.$end_page);
1.30      raeburn    69:     unless ($env{'user.name'} eq 'public' && ($env{'user.domain'} eq 'public')) {
                     70:         $r->register_cleanup(\&flush_course_logs);
                     71:     }
1.14      albertel   72:     return OK;
1.30      raeburn    73: }
1.14      albertel   74: 
1.45      raeburn    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: 
1.30      raeburn    93: sub flush_course_logs {
                     94:     &Apache::lonnet::flushcourselogs();
                     95:     return OK;
1.14      albertel   96: }
                     97: 
1.1       albertel   98: sub handler {
1.5       albertel   99:     my ($r) = @_;
1.60      raeburn   100: 
1.1       albertel  101:     my $handle=&init_env($r);
                    102:     if (!defined($handle)) { return FORBIDDEN; }
                    103: 
                    104:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
1.62    ! raeburn   105: 				['otherserver','role','origurl','symb','lcssowin']);
1.5       albertel  106: 
1.13      albertel  107:     my $switch_to=&Apache::lonnet::hostname($env{'form.otherserver'});
1.17      albertel  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'} = 
1.55      raeburn   114: 		&Apache::lonnet::spareserver($r,30000,undef,1);
1.17      albertel  115: 	}
1.13      albertel  116: 	$switch_to=&Apache::lonnet::hostname($env{'form.otherserver'});
1.4       albertel  117:     }
1.5       albertel  118: 
1.1       albertel  119:     if (!defined($switch_to)) { return FORBIDDEN; }
1.4       albertel  120: 
1.33      raeburn   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:         }
1.54      raeburn   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:         }
1.42      raeburn   130:     }
1.33      raeburn   131: 
1.14      albertel  132:     if ($env{'user.name'} eq 'public'
                    133: 	&& $env{'user.domain'} eq 'public') {
1.33      raeburn   134: 	my $url = $protocol.'://'.$switch_to.$r->uri;
1.36      raeburn   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);
1.14      albertel  141: 	return &do_redirect($r,$url,1)
                    142:     }
                    143: 
1.28      raeburn   144:     my $skip_canhost_check = '';
1.45      raeburn   145:     my $now = time;
1.28      raeburn   146:     if ($env{'form.role'}) {
                    147:         if (!exists($env{'user.role.'.$env{'form.role'}})) {
1.35      raeburn   148:             delete($env{'form.role'});
1.28      raeburn   149:         } else {
                    150:             my ($start,$end) = split(/\./,$env{'user.role.'.$env{'form.role'}});
                    151:             if (($start && $start > $now) || ($end && $end < $now)) {
1.35      raeburn   152:                 delete($env{'form.role'});
1.28      raeburn   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:                 }
1.31      raeburn   157:             } elsif ($env{'form.role'} =~ m{^[ac]a\./($match_domain)/($match_username)$}) {
1.37      raeburn   158:                 my ($audom,$auname) = ($1,$2);
                    159:                 if (&Apache::lonnet::homeserver($auname,$audom) eq $env{'form.otherserver'}) {
1.46      raeburn   160:                     if ((&Apache::lonnet::will_trust('othcoau',$env{'user.domain'},$audom)) &&
                    161:                         (&Apache::lonnet::will_trust('coaurem',$audom,$env{'user.domain'}))) {                             
1.37      raeburn   162:                         $skip_canhost_check = 1;
                    163:                     }
1.28      raeburn   164:                 }
                    165:             }
                    166:         }
                    167:     }
                    168: 
                    169:     unless ($skip_canhost_check) {
                    170:         my $canhost = 1;
                    171:         my $uprimary_id = &Apache::lonnet::domain($env{'user.domain'},'primary');
                    172:         my $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
1.29      raeburn   173:         my @intdoms;
                    174:         my $internet_names = &Apache::lonnet::get_internet_names($env{'form.otherserver'});
                    175:         if (ref($internet_names) eq 'ARRAY') {
                    176:             @intdoms = @{$internet_names};
                    177:         }
1.28      raeburn   178:         unless ($uint_dom ne '' && grep(/^\Q$uint_dom\E$/,@intdoms)) {
                    179:             my $serverhomeID = &Apache::lonnet::get_server_homeID($switch_to);
                    180:             my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                    181:             my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
                    182:             my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
                    183:             my $remoterev = &Apache::lonnet::get_server_loncaparev($env{'user.domain'},$env{'form.otherserver'});
                    184:             $canhost = 
                    185:                 &Apache::lonnet::can_host_session($env{'user.domain'},
                    186:                                                   $env{'form.otherserver'},
                    187:                                                   $remoterev,
                    188:                                                   $udomdefaults{'remotesessions'},
                    189:                                                   $defdomdefaults{'hostedsessions'});
                    190:         }
                    191:         unless ($canhost) { return FORBIDDEN; }
1.26      raeburn   192:     }
                    193: 
1.1       albertel  194:     #remove session env, and log event
1.41      raeburn   195:     if (unlink($handle)) {
                    196:         if ($env{'user.linkedenv'} ne '') {
                    197:             my $lonidsdir=$r->dir_config('lonIDsDir');
                    198:             if (($env{'user.linkedenv'} =~ /^[a-f0-9]+_linked$/) &&
                    199:                 (-l "$lonidsdir/$env{'user.linkedenv'}.id") &&
                    200:                 (readlink("$lonidsdir/$env{'user.linkedenv'}.id") eq $handle)) {
                    201:                 unlink("$lonidsdir/$env{'user.linkedenv'}.id");
                    202:             }
1.36      raeburn   203:         }
                    204:     }
1.42      raeburn   205:     my %temp=('switchserver' => $now.':'.$env{'form.otherserver'},
1.1       albertel  206: 	      $env{'form.role'});
                    207:     &Apache::lonnet::put('email_status',\%temp);
1.34      raeburn   208:     my $logmsg = "Switch Server to $env{'form.otherserver'}";
                    209:     if ($env{'form.role'}) {
                    210:         $logmsg .= " with role: $env{'form.role'}";
1.39      raeburn   211:     } elsif (($env{'form.lti.reqcrs'}) && ($env{'form.lti.reqrole'} eq 'cc')) {
                    212:         $logmsg .= " to create new LTI course";
                    213:     } elsif ($env{'form.lti.selfenrollrole'}) {
                    214:         $logmsg .= " to selfenroll with role: $env{'form.lti.selfenrollrole'}";
1.34      raeburn   215:     } else {
                    216:         $logmsg .= " (no role)";
                    217:     }
1.55      raeburn   218:     my $ip = &Apache::lonnet::get_requestor_ip($r,REMOTE_NOLOOKUP);
1.52      raeburn   219:     $logmsg .= ' '.$ip;
1.1       albertel  220:     &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
1.34      raeburn   221: 			 $env{'user.home'},$logmsg);
1.1       albertel  222: 
                    223:     &Apache::loncommon::content_type($r,'text/html');
1.12      albertel  224: 
1.41      raeburn   225:     #expire the cookies
                    226:     my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
                    227:     foreach my $name (keys(%cookies)) {
                    228:         next unless ($name =~ /^lon(|S|Link|Pub)ID$/);
                    229:         my $c = new CGI::Cookie(-name    => $name,
                    230:                                 -value   => '',
                    231:                                 -expires => '-10y',);
                    232:         $r->headers_out->add('Set-cookie' => $c);
1.36      raeburn   233:     }
1.20      albertel  234:     if ($r->header_only) {
                    235: 	$r->send_http_header;
                    236: 	return OK;
                    237:     }
1.1       albertel  238: # -------------------------------------------------------- Menu script and info
1.51      raeburn   239: 
1.1       albertel  240: # ---------------------------------------------------------------- Get handover
                    241: 
1.51      raeburn   242:     my ($is_balancer,$setcookie,$newcookieid,$otherbalcookie,$offloadto,$dom_balancers);
1.49      raeburn   243:     my $only_body = 0;
1.50      raeburn   244:     ($is_balancer,undef,$setcookie,$offloadto,$dom_balancers) =
                    245:         &Apache::lonnet::check_loadbalancing($env{'user.name'},$env{'user.domain'},'switchserver');
1.42      raeburn   246:     if ($is_balancer && $setcookie && $env{'form.otherserver'}) {
                    247: 
                    248:         # Set a balancer cookie unless browser already sent LON-CAPA load balancer
                    249:         # cookie which points at the target server
                    250:         my ($found_server,$balancer_cookie) = &Apache::lonnet::check_for_balancer_cookie($r,1);
                    251: 
1.49      raeburn   252:         if (($found_server eq $env{'form.otherserver'}) &&
                    253:             ($balancer_cookie =~ /^\Q$env{'user.domain'}\E_\Q$env{'user.name'}\E_/)) {
                    254:             $only_body = 1;
                    255:         } else {
1.45      raeburn   256:             $newcookieid = &balancer_cookieid($r,$env{'form.otherserver'},
                    257:                                               $env{'user.name'},$env{'user.domain'});
1.42      raeburn   258:         }
                    259:     }
1.51      raeburn   260:     if ((!$is_balancer) && ($env{'request.balancercookie'})) {
                    261:         $otherbalcookie = $env{'request.balancercookie'};
                    262:     }
1.42      raeburn   263: 
1.53      raeburn   264:     my %info=('ip'            => $ip,
1.43      raeburn   265:               'domain'        => $env{'user.domain'},
                    266:               'username'      => $env{'user.name'},
                    267:               'home'          => $env{'user.home'},
                    268:               'role'          => $env{'form.role'},
                    269:               'server'        => $r->dir_config('lonHostID'),
                    270:               'balancer'      => $is_balancer,
                    271:               'dom_balancers' => $dom_balancers,
                    272:               'offloadto'     => '');
                    273:     if (ref($offloadto) eq 'HASH') {
                    274:         foreach my $key (keys(%{$offloadto})) {
                    275:             if (ref($offloadto->{$key}) eq 'ARRAY') {
                    276:                 $info{'offloadto'} .= $key.'='.join(',',@{$offloadto->{$key}}).'&';
                    277:             }
                    278:         }
                    279:         $info{'offloadto'} =~ s/\&$//;
                    280:     } elsif (ref($offloadto) eq 'ARRAY') {
                    281:         $info{'offloadto'} = join(',',@{$offloadto});
                    282:     }
1.42      raeburn   283:     if ($newcookieid) {
                    284:         $info{'balcookie'} = $newcookieid;
1.51      raeburn   285:     } elsif ($otherbalcookie) {
                    286:         $info{'otherbalcookie'} = $otherbalcookie;
1.42      raeburn   287:     }
1.22      raeburn   288:     if ($env{'form.origurl'}) {
                    289:         $info{'origurl'} = $env{'form.origurl'};
                    290:     }
                    291:     if ($env{'form.symb'}) {
                    292:         $info{'symb'} = $env{'form.symb'};
                    293:     }
1.62    ! raeburn   294:     my $ssologoutscript = '';
        !           295:     my $write_to_opener;
1.8       albertel  296:     if ($env{'request.sso.login'}) {
                    297: 	$info{'sso.login'} = $env{'request.sso.login'};
1.56      raeburn   298:         if (defined($r->dir_config("lonSSOUserLogoutScriptFile_$info{domain}"))) {
                    299:             if (open(my $fh,'<',$r->dir_config("lonSSOUserLogoutScriptFile_$info{domain}"))) {
                    300:                 $ssologoutscript .= join('',<$fh>);
                    301:                 close($fh); 
                    302:             }
                    303:         }
1.58      raeburn   304:         if (defined($r->dir_config('lonSSOUserLogoutScriptFile'))) {
1.56      raeburn   305:             if (open(my $fh,'<',$r->dir_config('lonSSOUserLogoutScriptFile'))) {
                    306:                 $ssologoutscript .= join('',<$fh>);
                    307:                 close($fh);
                    308:             }
                    309:         }
1.8       albertel  310:     }
1.11      raeburn   311:     if ($env{'request.sso.reloginserver'}) {
                    312:         $info{'sso.reloginserver'} = $env{'request.sso.reloginserver'};
                    313:     }
1.47      raeburn   314:     if ($env{'request.linkprot'}) {
                    315:         $info{'linkprot'} = $env{'request.linkprot'};
1.61      raeburn   316:         foreach my $item ('linkprotuser','linkprotexit') {
                    317:             if ($env{'request.'.$item}) {
                    318:                 $info{$item} = $env{'request.'.$item};
                    319:             }
1.60      raeburn   320:         }
1.59      raeburn   321:     } elsif ($env{'request.linkkey'} ne '') {
1.57      raeburn   322:         $info{'linkkey'} = $env{'request.linkkey'};
1.47      raeburn   323:     }
1.48      raeburn   324:     if ($env{'request.deeplink.login'}) {
                    325:         $info{'deeplink.login'} = $env{'request.deeplink.login'};
                    326:     }
1.38      raeburn   327:     if ($env{'request.lti.login'}) {
                    328:         $info{'lti.login'} = $env{'request.lti.login'};
                    329:     }
1.40      raeburn   330:     if ($env{'request.lti.uri'}) {
                    331:         $info{'lti.uri'} = $env{'request.lti.uri'};
                    332:     }
1.39      raeburn   333:     if ($env{'request.lti.reqcrs'}) {
                    334:         $info{'lti.reqcrs'} = $env{'request.lti.reqcrs'};
                    335:     }
                    336:     if ($env{'request.lti.reqrole'}) {
                    337:         $info{'lti.reqrole'} = $env{'request.lti.reqrole'};
                    338:     }
                    339:     if ($env{'request.lti.selfenrollrole'}) {
                    340:         $info{'lti.selfenrollrole'} = $env{'request.lti.selfenrollrole'};
                    341:     }
                    342:     if ($env{'request.lti.sourcecrs'}) {
                    343:         $info{'lti.sourcecrs'} = $env{'request.lti.sourcecrs'};
                    344:     }
1.38      raeburn   345:     if ($env{'request.lti.passbackid'}) {
                    346:         $info{'lti.passbackid'} = $env{'request.lti.passbackid'};
                    347:     }
                    348:     if ($env{'request.lti.passbackurl'}) {
                    349:         $info{'lti.passbackurl'} = $env{'request.lti.passbackurl'};
                    350:     }
                    351:     if ($env{'request.lti.rosterid'}) {
                    352:         $info{'lti.rosterid'} = $env{'request.lti.rosterid'};
                    353:     }
                    354:     if ($env{'request.lti.rosterurl'}) {
                    355:         $info{'lti.rosterurl'} = $env{'request.lti.rosterurl'};
                    356:     }
1.40      raeburn   357:     if ($env{'request.lti.target'}) {
                    358:         $info{'lti.target'} = $env{'request.lti.target'};
                    359:     }
1.3       albertel  360:     my $token = &Apache::lonnet::tmpput(\%info,$env{'form.otherserver'});
1.62    ! raeburn   361:     my @args = ("domain=$env{'user.domain'}",
        !           362:                 "username=$env{'user.name'}",
        !           363:                 "token=$token");
        !           364:     my $url = $protocol.'://'.$switch_to.'/adm/login?';
        !           365:     if ($env{'form.lcssowin'}) {
        !           366:         $url .= join('&',@args);
        !           367:         $only_body = 1;
        !           368:     } else {
        !           369:         $url .= join('&amp;',@args);
        !           370:     }
1.1       albertel  371: # --------------------------------------------------------------- Screen Output
1.62    ! raeburn   372:     return &do_redirect($r, $url, $only_body, $ssologoutscript, $env{'form.lcssowin'});
1.1       albertel  373: }
                    374: 
                    375: 1;
                    376: __END__
                    377: 
                    378: 
                    379: 
                    380: 
                    381: 
                    382: 
                    383: 
                    384: 

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