client.py 9.4 KB
Newer Older
1
2
3
4
5
6
7
8
#!/usr/bin/python
# -*- coding: utf-8 -*-
import os
import sys
import time
import socket
import urllib.parse
import configparser
9
#import queue
10
11

from io import StringIO
12
from multiprocessing import Lock
13

14
from libraries.exceptions.auraexceptions import LQConnectionError
15
16


17
18
""" LiquidSoapClient Class 
    Repräsentiert alle Kommandos, die Soundserver und Recorder kennen
19
20
21
"""


22
class LiquidSoapClient:
23
    debug = False
24
    socket_path = ""
25
    mutex = None
26

27
    def __init__(self, config, socket_filename):
28
29
        """
        Constructor
30
31
        @type    socket_path: string
        @param   socket_path: Der Pfad zum Socket des Liquidsoap-Scripts
32
33
        """

34
35
36
        self.socket_path = config.get('socketdir') + '/' + socket_filename
        self.debug = config.get("debug")

37
        if self.debug > 2:
38
            print("socketpath: " + self.socket_path)
39

40
        # init
41
        self.mutex = Lock()
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
        self.connected = False
        self.can_connect = True
        self.message = ''
        self.client = None
        if sys.version_info <= (3, 2):
            self.metareader = configparser.ConfigParser({'strict': False, 'interpolation': None})
        else:
            self.metareader = configparser.ConfigParser()

    # ------------------------------------------------------------------------------------------ #
    def connect(self):
        """
        Verbindung herstellen
        """
        try:
            self.client = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
            self.client.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
59
            self.client.connect(self.socket_path)
60
61
        except socket.error as e:
            self.connected = False
62
            print(self.socket_path)
63
            raise LQConnectionError(e, self.socket_path)
64
65
66
67
68
69
70
            return False
        else:
            self.can_connect = True
            self.connected = True
            return True

    # ------------------------------------------------------------------------------------------ #
71
    def is_connected(self):
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
        return self.connected

    # ------------------------------------------------------------------------------------------ #
    def write(self, data):
        """
        Auf den Socket schreiben
        @type    data: string
        @param   data: Der String der gesendet wird
        """
        if self.connected:
            self.client.sendall(data.decode("UTF-8"))

    # ------------------------------------------------------------------------------------------ #
    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:
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
            # set timeout
            self.client.settimeout(timeout)

            # acquire the lock
            self.mutex.acquire()

            while True:
                data += self.client.recv(1).decode("utf-8")

                # 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()

116
117
        except Exception as e:
            print(e)
118
            self.mutex.release()
119
120
121
122
123
124
125
            pass

        return data

    # ------------------------------------------------------------------------------------------ #
    def read(self):
        """
126
        read from socket and store return value in self.message
127
        @rtype:  string
128
        @return: The answer of liquidsoap server
129
130
        """
        if self.connected:
131
            ret = self.read_all().splitlines()
132
133

            try:
134
135
                last = ret.pop()

136
137
138
139
140
141
142
143
                if len(ret) > 0:
                    first = ret[0]
                    if first == "END":
                        ret.remove(first)
                    if last == "Bye!" or last != "END":
                        ret.append(last)

                    self.message = str.join("\r\n", ret)
144

145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
            except Exception as e:
                print(e)

            return self.message

    # ------------------------------------------------------------------------------------------ #
    def close(self):
        """
        Quit senden und Verbindung schließen
        """
        if self.connected:
            message = "quit\r"
            self.client.sendall(message.decode("UTF-8"))
            self.client.close()
            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 "":
                message = str(command) + str(param) + str('\n')
            else:
                message = str(namespace) + str('.') + str(command) + str(param) + str('\n')

            try:
184
185
                if self.debug > 2:
                    print("LiquidSoapClient sending to LiquidSoap Server: "+message[0:len(message)-1])
186
187

                # send all the stuff over the socket to liquidsoap server
188
                self.client.sendall(message.encode())
189

190
191
                if self.debug > 2:
                    print("LiquidSoapClient waiting for reply from LiquidSoap Server")
192
193

                # wait for reply
194
                self.read()
195

196
197
                if self.debug > 2:
                    print("LiquidSoapClient got reply")
198
199
200
201
202
203
204
                # self.client.close()
            except:
                print("Unexpected error:", sys.exc_info()[0], sys.exc_info()[1], sys.exc_info()[2])
                raise

            return self.message
        else:
205
206
            if self.debug:
                print("LiquidSoapClient not connected to LiquidSoap Server")
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
            return False

    # ------------------------------------------------------------------------------------------ #
    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'
            self.client.sendall(message.decode("UTF-8"))
            self.read()
            # self.client.close()
            return self.message

    # ------------------------------------------------------------------------------------------ #
    def getMetadata(self, rid):
        """
        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
        if sys.version_info <= (3, 2):
            meta = StringIO.StringIO(meta)
            try:
                self.metareader.readfp(meta)
            except configparser.ParsingError:
                return False
        else:
            try:
                self.metareader.read_string(meta)
            except configparser.ParsingError:
                return False
        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', '')
            print('read (' + str(len(self.message)) + ' bytes): ' + self.message)
            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', '')
            print('read (' + str(len(self.message)) + ' bytes): ' + self.message)
            return self.message

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

        if self.connected:
297
            self.command("", "quit")
298
            return self.message