summary refs log blame commit diff
path: root/synapse/rest/client/v1/base.py
blob: 504a5e432fda4d1492c4668df3645c0d258402c5 (plain) (tree)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
                       
                                     










                                                                          
 


                                                                              
                                          
                                              
         



                                    









                                                                             
                                                       
 
                                                                


                           
                                         
                                                             
                                   
                                          
# -*- coding: utf-8 -*-
# Copyright 2014, 2015 OpenMarket 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.

"""This module contains base REST classes for constructing client v1 servlets.
"""

from synapse.http.servlet import RestServlet
from synapse.api.urls import CLIENT_PREFIX
from .transactions import HttpTransactionStore
import re

import logging


logger = logging.getLogger(__name__)


def client_path_pattern(path_regex):
    """Creates a regex compiled client path with the correct client path
    prefix.

    Args:
        path_regex (str): The regex string to match. This should NOT have a ^
        as this will be prefixed.
    Returns:
        SRE_Pattern
    """
    return re.compile("^" + CLIENT_PREFIX + path_regex)


class ClientV1RestServlet(RestServlet):
    """A base Synapse REST Servlet for the client version 1 API.
    """

    def __init__(self, hs):
        self.hs = hs
        self.handlers = hs.get_handlers()
        self.builder_factory = hs.get_event_builder_factory()
        self.auth = hs.get_v1auth()
        self.txns = HttpTransactionStore()