/usr/share/perl5/FCM/System/CM/SVN.pm is in fcm 2016.12.0-1.
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 | #-------------------------------------------------------------------------------
# (C) British Crown Copyright 2006-16 Met Office.
#
# This file is part of FCM, tools for managing and building source code.
#
# FCM is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# FCM is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with FCM. If not, see <http://www.gnu.org/licenses/>.
#-------------------------------------------------------------------------------
use strict;
use warnings;
#-------------------------------------------------------------------------------
package FCM::System::CM::SVN;
use base qw{FCM::Class::CODE};
use Cwd qw{cwd};
use FCM::Context::Event;
use FCM::Context::Locator;
use FCM::System::Exception;
use Memoize qw{memoize};
use File::Basename qw{dirname};
use File::Spec::Functions qw{catfile rel2abs};
use Time::Piece;
use XML::Parser;
my $E = 'FCM::System::Exception';
# Settings for the default repository layout
our %LAYOUT_CONFIG = (
'depth-project' => undef,
'depth-branch' => 3,
'depth-tag' => 1,
'dir-trunk' => 'trunk',
'dir-branch' => 'branches',
'dir-tag' => 'tags',
'level-owner-branch' => 2,
'level-owner-tag' => undef,
'owner' => undef,
'template-branch' => '{category}/{owner}/{name_prefix}{name}',
'template-tag' => undef,
);
# Layout configuration file basename
our $LAYOUT_CFG_BASE = 'svn-repos-layout.cfg';
# "svn log --xml" handlers.
# -> element node start tag handlers
my %SVN_LOG_ELEMENT_START_HANDLER_FOR = (
# tag => handler
'logentry' => \&_get_log_handle_element_enter_logentry,
'path' => \&_get_log_handle_element_enter_path,
);
# -> text node (after a start tag) handlers
my %SVN_LOG_TEXT_HANDLER_FOR = (
# tag => handler
'date' => \&_get_log_handle_text_date,
'path' => \&_get_log_handle_text_path,
);
our $SUBVERSION_SERVERS_CONF = catfile((getpwuid($<))[7], qw{.subversion/servers});
my %ACTION_OF = (
'call' => \&_call,
'get_info' => \&_get_info,
'get_layout' => \&_get_layout,
'get_layout_common' => \&_get_layout_common,
'get_list' => \&_get_list,
'get_log' => \&_get_log,
'get_username' => \&_get_username,
'get_wc_root' => \&_get_wc_root,
'load_layout_config' => \&_load_layout_config,
'split_by_peg' => \&_split_by_peg,
'stdout' => \&_stdout,
);
# Creates the class.
__PACKAGE__->class(
{ layout_cfg_base => {isa => '$', default => $LAYOUT_CFG_BASE},
layout_config_of=> '%',
util => '&',
},
{action_of => \%ACTION_OF},
);
# Calls "svn".
sub _call {
my ($attrib_ref, @args) = @_;
my @command = ('svn', @args);
my $timer = $attrib_ref->{util}->timer();
my $rc = system(@command);
$attrib_ref->{util}->event(
FCM::Context::Event->SHELL, \@command, $rc, $timer->());
if ($rc) {
$rc = $? == -1 ? $!
: $? & 127 ? $? & 127
: $? >> 8
;
return $E->throw($E->SHELL, {command_list => \@command, rc => $rc});
}
return;
}
# Invokes "svn info --xml @paths", and returns a LIST of info entries.
memoize('_get_info');
sub _get_info {
my $attrib_ref = shift();
my %option = ('recursive' => undef, 'revision' => undef);
if (@_ && ref($_[0]) && ref($_[0]) eq 'HASH') {
%option = (%option, %{shift()});
}
my @paths = @_;
if (!@paths) {
@paths = (q{.});
}
my (@entries, @stack);
my $parser = XML::Parser->new(Handlers => {
'Start' => sub {_get_info_handle_element_enter(\@entries, \@stack, @_)},
'End' => sub {_get_info_handle_element_leave(\@entries, \@stack, @_)},
'Char' => sub {_get_info_handle_text( \@entries, \@stack, @_)},
});
$parser->parse(scalar(_stdout(
$attrib_ref,
qw{svn info --xml},
($option{'recursive'} ? '--recursive' : ()),
($option{'revision'} ? ('--revision', $option{'revision'}) : ()),
@paths,
)));
\@entries;
}
# Helper for _get_info. Handle the start tag of an XML element.
sub _get_info_handle_element_enter {
my ($entries_ref, $stack_ref, $expat, $tag, %attrib) = @_;
# "entry": create a new entry in the list
if ($tag eq 'entry') {
push(@{$entries_ref}, {});
}
# "tree-conflict:version": need to handle differently
if ( $tag eq 'version'
&& @{$stack_ref}
&& $stack_ref->[-1] eq 'tree-conflict'
) {
my (undef, undef, @names) = @{$stack_ref};
push(@names, delete($attrib{side}));
while (my ($key, $value) = each(%attrib)) {
my $name = join(':', @names, $key);
$entries_ref->[-1]->{$name} = delete($attrib{$key});
}
}
# Add current tag to stack
push(@{$stack_ref}, $tag);
# Add attributes to current entry, if appropriate
if (@{$entries_ref} && @{$stack_ref} >= 2 && %attrib) {
my (undef, undef, @names) = @{$stack_ref};
while (my ($key, $value) = each(%attrib)) {
my $name = join(':', @names, $key);
$entries_ref->[-1]->{$name} = $value;
}
}
}
# Helper for _get_info. Handle the end tag of an XML element.
sub _get_info_handle_element_leave {
my ($entries_ref, $stack_ref, $expat, $tag) = @_;
pop(@{$stack_ref}) eq $tag;
}
# Helper for _get_info. Handle an XML text node.
sub _get_info_handle_text {
my ($entries_ref, $stack_ref, $expat, $text) = @_;
if (@{$stack_ref} <= 2 || !@{$entries_ref} || $text eq "\n") {
return;
}
my (undef, undef, @names) = @{$stack_ref};
my $name = join(':', @names);
$entries_ref->[-1]->{$name} .= $text;
}
# Return an object containing the repository layout information of a URL.
sub _get_layout {
my ($attrib_ref, $url_arg) = @_;
my %info = %{_get_info($attrib_ref, $url_arg)->[0]};
my ($url, $root, $peg_rev) = @info{'url', 'repository:root', 'revision'};
my $path = substr($url, length($root));
my $layout = _get_layout_common($attrib_ref, $root, $peg_rev, $path);
$layout->set_url($root . $path . '@' . $peg_rev);
$layout->set_username(_get_username($attrib_ref, $root));
$layout;
}
# Return an object containing the repository layout information of a URL.
sub _get_layout_common {
my ($attrib_ref, $root, $rev, $path, $is_local) = @_;
my %layout_config = _load_layout_config(
$attrib_ref, ($is_local ? 'file://' . $root : $root),
);
my ($project, $branch, $category, $owner, $sub_tree);
my @names = split(qr{/+}msx, $path);
shift(@names); # element 1 should be an empty string
# Search for the project
my $depth = $layout_config{'depth-project'};
if (defined($depth)) {
if (@names >= $depth) {
my @project_names = ();
for (1 .. $layout_config{'depth-project'}) {
push(@project_names, shift(@names));
}
$project = join('/', @project_names);
}
}
elsif (!grep {!defined($layout_config{"dir-$_"})} qw{trunk branch tag}) {
# trunk, branches and tags are ALL in specific sub-directories under
# the project
my @dirs = map {$layout_config{"dir-$_"}} qw{trunk branch tag};
my @head = ();
my @tail = @names;
while (my $name = shift(@tail)) {
if (grep {$_ eq $name} @dirs) {
$project = join('/', @head);
@names = ($name, @tail);
last;
}
push(@head, $name);
}
if (!defined($project)) {
# $path does not contain the specific sub-directories that
# contain the trunk, branches and tags, but $path itself may be
# the project
my $target = $path . '/' . $layout_config{'dir-trunk'};
if (_verify_path($attrib_ref, $root, $rev, $target, $is_local)) {
$project = join('/', @names);
}
@names = ();
}
}
else {
# Can only assume that trunk is in a specific sub-directory under the
# project
my @head = ();
my @tail = @names;
while (my $name = shift(@tail)) {
if ($name eq $layout_config{'dir-trunk'}) {
$project = join('/', @head);
@names = ($name, @tail);
last;
}
push(@head, $name);
}
if (!defined($project)) {
# $path does not contain the trunk sub-directory, need to search
# for it
my @head = ();
my @tail = @names;
while (@head <= @names) {
my $target = join('/', @head, $layout_config{'dir-trunk'});
if (_verify_path($attrib_ref, $root, $rev, $target, $is_local)) {
$project = join('/', @head);
@names = @tail;
last;
}
push(@head, shift(@tail));
}
}
}
# Search for the branch
if (defined($project) && @names) {
KEY:
for my $key (qw{trunk branch tag}) {
my @branch_names;
if ($layout_config{"dir-$key"}) {
if ($names[0] eq $layout_config{"dir-$key"}) {
@branch_names = (shift(@names));
}
else {
next KEY;
}
}
my $depth = $layout_config{"depth-$key"}
? $layout_config{"depth-$key"} : 0;
if (@names >= $depth) {
for my $i (1 .. $depth) {
my $name = shift(@names);
push(@branch_names, $name);
if ( $layout_config{"level-owner-$key"}
&& $layout_config{"level-owner-$key"} == $i
) {
$owner = $name;
}
}
$branch = join('/', @branch_names);
$category = $key;
}
last KEY;
}
}
# Remainder is the sub-tree under the branch
if (defined($branch)) {
$sub_tree = join('/', @names);
}
FCM::System::CM::SVN::Layout->new({
config => \%layout_config,
root => $root,
path => $path,
peg_rev => $rev,
project => $project,
branch => $branch,
branch_category => $category,
branch_owner => $owner,
sub_tree => $sub_tree,
});
}
# Return a (filtered) recursive listing of $url_arg.
sub _get_list {
my ($attrib_ref, $url_arg, $filter_func) = @_;
my @list;
my ($url0, $rev) = _split_by_peg($attrib_ref, $url_arg);
my @items = ([$url0, 0]);
while (my $item = shift(@items)) {
my ($url, $depth) = @{$item};
++$depth;
my @lines = _stdout($attrib_ref, qw{svn list}, $url . '@' . $rev);
for my $line (@lines) {
my ($this_name, $is_dir) = $line =~ qr{\A(.*?)(/?)\z};
my $this_url = $url . '/' . $this_name ;
my ($can_return, $can_recurse) = (1, $is_dir);
if (defined($filter_func)) {
($can_return, $can_recurse)
= $filter_func->($this_url, $this_name, $is_dir, $depth);
}
if ($can_return) {
push(@list, $this_url . '@' . $rev);
}
if ($can_recurse && $is_dir) {
push(@items, [$this_url, $depth]);
}
}
}
@list;
}
# Invokes "svn log --xml".
sub _get_log {
my $attrib_ref = shift();
my %option = ('revision' => undef, 'stop-on-copy' => undef);
if (@_ && ref($_[0]) && ref($_[0]) eq 'HASH') {
%option = (%option, %{shift()});
}
my @paths = @_;
if (!@paths) {
@paths = (q{.});
}
my (@entries, @stack);
my $parser = XML::Parser->new(Handlers => {
'Start' => sub {_get_log_handle_element_enter(\@entries, \@stack, @_)},
'End' => sub {_get_log_handle_element_leave(\@entries, \@stack, @_)},
'Char' => sub {_get_log_handle_text( \@entries, \@stack, @_)},
});
$parser->parse(scalar(_stdout(
$attrib_ref,
qw{svn log --xml -v},
($option{'revision'} ? ('--revision', $option{'revision'}) : ()),
($option{'stop-on-copy'} ? ('--stop-on-copy') : ()),
@paths,
)));
\@entries;
}
# Helper for "_get_log", handle beginning of an XML element.
sub _get_log_handle_element_enter {
my ($entries_ref, $stack_ref, $expat, $tag, %attrib) = @_;
push(@{$stack_ref}, $tag);
if (exists($SVN_LOG_ELEMENT_START_HANDLER_FOR{$tag})) {
$SVN_LOG_ELEMENT_START_HANDLER_FOR{$tag}->(
$entries_ref,
$tag,
%attrib,
);
}
}
# Helper for "_get_log", handle beginning of the "logentry" element.
sub _get_log_handle_element_enter_logentry {
my ($entries_ref, $tag, %attrib) = @_;
push(
@{$entries_ref},
{ 'author' => q{},
'date' => q{},
'msg' => q{},
'paths' => [],
'revision' => $attrib{'revision'},
},
);
}
# Helper for "_get_log", handle beginning of the "path" element.
sub _get_log_handle_element_enter_path {
my ($entries_ref, $tag, %attrib) = @_;
push(@{$entries_ref->[-1]->{'paths'}}, {%attrib, 'path' => q{}});
}
# Helper for "_get_log", handle end of an element.
sub _get_log_handle_element_leave {
my ($entries_ref, $stack_ref, $expat, $tag) = @_;
pop(@{$stack_ref}) eq $tag;
}
# Helper for "_get_log", handle text node.
sub _get_log_handle_text {
my ($entries_ref, $stack_ref, $expat, $text) = @_;
if (!exists($stack_ref->[-1])) {
return;
}
if (exists($SVN_LOG_TEXT_HANDLER_FOR{$stack_ref->[-1]})) {
$SVN_LOG_TEXT_HANDLER_FOR{$stack_ref->[-1]}->($entries_ref, $text);
}
elsif ( @{$entries_ref}
&& exists($entries_ref->[-1]->{$stack_ref->[-1]})
&& !ref($entries_ref->[-1]->{$stack_ref->[-1]})
) {
$entries_ref->[-1]->{$stack_ref->[-1]} .= $text;
}
}
# Helper for "_get_log", handle text node in a "date" element.
sub _get_log_handle_text_date {
my ($entries_ref, $text) = @_;
# "svn log --xml" may return a date with trailing spaces!
$text =~ s{\s+\z}{}gmsx;
my $head = Time::Piece->strptime(substr($text, 0, -8), '%Y-%m-%dT%H:%M:%S');
my $tail = substr($text, -8, -1);
$entries_ref->[-1]->{'date'} = $head->epoch() + $tail;
}
# Helper for "_get_log", handle text node in a "path" element.
sub _get_log_handle_text_path {
my ($entries_ref, $text) = @_;
$entries_ref->[-1]->{'paths'}->[-1]->{'path'} .= $text;
}
# Return the username of the host of a given target URL.
memoize('_get_username');
sub _get_username {
my ($attrib_ref, $target) = @_;
my ($scheme, $sps) = $attrib_ref->{util}->uri_match($target);
my ($host) = $sps =~ qr{\A//([^/]+)(?:/|\z)}msx;
# Note: can use Config::IniFiles, but best to avoid another dependency.
# Note: not very efficient logic here, but should not yet matter.
my $subversion_servers_conf = exists($ENV{'FCM_SUBVERSION_SERVERS_CONF'})
? $ENV{'FCM_SUBVERSION_SERVERS_CONF'} : $SUBVERSION_SERVERS_CONF;
my $handle
= $attrib_ref->{'util'}->file_load_handle($subversion_servers_conf);
my $is_in_section;
my $group;
LINE:
while (my $line = readline($handle)) {
chomp($line);
if ($line =~ qr{\A\s*(?:[#;]|\z)}msx) {
next LINE;
}
if ($line =~ qr{\A\s*\[\s*groups\s*\]\s*\z}msx) {
$is_in_section = 1;
}
elsif ($line =~ qr{\A\s*\[}msx) {
$is_in_section = 0;
}
elsif ($is_in_section) {
my ($lhs, $rhs) = $line =~ qr{\A\s*(\S+)\s*=\s*(\S+)\s*\z}msx;
if ($rhs) {
$rhs =~ s{[.]}{\\.}gmsx;
$rhs =~ s{[*]}{.*}gmsx;
$rhs =~ s{[?]}{.?}gmsx;
if ($host && $host =~ qr{\A$rhs\z}msx) {
$group = $lhs;
last LINE;
}
}
}
}
my $username = scalar(getpwuid($<)); # current user ID
if ($group) {
seek($handle, 0, 0);
LINE:
while (my $line = readline($handle)) {
chomp($line);
if ($line =~ qr{\A\s*(?:[#;]|\z)}msx) {
next LINE;
}
if ($line =~ qr{\A\s*\[\s*$group\s*\]\s*\z}msx) {
$is_in_section = 1;
}
elsif ($line =~ qr{\A\s*\[}msx) {
$is_in_section = 0;
}
elsif ($is_in_section) {
my ($rhs) = $line =~ qr{\A\s*username\s*=\s*(\S+)\s*\z}msx;
if ($rhs) {
$username = $rhs;
last LINE;
}
}
}
}
close($handle);
return $username;
}
# Return path to the root working copy directory of the argument.
sub _get_wc_root {
my ($attrib_ref, $path) = @_;
$path ||= cwd();
my ($entries_ref) = _get_info($attrib_ref, $path);
if ( defined($entries_ref)
&& @{$entries_ref}
&& exists($entries_ref->[0]->{'wc-info:wcroot-abspath'})
) {
return $entries_ref->[0]->{'wc-info:wcroot-abspath'};
}
if (-f $path) {
$path = dirname($path);
}
$path = rel2abs($path);
my $return;
if (-e catfile($path, qw{.svn entries})) {
while ( -e catfile($path, qw{.svn entries})
&& $path ne dirname($path)
) {
$return = $path;
$path = dirname($path);
}
}
else {
while ( !-e catfile($path, qw{.svn entries})
&& $path ne dirname($path)
) {
$path = dirname($path);
$return = $path;
}
}
return $return;
}
# Load layout related configuration for a given URL root.
memoize('_load_layout_config');
sub _load_layout_config {
my ($attrib_ref, $root) = @_;
if (exists($attrib_ref->{layout_config_of}{$root})) {
return %{$attrib_ref->{layout_config_of}{$root}};
}
my %site_layout_config;
if (exists($attrib_ref->{layout_config_of}{q{}})) {
%site_layout_config = %{$attrib_ref->{layout_config_of}{q{}}};
}
else {
%site_layout_config = %LAYOUT_CONFIG;
$attrib_ref->{util}->cfg_init(
$attrib_ref->{layout_cfg_base},
sub {
my $config_reader = shift();
my @unknown_entries;
while (defined(my $entry = $config_reader->())) {
if (exists($site_layout_config{$entry->get_label()})) {
my $value
= $entry->get_value() ? $entry->get_value() : undef;
$site_layout_config{$entry->get_label()} = $value;
}
else {
push(@unknown_entries, $entry);
}
}
if (@unknown_entries) {
return $E->throw($E->CONFIG_UNKNOWN, \@unknown_entries);
}
},
);
$attrib_ref->{layout_config_of}{q{}} = {%site_layout_config};
}
$attrib_ref->{layout_config_of}{$root} = {%site_layout_config};
my @prop_lines = eval {
_stdout($attrib_ref, qw{svn propget fcm:layout}, $root);
};
if ($@) {
$@ = undef;
}
PROP_LINE:
while (defined(my $prop_line = shift(@prop_lines))) {
chomp($prop_line);
if ($prop_line =~ qr{\A\s*(?:\#|\z)}msx) { # comment line
next PROP_LINE;
}
($prop_line) = $prop_line =~ qr{\A\s*(.+?)\s*\z}msx; # trim
my ($key, $value) = split(qr{\s*=\s*}msx, $prop_line, 2);
if (exists($attrib_ref->{layout_config_of}{$root}{$key})) {
$attrib_ref->{layout_config_of}{$root}{$key} = $value;
}
}
%{$attrib_ref->{layout_config_of}{$root}};
}
# Splits a URL@REV by the @.
sub _split_by_peg {
my ($attrib_ref, $url) = @_;
$url =~ qr{\A(.*?)(?:@([^@/]+))?\z}msx;
}
# Calls "svn", return its standard output.
sub _stdout {
my ($attrib_ref, @command) = @_;
my %value_of = %{$attrib_ref->{util}->shell_simple(\@command)};
if ($value_of{rc}) {
return $E->throw(
$E->SHELL,
{command_list => \@command, %value_of},
$value_of{e}
);
}
wantarray() ? split("\n", $value_of{o}) : $value_of{o};
}
# Return true if $path is in $repos for this $rev
sub _verify_path {
my ($attrib_ref, $root, $rev, $path, $is_local) = @_;
if ($is_local) {
my $opt = $rev =~ qr{\A\d+\z}msx ? '-r' : '-t';
eval {
_stdout($attrib_ref, qw{svnlook tree -N}, $opt, $rev, $root, $path);
};
if ($@) {
$@ = q{};
return;
}
return ($root, $rev, $path);
}
else {
my $target = $root . '/' . $path . '@' . $rev;
my $url = eval {_get_info($attrib_ref, $target)->[0]->{url}};
if ($@ || !$url) {
$@ = q{};
return;
}
return ($root, $rev, $path);
}
}
#-------------------------------------------------------------------------------
# Represent the layout information of a Subversion URL.
package FCM::System::CM::SVN::Layout;
use base qw{FCM::Class::HASH};
__PACKAGE__->class({
config => '%',
url => '$',
root => '$',
path => '$',
peg_rev => '$',
project => '$',
branch => '$',
branch_category => '$',
branch_owner => '$',
sub_tree => '$',
username => {isa => '$', default => scalar(getpwuid($<))},
});
sub is_trunk {
$_[0]->{branch_category} && $_[0]->{branch_category} eq 'trunk';
}
sub is_branch {
$_[0]->{branch_category} && $_[0]->{branch_category} eq 'branch';
}
sub is_tag {
$_[0]->{branch_category} && $_[0]->{branch_category} eq 'tag';
}
sub is_owned_by_user {
my ($self, $user) = @_;
$user ||= $self->get_username();
$self->{branch_owner} && $self->{branch_owner} eq $user;
}
sub is_shared {
my ($self) = @_;
$self->{branch_owner}
&& grep {$_ eq $self->{branch_owner}} qw{Share Config Rel};
}
sub as_string {
my ($self) = @_;
my $return = q{};
for my $key (qw{
url
root
path
peg_rev
project
branch
branch_category
branch_owner
sub_tree
}) {
my $value = $self->{$key};
if ($key ne 'config' && defined($value)) {
$return .= "$key: $value\n";
}
}
return $return;
}
1;
__END__
=head1 NAME
FCM::System::CM::SVN
=head1 DESCRIPTION
Part of L<FCM::System::CM|FCM::System::CM>. Provides an interface for common SVN
functionalities used in the FCM CM sub-system.
=head1 METHODS
This is a sub-class of L<FCM::Class::CODE|FCM::Class::CODE>.
=over 4
=item $class->new(\%attrib)
Return a new instance of this class. %attrib accepts a single "util" key for an
instance of an L<FCM::Util|FCM::Util> object.
=item $instance->call(@args)
Call the command line "svn" with a list of arguments in @args.
=item $instance->get_info(@path)
=item $instance->get_info(\%option, @path)
Invokes "svn info --xml @paths", and returns a LIST of info entries. If @paths
is not specified, use ("."). If %option is specified, it may contain the keys:
=over 4
=item recursive
If value of this key is not undef, add --recursive to "svn info".
=item revision
If value of this key is not undef, add --revision VALUE to "svn info".
=back
Each info entry is a HASH with keys reflecting the tag or attribute name in an
entry element. The original hierarchy below the entry element is delimited by a
colon in the name. For example, a return structure may look like this:
[ { 'commit:author' => 'fred',
'commit:date' => '2011-11-09T15:41:14.514665Z',
'commit:revision' => '4549',
'kind' => 'dir',
'path' => 'trunk',
'revision' => '4552',
'repository:root' => 'svn://host/my-repos',
'repository:uuid' => '91f685bf-fbee-0310-99e6-f3aa9e660bd5'
'url' => 'svn://host/my-repos/FCM/trunk',
},
]
=item $instance->get_layout($url)
Return an instance of L<FCM::System::CM::SVN::Layout|/FCM::System::CM::SVN::Layout>
containing the repository layout information of $url.
=item $instance->get_layout_common($root, $rev, $path, $is_local)
Return an instance of L<FCM::System::CM::SVN::Layout|/FCM::System::CM::SVN::Layout>
containing the repository layout information for $path in $root at $rev. If
$is_local is true, use "svnlook" to verify the existence of $path in $root
at $rev. Otherwise, it uses "svn info" instead. If $rev is assumed to be a
transaction if it is not numeric.
=item $instance->get_list($url_arg, $filter_func)
Call "svn list" multiple times to obtain a recursive listing of files and
directories under $url_arg. Return a list containing the listing. If
$filter_func is defined, it should be a CODE reference, which would be invoked
for each file/directory found. It should have the interface:
($can_return, $can_recurse)
= $filter_func->($this_url, $this_name, $is_dir, $depth);
where $this_url is the URL of the file/directory found, $this_name is the
base name of the file/directory found, $is_dir is true if it is a directory,
$depth is the directory depth of $this_url relative to $url_arg.
The $filter_func CODE reference should return a 2-element list ($can_return,
$can_recurse). The get_list method will only return $this_url in the listing
if $can_return is set to true. If $is_dir is true and $can_recurse is true, the
get_list method will go down to do more listing in $this_url.
=item $instance->get_log(@path)
=item $instance->get_log(\%option, @path)
Invokes "svn log --xml". If @paths is not specified, use ("."). If %option is
specified, it may contain the keys:
=over 4
=item revision
If value of this key is not undef, add --revision VALUE to "svn log".
=item stop-on-copy
If value of this key is not undef, add --stop-on-copy to "svn log".
=back
Returns an ARRAY reference. Each element is a data structure that represents a
log entry. The data structure should look like:
[ { 'author' => $author,
'date' => $date, # seconds since epoch
'msg' => $msg,
'paths' => [
{ 'path' => $path,
'action' => $action,
'copyfrom-path' => $p,
'copyfrom-rev' => $r,
},
# ...
],
'revision' => $revision,
},
]
=item $instance->get_username($target)
Return the user name associated with $target.
=item $instance->get_wc_root($path)
Return the path to the root working copy directory of the argument.
=item $instance->load_layout_config($root)
Return a HASH (not a reference) containing the layout configuration of $root.
See %LAYOUT_CONFIG for default settings. $root should be the URL to a
repository root.
=item $instance->split_by_peg($location)
Split a location string (either a URL@PEG or a PATH@PEG) and return a
two-element list: either (URL, PEG) or (PATH, PEG).
=item $instance->stdout(@command)
Call a @command, capture and return the STDOUT on success. In scalar context,
return the STDOUT as-is. In array context, return it as a list of lines with the
new line characters removed.
=back
=head1 EXCEPTION
Methods in this class may throw an
L<FCM::System::Exception|FCM::System::Exception> on error.
=head1 FCM::System::CM::SVN::Layout
The FCM::System::CM::SVN::Layout class inherits from
L<FCM::Class::HASH|FCM::Class::HASH>. An instance represents the layout
information in a Subversion URL based on the default or specified FCM layout
information. It has the following attributes:
=over 4
=item config
is a HASH containing the layout configuration applied to this URL.
Valid keys and their default values are:
=over 4
=item depth-project => undef
Number of sub-directories used by the name of a project.
=item depth-branch => 3
Number of sub-directories (under "branches") used by the name of branch.
=item depth-tag => 1
Number of sub-directories (under "tags") used by the name of branch.
=item dir-trunk => 'trunk'
Name of the master/trunk directory.
=item dir-branch => 'branches'
Name of the directory where all branches live. May be empty.
=item dir-tag => 'tags'
Name of the directory where all tags live. May be empty.
=item level-owner-branch => 2
Sub-directory level in the name of a branch containing the its owner.
=item level-owner-branch => undef
Sub-directory level in the name of a tag containing the its owner.
=item template-branch => '{category}/{owner}/{name_prefix}{name}'
Branch name template.
=item template-tag => undef
Tag name template.
=back
=item url
is the full URL@PEG.
=item root
is the repository root.
=item path
is the path below the repository root.
=item peg_rev
is the (peg) revision of the URL.
=item project
is the project name in the URL. It is undef if the URL does not contain a valid
project name for the given repository. An empty string is possible, for example,
if the layout means that the trunk is at the root level.
=item branch
is the "branch" name in the URL, (which may be the name of the master/trunk
branch or the name of a tag). It is undef if the URL does not contain a valid
branch name for the given repository.
=item branch_category
is the category (i.e. "trunk", "branch" or "tag") of the branch.
=item branch_owner
is the owner of the branch, if it can be derived from the URL.
=item sub_tree
is the path in the URL under the branch of a project tree. It is undef if the
URL is not at or below the level of a branch of the project tree. An empty
string means the that the URL is at root level of the project tree.
=back
An FCM::System::CM::SVN::Layout instance has the following convenient methods:
=over 4
=item $layout->is_trunk()
The URL is in the trunk of a project.
=item $layout->is_branch()
The URL is in a branch of a project.
=item $layout->is_tag()
The URL is in a tag of a project.
=item $layout->is_owned_by_user($user)
The URL is in a branch owned by $user. If $user is not defined, it defaults to
the current user ID.
=item $layout->is_shared()
The URL is in a shared branch.
=back
=head1 COPYRIGHT
(C) Crown copyright Met Office. All rights reserved.
=cut
|