--- loncom/publisher/lonretrieve.pm 2001/04/03 22:03:55 1.4 +++ loncom/publisher/lonretrieve.pm 2003/09/22 15:39:53 1.23 @@ -1,17 +1,46 @@ # The LearningOnline Network with CAPA # Handler to retrieve an old version of a file # +# $Id: lonretrieve.pm,v 1.23 2003/09/22 15:39:53 www Exp $ +# +# Copyright Michigan State University Board of Trustees +# +# This file is part of the LearningOnline Network with CAPA (LON-CAPA). +# +# LON-CAPA is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# LON-CAPA is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with LON-CAPA; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# /home/httpd/html/adm/gpl.txt +# +# http://www.lon-capa.org/ +# +# # (Publication Handler # # (TeX Content Handler # +# YEAR=2000 # 05/29/00,05/30,10/11 Gerd Kortemeyer) # # 11/28,11/29,11/30,12/01,12/02,12/04,12/23 Gerd Kortemeyer +# YEAR=2001 # 03/23 Guy Albertelli # 03/24,03/29 Gerd Kortemeyer) # -# 03/31,04/03 Gerd Kortemeyer +# 03/31,04/03,05/02,05/09,06/23,08/20 Gerd Kortemeyer +# +### package Apache::lonretrieve; @@ -19,7 +48,11 @@ use strict; use Apache::File; use File::Copy; use Apache::Constants qw(:common :http :methods); +use Apache::loncacc; +use Apache::loncommon(); +use Apache::lonlocal; +# ------------------------------------ Interface for selecting previous version sub phaseone { my ($r,$fn,$uname,$udom)=@_; my $docroot=$r->dir_config('lonDocRoot'); @@ -31,20 +64,22 @@ sub phaseone { my $resdir=$resfn; $resdir=~s/\/[^\/]+$/\//; - $fn=~/^\/(.+)\.(\w+)$/; + $fn=~/\/([^\/]+)\.(\w+)$/; my $main=$1; my $suffix=$2; - + + if (-e $resfn) { $r->print('
'. - ''. + ''. ''. - ''. - ''. - ''); + '
SelectVersionBecame this version on ...Metadata
'. + ''. + ''); my $filename; opendir(DIR,$resdir); while ($filename=readdir(DIR)) { - if ($filename=~/^$main\.(\d+)\.$suffix$/) { + if ($filename=~/^\Q$main\E\.(\d+)\.\Q$suffix\E$/) { my $version=$1; my ($rdev,$rino,$rmode,$rnlink, $ruid,$rgid,$rrdev,$rsize, @@ -54,7 +89,15 @@ sub phaseone { $version.'">'); + &mt('Metadata Version').' '.$version.''); + if (&Apache::loncommon::fileembstyle($suffix) eq 'ssi') { + $r->print( + '  '.&mt('Diffs with Version').' '.$version.''); + } + $r->print(''); } } closedir(DIR); @@ -63,49 +106,83 @@ sub phaseone { $ratime,$rmtime,$rctime, $rblksize,$rblocks)=stat($resfn); $r->print(''. - '
'.&mt('Select').''. + &mt('Version').''.&mt('Became this version on ...').''.&mt('Metadata').'
'.$version.''. localtime($rmtime).''. ''. - 'Metadata Version '.$version.'
Current'.localtime($rmtime). + ''.&mt('Current').''.localtime($rmtime). ''. - 'Metadata current version

'. - 'Retrieval of an old version will '. - 'overwrite the file currently in construction space

'. - '

'); + &mt('Metadata current version').''); + if (&Apache::loncommon::fileembstyle($suffix) eq 'ssi') { + $r->print( + '  '.&mt('Diffs with current Version').''); + } + $r->print('

'. + ''. +&mt('Retrieval of an old version will overwrite the file currently in construction space').'

'. + ''); +} else { + $r->print('

'.&mt('No previous versions published.').'

'); +} } +# ---------------------------------- Interface for presenting specified version sub phasetwo { my ($r,$fn,$uname,$udom)=@_; if ($ENV{'form.version'}) { my $version=$ENV{'form.version'}; if ($version eq 'new') { - $r->print('

Retrieving current (most recent) version

'); + $r->print('

'.&mt('Retrieving current (most recent) version').'

'); } else { - $r->print('

Retrieving old version '.$version.'

'); + $r->print('

'.&mt('Retrieving old version').' '.$version.'

'); } my $logfile; my $ctarget='/home/'.$uname.'/public_html'.$fn; + my $vfn=$fn; + if ($version ne 'new') { + $vfn=~s/\.(\w+)$/\.$version\.$1/; + } + my $csource=$r->dir_config('lonDocRoot').'/res/'.$udom.'/'.$uname.$vfn; unless ($logfile=Apache::File->new('>>'.$ctarget.'.log')) { $r->print( - 'No write permission to user directory, FAIL'); + ''.&mt('No write permission to user directory, FAIL').''); } print $logfile "\n\n================= Retrieve ".localtime()." ================\n". -"Version $version\n\n"; - +"Version: $version\nSource: $csource\nTarget: $ctarget\n"; + $r->print('

'.&mt('Copying file').': '); + if (copy($csource,$ctarget)) { + $r->print('ok

'); + print $logfile "Copied sucessfully.\n\n"; + } else { + my $error=$!; + $r->print('fail, '.$error.'

'); + print $logfile "Copy failed: $error\n\n"; + } + $r->print(''.&mt('Back to').' '.$fn.''); } else { $r->print( - 'Please pick a version to retrieve

'); + ''.&mt('Please pick a version to retrieve').'

'); &phaseone($r,$fn,$uname,$udom); } } +# ---------------------------------------------------------------- Main Handler sub handler { my $r=shift; my $fn; + +# Get query string for limited number of parameters + + &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'}, + ['filename']); + if ($ENV{'form.filename'}) { $fn=$ENV{'form.filename'}; - $fn=~s/^http\:\/\/[^\/]+\/\~(\w+)//; + $fn=~s/^http\:\/\/[^\/]+//; } else { $r->log_reason($ENV{'user.name'}.' at '.$ENV{'user.domain'}. ' unspecified filename for retrieval', $r->filename); @@ -119,20 +196,37 @@ sub handler { } # ----------------------------------------------------------- Start page output + my $uname; + my $udom; - my $uname=$ENV{'user.name'}; - my $udom=$ENV{'user.domain'}; + ($uname,$udom)= + &Apache::loncacc::constructaccess($fn,$r->dir_config('lonDefDomain')); + unless (($uname) && ($udom)) { + $r->log_reason($uname.' at '.$udom. + ' trying to publish file '.$ENV{'form.filename'}. + ' ('.$fn.') - not authorized', + $r->filename); + return HTTP_NOT_ACCEPTABLE; + } - $r->content_type('text/html'); + $fn=~s/\/\~(\w+)//; + + &Apache::loncommon::content_type($r,'text/html'); $r->send_http_header; $r->print('LON-CAPA Construction Space'); - $r->print( - ''); + $r->print(&Apache::loncommon::bodytag('Retrieve Published Resources')); - $r->print('

Retrieve previous versions of '.$fn.'

'); + $r->print('

'.&mt('Retrieve previous versions of').' '.$fn.'

'); + + if (($uname ne $ENV{'user.name'}) || ($udom ne $ENV{'user.domain'})) { + $r->print('

'.&mt('Co-Author').': '.$uname. + &mt(' at ').$udom. + '

'); + } + if ($ENV{'form.phase'} eq 'two') { &phasetwo($r,$fn,$uname,$udom); @@ -143,3 +237,71 @@ sub handler { $r->print(''); return OK; } + +1; +__END__ + +=head1 NAME + +Apache::lonretrieve - retrieves an old version of a file + +=head1 SYNOPSIS + +Invoked by /etc/httpd/conf/srm.conf: + + + PerlAccessHandler Apache::lonacc + SetHandler perl-script + PerlHandler Apache::lonretrieve + ErrorDocument 403 /adm/login + ErrorDocument 404 /adm/notfound.html + ErrorDocument 406 /adm/unauthorized.html + ErrorDocument 500 /adm/errorhandler + + +=head1 INTRODUCTION + +This module retrieves an old published version of a file. + +This is part of the LearningOnline Network with CAPA project +described at http://www.lon-capa.org. + +=head1 HANDLER SUBROUTINE + +This routine is called by Apache and mod_perl. + +=over 4 + +=item * + +Get query string for limited number of parameters + +=item * + +Start page output + +=item * + +print phase relevant output + +=item * + +(phase one is to select version; phase two retrieves version) + +=back + +=head1 OTHER SUBROUTINES + +=over 4 + +=item * + +phaseone() : Interface for selecting previous version. + +=item * + +phasetwo() : Interface for presenting specified version. + +=back + +=cut