/script/lib/PHP_CodeBrowser/PluginsAbstract.php

<?php
/**
 * Plugin Abstract
 *
 * PHP Version 5.3.0
 *
 * Copyright (c) 2007-2010, Mayflower GmbH
 * 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 Mayflower GmbH nor the names of his
 *     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 OWNER OR CONTRIBUTORS 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.
 *
 * @category  PHP_CodeBrowser
 * @package   PHP_CodeBrowser
 * @author    Elger Thiele <elger.thiele@mayflower.de>
 * @author    Michel Hartmann <michel.hartmann@mayflower.de>
 * @copyright 2007-2010 Mayflower GmbH
 * @license   http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @version   SVN: $Id$
 * @link      http://www.phpunit.de/
 * @since     File available since  0.1.0
 */

/**
 * CbPluginsAbstract
 *
 * @category  PHP_CodeBrowser
 * @package   PHP_CodeBrowser
 * @author    Elger Thiele <elger.thiele@mayflower.de>
 * @author    Michel Hartmann <michel.hartmann@mayflower.de>
 * @copyright 2007-2010 Mayflower GmbH
 * @license   http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @version   Release: 0.9.1
 * @link      http://www.phpunit.de/
 * @since     Class available since  0.1.0
 */
abstract class CbPluginsAbstract
{
    /**
     * The name of the plugin.
     * This should be the name that is written to the XML error files by
     * cruisecontrol.
     *
     * @var string
     */
    public $pluginName;

    /**
     * The CbIssueXml object
     *
     * @var CbIssueXml
     */
    protected $_issueXml;

    /**
     * Name of the attribute that holds the number of the first line
     * of the issue.
     *
     * @var String
     */
    protected $_lineStartAttr;

    /**
     * Name of the attribute that holds the number of the last line
     * of the issue.
     *
     * @var String
     */
    protected $_lineEndAttr;

    /**
     * Name of the attribute that holds message of the issue.
     *
     * @var String
     */
    protected $_descriptionAttr;

    /**
     * Name of the attribute that holds severity of the issue.
     *
     * @var String
     */
    protected $_severityAttr;

    /**
     * Default string to use as source for issue.
     *
     * @var String
     */
    protected $_source;

    /**
     * Default Constructor
     *
     * @param CbIssueXml $issueXml The cc XML document.
     */
    public function __construct(CbIssueXml $issueXml)
    {
        $this->_issueXml = $issueXml;
    }

    /**
     * Gets a list of CbFile objects, including their issues.
     *
     * @return Array of CbFile List of files with issues.
     */
    public function getFilelist()
    {
        $files = array();
        foreach ($this->getFilesWithIssues() as $name) {
            $files[] = new CbFile($name, $this->getIssuesByFile($name));
        }
        return $files;
    }

    /**
     * Parse the cc XML file for defined error type, e.g. "pmd" and map this
     * error to the Issue objects format.
     *
     * @param String $filename  Name of the file to parse the errors for.
     *
     * @return array
     */
    public function getIssuesByFile($filename)
    {
        $issues = array();
        foreach ($this->_getIssueNodes($filename) as $issueNode) {
            $issues = array_merge(
                $issues,
                $this->mapIssues($issueNode, $filename)
            );
        }
        return $issues;
    }

    /**
     * Get an array with all files that have issues.
     *
     * @return Array
     */
    public function getFilesWithIssues()
    {
        $filenames  = array();
        $issueNodes = $this->_issueXml->query(
            sprintf('/*/%s/file[@name]', $this->pluginName)
        );
        foreach ($issueNodes as $node) {
            $filenames[] = $node->getAttribute('name');
        }

        return array_unique($filenames);
    }

    /**
     * The detailed mapper method for each single plugin, returning an array
     * of issue objects.
     * This method provides a default behaviour an can be overloaded to
     * implement special behavior for other plugins.
     *
     * @param DomNode $element  The XML plugin node with its errors
     * @param String  $filename Name of the file to return issues for.
     *
     * @return Array            Array of issue objects.
     */
    public function mapIssues(DomNode $element, $filename)
    {
        $errorList = array();
        foreach ($element->childNodes as $child) {
            if (!($child instanceof DOMElement)) {
                continue;
            }
            $errorList[] = new CbIssue(
                $filename,
                $this->_getLineStart($child),
                $this->_getLineEnd($child),
                $this->_getSource($child),
                $this->_getDescription($child),
                $this->_getSeverity($child)
            );
        }
        return $errorList;
    }

    /**
     * Get all DOMNodes that represent issues for a specific file.
     *
     * @param String $filename      Name of the file to get nodes for.
     *
     * @return DOMNodeList
     */
    protected function _getIssueNodes($filename)
    {
        return $this->_issueXml->query(
            sprintf('/*/%s/file[@name="%s"]', $this->pluginName, $filename)
        );
    }

    /**
     * Default method for retrieving the first line of an issue.
     * @see self::mapIssues
     *
     * @param DOMElement $element
     *
     * @return Integer
     */
    protected function _getLineStart(DOMElement $element)
    {
        return (int) $element->getAttribute($this->_lineStartAttr);
    }

    /**
     * Default method for retrieving the last line of an issue.
     * @see self::mapIssues
     *
     * @param DOMElement $element
     *
     * @return Integer
     */
    protected function _getLineEnd(DOMElement $element)
    {
        return (int) $element->getAttribute($this->_lineEndAttr);
    }

    /**
     * Default method for retrieving the source of an issue.
     * @see self::mapIssues
     *
     * @param DOMElement $element
     *
     * @return String
     */
    protected function _getSource(DOMElement $element)
    {
        return $this->_source;
    }

    /**
     * Default method for retrieving the description of an issue.
     * @see self::mapIssues
     *
     * @param DOMElement $element
     *
     * @return String
     */
    protected function _getDescription(DOMElement $element)
    {
        return htmlentities($element->getAttribute($this->_descriptionAttr));
    }

    /**
     * Default method for retrieving the severity of an issue.
     * @see self::mapIssues
     *
     * @param DOMElement $element
     *
     * @return String
     */
    protected function _getSeverity(DOMElement $element)
    {
        return htmlentities($element->getAttribute($this->_severityAttr));
    }
}