Issues (1061)

Sources/Subs-Calendar.php (29 issues)

1
<?php
2
3
/**
4
 * This file contains several functions for retrieving and manipulating calendar events, birthdays and holidays.
5
 *
6
 * Simple Machines Forum (SMF)
7
 *
8
 * @package SMF
9
 * @author Simple Machines https://www.simplemachines.org
10
 * @copyright 2020 Simple Machines and individual contributors
11
 * @license https://www.simplemachines.org/about/smf/license.php BSD
12
 *
13
 * @version 2.1 RC2
14
 */
15
16
if (!defined('SMF'))
17
	die('No direct access...');
18
19
/**
20
 * Get all birthdays within the given time range.
21
 * finds all the birthdays in the specified range of days.
22
 * works with birthdays set for no year, or any other year, and respects month and year boundaries.
23
 *
24
 * @param string $low_date The low end of the range, inclusive, in YYYY-MM-DD format
25
 * @param string $high_date The high end of the range, inclusive, in YYYY-MM-DD format
26
 * @return array An array of days, each of which is an array of birthday information for the context
27
 */
28
function getBirthdayRange($low_date, $high_date)
29
{
30
	global $smcFunc;
31
32
	// We need to search for any birthday in this range, and whatever year that birthday is on.
33
	$year_low = (int) substr($low_date, 0, 4);
34
	$year_high = (int) substr($high_date, 0, 4);
35
36
	if ($smcFunc['db_title'] !== POSTGRE_TITLE)
37
	{
38
		// Collect all of the birthdays for this month.  I know, it's a painful query.
39
		$result = $smcFunc['db_query']('birthday_array', '
40
			SELECT id_member, real_name, YEAR(birthdate) AS birth_year, birthdate
41
			FROM {db_prefix}members
42
			WHERE YEAR(birthdate) != {string:year_one}
43
				AND MONTH(birthdate) != {int:no_month}
44
				AND DAYOFMONTH(birthdate) != {int:no_day}
45
				AND YEAR(birthdate) <= {int:max_year}
46
				AND (
47
					DATE_FORMAT(birthdate, {string:year_low}) BETWEEN {date:low_date} AND {date:high_date}' . ($year_low == $year_high ? '' : '
48
					OR DATE_FORMAT(birthdate, {string:year_high}) BETWEEN {date:low_date} AND {date:high_date}') . '
49
				)
50
				AND is_activated = {int:is_activated}',
51
			array(
52
				'is_activated' => 1,
53
				'no_month' => 0,
54
				'no_day' => 0,
55
				'year_one' => '1004',
56
				'year_low' => $year_low . '-%m-%d',
57
				'year_high' => $year_high . '-%m-%d',
58
				'low_date' => $low_date,
59
				'high_date' => $high_date,
60
				'max_year' => $year_high,
61
			)
62
		);
63
	}
64
	else
65
	{
66
		$result = $smcFunc['db_query']('birthday_array', '
67
			SELECT id_member, real_name, YEAR(birthdate) AS birth_year, birthdate
68
			FROM {db_prefix}members
69
			WHERE YEAR(birthdate) != {string:year_one}
70
				AND MONTH(birthdate) != {int:no_month}
71
				AND DAYOFMONTH(birthdate) != {int:no_day}
72
				AND (
73
					indexable_month_day(birthdate) BETWEEN indexable_month_day({date:year_low_low_date}) AND indexable_month_day({date:year_low_high_date})' . ($year_low == $year_high ? '' : '
74
					OR  indexable_month_day(birthdate) BETWEEN indexable_month_day({date:year_high_low_date}) AND indexable_month_day({date:year_high_high_date})') . '
75
				)
76
				AND is_activated = {int:is_activated}',
77
			array(
78
				'is_activated' => 1,
79
				'no_month' => 0,
80
				'no_day' => 0,
81
				'year_one' => '1004',
82
				'year_low' => $year_low . '-%m-%d',
83
				'year_high' => $year_high . '-%m-%d',
84
				'year_low_low_date' => $low_date,
85
				'year_low_high_date' => ($year_low == $year_high ? $high_date : $year_low . '-12-31'),
86
				'year_high_low_date' => ($year_low == $year_high ? $low_date : $year_high . '-01-01'),
87
				'year_high_high_date' => $high_date,
88
			)
89
		);
90
	}
91
	$bday = array();
92
	while ($row = $smcFunc['db_fetch_assoc']($result))
93
	{
94
		if ($year_low != $year_high)
95
			$age_year = substr($row['birthdate'], 5) < substr($high_date, 5) ? $year_high : $year_low;
96
		else
97
			$age_year = $year_low;
98
99
		$bday[$age_year . substr($row['birthdate'], 4)][] = array(
100
			'id' => $row['id_member'],
101
			'name' => $row['real_name'],
102
			'age' => $row['birth_year'] > 1004 && $row['birth_year'] <= $age_year ? $age_year - $row['birth_year'] : null,
103
			'is_last' => false
104
		);
105
	}
106
	$smcFunc['db_free_result']($result);
107
108
	ksort($bday);
109
110
	// Set is_last, so the themes know when to stop placing separators.
111
	foreach ($bday as $mday => $array)
112
		$bday[$mday][count($array) - 1]['is_last'] = true;
113
114
	return $bday;
115
}
116
117
/**
118
 * Get all calendar events within the given time range.
119
 *
120
 * - finds all the posted calendar events within a date range.
121
 * - both the earliest_date and latest_date should be in the standard YYYY-MM-DD format.
122
 * - censors the posted event titles.
123
 * - uses the current user's permissions if use_permissions is true, otherwise it does nothing "permission specific"
124
 *
125
 * @param string $low_date The low end of the range, inclusive, in YYYY-MM-DD format
126
 * @param string $high_date The high end of the range, inclusive, in YYYY-MM-DD format
127
 * @param bool $use_permissions Whether to use permissions
128
 * @return array Contextual information if use_permissions is true, and an array of the data needed to build that otherwise
129
 */
130
function getEventRange($low_date, $high_date, $use_permissions = true)
131
{
132
	global $scripturl, $modSettings, $user_info, $smcFunc, $context, $sourcedir;
133
	static $timezone_array = array();
134
	require_once($sourcedir . '/Subs.php');
135
136
	if (empty($timezone_array['default']))
137
		$timezone_array['default'] = timezone_open(date_default_timezone_get());
138
139
	$low_object = date_create($low_date);
140
	$high_object = date_create($high_date);
141
142
	// Find all the calendar info...
143
	$result = $smcFunc['db_query']('calendar_get_events', '
144
		SELECT
145
			cal.id_event, cal.title, cal.id_member, cal.id_topic, cal.id_board,
146
			cal.start_date, cal.end_date, cal.start_time, cal.end_time, cal.timezone, cal.location,
147
			b.member_groups, t.id_first_msg, t.approved, b.id_board
148
		FROM {db_prefix}calendar AS cal
149
			LEFT JOIN {db_prefix}boards AS b ON (b.id_board = cal.id_board)
150
			LEFT JOIN {db_prefix}topics AS t ON (t.id_topic = cal.id_topic)
151
		WHERE cal.start_date <= {date:high_date}
152
			AND cal.end_date >= {date:low_date}' . ($use_permissions ? '
153
			AND (cal.id_board = {int:no_board_link} OR {query_wanna_see_board})' : ''),
154
		array(
155
			'high_date' => $high_date,
156
			'low_date' => $low_date,
157
			'no_board_link' => 0,
158
		)
159
	);
160
	$events = array();
161
	while ($row = $smcFunc['db_fetch_assoc']($result))
162
	{
163
		// If the attached topic is not approved then for the moment pretend it doesn't exist
164
		if (!empty($row['id_first_msg']) && $modSettings['postmod_active'] && !$row['approved'])
165
			continue;
166
167
		// Force a censor of the title - as often these are used by others.
168
		censorText($row['title'], $use_permissions ? false : true);
169
170
		// Get the various time and date properties for this event
171
		list($start, $end, $allday, $span, $tz, $tz_abbrev) = buildEventDatetimes($row);
172
173
		if (empty($timezone_array[$tz]))
174
			$timezone_array[$tz] = timezone_open($tz);
175
176
		// Sanity check
177
		if (!empty($start['error_count']) || !empty($start['warning_count']) || !empty($end['error_count']) || !empty($end['warning_count']))
178
			continue;
179
180
		// Get set up for the loop
181
		$start_object = date_create($row['start_date'] . (!$allday ? ' ' . $row['start_time'] : ''), $timezone_array[$tz]);
182
		$end_object = date_create($row['end_date'] . (!$allday ? ' ' . $row['end_time'] : ''), $timezone_array[$tz]);
183
		date_timezone_set($start_object, $timezone_array['default']);
0 ignored issues
show
It seems like $start_object can also be of type false; however, parameter $object of date_timezone_set() does only seem to accept DateTime, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

183
		date_timezone_set(/** @scrutinizer ignore-type */ $start_object, $timezone_array['default']);
Loading history...
184
		date_timezone_set($end_object, $timezone_array['default']);
185
		date_time_set($start_object, 0, 0, 0);
0 ignored issues
show
$start_object of type DateTime|false is incompatible with the type integer expected by parameter $object of date_time_set(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

185
		date_time_set(/** @scrutinizer ignore-type */ $start_object, 0, 0, 0);
Loading history...
186
		date_time_set($end_object, 0, 0, 0);
187
		$start_date_string = date_format($start_object, 'Y-m-d');
188
		$end_date_string = date_format($end_object, 'Y-m-d');
189
190
		$cal_date = ($start_object >= $low_object) ? $start_object : $low_object;
191
		while ($cal_date <= $end_object && $cal_date <= $high_object)
192
		{
193
			$starts_today = (date_format($cal_date, 'Y-m-d') == $start_date_string);
194
			$ends_today = (date_format($cal_date, 'Y-m-d') == $end_date_string);
195
196
			$eventProperties = array(
197
				'id' => $row['id_event'],
198
				'title' => $row['title'],
199
				'year' => $start['year'],
200
				'month' => $start['month'],
201
				'day' => $start['day'],
202
				'hour' => !$allday ? $start['hour'] : null,
203
				'minute' => !$allday ? $start['minute'] : null,
204
				'second' => !$allday ? $start['second'] : null,
205
				'start_date' => $row['start_date'],
206
				'start_date_local' => $start['date_local'],
207
				'start_date_orig' => $start['date_orig'],
208
				'start_time' => !$allday ? $row['start_time'] : null,
209
				'start_time_local' => !$allday ? $start['time_local'] : null,
210
				'start_time_orig' => !$allday ? $start['time_orig'] : null,
211
				'start_timestamp' => $start['timestamp'],
212
				'start_datetime' => $start['datetime'],
213
				'start_iso_gmdate' => $start['iso_gmdate'],
214
				'end_year' => $end['year'],
215
				'end_month' => $end['month'],
216
				'end_day' => $end['day'],
217
				'end_hour' => !$allday ? $end['hour'] : null,
218
				'end_minute' => !$allday ? $end['minute'] : null,
219
				'end_second' => !$allday ? $end['second'] : null,
220
				'end_date' => $row['end_date'],
221
				'end_date_local' => $end['date_local'],
222
				'end_date_orig' => $end['date_orig'],
223
				'end_time' => !$allday ? $row['end_time'] : null,
224
				'end_time_local' => !$allday ? $end['time_local'] : null,
225
				'end_time_orig' => !$allday ? $end['time_orig'] : null,
226
				'end_timestamp' => $end['timestamp'],
227
				'end_datetime' => $end['datetime'],
228
				'end_iso_gmdate' => $end['iso_gmdate'],
229
				'allday' => $allday,
230
				'tz' => !$allday ? $tz : null,
231
				'tz_abbrev' => !$allday ? $tz_abbrev : null,
232
				'span' => $span,
233
				'is_last' => false,
234
				'id_board' => $row['id_board'],
235
				'is_selected' => !empty($context['selected_event']) && $context['selected_event'] == $row['id_event'],
236
				'starts_today' => $starts_today,
237
				'ends_today' => $ends_today,
238
				'location' => $row['location'],
239
			);
240
241
			// If we're using permissions (calendar pages?) then just ouput normal contextual style information.
242
			if ($use_permissions)
243
				$events[date_format($cal_date, 'Y-m-d')][] = array_merge($eventProperties, array(
244
					'href' => $row['id_board'] == 0 ? '' : $scripturl . '?topic=' . $row['id_topic'] . '.0',
245
					'link' => $row['id_board'] == 0 ? $row['title'] : '<a href="' . $scripturl . '?topic=' . $row['id_topic'] . '.0">' . $row['title'] . '</a>',
246
					'can_edit' => allowedTo('calendar_edit_any') || ($row['id_member'] == $user_info['id'] && allowedTo('calendar_edit_own')),
247
					'modify_href' => $scripturl . '?action=' . ($row['id_board'] == 0 ? 'calendar;sa=post;' : 'post;msg=' . $row['id_first_msg'] . ';topic=' . $row['id_topic'] . '.0;calendar;') . 'eventid=' . $row['id_event'] . ';' . $context['session_var'] . '=' . $context['session_id'],
248
					'can_export' => !empty($modSettings['cal_export']) ? true : false,
249
					'export_href' => $scripturl . '?action=calendar;sa=ical;eventid=' . $row['id_event'] . ';' . $context['session_var'] . '=' . $context['session_id'],
250
				));
251
			// Otherwise, this is going to be cached and the VIEWER'S permissions should apply... just put together some info.
252
			else
253
				$events[date_format($cal_date, 'Y-m-d')][] = array_merge($eventProperties, array(
254
					'href' => $row['id_topic'] == 0 ? '' : $scripturl . '?topic=' . $row['id_topic'] . '.0',
255
					'link' => $row['id_topic'] == 0 ? $row['title'] : '<a href="' . $scripturl . '?topic=' . $row['id_topic'] . '.0">' . $row['title'] . '</a>',
256
					'can_edit' => false,
257
					'can_export' => !empty($modSettings['cal_export']) ? true : false,
258
					'topic' => $row['id_topic'],
259
					'msg' => $row['id_first_msg'],
260
					'poster' => $row['id_member'],
261
					'allowed_groups' => explode(',', $row['member_groups']),
262
				));
263
264
			date_add($cal_date, date_interval_create_from_date_string('1 day'));
0 ignored issues
show
It seems like $cal_date can also be of type false; however, parameter $object of date_add() does only seem to accept DateTime, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

264
			date_add(/** @scrutinizer ignore-type */ $cal_date, date_interval_create_from_date_string('1 day'));
Loading history...
265
		}
266
	}
267
	$smcFunc['db_free_result']($result);
268
269
	// If we're doing normal contextual data, go through and make things clear to the templates ;).
270
	if ($use_permissions)
271
	{
272
		foreach ($events as $mday => $array)
273
			$events[$mday][count($array) - 1]['is_last'] = true;
274
	}
275
276
	ksort($events);
277
278
	return $events;
279
}
280
281
/**
282
 * Get all holidays within the given time range.
283
 *
284
 * @param string $low_date The low end of the range, inclusive, in YYYY-MM-DD format
285
 * @param string $high_date The high end of the range, inclusive, in YYYY-MM-DD format
286
 * @return array An array of days, which are all arrays of holiday names.
287
 */
288
function getHolidayRange($low_date, $high_date)
289
{
290
	global $smcFunc;
291
292
	// Get the lowest and highest dates for "all years".
293
	if (substr($low_date, 0, 4) != substr($high_date, 0, 4))
294
		$allyear_part = 'event_date BETWEEN {date:all_year_low} AND {date:all_year_dec}
295
			OR event_date BETWEEN {date:all_year_jan} AND {date:all_year_high}';
296
	else
297
		$allyear_part = 'event_date BETWEEN {date:all_year_low} AND {date:all_year_high}';
298
299
	// Find some holidays... ;).
300
	$result = $smcFunc['db_query']('', '
301
		SELECT event_date, YEAR(event_date) AS year, title
302
		FROM {db_prefix}calendar_holidays
303
		WHERE event_date BETWEEN {date:low_date} AND {date:high_date}
304
			OR ' . $allyear_part,
305
		array(
306
			'low_date' => $low_date,
307
			'high_date' => $high_date,
308
			'all_year_low' => '1004' . substr($low_date, 4),
309
			'all_year_high' => '1004' . substr($high_date, 4),
310
			'all_year_jan' => '1004-01-01',
311
			'all_year_dec' => '1004-12-31',
312
		)
313
	);
314
	$holidays = array();
315
	while ($row = $smcFunc['db_fetch_assoc']($result))
316
	{
317
		if (substr($low_date, 0, 4) != substr($high_date, 0, 4))
318
			$event_year = substr($row['event_date'], 5) < substr($high_date, 5) ? substr($high_date, 0, 4) : substr($low_date, 0, 4);
319
		else
320
			$event_year = substr($low_date, 0, 4);
321
322
		$holidays[$event_year . substr($row['event_date'], 4)][] = $row['title'];
323
	}
324
	$smcFunc['db_free_result']($result);
325
326
	ksort($holidays);
327
328
	return $holidays;
329
}
330
331
/**
332
 * Does permission checks to see if an event can be linked to a board/topic.
333
 * checks if the current user can link the current topic to the calendar, permissions et al.
334
 * this requires the calendar_post permission, a forum moderator, or a topic starter.
335
 * expects the $topic and $board variables to be set.
336
 * if the user doesn't have proper permissions, an error will be shown.
337
 */
338
function canLinkEvent()
339
{
340
	global $user_info, $topic, $board, $smcFunc;
341
342
	// If you can't post, you can't link.
343
	isAllowedTo('calendar_post');
344
345
	// No board?  No topic?!?
346
	if (empty($board))
347
		fatal_lang_error('missing_board_id', false);
348
	if (empty($topic))
349
		fatal_lang_error('missing_topic_id', false);
350
351
	// Administrator, Moderator, or owner.  Period.
352
	if (!allowedTo('admin_forum') && !allowedTo('moderate_board'))
353
	{
354
		// Not admin or a moderator of this board. You better be the owner - or else.
355
		$result = $smcFunc['db_query']('', '
356
			SELECT id_member_started
357
			FROM {db_prefix}topics
358
			WHERE id_topic = {int:current_topic}
359
			LIMIT 1',
360
			array(
361
				'current_topic' => $topic,
362
			)
363
		);
364
		if ($row = $smcFunc['db_fetch_assoc']($result))
365
		{
366
			// Not the owner of the topic.
367
			if ($row['id_member_started'] != $user_info['id'])
368
				fatal_lang_error('not_your_topic', 'user');
369
		}
370
		// Topic/Board doesn't exist.....
371
		else
372
			fatal_lang_error('calendar_no_topic', 'general');
373
		$smcFunc['db_free_result']($result);
374
	}
375
}
376
377
/**
378
 * Returns date information about 'today' relative to the users time offset.
379
 * returns an array with the current date, day, month, and year.
380
 * takes the users time offset into account.
381
 *
382
 * @return array An array of info about today, based on forum time. Has 'day', 'month', 'year' and 'date' (in YYYY-MM-DD format)
383
 */
384
function getTodayInfo()
385
{
386
	return array(
387
		'day' => (int) strftime('%d', forum_time()),
388
		'month' => (int) strftime('%m', forum_time()),
389
		'year' => (int) strftime('%Y', forum_time()),
390
		'date' => strftime('%Y-%m-%d', forum_time()),
391
	);
392
}
393
394
/**
395
 * Provides information (link, month, year) about the previous and next month.
396
 *
397
 * @param string $selected_date A date in YYYY-MM-DD format
398
 * @param array $calendarOptions An array of calendar options
399
 * @param bool $is_previous Whether this is the previous month
400
 * @return array A large array containing all the information needed to show a calendar grid for the given month
401
 */
402
function getCalendarGrid($selected_date, $calendarOptions, $is_previous = false)
403
{
404
	global $scripturl, $modSettings;
405
406
	$selected_object = date_create($selected_date);
407
408
	$next_object = date_create($selected_date);
409
	date_add($next_object, date_interval_create_from_date_string('1 month'));
0 ignored issues
show
It seems like $next_object can also be of type false; however, parameter $object of date_add() does only seem to accept DateTime, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

409
	date_add(/** @scrutinizer ignore-type */ $next_object, date_interval_create_from_date_string('1 month'));
Loading history...
410
411
	$prev_object = date_create($selected_date);
412
	date_sub($prev_object, date_interval_create_from_date_string('1 month'));
0 ignored issues
show
It seems like $prev_object can also be of type false; however, parameter $object of date_sub() does only seem to accept DateTime, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

412
	date_sub(/** @scrutinizer ignore-type */ $prev_object, date_interval_create_from_date_string('1 month'));
Loading history...
413
414
	// Eventually this is what we'll be returning.
415
	$calendarGrid = array(
416
		'week_days' => array(),
417
		'weeks' => array(),
418
		'short_day_titles' => !empty($calendarOptions['short_day_titles']),
419
		'short_month_titles' => !empty($calendarOptions['short_month_titles']),
420
		'current_month' => date_format($selected_object, 'n'),
421
		'current_year' => date_format($selected_object, 'Y'),
422
		'current_day' => date_format($selected_object, 'd'),
423
		'show_next_prev' => !empty($calendarOptions['show_next_prev']),
424
		'show_week_links' => isset($calendarOptions['show_week_links']) ? $calendarOptions['show_week_links'] : 0,
425
		'previous_calendar' => array(
426
			'year' => date_format($prev_object, 'Y'),
427
			'month' => date_format($prev_object, 'n'),
428
			'day' => date_format($prev_object, 'd'),
429
			'start_date' => date_format($prev_object, 'Y-m-d'),
430
			'disabled' => $modSettings['cal_minyear'] > date_format($prev_object, 'Y'),
431
		),
432
		'next_calendar' => array(
433
			'year' => date_format($next_object, 'Y'),
434
			'month' => date_format($next_object, 'n'),
435
			'day' => date_format($next_object, 'd'),
436
			'start_date' => date_format($next_object, 'Y-m-d'),
437
			'disabled' => $modSettings['cal_maxyear'] < date_format($next_object, 'Y'),
438
		),
439
		'start_date' => timeformat(date_format($selected_object, 'U'), get_date_or_time_format('date')),
0 ignored issues
show
date_format($selected_object, 'U') of type string is incompatible with the type integer expected by parameter $log_time of timeformat(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

439
		'start_date' => timeformat(/** @scrutinizer ignore-type */ date_format($selected_object, 'U'), get_date_or_time_format('date')),
Loading history...
get_date_or_time_format('date') of type string is incompatible with the type boolean expected by parameter $show_today of timeformat(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

439
		'start_date' => timeformat(date_format($selected_object, 'U'), /** @scrutinizer ignore-type */ get_date_or_time_format('date')),
Loading history...
440
	);
441
442
	// Get today's date.
443
	$today = getTodayInfo();
444
445
	$first_day_object = date_create(date_format($selected_object, 'Y-m-01'));
446
	$last_day_object = date_create(date_format($selected_object, 'Y-m-t'));
447
448
	// Get information about this month.
449
	$month_info = array(
450
		'first_day' => array(
451
			'day_of_week' => date_format($first_day_object, 'w'),
452
			'week_num' => date_format($first_day_object, 'W'),
453
			'date' => date_format($first_day_object, 'Y-m-d'),
454
		),
455
		'last_day' => array(
456
			'day_of_month' => date_format($last_day_object, 't'),
457
			'date' => date_format($last_day_object, 'Y-m-d'),
458
		),
459
		'first_day_of_year' => date_format(date_create(date_format($selected_object, 'Y-01-01')), 'w'),
460
		'first_day_of_next_year' => date_format(date_create((date_format($selected_object, 'Y') + 1) . '-01-01'), 'w'),
461
	);
462
463
	// The number of days the first row is shifted to the right for the starting day.
464
	$nShift = $month_info['first_day']['day_of_week'];
465
466
	$calendarOptions['start_day'] = empty($calendarOptions['start_day']) ? 0 : (int) $calendarOptions['start_day'];
467
468
	// Starting any day other than Sunday means a shift...
469
	if (!empty($calendarOptions['start_day']))
470
	{
471
		$nShift -= $calendarOptions['start_day'];
472
		if ($nShift < 0)
473
			$nShift = 7 + $nShift;
474
	}
475
476
	// Number of rows required to fit the month.
477
	$nRows = floor(($month_info['last_day']['day_of_month'] + $nShift) / 7);
478
	if (($month_info['last_day']['day_of_month'] + $nShift) % 7)
479
		$nRows++;
480
481
	// Fetch the arrays for birthdays, posted events, and holidays.
482
	$bday = $calendarOptions['show_birthdays'] ? getBirthdayRange($month_info['first_day']['date'], $month_info['last_day']['date']) : array();
483
	$events = $calendarOptions['show_events'] ? getEventRange($month_info['first_day']['date'], $month_info['last_day']['date']) : array();
484
	$holidays = $calendarOptions['show_holidays'] ? getHolidayRange($month_info['first_day']['date'], $month_info['last_day']['date']) : array();
485
486
	// Days of the week taking into consideration that they may want it to start on any day.
487
	$count = $calendarOptions['start_day'];
488
	for ($i = 0; $i < 7; $i++)
489
	{
490
		$calendarGrid['week_days'][] = $count;
491
		$count++;
492
		if ($count == 7)
493
			$count = 0;
494
	}
495
496
	// Iterate through each week.
497
	$calendarGrid['weeks'] = array();
498
	for ($nRow = 0; $nRow < $nRows; $nRow++)
499
	{
500
		// Start off the week - and don't let it go above 52, since that's the number of weeks in a year.
501
		$calendarGrid['weeks'][$nRow] = array(
502
			'days' => array(),
503
		);
504
505
		// And figure out all the days.
506
		for ($nCol = 0; $nCol < 7; $nCol++)
507
		{
508
			$nDay = ($nRow * 7) + $nCol - $nShift + 1;
509
510
			if ($nDay < 1 || $nDay > $month_info['last_day']['day_of_month'])
511
				$nDay = 0;
512
513
			$date = date_format($selected_object, 'Y-m-') . sprintf('%02d', $nDay);
514
515
			$calendarGrid['weeks'][$nRow]['days'][$nCol] = array(
516
				'day' => $nDay,
517
				'date' => $date,
518
				'is_today' => $date == $today['date'],
519
				'is_first_day' => !empty($calendarOptions['show_week_num']) && (($month_info['first_day']['day_of_week'] + $nDay - 1) % 7 == $calendarOptions['start_day']),
520
				'is_first_of_month' => $nDay === 1,
521
				'holidays' => !empty($holidays[$date]) ? $holidays[$date] : array(),
522
				'events' => !empty($events[$date]) ? $events[$date] : array(),
523
				'birthdays' => !empty($bday[$date]) ? $bday[$date] : array(),
524
			);
525
		}
526
	}
527
528
	// What is the last day of the month?
529
	if ($is_previous === true)
530
		$calendarGrid['last_of_month'] = $month_info['last_day']['day_of_month'];
531
532
	// We'll use the shift in the template.
533
	$calendarGrid['shift'] = $nShift;
534
535
	// Set the previous and the next month's links.
536
	$calendarGrid['previous_calendar']['href'] = $scripturl . '?action=calendar;viewmonth;year=' . $calendarGrid['previous_calendar']['year'] . ';month=' . $calendarGrid['previous_calendar']['month'] . ';day=' . $calendarGrid['previous_calendar']['day'];
537
	$calendarGrid['next_calendar']['href'] = $scripturl . '?action=calendar;viewmonth;year=' . $calendarGrid['next_calendar']['year'] . ';month=' . $calendarGrid['next_calendar']['month'] . ';day=' . $calendarGrid['previous_calendar']['day'];
538
539
	loadDatePicker('#calendar_navigation .date_input');
540
	loadDatePair('#calendar_navigation', 'date_input');
541
542
	return $calendarGrid;
543
}
544
545
/**
546
 * Returns the information needed to show a calendar for the given week.
547
 *
548
 * @param string $selected_date A date in YYYY-MM-DD format
549
 * @param array $calendarOptions An array of calendar options
550
 * @return array An array of information needed to display the grid for a single week on the calendar
551
 */
552
function getCalendarWeek($selected_date, $calendarOptions)
553
{
554
	global $scripturl, $modSettings, $txt;
555
556
	$selected_object = date_create($selected_date);
557
558
	// Get today's date.
559
	$today = getTodayInfo();
560
561
	// What is the actual "start date" for the passed day.
562
	$calendarOptions['start_day'] = empty($calendarOptions['start_day']) ? 0 : (int) $calendarOptions['start_day'];
563
	$day_of_week = date_format($selected_object, 'w');
564
	$first_day_object = date_create($selected_date);
565
	if ($day_of_week != $calendarOptions['start_day'])
566
	{
567
		// Here we offset accordingly to get things to the real start of a week.
568
		$date_diff = $day_of_week - $calendarOptions['start_day'];
569
		if ($date_diff < 0)
570
			$date_diff += 7;
571
572
		date_sub($first_day_object, date_interval_create_from_date_string($date_diff . ' days'));
0 ignored issues
show
It seems like $first_day_object can also be of type false; however, parameter $object of date_sub() does only seem to accept DateTime, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

572
		date_sub(/** @scrutinizer ignore-type */ $first_day_object, date_interval_create_from_date_string($date_diff . ' days'));
Loading history...
573
	}
574
575
	$last_day_object = date_create(date_format($first_day_object, 'Y-m-d'));
576
	date_add($last_day_object, date_interval_create_from_date_string('1 week'));
0 ignored issues
show
It seems like $last_day_object can also be of type false; however, parameter $object of date_add() does only seem to accept DateTime, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

576
	date_add(/** @scrutinizer ignore-type */ $last_day_object, date_interval_create_from_date_string('1 week'));
Loading history...
577
578
	$month = date_format($first_day_object, 'n');
0 ignored issues
show
The assignment to $month is dead and can be removed.
Loading history...
579
	$year = date_format($first_day_object, 'Y');
0 ignored issues
show
The assignment to $year is dead and can be removed.
Loading history...
580
	$day = date_format($first_day_object, 'd');
0 ignored issues
show
The assignment to $day is dead and can be removed.
Loading history...
581
582
	$next_object = date_create($selected_date);
583
	date_add($next_object, date_interval_create_from_date_string('1 week'));
584
585
	$prev_object = date_create($selected_date);
586
	date_sub($prev_object, date_interval_create_from_date_string('1 week'));
587
588
	// Now start filling in the calendar grid.
589
	$calendarGrid = array(
590
		'show_next_prev' => !empty($calendarOptions['show_next_prev']),
591
		'previous_week' => array(
592
			'year' => date_format($prev_object, 'Y'),
593
			'month' => date_format($prev_object, 'n'),
594
			'day' => date_format($prev_object, 'd'),
595
			'start_date' => date_format($prev_object, 'Y-m-d'),
596
			'disabled' => $modSettings['cal_minyear'] > date_format($prev_object, 'Y'),
597
		),
598
		'next_week' => array(
599
			'year' => date_format($next_object, 'Y'),
600
			'month' => date_format($next_object, 'n'),
601
			'day' => date_format($next_object, 'd'),
602
			'start_date' => date_format($next_object, 'Y-m-d'),
603
			'disabled' => $modSettings['cal_maxyear'] < date_format($next_object, 'Y'),
604
		),
605
		'start_date' => timeformat(date_format($selected_object, 'U'), get_date_or_time_format('date')),
0 ignored issues
show
date_format($selected_object, 'U') of type string is incompatible with the type integer expected by parameter $log_time of timeformat(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

605
		'start_date' => timeformat(/** @scrutinizer ignore-type */ date_format($selected_object, 'U'), get_date_or_time_format('date')),
Loading history...
get_date_or_time_format('date') of type string is incompatible with the type boolean expected by parameter $show_today of timeformat(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

605
		'start_date' => timeformat(date_format($selected_object, 'U'), /** @scrutinizer ignore-type */ get_date_or_time_format('date')),
Loading history...
606
	);
607
608
	// Fetch the arrays for birthdays, posted events, and holidays.
609
	$bday = $calendarOptions['show_birthdays'] ? getBirthdayRange(date_format($first_day_object, 'Y-m-d'), date_format($last_day_object, 'Y-m-d')) : array();
610
	$events = $calendarOptions['show_events'] ? getEventRange(date_format($first_day_object, 'Y-m-d'), date_format($last_day_object, 'Y-m-d')) : array();
611
	$holidays = $calendarOptions['show_holidays'] ? getHolidayRange(date_format($first_day_object, 'Y-m-d'), date_format($last_day_object, 'Y-m-d')) : array();
612
613
	$calendarGrid['week_title'] = sprintf($txt['calendar_week_beginning'], $txt['months_titles'][date_format($first_day_object, 'n')], date_format($first_day_object, 'j'), date_format($first_day_object, 'Y'));
614
615
	// This holds all the main data - there is at least one month!
616
	$calendarGrid['months'] = array();
617
	$current_day_object = date_create(date_format($first_day_object, 'Y-m-d'));
618
	for ($i = 0; $i < 7; $i++)
619
	{
620
		$current_month = date_format($current_day_object, 'n');
621
		$current_day = date_format($current_day_object, 'j');
622
		$current_date = date_format($current_day_object, 'Y-m-d');
623
624
		if (!isset($calendarGrid['months'][$current_month]))
625
			$calendarGrid['months'][$current_month] = array(
626
				'current_month' => $current_month,
627
				'current_year' => date_format($current_day_object, 'Y'),
628
				'days' => array(),
629
			);
630
631
		$calendarGrid['months'][$current_month]['days'][$current_day] = array(
632
			'day' => $current_day,
633
			'day_of_week' => (date_format($current_day_object, 'w') + 7 - $calendarOptions['start_day']) % 7,
634
			'date' => $current_date,
635
			'is_today' => $current_date == $today['date'],
636
			'holidays' => !empty($holidays[$current_date]) ? $holidays[$current_date] : array(),
637
			'events' => !empty($events[$current_date]) ? $events[$current_date] : array(),
638
			'birthdays' => !empty($bday[$current_date]) ? $bday[$current_date] : array()
639
		);
640
641
		date_add($current_day_object, date_interval_create_from_date_string('1 day'));
642
	}
643
644
	// Set the previous and the next week's links.
645
	$calendarGrid['previous_week']['href'] = $scripturl . '?action=calendar;viewweek;year=' . $calendarGrid['previous_week']['year'] . ';month=' . $calendarGrid['previous_week']['month'] . ';day=' . $calendarGrid['previous_week']['day'];
646
	$calendarGrid['next_week']['href'] = $scripturl . '?action=calendar;viewweek;year=' . $calendarGrid['next_week']['year'] . ';month=' . $calendarGrid['next_week']['month'] . ';day=' . $calendarGrid['next_week']['day'];
647
648
	loadDatePicker('#calendar_navigation .date_input');
649
	loadDatePair('#calendar_navigation', 'date_input', '');
650
651
	return $calendarGrid;
652
}
653
654
/**
655
 * Returns the information needed to show a list of upcoming events, birthdays, and holidays on the calendar.
656
 *
657
 * @param string $start_date The start of a date range in YYYY-MM-DD format
658
 * @param string $end_date The end of a date range in YYYY-MM-DD format
659
 * @param array $calendarOptions An array of calendar options
660
 * @return array An array of information needed to display a list of upcoming events, etc., on the calendar
661
 */
662
function getCalendarList($start_date, $end_date, $calendarOptions)
663
{
664
	global $modSettings, $user_info, $txt, $context, $sourcedir;
665
	require_once($sourcedir . '/Subs.php');
666
667
	// DateTime objects make life easier
668
	$start_object = date_create($start_date);
669
	$end_object = date_create($end_date);
670
671
	$calendarGrid = array(
672
		'start_date' => timeformat(date_format($start_object, 'U'), get_date_or_time_format('date')),
0 ignored issues
show
date_format($start_object, 'U') of type string is incompatible with the type integer expected by parameter $log_time of timeformat(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

672
		'start_date' => timeformat(/** @scrutinizer ignore-type */ date_format($start_object, 'U'), get_date_or_time_format('date')),
Loading history...
get_date_or_time_format('date') of type string is incompatible with the type boolean expected by parameter $show_today of timeformat(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

672
		'start_date' => timeformat(date_format($start_object, 'U'), /** @scrutinizer ignore-type */ get_date_or_time_format('date')),
Loading history...
673
		'start_year' => date_format($start_object, 'Y'),
674
		'start_month' => date_format($start_object, 'm'),
675
		'start_day' => date_format($start_object, 'd'),
676
		'end_date' => timeformat(date_format($end_object, 'U'), get_date_or_time_format('date')),
677
		'end_year' => date_format($end_object, 'Y'),
678
		'end_month' => date_format($end_object, 'm'),
679
		'end_day' => date_format($end_object, 'd'),
680
	);
681
682
	$calendarGrid['birthdays'] = $calendarOptions['show_birthdays'] ? getBirthdayRange($start_date, $end_date) : array();
683
	$calendarGrid['holidays'] = $calendarOptions['show_holidays'] ? getHolidayRange($start_date, $end_date) : array();
684
	$calendarGrid['events'] = $calendarOptions['show_events'] ? getEventRange($start_date, $end_date) : array();
685
686
	// Get rid of duplicate events
687
	$temp = array();
688
	foreach ($calendarGrid['events'] as $date => $date_events)
689
	{
690
		foreach ($date_events as $event_key => $event_val)
691
		{
692
			if (in_array($event_val['id'], $temp))
693
				unset($calendarGrid['events'][$date][$event_key]);
694
			else
695
				$temp[] = $event_val['id'];
696
		}
697
	}
698
699
	// Give birthdays and holidays a friendly format, without the year
700
	$date_format = str_replace(array('%Y', '%y', '%G', '%g', '%C', '%c', '%D'), array('', '', '', '', '', '%b %d', '%m/%d'), get_date_or_time_format('date'));
701
702
	foreach (array('birthdays', 'holidays') as $type)
703
	{
704
		foreach ($calendarGrid[$type] as $date => $date_content)
0 ignored issues
show
The expression $calendarGrid[$type] of type string is not traversable.
Loading history...
705
		{
706
			$date_local = preg_replace('~(?<=\s)0+(\d)~', '$1', trim(timeformat(strtotime($date), $date_format), " \t\n\r\0\x0B,./;:<>()[]{}\\|-_=+"));
707
708
			$calendarGrid[$type][$date]['date_local'] = $date_local;
709
		}
710
	}
711
712
	loadDatePicker('#calendar_range .date_input');
713
	loadDatePair('#calendar_range', 'date_input', '');
714
715
	return $calendarGrid;
716
}
717
718
/**
719
 * Loads the necessary JavaScript and CSS to create a datepicker.
720
 *
721
 * @param string $selector A CSS selector for the input field(s) that the datepicker should be attached to.
722
 * @param string $date_format The date format to use, in strftime() format.
723
 */
724
function loadDatePicker($selector = 'input.date_input', $date_format = '')
725
{
726
	global $modSettings, $txt, $context, $user_info;
727
728
	if (empty($date_format))
729
		$date_format = get_date_or_time_format('date');
730
731
	// Convert to format used by datepicker
732
	$date_format = strtr($date_format, array(
733
		// Day
734
		'%a' => 'D', '%A' => 'DD', '%e' => 'd', '%d' => 'dd', '%j' => 'oo', '%u' => '', '%w' => '',
735
		// Week
736
		'%U' => '', '%V' => '', '%W' => '',
737
		// Month
738
		'%b' => 'M', '%B' => 'MM', '%h' => 'M', '%m' => 'mm',
739
		// Year
740
		'%C' => '', '%g' => 'y', '%G' => 'yy', '%y' => 'y', '%Y' => 'yy',
741
		// Time (we remove all of these)
742
		'%H' => '', '%k' => '', '%I' => '', '%l' => '', '%M' => '', '%p' => '', '%P' => '',
743
		'%r' => '', '%R' => '', '%S' => '', '%T' => '', '%X' => '', '%z' => '', '%Z' => '',
744
		// Time and Date Stamps
745
		'%c' => 'D, d M yy', '%D' => 'mm/dd/y', '%F' => 'yy-mm-dd', '%s' => '@', '%x' => 'D, d M yy',
746
		// Miscellaneous
747
		'%n' => ' ', '%t' => ' ', '%%' => '%',
748
	));
749
750
	loadCSSFile('jquery-ui.datepicker.css', array(), 'smf_datepicker');
751
	loadJavaScriptFile('jquery-ui.datepicker.min.js', array('defer' => true), 'smf_datepicker');
752
	addInlineJavaScript('
753
	$("' . $selector . '").datepicker({
754
		dateFormat: "' . $date_format . '",
755
		autoSize: true,
756
		isRTL: ' . ($context['right_to_left'] ? 'true' : 'false') . ',
757
		constrainInput: true,
758
		showAnim: "",
759
		showButtonPanel: false,
760
		yearRange: "' . $modSettings['cal_minyear'] . ':' . $modSettings['cal_maxyear'] . '",
761
		hideIfNoPrevNext: true,
762
		monthNames: ["' . implode('", "', $txt['months_titles']) . '"],
763
		monthNamesShort: ["' . implode('", "', $txt['months_short']) . '"],
764
		dayNames: ["' . implode('", "', $txt['days']) . '"],
765
		dayNamesShort: ["' . implode('", "', $txt['days_short']) . '"],
766
		dayNamesMin: ["' . implode('", "', $txt['days_short']) . '"],
767
		prevText: "' . $txt['prev_month'] . '",
768
		nextText: "' . $txt['next_month'] . '",
769
	});', true);
770
}
771
772
/**
773
 * Loads the necessary JavaScript and CSS to create a timepicker.
774
 *
775
 * @param string $selector A CSS selector for the input field(s) that the timepicker should be attached to.
776
 * @param string $time_format A time format in strftime format
777
 */
778
function loadTimePicker($selector = 'input.time_input', $time_format = '')
779
{
780
	global $modSettings, $txt, $context;
781
782
	if (empty($time_format))
783
		$time_format = get_date_or_time_format('time');
784
785
	// Format used for timepicker
786
	$time_format = strtr($time_format, array(
787
		'%H' => 'H',
788
		'%k' => 'G',
789
		'%I' => 'h',
790
		'%l' => 'g',
791
		'%M' => 'i',
792
		'%p' => 'A',
793
		'%P' => 'a',
794
		'%r' => 'h:i:s A',
795
		'%R' => 'H:i',
796
		'%S' => 's',
797
		'%T' => 'H:i:s',
798
		'%X' => 'H:i:s',
799
	));
800
801
	loadCSSFile('jquery.timepicker.css', array(), 'smf_timepicker');
802
	loadJavaScriptFile('jquery.timepicker.min.js', array('defer' => true), 'smf_timepicker');
803
	addInlineJavaScript('
804
	$("' . $selector . '").timepicker({
805
		timeFormat: "' . $time_format . '",
806
		showDuration: true,
807
		maxTime: "23:59:59",
808
	});', true);
809
}
810
811
/**
812
 * Loads the necessary JavaScript for Datepair.js.
813
 *
814
 * Datepair.js helps to keep date ranges sane in the UI.
815
 *
816
 * @param string $container CSS selector for the containing element of the date/time inputs to be paired.
817
 * @param string $date_class The CSS class of the date inputs to be paired.
818
 * @param string $time_class The CSS class of the time inputs to be paired.
819
 */
820
function loadDatePair($container, $date_class = '', $time_class = '')
821
{
822
	global $modSettings, $txt, $context;
823
824
	$container = (string) $container;
825
	$date_class = (string) $date_class;
826
	$time_class = (string) $time_class;
827
828
	if ($container == '')
829
		return;
830
831
	loadJavaScriptFile('jquery.datepair.min.js', array('defer' => true), 'smf_datepair');
832
833
	$datepair_options = '';
834
835
	// If we're not using a date input, we might as well disable these.
836
	if ($date_class == '')
837
	{
838
		$datepair_options .= '
839
		parseDate: function (el) {},
840
		updateDate: function (el, v) {},';
841
	}
842
	else
843
	{
844
		$datepair_options .= '
845
		dateClass: "' . $date_class . '",';
846
847
		// Customize Datepair to work with jQuery UI's datepicker.
848
		$datepair_options .= '
849
		parseDate: function (el) {
850
			var val = $(el).datepicker("getDate");
851
			if (!val) {
852
				return null;
853
			}
854
			var utc = new Date(val);
855
			return utc && new Date(utc.getTime() + (utc.getTimezoneOffset() * 60000));
856
		},
857
		updateDate: function (el, v) {
858
			$(el).datepicker("setDate", new Date(v.getTime() - (v.getTimezoneOffset() * 60000)));
859
		},';
860
	}
861
862
	// If not using a time input, disable time functions.
863
	if ($time_class == '')
864
	{
865
		$datepair_options .= '
866
		parseTime: function(input){},
867
		updateTime: function(input, dateObj){},
868
		setMinTime: function(input, dateObj){},';
869
	}
870
	else
871
	{
872
		$datepair_options .= '
873
		timeClass: "' . $time_class . '",';
874
	}
875
876
	addInlineJavaScript('
877
	$("' . $container . '").datepair({' . $datepair_options . "\n\t});", true);
878
879
}
880
881
/**
882
 * Retrieve all events for the given days, independently of the users offset.
883
 * cache callback function used to retrieve the birthdays, holidays, and events between now and now + days_to_index.
884
 * widens the search range by an extra 24 hours to support time offset shifts.
885
 * used by the cache_getRecentEvents function to get the information needed to calculate the events taking the users time offset into account.
886
 *
887
 * @param array $eventOptions With the keys 'num_days_shown', 'include_holidays', 'include_birthdays' and 'include_events'
888
 * @return array An array containing the data that was cached as well as an expression to calculate whether the data should be refreshed and when it expires
889
 */
890
function cache_getOffsetIndependentEvents($eventOptions)
891
{
892
	$days_to_index = $eventOptions['num_days_shown'];
893
894
	$low_date = strftime('%Y-%m-%d', forum_time(false) - 24 * 3600);
895
	$high_date = strftime('%Y-%m-%d', forum_time(false) + $days_to_index * 24 * 3600);
896
897
	return array(
898
		'data' => array(
899
			'holidays' => (!empty($eventOptions['include_holidays']) ? getHolidayRange($low_date, $high_date) : array()),
900
			'birthdays' => (!empty($eventOptions['include_birthdays']) ? getBirthdayRange($low_date, $high_date) : array()),
901
			'events' => (!empty($eventOptions['include_events']) ? getEventRange($low_date, $high_date, false) : array()),
902
		),
903
		'refresh_eval' => 'return \'' . strftime('%Y%m%d', forum_time(false)) . '\' != strftime(\'%Y%m%d\', forum_time(false)) || (!empty($modSettings[\'calendar_updated\']) && ' . time() . ' < $modSettings[\'calendar_updated\']);',
904
		'expires' => time() + 3600,
905
	);
906
}
907
908
/**
909
 * cache callback function used to retrieve the upcoming birthdays, holidays, and events within the given period, taking into account the users time offset.
910
 * Called from the BoardIndex to display the current day's events on the board index
911
 * used by the board index and SSI to show the upcoming events.
912
 *
913
 * @param array $eventOptions An array of event options.
914
 * @return array An array containing the info that was cached as well as a few other relevant things
915
 */
916
function cache_getRecentEvents($eventOptions)
917
{
918
	// With the 'static' cached data we can calculate the user-specific data.
919
	$cached_data = cache_quick_get('calendar_index', 'Subs-Calendar.php', 'cache_getOffsetIndependentEvents', array($eventOptions));
920
921
	// Get the information about today (from user perspective).
922
	$today = getTodayInfo();
923
924
	$return_data = array(
925
		'calendar_holidays' => array(),
926
		'calendar_birthdays' => array(),
927
		'calendar_events' => array(),
928
	);
929
930
	// Set the event span to be shown in seconds.
931
	$days_for_index = $eventOptions['num_days_shown'] * 86400;
932
933
	// Get the current member time/date.
934
	$now = forum_time();
935
936
	if (!empty($eventOptions['include_holidays']))
937
	{
938
		// Holidays between now and now + days.
939
		for ($i = $now; $i < $now + $days_for_index; $i += 86400)
940
		{
941
			if (isset($cached_data['holidays'][strftime('%Y-%m-%d', $i)]))
942
				$return_data['calendar_holidays'] = array_merge($return_data['calendar_holidays'], $cached_data['holidays'][strftime('%Y-%m-%d', $i)]);
943
		}
944
	}
945
946
	if (!empty($eventOptions['include_birthdays']))
947
	{
948
		// Happy Birthday, guys and gals!
949
		for ($i = $now; $i < $now + $days_for_index; $i += 86400)
950
		{
951
			$loop_date = strftime('%Y-%m-%d', $i);
952
			if (isset($cached_data['birthdays'][$loop_date]))
953
			{
954
				foreach ($cached_data['birthdays'][$loop_date] as $index => $dummy)
955
					$cached_data['birthdays'][strftime('%Y-%m-%d', $i)][$index]['is_today'] = $loop_date === $today['date'];
956
				$return_data['calendar_birthdays'] = array_merge($return_data['calendar_birthdays'], $cached_data['birthdays'][$loop_date]);
957
			}
958
		}
959
	}
960
961
	if (!empty($eventOptions['include_events']))
962
	{
963
		$duplicates = array();
964
		for ($i = $now; $i < $now + $days_for_index; $i += 86400)
965
		{
966
			// Determine the date of the current loop step.
967
			$loop_date = strftime('%Y-%m-%d', $i);
968
969
			// No events today? Check the next day.
970
			if (empty($cached_data['events'][$loop_date]))
971
				continue;
972
973
			// Loop through all events to add a few last-minute values.
974
			foreach ($cached_data['events'][$loop_date] as $ev => $event)
975
			{
976
				// Create a shortcut variable for easier access.
977
				$this_event = &$cached_data['events'][$loop_date][$ev];
978
979
				// Skip duplicates.
980
				if (isset($duplicates[$this_event['topic'] . $this_event['title']]))
981
				{
982
					unset($cached_data['events'][$loop_date][$ev]);
983
					continue;
984
				}
985
				else
986
					$duplicates[$this_event['topic'] . $this_event['title']] = true;
987
988
				// Might be set to true afterwards, depending on the permissions.
989
				$this_event['can_edit'] = false;
990
				$this_event['is_today'] = $loop_date === $today['date'];
991
				$this_event['date'] = $loop_date;
992
			}
993
994
			if (!empty($cached_data['events'][$loop_date]))
995
				$return_data['calendar_events'] = array_merge($return_data['calendar_events'], $cached_data['events'][$loop_date]);
996
		}
997
	}
998
999
	// Mark the last item so that a list separator can be used in the template.
1000
	for ($i = 0, $n = count($return_data['calendar_birthdays']); $i < $n; $i++)
1001
		$return_data['calendar_birthdays'][$i]['is_last'] = !isset($return_data['calendar_birthdays'][$i + 1]);
1002
	for ($i = 0, $n = count($return_data['calendar_events']); $i < $n; $i++)
1003
		$return_data['calendar_events'][$i]['is_last'] = !isset($return_data['calendar_events'][$i + 1]);
1004
1005
	return array(
1006
		'data' => $return_data,
1007
		'expires' => time() + 3600,
1008
		'refresh_eval' => 'return \'' . strftime('%Y%m%d', forum_time(false)) . '\' != strftime(\'%Y%m%d\', forum_time(false)) || (!empty($modSettings[\'calendar_updated\']) && ' . time() . ' < $modSettings[\'calendar_updated\']);',
1009
		'post_retri_eval' => '
1010
			global $context, $scripturl, $user_info;
1011
1012
			foreach ($cache_block[\'data\'][\'calendar_events\'] as $k => $event)
1013
			{
1014
				// Remove events that the user may not see or wants to ignore.
1015
				if ((count(array_intersect($user_info[\'groups\'], $event[\'allowed_groups\'])) === 0 && !allowedTo(\'admin_forum\') && !empty($event[\'id_board\'])) || in_array($event[\'id_board\'], $user_info[\'ignoreboards\']))
1016
					unset($cache_block[\'data\'][\'calendar_events\'][$k]);
1017
				else
1018
				{
1019
					// Whether the event can be edited depends on the permissions.
1020
					$cache_block[\'data\'][\'calendar_events\'][$k][\'can_edit\'] = allowedTo(\'calendar_edit_any\') || ($event[\'poster\'] == $user_info[\'id\'] && allowedTo(\'calendar_edit_own\'));
1021
1022
					// The added session code makes this URL not cachable.
1023
					$cache_block[\'data\'][\'calendar_events\'][$k][\'modify_href\'] = $scripturl . \'?action=\' . ($event[\'topic\'] == 0 ? \'calendar;sa=post;\' : \'post;msg=\' . $event[\'msg\'] . \';topic=\' . $event[\'topic\'] . \'.0;calendar;\') . \'eventid=\' . $event[\'id\'] . \';\' . $context[\'session_var\'] . \'=\' . $context[\'session_id\'];
1024
				}
1025
			}
1026
1027
			if (empty($params[0][\'include_holidays\']))
1028
				$cache_block[\'data\'][\'calendar_holidays\'] = array();
1029
			if (empty($params[0][\'include_birthdays\']))
1030
				$cache_block[\'data\'][\'calendar_birthdays\'] = array();
1031
			if (empty($params[0][\'include_events\']))
1032
				$cache_block[\'data\'][\'calendar_events\'] = array();
1033
1034
			$cache_block[\'data\'][\'show_calendar\'] = !empty($cache_block[\'data\'][\'calendar_holidays\']) || !empty($cache_block[\'data\'][\'calendar_birthdays\']) || !empty($cache_block[\'data\'][\'calendar_events\']);',
1035
	);
1036
}
1037
1038
/**
1039
 * Makes sure the calendar post is valid.
1040
 */
1041
function validateEventPost()
1042
{
1043
	global $modSettings, $smcFunc;
1044
1045
	if (!isset($_POST['deleteevent']))
1046
	{
1047
		// The 2.1 way
1048
		if (isset($_POST['start_date']))
1049
		{
1050
			$d = date_parse($_POST['start_date']);
1051
			if (!empty($d['error_count']) || !empty($d['warning_count']))
1052
				fatal_lang_error('invalid_date', false);
1053
			if (empty($d['year']))
1054
				fatal_lang_error('event_year_missing', false);
1055
			if (empty($d['month']))
1056
				fatal_lang_error('event_month_missing', false);
1057
		}
1058
		elseif (isset($_POST['start_datetime']))
1059
		{
1060
			$d = date_parse($_POST['start_datetime']);
1061
			if (!empty($d['error_count']) || !empty($d['warning_count']))
1062
				fatal_lang_error('invalid_date', false);
1063
			if (empty($d['year']))
1064
				fatal_lang_error('event_year_missing', false);
1065
			if (empty($d['month']))
1066
				fatal_lang_error('event_month_missing', false);
1067
		}
1068
		// The 2.0 way
1069
		else
1070
		{
1071
			// No month?  No year?
1072
			if (!isset($_POST['month']))
1073
				fatal_lang_error('event_month_missing', false);
1074
			if (!isset($_POST['year']))
1075
				fatal_lang_error('event_year_missing', false);
1076
1077
			// Check the month and year...
1078
			if ($_POST['month'] < 1 || $_POST['month'] > 12)
1079
				fatal_lang_error('invalid_month', false);
1080
			if ($_POST['year'] < $modSettings['cal_minyear'] || $_POST['year'] > $modSettings['cal_maxyear'])
1081
				fatal_lang_error('invalid_year', false);
1082
		}
1083
	}
1084
1085
	// Make sure they're allowed to post...
1086
	isAllowedTo('calendar_post');
1087
1088
	// If they want to us to calculate an end date, make sure it will fit in an acceptable range.
1089
	if (isset($_POST['span']))
1090
	{
1091
		if (($_POST['span'] < 1) || (!empty($modSettings['cal_maxspan']) && $_POST['span'] > $modSettings['cal_maxspan']))
1092
			fatal_lang_error('invalid_days_numb', false);
1093
	}
1094
1095
	// There is no need to validate the following values if we are just deleting the event.
1096
	if (!isset($_POST['deleteevent']))
1097
	{
1098
		// If we're doing things the 2.0 way, check the day
1099
		if (empty($_POST['start_date']) && empty($_POST['start_datetime']))
1100
		{
1101
			// No day?
1102
			if (!isset($_POST['day']))
1103
				fatal_lang_error('event_day_missing', false);
1104
1105
			// Bad day?
1106
			if (!checkdate($_POST['month'], $_POST['day'], $_POST['year']))
1107
				fatal_lang_error('invalid_date', false);
1108
		}
1109
1110
		if (!isset($_POST['evtitle']) && !isset($_POST['subject']))
1111
			fatal_lang_error('event_title_missing', false);
1112
		elseif (!isset($_POST['evtitle']))
1113
			$_POST['evtitle'] = $_POST['subject'];
1114
1115
		// No title?
1116
		if ($smcFunc['htmltrim']($_POST['evtitle']) === '')
1117
			fatal_lang_error('no_event_title', false);
1118
		if ($smcFunc['strlen']($_POST['evtitle']) > 100)
1119
			$_POST['evtitle'] = $smcFunc['substr']($_POST['evtitle'], 0, 100);
1120
		$_POST['evtitle'] = str_replace(';', '', $_POST['evtitle']);
1121
	}
1122
}
1123
1124
/**
1125
 * Get the event's poster.
1126
 *
1127
 * @param int $event_id The ID of the event
1128
 * @return int|bool The ID of the poster or false if the event was not found
1129
 */
1130
function getEventPoster($event_id)
1131
{
1132
	global $smcFunc;
1133
1134
	// A simple database query, how hard can that be?
1135
	$request = $smcFunc['db_query']('', '
1136
		SELECT id_member
1137
		FROM {db_prefix}calendar
1138
		WHERE id_event = {int:id_event}
1139
		LIMIT 1',
1140
		array(
1141
			'id_event' => $event_id,
1142
		)
1143
	);
1144
1145
	// No results, return false.
1146
	if ($smcFunc['db_num_rows'] === 0)
1147
		return false;
1148
1149
	// Grab the results and return.
1150
	list ($poster) = $smcFunc['db_fetch_row']($request);
1151
	$smcFunc['db_free_result']($request);
1152
	return (int) $poster;
1153
}
1154
1155
/**
1156
 * Consolidating the various INSERT statements into this function.
1157
 * Inserts the passed event information into the calendar table.
1158
 * Allows to either set a time span (in days) or an end_date.
1159
 * Does not check any permissions of any sort.
1160
 *
1161
 * @param array $eventOptions An array of event options ('title', 'span', 'start_date', 'end_date', etc.)
1162
 */
1163
function insertEvent(&$eventOptions)
1164
{
1165
	global $smcFunc, $context;
1166
1167
	// Add special chars to the title.
1168
	$eventOptions['title'] = $smcFunc['htmlspecialchars']($eventOptions['title'], ENT_QUOTES);
1169
1170
	$eventOptions['location'] = isset($eventOptions['location']) ? $smcFunc['htmlspecialchars']($eventOptions['location'], ENT_QUOTES) : '';
1171
1172
	// Set the start and end dates and times
1173
	list($start_date, $end_date, $start_time, $end_time, $tz) = setEventStartEnd($eventOptions);
1174
1175
	// If no topic and board are given, they are not linked to a topic.
1176
	$eventOptions['board'] = isset($eventOptions['board']) ? (int) $eventOptions['board'] : 0;
1177
	$eventOptions['topic'] = isset($eventOptions['topic']) ? (int) $eventOptions['topic'] : 0;
1178
1179
	$event_columns = array(
1180
		'id_board' => 'int', 'id_topic' => 'int', 'title' => 'string-60', 'id_member' => 'int',
1181
		'start_date' => 'date', 'end_date' => 'date', 'location' => 'string-255',
1182
	);
1183
	$event_parameters = array(
1184
		$eventOptions['board'], $eventOptions['topic'], $eventOptions['title'], $eventOptions['member'],
1185
		$start_date, $end_date, $eventOptions['location'],
1186
	);
1187
	if (!empty($start_time) && !empty($end_time) && !empty($tz) && in_array($tz, timezone_identifiers_list(DateTimeZone::ALL_WITH_BC)))
0 ignored issues
show
It seems like timezone_identifiers_lis...eTimeZone::ALL_WITH_BC) can also be of type false; however, parameter $haystack of in_array() does only seem to accept array, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

1187
	if (!empty($start_time) && !empty($end_time) && !empty($tz) && in_array($tz, /** @scrutinizer ignore-type */ timezone_identifiers_list(DateTimeZone::ALL_WITH_BC)))
Loading history...
1188
	{
1189
		$event_columns['start_time'] = 'time';
1190
		$event_parameters[] = $start_time;
1191
		$event_columns['end_time'] = 'time';
1192
		$event_parameters[] = $end_time;
1193
		$event_columns['timezone'] = 'string';
1194
		$event_parameters[] = $tz;
1195
	}
1196
1197
	call_integration_hook('integrate_create_event', array(&$eventOptions, &$event_columns, &$event_parameters));
1198
1199
	// Insert the event!
1200
	$eventOptions['id'] = $smcFunc['db_insert']('',
1201
		'{db_prefix}calendar',
1202
		$event_columns,
1203
		$event_parameters,
1204
		array('id_event'),
1205
		1
1206
	);
1207
1208
	// If this isn't tied to a topic, we need to notify people about it.
1209
	if (empty($eventOptions['topic']))
1210
	{
1211
		$smcFunc['db_insert']('insert',
1212
			'{db_prefix}background_tasks',
1213
			array('task_file' => 'string', 'task_class' => 'string', 'task_data' => 'string', 'claimed_time' => 'int'),
1214
			array('$sourcedir/tasks/EventNew-Notify.php', 'EventNew_Notify_Background', $smcFunc['json_encode'](array(
1215
				'event_title' => $eventOptions['title'],
1216
				'event_id' => $eventOptions['id'],
1217
				'sender_id' => $eventOptions['member'],
1218
				'sender_name' => $eventOptions['member'] == $context['user']['id'] ? $context['user']['name'] : '',
1219
				'time' => time(),
1220
			)), 0),
1221
			array('id_task')
1222
		);
1223
	}
1224
1225
	// Update the settings to show something calendar-ish was updated.
1226
	updateSettings(array(
1227
		'calendar_updated' => time(),
1228
	));
1229
}
1230
1231
/**
1232
 * modifies an event.
1233
 * allows to either set a time span (in days) or an end_date.
1234
 * does not check any permissions of any sort.
1235
 *
1236
 * @param int $event_id The ID of the event
1237
 * @param array $eventOptions An array of event information
1238
 */
1239
function modifyEvent($event_id, &$eventOptions)
1240
{
1241
	global $smcFunc;
1242
1243
	// Properly sanitize the title and location
1244
	$eventOptions['title'] = $smcFunc['htmlspecialchars']($eventOptions['title'], ENT_QUOTES);
1245
	$eventOptions['location'] = $smcFunc['htmlspecialchars']($eventOptions['location'], ENT_QUOTES);
1246
1247
	// Set the new start and end dates and times
1248
	list($start_date, $end_date, $start_time, $end_time, $tz) = setEventStartEnd($eventOptions);
1249
1250
	$event_columns = array(
1251
		'start_date' => '{date:start_date}',
1252
		'end_date' => '{date:end_date}',
1253
		'title' => 'SUBSTRING({string:title}, 1, 60)',
1254
		'id_board' => '{int:id_board}',
1255
		'id_topic' => '{int:id_topic}',
1256
		'location' => 'SUBSTRING({string:location}, 1, 255)',
1257
	);
1258
	$event_parameters = array(
1259
		'start_date' => $start_date,
1260
		'end_date' => $end_date,
1261
		'title' => $eventOptions['title'],
1262
		'location' => $eventOptions['location'],
1263
		'id_board' => isset($eventOptions['board']) ? (int) $eventOptions['board'] : 0,
1264
		'id_topic' => isset($eventOptions['topic']) ? (int) $eventOptions['topic'] : 0,
1265
	);
1266
	if (!empty($start_time) && !empty($end_time) && !empty($tz) && in_array($tz, timezone_identifiers_list(DateTimeZone::ALL_WITH_BC)))
0 ignored issues
show
It seems like timezone_identifiers_lis...eTimeZone::ALL_WITH_BC) can also be of type false; however, parameter $haystack of in_array() does only seem to accept array, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

1266
	if (!empty($start_time) && !empty($end_time) && !empty($tz) && in_array($tz, /** @scrutinizer ignore-type */ timezone_identifiers_list(DateTimeZone::ALL_WITH_BC)))
Loading history...
1267
	{
1268
		$event_columns['start_time'] = '{time:start_time}';
1269
		$event_parameters['start_time'] = $start_time;
1270
		$event_columns['end_time'] = '{time:end_time}';
1271
		$event_parameters['end_time'] = $end_time;
1272
		$event_columns['timezone'] = '{string:timezone}';
1273
		$event_parameters['timezone'] = $tz;
1274
	}
1275
1276
	// This is to prevent hooks to modify the id of the event
1277
	$real_event_id = $event_id;
1278
	call_integration_hook('integrate_modify_event', array($event_id, &$eventOptions, &$event_columns, &$event_parameters));
1279
1280
	$column_clauses = array();
1281
	foreach ($event_columns as $col => $crit)
1282
		$column_clauses[] = $col . ' = ' . $crit;
1283
1284
	$smcFunc['db_query']('', '
1285
		UPDATE {db_prefix}calendar
1286
		SET
1287
			' . implode(', ', $column_clauses) . '
1288
		WHERE id_event = {int:id_event}',
1289
		array_merge(
1290
			$event_parameters,
1291
			array(
1292
				'id_event' => $real_event_id
1293
			)
1294
		)
1295
	);
1296
1297
	if (empty($start_time) || empty($end_time) || empty($tz) || !in_array($tz, timezone_identifiers_list(DateTimeZone::ALL_WITH_BC)))
1298
	{
1299
		$smcFunc['db_query']('', '
1300
			UPDATE {db_prefix}calendar
1301
			SET start_time = NULL, end_time = NULL, timezone = NULL
1302
			WHERE id_event = {int:id_event}',
1303
			array(
1304
				'id_event' => $real_event_id
1305
			)
1306
		);
1307
	}
1308
1309
	updateSettings(array(
1310
		'calendar_updated' => time(),
1311
	));
1312
}
1313
1314
/**
1315
 * Remove an event
1316
 * removes an event.
1317
 * does no permission checks.
1318
 *
1319
 * @param int $event_id The ID of the event to remove
1320
 */
1321
function removeEvent($event_id)
1322
{
1323
	global $smcFunc;
1324
1325
	$smcFunc['db_query']('', '
1326
		DELETE FROM {db_prefix}calendar
1327
		WHERE id_event = {int:id_event}',
1328
		array(
1329
			'id_event' => $event_id,
1330
		)
1331
	);
1332
1333
	call_integration_hook('integrate_remove_event', array($event_id));
1334
1335
	updateSettings(array(
1336
		'calendar_updated' => time(),
1337
	));
1338
}
1339
1340
/**
1341
 * Gets all the events properties
1342
 *
1343
 * @param int $event_id The ID of the event
1344
 * @return array An array of event information
1345
 */
1346
function getEventProperties($event_id)
1347
{
1348
	global $smcFunc;
1349
1350
	$request = $smcFunc['db_query']('', '
1351
		SELECT
1352
			c.id_event, c.id_board, c.id_topic, c.id_member, c.title,
1353
			c.start_date, c.end_date, c.start_time, c.end_time, c.timezone, c.location,
1354
			t.id_first_msg, t.id_member_started,
1355
			mb.real_name, m.modified_time
1356
		FROM {db_prefix}calendar AS c
1357
			LEFT JOIN {db_prefix}topics AS t ON (t.id_topic = c.id_topic)
1358
			LEFT JOIN {db_prefix}members AS mb ON (mb.id_member = t.id_member_started)
1359
			LEFT JOIN {db_prefix}messages AS m ON (m.id_msg  = t.id_first_msg)
1360
		WHERE c.id_event = {int:id_event}',
1361
		array(
1362
			'id_event' => $event_id,
1363
		)
1364
	);
1365
1366
	// If nothing returned, we are in poo, poo.
1367
	if ($smcFunc['db_num_rows']($request) === 0)
1368
		return false;
1369
1370
	$row = $smcFunc['db_fetch_assoc']($request);
1371
	$smcFunc['db_free_result']($request);
1372
1373
	list($start, $end, $allday, $span, $tz, $tz_abbrev) = buildEventDatetimes($row);
1374
1375
	// Sanity check
1376
	if (!empty($start['error_count']) || !empty($start['warning_count']) || !empty($end['error_count']) || !empty($end['warning_count']))
1377
		return false;
1378
1379
	$return_value = array(
1380
		'boards' => array(),
1381
		'board' => $row['id_board'],
1382
		'new' => 0,
1383
		'eventid' => $event_id,
1384
		'year' => $start['year'],
1385
		'month' => $start['month'],
1386
		'day' => $start['day'],
1387
		'hour' => !$allday ? $start['hour'] : null,
1388
		'minute' => !$allday ? $start['minute'] : null,
1389
		'second' => !$allday ? $start['second'] : null,
1390
		'start_date' => $row['start_date'],
1391
		'start_date_local' => $start['date_local'],
1392
		'start_date_orig' => $start['date_orig'],
1393
		'start_time' => !$allday ? $row['start_time'] : null,
1394
		'start_time_local' => !$allday ? $start['time_local'] : null,
1395
		'start_time_orig' => !$allday ? $start['time_orig'] : null,
1396
		'start_timestamp' => $start['timestamp'],
1397
		'start_datetime' => $start['datetime'],
1398
		'start_iso_gmdate' => $start['iso_gmdate'],
1399
		'end_year' => $end['year'],
1400
		'end_month' => $end['month'],
1401
		'end_day' => $end['day'],
1402
		'end_hour' => !$allday ? $end['hour'] : null,
1403
		'end_minute' => !$allday ? $end['minute'] : null,
1404
		'end_second' => !$allday ? $end['second'] : null,
1405
		'end_date' => $row['end_date'],
1406
		'end_date_local' => $end['date_local'],
1407
		'end_date_orig' => $end['date_orig'],
1408
		'end_time' => !$allday ? $row['end_time'] : null,
1409
		'end_time_local' => !$allday ? $end['time_local'] : null,
1410
		'end_time_orig' => !$allday ? $end['time_orig'] : null,
1411
		'end_timestamp' => $end['timestamp'],
1412
		'end_datetime' => $end['datetime'],
1413
		'end_iso_gmdate' => $end['iso_gmdate'],
1414
		'allday' => $allday,
1415
		'tz' => !$allday ? $tz : null,
1416
		'tz_abbrev' => !$allday ? $tz_abbrev : null,
1417
		'span' => $span,
1418
		'title' => $row['title'],
1419
		'location' => $row['location'],
1420
		'member' => $row['id_member'],
1421
		'realname' => $row['real_name'],
1422
		'sequence' => $row['modified_time'],
1423
		'topic' => array(
1424
			'id' => $row['id_topic'],
1425
			'member_started' => $row['id_member_started'],
1426
			'first_msg' => $row['id_first_msg'],
1427
		),
1428
	);
1429
1430
	$return_value['last_day'] = (int) strftime('%d', mktime(0, 0, 0, $return_value['month'] == 12 ? 1 : $return_value['month'] + 1, 0, $return_value['month'] == 12 ? $return_value['year'] + 1 : $return_value['year']));
1431
1432
	return $return_value;
1433
}
1434
1435
/**
1436
 * Gets an initial set of date and time values for creating a new event.
1437
 *
1438
 * @return array An array containing an initial set of date and time values for an event.
1439
 */
1440
function getNewEventDatetimes()
1441
{
1442
	// Ensure setEventStartEnd() has something to work with
1443
	$now = date_create();
1444
	$_POST['year'] = !empty($_POST['year']) ? $_POST['year'] : date_format($now, 'Y');
1445
	$_POST['month'] = !empty($_POST['month']) ? $_POST['month'] : date_format($now, 'm');
1446
	$_POST['day'] = !empty($_POST['day']) ? $_POST['day'] : date_format($now, 'd');
1447
	$_POST['hour'] = !empty($_POST['hour']) ? $_POST['hour'] : date_format($now, 'H');
1448
	$_POST['minute'] = !empty($_POST['minute']) ? $_POST['minute'] : date_format($now, 'i');
1449
	$_POST['second'] = !empty($_POST['second']) ? $_POST['second'] : date_format($now, 's');
1450
1451
	// Set the basic values for the new event
1452
	$row_keys = array('start_date', 'end_date', 'start_time', 'end_time', 'timezone');
1453
	$row = array_combine($row_keys, setEventStartEnd());
1454
1455
	// And now set the full suite of values
1456
	list($start, $end, $allday, $span, $tz, $tz_abbrev) = buildEventDatetimes($row);
0 ignored issues
show
It seems like $row can also be of type false; however, parameter $row of buildEventDatetimes() does only seem to accept array, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

1456
	list($start, $end, $allday, $span, $tz, $tz_abbrev) = buildEventDatetimes(/** @scrutinizer ignore-type */ $row);
Loading history...
1457
1458
	// Default theme only uses some of this info, but others might want it all
1459
	$eventProperties = array(
1460
		'year' => $start['year'],
1461
		'month' => $start['month'],
1462
		'day' => $start['day'],
1463
		'hour' => !$allday ? $start['hour'] : null,
1464
		'minute' => !$allday ? $start['minute'] : null,
1465
		'second' => !$allday ? $start['second'] : null,
1466
		'start_date' => $row['start_date'],
1467
		'start_date_local' => $start['date_local'],
1468
		'start_date_orig' => $start['date_orig'],
1469
		'start_time' => !$allday ? $row['start_time'] : null,
1470
		'start_time_local' => !$allday ? $start['time_local'] : null,
1471
		'start_time_orig' => !$allday ? $start['time_orig'] : null,
1472
		'start_timestamp' => $start['timestamp'],
1473
		'start_datetime' => $start['datetime'],
1474
		'start_iso_gmdate' => $start['iso_gmdate'],
1475
		'end_year' => $end['year'],
1476
		'end_month' => $end['month'],
1477
		'end_day' => $end['day'],
1478
		'end_hour' => !$allday ? $end['hour'] : null,
1479
		'end_minute' => !$allday ? $end['minute'] : null,
1480
		'end_second' => !$allday ? $end['second'] : null,
1481
		'end_date' => $row['end_date'],
1482
		'end_date_local' => $end['date_local'],
1483
		'end_date_orig' => $end['date_orig'],
1484
		'end_time' => !$allday ? $row['end_time'] : null,
1485
		'end_time_local' => !$allday ? $end['time_local'] : null,
1486
		'end_time_orig' => !$allday ? $end['time_orig'] : null,
1487
		'end_timestamp' => $end['timestamp'],
1488
		'end_datetime' => $end['datetime'],
1489
		'end_iso_gmdate' => $end['iso_gmdate'],
1490
		'allday' => $allday,
1491
		'tz' => !$allday ? $tz : null,
1492
		'tz_abbrev' => !$allday ? $tz_abbrev : null,
1493
		'span' => $span,
1494
	);
1495
1496
	return $eventProperties;
1497
}
1498
1499
/**
1500
 * Set the start and end dates and times for a posted event for insertion into the database.
1501
 * Validates all date and times given to it.
1502
 * Makes sure events do not exceed the maximum allowed duration (if any).
1503
 * If passed an array that defines any time or date parameters, they will be used. Otherwise, gets the values from $_POST.
1504
 *
1505
 * @param array $eventOptions An array of optional time and date parameters (span, start_year, end_month, etc., etc.)
1506
 * @return array An array containing $start_date, $end_date, $start_time, $end_time
1507
 */
1508
function setEventStartEnd($eventOptions = array())
1509
{
1510
	global $modSettings;
1511
1512
	// Set $span, in case we need it
1513
	$span = isset($eventOptions['span']) ? $eventOptions['span'] : (isset($_POST['span']) ? $_POST['span'] : 0);
1514
	if ($span > 0)
1515
		$span = !empty($modSettings['cal_maxspan']) ? min($modSettings['cal_maxspan'], $span - 1) : $span - 1;
1516
1517
	// Define the timezone for this event, falling back to the default if not provided
1518
	if (!empty($eventOptions['tz']) && in_array($eventOptions['tz'], timezone_identifiers_list(DateTimeZone::ALL_WITH_BC)))
0 ignored issues
show
It seems like timezone_identifiers_lis...eTimeZone::ALL_WITH_BC) can also be of type false; however, parameter $haystack of in_array() does only seem to accept array, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

1518
	if (!empty($eventOptions['tz']) && in_array($eventOptions['tz'], /** @scrutinizer ignore-type */ timezone_identifiers_list(DateTimeZone::ALL_WITH_BC)))
Loading history...
1519
		$tz = $eventOptions['tz'];
1520
	elseif (!empty($_POST['tz']) && in_array($_POST['tz'], timezone_identifiers_list(DateTimeZone::ALL_WITH_BC)))
1521
		$tz = $_POST['tz'];
1522
	else
1523
		$tz = getUserTimezone();
1524
1525
	// Is this supposed to be an all day event, or should it have specific start and end times?
1526
	if (isset($eventOptions['allday']))
1527
		$allday = $eventOptions['allday'];
1528
	elseif (empty($_POST['allday']))
1529
		$allday = false;
1530
	else
1531
		$allday = true;
1532
1533
	// Input might come as individual parameters...
1534
	$start_year = isset($eventOptions['year']) ? $eventOptions['year'] : (isset($_POST['year']) ? $_POST['year'] : null);
1535
	$start_month = isset($eventOptions['month']) ? $eventOptions['month'] : (isset($_POST['month']) ? $_POST['month'] : null);
1536
	$start_day = isset($eventOptions['day']) ? $eventOptions['day'] : (isset($_POST['day']) ? $_POST['day'] : null);
1537
	$start_hour = isset($eventOptions['hour']) ? $eventOptions['hour'] : (isset($_POST['hour']) ? $_POST['hour'] : null);
1538
	$start_minute = isset($eventOptions['minute']) ? $eventOptions['minute'] : (isset($_POST['minute']) ? $_POST['minute'] : null);
1539
	$start_second = isset($eventOptions['second']) ? $eventOptions['second'] : (isset($_POST['second']) ? $_POST['second'] : null);
1540
	$end_year = isset($eventOptions['end_year']) ? $eventOptions['end_year'] : (isset($_POST['end_year']) ? $_POST['end_year'] : null);
1541
	$end_month = isset($eventOptions['end_month']) ? $eventOptions['end_month'] : (isset($_POST['end_month']) ? $_POST['end_month'] : null);
1542
	$end_day = isset($eventOptions['end_day']) ? $eventOptions['end_day'] : (isset($_POST['end_day']) ? $_POST['end_day'] : null);
1543
	$end_hour = isset($eventOptions['end_hour']) ? $eventOptions['end_hour'] : (isset($_POST['end_hour']) ? $_POST['end_hour'] : null);
1544
	$end_minute = isset($eventOptions['end_minute']) ? $eventOptions['end_minute'] : (isset($_POST['end_minute']) ? $_POST['end_minute'] : null);
1545
	$end_second = isset($eventOptions['end_second']) ? $eventOptions['end_second'] : (isset($_POST['end_second']) ? $_POST['end_second'] : null);
1546
1547
	// ... or as datetime strings ...
1548
	$start_string = isset($eventOptions['start_datetime']) ? $eventOptions['start_datetime'] : (isset($_POST['start_datetime']) ? $_POST['start_datetime'] : null);
1549
	$end_string = isset($eventOptions['end_datetime']) ? $eventOptions['end_datetime'] : (isset($_POST['end_datetime']) ? $_POST['end_datetime'] : null);
1550
1551
	// ... or as date strings and time strings.
1552
	$start_date_string = isset($eventOptions['start_date']) ? $eventOptions['start_date'] : (isset($_POST['start_date']) ? $_POST['start_date'] : null);
1553
	$start_time_string = isset($eventOptions['start_time']) ? $eventOptions['start_time'] : (isset($_POST['start_time']) ? $_POST['start_time'] : null);
1554
	$end_date_string = isset($eventOptions['end_date']) ? $eventOptions['end_date'] : (isset($_POST['end_date']) ? $_POST['end_date'] : null);
1555
	$end_time_string = isset($eventOptions['end_time']) ? $eventOptions['end_time'] : (isset($_POST['end_time']) ? $_POST['end_time'] : null);
1556
1557
	// If the date and time were given in separate strings, combine them
1558
	if (empty($start_string) && isset($start_date_string))
1559
		$start_string = $start_date_string . (isset($start_time_string) ? ' ' . $start_time_string : '');
1560
	if (empty($end_string) && isset($end_date_string))
1561
		$end_string = $end_date_string . (isset($end_time_string) ? ' ' . $end_time_string : '');
1562
1563
	// If some form of string input was given, override individually defined options with it
1564
	if (isset($start_string))
1565
	{
1566
		$start_string_parsed = date_parse($start_string);
1567
		if (empty($start_string_parsed['error_count']) && empty($start_string_parsed['warning_count']))
1568
		{
1569
			if ($start_string_parsed['year'] != false)
1570
			{
1571
				$start_year = $start_string_parsed['year'];
1572
				$start_month = $start_string_parsed['month'];
1573
				$start_day = $start_string_parsed['day'];
1574
			}
1575
			if ($start_string_parsed['hour'] != false)
1576
			{
1577
				$start_hour = $start_string_parsed['hour'];
1578
				$start_minute = $start_string_parsed['minute'];
1579
				$start_second = $start_string_parsed['second'];
1580
			}
1581
		}
1582
	}
1583
	if (isset($end_string))
1584
	{
1585
		$end_string_parsed = date_parse($end_string);
1586
		if (empty($end_string_parsed['error_count']) && empty($end_string_parsed['warning_count']))
1587
		{
1588
			if ($end_string_parsed['year'] != false)
1589
			{
1590
				$end_year = $end_string_parsed['year'];
1591
				$end_month = $end_string_parsed['month'];
1592
				$end_day = $end_string_parsed['day'];
1593
			}
1594
			if ($end_string_parsed['hour'] != false)
1595
			{
1596
				$end_hour = $end_string_parsed['hour'];
1597
				$end_minute = $end_string_parsed['minute'];
1598
				$end_second = $end_string_parsed['second'];
1599
			}
1600
		}
1601
	}
1602
1603
	// Validate input
1604
	$start_date_isvalid = checkdate($start_month, $start_day, $start_year);
1605
	$end_date_isvalid = checkdate($end_month, $end_day, $end_year);
1606
1607
	$start_time_isset = (isset($start_hour) && isset($start_minute) && isset($start_second));
1608
	$d = date_parse(sprintf('%02d:%02d:%02d', $start_hour, $start_minute, $start_second));
1609
	$start_time_isvalid = ($d['error_count'] == 0 && $d['warning_count'] == 0) ? true : false;
1610
1611
	$end_time_isset = (isset($end_hour) && isset($end_minute) && isset($end_second));
1612
	$d = date_parse(sprintf('%02d:%02d:%02d', $end_hour, $end_minute, $end_second));
1613
	$end_time_isvalid = ($d['error_count'] == 0 && $d['warning_count'] == 0) ? true : false;
1614
1615
	// Uh-oh...
1616
	if ($start_date_isvalid === false)
1617
	{
1618
		fatal_lang_error('invalid_date', false);
1619
	}
1620
1621
	// Make sure we use valid values for everything
1622
	if ($end_date_isvalid === false)
1623
	{
1624
		$end_year = $start_year;
1625
		$end_month = $start_month;
1626
		$end_day = $start_day;
1627
	}
1628
1629
	if ($allday === true || $start_time_isset === false || $start_time_isvalid === false)
1630
	{
1631
		$allday = true;
1632
		$start_hour = 0;
1633
		$start_minute = 0;
1634
		$start_second = 0;
1635
	}
1636
1637
	if ($allday === true || $end_time_isvalid === false || $end_time_isset === false)
1638
	{
1639
		$end_hour = $start_hour;
1640
		$end_minute = $start_minute;
1641
		$end_second = $start_second;
1642
	}
1643
1644
	// Now create our datetime objects
1645
	$start_object = date_create(sprintf('%04d-%02d-%02d %02d:%02d:%02d', $start_year, $start_month, $start_day, $start_hour, $start_minute, $start_second) . ' ' . $tz);
1646
	$end_object = date_create(sprintf('%04d-%02d-%02d %02d:%02d:%02d', $end_year, $end_month, $end_day, $end_hour, $end_minute, $end_second) . ' ' . $tz);
1647
1648
	// Is $end_object too early?
1649
	if ($start_object >= $end_object)
1650
	{
1651
		$end_object = date_create(sprintf('%04d-%02d-%02d %02d:%02d:%02d', $start_year, $start_month, $start_day, $start_hour, $start_minute, $start_second) . ' ' . $tz);
1652
		if ($span > 0)
1653
			date_add($end_object, date_interval_create_from_date_string($span . ' days'));
0 ignored issues
show
It seems like $end_object can also be of type false; however, parameter $object of date_add() does only seem to accept DateTime, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

1653
			date_add(/** @scrutinizer ignore-type */ $end_object, date_interval_create_from_date_string($span . ' days'));
Loading history...
1654
		else
1655
			date_add($end_object, date_interval_create_from_date_string('1 hour'));
1656
	}
1657
1658
	// Is $end_object too late?
1659
	if (!empty($modSettings['cal_maxspan']))
1660
	{
1661
		$date_diff = date_diff($start_object, $end_object);
0 ignored issues
show
It seems like $start_object can also be of type false; however, parameter $object of date_diff() does only seem to accept DateTime, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

1661
		$date_diff = date_diff(/** @scrutinizer ignore-type */ $start_object, $end_object);
Loading history...
It seems like $end_object can also be of type false; however, parameter $object2 of date_diff() does only seem to accept DateTime, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

1661
		$date_diff = date_diff($start_object, /** @scrutinizer ignore-type */ $end_object);
Loading history...
1662
		if ($date_diff->days > $modSettings['cal_maxspan'])
1663
		{
1664
			if ($modSettings['cal_maxspan'] > 1)
1665
			{
1666
				$end_object = date_create(sprintf('%04d-%02d-%02d %02d:%02d:%02d', $start_year, $start_month, $start_day, $start_hour, $start_minute, $start_second) . ' ' . $tz);
1667
				date_add($end_object, date_interval_create_from_date_string($modSettings['cal_maxspan'] . ' days'));
1668
			}
1669
			else
1670
				$end_object = date_create(sprintf('%04d-%02d-%02d %02d:%02d:%02d', $start_year, $start_month, $start_day, '11', '59', '59') . ' ' . $tz);
1671
		}
1672
	}
1673
1674
	// Finally, make our strings
1675
	$start_date = date_format($start_object, 'Y-m-d');
1676
	$end_date = date_format($end_object, 'Y-m-d');
1677
1678
	if ($allday == true)
1679
	{
1680
		$start_time = null;
1681
		$end_time = null;
1682
		$tz = null;
1683
	}
1684
	else
1685
	{
1686
		$start_time = date_format($start_object, 'H:i:s');
1687
		$end_time = date_format($end_object, 'H:i:s');
1688
	}
1689
1690
	return array($start_date, $end_date, $start_time, $end_time, $tz);
1691
}
1692
1693
/**
1694
 * Helper function for getEventRange, getEventProperties, getNewEventDatetimes, etc.
1695
 *
1696
 * @param array $row A database row representing an event from the calendar table
1697
 * @return array An array containing the start and end date and time properties for the event
1698
 */
1699
function buildEventDatetimes($row)
1700
{
1701
	global $sourcedir, $user_info, $txt;
1702
	static $date_format = '', $time_format = '';
1703
1704
	require_once($sourcedir . '/Subs.php');
1705
	static $timezone_array = array();
1706
1707
	loadLanguage('Timezones');
1708
1709
	// First, try to create a better date format, ignoring the "time" elements.
1710
	if (empty($date_format))
1711
		$date_format = get_date_or_time_format('date');
1712
1713
	// We want a fairly compact version of the time, but as close as possible to the user's settings.
1714
	if (empty($time_format))
1715
		$time_format = strtr(get_date_or_time_format('time'), array(
1716
			'%I' => '%l',
1717
			'%H' => '%k',
1718
			'%S' => '',
1719
			'%r' => '%l:%M %p',
1720
			'%R' => '%k:%M',
1721
			'%T' => '%l:%M',
1722
		));
1723
1724
	// Should this be an all day event?
1725
	$allday = (empty($row['start_time']) || empty($row['end_time']) || empty($row['timezone']) || !in_array($row['timezone'], timezone_identifiers_list(DateTimeZone::ALL_WITH_BC))) ? true : false;
0 ignored issues
show
It seems like timezone_identifiers_lis...eTimeZone::ALL_WITH_BC) can also be of type false; however, parameter $haystack of in_array() does only seem to accept array, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

1725
	$allday = (empty($row['start_time']) || empty($row['end_time']) || empty($row['timezone']) || !in_array($row['timezone'], /** @scrutinizer ignore-type */ timezone_identifiers_list(DateTimeZone::ALL_WITH_BC))) ? true : false;
Loading history...
1726
1727
	// How many days does this event span?
1728
	$span = 1 + date_interval_format(date_diff(date_create($row['start_date']), date_create($row['end_date'])), '%d');
0 ignored issues
show
It seems like date_create($row['end_date']) can also be of type false; however, parameter $object2 of date_diff() does only seem to accept DateTime, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

1728
	$span = 1 + date_interval_format(date_diff(date_create($row['start_date']), /** @scrutinizer ignore-type */ date_create($row['end_date'])), '%d');
Loading history...
It seems like date_create($row['start_date']) can also be of type false; however, parameter $object of date_diff() does only seem to accept DateTime, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

1728
	$span = 1 + date_interval_format(date_diff(/** @scrutinizer ignore-type */ date_create($row['start_date']), date_create($row['end_date'])), '%d');
Loading history...
1729
1730
	// We need to have a defined timezone in the steps below
1731
	if (empty($row['timezone']))
1732
		$row['timezone'] = getUserTimezone();
1733
1734
	if (empty($timezone_array[$row['timezone']]))
1735
		$timezone_array[$row['timezone']] = timezone_open($row['timezone']);
1736
1737
	// Get most of the standard date information for the start and end datetimes
1738
	$start = date_parse($row['start_date'] . (!$allday ? ' ' . $row['start_time'] : ''));
1739
	$end = date_parse($row['end_date'] . (!$allday ? ' ' . $row['end_time'] : ''));
1740
1741
	// But we also want more info, so make some DateTime objects we can use
1742
	$start_object = date_create($row['start_date'] . (!$allday ? ' ' . $row['start_time'] : ''), $timezone_array[$row['timezone']]);
1743
	$end_object = date_create($row['end_date'] . (!$allday ? ' ' . $row['end_time'] : ''), $timezone_array[$row['timezone']]);
1744
1745
	// Unix timestamps are good
1746
	$start['timestamp'] = date_format($start_object, 'U');
1747
	$end['timestamp'] = date_format($end_object, 'U');
1748
1749
	// Datetime string without timezone  (e.g. '2016-12-28 22:45:30')
1750
	$start['datetime'] = date_format($start_object, 'Y-m-d H:i:s');
1751
	$end['datetime'] = date_format($start_object, 'Y-m-d H:i:s');
1752
1753
	// ISO formatted datetime string, relative to UTC (e.g. '2016-12-29T05:45:30+00:00')
1754
	$start['iso_gmdate'] = gmdate('c', $start['timestamp']);
1755
	$end['iso_gmdate'] = gmdate('c', $end['timestamp']);
1756
1757
	// Strings showing the datetimes in the user's preferred format, relative to the user's time zone
1758
	list($start['date_local'], $start['time_local']) = explode(' § ', timeformat($start['timestamp'], $date_format . ' § ' . $time_format));
0 ignored issues
show
$date_format . ' § ' . $time_format of type string is incompatible with the type boolean expected by parameter $show_today of timeformat(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

1758
	list($start['date_local'], $start['time_local']) = explode(' § ', timeformat($start['timestamp'], /** @scrutinizer ignore-type */ $date_format . ' § ' . $time_format));
Loading history...
1759
	list($end['date_local'], $end['time_local']) = explode(' § ', timeformat($end['timestamp'], $date_format . ' § ' . $time_format));
1760
1761
	// Strings showing the datetimes in the user's preferred format, relative to the event's time zone
1762
	list($start['date_orig'], $start['time_orig']) = explode(' § ', timeformat(strtotime(date_format($start_object, 'Y-m-d H:i:s')), $date_format . ' § ' . $time_format, 'none'));
1763
	list($end['date_orig'], $end['time_orig']) = explode(' § ', timeformat(strtotime(date_format($end_object, 'Y-m-d H:i:s')), $date_format . ' § ' . $time_format, 'none'));
1764
1765
	// The time zone identifier (e.g. 'Europe/London') and abbreviation (e.g. 'GMT')
1766
	$tz = date_format($start_object, 'e');
1767
	$tz_abbrev = date_format($start_object, 'T');
1768
1769
	// If the abbreviation is just a numerical offset from UTC, make that clear.
1770
	if (strspn($tz_abbrev, '+-') > 0)
1771
		$tz_abbrev = 'UTC' . $tz_abbrev;
1772
1773
	return array($start, $end, $allday, $span, $tz, $tz_abbrev);
1774
}
1775
1776
/**
1777
 * Gets a member's selected timezone identifier directly from the database
1778
 *
1779
 * @param int $id_member The member id to look up. If not provided, the current user's id will be used.
1780
 * @return string The timezone identifier string for the user's timezone.
1781
 */
1782
function getUserTimezone($id_member = null)
1783
{
1784
	global $smcFunc, $context, $user_info, $modSettings, $user_settings;
1785
	static $member_cache = array();
1786
1787
	if (is_null($id_member) && $user_info['is_guest'] == false)
1788
		$id_member = $context['user']['id'];
1789
1790
	//check if the cache got the data
1791
	if (isset($id_member) && isset($member_cache[$id_member]))
1792
	{
1793
		return $member_cache[$id_member];
1794
	}
1795
1796
	//maybe the current user is the one
1797
	if (isset($user_settings['id_member']) && $user_settings['id_member'] == $id_member && !empty($user_settings['timezone']))
1798
	{
1799
		$member_cache[$id_member] = $user_settings['timezone'];
1800
		return $user_settings['timezone'];
1801
	}
1802
1803
	if (isset($id_member))
1804
	{
1805
		$request = $smcFunc['db_query']('', '
1806
			SELECT timezone
1807
			FROM {db_prefix}members
1808
			WHERE id_member = {int:id_member}',
1809
			array(
1810
				'id_member' => $id_member,
1811
			)
1812
		);
1813
		list($timezone) = $smcFunc['db_fetch_row']($request);
1814
		$smcFunc['db_free_result']($request);
1815
	}
1816
1817
	if (empty($timezone) || !in_array($timezone, timezone_identifiers_list(DateTimeZone::ALL_WITH_BC)))
0 ignored issues
show
It seems like timezone_identifiers_lis...eTimeZone::ALL_WITH_BC) can also be of type false; however, parameter $haystack of in_array() does only seem to accept array, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

1817
	if (empty($timezone) || !in_array($timezone, /** @scrutinizer ignore-type */ timezone_identifiers_list(DateTimeZone::ALL_WITH_BC)))
Loading history...
1818
		$timezone = isset($modSettings['default_timezone']) ? $modSettings['default_timezone'] : date_default_timezone_get();
1819
1820
	if (isset($id_member))
1821
		$member_cache[$id_member] = $timezone;
1822
1823
	return $timezone;
1824
}
1825
1826
/**
1827
 * Gets all of the holidays for the listing
1828
 *
1829
 * @param int $start The item to start with (for pagination purposes)
1830
 * @param int $items_per_page How many items to show on each page
1831
 * @param string $sort A string indicating how to sort the results
1832
 * @return array An array of holidays, each of which is an array containing the id, year, month, day and title of the holiday
1833
 */
1834
function list_getHolidays($start, $items_per_page, $sort)
1835
{
1836
	global $smcFunc;
1837
1838
	$request = $smcFunc['db_query']('', '
1839
		SELECT id_holiday, YEAR(event_date) AS year, MONTH(event_date) AS month, DAYOFMONTH(event_date) AS day, title
1840
		FROM {db_prefix}calendar_holidays
1841
		ORDER BY {raw:sort}
1842
		LIMIT {int:start}, {int:max}',
1843
		array(
1844
			'sort' => $sort,
1845
			'start' => $start,
1846
			'max' => $items_per_page,
1847
		)
1848
	);
1849
	$holidays = array();
1850
	while ($row = $smcFunc['db_fetch_assoc']($request))
1851
		$holidays[] = $row;
1852
	$smcFunc['db_free_result']($request);
1853
1854
	return $holidays;
1855
}
1856
1857
/**
1858
 * Helper function to get the total number of holidays
1859
 *
1860
 * @return int The total number of holidays
1861
 */
1862
function list_getNumHolidays()
1863
{
1864
	global $smcFunc;
1865
1866
	$request = $smcFunc['db_query']('', '
1867
		SELECT COUNT(*)
1868
		FROM {db_prefix}calendar_holidays',
1869
		array(
1870
		)
1871
	);
1872
	list($num_items) = $smcFunc['db_fetch_row']($request);
1873
	$smcFunc['db_free_result']($request);
1874
1875
	return (int) $num_items;
1876
}
1877
1878
/**
1879
 * Remove a holiday from the calendar
1880
 *
1881
 * @param array $holiday_ids An array of IDs of holidays to delete
1882
 */
1883
function removeHolidays($holiday_ids)
1884
{
1885
	global $smcFunc;
1886
1887
	$smcFunc['db_query']('', '
1888
		DELETE FROM {db_prefix}calendar_holidays
1889
		WHERE id_holiday IN ({array_int:id_holiday})',
1890
		array(
1891
			'id_holiday' => $holiday_ids,
1892
		)
1893
	);
1894
1895
	updateSettings(array(
1896
		'calendar_updated' => time(),
1897
	));
1898
}
1899
1900
?>