added a hotkey on ctrl+0 for settings. fixes #91

Co-authored-by: Diogo Oliveira <dromarques@outlook.com>

.github/workflows/build.yml

@@ -9,10 +9,12 @@ jobs:
   build_on_linux:
     runs-on: ubuntu-latest
     steps:
+      - name: Install libarchive-tools
+        run: sudo apt-get install -y libarchive-tools
       - uses: actions/checkout@master
       - uses: actions/setup-node@master
         with:
-          node-version: 12
+          node-version: 16
       - run: npm install
       - run: npm run build
 
@@ -22,7 +24,7 @@ jobs:
       - uses: actions/checkout@master
       - uses: actions/setup-node@master
         with:
-          node-version: 12
+          node-version: 16
       - run: npm install
       - run: npm run build
 
@@ -32,6 +34,6 @@ jobs:
       - uses: actions/checkout@master
       - uses: actions/setup-node@master
         with:
-          node-version: 12
+          node-version: 16
       - run: npm install
       - run: npm run build

.github/workflows/release.yml

@@ -9,10 +9,12 @@ jobs:
   build_on_linux:
     runs-on: ubuntu-latest
     steps:
+      - name: Install libarchive-tools
+        run: sudo apt-get install -y libarchive-tools
       - uses: actions/checkout@master
       - uses: actions/setup-node@master
         with:
-          node-version: 12
+          node-version: 16
       - run: npm install
       - run: npm run build
       - uses: actions/upload-artifact@master
@@ -26,7 +28,7 @@ jobs:
       - uses: actions/checkout@master
       - uses: actions/setup-node@master
         with:
-          node-version: 12
+          node-version: 16
       - run: npm install
       - run: npm run build
       - uses: actions/upload-artifact@master
@@ -40,7 +42,7 @@ jobs:
       - uses: actions/checkout@master
       - uses: actions/setup-node@master
         with:
-          node-version: 12
+          node-version: 16
       - run: npm install
       - run: npm run build
       - uses: actions/upload-artifact@master

CHANGELOG.md

@@ -4,6 +4,42 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 2.7.1
+
+- Fixed bug: Triggering fullscreen from the Tidal web app would cause the menubar to be visible even if it was disabled in the settings
+
+## 2.7.0
+
+- Switched to the native Notifier (removed node-notifier)
+- Album art now also has a name, based on [best effort](https://github.com/Mastermindzh/tidal-hifi/pull/88#pullrequestreview-840814847)
+
+## 2.6.0
+
+- Add album images to mediainfo and discord
+
+## 2.5.0
+
+- Notify-send now correctly shows "Tidal Hifi" as the program name
+- Updated dependencies (including electron itself)
+
+### known issues
+
+- Requires older version of nodejs due to electron-builder (use lts/gallium)
+
+### builds
+
+updated to nodejs 16 in actions
+
+## 2.4.0
+
+- Added more mpris settings
+- Added instruction for rescrobbler to get last.fm working without sandbox mode
+
+## 2.3.0
+
+- Added a setting to minimize to tray on app close (off by default)
+- Added the main menu to the trayicon
+
 ## 2.2.1
 
 - artists is now gotten specifically from the footer. This fixes the [unknown artists bug](https://github.com/Mastermindzh/tidal-hifi/issues/45).
@@ -16,7 +52,7 @@ moved to: [https://github.com/Mastermindzh/tidal-hifi-aur](https://github.com/Ma
 ## 2.2.0
 
 - The discord integration now adds a time remaining field based on the song duration
-- All fields (current, remaining, and url are also available in the API*)
+- All fields (current, remaining, and url are also available in the API\*)
 - the artist field is now correctly identified
 
 * current time only updates on play/pause.

README.md

@@ -20,6 +20,7 @@ The web version of [listen.tidal.com](https://listen.tidal.com) running in elect
 - [Integrations](#integrations)
   - [not included](#not-included)
   - [Known bugs](#known-bugs)
+    - [last.fm doesn't work out of the box. Use rescrobbler as a workaround](#lastfm-doesnt-work-out-of-the-box-use-rescrobbler-as-a-workaround)
 - [Why](#why)
 - [Why not extend existing projects?](#why-not-extend-existing-projects)
 - [Special thanks to...](#special-thanks-to)
@@ -76,7 +77,8 @@ To install and work with the code on this project follow these steps:
 - Custom hotkeys ([source](https://defkey.com/tidal-desktop-shortcuts))
 - API for status and playback
 - Custom [integrations](#integrations)
-- [Settings feature](./docs/settings.png) to disable certain functionality. (`ctrl+=`)
+- [Settings feature](./docs/settings.png) to disable certain functionality. (`ctrl+=` or `ctrl+0`)
+- AlbumArt in integrations ([best-effort](https://github.com/Mastermindzh/tidal-hifi/pull/88#pullrequestreview-840814847))
 
 ## Integrations
 
@@ -96,7 +98,11 @@ It currently includes:
 
 ### Known bugs
 
-- [Last.fm login doesn't work](https://github.com/Mastermindzh/tidal-hifi/issues/4).
+#### last.fm doesn't work out of the box. Use rescrobbler as a workaround
+
+The last.fm login doesn't work, as is evident from the following issue: [Last.fm login doesn't work](https://github.com/Mastermindzh/tidal-hifi/issues/4).
+However, in that same issue you can read about a workaround using [rescrobbler](https://github.com/InputUsername/rescrobbled).
+For now that will be the default workaround.
 
 ## Why
 

build/electron-builder.yml

@@ -10,7 +10,7 @@ snap:
 linux:
   category: Audio
   target:
-    # - pacman
+    - pacman
     - tar.gz
     - deb
     - rpm
@@ -34,3 +34,7 @@ mac:
   category: public.app-category.entertainment
 win:
   target: msi
+  icon: build/icon.png
+  artifactName: "tidalhifi"
+  appId: com.rickvanlieshout.tidalhifi
+  executableName: tidalhifi

package.json

@@ -1,6 +1,6 @@
 {
   "name": "tidal-hifi",
-  "version": "2.2.1",
+  "version": "2.7.1",
   "description": "Tidal on Electron with widevine(hifi) support",
   "main": "src/main.js",
   "scripts": {
@@ -23,21 +23,19 @@
   "homepage": "https://github.com/Mastermindzh/tidal-hifi",
   "license": "MIT",
   "dependencies": {
-    "discord-rpc": "^3.2.0",
+    "discord-rpc": "^4.0.1",
-    "electron-store": "^5.1.1",
+    "electron-store": "^8.0.1",
     "express": "^4.17.1",
-    "hotkeys-js": "^3.7.6",
+    "hotkeys-js": "^3.8.7",
-    "mpris-service": "^2.1.0",
+    "mpris-service": "^2.1.2",
-    "node-notifier": "^9.0.1",
     "request": "^2.88.2"
   },
   "devDependencies": {
     "@mastermindzh/prettier-config": "^1.0.0",
-    "dot-prop": ">=4.2.1",
+    "electron": "git+https://github.com/castlabs/electron-releases.git#v16.0.4+wvcus",
-    "electron": "git+https://github.com/castlabs/electron-releases.git#v10.4.3-wvvmp",
+    "electron-builder": "^22.14.5",
-    "electron-builder": "^21.2.0",
     "electron-reload": "^1.5.0",
-    "prettier": "^2.0.4"
+    "prettier": "^2.5.0"
   },
   "prettier": "@mastermindzh/prettier-config"
 }

src/constants/globalEvents.js

@@ -6,6 +6,7 @@ const globalEvents = {
   previous: "previous",
   updateInfo: "update-info",
   hideSettings: "hideSettings",
+  refreshMenuBar: "refreshMenubar",
   showSettings: "showSettings",
   storeChanged: "storeChanged",
   error: "error",

src/constants/settings.js

@@ -26,6 +26,7 @@ const settings = {
     width: "windowBounds.width",
     height: "windowBounds.height",
   },
+  minimizeOnClose: "minimizeOnClose",
 };
 
 module.exports = settings;

src/main.js

@@ -29,6 +29,14 @@ if (!app.isPackaged) {
   });
 }
 
+/**
+ * Update the menuBarVisbility according to the store value
+ *
+ */
+function syncMenuBarWithStore() {
+  mainWindow.setMenuBarVisibility(store.get(settings.menuBar));
+}
+
 function createWindow(options = {}) {
   // Create the browser window.
   mainWindow = new BrowserWindow({
@@ -48,7 +56,7 @@ function createWindow(options = {}) {
     },
   });
 
-  mainWindow.setMenuBarVisibility(store.get(settings.menuBar));
+  syncMenuBarWithStore();
 
   // load the Tidal website
   mainWindow.loadURL(tidalUrl);
@@ -56,6 +64,14 @@ function createWindow(options = {}) {
   // run stuff after first load
   mainWindow.webContents.once("did-finish-load", () => {});
 
+  mainWindow.on("close", function (event) {
+    if (!app.isQuiting && store.get(settings.minimizeOnClose)) {
+      event.preventDefault();
+      mainWindow.hide();
+      refreshTray(mainWindow);
+    }
+    return false;
+  });
   // Emitted when the window is closed.
   mainWindow.on("closed", function () {
     closeSettingsWindow();
@@ -87,6 +103,7 @@ app.on("ready", () => {
   store.get(settings.trayIcon) && addTray({ icon }) && refreshTray();
   store.get(settings.api) && expressModule.run(mainWindow);
   store.get(settings.enableDiscord) && discordModule.initRPC();
+  // mainWindow.webContents.openDevTools();
 });
 
 app.on("activate", function () {
@@ -109,8 +126,12 @@ ipcMain.on(globalEvents.showSettings, (event, arg) => {
   showSettingsWindow();
 });
 
+ipcMain.on(globalEvents.refreshMenuBar, (event, arg) => {
+  syncMenuBarWithStore();
+});
+
 ipcMain.on(globalEvents.storeChanged, (event, arg) => {
-  mainWindow.setMenuBarVisibility(store.get(settings.menuBar));
+  syncMenuBarWithStore();
 
   if (store.get(settings.enableDiscord) && !discordModule.rpc) {
     discordModule.initRPC();

src/pages/settings/preload.js

@@ -21,6 +21,7 @@ function refreshSettings() {
   mpris.checked = store.get(settings.mpris);
   enableCustomHotkeys.checked = store.get(settings.enableCustomHotkeys);
   enableDiscord.checked = store.get(settings.enableDiscord);
+  minimizeOnClose.checked = store.get(settings.minimizeOnClose);
 }
 
 /**
@@ -80,6 +81,7 @@ window.addEventListener("DOMContentLoaded", () => {
   port = get("port");
   menuBar = get("menuBar");
   trayIcon = get("trayIcon");
+  minimizeOnClose = get("minimizeOnClose");
   mpris = get("mprisCheckbox");
   enableCustomHotkeys = get("enableCustomHotkeys");
   enableDiscord = get("enableDiscord");
@@ -95,4 +97,5 @@ window.addEventListener("DOMContentLoaded", () => {
   addInputListener(mpris, settings.mpris);
   addInputListener(enableCustomHotkeys, settings.enableCustomHotkeys);
   addInputListener(enableDiscord, settings.enableDiscord);
+  addInputListener(minimizeOnClose, settings.minimizeOnClose);
 });

src/pages/settings/settings.html

@@ -80,6 +80,16 @@
                               <span class="slider round"></span>
                           </label>
                       </div>
+                      <div class="option">
+                        <h4>Minimize on Close</h4>
+                        <p>
+                            Minimize window on close instead <br />
+                        </p>
+                        <label class="switch">
+                            <input id="minimizeOnClose" type="checkbox">
+                            <span class="slider round"></span>
+                        </label>
+                      </div>
                       <div class="option">
                         <h4>Hotkeys</h4>
                         <p>

src/preload.js

@@ -1,5 +1,5 @@
 const { setTitle } = require("./scripts/window-functions");
-const { dialog, process } = require("electron").remote;
+const { dialog, process, Notification } = require("electron").remote;
 const { store, settings } = require("./scripts/settings");
 const { ipcRenderer } = require("electron");
 const { app } = require("electron").remote;
@@ -7,7 +7,6 @@ const { downloadFile } = require("./scripts/download");
 const statuses = require("./constants/statuses");
 const hotkeys = require("./scripts/hotkeys");
 const globalEvents = require("./constants/globalEvents");
-const notifier = require("node-notifier");
 const notificationPath = `${app.getPath("userData")}/notification.jpg`;
 let currentSong = "";
 let player;
@@ -39,6 +38,10 @@ const elements = {
   duration: '*[data-test="duration-time"]',
   bar: '*[data-test="progress-bar"]',
   footer: "#footerPlayer",
+  album_header_title: '.header-details [data-test="title"]',
+  playing_title: 'span[data-test="table-cell-title"].css-geqnfr',
+  album_name_cell: '[data-test="table-cell-album"]',
+  tracklist_row: '[data-test="tracklist-row"]',
 
   /**
    * Get an element from the dom
@@ -57,7 +60,7 @@ const elements = {
     if (figure) {
       const mediaElement = figure.querySelector(this["image"]);
       if (mediaElement) {
-        return mediaElement.src;
+        return mediaElement.src.replace("80x80", "640x640");
       }
     }
 
@@ -77,6 +80,29 @@ const elements = {
     return "unknown artist(s)";
   },
 
+  getAlbumName: function () {
+    //If listening to an album, get its name from the header title
+    if (window.location.href.includes("/album/")) {
+      const albumName = window.document.querySelector(this.album_header_title);
+      if (albumName) {
+        return albumName.textContent;
+      }
+      //If listening to a playlist or a mix, get album name from the list
+    } else if (
+      window.location.href.includes("/playlist/") ||
+      window.location.href.includes("/mix/")
+    ) {
+      if (currentPlayStatus === statuses.playing) {
+        const row = window.document.querySelector(this.playing_title).closest(this.tracklist_row);
+        if (row) {
+          return row.querySelector(this.album_name_cell).textContent;
+        }
+      }
+    }
+
+    return "";
+  },
+
   /**
    * Shorthand function to get the text of a dom element
    * @param {*} key key in elements object to fetch
@@ -157,6 +183,9 @@ function addHotKeys() {
   hotkeys.add("control+=", function () {
     ipcRenderer.send(globalEvents.showSettings);
   });
+  hotkeys.add("control+0", function () {
+    ipcRenderer.send(globalEvents.showSettings);
+  });
 }
 
 /**
@@ -190,6 +219,12 @@ function handleLogout() {
   );
 }
 
+function addFullScreenListeners() {
+  window.document.addEventListener("fullscreenchange", (event) => {
+    ipcRenderer.send(globalEvents.refreshMenuBar);
+  });
+}
+
 /**
  * Add ipc event listeners.
  * Some actions triggered outside of the site need info from the site.
@@ -234,6 +269,15 @@ function getCurrentlyPlayingStatus() {
   return status;
 }
 
+/**
+ * Convert the duration from MM:SS to seconds
+ * @param {*} duration
+ */
+function convertDuration(duration) {
+  const parts = duration.split(":");
+  return parseInt(parts[1]) + 60 * parseInt(parts[0]);
+}
+
 /**
  * Update Tidal-hifi's media info
  *
@@ -242,15 +286,18 @@ function getCurrentlyPlayingStatus() {
 function updateMediaInfo(options, notify) {
   if (options) {
     ipcRenderer.send(globalEvents.updateInfo, options);
-    store.get(settings.notifications) && notify && notifier.notify(options);
+    if (store.get(settings.notifications) && notify) {
-
+      new Notification({ title: options.title, body: options.message, icon: options.icon }).show();
+    }
     if (player) {
       player.metadata = {
         ...player.metadata,
         ...{
           "xesam:title": options.title,
-          "xesam:artist": [options.artists],
+          "xesam:artist": [options.message],
+          "xesam:album": options.album,
           "mpris:artUrl": options.image,
+          "mpris:length": convertDuration(options.duration) * 1000 * 1000,
         },
       };
       player.playbackStatus = options.status == statuses.paused ? "Paused" : "Playing";
@@ -281,18 +328,22 @@ function updateURL() {
 setInterval(function () {
   const title = elements.getText("title");
   const artists = elements.getArtists();
+  const album = elements.getAlbumName();
   const current = elements.getText("current");
   const duration = elements.getText("duration");
+  const appName = "Tidal Hifi";
   const progressBarcurrentTime = elements.get("bar").getAttribute("aria-valuenow");
   const songDashArtistTitle = `${title} - ${artists}`;
   const currentStatus = getCurrentlyPlayingStatus();
   const options = {
     title,
     message: artists,
+    album: album,
     status: currentStatus,
     url: currentURL,
     current: current,
     duration: duration,
+    "app-name": appName,
   };
 
   const playStatusChanged = currentStatus !== currentPlayStatus;
@@ -331,6 +382,7 @@ setInterval(function () {
 
     new Promise((resolve) => {
       if (image.startsWith("http")) {
+        options.image = image;
         downloadFile(image, notificationPath).then(
           () => {
             options.icon = notificationPath;
@@ -397,6 +449,10 @@ if (process.platform === "linux" && store.get(settings.mpris)) {
         }
       });
     });
+    // Override get position function
+    player.getPosition = function () {
+      return convertDuration(elements.getText("current")) * 1000 * 1000;
+    };
 
     player.on("quit", function () {
       app.quit();
@@ -408,3 +464,4 @@ if (process.platform === "linux" && store.get(settings.mpris)) {
 
 addHotKeys();
 addIPCEventListeners();
+addFullScreenListeners();

src/scripts/discord.js

@@ -31,6 +31,8 @@ const observer = (event, arg) => {
             : "unknown artist(s)",
           startTimestamp: parseInt(now),
           endTimestamp: parseInt(remaining),
+          largeImageKey: mediaInfoModule.mediaInfo.image,
+          largeImageText: (mediaInfoModule.mediaInfo.album) ? mediaInfoModule.mediaInfo.album : `${idleStatus.largeImageText}`,
           buttons: [{ label: "Play on Tidal", url: mediaInfoModule.mediaInfo.url }],
         },
       });

src/scripts/mediaInfo.js

@@ -3,11 +3,13 @@ const statuses = require("./../constants/statuses");
 const mediaInfo = {
   title: "",
   artist: "",
+  album: "",
   icon: "",
   status: statuses.paused,
   url: "",
   current: "",
-  duration: ""
+  duration: "",
+  image: "tidal-hifi-icon"
 };
 const mediaInfoModule = {
   mediaInfo,
@@ -19,11 +21,13 @@ const mediaInfoModule = {
 mediaInfoModule.update = function (arg) {
   mediaInfo.title = propOrDefault(arg.title);
   mediaInfo.artist = propOrDefault(arg.message);
+  mediaInfo.album = propOrDefault(arg.album);
   mediaInfo.icon = propOrDefault(arg.icon);
   mediaInfo.url = propOrDefault(arg.url);
   mediaInfo.status = propOrDefault(arg.status);
   mediaInfo.current = propOrDefault(arg.current);
   mediaInfo.duration = propOrDefault(arg.duration);
+  mediaInfo.image = propOrDefault(arg.image);
 };
 
 /**

src/scripts/settings.js

@@ -15,6 +15,7 @@ const store = new Store({
       port: 47836,
     },
     trayIcon: true,
+    minimizeOnClose : false,
     mpris: false,
     enableCustomHotkeys: false,
     enableDiscord: false,

src/scripts/tray.js

@@ -1,5 +1,7 @@
-const { Tray } = require("electron");
+const { Tray, app } = require("electron");
-const { getMenu } = require("./menu");
+const { Menu } = require("electron");
+const { getMenu, mainMenu } = require("./menu");
+const { store, settings } = require("./settings");
 const trayModule = {};
 let tray;
 
@@ -7,16 +9,41 @@ trayModule.addTray = function (options = { icon: "" }) {
   tray = new Tray(options.icon);
 };
 
-trayModule.refreshTray = function () {
+trayModule.refreshTray = function (mainWindow) {
   if (!tray) {
     trayModule.addTray();
   }
+
   tray.on("click", function (e) {
-    // do nothing on click
+    if (mainWindow) {
+      mainWindow.show();
+    }
   });
 
   tray.setToolTip("Tidal-hifi");
-  tray.setContextMenu(getMenu());
+
+  if (mainWindow && store.get(settings.minimizeOnClose)) {
+    tray.setContextMenu(
+      Menu.buildFromTemplate([
+        {
+          label: "Toggle Window",
+          click: function () {
+            mainWindow.isVisible() ? mainWindow.hide() : mainWindow.show();
+          },
+        },
+        {
+          label: "Quit",
+          click: function () {
+            mainWindow.destroy();
+            app.quit();
+          },
+        },
+        ...mainMenu, //we add menu items from the other context
+      ])
+    );
+  } else {
+    tray.setContextMenu(getMenu());
+  }
 };
 
 module.exports = trayModule;