bin/projects/dbatools/dbatools/Utility/DbaDateTimeBase.cs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
using System;
using System.Globalization;
using System.Text.RegularExpressions;

namespace Sqlcollaborative.Dbatools.Utility
{
    /// <summary>
    /// Base class for wrapping around a DateTime object
    /// </summary>
    public class DbaDateTimeBase : IComparable, IComparable<DateTime>, IEquatable<DateTime> // IFormattable,
    {
        #region Properties
        /// <summary>
        /// The core resource, containing the actual timestamp
        /// </summary>
        internal DateTime _timestamp;

        /// <summary>
        /// Gets the date component of this instance.
        /// </summary>
        public DateTime Date
        {
            get { return _timestamp.Date; }
        }

        /// <summary>
        /// Gets the day of the month represented by this instance.
        /// </summary>
        public int Day
        {
            get { return _timestamp.Day; }
        }

        /// <summary>
        /// Gets the day of the week represented by this instance.
        /// </summary>
        public DayOfWeek DayOfWeek
        {
            get { return _timestamp.DayOfWeek; }
        }

        /// <summary>
        /// Gets the day of the year represented by this instance.
        /// </summary>
        public int DayOfYear
        {
            get { return _timestamp.DayOfYear; }
        }

        /// <summary>
        /// Gets the hour component of the date represented by this instance.
        /// </summary>
        public int Hour
        {
            get { return _timestamp.Hour; }
        }

        /// <summary>
        /// Gets a value that indicates whether the time represented by this instance is based on local time, Coordinated Universal Time (UTC), or neither.
        /// </summary>
        public DateTimeKind Kind
        {
            get { return _timestamp.Kind; }
        }

        /// <summary>
        /// Gets the milliseconds component of the date represented by this instance.
        /// </summary>
        public int Millisecond
        {
            get { return _timestamp.Millisecond; }
        }

        /// <summary>
        /// Gets the minute component of the date represented by this instance.
        /// </summary>
        public int Minute
        {
            get { return _timestamp.Minute; }
        }

        /// <summary>
        /// Gets the month component of the date represented by this instance.
        /// </summary>
        public int Month
        {
            get { return _timestamp.Month; }
        }

        /// <summary>
        /// Gets the seconds component of the date represented by this instance.
        /// </summary>
        public int Second
        {
            get { return _timestamp.Second; }
        }

        /// <summary>
        /// Gets the number of ticks that represent the date and time of this instance.
        /// </summary>
        public long Ticks
        {
            get { return _timestamp.Ticks; }
        }

        /// <summary>
        /// Gets the time of day for this instance.
        /// </summary>
        public TimeSpan TimeOfDay
        {
            get { return _timestamp.TimeOfDay; }
        }

        /// <summary>
        /// Gets the year component of the date represented by this instance.
        /// </summary>
        public int Year
        {
            get { return _timestamp.Year; }
        }
        #endregion Properties

        #region Constructors
        /// <summary>
        /// Constructor that should never be called, since this class should never be instantiated. It's there for implicit calls on child classes. /// </summary> public DbaDateTimeBase() { } /// <summary> /// Constructs a generic timestamp object wrapper from an input timestamp object. /// </summary> /// <param name="Timestamp">The timestamp to wrap</param> public DbaDateTimeBase(DateTime Timestamp) { _timestamp = Timestamp; } /// <summary> /// Parses a string into a datetime object. /// </summary> /// <param name="Time">The time-string to parse</param> public DbaDateTimeBase(string Time) { _timestamp = ParseDateTime(Time); } /// <summary> /// /// </summary> /// <param name="ticks"></param> public DbaDateTimeBase(long ticks) { _timestamp = new DateTime(ticks); } /// <summary> /// /// </summary> /// <param name="ticks"></param> /// <param name="kind"></param> public DbaDateTimeBase(long ticks, System.DateTimeKind kind) { _timestamp = new DateTime(ticks, kind); } /// <summary> /// /// </summary> /// <param name="year"></param> /// <param name="month"></param> /// <param name="day"></param> public DbaDateTimeBase(int year, int month, int day) { _timestamp = new DateTime(year, month, day); } /// <summary> /// /// </summary> /// <param name="year"></param> /// <param name="month"></param> /// <param name="day"></param> /// <param name="calendar"></param> public DbaDateTimeBase(int year, int month, int day, System.Globalization.Calendar calendar) { _timestamp = new DateTime(year, month, day, calendar); } /// <summary> /// /// </summary> /// <param name="year"></param> /// <param name="month"></param> /// <param name="day"></param> /// <param name="hour"></param> /// <param name="minute"></param> /// <param name="second"></param> public DbaDateTimeBase(int year, int month, int day, int hour, int minute, int second) { _timestamp = new DateTime(year, month, day, hour, minute, second); } /// <summary> /// /// </summary> /// <param name="year"></param> /// <param name="month"></param> /// <param name="day"></param> /// <param name="hour"></param> /// <param name="minute"></param> /// <param name="second"></param> /// <param name="kind"></param> public DbaDateTimeBase(int year, int month, int day, int hour, int minute, int second, System.DateTimeKind kind) { _timestamp = new DateTime(year, month, day, hour, minute, second, kind); } /// <summary> /// /// </summary> /// <param name="year"></param> /// <param name="month"></param> /// <param name="day"></param> /// <param name="hour"></param> /// <param name="minute"></param> /// <param name="second"></param> /// <param name="calendar"></param> public DbaDateTimeBase(int year, int month, int day, int hour, int minute, int second, System.Globalization.Calendar calendar) { _timestamp = new DateTime(year, month, day, hour, minute, second, calendar); } /// <summary> /// /// </summary> /// <param name="year"></param> /// <param name="month"></param> /// <param name="day"></param> /// <param name="hour"></param> /// <param name="minute"></param> /// <param name="second"></param> /// <param name="millisecond"></param> public DbaDateTimeBase(int year, int month, int day, int hour, int minute, int second, int millisecond) { _timestamp = new DateTime(year, month, day, hour, minute, second, millisecond); } /// <summary> /// /// </summary> /// <param name="year"></param> /// <param name="month"></param> /// <param name="day"></param> /// <param name="hour"></param> /// <param name="minute"></param> /// <param name="second"></param> /// <param name="millisecond"></param> /// <param name="kind"></param> public DbaDateTimeBase(int year, int month, int day, int hour, int minute, int second, int millisecond, System.DateTimeKind kind) { _timestamp = new DateTime(year, month, day, hour, minute, second, millisecond, kind); } /// <summary> /// /// </summary> /// <param name="year"></param> /// <param name="month"></param> /// <param name="day"></param> /// <param name="hour"></param> /// <param name="minute"></param> /// <param name="second"></param> /// <param name="millisecond"></param> /// <param name="calendar"></param> public DbaDateTimeBase(int year, int month, int day, int hour, int minute, int second, int millisecond, System.Globalization.Calendar calendar) { _timestamp = new DateTime(year, month, day, hour, minute, second, millisecond, calendar); } /// <summary> /// /// </summary> /// <param name="year"></param> /// <param name="month"></param> /// <param name="day"></param> /// <param name="hour"></param> /// <param name="minute"></param> /// <param name="second"></param> /// <param name="millisecond"></param> /// <param name="calendar"></param> /// <param name="kind"></param> public DbaDateTimeBase(int year, int month, int day, int hour, int minute, int second, int millisecond, System.Globalization.Calendar calendar, System.DateTimeKind kind) { _timestamp = new DateTime(year, month, day, hour, minute, second, millisecond, calendar, kind); } #endregion Constructors #region Methods /// <summary> /// /// </summary> /// <param name="value"></param> /// <returns></returns> public DateTime Add(TimeSpan value) { return _timestamp.Add(value); } /// <summary> /// /// </summary> /// <param name="value"></param> /// <returns></returns> public DateTime AddDays(double value) { return _timestamp.AddDays(value); } /// <summary> /// /// </summary> /// <param name="value"></param> /// <returns></returns> public DateTime AddHours(double value) { return _timestamp.AddHours(value); } /// <summary> /// /// </summary> /// <param name="value"></param> /// <returns></returns> public DateTime AddMilliseconds(double value) { return _timestamp.AddMilliseconds(value); } /// <summary> /// /// </summary> /// <param name="value"></param> /// <returns></returns> public DateTime AddMinutes(double value) { return _timestamp.AddMinutes(value); } /// <summary> /// /// </summary> /// <param name="months"></param> /// <returns></returns> public DateTime AddMonths(int months) { return _timestamp.AddMonths(months); } /// <summary> /// /// </summary> /// <param name="value"></param> /// <returns></returns> public DateTime AddSeconds(double value) { return _timestamp.AddSeconds(value); } /// <summary> /// /// </summary> /// <param name="value"></param> /// <returns></returns> public DateTime AddTicks(long value) { return _timestamp.AddTicks(value); } /// <summary> /// /// </summary> /// <param name="value"></param> /// <returns></returns> public DateTime AddYears(int value) { return _timestamp.AddYears(value); } /// <summary> /// /// </summary> /// <param name="value"></param> /// <returns></returns> public int CompareTo(System.Object value) { return _timestamp.CompareTo(value); } /// <summary> /// /// </summary> /// <param name="value"></param> /// <returns></returns> public int CompareTo(DateTime value) { return _timestamp.CompareTo(value); } /// <summary> /// /// </summary> /// <param name="value"></param> /// <returns></returns> public override bool Equals(System.Object value) { return _timestamp.Equals(value); } /// <summary> /// /// </summary> /// <param name="value"></param> /// <returns></returns> public bool Equals(DateTime value) { return _timestamp.Equals(value); } /// <summary> /// /// </summary> /// <returns></returns> public string[] GetDateTimeFormats() { return _timestamp.GetDateTimeFormats(); } /// <summary> /// /// </summary> /// <param name="provider"></param> /// <returns></returns> public string[] GetDateTimeFormats(System.IFormatProvider provider) { return _timestamp.GetDateTimeFormats(provider); } /// <summary> /// /// </summary> /// <param name="format"></param> /// <returns></returns> public string[] GetDateTimeFormats(char format) { return _timestamp.GetDateTimeFormats(format); } /// <summary> /// /// </summary> /// <param name="format"></param> /// <param name="provider"></param> /// <returns></returns> public string[] GetDateTimeFormats(char format, System.IFormatProvider provider) { return _timestamp.GetDateTimeFormats(format, provider); } /// <summary> /// Retrieve base DateTime object, this is a wrapper for /// </summary> /// <returns>Base DateTime object</returns> public DateTime GetBaseObject() { return _timestamp; } /// <summary> /// /// </summary> /// <returns></returns> public override int GetHashCode() { return _timestamp.GetHashCode(); } /// <summary> /// /// </summary> /// <returns></returns> public System.TypeCode GetTypeCode() { return _timestamp.GetTypeCode(); } /// <summary> /// /// </summary> /// <returns></returns> public bool IsDaylightSavingTime() { return _timestamp.IsDaylightSavingTime(); } /// <summary> /// /// </summary> /// <param name="value"></param> /// <returns></returns> public TimeSpan Subtract(DateTime value) { return _timestamp.Subtract(value); } /// <summary> /// /// </summary> /// <param name="value"></param> /// <returns></returns> public DateTime Subtract(TimeSpan value) { return _timestamp.Subtract(value); } /// <summary> /// /// </summary> /// <returns></returns> public long ToBinary() { return _timestamp.ToBinary(); } /// <summary> /// /// </summary> /// <returns></returns> public long ToFileTime() { return _timestamp.ToFileTime(); } /// <summary> /// /// </summary> /// <returns></returns> public long ToFileTimeUtc() { return _timestamp.ToFileTimeUtc(); } /// <summary> /// /// </summary> /// <returns></returns> public DateTime ToLocalTime() { return _timestamp.ToLocalTime(); } /// <summary> /// /// </summary> /// <returns></returns> public string ToLongDateString() { return _timestamp.ToLongDateString(); } /// <summary> /// /// </summary> /// <returns></returns> public string ToLongTimeString() { return _timestamp.ToLongTimeString(); } /// <summary> /// /// </summary> /// <returns></returns> public double ToOADate() { return _timestamp.ToOADate(); } /// <summary> /// /// </summary> /// <returns></returns> public string ToShortDateString() { return _timestamp.ToShortDateString(); } /// <summary> /// /// </summary> /// <returns></returns> public string ToShortTimeString() { return _timestamp.ToShortTimeString(); } /// <summary> /// /// </summary> /// <param name="format"></param> /// <returns></returns> public string ToString(string format) { return _timestamp.ToString(format); } /// <summary> /// /// </summary> /// <param name="provider"></param> /// <returns></returns> public string ToString(System.IFormatProvider provider) { return _timestamp.ToString(provider); } /// <summary> /// /// </summary> /// <param name="format"></param> /// <param name="provider"></param> /// <returns></returns> public string ToString(string format, System.IFormatProvider provider) { return _timestamp.ToString(format, provider); } /// <summary> /// /// </summary> /// <returns></returns> public DateTime ToUniversalTime() { return _timestamp.ToUniversalTime(); } /// <summary> /// Parses input string into datetime /// </summary> /// <param name="Value">The string to parse</param> /// <returns>The resultant datetime.</returns> internal static DateTime ParseDateTime(string Value) { if (String.IsNullOrWhiteSpace(Value)) throw new ArgumentNullException("Cannot parse empty string!"); try { return DateTime.Parse(Value, CultureInfo.CurrentCulture); } catch { } try { return DateTime.Parse(Value, CultureInfo.InvariantCulture); } catch { } bool positive = !(Value.Contains("-")); string tempValue = Value.Replace("-", "").Trim(); bool date = UtilityHost.IsLike(tempValue, "D *"); if (date) tempValue = tempValue.Substring(2); TimeSpan timeResult = new TimeSpan(); foreach (string element in tempValue.Split(' '))
            {
                if (Regex.IsMatch(element, @"^\d+$"))
                    timeResult = timeResult.Add(new TimeSpan(0, 0, Int32.Parse(element)));
                else if (UtilityHost.IsLike(element, "*ms") && Regex.IsMatch(element, @"^\d+ms$", RegexOptions.IgnoreCase))
                    timeResult = timeResult.Add(new TimeSpan(0, 0, 0, 0, Int32.Parse(Regex.Match(element, @"^(\d+)ms$", RegexOptions.IgnoreCase).Groups[1].Value)));
                else if (UtilityHost.IsLike(element, "*s") && Regex.IsMatch(element, @"^\d+s$", RegexOptions.IgnoreCase))
                    timeResult = timeResult.Add(new TimeSpan(0, 0, Int32.Parse(Regex.Match(element, @"^(\d+)s$", RegexOptions.IgnoreCase).Groups[1].Value)));
                else if (UtilityHost.IsLike(element, "*m") && Regex.IsMatch(element, @"^\d+m$", RegexOptions.IgnoreCase))
                    timeResult = timeResult.Add(new TimeSpan(0, Int32.Parse(Regex.Match(element, @"^(\d+)m$", RegexOptions.IgnoreCase).Groups[1].Value), 0));
                else if (UtilityHost.IsLike(element, "*h") && Regex.IsMatch(element, @"^\d+h$", RegexOptions.IgnoreCase))
                    timeResult = timeResult.Add(new TimeSpan(Int32.Parse(Regex.Match(element, @"^(\d+)h$", RegexOptions.IgnoreCase).Groups[1].Value), 0, 0));
                else if (UtilityHost.IsLike(element, "*d") && Regex.IsMatch(element, @"^\d+d$", RegexOptions.IgnoreCase))
                    timeResult = timeResult.Add(new TimeSpan(Int32.Parse(Regex.Match(element, @"^(\d+)d$", RegexOptions.IgnoreCase).Groups[1].Value), 0, 0, 0));
                else
                    throw new ArgumentException(String.Format("Failed to parse as timespan: {0} at {1}", Value, element));
            }
 
            DateTime result;
            if (!positive)
                result = DateTime.Now.Add(timeResult.Negate());
            else
                result = DateTime.Now.Add(timeResult);
 
            if (date)
                return result.Date;
            return result;
        }
        #endregion Methods
 
        #region Operators
        /// <summary>
        ///
        /// </summary>
        /// <param name="Timestamp"></param>
        /// <param name="Duration"></param>
        /// <returns></returns>
        public static DbaDateTimeBase operator +(DbaDateTimeBase Timestamp, TimeSpan Duration)
        {
            return Timestamp.Add(Duration);
        }
 
        /// <summary>
        ///
        /// </summary>
        /// <param name="Timestamp"></param>
        /// <param name="Duration"></param>
        /// <returns></returns>
        public static DbaDateTimeBase operator -(DbaDateTimeBase Timestamp, TimeSpan Duration)
        {
            return Timestamp.Subtract(Duration);
        }
 
        /// <summary>
        ///
        /// </summary>
        /// <param name="Timestamp1"></param>
        /// <param name="Timestamp2"></param>
        /// <returns></returns>
        public static bool operator ==(DbaDateTimeBase Timestamp1, DbaDateTimeBase Timestamp2)
        {
            return (Timestamp1.GetBaseObject().Equals(Timestamp2.GetBaseObject()));
        }
 
        /// <summary>
        ///
        /// </summary>
        /// <param name="Timestamp1"></param>
        /// <param name="Timestamp2"></param>
        /// <returns></returns>
        public static bool operator !=(DbaDateTimeBase Timestamp1, DbaDateTimeBase Timestamp2)
        {
            return (!Timestamp1.GetBaseObject().Equals(Timestamp2.GetBaseObject()));
        }
 
        /// <summary>
        ///
        /// </summary>
        /// <param name="Timestamp1"></param>
        /// <param name="Timestamp2"></param>
        /// <returns></returns>
        public static bool operator >(DbaDateTimeBase Timestamp1, DbaDateTimeBase Timestamp2)
        {
            return Timestamp1.GetBaseObject() > Timestamp2.GetBaseObject();
        }
 
        /// <summary>
        ///
        /// </summary>
        /// <param name="Timestamp1"></param>
        /// <param name="Timestamp2"></param>
        /// <returns></returns>
        public static bool operator <(DbaDateTimeBase Timestamp1, DbaDateTimeBase Timestamp2)
        {
            return Timestamp1.GetBaseObject() < Timestamp2.GetBaseObject();
        }
 
        /// <summary>
        ///
        /// </summary>
        /// <param name="Timestamp1"></param>
        /// <param name="Timestamp2"></param>
        /// <returns></returns>
        public static bool operator >=(DbaDateTimeBase Timestamp1, DbaDateTimeBase Timestamp2)
        {
            return Timestamp1.GetBaseObject() >= Timestamp2.GetBaseObject();
        }
 
        /// <summary>
        ///
        /// </summary>
        /// <param name="Timestamp1"></param>
        /// <param name="Timestamp2"></param>
        /// <returns></returns>
        public static bool operator <=(DbaDateTimeBase Timestamp1, DbaDateTimeBase Timestamp2)
        {
            return Timestamp1.GetBaseObject() <= Timestamp2.GetBaseObject();
        }
        #endregion Operators
 
        #region Implicit Conversions
        /// <summary>
        /// Implicitly convert DbaDateTimeBase to DateTime
        /// </summary>
        /// <param name="Base">The source object to convert</param>
        public static implicit operator DateTime(DbaDateTimeBase Base)
        {
            return Base.GetBaseObject();
        }
 
        /// <summary>
        /// Implicitly convert DateTime to DbaDateTimeBase
        /// </summary>
        /// <param name="Base">The object to convert</param>
        public static implicit operator DbaDateTimeBase(DateTime Base)
        {
            return new DbaDateTimeBase(Base.Ticks, Base.Kind);
        }
        #endregion Implicit Conversions
    }
}