Readme update

client/components/AudioPlayer.vue

@@ -315,7 +315,6 @@ export default {
       this.bufferTrackWidth = bufferlen
     },
     timeupdate() {
-      // console.log('Time update', this.audioEl.currentTime)
       if (!this.$refs.playedTrack) {
         console.error('Invalid no played track ref')
         return

client/components/app/Appbar.vue

@@ -16,11 +16,11 @@
           <span class="pl-2">Update is available! Check release notes for v{{ latestVersion }}</span>
         </a> -->
 
-        <nuxt-link v-if="isRootUser" to="/upload" class="outline-none hover:text-gray-200 cursor-pointer w-8 h-8 flex items-center justify-center mr-4">
+        <nuxt-link v-if="userCanUpload" to="/upload" class="outline-none hover:text-gray-200 cursor-pointer w-8 h-8 flex items-center justify-center">
           <span class="material-icons">upload</span>
         </nuxt-link>
 
-        <nuxt-link v-if="isRootUser" to="/config" class="outline-none hover:text-gray-200 cursor-pointer w-8 h-8 flex items-center justify-center">
+        <nuxt-link v-if="isRootUser" to="/config" class="outline-none hover:text-gray-200 cursor-pointer w-8 h-8 flex items-center justify-center ml-4">
           <span class="material-icons">settings</span>
         </nuxt-link>
 
@@ -96,6 +96,9 @@ export default {
     userCanDelete() {
       return this.$store.getters['user/getUserCanDelete']
     },
+    userCanUpload() {
+      return this.$store.getters['user/getUserCanUpload']
+    },
     selectedIsRead() {
       // Find an audiobook that is not read, if none then all audiobooks read
       return !this.selectedAudiobooks.find((ab) => {

client/components/controls/GlobalSearch.vue

@@ -18,7 +18,7 @@
         </li>
         <template v-else>
           <template v-for="item in items">
-            <li :key="item.id" class="text-gray-50 select-none relative cursor-pointer hover:bg-black-400" role="option" @click="clickedOption(item)">
+            <li :key="item.id" class="text-gray-50 select-none relative cursor-pointer hover:bg-black-400 py-1" role="option" @click="clickedOption(item)">
               <template v-if="item.type === 'audiobook'">
                 <cards-audiobook-search-card :audiobook="item.data" />
               </template>

client/components/modals/AccountModal.vue

@@ -27,9 +27,9 @@
             </div>
           </div>
 
-          <div v-if="!isEditingRoot && newUser.permissions" class="w-full border-t border-b border-black-200 py-2 mt-4">
-            <p class="text-lg mb-2">Permissions</p>
-            <div class="flex items-center my-2 max-w-lg">
+          <div v-if="!isEditingRoot && newUser.permissions" class="w-full border-t border-b border-black-200 py-2 px-3 mt-4">
+            <p class="text-lg mb-2 font-semibold">Permissions</p>
+            <div class="flex items-center my-2 max-w-md">
               <div class="w-1/2">
                 <p>Can Download</p>
               </div>
@@ -38,7 +38,7 @@
               </div>
             </div>
 
-            <div class="flex items-center my-2 max-w-lg">
+            <div class="flex items-center my-2 max-w-md">
               <div class="w-1/2">
                 <p>Can Update</p>
               </div>
@@ -47,7 +47,7 @@
               </div>
             </div>
 
-            <div class="flex items-center my-2 max-w-lg">
+            <div class="flex items-center my-2 max-w-md">
               <div class="w-1/2">
                 <p>Can Delete</p>
               </div>
@@ -55,6 +55,15 @@
                 <ui-toggle-switch v-model="newUser.permissions.delete" />
               </div>
             </div>
+
+            <div class="flex items-center my-2 max-w-md">
+              <div class="w-1/2">
+                <p>Can Upload</p>
+              </div>
+              <div class="w-1/2">
+                <ui-toggle-switch v-model="newUser.permissions.upload" />
+              </div>
+            </div>
           </div>
 
           <div class="flex pt-4">
@@ -179,7 +188,8 @@ export default {
       this.newUser.permissions = {
         download: type !== 'guest',
         update: type === 'admin',
-        delete: type === 'admin'
+        delete: type === 'admin',
+        upload: type === 'admin'
       }
     },
     init() {
@@ -201,7 +211,8 @@ export default {
           permissions: {
             download: true,
             update: false,
-            delete: false
+            delete: false,
+            upload: false
           }
         }
       }

client/package.json

@@ -1,6 +1,6 @@
 {
   "name": "audiobookshelf-client",
-  "version": "1.1.12",
+  "version": "1.1.13",
   "description": "Audiobook manager and player",
   "main": "index.js",
   "scripts": {

client/pages/audiobook/_id/index.vue

@@ -13,9 +13,11 @@
             <div class="mb-2">
               <h1 class="text-2xl font-book leading-7">{{ title }}</h1>
               <h3 v-if="series" class="font-book text-gray-300 text-lg leading-7">{{ seriesText }}</h3>
-              <ui-tooltip :text="authorTooltipText" direction="bottom">
-                <p class="text-sm text-gray-100 leading-7">by {{ author }}</p>
-              </ui-tooltip>
+              <div class="w-min">
+                <ui-tooltip :text="authorTooltipText" direction="bottom">
+                  <span class="text-sm text-gray-100 leading-7 whitespace-nowrap">by {{ author }}</span>
+                </ui-tooltip>
+              </div>
             </div>
             <div class="flex-grow" />
           </div>

client/pages/upload/index.vue

@@ -1,8 +1,8 @@
 <template>
   <div id="page-wrapper" class="page p-6" :class="streamAudiobook ? 'streaming' : ''">
     <main class="container mx-auto h-full max-w-screen-lg p-6">
-      <article class="max-h-full overflow-y-auto relative flex flex-col bg-primary shadow-xl rounded-md" @drop="drop" @dragover="dragover" @dragleave="dragleave" @dragenter="dragenter">
-        <h1 class="text-xl font-book px-4 pt-4 pb-2"><span class="text-error pr-4">(Experimental)</span>Audiobook Uploader</h1>
+      <article class="max-h-full overflow-y-auto relative flex flex-col rounded-md" @drop="drop" @dragover="dragover" @dragleave="dragleave" @dragenter="dragenter">
+        <h1 class="text-xl font-book px-8 pt-4 pb-2">Audiobook Uploader</h1>
 
         <div class="flex my-2 px-6">
           <div class="w-1/2 px-2">
@@ -170,19 +170,16 @@ export default {
       }
     },
     drop(evt) {
-      console.log('Dropped event', evt)
       this.isDragOver = false
       this.preventDefaults(evt)
       const files = [...evt.dataTransfer.files]
       this.filesChanged(files)
     },
     dragover(evt) {
-      console.log('Dragged over', evt)
       this.isDragOver = true
       this.preventDefaults(evt)
     },
     dragleave(evt) {
-      console.log('Dragged leave', evt)
       this.isDragOver = false
       this.preventDefaults(evt)
     },
@@ -195,7 +192,6 @@ export default {
       e.stopPropagation()
     },
     filesChanged(files) {
-      console.log('FilesChanged', files)
       this.showUploader = false
 
       for (let i = 0; i < files.length; i++) {

client/store/user.js

@@ -33,6 +33,9 @@ export const getters = {
   },
   getUserCanDownload: (state) => {
     return state.user && state.user.permissions ? !!state.user.permissions.download : false
+  },
+  getUserCanUpload: (state) => {
+    return state.user && state.user.permissions ? !!state.user.permissions.upload : false
   }
 }
 
@@ -60,10 +63,8 @@ export const mutations = {
     state.user = user
     if (user) {
       if (user.token) localStorage.setItem('token', user.token)
-      console.log('setUser', user.username)
     } else {
       localStorage.removeItem('token')
-      console.warn('setUser cleared')
     }
   },
   setSettings(state, settings) {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "audiobookshelf",
-  "version": "1.1.12",
+  "version": "1.1.13",
   "description": "Self-hosted audiobook server for managing and playing audiobooks.",
   "main": "index.js",
   "scripts": {

readme.md

@@ -9,30 +9,61 @@ Android app is in beta, try it out on the [Google Play Store](https://play.googl
 <img alt="Screenshot1" src="https://github.com/advplyr/audiobookshelf/raw/master/images/ss_streaming.png" />
 
 
-#### Folder Structures Supported:
+## Directory Structure
 
-```bash
-/Title/...
-/Author/Title/...
-/Author/Series/Title/...
+Author, Series, Volume Number, Title and Publish Year can all be parsed from your folder structure.
 
-Title can start with the publish year like so:
-/1989 - Book Title/...
+**Note**: Files in the root directory `/audiobooks` will be ignored, all audiobooks should be in a directory
 
-(Optional Setting) Subtitle can be seperated to its own field:
-/Book Title - With a Subtitle/...
-/1989 - Book Title - With a Subtitle/...
-will store "With a Subtitle" as the subtitle
-```
+**1 Folder:** `/Title/...`\
+**2 Folders:** `/Author/Title/...`\
+**3 Folders:** `/Author/Series/Title/...`
+
+### Parsing publish year
+
+`/1984 - Hackers/...`\
+Will save the publish year as `1984` and the title as `Hackers`
+
+### Parsing volume number (only for series)
+
+`/Book 3 - Hackers/...`\
+Will save the volume number as `3` and the title as `Hackers`
+
+`Book` `Volume` `Vol` `Vol.` are all supported case insensitive
+
+These combinations will also work:\
+`/Hackers - Vol. 3/...`\
+`/1984 - Volume 3 - Hackers/...`\
+`/1984 - Hackers Book 3/...`
 
 
-#### Features coming soon:
+### Parsing subtitles (optional in settings)
+
+Title Folder: `/Hackers - Heroes of the Computer Revolution/...`
+
+Will save the title as `Hackers` and the subtitle as `Heroes of the Computer Revolution`
+
+
+### Full example
+
+`/Steven Levy/The Hacker Series/1984 - Hackers - Heroes of the Computer Revolution - Vol. 1/...`
+
+**Becomes:**
+| Key           | Value                             |
+|---------------|-----------------------------------|
+| Author        | Steven Levy                       |
+| Series        | The Hacker Series                 |
+| Publish Year  | 1984                              |
+| Title         | Hackers                           |
+| Subtitle      | Heroes of the Computer Revolution |
+| Volume Number | 1                                 |
+
+
+## Features coming soon
 
 * Support different views to see more details of each audiobook
 * iOS App (Android is in beta [here](https://play.google.com/store/apps/details?id=com.audiobookshelf.app))
 
-<img alt="Screenshot2" src="https://github.com/advplyr/audiobookshelf/raw/master/images/ss_audiobook.png" />
-
 ## Installation
 
 Built to run in Docker for now (also on Unraid server Community Apps)

server/Server.js

@@ -123,6 +123,51 @@ class Server {
     this.auth.authMiddleware(req, res, next)
   }
 
+  async handleUpload(req, res) {
+    if (!req.user.canUpload) {
+      Logger.warn('User attempted to upload without permission', req.user)
+      return res.sendStatus(403)
+    }
+    var files = Object.values(req.files)
+    var title = req.body.title
+    var author = req.body.author
+    var series = req.body.series
+
+    if (!files.length || !title || !author) {
+      return res.json({
+        error: 'Invalid post data received'
+      })
+    }
+
+    var outputDirectory = ''
+    if (series && series.length && series !== 'null') {
+      outputDirectory = Path.join(this.AudiobookPath, author, series, title)
+    } else {
+      outputDirectory = Path.join(this.AudiobookPath, author, title)
+    }
+
+    var exists = await fs.pathExists(outputDirectory)
+    if (exists) {
+      Logger.error(`[Server] Upload directory "${outputDirectory}" already exists`)
+      return res.json({
+        error: `Directory "${outputDirectory}" already exists`
+      })
+    }
+
+    await fs.ensureDir(outputDirectory)
+    Logger.info(`Uploading ${files.length} files to`, outputDirectory)
+
+    for (let i = 0; i < files.length; i++) {
+      var file = files[i]
+
+      var path = Path.join(outputDirectory, file.name)
+      await file.mv(path).catch((error) => {
+        Logger.error('Failed to move file', path, error)
+      })
+    }
+    res.sendStatus(200)
+  }
+
   async start() {
     Logger.info('=== Starting Server ===')
 
@@ -157,38 +202,7 @@ class Server {
     // app.use('/hls', this.hlsController.router)
     app.use('/feeds', this.rssFeeds.router)
 
-    app.post('/upload', this.authMiddleware.bind(this), async (req, res) => {
-      var files = Object.values(req.files)
-      var title = req.body.title
-      var author = req.body.author
-      var series = req.body.series
-
-      if (!files.length || !title || !author) {
-        return res.json({
-          error: 'Invalid post data received'
-        })
-      }
-
-      var outputDirectory = ''
-      if (series && series.length && series !== 'null') {
-        outputDirectory = Path.join(this.AudiobookPath, author, series, title)
-      } else {
-        outputDirectory = Path.join(this.AudiobookPath, author, title)
-      }
-
-      await fs.ensureDir(outputDirectory)
-      Logger.info(`Uploading ${files.length} files to`, outputDirectory)
-
-      for (let i = 0; i < files.length; i++) {
-        var file = files[i]
-
-        var path = Path.join(outputDirectory, file.name)
-        await file.mv(path).catch((error) => {
-          Logger.error('Failed to move file', path, error)
-        })
-      }
-      res.sendStatus(200)
-    })
+    app.post('/upload', this.authMiddleware.bind(this), this.handleUpload.bind(this))
 
     app.post('/login', (req, res) => this.auth.login(req, res))
     app.post('/logout', this.logout.bind(this))

server/objects/Book.js

@@ -151,7 +151,7 @@ class Book {
   // If audiobook directory path was changed, check and update properties set from dirnames
   // May be worthwhile checking if these were manually updated and not override manual updates
   syncPathsUpdated(audiobookData) {
-    var keysToSync = ['author', 'title', 'series', 'publishYear']
+    var keysToSync = ['author', 'title', 'series', 'publishYear', 'volumeNumber']
     var syncPayload = {}
     keysToSync.forEach((key) => {
       if (audiobookData[key]) syncPayload[key] = audiobookData[key]

server/objects/Stream.js

@@ -171,13 +171,11 @@ class Stream extends EventEmitter {
         this.furthestSegmentCreated = lastSegment
       }
 
-      // console.log('SORT', [...this.segmentsCreated].slice(0, 200).join(', '), segments.slice(0, 200).join(', '))
       segments.forEach((seg) => {
         if (!current_chunk.length || last_seg_in_chunk + 1 === seg) {
           last_seg_in_chunk = seg
           current_chunk.push(seg)
         } else {
-          // console.log('Last Seg is not equal to - 1', last_seg_in_chunk, seg)
           if (current_chunk.length === 1) chunks.push(current_chunk[0])
           else chunks.push(`${current_chunk[0]}-${current_chunk[current_chunk.length - 1]}`)
           last_seg_in_chunk = seg

server/objects/User.js

@@ -32,6 +32,9 @@ class User {
   get canDownload() {
     return !!this.permissions.download && this.isActive
   }
+  get canUpload() {
+    return !!this.permissions.upload && this.isActive
+  }
 
   getDefaultUserSettings() {
     return {
@@ -47,7 +50,8 @@ class User {
     return {
       download: true,
       update: true,
-      delete: this.id === 'root'
+      delete: this.type === 'root',
+      upload: this.type === 'root' || this.type === 'admin'
     }
   }
 
@@ -112,6 +116,8 @@ class User {
     this.createdAt = user.createdAt || Date.now()
     this.settings = user.settings || this.getDefaultUserSettings()
     this.permissions = user.permissions || this.getDefaultUserPermissions()
+    // Upload permission added v1.1.13, make sure root user has upload permissions
+    if (this.type === 'root' && !this.permissions.upload) this.permissions.upload = true
   }
 
   update(payload) {

server/utils/scandir.js

@@ -155,10 +155,39 @@ function getAudiobookDataFromDir(abRootPath, dir, parseSubtitle = false) {
   // If there are at least 2 more directories, next furthest will be the series
   if (splitDir.length > 1) series = splitDir.pop()
   if (splitDir.length > 0) author = splitDir.pop()
-
   // There could be many more directories, but only the top 3 are used for naming /author/series/title/
 
 
+  // If in a series directory check for volume number match
+  /* ACCEPTS:
+    Book 2 - Title Here - Subtitle Here
+    Title Here - Subtitle Here - Vol 12
+    Title Here - volume 9 - Subtitle Here
+    Vol. 3 Title Here - Subtitle Here
+    1980 - Book 2-Title Here
+    Title Here-Volume 999-Subtitle Here
+  */
+  var volumeNumber = null
+  if (series) {
+    var volumeMatch = title.match(/(-(?: ?))?\b((?:Book|Vol.?|Volume) \b(\d{1,3}))((?: ?)-)?/i)
+    if (volumeMatch && volumeMatch.length > 3 && volumeMatch[2] && volumeMatch[3]) {
+      volumeNumber = volumeMatch[3]
+      var replaceChunk = volumeMatch[2]
+
+      // "1980 - Book 2-Title Here"
+      // Group 1 would be "- "
+      // Group 3 would be "-"
+      // Only remove the first group
+      if (volumeMatch[1]) {
+        replaceChunk = volumeMatch[1] + replaceChunk
+      } else if (volumeMatch[4]) {
+        replaceChunk += volumeMatch[4]
+      }
+      title = title.replace(replaceChunk, '').trim()
+    }
+  }
+
+
   var publishYear = null
   // If Title is of format 1999 - Title, then use 1999 as publish year
   var publishYearMatch = title.match(/^([0-9]{4}) - (.+)/)
@@ -169,7 +198,9 @@ function getAudiobookDataFromDir(abRootPath, dir, parseSubtitle = false) {
     }
   }
 
+
   // Subtitle can be parsed from the title if user enabled
+  // Subtitle is everything after " - "
   var subtitle = null
   if (parseSubtitle && title.includes(' - ')) {
     var splitOnSubtitle = title.split(' - ')
@@ -182,6 +213,7 @@ function getAudiobookDataFromDir(abRootPath, dir, parseSubtitle = false) {
     title,
     subtitle,
     series,
+    volumeNumber,
     publishYear,
     path: dir, // relative audiobook path i.e. /Author Name/Book Name/..
     fullPath: Path.join(abRootPath, dir) // i.e. /audiobook/Author Name/Book Name/..