Add webhook support

Makefile.in

@@ -78,7 +78,8 @@ SOURCES = \
 	src/sync.d \
 	src/upload.d \
 	src/util.d \
-	src/progress.d
+	src/progress.d \
+	src/arsd/cgi.d
 
 ifeq ($(NOTIFICATIONS),yes)
 SOURCES += src/notifications/notify.d src/notifications/dnotify.d
@@ -123,7 +124,7 @@ else
 ifeq ($(RHEL_VERSION),6)
 	install -D contrib/init.d/onedrive.init $(DESTDIR)/etc/init.d/onedrive
 	install -D contrib/init.d/onedrive_service.sh $(DESTDIR)$(bindir)/onedrive_service.sh
-endif	
+endif
 endif
 ifeq ($(COMPLETIONS),yes)
 	$(INSTALL) -D -m 644 contrib/completions/complete.zsh $(DESTDIR)$(ZSH_COMPLETION_DIR)/_onedrive

README.md

@@ -13,7 +13,8 @@ This client is a 'fork' of the [skilion](https://github.com/skilion/onedrive) cl
 
 ## Features
 *   State caching
-*   Real-Time file monitoring with Inotify
+*   Real-Time local file monitoring with inotify
+*   Real-Time syncing of remote updates via webhooks
 *   File upload / download validation to ensure data integrity
 *   Resumable uploads
 *   Support OneDrive for Business (part of Office 365)
@@ -27,7 +28,6 @@ This client is a 'fork' of the [skilion](https://github.com/skilion/onedrive) cl
 *   Supports rate limiting of traffic
 
 ## What's missing
-*   While local changes are uploaded right away, remote changes are delayed until next automated sync cycle when using --monitor
 *   Ability to encrypt/decrypt files on-the-fly when uploading/downloading files from OneDrive
 *   Support for Windows 'On-Demand' functionality so file is only downloaded when accessed locally
 *   A GUI for configuration management

config

@@ -41,4 +41,10 @@
 # sync_business_shared_folders = "false"
 # sync_dir_permissions = "700"
 # sync_file_permissions = "600"
-# rate_limit = "131072"
+# rate_limit = "131072"
+# webhook_enabled = "false"
+# webhook_public_url = ""
+# webhook_listening_host = ""
+# webhook_listening_port = "8888"
+# webhook_expiration_interval = "86400"
+# webhook_renewal_interval = "43200"

docs/USAGE.md

@@ -36,6 +36,10 @@
   * [Shared folders (OneDrive Business or Office 365)](#shared-folders-onedrive-business-or-office-365)
   * [SharePoint / Office 365 Shared Libraries](#sharepoint--office-365-shared-libraries)
 - [Running 'onedrive' in 'monitor' mode](#running-onedrive-in-monitor-mode)
+  * [Use webhook to subscribe to remote updates in 'monitor' mode](#use-webhook-to-subscribe-to-remote-updates-in-monitor-mode)
+  * [More webhook configuration options](#more-webhook-configuration-options)
+    + [webhook_listening_host and webhook_listening_port](#webhook_listening_host-and-webhook_listening_port)
+    + [webhook_expiration_interval and webhook_renewal_interval](#webhook_expiration_interval-and-webhook_renewal_interval)
 - [Running 'onedrive' as a system service](#running-onedrive-as-a-system-service)
   * [OneDrive service running as root user via init.d](#onedrive-service-running-as-root-user-via-initd)
   * [OneDrive service running as root user via systemd (Arch, Ubuntu, Debian, OpenSuSE, Fedora)](#onedrive-service-running-as-root-user-via-systemd-arch-ubuntu-debian-opensuse-fedora)
@@ -84,19 +88,19 @@ After installing the application you must authorize the application with your On
 
 You will be asked to open a specific URL by using your web browser where you will have to login into your Microsoft Account and give the application the permission to access your files. After giving permission to the application, you will be redirected to a blank page. Copy the URI of the blank page into the application.
 ```text
-[user@hostname ~]$ onedrive 
+[user@hostname ~]$ onedrive
 
 Authorize this app visiting:
 
 https://.....
 
-Enter the response uri: 
+Enter the response uri:
 
 ```
 
 **Example:**
 ```
-[user@hostname ~]$ onedrive 
+[user@hostname ~]$ onedrive
 Authorize this app visiting:
 
 https://login.microsoftonline.com/common/oauth2/v2.0/authorize?client_id=22c49a0d-d21c-4792-aed1-8f163c982546&scope=Files.ReadWrite%20Files.ReadWrite.all%20Sites.ReadWrite.All%20offline_access&response_type=code&redirect_uri=https://login.microsoftonline.com/common/oauth2/nativeclient
@@ -120,7 +124,7 @@ Config path                            = /home/alex/.config/onedrive
 Config file found in config path       = false
 Config option 'check_nosync'           = false
 Config option 'sync_dir'               = /home/alex/OneDrive
-Config option 'skip_dir'               = 
+Config option 'skip_dir'               =
 Config option 'skip_file'              = ~*|.~*|*.tmp
 Config option 'skip_dotfiles'          = false
 Config option 'skip_symlinks'          = false
@@ -188,7 +192,7 @@ Example: If the full path is `~/OneDrive/mydir`, the command would be `onedrive
 ### Performing a 'one-way' download sync
 In some cases it may be desirable to 'download only' from OneDrive. To do this use the following command:
 ```text
-onedrive --synchronize --download-only 
+onedrive --synchronize --download-only
 ```
 
 ### Performing a 'one-way' upload sync
@@ -353,6 +357,12 @@ See the [config](https://github.com/raw/abraunegg/onedrive/master/con
 # sync_file_permissions = "600"
 # rate_limit = "131072"
 # operation_timeout = "3600"
+# webhook_enabled = "false"
+# webhook_public_url = ""
+# webhook_listening_host = ""
+# webhook_listening_port = "8888"
+# webhook_expiration_interval = "86400"
+# webhook_renewal_interval = "43200"
 ```
 
 
@@ -401,7 +411,7 @@ sync_file_permissions = "600"
 **Important:** Special permission bits (setuid, setgid, sticky bit) are not supported. Valid permission values are from `000` to `777` only.
 
 #### skip_dir
-Example: 
+Example:
 ```text
 # When changing a config option below, remove the '#' from the start of the line
 # For explanations of all config options below see docs/USAGE.md or the man page.
@@ -528,7 +538,7 @@ Each line of the file represents a relative path from your `sync_dir`. All files
 Here is an example of `sync_list`:
 ```text
 # sync_list supports comments
-# 
+#
 # The ordering of entries is highly recommended - exclusions before inclusions
 #
 # Exclude temp folders under Documents
@@ -562,7 +572,7 @@ The following are supported for pattern matching and exclusion rules:
 To simplify 'exclusions' and 'inclusions', the following is also possible:
 ```text
 # sync_list supports comments
-# 
+#
 # The ordering of entries is highly recommended - exclusions before inclusions
 #
 # Exclude temp folders under Documents
@@ -583,7 +593,7 @@ sync_root_files = "true"
 This will tell the application to sync any file that it finds in your 'sync_dir' root by default.
 
 ### Configuring the client for 'single tenant application' use
-In some instances when using OneDrive Business Accounts, depending on the Azure organisational configuration, it will be necessary to configure the client as a 'single tenant application'. 
+In some instances when using OneDrive Business Accounts, depending on the Azure organisational configuration, it will be necessary to configure the client as a 'single tenant application'.
 To configure this, after creating the application on your Azure tenant, update the 'config' file with the tenant name (not the GUID) and the newly created Application ID, then this will be used for the authentication process.
 ```text
 # skip_dir_strict_match = "false"
@@ -682,6 +692,59 @@ sudo sysctl fs.inotify.max_user_watches=<new_value>
 
 To make these changes permanent, refer to your OS reference documentation.
 
+### Use webhook to subscribe to remote updates in 'monitor' mode
+
+A webhook can be optionally enabled in the monitor mode to allow the onedrive process to subscribe to remote updates. Remote changes can be synced to your local file system as soon as possible, without waiting for the next sync cycle.
+
+To enable this feature, you need to configure the following options in the config file:
+
+```
+webhook_enabled = "true"
+webhook_public_url = "<public-facing url to reach your webhook>"
+```
+
+Setting `webhook_enabled` to `true` enables the webhook in 'monitor' mode. The onedrive process will listen for incoming updates at a configurable endpoint, which defaults to `0.0.0.0:8888`. The `webhook_public_url` must be set to an public-facing url for Microsoft to send updates to your webhook. If your host is directly exposed to the Internet, the `webhook_public_url` can be set to `http://<your_host>:8888/` to match the default endpoint. However, the recommended approach is to configure a reverse proxy like nginx.
+
+For example, below is a nginx config snippet to proxy traffic into the webhook:
+
+```
+http {
+  server {
+    listen 80;
+    location /webhooks/onedrive {
+      proxy_pass http://127.0.0.1:8888;
+    }
+  }
+}
+```
+
+With nginx running, you can configure `webhook_public_url` to `http://<your_host>/webhooks/onedrive`.
+
+### More webhook configuration options
+
+Below options can be optionally configured. The default is usually good enough.
+
+#### webhook_listening_host and webhook_listening_port
+
+Set `webhook_listening_host` and `webhook_listening_port` to change the webhook listening endpoint. If `webhook_listening_host` is left empty, which is the default, the webhook will bind to `0.0.0.0`. The default `webhook_listening_port` is `8888`.
+
+```
+webhook_listening_host = ""
+webhook_listening_port = "8888"
+```
+
+#### webhook_expiration_interval and webhook_renewal_interval
+
+Set `webhook_expiration_interval` and `webhook_renewal_interval` to change the frequency of subscription renewal. By default, the webhook asks Microsoft to keep subscriptions alive for 24 hours, and it renews subscriptions when it is less than 12 hours before their expiration.
+
+```
+# Default expiration interval is 24 hours
+webhook_expiration_interval = "86400"
+
+# Default renewal interval is 12 hours
+webhook_renewal_interval = "43200"
+```
+
 ## Running 'onedrive' as a system service
 There are a few ways to use onedrive as a service
 *   via init.d
@@ -869,7 +932,7 @@ for extra details.
 *   Configuring the client for use in dual-boot (Windows / Linux) situations
 *   Configuring the client for use when 'sync_dir' is a mounted directory
 *   Upload data from the local ~/OneDrive folder to a specific location on OneDrive
- 
+
 Refer to [./advanced-usage.md](advanced-usage.md) for configuration assistance.
 
 ### Access OneDrive service through a proxy

src/arsd/README.md

@@ -0,0 +1,8 @@
+The files in this directory have been obtained form the following places:
+
+cgi.d
+	https://github.com/adamdruppe/arsd/blob/a870179988b8881b04126856105f0fad2cc0018d/cgi.d
+	License: Boost Software License - Version 1.0
+
+    Copyright 2008-2021, Adam D. Ruppe
+	see https://github.com/adamdruppe/arsd/blob/a870179988b8881b04126856105f0fad2cc0018d/LICENSE