/* Magic Mirror * Module: NewsFeed * * By Michael Teeuw https://michaelteeuw.nl * MIT Licensed. */ Module.register("newsfeed", { // Default module config. defaults: { feeds: [ { title: "New York Times", url: "https://rss.nytimes.com/services/xml/rss/nyt/HomePage.xml", encoding: "UTF-8" //ISO-8859-1 } ], showSourceTitle: true, showPublishDate: true, broadcastNewsFeeds: true, broadcastNewsUpdates: true, showDescription: false, wrapTitle: true, wrapDescription: true, truncDescription: true, lengthDescription: 400, hideLoading: false, reloadInterval: 5 * 60 * 1000, // every 5 minutes updateInterval: 10 * 1000, animationSpeed: 2.5 * 1000, maxNewsItems: 0, // 0 for unlimited ignoreOldItems: false, ignoreOlderThan: 24 * 60 * 60 * 1000, // 1 day removeStartTags: "", removeEndTags: "", startTags: [], endTags: [], prohibitedWords: [], scrollLength: 500, logFeedWarnings: false }, // Define required scripts. getScripts: function () { return ["moment.js"]; }, // Define required translations. getTranslations: function () { // The translations for the default modules are defined in the core translation files. // Therefor 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; }, // Define start sequence. start: function () { Log.info("Starting module: " + this.name); // Set locale. moment.locale(config.language); this.newsItems = []; this.loaded = false; this.activeItem = 0; this.scrollPosition = 0; this.registerFeeds(); this.isShowingDescription = this.config.showDescription; }, // Override socket notification handler. socketNotificationReceived: function (notification, payload) { if (notification === "NEWS_ITEMS") { this.generateFeed(payload); if (!this.loaded) { this.scheduleUpdateInterval(); } this.loaded = true; } }, // Override dom generator. getDom: function () { var wrapper = document.createElement("div"); if (this.config.feedUrl) { wrapper.className = "small bright"; wrapper.innerHTML = this.translate("MODULE_CONFIG_CHANGED", { MODULE_NAME: "Newsfeed" }); return wrapper; } if (this.activeItem >= this.newsItems.length) { this.activeItem = 0; } if (this.newsItems.length > 0) { // this.config.showFullArticle is a run-time configuration, triggered by optional notifications if (!this.config.showFullArticle && (this.config.showSourceTitle || this.config.showPublishDate)) { var sourceAndTimestamp = document.createElement("div"); sourceAndTimestamp.className = "newsfeed-source light small dimmed"; if (this.config.showSourceTitle && this.newsItems[this.activeItem].sourceTitle !== "") { sourceAndTimestamp.innerHTML = this.newsItems[this.activeItem].sourceTitle; } if (this.config.showSourceTitle && this.newsItems[this.activeItem].sourceTitle !== "" && this.config.showPublishDate) { sourceAndTimestamp.innerHTML += ", "; } if (this.config.showPublishDate) { sourceAndTimestamp.innerHTML += moment(new Date(this.newsItems[this.activeItem].pubdate)).fromNow(); } if ((this.config.showSourceTitle && this.newsItems[this.activeItem].sourceTitle !== "") || this.config.showPublishDate) { sourceAndTimestamp.innerHTML += ":"; } wrapper.appendChild(sourceAndTimestamp); } //Remove selected tags from the beginning of rss feed items (title or description) if (this.config.removeStartTags === "title" || this.config.removeStartTags === "both") { for (let f = 0; f < this.config.startTags.length; f++) { if (this.newsItems[this.activeItem].title.slice(0, this.config.startTags[f].length) === this.config.startTags[f]) { this.newsItems[this.activeItem].title = this.newsItems[this.activeItem].title.slice(this.config.startTags[f].length, this.newsItems[this.activeItem].title.length); } } } if (this.config.removeStartTags === "description" || this.config.removeStartTags === "both") { if (this.isShowingDescription) { for (let f = 0; f < this.config.startTags.length; f++) { if (this.newsItems[this.activeItem].description.slice(0, this.config.startTags[f].length) === this.config.startTags[f]) { this.newsItems[this.activeItem].description = this.newsItems[this.activeItem].description.slice(this.config.startTags[f].length, this.newsItems[this.activeItem].description.length); } } } } //Remove selected tags from the end of rss feed items (title or description) if (this.config.removeEndTags) { for (let f = 0; f < this.config.endTags.length; f++) { if (this.newsItems[this.activeItem].title.slice(-this.config.endTags[f].length) === this.config.endTags[f]) { this.newsItems[this.activeItem].title = this.newsItems[this.activeItem].title.slice(0, -this.config.endTags[f].length); } } if (this.isShowingDescription) { for (let f = 0; f < this.config.endTags.length; f++) { if (this.newsItems[this.activeItem].description.slice(-this.config.endTags[f].length) === this.config.endTags[f]) { this.newsItems[this.activeItem].description = this.newsItems[this.activeItem].description.slice(0, -this.config.endTags[f].length); } } } } if (!this.config.showFullArticle) { var title = document.createElement("div"); title.className = "newsfeed-title bright medium light" + (!this.config.wrapTitle ? " no-wrap" : ""); title.innerHTML = this.newsItems[this.activeItem].title; wrapper.appendChild(title); } if (this.isShowingDescription) { var description = document.createElement("div"); description.className = "newsfeed-desc small light" + (!this.config.wrapDescription ? " no-wrap" : ""); var txtDesc = this.newsItems[this.activeItem].description; description.innerHTML = this.config.truncDescription ? (txtDesc.length > this.config.lengthDescription ? txtDesc.substring(0, this.config.lengthDescription) + "..." : txtDesc) : txtDesc; wrapper.appendChild(description); } if (this.config.showFullArticle) { var fullArticle = document.createElement("iframe"); fullArticle.className = ""; fullArticle.style.width = "100vw"; // very large height value to allow scrolling fullArticle.height = "3000"; fullArticle.style.height = "3000"; fullArticle.style.top = "0"; fullArticle.style.left = "0"; fullArticle.style.border = "none"; fullArticle.src = this.getActiveItemURL(); fullArticle.style.zIndex = 1; wrapper.appendChild(fullArticle); } if (this.config.hideLoading) { this.show(); } } else { if (this.config.hideLoading) { this.hide(); } else { wrapper.innerHTML = this.translate("LOADING"); wrapper.className = "small dimmed"; } } return wrapper; }, getActiveItemURL: function () { return typeof this.newsItems[this.activeItem].url === "string" ? this.newsItems[this.activeItem].url : this.newsItems[this.activeItem].url.href; }, /* registerFeeds() * registers the feeds to be used by the backend. */ registerFeeds: function () { for (var f in this.config.feeds) { var feed = this.config.feeds[f]; this.sendSocketNotification("ADD_FEED", { feed: feed, config: this.config }); } }, /* generateFeed() * Generate an ordered list of items for this configured module. * * attribute feeds object - An object with feeds returned by the node helper. */ generateFeed: function (feeds) { var newsItems = []; for (var feed in feeds) { var feedItems = feeds[feed]; if (this.subscribedToFeed(feed)) { for (var i in feedItems) { var item = feedItems[i]; item.sourceTitle = this.titleForFeed(feed); if (!(this.config.ignoreOldItems && Date.now() - new Date(item.pubdate) > this.config.ignoreOlderThan)) { newsItems.push(item); } } } } newsItems.sort(function (a, b) { var dateA = new Date(a.pubdate); var dateB = new Date(b.pubdate); return dateB - dateA; }); if (this.config.maxNewsItems > 0) { newsItems = newsItems.slice(0, this.config.maxNewsItems); } if (this.config.prohibitedWords.length > 0) { newsItems = newsItems.filter(function (value) { for (var i = 0; i < this.config.prohibitedWords.length; i++) { if (value["title"].toLowerCase().indexOf(this.config.prohibitedWords[i].toLowerCase()) > -1) { return false; } } return true; }, this); } // get updated news items and broadcast them var updatedItems = []; newsItems.forEach((value) => { if (this.newsItems.findIndex((value1) => value1 === value) === -1) { // Add item to updated items list updatedItems.push(value); } }); // check if updated items exist, if so and if we should broadcast these updates, then lets do so if (this.config.broadcastNewsUpdates && updatedItems.length > 0) { this.sendNotification("NEWS_FEED_UPDATE", { items: updatedItems }); } this.newsItems = newsItems; }, /* subscribedToFeed(feedUrl) * Check if this module is configured to show this feed. * * attribute feedUrl string - Url of the feed to check. * * returns bool */ subscribedToFeed: function (feedUrl) { for (var f in this.config.feeds) { var feed = this.config.feeds[f]; if (feed.url === feedUrl) { return true; } } return false; }, /* titleForFeed(feedUrl) * Returns title for a specific feed Url. * * attribute feedUrl string - Url of the feed to check. * * returns string */ titleForFeed: function (feedUrl) { for (var f in this.config.feeds) { var feed = this.config.feeds[f]; if (feed.url === feedUrl) { return feed.title || ""; } } return ""; }, /* scheduleUpdateInterval() * Schedule visual update. */ scheduleUpdateInterval: function () { var self = this; self.updateDom(self.config.animationSpeed); // Broadcast NewsFeed if needed if (self.config.broadcastNewsFeeds) { self.sendNotification("NEWS_FEED", { items: self.newsItems }); } this.timer = setInterval(function () { self.activeItem++; self.updateDom(self.config.animationSpeed); // Broadcast NewsFeed if needed if (self.config.broadcastNewsFeeds) { self.sendNotification("NEWS_FEED", { items: self.newsItems }); } }, this.config.updateInterval); }, resetDescrOrFullArticleAndTimer: function () { this.isShowingDescription = this.config.showDescription; this.config.showFullArticle = false; this.scrollPosition = 0; // reset bottom bar alignment document.getElementsByClassName("region bottom bar")[0].style.bottom = "0"; document.getElementsByClassName("region bottom bar")[0].style.top = "inherit"; if (!this.timer) { this.scheduleUpdateInterval(); } }, notificationReceived: function (notification, payload, sender) { var before = this.activeItem; if (notification === "ARTICLE_NEXT") { this.activeItem++; if (this.activeItem >= this.newsItems.length) { this.activeItem = 0; } this.resetDescrOrFullArticleAndTimer(); Log.info(this.name + " - going from article #" + before + " to #" + this.activeItem + " (of " + this.newsItems.length + ")"); this.updateDom(100); } else if (notification === "ARTICLE_PREVIOUS") { this.activeItem--; if (this.activeItem < 0) { this.activeItem = this.newsItems.length - 1; } this.resetDescrOrFullArticleAndTimer(); Log.info(this.name + " - going from article #" + before + " to #" + this.activeItem + " (of " + this.newsItems.length + ")"); this.updateDom(100); } // if "more details" is received the first time: show article summary, on second time show full article else if (notification === "ARTICLE_MORE_DETAILS") { // full article is already showing, so scrolling down if (this.config.showFullArticle === true) { this.scrollPosition += this.config.scrollLength; window.scrollTo(0, this.scrollPosition); Log.info(this.name + " - scrolling down"); Log.info(this.name + " - ARTICLE_MORE_DETAILS, scroll position: " + this.config.scrollLength); } else { this.showFullArticle(); } } else if (notification === "ARTICLE_SCROLL_UP") { if (this.config.showFullArticle === true) { this.scrollPosition -= this.config.scrollLength; window.scrollTo(0, this.scrollPosition); Log.info(this.name + " - scrolling up"); Log.info(this.name + " - ARTICLE_SCROLL_UP, scroll position: " + this.config.scrollLength); } } else if (notification === "ARTICLE_LESS_DETAILS") { this.resetDescrOrFullArticleAndTimer(); Log.info(this.name + " - showing only article titles again"); this.updateDom(100); } else if (notification === "ARTICLE_TOGGLE_FULL") { if (this.config.showFullArticle) { this.activeItem++; this.resetDescrOrFullArticleAndTimer(); } else { this.showFullArticle(); } } else if (notification === "ARTICLE_INFO_REQUEST") { this.sendNotification("ARTICLE_INFO_RESPONSE", { title: this.newsItems[this.activeItem].title, source: this.newsItems[this.activeItem].sourceTitle, date: this.newsItems[this.activeItem].pubdate, desc: this.newsItems[this.activeItem].description, url: this.getActiveItemURL() }); } }, showFullArticle: function () { this.isShowingDescription = !this.isShowingDescription; this.config.showFullArticle = !this.isShowingDescription; // make bottom bar align to top to allow scrolling if (this.config.showFullArticle === true) { document.getElementsByClassName("region bottom bar")[0].style.bottom = "inherit"; document.getElementsByClassName("region bottom bar")[0].style.top = "-90px"; } clearInterval(this.timer); this.timer = null; Log.info(this.name + " - showing " + this.isShowingDescription ? "article description" : "full article"); this.updateDom(100); } });