Show calendar based on IP Address accessed

[sdetweil]

@MMRIZE said in Show calendar based on IP Address accessed:

My code is just small injection that does filtering out calendars by condition on socketNotificationReceived. No additional fetching is needed.

AFTER fetching… so throw away data, which we fetched , knowing we wouldn’t use it…

[Spinster]

@MMRIZE I tried it, but it is still showing the calendar even if there is no calendar defined for the ip. I edited only the config.js file and added your code. Modified the calendars to suite mine. I could see even if there is no calendar defined for a particular ip. Please advice

[Spinster]

@sdetweil Is this working? Should I try it, please advice

[MMRIZE]

@sdetweil
Still I can’t catch you.

[2024-05-07 15:03:33.741] [LOG]   Use existing calendarfetcher for url: https://ics.calendarlabs.com/76/mm3137/US_Holidays.ics

The log shows, duplicated URL would be integrated into existing fetcher, So unlike your words, 3 clients doesn’t make 3 duplicated wasted fetcher.

If clientA needs cal1, cal2, cal3 and clientB needs cal1, cal4, cal5. In this case server should fetch 5 calendars anyway. User may need cal1 ~ cal5 even on 1 screen or 2 screens, ther server’s burden would be the same.

The only aspect that could be considered a waste is the transmission of unusing event data for cal4 and cal5 to clientA, but unless it’s a performance issue with the data parsing algorithm, simply having large data size being transmitted isn’t particularly problematic. Moreover, since the data is dropped in my code as soon as the notification is received, it can’t be deemed a significant memory issue. If the data size itself becomes problematic, it implies there’s already a problem with the original calendar module using cal1, cal2, cal3, cal4, and cal5.

Too skeptic.

[MMRIZE]

@Spinster said in Show calendar based on IP Address accessed:

Modified the calendars to suite mine. I could see even if there is no calendar defined for a particular ip. Please advice

in the calendar config, I added clientMap.

{
	module: "calendar",
	header: "US Holidays",
	position: "top_left",
	config: {
		clientMap: {
			"192.168.178.63": [ "cal1", "cal2", "cal3" ],
			"192.168.178.22": [ "cal3", "cal4", "cal5" ]
		},
		calendars: [
			{
				url: "...",
				name: "cal1",
			},

...

[sdetweil]

@Spinster yes, the two pieces together

ipaddress:“…”
at each cal url block… only does one ipaddress per url

[Spinster]

@MMRIZE
Here is my config

	{
		module: "alert",
	},

	/*
	{
		module: "updatenotification",
		position: "top_bar"
	},*/
	{
		module: "clock",
		position: "top_left"
	},
	{
		module: "MMM-ModuleMonkeyPatch",
		config: {
			patches: [
				{
					module: "calendar",
					method: "socketNotificationReceived",
					patch: async function (original, args) {
						const [ notification, payload ] = args
						if (notification === "CALENDAR_EVENTS") {
							const calendarName = this.config.calendars.find((cal) => cal.url === payload?.url)?.name
							const r = await fetch('http://10.5.11.1:8080/modules/getip')
							const ip = JSON.parse(await r.text())?.[ 'address' ] ?? null
							console.log(ip)
							if (!this.config.clientMap?.[ ip ]?.includes(calendarName)) {
								return original(notification, { ...payload, events: [] })
							}
						}
						return original(notification, payload)
					}
				}
			]
		}
	},
	{
		module: "getip",
	},
	{
		module: "calendar",
		header: "Home Cal",
		position: "top_left",
		config: {
			clientMap: {
				"10.5.11.5": [ "cal1" ],
				"10.5.11.6": ["cal2"]
			},
			calendars: [
				{
					fetchInterval: 10 * 60 * 1000,
					symbol: "calendar-check",
					url: "https://homecals/xEzboFt7Kr3Yfiys?export",
					name: "cal1",

				}
			]
		}
	}

This is showing both 10.5.11.5 and 10.5.11.6 the same calendar. Though 10.5.11.6 should not have any calendar since it is not defined. Even I tried without an entry of 10.5.11.6 in calendar map but it still showing the calendar. What am I doing wrong. Please advice

[Spinster]

@MMRIZE I even added the calendarmap, I hope you seen my config.js sent earlier

[Spinster]

@Spinster said in Show calendar based on IP Address accessed:

@MMRIZE I even added the calendarmap, I hope you seen my config.js sent earlier

Sorry, i think I have not installed Monkey module, will install and check again

[Spinster]

@sdetweil

Should I use your earlier code and this? Please advise

[sdetweil]

@Spinster yes you need both

I am away from my system for another couple hours

will collapse to one post then

[sdetweil]

@Spinster ok, here is the final

in calendar.js

add these variables

		updateOnFetch: true,
		useIPAddress: false     // add config var
	},
	timerHandle:null,                 // add this
	ourIPAddress:null,              // add this 
	requiresVersion: "2.1.0",

change this

	// Override start method.
	start () {

to
this

	// Override start method.
	startup () {

add this code

			let ip_match = false;
			if(this.config.useIPAddress){
			 const client_ip_for_this_calendar = this.getCalendarProperty(calendar.url, "ipaddress", null)
			 if(this.ourIPAddress)
			 	  ip_match = client_ip_for_this_calendar.includes(this.ourIPAddress)
			}
			if(this.config.useIPAddress == false || ip_match==true)
			  this.addCalendar(calendar.url, calendar.auth, calendarConfig);   // old original   line 

and add this routine somewhere

  notificationReceived(notification,payload){
  	if(notification === 'ALL_MODULES_STARTED'){
  		// if we are using ip address checking
  		if(this.config.useIPAddress){
  			// loop thru all the modules
  			let m = MM.getModules().withClass("getip");
  			if(m.length){
  				// if getip is configured and not disabled
  				if((m[0].disabled== undefined || (m[0].disabled != undefined && m[0].disabled == false)) ){
  					// start a timer to wait for getip to finish
  					this.timerHandle = setInterval(()=>{
  						// get its dom content
  						let client_ip = document.getElementById("getip_address")
  						// if we found id
  						if(client_ip !== null){
  							// stop the timer
  							clearInterval(this.timerHandle)
  							// save our IP address, only need to look it up once
  							this.ourIPAddress=client_ip.innerText
  							// call startup
  							this.startup()
  						}
  					}, 500)
  				}
  			}
  			// thru the loop, didn't start a timer, module not found
			  if(this.timerHandle === null){
					// didn't find getip
					// module not found, can't do this later either
					this.config.useIPAddress = false;
					this.startup()
				}
			}
  		// use default
  		else
  			this.startup()
  	} 
  	else if (notification === "FETCH_CALENDAR") {
			this.sendSocketNotification(notification, { url: payload.url, id: this.identifier+(this.ourIPAddress?'_'+this.ourIPAddress:'') });
		}
  },

and in the socketNotificationReceived routine
change this

	socketNotificationReceived (notification, payload) {
		if (notification === "FETCH_CALENDAR") {
			this.sendSocketNotification(notification, { url: payload.url, id: this.identifier });
		}

		if (this.identifier !== payload.id) {
			return;
		}

to this

	socketNotificationReceived (notification, payload) {

		if (this.identifier+(this.ourIPAddress?'_'+this.ourIPAddress:'') !== payload.id) {
			return;
		}

and in the addCalendar routine
change this

		id: this.identifier,

to this

		id: this.identifier+(this.ourIPAddress?'_'+this.ourIPAddress:''),

to use

add the getip module to config.js, anywhere
add property to calendar above the calendars list (but still inside the config:{}{ section)

useIPAddress:true,

in any cal url block you want to be sensitive to IP address add property

    ipaddress:"xxx yyy zzz",  // space separated list of client ipaddresses this calendar can be displayed on

andhow

[Spinster]

@MMRIZE

After installing MonkeyPatch and adding the patch you have mentioned, I get the following error message when I run , npm run config:check
[2024-05-07 23:32:55.179] [INFO] Checking file… /home/vjkings/MagicMirror/config/config.js
[2024-05-07 23:32:55.222] [ERROR] Your configuration file contains syntax errors :(
[2024-05-07 23:32:55.223] [ERROR] Line 56 column 20: Parsing error: Unexpected token function

As per config.js, Line 56 is this

patch: async function (original, args) {

Whole section of patch as follows
patch: async function (original, args) {
const [ notification, payload ] = args
if (notification === “CALENDAR_EVENTS”) {
const calendarName = this.config.calendars.find((cal) => cal.url === payload?.url)?.name
const r = await fetch(‘http://192.168.1.4:8080/modules/getip’)
const ip = JSON.parse(await r.text())?.[ ‘address’ ] ?? null
if (!this.config.clientMap?.[ ip ]?.includes(calendarName)) {
return original(notification, { …payload, events: [] })
}
}
return original(notification, payload)
}

If I ignore the error and run the server, I don’t get any calendar and it just says Loading… in the mirror page
What is the reason for the error. Please advice

[Spinster]

@sdetweil

Wow, Clear, will try it and provide feedback please.

[Spinster]

@sdetweil

Hi,
I made all the changes you have mentioned, it is working!!!. Thank you so much for the efforts.
However, following are the observation,
When I add the config.js with useIPAddress: true (calendar.js has the entry of useIPAddress:false in its default), there is no effect, however in calendar.js if I set the useIPAddress: true, it is working, I don’t understand why the configuration settings are not taken.

I clearly added the useIPAddress: true before the calendars declared as part of the module configuration. Please advice how to fix this.

I also have doubt on when we override the start to startup, how the notificationreceived is called. What happens when there is no start in the module.

In fact this is the first time, I have added code without understanding of anything :).

Please help me with configuration settings (config.js) to get it effected than hardcoding it to calendar.js

[sdetweil]

@Spinster can you show the calendar config, you can leave out the calendars:[] list entries

start is optional. but only called once
getip has not placed its content yet.

the notification ALL_MODULES_STARTED is sent be the system when all the
modules start methods have been called

from the module development doc

[Spinster]

@sdetweil
Thank you for the details.

As required, my calendar config as follows

	{
		module: "getip",
		position:"bottom_left"
	},
	{
		module: "calendar",
		useIPAddress: true,
		header: "My Calendars",
		position: "top_left",
		config: {
			calendars: [
				{
					name: "cal01",
					fetchInterval: 5 * 60 * 1000,
					symbol: "calendar-check",
					url: "https://mycalendar/xEzboFt7Kr3Yfiys?export",
					ipaddress: "10.5.18.252 127.0.0.1 10.5.14.104",

				},
				{
					name: "cal02",
					fetchInterval: 10 * 60 * 1000,
					//useIPAddress: true,
					symbol: "calendar-check",
					url: "https://mycalendar/4aK7xZPQkGKz6nCZ?export",
					ipaddress: "10.5.11.5",

				}
			]
		}
	},

Please let me know if I have done any mistake

[sdetweil]

@Spinster yes, it has to be inside the
config:{} section

everything outside config are MagicMirror properties about a module
see
https://docs.magicmirror.builders/modules/configuration.html#example

config is properties FOR the module and override what is defined in the module defaults:{} object

[Spinster]

@sdetweil

I made the change and it first showed correctly, but when I refresh any one of the client, the other client is getting both the calendars. What is wrong? Here is my updated calendar.js as suggested by you.

/* global CalendarUtils */

Module.register("calendar", {
	// Define module defaults
	defaults: {
		maximumEntries: 10, // Total Maximum Entries
		maximumNumberOfDays: 365,
		limitDays: 0, // Limit the number of days shown, 0 = no limit
		pastDaysCount: 0,
		displaySymbol: true,
		defaultSymbol: "calendar-alt", // Fontawesome Symbol see https://fontawesome.com/cheatsheet?from=io
		defaultSymbolClassName: "fas fa-fw fa-",
		showLocation: false,
		displayRepeatingCountTitle: false,
		defaultRepeatingCountTitle: "",
		maxTitleLength: 25,
		maxLocationTitleLength: 25,
		wrapEvents: false, // Wrap events to multiple lines breaking at maxTitleLength
		wrapLocationEvents: false,
		maxTitleLines: 3,
		maxEventTitleLines: 3,
		fetchInterval: 60 * 60 * 1000, // Update every hour
		animationSpeed: 2000,
		fade: true,
		fadePoint: 0.25, // Start on 1/4th of the list.
		urgency: 7,
		timeFormat: "relative",
		dateFormat: "MMM Do",
		dateEndFormat: "LT",
		fullDayEventDateFormat: "MMM Do",
		showEnd: false,
		getRelative: 6,
		hidePrivate: false,
		hideOngoing: false,
		hideTime: false,
		hideDuplicates: true,
		showTimeToday: false,
		colored: false,
		forceUseCurrentTime: false,
		tableClass: "small",
		calendars: [
			{
				symbol: "calendar-alt",
				url: "https://www.calendarlabs.com/templates/ical/US-Holidays.ics"
			}
		],
		customEvents: [
			// Array of {keyword: "", symbol: "", color: "", eventClass: ""} where Keyword is a regexp and symbol/color/eventClass are to be applied for matched
			{ keyword: ".*", transform: { search: "De verjaardag van ", replace: "" } },
			{ keyword: ".*", transform: { search: "'s birthday", replace: "" } }
		],
		locationTitleReplace: {
			"street ": ""
		},
		broadcastEvents: true,
		excludedEvents: [],
		sliceMultiDayEvents: false,
		broadcastPastEvents: false,
		nextDaysRelative: false,
		selfSignedCert: false,
		coloredText: false,
		coloredBorder: false,
		coloredSymbol: false,
		coloredBackground: false,
		limitDaysNeverSkip: false,
		flipDateHeaderTitle: false,
		updateOnFetch: true,
		useIPAddress: false,// add config var
	},

	timerHandle:null,                 // add this
	ourIPAddress:null,              // add this 
	requiresVersion: "2.1.0",

	// Define required scripts.
	getStyles () {
		return ["calendar.css", "font-awesome.css"];
	},

	// Define required scripts.
	getScripts () {
		return ["calendarutils.js", "moment.js"];
	},

	// Define required translations.
	getTranslations () {
		// The translations for the default modules are defined in the core translation files.
		// Therefore we can just return false. Otherwise we should have returned a dictionary.
		// If you're trying to build your own module including translations, check out the documentation.
		return false;
	},

	// Override start method.
	startup () {

		//const ip = settings.detectIp(req)
		Log.info(`Starting module: ${this.name}`);
		Log.info(`Vijay starup Starting module: ${this.name}`);

		if (this.config.colored) {
			Log.warn("Your are using the deprecated config values 'colored'. Please switch to 'coloredSymbol' & 'coloredText'!");
			this.config.coloredText = true;
			this.config.coloredSymbol = true;
		}
		if (this.config.coloredSymbolOnly) {
			Log.warn("Your are using the deprecated config values 'coloredSymbolOnly'. Please switch to 'coloredSymbol' & 'coloredText'!");
			this.config.coloredText = false;
			this.config.coloredSymbol = true;
		}

		// Set locale.
		moment.updateLocale(config.language, CalendarUtils.getLocaleSpecification(config.timeFormat));

		// clear data holder before start
		this.calendarData = {};

		// indicate no data available yet
		this.loaded = false;

		// data holder of calendar url. Avoid fade out/in on updateDom (one for each calendar update)
		this.calendarDisplayer = {};

		this.config.calendars.forEach((calendar) => {
			calendar.url = calendar.url.replace("webcal://", "http://");

			const calendarConfig = {
				maximumEntries: calendar.maximumEntries,
				maximumNumberOfDays: calendar.maximumNumberOfDays,
				pastDaysCount: calendar.pastDaysCount,
				broadcastPastEvents: calendar.broadcastPastEvents,
				selfSignedCert: calendar.selfSignedCert,
				excludedEvents: calendar.excludedEvents,
				fetchInterval: calendar.fetchInterval
			};

			if (typeof calendar.symbolClass === "undefined" || calendar.symbolClass === null) {
				calendarConfig.symbolClass = "";
			}
			if (typeof calendar.titleClass === "undefined" || calendar.titleClass === null) {
				calendarConfig.titleClass = "";
			}
			if (typeof calendar.timeClass === "undefined" || calendar.timeClass === null) {
				calendarConfig.timeClass = "";
			}

			// we check user and password here for backwards compatibility with old configs
			if (calendar.user && calendar.pass) {
				Log.warn("Deprecation warning: Please update your calendar authentication configuration.");
				Log.warn("https://docs.magicmirror.builders/modules/calendar.html#configuration-options");
				calendar.auth = {
					user: calendar.user,
					pass: calendar.pass
				};
			}

			let ip_match = false;
			if(this.config.useIPAddress){
			 const client_ip_for_this_calendar = this.getCalendarProperty(calendar.url, "ipaddress", null)
			 if(this.ourIPAddress)
			 	  ip_match = client_ip_for_this_calendar.includes(this.ourIPAddress)
			}
			if(this.config.useIPAddress == false || ip_match==true)
			  this.addCalendar(calendar.url, calendar.auth, calendarConfig);   // old original   line 
			

			//this.addCalendar(calendar.url, calendar.auth, calendarConfig);
		});

		// for backward compatibility titleReplace
		if (typeof this.config.titleReplace !== "undefined") {
			Log.warn("Deprecation warning: Please consider upgrading your calendar titleReplace configuration to customEvents.");
			for (const [titlesearchstr, titlereplacestr] of Object.entries(this.config.titleReplace)) {
				this.config.customEvents.push({ keyword: ".*", transform: { search: titlesearchstr, replace: titlereplacestr } });
			}
		}

		this.selfUpdate();
	},

	// Override socket notification handler.
	socketNotificationReceived (notification, payload) {
		if (notification === "FETCH_CALENDAR") {
			this.sendSocketNotification(notification, { url: payload.url, id: this.identifier });
		}

		if (this.identifier !== payload.id) {
			return;
		}

		if (notification === "CALENDAR_EVENTS") {
			Log.warn("Calendar Events called Vijay");
			if (this.hasCalendarURL(payload.url)) {
				this.calendarData[payload.url] = payload.events;
				this.error = null;
				this.loaded = true;

				if (this.config.broadcastEvents) {
					this.broadcastEvents();
				}

				if (!this.config.updateOnFetch) {
					if (this.calendarDisplayer[payload.url] === undefined) {
						// calendar will never displayed, so display it
						this.updateDom(this.config.animationSpeed);
						// set this calendar as displayed
						this.calendarDisplayer[payload.url] = true;
					} else {
						Log.debug("[Calendar] DOM not updated waiting self update()");
					}
					return;
				}
			}
		} else if (notification === "CALENDAR_ERROR") {
			let error_message = this.translate(payload.error_type);
			this.error = this.translate("MODULE_CONFIG_ERROR", { MODULE_NAME: this.name, ERROR: error_message });
			this.loaded = true;
		}

		this.updateDom(this.config.animationSpeed);
	},

	eventEndingWithinNextFullTimeUnit (event, ONE_DAY) {
		const now = new Date();
		return event.endDate - now <= ONE_DAY;
	},

	notificationReceived(notification,payload){
		if(notification === 'ALL_MODULES_STARTED') {
			// if we are using ip address checking
			Log.info(`Vijay Calling : ${this.name}`);
			console.log("Vijay : Calendar notificationReceived called");
			if(this.config.useIPAddress){
				console.log("Vijay : Calendar Using IP Address");
				// find our dependent module in config.js, returns an array []
				let m = MM.getModules().withClass("getip");
				if(m.length){
					// if getip is not disabled
					if((m[0].disabled == undefined || (m[0].disabled != undefined && m[0].disabled == false)) ){
						// start a timer to wait for getip to finish
						this.timerHandle = setInterval(()=>{
							// get its dom content
							let client_ip = document.getElementById("getip_address")
							// if we found id
							if(client_ip !== null){
								// stop the timer
								clearInterval(this.timerHandle)
								// save our IP address, only need to look it up once
								this.ourIPAddress=client_ip.innerText
								// call startup
								this.startup()
							}
						}, 500)
					}
				}
				// didn't start a timer, module not found
				  if(this.timerHandle === null){
						// didn't find getip
						// module not found, can't do this later either      
						// turn off address checking                                
						this.config.useIPAddress = false;
						// start fetching calendars      
						Log.info(`Vijay No timer, useIP set to false: ${this.name}`);
						this.startup()
				   }
			}
			// use old approach
			else{
				Log.info(`Vijay timer available :  ${this.name}`);
				this.startup()
			}
		}
	},

Please let me know if I have to do something about this.

[sdetweil]

@Spinster sorry, explain
the other client

on refresh, everything is the same in the module.

each module has a unique id assigned, based on its placement in config.js
calendar sends its id down to its helper
and the helper sends the id back on response. as the response mechanism is a broadcast to all connected clients.
the clients then check to see if this response is for their request.
from code posted

also, please start using code block wrapper for all config, code and error postings

paste text into the message editor
empty line above and below
select that pasted text
hit the editor button </>