Add studio, tags, scene (#3)

* Add tags
* Add studio
* Add scenes support
* Add integration test
* Add gitattributes. Add test targets
* Add DB interface and refactor
* Add performer image
* Replace checksums with fingerprints
* Update dependencies
* Make performers unique on name/disambiguation
* Add first draft of README

Author: WithoutPants

.gitattributes

@@ -0,0 +1,2 @@
+go.mod text eol=lf
+go.sum text eol=lf

Makefile

@@ -20,6 +20,14 @@ generate:
 	go generate
 	packr2
 
+.PHONY: test
+test: 
+	go test ./...
+
+.PHONY: it
+it:
+	go test -tags=integration ./...
+	
 # Runs gofmt -w on the project's source code, modifying any files that do not match its style.
 .PHONY: fmt
 fmt:

README.md

@@ -1,2 +1,98 @@
 # stash-box
-Stash App's own OpenSource video indexing and Perceptual Hashing MetaData API
+
+[![Discord](https://img.shields.io/discord/559159668438728723.svg?logo=discord)](https://discord.gg/2TsNFKt)
+
+**stash-box is Stash App's own OpenSource video indexing and Perceptual Hashing MetaData API for porn.**
+
+The intent of stash-box is to provide a collaborative, crowd-sourced database of porn metadata, in the same way as [MusicBrainz](https://musicbrainz.org/) does for music. The submission and editing of metadata is expected to follow the same principle as that of the MusicBrainz database. [See here](https://musicbrainz.org/doc/Editing_FAQ) for how MusicBrainz does it.
+
+Currently, stash-box provides a graphql backend API only. There is no built in UI. The graphql playground can be accessed at `host:port/playground`. The graphql interface is at `host:port/graphql`.
+
+# Docker install
+
+TODO
+
+# Bare-metal Install
+
+Stash-box supports macOS, Windows, and Linux.  
+
+Releases TODO
+
+## CLI
+
+Stash-box provides some command line options.  See what is currently available by running `stashdb --help`.
+
+For example, to run stash locally on port 80 run it like this (OSX / Linux) `stashdb --host 127.0.0.1 --port 80`
+
+## Configuration
+
+Stash-box generates a configuration file in the current working directory when it is first started up. This configuration file is generated with the following defaults:
+- running on `0.0.0.0` port `9998`
+- sqlite3 database generated in the current working directory named `stashdb-go.sqlite`
+- generated read (`read_api_key`) and write (`modify_api_key`) API keys. These can be deleted to disable read/write authentication (all requests will be allowed without API key)
+
+### API keys
+
+These are a very basic authorization method. When set, the `ApiKey` header must be set to the correct value to read/write the data. The write API key allows reading and writing. The read API key allows only reading.
+
+## SSL (HTTPS)
+
+Stash-box supports HTTPS with some additional work.  First you must generate a SSL certificate and key combo.  Here is an example using openssl:
+
+`openssl req -x509 -newkey rsa:4096 -sha256 -days 7300 -nodes -keyout stashdb.key -out stashdb.crt -extensions san -config <(echo "[req]"; echo distinguished_name=req; echo "[san]"; echo subjectAltName=DNS:stashdb.server,IP:127.0.0.1) -subj /CN=stashdb.server`
+
+This command would need customizing for your environment.  [This link](https://stackoverflow.com/questions/10175812/how-to-create-a-self-signed-certificate-with-openssl) might be useful.
+
+Once you have a certificate and key file name them `stashdb.crt` and `stashdb.key` and place them in the directory where stash-box is run from. Stash-box detects these and starts up using HTTPS rather than HTTP.
+
+# FAQ
+
+> I have a question not answered here.
+
+Join the [Discord server](https://discord.gg/2TsNFKt).
+
+# Development
+
+## Install
+
+* [Revive](https://github.com/mgechev/revive) - Configurable linter
+    * Go Install: `go get github.com/mgechev/revive`
+* [Packr2](https://github.com/gobuffalo/packr/tree/v2.0.2/v2) - Static asset bundler
+    * Go Install: `go get github.com/gobuffalo/packr/v2/[email protected]`
+    * [Binary Download](https://github.com/gobuffalo/packr/releases)
+* [Yarn](https://yarnpkg.com/en/docs/install) - Yarn package manager
+
+NOTE: You may need to run the `go get` commands outside the project directory to avoid modifying the projects module file.
+
+## Environment
+
+### macOS
+
+TODO
+
+### Windows
+
+1. Download and install [Go for Windows](https://golang.org/dl/)
+2. Download and install [MingW](https://sourceforge.net/projects/mingw-w64/)
+3. Search for "advanced system settings" and open the system properties dialog.
+    1. Click the `Environment Variables` button
+    2. Add `GO111MODULE=on`
+    3. Under system variables find the `Path`.  Edit and add `C:\Program Files\mingw-w64\*\mingw64\bin` (replace * with the correct path).
+
+## Commands
+
+* `make generate` - Generate Go GraphQL and packr2 files. This should be run if the graphql schema or schema migration files have changed.
+* `make build` - Builds the binary
+* `make vet` - Run `go vet`
+* `make lint` - Run the linter
+* `make test` - Runs the unit tests
+* `make it` - Runs the unit and integration tests
+
+## Building a release
+
+1. Run `make generate` to create generated files 
+2. Run `make build` to build the executable for your current platform
+
+## Cross compiling
+
+TODO

go.mod

@@ -9,7 +9,6 @@ require (
 	github.com/golang-migrate/migrate/v4 v4.3.1
 	github.com/gorilla/websocket v1.4.0
 	github.com/h2non/filetype v1.0.8
-	github.com/inconshreveable/mousetrap v1.0.0 // indirect
 	github.com/jmoiron/sqlx v1.2.0
 	github.com/mattn/go-sqlite3 v1.10.0
 	github.com/pkg/errors v0.8.1

go.sum

@@ -243,6 +243,7 @@ github.com/gobuffalo/packr v1.15.0/go.mod h1:t5gXzEhIviQwVlNx/+3SfS07GS+cZ2hn76W
 github.com/gobuffalo/packr v1.15.1/go.mod h1:IeqicJ7jm8182yrVmNbM6PR4g79SjN9tZLH8KduZZwE=
 github.com/gobuffalo/packr v1.19.0/go.mod h1:MstrNkfCQhd5o+Ct4IJ0skWlxN8emOq8DsoT1G98VIU=
 github.com/gobuffalo/packr v1.20.0/go.mod h1:JDytk1t2gP+my1ig7iI4NcVaXr886+N0ecUga6884zw=
+github.com/gobuffalo/packr v1.21.0 h1:p2ujcDJQp2QTiYWcI0ByHbr/gMoCouok6M0vXs/yTYQ=
 github.com/gobuffalo/packr v1.21.0/go.mod h1:H00jGfj1qFKxscFJSw8wcL4hpQtPe1PfU2wa6sg/SR0=
 github.com/gobuffalo/packr/v2 v2.0.0-rc.8/go.mod h1:y60QCdzwuMwO2R49fdQhsjCPv7tLQFR0ayzxxla9zes=
 github.com/gobuffalo/packr/v2 v2.0.0-rc.9/go.mod h1:fQqADRfZpEsgkc7c/K7aMew3n4aF1Kji7+lIZeR98Fc=

gqlgen.yml

@@ -16,4 +16,10 @@ struct_tag: gqlgen
 models:
   Performer:
     model: github.com/stashapp/stashdb/pkg/models.Performer
+  Tag:
+    model: github.com/stashapp/stashdb/pkg/models.Tag
+  Studio:
+    model: github.com/stashapp/stashdb/pkg/models.Studio
+  Scene:
+    model: github.com/stashapp/stashdb/pkg/models.Scene
 

graphql/schema/schema.graphql

@@ -29,9 +29,12 @@ type Query {
 
   #### Scenes ####
 
-  # ids and checksums should be unique
-  """Find a scene by ID or checksum"""
-  findScene(id: ID, checksum: String): Scene
+  # ids should be unique
+  """Find a scene by ID"""
+  findScene(id: ID!): Scene
+
+  """Finds a scene by an algorithm-specific checksum"""
+  findSceneByFingerprint(fingerprint: FingerprintInput!): [Scene!]!
 
   queryScenes(scene_filter: SceneFilterType, filter: QuerySpec): QueryScenesResultType!
 

graphql/schema/types/performer.graphql

@@ -109,6 +109,8 @@ input PerformerCreateInput {
   career_end_year: Int
   tattoos: [BodyModificationInput!]
   piercings: [BodyModificationInput!]
+  """Should be base64 encoded"""
+  image: String
 }
 
 input PerformerUpdateInput {
@@ -130,6 +132,8 @@ input PerformerUpdateInput {
   career_end_year: Int
   tattoos: [BodyModificationInput!]
   piercings: [BodyModificationInput!]
+  """Should be base64 encoded"""
+  image: String
 }
 
 input PerformerDestroyInput {
@@ -154,6 +158,8 @@ input PerformerEditDetailsInput {
   career_end_year: Int
   tattoos: [BodyModificationInput!]
   piercings: [BodyModificationInput!]
+  """Should be base64 encoded"""
+  image: String
 }
 
 input PerformerEditInput {

graphql/schema/types/scene.graphql

@@ -10,6 +10,20 @@ input PerformerAppearanceInput {
   as: String
 }
 
+enum FingerprintAlgorithm {
+  MD5
+}
+
+type Fingerprint {
+  hash: String!
+  algorithm: FingerprintAlgorithm!
+}
+
+input FingerprintInput {
+  hash: String!
+  algorithm: FingerprintAlgorithm!
+}
+
 type Scene {
   id: ID!
   title: String
@@ -20,7 +34,7 @@ type Scene {
   studio: Studio
   tags: [Tag!]!
   performers: [PerformerAppearance!]!
-  checksums: [String!]!
+  fingerprints: [Fingerprint!]!
 }
 
 input SceneCreateInput {
@@ -31,7 +45,7 @@ input SceneCreateInput {
   studio_id: ID
   performers: [PerformerAppearanceInput!]
   tag_ids: [ID!]
-  checksums: [String!]!
+  fingerprints: [FingerprintInput!]!
 }
 
 input SceneUpdateInput {
@@ -43,6 +57,7 @@ input SceneUpdateInput {
   studio_id: ID
   performers: [PerformerAppearanceInput!]
   tag_ids: [ID!]
+  fingerprints: [FingerprintInput!]
 }
 
 input SceneDestroyInput {
@@ -57,7 +72,7 @@ input SceneEditDetailsInput {
   studio_id: ID
   performers: [PerformerAppearanceInput!]
   tag_ids: [ID!]
-  checksums: [String!]
+  fingerprints: [FingerprintInput!]
 }
 
 input SceneEditInput {
@@ -82,6 +97,8 @@ type SceneEdit {
   removed_performers: [PerformerAppearance!]
   added_tags: [Tag!]
   removed_tags: [Tag!]
+  added_fingerprints: [Fingerprint!]
+  removed_fingerprints: [Fingerprint!]
 }
 
 type QueryScenesResultType {

graphql/schema/types/studio.graphql

@@ -15,7 +15,7 @@ input StudioCreateInput {
 
 input StudioUpdateInput {
   id: ID!
-  name: String!
+  name: String
   urls: [URLInput!]
   parent_id: ID
   child_studio_ids: [ID!]

pkg/api/context_keys.go

@@ -0,0 +1,11 @@
+package api
+
+// https://stackoverflow.com/questions/40891345/fix-should-not-use-basic-type-string-as-key-in-context-withvalue-golint
+
+type key int
+
+const (
+	performerKey key = 1
+	sceneKey     key = 2
+	studioKey    key = 3
+)