1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
|
#!/usr/bin/perl
###############################################################################
# Tweak Subversion log messages
# -----------------------------
#
# It sure would be nice to be able to change the log messages on
# committed revisions of the Subversion repository via the web. This
# is a quick attempt at making that happen.
#
# The idea here is that you visit this script at the web page. With
# no action supplied, it will present a form asking for the revision
# of the log you wish to change.
#
# Upon submitting the form, it will come back with yet another form,
# which will:
#
# - Display the current log message as static text.
# - Present a textarea for editing, initialized with the current
# log message.
#
# The user can edit the message in the textarea, then submit that form,
# which will return a confirmation and show the new log message.
#
# ====================================================================
# Copyright (c) 2001-2003 CollabNet. All rights reserved.
#
# This software is licensed as described in the file COPYING, which
# you should have received as part of this distribution. The terms
# are also available at http://subversion.tigris.org/license.html.
# If newer versions of this license are posted there, you may use a
# newer version instead, at your option.
#
# This software consists of voluntary contributions made by many
# individuals. For exact contribution history, see the revision
# history and logs, available at http://subversion.tigris.org/.
# ====================================================================
###############################################################################
use strict;
use CGI qw(:standard);
###############################################################################
# Configuration Section
my $gSvnlookCmd = '/usr/local/bin/svnlook';
my $gSvnadminCmd = '/usr/local/bin/svnadmin';
my $gReposPath = '/usr/www/repositories/svn';
my $gActionURL = './tweak-log.cgi';
my $gTempfilePrefix = '/tmp/tweak-cgi';
my $gHistoryFile = './TWEAKLOG';
my $gBypassRevpropHooks = 0; # set to 1 to bypass the repository hook system
my $gNumRecentCommits = 20; # number of recent commits to show on init form
###############################################################################
my %gCGIValues = &doCGI( );
&main( );
#-----------------------------------------------------------------------------#
sub html_escape
# (log)
#-----------------------------------------------------------------------------#
{
my $str = shift;
$str =~ s/&/&/g;
$str =~ s/>/>/g;
$str =~ s/</</g;
return $str;
}
#-----------------------------------------------------------------------------#
sub doCGI
# (void)
#-----------------------------------------------------------------------------#
{
my $lCGI = new CGI;
my @lFields = $lCGI->param;
my $lField;
my %lCGIData = ();
foreach $lField ( @lFields )
{
$lCGIData{ uc $lField } = $lCGI->param( $lField );
}
return( %lCGIData );
}
#-----------------------------------------------------------------------------#
sub doError
# (error)
#-----------------------------------------------------------------------------#
{
my $error = shift @_;
print "<html><head><title>Tweak Log - Error</title></head>\n";
print "<body><h1>ERROR</h1>\n<p>$error</p></body></html>\n";
return;
}
#-----------------------------------------------------------------------------#
sub main
# (void)
#-----------------------------------------------------------------------------#
{
# Print out HTTP headers.
print "Content-type: text/html; charset=UTF-8\n\n";
# Figure out what action to take.
if( $gCGIValues{'ACTION'} =~ /fetch/i )
{
&doFetchLog();
}
elsif( $gCGIValues{'ACTION'} =~ /commit/i )
{
&doCommitLog();
}
else
{
&doInitialForm();
}
return;
}
#-----------------------------------------------------------------------------#
sub doInitialForm
# (void)
#-----------------------------------------------------------------------------#
{
my $youngest = `$gSvnlookCmd youngest $gReposPath`;
my $rev;
my $oldest;
print "<html>\n<head>\n<title>Tweak Log</title>\n</head>\n";
print "<body>\n<form action=\"$gActionURL\" method=\"post\">\n";
print "<a name=\"__top__\"></a>\n";
print "<p>\n";
print "Boy, I sure would like to modify that log message for \n";
print "revision <input type=\"text\" name=\"rev\" value\"\">\n";
print "<input type=\"submit\" name=\"action\" value=\"Fetch Log\">\n";
print "</p></form>\n";
print "<p>\n";
print "For convenience, here are the most recent $gNumRecentCommits\n";
print "commits (click the revision number to edit that revision's log):\n";
print "</p>\n";
chomp $youngest;
$oldest = $youngest - $gNumRecentCommits + 1;
$oldest = 1 if( $oldest < 1 );
$rev = $youngest;
while( $rev >= $oldest )
{
my @infolines = `$gSvnlookCmd info $gReposPath -r $rev`;
my $author = shift @infolines;
my $date = shift @infolines;
my $log_size = shift @infolines;
print "<hr />\n";
print "<a href=\"$gActionURL?action=Fetch+Log&rev=$rev\">Revision $rev</a>:<br />\n";
print "<i>Author: $author</i><br />\n";
print "<i>Date: $date</i><br />\n";
print "<i>Log: </i><br /><pre>\n";
map {
$_ = &html_escape ($_);
} @infolines;
print @infolines;
print "</pre><br />\n";
print "<a href=\"#__top__\">(back to top)</a>\n";
$rev--;
}
print "</body></html>\n";
return;
}
#-----------------------------------------------------------------------------#
sub isValidRev
# (rev)
#-----------------------------------------------------------------------------#
{
my $youngest = `$gSvnlookCmd youngest $gReposPath`;
my $rev = shift @_;
if(not (( $youngest =~ /^\d+$/) and
( $youngest > 0 )))
{
&doError( "Unable to determine youngest revision" );
return 0;
}
if(not (( $rev =~ /^\d+$/) and
( $rev <= $youngest )))
{
&doError( "'$rev' is not a valid revision number" );
return 0;
}
return 1;
}
#-----------------------------------------------------------------------------#
sub doFetchLog
# (void)
#-----------------------------------------------------------------------------#
{
my $rev = $gCGIValues{'REV'};
my $log;
my $escaped_log; ## HTML-escaped version of $log
# Make sure we've requested a valid revision.
if( not &isValidRev( $rev ))
{
return;
}
# Fetch the log for that revision.
$log = `$gSvnlookCmd log $gReposPath -r $rev`;
$escaped_log = &html_escape ($log);
# Display the form for editing the revision
print "<html>\n<head>\n<title>Tweak Log - Log Edit</title>\n</head>\n";
print "<body>\n";
print "<h1>Editing Log Message for Revision $rev</h1>\n";
print "<h2>Current log message:</h2>\n";
print "<blockquote><hr /><pre>$escaped_log</pre><hr /></blockquote>\n";
print "<p><font color=\"red\">\n";
print "<i>Every change made is logged in <tt>${gHistoryFile}</tt>.\n";
print "If you make a bogus\n";
print "change, you can still recover the old message from there.</i>\n";
print "</font></p>\n";
print "<form action=\"$gActionURL\" method=\"post\">\n";
print "<h2>New log message:</h2>\n";
print "<blockquote>\n";
print "<textarea cols=\"80\" rows=\"25\" wrap=\"off\" name=\"log\">\n";
print $escaped_log;
print "</textarea><br />\n";
print "<input type=\"hidden\" name=\"rev\" value=\"$rev\">\n";
print "<input type=\"submit\" name=\"action\" value=\"Commit Changes\">\n";
print "</blockquote>\n";
print "</form></body></html>\n";
return;
}
#-----------------------------------------------------------------------------#
sub doCommitLog
# (void)
#-----------------------------------------------------------------------------#
{
my $rev = $gCGIValues{'REV'};
my $log = $gCGIValues{'LOG'};
my $orig_log;
my $tempfile = "$gTempfilePrefix.$$";
# Make sure we are about to change a valid revision.
if (not &isValidRev( $rev ))
{
return;
}
# Get the original log from the repository.
$orig_log = `$gSvnlookCmd log $gReposPath -r $rev`;
# If nothing was changed, go complain to the user (shame on him for
# wasting our time like that!)
if ($log eq $orig_log)
{
&doError ("Log message doesn't appear to have been edited.");
return;
}
# Open a tempfile
if (not (open( LOGFILE, "> $tempfile")))
{
&doError ("Unable to open temporary file.");
return;
}
# Dump the new log into the tempfile (and close it)
print LOGFILE $log;
close LOGFILE;
# Tell our history file what we're about to do.
if ($gHistoryFile)
{
if (not (open (HISTORY, ">> $gHistoryFile")))
{
&doError ("Unable to open history file.");
return;
}
print HISTORY "====================================================\n";
print HISTORY "REVISION $rev WAS:\n";
print HISTORY "----------------------------------------------------\n";
print HISTORY $orig_log;
print HISTORY "\n";
}
# Now, make the mods
if ($gBypassRevpropHooks)
{
`$gSvnadminCmd setlog $gReposPath -r$rev $tempfile --bypass-hooks`;
}
else
{
`$gSvnadminCmd setlog $gReposPath -r$rev $tempfile`;
}
# ...and remove the tempfile. It is, after all, temporary.
unlink $tempfile;
# Now, tell the history file what we did.
if ($gHistoryFile)
{
print HISTORY "----------------------------------------------------\n";
print HISTORY "REVISION $rev IS:\n";
print HISTORY "----------------------------------------------------\n";
print HISTORY $log;
print HISTORY "\n";
close HISTORY;
}
# Now, re-read that logfile
$log = `$gSvnlookCmd log $gReposPath -r $rev`;
$log = &html_escape ($log);
print "<html>\n<head>\n<title>Tweak Log - Log Changed</title>\n</head>\n";
print "<body>\n";
print "<h1>Success!</h1>\n";
print "<h2>New Log Message for Revision $rev</h2>\n";
print "<blockquote><hr /><pre>$log</pre><hr /></blockquote>\n";
print "</body></html>\n";
return;
}
|