VCardParser::parse() - Code Metrics - Inspection of "Merge pull request #72 from wadmiraal/master" - jeroendesloovere/vcard - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b352fa...197388 )

by Jeroen

created 2017-02-14 08:47 UTC

VCardParser::parse() F

↳ Parent: VCardParser

Complexity

Conditions	38
Paths	438

Size

Total Lines	147
Code Lines	108

Duplication

Lines	21
Ratio	14.29 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	21
loc	147
rs	3.1761
cc	38
eloc	108
nc	438
nop	0

How to fix Long Method Complexity

<?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)) {
                // Strip grouping information. We don't use the group names. We
                // simply use a list for entries that have multiple values.
                // As per RFC, group names are alphanumerical, and end with a
                // period (.).
                $line = preg_replace('/^\w+\./', '', $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);

                // Normalize types. A type can either be a type-param directly,
                // or can be prefixed with "type=". E.g.: "INTERNET" or
                // "type=INTERNET".
                if (!empty($types)) {
                    $types = array_map(function($type) {
                        return preg_replace('/^type=/i', '', $type);
                    }, $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 'LOGO':
                        if ($rawValue) {
                            $cardData->rawLogo = $value;
                        } else {
                            $cardData->logo = $value;
                        }
                        break;
                    case 'NOTE':
                        $cardData->note = $this->unescape($value);
                        break;
                    case 'CATEGORIES':
                        $cardData->categories = array_map('trim', explode(',', $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,
        );
    }

    /**
     * Unescape newline characters according to RFC2425 section 5.8.4.
     * This function will replace escaped line breaks with PHP_EOL.
     *
     * @link http://tools.ietf.org/html/rfc2425#section-5.8.4
     * @param  string $text
     * @return string
     */
    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		// Strip grouping information. We don't use the group names. We
168		// simply use a list for entries that have multiple values.
169		// As per RFC, group names are alphanumerical, and end with a
170		// period (.).
171		$line = preg_replace('/^\w+\./', '', $line);
172
173		$type = '';
174		$value = '';
175		@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...
176
177		$types = explode(';', $type);
178		$element = strtoupper($types[0]);
179
180		array_shift($types);
181
182		// Normalize types. A type can either be a type-param directly,
183		// or can be prefixed with "type=". E.g.: "INTERNET" or
184		// "type=INTERNET".
185		if (!empty($types)) {
186		$types = array_map(function($type) {
187		return preg_replace('/^type=/i', '', $type);
188		}, $types);
189		}
190
191		$i = 0;
192		$rawValue = false;
193		foreach ($types as $type) {
194		if (preg_match('/base64/', strtolower($type))) {
195		$value = base64_decode($value);
196		unset($types[$i]);
197		$rawValue = true;
198		} elseif (preg_match('/encoding=b/', strtolower($type))) {
199		$value = base64_decode($value);
200		unset($types[$i]);
201		$rawValue = true;
202		} elseif (preg_match('/quoted-printable/', strtolower($type))) {
203		$value = quoted_printable_decode($value);
204		unset($types[$i]);
205		$rawValue = true;
206		} elseif (strpos(strtolower($type), 'charset=') === 0) {
207		try {
208		$value = mb_convert_encoding($value, "UTF-8", substr($type, 8));
209		} 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...
210		}
211		unset($types[$i]);
212		}
213		$i++;
214		}
215
216		switch (strtoupper($element)) {
217		case 'FN':
218		$cardData->fullname = $value;
219		break;
220		case 'N':
221		foreach ($this->parseName($value) as $key => $val) {
222		$cardData->{$key} = $val;
223		}
224		break;
225		case 'BDAY':
226		$cardData->birthday = $this->parseBirthday($value);
227		break;
228		case 'ADR':
229		if (!isset($cardData->address)) {
230		$cardData->address = array();
231		}
232		$key = !empty($types) ? implode(';', $types) : 'WORK;POSTAL';
233		$cardData->address[$key][] = $this->parseAddress($value);
234		break;
235	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...
236		if (!isset($cardData->phone)) {
237		$cardData->phone = array();
238		}
239		$key = !empty($types) ? implode(';', $types) : 'default';
240		$cardData->phone[$key][] = $value;
241		break;
242	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...
243		if (!isset($cardData->email)) {
244		$cardData->email = array();
245		}
246		$key = !empty($types) ? implode(';', $types) : 'default';
247		$cardData->email[$key][] = $value;
248		break;
249		case 'REV':
250		$cardData->revision = $value;
251		break;
252		case 'VERSION':
253		$cardData->version = $value;
254		break;
255		case 'ORG':
256		$cardData->organization = $value;
257		break;
258	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...
259		if (!isset($cardData->url)) {
260		$cardData->url = array();
261		}
262		$key = !empty($types) ? implode(';', $types) : 'default';
263		$cardData->url[$key][] = $value;
264		break;
265		case 'TITLE':
266		$cardData->title = $value;
267		break;
268		case 'PHOTO':
269		if ($rawValue) {
270		$cardData->rawPhoto = $value;
271		} else {
272		$cardData->photo = $value;
273		}
274		break;
275		case 'LOGO':
276		if ($rawValue) {
277		$cardData->rawLogo = $value;
278		} else {
279		$cardData->logo = $value;
280		}
281		break;
282		case 'NOTE':
283		$cardData->note = $this->unescape($value);
284		break;
285		case 'CATEGORIES':
286		$cardData->categories = array_map('trim', explode(',', $value));
287		break;
288		}
289		}
290		}
291		}
292
293		protected function parseName($value)
294		{
295		@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...
296		$lastname,
297		$firstname,
298		$additional,
299		$prefix,
300		$suffix
301		) = explode(';', $value);
302		return (object) array(
303		'lastname' => $lastname,
304		'firstname' => $firstname,
305		'additional' => $additional,
306		'prefix' => $prefix,
307		'suffix' => $suffix,
308		);
309		}
310
311		protected function parseBirthday($value)
312		{
313		return new \DateTime($value);
314		}
315
316		protected function parseAddress($value)
317		{
318		@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...
319		$name,
320		$extended,
321		$street,
322		$city,
323		$region,
324		$zip,
325		$country,
326		) = explode(';', $value);
327		return (object) array(
328		'name' => $name,
329		'extended' => $extended,
330		'street' => $street,
331		'city' => $city,
332		'region' => $region,
333		'zip' => $zip,
334		'country' => $country,
335		);
336		}
337
338		/**
339		* Unescape newline characters according to RFC2425 section 5.8.4.
340		* This function will replace escaped line breaks with PHP_EOL.
341		*
342		* @link http://tools.ietf.org/html/rfc2425#section-5.8.4
343		* @param string $text
344		* @return string
345		*/
346		protected function unescape($text)
347		{
348		return str_replace("\\n", PHP_EOL, $text);
349		}
350		}
351

jeroendesloovere / vcard

Push — master ( b352fa...197388 )

VCardParser::parse() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like