##############################################################################
#
# Copyright (c) 2012 Nexedi SA 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 Use, Study, Modify and Redistribute
# it under the terms of the GNU General Public License version 3, or (at your
# option) any later version, as published by the Free Software Foundation.
#
# You can also Link and Combine this program with other software covered by
# the terms of any of the Free Software licenses or any of the Open Source
# Initiative approved licenses and Convey the resulting work. Corresponding
# source of such a combination shall include the source code for all other
# software used.
#
# This program is distributed WITHOUT ANY WARRANTY; without even the implied
# warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
#
# See COPYING file for full licensing terms.
# See https://www.nexedi.com/licensing for rationale and options.
#
##############################################################################
from slapos.recipe.librecipe import GenericBaseRecipe

class Recipe(GenericBaseRecipe):
  """
  squid instance configuration.

  wrapper-path -- location of the init script to generate

  prepare-path -- location of the directory creation script to generate

  binary-path -- location of the squid command

  conf-path -- location of the configuration file

  cache-path -- location of the cache directory

  XXXX No good, specific...
  open_port -- entrance port to the host and allowed to use cache

  ip -- ip of the squid server

  port -- port of the squid server

  backend-ip -- ip of the service to cache

  backend-port -- port of the service to cache

  access-log-path -- location of the access log

  cache-log-path -- location of the cache log

  pid-filename-path -- location of the pid filename

  """

  def install(self):
    config = dict(
      ip=self.options['ip'], 
      port=self.options['port'],
      backend_ip=self.options['backend-ip'], 
      backend_port=self.options['backend-port'],
      cache_path=self.options['cache-path'],
      access_log_path=self.options['access-log-path'],
      cache_log_path=self.options['cache-log-path'],
      pid_filename_path=self.options['pid-filename-path'],
      open_port=self.options['open-port'],
      )

    template_filename = self.getTemplateFilename('squid.conf.in')
    configuration_path = self.createFile(
      self.options['conf-path'],
      self.substituteTemplate(template_filename, config))

    # Prepare directories
    prepare_path = self.createWrapper(
      self.options['prepare-path'],
      (self.options['binary-path'].strip(),
        '-z', '-f', configuration_path))

    # Create running wrapper
    wrapper_path = self.createWrapper(
      self.options['wrapper-path'],
      (self.options['binary-path'].strip(),
        '-N', '-f', configuration_path))

    return [configuration_path, wrapper_path, prepare_path]
