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

/*
 * Copyright (C) 2020-2021 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 java.time.format.DateTimeFormatter;

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

import fr.devinsy.catgenerator.core.CatGenerator;
import fr.devinsy.statoolinfos.HtmlizerContext;
import fr.devinsy.statoolinfos.core.Federation;
import fr.devinsy.statoolinfos.core.Organization;
import fr.devinsy.statoolinfos.core.StatoolInfosException;
import fr.devinsy.statoolinfos.crawl.CrawlCache;
import fr.devinsy.statoolinfos.htmlize.FederationMetricMenuView.PeriodMenu;
import fr.devinsy.statoolinfos.htmlize.FederationMetricMenuView.ViewMenu;
import fr.devinsy.xidyn.XidynException;
import fr.devinsy.xidyn.data.TagDataManager;
import fr.devinsy.xidyn.presenters.PresenterUtils;

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

    /**
     * Builds the.
     *
     * @throws StatoolInfosException
     *             the statool infos exception
     * @throws IOException
     */
    public static void build() throws StatoolInfosException, IOException
    {
        Federation federation = HtmlizerContext.instance().getFederation();
        CrawlCache cache = HtmlizerContext.instance().getCache();
        File htmlizeDirectory = HtmlizerContext.instance().getHtmlizeDirectory();

        //
        logger.info("PAGE FEDERATION Htmlize federation logo.");
        htmlizeFederationLogo(federation, cache, htmlizeDirectory);

        //
        logger.info("PAGE FEDERATION Htmlize federation properties files.");
        FileUtils.copyFile(federation.getInputFile(), new File(htmlizeDirectory, federation.getTechnicalName() + ".properties"));

        logger.info("PAGE FEDERATION federation page: {}.", federation.getName());
        String page = htmlize(federation);
        FileUtils.write(new File(htmlizeDirectory, "index.xhtml"), page, StandardCharsets.UTF_8);

        //
        logger.info("Htmlize federation metric pages: {}.", federation.getName());
        for (ViewMenu view : ViewMenu.values())
        {
            for (PeriodMenu period : PeriodMenu.values())
            {
                if ((view != ViewMenu.YEARS) || (period == PeriodMenu.FULL))
                {
                    if (view != ViewMenu.DAYS)
                    {
                        FederationMetricSummaryPage.build(htmlizeDirectory, federation, view, period);
                        FederationMetricGenericPage.build(htmlizeDirectory, federation, view, period);
                        FederationMetricSpecificPage.build(htmlizeDirectory, federation, view, period);
                        FederationMetricWebPage.build(htmlizeDirectory, federation, view, period);
                    }
                }
            }
        }
    }

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

        try
        {
            logger.debug("Building federation page {}…", federation.getName());

            TagDataManager data = new TagDataManager();

            data.setContent("federationHeaderView", FederationHeaderView.htmlize(federation));

            data.setContent("organizationCount", federation.getOrganizations().size());
            data.setContent("serviceCount", federation.getServiceCount());

            int index = 0;
            for (Organization organization : federation.getOrganizations().sortByReverseServiceCount())
            {
                data.setAttribute("organizationListLine", index, "organizationListLineNameLink", "href", organization.getTechnicalName() + ".xhtml");
                data.setAttribute("organizationListLine", index, "organizationListLineLogo", "src", organization.getLogoFileName());
                data.setAttribute("organizationListLine", index, "organizationListLineLogo", "alt", organization.getName());
                data.setEscapedContent("organizationListLine", index, "organizationListLineNameValue", organization.getName());

                if (organization.getWebsiteURL() != null)
                {
                    data.setEscapedContent("organizationListLine", index, "organizationListLineUrlLink", organization.getWebsiteURL().toString());
                    data.setEscapedAttribute("organizationListLine", index, "organizationListLineUrlLink", "href", organization.getWebsiteURL().toString());
                }
                data.setContent("organizationListLine", index, "organizationListLineServiceCount", organization.getServiceCount());
                data.setContent("organizationListLine", index, "organizationListLineUserCount", organization.getPreviousMonthUserCount());
                data.setContent("organizationListLine", index, "organizationListLineVisitCount", organization.getPreviousMonthVisitCount());

                data.setContent("organizationListLine", index, "organizationListLineDate", organization.getCrawledDate().format(DateTimeFormatter.ofPattern("dd/MM/YYYY")));
                data.setAttribute("organizationListLine", index, "organizationListLineDate", "title", organization.getCrawledDate().format(DateTimeFormatter.ofPattern("HH:mm:ss")));

                index += 1;
            }

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

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

        //
        return result;
    }

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

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

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