--- loncom/publisher/lonretrieve.pm 2001/05/24 21:43:05 1.12 +++ loncom/publisher/lonretrieve.pm 2008/12/12 03:57:12 1.34.2.1 @@ -1,17 +1,32 @@ # The LearningOnline Network with CAPA # Handler to retrieve an old version of a file # -# (Publication Handler -# -# (TeX Content Handler +# $Id: lonretrieve.pm,v 1.34.2.1 2008/12/12 03:57:12 raeburn Exp $ # -# 05/29/00,05/30,10/11 Gerd Kortemeyer) +# Copyright Michigan State University Board of Trustees # -# 11/28,11/29,11/30,12/01,12/02,12/04,12/23 Gerd Kortemeyer -# 03/23 Guy Albertelli -# 03/24,03/29 Gerd Kortemeyer) +# This file is part of the LearningOnline Network with CAPA (LON-CAPA). # -# 03/31,04/03,05/02,05/09 Gerd Kortemeyer +# 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/ +# +# +### package Apache::lonretrieve; @@ -20,7 +35,12 @@ use Apache::File; use File::Copy; use Apache::Constants qw(:common :http :methods); use Apache::loncacc; +use Apache::loncommon(); +use Apache::lonlocal; +use Apache::lonnet; +use LONCAPA(); +# ------------------------------------ Interface for selecting previous version sub phaseone { my ($r,$fn,$uname,$udom)=@_; my $docroot=$r->dir_config('lonDocRoot'); @@ -32,124 +52,186 @@ sub phaseone { my $resdir=$resfn; $resdir=~s/\/[^\/]+$/\//; - $fn=~/\/([^\/]+)\.(\w+)$/; - my $main=$1; - my $suffix=$2; - + my ($main,$suffix,$is_meta) = &get_file_info($fn); + if (-e $resfn) { - $r->print('
'. - ''. - ''. - ''. - ''. - ''); - my $filename; - opendir(DIR,$resdir); - while ($filename=readdir(DIR)) { - if ($filename=~/^$main\.(\d+)\.$suffix$/) { - my $version=$1; - my ($rdev,$rino,$rmode,$rnlink, - $ruid,$rgid,$rrdev,$rsize, - $ratime,$rmtime,$rctime, - $rblksize,$rblocks)=stat($resdir.'/'.$filename); - $r->print(''); - } + $r->print(''. + ''. + ''. + &Apache::loncommon::start_data_table(). + &Apache::loncommon::start_data_table_header_row(). + ''. + ''. + ''); + if (!$is_meta) { + $r->print(''); + } + if ($is_meta + || &Apache::loncommon::fileembstyle($suffix) eq 'ssi') { + $r->print(''); + } + $r->print(&Apache::loncommon::end_data_table_header_row()); + + opendir(DIR,$resdir); + my @files = grep(/^\Q$main\E\.(\d+)\.\Q$suffix\E$/,readdir(DIR)); + @files = sort { + my ($aver) = ($a=~/^\Q$main\E\.(\d+)\.\Q$suffix\E$/); + my ($bver) = ($b=~/^\Q$main\E\.(\d+)\.\Q$suffix\E$/); + return $aver <=> $bver; + } (@files); + closedir(DIR); + + foreach my $filename (@files) { + if ($filename=~/^\Q$main\E\.(\d+)\.\Q$suffix\E$/) { + my $version=$1; + my $rmtime=&Apache::lonnet::metadata($resdir.'/'.$filename,'lastrevisiondate'); + $r->print(&Apache::loncommon::start_data_table_row(). + ''); + + if (!$is_meta) { + $r->print(''); + } + if ($is_meta + || &Apache::loncommon::fileembstyle($suffix) eq 'ssi') { + $r->print( + ''); + } + $r->print(&Apache::loncommon::end_data_table_row()); + } + } + closedir(DIR); + my $rmtime=&Apache::lonnet::metadata($resfn,'lastrevisiondate'); + $r->print(&Apache::loncommon::start_data_table_row(). + ''. + ''); + if (!$is_meta) { + $r->print(''); + } + if ($is_meta + || &Apache::loncommon::fileembstyle($suffix) eq 'ssi') { + $r->print( + ''); + } + $r->print(&Apache::loncommon::end_data_table_row(). + &Apache::loncommon::end_data_table(). + '

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

'); + if (!$is_meta) { + $r->print('

'.''. + &mt('This will only retrieve the resource. If you want to retrieve the metadata you will need to do that separately.'). + '

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

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

'); } - closedir(DIR); - my ($rdev,$rino,$rmode,$rnlink, - $ruid,$rgid,$rrdev,$rsize, - $ratime,$rmtime,$rctime, - $rblksize,$rblocks)=stat($resfn); - $r->print(''. - '
SelectVersionBecame this version on ...Metadata
'.$version.''. - localtime($rmtime).''. - ''. - 'Metadata Version '.$version.''); - if (&Apache::lonnet::fileembstyle($suffix) eq 'ssi') { - $r->print( - '  Diffs with Version '.$version.''); - } - $r->print('
'.&mt('Select').''.&mt('Version').''.&mt('Published on ...').''.&mt('Metadata').''.&mt('Diffs').''.&mt('Previously published version').' '.$version.''. + localtime($rmtime).''. + &mt('Metadata Version').' '.$version.''.&mt('Diffs with Version').' '.$version. + ''.&mt('Currently published version').''.localtime($rmtime). + ''. + &mt('Metadata current version').''.&mt('Diffs with current Version').'
Current'.localtime($rmtime). - ''. - 'Metadata current version'); - if (&Apache::lonnet::fileembstyle($suffix) eq 'ssi') { - $r->print( - '  Diffs with current Version'); - } - $r->print('

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

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

No previous versions published.

'); -} + $r->print('

'.&mt('Back to [_1]',''.$fn.'') + .'

'); } +# ---------------------------------- Interface for presenting specified version sub phasetwo { my ($r,$fn,$uname,$udom)=@_; - if ($ENV{'form.version'}) { - my $version=$ENV{'form.version'}; + 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 ($main,$suffix,$is_meta) = &get_file_info($fn); + my $logfile; my $ctarget='/home/'.$uname.'/public_html'.$fn; my $vfn=$fn; if ($version ne 'new') { - $vfn=~s/\.(\w+)$/\.$version\.$1/; + $vfn=~s/\.(\Q$suffix\E)$/\.$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'); + + my $logname = $ctarget; + if ($is_meta) { $logname =~ s/\.meta$//; } + $logname = $ctarget.'.log'; + unless ($logfile=Apache::File->new('>>'.$logname)) { + $r->print('' + .&mt('No write permission to user directory, FAIL') + .''); } print $logfile "\n\n================= Retrieve ".localtime()." ================\n". "Version: $version\nSource: $csource\nTarget: $ctarget\n"; - $r->print('

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

'); + $r->print('

'.&mt('Copying file').': '); + if (copy($csource,$ctarget)) { + $r->print('' + .&mt('ok') + .''); print $logfile "Copied sucessfully.\n\n"; } else { my $error=$!; - $r->print('fail, '.$error.'

'); + $r->print('' + .&mt('Copy failed: [_1]',$error) + .''); print $logfile "Copy failed: $error\n\n"; } - $r->print('Back to '.$fn.''); + $r->print('

' + .'

' + .&mt('Back to [_1]',$fn) + .'

'); } else { - $r->print( - 'Please pick a version to retrieve

'); + $r->print('

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

'); &phaseone($r,$fn,$uname,$udom); } } +sub get_file_info { + my ($fn) = @_; + my ($main,$suffix) = ($fn=~/\/([^\/]+)\.(\w+)$/); + my $is_meta=0; + if ($suffix eq 'meta') { + $is_meta = 1; + ($main,$suffix) = ($main=~/(.+)\.(\w+)$/); + $suffix .= '.meta'; + } + return ($main,$suffix,$is_meta); +} + +# ---------------------------------------------------------------- Main Handler sub handler { my $r=shift; my $fn; - if ($ENV{'form.filename'}) { - $fn=$ENV{'form.filename'}; + +# 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\:\/\/[^\/]+//; } else { - $r->log_reason($ENV{'user.name'}.' at '.$ENV{'user.domain'}. + $r->log_reason($env{'user.name'}.' at '.$env{'user.domain'}. ' unspecified filename for retrieval', $r->filename); return HTTP_NOT_FOUND; } unless ($fn) { - $r->log_reason($ENV{'user.name'}.' at '.$ENV{'user.domain'}. + $r->log_reason($env{'user.name'}.' at '.$env{'user.domain'}. ' trying to retrieve non-existing file', $r->filename); return HTTP_NOT_FOUND; } @@ -158,44 +240,110 @@ sub handler { my $uname; my $udom; - unless (($uname,$udom)= - &Apache::loncacc::constructaccess( - $fn,$r->dir_config('lonDefDomain'))) { + ($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'}. + ' trying to publish file '.$env{'form.filename'}. ' ('.$fn.') - not authorized', $r->filename); return HTTP_NOT_ACCEPTABLE; } - $fn=~s/\/\~(\w+)//; + $fn=~s{/~($LONCAPA::username_re)}{}; - $r->content_type('text/html'); + &Apache::loncommon::content_type($r,'text/html'); $r->send_http_header; - $r->print('LON-CAPA Construction Space'); - - $r->print( - ''); + $r->print(&Apache::loncommon::start_page('Retrieve Published Resources')); - $r->print('

Retrieve previous versions of '.$fn.'

'); + $r->print('

' + .&mt('Retrieve previous versions of [_1]' + ,''.$fn.'') + .'

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

Co-Author: '.$uname.' at '.$udom. - '

'); + 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') { + if ($env{'form.phase'} eq 'two') { &phasetwo($r,$fn,$uname,$udom); } else { &phaseone($r,$fn,$uname,$udom); } - $r->print(''); + $r->print(&Apache::loncommon::end_page()); 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