~abentley/bzrtools/bzrtools.dev

« back to all changes in this revision

Viewing changes to shelf.py

  • Committer: Aaron Bentley
  • Date: 2005-11-10 20:15:27 UTC
  • Revision ID: aaron.bentley@utoronto.ca-20051110201527-8caa84ae529a1871
Added Daniel Silverstone to credits

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
#!/usr/bin/python
 
2
 
 
3
from patches import parse_patches
1
4
import os
2
5
import sys
3
 
import subprocess
4
 
from datetime import datetime
5
 
from errors import CommandError, PatchFailed, PatchInvokeError
6
 
from hunk_selector import ShelveHunkSelector, UnshelveHunkSelector
7
 
from patch import run_patch
8
 
from patchsource import PatchSource, FilePatchSource
9
 
from bzrlib.osutils import rename
 
6
import string
 
7
import glob
 
8
import bzrlib
 
9
from bzrlib.commands import Command
 
10
from bzrlib.branch import Branch
 
11
from bzrlib import DEFAULT_IGNORE
 
12
from hunk_selector import HunkSelector
 
13
from diffstat import DiffStat
 
14
 
 
15
DEFAULT_IGNORE.append('./.bzr-shelf*')
 
16
 
 
17
class QuitException(Exception):
 
18
    pass
10
19
 
11
20
class Shelf(object):
12
 
    MESSAGE_PREFIX = "# Shelved patch: "
13
 
 
14
 
    _paths = {
15
 
        'base'          : '.shelf',
16
 
        'shelves'       : '.shelf/shelves',
17
 
        'current-shelf' : '.shelf/current-shelf',
18
 
    }
19
 
 
20
 
    def __init__(self, base, name=None):
21
 
        self.base = base
22
 
        self.__setup()
23
 
 
24
 
        if name is None:
25
 
            current = os.path.join(self.base, self._paths['current-shelf'])
26
 
            name = open(current).read().strip()
27
 
 
28
 
        assert '\n' not in name
29
 
        self.name = name
30
 
 
31
 
        self.dir = os.path.join(self.base, self._paths['shelves'], name)
32
 
        if not os.path.isdir(self.dir):
33
 
            os.mkdir(self.dir)
34
 
 
35
 
    def __setup(self):
36
 
        # Create required directories etc.
37
 
        for dir in [self._paths['base'], self._paths['shelves']]:
38
 
            dir = os.path.join(self.base, dir)
39
 
            if not os.path.isdir(dir):
40
 
                os.mkdir(dir)
41
 
 
42
 
        current = os.path.join(self.base, self._paths['current-shelf'])
43
 
        if not os.path.exists(current):
44
 
            f = open(current, 'w')
45
 
            f.write('default')
46
 
            f.close()
47
 
 
48
 
    def make_default(self):
49
 
        f = open(os.path.join(self.base, self._paths['current-shelf']), 'w')
50
 
        f.write(self.name)
51
 
        f.close()
52
 
        self.log("Default shelf is now '%s'\n" % self.name)
53
 
 
54
 
    def log(self, msg):
55
 
        sys.stderr.write(msg)
56
 
 
57
 
    def delete(self, patch):
58
 
        path = self.__path_from_user(patch)
59
 
        rename(path, '%s~' % path)
60
 
 
61
 
    def display(self, patch=None):
62
 
        if patch is None:
63
 
            path = self.last_patch()
64
 
            if path is None:
65
 
                raise CommandError("No patches on shelf.")
66
 
        else:
67
 
            path = self.__path_from_user(patch)
68
 
        sys.stdout.write(open(path).read())
69
 
 
70
 
    def list(self):
71
 
        indexes = self.__list()
72
 
        self.log("Patches on shelf '%s':" % self.name)
73
 
        if len(indexes) == 0:
74
 
            self.log(' None\n')
75
 
            return
76
 
        self.log('\n')
77
 
        for index in indexes:
78
 
            msg = self.get_patch_message(self.__path(index))
79
 
            if msg is None:
80
 
                msg = "No message saved with patch."
81
 
            self.log(' %.2d: %s\n' % (index, msg))
82
 
 
83
 
    def __path_from_user(self, patch_id):
84
 
        try:
85
 
            patch_index = int(patch_id)
86
 
        except (TypeError, ValueError):
87
 
            raise CommandError("Invalid patch name '%s'" % patch_id)
88
 
 
89
 
        path = self.__path(patch_index)
90
 
 
91
 
        if not os.path.exists(path):
92
 
            raise CommandError("Patch '%s' doesn't exist on shelf %s!" % \
93
 
                        (patch_id, self.name))
94
 
 
95
 
        return path
96
 
 
97
 
    def __path(self, index):
98
 
        return os.path.join(self.dir, '%.2d' % index)
99
 
 
100
 
    def next_patch(self):
101
 
        indexes = self.__list()
102
 
 
103
 
        if len(indexes) == 0:
104
 
            next = 0
105
 
        else:
106
 
            next = indexes[-1] + 1
107
 
        return self.__path(next)
108
 
 
109
 
    def __list(self):
110
 
        patches = os.listdir(self.dir)
111
 
        indexes = []
112
 
        for f in patches:
113
 
            if f.endswith('~'):
114
 
                continue # ignore backup files
115
 
            try:
116
 
                indexes.append(int(f))
117
 
            except ValueError:
118
 
                self.log("Warning: Ignoring junk file '%s' on shelf.\n" % f)
119
 
 
120
 
        indexes.sort()
121
 
        return indexes
122
 
 
123
 
    def last_patch(self):
124
 
        indexes = self.__list()
125
 
 
126
 
        if len(indexes) == 0:
127
 
            return None
128
 
 
129
 
        return self.__path(indexes[-1])
130
 
 
131
 
    def get_patch_message(self, patch_path):
132
 
        patch = open(patch_path, 'r').read()
133
 
 
134
 
        if not patch.startswith(self.MESSAGE_PREFIX):
135
 
            return None
136
 
        return patch[len(self.MESSAGE_PREFIX):patch.index('\n')]
137
 
 
138
 
    def unshelve(self, patch_source, patch_name=None, all=False, force=False,
139
 
                 no_color=False):
140
 
        self._check_upgrade()
141
 
 
142
 
        if no_color is False:
143
 
            color = None
144
 
        else:
145
 
            color = False
146
 
        if patch_name is None:
147
 
            patch_path = self.last_patch()
148
 
        else:
149
 
            patch_path = self.__path_from_user(patch_name)
150
 
 
151
 
        if patch_path is None:
152
 
            raise CommandError("No patch found on shelf %s" % self.name)
153
 
 
154
 
        patches = FilePatchSource(patch_path).readpatches()
155
 
        if all:
156
 
            to_unshelve = patches
157
 
            to_remain = []
158
 
        else:
159
 
            hs = UnshelveHunkSelector(patches, color)
160
 
            to_unshelve, to_remain = hs.select()
161
 
 
162
 
        if len(to_unshelve) == 0:
163
 
            raise CommandError('Nothing to unshelve')
164
 
 
165
 
        message = self.get_patch_message(patch_path)
166
 
        if message is None:
167
 
            message = "No message saved with patch."
168
 
        self.log('Unshelving from %s/%s: "%s"\n' % \
169
 
                (self.name, os.path.basename(patch_path), message))
170
 
 
171
 
        try:
172
 
            self._run_patch(to_unshelve, dry_run=True)
173
 
            self._run_patch(to_unshelve)
174
 
        except PatchFailed:
175
 
            try:
176
 
                self._run_patch(to_unshelve, strip=1, dry_run=True)
177
 
                self._run_patch(to_unshelve, strip=1)
178
 
            except PatchFailed:
179
 
                if force:
180
 
                    self.log('Warning: Unshelving failed, forcing as ' \
181
 
                             'requested. Shelf will not be modified.\n')
182
 
                    try:
183
 
                        self._run_patch(to_unshelve)
184
 
                    except PatchFailed:
185
 
                        pass
186
 
                    return
187
 
                raise CommandError("Your shelved patch no " \
188
 
                    "longer applies cleanly to the working tree!")
189
 
 
190
 
        # Backup the shelved patch
191
 
        rename(patch_path, '%s~' % patch_path)
192
 
 
193
 
        if len(to_remain) > 0:
194
 
            f = open(patch_path, 'w')
195
 
            for patch in to_remain:
196
 
                f.write(str(patch))
197
 
            f.close()
198
 
 
199
 
    def shelve(self, patch_source, all=False, message=None, no_color=False):
200
 
        self._check_upgrade()
201
 
        if no_color is False:
202
 
            color = None
203
 
        else:
204
 
            color = False
205
 
 
206
 
        patches = patch_source.readpatches()
207
 
 
208
 
        if all:
209
 
            to_shelve = patches
210
 
        else:
211
 
            to_shelve = ShelveHunkSelector(patches, color).select()[0]
212
 
 
213
 
        if len(to_shelve) == 0:
214
 
            raise CommandError('Nothing to shelve')
215
 
 
216
 
        if message is None:
217
 
            timestamp = datetime.now().strftime('%Y-%m-%d %H:%M:%S')
218
 
            message = "Changes shelved on %s" % timestamp
219
 
 
220
 
        patch_path = self.next_patch()
221
 
        self.log('Shelving to %s/%s: "%s"\n' % \
222
 
                (self.name, os.path.basename(patch_path), message))
223
 
 
224
 
        f = open(patch_path, 'a')
225
 
 
226
 
        assert '\n' not in message
227
 
        f.write("%s%s\n" % (self.MESSAGE_PREFIX, message))
228
 
 
229
 
        for patch in to_shelve:
230
 
            f.write(str(patch))
231
 
 
232
 
        f.flush()
233
 
        os.fsync(f.fileno())
234
 
        f.close()
235
 
 
236
 
        try:
237
 
            self._run_patch(to_shelve, reverse=True, dry_run=True)
238
 
            self._run_patch(to_shelve, reverse=True)
239
 
        except PatchFailed:
240
 
            try:
241
 
                self._run_patch(to_shelve, reverse=True, strip=1, dry_run=True)
242
 
                self._run_patch(to_shelve, reverse=True, strip=1)
243
 
            except PatchFailed:
244
 
                raise CommandError("Failed removing shelved changes from the"
245
 
                    "working tree!")
246
 
 
247
 
    def _run_patch(self, patches, strip=0, reverse=False, dry_run=False):
248
 
        run_patch(self.base, patches, strip, reverse, dry_run)
249
 
 
250
 
    def _check_upgrade(self):
251
 
        if len(self._list_old_shelves()) > 0:
252
 
            raise CommandError("Old format shelves found, either upgrade " \
253
 
                    "or remove them!")
254
 
 
255
 
    def _list_old_shelves(self):
256
 
        import glob
257
 
        stem = os.path.join(self.base, '.bzr-shelf')
258
 
 
259
 
        patches = glob.glob(stem)
260
 
        patches.extend(glob.glob(stem + '-*[!~]'))
261
 
 
262
 
        if len(patches) == 0:
263
 
            return []
264
 
 
265
 
        def patch_index(name):
 
21
    def __init__(self, location):
 
22
        self.branch = Branch.open_containing(location)[0]
 
23
 
 
24
    def shelf_suffix(self, index):
 
25
        if index == 0:
 
26
            return ""
 
27
        else:
 
28
            return "-%d" % index
 
29
 
 
30
    def next_shelf(self):
 
31
        def name_sequence():
 
32
            i = 0
 
33
            while True:
 
34
                yield self.shelf_suffix(i)
 
35
                i = i + 1
 
36
 
 
37
        stem = os.path.join(self.branch.base, '.bzr-shelf')
 
38
        for end in name_sequence():
 
39
            name = stem + end
 
40
            if not os.path.exists(name):
 
41
                return name
 
42
 
 
43
    def last_shelf(self):
 
44
        stem = os.path.join(self.branch.base, '.bzr-shelf')
 
45
        shelves = glob.glob(stem)
 
46
        shelves.extend(glob.glob(stem + '-*'))
 
47
        def shelf_index(name):
266
48
            if name == stem:
267
49
                return 0
268
 
            return int(name[len(stem) + 1:])
269
 
 
270
 
        # patches might not be sorted in the right order
271
 
        patch_ids = []
272
 
        for patch in patches:
273
 
            if patch == stem:
274
 
                patch_ids.append(0)
275
 
            else:
276
 
                patch_ids.append(int(patch[len(stem) + 1:]))
277
 
 
278
 
        patch_ids.sort()
279
 
 
280
 
        patches = []
281
 
        for id in patch_ids:
282
 
            if id == 0:
283
 
                patches.append(stem)
284
 
            else:
285
 
                patches.append('%s-%s' % (stem, id))
286
 
 
287
 
        return patches
288
 
 
289
 
    def upgrade(self):
290
 
        patches = self._list_old_shelves()
 
50
            return int(name[len(stem)+1:])
 
51
        shelvenums = [shelf_index(f) for f in shelves]
 
52
        shelvenums.sort()
 
53
 
 
54
        if len(shelvenums) == 0:
 
55
            return None
 
56
        return stem + self.shelf_suffix(shelvenums[-1])
 
57
 
 
58
    def get_shelf_message(self, shelf):
 
59
        prefix = "# shelf: "
 
60
        if not shelf.startswith(prefix):
 
61
            return None
 
62
        return shelf[len(prefix):shelf.index('\n')]
 
63
 
 
64
    def unshelve(self):
 
65
        shelf = self.last_shelf()
 
66
 
 
67
        if shelf is None:
 
68
            raise Exception("No shelf found in '%s'" % self.branch.base)
 
69
 
 
70
        patch = open(shelf, 'r').read()
 
71
 
 
72
        print >>sys.stderr, "Reapplying shelved patches",
 
73
        message = self.get_shelf_message(patch)
 
74
        if message is not None:
 
75
            print >>sys.stderr, ' "%s"' % message
 
76
        else:
 
77
            print >>sys.stderr, ""
 
78
        pipe = os.popen('patch -d %s -s -p0' % self.branch.base, 'w')
 
79
        pipe.write(patch)
 
80
        pipe.flush()
 
81
 
 
82
        if pipe.close() is not None:
 
83
            raise Exception("Failed running patch!")
 
84
 
 
85
        os.remove(shelf)
 
86
 
 
87
        diff_stat = DiffStat(self.get_patches(None, None))
 
88
        print 'Diff status is now:\n', diff_stat
 
89
 
 
90
        return True
 
91
 
 
92
    def get_patches(self, revision, file_list):
 
93
        from StringIO import StringIO
 
94
        from bzrlib.diff import show_diff
 
95
        out = StringIO()
 
96
        show_diff(self.branch, revision, specific_files=file_list, output=out)
 
97
        out.seek(0)
 
98
        return out.readlines()
 
99
 
 
100
    def shelve(self, all_hunks=False, message=None, revision=None,
 
101
             file_list=None):
 
102
        patches = parse_patches(self.get_patches(revision, file_list))
 
103
 
 
104
        if not all_hunks:
 
105
            try:
 
106
                patches = HunkSelector(patches).select()
 
107
            except QuitException:
 
108
                return False
291
109
 
292
110
        if len(patches) == 0:
293
 
            self.log('No old-style shelves found to upgrade.\n')
294
 
            return
295
 
 
296
 
        for patch in patches:
297
 
            old_file = open(patch, 'r')
298
 
            new_path = self.next_patch()
299
 
            new_file = open(new_path, 'w')
300
 
            new_file.write(old_file.read())
301
 
            old_file.close()
302
 
            new_file.close()
303
 
            self.log('Copied %s to %s/%s\n' % (os.path.basename(patch),
304
 
                self.name, os.path.basename(new_path)))
305
 
            rename(patch, patch + '~')
 
111
            print >>sys.stderr, 'Nothing to shelve'
 
112
            return True
 
113
 
 
114
        shelf = self.next_shelf()
 
115
        print >>sys.stderr, "Saving shelved patches to", shelf
 
116
        shelf = open(shelf, 'a')
 
117
        if message is not None:
 
118
            assert '\n' not in message
 
119
            shelf.write("# shelf: %s\n" % message)
 
120
        for patch in patches:
 
121
            shelf.write(str(patch))
 
122
 
 
123
        shelf.flush()
 
124
        os.fsync(shelf.fileno())
 
125
        shelf.close()
 
126
 
 
127
        print >>sys.stderr, "Reverting shelved patches"
 
128
        pipe = os.popen('patch -d %s -sR -p0' % self.branch.base, 'w')
 
129
        for patch in patches:
 
130
            pipe.write(str(patch))
 
131
        pipe.flush()
 
132
 
 
133
        if pipe.close() is not None:
 
134
            raise Exception("Failed running patch!")
 
135
 
 
136
        diff_stat = DiffStat(self.get_patches(None, None))
 
137
        print 'Diff status is now:\n', diff_stat
 
138
 
 
139
        return True
 
140