File:  [LON-CAPA] / loncom / publisher / londiff.pm
Revision 1.32: download - view: text, annotated - select for diffs
Sun Oct 30 14:59:57 2011 UTC (12 years, 7 months ago) by raeburn
Branches: MAIN
CVS tags: HEAD
- permissions
- loncacc::constructaccess() args changed.
- coding style
   - eliminate leaning toothpicks
   - trim trailing white space

    1: # The LearningOnline Network with CAPA
    2: # Handler to show differences between file versions
    3: #
    4: # $Id: londiff.pm,v 1.32 2011/10/30 14:59:57 raeburn Exp $
    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: ###
   29: 
   30: 
   31: 
   32: 
   33: package Apache::londiff;
   34: 
   35: use strict;
   36: use Apache::File;
   37: use File::Copy;
   38: use File::Compare;
   39: use Algorithm::Diff qw(diff);
   40: use Apache::Constants qw(:common :http :methods);
   41: use Apache::loncacc();
   42: use Apache::lonnet;
   43: use Apache::loncommon();
   44: use Apache::lonretrieve();
   45: use Apache::lonlocal;
   46: use LONCAPA();
   47: 
   48: sub get_split_file {
   49:     my ($fn,$style)=@_;
   50:     my $f1;
   51:     my @f1;
   52:     if ($style eq 'local') {
   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') {
   61: 	$f1=&Apache::lonnet::getfile($fn);
   62:     }
   63:     @f1=split(/\r\n|\r|\n/,$f1);
   64:     return @f1;
   65: }
   66: 
   67: sub are_different_files {
   68:     my ($fileone,$filetwo)=@_;
   69:     return &compare($fileone,$filetwo);
   70: }
   71: 
   72: sub handler {
   73: 
   74:     my $r=shift;
   75: # Get query string for limited number of parameters
   76: 
   77:     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
   78: 					    ['filename','versiontwo',
   79: 					     'versionone','filetwo']);
   80: 
   81: # Check permissions
   82:     my $allowed=0;
   83:     my $cuname=$env{'user.name'};
   84:     my $cudom=$env{'user.domain'};
   85: 
   86:     if ($env{'form.filename'}=~ m{^/res/}) {
   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:                 }
   92:             } else {
   93:                 $allowed = 1;
   94:             }
   95:         } elsif (&Apache::lonnet::allowed('bro',$env{'form.filename'})) {
   96:             $allowed = 1;
   97:         }
   98:         if ($allowed) {
   99:             ($cudom,$cuname,$env{'form.filename'})=
  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:             }
  109:         }
  110:     } else {
  111: 	($cuname,$cudom)=
  112: 	    &Apache::loncacc::constructaccess($env{'form.filename'});
  113:         if ($cuname ne '' && $cudom ne '') {
  114:             $allowed = 1;
  115:         } else {
  116: 	    $r->log_reason($env{'user.name'}.':'.$env{'user.domain'}.
  117: 			   ' trying to get diffs file '.$env{'form.filename'}.
  118: 			   '  - not authorized',
  119: 			   $r->filename);
  120: 	}
  121:     }
  122:     unless ($allowed) {
  123:         return HTTP_NOT_ACCEPTABLE;
  124:     }
  125: 
  126: # Get the files
  127: 
  128:     my $efn=$env{'form.filename'};
  129:     $efn=~s{^/priv/$LONCAPA::domain_re/$LONCAPA::username_re}{};
  130: 
  131:     my @f1=();
  132:     my @f2=();
  133: 
  134:     &Apache::loncommon::content_type($r,'text/html');
  135:     $r->send_http_header;
  136: 
  137:     $r->print(&Apache::loncommon::start_page('Resource Differences',undef,
  138:                                              {'no_nav_bar'  => 1, }));
  139:   
  140:     $r->print(($env{'form.filetwo'}?'':&mt('Compare versions of')).
  141: 	      ' <span class="LC_filename">'.$efn.'</span>');
  142:    
  143:     if (($cuname ne $env{'user.name'}) || ($cudom ne $env{'user.domain'})) {
  144:         $r->print('<p><span class="LC_info">'
  145:                  .&mt('Co-Author [_1]'
  146:                      ,&Apache::loncommon::plainname($cuname,$cudom)
  147:                      .' ('.$cuname.':'.$cudom.')')
  148:                 .'</span></p>'
  149:         );
  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') {
  157: 	    my $fn=$r->dir_config('lonDocRoot')."/priv/$cudom/$cuname".$efn;
  158: 	    @f1=&get_split_file($fn,'local');
  159: 	    $r->print('<b>'.&mt('Construction Space Version').'</b>');
  160: 	} else {
  161: 	    my $fn=$r->dir_config('lonDocRoot')."/res/$cudom/$cuname";
  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'};
  181: 	    $efn2=~s{^/priv/$LONCAPA::domain_re/$LONCAPA::username_re}{};
  182: 	    my $fn=$r->dir_config('lonDocRoot')."/priv/$cudom/$cuname".$efn2;
  183: 	    @f2=&get_split_file($fn,'local');
  184: 	    $r->print('<tt>'.$efn2.'</tt>');
  185: 	} elsif ($env{'form.versiontwo'} eq 'priv') {
  186: 	    my $fn=$r->dir_config('lonDocRoot')."/priv/$cudom/$cuname".$efn;
  187: 	    @f2=&get_split_file($fn,'local');
  188: 	    $r->print('<b>'.&mt('Construction Space Version').'</b>');
  189: 	} else {
  190: 	    my $fn=
  191: 		'/home/httpd/html/res/'.$cudom.'/'.$cuname.'/';
  192: 	    if ($env{'form.versiontwo'}) {
  193: 		my ($main,$suffix,$is_meta)=
  194: 		    &Apache::lonretrieve::get_file_info($efn);
  195: 		# add on to $fn the path information in $efn
  196: 		$fn.=($efn =~m|(.*/)[^/]+|)[0];
  197: 		$fn.=$main.'.'.$env{'form.versiontwo'}.'.'.$suffix;
  198: 		$r->print('<b>'.&mt('Version').' '.$env{'form.versiontwo'}.'</b>');
  199: 	    } else {
  200: 		$fn.=$efn;
  201: 		$r->print('<b>'.&mt('Current Version').'</b>');
  202: 	    }
  203: 	    @f2=&get_split_file($fn,'remote');
  204: 	}
  205: 	$r->print('</span></p>');
  206: # Run diff
  207: 
  208: 	my $diffs = diff(\@f1, \@f2);
  209: 
  210:         if (@$diffs) {
  211:             # Start page output
  212:             my $chunk;
  213:             my $line;
  214:             $r->print('<pre>');
  215:             foreach $chunk (@$diffs) {
  216:                 foreach $line (@$chunk) {
  217:                     my ($sign, $lineno, $text) = @$line;
  218:                     $text=&HTML::Entities::encode($text,'<>&"');
  219:                     $lineno=substr($lineno.'        ',0,7);
  220:                     $r->print('<span class="'.(($sign eq '+')?'LC_diff_added'
  221:                                                              :'LC_diff_removed').'">'.
  222:                               $sign.' '.$lineno.' '.$text."</span>\n");
  223:                 }
  224:                 $r->print("</pre><hr /><pre>\n");
  225:             }
  226:             $r->print('</pre>');
  227:         } else {
  228:             $r->print('<p class="LC_info">'.&mt('No differences found').'</p>');
  229:         }
  230:     } else {
  231: 	$r->print('<h1><span class="LC_warning">'.&mt('Binary File').'</span></h1>');
  232:     }
  233:     $r->print('<center><a href="javascript:window.close();">'.&mt('Close This Window').'</a></center>');
  234:     $r->print(&Apache::loncommon::end_page()); 
  235:     return OK;  
  236: }
  237: 
  238: 
  239: 1;
  240: __END__
  241: 
  242: 
  243: =pod
  244: 
  245: =head1 NAME
  246: 
  247: Apache::londiff
  248: 
  249: =head1 SYNOPSIS
  250: 
  251: Handler to show difference between two files.
  252: 
  253: This is part of the LearningOnline Network with CAPA project
  254: described at http://www.lon-capa.org.
  255: 
  256: =head1 Subroutines
  257: 
  258: =over
  259: 
  260: =item get_split_file()
  261: 
  262: =item are_different_files()
  263: 
  264: =item handler()
  265: 
  266: =cut

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