Merge pull request #3692 from mikiher/rss-remove-server-address

Remove serverAddress from Feeds and FeedEpisodes URLs

server/Server.js

@@ -251,14 +251,17 @@ class Server {
 
     const router = express.Router()
     // if RouterBasePath is set, modify all requests to include the base path
-    if (global.RouterBasePath) {
-      app.use((req, res, next) => {
-        if (!req.url.startsWith(global.RouterBasePath)) {
-          req.url = `${global.RouterBasePath}${req.url}`
-        }
-        next()
-      })
-    }
+    app.use((req, res, next) => {
+      const urlStartsWithRouterBasePath = req.url.startsWith(global.RouterBasePath)
+      const host = req.get('host')
+      const protocol = req.secure || req.get('x-forwarded-proto') === 'https' ? 'https' : 'http'
+      const prefix = urlStartsWithRouterBasePath ? global.RouterBasePath : ''
+      req.originalHostPrefix = `${protocol}://${host}${prefix}`
+      if (!urlStartsWithRouterBasePath) {
+        req.url = `${global.RouterBasePath}${req.url}`
+      }
+      next()
+    })
     app.use(global.RouterBasePath, router)
     app.disable('x-powered-by')
 

server/managers/RssFeedManager.js

@@ -1,3 +1,4 @@
+const { Request, Response } = require('express')
 const Path = require('path')
 
 const Logger = require('../Logger')
@@ -77,6 +78,12 @@ class RssFeedManager {
     return Database.feedModel.findByPkOld(id)
   }
 
+  /**
+   * GET: /feed/:slug
+   *
+   * @param {Request} req
+   * @param {Response} res
+   */
   async getFeed(req, res) {
     const feed = await this.findFeedBySlug(req.params.slug)
     if (!feed) {
@@ -162,11 +169,17 @@ class RssFeedManager {
       }
     }
 
-    const xml = feed.buildXml()
+    const xml = feed.buildXml(req.originalHostPrefix)
     res.set('Content-Type', 'text/xml')
     res.send(xml)
   }
 
+  /**
+   * GET: /feed/:slug/item/:episodeId/*
+   *
+   * @param {Request} req
+   * @param {Response} res
+   */
   async getFeedItem(req, res) {
     const feed = await this.findFeedBySlug(req.params.slug)
     if (!feed) {
@@ -183,6 +196,12 @@ class RssFeedManager {
     res.sendFile(episodePath)
   }
 
+  /**
+   * GET: /feed/:slug/cover*
+   *
+   * @param {Request} req
+   * @param {Response} res
+   */
   async getFeedCover(req, res) {
     const feed = await this.findFeedBySlug(req.params.slug)
     if (!feed) {

server/migrations/changelog.md

@@ -10,3 +10,4 @@ Please add a record of every database migration that you create to this file. Th
 | v2.17.0        | v2.17.0-uuid-replacement                     | Changes the data type of columns with UUIDv4 to UUID matching the associated model                            |
 | v2.17.3        | v2.17.3-fk-constraints                       | Changes the foreign key constraints for tables due to sequelize bug dropping constraints in v2.17.0 migration |
 | v2.17.4        | v2.17.4-use-subfolder-for-oidc-redirect-uris | Save subfolder to OIDC redirect URIs to support existing installations                                        |
+| v2.17.5        | v2.17.5-remove-host-from-feed-urls           | removes the host (serverAddress) from URL columns in the feeds and feedEpisodes tables                        |

server/migrations/v2.17.5-remove-host-from-feed-urls.js

@@ -0,0 +1,74 @@
+/**
+ * @typedef MigrationContext
+ * @property {import('sequelize').QueryInterface} queryInterface - a suquelize QueryInterface object.
+ * @property {import('../Logger')} logger - a Logger object.
+ *
+ * @typedef MigrationOptions
+ * @property {MigrationContext} context - an object containing the migration context.
+ */
+
+const migrationVersion = '2.17.5'
+const migrationName = `${migrationVersion}-remove-host-from-feed-urls`
+const loggerPrefix = `[${migrationVersion} migration]`
+
+/**
+ * This upward migration removes the host (serverAddress) from URL columns in the feeds and feedEpisodes tables.
+ *
+ * @param {MigrationOptions} options - an object containing the migration context.
+ * @returns {Promise<void>} - A promise that resolves when the migration is complete.
+ */
+async function up({ context: { queryInterface, logger } }) {
+  // Upwards migration script
+  logger.info(`${loggerPrefix} UPGRADE BEGIN: ${migrationName}`)
+
+  logger.info(`${loggerPrefix} Removing serverAddress from Feeds table URLs`)
+  await queryInterface.sequelize.query(`
+    UPDATE Feeds
+    SET feedUrl = REPLACE(feedUrl, COALESCE(serverAddress, ''), ''),
+        imageUrl = REPLACE(imageUrl, COALESCE(serverAddress, ''), ''),
+        siteUrl = REPLACE(siteUrl, COALESCE(serverAddress, ''), '');
+  `)
+  logger.info(`${loggerPrefix} Removed serverAddress from Feeds table URLs`)
+
+  logger.info(`${loggerPrefix} Removing serverAddress from FeedEpisodes table URLs`)
+  await queryInterface.sequelize.query(`
+    UPDATE FeedEpisodes
+      SET siteUrl = REPLACE(siteUrl, (SELECT COALESCE(serverAddress, '') FROM Feeds WHERE Feeds.id = FeedEpisodes.feedId), ''),
+          enclosureUrl = REPLACE(enclosureUrl, (SELECT COALESCE(serverAddress, '') FROM Feeds WHERE Feeds.id = FeedEpisodes.feedId), '');
+  `)
+  logger.info(`${loggerPrefix} Removed serverAddress from FeedEpisodes table URLs`)
+
+  logger.info(`${loggerPrefix} UPGRADE END: ${migrationName}`)
+}
+
+/**
+ * This downward migration script adds the host (serverAddress) back to URL columns in the feeds and feedEpisodes tables.
+ *
+ * @param {MigrationOptions} options - an object containing the migration context.
+ * @returns {Promise<void>} - A promise that resolves when the migration is complete.
+ */
+async function down({ context: { queryInterface, logger } }) {
+  // Downward migration script
+  logger.info(`${loggerPrefix} DOWNGRADE BEGIN: ${migrationName}`)
+
+  logger.info(`${loggerPrefix} Adding serverAddress back to Feeds table URLs`)
+  await queryInterface.sequelize.query(`
+    UPDATE Feeds
+    SET feedUrl = COALESCE(serverAddress, '') || feedUrl,
+        imageUrl = COALESCE(serverAddress, '') || imageUrl,
+        siteUrl = COALESCE(serverAddress, '') || siteUrl;
+  `)
+  logger.info(`${loggerPrefix} Added serverAddress back to Feeds table URLs`)
+
+  logger.info(`${loggerPrefix} Adding serverAddress back to FeedEpisodes table URLs`)
+  await queryInterface.sequelize.query(`
+    UPDATE FeedEpisodes
+      SET siteUrl = (SELECT COALESCE(serverAddress, '') || FeedEpisodes.siteUrl FROM Feeds WHERE Feeds.id = FeedEpisodes.feedId),
+          enclosureUrl = (SELECT COALESCE(serverAddress, '') || FeedEpisodes.enclosureUrl FROM Feeds WHERE Feeds.id = FeedEpisodes.feedId);
+  `)
+  logger.info(`${loggerPrefix} Added serverAddress back to FeedEpisodes table URLs`)
+
+  logger.info(`${loggerPrefix} DOWNGRADE END: ${migrationName}`)
+}
+
+module.exports = { up, down }

server/objects/Feed.js

@@ -29,9 +29,6 @@ class Feed {
     this.createdAt = null
     this.updatedAt = null
 
-    // Cached xml
-    this.xml = null
-
     if (feed) {
       this.construct(feed)
     }
@@ -109,7 +106,7 @@ class Feed {
     const mediaMetadata = media.metadata
     const isPodcast = libraryItem.mediaType === 'podcast'
 
-    const feedUrl = `${serverAddress}/feed/${slug}`
+    const feedUrl = `/feed/${slug}`
     const author = isPodcast ? mediaMetadata.author : mediaMetadata.authorName
 
     this.id = uuidv4()
@@ -128,9 +125,9 @@ class Feed {
     this.meta.title = mediaMetadata.title
     this.meta.description = mediaMetadata.description
     this.meta.author = author
-    this.meta.imageUrl = media.coverPath ? `${serverAddress}/feed/${slug}/cover${coverFileExtension}` : `${serverAddress}/Logo.png`
+    this.meta.imageUrl = media.coverPath ? `/feed/${slug}/cover${coverFileExtension}` : `/Logo.png`
     this.meta.feedUrl = feedUrl
-    this.meta.link = `${serverAddress}/item/${libraryItem.id}`
+    this.meta.link = `/item/${libraryItem.id}`
     this.meta.explicit = !!mediaMetadata.explicit
     this.meta.type = mediaMetadata.type
     this.meta.language = mediaMetadata.language
@@ -176,7 +173,7 @@ class Feed {
     this.meta.title = mediaMetadata.title
     this.meta.description = mediaMetadata.description
     this.meta.author = author
-    this.meta.imageUrl = media.coverPath ? `${this.serverAddress}/feed/${this.slug}/cover${coverFileExtension}` : `${this.serverAddress}/Logo.png`
+    this.meta.imageUrl = media.coverPath ? `/feed/${this.slug}/cover${coverFileExtension}` : `/Logo.png`
     this.meta.explicit = !!mediaMetadata.explicit
     this.meta.type = mediaMetadata.type
     this.meta.language = mediaMetadata.language
@@ -202,11 +199,10 @@ class Feed {
     }
 
     this.updatedAt = Date.now()
-    this.xml = null
   }
 
   setFromCollection(userId, slug, collectionExpanded, serverAddress, preventIndexing = true, ownerName = null, ownerEmail = null) {
-    const feedUrl = `${serverAddress}/feed/${slug}`
+    const feedUrl = `/feed/${slug}`
 
     const itemsWithTracks = collectionExpanded.books.filter((libraryItem) => libraryItem.media.tracks.length)
     const firstItemWithCover = itemsWithTracks.find((item) => item.media.coverPath)
@@ -227,9 +223,9 @@ class Feed {
     this.meta.title = collectionExpanded.name
     this.meta.description = collectionExpanded.description || ''
     this.meta.author = this.getAuthorsStringFromLibraryItems(itemsWithTracks)
-    this.meta.imageUrl = this.coverPath ? `${serverAddress}/feed/${slug}/cover${coverFileExtension}` : `${serverAddress}/Logo.png`
+    this.meta.imageUrl = this.coverPath ? `/feed/${slug}/cover${coverFileExtension}` : `/Logo.png`
     this.meta.feedUrl = feedUrl
-    this.meta.link = `${serverAddress}/collection/${collectionExpanded.id}`
+    this.meta.link = `/collection/${collectionExpanded.id}`
     this.meta.explicit = !!itemsWithTracks.some((li) => li.media.metadata.explicit) // explicit if any item is explicit
     this.meta.preventIndexing = preventIndexing
     this.meta.ownerName = ownerName
@@ -272,7 +268,7 @@ class Feed {
     this.meta.title = collectionExpanded.name
     this.meta.description = collectionExpanded.description || ''
     this.meta.author = this.getAuthorsStringFromLibraryItems(itemsWithTracks)
-    this.meta.imageUrl = this.coverPath ? `${this.serverAddress}/feed/${this.slug}/cover${coverFileExtension}` : `${this.serverAddress}/Logo.png`
+    this.meta.imageUrl = this.coverPath ? `/feed/${this.slug}/cover${coverFileExtension}` : `/Logo.png`
     this.meta.explicit = !!itemsWithTracks.some((li) => li.media.metadata.explicit) // explicit if any item is explicit
 
     this.episodes = []
@@ -297,11 +293,10 @@ class Feed {
     })
 
     this.updatedAt = Date.now()
-    this.xml = null
   }
 
   setFromSeries(userId, slug, seriesExpanded, serverAddress, preventIndexing = true, ownerName = null, ownerEmail = null) {
-    const feedUrl = `${serverAddress}/feed/${slug}`
+    const feedUrl = `/feed/${slug}`
 
     let itemsWithTracks = seriesExpanded.books.filter((libraryItem) => libraryItem.media.tracks.length)
     // Sort series items by series sequence
@@ -326,9 +321,9 @@ class Feed {
     this.meta.title = seriesExpanded.name
     this.meta.description = seriesExpanded.description || ''
     this.meta.author = this.getAuthorsStringFromLibraryItems(itemsWithTracks)
-    this.meta.imageUrl = this.coverPath ? `${serverAddress}/feed/${slug}/cover${coverFileExtension}` : `${serverAddress}/Logo.png`
+    this.meta.imageUrl = this.coverPath ? `/feed/${slug}/cover${coverFileExtension}` : `/Logo.png`
     this.meta.feedUrl = feedUrl
-    this.meta.link = `${serverAddress}/library/${libraryId}/series/${seriesExpanded.id}`
+    this.meta.link = `/library/${libraryId}/series/${seriesExpanded.id}`
     this.meta.explicit = !!itemsWithTracks.some((li) => li.media.metadata.explicit) // explicit if any item is explicit
     this.meta.preventIndexing = preventIndexing
     this.meta.ownerName = ownerName
@@ -374,7 +369,7 @@ class Feed {
     this.meta.title = seriesExpanded.name
     this.meta.description = seriesExpanded.description || ''
     this.meta.author = this.getAuthorsStringFromLibraryItems(itemsWithTracks)
-    this.meta.imageUrl = this.coverPath ? `${this.serverAddress}/feed/${this.slug}/cover${coverFileExtension}` : `${this.serverAddress}/Logo.png`
+    this.meta.imageUrl = this.coverPath ? `/feed/${this.slug}/cover${coverFileExtension}` : `/Logo.png`
     this.meta.explicit = !!itemsWithTracks.some((li) => li.media.metadata.explicit) // explicit if any item is explicit
 
     this.episodes = []
@@ -399,18 +394,14 @@ class Feed {
     })
 
     this.updatedAt = Date.now()
-    this.xml = null
   }
 
-  buildXml() {
-    if (this.xml) return this.xml
-
-    var rssfeed = new RSS(this.meta.getRSSData())
+  buildXml(originalHostPrefix) {
+    var rssfeed = new RSS(this.meta.getRSSData(originalHostPrefix))
     this.episodes.forEach((ep) => {
-      rssfeed.item(ep.getRSSData())
+      rssfeed.item(ep.getRSSData(originalHostPrefix))
     })
-    this.xml = rssfeed.xml()
-    return this.xml
+    return rssfeed.xml()
   }
 
   getAuthorsStringFromLibraryItems(libraryItems) {

server/objects/FeedEpisode.js

@@ -79,7 +79,7 @@ class FeedEpisode {
     this.title = episode.title
     this.description = episode.description || ''
     this.enclosure = {
-      url: `${serverAddress}${contentUrl}`,
+      url: `${contentUrl}`,
       type: episode.audioTrack.mimeType,
       size: episode.size
     }
@@ -136,7 +136,7 @@ class FeedEpisode {
     this.title = title
     this.description = mediaMetadata.description || ''
     this.enclosure = {
-      url: `${serverAddress}${contentUrl}`,
+      url: `${contentUrl}`,
       type: audioTrack.mimeType,
       size: audioTrack.metadata.size
     }
@@ -151,15 +151,19 @@ class FeedEpisode {
     this.fullPath = audioTrack.metadata.path
   }
 
-  getRSSData() {
+  getRSSData(hostPrefix) {
     return {
       title: this.title,
       description: this.description || '',
-      url: this.link,
-      guid: this.enclosure.url,
+      url: `${hostPrefix}${this.link}`,
+      guid: `${hostPrefix}${this.enclosure.url}`,
       author: this.author,
       date: this.pubDate,
-      enclosure: this.enclosure,
+      enclosure: {
+        url: `${hostPrefix}${this.enclosure.url}`,
+        type: this.enclosure.type,
+        size: this.enclosure.size
+      },
       custom_elements: [
         { 'itunes:author': this.author },
         { 'itunes:duration': secondsToTimestamp(this.duration) },

server/objects/FeedMeta.js

@@ -60,42 +60,36 @@ class FeedMeta {
     }
   }
 
-  getRSSData() {
-    const blockTags = [
-      { 'itunes:block': 'yes' },
-      { 'googleplay:block': 'yes' }
-    ]
+  getRSSData(hostPrefix) {
+    const blockTags = [{ 'itunes:block': 'yes' }, { 'googleplay:block': 'yes' }]
     return {
       title: this.title,
       description: this.description || '',
       generator: 'Audiobookshelf',
-      feed_url: this.feedUrl,
-      site_url: this.link,
-      image_url: this.imageUrl,
+      feed_url: `${hostPrefix}${this.feedUrl}`,
+      site_url: `${hostPrefix}${this.link}`,
+      image_url: `${hostPrefix}${this.imageUrl}`,
       custom_namespaces: {
-        'itunes': 'http://www.itunes.com/dtds/podcast-1.0.dtd',
-        'psc': 'http://podlove.org/simple-chapters',
-        'podcast': 'https://podcastindex.org/namespace/1.0',
-        'googleplay': 'http://www.google.com/schemas/play-podcasts/1.0'
+        itunes: 'http://www.itunes.com/dtds/podcast-1.0.dtd',
+        psc: 'http://podlove.org/simple-chapters',
+        podcast: 'https://podcastindex.org/namespace/1.0',
+        googleplay: 'http://www.google.com/schemas/play-podcasts/1.0'
       },
       custom_elements: [
-        { 'language': this.language || 'en' },
-        { 'author': this.author || 'advplyr' },
+        { language: this.language || 'en' },
+        { author: this.author || 'advplyr' },
         { 'itunes:author': this.author || 'advplyr' },
         { 'itunes:summary': this.description || '' },
         { 'itunes:type': this.type },
         {
           'itunes:image': {
             _attr: {
-              href: this.imageUrl
+              href: `${hostPrefix}${this.imageUrl}`
             }
           }
         },
         {
-          'itunes:owner': [
-            { 'itunes:name': this.ownerName || this.author || '' },
-            { 'itunes:email': this.ownerEmail || '' }
-          ]
+          'itunes:owner': [{ 'itunes:name': this.ownerName || this.author || '' }, { 'itunes:email': this.ownerEmail || '' }]
         },
         { 'itunes:explicit': !!this.explicit },
         ...(this.preventIndexing ? blockTags : [])