Annotation of loncom/publisher/lonretrieve.pm, revision 1.43

1.1       www         1: # The LearningOnline Network with CAPA
                      2: # Handler to retrieve an old version of a file
                      3: #
1.43    ! www         4: # $Id: lonretrieve.pm,v 1.42 2010/12/14 16:26:04 www Exp $
1.15      albertel    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: #
                     28: #
1.16      harris41   29: ###
1.1       www        30: 
1.35      jms        31: =head1 NAME
                     32: 
                     33: Apache::lonretrieve - retrieves an old version of a file
                     34: 
                     35: =head1 SYNOPSIS
                     36: 
                     37: Invoked by /etc/httpd/conf/srm.conf:
                     38: 
                     39:  <Location /adm/retrieve>
                     40:  PerlAccessHandler       Apache::lonacc
                     41:  SetHandler perl-script
                     42:  PerlHandler Apache::lonretrieve
                     43:  ErrorDocument     403 /adm/login
                     44:  ErrorDocument     404 /adm/notfound.html
                     45:  ErrorDocument     406 /adm/unauthorized.html
                     46:  ErrorDocument	  500 /adm/errorhandler
                     47:  </Location>
                     48: 
                     49: =head1 INTRODUCTION
                     50: 
                     51: This module retrieves an old published version of a file.
                     52: 
                     53: This is part of the LearningOnline Network with CAPA project
                     54: described at http://www.lon-capa.org.
                     55: 
                     56: =head1 HANDLER SUBROUTINE
                     57: 
                     58: This routine is called by Apache and mod_perl.
                     59: 
                     60: =over 4
                     61: 
                     62: =item *
                     63: 
                     64: Get query string for limited number of parameters
                     65: 
                     66: =item *
                     67: 
                     68: Start page output
                     69: 
                     70: =item *
                     71: 
                     72: print phase relevant output
                     73: 
                     74: =item *
                     75: 
                     76: (phase one is to select version; phase two retrieves version)
                     77: 
                     78: =back
                     79: 
                     80: =head1 OTHER SUBROUTINES
                     81: 
                     82: =over 4
                     83: 
                     84: =item *
                     85: 
                     86: phaseone() : Interface for selecting previous version.
                     87: 
                     88: =item *
                     89: 
                     90: phasetwo() : Interface for presenting specified version.
                     91: 
                     92: =back
                     93: 
                     94: =cut
                     95: 
1.1       www        96: package Apache::lonretrieve;
                     97: 
                     98: use strict;
                     99: use Apache::File;
                    100: use File::Copy;
                    101: use Apache::Constants qw(:common :http :methods);
1.10      www       102: use Apache::loncacc;
1.16      harris41  103: use Apache::loncommon();
1.23      www       104: use Apache::lonlocal;
1.27      albertel  105: use Apache::lonnet;
1.34      albertel  106: use LONCAPA();
1.1       www       107: 
1.16      harris41  108: # ------------------------------------ Interface for selecting previous version
1.2       www       109: sub phaseone {
                    110:     my ($r,$fn,$uname,$udom)=@_;
                    111:     my $docroot=$r->dir_config('lonDocRoot');
                    112: 
1.3       www       113:     my $urldir='/res/'.$udom.'/'.$uname.$fn;
                    114:     $urldir=~s/\/[^\/]+$/\//;
                    115: 
                    116:     my $resfn=$docroot.'/res/'.$udom.'/'.$uname.$fn;
                    117:     my $resdir=$resfn;
1.2       www       118:     $resdir=~s/\/[^\/]+$/\//;
                    119: 
1.31      albertel  120:     my ($main,$suffix,$is_meta) = &get_file_info($fn);
                    121:     
1.6       www       122:     if (-e $resfn) {  
1.39      bisitz    123: 	$r->print('<form action="/adm/retrieve" method="post">'.
1.32      albertel  124: 		  '<input type="hidden" name="filename" value="/~'.$uname.$fn.'" />'.
                    125: 		  '<input type="hidden" name="phase" value="two" />'.
                    126: 		  &Apache::loncommon::start_data_table().
                    127: 		  &Apache::loncommon::start_data_table_header_row().
                    128: 		  '<th>'.&mt('Select').'</th>'.
                    129: 		  '<th>'.&mt('Version').'</th>'.
                    130: 		  '<th>'.&mt('Published on ...').'</th>');
                    131: 	if (!$is_meta) {
                    132: 	    $r->print('<th>'.&mt('Metadata').'</th>');
                    133: 	}
                    134: 	if ($is_meta
                    135: 	    || &Apache::loncommon::fileembstyle($suffix) eq 'ssi') {
                    136: 	    $r->print('<th>'.&mt('Diffs').'</th>');
                    137: 	}
                    138: 	$r->print(&Apache::loncommon::end_data_table_header_row());
                    139: 	
                    140: 	opendir(DIR,$resdir);
                    141: 	my @files = grep(/^\Q$main\E\.(\d+)\.\Q$suffix\E$/,readdir(DIR));
                    142: 	@files = sort {
                    143: 	    my ($aver) = ($a=~/^\Q$main\E\.(\d+)\.\Q$suffix\E$/);
                    144: 	    my ($bver) = ($b=~/^\Q$main\E\.(\d+)\.\Q$suffix\E$/);
                    145: 	    return $aver <=> $bver;
                    146: 	} (@files);
                    147: 	closedir(DIR);
                    148: 	
                    149: 	foreach my $filename (@files) {
                    150: 	    if ($filename=~/^\Q$main\E\.(\d+)\.\Q$suffix\E$/) {
                    151: 		my $version=$1;
                    152: 		my $rmtime=&Apache::lonnet::metadata($resdir.'/'.$filename,'lastrevisiondate');
                    153: 		$r->print(&Apache::loncommon::start_data_table_row().
                    154: 			  '<td><input type="radio" name="version" value="'.
1.41      bisitz    155: 			  $version.'" /></td><td>'.&mt('Previously published version').' '.$version.'</td>'.
                    156:               '<td>'.&Apache::lonlocal::locallocaltime($rmtime).'</td>');
1.32      albertel  157: 		
                    158: 		if (!$is_meta) {
1.38      bisitz    159: 		    $r->print('<td><a href="'.$urldir.$filename.'.meta" target="cat">'.
1.32      albertel  160: 			      &mt('Metadata Version').' '.$version.'</a></td>');
                    161: 		}
                    162: 		if ($is_meta
                    163: 		    || &Apache::loncommon::fileembstyle($suffix) eq 'ssi') {
                    164: 		    $r->print(
                    165: 			      '<td><a target="cat" href="/adm/diff?filename=/~'.
                    166: 			      $uname.$fn.
                    167: 			      '&amp;versiontwo=priv&amp;versionone='.$version.
                    168: 			      '">'.&mt('Diffs with Version').' '.$version.
                    169: 			      '</a></td>');
                    170: 		}
                    171: 		$r->print(&Apache::loncommon::end_data_table_row());
                    172: 	    }
                    173: 	}
                    174: 	closedir(DIR);
                    175: 	my $rmtime=&Apache::lonnet::metadata($resfn,'lastrevisiondate');
                    176: 	$r->print(&Apache::loncommon::start_data_table_row().
                    177: 		  '<td><input type="radio" name="version" value="new" /></td>'.
1.41      bisitz    178: 		  '<td><b>'.&mt('Currently published version').'</b></td>'.
                    179:           '<td>'.&Apache::lonlocal::locallocaltime($rmtime).'</td>'
                    180:     );
1.32      albertel  181: 	if (!$is_meta) {
1.38      bisitz    182: 	    $r->print('<td><a href="'.$urldir.$main.'.'.$suffix.'.meta" target="cat">'.
1.32      albertel  183: 		      &mt('Metadata current version').'</a></td>');           
                    184: 	}
                    185: 	if ($is_meta 
                    186: 	    || &Apache::loncommon::fileembstyle($suffix) eq 'ssi') {
                    187: 	    $r->print(
                    188: 		      '<td><a target="cat" href="/adm/diff?filename=/~'.
                    189: 		      $uname.$fn.
                    190: 		      '&amp;versiontwo=priv'.
                    191: 		      '">'.&mt('Diffs with current Version').'</a></td>');
                    192: 	}
                    193: 	$r->print(&Apache::loncommon::end_data_table_row().
                    194: 		  &Apache::loncommon::end_data_table().
1.33      albertel  195: 		  '<p>'.'<span class="LC_warning">'.
1.36      bisitz    196: 		  &mt('Retrieval of an old version will overwrite the file currently in construction space.').'</span></p>');
1.33      albertel  197: 	if (!$is_meta) {
                    198: 	    $r->print('<p>'.'<span class="LC_warning">'.
1.36      bisitz    199: 		      &mt('This will only retrieve the resource. If you want to retrieve the metadata, you will need to do that separately.').
1.33      albertel  200: 		      '</span></p>');
                    201: 	}
1.41      bisitz    202: 	$r->print('<input type="submit" value="'.&mt('Retrieve selected Version').'" /></form>');
1.32      albertel  203:     } else {
1.36      bisitz    204: 	$r->print('<p class="LC_warning">'.&mt('No previous versions published.').'</p>');
1.31      albertel  205:     }
1.41      bisitz    206: 
                    207:     my $dir =  &Apache::loncommon::authorspace()
                    208:               .&File::Basename::dirname($fn)
                    209:               .'/';
                    210:     $r->print(&Apache::lonhtmlcommon::start_funclist()
                    211:              .&Apache::lonhtmlcommon::add_item_funclist(
                    212:                   '<a href="/priv/'.$uname.$fn.'">'
                    213:                  .&mt('Back to Resource')
                    214:                  .'</a>')
                    215:              .&Apache::lonhtmlcommon::add_item_funclist(
                    216:                   '<a href="'.$dir.'">'
                    217:                  .&mt('Back to Directory')
                    218:                  .'</a>')
                    219:              .&Apache::lonhtmlcommon::end_funclist()
                    220:     );
1.2       www       221: }
1.1       www       222: 
1.16      harris41  223: # ---------------------------------- Interface for presenting specified version
1.4       www       224: sub phasetwo {
                    225:     my ($r,$fn,$uname,$udom)=@_;
1.27      albertel  226:     if ($env{'form.version'}) {
                    227:         my $version=$env{'form.version'};
1.4       www       228: 	if ($version eq 'new') {
1.23      www       229: 	    $r->print('<h3>'.&mt('Retrieving current (most recent) version').'</h3>');
1.4       www       230:         } else {
1.23      www       231:             $r->print('<h3>'.&mt('Retrieving old version').' '.$version.'</h3>');
1.4       www       232:         }
1.31      albertel  233: 	my ($main,$suffix,$is_meta) = &get_file_info($fn);
                    234: 
1.4       www       235:         my $logfile;
1.43    ! www       236:         my $ctarget=$r->dir_config('lonDocRoot').'/priv/'.$udom.'/'.$uname.$fn;
1.5       www       237:         my $vfn=$fn;
                    238:         if ($version ne 'new') {
1.31      albertel  239: 	    $vfn=~s/\.(\Q$suffix\E)$/\.$version\.$1/;
1.5       www       240:         }
1.31      albertel  241: 
1.5       www       242:         my $csource=$r->dir_config('lonDocRoot').'/res/'.$udom.'/'.$uname.$vfn;
1.31      albertel  243: 
                    244: 	my $logname = $ctarget;
                    245: 	if ($is_meta) { $logname =~ s/\.meta$//; }
                    246: 	$logname = $ctarget.'.log';
                    247:         unless ($logfile=Apache::File->new('>>'.$logname)) {
1.36      bisitz    248:           $r->print('<span class="LC_error">'
                    249:                    .&mt('No write permission to user directory, FAIL')
                    250:                    .'</span>');
1.4       www       251:         }
                    252:         print $logfile 
                    253: "\n\n================= Retrieve ".localtime()." ================\n".
1.5       www       254: "Version: $version\nSource: $csource\nTarget: $ctarget\n";
1.23      www       255:         $r->print('<p>'.&mt('Copying file').': ');
1.31      albertel  256: 	if (copy($csource,$ctarget)) {
1.36      bisitz    257: 	    $r->print('<span class="LC_success">'
                    258:                      .&mt('ok')
                    259:                      .'</span>');
1.5       www       260:             print $logfile "Copied sucessfully.\n\n";
                    261:         } else {
                    262:             my $error=$!;
1.36      bisitz    263: 	    $r->print('<span class="LC_error">'
                    264:                      .&mt('Copy failed: [_1]',$error)
                    265:                      .'</span>');
1.5       www       266:             print $logfile "Copy failed: $error\n\n";
                    267:         }
1.36      bisitz    268:         $r->print('</p>'
                    269:                  .'<p><a href="/priv/'.$uname.$fn.'">'
1.41      bisitz    270:                  .&mt('Back to Resource')
1.36      bisitz    271:                  .'</a></p>');
1.4       www       272:     } else {
1.36      bisitz    273:        $r->print('<p class="LC_info">'.&mt('Please pick a version to retrieve:').'</p>');
1.4       www       274:        &phaseone($r,$fn,$uname,$udom);
                    275:     }
                    276: }
                    277: 
1.31      albertel  278: sub get_file_info {
                    279:     my ($fn) = @_;
                    280:     my ($main,$suffix) = ($fn=~/\/([^\/]+)\.(\w+)$/);
                    281:     my $is_meta=0;
                    282:     if ($suffix eq 'meta') {
                    283: 	$is_meta = 1;
                    284: 	($main,$suffix) = ($main=~/(.+)\.(\w+)$/);	    
                    285: 	$suffix .= '.meta';
                    286:     }
                    287:     return ($main,$suffix,$is_meta);
                    288: }
                    289: 
1.16      harris41  290: # ---------------------------------------------------------------- Main Handler
1.1       www       291: sub handler {
                    292: 
                    293:   my $r=shift;
                    294: 
                    295:   my $fn;
1.14      www       296: 
                    297: 
                    298: # Get query string for limited number of parameters
                    299: 
1.17      stredwic  300:   &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
1.18      www       301: 					  ['filename']);
1.1       www       302: 
1.27      albertel  303:   if ($env{'form.filename'}) {
                    304:       $fn=$env{'form.filename'};
1.37      raeburn   305:       $fn=~s/^https?\:\/\/[^\/]+//;
1.1       www       306:   } else {
1.27      albertel  307:      $r->log_reason($env{'user.name'}.' at '.$env{'user.domain'}.
1.2       www       308:          ' unspecified filename for retrieval', $r->filename); 
                    309:      return HTTP_NOT_FOUND;
1.1       www       310:   }
                    311: 
                    312:   unless ($fn) { 
1.27      albertel  313:      $r->log_reason($env{'user.name'}.' at '.$env{'user.domain'}.
1.2       www       314:          ' trying to retrieve non-existing file', $r->filename); 
1.1       www       315:      return HTTP_NOT_FOUND;
                    316:   } 
                    317: 
                    318: # ----------------------------------------------------------- Start page output
1.10      www       319:   my $uname;
                    320:   my $udom;
1.1       www       321: 
1.13      www       322:   ($uname,$udom)=
                    323:     &Apache::loncacc::constructaccess($fn,$r->dir_config('lonDefDomain'));
                    324:   unless (($uname) && ($udom)) {
1.10      www       325:      $r->log_reason($uname.' at '.$udom.
1.27      albertel  326:          ' trying to publish file '.$env{'form.filename'}.
1.10      www       327:          ' ('.$fn.') - not authorized', 
                    328:          $r->filename); 
                    329:      return HTTP_NOT_ACCEPTABLE;
                    330:   }
                    331: 
1.34      albertel  332:   $fn=~s{/~($LONCAPA::username_re)}{};
1.1       www       333: 
1.23      www       334:   &Apache::loncommon::content_type($r,'text/html');
1.1       www       335:   $r->send_http_header;
                    336: 
1.41      bisitz    337:     # Breadcrumbs
                    338:     &Apache::lonhtmlcommon::clear_breadcrumbs();
                    339:     &Apache::lonhtmlcommon::add_breadcrumb({
                    340:         'text'  => 'Construction Space',
                    341:         'href'  => &Apache::loncommon::authorspace(),
                    342:     });
                    343:     &Apache::lonhtmlcommon::add_breadcrumb({
                    344:         'text'  => 'Retrieve previous version',
                    345:         'href'  => '',
                    346:     });
                    347: 
                    348:   $r->print(&Apache::loncommon::start_page('Retrieve Published Resources')
                    349:            .&Apache::lonhtmlcommon::breadcrumbs()
                    350:            .&Apache::loncommon::head_subbox(
                    351:                 &Apache::loncommon::CSTR_pageheader()) # FIXME crumbs broken?
                    352:     );
1.1       www       353: 
1.40      bisitz    354:   $r->print('<p>'
1.36      bisitz    355:            .&mt('Retrieve previous versions of [_1]'
                    356:                    ,'<span class="LC_filename">'.$fn.'</span>')
1.40      bisitz    357:            .'</p>');
1.10      www       358:   
1.27      albertel  359:   if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.42      www       360:           $r->print('<p><span class="LC_info">'
1.40      bisitz    361:                    .&mt('Co-Author [_1]'
                    362:                        ,&Apache::loncommon::plainname($uname,$udom)
                    363:                        .' ('.$uname.':'.$udom.')')
                    364:                    .'</span></p>');
1.10      www       365:   }
                    366: 
1.1       www       367: 
1.27      albertel  368:   if ($env{'form.phase'} eq 'two') {
1.4       www       369:       &phasetwo($r,$fn,$uname,$udom);
1.2       www       370:   } else {
                    371:       &phaseone($r,$fn,$uname,$udom);
                    372:   }
1.1       www       373: 
1.30      albertel  374:   $r->print(&Apache::loncommon::end_page());
1.1       www       375:   return OK;  
                    376: }
1.7       www       377: 
                    378: 1;
                    379: __END__
1.16      harris41  380: 
                    381: 

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