Backend: Rename /internal/remote package to /internal/service

Signed-off-by: Michael Mayer <michael@photoprism.app>
photoprism · Jul 2, 2024 · c096382 · c096382
1 parent 08e1061
commit c096382
Show file tree

Hide file tree

Showing 50 changed files with 103 additions and 105 deletions.
diff --git a/internal/config/config.go b/internal/config/config.go
@@ -50,8 +50,8 @@ import (
 	"github.com/photoprism/photoprism/internal/entity"
 	"github.com/photoprism/photoprism/internal/event"
 	"github.com/photoprism/photoprism/internal/mutex"
-	"github.com/photoprism/photoprism/internal/remote/hub"
-	"github.com/photoprism/photoprism/internal/remote/hub/places"
+	"github.com/photoprism/photoprism/internal/service/hub"
+	"github.com/photoprism/photoprism/internal/service/hub/places"
 	"github.com/photoprism/photoprism/internal/tensorflow/face"
 	"github.com/photoprism/photoprism/internal/thumb"
 	"github.com/photoprism/photoprism/pkg/checksum"

diff --git a/internal/entity/album.go b/internal/entity/album.go
@@ -12,7 +12,7 @@ import (
 
 	"github.com/photoprism/photoprism/internal/event"
 	"github.com/photoprism/photoprism/internal/form"
-	"github.com/photoprism/photoprism/internal/remote/maps"
+	"github.com/photoprism/photoprism/internal/service/maps"
 	"github.com/photoprism/photoprism/pkg/clean"
 	"github.com/photoprism/photoprism/pkg/rnd"
 	"github.com/photoprism/photoprism/pkg/sortby"

diff --git a/internal/entity/cell.go b/internal/entity/cell.go
@@ -6,7 +6,7 @@ import (
 	"time"
 
 	"github.com/photoprism/photoprism/internal/event"
-	"github.com/photoprism/photoprism/internal/remote/maps"
+	"github.com/photoprism/photoprism/internal/service/maps"
 	"github.com/photoprism/photoprism/pkg/s2"
 	"github.com/photoprism/photoprism/pkg/txt"
 )

diff --git a/internal/entity/country.go b/internal/entity/country.go
@@ -4,7 +4,7 @@ import (
 	"github.com/jinzhu/gorm"
 
 	"github.com/photoprism/photoprism/internal/event"
-	"github.com/photoprism/photoprism/internal/remote/maps"
+	"github.com/photoprism/photoprism/internal/service/maps"
 	"github.com/photoprism/photoprism/pkg/txt"
 )
 

diff --git a/internal/entity/photo_location.go b/internal/entity/photo_location.go
@@ -7,7 +7,7 @@ import (
 
 	"github.com/dustin/go-humanize/english"
 
-	"github.com/photoprism/photoprism/internal/remote/maps"
+	"github.com/photoprism/photoprism/internal/service/maps"
 	"github.com/photoprism/photoprism/internal/tensorflow/classify"
 	"github.com/photoprism/photoprism/pkg/clean"
 	"github.com/photoprism/photoprism/pkg/geo"

diff --git a/internal/entity/place.go b/internal/entity/place.go
@@ -5,7 +5,7 @@ import (
 	"sync"
 	"time"
 
-	"github.com/photoprism/photoprism/internal/remote/maps"
+	"github.com/photoprism/photoprism/internal/service/maps"
 	"github.com/photoprism/photoprism/pkg/clean"
 )
 

diff --git a/internal/entity/query/moments.go b/internal/entity/query/moments.go
@@ -6,7 +6,7 @@ import (
 	"time"
 
 	"github.com/photoprism/photoprism/internal/entity"
-	"github.com/photoprism/photoprism/internal/remote/maps"
+	"github.com/photoprism/photoprism/internal/service/maps"
 	"github.com/photoprism/photoprism/pkg/clean"
 	"github.com/photoprism/photoprism/pkg/txt"
 )

diff --git a/internal/entity/service.go b/internal/entity/service.go
@@ -9,8 +9,8 @@ import (
 	"github.com/ulule/deepcopier"
 
 	"github.com/photoprism/photoprism/internal/form"
-	"github.com/photoprism/photoprism/internal/remote"
-	"github.com/photoprism/photoprism/internal/remote/webdav"
+	"github.com/photoprism/photoprism/internal/service"
+	"github.com/photoprism/photoprism/internal/service/webdav"
 	"github.com/photoprism/photoprism/pkg/fs"
 	"github.com/photoprism/photoprism/pkg/txt"
 )
@@ -140,7 +140,7 @@ func (m *Service) SaveForm(form form.Service) error {
 	}
 
 	// TODO: Support for other remote services in addition to WebDAV.
-	if m.AccType != remote.ServiceWebDAV {
+	if m.AccType != service.WebDAV {
 		m.AccShare = false // Disable manual upload.
 		m.AccSync = false  // Disable background sync.
 	}
@@ -192,7 +192,7 @@ func (m *Service) Delete() error {
 
 // Directories returns a list of directories or albums in an account.
 func (m *Service) Directories() (result fs.FileInfos, err error) {
-	if m.AccType == remote.ServiceWebDAV {
+	if m.AccType == service.WebDAV {
 		var client *webdav.Client
 		if client, err = webdav.NewClient(m.AccURL, m.AccUser, m.AccPass, webdav.Timeout(m.AccTimeout)); err != nil {
 			return result, err

diff --git a/internal/form/service.go b/internal/form/service.go
@@ -3,7 +3,7 @@ package form
 import (
 	"github.com/ulule/deepcopier"
 
-	"github.com/photoprism/photoprism/internal/remote"
+	"github.com/photoprism/photoprism/internal/service"
 )
 
 // Service represents a remote service form for uploading, downloading or syncing media files.
@@ -40,7 +40,7 @@ func NewService(m interface{}) (f Service, err error) {
 
 // Discovery performs automatic service discovery.
 func (f *Service) Discovery() error {
-	acc, err := remote.Discover(f.AccURL, f.AccUser, f.AccPass)
+	acc, err := service.Discover(f.AccURL, f.AccUser, f.AccPass)
 
 	if err != nil {
 		return err

diff --git a/internal/remote/heuristic.go b/internal/remote/heuristic.go
diff --git a/internal/remote/discover.go → internal/service/discover.go b/internal/remote/discover.go → internal/service/discover.go
@@ -1,4 +1,4 @@
-package remote
+package service
 
 import (
 	"errors"

diff --git a/internal/remote/discover_test.go → internal/service/discover_test.go b/internal/remote/discover_test.go → internal/service/discover_test.go
@@ -1,4 +1,4 @@
-package remote
+package service
 
 import (
 	"testing"

diff --git a/internal/service/heuristic.go b/internal/service/heuristic.go
@@ -0,0 +1,62 @@
+package service
+
+import (
+	"net/url"
+	"strings"
+)
+
+type Heuristic struct {
+	ServiceType string
+	Domains     []string
+	Paths       []string
+	Method      string
+}
+
+var Heuristics = []Heuristic{
+	{Facebook, []string{"facebook.com", "www.facebook.com"}, []string{}, "GET"},
+	{Twitter, []string{"twitter.com"}, []string{}, "GET"},
+	{Flickr, []string{"flickr.com", "www.flickr.com"}, []string{}, "GET"},
+	{Instagram, []string{"instagram.com", "www.instagram.com"}, []string{}, "GET"},
+	{Telegram, []string{"web.telegram.org", "www.telegram.org", "telegram.org"}, []string{}, "GET"},
+	{WhatsApp, []string{"web.whatsapp.com", "www.whatsapp.com", "whatsapp.com"}, []string{}, "GET"},
+	{OneDrive, []string{"onedrive.live.com"}, []string{}, "GET"},
+	{GDrive, []string{"drive.google.com"}, []string{}, "GET"},
+	{GPhotos, []string{"photos.google.com"}, []string{}, "GET"},
+	{WebDAV, []string{}, []string{"/", "/webdav/", "/originals/", "/remote.php/dav/files/{user}/", "/remote.php/webdav/", "/dav/files/{user}/", "/servlet/webdav.infostore/"}, "PROPFIND"},
+}
+
+func (h Heuristic) MatchDomain(match string) bool {
+	if len(h.Domains) == 0 {
+		return true
+	}
+
+	for _, m := range h.Domains {
+		if m == match {
+			return true
+		}
+	}
+
+	return false
+}
+
+func (h Heuristic) Discover(rawUrl, user string) *url.URL {
+	u, err := url.Parse(rawUrl)
+
+	if err != nil {
+		return nil
+	}
+
+	if HttpOk(h.Method, u.String()) {
+		return u
+	}
+
+	for _, p := range h.Paths {
+		u.Path = strings.Replace(p, "{user}", user, -1)
+
+		if HttpOk(h.Method, u.String()) {
+			return u
+		}
+	}
+
+	return nil
+}
diff --git a/internal/remote/hub/config.go → internal/service/hub/config.go b/internal/remote/hub/config.go → internal/service/hub/config.go
@@ -19,7 +19,7 @@ import (
 
 	"gopkg.in/yaml.v2"
 
-	"github.com/photoprism/photoprism/internal/remote/hub/places"
+	"github.com/photoprism/photoprism/internal/service/hub/places"
 	"github.com/photoprism/photoprism/pkg/clean"
 	"github.com/photoprism/photoprism/pkg/fs"
 	"github.com/photoprism/photoprism/pkg/header"

diff --git a/internal/remote/hub/config_test.go → internal/service/hub/config_test.go b/internal/remote/hub/config_test.go → internal/service/hub/config_test.go
diff --git a/internal/remote/hub/debug.go → internal/service/hub/debug.go b/internal/remote/hub/debug.go → internal/service/hub/debug.go
diff --git a/internal/remote/hub/feedback.go → internal/service/hub/feedback.go b/internal/remote/hub/feedback.go → internal/service/hub/feedback.go
diff --git a/internal/remote/hub/feedback_test.go → internal/service/hub/feedback_test.go b/internal/remote/hub/feedback_test.go → internal/service/hub/feedback_test.go
diff --git a/internal/remote/hub/hub.go → internal/service/hub/hub.go b/internal/remote/hub/hub.go → internal/service/hub/hub.go
diff --git a/internal/remote/hub/hub_test.go → internal/service/hub/hub_test.go b/internal/remote/hub/hub_test.go → internal/service/hub/hub_test.go
diff --git a/internal/remote/hub/places/cache.go → internal/service/hub/places/cache.go b/internal/remote/hub/places/cache.go → internal/service/hub/places/cache.go
diff --git a/internal/remote/hub/places/location.go → internal/service/hub/places/location.go b/internal/remote/hub/places/location.go → internal/service/hub/places/location.go
diff --git a/internal/remote/hub/places/location_test.go → internal/service/hub/places/location_test.go b/internal/remote/hub/places/location_test.go → internal/service/hub/places/location_test.go
diff --git a/internal/remote/hub/places/place.go → internal/service/hub/places/place.go b/internal/remote/hub/places/place.go → internal/service/hub/places/place.go
diff --git a/internal/remote/hub/places/places.go → internal/service/hub/places/places.go b/internal/remote/hub/places/places.go → internal/service/hub/places/places.go
diff --git a/internal/remote/hub/request.go → internal/service/hub/request.go b/internal/remote/hub/request.go → internal/service/hub/request.go
diff --git a/internal/remote/hub/session.go → internal/service/hub/session.go b/internal/remote/hub/session.go → internal/service/hub/session.go
diff --git a/internal/remote/hub/session_test.go → internal/service/hub/session_test.go b/internal/remote/hub/session_test.go → internal/service/hub/session_test.go
diff --git a/internal/remote/hub/testdata/hub1.yml → internal/service/hub/testdata/hub1.yml b/internal/remote/hub/testdata/hub1.yml → internal/service/hub/testdata/hub1.yml
diff --git a/internal/remote/hub/testdata/hub2.yml → internal/service/hub/testdata/hub2.yml b/internal/remote/hub/testdata/hub2.yml → internal/service/hub/testdata/hub2.yml
diff --git a/internal/remote/hub/testdata/hub3.yml → internal/service/hub/testdata/hub3.yml b/internal/remote/hub/testdata/hub3.yml → internal/service/hub/testdata/hub3.yml
diff --git a/internal/remote/maps/countries.go → internal/service/maps/countries.go b/internal/remote/maps/countries.go → internal/service/maps/countries.go
diff --git a/internal/remote/maps/countries.json → internal/service/maps/countries.json b/internal/remote/maps/countries.json → internal/service/maps/countries.json
diff --git a/internal/remote/maps/country.go → internal/service/maps/country.go b/internal/remote/maps/country.go → internal/service/maps/country.go
diff --git a/internal/remote/maps/country_test.go → internal/service/maps/country_test.go b/internal/remote/maps/country_test.go → internal/service/maps/country_test.go
diff --git a/internal/remote/maps/gen.go → internal/service/maps/gen.go b/internal/remote/maps/gen.go → internal/service/maps/gen.go
diff --git a/internal/remote/maps/location.go → internal/service/maps/location.go b/internal/remote/maps/location.go → internal/service/maps/location.go
@@ -4,7 +4,7 @@ import (
 	"errors"
 	"strings"
 
-	"github.com/photoprism/photoprism/internal/remote/hub/places"
+	"github.com/photoprism/photoprism/internal/service/hub/places"
 	"github.com/photoprism/photoprism/pkg/clean"
 	"github.com/photoprism/photoprism/pkg/s2"
 	"github.com/photoprism/photoprism/pkg/txt"

diff --git a/internal/remote/maps/location_test.go → internal/service/maps/location_test.go b/internal/remote/maps/location_test.go → internal/service/maps/location_test.go
diff --git a/internal/remote/maps/maps.go → internal/service/maps/maps.go b/internal/remote/maps/maps.go → internal/service/maps/maps.go
diff --git a/internal/remote/remote.go → internal/service/remote.go b/internal/remote/remote.go → internal/service/remote.go
@@ -1,5 +1,5 @@
 /*
-Package remote provides detection of remote services for file sharing and synchronization.
+Package service provides detection of remote services for file sharing and synchronization.
 
 Copyright (c) 2018 - 2024 PhotoPrism UG. All rights reserved.
 
@@ -22,25 +22,24 @@ want to support our work, or just want to say hello.
 Additional information can be found in our Developer Guide:
 <https://docs.photoprism.app/developer-guide/>
 */
-package remote
+package service
 
 import (
 	"net/http"
 	"time"
 )
 
 const (
-	ServiceWebDAV    = "webdav"
-	ServiceFacebook  = "facebook"
-	ServiceTwitter   = "twitter"
-	ServiceFlickr    = "flickr"
-	ServiceInstagram = "instagram"
-	ServiceEyeEm     = "eyeem"
-	ServiceTelegram  = "telegram"
-	ServiceWhatsApp  = "whatsapp"
-	ServiceGPhotos   = "gphotos"
-	ServiceGDrive    = "gdrive"
-	ServiceOneDrive  = "onedrive"
+	WebDAV    = "webdav"
+	Facebook  = "facebook"
+	Twitter   = "twitter"
+	Flickr    = "flickr"
+	Instagram = "instagram"
+	Telegram  = "telegram"
+	WhatsApp  = "whatsapp"
+	GPhotos   = "gphotos"
+	GDrive    = "gdrive"
+	OneDrive  = "onedrive"
 )
 
 func HttpOk(method, rawUrl string) bool {

diff --git a/internal/remote/webdav/client.go → internal/service/webdav/client.go b/internal/remote/webdav/client.go → internal/service/webdav/client.go
diff --git a/internal/remote/webdav/client_test.go → internal/service/webdav/client_test.go b/internal/remote/webdav/client_test.go → internal/service/webdav/client_test.go
diff --git a/internal/remote/webdav/path.go → internal/service/webdav/path.go b/internal/remote/webdav/path.go → internal/service/webdav/path.go
diff --git a/internal/remote/webdav/testdata/example.jpg → internal/service/webdav/testdata/example.jpg b/internal/remote/webdav/testdata/example.jpg → internal/service/webdav/testdata/example.jpg
diff --git a/internal/remote/webdav/webdav.go → internal/service/webdav/webdav.go b/internal/remote/webdav/webdav.go → internal/service/webdav/webdav.go
diff --git a/internal/workers/share.go b/internal/workers/share.go
@@ -12,8 +12,8 @@ import (
 	"github.com/photoprism/photoprism/internal/form"
 	"github.com/photoprism/photoprism/internal/mutex"
 	"github.com/photoprism/photoprism/internal/photoprism"
-	"github.com/photoprism/photoprism/internal/remote"
-	"github.com/photoprism/photoprism/internal/remote/webdav"
+	"github.com/photoprism/photoprism/internal/service"
+	"github.com/photoprism/photoprism/internal/service/webdav"
 	"github.com/photoprism/photoprism/internal/thumb"
 	"github.com/photoprism/photoprism/pkg/clean"
 	"github.com/photoprism/photoprism/pkg/fs"
@@ -64,7 +64,7 @@ func (w *Share) Start() (err error) {
 			return nil
 		}
 
-		if a.AccType != remote.ServiceWebDAV {
+		if a.AccType != service.WebDAV {
 			continue
 		}
 
@@ -159,7 +159,7 @@ func (w *Share) Start() (err error) {
 			return nil
 		}
 
-		if a.AccType != remote.ServiceWebDAV {
+		if a.AccType != service.WebDAV {
 			continue
 		}
 

diff --git a/internal/workers/sync.go b/internal/workers/sync.go
@@ -11,7 +11,7 @@ import (
 	"github.com/photoprism/photoprism/internal/event"
 	"github.com/photoprism/photoprism/internal/form"
 	"github.com/photoprism/photoprism/internal/mutex"
-	"github.com/photoprism/photoprism/internal/remote"
+	"github.com/photoprism/photoprism/internal/service"
 )
 
 // Sync represents a sync worker.
@@ -62,7 +62,7 @@ func (w *Sync) Start() (err error) {
 	accounts, err := search.Accounts(f)
 
 	for _, a := range accounts {
-		if a.AccType != remote.ServiceWebDAV {
+		if a.AccType != service.WebDAV {
 			continue
 		}
 

diff --git a/internal/workers/sync_download.go b/internal/workers/sync_download.go
@@ -12,7 +12,7 @@ import (
 	"github.com/photoprism/photoprism/internal/get"
 	"github.com/photoprism/photoprism/internal/mutex"
 	"github.com/photoprism/photoprism/internal/photoprism"
-	"github.com/photoprism/photoprism/internal/remote/webdav"
+	"github.com/photoprism/photoprism/internal/service/webdav"
 	"github.com/photoprism/photoprism/pkg/clean"
 	"github.com/photoprism/photoprism/pkg/fs"
 )

diff --git a/internal/workers/sync_refresh.go b/internal/workers/sync_refresh.go
@@ -3,14 +3,14 @@ package workers
 import (
 	"github.com/photoprism/photoprism/internal/entity"
 	"github.com/photoprism/photoprism/internal/mutex"
-	"github.com/photoprism/photoprism/internal/remote"
-	"github.com/photoprism/photoprism/internal/remote/webdav"
+	"github.com/photoprism/photoprism/internal/service"
+	"github.com/photoprism/photoprism/internal/service/webdav"
 	"github.com/photoprism/photoprism/pkg/media"
 )
 
 // Updates the local list of remote files so that they can be downloaded in batches
 func (w *Sync) refresh(a entity.Service) (complete bool, err error) {
-	if a.AccType != remote.ServiceWebDAV {
+	if a.AccType != service.WebDAV {
 		return false, nil
 	}
 

diff --git a/internal/workers/sync_upload.go b/internal/workers/sync_upload.go
@@ -9,7 +9,7 @@ import (
 	"github.com/photoprism/photoprism/internal/event"
 	"github.com/photoprism/photoprism/internal/mutex"
 	"github.com/photoprism/photoprism/internal/photoprism"
-	"github.com/photoprism/photoprism/internal/remote/webdav"
+	"github.com/photoprism/photoprism/internal/service/webdav"
 	"github.com/photoprism/photoprism/pkg/clean"
 )
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,7 +5,7 @@ import ( @@
     	"sync"
     	"time"
-    	"github.com/photoprism/photoprism/internal/remote/maps"
+    	"github.com/photoprism/photoprism/internal/service/maps"
     	"github.com/photoprism/photoprism/pkg/clean"
     )
@@ Expand Down @@