Make "stg commit" fancier
[stgit] / stgit / lib / transaction.py
1 from stgit import exception, utils
2 from stgit.out import *
3 from stgit.lib import git
4
5 class TransactionException(exception.StgException):
6 pass
7
8 class TransactionHalted(TransactionException):
9 pass
10
11 def _print_current_patch(old_applied, new_applied):
12 def now_at(pn):
13 out.info('Now at patch "%s"' % pn)
14 if not old_applied and not new_applied:
15 pass
16 elif not old_applied:
17 now_at(new_applied[-1])
18 elif not new_applied:
19 out.info('No patch applied')
20 elif old_applied[-1] == new_applied[-1]:
21 pass
22 else:
23 now_at(new_applied[-1])
24
25 class _TransPatchMap(dict):
26 def __init__(self, stack):
27 dict.__init__(self)
28 self.__stack = stack
29 def __getitem__(self, pn):
30 try:
31 return dict.__getitem__(self, pn)
32 except KeyError:
33 return self.__stack.patches.get(pn).commit
34
35 class StackTransaction(object):
36 def __init__(self, stack, msg):
37 self.__stack = stack
38 self.__msg = msg
39 self.__patches = _TransPatchMap(stack)
40 self.__applied = list(self.__stack.patchorder.applied)
41 self.__unapplied = list(self.__stack.patchorder.unapplied)
42 self.__error = None
43 self.__current_tree = self.__stack.head.data.tree
44 self.__base = self.__stack.base
45 stack = property(lambda self: self.__stack)
46 patches = property(lambda self: self.__patches)
47 def __set_applied(self, val):
48 self.__applied = list(val)
49 applied = property(lambda self: self.__applied, __set_applied)
50 def __set_unapplied(self, val):
51 self.__unapplied = list(val)
52 unapplied = property(lambda self: self.__unapplied, __set_unapplied)
53 def __set_base(self, val):
54 assert (not self.__applied
55 or self.patches[self.applied[0]].data.parent == val)
56 self.__base = val
57 base = property(lambda self: self.__base, __set_base)
58 def __checkout(self, tree, iw):
59 if not self.__stack.head_top_equal():
60 out.error(
61 'HEAD and top are not the same.',
62 'This can happen if you modify a branch with git.',
63 '"stg repair --help" explains more about what to do next.')
64 self.__abort()
65 if self.__current_tree != tree:
66 assert iw != None
67 iw.checkout(self.__current_tree, tree)
68 self.__current_tree = tree
69 @staticmethod
70 def __abort():
71 raise TransactionException(
72 'Command aborted (all changes rolled back)')
73 def __check_consistency(self):
74 remaining = set(self.__applied + self.__unapplied)
75 for pn, commit in self.__patches.iteritems():
76 if commit == None:
77 assert self.__stack.patches.exists(pn)
78 else:
79 assert pn in remaining
80 @property
81 def __head(self):
82 if self.__applied:
83 return self.__patches[self.__applied[-1]]
84 else:
85 return self.__base
86 def abort(self, iw = None):
87 # The only state we need to restore is index+worktree.
88 if iw:
89 self.__checkout(self.__stack.head.data.tree, iw)
90 def run(self, iw = None):
91 self.__check_consistency()
92 new_head = self.__head
93
94 # Set branch head.
95 try:
96 self.__checkout(new_head.data.tree, iw)
97 except git.CheckoutException:
98 # We have to abort the transaction.
99 self.abort(iw)
100 self.__abort()
101 self.__stack.set_head(new_head, self.__msg)
102
103 if self.__error:
104 out.error(self.__error)
105
106 # Write patches.
107 for pn, commit in self.__patches.iteritems():
108 if self.__stack.patches.exists(pn):
109 p = self.__stack.patches.get(pn)
110 if commit == None:
111 p.delete()
112 else:
113 p.set_commit(commit, self.__msg)
114 else:
115 self.__stack.patches.new(pn, commit, self.__msg)
116 _print_current_patch(self.__stack.patchorder.applied, self.__applied)
117 self.__stack.patchorder.applied = self.__applied
118 self.__stack.patchorder.unapplied = self.__unapplied
119
120 if self.__error:
121 return utils.STGIT_CONFLICT
122 else:
123 return utils.STGIT_SUCCESS
124
125 def __halt(self, msg):
126 self.__error = msg
127 raise TransactionHalted(msg)
128
129 @staticmethod
130 def __print_popped(popped):
131 if len(popped) == 0:
132 pass
133 elif len(popped) == 1:
134 out.info('Popped %s' % popped[0])
135 else:
136 out.info('Popped %s -- %s' % (popped[-1], popped[0]))
137
138 def pop_patches(self, p):
139 """Pop all patches pn for which p(pn) is true. Return the list of
140 other patches that had to be popped to accomplish this."""
141 popped = []
142 for i in xrange(len(self.applied)):
143 if p(self.applied[i]):
144 popped = self.applied[i:]
145 del self.applied[i:]
146 break
147 popped1 = [pn for pn in popped if not p(pn)]
148 popped2 = [pn for pn in popped if p(pn)]
149 self.unapplied = popped1 + popped2 + self.unapplied
150 self.__print_popped(popped)
151 return popped1
152
153 def delete_patches(self, p):
154 """Delete all patches pn for which p(pn) is true. Return the list of
155 other patches that had to be popped to accomplish this."""
156 popped = []
157 all_patches = self.applied + self.unapplied
158 for i in xrange(len(self.applied)):
159 if p(self.applied[i]):
160 popped = self.applied[i:]
161 del self.applied[i:]
162 break
163 popped = [pn for pn in popped if not p(pn)]
164 self.unapplied = popped + [pn for pn in self.unapplied if not p(pn)]
165 self.__print_popped(popped)
166 for pn in all_patches:
167 if p(pn):
168 s = ['', ' (empty)'][self.patches[pn].data.is_nochange()]
169 self.patches[pn] = None
170 out.info('Deleted %s%s' % (pn, s))
171 return popped
172
173 def push_patch(self, pn, iw = None):
174 """Attempt to push the named patch. If this results in conflicts,
175 halts the transaction. If index+worktree are given, spill any
176 conflicts to them."""
177 i = self.unapplied.index(pn)
178 cd = self.patches[pn].data
179 s = ['', ' (empty)'][cd.is_nochange()]
180 oldparent = cd.parent
181 cd = cd.set_parent(self.__head)
182 base = oldparent.data.tree
183 ours = cd.parent.data.tree
184 theirs = cd.tree
185 tree = self.__stack.repository.simple_merge(base, ours, theirs)
186 merge_conflict = False
187 if not tree:
188 if iw == None:
189 self.__halt('%s does not apply cleanly' % pn)
190 try:
191 self.__checkout(ours, iw)
192 except git.CheckoutException:
193 self.__halt('Index/worktree dirty')
194 try:
195 iw.merge(base, ours, theirs)
196 tree = iw.index.write_tree()
197 self.__current_tree = tree
198 s = ' (modified)'
199 except git.MergeException:
200 tree = ours
201 merge_conflict = True
202 s = ' (conflict)'
203 cd = cd.set_tree(tree)
204 self.patches[pn] = self.__stack.repository.commit(cd)
205 del self.unapplied[i]
206 self.applied.append(pn)
207 out.info('Pushed %s%s' % (pn, s))
208 if merge_conflict:
209 self.__halt('Merge conflict')