def search(args: Dict[str, str], config: Dict[str, str]):
"""
Search artifacts within the knowledge base of kb.
Arguments:
args: - a dictionary containing the following fields:
query -> filter for the title field of the artifact
category -> filter for the category field of the artifact
tags -> filter for the tags field of the artifact
author -> filter for the author field of the artifact
status -> filter for the status field of the artifact
config: - a configuration dictionary containing at least
the following keys:
PATH_KB_DB - the database path of KB
PATH_KB_DATA - the data directory of KB
PATH_KB_HIST - the history menu path of KB
EDITOR - the editor program to call
"""
# Check initialization
initializer.init(config)
tags_list = None
if args["tags"] and args["tags"] != "":
tags_list = args["tags"].split(';')
conn = db.create_connection(config["PATH_KB_DB"])
rows = db.get_artifacts_by_filter(
conn,
title=args["query"],
category=args["category"],
tags=tags_list,
status=args["status"],
author=args["author"])
# rows.sort(key=lambda x: x[1])
artifacts = sorted(rows, key=lambda x: x.title)
# Write to history file
history.write(config["PATH_KB_HIST"], artifacts)
# Is full_identifier mode enabled?
if args["full_identifier"]:
printer.print_search_result_full_mode(artifacts)
return
# Print resulting list
color_mode = not args["no_color"]
if args["verbose"]:
printer.print_search_result_verbose(artifacts, color_mode)
else:
printer.print_search_result(artifacts, color_mode)
def search(args: Dict[str, str], config: Dict[str, str]):
"""
Search artifacts within the knowledge base of kb and display the output on the terminal.
Arguments:
args: - a dictionary containing the following fields:
query -> filter for the title field of the artifact
category -> filter for the category field of the artifact
tags -> filter for the tags field of the artifact
author -> filter for the author field of the artifact
status -> filter for the status field of the artifact
config: - a configuration dictionary containing at least
the following keys:
PATH_KB_DB - the database path of KB
PATH_KB_DATA - the data directory of KB
PATH_KB_HIST - the history menu path of KB
EDITOR - the editor program to call
"""
result = search_kb(args, config)
# List all categories
if args.get("all_categories", False) is True:
others.generate_list(args, result, 'Categories')
sys.exit(0)
# List all tags
if args.get("all_tags", False) is True:
others.generate_list(args, result, 'Tags')
sys.exit(0)
# Write to history file
history.write(config["PATH_KB_HIST"], result)
# Print resulting list
color_mode = not args["no_color"]
if args["verbose"]:
printer.print_search_result_verbose(result, color_mode)
else:
printer.print_search_result(result, color_mode)
def grep(args: Dict[str, str], config: Dict[str, str]):
"""
Grep through the list of artifacts of the knowledge base of kb.
Arguments:
args: - a dictionary containing the following fields:
regex -> the regex to search for
case_insensitive -> a boolean, if true,
the search will be case insensitive
matches -> a boolean, if true, only the raw
matches will be shown
verbose -> a boolean, if true, a verbose
output is produced on screen
config: - a configuration dictionary containing at least
the following keys:
PATH_KB_DB - the database path of KB
PATH_KB_DATA - the data directory of KB
PATH_KB_HIST - the history menu path of KB
"""
initializer.init(config)
conn = db.create_connection(config["PATH_KB_DB"])
# Get all artifacts
rows = db.get_artifacts_by_filter(conn, title="")
# Get all the file paths related to the artifacts in the database
file_list = [Path(config["PATH_KB_DATA"], r.category, r.title)
for r in rows]
# Grep in the files
results = fs.grep_in_files(
file_list,
args["regex"],
args["case_insensitive"])
# Get the list of artifact tuples in the form (category,title)
artifact_names = [fs.get_filename_parts_wo_prefix(
res[0], config["PATH_KB_DATA"]) for res in results]
# If user specied --matches -> just show matching lines and exit
if args["matches"]:
printer.print_grep_matches(artifact_names)
sys.exit(0)
# Get the set of uniq artifacts
uniq_artifact_names = set(artifact_names)
# Get the number of matches (hits) for each path found
filecounts = get_hits_per_artifact_name(artifact_names)
grep_result = list()
for art in uniq_artifact_names:
artifact = db.get_artifacts_by_filter(
conn, category=art[0], title=art[1])[0]
if artifact:
no_of_hits = filecounts[art]
grep_result.append((artifact, no_of_hits))
# Sort by number of hits, the largest -> the first
grep_result.sort(key=lambda x: x[1], reverse=True)
grep_artifacts = [r[0] for r in grep_result]
grep_hits = [r[1] for r in grep_result]
# Write to history file
history.write(config["PATH_KB_HIST"], grep_artifacts)
color_mode = not args["no_color"]
if args["verbose"]:
printer.print_grep_result_verbose(
grep_artifacts, grep_hits, color_mode)
else:
printer.print_grep_result(grep_artifacts, grep_hits, color_mode)
