Uhm 8157

api/src/main/java/org/openmrs/module/pihcore/htmlformentry/analysis/DataSet.java

@@ -0,0 +1,72 @@
+package org.openmrs.module.pihcore.htmlformentry.analysis;
+
+import com.opencsv.CSVWriter;
+import lombok.Data;
+import org.apache.commons.lang.StringUtils;
+
+import java.io.File;
+import java.io.FileWriter;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+
+@Data
+public class DataSet {
+
+    private String name;
+    private List<String> columns = new ArrayList<>();
+    private List<Map<String, String>> rows = new ArrayList<>();
+
+    public DataSet() {}
+
+    @Override
+    public String toString() {
+        return name + " (" + columns.size() + " x " + rows.size() + ")";
+    }
+
+    public void setHeaderRow(String... values) {
+        columns = Arrays.asList(values);
+    }
+
+    public void addDataRow(String... values) {
+        if (values == null || columns == null || values.length != columns.size()) {
+            throw new IllegalArgumentException("Values and columns must have same length");
+        }
+        Map<String, String> row = new LinkedHashMap<>();
+        for (int i=0; i<columns.size(); i++) {
+            row.put(columns.get(i), values[i]);
+        }
+        rows.add(row);
+    }
+
+    public void toCsv(File outputFile, char separator) throws Exception {
+        try (FileWriter fileWriter = new FileWriter(outputFile)) {
+            try (CSVWriter writer = new CSVWriter(fileWriter, separator)) {
+                writer.writeNext(columns.toArray(new String[0]));
+                for (Map<String, String> row : rows) {
+                    String[] r = new String[columns.size()];
+                    for (int i = 0; i < columns.size(); i++) {
+                        r[i] = row.get(columns.get(i));
+                    }
+                    writer.writeNext(r);
+                }
+            }
+        }
+    }
+
+    public void print(String separator) {
+        if (StringUtils.isNotBlank(name)) {
+            System.out.println(name);
+        }
+        System.out.println(String.join(separator, columns));
+        for (Map<String, String> row : rows) {
+            List<String> values = new ArrayList<>();
+            for (String c : columns) {
+                values.add(row.get(c));
+            }
+            System.out.println(String.join(separator, values));
+        }
+    }
+}

api/src/main/java/org/openmrs/module/pihcore/htmlformentry/analysis/HtmlFormAnalyzer.java

@@ -0,0 +1,163 @@
+package org.openmrs.module.pihcore.htmlformentry.analysis;
+
+import org.openmrs.module.pihcore.htmlformentry.analysis.converter.Converter;
+import org.openmrs.module.pihcore.htmlformentry.analysis.converter.file.FileToStringConverter;
+import org.openmrs.module.pihcore.htmlformentry.analysis.converter.tag.FlattenObsGroupsConverter;
+import org.openmrs.module.pihcore.htmlformentry.analysis.converter.tag.FlattenOrExcludeIfModeConverter;
+import org.openmrs.module.pihcore.htmlformentry.analysis.converter.tag.MergeParentToChildrenConverter;
+import org.openmrs.module.pihcore.htmlformentry.analysis.converter.tag.MergeSectionToChildrenConverter;
+import org.openmrs.module.pihcore.htmlformentry.analysis.converter.tag.MergeSiblingsConverter;
+import org.openmrs.module.pihcore.htmlformentry.analysis.converter.tag.RemoveTagByNameConverter;
+import org.openmrs.module.pihcore.htmlformentry.analysis.converter.xml.ApplyMacrosConverter;
+import org.openmrs.module.pihcore.htmlformentry.analysis.converter.xml.ApplyRepeatsConverter;
+import org.openmrs.module.pihcore.htmlformentry.analysis.converter.xml.ApplyTranslationsConverter;
+import org.openmrs.module.pihcore.htmlformentry.analysis.converter.xml.StripCommentsConverter;
+import org.openmrs.module.pihcore.htmlformentry.analysis.converter.xml.TextConverter;
+import org.openmrs.module.pihcore.htmlformentry.analysis.converter.xml.XmlToTagConverter;
+import org.openmrs.module.pihcore.htmlformentry.analysis.processor.TagProcessor;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.File;
+import java.util.ArrayList;
+import java.util.List;
+
+public class HtmlFormAnalyzer {
+
+    private final Logger log = LoggerFactory.getLogger(HtmlFormAnalyzer.class);
+
+    public <T> DataSet analyze(File fileOrDirectory, TagProcessor processor) throws Exception {
+        log.info("Analysis started for " + fileOrDirectory.getAbsolutePath() + " with processor: " + processor);
+        List<HtmlFormTag> tags = new ArrayList<>();
+        if (fileOrDirectory.exists()) {
+            if (fileOrDirectory.isFile()) {
+                tags.add(convertFileToTag(fileOrDirectory));
+            }
+            else if (fileOrDirectory.isDirectory()) {
+                for (File file : HtmlFormUtils.getNestedFilesBySuffix(fileOrDirectory, "xml")) {
+                    try {
+                        tags.add(convertFileToTag(file));
+                    }
+                    catch (Exception e) {
+                        log.error("Unable to convert file to tag at: " + file, e);
+                    }
+                }
+            }
+        }
+        log.info("Successfully converted " + tags.size() + " forms to tags.  Executing processor...");
+        return processor.process(tags);
+    }
+
+    public HtmlFormTag convertFileToTag(File formFile) {
+        try {
+            log.debug("Processing htmlform file: " + formFile.getAbsolutePath());
+            String xml = new FileToStringConverter().convert(formFile);
+            for (Converter<String, String> converter : getXmlConverters()) {
+                log.debug("Converting xml: " + converter);
+                xml = converter.convert(xml);
+            }
+            log.debug("Converting xml to tags");
+            HtmlFormTag tag = new XmlToTagConverter().convert(xml);
+            for (Converter<HtmlFormTag, HtmlFormTag> converter : getTagConverters()) {
+                log.debug("Converting tag: " + converter);
+                tag = converter.convert(tag);
+            }
+            tag.setHtmlFormFile(formFile);
+            return tag;
+        }
+        catch (Exception e) {
+            throw new IllegalArgumentException("Unable to load form from " + formFile.getName(), e);
+        }
+    }
+
+    public List<Converter<String, String>> getXmlConverters() {
+        List<Converter<String, String>> l = new ArrayList<>();
+        l.add(new StripCommentsConverter());
+        l.add(new ApplyMacrosConverter());
+        l.add(new ApplyRepeatsConverter());
+        l.add(new ApplyTranslationsConverter());
+        l.add(new TextConverter("(!$user.hasPrivilege('Task: emr.retroConsultNoteThisProviderOnly') and !$user.hasPrivilege('Task: emr.retroConsultNote')) or ($user.hasPrivilege('Task: emr.retroConsultNoteThisProviderOnly') and !$user.hasPrivilege('Task: emr.retroConsultNote') and $visit.open)", "retroCondition1"));
+        l.add(new TextConverter("$user.hasPrivilege('Task: emr.retroConsultNoteThisProviderOnly') and !($user.hasPrivilege('Task: emr.retroConsultNote')) and (!$visit.open)", "retroCondition2"));
+        l.add(new TextConverter("$user.hasPrivilege('Task: emr.retroConsultNote')", "retroCondition3"));
+        return l;
+    }
+
+    public List<Converter<HtmlFormTag, HtmlFormTag>> getTagConverters() {
+        List<Converter<HtmlFormTag, HtmlFormTag>> l = new ArrayList<>();
+
+        // Remove any standard html tags
+        l.add(new RemoveTagByNameConverter("#comment"));
+        l.add(new RemoveTagByNameConverter("#text"));
+        l.add(new RemoveTagByNameConverter("a"));
+        l.add(new RemoveTagByNameConverter("b"));
+        l.add(new RemoveTagByNameConverter("br"));
+        l.add(new RemoveTagByNameConverter("button"));
+        l.add(new RemoveTagByNameConverter("center"));
+        l.add(new RemoveTagByNameConverter("dd"));
+        l.add(new RemoveTagByNameConverter("div"));
+        l.add(new RemoveTagByNameConverter("dl"));
+        l.add(new RemoveTagByNameConverter("dt"));
+        l.add(new RemoveTagByNameConverter("field"));
+        l.add(new RemoveTagByNameConverter("fieldset"));
+        l.add(new RemoveTagByNameConverter("font"));
+        l.add(new RemoveTagByNameConverter("h1"));
+        l.add(new RemoveTagByNameConverter("h2"));
+        l.add(new RemoveTagByNameConverter("h3"));
+        l.add(new RemoveTagByNameConverter("h4"));
+        l.add(new RemoveTagByNameConverter("h5"));
+        l.add(new RemoveTagByNameConverter("h6"));
+        l.add(new RemoveTagByNameConverter("h7"));
+        l.add(new RemoveTagByNameConverter("hr"));
+        l.add(new RemoveTagByNameConverter("i"));
+        l.add(new RemoveTagByNameConverter("img"));
+        l.add(new RemoveTagByNameConverter("input"));
+        l.add(new RemoveTagByNameConverter("label"));
+        l.add(new RemoveTagByNameConverter("legend"));
+        l.add(new RemoveTagByNameConverter("li"));
+        l.add(new RemoveTagByNameConverter("p"));
+        l.add(new RemoveTagByNameConverter("script"));
+        l.add(new RemoveTagByNameConverter("select"));
+        l.add(new RemoveTagByNameConverter("sl"));
+        l.add(new RemoveTagByNameConverter("small"));
+        l.add(new RemoveTagByNameConverter("span"));
+        l.add(new RemoveTagByNameConverter("strong"));
+        l.add(new RemoveTagByNameConverter("style"));
+        l.add(new RemoveTagByNameConverter("table"));
+        l.add(new RemoveTagByNameConverter("tbody"));
+        l.add(new RemoveTagByNameConverter("td"));
+        l.add(new RemoveTagByNameConverter("th"));
+        l.add(new RemoveTagByNameConverter("thead"));
+        l.add(new RemoveTagByNameConverter("tr"));
+        l.add(new RemoveTagByNameConverter("u"));
+        l.add(new RemoveTagByNameConverter("ul"));
+
+        // Remove tags that do not impact the data model and cannot be easily used as context for other elements
+        l.add(new RemoveTagByNameConverter("uimessage"));
+        l.add(new RemoveTagByNameConverter("lookup"));
+        l.add(new RemoveTagByNameConverter("submit"));
+
+        // Remove any sections of the form that are added *just* for view mode
+        l.add(new FlattenOrExcludeIfModeConverter());
+
+        // Flatten any includeIf or excludeIf expressions down into the child tags
+        l.add(new MergeParentToChildrenConverter("includeIf", " | "));
+        l.add(new MergeParentToChildrenConverter("excludeIf", " | "));
+
+        // Handle the complex web of velocity conditions for entry of date/location/provider
+        l.add(new MergeSiblingsConverter("encounterDate"));
+        l.add(new MergeSiblingsConverter("encounterLocation"));
+        l.add(new MergeSiblingsConverter("encounterProviderAndRole"));
+
+        // Merge obs groups attributes down into children, and add any hidden obs
+        l.add(new FlattenObsGroupsConverter());
+
+        // Flatten sections down into the child tags
+        l.add(new MergeSectionToChildrenConverter());
+
+        // Handle when/then tags
+        l.add(new MergeSiblingsConverter("when"));
+        l.add(new RemoveTagByNameConverter("controls"));
+
+        return l;
+    }
+}

api/src/main/java/org/openmrs/module/pihcore/htmlformentry/analysis/HtmlFormTag.java

@@ -0,0 +1,83 @@
+package org.openmrs.module.pihcore.htmlformentry.analysis;
+
+import lombok.Data;
+
+import java.io.File;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * A tag represents a specific xml node in a html form
+ */
+@Data
+public class HtmlFormTag {
+
+    private String name;
+    private final Map<String, String> attributes = new HashMap<>();
+    private String data;
+    private final List<HtmlFormTag> childTags = new ArrayList<>();
+    private File htmlFormFile;
+
+    public HtmlFormTag() {
+    }
+
+    public HtmlFormTag cloneWithoutChildren() {
+        HtmlFormTag clone = new HtmlFormTag();
+        clone.setName(name);
+        clone.setData(data);
+        for (String key : attributes.keySet()) {
+            clone.getAttributes().put(key, attributes.get(key));
+        }
+        return clone;
+    }
+
+    public String getAttributeValue(String name) {
+        return getAttributes().get(name);
+    }
+
+    public void addAttribute(String name, String value) {
+        String existingValue = getAttributes().get(name);
+        if (existingValue != null && !existingValue.equals(value)) {
+            throw new IllegalStateException("Attribute with name " + name + " already exists in: " + this);
+        }
+        attributes.put(name, value);
+    }
+
+    public void mergeAttributeRecursively(String name, String value, String separator) {
+        String existingValue = getAttributes().get(name);
+        if (existingValue != null && !existingValue.equals(value)) {
+            value = existingValue + separator + value;
+        }
+        attributes.put(name, value);
+        for (HtmlFormTag child : childTags) {
+            child.mergeAttributeRecursively(name, value, separator);
+        }
+    }
+
+    public boolean hasAttribute(String name, String value) {
+        String v = attributes.get(name);
+        return v != null && v.equalsIgnoreCase(value);
+    }
+
+    public boolean hasAttribute(String name) {
+        return attributes.containsKey(name);
+    }
+
+    public List<HtmlFormTag> getAllTagsByName(String name) {
+        List<HtmlFormTag> ret = new ArrayList<>();
+        if (getName().equalsIgnoreCase(name)) {
+            ret.add(this);
+        }
+        for (HtmlFormTag childTag : getChildTags()) {
+            ret.addAll(childTag.getAllTagsByName(name));
+        }
+        return ret;
+    }
+
+    @Override
+    public String toString() {
+        return getName() + getAttributes();
+    }
+}

api/src/main/java/org/openmrs/module/pihcore/htmlformentry/analysis/HtmlFormUtils.java

@@ -0,0 +1,39 @@
+package org.openmrs.module.pihcore.htmlformentry.analysis;
+
+import java.io.File;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * A tag represents a specific xml node in a html form
+ */
+public class HtmlFormUtils {
+
+    public static List<File> getNestedFilesBySuffix(File directory, String suffix) {
+        List<File> files = new ArrayList<>();
+        if (directory.exists() && directory.isDirectory()) {
+            File[] filesInDirectory = directory.listFiles();
+            if (filesInDirectory != null) {
+                for (File f : filesInDirectory) {
+                    if (f.isDirectory()) {
+                        files.addAll(getNestedFilesBySuffix(f, suffix));
+                    } else {
+                        if (f.getName().endsWith(suffix)) {
+                            files.add(f);
+                        }
+                    }
+                }
+            }
+        }
+        return files;
+    }
+
+    public static String mapToString(Map<String, String> m, String keyValueSeparator, String entrySeparator) {
+        List<String> ret = new ArrayList<>();
+        for (String key : m.keySet()) {
+            ret.add(key + keyValueSeparator + m.get(key));
+        }
+        return String.join(entrySeparator, ret);
+    }
+}

api/src/main/java/org/openmrs/module/pihcore/htmlformentry/analysis/converter/Converter.java

@@ -0,0 +1,5 @@
+package org.openmrs.module.pihcore.htmlformentry.analysis.converter;
+
+public interface Converter<I, O> {
+    O convert(I input) throws Exception;
+}

api/src/main/java/org/openmrs/module/pihcore/htmlformentry/analysis/converter/file/FileToStringConverter.java

@@ -0,0 +1,14 @@
+package org.openmrs.module.pihcore.htmlformentry.analysis.converter.file;
+
+import org.apache.commons.io.FileUtils;
+import org.openmrs.module.pihcore.htmlformentry.analysis.converter.Converter;
+
+import java.io.File;
+import java.nio.charset.StandardCharsets;
+
+public class FileToStringConverter implements Converter<File, String> {
+
+    public String convert(File input) throws Exception {
+        return FileUtils.readFileToString(input, StandardCharsets.UTF_8);
+    }
+}