gomuks/config/config.go

// gomuks - A terminal Matrix client written in Go.
// Copyright (C) 2018 Tulir Asokan
//
// This program 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.
//
// This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.

package config

import (
	"io/ioutil"
	"os"
	"path/filepath"

	"encoding/json"
	"gopkg.in/yaml.v2"
	"maunium.net/go/gomatrix"
	"maunium.net/go/gomuks/debug"
	"maunium.net/go/gomuks/matrix/pushrules"
	"maunium.net/go/gomuks/matrix/rooms"
	"strings"
)

type AuthCache struct {
	NextBatch       string `yaml:"next_batch"`
	FilterID        string `yaml:"filter_id"`
	InitialSyncDone bool   `yaml:"initial_sync_done"`
}

type UserPreferences struct {
	HideUserList    bool `yaml:"hide_user_list"`
	HideRoomList    bool `yaml:"hide_room_list"`
	BareMessageView bool `yaml:"bare_message_view"`
	DisableImages   bool `yaml:"disable_images"`
}

// Config contains the main config of gomuks.
type Config struct {
	UserID      string `yaml:"mxid"`
	AccessToken string `yaml:"access_token"`
	HS          string `yaml:"homeserver"`

	Dir        string `yaml:"-"`
	CacheDir   string `yaml:"cache_dir"`
	HistoryDir string `yaml:"history_dir"`
	MediaDir   string `yaml:"media_dir"`
	StateDir   string `yaml:"state_dir"`

	Preferences UserPreferences        `yaml:"-"`
	AuthCache   AuthCache              `yaml:"-"`
	Rooms       map[string]*rooms.Room `yaml:"-"`
	PushRules   *pushrules.PushRuleset `yaml:"-"`

	nosave bool
}

// NewConfig creates a config that loads data from the given directory.
func NewConfig(configDir, cacheDir string) *Config {
	return &Config{
		Dir:        configDir,
		CacheDir:   cacheDir,
		HistoryDir: filepath.Join(cacheDir, "history"),
		StateDir:   filepath.Join(cacheDir, "state"),
		MediaDir:   filepath.Join(cacheDir, "media"),

		Rooms: make(map[string]*rooms.Room),
	}
}

// Clear clears the session cache and removes all history.
func (config *Config) Clear() {
	os.RemoveAll(config.HistoryDir)
	os.RemoveAll(config.StateDir)
	os.RemoveAll(config.MediaDir)
	os.RemoveAll(config.CacheDir)
	config.nosave = true
}

func (config *Config) CreateCacheDirs() {
	os.MkdirAll(config.CacheDir, 0700)
	os.MkdirAll(config.HistoryDir, 0700)
	os.MkdirAll(config.StateDir, 0700)
	os.MkdirAll(config.MediaDir, 0700)
}

func (config *Config) DeleteSession() {
	config.AuthCache.NextBatch = ""
	config.AuthCache.InitialSyncDone = false
	config.Rooms = make(map[string]*rooms.Room)
	config.PushRules = nil

	config.Clear()
	config.nosave = false
	config.CreateCacheDirs()
}

func (config *Config) LoadAll() {
	config.Load()
	config.LoadAuthCache()
	config.LoadPushRules()
	config.LoadPreferences()
	config.LoadRooms()
}

// Load loads the config from config.yaml in the directory given to the config struct.
func (config *Config) Load() {
	config.load("config", config.Dir, "config.yaml", config)
	config.CreateCacheDirs()
}

func (config *Config) SaveAll() {
	config.Save()
	config.SaveAuthCache()
	config.SavePushRules()
	config.SavePreferences()
	config.SaveRooms()
}

// Save saves this config to config.yaml in the directory given to the config struct.
func (config *Config) Save() {
	config.save("config", config.Dir, "config.yaml", config)
}

func (config *Config) LoadPreferences() {
	config.load("user preferences", config.CacheDir, "preferences.yaml", &config.Preferences)
}

func (config *Config) SavePreferences() {
	config.save("user preferences", config.CacheDir, "preferences.yaml", &config.Preferences)
}

func (config *Config) LoadAuthCache() {
	config.load("auth cache", config.CacheDir, "auth-cache.yaml", &config.AuthCache)
}

func (config *Config) SaveAuthCache() {
	config.save("auth cache", config.CacheDir, "auth-cache.yaml", &config.AuthCache)
}

func (config *Config) LoadPushRules() {
	config.load("push rules", config.CacheDir, "pushrules.json", &config.PushRules)
}

func (config *Config) SavePushRules() {
	if config.PushRules == nil {
		return
	}
	config.save("push rules", config.CacheDir, "pushrules.json", &config.PushRules)
}

func (config *Config) LoadRooms() {
	os.MkdirAll(config.StateDir, 0700)

	roomFiles, err := ioutil.ReadDir(config.StateDir)
	if err != nil {
		debug.Print("Failed to list rooms state caches in", config.StateDir)
		panic(err)
	}

	for _, roomFile := range roomFiles {
		if roomFile.IsDir() || !strings.HasSuffix(roomFile.Name(), ".gmxstate") {
			continue
		}
		path := filepath.Join(config.StateDir, roomFile.Name())
		room := &rooms.Room{}
		err = room.Load(path)
		if err != nil {
			debug.Printf("Failed to load room state cache from %s: %v", path, err)
			continue
		}
		config.Rooms[room.ID] = room
	}
}

func (config *Config) SaveRooms() {
	if config.nosave {
		return
	}

	os.MkdirAll(config.StateDir, 0700)
	for _, room := range config.Rooms {
		path := config.getRoomCachePath(room)
		err := room.Save(path)
		if err != nil {
			debug.Printf("Failed to save room state cache to file %s: %v", path, err)
		}
	}
}

func (config *Config) load(name, dir, file string, target interface{}) {
	os.MkdirAll(dir, 0700)

	path := filepath.Join(dir, file)
	data, err := ioutil.ReadFile(path)
	if err != nil {
		if os.IsNotExist(err) {
			return
		}
		debug.Print("Failed to read", name, "from", path)
		panic(err)
	}

	if strings.HasSuffix(file, ".yaml") {
		err = yaml.Unmarshal(data, target)
	} else {
		err = json.Unmarshal(data, target)
	}
	if err != nil {
		debug.Print("Failed to parse", name, "at", path)
		panic(err)
	}
}

func (config *Config) save(name, dir, file string, source interface{}) {
	if config.nosave {
		return
	}

	os.MkdirAll(dir, 0700)
	var data []byte
	var err error
	if strings.HasSuffix(file, ".yaml") {
		data, err = yaml.Marshal(source)
	} else {
		data, err = json.Marshal(source)
	}
	if err != nil {
		debug.Print("Failed to marshal", name)
		panic(err)
	}

	path := filepath.Join(dir, file)
	err = ioutil.WriteFile(path, data, 0600)
	if err != nil {
		debug.Print("Failed to write", name, "to", path)
		panic(err)
	}
}

func (config *Config) GetUserID() string {
	return config.UserID
}

func (config *Config) SaveFilterID(_, filterID string) {
	config.AuthCache.FilterID = filterID
	config.SaveAuthCache()
}

func (config *Config) LoadFilterID(_ string) string {
	return config.AuthCache.FilterID
}

func (config *Config) SaveNextBatch(_, nextBatch string) {
	config.AuthCache.NextBatch = nextBatch
	config.SaveAuthCache()
}

func (config *Config) LoadNextBatch(_ string) string {
	return config.AuthCache.NextBatch
}

func (config *Config) GetRoom(roomID string) *rooms.Room {
	room, _ := config.Rooms[roomID]
	if room == nil {
		room = rooms.NewRoom(roomID, config.UserID)
		config.Rooms[room.ID] = room
	}
	return room
}

func (config *Config) getRoomCachePath(room *rooms.Room) string {
	return filepath.Join(config.StateDir, room.ID+".gmxstate")
}

func (config *Config) PutRoom(room *rooms.Room) {
	config.Rooms[room.ID] = room
	room.Save(config.getRoomCachePath(room))
}

func (config *Config) SaveRoom(room *gomatrix.Room) {
	gmxRoom := config.GetRoom(room.ID)
	gmxRoom.Room = room
	gmxRoom.Save(config.getRoomCachePath(gmxRoom))
}

func (config *Config) LoadRoom(roomID string) *gomatrix.Room {
	return config.GetRoom(roomID).Room
}