CouchPotatoServer/couchpotato/core/plugins/base.py

from couchpotato import addView
from couchpotato.core.event import fireEvent, addEvent
from couchpotato.core.helpers.variable import getExt
from couchpotato.core.logger import CPLog
from couchpotato.environment import Env
from flask.helpers import send_from_directory
import glob
import os.path
import re

log = CPLog(__name__)


class Plugin(object):

    enabled_option = 'enabled'
    auto_register_static = True

    needs_shutdown = False
    running = 0

    def registerPlugin(self):
        addEvent('app.shutdown', self.doShutdown)
        addEvent('plugin.running', self.isRunning)

    def conf(self, attr, default = None):
        return Env.setting(attr, self.getName().lower(), default = default)

    def getName(self):
        return self.__class__.__name__

    def registerStatic(self, plugin_file, add_to_head = True):

        # Register plugin path
        self.plugin_path = os.path.dirname(plugin_file)

        # Get plugin_name from PluginName
        s1 = re.sub('(.)([A-Z][a-z]+)', r'\1_\2', self.__class__.__name__)
        class_name = re.sub('([a-z0-9])([A-Z])', r'\1_\2', s1).lower()

        path = 'static/' + class_name + '/'
        addView(path + '<path:file>', self.showStatic, static = True)

        if add_to_head:
            for f in glob.glob(os.path.join(self.plugin_path, 'static', '*')):
                fireEvent('register_%s' % ('script' if getExt(f) in 'js' else 'style'), path + os.path.basename(f))

    def showStatic(self, f = ''):
        d = os.path.join(self.plugin_path, 'static')
        return send_from_directory(d, f)

    def createFile(self, path, content):

        self.makeDir(os.path.dirname(path))

        try:
            f = open(path, 'w')
            f.write(content)
            f.close()
        except Exception, e:
            log.error('Unable writing to file "%s": %s' % (path, e))

    def makeDir(self, path):
        try:
            if not os.path.isdir(path):
                os.makedirs(path, Env.getPermission('folder'))
        except Exception, e:
            log.error('Unable to create folder "%s": %s' % (path, e))

    def beforeCall(self):
        self.isRunning(True)

    def afterCall(self):
        self.isRunning(False)

    def doShutdown(self):
        self.shuttingDown(True)

    def shuttingDown(self, value = None):
        if value is None:
            return self.needs_shutdown

        self.needs_shutdown = value

    def isRunning(self, value = None):
        if value is None:
            return self.running

        log.debug('Running %s: %s' % (value, self.getName()))
        self.running += 1 if value else -1

    def isDisabled(self):
        return not self.isEnabled()

    def isEnabled(self):
        return self.conf(self.enabled_option) or self.conf(self.enabled_option) == None