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

1.1       albertel    1: # The LearningOnline Network
                      2: # Switch Servers Handler
                      3: #
1.35.2.8! raeburn     4: # $Id: switchserver.pm,v 1.35.2.7 2024/07/02 19:42:06 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.35.2.6  raeburn    32: use Apache::Constants qw(:common :remotehost);
1.1       albertel   33: use Apache::lonnet;
1.35.2.1  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.35.2.1  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.35.2.1  raeburn    59:     my $delay = 0.5;
1.35.2.6  raeburn    60:     if ($only_body && !$extra_text) {
1.35.2.1  raeburn    61:         $delay = 0;
                     62:     }
1.14      albertel   63:     my $start_page = 
1.16      raeburn    64: 	&Apache::loncommon::start_page('Switching Server ...',undef,
1.35.2.7  raeburn    65: 				       {'redirect'       => [$delay,$url,'',1],
1.35.2.8! raeburn    66: 					'only_body'      => $only_body,
        !            67:                                         'switchserver'   => 1,
        !            68:                                         'links_disabled' => 1,
        !            69:                                         'no_inline_link' => 1,});
1.14      albertel   70:     my $end_page   = &Apache::loncommon::end_page();
                     71:     $r->print($start_page.$extra_text.$end_page);
1.30      raeburn    72:     unless ($env{'user.name'} eq 'public' && ($env{'user.domain'} eq 'public')) {
                     73:         $r->register_cleanup(\&flush_course_logs);
                     74:     }
1.14      albertel   75:     return OK;
1.30      raeburn    76: }
1.14      albertel   77: 
1.35.2.1  raeburn    78: sub balancer_cookieid {
                     79:     my ($r,$desthost,$uname,$udom) = @_;
                     80:     my @hosts = &Apache::lonnet::current_machine_ids();
                     81:     my $newcookieid;
                     82:     unless (grep(/^\Q$desthost\E$/,@hosts)) {
                     83:         my $balancedir=$r->dir_config('lonBalanceDir');
                     84:         $newcookieid = &md5_hex(&md5_hex(time.{}.rand().$$));
                     85:         my $cookie = $udom.'_'.$uname.'_'.$newcookieid;
                     86:         my $balcookie = "balanceID=$cookie; path=/; HttpOnly;";
                     87:         if (open(my $fh,'>',"$balancedir/$cookie.id")) {
                     88:             print $fh $desthost;
                     89:             close($fh);
                     90:             $r->headers_out->add('Set-cookie' => $balcookie);
                     91:         }
                     92:     }
                     93:     return $newcookieid;
                     94: }
                     95: 
1.30      raeburn    96: sub flush_course_logs {
                     97:     &Apache::lonnet::flushcourselogs();
                     98:     return OK;
1.14      albertel   99: }
                    100: 
1.1       albertel  101: sub handler {
1.5       albertel  102:     my ($r) = @_;
1.1       albertel  103:     
                    104:     my $handle=&init_env($r);
                    105:     if (!defined($handle)) { return FORBIDDEN; }
                    106: 
                    107:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
1.35.2.7  raeburn   108: 				['otherserver','role','origurl','symb','edit']);
1.5       albertel  109: 
1.13      albertel  110:     my $switch_to=&Apache::lonnet::hostname($env{'form.otherserver'});
1.17      albertel  111:     if (! $env{'form.otherserver'}) {
                    112: 	$env{'form.otherserver'} =	
                    113: 	    &Apache::lonnet::find_existing_session($env{'user.domain'},
                    114: 						   $env{'user.name'});
                    115: 	if (! $env{'form.otherserver'}) {
                    116: 	    $env{'form.otherserver'} = 
1.35.2.6  raeburn   117: 		&Apache::lonnet::spareserver($r,30000,undef,1);
1.17      albertel  118: 	}
1.13      albertel  119: 	$switch_to=&Apache::lonnet::hostname($env{'form.otherserver'});
1.4       albertel  120:     }
1.5       albertel  121: 
1.1       albertel  122:     if (!defined($switch_to)) { return FORBIDDEN; }
1.4       albertel  123: 
1.33      raeburn   124:     my $protocol = 'http';
                    125:     if ($env{'form.otherserver'}) {
                    126:         if ($Apache::lonnet::protocol{$env{'form.otherserver'}} eq 'https') {
                    127:             $protocol = $Apache::lonnet::protocol{$env{'form.otherserver'}};
                    128:         }
1.35.2.6  raeburn   129:         unless ($env{'form.otherserver'} eq $r->dir_config('lonHostID')) {
                    130:             my $alias = &Apache::lonnet::use_proxy_alias($r,$env{'form.otherserver'});
                    131:             $switch_to = $alias if ($alias ne '');
                    132:         }
1.35.2.1  raeburn   133:     }
1.33      raeburn   134: 
1.14      albertel  135:     if ($env{'user.name'} eq 'public'
                    136: 	&& $env{'user.domain'} eq 'public') {
1.33      raeburn   137: 	my $url = $protocol.'://'.$switch_to.$r->uri;
1.35.2.2  raeburn   138:         unlink($handle);
                    139:         #expire the cookie
                    140:         my $c = new CGI::Cookie(-name    => 'lonPubID',
                    141:                                 -value   => '',
                    142:                                 -expires => '-10y',);
                    143:         $r->header_out('Set-cookie' => $c);
1.14      albertel  144: 	return &do_redirect($r,$url,1)
                    145:     }
                    146: 
1.28      raeburn   147:     my $skip_canhost_check = '';
1.35.2.1  raeburn   148:     my $now = time;
1.28      raeburn   149:     if ($env{'form.role'}) {
                    150:         if (!exists($env{'user.role.'.$env{'form.role'}})) {
1.35      raeburn   151:             delete($env{'form.role'});
1.28      raeburn   152:         } else {
                    153:             my ($start,$end) = split(/\./,$env{'user.role.'.$env{'form.role'}});
                    154:             if (($start && $start > $now) || ($end && $end < $now)) {
1.35      raeburn   155:                 delete($env{'form.role'});
1.28      raeburn   156:             } elsif ($env{'form.role'} eq 'au./'.$env{'user.domain'}.'/') {
                    157:                 if (&Apache::lonnet::homeserver($env{'user.name'},$env{'user.domain'}) eq $env{'form.otherserver'}) {
                    158:                     $skip_canhost_check = 1;
                    159:                 }
1.31      raeburn   160:             } elsif ($env{'form.role'} =~ m{^[ac]a\./($match_domain)/($match_username)$}) {
1.28      raeburn   161:                 if (&Apache::lonnet::homeserver($2,$1) eq $env{'form.otherserver'}) {
                    162:                     $skip_canhost_check = 1; 
                    163:                 }
                    164:             }
                    165:         }
                    166:     }
                    167: 
                    168:     unless ($skip_canhost_check) {
1.35.2.7  raeburn   169:         my $canhost = &Apache::lonnet::can_switchserver($env{'user.domain'},$env{'form.otherserver'});
                    170:         unless ($canhost) {
                    171:             if (($env{'request.course.id'}) && ($env{'form.symb'} ne '') &&
                    172:                 (&Apache::lonnet::allowed('mdc',$env{'request.course.id'}))) {
                    173:                 my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                    174:                 my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                    175:                 if (($cdom ne '') && ($cnum ne '') && ($env{'form.role'} =~ m{^([^.]+)\Q./$cdom/$cnum\E$})) {
                    176:                     my $symb = &Apache::lonnet::symbclean($env{'form.symb'});
                    177:                     my ($map,$idx,$url) = &Apache::lonnet::decode_symb($symb);
                    178:                     if (&Apache::lonnet::symbverify($symb,$url)) {
                    179:                         my $fileloc = &Apache::lonnet::declutter(&Apache::lonnet::filelocation("",$url));
                    180:                         my $resurl = &Apache::lonnet::clutter($url);
                    181:                         if ($resurl =~ m{^/res/($match_domain)/($match_username)/}) {
                    182:                             my ($audom,$auname) = ($1,$2);
                    183:                             if (&Apache::lonnet::homeserver($auname,$audom) eq $env{'form.otherserver'}) {
                    184:                                 my @possroles = ("user.role.au./$audom/","user.role.ca./$audom/$auname","user.role.aa./$audom/$auname");
                    185:                                 my $hasrole;
                    186:                                 foreach my $rolekey (@possroles) {
                    187:                                     if (exists($env{$rolekey})) {
                    188:                                         my ($start,$end) = split(/\./,$env{$rolekey});
                    189:                                         unless (($start && $start > $now) || ($end && $end < $now)) {
                    190:                                             $hasrole = $rolekey;
                    191:                                         }
                    192:                                         if ($hasrole) {
                    193:                                             $hasrole =~ s/^\Quser.role.\E//;
                    194:                                             last;
                    195:                                         }
                    196:                                     }
                    197:                                 }
                    198:                                 if ($hasrole) {
                    199:                                     $env{'form.role'} = $hasrole;
                    200:                                     $env{'form.origurl'} = &Apache::lonnet::deversion($resurl);
                    201:                                     $env{'form.origurl'} =~ s{^/res/}{/priv/};
                    202:                                     delete($env{'form.symb'});
                    203:                                     $canhost = 1;
                    204:                                     if ($env{'form.edit'}) {
                    205:                                         my $ip = &Apache::lonnet::get_requestor_ip($r,REMOTE_NOLOOKUP);
                    206:                                         my %info=('ip'            => $ip,
                    207:                                                   'domain'        => $env{'user.domain'},
                    208:                                                   'username'      => $env{'user.name'},
                    209:                                                   'home'          => $env{'user.home'},
                    210:                                                   'role'          => $env{'form.role'},
                    211:                                                   'server'        => $r->dir_config('lonHostID'),
                    212:                                                   'origurl'       => $env{'form.origurl'});
                    213:                                         &Apache::loncommon::content_type($r,'text/html');
                    214:                                         my $token = &Apache::lonnet::tmpput(\%info,$env{'form.otherserver'});
                    215:                                         my $url = $protocol.'://'.$switch_to.'/adm/login?'.
                    216:                                                                  'domain='.$env{'user.domain'}.
                    217:                                                                  '&amp;username='.$env{'user.name'}.
                    218:                                                                  '&amp;token='.$token;
                    219:                                         return &do_redirect($r,$url,0);
                    220:                                     }
                    221:                                 }
                    222:                             }
                    223:                         }
                    224:                     }
                    225:                 }
                    226:             }
1.28      raeburn   227:         }
                    228:         unless ($canhost) { return FORBIDDEN; }
1.26      raeburn   229:     }
                    230: 
1.1       albertel  231:     #remove session env, and log event
1.35.2.2  raeburn   232:     if (unlink($handle)) {
                    233:         if ($env{'user.linkedenv'} ne '') {
                    234:             my $lonidsdir=$r->dir_config('lonIDsDir');
                    235:             if (($env{'user.linkedenv'} =~ /^[a-f0-9]+_linked$/) &&
                    236:                 (-l "$lonidsdir/$env{'user.linkedenv'}.id") &&
                    237:                 (readlink("$lonidsdir/$env{'user.linkedenv'}.id") eq $handle)) {
                    238:                 unlink("$lonidsdir/$env{'user.linkedenv'}.id");
                    239:             }
                    240:         }
                    241:     }
1.35.2.1  raeburn   242:     my %temp=('switchserver' => $now.':'.$env{'form.otherserver'},
1.1       albertel  243: 	      $env{'form.role'});
                    244:     &Apache::lonnet::put('email_status',\%temp);
1.34      raeburn   245:     my $logmsg = "Switch Server to $env{'form.otherserver'}";
                    246:     if ($env{'form.role'}) {
                    247:         $logmsg .= " with role: $env{'form.role'}";
                    248:     } else {
                    249:         $logmsg .= " (no role)";
                    250:     }
1.35.2.6  raeburn   251:     my $ip = &Apache::lonnet::get_requestor_ip($r,REMOTE_NOLOOKUP);
1.35.2.5  raeburn   252:     $logmsg .= ' '.$ip;
1.1       albertel  253:     &Apache::lonnet::log($env{'user.domain'},$env{'user.name'},
1.34      raeburn   254: 			 $env{'user.home'},$logmsg);
1.1       albertel  255: 
                    256:     &Apache::loncommon::content_type($r,'text/html');
1.12      albertel  257: 
1.35.2.2  raeburn   258:     #expire the cookies
                    259:     my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
                    260:     foreach my $name (keys(%cookies)) {
                    261:         next unless ($name =~ /^lon(|S|Link|Pub)ID$/);
                    262:         my $c = new CGI::Cookie(-name    => $name,
                    263:                                 -value   => '',
                    264:                                 -expires => '-10y',);
                    265:         $r->headers_out->add('Set-cookie' => $c);
                    266:     }
1.20      albertel  267:     if ($r->header_only) {
                    268: 	$r->send_http_header;
                    269: 	return OK;
                    270:     }
1.1       albertel  271: # -------------------------------------------------------- Menu script and info
1.35.2.3  raeburn   272: 
1.1       albertel  273: # ---------------------------------------------------------------- Get handover
                    274: 
1.35.2.4  raeburn   275:     my ($is_balancer,$setcookie,$newcookieid,$otherbalcookie);
1.35.2.1  raeburn   276:     my $only_body = 0;
1.35.2.3  raeburn   277:     ($is_balancer,undef,$setcookie) =
                    278:         &Apache::lonnet::check_loadbalancing($env{'user.name'},$env{'user.domain'},'switchserver');
1.35.2.1  raeburn   279:     if ($is_balancer && $setcookie && $env{'form.otherserver'}) {
1.35.2.3  raeburn   280: 
1.35.2.1  raeburn   281:         # Set a balancer cookie unless browser already sent LON-CAPA load balancer
                    282:         # cookie which points at the target server
                    283:         my ($found_server,$balancer_cookie) = &Apache::lonnet::check_for_balancer_cookie($r,1);
                    284: 
                    285:         if (($found_server eq $env{'form.otherserver'}) &&
                    286:             ($balancer_cookie =~ /^\Q$env{'user.domain'}\E_\Q$env{'user.name'}\E_/)) {
                    287:             $only_body = 1;
                    288:         } else {
                    289:             $newcookieid = &balancer_cookieid($r,$env{'form.otherserver'},
                    290:                                               $env{'user.name'},$env{'user.domain'});
                    291:         }
                    292:     }
1.35.2.3  raeburn   293:     if ((!$is_balancer) && ($env{'request.balancercookie'})) {
                    294:         $otherbalcookie = $env{'request.balancercookie'};
                    295:     }
1.35.2.1  raeburn   296: 
1.35.2.5  raeburn   297:     my %info=('ip'       => $ip,
1.3       albertel  298: 	      'domain'   => $env{'user.domain'},
                    299: 	      'username' => $env{'user.name'},
                    300: 	      'role'     => $env{'form.role'},
1.32      raeburn   301: 	      'server'   => $r->dir_config('lonHostID'),
                    302: 	      'balancer' => $is_balancer);
1.35.2.1  raeburn   303:     if ($newcookieid) {
                    304:         $info{'balcookie'} = $newcookieid;
1.35.2.3  raeburn   305:     } elsif ($otherbalcookie) {
                    306:         $info{'otherbalcookie'} = $otherbalcookie;
1.35.2.1  raeburn   307:     }
1.22      raeburn   308:     if ($env{'form.origurl'}) {
                    309:         $info{'origurl'} = $env{'form.origurl'};
                    310:     }
                    311:     if ($env{'form.symb'}) {
                    312:         $info{'symb'} = $env{'form.symb'};
                    313:     }
1.35.2.6  raeburn   314:     my $ssologoutscript = ''; 
1.8       albertel  315:     if ($env{'request.sso.login'}) {
                    316: 	$info{'sso.login'} = $env{'request.sso.login'};
1.35.2.6  raeburn   317:         if (defined($r->dir_config("lonSSOUserLogoutScriptFile_$info{domain}"))) {
                    318:             if (open(my $fh,'<',$r->dir_config("lonSSOUserLogoutScriptFile_$info{domain}"))) {
                    319:                 $ssologoutscript .= join('',<$fh>);
                    320:                 close($fh);
                    321:             }
                    322:         }
                    323:         if (defined($r->dir_config('lonSSOUserLogoutScriptFile'))) {
                    324:             if (open(my $fh,'<',$r->dir_config('lonSSOUserLogoutScriptFile'))) {
                    325:                 $ssologoutscript .= join('',<$fh>);
                    326:                 close($fh);
                    327:             }
                    328:         }
1.8       albertel  329:     }
1.11      raeburn   330:     if ($env{'request.sso.reloginserver'}) {
                    331:         $info{'sso.reloginserver'} = $env{'request.sso.reloginserver'};
                    332:     }
1.3       albertel  333:     my $token = &Apache::lonnet::tmpput(\%info,$env{'form.otherserver'});
1.33      raeburn   334:     my $url =$protocol.'://'.$switch_to.'/adm/login?'.
1.14      albertel  335: 	'domain='.$env{'user.domain'}.
1.21      albertel  336: 	'&amp;username='.$env{'user.name'}.
                    337: 	'&amp;token='.$token;
1.1       albertel  338: # --------------------------------------------------------------- Screen Output
1.35.2.6  raeburn   339:     return &do_redirect($r, $url, $only_body, $ssologoutscript);
1.1       albertel  340: }
                    341: 
                    342: 1;
                    343: __END__
                    344: 
                    345: 
                    346: 
                    347: 
                    348: 
                    349: 
                    350: 
                    351: 

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