AcSessions.cs

Go to the documentation of this file.

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using System.Xml.Linq;

namespace AcUtils
{

    [Serializable]
    public sealed class AcSession : IFormattable, IEquatable<AcSession>, IComparable<AcSession>, IComparable
    {
        #region class variables
        private string _name; // user's principal name
        private string _host; // IP address of the host machine
        private AcDuration _duration; // length of time user has been logged on
        #endregion

        internal AcSession() { }

        #region Equality comparison

        public bool Equals(AcSession other)
        {
            if (ReferenceEquals(other, null)) return false;
            if (ReferenceEquals(this, other)) return true;
            var left = Tuple.Create(Name, Host);
            var right = Tuple.Create(other.Name, other.Host);
            return left.Equals(right);
        }

        public override bool Equals(object other)
        {
            if (ReferenceEquals(other, null)) return false;
            if (ReferenceEquals(this, other)) return true;
            if (GetType() != other.GetType()) return false;
            return this.Equals(other as AcSession);
        }

        public override int GetHashCode()
        {
            var hash = Tuple.Create(Name, Host);
            return hash.GetHashCode();
        }
        #endregion

        #region Order comparison


        public int CompareTo(AcSession other)
        {
            int result;
            if (AcSession.ReferenceEquals(this, other))
                result = 0;
            else
            {
                result = Duration.CompareTo(other.Duration);
                if (result == 0)
                    result = Name.CompareTo(other.Name);
            }

            //return -1 * result; // sort in reverse order to show longer sessions first
            return result;
        }

        int IComparable.CompareTo(object other)
        {
            if (!(other is AcSession))
                throw new ArgumentException("Argument is not an AcSession", "other");
            AcSession o = (AcSession)other;
            return this.CompareTo(o);
        }
        #endregion

        public string Name
        {
            get { return _name ?? String.Empty; }
            internal set { _name = value; }
        }

        public string Host
        {
            get { return _host ?? String.Empty; }
            internal set { _host = value; }
        }


        public AcDuration Duration
        {
            get { return _duration; }
            internal set { _duration = value; }
        }

        #region ToString
        public string ToString(string format, IFormatProvider provider)
        {
            if (provider != null)
            {
                ICustomFormatter fmt = provider.GetFormat(this.GetType()) as ICustomFormatter;
                if (fmt != null)
                    return fmt.Format(format, this, provider);
            }

            if (String.IsNullOrEmpty(format))
                format = "G";

            switch (format.ToUpperInvariant())
            {
                case "G": // default when not using a format specifier
                    return $"{Name}, {Host}, {Duration}";
                case "N": // user's AccuRev principal name
                    return Name;
                case "H": // IP address of the host machine
                    return Host;
                case "D": // length of time user has been logged on
                    return Duration.ToString();
                default:
                    throw new FormatException($"The {format} format string is not supported.");
            }
        }

        // Calls ToString(string, IFormatProvider) version with a null IFormatProvider argument.
        public string ToString(string format)
        {
            return ToString(format, null);
        }

        // Calls ToString(string, IFormatProvider) version with the general format and a null IFormatProvider argument.
        public override string ToString()
        {
            return ToString("G", null);
        }
        #endregion ToString
    }

    [Serializable]
    public sealed class AcSessions : List<AcSession>
    {
        #region class variables
        [NonSerialized] private readonly object _locker = new object();
        #endregion

        #region object construction:


        public AcSessions() { }


        public async Task<bool> initAsync()
        {
            bool ret = false; // assume failure
            try
            {
                AcResult r = await AcCommand.runAsync("show -fx sessions").ConfigureAwait(false);
                if (r != null && r.RetVal == 0)
                {
                    XElement xml = XElement.Parse(r.CmdResult);
                    foreach (XElement e in xml.Elements("Element"))
                    {
                        AcSession session = new AcSession();
                        session.Name = (string)e.Attribute("Username");
                        session.Host = (string)e.Attribute("Host");
                        string temp = (string)e.Attribute("Duration");
                        if (!String.Equals(temp, "(timed out)"))
                        {
                            double duration = double.Parse(temp);
                            session.Duration = TimeSpan.FromMinutes(duration);
                        }

                        lock (_locker) { Add(session); }
                    }

                    ret = true; // operation succeeded
                }
            }

            catch (AcUtilsException ecx)
            {
                AcDebug.Log($"AcUtilsException caught and logged in AcSessions.initAsync{Environment.NewLine}{ecx.Message}");
            }

            catch (Exception ecx)
            {
                AcDebug.Log($"Exception caught and logged in AcSessions.initAsync{Environment.NewLine}{ecx.Message}");
            }

            return ret;
        }
        #endregion
    }
}