src/pls.nim
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 |
import
sequtils,
pegs,
os,
parseopt,
strutils,
tables
import
plspkg/config
type ConfigParseError = ref object of ValueError
type RuntimeError = ref object of ValueError
let USAGE* = """$1 v$2 - $3
(c) 2021 $4
Usage:
pls <action> [<thing>, <thing2>, ...] Executes <action> (on <thing>).
<thing> can contain a start and/or leading *
to perform simple searches.
Options:
--help, -h Displays this message.
--actions, -a[:<query>] Displays all known actions, optionally matching <query>.
<query> can contain a start and/or leading * for simple searches.
--deps, -d Displays dependencies of the specified command.
--things, -t[:<query>] Displays all known things, optionally matching <query>
<query> can contain a start and/or leading * for simple searches.
--inspect, -i Display information on the specified command.
--full, -f If -a or -t are specified, display all properties for items.
If -d is specified, outputs debug information for configuration parsing.
Otherwise, print additional information when executing commands.
--version, -v Displays the version of the application.
""" % [pkgTitle, pkgVersion, pkgDescription, pkgAuthor]
# PEG strings used when parsing the configuration file.
let PEG_PLACEHOLDER* = peg"'{{' {[a-zA-Z0-9._-]+} '}}'"
let PEG_ID* = peg"^[a-z0-9][a-zA-Z0-9._-]+$"
let PEG_DEF* = peg"^[a-z0-9][a-zA-Z0-9._-]+ ('+' [a-z0-9][a-zA-Z0-9._-]+)*$"
# Hash containing all the actions and things saved in the configuration file.
var DATA* = newOrderedTable[string, OrderedTableRef[string, OrderedTableRef[string, string]]]()
DATA["actions"] = newOrderedTable[string, OrderedTableRef[string, string]]()
DATA["things"] = newOrderedTable[string, OrderedTableRef[string, string]]()
DATA["deps"] = newOrderedTable[string, OrderedTableRef[string, string]]()
# Default configuration file, saved if no pls.yml is present on the system.
const DEFAULT_CFG = """
actions:
# Define actions here
deps:
# Define dependencies here
things:
# Define things here
"""
# The list of actions called, including dependencies
var COMMAND_STACK = newSeq[string]()
# The path to the pls.yml configuration file.
var CONFIG_FILE: string
if defined(windows):
CONFIG_FILE = getenv("USERPROFILE") / "pls.yml"
else:
CONFIG_FILE = getenv("HOME") / "pls.yml"
# Argument/option management
var ARGS = newSeq[string]()
var OPT_INSPECT = false
var OPT_FULL = false
var OPT_DEPS = false
var OPT_SHOW = ""
var OPT_SHOW_QUERY = ""
### Helper Methods ##
proc debug(s: string): void =
if OPT_INSPECT:
echo ". $1" % s
proc full_debug(s: string): void =
if OPT_FULL:
debug(s)
proc parseProperty(line: string, count: int): tuple[name: string, value: string] =
let parts = line.split(":")
if parts.len < 2:
raise ConfigParseError(msg: "Line $1 - Invalid property." % $count)
result.name = parts[0].strip
result.value = parts[1..parts.len-1].join(":").strip
proc parseCommand(item: string, count: int = 0): tuple[action: string, things: seq[string]] =
let parts = item.split(" ")
result.action = ""
result.things = newSeq[string]()
if parts.len == 0:
raise ConfigParseError(msg: "Line $1 - No action specified.")
result.action = parts[0].strip
if parts.len == 1:
raise ConfigParseError(msg: "Line $1 - No thing specified for action '$2'." % [$count, result.action])
if not result.action.match(PEG_ID):
raise ConfigParseError(msg: "Line $1 - Invalid action '$2'." % [$count, result.action])
for part in parts[1..parts.len-1]:
let thing = part.strip
if not thing.match(PEG_ID):
raise ConfigParseError(msg: "Line $1 - Invalid thing '$2'." % [$count, thing])
result.things.add(thing)
proc parseConfig(cfg: string): void =
full_debug("=== Parsing Configuration Start ===")
var section = ""
var itemId = ""
var indent = 0
var count = 0
var depCount = 0
for l in cfg.lines:
count += 1
# Third level: items
if l.startsWith(" "):
var line = l.strip
var obj = ""
if line.len == 0:
raise ConfigParseError(msg: "Line $1 - Invalid empty line within item." % $count)
if line[0] == '#':
# comment
full_debug("# Comment: $1" % line)
continue
if section == "actions":
obj = "action ID"
if section == "things":
obj = "property name"
if section == "deps":
obj = "dependency"
if l.strip(true, false).len < l.strip(false, true).len-4:
raise ConfigParseError(msg: "Line $1 - Invalid $2 indentation, expected 4 spaces." % [$count, obj])
if section == "" or indent == 0:
raise ConfigParseError(msg: "Line $1 - Invalid $2 indentation." % [$count, obj])
if itemId == "":
raise ConfigParseError(msg: "Line $1 - Invalid $2 indentation (not within an item)." % [$count, obj])
if line[0] == '-':
if section != "deps":
raise ConfigParseError(msg: "Line $1 - Unexpected array in section '$2'" % [$count, section])
let item = line[1..line.len-1].strip
let dep = parseCommand(item, count)
DATA[section][itemId][$depCount] = "$1 $2" % [dep.action, dep.things.join(" ")]
depCount += 1
continue
let p = parseProperty(line, count)
if (section == "actions" and not p.name.match(PEG_DEF)) or (section == "things" and not p.name.match(PEG_ID)):
raise ConfigParseError(msg: "Line $1 - Invalid $2 '$3'" % [$count, obj, p.name])
if DATA[section][itemId].hasKey(p.name):
raise ConfigParseError(msg: "Line $1 - Duplicate property '$2'" % [$count, p.name])
DATA[section][itemId][p.name] = p.value
full_debug(" DATA.$1.$2.$3 = $4" % [section, itemId, p.name, p.value])
indent = 4
continue
# Second level: definitions
if l.startsWith(" "):
var line = l.strip
var obj = ""
if line.len == 0:
raise ConfigParseError(msg: "Line $1 - Invalid empty line within section." % $count)
if line[0] == '#':
# comment
full_debug("# Comment: $1" % line)
continue
if section == "actions":
obj = "action"
elif section == "things":
obj = "thing"
elif section == "deps":
obj = "dependency"
depCount = 0
if l.strip(true, false).len < l.strip(false, true).len-2:
raise ConfigParseError(msg: "Line $1 - Invalid $2 indentation, expected 2 spaces." % [$count, obj])
if section == "":
raise ConfigParseError(msg: "Line $1 - Invalid $2 indentation." % [$count, obj])
if line[line.len-1] != ':' or line == ":":
raise ConfigParseError(msg: "Line $1 - Invalid $2 identifier." % [$count, obj])
itemId = line[0..line.len-2]
if section == "deps":
let instance = parseCommand(itemId, count)
itemId = "$1 $2" % [instance.action, instance.things.join(" ")]
elif ["things", "actions"].contains(section):
if not itemId.match(PEG_ID):
raise ConfigParseError(msg: "Line $1 - Invalid $2 identifier '$3'." % [$count, obj, itemId])
if DATA[section].hasKey(itemId):
raise ConfigParseError(msg: "Line $1 - Duplicate item '$2'" % [$count, itemId])
# Start new item
DATA[section][itemId] = newOrderedTable[string, string]()
full_debug(" DATA.$2.$3" % [obj, section, itemId])
indent = 2
continue
if l == "":
itemId = ""
continue
# First level: sections
if l == "actions:":
if section == "actions":
raise ConfigParseError(msg: "Line $1 - Duplicated 'actions' section." % $count)
section = "actions"
full_debug("DATA.$1" % section)
continue
if l == "deps:":
if section == "deps":
raise ConfigParseError(msg: "Line $1 - Duplicated 'deps' section." % $count)
section = "deps"
full_debug("DATA.$1" % section)
continue
if l == "things:":
if section == "things":
raise ConfigParseError(msg: "Line $1 - Duplicated 'things' section." % $count)
section = "things"
full_debug("DATA.$1" % section)
continue
if l.strip.startsWith("#"):
# comment
full_debug("Comment: $1" % l)
continue
else:
raise ConfigParseError(msg: "Line $1 - Invalid line." % $count)
full_debug("=== Parsing Configuration End ===")
proc lookupActionDef(action, thing: string, props: seq[string], deps: bool): string =
result = ""
if not DATA["actions"].hasKey(action):
if deps:
# Deps exist, do not fail, just return empty action.
return ""
raise RuntimeError(msg: "Action '$1' not found" % action)
var defs = DATA["actions"][action]
var score = 0
# Cycle through action definitions
for key, val in defs.pairs:
var params = key.split("+")
# Check if all params are available
var match = params.all do (x: string) -> bool:
props.contains(x)
if match and params.len > score:
score = params.len
result = val
debug(" Thing: $1\n. -> Matching Definition: $2\n. -> Command Definition: $3" % [thing, key, val])
proc resolvePlaceholder(ident, initialThing: string): string =
var id = ident
var thing = initialThing
let parts = id.split(".")
if parts.len > 2:
raise RuntimeError(msg: "Invalid placeholder '$1'." % id)
elif parts.len == 2:
thing = parts[0]
id = parts[1]
if not DATA["things"].hasKey(thing):
raise RuntimeError(msg: "Unable to access thing '$1' in placeholder '$2'." % [thing, ident])
if not DATA["things"][thing].hasKey(id):
raise RuntimeError(msg: "Unable to access property '$1' in thing '$2' within placeholder '$3'." % [id, thing, ident])
result = DATA["things"][thing][id]
result = result.replace(PEG_PLACEHOLDER) do (m: int, n: int, c: openArray[string]) -> string:
return resolvePlaceholder(c[0], thing)
debug(" Resolving placeholder: $1 -> $2" % ["{{$1.$2}}" % [thing, id], result])
proc printCommandWithDeps*(command: string, level = 0): void =
echo " ".repeat(level) & " - " & command
if DATA["deps"].contains(command):
for dep in DATA["deps"][command].values:
printCommandWithDeps(dep, level+1)
proc execute*(action, thing: string): int {.discardable.} =
let command = "$1 $2" % [action, thing]
if COMMAND_STACK.contains(command):
debug("Command: $1 (skipped)" % command)
return 0
else:
debug("Command: $1" % command)
COMMAND_STACK.add(command)
# Check and execute dependencies
var hasDeps = false
var lastResult = 0
if DATA["deps"].hasKey(command):
for dep in DATA["deps"][command].values:
let instance = parseCommand(dep)
for instanceThing in instance.things:
hasDeps = true
if lastResult == 0:
lastResult = execute(instance.action, instanceThing)
result = 0
if not DATA["things"].hasKey(thing):
if hasDeps:
return 0
raise RuntimeError(msg: "Thing '$1' not found. Action '$2' aborted." % [thing, action])
let props = DATA["things"][thing]
var keys = newSeq[string](0)
for key, val in props.pairs:
keys.add key
var cmd = lookupActionDef(action, thing, keys, hasDeps)
if cmd != "":
cmd = cmd.replace(PEG_PLACEHOLDER) do (m: int, n: int, c: openArray[string]) -> string:
return resolvePlaceholder(c[0], thing)
debug(" -> Resolved Command: " & cmd)
if not OPT_INSPECT:
if OPT_FULL:
echo "=== Executing Command: $1 -> $2" % [command, cmd]
result = execShellCmd cmd
if result != 0:
raise RuntimeError(msg: "Command '$1' failed (Error Code: $2)." % [command, $result])
proc filterItems*(t: string, query=""): seq[string] =
result = newSeq[string]()
var endsWith = false
var startsWith = false
var contains = false
if query.endsWith("*"):
startsWith = true
if query.startsWith("*"):
endsWith = true
if startsWith and endsWith:
contains = true
let q = query.replace("*", "")
let filter = proc (str: string): bool =
if contains:
return str.contains(q)
elif endsWith:
return str.endsWith(q)
elif startsWith:
return str.startsWith(q)
elif q.len == 0:
return true
else:
return str == q
for s, props in DATA[t].pairs:
if s.filter():
result.add(s)
proc show*(t: string, query="", full = false): void =
let keys = filterItems(t, query)
for s in keys:
if OPT_FULL:
echo "\n$1:" % s
for key, val in DATA[t][s].pairs:
echo " $1: $2" % [key, val]
else:
echo "- $1" % s
### MAIN ###
for kind, key, val in getopt():
case kind:
of cmdArgument:
ARGS.add key
of cmdLongOption, cmdShortOption:
case key:
of "help", "h":
echo USAGE
quit(0)
of "version", "v":
echo pkgVersion
quit(0)
of "full", "f":
OPT_FULL = true
of "inspect", "i":
OPT_INSPECT = true
of "deps", "d":
OPT_DEPS = true
of "actions", "a":
OPT_SHOW = "actions"
OPT_SHOW_QUERY = val
of "things", "t":
OPT_SHOW = "things"
OPT_SHOW_QUERY = val
else:
discard
else:
discard
if not CONFIG_FILE.fileExists():
CONFIG_FILE.writeFile(DEFAULT_CFG)
try:
CONFIG_FILE.parseConfig()
except:
echo "(!) Unable to parse $1: $2" % [CONFIG_FILE, getCurrentExceptionMsg()]
quit(1)
if ARGS.len < 1:
if OPT_SHOW != "":
show(OPT_SHOW, OPT_SHOW_QUERY, OPT_FULL)
quit(0)
else:
echo USAGE
quit(0)
elif ARGS.len < 2:
stderr.writeLine "(!) Too few arguments - no thing(s) specified."
else:
let action = ARGS[0]
let targets = ARGS[1..ARGS.len-1]
if OPT_DEPS:
printCommandWithDeps("$1 $2" % [action, targets.join(" ")])
quit(0)
for arg in targets:
for thing in filterItems("things", arg):
try:
execute(action, thing)
except:
stderr.writeLine "(!) " & getCurrentExceptionMsg()
|