Annotation of loncom/auth/lonlogout.pm, revision 1.45.2.7

1.1       www         1: # The LearningOnline Network
                      2: # Logout Handler
1.3       www         3: #
1.45.2.7! raeburn     4: # $Id: lonlogout.pm,v 1.45.2.6 2019/08/01 14:30:27 raeburn Exp $
1.3       www         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: #
1.1       www        28: 
1.36      jms        29: =head1 NAME
                     30: 
                     31: Apache::lonlogout
                     32: 
                     33: =head1 SYNOPSIS
                     34: 
                     35: 
                     36: This is part of the LearningOnline Network with CAPA project
                     37: described at http://www.lon-capa.org.
                     38: 
                     39: 
                     40: =cut
                     41: 
1.1       www        42: package Apache::lonlogout;
                     43: 
                     44: use strict;
                     45: use Apache::Constants qw(:common);
                     46: use Apache::File;
                     47: use Apache::lonnet;
1.45.2.4  raeburn    48: use Apache::loncommon;
1.2       www        49: use Apache::lonmenu;
1.1       www        50: use CGI::Cookie();
1.11      www        51: use Apache::lonlocal;
1.45.2.4  raeburn    52: use LONCAPA qw(:DEFAULT :match);
1.1       www        53: 
                     54: sub handler {
                     55:     my $r = shift;
                     56: 
1.17      albertel   57:     #Check for cookie
1.1       www        58:     my $requrl=$r->uri;
1.29      albertel   59:     my $handle = &Apache::lonnet::check_for_valid_session($r);
1.17      albertel   60:     #check if cookie still valid
1.29      albertel   61:     if ($handle eq '') {
1.17      albertel   62: 	$r->log_reason("Cookie $handle not valid", $r->filename); 
                     63: 	return FORBIDDEN;
                     64:     }
                     65: 
                     66:     #we've got a valid user
1.31      www        67:     #any locks in place?
                     68:     my $locknum=&Apache::lonnet::get_locks();
                     69:     if ($locknum) { return 409; }
                     70:     #nope, go ahead
1.17      albertel   71:     my @profile;
1.29      albertel   72:     my $lonidsdir=$r->dir_config('lonIDsDir');
1.21      albertel   73:     &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle);
1.45.2.7! raeburn    74:     if (unlink("$lonidsdir/$handle.id")) {
        !            75:         if (($env{'user.linkedenv'} =~ /^[a-f0-9]+_linked$/) &&
        !            76:             (-l "$lonidsdir/$env{'user.linkedenv'}.id") &&
        !            77:             (readlink("$lonidsdir/$env{'user.linkedenv'}.id") eq "$lonidsdir/$handle.id")) {
        !            78:             unlink("$lonidsdir/$env{'user.linkedenv'}.id");
        !            79:         }
        !            80:     }
1.45.2.2  raeburn    81:     if (!$Apache::lonlocal::lh) {
                     82:         &Apache::lonlocal::get_language_handle($r);
                     83:     }
1.17      albertel   84:     my %temp=('logout' => time);
                     85:     &Apache::lonnet::put('email_status',\%temp);
1.21      albertel   86:     &Apache::lonnet::log($env{'user.domain'},
                     87: 			 $env{'user.name'},
                     88: 			 $env{'user.home'},
1.17      albertel   89: 			 "Logout $ENV{'REMOTE_ADDR'}");
1.25      albertel   90: 
1.17      albertel   91:     &Apache::loncommon::content_type($r,'text/html');
1.25      albertel   92: 
1.45.2.7! raeburn    93:     #expire the cookies
        !            94:     my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
        !            95:     foreach my $name (keys(%cookies)) {
        !            96:         next unless ($name =~ /^lon(|S|Link|Pub)ID$/);
        !            97:         my $c = new CGI::Cookie(-name    => $name,
        !            98:                                 -value   => '',
        !            99:                                 -expires => '-10y',);
        !           100:         $r->headers_out->add('Set-cookie' => $c);
        !           101:     }
1.17      albertel  102:     $r->send_http_header;
                    103:     return OK if $r->header_only;
1.2       www       104: # -------------------------------------------------------- Menu script and info
                    105: 
1.45.2.1  raeburn   106:     my $windowinfo=&Apache::lonmenu::close();
1.6       www       107: # ---------------------------------------------------------------- Get handover
                    108:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['handover']);
                    109:     my $switch='';
1.18      albertel  110:     my $start_page='';
1.7       www       111:     my $relogmessage='';
1.14      albertel  112:     if ($env{'form.handover'}) {
1.17      albertel  113: 	$switch='<meta HTTP-EQUIV="Refresh" CONTENT="0.5; url='.
1.37      bisitz    114: 	    $env{'form.handover'}.'" />';
1.17      albertel  115: 	$start_page=&Apache::loncommon::start_page('Switching Server ...',
                    116: 						   $switch);
                    117:     } else {
1.45.2.3  raeburn   118:         my $domain = $env{'user.domain'};
1.45.2.4  raeburn   119:         my ($headextra,$ssofile);
                    120:         if ($env{'request.sso.login'}) {
                    121:             my $londocroot = $r->dir_config('lonDocRoot');
                    122:             if ($domain =~ /^$match_domain$/) {
                    123:                 if (defined($r->dir_config("lonSSOUserLogoutHeadFile_$domain"))) {
                    124:                     $ssofile = '/'.&Apache::loncommon::clean_path($r->dir_config("lonSSOUserLogoutHeadFile_$domain"));
                    125:                     if ($ssofile eq $r->dir_config("lonSSOUserLogoutHeadFile_$domain")) {
                    126:                         if ($ssofile =~ /^\Q$londocroot\E/) {
                    127:                             if (open(my $fh,'<',$ssofile)) {
                    128:                                 $headextra = join('',<$fh>);
                    129:                                 close($fh);
                    130:                             }
                    131:                         }
                    132:                     }
                    133:                 }
                    134:             }
                    135:             if (defined($r->dir_config('lonSSOUserLogoutHeadFile'))) {
                    136:                 $ssofile = '/'.&Apache::loncommon::clean_path($r->dir_config('lonSSOUserLogoutHeadFile'));
                    137:                 if ($ssofile eq $r->dir_config('lonSSOUserLogoutHeadFile')) {
                    138:                     if ($ssofile =~ /^\Q$londocroot\E/) {
                    139:                         if (open(my $fh,'<',$ssofile)) {
                    140:                             $headextra.= join('',<$fh>);
                    141:                             close($fh);
                    142:                         }
                    143:                     }
                    144:                 }
1.45.2.3  raeburn   145:             }
                    146:         }
                    147: 	$start_page=&Apache::loncommon::start_page('Logged Out',$headextra,
1.45.2.1  raeburn   148:                            {'no_inline_link' => 1,
                    149:                             'no_nav_bar'     => 1,});
1.26      albertel  150: 	
1.32      bisitz    151:         $relogmessage.='<h1>'.&mt('Goodbye').'</h1>'
                    152:                       .'<p>'.&mt('Thank you for using LON-CAPA.').'</p>';
1.26      albertel  153: 
                    154: 	if (!$env{'request.sso.norelogin'}) {
1.42      raeburn   155: 	    my ($relogin_server,$login_url);
1.26      albertel  156: 	    if ($env{'request.sso.reloginserver'}) {
                    157: 		$relogin_server = $env{'request.sso.reloginserver'};
1.42      raeburn   158: 	    } else {
                    159:                  my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                    160:                  if ($domdefaults{'portal_def'}) {
                    161:                      $login_url = $domdefaults{'portal_def'};
                    162:                  } else {
                    163:                      my $checkloginvia = 1;
1.44      raeburn   164:                      my ($lonhost,$server,$path,$isredirect) = 
1.42      raeburn   165:                          &Apache::lonnet::choose_server($domain,$checkloginvia);
                    166:                      if ($server && $lonhost) {
                    167:                          $login_url = $Apache::lonnet::protocol{$lonhost}.
                    168:                                       '://'.$server.$path;
1.44      raeburn   169:                          if (($path eq '') && (!$isredirect)) {
                    170:                              my $serverhomeID =
1.45      raeburn   171:                                  &Apache::lonnet::get_server_homeID($server);
1.44      raeburn   172:                              my $serverhomedom =
                    173:                                  &Apache::lonnet::host_domain($serverhomeID);
                    174:                              if ($serverhomedom ne $domain) {
                    175:                                  $path = '/adm/login';
                    176:                                  $login_url .= $path;
                    177:                              }
                    178:                          }
1.43      raeburn   179:                          if ($path eq '/adm/login' && $domain ne '') {
                    180:                              $login_url .= '?domain='.$domain;
                    181:                          }
1.42      raeburn   182:                      }
                    183:                  }
                    184:             }
                    185:             if ($login_url eq '') {
                    186: 	        $login_url = $relogin_server.'/adm/'.
                    187: 		    ($env{'request.sso.login'} ? 'roles': 'login?domain='.$domain);
                    188:             }
1.32      bisitz    189:             $relogmessage.='<p>'.&mt('You have been successfully logged out.').' '
                    190:                           .&mt('You can [_1]close this window[_2] now.'
1.34      bisitz    191:                               ,'','') # ,'<a href="javascript:self.close();">','</a>')
                    192:                           .'</p>';
1.33      jms       193: =pod
                    194: 
                    195: =head1 NOTES:
                    196: 
1.34      bisitz    197: '<a href="javascript:self.close();">','</a>'
1.33      jms       198: 
1.45.2.3  raeburn   199: Due to security reasons in new web browsers a window could only be closed with javascript, if this window has also been opened with javascript. This is not done here which means that in most cases the close link will not work. Unless we find another solution, this link should not be offered. (Stefan Bisitz, 2008-08-01)
1.33      jms       200: 
                    201: =cut
1.34      bisitz    202:             $relogmessage.='<p>'.&mt('[_1]Log in again[_2]'
1.42      raeburn   203:                               ,'<a href="'.$login_url.'">','</a>')
1.32      bisitz    204:                           .'</p>';
1.26      albertel  205:         }
1.20      albertel  206:         if ($env{'request.sso.login'}
1.26      albertel  207: 	    && defined($r->dir_config("lonSSOUserLogoutMessageFile_$domain"))) {
1.45.2.5  raeburn   208: 	    if (open(my $fh,'<',$r->dir_config("lonSSOUserLogoutMessageFile_$domain"))) {
1.45.2.3  raeburn   209: 	        $relogmessage.= join('',<$fh>);
                    210:                 close($fh);
                    211:             }
1.26      albertel  212: 	}
                    213: 	if ($env{'request.sso.login'}
1.27      albertel  214: 	    && defined($r->dir_config('lonSSOUserLogoutMessageFile'))) {
1.45.2.5  raeburn   215: 	    if (open(my $fh,'<',$r->dir_config('lonSSOUserLogoutMessageFile'))) {
1.45.2.3  raeburn   216: 	        $relogmessage.= join('',<$fh>);
                    217:                 close($fh);
                    218:             }
1.20      albertel  219: 	}
1.17      albertel  220:     }
1.18      albertel  221:     my $end_page=&Apache::loncommon::end_page();
1.2       www       222: # --------------------------------------------------------------- Screen Output
1.17      albertel  223:     $r->print(<<ENDDOCUMENT);
1.16      albertel  224: $start_page
1.45.2.1  raeburn   225: $windowinfo
1.7       www       226: $relogmessage
1.16      albertel  227: $end_page
1.1       www       228: ENDDOCUMENT
1.45.2.6  raeburn   229:     if ($env{'request.balancercookie'}) {
                    230:         my ($balancer,$cookie) = split(/:/,$env{'request.balancercookie'});
                    231:         if ((&Apache::lonnet::hostname($balancer)) && ($cookie =~ /^[a-f0-9]{32}$/)) {
                    232:             $cookie = $env{'user.domain'}.'_'.$env{'user.name'}.'_'.$cookie;
                    233:             &Apache::lonnet::delbalcookie($cookie,$balancer);
                    234:         }
                    235:     }
1.28      albertel  236:     $r->register_cleanup(\&flush_course_logs);
                    237:     return OK; 
                    238: }
                    239: 
                    240: sub flush_course_logs {
1.17      albertel  241:     &Apache::lonnet::flushcourselogs();
1.28      albertel  242:     return OK;
1.1       www       243: }
                    244: 
                    245: 1;
                    246: __END__
                    247: 
                    248: 
                    249: 
                    250: 
                    251: 
                    252: 
                    253: 

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