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

1.1       www         1: # The LearningOnline Network
                      2: # Logout Handler
1.3       www         3: #
1.45.2.3! raeburn     4: # $Id: lonlogout.pm,v 1.45.2.2 2013/02/08 17:11:59 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.45.2.2  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.45.2.1  raeburn    95:     my $windowinfo=&Apache::lonmenu::close();
1.6       www        96: # ---------------------------------------------------------------- Get handover
                     97:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['handover']);
                     98:     my $switch='';
1.18      albertel   99:     my $start_page='';
1.7       www       100:     my $relogmessage='';
1.14      albertel  101:     if ($env{'form.handover'}) {
1.17      albertel  102: 	$switch='<meta HTTP-EQUIV="Refresh" CONTENT="0.5; url='.
1.37      bisitz    103: 	    $env{'form.handover'}.'" />';
1.17      albertel  104: 	$start_page=&Apache::loncommon::start_page('Switching Server ...',
                    105: 						   $switch);
                    106:     } else {
1.45.2.3! raeburn   107:         my $domain = $env{'user.domain'};
        !           108:         my $headextra;
        !           109:         if ($env{'request.sso.login'}
        !           110:             && defined($r->dir_config("lonSSOUserLogoutHeadFile_$domain"))) {
        !           111:             if (open(my $fh,$r->dir_config("lonSSOUserLogoutHeadFile_$domain"))) {
        !           112:                 $headextra = join('',<$fh>);
        !           113:                 close($fh);
        !           114:             }
        !           115:         }
        !           116:         if ($env{'request.sso.login'}
        !           117:             && defined($r->dir_config('lonSSOUserLogoutHeadFile'))) {
        !           118:             if (open(my $fh,$r->dir_config('lonSSOUserLogoutHeadFile'))) {
        !           119:                 $headextra.= join('',<$fh>);
        !           120:                 close($fh);
        !           121:             }
        !           122:         }
        !           123: 	$start_page=&Apache::loncommon::start_page('Logged Out',$headextra,
1.45.2.1  raeburn   124:                            {'no_inline_link' => 1,
                    125:                             'no_nav_bar'     => 1,});
1.26      albertel  126: 	
1.32      bisitz    127:         $relogmessage.='<h1>'.&mt('Goodbye').'</h1>'
                    128:                       .'<p>'.&mt('Thank you for using LON-CAPA.').'</p>';
1.26      albertel  129: 
                    130: 	if (!$env{'request.sso.norelogin'}) {
1.42      raeburn   131: 	    my ($relogin_server,$login_url);
1.26      albertel  132: 	    if ($env{'request.sso.reloginserver'}) {
                    133: 		$relogin_server = $env{'request.sso.reloginserver'};
1.42      raeburn   134: 	    } else {
                    135:                  my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                    136:                  if ($domdefaults{'portal_def'}) {
                    137:                      $login_url = $domdefaults{'portal_def'};
                    138:                  } else {
                    139:                      my $checkloginvia = 1;
1.44      raeburn   140:                      my ($lonhost,$server,$path,$isredirect) = 
1.42      raeburn   141:                          &Apache::lonnet::choose_server($domain,$checkloginvia);
                    142:                      if ($server && $lonhost) {
                    143:                          $login_url = $Apache::lonnet::protocol{$lonhost}.
                    144:                                       '://'.$server.$path;
1.44      raeburn   145:                          if (($path eq '') && (!$isredirect)) {
                    146:                              my $serverhomeID =
1.45      raeburn   147:                                  &Apache::lonnet::get_server_homeID($server);
1.44      raeburn   148:                              my $serverhomedom =
                    149:                                  &Apache::lonnet::host_domain($serverhomeID);
                    150:                              if ($serverhomedom ne $domain) {
                    151:                                  $path = '/adm/login';
                    152:                                  $login_url .= $path;
                    153:                              }
                    154:                          }
1.43      raeburn   155:                          if ($path eq '/adm/login' && $domain ne '') {
                    156:                              $login_url .= '?domain='.$domain;
                    157:                          }
1.42      raeburn   158:                      }
                    159:                  }
                    160:             }
                    161:             if ($login_url eq '') {
                    162: 	        $login_url = $relogin_server.'/adm/'.
                    163: 		    ($env{'request.sso.login'} ? 'roles': 'login?domain='.$domain);
                    164:             }
1.32      bisitz    165:             $relogmessage.='<p>'.&mt('You have been successfully logged out.').' '
                    166:                           .&mt('You can [_1]close this window[_2] now.'
1.34      bisitz    167:                               ,'','') # ,'<a href="javascript:self.close();">','</a>')
                    168:                           .'</p>';
1.33      jms       169: =pod
                    170: 
                    171: =head1 NOTES:
                    172: 
1.34      bisitz    173: '<a href="javascript:self.close();">','</a>'
1.33      jms       174: 
1.45.2.3! raeburn   175: 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       176: 
                    177: =cut
1.34      bisitz    178:             $relogmessage.='<p>'.&mt('[_1]Log in again[_2]'
1.42      raeburn   179:                               ,'<a href="'.$login_url.'">','</a>')
1.32      bisitz    180:                           .'</p>';
1.26      albertel  181:         }
1.20      albertel  182:         if ($env{'request.sso.login'}
1.26      albertel  183: 	    && defined($r->dir_config("lonSSOUserLogoutMessageFile_$domain"))) {
1.45.2.3! raeburn   184: 	    if (open(my $fh,$r->dir_config("lonSSOUserLogoutMessageFile_$domain"))) {
        !           185: 	        $relogmessage.= join('',<$fh>);
        !           186:                 close($fh);
        !           187:             }
1.26      albertel  188: 	}
                    189: 	if ($env{'request.sso.login'}
1.27      albertel  190: 	    && defined($r->dir_config('lonSSOUserLogoutMessageFile'))) {
1.45.2.3! raeburn   191: 	    if (open(my $fh,$r->dir_config('lonSSOUserLogoutMessageFile'))) {
        !           192: 	        $relogmessage.= join('',<$fh>);
        !           193:                 close($fh);
        !           194:             }
1.20      albertel  195: 	}
1.17      albertel  196:     }
1.18      albertel  197:     my $end_page=&Apache::loncommon::end_page();
1.2       www       198: # --------------------------------------------------------------- Screen Output
1.17      albertel  199:     $r->print(<<ENDDOCUMENT);
1.16      albertel  200: $start_page
1.45.2.1  raeburn   201: $windowinfo
1.7       www       202: $relogmessage
1.16      albertel  203: $end_page
1.1       www       204: ENDDOCUMENT
1.28      albertel  205:     $r->register_cleanup(\&flush_course_logs);
                    206:     return OK; 
                    207: }
                    208: 
                    209: sub flush_course_logs {
1.17      albertel  210:     &Apache::lonnet::flushcourselogs();
1.28      albertel  211:     return OK;
1.1       www       212: }
                    213: 
                    214: 1;
                    215: __END__
                    216: 
                    217: 
                    218: 
                    219: 
                    220: 
                    221: 
                    222: 

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