Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add tab-completion for paths #45

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add tab-completion for paths #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d01fc1b
Add `argcomplete` dependency
ulken Nov 23, 2020
4c93228
Add tab-completion for paths
ulken Nov 30, 2020
71a68ef
Append space on completion
ulken Dec 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 66 additions & 16 deletions passhole/passhole.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@
import shutil
import logging
import argparse
import argcomplete
from argcomplete import warn
from configparser import ConfigParser
from collections import OrderedDict

Expand Down Expand Up @@ -351,14 +353,14 @@ def prompt_open(name, database, keyfile, no_password, no_cache, cache_timeout):
log.debug('Detected non-interactive shell')
try:
p = subprocess.Popen(
["zenity", "--entry", "--hide-text", "--text='{}'".format(prompt)],
["zenity", "--entry", "--hide-text", "--text={}".format(prompt)],
stdin=subprocess.PIPE,
stdout=subprocess.PIPE,
stderr=open(os.devnull, 'w'),
close_fds=True
)
except FileNotFoundError:
log.error(bold("zenity ") + red("not found."))
log.error(bold("zenity ") + red("not found"))
sys.exit(1)
password = p.communicate()[0].decode('utf-8').rstrip('\n')

Expand Down Expand Up @@ -490,7 +492,7 @@ def prompt_open(name, database, keyfile, no_password, no_cache, cache_timeout):
log.error(red("No default database specified in config"))
sys.exit(1)
return prompt_open(
section,
default_section,
c[default_section].get('database'),
c[default_section].get('keyfile'),
c[default_section].get('no-password'),
Expand Down Expand Up @@ -720,21 +722,21 @@ def decompose_path(path):
"""Process path into parent group and child item"""

if '/' in path.strip('/'):
[group_path, child_name] = path.strip('/').rsplit('/', 1)
group_path, child_name = path.strip('/').rsplit('/', 1)
else:
group_path = ''
child_name = path.strip('/')
group_path = path.rstrip('/') if path.endswith('/') else ''
child_name = path.lstrip('/') if path.startswith('/') else ''

log.debug("Decomposed path into: '{}' and '{}'".format(group_path + '/', child_name))
return [group_path + '/', child_name]
return group_path + '/', child_name


def add(args):
"""Create new entry/group"""

kp = open_database(**vars(args))

[group_path, child_name] = decompose_path(args.path)
group_path, child_name = decompose_path(args.path)
if not child_name:
log.error(red("Path is invalid"))
sys.exit(1)
Expand Down Expand Up @@ -892,7 +894,7 @@ def move(args):
log.error(red("Moving elements between databases not supported"))
sys.exit(1)

[group_path, child_name] = decompose_path(args.dest_path)
group_path, child_name = decompose_path(args.dest_path)
# parent_group = get_group(dest_kp, group_path)
parent_group = get_group(src_kp, group_path)

Expand Down Expand Up @@ -962,6 +964,49 @@ def info(args):
print(green("Encryption Algorithm: ") + kp.encryption_algorithm)
print(green("Database Version: ") + '.'.join(map(str, kp.version)))

def login(args):
"""Log in to database (mainly for caching purposes)"""

open_database(**vars(args))
print(green("Logged in to database"))

def PathCompleter(prefix, parsed_args, **kwargs):
"""List paths matching `prefix`"""

def list_matching_objects(query, kp, **kwargs):
# group selected? -> show subgroups and group entries
if '/' in query:
group_path, child_name = decompose_path(query)
group = kp.find_groups(path=group_path, first=True, **kwargs)

return (
kp.find_groups(name=child_name, group=group, **kwargs),
kp.find_entries(title=child_name, group=group, **kwargs)
)

# show first-level (i.e. in root group) groups and entries
return (
kp.find_groups(name=query, group=kp.root_group, **kwargs),
kp.find_entries(title=query, group=kp.root_group, **kwargs)
)

try:
kp = open_database(**vars(parsed_args))
except SystemExit:
# if `zenity` is missing, there is no way to supply password while completing
# use manual `login` command for database to be cached and path completion to work
warn(red("Log in") + " to database to " + bold("auto-complete paths"))
return []

groups, entries = list_matching_objects(
prefix,
kp,
regex=True,
recursive=False
)

return [g.name + "/" for g in groups] + [e.path for e in entries]


def create_parser():
"""Create argparse object"""
Expand All @@ -977,7 +1022,7 @@ def create_parser():

# process args for `list` command
list_parser = subparsers.add_parser('list', aliases=['ls'], help="list entries in the database")
list_parser.add_argument('path', nargs='?', metavar='PATH', default=None, type=str, help=path_help)
list_parser.add_argument('path', nargs='?', metavar='PATH', default=None, type=str, help=path_help).completer = PathCompleter
list_parser.add_argument('--username', action='store_true', default=False, help="show username in parenthesis")
list_parser.set_defaults(func=list_entries)

Expand All @@ -993,24 +1038,24 @@ def create_parser():

# process args for `remove` command
remove_parser = subparsers.add_parser('remove', aliases=['rm'], help="remove an entry")
remove_parser.add_argument('path', metavar='PATH', type=str, help=path_help)
remove_parser.add_argument('path', metavar='PATH', type=str, help=path_help).completer = PathCompleter
remove_parser.set_defaults(func=remove)

# process args for `move` command
move_parser = subparsers.add_parser('move', aliases=['mv'], help="move an entry or group")
move_parser.add_argument('src_path', metavar='SRC_PATH', type=str, help=path_help)
move_parser.add_argument('dest_path', metavar='DEST_PATH', type=str, help=path_help)
move_parser.add_argument('src_path', metavar='SRC_PATH', type=str, help=path_help).completer = PathCompleter
move_parser.add_argument('dest_path', metavar='DEST_PATH', type=str, help=path_help).completer = PathCompleter
move_parser.set_defaults(func=move)

# process args for `show` command
show_parser = subparsers.add_parser('show', help="show the contents of an entry")
show_parser.add_argument('path', metavar='PATH', type=str, help="path to entry")
show_parser.add_argument('path', metavar='PATH', type=str, help="path to entry").completer = PathCompleter
show_parser.add_argument('--field', metavar='FIELD', type=str, default=None, help="show the contents of a specific field")
show_parser.set_defaults(func=show)

# process args for `edit` command
edit_parser = subparsers.add_parser('edit', help="edit the contents of an entry or group")
edit_parser.add_argument('path', metavar='PATH', type=str, help=path_help)
edit_parser.add_argument('path', metavar='PATH', type=str, help=path_help).completer = PathCompleter
edit_parser.add_argument('--field', metavar='FIELD', type=str, default=None, help="edit the contents of a specific field")
edit_parser.add_argument('--set', metavar=('FIELD', 'VALUE'), type=str, nargs=2, default=None, help="add/edit the contents of a specific field, noninteractively")
edit_parser.add_argument('--remove', metavar='FIELD', type=str, default=None, help="remove a field from the entry")
Expand Down Expand Up @@ -1046,11 +1091,15 @@ def create_parser():
dump_parser.add_argument('name', type=str, nargs='?', default=None, help="name of database")
dump_parser.set_defaults(func=dump)

# process args for `dump` command
# process args for `info` command
info_parser = subparsers.add_parser('info', help="print database information")
info_parser.add_argument('name', type=str, nargs='?', default=None, help="name of database")
info_parser.set_defaults(func=info)

# process args for `login` command
login_parser = subparsers.add_parser('login', help="log in to database")
login_parser.add_argument('name', type=str, nargs='?', default=None, help="name of database")
login_parser.set_defaults(func=login)

# optional arguments
parser.add_argument('--debug', action='store_true', default=False, help="enable debug messages")
Expand All @@ -1068,6 +1117,7 @@ def create_parser():
def main():

parser = create_parser()
argcomplete.autocomplete(parser)
args = parser.parse_args()

if args.debug:
Expand Down
3 changes: 2 additions & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@
"pynput",
"pykeepass_cache",
"colorama",
"future"
"future",
"argcomplete"
],
data_files=[
('share/man/man1', ['passhole.1'] if os.path.exists('passhole.1') else []),
Expand Down