IKeyword.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.Web;
using System.Xml;
using erminas.SmartAPI.Exceptions;
using erminas.SmartAPI.Utils;

namespace erminas.SmartAPI.CMS.Project.Keywords
{
    public interface IKeyword : IPartialRedDotObject, IProjectObject
    {
        ICategory Category { get; }
        void Commit();

        void Delete();

        void DeleteForcibly();

        void Rename(string newKeywordName);
    }

    public static class KeywordFactory
    {
        public static IKeyword CreateFromGuid(IProject project, Guid guid)
        {
            return new Keyword(project, guid);
        }
    }

    internal class Keyword : PartialRedDotProjectObject, IKeyword
    {
        private ICategory _category;

        internal Keyword(IProject project, XmlElement xmlElement) : base(project, xmlElement)
        {
            LoadXml();
        }

        internal Keyword(IProject project, Guid guid) : base(project, guid)
        {
        }

        public ICategory Category
        {
            get { return LazyLoad(ref _category); }
            internal set { _category = value; }
        }

        public void Commit()
        {
            const string SAVE_KEYWORD = @"<PROJECT><KEYWORD action=""save"" guid=""{0}"" value=""{1}""/></PROJECT>";

            string htmlEncodedName = HttpUtility.HtmlEncode(Name);
            var xmlDoc = Project.ExecuteRQL(SAVE_KEYWORD.RQLFormat(this, htmlEncodedName));

            const string KEYWORD_XPATH_TEMPLATE = "/IODATA/KEYWORD[@value='{0}' and @guid='{1}']";
            string keywordXPath = KEYWORD_XPATH_TEMPLATE.RQLFormat(htmlEncodedName, this);
            var keyword = xmlDoc.SelectSingleNode(keywordXPath);
            if (keyword == null)
            {
                throw new SmartAPIException(Session.ServerLogin,
                                            string.Format("Could not rename keyword to '{0}'", Name));
            }
        }

        public void Delete()
        {
            const string DELETE_KEYWORD = @"<KEYWORD action=""delete"" guid=""{0}"" force=""0""/>";

            var xmlDoc = Project.ExecuteRQL(DELETE_KEYWORD.RQLFormat(this), RqlType.SessionKeyInProject);
            var keyword = (XmlElement) xmlDoc.SelectSingleNode("/IODATA/KEYWORD");

            if (keyword == null)
            {
                throw new SmartAPIException(Session.ServerLogin, string.Format("Could not delete keyword {0}", this));
            }

            if (IsKeywordStillUsed(keyword))
            {
                throw new SmartAPIException(Session.ServerLogin,
                                            string.Format(
                                                "Could not delete keyword {0}, because it is still used for page connections",
                                                this));
            }

            Category.Keywords.InvalidateCache();
        }

        public void DeleteForcibly()
        {
            const string DELETE_KEYWORD = @"<KEYWORD action=""delete"" guid=""{0}"" force=""1"" password=""{1}"" />";

            var xmlDoc =
                Project.ExecuteRQL(DELETE_KEYWORD.RQLFormat(this, Project.Session.ServerLogin.AuthData.Password),
                                   RqlType.SessionKeyInProject);
            var keyword = (XmlElement) xmlDoc.SelectSingleNode("/IODATA/KEYWORD");
            //TODO execute page builder command
            if (keyword == null)
            {
                throw new SmartAPIException(Session.ServerLogin, string.Format("Could not delete keyword {0}", this));
            }

            Category.Keywords.InvalidateCache();
        }

        public void Rename(string newKeywordName)
        {
            var oldName = Name;
            Name = newKeywordName;
            try
            {
                Commit();
            } catch (Exception)
            {
                Name = oldName;
                throw;
            }
        }

        protected override void LoadWholeObject()
        {
            LoadXml();
        }

        protected override XmlElement RetrieveWholeObject()
        {
            const string LOAD_KEYWORD =
                @"<PROJECT><CATEGORY><KEYWORD action=""load"" guid=""{0}""/></CATEGORY></PROJECT>";
            return (XmlElement) Project.ExecuteRQL(LOAD_KEYWORD.RQLFormat(this)).GetElementsByTagName("KEYWORD")[0];
        }

        private static bool IsKeywordStillUsed(XmlElement keyword)
        {
            return keyword.GetIntAttributeValue("countkeywordonpag").GetValueOrDefault() > 0 ||
                   keyword.GetIntAttributeValue("countkeywordonpge") > 0 ||
                   keyword.GetIntAttributeValue("countkeywordonpgeandpag") > 0;
        }

        private void LoadXml()
        {
            Name = _xmlElement.GetAttributeValue("value");
            InitIfPresent(ref _category, "categoryguid", x => new Category(Project, Guid.Parse(x)));
            if (_category == null)
            {
                var keywordsNode = XmlElement.ParentNode as XmlElement;
                if (keywordsNode == null)
                {
                    return;
                }
                var categoryNode = keywordsNode.ParentNode as XmlElement;
                if (categoryNode == null || categoryNode.Name != "CATEGORY")
                {
                    return;
                }

                _category = new Category(Project, categoryNode);
            }
        }
    }
}