├── .travis.yml ├── .gitignore ├── test └── init.js ├── test.js ├── package.json ├── README.md ├── config.js.template ├── bin └── putio-sync ├── lib ├── putio-api-helper.js └── putio-sync.js └── LICENSE /.travis.yml: -------------------------------------------------------------------------------- 1 | language: node_js 2 | node_js: 3 | - "0.10" 4 | - "0.11" 5 | script: npm test 6 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | lib-cov 2 | *.seed 3 | *.log 4 | *.csv 5 | *.dat 6 | *.out 7 | *.pid 8 | *.gz 9 | 10 | pids 11 | logs 12 | results 13 | 14 | npm-debug.log 15 | node_modules 16 | /config.js 17 | /.idea 18 | -------------------------------------------------------------------------------- /test/init.js: -------------------------------------------------------------------------------- 1 | var tap = require('tap') 2 | 3 | tap.test('The putio-sync module loads', function(t) { 4 | t.doesNotThrow(load_app, 'Test loading the putio-sync.js file') 5 | t.end() 6 | 7 | function load_app() { 8 | var PutIOSync = require('../lib/putio-sync') 9 | } 10 | }) 11 | 12 | tap.test('startSync function available', function(t) { 13 | var PutIOSync = require('../lib/putio-sync'); 14 | var sync = new PutIOSync({config: 'config.js.template'}); 15 | t.type(sync.startSync, 'function', 'Check if startSync function available') 16 | t.end() 17 | }) 18 | -------------------------------------------------------------------------------- /test.js: -------------------------------------------------------------------------------- 1 | var path = require ("path"); 2 | var http = require ("http"); 3 | var statusBar = require ("status-bar"); 4 | 5 | var url = "http://nodejs.org/dist/latest/node.exe"; 6 | var bar; 7 | 8 | http.get (url, function (res){ 9 | bar = statusBar.create ({ total: res.headers["content-length"] }) 10 | .on ("render", function (stats){ 11 | process.stdout.write ( 12 | path.basename (url) + " " + 13 | " (" + this.format.storage(stats.currentSize) + "/" + this.format.storage(stats.totalSize) + "), " + 14 | this.format.speed (stats.speed) + " " + 15 | this.format.time (stats.remainingTime) + " [" + 16 | this.format.progressBar (stats.percentage) + "] " + 17 | this.format.percentage (stats.percentage)); 18 | process.stdout.cursorTo (0); 19 | }); 20 | 21 | res.pipe (bar); 22 | }).on ("error", function (error){ 23 | bar.cancel (); 24 | console.error (error); 25 | }); -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "author": "Stefan Profanter", 3 | "name": "put.io-sync", 4 | "description": "Put.io Sync and automatic file download", 5 | "version": "0.0.9", 6 | "repository": { 7 | "type": "git", 8 | "url": "git://github.com/Pro/put.io-sync.git" 9 | }, 10 | "main": "./lib/putio-sync", 11 | "scripts": { 12 | "test": "tap test/*.js" 13 | }, 14 | "keywords": [ 15 | "put.io", 16 | "sync" 17 | ], 18 | "bin": { 19 | "putio-sync": "./bin/putio-sync" 20 | }, 21 | "dependencies": { 22 | "put.io-v2" : ">=0.0.2", 23 | "underscore" : ">=1.6.0", 24 | "npid" : ">=0.3.2", 25 | "colors" : ">=0.6.2", 26 | "ensureDir" : ">=1.0.6", 27 | "nopt" : ">=2.2.0", 28 | "nopt-usage" : ">=0.1.0", 29 | "status-bar": ">=2.0.0", 30 | "fswin": ">=2.14.1024", 31 | "request" : ">=2.33", 32 | "ansi": ">=0.2.1" 33 | }, 34 | "devDependencies": { 35 | "tap": "~0.4.8" 36 | }, 37 | "optionalDependencies": {}, 38 | "engines": { 39 | "node": ">=0.10.*" 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | put.io-sync [![NPM version](https://badge.fury.io/js/put.io-sync.svg)](http://badge.fury.io/js/put.io-sync) [![Build Status](https://secure.travis-ci.org/Pro/put.io-sync.svg)](http://travis-ci.org/Pro/put.io-sync) [![Dependency Status](https://david-dm.org/pro/put.io-sync.svg)](https://david-dm.org/pro/put.io-sync) 2 | =========== 3 | 4 | [![NPM](https://nodei.co/npm/put.io-sync.png)](https://nodei.co/npm/put.io-sync/) 5 | 6 | # Installation 7 | 8 | After downloading use `npm install .` to install the required dependencies. 9 | 10 | Then rename `config.js.template` to `config.js` and adapt it to your setup. 11 | 12 | You can get the `oauth_token` by clicking this link: [Get Token]( 13 | https://api.put.io/v2/oauth2/authenticate?client_id=1159&response_type=code&redirect_uri=http://profanter.me/putio/node) 14 | 15 | # Executing 16 | 17 | `node bin/putio-sync` 18 | 19 | # Organizing your TV Shows 20 | 21 | If you want to automatically order your TV Shows you can check out this handy script: 22 | 23 | https://github.com/arrizer/TVGeek 24 | 25 | # Changelog 26 | 27 | * 0.0.9 [29.10.2014]: Updated fswin dependency 28 | * 0.0.7 [27.08.2014]: Updated dependency for put.io-v2 to 0.0.2 and fswin-binary 29 | -------------------------------------------------------------------------------- /config.js.template: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | /* Get the token by opening: https://api.put.io/v2/oauth2/authenticate?client_id=1159&response_type=code&redirect_uri=http://profanter.me/putio/node */ 3 | oauth_token: 'XXXXXX', 4 | // Add folders to this array which should be synced 5 | sync : [ 6 | { 7 | // Path on the put.io filesystem 8 | remote_path: 'TV Shows', 9 | // Folder on your local system. You need to escape backslashes. 10 | local_path : 'X:\\TV Shows', 11 | // Set to 'true' to download all subfolders from put.io 12 | recursive: true, 13 | // Set to 'true' to delete downloads from put.io after successful download 14 | delete: true, 15 | // Set to 'true' to delete empty subfolders from put.io 16 | delete_subfolder: true 17 | }, 18 | { 19 | // Path on the put.io filesystem 20 | remote_path: 'Movies', 21 | // Folder on your local system 22 | local_path : 'V:\\Movies', 23 | // Set to 'true' to download all subfolders from put.io 24 | recursive: true, 25 | // Set to 'true' to delete downloads from put.io after successful download 26 | delete: true, 27 | // Set to 'true' to delete empty subfolders from put.io 28 | delete_subfolder: true 29 | } 30 | ] 31 | } -------------------------------------------------------------------------------- /bin/putio-sync: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | 3 | "use strict"; 4 | var path = require('path'); 5 | var fs = require('fs'); 6 | var _ = require('underscore'); 7 | var lib = path.join(path.dirname(fs.realpathSync(__filename)), '../lib'); 8 | var nopt = require("nopt") 9 | , noptUsage = require("nopt-usage") 10 | , Stream = require("stream").Stream 11 | , knownOpts = { 12 | "help": Boolean, 13 | "override": Boolean, 14 | "parallel": [Stream, Number], 15 | "config": path, 16 | "verbosity" : [Stream, Number], 17 | "quiet": Boolean, 18 | "wait" : [Stream, Number] 19 | } 20 | , shortHands = { 21 | "h": ["--help", "true"], 22 | "o": ["--override", "true"], 23 | "p": ["--parallel"], 24 | "c": ["--config"], 25 | "v": ["--verbosity"], 26 | "q": ["--quiet"] 27 | } 28 | , description = { 29 | "help": "Print this message", 30 | "override": "Override monogamy checking. Ignore if another instance is already running", 31 | "parallel": "Number of parallel downloads", 32 | "config": "Path to config.js file", 33 | "verbosity": "Set verbosity level. 0=only errors, 5=debug messages", 34 | "quiet": "No output whatsoever", 35 | "wait": "Wait for this many seconds, then sync again" 36 | } 37 | , defaults = { 38 | "override": false, 39 | "parallel": 10, 40 | "config": "config.js", 41 | "verbosity": 1, 42 | "quiet" : false 43 | } 44 | , parsed = nopt(knownOpts, shortHands) 45 | , usage = noptUsage(knownOpts, shortHands, description, defaults) 46 | 47 | if (parsed.help) { 48 | console.log('Usage: ') 49 | console.log(usage) 50 | process.exit(0); 51 | } 52 | 53 | var PutIOSync = require(lib + '/putio-sync.js') 54 | 55 | var sync = new PutIOSync(_.extend(defaults, parsed)); 56 | sync.startSync(); -------------------------------------------------------------------------------- /lib/putio-api-helper.js: -------------------------------------------------------------------------------- 1 | "use strict;" 2 | 3 | var _ = require('underscore'); 4 | 5 | var PutIOApiHelper = function (api) { 6 | 7 | /** 8 | * Traverses through the put.io filesystem to get the id of the folder path 9 | * @param path string[] containing the successive folder names 10 | * @param parentId id of the current parent folder 11 | * @param depth current recursion depth 12 | * @param callback success callback 13 | */ 14 | var findFolderIdRecursive = function (path, parentId, depth, callback) { 15 | api.files.list(parentId, function (data) { 16 | var found = _.find(data.files, function(entry) { 17 | return (entry.content_type === "application/x-directory") && entry.name === path[depth]; 18 | }); 19 | if (typeof found === "undefined") 20 | callback(undefined); 21 | else { 22 | if (path.length == depth+1) { 23 | callback(found.id); 24 | } 25 | else 26 | findFolderIdRecursive(path, found.id, depth + 1, callback); 27 | } 28 | }); 29 | } 30 | 31 | /** 32 | * Gets the folder ID of the given folder path from put.io file system 33 | * @param folderPath the path identifying the folder. e.g 'Folder1/Subfolder2' 34 | * @param callback the callback with the id as parameter 35 | */ 36 | this.findFolderId = function (folderPath, callback) { 37 | findFolderIdRecursive(folderPath.split('/'), 0, 0, callback); 38 | } 39 | } 40 | 41 | var root = this; 42 | 43 | // Export the Class object for **Node.js**, with 44 | // backwards-compatibility for the old `require()` API. If we're in 45 | // the browser, add `PutIOApiHelper` as a global object via a string identifier, 46 | // for Closure Compiler "advanced" mode. 47 | if (typeof exports !== 'undefined') { 48 | if (typeof module !== 'undefined' && module.exports) { 49 | exports = module.exports = PutIOApiHelper; 50 | } 51 | exports.PutIOApiHelper = PutIOApiHelper; 52 | } else { 53 | root.PutIOSync = PutIOApiHelper; 54 | } -------------------------------------------------------------------------------- /lib/putio-sync.js: -------------------------------------------------------------------------------- 1 | "use strict;" 2 | 3 | var windows = false; 4 | 5 | var PutIO = require('put.io-v2'); 6 | var _ = require('underscore'); 7 | var fs = require('fs'); 8 | var path = require('path'); 9 | var npid = require('npid'); 10 | var colors = require('colors'); 11 | var ensureDir = require('ensureDir'); 12 | var fswin = null; 13 | if(process.platform == 'win32' || process.platform == 'win64'){ 14 | fswin = require('fswin'); 15 | windows = true; 16 | } 17 | var request = require('request'); 18 | var url = require('url'); 19 | var tty = require('tty') 20 | var cursor = require('ansi')(process.stdout); 21 | var events = require('events'); 22 | 23 | var https = require("https"); 24 | var statusBar = require("status-bar"); 25 | 26 | var PutIOApiHelper = require(path.join(path.dirname(fs.realpathSync(__filename)), 'putio-api-helper.js')); 27 | 28 | var projectBase = path.join(path.dirname(fs.realpathSync(__filename)), '../'); 29 | 30 | var PutIOSync = function (opts) { 31 | var self = this; 32 | 33 | // Set default options 34 | /** 35 | * Available options: 36 | * config: Path to config file relative to main project directory 37 | */ 38 | if (typeof opts === "undefined") 39 | opts = {}; 40 | opts = _.extend({ 41 | config: "config.js", 42 | verbosity: 1, 43 | parallel: 10, 44 | quiet: false 45 | }, opts); 46 | 47 | /** 48 | * Log message with specified log level 49 | * @param level the log level. 0=error, 5 = very verbose 50 | * @param message the message to log 51 | */ 52 | var logv = function (level, message) { 53 | if (opts.quiet || level > opts.verbosity) 54 | return; 55 | console.log(message); 56 | } 57 | 58 | /** 59 | * Load the configuration. 60 | * @type {object} 61 | */ 62 | var config = require(path.join(projectBase, opts.config)); 63 | 64 | 65 | // Ensure monogamy 66 | try { 67 | var pid = npid.create(path.join(projectBase, "sync.pid")); 68 | pid.removeOnExit(); 69 | process.on('SIGINT', function() { 70 | pid.remove(); 71 | process.exit(1); 72 | }); 73 | } catch (err) { 74 | if (!opts.override) { 75 | if (err.code === 'EEXIST') { 76 | fs.readFile(path.join(projectBase, "sync.pid"), 'utf8', function (err, data) { 77 | if (err) { 78 | logv(0, err); 79 | } else { 80 | logv(0, ("Another instance is already running with PID: " + data).red); 81 | } 82 | process.exit(1); 83 | }); 84 | } else { 85 | logv(0, err); 86 | process.exit(1); 87 | } 88 | } 89 | } 90 | 91 | /** 92 | * The Api to communicate with Put.io 93 | * @type {PutIO} 94 | */ 95 | var api = new PutIO(config.oauth_token); 96 | /** 97 | * Helper combining some api functions 98 | * @type {PutIOApiHelper} 99 | */ 100 | var apiHelper = new PutIOApiHelper(api); 101 | 102 | /** 103 | * Temporary download directory 104 | * @type {string} 105 | */ 106 | var download_temp_dir = ".putiosync-downloading"; 107 | 108 | /** 109 | * Timer id for the next sync run timeout 110 | * @type {number} 111 | */ 112 | var waitNextSyncTimeout = 0; 113 | 114 | /** 115 | * Number of files to download 116 | * @type {number} 117 | */ 118 | var totalFileCount = 0; 119 | /** 120 | * Number of currently active downloads 121 | * @type {number} 122 | */ 123 | var currentDownloading = 0; 124 | 125 | /** 126 | * The download queue containing all the files to download 127 | * @type {Array} 128 | */ 129 | var downloadQueue = []; 130 | /** 131 | * EventEmitter for download queue notifications. 132 | * @type {events.EventEmitter} 133 | */ 134 | var downloadQueueEvents = new events.EventEmitter(); 135 | 136 | /** 137 | * Add file to download queue and start the download if a slot is available. 138 | * @param sync Sync section from the config file 139 | * @param fileData put.io file info object 140 | * @param target local file path where to store downloaded file 141 | * @param downloadedCallback callbackFunction called when file is downloaded 142 | */ 143 | var enqueueDownload = function (sync, fileData, target, downloadedCallback) { 144 | downloadQueue.push({ 145 | sync: sync, 146 | fileData: fileData, 147 | target: target, 148 | number: totalFileCount + 1, 149 | downloadedCallback : downloadedCallback 150 | }); 151 | totalFileCount += 1; 152 | if (currentDownloading < opts.parallel) { 153 | // there's a slot available, start downloading 154 | downloadQueueEvents.emit("next", currentDownloading); 155 | currentDownloading += 1; 156 | } 157 | } 158 | 159 | /** 160 | * Wait opts.wait seconds and then start a new sync run. 161 | */ 162 | var waitForNextExecution = function () { 163 | if (opts.wait) { 164 | logv(1, ("Waiting " + opts.wait + " seconds for next execution...").cyan); 165 | waitNextSyncTimeout = setTimeout(self.startSync, opts.wait * 1000); 166 | } 167 | } 168 | 169 | /** 170 | * Event triggered after a download finished or a new one has been added to the queue and there's a slot available. 171 | * @param slot index where the status bar can be shown 172 | */ 173 | downloadQueueEvents.on("next", function (slot) { 174 | if (downloadQueue.length == 0) { 175 | currentDownloading -= 1; 176 | if (currentDownloading == 0) { 177 | // queue is empty and all files downloaded 178 | if (!opts.quiet) 179 | // reset cursor to the end 180 | cursor.down(2 * Math.min(totalFileCount, opts.parallel) + 1).horizontalAbsolute(0).reset(); 181 | //waitForNextExecution(); 182 | } 183 | return; 184 | } 185 | var toDownload = downloadQueue.shift(); 186 | downloadFile(toDownload.sync, toDownload.fileData, toDownload.target, slot, toDownload.number, toDownload.downloadedCallback); 187 | }); 188 | 189 | /** 190 | * Shorten a filename if it is longer than given maximum length. Add ellipsis points '...' 191 | * @param filename filename to shorten 192 | * @param filenameMaxLength maximum length of the resulting string 193 | * @returns {string} the shortened filename 194 | */ 195 | var formatFilename = function (filename, filenameMaxLength) { 196 | if (filename.length > filenameMaxLength) { 197 | filename = filename.slice(0, filenameMaxLength - 3) + "..."; 198 | } 199 | return filename; 200 | }; 201 | 202 | /** 203 | * Download the file to the temporary download directory and then move it to the final target path. 204 | * @param sync Sync section from config file 205 | * @param fileData put.io file data object 206 | * @param target target file path where to store the file 207 | * @param slot index where to show download info and progress 208 | * @param number index of the download within the queue of all the downloads. 209 | * @param downloadedCallback callbackFunction called when file is downloaded 210 | */ 211 | var downloadFile = function (sync, fileData, target, slot, number, downloadedCallback) { 212 | //logv(0, ("Downloading " + fileData.name + " to: " + target).magenta); 213 | var downloadUrl = api.files.download(fileData.id); 214 | 215 | var current = path.resolve(target); 216 | var parent = path.dirname(current); 217 | // make sure target path exists 218 | ensureDir(parent, undefined, function (err) { 219 | if (err) { 220 | logv(0, ("Coudln't create directory: " + parent + " -> " + err).red); 221 | return; 222 | } 223 | 224 | // get the url where we can fetch the file 225 | request({ 226 | url: downloadUrl, 227 | followRedirect: false 228 | }, function (error, response, body) { 229 | if (response.statusCode === 302) { 230 | // yayy! We got the url in the location header 231 | var newUrl = response.headers.location; 232 | 233 | var filename = formatFilename(fileData.name, 80); 234 | 235 | var tempFilename = path.join(path.join(sync.local_path, download_temp_dir), fileData.id + "-" + path.basename(target)); 236 | 237 | // check if file already partially downloaded 238 | var bytesOffset = 0; 239 | if (fs.existsSync(tempFilename)) { 240 | bytesOffset = fs.statSync(tempFilename).size; 241 | } 242 | 243 | var bar = null; 244 | if (!opts.quiet) 245 | bar = statusBar.create({ total: fileData.size - bytesOffset }) 246 | //var bar = statusBar.create({ total: fileData.size }) 247 | .on("render", function (stats) { 248 | cursor.down(2 * slot).horizontalAbsolute(0).grey().write( 249 | "[" + number + " of " + totalFileCount + "] ").cyan().write(filename + "\r\n").white().write(this.format.storage(stats.currentSize + bytesOffset) + "/" + this.format.storage(fileData.size) + "), " + 250 | this.format.speed(stats.speed) + " " + 251 | this.format.time(stats.remainingTime) + " [" + 252 | this.format.progressBar(stats.percentage) + "] " + 253 | this.format.percentage(stats.percentage) + "\r\n").up(2 * (slot + 1)).reset(); 254 | }); 255 | 256 | var urlObj = url.parse(newUrl); 257 | 258 | // start download 259 | https.get({ 260 | 'host': urlObj.host, 261 | 'port': 443, 262 | 'path': urlObj.path, 263 | method: 'GET', 264 | headers: { 265 | 'Range': 'bytes=' + bytesOffset + "-" 266 | } 267 | },function (res) { 268 | // temporary file to store the content 269 | var file = fs.createWriteStream(tempFilename, { 270 | 'flags': bytesOffset === 0 ? 'w' : 'a' 271 | }); 272 | if (!opts.quiet) 273 | res.pipe(bar); 274 | res.on('data', function (chunk) { 275 | file.write(chunk); 276 | }); 277 | res.on('end', function () { 278 | file.end(); 279 | }); 280 | file.on('close', function () { 281 | // move file to final location 282 | fs.rename(tempFilename, target, function () { 283 | if (!opts.quiet) 284 | cursor.down(2 * slot + 1).horizontalAbsolute(0).eraseLine().white().write("DOWNLOADED").up(2 * slot + 1).reset(); 285 | // start next download 286 | downloadQueueEvents.emit("next", slot); 287 | if (sync.delete) { 288 | // delete file on put.io 289 | api.files.delete(fileData.id, function (delData) { 290 | if (delData.status !== "OK") 291 | logv(0, ("Coudln't delete file '" + file.name + "' put.io").red); 292 | else if (downloadedCallback !== null) 293 | downloadedCallback(); 294 | }) 295 | } else if (downloadedCallback !== null) 296 | downloadedCallback(); 297 | }) 298 | }); 299 | 300 | }).on("error", function (error) { 301 | if (!opts.quiet) 302 | bar.cancel(); 303 | logv(0, error.red); 304 | }); 305 | } else { 306 | logv(0, ("Expected 302 status code but got " + response.statusCode + " for file " + fileData.name).red); 307 | } 308 | }) 309 | 310 | 311 | }); 312 | } 313 | 314 | /** 315 | * Iterate through folder with given id and enqueue all the files for download. 316 | * 317 | * @param sync Sync section from the config file 318 | * @param folderId id of the folder to download 319 | * @param localPath local target path where to store the folder contents 320 | * @param depth current recursion depth 321 | * @param finishCallback Callback function for when the syncing finished 322 | */ 323 | var syncFolderRecursive = function (sync, folderId, localPath, depth, finishCallback) { 324 | api.files.list(folderId, function (data) { 325 | // check if folder is empty and should be deleted 326 | if (sync.delete_subfolder && depth > 0 && data.files.length == 0) { 327 | logv(1, ("Folder '" + data.parent.name + "' is empty. Deleting ...").green); 328 | api.files.delete(folderId, function (delData) { 329 | if (delData.status !== "OK") 330 | logv(0, ("Couldn't delete folder '" + data.parent.name + "'").red); 331 | else 332 | finishCallback(); 333 | }); 334 | return; 335 | } 336 | 337 | var filesToSync = data.files.length; 338 | 339 | if (filesToSync == 0) { 340 | finishCallback(); 341 | return; 342 | } 343 | 344 | var filesSynced = 0; 345 | 346 | var incFileSynced = function() { 347 | filesSynced++; 348 | if (filesSynced == filesToSync) { 349 | finishCallback(); 350 | } 351 | } 352 | 353 | _.each(data.files, function (file) { 354 | // check folder content 355 | var localFile = path.join(localPath, file.name.replace(':', '_'));//Replace colon, otherwise subfolders will fail 356 | localFile = localFile.replace(' \\', '\\'); //Remove whitespace before slash, otherwise subfolders will fail 357 | if (file.content_type === "application/x-directory") { 358 | if (!sync.recursive) { 359 | incFileSynced(); 360 | return; 361 | } 362 | // recursive step into directory 363 | syncFolderRecursive(sync, file.id, localFile, depth + 1, incFileSynced); 364 | } else { 365 | //check if local file already exists 366 | fs.exists(localFile, function (exists) { 367 | if (exists) { 368 | // check if local size is equal to remote file size 369 | fs.stat(localFile, function (err, stats) { 370 | if (stats.size === file.size) { 371 | logv(2, ("File '" + file.name + "' already exists and will be skipped").yellow); 372 | if (sync.delete) { 373 | // delete remote file 374 | api.files.delete(file.id, function (delData) { 375 | if (delData.status === "OK") { 376 | logv(1, ("File '" + file.name + "' deleted on put.io").green); 377 | incFileSynced(); 378 | } 379 | else 380 | logv(0, ("Coudln't delete file '" + file.name + "' put.io").red); 381 | }) 382 | } else 383 | incFileSynced(); 384 | } else { 385 | logv(1, ("File '" + file.name + "' exists but has a different size. Will be redownloaded").yellow); 386 | enqueueDownload(sync, file, localFile, incFileSynced); 387 | } 388 | }); 389 | } else { 390 | // file doesn't exist locally -> download 391 | enqueueDownload(sync, file, localFile, incFileSynced); 392 | } 393 | }); 394 | } 395 | 396 | }); 397 | }); 398 | } 399 | 400 | /** 401 | * Sync the given remote and local path 402 | * @param sync sync config section 403 | * @param finishCallback Callback function for when the syncing finished 404 | */ 405 | var syncFolder = function (sync, finishCallback) { 406 | logv(1, ("Syncing folder '" + sync.remote_path + "' to '" + sync.local_path + "'...").yellow); 407 | apiHelper.findFolderId(sync.remote_path, function (id) { 408 | if (typeof id === "undefined") { 409 | logv(0, ("Remote folder '" + sync.remote_path + "' not found").red); 410 | finishCallback(); 411 | return; 412 | } 413 | syncFolderRecursive(sync, id, sync.local_path, 0, finishCallback); 414 | 415 | }) 416 | } 417 | 418 | /** 419 | * Start the sync process 420 | */ 421 | this.startSync = function () { 422 | totalFileCount = 0; 423 | currentDownloading = 0; 424 | downloadQueue = []; 425 | waitNextSyncTimeout = 0; 426 | 427 | var foldersToSync = config.sync.length; 428 | var foldersSynced = 0; 429 | 430 | _.each(config.sync, function (sync) { 431 | // Create download temp dir 432 | var tempDir = path.join(sync.local_path, download_temp_dir); 433 | if (!fs.existsSync(tempDir)) { 434 | fs.mkdirSync(tempDir); 435 | if(windows){ 436 | fswin.setAttributesSync(tempDir, { IS_HIDDEN: true }); 437 | } 438 | } 439 | 440 | // Trim leading and trailing slashes from the source path 441 | sync.remote_path = sync.remote_path.replace(/^\/|\/$/gi, ''); 442 | 443 | fs.exists(sync.local_path, function (exists) { 444 | if (exists) { 445 | syncFolder(sync, function() { 446 | foldersSynced++; 447 | if (foldersSynced === foldersToSync) { 448 | logv(1, ("Sync ended successfully").green); 449 | waitForNextExecution(); 450 | } 451 | }); 452 | } else { 453 | logv(0, ("The local folder '" + sync.local_path + "' doesn't exist").red) 454 | } 455 | }); 456 | }); 457 | 458 | } 459 | } 460 | 461 | // Establish the root object, `window` in the browser, or `exports` on the server. 462 | var root = this; 463 | 464 | // Export the Class object for **Node.js**, with 465 | // backwards-compatibility for the old `require()` API. If we're in 466 | // the browser, add `PutIOSync` as a global object via a string identifier, 467 | // for Closure Compiler "advanced" mode. 468 | if (typeof exports !== 'undefined') { 469 | if (typeof module !== 'undefined' && module.exports) { 470 | exports = module.exports = PutIOSync; 471 | } 472 | exports.PutIOSync = PutIOSync; 473 | } else { 474 | root.PutIOSync = PutIOSync; 475 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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 | --------------------------------------------------------------------------------