__init__.py 15.2 KB
Newer Older
echel0n's avatar
echel0n committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# ##############################################################################
#  Author: echel0n <[email protected]>
#  URL: https://sickrage.ca/
#  Git: https://git.sickrage.ca/SiCKRAGE/sickrage.git
#  -
#  This file is part of SiCKRAGE.
#  -
#  SiCKRAGE is free software: you can redistribute it and/or modify
#  it under the terms of the GNU General Public License as published by
#  the Free Software Foundation, either version 3 of the License, or
#  (at your option) any later version.
#  -
#  SiCKRAGE 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 General Public License for more details.
#  -
#  You should have received a copy of the GNU General Public License
#  along with SiCKRAGE.  If not, see <http://www.gnu.org/licenses/>.
# ##############################################################################
echel0n's avatar
echel0n committed
21

echel0n's avatar
echel0n committed
22
__version__ = "10.0.59"
echel0n's avatar
echel0n committed
23
__install_type__ = ""
24

25
import argparse
echel0n's avatar
echel0n committed
26
import atexit
27
import gettext
28
import os
29
import pathlib
30
import re
31
import site
32
import subprocess
33
import sys
34
import threading
echel0n's avatar
echel0n committed
35
import time
36
import traceback
echel0n's avatar
echel0n committed
37
from signal import SIGTERM
echel0n's avatar
echel0n committed
38

39
40
import pkg_resources

41
app = None
echel0n's avatar
echel0n committed
42

43
44
MAIN_DIR = os.path.abspath(os.path.realpath(os.path.expanduser(os.path.dirname(os.path.dirname(__file__)))))
PROG_DIR = os.path.abspath(os.path.realpath(os.path.expanduser(os.path.dirname(__file__))))
45
LOCALE_DIR = os.path.join(PROG_DIR, 'locale')
46
LIBS_DIR = os.path.join(PROG_DIR, 'libs')
echel0n's avatar
echel0n committed
47
CHANGELOG_FILE = os.path.join(MAIN_DIR, 'CHANGELOG.md')
echel0n's avatar
echel0n committed
48
REQS_FILE = os.path.join(MAIN_DIR, 'requirements.txt')
echel0n's avatar
echel0n committed
49
CHECKSUM_FILE = os.path.join(PROG_DIR, 'checksums.md5')
50
AUTO_PROCESS_TV_CFG_FILE = os.path.join(*[PROG_DIR, 'autoProcessTV', 'autoProcessTV.cfg'])
51

52

echel0n's avatar
echel0n committed
53
54
class Daemon(object):
    """
echel0n's avatar
echel0n committed
55
    Usage: subclass the Daemon class
echel0n's avatar
echel0n committed
56
57
    """

echel0n's avatar
echel0n committed
58
    def __init__(self, pidfile, working_dir="/"):
echel0n's avatar
echel0n committed
59
60
61
62
        self.stdin = getattr(os, 'devnull', '/dev/null')
        self.stdout = getattr(os, 'devnull', '/dev/null')
        self.stderr = getattr(os, 'devnull', '/dev/null')
        self.pidfile = pidfile
echel0n's avatar
echel0n committed
63
        self.working_dir = working_dir
64
        self.pid = None
echel0n's avatar
echel0n committed
65
66
67
68
69
70
71
72
73
74
75

    def daemonize(self):
        """
        do the UNIX double-fork magic, see Stevens' "Advanced
        Programming in the UNIX Environment" for details (ISBN 0201563177)
        http://www.erlenstar.demon.co.uk/unix/faq_2.html#SEC16
        """
        try:
            pid = os.fork()
            if pid > 0:
                # exit first parent
76
                os._exit(0)
77
        except OSError as e:
echel0n's avatar
echel0n committed
78
79
80
81
            sys.stderr.write("fork #1 failed: %d (%s)\n" % (e.errno, e.strerror))
            sys.exit(1)

        os.setsid()
82
        os.umask(0)
echel0n's avatar
echel0n committed
83
84
85
86
87
88

        # do second fork
        try:
            pid = os.fork()
            if pid > 0:
                # exit from second parent
89
                os._exit(0)
90
        except OSError as e:
echel0n's avatar
echel0n committed
91
92
93
94
            sys.stderr.write("fork #2 failed: %d (%s)\n" % (e.errno, e.strerror))
            sys.exit(1)

        # redirect standard file descriptors
echel0n's avatar
echel0n committed
95
96
97
        sys.stdin = sys.__stdin__
        sys.stdout = sys.__stdout__
        sys.stderr = sys.__stderr__
echel0n's avatar
echel0n committed
98
99
        sys.stdout.flush()
        sys.stderr.flush()
100
101
        si = open(self.stdin, 'r')
        so = open(self.stdout, 'a+')
102
        se = open(self.stderr, 'a+')
echel0n's avatar
echel0n committed
103
104
105
106
107
108
        os.dup2(si.fileno(), sys.stdin.fileno())
        os.dup2(so.fileno(), sys.stdout.fileno())
        os.dup2(se.fileno(), sys.stderr.fileno())

        # write pidfile
        atexit.register(self.delpid)
109
        self.pid = os.getpid()
110
        open(self.pidfile, 'w+').write("%s\n" % self.pid)
echel0n's avatar
echel0n committed
111
112
113
114
115
116
117
118
119
120
121

    def delpid(self):
        if os.path.exists(self.pidfile):
            os.remove(self.pidfile)

    def start(self):
        """
        Start the daemon
        """
        # Check for a pidfile to see if the daemon already runs
        try:
122
            pf = open(self.pidfile, 'r')
echel0n's avatar
echel0n committed
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
            pid = int(pf.read().strip())
            pf.close()
        except IOError:
            pid = None

        if pid:
            message = "pidfile %s already exist. Daemon already running?\n"
            sys.stderr.write(message % self.pidfile)
            sys.exit(1)

        # Start the daemon
        self.daemonize()

    def stop(self):
        """
        Stop the daemon
        """

        # Get the pid from the pidfile
        try:
143
            pf = open(self.pidfile, 'r')
echel0n's avatar
echel0n committed
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
            pid = int(pf.read().strip())
            pf.close()
        except IOError:
            pid = None

        if not pid:
            message = "pidfile %s does not exist. Daemon not running?\n"
            sys.stderr.write(message % self.pidfile)
            return  # not an error in a restart

        # Try killing the daemon process
        try:
            while 1:
                os.kill(pid, SIGTERM)
                time.sleep(0.1)
159
        except OSError as err:
echel0n's avatar
echel0n committed
160
161
162
163
164
165
166
            err = str(err)
            if err.find("No such process") > 0:
                self.delpid()
            else:
                sys.exit(1)


echel0n's avatar
echel0n committed
167
168
169
170
171
172
173
174
175
176
177
def version():
    # Return the version number
    return __version__


def install_type():
    # Return the install type
    if not __install_type__ and os.path.isdir(os.path.join(MAIN_DIR, '.git')):
        return 'git'
    else:
        return __install_type__ or 'source'
178
179


echel0n's avatar
echel0n committed
180
181
182
183
def changelog():
    # Return contents of CHANGELOG.md
    with open(CHANGELOG_FILE) as f:
        return f.read()
184
185


186
187
def check_requirements():
    if os.path.exists(REQS_FILE):
188
189
190
        with open(REQS_FILE) as f:
            for line in f.readlines():
                try:
191
192
193
194
195
196
197
198
199
200
                    req_name, req_version = line.strip().split('==', 1)
                    if 'python_version' in req_version:
                        m = re.search('(\d+.\d+.\d+).*(\d+.\d+)', req_version)
                        req_version = m.group(1)
                        python_version = m.group(2)
                        python_version_major = int(python_version.split('.')[0])
                        python_version_minor = int(python_version.split('.')[1])
                        if sys.version_info.major == python_version_major and sys.version_info.minor != python_version_minor:
                            continue

201
202
203
204
205
206
207
208
                    if not pkg_resources.get_distribution(req_name).version == req_version:
                        print('Updating requirement {} to {}'.format(req_name, req_version))
                        subprocess.check_call([sys.executable, "-m", "pip", "install", "--no-deps", "--no-cache-dir", line.strip()])
                except pkg_resources.DistributionNotFound:
                    print('Installing requirement {}'.format(line.strip()))
                    subprocess.check_call([sys.executable, "-m", "pip", "install", "--no-deps", "--no-cache-dir", line.strip()])
                except ValueError:
                    continue
209

210

echel0n's avatar
echel0n committed
211
def verify_checksums(remove_unverified=False):
echel0n's avatar
echel0n committed
212
    valid_files = []
echel0n's avatar
echel0n committed
213
    exempt_files = [pathlib.Path(__file__), pathlib.Path(CHECKSUM_FILE), pathlib.Path(AUTO_PROCESS_TV_CFG_FILE)]
echel0n's avatar
echel0n committed
214
215
216
217
218
219

    if not os.path.exists(CHECKSUM_FILE):
        return

    with open(CHECKSUM_FILE, "rb") as fp:
        for line in fp.readlines():
220
221
            file, checksum = line.decode().strip().split(' = ')
            full_filename = pathlib.Path(MAIN_DIR).joinpath(file)
echel0n's avatar
echel0n committed
222
223
224
225
            valid_files.append(full_filename)

    for root, dirs, files in os.walk(PROG_DIR):
        for file in files:
226
            full_filename = pathlib.Path(root).joinpath(file)
227

228
            if full_filename in exempt_files or full_filename.suffix == '.pyc':
229
230
231
                continue

            if full_filename not in valid_files and PROG_DIR in str(full_filename):
echel0n's avatar
echel0n committed
232
                try:
echel0n's avatar
echel0n committed
233
234
                    if remove_unverified:
                        print('Found unverified file {}, removed!'.format(full_filename))
235
                        full_filename.unlink()
echel0n's avatar
echel0n committed
236
                    else:
echel0n's avatar
echel0n committed
237
                        print('Found unverified file {}, you should delete this file manually!'.format(full_filename))
echel0n's avatar
echel0n committed
238
                except OSError:
echel0n's avatar
echel0n committed
239
                    print('Unable to delete unverified filename {} during checksum verification, you should delete this file manually!'.format(full_filename))
echel0n's avatar
echel0n committed
240
241


242
def main():
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
    global app

    # set thread name
    threading.currentThread().setName('MAIN')

    # fix threading time bug
    time.strptime("2012", "%Y")

    # add sickrage libs path to python system path
    if not (LIBS_DIR in sys.path):
        sys.path, remainder = sys.path[:1], sys.path[1:]
        site.addsitedir(LIBS_DIR)
        sys.path.extend(remainder)

    # set system default language
258
    gettext.install('messages', LOCALE_DIR, codeset='UTF-8', names=["ngettext"])
259

echel0n's avatar
echel0n committed
260
261
262
263
    # sickrage startup options
    parser = argparse.ArgumentParser(prog='sickrage')
    parser.add_argument('-v', '--version',
                        action='version',
echel0n's avatar
echel0n committed
264
                        version=version())
echel0n's avatar
echel0n committed
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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
    parser.add_argument('-d', '--daemon',
                        action='store_true',
                        help='Run as a daemon (*NIX ONLY)')
    parser.add_argument('-q', '--quiet',
                        action='store_true',
                        help='Disables logging to CONSOLE')
    parser.add_argument('-p', '--port',
                        default=0,
                        type=int,
                        help='Override default/configured port to listen on')
    parser.add_argument('-H', '--host',
                        default='',
                        help='Override default/configured host to listen on')
    parser.add_argument('--dev',
                        action='store_true',
                        help='Enable developer mode')
    parser.add_argument('--debug',
                        action='store_true',
                        help='Enable debugging')
    parser.add_argument('--datadir',
                        default=os.path.abspath(os.path.join(os.path.expanduser("~"), '.sickrage')),
                        help='Overrides data folder for database, config, cache and logs (specify full path)')
    parser.add_argument('--config',
                        default='config.ini',
                        help='Overrides config filename (specify full path and filename if outside datadir path)')
    parser.add_argument('--pidfile',
                        default='sickrage.pid',
                        help='Creates a PID file (specify full path and filename if outside datadir path)')
    parser.add_argument('--no_clean',
                        action='store_true',
                        help='Suppress cleanup of files not present in checksum.md5')
    parser.add_argument('--nolaunch',
                        action='store_true',
                        help='Suppress launching web browser on startup')
    parser.add_argument('--disable_updates',
                        action='store_true',
                        help='Disable application updates')
    parser.add_argument('--web_root',
                        default='',
                        type=str,
                        help='Overrides URL web root')
    parser.add_argument('--db_type',
                        default='sqlite',
                        help='Database type: sqlite or mysql')
    parser.add_argument('--db_prefix',
                        default='sickrage',
                        help='Database prefix you want prepended to database table names')
    parser.add_argument('--db_host',
                        default='localhost',
                        help='Database hostname (not used for sqlite)')
    parser.add_argument('--db_port',
                        default='3306',
                        help='Database port number (not used for sqlite)')
    parser.add_argument('--db_username',
                        default='sickrage',
                        help='Database username (not used for sqlite)')
    parser.add_argument('--db_password',
                        default='sickrage',
                        help='Database password (not used for sqlite)')

    # Parse startup args
    args = parser.parse_args()

328
329
330
331
    # sickrage requires python 3.6+
    if sys.version_info < (3, 6, 0):
        sys.exit("Sorry, SiCKRAGE requires Python 3.6+")

332
    # check lib requirements
echel0n's avatar
echel0n committed
333
    if install_type() not in ['windows', 'synology', 'docker', 'qnap', 'readynas', 'pip']:
334
        check_requirements()
335

echel0n's avatar
echel0n committed
336
337
    # verify file checksums, remove unverified files
    verify_checksums(remove_unverified=not args.no_clean)
echel0n's avatar
echel0n committed
338

339
    try:
echel0n's avatar
echel0n committed
340
        from sickrage.core import Core
341

342
343
344
        # main app instance
        app = Core()

echel0n's avatar
echel0n committed
345
        app.quiet = args.quiet
346
        app.web_host = args.host
347
        app.web_port = int(args.port)
348
        app.web_root = args.web_root.lstrip('/').rstrip('/')
349
        app.no_launch = args.nolaunch
350
        app.disable_updates = args.disable_updates
351
        app.developer = args.dev
352
353
354
355
356
357
        app.db_type = args.db_type
        app.db_prefix = args.db_prefix
        app.db_host = args.db_host
        app.db_port = args.db_port
        app.db_username = args.db_username
        app.db_password = args.db_password
358
359
360
361
        app.debug = args.debug
        app.data_dir = os.path.abspath(os.path.realpath(os.path.expanduser(args.datadir)))
        app.cache_dir = os.path.abspath(os.path.realpath(os.path.join(app.data_dir, 'cache')))
        app.config_file = args.config
echel0n's avatar
echel0n committed
362
363
        daemonize = (False, args.daemon)[not sys.platform == 'win32']
        pid_file = args.pidfile
364

365
366
        if not os.path.isabs(app.config_file):
            app.config_file = os.path.join(app.data_dir, app.config_file)
367

368
        if not os.path.isabs(pid_file):
echel0n's avatar
echel0n committed
369
            pid_file = os.path.join(app.data_dir, pid_file)
370
371
372
373
374
375
376

        # add sickrage module to python system path
        if not (PROG_DIR in sys.path):
            sys.path, remainder = sys.path[:1], sys.path[1:]
            site.addsitedir(PROG_DIR)
            sys.path.extend(remainder)

377
        # Make sure that we can create the data dir
378
        if not os.access(app.data_dir, os.F_OK):
379
            try:
380
                os.makedirs(app.data_dir, 0o744)
381
            except os.error:
382
                sys.exit("Unable to create data directory '" + app.data_dir + "'")
383
384

        # Make sure we can write to the data dir
385
386
        if not os.access(app.data_dir, os.W_OK):
            sys.exit("Data directory must be writeable '" + app.data_dir + "'")
387

388
        # Make sure that we can create the cache dir
389
        if not os.access(app.cache_dir, os.F_OK):
390
            try:
391
                os.makedirs(app.cache_dir, 0o744)
392
            except os.error:
393
                sys.exit("Unable to create cache directory '" + app.cache_dir + "'")
394
395

        # Make sure we can write to the cache dir
396
397
        if not os.access(app.cache_dir, os.W_OK):
            sys.exit("Cache directory must be writeable '" + app.cache_dir + "'")
398

echel0n's avatar
echel0n committed
399
        # daemonize if requested
echel0n's avatar
echel0n committed
400
        if daemonize:
401
            app.no_launch = True
echel0n's avatar
echel0n committed
402
            app.quiet = True
echel0n's avatar
echel0n committed
403
            app.daemon = Daemon(pid_file, app.data_dir)
404
            app.daemon.daemonize()
405
            app.pid = app.daemon.pid
echel0n's avatar
echel0n committed
406

407
        # start app
408
        app.start()
echel0n's avatar
echel0n committed
409
    except (SystemExit, KeyboardInterrupt):
410
411
        if app:
            app.shutdown()
echel0n's avatar
echel0n committed
412
413
414
415
416
417
418
419
    except Exception as e:
        # attempt to send exception to sentry
        try:
            import sentry_sdk
            sentry_sdk.capture_exception(e)
        except ImportError:
            pass

420
        traceback.print_exc()
421

422

echel0n's avatar
echel0n committed
423
424
if __name__ == '__main__':
    main()