XsltFilter::chain() - Code Metrics - Inspection of "update coding style (#1137)" - phingofficial/phing - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7082f0...55a2b2 )

by Siad

created 2019-10-06 13:42 UTC

XsltFilter::chain() A

↳ Parent: XsltFilter

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	7
nc	1
nop	1
dl	0
loc	10
ccs	0
cts	8
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?php
/**
 * 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.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the LGPL. For more information please see
 * <http://phing.info>.
 */

/**
 * Applies XSL stylesheet to incoming text.
 *
 * Uses PHP XSLT support (libxslt).
 *
 * @author Hans Lellelid <[email protected]>
 * @author Yannick Lecaillez <[email protected]>
 * @author Andreas Aderhold <[email protected]>
 *
 * @see     FilterReader
 * @package phing.filters
 */
class XsltFilter extends BaseParamFilterReader implements ChainableReader
{

    /**
     * Path to XSL stylesheet.
     *
     * @var PhingFile
     */
    private $xslFile = null;

    /**
     * Whether XML file has been transformed.
     *
     * @var boolean
     */
    private $processed = false;

    /**
     * XSLT Params.
     *
     * @var XsltParam[]
     */
    private $xsltParams = [];

    /**
     * Whether to use loadHTML() to parse the input XML file.
     */
    private $html = false;

    /**
     * Whether to resolve entities in the XML document (see
     * {@link http://www.php.net/manual/en/class.domdocument.php#domdocument.props.resolveexternals}
     * for more details).
     *
     * @var bool
     *
     * @since 2.4
     */
    private $resolveDocumentExternals = false;

    /**
     * Whether to resolve entities in the stylesheet.
     *
     * @var bool
     *
     * @since 2.4
     */
    private $resolveStylesheetExternals = false;

    /**
     * Create new XSLT Param object, to handle the <param/> nested element.
     *
     * @return XsltParam
     */
    public function createParam()
    {
        $num = array_push($this->xsltParams, new XsltParam());

        return $this->xsltParams[$num - 1];
    }

    /**
     * Sets the XSLT params for this class.
     * This is used to "clone" this class, in the chain() method.
     *
     * @param array $params
     */
    public function setParams($params)
    {
        $this->xsltParams = $params;
    }

    /**
     * Returns the XSLT params set for this class.
     * This is used to "clone" this class, in the chain() method.
     *
     * @return array
     */
    public function getParams()
    {
        return $this->xsltParams;
    }

    /**
     * Set the XSLT stylesheet.
     *
     * @param mixed $file PhingFile object or path.
     */
    public function setStyle(PhingFile $file)
    {
        $this->xslFile = $file;
    }

    /**
     * Whether to use HTML parser for the XML.
     * This is supported in libxml2 -- Yay!
     *
     * @return boolean
     */
    public function getHtml()
    {
        return $this->html;
    }

    /**
     * Whether to use HTML parser for XML.
     *
     * @param boolean $b
     */
    public function setHtml($b)
    {
        $this->html = (bool) $b;
    }

    /**
     * Get the path to XSLT stylesheet.
     *
     * @return PhingFile XSLT stylesheet path.
     */
    public function getStyle()
    {
        return $this->xslFile;
    }

    /**
     * Whether to resolve entities in document.
     *
     * @param bool $resolveExternals
     *
     * @since 2.4
     */
    public function setResolveDocumentExternals(bool $resolveExternals)
    {
        $this->resolveDocumentExternals = $resolveExternals;
    }

    /**
     * @return bool
     *
     * @since 2.4
     */
    public function getResolveDocumentExternals()
    {
        return $this->resolveDocumentExternals;
    }

    /**
     * Whether to resolve entities in stylesheet.
     *
     * @param bool $resolveExternals
     *
     * @since 2.4
     */
    public function setResolveStylesheetExternals(bool $resolveExternals)
    {
        $this->resolveStylesheetExternals = $resolveExternals;
    }

    /**
     * @return bool
     *
     * @since 2.4
     */
    public function getResolveStylesheetExternals()
    {
        return $this->resolveStylesheetExternals;
    }

    /**
     * Reads stream, applies XSLT and returns resulting stream.
     *
     * @param  int $len
     * @throws BuildException
     * @return string         transformed buffer.
     */
    public function read($len = null)
    {
        if (!class_exists('XSLTProcessor')) {
            throw new BuildException("Could not find the XSLTProcessor class. Make sure PHP has been compiled/configured to support XSLT.");
        }

        if ($this->processed === true) {
            return -1; // EOF
        }

        if (!$this->getInitialized()) {
            $this->initialize();
            $this->setInitialized(true);
        }

        // Read XML
        $_xml = null;
        while (($data = $this->in->read($len)) !== -1) {
            $_xml .= $data;
        }

        if ($_xml === null) { // EOF?
            return -1;
        }

        if (empty($_xml)) {
            $this->log("XML file is empty!", Project::MSG_WARN);

            return ''; // return empty string, don't attempt to apply XSLT
        }

        // Read XSLT
        $_xsl = null;

        $br = new BufferedReader(new FileReader($this->xslFile));
        $_xsl = $br->read();

        $this->log(
            "Tranforming XML " . $this->in->getResource() . " using style " . $this->xslFile->getPath(),
            Project::MSG_VERBOSE
        );

        $out = '';

        try {
            $out = $this->process($_xml, $_xsl);
            $this->processed = true;
        } catch (IOException $e) {
            throw new BuildException($e);
        }

        return $out;
    }

    // {{{ method _ProcessXsltTransformation($xml, $xslt) throws BuildException

    /**
     * Try to process the XSLT transformation
     *
     * @param string $xml XML to process.
     * @param string $xsl XSLT sheet to use for the processing.
     *
     * @return string
     *
     * @throws BuildException On XSLT errors
     */
    protected function process($xml, $xsl)
    {
        $processor = new XSLTProcessor();

        // Create and setup document.
        $xmlDom = new DOMDocument();
        $xmlDom->resolveExternals = $this->resolveDocumentExternals;

        // Create and setup stylesheet.
        $xslDom = new DOMDocument();
        $xslDom->resolveExternals = $this->resolveStylesheetExternals;

        if ($this->html) {
            $result = @$xmlDom->loadHTML($xml);
        } else {
            $result = @$xmlDom->loadXML($xml);
        }

        if ($result === false) {
            throw new BuildException('Invalid syntax detected.');
        }

        $xslDom->loadXML($xsl);

        if (defined('XSL_SECPREF_WRITE_FILE')) {
            $processor->setSecurityPrefs(XSL_SECPREF_WRITE_FILE | XSL_SECPREF_CREATE_DIRECTORY);
        }
        $processor->importStylesheet($xslDom);

        // ignoring param "type" attrib, because
        // we're only supporting direct XSL params right now
        foreach ($this->xsltParams as $param) {
            $this->log("Setting XSLT param: " . $param->getName() . "=>" . $param->getExpression(), Project::MSG_DEBUG);
            $processor->setParameter(null, $param->getName(), $param->getExpression());
        }

        $errorlevel = error_reporting();
        error_reporting($errorlevel & ~E_WARNING);
        @$result = $processor->transformToXml($xmlDom);
        error_reporting($errorlevel);

        if (false === $result) {
            //$errno = xslt_errno($processor);
            //$err   = xslt_error($processor);
            throw new BuildException("XSLT Error");
        }

        return $result;
    }

    /**
     * Creates a new XsltFilter using the passed in
     * Reader for instantiation.
     *
     * @param Reader A Reader object providing the underlying stream.
     *               Must not be <code>null</code>.
     *
     * @return XsltFilter A new filter based on this configuration, but filtering
     *                    the specified reader
     */
    public function chain(Reader $reader): Reader
    {
        $newFilter = new XsltFilter($reader);
        $newFilter->setProject($this->getProject());
        $newFilter->setStyle($this->getStyle());
        $newFilter->setInitialized(true);
        $newFilter->setParams($this->getParams());
        $newFilter->setHtml($this->getHtml());

        return $newFilter;
    }

    /**
     * Parses the parameters to get stylesheet path.
     */
    private function initialize()
    {
        $params = $this->getParameters();
        if ($params !== null) {

            for ($i = 0, $_i = count($params); $i < $_i; $i++) {
                if ($params[$i]->getType() === null) {
                    if ($params[$i]->getName() === "style") {
                        $this->setStyle($params[$i]->getValue());
                    }
                } elseif ($params[$i]->getType() == "param") {
                    $xp = new XsltParam();
                    $xp->setName($params[$i]->getName());
                    $xp->setExpression($params[$i]->getValue());
                    $this->xsltParams[] = $xp;
                }
            }
        }
    }
}


1			<?php
2			/**
3			* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4			* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5			* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6			* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7			* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8			* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9			* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10			* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11			* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12			* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13			* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14			*
15			* This software consists of voluntary contributions made by many individuals
16			* and is licensed under the LGPL. For more information please see
17			* <http://phing.info>.
18			*/
19
20			/**
21			* Applies XSL stylesheet to incoming text.
22			*
23			* Uses PHP XSLT support (libxslt).
24			*
25			* @author Hans Lellelid <[email protected]>
26			* @author Yannick Lecaillez <[email protected]>
27			* @author Andreas Aderhold <[email protected]>
28			*
29			* @see FilterReader
30			* @package phing.filters
31			*/
32			class XsltFilter extends BaseParamFilterReader implements ChainableReader
33			{
34
35			/**
36			* Path to XSL stylesheet.
37			*
38			* @var PhingFile
39			*/
40			private $xslFile = null;
41
42			/**
43			* Whether XML file has been transformed.
44			*
45			* @var boolean
46			*/
47			private $processed = false;
48
49			/**
50			* XSLT Params.
51			*
52			* @var XsltParam[]
53			*/
54			private $xsltParams = [];
55
56			/**
57			* Whether to use loadHTML() to parse the input XML file.
58			*/
59			private $html = false;
60
61			/**
62			* Whether to resolve entities in the XML document (see
63			* {@link http://www.php.net/manual/en/class.domdocument.php#domdocument.props.resolveexternals}
64			* for more details).
65			*
66			* @var bool
67			*
68			* @since 2.4
69			*/
70			private $resolveDocumentExternals = false;
71
72			/**
73			* Whether to resolve entities in the stylesheet.
74			*
75			* @var bool
76			*
77			* @since 2.4
78			*/
79			private $resolveStylesheetExternals = false;
80
81			/**
82			* Create new XSLT Param object, to handle the <param/> nested element.
83			*
84			* @return XsltParam
85			*/
86			public function createParam()
87			{
88			$num = array_push($this->xsltParams, new XsltParam());
89
90			return $this->xsltParams[$num - 1];
91			}
92
93			/**
94			* Sets the XSLT params for this class.
95			* This is used to "clone" this class, in the chain() method.
96			*
97			* @param array $params
98			*/
99			public function setParams($params)
100			{
101			$this->xsltParams = $params;
102			}
103
104			/**
105			* Returns the XSLT params set for this class.
106			* This is used to "clone" this class, in the chain() method.
107			*
108			* @return array
109			*/
110			public function getParams()
111			{
112			return $this->xsltParams;
113			}
114
115			/**
116			* Set the XSLT stylesheet.
117			*
118			* @param mixed $file PhingFile object or path.
119			*/
120			public function setStyle(PhingFile $file)
121			{
122			$this->xslFile = $file;
123			}
124
125			/**
126			* Whether to use HTML parser for the XML.
127			* This is supported in libxml2 -- Yay!
128			*
129			* @return boolean
130			*/
131			public function getHtml()
132			{
133			return $this->html;
134			}
135
136			/**
137			* Whether to use HTML parser for XML.
138			*
139			* @param boolean $b
140			*/
141			public function setHtml($b)
142			{
143			$this->html = (bool) $b;
144			}
145
146			/**
147			* Get the path to XSLT stylesheet.
148			*
149			* @return PhingFile XSLT stylesheet path.
150			*/
151			public function getStyle()
152			{
153			return $this->xslFile;
154			}
155
156			/**
157			* Whether to resolve entities in document.
158			*
159			* @param bool $resolveExternals
160			*
161			* @since 2.4
162			*/
163			public function setResolveDocumentExternals(bool $resolveExternals)
164			{
165			$this->resolveDocumentExternals = $resolveExternals;
166			}
167
168			/**
169			* @return bool
170			*
171			* @since 2.4
172			*/
173			public function getResolveDocumentExternals()
174			{
175			return $this->resolveDocumentExternals;
176			}
177
178			/**
179			* Whether to resolve entities in stylesheet.
180			*
181			* @param bool $resolveExternals
182			*
183			* @since 2.4
184			*/
185			public function setResolveStylesheetExternals(bool $resolveExternals)
186			{
187			$this->resolveStylesheetExternals = $resolveExternals;
188			}
189
190			/**
191			* @return bool
192			*
193			* @since 2.4
194			*/
195			public function getResolveStylesheetExternals()
196			{
197			return $this->resolveStylesheetExternals;
198			}
199
200			/**
201			* Reads stream, applies XSLT and returns resulting stream.
202			*
203			* @param int $len
204			* @throws BuildException
205			* @return string transformed buffer.
206			*/
207			public function read($len = null)
208			{
209			if (!class_exists('XSLTProcessor')) {
210			throw new BuildException("Could not find the XSLTProcessor class. Make sure PHP has been compiled/configured to support XSLT.");
211			}
212
213			if ($this->processed === true) {
214			return -1; // EOF
215			}
216
217			if (!$this->getInitialized()) {
218			$this->initialize();
219			$this->setInitialized(true);
220			}
221
222			// Read XML
223			$_xml = null;
224			while (($data = $this->in->read($len)) !== -1) {
225			$_xml .= $data;
226			}
227
228			if ($_xml === null) { // EOF?
229			return -1;
230			}
231
232			if (empty($_xml)) {
233			$this->log("XML file is empty!", Project::MSG_WARN);
234
235			return ''; // return empty string, don't attempt to apply XSLT
236			}
237
238			// Read XSLT
239			$_xsl = null;
			0 ignored issues – show Unused Code introduced 2019-07-31 09:36 UTC by Report Bug Copy Issue Report The assignment to `$_xsl` is dead and can be removed. Loading history...
240			$br = new BufferedReader(new FileReader($this->xslFile));
241			$_xsl = $br->read();
242
243			$this->log(
244			"Tranforming XML " . $this->in->getResource() . " using style " . $this->xslFile->getPath(),
245			Project::MSG_VERBOSE
246			);
247
248			$out = '';
			0 ignored issues – show Unused Code introduced 2019-07-31 09:36 UTC by Report Bug Copy Issue Report The assignment to `$out` is dead and can be removed. Loading history...
249			try {
250			$out = $this->process($_xml, $_xsl);
251			$this->processed = true;
252			} catch (IOException $e) {
253			throw new BuildException($e);
254			}
255
256			return $out;
257			}
258
259			// {{{ method _ProcessXsltTransformation($xml, $xslt) throws BuildException
260
261			/**
262			* Try to process the XSLT transformation
263			*
264			* @param string $xml XML to process.
265			* @param string $xsl XSLT sheet to use for the processing.
266			*
267			* @return string
268			*
269			* @throws BuildException On XSLT errors
270			*/
271			protected function process($xml, $xsl)
272			{
273			$processor = new XSLTProcessor();
274
275			// Create and setup document.
276			$xmlDom = new DOMDocument();
277			$xmlDom->resolveExternals = $this->resolveDocumentExternals;
278
279			// Create and setup stylesheet.
280			$xslDom = new DOMDocument();
281			$xslDom->resolveExternals = $this->resolveStylesheetExternals;
282
283			if ($this->html) {
284			$result = @$xmlDom->loadHTML($xml);
285			} else {
286			$result = @$xmlDom->loadXML($xml);
287			}
288
289			if ($result === false) {
290			throw new BuildException('Invalid syntax detected.');
291			}
292
293			$xslDom->loadXML($xsl);
294
295			if (defined('XSL_SECPREF_WRITE_FILE')) {
296			$processor->setSecurityPrefs(XSL_SECPREF_WRITE_FILE \| XSL_SECPREF_CREATE_DIRECTORY);
297			}
298			$processor->importStylesheet($xslDom);
299
300			// ignoring param "type" attrib, because
301			// we're only supporting direct XSL params right now
302			foreach ($this->xsltParams as $param) {
303			$this->log("Setting XSLT param: " . $param->getName() . "=>" . $param->getExpression(), Project::MSG_DEBUG);
304			$processor->setParameter(null, $param->getName(), $param->getExpression());
305			}
306
307			$errorlevel = error_reporting();
308			error_reporting($errorlevel & ~E_WARNING);
309			@$result = $processor->transformToXml($xmlDom);
310			error_reporting($errorlevel);
311
312			if (false === $result) {
313			//$errno = xslt_errno($processor);
314			//$err = xslt_error($processor);
315			throw new BuildException("XSLT Error");
316			}
317
318			return $result;
319			}
320
321			/**
322			* Creates a new XsltFilter using the passed in
323			* Reader for instantiation.
324			*
325			* @param Reader A Reader object providing the underlying stream.
326			* Must not be <code>null</code>.
327			*
328			* @return XsltFilter A new filter based on this configuration, but filtering
329			* the specified reader
330			*/
331			public function chain(Reader $reader): Reader
332			{
333			$newFilter = new XsltFilter($reader);
334			$newFilter->setProject($this->getProject());
335			$newFilter->setStyle($this->getStyle());
336			$newFilter->setInitialized(true);
337			$newFilter->setParams($this->getParams());
338			$newFilter->setHtml($this->getHtml());
339
340			return $newFilter;
341			}
342
343			/**
344			* Parses the parameters to get stylesheet path.
345			*/
346			private function initialize()
347			{
348			$params = $this->getParameters();
349			if ($params !== null) {
			0 ignored issues – show introduced 2019-07-31 09:36 UTC by Report Bug Copy Issue Report The condition `$params !== null` is always `true`. Loading history...
350			for ($i = 0, $_i = count($params); $i < $_i; $i++) {
351			if ($params[$i]->getType() === null) {
352			if ($params[$i]->getName() === "style") {
353			$this->setStyle($params[$i]->getValue());
354			}
355			} elseif ($params[$i]->getType() == "param") {
356			$xp = new XsltParam();
357			$xp->setName($params[$i]->getName());
358			$xp->setExpression($params[$i]->getValue());
359			$this->xsltParams[] = $xp;
360			}
361			}
362			}
363			}
364			}
365

phingofficial / phing

Push — master ( 7082f0...55a2b2 )

XsltFilter::chain() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like