homebridge-eosstb 2.2.6 → 2.2.9

package/CHANGELOG.md

@@ -10,6 +10,17 @@ Please restart Homebridge after every plugin update.
 * Implement refreshToken capabilities
 
 
+## 2.2.9 (2023-05-29)
+* Fixed bug with access token expiring causing 401 unauthorised errors when refreshing channel list
+* Cleaned up some code
+
+
+## 2.2.8 (2023-05-22)
+* Updated iOS version references
+* Fixed bug causing Homebridge crash when master channel list is not yet loaded
+* Fixed bug causing Homebridge crash when any error occurs in refresh of master channel list
+
+
 ## 2.2.6 (2023-05-19)
 * Fixed some minor logging typos
 * Added logging of version info

package/README.md

@@ -72,7 +72,7 @@ In January 2023, an ARRIS VIP5002W appeared, which identifies itself as an APLST
 This plugin is not provided by Magenta or Telenet or Sunrise or Virgin Media or Ziggo any other affiliate of [UPC](https://en.wikipedia.org/wiki/UPC_Broadband). It is neither endorsed nor supported nor developed by [UPC](https://en.wikipedia.org/wiki/UPC_Broadband) or any affiliates. [UPC](https://en.wikipedia.org/wiki/UPC_Broadband) can change their systems at any time and that might break this plugin. But I hope not.
 
 ## Requirements
-* An Apple iPhone or iPad with iOS/iPadOS 14.0 (or later). Developed on iOS 14.1...16.4, earlier versions not tested.
+* An Apple iPhone or iPad with iOS/iPadOS 14.0 (or later). Developed on iOS 14.1...16.5, earlier versions not tested.
 * [Homebridge](https://homebridge.io/) v1.1.116 (or later). Developed on Homebridge 1.1.116....1.6.1, earlier versions not tested.
 * A TV subscription from one of the supported countries and TV providers.
 * An online account for viewing TV in the web app (often part of your TV package), see the table above.
@@ -115,7 +115,7 @@ This plugin is not provided by Magenta or Telenet or Sunrise or Virgin Media or
 
 * **Fully Configurable**: A large amount of configuration items exist to allow you to configure your plugin the way you want.
 
-* **Future Feature Support**: The plugin also supports current and target media state as well as closed captions, even though the Home app accessory cannot currently display or control this data in the home app (as at iOS 16.4). Hopefully, Apple will add support for these features in the future. You can however use this data in Home Automations or the Shortcuts app.
+* **Future Feature Support**: The plugin also supports current and target media state as well as closed captions, even though the Home app accessory cannot currently display or control this data in the home app (as at iOS 16.5). Hopefully, Apple will add support for these features in the future. You can however use this data in Home Automations or the Shortcuts app.
 
 
 
@@ -136,7 +136,7 @@ The set-top box accessory is exposed as a separate external accessory and each s
 4. **Add Accessory**: tap **More options...** to add the accessory manually.
 5. **Select an Accessory to Add to \<HomeName\>**: Select the accessory you want to add. You should see your set-top box here. If not, check your Homebridge config.
 6. Accept the **Uncertified Accessory** warning by tapping **Add Anyway**.
-7. **Enter HomeKit Setup Code**: Enter the **HomeKit Setup Code** (displayed in Homebridge under the QR code, format XXX-XX-XXX), or use the device's camera to scan the QR code in Homebridge and tap **Continue**.
+7. **Enter HomeKit Setup Code**: Enter the **HomeKit Setup Code** (displayed in Homebridge under the QR code, format XXXX-XXXX), or use the device's camera to scan the QR code in Homebridge and tap **Continue**.
 8. **Set-Top Box Location**: Select a room for your new accessory and tap **Continue**.
 9. **Set-Top Box Name**: Give your set-top box a different name if you wish (synchronised to your real set-top box, you can change this in the Home app later) and tap **Continue**.
 10. **Name TV Input Sources**: Re-name your TV input sources if you wish (you can change these in the Home app later) and tap **Continue**.
@@ -204,13 +204,13 @@ Services used in this set-top box accessory are:
 4. Input service. The input (TV channels) utilises one service per input. The maximum possible channels (inputs) are thus 100 - 3 = 97. I have limited the inputs to maximum 95, but you can override this in the config (helpful to reduce log entries when debugging). The inputs are hard limited to 95 inputs.
 
 ### Media State (Play/Pause) Limitations
-The eosstb plugin can detect the target and current media state and shows STOP, PLAY, PAUSE or LOADING (loading is displayed only for current media state when fast-forwarding or rewinding) in the Homebridge logs. Unfortunately, the Apple Home app cannot do anything with the media state (as at iOS 16.4) apart from allow you to read it in Shortcuts or Automations. Hopefully this will improve in the future.
+The eosstb plugin can detect the target and current media state and shows STOP, PLAY, PAUSE or LOADING (loading is displayed only for current media state when fast-forwarding or rewinding) in the Homebridge logs. Unfortunately, the Apple Home app cannot do anything with the media state (as at iOS 16.5) apart from allow you to read it in Shortcuts or Automations. Hopefully this will improve in the future.
 
 ### Recording State Limitations
 The eosstb plugin can detect the current recording state of the set-top box, both for local HDD-based recording (for boxes that have a HDD fitted) and for network recording. The plugin shows IDLE, ONGOING_NDVR or ONGOING_LOCALDVR in the Homebridge logs. DVR means digital video recorder; N for network and LOCAL for local HDD based recording. The Apple Home app cannot natively do anything with the recording state but the eosstb plugin uses it to set the inUse charateristic if the set-top box is turned on or is recording to the local HDD. This is useful in Shortcuts or Automations.
 
 ### Closed Captions Limitations
-The eosstb plugin can detect the closed captions state (**Subtitle options** in the set-top box menu) and shows ENABLED or DISABLED in the Homebridge logs. Unfortunately, the Apple Home app cannot do anything with the closed captions state (as at iOS 16.4) apart from allow you to read it in Shortcuts or Automations. Hopefully this will improve in the future.
+The eosstb plugin can detect the closed captions state (**Subtitle options** in the set-top box menu) and shows ENABLED or DISABLED in the Homebridge logs. Unfortunately, the Apple Home app cannot do anything with the closed captions state (as at iOS 16.5) apart from allow you to read it in Shortcuts or Automations. Hopefully this will improve in the future.
 
 ## Configuration
 Add a new platform to the platforms section of your homebridge `config.json`.

package/index.js

@@ -306,6 +306,7 @@ class stbPlatform {
 		this.config = config;
 		this.api = api;
     	this.stbDevices = []; // store stbDevice in this.stbDevices
+		this.masterChannelList = [];
 
 		// show some useful version info
 		this.log.info('%s v%s, node %s, homebridge v%s', packagejson.name, packagejson.version, process.version, this.api.serverVersion)
@@ -347,7 +348,33 @@ class stbPlatform {
 			this.checkSessionInterval = setInterval(this.sessionWatchdog.bind(this),SESSION_WATCHDOG_INTERVAL_MS);
 
 			// check for a channel list update every MASTER_CHANNEL_LIST_REFRESH_CHECK_INTERVAL_S seconds
-			this.checkChannelListInterval = setInterval(this.refreshMasterChannelList.bind(this),MASTER_CHANNEL_LIST_REFRESH_CHECK_INTERVAL_S * 1000);
+			//this.checkChannelListInterval = setInterval(this.refreshMasterChannelList.bind(this),MASTER_CHANNEL_LIST_REFRESH_CHECK_INTERVAL_S * 1000);
+
+
+			this.checkChannelListInterval = setInterval(() => {
+				// check if master channel list has expired. If it has, refresh auth token, then refresh channel list
+				if (this.config.debugLevel >= 1) { this.log.warn('stbPlatform: checkChannelListInterval Start'); }
+				if (this.masterChannelListExpiryDate <= Date.now()) {
+					// must check and refresh auth token before each call to refresh master channel list
+					this.refreshAccessToken()
+						.then(response => {
+							if (this.config.debugLevel >= 1) { this.log.warn('stbPlatform: refreshAccessToken completed OK'); }
+							return this.refreshMasterChannelList()
+						})
+						.then(response => {
+							if (this.config.debugLevel >= 1) { this.log.warn('stbPlatform: refreshMasterChannelList completed OK'); }
+							return true
+						})
+						.catch(error => {
+							if (error.code) {
+								this.log.warn('stbPlatform: checkChannelListInterval Error', (error.syscall || '') + ' ' + (error.code || '') + ' ' + (error.config.url || error.hostname || ''));
+							} else {
+								this.log.warn('stbPlatform: checkChannelListInterval Error', error);
+							}
+						})
+						if (this.config.debugLevel >= 1) { this.log.warn('stbPlatform: checkChannelListInterval end'); }
+				}
+			}, MASTER_CHANNEL_LIST_REFRESH_CHECK_INTERVAL_S * 1000 ) // need to pass ms
 
 			debug('stbPlatform:apievent :: didFinishLaunching end of code block')
 			//this.log('stbPlatform: end of code block');
@@ -564,17 +591,17 @@ class stbPlatform {
 				.then((objStbDevices) => {
 					this.log('Discovery completed');
 					this.log.debug('%s: ++++++ step 8: devices found:', watchdogInstance, this.devices.length)
-					this.log.debug('%s: ++++++ step 8: calling getJwtToken', watchdogInstance)
+					this.log.debug('%s: ++++++ step 8: calling getMqttToken', watchdogInstance)
 					errorTitle = 'Failed to start mqtt session';
-					debug(debugPrefix + 'calling getJwtToken')
-					return this.getJwtToken(this.session.username, this.session.accessToken, this.session.householdId);
+					debug(debugPrefix + 'calling getMqttToken')
+					return this.getMqttToken(this.session.username, this.session.accessToken, this.session.householdId);
 				})
-				.then((jwToken) => {
-					this.log.debug('%s: ++++++ step 9: getJwtToken token was retrieved, token %s', watchdogInstance, jwToken)
+				.then((mqttToken) => {
+					this.log.debug('%s: ++++++ step 9: getMqttToken token was retrieved, token %s', watchdogInstance, mqttToken)
 					this.log.debug('%s: ++++++ step 9: start mqtt client', watchdogInstance)
 					debug(debugPrefix + 'calling startMqttClient')
-					return this.startMqttClient(this, this.session.householdId, jwToken);  // returns true
-				})				
+					return this.startMqttClient(this, this.session.householdId, mqttToken);  // returns true
+				})
 				.catch(errorReason => {
 					// log any errors and set the currentSessionState
 					this.log.warn(errorTitle + ' - %s', errorReason);
@@ -678,6 +705,73 @@ class stbPlatform {
 	}
 
 
+	// get a new access token
+	async refreshAccessToken() {
+		return new Promise((resolve, reject) => {
+
+			// exit immediately if access token has not expired
+			if (this.session.accessTokenExpiry > Date.now()) {
+				if (this.config.debugLevel >= 1) { this.log.warn('refreshAccessToken: Access token has not expired yet. Next refresh will occur after %s', this.session.accessTokenExpiry.toLocaleString()); }
+				resolve(true);
+				return
+			}
+
+			if (this.config.debugLevel >= 1) { this.log.warn('refreshAccessToken: Access token has expired at %s. Requesting refresh', this.session.accessTokenExpiry.toLocaleString()); }
+
+			const axiosConfig = {
+				method: 'POST',
+				// https://prod.spark.sunrisetv.ch/auth-service/v1/authorization/refresh
+				url: countryBaseUrlArray[this.config.country.toLowerCase()] + '/auth-service/v1/authorization/refresh',
+				headers: {
+					'x-oesp-username': this.session.username
+				}, 
+				jar: cookieJar,
+				data: {
+					refreshToken: this.session.refreshToken,
+					username: this.config.username
+				}
+			};
+
+			if (this.config.debugLevel >=1) { this.log.warn('refreshAccessToken: Post auth refresh request to',axiosConfig.url); }
+			axiosWS(axiosConfig)
+				.then(response => {	
+					if (this.config.debugLevel >= 2) { 
+						this.log('refreshAccessToken: auth refresh response:',response.status, response.statusText);
+						this.log('refreshAccessToken: response data (saved to this.session):');
+						this.log(response.data); 
+						//this.log(response.headers); 
+					}
+					this.session = response.data;
+
+					// add an expiry date for the access token: 2 min (120000ms) after created date
+					this.session.accessTokenExpiry = new Date(new Date().getTime() + 2*60000);
+
+					// check if householdId exists, if so, we have authenticated ok
+					if (this.session.householdId) { currentSessionState = sessionState.AUTHENTICATED; }
+					this.log.debug('Session username:', this.session.username);
+					this.log.debug('Session householdId:', this.session.householdId);
+					this.log.debug('Session accessToken:', this.session.accessToken);
+					this.log.debug('Session accessTokenExpiry:', this.session.accessTokenExpiry);
+					this.log.debug('Session refreshToken:', this.session.refreshToken);
+					this.log.debug('Session refreshTokenExpiry:', this.session.refreshTokenExpiry);
+					// Robustness: Observed that new APLSTB Apollo box on NL did not always return username during session logon, so store username from settings if missing
+					if (this.session.username == '') { 
+						this.log.debug('Session username empty, setting to %s', this.config.username);
+						this.session.username = this.config.username; 
+					} else {
+						this.log.debug('Session username exists: %s', this.session.username);
+					}
+					currentSessionState = sessionState.CONNECTED;
+					this.currentStatusFault = Characteristic.StatusFault.NO_FAULT;
+					resolve(this.session.householdId) // resolve the promise with the householdId
+				})
+				.catch(error => {
+					this.log.debug('refreshAccessToken: error:', error);
+					reject(error); // reject the promise and return the error
+				});
+		})
+	}
+
 
 	// select the right session to create
 	async createSession(country) {
@@ -768,11 +862,16 @@ class stbPlatform {
 						this.log(response.data); 
 					}
 					this.session = response.data;
+
+					// add an expiry date for the access token: 2 min (120000ms) after created date
+					this.session.accessTokenExpiry = new Date(new Date().getTime() + 2*60000);
+
 					// check if householdId exists, if so, we have authenticated ok
 					if (this.session.householdId) { currentSessionState = sessionState.AUTHENTICATED; }
 					this.log.debug('Session username:', this.session.username);
 					this.log.debug('Session householdId:', this.session.householdId);
 					this.log.debug('Session accessToken:', this.session.accessToken);
+					this.log.debug('Session accessTokenExpiry:', this.session.accessTokenExpiry);
 					this.log.debug('Session refreshToken:', this.session.refreshToken);
 					this.log.debug('Session refreshTokenExpiry:', this.session.refreshTokenExpiry);
 					// Robustness: Observed that new APLSTB Apollo box on NL did not always return username during session logon, so store username from settings if missing
@@ -795,8 +894,10 @@ class stbPlatform {
 						errReason = 'try again later: ' + error.response.status + ' ' + (error.response.statusText || '');
 					} else if (error.response && error.response.status) {
 						errReason = 'check your internet connection: ' + error.response.status + ' ' + (error.response.statusText || '');
-					} else {
+					} else if (error.code) {
 						errReason = 'check your internet connection: ' + error.code + ' ' + (error.hostname || '');
+					} else {
+						errReason = 'unexpected error: ' + error;
 					}
 					//this.log('%s %s', errText, (errReason || ''));
 					this.log.debug('getSession: error:', error);
@@ -1336,7 +1437,7 @@ class stbPlatform {
 
 			// exit immediately if channel list has not expired
 			if (this.masterChannelListExpiryDate > Date.now()) {
-				if (this.config.debugLevel > 1) { this.log.warn('refreshMasterChannelList: Master channel list has not expired yet. Next refresh will occur after %s', this.masterChannelListExpiryDate.toLocaleString()); }
+				if (this.config.debugLevel >= 1) { this.log.warn('refreshMasterChannelList: Master channel list has not expired yet. Next refresh will occur after %s', this.masterChannelListExpiryDate.toLocaleString()); }
 				resolve(true);
 				return
 			}
@@ -1370,6 +1471,7 @@ class stbPlatform {
 				url: url,
 				headers: {
 					accept: '*/*',
+					"x-oesp-token": this.session.accessToken, // to try and avoid the 401 auth issues
 					'x-oesp-username': this.session.username
 				}
 			};
@@ -1378,6 +1480,11 @@ class stbPlatform {
 					if (this.config.debugLevel > 0) { this.log.warn('refreshMasterChannelList: response: %s %s', response.status, response.statusText); }
 					//this.log(response.data);
 
+					// the header contains the following:
+					// Cache-Control: max-age=600, public, stale-if-error=43200
+					// this could be used to set expiry date...
+
+
 					// set the masterChannelListExpiryDate to expire at now + MASTER_CHANNEL_LIST_VALID_FOR_S
 					this.masterChannelListExpiryDate =new Date(new Date().getTime() + (MASTER_CHANNEL_LIST_VALID_FOR_S * 1000));
 					//this.log('MasterChannelList valid until',this.masterChannelListExpiryDate.toLocaleString())
@@ -1423,7 +1530,6 @@ class stbPlatform {
 
 
 
-
 	// load all recording states and bookings
 	// called when a mqtt topic is received indicating a recording settings change
 	async refreshRecordings(householdId, callback) {
@@ -1965,28 +2071,28 @@ class stbPlatform {
 	// START session handler mqtt
   	//+++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-	// get a Json Web Token
-	async getJwtToken(oespUsername, accessToken, householdId){
+	// get the mqtt token
+	async getMqttToken(oespUsername, accessToken, householdId){
 		return new Promise((resolve, reject) => {
-			this.log.debug("Getting jwt token for householdId %s", householdId);
+			this.log.debug("Getting mqtt token for householdId %s", householdId);
 			// get a JSON web token from the supplied accessToken and householdId
-			if (this.config.debugLevel > 1) { this.log.warn('getJwtToken'); }
+			if (this.config.debugLevel > 1) { this.log.warn('getMqttToken'); }
 			// robustness checks
 			if (currentSessionState !== sessionState.CONNECTED) {
-				this.log.warn('Cannot get JWT token: currentSessionState incorrect:', currentSessionState);
+				this.log.warn('Cannot get mqtt token: currentSessionState incorrect:', currentSessionState);
 				return false;
 			}
 			if (!accessToken) {
-				this.log.warn('Cannot get JWT token: accessToken not set');
+				this.log.warn('Cannot get mqtt token: accessToken not set');
 				return false;
 			}
 
-			//this.log.warn('getJwtToken disabled while I build channel list');
+			//this.log.warn('getMqttToken disabled while I build channel list');
 			//return false;
 
-			const jwtAxiosConfig = {
+			const mqttAxiosConfig = {
 				method: 'GET',
-				url: countryBaseUrlArray[this.config.country.toLowerCase()] + '/tokens/jwt',
+				//url: countryBaseUrlArray[this.config.country.toLowerCase()] + '/tokens/jwt', prior to October 2022
 				// examples of auth-service/v1/mqtt/token urls:
 				// https://prod.spark.ziggogo.tv/auth-service/v1/mqtt/token
 				// https://prod.spark.sunrisetv.ch/auth-service/v1/mqtt/token
@@ -1996,23 +2102,22 @@ class stbPlatform {
 					'X-OESP-Username': oespUsername, 
 				}
 			};
-			this.log.debug("getJwtToken: jwtAxiosConfig:", jwtAxiosConfig)
-			axiosWS(jwtAxiosConfig)
+			this.log.debug("getMqttToken: mqttAxiosConfig:", mqttAxiosConfig)
+			axiosWS(mqttAxiosConfig)
 				.then(response => {	
 					if (this.config.debugLevel > 0) { 
-						this.log.warn("getJwtToken: response.data:", response.data)
+						this.log.warn("getMqttToken: response.data:", response.data)
 					}
-					//this.jwtToken = response.data.token; // store the token
 					mqttUsername = householdId; // used in sendKey to ensure that mqtt is connected
-					resolve(response.data.token); // resolve with the tokwn
+					resolve(response.data.token); // resolve with the token
 					//this.startMqttClient(this, householdId, response.data.token);  // this starts the mqtt session
 					
 				})
 				.catch(error => {
-					this.log.debug('getJwtToken error details:', error);
+					this.log.debug('getMqttToken error details:', error);
 					// set session flag to disconnected to force a session reconnect
 					currentSessionState = sessionState.DISCONNECTED;
-					reject('Failed to get jwtToken: ', error.code + ' ' + (error.hostname || ''));
+					reject('Failed to get mqtt token: ', error.code + ' ' + (error.hostname || ''));
 				});			
 		})
 	}

package/package.json

@@ -3,7 +3,7 @@
   "displayName": "Homebridge EOSSTB",
   "description": "homebridge-plugin - Add your set-top box to Homekit (for Magenta AT, Telenet BE, Sunrise CH, Virgin Media GB & IE, Ziggo NL)",
   "author": "Jochen Siegenthaler (https://github.com/jsiegenthaler/)",
-  "version": "2.2.6",
+  "version": "2.2.9",
   "platformname": "eosstb",
   "dependencies": {
     "axios-cookiejar-support": "^4.0.6",