ExifPropertyAnnotator::makeDataItemTime() - Code Metrics - Inspection of "Fix exeption by failed time string parsing" - SemanticMediaWiki/SemanticExtraSpecialProperties - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — issue-113 ( 044d76...1ae5f4 )

by Karsten

created 2019-03-25 15:01 UTC

ExifPropertyAnnotator::makeDataItemTime() A

↳ Parent: ExifPropertyAnnotator

Complexity

Conditions	3
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	3.0032

Importance

Changes

Metric	Value
dl	0
loc	19
ccs	13
cts	14
cp	0.9286
rs	9.6333
c	0
b	0
f	0
cc	3
nc	4
nop	1
crap	3.0032

<?php

namespace SESP\PropertyAnnotators;

use SESP\PropertyAnnotator;
use SESP\AppFactory;
use SMW\DIProperty;
use SMW\DIWikiPage;
use SMWContainerSemanticData as ContainerSemanticData;
use SMW\SemanticData;
use SMWDataItem as DataItem;
use SMWDIContainer as DIContainer;
use SMWDITime as DITime;
use SMWDINumber as DINumber;
use SMWDIBlob as DIBlob;
use FormatMetadata;
use RuntimeException;

/**
 * @private
 * @ingroup SESP
 *
 * @see http://www.exiv2.org/tags.html
 *
 * @license GNU GPL v2+
 * @since 2.0
 *
 * @author mwjames
 * @author rotsee
 * @author Stephan Gambke
 */
class ExifPropertyAnnotator implements PropertyAnnotator {

	/**
	 * Predefined property ID
	 */
	const PROP_ID = '___EXIFDATA';

	/**
	 * @var AppFactory
	 */
	private $appFactory;

	/**
	 * @since 2.0
	 *
	 * @param AppFactory $appFactory
	 */
	public function __construct( AppFactory $appFactory ) {
		$this->appFactory = $appFactory;
	}

	/**
	 * @since 2.0
	 *
	 * {@inheritDoc}
	 */
	public function isAnnotatorFor( DIProperty $property ) {
		return $property->getKey() === self::PROP_ID;
	}

	/**
	 * @since 2.0
	 *
	 * {@inheritDoc}
	 */
	public function addAnnotation( DIProperty $property, SemanticData $semanticData ) {

		$subject = $semanticData->getSubject();
		$title = $subject->getTitle();

		if ( !$title->inNamespace( NS_FILE ) ) {
			return;
		}

		$page = $this->appFactory->newWikiPage( $title );
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
		$file = $page->getFile();

		if ( !$file->exists() ) {
			return;
		}

		// #66
		$meta = $file->getMetadata();

		if ( !$meta ) {
			return false;
		}

		// Guard against "Error at offset 0 of 1 bytes"
		$exif = @unserialize( $meta );

		if ( !is_array( $exif ) || count( $exif ) === 0 ) {
			return;
		}

		$exif['ImageWidth']  = $file->getWidth();
		$exif['ImageLength'] = $file->getHeight();

		$dataItem = $this->getDataItemFromExifData( $subject, $exif );

		if ( $dataItem instanceof DataItem ) {
			$semanticData->addPropertyObjectValue( $property, $dataItem );
		}
	}

	protected function getDataItemFromExifData( $subject, $rawExif ) {

		$containerSemanticData = $this->newContainerSemanticData(
			$subject
		);

		$this->addExifDataTo( $containerSemanticData, $rawExif );

		if ( $containerSemanticData->isEmpty() ) {
			return;
		}

		return new DIContainer( $containerSemanticData );
	}

	private function newContainerSemanticData( $subject ) {

		$subject = new DIWikiPage(
			$subject->getDBkey(),
			$subject->getNamespace(),
			$subject->getInterwiki(),
			'_EXIFDATA'
		);

		return new ContainerSemanticData( $subject );
	}

	private function addExifDataTo( $containerSemanticData, $rawExif ) {

		$exifDefinitions = $this->appFactory->getPropertyDefinitions()->safeGet( '_EXIF' );
		$formattedExif = FormatMetadata::getFormattedData( $rawExif );

		foreach ( $formattedExif as $key => $value ) {

			$dataItem = $this->createDataItemFromExif( $id, $key, $value, $rawExif, $exifDefinitions );

			if ( $dataItem instanceof DataItem ) {
				$containerSemanticData->addPropertyObjectValue( new DIProperty( $id ), $dataItem );
			}
		}
	}

	private function createDataItemFromExif( &$id, $key, $value, $rawExif, $exifDefinitions ) {

		$dataItem = null;
		$upKey = strtoupper( $key );

		if ( !isset( $exifDefinitions[$upKey] ) || !isset( $exifDefinitions[$upKey]['id'] ) ) {
			return;
		}

		$id = $exifDefinitions[$upKey]['id'];
		$type = $exifDefinitions[$upKey]['type'];

		switch ( $type ) {
			case '_num':
				$dataItem = is_numeric( $rawExif[$key] ) ? new DINumber( $rawExif[$key] ) : null;
				break;
			case '_txt':
				$dataItem = new DIBlob( $value );
				break;
			case '_dat':
				$dataItem = $this->makeDataItemTime( $rawExif[$key] );
		}

		return $dataItem;
	}

	private function makeDataItemTime( $exifValue ) {

		try {
			$datetime = $this->convertExifDate( $exifValue );
		} catch ( \Exception $e ) {
			$datetime = null;
		}

		if ( $datetime ) {
			return new DITime(
				DITime::CM_GREGORIAN,
				$datetime->format('Y'),
				$datetime->format('n'),
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
				$datetime->format('j'),
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
				$datetime->format('G'),
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
				$datetime->format('i')
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
			);
		}
	}

	private function convertExifDate( $exifString ) {

		// Unknown date
		if ( $exifString == '0000:00:00 00:00:00' || $exifString == '    :  :     :  :  ' ) {
			return false;
		}

		// Full date
		if ( preg_match( '/^(?:\d{4}):(?:\d\d):(?:\d\d) (?:\d\d):(?:\d\d):(?:\d\d)$/D', $exifString ) ) {
			return new \DateTime( $exifString );
		}

		// No second field, timeanddate doesn't include seconds but second still available in api
		if ( preg_match( '/^(?:\d{4}):(?:\d\d):(?:\d\d) (?:\d\d):(?:\d\d)$/D', $exifString ) ) {
			return new \DateTime( $exifString . ':00' );
		}

		// Only the date but not the time
		if (  preg_match( '/^(?:\d{4}):(?:\d\d):(?:\d\d)$/D', $exifString ) ) {
			return new \DateTime(
				substr( $exifString, 0, 4 ) . ':' .
				substr( $exifString, 5, 2 ) . ':' .
				substr( $exifString, 8, 2 ) . ' 00:00:00'
			);
		}

		return false;
	}

}


1		<?php
2
3		namespace SESP\PropertyAnnotators;
4
5		use SESP\PropertyAnnotator;
6		use SESP\AppFactory;
7		use SMW\DIProperty;
8		use SMW\DIWikiPage;
9		use SMWContainerSemanticData as ContainerSemanticData;
10		use SMW\SemanticData;
11		use SMWDataItem as DataItem;
12		use SMWDIContainer as DIContainer;
13		use SMWDITime as DITime;
14		use SMWDINumber as DINumber;
15		use SMWDIBlob as DIBlob;
16		use FormatMetadata;
17		use RuntimeException;
18
19		/**
20		* @private
21		* @ingroup SESP
22		*
23		* @see http://www.exiv2.org/tags.html
24		*
25		* @license GNU GPL v2+
26		* @since 2.0
27		*
28		* @author mwjames
29		* @author rotsee
30		* @author Stephan Gambke
31		*/
32		class ExifPropertyAnnotator implements PropertyAnnotator {
33
34		/**
35		* Predefined property ID
36		*/
37		const PROP_ID = '___EXIFDATA';
38
39		/**
40		* @var AppFactory
41		*/
42		private $appFactory;
43
44		/**
45		* @since 2.0
46		*
47		* @param AppFactory $appFactory
48		*/
49	9	public function __construct( AppFactory $appFactory ) {
50	9	$this->appFactory = $appFactory;
51	9	}
52
53		/**
54		* @since 2.0
55		*
56		* {@inheritDoc}
57		*/
58	1	public function isAnnotatorFor( DIProperty $property ) {
59	1	return $property->getKey() === self::PROP_ID;
60		}
61
62		/**
63		* @since 2.0
64		*
65		* {@inheritDoc}
66		*/
67	7	public function addAnnotation( DIProperty $property, SemanticData $semanticData ) {
68
69	7	$subject = $semanticData->getSubject();
70	7	$title = $subject->getTitle();
71
72	7	if ( !$title->inNamespace( NS_FILE ) ) {
73		return;
74		}
75
76	7	$page = $this->appFactory->newWikiPage( $title );
		0 ignored issues – show Bug introduced 2017-06-03 14:08 UTC by Report Bug Copy Issue Report It seems like `$title` defined by `$subject->getTitle()` on line `70` can be `null`; however, `SESP\AppFactory::newWikiPage()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
77	7	$file = $page->getFile();
78
79	7	if ( !$file->exists() ) {
80	1	return;
81		}
82
83		// #66
84	6	$meta = $file->getMetadata();
85
86	6	if ( !$meta ) {
87		return false;
88		}
89
90		// Guard against "Error at offset 0 of 1 bytes"
91	6	$exif = @unserialize( $meta );
92
93	6	if ( !is_array( $exif ) \|\| count( $exif ) === 0 ) {
94		return;
95		}
96
97	6	$exif['ImageWidth'] = $file->getWidth();
98	6	$exif['ImageLength'] = $file->getHeight();
99
100	6	$dataItem = $this->getDataItemFromExifData( $subject, $exif );
101
102	6	if ( $dataItem instanceof DataItem ) {
103	4	$semanticData->addPropertyObjectValue( $property, $dataItem );
104	4	}
105	6	}
106
107	6	protected function getDataItemFromExifData( $subject, $rawExif ) {
108
109	6	$containerSemanticData = $this->newContainerSemanticData(
110		$subject
111	6	);
112
113	6	$this->addExifDataTo( $containerSemanticData, $rawExif );
114
115	6	if ( $containerSemanticData->isEmpty() ) {
116	2	return;
117		}
118
119	4	return new DIContainer( $containerSemanticData );
120		}
121
122	6	private function newContainerSemanticData( $subject ) {
123
124	6	$subject = new DIWikiPage(
125	6	$subject->getDBkey(),
126	6	$subject->getNamespace(),
127	6	$subject->getInterwiki(),
128		'_EXIFDATA'
129	6	);
130
131	6	return new ContainerSemanticData( $subject );
132		}
133
134	6	private function addExifDataTo( $containerSemanticData, $rawExif ) {
135
136	6	$exifDefinitions = $this->appFactory->getPropertyDefinitions()->safeGet( '_EXIF' );
137	6	$formattedExif = FormatMetadata::getFormattedData( $rawExif );
138
139	6	foreach ( $formattedExif as $key => $value ) {
140
141	6	$dataItem = $this->createDataItemFromExif( $id, $key, $value, $rawExif, $exifDefinitions );
142
143	6	if ( $dataItem instanceof DataItem ) {
144	4	$containerSemanticData->addPropertyObjectValue( new DIProperty( $id ), $dataItem );
145	4	}
146	6	}
147	6	}
148
149	6	private function createDataItemFromExif( &$id, $key, $value, $rawExif, $exifDefinitions ) {
150
151	6	$dataItem = null;
152	6	$upKey = strtoupper( $key );
153
154	6	if ( !isset( $exifDefinitions[$upKey] ) \|\| !isset( $exifDefinitions[$upKey]['id'] ) ) {
155	6	return;
156		}
157
158	5	$id = $exifDefinitions[$upKey]['id'];
159	5	$type = $exifDefinitions[$upKey]['type'];
160
161		switch ( $type ) {
162	5	case '_num':
163		$dataItem = is_numeric( $rawExif[$key] ) ? new DINumber( $rawExif[$key] ) : null;
164		break;
165	5	case '_txt':
166	1	$dataItem = new DIBlob( $value );
167	1	break;
168	4	case '_dat':
169	4	$dataItem = $this->makeDataItemTime( $rawExif[$key] );
170	4	}
171
172	5	return $dataItem;
173		}
174
175	4	private function makeDataItemTime( $exifValue ) {
176
177		try {
178	4	$datetime = $this->convertExifDate( $exifValue );
179	4	} catch ( \Exception $e ) {
180		$datetime = null;
181		}
182
183	4	if ( $datetime ) {
184	3	return new DITime(
185	3	DITime::CM_GREGORIAN,
186	3	$datetime->format('Y'),
187	3	$datetime->format('n'),
		0 ignored issues – show Documentation introduced 2015-12-04 20:50 UTC by Report Bug Copy Issue Report `$datetime->format('n')` is of type `string`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
188	3	$datetime->format('j'),
		0 ignored issues – show Documentation introduced 2015-12-04 20:50 UTC by Report Bug Copy Issue Report `$datetime->format('j')` is of type `string`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
189	3	$datetime->format('G'),
		0 ignored issues – show Documentation introduced 2015-12-04 20:50 UTC by Report Bug Copy Issue Report `$datetime->format('G')` is of type `string`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
190	3	$datetime->format('i')
		0 ignored issues – show Documentation introduced 2015-12-04 20:50 UTC by Report Bug Copy Issue Report `$datetime->format('i')` is of type `string`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
191	3	);
192		}
193	1	}
194
195	4	private function convertExifDate( $exifString ) {
196
197		// Unknown date
198	4	if ( $exifString == '0000:00:00 00:00:00' \|\| $exifString == ' : : : : ' ) {
199	1	return false;
200		}
201
202		// Full date
203	3	if ( preg_match( '/^(?:\d{4}):(?:\d\d):(?:\d\d) (?:\d\d):(?:\d\d):(?:\d\d)$/D', $exifString ) ) {
204	1	return new \DateTime( $exifString );
205		}
206
207		// No second field, timeanddate doesn't include seconds but second still available in api
208	2	if ( preg_match( '/^(?:\d{4}):(?:\d\d):(?:\d\d) (?:\d\d):(?:\d\d)$/D', $exifString ) ) {
209	1	return new \DateTime( $exifString . ':00' );
210		}
211
212		// Only the date but not the time
213	1	if ( preg_match( '/^(?:\d{4}):(?:\d\d):(?:\d\d)$/D', $exifString ) ) {
214	1	return new \DateTime(
215	1	substr( $exifString, 0, 4 ) . ':' .
216	1	substr( $exifString, 5, 2 ) . ':' .
217	1	substr( $exifString, 8, 2 ) . ' 00:00:00'
218	1	);
219		}
220
221		return false;
222		}
223
224		}
225

SemanticMediaWiki / SemanticExtraSpecialProperties

Push — issue-113 ( 044d76...1ae5f4 )

ExifPropertyAnnotator::makeDataItemTime() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like