2014-08-30 17:15:14 +00:00
|
|
|
# Nemubot is a smart and modulable IM bot.
|
2015-01-03 19:17:46 +00:00
|
|
|
# Copyright (C) 2012-2015 Mercier Pierre-Olivier
|
2014-08-30 17:15:14 +00:00
|
|
|
#
|
|
|
|
# This program is free software: you can redistribute it and/or modify
|
|
|
|
# it under the terms of the GNU Affero General Public License as published by
|
|
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
|
|
# (at your option) any later version.
|
|
|
|
#
|
|
|
|
# This program is distributed in the hope that it will be useful,
|
|
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
# GNU Affero General Public License for more details.
|
|
|
|
#
|
|
|
|
# You should have received a copy of the GNU Affero General Public License
|
|
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
2015-07-18 12:01:56 +00:00
|
|
|
import nemubot.message as message
|
2015-07-17 18:04:37 +00:00
|
|
|
from nemubot.message.printer.socket import Socket as SocketPrinter
|
2015-02-21 12:51:40 +00:00
|
|
|
from nemubot.server.abstract import AbstractServer
|
2014-08-30 17:15:14 +00:00
|
|
|
|
2014-11-09 13:11:54 +00:00
|
|
|
|
2014-08-30 17:15:14 +00:00
|
|
|
class SocketServer(AbstractServer):
|
|
|
|
|
2014-11-09 13:11:54 +00:00
|
|
|
"""Concrete implementation of a socket connexion (can be wrapped with TLS)"""
|
|
|
|
|
2016-05-16 15:35:24 +00:00
|
|
|
def __init__(self, sock_location=None,
|
|
|
|
host=None, port=None,
|
|
|
|
sock=None,
|
|
|
|
ssl=False,
|
|
|
|
name=None):
|
|
|
|
"""Create a server socket
|
|
|
|
|
|
|
|
Keyword arguments:
|
|
|
|
sock_location -- Path to the UNIX socket
|
|
|
|
host -- Hostname of the INET socket
|
|
|
|
port -- Port of the INET socket
|
|
|
|
sock -- Already connected socket
|
|
|
|
ssl -- Should TLS connection enabled
|
|
|
|
name -- Convinience name
|
|
|
|
"""
|
|
|
|
|
|
|
|
import socket
|
|
|
|
|
|
|
|
assert(sock is None or isinstance(sock, socket.SocketType))
|
|
|
|
assert(port is None or isinstance(port, int))
|
|
|
|
|
|
|
|
super().__init__(name=name)
|
|
|
|
|
|
|
|
if sock is None:
|
|
|
|
if sock_location is not None:
|
|
|
|
self.socket = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
|
|
|
|
self.connect_to = sock_location
|
|
|
|
elif host is not None:
|
|
|
|
for af, socktype, proto, canonname, sa in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
|
|
|
|
self.socket = socket.socket(af, socktype, proto)
|
|
|
|
self.connect_to = sa
|
|
|
|
break
|
|
|
|
else:
|
|
|
|
self.socket = sock
|
|
|
|
|
2014-08-30 17:15:14 +00:00
|
|
|
self.ssl = ssl
|
|
|
|
|
|
|
|
self.readbuffer = b''
|
2015-07-17 18:04:37 +00:00
|
|
|
self.printer = SocketPrinter
|
2014-08-30 17:15:14 +00:00
|
|
|
|
2014-10-09 05:37:52 +00:00
|
|
|
|
2014-08-30 17:15:14 +00:00
|
|
|
def fileno(self):
|
|
|
|
return self.socket.fileno() if self.socket else None
|
|
|
|
|
2014-10-09 05:37:52 +00:00
|
|
|
|
2014-09-30 22:33:52 +00:00
|
|
|
@property
|
2016-04-18 17:58:10 +00:00
|
|
|
def closed(self):
|
2014-10-09 05:37:52 +00:00
|
|
|
"""Indicator of the connection aliveness"""
|
2016-05-16 15:35:24 +00:00
|
|
|
return self.socket._closed
|
2014-09-30 22:33:52 +00:00
|
|
|
|
2014-10-09 05:37:52 +00:00
|
|
|
|
|
|
|
# Open/close
|
|
|
|
|
2016-04-18 17:58:10 +00:00
|
|
|
def open(self):
|
|
|
|
if not self.closed:
|
2015-05-21 08:13:16 +00:00
|
|
|
return True
|
|
|
|
|
2014-08-30 17:15:14 +00:00
|
|
|
try:
|
2016-05-16 15:35:24 +00:00
|
|
|
self.socket.connect(self.connect_to)
|
|
|
|
self.logger.info("Connected to %s", self.connect_to)
|
2016-04-18 17:58:10 +00:00
|
|
|
except:
|
2016-05-16 15:35:24 +00:00
|
|
|
self.socket.close()
|
|
|
|
self.logger.exception("Unable to connect to %s",
|
|
|
|
self.connect_to)
|
2014-08-30 17:15:14 +00:00
|
|
|
return False
|
|
|
|
|
2015-04-26 06:02:37 +00:00
|
|
|
# Wrap the socket for SSL
|
|
|
|
if self.ssl:
|
|
|
|
import ssl
|
|
|
|
ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
|
|
|
|
self.socket = ctx.wrap_socket(self.socket)
|
|
|
|
|
2016-04-18 17:58:10 +00:00
|
|
|
return super().open()
|
2014-08-30 17:15:14 +00:00
|
|
|
|
2014-10-09 05:37:52 +00:00
|
|
|
|
2016-04-18 17:58:10 +00:00
|
|
|
def close(self):
|
2015-02-21 12:51:40 +00:00
|
|
|
import socket
|
|
|
|
|
2016-05-16 15:35:24 +00:00
|
|
|
# Flush the sending queue before close
|
2015-05-11 05:41:04 +00:00
|
|
|
from nemubot.server import _lock
|
|
|
|
_lock.release()
|
2014-08-31 08:51:44 +00:00
|
|
|
self._sending_queue.join()
|
2015-05-11 05:41:04 +00:00
|
|
|
_lock.acquire()
|
2016-05-16 15:35:24 +00:00
|
|
|
|
2016-04-18 17:58:10 +00:00
|
|
|
if not self.closed:
|
2014-09-08 00:30:18 +00:00
|
|
|
try:
|
|
|
|
self.socket.shutdown(socket.SHUT_RDWR)
|
|
|
|
except socket.error:
|
|
|
|
pass
|
2015-05-11 05:41:04 +00:00
|
|
|
|
2016-05-16 15:35:24 +00:00
|
|
|
self.socket.close()
|
2015-05-11 05:41:04 +00:00
|
|
|
|
2016-04-18 17:58:10 +00:00
|
|
|
return super().close()
|
2014-08-30 17:15:14 +00:00
|
|
|
|
2014-10-09 05:37:52 +00:00
|
|
|
|
|
|
|
# Write
|
|
|
|
|
2014-08-30 17:15:14 +00:00
|
|
|
def _write(self, cnt):
|
2016-04-18 17:58:10 +00:00
|
|
|
if self.closed:
|
2014-11-09 13:11:54 +00:00
|
|
|
return
|
2014-10-09 05:37:52 +00:00
|
|
|
|
2016-04-18 17:58:10 +00:00
|
|
|
self.socket.sendall(cnt)
|
2014-08-30 17:15:14 +00:00
|
|
|
|
2014-10-09 05:37:52 +00:00
|
|
|
|
2014-08-30 17:15:14 +00:00
|
|
|
def format(self, txt):
|
2014-09-13 21:49:00 +00:00
|
|
|
if isinstance(txt, bytes):
|
|
|
|
return txt + b'\r\n'
|
|
|
|
else:
|
|
|
|
return txt.encode() + b'\r\n'
|
2014-08-30 17:15:14 +00:00
|
|
|
|
2014-10-09 05:37:52 +00:00
|
|
|
|
|
|
|
# Read
|
|
|
|
|
2014-08-30 17:15:14 +00:00
|
|
|
def read(self):
|
2016-04-18 17:58:10 +00:00
|
|
|
if self.closed:
|
2015-05-21 08:13:16 +00:00
|
|
|
return []
|
2014-10-09 05:37:52 +00:00
|
|
|
|
2014-08-30 17:15:14 +00:00
|
|
|
raw = self.socket.recv(1024)
|
|
|
|
temp = (self.readbuffer + raw).split(b'\r\n')
|
|
|
|
self.readbuffer = temp.pop()
|
|
|
|
|
|
|
|
for line in temp:
|
|
|
|
yield line
|
2015-05-19 10:32:23 +00:00
|
|
|
|
|
|
|
|
2015-07-18 12:01:56 +00:00
|
|
|
def parse(self, line):
|
|
|
|
import shlex
|
|
|
|
|
|
|
|
line = line.strip().decode()
|
|
|
|
try:
|
|
|
|
args = shlex.split(line)
|
|
|
|
except ValueError:
|
|
|
|
args = line.split(' ')
|
|
|
|
|
2016-05-16 15:35:24 +00:00
|
|
|
yield message.Command(cmd=args[0], args=args[1:], server=self.name, to=["you"], frm="you")
|
2015-07-18 12:01:56 +00:00
|
|
|
|
|
|
|
|
2015-05-19 10:32:23 +00:00
|
|
|
class SocketListener(AbstractServer):
|
|
|
|
|
2016-05-16 15:35:24 +00:00
|
|
|
def __init__(self, new_server_cb, name, sock_location=None, host=None, port=None, ssl=None):
|
|
|
|
super().__init__(name=name)
|
2015-05-19 10:32:23 +00:00
|
|
|
self.new_server_cb = new_server_cb
|
|
|
|
self.sock_location = sock_location
|
|
|
|
self.host = host
|
|
|
|
self.port = port
|
|
|
|
self.ssl = ssl
|
|
|
|
self.nb_son = 0
|
|
|
|
|
|
|
|
|
|
|
|
def fileno(self):
|
|
|
|
return self.socket.fileno() if self.socket else None
|
|
|
|
|
|
|
|
|
|
|
|
@property
|
2016-04-18 17:58:10 +00:00
|
|
|
def closed(self):
|
2015-05-19 10:32:23 +00:00
|
|
|
"""Indicator of the connection aliveness"""
|
2016-04-18 17:58:10 +00:00
|
|
|
return self.socket is None
|
2015-05-19 10:32:23 +00:00
|
|
|
|
|
|
|
|
2016-04-18 17:58:10 +00:00
|
|
|
def open(self):
|
2015-05-19 10:32:23 +00:00
|
|
|
import os
|
|
|
|
import socket
|
|
|
|
|
|
|
|
if self.sock_location is not None:
|
2016-04-18 17:58:10 +00:00
|
|
|
self.socket = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
|
2015-05-19 10:32:23 +00:00
|
|
|
try:
|
|
|
|
os.remove(self.sock_location)
|
|
|
|
except FileNotFoundError:
|
|
|
|
pass
|
|
|
|
self.socket.bind(self.sock_location)
|
|
|
|
elif self.host is not None and self.port is not None:
|
2016-04-18 17:58:10 +00:00
|
|
|
self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
|
2015-05-19 10:32:23 +00:00
|
|
|
self.socket.bind((self.host, self.port))
|
|
|
|
self.socket.listen(5)
|
|
|
|
|
2016-04-18 17:58:10 +00:00
|
|
|
return super().open()
|
2015-05-19 10:32:23 +00:00
|
|
|
|
|
|
|
|
2016-04-18 17:58:10 +00:00
|
|
|
def close(self):
|
2015-05-19 10:32:23 +00:00
|
|
|
import os
|
|
|
|
import socket
|
|
|
|
|
|
|
|
try:
|
|
|
|
self.socket.shutdown(socket.SHUT_RDWR)
|
|
|
|
self.socket.close()
|
|
|
|
if self.sock_location is not None:
|
|
|
|
os.remove(self.sock_location)
|
|
|
|
except socket.error:
|
|
|
|
pass
|
|
|
|
|
2016-04-18 17:58:10 +00:00
|
|
|
return super().close()
|
|
|
|
|
|
|
|
|
2015-05-19 10:32:23 +00:00
|
|
|
# Read
|
|
|
|
|
|
|
|
def read(self):
|
2016-04-18 17:58:10 +00:00
|
|
|
if self.closed:
|
2015-05-19 10:32:23 +00:00
|
|
|
return []
|
|
|
|
|
|
|
|
conn, addr = self.socket.accept()
|
|
|
|
self.nb_son += 1
|
2016-05-16 15:35:24 +00:00
|
|
|
ss = SocketServer(name=self.name + "#" + str(self.nb_son), socket=conn)
|
2015-05-19 10:32:23 +00:00
|
|
|
self.new_server_cb(ss)
|
|
|
|
|
|
|
|
return []
|