/usr/lib/python2.7/dist-packages/cvs2svn_lib/collect_data.py is in cvs2svn 2.4.0-2.
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 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 | # (Be in -*- python -*- mode.)
#
# ====================================================================
# Copyright (c) 2000-2009 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-1.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://cvs2svn.tigris.org/.
# ====================================================================
"""Data collection classes.
This module contains the code used to collect data from the CVS
repository. It parses *,v files, recording all useful information
except for the actual file contents.
As a *,v file is parsed, the information pertaining to the file is
accumulated in memory, mostly in _RevisionData, _BranchData, and
_TagData objects. When parsing is complete, a final pass is made over
the data to create some final dependency links, collect statistics,
etc., then the _*Data objects are converted into CVSItem objects
(CVSRevision, CVSBranch, and CVSTag respectively) and the CVSItems are
dumped into databases.
During the data collection, persistent unique ids are allocated to
many types of objects: CVSFile, Symbol, and CVSItems. CVSItems are a
special case. CVSItem ids are unique across all CVSItem types, and
the ids are carried over from the corresponding data collection
objects:
_RevisionData -> CVSRevision
_BranchData -> CVSBranch
_TagData -> CVSTag
In a later pass it is possible to convert tags <-> branches. But even
if this occurs, the new branch or tag uses the same id as the old tag
or branch.
"""
import re
from cvs2svn_lib import config
from cvs2svn_lib.common import DB_OPEN_NEW
from cvs2svn_lib.common import warning_prefix
from cvs2svn_lib.common import error_prefix
from cvs2svn_lib.common import is_trunk_revision
from cvs2svn_lib.common import is_branch_revision_number
from cvs2svn_lib.log import logger
from cvs2svn_lib.context import Ctx
from cvs2svn_lib.artifact_manager import artifact_manager
from cvs2svn_lib.cvs_path import CVSFile
from cvs2svn_lib.cvs_path import CVSDirectory
from cvs2svn_lib.symbol import Symbol
from cvs2svn_lib.symbol import Trunk
from cvs2svn_lib.cvs_item import CVSRevision
from cvs2svn_lib.cvs_item import CVSBranch
from cvs2svn_lib.cvs_item import CVSTag
from cvs2svn_lib.cvs_item import cvs_revision_type_map
from cvs2svn_lib.cvs_file_items import VendorBranchError
from cvs2svn_lib.cvs_file_items import CVSFileItems
from cvs2svn_lib.key_generator import KeyGenerator
from cvs2svn_lib.cvs_item_database import NewCVSItemStore
from cvs2svn_lib.symbol_statistics import SymbolStatisticsCollector
from cvs2svn_lib.metadata_database import MetadataDatabase
from cvs2svn_lib.metadata_database import MetadataLogger
from cvs2svn_lib.rcsparser import Sink
from cvs2svn_lib.rcsparser import parse
from cvs2svn_lib.rcsparser import RCSParseError
# A regular expression defining "valid" revision numbers (used to
# check that symbol definitions are reasonable).
_valid_revision_re = re.compile(r'''
^
(?:\d+\.)+ # Digit groups with trailing dots
\d+ # And the last digit group.
$
''', re.VERBOSE)
_branch_revision_re = re.compile(r'''
^
((?:\d+\.\d+\.)+) # A nonzero even number of digit groups w/trailing dot
(?:0\.)? # CVS sticks an extra 0 here; RCS does not
(\d+) # And the last digit group
$
''', re.VERBOSE)
def is_same_line_of_development(rev1, rev2):
"""Return True if rev1 and rev2 are on the same line of
development (i.e., both on trunk, or both on the same branch);
return False otherwise. Either rev1 or rev2 can be None, in
which case automatically return False."""
if rev1 is None or rev2 is None:
return False
if is_trunk_revision(rev1) and is_trunk_revision(rev2):
# Trunk revisions have to be handled specially because the main
# trunk version number can be changed; e.g., from 1 to 2.
return True
if rev1[0:rev1.rfind('.')] == rev2[0:rev2.rfind('.')]:
return True
return False
class _RevisionData:
"""We track the state of each revision so that in set_revision_info,
we can determine if our op is an add/change/delete. We can do this
because in set_revision_info, we'll have all of the _RevisionData
for a file at our fingertips, and we need to examine the state of
our prev_rev to determine if we're an add or a change. Without the
state of the prev_rev, we are unable to distinguish between an add
and a change."""
def __init__(self, cvs_rev_id, rev, timestamp, author, state):
# The id of this revision:
self.cvs_rev_id = cvs_rev_id
self.rev = rev
self.timestamp = timestamp
self.author = author
self.state = state
# If this is the first revision on a branch, then this is the
# branch_data of that branch; otherwise it is None.
self.parent_branch_data = None
# The revision number of the parent of this revision along the
# same line of development, if any. For the first revision R on a
# branch, we consider the revision from which R sprouted to be the
# 'parent'. If this is the root revision in the file's revision
# tree, then this field is None.
#
# Note that this revision can't be determined arithmetically (due
# to cvsadmin -o), which is why this field is necessary.
self.parent = None
# The revision number of the primary child of this revision (the
# child along the same line of development), if any; otherwise,
# None.
self.child = None
# The _BranchData instances of branches that sprout from this
# revision, sorted in ascending order by branch number. It would
# be inconvenient to initialize it here because we would have to
# scan through all branches known by the _SymbolDataCollector to
# find the ones having us as the parent. Instead, this
# information is filled in by
# _FileDataCollector._resolve_dependencies() and sorted by
# _FileDataCollector._sort_branches().
self.branches_data = []
# The revision numbers of the first commits on any branches on
# which commits occurred. This dependency is kept explicitly
# because otherwise a revision-only topological sort would miss
# the dependency that exists via branches_data.
self.branches_revs_data = []
# The _TagData instances of tags that are connected to this
# revision.
self.tags_data = []
# A token that may be set by a RevisionCollector, then used by
# RevisionReader to obtain the text again.
self.revision_reader_token = None
def get_first_on_branch_id(self):
return self.parent_branch_data and self.parent_branch_data.id
class _SymbolData:
"""Collection area for information about a symbol in a single CVSFile.
SYMBOL is an instance of Symbol, undifferentiated as a Branch or a
Tag regardless of whether self is a _BranchData or a _TagData."""
def __init__(self, id, symbol):
"""Initialize an object for SYMBOL."""
# The unique id that will be used for this particular symbol in
# this particular file. This same id will be used for the CVSItem
# that is derived from this instance.
self.id = id
# An instance of Symbol.
self.symbol = symbol
class _BranchData(_SymbolData):
"""Collection area for information about a Branch in a single CVSFile."""
def __init__(self, id, symbol, branch_number):
_SymbolData.__init__(self, id, symbol)
# The branch number (e.g., '1.5.2') of this branch.
self.branch_number = branch_number
# The revision number of the revision from which this branch
# sprouts (e.g., '1.5').
self.parent = self.branch_number[:self.branch_number.rindex(".")]
# The revision number of the first commit on this branch, if any
# (e.g., '1.5.2.1'); otherwise, None.
self.child = None
class _TagData(_SymbolData):
"""Collection area for information about a Tag in a single CVSFile."""
def __init__(self, id, symbol, rev):
_SymbolData.__init__(self, id, symbol)
# The revision number being tagged (e.g., '1.5.2.3').
self.rev = rev
class _SymbolDataCollector(object):
"""Collect information about symbols in a single CVSFile."""
def __init__(self, fdc, cvs_file):
self.fdc = fdc
self.cvs_file = cvs_file
self.pdc = self.fdc.pdc
self.collect_data = self.fdc.collect_data
# A list [(name, revision), ...] of symbols defined in the header
# of the file. The name has already been transformed using the
# symbol transform rules. If the symbol transform rules indicate
# that the symbol should be ignored, then it is never added to
# this list. This list is processed then deleted in
# process_symbols().
self._symbol_defs = []
# A set containing the transformed names of symbols in this file
# (used to detect duplicates during processing of unlabeled
# branches):
self._defined_symbols = set()
# Map { branch_number : _BranchData }, where branch_number has an
# odd number of digits.
self.branches_data = { }
# Map { revision : [ tag_data ] }, where revision has an even
# number of digits, and the value is a list of _TagData objects
# for tags that apply to that revision.
self.tags_data = { }
def _add_branch(self, name, branch_number):
"""Record that BRANCH_NUMBER is the branch number for branch NAME,
and derive and record the revision from which NAME sprouts.
BRANCH_NUMBER is an RCS branch number with an odd number of
components, for example '1.7.2' (never '1.7.0.2'). Return the
_BranchData instance (which is usually newly-created)."""
branch_data = self.branches_data.get(branch_number)
if branch_data is not None:
logger.warn(
"%s: in '%s':\n"
" branch '%s' already has name '%s',\n"
" cannot also have name '%s', ignoring the latter\n"
% (warning_prefix,
self.cvs_file.rcs_path, branch_number,
branch_data.symbol.name, name)
)
return branch_data
symbol = self.pdc.get_symbol(name)
branch_data = _BranchData(
self.collect_data.item_key_generator.gen_id(), symbol, branch_number
)
self.branches_data[branch_number] = branch_data
return branch_data
def _construct_distinct_name(self, name, original_name):
"""Construct a distinct symbol name from NAME.
If NAME is distinct, return it. If it is already used in this
file (as determined from its presence in self._defined_symbols),
construct and return a new name that is not already used."""
if name not in self._defined_symbols:
return name
else:
index = 1
while True:
dup_name = '%s-DUPLICATE-%d' % (name, index,)
if dup_name not in self._defined_symbols:
self.collect_data.record_fatal_error(
"Symbol name '%s' is already used in '%s'.\n"
"The unlabeled branch '%s' must be renamed using "
"--symbol-transform."
% (name, self.cvs_file.rcs_path, original_name,)
)
return dup_name
def _add_unlabeled_branch(self, branch_number):
original_name = "unlabeled-" + branch_number
name = self.transform_symbol(original_name, branch_number)
if name is None:
self.collect_data.record_fatal_error(
"The unlabeled branch '%s' in '%s' contains commits.\n"
"It may not be ignored via a symbol transform. (Use --exclude "
"instead.)"
% (original_name, self.cvs_file.rcs_path,)
)
# Retain the original name to allow the conversion to continue:
name = original_name
distinct_name = self._construct_distinct_name(name, original_name)
self._defined_symbols.add(distinct_name)
return self._add_branch(distinct_name, branch_number)
def _add_tag(self, name, revision):
"""Record that tag NAME refers to the specified REVISION."""
symbol = self.pdc.get_symbol(name)
tag_data = _TagData(
self.collect_data.item_key_generator.gen_id(), symbol, revision
)
self.tags_data.setdefault(revision, []).append(tag_data)
return tag_data
def transform_symbol(self, name, revision):
"""Transform a symbol according to the project's symbol transforms.
Transform the symbol with the original name NAME and canonicalized
revision number REVISION. Return the new symbol name or None if
the symbol should be ignored entirely.
Log the results of the symbol transform if necessary."""
old_name = name
# Apply any user-defined symbol transforms to the symbol name:
name = self.cvs_file.project.transform_symbol(
self.cvs_file, name, revision
)
if name is None:
# Ignore symbol:
self.pdc.log_symbol_transform(old_name, None)
logger.verbose(
" symbol '%s'=%s ignored in %s"
% (old_name, revision, self.cvs_file.rcs_path,)
)
else:
if name != old_name:
self.pdc.log_symbol_transform(old_name, name)
logger.verbose(
" symbol '%s'=%s transformed to '%s' in %s"
% (old_name, revision, name, self.cvs_file.rcs_path,)
)
return name
def define_symbol(self, name, revision):
"""Record a symbol definition for later processing."""
# Canonicalize the revision number:
revision = _branch_revision_re.sub(r'\1\2', revision)
# Apply any user-defined symbol transforms to the symbol name:
name = self.transform_symbol(name, revision)
if name is not None:
# Verify that the revision number is valid:
if _valid_revision_re.match(revision):
# The revision number is valid; record it for later processing:
self._symbol_defs.append( (name, revision) )
else:
logger.warn(
'In %r:\n'
' branch %r references invalid revision %s\n'
' and will be ignored.'
% (self.cvs_file.rcs_path, name, revision,)
)
def _eliminate_trivial_duplicate_defs(self, symbol_defs):
"""Iterate through SYMBOL_DEFS, Removing identical duplicate definitions.
Duplicate definitions of symbol names have been seen in the wild,
and they can also happen when --symbol-transform is used. If a
symbol is defined to the same revision number repeatedly, then
ignore all but the last definition."""
# Make a copy, since we have to iterate through the definitions
# twice:
symbol_defs = list(symbol_defs)
# A map { (name, revision) : [index,...] } of the indexes where
# symbol definitions name=revision were found:
known_definitions = {}
for (i, symbol_def) in enumerate(symbol_defs):
known_definitions.setdefault(symbol_def, []).append(i)
# A set of the indexes of entries that have to be removed from
# symbol_defs:
dup_indexes = set()
for ((name, revision), indexes) in known_definitions.iteritems():
if len(indexes) > 1:
logger.verbose(
"in %r:\n"
" symbol %s:%s defined multiple times; ignoring duplicates\n"
% (self.cvs_file.rcs_path, name, revision,)
)
dup_indexes.update(indexes[:-1])
for (i, symbol_def) in enumerate(symbol_defs):
if i not in dup_indexes:
yield symbol_def
def _process_duplicate_defs(self, symbol_defs):
"""Iterate through SYMBOL_DEFS, processing duplicate names.
Duplicate definitions of symbol names have been seen in the wild,
and they can also happen when --symbol-transform is used. If a
symbol is defined multiple times, then it is a fatal error. This
method should be called after _eliminate_trivial_duplicate_defs()."""
# Make a copy, since we have to access multiple times:
symbol_defs = list(symbol_defs)
# A map {name : [index,...]} mapping the names of symbols to a
# list of their definitions' indexes in symbol_defs:
known_symbols = {}
for (i, (name, revision)) in enumerate(symbol_defs):
known_symbols.setdefault(name, []).append(i)
known_symbols = known_symbols.items()
known_symbols.sort()
dup_indexes = set()
for (name, indexes) in known_symbols:
if len(indexes) > 1:
# This symbol was defined multiple times.
self.collect_data.record_fatal_error(
"Multiple definitions of the symbol '%s' in '%s': %s" % (
name, self.cvs_file.rcs_path,
' '.join([symbol_defs[i][1] for i in indexes]),
)
)
# Ignore all but the last definition for now, to allow the
# conversion to proceed:
dup_indexes.update(indexes[:-1])
for (i, symbol_def) in enumerate(symbol_defs):
if i not in dup_indexes:
yield symbol_def
def _process_symbol(self, name, revision):
"""Process a symbol called NAME, which is associated with REVISON.
REVISION is a canonical revision number with zeros removed, for
example: '1.7', '1.7.2', or '1.1.1' or '1.1.1.1'. NAME is a
transformed branch or tag name."""
# Add symbol to our records:
if is_branch_revision_number(revision):
self._add_branch(name, revision)
else:
self._add_tag(name, revision)
def process_symbols(self):
"""Process the symbol definitions from SELF._symbol_defs."""
symbol_defs = self._symbol_defs
del self._symbol_defs
symbol_defs = self._eliminate_trivial_duplicate_defs(symbol_defs)
symbol_defs = self._process_duplicate_defs(symbol_defs)
for (name, revision) in symbol_defs:
self._defined_symbols.add(name)
self._process_symbol(name, revision)
@staticmethod
def rev_to_branch_number(revision):
"""Return the branch_number of the branch on which REVISION lies.
REVISION is a branch revision number with an even number of
components; for example '1.7.2.1' (never '1.7.2' nor '1.7.0.2').
The return value is the branch number (for example, '1.7.2').
Return none iff REVISION is a trunk revision such as '1.2'."""
if is_trunk_revision(revision):
return None
return revision[:revision.rindex(".")]
def rev_to_branch_data(self, revision):
"""Return the branch_data of the branch on which REVISION lies.
REVISION must be a branch revision number with an even number of
components; for example '1.7.2.1' (never '1.7.2' nor '1.7.0.2').
Raise KeyError iff REVISION is unknown."""
assert not is_trunk_revision(revision)
return self.branches_data[self.rev_to_branch_number(revision)]
def rev_to_lod(self, revision):
"""Return the line of development on which REVISION lies.
REVISION must be a revision number with an even number of
components. Raise KeyError iff REVISION is unknown."""
if is_trunk_revision(revision):
return self.pdc.trunk
else:
return self.rev_to_branch_data(revision).symbol
class _FileDataCollector(Sink):
"""Class responsible for collecting RCS data for a particular file.
Any collected data that need to be remembered are stored into the
referenced CollectData instance."""
def __init__(self, pdc, cvs_file):
"""Create an object that is prepared to receive data for CVS_FILE.
CVS_FILE is a CVSFile instance. COLLECT_DATA is used to store the
information collected about the file."""
self.pdc = pdc
self.cvs_file = cvs_file
self.collect_data = self.pdc.collect_data
self.project = self.cvs_file.project
# A place to store information about the symbols in this file:
self.sdc = _SymbolDataCollector(self, self.cvs_file)
# { revision : _RevisionData instance }
self._rev_data = { }
# Lists [ (parent, child) ] of revision number pairs indicating
# that revision child depends on revision parent along the main
# line of development.
self._primary_dependencies = []
# If set, this is an RCS branch number -- rcsparse calls this the
# "principal branch", but CVS and RCS refer to it as the "default
# branch", so that's what we call it, even though the rcsparse API
# setter method is still 'set_principal_branch'.
self.default_branch = None
# True iff revision 1.1 of the file appears to have been imported
# (as opposed to added normally).
self._file_imported = False
def _get_rev_id(self, revision):
if revision is None:
return None
return self._rev_data[revision].cvs_rev_id
def set_principal_branch(self, branch):
"""This is a callback method declared in Sink."""
if branch.find('.') == -1:
# This just sets the default branch to trunk. Normally this
# shouldn't occur, but it has been seen in at least one CVS
# repository. Just ignore it.
return
m = _branch_revision_re.match(branch)
if not m:
self.collect_data.record_fatal_error(
'The default branch %s in file %r is not a valid branch number'
% (branch, self.cvs_file.rcs_path,)
)
return
branch = m.group(1) + m.group(2)
if branch.count('.') != 2:
# We don't know how to deal with a non-top-level default
# branch (what does CVS do?). So if this case is detected,
# punt:
self.collect_data.record_fatal_error(
'The default branch %s in file %r is not a top-level branch'
% (branch, self.cvs_file.rcs_path,)
)
return
self.default_branch = branch
def define_tag(self, name, revision):
"""Remember the symbol name and revision, but don't process them yet.
This is a callback method declared in Sink."""
self.sdc.define_symbol(name, revision)
def set_expansion(self, mode):
"""This is a callback method declared in Sink."""
self.cvs_file.mode = mode
def admin_completed(self):
"""This is a callback method declared in Sink."""
self.sdc.process_symbols()
def define_revision(self, revision, timestamp, author, state,
branches, next):
"""This is a callback method declared in Sink."""
for branch in branches:
try:
branch_data = self.sdc.rev_to_branch_data(branch)
except KeyError:
# Normally we learn about the branches from the branch names
# and numbers parsed from the symbolic name header. But this
# must have been an unlabeled branch that slipped through the
# net. Generate a name for it and create a _BranchData record
# for it now.
branch_data = self.sdc._add_unlabeled_branch(
self.sdc.rev_to_branch_number(branch))
assert branch_data.child is None
branch_data.child = branch
if revision in self._rev_data:
# This revision has already been seen.
logger.error('File %r contains duplicate definitions of revision %s.'
% (self.cvs_file.rcs_path, revision,))
raise RuntimeError()
# Record basic information about the revision:
rev_data = _RevisionData(
self.collect_data.item_key_generator.gen_id(),
revision, int(timestamp), author, state)
self._rev_data[revision] = rev_data
# When on trunk, the RCS 'next' revision number points to what
# humans might consider to be the 'previous' revision number. For
# example, 1.3's RCS 'next' is 1.2.
#
# However, on a branch, the RCS 'next' revision number really does
# point to what humans would consider to be the 'next' revision
# number. For example, 1.1.2.1's RCS 'next' would be 1.1.2.2.
#
# In other words, in RCS, 'next' always means "where to find the next
# deltatext that you need this revision to retrieve.
#
# That said, we don't *want* RCS's behavior here, so we determine
# whether we're on trunk or a branch and set the dependencies
# accordingly.
if next:
if is_trunk_revision(revision):
self._primary_dependencies.append( (next, revision,) )
else:
self._primary_dependencies.append( (revision, next,) )
def tree_completed(self):
"""The revision tree has been parsed.
Analyze it for consistency and connect some loose ends.
This is a callback method declared in Sink."""
self._resolve_primary_dependencies()
self._resolve_branch_dependencies()
self._sort_branches()
self._resolve_tag_dependencies()
# Compute the preliminary CVSFileItems for this file:
cvs_items = []
cvs_items.extend(self._get_cvs_revisions())
cvs_items.extend(self._get_cvs_branches())
cvs_items.extend(self._get_cvs_tags())
self._cvs_file_items = CVSFileItems(
self.cvs_file, self.pdc.trunk, cvs_items
)
self._cvs_file_items.check_link_consistency()
def _resolve_primary_dependencies(self):
"""Resolve the dependencies listed in self._primary_dependencies."""
for (parent, child,) in self._primary_dependencies:
parent_data = self._rev_data[parent]
assert parent_data.child is None
parent_data.child = child
child_data = self._rev_data[child]
assert child_data.parent is None
child_data.parent = parent
def _resolve_branch_dependencies(self):
"""Resolve dependencies involving branches."""
for branch_data in self.sdc.branches_data.values():
# The branch_data's parent has the branch as a child regardless
# of whether the branch had any subsequent commits:
try:
parent_data = self._rev_data[branch_data.parent]
except KeyError:
logger.warn(
'In %r:\n'
' branch %r references non-existing revision %s\n'
' and will be ignored.'
% (self.cvs_file.rcs_path, branch_data.symbol.name,
branch_data.parent,))
del self.sdc.branches_data[branch_data.branch_number]
else:
parent_data.branches_data.append(branch_data)
# If the branch has a child (i.e., something was committed on
# the branch), then we store a reference to the branch_data
# there, define the child's parent to be the branch's parent,
# and list the child in the branch parent's branches_revs_data:
if branch_data.child is not None:
child_data = self._rev_data[branch_data.child]
assert child_data.parent_branch_data is None
child_data.parent_branch_data = branch_data
assert child_data.parent is None
child_data.parent = branch_data.parent
parent_data.branches_revs_data.append(branch_data.child)
def _sort_branches(self):
"""Sort the branches sprouting from each revision in creation order.
Creation order is taken to be the reverse of the order that they
are listed in the symbols part of the RCS file. (If a branch is
created then deleted, a later branch can be assigned the recycled
branch number; therefore branch numbers are not an indication of
creation order.)"""
for rev_data in self._rev_data.values():
rev_data.branches_data.sort(lambda a, b: - cmp(a.id, b.id))
def _resolve_tag_dependencies(self):
"""Resolve dependencies involving tags."""
for (rev, tag_data_list) in self.sdc.tags_data.items():
try:
parent_data = self._rev_data[rev]
except KeyError:
logger.warn(
'In %r:\n'
' the following tag(s) reference non-existing revision %s\n'
' and will be ignored:\n'
' %s' % (
self.cvs_file.rcs_path, rev,
', '.join([repr(tag_data.symbol.name)
for tag_data in tag_data_list]),))
del self.sdc.tags_data[rev]
else:
for tag_data in tag_data_list:
assert tag_data.rev == rev
# The tag_data's rev has the tag as a child:
parent_data.tags_data.append(tag_data)
def _get_cvs_branches(self):
"""Generate the CVSBranches present in this file."""
for branch_data in self.sdc.branches_data.values():
yield CVSBranch(
branch_data.id, self.cvs_file, branch_data.symbol,
branch_data.branch_number,
self.sdc.rev_to_lod(branch_data.parent),
self._get_rev_id(branch_data.parent),
self._get_rev_id(branch_data.child),
None,
)
def _get_cvs_tags(self):
"""Generate the CVSTags present in this file."""
for tags_data in self.sdc.tags_data.values():
for tag_data in tags_data:
yield CVSTag(
tag_data.id, self.cvs_file, tag_data.symbol,
self.sdc.rev_to_lod(tag_data.rev),
self._get_rev_id(tag_data.rev),
None,
)
def set_description(self, description):
"""This is a callback method declared in Sink."""
self.cvs_file.description = description
self.cvs_file.determine_file_properties(Ctx().file_property_setters)
def set_revision_info(self, revision, log, text):
"""This is a callback method declared in Sink."""
rev_data = self._rev_data[revision]
cvs_rev = self._cvs_file_items[rev_data.cvs_rev_id]
if cvs_rev.metadata_id is not None:
# Users have reported problems with repositories in which the
# deltatext block for revision 1.1 appears twice. It is not
# known whether this results from a CVS/RCS bug, or from botched
# hand-editing of the repository. In any case, empirically, cvs
# and rcs both use the first version when checking out data, so
# that's what we will do. (For the record: "cvs log" fails on
# such a file; "rlog" prints the log message from the first
# block and ignores the second one.)
logger.warn(
"%s: in '%s':\n"
" Deltatext block for revision %s appeared twice;\n"
" ignoring the second occurrence.\n"
% (warning_prefix, self.cvs_file.rcs_path, revision,)
)
return
if is_trunk_revision(revision):
branch_name = None
else:
branch_name = self.sdc.rev_to_branch_data(revision).symbol.name
cvs_rev.metadata_id = self.collect_data.metadata_logger.store(
self.project, branch_name, rev_data.author, log
)
cvs_rev.deltatext_exists = bool(text)
# If this is revision 1.1, determine whether the file appears to
# have been created via 'cvs add' instead of 'cvs import'. The
# test is that the log message CVS uses for 1.1 in imports is
# "Initial revision\n" with no period. (This fact helps determine
# whether this file might have had a default branch in the past.)
if revision == '1.1':
self._file_imported = (log == 'Initial revision\n')
def parse_completed(self):
"""Finish the processing of this file.
This is a callback method declared in Sink."""
# Make sure that there was an info section for each revision:
for cvs_item in self._cvs_file_items.values():
if isinstance(cvs_item, CVSRevision) and cvs_item.metadata_id is None:
self.collect_data.record_fatal_error(
'%r has no deltatext section for revision %s'
% (self.cvs_file.rcs_path, cvs_item.rev,)
)
def _determine_operation(self, rev_data):
prev_rev_data = self._rev_data.get(rev_data.parent)
return cvs_revision_type_map[(
rev_data.state != 'dead',
prev_rev_data is not None and prev_rev_data.state != 'dead',
)]
def _get_cvs_revisions(self):
"""Generate the CVSRevisions present in this file."""
for rev_data in self._rev_data.itervalues():
yield self._get_cvs_revision(rev_data)
def _get_cvs_revision(self, rev_data):
"""Create and return a CVSRevision for REV_DATA."""
branch_ids = [
branch_data.id
for branch_data in rev_data.branches_data
]
branch_commit_ids = [
self._get_rev_id(rev)
for rev in rev_data.branches_revs_data
]
tag_ids = [
tag_data.id
for tag_data in rev_data.tags_data
]
revision_type = self._determine_operation(rev_data)
return revision_type(
self._get_rev_id(rev_data.rev), self.cvs_file,
rev_data.timestamp, None,
self._get_rev_id(rev_data.parent),
self._get_rev_id(rev_data.child),
rev_data.rev,
True,
self.sdc.rev_to_lod(rev_data.rev),
rev_data.get_first_on_branch_id(),
False, None, None,
tag_ids, branch_ids, branch_commit_ids,
rev_data.revision_reader_token
)
def get_cvs_file_items(self):
"""Finish up and return a CVSFileItems instance for this file.
This method must only be called once."""
self._process_ntdbrs()
# Break a circular reference loop, allowing the memory for self
# and sdc to be freed.
del self.sdc
return self._cvs_file_items
def _process_ntdbrs(self):
"""Fix up any non-trunk default branch revisions (if present).
If a non-trunk default branch is determined to have existed, yield
the _RevisionData.ids for all revisions that were once non-trunk
default revisions, in dependency order.
There are two cases to handle:
One case is simple. The RCS file lists a default branch
explicitly in its header, such as '1.1.1'. In this case, we know
that every revision on the vendor branch is to be treated as head
of trunk at that point in time.
But there's also a degenerate case. The RCS file does not
currently have a default branch, yet we can deduce that for some
period in the past it probably *did* have one. For example, the
file has vendor revisions 1.1.1.1 -> 1.1.1.96, all of which are
dated before 1.2, and then it has 1.1.1.97 -> 1.1.1.100 dated
after 1.2. In this case, we should record 1.1.1.96 as the last
vendor revision to have been the head of the default branch.
If any non-trunk default branch revisions are found:
- Set their ntdbr members to True.
- Connect the last one with revision 1.2.
- Remove revision 1.1 if it is not needed.
"""
try:
if self.default_branch:
try:
vendor_cvs_branch_id = self.sdc.branches_data[self.default_branch].id
except KeyError:
logger.warn(
'%s: In %s:\n'
' vendor branch %r is not present in file and will be ignored.'
% (warning_prefix, self.cvs_file.rcs_path, self.default_branch,)
)
self.default_branch = None
return
vendor_lod_items = self._cvs_file_items.get_lod_items(
self._cvs_file_items[vendor_cvs_branch_id]
)
if not self._cvs_file_items.process_live_ntdb(vendor_lod_items):
return
elif self._file_imported:
vendor_branch_data = self.sdc.branches_data.get('1.1.1')
if vendor_branch_data is None:
return
else:
vendor_lod_items = self._cvs_file_items.get_lod_items(
self._cvs_file_items[vendor_branch_data.id]
)
if not self._cvs_file_items.process_historical_ntdb(
vendor_lod_items
):
return
else:
return
except VendorBranchError, e:
self.collect_data.record_fatal_error(str(e))
return
if self._file_imported:
self._cvs_file_items.imported_remove_1_1(vendor_lod_items)
self._cvs_file_items.check_link_consistency()
class _ProjectDataCollector:
def __init__(self, collect_data, project):
self.collect_data = collect_data
self.project = project
self.num_files = 0
# The Trunk LineOfDevelopment object for this project:
self.trunk = Trunk(
self.collect_data.symbol_key_generator.gen_id(), self.project
)
self.project.trunk_id = self.trunk.id
# This causes a record for self.trunk to spring into existence:
self.collect_data.register_trunk(self.trunk)
# A map { name -> Symbol } for all known symbols in this project.
# The symbols listed here are undifferentiated into Branches and
# Tags because the same name might appear as a branch in one file
# and a tag in another.
self.symbols = {}
# A map { (old_name, new_name) : count } indicating how many files
# were affected by each each symbol name transformation:
self.symbol_transform_counts = {}
def get_symbol(self, name):
"""Return the Symbol object for the symbol named NAME in this project.
If such a symbol does not yet exist, allocate a new symbol_id,
create a Symbol instance, store it in self.symbols, and return it."""
symbol = self.symbols.get(name)
if symbol is None:
symbol = Symbol(
self.collect_data.symbol_key_generator.gen_id(),
self.project, name)
self.symbols[name] = symbol
return symbol
def log_symbol_transform(self, old_name, new_name):
"""Record that OLD_NAME was transformed to NEW_NAME in one file.
This information is used to generated a statistical summary of
symbol transforms."""
try:
self.symbol_transform_counts[old_name, new_name] += 1
except KeyError:
self.symbol_transform_counts[old_name, new_name] = 1
def summarize_symbol_transforms(self):
if self.symbol_transform_counts and logger.is_on(logger.NORMAL):
logger.normal('Summary of symbol transforms:')
transforms = self.symbol_transform_counts.items()
transforms.sort()
for ((old_name, new_name), count) in transforms:
if new_name is None:
logger.normal(' "%s" ignored in %d files' % (old_name, count,))
else:
logger.normal(
' "%s" transformed to "%s" in %d files'
% (old_name, new_name, count,)
)
def process_file(self, cvs_file):
logger.normal(cvs_file.rcs_path)
fdc = _FileDataCollector(self, cvs_file)
try:
parse(open(cvs_file.rcs_path, 'rb'), fdc)
except (RCSParseError, RuntimeError):
self.collect_data.record_fatal_error(
"%r is not a valid ,v file" % (cvs_file.rcs_path,)
)
# Abort the processing of this file, but let the pass continue
# with other files:
return
except ValueError, e:
self.collect_data.record_fatal_error(
"%r is not a valid ,v file (%s)" % (cvs_file.rcs_path, str(e),)
)
# Abort the processing of this file, but let the pass continue
# with other files:
return
except:
logger.warn("Exception occurred while parsing %s" % cvs_file.rcs_path)
raise
else:
self.num_files += 1
return fdc.get_cvs_file_items()
class CollectData:
"""Repository for data collected by parsing the CVS repository files.
This class manages the databases into which information collected
from the CVS repository is stored. The data are stored into this
class by _FileDataCollector instances, one of which is created for
each file to be parsed."""
def __init__(self, stats_keeper):
self._cvs_item_store = NewCVSItemStore(
artifact_manager.get_temp_file(config.CVS_ITEMS_STORE))
self.metadata_db = MetadataDatabase(
artifact_manager.get_temp_file(config.METADATA_STORE),
artifact_manager.get_temp_file(config.METADATA_INDEX_TABLE),
DB_OPEN_NEW,
)
self.metadata_logger = MetadataLogger(self.metadata_db)
self.fatal_errors = []
self.num_files = 0
self.symbol_stats = SymbolStatisticsCollector()
self.stats_keeper = stats_keeper
# Key generator for CVSItems:
self.item_key_generator = KeyGenerator()
# Key generator for Symbols:
self.symbol_key_generator = KeyGenerator()
def record_fatal_error(self, err):
"""Record that fatal error ERR was found.
ERR is a string (without trailing newline) describing the error.
Output the error to stderr immediately, and record a copy to be
output again in a summary at the end of CollectRevsPass."""
err = '%s: %s' % (error_prefix, err,)
logger.error(err + '\n')
self.fatal_errors.append(err)
def add_cvs_directory(self, cvs_directory):
"""Record CVS_DIRECTORY."""
Ctx()._cvs_path_db.log_path(cvs_directory)
def add_cvs_file_items(self, cvs_file_items):
"""Record the information from CVS_FILE_ITEMS.
Store the CVSFile to _cvs_path_db under its persistent id, store
the CVSItems, and record the CVSItems to self.stats_keeper."""
Ctx()._cvs_path_db.log_path(cvs_file_items.cvs_file)
self._cvs_item_store.add(cvs_file_items)
self.stats_keeper.record_cvs_file(cvs_file_items.cvs_file)
for cvs_item in cvs_file_items.values():
self.stats_keeper.record_cvs_item(cvs_item)
def register_trunk(self, trunk):
"""Create a symbol statistics record for the specified trunk LOD."""
# This causes a record to spring into existence:
self.symbol_stats[trunk]
def _process_cvs_file_items(self, cvs_file_items):
"""Process the CVSFileItems from one CVSFile."""
# Remove an initial delete on trunk if it is not needed:
cvs_file_items.remove_unneeded_initial_trunk_delete(self.metadata_db)
# Remove initial branch deletes that are not needed:
cvs_file_items.remove_initial_branch_deletes(self.metadata_db)
# If this is a --trunk-only conversion, discard all branches and
# tags, then draft any non-trunk default branch revisions to
# trunk:
if Ctx().trunk_only:
cvs_file_items.exclude_non_trunk()
cvs_file_items.check_link_consistency()
self.add_cvs_file_items(cvs_file_items)
self.symbol_stats.register(cvs_file_items)
def process_project(self, project, cvs_paths):
pdc = _ProjectDataCollector(self, project)
found_rcs_file = False
for cvs_path in cvs_paths:
if isinstance(cvs_path, CVSDirectory):
self.add_cvs_directory(cvs_path)
else:
cvs_file_items = pdc.process_file(cvs_path)
self._process_cvs_file_items(cvs_file_items)
found_rcs_file = True
if not found_rcs_file:
self.record_fatal_error(
'No RCS files found under %r!\n'
'Are you absolutely certain you are pointing cvs2svn\n'
'at a CVS repository?\n'
% (project.project_cvs_repos_path,)
)
pdc.summarize_symbol_transforms()
self.num_files += pdc.num_files
logger.verbose('Processed', self.num_files, 'files')
def _register_empty_subdirectories(self):
"""Set the CVSDirectory.empty_subdirectory_id members."""
directories = set(
path
for path in Ctx()._cvs_path_db.itervalues()
if isinstance(path, CVSDirectory)
)
for path in Ctx()._cvs_path_db.itervalues():
if isinstance(path, CVSFile):
directory = path.parent_directory
while directory is not None and directory in directories:
directories.remove(directory)
directory = directory.parent_directory
for directory in directories:
if directory.parent_directory is not None:
directory.parent_directory.empty_subdirectory_ids.append(directory.id)
def close(self):
"""Close the data structures associated with this instance.
Return a list of fatal errors encountered while processing input.
Each list entry is a string describing one fatal error."""
self.symbol_stats.purge_ghost_symbols()
self.symbol_stats.close()
self.symbol_stats = None
self.metadata_logger = None
self.metadata_db.close()
self.metadata_db = None
self._cvs_item_store.close()
self._cvs_item_store = None
self._register_empty_subdirectories()
retval = self.fatal_errors
self.fatal_errors = None
return retval
|