##############################################################################
#
# Copyright (c) 2010 Vifib SARL and Contributors. All Rights Reserved.
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsibility of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# guarantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program 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.
#
# 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################

import shlex
import os

from slapos.recipe.librecipe import GenericBaseRecipe

class Recipe(GenericBaseRecipe):
    """Recipe to create a script from given command and options.

    :param str command-line: shell command which launches the intended process
    :param str wrapper-path: absolute path to file's destination

    :param lines wait-for-files: list of files to wait for
    :param str pidfile: path to pidfile ensure exclusivity for the process
    :param bool parameters-extra: whether wrapper parameters are passed onto command
    :param bool reserve-cpu: command will ask for an exclusive CPU core
    """
    def install(self):
        command_line = shlex.split(self.options['command-line'])
        wrapper_path = self.options['wrapper-path']
        wait_files = self.options.get('wait-for-files')
        environment = self.options.get('environment')
        parameters_extra = self.options.get('parameters-extra')
        pidfile = self.options.get('pidfile')
        reserve_cpu = self.options.get('reserve-cpu', False)

        if not wait_files and not environment:
          # Create a simple wrapper as shell script
          return [self.createWrapper(
             name=wrapper_path,
             command=command_line[0],
             parameters=command_line[1:],
             parameters_extra=parameters_extra,
             pidfile=pidfile,
             reserve_cpu=reserve_cpu
          )]

        # More complex needs: create a Python script as wrapper

        if wait_files is not None:
            wait_files = [filename.strip() for filename in wait_files.split()
                          if filename.strip()]
        if environment is not None:
            environment = dict((k.strip(), v.strip()) for k, v in [
              line.split('=') for line in environment.splitlines() if line.strip() ])

        # We create a python script and a wrapper around the python
        # script because the python script might have a too long #! line
        if os.path.exists(os.path.join(self.buildout['buildout']['directory'], "bin")): 
          base_script_path = os.path.join(
            self.buildout['buildout']['directory'], "bin/" + wrapper_path.split("/")[-1])
        else:
          base_script_path = os.path.join(
            self.buildout['buildout']['directory'], wrapper_path.split("/")[-1])
        python_script = self.createPythonScript(
            base_script_path +'.py',
            'slapos.recipe.librecipe.execute.generic_exec',
            (command_line, wait_files, environment,), )
        return [python_script, self.createWrapper(
             name=wrapper_path,
             command=python_script,
             parameters=[],
             parameters_extra=parameters_extra,
             pidfile=pidfile,
             reserve_cpu=reserve_cpu
        )]

