faf031acd7
- can register callbacks on specific HTTP methods and paths - Can call update_poll in event loop to check for new incoming requests - update server example script
131 lines
5.2 KiB
Python
131 lines
5.2 KiB
Python
# The MIT License (MIT)
|
|
#
|
|
# Copyright (c) 2019 ladyada for Adafruit Industries
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
# of this software and associated documentation files (the "Software"), to deal
|
|
# in the Software without restriction, including without limitation the rights
|
|
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
# copies of the Software, and to permit persons to whom the Software is
|
|
# furnished to do so, subject to the following conditions:
|
|
#
|
|
# The above copyright notice and this permission notice shall be included in
|
|
# all copies or substantial portions of the Software.
|
|
#
|
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
# THE SOFTWARE.
|
|
|
|
"""
|
|
`adafruit_esp32spi_server`
|
|
================================================================================
|
|
|
|
TODO: better description?
|
|
Server management lib to make handling and responding to incoming requests much easier
|
|
|
|
* Author(s): Matt Costi
|
|
"""
|
|
|
|
from micropython import const
|
|
import adafruit_esp32spi.adafruit_esp32spi_socket as socket
|
|
from adafruit_esp32spi.adafruit_esp32spi_requests import parse_headers
|
|
|
|
_the_interface = None # pylint: disable=invalid-name
|
|
def set_interface(iface):
|
|
"""Helper to set the global internet interface"""
|
|
global _the_interface # pylint: disable=global-statement, invalid-name
|
|
_the_interface = iface
|
|
socket.set_interface(iface)
|
|
|
|
NO_SOCK_AVAIL = const(255)
|
|
|
|
|
|
# pylint: disable=unused-argument, redefined-builtin, invalid-name
|
|
class server:
|
|
""" TODO: class docs """
|
|
def __init__(self, port=80, debug=False):
|
|
self.port = port
|
|
self._server_sock = socket.socket(socknum=NO_SOCK_AVAIL)
|
|
self._client_sock = socket.socket(socknum=NO_SOCK_AVAIL)
|
|
self._debug = debug
|
|
self._listeners = {}
|
|
|
|
|
|
def start(self):
|
|
""" start the server """
|
|
self._server_sock = socket.socket()
|
|
_the_interface.start_server(self.port, self._server_sock.socknum)
|
|
if self._debug:
|
|
ip = _the_interface.pretty_ip(_the_interface.ip_address)
|
|
print("Server available at {0}:{1}".format(ip, self.port))
|
|
print("Sever status: ", _the_interface.get_server_state(self._server_sock.socknum))
|
|
|
|
def on(self, method, path, request_handler):
|
|
"""
|
|
Register a Request Handler for a particular HTTP method and path.
|
|
request_handler will be called whenever a matching HTTP request is received.
|
|
|
|
request_handler should accept the following args:
|
|
(Dict headers, bytes body, Socket client)
|
|
:param str method: the method of the HTTP request
|
|
:param str path: the path of the HTTP request
|
|
:param func request_handler: the function to call
|
|
"""
|
|
self._listeners[self._get_listener_key(method, path)] = request_handler
|
|
|
|
def update_poll(self):
|
|
client = self.client_available()
|
|
if (client and client.available()):
|
|
line = client.readline()
|
|
method, path, ver = line.split(None, 2)
|
|
key = self._get_listener_key(method, path)
|
|
if key in self._listeners:
|
|
headers = parse_headers(client)
|
|
body = client.read()
|
|
print("headers: ", headers)
|
|
print("body: ", body)
|
|
self._listeners[key](headers, body, client)
|
|
else:
|
|
# TODO: support optional custom 404 callback?
|
|
client.write(b"HTTP/1.1 404 NotFound\r\n")
|
|
client.close()
|
|
|
|
|
|
def client_available(self):
|
|
"""
|
|
returns a client socket connection if available.
|
|
Otherwise, returns None
|
|
:return: the client
|
|
:rtype: Socket
|
|
"""
|
|
sock = None
|
|
if self._server_sock.socknum != NO_SOCK_AVAIL:
|
|
if self._client_sock.socknum != NO_SOCK_AVAIL:
|
|
# check previous received client socket
|
|
if self._debug:
|
|
print("checking if last client sock still valid")
|
|
if self._client_sock.connected() and self._client_sock.available():
|
|
sock = self._client_sock
|
|
if not sock:
|
|
# check for new client sock
|
|
if self._debug:
|
|
print("checking for new client sock")
|
|
client_sock_num = _the_interface.socket_available(self._server_sock.socknum)
|
|
sock = socket.socket(socknum=client_sock_num)
|
|
else:
|
|
print("Server has not been started, cannot check for clients!")
|
|
|
|
if sock and sock.socknum != NO_SOCK_AVAIL:
|
|
if self._debug:
|
|
print("client sock num is: ", sock.socknum)
|
|
self._client_sock = sock
|
|
return self._client_sock
|
|
|
|
return None
|
|
|
|
def _get_listener_key(self, method, path):
|
|
return "{0}|{1}".format(str(method.lower(), 'utf-8'), str(path, 'utf-8'))
|