Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[basicui] Use sitemap input hint #1787

Closed
wants to merge 23 commits into from
Closed

[basicui] Use sitemap input hint #1787

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
6cfd458
number, date and time input using hints
mherwege Feb 23, 2023
990fae1
fix rebase issue
mherwege Apr 10, 2023
4aa4ad1
Rebase mistake fixes
mherwege Apr 10, 2023
7fdbe65
review adjustments, force datetime inputHint for dateTime type
mherwege May 7, 2023
0117ba3
cut seconds
mherwege May 8, 2023
97dd0da
fix datetime from UNDEF handling
mherwege May 8, 2023
d0452a4
fix js error setting date to UNDEF
mherwege May 8, 2023
45b270b
fix undefValue when no state description
mherwege May 8, 2023
5b5a574
fix undef colors
mherwege May 8, 2023
0fc13e1
correct undef color at start
mherwege May 8, 2023
e594619
fix build
mherwege May 8, 2023
b83bca4
warnings and unit fix
mherwege May 9, 2023
a91f610
fix build error
mherwege May 9, 2023
ba1645d
default interpret single comma in number string as decimal separator
mherwege May 9, 2023
02f392e
improvements
mherwege May 22, 2023
7987531
fix build error
mherwege May 22, 2023
9f06e3a
support extended state descriptions
mherwege May 23, 2023
b2d1212
postfix identification improvement
mherwege May 23, 2023
460c61a
enter data in field active color
mherwege May 24, 2023
bd9afef
support scientific notation for numbers
mherwege May 25, 2023
4484a91
fix single character units
mherwege May 25, 2023
fa91c51
item unit from state description
mherwege Jul 1, 2023
cb248d8
review feedback
mherwege Jul 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
289 changes: 275 additions & 14 deletions ...rg.openhab.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/InputRenderer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,29 @@
*/
package org.openhab.ui.basic.internal.render;

import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import org.eclipse.emf.common.util.ECollections;
import org.eclipse.emf.common.util.EList;
import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
import org.openhab.core.i18n.LocaleProvider;
import org.openhab.core.i18n.TranslationProvider;
import org.openhab.core.items.Item;
import org.openhab.core.items.ItemNotFoundException;
import org.openhab.core.library.items.NumberItem;
import org.openhab.core.library.types.DateTimeType;
import org.openhab.core.library.types.DecimalType;
import org.openhab.core.library.types.PercentType;
import org.openhab.core.library.types.StringType;
import org.openhab.core.model.sitemap.sitemap.Input;
import org.openhab.core.model.sitemap.sitemap.Widget;
import org.openhab.core.types.State;
import org.openhab.core.types.StateDescription;
import org.openhab.core.types.UnDefType;
import org.openhab.core.types.util.UnitUtils;
import org.openhab.core.ui.items.ItemUIRegistry;
import org.openhab.ui.basic.render.RenderException;
import org.openhab.ui.basic.render.WidgetRenderer;
Expand All @@ -43,6 +55,11 @@
@NonNullByDefault
public class InputRenderer extends AbstractWidgetRenderer {

private static final Pattern NUMBER_PATTERN = Pattern.compile("^(\\+|-)?[0-9\\.,]+((e|E)(\\+|-)?[0-9]+)?");
private static final Pattern COMMA_SEPARATOR_PATTERN = Pattern
.compile("^(\\+|-)?(([1-9][0-9]{0,2}(\\.[0-9]{3})*)|([0-9]*))?(,[0-9]+)?((e|E)(\\+|-)?[0-9]+)?$");
private static final Pattern LABEL_PATTERN = Pattern.compile("[^\\[]*?\\[([^%]*)(%\\S+)? ?(\\S+)?(.*)\\]");

private final Logger logger = LoggerFactory.getLogger(InputRenderer.class);

@Activate
Expand All @@ -58,38 +75,282 @@ public boolean canRender(Widget w) {

@Override
public EList<Widget> renderWidget(Widget w, StringBuilder sb, String sitemap) throws RenderException {
String snippet = getSnippet("input");
Input input = (Input) w;

String snippet = getSnippet("input");
snippet = preprocessSnippet(snippet, w);

String dataState = getValue(w);
State state = itemUIRegistry.getState(w);
if (state == null || state instanceof UnDefType) {
snippet = snippet.replace("%undef_state%", dataState);
snippet = snippet.replace("%data_state%", "");
} else {
snippet = snippet.replace("%undef_state%", "");
snippet = snippet.replace("%data_state%", dataState);
}

Item item = null;
try {
item = itemUIRegistry.getItem(w.getItem());
} catch (ItemNotFoundException e) {
logger.debug("Failed to retrieve item during widget rendering: {}", e.getMessage());
return ECollections.emptyEList();
}

String dataType;
if (item != null && item.getAcceptedDataTypes().stream().anyMatch(o -> Number.class.isAssignableFrom(o))) {
dataType = "Number";
if (item.getAcceptedCommandTypes().stream()
.anyMatch(o -> (!StringType.class.isAssignableFrom(o) && Number.class.isAssignableFrom(o)))) {
dataType = "number";
} else if (item.getAcceptedCommandTypes().stream()
.anyMatch(o -> (!StringType.class.isAssignableFrom(o) && DateTimeType.class.isAssignableFrom(o)))) {
dataType = "datetime";
} else {
dataType = "Text";
dataType = "text";
}
snippet = snippet.replace("%data_type%", dataType);

String inputHint = input.getInputHint();
List<Class<? extends State>> dataTypes = item.getAcceptedDataTypes();
if (("number".equals(inputHint)
&& !(dataTypes.contains(DecimalType.class) || dataTypes.contains(PercentType.class)))
|| (("date".equals(inputHint) || "time".equals(inputHint) || "datetime".equals(inputHint))
&& !dataTypes.contains(DateTimeType.class))) {
logger.warn("Invalid inputHint {} for item {} of type {}, set to default", inputHint, item.getName(),
item.getType());
inputHint = null;
}
if ("datetime".equals(dataType) && ((inputHint == null) || inputHint.isEmpty() || "text".equals(inputHint))) {
inputHint = "datetime";
}
snippet = snippet.replace("%input_hint%", inputHint == null ? "" : inputHint);

String inputType = "text";
String inputPattern = "";
if ("number".equals(inputHint)) {
inputType = "number";
inputPattern = "pattern=\"[0-9]*([\\.|,][0-9]*)?\"";
} else if ("date".equals(inputHint)) {
inputType = "date";
inputPattern = "pattern=\"[0-9]{4}-[0-9]d{2}-[0-9]d{2}\"";
} else if ("time".equals(inputHint)) {
inputType = "time";
inputPattern = "pattern=\"[0-9]{2}:[0-9]{2}?\"";
} else if ("datetime".equals(inputHint)) {
inputType = "datetime-local";
inputPattern = "pattern=\"[0-9]{4}-[0-9]d{2}-[0-9]d{2} [0-9]{2}:[0-9]{2}\"";
}
snippet = snippet.replace("%input_type%", inputType);
snippet = snippet.replace("%input_pattern%", inputPattern);

String displayState = getValue(w, item);
State state = itemUIRegistry.getState(w);

String prefix = getPrefix(w, item);
String postfix = getPostfix(w, item);
String prefixSnippet = !prefix.isBlank()
? "<span %valuestyle% class=\"mdl-form__input-prefix\">" + prefix + "</span>"
: "";
String postfixSnippet = !postfix.isBlank()
? "<span %valuestyle% class=\"mdl-form__input-postfix\">" + postfix + "</span>"
: "";
snippet = snippet.replace("%prefix_snippet%", prefixSnippet);
snippet = snippet.replace("%postfix_snippet%", postfixSnippet);

String undefState = "";
if (state == null || state instanceof UnDefType) {
if ("number".equals(inputHint)) {
String[] stateArray = displayState.split(" ");
undefState = stateArray.length > 0 ? stateArray[0] : undefState;
} else if (!("date".equals(inputHint) || "time".equals(inputHint) || "datetime".equals(inputHint))) {
undefState = displayState;
}
}
snippet = snippet.replace("%undef_state%", undefState);

String dataState = "";
String itemState = "";
if ((state == null) || (state instanceof UnDefType)) {
itemState = "";
} else {
itemState = state.toString();
dataState = displayState;
if ("number".equals(inputHint)) {
String[] stateArray = dataState.trim().split(" ");
dataState = parseNumber(stateArray[0]);
} else if (state instanceof DateTimeType) {
if ("date".equals(inputHint)) {
dataState = ((DateTimeType) state).format("%1$tY-%1$tm-%1$td");
} else if ("time".equals(inputHint)) {
dataState = ((DateTimeType) state).format("%1$tR");
} else if ("datetime".equals(inputHint)) {
dataState = ((DateTimeType) state).format("%1$tY-%1$tm-%1$tdT%1$tR");
}
}
}
snippet = snippet.replace("%data_state%", dataState);
snippet = snippet.replace("%item_state%", itemState);

String unitSnippet = "";
String unit = "";
if (item instanceof NumberItem) {
NumberItem numberItem = (NumberItem) item;
if (numberItem.getDimension() != null) {
unit = getUnit(w, numberItem);
if ("number".equals(inputHint)) {
unitSnippet = "<span %valuestyle% class=\"mdl-form__input-unit\">" + unit + "</span>";
}
}
}
snippet = snippet.replace("%item_unit%", unit);
snippet = snippet.replace("%unit_snippet%", unitSnippet);

// Process the color tags
snippet = processColor(w, snippet);

sb.append(snippet);

return ECollections.emptyEList();
}

private String parseNumber(String value) {
String newValue = value.trim();
Matcher numberMatcher = NUMBER_PATTERN.matcher(newValue);
if (numberMatcher.find()) {
String numberValue = numberMatcher.group(0);
String unitValue = newValue.substring(numberValue.length()).trim();
newValue = numberValue.replace("/^\\+/", "");
if (COMMA_SEPARATOR_PATTERN.matcher(newValue).find()) {
newValue = newValue.replace("/\\./g", "").replace(",", ".");
}
if (unitValue.length() > 0) {
newValue = newValue + " " + unitValue;
}
return newValue;
} else {
return value;
}
}

private String getValue(Widget w, Item item) {
String value = cleanValue(getValue(w), w, item);
if (value.isBlank()) {
State state = itemUIRegistry.getState(w);
if (state != null && !(state instanceof UnDefType)) {
value = state.toString();
} else {
value = "-";
}
}
if (item instanceof NumberItem) {
NumberItem numberItem = (NumberItem) item;
if (numberItem.getDimension() != null) {
String[] stateArray = value.split(" ");
if (stateArray.length <= 1) {
value = (stateArray.length > 0 ? stateArray[0] : value) + " " + getUnit(w, numberItem);
}
}
}
return value;
}

private String cleanValue(String value, Widget w, Item item) {
String prefix = getPrefix(w, item);
String postfix = getPostfix(w, item);
String newValue = value.startsWith(prefix) ? value.substring(prefix.length()) : value;
newValue = value.endsWith(postfix) ? newValue.substring(0, newValue.lastIndexOf(postfix)) : newValue;
return newValue.trim();
}

private String getUnit(Widget w, NumberItem item) {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the new method that is key to making it work, and was not there before May 22nd.

String unit = "";
if (w.getLabel() != null) {
unit = getUnitFromLabel(item, w.getLabel());
}
// required when item is defined through UI and the label contains the value format pattern
if ((unit != null) && unit.isBlank() && (item.getLabel() != null)) {
unit = getUnitFromLabel(item, item.getLabel());
}
// required when the value pattern is in the state description (text definition or meta data)
if ((unit != null) && unit.isBlank()) {
StateDescription stateDescription = item.getStateDescription();
if (stateDescription != null) {
String pattern = stateDescription.getPattern();
if (pattern != null) {
unit = getUnitFromLabel(item, "[" + pattern + "]");
}
}
}
if (unit == null || unit.isBlank()) {
unit = item.getUnitSymbol();
}
unit = (unit == null) ? "" : unit;
return unit;
}

private @Nullable String getUnitFromLabel(NumberItem item, @Nullable String label) {
String unit = null;
if (label != null && !label.isBlank()) {
Matcher m = LABEL_PATTERN.matcher(label);
if (m.matches()) {
unit = m.group(3);
if (unit != null) {
unit = unit.trim();
}
} else {
unit = "";
}
if (UnitUtils.UNIT_PLACEHOLDER.equals(unit)) {
unit = item.getUnitSymbol();
}
unit = "%%".equals(unit) ? "%" : unit;
}
return unit;
}

private String getPrefix(Widget w, Item item) {
if (w.getLabel() != null) {
return getPrefixFromLabel(w.getLabel());
} else if (item.getLabel() != null) {
return getPrefixFromLabel(item.getLabel());
} else {
return "";
}
}

private String getPrefixFromLabel(@Nullable String label) {
if (label != null && !label.isBlank()) {
Matcher m = LABEL_PATTERN.matcher(label);
if (m.matches()) {
String prefix = m.group(1);
if (prefix != null && !prefix.isBlank()) {
return prefix;
}
}
}
return "";
}

private String getPostfix(Widget w, Item item) {
boolean hasUnit = false;
if (item instanceof NumberItem) {
NumberItem numberItem = (NumberItem) item;
if (numberItem.getDimension() != null) {
hasUnit = true;
}
}
if (w.getLabel() != null) {
return getPostfixFromLabel(w.getLabel(), hasUnit);
} else if (item.getLabel() != null) {
return getPostfixFromLabel(item.getLabel(), hasUnit);
} else {
return "";
}
}

private String getPostfixFromLabel(@Nullable String label, boolean hasUnit) {
String postfix = "";
if (label != null && !label.isBlank()) {
Matcher m = LABEL_PATTERN.matcher(label);
if (m.matches()) {
if (!hasUnit && m.group(3) != null) {
postfix = m.group(3);
}
if (m.group(4) != null) {
postfix = postfix + m.group(4);
}
}
}
return postfix;
}
}
42 changes: 27 additions & 15 deletions bundles/org.openhab.ui.basic/src/main/resources/snippets/input.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,33 @@
%label%
</span>
<div
class="mdl-form__control mdl-form__input mdl-textfield mdl-js-textfield"
data-control-type="input"
data-item="%item%"
data-widget-id="%widget_id%"
data-item-type=%data_type%
for="oh-input-%item%"
class="mdl-form__input"
>
<input
%valuestyle% type="text"
id="oh-input-%item%"
class="mdl-textfield__input"
value="%data_state%"
/>
<label for="oh-input-%item%" class="mdl-textfield__label">
%undef_state%
</label>
%prefix_snippet%
<div
class="mdl-form__control mdl-form__input-container mdl-textfield mdl-js-textfield"
data-control-type="input"
data-item="%item%"
data-widget-id="%widget_id%"
data-item-type="%data_type%"
data-input-hint="%input_hint%"
data-item-state="%item_state%"
data-item-unit="%item_unit%"
for="oh-input-%item%"
>
<input
%valuestyle% type="%input_type%" %input_pattern%
autocomplete="off"
step="any"
id="oh-input-%item%"
class="mdl-textfield__input"
value="%data_state%"
/>
<label for="oh-input-%item%" class="mdl-textfield__label">
%undef_state%
</label>
</div>
%unit_snippet%
%postfix_snippet%
</div>
</div>
Loading