validatortool.java

一个用于java web页面开发的开源包

        return results.toString();
    }



    /**
     * Generates the dynamic JavaScript for the form.
     *
     * @param resources the validator resources
     * @param locale the locale for the current request
     * @param form the form to generate javascript for
     * @return the dynamic javascript
     */
    protected String getDynamicJavascript(ValidatorResources resources,
                                          Locale locale,
                                          Form form)
    {
        StringBuffer results = new StringBuffer();

        MessageResources messages =
            StrutsUtils.getMessageResources(request, app);

        List actions = createActionList(resources, form);

        final String methods = createMethods(actions);

        String formName = form.getName();

        jsFormName = formName;
        if(jsFormName.charAt(0) == '/') {
            String mappingName = StrutsUtils.getActionMappingName(jsFormName);
            ModuleConfig mconfig = ModuleUtils.getInstance().getModuleConfig(request, app);

            ActionConfig mapping = (ActionConfig) mconfig.findActionConfig(mappingName);
            if (mapping == null) {
                throw new NullPointerException("Cannot retrieve mapping for action " + mappingName);
            }
            jsFormName = mapping.getAttribute();
        }

        results.append(getJavascriptBegin(methods));

        for (Iterator i = actions.iterator(); i.hasNext();)
        {
            ValidatorAction va = (ValidatorAction)i.next();
            int jscriptVar = 0;
            String functionName = null;

            if (va.getJsFunctionName() != null && va.getJsFunctionName().length() > 0)
            {
                functionName = va.getJsFunctionName();
            }
            else
            {
                functionName = va.getName();
            }

            results.append("    function ");
            results.append(jsFormName);
            results.append("_");
            results.append(functionName);
            results.append(" () { \n");

            for (Iterator x = form.getFields().iterator(); x.hasNext();)
            {
                Field field = (Field)x.next();

                // Skip indexed fields for now until there is
                // a good way to handle error messages (and the length
                // of the list (could retrieve from scope?))
                if (field.isIndexed()
                    || field.getPage() != page
                    || !field.isDependency(va.getName()))
                {
                    continue;
                }

                String message = Resources.getMessage(app, request, messages,
                                                      locale, va, field);

                message = (message != null) ? message : "";

                //jscriptVar = this.getNextVar(jscriptVar);

                results.append("     this.a");
                results.append(jscriptVar++);
                results.append(" = new Array(\"");
                results.append(field.getKey()); // TODO: escape?
                results.append("\", \"");
                results.append(escapeJavascript(message));
                results.append("\", ");
                results.append("new Function (\"varName\", \"");

                Map vars = field.getVars();
                // Loop through the field's variables.
                Iterator varsIterator = vars.keySet().iterator();
                while (varsIterator.hasNext())
                {
                    String varName = (String)varsIterator.next(); // TODO: escape?
                    Var var = (Var)vars.get(varName);
                    String varValue =
                        Resources.getVarValue(var, app, request, false);
                    String jsType = var.getJsType();

                    // skip requiredif variables field, fieldIndexed, fieldTest, fieldValue
                    if (varName.startsWith("field"))
                    {
                        continue;
                    }

                    // these are appended no matter what jsType is
                    results.append("this.");
                    results.append(varName);

                    String escapedVarValue = escapeJavascript(varValue);

                    if (Var.JSTYPE_INT.equalsIgnoreCase(jsType))
                    {
                        results.append("=");
                        results.append(escapedVarValue);
                        results.append("; ");
                    }
                    else if (Var.JSTYPE_REGEXP.equalsIgnoreCase(jsType))
                    {
                        results.append("=/");
                        results.append(escapedVarValue);
                        results.append("/; ");
                    }
                    else if (Var.JSTYPE_STRING.equalsIgnoreCase(jsType))
                    {
                        results.append("='");
                        results.append(escapedVarValue);
                        results.append("'; ");
                    }
                    // So everyone using the latest format
                    // doesn't need to change their xml files immediately.
                    else if ("mask".equalsIgnoreCase(varName))
                    {
                        results.append("=/");
                        results.append(escapedVarValue);
                        results.append("/; ");
                    }
                    else
                    {
                        results.append("='");
                        results.append(escapedVarValue);
                        results.append("'; ");
                    }
                }
                results.append(" return this[varName];\"));\n");
            }
            results.append("    } \n\n");
        }
        return results.toString();
    }


    /**
     * <p>Backslash-escapes the following characters from the input string:
     * &quot;, &apos;, \, \r, \n.</p>
     *
     * <p>This method escapes characters that will result in an invalid
     * Javascript statement within the validator Javascript.</p>
     *
     * @param str The string to escape.
     * @return The string <code>s</code> with each instance of a double quote,
     *         single quote, backslash, carriage-return, or line feed escaped
     *         with a leading backslash.
     * @since VelocityTools 1.2
     */
    protected String escapeJavascript(String str)
    {
        if (str == null)
        {
            return null;
        }
        int length = str.length();
        if (length == 0)
        {
            return str;
        }

        // guess at how many chars we'll be adding...
        StringBuffer out = new StringBuffer(length + 4);
        // run through the string escaping sensitive chars
        for (int i=0; i < length; i++)
        {
            char c = str.charAt(i);
            if (c == '"'  ||
                c == '\'' ||
                c == '\\' ||
                c == '\n' ||
                c == '\r')
            {
                out.append('\\');
            }
            out.append(c);
        }
        return out.toString();
    }


    /**
     * Creates the JavaScript methods list from the given actions.
     * @param actions A List of ValidatorAction objects.
     * @return JavaScript methods.
     */
    protected String createMethods(List actions)
    {
        String methodOperator = " && ";

        StringBuffer methods = null;
        for (Iterator i = actions.iterator(); i.hasNext();)
        {
            ValidatorAction va = (ValidatorAction)i.next();
            if (methods == null)
            {
                methods = new StringBuffer(va.getMethod());
            }
            else
            {
                methods.append(methodOperator);
                methods.append(va.getMethod());
            }
            methods.append("(form)");
        }
        return methods.toString();
    }


    /**
     * Get List of actions for the given Form.
     *
     * @param resources the validator resources
     * @param form the form for which the actions are requested
     * @return A sorted List of ValidatorAction objects.
     */
    protected List createActionList(ValidatorResources resources, Form form)
    {
        List actionMethods = new ArrayList();
        // Get List of actions for this Form
        for (Iterator i = form.getFields().iterator(); i.hasNext();)
        {
            Field field = (Field)i.next();
            for (Iterator x = field.getDependencyList().iterator(); x.hasNext();)
            {
                Object o = x.next();
                if (o != null && !actionMethods.contains(o))
                {
                    actionMethods.add(o);
                }
            }
        }

        List actions = new ArrayList();

        // Create list of ValidatorActions based on actionMethods
        for (Iterator i = actionMethods.iterator(); i.hasNext();)
        {
            String depends = (String) i.next();
            ValidatorAction va = resources.getValidatorAction(depends);

            // throw nicer NPE for easier debugging
            if (va == null)
            {
                throw new NullPointerException(
                    "Depends string \"" + depends +
                    "\" was not found in validator-rules.xml.");
            }

            String javascript = va.getJavascript();
            if (javascript != null && javascript.length() > 0)
            {
                actions.add(va);
            }
            else
            {
                i.remove();
            }
        }

        Collections.sort(actions, actionComparator);
        return actions;
    }


    /**
     * Returns the opening script element and some initial javascript.
     *
     * @param methods javascript validation methods
     * @return  the opening script element and some initial javascript
     */
    protected String getJavascriptBegin(String methods)
    {
        StringBuffer sb = new StringBuffer();
        String name = jsFormName.replace('/', '_'); // remove any '/' characters
        name = jsFormName.substring(0, 1).toUpperCase() +
                      jsFormName.substring(1, jsFormName.length());

        sb.append(this.getStartElement());

        if (this.xhtml && this.cdata)
        {
            sb.append("<![CDATA[\r\n");
        }

        if (!this.xhtml && this.htmlComment)
        {
            sb.append(HTML_BEGIN_COMMENT);
        }
        sb.append("\n     var bCancel = false; \n\n");

        if (methodName == null || methodName.length() == 0)
        {
            sb.append("    function validate");
            sb.append(name);
        }
        else
        {
            sb.append("    function ");
            sb.append(methodName);
        }
        sb.append("(form) {");
        //FIXME? anyone know why all these spaces need to be here?
        sb.append("                                                                   \n");
        sb.append("        if (bCancel) \n");
        sb.append("      return true; \n");
        sb.append("        else \n");

        // Always return true if there aren't any Javascript validation methods
        if (methods == null || methods.length() == 0)
        {
            sb.append("       return true; \n");
        }
        else
        {
            //Making Sure that Bitwise operator works:
            sb.append(" var formValidationResult;\n");
            sb.append("       formValidationResult = " + methods + "; \n");
            sb.append("     return (formValidationResult == 1);\n");

        }
        sb.append("   } \n\n");

        return sb.toString();
    }

    /**
     *
     * @param resources the validation resources
     * @return the static javascript methods
     */
    protected String getJavascriptStaticMethods(ValidatorResources resources)
    {
        StringBuffer sb = new StringBuffer("\n\n");

        Iterator actions = resources.getValidatorActions().values().iterator();
        while (actions.hasNext())
        {
            ValidatorAction va = (ValidatorAction) actions.next();
            if (va != null)
            {
                String javascript = va.getJavascript();
                if (javascript != null && javascript.length() > 0)
                {
                    sb.append(javascript + "\n");
                }
            }
        }
        return sb.toString();
    }


    /**
     * Returns the closing script element.
     *
     * @return the closing script element
     */
    protected String getJavascriptEnd()
    {
        StringBuffer sb = new StringBuffer();
        sb.append("\n");

        if (!this.xhtml && this.htmlComment)
        {
            sb.append(HTML_END_COMMENT);
        }

        if (this.xhtml && this.cdata)
        {
            sb.append("]]>\r\n");
        }
        sb.append("</script>\n\n");

        return sb.toString();
    }


    /**
     * Constructs the beginning <script> element depending on xhtml status.
     *
     * @return the beginning <script> element depending on xhtml status
     */
    private String getStartElement()
    {
        StringBuffer start = new StringBuffer("<script type=\"text/javascript\"");

        // there is no language attribute in xhtml
        if (!this.xhtml)
        {
            start.append(" language=\"Javascript1.1\"");
        }

        if (this.src != null)
        {
            start.append(" src=\"" + src + "\"");
        }

        start.append("> \n");
        return start.toString();
    }

}