* Copyright (C) 2012 JBoss Inc

*

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

*/

* Extension of the HTML base panel that makes possible to embed inside the HTML dashboard variables.

* <p>For example, it's possible to display, as a part of an HTML fragment, the number of running cases that a given dashboard KPI is displaying, or

* the total amount of sales made in a given period. The following HTML fragment is an example of how to do that. Suppose we want to display the following

* HTML fragment: <br><b> &#8364; 9600K Total sales between January 1st, 2008 and July 31st, 2008</b>.<br>

* As we can see we got 3 dynamic variables extracted from the

* dashboard context. The HTML source that prints the previous HTML is: &lt;b&gt;&amp;#36; {dashboard_sumfunction, order_amount} Total sales between {dashboard_minvalue,

* date} and {dashboard_maxvalue, date}&lt;/b&gt; Each command is replaced by:

* <ul>

* <li>{dashboard_sumfunction, order_amount} =>  &#8364; 9600K

* <li>{dashboard_minvalue, date}            => January 1st, 2008

* <li>{dashboard_maxvalue, date}            => July 31st, 2008

* </ul>

* So with a simple command mechanism the HTML editor can mix HTML static code with information displayed by the dashboard&#39;s KPIs.

* Next is a list fo some commands available:<br>

* <b>Data property commands</b>. Access the dashboard data filter current status:

* <ul>

* <li>{dashboard_minvalue, &lt;propertyId&gt;}   => The minimum data filter value defined for a property.

* <li>{dashboard_maxvalue, &lt;propertyId&gt;}   => The maximum data filter value defined for a property.

* <li>{dashboard_selectedvalues, &lt;propertyId&gt;} => The filter values the user has entered.

* <li>{dashboard_allvalues, &lt;propertyId&gt;}  => All the filter allowed values.

* </ul>

* &lt;propertyId&gt; must be replaced by a property identifier belonging to the list of properties loaded by the data providers

* contained in the dashboard. So we got a data provider that loads, for instance, an order_amount property, then we could extract

* information of that property using those commands.

*

* <p><b>Function commands</b>. Apply an scalar function over the values loaded for a given property:

* <ul>

* <li>{dashboard_count, &lt;propertyId&gt;}    => The number of occurrences or values a given property has.

* <li>{dashboard_distinct, &lt;propertyId&gt;} => The number of different occurrences a given property has.

* <li>{dashboard_max, &lt;propertyId&gt;}      => The maximum value for a given property.

* <li>{dashboard_min, &lt;propertyId&gt;}      => The minimum value for a given property.

* <li>{dashboard_average, &lt;propertyId&gt;}  => The average value for a given property.

* <li>{dashboard_sum, &lt;propertyId&gt;}      => The sum of all the values for a given property.

* </ul>

* The last 4 commands can only be applied to numeric properties.<br>

*

* <p><b>Navigations commands</b>. Give access to the user navigation context within the workspace:

* <ul>

* <li>{navigation_workspace_id}     => The current workspace identifier.

* <li>{navigation_workspace_title}  => The current workspace title localized in the user language.

* <li>{navigation_page_id}        => The current page identifier.

* <li>{navigation_page_title}     => The current page title localized in the user language.

* <li>{navigation_language}      => The current language (es, en, ca, ...)

* <li>{navigation_user_login}    => The logged user login.

* <li>{navigation_user_name}     => The logged user name.

* <li>{navigation_user_email}    => The logged user e-mail.

* </ul>

*/

    /**

     * Logger

     */

    protected transient static org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(DashboardHTMLDriver.class);

    /**

     * OVERWRITTEN in order to process commands embedded in the HTML.

     */

    public Map getHtmlCode(Panel panel) {

        Map origMap = super.getHtmlCode(panel);

        if (origMap == null || !getPanelSession(panel).isShowMode()) return origMap;

        // Process the commands embedded into the HTML.

        Map modifiedMap = new HashMap();

        Iterator it = origMap.keySet().iterator();

        while (it.hasNext()) {

            String language = (String) it.next();

            String html = (String) origMap.get(language);

            try {

                TemplateProcessor tp = DataProviderServices.lookup().getTemplateProcessor();

                String parsedHtml = tp.processTemplate(html, new DashboardCommandProcessor());

                modifiedMap.put(language, parsedHtml);

            } catch (Exception e) {

                log.error("HTML template processing error.", e);

                continue;

            }

        }

        return modifiedMap;

    }

    // DashboardDriver interface

    public Set<DataProvider> getDataProvidersUsed(Panel panel) throws Exception {

        Set<DataProvider> results = new HashSet<DataProvider>();

        Map origMap = super.getHtmlCode(panel);

        if (origMap == null || !getPanelSession(panel).isShowMode()) return results;

        String html = (String) origMap.get(LocaleManager.currentLang());

        if (StringUtils.isBlank(html)) return results;

        // Get the commands embedded into the HTML.

        DashboardCommandProcessor cp = new DashboardCommandProcessor();

        cp.setCommandExecutionEnabled(false);

        TemplateProcessor tp = DataProviderServices.lookup().getTemplateProcessor();

        tp.processTemplate(html, cp);

        List<Command> commandList = cp.getSuccessfulCommands();

        // Get the data providers used by the commands.

        Dashboard dashboard = DashboardHandler.lookup().getCurrentDashboard();

        Set<DataProvider> dataProviders = dashboard.getDataProviders();

        for (DataProvider dataProvider : dataProviders) {

            DataProperty[] dataProperties = dataProvider.getDataSet().getProperties();

            for (int i = 0; i < dataProperties.length; i++) {

                DataProperty dataProperty = dataProperties[i];

                for (Command command : commandList) {

                    if (command.containsProperty(dataProperty.getPropertyId())) {

                        results.add(dataProvider);

                    }

                }

            }

        }

        return results;

    }

}