IRedDotObject.cs

Go to the documentation of this file.

// SmartAPI - .Net programmatic access to RedDot servers
//  
// Copyright (C) 2013 erminas GbR
// 
// This program 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.
// 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 General Public License for more details.
// 
// You should have received a copy of the GNU General Public License along with this program.
// If not, see <http://www.gnu.org/licenses/>.

using System;
using System.Xml;
using erminas.SmartAPI.Exceptions;
using erminas.SmartAPI.Utils;

namespace erminas.SmartAPI.CMS
{
    internal abstract class RedDotObject : AbstractAttributeContainer, IRedDotObject
    {
        protected static XmlDocument XMLDoc = new XmlDocument();

        private Guid _guid = Guid.Empty;
        protected string _name;

        protected RedDotObject(ISession session) : base(session)
        {
        }

        protected RedDotObject(ISession session, Guid guid) : base(session)
        {
            Guid = guid;
        }

        protected RedDotObject(ISession session, XmlElement xmlElement) : base(session, xmlElement)
        {
            InitGuidAndName();
        }

        public override bool Equals(object other)
        {
            var o = other as IRedDotObject;
            if (o == null)
            {
                return false;
            }
            return ReferenceEquals(this, other) || o.Guid.Equals(_guid);
        }

        public override int GetHashCode()
        {
            return _guid.GetHashCode();
        }

        public Guid Guid
        {
            get
            {
                if (_guid.Equals(Guid.Empty) && _xmlElement != null)
                {
                    InitIfPresent(ref _guid, "guid", GuidConvert);
                }
                return _guid;
            }
            internal set
            {
                if (_xmlElement != null)
                {
                    _xmlElement.Attributes["guid"].Value = value.ToRQLString();
                }
                _guid = value;
            }
        }

        public static Guid GuidConvert(string str)
        {
            return new Guid(str);
        }

        public virtual string Name
        {
            get { return _name; }
            internal set { _name = value; }
        }

        public override string ToString()
        {
            return Name + " (" + Guid.ToRQLString() + ")";
        }

        protected internal static string GetSaveString(XmlElement xmlElement)
        {
            XmlAttributeCollection attributes = xmlElement.Attributes;
            foreach (XmlAttribute curAttr in attributes)
            {
                if (string.IsNullOrEmpty(curAttr.Value))
                {
                    curAttr.Value = RQL.SESSIONKEY_PLACEHOLDER;
                }
            }

            xmlElement.AddAttribute("action", "save");

            return xmlElement.NodeToString();
        }

        protected static bool BoolConvert(string str)
        {
            switch (str.Trim())
            {
                case "1":
                    return true;
                case "0":
                    return false;
                default:
                    throw new Exception("Illegal value for bool '" + str + "', '1' or '0' expected");
            }
        }

        protected void EnsuredInit<T>(ref T variable, string attributeName, Func<string, T> converter)
        {
            string value = _xmlElement.GetAttributeValue(attributeName);
            if (string.IsNullOrEmpty(value))
            {
                throw new SmartAPIException(Session.ServerLogin,
                                            string.Format("Missing value for attribute {0}", attributeName));
            }
            variable = converter(value);
        }

        protected void InitGuidAndName()
        {
            InitIfPresent(ref _guid, "guid", GuidConvert);
            InitIfPresent(ref _name, "name", x => x);
        }

        protected void InitIfPresent<T>(ref T variable, string attributeName, Func<string, T> converter)
        {
            string value = _xmlElement.GetAttributeValue(attributeName);
            if (!string.IsNullOrEmpty(value))
            {
                variable = converter(value);
            }
        }

        protected static bool? NullableBoolConvert(string str)
        {
            return BoolConvert(str);
        }
    }

    public interface IRedDotObject
    {
        Guid Guid { get; }

        string Name { get; }
    }
}