def main(): import sys from Naked.commandline import Command from Naked.toolshed.state import StateObject c = Command(sys.argv[0], sys.argv[1:]) if not c.command_suite_validates(): from jampack.settings import usage as jampack_usage print(jampack_usage) sys.exit(1) if c.help(): # User requested jampack help information from jampack.settings import help as jampack_help print(jampack_help) sys.exit(0) elif c.usage(): # User requested jampack usage information from jampack.settings import usage as jampack_usage print(jampack_usage) sys.exit(0) elif c.version(): # User requested jampack version information from jampack.settings import app_name, major_version, minor_version, patch_version version_display_string = app_name + ' ' + major_version + '.' + minor_version + '.' + patch_version print(version_display_string) sys.exit(0) else: # just display usage information with this executable. Users need to use jam or unjam from jampack.settings import usage as jampack_usage print(jampack_usage) sys.exit(0)
def main(): import sys from Naked.commandline import Command #------------------------------------------------------------------------------------------ # [ Instantiate command line object ] # used for all subsequent conditional logic in the CLI application #------------------------------------------------------------------------------------------ c = Command(sys.argv[0], sys.argv[1:]) #------------------------------------------------------------------------------------------ # [ Command Suite Validation ] - early validation of appropriate command syntax # Test that user entered at least one argument to the executable, print usage if not #------------------------------------------------------------------------------------------ if not c.app_validates_args(): from helpy.settings import usage as helpy_usage print(helpy_usage) sys.exit(1) #------------------------------------------------------------------------------------------ # [ NAKED FRAMEWORK COMMANDS ] # Naked framework provides default help, usage, and version commands for all applications # --> settings for user messages are assigned in the lib/pyh/settings.py file #------------------------------------------------------------------------------------------ if c.help(): # User requested pyh help information from helpy.settings import help as helpy_help print(helpy_help) sys.exit(0) elif c.usage(): # User requested pyh usage information from helpy.settings import usage as helpy_usage print(helpy_usage) sys.exit(0) elif c.version(): # User requested pyh version information from helpy.settings import app_name, major_version, minor_version, patch_version version_display_string = app_name + ' ' + major_version + '.' + minor_version + '.' + patch_version print(version_display_string) sys.exit(0) #------------------------------------------------------------------------------------------ # [ PRIMARY COMMAND LOGIC ] # Enter your command line parsing logic below #------------------------------------------------------------------------------------------ if c.argc > 1: from helpy.settings import usage as helpy_usage print(helpy_usage) sys.exit(1) elif c.argc == 1: from helpy.commands.pyhelp import print_help_for print_help_for(c.first) #------------------------------------------------------------------------------------------ # [ DEFAULT MESSAGE FOR MATCH FAILURE ] # Message to provide to the user when all above conditional logic fails to meet a true condition #------------------------------------------------------------------------------------------ else: print( "Could not complete the command that you entered. Please try again." ) sys.exit(1) #exit
def main(): import sys from Naked.commandline import Command #------------------------------------------------------------------------------------------ # [ Instantiate command line object ] # used for all subsequent conditional logic in the CLI application #------------------------------------------------------------------------------------------ c = Command(sys.argv[0], sys.argv[1:]) #------------------------------------------------------------------------------------------ # [ Command Suite Validation ] - early validation of appropriate command syntax # Test that user entered at least one argument to the executable, print usage if not #------------------------------------------------------------------------------------------ if not c.app_validates_args(): from helpy.settings import usage as helpy_usage print(helpy_usage) sys.exit(1) #------------------------------------------------------------------------------------------ # [ NAKED FRAMEWORK COMMANDS ] # Naked framework provides default help, usage, and version commands for all applications # --> settings for user messages are assigned in the lib/pyh/settings.py file #------------------------------------------------------------------------------------------ if c.help(): # User requested pyh help information from helpy.settings import help as helpy_help print(helpy_help) sys.exit(0) elif c.usage(): # User requested pyh usage information from helpy.settings import usage as helpy_usage print(helpy_usage) sys.exit(0) elif c.version(): # User requested pyh version information from helpy.settings import app_name, major_version, minor_version, patch_version version_display_string = app_name + ' ' + major_version + '.' + minor_version + '.' + patch_version print(version_display_string) sys.exit(0) #------------------------------------------------------------------------------------------ # [ PRIMARY COMMAND LOGIC ] # Enter your command line parsing logic below #------------------------------------------------------------------------------------------ if c.argc > 1: from helpy.settings import usage as helpy_usage print(helpy_usage) sys.exit(1) elif c.argc == 1: from helpy.commands.pyhelp import print_help_for print_help_for(c.first) #------------------------------------------------------------------------------------------ # [ DEFAULT MESSAGE FOR MATCH FAILURE ] # Message to provide to the user when all above conditional logic fails to meet a true condition #------------------------------------------------------------------------------------------ else: print("Could not complete the command that you entered. Please try again.") sys.exit(1) #exit
def main(): import sys from Naked.commandline import Command user_platform = platform.system() # ------------------------------------------------------------------------------------------ # [ Instantiate Naked framework command line object ] # used for all subsequent conditional logic in the CLI application # ------------------------------------------------------------------------------------------ c = Command(sys.argv[0], sys.argv[1:]) if not c.command_suite_validates(): from jampack.settings import usage as jampack_usage print(jampack_usage) sys.exit(1) if c.help(): # User requested jampack help information from jampack.settings import help as jampack_help print(jampack_help) sys.exit(0) elif c.usage(): # User requested jampack usage information from jampack.settings import usage as jampack_usage print(jampack_usage) sys.exit(0) elif c.version(): # User requested jampack version information from jampack.settings import app_name, major_version, minor_version, patch_version version_display_string = app_name + ' ' + major_version + '.' + minor_version + '.' + patch_version print(version_display_string) sys.exit(0) if c.argc > 0: # if there is an argument to the executable try: for archive_name in c.argv: lowercase_archive_name = archive_name.lower() if lowercase_archive_name.endswith('.zip'): if zipfile.is_zipfile(archive_name): zipper = zipfile.ZipFile(archive_name, mode="r") zipper.extractall() if user_platform == "Windows": stdout("'" + archive_name + "' was unpacked.") else: stdout("[\033[32m✓\033[0m] '" + archive_name + "' was unpacked.") else: if user_platform == "Windows": stderr("'" + archive_name + "' does not appear to be a zip file") else: stderr("[\033[31m!\033[0m] '" + archive_name + "' does not appear to be a zip file") elif lowercase_archive_name.endswith('.tar.gz') or lowercase_archive_name.endswith('.tgz') or lowercase_archive_name.endswith('.tar.gzip'): if tarfile.is_tarfile(archive_name): tarball = tarfile.open(archive_name, mode="r:gz") tarball.extractall() if user_platform == "Windows": stdout("'" + archive_name + "' was unpacked.") else: stdout("[\033[32m✓\033[0m] '" + archive_name + "' was unpacked.") else: if user_platform == "Windows": stderr("'" + archive_name + "' does not appear to be a tar archive") else: stderr("[\033[31m!\033[0m] '" + archive_name + "' does not appear to be a tar archive") elif lowercase_archive_name.endswith('.tar.bz2') or lowercase_archive_name.endswith('.tar.bzip2'): if tarfile.is_tarfile(archive_name): bzball = tarfile.open(archive_name, mode="r:bz2") bzball.extractall() if user_platform == "Windows": stdout("'" + archive_name + "' was unpacked.") else: stdout("[\033[32m✓\033[0m] '" + archive_name + "' was unpacked.") else: if user_platform == "Windows": stderr("'" + archive_name + "' does not appear to be a tar archive") else: stderr("[\033[31m!\033[0m] '" + archive_name + "' does not appear to be a tar archive") else: if user_platform == "Windows": stderr("Unable to identify the archive type for '" + archive_name + "'. This archive was not unpacked. Please check the file extension and try again.") else: stderr("[\033[31m!\033[0m] Unable to identify the archive type for '" + archive_name + "'. This archive was not unpacked. Please check the file extension and try again.") except Exception as e: if user_platform == "Windows": stderr("Unable to unpack the archive '" + archive_name + "'. Error: " + str(e)) else: stderr( "[\033[31m!\033[0m] Unable to unpack the archive '" + archive_name + "'. Error: " + str(e)) # ------------------------------------------------------------------------------------------ # [ DEFAULT MESSAGE FOR MATCH FAILURE ] # Message to provide to the user when all above conditional logic fails to meet a true condition # ------------------------------------------------------------------------------------------ else: if user_platform == "Windows": print("Could not complete the command that you entered. Please try again.") else: print("[\033[31mX\033[0m] Could not complete the command that you entered. Please try again.") sys.exit(1) # exit
def main(): import sys import getpass from Naked.commandline import Command from Naked.toolshed.shell import muterun from Naked.toolshed.system import dir_exists, directory, filename, file_exists, list_all_files, make_path, stdout, stderr #------------------------------------------------------------------------------------------ # [ Instantiate command line object ] # used for all subsequent conditional logic in the CLI application #------------------------------------------------------------------------------------------ c = Command(sys.argv[0], sys.argv[1:]) #------------------------------------------------------------------------------------------ # [ VALIDATION LOGIC ] - early validation of appropriate command syntax # Test that user entered at least one argument to the executable, print usage if not #------------------------------------------------------------------------------------------ if not c.command_suite_validates(): from crypto.settings import usage as crypto_usage print(crypto_usage) sys.exit(1) #------------------------------------------------------------------------------------------ # [ HELP, VERSION, USAGE LOGIC ] # Naked framework provides default help, usage, and version commands for all applications # --> settings for user messages are assigned in the lib/crypto/settings.py file #------------------------------------------------------------------------------------------ if c.help(): # User requested crypto help information from crypto.settings import help as crypto_help print(crypto_help) sys.exit(0) elif c.usage(): # User requested crypto usage information from crypto.settings import usage as crypto_usage print(crypto_usage) sys.exit(0) elif c.version(): # User requested crypto version information from crypto.settings import app_name, major_version, minor_version, patch_version version_display_string = app_name + ' ' + major_version + '.' + minor_version + '.' + patch_version print(version_display_string) sys.exit(0) #------------------------------------------------------------------------------------------ # [ APPLICATION LOGIC ] # #------------------------------------------------------------------------------------------ elif c.argc > 1: # code for multi-file processing and commands that include options ## ASCII ARMOR SWITCH ascii_armored = False if c.option('--armor') or c.option('-a'): ascii_armored = True ## MAX COMPRESS / COMPRESS ALL SWITCH max_compress = False if c.option('--space'): max_compress = True ## NO COMPRESSION SWITCH no_compress = False if c.option('--speed'): no_compress = True ## SECURE HASH DIGEST REPORT SWITCH report_checksum = False if c.option('--hash'): report_checksum = True path_list = [] # user entered paths from command line directory_list = [] # directory paths included in the user entered paths from the command line file_list = [] # file paths included in the user entered paths from the command line (and inside directories entered) # dot and .crypt file flags for exclusion testing contained_dot_file = False contained_crypt_file = False # determine if argument is an existing file or directory for argument in c.argv: if file_exists(argument): if argument.endswith('.crypt'): # do not include previously encrypted files contained_crypt_file = True else: file_list.append(argument) # add appropriate file paths to the file_list elif dir_exists(argument): directory_list.append(argument) # if it is a directory, add path to the directory_list # add all file paths from user specified directories to the file_list if len(directory_list) > 0: for directory in directory_list: directory_file_list = list_all_files(directory) for contained_file in directory_file_list: if contained_file[0] == ".": contained_dot_file = True # change the flag + is not included in file_list intentionally (no dot files) elif contained_file.endswith('.crypt'): contained_crypt_file = True # change the flag + is not included in file_list intentionally (no previously encrypted files) else: # otherwise add to the list for encryption contained_file_path = make_path(directory, contained_file) file_list.append(contained_file_path) # confirm that there are files to be encrypted, if not warn user if len(file_list) == 0: if contained_dot_file == True or contained_crypt_file == True: stderr("There were no files identified for encryption. crypto does not encrypt dot files or previously encrypted '.crypt' files.") sys.exit(1) else: stderr("Unable to identify files for encryption") sys.exit(1) else: # file_list should contain all filepaths from either user specified file paths or contained in top level of directory, encrypt them passphrase = getpass.getpass("Please enter your passphrase: ") if len(passphrase) == 0: # confirm that user entered a passphrase stderr("You did not enter a passphrase. Please repeat your command and try again.") sys.exit(1) passphrase_confirm = getpass.getpass("Please enter your passphrase again: ") if passphrase == passphrase_confirm: from crypto.library.cryptor import Cryptor the_cryptor = Cryptor(passphrase) # run encryption based upon any passed switches if ascii_armored: if max_compress: the_cryptor.encrypt_files(file_list, force_nocompress=False, force_compress=True, armored=True, checksum=report_checksum) elif no_compress: the_cryptor.encrypt_files(file_list, force_nocompress=True, force_compress=False, armored=True, checksum=report_checksum) else: the_cryptor.encrypt_files(file_list, force_nocompress=False, force_compress=False, armored=True, checksum=report_checksum) else: if max_compress: the_cryptor.encrypt_files(file_list, force_nocompress=False, force_compress=True, armored=False, checksum=report_checksum) elif no_compress: the_cryptor.encrypt_files(file_list, force_nocompress=True, force_compress=False, armored=False, checksum=report_checksum) else: the_cryptor.encrypt_files(file_list, force_nocompress=False, force_compress=False, armored=False, checksum=report_checksum) # overwrite user entered passphrases passphrase = "" passphrase_confirm = "" the_cryptor.cleanup() else: # passphrases did not match, report to user and abort # overwrite user entered passphrases passphrase = "" passphrase_confirm = "" stderr("The passphrases did not match. Please enter your command again.") sys.exit(1) elif c.argc == 1: # simple single file or directory processing with default settings path = c.arg0 if file_exists(path): # it is a file, encrypt the single file with default settings # confirm that it is not already encrypted, abort if so if path.endswith('.crypt'): stderr("You are attempting to encrypt an encrypted file. Please delete the .crypt file and repeat encryption with the original file if this is your intent.") sys.exit(1) # if passes test above, obtain passphrase from the user passphrase = getpass.getpass("Please enter your passphrase: ") if len(passphrase) == 0: # confirm that user entered a passphrase stderr("You did not enter a passphrase. Please repeat your command and try again.") sys.exit(1) passphrase_confirm = getpass.getpass("Please enter your passphrase again: ") if passphrase == passphrase_confirm: from crypto.library.cryptor import Cryptor the_cryptor = Cryptor(passphrase) the_cryptor.encrypt_file(path) the_cryptor.cleanup() else: stderr("The passphrases did not match. Please enter your command again.") sys.exit(1) elif dir_exists(path): # it is a directory, encrypt all top level files with default settings dirty_directory_file_list = list_all_files(path) # remove dot files and previously encrypted files (with .crypt suffix) from the list of directory files clean_directory_file_list = [x for x in dirty_directory_file_list if x[0] != "." and x.endswith(".crypt") == False] # remove dotfiles and .crypt files # confirm that there are still files in the list after the dot files and encrypted files are removed if len(clean_directory_file_list) == 0: stderr("There are no unencrypted files in the directory.") sys.exit(1) # create relative file paths for each file in the clean_directory_file_list clean_directory_file_list_relpaths = [] for clean_file in clean_directory_file_list: new_file_path = make_path(path, clean_file) clean_directory_file_list_relpaths.append(new_file_path) #prompt for the passphrase passphrase = getpass.getpass("Please enter your passphrase: ") if len(passphrase) == 0: # confirm that user entered a passphrase stderr("You did not enter a passphrase. Please repeat your command and try again.") sys.exit(1) passphrase_confirm = getpass.getpass("Please enter your passphrase again: ") if passphrase == passphrase_confirm: from crypto.library.cryptor import Cryptor the_cryptor = Cryptor(passphrase) the_cryptor.encrypt_files(clean_directory_file_list_relpaths) #encrypt the list of directory files the_cryptor.cleanup() else: # passphrases do not match # overwrite user entered passphrases passphrase = "" passphrase_confirm = "" stderr("The passphrases did not match. Please enter your command again.") sys.exit(1) else: # error message, not a file or directory. user entry error stderr("The path that you entered does not appear to be an existing file or directory. Please try again.") sys.exit(1) #------------------------------------------------------------------------------------------ # [ DEFAULT MESSAGE FOR MATCH FAILURE ] # Message to provide to the user when all above conditional logic fails to meet a true condition #------------------------------------------------------------------------------------------ else: print("Could not complete your request. Please try again.") sys.exit(1)
def main(): import sys import getpass from Naked.commandline import Command from Naked.toolshed.shell import muterun from Naked.toolshed.system import dir_exists, directory, filename, file_exists, list_all_files, make_path, stdout, stderr #------------------------------------------------------------------------------------------ # [ Instantiate command line object ] # used for all subsequent conditional logic in the CLI application #------------------------------------------------------------------------------------------ c = Command(sys.argv[0], sys.argv[1:]) #------------------------------------------------------------------------------------------ # [ VALIDATION LOGIC ] - early validation of appropriate command syntax # Test that user entered at least one argument to the executable, print usage if not #------------------------------------------------------------------------------------------ if not c.command_suite_validates(): from crypto.settings import usage as crypto_usage print(crypto_usage) sys.exit(1) #------------------------------------------------------------------------------------------ # [ HELP, VERSION, USAGE LOGIC ] # Naked framework provides default help, usage, and version commands for all applications # --> settings for user messages are assigned in the lib/crypto/settings.py file #------------------------------------------------------------------------------------------ if c.help(): # User requested crypto help information from crypto.settings import help as crypto_help print(crypto_help) sys.exit(0) elif c.usage(): # User requested crypto usage information from crypto.settings import usage as crypto_usage print(crypto_usage) sys.exit(0) elif c.version(): # User requested crypto version information from crypto.settings import app_name, major_version, minor_version, patch_version version_display_string = app_name + ' ' + major_version + '.' + minor_version + '.' + patch_version print(version_display_string) sys.exit(0) #------------------------------------------------------------------------------------------ # [ APPLICATION LOGIC ] # #------------------------------------------------------------------------------------------ elif c.argc > 1: # code for multi-file processing and commands that include options ## ASCII ARMOR SWITCH ascii_armored = False if c.option('--armor') or c.option('-a'): ascii_armored = True ## MAX COMPRESS / COMPRESS ALL SWITCH max_compress = False if c.option('--space'): max_compress = True ## NO COMPRESSION SWITCH no_compress = False if c.option('--speed'): no_compress = True ## SECURE HASH DIGEST REPORT SWITCH report_checksum = False if c.option('--hash'): report_checksum = True path_list = [] # user entered paths from command line directory_list = [ ] # directory paths included in the user entered paths from the command line file_list = [ ] # file paths included in the user entered paths from the command line (and inside directories entered) # dot and .crypt file flags for exclusion testing contained_dot_file = False contained_crypt_file = False # determine if argument is an existing file or directory for argument in c.argv: if file_exists(argument): if argument.endswith( '.crypt'): # do not include previously encrypted files contained_crypt_file = True else: file_list.append( argument ) # add appropriate file paths to the file_list elif dir_exists(argument): directory_list.append( argument ) # if it is a directory, add path to the directory_list # add all file paths from user specified directories to the file_list if len(directory_list) > 0: for directory in directory_list: directory_file_list = list_all_files(directory) for contained_file in directory_file_list: if contained_file[0] == ".": contained_dot_file = True # change the flag + is not included in file_list intentionally (no dot files) elif contained_file.endswith('.crypt'): contained_crypt_file = True # change the flag + is not included in file_list intentionally (no previously encrypted files) else: # otherwise add to the list for encryption contained_file_path = make_path( directory, contained_file) file_list.append(contained_file_path) # confirm that there are files to be encrypted, if not warn user if len(file_list) == 0: if contained_dot_file == True or contained_crypt_file == True: stderr( "There were no files identified for encryption. crypto does not encrypt dot files or previously encrypted '.crypt' files." ) sys.exit(1) else: stderr("Unable to identify files for encryption") sys.exit(1) else: # file_list should contain all filepaths from either user specified file paths or contained in top level of directory, encrypt them passphrase = getpass.getpass("Please enter your passphrase: ") if len(passphrase) == 0: # confirm that user entered a passphrase stderr( "You did not enter a passphrase. Please repeat your command and try again." ) sys.exit(1) passphrase_confirm = getpass.getpass( "Please enter your passphrase again: ") if passphrase == passphrase_confirm: from crypto.library.cryptor import Cryptor the_cryptor = Cryptor(passphrase) # run encryption based upon any passed switches if ascii_armored: if max_compress: the_cryptor.encrypt_files(file_list, force_nocompress=False, force_compress=True, armored=True, checksum=report_checksum) elif no_compress: the_cryptor.encrypt_files(file_list, force_nocompress=True, force_compress=False, armored=True, checksum=report_checksum) else: the_cryptor.encrypt_files(file_list, force_nocompress=False, force_compress=False, armored=True, checksum=report_checksum) else: if max_compress: the_cryptor.encrypt_files(file_list, force_nocompress=False, force_compress=True, armored=False, checksum=report_checksum) elif no_compress: the_cryptor.encrypt_files(file_list, force_nocompress=True, force_compress=False, armored=False, checksum=report_checksum) else: the_cryptor.encrypt_files(file_list, force_nocompress=False, force_compress=False, armored=False, checksum=report_checksum) # overwrite user entered passphrases passphrase = "" passphrase_confirm = "" the_cryptor.cleanup() else: # passphrases did not match, report to user and abort # overwrite user entered passphrases passphrase = "" passphrase_confirm = "" stderr( "The passphrases did not match. Please enter your command again." ) sys.exit(1) elif c.argc == 1: # simple single file or directory processing with default settings path = c.arg0 if file_exists(path): # it is a file, encrypt the single file with default settings # confirm that it is not already encrypted, abort if so if path.endswith('.crypt'): stderr( "You are attempting to encrypt an encrypted file. Please delete the .crypt file and repeat encryption with the original file if this is your intent." ) sys.exit(1) # if passes test above, obtain passphrase from the user passphrase = getpass.getpass("Please enter your passphrase: ") if len(passphrase) == 0: # confirm that user entered a passphrase stderr( "You did not enter a passphrase. Please repeat your command and try again." ) sys.exit(1) passphrase_confirm = getpass.getpass( "Please enter your passphrase again: ") if passphrase == passphrase_confirm: from crypto.library.cryptor import Cryptor the_cryptor = Cryptor(passphrase) the_cryptor.encrypt_file(path) the_cryptor.cleanup() else: stderr( "The passphrases did not match. Please enter your command again." ) sys.exit(1) elif dir_exists(path): # it is a directory, encrypt all top level files with default settings dirty_directory_file_list = list_all_files(path) # remove dot files and previously encrypted files (with .crypt suffix) from the list of directory files clean_directory_file_list = [ x for x in dirty_directory_file_list if x[0] != "." and x.endswith(".crypt") == False ] # remove dotfiles and .crypt files # confirm that there are still files in the list after the dot files and encrypted files are removed if len(clean_directory_file_list) == 0: stderr("There are no unencrypted files in the directory.") sys.exit(1) # create relative file paths for each file in the clean_directory_file_list clean_directory_file_list_relpaths = [] for clean_file in clean_directory_file_list: new_file_path = make_path(path, clean_file) clean_directory_file_list_relpaths.append(new_file_path) #prompt for the passphrase passphrase = getpass.getpass("Please enter your passphrase: ") if len(passphrase) == 0: # confirm that user entered a passphrase stderr( "You did not enter a passphrase. Please repeat your command and try again." ) sys.exit(1) passphrase_confirm = getpass.getpass( "Please enter your passphrase again: ") if passphrase == passphrase_confirm: from crypto.library.cryptor import Cryptor the_cryptor = Cryptor(passphrase) the_cryptor.encrypt_files( clean_directory_file_list_relpaths ) #encrypt the list of directory files the_cryptor.cleanup() else: # passphrases do not match # overwrite user entered passphrases passphrase = "" passphrase_confirm = "" stderr( "The passphrases did not match. Please enter your command again." ) sys.exit(1) else: # error message, not a file or directory. user entry error stderr( "The path that you entered does not appear to be an existing file or directory. Please try again." ) sys.exit(1) #------------------------------------------------------------------------------------------ # [ DEFAULT MESSAGE FOR MATCH FAILURE ] # Message to provide to the user when all above conditional logic fails to meet a true condition #------------------------------------------------------------------------------------------ else: print("Could not complete your request. Please try again.") sys.exit(1)
def main(): import os import sys from time import sleep import getpass import tarfile from Naked.commandline import Command from Naked.toolshed.shell import execute, muterun from Naked.toolshed.system import dir_exists, file_exists, list_all_files, make_path, stdout, stderr, is_dir from shellescape import quote # ------------------------------------------------------------------------------------------ # [ Instantiate command line object ] # used for all subsequent conditional logic in the CLI application # ------------------------------------------------------------------------------------------ c = Command(sys.argv[0], sys.argv[1:]) # ------------------------------------------------------------------------------------------ # [ VALIDATION LOGIC ] - early validation of appropriate command syntax # Test that user entered at least one argument to the executable, print usage if not # ------------------------------------------------------------------------------------------ if not c.command_suite_validates(): from Crypto.settings import usage as crypto_usage print(crypto_usage) sys.exit(1) # ------------------------------------------------------------------------------------------ # [ HELP, VERSION, USAGE LOGIC ] # Naked framework provides default help, usage, and version commands for all applications # --> settings for user messages are assigned in the lib/Crypto/settings.py file # ------------------------------------------------------------------------------------------ if c.help(): # User requested Crypto help information from Crypto.settings import help as crypto_help print(crypto_help) sys.exit(0) elif c.usage(): # User requested Crypto usage information from Crypto.settings import usage as crypto_usage print(crypto_usage) sys.exit(0) elif c.version(): # User requested Crypto version information from Crypto.settings import app_name, major_version, minor_version, patch_version version_display_string = app_name + ' ' + major_version + '.' + minor_version + '.' + patch_version print(version_display_string) sys.exit(0) # ------------------------------------------------------------------------------------------ # [ APPLICATION LOGIC ] # # ------------------------------------------------------------------------------------------ elif c.argc > 1: # code for multi-file processing and commands that include options use_standard_output = False # print to stdout flag use_file_overwrite = False # overwrite existing file untar_archives = True # untar decrypted tar archives, true by default # set user option flags if c.option('--stdout') or c.option('-s'): use_standard_output = True if c.option('--overwrite') or c.option('-o'): use_file_overwrite = True if c.option('--nountar'): untar_archives = False directory_list = [ ] # directory paths included in the user entered paths from the command line file_list = [ ] # file paths included in the user entered paths from the command line (and inside directories entered) for argument in c.argv: if file_exists( argument ): # user included a file, add it to the file_list for decryption if argument.endswith('.crypt'): file_list.append( argument ) # add .crypt files to the list of files for decryption elif argument.endswith('.gpg'): file_list.append(argument) elif argument.endswith('.asc'): file_list.append(argument) elif argument.endswith('.pgp'): file_list.append(argument) else: # cannot identify as an encrypted file, give it a shot anyways but warn user file_list.append(argument) stdout( "Could not confirm that '" + argument + "' is encrypted based upon the file type. Attempting decryption. Keep your fingers crossed..." ) elif dir_exists( argument ): # user included a directory, add it to the directory_list directory_list.append(argument) else: if argument[0] == "-": pass # if it is an option, do nothing else: stderr( "'" + argument + "' does not appear to be an existing file or directory. Aborting decryption attempt for this request." ) # unroll the contained directory files into the file_list IF they are encrypted file types if len(directory_list) > 0: for directory in directory_list: directory_file_list = list_all_files(directory) for contained_file in directory_file_list: if contained_file.endswith('.crypt'): file_list.append( make_path(directory, contained_file) ) # include the file with a filepath 'directory path/contained_file path' elif contained_file.endswith('.gpg'): file_list.append(make_path(directory, contained_file)) elif contained_file.endswith('asc'): file_list.append(make_path(directory, contained_file)) elif contained_file.endswith('.pgp'): file_list.append(make_path(directory, contained_file)) # confirm that there are files for decryption, if not abort if len(file_list) == 0: stderr("Could not identify files for decryption") sys.exit(1) # get passphrase used to symmetrically decrypt the file passphrase = getpass.getpass("Please enter your passphrase: ") if len(passphrase) == 0: # confirm that user entered a passphrase stderr( "You did not enter a passphrase. Please repeat your command and try again." ) sys.exit(1) passphrase_confirm = getpass.getpass( "Please enter your passphrase again: ") if passphrase == passphrase_confirm: # begin decryption of each requested file. the directory path was already added to the file path above for encrypted_file in file_list: # create the decrypted file name decrypted_filename = "" if encrypted_file.endswith('.crypt'): decrypted_filename = encrypted_file[0:-6] elif encrypted_file.endswith( '.gpg') or encrypted_file.endswith( '.asc') or encrypted_file.endswith('.pgp'): decrypted_filename = encrypted_file[0:-4] else: decrypted_filename = encrypted_file + '.decrypt' # if it was a file without a known encrypted file type, add the .decrypt suffix # determine whether file overwrite will take place with the decrypted file skip_file = False # flag that indicates this file should not be encrypted created_tmp_files = False if not use_standard_output: # if not writing a file, no need to check for overwrite if file_exists(decrypted_filename): if use_file_overwrite: # rename the existing file to temp file which will be erased or replaced (on decryption failures) below tmp_filename = decrypted_filename + '.tmp' os.rename(decrypted_filename, tmp_filename) created_tmp_files = True else: stdout( "The file path '" + decrypted_filename + "' already exists. This file was not decrypted." ) skip_file = True # begin decryption if not skip_file: if use_standard_output: # using --quiet flag to suppress stdout messages from gpg, just want the file data in stdout stream system_command = "gpg --batch --quiet --passphrase " + quote( passphrase) + " -d " + quote(encrypted_file) successful_execution = execute( system_command ) # use naked execute function to directly push to stdout, rather than return stdout if not successful_execution: stderr( "Unable to decrypt file '" + encrypted_file + "'", 0) if created_tmp_files: # restore the moved tmp file to original if decrypt failed tmp_filename = decrypted_filename + '.tmp' if file_exists(tmp_filename): os.rename(tmp_filename, decrypted_filename) else: # decryption successful but we are in stdout flag so do not include any other output from decrypto pass else: system_command = "gpg --batch -o " + quote( decrypted_filename) + " --passphrase " + quote( passphrase) + " -d " + quote(encrypted_file) response = muterun(system_command) if response.exitcode == 0: stdout("'" + encrypted_file + "' decrypted to '" + decrypted_filename + "'") else: # failed decryption if created_tmp_files: # restore the moved tmp file to original if decrypt failed tmp_filename = decrypted_filename + '.tmp' if file_exists(tmp_filename): os.rename(tmp_filename, decrypted_filename) # report the error stderr(response.stderr) stderr("Decryption failed for " + encrypted_file) # cleanup: remove the tmp file if created_tmp_files: tmp_filename = decrypted_filename + '.tmp' if file_exists(tmp_filename): os.remove(tmp_filename) # untar/extract any detected archive file(s) if untar_archives is True: if decrypted_filename.endswith( '.tar') and tarfile.is_tarfile(decrypted_filename): untar_path_tuple = os.path.split(decrypted_filename) untar_path = untar_path_tuple[0] if use_file_overwrite: with tarfile.open(decrypted_filename) as tar: if len(untar_path) > 0: tar.extractall( path=untar_path ) # use dir path from the decrypted_filename if not CWD stdout( "'" + decrypted_filename + "' unpacked in the directory path '" + untar_path + "'") else: tar.extractall() # else use CWD stdout( "'" + decrypted_filename + "' unpacked in the current working directory" ) else: with tarfile.TarFile(decrypted_filename, 'r', errorlevel=1) as tar: for tarinfo in tar: t_file = tarinfo.name if len(untar_path) > 0: t_file_path = os.path.join( untar_path, t_file) else: t_file_path = t_file if not os.path.exists(t_file_path): try: if len(untar_path) > 0: tar.extract( t_file, path=untar_path ) # write to the appropriate dir else: tar.extract( t_file) # write to CWD except IOError as e: stderr( "Failed to unpack the file '" + t_file_path + "' [" + str(e) + "]") elif is_dir(t_file_path): pass # do nothing if it exists and is a directory, no need to warn else: # it is a file and it already exists, provide user error message stderr( "Failed to unpack the file '" + t_file_path + "'. File already exists. Use the --overwrite flag to replace existing files." ) # remove the decrypted tar archive file os.remove(decrypted_filename) # overwrite the entered passphrases after file decryption is complete for all files passphrase = "" passphrase_confirm = "" # add a short pause to hinder brute force pexpect style password attacks with decrypto sleep(0.2) # 200ms pause else: # passphrases did not match passphrase = "" passphrase_confirm = "" stderr( "The passphrases did not match. Please enter your command again." ) sys.exit(1) elif c.argc == 1: # simple single file or directory processing with default settings path = c.arg0 if file_exists(path): # SINGLE FILE check_existing_file = False # check for a file with the name of new decrypted filename in the directory if path.endswith('.crypt'): decrypted_filename = path[0:-6] # remove the .crypt suffix check_existing_file = True elif path.endswith('.gpg') or path.endswith( '.pgp') or path.endswith('.asc'): decrypted_filename = path[0:-4] check_existing_file = True else: decrypted_filename = path + ".decrypt" # if there is not a standard file type, then add a .decrypt suffix to the decrypted file name stdout( "Could not confirm that the requested file is encrypted based upon the file type. Attempting decryption. Keep your fingers crossed..." ) # confirm that the decrypted path does not already exist, if so abort with warning message to user if check_existing_file is True: if file_exists(decrypted_filename): stderr( "Your file will be decrypted to '" + decrypted_filename + "' and this file path already exists. Please move the file or use the --overwrite option with your command if you intend to replace the current file." ) sys.exit(1) # get passphrase used to symmetrically decrypt the file passphrase = getpass.getpass("Please enter your passphrase: ") if len(passphrase) == 0: # confirm that user entered a passphrase stderr( "You did not enter a passphrase. Please repeat your command and try again." ) sys.exit(1) passphrase_confirm = getpass.getpass( "Please enter your passphrase again: ") # confirm that the passphrases match if passphrase == passphrase_confirm: system_command = "gpg --batch -o " + quote( decrypted_filename) + " --passphrase " + quote( passphrase) + " -d " + quote(path) response = muterun(system_command) if response.exitcode == 0: # unpack tar archive generated from the decryption, if present if decrypted_filename.endswith( '.tar') and tarfile.is_tarfile(decrypted_filename): untar_path_tuple = os.path.split(decrypted_filename) untar_path = untar_path_tuple[0] with tarfile.TarFile(decrypted_filename, 'r', errorlevel=1) as tar: for tarinfo in tar: t_file = tarinfo.name if len(untar_path) > 0: t_file_path = os.path.join( untar_path, t_file) else: t_file_path = t_file if not os.path.exists(t_file_path): try: if len(untar_path) > 0: tar.extract( t_file, path=untar_path ) # write to the appropriate dir else: tar.extract(t_file) # write to CWD except IOError as e: stderr("Failed to unpack the file '" + t_file_path + "' [" + str(e) + "]") elif is_dir(t_file_path): pass # do nothing if it exists and is a directory, no need to warn else: # it is a file and it already exists, provide user error message stderr( "Failed to unpack the file '" + t_file_path + "'. File already exists. Use the --overwrite flag to replace existing files." ) # remove the decrypted tar archive os.remove(decrypted_filename) stdout("Decryption complete") # overwrite user entered passphrases passphrase = "" passphrase_confirm = "" sys.exit(0) else: stderr(response.stderr) stderr("Decryption failed") # overwrite user entered passphrases passphrase = "" passphrase_confirm = "" # add a short pause to hinder brute force pexpect style password attacks with decrypto sleep(0.2) # 200ms pause sys.exit(1) else: stderr( "The passphrases did not match. Please enter your command again." ) sys.exit(1) elif dir_exists(path): # SINGLE DIRECTORY dirty_directory_file_list = list_all_files(path) directory_file_list = [ x for x in dirty_directory_file_list if (x.endswith('.crypt') or x.endswith('.gpg') or x.endswith('.pgp') or x.endswith('.asc')) ] # if there are no encrypted files found, warn and abort if len(directory_file_list) == 0: stderr("There are no encrypted files in the directory") sys.exit(1) # prompt for the passphrase passphrase = getpass.getpass("Please enter your passphrase: ") if len(passphrase) == 0: # confirm that user entered a passphrase stderr( "You did not enter a passphrase. Please repeat your command and try again." ) sys.exit(1) passphrase_confirm = getpass.getpass( "Please enter your passphrase again: ") if passphrase == passphrase_confirm: # decrypt all of the encypted files in the directory for filepath in directory_file_list: absolute_filepath = make_path( path, filepath ) # combine the directory path and file name into absolute path # remove file suffix from the decrypted file path that writes to disk if absolute_filepath.endswith('.crypt'): decrypted_filepath = absolute_filepath[ 0:-6] # remove the .crypt suffix elif absolute_filepath.endswith( '.gpg') or absolute_filepath.endswith( '.pgp') or absolute_filepath.endswith('.asc'): decrypted_filepath = absolute_filepath[0:-4] # confirm that the file does not already exist if file_exists(decrypted_filepath): stdout( "The file path '" + decrypted_filepath + "' already exists. This file was not decrypted.") else: system_command = "gpg --batch -o " + quote( decrypted_filepath) + " --passphrase " + quote( passphrase) + " -d " + quote(absolute_filepath) response = muterun(system_command) if response.exitcode == 0: stdout("'" + absolute_filepath + "' decrypted to '" + decrypted_filepath + "'") else: stderr(response.stderr) stderr("Decryption failed for " + absolute_filepath) # overwrite user entered passphrases passphrase = "" passphrase_confirm = "" # add a short pause to hinder brute force pexpect style password attacks with decrypto sleep(0.2) # 200ms pause else: # overwrite user entered passphrases passphrase = "" passphrase_confirm = "" stderr( "The passphrases did not match. Please enter your command again." ) sys.exit(1) else: # error message, not a file or directory. user entry error stderr( "The path that you entered does not appear to be an existing file or directory. Please try again." ) sys.exit(1) # ------------------------------------------------------------------------------------------ # [ DEFAULT MESSAGE FOR MATCH FAILURE ] # Message to provide to the user when all above conditional logic fails to meet a true condition # ------------------------------------------------------------------------------------------ else: print("Could not complete your request. Please try again.") sys.exit(1)
def main(): import os import sys from time import sleep import getpass import tarfile from Naked.commandline import Command from Naked.toolshed.shell import execute, muterun from Naked.toolshed.system import dir_exists, file_exists, list_all_files, make_path, stdout, stderr, is_dir #------------------------------------------------------------------------------------------ # [ Instantiate command line object ] # used for all subsequent conditional logic in the CLI application #------------------------------------------------------------------------------------------ c = Command(sys.argv[0], sys.argv[1:]) #------------------------------------------------------------------------------------------ # [ VALIDATION LOGIC ] - early validation of appropriate command syntax # Test that user entered at least one argument to the executable, print usage if not #------------------------------------------------------------------------------------------ if not c.command_suite_validates(): from crypto.settings import usage as crypto_usage print(crypto_usage) sys.exit(1) #------------------------------------------------------------------------------------------ # [ HELP, VERSION, USAGE LOGIC ] # Naked framework provides default help, usage, and version commands for all applications # --> settings for user messages are assigned in the lib/crypto/settings.py file #------------------------------------------------------------------------------------------ if c.help(): # User requested crypto help information from crypto.settings import help as crypto_help print(crypto_help) sys.exit(0) elif c.usage(): # User requested crypto usage information from crypto.settings import usage as crypto_usage print(crypto_usage) sys.exit(0) elif c.version(): # User requested crypto version information from crypto.settings import app_name, major_version, minor_version, patch_version version_display_string = app_name + ' ' + major_version + '.' + minor_version + '.' + patch_version print(version_display_string) sys.exit(0) #------------------------------------------------------------------------------------------ # [ APPLICATION LOGIC ] # #------------------------------------------------------------------------------------------ elif c.argc > 1: # code for multi-file processing and commands that include options use_standard_output = False # print to stdout flag use_file_overwrite = False # overwrite existing file untar_archives = True # untar decrypted tar archives, true by default # set user option flags if c.option('--stdout') or c.option('-s'): use_standard_output = True if c.option('--overwrite') or c.option('-o'): use_file_overwrite = True if c.option('--nountar'): untar_archives = False directory_list = [] # directory paths included in the user entered paths from the command line file_list = [] # file paths included in the user entered paths from the command line (and inside directories entered) for argument in c.argv: if file_exists(argument): # user included a file, add it to the file_list for decryption if argument.endswith('.crypt'): file_list.append(argument) # add .crypt files to the list of files for decryption elif argument.endswith('.gpg'): file_list.append(argument) elif argument.endswith('.asc'): file_list.append(argument) elif argument.endswith('.pgp'): file_list.append(argument) else: # cannot identify as an encrypted file, give it a shot anyways but warn user file_list.append(argument) stdout("Could not confirm that '" + argument + "' is encrypted based upon the file type. Attempting decryption. Keep your fingers crossed...") elif dir_exists(argument): # user included a directory, add it to the directory_list directory_list.append(argument) else: if argument[0] == "-": pass # if it is an option, do nothing else: stderr("'" + argument + "' does not appear to be an existing file or directory. Aborting decryption attempt for this request.") # unroll the contained directory files into the file_list IF they are encrypted file types if len(directory_list) > 0: for directory in directory_list: directory_file_list = list_all_files(directory) for contained_file in directory_file_list: if contained_file.endswith('.crypt'): file_list.append(make_path(directory, contained_file)) # include the file with a filepath 'directory path/contained_file path' elif contained_file.endswith('.gpg'): file_list.append(make_path(directory, contained_file)) elif contained_file.endswith('asc'): file_list.append(make_path(directory, contained_file)) elif contained_file.endswith('.pgp'): file_list.append(make_path(directory, contained_file)) # confirm that there are files for decryption, if not abort if len(file_list) == 0: stderr("Could not identify files for decryption") sys.exit(1) # get passphrase used to symmetrically decrypt the file passphrase = getpass.getpass("Please enter your passphrase: ") if len(passphrase) == 0: # confirm that user entered a passphrase stderr("You did not enter a passphrase. Please repeat your command and try again.") sys.exit(1) passphrase_confirm = getpass.getpass("Please enter your passphrase again: ") if passphrase == passphrase_confirm: # begin decryption of each requested file. the directory path was already added to the file path above for encrypted_file in file_list: # create the decrypted file name decrypted_filename = "" if encrypted_file.endswith('.crypt'): decrypted_filename = encrypted_file[0:-6] elif encrypted_file.endswith('.gpg') or encrypted_file.endswith('.asc') or encrypted_file.endswith('.pgp'): decrypted_filename = encrypted_file[0:-4] else: decrypted_filename = encrypted_file + '.decrypt' # if it was a file without a known encrypted file type, add the .decrypt suffix # determine whether file overwrite will take place with the decrypted file skip_file = False # flag that indicates this file should not be encrypted created_tmp_files = False if not use_standard_output: # if not writing a file, no need to check for overwrite if file_exists(decrypted_filename): if use_file_overwrite: # rename the existing file to temp file which will be erased or replaced (on decryption failures) below tmp_filename = decrypted_filename + '.tmp' os.rename(decrypted_filename, tmp_filename) created_tmp_files = True else: stdout("The file path '" + decrypted_filename + "' already exists. This file was not decrypted.") skip_file = True # begin decryption if not skip_file: if use_standard_output: # using --quiet flag to suppress stdout messages from gpg, just want the file data in stdout stream system_command = "gpg --batch --quiet --passphrase '" + passphrase + "' -d " + encrypted_file successful_execution = execute(system_command) # use naked execute function to directly push to stdout, rather than return stdout if not successful_execution: stderr("Unable to decrypt file '" + encrypted_file + "'", 0) if created_tmp_files: # restore the moved tmp file to original if decrypt failed tmp_filename = decrypted_filename + '.tmp' if file_exists(tmp_filename): os.rename(tmp_filename, decrypted_filename) else: # decryption successful but we are in stdout flag so do not include any other output from decrypto pass else: system_command = "gpg --batch -o " + decrypted_filename + " --passphrase '" + passphrase + "' -d " + encrypted_file response = muterun(system_command) if response.exitcode == 0: stdout("'" + encrypted_file + "' decrypted to '" + decrypted_filename + "'") else: # failed decryption if created_tmp_files: # restore the moved tmp file to original if decrypt failed tmp_filename = decrypted_filename + '.tmp' if file_exists(tmp_filename): os.rename(tmp_filename, decrypted_filename) # report the error stderr(response.stderr) stderr("Decryption failed for " + encrypted_file) # cleanup: remove the tmp file if created_tmp_files: tmp_filename = decrypted_filename + '.tmp' if file_exists(tmp_filename): os.remove(tmp_filename) # untar/extract any detected archive file(s) if untar_archives is True: if decrypted_filename.endswith('.tar') and tarfile.is_tarfile(decrypted_filename): untar_path_tuple = os.path.split(decrypted_filename) untar_path = untar_path_tuple[0] if use_file_overwrite: with tarfile.open(decrypted_filename) as tar: if len(untar_path) > 0: tar.extractall(path=untar_path) # use dir path from the decrypted_filename if not CWD stdout("'" + decrypted_filename + "' unpacked in the directory path '" + untar_path + "'") else: tar.extractall() # else use CWD stdout("'" + decrypted_filename + "' unpacked in the current working directory") else: with tarfile.TarFile(decrypted_filename, 'r', errorlevel=1) as tar: for tarinfo in tar: t_file = tarinfo.name if len(untar_path) > 0: t_file_path = os.path.join(untar_path, t_file) else: t_file_path = t_file if not os.path.exists(t_file_path): try: if len(untar_path) > 0: tar.extract(t_file, path=untar_path) # write to the appropriate dir else: tar.extract(t_file) # write to CWD except IOError as e: stderr( "Failed to unpack the file '" + t_file_path + "' [" + str( e) + "]") elif is_dir(t_file_path): pass # do nothing if it exists and is a directory, no need to warn else: # it is a file and it already exists, provide user error message stderr( "Failed to unpack the file '" + t_file_path + "'. File already exists. Use the --overwrite flag to replace existing files.") # remove the decrypted tar archive file os.remove(decrypted_filename) # overwrite the entered passphrases after file decryption is complete for all files passphrase = "" passphrase_confirm = "" # add a short pause to hinder brute force pexpect style password attacks with decrypto sleep(0.2) # 200ms pause else: # passphrases did not match passphrase = "" passphrase_confirm = "" stderr("The passphrases did not match. Please enter your command again.") sys.exit(1) elif c.argc == 1: # simple single file or directory processing with default settings path = c.arg0 if file_exists(path): # SINGLE FILE check_existing_file = False # check for a file with the name of new decrypted filename in the directory if path.endswith('.crypt'): decrypted_filename = path[0:-6] # remove the .crypt suffix check_existing_file = True elif path.endswith('.gpg') or path.endswith('.pgp') or path.endswith('.asc'): decrypted_filename = path[0:-4] check_existing_file = True else: decrypted_filename = path + ".decrypt" # if there is not a standard file type, then add a .decrypt suffix to the decrypted file name stdout("Could not confirm that the requested file is encrypted based upon the file type. Attempting decryption. Keep your fingers crossed...") # confirm that the decrypted path does not already exist, if so abort with warning message to user if check_existing_file is True: if file_exists(decrypted_filename): stderr("Your file will be decrypted to '" + decrypted_filename + "' and this file path already exists. Please move the file or use the --overwrite option with your command if you intend to replace the current file.") sys.exit(1) # get passphrase used to symmetrically decrypt the file passphrase = getpass.getpass("Please enter your passphrase: ") if len(passphrase) == 0: # confirm that user entered a passphrase stderr("You did not enter a passphrase. Please repeat your command and try again.") sys.exit(1) passphrase_confirm = getpass.getpass("Please enter your passphrase again: ") # confirm that the passphrases match if passphrase == passphrase_confirm: system_command = "gpg --batch -o " + decrypted_filename + " --passphrase '" + passphrase + "' -d " + path response = muterun(system_command) if response.exitcode == 0: # unpack tar archive generated from the decryption, if present if decrypted_filename.endswith('.tar') and tarfile.is_tarfile(decrypted_filename): untar_path_tuple = os.path.split(decrypted_filename) untar_path = untar_path_tuple[0] with tarfile.TarFile(decrypted_filename, 'r', errorlevel=1) as tar: for tarinfo in tar: t_file = tarinfo.name if len(untar_path) > 0: t_file_path = os.path.join(untar_path, t_file) else: t_file_path = t_file if not os.path.exists(t_file_path): try: if len(untar_path) > 0: tar.extract(t_file, path=untar_path) # write to the appropriate dir else: tar.extract(t_file) # write to CWD except IOError as e: stderr("Failed to unpack the file '" + t_file_path + "' [" + str(e) + "]") elif is_dir(t_file_path): pass # do nothing if it exists and is a directory, no need to warn else: # it is a file and it already exists, provide user error message stderr("Failed to unpack the file '" + t_file_path + "'. File already exists. Use the --overwrite flag to replace existing files.") # remove the decrypted tar archive os.remove(decrypted_filename) stdout("Decryption complete") # overwrite user entered passphrases passphrase = "" passphrase_confirm = "" sys.exit(0) else: stderr(response.stderr) stderr("Decryption failed") # overwrite user entered passphrases passphrase = "" passphrase_confirm = "" # add a short pause to hinder brute force pexpect style password attacks with decrypto sleep(0.2) # 200ms pause sys.exit(1) else: stderr("The passphrases did not match. Please enter your command again.") sys.exit(1) elif dir_exists(path): # SINGLE DIRECTORY dirty_directory_file_list = list_all_files(path) directory_file_list = [x for x in dirty_directory_file_list if (x.endswith('.crypt') or x.endswith('.gpg') or x.endswith('.pgp') or x.endswith('.asc'))] # if there are no encrypted files found, warn and abort if len(directory_file_list) == 0: stderr("There are no encrypted files in the directory") sys.exit(1) # prompt for the passphrase passphrase = getpass.getpass("Please enter your passphrase: ") if len(passphrase) == 0: # confirm that user entered a passphrase stderr("You did not enter a passphrase. Please repeat your command and try again.") sys.exit(1) passphrase_confirm = getpass.getpass("Please enter your passphrase again: ") if passphrase == passphrase_confirm: # decrypt all of the encypted files in the directory for filepath in directory_file_list: absolute_filepath = make_path(path, filepath) # combine the directory path and file name into absolute path # remove file suffix from the decrypted file path that writes to disk if absolute_filepath.endswith('.crypt'): decrypted_filepath = absolute_filepath[0:-6] # remove the .crypt suffix elif absolute_filepath.endswith('.gpg') or absolute_filepath.endswith('.pgp') or absolute_filepath.endswith('.asc'): decrypted_filepath = absolute_filepath[0:-4] # confirm that the file does not already exist if file_exists(decrypted_filepath): stdout("The file path '" + decrypted_filepath + "' already exists. This file was not decrypted.") else: system_command = "gpg --batch -o " + decrypted_filepath + " --passphrase '" + passphrase + "' -d " + absolute_filepath response = muterun(system_command) if response.exitcode == 0: stdout("'" + absolute_filepath + "' decrypted to '" + decrypted_filepath + "'") else: stderr(response.stderr) stderr("Decryption failed for " + absolute_filepath) # overwrite user entered passphrases passphrase = "" passphrase_confirm = "" # add a short pause to hinder brute force pexpect style password attacks with decrypto sleep(0.2) # 200ms pause else: # overwrite user entered passphrases passphrase = "" passphrase_confirm = "" stderr("The passphrases did not match. Please enter your command again.") sys.exit(1) else: # error message, not a file or directory. user entry error stderr("The path that you entered does not appear to be an existing file or directory. Please try again.") sys.exit(1) # ------------------------------------------------------------------------------------------ # [ DEFAULT MESSAGE FOR MATCH FAILURE ] # Message to provide to the user when all above conditional logic fails to meet a true condition # ------------------------------------------------------------------------------------------ else: print("Could not complete your request. Please try again.") sys.exit(1)
def main(): import sys from Naked.commandline import Command #from Naked.toolshed.state import StateObject from Naked.toolshed.system import stderr, exit_success, exit_fail from status.commands.http_request import Get, Post #------------------------------------------------------------------------------------------ # [ Instantiate command line object ] # used for all subsequent conditional logic in the CLI application #------------------------------------------------------------------------------------------ c = Command(sys.argv[0], sys.argv[1:]) #------------------------------------------------------------------------------ # [ Instantiate state object ] #------------------------------------------------------------------------------ # state = StateObject() #------------------------------------------------------------------------------------------ # [ Command Suite Validation ] - early validation of appropriate command syntax # Test that user entered a primary command, print usage if not #------------------------------------------------------------------------------------------ if not c.command_suite_validates(): from status.commands.usage import Usage Usage().print_usage() exit_fail() #------------------------------------------------------------------------------------------ # [ NAKED FRAMEWORK COMMANDS ] # Naked framework provides default help, usage, and version commands for all applications # --> settings for user messages are assigned in the lib/status/settings.py file #------------------------------------------------------------------------------------------ if c.help(): # User requested naked help (help.py module in commands directory) from status.commands.help import Help Help().print_help() elif c.usage(): # user requested naked usage info (usage.py module in commands directory) from status.commands.usage import Usage Usage().print_usage() elif c.version(): # user requested naked version (version.py module in commands directory) from status.commands.version import Version Version().print_version() #------------------------------------------------------------------------------------------ # [ PRIMARY COMMAND LOGIC ] # Enter your command line parsing logic below #------------------------------------------------------------------------------------------ # POST request elif c.option("-p") or c.option("--post"): if c.arg1: post = Post(c.arg1) post.post_response() else: stderr("Please enter a URL to test.", 1) # GET request elif len(c.arg0) > 0: get = Get(c.arg0) get.get_response() #------------------------------------------------------------------------------------------ # [ DEFAULT MESSAGE FOR MATCH FAILURE ] # Message to provide to the user when all above conditional logic fails to meet a true condition #------------------------------------------------------------------------------------------ else: stderr("Please enter a URL to test.", 1)
def main(): from Naked.commandline import Command global PROGRESS_INDICATOR user_platform = platform.system() # ------------------------------------------------------------------------------------------ # [ Instantiate Naked framework command line object ] # used for all subsequent conditional logic in the CLI application # ------------------------------------------------------------------------------------------ c = Command(sys.argv[0], sys.argv[1:]) if c.help(): # User requested jampack help information from jampack.settings import help as jampack_help print(jampack_help) sys.exit(0) elif c.usage(): # User requested jampack usage information from jampack.settings import usage as jampack_usage print(jampack_usage) sys.exit(0) elif c.version(): # User requested jampack version information from jampack.settings import app_name, major_version, minor_version, patch_version version_display_string = app_name + ' ' + major_version + '.' + minor_version + '.' + patch_version print(version_display_string) sys.exit(0) # ------------------------------------------------------------------------------------------ # [ PRIMARY COMMAND LOGIC ] # ------------------------------------------------------------------------------------------ if c.argc == 0: # tar.gz pack the current working directory directory_name = os.path.basename(os.getcwd()) directory_size = get_directory_size(".") package_targz(directory_name, ".") archive_name = directory_name + ".tar.gz" percent_filesize = (100 * (get_file_size(archive_name) / float(directory_size))) display_percent = str(int(percent_filesize)) stdout(" 100%") if user_platform == "Windows": stdout(archive_name + " created " + "[~" + display_percent + "% original]") else: stdout("[\033[32m✓\033[0m] " + archive_name + " created " + "[~" + display_percent + "% original]") sys.exit(0) elif c.argc > 0: if c.arg0 == "zip": if c.argc == 1: # zip pack the current working directory directory_name = os.path.basename(os.getcwd()) directory_size = get_directory_size(".") package_zip(directory_name, ".") archive_name = directory_name + ".zip" percent_filesize = (100 * (get_file_size(archive_name) / float(directory_size))) display_percent = str(int(percent_filesize)) stdout(" 100%") # end of the progress indicator if user_platform == "Windows": stdout(archive_name + " created " + "[~" + display_percent + "% original]") else: stdout("[\033[32m✓\033[0m] " + archive_name + " created " + "[~" + display_percent + "% original]") sys.exit(0) else: directory_list = c.argv[1:] for a_directory in directory_list: if os.path.isdir(a_directory): PROGRESS_INDICATOR = 1 # reset the progress indicator on each new archive that is processed directory_name = os.path.basename(a_directory) directory_size = get_directory_size(a_directory) package_zip(directory_name, a_directory) archive_name = directory_name + ".zip" percent_filesize = (100 * (get_file_size(archive_name) / float(directory_size))) display_percent = str(int(percent_filesize)) stdout(" 100%") # end of the progress indicator if user_platform == "Windows": stdout(archive_name + " created " + "[~" + display_percent + "% original]") else: stdout("[\033[32m✓\033[0m] " + archive_name + " created " + "[~" + display_percent + "% original]") else: if user_platform == "Windows": stderr(a_directory + " is not a directory path") else: stderr("[\033[31mX\033[0m] " + a_directory + " is not a directory path") sys.exit(0) elif c.arg0 == "bz2": if c.argc == 1: # bz2 pack the current working directory directory_name = os.path.basename(os.getcwd()) directory_size = get_directory_size(".") package_bzip2(directory_name, ".") archive_name = directory_name + ".tar.bz2" percent_filesize = (100 * (get_file_size(archive_name) / float(directory_size))) display_percent = str(int(percent_filesize)) stdout(" 100%") # end of the progress indicator if user_platform == "Windows": stdout(archive_name + " created " + "[~" + display_percent + "% original]") else: stdout("[\033[32m✓\033[0m] " + archive_name + " created " + "[~" + display_percent + "% original]") sys.exit(0) else: # bz2 pack one or more explicitly set directory directory_list = c.argv[1:] for a_directory in directory_list: if os.path.isdir(a_directory): PROGRESS_INDICATOR = 1 # reset the progress indicator on each new archive that is processed directory_name = os.path.basename(a_directory) directory_size = get_directory_size(a_directory) package_bzip2(directory_name, a_directory) archive_name = directory_name + ".tar.bz2" percent_filesize = (100 * (get_file_size(archive_name) / float(directory_size))) display_percent = str(int(percent_filesize)) stdout(" 100%") # end of the progress indicator if user_platform == "Windows": stdout(archive_name + " created " + "[~" + display_percent + "% original]") else: stdout("[\033[32m✓\033[0m] " + archive_name + " created " + "[~" + display_percent + "% original]") else: if user_platform == "Windows": stderr(a_directory + " is not a directory path") else: stderr("[\033[31mX\033[0m] " + a_directory + " is not a directory path") sys.exit(0) else: # tar.gz one or more explicitly defined directories for a_directory in c.argv: if os.path.isdir(a_directory): PROGRESS_INDICATOR = 1 # reset the progress indicator on each new archive that is processed directory_name = os.path.basename(a_directory) directory_size = get_directory_size(a_directory) package_targz(directory_name, a_directory) archive_name = directory_name + ".tar.gz" percent_filesize = (100 * (get_file_size(archive_name) / float(directory_size))) display_percent = str(int(percent_filesize)) stdout(" 100%") # end of the progress indicator if user_platform == "Windows": stdout(archive_name + " created " + "[~" + display_percent + "% original]") else: stdout("[\033[32m✓\033[0m] " + archive_name + " created " + "[~" + display_percent + "% original]") else: if user_platform == "Windows": stderr(a_directory + " is not a directory path") else: stderr("[\033[31mX\033[0m] " + a_directory + " is not a directory path") sys.exit(0) # ------------------------------------------------------------------------------------------ # [ DEFAULT MESSAGE FOR MATCH FAILURE ] # Message to provide to the user when all above conditional logic fails to meet a true condition # ------------------------------------------------------------------------------------------ else: if user_platform == "Windows": stdout("Could not complete the command that you entered. Please try again.") else: stdout("[\033[31mX\033[0m] Could not complete the command that you entered. Please try again.") sys.exit(1) # exit
def main(): import sys from Naked.commandline import Command #from Naked.toolshed.state import StateObject from Naked.toolshed.system import stderr #------------------------------------------------------------------------------------------ # [ Instantiate command line object ] # used for all subsequent conditional logic in the CLI application #------------------------------------------------------------------------------------------ c = Command(sys.argv[0], sys.argv[1:]) #------------------------------------------------------------------------------ # [ Instantiate state object ] #------------------------------------------------------------------------------ #state = StateObject() #------------------------------------------------------------------------------------------ # [ Command Suite Validation ] - early validation of appropriate command syntax # Test that user entered a primary command, print usage if not #------------------------------------------------------------------------------------------ if not c.command_suite_validates(): from Naked.commands.usage import Usage Usage().print_usage() sys.exit(1) #------------------------------------------------------------------------------------------ # [ PRIMARY COMMAND LOGIC ] # Test for primary commands and handle them #------------------------------------------------------------------------------------------ #------------------------------------------------------------------------------ # [ args ] - identify the parsed arguments for a command string (2)= help #------------------------------------------------------------------------------ if c.cmd == "args": if c.cmd2 == "help": from Naked.commands.args import help as args_help args_help() elif c.argc > 0: # there is an argument to where that is not help from Naked.commands.args import Args a = Args(c.arg_to_cmd) a.run() else: stderr("The args command requires an example command as an argument. Use 'naked args help' for more information.", 1) #------------------------------------------------------------------------------ # [ build ] - build the C code in the Naked library (2)= help #------------------------------------------------------------------------------ elif c.cmd == "build": if c.cmd2 == "help": from Naked.commands.build import help as build_help build_help() else: from Naked.commands.build import compile_c_code import os, inspect abs_dirpath = os.path.join(os.path.dirname(os.path.abspath(inspect.getfile(inspect.currentframe()))), "toolshed", "c") compile_c_code(abs_dirpath) # function calls exit status code #------------------------------------------------------------------------------ # [ classify ] - search Python application classifiers and display to user (args)-search string #------------------------------------------------------------------------------ elif c.cmd == "classify": if c.cmd2 == "help": from Naked.commands.classifier import help as classifier_help classifier_help() else: if c.second: # if search string was given search_string = c.second else: search_string = "" # absence of search string detected in Classifier, defaults to the entire list instead of search from Naked.commands.classifier import Classifier c = Classifier(search_string) c.run() #------------------------------------------------------------------------------ # [ dist ] - distribute source files to PyPI (2)=register, sdist, swheel, wheel, win, all, help #------------------------------------------------------------------------------ elif c.cmd == "dist": if c.argc > 1: from Naked.commands.dist import Dist d = Dist() if c.cmd2 == "register": # python setup.py register d.run('register') elif c.cmd2 == "sdist": # python setup.py sdist upload d.run('sdist') elif c.cmd2 == "swheel": # python setup.py sdist bdist_wheel upload d.run('swheel') elif c.cmd2 == "wheel": # python setup.py bdist_wheel upload d.run('wheel') elif c.cmd2 == "win": # python setup.py bdist_wininst upload d.run('win') elif c.cmd2 == "all": # python setup.py sdist bdist_wheel bdist_wininst upload d.run('all') elif c.cmd2 == "help": # help for command from Naked.commands.dist import help as dist_help dist_help() else: stderr("The naked dist secondary command was not recognized. Use 'naked dist help' for more information.", 1) else: stderr("Please enter a secondary command", 1) #------------------------------------------------------------------------------ # [ locate ] - locate Naked project files (2)= main, settings, setup, help #------------------------------------------------------------------------------ elif c.cmd == "locate": from Naked.commands.locate import Locator if c.cmd2 == "help": from Naked.commands.locate import help as locate_help locate_help() elif c.cmd2 == "main": l = Locator('main') elif c.cmd2 == "settings": l = Locator('settings') elif c.cmd2 == "setup": l = Locator('setup') else: l = Locator('') #handles error report to user #------------------------------------------------------------------------------ # [ make ] - make a new Naked project (2)=help (args)=project name #------------------------------------------------------------------------------ elif c.cmd == "make": from Naked.commands.make import MakeController if c.cmd2 == "help": from Naked.commands.make import help as make_help make_help() if c.arg1: # arg1 is not help so use it as the argument to the make command m = MakeController(c.arg1) else: m = MakeController(None) m.run() #------------------------------------------------------------------------------ # [ profile ] - run the profiler.py file in the Naked project (2)=help #------------------------------------------------------------------------------ elif c.cmd == "profile": if c.cmd2 == "help": from Naked.commands.profile import help as profile_help profile_help() else: from Naked.commands.profile import Profiler p = Profiler() p.run() #------------------------------------------------------------------------------ # [ pyh ] - help for python built-in library modules, classes, methods, functions #------------------------------------------------------------------------------ elif c.cmd == "pyh": if c.cmd2 == "help": from Naked.commands.pyh import pyh_help pyh_help() else: if c.argc > 1: from Naked.commands.pyh import python_help python_help(c.arg1) else: stderr("Please enter a query term with the pyh command. Use 'naked pyh help' for more information.", 1) #------------------------------------------------------------------------------ # [ test ] - Run unit tests on the project (2)= help,nose,pytest,tox,unittest (see help for args) #------------------------------------------------------------------------------ elif c.cmd == "test": if c.argc > 1: if c.cmd2 == "help": from Naked.commands.test import help as tox_help tox_help() elif c.cmd2 == "nose": from Naked.commands.test import NoseTester n = NoseTester() n.run() elif c.cmd2 == "pytest": from Naked.commands.test import PyTester p = PyTester() p.run() elif c.cmd2 == "tox": from Naked.commands.test import ToxTester if c.arg2: #user specified a python version to run with one of the tox version defs t = ToxTester(c.arg2) #instantiate with the python version else: t = ToxTester() t.run() elif c.cmd2 == "unittest": from Naked.commands.test import UnitTester if c.arg2: t = UnitTester(c.arg2) t.run() else: stderr("Please include a unit test file path. Use 'naked test help' for more information.", 1) else: stderr("The secondary command was not recognized. Use 'naked test help' for more information.", 1) else: stderr("Please include a secondary command with the 'naked test' command. Use 'naked dist help' for more information.", 1) #------------------------------------------------------------------------------------------ # [ NAKED FRAMEWORK COMMANDS ] # Naked framework provides default help, usage, and version commands for all applications # --> settings for user messages are assigned in the lib/PROJECT/settings.py file #------------------------------------------------------------------------------------------ elif c.help(): # User requested naked help (help.py module in commands directory) from Naked.commands.help import Help Help().print_help() elif c.usage(): # user requested naked usage info (usage.py module in commands directory) from Naked.commands.usage import Usage Usage().print_usage() elif c.version(): # user requested naked version (version.py module in commands directory) from Naked.commands.version import Version Version().print_version() #------------------------------------------------------------------------------------------ # [ DEFAULT MESSAGE FOR MATCH FAILURE ] # Message to provide to the user when all above conditional logic fails to meet a true condition #------------------------------------------------------------------------------------------ else: print("Could not complete the command that you entered. Please try again.") sys.exit(1) #exit
def main(): import sys from Naked.commandline import Command user_platform = platform.system() # ------------------------------------------------------------------------------------------ # [ Instantiate Naked framework command line object ] # used for all subsequent conditional logic in the CLI application # ------------------------------------------------------------------------------------------ c = Command(sys.argv[0], sys.argv[1:]) if not c.command_suite_validates(): from jampack.settings import usage as jampack_usage print(jampack_usage) sys.exit(1) if c.help(): # User requested jampack help information from jampack.settings import help as jampack_help print(jampack_help) sys.exit(0) elif c.usage(): # User requested jampack usage information from jampack.settings import usage as jampack_usage print(jampack_usage) sys.exit(0) elif c.version(): # User requested jampack version information from jampack.settings import app_name, major_version, minor_version, patch_version version_display_string = app_name + ' ' + major_version + '.' + minor_version + '.' + patch_version print(version_display_string) sys.exit(0) if c.argc > 0: # if there is an argument to the executable try: for archive_name in c.argv: lowercase_archive_name = archive_name.lower() if lowercase_archive_name.endswith('.zip'): if zipfile.is_zipfile(archive_name): zipper = zipfile.ZipFile(archive_name, mode="r") zipper.extractall() if user_platform == "Windows": stdout("'" + archive_name + "' was unpacked.") else: stdout("[\033[32m✓\033[0m] '" + archive_name + "' was unpacked.") else: if user_platform == "Windows": stderr("'" + archive_name + "' does not appear to be a zip file") else: stderr("[\033[31m!\033[0m] '" + archive_name + "' does not appear to be a zip file") elif lowercase_archive_name.endswith( '.tar.gz') or lowercase_archive_name.endswith( '.tgz') or lowercase_archive_name.endswith( '.tar.gzip'): if tarfile.is_tarfile(archive_name): tarball = tarfile.open(archive_name, mode="r:gz") tarball.extractall() if user_platform == "Windows": stdout("'" + archive_name + "' was unpacked.") else: stdout("[\033[32m✓\033[0m] '" + archive_name + "' was unpacked.") else: if user_platform == "Windows": stderr("'" + archive_name + "' does not appear to be a tar archive") else: stderr("[\033[31m!\033[0m] '" + archive_name + "' does not appear to be a tar archive") elif lowercase_archive_name.endswith( '.tar.bz2') or lowercase_archive_name.endswith( '.tar.bzip2'): if tarfile.is_tarfile(archive_name): bzball = tarfile.open(archive_name, mode="r:bz2") bzball.extractall() if user_platform == "Windows": stdout("'" + archive_name + "' was unpacked.") else: stdout("[\033[32m✓\033[0m] '" + archive_name + "' was unpacked.") else: if user_platform == "Windows": stderr("'" + archive_name + "' does not appear to be a tar archive") else: stderr("[\033[31m!\033[0m] '" + archive_name + "' does not appear to be a tar archive") else: if user_platform == "Windows": stderr( "Unable to identify the archive type for '" + archive_name + "'. This archive was not unpacked. Please check the file extension and try again." ) else: stderr( "[\033[31m!\033[0m] Unable to identify the archive type for '" + archive_name + "'. This archive was not unpacked. Please check the file extension and try again." ) except Exception as e: if user_platform == "Windows": stderr("Unable to unpack the archive '" + archive_name + "'. Error: " + str(e)) else: stderr("[\033[31m!\033[0m] Unable to unpack the archive '" + archive_name + "'. Error: " + str(e)) # ------------------------------------------------------------------------------------------ # [ DEFAULT MESSAGE FOR MATCH FAILURE ] # Message to provide to the user when all above conditional logic fails to meet a true condition # ------------------------------------------------------------------------------------------ else: if user_platform == "Windows": print( "Could not complete the command that you entered. Please try again." ) else: print( "[\033[31mX\033[0m] Could not complete the command that you entered. Please try again." ) sys.exit(1) # exit
def main(): import sys from Naked.commandline import Command #from Naked.toolshed.state import StateObject from Naked.toolshed.system import stderr #------------------------------------------------------------------------------------------ # [ Instantiate command line object ] # used for all subsequent conditional logic in the CLI application #------------------------------------------------------------------------------------------ c = Command(sys.argv[0], sys.argv[1:]) #------------------------------------------------------------------------------ # [ Instantiate state object ] #------------------------------------------------------------------------------ #state = StateObject() #------------------------------------------------------------------------------------------ # [ Command Suite Validation ] - early validation of appropriate command syntax # Test that user entered a primary command, print usage if not #------------------------------------------------------------------------------------------ if not c.command_suite_validates(): from Naked.commands.usage import Usage Usage().print_usage() sys.exit(1) #------------------------------------------------------------------------------------------ # [ PRIMARY COMMAND LOGIC ] # Test for primary commands and handle them #------------------------------------------------------------------------------------------ #------------------------------------------------------------------------------ # [ args ] - identify the parsed arguments for a command string (2)= help #------------------------------------------------------------------------------ if c.cmd == "args": if c.cmd2 == "help": from Naked.commands.args import help as args_help args_help() elif c.argc > 0: # there is an argument to where that is not help from Naked.commands.args import Args a = Args(c.arg_to_cmd) a.run() else: stderr( "The args command requires an example command as an argument. Use 'naked args help' for more information.", 1) #------------------------------------------------------------------------------ # [ build ] - build the C code in the Naked library (2)= help #------------------------------------------------------------------------------ elif c.cmd == "build": if c.cmd2 == "help": from Naked.commands.build import help as build_help build_help() else: from Naked.commands.build import compile_c_code import os, inspect abs_dirpath = os.path.join( os.path.dirname( os.path.abspath(inspect.getfile(inspect.currentframe()))), "toolshed", "c") compile_c_code(abs_dirpath) # function calls exit status code #------------------------------------------------------------------------------ # [ classify ] - search Python application classifiers and display to user (args)-search string #------------------------------------------------------------------------------ elif c.cmd == "classify": if c.cmd2 == "help": from Naked.commands.classifier import help as classifier_help classifier_help() else: if c.second: # if search string was given search_string = c.second else: search_string = "" # absence of search string detected in Classifier, defaults to the entire list instead of search from Naked.commands.classifier import Classifier c = Classifier(search_string) c.run() #------------------------------------------------------------------------------ # [ dist ] - distribute source files to PyPI (2)=register, sdist, swheel, wheel, win, all, help #------------------------------------------------------------------------------ elif c.cmd == "dist": if c.argc > 1: from Naked.commands.dist import Dist d = Dist() if c.cmd2 == "register": # python setup.py register d.run('register') elif c.cmd2 == "sdist": # python setup.py sdist upload d.run('sdist') elif c.cmd2 == "swheel": # python setup.py sdist bdist_wheel upload d.run('swheel') elif c.cmd2 == "wheel": # python setup.py bdist_wheel upload d.run('wheel') elif c.cmd2 == "win": # python setup.py bdist_wininst upload d.run('win') elif c.cmd2 == "all": # python setup.py sdist bdist_wheel bdist_wininst upload d.run('all') elif c.cmd2 == "help": # help for command from Naked.commands.dist import help as dist_help dist_help() else: stderr( "The naked dist secondary command was not recognized. Use 'naked dist help' for more information.", 1) else: stderr("Please enter a secondary command", 1) #------------------------------------------------------------------------------ # [ locate ] - locate Naked project files (2)= main, settings, setup, help #------------------------------------------------------------------------------ elif c.cmd == "locate": from Naked.commands.locate import Locator if c.cmd2 == "help": from Naked.commands.locate import help as locate_help locate_help() elif c.cmd2 == "main": l = Locator('main') elif c.cmd2 == "settings": l = Locator('settings') elif c.cmd2 == "setup": l = Locator('setup') else: l = Locator('') #handles error report to user #------------------------------------------------------------------------------ # [ make ] - make a new Naked project (2)=help (args)=project name #------------------------------------------------------------------------------ elif c.cmd == "make": from Naked.commands.make import MakeController if c.cmd2 == "help": from Naked.commands.make import help as make_help make_help() if c.arg1: # arg1 is not help so use it as the argument to the make command m = MakeController(c.arg1) else: m = MakeController(None) m.run() #------------------------------------------------------------------------------ # [ profile ] - run the profiler.py file in the Naked project (2)=help #------------------------------------------------------------------------------ elif c.cmd == "profile": if c.cmd2 == "help": from Naked.commands.profile import help as profile_help profile_help() else: from Naked.commands.profile import Profiler p = Profiler() p.run() #------------------------------------------------------------------------------ # [ pyh ] - help for python built-in library modules, classes, methods, functions #------------------------------------------------------------------------------ elif c.cmd == "pyh": if c.cmd2 == "help": from Naked.commands.pyh import pyh_help pyh_help() else: if c.argc > 1: from Naked.commands.pyh import python_help python_help(c.arg1) else: stderr( "Please enter a query term with the pyh command. Use 'naked pyh help' for more information.", 1) #------------------------------------------------------------------------------ # [ test ] - Run unit tests on the project (2)= help,nose,pytest,tox,unittest (see help for args) #------------------------------------------------------------------------------ elif c.cmd == "test": if c.argc > 1: if c.cmd2 == "help": from Naked.commands.test import help as tox_help tox_help() elif c.cmd2 == "nose": from Naked.commands.test import NoseTester n = NoseTester() n.run() elif c.cmd2 == "pytest": from Naked.commands.test import PyTester p = PyTester() p.run() elif c.cmd2 == "tox": from Naked.commands.test import ToxTester if c.arg2: #user specified a python version to run with one of the tox version defs t = ToxTester(c.arg2) #instantiate with the python version else: t = ToxTester() t.run() elif c.cmd2 == "unittest": from Naked.commands.test import UnitTester if c.arg2: t = UnitTester(c.arg2) t.run() else: stderr( "Please include a unit test file path. Use 'naked test help' for more information.", 1) else: stderr( "The secondary command was not recognized. Use 'naked test help' for more information.", 1) else: stderr( "Please include a secondary command with the 'naked test' command. Use 'naked dist help' for more information.", 1) #------------------------------------------------------------------------------------------ # [ NAKED FRAMEWORK COMMANDS ] # Naked framework provides default help, usage, and version commands for all applications # --> settings for user messages are assigned in the lib/PROJECT/settings.py file #------------------------------------------------------------------------------------------ elif c.help( ): # User requested naked help (help.py module in commands directory) from Naked.commands.help import Help Help().print_help() elif c.usage( ): # user requested naked usage info (usage.py module in commands directory) from Naked.commands.usage import Usage Usage().print_usage() elif c.version( ): # user requested naked version (version.py module in commands directory) from Naked.commands.version import Version Version().print_version() #------------------------------------------------------------------------------------------ # [ DEFAULT MESSAGE FOR MATCH FAILURE ] # Message to provide to the user when all above conditional logic fails to meet a true condition #------------------------------------------------------------------------------------------ else: print( "Could not complete the command that you entered. Please try again." ) sys.exit(1) #exit
def main(): import sys from Naked.commandline import Command from Naked.toolshed.state import StateObject #------------------------------------------------------------------------------------------ # [ Instantiate command line object ] # used for all subsequent conditional logic in the CLI application #------------------------------------------------------------------------------------------ c = Command(sys.argv[0], sys.argv[1:]) #------------------------------------------------------------------------------ # [ Instantiate state object ] #------------------------------------------------------------------------------ state = StateObject() #------------------------------------------------------------------------------------------ # [ Command Suite Validation ] - early validation of appropriate command syntax # Test that user entered at least one argument to the executable, print usage if not #------------------------------------------------------------------------------------------ if not c.command_suite_validates(): from commit_entropy.settings import usage as commit_entropy_usage print(commit_entropy_usage) sys.exit(1) #------------------------------------------------------------------------------------------ # [ NAKED FRAMEWORK COMMANDS ] # Naked framework provides default help, usage, and version commands for all applications # --> settings for user messages are assigned in the lib/commit_entropy/settings.py file #------------------------------------------------------------------------------------------ if c.help(): # User requested commit-entropy help information from commit_entropy.settings import help as entropy_help print(commit_entropy_help) sys.exit(0) elif c.usage(): # User requested commit-entropy usage information from commit_entropy.settings import usage as commit_entropy_usage print(commit_entropy_usage) sys.exit(0) elif c.version(): # User requested commit-entropy version information from commit_entropy.settings import app_name, major_version, minor_version, patch_version version_display_string = app_name + ' ' + major_version + '.' + minor_version + '.' + patch_version print(version_display_string) sys.exit(0) #------------------------------------------------------------------------------------------ # [ PRIMARY COMMAND LOGIC ] # Enter your command line parsing logic below #------------------------------------------------------------------------------------------ # [[ Example usage ]] ------------------------------->>> # if c.cmd == 'hello': # if c.cmd2 = 'world': # if c.option('--print'): # print('Hello World!') # elif c.cmd == 'spam': # if c.option_with_arg('--with'): # friend_of_spam = c.arg('--with') # user enters commit-entropy spam --with eggs # print('spam and ' + friend_of_spam) # prints 'spam and eggs' # elif c.cmd == 'naked': # if c.flag("--language"): # lang = c.flag_arg("--language") # user enters commit-entropy naked --language=python # print("Naked & " + lang) # prints 'Naked & python' # End example --------------------------------------->>> elif c.cmd == 'csv': from commit_entropy.commands.csv_printer import CsvPrinter printer = CsvPrinter() printer.run() #------------------------------------------------------------------------------------------ # [ DEFAULT MESSAGE FOR MATCH FAILURE ] # Message to provide to the user when all above conditional logic fails to meet a true condition #------------------------------------------------------------------------------------------ else: print("Could not complete the command that you entered. Please try again.") sys.exit(1) #exit