client.py 8.78 KB
Newer Older
1
2
3
4
5
#!/usr/bin/python
# -*- coding: utf-8 -*-
import socket
import urllib.parse
import configparser
6
import logging
7

8
from multiprocessing import Lock
9

10
from libraries.exceptions.auraexceptions import LQConnectionError
11
12


13
14
""" LiquidSoapClient Class 
    Repräsentiert alle Kommandos, die Soundserver und Recorder kennen
15
16
17
"""


18
class LiquidSoapClient:
19
20
    mutex = None
    logger = None
21
    debug = False
22
    socket_path = ""
23

24
    def __init__(self, config, socket_filename):
25
26
        """
        Constructor
27
28
        @type    socket_path: string
        @param   socket_path: Der Pfad zum Socket des Liquidsoap-Scripts
29
        """
30
        self.logger = logging.getLogger("AuraEngine")
31
32
        self.socket_path = config.get('socketdir') + '/' + socket_filename

33
        self.logger.debug("LiquidSoapClient using socketpath: " + self.socket_path)
34

35
        # init
36
        self.mutex = Lock()
37
38
39
        self.connected = False
        self.can_connect = True
        self.message = ''
40
41
        self.socket = None
        self.metareader = configparser.ConfigParser()
42
43
44
45
46
47
48

    # ------------------------------------------------------------------------------------------ #
    def connect(self):
        """
        Verbindung herstellen
        """
        try:
49
50
51
            self.socket = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
            self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
            self.socket.connect(self.socket_path)
52
        except socket.error as e:
Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
53
54
            msg = "Cannot connect to socketpath " + self.socket_path + ". Reason: "+str(e)
            self.logger.critical(msg)
55
            self.can_connect = False
56
            self.connected = False
Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
57
#            raise e
58
59
60
61
62
63
        else:
            self.can_connect = True
            self.connected = True
            return True

    # ------------------------------------------------------------------------------------------ #
64
    def is_connected(self):
65
66
67
68
69
70
71
72
73
74
        return self.connected

    # ------------------------------------------------------------------------------------------ #
    def write(self, data):
        """
        Auf den Socket schreiben
        @type    data: string
        @param   data: Der String der gesendet wird
        """
        if self.connected:
75
            self.socket.sendall(data.decode("UTF-8"))
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

    # ------------------------------------------------------------------------------------------ #
    def read_all(self, timeout=2):
        """
        Vom Socket lesen, bis dieser "END" sendet
        @type    timeout: int
        @param   timeout: Ein optionales Timeout
        @rtype:  string
        @return: Die Antwort des Liquidsoap-Servers
        """
        # make socket non blocking
        # self.client.setblocking(0)

        data = '';

        try:
92
            # set timeout
93
            self.socket.settimeout(timeout)
94
95
96
97
98

            # acquire the lock
            self.mutex.acquire()

            while True:
99
                data += self.socket.recv(1).decode("utf-8")
100
101
102
103
104
105
106
107
108

                # receive as long as we are not at the END or recv a Bye! from liquidsoap
                if data.find("END\r\n") != -1 or data.find("Bye!\r\n") != -1:
                    data.replace("END\r\n", "")
                    break

            # release the lock
            self.mutex.release()

109
        except Exception as e:
110
            self.logger.error(str(e))
111
            self.mutex.release()
112
113
114
115
116
117

        return data

    # ------------------------------------------------------------------------------------------ #
    def read(self):
        """
118
        read from socket and store return value in self.message
119
        @rtype:  string
120
        @return: The answer of liquidsoap server
121
122
        """
        if self.connected:
123
            ret = self.read_all().splitlines()
124
125

            try:
126
                last = ret.pop() # pop out end
127

128
129
130
131
                if len(ret) > 1:
                    self.message = str.join(" - ", ret)
                elif len(ret) == 1:
                    self.message = ret[0]
132

133
134
                if last == "Bye!":
                    self.message = last
135

136
            except Exception as e:
137
                self.logger.error(str(e))
138
139
140
141
142
143
144
145
146
147

            return self.message

    # ------------------------------------------------------------------------------------------ #
    def close(self):
        """
        Quit senden und Verbindung schließen
        """
        if self.connected:
            message = "quit\r"
148
149
            self.socket.sendall(message.decode("UTF-8"))
            self.socket.close()
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
            self.connected = False

    # ------------------------------------------------------------------------------------------ #
    def command(self, namespace, command, param=""):
        """
        Kommando an Liquidosap senden
        @type    command:   string
        @param   command:   Kommando
        @type    namespace: string
        @param   namespace: Namespace/Kanal der angesprochen wird
        @type    param:     mixed
        @param   param:     ein optionaler Parameter
        @rtype:  string
        @return: Die Antwort des Liquidsoap-Servers
        """

        param = (param.strip() if param.strip() == "" else " " + urllib.parse.unquote(param.strip()))
        if self.connected:
            # print namespace + '.' + command + param + "\n"
            if namespace is "":
170
                message = str(command) + str(param) + str("\n")
171
            else:
172
                message = str(namespace) + str(".") + str(command) + str(param) + str("\n")
173
174

            try:
175
                self.logger.info("LiquidSoapClient sending to LiquidSoap Server: " + message[0:len(message)-1])
176
177

                # send all the stuff over the socket to liquidsoap server
178
                self.socket.sendall(message.encode())
179

180
                self.logger.debug("LiquidSoapClient waiting for reply from LiquidSoap Server")
181
182

                # wait for reply
183
                self.read()
184

185
186
187
                self.logger.info("LiquidSoapClient got reply: " + self.message)
            except Exception as e:
                self.logger.error("Unexpected error: " + str(e))
188
189
190
191
                raise

            return self.message
        else:
192
            raise LQConnectionError("LiquidSoapClient not connected to LiquidSoap Server")
193
194
195
196
197
198
199
200
201
202
203
204
205

    # ------------------------------------------------------------------------------------------ #
    def simplecommand(self, command):
        """
        Parameterloses Kommando ohne Namespace senden
        @type    command:   string
        @param   command:   Kommando
        @rtype:  string
        @return: Die Antwort des Liquidsoap-Servers
        """

        if self.connected:
            message = str(command) + '\n'
206
            self.socket.sendall(message.decode("UTF-8"))
207
208
209
210
211
            self.read()
            # self.client.close()
            return self.message

    # ------------------------------------------------------------------------------------------ #
212
    def get_metadata(self, rid):
213
214
215
216
217
218
219
220
221
222
        """
        Parameterloses Kommando ohne Namespace senden
        @type    rid:   string/int
        @param   rid:   Die ID eines Requests
        @rtype:  dict
        @return: Die Metadaten als dict
        """
        meta = self.command('metadata ' + str(rid), 'request')

        meta = '[root]\n' + meta
223
224
225
226
227
        try:
            self.metareader.read_string(meta)
        except configparser.ParsingError as e:
            self.logger.error("ParsingError. Reason: " + str(e))
            return False
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
        return self.metareader

    # ------------------------------------------------------------------------------------------ #
    def help(self):
        """
        get liquidsoap server help
        @rtype:  string
        @return: the response of the liquidsoap server
        """
        if self.connected:
            self.command('help', '')
            return self.message

    # ------------------------------------------------------------------------------------------ #
    def version(self):
        """
        Liquidsoap get version
        @rtype:  string
        @return: the response of the liquidsoap server
        """
        if self.connected:
            message = 'version'
            self.command(message, '')
            return self.message

    # ------------------------------------------------------------------------------------------ #
    def uptime(self):
        """
        Liquidsoap get uptime
        @rtype:  string
        @return: Die Antwort des Liquidsoap-Servers
        """

        if self.connected:
            self.command('uptime', '')
            return self.message

    # ------------------------------------------------------------------------------------------ #
    def byebye(self):
        """
        Liquidsoap say byebye
        @rtype:  string
        @return: Die Antwort des Liquidsoap-Servers
        """

        if self.connected:
274
            self.command("", "quit")
275
            return self.message