# -*- coding: utf-8 -*-

# 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, see <http://www.gnu.org/licenses/>.

"""

kallithea.lib.inifile

~~~~~~~~~~~~~~~~~~~~~

Handling of .ini files, mainly creating them from Mako templates and adding

other custom values.

"""

import logging

import re

import mako.template

log = logging.getLogger(__name__)

def expand(template, desc, mako_variable_values, settings):

    """Expand mako template and tweak it.

    Not entirely stable for random templates as input, but good enough for our

    single template.

    >>> template = '''

    ... [first-section]

    ...

    ... variable=${mako_variable}

    ... variable2  =\tvalue after tab

    ... ## This section had some whitespace and stuff

    ...

    ...

    ... # ${mako_function()}

    ... [second-section]

    ... %if conditional_options == 'option-a':

    ... # Kallithea - config file generated with kallithea-config                      #

    ... %elif conditional_options == 'option-b':

    ... some_variable = "never mind - option-b will not be used anyway ..."

    ... %endif

    ... '''

    >>> desc = 'Description\\nof this config file'

    >>> selected_mako_conditionals = []

    >>> mako_variable_values = {'mako_variable': 'VALUE', 'mako_function': (lambda: 'FUNCTION RESULT'),

    ...                         'conditional_options': 'option-a'}

    >>> settings = { # only partially used

    ...     '[first-section]': {'variable2': 'VAL2', 'first_extra': 'EXTRA'},

    ...     '[third-section]': {'third_extra': ' 3'},

    ...     '[fourth-section]': {'fourth_extra': '4', 'fourth': '"four"'},

    ... }

    >>> print expand(template, desc, mako_variable_values, settings)

    <BLANKLINE>

    [first-section]

    <BLANKLINE>

    variable=VALUE

    #variable2 = value after tab

    variable2 = VAL2

    <BLANKLINE>

    <BLANKLINE>

    # FUNCTION RESULT

    [second-section]

    # Description                                                                  #

    # of this config file                                                          #

    <BLANKLINE>

    """

    ini_lines = mako.template.Template(template).render(**mako_variable_values)

    ini_lines = re.sub(

        '# Kallithea - config file generated with kallithea-config *#\n',

        ''.join('# %-77s#\n' % l.strip() for l in desc.strip().split('\n')),

        ini_lines)

    def process_section(m):

        """process a ini section, replacing values as necessary"""

        sectionname, lines = m.groups()

        if sectionname in settings:

            section_settings = settings[sectionname]

            def process_line(m):

                """process a section line and update value if necessary"""

                key, value = m.groups()

                line = m.group(0)

                if key in section_settings:

                    line = '%s = %s' % (key, section_settings[key])

                    if '$' not in value:

                        line = '#%s = %s\n%s' % (key, value, line)

                return line.rstrip()

            lines = re.sub(r'^([^#\n\s]*)[ \t]*=[ \t]*(.*)$', process_line, lines, flags=re.MULTILINE)

        return sectionname + '\n' + lines

    return ini_lines