com.helger.diver.repo.impl.AbstractRepoStorageWithToc Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2023-2024 Philip Helger & ecosio
 * 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.diver.repo.impl;

import java.time.OffsetDateTime;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.function.Consumer;

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.annotation.OverrideOnDemand;
import com.helger.commons.datetime.PDTFactory;
import com.helger.commons.error.list.ErrorList;
import com.helger.commons.state.ESuccess;
import com.helger.commons.string.ToStringGenerator;
import com.helger.diver.api.version.VESID;
import com.helger.diver.repo.ERepoDeletable;
import com.helger.diver.repo.ERepoWritable;
import com.helger.diver.repo.IRepoStorageContent;
import com.helger.diver.repo.IRepoStorageReadItem;
import com.helger.diver.repo.IRepoStorageType;
import com.helger.diver.repo.RepoStorageContentByteArray;
import com.helger.diver.repo.RepoStorageKeyOfArtefact;
import com.helger.diver.repo.toc.IRepoStorageWithToc;
import com.helger.diver.repo.toc.IRepoTopTocService;
import com.helger.diver.repo.toc.RepoToc;
import com.helger.diver.repo.toc.RepoToc1Marshaller;
import com.helger.diver.repo.toc.jaxb.v10.RepoTocType;

/**
 * Abstract implementation of a repository storage with table of contents
 * support.
 *
 * @author Philip Helger
 * @param 
 *        The real implementation type.
 */
public abstract class AbstractRepoStorageWithToc > extends
                                                 AbstractRepoStorage  implements
                                                 IRepoStorageWithToc
{
  public static final boolean DEFAULT_ENABLE_TOC_UPDATES = true;

  private static final Logger LOGGER = LoggerFactory.getLogger (AbstractRepoStorageWithToc.class);

  // Enable ToC updates on write and delete
  private boolean m_bEnableTocUpdates = DEFAULT_ENABLE_TOC_UPDATES;
  private final AtomicBoolean m_aTopTocServiceInitialized = new AtomicBoolean (false);
  private final IRepoTopTocService m_aTopTocService;

  protected AbstractRepoStorageWithToc (@Nonnull final IRepoStorageType aType,
                                        @Nonnull @Nonempty final String sID,
                                        @Nonnull final ERepoWritable eWriteEnabled,
                                        @Nonnull final ERepoDeletable eDeleteEnabled,
                                        @Nonnull final IRepoTopTocService aTopTocService)
  {
    super (aType, sID, eWriteEnabled, eDeleteEnabled);
    ValueEnforcer.notNull (aTopTocService, "TopTocService");
    m_aTopTocService = aTopTocService;
  }

  @Nonnull
  public final IRepoTopTocService getTopTocService ()
  {
    if (!m_aTopTocServiceInitialized.getAndSet (true))
    {
      LOGGER.info ("Begin initializing TopToc for repo");
      m_aTopTocService.initForRepo (this);
      LOGGER.info ("Done initializing TopToc for repo");
    }

    return m_aTopTocService;
  }

  public final boolean isEnableTocUpdates ()
  {
    return m_bEnableTocUpdates;
  }

  @Nonnull
  public final IMPLTYPE setEnableTocUpdates (final boolean b)
  {
    m_bEnableTocUpdates = b;
    LOGGER.info ("RepoStorage[" + getRepoType ().getID () + "]: ToC updates are now: " + (b ? "enabled" : "disabled"));
    return thisAsT ();
  }

  /**
   * Update the table of contents for a specific group ID and artifact ID. This
   * method may only be called if {@link #isEnableTocUpdates()} returned
   * true.
   *
   * @param aKeyToc
   *        The ToC key with group ID and artifact ID. Never null.
   * @param aTocConsumer
   *        The main activities are done in the callback. Never
   *        null.
   * @return {@link ESuccess#SUCCESS} if updating was successful. Never
   *         null.
   */
  @Nonnull
  @OverrideOnDemand
  protected ESuccess updateToc (@Nonnull final RepoStorageKeyOfArtefact aKeyToc,
                                @Nonnull final Consumer  aTocConsumer)
  {
    // Read existing ToC
    final IRepoStorageReadItem aTocItem = read (aKeyToc);
    final RepoToc aToc;
    if (aTocItem == null)
    {
      // Create a new one
      aToc = new RepoToc (aKeyToc.getVESID ().getGroupID (), aKeyToc.getVESID ().getArtifactID ());
    }
    else
    {
      final RepoTocType aJaxbToc = new RepoToc1Marshaller ().read (aTocItem.getContent ().getBufferedInputStream ());
      if (aJaxbToc == null)
        throw new IllegalStateException ("Invalid TOC found in '" + aKeyToc.getPath () + "'");
      aToc = RepoToc.createFromJaxbObject (aJaxbToc);
    }

    try
    {
      // Make modifications
      aTocConsumer.accept (aToc);
    }
    catch (final RuntimeException ex)
    {
      LOGGER.error ("Error invoking ToC consumer", ex);
      return ESuccess.FAILURE;
    }

    // Serialize updated ToC
    final ErrorList aErrorList = new ErrorList ();
    final byte [] aMarshalledTocBytes = new RepoToc1Marshaller ().setFormattedOutput (true)
                                                                 .setCollectErrors (aErrorList)
                                                                 .getAsBytes (aToc.getAsJaxbObject ());
    if (aMarshalledTocBytes == null)
      throw new IllegalStateException ("Failed to serialize XML ToC. Details: " + aErrorList);

    // Write ToC again
    // Don't check if enabled or not
    return doWriteRepoStorageItem (aKeyToc, RepoStorageContentByteArray.of (aMarshalledTocBytes));
  }

  @Override
  @OverrideOnDemand
  @Nonnull
  protected final ESuccess onAfterWrite (@Nonnull final RepoStorageKeyOfArtefact aKey,
                                         @Nonnull final IRepoStorageContent aContent,
                                         @Nullable final OffsetDateTime aPublicationDT)
  {
    if (isEnableTocUpdates ())
    {
      // Update ToC
      return updateToc (aKey.getKeyToc (), toc -> {
        final VESID aVESID = aKey.getVESID ();
        // Make sure a publication DT is present and always UTC
        final OffsetDateTime aRealPubDT = aPublicationDT != null ? aPublicationDT : PDTFactory
                                                                                              .getCurrentOffsetDateTimeUTC ();

        // Add new version
        if (toc.addVersion (aVESID.getVersionObj (), aRealPubDT).isUnchanged ())
        {
          // This is okay, if e.g. resource and VES reside in the same folder
          if (LOGGER.isDebugEnabled ())
            LOGGER.debug ("Failed to add version '" +
                          aVESID.getAsSingleID () +
                          "' to ToC of because it is already contained");
        }
        else
        {
          LOGGER.info ("Successfully added version '" + aVESID.getAsSingleID () + "' to ToC");
        }

        // Update top-level ToC
        getTopTocService ().registerGroupAndArtifact (aVESID.getGroupID (), aVESID.getArtifactID ());
      });
    }

    return ESuccess.SUCCESS;
  }

  @Override
  @Nonnull
  protected final ESuccess onAfterDelete (@Nonnull final RepoStorageKeyOfArtefact aKey)
  {
    if (isEnableTocUpdates ())
    {
      // Update ToC
      return updateToc (aKey.getKeyToc (), toc -> {
        final VESID aVESID = aKey.getVESID ();
        // Remove deleted version
        if (toc.removeVersion (aVESID.getVersionObj ()).isUnchanged ())
        {
          LOGGER.warn ("Failed to delete version '" +
                       aVESID.getAsSingleID () +
                       "' from ToC because it is not contained");
        }
        else
        {
          LOGGER.info ("Successfully deleted version '" + aVESID.getAsSingleID () + "' from ToC");
        }
      });
    }

    return ESuccess.SUCCESS;
  }

  @Override
  public String toString ()
  {
    return ToStringGenerator.getDerived (super.toString ())
                            .append ("EnableTocUpdates", m_bEnableTocUpdates)
                            .append ("TopTocServiceInited", m_aTopTocServiceInitialized.get ())
                            .append ("TopTocService", m_aTopTocService)
                            .getToString ();
  }
}