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

1.1       www         1: # The LearningOnline Network
                      2: # Logout Handler
1.3       www         3: #
1.50    ! raeburn     4: # $Id: lonlogout.pm,v 1.49 2015/03/12 00:50:10 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.2       www        48: use Apache::lonmenu;
1.1       www        49: use CGI::Cookie();
1.11      www        50: use Apache::lonlocal;
1.1       www        51: 
                     52: sub handler {
                     53:     my $r = shift;
                     54: 
1.17      albertel   55:     #Check for cookie
1.1       www        56:     my $requrl=$r->uri;
1.29      albertel   57:     my $handle = &Apache::lonnet::check_for_valid_session($r);
1.17      albertel   58:     #check if cookie still valid
1.29      albertel   59:     if ($handle eq '') {
1.17      albertel   60: 	$r->log_reason("Cookie $handle not valid", $r->filename); 
                     61: 	return FORBIDDEN;
                     62:     }
                     63: 
                     64:     #we've got a valid user
1.31      www        65:     #any locks in place?
                     66:     my $locknum=&Apache::lonnet::get_locks();
                     67:     if ($locknum) { return 409; }
                     68:     #nope, go ahead
1.17      albertel   69:     my @profile;
1.29      albertel   70:     my $lonidsdir=$r->dir_config('lonIDsDir');
1.21      albertel   71:     &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle);
1.17      albertel   72:     unlink("$lonidsdir/$handle.id");
1.50    ! raeburn    73:     if ($env{'user.linkedenv'} ne '') {
        !            74:         my $lonhost = $r->dir_config('lonHostID');
        !            75:         if ((-l $env{'user.linkedenv'}) && 
        !            76:             (readlink($env{'user.linkedenv'}) eq "$lonidsdir/$handle.id")) {
        !            77:             unlink($env{'user.linkedenv'});
        !            78:         }
        !            79:     }
1.46      raeburn    80:     if (!$Apache::lonlocal::lh) {
                     81:         &Apache::lonlocal::get_language_handle($r);
                     82:     }
1.17      albertel   83:     my %temp=('logout' => time);
                     84:     &Apache::lonnet::put('email_status',\%temp);
1.21      albertel   85:     &Apache::lonnet::log($env{'user.domain'},
                     86: 			 $env{'user.name'},
                     87: 			 $env{'user.home'},
1.17      albertel   88: 			 "Logout $ENV{'REMOTE_ADDR'}");
1.25      albertel   89: 
1.17      albertel   90:     &Apache::loncommon::content_type($r,'text/html');
1.25      albertel   91: 
                     92:     #expire the cookie
1.50    ! raeburn    93:     my $name = 'lonID';
        !            94:     if (($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')) {
        !            95:         $name = 'lonPubID';
        !            96:     }
        !            97:     my $c = new CGI::Cookie(-name    => $name,
1.25      albertel   98: 			    -value   => '',
                     99: 			    -expires => '-10y',);
1.50    ! raeburn   100:     $r->headers_out->add('Set-cookie' => $c);
        !           101:     if (($name eq 'lonID') && ($env{'user.linkeenv'})) {
        !           102:         my $other = new CGI::Cookie(-name    => 'lonLinkID',
        !           103:                                     -value   => '',
        !           104:                                     -expires => '-10y',);
        !           105:         $r->headers_out->add('Set-cookie' => $other);
        !           106:     }
1.17      albertel  107:     $r->send_http_header;
                    108:     return OK if $r->header_only;
1.2       www       109: # -------------------------------------------------------- Menu script and info
                    110: 
1.6       www       111: # ---------------------------------------------------------------- Get handover
                    112:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['handover']);
                    113:     my $switch='';
1.18      albertel  114:     my $start_page='';
1.7       www       115:     my $relogmessage='';
1.14      albertel  116:     if ($env{'form.handover'}) {
1.17      albertel  117: 	$switch='<meta HTTP-EQUIV="Refresh" CONTENT="0.5; url='.
1.37      bisitz    118: 	    $env{'form.handover'}.'" />';
1.17      albertel  119: 	$start_page=&Apache::loncommon::start_page('Switching Server ...',
                    120: 						   $switch);
                    121:     } else {
1.47      raeburn   122:         my $domain = $env{'user.domain'};
                    123:         my $headextra;
                    124:         if ($env{'request.sso.login'}
                    125:             && defined($r->dir_config("lonSSOUserLogoutHeadFile_$domain"))) {
                    126:             if (open(my $fh,$r->dir_config("lonSSOUserLogoutHeadFile_$domain"))) {
                    127:                 $headextra = join('',<$fh>);
                    128:                 close($fh);
                    129:             }
                    130:         }
                    131:         if ($env{'request.sso.login'}
                    132:             && defined($r->dir_config('lonSSOUserLogoutHeadFile'))) {
                    133:             if (open(my $fh,$r->dir_config('lonSSOUserLogoutHeadFile'))) {
                    134:                 $headextra.= join('',<$fh>);
1.48      raeburn   135:                 close($fh);
1.47      raeburn   136:             }
                    137:         }
                    138: 	$start_page=&Apache::loncommon::start_page('Logged Out',$headextra,
1.41      droeschl  139:                            {'no_nav_bar'     => 1,});
1.26      albertel  140: 	
1.32      bisitz    141:         $relogmessage.='<h1>'.&mt('Goodbye').'</h1>'
                    142:                       .'<p>'.&mt('Thank you for using LON-CAPA.').'</p>';
1.26      albertel  143: 
                    144: 	if (!$env{'request.sso.norelogin'}) {
1.42      raeburn   145: 	    my ($relogin_server,$login_url);
1.26      albertel  146: 	    if ($env{'request.sso.reloginserver'}) {
                    147: 		$relogin_server = $env{'request.sso.reloginserver'};
1.42      raeburn   148: 	    } else {
                    149:                  my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                    150:                  if ($domdefaults{'portal_def'}) {
                    151:                      $login_url = $domdefaults{'portal_def'};
                    152:                  } else {
                    153:                      my $checkloginvia = 1;
1.44      raeburn   154:                      my ($lonhost,$server,$path,$isredirect) = 
1.42      raeburn   155:                          &Apache::lonnet::choose_server($domain,$checkloginvia);
                    156:                      if ($server && $lonhost) {
                    157:                          $login_url = $Apache::lonnet::protocol{$lonhost}.
                    158:                                       '://'.$server.$path;
1.44      raeburn   159:                          if (($path eq '') && (!$isredirect)) {
                    160:                              my $serverhomeID =
1.45      raeburn   161:                                  &Apache::lonnet::get_server_homeID($server);
1.44      raeburn   162:                              my $serverhomedom =
                    163:                                  &Apache::lonnet::host_domain($serverhomeID);
                    164:                              if ($serverhomedom ne $domain) {
                    165:                                  $path = '/adm/login';
                    166:                                  $login_url .= $path;
                    167:                              }
                    168:                          }
1.43      raeburn   169:                          if ($path eq '/adm/login' && $domain ne '') {
                    170:                              $login_url .= '?domain='.$domain;
                    171:                          }
1.42      raeburn   172:                      }
                    173:                  }
                    174:             }
                    175:             if ($login_url eq '') {
                    176: 	        $login_url = $relogin_server.'/adm/'.
                    177: 		    ($env{'request.sso.login'} ? 'roles': 'login?domain='.$domain);
                    178:             }
1.32      bisitz    179:             $relogmessage.='<p>'.&mt('You have been successfully logged out.').' '
                    180:                           .&mt('You can [_1]close this window[_2] now.'
1.34      bisitz    181:                               ,'','') # ,'<a href="javascript:self.close();">','</a>')
                    182:                           .'</p>';
1.33      jms       183: =pod
                    184: 
                    185: =head1 NOTES:
                    186: 
1.34      bisitz    187: '<a href="javascript:self.close();">','</a>'
1.33      jms       188: 
1.49      raeburn   189: 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       190: 
                    191: =cut
1.34      bisitz    192:             $relogmessage.='<p>'.&mt('[_1]Log in again[_2]'
1.42      raeburn   193:                               ,'<a href="'.$login_url.'">','</a>')
1.32      bisitz    194:                           .'</p>';
1.26      albertel  195:         }
1.20      albertel  196:         if ($env{'request.sso.login'}
1.26      albertel  197: 	    && defined($r->dir_config("lonSSOUserLogoutMessageFile_$domain"))) {
1.47      raeburn   198: 	    if (open(my $fh,$r->dir_config("lonSSOUserLogoutMessageFile_$domain"))) {
                    199: 	        $relogmessage.= join('',<$fh>);
                    200:                 close($fh);
                    201:             }
1.26      albertel  202: 	}
                    203: 	if ($env{'request.sso.login'}
1.27      albertel  204: 	    && defined($r->dir_config('lonSSOUserLogoutMessageFile'))) {
1.47      raeburn   205: 	    if (open(my $fh,$r->dir_config('lonSSOUserLogoutMessageFile'))) {
                    206: 	        $relogmessage.= join('',<$fh>);
                    207:                 close($fh);
                    208:             }
1.20      albertel  209: 	}
1.17      albertel  210:     }
1.18      albertel  211:     my $end_page=&Apache::loncommon::end_page();
1.2       www       212: # --------------------------------------------------------------- Screen Output
1.17      albertel  213:     $r->print(<<ENDDOCUMENT);
1.16      albertel  214: $start_page
1.7       www       215: $relogmessage
1.16      albertel  216: $end_page
1.1       www       217: ENDDOCUMENT
1.28      albertel  218:     $r->register_cleanup(\&flush_course_logs);
                    219:     return OK; 
                    220: }
                    221: 
                    222: sub flush_course_logs {
1.17      albertel  223:     &Apache::lonnet::flushcourselogs();
1.28      albertel  224:     return OK;
1.1       www       225: }
                    226: 
                    227: 1;
                    228: __END__
                    229: 
                    230: 
                    231: 
                    232: 
                    233: 
                    234: 
                    235: 

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