org.sipfoundry.sipxconfig.components.TapestryContext.java Source code

Introduction

Here is the source code for org.sipfoundry.sipxconfig.components.TapestryContext.java

Source

/*
 *
 *
 * Copyright (C) 2007 Pingtel Corp., certain elements licensed under a Contributor Agreement.
 * Contributors retain copyright to elements licensed under a Contributor Agreement.
 * Licensed to the User under the LGPL license.
 *
 * $
 */
package org.sipfoundry.sipxconfig.components;

import java.io.IOException;
import java.io.InputStream;
import java.text.DateFormat;
import java.util.Collection;
import java.util.Locale;

import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang.StringUtils;
import org.apache.hivemind.Messages;
import org.apache.tapestry.IAsset;
import org.apache.tapestry.IComponent;
import org.apache.tapestry.form.IPropertySelectionModel;
import org.sipfoundry.sipxconfig.common.NamedObject;
import org.sipfoundry.sipxconfig.common.UserException;
import org.sipfoundry.sipxconfig.site.skin.SkinControl;

/**
 * Tapestry utilities available to web pages
 */
public class TapestryContext {
    public static final String CONTEXT_BEAN_NAME = "tapestry";

    private static final int SECONDS_PER_MINUTE = 60;
    private static final String BLANK = "";
    private static final String UNDERSCORE = "_";

    private HivemindContext m_hivemindContext;

    private SkinControl m_skinControl;

    /**
     * Set to false to suppress rendering base tag which is important with some older HTTP
     * proxies.
     */
    private boolean m_renderBaseTag;

    /**
     * Session timeout for an admin session in minutes.
     */
    private int m_adminSessionTimeout;

    /**
     * Session timeout for a user session in minutes.
     */
    private int m_userSessionTimeout;

    public void setHivemindContext(HivemindContext hivemindContext) {
        m_hivemindContext = hivemindContext;
    }

    public HivemindContext getHivemindContext() {
        return m_hivemindContext;
    }

    /**
     * Add a option to the dropdown model with a label to instruct the user to make a selection.
     * If not item is selected, your business object method will be explicitly set to null
     */
    public IPropertySelectionModel instructUserToSelect(IPropertySelectionModel model, Messages messages) {
        return addExtraOption(model, messages, "prompt.select");
    }

    /**
     * Add a option to the dropdown model with a label to instruct the user to make a selection.
     * If not item is selected, your business object method will be explicitly set to null
     */
    public IPropertySelectionModel addExtraOption(IPropertySelectionModel model, Messages messages,
            String extraKey) {
        ExtraOptionModelDecorator decorated = new ExtraOptionModelDecorator();
        decorated.setExtraLabel(messages.getMessage(extraKey));
        decorated.setExtraOption(null);
        decorated.setModel(model);

        return decorated;
    }

    /**
     * Join a list of names objects into a string give a delimiter.
     *
     * Example: <code>
     *  <span jwcid="@Insert" value="ognl:tapestry.joinNamed(items, ', ')"/>
     * </code>
     */
    public String joinNamed(Collection namedItems, String delim) {
        Collection names = CollectionUtils.collect(namedItems, new NamedObject.ToName());
        return StringUtils.join(names.iterator(), delim);
    }

    /**
     * Example: <span jwcid="@Insert" value="someDate" format="tapestry.date(locale)"/>
     */
    public DateFormat date(Locale locale) {
        return TapestryUtils.getDateFormat(locale);
    }

    public IAsset[] getStylesheets(IComponent component) {
        String userAgent = component.getPage().getRequestCycle().getInfrastructure().getRequest()
                .getHeader("user-agent");
        return m_skinControl.getStylesheetAssets(userAgent);
    }

    public void setSkinControl(SkinControl skinControl) {
        m_skinControl = skinControl;
    }

    public SkinControl getSkinControl() {
        return m_skinControl;
    }

    public boolean isLicenseRequired() {
        return null != m_skinControl.getAsset(SkinControl.ASSET_LICENSE);
    }

    public void setRenderBaseTag(boolean renderBaseTag) {
        m_renderBaseTag = renderBaseTag;
    }

    public boolean isRenderBaseTag() {
        return m_renderBaseTag;
    }

    public void setAdminSessionTimeout(int adminSessionTimeout) {
        m_adminSessionTimeout = adminSessionTimeout;
    }

    public void setUserSessionTimeout(int userSessionTimeout) {
        m_userSessionTimeout = userSessionTimeout;
    }

    /**
     * Returns desired session timeout
     *
     * @param admin - true if it is an admin session
     * @return session timeout in seconds
     */
    public int getMaxInactiveInterval(boolean admin) {
        int minutes = admin ? m_adminSessionTimeout : m_userSessionTimeout;
        return minutes * SECONDS_PER_MINUTE;
    }

    public int getLicensesNumber() {
        int i = 0;
        String prefix = BLANK;
        while (m_skinControl.getAsset(prefix + SkinControl.ASSET_LICENSE) != null) {
            i++;
            prefix = i + UNDERSCORE;
        }
        return i;
    }

    /**
     * Retrieves text of the license usually provided by OEM plugin. Only works if
     * isLicenseRequired returns true. The licenseNumber parameter is used only
     * when we have more than one license to display. In this case the license key
     * asset will be like that: license.txt, 1_license.txt, 2_license.txt etc
     */
    public String getLicense(int licenseNumber) {
        String prefix = BLANK;
        if (licenseNumber > 0) {
            prefix = licenseNumber + UNDERSCORE;
        }
        IAsset asset = m_skinControl.getAsset(prefix + SkinControl.ASSET_LICENSE);
        if (asset == null) {
            return null;
        }
        InputStream licenseStream = asset.getResourceAsStream();
        try {
            return IOUtils.toString(licenseStream, "UTF-8");
        } catch (IOException e) {
            throw new UserException(e);
        } finally {
            IOUtils.closeQuietly(licenseStream);
        }
    }

    public String getLicense() {
        return getLicense(0);
    }
}