Site.java

/**
 * Copyright 2013 Tommi S.E. Laukkanen
 *
 * 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.
 */
package org.bubblecloud.ilves.site;

import com.vaadin.navigator.View;
import com.vaadin.navigator.ViewChangeListener;
import com.vaadin.navigator.ViewProvider;
import com.vaadin.server.FontAwesome;
import com.vaadin.server.Resource;
import com.vaadin.server.ThemeResource;
import com.vaadin.ui.Button;
import com.vaadin.ui.UI;
import com.vaadin.ui.Window;
import org.apache.log4j.Logger;
import org.bubblecloud.ilves.exception.SiteException;
import org.bubblecloud.ilves.model.Company;
import org.bubblecloud.ilves.util.PropertiesUtil;

import java.util.HashMap;
import java.util.Map;

/**
 * Vaadin portal implementation.
 * @author Tommi S.E. Laukkanen
 */
public final class Site implements ViewProvider, ViewChangeListener {
    /** The logger. */
    private static final Logger LOGGER = Logger.getLogger(Site.class);
    /** The site. */
    private final SiteDescriptor siteDescriptor;
    /** The portal mode of operation. */
    private final SiteMode siteMode;
    /** The portal view windows. */
    private final Map<String, Window> windows = new HashMap<String, Window>();
    /** The content provider. */
    private final ContentProvider contentProvider;
    /** The localization provider. */
    private final LocalizationProvider localizationProvider;
    /** The security provider. */
    private final SecurityProvider securityProvider;
    /** The site context. */
    private final SiteContext siteContext;
    /** The flows. */
    private final Map<String, View> views = new HashMap<String, View>();

    /**
     * Construct site with help of the providers.
     * @param siteMode the portal mode of operation
     * @param contentProvider the content provider
     * @param localizationProvider the localization provider
     * @param securityProvider the security provider
     * @param siteContext the site context
     */
    public Site(final SiteMode siteMode, final ContentProvider contentProvider,
                final LocalizationProvider localizationProvider,
            final SecurityProvider securityProvider, final SiteContext siteContext) {
        super();
        this.siteDescriptor = contentProvider.getSiteDescriptor();
        this.contentProvider = contentProvider;
        this.siteMode = siteMode;
        this.localizationProvider = localizationProvider;
        this.securityProvider = securityProvider;
        this.siteContext = siteContext;
    }

    /**
     * Method for accessing current site object.
     *
     * @return the current site
     */
    public static Site getCurrent() {
        return ((AbstractSiteUI) UI.getCurrent()).getSite();
    }

    /**
     * Initialize the site.
     */
    public void initialize() {
        /*for (final ViewDescriptor view : this.siteDescriptor.getViewDescriptors()) {
            constructView(view);
        }*/
    }

    /**
     * @return the localizationProvider
     */
    public LocalizationProvider getLocalizationProvider() {
        return localizationProvider;
    }

    /**
     * @return the siteContext
     */
    public SiteContext getSiteContext() {
        return siteContext;
    }

    /**
     * @return the securityProvider
     */
    public SecurityProvider getSecurityProvider() {
        return securityProvider;
    }

    /**
     * @return the mode
     */
    public SiteMode getSiteMode() {
        return siteMode;
    }

    /**
     * @return the site
     */
    public SiteDescriptor getSiteDescriptor() {
        return siteDescriptor;
    }

    /**
     * Gets localized value corresponding to given localization key.
     * @param key The localization key.
     * @return The localized value.
     */
    public String localize(final String key) {
        if (localizationProvider != null) {
            return localizationProvider.localize(key, UI.getCurrent().getLocale());
        } else {
            return null;
        }
    }

    /**
     * Gets getIcon corresponding to given localization key.
     * @param key The localization key.
     * @return The localized getIcon.
     */
    public Resource getIcon(final String key) {
        if (PropertiesUtil.hasProperty("icon", key)) {
            final String value = PropertiesUtil.getProperty("icon", key).trim();
            if (value.startsWith("FontAwesome.")) {
                final String iconName = value.substring(value.indexOf('.') + 1);
                for (final FontAwesome icon : FontAwesome.values()) {
                    if (icon.name().equals(iconName)) {
                        return icon;
                    }
                }
                throw new IllegalArgumentException("No such icon in FontAwesome: " + iconName);
            } else {
                return new ThemeResource("icons/" + value + ".png");
            }

        }
        return new ThemeResource("icons/" + key + ".png");
    }

    /**
     * Gets button.
     * @param key the button key
     * @return the key
     */
    public Button getButton(final String key) {
        final Button button = new Button(localize("button-" + key));
        button.setIcon(getIcon("button-icon-" + key));
        return button;
    }

    /**
     * Gets the current navigation version according to portal mode.
     * @return The navigation version in use.
     */
    public NavigationVersion getCurrentNavigationVersion() {
        if (siteMode == SiteMode.DEVELOPMENT) {
            return contentProvider.getDynamicSiteDescriptor().getNavigation().getDevelopmentVersion();
        }
        if (siteMode == SiteMode.TEST) {
            return contentProvider.getDynamicSiteDescriptor().getNavigation().getTestVersion();
        }
        if (siteMode == SiteMode.PRODUCTION) {
            return contentProvider.getDynamicSiteDescriptor().getNavigation().getProductionVersion();
        }
        throw new SiteException("Unable to deduce navigation version due to invalid portal mode: " + siteMode);
    }

    /**
     * Gets current view version for given view name.
     * @param viewName The name of the view.
     * @return The current view version.
     */
    public ViewVersion getCurrentViewVersion(final String viewName) {
        for (final ViewDescriptor view : contentProvider.getDynamicSiteDescriptor().getViewDescriptors()) {
            if (viewName.equals(view.getName())) {
                ViewVersion viewVersion = null;
                if (siteMode == SiteMode.DEVELOPMENT) {
                    viewVersion = view.getDevelopmentVersion();
                }
                if (siteMode == SiteMode.TEST) {
                    viewVersion = view.getTestVersion();
                }
                if (siteMode == SiteMode.PRODUCTION) {
                    viewVersion = view.getProductionVersion();
                }
                return viewVersion;
            }
        }
        return null;
    }

    /**
     * Constructs view to the portal.
     * @param viewDescriptor The view descriptor of the view to be added.
     */
    private void constructView(final ViewDescriptor viewDescriptor) {
        final long startTimeMillis = System.currentTimeMillis();
        views.remove(viewDescriptor.getName());

        ViewVersion viewVersion = null;
        if (siteMode == SiteMode.DEVELOPMENT) {
            viewVersion = viewDescriptor.getDevelopmentVersion();
        }
        if (siteMode == SiteMode.TEST) {
            viewVersion = viewDescriptor.getTestVersion();
        }
        if (siteMode == SiteMode.PRODUCTION) {
            viewVersion = viewDescriptor.getProductionVersion();
        }

        try {
            final Class<?> windowClass = Class.forName(viewVersion.getViewClass());
            final View view = (View) windowClass.newInstance();

            if (view instanceof SiteView) {
                ((SiteView) view).setViewDescriptor(viewDescriptor);
                ((SiteView) view).setViewVersion(viewVersion);
                ((SiteView) view).initialize();
            }

            views.put(viewDescriptor.getName(), view);

        } catch (final Exception e) {
            LOGGER.error("Error instantiating view window: " + viewDescriptor.getName(), e);
            throw new SiteException("Error instantiating view window: " + viewDescriptor.getName(), e);
        }
        LOGGER.debug("Constructing view: " + viewDescriptor.getName() + " took " + (System.currentTimeMillis()
        - startTimeMillis ) + " ms.");
    }

    @Override
    public String getViewName(final String viewAndParameters) {
        /*if (viewAndParameters.length() == 0) {
            return getCurrentNavigationVersion().getDefaultPageName();
        }*/
        if (viewAndParameters.contains("/")) {
            return viewAndParameters.split("/")[0];
        } else {
            return viewAndParameters;
        }
    }

    @Override
    public View getView(final String viewName_) {
        final String viewName;
        if (viewName_.length() == 0) {
            viewName = getCurrentNavigationVersion().getDefaultPageName();
        } else {
            viewName = viewName_;
        }
        if (!views.containsKey(viewName)) {
            for (final ViewDescriptor viewDescriptor : contentProvider.getDynamicSiteDescriptor().getViewDescriptors()) {
                if (viewDescriptor.getName().equals(viewName)) {
                    constructView(viewDescriptor);
                }
            }
        }
        if (!views.containsKey(viewName)) {
            final Company company = getSiteContext().getObject(Company.class);
            /*((AbstractSiteUI) UI.getCurrent()).navigateTo(
                    "denied",
                    localize("message-access-denied"), Notification.Type.WARNING_MESSAGE);
            */
            for (final ViewDescriptor viewDescriptor : contentProvider.getDynamicSiteDescriptor().getViewDescriptors()) {
                if ("denied".equals(viewDescriptor.getName())) {
                    constructView(viewDescriptor);
                }
            }

            return views.get("denied");
        }
        return views.get(viewName);
    }


    @Override
    public boolean beforeViewChange(final ViewChangeEvent event) {
        return true;
    }

    @Override
    public void afterViewChange(final ViewChangeEvent event) {
    }
}