diff --git a/synapse/handlers/admin.py b/synapse/handlers/admin.py
index 6c905e97a7..69d2c8c36f 100644
--- a/synapse/handlers/admin.py
+++ b/synapse/handlers/admin.py
@@ -99,7 +99,7 @@ class AdminHandler(BaseHandler):
defer.returnValue(ret)
@defer.inlineCallbacks
- def exfiltrate_user_data(self, user_id, writer):
+ def export_user_data(self, user_id, writer):
"""Write all data we have on the user to the given writer.
Args:
@@ -107,7 +107,8 @@ class AdminHandler(BaseHandler):
writer (ExfiltrationWriter)
Returns:
- defer.Deferred
+ defer.Deferred: Resolves when all data for a user has been written.
+ The returned value is that returned by `writer.finished()`.
"""
# Get all rooms the user is in or has been in
rooms = yield self.store.get_rooms_for_user_where_membership_is(
@@ -134,7 +135,7 @@ class AdminHandler(BaseHandler):
forgotten = yield self.store.did_forget(user_id, room_id)
if forgotten:
- logger.info("[%s] User forgot room %d, ignoring", room_id)
+ logger.info("[%s] User forgot room %d, ignoring", user_id, room_id)
continue
if room_id not in rooms_user_has_been_in:
@@ -172,9 +173,10 @@ class AdminHandler(BaseHandler):
# dict[str, set[str]].
event_to_unseen_prevs = {}
- # The reverse mapping to above, i.e. map from unseen event to parent
- # events. dict[str, set[str]]
- unseen_event_to_parents = {}
+ # The reverse mapping to above, i.e. map from unseen event to events
+ # that have the unseen event in their prev_events, i.e. the unseen
+ # events "children". dict[str, set[str]]
+ unseen_to_child_events = {}
# We fetch events in the room the user could see by fetching *all*
# events that we have and then filtering, this isn't the most
@@ -200,14 +202,14 @@ class AdminHandler(BaseHandler):
if unseen_events:
event_to_unseen_prevs[event.event_id] = unseen_events
for unseen in unseen_events:
- unseen_event_to_parents.setdefault(unseen, set()).add(
+ unseen_to_child_events.setdefault(unseen, set()).add(
event.event_id
)
# Now check if this event is an unseen prev event, if so
# then we remove this event from the appropriate dicts.
- for event_id in unseen_event_to_parents.pop(event.event_id, []):
- event_to_unseen_prevs.get(event_id, set()).discard(
+ for child_id in unseen_to_child_events.pop(event.event_id, []):
+ event_to_unseen_prevs.get(child_id, set()).discard(
event.event_id
)
@@ -233,7 +235,7 @@ class AdminHandler(BaseHandler):
class ExfiltrationWriter(object):
- """Interface used to specify how to write exfiltrated data.
+ """Interface used to specify how to write exported data.
"""
def write_events(self, room_id, events):
@@ -254,7 +256,7 @@ class ExfiltrationWriter(object):
Args:
room_id (str)
event_id (str)
- state (list[FrozenEvent])
+ state (dict[tuple[str, str], FrozenEvent])
"""
pass
@@ -264,13 +266,16 @@ class ExfiltrationWriter(object):
Args:
room_id (str)
event (FrozenEvent)
- state (list[dict]): A subset of the state at the invite, with a
- subset of the event keys (type, state_key, content and sender)
+ state (dict[tuple[str, str], dict]): A subset of the state at the
+ invite, with a subset of the event keys (type, state_key
+ content and sender)
"""
def finished(self):
- """Called when exfiltration is complete, and the return valus is passed
- to the requester.
+ """Called when all data has succesfully been exported and written.
+
+ This functions return value is passed to the caller of
+ `export_user_data`.
"""
pass
@@ -281,7 +286,7 @@ class FileExfiltrationWriter(ExfiltrationWriter):
Returns the directory location on completion.
Args:
- user_id (str): The user whose data is being exfiltrated.
+ user_id (str): The user whose data is being exported.
directory (str|None): The directory to write the data to. If None then
will write to a temporary directory.
"""
@@ -293,7 +298,7 @@ class FileExfiltrationWriter(ExfiltrationWriter):
self.base_directory = directory
else:
self.base_directory = tempfile.mkdtemp(
- prefix="synapse-exfiltrate__%s__" % (user_id,)
+ prefix="synapse-exported__%s__" % (user_id,)
)
os.makedirs(self.base_directory, exist_ok=True)
|
