Implement the HereSphere API

graphql/documents/data/config.graphql

@@ -114,6 +114,15 @@ fragment ConfigDLNAData on ConfigDLNAResult {
   videoSortOrder
 }
 
+fragment ConfigHSPData on ConfigHSPResult {
+  enabled
+  favoriteTagId
+  writeFavorites
+  writeRatings
+  writeTags
+  writeDeletes
+}
+
 fragment ConfigScrapingData on ConfigScrapingResult {
   scraperUserAgent
   scraperCertCheck
@@ -212,6 +221,9 @@ fragment ConfigData on ConfigResult {
   dlna {
     ...ConfigDLNAData
   }
+  hsp {
+    ...ConfigHSPData
+  }
   scraping {
     ...ConfigScrapingData
   }

graphql/documents/mutations/config.graphql

@@ -24,6 +24,12 @@ mutation ConfigureDLNA($input: ConfigDLNAInput!) {
   }
 }
 
+mutation ConfigureHSP($input: ConfigHSPInput!) {
+  configureHSP(input: $input) {
+    ...ConfigHSPData
+  }
+}
+
 mutation ConfigureScraping($input: ConfigScrapingInput!) {
   configureScraping(input: $input) {
     ...ConfigScrapingData

graphql/schema/schema.graphql

@@ -322,6 +322,7 @@ type Mutation {
   configureGeneral(input: ConfigGeneralInput!): ConfigGeneralResult!
   configureInterface(input: ConfigInterfaceInput!): ConfigInterfaceResult!
   configureDLNA(input: ConfigDLNAInput!): ConfigDLNAResult!
+  configureHSP(input: ConfigHSPInput!): ConfigHSPResult!
   configureScraping(input: ConfigScrapingInput!): ConfigScrapingResult!
   configureDefaults(
     input: ConfigDefaultSettingsInput!

graphql/schema/types/config.graphql

@@ -481,6 +481,36 @@ type ConfigDLNAResult {
   videoSortOrder: String!
 }
 
+input ConfigHSPInput {
+  "True if HSP Api should be enabled by default"
+  enabled: Boolean
+  "ID of the favorite tag"
+  favoriteTagId: Int
+  "True if writing favorites to HSP Api should be enabled"
+  writeFavorites: Boolean
+  "True if writing ratings to HSP Api should be enabled"
+  writeRatings: Boolean
+  "True if writing tags to HSP Api should be enabled"
+  writeTags: Boolean
+  "True if writing deletes to HSP Api should be enabled"
+  writeDeletes: Boolean
+}
+
+type ConfigHSPResult {
+  "True if HSP Api should be enabled by default"
+  enabled: Boolean!
+  "ID of the favorite tag"
+  favoriteTagId: Int!
+  "True if writing favorites to HSP Api should be enabled"
+  writeFavorites: Boolean!
+  "True if writing ratings to HSP Api should be enabled"
+  writeRatings: Boolean!
+  "True if writing tags to HSP Api should be enabled"
+  writeTags: Boolean!
+  "True if writing deletes to HSP Api should be enabled"
+  writeDeletes: Boolean!
+}
+
 input ConfigScrapingInput {
   "Scraper user agent string"
   scraperUserAgent: String
@@ -532,6 +562,7 @@ type ConfigResult {
   general: ConfigGeneralResult!
   interface: ConfigInterfaceResult!
   dlna: ConfigDLNAResult!
+  hsp: ConfigHSPResult!
   scraping: ConfigScrapingResult!
   defaults: ConfigDefaultSettingsResult!
   ui: Map!

internal/api/authentication.go

@@ -26,7 +26,7 @@ const (
 
 func allowUnauthenticated(r *http.Request) bool {
 	// #2715 - allow access to UI files
-	return strings.HasPrefix(r.URL.Path, loginEndpoint) || r.URL.Path == logoutEndpoint || r.URL.Path == "/css" || strings.HasPrefix(r.URL.Path, "/assets")
+	return strings.HasPrefix(r.URL.Path, loginEndpoint) || r.URL.Path == logoutEndpoint || r.URL.Path == "/css" || strings.HasPrefix(r.URL.Path, "/assets") || strings.HasPrefix(r.URL.Path, "/heresphere")
 }
 
 func authenticateHandler() func(http.Handler) http.Handler {
@@ -84,7 +84,7 @@ func authenticateHandler() func(http.Handler) http.Handler {
 						return
 					}
 
-					prefix := getProxyPrefix(r)
+					prefix := manager.GetProxyPrefix(r)
 
 					// otherwise redirect to the login page
 					returnURL := url.URL{

internal/api/resolver_mutation_configure.go

@@ -542,6 +542,35 @@ func (r *mutationResolver) ConfigureDlna(ctx context.Context, input ConfigDLNAIn
 	return makeConfigDLNAResult(), nil
 }
 
+func (r *mutationResolver) ConfigureHsp(ctx context.Context, input ConfigHSPInput) (*ConfigHSPResult, error) {
+	c := config.GetInstance()
+
+	if input.Enabled != nil {
+		c.Set(config.HSPDefaultEnabled, *input.Enabled)
+	}
+	if input.FavoriteTagID != nil {
+		c.Set(config.HSPFavoriteTag, *input.FavoriteTagID)
+	}
+	if input.WriteFavorites != nil {
+		c.Set(config.HSPWriteFavorites, *input.WriteFavorites)
+	}
+	if input.WriteRatings != nil {
+		c.Set(config.HSPWriteRating, *input.WriteRatings)
+	}
+	if input.WriteTags != nil {
+		c.Set(config.HSPWriteTags, *input.WriteTags)
+	}
+	if input.WriteDeletes != nil {
+		c.Set(config.HSPWriteDeletes, *input.WriteDeletes)
+	}
+
+	if err := c.Write(); err != nil {
+		return makeConfigHSPResult(), err
+	}
+
+	return makeConfigHSPResult(), nil
+}
+
 func (r *mutationResolver) ConfigureScraping(ctx context.Context, input ConfigScrapingInput) (*ConfigScrapingResult, error) {
 	c := config.GetInstance()
 

internal/api/resolver_query_configuration.go

@@ -64,6 +64,7 @@ func makeConfigResult() *ConfigResult {
 		General:   makeConfigGeneralResult(),
 		Interface: makeConfigInterfaceResult(),
 		Dlna:      makeConfigDLNAResult(),
+		Hsp:       makeConfigHSPResult(),
 		Scraping:  makeConfigScrapingResult(),
 		Defaults:  makeConfigDefaultsResult(),
 		UI:        makeConfigUIResult(),
@@ -203,6 +204,19 @@ func makeConfigDLNAResult() *ConfigDLNAResult {
 	}
 }
 
+func makeConfigHSPResult() *ConfigHSPResult {
+	config := config.GetInstance()
+
+	return &ConfigHSPResult{
+		Enabled:        config.GetHSPDefaultEnabled(),
+		FavoriteTagID:  config.GetHSPFavoriteTag(),
+		WriteFavorites: config.GetHSPWriteFavorites(),
+		WriteRatings:   config.GetHSPWriteRatings(),
+		WriteTags:      config.GetHSPWriteTags(),
+		WriteDeletes:   config.GetHSPWriteDeletes(),
+	}
+}
+
 func makeConfigScrapingResult() *ConfigScrapingResult {
 	config := config.GetInstance()
 

internal/api/server.go

@@ -30,6 +30,7 @@ import (
 
 	"github.com/stashapp/stash/internal/api/loaders"
 	"github.com/stashapp/stash/internal/build"
+	"github.com/stashapp/stash/internal/heresphere"
 	"github.com/stashapp/stash/internal/manager"
 	"github.com/stashapp/stash/internal/manager/config"
 	"github.com/stashapp/stash/pkg/fsutil"
@@ -179,7 +180,7 @@ func Initialize() (*Server, error) {
 	r.HandleFunc(gqlEndpoint, gqlHandlerFunc)
 	r.HandleFunc(playgroundEndpoint, func(w http.ResponseWriter, r *http.Request) {
 		setPageSecurityHeaders(w, r, pluginCache.ListPlugins())
-		endpoint := getProxyPrefix(r) + gqlEndpoint
+		endpoint := manager.GetProxyPrefix(r) + gqlEndpoint
 		gqlPlayground.Handler("GraphQL playground", endpoint)(w, r)
 	})
 
@@ -191,6 +192,7 @@ func Initialize() (*Server, error) {
 	r.Mount("/tag", server.getTagRoutes())
 	r.Mount("/downloads", server.getDownloadsRoutes())
 	r.Mount("/plugin", server.getPluginRoutes())
+	r.Mount("/heresphere", server.getHeresphereRoutes())
 
 	r.HandleFunc("/css", cssHandler(cfg))
 	r.HandleFunc("/javascript", javascriptHandler(cfg))
@@ -237,7 +239,7 @@ func Initialize() (*Server, error) {
 			}
 			indexHtml := string(data)
 
-			prefix := getProxyPrefix(r)
+			prefix := manager.GetProxyPrefix(r)
 			indexHtml = strings.ReplaceAll(indexHtml, "%COLOR%", themeColor)
 			indexHtml = strings.Replace(indexHtml, `<base href="/"`, fmt.Sprintf(`<base href="%s/"`, prefix), 1)
 
@@ -344,6 +346,11 @@ func (s *Server) getPluginRoutes() chi.Router {
 	}.Routes()
 }
 
+func (s *Server) getHeresphereRoutes() chi.Router {
+	repo := s.manager.Repository
+	return heresphere.GetRoutes(repo)
+}
+
 func copyFile(w io.Writer, path string) error {
 	f, err := os.Open(path)
 	if err != nil {
@@ -568,26 +575,10 @@ func BaseURLMiddleware(next http.Handler) http.Handler {
 	fn := func(w http.ResponseWriter, r *http.Request) {
 		ctx := r.Context()
 
-		scheme := "http"
-		if strings.Compare("https", r.URL.Scheme) == 0 || r.TLS != nil || r.Header.Get("X-Forwarded-Proto") == "https" {
-			scheme = "https"
-		}
-		prefix := getProxyPrefix(r)
-
-		baseURL := scheme + "://" + r.Host + prefix
-
-		externalHost := config.GetInstance().GetExternalHost()
-		if externalHost != "" {
-			baseURL = externalHost + prefix
-		}
-
+		baseURL := manager.GetBaseURL(r)
 		r = r.WithContext(context.WithValue(ctx, BaseURLCtxKey, baseURL))
 
 		next.ServeHTTP(w, r)
 	}
 	return http.HandlerFunc(fn)
 }
-
-func getProxyPrefix(r *http.Request) string {
-	return strings.TrimRight(r.Header.Get("X-Forwarded-Prefix"), "/")
-}

internal/api/session.go

@@ -34,7 +34,7 @@ type loginTemplateData struct {
 
 func serveLoginPage(w http.ResponseWriter, r *http.Request, returnURL string, loginError string) {
 	loginPage := string(getLoginPage())
-	prefix := getProxyPrefix(r)
+	prefix := manager.GetProxyPrefix(r)
 	loginPage = strings.ReplaceAll(loginPage, "/%BASE_URL%", prefix)
 
 	templ, err := template.New("Login").Parse(loginPage)
@@ -66,7 +66,7 @@ func handleLogin() http.HandlerFunc {
 			if returnURL != "" {
 				http.Redirect(w, r, returnURL, http.StatusFound)
 			} else {
-				prefix := getProxyPrefix(r)
+				prefix := manager.GetProxyPrefix(r)
 				http.Redirect(w, r, prefix+"/", http.StatusFound)
 			}
 			return
@@ -80,7 +80,7 @@ func handleLoginPost() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
 		url := r.FormValue(returnURLParam)
 		if url == "" {
-			url = getProxyPrefix(r) + "/"
+			url = manager.GetProxyPrefix(r) + "/"
 		}
 
 		err := manager.GetInstance().SessionStore.Login(w, r)
@@ -114,7 +114,7 @@ func handleLogout() http.HandlerFunc {
 		}
 
 		// redirect to the login page if credentials are required
-		prefix := getProxyPrefix(r)
+		prefix := manager.GetProxyPrefix(r)
 		if config.GetInstance().HasCredentials() {
 			http.Redirect(w, r, prefix+loginEndpoint, http.StatusFound)
 		} else {

internal/heresphere/auth.go

@@ -0,0 +1,101 @@
+package heresphere
+
+import (
+	"encoding/json"
+	"fmt"
+	"net/http"
+	"net/url"
+
+	"github.com/stashapp/stash/internal/manager"
+	"github.com/stashapp/stash/internal/manager/config"
+	"github.com/stashapp/stash/pkg/logger"
+	"github.com/stashapp/stash/pkg/session"
+)
+
+/*
+ * This auxiliary function finds if a login is needed, and auth is correct.
+ */
+func basicLogin(username string, password string) bool {
+	// If needs creds, try login
+	if config.GetInstance().HasCredentials() {
+		err := manager.GetInstance().SessionStore.LoginPlain(username, password)
+		return err != nil
+	}
+	return false
+}
+
+/*
+ * This auxiliary function finds if the request has a valid auth token.
+ */
+func HeresphereHasValidToken(r *http.Request) bool {
+	// Check header auth
+	apiKey := r.Header.Get(HeresphereAuthHeader)
+
+	// Check url query auth
+	if len(apiKey) == 0 {
+		apiKey = r.URL.Query().Get(session.ApiKeyParameter)
+	}
+
+	return len(apiKey) > 0 && apiKey == config.GetInstance().GetAPIKey()
+}
+
+/*
+ * This auxiliary function adds an auth token to a url
+ */
+func addApiKey(urlS string) string {
+	// Parse URL
+	u, err := url.Parse(urlS)
+	if err != nil {
+		// shouldn't happen
+		panic(err)
+	}
+
+	// Add apikey if applicable
+	if config.GetInstance().GetAPIKey() != "" {
+		v := u.Query()
+		if !v.Has("apikey") {
+			v.Set("apikey", config.GetInstance().GetAPIKey())
+		}
+		u.RawQuery = v.Encode()
+	}
+
+	return u.String()
+}
+
+/*
+ * This auxiliary writes a library with a fake name upon auth failure
+ */
+func writeNotAuthorized(w http.ResponseWriter, r *http.Request, msg string) {
+	// Banner
+	banner := HeresphereBanner{
+		Image: fmt.Sprintf("%s%s",
+			manager.GetBaseURL(r),
+			"/apple-touch-icon.png",
+		),
+		Link: fmt.Sprintf("%s%s",
+			manager.GetBaseURL(r),
+			"/",
+		),
+	}
+	// Default video
+	library := HeresphereIndexEntry{
+		Name: msg,
+		List: []string{},
+	}
+	// Index
+	idx := HeresphereIndex{
+		Access:  HeresphereBadLogin,
+		Banner:  banner,
+		Library: []HeresphereIndexEntry{library},
+	}
+
+	// Create a JSON encoder for the response writer
+	w.Header().Set("Content-Type", "application/json")
+	enc := json.NewEncoder(w)
+	enc.SetEscapeHTML(false)
+	if err := enc.Encode(idx); err != nil {
+		logger.Errorf("Heresphere writeNotAuthorized error: %s\n", err.Error())
+		http.Error(w, err.Error(), http.StatusInternalServerError)
+		return
+	}
+}