Reports - Add Users activities

1 files changed, 325 insertions, 212 deletions

diff --git a/MediaBrowser.Api/Reports/Common/ReportBuilderBase.cs b/MediaBrowser.Api/Reports/Common/ReportBuilderBase.cs
index af6dc997c..939bf280a 100644
--- a/MediaBrowser.Api/Reports/Common/ReportBuilderBase.cs
+++ b/MediaBrowser.Api/Reports/Common/ReportBuilderBase.cs
@@ -13,217 +13,330 @@ using System.Threading.Tasks;
 
 namespace MediaBrowser.Api.Reports
 {
-	/// <summary> A report builder base. </summary>
-	public class ReportBuilderBase
-	{
-		/// <summary>
-		/// Initializes a new instance of the MediaBrowser.Api.Reports.ReportBuilderBase class. </summary>
-		/// <param name="libraryManager"> Manager for library. </param>
-		public ReportBuilderBase(ILibraryManager libraryManager)
-		{
-			_libraryManager = libraryManager;
-		}
-
-		/// <summary> Manager for library. </summary>
-		protected readonly ILibraryManager _libraryManager;
-
-		/// <summary> Gets audio stream. </summary>
-		/// <param name="item"> The item. </param>
-		/// <returns> The audio stream. </returns>
-		protected string GetAudioStream(BaseItem item)
-		{
-			var stream = GetStream(item, MediaStreamType.Audio);
-			if (stream != null)
-				return stream.Codec.ToUpper() == "DCA" ? stream.Profile : stream.Codec.
-				ToUpper();
-
-			return string.Empty;
-		}
-
-		/// <summary> Gets an episode. </summary>
-		/// <param name="item"> The item. </param>
-		/// <returns> The episode. </returns>
-		protected string GetEpisode(BaseItem item)
-		{
-
-			if (item.GetClientTypeName() == ChannelMediaContentType.Episode.ToString() && item.ParentIndexNumber != null)
-				return "Season " + item.ParentIndexNumber;
-			else
-				return item.Name;
-		}
-
-		/// <summary> Gets a genre. </summary>
-		/// <param name="name"> The name. </param>
-		/// <returns> The genre. </returns>
-		protected Genre GetGenre(string name)
-		{
-			if (string.IsNullOrEmpty(name))
-				return null;
-			return _libraryManager.GetGenre(name);
-		}
-
-		/// <summary> Gets genre identifier. </summary>
-		/// <param name="name"> The name. </param>
-		/// <returns> The genre identifier. </returns>
-		protected string GetGenreID(string name)
-		{
-			if (string.IsNullOrEmpty(name))
-				return string.Empty;
-			return string.Format("{0:N}",
-					GetGenre(name).Id);
-		}
-
-		/// <summary> Gets list as string. </summary>
-		/// <param name="items"> The items. </param>
-		/// <returns> The list as string. </returns>
-		protected string GetListAsString(List<string> items)
-		{
-			return String.Join("; ", items);
-		}
-
-		/// <summary> Gets media source information. </summary>
-		/// <param name="item"> The item. </param>
-		/// <returns> The media source information. </returns>
-		protected MediaSourceInfo GetMediaSourceInfo(BaseItem item)
-		{
-			var mediaSource = item as IHasMediaSources;
-			if (mediaSource != null)
-				return mediaSource.GetMediaSources(false).FirstOrDefault(n => n.Type == MediaSourceType.Default);
-
-			return null;
-		}
-
-		/// <summary> Gets an object. </summary>
-		/// <typeparam name="T"> Generic type parameter. </typeparam>
-		/// <typeparam name="R"> Type of the r. </typeparam>
-		/// <param name="item"> The item. </param>
-		/// <param name="function"> The function. </param>
-		/// <param name="defaultValue"> The default value. </param>
-		/// <returns> The object. </returns>
-		protected R GetObject<T, R>(BaseItem item, Func<T, R> function, R defaultValue = default(R)) where T : class
-		{
-			var value = item as T;
-			if (value != null && function != null)
-				return function(value);
-			else
-				return defaultValue;
-		}
-
-		/// <summary> Gets a person. </summary>
-		/// <param name="name"> The name. </param>
-		/// <returns> The person. </returns>
-		protected Person GetPerson(string name)
-		{
-			if (string.IsNullOrEmpty(name))
-				return null;
-			return _libraryManager.GetPerson(name);
-		}
-
-		/// <summary> Gets person identifier. </summary>
-		/// <param name="name"> The name. </param>
-		/// <returns> The person identifier. </returns>
-		protected string GetPersonID(string name)
-		{
-			if (string.IsNullOrEmpty(name))
-				return string.Empty;
-			return string.Format("{0:N}",
-					GetPerson(name).Id);
-		}
-
-		/// <summary> Gets runtime date time. </summary>
-		/// <param name="runtime"> The runtime. </param>
-		/// <returns> The runtime date time. </returns>
-		protected double? GetRuntimeDateTime(long? runtime)
-		{
-			if (runtime.HasValue)
+    /// <summary> A report builder base. </summary>
+    public abstract class ReportBuilderBase
+    {
+
+        #region [Constructors]
+
+        /// <summary>
+        /// Initializes a new instance of the MediaBrowser.Api.Reports.ReportBuilderBase class. </summary>
+        /// <param name="libraryManager"> Manager for library. </param>
+        public ReportBuilderBase(ILibraryManager libraryManager)
+        {
+            _libraryManager = libraryManager;
+        }
+
+        #endregion
+
+        #region [Protected Fields]
+
+        /// <summary> Manager for library. </summary>
+        protected readonly ILibraryManager _libraryManager; ///< Manager for library
+
+        protected Func<bool, string> GetBoolString = s => s == true ? "x" : ""; ///< .
+
+        #endregion
+
+        #region [Protected Internal Methods]
+
+        /// <summary> Gets the headers. </summary>
+        /// <typeparam name="H"> Type of the header. </typeparam>
+        /// <param name="request"> The request. </param>
+        /// <returns> The headers. </returns>
+        protected internal abstract List<ReportHeader> GetHeaders<H>(H request) where H : IReportsHeader;
+
+        #endregion
+
+        #region [Protected Methods]
+
+        /// <summary> Gets active headers. </summary>
+        /// <typeparam name="T"> Generic type parameter. </typeparam>
+        /// <param name="options"> Options for controlling the operation. </param>
+        /// <returns> The active headers. </returns>
+        protected List<ReportHeader> GetActiveHeaders<T>(List<ReportOptions<T>> options)
+        {
+            List<ReportHeader> headers = new List<ReportHeader>();
+            foreach (ReportOptions<T> option in options.Where(x => x.Header.Visible == true))
+            {
+                headers.Add(option.Header);
+            }
+
+            return headers;
+        }
+
+        /// <summary> Gets audio stream. </summary>
+        /// <param name="item"> The item. </param>
+        /// <returns> The audio stream. </returns>
+        protected string GetAudioStream(BaseItem item)
+        {
+            var stream = GetStream(item, MediaStreamType.Audio);
+            if (stream != null)
+                return stream.Codec.ToUpper() == "DCA" ? stream.Profile : stream.Codec.
+                ToUpper();
+
+            return string.Empty;
+        }
+
+        /// <summary> Gets an episode. </summary>
+        /// <param name="item"> The item. </param>
+        /// <returns> The episode. </returns>
+        protected string GetEpisode(BaseItem item)
+        {
+
+            if (item.GetClientTypeName() == ChannelMediaContentType.Episode.ToString() && item.ParentIndexNumber != null)
+                return "Season " + item.ParentIndexNumber;
+            else
+                return item.Name;
+        }
+
+        /// <summary> Gets a genre. </summary>
+        /// <param name="name"> The name. </param>
+        /// <returns> The genre. </returns>
+        protected Genre GetGenre(string name)
+        {
+            if (string.IsNullOrEmpty(name))
+                return null;
+            return _libraryManager.GetGenre(name);
+        }
+
+        /// <summary> Gets genre identifier. </summary>
+        /// <param name="name"> The name. </param>
+        /// <returns> The genre identifier. </returns>
+        protected string GetGenreID(string name)
+        {
+            if (string.IsNullOrEmpty(name))
+                return string.Empty;
+            return string.Format("{0:N}",
+                    GetGenre(name).Id);
+        }
+
+        /// <summary> Gets the headers. </summary>
+        /// <typeparam name="T"> Generic type parameter. </typeparam>
+        /// <param name="options"> Options for controlling the operation. </param>
+        /// <returns> The headers. </returns>
+        protected List<ReportHeader> GetHeaders<T>(List<ReportOptions<T>> options)
+        {
+            List<ReportHeader> headers = new List<ReportHeader>();
+            foreach (ReportOptions<T> option in options)
+            {
+                headers.Add(option.Header);
+            }
+
+            return headers;
+        }
+
+        /// <summary> Gets the headers. </summary>
+        /// <typeparam name="T"> Generic type parameter. </typeparam>
+        /// <param name="request"> The request. </param>
+        /// <param name="getHeadersMetadata"> The get headers metadata. </param>
+        /// <param name="getOptions"> Options for controlling the get. </param>
+        /// <returns> The headers. </returns>
+        protected List<ReportHeader> GetHeaders<T>(IReportsHeader request, Func<List<HeaderMetadata>> getHeadersMetadata, Func<HeaderMetadata, ReportOptions<T>> getOptions)
+        {
+            List<ReportOptions<T>> options = this.GetReportOptions(request, getHeadersMetadata, getOptions);
+            return this.GetHeaders(options);
+        }
+
+        /// <summary> Gets list as string. </summary>
+        /// <param name="items"> The items. </param>
+        /// <returns> The list as string. </returns>
+        protected string GetListAsString(List<string> items)
+        {
+            return String.Join("; ", items);
+        }
+
+        /// <summary> Gets localized header. </summary>
+        /// <param name="internalHeader"> The internal header. </param>
+        /// <returns> The localized header. </returns>
+        protected static string GetLocalizedHeader(HeaderMetadata internalHeader)
+        {
+            string headerName = "";
+            if (internalHeader != HeaderMetadata.None)
+            {
+                string localHeader = "Header" + internalHeader.ToString();
+                headerName = internalHeader != HeaderMetadata.None ? ReportHelper.GetJavaScriptLocalizedString(localHeader) : "";
+                if (string.Compare(localHeader, headerName, StringComparison.CurrentCultureIgnoreCase) == 0)
+                    headerName = ReportHelper.GetServerLocalizedString(localHeader);
+            }
+            return headerName;
+        }
+
+        /// <summary> Gets media source information. </summary>
+        /// <param name="item"> The item. </param>
+        /// <returns> The media source information. </returns>
+        protected MediaSourceInfo GetMediaSourceInfo(BaseItem item)
+        {
+            var mediaSource = item as IHasMediaSources;
+            if (mediaSource != null)
+                return mediaSource.GetMediaSources(false).FirstOrDefault(n => n.Type == MediaSourceType.Default);
+
+            return null;
+        }
+
+        /// <summary> Gets an object. </summary>
+        /// <typeparam name="T"> Generic type parameter. </typeparam>
+        /// <typeparam name="R"> Type of the r. </typeparam>
+        /// <param name="item"> The item. </param>
+        /// <param name="function"> The function. </param>
+        /// <param name="defaultValue"> The default value. </param>
+        /// <returns> The object. </returns>
+        protected R GetObject<T, R>(BaseItem item, Func<T, R> function, R defaultValue = default(R)) where T : class
+        {
+            var value = item as T;
+            if (value != null && function != null)
+                return function(value);
+            else
+                return defaultValue;
+        }
+
+        /// <summary> Gets a person. </summary>
+        /// <param name="name"> The name. </param>
+        /// <returns> The person. </returns>
+        protected Person GetPerson(string name)
+        {
+            if (string.IsNullOrEmpty(name))
+                return null;
+            return _libraryManager.GetPerson(name);
+        }
+
+        /// <summary> Gets person identifier. </summary>
+        /// <param name="name"> The name. </param>
+        /// <returns> The person identifier. </returns>
+        protected string GetPersonID(string name)
+        {
+            if (string.IsNullOrEmpty(name))
+                return string.Empty;
+            return string.Format("{0:N}",
+                    GetPerson(name).Id);
+        }
+
+        /// <summary> Gets report options. </summary>
+        /// <typeparam name="T"> Generic type parameter. </typeparam>
+        /// <param name="request"> The request. </param>
+        /// <param name="getHeadersMetadata"> The get headers metadata. </param>
+        /// <param name="getOptions"> Options for controlling the get. </param>
+        /// <returns> The report options. </returns>
+        protected List<ReportOptions<T>> GetReportOptions<T>(IReportsHeader request, Func<List<HeaderMetadata>> getHeadersMetadata, Func<HeaderMetadata, ReportOptions<T>> getOptions)
+        {
+            List<HeaderMetadata> headersMetadata = getHeadersMetadata();
+            List<ReportOptions<T>> options = new List<ReportOptions<T>>();
+            foreach (HeaderMetadata header in headersMetadata)
+            {
+                options.Add(getOptions(header));
+            }
+
+            if (request != null && !string.IsNullOrEmpty(request.ReportColumns))
+            {
+                List<HeaderMetadata> headersMetadataFiltered = ReportHelper.GetFilteredReportHeaderMetadata(request.ReportColumns, () => headersMetadata);
+                foreach (ReportHeader header in options.Select(x => x.Header))
+                {
+                    if (!headersMetadataFiltered.Contains(header.FieldName))
+                    {
+                        header.Visible = false;
+                    }
+                }
+            }
+
+            return options;
+        }
+
+        /// <summary> Gets runtime date time. </summary>
+        /// <param name="runtime"> The runtime. </param>
+        /// <returns> The runtime date time. </returns>
+        protected double? GetRuntimeDateTime(long? runtime)
+        {
+            if (runtime.HasValue)
                 return Math.Ceiling(new TimeSpan(runtime.Value).TotalMinutes);
-			return null;
-		}
-
-		/// <summary> Gets series production year. </summary>
-		/// <param name="item"> The item. </param>
-		/// <returns> The series production year. </returns>
-		protected string GetSeriesProductionYear(BaseItem item)
-		{
-
-			string productionYear = item.ProductionYear.ToString();
-			var series = item as Series;
-			if (series == null)
-			{
-				if (item.ProductionYear == null || item.ProductionYear == 0)
-					return string.Empty;
-				return productionYear;
-			}
-
-			if (series.Status == SeriesStatus.Continuing)
-				return productionYear += "-Present";
-
-			if (series.EndDate != null && series.EndDate.Value.Year != series.ProductionYear)
-				return productionYear += "-" + series.EndDate.Value.Year;
-
-			return productionYear;
-		}
-
-		/// <summary> Gets a stream. </summary>
-		/// <param name="item"> The item. </param>
-		/// <param name="streamType"> Type of the stream. </param>
-		/// <returns> The stream. </returns>
-		protected MediaStream GetStream(BaseItem item, MediaStreamType streamType)
-		{
-			var itemInfo = GetMediaSourceInfo(item);
-			if (itemInfo != null)
-				return itemInfo.MediaStreams.FirstOrDefault(n => n.Type == streamType);
-
-			return null;
-		}
-
-		/// <summary> Gets a studio. </summary>
-		/// <param name="name"> The name. </param>
-		/// <returns> The studio. </returns>
-		protected Studio GetStudio(string name)
-		{
-			if (string.IsNullOrEmpty(name))
-				return null;
-			return _libraryManager.GetStudio(name);
-		}
-
-		/// <summary> Gets studio identifier. </summary>
-		/// <param name="name"> The name. </param>
-		/// <returns> The studio identifier. </returns>
-		protected string GetStudioID(string name)
-		{
-			if (string.IsNullOrEmpty(name))
-				return string.Empty;
-			return string.Format("{0:N}",
-					GetStudio(name).Id);
-		}
-
-		/// <summary> Gets video resolution. </summary>
-		/// <param name="item"> The item. </param>
-		/// <returns> The video resolution. </returns>
-		protected string GetVideoResolution(BaseItem item)
-		{
-			var stream = GetStream(item,
-					MediaStreamType.Video);
-			if (stream != null && stream.Width != null)
-				return string.Format("{0} * {1}",
-						stream.Width,
-						(stream.Height != null ? stream.Height.ToString() : "-"));
-
-			return string.Empty;
-		}
-
-		/// <summary> Gets video stream. </summary>
-		/// <param name="item"> The item. </param>
-		/// <returns> The video stream. </returns>
-		protected string GetVideoStream(BaseItem item)
-		{
-			var stream = GetStream(item, MediaStreamType.Video);
-			if (stream != null)
-				return stream.Codec.ToUpper();
-
-			return string.Empty;
-		}
-
-	}
+            return null;
+        }
+
+        /// <summary> Gets series production year. </summary>
+        /// <param name="item"> The item. </param>
+        /// <returns> The series production year. </returns>
+        protected string GetSeriesProductionYear(BaseItem item)
+        {
+
+            string productionYear = item.ProductionYear.ToString();
+            var series = item as Series;
+            if (series == null)
+            {
+                if (item.ProductionYear == null || item.ProductionYear == 0)
+                    return string.Empty;
+                return productionYear;
+            }
+
+            if (series.Status == SeriesStatus.Continuing)
+                return productionYear += "-Present";
+
+            if (series.EndDate != null && series.EndDate.Value.Year != series.ProductionYear)
+                return productionYear += "-" + series.EndDate.Value.Year;
+
+            return productionYear;
+        }
+
+        /// <summary> Gets a stream. </summary>
+        /// <param name="item"> The item. </param>
+        /// <param name="streamType"> Type of the stream. </param>
+        /// <returns> The stream. </returns>
+        protected MediaStream GetStream(BaseItem item, MediaStreamType streamType)
+        {
+            var itemInfo = GetMediaSourceInfo(item);
+            if (itemInfo != null)
+                return itemInfo.MediaStreams.FirstOrDefault(n => n.Type == streamType);
+
+            return null;
+        }
+
+        /// <summary> Gets a studio. </summary>
+        /// <param name="name"> The name. </param>
+        /// <returns> The studio. </returns>
+        protected Studio GetStudio(string name)
+        {
+            if (string.IsNullOrEmpty(name))
+                return null;
+            return _libraryManager.GetStudio(name);
+        }
+
+        /// <summary> Gets studio identifier. </summary>
+        /// <param name="name"> The name. </param>
+        /// <returns> The studio identifier. </returns>
+        protected string GetStudioID(string name)
+        {
+            if (string.IsNullOrEmpty(name))
+                return string.Empty;
+            return string.Format("{0:N}",
+                    GetStudio(name).Id);
+        }
+
+        /// <summary> Gets video resolution. </summary>
+        /// <param name="item"> The item. </param>
+        /// <returns> The video resolution. </returns>
+        protected string GetVideoResolution(BaseItem item)
+        {
+            var stream = GetStream(item,
+                    MediaStreamType.Video);
+            if (stream != null && stream.Width != null)
+                return string.Format("{0} * {1}",
+                        stream.Width,
+                        (stream.Height != null ? stream.Height.ToString() : "-"));
+
+            return string.Empty;
+        }
+
+        /// <summary> Gets video stream. </summary>
+        /// <param name="item"> The item. </param>
+        /// <returns> The video stream. </returns>
+        protected string GetVideoStream(BaseItem item)
+        {
+            var stream = GetStream(item, MediaStreamType.Video);
+            if (stream != null)
+                return stream.Codec.ToUpper();
+
+            return string.Empty;
+        }
+
+        #endregion
+
+    }
 }