├── .gitignore ├── .vscodeignore ├── tsconfig.json ├── .vscode ├── settings.json ├── tasks.json └── launch.json ├── test ├── extension.test.ts └── index.ts ├── CHANGELOG.md ├── src ├── Config.ts └── extension.ts ├── README.md ├── package.json └── LICENSE.txt /.gitignore: -------------------------------------------------------------------------------- 1 | out 2 | node_modules -------------------------------------------------------------------------------- /.vscodeignore: -------------------------------------------------------------------------------- 1 | .vscode/** 2 | .vscode-test/** 3 | out/test/** 4 | test/** 5 | src/** 6 | **/*.map 7 | .gitignore 8 | tsconfig.json 9 | vsc-extension-quickstart.md 10 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "module": "commonjs", 4 | "target": "es6", 5 | "outDir": "out", 6 | "lib": [ 7 | "es6" 8 | ], 9 | "sourceMap": true, 10 | "rootDir": "." 11 | }, 12 | "exclude": [ 13 | "node_modules", 14 | ".vscode-test" 15 | ] 16 | } -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | // Place your settings in this file to overwrite default and user settings. 2 | { 3 | "files.exclude": { 4 | "out": false // set this to true to hide the "out" folder with the compiled JS files 5 | }, 6 | "search.exclude": { 7 | "out": true // set this to false to include "out" folder in search results 8 | }, 9 | "typescript.tsdk": "./node_modules/typescript/lib" // we want to use the TS server from our node_modules folder to control its version 10 | } -------------------------------------------------------------------------------- /test/extension.test.ts: -------------------------------------------------------------------------------- 1 | // 2 | // Note: This example test is leveraging the Mocha test framework. 3 | // Please refer to their documentation on https://mochajs.org/ for help. 4 | // 5 | 6 | // The module 'assert' provides assertion methods from node 7 | //import * as assert from 'assert'; 8 | 9 | // You can import and use all API from the 'vscode' module 10 | // as well as import your extension to test it 11 | //import * as vscode from 'vscode'; 12 | //import * as myExtension from '../src/extension'; 13 | 14 | // Defines a Mocha test suite to group tests of similar kind together 15 | //suite("Extension Tests", () => { 16 | // 17 | // // Defines a Mocha unit test 18 | // test("Something 1", () => { 19 | // assert.equal(-1, [1, 2, 3].indexOf(5)); 20 | // assert.equal(-1, [1, 2, 3].indexOf(0)); 21 | // }); 22 | //}); -------------------------------------------------------------------------------- /test/index.ts: -------------------------------------------------------------------------------- 1 | // 2 | // PLEASE DO NOT MODIFY / DELETE UNLESS YOU KNOW WHAT YOU ARE DOING 3 | // 4 | // This file is providing the test runner to use when running extension tests. 5 | // By default the test runner in use is Mocha based. 6 | // 7 | // You can provide your own test runner if you want to override it by exporting 8 | // a function run(testRoot: string, clb: (error:Error) => void) that the extension 9 | // host can call to run the tests. The test runner is expected to use console.log 10 | // to report the results back to the caller. When the tests are finished, return 11 | // a possible error to the callback or null if none. 12 | 13 | var testRunner = require('vscode/lib/testrunner'); 14 | 15 | // You can directly control Mocha options by uncommenting the following lines 16 | // See https://github.com/mochajs/mocha/wiki/Using-mocha-programmatically#set-options for more info 17 | testRunner.configure({ 18 | ui: 'tdd', // the TDD UI is being used in extension.test.ts (suite, test, etc.) 19 | useColors: true // colored output from test results 20 | }); 21 | 22 | module.exports = testRunner; -------------------------------------------------------------------------------- /.vscode/tasks.json: -------------------------------------------------------------------------------- 1 | // Available variables which can be used inside of strings. 2 | // ${workspaceRoot}: the root folder of the team 3 | // ${file}: the current opened file 4 | // ${fileBasename}: the current opened file's basename 5 | // ${fileDirname}: the current opened file's dirname 6 | // ${fileExtname}: the current opened file's extension 7 | // ${cwd}: the current working directory of the spawned process 8 | 9 | // A task runner that calls a custom npm script that compiles the extension. 10 | { 11 | "version": "0.1.0", 12 | 13 | // we want to run npm 14 | "command": "npm", 15 | 16 | // the command is a shell script 17 | "isShellCommand": true, 18 | 19 | // show the output window only if unrecognized errors occur. 20 | "showOutput": "silent", 21 | 22 | // we run the custom script "compile" as defined in package.json 23 | "args": ["run", "compile", "--loglevel", "silent"], 24 | 25 | // The tsc compiler is started in watching mode 26 | "isWatching": true, 27 | 28 | // use the standard tsc in watch mode problem matcher to find compile problems in the output. 29 | "problemMatcher": "$tsc-watch" 30 | } -------------------------------------------------------------------------------- /.vscode/launch.json: -------------------------------------------------------------------------------- 1 | // A launch configuration that compiles the extension and then opens it inside a new window 2 | { 3 | "version": "0.1.0", 4 | "configurations": [ 5 | { 6 | "name": "Launch Extension", 7 | "type": "extensionHost", 8 | "request": "launch", 9 | "runtimeExecutable": "${execPath}", 10 | "args": ["--extensionDevelopmentPath=${workspaceRoot}","C:\\Users\\joe\\Documents\\Test" ], 11 | "stopOnEntry": false, 12 | "sourceMaps": true, 13 | "outFiles": [ "${workspaceRoot}/out/src/**/*.js" ], 14 | "preLaunchTask": "npm" 15 | }, 16 | { 17 | "name": "Launch Tests", 18 | "type": "extensionHost", 19 | "request": "launch", 20 | "runtimeExecutable": "${execPath}", 21 | "args": ["--extensionDevelopmentPath=${workspaceRoot}", "--extensionTestsPath=${workspaceRoot}/out/test" ], 22 | "stopOnEntry": false, 23 | "sourceMaps": true, 24 | "outFiles": [ "${workspaceRoot}/out/test/**/*.js" ], 25 | "preLaunchTask": "npm" 26 | } 27 | ] 28 | } 29 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Change Log 2 | All notable changes to the "sync-rsync" extension will be documented in this file. 3 | 4 | Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file. 5 | 6 | ## Change Log 7 | 8 | ### 0.35 9 | 10 | Added: preSyncUp, postSyncUp, preSyncDown, postSyncDown 11 | 12 | ### 0.34.8 13 | 14 | Ignore git:// files 15 | 16 | ### 0.34.7 17 | 18 | Refactored variable expansion 19 | 20 | ### 0.34.6 21 | 22 | Moved translate to after variable expansion 23 | 24 | ### 0.34.5 25 | 26 | Fix for wls and cygwin path translate 27 | 28 | ### 0.34.4 29 | 30 | Fix for util.promisify not being present in older VSCode 31 | 32 | ### 0.34.3 33 | 34 | Fix for breaking cygwin 35 | 36 | ### 0.34.2 37 | 38 | removed skip localPaths that do not exist 39 | 40 | Could not do reliably with cygwin, wls, linux, and mac os 41 | 42 | ### 0.34.1 43 | 44 | Fix for when using cygwin 45 | 46 | ### 0.34.0 47 | 48 | Context Menus for sync 49 | 50 | ### 0.33.0 51 | 52 | skip localPaths that do not exist 53 | 54 | ### 0.32.0 55 | 56 | automatically add trailing / 57 | 58 | ### 0.31.0 59 | 60 | replace `${workspaceRoot}` in options 61 | 62 | ### 0.30.0 63 | 64 | `Sync-Rsync: Sync Local to Remote (Single)` 65 | 66 | `Sync-Rsync: Sync Remote to local (Single)` 67 | 68 | `upOnly`: this site only sync Local to Remote. 69 | 70 | `downOnly`: this site only sync Remote to Local. 71 | 72 | ### 0.29.0 73 | 74 | `sync-rsync.useWSL`: Use WSL for executing rsync. See [Windows Notes](#windows-notes) 75 | 76 | ### 0.28.0 77 | 78 | `sync-rsync.autoLoadIndividual` : do rsync on load to ensure the last file is available locally (defaults to false). 79 | 80 | `sync-rsync.showProgress` : show progress during rsync (defaults to true). 81 | 82 | ### 0.27.1 83 | 84 | `sync-rsync.autoShowOutputOnError` 85 | 86 | ### 0.27.0 87 | 88 | `sync-rsync.include` 89 | 90 | `sync-rsync.args` 91 | 92 | ### 0.26.0 93 | 94 | Added notification option 95 | 96 | ### 0.25.0 97 | 98 | Possible breaking changes 99 | Imporoved Cygwin and WSL support thanks @idanpa. 100 | 101 | ### 0.24.0 102 | 103 | Add support for workspaceFolder and workspaceFolderBasename 104 | 105 | ### 0.23.0 106 | 107 | `sync-rsync.watchGlobs` 108 | 109 | ### 0.22.0 110 | 111 | cygpath option and fix issue #33 112 | 113 | ### 0.21.0 114 | 115 | executable option. 116 | 117 | Should fix problems on windows. 118 | 119 | ### 0.20.0 120 | 121 | onSaveIndividual 122 | 123 | ### 0.19.0 124 | 125 | onSaveIndividual 126 | 127 | ### 0.18.2 128 | 129 | fix error in remote replace code 130 | 131 | ### 0.18.1 132 | 133 | commands fix 134 | 135 | ### 0.18.0 136 | 137 | Extra rsync options 138 | 139 | ### 0.17.0 140 | 141 | Replace of ${workspaceRoot} 142 | 143 | ### 0.16.1 144 | 145 | Kill running sync 146 | 147 | ### 0.15.0 148 | 149 | Multisite support 150 | 151 | ### 0.14.0 152 | 153 | Minor color scheme change 154 | 155 | ### 0.13.0 156 | 157 | Lots of minor updates thanks to https://github.com/leshniak 158 | 159 | ### 0.12.0 160 | 161 | added sync-rsync.autoShowOutput 162 | 163 | ### 0.11.5 164 | 165 | revert breaking changes 166 | 167 | ### 0.10.0 168 | 169 | local in config 170 | 171 | ### 0.9.3 172 | 173 | readme fix 174 | 175 | ### 0.9.2 176 | 177 | path seperator fix 178 | 179 | ### 0.9.0 180 | 181 | chmod option 182 | 183 | ### 0.8.0 184 | 185 | shell option 186 | 187 | ### 0.7.0 188 | 189 | Auto hide rsync output when rsync is done 190 | 191 | 192 | ### 0.6.1 193 | 194 | Upgraded rsync library 195 | 196 | ### 0.6.0 197 | 198 | Sync on save 199 | 200 | ### 0.5.1 201 | 202 | Exclude patterns 203 | 204 | ### 0.4.1 205 | 206 | Added ability to delete and specify flags 207 | 208 | ### 0.1.0 209 | 210 | Initial release 211 | -------------------------------------------------------------------------------- /src/Config.ts: -------------------------------------------------------------------------------- 1 | import { 2 | WorkspaceConfiguration, 3 | workspace 4 | } from 'vscode'; 5 | import * as path from 'path'; 6 | import * as child from 'child_process'; 7 | 8 | export class Site { 9 | 10 | constructor( 11 | public name: string, 12 | public upOnly: boolean, 13 | public downOnly: boolean, 14 | public localPath: string, 15 | public remotePath: string, 16 | public deleteFiles: boolean, 17 | public flags: string, 18 | public exclude: Array, 19 | public include: Array, 20 | public chmod: string, 21 | public shell: string, 22 | public executableShell: string, 23 | public executable: string, 24 | public afterSync: string[], 25 | public preSyncUp: string[], 26 | public postSyncUp: string[], 27 | public preSyncDown: string[], 28 | public postSyncDown: string[], 29 | public options: Array>, 30 | public args: Array 31 | ) {} 32 | 33 | } 34 | 35 | export class Config { 36 | notification: boolean; 37 | autoShowOutput: boolean; 38 | autoShowOutputOnError: boolean; 39 | autoHideOutput: boolean; 40 | onFileSave: boolean; 41 | onFileSaveIndividual: boolean; 42 | onFileLoadIndividual: boolean; 43 | showProgress: boolean; 44 | sites: Array; 45 | cygpath: string; 46 | watchGlobs: Array; 47 | useWSL: boolean; 48 | siteMap: Map; 49 | _workspaceFolder: string = workspace.rootPath ? workspace.rootPath : ""; 50 | _workspaceFolderBasename: string = workspace.rootPath ? path.basename(workspace.rootPath) : ""; 51 | 52 | constructor(config: WorkspaceConfiguration) { 53 | this.onFileSave = config.get('onSave', false); 54 | this.onFileSaveIndividual = config.get('onSaveIndividual', false); 55 | this.onFileLoadIndividual = config.get('onLoadIndividual', false); 56 | this.showProgress = config.get('showProgress', true); 57 | this.notification = config.get('notification', false); 58 | this.autoShowOutput = config.get('autoShowOutput', false); 59 | this.autoShowOutputOnError = config.get('autoShowOutputOnError', true); 60 | this.autoHideOutput = config.get('autoHideOutput', false); 61 | this.cygpath = config.get('cygpath', undefined); 62 | this.watchGlobs = config.get('watchGlobs', []); 63 | this.useWSL = config.get('useWSL', false); 64 | 65 | let site_default = new Site( 66 | config.get('name', null), 67 | false, 68 | false, 69 | config.get('local', null), 70 | config.get('remote', null), 71 | config.get('delete', false), 72 | config.get('flags', 'rlptzv'), 73 | config.get('exclude', ['.git', '.vscode']), 74 | config.get('include', []), 75 | config.get('chmod', undefined), 76 | config.get('shell', undefined), 77 | config.get('executableShell', undefined), 78 | config.get('executable', 'rsync'), 79 | undefined, 80 | undefined, 81 | undefined, 82 | undefined, 83 | undefined, 84 | config.get('options', []), 85 | config.get('args', []), 86 | ) 87 | 88 | let sites: Array = []; 89 | let config_sites: Array = config.get('sites', []); 90 | 91 | if(config_sites.length == 0) { 92 | sites.push(site_default); 93 | } else { 94 | for(let site of config_sites) { 95 | let clone = Object.assign({},site_default); 96 | clone = Object.assign(clone,site); 97 | sites.push(clone); 98 | } 99 | } 100 | 101 | let workspaceLocal = workspace.rootPath 102 | 103 | for(let site of sites) { 104 | if(site.localPath === null || site.localPath == "null") { 105 | site.localPath = workspaceLocal; 106 | } 107 | if(workspaceLocal != null) { 108 | site.localPath = this.expandVars(site.localPath) 109 | 110 | for(let i = 0; i < site.options.length; i ++) { 111 | const site_option = site.options[i]; 112 | for(let j = 0; j < site_option.length; j++ ) { 113 | site_option[j] = this.expandVars(site_option[j]); 114 | } 115 | } 116 | 117 | if(site.remotePath != null) { 118 | site.remotePath = this.expandVars(site.remotePath); 119 | } 120 | } 121 | 122 | site.localPath = this.translatePath(site.localPath); 123 | site.remotePath = this.translatePath(site.remotePath); 124 | 125 | if(undefined != site.localPath && site.localPath[site.localPath.length - 1] != '/') site.localPath += '/'; 126 | if(undefined != site.remotePath && site.remotePath[site.remotePath.length - 1] != '/') site.remotePath += '/'; 127 | } 128 | 129 | var siteMap = new Map(); 130 | 131 | for(let s of sites) { 132 | var s_key = s.name ? s.name : s.remotePath; 133 | siteMap.set(s_key,s); 134 | } 135 | 136 | this.siteMap = siteMap; 137 | 138 | this.sites = sites; 139 | } 140 | 141 | expandVars(path: string) { 142 | path = path.replace("${workspaceRoot}",this._workspaceFolder); 143 | path = path.replace("${workspaceFolder}",this._workspaceFolder); 144 | path = path.replace("${workspaceFolderBasename}",this._workspaceFolderBasename); 145 | return path; 146 | } 147 | 148 | translatePath(path: string): string { 149 | 150 | if(path == null) return null; 151 | 152 | if(path[0] == '/') return path; 153 | 154 | if(this.cygpath) { 155 | let rtn = child.spawnSync(this.cygpath, [path]); 156 | if(rtn.status != 0) { 157 | throw new Error("Path Tranlate Issue:" + rtn.stderr.toString()); 158 | } 159 | if(rtn.error) { 160 | throw rtn.error; 161 | } 162 | let s_rtn = rtn.stdout.toString(); 163 | s_rtn = s_rtn.trim(); 164 | return s_rtn; 165 | } 166 | 167 | if(this.useWSL) { 168 | let r_path = path.replace(/\\/g,"\\\\"); 169 | let rtn = child.spawnSync("wsl", ["wslpath", r_path]); 170 | if(rtn.status != 0) { 171 | throw new Error("Path Tranlate Issue:" + rtn.stderr.toString()); 172 | } 173 | if(rtn.error) { 174 | throw rtn.error; 175 | } 176 | let s_rtn = rtn.stdout.toString(); 177 | s_rtn = s_rtn.trim(); 178 | return s_rtn; 179 | } 180 | 181 | return path; 182 | } 183 | 184 | } 185 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # sync-rsync 2 | 3 | Basic sync using Rsync 4 | 5 | ## Features 6 | 7 | This extension syncs with a remote server using rsync 8 | 9 | With these commands: 10 | 11 | * `Sync-Rsync: Sync Local to Remote` 12 | * `Sync-Rsync: Sync Local to Remote (Single)` 13 | * `Sync-Rsync: Sync Remote to local` 14 | * `Sync-Rsync: Sync Remote to local (Single)` 15 | * `Sync-Rsync: Compare Local to Remote` (dry run) 16 | * `Sync-Rsync: Compare Remote to local` (dry run) 17 | * `Sync-Rsync: Kills the current sync` 18 | 19 | If no sync is running clicking the status bar item will show the output 20 | 21 | If a sync is running clicking the status bar item will kill the running sync, see [Windows Notes](#windows-notes) 22 | 23 | ## Requirements 24 | 25 | Rsync installed both locally and remotely 26 | 27 | If you are using wsl, wslpath maybe required. (Windows 10 1803 or higher). Or you can install this https://github.com/laurent22/wslpath/blob/master/wslpath which requires php. 28 | 29 | If using cygwin, cygpath maybe required. 30 | 31 | ## Extension Settings 32 | 33 | Overall Settings (all optional): 34 | 35 | * `sync-rsync.notification`: Show notifiactions for sync successes (failurers always show notifications) 36 | * `sync-rsync.autoShowOutput`: Auto show rsync output when rsync is working. 37 | * `sync-rsync.autoShowOutputOnError`: Auto show rsync output on error. 38 | * `sync-rsync.autoHideOutput`: Auto hide rsync output when rsync is done. 39 | * `sync-rsync.onSave`: syncs entire local on save. 40 | * `sync-rsync.onSaveIndividual`: syncs the changed file on save (onSave takes presedence). (note: rsync error 3 is ignored because it might be excluded). 41 | * `sync-rsync.onLoadIndividual`: syncs the opened file on load. (note: rsync error 3 is ignored because it might be excluded). 42 | * `sync-rsync.executableShell`: The executable shell to run rsync in (e.g. /bin/bash). 43 | * `sync-rsync.executable`: The rsync executeable (e.g. rsync, C:\cygwin64\bin\rsync.exe). 44 | * `sync-rsync.cygpath`: If using cygwin, this is the path to cygpath (e.g. C:\cygwin64\bin\cygpath.exe) used to translate windows paths to cywgin. 45 | * `sync-rsync.watchGlobs`: Enables file system watcher on given glob patterns (may cause high CPU usage - use carefuly). 46 | * `sync-rsync.useWSL`: Use WSL for executing rsync. See [Windows Notes](#windows-notes) 47 | 48 | Global site options (they will be used as the default for each site): 49 | 50 | * `sync-rsync.local`: the local location defaults to workspace. 51 | * `sync-rsync.remote`: the rsync remote location e.g. user@remote:path. 52 | * `sync-rsync.delete`: true or false if you want rsync to delete files. 53 | * `sync-rsync.flags`: rsync flags. 54 | * `sync-rsync.showProgress`: show progress during rsync, by adding ```--progress```. 55 | * `sync-rsync.exclude`: rsync exclude patterns e.g. [".git",".vscode"] (includes happen before excludes) See [Includes / Excludes](#includes--excludes). 56 | * `sync-rsync.include`: rsync exclude patterns e.g. ["*/","**/*.php] (includes happen before excludes) See [Includes / Excludes](#includes--excludes). 57 | * `sync-rsync.shell`: Rsync's -e option e.g. ssh -p 1234. 58 | * `sync-rsync.chmod`: Rsync's --chmod option. 59 | * `sync-rsync.options`: Array of extra rsync options, set each element using [rsync.set](https://github.com/mattijs/node-rsync#setoption-value). See [Extra Options](#extra-options). 60 | * `sync-rsync.args`: Array of extra arguments to append to rsync e.g. ```["--exclude=venv/", "--include=*/", "--include=**/*.py", "--exclude=*"]```. 61 | 62 | Sites (Completely Optional, If no sites are defined Sync Rsync creates one using defaults): 63 | 64 | * `sync-rsync.sites`: Multiple Site Support [Multiple Sites](#multiple-sites). 65 | 66 | ## Workspaces 67 | 68 | For workspaces you have to define ```localPath``` and ```remotePath``` for each folder you want synced. e.g. 69 | 70 | ```javascript 71 | { 72 | "folders": [ 73 | { 74 | "path": "/home/user/project/s1" 75 | }, 76 | { 77 | "path": "/home/user/projects/t2" 78 | } 79 | ], 80 | "settings": { 81 | "sync-rsync.sites": [ 82 | { 83 | "localPath": "/home/user/project/s1/", 84 | "remotePath": "user@server:/var/www/s1/" 85 | }, 86 | { 87 | "localPath": "/home/user/projects/t2/", 88 | "remotePath": "user@server:/var/www/s2/" 89 | } 90 | ] 91 | } 92 | } 93 | ``` 94 | 95 | ## Multiple Sites 96 | 97 | Sites have these options, they are all optional sync-rsync will use the defaults if they are not defined: 98 | 99 | * `name`: a Nickname for single site sync. 100 | * `upOnly`: this site only sync Local to Remote. 101 | * `downOnly`: this site only sync Remote to Local. 102 | * `localPath`: the local location defaults to workspace. 103 | * `remotePath`: the rsync remote location e.g. user@remote:path. 104 | * `deleteFiles`: true or false if you want rsync to delete files. 105 | * `flags`: rsync flags. 106 | * `exclude`: rsync exclude patterns e.g. [".git",".vscode"] (includes happen before excludes) See [Includes / Excludes](#includes--excludes). 107 | * `include`: rsync exclude patterns e.g. ["*/","**/*.php] (includes happen before excludes) See [Includes / Excludes](#includes--excludes). 108 | * `shell`: Rsync's -e option e.g. ssh -p 1234. 109 | * `preSyncUp`: a command to run before sync up (e.g. clear cache). First item in array is the command the rest are arguments. e.g. ['ssh','user@server','~/cr.sh']. 110 | * `postSyncUp`: a command to run after successful sync up (e.g. clear cache). First item in array is the command the rest are arguments. e.g. ['ssh','user@server','~/cr.sh']. 111 | * `preSyncDown`: a command to run before sync down (e.g. clear cache). First item in array is the command the rest are arguments. e.g. ['ssh','user@server','~/cr.sh']. 112 | * `postSyncDown`: a command to run after successful sync down (e.g. clear cache). First item in array is the command the rest are arguments. e.g. ['ssh','user@server','~/cr.sh']. 113 | * `chmod`: Rsync's --chmod option. 114 | * `options`: Array of extra rsync options, set each element using [rsync.set](https://github.com/mattijs/node-rsync#setoption-value). See [Extra Options](#extra-options). 115 | * `args`: Array of extra arguments to append to rsync e.g. ```["--exclude=venv/", "--include=*/", "--include=**/*.tpl", "--exclude=*"]```. 116 | 117 | localPath and remotePath will replace ${workspaceRoot} with the current Workspace Path 118 | 119 | Example : 120 | 121 | ```javascript 122 | { 123 | "sync-rsync.delete": true, 124 | "sync-rsync.sites": [ 125 | { 126 | "remotePath":"user1@server1:/path1/", // Sync sync-rsync.local to user1@server1:/path1/ using port 1234 127 | "shell":"ssh -p 1234" 128 | }, 129 | { 130 | "remotePath":"user2@server2:/path2/", // Sync sync-rsync.local to user2@server2:/path2/ 131 | }, 132 | { 133 | "localPath":"project/static/", 134 | "remotePath":"user3server3:/static/", // Sync project/static/ to user3@server3:/static/ 135 | } 136 | ] 137 | } 138 | ``` 139 | 140 | ## Extra Options 141 | 142 | The `options` array is an array of arrays [rsync.set](https://github.com/mattijs/node-rsync#setoption-value) is call with each array spread as paramamiters e.g: 143 | 144 | ```javascript 145 | 146 | "sync-rsync.options": [ 147 | ['progress'], 148 | ['exclude-from', '/path/to/exclude-file'], 149 | ['delete'], 150 | ] 151 | ``` 152 | 153 | ## Includes / Excludes 154 | 155 | Includes happen before Excludes, this is important because rsync handles a file based on first match, so for example to only upload php files: 156 | 157 | ```javascript 158 | { 159 | "sync-rsync.exclude":[ 160 | "*" 161 | ], 162 | "sync-rsync.include": [ 163 | "*/", 164 | "**/*.php" 165 | ], 166 | } 167 | ``` 168 | 169 | if you need more control use ```sync-rsync.args``` 170 | 171 | 172 | ## Windows Notes 173 | 174 | If using cywgin, `sync-rsync.cygpath` is needed for things like `onSaveIndividual` to work because cygwin uses diferent paths as windows. 175 | 176 | Here is as example config: 177 | 178 | ```javascript 179 | { 180 | "sync-rsync.executable": "/bin/rsync", 181 | "sync-rsync.shell": "/bin/ssh -p 2222", 182 | "sync-rsync.remote": "root@server:/root/test/", 183 | "sync-rsync.local": "c:\\Users\\root\\sync_test\\", 184 | "sync-rsync.onSaveIndividual": true, 185 | "sync-rsync.cygpath": "C:\\cygwin64\\bin\\cygpath.exe", 186 | "sync-rsync.executableShell": "C:\\cygwin64\\bin\\bash.exe" 187 | } 188 | ``` 189 | 190 | Here is and example config for WSL: 191 | 192 | ```javascript 193 | { 194 | "sync-rsync.remote": "root@server:/root/folder/", 195 | "sync-rsync.local": "/mnt/c/Users/root/folder/", 196 | "sync-rsync.useWSL": true 197 | } 198 | ``` 199 | 200 | ## Mac OS Notes 201 | 202 | If you are using the `shell` option to do something like `ssh -p 123` you will most likely have the set `sync-rsync.executableShell` to `/bin/bash` 203 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "sync-rsync", 3 | "displayName": "Sync-Rsync", 4 | "description": "Sync with remote using rsync", 5 | "version": "0.35", 6 | "publisher": "vscode-ext", 7 | "repository": { 8 | "type": "git", 9 | "url": "https://github.com/thisboyiscrazy/vscode-rsync" 10 | }, 11 | "engines": { 12 | "vscode": "^1.5.0" 13 | }, 14 | "categories": [ 15 | "Other" 16 | ], 17 | "activationEvents": [ 18 | "*" 19 | ], 20 | "main": "./out/src/extension", 21 | "contributes": { 22 | "commands": [ 23 | { 24 | "command": "sync-rsync.syncDown", 25 | "title": "Sync-Rsync: Sync Remote to Local" 26 | }, 27 | { 28 | "command": "sync-rsync.syncDownContext", 29 | "title": "Sync Remote to Local" 30 | }, 31 | { 32 | "command": "sync-rsync.syncDownSingle", 33 | "title": "Sync-Rsync: Sync Remote to Local (Single site)" 34 | }, 35 | { 36 | "command": "sync-rsync.syncUp", 37 | "title": "Sync-Rsync: Sync Local to Remote" 38 | }, 39 | { 40 | "command": "sync-rsync.syncUpContext", 41 | "title": "Sync Local to Remote" 42 | }, 43 | { 44 | "command": "sync-rsync.syncUpSingle", 45 | "title": "Sync-Rsync: Sync Local to Remote (Single site)" 46 | }, 47 | { 48 | "command": "sync-rsync.compareDown", 49 | "title": "Sync-Rsync: Compare Remote to Local" 50 | }, 51 | { 52 | "command": "sync-rsync.compareUp", 53 | "title": "Sync-Rsync: Compare Local to Remote" 54 | }, 55 | { 56 | "command": "sync-rsync.killSync", 57 | "title": "Sync-Rsync: Kills the current sync" 58 | } 59 | ], 60 | "menus": { 61 | "commandPalette": [ 62 | { 63 | "command": "sync-rsync.syncDownContext", 64 | "when": "false" 65 | }, 66 | { 67 | "command": "sync-rsync.syncUpContext", 68 | "when": "false" 69 | } 70 | ], 71 | "explorer/context": [ 72 | { 73 | "command": "sync-rsync.syncDownContext", 74 | "group": "2_workspace" 75 | }, 76 | { 77 | "command": "sync-rsync.syncUpContext", 78 | "group": "2_workspace" 79 | } 80 | ] 81 | }, 82 | "configuration": { 83 | "type": "object", 84 | "title": "Sync-Rsync configuration", 85 | "properties": { 86 | "sync-rsync.notification": { 87 | "type": "boolean", 88 | "default": false, 89 | "description": "Show notifications for sync" 90 | }, 91 | "sync-rsync.autoShowOutput": { 92 | "type": "boolean", 93 | "default": false, 94 | "description": "Auto show rsync output when rsync is working" 95 | }, 96 | "sync-rsync.autoShowOutputOnError": { 97 | "type": "boolean", 98 | "default": true, 99 | "description": "Auto show rsync output when rsync is working" 100 | }, 101 | "sync-rsync.autoHideOutput": { 102 | "type": "boolean", 103 | "default": false, 104 | "description": "Auto hide rsync output when rsync is done" 105 | }, 106 | "sync-rsync.onSave": { 107 | "type": "boolean", 108 | "default": false, 109 | "description": "Sync project on save" 110 | }, 111 | "sync-rsync.onSaveIndividual": { 112 | "type": "boolean", 113 | "default": false, 114 | "description": "Sync file on save" 115 | }, 116 | "sync-rsync.onLoadIndividual": { 117 | "type": "boolean", 118 | "default": false, 119 | "description": "Sync file on load" 120 | }, 121 | "sync-rsync.showProgress": { 122 | "type": "boolean", 123 | "default": true, 124 | "description": "Show progress during rsync" 125 | }, 126 | "sync-rsync.cygpath": { 127 | "type": "string", 128 | "description": "If using cygwin, optional path to cygpath" 129 | }, 130 | "sync-rsync.watchGlobs": { 131 | "type": "array", 132 | "default": [], 133 | "description": "Enables sync up on file system change for given glob patterns (use carefuly)", 134 | "items": { 135 | "type": "string", 136 | "title": "glob pattern" 137 | } 138 | }, 139 | "sync-rsync.executableShell": { 140 | "type": "string", 141 | "description": "The executable shell to run rsync in" 142 | }, 143 | "sync-rsync.executable": { 144 | "type": "string", 145 | "description": "The rsync executable", 146 | "default": "rsync" 147 | }, 148 | "sync-rsync.local": { 149 | "type": "string", 150 | "default": null, 151 | "description": "Local location defaults to workspace (must end in path separator)" 152 | }, 153 | "sync-rsync.remote": { 154 | "type": "string", 155 | "default": null, 156 | "description": "Remote location (user@host:path) (must end in path separator)" 157 | }, 158 | "sync-rsync.delete": { 159 | "type": "boolean", 160 | "default": false, 161 | "description": "Delete false during sync" 162 | }, 163 | "sync-rsync.flags": { 164 | "type": "string", 165 | "default": "rlptzv", 166 | "description": "Rsync flags" 167 | }, 168 | "sync-rsync.exclude": { 169 | "type": "array", 170 | "default": [ 171 | ".git", 172 | ".vscode" 173 | ], 174 | "description": "Rsync exclude patterns", 175 | "items": { 176 | "type": "string", 177 | "title": "rsync exclude pattern" 178 | } 179 | }, 180 | "sync-rsync.include": { 181 | "type": "array", 182 | "default": [], 183 | "description": "Rsync include patterns", 184 | "items": { 185 | "type": "string", 186 | "title": "rsync include pattern" 187 | } 188 | }, 189 | "sync-rsync.chmod": { 190 | "type": "string", 191 | "description": "Rsync's --chmod option" 192 | }, 193 | "sync-rsync.shell": { 194 | "type": "string", 195 | "description": "Rsync's -e option e.g. ssh -p 1234" 196 | }, 197 | "sync-rsync.options": { 198 | "type": "array", 199 | "description": "Extra rsync options (not checked)", 200 | "default": [], 201 | "items": { 202 | "type": "array" 203 | } 204 | }, 205 | "sync-rsync.args": { 206 | "type": "array", 207 | "description": "rsync arguments to add", 208 | "default": [], 209 | "items": { 210 | "type": "string" 211 | } 212 | }, 213 | "sync-rsync.useWSL": { 214 | "type": "boolean", 215 | "default": false, 216 | "description": "Use WSL" 217 | }, 218 | "sync-rsync.sites": { 219 | "type": "array", 220 | "description": "Sites", 221 | "default": [], 222 | "items": { 223 | "type": "object", 224 | "properties": { 225 | "name": { 226 | "type": "string", 227 | "default": null, 228 | "description": "Site Name" 229 | }, 230 | "upOnly": { 231 | "type": "boolean", 232 | "default": false, 233 | "description": "Only Sync Local to Remote" 234 | }, 235 | "downOnly": { 236 | "type": "boolean", 237 | "default": false, 238 | "description": "Only Sync Remote to Local" 239 | }, 240 | "localPath": { 241 | "type": "string", 242 | "default": null, 243 | "description": "Local location defaults to workspace (must end in path separator)" 244 | }, 245 | "remotePath": { 246 | "type": "string", 247 | "default": null, 248 | "description": "Remote location (user@host:path) (must end in path separator)" 249 | }, 250 | "deleteFiles": { 251 | "type": "boolean", 252 | "default": false, 253 | "description": "Delete false during sync" 254 | }, 255 | "flags": { 256 | "type": "string", 257 | "default": "rlptzv", 258 | "description": "Rsync flags" 259 | }, 260 | "exclude": { 261 | "type": "array", 262 | "default": [ 263 | ".git", 264 | ".vscode" 265 | ], 266 | "description": "Rsync exclude patterns", 267 | "items": { 268 | "type": "string", 269 | "title": "rsync exclude pattern" 270 | } 271 | }, 272 | "include": { 273 | "type": "array", 274 | "default": [], 275 | "description": "Rsync include patterns", 276 | "items": { 277 | "type": "string", 278 | "title": "rsync include pattern" 279 | } 280 | }, 281 | "chmod": { 282 | "type": "string", 283 | "description": "Rsync's --chmod option" 284 | }, 285 | "shell": { 286 | "type": "string", 287 | "description": "Rsync's -e option e.g. ssh -p 1234" 288 | }, 289 | "afterSync": { 290 | "type": "array", 291 | "description": "a command to run after successful sync up", 292 | "items": { 293 | "type": "string" 294 | } 295 | }, 296 | "preSyncUp": { 297 | "type": "array", 298 | "description": "a command to before syncing up", 299 | "items": { 300 | "type": "string" 301 | } 302 | }, 303 | "postSyncUp": { 304 | "type": "array", 305 | "description": "a command to after syncing up", 306 | "items": { 307 | "type": "string" 308 | } 309 | }, 310 | "preSyncDown": { 311 | "type": "array", 312 | "description": "a command to before syncing down", 313 | "items": { 314 | "type": "string" 315 | } 316 | }, 317 | "postSyncDown": { 318 | "type": "array", 319 | "description": "a command to after syncing down", 320 | "items": { 321 | "type": "string" 322 | } 323 | }, 324 | "options": { 325 | "type": "array", 326 | "description": "Extra rsync options (not checked)", 327 | "default": [], 328 | "items": { 329 | "type": "array" 330 | } 331 | }, 332 | "args": { 333 | "type": "array", 334 | "description": "rsync arguments to add", 335 | "default": [], 336 | "items": { 337 | "type": "string" 338 | } 339 | } 340 | } 341 | } 342 | } 343 | } 344 | } 345 | }, 346 | "scripts": { 347 | "vscode:prepublish": "tsc -p ./", 348 | "compile": "tsc -watch -p ./", 349 | "postinstall": "node ./node_modules/vscode/bin/install", 350 | "test": "node ./node_modules/vscode/bin/test" 351 | }, 352 | "devDependencies": { 353 | "@types/node": "^10.5.4", 354 | "typescript": "^2.6.2", 355 | "vscode": "^1.1.10" 356 | }, 357 | "dependencies": { 358 | "chokidar": "^2.0.4", 359 | "lodash": "^4.17.10", 360 | "rsync": "^0.6.1", 361 | "util.promisify": "^1.0.0" 362 | } 363 | } 364 | -------------------------------------------------------------------------------- /src/extension.ts: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | // The module 'vscode' contains the VS Code extensibility API 3 | // Import the module and reference it with the alias vscode in your code below 4 | import { 5 | ExtensionContext, 6 | StatusBarAlignment, 7 | OutputChannel, 8 | StatusBarItem, 9 | Disposable, 10 | window as vscWindow, 11 | workspace, 12 | commands, 13 | TextDocument, 14 | window 15 | } from 'vscode'; 16 | import * as path from 'path'; 17 | import * as debounce from 'lodash.debounce'; 18 | import * as Rsync from 'rsync'; 19 | import * as chokidar from 'chokidar'; 20 | import { Config, Site } from './Config'; 21 | import * as child from 'child_process'; 22 | import { exists, lstat } from 'fs'; 23 | import * as util from 'util'; 24 | 25 | //Shim for older VSCode 26 | require("util.promisify").shim(); 27 | 28 | const path_exists = util.promisify(exists); 29 | 30 | const outputChannel: OutputChannel = vscWindow.createOutputChannel('Sync-Rsync'); 31 | const statusBar: StatusBarItem = vscWindow.createStatusBarItem(StatusBarAlignment.Right, 1); 32 | const createStatusText = (text: string): string => `Rsync: ${text}`; 33 | const getConfig = (): Config => new Config(workspace.getConfiguration('sync-rsync')); 34 | 35 | let currentSync: child.ChildProcess = undefined; 36 | let syncKilled = true; 37 | 38 | const execute = function (config: Config, cmd: string, args: string[] = [], shell: string = undefined): Promise { 39 | return new Promise(resolve => { 40 | 41 | let error = false; 42 | 43 | outputChannel.appendLine(`> ${cmd} ${args.join(" ")} `); 44 | 45 | if (config.autoShowOutput) { 46 | outputChannel.show(); 47 | } 48 | 49 | let showOutput = (data: Buffer): void => { 50 | outputChannel.append(data.toString()); 51 | }; 52 | 53 | 54 | if (process.platform === 'win32' && shell) { 55 | 56 | // when the platform is win32, spawn would add /s /c flags, making it impossible for the 57 | // shell to be something other than cmd or powershell (e.g. bash) 58 | args = ["'", cmd].concat(args, "'"); 59 | currentSync = child.spawn(shell + " -c", args, { stdio: 'pipe', shell: "cmd.exe" }); 60 | } else if (process.platform === 'win32' && config.useWSL) { 61 | args = [cmd].concat(args); 62 | currentSync = child.spawn("wsl", args, { stdio: 'pipe', shell: "cmd.exe" }); 63 | } else { 64 | currentSync = child.spawn(cmd, args, { stdio: 'pipe', shell: shell }); 65 | } 66 | 67 | currentSync.on('error', function (err: { code: string, message: string }) { 68 | outputChannel.append("ERROR > " + err.message); 69 | error = true; 70 | resolve(1); 71 | }); 72 | currentSync.stdout.on('data', showOutput); 73 | currentSync.stderr.on('data', showOutput); 74 | 75 | currentSync.on('close', function (code) { 76 | 77 | if (error) return; 78 | 79 | if (code != 0) { 80 | resolve(code); 81 | } 82 | 83 | resolve(0); 84 | 85 | }); 86 | }); 87 | } 88 | 89 | const runSync = function (rsync: Rsync, paths: string[], site: Site, config: Config): Promise { 90 | const syncStartTime: Date = new Date(); 91 | const isDryRun: boolean = rsync.isSet('n'); 92 | outputChannel.appendLine(`\n${syncStartTime.toString()} ${isDryRun ? 'comparing' : 'syncing'}`); 93 | return execute(config, site.executable, rsync.args().concat(site.args).concat(paths), site.executableShell); 94 | }; 95 | 96 | const runCommand = function (site: Site, config: Config, command: string[]): Promise { 97 | let _command = command[0]; 98 | let args = command.slice(1); 99 | return execute(config, _command, args, site.executableShell); 100 | }; 101 | 102 | const syncSite = async function (site: Site, config: Config, { down, dry }: { down: boolean, dry: boolean }): Promise { 103 | 104 | if(down && site.upOnly) { 105 | outputChannel.appendLine(`\n${site.remotePath} is upOnly`); 106 | return true; 107 | } 108 | 109 | if(!down && site.downOnly) { 110 | outputChannel.appendLine(`\n${site.remotePath} is downOnly`); 111 | return true; 112 | } 113 | 114 | let paths = []; 115 | 116 | if (syncKilled) return false;; 117 | 118 | if (site.localPath === null) { 119 | vscWindow.showErrorMessage('Sync-Rsync: you must have a folder open or configured local'); 120 | return false; 121 | } 122 | 123 | if (site.remotePath === null) { 124 | vscWindow.showErrorMessage('Sync-Rsync: you must configure a remote'); 125 | return false; 126 | } 127 | 128 | let rsync: Rsync = new Rsync(); 129 | 130 | if (down) { 131 | paths = [site.remotePath, site.localPath]; 132 | } else { 133 | paths = [site.localPath, site.remotePath]; 134 | } 135 | 136 | if (dry) { 137 | rsync = rsync.dry(); 138 | } 139 | 140 | for (let option of site.options) { 141 | rsync.set.apply(rsync, option) 142 | } 143 | 144 | rsync = rsync 145 | .flags(site.flags) 146 | .progress(config.showProgress); 147 | 148 | if (site.include.length > 0) { 149 | rsync = rsync.include(site.include); 150 | } 151 | 152 | if (site.exclude.length > 0) { 153 | rsync = rsync.exclude(site.exclude); 154 | } 155 | 156 | 157 | if (site.shell !== undefined) { 158 | rsync = rsync.shell(site.shell); 159 | } 160 | 161 | if (site.deleteFiles) { 162 | rsync = rsync.delete(); 163 | } 164 | 165 | if (site.chmod !== undefined) { 166 | rsync = rsync.chmod(site.chmod); 167 | } 168 | 169 | const runPrePost = async function(site: Site, config: Config, command: string[], tag:string): Promise { 170 | let rtn = await runCommand(site, config, command); 171 | if (rtn != 0) { 172 | vscWindow.showErrorMessage(tag + " return " + rtn); 173 | } 174 | return rtn; 175 | } 176 | 177 | let rtn: number = 0; 178 | if(down) { 179 | if(site.preSyncDown) rtn = await runPrePost(site, config, site.preSyncDown,"preSyncDown"); 180 | } else { 181 | if(site.preSyncUp) rtn = await runPrePost(site, config, site.preSyncUp,"preSyncUp"); 182 | } 183 | 184 | rtn = await runSync(rsync, paths, site, config); 185 | 186 | if (rtn == 0) { 187 | if(down) { 188 | if(site.postSyncDown) rtn = await runPrePost(site, config, site.postSyncDown,"postSyncDown"); 189 | } else { 190 | if(site.postSyncUp) rtn = await runPrePost(site, config, site.postSyncUp,"postSyncUp"); 191 | if(site.afterSync) { 192 | rtn = await runPrePost(site, config, site.afterSync,"afterSync"); 193 | vscWindow.showInformationMessage("afterSync will be deprecated use postSyncUp"); 194 | } 195 | } 196 | return true; 197 | } else { 198 | vscWindow.showErrorMessage("rsync return " + rtn); 199 | return false; 200 | } 201 | } 202 | 203 | const sync = async function (config: Config, { down, dry }: { down: boolean, dry: boolean }): Promise { 204 | 205 | statusBar.color = 'mediumseagreen'; 206 | statusBar.text = createStatusText('$(sync)'); 207 | 208 | let success = true; 209 | syncKilled = false; 210 | statusBar.command = 'sync-rsync.killSync'; 211 | 212 | for (let site of config.sites) { 213 | success = success && await syncSite(site,config,{down, dry}); 214 | } 215 | 216 | syncKilled = true; 217 | statusBar.command = 'sync-rsync.showOutput'; 218 | 219 | if (success) { 220 | if (config.autoHideOutput) { 221 | outputChannel.hide(); 222 | } 223 | statusBar.color = undefined; 224 | statusBar.text = createStatusText('$(check)'); 225 | if (config.notification) { 226 | vscWindow.showInformationMessage("Sync Completed"); 227 | } 228 | } else { 229 | if (config.autoShowOutputOnError) { 230 | outputChannel.show(); 231 | } 232 | statusBar.color = 'red'; 233 | statusBar.text = createStatusText('$(alert)'); 234 | } 235 | }; 236 | 237 | const syncFile = async function (config: Config, file: string, down: boolean): Promise { 238 | 239 | statusBar.color = 'mediumseagreen'; 240 | statusBar.text = createStatusText('$(sync)'); 241 | 242 | let success = true; 243 | syncKilled = false; 244 | statusBar.command = 'sync-rsync.killSync'; 245 | 246 | let sync_file = false; 247 | 248 | for (let site of config.sites) { 249 | 250 | let paths = []; 251 | 252 | if (syncKilled) continue; 253 | 254 | if (site.localPath === null) { 255 | vscWindow.showErrorMessage('Sync-Rsync: you must have a folder open or configured local'); 256 | continue; 257 | } 258 | 259 | if (site.remotePath === null) { 260 | vscWindow.showErrorMessage('Sync-Rsync: you must configure a remote'); 261 | continue; 262 | } 263 | 264 | let path = site.localPath; 265 | 266 | file = config.translatePath(file); 267 | 268 | if (file.startsWith(path)) { 269 | 270 | sync_file = true; 271 | 272 | let path_l = path.length; 273 | let post = file.slice(path_l); 274 | let local = path + post; 275 | let remote = site.remotePath + post; 276 | 277 | let rsync: Rsync = new Rsync(); 278 | 279 | let paths = down ? [remote, local] : [local, remote]; 280 | 281 | for (let option of site.options) { 282 | rsync.set.apply(rsync, option) 283 | } 284 | 285 | rsync = rsync 286 | .flags(site.flags) 287 | .progress(config.showProgress); 288 | 289 | if (site.include.length > 0) { 290 | rsync = rsync.include(site.include); 291 | } 292 | 293 | if (site.exclude.length > 0) { 294 | rsync = rsync.exclude(site.exclude); 295 | } 296 | 297 | 298 | if (site.shell !== undefined) { 299 | rsync = rsync.shell(site.shell); 300 | } 301 | 302 | if (site.deleteFiles) { 303 | rsync = rsync.delete(); 304 | } 305 | 306 | if (site.chmod !== undefined) { 307 | rsync = rsync.chmod(site.chmod); 308 | } 309 | 310 | let rtn = await runSync(rsync, paths, site, config) 311 | //We can safly ignore error 3 because it might be excluded. 312 | if ((rtn == 0) || (rtn == 3)) { 313 | success = success && true; 314 | } else { 315 | vscWindow.showErrorMessage("rsync return " + rtn); 316 | success = false; 317 | } 318 | } 319 | } 320 | 321 | syncKilled = true; 322 | statusBar.command = 'sync-rsync.showOutput'; 323 | 324 | if(sync_file) { 325 | if (success) { 326 | if (config.autoHideOutput) { 327 | outputChannel.hide(); 328 | } 329 | statusBar.color = undefined; 330 | statusBar.text = createStatusText('$(check)'); 331 | if (config.notification) { 332 | vscWindow.showInformationMessage("Synced " + file); 333 | } 334 | } else { 335 | if (config.autoShowOutputOnError) { 336 | outputChannel.show(); 337 | } 338 | statusBar.color = 'red'; 339 | statusBar.text = createStatusText('$(alert)'); 340 | } 341 | } 342 | }; 343 | 344 | const syncUp = (config: Config) => sync(config, { down: false, dry: false }); 345 | const syncDown = (config: Config) => sync(config, { down: true, dry: false }); 346 | const compareUp = (config: Config) => sync(config, { down: false, dry: true }); 347 | const compareDown = (config: Config) => sync(config, { down: true, dry: true }); 348 | const debouncedSyncUp: (config: Config) => void = debounce(syncUp, 100); // debounce 100ms in case of 'Save All' 349 | 350 | const watch = (config: Config) => { 351 | if (config.watchGlobs.length === 0) { 352 | return null; 353 | } 354 | 355 | outputChannel.appendLine(`Activating watcher on globs: ${config.watchGlobs.join(', ')}`); 356 | 357 | try { 358 | const watcher = chokidar.watch(config.watchGlobs, { 359 | cwd: workspace.rootPath, 360 | ignoreInitial: true 361 | }); 362 | 363 | watcher.on('all', (): void => { 364 | debouncedSyncUp(config); 365 | }); 366 | 367 | return watcher; 368 | } catch (error) { 369 | outputChannel.appendLine(`Unable to create watcher: ${error}`); 370 | } 371 | 372 | return null; 373 | }; 374 | 375 | const syncSingle = function(config: Config, down: boolean) { 376 | 377 | syncKilled = false; 378 | 379 | var site_map = config.siteMap; 380 | 381 | var keys = [ ... site_map.keys() ]; 382 | window.showQuickPick(keys) 383 | .then(async (k) => { 384 | 385 | if(undefined == k) return true; 386 | 387 | var site = config.siteMap.get(k); 388 | 389 | if(undefined == site) return true; 390 | 391 | statusBar.color = 'mediumseagreen'; 392 | statusBar.text = createStatusText('$(sync)'); 393 | 394 | let success = true; 395 | syncKilled = false; 396 | statusBar.command = 'sync-rsync.killSync'; 397 | 398 | success = await syncSite(site, config, { down, dry: false}); 399 | 400 | syncKilled = true; 401 | statusBar.command = 'sync-rsync.showOutput'; 402 | 403 | if (success) { 404 | if (config.autoHideOutput) { 405 | outputChannel.hide(); 406 | } 407 | statusBar.color = undefined; 408 | statusBar.text = createStatusText('$(check)'); 409 | if (config.notification) { 410 | vscWindow.showInformationMessage("Sync Completed"); 411 | } 412 | } else { 413 | if (config.autoShowOutputOnError) { 414 | outputChannel.show(); 415 | } 416 | statusBar.color = 'red'; 417 | statusBar.text = createStatusText('$(alert)'); 418 | } 419 | 420 | return true; 421 | }) 422 | 423 | } 424 | 425 | // this method is called when your extension is activated 426 | // your extension is activated the very first time the command is executed 427 | export function activate(context: ExtensionContext): void { 428 | let config: Config = getConfig(); 429 | let watcher = null; 430 | 431 | workspace.onDidChangeConfiguration((): void => { 432 | config = getConfig(); 433 | 434 | if (watcher) { 435 | outputChannel.appendLine('Closing watcher'); 436 | watcher.close(); 437 | } 438 | 439 | watcher = watch(config); 440 | }); 441 | 442 | workspace.onDidSaveTextDocument((doc: TextDocument): void => { 443 | if (config.onFileSave) { 444 | debouncedSyncUp(config); 445 | } else if (config.onFileSaveIndividual) { 446 | syncFile(config, config.translatePath(doc.fileName), false); 447 | } 448 | }); 449 | 450 | workspace.onDidOpenTextDocument((doc: TextDocument): void => { 451 | if (config.onFileLoadIndividual && doc.uri.scheme == 'file') { 452 | syncFile(config, config.translatePath(doc.fileName), true); 453 | } 454 | }); 455 | 456 | const syncDownCommand: Disposable = commands.registerCommand('sync-rsync.syncDown', (): void => { 457 | syncDown(config); 458 | }); 459 | const syncDownContextCommand: Disposable = commands.registerCommand('sync-rsync.syncDownContext', (i :{path}): void => { 460 | lstat(i.path,(err,info) => { 461 | if(err) return; 462 | 463 | var path = config.translatePath(i.path); 464 | 465 | if(info.isDirectory()) { 466 | if(path[path.length - 1] != '/') path += '/'; 467 | } 468 | syncFile(config, path, true); 469 | }) 470 | 471 | }); 472 | const syncDownSingleCommand: Disposable = commands.registerCommand('sync-rsync.syncDownSingle', (site: string): void => { 473 | syncSingle(config,true); 474 | }); 475 | const syncUpCommand: Disposable = commands.registerCommand('sync-rsync.syncUp', (): void => { 476 | syncUp(config); 477 | }); 478 | const syncUpContextCommand: Disposable = commands.registerCommand('sync-rsync.syncUpContext', (i :{path}): void => { 479 | lstat(i.path,(err,info) => { 480 | if(err) return; 481 | 482 | var path = config.translatePath(i.path); 483 | 484 | if(info.isDirectory()) { 485 | if(path[path.length - 1] != '/') path += '/'; 486 | } 487 | syncFile(config, path, false); 488 | }) 489 | 490 | }); 491 | const syncUpSingleCommand: Disposable = commands.registerCommand('sync-rsync.syncUpSingle', (site: string): void => { 492 | syncSingle(config,false); 493 | }); 494 | const compareDownCommand: Disposable = commands.registerCommand('sync-rsync.compareDown', (): void => { 495 | compareDown(config); 496 | }); 497 | const compareUpCommand: Disposable = commands.registerCommand('sync-rsync.compareUp', (): void => { 498 | compareUp(config); 499 | }); 500 | const showOutputCommand: Disposable = commands.registerCommand('sync-rsync.showOutput', (): void => { 501 | outputChannel.show(); 502 | }); 503 | const killSyncCommand: Disposable = commands.registerCommand('sync-rsync.killSync', (): void => { 504 | syncKilled = true; 505 | currentSync.kill(); 506 | }); 507 | 508 | context.subscriptions.push(syncDownCommand); 509 | context.subscriptions.push(syncDownContextCommand); 510 | context.subscriptions.push(syncDownSingleCommand); 511 | context.subscriptions.push(syncUpCommand); 512 | context.subscriptions.push(syncUpContextCommand); 513 | context.subscriptions.push(syncUpSingleCommand); 514 | context.subscriptions.push(compareDownCommand); 515 | context.subscriptions.push(compareUpCommand); 516 | context.subscriptions.push(showOutputCommand); 517 | context.subscriptions.push(killSyncCommand); 518 | 519 | statusBar.text = createStatusText('$(info)'); 520 | statusBar.command = 'sync-rsync.showOutput'; 521 | statusBar.show(); 522 | outputChannel.appendLine('Sync-Rsync started'); 523 | watcher = watch(config); 524 | } 525 | 526 | // this method is called when your extension is deactivated 527 | export function deactivate(): void { } 528 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------