<?php
/**
 * Copyright (c) 2009 Stefan Priebsch <stefan@priebsch.de>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 *   * Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *
 *   * Redistributions in binary form must reproduce the above copyright notice,
 *     this list of conditions and the following disclaimer in the documentation
 *     and/or other materials provided with the distribution.
 *
 *   * Neither the name of Stefan Priebsch nor the names of contributors
 *     may be used to endorse or promote products derived from this software
 *     without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER ORCONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * @package    PHPca
 * @author     Stefan Priebsch <stefan@priebsch.de>
 * @copyright  Stefan Priebsch <stefan@priebsch.de>. All rights reserved.
 * @license    BSD License
 */

namespace spriebsch\PHPca;

/**
 * The PHPca configuration.
 *
 * @author     Stefan Priebsch <stefan@priebsch.de>
 * @copyright  Stefan Priebsch <stefan@priebsch.de>. All rights reserved.
 */
class Configuration
{
    /**
     * Global configuration settings.
     *
     * @var array
     */
    protected $settings = array();

    /**
     * Configuration settings for individual rules.
     *
     * @var array
     */
    protected $ruleSettings = array();

    /**
     * The coding standard to enforce.
     *
     * @var string
     */
    protected $codingStandard;

    /**
     * File extensions to analyze.
     *
     * @var array
     */
    protected $extensions = array('php');

    /**
     * The line endings
     *
     * @var string
     */
    protected $lineEndings;

    /**
     * The indentation string
     *
     * @var string
     */
    protected $indentation;

    /**
     * Additional paths to load rules from.
     *
     * @var array
     */
    protected $rulePaths = array();

    /**
     * Rules to enforce.
     *
     * @var array
     */
    protected $rules = array();

    /**
     * Files to skip.
     *
     * @var array
     */
    protected $skipFiles = array();

    /**
     * Constructs the object.
     *
     * @param string $basePath
     * @return null
     */
    public function __construct($basePath)
    {
        $this->basePath = realpath($basePath);
    }

    /**
     * Converts paths to absolute paths.
     *
     * @param string $path Path
     * @return string
     * @todo fix for Windows
     */
    protected function toAbsolutePath($path)
    {
        if (substr($path, 0, 1) == '/') {
            return $path;
        }

        return $this->basePath . '/' . $path;
    }

    /**
     * Returns the base path.
     *
     * @return null
     */
    public function getBasePath()
    {
        return $this->basePath;
    }

    /**
     * Sets the standard settings read from an ini file.
     *
     * @param array $settings
     * @return null
     */
    public function setStandard(array $settings)
    {
        if (isset($settings['PHPca'])) {
            $this->settings = $settings['PHPca'];
            unset($settings['PHPca']);
        }

        $this->ruleSettings = $settings;
    }

    /**
     * Sets the configuration settings read from an ini file.
     *
     * @param array $configuration
     * @return null
     * @todo make global section parsing generic
     */
    public function setConfiguration(array $configuration)
    {
        if (isset($configuration['PHPca'])) {
            $this->settings = array_replace($this->settings, $configuration['PHPca']);
            unset($configuration['PHPca']);
        }

        if (isset($this->settings['additional_rules'])) {
            $paths = explode(',', $this->settings['additional_rules']);
            $this->rulePaths = array_map('trim', $paths);
        }

        if (isset($this->settings['skip'])) {
            $files = explode(',', $this->settings['skip']);
            $this->skipFiles = array_map('trim', $files);
        }

        if (isset($this->settings['line_endings'])) {
            $this->lineEndings = $this->settings['line_endings'];
        }

        if (isset($this->settings['indentation'])) {
            $this->indentation = $this->settings['indentation'];
        }

        $this->ruleSettings = array_replace($this->ruleSettings, $configuration);
    }

    /**
     * Sets the name of the coding standard to use.
     *
     * @param string $codingStandard
     * @return null
     */
    public function setCodingStandard($codingStandard)
    {
        $this->codingStandard = $codingStandard;
    }

    /**
     * Returns the coding standard used.
     *
     * @return string
     */
    public function getCodingStandard()
    {
        return $this->codingStandard;
    }

    /**
     * Sets the file extensions to analyze.
     *
     * @param array $extensions Array of file extensions
     * @return null
     */
    public function setExtensions(array $extensions)
    {
        $this->extensions = $extensions;
    }

    /**
     * Adds a file extensions to analyze.
     *
     * @param string $extension File extension
     * @return null
     */
    public function addExtension($extension)
    {
        $this->extensions[] = $extension;
    }

    /**
     * Returns the file extensions to analyze.
     *
     * @return array
     */
    public function getExtensions()
    {
        if (isset($this->settings['extensions'])) {
            $extensions = explode(',', $this->settings['extensions']);
            return array_map('trim', $extensions);
        }

        return $this->extensions;
    }

    /**
     * Sets the line endings.
     *
     * @param string $lineEndings The line endings
     * @return null
     */
    public function setLineEndings($lineEndings)
    {
        $this->lineEndings = $lineEndings;
    }

    /**
     * Returns the line endings.
     *
     * @return string
     */
    public function getLineEndings()
    {
        return $this->lineEndings;
    }

    /**
     * Sets the indentation string.
     *
     * @param string $indentation
     * @return null
     */
    public function setIndentation($indentation)
    {
        $this->indentation = $indentation;
    }

    /**
     * Returns the indentation string.
     *
     * @return string
     */
    public function getIndentation()
    {
        return $this->indentation;
    }

    /**
     * Sets the rule paths to load additional rules from.
     *
     * @param array $rulePaths Array of rule paths
     * @return null
     */
    public function setRulePaths(array $rulePaths)
    {
        $this->rulePaths = $rulePaths;
    }

    /**
     * Adds another path to load additional rules from.
     *
     * @param array $paths Rule paths
     * @return null
     */
    public function addRulePath($path)
    {
        $this->rulePaths[] = $path;
    }

    /**
     * Returns the additional rule paths from the configuration file.
     *
     * @return array
     */
    public function getRulePaths()
    {
        return $this->rulePaths;
    }

    /**
     * Sets the rules to enforce.
     *
     * @param array $extensions
     * @return null
     */
    public function setRules(array $rules)
    {
        foreach ($rules as &$rule) {
            if (substr($rule, -4) == 'Rule') {
                $rule = substr($rule, 0, -4);
            }
        }

        $this->rules = $rules;
    }

    /**
     * Add rule to enforce.
     *
     * @param string $rule
     * @return null
     */
    public function addRule($rule)
    {
        $this->rules[] = $rule;
    }

    /**
     * Returns the rules to enforce.
     *
     * @return array
     */
    public function getRules()
    {
        return $this->rules;
    }

    /**
     * Returns the list of files to skip.
     *
     * @return array
     */
    public function getSkipFiles()
    {
        return $this->skipFiles;
    }

    /**
     * Checks whether settings exist for given rule.
     *
     * @param string $rule
     * @return bool
     */
    public function hasSettings($rule)
    {
        return isset($this->ruleSettings[$rule]);
    }

    /**
     * Returns all settings for given rule.
     *
     * @param string $rule
     * @return array
     */
    public function getSettings($rule)
    {
        if (!isset($this->ruleSettings[$rule])) {
            return array();
        }

        $settings = $this->ruleSettings[$rule];

        if (isset($settings['skip'])) {
            $settings['skip'] = explode(',', $settings['skip']);
            $settings['skip'] = array_map('trim', $settings['skip']);

            foreach ($settings['skip'] as &$path) {
                $path = $this->toAbsolutePath($path);
            }
        }

        return $settings;
    }

    /**
     * Checks whether a certain setting exists for given rule.
     *
     * @param string $rule
     * @param string $setting
     * @return bool
     */
    public function hasSetting($rule, $setting)
    {
        return isset($this->ruleSettings[$rule]) && isset($this->ruleSettings[$rule][$setting]);
    }

    /**
     * Returns given setting for a given rule.
     *
     * @param string $rule
     * @param string $setting
     * @return string
     */
    public function getSetting($rule, $setting)
    {
        if (!isset($this->ruleSettings[$rule]) && !isset($this->ruleSettings[$rule][$setting])) {
            return '';
        }

        return $this->ruleSettings[$rule][$setting];
    }
}
?>