mirror of
https://mau.dev/maunium/synapse.git
synced 2024-08-25 03:35:28 +00:00
![Richard van der Hoff](/assets/img/avatar_default.png)
Nothing uses this now, so we can remove the dead code, and clean up the API. Since we're changing the shape of the return value anyway, we take the opportunity to give the method a better name.
152 lines
5.3 KiB
Python
152 lines
5.3 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright 2019 New Vector Ltd
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
import logging
|
|
|
|
from twisted.internet import defer
|
|
|
|
from synapse.http.servlet import parse_json_object_from_request
|
|
from synapse.replication.http._base import ReplicationEndpoint
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class ReplicationRegisterServlet(ReplicationEndpoint):
|
|
"""Register a new user
|
|
"""
|
|
|
|
NAME = "register_user"
|
|
PATH_ARGS = ("user_id",)
|
|
|
|
def __init__(self, hs):
|
|
super(ReplicationRegisterServlet, self).__init__(hs)
|
|
self.store = hs.get_datastore()
|
|
self.registration_handler = hs.get_registration_handler()
|
|
|
|
@staticmethod
|
|
def _serialize_payload(
|
|
user_id,
|
|
password_hash,
|
|
was_guest,
|
|
make_guest,
|
|
appservice_id,
|
|
create_profile_with_displayname,
|
|
admin,
|
|
user_type,
|
|
address,
|
|
):
|
|
"""
|
|
Args:
|
|
user_id (str): The desired user ID to register.
|
|
password_hash (str|None): Optional. The password hash for this user.
|
|
was_guest (bool): Optional. Whether this is a guest account being
|
|
upgraded to a non-guest account.
|
|
make_guest (boolean): True if the the new user should be guest,
|
|
false to add a regular user account.
|
|
appservice_id (str|None): The ID of the appservice registering the user.
|
|
create_profile_with_displayname (unicode|None): Optionally create a
|
|
profile for the user, setting their displayname to the given value
|
|
admin (boolean): is an admin user?
|
|
user_type (str|None): type of user. One of the values from
|
|
api.constants.UserTypes, or None for a normal user.
|
|
address (str|None): the IP address used to perform the regitration.
|
|
"""
|
|
return {
|
|
"password_hash": password_hash,
|
|
"was_guest": was_guest,
|
|
"make_guest": make_guest,
|
|
"appservice_id": appservice_id,
|
|
"create_profile_with_displayname": create_profile_with_displayname,
|
|
"admin": admin,
|
|
"user_type": user_type,
|
|
"address": address,
|
|
}
|
|
|
|
@defer.inlineCallbacks
|
|
def _handle_request(self, request, user_id):
|
|
content = parse_json_object_from_request(request)
|
|
|
|
yield self.registration_handler.register_with_store(
|
|
user_id=user_id,
|
|
password_hash=content["password_hash"],
|
|
was_guest=content["was_guest"],
|
|
make_guest=content["make_guest"],
|
|
appservice_id=content["appservice_id"],
|
|
create_profile_with_displayname=content["create_profile_with_displayname"],
|
|
admin=content["admin"],
|
|
user_type=content["user_type"],
|
|
address=content["address"],
|
|
)
|
|
|
|
defer.returnValue((200, {}))
|
|
|
|
|
|
class ReplicationPostRegisterActionsServlet(ReplicationEndpoint):
|
|
"""Run any post registration actions
|
|
"""
|
|
|
|
NAME = "post_register"
|
|
PATH_ARGS = ("user_id",)
|
|
|
|
def __init__(self, hs):
|
|
super(ReplicationPostRegisterActionsServlet, self).__init__(hs)
|
|
self.store = hs.get_datastore()
|
|
self.registration_handler = hs.get_registration_handler()
|
|
|
|
@staticmethod
|
|
def _serialize_payload(user_id, auth_result, access_token, bind_email, bind_msisdn):
|
|
"""
|
|
Args:
|
|
user_id (str): The user ID that consented
|
|
auth_result (dict): The authenticated credentials of the newly
|
|
registered user.
|
|
access_token (str|None): The access token of the newly logged in
|
|
device, or None if `inhibit_login` enabled.
|
|
bind_email (bool): Whether to bind the email with the identity
|
|
server
|
|
bind_msisdn (bool): Whether to bind the msisdn with the identity
|
|
server
|
|
"""
|
|
return {
|
|
"auth_result": auth_result,
|
|
"access_token": access_token,
|
|
"bind_email": bind_email,
|
|
"bind_msisdn": bind_msisdn,
|
|
}
|
|
|
|
@defer.inlineCallbacks
|
|
def _handle_request(self, request, user_id):
|
|
content = parse_json_object_from_request(request)
|
|
|
|
auth_result = content["auth_result"]
|
|
access_token = content["access_token"]
|
|
bind_email = content["bind_email"]
|
|
bind_msisdn = content["bind_msisdn"]
|
|
|
|
yield self.registration_handler.post_registration_actions(
|
|
user_id=user_id,
|
|
auth_result=auth_result,
|
|
access_token=access_token,
|
|
bind_email=bind_email,
|
|
bind_msisdn=bind_msisdn,
|
|
)
|
|
|
|
defer.returnValue((200, {}))
|
|
|
|
|
|
def register_servlets(hs, http_server):
|
|
ReplicationRegisterServlet(hs).register(http_server)
|
|
ReplicationPostRegisterActionsServlet(hs).register(http_server)
|