Better CLI parameters parsing.
parent
e88c19c892
commit
c3d5aef951
|
@ -8,7 +8,6 @@ require "baguette-crystal-base"
|
||||||
require "../src/authd.cr"
|
require "../src/authd.cr"
|
||||||
|
|
||||||
# require "./altideal-client.cr"
|
# require "./altideal-client.cr"
|
||||||
# require "./yaml_dates.cr" # from "3 days - 2 hours" to YAML-compliant dates
|
|
||||||
# require "./yaml_uuid.cr" # YAML UUID parser
|
# require "./yaml_uuid.cr" # YAML UUID parser
|
||||||
# require "./authd_api.cr" # Authd interface functions
|
# require "./authd_api.cr" # Authd interface functions
|
||||||
|
|
||||||
|
@ -26,9 +25,12 @@ class Context
|
||||||
# class_property print_owner = true
|
# class_property print_owner = true
|
||||||
# class_property print_nb_comments = true
|
# class_property print_nb_comments = true
|
||||||
|
|
||||||
class_property user_profile : Hash(String,JSON::Any)?
|
|
||||||
class_property command = "not-implemented"
|
class_property command = "not-implemented"
|
||||||
|
|
||||||
|
class_property user_profile : Hash(String,JSON::Any)?
|
||||||
|
class_property phone : String?
|
||||||
|
class_property email : String?
|
||||||
|
|
||||||
# TODO: inner arguments.
|
# TODO: inner arguments.
|
||||||
# Will be parsed later, with a specific parser.
|
# Will be parsed later, with a specific parser.
|
||||||
class_property args : Array(String)? = nil
|
class_property args : Array(String)? = nil
|
||||||
|
@ -51,21 +53,32 @@ class Actions
|
||||||
password
|
password
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def self.ask_something(str : String) : String?
|
||||||
|
STDOUT << "#{str} "
|
||||||
|
STDOUT.flush
|
||||||
|
answer = STDIN.gets.try &.chomp
|
||||||
|
answer
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
property the_call = {} of String => Proc(Nil)
|
property the_call = {} of String => Proc(Nil)
|
||||||
property authd : AuthD::Client
|
property authd : AuthD::Client
|
||||||
|
|
||||||
def initialize(@authd)
|
def initialize(@authd)
|
||||||
# Admin section.
|
|
||||||
@the_call["user-add"] = ->user_add
|
@the_call["user-add"] = ->user_add
|
||||||
@the_call["user-mod"] = ->user_mod
|
@the_call["user-mod"] = ->user_mod
|
||||||
@the_call["set-permissions"] = ->set_permissions
|
@the_call["user-registration"] = ->user_registration # Do not require admin priviledges.
|
||||||
@the_call["check-permissions"] = ->check_permissions
|
@the_call["user-delete"] = ->user_deletion # Do not require admin priviledges.
|
||||||
|
|
||||||
|
@the_call["permission-set"] = ->permission_set
|
||||||
|
@the_call["permission-check"] = ->permission_check
|
||||||
|
|
||||||
# User.
|
|
||||||
@the_call["registration"] = ->user_registration
|
|
||||||
@the_call["delete"] = ->user_deletion
|
|
||||||
end
|
end
|
||||||
|
|
||||||
|
#
|
||||||
|
# For all functions: the number of arguments is already tested.
|
||||||
|
#
|
||||||
|
|
||||||
def user_registration
|
def user_registration
|
||||||
# pp! authd.register login, password.not_nil!, email, phone, profile: profile
|
# pp! authd.register login, password.not_nil!, email, phone, profile: profile
|
||||||
rescue e : AuthD::Exception
|
rescue e : AuthD::Exception
|
||||||
|
@ -75,41 +88,43 @@ class Actions
|
||||||
end
|
end
|
||||||
|
|
||||||
def user_add
|
def user_add
|
||||||
args = Context.args
|
args = Context.args.not_nil!
|
||||||
if args.nil? || args.size < 3
|
login, email, phone = args[0..2]
|
||||||
Baguette::Log.warning "subcommand usage: user email phone"
|
|
||||||
Baguette::Log.warning " example: 1002 test@example.com 0690290516"
|
|
||||||
Baguette::Log.warning ""
|
|
||||||
Baguette::Log.warning "User profile opt: -P | --profile"
|
|
||||||
return
|
|
||||||
end
|
|
||||||
|
|
||||||
profile = Context.user_profile
|
profile = Context.user_profile
|
||||||
|
|
||||||
password = Actions.ask_password
|
password = Actions.ask_password
|
||||||
exit 1 unless password
|
exit 1 unless password
|
||||||
|
|
||||||
# pp! authd.add_user login, password.not_nil!, email, phone, profile: profile
|
pp! authd.add_user login, password.not_nil!, email, phone, profile: profile
|
||||||
rescue e : AuthD::Exception
|
rescue e : AuthD::Exception
|
||||||
puts "error: #{e.message}"
|
puts "error: #{e.message}"
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# TODO
|
||||||
def user_mod
|
def user_mod
|
||||||
end
|
args = Context.args.not_nil!
|
||||||
|
userid = args[0]
|
||||||
|
|
||||||
def check_permissions
|
password : String? = nil
|
||||||
args = Context.args
|
|
||||||
if args.nil? || args.size < 3
|
should_ask_password = Actions.ask_something "Should we change the password (Yn) ?" || "n"
|
||||||
Baguette::Log.warning "subcommand usage: user application resource"
|
case should_ask_password
|
||||||
Baguette::Log.warning " example: 1002 my-application chat "
|
when /y/i
|
||||||
Baguette::Log.warning ""
|
Baguette::Log.debug "Ok let's change the password!"
|
||||||
Baguette::Log.warning "permission list: none read edit admin"
|
password = Actions.ask_password
|
||||||
return
|
exit 1 unless password
|
||||||
|
else
|
||||||
|
Baguette::Log.debug "Ok no change in password."
|
||||||
end
|
end
|
||||||
|
|
||||||
user, application, resource = args[0..2]
|
email = Context.email
|
||||||
pp! user, application, resource
|
phone = Context.phone
|
||||||
|
|
||||||
pp! @authd.check_permission user.to_i, application, resource
|
Baguette::Log.error "This function shouldn't be used for now."
|
||||||
|
Baguette::Log.error "It is way too cumbersome."
|
||||||
|
|
||||||
|
# res = authd.add_user login, password, email, phone, profile: profile
|
||||||
|
# puts res
|
||||||
end
|
end
|
||||||
|
|
||||||
# TODO
|
# TODO
|
||||||
|
@ -126,21 +141,23 @@ class Actions
|
||||||
# pp! authd.ask_password_recovery login
|
# pp! authd.ask_password_recovery login
|
||||||
end
|
end
|
||||||
|
|
||||||
def set_permissions
|
def permission_check
|
||||||
args = Context.args
|
args = Context.args.not_nil!
|
||||||
if args.nil? || args.size < 4
|
user, application, resource = args[0..2]
|
||||||
Baguette::Log.warning "subcommand usage: user application resource permission"
|
# pp! user, application, resource
|
||||||
Baguette::Log.warning " example: 1002 my-application chat read"
|
|
||||||
Baguette::Log.warning ""
|
|
||||||
Baguette::Log.warning "permission list: none read edit admin"
|
|
||||||
return
|
|
||||||
end
|
|
||||||
|
|
||||||
|
res = @authd.check_permission user.to_i, application, resource
|
||||||
|
puts res
|
||||||
|
end
|
||||||
|
|
||||||
|
def permission_set
|
||||||
|
args = Context.args.not_nil!
|
||||||
user, application, resource, permission = args[0..3]
|
user, application, resource, permission = args[0..3]
|
||||||
pp! user, application, resource, permission
|
# pp! user, application, resource, permission
|
||||||
|
|
||||||
perm = AuthD::User::PermissionLevel.parse(permission)
|
perm = AuthD::User::PermissionLevel.parse(permission)
|
||||||
pp! @authd.set_permission user.to_i, application, resource, perm
|
res = @authd.set_permission user.to_i, application, resource, perm
|
||||||
|
puts res
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
|
@ -7,6 +7,67 @@ opt_authd_admin = -> (parser : OptionParser) {
|
||||||
end
|
end
|
||||||
}
|
}
|
||||||
|
|
||||||
|
# frequently used functions
|
||||||
|
opt_authd_login = -> (parser : OptionParser) {
|
||||||
|
parser.on "-l LOGIN", "--login LOGIN", "Authd user login." do |login|
|
||||||
|
Context.authd_login = login
|
||||||
|
Baguette::Log.info "User login for authd: #{Context.authd_login}."
|
||||||
|
end
|
||||||
|
parser.on "-p PASSWORD", "--password PASSWORD", "Authd user password." do |password|
|
||||||
|
Context.authd_pass = password
|
||||||
|
Baguette::Log.info "User password for authd: #{Context.authd_pass}."
|
||||||
|
end
|
||||||
|
}
|
||||||
|
|
||||||
|
opt_help = -> (parser : OptionParser) {
|
||||||
|
parser.on "help", "Prints this help message." do
|
||||||
|
puts parser
|
||||||
|
exit 0
|
||||||
|
end
|
||||||
|
}
|
||||||
|
|
||||||
|
opt_profile = -> (parser : OptionParser) {
|
||||||
|
parser.on "-P file", "--profile file", "Read the user profile from a file." do |file|
|
||||||
|
Context.user_profile = JSON.parse(File.read file).as_h
|
||||||
|
Baguette::Log.info "Reading the user profile: #{Context.user_profile}."
|
||||||
|
end
|
||||||
|
}
|
||||||
|
|
||||||
|
opt_phone = -> (parser : OptionParser) {
|
||||||
|
parser.on "-n phone", "--phone-number num", "Phone number." do |phone|
|
||||||
|
Context.phone = phone
|
||||||
|
Baguette::Log.info "Reading the user phone number: #{Context.phone}."
|
||||||
|
end
|
||||||
|
}
|
||||||
|
|
||||||
|
opt_email = -> (parser : OptionParser) {
|
||||||
|
parser.on "-e email", "--email address", "Email address." do |email|
|
||||||
|
Context.email = email
|
||||||
|
Baguette::Log.info "Reading the user email address: #{Context.email}."
|
||||||
|
end
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
# Unrecognized parameters are used to create commands with multiple arguments.
|
||||||
|
# Example: user add _login email phone_
|
||||||
|
# Here, login, email and phone are unrecognized arguments.
|
||||||
|
# Still, the "user add" command expect them.
|
||||||
|
unrecognized_args_to_context_args = -> (parser : OptionParser, n_expected_args : Int32) {
|
||||||
|
# With the right args, these will be interpreted as serialized data.
|
||||||
|
parser.unknown_args do |args|
|
||||||
|
if args.size != n_expected_args
|
||||||
|
Baguette::Log.error "#{parser}"
|
||||||
|
exit 1
|
||||||
|
end
|
||||||
|
args.each do |arg|
|
||||||
|
Baguette::Log.debug "Unrecognized argument: #{arg} (adding to Context.args)"
|
||||||
|
if Context.args.nil?
|
||||||
|
Context.args = Array(String).new
|
||||||
|
end
|
||||||
|
Context.args.not_nil! << arg
|
||||||
|
end
|
||||||
|
end
|
||||||
|
}
|
||||||
|
|
||||||
parser = OptionParser.new do |parser|
|
parser = OptionParser.new do |parser|
|
||||||
parser.banner = "usage: #{PROGRAM_NAME} command help"
|
parser.banner = "usage: #{PROGRAM_NAME} command help"
|
||||||
|
@ -20,80 +81,104 @@ parser = OptionParser.new do |parser|
|
||||||
exit 0
|
exit 0
|
||||||
end
|
end
|
||||||
|
|
||||||
parser.on "user", "user" do
|
parser.on "user", "Operations on users." do
|
||||||
parser.banner = "Usage: user [add | mod | delete]"
|
parser.banner = "Usage: user [add | mod | delete]"
|
||||||
parser.on "add", "add" do
|
|
||||||
Baguette::Log.info "user-add"
|
|
||||||
Context.command = "user-add"
|
|
||||||
# parser_user_add.call parser
|
|
||||||
# opt_profile.call parser
|
|
||||||
opt_authd_admin.call parser
|
|
||||||
parser.banner = "Usage: user-add user-id -e email -p phone [opt]"
|
|
||||||
|
|
||||||
parser.on "help", "Prints this help message." do
|
parser.on "add", "Adding a user to the DB." do
|
||||||
puts "usage: #{PROGRAM_NAME} user-add THINGS [options]"
|
parser.banner = "usage: user add login email phone [-P profile] [opt]"
|
||||||
puts parser
|
Baguette::Log.info "Adding a user to the DB."
|
||||||
exit 0
|
Context.command = "user-add"
|
||||||
end
|
opt_authd_admin.call parser
|
||||||
|
opt_profile.call parser
|
||||||
|
opt_email.call parser
|
||||||
|
opt_phone.call parser
|
||||||
|
opt_help.call parser
|
||||||
|
# login email phone
|
||||||
|
unrecognized_args_to_context_args.call parser, 3
|
||||||
end
|
end
|
||||||
|
|
||||||
parser.on "mod", "mod" do
|
parser.on "mod", "Modify a user account." do
|
||||||
Baguette::Log.info "user-mod"
|
parser.banner = "Usage: user mod userid [-e email|-n phone|-P profile] [opt]"
|
||||||
|
Baguette::Log.info "Modify a user account."
|
||||||
Context.command = "user-mod"
|
Context.command = "user-mod"
|
||||||
# opt_profile.call parser
|
|
||||||
opt_authd_admin.call parser
|
opt_authd_admin.call parser
|
||||||
|
opt_email.call parser
|
||||||
|
opt_phone.call parser
|
||||||
|
opt_profile.call parser
|
||||||
|
opt_help.call parser
|
||||||
|
# userid
|
||||||
|
unrecognized_args_to_context_args.call parser, 1
|
||||||
end
|
end
|
||||||
|
|
||||||
parser.on "delete", "Remove user." do
|
parser.on "delete", "Remove user." do
|
||||||
|
parser.banner = "Usage: user delete -u userid [opt]"
|
||||||
Baguette::Log.info "Remove user."
|
Baguette::Log.info "Remove user."
|
||||||
Context.command = "delete"
|
Context.command = "delete"
|
||||||
|
# You can either be the owner of the account, or an admin.
|
||||||
|
opt_authd_login.call parser
|
||||||
opt_authd_admin.call parser
|
opt_authd_admin.call parser
|
||||||
|
opt_help.call parser
|
||||||
|
end
|
||||||
|
|
||||||
|
# Do not require to be admin.
|
||||||
|
parser.on "register", "Register a user (requires activation)." do
|
||||||
|
parser.banner = "Usage: user register login email phone [-P profile] [opt]"
|
||||||
|
Baguette::Log.info "Register a user (requires activation)."
|
||||||
|
Context.command = "user-registration"
|
||||||
|
# These options shouldn't be used here,
|
||||||
|
# email and phone parameters are mandatory.
|
||||||
|
# opt_email.call parser
|
||||||
|
# opt_phone.call parser
|
||||||
|
opt_profile.call parser
|
||||||
|
opt_help.call parser
|
||||||
|
# login email phone
|
||||||
|
unrecognized_args_to_context_args.call parser, 3
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
parser.on "permissions", "Permissions." do
|
parser.on "permission", "Permissions management." do
|
||||||
parser.banner = "Usage: permissions [check | set]"
|
parser.banner = "Usage: permissions [check | set]"
|
||||||
parser.on "set", "Set permissions." do
|
parser.on "set", "Set permissions." do
|
||||||
|
parser.banner = <<-END
|
||||||
|
usage: permission set user application resource permission
|
||||||
|
example: permission set 1002 my-application chat read
|
||||||
|
|
||||||
|
permission list: none read edit admin
|
||||||
|
END
|
||||||
Baguette::Log.info "Set permissions."
|
Baguette::Log.info "Set permissions."
|
||||||
Context.command = "set-permissions"
|
Context.command = "permission-set"
|
||||||
opt_authd_admin.call parser
|
opt_authd_admin.call parser
|
||||||
|
opt_help.call parser
|
||||||
|
# userid application resource permission
|
||||||
|
unrecognized_args_to_context_args.call parser, 4
|
||||||
end
|
end
|
||||||
|
|
||||||
parser.on "check", "Check permissions." do
|
parser.on "check", "Check permissions." do
|
||||||
|
parser.banner = <<-END
|
||||||
|
usage: permission check user application resource
|
||||||
|
example: permission check 1002 my-application chat
|
||||||
|
|
||||||
|
permission list: none read edit admin
|
||||||
|
END
|
||||||
Baguette::Log.info "Check permissions."
|
Baguette::Log.info "Check permissions."
|
||||||
Context.command = "check-permissions"
|
Context.command = "permission-check"
|
||||||
opt_authd_admin.call parser
|
opt_authd_admin.call parser
|
||||||
|
opt_help.call parser
|
||||||
|
# userid application resource
|
||||||
|
unrecognized_args_to_context_args.call parser, 3
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Do not require to be admin.
|
|
||||||
parser.on "registration", "Register a user." do
|
|
||||||
Baguette::Log.info "Register a user."
|
|
||||||
Context.command = "registration"
|
|
||||||
# opt_profile.call parser
|
|
||||||
# opt_authd_login.call parser
|
|
||||||
end
|
|
||||||
parser.unknown_args do |args|
|
parser.unknown_args do |args|
|
||||||
if args.size > 0
|
if args.size > 0
|
||||||
Baguette::Log.warning "Unknown args: #{args}"
|
Baguette::Log.warning "Unknown args: #{args}"
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# parser.on "-p file", "--profile file", "Read the user profile from a file." do |file|
|
|
||||||
# profile_file = file
|
|
||||||
# end
|
|
||||||
#
|
|
||||||
# parser.on "-X user-password", "--user-password pass", "Read the new user password." do |pass|
|
# parser.on "-X user-password", "--user-password pass", "Read the new user password." do |pass|
|
||||||
# password = pass
|
# password = pass
|
||||||
# end
|
# end
|
||||||
#
|
|
||||||
# parser.on "-K file", "--key-file file", "Read the authd shared key from a file." do |file|
|
|
||||||
# key_file = file
|
|
||||||
# end
|
|
||||||
#
|
|
||||||
# parser.on "-R", "--register", "Use a registration request instead of a add-user one." do
|
|
||||||
# register = true
|
|
||||||
# end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -57,18 +57,6 @@ opt_authd_admin = -> (root : Phreak::Subparser) {
|
||||||
end
|
end
|
||||||
}
|
}
|
||||||
|
|
||||||
# frequently used functions
|
|
||||||
opt_profile = -> (root : Phreak::Subparser) {
|
|
||||||
root.bind(short_flag: 'P', long_flag: "profile", description: "Read the user profile from a file.") do |sub|
|
|
||||||
sub.grab do |sub, name|
|
|
||||||
Blah.next_token = name
|
|
||||||
end
|
|
||||||
file = Blah.next_token
|
|
||||||
Context.user_profile = JSON.parse(File.read file).as_h
|
|
||||||
Baguette::Log.info "Reading the user profile: #{Context.user_profile}."
|
|
||||||
end
|
|
||||||
}
|
|
||||||
|
|
||||||
opt_simulation = -> (root : Phreak::RootParser) {
|
opt_simulation = -> (root : Phreak::RootParser) {
|
||||||
root.bind(short_flag: 's', long_flag: "simulation", description: "Don't do anything.") do |sub|
|
root.bind(short_flag: 's', long_flag: "simulation", description: "Don't do anything.") do |sub|
|
||||||
Baguette::Log.info "This is a simulation."
|
Baguette::Log.info "This is a simulation."
|
||||||
|
|
Loading…
Reference in New Issue