Bug fix to correctly handle the logic for 'maxEntries' Issue #2050

CHANGELOG.md

@@ -37,6 +37,7 @@ _This release is scheduled to be released on 2020-07-01._
 - Support multiple instances of calendar module with different config [#1109](https://github.com/MichMich/MagicMirror/issues/1109)
 - Fix the use of "maxNumberOfDays" in the module "weatherforecast" [#2018](https://github.com/MichMich/MagicMirror/issues/2018)
 - Throw error when check_config fails [#1928](https://github.com/MichMich/MagicMirror/issues/1928)
+- Bug fix related to 'maxEntries' not displaying Calendar events. [#2050](https://github.com/MichMich/MagicMirror/issues/2050)
 
 ## [2.11.0] - 2020-04-01
 

modules/default/calendar/calendarfetcher.js

@@ -1,14 +1,14 @@
 /* Magic Mirror
  * Node Helper: Calendar - CalendarFetcher
  *
- * By Michael Teeuw https://michaelteeuw.nl
+ * By Michael Teeuw http://michaelteeuw.nl
  * MIT Licensed.
  */
-const Log = require("../../../js/logger.js");
-const ical = require("./vendor/ical.js");
-const moment = require("moment");
 
-var CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEntries, maximumNumberOfDays, auth, includePastEvents) {
+var ical = require("./vendor/ical.js");
+var moment = require("moment");
+
+var CalendarFetcher = function(url, reloadInterval, excludedEvents, maximumNumberOfDays, auth, includePastEvents) {
 	var self = this;
 
 	var reloadTimer = null;
@@ -21,10 +21,11 @@ var CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEntr
 	 * Initiates calendar fetch.
 	 */
 	var fetchCalendar = function() {
+
 		clearTimeout(reloadTimer);
 		reloadTimer = null;
 
-		var nodeVersion = Number(process.version.match(/^v(\d+\.\d+)/)[1]);
+		nodeVersion = Number(process.version.match(/^v(\d+\.\d+)/)[1]);
 		var opts = {
 			headers: {
 				"User-Agent": "Mozilla/5.0 (Node.js "+ nodeVersion + ") MagicMirror/" + global.version + " (https://github.com/MichMich/MagicMirror/)"
@@ -37,6 +38,7 @@ var CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEntr
 				opts.auth = {
 					bearer: auth.pass
 				};
+
 			} else {
 				opts.auth = {
 					user: auth.user,
@@ -58,15 +60,14 @@ var CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEntr
 				return;
 			}
 
-			var newEvents = [];
+			// console.log(data);
+			newEvents = [];
 
 			// limitFunction doesn't do much limiting, see comment re: the dates array in rrule section below as to why we need to do the filtering ourselves
-			var limitFunction = function (date, i) {
+			var limitFunction = function(date, i) {return true;};
-				return true;
-			};
 
 			var eventDate = function(event, time) {
-				return event[time].length === 8 ? moment(event[time], "YYYYMMDD") : moment(new Date(event[time]));
+				return (event[time].length === 8) ? moment(event[time], "YYYYMMDD") : moment(new Date(event[time]));
 			};
 
 			for (var e in data) {
@@ -80,7 +81,8 @@ var CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEntr
 					past = moment().startOf("day").subtract(maximumNumberOfDays, "days").toDate();
 				}
 
-				// FIXME: Ugly fix to solve the facebook birthday issue.
+				// FIXME:
+				// Ugly fix to solve the facebook birthday issue.
 				// Otherwise, the recurring events only show the birthday for next year.
 				var isFacebookBirthday = false;
 				if (typeof event.uid !== "undefined") {
@@ -90,12 +92,13 @@ var CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEntr
 				}
 
 				if (event.type === "VEVENT") {
+
 					var startDate = eventDate(event, "start");
 					var endDate;
 					if (typeof event.end !== "undefined") {
 						endDate = eventDate(event, "end");
 					} else if(typeof event.duration !== "undefined") {
-						var dur = moment.duration(event.duration);
+						dur=moment.duration(event.duration);
 						endDate = startDate.clone().add(dur);
 					} else {
 						if (!isFacebookBirthday) {
@@ -173,7 +176,8 @@ var CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEntr
 						var addedEvents = 0;
 
 						// can cause problems with e.g. birthdays before 1900
-						if ((rule.options && rule.origOptions && rule.origOptions.dtstart && rule.origOptions.dtstart.getFullYear() < 1900) || (rule.options && rule.options.dtstart && rule.options.dtstart.getFullYear() < 1900)) {
+						if(rule.options && rule.origOptions && rule.origOptions.dtstart && rule.origOptions.dtstart.getFullYear() < 1900 ||
+							rule.options && rule.options.dtstart && rule.options.dtstart.getFullYear() < 1900){
 							rule.origOptions.dtstart.setYear(1900);
 							rule.options.dtstart.setYear(1900);
 						}
@@ -196,14 +200,17 @@ var CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEntr
 						// because the logic below will filter out any recurrences that don"t actually belong within
 						// our display range.
 						// Would be great if there was a better way to handle this.
-						if (event.recurrences !== undefined) {
+						if (event.recurrences != undefined)
+						{
 							var pastMoment = moment(past);
 							var futureMoment = moment(future);
 
-							for (var r in event.recurrences) {
+							for (var r in event.recurrences)
+							{
 								// Only add dates that weren't already in the range we added from the rrule so that
 								// we don"t double-add those events.
-								if (moment(new Date(r)).isBetween(pastMoment, futureMoment) !== true) {
+								if (moment(new Date(r)).isBetween(pastMoment, futureMoment) != true)
+								{
 									dates.push(new Date(r));
 								}
 							}
@@ -219,29 +226,25 @@ var CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEntr
 							var curEvent = event;
 							var showRecurrence = true;
 
-							// Stop parsing this event's recurrences if we've already found maximumEntries worth of recurrences.
-							// (The logic below would still filter the extras, but the check is simple since we're already tracking the count)
-							if (addedEvents >= maximumEntries) {
-								break;
-							}
-
 							startDate = moment(date);
 
 							// For each date that we"re checking, it"s possible that there is a recurrence override for that one day.
-							if (curEvent.recurrences !== undefined && curEvent.recurrences[dateKey] !== undefined) {
+							if ((curEvent.recurrences != undefined) && (curEvent.recurrences[dateKey] != undefined))
+							{
 								// We found an override, so for this recurrence, use a potentially different title, start date, and duration.
 								curEvent = curEvent.recurrences[dateKey];
 								startDate = moment(curEvent.start);
 								duration = parseInt(moment(curEvent.end).format("x")) - parseInt(startDate.format("x"));
 							}
 							// If there"s no recurrence override, check for an exception date.  Exception dates represent exceptions to the rule.
-							else if (curEvent.exdate !== undefined && curEvent.exdate[dateKey] !== undefined) {
+							else if ((curEvent.exdate != undefined) && (curEvent.exdate[dateKey] != undefined))
+							{
 								// This date is an exception date, which means we should skip it in the recurrence pattern.
 								showRecurrence = false;
 							}
 
 							endDate = moment(parseInt(startDate.format("x")) + duration, "x");
-							if (startDate.format("x") === endDate.format("x")) {
+							if (startDate.format("x") == endDate.format("x")) {
 								endDate = endDate.endOf("day");
 							}
 
@@ -257,7 +260,7 @@ var CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEntr
 								showRecurrence = false;
 							}
 
-							if (showRecurrence === true && addedEvents < maximumEntries) {
+							if (showRecurrence === true) {
 								addedEvents++;
 								newEvents.push({
 									title: recurrenceTitle,
@@ -274,28 +277,29 @@ var CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEntr
 						}
 						// end recurring event parsing
 					} else {
+						// console.log("Single event ...");
 						// Single event.
-						var fullDayEvent = isFacebookBirthday ? true : isFullDayEvent(event);
+						var fullDayEvent = (isFacebookBirthday) ? true : isFullDayEvent(event);
 
 						if (includePastEvents) {
-							// Past event is too far in the past, so skip.
 							if (endDate < past) {
+								//console.log("Past event is too far in the past.  So skip: " + title);
 								continue;
 							}
 						} else {
-							// It's not a fullday event, and it is in the past, so skip.
 							if (!fullDayEvent && endDate < new Date()) {
+								//console.log("It's not a fullday event, and it is in the past. So skip: " + title);
 								continue;
 							}
 
-							// It's a fullday event, and it is before today, So skip.
 							if (fullDayEvent && endDate <= today) {
+								//console.log("It's a fullday event, and it is before today. So skip: " + title);
 								continue;
 							}
 						}
 
-						// It exceeds the maximumNumberOfDays limit, so skip.
 						if (startDate > future) {
+							//console.log("It exceeds the maximumNumberOfDays limit. So skip: " + title);
 							continue;
 						}
 
@@ -303,12 +307,13 @@ var CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEntr
 							continue;
 						}
 
-						// Adjust start date so multiple day events will be displayed as happening today even though they started some days ago already
+						// adjust start date so multiple day events will be displayed as happening today even though they started some days ago already
 						if (fullDayEvent && startDate <= today) {
 							startDate = moment(today);
 						}
 
 						// Every thing is good. Add it to the list.
+
 						newEvents.push({
 							title: title,
 							startDate: startDate.format("x"),
@@ -319,6 +324,7 @@ var CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEntr
 							geo: geo,
 							description: description
 						});
+
 					}
 				}
 			}
@@ -327,7 +333,8 @@ var CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEntr
 				return a.startDate - b.startDate;
 			});
 
-			events = newEvents.slice(0, maximumEntries);
+			//console.log(newEvents);
+			events = newEvents;
 
 			self.broadcastEvents();
 			scheduleTimer();
@@ -338,6 +345,7 @@ var CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEntr
 	 * Schedule the timer for the next update.
 	 */
 	var scheduleTimer = function() {
+		//console.log('Schedule update timer.');
 		clearTimeout(reloadTimer);
 		reloadTimer = setTimeout(function() {
 			fetchCalendar();
@@ -359,7 +367,7 @@ var CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEntr
 		var start = event.start || 0;
 		var startDate = new Date(start);
 		var end = event.end || 0;
-		if ((end - start) % (24 * 60 * 60 * 1000) === 0 && startDate.getHours() === 0 && startDate.getMinutes() === 0) {
+		if (((end - start) % (24 * 60 * 60 * 1000)) === 0 && startDate.getHours() === 0 && startDate.getMinutes() === 0) {
 			// Is 24 hours, and starts on the middle of the night.
 			return true;
 		}
@@ -399,7 +407,7 @@ var CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEntr
 	var getTitleFromEvent = function (event) {
 		var title = "Event";
 		if (event.summary) {
-			title = typeof event.summary.val !== "undefined" ? event.summary.val : event.summary;
+			title = (typeof event.summary.val !== "undefined") ? event.summary.val : event.summary;
 		} else if (event.description) {
 			title = event.description;
 		}
@@ -436,7 +444,7 @@ var CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEntr
 	 * Broadcast the existing events.
 	 */
 	this.broadcastEvents = function() {
-		Log.info("Calendar-Fetcher: Broadcasting " + events.length + " events.");
+		//console.log('Broadcasting ' + events.length + ' events.');
 		eventsReceivedCallback(self);
 	};
 

modules/default/calendar/node_helper.js

@@ -1,26 +1,30 @@
 /* Magic Mirror
  * Node Helper: Calendar
  *
- * By Michael Teeuw https://michaelteeuw.nl
+ * By Michael Teeuw http://michaelteeuw.nl
  * MIT Licensed.
  */
 
-const NodeHelper = require("node_helper");
+var NodeHelper = require("node_helper");
-const validUrl = require("valid-url");
+var validUrl = require("valid-url");
-const CalendarFetcher = require("./calendarfetcher.js");
+var CalendarFetcher = require("./calendarfetcher.js");
-const Log = require("../../../js/logger");
 
 module.exports = NodeHelper.create({
 	// Override start method.
 	start: function() {
-		Log.log("Starting node helper for: " + this.name);
+		var events = [];
+
 		this.fetchers = [];
+
+		console.log("Starting node helper for: " + this.name);
+
 	},
 
 	// Override socketNotificationReceived method.
 	socketNotificationReceived: function(notification, payload) {
 		if (notification === "ADD_CALENDAR") {
-			this.createFetcher(payload.url, payload.fetchInterval, payload.excludedEvents, payload.maximumEntries, payload.maximumNumberOfDays, payload.auth, payload.broadcastPastEvents, payload.id);
+			//console.log('ADD_CALENDAR: ');
+			this.createFetcher(payload.url, payload.fetchInterval, payload.excludedEvents, payload.maximumEntries, payload.maximumNumberOfDays, payload.auth, payload.broadcastPastEvents);
 		}
 	},
 
@@ -31,40 +35,42 @@ module.exports = NodeHelper.create({
 	 * attribute url string - URL of the news feed.
 	 * attribute reloadInterval number - Reload interval in milliseconds.
 	 */
-	createFetcher: function (url, fetchInterval, excludedEvents, maximumEntries, maximumNumberOfDays, auth, broadcastPastEvents, identifier) {
+
+	createFetcher: function(url, fetchInterval, excludedEvents, maximumEntries, maximumNumberOfDays, auth, broadcastPastEvents) {
 		var self = this;
 
 		if (!validUrl.isUri(url)) {
-			self.sendSocketNotification("INCORRECT_URL", { id: identifier, url: url });
+			self.sendSocketNotification("INCORRECT_URL", {url: url});
 			return;
 		}
 
 		var fetcher;
-		if (typeof self.fetchers[identifier + url] === "undefined") {
+		if (typeof self.fetchers[url] === "undefined") {
-			Log.log("Create new calendar fetcher for url: " + url + " - Interval: " + fetchInterval);
+			console.log("Create new calendar fetcher for url: " + url + " - Interval: " + fetchInterval);
-			fetcher = new CalendarFetcher(url, fetchInterval, excludedEvents, maximumEntries, maximumNumberOfDays, auth, broadcastPastEvents);
+			fetcher = new CalendarFetcher(url, fetchInterval, excludedEvents, maximumNumberOfDays, auth, broadcastPastEvents);
 
 			fetcher.onReceive(function(fetcher) {
+				//console.log('Broadcast events.');
+				//console.log(fetcher.events());
+
 				self.sendSocketNotification("CALENDAR_EVENTS", {
-					id: identifier,
 					url: fetcher.url(),
 					events: fetcher.events()
 				});
 			});
 
 			fetcher.onError(function(fetcher, error) {
-				Log.error("Calendar Error. Could not fetch calendar: ", fetcher.url(), error);
+				console.error("Calendar Error. Could not fetch calendar: ", fetcher.url(), error);
 				self.sendSocketNotification("FETCH_ERROR", {
-					id: identifier,
 					url: fetcher.url(),
 					error: error
 				});
 			});
 
-			self.fetchers[identifier + url] = fetcher;
+			self.fetchers[url] = fetcher;
 		} else {
-			Log.log("Use existing calendar fetcher for url: " + url);
+			//console.log('Use existing news fetcher for url: ' + url);
-			fetcher = self.fetchers[identifier + url];
+			fetcher = self.fetchers[url];
 			fetcher.broadcastEvents();
 		}