statoolinfosweb/src/fr/devinsy/statoolinfos/htmlize/OrganizationPage.java

/*
 * Copyright (C) 2020 Christian Pierre MOMON <christian@momon.org>
 * 
 * This file is part of StatoolInfos, simple service statistics tool.
 * 
 * StatoolInfos is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * StatoolInfos is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with StatoolInfos.  If not, see <http://www.gnu.org/licenses/>.
 */
package fr.devinsy.statoolinfos.htmlize;

import java.io.File;
import java.io.IOException;
import java.nio.charset.StandardCharsets;

import org.apache.commons.io.FileUtils;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import fr.devinsy.catgenerator.core.CatGenerator;
import fr.devinsy.statoolinfos.HtmlizerContext;
import fr.devinsy.statoolinfos.core.Organization;
import fr.devinsy.statoolinfos.core.StatoolInfosException;
import fr.devinsy.statoolinfos.crawl.CrawlCache;
import fr.devinsy.xidyn.XidynException;
import fr.devinsy.xidyn.data.DisplayMode;
import fr.devinsy.xidyn.data.TagDataManager;
import fr.devinsy.xidyn.presenters.PresenterUtils;

/**
 * The Class OrganizationPage.
 */
public class OrganizationPage
{
    private static Logger logger = LoggerFactory.getLogger(OrganizationPage.class);

    /**
     * Builds the view.
     *
     * @param organization
     *            the organization
     * @throws IOException
     * @throws StatoolInfosException
     */
    public static void build(final Organization organization) throws IOException, StatoolInfosException
    {
        CrawlCache cache = HtmlizerContext.instance().getCache();
        File htmlizeDirectory = HtmlizerContext.instance().getHtmlizeDirectory();

        // Manage the logo file.
        logger.info("Htmlize organization logo: {}.", organization.getName());
        htmlizeOrganizationLogo(organization, cache, htmlizeDirectory);

        //
        logger.info("Htmlize organization properties file: {}.", organization.getName());
        FileUtils.copyFile(organization.getInputFile(), new File(htmlizeDirectory, organization.getTechnicalName() + ".properties"));

        //
        logger.info("Htmlize organization page: {}.", organization.getName());
        String page = OrganizationPage.htmlize(organization);
        FileUtils.write(new File(htmlizeDirectory, organization.getTechnicalName() + ".xhtml"), page, StandardCharsets.UTF_8);
    }

    /**
     * Builds the all.
     * 
     * @throws StatoolInfosException
     * @throws IOException
     */
    public static void buildAll() throws IOException, StatoolInfosException
    {
        for (Organization organization : HtmlizerContext.instance().getFederation().getOrganizations())
        {
            build(organization);
        }
    }

    /**
     * Builds the.
     *
     * @param organization
     *            the organization
     * @return the string
     * @throws StatoolInfosException
     *             the statool infos exception
     */
    public static String htmlize(final Organization organization) throws StatoolInfosException
    {
        String result;

        try
        {
            logger.debug("Building organization page {}…", organization.get("organization.name"));

            TagDataManager data = new TagDataManager();

            data.setAttribute("organizationRawButton", "href", organization.getTechnicalName() + ".properties");

            data.setAttribute("organizationLogo", "src", organization.getLogoFileName());
            data.setEscapedContent("organizationName", organization.get("organization.name"));

            data.setEscapedContent("organizationURL", organization.getWebsite());
            data.setEscapedAttribute("organizationURL", "href", organization.getWebsite());

            data.setEscapedContent("organizationDescription", organization.get("organization.description"));
            data.setContent("organizationStartDate", StringUtils.defaultIfBlank(organization.getStartDate(), "n/a"));
            data.setContent("organizationEndDate", StringUtils.defaultIfBlank(organization.getEndDate(), "n/a"));
            data.setContent("serviceCount", organization.getServices().size());

            data.setAttribute("rawLink", "href", organization.getTechnicalName() + ".properties");
            data.setAttribute("rawCheckLink", "href", organization.getTechnicalName() + "-check.xhtml");

            data.setAttribute("statsLink", "href", organization.getTechnicalName() + "-stats.xhtml");

            if (StringUtils.isNotBlank(organization.getLegalWebsite()))
            {
                data.setEscapedAttribute("legalLink", "href", organization.getLegalWebsite());
                data.setAttribute("legalLinkImg", "class", "");
                data.getIdData("legalLinkImg").getAttribute("class").setMode(DisplayMode.REPLACE);
            }
            if (StringUtils.isNotBlank(organization.getContactWebsite()))
            {
                data.setEscapedAttribute("contactLink", "href", organization.getContactWebsite());
                data.setAttribute("contactLinkImg", "class", "");
                data.getIdData("contactLinkImg").getAttribute("class").setMode(DisplayMode.REPLACE);
            }
            if (StringUtils.isNotBlank(organization.getContactEmail()))
            {
                data.setEscapedAttribute("emailLink", "href", "mailto:" + organization.getContactEmail());
                data.setAttribute("emailLinkImg", "class", "");
                data.getIdData("emailLinkImg").getAttribute("class").setMode(DisplayMode.REPLACE);
            }
            if (StringUtils.isNotBlank(organization.getUserGuideWebsite()))
            {
                data.setEscapedAttribute("userDocLink", "href", organization.getUserGuideWebsite());
                data.setAttribute("userDocLinkImg", "class", "");
                data.getIdData("userDocLinkImg").getAttribute("class").setMode(DisplayMode.REPLACE);
            }
            if (StringUtils.isNotBlank(organization.getTechnicalGuideWebsite()))
            {
                data.setEscapedAttribute("technicalDocLink", "href", organization.getTechnicalGuideWebsite());
                data.setAttribute("technicalDocLinkImg", "class", "");
                data.getIdData("technicalDocLinkImg").getAttribute("class").setMode(DisplayMode.REPLACE);
            }

            data.setContent("serviceListView", ServiceListView.build(organization.getServices().sortByName()));

            String content = PresenterUtils.dynamize("/fr/devinsy/statoolinfos/htmlize/organization.xhtml", data).toString();

            BreadcrumbTrail trail = new BreadcrumbTrail();
            trail.add(organization.getName(), organization.getTechnicalName() + ".xhtml");
            result = WebCharterView.build(content, trail);
        }
        catch (XidynException exception)
        {
            throw new StatoolInfosException("Error building organization page: " + exception.getMessage(), exception);
        }

        //
        return result;
    }

    /**
     * Htmlize organization logo.
     *
     * @param organization
     *            the organization
     * @param cache
     *            the cache
     * @param htmlizeDirectory
     *            the htmlize directory
     * @throws IOException
     *             Signals that an I/O exception has occurred.
     */
    private static void htmlizeOrganizationLogo(final Organization organization, final CrawlCache cache, final File htmlizeDirectory) throws IOException
    {
        logger.info("Htmlize organization logo.");

        File target = new File(htmlizeDirectory, organization.getLogoFileName());

        File logoFile = cache.restoreFile(organization.getLogoURL());
        if (logoFile == null)
        {
            logger.info("CatGeneratoring cat avatar: {}", target.getAbsoluteFile());
            CatGenerator.buildAvatarTo(organization.getTechnicalName(), target);
        }
        else
        {
            FileUtils.copyFile(logoFile, target);
        }
    }
}