Annotation of loncom/publisher/londiff.pm, revision 1.34

1.1       www         1: # The LearningOnline Network with CAPA
                      2: # Handler to show differences between file versions
                      3: #
1.34    ! www         4: # $Id: londiff.pm,v 1.33 2011/11/07 18:28:28 raeburn Exp $
1.6       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: #
1.7       harris41   28: ###
1.1       www        29: 
1.24      jms        30: 
                     31: 
                     32: 
1.1       www        33: package Apache::londiff;
                     34: 
                     35: use strict;
                     36: use Apache::File;
                     37: use File::Copy;
1.19      www        38: use File::Compare;
1.1       www        39: use Algorithm::Diff qw(diff);
                     40: use Apache::Constants qw(:common :http :methods);
1.20      albertel   41: use Apache::loncacc();
1.16      albertel   42: use Apache::lonnet;
1.7       harris41   43: use Apache::loncommon();
1.20      albertel   44: use Apache::lonretrieve();
1.13      sakharuk   45: use Apache::lonlocal;
1.22      albertel   46: use LONCAPA();
1.15      albertel   47: 
                     48: sub get_split_file {
                     49:     my ($fn,$style)=@_;
                     50:     my $f1;
                     51:     my @f1;
1.19      www        52:     if ($style eq 'local') {
1.15      albertel   53: 	if (-e $fn) {
                     54: 	    my $fh=Apache::File->new($fn);
                     55: 	    my $line;	
                     56: 	    while($line=<$fh>) {
                     57: 		$f1.=$line;
                     58: 	    }
                     59: 	}
                     60:     } elsif ($style eq 'remote') {
1.23      albertel   61: 	$f1=&Apache::lonnet::getfile($fn);
1.15      albertel   62:     }
1.23      albertel   63:     @f1=split(/\r\n|\r|\n/,$f1);
1.15      albertel   64:     return @f1;
                     65: }
                     66: 
1.19      www        67: sub are_different_files {
                     68:     my ($fileone,$filetwo)=@_;
                     69:     return &compare($fileone,$filetwo);
                     70: }
                     71: 
1.1       www        72: sub handler {
                     73: 
1.21      albertel   74:     my $r=shift;
1.1       www        75: # Get query string for limited number of parameters
                     76: 
1.21      albertel   77:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
                     78: 					    ['filename','versiontwo',
                     79: 					     'versionone','filetwo']);
1.1       www        80: 
1.31      raeburn    81: # Check permissions
                     82:     my $allowed=0;
1.21      albertel   83:     my $cuname=$env{'user.name'};
                     84:     my $cudom=$env{'user.domain'};
1.5       www        85: 
1.32      raeburn    86:     if ($env{'form.filename'}=~ m{^/res/}) {
1.31      raeburn    87:         if (&Apache::lonnet::allowed('bre',$env{'form.filename'})) {
                     88:             if ($env{'request.course.id'}) {
                     89:                 if (&Apache::lonnet::allowed('mdc',$env{'request.course.id'})) {
                     90:                     $allowed = 1;
                     91:                 }
1.32      raeburn    92:             } else {
                     93:                 $allowed = 1;
1.31      raeburn    94:             }
                     95:         } elsif (&Apache::lonnet::allowed('bro',$env{'form.filename'})) {
1.32      raeburn    96:             $allowed = 1;
1.31      raeburn    97:         }
                     98:         if ($allowed) {
                     99:             ($cudom,$cuname,$env{'form.filename'})=
1.32      raeburn   100:                 ($env{'form.filename'}=~m{^/res/($LONCAPA::domain_re)/($LONCAPA::username_re)(/.*)$});
                    101: 
                    102:             if (($env{'form.versionone'} eq 'priv') || ($env{'form.versiontwo'} eq 'priv')) {
                    103:                 my ($cstrname,$cstrdom) =
                    104:                     &Apache::loncacc::constructaccess("/priv/$cudom/$cuname".$env{'form.filename'});
                    105:                 unless (($cstrname eq $cuname) && ($cstrdom eq $cudom)) {
                    106:                     $allowed = 0;
                    107:                 }
                    108:             }
1.31      raeburn   109:         }
1.21      albertel  110:     } else {
1.31      raeburn   111: 	($cuname,$cudom)=
1.32      raeburn   112: 	    &Apache::loncacc::constructaccess($env{'form.filename'});
1.31      raeburn   113:         if ($cuname ne '' && $cudom ne '') {
                    114:             $allowed = 1;
                    115:         } else {
                    116: 	    $r->log_reason($env{'user.name'}.':'.$env{'user.domain'}.
1.21      albertel  117: 			   ' trying to get diffs file '.$env{'form.filename'}.
1.32      raeburn   118: 			   '  - not authorized',
                    119: 			   $r->filename);
1.21      albertel  120: 	}
                    121:     }
1.31      raeburn   122:     unless ($allowed) {
                    123:         return HTTP_NOT_ACCEPTABLE;
                    124:     }
                    125: 
                    126: # Get the files
1.32      raeburn   127: 
1.21      albertel  128:     my $efn=$env{'form.filename'};
1.30      raeburn   129:     $efn=~s{^/priv/$LONCAPA::domain_re/$LONCAPA::username_re}{};
1.5       www       130: 
1.21      albertel  131:     my @f1=();
                    132:     my @f2=();
1.1       www       133: 
1.21      albertel  134:     &Apache::loncommon::content_type($r,'text/html');
                    135:     $r->send_http_header;
1.2       www       136: 
1.26      bisitz    137:     $r->print(&Apache::loncommon::start_page('Resource Differences',undef,
                    138:                                              {'no_nav_bar'  => 1, }));
1.2       www       139:   
1.26      bisitz    140:     $r->print(($env{'form.filetwo'}?'':&mt('Compare versions of')).
                    141: 	      ' <span class="LC_filename">'.$efn.'</span>');
1.5       www       142:    
1.21      albertel  143:     if (($cuname ne $env{'user.name'}) || ($cudom ne $env{'user.domain'})) {
1.28      www       144:         $r->print('<p><span class="LC_info">'
1.27      bisitz    145:                  .&mt('Co-Author [_1]'
1.26      bisitz    146:                      ,&Apache::loncommon::plainname($cuname,$cudom)
                    147:                      .' ('.$cuname.':'.$cudom.')')
                    148:                 .'</span></p>'
                    149:         );
1.21      albertel  150:     }
                    151: 
                    152: 
                    153:     if (&Apache::loncommon::fileembstyle(($efn=~/\.(\w+)$/)) eq 'ssi'
                    154: 	|| $efn =~ /\.meta$/) {
                    155: 	$r->print('<p><span class="LC_diff_removed">');
                    156: 	if ($env{'form.versionone'} eq 'priv') {
1.30      raeburn   157: 	    my $fn=$r->dir_config('lonDocRoot')."/priv/$cudom/$cuname".$efn;
1.21      albertel  158: 	    @f1=&get_split_file($fn,'local');
                    159: 	    $r->print('<b>'.&mt('Construction Space Version').'</b>');
                    160: 	} else {
1.30      raeburn   161: 	    my $fn=$r->dir_config('lonDocRoot')."/res/$cudom/$cuname";
1.21      albertel  162: 	    if ($env{'form.versionone'}) {
                    163: 		my ($main,$suffix,$is_meta)=
                    164: 		    &Apache::lonretrieve::get_file_info($efn);
                    165: 		
                    166: 		$fn.=($efn =~m|(.*/)[^/]+|)[0];
                    167: 		# add on to $fn the path information in $efn
                    168: 		$fn.=$main.'.'.$env{'form.versionone'}.'.'.$suffix;
                    169: 		$r->print('<b>'.&mt('Version').' '.$env{'form.versionone'}.'</b>');
                    170: 	    } else {
                    171: 		$fn.=$efn;
                    172: 		$r->print('<b>'.&mt('Current Version').'</b>');
                    173: 	    }
                    174: 	    @f1=&get_split_file($fn,'remote');
                    175: 	}
                    176: 	
                    177: 	$r->print('</span><br />'.&mt('versus').'<br /><span class="LC_diff_added">');
                    178: 
                    179: 	if ($env{'form.filetwo'}) {
                    180: 	    my $efn2=$env{'form.filetwo'};
1.30      raeburn   181: 	    $efn2=~s{^/priv/$LONCAPA::domain_re/$LONCAPA::username_re}{};
                    182: 	    my $fn=$r->dir_config('lonDocRoot')."/priv/$cudom/$cuname".$efn2;
1.21      albertel  183: 	    @f2=&get_split_file($fn,'local');
                    184: 	    $r->print('<tt>'.$efn2.'</tt>');
                    185: 	} elsif ($env{'form.versiontwo'} eq 'priv') {
1.30      raeburn   186: 	    my $fn=$r->dir_config('lonDocRoot')."/priv/$cudom/$cuname".$efn;
1.21      albertel  187: 	    @f2=&get_split_file($fn,'local');
                    188: 	    $r->print('<b>'.&mt('Construction Space Version').'</b>');
                    189: 	} else {
1.33      raeburn   190: 	    my $fn=$r->dir_config('lonDocRoot')."/res/$cudom/$cuname/";
1.21      albertel  191: 	    if ($env{'form.versiontwo'}) {
                    192: 		my ($main,$suffix,$is_meta)=
                    193: 		    &Apache::lonretrieve::get_file_info($efn);
                    194: 		# add on to $fn the path information in $efn
                    195: 		$fn.=($efn =~m|(.*/)[^/]+|)[0];
                    196: 		$fn.=$main.'.'.$env{'form.versiontwo'}.'.'.$suffix;
                    197: 		$r->print('<b>'.&mt('Version').' '.$env{'form.versiontwo'}.'</b>');
                    198: 	    } else {
                    199: 		$fn.=$efn;
                    200: 		$r->print('<b>'.&mt('Current Version').'</b>');
                    201: 	    }
                    202: 	    @f2=&get_split_file($fn,'remote');
                    203: 	}
                    204: 	$r->print('</span></p>');
1.1       www       205: # Run diff
                    206: 
1.21      albertel  207: 	my $diffs = diff(\@f1, \@f2);
1.1       www       208: 
1.26      bisitz    209:         if (@$diffs) {
                    210:             # Start page output
                    211:             my $chunk;
                    212:             my $line;
                    213:             $r->print('<pre>');
                    214:             foreach $chunk (@$diffs) {
                    215:                 foreach $line (@$chunk) {
                    216:                     my ($sign, $lineno, $text) = @$line;
                    217:                     $text=&HTML::Entities::encode($text,'<>&"');
                    218:                     $lineno=substr($lineno.'        ',0,7);
                    219:                     $r->print('<span class="'.(($sign eq '+')?'LC_diff_added'
                    220:                                                              :'LC_diff_removed').'">'.
                    221:                               $sign.' '.$lineno.' '.$text."</span>\n");
                    222:                 }
                    223:                 $r->print("</pre><hr /><pre>\n");
                    224:             }
                    225:             $r->print('</pre>');
                    226:         } else {
                    227:             $r->print('<p class="LC_info">'.&mt('No differences found').'</p>');
                    228:         }
1.21      albertel  229:     } else {
                    230: 	$r->print('<h1><span class="LC_warning">'.&mt('Binary File').'</span></h1>');
                    231:     }
                    232:     $r->print(&Apache::loncommon::end_page()); 
                    233:     return OK;  
1.1       www       234: }
                    235: 
                    236: 
                    237: 1;
                    238: __END__
1.2       www       239: 
1.1       www       240: 
1.25      jms       241: =pod
1.1       www       242: 
1.25      jms       243: =head1 NAME
1.1       www       244: 
1.25      jms       245: Apache::londiff
                    246: 
                    247: =head1 SYNOPSIS
                    248: 
                    249: Handler to show difference between two files.
                    250: 
                    251: This is part of the LearningOnline Network with CAPA project
                    252: described at http://www.lon-capa.org.
                    253: 
                    254: =head1 Subroutines
                    255: 
                    256: =over
                    257: 
                    258: =item get_split_file()
                    259: 
                    260: =item are_different_files()
                    261: 
                    262: =item handler()
                    263: 
                    264: =cut

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