gf_images_core

type GF_image_id = Gf_image_id

type GFconfig struct {
	ImagesStoreLocalDirPathStr           string `yaml:"store_local_dir_path"`
	ImagesThumbnailsStoreLocalDirPathStr string `yaml:"thumbnails_store_local_dir_path"`
	VideoStoreLocalDirPathStr            string `yaml:"videos_store_local_dir_path"`

	MediaDomainStr               string `yaml:"media_domain"`
	MainS3bucketNameStr          string `yaml:"main_s3_bucket_name"`
	EmailSharingSenderAddressStr string `yaml:"email_sharing_sender_address"`

	// UPLOADED_IMAGES - this is a special dedicated bucket, separate from buckets for all other flows.
	//                   Mainly because users are pushing data to it directly and so we want to possibly handle
	//                   it in a separate way from other buckets that only have internal GF systems
	//                   uploading data to it.
	Uploaded_images_s3_bucket_str string `yaml:"uploaded_images_s3_bucket"`

	// BOOKMARKS_IMAGES - dedicated bucket for screenshots of bookmarks
	Bookmark_images_s3_bucket_str string `yaml:"bookmark_images_s3_bucket"`

	ImagesFlowToS3bucketDefaultStr string            `yaml:"images_flow_to_s3_bucket_default"`
	ImagesFlowToS3bucketMap        map[string]string `yaml:"images_flow_to_s3_bucket"`

	UseNewStorageEngineBool bool `yaml:"use_new_storage_engine"`

	//------------------------
	// IPFS
	IPFSnodeHostStr string `yaml:"ipfs_node_host"`

	//------------------------
	// PY
	//------------------------
	// PLUGINGS
	PluginsPyDirPathStr string `yaml:"plugins_py_dir_path"`

	// IMAGE_CLASSIFY
	ImagesClassifyPyDirPathStr string `yaml:"images_classify_py_dir_path"`
}

type GFimage struct {
	Id                   primitive.ObjectID `json:"-"               bson:"_id,omitempty"`
	IDstr                GFimageID          `json:"id_str"               bson:"id_str"`
	T_str                string             `json:"-"                    bson:"t"` // "img"
	Creation_unix_time_f float64            `json:"creation_unix_time_f" bson:"creation_unix_time_f"`
	UserID               gf_core.GF_ID      `json:"user_id_str"          bson:"user_id_str"`

	//---------------
	ClientTypeStr string   `json:"-"                    bson:"client_type_str"` // "gchrome_ext"|"gf_crawl_images"|"gf_image_editor"
	TitleStr      string   `json:"title_str"            bson:"title_str"`
	FlowsNamesLst []string `json:"flows_names_lst"      bson:"flows_names_lst"` // image can bellong to multiple flows

	//---------------
	/*
		RESOLVED_SOURCE_URL
		IMPORTANT!! - when the image comes from an external url (as oppose to it being
			created internally, or uploaded directly to the system).
			this is different from Origin_page_url_str in that the page_url is the url
			of the page in which the image is found, whereas this origin_url is the url
			of the file on some file server from which the image is served
	*/
	Origin_url_str string `json:"origin_url_str" bson:"origin_url_str"`

	// if the image is extracted from a page, this holds the page_url
	Origin_page_url_str string `json:"origin_page_url_str,omitempty" bson:"origin_page_url_str,omitempty"`

	/*
		DEPRECATED!! - is this used? images are stored in S3, and accessible via URL.
			actual path on the OS filesystem, of the fullsized image gotten from origin_url_str durring
			processing (download/transformation/s3_upload).
	*/
	Original_file_internal_uri_str string `json:"original_file_internal_uri_str,omitempty" bson:"original_file_internal_uri_str,omitempty"`

	ThumbnailSmallURLstr  string `json:"thumbnail_small_url_str"  bson:"thumbnail_small_url_str"`
	ThumbnailMediumURLstr string `json:"thumbnail_medium_url_str" bson:"thumbnail_medium_url_str"`
	ThumbnailLargeURLstr  string `json:"thumbnail_large_url_str"  bson:"thumbnail_large_url_str"`

	//---------------
	Format_str string `json:"format_str" bson:"format_str"` // "jpeg" | "png" | "gif"
	Width_int  int    `json:"width_str"  bson:"width_int"`
	Height_int int    `json:"height_str" bson:"height_int"`

	//---------------
	// COLORS
	DominantColorHexStr string `json:"dominant_color_hex_str" bson:"dominant_color_hex_str"`
	PalleteStr          string `json:"pallete_str"            bson:"pallete_str"`

	//---------------
	// META
	MetaMap map[string]interface{} `json:"meta_map" bson:"meta_map"` // metadata external users might assign to an image
	TagsLst []string               `json:"tags_lst" bson:"tags_lst"` // human facing tags assigned to an image

}

type GFimageExport struct {
	Creation_unix_time_f  float64                     `json:"creation_unix_time_f"`
	UserNameStr           gf_identity_core.GFuserName `json:"user_name_str"`
	Title_str             string                      `json:"title_str"`
	Flows_names_lst       []string                    `json:"flows_names_lst"`
	Origin_page_url_str   string                      `json:"origin_page_url_str"`
	ThumbnailSmallURLstr  string                      `json:"thumbnail_small_url_str"`
	ThumbnailMediumURLstr string                      `json:"thumbnail_medium_url_str"`
	ThumbnailLargeURLstr  string                      `json:"thumbnail_large_url_str"`
	Format_str            string                      `json:"format_str"`
	Tags_lst              []string                    `json:"tags_lst"`
}

type GFimageID = GF_image_id

type GFimageNewInfo struct {
	IDstr                          GFimageID
	Title_str                      string
	Flows_names_lst                []string
	Image_client_type_str          string
	Origin_url_str                 string
	Origin_page_url_str            string
	Original_file_internal_uri_str string
	ThumbnailSmallURLstr           string
	ThumbnailMediumURLstr          string
	ThumbnailLargeURLstr           string
	Format_str                     string
	Width_int                      int
	Height_int                     int

	Meta_map map[string]interface{}

	// user that owns this image, that uploaded or added it in some other way
	UserID gf_core.GF_ID
}

type GFimageThumbs struct {
	Small_relative_url_str  string `json:"small_relative_url_str"`
	Medium_relative_url_str string `json:"medium_relative_url_str"`
	Large_relative_url_str  string `json:"large_relative_url_str"`

	Small_local_file_path_str  string
	Medium_local_file_path_str string
	Large_local_file_path_str  string
}

type GFmetrics struct {

	// IMAGE_UPLOAD
	ImageUploadClientDurationGauge         prometheus.Gauge
	ImageUploadClientTransferDurationGauge prometheus.Gauge

	// IMAGE_CLASSIFY
	ImageClassifyPyExecDurationGauge prometheus.Gauge
}

type GFserviceInfo struct {
	Port_str      string
	DomainBaseStr string

	// DB
	Mongodb_host_str    string
	Mongodb_db_name_str string

	ImagesStoreLocalDirPathStr           string
	ImagesThumbnailsStoreLocalDirPathStr string
	VideoStoreLocalDirPathStr            string

	MediaDomainStr            string
	ImagesMainS3bucketNameStr string
	TemplatesPathsMap         map[string]string
	ConfigFilePathStr         string

	// email address from which image sharing emails are sent
	EmailSharingSenderAddressStr string

	//------------------------
	// AUTH_SUBSYSTEM_TYPE
	AuthSubsystemTypeStr string

	// AUTH_LOGIN_URL - url of the login page to which the system should
	//                  redirect users when email is confirmed.
	AuthLoginURLstr string
	KeyServer       *gf_identity_core.GFkeyServerInfo

	// NEW_STORAGE_ENGINE - flag indicating if the new image storage engine should be used
	UseNewStorageEngineBool bool

	// IPFS_NODE_HOST - host/gateway to use to connect to for IPFS operations
	IPFSnodeHostStr string

	// EVENTS_APP - enable sending of app events from various functions
	EnableEventsAppBool bool
}

type GFshareInput struct {
	ImageID         GFimageID
	EmailAddressStr string
	EmailSubjectStr string
	EmailBodyStr    string
}

type Gf_image_id string // DEPRECATED!! - switch to using GF_image_id fully

type ImageFetchError struct {
	Id                   primitive.ObjectID `json:"-"                    bson:"_id,omitempty"`
	Id_str               string             `json:"id_str"               bson:"id_str"`
	T_str                string             `json:"-"                    bson:"t"` // img_fetch_error
	Creation_unix_time_f float64            `json:"creation_unix_time_f" bson:"creation_unix_time_f"`
	Image_url_str        string             `json:"image_url_str"        bson:"image_url_str"`
	Status_code_int      int                `json:"status_code_int"      bson:"status_code_int"`
}