/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Vincent Ladeuil
  • Date: 2007-11-24 14:20:59 UTC
  • mto: (3928.1.1 bzr.integration)
  • mto: This revision was merged to the branch mainline in revision 3929.
  • Revision ID: v.ladeuil+lp@free.fr-20071124142059-2114qtsgfdv8g9p1
Ssl files needed for the test https server.

* bzrlib/tests/ssl_certs/create_ssls.py: 
Script to create the ssl keys and certificates.

* bzrlib/tests/ssl_certs/server.crt: 
Server certificate signed by the certificate authority.

* bzrlib/tests/ssl_certs/server.csr: 
Server certificate signing request.

* bzrlib/tests/ssl_certs/server_without_pass.key: 
Server key usable without password.

* bzrlib/tests/ssl_certs/server_with_pass.key: 
Server key.

* bzrlib/tests/ssl_certs/ca.key: 
Certificate authority private key.

* bzrlib/tests/ssl_certs/ca.crt: 
Certificate authority certificate.

* bzrlib/tests/ssl_certs/__init__.py: 
Provide access to ssl files (keys and certificates). 

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
from __future__ import absolute_import
18
17
 
19
18
# The newly committed revision is going to have a shape corresponding
20
19
# to that of the working tree.  Files that are not in the
50
49
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
51
50
# the rest of the code; add a deprecation of the old name.
52
51
 
53
 
from . import (
 
52
import os
 
53
import re
 
54
import sys
 
55
import time
 
56
 
 
57
from cStringIO import StringIO
 
58
 
 
59
from bzrlib import (
54
60
    debug,
55
61
    errors,
56
 
    trace,
 
62
    revision,
57
63
    tree,
58
 
    ui,
59
64
    )
60
 
from .branch import Branch
61
 
from .cleanup import OperationWithCleanups
62
 
import breezy.config
63
 
from .errors import (BzrError,
64
 
                     ConflictsInTree,
65
 
                     StrictCommitFailed
66
 
                     )
67
 
from .osutils import (get_user_encoding,
68
 
                      is_inside_any,
69
 
                      minimum_path_selection,
70
 
                      splitpath,
71
 
                      )
72
 
from .trace import mutter, note, is_quiet
73
 
from .urlutils import unescape_for_display
74
 
from .i18n import gettext
75
 
 
76
 
 
77
 
class PointlessCommit(BzrError):
78
 
 
79
 
    _fmt = "No changes to commit"
80
 
 
81
 
 
82
 
class CannotCommitSelectedFileMerge(BzrError):
83
 
 
84
 
    _fmt = 'Selected-file commit of merges is not supported yet:'\
85
 
        ' files %(files_str)s'
86
 
 
87
 
    def __init__(self, files):
88
 
        files_str = ', '.join(files)
89
 
        BzrError.__init__(self, files=files, files_str=files_str)
90
 
 
91
 
 
92
 
def filter_excluded(iter_changes, exclude):
93
 
    """Filter exclude filenames.
94
 
 
95
 
    :param iter_changes: iter_changes function
96
 
    :param exclude: List of paths to exclude
97
 
    :return: iter_changes function
98
 
    """
99
 
    for change in iter_changes:
100
 
        old_path = change[1][0]
101
 
        new_path = change[1][1]
102
 
 
103
 
        new_excluded = (new_path is not None and
104
 
            is_inside_any(exclude, new_path))
105
 
 
106
 
        old_excluded = (old_path is not None and
107
 
            is_inside_any(exclude, old_path))
108
 
 
109
 
        if old_excluded and new_excluded:
110
 
            continue
111
 
 
112
 
        if old_excluded or new_excluded:
113
 
            # TODO(jelmer): Perhaps raise an error here instead?
114
 
            continue
115
 
 
116
 
        yield change
 
65
from bzrlib.branch import Branch
 
66
import bzrlib.config
 
67
from bzrlib.errors import (BzrError, PointlessCommit,
 
68
                           ConflictsInTree,
 
69
                           StrictCommitFailed
 
70
                           )
 
71
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
 
72
                            is_inside_or_parent_of_any,
 
73
                            minimum_path_selection,
 
74
                            quotefn, sha_file, split_lines)
 
75
from bzrlib.testament import Testament
 
76
from bzrlib.trace import mutter, note, warning, is_quiet
 
77
from bzrlib.xml5 import serializer_v5
 
78
from bzrlib.inventory import InventoryEntry, make_entry
 
79
from bzrlib import symbol_versioning
 
80
from bzrlib.symbol_versioning import (deprecated_passed,
 
81
        deprecated_function,
 
82
        DEPRECATED_PARAMETER)
 
83
from bzrlib.workingtree import WorkingTree
 
84
from bzrlib.urlutils import unescape_for_display
 
85
import bzrlib.ui
117
86
 
118
87
 
119
88
class NullCommitReporter(object):
120
89
    """I report on progress of a commit."""
121
90
 
122
 
    def started(self, revno, revid, location):
 
91
    def started(self, revno, revid, location=None):
123
92
        pass
124
93
 
125
94
    def snapshot_change(self, change, path):
128
97
    def completed(self, revno, rev_id):
129
98
        pass
130
99
 
131
 
    def deleted(self, path):
 
100
    def deleted(self, file_id):
 
101
        pass
 
102
 
 
103
    def escaped(self, escape_count, message):
132
104
        pass
133
105
 
134
106
    def missing(self, path):
151
123
        note(format, *args)
152
124
 
153
125
    def snapshot_change(self, change, path):
154
 
        if path == '' and change in (gettext('added'), gettext('modified')):
 
126
        if change == 'unchanged':
 
127
            return
 
128
        if change == 'added' and path == '':
155
129
            return
156
130
        self._note("%s %s", change, path)
157
131
 
158
 
    def started(self, revno, rev_id, location):
159
 
        self._note(
160
 
            gettext('Committing to: %s'),
161
 
            unescape_for_display(location, 'utf-8'))
 
132
    def started(self, revno, rev_id, location=None):
 
133
        if location is not None:
 
134
            location = ' to "' + unescape_for_display(location, 'utf-8') + '"'
 
135
        else:
 
136
            location = ''
 
137
        self._note('Committing revision %d%s.', revno, location)
162
138
 
163
139
    def completed(self, revno, rev_id):
164
 
        self._note(gettext('Committed revision %d.'), revno)
165
 
        # self._note goes to the console too; so while we want to log the
166
 
        # rev_id, we can't trivially only log it. (See bug 526425). Long
167
 
        # term we should rearrange the reporting structure, but for now
168
 
        # we just mutter seperately. We mutter the revid and revno together
169
 
        # so that concurrent bzr invocations won't lead to confusion.
170
 
        mutter('Committed revid %s as revno %d.', rev_id, revno)
171
 
 
172
 
    def deleted(self, path):
173
 
        self._note(gettext('deleted %s'), path)
 
140
        self._note('Committed revision %d.', revno)
 
141
 
 
142
    def deleted(self, file_id):
 
143
        self._note('deleted %s', file_id)
 
144
 
 
145
    def escaped(self, escape_count, message):
 
146
        self._note("replaced %d control characters in message", escape_count)
174
147
 
175
148
    def missing(self, path):
176
 
        self._note(gettext('missing %s'), path)
 
149
        self._note('missing %s', path)
177
150
 
178
151
    def renamed(self, change, old_path, new_path):
179
152
        self._note('%s %s => %s', change, old_path, new_path)
196
169
    """
197
170
    def __init__(self,
198
171
                 reporter=None,
199
 
                 config_stack=None):
 
172
                 config=None):
200
173
        """Create a Commit object.
201
174
 
202
175
        :param reporter: the default reporter to use or None to decide later
203
176
        """
204
177
        self.reporter = reporter
205
 
        self.config_stack = config_stack
206
 
 
207
 
    @staticmethod
208
 
    def update_revprops(revprops, branch, authors=None,
209
 
                        local=False, possible_master_transports=None):
210
 
        if revprops is None:
211
 
            revprops = {}
212
 
        if possible_master_transports is None:
213
 
            possible_master_transports = []
214
 
        if (not u'branch-nick' in revprops and
215
 
                branch.repository._format.supports_storing_branch_nick):
216
 
            revprops[u'branch-nick'] = branch._get_nick(
217
 
                local,
218
 
                possible_master_transports)
219
 
        if authors is not None:
220
 
            if u'author' in revprops or u'authors' in revprops:
221
 
                # XXX: maybe we should just accept one of them?
222
 
                raise AssertionError('author property given twice')
223
 
            if authors:
224
 
                for individual in authors:
225
 
                    if '\n' in individual:
226
 
                        raise AssertionError('\\n is not a valid character '
227
 
                                'in an author identity')
228
 
                revprops[u'authors'] = '\n'.join(authors)
229
 
        return revprops
 
178
        self.config = config
230
179
 
231
180
    def commit(self,
232
181
               message=None,
244
193
               reporter=None,
245
194
               config=None,
246
195
               message_callback=None,
247
 
               recursive='down',
248
 
               exclude=None,
249
 
               possible_master_transports=None,
250
 
               lossy=False):
 
196
               recursive='down'):
251
197
        """Commit working copy as a new revision.
252
198
 
253
199
        :param message: the commit message (it or message_callback is required)
254
 
        :param message_callback: A callback: message = message_callback(cmt_obj)
255
200
 
256
201
        :param timestamp: if not None, seconds-since-epoch for a
257
202
            postdated/predated commit.
258
203
 
259
 
        :param specific_files: If not None, commit only those files. An empty
260
 
            list means 'commit no files'.
 
204
        :param specific_files: If true, commit only those files.
261
205
 
262
206
        :param rev_id: If set, use this as the new revision id.
263
207
            Useful for test or import commands that need to tightly
277
221
        :param verbose: if True and the reporter is not None, report everything
278
222
        :param recursive: If set to 'down', commit in any subtrees that have
279
223
            pending changes of any sort during this commit.
280
 
        :param exclude: None or a list of relative paths to exclude from the
281
 
            commit. Pending changes to excluded files will be ignored by the
282
 
            commit.
283
 
        :param lossy: When committing to a foreign VCS, ignore any
284
 
            data that can not be natively represented.
285
224
        """
286
 
        operation = OperationWithCleanups(self._commit)
287
 
        self.revprops = revprops or {}
288
 
        # XXX: Can be set on __init__ or passed in - this is a bit ugly.
289
 
        self.config_stack = config or self.config_stack
290
 
        return operation.run(
291
 
               message=message,
292
 
               timestamp=timestamp,
293
 
               timezone=timezone,
294
 
               committer=committer,
295
 
               specific_files=specific_files,
296
 
               rev_id=rev_id,
297
 
               allow_pointless=allow_pointless,
298
 
               strict=strict,
299
 
               verbose=verbose,
300
 
               working_tree=working_tree,
301
 
               local=local,
302
 
               reporter=reporter,
303
 
               message_callback=message_callback,
304
 
               recursive=recursive,
305
 
               exclude=exclude,
306
 
               possible_master_transports=possible_master_transports,
307
 
               lossy=lossy)
308
 
 
309
 
    def _commit(self, operation, message, timestamp, timezone, committer,
310
 
            specific_files, rev_id, allow_pointless, strict, verbose,
311
 
            working_tree, local, reporter, message_callback, recursive,
312
 
            exclude, possible_master_transports, lossy):
313
225
        mutter('preparing to commit')
314
226
 
315
227
        if working_tree is None:
322
234
                    raise errors.RootNotRich()
323
235
        if message_callback is None:
324
236
            if message is not None:
325
 
                if isinstance(message, bytes):
326
 
                    message = message.decode(get_user_encoding())
 
237
                if isinstance(message, str):
 
238
                    message = message.decode(bzrlib.user_encoding)
327
239
                message_callback = lambda x: message
328
240
            else:
329
241
                raise BzrError("The message or message_callback keyword"
330
242
                               " parameter is required for commit().")
331
243
 
332
244
        self.bound_branch = None
 
245
        self.any_entries_changed = False
333
246
        self.any_entries_deleted = False
334
 
        if exclude is not None:
335
 
            self.exclude = sorted(
336
 
                minimum_path_selection(exclude))
337
 
        else:
338
 
            self.exclude = []
339
247
        self.local = local
340
248
        self.master_branch = None
 
249
        self.master_locked = False
341
250
        self.recursive = recursive
342
251
        self.rev_id = None
343
 
        # self.specific_files is None to indicate no filter, or any iterable to
344
 
        # indicate a filter - [] means no files at all, as per iter_changes.
345
252
        if specific_files is not None:
346
253
            self.specific_files = sorted(
347
254
                minimum_path_selection(specific_files))
348
255
        else:
349
256
            self.specific_files = None
350
 
 
 
257
        self.specific_file_ids = None
351
258
        self.allow_pointless = allow_pointless
 
259
        self.revprops = revprops
352
260
        self.message_callback = message_callback
353
261
        self.timestamp = timestamp
354
262
        self.timezone = timezone
355
263
        self.committer = committer
356
264
        self.strict = strict
357
265
        self.verbose = verbose
 
266
        # accumulates an inventory delta to the basis entry, so we can make
 
267
        # just the necessary updates to the workingtree's cached basis.
 
268
        self._basis_delta = []
358
269
 
359
270
        self.work_tree.lock_write()
360
 
        operation.add_cleanup(self.work_tree.unlock)
361
 
        self.parents = self.work_tree.get_parent_ids()
362
 
        self.pb = ui.ui_factory.nested_progress_bar()
363
 
        operation.add_cleanup(self.pb.finished)
 
271
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
364
272
        self.basis_revid = self.work_tree.last_revision()
365
273
        self.basis_tree = self.work_tree.basis_tree()
366
274
        self.basis_tree.lock_read()
367
 
        operation.add_cleanup(self.basis_tree.unlock)
368
 
        # Cannot commit with conflicts present.
369
 
        if len(self.work_tree.conflicts()) > 0:
370
 
            raise ConflictsInTree
371
 
 
372
 
        # Setup the bound branch variables as needed.
373
 
        self._check_bound_branch(operation, possible_master_transports)
374
 
 
375
 
        # Check that the working tree is up to date
376
 
        old_revno, old_revid, new_revno = self._check_out_of_date_tree()
377
 
 
378
 
        # Complete configuration setup
379
 
        if reporter is not None:
380
 
            self.reporter = reporter
381
 
        elif self.reporter is None:
382
 
            self.reporter = self._select_reporter()
383
 
        if self.config_stack is None:
384
 
            self.config_stack = self.work_tree.get_config_stack()
385
 
 
386
 
        # Setup the progress bar. As the number of files that need to be
387
 
        # committed in unknown, progress is reported as stages.
388
 
        # We keep track of entries separately though and include that
389
 
        # information in the progress bar during the relevant stages.
390
 
        self.pb_stage_name = ""
391
 
        self.pb_stage_count = 0
392
 
        self.pb_stage_total = 5
393
 
        if self.bound_branch:
394
 
            # 2 extra stages: "Uploading data to master branch" and "Merging
395
 
            # tags to master branch"
396
 
            self.pb_stage_total += 2
397
 
        self.pb.show_pct = False
398
 
        self.pb.show_spinner = False
399
 
        self.pb.show_eta = False
400
 
        self.pb.show_count = True
401
 
        self.pb.show_bar = True
402
 
 
403
 
        # After a merge, a selected file commit is not supported.
404
 
        # See 'bzr help merge' for an explanation as to why.
405
 
        if len(self.parents) > 1 and self.specific_files is not None:
406
 
            raise CannotCommitSelectedFileMerge(self.specific_files)
407
 
        # Excludes are a form of selected file commit.
408
 
        if len(self.parents) > 1 and self.exclude:
409
 
            raise CannotCommitSelectedFileMerge(self.exclude)
410
 
 
411
 
        # Collect the changes
412
 
        self._set_progress_stage("Collecting changes", counter=True)
413
 
        self._lossy = lossy
414
 
        self.builder = self.branch.get_commit_builder(self.parents,
415
 
            self.config_stack, timestamp, timezone, committer, self.revprops,
416
 
            rev_id, lossy=lossy)
417
 
 
418
 
        if self.builder.updates_branch and self.bound_branch:
419
 
            self.builder.abort()
420
 
            raise AssertionError(
421
 
                "bound branches not supported for commit builders "
422
 
                "that update the branch")
423
 
 
424
275
        try:
425
 
            # find the location being committed to
 
276
            # Cannot commit with conflicts present.
 
277
            if len(self.work_tree.conflicts()) > 0:
 
278
                raise ConflictsInTree
 
279
 
 
280
            # Setup the bound branch variables as needed.
 
281
            self._check_bound_branch()
 
282
 
 
283
            # Check that the working tree is up to date
 
284
            old_revno, new_revno = self._check_out_of_date_tree()
 
285
 
 
286
            # Complete configuration setup
 
287
            if reporter is not None:
 
288
                self.reporter = reporter
 
289
            elif self.reporter is None:
 
290
                self.reporter = self._select_reporter()
 
291
            if self.config is None:
 
292
                self.config = self.branch.get_config()
 
293
 
 
294
            # If provided, ensure the specified files are versioned
 
295
            if self.specific_files is not None:
 
296
                # Note: This routine is being called because it raises
 
297
                # PathNotVersionedError as a side effect of finding the IDs. We
 
298
                # later use the ids we found as input to the working tree
 
299
                # inventory iterator, so we only consider those ids rather than
 
300
                # examining the whole tree again.
 
301
                # XXX: Dont we have filter_unversioned to do this more
 
302
                # cheaply?
 
303
                self.specific_file_ids = tree.find_ids_across_trees(
 
304
                    specific_files, [self.basis_tree, self.work_tree])
 
305
 
 
306
            # Setup the progress bar. As the number of files that need to be
 
307
            # committed in unknown, progress is reported as stages.
 
308
            # We keep track of entries separately though and include that
 
309
            # information in the progress bar during the relevant stages.
 
310
            self.pb_stage_name = ""
 
311
            self.pb_stage_count = 0
 
312
            self.pb_stage_total = 5
426
313
            if self.bound_branch:
427
 
                master_location = self.master_branch.base
428
 
            else:
429
 
                master_location = self.branch.base
430
 
 
431
 
            # report the start of the commit
432
 
            self.reporter.started(new_revno, self.rev_id, master_location)
433
 
 
434
 
            self._update_builder_with_changes()
435
 
            self._check_pointless()
436
 
 
437
 
            # TODO: Now the new inventory is known, check for conflicts.
438
 
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
439
 
            # weave lines, because nothing should be recorded until it is known
440
 
            # that commit will succeed.
441
 
            self._set_progress_stage("Saving data locally")
442
 
            self.builder.finish_inventory()
443
 
 
444
 
            # Prompt the user for a commit message if none provided
445
 
            message = message_callback(self)
446
 
            self.message = message
447
 
 
448
 
            # Add revision data to the local branch
449
 
            self.rev_id = self.builder.commit(self.message)
450
 
 
451
 
        except Exception as e:
452
 
            mutter("aborting commit write group because of exception:")
453
 
            trace.log_exception_quietly()
454
 
            self.builder.abort()
455
 
            raise
456
 
 
457
 
        self._update_branches(old_revno, old_revid, new_revno)
458
 
 
459
 
        # Make the working tree be up to date with the branch. This
460
 
        # includes automatic changes scheduled to be made to the tree, such
461
 
        # as updating its basis and unversioning paths that were missing.
462
 
        self.work_tree.unversion(self.deleted_paths)
463
 
        self._set_progress_stage("Updating the working tree")
464
 
        self.work_tree.update_basis_by_delta(self.rev_id,
465
 
             self.builder.get_basis_delta())
466
 
        self.reporter.completed(new_revno, self.rev_id)
467
 
        self._process_post_hooks(old_revno, new_revno)
468
 
        return self.rev_id
469
 
 
470
 
    def _update_branches(self, old_revno, old_revid, new_revno):
471
 
        """Update the master and local branch to the new revision.
472
 
 
473
 
        This will try to make sure that the master branch is updated
474
 
        before the local branch.
475
 
 
476
 
        :param old_revno: Revision number of master branch before the
477
 
            commit
478
 
        :param old_revid: Tip of master branch before the commit
479
 
        :param new_revno: Revision number of the new commit
480
 
        """
481
 
        if not self.builder.updates_branch:
 
314
                self.pb_stage_total += 1
 
315
            self.pb.show_pct = False
 
316
            self.pb.show_spinner = False
 
317
            self.pb.show_eta = False
 
318
            self.pb.show_count = True
 
319
            self.pb.show_bar = True
 
320
 
 
321
            # After a merge, a selected file commit is not supported.
 
322
            # See 'bzr help merge' for an explanation as to why.
 
323
            self.basis_inv = self.basis_tree.inventory
 
324
            self._gather_parents()
 
325
            if len(self.parents) > 1 and self.specific_files:
 
326
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
327
 
 
328
            # Collect the changes
 
329
            self._set_progress_stage("Collecting changes",
 
330
                    entries_title="Directory")
 
331
            self.builder = self.branch.get_commit_builder(self.parents,
 
332
                self.config, timestamp, timezone, committer, revprops, rev_id)
 
333
            
 
334
            try:
 
335
                # find the location being committed to
 
336
                if self.bound_branch:
 
337
                    master_location = self.master_branch.base
 
338
                else:
 
339
                    master_location = self.branch.base
 
340
 
 
341
                # report the start of the commit
 
342
                self.reporter.started(new_revno, self.rev_id, master_location)
 
343
 
 
344
                self._update_builder_with_changes()
 
345
                self._report_and_accumulate_deletes()
 
346
                self._check_pointless()
 
347
 
 
348
                # TODO: Now the new inventory is known, check for conflicts.
 
349
                # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
350
                # weave lines, because nothing should be recorded until it is known
 
351
                # that commit will succeed.
 
352
                self._set_progress_stage("Saving data locally")
 
353
                self.builder.finish_inventory()
 
354
 
 
355
                # Prompt the user for a commit message if none provided
 
356
                message = message_callback(self)
 
357
                assert isinstance(message, unicode), type(message)
 
358
                self.message = message
 
359
                self._escape_commit_message()
 
360
 
 
361
                # Add revision data to the local branch
 
362
                self.rev_id = self.builder.commit(self.message)
 
363
 
 
364
            except:
 
365
                self.builder.abort()
 
366
                raise
 
367
 
482
368
            self._process_pre_hooks(old_revno, new_revno)
483
369
 
484
370
            # Upload revision data to the master.
485
371
            # this will propagate merged revisions too if needed.
486
372
            if self.bound_branch:
487
373
                self._set_progress_stage("Uploading data to master branch")
 
374
                self.master_branch.repository.fetch(self.branch.repository,
 
375
                                                    revision_id=self.rev_id)
 
376
                # now the master has the revision data
488
377
                # 'commit' to the master first so a timeout here causes the
489
378
                # local branch to be out of date
490
 
                (new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
491
 
                    self.branch, new_revno, self.rev_id, lossy=self._lossy)
492
 
                if self._lossy:
493
 
                    self.branch.fetch(self.master_branch, self.rev_id)
 
379
                self.master_branch.set_last_revision_info(new_revno,
 
380
                                                          self.rev_id)
494
381
 
495
382
            # and now do the commit locally.
496
383
            self.branch.set_last_revision_info(new_revno, self.rev_id)
497
 
        else:
498
 
            try:
499
 
                self._process_pre_hooks(old_revno, new_revno)
500
 
            except:
501
 
                # The commit builder will already have updated the branch,
502
 
                # revert it.
503
 
                self.branch.set_last_revision_info(old_revno, old_revid)
504
 
                raise
505
384
 
506
 
        # Merge local tags to remote
507
 
        if self.bound_branch:
508
 
            self._set_progress_stage("Merging tags to master branch")
509
 
            tag_updates, tag_conflicts = self.branch.tags.merge_to(
510
 
                self.master_branch.tags)
511
 
            if tag_conflicts:
512
 
                warning_lines = ['    ' + name for name, _, _ in tag_conflicts]
513
 
                note( gettext("Conflicting tags in bound branch:\n{0}".format(
514
 
                    "\n".join(warning_lines))) )
 
385
            # Make the working tree up to date with the branch
 
386
            self._set_progress_stage("Updating the working tree")
 
387
            self.work_tree.update_basis_by_delta(self.rev_id,
 
388
                 self._basis_delta)
 
389
            self.reporter.completed(new_revno, self.rev_id)
 
390
            self._process_post_hooks(old_revno, new_revno)
 
391
        finally:
 
392
            self._cleanup()
 
393
        return self.rev_id
515
394
 
516
395
    def _select_reporter(self):
517
396
        """Select the CommitReporter to use."""
525
404
        # A merge with no effect on files
526
405
        if len(self.parents) > 1:
527
406
            return
528
 
        if self.builder.any_changes():
 
407
        # TODO: we could simplify this by using self._basis_delta.
 
408
 
 
409
        # The initial commit adds a root directory, but this in itself is not
 
410
        # a worthwhile commit.
 
411
        if (self.basis_revid == revision.NULL_REVISION and
 
412
            len(self.builder.new_inventory) == 1):
 
413
            raise PointlessCommit()
 
414
        # If length == 1, then we only have the root entry. Which means
 
415
        # that there is no real difference (only the root could be different)
 
416
        # unless deletes occured, in which case the length is irrelevant.
 
417
        if (self.any_entries_deleted or 
 
418
            (len(self.builder.new_inventory) != 1 and
 
419
             self.any_entries_changed)):
529
420
            return
530
421
        raise PointlessCommit()
531
422
 
532
 
    def _check_bound_branch(self, operation, possible_master_transports=None):
 
423
    def _check_bound_branch(self):
533
424
        """Check to see if the local branch is bound.
534
425
 
535
426
        If it is bound, then most of the commit will actually be
540
431
            raise errors.LocalRequiresBoundBranch()
541
432
 
542
433
        if not self.local:
543
 
            self.master_branch = self.branch.get_master_branch(
544
 
                possible_master_transports)
 
434
            self.master_branch = self.branch.get_master_branch()
545
435
 
546
436
        if not self.master_branch:
547
437
            # make this branch the reference branch for out of date checks.
558
448
        #       commits to the remote branch if they would fit.
559
449
        #       But for now, just require remote to be identical
560
450
        #       to local.
561
 
 
 
451
        
562
452
        # Make sure the local branch is identical to the master
563
453
        master_info = self.master_branch.last_revision_info()
564
454
        local_info = self.branch.last_revision_info()
570
460
        # so grab the lock
571
461
        self.bound_branch = self.branch
572
462
        self.master_branch.lock_write()
573
 
        operation.add_cleanup(self.master_branch.unlock)
 
463
        self.master_locked = True
574
464
 
575
465
    def _check_out_of_date_tree(self):
576
466
        """Check that the working tree is up to date.
577
467
 
578
 
        :return: old_revision_number, old_revision_id, new_revision_number
579
 
            tuple
 
468
        :return: old_revision_number,new_revision_number tuple
580
469
        """
581
470
        try:
582
471
            first_tree_parent = self.work_tree.get_parent_ids()[0]
585
474
            # this is so that we still consider the master branch
586
475
            # - in a checkout scenario the tree may have no
587
476
            # parents but the branch may do.
588
 
            first_tree_parent = breezy.revision.NULL_REVISION
 
477
            first_tree_parent = bzrlib.revision.NULL_REVISION
589
478
        old_revno, master_last = self.master_branch.last_revision_info()
590
479
        if master_last != first_tree_parent:
591
 
            if master_last != breezy.revision.NULL_REVISION:
 
480
            if master_last != bzrlib.revision.NULL_REVISION:
592
481
                raise errors.OutOfDateTree(self.work_tree)
593
482
        if self.branch.repository.has_revision(first_tree_parent):
594
483
            new_revno = old_revno + 1
595
484
        else:
596
485
            # ghost parents never appear in revision history.
597
486
            new_revno = 1
598
 
        return old_revno, master_last, new_revno
 
487
        return old_revno,new_revno
599
488
 
600
489
    def _process_pre_hooks(self, old_revno, new_revno):
601
490
        """Process any registered pre commit hooks."""
607
496
        # Process the post commit hooks, if any
608
497
        self._set_progress_stage("Running post_commit hooks")
609
498
        # old style commit hooks - should be deprecated ? (obsoleted in
610
 
        # 0.15^H^H^H^H 2.5.0)
611
 
        post_commit = self.config_stack.get('post_commit')
612
 
        if post_commit is not None:
613
 
            hooks = post_commit.split(' ')
 
499
        # 0.15)
 
500
        if self.config.post_commit() is not None:
 
501
            hooks = self.config.post_commit().split(' ')
614
502
            # this would be nicer with twisted.python.reflect.namedAny
615
503
            for hook in hooks:
616
504
                result = eval(hook + '(branch, rev_id)',
617
505
                              {'branch':self.branch,
618
 
                               'breezy':breezy,
 
506
                               'bzrlib':bzrlib,
619
507
                               'rev_id':self.rev_id})
620
508
        # process new style post commit hooks
621
509
        self._process_hooks("post_commit", old_revno, new_revno)
623
511
    def _process_hooks(self, hook_name, old_revno, new_revno):
624
512
        if not Branch.hooks[hook_name]:
625
513
            return
626
 
 
 
514
        
627
515
        # new style commit hooks:
628
516
        if not self.bound_branch:
629
517
            hook_master = self.branch
637
525
        if self.parents:
638
526
            old_revid = self.parents[0]
639
527
        else:
640
 
            old_revid = breezy.revision.NULL_REVISION
641
 
 
 
528
            old_revid = bzrlib.revision.NULL_REVISION
 
529
        
642
530
        if hook_name == "pre_commit":
643
531
            future_tree = self.builder.revision_tree()
644
532
            tree_delta = future_tree.changes_from(self.basis_tree,
645
533
                                             include_root=True)
646
 
 
 
534
        
647
535
        for hook in Branch.hooks[hook_name]:
648
536
            # show the running hook in the progress bar. As hooks may
649
537
            # end up doing nothing (e.g. because they are not configured by
663
551
                     old_revno, old_revid, new_revno, self.rev_id,
664
552
                     tree_delta, future_tree)
665
553
 
 
554
    def _cleanup(self):
 
555
        """Cleanup any open locks, progress bars etc."""
 
556
        cleanups = [self._cleanup_bound_branch,
 
557
                    self.basis_tree.unlock,
 
558
                    self.work_tree.unlock,
 
559
                    self.pb.finished]
 
560
        found_exception = None
 
561
        for cleanup in cleanups:
 
562
            try:
 
563
                cleanup()
 
564
            # we want every cleanup to run no matter what.
 
565
            # so we have a catchall here, but we will raise the
 
566
            # last encountered exception up the stack: and
 
567
            # typically this will be useful enough.
 
568
            except Exception, e:
 
569
                found_exception = e
 
570
        if found_exception is not None: 
 
571
            # don't do a plan raise, because the last exception may have been
 
572
            # trashed, e is our sure-to-work exception even though it loses the
 
573
            # full traceback. XXX: RBC 20060421 perhaps we could check the
 
574
            # exc_info and if its the same one do a plain raise otherwise 
 
575
            # 'raise e' as we do now.
 
576
            raise e
 
577
 
 
578
    def _cleanup_bound_branch(self):
 
579
        """Executed at the end of a try/finally to cleanup a bound branch.
 
580
 
 
581
        If the branch wasn't bound, this is a no-op.
 
582
        If it was, it resents self.branch to the local branch, instead
 
583
        of being the master.
 
584
        """
 
585
        if not self.bound_branch:
 
586
            return
 
587
        if self.master_locked:
 
588
            self.master_branch.unlock()
 
589
 
 
590
    def _escape_commit_message(self):
 
591
        """Replace xml-incompatible control characters."""
 
592
        # FIXME: RBC 20060419 this should be done by the revision
 
593
        # serialiser not by commit. Then we can also add an unescaper
 
594
        # in the deserializer and start roundtripping revision messages
 
595
        # precisely. See repository_implementations/test_repository.py
 
596
        
 
597
        # Python strings can include characters that can't be
 
598
        # represented in well-formed XML; escape characters that
 
599
        # aren't listed in the XML specification
 
600
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
 
601
        self.message, escape_count = re.subn(
 
602
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
 
603
            lambda match: match.group(0).encode('unicode_escape'),
 
604
            self.message)
 
605
        if escape_count:
 
606
            self.reporter.escaped(escape_count, self.message)
 
607
 
 
608
    def _gather_parents(self):
 
609
        """Record the parents of a merge for merge detection."""
 
610
        # TODO: Make sure that this list doesn't contain duplicate 
 
611
        # entries and the order is preserved when doing this.
 
612
        self.parents = self.work_tree.get_parent_ids()
 
613
        self.parent_invs = [self.basis_inv]
 
614
        for revision in self.parents[1:]:
 
615
            if self.branch.repository.has_revision(revision):
 
616
                mutter('commit parent revision {%s}', revision)
 
617
                inventory = self.branch.repository.get_inventory(revision)
 
618
                self.parent_invs.append(inventory)
 
619
            else:
 
620
                mutter('commit parent ghost revision {%s}', revision)
 
621
 
666
622
    def _update_builder_with_changes(self):
667
623
        """Update the commit builder with the data about what has changed.
668
624
        """
 
625
        # Build the revision inventory.
 
626
        #
 
627
        # This starts by creating a new empty inventory. Depending on
 
628
        # which files are selected for commit, and what is present in the
 
629
        # current tree, the new inventory is populated. inventory entries 
 
630
        # which are candidates for modification have their revision set to
 
631
        # None; inventory entries that are carried over untouched have their
 
632
        # revision set to their prior value.
 
633
        #
 
634
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
 
635
        # results to create a new inventory at the same time, which results
 
636
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
 
637
        # ADHB 11-07-2006
 
638
 
669
639
        specific_files = self.specific_files
670
 
        mutter("Selecting files for commit with filter %r", specific_files)
671
 
 
672
 
        self._check_strict()
673
 
        iter_changes = self.work_tree.iter_changes(self.basis_tree,
674
 
            specific_files=specific_files)
675
 
        if self.exclude:
676
 
            iter_changes = filter_excluded(iter_changes, self.exclude)
677
 
        iter_changes = self._filter_iter_changes(iter_changes)
678
 
        for file_id, path, fs_hash in self.builder.record_iter_changes(
679
 
            self.work_tree, self.basis_revid, iter_changes):
680
 
            self.work_tree._observed_sha1(file_id, path, fs_hash)
681
 
 
682
 
    def _filter_iter_changes(self, iter_changes):
683
 
        """Process iter_changes.
684
 
 
685
 
        This method reports on the changes in iter_changes to the user, and 
686
 
        converts 'missing' entries in the iter_changes iterator to 'deleted'
687
 
        entries. 'missing' entries have their
688
 
 
689
 
        :param iter_changes: An iter_changes to process.
690
 
        :return: A generator of changes.
691
 
        """
692
 
        reporter = self.reporter
693
 
        report_changes = reporter.is_verbose()
694
 
        deleted_paths = []
695
 
        for change in iter_changes:
696
 
            if report_changes:
697
 
                old_path = change[1][0]
698
 
                new_path = change[1][1]
699
 
                versioned = change[3][1]
700
 
            kind = change[6][1]
701
 
            versioned = change[3][1]
702
 
            if kind is None and versioned:
703
 
                # 'missing' path
704
 
                if report_changes:
705
 
                    reporter.missing(new_path)
706
 
                deleted_paths.append(change[1][1])
707
 
                # Reset the new path (None) and new versioned flag (False)
708
 
                change = (change[0], (change[1][0], None), change[2],
709
 
                    (change[3][0], False)) + change[4:]
710
 
                new_path = change[1][1]
711
 
                versioned = False
712
 
            elif kind == 'tree-reference':
713
 
                if self.recursive == 'down':
714
 
                    self._commit_nested_tree(change[0], change[1][1])
715
 
            if change[3][0] or change[3][1]:
716
 
                yield change
717
 
                if report_changes:
718
 
                    if new_path is None:
719
 
                        reporter.deleted(old_path)
720
 
                    elif old_path is None:
721
 
                        reporter.snapshot_change(gettext('added'), new_path)
722
 
                    elif old_path != new_path:
723
 
                        reporter.renamed(gettext('renamed'), old_path, new_path)
724
 
                    else:
725
 
                        if (new_path or 
726
 
                            self.work_tree.branch.repository._format.rich_root_data):
727
 
                            # Don't report on changes to '' in non rich root
728
 
                            # repositories.
729
 
                            reporter.snapshot_change(gettext('modified'), new_path)
730
 
            self._next_progress_entry()
731
 
        # Unversion files that were found to be deleted
732
 
        self.deleted_paths = deleted_paths
733
 
 
734
 
    def _check_strict(self):
735
 
        # XXX: when we use iter_changes this would likely be faster if
736
 
        # iter_changes would check for us (even in the presence of
737
 
        # selected_files).
 
640
        mutter("Selecting files for commit with filter %s", specific_files)
 
641
 
 
642
        # Build the new inventory
 
643
        self._populate_from_inventory(specific_files)
 
644
 
 
645
        # If specific files are selected, then all un-selected files must be
 
646
        # recorded in their previous state. For more details, see
 
647
        # https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
 
648
        if specific_files:
 
649
            for path, old_ie in self.basis_inv.iter_entries():
 
650
                if old_ie.file_id in self.builder.new_inventory:
 
651
                    # already added - skip.
 
652
                    continue
 
653
                if is_inside_any(specific_files, path):
 
654
                    # was inside the selected path, if not present it has been
 
655
                    # deleted so skip.
 
656
                    continue
 
657
                if old_ie.kind == 'directory':
 
658
                    self._next_progress_entry()
 
659
                # not in final inv yet, was not in the selected files, so is an
 
660
                # entry to be preserved unaltered.
 
661
                ie = old_ie.copy()
 
662
                # Note: specific file commits after a merge are currently
 
663
                # prohibited. This test is for sanity/safety in case it's
 
664
                # required after that changes.
 
665
                if len(self.parents) > 1:
 
666
                    ie.revision = None
 
667
                delta, version_recorded = self.builder.record_entry_contents(
 
668
                    ie, self.parent_invs, path, self.basis_tree, None)
 
669
                if version_recorded:
 
670
                    self.any_entries_changed = True
 
671
                if delta: self._basis_delta.append(delta)
 
672
 
 
673
    def _report_and_accumulate_deletes(self):
 
674
        # XXX: Could the list of deleted paths and ids be instead taken from
 
675
        # _populate_from_inventory?
 
676
        deleted_ids = set(self.basis_inv._byid.keys()) - \
 
677
            set(self.builder.new_inventory._byid.keys())
 
678
        if deleted_ids:
 
679
            self.any_entries_deleted = True
 
680
            deleted = [(self.basis_tree.id2path(file_id), file_id)
 
681
                for file_id in deleted_ids]
 
682
            deleted.sort()
 
683
            # XXX: this is not quite directory-order sorting
 
684
            for path, file_id in deleted:
 
685
                self._basis_delta.append((path, None, file_id, None))
 
686
                self.reporter.deleted(path)
 
687
 
 
688
    def _populate_from_inventory(self, specific_files):
 
689
        """Populate the CommitBuilder by walking the working tree inventory."""
738
690
        if self.strict:
739
691
            # raise an exception as soon as we find a single unknown.
740
692
            for unknown in self.work_tree.unknowns():
741
693
                raise StrictCommitFailed()
 
694
               
 
695
        report_changes = self.reporter.is_verbose()
 
696
        deleted_ids = []
 
697
        deleted_paths = set()
 
698
        # XXX: Note that entries may have the wrong kind because the entry does
 
699
        # not reflect the status on disk.
 
700
        work_inv = self.work_tree.inventory
 
701
        entries = work_inv.iter_entries_by_dir(
 
702
            specific_file_ids=self.specific_file_ids, yield_parents=True)
 
703
        for path, existing_ie in entries:
 
704
            file_id = existing_ie.file_id
 
705
            name = existing_ie.name
 
706
            parent_id = existing_ie.parent_id
 
707
            kind = existing_ie.kind
 
708
            if kind == 'directory':
 
709
                self._next_progress_entry()
 
710
            # Skip files that have been deleted from the working tree.
 
711
            # The deleted files/directories are also recorded so they
 
712
            # can be explicitly unversioned later. Note that when a
 
713
            # filter of specific files is given, we must only skip/record
 
714
            # deleted files matching that filter.
 
715
            if is_inside_any(deleted_paths, path):
 
716
                continue
 
717
            content_summary = self.work_tree.path_content_summary(path)
 
718
            if not specific_files or is_inside_any(specific_files, path):
 
719
                if content_summary[0] == 'missing':
 
720
                    deleted_paths.add(path)
 
721
                    self.reporter.missing(path)
 
722
                    deleted_ids.append(file_id)
 
723
                    continue
 
724
            # TODO: have the builder do the nested commit just-in-time IF and
 
725
            # only if needed.
 
726
            if content_summary[0] == 'tree-reference':
 
727
                # enforce repository nested tree policy.
 
728
                if (not self.work_tree.supports_tree_reference() or
 
729
                    # repository does not support it either.
 
730
                    not self.branch.repository._format.supports_tree_reference):
 
731
                    content_summary = ('directory',) + content_summary[1:]
 
732
            kind = content_summary[0]
 
733
            # TODO: specific_files filtering before nested tree processing
 
734
            if kind == 'tree-reference':
 
735
                if self.recursive == 'down':
 
736
                    nested_revision_id = self._commit_nested_tree(
 
737
                        file_id, path)
 
738
                    content_summary = content_summary[:3] + (
 
739
                        nested_revision_id,)
 
740
                else:
 
741
                    content_summary = content_summary[:3] + (
 
742
                        self.work_tree.get_reference_revision(file_id),)
 
743
 
 
744
            # Record an entry for this item
 
745
            # Note: I don't particularly want to have the existing_ie
 
746
            # parameter but the test suite currently (28-Jun-07) breaks
 
747
            # without it thanks to a unicode normalisation issue. :-(
 
748
            definitely_changed = kind != existing_ie.kind
 
749
            self._record_entry(path, file_id, specific_files, kind, name,
 
750
                parent_id, definitely_changed, existing_ie, report_changes,
 
751
                content_summary)
 
752
 
 
753
        # Unversion IDs that were found to be deleted
 
754
        self.work_tree.unversion(deleted_ids)
742
755
 
743
756
    def _commit_nested_tree(self, file_id, path):
744
757
        "Commit a nested tree."
745
 
        sub_tree = self.work_tree.get_nested_tree(path, file_id)
 
758
        sub_tree = self.work_tree.get_nested_tree(file_id, path)
746
759
        # FIXME: be more comprehensive here:
747
760
        # this works when both trees are in --trees repository,
748
761
        # but when both are bound to a different repository,
749
 
        # it fails; a better way of approaching this is to
 
762
        # it fails; a better way of approaching this is to 
750
763
        # finally implement the explicit-caches approach design
751
764
        # a while back - RBC 20070306.
752
765
        if sub_tree.branch.repository.has_same_location(
762
775
                allow_pointless=self.allow_pointless,
763
776
                strict=self.strict, verbose=self.verbose,
764
777
                local=self.local, reporter=self.reporter)
765
 
        except PointlessCommit:
766
 
            return self.work_tree.get_reference_revision(path, file_id)
767
 
 
768
 
    def _set_progress_stage(self, name, counter=False):
 
778
        except errors.PointlessCommit:
 
779
            return self.work_tree.get_reference_revision(file_id)
 
780
 
 
781
    def _record_entry(self, path, file_id, specific_files, kind, name,
 
782
        parent_id, definitely_changed, existing_ie, report_changes,
 
783
        content_summary):
 
784
        "Record the new inventory entry for a path if any."
 
785
        # mutter('check %s {%s}', path, file_id)
 
786
        # mutter('%s selected for commit', path)
 
787
        if definitely_changed or existing_ie is None:
 
788
            ie = make_entry(kind, name, parent_id, file_id)
 
789
        else:
 
790
            ie = existing_ie.copy()
 
791
            ie.revision = None
 
792
        delta, version_recorded = self.builder.record_entry_contents(ie,
 
793
            self.parent_invs, path, self.work_tree, content_summary)
 
794
        if delta:
 
795
            self._basis_delta.append(delta)
 
796
        if version_recorded:
 
797
            self.any_entries_changed = True
 
798
        if report_changes:
 
799
            self._report_change(ie, path)
 
800
        return ie
 
801
 
 
802
    def _report_change(self, ie, path):
 
803
        """Report a change to the user.
 
804
 
 
805
        The change that has occurred is described relative to the basis
 
806
        inventory.
 
807
        """
 
808
        if (self.basis_inv.has_id(ie.file_id)):
 
809
            basis_ie = self.basis_inv[ie.file_id]
 
810
        else:
 
811
            basis_ie = None
 
812
        change = ie.describe_change(basis_ie, ie)
 
813
        if change in (InventoryEntry.RENAMED, 
 
814
            InventoryEntry.MODIFIED_AND_RENAMED):
 
815
            old_path = self.basis_inv.id2path(ie.file_id)
 
816
            self.reporter.renamed(change, old_path, path)
 
817
        else:
 
818
            self.reporter.snapshot_change(change, path)
 
819
 
 
820
    def _set_progress_stage(self, name, entries_title=None):
769
821
        """Set the progress stage and emit an update to the progress bar."""
770
822
        self.pb_stage_name = name
771
823
        self.pb_stage_count += 1
772
 
        if counter:
 
824
        self.pb_entries_title = entries_title
 
825
        if entries_title is not None:
773
826
            self.pb_entries_count = 0
774
 
        else:
775
 
            self.pb_entries_count = None
 
827
            self.pb_entries_total = '?'
776
828
        self._emit_progress()
777
829
 
778
830
    def _next_progress_entry(self):
781
833
        self._emit_progress()
782
834
 
783
835
    def _emit_progress(self):
784
 
        if self.pb_entries_count is not None:
785
 
            text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
786
 
                self.pb_entries_count)
 
836
        if self.pb_entries_title:
 
837
            if self.pb_entries_total == '?':
 
838
                text = "%s [%s %d] - Stage" % (self.pb_stage_name,
 
839
                    self.pb_entries_title, self.pb_entries_count)
 
840
            else:
 
841
                text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
 
842
                    self.pb_entries_title, self.pb_entries_count,
 
843
                    str(self.pb_entries_total))
787
844
        else:
788
 
            text = gettext("%s - Stage") % (self.pb_stage_name, )
 
845
            text = "%s - Stage" % (self.pb_stage_name)
789
846
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
 
847