mirrors/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse.git synced 2024-11-27 20:22:07 +03:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #575 from matrix-org/daniel/roomcleanup

Browse source 
Merge two of the room join codepaths

There's at least one more to merge in.

Side-effects:
 * Stop reporting None as displayname and avatar_url in some cases
 * Joining a room by alias populates guest-ness in join event
 * Remove unspec'd PUT version of /join/<room_id_or_alias> which has not
   been called on matrix.org according to logs
 * Stop recording access_token_id on /join/room_id - currently we don't
   record it on /join/room_alias; I can try to thread it through at some
   point.
This commit is contained in:
Daniel Wagner-Hall 2016-02-12 15:11:59 +00:00
commit d7aa103f00
5 changed files with 73 additions and 69 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
synapse/api/errors.py
View file

@ -84,6 +84,11 @@ class RegistrationError(SynapseError):
pass
class BadIdentifierError(SynapseError):
"""An error indicating an identifier couldn't be parsed."""
pass
class UnrecognizedRequestError(SynapseError):
"""An error indicating we don't understand the request you're trying to make"""
def __init__(self, *args, **kwargs):

11
synapse/handlers/profile.py
View file

@ -169,8 +169,15 @@ class ProfileHandler(BaseHandler):
consumeErrors=True
).addErrback(unwrapFirstError)
state["displayname"] = displayname
state["avatar_url"] = avatar_url
if displayname is None:
del state["displayname"]
else:
state["displayname"] = displayname
if avatar_url is None:
del state["avatar_url"]
else:
state["avatar_url"] = avatar_url
defer.returnValue(None)

44
synapse/handlers/room.py
View file

@ -527,7 +527,17 @@ class RoomMemberHandler(BaseHandler):
defer.returnValue({"room_id": room_id})
@defer.inlineCallbacks
def join_room_alias(self, joinee, room_alias, content={}):
def lookup_room_alias(self, room_alias):
"""
Gets the room ID for an alias.
Args:
room_alias (str): The room alias to look up.
Returns:
A tuple of the room ID (str) and the hosts hosting the room ([str])
Raises:
SynapseError if the room couldn't be looked up.
"""
directory_handler = self.hs.get_handlers().directory_handler
mapping = yield directory_handler.get_association(room_alias)
@ -539,24 +549,40 @@ class RoomMemberHandler(BaseHandler):
if not hosts:
raise SynapseError(404, "No known servers")
# If event doesn't include a display name, add one.
yield collect_presencelike_data(self.distributor, joinee, content)
defer.returnValue((room_id, hosts))
@defer.inlineCallbacks
def do_join(self, requester, room_id, hosts=None):
"""
Joins requester to room_id.
Args:
requester (Requester): The user joining the room.
room_id (str): The room ID (not alias) being joined.
hosts ([str]): A list of hosts which are hopefully in the room.
Raises:
SynapseError if the room couldn't be joined.
"""
hosts = hosts or []
content = {"membership": Membership.JOIN}
if requester.is_guest:
content["kind"] = "guest"
yield collect_presencelike_data(self.distributor, requester.user, content)
content.update({"membership": Membership.JOIN})
builder = self.event_builder_factory.new({
"type": EventTypes.Member,
"state_key": joinee.to_string(),
"state_key": requester.user.to_string(),
"room_id": room_id,
"sender": joinee.to_string(),
"membership": Membership.JOIN,
"sender": requester.user.to_string(),
"membership": Membership.JOIN, # For backwards compatibility
"content": content,
})
event, context = yield self._create_new_client_event(builder)
yield self._do_join(event, context, room_hosts=hosts)
defer.returnValue({"room_id": room_id})
@defer.inlineCallbacks
def _do_join(self, event, context, room_hosts=None):
room_id = event.room_id

68
synapse/rest/client/v1/room.py
View file

@ -216,11 +216,7 @@ class RoomSendEventRestServlet(ClientV1RestServlet):
# TODO: Needs unit testing for room ID + alias joins
class JoinRoomAliasServlet(ClientV1RestServlet):
def register(self, http_server):
# /join/$room_identifier[/$txn_id]
PATTERNS = ("/join/(?P<room_identifier>[^/]*)")
register_txn_path(self, PATTERNS, http_server)
PATTERNS = client_path_patterns("/join/(?P<room_identifier>[^/]*)$")
@defer.inlineCallbacks
def on_POST(self, request, room_identifier, txn_id=None):
@ -229,60 +225,22 @@ class JoinRoomAliasServlet(ClientV1RestServlet):
allow_guest=True,
)
# the identifier could be a room alias or a room id. Try one then the
# other if it fails to parse, without swallowing other valid
# SynapseErrors.
handler = self.handlers.room_member_handler
identifier = None
is_room_alias = False
try:
identifier = RoomAlias.from_string(room_identifier)
is_room_alias = True
except SynapseError:
identifier = RoomID.from_string(room_identifier)
room_id = None
hosts = []
if RoomAlias.is_valid(room_identifier):
room_alias = RoomAlias.from_string(room_identifier)
room_id, hosts = yield handler.lookup_room_alias(room_alias)
else:
room_id = RoomID.from_string(room_identifier).to_string()
# TODO: Support for specifying the home server to join with?
if is_room_alias:
handler = self.handlers.room_member_handler
ret_dict = yield handler.join_room_alias(
requester.user,
identifier,
)
defer.returnValue((200, ret_dict))
else: # room id
msg_handler = self.handlers.message_handler
content = {"membership": Membership.JOIN}
if requester.is_guest:
content["kind"] = "guest"
yield msg_handler.create_and_send_event(
{
"type": EventTypes.Member,
"content": content,
"room_id": identifier.to_string(),
"sender": requester.user.to_string(),
"state_key": requester.user.to_string(),
},
token_id=requester.access_token_id,
txn_id=txn_id,
is_guest=requester.is_guest,
)
defer.returnValue((200, {"room_id": identifier.to_string()}))
@defer.inlineCallbacks
def on_PUT(self, request, room_identifier, txn_id):
try:
defer.returnValue(
self.txns.get_client_transaction(request, txn_id)
)
except KeyError:
pass
response = yield self.on_POST(request, room_identifier, txn_id)
self.txns.store_client_transaction(request, txn_id, response)
defer.returnValue(response)
yield handler.do_join(
requester, room_id, hosts=hosts
)
defer.returnValue((200, {"room_id": room_id}))
# TODO: Needs unit testing

14
synapse/types.py
View file

@ -13,7 +13,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
from synapse.api.errors import SynapseError
from synapse.api.errors import SynapseError, BadIdentifierError
from collections import namedtuple
@ -51,13 +51,13 @@ class DomainSpecificString(
def from_string(cls, s):
"""Parse the string given by 's' into a structure object."""
if len(s) < 1 or s[0] != cls.SIGIL:
raise SynapseError(400, "Expected %s string to start with '%s'" % (
raise BadIdentifierError(400, "Expected %s string to start with '%s'" % (
cls.__name__, cls.SIGIL,
))
parts = s[1:].split(':', 1)
if len(parts) != 2:
raise SynapseError(
raise BadIdentifierError(
400, "Expected %s of the form '%slocalname:domain'" % (
cls.__name__, cls.SIGIL,
)
@ -69,6 +69,14 @@ class DomainSpecificString(
# names on one HS
return cls(localpart=parts[0], domain=domain)
@classmethod
def is_valid(cls, s):
try:
cls.from_string(s)
return True
except:
return False
def to_string(self):
"""Return a string encoding the fields of the structure object."""
return "%s%s:%s" % (self.SIGIL, self.localpart, self.domain)