OKW_Memorize.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.IO;
    using System.Xml.Serialization;

    using OKW.Log;

    public class OKW_Memorize
    {
        #region Fields

        public string OKW_Memorize_xml = string.Empty;

        public SerializableDictionary<string, string> _Value = new SerializableDictionary<string, string>();

        private static OKW_Memorize _Instance;


        private LogMessenger LM = null;
        

        private Logger Log = Logger.Instance;

        #endregion Fields

        #region Constructors

        private OKW_Memorize()
        {
            this.LM = new LogMessenger(this.GetType().Name);
        }

        #endregion Constructors

        #region Properties

        public static OKW_Memorize Instance
        {
            get
            {
                if (_Instance == null)
                {
                    _Instance = new OKW_Memorize();
                    _Instance.Init();
                }

                return _Instance;
            }
        }

        #endregion Properties

        #region Methods

        public static void Reset()
        {
            _Instance = null;
        }
        
        public bool Exists(string fpsKey)
        {
            bool lvbReturn = false;

            this.Log.LogFunctionStartDebug(_Instance.GetType().FullName + "Exists", "string fpsKey", fpsKey);

            if (this._Value.ContainsKey(fpsKey))
            {
                lvbReturn = true;
            }
            
            this.Log.LogFunctionEndDebug(lvbReturn);
            
            return lvbReturn;
        }

        public string Get(string fpsKey)
        {
            string lvsReturn = string.Empty;
            bool bOK = false;

            this.Log.LogFunctionStartDebug(_Instance.GetType().FullName + "Get", "String fpsKey", fpsKey);

            try
            {
                if (this._Value.ContainsKey(fpsKey))
                {
                    lvsReturn = this._Value[fpsKey];
                }
                else
                {
                    string ErrorText = this.LM.GetMessage("Get", "OKWMemorizeKeyNotExistsException", fpsKey);
                    throw new OKWMemorizeKeyNotExistsException(ErrorText);
                }
                
                bOK = true;
            }
            finally
            {
                if (bOK)
                {
                    this.Log.LogFunctionEndDebug();
                }
                else
                {
                    this.Log.LogFunctionEndDebug(lvsReturn);
                }
            }
            
            return lvsReturn;
        }

        public void Init()
        {
            this.Log.LogFunctionStartDebug(this.GetType().FullName + ".Init");

            // Klassen Variablen erst löschen...
            _Instance.OKW_Memorize_xml = string.Empty;
            _Instance._Value.Clear();

            // ... und dann alles Initialisieren!
            // 1. Setze Pfad und
            this.OKW_Memorize_xml = OKW_Ini.Instance.OKW_Enviroment.File_OKW_Memorize_xml;

            if (!string.IsNullOrEmpty(this.OKW_Memorize_xml))
            {
                this.Log.LogPrintDebug("OKW Memorize Datei = >>" + this.OKW_Memorize_xml + "<<");
                if (System.IO.File.Exists(this.OKW_Memorize_xml))
                {
                    // Lesen der Daten...
                    this.Read();
                }
                else
                {
                    // Deafault Werte Lesen.
                    this.Log.LogWarning("Datei: >>" + this.OKW_Memorize_xml + "<< nicht gefunden.");
                }
            }
            else
            {
                this.Log.LogWarning("Enviroment variable 'OKWIni' not set!");
            }

            this.Log.LogFunctionEndDebug();
            return;
        }

        public void Read()
        {
            this.Log.LogFunctionStartDebug(_Instance.GetType().FullName + "Read()");

            try
            {
                XmlSerializer serializer = new XmlSerializer(typeof(OKW_Memorize));
                StreamReader fs = new StreamReader(this.OKW_Memorize_xml);
                _Instance = (OKW_Memorize)serializer.Deserialize(fs);
                fs.Close();
            }
            finally
            {
                this.Log.LogFunctionEndDebug();
            }

            return;
        }

        public void Save()
        {
            this.Log.LogFunctionStartDebug(_Instance.GetType().FullName + "Save()");

            try
            {
                XmlSerializer serializer = new XmlSerializer(typeof(OKW_Memorize));
                StreamWriter fs = new StreamWriter(this.OKW_Memorize_xml, false);
                serializer.Serialize(fs, _Instance);
                fs.Close();
            }
            finally
            {
                this.Log.LogFunctionEndDebug();
            }
            
            return;
        }

        public void Set(string fpsKey, string fpsValue)
        {
            this.Log.LogFunctionStartDebug(_Instance.GetType().FullName + "Set", "String fpsKey", fpsKey, "String fpsValue", fpsValue);
            
            try
            {
                if (this._Value.ContainsKey(fpsKey))
                {
                    string lvsOverwriteKey = this.LM.GetMessage("Set", "OverwriteKeyWarning", fpsKey);
                    string lvsOldValue = this.LM.GetMessage("Set", "OldValue", this._Value[fpsKey]);
                    string lvsNewValue = this.LM.GetMessage("Set", "NewValue", fpsValue);

                    this.Log.LogWarning(lvsOverwriteKey);
                    this.Log.LogPrint(lvsOldValue);
                    this.Log.LogPrint(lvsNewValue);
                    _Instance._Value[fpsKey] = fpsValue;
                }
                else
                {
                    _Instance._Value.Add(fpsKey, fpsValue);
                    this.Log.LogPrint("Wert: " + fpsValue  + " wird gespeichert");
                }
                
                // persistentes Speichern aller Daten...
                _Instance.Save();
            }
            finally
            {
                this.Log.LogFunctionEndDebug();
            }

            return;
        }

        #endregion Methods
    }
}