* Licensed to the Apache Software Foundation (ASF) under one

* or more contributor license agreements.  See the NOTICE file

* distributed with this work for additional information

* regarding copyright ownership.  The ASF licenses this file

* to you 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.

*******************************************************************************/

* Widget Library - Form Renderer implementation based on Freemarker macros

*

*/

    public static final String module = MacroFormRenderer.class.getName();

    private Template macroLibrary;

    private WeakHashMap<Appendable, Environment> environments = new WeakHashMap<Appendable, Environment>();

    private StringUtil.SimpleEncoder internalEncoder;

    protected RequestHandler rh;

    protected HttpServletRequest request;

    protected HttpServletResponse response;

    protected boolean javaScriptEnabled = false;

    protected boolean renderPagination = true;

    protected boolean widgetCommentsEnabled = false;

    public MacroFormRenderer(String macroLibraryPath, HttpServletRequest request, HttpServletResponse response) throws TemplateException, IOException {

        macroLibrary = FreeMarkerWorker.getTemplate(macroLibraryPath);

        this.request = request;

        this.response = response;

        ServletContext ctx = (ServletContext) request.getAttribute("servletContext");

        this.rh = (RequestHandler) ctx.getAttribute("_REQUEST_HANDLER_");

        this.javaScriptEnabled = UtilHttp.isJavaScriptEnabled(request);

        internalEncoder = StringUtil.getEncoder("string");

    }

    @Deprecated

    public MacroFormRenderer(String macroLibraryPath, Appendable writer, HttpServletRequest request, HttpServletResponse response) throws TemplateException, IOException {

        this(macroLibraryPath, request, response);

    }

    public boolean getRenderPagination() {

        return this.renderPagination;

    }

    public void setRenderPagination(boolean renderPagination) {

        this.renderPagination = renderPagination;

    }

    private void executeMacro(Appendable writer, String macro) throws IOException {

        try {

            Environment environment = getEnvironment(writer);

            Reader templateReader = new StringReader(macro);

            // FIXME: I am using a Date as an hack to provide a unique name for the template...

            Template template = new Template((new java.util.Date()).toString(), templateReader, FreeMarkerWorker.getDefaultOfbizConfig());

            templateReader.close();

            environment.include(template);

        } catch (TemplateException e) {

            Debug.logError(e, "Error rendering screen thru ftl macro: " + macro, module);

        } catch (IOException e) {

            Debug.logError(e, "Error rendering screen thru ftl, macro: " + macro, module);

        }

    }

    private Environment getEnvironment(Appendable writer) throws TemplateException, IOException {

        Environment environment = environments.get(writer);

        if (environment == null) {

            Map<String, Object> input = UtilMisc.toMap("key", null);

            environment = FreeMarkerWorker.renderTemplate(macroLibrary, input, writer);

            environments.put(writer, environment);

        }

        return environment;

    }

    private void appendWhitespace(Appendable writer) throws IOException {

        // appending line ends for now, but this could be replaced with a simple space or something

        writer.append("\r\n");

        //writer.append(' ');

    }

    private String encode(String value, ModelFormField modelFormField, Map<String, Object> context) {

        if (UtilValidate.isEmpty(value)) {

            return value;

        }

        StringUtil.SimpleEncoder encoder = (StringUtil.SimpleEncoder)context.get("simpleEncoder");

        if (modelFormField.getEncodeOutput() && encoder != null) {

            value = encoder.encode(value);

        } else {

            value = internalEncoder.encode(value);

        }

        return value;

    }

    public void renderLabel(Appendable writer, Map<String, Object> context, ModelScreenWidget.Label label) throws IOException {

        String labelText = label.getText(context);

        if (UtilValidate.isEmpty(labelText)) {

            // nothing to render

            return;

        }

        StringWriter sr = new StringWriter();

        sr.append("<@renderLabel ");

        sr.append("text=\"");

        sr.append(labelText);

        sr.append("\"");

        sr.append(" />");

        executeMacro(writer, sr.toString());

    }

    public void renderDisplayField(Appendable writer, Map<String, Object> context, DisplayField displayField) throws IOException {

        ModelFormField modelFormField = displayField.getModelFormField();

        ModelForm modelForm = modelFormField.getModelForm();

        String idName = modelFormField.getIdName();

        if (UtilValidate.isNotEmpty(idName) && ("list".equals(modelForm.getType()) || "multi".equals(modelForm.getType()))) {

            idName += "_" + modelForm.getRowCount();

        }

        String description = displayField.getDescription(context);

        String type = displayField.getType();

        String imageLocation = displayField.getImageLocation(context);

        Integer size = Integer.valueOf("0");

        String title = "";

        if (UtilValidate.isNotEmpty(displayField.getSize())) {

            try {

                size = Integer.parseInt(displayField.getSize());

            }

            catch(NumberFormatException nfe) {

                Debug.logError(nfe, "Error reading size of a field fieldName=" + displayField.getModelFormField().getFieldName()

                        + " FormName= " + displayField.getModelFormField().getModelForm().getName(), module);

            }

        }

        ModelFormField.InPlaceEditor inPlaceEditor = displayField.getInPlaceEditor();

        boolean ajaxEnabled = inPlaceEditor != null && this.javaScriptEnabled;

        if (UtilValidate.isNotEmpty(description) && size > 0 && description.length() > size ) {

            title = description;

            description = description.substring(0, size - 8) + "..." + description.substring(description.length() - 5);

        }

        StringWriter sr = new StringWriter();

        sr.append("<@renderDisplayField ");

        sr.append("type=\"");

        sr.append(type);

        sr.append("\" imageLocation=\"");

        sr.append(imageLocation);

        sr.append("\" idName=\"");

        sr.append(idName);

        sr.append("\" description=\"");

        sr.append(FreeMarkerWorker.encodeDoubleQuotes(description));

        sr.append("\" title=\"");

        sr.append(title);

        sr.append("\" class=\"");

        sr.append(modelFormField.getWidgetStyle());

        sr.append("\" alert=\"");

        sr.append(modelFormField.shouldBeRed(context)? "true": "false");

        if (ajaxEnabled) {

            String url = inPlaceEditor.getUrl(context);

            String extraParameter = "{";

            Map<String, Object> fieldMap = inPlaceEditor.getFieldMap(context);

            if (fieldMap != null) {

                Set<Entry<String, Object>> fieldSet = fieldMap.entrySet();

                Iterator<Entry<String, Object>> fieldIterator = fieldSet.iterator();

                int count = 0;

                while (fieldIterator.hasNext()) {

                    count++;

                    Entry<String, Object> field = fieldIterator.next();

                    extraParameter += field.getKey() + ":'" + (String) field.getValue() + "'";

                    if (count < fieldSet.size()) {

                        extraParameter += ',';

                    }

                }

            }

            extraParameter += "}";

            sr.append("\" inPlaceEditorUrl=\"");

            sr.append(url);

            sr.append("\" inPlaceEditorParams=\"");

            StringWriter inPlaceEditorParams = new StringWriter();

            inPlaceEditorParams.append("{name: '");

            if (UtilValidate.isNotEmpty(inPlaceEditor.getParamName())) {

                inPlaceEditorParams.append(inPlaceEditor.getParamName());

            } else {

                inPlaceEditorParams.append(modelFormField.getFieldName());

            }

            inPlaceEditorParams.append("'");

            inPlaceEditorParams.append(", method: 'POST'");

            inPlaceEditorParams.append(", submitdata: " + extraParameter);

            inPlaceEditorParams.append(", type: 'textarea'");

            inPlaceEditorParams.append(", select: 'true'");

            inPlaceEditorParams.append(", onreset: function(){jQuery('#cc_" + idName + "').css('background-color', 'transparent');}");

            if (UtilValidate.isNotEmpty(inPlaceEditor.getCancelText())) {

                inPlaceEditorParams.append(", cancel: '" +inPlaceEditor.getCancelText()+ "'");

            } else {

                inPlaceEditorParams.append(", cancel: 'Cancel'");

            }

            if (UtilValidate.isNotEmpty(inPlaceEditor.getClickToEditText())) {

                inPlaceEditorParams.append(", tooltip: '" +inPlaceEditor.getClickToEditText()+ "'");

            }

            if (UtilValidate.isNotEmpty(inPlaceEditor.getFormClassName())) {

                inPlaceEditorParams.append(", cssclass: '" + inPlaceEditor.getFormClassName()+ "'");

            } else {

                inPlaceEditorParams.append(", cssclass: 'inplaceeditor-form'");

            }

            if (UtilValidate.isNotEmpty(inPlaceEditor.getLoadingText())) {

                inPlaceEditorParams.append(", indicator: '" +inPlaceEditor.getLoadingText()+ "'");

            }

            if (UtilValidate.isNotEmpty(inPlaceEditor.getOkControl())) {

                inPlaceEditorParams.append(", submit: ");

                if (!"false".equals(inPlaceEditor.getOkControl())) {

                    inPlaceEditorParams.append("'");

                }

                inPlaceEditorParams.append(inPlaceEditor.getOkControl());

                if (!"false".equals(inPlaceEditor.getOkControl())) {

                    inPlaceEditorParams.append("'");

                }

            } else {

                inPlaceEditorParams.append(", submit: 'OK'");

            }

            if (UtilValidate.isNotEmpty(inPlaceEditor.getRows())) {

                inPlaceEditorParams.append(", rows: '" +inPlaceEditor.getRows()+ "'");

            }

            if (UtilValidate.isNotEmpty(inPlaceEditor.getCols())) {

                inPlaceEditorParams.append(", cols: '" +inPlaceEditor.getCols()+ "'");

            }

            inPlaceEditorParams.append("}");

            sr.append(inPlaceEditorParams.toString());

        }

        sr.append("\" />");

        executeMacro(writer, sr.toString());

        if (displayField instanceof DisplayEntityField) {

            makeHyperlinkString(writer,((DisplayEntityField) displayField).getSubHyperlink(),context);

        }

        this.appendTooltip(writer, context, modelFormField);

    }

    public void renderHyperlinkField(Appendable writer, Map<String, Object> context, HyperlinkField hyperlinkField) throws IOException {

        this.request.setAttribute("image", hyperlinkField.getImageLocation(context));

        ModelFormField modelFormField = hyperlinkField.getModelFormField();

        String encodedAlternate = encode(hyperlinkField.getAlternate(context), modelFormField, context);

        String encodedImageTitle = encode(hyperlinkField.getImageTitle(context), modelFormField, context);

        this.request.setAttribute("alternate", encodedAlternate);

        this.request.setAttribute("imageTitle", encodedImageTitle);

        this.request.setAttribute("descriptionSize", hyperlinkField.getSize());

        makeHyperlinkByType(writer, hyperlinkField.getLinkType(), modelFormField.getWidgetStyle(), hyperlinkField.getTargetType(), hyperlinkField.getTarget(context),

                hyperlinkField.getParameterMap(context), hyperlinkField.getDescription(context), hyperlinkField.getTargetWindow(context), hyperlinkField.getConfirmation(context), modelFormField,

                this.request, this.response, context);

        this.appendTooltip(writer, context, modelFormField);

        this.request.removeAttribute("image");

        this.request.removeAttribute("descriptionSize");

    }

    public void renderTextField(Appendable writer, Map<String, Object> context, TextField textField) throws IOException {

        ModelFormField modelFormField = textField.getModelFormField();

        String name = modelFormField.getParameterName(context);

        String className = "";

        String alert = "false";

        String mask = "";

        if (UtilValidate.isNotEmpty(modelFormField.getWidgetStyle())) {

            className = modelFormField.getWidgetStyle();

            if (modelFormField.shouldBeRed(context)) {

                alert = "true";

            }

        }

        String value = modelFormField.getEntry(context, textField.getDefaultValue(context));

        String textSize = Integer.toString(textField.getSize());

        String maxlength = "";

        if (textField.getMaxlength() != null) {

            maxlength = Integer.toString(textField.getMaxlength());

        }

        String event = modelFormField.getEvent();