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
|
# 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
"""Upload a working tree, incrementally.
The only bzr-related info uploaded with the working tree is the corresponding
revision id. The uploaded working tree is not linked to any other bzr data.
The intended use is for web developers which keep their web sites versioned
with bzr, can can use either FTP or SFTP to upload their site.
Known limitations:
- Symlinks are ignored,
- chmod bits (other than the owner's execution bit) are not supported.
"""
# TODO: the chmod bits *can* be supported via the upload protocols
# (i.e. poorly), but since the web developers use these protocols to upload
# manually, it is expected that the associated web server is coherent with
# their presence/absence. In other words, if a web hosting provider requires
# chmod bits but don't provide an ftp server that support them, well, better
# find another provider ;-)
# TODO: The message emitted in verbose mode displays local paths. That may be
# scary for the user when we say 'Deleting <path>' and are referring to
# remote files...
from bzrlib import (
branch,
commands,
lazy_import,
option,
)
lazy_import.lazy_import(globals(), """
import stat
from bzrlib import (
bzrdir,
errors,
revisionspec,
transport,
osutils,
urlutils,
workingtree,
)
""")
version_info = (1, 0, 0, 'dev', 0)
plugin_name = 'upload'
def _get_branch_option(branch, option):
return branch.get_config().get_user_option(option)
def _set_branch_option(branch, option, value):
branch.get_config().set_user_option(option, value)
def get_upload_location(branch):
return _get_branch_option(branch, 'upload_location')
def set_upload_location(branch, location):
_set_branch_option(branch, 'upload_location', location)
def get_upload_auto(branch):
result = _get_branch_option(branch, 'upload_auto')
# FIXME: is there a better way to do this with bzr's config API?
if result is not None and result.strip() == "True":
return True
return False
def set_upload_auto(branch, auto):
if auto:
auto_str = "True"
else:
auto_str = "False"
_set_branch_option(branch, 'upload_auto', auto_str)
class BzrUploader(object):
def __init__(self, branch, to_transport, outf, tree, rev_id,
quiet=False):
self.branch = branch
self.to_transport = to_transport
self.outf = outf
self.tree = tree
self.rev_id = rev_id
self.quiet = quiet
self._pending_deletions = []
self._pending_renames = []
bzr_upload_revid_file_name = '.bzr-upload.revid'
def set_uploaded_revid(self, rev_id):
# XXX: Add tests for concurrent updates, etc.
self.to_transport.put_bytes(self.bzr_upload_revid_file_name, rev_id)
def get_uploaded_revid(self):
return self.to_transport.get_bytes(self.bzr_upload_revid_file_name)
def upload_file(self, relpath, id, mode=None):
if mode is None:
if self.tree.is_executable(id):
mode = 0775
else:
mode = 0664
if not self.quiet:
self.outf.write('Uploading %s\n' % relpath)
self.to_transport.put_bytes(relpath, self.tree.get_file_text(id), mode)
def upload_file_robustly(self, relpath, id, mode=None):
"""Upload a file, clearing the way on the remote side.
When doing a full upload, it may happen that a directory exists where
we want to put our file.
"""
try:
st = self.to_transport.stat(relpath)
if stat.S_ISDIR(st.st_mode):
# A simple rmdir may not be enough
if not self.quiet:
self.outf.write('Clearing %s/%s\n' % (
self.to_transport.external_url(), relpath))
self.to_transport.delete_tree(relpath)
except errors.PathError:
pass
self.upload_file(relpath, id, mode)
def make_remote_dir(self, relpath, mode=None):
if mode is None:
mode = 0775
self.to_transport.mkdir(relpath, mode)
def make_remote_dir_robustly(self, relpath, mode=None):
"""Create a remote directory, clearing the way on the remote side.
When doing a full upload, it may happen that a file exists where we
want to create our directory.
"""
try:
st = self.to_transport.stat(relpath)
if not stat.S_ISDIR(st.st_mode):
if not self.quiet:
self.outf.write('Deleting %s/%s\n' % (
self.to_transport.external_url(), relpath))
self.to_transport.delete(relpath)
else:
# Ok the remote dir already exists, nothing to do
return
except errors.PathError:
pass
self.make_remote_dir(relpath, mode)
def delete_remote_file(self, relpath):
if not self.quiet:
self.outf.write('Deleting %s\n' % relpath)
self.to_transport.delete(relpath)
def delete_remote_dir(self, relpath):
if not self.quiet:
self.outf.write('Deleting %s\n' % relpath)
self.to_transport.rmdir(relpath)
def delete_remote_dir_maybe(self, relpath):
"""Try to delete relpath, keeping failures to retry later."""
try:
self.to_transport.rmdir(relpath)
# any kind of PathError would be OK, though we normally expect
# DirectoryNotEmpty
except errors.PathError:
self._pending_deletions.append(relpath)
def finish_deletions(self):
if self._pending_deletions:
# Process the previously failed deletions in reverse order to
# delete children before parents
for relpath in reversed(self._pending_deletions):
self.to_transport.rmdir(relpath)
# The following shouldn't be needed since we use it once per
# upload, but better safe than sorry ;-)
self._pending_deletions = []
def rename_remote(self, old_relpath, new_relpath):
"""Rename a remote file or directory taking care of collisions.
To avoid collisions during bulk renames, each renamed target is
temporarily assigned a unique name. When all renames have been done,
each target get its proper name.
"""
# We generate a sufficiently random name to *assume* that
# no collisions will occur and don't worry about it (nor
# handle it).
import os
import random
import time
stamp = '.tmp.%.9f.%d.%d' % (time.time(),
os.getpid(),
random.randint(0,0x7FFFFFFF))
if not self.quiet:
self.outf.write('Renaming %s to %s\n' % (old_relpath, new_relpath))
self.to_transport.rename(old_relpath, stamp)
self._pending_renames.append((stamp, new_relpath))
def finish_renames(self):
for (stamp, new_path) in self._pending_renames:
self.to_transport.rename(stamp, new_path)
# The following shouldn't be needed since we use it once per upload,
# but better safe than sorry ;-)
self._pending_renames = []
def upload_full_tree(self):
self.to_transport.ensure_base() # XXX: Handle errors (add
# --create-prefix option ?)
self.tree.lock_read()
try:
for relpath, ie in self.tree.inventory.iter_entries():
if relpath in ('', '.bzrignore'):
# skip root ('')
# .bzrignore has no meaning outside of a working tree
# so do not upload it
continue
if ie.kind == 'file':
self.upload_file_robustly(relpath, ie.file_id)
elif ie.kind == 'directory':
self.make_remote_dir_robustly(relpath)
else:
raise NotImplementedError
self.set_uploaded_revid(self.rev_id)
finally:
self.tree.unlock()
def upload_tree(self):
# If we can't find the revid file on the remote location, upload the
# full tree instead
try:
rev_id = self.get_uploaded_revid()
except errors.NoSuchFile:
if not self.quiet:
self.outf.write('No uploaded revision id found,'
' switching to full upload\n')
self.upload_full_tree()
# We're done
return
# Check if the revision hasn't already been uploaded
if rev_id == self.rev_id:
if not self.quiet:
self.outf.write('Remote location already up to date\n')
# XXX: errors out if rev_id not in branch history (probably someone
# uploaded from a different branch).
from_tree = self.branch.repository.revision_tree(rev_id)
self.to_transport.ensure_base() # XXX: Handle errors (add
# --create-prefix option ?)
changes = self.tree.changes_from(from_tree)
self.tree.lock_read()
try:
for (path, id, kind) in changes.removed:
if kind is 'file':
self.delete_remote_file(path)
elif kind is 'directory':
self.delete_remote_dir_maybe(path)
else:
raise NotImplementedError
for (old_path, new_path, id, kind,
content_change, exec_change) in changes.renamed:
if content_change:
# We update the old_path content because renames and
# deletions are differed.
self.upload_file(old_path, id)
self.rename_remote(old_path, new_path)
self.finish_renames()
self.finish_deletions()
for (path, id, old_kind, new_kind) in changes.kind_changed:
if old_kind is 'file':
self.delete_remote_file(path)
elif old_kind is 'directory':
self.delete_remote_dir(path)
else:
raise NotImplementedError
if new_kind is 'file':
self.upload_file(path, id)
elif new_kind is 'directory':
self.make_remote_dir(path)
else:
raise NotImplementedError
for (path, id, kind) in changes.added:
if kind is 'file':
self.upload_file(path, id)
elif kind is 'directory':
self.make_remote_dir(path)
else:
raise NotImplementedError
# XXX: Add a test for exec_change
for (path, id, kind,
content_change, exec_change) in changes.modified:
if kind is 'file':
self.upload_file(path, id)
else:
raise NotImplementedError
self.set_uploaded_revid(self.rev_id)
finally:
self.tree.unlock()
class CannotUploadToWorkingTreeError(errors.BzrCommandError):
_fmt = 'Cannot upload to a bzr managed working tree: %(url)s".'
def __init__(self, url):
super(CannotUploadToWorkingTreeError, self).__init__(self)
self.url = url
class cmd_upload(commands.Command):
"""Upload a working tree, as a whole or incrementally.
If no destination is specified use the last one used.
If no revision is specified upload the changes since the last upload.
"""
takes_args = ['location?']
takes_options = [
'revision',
'remember',
option.Option('full', 'Upload the full working tree.'),
option.Option('quiet', 'Do not output what is being done.',
short_name='q'),
option.Option('directory',
help='Branch to upload from, '
'rather than the one containing the working directory.',
short_name='d',
type=unicode,
),
option.Option('auto',
'Trigger an upload from this branch whenever the tip '
'revision changes.')
]
def run(self, location=None, full=False, revision=None, remember=None,
directory=None, quiet=False, auto=None
):
if directory is None:
directory = u'.'
if auto and not auto_hook_available:
raise BzrCommandError("Your version of bzr does not have the "
"hooks necessary for --auto to work")
(wt, branch,
relpath) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
if wt:
changes = wt.changes_from(wt.basis_tree())
if revision is None and changes.has_changed():
raise errors.UncommittedChanges(wt)
if location is None:
stored_loc = get_upload_location(branch)
if stored_loc is None:
raise errors.BzrCommandError('No upload location'
' known or specified.')
else:
# FIXME: Not currently tested
display_url = urlutils.unescape_for_display(stored_loc,
self.outf.encoding)
self.outf.write("Using saved location: %s\n" % display_url)
location = stored_loc
to_transport = transport.get_transport(location)
# Check that we are not uploading to a existing working tree.
try:
to_bzr_dir = bzrdir.BzrDir.open_from_transport(to_transport)
has_wt = to_bzr_dir.has_workingtree()
except errors.NotBranchError:
has_wt = False
except errors.NotLocalUrl:
# The exception raised is a bit weird... but that's life.
has_wt = True
if has_wt:
raise CannotUploadToWorkingTreeError(location)
if revision is None:
rev_id = branch.last_revision()
else:
if len(revision) != 1:
raise errors.BzrCommandError(
'bzr upload --revision takes exactly 1 argument')
rev_id = revision[0].in_history(branch).rev_id
tree = branch.repository.revision_tree(rev_id)
uploader = BzrUploader(branch, to_transport, self.outf, tree,
rev_id, quiet=quiet)
if full:
uploader.upload_full_tree()
else:
uploader.upload_tree()
# We uploaded successfully, remember it
if get_upload_location(branch) is None or remember:
set_upload_location(branch, to_transport.base)
if auto is not None:
set_upload_auto(branch, auto)
commands.register_command(cmd_upload)
from bzrlib.plugins.upload.auto_upload_hook import auto_upload_hook
if hasattr(branch.Branch.hooks, "install_named_hook"):
branch.Branch.hooks.install_named_hook('post_change_branch_tip',
auto_upload_hook,
'Auto upload code from a branch when it is changed.')
auto_hook_available = True
else:
auto_hook_available = False
def load_tests(basic_tests, module, loader):
# This module shouldn't define any tests but I don't know how to report
# that. I prefer to update basic_tests with the other tests to detect
# unwanted tests and I think that's sufficient.
testmod_names = [
'tests',
]
basic_tests.addTest(loader.loadTestsFromModuleNames(
["%s.%s" % (__name__, tmn) for tmn in testmod_names]))
return basic_tests
|