├── requirements.txt ├── .gitignore ├── screenshots ├── overview.png ├── offline_device.png └── pending_device_and_folder.png ├── .dockerignore ├── cron ├── hourly │ └── retry_offline_devices └── daily │ └── report ├── Dockerfile ├── env_reader.py ├── .github └── workflows │ └── build_image.yml ├── README.MD ├── app.py ├── syncthing_multi_server ├── syncthing.py └── syncthing_muxer.py ├── templates └── index.html └── LICENSE /requirements.txt: -------------------------------------------------------------------------------- 1 | flask 2 | requests 3 | gunicorn -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .venv/ 2 | __pycache__/ 3 | device_list.json 4 | docker-compose.yml 5 | sm2.log -------------------------------------------------------------------------------- /screenshots/overview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nware-lab/sm2/HEAD/screenshots/overview.png -------------------------------------------------------------------------------- /screenshots/offline_device.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nware-lab/sm2/HEAD/screenshots/offline_device.png -------------------------------------------------------------------------------- /.dockerignore: -------------------------------------------------------------------------------- 1 | **/.gitea/ 2 | **/.venv/ 3 | **/__pycache__/ 4 | /screenshots 5 | device_list.json 6 | docker-compose.yml 7 | sm2.log -------------------------------------------------------------------------------- /screenshots/pending_device_and_folder.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nware-lab/sm2/HEAD/screenshots/pending_device_and_folder.png -------------------------------------------------------------------------------- /cron/hourly/retry_offline_devices: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # retry offline devices 4 | wget http://127.0.0.1:8456/retry_offline_devices -O /dev/null -------------------------------------------------------------------------------- /cron/daily/report: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | #report to home 3 | #It looks like here we are ignoring if the user has configured whether or to do the reporting. 4 | #The users decision is captured by the webserver. 5 | #Future goal is to remove this cron job when the reporting is disable by the user 6 | echo doing the report call 7 | wget http://127.0.0.1:8456/report -O /dev/null -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM python:alpine3.21 2 | 3 | ENV PYTHONUNBUFFERED=true 4 | 5 | COPY requirements.txt . 6 | RUN pip3 install --no-cache-dir -r requirements.txt 7 | ENV SM2_VERSION=0.1.7 8 | ENV TZ=UTC 9 | COPY . /app 10 | COPY ./cron /etc/periodic 11 | RUN chmod +x -R /etc/periodic/ 12 | WORKDIR /app 13 | ENTRYPOINT ["python3"] 14 | HEALTHCHECK --interval=5s --timeout=1s --start-period=5s --retries=1 CMD ps aux | grep 'gunicorn' || exit 1 15 | CMD ["/usr/local/bin/gunicorn","-w", "1","-t", "5", "-b","0.0.0.0:8456","--timeout","10","app:app"] 16 | -------------------------------------------------------------------------------- /env_reader.py: -------------------------------------------------------------------------------- 1 | import os 2 | 3 | 4 | def get_devices_from_env_vriables(): 5 | print("checking env variables for device configs") 6 | count = 1 7 | running = True 8 | devices = list() 9 | while (running): 10 | 11 | name= os.environ.get(f"DEV_NAME_{count}", None) 12 | if name == None: 13 | break 14 | url= os.environ.get(f"DEV_URL_{count}", None) 15 | api_key= os.environ.get(f"DEV_API_KEY_{count}", None) 16 | # checking if all keys are present is done when devices are added to the mux 17 | 18 | # got all the vars for this round to lets add them 19 | devices.append({"name": name, "url": url, "api_key": api_key}) 20 | 21 | count += 1 22 | 23 | return devices 24 | -------------------------------------------------------------------------------- /.github/workflows/build_image.yml: -------------------------------------------------------------------------------- 1 | name: Build sm2 docker image 2 | on: 3 | push: 4 | 5 | jobs: 6 | push_to_registry: 7 | name: Push Docker image to Docker Hub 8 | runs-on: ubuntu-latest 9 | permissions: 10 | packages: write 11 | contents: read 12 | attestations: write 13 | id-token: write 14 | steps: 15 | - name: Check out the repo 16 | uses: actions/checkout@v4 17 | 18 | - name: Log in to Docker Hub 19 | uses: docker/login-action@v3 20 | with: 21 | username: ${{ secrets.DOCKER_HUB_USERNAME }} 22 | password: ${{ secrets.DOCKER_HUB_TOKEN }} 23 | - name: Build and push Docker image for main branch => latest 24 | id: push_latest_image 25 | uses: docker/build-push-action@3b5e8027fcad23fda98b2e3ac259d8d67585f671 26 | with: 27 | context: . 28 | file: ./Dockerfile 29 | push: true 30 | tags: nwarelab/sm2:latest 31 | if: github.ref_name == 'main' 32 | 33 | 34 | - name: Build and push Docker image for other branches 35 | id: push_branch_image 36 | uses: docker/build-push-action@3b5e8027fcad23fda98b2e3ac259d8d67585f671 37 | with: 38 | context: . 39 | file: ./Dockerfile 40 | push: true 41 | tags: nwarelab/sm2:${{github.ref_name}} 42 | if: github.ref_name != 'main' 43 | 44 | -------------------------------------------------------------------------------- /README.MD: -------------------------------------------------------------------------------- 1 | # sm² 2 | Syncthing Multi Server Monitor 3 | stylized as sm² (or sm2 for convenience) 4 | 5 | 6 | ## The goal: 7 | Monitor multiple syncthing instances while using as little diskspace(docker image size) & memory while doing it. 8 | 9 | This affected the following parts: 10 | - no use of an already made syncthing library (this also allows sm2 to only ever call GET endpoinds) 11 | - no fancy ui -> lower diskspace, loadtime ( I also could not make a fancy ui if I tried) 12 | - no logging exept printing to console logging increased the ram usage by ~50% 13 | 14 | 15 | This project was made with very little sleep so there will be typo's, missed conventions, ... let me know when you see anything. 16 | Any feedback is appreciated. 17 | 18 | # features 19 | - Sync status of each device (threaded for performance) 20 | - List of folders with local changes (if there are any) 21 | - List pending devices or folders (if there are any) 22 | - Display of errors (if there are any) 23 | - API for monitoring (I use changedetecion.io) 24 | - Small footprint: docker image ~65MB, ram usage 34MB (goal is to lower this back down) 25 | - Responsive UI that works on mobile devices 26 | - Configure devices with environment variables or with a json file 27 | - handling devices going offline and returning (phones, laptops, ...) 28 | 29 | # Screenshots 30 | 31 |
32 | overview 33 |
34 |
35 | pending_device_and_folder 36 | offline_device 37 |
38 | 39 | Usage: 40 | add your syncthing devices via a json file or env variables: 41 | 42 | json: 43 | ``` 44 | [ 45 | {"name" : "device1", 46 | "url": "10.0.0.1:8384", 47 | "api_key": "API_KEY" }, 48 | {"name" : "device2", 49 | "url": "10.0.0.2:8384", 50 | "api_key": "API_KEY" } 51 | ] 52 | ``` 53 | env variables: 54 | ``` 55 | - DEV_NAME_1=device1 56 | - DEV_URL_1=10.0.0.1:8384 57 | - DEV_API_KEY_1=API_KEY 58 | - DEV_NAME_2=device2 59 | - DEV_URL_2=10.0.0.2:8384 60 | - DEV_API_KEY_2=API_KEY 61 | ``` 62 | 63 | The default protocol used is http if you require https for a device you'll need to add it to the url 64 | 65 | 66 | # docker-compose example 67 | You can mix both env variables & the device file 68 | ## with env variables 69 | ``` 70 | sm2: 71 | image: nwarelab/sm2:latest 72 | container_name: sm2 73 | restart: always 74 | environment: 75 | - DEV_NAME_1=device1 76 | - DEV_URL_1=10.0.0.1:8384 77 | - DEV_API_KEY_1=API_KEY 78 | - DEV_NAME_2=device2 79 | - DEV_URL_2=10.0.0.2:8384 80 | - DEV_API_KEY_2=API_KEY 81 | ports: 82 | - 8456:8456 83 | ``` 84 | ## with device files 85 | ``` 86 | sm2: 87 | image: nwarelab/sm2:latest 88 | container_name: sm2 89 | restart: always 90 | ports: 91 | - 8456:8456 92 | volumes: 93 | - ./device_list.json:/app/device_list.json 94 | ``` 95 | 96 | ## data reporting 97 | By default the application reports some data back for usage statistics. 98 | This is to follow the amount installs and which versions users are running, ... 99 | sm2 will always report what data its sending back. 100 | example of the data 101 | ``` 102 | {'ts': 1738466626.1446433, 'hostname': '5251dae16210', 'dev': 1, 'v': '0.1', 'startup': 'True'} 103 | ``` 104 | currently this data includes: 105 | - docker container id (this is to keep instances apart in the stats) 106 | - amount off devices configured (just the amount) 107 | - application version 108 | 109 | tl:dr; 110 | 111 | sm² has basic reporting for some statistics. __no personal data__ will ever be sent over, if you want to disable this reporting add the following environment variable. _I would like it if you didn't because I like stats, but I fully understand if you don't_ 112 | ``` 113 | - DISABLE_REPORTING=true 114 | ``` 115 | # Exta settings 116 | | env variable | what it does | default value | 117 | |-----------------------------------------|-------------------------------------|-------------- | 118 | | DISABLE_OFFLINE_DEVICE_BACKGROUND_RETRY | disable the retrying off offline devices in background | false | 119 | | DISABLE_REPORTING | disable the information reporting | false | 120 | | DEVICE_API_TIMEOUT_SEC | timeout value for sm² calls to devices | 0.5 | 121 | 122 | 123 | # FAQ 124 | Q: How would I add devices that are on different networks? 125 | A: I use vpn's to connect my multiple locations common options are tailscale, netbird, twingate, ... (not endorsements) 126 | 127 | # TODO's 128 | - check offline devices in background 129 | - gotify for notifications ? 130 | - figure out healthcheck that has less cpu impact 131 | 132 | -------------------------------------------------------------------------------- /app.py: -------------------------------------------------------------------------------- 1 | 2 | from syncthing_multi_server.syncthing_muxer import Syncthing_mux 3 | import json 4 | from flask import Flask, jsonify, render_template, request 5 | from env_reader import get_devices_from_env_vriables 6 | import os.path 7 | 8 | 9 | app = Flask(__name__) 10 | 11 | mux = Syncthing_mux() 12 | 13 | # check if there is a device list file 14 | device_list_file_path = "device_list.json" 15 | if os.path.exists(device_list_file_path): 16 | with open (device_list_file_path, "r") as file: 17 | devices = json.load(file) 18 | # add the devices from the json to the mux 19 | mux.add_list_off_devices_dicts(devices) 20 | # add the devices from the env variable to the mux 21 | mux.add_list_off_devices_dicts(get_devices_from_env_vriables()) 22 | 23 | 24 | 25 | 26 | @app.route("/") 27 | def root(): 28 | # basic html page with an overview off all the configured devices 29 | # default refresh only the known online devices 30 | # but if we get a ?load=full we recheck the offline devices 31 | retest_offline_devices_if_requested() 32 | if request.args.get("thread") == "no": 33 | res = mux.get_full_device_list_status() 34 | else: 35 | res = mux.get_full_device_list_status_threaded() 36 | offline_device_count = mux.get_offline_device_count() 37 | offine_device_names = mux.get_offline_device_names() 38 | last_checked_offline = mux.get_how_long_ago_we_checked_offline_devices_in_human() 39 | return render_template('index.html', status = res, offline_count= offline_device_count, offline_names = offine_device_names, last_checked_offline = last_checked_offline) 40 | 41 | @app.route("/retry_offline_devices") 42 | def retry_offline_devices(): 43 | res = mux.retest_the_offline_devices() 44 | return jsonify(res) 45 | 46 | @app.route("/api/status") 47 | def api_status(): 48 | retest_offline_devices_if_requested() 49 | 50 | # return the status off all devices to as a json result 51 | return mux.get_full_device_list_status() 52 | 53 | @app.route("/api/devices_not_fully_synced") 54 | def api_devices_not_fully_synced(): 55 | return mux.get_list_off_devices_that_are_not_fully_synced() 56 | 57 | @app.route("/ping") 58 | def ping(): 59 | return jsonify("ello") 60 | 61 | 62 | # send "metrics" home on startup 63 | # no reason to trigger this yourself 64 | # Please don't spam this. :) thanks 65 | @app.route("/report") 66 | def report_data(startup = False): 67 | # some cool 'magic' which allows us to run this function before the app is fully loaded 68 | with app.app_context(): 69 | if os.environ.get("DISABLE_REPORTING", "false").lower() != "true": 70 | import time, socket, requests 71 | data= {} 72 | data["ts"]= time.time() 73 | #aware that this will only give contianer id but thats what i want. 74 | data["hostname"] = socket.gethostname() 75 | # amount off devices 76 | data["dev"]= mux.get_total_device_count() 77 | # app version 78 | data["v"]= os.environ.get("SM2_VERSION", "0") 79 | # is this the startup report or not 80 | data["startup"]= startup 81 | try: 82 | requests.post("https://private-sm2monitor.onrender.com/report",json=data) 83 | except Exception: 84 | print("stats reporting failed") 85 | return jsonify(data) 86 | return jsonify("user requested no reporting so we will not") 87 | 88 | 89 | def retest_offline_devices_if_requested(): 90 | if request.args.get("load") == "full": 91 | mux.retest_the_offline_devices() 92 | 93 | def remove_cron_jobs_if_requested(): 94 | print("cleaning cron jobs if requested") 95 | if os.environ.get("DISABLE_REPORTING", "false").lower() == "true": 96 | # the user requested no reporting so we will delete the cron job that would trigger that reporting. 97 | report_path = "/etc/periodic/daily/report" 98 | if os.path.exists("/etc/periodic/daily/report"): 99 | print("deleting daily report cron script") 100 | os.remove(report_path) 101 | else: 102 | print(f"{report_path} not found or already deleted") 103 | if os.environ.get("DISABLE_OFFLINE_DEVICE_BACKGROUND_RETRY", "false").lower() == "true": 104 | # user asked for no background retry off the offline devices 105 | retry_offline_devices_path = "/etc/periodic/hourly/retry_offline_devices" 106 | if os.path.exists(retry_offline_devices_path): 107 | print("deleting hourly offline device retry cron") 108 | os.remove(retry_offline_devices_path) 109 | else: 110 | print(f"{retry_offline_devices_path} not found or already deleted") 111 | 112 | 113 | def start_cron_daemon(): 114 | import subprocess 115 | subprocess.run("crond") 116 | print("Background cron started") 117 | 118 | if __name__ == '__main__': 119 | app.run() 120 | 121 | report_data(startup=True) 122 | remove_cron_jobs_if_requested() 123 | start_cron_daemon() 124 | print("sm² is loaded and ready") 125 | print("-----------------------------") 126 | print(" ###### ## ## ####### ") 127 | print("## ## ### ### ## ## ") 128 | print("## #### #### ## ") 129 | print(" ###### ## ### ## ####### ") 130 | print(" ## ## ## ## ") 131 | print("## ## ## ## ## ") 132 | print(" ###### ## ## ######### ") -------------------------------------------------------------------------------- /syncthing_multi_server/syncthing.py: -------------------------------------------------------------------------------- 1 | import requests 2 | import json 3 | import os 4 | 5 | ''' 6 | Setup call timeout based on environment variable if requested by the user 7 | ''' 8 | timeout_default_value = 0.5 9 | timeout = timeout_default_value 10 | timeout_env_var_name="DEVICE_API_TIMEOUT_SEC" 11 | 12 | if timeout_env_var_name in os.environ: 13 | try: 14 | input=os.environ.get(timeout_env_var_name, timeout_default_value) 15 | timeout = float(input) 16 | print(f"{timeout_env_var_name} set to {timeout} seconds") 17 | except ValueError: 18 | print(f"error casting requested {timeout_env_var_name} value got : {input} \nreverting back to default value 0.5 s") 19 | # likely an unneeded line but it will one be executed on startup and keeps this readable 20 | timeout=timeout_default_value 21 | 22 | 23 | class Syncthing_device_status: 24 | """ Class for carrying the status off a syncthing device """ 25 | def __init__(self, instance_name, url): 26 | self.name = instance_name 27 | self.url = url 28 | self.sync_completion= None 29 | self.errors= None 30 | self.local_changed_files = None 31 | self.folder_count = 0 32 | self.device_count = 0 33 | 34 | 35 | 36 | 37 | class Syncthing: 38 | """ Class representing a Syncthing device """ 39 | folder_list_simplified = None 40 | folder_list = None 41 | 42 | def __init__(self,name, url, api_key): 43 | self.name = name 44 | self.baseurl = url 45 | self.api_key= api_key 46 | 47 | 48 | def get_syncthing_device_status(self) -> dict: 49 | device_status = Syncthing_device_status(instance_name=self.name, url=self.baseurl) 50 | device_status.errors = self.system_errors() 51 | device_status.sync_completion = self.system_sync_completion_level()["completion"] 52 | device_status.local_changed_files = self.list_folders_that_have_local_changes() 53 | device_status.folder_count = len(self.list_folders_simplified()) 54 | device_status.device_count = len(self.list_devices()) 55 | device_status.pending_folders = self.list_pending_folders_labels_for_device() 56 | device_status.pending_devices = self.list_pending_devices_labels_for_device() 57 | 58 | 59 | return device_status 60 | 61 | def _request_builder(self,path:str): 62 | # helper function to keep the rest of the code cleaner 63 | # short timeout because if we in 0.5 sec don't have our response something is wrong and we aren't going to wait forever 64 | # users asked for a configurable timeout, which we get from env variable: default value is 0.5s 65 | return requests.get(self.baseurl + path, headers = {'Authorization': f'Bearer {self.api_key}'},timeout=timeout) 66 | 67 | def healthcheck(self): 68 | # https://docs.syncthing.net/rest/noauth-health-get.html 69 | r = self._request_builder('rest/noauth/health') 70 | return r.json() 71 | 72 | def ping(self): 73 | # https://docs.syncthing.net/rest/system-ping-get.html 74 | r = self._request_builder('rest/system/ping') 75 | if r.status_code != 200: 76 | raise ConnectionError(f"Could not connect to client {self.name}") 77 | return r.json() 78 | 79 | def list_folders(self): 80 | # https://docs.syncthing.net/rest/config.html#rest-config-folders-rest-config-devices 81 | r = self._request_builder('rest/config/folders') 82 | self.folder_list =r.json() 83 | return r.json() 84 | 85 | def list_folders_simplified(self): 86 | js = self.list_folders() 87 | 88 | folder_dict = dict() 89 | # only keep the keys we are interested in 90 | for item in js: 91 | folder_dict[item["label"]]= item["id"] 92 | self.folder_list_simplified = folder_dict 93 | return folder_dict 94 | 95 | 96 | def system_status(self): 97 | # https://docs.syncthing.net/rest/system-status-get.html 98 | r = self._request_builder('rest/system/status') 99 | return r.json() 100 | 101 | def system_errors(self): 102 | # https://docs.syncthing.net/rest/folder-errors-get.html 103 | r = self._request_builder('rest/system/error') 104 | if r.json() == {'errors': None}: 105 | return None 106 | return r.json() 107 | 108 | def system_logs(self): 109 | # https://docs.syncthing.net/rest/system-log-get.html 110 | r = self._request_builder('rest/system/log') 111 | return r.json() 112 | 113 | def system_sync_completion_level(self): 114 | # https://docs.syncthing.net/rest/db-completion-get.html 115 | r = self._request_builder(f'rest/db/completion') 116 | return r.json() 117 | 118 | def list_folders_that_are_incomplete(self): 119 | folders_with_non_complete_status = list() 120 | for folder in self.folder_list: 121 | result = self.list_missing_files_for_folder(folder_id=folder["id"]) 122 | return result 123 | 124 | def list_devices(self): 125 | # https://docs.syncthing.net/rest/config.html#rest-config-folders-rest-config-devices 126 | r = self._request_builder("rest/config/devices") 127 | return r.json() 128 | 129 | 130 | def list_local_changes_for_folder(self, folder_id): 131 | # https://docs.syncthing.net/rest/db-localchanged-get.html 132 | 133 | # only check for non paused folders 134 | r = self._request_builder(f"rest/db/localchanged?folder={folder_id}") 135 | # print(f"folderid = {folder_id} \n response\n{r}") 136 | return r.json() 137 | 138 | def list_folders_that_have_local_changes(self): 139 | folders_with_local_changes = dict() 140 | if self.folder_list == None: 141 | self.list_folders() 142 | if len(self.folder_list) == 0: 143 | return None 144 | for folder in self.folder_list: 145 | if folder["type"] == "receiveonly" and folder["paused"] == False : 146 | 147 | # print(folder["id"] + " " + folder["label"]) 148 | result = self.list_local_changes_for_folder(folder_id=folder["id"]) 149 | # print(result) 150 | result_count =len(result["files"]) 151 | if result_count > 0: 152 | folders_with_local_changes[folder["label"]] = result_count 153 | else: 154 | # print(f"skipping {folder['id']} as its either not reeive only or is paused") 155 | pass 156 | 157 | if len(folders_with_local_changes) == 0: 158 | return None 159 | 160 | return folders_with_local_changes 161 | 162 | def list_pending_folders_for_device(self): 163 | r = self._request_builder("rest/cluster/pending/folders") 164 | 165 | return r.json() 166 | def list_pending_devices_for_device(self): 167 | r = self._request_builder("rest/cluster/pending/devices") 168 | return r.json() 169 | 170 | def list_pending_devices_labels_for_device(self): 171 | js = self.list_pending_devices_for_device() 172 | # get jsust the labels from the js 173 | label_list = [] 174 | for device in js: 175 | label_list.append(js[device]["name"]) 176 | return label_list 177 | 178 | 179 | def list_pending_folders_labels_for_device(self): 180 | js = self.list_pending_folders_for_device() 181 | # get jsust the labels from the js 182 | label_list = [] 183 | for folder in js: 184 | if folder != "{}": 185 | # this feels like it could be done more efficient 186 | # TODO make this less iffy 187 | inter_folder = js[folder]["offeredBy"] 188 | device_name = list(inter_folder.keys())[0] 189 | label_list.append(inter_folder[device_name]["label"]) 190 | 191 | return label_list -------------------------------------------------------------------------------- /syncthing_multi_server/syncthing_muxer.py: -------------------------------------------------------------------------------- 1 | from syncthing_multi_server.syncthing import Syncthing 2 | import time 3 | 4 | import threading 5 | import concurrent.futures 6 | 7 | """ class that gathers the info from all the configured syncthing devices """ 8 | 9 | 10 | class Syncthing_mux: 11 | # type hint 12 | device_list : [Syncthing] 13 | 14 | def __init__(self): 15 | self.device_list = [] 16 | self.offline_device_list = [] 17 | self.offline_last_checked = time.time() 18 | 19 | def add_syncthing_device_to_mux(self, name, url, api_key): 20 | # cleanup the url 21 | if url.startswith("http") == False: 22 | url = f"http://{url}" 23 | # if no port is set we add the default syncthing ui port 24 | # but when a url starts with https, we expect the user to know what they are doing 25 | # and they will likely not be using the default webui port anymore 26 | if ':' not in url[-7:] and not url.startswith("https"): 27 | url = f"{url}:8384" 28 | if url.endswith("/") == False: 29 | url= f"{url}/" 30 | device = Syncthing(name, url, api_key) 31 | # check if the device is up 32 | try: 33 | device.healthcheck() 34 | except Exception as ex: 35 | # not perfect that we catch just every type off exception but for now it will do. 36 | print (f"error while connecting with device: {name}, this indicates that the protocol, ip or port is wrong, this test does not use the api key") 37 | print(f"{name} connection error : {ex}") 38 | self.add_device_to_the_offline_list(device=device) 39 | #this device errored so we don't add it to the list return to finish the function 40 | return 41 | # ping and also check if we have a working api key 42 | try: 43 | device.ping() 44 | except Exception as ex: 45 | print (f"error while connecting with device: {name} using its api key this indicates that the api key is wrong. ") 46 | self.add_device_to_the_offline_list(device=device) 47 | # print(ex.with_traceback()) 48 | #this device errored so we don't add it to the list return to finish the function 49 | return 50 | self.device_list.append(device) 51 | 52 | def add_list_off_devices_dicts(self, list): 53 | for device in list: 54 | # check if all params are present 55 | if "name" not in device: 56 | print("device added that is missing a name") 57 | return 58 | name = device["name"] 59 | if "url" not in device: 60 | print(f"device {name} is missing url") 61 | return 62 | url = device["url"] 63 | if "api_key" not in device: 64 | print(f"device {name} is missing an api_key") 65 | return 66 | api_key = device["api_key"] 67 | self.add_syncthing_device_to_mux(name= name, 68 | api_key= api_key, 69 | url=url) 70 | 71 | def add_device_to_the_offline_list(self, device:Syncthing): 72 | # sounds stupid to keep a device that is not online. 73 | # but some clients are not online 24/7 ex. mobile devices, personal computors, unstable connections, ... 74 | # so we keep these devices so that we can try to reach them in the future 75 | 76 | self.offline_device_list.append(device) 77 | def move_device_from_online_to_offline(self, device:Syncthing): 78 | #print(f"moving {device} to the offline list)") 79 | self.add_device_to_the_offline_list(device) 80 | self.device_list.remove(device) 81 | 82 | def retest_the_offline_devices(self): 83 | # remember when we last did this 84 | self.offline_last_checked = time.time() 85 | 86 | # we try if any of the offline devices is up now 87 | for device in self.offline_device_list: 88 | # we pop the device from the list as we are positive and assume that it will be online now. 89 | # pop 0 to take from the top as we always add to the bottom. 90 | # otherwise if all these are still offline we could check the last one in this list for the amount off offline devices in the list. 91 | dev = self.offline_device_list.pop(0) 92 | self.add_syncthing_device_to_mux(name=dev.name,url=dev.baseurl, api_key=dev.api_key) 93 | 94 | def get_how_long_ago_we_checked_offline_devices_seconds(self) -> int: 95 | return int(time.time() - self.offline_last_checked) 96 | def get_how_long_ago_we_checked_offline_devices_in_human(self) -> str: 97 | sec = self.get_how_long_ago_we_checked_offline_devices_seconds() 98 | if sec < 60: 99 | return f"{sec} second{'s' if sec > 1 else ''} ago" 100 | elif sec < 3600: # Less than an hour 101 | min = round(sec / 60) 102 | return f"{min} minute{'s' if min > 1 else ''} ago" 103 | elif sec < 86400: # Less than a day 104 | hours = round(sec / 3600) 105 | return f"{hours} hour{'s' if hours > 1 else ''} ago" 106 | else: 107 | days = round(sec / 86400) 108 | return f"{days} day{'s' if days > 1 else ''} ago" 109 | 110 | 111 | 112 | def del_none(self, d): 113 | # cleanup dict to remove keys that have None values 114 | for key, value in list(d.items()): 115 | if value is None: 116 | del d[key] 117 | elif isinstance(value, dict): 118 | self.del_none(value) 119 | return d 120 | 121 | def get_full_device_list_status(self): 122 | all_statuses = list() 123 | 124 | # before 800~ ms response for 6 devices 125 | #TODO multithread this 126 | 127 | for device in self.device_list: 128 | try: 129 | status = device.get_syncthing_device_status() 130 | # removing all keys that have null values 131 | all_statuses.append(self.del_none(status.__dict__)) 132 | except Exception as ex: # todo don't just catch all exceptions 133 | self.move_device_from_online_to_offline(device=device) 134 | 135 | 136 | return all_statuses 137 | 138 | def get_full_device_list_status_threaded(self): 139 | all_statuses = list() 140 | 141 | with concurrent.futures.ThreadPoolExecutor() as executor: 142 | futures = [executor.submit(self.thread_worker_get_device_status, device) for device in self.device_list] # create the threads and assign them function and arguments 143 | 144 | for future in concurrent.futures.as_completed(futures): # as_completed returns the results when the threads are done 145 | try: 146 | result = future.result() # Get the result from the thread 147 | all_statuses.append(result) 148 | except Exception as e: 149 | print(f"error when checking for statuses with threads {e}") 150 | print(f"because we have an error in the threaded way likely a device that has gone ofline, we switch back to the non threaded check") 151 | return self.get_full_device_list_status() 152 | 153 | 154 | return all_statuses 155 | 156 | def thread_worker_get_device_status(self, device:Syncthing): 157 | status = device.get_syncthing_device_status() 158 | return self.del_none(status.__dict__) 159 | 160 | def get_list_off_devices_that_are_not_fully_synced(self) -> []: 161 | full_status = self.get_full_device_list_status() 162 | unfinished_syncs = [] 163 | for device in full_status: 164 | if device["sync_completion"] < 100 : 165 | unfinished_syncs.append({"name": device["name"], "sync_completion" : device["sync_completion"]}) 166 | return unfinished_syncs 167 | 168 | 169 | def get_total_device_count(self) -> int: 170 | return len(self.offline_device_list) + len(self.device_list) 171 | 172 | def get_offline_device_count(self) -> int: 173 | return len(self.offline_device_list) 174 | def get_offline_device_names(self) -> [str]: 175 | name_list = [] 176 | for device in self.offline_device_list: 177 | name_list.append(device.name) 178 | return name_list -------------------------------------------------------------------------------- /templates/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | SM² 4 | 5 | 6 | 99 | 100 | 101 | 102 | 107 |
108 | 109 | Device{% if status |length > 1 %}s{% endif %} ({{ status |length }}) 110 |
111 |
112 | 113 | {%- for device in status %} 114 |
115 | 116 |

{{device.name}}

117 |
118 | {% if device.sync_completion == 100 %} 119 |
Up to Date
120 | {% else %} 121 |
Syncing {{device.sync_completion | int() }}%
122 | {% endif %} 123 |
{{device.folder_count}} folders - {{device.device_count}} devices
124 |
125 | 126 | {% if device.errors is defined %} 127 |
{{device.errors}}
128 | {% endif %} 129 | 130 | {% if device.local_changed_files is defined %} 131 |
Folders with local changes:
132 | {% if device.local_changed_files.items()| length > 0 %} 133 |
    134 | {%- for folder, count in device.local_changed_files.items() %} 135 |
  • {{folder}}: {{count}} file{% if count > 1 %}s{% endif %}
    • 136 | {% endfor %} 137 |
138 | {% else %} 139 |
No file conflicts
140 | {% endif %} 141 | {% endif %} 142 | 143 | 144 | {% if device.pending_devices is defined and device.pending_devices| length > 0 %} 145 |
Pending device{% if device.pending_devices|length > 1 %}s{% endif %}:
146 |
    147 | {%- for device in device.pending_devices %} 148 |
  • {{device}}
    • 149 | {% endfor %} 150 |
151 | {% endif %} 152 | 153 | 154 | {% if device.pending_folders is defined and device.pending_folders| length > 0 %} 155 |
Pending folder{% if device.pending_folders|length > 1 %}s{% endif %}:
156 |
    157 | {%- for folder in device.pending_folders %} 158 |
  • {{folder}}
    • 159 | {% endfor %} 160 |
161 | {% endif %} 162 | 163 | 164 |
165 | 166 |
167 | {% endfor %} 168 | {% if offline_count > 0 %} 169 |
170 |

Offline Devices

171 |
172 |
{{offline_count}} offline device{% if offline_count > 1 %}s{% endif %}
173 | 174 |
Checked {{last_checked_offline}}
175 |
Check
176 |
    177 | {%- for device_name in offline_names %} 178 |
      ● {{device_name}}
    179 | {% endfor %} 180 |
181 |
182 |
183 | {% endif %} 184 |
185 | 186 | 187 | 188 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | “Commons Clause” License Condition v1.0 2 | 3 | The Software is provided to you by the Licensor under the License, as defined below, subject to the following condition. 4 | 5 | Without limiting other conditions in the License, the grant of rights under the License will not include, and the License does not grant to you, right to Sell the Software. 6 | 7 | For purposes of the foregoing, “Sell” means practicing any or all of the rights granted to you under the License to provide to third parties, for a fee or other consideration (including without limitation fees for hosting or consulting/ support services related to the Software), a product or service whose value derives, entirely or substantially, from the functionality of the Software. Any license notice or attribution required by the License must also include this Commons Cause License Condition notice. 8 | 9 | Software: sm2 10 | License: GNU GENERAL PUBLIC LICENSE with Commons Clause 11 | Licensor: nware-lab 12 | 13 | 14 | --------------------------------------------------------------------- 15 | 16 | GNU GENERAL PUBLIC LICENSE 17 | Version 3, 29 June 2007 18 | 19 | Copyright (C) 2007 Free Software Foundation, Inc. 20 | Everyone is permitted to copy and distribute verbatim copies 21 | of this license document, but changing it is not allowed. 22 | 23 | Preamble 24 | 25 | The GNU General Public License is a free, copyleft license for 26 | software and other kinds of works. 27 | 28 | The licenses for most software and other practical works are designed 29 | to take away your freedom to share and change the works. By contrast, 30 | the GNU General Public License is intended to guarantee your freedom to 31 | share and change all versions of a program--to make sure it remains free 32 | software for all its users. We, the Free Software Foundation, use the 33 | GNU General Public License for most of our software; it applies also to 34 | any other work released this way by its authors. You can apply it to 35 | your programs, too. 36 | 37 | When we speak of free software, we are referring to freedom, not 38 | price. Our General Public Licenses are designed to make sure that you 39 | have the freedom to distribute copies of free software (and charge for 40 | them if you wish), that you receive source code or can get it if you 41 | want it, that you can change the software or use pieces of it in new 42 | free programs, and that you know you can do these things. 43 | 44 | To protect your rights, we need to prevent others from denying you 45 | these rights or asking you to surrender the rights. Therefore, you have 46 | certain responsibilities if you distribute copies of the software, or if 47 | you modify it: responsibilities to respect the freedom of others. 48 | 49 | For example, if you distribute copies of such a program, whether 50 | gratis or for a fee, you must pass on to the recipients the same 51 | freedoms that you received. You must make sure that they, too, receive 52 | or can get the source code. And you must show them these terms so they 53 | know their rights. 54 | 55 | Developers that use the GNU GPL protect your rights with two steps: 56 | (1) assert copyright on the software, and (2) offer you this License 57 | giving you legal permission to copy, distribute and/or modify it. 58 | 59 | For the developers' and authors' protection, the GPL clearly explains 60 | that there is no warranty for this free software. For both users' and 61 | authors' sake, the GPL requires that modified versions be marked as 62 | changed, so that their problems will not be attributed erroneously to 63 | authors of previous versions. 64 | 65 | Some devices are designed to deny users access to install or run 66 | modified versions of the software inside them, although the manufacturer 67 | can do so. This is fundamentally incompatible with the aim of 68 | protecting users' freedom to change the software. The systematic 69 | pattern of such abuse occurs in the area of products for individuals to 70 | use, which is precisely where it is most unacceptable. Therefore, we 71 | have designed this version of the GPL to prohibit the practice for those 72 | products. If such problems arise substantially in other domains, we 73 | stand ready to extend this provision to those domains in future versions 74 | of the GPL, as needed to protect the freedom of users. 75 | 76 | Finally, every program is threatened constantly by software patents. 77 | States should not allow patents to restrict development and use of 78 | software on general-purpose computers, but in those that do, we wish to 79 | avoid the special danger that patents applied to a free program could 80 | make it effectively proprietary. To prevent this, the GPL assures that 81 | patents cannot be used to render the program non-free. 82 | 83 | The precise terms and conditions for copying, distribution and 84 | modification follow. 85 | 86 | TERMS AND CONDITIONS 87 | 88 | 0. Definitions. 89 | 90 | "This License" refers to version 3 of the GNU General Public License. 91 | 92 | "Copyright" also means copyright-like laws that apply to other kinds of 93 | works, such as semiconductor masks. 94 | 95 | "The Program" refers to any copyrightable work licensed under this 96 | License. Each licensee is addressed as "you". "Licensees" and 97 | "recipients" may be individuals or organizations. 98 | 99 | To "modify" a work means to copy from or adapt all or part of the work 100 | in a fashion requiring copyright permission, other than the making of an 101 | exact copy. The resulting work is called a "modified version" of the 102 | earlier work or a work "based on" the earlier work. 103 | 104 | A "covered work" means either the unmodified Program or a work based 105 | on the Program. 106 | 107 | To "propagate" a work means to do anything with it that, without 108 | permission, would make you directly or secondarily liable for 109 | infringement under applicable copyright law, except executing it on a 110 | computer or modifying a private copy. Propagation includes copying, 111 | distribution (with or without modification), making available to the 112 | public, and in some countries other activities as well. 113 | 114 | To "convey" a work means any kind of propagation that enables other 115 | parties to make or receive copies. Mere interaction with a user through 116 | a computer network, with no transfer of a copy, is not conveying. 117 | 118 | An interactive user interface displays "Appropriate Legal Notices" 119 | to the extent that it includes a convenient and prominently visible 120 | feature that (1) displays an appropriate copyright notice, and (2) 121 | tells the user that there is no warranty for the work (except to the 122 | extent that warranties are provided), that licensees may convey the 123 | work under this License, and how to view a copy of this License. If 124 | the interface presents a list of user commands or options, such as a 125 | menu, a prominent item in the list meets this criterion. 126 | 127 | 1. Source Code. 128 | 129 | The "source code" for a work means the preferred form of the work 130 | for making modifications to it. "Object code" means any non-source 131 | form of a work. 132 | 133 | A "Standard Interface" means an interface that either is an official 134 | standard defined by a recognized standards body, or, in the case of 135 | interfaces specified for a particular programming language, one that 136 | is widely used among developers working in that language. 137 | 138 | The "System Libraries" of an executable work include anything, other 139 | than the work as a whole, that (a) is included in the normal form of 140 | packaging a Major Component, but which is not part of that Major 141 | Component, and (b) serves only to enable use of the work with that 142 | Major Component, or to implement a Standard Interface for which an 143 | implementation is available to the public in source code form. A 144 | "Major Component", in this context, means a major essential component 145 | (kernel, window system, and so on) of the specific operating system 146 | (if any) on which the executable work runs, or a compiler used to 147 | produce the work, or an object code interpreter used to run it. 148 | 149 | The "Corresponding Source" for a work in object code form means all 150 | the source code needed to generate, install, and (for an executable 151 | work) run the object code and to modify the work, including scripts to 152 | control those activities. However, it does not include the work's 153 | System Libraries, or general-purpose tools or generally available free 154 | programs which are used unmodified in performing those activities but 155 | which are not part of the work. For example, Corresponding Source 156 | includes interface definition files associated with source files for 157 | the work, and the source code for shared libraries and dynamically 158 | linked subprograms that the work is specifically designed to require, 159 | such as by intimate data communication or control flow between those 160 | subprograms and other parts of the work. 161 | 162 | The Corresponding Source need not include anything that users 163 | can regenerate automatically from other parts of the Corresponding 164 | Source. 165 | 166 | The Corresponding Source for a work in source code form is that 167 | same work. 168 | 169 | 2. Basic Permissions. 170 | 171 | All rights granted under this License are granted for the term of 172 | copyright on the Program, and are irrevocable provided the stated 173 | conditions are met. This License explicitly affirms your unlimited 174 | permission to run the unmodified Program. The output from running a 175 | covered work is covered by this License only if the output, given its 176 | content, constitutes a covered work. This License acknowledges your 177 | rights of fair use or other equivalent, as provided by copyright law. 178 | 179 | You may make, run and propagate covered works that you do not 180 | convey, without conditions so long as your license otherwise remains 181 | in force. You may convey covered works to others for the sole purpose 182 | of having them make modifications exclusively for you, or provide you 183 | with facilities for running those works, provided that you comply with 184 | the terms of this License in conveying all material for which you do 185 | not control copyright. Those thus making or running the covered works 186 | for you must do so exclusively on your behalf, under your direction 187 | and control, on terms that prohibit them from making any copies of 188 | your copyrighted material outside their relationship with you. 189 | 190 | Conveying under any other circumstances is permitted solely under 191 | the conditions stated below. Sublicensing is not allowed; section 10 192 | makes it unnecessary. 193 | 194 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 195 | 196 | No covered work shall be deemed part of an effective technological 197 | measure under any applicable law fulfilling obligations under article 198 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 199 | similar laws prohibiting or restricting circumvention of such 200 | measures. 201 | 202 | When you convey a covered work, you waive any legal power to forbid 203 | circumvention of technological measures to the extent such circumvention 204 | is effected by exercising rights under this License with respect to 205 | the covered work, and you disclaim any intention to limit operation or 206 | modification of the work as a means of enforcing, against the work's 207 | users, your or third parties' legal rights to forbid circumvention of 208 | technological measures. 209 | 210 | 4. Conveying Verbatim Copies. 211 | 212 | You may convey verbatim copies of the Program's source code as you 213 | receive it, in any medium, provided that you conspicuously and 214 | appropriately publish on each copy an appropriate copyright notice; 215 | keep intact all notices stating that this License and any 216 | non-permissive terms added in accord with section 7 apply to the code; 217 | keep intact all notices of the absence of any warranty; and give all 218 | recipients a copy of this License along with the Program. 219 | 220 | You may charge any price or no price for each copy that you convey, 221 | and you may offer support or warranty protection for a fee. 222 | 223 | 5. Conveying Modified Source Versions. 224 | 225 | You may convey a work based on the Program, or the modifications to 226 | produce it from the Program, in the form of source code under the 227 | terms of section 4, provided that you also meet all of these conditions: 228 | 229 | a) The work must carry prominent notices stating that you modified 230 | it, and giving a relevant date. 231 | 232 | b) The work must carry prominent notices stating that it is 233 | released under this License and any conditions added under section 234 | 7. This requirement modifies the requirement in section 4 to 235 | "keep intact all notices". 236 | 237 | c) You must license the entire work, as a whole, under this 238 | License to anyone who comes into possession of a copy. This 239 | License will therefore apply, along with any applicable section 7 240 | additional terms, to the whole of the work, and all its parts, 241 | regardless of how they are packaged. This License gives no 242 | permission to license the work in any other way, but it does not 243 | invalidate such permission if you have separately received it. 244 | 245 | d) If the work has interactive user interfaces, each must display 246 | Appropriate Legal Notices; however, if the Program has interactive 247 | interfaces that do not display Appropriate Legal Notices, your 248 | work need not make them do so. 249 | 250 | A compilation of a covered work with other separate and independent 251 | works, which are not by their nature extensions of the covered work, 252 | and which are not combined with it such as to form a larger program, 253 | in or on a volume of a storage or distribution medium, is called an 254 | "aggregate" if the compilation and its resulting copyright are not 255 | used to limit the access or legal rights of the compilation's users 256 | beyond what the individual works permit. Inclusion of a covered work 257 | in an aggregate does not cause this License to apply to the other 258 | parts of the aggregate. 259 | 260 | 6. Conveying Non-Source Forms. 261 | 262 | You may convey a covered work in object code form under the terms 263 | of sections 4 and 5, provided that you also convey the 264 | machine-readable Corresponding Source under the terms of this License, 265 | in one of these ways: 266 | 267 | a) Convey the object code in, or embodied in, a physical product 268 | (including a physical distribution medium), accompanied by the 269 | Corresponding Source fixed on a durable physical medium 270 | customarily used for software interchange. 271 | 272 | b) Convey the object code in, or embodied in, a physical product 273 | (including a physical distribution medium), accompanied by a 274 | written offer, valid for at least three years and valid for as 275 | long as you offer spare parts or customer support for that product 276 | model, to give anyone who possesses the object code either (1) a 277 | copy of the Corresponding Source for all the software in the 278 | product that is covered by this License, on a durable physical 279 | medium customarily used for software interchange, for a price no 280 | more than your reasonable cost of physically performing this 281 | conveying of source, or (2) access to copy the 282 | Corresponding Source from a network server at no charge. 283 | 284 | c) Convey individual copies of the object code with a copy of the 285 | written offer to provide the Corresponding Source. This 286 | alternative is allowed only occasionally and noncommercially, and 287 | only if you received the object code with such an offer, in accord 288 | with subsection 6b. 289 | 290 | d) Convey the object code by offering access from a designated 291 | place (gratis or for a charge), and offer equivalent access to the 292 | Corresponding Source in the same way through the same place at no 293 | further charge. You need not require recipients to copy the 294 | Corresponding Source along with the object code. If the place to 295 | copy the object code is a network server, the Corresponding Source 296 | may be on a different server (operated by you or a third party) 297 | that supports equivalent copying facilities, provided you maintain 298 | clear directions next to the object code saying where to find the 299 | Corresponding Source. Regardless of what server hosts the 300 | Corresponding Source, you remain obligated to ensure that it is 301 | available for as long as needed to satisfy these requirements. 302 | 303 | e) Convey the object code using peer-to-peer transmission, provided 304 | you inform other peers where the object code and Corresponding 305 | Source of the work are being offered to the general public at no 306 | charge under subsection 6d. 307 | 308 | A separable portion of the object code, whose source code is excluded 309 | from the Corresponding Source as a System Library, need not be 310 | included in conveying the object code work. 311 | 312 | A "User Product" is either (1) a "consumer product", which means any 313 | tangible personal property which is normally used for personal, family, 314 | or household purposes, or (2) anything designed or sold for incorporation 315 | into a dwelling. In determining whether a product is a consumer product, 316 | doubtful cases shall be resolved in favor of coverage. For a particular 317 | product received by a particular user, "normally used" refers to a 318 | typical or common use of that class of product, regardless of the status 319 | of the particular user or of the way in which the particular user 320 | actually uses, or expects or is expected to use, the product. A product 321 | is a consumer product regardless of whether the product has substantial 322 | commercial, industrial or non-consumer uses, unless such uses represent 323 | the only significant mode of use of the product. 324 | 325 | "Installation Information" for a User Product means any methods, 326 | procedures, authorization keys, or other information required to install 327 | and execute modified versions of a covered work in that User Product from 328 | a modified version of its Corresponding Source. The information must 329 | suffice to ensure that the continued functioning of the modified object 330 | code is in no case prevented or interfered with solely because 331 | modification has been made. 332 | 333 | If you convey an object code work under this section in, or with, or 334 | specifically for use in, a User Product, and the conveying occurs as 335 | part of a transaction in which the right of possession and use of the 336 | User Product is transferred to the recipient in perpetuity or for a 337 | fixed term (regardless of how the transaction is characterized), the 338 | Corresponding Source conveyed under this section must be accompanied 339 | by the Installation Information. But this requirement does not apply 340 | if neither you nor any third party retains the ability to install 341 | modified object code on the User Product (for example, the work has 342 | been installed in ROM). 343 | 344 | The requirement to provide Installation Information does not include a 345 | requirement to continue to provide support service, warranty, or updates 346 | for a work that has been modified or installed by the recipient, or for 347 | the User Product in which it has been modified or installed. Access to a 348 | network may be denied when the modification itself materially and 349 | adversely affects the operation of the network or violates the rules and 350 | protocols for communication across the network. 351 | 352 | Corresponding Source conveyed, and Installation Information provided, 353 | in accord with this section must be in a format that is publicly 354 | documented (and with an implementation available to the public in 355 | source code form), and must require no special password or key for 356 | unpacking, reading or copying. 357 | 358 | 7. Additional Terms. 359 | 360 | "Additional permissions" are terms that supplement the terms of this 361 | License by making exceptions from one or more of its conditions. 362 | Additional permissions that are applicable to the entire Program shall 363 | be treated as though they were included in this License, to the extent 364 | that they are valid under applicable law. If additional permissions 365 | apply only to part of the Program, that part may be used separately 366 | under those permissions, but the entire Program remains governed by 367 | this License without regard to the additional permissions. 368 | 369 | When you convey a copy of a covered work, you may at your option 370 | remove any additional permissions from that copy, or from any part of 371 | it. (Additional permissions may be written to require their own 372 | removal in certain cases when you modify the work.) You may place 373 | additional permissions on material, added by you to a covered work, 374 | for which you have or can give appropriate copyright permission. 375 | 376 | Notwithstanding any other provision of this License, for material you 377 | add to a covered work, you may (if authorized by the copyright holders of 378 | that material) supplement the terms of this License with terms: 379 | 380 | a) Disclaiming warranty or limiting liability differently from the 381 | terms of sections 15 and 16 of this License; or 382 | 383 | b) Requiring preservation of specified reasonable legal notices or 384 | author attributions in that material or in the Appropriate Legal 385 | Notices displayed by works containing it; or 386 | 387 | c) Prohibiting misrepresentation of the origin of that material, or 388 | requiring that modified versions of such material be marked in 389 | reasonable ways as different from the original version; or 390 | 391 | d) Limiting the use for publicity purposes of names of licensors or 392 | authors of the material; or 393 | 394 | e) Declining to grant rights under trademark law for use of some 395 | trade names, trademarks, or service marks; or 396 | 397 | f) Requiring indemnification of licensors and authors of that 398 | material by anyone who conveys the material (or modified versions of 399 | it) with contractual assumptions of liability to the recipient, for 400 | any liability that these contractual assumptions directly impose on 401 | those licensors and authors. 402 | 403 | All other non-permissive additional terms are considered "further 404 | restrictions" within the meaning of section 10. If the Program as you 405 | received it, or any part of it, contains a notice stating that it is 406 | governed by this License along with a term that is a further 407 | restriction, you may remove that term. If a license document contains 408 | a further restriction but permits relicensing or conveying under this 409 | License, you may add to a covered work material governed by the terms 410 | of that license document, provided that the further restriction does 411 | not survive such relicensing or conveying. 412 | 413 | If you add terms to a covered work in accord with this section, you 414 | must place, in the relevant source files, a statement of the 415 | additional terms that apply to those files, or a notice indicating 416 | where to find the applicable terms. 417 | 418 | Additional terms, permissive or non-permissive, may be stated in the 419 | form of a separately written license, or stated as exceptions; 420 | the above requirements apply either way. 421 | 422 | 8. Termination. 423 | 424 | You may not propagate or modify a covered work except as expressly 425 | provided under this License. Any attempt otherwise to propagate or 426 | modify it is void, and will automatically terminate your rights under 427 | this License (including any patent licenses granted under the third 428 | paragraph of section 11). 429 | 430 | However, if you cease all violation of this License, then your 431 | license from a particular copyright holder is reinstated (a) 432 | provisionally, unless and until the copyright holder explicitly and 433 | finally terminates your license, and (b) permanently, if the copyright 434 | holder fails to notify you of the violation by some reasonable means 435 | prior to 60 days after the cessation. 436 | 437 | Moreover, your license from a particular copyright holder is 438 | reinstated permanently if the copyright holder notifies you of the 439 | violation by some reasonable means, this is the first time you have 440 | received notice of violation of this License (for any work) from that 441 | copyright holder, and you cure the violation prior to 30 days after 442 | your receipt of the notice. 443 | 444 | Termination of your rights under this section does not terminate the 445 | licenses of parties who have received copies or rights from you under 446 | this License. If your rights have been terminated and not permanently 447 | reinstated, you do not qualify to receive new licenses for the same 448 | material under section 10. 449 | 450 | 9. Acceptance Not Required for Having Copies. 451 | 452 | You are not required to accept this License in order to receive or 453 | run a copy of the Program. Ancillary propagation of a covered work 454 | occurring solely as a consequence of using peer-to-peer transmission 455 | to receive a copy likewise does not require acceptance. However, 456 | nothing other than this License grants you permission to propagate or 457 | modify any covered work. These actions infringe copyright if you do 458 | not accept this License. Therefore, by modifying or propagating a 459 | covered work, you indicate your acceptance of this License to do so. 460 | 461 | 10. Automatic Licensing of Downstream Recipients. 462 | 463 | Each time you convey a covered work, the recipient automatically 464 | receives a license from the original licensors, to run, modify and 465 | propagate that work, subject to this License. You are not responsible 466 | for enforcing compliance by third parties with this License. 467 | 468 | An "entity transaction" is a transaction transferring control of an 469 | organization, or substantially all assets of one, or subdividing an 470 | organization, or merging organizations. If propagation of a covered 471 | work results from an entity transaction, each party to that 472 | transaction who receives a copy of the work also receives whatever 473 | licenses to the work the party's predecessor in interest had or could 474 | give under the previous paragraph, plus a right to possession of the 475 | Corresponding Source of the work from the predecessor in interest, if 476 | the predecessor has it or can get it with reasonable efforts. 477 | 478 | You may not impose any further restrictions on the exercise of the 479 | rights granted or affirmed under this License. For example, you may 480 | not impose a license fee, royalty, or other charge for exercise of 481 | rights granted under this License, and you may not initiate litigation 482 | (including a cross-claim or counterclaim in a lawsuit) alleging that 483 | any patent claim is infringed by making, using, selling, offering for 484 | sale, or importing the Program or any portion of it. 485 | 486 | 11. Patents. 487 | 488 | A "contributor" is a copyright holder who authorizes use under this 489 | License of the Program or a work on which the Program is based. The 490 | work thus licensed is called the contributor's "contributor version". 491 | 492 | A contributor's "essential patent claims" are all patent claims 493 | owned or controlled by the contributor, whether already acquired or 494 | hereafter acquired, that would be infringed by some manner, permitted 495 | by this License, of making, using, or selling its contributor version, 496 | but do not include claims that would be infringed only as a 497 | consequence of further modification of the contributor version. For 498 | purposes of this definition, "control" includes the right to grant 499 | patent sublicenses in a manner consistent with the requirements of 500 | this License. 501 | 502 | Each contributor grants you a non-exclusive, worldwide, royalty-free 503 | patent license under the contributor's essential patent claims, to 504 | make, use, sell, offer for sale, import and otherwise run, modify and 505 | propagate the contents of its contributor version. 506 | 507 | In the following three paragraphs, a "patent license" is any express 508 | agreement or commitment, however denominated, not to enforce a patent 509 | (such as an express permission to practice a patent or covenant not to 510 | sue for patent infringement). To "grant" such a patent license to a 511 | party means to make such an agreement or commitment not to enforce a 512 | patent against the party. 513 | 514 | If you convey a covered work, knowingly relying on a patent license, 515 | and the Corresponding Source of the work is not available for anyone 516 | to copy, free of charge and under the terms of this License, through a 517 | publicly available network server or other readily accessible means, 518 | then you must either (1) cause the Corresponding Source to be so 519 | available, or (2) arrange to deprive yourself of the benefit of the 520 | patent license for this particular work, or (3) arrange, in a manner 521 | consistent with the requirements of this License, to extend the patent 522 | license to downstream recipients. "Knowingly relying" means you have 523 | actual knowledge that, but for the patent license, your conveying the 524 | covered work in a country, or your recipient's use of the covered work 525 | in a country, would infringe one or more identifiable patents in that 526 | country that you have reason to believe are valid. 527 | 528 | If, pursuant to or in connection with a single transaction or 529 | arrangement, you convey, or propagate by procuring conveyance of, a 530 | covered work, and grant a patent license to some of the parties 531 | receiving the covered work authorizing them to use, propagate, modify 532 | or convey a specific copy of the covered work, then the patent license 533 | you grant is automatically extended to all recipients of the covered 534 | work and works based on it. 535 | 536 | A patent license is "discriminatory" if it does not include within 537 | the scope of its coverage, prohibits the exercise of, or is 538 | conditioned on the non-exercise of one or more of the rights that are 539 | specifically granted under this License. You may not convey a covered 540 | work if you are a party to an arrangement with a third party that is 541 | in the business of distributing software, under which you make payment 542 | to the third party based on the extent of your activity of conveying 543 | the work, and under which the third party grants, to any of the 544 | parties who would receive the covered work from you, a discriminatory 545 | patent license (a) in connection with copies of the covered work 546 | conveyed by you (or copies made from those copies), or (b) primarily 547 | for and in connection with specific products or compilations that 548 | contain the covered work, unless you entered into that arrangement, 549 | or that patent license was granted, prior to 28 March 2007. 550 | 551 | Nothing in this License shall be construed as excluding or limiting 552 | any implied license or other defenses to infringement that may 553 | otherwise be available to you under applicable patent law. 554 | 555 | 12. No Surrender of Others' Freedom. 556 | 557 | If conditions are imposed on you (whether by court order, agreement or 558 | otherwise) that contradict the conditions of this License, they do not 559 | excuse you from the conditions of this License. If you cannot convey a 560 | covered work so as to satisfy simultaneously your obligations under this 561 | License and any other pertinent obligations, then as a consequence you may 562 | not convey it at all. For example, if you agree to terms that obligate you 563 | to collect a royalty for further conveying from those to whom you convey 564 | the Program, the only way you could satisfy both those terms and this 565 | License would be to refrain entirely from conveying the Program. 566 | 567 | 13. Use with the GNU Affero General Public License. 568 | 569 | Notwithstanding any other provision of this License, you have 570 | permission to link or combine any covered work with a work licensed 571 | under version 3 of the GNU Affero General Public License into a single 572 | combined work, and to convey the resulting work. The terms of this 573 | License will continue to apply to the part which is the covered work, 574 | but the special requirements of the GNU Affero General Public License, 575 | section 13, concerning interaction through a network will apply to the 576 | combination as such. 577 | 578 | 14. Revised Versions of this License. 579 | 580 | The Free Software Foundation may publish revised and/or new versions of 581 | the GNU General Public License from time to time. Such new versions will 582 | be similar in spirit to the present version, but may differ in detail to 583 | address new problems or concerns. 584 | 585 | Each version is given a distinguishing version number. If the 586 | Program specifies that a certain numbered version of the GNU General 587 | Public License "or any later version" applies to it, you have the 588 | option of following the terms and conditions either of that numbered 589 | version or of any later version published by the Free Software 590 | Foundation. If the Program does not specify a version number of the 591 | GNU General Public License, you may choose any version ever published 592 | by the Free Software Foundation. 593 | 594 | If the Program specifies that a proxy can decide which future 595 | versions of the GNU General Public License can be used, that proxy's 596 | public statement of acceptance of a version permanently authorizes you 597 | to choose that version for the Program. 598 | 599 | Later license versions may give you additional or different 600 | permissions. However, no additional obligations are imposed on any 601 | author or copyright holder as a result of your choosing to follow a 602 | later version. 603 | 604 | 15. Disclaimer of Warranty. 605 | 606 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 607 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 608 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 609 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 610 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 611 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 612 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 613 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 614 | 615 | 16. Limitation of Liability. 616 | 617 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 618 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 619 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 620 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 621 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 622 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 623 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 624 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 625 | SUCH DAMAGES. 626 | 627 | 17. Interpretation of Sections 15 and 16. 628 | 629 | If the disclaimer of warranty and limitation of liability provided 630 | above cannot be given local legal effect according to their terms, 631 | reviewing courts shall apply local law that most closely approximates 632 | an absolute waiver of all civil liability in connection with the 633 | Program, unless a warranty or assumption of liability accompanies a 634 | copy of the Program in return for a fee. 635 | 636 | END OF TERMS AND CONDITIONS 637 | 638 | How to Apply These Terms to Your New Programs 639 | 640 | If you develop a new program, and you want it to be of the greatest 641 | possible use to the public, the best way to achieve this is to make it 642 | free software which everyone can redistribute and change under these terms. 643 | 644 | To do so, attach the following notices to the program. It is safest 645 | to attach them to the start of each source file to most effectively 646 | state the exclusion of warranty; and each file should have at least 647 | the "copyright" line and a pointer to where the full notice is found. 648 | 649 | 650 | Copyright (C) 651 | 652 | This program is free software: you can redistribute it and/or modify 653 | it under the terms of the GNU General Public License as published by 654 | the Free Software Foundation, either version 3 of the License, or 655 | (at your option) any later version. 656 | 657 | This program is distributed in the hope that it will be useful, 658 | but WITHOUT ANY WARRANTY; without even the implied warranty of 659 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 660 | GNU General Public License for more details. 661 | 662 | You should have received a copy of the GNU General Public License 663 | along with this program. If not, see . 664 | 665 | Also add information on how to contact you by electronic and paper mail. 666 | 667 | If the program does terminal interaction, make it output a short 668 | notice like this when it starts in an interactive mode: 669 | 670 | Copyright (C) 671 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 672 | This is free software, and you are welcome to redistribute it 673 | under certain conditions; type `show c' for details. 674 | 675 | The hypothetical commands `show w' and `show c' should show the appropriate 676 | parts of the General Public License. Of course, your program's commands 677 | might be different; for a GUI interface, you would use an "about box". 678 | 679 | You should also get your employer (if you work as a programmer) or school, 680 | if any, to sign a "copyright disclaimer" for the program, if necessary. 681 | For more information on this, and how to apply and follow the GNU GPL, see 682 | . 683 | 684 | The GNU General Public License does not permit incorporating your program 685 | into proprietary programs. If your program is a subroutine library, you 686 | may consider it more useful to permit linking proprietary applications with 687 | the library. If this is what you want to do, use the GNU Lesser General 688 | Public License instead of this License. But first, please read 689 | . 690 | --------------------------------------------------------------------------------