Store factory to make store optional

internal/bridge/bridge.go

@@ -19,6 +19,11 @@
 package bridge
 
 import (
+	"strconv"
+	"time"
+
+	"github.com/ProtonMail/proton-bridge/internal/metrics"
+	"github.com/ProtonMail/proton-bridge/internal/preferences"
 	"github.com/ProtonMail/proton-bridge/internal/users"
 
 	"github.com/ProtonMail/proton-bridge/pkg/listener"
@@ -32,6 +37,7 @@ var (
 type Bridge struct {
 	*users.Users
 
+	pref          PreferenceProvider
 	clientManager users.ClientManager
 
 	userAgentClientName    string
@@ -40,19 +46,53 @@ type Bridge struct {
 }
 
 func New(
-	config users.Configer,
-	pref users.PreferenceProvider,
+	config Configer,
+	pref PreferenceProvider,
 	panicHandler users.PanicHandler,
 	eventListener listener.Listener,
 	clientManager users.ClientManager,
 	credStorer users.CredentialsStorer,
 ) *Bridge {
-	u := users.New(config, pref, panicHandler, eventListener, clientManager, credStorer)
-	return &Bridge{
+	storeFactory := newStoreFactory(config, panicHandler, clientManager, eventListener)
+	u := users.New(config, panicHandler, eventListener, clientManager, credStorer, storeFactory)
+	b := &Bridge{
 		Users: u,
 
+		pref:          pref,
 		clientManager: clientManager,
 	}
+
+	// Allow DoH before starting the app if the user has previously set this setting.
+	// This allows us to start even if protonmail is blocked.
+	if pref.GetBool(preferences.AllowProxyKey) {
+		b.AllowProxy()
+	}
+
+	if pref.GetBool(preferences.FirstStartKey) {
+		b.SendMetric(metrics.New(metrics.Setup, metrics.FirstStart, metrics.Label(config.GetVersion())))
+	}
+
+	go b.heartbeat()
+
+	return b
+}
+
+// heartbeat sends a heartbeat signal once a day.
+func (b *Bridge) heartbeat() {
+	ticker := time.NewTicker(1 * time.Minute)
+
+	for range ticker.C {
+		next, err := strconv.ParseInt(b.pref.Get(preferences.NextHeartbeatKey), 10, 64)
+		if err != nil {
+			continue
+		}
+		nextTime := time.Unix(next, 0)
+		if time.Now().After(nextTime) {
+			b.SendMetric(metrics.New(metrics.Heartbeat, metrics.Daily, metrics.NoLabel))
+			nextTime = nextTime.Add(24 * time.Hour)
+			b.pref.Set(preferences.NextHeartbeatKey, strconv.FormatInt(nextTime.Unix(), 10))
+		}
+	}
 }
 
 // GetCurrentClient returns currently connected client (e.g. Thunderbird).

internal/bridge/store_factory.go

@@ -0,0 +1,69 @@
+// Copyright (c) 2020 Proton Technologies AG
+//
+// This file is part of ProtonMail Bridge.
+//
+// ProtonMail Bridge is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// ProtonMail Bridge is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with ProtonMail Bridge.  If not, see <https://www.gnu.org/licenses/>.
+
+package bridge
+
+import (
+	"fmt"
+	"path/filepath"
+
+	"github.com/ProtonMail/proton-bridge/internal/store"
+	"github.com/ProtonMail/proton-bridge/internal/users"
+
+	"github.com/ProtonMail/proton-bridge/pkg/listener"
+)
+
+type storeFactory struct {
+	config        StoreFactoryConfiger
+	panicHandler  users.PanicHandler
+	clientManager users.ClientManager
+	eventListener listener.Listener
+	storeCache    *store.Cache
+}
+
+func newStoreFactory(
+	config StoreFactoryConfiger,
+	panicHandler users.PanicHandler,
+	clientManager users.ClientManager,
+	eventListener listener.Listener,
+) *storeFactory {
+	return &storeFactory{
+		config:        config,
+		panicHandler:  panicHandler,
+		clientManager: clientManager,
+		eventListener: eventListener,
+		storeCache:    store.NewCache(config.GetIMAPCachePath()),
+	}
+}
+
+// New creates new store for given user.
+func (f *storeFactory) New(user store.BridgeUser) (*store.Store, error) {
+	storePath := getUserStorePath(f.config.GetDBDir(), user.ID())
+	return store.New(f.panicHandler, user, f.clientManager, f.eventListener, storePath, f.storeCache)
+}
+
+// Remove removes all store files for given user.
+func (f *storeFactory) Remove(userID string) error {
+	storePath := getUserStorePath(f.config.GetDBDir(), userID)
+	return store.RemoveStore(f.storeCache, storePath, userID)
+}
+
+// getUserStorePath returns the file path of the store database for the given userID.
+func getUserStorePath(storeDir string, userID string) (path string) {
+	fileName := fmt.Sprintf("mailbox-%v.db", userID)
+	return filepath.Join(storeDir, fileName)
+}

internal/bridge/types.go

@@ -0,0 +1,37 @@
+// Copyright (c) 2020 Proton Technologies AG
+//
+// This file is part of ProtonMail Bridge.
+//
+// ProtonMail Bridge is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// ProtonMail Bridge is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with ProtonMail Bridge.  If not, see <https://www.gnu.org/licenses/>.
+
+package bridge
+
+import "github.com/ProtonMail/proton-bridge/internal/users"
+
+type Configer interface {
+	users.Configer
+	StoreFactoryConfiger
+}
+
+type StoreFactoryConfiger interface {
+	GetDBDir() string
+	GetIMAPCachePath() string
+}
+
+type PreferenceProvider interface {
+	Get(key string) string
+	GetBool(key string) bool
+	GetInt(key string) int
+	Set(key string, value string)
+}