engine-core.py 5.81 KB
Newer Older
1
#!/usr/bin/env python3.7
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

#
# Aura Engine
#
# Copyright (C) 2017-2020    
#           David Trattnig <david.trattnig@subsquare.at>
#           Gottfried Gaisbauer <gottfried.gaisbauer@servus.at>

# 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/>.




import os
import sys
28
import meta
29
30
31
import signal
import logging
import unittest
32
import subprocess
33

34
35
from flask               import Flask
from flask_sqlalchemy    import SQLAlchemy
36
37
38

from modules.base.logger import AuraLogger
from modules.base.config import AuraConfig
39
from modules.base.utils  import SimpleUtil
40
41
42
43
44
45
46
47
48
49
50
51
52


config = AuraConfig()
def configure_flask():
    app.config["SQLALCHEMY_DATABASE_URI"] = config.get_database_uri()
    app.config['BABEL_DEFAULT_LOCALE'] = 'de'
    app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False

# FIXME Instatiate SQLAlchemy without the need for Flask
app = Flask(__name__)
configure_flask()
DB = SQLAlchemy(app)

53
54

class AuraEngine:
55
    """
56
57
58
59
60
    AuraEngine does the following:

    1. Initialize the soundsystem and scheduler
    2. Initialize Redis
    3. Start Liquidsoap in a separate thread which connects to the engine
61
62
63
64
65
66
67
68

    """
    logger = None
    config = None
    server = None
    messenger = None
    controller = None
    scheduler = None
69
    lqs = None
70
71
    lqs_startup = None

72
73
74
75


    def __init__(self):
        """
76
        Initializes Engine Core.
77
78
79
80
        """
        self.config = config


81
82

    def startup(self, lqs_startup):
83
        """
84
        Starts Engine Core.
85
        """
86
87
88
        AuraLogger(self.config)
        self.logger = logging.getLogger("AuraEngine")

89
90
91
92
        from modules.scheduling.scheduler import AuraScheduler
        from modules.core.engine import SoundSystem
        from modules.communication.redis.adapter import ServerRedisAdapter

93
94
95
        # If Liquidsoap should be started automatically
        self.lqs_startup = lqs_startup

96
97
        # Check if the database has to be re-created
        if self.config.get("recreate_db") is not None:
98
            AuraScheduler(self.config, None, None)
99
100
101

        # Create scheduler and Liquidsoap communicator
        self.soundsystem = SoundSystem(self.config)
102
        self.scheduler = AuraScheduler(self.config, self.soundsystem, self.on_initialized)
103
104
105
106
107
108
109
110
111
112
113

        # Create the Redis adapter
        self.messenger = ServerRedisAdapter(self.config)
        self.messenger.scheduler = self.scheduler
        self.messenger.soundsystem = self.soundsystem

        # And finally wait for redis message / start listener thread
        self.messenger.start()



114
115
116
117
118
    def on_initialized(self):
        """
        Called when the engine is initialized, before the Liquidsoap connection is established."
        """
        self.logger.info(SimpleUtil.green("Engine Core initialized - Waiting for Liquidsoap connection ..."))
119
120
121
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
157
158
159
160
161
162
        if self.lqs_startup:
            self.start_lqs(False, False)
        else:
            self.logger.info(SimpleUtil.yellow("Please note, Liquidsoap needs to be started manually."))



    def start_lqs(self, debug_output, verbose_output):
        """
        Starts Liquidsoap.
        """
        lqs_path = self.config.get("liquidsoap_path")
        lqs_cwd = os.getcwd() + "/" + self.config.get("liquidsoap_working_dir")
        lqs_output = ""
        lqs_output = self.get_debug_flags(debug_output, verbose_output)

        self.lqs = subprocess.Popen([lqs_path, lqs_output, "engine.liq"], \
            cwd=lqs_cwd, \
            stdout=subprocess.PIPE, \
            shell=False)



    def get_lqs_cmd(self, debug_output, verbose_output):
        """
        Returns a shell command string to start Liquidsoap
        """
        lqs_path = self.config.get("liquidsoap_path")
        lqs_cwd = os.getcwd() + "/" + self.config.get("liquidsoap_working_dir")
        lqs_output = self.get_debug_flags(debug_output, verbose_output)
        return "(cd %s && %s %s ./engine.liq)" % (lqs_cwd, lqs_path, lqs_output)



    def get_debug_flags(self, debug_output, verbose_output):
        """
        Build Liquidssoap debug parameters.
        """
        output = ""
        if debug_output:
            output += "--debug " 
        if verbose_output:
            output += "--verbose "
        return output
163
164
165
166
167



    def exit_gracefully(self, signum, frame):
        """
168
        Shutdown of the engine. Also terminates the Liquidsoap thread.
169
        """
170
171
172
173
174
175
176
        if self.lqs:
            self.lqs.terminate()
            self.logger.info("Terminated Liquidsoap")

        if self.messenger:
            self.messenger.terminate()
        
177
        self.logger.info("Gracefully terminated Aura Engine!" + str(self.lqs))
178
        sys.exit(0)        
179
180
181



182
183
184
185
186
#
# START THE ENGINE
#


187
if __name__ == "__main__":        
188

189
    engine = AuraEngine()
190
191
    lqs_startup = True
    lqs_cmd = False
192
193
194

    signal.signal(signal.SIGINT, engine.exit_gracefully)
    signal.signal(signal.SIGTERM, engine.exit_gracefully)
195
196

    if len(sys.argv) >= 2:
197
198
199
200
        if "--without-lqs" in sys.argv:
            lqs_startup = False
        if "--get-lqs-command" in sys.argv:
            lqs_cmd = True
201
        if "--use-test-data" in sys.argv:
202
            engine.config.set("use_test_data", True)
203
        if "--recreate-database" in sys.argv:
204
            engine.config.set("recreate_db", True)
205

206
207
208
209
    if lqs_cmd:
        print(engine.get_lqs_cmd(True, True))
    else:
        engine.startup(lqs_startup)