multiSSH3 4.99__tar.gz → 5.4__tar.gz

{multissh3-4.99 → multissh3-5.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: multiSSH3
-Version: 4.99
+Version: 5.4
 Summary: Run commands on multiple hosts via SSH
 Home-page: https://github.com/yufei-pan/multiSSH3
 Author: Yufei Pan

{multissh3-4.99 → multissh3-5.4}/multiSSH3.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: multiSSH3
-Version: 4.99
+Version: 5.4
 Summary: Run commands on multiple hosts via SSH
 Home-page: https://github.com/yufei-pan/multiSSH3
 Author: Yufei Pan

{multissh3-4.99 → multissh3-5.4}/multiSSH3.py

@@ -18,6 +18,7 @@ import glob
 import shutil
 import getpass
 import uuid
+import tempfile
 
 try:
 	# Check if functiools.cache is available
@@ -30,7 +31,7 @@ except AttributeError:
 		# If neither is available, use a dummy decorator
 		def cache_decorator(func):
 			return func
-version = '4.99'
+version = '5.04'
 VERSION = version
 
 CONFIG_FILE = '/etc/multiSSH3.config.json'	
@@ -94,7 +95,7 @@ __build_in_default_config = {
 	'DEFAULT_JSON_MODE': False,
 	'DEFAULT_PRINT_SUCCESS_HOSTS': False,
 	'DEFAULT_GREPPABLE_MODE': False,
-	'DEFAULT_SKIP_UNREACHABLE': False,
+	'DEFAULT_SKIP_UNREACHABLE': True,
 	'DEFAULT_SKIP_HOSTS': '',
 	'SSH_STRICT_HOST_KEY_CHECKING': False,
 	'ERROR_MESSAGES_TO_IGNORE': [
@@ -179,7 +180,7 @@ __DEBUG_MODE = __configs_from_file.get('__DEBUG_MODE', __build_in_default_config
 
 
 
-__global_suppress_printout = True
+__global_suppress_printout = False
 
 __mainReturnCode = 0
 __failedHosts = set()
@@ -979,7 +980,14 @@ def get_hosts_to_display (hosts, max_num_hosts, hosts_to_display = None):
 			host.printedLines = 0
 	return new_hosts_to_display , {'running':len(running_hosts), 'failed':len(failed_hosts), 'finished':len(finished_hosts), 'waiting':len(waiting_hosts)}
 
-def generate_display(stdscr, hosts, lineToDisplay = -1,curserPosition = 0, min_char_len = DEFAULT_CURSES_MINIMUM_CHAR_LEN, min_line_len = DEFAULT_CURSES_MINIMUM_LINE_LEN,single_window=DEFAULT_SINGLE_WINDOW):
+# Error: integer division or modulo by zero, Reloading Configuration: min_char_len=40, min_line_len=1, single_window=False with window size (61, 186) and 1 hosts...
+# Traceback (most recent call last):
+#   File "/usr/local/lib/python3.11/site-packages/multiSSH3.py", line 1030, in generate_display
+#     host_window_height = max_y // num_hosts_y
+#                          ~~~~~~^^~~~~~~~~~~~~
+# ZeroDivisionError: integer division or modulo by zero
+
+def generate_display(stdscr, hosts, lineToDisplay = -1,curserPosition = 0, min_char_len = DEFAULT_CURSES_MINIMUM_CHAR_LEN, min_line_len = DEFAULT_CURSES_MINIMUM_LINE_LEN,single_window=DEFAULT_SINGLE_WINDOW, config_reason= 'New Configuration'):
 	try:
 		org_dim = stdscr.getmaxyx()
 		new_configured = True
@@ -995,9 +1003,9 @@ def generate_display(stdscr, hosts, lineToDisplay = -1,curserPosition = 0, min_c
 			min_line_len_local = max_y-1
 		# return True if the terminal is too small
 		if max_x < 2 or max_y < 2:
-			return (lineToDisplay,curserPosition , min_char_len, min_line_len, single_window)
+			return (lineToDisplay,curserPosition , min_char_len, min_line_len, single_window, 'Terminal too small')
 		if min_char_len_local < 1 or min_line_len_local < 1:
-			return (lineToDisplay,curserPosition , min_char_len, min_line_len, single_window)
+			return (lineToDisplay,curserPosition , min_char_len, min_line_len, single_window, 'Minimum character or line length too small')
 		# We need to figure out how many hosts we can fit in the terminal
 		# We will need at least 2 lines per host, one for its name, one for its output
 		# Each line will be at least 61 characters long (60 for the output, 1 for the borders)
@@ -1005,14 +1013,14 @@ def generate_display(stdscr, hosts, lineToDisplay = -1,curserPosition = 0, min_c
 		max_num_hosts_y = max_y // (min_line_len_local + 1)
 		max_num_hosts = max_num_hosts_x * max_num_hosts_y
 		if max_num_hosts < 1:
-			return (lineToDisplay,curserPosition , min_char_len, min_line_len, single_window)
+			return (lineToDisplay,curserPosition , min_char_len, min_line_len, single_window, 'Terminal too small to display any hosts')
 		hosts_to_display , host_stats = get_hosts_to_display(hosts, max_num_hosts)
 		if len(hosts_to_display) == 0:
-			return (lineToDisplay,curserPosition , min_char_len, min_line_len, single_window)
+			return (lineToDisplay,curserPosition , min_char_len, min_line_len, single_window, 'No hosts to display')
 		# Now we calculate the actual number of hosts we will display for x and y
 		optimal_len_x = max(min_char_len_local, 80)
-		num_hosts_x = max(min(max_num_hosts_x, max_x // optimal_len_x),1)
-		num_hosts_y = len(hosts_to_display) // num_hosts_x
+		num_hosts_x = min(max(min(max_num_hosts_x, max_x // optimal_len_x),1),len(hosts_to_display))
+		num_hosts_y = len(hosts_to_display) // num_hosts_x + (len(hosts_to_display) % num_hosts_x > 0)
 		while num_hosts_y > max_num_hosts_y:
 			num_hosts_x += 1
 			# round up for num_hosts_y
@@ -1024,12 +1032,12 @@ def generate_display(stdscr, hosts, lineToDisplay = -1,curserPosition = 0, min_c
 					num_hosts_x += 1
 					num_hosts_y = len(hosts_to_display) // num_hosts_x + (len(hosts_to_display) % num_hosts_x > 0)
 				break
-
+		num_hosts_y = max(num_hosts_y,1)
 		# We calculate the size of each window
 		host_window_height = max_y // num_hosts_y
 		host_window_width = max_x // num_hosts_x
 		if host_window_height < 1 or host_window_width < 1:
-			return (lineToDisplay,curserPosition , min_char_len, min_line_len, single_window)
+			return (lineToDisplay,curserPosition , min_char_len, min_line_len, single_window, 'Host window too small')
 
 		old_stat = ''
 		old_bottom_stat = ''
@@ -1070,24 +1078,24 @@ def generate_display(stdscr, hosts, lineToDisplay = -1,curserPosition = 0, min_c
 				# with open('keylog.txt','a') as f:
 				#     f.write(str(key)+'\n')
 				if key == 410: # 410 is the key code for resize
-					return (lineToDisplay,curserPosition , min_char_len, min_line_len, single_window)         
+					return (lineToDisplay,curserPosition , min_char_len, min_line_len, single_window, 'Terminal resize requested')      
 				elif key == 95 and not __keyPressesIn[-1]: # 95 is the key code for _
 					# if last line is empty, we will reconfigure the wh to be smaller
 					if min_line_len != 1:
-						return (lineToDisplay,curserPosition , min_char_len , max(min_line_len -1,1), single_window)
+						return (lineToDisplay,curserPosition , min_char_len , max(min_line_len -1,1), single_window, 'Decrease line length')
 				elif key == 43 and not __keyPressesIn[-1]: # 43 is the key code for +
 					# if last line is empty, we will reconfigure the wh to be larger
-					return (lineToDisplay,curserPosition , min_char_len , min_line_len +1, single_window)
+					return (lineToDisplay,curserPosition , min_char_len , min_line_len +1, single_window, 'Increase line length')
 				elif key == 123 and not __keyPressesIn[-1]: # 123 is the key code for {
 					# if last line is empty, we will reconfigure the ww to be smaller
 					if min_char_len != 1:
-						return (lineToDisplay,curserPosition , max(min_char_len -1,1), min_line_len, single_window)
+						return (lineToDisplay,curserPosition , max(min_char_len -1,1), min_line_len, single_window, 'Decrease character length')
 				elif key == 124 and not __keyPressesIn[-1]: # 124 is the key code for |
 					# if last line is empty, we will toggle the single window mode
-					return (lineToDisplay,curserPosition , min_char_len, min_line_len, not single_window)
+					return (lineToDisplay,curserPosition , min_char_len, min_line_len, not single_window, 'Toggle single window mode')
 				elif key == 125 and not __keyPressesIn[-1]: # 125 is the key code for }
 					# if last line is empty, we will reconfigure the ww to be larger
-					return (lineToDisplay,curserPosition , min_char_len +1, min_line_len, single_window)
+					return (lineToDisplay,curserPosition , min_char_len +1, min_line_len, single_window, 'Increase character length')
 				# We handle positional keys
 				# if the key is up arrow, we will move the line to display up
 				elif key == 259: # 259 is the key code for up arrow
@@ -1146,7 +1154,7 @@ def generate_display(stdscr, hosts, lineToDisplay = -1,curserPosition = 0, min_c
 						curserPosition += 1
 			# reconfigure when the terminal size changes
 			if org_dim != stdscr.getmaxyx():
-				return (lineToDisplay,curserPosition , min_char_len, min_line_len, single_window)
+				return (lineToDisplay,curserPosition , min_char_len, min_line_len, single_window, 'Terminal resize detected')
 			# We generate the aggregated stats if user did not input anything
 			if not __keyPressesIn[lineToDisplay]:
 				stats = '┍'+ f" Total: {len(hosts)} Running: {host_stats['running']} Failed: {host_stats['failed']} Finished: {host_stats['finished']} Waiting: {host_stats['waiting']}  ww: {min_char_len} wh:{min_line_len} "[:max_x - 2].center(max_x - 2, "━")
@@ -1211,11 +1219,12 @@ def generate_display(stdscr, hosts, lineToDisplay = -1,curserPosition = 0, min_c
 						# print(str(e).strip())
 						# print(traceback.format_exc().strip())
 						if org_dim != stdscr.getmaxyx():
-							return (lineToDisplay,curserPosition , min_char_len, min_line_len, single_window)
+							return (lineToDisplay,curserPosition , min_char_len, min_line_len, single_window, 'Terminal resize detected')
 			new_configured = False
 			last_refresh_time = time.perf_counter()
 	except Exception as e:
-		return (lineToDisplay,curserPosition , min_char_len, min_line_len, single_window)
+		import traceback
+		return (lineToDisplay,curserPosition , min_char_len, min_line_len, single_window, f'Error: {str(e)}',traceback.format_exc())
 	return None
 
 def curses_print(stdscr, hosts, threads, min_char_len = DEFAULT_CURSES_MINIMUM_CHAR_LEN, min_line_len = DEFAULT_CURSES_MINIMUM_LINE_LEN,single_window = DEFAULT_SINGLE_WINDOW):
@@ -1254,7 +1263,12 @@ def curses_print(stdscr, hosts, threads, min_char_len = DEFAULT_CURSES_MINIMUM_C
 	curses.init_pair(18, curses.COLOR_BLACK, curses.COLOR_BLUE)
 	curses.init_pair(19, curses.COLOR_BLACK, curses.COLOR_MAGENTA)
 	curses.init_pair(20, curses.COLOR_BLACK, curses.COLOR_CYAN)
-	params = (-1,0 , min_char_len, min_line_len, single_window)
+
+	# do not generate display if the output window have a size of zero
+	if stdscr.getmaxyx()[0] < 2 or stdscr.getmaxyx()[1] < 2:
+		return
+
+	params = (-1,0 , min_char_len, min_line_len, single_window,'new config')
 	while params:
 		params = generate_display(stdscr, hosts, *params)
 		if not params:
@@ -1264,8 +1278,19 @@ def curses_print(stdscr, hosts, threads, min_char_len = DEFAULT_CURSES_MINIMUM_C
 			break
 		# print the current configuration
 		stdscr.clear()
-		stdscr.addstr(0, 0, f"Loading Configuration: min_char_len={params[2]}, min_line_len={params[3]}, single_window={params[4]}")
-		stdscr.refresh()
+		try:
+			stdscr.addstr(0, 0, f"{params[5]}, Reloading Configuration: min_char_len={params[2]}, min_line_len={params[3]}, single_window={params[4]} with window size {stdscr.getmaxyx()} and {len(hosts)} hosts...")
+			if len(params) > 6:
+				# traceback is available, print it
+				i = 1
+				for line in params[6].split('\n'):
+					stdscr.addstr(i, 0, line)
+					i += 1
+			stdscr.refresh()
+		except:
+			pass
+		params = params[:5]
+		time.sleep(0.01)
 		#time.sleep(0.25)
 
 
@@ -1302,9 +1327,10 @@ def print_output(hosts,usejson = False,quiet = False,greppable = False):
 				outputs[hostPrintOut] = [host['name']]
 			else:
 				outputs[hostPrintOut].append(host['name'])
-		rtnStr = ''
+		rtnStr = '*'*80+'\n'
 		for output, hosts in outputs.items():
 			rtnStr += f"{','.join(hosts)}{output}\n"
+			rtnStr += '*'*80+'\n'
 		if __keyPressesIn[-1]:
 			CMDsOut = [''.join(cmd).encode('unicode_escape').decode().replace('\\n', '↵') for cmd in __keyPressesIn if cmd]
 			rtnStr += 'User Inputs: '+ '\nUser Inputs: '.join(CMDsOut)
@@ -1416,13 +1442,45 @@ def processRunOnHosts(timeout, password, max_connections, hosts, returnUnfinishe
 			thread.join(timeout=3)
 	# update the unavailable hosts and global unavailable hosts
 	if willUpdateUnreachableHosts:
+		unavailableHosts = set(unavailableHosts)
 		unavailableHosts.update([host.name for host in hosts if host.stderr and ('No route to host' in host.stderr[0].strip() or host.stderr[0].strip().startswith('Timeout!'))])
+		# reachable hosts = all hosts - unreachable hosts
+		reachableHosts = set([host.name for host in hosts]) - unavailableHosts
 		if __DEBUG_MODE:
 			print(f'Unreachable hosts: {unavailableHosts}')
 		__globalUnavailableHosts.update(unavailableHosts)
-		# update the os environment variable if not _no_env
-		if not _no_env:
-			os.environ['__multiSSH3_UNAVAILABLE_HOSTS'] = ','.join(unavailableHosts)
+
+		# os.environ['__multiSSH3_UNAVAILABLE_HOSTS'] = ','.join(unavailableHosts)
+		# create a temporary file to store the unavailable hosts
+		try:
+			# check for the old content, only update if the new content is different
+			if not os.path.exists(os.path.join(tempfile.gettempdir(),'__multiSSH3_UNAVAILABLE_HOSTS.csv')):
+				with open(os.path.join(tempfile.gettempdir(),'__multiSSH3_UNAVAILABLE_HOSTS.csv'),'w') as f:
+					f.write(f',{int(time.time())}\n'.join(unavailableHosts) + f',{int(time.time())}\n')
+			else:
+				oldDic = {}
+				try:
+					with open(os.path.join(tempfile.gettempdir(),'__multiSSH3_UNAVAILABLE_HOSTS.csv'),'r') as f:
+						for line in f:
+							line = line.strip()
+							if line and ',' in line and len(line.split(',')) >= 2 and line.split(',')[0] and line.split(',')[1].isdigit():
+								oldDic[line.split(',')[0]] = int(line.split(',')[1])
+				except:
+					pass
+				# remove entries that are either available now or older than min(timeout,3600) seconds
+				for key in list(oldDic.keys()):
+					if key in reachableHosts or time.time() - oldDic[key] > min(timeout,3600):
+						del oldDic[key]
+				# add new entries
+				for host in unavailableHosts:
+					oldDic[host] = int(time.time())
+				with open(os.path.join(tempfile.gettempdir(),'__multiSSH3_UNAVAILABLE_HOSTS.csv.new'),'w') as f:
+					for key, value in oldDic.items():
+						f.write(f'{key},{value}\n')
+				os.replace(os.path.join(tempfile.gettempdir(),'__multiSSH3_UNAVAILABLE_HOSTS.csv.new'),os.path.join(tempfile.gettempdir(),'__multiSSH3_UNAVAILABLE_HOSTS.csv'))
+				
+		except Exception as e:
+			eprint(f'Error writing to temporary file: {e}')
 
 	# print the output, if the output of multiple hosts are the same, we aggragate them
 	if not called:
@@ -1555,10 +1613,30 @@ def run_command_on_hosts(hosts = DEFAULT_HOSTS,commands = None,oneonone = DEFAUL
 	global __DEBUG_MODE
 	_emo = False
 	_no_env = no_env
-	if not no_env and '__multiSSH3_UNAVAILABLE_HOSTS' in os.environ:
-		__globalUnavailableHosts = set(os.environ['__multiSSH3_UNAVAILABLE_HOSTS'].split(','))
+	if os.path.exists(os.path.join(tempfile.gettempdir(),'__multiSSH3_UNAVAILABLE_HOSTS.csv')):
+		if timeout <= 0:
+			checkTime = DEFAULT_TIMEOUT
+		else:
+			checkTime = timeout
+		if checkTime <= 0:
+			checkTime = 60
+		elif checkTime > 3600:
+			checkTime = 3600
+		try:
+			if 0 < time.time() - os.path.getmtime(os.path.join(tempfile.gettempdir(),'__multiSSH3_UNAVAILABLE_HOSTS.csv')) < checkTime:
+				if not __global_suppress_printout:
+					eprint(f"Reading unavailable hosts from the file {os.path.join(tempfile.gettempdir(),'__multiSSH3_UNAVAILABLE_HOSTS.csv')}")
+				with open(os.path.join(tempfile.gettempdir(),'__multiSSH3_UNAVAILABLE_HOSTS.csv'),'r') as f:
+					for line in f:
+						line = line.strip()
+						if line and ',' in line and len(line.split(',')) >= 2 and line.split(',')[0] and line.split(',')[1].isdigit():
+							if int(line.split(',')[1]) > time.time() - checkTime:
+								__globalUnavailableHosts.add(line.split(',')[0])
+		except Exception as e:
+			eprint(f"Warning: Unable to read the unavailable hosts from the file {os.path.join(tempfile.gettempdir(),'__multiSSH3_UNAVAILABLE_HOSTS.csv')}")
+			eprint(str(e))
 	elif '__multiSSH3_UNAVAILABLE_HOSTS' in readEnvFromFile():
-		__globalUnavailableHosts = set(readEnvFromFile()['__multiSSH3_UNAVAILABLE_HOSTS'].split(','))
+		__globalUnavailableHosts.update(readEnvFromFile()['__multiSSH3_UNAVAILABLE_HOSTS'].split(','))
 	if not max_connections:
 		max_connections = 4 * os.cpu_count()
 	elif max_connections == 0:
@@ -1842,7 +1920,7 @@ def main():
 	parser.add_argument("-j","--json", action='store_true', help=F"Output in json format. (default: {DEFAULT_JSON_MODE})", default=DEFAULT_JSON_MODE)
 	parser.add_argument("--success_hosts", action='store_true', help=f"Output the hosts that succeeded in summary as wells. (default: {DEFAULT_PRINT_SUCCESS_HOSTS})", default=DEFAULT_PRINT_SUCCESS_HOSTS)
 	parser.add_argument("-g","--greppable", action='store_true', help=f"Output in greppable format. (default: {DEFAULT_GREPPABLE_MODE})", default=DEFAULT_GREPPABLE_MODE)
-	parser.add_argument("-su","--skip_unreachable", action='store_true', help=f"Skip unreachable hosts while using --repeat. Note: Timedout Hosts are considered unreachable. Note: multiple command sequence will still auto skip unreachable hosts. (default: {DEFAULT_SKIP_UNREACHABLE})", default=DEFAULT_SKIP_UNREACHABLE)
+	parser.add_argument("-su","--skip_unreachable", action='store_true', help=f"Skip unreachable hosts. Note: Timedout Hosts are considered unreachable. Note: multiple command sequence will still auto skip unreachable hosts. (default: {DEFAULT_SKIP_UNREACHABLE})", default=DEFAULT_SKIP_UNREACHABLE)
 	parser.add_argument("-sh","--skip_hosts", type=str, help=f"Skip the hosts in the list. (default: {DEFAULT_SKIP_HOSTS if DEFAULT_SKIP_HOSTS else 'None'})", default=DEFAULT_SKIP_HOSTS)
 	parser.add_argument('--store_config_file', action='store_true', help=f'Store / generate the default config file from command line argument and current config at {CONFIG_FILE}')
 	parser.add_argument('--debug', action='store_true', help='Print debug information')
@@ -1940,15 +2018,16 @@ def main():
 
 	__ipmiiInterfaceIPPrefix = args.ipmi_interface_ip_prefix
 
-	if not args.greppable and not args.json and not args.no_output:
-		__global_suppress_printout = False
+	if args.no_output:
+		__global_suppress_printout = True
 
 	if not __global_suppress_printout:
-		eprint('> ' + getStrCommand(args.hosts,args.commands,oneonone=args.oneonone,timeout=args.timeout,password=args.password,
+		cmdStr = getStrCommand(args.hosts,args.commands,oneonone=args.oneonone,timeout=args.timeout,password=args.password,
 						 nowatch=args.nowatch,json=args.json,called=args.no_output,max_connections=args.max_connections,
 						 files=args.file,file_sync=args.file_sync,ipmi=args.ipmi,interface_ip_prefix=args.interface_ip_prefix,scp=args.scp,gather_mode = args.gather_mode,username=args.username,
 						 extraargs=args.extraargs,skipUnreachable=args.skip_unreachable,no_env=args.no_env,greppable=args.greppable,skip_hosts = args.skip_hosts,
-						 curses_min_char_len = args.window_width, curses_min_line_len = args.window_height,single_window=args.single_window,error_only=args.error_only,identity_file=args.key))
+						 curses_min_char_len = args.window_width, curses_min_line_len = args.window_height,single_window=args.single_window,error_only=args.error_only,identity_file=args.key)
+		eprint('> ' + cmdStr)
 	if args.error_only:
 		__global_suppress_printout = True
 

{multissh3-4.99 → multissh3-5.4}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup
 
 setup(
     name='multiSSH3',
-    version='4.99',
+    version='5.04',
     description='Run commands on multiple hosts via SSH',
     long_description=open('README.md').read(),
     long_description_content_type='text/markdown',