Replace Database connection with web server API

src/electron/ipc/AlbumArtHandler.ipc.ts

@@ -1,6 +1,7 @@
 import { IPCInvokeHandler } from '../shared/IPCHandler'
-import Database from '../shared/Database'
 import { AlbumArtResult } from '../shared/interfaces/songDetails.interface'
+import * as needle from 'needle'
+import { serverURL } from '../shared/Paths'
 
 /**
  * Handles the 'album-art' event.
@@ -12,20 +13,19 @@ class AlbumArtHandler implements IPCInvokeHandler<'album-art'> {
    * @returns an `AlbumArtResult` object containing the album art for the song with `songID`.
    */
   async handler(songID: number) {
-    const db = await Database.getInstance()
-
-    return db.sendQuery(this.getAlbumArtQuery(songID), 1) as Promise<AlbumArtResult>
-  }
-
-  /**
-   * @returns a database query that returns the album art for the song with `songID`.
-   */
-  private getAlbumArtQuery(songID: number) {
-    return `
-      SELECT art
-      FROM AlbumArt
-      WHERE songID = ${songID};
-    `
+    return new Promise<AlbumArtResult>((resolve, reject) => {
+      needle.request(
+        'get',
+        serverURL + `/api/data/albumArt`, {
+          songID: songID
+        }, (err, response) => {
+          if (err) {
+            reject(err)
+          } else {
+            resolve(response.body)
+          }
+        })
+    })
   }
 }
 

src/electron/ipc/BatchSongDetailsHandler.ipc.ts

@@ -1,6 +1,7 @@
 import { IPCInvokeHandler } from '../shared/IPCHandler'
-import Database from '../shared/Database'
 import { VersionResult } from '../shared/interfaces/songDetails.interface'
+import { serverURL } from '../shared/Paths'
+import * as needle from 'needle'
 
 /**
  * Handles the 'batch-song-details' event.
@@ -12,20 +13,19 @@ class BatchSongDetailsHandler implements IPCInvokeHandler<'batch-song-details'>
    * @returns an array of all the chart versions with a songID found in `songIDs`.
    */
   async handler(songIDs: number[]) {
-    const db = await Database.getInstance()
-
-    return db.sendQuery(this.getVersionQuery(songIDs)) as Promise<VersionResult[]>
-  }
-
-  /**
-   * @returns a database query that returns all the chart versions with a songID found in `songIDs`.
-   */
-  private getVersionQuery(songIDs: number[]) {
-    return `
-      SELECT *
-      FROM VersionMetaFull
-      WHERE songID IN (${songIDs.join(',')});
-    `
+    return new Promise<VersionResult[]>((resolve, reject) => {
+      needle.request(
+        'get',
+        serverURL + `/api/data/songsVersions`, {
+          songIDs: songIDs
+        }, (err, response) => {
+          if (err) {
+            reject(err)
+          } else {
+            resolve(response.body)
+          }
+        })
+    })
   }
 }
 

src/electron/ipc/SearchHandler.ipc.ts

@@ -1,8 +1,7 @@
 import { IPCInvokeHandler } from '../shared/IPCHandler'
-import Database from '../shared/Database'
 import { SongSearch, SearchType, SongResult } from '../shared/interfaces/search.interface'
-import { escape } from 'mysql'
-
+import * as needle from 'needle'
+import { serverURL } from '../shared/Paths'
 /**
  * Handles the 'song-search' event.
  */
@@ -13,32 +12,32 @@ class SearchHandler implements IPCInvokeHandler<'song-search'> {
    * @returns the top 20 songs that match `search`.
    */
   async handler(search: SongSearch) {
-    const db = await Database.getInstance()
-
-    return db.sendQuery(this.getSearchQuery(search)) as Promise<SongResult[]>
+    return new Promise<SongResult[]>((resolve, reject) => {
+      needle.request(
+        'get',
+        serverURL + `/api/search/${this.getSearchType(search)}`, {
+          query: search.query,
+          limit: search.length,
+          offset: search.offset
+        }, (err, response) => {
+          if (err) {
+            reject(err)
+          } else {
+            resolve(response.body)
+          }
+        })
+    })
   }
 
   /**
-   * @returns a database query that returns the type of results expected by `search.type`.
+   * @returns the search api type that corresponds with `search.type`.
    */
-  private getSearchQuery(search: SongSearch) {
+  private getSearchType(search: SongSearch) {
     switch (search.type) {
-      case SearchType.Any: return this.getGeneralSearchQuery(search)
+      case SearchType.Any: return 'general'
       default: return '<<<ERROR>>>' // TODO: add more search types
     }
   }
-
-  /**
-   * @returns a database query that returns the top 20 songs that match `search`.
-   */
-  private getGeneralSearchQuery(search: SongSearch) {
-    return `
-      SELECT id, name, artist, album, genre, year
-      FROM Song
-      WHERE MATCH (name,artist,album,genre) AGAINST (${escape(search.query)}) > 0
-      LIMIT ${search.length} OFFSET ${search.offset};
-    ` // TODO: add parameters for the limit and offset
-  }
 }
 
 export const searchHandler = new SearchHandler()

src/electron/ipc/SongDetailsHandler.ipc.ts

@@ -1,6 +1,7 @@
 import { IPCInvokeHandler } from '../shared/IPCHandler'
-import Database from '../shared/Database'
 import { VersionResult } from '../shared/interfaces/songDetails.interface'
+import * as needle from 'needle'
+import { serverURL } from '../shared/Paths'
 
 /**
  * Handles the 'song-details' event.
@@ -12,20 +13,19 @@ class SongDetailsHandler implements IPCInvokeHandler<'song-details'> {
    * @returns the chart versions with `songID`.
    */
   async handler(songID: number) {
-    const db = await Database.getInstance()
-
-    return db.sendQuery(this.getVersionQuery(songID)) as Promise<VersionResult[]>
-  }
-
-  /**
-   * @returns a database query that returns the chart versions with `songID`.
-   */
-  private getVersionQuery(songID: number) {
-    return `
-      SELECT *
-      FROM VersionMetaFull
-      WHERE songID = ${songID};
-    `
+    return new Promise<VersionResult[]>((resolve, reject) => {
+      needle.request(
+        'get',
+        serverURL + `/api/data/songVersions`, {
+          songID: songID
+        }, (err, response) => {
+          if (err) {
+            reject(err)
+          } else {
+            resolve(response.body)
+          }
+        })
+    })
   }
 }
 

src/electron/ipc/download/ChartDownload.ts

@@ -5,11 +5,12 @@ import { FileExtractor } from './FileExtractor'
 import { sanitizeFilename, interpolate } from '../../shared/UtilFunctions'
 import { emitIPCEvent } from '../../main'
 import { promisify } from 'util'
-import { randomBytes as _randomBytes, createHash } from 'crypto'
+import { randomBytes as _randomBytes } from 'crypto'
 import { mkdir as _mkdir } from 'fs'
 import { ProgressType, NewDownload } from 'src/electron/shared/interfaces/download.interface'
 import { downloadHandler } from './DownloadHandler'
 import { googleTimer } from './GoogleTimer'
+import { DriveFile } from 'src/electron/shared/interfaces/songDetails.interface'
 
 const randomBytes = promisify(_randomBytes)
 const mkdir = promisify(_mkdir)
@@ -21,26 +22,20 @@ export class ChartDownload {
   cancel: () => void
 
   isArchive: boolean
-  isGoogle: boolean
   title: string
   header: string
   description: string
   percent = 0
   type: ProgressType
 
-  private fileKeys: string[]
-  private fileValues: string[]
+  private files: DriveFile[]
   allFilesProgress = 0
   individualFileProgressPortion: number
 
   constructor(public versionID: number, private data: NewDownload) {
-    // Only iterate over the keys in data.links that have link values (not hashes)
-    this.fileKeys = Object.keys(data.links).filter(link => data.links[link].includes('.'))
-    this.fileValues = Object.values(data.links).filter(value => value.includes('.'))
-
-    this.isArchive = this.fileKeys.includes('archive')
-    this.isGoogle = !!this.fileValues.find(value => value.toLocaleLowerCase().includes('google'))
-    this.individualFileProgressPortion = 80 / this.fileKeys.length
+    this.files = data.driveData.files
+    this.isArchive = data.driveData.isArchive
+    this.individualFileProgressPortion = 80 / this.files.length
   }
 
   /**
@@ -69,31 +64,27 @@ export class ChartDownload {
       return
     }
 
-    // For each actual download link in <this.data.links>, download the file to <chartPath>
-    for (let i = 0; i < this.fileKeys.length; i++) {
+    // For each download link in <this.files>, download the file to <chartPath>
+    for (let i = 0; i < this.files.length; i++) {
       // INITIALIZE DOWNLOADER
-      const typeHash = createHash('md5').update(this.fileValues[i]).digest('hex')
-      // <this.data.links[typeHash]> stores the expected hash value found in the download header
-      const downloader = new FileDownloader(this.fileValues[i], chartPath, this.data.links[typeHash])
+      const downloader = new FileDownloader(this.files[i].webContentLink, chartPath)
       const downloadComplete = this.addDownloadEventListeners(downloader, i)
 
       // DOWNLOAD THE NEXT FILE
-      if (this.isGoogle) { // If this is a google download...
-        // Wait for google rate limit
-        this.header = `[${this.fileKeys[i]}] (file ${i + 1}/${this.fileKeys.length})`
-        googleTimer.onTimerUpdate((remainingTime, totalTime) => {
-          this.description = `Waiting for Google rate limit... (${remainingTime}s)`
-          this.percent = this.allFilesProgress + interpolate(remainingTime, totalTime, 0, 0, this.individualFileProgressPortion / 2)
-          this.type = 'good'
-          emitIPCEvent('download-updated', this)
-        })
-        this.cancel = () => {
-          googleTimer.removeCallbacks()
-          this.onDownloadStop()
-          downloader.cancelDownload()
-        }
-        await new Promise<void>(resolve => googleTimer.onTimerReady(resolve))
+      // Wait for google rate limit
+      this.header = `[${this.files[i].originalFilename}] (file ${i + 1}/${this.files.length})`
+      googleTimer.onTimerUpdate((remainingTime, totalTime) => {
+        this.description = `Waiting for Google rate limit... (${remainingTime}s)`
+        this.percent = this.allFilesProgress + interpolate(remainingTime, totalTime, 0, 0, this.individualFileProgressPortion / 2)
+        this.type = 'good'
+        emitIPCEvent('download-updated', this)
+      })
+      this.cancel = () => {
+        googleTimer.removeCallbacks()
+        this.onDownloadStop()
+        downloader.cancelDownload()
       }
+      await new Promise<void>(resolve => googleTimer.onTimerReady(resolve))
 
       this.cancel = () => {
         this.onDownloadStop()
@@ -149,10 +140,8 @@ export class ChartDownload {
    * If this was a google download, allows a new google download to start.
    */
   private onDownloadStop() {
-    if (this.isGoogle) {
-      downloadHandler.isGoogleDownloading = false
-      downloadHandler.updateQueue()
-    }
+    downloadHandler.isGoogleDownloading = false
+    downloadHandler.updateQueue()
   }
 
   /**
@@ -177,28 +166,12 @@ export class ChartDownload {
       emitIPCEvent('download-updated', this)
     })
 
-    let filesize = -1
-    downloader.on('download', (filename, _filesize) => {
-      this.header = `[${filename}] (file ${fileIndex + 1}/${this.fileKeys.length})`
-      if (_filesize != undefined) {
-        filesize = _filesize
-        this.description = 'Downloading... (0%)'
-      } else {
-        this.description = 'Downloading... (0 MB)'
-      }
-      this.type = 'good'
-      emitIPCEvent('download-updated', this)
-    })
-
     downloader.on('downloadProgress', (bytesDownloaded) => {
-      if (filesize != -1) {
-        this.description = `Downloading... (${Math.round(1000 * bytesDownloaded / filesize) / 10}%)`
-        fileProgress = interpolate(bytesDownloaded, 0, filesize, this.individualFileProgressPortion / 2, this.individualFileProgressPortion)
-        this.percent = this.allFilesProgress + fileProgress
-      } else {
-        this.description = `Downloading... (${Math.round(bytesDownloaded / 1e+5) / 10} MB)`
-        this.percent = this.allFilesProgress + fileProgress
-      }
+      const size = Number(this.files[fileIndex].size)
+      this.header = `[${this.files[fileIndex].originalFilename}] (file ${fileIndex + 1}/${this.files.length})`
+      this.description = `Downloading... (${Math.round(1000 * bytesDownloaded / size) / 10}%)`
+      fileProgress = interpolate(bytesDownloaded, 0, size, this.individualFileProgressPortion / 2, this.individualFileProgressPortion)
+      this.percent = this.allFilesProgress + fileProgress
       this.type = 'fastUpdate'
       emitIPCEvent('download-updated', this)
     })

src/electron/ipc/download/DownloadHandler.ts

@@ -32,17 +32,15 @@ class DownloadHandler implements IPCEmitHandler<'download'> {
    */
   updateQueue() {
     this.downloadQueue.sort((cd1: ChartDownload, cd2: ChartDownload) => {
-      const value1 = (cd1.isGoogle ? 100 : 0) + (99 - cd1.allFilesProgress)
-      const value2 = (cd2.isGoogle ? 100 : 0) + (99 - cd2.allFilesProgress)
+      const value1 = 100 + (99 - cd1.allFilesProgress)
+      const value2 = 100 + (99 - cd2.allFilesProgress)
       return value1 - value2 // Sorts in the order to get the most downloads completed early
     })
 
-    while (this.downloadQueue[0] != undefined && !(this.downloadQueue[0].isGoogle && this.isGoogleDownloading)) {
+    while (this.downloadQueue[0] != undefined && !(this.isGoogleDownloading)) {
       const nextDownload = this.downloadQueue.shift()
       nextDownload.run()
-      if (nextDownload.isGoogle) {
-        this.isGoogleDownloading = true
-      }
+      this.isGoogleDownloading = true
     }
   }
 }

src/electron/ipc/download/FileDownloader.ts

@@ -8,7 +8,6 @@ import { getSettings } from '../SettingsHandler.ipc'
 type EventCallback = {
   'request': () => void
   'warning': (continueAnyway: () => void) => void
-  'download': (filename: string, filesize?: number) => void
   'downloadProgress': (bytesDownloaded: number) => void
   'error': (error: DownloadError, retry: () => void) => void
   'complete': () => void
@@ -34,7 +33,7 @@ export class FileDownloader {
    * @param destinationFolder The path to where this file should be stored.
    * @param expectedHash The hash header value that is expected for this file.
    */
-  constructor(private url: string, private destinationFolder: string, private expectedHash?: string) { }
+  constructor(private url: string, private destinationFolder: string) { }
 
   /**
    * Calls `callback` when `event` fires.
@@ -103,14 +102,7 @@ export class FileDownloader {
         this.handleHTMLResponse(req, headers['set-cookie'])
       } else {
         const fileName = this.getDownloadFileName(headers)
-        this.handleDownloadResponse(req, fileName, headers['content-length'])
-
-        if (this.expectedHash !== undefined && this.getDownloadHash(headers) !== this.expectedHash) {
-          req.pause()
-          this.callbacks.warning(() => {
-            req.resume()
-          })
-        }
+        this.handleDownloadResponse(req, fileName)
       }
     })
   }
@@ -149,10 +141,9 @@ export class FileDownloader {
    * Pipes the data from a download response to `fileName`.
    * @param req The download request.
    * @param fileName The name of the output file.
-   * @param contentLength The number of bytes to be downloaded. If undefined, download progress is indicated by MB, not %.
    */
-  private handleDownloadResponse(req: NodeJS.ReadableStream, fileName: string, contentLength?: number) {
-    this.callbacks.download(fileName, contentLength)
+  private handleDownloadResponse(req: NodeJS.ReadableStream, fileName: string) {
+    this.callbacks.downloadProgress(0)
     let downloadedSize = 0
     const filePath = path.join(this.destinationFolder, fileName)
     req.pipe(fs.createWriteStream(filePath))
@@ -192,20 +183,6 @@ export class FileDownloader {
     }
   }
 
-  /**
-   * Extracts the downloaded file's hash from `headers`, depending on the file's host server.
-   * @param headers The response headers for this request.
-   */
-  private getDownloadHash(headers: Headers): string {
-    if (headers['server'] && headers['server'] == 'cloudflare' || this.url.startsWith('https://public.fightthe.pw/')) {
-      // Cloudflare and Chorus specific jazz
-      return String(headers['content-length']) // No actual hash is provided in the header, so this is the next best thing
-    } else {
-      // GDrive specific jazz
-      return headers['x-goog-hash']
-    }
-  }
-
   cancelDownload() {
     this.wasCanceled = true
   }

src/electron/ipc/download/FileExtractor.ts

@@ -105,6 +105,7 @@ export class FileExtractor {
   private async transfer(archiveFilepath?: string) {
     // TODO: this fails if the extracted chart has nested folders
     // TODO: skip over "__MACOSX" folder
+    // TODO: handle other common problems, like chart/audio files not named correctly
     if (this.wasCanceled) { return } // CANCEL POINT
     try {