Configurable title format for DeoVR

Author: CoolMintChocolate

pkg/api/deovr.go

@@ -339,7 +339,7 @@ func (i DeoVRResource) getDeoScene(req *restful.Request, resp *restful.Response)
 					Height:     height,
 					Width:      width,
 					Size:       file.Size,
-					URL:        fmt.Sprintf("%v/api/dms/file/%v/%v%v", session.DeoRequestHost, file.ID, scene.GetFunscriptTitle(), dnt),
+					URL:        fmt.Sprintf("%v/api/dms/file/%v/%v%v", session.DeoRequestHost, file.ID, scene.GetFunscriptTitle(config.Config.Interfaces.DeoVR.TitleFormat), dnt),
 				},
 			},
 		}
@@ -425,11 +425,11 @@ func (i DeoVRResource) getDeoScene(req *restful.Request, resp *restful.Response)
 		}
 	}
 
-	title := scene.Title
+	title := scene.GetDeoFormattedTitle(config.Config.Interfaces.DeoVR.TitleFormat)
 	thumbnailURL := session.DeoRequestHost + "/img/700x/" + strings.Replace(scene.CoverURL, "://", ":/", -1)
 
 	if scene.IsScripted {
-		title = scene.GetFunscriptTitle()
+		title = scene.GetFunscriptTitle(config.Config.Interfaces.DeoVR.TitleFormat)
 		if config.Config.Interfaces.DeoVR.RenderHeatmaps {
 			thumbnailURL = session.DeoRequestHost + "/imghm/" + fmt.Sprint(scene.ID) + "/" + strings.Replace(scene.CoverURL, "://", ":/", -1)
 		}
@@ -530,9 +530,8 @@ func scenesToDeoList(req *restful.Request, scenes []models.Scene) []DeoListItem
 		if config.Config.Interfaces.DeoVR.RenderHeatmaps && scenes[i].IsScripted {
 			thumbnailURL = fmt.Sprintf("%v/imghm/%d/%v", session.DeoRequestHost, scenes[i].ID, strings.Replace(scenes[i].CoverURL, "://", ":/", -1))
 		}
-
 		item := DeoListItem{
-			Title:        scenes[i].Title,
+			Title:        scenes[i].GetDeoFormattedTitle(config.Config.Interfaces.DeoVR.TitleFormat),
 			VideoLength:  scenes[i].Duration * 60,
 			ThumbnailURL: thumbnailURL,
 			VideoURL:     fmt.Sprintf("%v/deovr/%v", session.DeoRequestHost, scenes[i].ID),

pkg/api/options.go

@@ -62,6 +62,7 @@ type RequestSaveOptionsDeoVR struct {
 	RemoteEnabled  bool   `json:"remote_enabled"`
 	TrackWatchTime bool   `json:"track_watch_time"`
 	RenderHeatmaps bool   `json:"render_heatmaps"`
+	TitleFormat    string `json:"title_format"`
 }
 
 type RequestSaveOptionsPreviews struct {
@@ -256,6 +257,7 @@ func (i ConfigResource) saveOptionsDeoVR(req *restful.Request, resp *restful.Res
 	config.Config.Interfaces.DeoVR.RemoteEnabled = r.RemoteEnabled
 	config.Config.Interfaces.DeoVR.TrackWatchTime = r.TrackWatchTime
 	config.Config.Interfaces.DeoVR.Username = r.Username
+	config.Config.Interfaces.DeoVR.TitleFormat = r.TitleFormat
 	if r.Password != config.Config.Interfaces.DeoVR.Password && r.Password != "" {
 		hash, _ := bcrypt.GenerateFromPassword([]byte(r.Password), bcrypt.DefaultCost)
 		config.Config.Interfaces.DeoVR.Password = string(hash)

pkg/config/config.go

@@ -45,6 +45,7 @@ type ObjectConfig struct {
 			RemoteEnabled  bool   `default:"false" json:"remote_enabled"`
 			Username       string `default:"" json:"username"`
 			Password       string `default:"" json:"password"`
+			TitleFormat    string `default:"{{.Title}}" json:"title_format"`
 		} `json:"deovr"`
 	} `json:"interfaces"`
 	Library struct {

pkg/models/model_scene.go

@@ -1,12 +1,14 @@
 package models
 
 import (
+	"bytes"
 	"encoding/json"
 	"fmt"
 	"os"
 	"path/filepath"
 	"regexp"
 	"strings"
+	"text/template"
 	"time"
 
 	"github.com/araddon/dateparse"
@@ -172,12 +174,32 @@ func (o *Scene) GetIfExistURL(u string) error {
 		Where(&Scene{SceneURL: u}).First(o).Error
 }
 
-func (o *Scene) GetFunscriptTitle() string {
+func (scene *Scene) GetDeoFormattedTitle(titleFormat string) string {
+	customTitleTemplate, err := template.New("customTitleTemplate").Parse(titleFormat)
+	if err != nil {
+		common.Log.Warn(err)
+		customTitleTemplate, err = template.New("customTitleTemplate").Parse("{{.Title}}")
+		if err != nil {
+			return scene.Title
+		}
+	}
+	var tpl bytes.Buffer
+	title := scene.Title
+	err = customTitleTemplate.Execute(&tpl, scene)
+	if err == nil {
+		title = tpl.String()
+	} else {
+		common.Log.Warn(err)
+	}
+	return title
+}
+
+func (o *Scene) GetFunscriptTitle(titleFormat string) string {
 
 	// first make the title filename safe
 	var re = regexp.MustCompile(`[?/\<>|]`)
 
-	title := o.Title
+	title := o.GetDeoFormattedTitle(titleFormat)
 	// Colons are pretty common in titles, so we use a unicode alternative
 	title = strings.ReplaceAll(title, ":", "꞉")
 	// all other unsafe characters get removed

pkg/tasks/funscripts.go

@@ -7,6 +7,7 @@ import (
 	"net/http"
 	"os"
 
+	"github.com/xbapps/xbvr/pkg/config"
 	"github.com/xbapps/xbvr/pkg/models"
 )
 
@@ -39,7 +40,7 @@ func ExportFunscripts(w http.ResponseWriter, updatedOnly bool) {
 			if i == 0 {
 				if file.Exists() {
 					if !file.IsExported || !updatedOnly {
-						funscriptName := fmt.Sprintf("%s.funscript", scene.GetFunscriptTitle())
+						funscriptName := fmt.Sprintf("%s.funscript", scene.GetFunscriptTitle(config.Config.Interfaces.DeoVR.TitleFormat))
 
 						if err = AddFileToZip(zipWriter, file.GetPath(), funscriptName); err != nil {
 							log.Infof("Error when adding file to zip: %v (%s)", err, funscriptName)

ui/src/store/optionsDeoVR.js

@@ -10,6 +10,7 @@ const state = {
     remote_enabled: false,
     username: '',
     password: '',
+    title_format: '',
     boundIp: []
   }
 }
@@ -29,6 +30,7 @@ const actions = {
         state.deovr.remote_enabled = data.config.interfaces.deovr.remote_enabled
         state.deovr.username = data.config.interfaces.deovr.username
         state.deovr.password = data.config.interfaces.deovr.password
+        state.deovr.title_format = data.config.interfaces.deovr.title_format
         state.deovr.boundIp = data.currentState.server.bound_ip
         state.loading = false
       })

ui/src/views/options/sections/InterfaceDeoVR.vue

@@ -58,6 +58,19 @@
                   instructions in DeoVR documentation</a>.
                 </p>
               </div>
+              <hr/>
+              <div class="block">
+                <b-field label="Title Format">
+                  <b-input v-model="titleFormat"></b-input>
+                </b-field>
+                <p>
+                  Custom Title format to use in DeoVR, following Golang's template <a href="https://golang.org/pkg/text/template/" target="_blank" rel="noreferrer">format</a>.
+                  Examples:
+                </p>
+                <ul>
+                  <pre v-pre><li>{{.Studio}} - {{.Title}}</li><li>{{.Title}} ({{.ReleaseDate.Format "2006"}})</li></pre>
+                </ul>
+              </div>
             </div>
           </section>
         </div>
@@ -162,6 +175,14 @@ export default {
         this.$store.state.optionsDeoVR.deovr.password = value
       }
     },
+    titleFormat: {
+      get () {
+        return this.$store.state.optionsDeoVR.deovr.title_format
+      },
+      set (value) {
+        this.$store.state.optionsDeoVR.deovr.title_format = value
+      }
+    },
     boundIp: {
       get () {
         return this.$store.state.optionsDeoVR.deovr.boundIp