# ParamFileReader.java

    /*
    ** Module   : ParamFileReader.java
    ** Abstract : -pf file helper
    **
    ** Copyright (c) 2024, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- ---------------------------------Description----------------------------------
    ** 001 GBB 20240110 Initial version. removeEnclosingQuotes moved from ServerConnectHelper.
    */
    /*
    ** 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.util.logging.*;
    import com.goldencode.util.*;

    import java.io.*;
    import java.util.logging.*;

    /** -pf file helper */
    public class ParamFileReader
    {
       /** Logger */
       private static final CentralLogger LOG = CentralLogger.get(ParamFileReader.class);

       /**
        * Reads -pf file from the file system.
        *
        * @param    file
        *           The path to the -pf file.
        *
        * @return   The content of the pf file.
        */
       public static String readPfFile(String file)
       {
          character foundFilePath = FileSystemOps.searchPath(file);
          if (foundFilePath.isUnknown())
          {
             LOG.log(Level.WARNING, "Parameter file %s can't be found.", file);
             return null;
          }

          StringBuilder fileContentBuilder = new StringBuilder();

          StreamWrapper stream = new StreamWrapper();
          stream.assign(StreamFactory.openFileStream(false, file, false, false));
          try
          {
             String line;
             while ((line = stream.readLn()) != null)
             {
                line = line.trim();
                int commentStartIndex = line.indexOf('#');
                if (commentStartIndex >= 0)
                {
                   // remove comment
                   line = line.substring(0, commentStartIndex).trim();
                }

                if (line.length() > 0)
                {
                   fileContentBuilder.append(line);
                }
             }
          }
          catch (EOFException ignored)
          {
             // indicates end of file
          }
          catch (Throwable t)
          {
             LOG.log(Level.WARNING, "Problems reading parameter file " + file, t);
             return null;
          }

          return fileContentBuilder.toString();
       }

       /**
        * Remove matched pairs of enclosing single or double quote characters from the given string
        * and return the result.  If there is more than one sequential matched pair of quotes, the
        * extra pairs of quotes will also be removed if and only if those quote characters are the
        * same as the first quote character that was removed. In other words, this will remove
        * multiple matching pairs of single quotes or multiple matching pairs of double quotes but
        * it will NOT remove pairs of double quotes when the first quotes are single quotes (and
        * vice versa).  This is how the 4GL works.  Yes, really.
        *
        * @param    txt
        *           Text to clean up.
        *
        * @return   The text without enclosing quotes.  Mostly (see the mixed quotes issue above).
        */
       public static String removeEnclosingQuotes(String txt)
       {
          if (txt == null || txt.length() == 0)
             return txt;

          char rmch = txt.charAt(0);

          if (rmch == '\'' || rmch == '\"')
          {
             int len = 0;

             do
             {
                txt = StringHelper.stripEnclosing(txt, rmch);
                len = txt.length();
             }
             while (len > 1 && txt.charAt(0) == rmch && txt.charAt(len - 1) == rmch);
          }

          return txt;
       }

       /**
        * Test the quote removal processing.
        *
        * @param    args
        *           Ignored.
        */
       public static void main(String[] args)
       {
          String[][] tests = new String[][]
             {
                { "'aaa'",                       "aaa"               },
                { "''aaa''",                     "aaa"               },
                { "''aaa'''",                    "aaa'"              },
                { "'''aaa''",                    "'aaa"              },
                { "'''''aaa'''",                 "''aaa"             },
                { "'''aaa'''",                   "aaa"               },
                { "''''''aaa''''''",             "aaa"               },
                { "''\"'''aaa'''\"''",           "\"'''aaa'''\""     },
                { "''\"'''aaa'''''",             "\"'''aaa'''"       },
                { "'aaa\"",                      "'aaa\""            },
                { "'aaa",                        "'aaa"              },
                { "aaa'",                        "aaa'"              },
                { "\"aaa\"",                     "aaa"               },
                { "\"\"aaa\"\"",                 "aaa"               },
                { "\"\"aaa\"\"\"",               "aaa\""             },
                { "\"\"\"aaa\"\"",               "\"aaa"             },
                { "\"\"\"\"\"aaa\"\"\"",         "\"\"aaa"           },
                { "\"\"\"aaa\"\"\"",             "aaa"               },
                { "\"\"\"\"\"\"aaa\"\"\"\"\"\"", "aaa"               },
                { "\"\"'\"\"\"aaa\"\"\"'\"\"",   "'\"\"\"aaa\"\"\"'" },
                { "\"\"'\"\"\"aaa\"\"\"\"\"",    "'\"\"\"aaa\"\"\""  },
                { "\"aaa'",                      "\"aaa'"            },
                { "\"aaa",                       "\"aaa"             },
                { "aaa\"",                       "aaa\""             }
             };

          int fails = 0;

          for (int i = 0; i < tests.length; i++)
          {
             if (!tests[i][1].equals(removeEnclosingQuotes(tests[i][0])))
             {
                fails++;

                System.out.printf("FAIL for test %d; input %s; output %s; expected %s;\n",
                                  i,
                                  tests[i][0],
                                  removeEnclosingQuotes(tests[i][0]),
                                  tests[i][1]);
             }
          }

          if (fails == 0)
             System.out.printf("All tests passed successfully.\n");
       }
    }