All Downloads are FREE. Search and download functionalities are using the official Maven repository.
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.aspectran.shell.command.ShellTransletProcedure Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2023 The Aspectran Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.aspectran.shell.command;
import com.aspectran.core.activity.Translet;
import com.aspectran.core.activity.request.MissingMandatoryParametersException;
import com.aspectran.core.activity.request.ParameterMap;
import com.aspectran.core.context.expr.token.Token;
import com.aspectran.core.context.rule.DescriptionRule;
import com.aspectran.core.context.rule.ItemRule;
import com.aspectran.core.context.rule.ItemRuleMap;
import com.aspectran.core.context.rule.TransletRule;
import com.aspectran.core.context.rule.type.ItemType;
import com.aspectran.core.context.rule.type.TokenType;
import com.aspectran.core.lang.NonNull;
import com.aspectran.core.lang.Nullable;
import com.aspectran.core.util.StringUtils;
import com.aspectran.shell.console.ShellConsole;
import com.aspectran.shell.service.ShellService;
import java.util.Collection;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.Map;
import java.util.Set;
public class ShellTransletProcedure {
private final ShellService shellService;
private final ShellConsole console;
private final TransletRule transletRule;
private final ParameterMap parameterMap;
private final boolean procedural;
private final boolean verbose;
private boolean readSimply;
public ShellTransletProcedure(@NonNull ShellService shellService, @NonNull TransletRule transletRule,
@NonNull ParameterMap parameterMap, boolean procedural, boolean verbose) {
this.shellService = shellService;
this.console = shellService.getConsole();
this.transletRule = transletRule;
this.parameterMap = parameterMap;
this.procedural = procedural;
this.verbose = verbose;
}
public void proceed() throws MissingMandatoryParametersException {
determineSimpleReading();
if (procedural) {
printRequiredParameters();
printRequiredAttributes();
}
readRequiredParameters();
}
private void determineSimpleReading() {
ItemRuleMap attributeItemRuleMap = transletRule.getRequestRule().getAttributeItemRuleMap();
if (attributeItemRuleMap != null && !attributeItemRuleMap.isEmpty()) {
readSimply = false;
} else {
ItemRuleMap parameterItemRuleMap = transletRule.getRequestRule().getParameterItemRuleMap();
if (parameterItemRuleMap != null && !parameterItemRuleMap.isEmpty()) {
readSimply = isSimpleItemRules(parameterItemRuleMap.values());
} else {
readSimply = true;
}
}
}
private boolean isSimpleItemRules(Collection itemRules) {
for (ItemRule itemRule : itemRules) {
if (itemRule.getType() != ItemType.SINGLE) {
return false;
}
Token[] tokens = itemRule.getAllTokens();
if (tokens != null && tokens.length > 0) {
if (tokens.length == 1) {
Token token = tokens[0];
if (token.getType() != TokenType.TEXT) {
if (token.getType() != TokenType.PARAMETER ||
!token.getName().equals(itemRule.getName())) {
return false;
}
}
} else {
return false;
}
}
}
return true;
}
public void printDescription(String description) {
if (description != null) {
console.setStyle(console.getInfoStyle());
console.writeLine(description);
console.resetStyle();
}
}
public void printDescription(Translet translet) {
if (verbose) {
printDescription(translet.getDescription());
}
}
public void printDescription(TransletRule transletRule) {
if (verbose) {
printDescription(getDescription(transletRule));
}
}
@Nullable
private String getDescription(@NonNull TransletRule transletRule) {
DescriptionRule descriptionRule = transletRule.getDescriptionRule();
if (descriptionRule != null) {
return DescriptionRule.render(descriptionRule, shellService.getDefaultActivity());
} else {
return null;
}
}
private void printRequiredParameters() {
ItemRuleMap parameterItemRuleMap = transletRule.getRequestRule().getParameterItemRuleMap();
if (parameterItemRuleMap != null && !parameterItemRuleMap.isEmpty()) {
console.setStyle(console.getSecondaryStyle());
console.writeLine("Required parameters:");
console.resetStyle();
if (!readSimply) {
writeItems(parameterItemRuleMap.values(), TokenType.PARAMETER);
}
}
}
private void printRequiredAttributes() {
if (!readSimply) {
ItemRuleMap attributeItemRuleMap = transletRule.getRequestRule().getAttributeItemRuleMap();
if (attributeItemRuleMap != null && !attributeItemRuleMap.isEmpty()) {
console.setStyle(console.getSecondaryStyle());
console.writeLine("Required attributes:");
console.resetStyle();
writeItems(attributeItemRuleMap.values(), TokenType.ATTRIBUTE);
}
}
}
public void printSomeMandatoryParametersMissing(Collection itemRules) {
if (itemRules != null && !itemRules.isEmpty()) {
console.setStyle(console.getDangerStyle());
console.writeLine("Some mandatory parameters are missing:");
console.resetStyle();
for (ItemRule ir : itemRules) {
console.setStyle(console.getWarningStyle());
console.write(" * ");
console.resetStyle("bold");
console.writeLine(ir.getName());
console.resetStyle();
}
}
}
public void printSomeMandatoryAttributesMissing(Collection itemRules) {
if (itemRules != null && !itemRules.isEmpty()) {
console.setStyle(console.getDangerStyle());
console.writeLine("Some mandatory attributes are missing:");
console.resetStyle();
for (ItemRule ir : itemRules) {
console.setStyle(console.getWarningStyle());
console.write(" * ");
console.resetStyle("bold");
console.writeLine(ir.getName());
console.resetStyle();
}
}
}
private void readRequiredParameters() throws MissingMandatoryParametersException {
Collection itemRules;
ItemRuleMap parameterItemRuleMap = transletRule.getRequestRule().getParameterItemRuleMap();
if (parameterItemRuleMap != null && !parameterItemRuleMap.isEmpty()) {
itemRules = parameterItemRuleMap.values();
} else {
return;
}
Collection missingItemRules;
if (procedural) {
if (readSimply) {
missingItemRules = readEachParameter(itemRules);
} else {
missingItemRules = readEachToken(itemRules);
}
} else {
missingItemRules = checkRequiredParameters(itemRules);
}
if (missingItemRules != null) {
console.setStyle(console.getWarningStyle());
console.writeLine("Missing mandatory parameters:");
console.resetStyle();
if (!readSimply) {
writeItems(missingItemRules, TokenType.PARAMETER);
}
Collection missingItemRules2;
if (readSimply) {
missingItemRules2 = readEachParameter(missingItemRules);
} else {
missingItemRules2 = readEachToken(missingItemRules);
}
if (missingItemRules2 != null) {
throw new MissingMandatoryParametersException(missingItemRules2);
}
}
}
private Collection readEachParameter(Collection itemRules) {
Set missingItemRules = new LinkedHashSet<>();
for (ItemRule ir : itemRules) {
String value = readParameter(ir);
if (StringUtils.hasLength(value)) {
parameterMap.setParameter(ir.getName(), value);
} else if (ir.isMandatory()) {
missingItemRules.add(ir);
}
}
return (missingItemRules.isEmpty() ? null : missingItemRules);
}
private String readParameter(ItemRule itemRule) {
console.clearPrompt();
console.setStyle(console.getWarningStyle());
console.appendPrompt(getMandatoryMarker(itemRule.isMandatory()));
console.resetStyle("bold");
console.appendPrompt(itemRule.getName());
console.resetStyle();
console.appendPrompt(": ");
String defaultValue = null;
Token[] tokens = itemRule.getAllTokens();
if (tokens != null && tokens.length == 1) {
Token token = tokens[0];
if (token.getType() == TokenType.TEXT) {
defaultValue = token.getDefaultValue();
} else if (token.getType() == TokenType.PARAMETER &&
token.getName().equals(itemRule.getName())) {
defaultValue = token.getDefaultValue();
}
}
if (itemRule.isSecret()) {
return console.readPassword(null, defaultValue);
} else {
return console.readLine(null, defaultValue);
}
}
private Collection readEachToken(Collection itemRules) {
console.setStyle(console.getSecondaryStyle());
console.writeLine("Enter a value for each token:");
console.resetStyle();
Set missingItemRules = new LinkedHashSet<>();
Map> valueTokens = new LinkedHashMap<>();
for (ItemRule itemRule : itemRules) {
Token[] tokens = itemRule.getAllTokens();
if (tokens == null || tokens.length == 0) {
Token t = new Token(TokenType.PARAMETER, itemRule.getName());
tokens = new Token[] { t };
} else if (tokens.length == 1 && tokens[0].getType() == TokenType.TEXT) {
Token t = new Token(TokenType.PARAMETER, itemRule.getName());
t.setDefaultValue(tokens[0].getDefaultValue());
tokens = new Token[] { t };
}
for (Token t1 : tokens) {
if (t1.getType() == TokenType.PARAMETER) {
boolean exists = false;
for (Token t2 : valueTokens.keySet()) {
if (t2.equals(t1)) {
exists = true;
break;
}
}
if (exists) {
Set rules = valueTokens.get(t1);
rules.add(itemRule);
} else {
Set rules = new LinkedHashSet<>();
rules.add(itemRule);
valueTokens.put(t1, rules);
}
}
}
}
for (Map.Entry> entry : valueTokens.entrySet()) {
Token token = entry.getKey();
Set itemRuleSet = entry.getValue();
boolean secret = hasSecretItem(itemRuleSet);
console.clearPrompt();
console.appendPrompt(" ");
console.setStyle(console.getInfoStyle());
console.appendPrompt(String.valueOf(Token.PARAMETER_SYMBOL));
console.appendPrompt(String.valueOf(Token.BRACKET_OPEN));
console.resetStyle("bold");
console.appendPrompt(token.getName());
console.resetStyle(console.getInfoStyle());
console.appendPrompt(String.valueOf(Token.BRACKET_CLOSE));
console.resetStyle();
console.appendPrompt(": ");
String line;
if (secret) {
line = console.readPassword(null, token.getDefaultValue());
} else {
line = console.readLine(null, token.getDefaultValue());
}
if (StringUtils.hasLength(line)) {
parameterMap.setParameter(token.getName(), line);
} else {
for (ItemRule ir : itemRuleSet) {
if (ir.isMandatory()) {
missingItemRules.add(ir);
}
}
}
}
return (missingItemRules.isEmpty() ? null : missingItemRules);
}
private boolean hasSecretItem(Collection itemRules) {
boolean secret = false;
for (ItemRule ir : itemRules) {
if (ir.isSecret()) {
secret = true;
break;
}
}
return secret;
}
private String getMandatoryMarker(boolean mandatory) {
return (mandatory ? " * " : " ");
}
private void writeItems(Collection itemRules, TokenType tokenType) {
for (ItemRule itemRule : itemRules) {
if (readSimply) {
writeItem(itemRule, null);
} else {
Token[] tokens = itemRule.getAllTokens();
if (tokens == null) {
Token t = new Token(tokenType, itemRule.getName());
tokens = new Token[] { t };
}
writeItem(itemRule, tokens);
}
}
}
private void writeItem(ItemRule itemRule, Token[] tokens) {
console.setStyle(console.getWarningStyle());
console.write(getMandatoryMarker(itemRule.isMandatory()));
console.resetStyle("bold");
console.write(itemRule.getName());
console.resetStyle();
if (tokens != null && tokens.length > 0) {
console.write(": ");
for (Token token : tokens) {
writeToken(token);
}
}
console.writeLine();
}
private void writeToken(Token token) {
if (token.getType() == TokenType.TEXT) {
console.write(token.stringify());
} else {
String str = token.stringify();
console.setStyle(console.getInfoStyle());
console.write(str.substring(0, 2));
console.resetStyle("bold");
console.write(str.substring(2, str.length() - 1));
console.resetStyle(console.getInfoStyle());
console.write(str.substring(str.length() - 1));
console.resetStyle();
}
}
private Collection checkRequiredParameters(Collection itemRules) {
Set missingItemRules = new LinkedHashSet<>();
for (ItemRule itemRule : itemRules) {
String[] values = parameterMap.getParameterValues(itemRule.getName());
if (values == null || values.length == 0) {
missingItemRules.add(itemRule);
}
}
return (missingItemRules.isEmpty() ? null : missingItemRules);
}
}
