com.helger.photon.app.resource.WebSiteResourceBundleSerialized Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-oton-app Show documentation
Show all versions of ph-oton-app Show documentation
ph-oton basic application stuff
The newest version!
/*
* Copyright (C) 2014-2024 Philip Helger (www.helger.com)
* philip[at]helger[dot]com
*
* 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 com.helger.photon.app.resource;
import java.io.InputStream;
import java.io.Writer;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.time.LocalDateTime;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.Nonempty;
import com.helger.commons.datetime.PDTFactory;
import com.helger.commons.io.EAppend;
import com.helger.commons.io.IHasInputStream;
import com.helger.commons.io.resource.FileSystemResource;
import com.helger.commons.io.stream.StreamHelper;
import com.helger.commons.mime.IMimeType;
import com.helger.commons.string.StringHelper;
import com.helger.commons.string.ToStringGenerator;
import com.helger.commons.url.ISimpleURL;
import com.helger.html.hc.IHCNode;
import com.helger.photon.app.PhotonAppSettings;
import com.helger.photon.app.url.LinkHelper;
import com.helger.photon.io.WebFileIO;
import com.helger.web.scope.IRequestWebScopeWithoutResponse;
/**
* This class combines a {@link WebSiteResourceBundle} with an internal ID and a
* creation date time. It is so to say the serialized version of a
* {@link WebSiteResourceBundle}.
*
* @author Philip Helger
*/
public class WebSiteResourceBundleSerialized implements IHasInputStream
{
public static final String RESOURCE_BUNDLE_PATH = "resource-bundles/";
public static final Charset CHARSET_TO_USE = StandardCharsets.UTF_8;
private static final Logger LOGGER = LoggerFactory.getLogger (WebSiteResourceBundleSerialized.class);
private final String m_sBundleID;
private final WebSiteResourceBundle m_aBundle;
private final LocalDateTime m_aCreationDT;
public WebSiteResourceBundleSerialized (@Nonnull @Nonempty final String sBundleID,
@Nonnull final WebSiteResourceBundle aBundle,
final boolean bRegular)
{
this (sBundleID, aBundle, PDTFactory.getCurrentLocalDateTime ());
// Always serialize new bundles
_ensureSerialized (bRegular);
}
/**
* Constructor for de-serialization only.
*
* @param sBundleID
* Bundle ID
* @param aBundle
* Bundle data
* @param aCreationDT
* Bundle creation data
*/
WebSiteResourceBundleSerialized (@Nonnull @Nonempty final String sBundleID,
@Nonnull final WebSiteResourceBundle aBundle,
@Nonnull final LocalDateTime aCreationDT)
{
m_sBundleID = ValueEnforcer.notEmpty (sBundleID, "BundleID");
m_aBundle = ValueEnforcer.notNull (aBundle, "Bundle");
m_aCreationDT = ValueEnforcer.notNull (aCreationDT, "CreationDT");
}
private void _ensureSerialized (final boolean bRegular)
{
final FileSystemResource aTargetRes = getResource (m_sBundleID);
if (!aTargetRes.exists ())
{
// persist file by merging all items
try (final Writer aWriter = StreamHelper.getBuffered (aTargetRes.getWriter (StandardCharsets.UTF_8,
EAppend.TRUNCATE)))
{
if (aWriter == null)
{
// May happen if write access is denied for the file
LOGGER.error ("Failed to serialize " +
m_aBundle.getResourceType ().getID () +
" bundle '" +
m_sBundleID +
"' with " +
m_aBundle.getAllResourcePaths () +
(m_aBundle.hasConditionalComment () ? " and conditional comment '" +
m_aBundle.getConditionalComment () +
"'" : "") +
" to path " +
aTargetRes.getAsFile ().getAbsolutePath ());
}
else
{
// Write all used files into the result file (at least for now)
for (final WebSiteResource aRes : m_aBundle.getAllResources ())
{
// This type of comment works for CSS and JS!
// Update don't display the resource as URL because that might
// reveal internal paths
final String sMetaInfo = "/* " +
aRes.getPath () +
(true ? "" : " - " + aRes.getResource ().getAsURL ()) +
" - " +
aRes.getContentHashAsString () +
" */\n";
aWriter.write (sMetaInfo);
}
// Write all resources themselves
for (final WebSiteResource aRes : m_aBundle.getAllResources ())
{
final String sContent = aRes.getContent (bRegular);
if (sContent != null)
{
aWriter.write (sContent);
if (StringHelper.getLastChar (sContent) != '\n')
{
// For the sake of clarity if a script does not end with a "\n"
// Add this in minified mode as well, because if the last line
// of the previous
// script started with "//" and the next file starts with a
// multi line comment,
// we would run in a syntax error!
// As in:
/**
*
* // last line of previous file/*
* * Multi line comment in next file
* ... etc
*
*/
aWriter.write ('\n');
}
}
else
{
LOGGER.error ("Web site resource '" +
aRes.getPath () +
"' at '" +
aRes.getAsURLString () +
"' has no content/does not exist!");
}
}
LOGGER.info ("Serialized " +
m_aBundle.getResourceType ().getID () +
" bundle '" +
m_sBundleID +
"' with " +
m_aBundle.getAllResourcePaths () +
(m_aBundle.hasConditionalComment () ? " and conditional comment '" +
m_aBundle.getConditionalComment () +
"'" : ""));
}
}
catch (final Exception ex)
{
LOGGER.error ("Error serializing bundle '" + m_sBundleID + "' with " + m_aBundle.getAllResourcePaths (), ex);
throw new IllegalStateException (ex);
}
}
}
@Nonnull
@Nonempty
public String getBundleID ()
{
return m_sBundleID;
}
@Nonnull
public WebSiteResourceBundle getBundle ()
{
return m_aBundle;
}
@Nullable
public static FileSystemResource getResource (@Nonnull @Nonempty final String sBundleID)
{
ValueEnforcer.notEmpty (sBundleID, "BundleID");
return WebFileIO.getDataIO ().getResource (RESOURCE_BUNDLE_PATH + sBundleID);
}
@Nullable
public InputStream getInputStream ()
{
return getResource (m_sBundleID).getInputStream ();
}
public boolean isReadMultiple ()
{
return true;
}
@Nonnull
public IMimeType getMimeType ()
{
return m_aBundle.getMimeType ();
}
@Nonnull
public LocalDateTime getCreationDT ()
{
return m_aCreationDT;
}
@Nonnull
public IHCNode createNode (@Nonnull final IRequestWebScopeWithoutResponse aRequestScope)
{
ISimpleURL aURL = null;
if (m_aBundle.getResourceCount () == 1 && !m_aBundle.isBundlable ())
{
// Special handling for resource bundles with a single item - use the
// original path (e.g. for TinyMCE because it cannot be bundled)
final WebSiteResource aResource = m_aBundle.getResourceAtIndex (0);
aURL = aResource.getAsURL (aRequestScope);
}
if (aURL == null)
{
// Use the ResourceBundleServlet path by default
aURL = LinkHelper.getURLWithContext (aRequestScope,
PhotonAppSettings.getResourceBundleServletName () +
"/" +
m_sBundleID +
m_aBundle.getResourceType ().getFileExtension ());
}
// Create the main node
final IHCNode aNode = m_aBundle.getResourceType ().createNode (aURL, m_aBundle.getMediaList ());
// Wrap in conditional comment (if any)
return m_aBundle.getWrapped (aNode);
}
@Override
public String toString ()
{
return new ToStringGenerator (this).append ("BundleID", m_sBundleID)
.append ("Bundle", m_aBundle)
.append ("CreationDT", m_aCreationDT)
.getToString ();
}
}