source: trunk/factory/src/backends/__init__.py @ 57

# Officeshots.org - Test your office documents in different applications
# Copyright (C) 2009 Stichting Lone Wolves
# Written by Sander Marechal <s.marechal@jejik.com>
#
# 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.
#
# 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.
#
# 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/>.

"""
The core backend class
"""

class BackendException:
        """
        A base Backend exception class. Backends should derive their own
        exceptions from this.

        When the Factory catches this exception and recoverable is False, then
        the backend will be unloaded.
        """
        def __init__(self, message, recoverable = False):
                self.message = message
                self.recoverable = recoverable
        
        def __str__(self):
                if self.recoverable:
                        return self.message + ' (Recoverable)'
                return self.message + ' (Not recoverable)'

class Backend:
        """
        The base backend class. Backends shoudl derive from this
        """
        def __init__(self, options, config, section):
                self.options = options
                self.config = config
                self.section = section

                self.application = config.get(section, 'application')
                self.major = config.get(section, 'major')
                self.minor = config.get(section, 'minor')
                self.doctype = config.get(section, 'doctype')
                self.formats = [s.strip() for s in config.get(section, 'formats').split(',')]
        
        def initialize(self):
                """
                This is called right after instanciating the backend.
                Returning False will cause the backend not to be loaded
                """
                return True

        def can_process(self, job):
                """
                Return True if this backend is eligable to process this Job, False otherwise
                """
                eligable = (
                        job['application'] == self.application and
                        job['major'] == self.major and
                        job['minor'] == self.minor and
                        job['doctype'] == self.doctype and
                        job['format'] in self.formats
                )
                return eligable

        def process(self, job):
                """
                Process a job. Backends must override this method.
                """
                raise NotImplementedError