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
|
# Copyright (C) 2008 Canonical Ltd
#
# This program 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 2 of the License, or
# (at your option) any later version.
#
# This program 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 this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""Import processor that supports all Bazaar repository formats."""
import time
from bzrlib import (
delta,
errors,
generate_ids,
inventory,
lru_cache,
osutils,
revision,
revisiontree,
)
from bzrlib.trace import (
note,
warning,
)
from bzrlib.plugins.fastimport import (
processor,
revisionloader,
)
def _single_plural(n, single, plural):
"""Return a single or plural form of a noun based on number."""
if n == 1:
return single
else:
return plural
class GenericProcessor(processor.ImportProcessor):
"""An import processor that handles basic imports.
Current features supported:
* timestamped progress reporting
* blobs are cached in memory until used
* TODO: commit handling
* LATER: branch support
* checkpoints and tags are ignored
* some basic statistics are dumped on completion.
"""
def pre_process(self):
self.cache_mgr = GenericCacheManager()
self.active_branch = self.branch
self.init_stats()
def post_process(self):
self.dump_stats()
# Update the branches, assuming the last revision is the head
note("Updating branch information ...")
# TODO - loop over the branches created/modified
last_rev_id = self.cache_mgr.last_revision_ids[self.branch]
revno = len(list(self.repo.iter_reverse_revision_history(last_rev_id)))
self.branch.set_last_revision_info(revno, last_rev_id)
# Update the working tree, if any
if self.working_tree:
self.working_tree.update(delta._ChangeReporter())
def init_stats(self):
self._revision_count = 0
self._branch_count = 1
self._tag_count = 0
def dump_stats(self):
rc = self._revision_count
bc = self._branch_count
tc = self._tag_count
note("Imported %d %s into %d %s with %d %s.",
rc, _single_plural(rc, "revision", "revisions"),
bc, _single_plural(bc, "branch", "branches"),
tc, _single_plural(tc, "tag", "tags"))
def blob_handler(self, cmd):
"""Process a BlobCommand."""
if cmd.mark is not None:
dataref = ":%s" % (cmd.mark,)
else:
dataref = osutils.sha_strings(cmd.data)
self.cache_mgr.blobs[dataref] = cmd.data
def checkpoint_handler(self, cmd):
"""Process a CheckpointCommand."""
warning("ignoring checkpoint")
def commit_handler(self, cmd):
"""Process a CommitCommand."""
handler = GenericCommitHandler(cmd, self.repo, self.cache_mgr,
self.active_branch)
# For now, put a write group around every commit. In the future,
# we might only start/commit one every N to sppeed things up
self.repo.start_write_group()
try:
handler.process()
self.cache_mgr.last_revision_ids[self.active_branch] = \
handler.revision_id
self._revision_count += 1
except:
self.repo.abort_write_group()
raise
else:
self.repo.commit_write_group()
def progress_handler(self, cmd):
"""Process a ProgressCommand."""
# We could use a progress bar here but timestamped messages
# is more useful for determining when things might complete
note("%s progress %s" % (self._time_of_day(), cmd.message))
def _time_of_day(self):
"""Time of day as a string."""
# Note: this is a separate method so tests can patch in a fixed value
return time.localtime().strftime("%H:%M:%s")
def reset_handler(self, cmd):
"""Process a ResetCommand."""
warning("multiple branches are not supported yet"
" - ignoring branch '%s'", cmd.ref)
def tag_handler(self, cmd):
"""Process a TagCommand."""
warning("tags are not supported yet - ignoring tag '%s'", cmd.id)
class GenericCacheManager(object):
"""A manager of caches for the GenericProcessor."""
def __init__(self, inventory_cache_size=100):
# dataref -> data. datref is either :mark or the sha-1.
# Once a blob is used, it should be deleted from here.
self.blobs = {}
# revision-id -> Inventory cache
# these are large and we probably don't need too many as
# most parents are recent in history
self.inventories = lru_cache.LRUCache(inventory_cache_size)
# directory-path -> inventory-entry lookup table
# we need to keep all of these but they are small
self.directory_entries = {}
# import-ref -> revision-id lookup table
# we need to keep all of these but they are small
self.revision_ids = {}
# branch -> last revision-id lookup table
self.last_revision_ids = {}
class GenericCommitHandler(processor.CommitHandler):
def __init__(self, command, repo, cache_mgr, active_branch):
processor.CommitHandler.__init__(self, command)
self.repo = repo
self.cache_mgr = cache_mgr
self.active_branch = active_branch
# smart loader that uses these caches
self.loader = revisionloader.RevisionLoader(repo,
lambda revision_ids: self._get_inventories(revision_ids))
def pre_process_files(self):
"""Prepare for committing."""
self.revision_id = self.gen_revision_id()
self.inv_delta = []
# cache of texts for this commit, indexed by file-id
self.lines_for_commit = {}
def post_process_files(self):
"""Save the revision."""
if self.command.parents:
parents = [self.cache_mgr.revision_ids[ref]
for ref in self.command.parents]
else:
# if no parents are given, the last revision on
# the current branch is assumed according to the spec
last_rev = self.cache_mgr.last_revision_ids.get(
self.active_branch)
if last_rev:
parents = [last_rev]
else:
parents = []
# Derive the inventory from the previous one
if len(parents) == 0:
new_inventory = self.gen_initial_inventory()
else:
# use the bzr_revision_id to lookup the inv cache
new_inventory = self.get_inventory(parents[0]).copy()
new_inventory.apply_delta(self.inv_delta)
self.cache_mgr.revision_ids[self.command.ref] = new_inventory
# debug trace ...
print "applied inventory delta ..."
for entry in self.inv_delta:
print " %r" % (entry,)
print "creating inventory ..."
for entry in new_inventory:
print " %r" % (entry,)
# Load the revision into the repository
# TODO: Escape the commit message
committer = self.command.committer
who = "%s <%s>" % (committer[0],committer[1])
rev = revision.Revision(self.revision_id)
rev = revision.Revision(
timestamp=committer[2],
timezone=committer[3],
committer=who,
message=self.escape_commit_message(self.command.message),
revision_id=self.revision_id)
rev.parent_ids = parents
self.loader.load(rev, new_inventory, None,
lambda file_id: self._get_lines(file_id))
print "loaded revision %r" % (rev,)
def escape_commit_message(self, msg):
# It's crap that we need to do this at this level (but we do)
# TODO
return msg
def modify_handler(self, filecmd):
if filecmd.dataref is not None:
data = self.cache_mgr.blobs[filecmd.dataref]
# Conserve memory, assuming blobs aren't referenced twice
del self.cache_mgr.blobs[filecmd.dataref]
else:
data = filecmd.data
self._modify_inventory(filecmd.path, filecmd.kind,
filecmd.is_executable, data)
def delete_handler(self, filecmd):
path = filecmd.path
self.inv_delta.append((path, None, self.bzr_file_id(path), None))
def copy_handler(self, filecmd):
raise NotImplementedError(self.copy_handler)
def rename_handler(self, filecmd):
# TODO: add a suitable entry to the inventory delta
raise NotImplementedError(self.rename_handler)
def deleteall_handler(self, filecmd):
raise NotImplementedError(self.deleteall_handler)
def bzr_file_id(self, path):
"""Generate a Bazaar file identifier for a path."""
# TODO: Search the current inventory instead of generating every time
return generate_ids.gen_file_id(path)
def gen_initial_inventory(self):
"""Generate an inventory for a parentless revision."""
inv = inventory.Inventory(revision_id=self.revision_id)
if not self.repo.supports_rich_root():
# In this repository, root entries have no knit or weave. When
# serializing out to disk and back in, root.revision is always
# the new revision_id.
inv.root.revision = self.revision_id
return inv
def gen_revision_id(self):
"""Generate a revision id.
Subclasses may override this to produce deterministic ids say.
"""
committer = self.command.committer
who = "%s <%s>" % (committer[0],committer[1])
timestamp = committer[2]
return generate_ids.gen_revision_id(who, timestamp)
def get_inventory(self, revision_id):
"""Get the inventory for a revision id."""
try:
inv = self.cache_mgr.inventories[revision_id]
except KeyError:
# TODO: count misses and/or inform the user about the miss?
# Not cached so reconstruct from repository
inv = self.repo.revision_tree(revision_id).inventory
self.cache_mgr.inventories[revision_id] = inv
return inv
def _get_inventories(self, revision_ids):
"""Get the inventories for revision-ids.
This is a callback used by the RepositoryLoader to
speed up inventory reconstruction."""
present = []
inventories = []
# If an inventory is in the cache, we assume it was
# successfully loaded into the repsoitory
for revision_id in revision_ids:
try:
inv = self.cache_mgr.inventories[revision_id]
present.append(revision_id)
except KeyError:
# TODO: count misses and/or inform the user about the miss?
# Not cached so reconstruct from repository
if self.repo.has_revision(revision_id):
rev_tree = self.repo.revision_tree(revision_id)
present.append(revision_id)
else:
rev_tree = self.repo.revision_tree(None)
inv = rev_tree.inventory
self.cache_mgr.inventories[revision_id] = inv
inventories.append(inv)
return present, inventories
def _get_lines(self, file_id):
"""Get the lines for a file-id."""
return self.lines_for_commit[file_id]
def _modify_inventory(self, path, kind, is_executable, data):
"""Add to or change an item in the inventory."""
# Create the new InventoryEntry
basename, parent_ie = self._ensure_directory(path)
file_id = self.bzr_file_id(path)
ie = inventory.make_entry(kind, basename, parent_ie, file_id)
ie.revision = self.revision_id
if isinstance(ie, inventory.InventoryFile):
ie.text_sha1 = osutils.sha_strings(data)
ie.text_size = len(data)
ie.executable = is_executable
lines = data.split('\n')
if lines[-1] == '':
lines.pop()
self.lines_for_commit[file_id] = lines
elif isinstance(ie, inventory.InventoryLnk):
ie.symlink_target = data
else:
raise errors.BzrError("Cannot import items of kind '%s' yet" %
(kind,))
# Record this new inventory entry. As the import stream doesn't
# repeat all files every time, we build an inventory delta.
# HACK: We also assume that inventory.apply_delta handles the
# 'add' case cleanly when asked to change a non-existent entry.
# This saves time vs explicitly detecting add vs change.
old_path = path
self.inv_delta.append((old_path, path, file_id, ie))
def _ensure_directory(self, path):
"""Ensure that the containing directory exists for 'path'"""
dirname, basename = osutils.split(path)
if dirname == '':
# the root node doesn't get updated
return basename, inventory.ROOT_ID
try:
ie = self.cache_mgr.directory_entries[dirname]
except KeyError:
# We will create this entry, since it doesn't exist
pass
else:
return basename, ie
# No directory existed, we will just create one, first, make sure
# the parent exists
dir_basename, parent_ie = self._ensure_directory(dirname)
dir_file_id = self.bzr_file_id(dirname)
ie = inventory.entry_factory['directory'](dir_file_id,
dir_basename,
parent_ie.file_id)
ie.revision = self.revision_id
self.cache_mgr.directory_entries[dirname] = ie
self.inv_delta.append((None, path, dir_file_id, ie))
return basename, ie
|