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

1.1       www         1: # The LearningOnline Network
                      2: # Logout Handler
1.3       www         3: #
1.49    ! raeburn     4: # $Id: lonlogout.pm,v 1.48 2015/03/12 00:47:49 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.46      raeburn    73:     if (!$Apache::lonlocal::lh) {
                     74:         &Apache::lonlocal::get_language_handle($r);
                     75:     }
1.17      albertel   76:     my %temp=('logout' => time);
                     77:     &Apache::lonnet::put('email_status',\%temp);
1.21      albertel   78:     &Apache::lonnet::log($env{'user.domain'},
                     79: 			 $env{'user.name'},
                     80: 			 $env{'user.home'},
1.17      albertel   81: 			 "Logout $ENV{'REMOTE_ADDR'}");
1.25      albertel   82: 
1.17      albertel   83:     &Apache::loncommon::content_type($r,'text/html');
1.25      albertel   84: 
                     85:     #expire the cookie
                     86:     my $c = new CGI::Cookie(-name    => 'lonID',
                     87: 			    -value   => '',
                     88: 			    -expires => '-10y',);
                     89:     $r->header_out('Set-cookie' => $c);
                     90: 
1.17      albertel   91:     $r->send_http_header;
                     92:     return OK if $r->header_only;
1.2       www        93: # -------------------------------------------------------- Menu script and info
                     94: 
1.6       www        95: # ---------------------------------------------------------------- Get handover
                     96:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['handover']);
                     97:     my $switch='';
1.18      albertel   98:     my $start_page='';
1.7       www        99:     my $relogmessage='';
1.14      albertel  100:     if ($env{'form.handover'}) {
1.17      albertel  101: 	$switch='<meta HTTP-EQUIV="Refresh" CONTENT="0.5; url='.
1.37      bisitz    102: 	    $env{'form.handover'}.'" />';
1.17      albertel  103: 	$start_page=&Apache::loncommon::start_page('Switching Server ...',
                    104: 						   $switch);
                    105:     } else {
1.47      raeburn   106:         my $domain = $env{'user.domain'};
                    107:         my $headextra;
                    108:         if ($env{'request.sso.login'}
                    109:             && defined($r->dir_config("lonSSOUserLogoutHeadFile_$domain"))) {
                    110:             if (open(my $fh,$r->dir_config("lonSSOUserLogoutHeadFile_$domain"))) {
                    111:                 $headextra = join('',<$fh>);
                    112:                 close($fh);
                    113:             }
                    114:         }
                    115:         if ($env{'request.sso.login'}
                    116:             && defined($r->dir_config('lonSSOUserLogoutHeadFile'))) {
                    117:             if (open(my $fh,$r->dir_config('lonSSOUserLogoutHeadFile'))) {
                    118:                 $headextra.= join('',<$fh>);
1.48      raeburn   119:                 close($fh);
1.47      raeburn   120:             }
                    121:         }
                    122: 	$start_page=&Apache::loncommon::start_page('Logged Out',$headextra,
1.41      droeschl  123:                            {'no_nav_bar'     => 1,});
1.26      albertel  124: 	
1.32      bisitz    125:         $relogmessage.='<h1>'.&mt('Goodbye').'</h1>'
                    126:                       .'<p>'.&mt('Thank you for using LON-CAPA.').'</p>';
1.26      albertel  127: 
                    128: 	if (!$env{'request.sso.norelogin'}) {
1.42      raeburn   129: 	    my ($relogin_server,$login_url);
1.26      albertel  130: 	    if ($env{'request.sso.reloginserver'}) {
                    131: 		$relogin_server = $env{'request.sso.reloginserver'};
1.42      raeburn   132: 	    } else {
                    133:                  my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                    134:                  if ($domdefaults{'portal_def'}) {
                    135:                      $login_url = $domdefaults{'portal_def'};
                    136:                  } else {
                    137:                      my $checkloginvia = 1;
1.44      raeburn   138:                      my ($lonhost,$server,$path,$isredirect) = 
1.42      raeburn   139:                          &Apache::lonnet::choose_server($domain,$checkloginvia);
                    140:                      if ($server && $lonhost) {
                    141:                          $login_url = $Apache::lonnet::protocol{$lonhost}.
                    142:                                       '://'.$server.$path;
1.44      raeburn   143:                          if (($path eq '') && (!$isredirect)) {
                    144:                              my $serverhomeID =
1.45      raeburn   145:                                  &Apache::lonnet::get_server_homeID($server);
1.44      raeburn   146:                              my $serverhomedom =
                    147:                                  &Apache::lonnet::host_domain($serverhomeID);
                    148:                              if ($serverhomedom ne $domain) {
                    149:                                  $path = '/adm/login';
                    150:                                  $login_url .= $path;
                    151:                              }
                    152:                          }
1.43      raeburn   153:                          if ($path eq '/adm/login' && $domain ne '') {
                    154:                              $login_url .= '?domain='.$domain;
                    155:                          }
1.42      raeburn   156:                      }
                    157:                  }
                    158:             }
                    159:             if ($login_url eq '') {
                    160: 	        $login_url = $relogin_server.'/adm/'.
                    161: 		    ($env{'request.sso.login'} ? 'roles': 'login?domain='.$domain);
                    162:             }
1.32      bisitz    163:             $relogmessage.='<p>'.&mt('You have been successfully logged out.').' '
                    164:                           .&mt('You can [_1]close this window[_2] now.'
1.34      bisitz    165:                               ,'','') # ,'<a href="javascript:self.close();">','</a>')
                    166:                           .'</p>';
1.33      jms       167: =pod
                    168: 
                    169: =head1 NOTES:
                    170: 
1.34      bisitz    171: '<a href="javascript:self.close();">','</a>'
1.33      jms       172: 
1.49    ! raeburn   173: 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       174: 
                    175: =cut
1.34      bisitz    176:             $relogmessage.='<p>'.&mt('[_1]Log in again[_2]'
1.42      raeburn   177:                               ,'<a href="'.$login_url.'">','</a>')
1.32      bisitz    178:                           .'</p>';
1.26      albertel  179:         }
1.20      albertel  180:         if ($env{'request.sso.login'}
1.26      albertel  181: 	    && defined($r->dir_config("lonSSOUserLogoutMessageFile_$domain"))) {
1.47      raeburn   182: 	    if (open(my $fh,$r->dir_config("lonSSOUserLogoutMessageFile_$domain"))) {
                    183: 	        $relogmessage.= join('',<$fh>);
                    184:                 close($fh);
                    185:             }
1.26      albertel  186: 	}
                    187: 	if ($env{'request.sso.login'}
1.27      albertel  188: 	    && defined($r->dir_config('lonSSOUserLogoutMessageFile'))) {
1.47      raeburn   189: 	    if (open(my $fh,$r->dir_config('lonSSOUserLogoutMessageFile'))) {
                    190: 	        $relogmessage.= join('',<$fh>);
                    191:                 close($fh);
                    192:             }
1.20      albertel  193: 	}
1.17      albertel  194:     }
1.18      albertel  195:     my $end_page=&Apache::loncommon::end_page();
1.2       www       196: # --------------------------------------------------------------- Screen Output
1.17      albertel  197:     $r->print(<<ENDDOCUMENT);
1.16      albertel  198: $start_page
1.7       www       199: $relogmessage
1.16      albertel  200: $end_page
1.1       www       201: ENDDOCUMENT
1.28      albertel  202:     $r->register_cleanup(\&flush_course_logs);
                    203:     return OK; 
                    204: }
                    205: 
                    206: sub flush_course_logs {
1.17      albertel  207:     &Apache::lonnet::flushcourselogs();
1.28      albertel  208:     return OK;
1.1       www       209: }
                    210: 
                    211: 1;
                    212: __END__
                    213: 
                    214: 
                    215: 
                    216: 
                    217: 
                    218: 
                    219: 

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