OKW_Helper.cs

#region Header
/*
    ==============================================================================
      Author: Zoltan Hrabovszki <zh@openkeyword.de>

      Copyright © 2012, 2013, 2014, 2015 IT-Beratung Hrabovszki
      www.OpenKeyWord.de
    ============================================================================== 

    This file is part of OpenKeyWord.

    OpenKeyWord is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    OpenKeyWord 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with OpenKeyWord.  If not, see <http://www.gnu.org/licenses/>.

    Diese Datei ist Teil von OpenKeyWord.

    OpenKeyWord ist Freie Software: Sie können es unter den Bedingungen
    der GNU General Public License, wie von der Free Software Foundation,
    Version 3 der Lizenz oder (nach Ihrer Wahl) jeder späteren
    veröffentlichten Version, weiterverbreiten und/oder modifizieren.

    OpenKeyWord wird in der Hoffnung, dass es nützlich sein wird, aber
    OHNE JEDE GEWÄHRLEISTUNG, bereitgestellt; sogar ohne die implizite
    Gewährleistung der MARKTFÄHIGKEIT oder EIGNUNG FÜR EINEN BESTIMMTEN ZWECK.
    Siehe die GNU General Public License für weitere Details.

    Sie sollten eine Kopie der GNU General Public License zusammen mit 
    OpenKeyWord erhalten haben. Wenn nicht, siehe <http://www.gnu.org/licenses/>.
*/
#endregion Header

namespace OKW
{
    using System;
    using System.Collections.Generic;
    using System.Text.RegularExpressions;
    using System.Windows.Forms;
    using OKW.Log;

    public static class OKW_Helper
    {
        #region Fields
        
        private static Logger Log = Logger.Instance;

        private static LogMessenger LM = new LogMessenger("OKWHelper");

        #endregion Fields

        #region Methods

        public static string Boolean2String(bool fpbTrueOrFalse)
        {
            string lvsReturn = string.Empty;

            Logger.Instance.LogFunctionStartDebug("OKW_Helper.Boolean2String", "fpbTrueOrFalse", fpbTrueOrFalse.ToString());

            try
            {
                if (fpbTrueOrFalse)
                {
                    lvsReturn = "true";
                }
                else
                {
                    lvsReturn = "false";
                }
            }
            finally
            {
                Logger.Instance.LogFunctionEndDebug(lvsReturn);
            }

            return lvsReturn;
        }

        public static string GetLeftFromDelimiterNumber(string fpsSource, string fpsDelimiter, int fpiCount)
        {
            string lvsReturn = string.Empty;
            List<string> lvLsSplitedSource = null;

            bool bOK = false;

            int RangeMin = 1;
            int RangeMax = 1;

            try
            {
                Log.LogFunctionStartDebug("OKW_Helper.GetLeftFromDelimiterNumber", "fpsSource", fpsSource, "fpsDelimiter", fpsDelimiter, "fpiCount", fpiCount.ToString());

                if (fpsDelimiter != string.Empty)
                {
                    lvLsSplitedSource = StrSplit(fpsSource, fpsDelimiter);

                    // Gültigen Werte bereich berechnen:
                    RangeMax = lvLsSplitedSource.Count - 1;
                    RangeMin = 1;

                    // 1. Prüfen ob Split Zahl <= Count, anderefalls Exception auslösen...
                    if ((RangeMin <= fpiCount) & (fpiCount <= RangeMax))
                    {
                        // 2. Dann bauen wir den string auf
                        lvsReturn = lvLsSplitedSource[0];

                        for (int i = 1; i < fpiCount; i++)
                        {
                            lvsReturn = lvsReturn + fpsDelimiter + lvLsSplitedSource[i];
                        }
                    }
                    else
                    {
                        string lvsLM = LM.GetMessage("GetLeftFromDelimiterNumber", "OKWDelimiterCountOutOfRangeException", fpiCount.ToString(), RangeMax.ToString());
                        throw new System.IndexOutOfRangeException(lvsLM);
                    }
                }
                else
                {
                    string lvsLM = LM.GetMessage("GetLeftFromDelimiterNumber", "OKWDelimiterIsEmptyException");
                    throw new System.ArgumentException(lvsLM);
                }

                bOK = true;
            }
            finally
            {
                if (bOK)
                {
                    Log.LogFunctionEndDebug(lvsReturn);
                }
                else
                {
                    Log.LogFunctionEndDebug();
                }
            }

            return lvsReturn;
        }

        public static string GetRigthFromDelimiterNumber(string fpsSource, string fpsDelimiter, int fpiCount)
        {
            string lvsReturn = string.Empty;
            List<string> lvLsSplitedSource = null;
            bool bOK = false;
            int RangeMin = 1;
            int RangeMax = 1;
            try
            {
                Log.LogFunctionStartDebug("OKW_Helper.GetLeftFromDelimiterNumber", "fpsSource", fpsSource, "fpsDelimiter", fpsDelimiter, "fpiCount", fpiCount.ToString());
                if (fpsDelimiter != string.Empty)
                {
                    lvLsSplitedSource = StrSplit(fpsSource, fpsDelimiter);

                    // Gültigen Werte bereich berechnen:
                    RangeMax = lvLsSplitedSource.Count - 1;
                    RangeMin = 1;

                    // 1. Prüfen ob Split Zahl <= Count, anderefalls Exception auslösen...
                    if ((RangeMin <= fpiCount) & (fpiCount <= RangeMax))
                    {
                        // 2. Dann bauen wir den string auf
                        lvsReturn = lvLsSplitedSource[fpiCount];

                        for (int i = fpiCount + 1; i < lvLsSplitedSource.Count; i++)
                        {
                            lvsReturn = lvsReturn + fpsDelimiter + lvLsSplitedSource[i];
                        }
                    }
                    else
                    {
                        string lvsLM = LM.GetMessage("GetLeftFromDelimiterNumber", "OKWDelimiterCountOutOfRangeException", fpiCount.ToString(), RangeMax.ToString());
                        throw new System.IndexOutOfRangeException(lvsLM);
                    }
                }
                else
                {
                    string lvsLM = LM.GetMessage("GetLeftFromDelimiterNumber", "OKWDelimiterIsEmptyException");
                    throw new System.ArgumentException(lvsLM);
                }

                bOK = true;
            }
            finally
            {
                if (bOK)
                {
                    Log.LogFunctionEndDebug(lvsReturn);
                }
                else
                {
                    Log.LogFunctionEndDebug();
                }
            }
            
            return lvsReturn;
        }

        public static bool ListStringCompare(List<string> ListString1, List<string> ListString2)
        {
            bool lvbReturn = true;
            bool bOK = false;

            Logger.Instance.LogFunctionStartDebug("OKW_Helper.ListStringCompare", "ListString1", ListString1.ToString(), "ListString2", ListString2.ToString());

            try
            {
                // HAben beide Listen
                if (ListString1.Count == ListString2.Count)
                {
                    for (int i = 0; i < ListString1.Count; i++)
                    {
                        if (ListString1[i] != ListString2[i])
                        {
                            // ungleich daher abbrechen und false zurückliefern.
                            Logger.Instance.LogPrintDebug(ListString1[i] + "<>" + ListString2[i]);
                            lvbReturn = false;
                            break;
                        }
                        else
                        {
                            lvbReturn = true;
                        }
                    }
                }
                else
                {
                    lvbReturn = false;
                }
                
                bOK = true;
            }
            finally
            {
                if (bOK)
                {
                    Logger.Instance.LogFunctionEndDebug(lvbReturn);
                }
                else
                {
                    Logger.Instance.LogFunctionEndDebug();
                }
            }
            
            return lvbReturn;
        }

        public static string ListStringConcat(List<string> fps_ListString2Concat, string fps_Separator)
        {
            string lvsReturn = string.Empty;
            bool bOK = false;

            Log.LogFunctionStartDebug("OKW_Helper.ListStringConcat", "fps_ListString2Concat", fps_ListString2Concat.ToString(), "fps_Separator", fps_Separator);

            try
            {
                lvsReturn = string.Join(fps_Separator, fps_ListString2Concat.ToArray());
                bOK = true;
            }
            finally
            {
                if (bOK)
                {
                    Log.LogFunctionEndDebug(lvsReturn);
                }
                else
                {
                    Log.LogFunctionEndDebug();
                }
            }

            return lvsReturn;
        }

        public static bool MatchStr(string fpsPattern, string fpsStringToMatch)
        {
            // Variables:
            bool lvbReturn = false;
            bool bOK = false;

            // Action:
            try
            {
                Logger.Instance.LogFunctionStartDebug("OKW_Helper.MatchStr", "String fpsPattern", fpsPattern, "String fpsStringToMatch", fpsStringToMatch);

                // Replace the * with an .* and the ? with a dot. Put ^ at the
                // beginning and a $ at the end
                string pattern = "^" + Regex.Escape(fpsPattern).Replace(@"\*", ".*").Replace(@"\?", ".") + "$";

                // Now, run the Regex as you already know
                Regex regex;
                regex = new Regex(pattern);

                lvbReturn = regex.IsMatch(fpsStringToMatch);
                bOK = true;
            }
            finally
            {
                if (bOK)
                {
                    Log.LogFunctionEndDebug(lvbReturn);
                }
                else
                {
                    Log.LogFunctionEndDebug();
                }
            }
            
            return lvbReturn;
        }

        public static bool MatchStrIgnoreCase(string fpsPattern, string fpsStringToMatch)
        {
            // Variables:
            bool lvb_Return = false;
            bool bOK = true;

            // Action:
            try
            {
                Logger.Instance.LogFunctionStartDebug("OKW_Helper.MatchStrIgnoreCase", "String fpsPattern", fpsPattern, "String fpsStringToMatch", fpsStringToMatch);

                // Replace the * with an .* and the ? with a dot. Put ^ at the
                // beginning and a $ at the end
                string pattern = "^" + Regex.Escape(fpsPattern).Replace(@"\*", ".*").Replace(@"\?", ".") + "$";

                // Now, run the Regex as you already know
                Regex regex;
                regex = new Regex(pattern, RegexOptions.IgnoreCase);

                lvb_Return = regex.IsMatch(fpsStringToMatch);
                bOK = true;
            }
            finally
            {
                if (bOK)
                {
                    Logger.Instance.LogFunctionEndDebug(lvb_Return);
                }
                else
                {
                    Logger.Instance.LogFunctionEndDebug();
                }
            }
            
            return lvb_Return;
        }

        public static string RemoveBeginEndQuotations(string fps_StringinQuotations)
        {
            string lvs_Return = Regex.Replace(fps_StringinQuotations, "^\"|\"$", string.Empty);
            return lvs_Return;
        }

        public static List<string> StrArray2ListStr(string[] fpsStringArray)
        {
            Logger.Instance.LogFunctionStartDebug("OKW_Helper.StrArray2ListStr", "fpsStringArray", fpsStringArray.ToString());

            List<string> lvls_Splited = new List<string>();
            lvls_Splited.Clear();

            try
            {
                lvls_Splited = new List<string>(fpsStringArray);
            }
            finally
            {
                Logger.Instance.LogFunctionEndDebug(lvls_Splited);
            }
            
            return lvls_Splited;
        }


        public static bool String2Boolean(string fpsTrueOrFalse)
        {
            bool lvbReturn = false;
            bool bOK = false;

            string lvsTrueOrFalse = fpsTrueOrFalse.ToLower();

            Logger.Instance.LogFunctionStartDebug("OKW_Helper.String2Boolean", "fpsTrueOrFalse", fpsTrueOrFalse);

            try
            {
                if ( lvsTrueOrFalse == "true")
                {
                    lvbReturn = true;
                    bOK = true;
                }
                else if ( lvsTrueOrFalse == "false" )
                {
                    lvbReturn = false;
                    bOK = true;
                }
                else{
                    // alles andere löst ein OKWNotAllowedValueException aus
                    bOK = false;

                    string lvsLM = LM.GetMessage("String2Boolean", "OKWNotAllowedValueException", fpsTrueOrFalse);
                    throw new OKWNotAllowedValueException(lvsLM);
                }
            }
            finally
            {
                if (bOK)
                {
                    Log.LogFunctionEndDebug(lvbReturn);
                }
                else
                {
                    Log.LogFunctionEndDebug();
                }
            }

            return lvbReturn;
        }

        public static List<string> StrSplit(string fpsString2Split, string fpsSeparator)
        {
            bool bOK = false;

            string[] lvsA_Splited;
            List<string> lvls_Splited = new List<string>();

            string[] lvsSeparators = new string[] { fpsSeparator };

            Log.LogFunctionStartDebug("OKW_Helper.StrSplit", "fpsString2Split", fpsString2Split, "fpsSeparator", fpsSeparator);

            try
            {
                lvsA_Splited = fpsString2Split.Split(lvsSeparators, StringSplitOptions.None);
                lvls_Splited = StrArray2ListStr(lvsA_Splited);
                bOK = true;
            }
            finally
            {
                if (bOK)
                {
                    Log.LogFunctionEndDebug(lvls_Splited);
                }
                else
                {
                    Log.LogFunctionEndDebug();
                }
            }
            
            return lvls_Splited;
        }

        #endregion Methods
    }
}