#!/bin/bash
#
# render_setBaseRendition.sh -- This function performs base-rendition
# action for all files.
#
# Copyright (C) 2009-2013 The CentOS Project
#
# 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 2 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., 675 Mass Ave, Cambridge, MA 02139, USA.
#
# ----------------------------------------------------------------------
# $Id$
# ----------------------------------------------------------------------
 
function render_setBaseRendition {
 
    local -a FILES
    local FILE=''
    local OUTPUT=''
    local TEMPLATE=''
    local TEMPLATES=''
    local PARENTDIR=''
    local TRANSLATION=''
    local EXTERNALFILE=''
    local EXTERNALFILES=''
    local THIS_FILE_DIR=''
    local NEXT_FILE_DIR=''
    local RENDER_EXTENSION=''
    local EXPORTID=''
    local COUNT=0
 
    # Verify default directory where design models are stored in.
    cli_checkFiles -e "${TCAR_WORKDIR}/Identity/Models/Themes/${FLAG_THEME_MODEL}"
 
    # Redefine parent directory for current workplace.
    PARENTDIR=$(basename "${ACTIONVAL}")
 
    # Loop through list of supported file extensions. 
    for RENDER_EXTENSION in ${RENDER_EXTENSIONS};do
 
        # Redefine rendition format name based on supported file
        # extension.
        if [[ $RENDER_EXTENSION =~ '^(svgz|svg)$' ]];then
            RENDER_FORMAT='svg'
        elif [[ $RENDER_EXTENSION =~ '^(docbook)$' ]];then
            RENDER_FORMAT='docbook'
        elif [[ $RENDER_EXTENSION =~ '^(conf)$' ]];then
            RENDER_FORMAT='conf'
        else
           cli_printMessage "`eval_gettext "The \\\"\\\$RENDER_EXTENSION\\\" file extension is not supported yet."`" --as-error-line 
        fi
 
        # Redefine specific function export id. 
        EXPORTID="${CLI_FUNCDIRNAM}/$(cli_getRepoName ${RENDER_FORMAT} -d)/$(cli_getRepoName ${RENDER_FORMAT} -f)"
 
        # Define base location of template files using paths passed to
        # centos-art.sh script as argument to.
        render_getDirTemplate
 
        # Verify whether or not the source location of the path
        # provided as argument to centos-art.sh script accepts or not
        # localization messages. Don't produce localized content for
        # repository components that don't accept it.
        if [[ ! ${CLI_LANG_LC} =~ '^en' ]];then
            cli_runFnEnvironment locale --is-localizable ${TEMPLATE}
        fi
 
        # Define the list of files to process. Use an array variable
        # to store the list of files to process. This make possible to
        # realize verifications like: is the current base directory
        # equal to the next one in the list of files to process?
        # Questions like this let us to know when centos-art.sh is
        # leaving a directory structure and entering another. This
        # information is required in order for centos-art.sh to know
        # when to apply last-rendition actions.
        #
        # Another issue is that some directories might be named as if
        # they were files (e.g., using a render able extension like
        # .docbook).  In these situations we need to avoid such
        # directories from being interpreted as a render able file.
        # For this, pass the `--type="f"' option when building the
        # list of files to process in order to retrieve regular files
        # only.
        #
        # Another issue to consider here is that, in some cases, both
        # templates and outputs might be in the same location. In
        # these cases localized content are stored in the same
        # location where template files are retrieved from and we need
        # to avoid using localized content from being interpreted as
        # design models. In that sake, build the list of files to
        # process using the files directly stored in the directory
        # passed as argument to centos-art.sh command-line. Don't go
        # recursively here.
        #
        # Another issue to consider here, is the way of restricting
        # the list of files to process. We cannot expand the pattern
        # specified by FLAG_FILTER with a `.*' here (e.g.,
        # "${FLAG_FILTER}.*\.${RENDER_EXTENSION}") because that would
        # suppress any possibility from the user to specify just one
        # file name in locations where more than one file with the
        # same name as prefix exists (e.g., `repository.docbook',
        # `repository-preamble.docbook' and
        # `repository-parts.docbook').  Instead, pass filtering
        # control to the user whom can use regular expression markup
        # in the `--filter' option to decide whether to match
        # `repository.docbook' only (e.g., through
        # `--filter="repository"') or `repository-preamble.docbook'
        # and `repository-parts.docbook' but not `repository.docbook'
        # (e.g., through `--filter="repository-.*"').
        if [[ ${RENDER_FORMAT} =~ "^docbook$" ]];then
 
            # When the render format is docbook, don't build a list of
            # files to process. Instead, build the absolute path of
            # the main file used to render docbook from models to
            # final output manuals. This file must be stored directly
            # inside the main manual's directory and named as it but
            # with all letters in lowercase.
            for FILE in $(cli_getFilesList ${TEMPLATE} \
                --maxdepth="1" --mindepth="1" \
                --pattern="^.*$(cli_getRepoName ${TEMPLATE} -f)\.${RENDER_EXTENSION}$" \
                --type="f");do
                FILES[((++${#FILES[*]}))]=$FILE
            done
 
        elif [[ ${RENDER_FORMAT} =~ "^conf$" ]];then
 
            # When the render format is conf, be sure it refers to
            # image.conf files only. Other configuration files (e.g.,
            # branding.conf) cannot be processed this way because
            # their configuration options and values haven't any
            # meaning in this context.
            for FILE in $(cli_getFilesList ${TEMPLATE} \
                --pattern="^.+/images\.${RENDER_EXTENSION}$" \
                --type="f");do
                FILES[((++${#FILES[*]}))]=$FILE
            done
 
        else
 
            # For all other cases, build a list of files to process
            # using the path value pass as argument.
            for FILE in $(cli_getFilesList ${TEMPLATE} \
                --pattern="^.+/${FLAG_FILTER}.*\.${RENDER_EXTENSION}$" \
                --type="f");do
                FILES[((++${#FILES[*]}))]=$FILE
            done
 
        fi
 
        # Verify list of files to process. Assuming no file was found,
        # evaluate the next supported file extension.
        if [[ ${#FILES[*]} -eq 0 ]];then
            continue
        fi
 
        # Initialize format-specific functionalities.
        cli_exportFunctions "${EXPORTID}"
 
        # Start processing the base rendition list of FILES. Fun part
        # approaching :-).
        while [[ $COUNT -lt ${#FILES[*]} ]];do
 
            # Define base file.
            FILE=${FILES[$COUNT]}
 
            # Define the base directory path for the current file being
            # process.
            THIS_FILE_DIR=$(dirname ${FILES[$COUNT]})
 
            # Define the base directory path for the next file that will
            # be process.
            if [[ $(($COUNT + 1)) -lt ${#FILES[*]} ]];then
                NEXT_FILE_DIR=$(dirname ${FILES[$(($COUNT + 1))]})
            else
                NEXT_FILE_DIR=''
            fi
 
            # Print separator line.
            cli_printMessage '-' --as-separator-line
 
            # Print action message based on file extension.
            if [[ ${FILE} =~ 'images\.conf$' ]] && [[ $FLAG_WITH_BRANDS == 'true' ]];then
                cli_printMessage "${FILE}" --as-processing-line
            elif [[ ${FILE} =~ 'brands\.conf$' ]];then
                continue
            else
                cli_printMessage "${FILE}" --as-template-line
            fi
 
            # Verify design models file existence. We cannot continue
            # with out it.
            cli_checkFiles ${FILE} -f
 
            # Define final location of translation file.
            TRANSLATION=$(dirname ${FILE} \
               | sed -r 's!(Documentation|Identity)!Locales/\1!')/${CLI_LANG_LC}/messages.po
 
            # Define final location of template file.
            TEMPLATE=${FILE}
 
            # Define final location of output directory.
            render_getDirOutput
 
            # Get relative path to file. The path string (stored in
            # FILE) has two parts: 1. the variable path and 2. the
            # common path.  The variable path is before the common
            # point in the path string. The common path is after the
            # common point in the path string. The common point is the
            # name of the parent directory (stored in PARENTDIR).
            #
            # Identity/Models/Themes/.../Firstboot/3/splash-small.svg
            # -------------------------^| the     |^------------^
            # variable path             | common  |    common path
            # -------------------------v| point   |    v------------v
            # Identity/Images/Themes/.../Firstboot/Img/3/splash-small.png
            #
            # What we do here is remove the variable path, the common
            # point, and the file extension parts in the string
            # holding the path retrieved from design models directory
            # structure.  Then we use the common path as relative path
            # to store the final image file.
            #
            # The file extension is removed from the common path
            # because it is set when we create the final image file.
            # This configuration let us use different extensions for
            # the same file name.
            #
            # When we render using base-rendition action, the
            # structure of files under the output directory will be
            # the same used after the common point in the related
            # design model directory structure.
            FILE=$(echo ${FILE} \
                | sed -r "s!.*${PARENTDIR}/!!" \
                | sed -r "s/\.${RENDER_EXTENSION}$//")
 
            # Define absolute path to final file (without extension).
            FILE=${OUTPUT}/$(basename "${FILE}")
 
            # Define instance name from design model.
            INSTANCE=$(cli_getTemporalFile ${TEMPLATE})
 
            # Perform format base-rendition.
            ${RENDER_FORMAT}
 
            # Remove template instance. 
            if [[ -f $INSTANCE ]];then
                rm $INSTANCE
            fi
 
            # Increment file counter.
            COUNT=$(($COUNT + 1))
 
        done
 
        # Reset counter to prevent accumulation of values.
        COUNT=0
 
        # Unset format-specific functionalities.
        cli_unsetFunctions "${EXPORTID}"
 
        # Unset files list to prevent accumulation of values.
        unset FILES
 
    done
}