mirror of
https://github.com/Erreur32/cheat.git
synced 2024-10-31 21:11:07 +01:00
05400a92ed
If the `DEFAULT_CHEAT_DIR` environment variable contains the `~` — as shortcut for the users home directory — or environment variables like `$HOME`, the program bails. This change allows the usage of both.
93 lines
2.7 KiB
Python
93 lines
2.7 KiB
Python
import os
|
|
|
|
from cheat import cheatsheets
|
|
from cheat.utils import die
|
|
|
|
def default_path():
|
|
""" Returns the default cheatsheet path """
|
|
|
|
# determine the default cheatsheet dir
|
|
default_sheets_dir = os.environ.get('DEFAULT_CHEAT_DIR') or os.path.join('~', '.cheat')
|
|
default_sheets_dir = os.path.expanduser(os.path.expandvars(default_sheets_dir))
|
|
|
|
# create the DEFAULT_CHEAT_DIR if it does not exist
|
|
if not os.path.isdir(default_sheets_dir):
|
|
try:
|
|
# @kludge: unclear on why this is necessary
|
|
os.umask(0000)
|
|
os.mkdir(default_sheets_dir)
|
|
|
|
except OSError:
|
|
die('Could not create DEFAULT_CHEAT_DIR')
|
|
|
|
# assert that the DEFAULT_CHEAT_DIR is readable and writable
|
|
if not os.access(default_sheets_dir, os.R_OK):
|
|
die('The DEFAULT_CHEAT_DIR (' + default_sheets_dir +') is not readable.')
|
|
if not os.access(default_sheets_dir, os.W_OK):
|
|
die('The DEFAULT_CHEAT_DIR (' + default_sheets_dir +') is not writable.')
|
|
|
|
# return the default dir
|
|
return default_sheets_dir
|
|
|
|
|
|
def get():
|
|
""" Assembles a dictionary of cheatsheets as name => file-path """
|
|
cheats = {}
|
|
|
|
# otherwise, scan the filesystem
|
|
for cheat_dir in reversed(paths()):
|
|
cheats.update(
|
|
dict([
|
|
(cheat, os.path.join(cheat_dir, cheat))
|
|
for cheat in os.listdir(cheat_dir)
|
|
if not cheat.startswith('.')
|
|
and not cheat.startswith('__')
|
|
])
|
|
)
|
|
|
|
return cheats
|
|
|
|
|
|
def paths():
|
|
""" Assembles a list of directories containing cheatsheets """
|
|
sheet_paths = [
|
|
default_path(),
|
|
cheatsheets.sheets_dir()[0],
|
|
]
|
|
|
|
# merge the CHEATPATH paths into the sheet_paths
|
|
if 'CHEATPATH' in os.environ and os.environ['CHEATPATH']:
|
|
for path in os.environ['CHEATPATH'].split(os.pathsep):
|
|
if os.path.isdir(path):
|
|
sheet_paths.append(path)
|
|
|
|
if not sheet_paths:
|
|
die('The DEFAULT_CHEAT_DIR dir does not exist or the CHEATPATH is not set.')
|
|
|
|
return sheet_paths
|
|
|
|
|
|
def list():
|
|
""" Lists the available cheatsheets """
|
|
sheet_list = ''
|
|
pad_length = max([len(x) for x in get().keys()]) + 4
|
|
for sheet in sorted(get().items()):
|
|
sheet_list += sheet[0].ljust(pad_length) + sheet[1] + "\n"
|
|
return sheet_list
|
|
|
|
|
|
def search(term):
|
|
""" Searches all cheatsheets for the specified term """
|
|
result = ''
|
|
|
|
for cheatsheet in sorted(get().items()):
|
|
match = ''
|
|
for line in open(cheatsheet[1]):
|
|
if term in line:
|
|
match += ' ' + line
|
|
|
|
if match != '':
|
|
result += cheatsheet[0] + ":\n" + match + "\n"
|
|
|
|
return result
|