Add SFW content mode option

README.md

@@ -9,7 +9,7 @@
 [![GitHub release (latest by date)](https://img.shields.io/github/v/release/stashapp/stash?logo=github)](https://github.com/stashapp/stash/releases/latest)
 [![GitHub issues by-label](https://img.shields.io/github/issues-raw/stashapp/stash/bounty)](https://github.com/stashapp/stash/labels/bounty)
 
-### **Stash is a self-hosted webapp written in Go which organizes and serves your porn.**
+### **Stash is a self-hosted webapp written in Go which organizes and serves your diverse content collection, catering to both your SFW and NSFW needs.**
 ![demo image](docs/readme_assets/demo_image.png)
 
 * Stash gathers information about videos in your collection from the internet, and is extensible through the use of community-built plugins for a large number of content producers and sites.

graphql/schema/types/config.graphql

@@ -2,6 +2,8 @@ input SetupInput {
   "Empty to indicate $HOME/.stash/config.yml default"
   configLocation: String!
   stashes: [StashConfigInput!]!
+  "True if SFW content mode is enabled"
+  sfwContentMode: Boolean
   "Empty to indicate default"
   databaseFile: String!
   "Empty to indicate default"
@@ -341,6 +343,9 @@ type ConfigImageLightboxResult {
 }
 
 input ConfigInterfaceInput {
+  "True if SFW content mode is enabled"
+  sfwContentMode: Boolean
+
   "Ordered list of items that should be shown in the menu"
   menuItems: [String!]
 
@@ -407,6 +412,9 @@ type ConfigDisableDropdownCreate {
 }
 
 type ConfigInterfaceResult {
+  "True if SFW content mode is enabled"
+  sfwContentMode: Boolean!
+
   "Ordered list of items that should be shown in the menu"
   menuItems: [String!]
 

internal/api/images.go

@@ -101,7 +101,7 @@ func initCustomPerformerImages(customPath string) {
 	}
 }
 
-func getDefaultPerformerImage(name string, gender *models.GenderEnum) []byte {
+func getDefaultPerformerImage(name string, gender *models.GenderEnum, sfwMode bool) []byte {
 	// try the custom box first if we have one
 	if performerBoxCustom != nil {
 		ret, err := performerBoxCustom.GetRandomImageByName(name)
@@ -111,6 +111,10 @@ func getDefaultPerformerImage(name string, gender *models.GenderEnum) []byte {
 		logger.Warnf("error loading custom default performer image: %v", err)
 	}
 
+	if sfwMode {
+		return static.ReadAll(static.DefaultSFWPerformerImage)
+	}
+
 	var g models.GenderEnum
 	if gender != nil {
 		g = *gender

internal/api/resolver_mutation_configure.go

@@ -445,6 +445,8 @@ func (r *mutationResolver) ConfigureGeneral(ctx context.Context, input ConfigGen
 func (r *mutationResolver) ConfigureInterface(ctx context.Context, input ConfigInterfaceInput) (*ConfigInterfaceResult, error) {
 	c := config.GetInstance()
 
+	r.setConfigBool(config.SFWContentMode, input.SfwContentMode)
+
 	if input.MenuItems != nil {
 		c.SetInterface(config.MenuItems, input.MenuItems)
 	}

internal/api/resolver_query_configuration.go

@@ -162,6 +162,7 @@ func makeConfigInterfaceResult() *ConfigInterfaceResult {
 	disableDropdownCreate := config.GetDisableDropdownCreate()
 
 	return &ConfigInterfaceResult{
+		SfwContentMode:               config.GetSFWContentMode(),
 		MenuItems:                    menuItems,
 		SoundOnPreview:               &soundOnPreview,
 		WallShowTitle:                &wallShowTitle,

internal/api/routes_performer.go

@@ -18,9 +18,14 @@ type PerformerFinder interface {
 	GetImage(ctx context.Context, performerID int) ([]byte, error)
 }
 
+type sfwConfig interface {
+	GetSFWContentMode() bool
+}
+
 type performerRoutes struct {
 	routes
 	performerFinder PerformerFinder
+	sfwConfig       sfwConfig
 }
 
 func (rs performerRoutes) Routes() chi.Router {
@@ -54,7 +59,7 @@ func (rs performerRoutes) Image(w http.ResponseWriter, r *http.Request) {
 	}
 
 	if len(image) == 0 {
-		image = getDefaultPerformerImage(performer.Name, performer.Gender)
+		image = getDefaultPerformerImage(performer.Name, performer.Gender, rs.sfwConfig.GetSFWContentMode())
 	}
 
 	utils.ServeImage(w, r, image)

internal/api/server.go

@@ -322,6 +322,7 @@ func (s *Server) getPerformerRoutes() chi.Router {
 	return performerRoutes{
 		routes:          routes{txnManager: repo.TxnManager},
 		performerFinder: repo.Performer,
+		sfwConfig:       s.manager.Config,
 	}.Routes()
 }
 

internal/manager/config/config.go

@@ -43,6 +43,9 @@ const (
 	Password            = "password"
 	MaxSessionAge       = "max_session_age"
 
+	// SFWContentMode mode config key
+	SFWContentMode = "sfw_content_mode"
+
 	FFMpegPath  = "ffmpeg_path"
 	FFProbePath = "ffprobe_path"
 
@@ -628,7 +631,15 @@ func (i *Config) getStringMapString(key string) map[string]string {
 	return ret
 }
 
-// GetStathPaths returns the configured stash library paths.
+// GetSFW returns true if SFW mode is enabled.
+// Default performer images are changed to more agnostic images when enabled.
+func (i *Config) GetSFWContentMode() bool {
+	i.RLock()
+	defer i.RUnlock()
+	return i.getBool(SFWContentMode)
+}
+
+// GetStashPaths returns the configured stash library paths.
 // Works opposite to the usual case - it will return the override
 // value only if the main value is not set.
 func (i *Config) GetStashPaths() StashConfigs {

internal/manager/manager.go

@@ -262,6 +262,10 @@ func (s *Manager) Setup(ctx context.Context, input SetupInput) error {
 		cfg.SetString(config.Cache, input.CacheLocation)
 	}
 
+	if input.SFWContentMode {
+		cfg.SetBool(config.SFWContentMode, true)
+	}
+
 	if input.StoreBlobsInDatabase {
 		cfg.SetInterface(config.BlobsStorage, config.BlobStorageTypeDatabase)
 	} else {

internal/manager/models.go

@@ -21,6 +21,7 @@ type SetupInput struct {
 	// Empty to indicate $HOME/.stash/config.yml default
 	ConfigLocation string                     `json:"configLocation"`
 	Stashes        []*config.StashConfigInput `json:"stashes"`
+	SFWContentMode bool                       `json:"sfwContentMode"`
 	// Empty to indicate default
 	DatabaseFile string `json:"databaseFile"`
 	// Empty to indicate default

internal/static/embed.go

@@ -8,12 +8,13 @@ import (
 	"io/fs"
 )
 
-//go:embed performer performer_male scene image gallery tag studio group
+//go:embed performer performer_male performer_sfw scene image gallery tag studio group
 var data embed.FS
 
 const (
-	Performer     = "performer"
-	PerformerMale = "performer_male"
+	Performer                = "performer"
+	PerformerMale            = "performer_male"
+	DefaultSFWPerformerImage = "performer_sfw/performer.svg"
 
 	Scene             = "scene"
 	DefaultSceneImage = "scene/scene.svg"

ui/v2.5/graphql/data/config.graphql

@@ -71,6 +71,7 @@ fragment ConfigGeneralData on ConfigGeneralResult {
 }
 
 fragment ConfigInterfaceData on ConfigInterfaceResult {
+  sfwContentMode
   menuItems
   soundOnPreview
   wallShowTitle

ui/v2.5/src/App.tsx

@@ -31,7 +31,10 @@ import * as GQL from "./core/generated-graphql";
 import { makeTitleProps } from "./hooks/title";
 import { LoadingIndicator } from "./components/Shared/LoadingIndicator";
 
-import { ConfigurationProvider } from "./hooks/Config";
+import {
+  ConfigurationProvider,
+  useConfigurationContextOptional,
+} from "./hooks/Config";
 import { ManualProvider } from "./components/Help/context";
 import { InteractiveProvider } from "./hooks/Interactive/context";
 import { ReleaseNotesDialog } from "./components/Dialogs/ReleaseNotesDialog";
@@ -50,6 +53,7 @@ import { PatchFunction } from "./patch";
 
 import moment from "moment/min/moment-with-locales";
 import { ErrorMessage } from "./components/Shared/ErrorMessage";
+import cx from "classnames";
 
 const Performers = lazyComponent(
   () => import("./components/Performers/Performers")
@@ -104,8 +108,17 @@ const AppContainer: React.FC<React.PropsWithChildren<{}>> = PatchFunction(
 ) as React.FC;
 
 const MainContainer: React.FC = ({ children }) => {
+  // use optional here because the configuration may have be loading or errored
+  const { configuration } = useConfigurationContextOptional() || {};
+  const { sfwContentMode } = configuration?.interface || {};
+
   return (
-    <div className={`main container-fluid ${appleRendering ? "apple" : ""}`}>
+    <div
+      className={cx("main container-fluid", {
+        apple: appleRendering,
+        "sfw-content-mode": sfwContentMode,
+      })}
+    >
       {children}
     </div>
   );
@@ -300,28 +313,36 @@ export const App: React.FC = () => {
     return null;
   }
 
-  if (config.error) {
+  function renderSimple(content: React.ReactNode) {
     return (
       <IntlProvider
         locale={intlLanguage}
         messages={messages}
         formats={intlFormats}
       >
-        <MainContainer>
-          <ErrorMessage
-            message={
-              <FormattedMessage
-                id="errors.loading_type"
-                values={{ type: "configuration" }}
-              />
-            }
-            error={config.error.message}
-          />
-        </MainContainer>
+        <MainContainer>{content}</MainContainer>
       </IntlProvider>
     );
   }
 
+  if (config.loading) {
+    return renderSimple(<LoadingIndicator />);
+  }
+
+  if (config.error) {
+    return renderSimple(
+      <ErrorMessage
+        message={
+          <FormattedMessage
+            id="errors.loading_type"
+            values={{ type: "configuration" }}
+          />
+        }
+        error={config.error.message}
+      />
+    );
+  }
+
   return (
     <ErrorBoundary>
       <IntlProvider
@@ -332,10 +353,7 @@ export const App: React.FC = () => {
         <ToastProvider>
           <PluginsLoader>
             <AppContainer>
-              <ConfigurationProvider
-                configuration={config.data?.configuration}
-                loading={config.loading}
-              >
+              <ConfigurationProvider configuration={config.data!.configuration}>
                 {maybeRenderReleaseNotes()}
                 <ConnectionMonitor />
                 <Suspense fallback={<LoadingIndicator />}>

ui/v2.5/src/components/Dialogs/GenerateDialog.tsx

@@ -6,7 +6,7 @@ import { Icon } from "src/components/Shared/Icon";
 import { useToast } from "src/hooks/Toast";
 import * as GQL from "src/core/generated-graphql";
 import { FormattedMessage, useIntl } from "react-intl";
-import { ConfigurationContext } from "src/hooks/Config";
+import { useConfigurationContext } from "src/hooks/Config";
 import { Manual } from "../Help/Manual";
 import { withoutTypename } from "src/utils/data";
 import { GenerateOptions } from "../Settings/Tasks/GenerateOptions";
@@ -25,7 +25,7 @@ export const GenerateDialog: React.FC<ISceneGenerateDialog> = ({
   onClose,
   type,
 }) => {
-  const { configuration } = React.useContext(ConfigurationContext);
+  const { configuration } = useConfigurationContext();
 
   function getDefaultOptions(): GQL.GenerateMetadataInput {
     return {

ui/v2.5/src/components/FrontPage/Control.tsx

@@ -1,9 +1,9 @@
-import React, { useContext, useMemo } from "react";
+import React, { useMemo } from "react";
 import { useIntl } from "react-intl";
 import { FrontPageContent, ICustomFilter } from "src/core/config";
 import * as GQL from "src/core/generated-graphql";
 import { useFindSavedFilter } from "src/core/StashService";
-import { ConfigurationContext } from "src/hooks/Config";
+import { useConfigurationContext } from "src/hooks/Config";
 import { ListFilterModel } from "src/models/list-filter/filter";
 import { GalleryRecommendationRow } from "../Galleries/GalleryRecommendationRow";
 import { ImageRecommendationRow } from "../Images/ImageRecommendationRow";
@@ -105,7 +105,7 @@ interface ISavedFilterResults {
 const SavedFilterResults: React.FC<ISavedFilterResults> = ({
   savedFilterID,
 }) => {
-  const { configuration: config } = useContext(ConfigurationContext);
+  const { configuration: config } = useConfigurationContext();
   const { loading, data } = useFindSavedFilter(savedFilterID.toString());
 
   const filter = useMemo(() => {
@@ -136,7 +136,7 @@ interface ICustomFilterProps {
 const CustomFilterResults: React.FC<ICustomFilterProps> = ({
   customFilter,
 }) => {
-  const { configuration: config } = useContext(ConfigurationContext);
+  const { configuration: config } = useConfigurationContext();
   const intl = useIntl();
 
   const filter = useMemo(() => {

ui/v2.5/src/components/FrontPage/FrontPage.tsx

@@ -6,7 +6,7 @@ import { Button } from "react-bootstrap";
 import { FrontPageConfig } from "./FrontPageConfig";
 import { useToast } from "src/hooks/Toast";
 import { Control } from "./Control";
-import { ConfigurationContext } from "src/hooks/Config";
+import { useConfigurationContext } from "src/hooks/Config";
 import {
   FrontPageContent,
   generateDefaultFrontPageContent,
@@ -24,7 +24,7 @@ const FrontPage: React.FC = PatchComponent("FrontPage", () => {
 
   const [saveUI] = useConfigureUI();
 
-  const { configuration, loading } = React.useContext(ConfigurationContext);
+  const { configuration } = useConfigurationContext();
 
   useScrollToTopOnMount();
 
@@ -51,7 +51,7 @@ const FrontPage: React.FC = PatchComponent("FrontPage", () => {
     setSaving(false);
   }
 
-  if (loading || saving) {
+  if (saving) {
     return <LoadingIndicator />;
   }
 

ui/v2.5/src/components/FrontPage/FrontPageConfig.tsx

@@ -4,7 +4,7 @@ import { useFindSavedFilters } from "src/core/StashService";
 import { LoadingIndicator } from "../Shared/LoadingIndicator";
 import { Button, Form, Modal } from "react-bootstrap";
 import * as GQL from "src/core/generated-graphql";
-import { ConfigurationContext } from "src/hooks/Config";
+import { useConfigurationContext } from "src/hooks/Config";
 import {
   ISavedFilterRow,
   ICustomFilter,
@@ -277,11 +277,11 @@ interface IFrontPageConfigProps {
 export const FrontPageConfig: React.FC<IFrontPageConfigProps> = ({
   onClose,
 }) => {
-  const { configuration, loading } = React.useContext(ConfigurationContext);
+  const { configuration } = useConfigurationContext();
 
   const ui = configuration?.ui;
 
-  const { data: allFilters, loading: loading2 } = useFindSavedFilters();
+  const { data: allFilters, loading } = useFindSavedFilters();
 
   const [isAdd, setIsAdd] = useState(false);
   const [currentContent, setCurrentContent] = useState<FrontPageContent[]>([]);
@@ -338,7 +338,7 @@ export const FrontPageConfig: React.FC<IFrontPageConfigProps> = ({
     setDragIndex(undefined);
   }
 
-  if (loading || loading2) {
+  if (loading) {
     return <LoadingIndicator />;
   }