|
|
@@ -0,0 +1,198 @@
|
|
|
+import json
|
|
|
+import logging
|
|
|
+import threading
|
|
|
+from functools import partial
|
|
|
+
|
|
|
+from django.http import HttpResponse, HttpRequest
|
|
|
+
|
|
|
+from .httpbased import HttpContext, HttpHandler, run_event_loop
|
|
|
+from ..session import register_session_implement_for_target
|
|
|
+from ..utils import STATIC_PATH, iscoroutinefunction, isgeneratorfunction, get_free_port
|
|
|
+
|
|
|
+logger = logging.getLogger(__name__)
|
|
|
+
|
|
|
+
|
|
|
+class DjangoHttpContext(HttpContext):
|
|
|
+ def __init__(self, request: HttpRequest):
|
|
|
+ self.request = request
|
|
|
+ self.response = HttpResponse()
|
|
|
+
|
|
|
+ def request_method(self):
|
|
|
+ """返回当前请求的方法，大写"""
|
|
|
+ return self.request.method
|
|
|
+
|
|
|
+ def request_headers(self):
|
|
|
+ """返回当前请求的header字典"""
|
|
|
+ return self.request.headers
|
|
|
+
|
|
|
+ def request_url_parameter(self, name, default=None):
|
|
|
+ """返回当前请求的URL参数"""
|
|
|
+ return self.request.GET.get(name, default=default)
|
|
|
+
|
|
|
+ def request_json(self):
|
|
|
+ """返回当前请求的json反序列化后的内容，若请求数据不为json格式，返回None"""
|
|
|
+ try:
|
|
|
+ return json.loads(self.request.body.decode('utf8'))
|
|
|
+ except Exception:
|
|
|
+ return None
|
|
|
+
|
|
|
+ def set_header(self, name, value):
|
|
|
+ """为当前响应设置header"""
|
|
|
+ self.response[name] = value
|
|
|
+
|
|
|
+ def set_status(self, status: int):
|
|
|
+ """为当前响应设置http status"""
|
|
|
+ self.response.status_code = status
|
|
|
+
|
|
|
+ def set_content(self, content, json_type=False):
|
|
|
+ """设置相应的内容
|
|
|
+
|
|
|
+ :param content:
|
|
|
+ :param bool json_type: content是否要序列化成json格式，并将 content-type 设置为application/json
|
|
|
+ """
|
|
|
+ if json_type:
|
|
|
+ self.set_header('content-type', 'application/json')
|
|
|
+ self.response.content = json.dumps(content)
|
|
|
+ else:
|
|
|
+ self.response.content = content
|
|
|
+
|
|
|
+ def get_response(self):
|
|
|
+ """获取当前的响应对象，用于在私图函数中返回"""
|
|
|
+ return self.response
|
|
|
+
|
|
|
+
|
|
|
+def webio_view(target,
|
|
|
+ session_expire_seconds=None,
|
|
|
+ session_cleanup_interval=None,
|
|
|
+ allowed_origins=None, check_origin=None):
|
|
|
+ """获取用于与后端实现进行整合的view函数，基于http请求与前端进行通讯
|
|
|
+
|
|
|
+ :param target: 任务函数。任务函数为协程函数时，使用 :ref:`基于协程的会话实现 <coroutine_based_session>` ；任务函数为普通函数时，使用基于线程的会话实现。
|
|
|
+ :param int session_expire_seconds: 会话不活跃过期时间。
|
|
|
+ :param int session_cleanup_interval: 会话清理间隔。
|
|
|
+ :param list allowed_origins: 除当前域名外，服务器还允许的请求的来源列表。
|
|
|
+ 来源包含协议和域名和端口部分，允许使用 Unix shell 风格的匹配模式:
|
|
|
+
|
|
|
+ - ``*`` 为通配符
|
|
|
+ - ``?`` 匹配单个字符
|
|
|
+ - ``[seq]`` 匹配seq内的字符
|
|
|
+ - ``[!seq]`` 匹配不在seq内的字符
|
|
|
+
|
|
|
+ 比如 ``https://*.example.com`` 、 ``*://*.example.com``
|
|
|
+ :param callable check_origin: 请求来源检查函数。接收请求来源(包含协议和域名和端口部分)字符串，
|
|
|
+ 返回 ``True/False`` 。若设置了 ``check_origin`` ， ``allowed_origins`` 参数将被忽略
|
|
|
+ :return: Django视图函数
|
|
|
+ """
|
|
|
+ session_cls = register_session_implement_for_target(target)
|
|
|
+ handler = HttpHandler(target=target, session_cls=session_cls,
|
|
|
+ session_expire_seconds=session_expire_seconds,
|
|
|
+ session_cleanup_interval=session_cleanup_interval,
|
|
|
+ allowed_origins=allowed_origins, check_origin=check_origin)
|
|
|
+
|
|
|
+ def view_func(request):
|
|
|
+ context = DjangoHttpContext(request)
|
|
|
+ return handler.handle_request(context)
|
|
|
+
|
|
|
+ view_func.__name__ = 'webio_view'
|
|
|
+ return view_func
|
|
|
+
|
|
|
+
|
|
|
+urlpatterns = []
|
|
|
+
|
|
|
+
|
|
|
+def start_server(target, port=8080, host='localhost',
|
|
|
+ allowed_origins=None, check_origin=None,
|
|
|
+ disable_asyncio=False,
|
|
|
+ session_cleanup_interval=None,
|
|
|
+ session_expire_seconds=None,
|
|
|
+ debug=False, **django_options):
|
|
|
+ """启动一个 Django server 来运行PyWebIO的 ``target`` 服务
|
|
|
+
|
|
|
+ :param target: task function. It's a coroutine function is use CoroutineBasedSession or
|
|
|
+ a simple function is use ThreadBasedSession.
|
|
|
+ :param port: server bind port. set ``0`` to find a free port number to use
|
|
|
+ :param host: server bind host. ``host`` may be either an IP address or hostname. If it's a hostname,
|
|
|
+ :param list allowed_origins: 除当前域名外，服务器还允许的请求的来源列表。
|
|
|
+ 来源包含协议和域名和端口部分，允许使用 Unix shell 风格的匹配模式:
|
|
|
+
|
|
|
+ - ``*`` 为通配符
|
|
|
+ - ``?`` 匹配单个字符
|
|
|
+ - ``[seq]`` 匹配seq内的字符
|
|
|
+ - ``[!seq]`` 匹配不在seq内的字符
|
|
|
+
|
|
|
+ 比如 ``https://*.example.com`` 、 ``*://*.example.com``
|
|
|
+ :param callable check_origin: 请求来源检查函数。接收请求来源(包含协议和域名和端口部分)字符串，
|
|
|
+ 返回 ``True/False`` 。若设置了 ``check_origin`` ， ``allowed_origins`` 参数将被忽略
|
|
|
+ :param bool disable_asyncio: 禁用 asyncio 函数。仅在 ``target`` 为协程函数时有效。
|
|
|
+
|
|
|
+ .. note:: 实现说明：
|
|
|
+ 当使用Django backend时，若要在PyWebIO的会话中使用 ``asyncio`` 标准库里的协程函数，PyWebIO需要单独开启一个线程来运行 ``asyncio`` 事件循环，
|
|
|
+ 若程序中没有使用到 ``asyncio`` 中的异步函数，可以开启此选项来避免不必要的资源浪费
|
|
|
+
|
|
|
+ :param int session_expire_seconds: 会话过期时间。若 session_expire_seconds 秒内没有收到客户端的请求，则认为会话过期。
|
|
|
+ :param int session_cleanup_interval: 会话清理间隔。
|
|
|
+ :param bool debug: 开启 Django debug mode 和一般访问日志的记录
|
|
|
+ :param django_options: django应用的其他设置，见 https://docs.djangoproject.com/en/3.0/ref/settings/ .
|
|
|
+ 其中 ``DEBUG`` 、 ``ALLOWED_HOSTS`` 、 ``ROOT_URLCONF`` 、 ``SECRET_KEY`` 被PyWebIO设置，不可以手动指定
|
|
|
+ """
|
|
|
+ global urlpatterns
|
|
|
+
|
|
|
+ from django.conf import settings
|
|
|
+ from django.core.wsgi import get_wsgi_application
|
|
|
+ from django.urls import path
|
|
|
+ from django.utils.crypto import get_random_string
|
|
|
+ from django.views.static import serve
|
|
|
+ from django.core.management import call_command
|
|
|
+
|
|
|
+ if port == 0:
|
|
|
+ port = get_free_port()
|
|
|
+
|
|
|
+ django_options.update(dict(
|
|
|
+ DEBUG=debug,
|
|
|
+ ALLOWED_HOSTS=["*"], # Disable host header validation
|
|
|
+ ROOT_URLCONF=__name__, # Make this module the urlconf
|
|
|
+ SECRET_KEY=get_random_string(10), # We aren't using any security features but Django requires this setting
|
|
|
+ ))
|
|
|
+ django_options.setdefault('LOGGING', {
|
|
|
+ 'version': 1,
|
|
|
+ 'disable_existing_loggers': False,
|
|
|
+ 'formatters': {
|
|
|
+ 'simple': {
|
|
|
+ 'format': '[%(asctime)s] %(message)s'
|
|
|
+ },
|
|
|
+ },
|
|
|
+ 'handlers': {
|
|
|
+ 'console': {
|
|
|
+ 'class': 'logging.StreamHandler',
|
|
|
+ 'formatter': 'simple'
|
|
|
+ },
|
|
|
+ },
|
|
|
+ 'loggers': {
|
|
|
+ 'django.server': {
|
|
|
+ 'level': 'INFO' if debug else 'WARN',
|
|
|
+ 'handlers': ['console'],
|
|
|
+ },
|
|
|
+ },
|
|
|
+ })
|
|
|
+ settings.configure(**django_options)
|
|
|
+
|
|
|
+ webio_view_func = webio_view(
|
|
|
+ target,
|
|
|
+ session_expire_seconds=session_expire_seconds,
|
|
|
+ session_cleanup_interval=session_cleanup_interval,
|
|
|
+ allowed_origins=allowed_origins,
|
|
|
+ check_origin=check_origin
|
|
|
+ )
|
|
|
+
|
|
|
+ urlpatterns = [
|
|
|
+ path(r"io", webio_view_func),
|
|
|
+ path(r'', partial(serve, path='index.html'), {'document_root': STATIC_PATH}),
|
|
|
+ path(r'<path:path>', serve, {'document_root': STATIC_PATH}),
|
|
|
+ ]
|
|
|
+
|
|
|
+ get_wsgi_application()
|
|
|
+
|
|
|
+ if not disable_asyncio and (iscoroutinefunction(target) or isgeneratorfunction(target)):
|
|
|
+ threading.Thread(target=run_event_loop, daemon=True).start()
|
|
|
+
|
|
|
+ call_command('runserver', '%s:%d' % (host, port))
|
wangweimin