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

1.1       albertel    1: # The LearningOnline Network
                      2: # Switch Servers Handler
                      3: #
1.52    ! raeburn     4: # $Id: switchserver.pm,v 1.51 2020/10/22 19:23:22 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;
                     32: use Apache::Constants qw(:common);
                     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 {
                     57:     my ($r,$url,$only_body,$extra_text) = @_;
                     58:     $r->send_http_header;
1.49      raeburn    59:     my $delay = 0.5;
                     60:     if ($only_body) {
                     61:         $delay = 0;
                     62:     }
1.14      albertel   63:     my $start_page = 
1.16      raeburn    64: 	&Apache::loncommon::start_page('Switching Server ...',undef,
1.49      raeburn    65: 				       {'redirect'       => [$delay,$url],
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.1       albertel  100:     
                    101:     my $handle=&init_env($r);
                    102:     if (!defined($handle)) { return FORBIDDEN; }
                    103: 
                    104:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
1.22      raeburn   105: 				['otherserver','role','origurl','symb']);
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'} = 
                    114: 		&Apache::lonnet::spareserver(30000,undef,1);
                    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.42      raeburn   126:     }
1.33      raeburn   127: 
1.14      albertel  128:     if ($env{'user.name'} eq 'public'
                    129: 	&& $env{'user.domain'} eq 'public') {
1.33      raeburn   130: 	my $url = $protocol.'://'.$switch_to.$r->uri;
1.36      raeburn   131:         unlink($handle);
                    132:         #expire the cookie
                    133:         my $c = new CGI::Cookie(-name    => 'lonPubID',
                    134:                                 -value   => '',
                    135:                                 -expires => '-10y',);
                    136:         $r->header_out('Set-cookie' => $c);
1.14      albertel  137: 	return &do_redirect($r,$url,1)
                    138:     }
                    139: 
1.28      raeburn   140:     my $skip_canhost_check = '';
1.45      raeburn   141:     my $now = time;
1.28      raeburn   142:     if ($env{'form.role'}) {
                    143:         if (!exists($env{'user.role.'.$env{'form.role'}})) {
1.35      raeburn   144:             delete($env{'form.role'});
1.28      raeburn   145:         } else {
                    146:             my ($start,$end) = split(/\./,$env{'user.role.'.$env{'form.role'}});
                    147:             if (($start && $start > $now) || ($end && $end < $now)) {
1.35      raeburn   148:                 delete($env{'form.role'});
1.28      raeburn   149:             } elsif ($env{'form.role'} eq 'au./'.$env{'user.domain'}.'/') {
                    150:                 if (&Apache::lonnet::homeserver($env{'user.name'},$env{'user.domain'}) eq $env{'form.otherserver'}) {
                    151:                     $skip_canhost_check = 1;
                    152:                 }
1.31      raeburn   153:             } elsif ($env{'form.role'} =~ m{^[ac]a\./($match_domain)/($match_username)$}) {
1.37      raeburn   154:                 my ($audom,$auname) = ($1,$2);
                    155:                 if (&Apache::lonnet::homeserver($auname,$audom) eq $env{'form.otherserver'}) {
1.46      raeburn   156:                     if ((&Apache::lonnet::will_trust('othcoau',$env{'user.domain'},$audom)) &&
                    157:                         (&Apache::lonnet::will_trust('coaurem',$audom,$env{'user.domain'}))) {                             
1.37      raeburn   158:                         $skip_canhost_check = 1;
                    159:                     }
1.28      raeburn   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);
1.29      raeburn   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:         }
1.28      raeburn   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; }
1.26      raeburn   188:     }
                    189: 
1.1       albertel  190:     #remove session env, and log event
1.41      raeburn   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:             }
1.36      raeburn   199:         }
                    200:     }
1.42      raeburn   201:     my %temp=('switchserver' => $now.':'.$env{'form.otherserver'},
1.1       albertel  202: 	      $env{'form.role'});
                    203:     &Apache::lonnet::put('email_status',\%temp);
1.34      raeburn   204:     my $logmsg = "Switch Server to $env{'form.otherserver'}";
                    205:     if ($env{'form.role'}) {
                    206:         $logmsg .= " with role: $env{'form.role'}";
1.39      raeburn   207:     } elsif (($env{'form.lti.reqcrs'}) && ($env{'form.lti.reqrole'} eq 'cc')) {
                    208:         $logmsg .= " to create new LTI course";
                    209:     } elsif ($env{'form.lti.selfenrollrole'}) {
                    210:         $logmsg .= " to selfenroll with role: $env{'form.lti.selfenrollrole'}";
1.34      raeburn   211:     } else {
                    212:         $logmsg .= " (no role)";
                    213:     }
1.52    ! raeburn   214:     my $ip = &Apache::lonnet::get_requestor_ip();
        !           215:     $logmsg .= ' '.$ip;
1.1       albertel  216:     &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
1.34      raeburn   217: 			 $env{'user.home'},$logmsg);
1.1       albertel  218: 
                    219:     &Apache::loncommon::content_type($r,'text/html');
1.12      albertel  220: 
1.41      raeburn   221:     #expire the cookies
                    222:     my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
                    223:     foreach my $name (keys(%cookies)) {
                    224:         next unless ($name =~ /^lon(|S|Link|Pub)ID$/);
                    225:         my $c = new CGI::Cookie(-name    => $name,
                    226:                                 -value   => '',
                    227:                                 -expires => '-10y',);
                    228:         $r->headers_out->add('Set-cookie' => $c);
1.36      raeburn   229:     }
1.20      albertel  230:     if ($r->header_only) {
                    231: 	$r->send_http_header;
                    232: 	return OK;
                    233:     }
1.1       albertel  234: # -------------------------------------------------------- Menu script and info
1.51      raeburn   235: 
1.1       albertel  236: # ---------------------------------------------------------------- Get handover
                    237: 
1.51      raeburn   238:     my ($is_balancer,$setcookie,$newcookieid,$otherbalcookie,$offloadto,$dom_balancers);
1.49      raeburn   239:     my $only_body = 0;
1.50      raeburn   240:     ($is_balancer,undef,$setcookie,$offloadto,$dom_balancers) =
                    241:         &Apache::lonnet::check_loadbalancing($env{'user.name'},$env{'user.domain'},'switchserver');
1.42      raeburn   242:     if ($is_balancer && $setcookie && $env{'form.otherserver'}) {
                    243: 
                    244:         # Set a balancer cookie unless browser already sent LON-CAPA load balancer
                    245:         # cookie which points at the target server
                    246:         my ($found_server,$balancer_cookie) = &Apache::lonnet::check_for_balancer_cookie($r,1);
                    247: 
1.49      raeburn   248:         if (($found_server eq $env{'form.otherserver'}) &&
                    249:             ($balancer_cookie =~ /^\Q$env{'user.domain'}\E_\Q$env{'user.name'}\E_/)) {
                    250:             $only_body = 1;
                    251:         } else {
1.45      raeburn   252:             $newcookieid = &balancer_cookieid($r,$env{'form.otherserver'},
                    253:                                               $env{'user.name'},$env{'user.domain'});
1.42      raeburn   254:         }
                    255:     }
1.51      raeburn   256:     if ((!$is_balancer) && ($env{'request.balancercookie'})) {
                    257:         $otherbalcookie = $env{'request.balancercookie'};
                    258:     }
1.42      raeburn   259: 
1.43      raeburn   260:     my %info=('ip'            => $ENV{'REMOTE_ADDR'},
                    261:               'domain'        => $env{'user.domain'},
                    262:               'username'      => $env{'user.name'},
                    263:               'home'          => $env{'user.home'},
                    264:               'role'          => $env{'form.role'},
                    265:               'server'        => $r->dir_config('lonHostID'),
                    266:               'balancer'      => $is_balancer,
                    267:               'dom_balancers' => $dom_balancers,
                    268:               'offloadto'     => '');
                    269:     if (ref($offloadto) eq 'HASH') {
                    270:         foreach my $key (keys(%{$offloadto})) {
                    271:             if (ref($offloadto->{$key}) eq 'ARRAY') {
                    272:                 $info{'offloadto'} .= $key.'='.join(',',@{$offloadto->{$key}}).'&';
                    273:             }
                    274:         }
                    275:         $info{'offloadto'} =~ s/\&$//;
                    276:     } elsif (ref($offloadto) eq 'ARRAY') {
                    277:         $info{'offloadto'} = join(',',@{$offloadto});
                    278:     }
1.42      raeburn   279:     if ($newcookieid) {
                    280:         $info{'balcookie'} = $newcookieid;
1.51      raeburn   281:     } elsif ($otherbalcookie) {
                    282:         $info{'otherbalcookie'} = $otherbalcookie;
1.42      raeburn   283:     }
1.22      raeburn   284:     if ($env{'form.origurl'}) {
                    285:         $info{'origurl'} = $env{'form.origurl'};
                    286:     }
                    287:     if ($env{'form.symb'}) {
                    288:         $info{'symb'} = $env{'form.symb'};
                    289:     }
1.8       albertel  290:     if ($env{'request.sso.login'}) {
                    291: 	$info{'sso.login'} = $env{'request.sso.login'};
                    292:     }
1.11      raeburn   293:     if ($env{'request.sso.reloginserver'}) {
                    294:         $info{'sso.reloginserver'} = $env{'request.sso.reloginserver'};
                    295:     }
1.47      raeburn   296:     if ($env{'request.linkprot'}) {
                    297:         $info{'linkprot'} = $env{'request.linkprot'};
                    298:     }
1.48      raeburn   299:     if ($env{'request.deeplink.login'}) {
                    300:         $info{'deeplink.login'} = $env{'request.deeplink.login'};
                    301:         if ($env{'request.linkkey'}) {
                    302:             $info{'linkkey'} = $env{'request.linkkey'};
                    303:         }
                    304:     }
1.38      raeburn   305:     if ($env{'request.lti.login'}) {
                    306:         $info{'lti.login'} = $env{'request.lti.login'};
                    307:     }
1.40      raeburn   308:     if ($env{'request.lti.uri'}) {
                    309:         $info{'lti.uri'} = $env{'request.lti.uri'};
                    310:     }
1.39      raeburn   311:     if ($env{'request.lti.reqcrs'}) {
                    312:         $info{'lti.reqcrs'} = $env{'request.lti.reqcrs'};
                    313:     }
                    314:     if ($env{'request.lti.reqrole'}) {
                    315:         $info{'lti.reqrole'} = $env{'request.lti.reqrole'};
                    316:     }
                    317:     if ($env{'request.lti.selfenrollrole'}) {
                    318:         $info{'lti.selfenrollrole'} = $env{'request.lti.selfenrollrole'};
                    319:     }
                    320:     if ($env{'request.lti.sourcecrs'}) {
                    321:         $info{'lti.sourcecrs'} = $env{'request.lti.sourcecrs'};
                    322:     }
1.38      raeburn   323:     if ($env{'request.lti.passbackid'}) {
                    324:         $info{'lti.passbackid'} = $env{'request.lti.passbackid'};
                    325:     }
                    326:     if ($env{'request.lti.passbackurl'}) {
                    327:         $info{'lti.passbackurl'} = $env{'request.lti.passbackurl'};
                    328:     }
                    329:     if ($env{'request.lti.rosterid'}) {
                    330:         $info{'lti.rosterid'} = $env{'request.lti.rosterid'};
                    331:     }
                    332:     if ($env{'request.lti.rosterurl'}) {
                    333:         $info{'lti.rosterurl'} = $env{'request.lti.rosterurl'};
                    334:     }
1.40      raeburn   335:     if ($env{'request.lti.target'}) {
                    336:         $info{'lti.target'} = $env{'request.lti.target'};
                    337:     }
1.3       albertel  338:     my $token = &Apache::lonnet::tmpput(\%info,$env{'form.otherserver'});
1.33      raeburn   339:     my $url =$protocol.'://'.$switch_to.'/adm/login?'.
1.14      albertel  340: 	'domain='.$env{'user.domain'}.
1.21      albertel  341: 	'&amp;username='.$env{'user.name'}.
                    342: 	'&amp;token='.$token;
1.1       albertel  343: # --------------------------------------------------------------- Screen Output
1.49      raeburn   344:     return &do_redirect($r, $url, $only_body);
1.1       albertel  345: }
                    346: 
                    347: 1;
                    348: __END__
                    349: 
                    350: 
                    351: 
                    352: 
                    353: 
                    354: 
                    355: 
                    356: 

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