/usr/share/perl5/IkiWiki/Plugin/git.pm is in ikiwiki 3.20141016.4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 | #!/usr/bin/perl
package IkiWiki::Plugin::git;
use warnings;
use strict;
use IkiWiki;
use Encode;
use File::Path qw{remove_tree};
use URI::Escape q{uri_escape_utf8};
use open qw{:utf8 :std};
my $sha1_pattern = qr/[0-9a-fA-F]{40}/; # pattern to validate Git sha1sums
my $dummy_commit_msg = 'dummy commit'; # message to skip in recent changes
sub import {
hook(type => "checkconfig", id => "git", call => \&checkconfig);
hook(type => "getsetup", id => "git", call => \&getsetup);
hook(type => "genwrapper", id => "git", call => \&genwrapper);
hook(type => "rcs", id => "rcs_update", call => \&rcs_update);
hook(type => "rcs", id => "rcs_prepedit", call => \&rcs_prepedit);
hook(type => "rcs", id => "rcs_commit", call => \&rcs_commit);
hook(type => "rcs", id => "rcs_commit_staged", call => \&rcs_commit_staged);
hook(type => "rcs", id => "rcs_add", call => \&rcs_add);
hook(type => "rcs", id => "rcs_remove", call => \&rcs_remove);
hook(type => "rcs", id => "rcs_rename", call => \&rcs_rename);
hook(type => "rcs", id => "rcs_recentchanges", call => \&rcs_recentchanges);
hook(type => "rcs", id => "rcs_diff", call => \&rcs_diff);
hook(type => "rcs", id => "rcs_getctime", call => \&rcs_getctime);
hook(type => "rcs", id => "rcs_getmtime", call => \&rcs_getmtime);
hook(type => "rcs", id => "rcs_receive", call => \&rcs_receive);
hook(type => "rcs", id => "rcs_preprevert", call => \&rcs_preprevert);
hook(type => "rcs", id => "rcs_revert", call => \&rcs_revert);
hook(type => "rcs", id => "rcs_find_changes", call => \&rcs_find_changes);
hook(type => "rcs", id => "rcs_get_current_rev", call => \&rcs_get_current_rev);
}
sub checkconfig () {
if (! defined $config{gitorigin_branch}) {
$config{gitorigin_branch}="origin";
}
if (! defined $config{gitmaster_branch}) {
$config{gitmaster_branch}="master";
}
if (defined $config{git_wrapper} &&
length $config{git_wrapper}) {
push @{$config{wrappers}}, {
wrapper => $config{git_wrapper},
wrappermode => (defined $config{git_wrappermode} ? $config{git_wrappermode} : "06755"),
wrapper_background_command => $config{git_wrapper_background_command},
};
}
if (defined $config{git_test_receive_wrapper} &&
length $config{git_test_receive_wrapper} &&
defined $config{untrusted_committers} &&
@{$config{untrusted_committers}}) {
push @{$config{wrappers}}, {
test_receive => 1,
wrapper => $config{git_test_receive_wrapper},
wrappermode => (defined $config{git_wrappermode} ? $config{git_wrappermode} : "06755"),
};
}
# Avoid notes, parser does not handle and they only slow things down.
$ENV{GIT_NOTES_REF}="";
# Run receive test only if being called by the wrapper, and not
# when generating same.
if ($config{test_receive} && ! exists $config{wrapper}) {
require IkiWiki::Receive;
IkiWiki::Receive::test();
}
}
sub getsetup () {
return
plugin => {
safe => 0, # rcs plugin
rebuild => undef,
section => "rcs",
},
git_wrapper => {
type => "string",
example => "/git/wiki.git/hooks/post-update",
description => "git hook to generate",
safe => 0, # file
rebuild => 0,
},
git_wrapper_background_command => {
type => "string",
example => "git push github",
description => "shell command for git_wrapper to run, in the background",
safe => 0, # command
rebuild => 0,
},
git_wrappermode => {
type => "string",
example => '06755',
description => "mode for git_wrapper (can safely be made suid)",
safe => 0,
rebuild => 0,
},
git_test_receive_wrapper => {
type => "string",
example => "/git/wiki.git/hooks/pre-receive",
description => "git pre-receive hook to generate",
safe => 0, # file
rebuild => 0,
},
untrusted_committers => {
type => "string",
example => [],
description => "unix users whose commits should be checked by the pre-receive hook",
safe => 0,
rebuild => 0,
},
historyurl => {
type => "string",
example => "http://git.example.com/gitweb.cgi?p=wiki.git;a=history;f=[[file]];hb=HEAD",
description => "gitweb url to show file history ([[file]] substituted)",
safe => 1,
rebuild => 1,
},
diffurl => {
type => "string",
example => "http://git.example.com/gitweb.cgi?p=wiki.git;a=blobdiff;f=[[file]];h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_commit]];hpb=[[sha1_parent]]",
description => "gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)",
safe => 1,
rebuild => 1,
},
gitorigin_branch => {
type => "string",
example => "origin",
description => "where to pull and push changes (set to empty string to disable)",
safe => 0, # paranoia
rebuild => 0,
},
gitmaster_branch => {
type => "string",
example => "master",
description => "branch that the wiki is stored in",
safe => 0, # paranoia
rebuild => 0,
},
}
sub genwrapper {
if ($config{test_receive}) {
require IkiWiki::Receive;
return IkiWiki::Receive::genwrapper();
}
else {
return "";
}
}
# Loosely based on git-new-workdir from git contrib.
sub create_temp_working_dir ($$) {
my $rootdir = shift;
my $branch = shift;
my $working = "$rootdir/.git/ikiwiki-temp-working";
remove_tree($working);
foreach my $dir ("", ".git") {
if (!mkdir("$working/$dir")) {
error("Unable to create $working/$dir: $!");
}
}
# Hooks are deliberately not included: we will commit to the temporary
# branch that is used in the temporary working tree, and we don't want
# to run the post-commit hook there.
#
# logs/refs is not included because we don't use the reflog.
# remotes, rr-cache, svn are similarly excluded.
foreach my $link ("config", "refs", "objects", "info", "packed-refs") {
if (!symlink("../../$link", "$working/.git/$link")) {
error("Unable to create symlink $working/.git/$link: $!");
}
}
open (my $out, '>', "$working/.git/HEAD") or
error("failed to write $working.git/HEAD: $!");
print $out "ref: refs/heads/$branch\n" or
error("failed to write $working.git/HEAD: $!");
close $out or
error("failed to write $working.git/HEAD: $!");
return $working;
}
sub safe_git {
# Start a child process safely without resorting to /bin/sh.
# Returns command output (in list content) or success state
# (in scalar context), or runs the specified data handler.
my %params = @_;
my $pid = open my $OUT, "-|";
error("Working directory not specified") unless defined $params{chdir};
error("Cannot fork: $!") if !defined $pid;
if (!$pid) {
# In child.
# Git commands want to be in wc.
if ($params{chdir} ne '.') {
chdir $params{chdir}
or error("cannot chdir to $params{chdir}: $!");
}
if ($params{stdout}) {
open(STDOUT, '>&', $params{stdout}) or error("Cannot reopen stdout: $!");
}
exec @{$params{cmdline}} or error("Cannot exec '@{$params{cmdline}}': $!");
}
# In parent.
# git output is probably utf-8 encoded, but may contain
# other encodings or invalidly encoded stuff. So do not rely
# on the normal utf-8 IO layer, decode it by hand.
binmode($OUT);
my @lines;
while (<$OUT>) {
$_=decode_utf8($_, 0);
chomp;
if (! defined $params{data_handler}) {
push @lines, $_;
}
else {
last unless $params{data_handler}->($_);
}
}
close $OUT;
$params{error_handler}->("'@{$params{cmdline}}' failed: $!") if $? && $params{error_handler};
return wantarray ? @lines : ($? == 0);
}
# Convenient wrappers.
sub run_or_die_in ($$@) {
my $dir = shift;
safe_git(chdir => $dir, error_handler => \&error, cmdline => \@_);
}
sub run_or_cry_in ($$@) {
my $dir = shift;
safe_git(chdir => $dir, error_handler => sub { warn @_ }, cmdline => \@_);
}
sub run_or_non_in ($$@) {
my $dir = shift;
safe_git(chdir => $dir, cmdline => \@_);
}
sub ensure_committer ($) {
my $dir = shift;
if (! length $ENV{GIT_AUTHOR_NAME} || ! length $ENV{GIT_COMMITTER_NAME}) {
my $name = join('', run_or_non_in($dir, "git", "config", "user.name"));
if (! length $name) {
run_or_die_in($dir, "git", "config", "user.name", "IkiWiki");
}
}
if (! length $ENV{GIT_AUTHOR_EMAIL} || ! length $ENV{GIT_COMMITTER_EMAIL}) {
my $email = join('', run_or_non_in($dir, "git", "config", "user.email"));
if (! length $email) {
run_or_die_in($dir, "git", "config", "user.email", "ikiwiki.info");
}
}
}
sub merge_past ($$$) {
# Unlike with Subversion, Git cannot make a 'svn merge -rN:M file'.
# Git merge commands work with the committed changes, except in the
# implicit case of '-m' of git checkout(1). So we should invent a
# kludge here. In principle, we need to create a throw-away branch
# in preparing for the merge itself. Since branches are cheap (and
# branching is fast), this shouldn't cost high.
#
# The main problem is the presence of _uncommitted_ local changes. One
# possible approach to get rid of this situation could be that we first
# make a temporary commit in the master branch and later restore the
# initial state (this is possible since Git has the ability to undo a
# commit, i.e. 'git reset --soft HEAD^'). The method can be summarized
# as follows:
#
# - create a diff of HEAD:current-sha1
# - dummy commit
# - create a dummy branch and switch to it
# - rewind to past (reset --hard to the current-sha1)
# - apply the diff and commit
# - switch to master and do the merge with the dummy branch
# - make a soft reset (undo the last commit of master)
#
# The above method has some drawbacks: (1) it needs a redundant commit
# just to get rid of local changes, (2) somewhat slow because of the
# required system forks. Until someone points a more straight method
# (which I would be grateful) I have implemented an alternative method.
# In this approach, we hide all the modified files from Git by renaming
# them (using the 'rename' builtin) and later restore those files in
# the throw-away branch (that is, we put the files themselves instead
# of applying a patch).
my ($sha1, $file, $message) = @_;
my @undo; # undo stack for cleanup in case of an error
my $conflict; # file content with conflict markers
ensure_committer($config{srcdir});
eval {
# Hide local changes from Git by renaming the modified file.
# Relative paths must be converted to absolute for renaming.
my ($target, $hidden) = (
"$config{srcdir}/${file}", "$config{srcdir}/${file}.${sha1}"
);
rename($target, $hidden)
or error("rename '$target' to '$hidden' failed: $!");
# Ensure to restore the renamed file on error.
push @undo, sub {
return if ! -e "$hidden"; # already renamed
rename($hidden, $target)
or warn "rename '$hidden' to '$target' failed: $!";
};
my $branch = "throw_away_${sha1}"; # supposed to be unique
# Create a throw-away branch and rewind backward.
push @undo, sub { run_or_cry_in($config{srcdir}, 'git', 'branch', '-D', $branch) };
run_or_die_in($config{srcdir}, 'git', 'branch', $branch, $sha1);
# Switch to throw-away branch for the merge operation.
push @undo, sub {
if (!run_or_cry_in($config{srcdir}, 'git', 'checkout', $config{gitmaster_branch})) {
run_or_cry_in($config{srcdir}, 'git', 'checkout','-f',$config{gitmaster_branch});
}
};
run_or_die_in($config{srcdir}, 'git', 'checkout', $branch);
# Put the modified file in _this_ branch.
rename($hidden, $target)
or error("rename '$hidden' to '$target' failed: $!");
# _Silently_ commit all modifications in the current branch.
run_or_non_in($config{srcdir}, 'git', 'commit', '-m', $message, '-a');
# ... and re-switch to master.
run_or_die_in($config{srcdir}, 'git', 'checkout', $config{gitmaster_branch});
# Attempt to merge without complaining.
if (!run_or_non_in($config{srcdir}, 'git', 'pull', '--no-commit', '.', $branch)) {
$conflict = readfile($target);
run_or_die_in($config{srcdir}, 'git', 'reset', '--hard');
}
};
my $failure = $@;
# Process undo stack (in reverse order). By policy cleanup
# actions should normally print a warning on failure.
while (my $handle = pop @undo) {
$handle->();
}
error("Git merge failed!\n$failure\n") if $failure;
return $conflict;
}
{
my %prefix_cache;
sub decode_git_file ($$) {
my $dir=shift;
my $file=shift;
# git does not output utf-8 filenames, but instead
# double-quotes them with the utf-8 characters
# escaped as \nnn\nnn.
if ($file =~ m/^"(.*)"$/) {
($file=$1) =~ s/\\([0-7]{1,3})/chr(oct($1))/eg;
}
# strip prefix if in a subdir
if (! defined $prefix_cache{$dir}) {
($prefix_cache{$dir}) = run_or_die_in($dir, 'git', 'rev-parse', '--show-prefix');
if (! defined $prefix_cache{$dir}) {
$prefix_cache{$dir}="";
}
}
$file =~ s/^\Q$prefix_cache{$dir}\E//;
return decode("utf8", $file);
}
}
sub parse_diff_tree ($$) {
# Parse the raw diff tree chunk and return the info hash.
# See git-diff-tree(1) for the syntax.
my $dir = shift;
my $dt_ref = shift;
# End of stream?
return if ! @{ $dt_ref } ||
!defined $dt_ref->[0] || !length $dt_ref->[0];
my %ci;
# Header line.
while (my $line = shift @{ $dt_ref }) {
return if $line !~ m/^(.+) ($sha1_pattern)/;
my $sha1 = $2;
$ci{'sha1'} = $sha1;
last;
}
# Identification lines for the commit.
while (my $line = shift @{ $dt_ref }) {
# Regexps are semi-stolen from gitweb.cgi.
if ($line =~ m/^tree ([0-9a-fA-F]{40})$/) {
$ci{'tree'} = $1;
}
elsif ($line =~ m/^parent ([0-9a-fA-F]{40})$/) {
# XXX: collecting in reverse order
push @{ $ci{'parents'} }, $1;
}
elsif ($line =~ m/^(author|committer) (.*) ([0-9]+) (.*)$/) {
my ($who, $name, $epoch, $tz) =
($1, $2, $3, $4 );
$ci{ $who } = $name;
$ci{ "${who}_epoch" } = $epoch;
$ci{ "${who}_tz" } = $tz;
if ($name =~ m/^([^<]+)\s+<([^@>]+)/) {
$ci{"${who}_name"} = $1;
$ci{"${who}_username"} = $2;
}
elsif ($name =~ m/^([^<]+)\s+<>$/) {
$ci{"${who}_username"} = $1;
}
else {
$ci{"${who}_username"} = $name;
}
}
elsif ($line =~ m/^$/) {
# Trailing empty line signals next section.
last;
}
}
debug("No 'tree' seen in diff-tree output") if !defined $ci{'tree'};
if (defined $ci{'parents'}) {
$ci{'parent'} = @{ $ci{'parents'} }[0];
}
else {
$ci{'parent'} = 0 x 40;
}
# Commit message (optional).
while ($dt_ref->[0] =~ /^ /) {
my $line = shift @{ $dt_ref };
$line =~ s/^ //;
push @{ $ci{'comment'} }, $line;
}
shift @{ $dt_ref } if $dt_ref->[0] =~ /^$/;
$ci{details} = [parse_changed_files($dir, $dt_ref)];
return \%ci;
}
sub parse_changed_files ($$) {
my $dir = shift;
my $dt_ref = shift;
my @files;
# Modified files.
while (my $line = shift @{ $dt_ref }) {
if ($line =~ m{^
(:+) # number of parents
([^\t]+)\t # modes, sha1, status
(.*) # file names
$}xo) {
my $num_parents = length $1;
my @tmp = split(" ", $2);
my ($file, $file_to) = split("\t", $3);
my @mode_from = splice(@tmp, 0, $num_parents);
my $mode_to = shift(@tmp);
my @sha1_from = splice(@tmp, 0, $num_parents);
my $sha1_to = shift(@tmp);
my $status = shift(@tmp);
if (length $file) {
push @files, {
'file' => decode_git_file($dir, $file),
'sha1_from' => $sha1_from[0],
'sha1_to' => $sha1_to,
'mode_from' => $mode_from[0],
'mode_to' => $mode_to,
'status' => $status,
};
}
next;
};
last;
}
return @files;
}
sub git_commit_info ($$;$) {
# Return an array of commit info hashes of num commits
# starting from the given sha1sum.
my ($dir, $sha1, $num) = @_;
my @opts;
push @opts, "--max-count=$num" if defined $num;
my @raw_lines = run_or_die_in($dir, 'git', 'log', @opts,
'--pretty=raw', '--raw', '--abbrev=40', '--always', '-c',
'-r', $sha1, '--no-renames', '--', '.');
my @ci;
while (my $parsed = parse_diff_tree($dir, \@raw_lines)) {
push @ci, $parsed;
}
warn "Cannot parse commit info for '$sha1' commit" if !@ci;
return wantarray ? @ci : $ci[0];
}
sub rcs_find_changes ($) {
my $oldrev=shift;
# Note that git log will sometimes show files being added that
# don't exist. Particularly, git merge -s ours can result in a
# merge commit where some files were not really added.
# This is why the code below verifies that the files really
# exist.
my @raw_lines = run_or_die_in($config{srcdir}, 'git', 'log',
'--pretty=raw', '--raw', '--abbrev=40', '--always', '-c',
'--no-renames', , '--reverse',
'-r', "$oldrev..HEAD", '--', '.');
# Due to --reverse, we see changes in chronological order.
my %changed;
my %deleted;
my $nullsha = 0 x 40;
my $newrev=$oldrev;
while (my $ci = parse_diff_tree($config{srcdir}, \@raw_lines)) {
$newrev=$ci->{sha1};
foreach my $i (@{$ci->{details}}) {
my $file=$i->{file};
if ($i->{sha1_to} eq $nullsha) {
if (! -e "$config{srcdir}/$file") {
delete $changed{$file};
$deleted{$file}=1;
}
}
else {
if (-e "$config{srcdir}/$file") {
delete $deleted{$file};
$changed{$file}=1;
}
}
}
}
return (\%changed, \%deleted, $newrev);
}
sub git_sha1_file ($$) {
my $dir=shift;
my $file=shift;
return git_sha1($dir, $file);
}
sub git_sha1 ($@) {
my $dir = shift;
# Ignore error since a non-existing file might be given.
my ($sha1) = run_or_non_in($dir, 'git', 'rev-list', '--max-count=1', 'HEAD',
'--', @_);
if (defined $sha1) {
($sha1) = $sha1 =~ m/($sha1_pattern)/; # sha1 is untainted now
}
return defined $sha1 ? $sha1 : '';
}
sub rcs_get_current_rev () {
return git_sha1($config{srcdir});
}
sub rcs_update () {
# Update working directory.
ensure_committer($config{srcdir});
if (length $config{gitorigin_branch}) {
run_or_cry_in($config{srcdir}, 'git', 'pull', '--prune', $config{gitorigin_branch});
}
}
sub rcs_prepedit ($) {
# Return the commit sha1sum of the file when editing begins.
# This will be later used in rcs_commit if a merge is required.
my ($file) = @_;
return git_sha1_file($config{srcdir}, $file);
}
sub rcs_commit (@) {
# Try to commit the page; returns undef on _success_ and
# a version of the page with the rcs's conflict markers on
# failure.
my %params=@_;
# Check to see if the page has been changed by someone else since
# rcs_prepedit was called.
my $cur = git_sha1_file($config{srcdir}, $params{file});
my $prev;
if (defined $params{token}) {
($prev) = $params{token} =~ /^($sha1_pattern)$/; # untaint
}
if (defined $cur && defined $prev && $cur ne $prev) {
my $conflict = merge_past($prev, $params{file}, $dummy_commit_msg);
return $conflict if defined $conflict;
}
return rcs_commit_helper(@_);
}
sub rcs_commit_staged (@) {
# Commits all staged changes. Changes can be staged using rcs_add,
# rcs_remove, and rcs_rename.
return rcs_commit_helper(@_);
}
sub rcs_commit_helper (@) {
my %params=@_;
my %env=%ENV;
if (defined $params{session}) {
# Set the commit author and email based on web session info.
my $u;
if (defined $params{session}->param("name")) {
$u=$params{session}->param("name");
}
elsif (defined $params{session}->remote_addr()) {
$u=$params{session}->remote_addr();
}
if (length $u) {
$u=encode_utf8($u);
$ENV{GIT_AUTHOR_NAME}=$u;
}
else {
$u = 'anonymous';
}
if (defined $params{session}->param("nickname")) {
$u=encode_utf8($params{session}->param("nickname"));
$u=~s/\s+/_/g;
$u=~s/[^-_0-9[:alnum:]]+//g;
}
if (length $u) {
$ENV{GIT_AUTHOR_EMAIL}="$u\@web";
}
else {
$ENV{GIT_AUTHOR_EMAIL}='anonymous@web';
}
}
ensure_committer($config{srcdir});
$params{message} = IkiWiki::possibly_foolish_untaint($params{message});
my @opts;
if ($params{message} !~ /\S/) {
# Force git to allow empty commit messages.
# (If this version of git supports it.)
my ($version)=`git --version` =~ /git version (.*)/;
if ($version ge "1.7.8") {
push @opts, "--allow-empty-message", "--no-edit";
}
if ($version ge "1.7.2") {
push @opts, "--allow-empty-message";
}
elsif ($version ge "1.5.4") {
push @opts, '--cleanup=verbatim';
}
else {
$params{message}.=".";
}
}
if (exists $params{file}) {
push @opts, '--', $params{file};
}
# git commit returns non-zero if nothing really changed.
# So we should ignore its exit status (hence run_or_non_in).
if (run_or_non_in($config{srcdir}, 'git', 'commit', '-m', $params{message}, '-q', @opts)) {
if (length $config{gitorigin_branch}) {
run_or_cry_in($config{srcdir}, 'git', 'push', $config{gitorigin_branch}, $config{gitmaster_branch});
}
}
%ENV=%env;
return undef; # success
}
sub rcs_add ($) {
# Add file to archive.
my ($file) = @_;
ensure_committer($config{srcdir});
run_or_cry_in($config{srcdir}, 'git', 'add', '--', $file);
}
sub rcs_remove ($) {
# Remove file from archive.
my ($file) = @_;
ensure_committer($config{srcdir});
run_or_cry_in($config{srcdir}, 'git', 'rm', '-f', '--', $file);
}
sub rcs_rename ($$) {
my ($src, $dest) = @_;
ensure_committer($config{srcdir});
run_or_cry_in($config{srcdir}, 'git', 'mv', '-f', '--', $src, $dest);
}
sub rcs_recentchanges ($) {
# List of recent changes.
my ($num) = @_;
eval q{use Date::Parse};
error($@) if $@;
my @rets;
foreach my $ci (git_commit_info($config{srcdir}, 'HEAD', $num || 1)) {
# Skip redundant commits.
next if ($ci->{'comment'} && @{$ci->{'comment'}}[0] eq $dummy_commit_msg);
my ($sha1, $when) = (
$ci->{'sha1'},
$ci->{'author_epoch'}
);
my @pages;
foreach my $detail (@{ $ci->{'details'} }) {
my $file = $detail->{'file'};
my $efile = join('/',
map { uri_escape_utf8($_) } split('/', $file)
);
my $diffurl = defined $config{'diffurl'} ? $config{'diffurl'} : "";
$diffurl =~ s/\[\[file\]\]/$efile/go;
$diffurl =~ s/\[\[sha1_parent\]\]/$ci->{'parent'}/go;
$diffurl =~ s/\[\[sha1_from\]\]/$detail->{'sha1_from'}/go;
$diffurl =~ s/\[\[sha1_to\]\]/$detail->{'sha1_to'}/go;
$diffurl =~ s/\[\[sha1_commit\]\]/$sha1/go;
push @pages, {
page => pagename($file),
diffurl => $diffurl,
};
}
my @messages;
my $pastblank=0;
foreach my $line (@{$ci->{'comment'}}) {
$pastblank=1 if $line eq '';
next if $pastblank && $line=~m/^ *(signed[ \-]off[ \-]by[ :]|acked[ \-]by[ :]|cc[ :])/i;
push @messages, { line => $line };
}
my $user=$ci->{'author_username'};
my $web_commit = ($ci->{'author'} =~ /\@web>/);
my $nickname;
# Set nickname only if a non-url author_username is available,
# and author_name is an url.
if ($user !~ /:\/\// && defined $ci->{'author_name'} &&
$ci->{'author_name'} =~ /:\/\//) {
$nickname=$user;
$user=$ci->{'author_name'};
}
# compatability code for old web commit messages
if (! $web_commit &&
defined $messages[0] &&
$messages[0]->{line} =~ m/$config{web_commit_regexp}/) {
$user = defined $2 ? "$2" : "$3";
$messages[0]->{line} = $4;
$web_commit=1;
}
push @rets, {
rev => $sha1,
user => $user,
nickname => $nickname,
committype => $web_commit ? "web" : "git",
when => $when,
message => [@messages],
pages => [@pages],
} if @pages;
last if @rets >= $num;
}
return @rets;
}
sub rcs_diff ($;$) {
my $rev=shift;
my $maxlines=shift;
my ($sha1) = $rev =~ /^($sha1_pattern)$/; # untaint
my @lines;
my $addlines=sub {
my $line=shift;
return if defined $maxlines && @lines == $maxlines;
push @lines, $line."\n"
if (@lines || $line=~/^diff --git/);
return 1;
};
safe_git(
chdir => $config{srcdir},
error_handler => undef,
data_handler => $addlines,
cmdline => ["git", "show", $sha1],
);
if (wantarray) {
return @lines;
}
else {
return join("", @lines);
}
}
{
my %time_cache;
sub findtimes ($$) {
my $file=shift;
my $id=shift; # 0 = mtime ; 1 = ctime
if (! keys %time_cache) {
my $date;
foreach my $line (run_or_die_in($config{srcdir}, 'git', 'log',
'--pretty=format:%at',
'--name-only', '--relative')) {
if (! defined $date && $line =~ /^(\d+)$/) {
$date=$line;
}
elsif (! length $line) {
$date=undef;
}
else {
my $f=decode_git_file($config{srcdir}, $line);
if (! $time_cache{$f}) {
$time_cache{$f}[0]=$date; # mtime
}
$time_cache{$f}[1]=$date; # ctime
}
}
}
return exists $time_cache{$file} ? $time_cache{$file}[$id] : 0;
}
}
sub rcs_getctime ($) {
my $file=shift;
return findtimes($file, 1);
}
sub rcs_getmtime ($) {
my $file=shift;
return findtimes($file, 0);
}
{
my $ret;
sub git_find_root {
# The wiki may not be the only thing in the git repo.
# Determine if it is in a subdirectory by examining the srcdir,
# and its parents, looking for the .git directory.
return @$ret if defined $ret;
my $subdir="";
my $dir=$config{srcdir};
while (! -d "$dir/.git") {
$subdir=IkiWiki::basename($dir)."/".$subdir;
$dir=IkiWiki::dirname($dir);
if (! length $dir) {
error("cannot determine root of git repo");
}
}
$ret=[$subdir, $dir];
return @$ret;
}
}
sub git_parse_changes ($$@) {
my $dir = shift;
my $reverted = shift;
my @changes = @_;
my ($subdir, $rootdir) = git_find_root();
my @rets;
foreach my $ci (@changes) {
foreach my $detail (@{ $ci->{'details'} }) {
my $file = $detail->{'file'};
# check that all changed files are in the subdir
if (length $subdir &&
! ($file =~ s/^\Q$subdir\E//)) {
error sprintf(gettext("you are not allowed to change %s"), $file);
}
my ($action, $mode, $path);
if ($detail->{'status'} =~ /^[M]+\d*$/) {
$action="change";
$mode=$detail->{'mode_to'};
}
elsif ($detail->{'status'} =~ /^[AM]+\d*$/) {
$action= $reverted ? "remove" : "add";
$mode=$detail->{'mode_to'};
}
elsif ($detail->{'status'} =~ /^[DAM]+\d*/) {
$action= $reverted ? "add" : "remove";
$mode=$detail->{'mode_from'};
}
else {
error "unknown status ".$detail->{'status'};
}
# test that the file mode is ok
if ($mode !~ /^100[64][64][64]$/) {
error sprintf(gettext("you cannot act on a file with mode %s"), $mode);
}
if ($action eq "change") {
if ($detail->{'mode_from'} ne $detail->{'mode_to'}) {
error gettext("you are not allowed to change file modes");
}
}
# extract attachment to temp file
if (($action eq 'add' || $action eq 'change') &&
! pagetype($file)) {
eval q{use File::Temp};
die $@ if $@;
my $fh;
($fh, $path)=File::Temp::tempfile(undef, UNLINK => 1);
safe_git(
chdir => $dir,
error_handler => sub { error("failed writing temp file '$path': ".shift."."); },
stdout => $fh,
cmdline => ['git', 'show', $detail->{sha1_to}],
);
}
push @rets, {
file => $file,
action => $action,
path => $path,
};
}
}
return @rets;
}
sub rcs_receive () {
my @rets;
while (<>) {
chomp;
my ($oldrev, $newrev, $refname) = split(' ', $_, 3);
# only allow changes to gitmaster_branch
if ($refname !~ /^refs\/heads\/\Q$config{gitmaster_branch}\E$/) {
error sprintf(gettext("you are not allowed to change %s"), $refname);
}
# Avoid chdir when running git here, because the changes
# are in the master git repo, not the srcdir repo.
# (Also, if a subdir is involved, we don't want to chdir to
# it and only see changes in it.)
# The pre-receive hook already puts us in the right place.
push @rets, git_parse_changes('.', 0, git_commit_info('.', $oldrev."..".$newrev));
}
return reverse @rets;
}
sub rcs_preprevert ($) {
my $rev=shift;
my ($sha1) = $rev =~ /^($sha1_pattern)$/; # untaint
my @undo; # undo stack for cleanup in case of an error
# Examine changes from root of git repo, not from any subdir,
# in order to see all changes.
my ($subdir, $rootdir) = git_find_root();
ensure_committer($rootdir);
# preserve indentation of previous in_git_dir code for now
do {
my @commits=git_commit_info($rootdir, $sha1, 1);
if (! @commits) {
error "unknown commit"; # just in case
}
# git revert will fail on merge commits. Add a nice message.
if (exists $commits[0]->{parents} &&
@{$commits[0]->{parents}} > 1) {
error gettext("you are not allowed to revert a merge");
}
# Due to the presence of rename-detection, we cannot actually
# see what will happen in a revert without trying it.
# But we can guess, which is enough to rule out most changes
# that we won't allow reverting.
git_parse_changes($rootdir, 1, @commits);
my $failure;
my @ret;
eval {
my $branch = "ikiwiki_revert_${sha1}"; # supposed to be unique
push @undo, sub {
run_or_cry_in($rootdir, 'git', 'branch', '-D', $branch) if $failure;
};
if (run_or_non_in($rootdir, 'git', 'rev-parse', '--quiet', '--verify', $branch)) {
run_or_non_in($rootdir, 'git', 'branch', '-D', $branch);
}
run_or_die_in($rootdir, 'git', 'branch', $branch, $config{gitmaster_branch});
my $working = create_temp_working_dir($rootdir, $branch);
push @undo, sub {
remove_tree($working);
};
run_or_die_in($working, 'git', 'checkout', '--quiet', '--force', $branch);
run_or_die_in($working, 'git', 'revert', '--no-commit', $sha1);
run_or_die_in($working, 'git', 'commit', '-m', "revert $sha1", '-a');
my @raw_lines;
@raw_lines = run_or_die_in($rootdir, 'git', 'diff', '--pretty=raw',
'--raw', '--abbrev=40', '--always', '--no-renames',
"..${branch}");
my $ci = {
details => [parse_changed_files($rootdir, \@raw_lines)],
};
@ret = git_parse_changes($rootdir, 0, $ci);
};
$failure = $@;
# Process undo stack (in reverse order). By policy cleanup
# actions should normally print a warning on failure.
while (my $handle = pop @undo) {
$handle->();
}
if ($failure) {
my $message = sprintf(gettext("Failed to revert commit %s"), $sha1);
error("$message\n$failure\n");
}
return @ret;
};
}
sub rcs_revert ($) {
# Try to revert the given rev; returns undef on _success_.
my $rev = shift;
my ($sha1) = $rev =~ /^($sha1_pattern)$/; # untaint
ensure_committer($config{srcdir});
if (run_or_non_in($config{srcdir}, 'git', 'cherry-pick', '--no-commit', "ikiwiki_revert_$sha1")) {
return undef;
}
else {
run_or_non_in($config{srcdir}, 'git', 'branch', '-D', "ikiwiki_revert_$sha1");
return sprintf(gettext("Failed to revert commit %s"), $sha1);
}
}
1
|