3c955a9706
### Purpose This exposes four methods from `Model` through `Internals`. It allows apps like Synctrain to obtain information about local/remote need and sync progress. ### Testing No testing seems necessary, functions are exported verbatim. ### Screenshots N/a ### Documentation Not public API, I am aware this interface may change at any time. ## Authorship OK. Co-authored-by: Ross Smith II <ross@smithii.com> Co-authored-by: Jakob Borg <jakob@kastelo.net>
105 lines
3.9 KiB
Go
105 lines
3.9 KiB
Go
// Copyright (C) 2024 The Syncthing Authors.
|
|
//
|
|
// This Source Code Form is subject to the terms of the Mozilla Public
|
|
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
// You can obtain one at https://mozilla.org/MPL/2.0/.
|
|
|
|
package syncthing
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
"github.com/syncthing/syncthing/lib/db"
|
|
"github.com/syncthing/syncthing/lib/model"
|
|
"github.com/syncthing/syncthing/lib/protocol"
|
|
"github.com/syncthing/syncthing/lib/stats"
|
|
)
|
|
|
|
// Internals allows access to a subset of functionality in model.Model. While intended for use from applications that import
|
|
// the package, it is not intended as a stable API at this time. It does however provide a boundary between the more
|
|
// volatile Model interface and upstream users (one of which is an iOS app).
|
|
type Internals struct {
|
|
model model.Model
|
|
}
|
|
|
|
func newInternals(model model.Model) *Internals {
|
|
return &Internals{
|
|
model: model,
|
|
}
|
|
}
|
|
|
|
func (m *Internals) FolderState(folderID string) (string, time.Time, error) {
|
|
return m.model.State(folderID)
|
|
}
|
|
|
|
func (m *Internals) Ignores(folderID string) ([]string, []string, error) {
|
|
return m.model.CurrentIgnores(folderID)
|
|
}
|
|
|
|
func (m *Internals) SetIgnores(folderID string, content []string) error {
|
|
return m.model.SetIgnores(folderID, content)
|
|
}
|
|
|
|
func (m *Internals) DownloadBlock(ctx context.Context, deviceID protocol.DeviceID, folderID string, path string, blockNumber int, blockInfo protocol.BlockInfo, allowFromTemporary bool) ([]byte, error) {
|
|
return m.model.RequestGlobal(ctx, deviceID, folderID, path, int(blockNumber), blockInfo.Offset, blockInfo.Size, blockInfo.Hash, blockInfo.WeakHash, allowFromTemporary)
|
|
}
|
|
|
|
func (m *Internals) BlockAvailability(folderID string, file protocol.FileInfo, block protocol.BlockInfo) ([]model.Availability, error) {
|
|
return m.model.Availability(folderID, file, block)
|
|
}
|
|
|
|
func (m *Internals) GlobalFileInfo(folderID, path string) (protocol.FileInfo, bool, error) {
|
|
return m.model.CurrentGlobalFile(folderID, path)
|
|
}
|
|
|
|
func (m *Internals) GlobalTree(folderID string, prefix string, levels int, returnOnlyDirectories bool) ([]*model.TreeEntry, error) {
|
|
return m.model.GlobalDirectoryTree(folderID, prefix, levels, returnOnlyDirectories)
|
|
}
|
|
|
|
func (m *Internals) IsConnectedTo(deviceID protocol.DeviceID) bool {
|
|
return m.model.ConnectedTo(deviceID)
|
|
}
|
|
|
|
func (m *Internals) ScanFolders() map[string]error {
|
|
return m.model.ScanFolders()
|
|
}
|
|
|
|
func (m *Internals) Completion(deviceID protocol.DeviceID, folderID string) (model.FolderCompletion, error) {
|
|
return m.model.Completion(deviceID, folderID)
|
|
}
|
|
|
|
func (m *Internals) DeviceStatistics() (map[protocol.DeviceID]stats.DeviceStatistics, error) {
|
|
return m.model.DeviceStatistics()
|
|
}
|
|
|
|
func (m *Internals) PendingFolders(deviceID protocol.DeviceID) (map[string]db.PendingFolder, error) {
|
|
return m.model.PendingFolders(deviceID)
|
|
}
|
|
|
|
func (m *Internals) DBSnapshot(folderID string) (*db.Snapshot, error) {
|
|
return m.model.DBSnapshot(folderID)
|
|
}
|
|
|
|
func (m *Internals) ScanFolderSubdirs(folderID string, paths []string) error {
|
|
return m.model.ScanFolderSubdirs(folderID, paths)
|
|
}
|
|
|
|
func (m *Internals) FolderProgressBytesCompleted(folder string) int64 {
|
|
return m.model.FolderProgressBytesCompleted(folder)
|
|
}
|
|
|
|
// NeedFolderFiles returns paginated list of currently needed files in
|
|
// progress, queued, and to be queued on next puller iteration.
|
|
func (m *Internals) NeedFolderFiles(folder string, page, perpage int) ([]protocol.FileInfo, []protocol.FileInfo, []protocol.FileInfo, error) {
|
|
return m.model.NeedFolderFiles(folder, page, perpage)
|
|
}
|
|
|
|
func (m *Internals) RemoteNeedFolderFiles(folder string, device protocol.DeviceID, page, perpage int) ([]protocol.FileInfo, error) {
|
|
return m.model.RemoteNeedFolderFiles(folder, device, page, perpage)
|
|
}
|
|
|
|
func (m *Internals) LocalChangedFolderFiles(folder string, page, perpage int) ([]protocol.FileInfo, error) {
|
|
return m.model.LocalChangedFolderFiles(folder, page, perpage)
|
|
}
|