Source

pida-hacks / pida / core / service.py

"""
    pida.core.service
    ~~~~~~~~~~~~~~~~~

    Base classes for services/plugins.

    :copyright: 2005-2008 by The PIDA Project
    :license: GPL2 or later
"""
import logbook

# PIDA Imports
from pida.core.events import EventsConfig
from pida.core.options import OptionsConfig
from pida.core.actions import ActionsConfig
from pida.core.commands import CommandsConfig
from pida.core.features import FeaturesConfig
from pida.utils.descriptors import cached_property

# locale
from pida.core.locale import Locale
locale = Locale('pida')
_ = locale.gettext


class Service(object):
    """Base Service Class"""

    label = None

    options_config = OptionsConfig
    events_config = EventsConfig
    commands_config = CommandsConfig
    features_config = FeaturesConfig
    actions_config = ActionsConfig
    dbus_config = None

    def __init__(self, boss):
        self.boss = boss
        self.log.debug('Loading Service')

    def create_all(self):
        """
        Called to create all the services by the
        {servicemanager.ServiceManager}
        """

        self.commands = self.commands_config(self)
        self.events = self.events_config(self)
        self.options = self.options_config(self)
        self.features = self.features_config(self)
        self.actions = self.actions_config(self)

        if self.dbus_config:
            self.dbus = self.dbus_config(self)
        else:
            self.dbus = None

    def subscribe_all(self):
        self.events.subscribe_all_foreign()
        self.features.subscribe_all_foreign()

    def __repr__(self):
        cls = self.__class__
        return '<{kind}: {name}>'.format(
            kind=cls.__module__.split('.')[1].capitalize().rstrip('s'),
            name=cls.__name__,
        )

    @classmethod
    def get_name(cls):
        return cls.__module__.split('.')[-1]

    @staticmethod
    def sort_key(service):
        """helper for sorting, use as key argument for `list.sort`/`sorted`"""
        return service.get_name()

    @classmethod
    def get_label(cls):
        return cls.label or cls.get_name().capitalize()

    def pre_start(self):
        """Override to pre start up"""

    def start(self):
        """Override for main phase of startup"""

    def pre_stop(self):
        """pre_stop allows a service to stop the shutdown process by returning
        False. In this phase all user interaction should take place"""
        return True

    def destroy(self):
        """
        Stop and unregisters this service.
        """
        try:
            self.stop()
        except Exception, e:
            self.log.exception(e)
            # big fat warning to the user
            self.log.error(
              _('!!!! Warning !!!!\n'
                'Exception while unloading. Pida is in an unpredictable state.'
                'Consider a restart'
                ))
        finally:
            self.stop_components()

    def stop(self):
        """Override to stop service"""

    def stop_components(self):
        # Will remove everything
        self.events.unsubscribe_foreign()
        self.features.unsubscribe_foreign()
        self.actions.remove_actions()
        del self.events
        del self.features
        del self.actions
        del self.commands
        del self.options

    ##########
    # Options API
    def get_option(self, name):
        return self.options.get_option(name)

    def opt(self, name):
        return self.options.get_value(name)

    def set_opt(self, name, value):
        return self.options.set_value(name, value)

    def cmd(self, commandname, **kw):
        """delegates a command to the commandsconfig"""
        return self.commands(commandname, **kw)

    def emit(self, name, **kw):
        """delegates a emited event to the eventsconfig"""
        self.events.emit(name, **kw)

    ##########
    # Actions

    def get_action_group(self):
        return self.actions.get_action_group()

    def get_action(self, name):
        return self.actions.get_action(name)

    def get_keyboard_options(self):
        return self.actions.get_keyboard_options()

    # Logging

    @cached_property
    def log(self):
        if self.__module__[:14] == 'pida.services.':
            return logbook.Logger('pida.svc.' + self.get_name())
        else:
            return logbook.Logger('pida.plugin.' + self.get_name())

    # window proxy
    @property
    def window(self):
        return self.boss.window

    def save_dlg(self, *args, **kw):
        return self.window.save_dlg(*args, **kw)

    def open_dlg(self, *args, **kw):
        return self.window.open_dlg(*args, **kw)

    def info_dlg(self, *args, **kw):
        return self.window.info_dlg(*args, **kw)

    def error_dlg(self, *args, **kw):
        return self.window.error_dlg(*args, **kw)

    def yesno_dlg(self, *args, **kw):
        return self.window.yesno_dlg(*args, **kw)

    def error_list_dlg(self, msg, errs):
        return self.window.error_list_dlg('%s\n\n* %s' % (
            msg,
            '\n\n* '.join(errs)))

    def notify_user(self, data, **kwargs):
        """Shortcut to make it easy to notify the user"""
        if not 'title' in kwargs:
            kwargs['title'] = self.label
        if self.boss:
            try:
                notify = self.boss.get_service('notify')
            except KeyError:
                return
            notify.notify(data, **kwargs)
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.