mirror of
https://github.com/syncthing/syncthing.git
synced 2024-11-16 02:18:44 -07:00
de0b4270df
### Purpose This PR contains the set of changes needed to make Syncthing work on iOS for [my iOS app for Syncthing](https://github.com/pixelspark/sushitrain). Most changes originate from [the Mobius Sync fork](http://github.com/MobiusSync/syncthing/tree/ios). I have removed the changes from their fork that are not strictly needed for my app (i.e. their changes to the GUI and command line utilities, for instance) and squashed it all in a single commit. In summary, the changes are: * Resolve non-absolute paths to the 'Documents' folder (basically the only one an app can/should write user data to by default on iOS) * Tweaking of build flags/conditions for iOS (i.e. determine which basicfs_watch, ignoreresult variant to build for iOS) * Disable upgrade mechanism on iOS * Make `RequestGlobal` and `PullerProgress` public symbols * Expose syncthing.app's Model instance (app.M) * Add no-op stub for SetLowPriority on iOS I would very much appreciate these changes to be (eventually) merged to mainline syncthing, as this would allow my iOS app to track the mainline source code directly and removes the need (for me at least) for maintaining a separate fork. Perhaps the Mobius folks can also benefit from this (although as noted this branch does not contain their changes to e.g. the GUI). ### Testing This branch has been tested with the iOS app and appears to work fine. The full set of MobiusSync changes has been used before with success. ### Screenshots n/a ### Documentation There should be no visible changes for users due to this set of changes. --------- Co-authored-by: Simon Pickup <simon@pickupinfinity.com>
134 lines
3.5 KiB
Go
134 lines
3.5 KiB
Go
// Copyright (C) 2016 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 http://mozilla.org/MPL/2.0/.
|
|
|
|
//go:build !(solaris && !cgo) && !(darwin && !cgo) && !(darwin && kqueue) && !(android && amd64) && !ios
|
|
// +build !solaris cgo
|
|
// +build !darwin cgo
|
|
// +build !darwin !kqueue
|
|
// +build !android !amd64
|
|
// +build !ios
|
|
|
|
package fs
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"unicode/utf8"
|
|
|
|
"github.com/syncthing/notify"
|
|
)
|
|
|
|
// Notify does not block on sending to channel, so the channel must be buffered.
|
|
// The actual number is magic.
|
|
// Not meant to be changed, but must be changeable for tests
|
|
var backendBuffer = 500
|
|
|
|
func (f *BasicFilesystem) Watch(name string, ignore Matcher, ctx context.Context, ignorePerms bool) (<-chan Event, <-chan error, error) {
|
|
watchPath, roots, err := f.watchPaths(name)
|
|
if err != nil {
|
|
return nil, nil, err
|
|
}
|
|
|
|
outChan := make(chan Event)
|
|
backendChan := make(chan notify.EventInfo, backendBuffer)
|
|
|
|
eventMask := subEventMask
|
|
if !ignorePerms {
|
|
eventMask |= permEventMask
|
|
}
|
|
|
|
absShouldIgnore := func(absPath string) bool {
|
|
if !utf8.ValidString(absPath) {
|
|
return true
|
|
}
|
|
|
|
rel, err := f.unrootedChecked(absPath, roots)
|
|
if err != nil {
|
|
return true
|
|
}
|
|
return ignore.Match(rel).CanSkipDir()
|
|
}
|
|
err = notify.WatchWithFilter(watchPath, backendChan, absShouldIgnore, eventMask)
|
|
if err != nil {
|
|
notify.Stop(backendChan)
|
|
if reachedMaxUserWatches(err) {
|
|
err = errors.New("failed to setup inotify handler. Please increase inotify limits, see https://docs.syncthing.net/users/faq.html#inotify-limits")
|
|
}
|
|
return nil, nil, err
|
|
}
|
|
|
|
errChan := make(chan error)
|
|
go f.watchLoop(ctx, name, roots, backendChan, outChan, errChan, ignore)
|
|
|
|
return outChan, errChan, nil
|
|
}
|
|
|
|
func (f *BasicFilesystem) watchLoop(ctx context.Context, name string, roots []string, backendChan chan notify.EventInfo, outChan chan<- Event, errChan chan<- error, ignore Matcher) {
|
|
for {
|
|
// Detect channel overflow
|
|
if len(backendChan) == backendBuffer {
|
|
outer:
|
|
for {
|
|
select {
|
|
case <-backendChan:
|
|
default:
|
|
break outer
|
|
}
|
|
}
|
|
// When next scheduling a scan, do it on the entire folder as events have been lost.
|
|
outChan <- Event{Name: name, Type: NonRemove}
|
|
l.Debugln(f.Type(), f.URI(), "Watch: Event overflow, send \".\"")
|
|
}
|
|
|
|
select {
|
|
case ev := <-backendChan:
|
|
evPath := ev.Path()
|
|
|
|
if !utf8.ValidString(evPath) {
|
|
l.Debugln(f.Type(), f.URI(), "Watch: Ignoring invalid UTF-8")
|
|
continue
|
|
}
|
|
|
|
relPath, err := f.unrootedChecked(evPath, roots)
|
|
if err != nil {
|
|
select {
|
|
case errChan <- err:
|
|
l.Debugln(f.Type(), f.URI(), "Watch: Sending error", err)
|
|
case <-ctx.Done():
|
|
}
|
|
notify.Stop(backendChan)
|
|
l.Debugln(f.Type(), f.URI(), "Watch: Stopped due to", err)
|
|
return
|
|
}
|
|
|
|
if ignore.Match(relPath).IsIgnored() {
|
|
l.Debugln(f.Type(), f.URI(), "Watch: Ignoring", relPath)
|
|
continue
|
|
}
|
|
evType := f.eventType(ev.Event())
|
|
select {
|
|
case outChan <- Event{Name: relPath, Type: evType}:
|
|
l.Debugln(f.Type(), f.URI(), "Watch: Sending", relPath, evType)
|
|
case <-ctx.Done():
|
|
notify.Stop(backendChan)
|
|
l.Debugln(f.Type(), f.URI(), "Watch: Stopped")
|
|
return
|
|
}
|
|
case <-ctx.Done():
|
|
notify.Stop(backendChan)
|
|
l.Debugln(f.Type(), f.URI(), "Watch: Stopped")
|
|
return
|
|
}
|
|
}
|
|
}
|
|
|
|
func (*BasicFilesystem) eventType(notifyType notify.Event) EventType {
|
|
if notifyType&rmEventMask != 0 {
|
|
return Remove
|
|
}
|
|
return NonRemove
|
|
}
|