FallbackEnvironmentReader.java

/*
 ** Module   : FallbackEnvironmentReader.java
 ** Abstract : Fallback Environment Reader
 **
 ** Copyright (c) 2023, Golden Code Development Corporation.
 **
 ** -#- -I- --Date-- ---------------------------------Description----------------------------------
 ** 001 GBB 20231025 Created initial version.
 ** 002 GBB 20231201 Adds base key. Handle sections with Win separators.
 */

/*
 ** This program 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.
 **
 ** This program 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 may find a copy of the GNU Affero GPL version 3 at the following
 ** location: https://www.gnu.org/licenses/agpl-3.0.en.html
 **
 ** Additional terms under GNU Affero GPL version 3 section 7:
 **
 **   Under Section 7 of the GNU Affero GPL version 3, the following additional
 **   terms apply to the works covered under the License.  These additional terms
 **   are non-permissive additional terms allowed under Section 7 of the GNU
 **   Affero GPL version 3 and may not be removed by you.
 **
 **   0. Attribution Requirement.
 **
 **     You must preserve all legal notices or author attributions in the covered
 **     work or Appropriate Legal Notices displayed by works containing the covered
 **     work.  You may not remove from the covered work any author or developer
 **     credit already included within the covered work.
 **
 **   1. No License To Use Trademarks.
 **
 **     This license does not grant any license or rights to use the trademarks
 **     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
 **     of Golden Code Development Corporation. You are not authorized to use the
 **     name Golden Code, FWD, or the names of any author or contributor, for
 **     publicity purposes without written authorization.
 **
 **   2. No Misrepresentation of Affiliation.
 **
 **     You may not represent yourself as Golden Code Development Corporation or FWD.
 **
 **     You may not represent yourself for publicity purposes as associated with
 **     Golden Code Development Corporation, FWD, or any author or contributor to
 **     the covered work, without written authorization.
 **
 **   3. No Misrepresentation of Source or Origin.
 **
 **     You may not represent the covered work as solely your work.  All modified
 **     versions of the covered work must be marked in a reasonable way to make it
 **     clear that the modified work is not originating from Golden Code Development
 **     Corporation or FWD.  All modified versions must contain the notices of
 **     attribution required in this license.
 */

package com.goldencode.p2j.util;

import com.goldencode.p2j.ui.*;
import com.goldencode.util.*;

/** Fallback Environment Reader */
public class FallbackEnvironmentReader
implements EnvironmentReader
{
   /** The env name */
   private String env;
   
   /** The client storage */
   private ClientStorage clientStorage;
   
   /** The base key */
   private String baseKey;
   
   /**
    * Public constructor.
    *
    * @param env
    *        The name of the environment.
    * @param clientStorage
    *        The client storage.
    * @param baseKey
    *        The base key.
    */
   public FallbackEnvironmentReader(String env, ClientStorage clientStorage, String baseKey)
   {
      this.env = env;
      this.clientStorage = clientStorage;
      this.baseKey = baseKey == null ? null : baseKey.replaceAll("\\\\", "/");
   }
   
   /**
    * Creates application defaults implementing Progress LOAD statement. 
    *
    * @return  <code>true</code> if loaded false otherwise      
    */
   @Override
   public boolean load()
   {
      // storing and restoring key : values from java Preferences and localStorage 
      // doesn't require initialization
      return true;
   }
   
   /**
    * Adds, modifies and deletes keys in current environment.
    *
    * @param section
    *        The name of the section containing the key to modify.
    * @param key
    *        The name of the key key to modify or default key if not specified.
    * @param value
    *        The new value of the key under modification.
    */
   @Override
   public void setKeyValue(String section, String key, String value)
   {
      String sectionKey = (baseKey != null ? baseKey + "/" : "") + env +
         (StringHelper.hasContent(section) ? "/" + section.replaceAll("\\\\", "/") : "");
      
      String finalKey = sectionKey + "/" + key;
      
      if (value == null || value.isEmpty())
      {
         if (key == null || key.isEmpty() || key.equals("?"))
         {
            clientStorage.delete(sectionKey);
         }
         else
         {
            clientStorage.delete(finalKey);
         }
         return;
      }
      
      clientStorage.setString(finalKey, value);
   }
   
   /**
    * Getting the key value from the current environment.
    *
    * @param section
    *        The name of the section containing the key to get.
    * @param key
    *        The name of the key key to get or default key if not specified.
    *
    * @return The value of the key.
    */
   @Override
   public String getKeyValue(String section, String key)
   {
      String compositeKey = baseKey != null ? baseKey + "/" : "";
      compositeKey += StringHelper.hasContent(section) ?
         env + "/" + section.replaceAll("\\\\", "/") + "/" + key :
         env + "/" + key;
      return clientStorage.getString(compositeKey);
   }

   /**
    * Unloads specifies environment from the current one.
    */
   @Override
   public void unload()
   {
   }

   /**
    * Get the environment's name.
    *
    * @return   See above.
    */
   @Override
   public String getEnvironmentName()
   {
      return env;
   }
   
   /**
    * Get the current environment's type.
    *
    * @return  environment type.
    */
   @Override
   public String getEnvironmentType()
   {
      return TYPE_FALLBACK;
   }
}