Added password prompt when omitted in config

The password prompt will be shown on demand and the password will be cached (as long as it is correct) until Sublime Text is closed
Fixes #18

README.md

@@ -38,6 +38,8 @@ Minimal `simple-ftp-deploy.json` file:
 }
 ```
 
+**Note:** Password is optional. If omitted, you will be asked for it once needed.
+
 ### Format
 The format is [JSON](https://www.json.org), so every property consists of a key-value pair:
 ```json
@@ -77,8 +79,8 @@ The port of the FTP server.
 `"username"` *string*  
 The username.
 
-`"password"` *string*  
-The password.
+`"password"` *string, optional*  
+The password. If not given, you will be asked for it once needed.
 
 `"rootDirectory"` *string, optional (default: `"/"`)*  
 The FTP path to deploy.  

main.py

@@ -31,12 +31,14 @@
 import sys
 import time
 
-REQUIRED_FIELDS = ['host', 'username', 'password']
+REQUIRED_FIELDS = ['host', 'username']
 
 CONFIG_FILE_NAME = 'simple-ftp-deploy.json'
 
 FTP_SESSIONS = []
 
+SAVED_LOGINS = {}
+
 def ignored(path, config):
 	filename, extension = os.path.splitext(path)
 
@@ -128,7 +130,13 @@ def __init__(self, config):
 		self.host = config.get('host')
 		self.port = config.get('port', 21)
 		self.username = config.get('username')
-		self.password = config.get('password')
+
+		if not config.get('password'):
+			if (config.get('host'), config.get('port', 21), config.get('username')) in SAVED_LOGINS:
+				self.password = SAVED_LOGINS[(self.host, self.port, self.username)]
+		else:
+			self.password = config.get('password')
+
 		self.rootDir = config.get('rootDirectory', '')
 		self.timeout = config.get('connectionTimeout', 600)
 		self.TLS = config.get('useTLS', False)
@@ -187,7 +195,7 @@ def connect(self):
 					session['timestamp'] = time.time()
 
 					# As the session is ready to use, we are done
-					return
+					return True
 
 		# Create new session
 		if self.TLS:
@@ -211,7 +219,7 @@ def connect(self):
 			self.session.connect(self.host, self.port)
 		except ftplib.all_errors as e:
 			error('Could not connect to ' + self.host + ':' + str(self.port) + '\n' + str(e))
-			return
+			return False
 
 		# Secure with TLS
 		if self.TLS:
@@ -226,8 +234,12 @@ def connect(self):
 		try:
 			self.session.login(self.username, self.password)
 		except ftplib.all_errors as e:
+			# If it happened from saved logins, discard it, so it would ask for new password again
+			if (self.host, self.port, self.username) in SAVED_LOGINS:
+				SAVED_LOGINS.pop((self.host, self.port, self.username))
+
 			error('Could not login to ' + self.host + ':' + str(self.port) + '\n' + str(e))
-			return
+			return False
 
 		end = time.time()
 
@@ -246,6 +258,8 @@ def connect(self):
 				'session': self.session
 			})
 
+		return True
+
 	def parsePath(self, rootDir, fullPath):
 		# Remove full path and remove \
 		localFilePath = os.path.dirname(fullPath).replace(rootDir, '')[1:]
@@ -333,6 +347,9 @@ def set(self, name, value):
 	def get(self, name, defaultValue = None):
 		return self.config[name] if self.config and name in self.config else defaultValue
 
+	def has(self, name):
+		return self.config and name in self.config
+
 # Save file event listener
 class EventListener(sublime_plugin.EventListener):
 	def on_post_save_async(self, view):
@@ -353,13 +370,24 @@ def on_post_save_async(self, view):
 
 				if not ignored(filename, config):
 					# Upload
-					ftp = FTP(config)
-					ftp.connect()
-					ftp.upload(folder, filename)
+					def run():
+						ftp = FTP(config)
+						if ftp.connect():
+							ftp.upload(folder, filename)
 
-					process_triggers(config.get('triggers', []), folder, filename, 'save', {'ftp': ftp, 'config': config, 'sublime': sublime, 'msg': msg, 'error': error, 'ask': ask})
+							process_triggers(config.get('triggers', []), folder, filename, 'save', {'ftp': ftp, 'config': config, 'sublime': sublime, 'msg': msg, 'error': error, 'ask': ask})
 
-					ftp.exit()
+							ftp.exit()
+
+					if not config.has('password') and (config.get('host'), config.get('port', 21), config.get('username')) not in SAVED_LOGINS:
+						def on_password_done(input):
+							SAVED_LOGINS[(config.get('host'), config.get('port', 21), config.get('username'))] = input
+
+							run()
+
+						window.show_input_panel('FTP Password', '', on_password_done, None, None)
+					else:
+						run()
 
 	def on_post_window_command(self, window, command, args):
 		if not window.project_data():
@@ -385,13 +413,26 @@ def on_post_window_command(self, window, command, args):
 
 						if not ignored(filename, config):
 							# Delete
-							ftp = FTP(config)
-							ftp.connect()
-							ftp.delete(folder, filename)
+							def run():
+								ftp = FTP(config)
+								if ftp.connect():
+									ftp.delete(folder, filename)
 
-							process_triggers(config.get('triggers', []), folder, filename, 'delete', {'ftp': ftp, 'config': config, 'sublime': sublime, 'msg': msg, 'error': error, 'ask': ask})
+									process_triggers(config.get('triggers', []), folder, filename, 'delete', {'ftp': ftp, 'config': config, 'sublime': sublime, 'msg': msg, 'error': error, 'ask': ask})
 
-							ftp.exit()
+									ftp.exit()
+
+							# Upload
+							if not config.has('password') and (config.get('host'), config.get('port', 21), config.get('username')) not in SAVED_LOGINS:
+								def on_password_done(input):
+									SAVED_LOGINS[(config.get('host'), config.get('port', 21), config.get('username'))] = input
+
+									run()
+
+
+								window.show_input_panel('FTP Password', '', on_password_done, None, None)
+							else:
+								run()
 
 						break
 

messages.json

@@ -0,0 +1,3 @@
+{
+	"1.8.0": "messages/1.8.0.md"
+}

messages/1.8.0.md

@@ -0,0 +1,5 @@
+# 1.8.0 - Added option to enter password at runtime
+
+## New features
+* If password is omitted in config, password prompt will appear once it is needed
+* Password entered to password prompt is cached until you close Sublime Text. This means that you will have to enter password only once (as long as it is correct)