com.helger.photon.app.html.PhotonMetaElements 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
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.html;

import java.util.Collection;
import java.util.Map;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.ThreadSafe;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.collection.impl.CommonsArrayList;
import com.helger.commons.collection.impl.CommonsLinkedHashMap;
import com.helger.commons.collection.impl.ICommonsList;
import com.helger.commons.collection.impl.ICommonsOrderedMap;
import com.helger.commons.concurrent.SimpleLock;
import com.helger.commons.io.resource.IReadableResource;
import com.helger.html.meta.IMetaElement;
import com.helger.html.meta.MetaElement;
import com.helger.html.meta.MetaElementList;
import com.helger.web.scope.IRequestWebScopeWithoutResponse;
import com.helger.web.scope.mgr.WebScopeManager;
import com.helger.xml.microdom.util.XMLMapHandler;

/**
 * This class keeps track of all the meta elements that must be included
 * globally or for a single request.
 *
 * @author Philip Helger
 */
@ThreadSafe
public final class PhotonMetaElements
{
  public static final String DEFAULT_FILENAME = "html/metatags.xml";

  private static final String REQUEST_ATTR_METAELEMENTS = PhotonMetaElements.class.getName ();
  private static final Logger LOGGER = LoggerFactory.getLogger (PhotonMetaElements.class);
  private static final MetaElementList GLOBAL = new MetaElementList ();
  private static final SimpleLock LOCK = new SimpleLock ();

  private PhotonMetaElements ()
  {}

  public static void _readMetaElements (@Nonnull final IReadableResource aRes, @Nonnull final MetaElementList aTarget)
  {
    ValueEnforcer.notNull (aRes, "Res");
    ValueEnforcer.notNull (aTarget, "Target");

    if (aRes.exists ())
    {
      final ICommonsOrderedMap  aMetaElements = new CommonsLinkedHashMap <> ();
      if (XMLMapHandler.readMap (aRes, aMetaElements).isFailure ())
        LOGGER.error ("Failed to read meta element file " + aRes.getPath ());

      for (final Map.Entry  aEntry : aMetaElements.entrySet ())
        aTarget.addMetaElement (MetaElement.createMeta (aEntry.getKey (), aEntry.getValue ()));
    }
  }

  public static void readMetaElementsForGlobal (@Nonnull final IReadableResource aRes)
  {
    _readMetaElements (aRes, GLOBAL);
  }

  /**
   * Register a new meta element for global scope.
   *
   * @param aMetaElement
   *        The meta element to use. May not be null.
   */
  public static void registerMetaElementForGlobal (@Nonnull final IMetaElement aMetaElement)
  {
    GLOBAL.addMetaElement (aMetaElement);
  }

  /**
   * Unregister an existing meta element for global scope.
   *
   * @param sMetaElementName
   *        The meta element name to be removed. May not be null.
   */
  public static void unregisterMetaElementForGlobal (@Nullable final String sMetaElementName)
  {
    GLOBAL.removeMetaElement (sMetaElementName);
  }

  /**
   * Unregister all existing meta elements from global scope.
   */
  public static void unregisterAllMetaElementsFromGlobal ()
  {
    GLOBAL.removeAllMetaElements ();
  }

  /**
   * @return A non-null set with all meta elements to be included
   *         globally.
   */
  @Nonnull
  @ReturnsMutableCopy
  public static ICommonsList  getAllRegisteredMetaElementsForGlobal ()
  {
    return GLOBAL.getAllMetaElements ();
  }

  public static void getAllRegisteredMetaElementsForGlobal (@Nonnull final Collection  aTarget)
  {
    GLOBAL.getAllMetaElements (aTarget);
  }

  /**
   * @return true if at least a single meta element has been
   *         registered globally.
   */
  public static boolean hasRegisteredMetaElementsForGlobal ()
  {
    return GLOBAL.hasMetaElements ();
  }

  @Nullable
  private static MetaElementList _getPerRequestSet (final boolean bCreateIfNotExisting)
  {
    final IRequestWebScopeWithoutResponse aRequestScope = WebScopeManager.getRequestScope ();

    return LOCK.lockedGet ( () -> {
      MetaElementList ret = aRequestScope.attrs ().getCastedValue (REQUEST_ATTR_METAELEMENTS);
      if (ret == null && bCreateIfNotExisting)
      {
        ret = new MetaElementList ();
        aRequestScope.attrs ().putIn (REQUEST_ATTR_METAELEMENTS, ret);
      }
      return ret;
    });
  }

  /**
   * Register a new meta element only for this request
   *
   * @param aMetaElement
   *        The meta element to use. May not be null.
   */
  public static void registerMetaElementForThisRequest (@Nonnull final IMetaElement aMetaElement)
  {
    _getPerRequestSet (true).addMetaElement (aMetaElement);
  }

  /**
   * Unregister an existing meta element only from this request
   *
   * @param sMetaElementName
   *        The name of the meta element to be removed. May not be
   *        null.
   */
  public static void unregisterMetaElementFromThisRequest (@Nullable final String sMetaElementName)
  {
    final MetaElementList aSet = _getPerRequestSet (false);
    if (aSet != null)
      aSet.removeMetaElement (sMetaElementName);
  }

  /**
   * Unregister all existing meta elements from this request
   */
  public static void unregisterAllMetaElementsFromThisRequest ()
  {
    final MetaElementList aSet = _getPerRequestSet (false);
    if (aSet != null)
      aSet.removeAllMetaElements ();
  }

  /**
   * @return A non-null set with all meta elements to be included
   *         in this request.
   */
  @Nonnull
  @ReturnsMutableCopy
  public static ICommonsList  getAllRegisteredMetaElementsForThisRequest ()
  {
    final MetaElementList aSet = _getPerRequestSet (false);
    return aSet == null ? new CommonsArrayList <> () : aSet.getAllMetaElements ();
  }

  public static void getAllRegisteredMetaElementsForThisRequest (@Nonnull final Collection  aTarget)
  {
    final MetaElementList aSet = _getPerRequestSet (false);
    if (aSet != null)
      aSet.getAllMetaElements (aTarget);
  }

  /**
   * @return true if at least a single CSS path has been registered
   *         for this request only
   */
  public static boolean hasRegisteredMetaElementsForThisRequest ()
  {
    final MetaElementList aSet = _getPerRequestSet (false);
    return aSet != null && aSet.hasMetaElements ();
  }
}