/breezy-svn/trunk

To get this branch, use:
bzr branch https://code.breezy-vcs.org/breezy-svn/trunk
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
# Copyright (C) 2006-2009 Jelmer Vernooij <jelmer@samba.org>

# 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


"""Cache of the Subversion history log."""

from __future__ import absolute_import

import subvertpy

from breezy import (
    debug,
    ui,
    trace,
    )
from breezy.errors import (
    NoSuchRevision,
    )
from breezy.sixish import (
    text_type,
    )

from breezy.plugins.svn import (
    changes,
    errors as bzrsvn_errors,
    )
from breezy.plugins.svn.cache import (
    CacheConcurrencyError,
    )
from breezy.plugins.svn.transport import (
    SvnRaTransport,
    )
from breezy.plugins.svn.util import (
    lazy_dict,
    )

from subvertpy import NODE_UNKNOWN


# Maximum number of extra revisions to fetch in caching logwalker
MAX_OVERHEAD_FETCH = 1000

def iter_all_changes(from_revnum, to_revnum, get_revision_paths,
    revprop_list, limit=0):
    revnum = from_revnum
    ascending = (to_revnum > from_revnum)
    i = 0
    while ((not ascending and revnum >= to_revnum) or
           (ascending and revnum <= to_revnum)):
        revpaths = get_revision_paths(revnum)
        assert all(isinstance(p, text_type) for p in revpaths)

        # Report this revision if any affected paths are changed
        yield (revpaths, revnum, revprop_list(revnum))
        i += 1
        if limit != 0 and i == limit:
            break

        if ascending:
            revnum += 1
        else:
            revnum -= 1


def iter_changes(prefixes, from_revnum, to_revnum, get_revision_paths,
    revprop_list, limit=0):
    """Iter changes.

    :param prefix: Sequence of paths
    :param from_revnum: Start revision number
    :param to_revnum: End revision number
    :param get_revision_paths: Callback to retrieve the paths
        for a particular revision
    :param revprop_list: Callback to retrieve the revision properties
        for a particular revision
    :param limit: Maximum number of revisions to yield, 0 for all
    :return: Iterator over (revpaths, revnum, revprops)
    """
    revnum = from_revnum

    if prefixes is not None:
        prefixes = set(prefixes)

    if prefixes in (None, set([u""]), set()):
        return iter_all_changes(from_revnum, to_revnum, get_revision_paths,
                revprop_list, limit)
    else:
        return iter_prefixes_changes(prefixes, from_revnum, to_revnum,
            get_revision_paths, revprop_list, limit)


def iter_prefixes_changes(from_prefixes, from_revnum, to_revnum,
    get_revision_paths, revprop_list, limit=0):
    assert type(from_prefixes) is set
    from_prefixes = set([p.strip(u"/") for p in from_prefixes])

    assert from_revnum >= to_revnum, "path: %r, %d >= %d" % (
            from_prefixes, from_revnum, to_revnum)

    revnum = from_revnum
    todo_prefixes = { revnum: from_prefixes }

    i = 0
    while revnum >= to_revnum:
        prefixes = todo_prefixes.pop(revnum)
        revpaths = get_revision_paths(revnum)
        assert all(isinstance(p, text_type) for p in revpaths)

        # Report this revision if any affected paths are changed
        if any(changes.changes_path(revpaths, prefix, True) for prefix in prefixes):
            assert isinstance(revnum, int)
            yield (revpaths, revnum, revprop_list(revnum))
            i += 1
            if limit != 0 and i == limit:
                break

        next = {}
        # Find the location of each prefix for the next iteration
        for prefix in prefixes:
            if not isinstance(prefix, text_type):
                raise TypeError(prefix)
            try:
                (p, r) = changes.find_prev_location(revpaths, prefix,
                        revnum)
            except TypeError:
                pass # didn't exist here
            else:
                assert r < revnum
                todo_prefixes.setdefault(r, set()).add(p)

        if todo_prefixes == {}:
            break
        revnum = max(todo_prefixes)


class LogCache(object):
    """Log browser cache manager. The methods of this class
    encapsulate the data access patterns used by CachingLogWalker to
    access the log cache."""

    def find_latest_change(self, path, revnum):
        """Find the last revision in which a particular path
        was changed.

        This is an optional operation: cache backends may choose not to
        implement it if they cannot efficiently perform this kind of lookup.

        :param path: Path to check
        :param revnum: Revision in which to check
        """
        raise NotImplementedError(self.find_latest_change)

    def get_revision_paths(self, revnum):
        """Return all history information for a given revision number.

        :param revnum: Revision number of revision.
        """
        raise NotImplementedError(self.get_revision_paths)

    def insert_paths(self, rev, orig_paths, revprops, all_revprops):
        """Insert new history information into the cache.

        :param rev: Revision number of the revision
        :param orig_paths: SVN-style changes dictionary
        """
        raise NotImplementedError(self.insert_paths)

    def drop_revprops(self, revnum):
        raise NotImplementedError(self.drop_revprops)

    def get_revprops(self, revnum):
        """Retrieve all the cached revision properties.

        :param revnum: Revision number of revision to retrieve revprops for.
        """
        raise NotImplementedError(self.get_revprops)

    def insert_revprops(self, revision, revprops, all):
        raise NotImplementedError(self.insert_revprops)

    def max_revnum(self):
        raise NotImplementedError(self.max_revnum)

    def min_revnum(self):
        raise NotImplementedError(self.min_revnum)


class CachingLogWalkerUpdater(object):
    """Function that can update a logwalker."""

    def __init__(self, logwalker, all_revprops):
        self.count = 0
        self.total = None
        self.pb = ui.ui_factory.nested_progress_bar()
        self.all_revprops = all_revprops
        self.logwalker = logwalker

    def __call__(self, orig_paths, revision, revprops, has_children=None):
        self.count += 1
        self.pb.update('fetching svn revision info', self.count, self.total)
        self.logwalker.cache.insert_paths(revision, orig_paths,
            revprops, self.all_revprops)
        self.logwalker.saved_maxrevnum = max(revision,
            self.logwalker.saved_maxrevnum)
        if self.logwalker.saved_minrevnum is None:
            self.logwalker.saved_minrevnum = revision
        else:
            self.logwalker.saved_minrevnum = min(revision,
                self.logwalker.saved_minrevnum)

    def finished(self):
        self.pb.finished()


class CachingLogWalker(object):
    """Subversion log browser."""

    def __init__(self, actual, cache):
        self.cache = cache
        self.actual = actual
        self.quick_revprops = actual.quick_revprops
        self._transport = actual._transport
        self.saved_maxrevnum = self.cache.max_revnum()
        self.saved_minrevnum = self.cache.min_revnum()
        self._latest_revnum = None

    def mutter(self, text, *args, **kwargs):
        if "logwalker" in debug.debug_flags:
            trace.mutter(text, *args, **kwargs)

    def _warn_busy_cache(self):
        trace.warning("Cache for repository %s busy, ignoring")

    def find_latest_change(self, path, revnum):
        """Find latest revision that touched path.

        :param path: Path to check for changes
        :param revnum: First revision to check
        """
        assert isinstance(path, text_type)
        assert isinstance(revnum, int) and revnum >= 0
        try:
            self._fetch_revisions(revnum)
        except CacheConcurrencyError:
            self._warn_busy_cache()
            return self.actual.find_latest_change(path, revnum)

        self.mutter("latest change: %r:%r", path, revnum)
        try:
            revnum = self.cache.find_latest_change(path.strip(u"/"), revnum)
        except NotImplementedError:
            return self.actual.find_latest_change(path, revnum)
        if revnum is None and path == u"":
            return 0

        return revnum

    def iter_changes(self, prefixes, from_revnum, to_revnum=0, limit=0, pb=None):
        """Return iterator over all the revisions in a range.

        :param prefixes: Prefixes of paths to report about
        :param from_revnum: Start revision.
        :param to_revnum: End revision.
        :return: An iterator that yields tuples with (paths, revnum, revprops)
            where paths is a dictionary with all changes that happened
            in revnum.
        """
        assert from_revnum >= 0 and to_revnum >= 0, "%r -> %r" % (from_revnum, to_revnum)
        self.mutter("iter changes %r->%r (%r)", from_revnum, to_revnum, prefixes)
        try:
            self._fetch_revisions(max(from_revnum, to_revnum), pb=pb)
        except CacheConcurrencyError:
            self._warn_busy_cache()
            return self.actual.iter_changes(prefixes, from_revnum, to_revnum,
                    limit, pb)
        return iter(iter_changes(prefixes, from_revnum, to_revnum,
            self.get_revision_paths, self.revprop_list, limit))

    def get_revision_paths(self, revnum):
        if revnum == 0:
            return changes.REV0_CHANGES
        try:
            self._fetch_revisions(revnum)
        except CacheConcurrencyError:
            self._warn_busy_cache()
            return self.actual.get_revision_paths(revnum)
        else:
            return self.cache.get_revision_paths(revnum)

    def revprop_list(self, revnum):
        self.mutter('revprop list: %d' % revnum)
        try:
            self._fetch_revisions(revnum)
        except CacheConcurrencyError:
            self._warn_busy_cache()
            return self.actual.revprop_list(revnum)

        if revnum > 0:
            (known_revprops, has_all_revprops) = self.cache.get_revprops(revnum)
        else:
            has_all_revprops = False
            known_revprops = {}

        if has_all_revprops:
            return known_revprops

        return lazy_dict(known_revprops, self._caching_revprop_list, revnum)

    def _caching_revprop_list(self, revnum):
        revprops = self._transport.revprop_list(revnum)
        try:
            self.cache.insert_revprops(revnum, revprops, True)
            self.cache.commit()
        except CacheConcurrencyError:
            pass
        return revprops

    def _fetch_revisions(self, to_revnum, pb=None):
        """Fetch information about all revisions in the remote repository
        until to_revnum.

        :param to_revnum: End of range to fetch information for
        """
        assert isinstance(self.saved_maxrevnum, int)

        if to_revnum <= self.saved_maxrevnum and self.saved_minrevnum == 0:
            return

        # Try to fetch log data in lumps, if possible.
        if self._latest_revnum is None:
            self._latest_revnum = self.actual._transport.get_latest_revnum()
        assert isinstance(self._latest_revnum, int)
        to_revnum = max(min(self._latest_revnum, to_revnum+MAX_OVERHEAD_FETCH),
                        to_revnum)

        # Subversion 1.4 clients and servers can only deliver a limited set of
        # revprops
        if self._transport.has_capability("log-revprops"):
            todo_revprops = None
        else:
            todo_revprops = ["svn:author", "svn:log", "svn:date"]

        rcvr = CachingLogWalkerUpdater(self, todo_revprops is None)
        try:
            try:
                # The get_log bounds are inclusive at both ends, so the total
                # number of revisions requested is A - B.
                rcvr.total = to_revnum - self.saved_maxrevnum
                # Try to keep the cache consistent by closing any holes early
                # in the history
                if self.saved_minrevnum:
                    rcvr.total += self.saved_minrevnum
                    self.mutter("get_log %d->%d", self.saved_minrevnum, 0)
                    self.actual._transport.get_log(rcvr, [u""],
                        self.saved_minrevnum - 1, 0, 0, True, True, False,
                        todo_revprops)
                    if self.saved_minrevnum:
                        raise bzrsvn_errors.IncompleteRepositoryHistory(
                            "first available revision: %d" % self.saved_minrevnum)
                if to_revnum > self.saved_maxrevnum:
                    self.mutter("get_log %d->%d", to_revnum,
                            self.saved_maxrevnum)
                    self.actual._transport.get_log(rcvr, [u""], to_revnum,
                        self.saved_maxrevnum, 0, True, True, False,
                        todo_revprops)
                    if to_revnum > self.saved_maxrevnum and to_revnum > 0:
                        raise bzrsvn_errors.IncompleteRepositoryHistory(
                            "last available revision: %d" % self.saved_maxrevnum)
            except subvertpy.SubversionException, (msg, num):
                if num == subvertpy.ERR_FS_NO_SUCH_REVISION:
                    raise NoSuchRevision(branch=self,
                        revision="Revision number %d: %s" % (to_revnum, msg))
                raise
        finally:
            rcvr.finished()
            self.cache.commit()


def strip_slashes(changed_paths):
    """Strip the leading and trailing slashes in paths.

    :param changed_paths: Changed paths dictionary
    :return: Update paths dictionary
    """
    if changed_paths is None:
        return {}
    assert type(changed_paths) is dict
    revpaths = {}
    for k, v in changed_paths.iteritems():
        try:
            kind = v[3]
        except IndexError:
            kind = NODE_UNKNOWN
        if v[1] is None:
            copyfrom_path = None
        else:
            copyfrom_path = v[1].strip(u"/")
        revpaths[k.strip(u"/")] = (v[0], copyfrom_path, v[2], kind)
    return revpaths


class LogWalker(object):
    """Easy way to access the history of a Subversion repository."""

    def __init__(self, transport, limit=None):
        """Create a new instance.

        :param transport:   SvnRaTransport to use to access the repository.
        """
        assert isinstance(transport, SvnRaTransport)

        self._transport = transport
        self.quick_revprops = (self._transport.has_capability("log-revprops") == True)

    def find_latest_change(self, path, revnum):
        """Find latest revision that touched path.

        :param path: Path to check for changes
        :param revnum: First revision to check
        """
        assert isinstance(path, text_type)
        assert isinstance(revnum, int) and revnum >= 0

        try:
            return self._transport.iter_log([path], revnum, 0, 2, True, False,
                    False, []).next()[1]
        except subvertpy.SubversionException, (_, num):
            if num == subvertpy.ERR_FS_NO_SUCH_REVISION:
                raise NoSuchRevision(branch=self,
                    revision="Revision number %d" % revnum)
            if num == subvertpy.ERR_FS_NOT_FOUND:
                return None
            raise

    def revprop_list(self, revnum):
        return lazy_dict({}, self._transport.revprop_list, revnum)

    def iter_changes(self, prefixes, from_revnum, to_revnum=0, limit=0, pb=None):
        """Return iterator over all the revisions between revnum and 0 named
        path or inside path.

        :param prefixes:    Prefixes to report about (in from_revnum)
        :param from_revnum:  Start revision.
        :param to_revnum: End revision.
        :return: An iterator that yields tuples with (paths, revnum, revprops)
            where paths is a dictionary with all changes that happened in revnum.
        """
        assert from_revnum >= 0 and to_revnum >= 0

        # Subversion 1.4 clients and servers can only deliver a limited set of revprops
        if self._transport.has_capability("log-revprops"):
            todo_revprops = None
        else:
            todo_revprops = ["svn:author", "svn:log", "svn:date"]

        try:
            iterator = self._transport.iter_log(prefixes, from_revnum,
                to_revnum, limit, True, False, False, revprops=todo_revprops)

            for (changed_paths, revnum, known_revprops, has_children) in iterator:
                if revnum == 0 and changed_paths is None:
                    revpaths = changes.REV0_CHANGES
                elif isinstance(changed_paths, dict):
                    revpaths = strip_slashes(changed_paths)
                else:
                    revpaths = {}
                if todo_revprops is None:
                    revprops = known_revprops
                    if revprops is None:
                        revprops = {}
                else:
                    revprops = lazy_dict(known_revprops, self._transport.revprop_list,
                        revnum)
                yield (revpaths, revnum, revprops)
        except subvertpy.SubversionException, (_, num):
            if num == subvertpy.ERR_FS_NO_SUCH_REVISION:
                raise NoSuchRevision(branch=self,
                    revision="Revision number %d" % from_revnum)
            raise

    def get_revision_paths(self, revnum):
        """Obtain dictionary with all the changes in a particular revision.

        :param revnum: Subversion revision number
        :returns: dictionary with paths as keys and
                  (action, copyfrom_path, copyfrom_rev) as values.
        """
        # To make the existing code happy:
        if revnum == 0:
            return changes.REV0_CHANGES

        try:
            log_iter = self._transport.iter_log([u""], revnum, revnum, 1, True,
                True, False, [])
            return strip_slashes(log_iter.next()[0])
        except subvertpy.SubversionException, (_, num):
            if num == subvertpy.ERR_FS_NO_SUCH_REVISION:
                raise NoSuchRevision(branch=self,
                    revision="Revision number %d" % revnum)
            raise


class DictBasedLogWalker(object):

    def __init__(self, paths, revprops):
        self.paths = paths
        self.revprops = revprops

    def iter_changes(self, prefixes, from_revnum, to_revnum=0, limit=0,
            pb=None):
        return iter(iter_changes(prefixes, from_revnum, to_revnum,
            self.get_revision_paths, self.revprop_list, limit))

    def get_revision_paths(self, revnum):
        if revnum == 0:
            return changes.REV0_CHANGES

        return self.paths.get(revnum, {})

    def revprop_list(self, revnum):
        if revnum == 0:
            return {}
        return self.revprops.get(revnum, {})