2022-01-26 23:09:26 +01:00
|
|
|
/* MagicMirror²
|
2016-03-31 11:05:32 +02:00
|
|
|
* Node Helper: Newsfeed
|
|
|
|
*
|
2020-04-28 23:05:28 +02:00
|
|
|
* By Michael Teeuw https://michaelteeuw.nl
|
2016-03-31 11:05:32 +02:00
|
|
|
* MIT Licensed.
|
|
|
|
*/
|
|
|
|
|
2020-05-25 23:03:19 +02:00
|
|
|
const NodeHelper = require("node_helper");
|
2021-02-18 19:14:53 +01:00
|
|
|
const Log = require("logger");
|
2023-03-22 23:53:10 +01:00
|
|
|
const NewsfeedFetcher = require("./newsfeedfetcher");
|
2016-03-30 12:20:46 +02:00
|
|
|
|
2016-03-30 14:49:37 +02:00
|
|
|
module.exports = NodeHelper.create({
|
2020-05-25 23:03:19 +02:00
|
|
|
// Override start method.
|
2020-05-11 22:22:32 +02:00
|
|
|
start: function () {
|
2023-03-19 14:32:23 +01:00
|
|
|
Log.log(`Starting node helper for: ${this.name}`);
|
2016-03-30 14:49:37 +02:00
|
|
|
this.fetchers = [];
|
|
|
|
},
|
2016-03-30 12:20:46 +02:00
|
|
|
|
2020-05-25 23:03:19 +02:00
|
|
|
// Override socketNotificationReceived received.
|
2020-05-11 22:22:32 +02:00
|
|
|
socketNotificationReceived: function (notification, payload) {
|
2016-04-05 14:35:11 -04:00
|
|
|
if (notification === "ADD_FEED") {
|
2016-04-20 14:39:38 +02:00
|
|
|
this.createFetcher(payload.feed, payload.config);
|
2016-03-30 14:49:37 +02:00
|
|
|
}
|
|
|
|
},
|
2016-03-30 12:20:46 +02:00
|
|
|
|
2020-08-03 11:36:29 +02:00
|
|
|
/**
|
2017-03-30 21:15:51 +02:00
|
|
|
* Creates a fetcher for a new feed if it doesn't exist yet.
|
|
|
|
* Otherwise it reuses the existing one.
|
2021-05-15 14:49:04 +02:00
|
|
|
* @param {object} feed The feed object
|
|
|
|
* @param {object} config The configuration object
|
2016-03-30 12:20:46 +02:00
|
|
|
*/
|
2020-05-11 22:22:32 +02:00
|
|
|
createFetcher: function (feed, config) {
|
2020-07-12 12:45:32 +02:00
|
|
|
const url = feed.url || "";
|
|
|
|
const encoding = feed.encoding || "UTF-8";
|
|
|
|
const reloadInterval = feed.reloadInterval || config.reloadInterval || 5 * 60 * 1000;
|
2022-10-17 21:38:08 +02:00
|
|
|
let useCorsProxy = feed.useCorsProxy;
|
|
|
|
if (useCorsProxy === undefined) useCorsProxy = true;
|
2016-04-20 14:39:38 +02:00
|
|
|
|
2021-03-16 19:25:23 +01:00
|
|
|
try {
|
|
|
|
new URL(url);
|
|
|
|
} catch (error) {
|
2021-05-02 10:24:22 +02:00
|
|
|
Log.error("Newsfeed Error. Malformed newsfeed url: ", url, error);
|
|
|
|
this.sendSocketNotification("NEWSFEED_ERROR", { error_type: "MODULE_ERROR_MALFORMED_URL" });
|
2016-03-30 12:20:46 +02:00
|
|
|
return;
|
|
|
|
}
|
2016-03-29 15:44:43 +02:00
|
|
|
|
2020-07-12 12:45:32 +02:00
|
|
|
let fetcher;
|
|
|
|
if (typeof this.fetchers[url] === "undefined") {
|
2023-03-19 14:32:23 +01:00
|
|
|
Log.log(`Create new newsfetcher for url: ${url} - Interval: ${reloadInterval}`);
|
2022-10-17 21:38:08 +02:00
|
|
|
fetcher = new NewsfeedFetcher(url, reloadInterval, encoding, config.logFeedWarnings, useCorsProxy);
|
2016-04-03 19:52:13 +02:00
|
|
|
|
2020-07-12 12:45:32 +02:00
|
|
|
fetcher.onReceive(() => {
|
|
|
|
this.broadcastFeeds();
|
2016-03-30 14:49:37 +02:00
|
|
|
});
|
|
|
|
|
2020-07-12 12:45:32 +02:00
|
|
|
fetcher.onError((fetcher, error) => {
|
2021-05-02 10:24:22 +02:00
|
|
|
Log.error("Newsfeed Error. Could not fetch newsfeed: ", url, error);
|
|
|
|
let error_type = NodeHelper.checkFetchError(error);
|
|
|
|
this.sendSocketNotification("NEWSFEED_ERROR", {
|
|
|
|
error_type
|
2016-03-30 14:49:37 +02:00
|
|
|
});
|
|
|
|
});
|
|
|
|
|
2020-07-12 12:45:32 +02:00
|
|
|
this.fetchers[url] = fetcher;
|
2016-03-30 14:49:37 +02:00
|
|
|
} else {
|
2023-03-19 14:32:23 +01:00
|
|
|
Log.log(`Use existing newsfetcher for url: ${url}`);
|
2020-07-12 12:45:32 +02:00
|
|
|
fetcher = this.fetchers[url];
|
2016-03-30 14:49:37 +02:00
|
|
|
fetcher.setReloadInterval(reloadInterval);
|
|
|
|
fetcher.broadcastItems();
|
|
|
|
}
|
2016-03-29 15:44:43 +02:00
|
|
|
|
2016-03-30 14:49:37 +02:00
|
|
|
fetcher.startFetch();
|
2016-04-20 14:39:38 +02:00
|
|
|
},
|
|
|
|
|
2020-08-03 11:36:29 +02:00
|
|
|
/**
|
2016-12-30 17:47:33 -03:00
|
|
|
* Creates an object with all feed items of the different registered feeds,
|
2016-04-20 14:39:38 +02:00
|
|
|
* and broadcasts these using sendSocketNotification.
|
|
|
|
*/
|
2020-05-11 22:22:32 +02:00
|
|
|
broadcastFeeds: function () {
|
2021-03-16 21:15:19 +01:00
|
|
|
const feeds = {};
|
|
|
|
for (let f in this.fetchers) {
|
2016-04-20 14:39:38 +02:00
|
|
|
feeds[f] = this.fetchers[f].items();
|
|
|
|
}
|
|
|
|
this.sendSocketNotification("NEWS_ITEMS", feeds);
|
2016-03-30 14:49:37 +02:00
|
|
|
}
|
|
|
|
});
|