Customer.cs | searchcode

/sipsorcery-core/SIPSorcery.CRM/Customer.cs

https://github.com/thecc4re/sipsorcery-mono
C# | 327 lines | 246 code | 46 blank | 35 comment | 76 complexity | 735ffa01fb50aaa32e3fe9d5a1733f8e MD5 | raw file
Possible License(s): CC-BY-SA-3.0

// ============================================================================

// FileName: Customer.cs

//

// Description:

// Represents a customer record.

//

// Author(s):

// Aaron Clauson

//

// History:

// 20 May 2009	Aaron Clauson	Created.

//

// License: 

// This software is licensed under the BSD License http://www.opensource.org/licenses/bsd-license.php

//

// Copyright (c) 2009 Aaron Clauson (aaronc@blueface.ie), Blue Face Ltd, Dublin, Ireland (www.blueface.ie)

// All rights reserved.

//

// Redistribution and use in source and binary forms, with or without modification, are permitted provided that 

// the following conditions are met:

//

// Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 

// Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following 

// disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of Blue Face Ltd. 

// nor the names of its contributors may be used to endorse or promote products derived from this software without specific 

// prior written permission. 

//

// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, 

// BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 

// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, 

// OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, 

// OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 

// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 

// POSSIBILITY OF SUCH DAMAGE.

// ============================================================================



using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using System.Text.RegularExpressions;

using System.Xml;

using SIPSorcery.Sys;

using SIPSorcery.Persistence;

using log4net;



#if !SILVERLIGHT

using System.Data;

using System.Data.Linq;

using System.Data.Linq.Mapping;

#endif



namespace SIPSorcery.CRM

{

    [Table(Name = "customers")]

    public class Customer : ISIPAsset

    {

        public const string XML_DOCUMENT_ELEMENT_NAME = "customers";

        public const string XML_ELEMENT_NAME = "customer";

        public const string TOPLEVEL_ADMIN_ID = "*";                    // If a customer record has their AdminId set to this value they are in charge!

        public const int DEFAULT_MAXIMUM_EXECUTION_COUNT = 5;           // The default value for the maximum allowed simultaneous executions of all the customer's dial plans.

        

        public const int MAX_FIELD_LENGTH = 64;

        public const int MIN_USERNAME_LENGTH = 5;

        public const int MAX_USERNAME_LENGTH = 20;

        public const int MIN_PASSWORD_LENGTH = 6;

        public const int MAX_PASSWORD_LENGTH = 20;

        public const int MAX_WEBSITE_FIELD_LENGTH = 256;

        

        public static readonly string USERNAME_ALLOWED_CHARS = @"a-zA-Z0-9_\-";     // The '.' character is not allowed in customer usernames in order to support a domain like structure for SIP account usernames.



        private static ILog logger = AppState.logger;

        private static string m_newLine = AppState.NewLine;



        [Column(Name = "id", DbType = "varchar(36)", IsPrimaryKey = true, CanBeNull = false, UpdateCheck = UpdateCheck.Never)]

        public Guid Id { get; set; }



        [Column(Name = "customerusername", DbType = "varchar(32)", CanBeNull = false, UpdateCheck = UpdateCheck.Never)]

        public string CustomerUsername { get; set; }



        [Column(Name = "customerpassword", DbType = "varchar(32)", CanBeNull = false, UpdateCheck = UpdateCheck.Never)]

        public string CustomerPassword { get; set; }



        [Column(Name = "emailaddress", DbType = "varchar(255)", CanBeNull = false, UpdateCheck = UpdateCheck.Never)]

        public string EmailAddress { get; set; }



        [Column(Name = "lastname", DbType = "varchar(64)", UpdateCheck = UpdateCheck.Never)]

        public string LastName { get; set; }



        [Column(Name = "firstname", DbType = "varchar(64)", UpdateCheck = UpdateCheck.Never)]

        public string FirstName { get; set; }



        [Column(Name = "city", DbType = "varchar(64)", UpdateCheck = UpdateCheck.Never)]

        public string City { get; set; }



        [Column(Name = "country", DbType = "varchar(64)", UpdateCheck = UpdateCheck.Never)]

        public string Country { get; set; }



        [Column(Name = "website", DbType = "varchar(256)", UpdateCheck = UpdateCheck.Never)]

        public string WebSite { get; set; }



        [Column(Name = "active", DbType = "bit", CanBeNull = false, UpdateCheck = UpdateCheck.Never)]

	    public bool Active{get; set;}



        [Column(Name = "suspended", DbType = "bit", CanBeNull = false, UpdateCheck = UpdateCheck.Never)]

	    public bool Suspended{get; set;}



        [Column(Name = "suspendedreason", DbType = "varchar(1024)", UpdateCheck = UpdateCheck.Never)]

        public string SuspendedReason { get; set; }



        [Column(Name = "securityquestion", DbType = "varchar(1024)", UpdateCheck = UpdateCheck.Never)]

        public string SecurityQuestion { get; set; }



        [Column(Name = "securityanswer", DbType = "varchar(256)", UpdateCheck = UpdateCheck.Never)]

        public string SecurityAnswer { get; set; }



        [Column(Name = "createdfromipaddress", DbType = "varchar(15)", UpdateCheck = UpdateCheck.Never)]

        public string CreatedFromIPAddress { get; set; }



        [Column(Name = "adminid", DbType = "varchar(32)", CanBeNull = true, UpdateCheck = UpdateCheck.Never)]

        public string AdminId { get; set; }          // Like a whitelabelid. If set identifies this user as the administrative owner of all accounts that have the same value for their adminmemberid.



        [Column(Name = "adminmemberid", DbType = "varchar(32)", CanBeNull = true, UpdateCheck = UpdateCheck.Never)]

        public string AdminMemberId { get; set; }    // If set it designates this customer as a belonging to the administrative domain of the customer with the same adminid.



        [Column(Name = "timezone", DbType = "varchar(128)", CanBeNull = true, UpdateCheck = UpdateCheck.Never)]

        public string TimeZone { get; set; }



        [Column(Name = "inserted", DbType = "datetimeoffset", CanBeNull = false, UpdateCheck = UpdateCheck.Never)]

        public DateTimeOffset Inserted { get; set; }



        [Column(Name = "maxexecutioncount", DbType = "int", CanBeNull = false, UpdateCheck = UpdateCheck.Never)]

        public int MaxExecutionCount { get; set; }



        [Column(Name = "executioncount", DbType = "int", CanBeNull = false, UpdateCheck = UpdateCheck.Never)]

        public int ExecutionCount { get; set; }



        [Column(Name = "authorisedapps", DbType = "varchar(2048)", CanBeNull = true, UpdateCheck = UpdateCheck.Never)]

        public string AuthorisedApps { get; set; }



        [Column(Name = "invitecode", DbType = "varchar(36)", UpdateCheck = UpdateCheck.Never)]

        public string InviteCode { get; set; }



        [Column(Name = "emailaddressconfirmed", DbType = "bit", CanBeNull = false, UpdateCheck = UpdateCheck.Never)]

        public bool EmailAddressConfirmed { get; set; }



        public Customer() { }



        public static string ValidateAndClean(Customer customer) {



            if (customer.FirstName.IsNullOrBlank()) {

                return "A first name must be specified.";

            }

            else if (customer.FirstName.Trim().Length > MAX_FIELD_LENGTH) {

                return "The first name length must be less than " + MAX_FIELD_LENGTH + ".";

            }

            else if (customer.LastName.IsNullOrBlank()) {

                return "A last name must be specified.";

            }

            else if (customer.LastName.Trim().Length > MAX_FIELD_LENGTH) {

                return "The last name length must be less than " + MAX_FIELD_LENGTH + ".";

            }

            else if (customer.EmailAddress.IsNullOrBlank()) {

                return "An email address must be specified.";

            }

            else if (customer.EmailAddress.Trim().Length > MAX_FIELD_LENGTH) {

                return "The email address length must be less than " + MAX_FIELD_LENGTH + ".";

            }

            else if (!Regex.Match(customer.EmailAddress, @"\S+@\S+\.\S+").Success) {

                return "The email address was an invalid format.";

            }

            else if (customer.CustomerUsername.IsNullOrBlank()) {

                return "A username must be specified.";

            }

            else if (customer.CustomerUsername.Trim().Length > MAX_USERNAME_LENGTH || customer.CustomerUsername.Trim().Length < MIN_USERNAME_LENGTH) {

                return "The username length must be between " + MIN_USERNAME_LENGTH + " and " + MAX_USERNAME_LENGTH + ".";

            }

            else if (Regex.Match(customer.CustomerUsername.Trim(), "[^" + USERNAME_ALLOWED_CHARS + "]").Success) {

                return "The username had an invalid character, characters permitted are alpha-numeric and -_ (no full stop characters '.' are allowed).";

            }

            else if (customer.CustomerPassword.IsNullOrBlank()) {

                return "A password must be specified.";

            }

            else if (customer.CustomerPassword.Trim().Length > MAX_PASSWORD_LENGTH || customer.CustomerPassword.Trim().Length < MIN_PASSWORD_LENGTH) {

                return "The password length must be between " + MIN_PASSWORD_LENGTH + " and " + MAX_PASSWORD_LENGTH + ".";

            }

            else if (customer.SecurityAnswer.IsNullOrBlank()) {

                return "The answer to the security question must be specified.";

            }

            else if (customer.SecurityAnswer.Trim().Length > MAX_FIELD_LENGTH) {

                return "The security question answer length must be less than " + MAX_FIELD_LENGTH + ".";

            }

            else if (customer.City.IsNullOrBlank()) {

                return "Your city must be specified. If you don't live in a city please enter the one closest to you.";

            }

            else if (customer.City.Trim().Length > MAX_FIELD_LENGTH) {

                return "The city length must be less than " + MAX_FIELD_LENGTH + ".";

            }

            else if (!customer.WebSite.IsNullOrBlank() && customer.WebSite.Trim().Length > MAX_WEBSITE_FIELD_LENGTH) {

                return "The web site length must be less than " + MAX_WEBSITE_FIELD_LENGTH + ".";

            }



            return null;

        }



#if !SILVERLIGHT



        public Customer(DataRow customerRow) {

            Load(customerRow);

        }



        public DataTable GetTable() {

            DataTable table = new DataTable();

            table.Columns.Add(new DataColumn("id", typeof(String)));

            table.Columns.Add(new DataColumn("customerusername", typeof(String)));

            table.Columns.Add(new DataColumn("customerpassword", typeof(String)));

            table.Columns.Add(new DataColumn("emailaddress", typeof(String)));

            table.Columns.Add(new DataColumn("adminid", typeof(String)));

            table.Columns.Add(new DataColumn("adminmemberid", typeof(String)));

            table.Columns.Add(new DataColumn("firstname", typeof(String)));

            table.Columns.Add(new DataColumn("lastname", typeof(String)));

            table.Columns.Add(new DataColumn("city", typeof(String)));

            table.Columns.Add(new DataColumn("country", typeof(String)));

            table.Columns.Add(new DataColumn("securityquestion", typeof(String)));

            table.Columns.Add(new DataColumn("securityanswer", typeof(String)));

            table.Columns.Add(new DataColumn("website", typeof(String)));

            table.Columns.Add(new DataColumn("createdfromipaddress", typeof(String)));

            table.Columns.Add(new DataColumn("inserted", typeof(DateTime)));

            table.Columns.Add(new DataColumn("active", typeof(Boolean)));

            table.Columns.Add(new DataColumn("suspended", typeof(Boolean)));

            table.Columns.Add(new DataColumn("suspendedreason", typeof(String)));

            table.Columns.Add(new DataColumn("ipaddress", typeof(String)));

            table.Columns.Add(new DataColumn("executioncount", typeof(Int32)));

            table.Columns.Add(new DataColumn("maxexecutioncount", typeof(Int32)));

            table.Columns.Add(new DataColumn("authorisedapps", typeof(String)));

            table.Columns.Add(new DataColumn("timezone", typeof(String)));

            table.Columns.Add(new DataColumn("invitecode", typeof(String)));

            table.Columns.Add(new DataColumn("emailaddressconfirmed", typeof(Boolean)));

            return table;

        }



        public void Load(DataRow customerRow) {

            try {

                Id = new Guid(customerRow["id"] as string);

                CustomerUsername = customerRow["customerusername"] as string;

                CustomerPassword = customerRow["customerpassword"] as string;

                EmailAddress = (customerRow.Table.Columns.Contains("emailaddress") && customerRow["emailaddress"] != null) ?  customerRow["emailaddress"] as string : null;

                AdminId = (customerRow.Table.Columns.Contains("adminid") && customerRow["adminid"] != null) ? customerRow["adminid"] as string : null;

                AdminMemberId = (customerRow.Table.Columns.Contains("adminmemberid") && customerRow["adminmemberid"] != null) ? customerRow["adminmemberid"] as string : null;

                FirstName = (customerRow.Table.Columns.Contains("firstname") && customerRow["firstname"] != null) ? customerRow["firstname"] as string : null;

                LastName = (customerRow.Table.Columns.Contains("lastname") && customerRow["lastname"] != null) ? customerRow["lastname"] as string : null;

                City = (customerRow.Table.Columns.Contains("city") && customerRow["city"] != null) ? customerRow["city"] as string : null;

                Country = (customerRow.Table.Columns.Contains("country") && customerRow["country"] != null) ? customerRow["country"] as string : null;

                SecurityQuestion = (customerRow.Table.Columns.Contains("securityquestion") && customerRow["securityquestion"] != null) ? customerRow["securityquestion"] as string : null;

                SecurityAnswer = (customerRow.Table.Columns.Contains("securityanswer") && customerRow["securityanswer"] != null) ? customerRow["securityanswer"] as string : null;

                WebSite = (customerRow.Table.Columns.Contains("website") && customerRow["website"] != null) ? customerRow["website"] as string : null;

                CreatedFromIPAddress = (customerRow.Table.Columns.Contains("createdfromipaddress") && customerRow["createdfromipaddress"] != null) ? customerRow["createdfromipaddress"] as string : null;

                Inserted = (customerRow.Table.Columns.Contains("inserted") && customerRow["inserted"] != null) ? DateTimeOffset.Parse(customerRow["inserted"] as string) : DateTimeOffset.MinValue;

                Suspended = (customerRow.Table.Columns.Contains("suspended") && customerRow["suspended"] != null) ? Convert.ToBoolean(customerRow["suspended"]) : false;

                SuspendedReason = (customerRow.Table.Columns.Contains("suspendedreason") && customerRow["suspendedreason"] != null) ? customerRow["suspendedreason"] as string : null;

                ExecutionCount = (customerRow.Table.Columns.Contains("executioncount") && customerRow["executioncount"] != null) ? Convert.ToInt32(customerRow["executioncount"]) : 0;

                MaxExecutionCount = (customerRow.Table.Columns.Contains("maxexecutioncount") && customerRow["maxexecutioncount"] != null) ? Convert.ToInt32(customerRow["maxexecutioncount"]) : DEFAULT_MAXIMUM_EXECUTION_COUNT;

                AuthorisedApps = (customerRow.Table.Columns.Contains("authorisedapps") && customerRow["authorisedapps"] != null) ? customerRow["authorisedapps"] as string : null;

                EmailAddressConfirmed = (customerRow.Table.Columns.Contains("emailaddressconfirmed") && customerRow["emailaddressconfirmed"] != null) ? Convert.ToBoolean(customerRow["emailaddressconfirmed"]) : true;

                InviteCode = (customerRow.Table.Columns.Contains("invitecode") && customerRow["invitecode"] != null) ? customerRow["invitecode"] as string : null;

                TimeZone = (customerRow.Table.Columns.Contains("timezone") && customerRow["timezone"] != null) ? customerRow["timezone"] as string : null;

            }

            catch (Exception excp) {

                logger.Error("Exception Customer Load. " + excp.Message);

                throw;

            }

        }



        public Dictionary<Guid, object> Load(XmlDocument dom) {

            return SIPAssetXMLPersistor<Customer>.LoadAssetsFromXMLRecordSet(dom);

        }



#endif



        public string ToXML()

        {

            string customerXML =

                " <" + XML_ELEMENT_NAME + ">" + m_newLine +

               ToXMLNoParent() + m_newLine +

                " </" + XML_ELEMENT_NAME + ">" + m_newLine;



            return customerXML;

        }



         public string ToXMLNoParent() {

            string customerXML =

                "  <id>" + Id + "</id>" + m_newLine +

                "  <customerusername>" + CustomerUsername + "</customerusername>" + m_newLine +

                "  <customerpassword>" + CustomerPassword + "</customerpassword>" + m_newLine +

                "  <emailaddress>" + EmailAddress + "</emailaddress>" + m_newLine +

                "  <firstname>" + SafeXML.MakeSafeXML(FirstName) + "</firstname>" + m_newLine +

                "  <lastname>" + SafeXML.MakeSafeXML(LastName) + "</lastname>" + m_newLine +

                "  <city>" + SafeXML.MakeSafeXML(City) + "</city>" + m_newLine +

                "  <country>" + Country + "</country>" + m_newLine +

                "  <adminid>" + AdminId + "</adminid>" + m_newLine +

                "  <adminmemberid>" + AdminMemberId + "</adminmemberid>" + m_newLine +

                "  <website>" + SafeXML.MakeSafeXML(WebSite) + "</website>" + m_newLine +

                "  <securityquestion>" + SecurityQuestion + "</securityquestion>" + m_newLine +

                "  <securityanswer>" + SafeXML.MakeSafeXML(SecurityAnswer) + "</securityanswer>" + m_newLine +

                "  <createdfromipaddress>" + CreatedFromIPAddress + "</createdfromipaddress>" + m_newLine +

                "  <inserted>" + Inserted.ToString() + "</inserted>" + m_newLine +

                "  <active>" + Active + "</active>" + m_newLine +

                "  <suspended>" + Suspended + "</suspended>" + m_newLine +

                "  <suspendedreason>" + SuspendedReason + "</suspendedreason>" + m_newLine +

                "  <executioncount>" + ExecutionCount + "</executioncount>" + m_newLine +

                "  <maxexecutioncount>" + MaxExecutionCount + "</maxexecutioncount>" + m_newLine +

                "  <authorisedapps>" + AuthorisedApps + "</authorisedapps>" + m_newLine +

                "  <invitecode>" + InviteCode + "</invitecode>" + m_newLine +

                "  <emailaddressconfirmed>" + EmailAddressConfirmed + "</emailaddressconfirmed>";



             return customerXML;

         }



        public string GetXMLElementName() {

            return XML_ELEMENT_NAME;

        }



        public string GetXMLDocumentElementName() {

            return XML_DOCUMENT_ELEMENT_NAME;

        }

    }

}