95aef72aaa9a1055fe1bc74664f50aa27ce589b6
[quix0rs-apt-p2p.git] / apt_p2p_Khashmir / actions.py
1 ## Copyright 2002-2004 Andrew Loewenstern, All Rights Reserved
2 # see LICENSE.txt for license information
3
4 """Details of how to perform actions on remote peers."""
5
6 from datetime import datetime
7
8 from twisted.internet import reactor, defer
9 from twisted.python import log
10
11 from khash import intify
12 from ktable import K
13 from util import uncompact
14
15 class ActionBase:
16     """Base class for some long running asynchronous proccesses like finding nodes or values.
17     
18     @type caller: L{khashmir.Khashmir}
19     @ivar caller: the DHT instance that is performing the action
20     @type target: C{string}
21     @ivar target: the target of the action, usually a DHT key
22     @type config: C{dictionary}
23     @ivar config: the configuration variables for the DHT
24     @type action: C{string}
25     @ivar action: the name of the action to call on remote nodes
26     @type stats: L{stats.StatsLogger}
27     @ivar stats: the statistics modules to report to
28     @type num: C{long}
29     @ivar num: the target key in integer form
30     @type queried: C{dictionary}
31     @ivar queried: the nodes that have been queried for this action,
32         keys are node IDs, values are the node itself
33     @type answered: C{dictionary}
34     @ivar answered: the nodes that have answered the queries
35     @type found: C{dictionary}
36     @ivar found: nodes that have been found so far by the action
37     @type sorted_nodes: C{list} of L{node.Node}
38     @ivar sorted_nodes: a sorted list of nodes by there proximity to the key
39     @type results: C{dictionary}
40     @ivar results: keys are the results found so far by the action
41     @type desired_results: C{int}
42     @ivar desired_results: the minimum number of results that are needed
43         before the action should stop
44     @type callback: C{method}
45     @ivar callback: the method to call with the results
46     @type outstanding: C{int}
47     @ivar outstanding: the number of requests currently outstanding
48     @type outstanding_results: C{int}
49     @ivar outstanding_results: the number of results that are expected from
50         the requests that are currently outstanding
51     @type finished: C{boolean}
52     @ivar finished: whether the action is done
53     @type started: C{datetime.datetime}
54     @ivar started: the time the action was started at
55     @type sort: C{method}
56     @ivar sort: used to sort nodes by their proximity to the target
57     """
58     
59     def __init__(self, caller, target, callback, config, stats, action, num_results = None):
60         """Initialize the action.
61         
62         @type caller: L{khashmir.Khashmir}
63         @param caller: the DHT instance that is performing the action
64         @type target: C{string}
65         @param target: the target of the action, usually a DHT key
66         @type callback: C{method}
67         @param callback: the method to call with the results
68         @type config: C{dictionary}
69         @param config: the configuration variables for the DHT
70         @type stats: L{stats.StatsLogger}
71         @param stats: the statistics gatherer
72         @type action: C{string}
73         @param action: the name of the action to call on remote nodes
74         @type num_results: C{int}
75         @param num_results: the minimum number of results that are needed before
76             the action should stop (optional, defaults to getting all the results)
77         
78         """
79         
80         self.caller = caller
81         self.target = target
82         self.config = config
83         self.action = action
84         self.stats = stats
85         self.stats.startedAction(action)
86         self.num = intify(target)
87         self.queried = {}
88         self.answered = {}
89         self.found = {}
90         self.sorted_nodes = []
91         self.results = {}
92         self.desired_results = num_results
93         self.callback = callback
94         self.outstanding = 0
95         self.outstanding_results = 0
96         self.finished = False
97         self.started = datetime.now()
98     
99         def sort(a, b, num=self.num):
100             """Sort nodes relative to the ID we are looking for."""
101             x, y = num ^ a.num, num ^ b.num
102             if x > y:
103                 return 1
104             elif x < y:
105                 return -1
106             return 0
107         self.sort = sort
108
109     #{ Main operation
110     def goWithNodes(self, nodes):
111         """Start the action's process with a list of nodes to contact."""
112         self.started = datetime.now()
113         for node in nodes:
114             self.found[node.id] = node
115         self.sortNodes()
116         self.schedule()
117     
118     def schedule(self):
119         """Schedule requests to be sent to remote nodes."""
120         # Check if we are already done
121         if self.desired_results and ((len(self.results) >= abs(self.desired_results)) or
122                                      (self.desired_results < 0 and
123                                       len(self.answered) >= self.config['STORE_REDUNDANCY'])):
124             self.finished = True
125             result = self.generateResult()
126             reactor.callLater(0, self.callback, *result)
127
128         if self.finished or (self.desired_results and 
129                              len(self.results) + self.outstanding_results >= abs(self.desired_results)):
130             return
131         
132         # Loop for each node that should be processed
133         for node in self.getNodesToProcess():
134             # Don't send requests twice or to ourself
135             if node.id not in self.queried:
136                 self.queried[node.id] = 1
137                 
138                 # Get the action to call on the node
139                 if node.id == self.caller.node.id:
140                     try:
141                         f = getattr(self.caller, 'krpc_' + self.action)
142                     except AttributeError:
143                         log.msg("%s doesn't have a %s method!" % (node, 'krpc_' + self.action))
144                         continue
145                 else:
146                     try:
147                         f = getattr(node, self.action)
148                     except AttributeError:
149                         log.msg("%s doesn't have a %s method!" % (node, self.action))
150                         continue
151
152                 # Get the arguments to the action's method
153                 try:
154                     args, expected_results = self.generateArgs(node)
155                 except ValueError:
156                     continue
157
158                 # Call the action on the remote node
159                 self.outstanding += 1
160                 self.outstanding_results += expected_results
161                 df = defer.maybeDeferred(f, *args)
162                 reactor.callLater(0, df.addCallbacks,
163                                   *(self.gotResponse, self.actionFailed),
164                                   **{'callbackArgs': (node, expected_results, df),
165                                      'errbackArgs': (node, expected_results, df)})
166                         
167             # We might have to stop for now
168             if (self.outstanding >= self.config['CONCURRENT_REQS'] or
169                 (self.desired_results and
170                  len(self.results) + self.outstanding_results >= abs(self.desired_results))):
171                 break
172             
173         assert self.outstanding >= 0
174         assert self.outstanding_results >= 0
175
176         # If no requests are outstanding, then we are done
177         if self.outstanding == 0:
178             self.finished = True
179             result = self.generateResult()
180             reactor.callLater(0, self.callback, *result)
181
182     def gotResponse(self, dict, node, expected_results, df):
183         """Receive a response from a remote node."""
184         self.caller.insertNode(node)
185         if self.finished or self.answered.has_key(node.id):
186             # a day late and a dollar short
187             return
188         self.outstanding -= 1
189         self.outstanding_results -= expected_results
190         self.answered[node.id] = 1
191         self.processResponse(dict)
192         self.schedule()
193
194     def actionFailed(self, err, node, expected_results, df):
195         """Receive an error from a remote node."""
196         log.msg("action %s failed (%s) %s/%s" % (self.action, self.config['PORT'], node.host, node.port))
197         log.err(err)
198         self.caller.table.nodeFailed(node)
199         self.outstanding -= 1
200         self.outstanding_results -= expected_results
201         self.schedule()
202     
203     def handleGotNodes(self, nodes):
204         """Process any received node contact info in the response.
205         
206         Not called by default, but suitable for being called by
207         L{processResponse} in a recursive node search.
208         """
209         for compact_node in nodes:
210             node_contact = uncompact(compact_node)
211             node = self.caller.Node(node_contact)
212             if not self.found.has_key(node.id):
213                 self.found[node.id] = node
214
215     def sortNodes(self):
216         """Sort the nodes, if necessary.
217         
218         Assumes nodes are never removed from the L{found} dictionary.
219         """
220         if len(self.sorted_nodes) != len(self.found):
221             self.sorted_nodes = self.found.values()
222             self.sorted_nodes.sort(self.sort)
223                 
224     #{ Subclass for specific actions
225     def getNodesToProcess(self):
226         """Generate a list of nodes to process next.
227         
228         This implementation is suitable for a recurring search over all nodes.
229         """
230         self.sortNodes()
231         return self.sorted_nodes[:K]
232     
233     def generateArgs(self, node):
234         """Generate the arguments to the node's action.
235         
236         Also return the number of results expected from this request.
237         
238         @raise ValueError: if the node should not be queried
239         """
240         return (self.caller.node.id, self.target), 0
241     
242     def processResponse(self, dict):
243         """Process the response dictionary received from the remote node."""
244         self.handleGotNodes(dict['nodes'])
245
246     def generateResult(self, nodes):
247         """Create the final result to return to the L{callback} function."""
248         self.stats.completedAction(self.action, self.started)
249         return []
250         
251
252 class FindNode(ActionBase):
253     """Find the closest nodes to the key."""
254
255     def __init__(self, caller, target, callback, config, stats, action="find_node"):
256         ActionBase.__init__(self, caller, target, callback, config, stats, action)
257
258     def processResponse(self, dict):
259         """Save the token received from each node."""
260         if dict["id"] in self.found:
261             self.found[dict["id"]].updateToken(dict.get('token', ''))
262         self.handleGotNodes(dict['nodes'])
263
264     def generateResult(self):
265         """Result is the K closest nodes to the target."""
266         self.sortNodes()
267         self.stats.completedAction(self.action, self.started)
268         return (self.sorted_nodes[:K], )
269     
270
271 class FindValue(ActionBase):
272     """Find the closest nodes to the key and check for values."""
273
274     def __init__(self, caller, target, callback, config, stats, action="find_value"):
275         ActionBase.__init__(self, caller, target, callback, config, stats, action)
276
277     def processResponse(self, dict):
278         """Save the number of values each node has."""
279         if dict["id"] in self.found:
280             self.found[dict["id"]].updateNumValues(dict.get('num', 0))
281         self.handleGotNodes(dict['nodes'])
282         
283     def generateResult(self):
284         """Result is the nodes that have values, sorted by proximity to the key."""
285         self.sortNodes()
286         self.stats.completedAction(self.action, self.started)
287         return ([node for node in self.sorted_nodes if node.num_values > 0], )
288     
289
290 class GetValue(ActionBase):
291     """Retrieve values from a list of nodes."""
292     
293     def __init__(self, caller, target, num_results, callback, config, stats, action="get_value"):
294         ActionBase.__init__(self, caller, target, callback, config, stats, action, num_results)
295
296     def getNodesToProcess(self):
297         """Nodes are never added, always return the same sorted node list."""
298         return self.sorted_nodes
299     
300     def generateArgs(self, node):
301         """Arguments include the number of values to request."""
302         if node.num_values > 0:
303             # Request all desired results from each node, just to be sure.
304             num_values = abs(self.desired_results) - len(self.results)
305             assert num_values > 0
306             if num_values > node.num_values:
307                 num_values = 0
308             return (self.caller.node.id, self.target, num_values), node.num_values
309         else:
310             raise ValueError, "Don't try and get values from this node because it doesn't have any"
311
312     def processResponse(self, dict):
313         """Save the returned values, calling the L{callback} each time there are new ones."""
314         if dict.has_key('values'):
315             def x(y, z=self.results):
316                 if not z.has_key(y):
317                     z[y] = 1
318                     return y
319                 else:
320                     return None
321             z = len(dict['values'])
322             v = filter(None, map(x, dict['values']))
323             if len(v):
324                 reactor.callLater(0, self.callback, self.target, v)
325
326     def generateResult(self):
327         """Results have all been returned, now send the empty list to end the action."""
328         self.stats.completedAction(self.action, self.started)
329         return (self.target, [])
330         
331
332 class StoreValue(ActionBase):
333     """Store a value in a list of nodes."""
334
335     def __init__(self, caller, target, value, num_results, callback, config, stats, action="store_value"):
336         """Initialize the action with the value to store.
337         
338         @type value: C{string}
339         @param value: the value to store in the nodes
340         """
341         ActionBase.__init__(self, caller, target, callback, config, stats, action, num_results)
342         self.value = value
343         
344     def getNodesToProcess(self):
345         """Nodes are never added, always return the same sorted list."""
346         return self.sorted_nodes
347
348     def generateArgs(self, node):
349         """Args include the value to store and the node's token."""
350         if node.token:
351             return (self.caller.node.id, self.target, self.value, node.token), 1
352         else:
353             raise ValueError, "Don't store at this node since we don't know it's token"
354
355     def processResponse(self, dict):
356         """Save the response, though it should be nothin but the ID."""
357         self.results[dict["id"]] = dict
358     
359     def generateResult(self):
360         """Return all the response IDs received."""
361         self.stats.completedAction(self.action, self.started)
362         return (self.target, self.value, self.results.values())