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

from io import StringIO

12
from libraries.exceptions.auraexceptions import LQConnectionError
13
14


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


class LiquidSoapClient():
21
    debug = False
22

23
    def __init__(self, socketPath, debug=True):
24
25
26
27
28
        """
        Constructor
        @type    socketPath: string
        @param   socketPath: Der Pfad zum Socket des Liquidsoap-Scripts
        """
29
        self.debug = debug
30
31
        self.socketpath = socketPath

32
33
34
        if debug:
            print("socketpath: "+socketPath)

35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
        # init
        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)
            self.client.connect(self.socketpath)
        except socket.error as e:
            self.connected = False
56
            raise LQConnectionError(e, self.socketpath)
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
            return False
        else:
            self.can_connect = True
            self.connected = True
            return True

    # ------------------------------------------------------------------------------------------ #
    def isConnected(self):
        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 = '';
90
        self.client.settimeout(3)
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

        # recv something
        # while True:
        try:
            time.sleep(0.1)
            raw = self.client.recv(8192)
            data = raw.decode()
        except Exception as e:
            print(e)
            pass

        return data

    # ------------------------------------------------------------------------------------------ #
    def read(self):
        """
        Vom Socket lesen und anschließend quit senden, um den Server zu veranlassen, die Verbindung schließen
        @rtype:  string
        @return: Die Antwort des Liquidsoap-Servers
        """
        if self.connected:

            ret = self.read_all()
            ret = ret.splitlines()

            try:
117
118
#                print("pop from empty list?")
#                print(ret)
119
                ret.pop()  # pop 'END' out
120
121
#                print(ret)
#                print("yes")
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
                self.message = str.join('\n', ret)
                # self.message = str(b'\n'.join(ret))
            except Exception as e:
                print(e)

            # self.client.sendall('quit\n')
            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()))

157
158
159
        if self.debug:
            print("I am in: LiquidSoapClient.command("+namespace+", "+command+", "+param+")")

160
161
162
163
164
165
166
167
        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:
168
169
170
171
                if self.debug:
                    print("Client sending to LiquidSoap Server: "+message)

                # send all the stuff over the socket to liquidsoap server
172
                self.client.sendall(message.encode())
173
174
175
176
177

                if self.debug:
                    print("Client waiting for reply from LiquidSoap Server")

                # wait for reply
178
                self.read()
179
180
181

                if self.debug:
                    print("got reply")
182
183
184
185
186
187
188
                # self.client.close()
            except:
                print("Unexpected error:", sys.exc_info()[0], sys.exc_info()[1], sys.exc_info()[2])
                raise

            return self.message
        else:
189
190
            if self.debug:
                print("LiquidSoapClient not connected to LiquidSoap Server")
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
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
            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:
            message = 'quit'
            self.command("", message)  # client.sendall(message.encode())
            # self.read()
            # print("read: " + self.message)
            return self.message