2020-09-17 02:03:56 +02:00
|
|
|
/*
|
|
|
|
* 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;
|
|
|
|
|
2020-10-28 15:32:05 +01:00
|
|
|
import java.io.File;
|
|
|
|
import java.io.IOException;
|
|
|
|
import java.nio.charset.StandardCharsets;
|
|
|
|
|
|
|
|
import org.apache.commons.io.FileUtils;
|
2020-10-03 06:30:47 +02:00
|
|
|
import org.apache.commons.lang3.StringUtils;
|
2020-09-17 02:03:56 +02:00
|
|
|
import org.slf4j.Logger;
|
|
|
|
import org.slf4j.LoggerFactory;
|
|
|
|
|
2020-10-28 15:32:05 +01:00
|
|
|
import fr.devinsy.catgenerator.core.BirdGenerator;
|
|
|
|
import fr.devinsy.statoolinfos.HtmlizerContext;
|
2020-10-07 04:33:30 +02:00
|
|
|
import fr.devinsy.statoolinfos.core.Metric;
|
2020-09-19 03:36:41 +02:00
|
|
|
import fr.devinsy.statoolinfos.core.Organization;
|
2020-09-17 02:03:56 +02:00
|
|
|
import fr.devinsy.statoolinfos.core.Service;
|
|
|
|
import fr.devinsy.statoolinfos.core.StatoolInfosException;
|
2020-10-28 15:32:05 +01:00
|
|
|
import fr.devinsy.statoolinfos.crawl.CrawlCache;
|
2020-10-07 04:33:30 +02:00
|
|
|
import fr.devinsy.statoolinfos.htmlize.charts.BarMonthsChartView;
|
2020-11-17 05:44:31 +01:00
|
|
|
import fr.devinsy.statoolinfos.htmlize.charts.ChartColor;
|
2020-09-17 02:03:56 +02:00
|
|
|
import fr.devinsy.xidyn.XidynException;
|
2020-10-02 19:43:37 +02:00
|
|
|
import fr.devinsy.xidyn.data.DisplayMode;
|
2020-09-17 02:03:56 +02:00
|
|
|
import fr.devinsy.xidyn.data.TagDataManager;
|
|
|
|
import fr.devinsy.xidyn.presenters.PresenterUtils;
|
|
|
|
|
|
|
|
/**
|
2020-10-28 15:32:05 +01:00
|
|
|
* The Class ServicePage.
|
2020-09-17 02:03:56 +02:00
|
|
|
*/
|
|
|
|
public class ServicePage
|
|
|
|
{
|
|
|
|
private static Logger logger = LoggerFactory.getLogger(ServicePage.class);
|
|
|
|
|
2020-10-28 15:32:05 +01:00
|
|
|
/**
|
|
|
|
* Builds the view.
|
|
|
|
*
|
|
|
|
* @throws IOException
|
|
|
|
* @throws StatoolInfosException
|
|
|
|
*/
|
|
|
|
public static void build(final Service service) throws IOException, StatoolInfosException
|
|
|
|
{
|
|
|
|
CrawlCache cache = HtmlizerContext.instance().getCache();
|
|
|
|
File htmlizeDirectory = HtmlizerContext.instance().getHtmlizeDirectory();
|
|
|
|
|
|
|
|
// Manage the logo file.
|
|
|
|
logger.info("Htmlize service logo: {}.", service.getName());
|
|
|
|
htmlizeServiceLogo(service, cache, htmlizeDirectory);
|
|
|
|
|
|
|
|
//
|
|
|
|
logger.info("Htmlize service properties file: {}.", service.getName());
|
|
|
|
FileUtils.copyFile(service.getInputFile(),
|
|
|
|
new File(htmlizeDirectory, service.getOrganization().getTechnicalName() + "-" + service.getTechnicalName() + ".properties"));
|
|
|
|
|
|
|
|
//
|
|
|
|
logger.info("Htmlize service page: {}.", service.getName());
|
|
|
|
String page = ServicePage.htmlize(service.getOrganization(), service);
|
|
|
|
FileUtils.write(new File(htmlizeDirectory, service.getOrganization().getTechnicalName() + "-" + service.getTechnicalName() + ".xhtml"), page, StandardCharsets.UTF_8);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Builds the all.
|
|
|
|
*
|
|
|
|
* @throws IOException
|
|
|
|
* Signals that an I/O exception has occurred.
|
|
|
|
* @throws StatoolInfosException
|
|
|
|
* the statool infos exception
|
|
|
|
*/
|
|
|
|
public static void buildAll() throws IOException, StatoolInfosException
|
|
|
|
{
|
|
|
|
for (Service service : HtmlizerContext.instance().getFederation().getAllServices())
|
|
|
|
{
|
|
|
|
build(service);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-09-17 02:03:56 +02:00
|
|
|
/**
|
|
|
|
* Builds the.
|
|
|
|
*
|
|
|
|
* @param service
|
|
|
|
* the service
|
|
|
|
* @return the string
|
|
|
|
* @throws StatoolInfosException
|
|
|
|
* the statool infos exception
|
|
|
|
*/
|
2020-10-28 15:32:05 +01:00
|
|
|
public static String htmlize(final Organization organization, final Service service) throws StatoolInfosException
|
2020-09-17 02:03:56 +02:00
|
|
|
{
|
|
|
|
String result;
|
|
|
|
|
|
|
|
try
|
|
|
|
{
|
|
|
|
logger.debug("Building organization page {}…", service.get("organization.name"));
|
|
|
|
|
|
|
|
TagDataManager data = new TagDataManager();
|
|
|
|
|
2020-10-23 04:41:04 +02:00
|
|
|
data.setAttribute("serviceLogo", "src", service.getLogoFileName());
|
2020-10-03 06:30:47 +02:00
|
|
|
|
2020-09-17 02:03:56 +02:00
|
|
|
data.setEscapedContent("serviceName", service.getName());
|
2020-11-20 07:07:59 +01:00
|
|
|
data.setEscapedAttribute("serviceName", "href", service.getWebsite());
|
2020-10-03 06:30:47 +02:00
|
|
|
|
|
|
|
data.setEscapedContent("serviceURL", service.getWebsite());
|
2020-11-20 07:07:59 +01:00
|
|
|
data.setEscapedAttribute("serviceURL", "href", service.getWebsite());
|
2020-10-03 06:30:47 +02:00
|
|
|
|
2020-11-26 06:46:57 +01:00
|
|
|
data.setEscapedContent("serviceDescription", StringUtils.defaultIfBlank(service.getDescription(), "n/a"));
|
2020-10-04 00:18:38 +02:00
|
|
|
data.setContent("serviceStartDate", StringUtils.defaultIfBlank(service.getStartDate(), "n/a"));
|
|
|
|
data.setContent("serviceEndDate", StringUtils.defaultIfBlank(service.getEndDate(), "n/a"));
|
|
|
|
|
|
|
|
data.setAttribute("serviceStatusImg", "src", "status-" + service.getStatus().toString().toLowerCase() + ".png");
|
|
|
|
data.setAttribute("serviceStatusImg", "title", StringUtils.defaultIfBlank(service.getStatusDescription(), service.getStatus().toString()));
|
2020-09-17 02:03:56 +02:00
|
|
|
|
2020-10-03 06:30:47 +02:00
|
|
|
data.setAttribute("rawLink", "href", organization.getTechnicalName() + "-" + service.getTechnicalName() + ".properties");
|
2020-10-17 17:57:10 +02:00
|
|
|
data.setAttribute("rawCheckLink", "href", organization.getTechnicalName() + "-" + service.getTechnicalName() + "-check.xhtml");
|
2020-10-03 06:30:47 +02:00
|
|
|
|
2020-11-21 07:35:59 +01:00
|
|
|
data.setAttribute("statsLink", "href", organization.getTechnicalName() + "-" + service.getTechnicalName() + ".xhtml");
|
|
|
|
|
2020-10-03 06:30:47 +02:00
|
|
|
if (StringUtils.isNotBlank(service.getLegalWebsite()))
|
|
|
|
{
|
2020-11-20 07:07:59 +01:00
|
|
|
data.setEscapedAttribute("legalLink", "href", service.getLegalWebsite());
|
2020-10-03 06:30:47 +02:00
|
|
|
data.setAttribute("legalLinkImg", "class", "");
|
|
|
|
data.getIdData("legalLinkImg").getAttribute("class").setMode(DisplayMode.REPLACE);
|
|
|
|
}
|
|
|
|
if (StringUtils.isNotBlank(service.getContactWebsite()))
|
|
|
|
{
|
2020-11-20 07:07:59 +01:00
|
|
|
data.setEscapedAttribute("contactLink", "href", service.getContactWebsite());
|
2020-10-03 06:30:47 +02:00
|
|
|
data.setAttribute("contactLinkImg", "class", "");
|
|
|
|
data.getIdData("contactLinkImg").getAttribute("class").setMode(DisplayMode.REPLACE);
|
|
|
|
}
|
|
|
|
if (StringUtils.isNotBlank(service.getContactEmail()))
|
|
|
|
{
|
2020-11-20 07:07:59 +01:00
|
|
|
data.setEscapedAttribute("emailLink", "href", "mailto:" + service.getContactEmail());
|
2020-10-03 06:30:47 +02:00
|
|
|
data.setAttribute("emailLinkImg", "class", "");
|
|
|
|
data.getIdData("emailLinkImg").getAttribute("class").setMode(DisplayMode.REPLACE);
|
|
|
|
}
|
|
|
|
if (StringUtils.isNotBlank(service.getUserDocWebsite()))
|
|
|
|
{
|
2020-11-20 07:07:59 +01:00
|
|
|
data.setEscapedAttribute("userDocLink", "href", service.getUserDocWebsite());
|
2020-10-03 06:30:47 +02:00
|
|
|
data.setAttribute("userDocLinkImg", "class", "");
|
|
|
|
data.getIdData("userDocLinkImg").getAttribute("class").setMode(DisplayMode.REPLACE);
|
|
|
|
}
|
|
|
|
if (StringUtils.isNotBlank(service.getTechnicalDocWebsite()))
|
|
|
|
{
|
2020-11-20 07:07:59 +01:00
|
|
|
data.setEscapedAttribute("technicalDocLink", "href", service.getTechnicalDocWebsite());
|
2020-10-03 06:30:47 +02:00
|
|
|
data.setAttribute("technicalDocLinkImg", "class", "");
|
|
|
|
data.getIdData("technicalDocLinkImg").getAttribute("class").setMode(DisplayMode.REPLACE);
|
|
|
|
}
|
|
|
|
|
|
|
|
//
|
2020-10-02 19:43:37 +02:00
|
|
|
if (service.isRegistrationNone())
|
|
|
|
{
|
2020-10-03 06:30:47 +02:00
|
|
|
data.setAttribute("registrationNoneImg", "class", "");
|
2020-10-02 19:43:37 +02:00
|
|
|
data.getIdData("registrationNoneImg").getAttribute("class").setMode(DisplayMode.REPLACE);
|
|
|
|
}
|
|
|
|
if (service.isRegistrationFree())
|
|
|
|
{
|
|
|
|
data.setAttribute("registrationFreeImg", "class", "");
|
|
|
|
data.getIdData("registrationFreeImg").getAttribute("class").setMode(DisplayMode.REPLACE);
|
|
|
|
}
|
|
|
|
if (service.isRegistrationMember())
|
|
|
|
{
|
|
|
|
data.setAttribute("registrationMemberImg", "class", "");
|
|
|
|
data.getIdData("registrationMemberImg").getAttribute("class").setMode(DisplayMode.REPLACE);
|
|
|
|
}
|
|
|
|
if (service.isRegistrationClient())
|
|
|
|
{
|
|
|
|
data.setAttribute("registrationClientImg", "class", "");
|
|
|
|
data.getIdData("registrationClientImg").getAttribute("class").setMode(DisplayMode.REPLACE);
|
|
|
|
}
|
|
|
|
|
2020-10-04 00:18:38 +02:00
|
|
|
//
|
2020-11-26 06:46:57 +01:00
|
|
|
data.setEscapedContent("softwareName", StringUtils.defaultIfBlank(service.getSoftwareName(), "n/a"));
|
2020-10-04 00:18:38 +02:00
|
|
|
data.setContent("softwareVersion", StringUtils.defaultIfBlank(service.getSoftwareVersion(), "n/a"));
|
2020-11-26 06:46:57 +01:00
|
|
|
data.setEscapedContent("softwareLicenseName", StringUtils.defaultIfBlank(service.getSoftwareLicenseName(), "n/a"));
|
2020-10-04 00:18:38 +02:00
|
|
|
if (StringUtils.isNotBlank(service.getSoftwareWebsite()))
|
|
|
|
{
|
2020-11-20 07:07:59 +01:00
|
|
|
data.setEscapedAttribute("softwareWebsiteLink", "href", service.getSoftwareWebsite());
|
2020-10-04 00:18:38 +02:00
|
|
|
data.setAttribute("softwareWebsiteLinkImg", "class", "");
|
|
|
|
data.getIdData("softwareWebsiteLinkImg").getAttribute("class").setMode(DisplayMode.REPLACE);
|
|
|
|
}
|
|
|
|
if (StringUtils.isNotBlank(service.getSoftwareLicenseWebpage()))
|
|
|
|
{
|
2020-11-20 07:07:59 +01:00
|
|
|
data.setEscapedAttribute("softwareLicenseLink", "href", service.getSoftwareLicenseWebpage());
|
2020-10-04 00:18:38 +02:00
|
|
|
data.setAttribute("softwareLicenseLinkImg", "class", "");
|
|
|
|
data.getIdData("softwareLicenseLinkImg").getAttribute("class").setMode(DisplayMode.REPLACE);
|
|
|
|
}
|
|
|
|
if (StringUtils.isNotBlank(service.getSoftwareSourceWebsite()))
|
|
|
|
{
|
2020-11-20 07:07:59 +01:00
|
|
|
data.setEscapedAttribute("softwareSourceLink", "href", service.getSoftwareSourceWebsite());
|
2020-10-04 00:18:38 +02:00
|
|
|
data.setAttribute("softwareSourceLinkImg", "class", "");
|
|
|
|
data.getIdData("softwareSourceLinkImg").getAttribute("class").setMode(DisplayMode.REPLACE);
|
|
|
|
}
|
|
|
|
|
2020-10-07 04:33:30 +02:00
|
|
|
//
|
|
|
|
int graphicIndex = 0;
|
|
|
|
// data.setContent("fooChart", graphicIndex++,
|
|
|
|
// LineMonthsChartView.build());
|
|
|
|
|
|
|
|
service.getPrefixes();
|
|
|
|
|
|
|
|
Metric metric = service.getMetric("metrics.http.hits");
|
|
|
|
if ((metric != null) && (!metric.isEmpty()))
|
|
|
|
{
|
|
|
|
data.setContent("fooChart", graphicIndex++, BarMonthsChartView.build(metric));
|
|
|
|
}
|
|
|
|
|
|
|
|
metric = service.getMetric("metrics.http.errors");
|
|
|
|
if ((metric != null) && (!metric.isEmpty()))
|
|
|
|
{
|
2020-11-17 05:44:31 +01:00
|
|
|
data.setContent("fooChart", graphicIndex++, BarMonthsChartView.build(metric, ChartColor.RED));
|
2020-10-07 04:33:30 +02:00
|
|
|
}
|
|
|
|
|
2020-10-04 00:18:38 +02:00
|
|
|
//
|
2020-09-21 03:41:46 +02:00
|
|
|
String content = PresenterUtils.dynamize("/fr/devinsy/statoolinfos/htmlize/service.xhtml", data).toString();
|
2020-09-17 02:03:56 +02:00
|
|
|
|
2020-09-24 02:45:31 +02:00
|
|
|
BreadcrumbTrail trail = new BreadcrumbTrail();
|
|
|
|
trail.add(service.getOrganization().getName(), service.getOrganization().getTechnicalName() + ".xhtml");
|
|
|
|
trail.add(service.getName(), service.getOrganization().getTechnicalName() + "-" + service.getTechnicalName() + ".xhtml");
|
|
|
|
result = WebCharterView.build(content, trail);
|
2020-09-17 02:03:56 +02:00
|
|
|
}
|
|
|
|
catch (XidynException exception)
|
|
|
|
{
|
|
|
|
throw new StatoolInfosException("Error building service page: " + exception.getMessage(), exception);
|
|
|
|
}
|
|
|
|
|
|
|
|
//
|
|
|
|
return result;
|
|
|
|
}
|
2020-10-28 15:32:05 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @param service
|
|
|
|
* @param cache
|
|
|
|
* @param htmlizeDirectory
|
|
|
|
* @throws IOException
|
|
|
|
*/
|
|
|
|
private static void htmlizeServiceLogo(final Service service, final CrawlCache cache, final File htmlizeDirectory) throws IOException
|
|
|
|
{
|
|
|
|
logger.info("Htmlize organization logo.");
|
|
|
|
|
|
|
|
File target = new File(htmlizeDirectory, service.getLogoFileName());
|
|
|
|
|
|
|
|
File logoFile = cache.restoreFile(service.getLogoURL());
|
|
|
|
if (logoFile == null)
|
|
|
|
{
|
|
|
|
logger.info("BirdGeneratoring cat avatar: {}", target.getAbsoluteFile());
|
|
|
|
BirdGenerator.buildAvatarTo(service.getTechnicalName(), target);
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
FileUtils.copyFile(logoFile, target);
|
|
|
|
}
|
|
|
|
}
|
2020-09-17 02:03:56 +02:00
|
|
|
}
|