VCardParser - Code Metrics - Inspection of "Noteparser" - jeroendesloovere/vcard - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#70)

unknown

created 2016-06-19 10:07 UTC

VCardParser B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	279
Duplicated Lines	7.53 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	6
Bugs	0	Features	3

Metric	Value
wmc	51
c	6
b	0
f	3
lcom	1
cbo	0
dl	21
loc	279
rs	8.3206

14 Methods

Rating	Name	Duplication	Size	Complexity
A	parseFromFile()	0	8	3
A	__construct()	0	7	1
A	rewind()	0	4	1
A	current()	0	6	2
A	key()	0	4	1
A	next()	0	4	1
A	valid()	0	4	1
A	getCards()	0	4	1
A	getCardAtIndex()	0	7	2
D	parse()	21	120	34
A	parseName()	0	17	1
A	parseBirthday()	0	4	1
A	parseAddress()	0	21	1
A	unescape()	0	4	1

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like VCardParser often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use VCardParser, and based on these observations, apply Extract Interface, too.

<?php

namespace JeroenDesloovere\VCard;

/*
 * Copyright 2010 Thomas Schaaf <[email protected]>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Changes by: Wouter Admiraal <[email protected]>
 * Original code is available at: http://code.google.com/p/zendvcard/
 */

use Iterator;

/**
 * VCard PHP Class to parse .vcard files.
 *
 * This class is heavily based on the Zendvcard project (seemingly abandoned),
 * which is licensed under the Apache 2.0 license.
 * More information can be found at https://code.google.com/archive/p/zendvcard/
 *
 * @author Thomas Schaaf <[email protected]>
 * @author ruzicka.jan
 * @author Wouter Admiraal <[email protected]>
 */
class VCardParser implements Iterator
{
    /**
     * The raw VCard content.
    *
     * @var string
     */
    protected $content;

    /**
     * The VCard data objects.
     *
     * @var array
     */
    protected $vcardObjects;

    /**
     * The iterator position.
     *
     * @var int
     */
    protected $position;

    /**
     * Helper function to parse a file directly.
     *
     * @param string $filename
     *
     * @return JeroenDesloovere\VCard\VCardParser
     */
    public static function parseFromFile($filename)
    {
        if (file_exists($filename) && is_readable($filename)) {
            return new VCardParser(file_get_contents($filename));
        } else {
            throw new \RuntimeException(sprintf("File %s is not readable, or doesn't exist.", $filename));
        }
    }

    public function __construct($content)
    {
        $this->content = $content;
        $this->vcardObjects = array();
        $this->rewind();
        $this->parse();
    }

    public function rewind()
    {
        $this->position = 0;
    }

    public function current()
    {
        if ($this->valid()) {
            return $this->getCardAtIndex($this->position);
        }
    }

    public function key()
    {
        return $this->position;
    }

    public function next()
    {
        $this->position++;
    }

    public function valid()
    {
        return !empty($this->vcardObjects[$this->position]);
    }

    /**
     * Fetch all the imported VCards.
     *
     * @return array
     *    A list of VCard card data objects.
     */
    public function getCards()
    {
        return $this->vcardObjects;
    }

    /**
     * Fetch the imported VCard at the specified index.
     *
     * @throws OutOfBoundsException
     *
     * @param int $i
     *
     * @return stdClass
     *    The card data object.
     */
    public function getCardAtIndex($i)
    {
        if (isset($this->vcardObjects[$i])) {
            return $this->vcardObjects[$i];
        }
        throw new \OutOfBoundsException();
    }

    /**
     * Start the parsing process.
     *
     * This method will populate the data object.
     */
    protected function parse()
    {
        // Normalize new lines.
        $this->content = str_replace(array("\r\n", "\r"), "\n", $this->content);

        // RFC2425 5.8.1. Line delimiting and folding
        // Unfolding is accomplished by regarding CRLF immediately followed by
        // a white space character (namely HTAB ASCII decimal 9 or. SPACE ASCII
        // decimal 32) as equivalent to no characters at all (i.e., the CRLF
        // and single white space character are removed).
        $this->content = preg_replace("/\n(?:[ \t])/", "", $this->content);
        $lines = explode("\n", $this->content);

        // Parse the VCard, line by line.
        foreach ($lines as $line) {
            $line = trim($line);

            if (strtoupper($line) == "BEGIN:VCARD") {
                $cardData = new \stdClass();
            } elseif (strtoupper($line) == "END:VCARD") {
                $this->vcardObjects[] = $cardData;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
            } elseif (!empty($line)) {
                $type = '';
                $value = '';
                @list($type, $value) = explode(':', $line, 2);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}

                $types = explode(';', $type);
                $element = strtoupper($types[0]);

                array_shift($types);
                $i = 0;
                $rawValue = false;
                foreach ($types as $type) {
                    if (preg_match('/base64/', strtolower($type))) {
                        $value = base64_decode($value);
                        unset($types[$i]);
                        $rawValue = true;
                    } elseif (preg_match('/encoding=b/', strtolower($type))) {
                        $value = base64_decode($value);
                        unset($types[$i]);
                        $rawValue = true;
                    } elseif (preg_match('/quoted-printable/', strtolower($type))) {
                        $value = quoted_printable_decode($value);
                        unset($types[$i]);
                        $rawValue = true;
                    } elseif (strpos(strtolower($type), 'charset=') === 0) {
                        try {
                            $value = mb_convert_encoding($value, "UTF-8", substr($type, 8));
                        } catch (\Exception $e) { }

                        unset($types[$i]);
                    }
                    $i++;
                }

                switch (strtoupper($element)) {
                    case 'FN':
                        $cardData->fullname = $value;
                        break;
                    case 'N':
                        foreach($this->parseName($value) as $key => $val) {
                            $cardData->{$key} = $val;
                        }
                        break;
                    case 'BDAY':
                        $cardData->birthday = $this->parseBirthday($value);
                        break;
                    case 'ADR':
                        if (!isset($cardData->address)) {
                            $cardData->address = array();
                        }
                        $key = !empty($types) ? implode(';', $types) : 'WORK;POSTAL';
                        $cardData->address[$key][] = $this->parseAddress($value);
                        break;
                    case 'TEL':

                        if (!isset($cardData->phone)) {
                            $cardData->phone = array();
                        }
                        $key = !empty($types) ? implode(';', $types) : 'default';
                        $cardData->phone[$key][] = $value;
                        break;
                    case 'EMAIL':

                        if (!isset($cardData->email)) {
                            $cardData->email = array();
                        }
                        $key = !empty($types) ? implode(';', $types) : 'default';
                        $cardData->email[$key][] = $value;
                        break;
                    case 'REV':
                        $cardData->revision = $value;
                        break;
                    case 'VERSION':
                        $cardData->version = $value;
                        break;
                    case 'ORG':
                        $cardData->organization = $value;
                        break;
                    case 'URL':

                        if (!isset($cardData->url)) {
                            $cardData->url = array();
                        }
                        $key = !empty($types) ? implode(';', $types) : 'default';
                        $cardData->url[$key][] = $value;
                        break;
                    case 'TITLE':
                        $cardData->title = $value;
                        break;
                    case 'PHOTO':
                        if ($rawValue) {
                            $cardData->rawPhoto = $value;
                        } else {
                            $cardData->photo = $value;
                        }
                        break;
                    case 'NOTE':
                        $cardData->note = $this->unescape($value);
                        break;
                }
            }
        }
    }

    protected function parseName($value)
    {
        @list(
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
            $lastname,
            $firstname,
            $additional,
            $prefix,
            $suffix
        ) = explode(';', $value);
        return (object) array(
            'lastname' => $lastname,
            'firstname' => $firstname,
            'additional' => $additional,
            'prefix' => $prefix,
            'suffix' => $suffix,
        );
    }

    protected function parseBirthday($value)
    {
        return new \DateTime($value);
    }

    protected function parseAddress($value)
    {
        @list(
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
            $name,
            $extended,
            $street,
            $city,
            $region,
            $zip,
            $country,
        ) = explode(';', $value);
        return (object) array(
            'name' => $name,
            'extended' => $extended,
            'street' => $street,
            'city' => $city,
            'region' => $region,
            'zip' => $zip,
            'country' => $country,
        );
    }

    protected function unescape($text)
    {
        return str_replace("\\n", PHP_EOL, $text);
    }
}


1		<?php
2
3		namespace JeroenDesloovere\VCard;
4
5		/*
6		* Copyright 2010 Thomas Schaaf <[email protected]>
7		*
8		* Licensed under the Apache License, Version 2.0 (the "License");
9		* you may not use this file except in compliance with the License.
10		* You may obtain a copy of the License at
11		*
12		* http://www.apache.org/licenses/LICENSE-2.0
13		*
14		* Unless required by applicable law or agreed to in writing, software
15		* distributed under the License is distributed on an "AS IS" BASIS,
16		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17		* See the License for the specific language governing permissions and
18		* limitations under the License.
19		*
20		* Changes by: Wouter Admiraal <[email protected]>
21		* Original code is available at: http://code.google.com/p/zendvcard/
22		*/
23
24		use Iterator;
25
26		/**
27		* VCard PHP Class to parse .vcard files.
28		*
29		* This class is heavily based on the Zendvcard project (seemingly abandoned),
30		* which is licensed under the Apache 2.0 license.
31		* More information can be found at https://code.google.com/archive/p/zendvcard/
32		*
33		* @author Thomas Schaaf <[email protected]>
34		* @author ruzicka.jan
35		* @author Wouter Admiraal <[email protected]>
36		*/
37		class VCardParser implements Iterator
38		{
39		/**
40		* The raw VCard content.
41		*
42		* @var string
43		*/
44		protected $content;
45
46		/**
47		* The VCard data objects.
48		*
49		* @var array
50		*/
51		protected $vcardObjects;
52
53		/**
54		* The iterator position.
55		*
56		* @var int
57		*/
58		protected $position;
59
60		/**
61		* Helper function to parse a file directly.
62		*
63		* @param string $filename
64		*
65		* @return JeroenDesloovere\VCard\VCardParser
66		*/
67		public static function parseFromFile($filename)
68		{
69		if (file_exists($filename) && is_readable($filename)) {
70		return new VCardParser(file_get_contents($filename));
71		} else {
72		throw new \RuntimeException(sprintf("File %s is not readable, or doesn't exist.", $filename));
73		}
74		}
75
76		public function __construct($content)
77		{
78		$this->content = $content;
79		$this->vcardObjects = array();
80		$this->rewind();
81		$this->parse();
82		}
83
84		public function rewind()
85		{
86		$this->position = 0;
87		}
88
89		public function current()
90		{
91		if ($this->valid()) {
92		return $this->getCardAtIndex($this->position);
93		}
94		}
95
96		public function key()
97		{
98		return $this->position;
99		}
100
101		public function next()
102		{
103		$this->position++;
104		}
105
106		public function valid()
107		{
108		return !empty($this->vcardObjects[$this->position]);
109		}
110
111		/**
112		* Fetch all the imported VCards.
113		*
114		* @return array
115		* A list of VCard card data objects.
116		*/
117		public function getCards()
118		{
119		return $this->vcardObjects;
120		}
121
122		/**
123		* Fetch the imported VCard at the specified index.
124		*
125		* @throws OutOfBoundsException
126		*
127		* @param int $i
128		*
129		* @return stdClass
130		* The card data object.
131		*/
132		public function getCardAtIndex($i)
133		{
134		if (isset($this->vcardObjects[$i])) {
135		return $this->vcardObjects[$i];
136		}
137		throw new \OutOfBoundsException();
138		}
139
140		/**
141		* Start the parsing process.
142		*
143		* This method will populate the data object.
144		*/
145		protected function parse()
146		{
147		// Normalize new lines.
148		$this->content = str_replace(array("\r\n", "\r"), "\n", $this->content);
149
150		// RFC2425 5.8.1. Line delimiting and folding
151		// Unfolding is accomplished by regarding CRLF immediately followed by
152		// a white space character (namely HTAB ASCII decimal 9 or. SPACE ASCII
153		// decimal 32) as equivalent to no characters at all (i.e., the CRLF
154		// and single white space character are removed).
155		$this->content = preg_replace("/\n(?:[ \t])/", "", $this->content);
156		$lines = explode("\n", $this->content);
157
158		// Parse the VCard, line by line.
159		foreach ($lines as $line) {
160		$line = trim($line);
161
162		if (strtoupper($line) == "BEGIN:VCARD") {
163		$cardData = new \stdClass();
164		} elseif (strtoupper($line) == "END:VCARD") {
165		$this->vcardObjects[] = $cardData;
		0 ignored issues – show Bug introduced 2016-05-30 10:51 UTC by Report Bug Copy Issue Report The variable `$cardData` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
166		} elseif (!empty($line)) {
167		$type = '';
168		$value = '';
169		@list($type, $value) = explode(':', $line, 2);
		0 ignored issues – show Security Best Practice introduced 2016-05-30 10:51 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
170
171		$types = explode(';', $type);
172		$element = strtoupper($types[0]);
173
174		array_shift($types);
175		$i = 0;
176		$rawValue = false;
177		foreach ($types as $type) {
178		if (preg_match('/base64/', strtolower($type))) {
179		$value = base64_decode($value);
180		unset($types[$i]);
181		$rawValue = true;
182		} elseif (preg_match('/encoding=b/', strtolower($type))) {
183		$value = base64_decode($value);
184		unset($types[$i]);
185		$rawValue = true;
186		} elseif (preg_match('/quoted-printable/', strtolower($type))) {
187		$value = quoted_printable_decode($value);
188		unset($types[$i]);
189		$rawValue = true;
190		} elseif (strpos(strtolower($type), 'charset=') === 0) {
191		try {
192		$value = mb_convert_encoding($value, "UTF-8", substr($type, 8));
193		} catch (\Exception $e) { }
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-05-30 10:51 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
194		unset($types[$i]);
195		}
196		$i++;
197		}
198
199		switch (strtoupper($element)) {
200		case 'FN':
201		$cardData->fullname = $value;
202		break;
203		case 'N':
204		foreach($this->parseName($value) as $key => $val) {
205		$cardData->{$key} = $val;
206		}
207		break;
208		case 'BDAY':
209		$cardData->birthday = $this->parseBirthday($value);
210		break;
211		case 'ADR':
212		if (!isset($cardData->address)) {
213		$cardData->address = array();
214		}
215		$key = !empty($types) ? implode(';', $types) : 'WORK;POSTAL';
216		$cardData->address[$key][] = $this->parseAddress($value);
217		break;
218	View Code Duplication	case 'TEL':
		0 ignored issues – show Duplication introduced 2016-05-30 10:51 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
219		if (!isset($cardData->phone)) {
220		$cardData->phone = array();
221		}
222		$key = !empty($types) ? implode(';', $types) : 'default';
223		$cardData->phone[$key][] = $value;
224		break;
225	View Code Duplication	case 'EMAIL':
		0 ignored issues – show Duplication introduced 2016-05-30 10:51 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
226		if (!isset($cardData->email)) {
227		$cardData->email = array();
228		}
229		$key = !empty($types) ? implode(';', $types) : 'default';
230		$cardData->email[$key][] = $value;
231		break;
232		case 'REV':
233		$cardData->revision = $value;
234		break;
235		case 'VERSION':
236		$cardData->version = $value;
237		break;
238		case 'ORG':
239		$cardData->organization = $value;
240		break;
241	View Code Duplication	case 'URL':
		0 ignored issues – show Duplication introduced 2016-05-30 10:51 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
242		if (!isset($cardData->url)) {
243		$cardData->url = array();
244		}
245		$key = !empty($types) ? implode(';', $types) : 'default';
246		$cardData->url[$key][] = $value;
247		break;
248		case 'TITLE':
249		$cardData->title = $value;
250		break;
251		case 'PHOTO':
252		if ($rawValue) {
253		$cardData->rawPhoto = $value;
254		} else {
255		$cardData->photo = $value;
256		}
257		break;
258		case 'NOTE':
259		$cardData->note = $this->unescape($value);
260		break;
261		}
262		}
263		}
264		}
265
266		protected function parseName($value)
267		{
268		@list(
		0 ignored issues – show Security Best Practice introduced 2016-05-30 10:51 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
269		$lastname,
270		$firstname,
271		$additional,
272		$prefix,
273		$suffix
274		) = explode(';', $value);
275		return (object) array(
276		'lastname' => $lastname,
277		'firstname' => $firstname,
278		'additional' => $additional,
279		'prefix' => $prefix,
280		'suffix' => $suffix,
281		);
282		}
283
284		protected function parseBirthday($value)
285		{
286		return new \DateTime($value);
287		}
288
289		protected function parseAddress($value)
290		{
291		@list(
		0 ignored issues – show Security Best Practice introduced 2016-05-30 10:51 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
292		$name,
293		$extended,
294		$street,
295		$city,
296		$region,
297		$zip,
298		$country,
299		) = explode(';', $value);
300		return (object) array(
301		'name' => $name,
302		'extended' => $extended,
303		'street' => $street,
304		'city' => $city,
305		'region' => $region,
306		'zip' => $zip,
307		'country' => $country,
308		);
309		}
310
311		protected function unescape($text)
312		{
313		return str_replace("\\n", PHP_EOL, $text);
314		}
315		}
316

jeroendesloovere / vcard