source: SHX/trunk/src/SeismicHandler/core/modules/Command.py @ 152

# -*- coding: utf-8 -*-
#
# Copyright (C) 2008-2010 Marcus Walther (walther@szgrf.bgr.de)
#
# This file is part of Seismic Handler eXtended (SHX)
# Full details can be found at project website http://www.seismic-handler.org/
#
# SHX is free software; you can redistribute it and/or modify
# it under the terms of the GNU LESSER GENERAL PUBLIC LICENSE as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# SHX 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 Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with SHX (see license.txt); if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA

"""Command base class

    - derived classes (e.g. commands) must have "Run" method
    - optional is "Build" method which constructs a command line suitable for
      old command line interface
    - if a cmdstr attribute is found, the cmdstr will automatically promoted
      to shlib interface
"""

from SeismicHandler.core import history
from SeismicHandler.core.log import logging
from SeismicHandler.core.shlib import shlib
from  SeismicHandler.core.modules.Events import MessageService, Message

class Command(object):
    logger = None
    _stop = False

    def __init__(self, args, kwargs):
        """run command
           - add history entry
           - set initial returnCode"""

        history(self.__class__.__name__, args, kwargs)

        if not self.logger:
            self.logger = logging.getLogger("command.run")

        self.logger.debug(self.__class__.__name__)

        # switch to another shlib instance if keyword given
        try:
            self.id = kwargs["id"]
        except KeyError:
            pass

        if hasattr(self, "id"):
            shlib().switch(self.id)

        self.returnCode = None

        if self._stop:
            self._stop = False
            return

        # we assume that a command is either run in python context
        # or in "old" c lib context - no parallel execution
        # of course it's still possible to run the c method from python

        # running in python takes over precedence
        if hasattr(self, "run"):
            self.run()
        else:
            self.promote()

        MessageService.trigger(Message(MessageService.COMMANDRUN))

    def Cancel(self):
        """stop command execution"""
        self.logger.warning("command execution stopped")
        self._stop = True

    def promote(self):
        """run command on seismic handler c routine

           - command line also processed by c lib"""

        # run method build (if any) in order to construct command string suitable for c lib processing
        if hasattr(self, "build"):
            self.build()

        slib = shlib()
        slib.call(self.cmdstr)

    def __repr__(self):
        if not self.returnCode:
            return ""
        else:
            return str(self.returnCode)