engine-core.py 5.96 KB
Newer Older
1
2
3
4
#!/bin/sh
''''which python3.8 >/dev/null 2>&1 && exec python3.8 "$0" "$@"     # '''
''''which python3.7  >/dev/null 2>&1 && exec python3.7  "$0" "$@"   # '''
''''exec echo "Error: Snaaakey Python, where are you?"                # '''
5
6

#
David Trattnig's avatar
David Trattnig committed
7
8
9
# Aura Engine (https://gitlab.servus.at/aura/engine)
#
# Copyright (C) 2017-2020 - The Aura Engine Team.
10
11
12
13
14
#
# 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.
David Trattnig's avatar
David Trattnig committed
15
#
16
17
18
19
# 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.
David Trattnig's avatar
David Trattnig committed
20
#
21
22
23
24
25
26
27
28
# 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
import signal
import logging
29
import subprocess
30

31
32
from flask               import Flask
from flask_sqlalchemy    import SQLAlchemy
33
34
35

from modules.base.logger import AuraLogger
from modules.base.config import AuraConfig
36
from modules.base.utils  import SimpleUtil
37
38
39
40
41
42
43
44
45
46
47
48
49


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)

50
51

class AuraEngine:
52
    """
53
54
55
56
57
    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
58
59
60
61
62
63
64

    """
    logger = None
    config = None
    server = None
    messenger = None
    controller = None
65
    soundsystem = None
66
    scheduler = None
67
    lqs = None
68
69
    lqs_startup = None

70
71
72
73


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


79
80

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

87
88
        from modules.scheduling.scheduler import AuraScheduler
        from modules.core.engine import SoundSystem
David Trattnig's avatar
David Trattnig committed
89
        from modules.cli.redis.adapter import ServerRedisAdapter
90

91
92
93
        # If Liquidsoap should be started automatically
        self.lqs_startup = lqs_startup

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

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

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



112
113
114
115
116
    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 ..."))
117
118
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
        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):
        """
David Trattnig's avatar
David Trattnig committed
152
        Build Liquidsoap debug parameters.
153
154
155
156
157
158
159
        """
        output = ""
        if debug_output:
            output += "--debug " 
        if verbose_output:
            output += "--verbose "
        return output
160
161
162
163
164



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

        if self.messenger:
            self.messenger.terminate()
        
David Trattnig's avatar
David Trattnig committed
174
        self.logger.info("Gracefully terminated Aura Engine! (signum:%s, frame:%s)" % (signum, frame))
175
        sys.exit(0)        
176
177
178



179
180
181
182
183
#
# START THE ENGINE
#


184
if __name__ == "__main__":        
185

186
    engine = AuraEngine()
David Trattnig's avatar
David Trattnig committed
187
    start_lqs = True
188
    lqs_cmd = False
189
190
191

    signal.signal(signal.SIGINT, engine.exit_gracefully)
    signal.signal(signal.SIGTERM, engine.exit_gracefully)
192
193

    if len(sys.argv) >= 2:
194
        if "--without-lqs" in sys.argv:
David Trattnig's avatar
David Trattnig committed
195
            start_lqs = False
196
197
        if "--get-lqs-command" in sys.argv:
            lqs_cmd = True
198
        if "--use-test-data" in sys.argv:
199
            engine.config.set("use_test_data", True)
200
        if "--recreate-database" in sys.argv:
201
            engine.config.set("recreate_db", True)
202

203
204
205
    if lqs_cmd:
        print(engine.get_lqs_cmd(True, True))
    else:
David Trattnig's avatar
David Trattnig committed
206
        engine.startup(start_lqs)