iCalendarFileExportPrinter::getIcalForItem() - Code Metrics - Inspection of "[ical] Add `DateParser`" - SemanticMediaWiki/SemanticResultFormats - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — ical-dateparser ( 5468af )

by mw

created 2019-08-24 03:15 UTC

iCalendarFileExportPrinter::getIcalForItem() F

↳ Parent: iCalendarFileExportPrinter

Complexity

Conditions	18
Paths	320

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	86
rs	2.5333
c	0
b	0
f	0
cc	18
nc	320
nop	1

How to fix Long Method Complexity

<?php

namespace SRF\iCalendar;

use SMW\Query\Result\ResultArray;
use SMWDataValueFactory as DataValueFactory;
use SMWExportPrinter as FileExportPrinter;
use SMWQuery as Query;
use SMWQueryProcessor as QueryProcessor;
use SMWQueryResult as QueryResult;
use SMWTimeValue as TimeValue;
use WikiPage;

/**
 * Printer class for iCalendar exports
 *
 * @see https://en.wikipedia.org/wiki/ICalendar
 * @see https://tools.ietf.org/html/rfc5545
 *
 * @license GNU GPL v2+
 * @since 1.5
 *
 * @author Markus Krötzsch
 * @author Denny Vrandecic
 * @author Jeroen De Dauw
 */
class iCalendarFileExportPrinter extends FileExportPrinter {

	/**
	 * @var string
	 */
	private $title;

	/**
	 * @var string
	 */
	private $description;

	/**
	 * @var IcalTimezoneFormatter
	 */
	private $icalTimezoneFormatter;

	/**
	 * @var DateParser
	 */
	private $dateParser;

	/**
	 * @see ResultPrinter::getName
	 *
	 * @since 1.8
	 *
	 * {@inheritDoc}
	 */
	public function getName() {
		return wfMessage( 'srf_printername_icalendar' )->text();
	}

	/**
	 * @see FileExportPrinter::getMimeType
	 *
	 * @since 1.8
	 *
	 * {@inheritDoc}
	 */
	public function getMimeType( QueryResult $queryResult ) {
		return 'text/calendar';
	}

	/**
	 * @see FileExportPrinter::getFileName
	 *
	 * @since 1.8
	 *
	 * {@inheritDoc}
	 */
	public function getFileName( QueryResult $queryResult ) {

		if ( $this->title != '' ) {
			return str_replace( ' ', '_', $this->title ) . '.ics';
		}

		return 'iCalendar.ics';
	}

	/**
	 * @see FileExportPrinter::getQueryMode
	 *
	 * @since 1.8
	 *
	 * {@inheritDoc}
	 */
	public function getQueryMode( $context ) {
		return ( $context == QueryProcessor::SPECIAL_PAGE ) ? Query::MODE_INSTANCES : Query::MODE_NONE;
	}

	/**
	 * @see ResultPrinter::getParamDefinitions
	 *
	 * @since 1.8
	 *
	 * {@inheritDoc}
	 */
	public function getParamDefinitions( array $definitions ) {
		$params = parent::getParamDefinitions( $definitions );

		$params['title'] = [
			'default' => '',
			'message' => 'srf_paramdesc_icalendartitle',
		];

		$params['description'] = [
			'default' => '',
			'message' => 'srf_paramdesc_icalendardescription',
		];

		$params['timezone'] = [
			'default' => '',
			'message' => 'srf-paramdesc-icalendar-timezone',
		];

		return $params;
	}

	/**
	 * @see ResultPrinter::handleParameters
	 *
	 * {@inheritDoc}
	 */
	protected function handleParameters( array $params, $outputMode ) {
		parent::handleParameters( $params, $outputMode );

		$this->title = trim( $params['title'] );
		$this->description = trim( $params['description'] );
	}

	/**
	 * @see ResultPrinter::getResultText
	 *
	 * {@inheritDoc}
	 */
	protected function getResultText( QueryResult $res, $outputMode ) {

		if ( $outputMode == SMW_OUTPUT_FILE ) {
			return $this->getIcal( $res );
		}

		return $this->getIcalLink( $res, $outputMode );
	}

	/**
	 * Returns the query result in iCal.
	 */
	private function getIcal( QueryResult $res ) {

		$this->dateParser = new DateParser();

		$this->icalTimezoneFormatter = new IcalTimezoneFormatter();

		$this->icalTimezoneFormatter->setLocalTimezones(
			isset( $this->params['timezone'] ) ? $this->params['timezone'] : []
		);

		$result = '';

		if ( $this->title == '' ) {
			$this->title = $GLOBALS['wgSitename'];
		}

		$result .= "BEGIN:VCALENDAR\r\n";
		$result .= "PRODID:-//SMW Project//Semantic Result Formats\r\n";
		$result .= "VERSION:2.0\r\n";
		$result .= "METHOD:PUBLISH\r\n";
		$result .= "X-WR-CALNAME:" . $this->title . "\r\n";

		if ( $this->description !== '' ) {
			$result .= "X-WR-CALDESC:" . $this->description . "\r\n";
		}

		$events = '';

		while ( $row = $res->getNext() ) {
			$events .= $this->getIcalForItem( $row );
		}

		$result .= $this->icalTimezoneFormatter->getTransitions();
		$result .= $events;
		$result .= "END:VCALENDAR\r\n";

		return $result;
	}

	/**
	 * Returns html for a link to a query that returns the iCal.
	 */
	private function getIcalLink( QueryResult $res, $outputMode ) {

		if ( $this->getSearchLabel( $outputMode ) ) {
			$label = $this->getSearchLabel( $outputMode );
		} else {
			$label = wfMessage( 'srf_icalendar_link' )->inContentLanguage()->text();
		}

		$link = $res->getQueryLink( $label );
		$link->setParameter( 'icalendar', 'format' );

		if ( $this->title !== '' ) {
			$link->setParameter( $this->title, 'title' );
		}

		if ( $this->description !== '' ) {
			$link->setParameter( $this->description, 'description' );
		}

		if ( array_key_exists( 'limit', $this->params ) ) {
			$link->setParameter( $this->params['limit'], 'limit' );
		} else { // use a reasonable default limit
			$link->setParameter( 20, 'limit' );
		}

		// yes, our code can be viewed as HTML if requested, no more parsing needed
		$this->isHTML = ( $outputMode == SMW_OUTPUT_HTML );

		return $link->getText( $outputMode, $this->mLinker );
	}

	/**
	 * Returns the iCal for a single item.
	 *
	 * @param ResultArray[] $row
	 *
	 * @return string
	 * @throws \MWException
	 */
	private function getIcalForItem( array $row ) {
		$result = '';

		$subjectDI = $row[0]->getResultSubject(); // get the object
		$subjectDV = DataValueFactory::getInstance()->newDataValueByItem( $subjectDI, null );

		$params = [
			'summary' => $subjectDV->getShortWikiText()
		];

		$from = null;
		$to = null;
		foreach ( $row as /* SMWResultArray */
				  $field ) {
			// later we may add more things like a generic
			// mechanism to add whatever you want :)
			// could include funny things like geo, description etc. though
			$req = $field->getPrintRequest();
			$label = strtolower( $req->getLabel() );

			switch ( $label ) {
				case 'start':
				case 'end':
					if ( $req->getTypeID() == '_dat' ) {
						$dataValue = $field->getNextDataValue();

						if ( $dataValue === false ) {
							unset( $params[$label] );
						} else {
							$params[$label] = $this->dateParser->parseDate( $dataValue, $label == 'end' );

							$timestamp = strtotime( $params[$label] );
							if ( $from === null || $timestamp < $from ) {
								$from = $timestamp;
							}
							if ( $to === null || $timestamp > $to ) {
								$to = $timestamp;
							}
						}
					}
					break;
				case 'location':
				case 'description':
				case 'summary':
					$value = $field->getNextDataValue();
					if ( $value !== false ) {
						$params[$label] = $value->getShortWikiText();
					}
					break;
			}
		}

		$this->icalTimezoneFormatter->calcTransitions( $from, $to );

		$title = $subjectDI->getTitle();
		$timestamp = WikiPage::factory( $title )->getTimestamp();
		$url = $title->getFullURL();

		$result .= "BEGIN:VEVENT\r\n";
		$result .= "SUMMARY:" . $this->escape( $params['summary'] ) . "\r\n";
		$result .= "URL:$url\r\n";
		$result .= "UID:$url\r\n";

		if ( array_key_exists( 'start', $params ) ) {
			$result .= "DTSTART:" . $params['start'] . "\r\n";
		}

		if ( array_key_exists( 'end', $params ) ) {
			$result .= "DTEND:" . $params['end'] . "\r\n";
		}

		if ( array_key_exists( 'location', $params ) ) {
			$result .= "LOCATION:" . $this->escape( $params['location'] ) . "\r\n";
		}

		if ( array_key_exists( 'description', $params ) ) {
			$result .= "DESCRIPTION:" . $this->escape( $params['description'] ) . "\r\n";
		}

		$t = strtotime( str_replace( 'T', ' ', $timestamp ) );
		$result .= "DTSTAMP:" . date( "Ymd", $t ) . "T" . date( "His", $t ) . "\r\n";
		$result .= "SEQUENCE:" . $title->getLatestRevID() . "\r\n";
		$result .= "END:VEVENT\r\n";

		return $result;
	}

	/**
	 * Implements esaping of special characters for iCalendar properties of type
	 * TEXT. This is defined in RFC2445 Section 4.3.11.
	 */
	private function escape( $text ) {
		// Note that \\ is a PHP escaped single \ here
		return str_replace( [ "\\", "\n", ";", "," ], [ "\\\\", "\\n", "\\;", "\\," ], $text );
	}

}


1			<?php
2
3			namespace SRF\iCalendar;
4
5			use SMW\Query\Result\ResultArray;
6			use SMWDataValueFactory as DataValueFactory;
7			use SMWExportPrinter as FileExportPrinter;
8			use SMWQuery as Query;
9			use SMWQueryProcessor as QueryProcessor;
10			use SMWQueryResult as QueryResult;
11			use SMWTimeValue as TimeValue;
12			use WikiPage;
13
14			/**
15			* Printer class for iCalendar exports
16			*
17			* @see https://en.wikipedia.org/wiki/ICalendar
18			* @see https://tools.ietf.org/html/rfc5545
19			*
20			* @license GNU GPL v2+
21			* @since 1.5
22			*
23			* @author Markus Krötzsch
24			* @author Denny Vrandecic
25			* @author Jeroen De Dauw
26			*/
27			class iCalendarFileExportPrinter extends FileExportPrinter {
28
29			/**
30			* @var string
31			*/
32			private $title;
33
34			/**
35			* @var string
36			*/
37			private $description;
38
39			/**
40			* @var IcalTimezoneFormatter
41			*/
42			private $icalTimezoneFormatter;
43
44			/**
45			* @var DateParser
46			*/
47			private $dateParser;
48
49			/**
50			* @see ResultPrinter::getName
51			*
52			* @since 1.8
53			*
54			* {@inheritDoc}
55			*/
56			public function getName() {
57			return wfMessage( 'srf_printername_icalendar' )->text();
58			}
59
60			/**
61			* @see FileExportPrinter::getMimeType
62			*
63			* @since 1.8
64			*
65			* {@inheritDoc}
66			*/
67			public function getMimeType( QueryResult $queryResult ) {
68			return 'text/calendar';
69			}
70
71			/**
72			* @see FileExportPrinter::getFileName
73			*
74			* @since 1.8
75			*
76			* {@inheritDoc}
77			*/
78			public function getFileName( QueryResult $queryResult ) {
79
80			if ( $this->title != '' ) {
81			return str_replace( ' ', '_', $this->title ) . '.ics';
82			}
83
84			return 'iCalendar.ics';
85			}
86
87			/**
88			* @see FileExportPrinter::getQueryMode
89			*
90			* @since 1.8
91			*
92			* {@inheritDoc}
93			*/
94			public function getQueryMode( $context ) {
95			return ( $context == QueryProcessor::SPECIAL_PAGE ) ? Query::MODE_INSTANCES : Query::MODE_NONE;
96			}
97
98			/**
99			* @see ResultPrinter::getParamDefinitions
100			*
101			* @since 1.8
102			*
103			* {@inheritDoc}
104			*/
105			public function getParamDefinitions( array $definitions ) {
106			$params = parent::getParamDefinitions( $definitions );
107
108			$params['title'] = [
109			'default' => '',
110			'message' => 'srf_paramdesc_icalendartitle',
111			];
112
113			$params['description'] = [
114			'default' => '',
115			'message' => 'srf_paramdesc_icalendardescription',
116			];
117
118			$params['timezone'] = [
119			'default' => '',
120			'message' => 'srf-paramdesc-icalendar-timezone',
121			];
122
123			return $params;
124			}
125
126			/**
127			* @see ResultPrinter::handleParameters
128			*
129			* {@inheritDoc}
130			*/
131			protected function handleParameters( array $params, $outputMode ) {
132			parent::handleParameters( $params, $outputMode );
133
134			$this->title = trim( $params['title'] );
135			$this->description = trim( $params['description'] );
136			}
137
138			/**
139			* @see ResultPrinter::getResultText
140			*
141			* {@inheritDoc}
142			*/
143			protected function getResultText( QueryResult $res, $outputMode ) {
144
145			if ( $outputMode == SMW_OUTPUT_FILE ) {
146			return $this->getIcal( $res );
147			}
148
149			return $this->getIcalLink( $res, $outputMode );
150			}
151
152			/**
153			* Returns the query result in iCal.
154			*/
155			private function getIcal( QueryResult $res ) {
156
157			$this->dateParser = new DateParser();
158
159			$this->icalTimezoneFormatter = new IcalTimezoneFormatter();
160
161			$this->icalTimezoneFormatter->setLocalTimezones(
162			isset( $this->params['timezone'] ) ? $this->params['timezone'] : []
163			);
164
165			$result = '';
166
167			if ( $this->title == '' ) {
168			$this->title = $GLOBALS['wgSitename'];
169			}
170
171			$result .= "BEGIN:VCALENDAR\r\n";
172			$result .= "PRODID:-//SMW Project//Semantic Result Formats\r\n";
173			$result .= "VERSION:2.0\r\n";
174			$result .= "METHOD:PUBLISH\r\n";
175			$result .= "X-WR-CALNAME:" . $this->title . "\r\n";
176
177			if ( $this->description !== '' ) {
178			$result .= "X-WR-CALDESC:" . $this->description . "\r\n";
179			}
180
181			$events = '';
182
183			while ( $row = $res->getNext() ) {
184			$events .= $this->getIcalForItem( $row );
185			}
186
187			$result .= $this->icalTimezoneFormatter->getTransitions();
188			$result .= $events;
189			$result .= "END:VCALENDAR\r\n";
190
191			return $result;
192			}
193
194			/**
195			* Returns html for a link to a query that returns the iCal.
196			*/
197			private function getIcalLink( QueryResult $res, $outputMode ) {
198
199			if ( $this->getSearchLabel( $outputMode ) ) {
200			$label = $this->getSearchLabel( $outputMode );
201			} else {
202			$label = wfMessage( 'srf_icalendar_link' )->inContentLanguage()->text();
203			}
204
205			$link = $res->getQueryLink( $label );
206			$link->setParameter( 'icalendar', 'format' );
207
208			if ( $this->title !== '' ) {
209			$link->setParameter( $this->title, 'title' );
210			}
211
212			if ( $this->description !== '' ) {
213			$link->setParameter( $this->description, 'description' );
214			}
215
216			if ( array_key_exists( 'limit', $this->params ) ) {
217			$link->setParameter( $this->params['limit'], 'limit' );
218			} else { // use a reasonable default limit
219			$link->setParameter( 20, 'limit' );
220			}
221
222			// yes, our code can be viewed as HTML if requested, no more parsing needed
223			$this->isHTML = ( $outputMode == SMW_OUTPUT_HTML );
224
225			return $link->getText( $outputMode, $this->mLinker );
226			}
227
228			/**
229			* Returns the iCal for a single item.
230			*
231			* @param ResultArray[] $row
232			*
233			* @return string
234			* @throws \MWException
235			*/
236			private function getIcalForItem( array $row ) {
237			$result = '';
238
239			$subjectDI = $row[0]->getResultSubject(); // get the object
240			$subjectDV = DataValueFactory::getInstance()->newDataValueByItem( $subjectDI, null );
241
242			$params = [
243			'summary' => $subjectDV->getShortWikiText()
244			];
245
246			$from = null;
247			$to = null;
248			foreach ( $row as /* SMWResultArray */
249			$field ) {
250			// later we may add more things like a generic
251			// mechanism to add whatever you want :)
252			// could include funny things like geo, description etc. though
253			$req = $field->getPrintRequest();
254			$label = strtolower( $req->getLabel() );
255
256			switch ( $label ) {
257			case 'start':
258			case 'end':
259			if ( $req->getTypeID() == '_dat' ) {
260			$dataValue = $field->getNextDataValue();
261
262			if ( $dataValue === false ) {
263			unset( $params[$label] );
264			} else {
265			$params[$label] = $this->dateParser->parseDate( $dataValue, $label == 'end' );
266
267			$timestamp = strtotime( $params[$label] );
268			if ( $from === null \|\| $timestamp < $from ) {
269			$from = $timestamp;
270			}
271			if ( $to === null \|\| $timestamp > $to ) {
272			$to = $timestamp;
273			}
274			}
275			}
276			break;
277			case 'location':
278			case 'description':
279			case 'summary':
280			$value = $field->getNextDataValue();
281			if ( $value !== false ) {
282			$params[$label] = $value->getShortWikiText();
283			}
284			break;
285			}
286			}
287
288			$this->icalTimezoneFormatter->calcTransitions( $from, $to );
289
290			$title = $subjectDI->getTitle();
291			$timestamp = WikiPage::factory( $title )->getTimestamp();
292			$url = $title->getFullURL();
293
294			$result .= "BEGIN:VEVENT\r\n";
295			$result .= "SUMMARY:" . $this->escape( $params['summary'] ) . "\r\n";
296			$result .= "URL:$url\r\n";
297			$result .= "UID:$url\r\n";
298
299			if ( array_key_exists( 'start', $params ) ) {
300			$result .= "DTSTART:" . $params['start'] . "\r\n";
301			}
302
303			if ( array_key_exists( 'end', $params ) ) {
304			$result .= "DTEND:" . $params['end'] . "\r\n";
305			}
306
307			if ( array_key_exists( 'location', $params ) ) {
308			$result .= "LOCATION:" . $this->escape( $params['location'] ) . "\r\n";
309			}
310
311			if ( array_key_exists( 'description', $params ) ) {
312			$result .= "DESCRIPTION:" . $this->escape( $params['description'] ) . "\r\n";
313			}
314
315			$t = strtotime( str_replace( 'T', ' ', $timestamp ) );
316			$result .= "DTSTAMP:" . date( "Ymd", $t ) . "T" . date( "His", $t ) . "\r\n";
317			$result .= "SEQUENCE:" . $title->getLatestRevID() . "\r\n";
318			$result .= "END:VEVENT\r\n";
319
320			return $result;
321			}
322
323			/**
324			* Implements esaping of special characters for iCalendar properties of type
325			* TEXT. This is defined in RFC2445 Section 4.3.11.
326			*/
327			private function escape( $text ) {
328			// Note that \\ is a PHP escaped single \ here
329			return str_replace( [ "\\", "\n", ";", "," ], [ "\\\\", "\\n", "\\;", "\\," ], $text );
330			}
331
332			}
333

SemanticMediaWiki / SemanticResultFormats

Push — ical-dateparser ( 5468af )

iCalendarFileExportPrinter::getIcalForItem() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like