Backupppert/jellyfin
0
0
Fork 0
mirror of https://github.com/jellyfin/jellyfin.git synced 2024-07-25 06:58:40 +02:00
Code Issues Packages Projects Releases Wiki Activity

Reports - Add Users activities

Browse source
This commit is contained in:
Tavares André 2015-06-11 20:25:12 +02:00
parent ff26b09583
commit 1e07dbec63
19 changed files with 2626 additions and 1930 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
MediaBrowser.Api/MediaBrowser.Api.csproj
View file

@ -84,6 +84,8 @@
<Compile Include="Playback\MediaInfoService.cs" /> <Compile Include="Playback\MediaInfoService.cs" />
<Compile Include="Playback\TranscodingThrottler.cs" /> <Compile Include="Playback\TranscodingThrottler.cs" />
<Compile Include="PlaylistService.cs" /> <Compile Include="PlaylistService.cs" />
<Compile Include="Reports\Activities\ReportActivitiesBuilder.cs" />
<Compile Include="Reports\Common\HeaderActivitiesMetadata.cs" />
<Compile Include="Reports\Common\HeaderMetadata.cs" /> <Compile Include="Reports\Common\HeaderMetadata.cs" />
<Compile Include="Reports\Common\ItemViewType.cs" /> <Compile Include="Reports\Common\ItemViewType.cs" />
<Compile Include="Reports\Common\ReportBuilderBase.cs" /> <Compile Include="Reports\Common\ReportBuilderBase.cs" />
@ -91,15 +93,16 @@
<Compile Include="Reports\Common\ReportFieldType.cs" /> <Compile Include="Reports\Common\ReportFieldType.cs" />
<Compile Include="Reports\Common\ReportHeaderIdType.cs" /> <Compile Include="Reports\Common\ReportHeaderIdType.cs" />
<Compile Include="Reports\Common\ReportHelper.cs" /> <Compile Include="Reports\Common\ReportHelper.cs" />
<Compile Include="Reports\Common\ReportIncludeItemTypes.cs" />
<Compile Include="Reports\Common\ReportViewType.cs" /> <Compile Include="Reports\Common\ReportViewType.cs" />
<Compile Include="Reports\Data\ReportBuilder.cs" /> <Compile Include="Reports\Data\ReportBuilder.cs" />
<Compile Include="Reports\Data\ReportExport.cs" /> <Compile Include="Reports\Data\ReportExport.cs" />
<Compile Include="Reports\Data\ReportGroup.cs" />
<Compile Include="Reports\Data\ReportHeader.cs" />
<Compile Include="Reports\Data\ReportItem.cs" />
<Compile Include="Reports\Data\ReportOptions.cs" /> <Compile Include="Reports\Data\ReportOptions.cs" />
<Compile Include="Reports\Data\ReportResult.cs" /> <Compile Include="Reports\Model\ReportGroup.cs" />
<Compile Include="Reports\Data\ReportRow.cs" /> <Compile Include="Reports\Model\ReportHeader.cs" />
<Compile Include="Reports\Model\ReportItem.cs" />
<Compile Include="Reports\Model\ReportResult.cs" />
<Compile Include="Reports\Model\ReportRow.cs" />
<Compile Include="Reports\ReportRequests.cs" /> <Compile Include="Reports\ReportRequests.cs" />
<Compile Include="Reports\ReportsService.cs" /> <Compile Include="Reports\ReportsService.cs" />
<Compile Include="Reports\Stat\ReportStatBuilder.cs" /> <Compile Include="Reports\Stat\ReportStatBuilder.cs" />
@ -204,6 +207,13 @@
<PostBuildEvent> <PostBuildEvent>
</PostBuildEvent> </PostBuildEvent>
</PropertyGroup> </PropertyGroup>
<Import Project="$(SolutionDir)\.nuget\NuGet.targets" Condition="Exists('$(SolutionDir)\.nuget\NuGet.targets')" />
<Target Name="EnsureNuGetPackageBuildImports" BeforeTargets="PrepareForBuild">
<PropertyGroup>
<ErrorText>This project references NuGet package(s) that are missing on this computer. Enable NuGet Package Restore to download them. For more information, see http://go.microsoft.com/fwlink/?LinkID=322105. The missing file is {0}.</ErrorText>
</PropertyGroup>
<Error Condition="!Exists('$(SolutionDir)\.nuget\NuGet.targets')" Text="$([System.String]::Format('$(ErrorText)', '$(SolutionDir)\.nuget\NuGet.targets'))" />
</Target>
<!-- To modify your build process, add your task inside one of the targets below and uncomment it. <!-- To modify your build process, add your task inside one of the targets below and uncomment it.
Other similar extension points exist, see Microsoft.Common.targets. Other similar extension points exist, see Microsoft.Common.targets.
<Target Name="BeforeBuild"> <Target Name="BeforeBuild">

240
MediaBrowser.Api/Reports/Activities/ReportActivitiesBuilder.cs Normal file
View file

@ -0,0 +1,240 @@
using MediaBrowser.Model.Activity;
using MediaBrowser.Model.Querying;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using MediaBrowser.Controller.Library;
namespace MediaBrowser.Api.Reports
{
/// <summary> A report activities builder. </summary>
/// <seealso cref="T:MediaBrowser.Api.Reports.ReportBuilderBase"/>
public class ReportActivitiesBuilder : ReportBuilderBase
{
#region [Constructors]
/// <summary>
/// Initializes a new instance of the MediaBrowser.Api.Reports.ReportActivitiesBuilder class. </summary>
/// <param name="libraryManager"> Manager for library. </param>
/// <param name="userManager"> Manager for user. </param>
public ReportActivitiesBuilder(ILibraryManager libraryManager, IUserManager userManager)
: base(libraryManager)
{
_userManager = userManager;
}
#endregion
#region [Private Fields]
private readonly IUserManager _userManager; ///< Manager for user
#endregion
#region [Public Methods]
/// <summary> Gets a result. </summary>
/// <param name="queryResult"> The query result. </param>
/// <param name="request"> The request. </param>
/// <returns> The result. </returns>
public ReportResult GetResult(QueryResult<ActivityLogEntry> queryResult, IReportsQuery request)
{
List<ReportOptions<ActivityLogEntry>> options = this.GetReportOptions<ActivityLogEntry>(request,
() => this.GetDefaultHeaderMetadata(),
(hm) => this.GetOption(hm)).Where(x => x.Header.Visible == true).ToList();
var headers = GetHeaders<ActivityLogEntry>(options);
var rows = GetReportRows(queryResult.Items, options);
ReportResult result = new ReportResult { Headers = headers };
HeaderMetadata groupBy = ReportHelper.GetHeaderMetadataType(request.GroupBy);
int i = headers.FindIndex(x => x.FieldName == groupBy);
if (groupBy != HeaderMetadata.None && i >= 0)
{
var rowsGroup = rows.SelectMany(x => x.Columns[i].Name.Split(';'), (x, g) => new { Group = g.Trim(), Rows = x })
.GroupBy(x => x.Group)
.OrderBy(x => x.Key)
.Select(x => new ReportGroup { Name = x.Key, Rows = x.Select(r => r.Rows).ToList() });
result.Groups = rowsGroup.ToList();
result.IsGrouped = true;
}
else
{
result.Rows = rows;
result.IsGrouped = false;
}
return result;
}
#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>
/// <seealso cref="M:MediaBrowser.Api.Reports.ReportBuilderBase.GetHeaders{H}(H)"/>
protected internal override List<ReportHeader> GetHeaders<H>(H request)
{
return this.GetHeaders<ActivityLogEntry>(request, () => this.GetDefaultHeaderMetadata(), (hm) => this.GetOption(hm));
}
#endregion
#region [Private Methods]
/// <summary> Gets default header metadata. </summary>
/// <returns> The default header metadata. </returns>
private List<HeaderMetadata> GetDefaultHeaderMetadata()
{
return new List<HeaderMetadata>
{
HeaderMetadata.Date,
HeaderMetadata.User,
HeaderMetadata.Type,
HeaderMetadata.Severity,
HeaderMetadata.Name,
HeaderMetadata.ShortOverview,
HeaderMetadata.Overview,
//HeaderMetadata.UserPrimaryImageTag,
//HeaderMetadata.Item,
};
}
/// <summary> Gets an option. </summary>
/// <param name="header"> The header. </param>
/// <param name="sortField"> The sort field. </param>
/// <returns> The option. </returns>
private ReportOptions<ActivityLogEntry> GetOption(HeaderMetadata header, string sortField = "")
{
HeaderMetadata internalHeader = header;
ReportOptions<ActivityLogEntry> option = new ReportOptions<ActivityLogEntry>()
{
Header = new ReportHeader
{
HeaderFieldType = ReportFieldType.String,
SortField = sortField,
Type = "",
ItemViewType = ItemViewType.None
}
};
switch (header)
{
case HeaderMetadata.StatusImage:
option.Header.ItemViewType = ItemViewType.StatusImage;
internalHeader = HeaderMetadata.Status;
option.Header.CanGroup = false;
break;
case HeaderMetadata.Name:
option.Column = (i, r) => i.Name;
break;
case HeaderMetadata.Overview:
option.Column = (i, r) => i.Overview;
option.Header.SortField = "";
option.Header.CanGroup = false;
break;
case HeaderMetadata.ShortOverview:
option.Column = (i, r) => i.ShortOverview;
option.Header.SortField = "";
option.Header.CanGroup = false;
break;
case HeaderMetadata.Type:
option.Column = (i, r) => i.Type;
option.Header.SortField = "";
break;
case HeaderMetadata.Date:
option.Column = (i, r) => i.Date;
option.Header.SortField = "";
option.Header.HeaderFieldType = ReportFieldType.DateTime;
option.Header.Type = "";
break;
case HeaderMetadata.UserPrimaryImageTag:
option.Column = (i, r) => i.UserPrimaryImageTag;
option.Header.SortField = "";
break;
case HeaderMetadata.Severity:
option.Column = (i, r) => i.Severity;
option.Header.SortField = "";
break;
case HeaderMetadata.Item:
option.Column = (i, r) => i.ItemId;
option.Header.SortField = "";
break;
case HeaderMetadata.User:
option.Column = (i, r) =>
{
if (!string.IsNullOrEmpty(i.UserId))
{
MediaBrowser.Controller.Entities.User user = _userManager.GetUserById(i.UserId);
if (user != null)
return user.Name;
}
return string.Empty;
};
option.Header.SortField = "";
break;
}
option.Header.Name = GetLocalizedHeader(internalHeader);
option.Header.FieldName = header;
return option;
}
/// <summary> Gets report rows. </summary>
/// <param name="items"> The items. </param>
/// <param name="options"> Options for controlling the operation. </param>
/// <returns> The report rows. </returns>
private List<ReportRow> GetReportRows(IEnumerable<ActivityLogEntry> items, List<ReportOptions<ActivityLogEntry>> options)
{
var rows = new List<ReportRow>();
foreach (ActivityLogEntry item in items)
{
ReportRow rRow = GetRow(item);
foreach (ReportOptions<ActivityLogEntry> option in options)
{
object itemColumn = option.Column != null ? option.Column(item, rRow) : "";
object itemId = option.ItemID != null ? option.ItemID(item) : "";
ReportItem rItem = new ReportItem
{
Name = ReportHelper.ConvertToString(itemColumn, option.Header.HeaderFieldType),
Id = ReportHelper.ConvertToString(itemId, ReportFieldType.Object)
};
rRow.Columns.Add(rItem);
}
rows.Add(rRow);
}
return rows;
}
/// <summary> Gets a row. </summary>
/// <param name="item"> The item. </param>
/// <returns> The row. </returns>
private ReportRow GetRow(ActivityLogEntry item)
{
ReportRow rRow = new ReportRow
{
Id = item.Id,
};
return rRow;
}
#endregion
}
}

20
MediaBrowser.Api/Reports/Common/HeaderActivitiesMetadata.cs Normal file
View file

@ -0,0 +1,20 @@
using System;
using System.Collections.Generic;
using System.Linq;
namespace MediaBrowser.Api.Reports
{
public enum HeaderActivitiesMetadata
{
None,
Name,
Overview,
ShortOverview,
Type,
Date,
UserPrimaryImageTag,
Severity,
Item,
User
}
}

11
MediaBrowser.Api/Reports/Common/HeaderMetadata.cs
View file

@ -42,6 +42,15 @@ namespace MediaBrowser.Api.Reports
AudioAlbumArtist, AudioAlbumArtist,
MusicArtist, MusicArtist,
AudioAlbum, AudioAlbum,
Status Status,
//Activity logs
Overview,
ShortOverview,
Type,
Date,
UserPrimaryImageTag,
Severity,
Item,
User
} }
} }

481
MediaBrowser.Api/Reports/Common/ReportBuilderBase.cs
View file

@ -13,217 +13,330 @@ using System.Threading.Tasks;
namespace MediaBrowser.Api.Reports namespace MediaBrowser.Api.Reports
{ {
/// <summary> A report builder base. </summary> /// <summary> A report builder base. </summary>
public class ReportBuilderBase public abstract 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> #region [Constructors]
protected readonly ILibraryManager _libraryManager;
/// <summary> Gets audio stream. </summary> /// <summary>
/// <param name="item"> The item. </param> /// Initializes a new instance of the MediaBrowser.Api.Reports.ReportBuilderBase class. </summary>
/// <returns> The audio stream. </returns> /// <param name="libraryManager"> Manager for library. </param>
protected string GetAudioStream(BaseItem item) public ReportBuilderBase(ILibraryManager libraryManager)
{ {
var stream = GetStream(item, MediaStreamType.Audio); _libraryManager = libraryManager;
if (stream != null) }
return stream.Codec.ToUpper() == "DCA" ? stream.Profile : stream.Codec.
ToUpper();
return string.Empty; #endregion
}
/// <summary> Gets an episode. </summary> #region [Protected Fields]
/// <param name="item"> The item. </param>
/// <returns> The episode. </returns>
protected string GetEpisode(BaseItem item)
{
if (item.GetClientTypeName() == ChannelMediaContentType.Episode.ToString() && item.ParentIndexNumber != null) /// <summary> Manager for library. </summary>
return "Season " + item.ParentIndexNumber; protected readonly ILibraryManager _libraryManager; ///< Manager for library
else
return item.Name;
}
/// <summary> Gets a genre. </summary> protected Func<bool, string> GetBoolString = s => s == true ? "x" : ""; ///< .
/// <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> #endregion
/// <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> #region [Protected Internal Methods]
/// <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> /// <summary> Gets the headers. </summary>
/// <param name="item"> The item. </param> /// <typeparam name="H"> Type of the header. </typeparam>
/// <returns> The media source information. </returns> /// <param name="request"> The request. </param>
protected MediaSourceInfo GetMediaSourceInfo(BaseItem item) /// <returns> The headers. </returns>
{ protected internal abstract List<ReportHeader> GetHeaders<H>(H request) where H : IReportsHeader;
var mediaSource = item as IHasMediaSources;
if (mediaSource != null)
return mediaSource.GetMediaSources(false).FirstOrDefault(n => n.Type == MediaSourceType.Default);
return null; #endregion
}
/// <summary> Gets an object. </summary> #region [Protected Methods]
/// <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> /// <summary> Gets active headers. </summary>
/// <param name="name"> The name. </param> /// <typeparam name="T"> Generic type parameter. </typeparam>
/// <returns> The person. </returns> /// <param name="options"> Options for controlling the operation. </param>
protected Person GetPerson(string name) /// <returns> The active headers. </returns>
{ protected List<ReportHeader> GetActiveHeaders<T>(List<ReportOptions<T>> options)
if (string.IsNullOrEmpty(name)) {
return null; List<ReportHeader> headers = new List<ReportHeader>();
return _libraryManager.GetPerson(name); foreach (ReportOptions<T> option in options.Where(x => x.Header.Visible == true))
} {
headers.Add(option.Header);
}
/// <summary> Gets person identifier. </summary> return headers;
/// <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> /// <summary> Gets audio stream. </summary>
/// <param name="runtime"> The runtime. </param> /// <param name="item"> The item. </param>
/// <returns> The runtime date time. </returns> /// <returns> The audio stream. </returns>
protected double? GetRuntimeDateTime(long? runtime) protected string GetAudioStream(BaseItem item)
{ {
if (runtime.HasValue) 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 Math.Ceiling(new TimeSpan(runtime.Value).TotalMinutes);
return null; return null;
} }
/// <summary> Gets series production year. </summary> /// <summary> Gets series production year. </summary>
/// <param name="item"> The item. </param> /// <param name="item"> The item. </param>
/// <returns> The series production year. </returns> /// <returns> The series production year. </returns>
protected string GetSeriesProductionYear(BaseItem item) protected string GetSeriesProductionYear(BaseItem item)
{ {
string productionYear = item.ProductionYear.ToString(); string productionYear = item.ProductionYear.ToString();
var series = item as Series; var series = item as Series;
if (series == null) if (series == null)
{ {
if (item.ProductionYear == null || item.ProductionYear == 0) if (item.ProductionYear == null || item.ProductionYear == 0)
return string.Empty; return string.Empty;
return productionYear; return productionYear;
} }
if (series.Status == SeriesStatus.Continuing) if (series.Status == SeriesStatus.Continuing)
return productionYear += "-Present"; return productionYear += "-Present";
if (series.EndDate != null && series.EndDate.Value.Year != series.ProductionYear) if (series.EndDate != null && series.EndDate.Value.Year != series.ProductionYear)
return productionYear += "-" + series.EndDate.Value.Year; return productionYear += "-" + series.EndDate.Value.Year;
return productionYear; return productionYear;
} }
/// <summary> Gets a stream. </summary> /// <summary> Gets a stream. </summary>
/// <param name="item"> The item. </param> /// <param name="item"> The item. </param>
/// <param name="streamType"> Type of the stream. </param> /// <param name="streamType"> Type of the stream. </param>
/// <returns> The stream. </returns> /// <returns> The stream. </returns>
protected MediaStream GetStream(BaseItem item, MediaStreamType streamType) protected MediaStream GetStream(BaseItem item, MediaStreamType streamType)
{ {
var itemInfo = GetMediaSourceInfo(item); var itemInfo = GetMediaSourceInfo(item);
if (itemInfo != null) if (itemInfo != null)
return itemInfo.MediaStreams.FirstOrDefault(n => n.Type == streamType); return itemInfo.MediaStreams.FirstOrDefault(n => n.Type == streamType);
return null; return null;
} }
/// <summary> Gets a studio. </summary> /// <summary> Gets a studio. </summary>
/// <param name="name"> The name. </param> /// <param name="name"> The name. </param>
/// <returns> The studio. </returns> /// <returns> The studio. </returns>
protected Studio GetStudio(string name) protected Studio GetStudio(string name)
{ {
if (string.IsNullOrEmpty(name)) if (string.IsNullOrEmpty(name))
return null; return null;
return _libraryManager.GetStudio(name); return _libraryManager.GetStudio(name);
} }
/// <summary> Gets studio identifier. </summary> /// <summary> Gets studio identifier. </summary>
/// <param name="name"> The name. </param> /// <param name="name"> The name. </param>
/// <returns> The studio identifier. </returns> /// <returns> The studio identifier. </returns>
protected string GetStudioID(string name) protected string GetStudioID(string name)
{ {
if (string.IsNullOrEmpty(name)) if (string.IsNullOrEmpty(name))
return string.Empty; return string.Empty;
return string.Format("{0:N}", return string.Format("{0:N}",
GetStudio(name).Id); GetStudio(name).Id);
} }
/// <summary> Gets video resolution. </summary> /// <summary> Gets video resolution. </summary>
/// <param name="item"> The item. </param> /// <param name="item"> The item. </param>
/// <returns> The video resolution. </returns> /// <returns> The video resolution. </returns>
protected string GetVideoResolution(BaseItem item) protected string GetVideoResolution(BaseItem item)
{ {
var stream = GetStream(item, var stream = GetStream(item,
MediaStreamType.Video); MediaStreamType.Video);
if (stream != null && stream.Width != null) if (stream != null && stream.Width != null)
return string.Format("{0} * {1}", return string.Format("{0} * {1}",
stream.Width, stream.Width,
(stream.Height != null ? stream.Height.ToString() : "-")); (stream.Height != null ? stream.Height.ToString() : "-"));
return string.Empty; return string.Empty;
} }
/// <summary> Gets video stream. </summary> /// <summary> Gets video stream. </summary>
/// <param name="item"> The item. </param> /// <param name="item"> The item. </param>
/// <returns> The video stream. </returns> /// <returns> The video stream. </returns>
protected string GetVideoStream(BaseItem item) protected string GetVideoStream(BaseItem item)
{ {
var stream = GetStream(item, MediaStreamType.Video); var stream = GetStream(item, MediaStreamType.Video);
if (stream != null) if (stream != null)
return stream.Codec.ToUpper(); return stream.Codec.ToUpper();
return string.Empty; return string.Empty;
} }
} #endregion
}
} }

216
MediaBrowser.Api/Reports/Common/ReportHelper.cs
View file

@ -7,95 +7,135 @@ using System.Threading.Tasks;
namespace MediaBrowser.Api.Reports namespace MediaBrowser.Api.Reports
{ {
public class ReportHelper /// <summary> A report helper. </summary>
{ public class ReportHelper
/// <summary> Gets java script localized string. </summary> {
/// <param name="phrase"> The phrase. </param> #region [Public Methods]
/// <returns> The java script localized string. </returns>
public static string GetJavaScriptLocalizedString(string phrase)
{
var dictionary = BaseItem.LocalizationManager.GetJavaScriptLocalizationDictionary(BaseItem.ConfigurationManager.Configuration.UICulture);
string value; /// <summary> Convert field to string. </summary>
/// <typeparam name="T"> Generic type parameter. </typeparam>
if (dictionary.TryGetValue(phrase, out value)) /// <param name="value"> The value. </param>
{ /// <param name="fieldType"> Type of the field. </param>
return value; /// <returns> The field converted to string. </returns>
} public static string ConvertToString<T>(T value, ReportFieldType fieldType)
{
return phrase; if (value == null)
} return "";
switch (fieldType)
/// <summary> Gets server localized string. </summary> {
/// <param name="phrase"> The phrase. </param> case ReportFieldType.String:
/// <returns> The server localized string. </returns> return value.ToString();
public static string GetServerLocalizedString(string phrase) case ReportFieldType.Boolean:
{ return value.ToString();
return BaseItem.LocalizationManager.GetLocalizedString(phrase, BaseItem.ConfigurationManager.Configuration.UICulture); case ReportFieldType.Date:
} return string.Format("{0:d}", value);
case ReportFieldType.Time:
/// <summary> Gets row type. </summary> return string.Format("{0:t}", value);
/// <param name="rowType"> The type. </param> case ReportFieldType.DateTime:
/// <returns> The row type. </returns> return string.Format("{0:d}", value);
public static ReportViewType GetRowType(string rowType)
{
if (string.IsNullOrEmpty(rowType))
return ReportViewType.BaseItem;
ReportViewType rType;
if (!Enum.TryParse<ReportViewType>(rowType, out rType))
return ReportViewType.BaseItem;
return rType;
}
/// <summary> Gets header metadata type. </summary>
/// <param name="header"> The header. </param>
/// <returns> The header metadata type. </returns>
public static HeaderMetadata GetHeaderMetadataType(string header)
{
if (string.IsNullOrEmpty(header))
return HeaderMetadata.None;
HeaderMetadata rType;
if (!Enum.TryParse<HeaderMetadata>(header, out rType))
return HeaderMetadata.None;
return rType;
}
/// <summary> Convert field to string. </summary>
/// <typeparam name="T"> Generic type parameter. </typeparam>
/// <param name="value"> The value. </param>
/// <param name="fieldType"> Type of the field. </param>
/// <returns> The field converted to string. </returns>
public static string ConvertToString<T>(T value, ReportFieldType fieldType)
{
if (value == null)
return "";
switch (fieldType)
{
case ReportFieldType.String:
return value.ToString();
case ReportFieldType.Boolean:
return value.ToString();
case ReportFieldType.Date:
return string.Format("{0:d}", value);
case ReportFieldType.Time:
return string.Format("{0:t}", value);
case ReportFieldType.DateTime:
return string.Format("{0:d}", value);
case ReportFieldType.Minutes: case ReportFieldType.Minutes:
return string.Format("{0}mn", value); return string.Format("{0}mn", value);
case ReportFieldType.Int: case ReportFieldType.Int:
return string.Format("", value); return string.Format("", value);
default: default:
if (value is Guid) if (value is Guid)
return string.Format("{0:N}", value); return string.Format("{0:N}", value);
return value.ToString(); return value.ToString();
} }
} }
}
/// <summary> Gets filtered report header metadata. </summary>
/// <param name="reportColumns"> The report columns. </param>
/// <param name="defaultReturnValue"> The default return value. </param>
/// <returns> The filtered report header metadata. </returns>
public static List<HeaderMetadata> GetFilteredReportHeaderMetadata(string reportColumns, Func<List<HeaderMetadata>> defaultReturnValue = null)
{
if (!string.IsNullOrEmpty(reportColumns))
{
var s = reportColumns.Split('|').Select(x => ReportHelper.GetHeaderMetadataType(x)).Where(x => x != HeaderMetadata.None);
return s.ToList();
}
else
if (defaultReturnValue != null)
return defaultReturnValue();
else
return new List<HeaderMetadata>();
}
/// <summary> Gets header metadata type. </summary>
/// <param name="header"> The header. </param>
/// <returns> The header metadata type. </returns>
public static HeaderMetadata GetHeaderMetadataType(string header)
{
if (string.IsNullOrEmpty(header))
return HeaderMetadata.None;
HeaderMetadata rType;
if (!Enum.TryParse<HeaderMetadata>(header, out rType))
return HeaderMetadata.None;
return rType;
}
/// <summary> Gets java script localized string. </summary>
/// <param name="phrase"> The phrase. </param>
/// <returns> The java script localized string. </returns>
public static string GetJavaScriptLocalizedString(string phrase)
{
var dictionary = BaseItem.LocalizationManager.GetJavaScriptLocalizationDictionary(BaseItem.ConfigurationManager.Configuration.UICulture);
string value;
if (dictionary.TryGetValue(phrase, out value))
{
return value;
}
return phrase;
}
/// <summary> Gets report view type. </summary>
/// <param name="rowType"> The type. </param>
/// <returns> The report view type. </returns>
public static ReportViewType GetReportViewType(string rowType)
{
if (string.IsNullOrEmpty(rowType))
return ReportViewType.ReportData;
ReportViewType rType;
if (!Enum.TryParse<ReportViewType>(rowType, out rType))
return ReportViewType.ReportData;
return rType;
}
/// <summary> Gets row type. </summary>
/// <param name="rowType"> The type. </param>
/// <returns> The row type. </returns>
public static ReportIncludeItemTypes GetRowType(string rowType)
{
if (string.IsNullOrEmpty(rowType))
return ReportIncludeItemTypes.BaseItem;
ReportIncludeItemTypes rType;
if (!Enum.TryParse<ReportIncludeItemTypes>(rowType, out rType))
return ReportIncludeItemTypes.BaseItem;
return rType;
}
/// <summary> Gets server localized string. </summary>
/// <param name="phrase"> The phrase. </param>
/// <returns> The server localized string. </returns>
public static string GetServerLocalizedString(string phrase)
{
return BaseItem.LocalizationManager.GetLocalizedString(phrase, BaseItem.ConfigurationManager.Configuration.UICulture);
}
#endregion
}
} }

25
MediaBrowser.Api/Reports/Common/ReportIncludeItemTypes.cs Normal file
View file

@ -0,0 +1,25 @@
using System;
using System.Collections.Generic;
using System.Linq;
namespace MediaBrowser.Api.Reports
{
public enum ReportIncludeItemTypes
{
MusicArtist,
MusicAlbum,
Book,
BoxSet,
Episode,
Game,
Video,
Movie,
MusicVideo,
Trailer,
Season,
Series,
Audio,
BaseItem,
Artist
}
}

19
MediaBrowser.Api/Reports/Common/ReportViewType.cs
View file

@ -6,20 +6,9 @@ namespace MediaBrowser.Api.Reports
{ {
public enum ReportViewType public enum ReportViewType
{ {
MusicArtist, ReportData,
MusicAlbum, ReportStatistics,
Book, ReportActivities
BoxSet,
Episode,
Game,
Video,
Movie,
MusicVideo,
Trailer,
Season,
Series,
Audio,
BaseItem,
Artist
} }
} }

694
MediaBrowser.Api/Reports/Data/ReportBuilder.cs
View file

@ -17,162 +17,89 @@ using System.Threading.Tasks;
namespace MediaBrowser.Api.Reports namespace MediaBrowser.Api.Reports
{ {
/// <summary> A report builder. </summary> /// <summary> A report builder. </summary>
/// <seealso cref="T:MediaBrowser.Api.Reports.ReportBuilderBase"/> /// <seealso cref="T:MediaBrowser.Api.Reports.ReportBuilderBase"/>
public class ReportBuilder : ReportBuilderBase public class ReportBuilder : ReportBuilderBase
{ {
/// <summary> #region [Constructors]
/// Initializes a new instance of the MediaBrowser.Api.Reports.ReportBuilder class. </summary>
/// <param name="libraryManager"> Manager for library. </param>
public ReportBuilder(ILibraryManager libraryManager)
: base(libraryManager)
{
}
private Func<bool, string> GetBoolString = s => s == true ? "x" : ""; /// <summary>
/// Initializes a new instance of the MediaBrowser.Api.Reports.ReportBuilder class. </summary>
/// <param name="libraryManager"> Manager for library. </param>
public ReportBuilder(ILibraryManager libraryManager)
: base(libraryManager)
{
}
public ReportResult GetReportResult(BaseItem[] items, ReportViewType reportRowType, BaseReportRequest request) #endregion
{
List<HeaderMetadata> headersMetadata = this.GetFilteredReportHeaderMetadata(reportRowType, request);
var headers = GetReportHeaders(reportRowType, headersMetadata); #region [Public Methods]
var rows = GetReportRows(items, headersMetadata);
ReportResult result = new ReportResult { Headers = headers }; /// <summary> Gets report result. </summary>
HeaderMetadata groupBy = ReportHelper.GetHeaderMetadataType(request.GroupBy); /// <param name="items"> The items. </param>
int i = headers.FindIndex(x => x.FieldName == groupBy); /// <param name="request"> The request. </param>
if (groupBy != HeaderMetadata.None && i > 0) /// <returns> The report result. </returns>
{ public ReportResult GetResult(BaseItem[] items, IReportsQuery request)
var rowsGroup = rows.SelectMany(x => x.Columns[i].Name.Split(';'), (x, g) => new { Genre = g.Trim(), Rows = x }) {
.GroupBy(x => x.Genre) ReportIncludeItemTypes reportRowType = ReportHelper.GetRowType(request.IncludeItemTypes);
.OrderBy(x => x.Key) List<ReportOptions<BaseItem>> options = this.GetReportOptions<BaseItem>(request,
.Select(x => new ReportGroup { Name = x.Key, Rows = x.Select(r => r.Rows).ToList() }); () => this.GetDefaultHeaderMetadata(reportRowType),
(hm) => this.GetOption(hm)).Where(x => x.Header.Visible == true).ToList();
result.Groups = rowsGroup.ToList(); var headers = GetHeaders<BaseItem>(options);
result.IsGrouped = true; var rows = GetReportRows(items, options);
}
else
{
result.Rows = rows;
result.IsGrouped = false;
}
return result; ReportResult result = new ReportResult { Headers = headers };
} HeaderMetadata groupBy = ReportHelper.GetHeaderMetadataType(request.GroupBy);
int i = headers.FindIndex(x => x.FieldName == groupBy);
if (groupBy != HeaderMetadata.None && i >= 0)
{
var rowsGroup = rows.SelectMany(x => x.Columns[i].Name.Split(';'), (x, g) => new { Group = g.Trim(), Rows = x })
.GroupBy(x => x.Group)
.OrderBy(x => x.Key)
.Select(x => new ReportGroup { Name = x.Key, Rows = x.Select(r => r.Rows).ToList() });
public List<ReportHeader> GetReportHeaders(ReportViewType reportRowType, BaseReportRequest request) result.Groups = rowsGroup.ToList();
{ result.IsGrouped = true;
List<ReportHeader> headersMetadata = this.GetReportHeaders(reportRowType); }
if (request != null && !string.IsNullOrEmpty(request.ReportColumns)) else
{ {
List<HeaderMetadata> headersMetadataFiltered = this.GetFilteredReportHeaderMetadata(reportRowType, request); result.Rows = rows;
foreach (ReportHeader reportHeader in headersMetadata) result.IsGrouped = false;
{ }
if (!headersMetadataFiltered.Contains(reportHeader.FieldName))
{
reportHeader.Visible = false;
}
}
return result;
}
} #endregion
return headersMetadata; #region [Protected Internal Methods]
}
public List<ReportHeader> GetReportHeaders(ReportViewType reportRowType, List<HeaderMetadata> headersMetadata = null) /// <summary> Gets the headers. </summary>
{ /// <typeparam name="H"> Type of the header. </typeparam>
if (headersMetadata == null) /// <param name="request"> The request. </param>
headersMetadata = this.GetDefaultReportHeaderMetadata(reportRowType); /// <returns> The headers. </returns>
/// <seealso cref="M:MediaBrowser.Api.Reports.ReportBuilderBase.GetHeaders{H}(H)"/>
protected internal override List<ReportHeader> GetHeaders<H>(H request)
{
ReportIncludeItemTypes reportRowType = ReportHelper.GetRowType(request.IncludeItemTypes);
return this.GetHeaders<BaseItem>(request, () => this.GetDefaultHeaderMetadata(reportRowType), (hm) => this.GetOption(hm));
}
List<ReportOptions<BaseItem>> options = new List<ReportOptions<BaseItem>>(); #endregion
foreach (HeaderMetadata header in headersMetadata)
{
options.Add(GetReportOption(header));
}
#region [Private Methods]
List<ReportHeader> headers = new List<ReportHeader>(); /// <summary> Gets default report header metadata. </summary>
foreach (ReportOptions<BaseItem> option in options) /// <param name="reportIncludeItemTypes"> Type of the report row. </param>
{ /// <returns> The default report header metadata. </returns>
headers.Add(option.Header); private List<HeaderMetadata> GetDefaultHeaderMetadata(ReportIncludeItemTypes reportIncludeItemTypes)
} {
return headers; switch (reportIncludeItemTypes)
} {
case ReportIncludeItemTypes.Season:
private List<ReportRow> GetReportRows(IEnumerable<BaseItem> items, List<HeaderMetadata> headersMetadata) return new List<HeaderMetadata>
{
List<ReportOptions<BaseItem>> options = new List<ReportOptions<BaseItem>>();
foreach (HeaderMetadata header in headersMetadata)
{
options.Add(GetReportOption(header));
}
var rows = new List<ReportRow>();
foreach (BaseItem item in items)
{
ReportRow rRow = GetRow(item);
foreach (ReportOptions<BaseItem> option in options)
{
object itemColumn = option.Column != null ? option.Column(item, rRow) : "";
object itemId = option.ItemID != null ? option.ItemID(item) : "";
ReportItem rItem = new ReportItem
{
Name = ReportHelper.ConvertToString(itemColumn, option.Header.HeaderFieldType),
Id = ReportHelper.ConvertToString(itemId, ReportFieldType.Object)
};
rRow.Columns.Add(rItem);
}
rows.Add(rRow);
}
return rows;
}
/// <summary> Gets a row. </summary>
/// <param name="item"> The item. </param>
/// <returns> The row. </returns>
private ReportRow GetRow(BaseItem item)
{
var hasTrailers = item as IHasTrailers;
var hasSpecialFeatures = item as IHasSpecialFeatures;
var video = item as Video;
ReportRow rRow = new ReportRow
{
Id = item.Id.ToString("N"),
HasLockData = item.IsLocked,
IsUnidentified = item.IsUnidentified,
HasLocalTrailer = hasTrailers != null ? hasTrailers.GetTrailerIds().Count() > 0 : false,
HasImageTagsPrimary = (item.ImageInfos != null && item.ImageInfos.Count(n => n.Type == ImageType.Primary) > 0),
HasImageTagsBackdrop = (item.ImageInfos != null && item.ImageInfos.Count(n => n.Type == ImageType.Backdrop) > 0),
HasImageTagsLogo = (item.ImageInfos != null && item.ImageInfos.Count(n => n.Type == ImageType.Logo) > 0),
HasSpecials = hasSpecialFeatures != null ? hasSpecialFeatures.SpecialFeatureIds.Count > 0 : false,
HasSubtitles = video != null ? video.HasSubtitles : false,
RowType = ReportHelper.GetRowType(item.GetClientTypeName())
};
return rRow;
}
public List<HeaderMetadata> GetFilteredReportHeaderMetadata(ReportViewType reportRowType, BaseReportRequest request)
{
if (request != null && !string.IsNullOrEmpty(request.ReportColumns))
{
var s = request.ReportColumns.Split('|').Select(x => ReportHelper.GetHeaderMetadataType(x)).Where(x => x != HeaderMetadata.None);
return s.ToList();
}
else
return this.GetDefaultReportHeaderMetadata(reportRowType);
}
public List<HeaderMetadata> GetDefaultReportHeaderMetadata(ReportViewType reportRowType)
{
switch (reportRowType)
{
case ReportViewType.Season:
return new List<HeaderMetadata>
{ {
HeaderMetadata.StatusImage, HeaderMetadata.StatusImage,
HeaderMetadata.Series, HeaderMetadata.Series,
@ -183,8 +110,8 @@ namespace MediaBrowser.Api.Reports
HeaderMetadata.Genres HeaderMetadata.Genres
}; };
case ReportViewType.Series: case ReportIncludeItemTypes.Series:
return new List<HeaderMetadata> return new List<HeaderMetadata>
{ {
HeaderMetadata.StatusImage, HeaderMetadata.StatusImage,
HeaderMetadata.Name, HeaderMetadata.Name,
@ -199,8 +126,8 @@ namespace MediaBrowser.Api.Reports
HeaderMetadata.Specials HeaderMetadata.Specials
}; };
case ReportViewType.MusicAlbum: case ReportIncludeItemTypes.MusicAlbum:
return new List<HeaderMetadata> return new List<HeaderMetadata>
{ {
HeaderMetadata.StatusImage, HeaderMetadata.StatusImage,
HeaderMetadata.Name, HeaderMetadata.Name,
@ -212,8 +139,8 @@ namespace MediaBrowser.Api.Reports
HeaderMetadata.Genres HeaderMetadata.Genres
}; };
case ReportViewType.MusicArtist: case ReportIncludeItemTypes.MusicArtist:
return new List<HeaderMetadata> return new List<HeaderMetadata>
{ {
HeaderMetadata.StatusImage, HeaderMetadata.StatusImage,
HeaderMetadata.MusicArtist, HeaderMetadata.MusicArtist,
@ -223,8 +150,8 @@ namespace MediaBrowser.Api.Reports
HeaderMetadata.Genres HeaderMetadata.Genres
}; };
case ReportViewType.Game: case ReportIncludeItemTypes.Game:
return new List<HeaderMetadata> return new List<HeaderMetadata>
{ {
HeaderMetadata.StatusImage, HeaderMetadata.StatusImage,
HeaderMetadata.Name, HeaderMetadata.Name,
@ -239,8 +166,8 @@ namespace MediaBrowser.Api.Reports
HeaderMetadata.Trailers HeaderMetadata.Trailers
}; };
case ReportViewType.Movie: case ReportIncludeItemTypes.Movie:
return new List<HeaderMetadata> return new List<HeaderMetadata>
{ {
HeaderMetadata.StatusImage, HeaderMetadata.StatusImage,
HeaderMetadata.Name, HeaderMetadata.Name,
@ -259,8 +186,8 @@ namespace MediaBrowser.Api.Reports
HeaderMetadata.Specials HeaderMetadata.Specials
}; };
case ReportViewType.Book: case ReportIncludeItemTypes.Book:
return new List<HeaderMetadata> return new List<HeaderMetadata>
{ {
HeaderMetadata.StatusImage, HeaderMetadata.StatusImage,
HeaderMetadata.Name, HeaderMetadata.Name,
@ -272,8 +199,8 @@ namespace MediaBrowser.Api.Reports
HeaderMetadata.CommunityRating HeaderMetadata.CommunityRating
}; };
case ReportViewType.BoxSet: case ReportIncludeItemTypes.BoxSet:
return new List<HeaderMetadata> return new List<HeaderMetadata>
{ {
HeaderMetadata.StatusImage, HeaderMetadata.StatusImage,
HeaderMetadata.Name, HeaderMetadata.Name,
@ -286,8 +213,8 @@ namespace MediaBrowser.Api.Reports
HeaderMetadata.Trailers HeaderMetadata.Trailers
}; };
case ReportViewType.Audio: case ReportIncludeItemTypes.Audio:
return new List<HeaderMetadata> return new List<HeaderMetadata>
{ {
HeaderMetadata.StatusImage, HeaderMetadata.StatusImage,
HeaderMetadata.Name, HeaderMetadata.Name,
@ -305,8 +232,8 @@ namespace MediaBrowser.Api.Reports
HeaderMetadata.Audio HeaderMetadata.Audio
}; };
case ReportViewType.Episode: case ReportIncludeItemTypes.Episode:
return new List<HeaderMetadata> return new List<HeaderMetadata>
{ {
HeaderMetadata.StatusImage, HeaderMetadata.StatusImage,
HeaderMetadata.Name, HeaderMetadata.Name,
@ -327,12 +254,12 @@ namespace MediaBrowser.Api.Reports
HeaderMetadata.Specials HeaderMetadata.Specials
}; };
case ReportViewType.Video: case ReportIncludeItemTypes.Video:
case ReportViewType.MusicVideo: case ReportIncludeItemTypes.MusicVideo:
case ReportViewType.Trailer: case ReportIncludeItemTypes.Trailer:
case ReportViewType.BaseItem: case ReportIncludeItemTypes.BaseItem:
default: default:
return new List<HeaderMetadata> return new List<HeaderMetadata>
{ {
HeaderMetadata.StatusImage, HeaderMetadata.StatusImage,
HeaderMetadata.Name, HeaderMetadata.Name,
@ -351,239 +278,282 @@ namespace MediaBrowser.Api.Reports
HeaderMetadata.Specials HeaderMetadata.Specials
}; };
} }
} }
/// <summary> Gets report option. </summary> /// <summary> Gets report option. </summary>
/// <param name="header"> The header. </param> /// <param name="header"> The header. </param>
/// <param name="sortField"> The sort field. </param> /// <param name="sortField"> The sort field. </param>
/// <returns> The report option. </returns> /// <returns> The report option. </returns>
private ReportOptions<BaseItem> GetReportOption(HeaderMetadata header, string sortField = "") private ReportOptions<BaseItem> GetOption(HeaderMetadata header, string sortField = "")
{ {
ReportHeader reportHeader = new ReportHeader HeaderMetadata internalHeader = header;
{
HeaderFieldType = ReportFieldType.String,
SortField = sortField,
Type = "",
ItemViewType = ItemViewType.None
};
Func<BaseItem, ReportRow, object> column = null; ReportOptions<BaseItem> option = new ReportOptions<BaseItem>()
Func<BaseItem, object> itemId = null; {
HeaderMetadata internalHeader = header; Header = new ReportHeader
{
HeaderFieldType = ReportFieldType.String,
SortField = sortField,
Type = "",
ItemViewType = ItemViewType.None
}
};
switch (header) switch (header)
{ {
case HeaderMetadata.StatusImage: case HeaderMetadata.StatusImage:
reportHeader.ItemViewType = ItemViewType.StatusImage; option.Header.ItemViewType = ItemViewType.StatusImage;
internalHeader = HeaderMetadata.Status; internalHeader = HeaderMetadata.Status;
reportHeader.CanGroup = false; option.Header.CanGroup = false;
break; break;
case HeaderMetadata.Name: case HeaderMetadata.Name:
column = (i, r) => i.Name; option.Column = (i, r) => i.Name;
reportHeader.ItemViewType = ItemViewType.Detail; option.Header.ItemViewType = ItemViewType.Detail;
reportHeader.SortField = "SortName"; option.Header.SortField = "SortName";
break; break;
case HeaderMetadata.DateAdded: case HeaderMetadata.DateAdded:
column = (i, r) => i.DateCreated; option.Column = (i, r) => i.DateCreated;
reportHeader.SortField = "DateCreated,SortName"; option.Header.SortField = "DateCreated,SortName";
reportHeader.HeaderFieldType = ReportFieldType.DateTime; option.Header.HeaderFieldType = ReportFieldType.DateTime;
reportHeader.Type = ""; option.Header.Type = "";
break; break;
case HeaderMetadata.PremiereDate: case HeaderMetadata.PremiereDate:
case HeaderMetadata.ReleaseDate: case HeaderMetadata.ReleaseDate:
column = (i, r) => i.PremiereDate; option.Column = (i, r) => i.PremiereDate;
reportHeader.HeaderFieldType = ReportFieldType.DateTime; option.Header.HeaderFieldType = ReportFieldType.DateTime;
reportHeader.SortField = "ProductionYear,PremiereDate,SortName"; option.Header.SortField = "ProductionYear,PremiereDate,SortName";
break; break;
case HeaderMetadata.Runtime: case HeaderMetadata.Runtime:
column = (i, r) => this.GetRuntimeDateTime(i.RunTimeTicks); option.Column = (i, r) => this.GetRuntimeDateTime(i.RunTimeTicks);
reportHeader.HeaderFieldType = ReportFieldType.Minutes; option.Header.HeaderFieldType = ReportFieldType.Minutes;
reportHeader.SortField = "Runtime,SortName"; option.Header.SortField = "Runtime,SortName";
break; break;
case HeaderMetadata.PlayCount: case HeaderMetadata.PlayCount:
reportHeader.HeaderFieldType = ReportFieldType.Int; option.Header.HeaderFieldType = ReportFieldType.Int;
break; break;
case HeaderMetadata.Season: case HeaderMetadata.Season:
column = (i, r) => this.GetEpisode(i); option.Column = (i, r) => this.GetEpisode(i);
reportHeader.ItemViewType = ItemViewType.Detail; option.Header.ItemViewType = ItemViewType.Detail;
reportHeader.SortField = "SortName"; option.Header.SortField = "SortName";
break; break;
case HeaderMetadata.SeasonNumber: case HeaderMetadata.SeasonNumber:
column = (i, r) => this.GetObject<Season, string>(i, (x) => x.IndexNumber == null ? "" : x.IndexNumber.ToString()); option.Column = (i, r) => this.GetObject<Season, string>(i, (x) => x.IndexNumber == null ? "" : x.IndexNumber.ToString());
reportHeader.SortField = "IndexNumber"; option.Header.SortField = "IndexNumber";
reportHeader.HeaderFieldType = ReportFieldType.Int; option.Header.HeaderFieldType = ReportFieldType.Int;
break; break;
case HeaderMetadata.Series: case HeaderMetadata.Series:
column = (i, r) => this.GetObject<IHasSeries, string>(i, (x) => x.SeriesName); option.Column = (i, r) => this.GetObject<IHasSeries, string>(i, (x) => x.SeriesName);
reportHeader.ItemViewType = ItemViewType.Detail; option.Header.ItemViewType = ItemViewType.Detail;
reportHeader.SortField = "SeriesSortName,SortName"; option.Header.SortField = "SeriesSortName,SortName";
break; break;
case HeaderMetadata.EpisodeSeries: case HeaderMetadata.EpisodeSeries:
column = (i, r) => this.GetObject<IHasSeries, string>(i, (x) => x.SeriesName); option.Column = (i, r) => this.GetObject<IHasSeries, string>(i, (x) => x.SeriesName);
reportHeader.ItemViewType = ItemViewType.Detail; option.Header.ItemViewType = ItemViewType.Detail;
itemId = (i) => option.ItemID = (i) =>
{ {
Series series = this.GetObject<Episode, Series>(i, (x) => x.Series); Series series = this.GetObject<Episode, Series>(i, (x) => x.Series);
if (series == null) if (series == null)
return string.Empty; return string.Empty;
return series.Id; return series.Id;
}; };
reportHeader.SortField = "SeriesSortName,SortName"; option.Header.SortField = "SeriesSortName,SortName";
internalHeader = HeaderMetadata.Series; internalHeader = HeaderMetadata.Series;
break; break;
case HeaderMetadata.EpisodeSeason: case HeaderMetadata.EpisodeSeason:
column = (i, r) => this.GetObject<IHasSeries, string>(i, (x) => x.SeriesName); option.Column = (i, r) => this.GetObject<IHasSeries, string>(i, (x) => x.SeriesName);
reportHeader.ItemViewType = ItemViewType.Detail; option.Header.ItemViewType = ItemViewType.Detail;
itemId = (i) => option.ItemID = (i) =>
{ {
Season season = this.GetObject<Episode, Season>(i, (x) => x.Season); Season season = this.GetObject<Episode, Season>(i, (x) => x.Season);
if (season == null) if (season == null)
return string.Empty; return string.Empty;
return season.Id; return season.Id;
}; };
reportHeader.SortField = "SortName"; option.Header.SortField = "SortName";
internalHeader = HeaderMetadata.Season; internalHeader = HeaderMetadata.Season;
break; break;
case HeaderMetadata.Network: case HeaderMetadata.Network:
column = (i, r) => this.GetListAsString(i.Studios); option.Column = (i, r) => this.GetListAsString(i.Studios);
itemId = (i) => this.GetStudioID(i.Studios.FirstOrDefault()); option.ItemID = (i) => this.GetStudioID(i.Studios.FirstOrDefault());
reportHeader.ItemViewType = ItemViewType.ItemByNameDetails; option.Header.ItemViewType = ItemViewType.ItemByNameDetails;
reportHeader.SortField = "Studio,SortName"; option.Header.SortField = "Studio,SortName";
break; break;
case HeaderMetadata.Year: case HeaderMetadata.Year:
column = (i, r) => this.GetSeriesProductionYear(i); option.Column = (i, r) => this.GetSeriesProductionYear(i);
reportHeader.SortField = "ProductionYear,PremiereDate,SortName"; option.Header.SortField = "ProductionYear,PremiereDate,SortName";
break; break;
case HeaderMetadata.ParentalRating: case HeaderMetadata.ParentalRating:
column = (i, r) => i.OfficialRating; option.Column = (i, r) => i.OfficialRating;
reportHeader.SortField = "OfficialRating,SortName"; option.Header.SortField = "OfficialRating,SortName";
break; break;
case HeaderMetadata.CommunityRating: case HeaderMetadata.CommunityRating:
column = (i, r) => i.CommunityRating; option.Column = (i, r) => i.CommunityRating;
reportHeader.SortField = "CommunityRating,SortName"; option.Header.SortField = "CommunityRating,SortName";
break; break;
case HeaderMetadata.Trailers: case HeaderMetadata.Trailers:
column = (i, r) => this.GetBoolString(r.HasLocalTrailer); option.Column = (i, r) => this.GetBoolString(r.HasLocalTrailer);
reportHeader.ItemViewType = ItemViewType.TrailersImage; option.Header.ItemViewType = ItemViewType.TrailersImage;
break; break;
case HeaderMetadata.Specials: case HeaderMetadata.Specials:
column = (i, r) => this.GetBoolString(r.HasSpecials); option.Column = (i, r) => this.GetBoolString(r.HasSpecials);
reportHeader.ItemViewType = ItemViewType.SpecialsImage; option.Header.ItemViewType = ItemViewType.SpecialsImage;
break; break;
case HeaderMetadata.GameSystem: case HeaderMetadata.GameSystem:
column = (i, r) => this.GetObject<Game, string>(i, (x) => x.GameSystem); option.Column = (i, r) => this.GetObject<Game, string>(i, (x) => x.GameSystem);
reportHeader.SortField = "GameSystem,SortName"; option.Header.SortField = "GameSystem,SortName";
break; break;
case HeaderMetadata.Players: case HeaderMetadata.Players:
column = (i, r) => this.GetObject<Game, int?>(i, (x) => x.PlayersSupported); option.Column = (i, r) => this.GetObject<Game, int?>(i, (x) => x.PlayersSupported);
reportHeader.SortField = "Players,GameSystem,SortName"; option.Header.SortField = "Players,GameSystem,SortName";
break; break;
case HeaderMetadata.AlbumArtist: case HeaderMetadata.AlbumArtist:
column = (i, r) => this.GetObject<MusicAlbum, string>(i, (x) => x.AlbumArtist); option.Column = (i, r) => this.GetObject<MusicAlbum, string>(i, (x) => x.AlbumArtist);
itemId = (i) => this.GetPersonID(this.GetObject<MusicAlbum, string>(i, (x) => x.AlbumArtist)); option.ItemID = (i) => this.GetPersonID(this.GetObject<MusicAlbum, string>(i, (x) => x.AlbumArtist));
reportHeader.ItemViewType = ItemViewType.Detail; option.Header.ItemViewType = ItemViewType.Detail;
reportHeader.SortField = "AlbumArtist,Album,SortName"; option.Header.SortField = "AlbumArtist,Album,SortName";
break; break;
case HeaderMetadata.MusicArtist: case HeaderMetadata.MusicArtist:
column = (i, r) => this.GetObject<MusicArtist, string>(i, (x) => x.GetLookupInfo().Name); option.Column = (i, r) => this.GetObject<MusicArtist, string>(i, (x) => x.GetLookupInfo().Name);
reportHeader.ItemViewType = ItemViewType.Detail; option.Header.ItemViewType = ItemViewType.Detail;
reportHeader.SortField = "AlbumArtist,Album,SortName"; option.Header.SortField = "AlbumArtist,Album,SortName";
internalHeader = HeaderMetadata.AlbumArtist; internalHeader = HeaderMetadata.AlbumArtist;
break; break;
case HeaderMetadata.AudioAlbumArtist: case HeaderMetadata.AudioAlbumArtist:
column = (i, r) => this.GetListAsString(this.GetObject<Audio, List<string>>(i, (x) => x.AlbumArtists)); option.Column = (i, r) => this.GetListAsString(this.GetObject<Audio, List<string>>(i, (x) => x.AlbumArtists));
reportHeader.SortField = "AlbumArtist,Album,SortName"; option.Header.SortField = "AlbumArtist,Album,SortName";
internalHeader = HeaderMetadata.AlbumArtist; internalHeader = HeaderMetadata.AlbumArtist;
break; break;
case HeaderMetadata.AudioAlbum: case HeaderMetadata.AudioAlbum:
column = (i, r) => this.GetObject<Audio, string>(i, (x) => x.Album); option.Column = (i, r) => this.GetObject<Audio, string>(i, (x) => x.Album);
reportHeader.SortField = "Album,SortName"; option.Header.SortField = "Album,SortName";
internalHeader = HeaderMetadata.Album; internalHeader = HeaderMetadata.Album;
break; break;
case HeaderMetadata.Countries: case HeaderMetadata.Countries:
column = (i, r) => this.GetListAsString(this.GetObject<IHasProductionLocations, List<string>>(i, (x) => x.ProductionLocations)); option.Column = (i, r) => this.GetListAsString(this.GetObject<IHasProductionLocations, List<string>>(i, (x) => x.ProductionLocations));
break; break;
case HeaderMetadata.Disc: case HeaderMetadata.Disc:
column = (i, r) => i.ParentIndexNumber; option.Column = (i, r) => i.ParentIndexNumber;
break; break;
case HeaderMetadata.Track: case HeaderMetadata.Track:
column = (i, r) => i.IndexNumber; option.Column = (i, r) => i.IndexNumber;
break; break;
case HeaderMetadata.Tracks: case HeaderMetadata.Tracks:
column = (i, r) => this.GetObject<MusicAlbum, List<Audio>>(i, (x) => x.Tracks.ToList(), new List<Audio>()).Count(); option.Column = (i, r) => this.GetObject<MusicAlbum, List<Audio>>(i, (x) => x.Tracks.ToList(), new List<Audio>()).Count();
break; break;
case HeaderMetadata.Audio: case HeaderMetadata.Audio:
column = (i, r) => this.GetAudioStream(i); option.Column = (i, r) => this.GetAudioStream(i);
break; break;
case HeaderMetadata.EmbeddedImage: case HeaderMetadata.EmbeddedImage:
break; break;
case HeaderMetadata.Video: case HeaderMetadata.Video:
column = (i, r) => this.GetVideoStream(i); option.Column = (i, r) => this.GetVideoStream(i);
break; break;
case HeaderMetadata.Resolution: case HeaderMetadata.Resolution:
column = (i, r) => this.GetVideoResolution(i); option.Column = (i, r) => this.GetVideoResolution(i);
break; break;
case HeaderMetadata.Subtitles: case HeaderMetadata.Subtitles:
column = (i, r) => this.GetBoolString(r.HasSubtitles); option.Column = (i, r) => this.GetBoolString(r.HasSubtitles);
reportHeader.ItemViewType = ItemViewType.SubtitleImage; option.Header.ItemViewType = ItemViewType.SubtitleImage;
break; break;
case HeaderMetadata.Genres: case HeaderMetadata.Genres:
column = (i, r) => this.GetListAsString(i.Genres); option.Column = (i, r) => this.GetListAsString(i.Genres);
break; break;
} }
string headerName = ""; option.Header.Name = GetLocalizedHeader(internalHeader);
if (internalHeader != HeaderMetadata.None) option.Header.FieldName = header;
{
string localHeader = "Header" + internalHeader.ToString();
headerName = internalHeader != HeaderMetadata.None ? ReportHelper.GetJavaScriptLocalizedString(localHeader) : "";
if (string.Compare(localHeader, headerName, StringComparison.CurrentCultureIgnoreCase) == 0)
headerName = ReportHelper.GetServerLocalizedString(localHeader);
}
reportHeader.Name = headerName; return option;
reportHeader.FieldName = header; }
ReportOptions<BaseItem> option = new ReportOptions<BaseItem>()
{ /// <summary> Gets report rows. </summary>
Header = reportHeader, /// <param name="items"> The items. </param>
Column = column, /// <param name="options"> Options for controlling the operation. </param>
ItemID = itemId /// <returns> The report rows. </returns>
}; private List<ReportRow> GetReportRows(IEnumerable<BaseItem> items, List<ReportOptions<BaseItem>> options)
return option; {
} var rows = new List<ReportRow>();
}
foreach (BaseItem item in items)
{
ReportRow rRow = GetRow(item);
foreach (ReportOptions<BaseItem> option in options)
{
object itemColumn = option.Column != null ? option.Column(item, rRow) : "";
object itemId = option.ItemID != null ? option.ItemID(item) : "";
ReportItem rItem = new ReportItem
{
Name = ReportHelper.ConvertToString(itemColumn, option.Header.HeaderFieldType),
Id = ReportHelper.ConvertToString(itemId, ReportFieldType.Object)
};
rRow.Columns.Add(rItem);
}
rows.Add(rRow);
}
return rows;
}
/// <summary> Gets a row. </summary>
/// <param name="item"> The item. </param>
/// <returns> The row. </returns>
private ReportRow GetRow(BaseItem item)
{
var hasTrailers = item as IHasTrailers;
var hasSpecialFeatures = item as IHasSpecialFeatures;
var video = item as Video;
ReportRow rRow = new ReportRow
{
Id = item.Id.ToString("N"),
HasLockData = item.IsLocked,
IsUnidentified = item.IsUnidentified,
HasLocalTrailer = hasTrailers != null ? hasTrailers.GetTrailerIds().Count() > 0 : false,
HasImageTagsPrimary = (item.ImageInfos != null && item.ImageInfos.Count(n => n.Type == ImageType.Primary) > 0),
HasImageTagsBackdrop = (item.ImageInfos != null && item.ImageInfos.Count(n => n.Type == ImageType.Backdrop) > 0),
HasImageTagsLogo = (item.ImageInfos != null && item.ImageInfos.Count(n => n.Type == ImageType.Logo) > 0),
HasSpecials = hasSpecialFeatures != null ? hasSpecialFeatures.SpecialFeatureIds.Count > 0 : false,
HasSubtitles = video != null ? video.HasSubtitles : false,
RowType = ReportHelper.GetRowType(item.GetClientTypeName())
};
return rRow;
}
#endregion
}
} }

3
MediaBrowser.Api/Reports/Data/ReportOptions.cs
View file

@ -7,8 +7,9 @@ using System.Threading.Tasks;
namespace MediaBrowser.Api.Reports namespace MediaBrowser.Api.Reports
{ {
/// <summary> A report options. </summary> /// <summary> A report options. </summary>
internal class ReportOptions<I> public class ReportOptions<I>
{ {
/// <summary> Initializes a new instance of the ReportOptions class. </summary> /// <summary> Initializes a new instance of the ReportOptions class. </summary>
public ReportOptions() public ReportOptions()

0
MediaBrowser.Api/Reports/Data/ReportGroup.cs → MediaBrowser.Api/Reports/Model/ReportGroup.cs
View file

0
MediaBrowser.Api/Reports/Data/ReportHeader.cs → MediaBrowser.Api/Reports/Model/ReportHeader.cs
View file

0
MediaBrowser.Api/Reports/Data/ReportItem.cs → MediaBrowser.Api/Reports/Model/ReportItem.cs
View file

0
MediaBrowser.Api/Reports/Data/ReportResult.cs → MediaBrowser.Api/Reports/Model/ReportResult.cs
View file

2
MediaBrowser.Api/Reports/Data/ReportRow.cs → MediaBrowser.Api/Reports/Model/ReportRow.cs
View file

@ -66,6 +66,6 @@ namespace MediaBrowser.Api.Reports
/// <summary> Gets or sets the type. </summary> /// <summary> Gets or sets the type. </summary>
/// <value> The type. </value> /// <value> The type. </value>
public ReportViewType RowType { get; set; } public ReportIncludeItemTypes RowType { get; set; }
} }
} }

156
MediaBrowser.Api/Reports/ReportRequests.cs
View file

@ -7,8 +7,80 @@ using System.Linq;
namespace MediaBrowser.Api.Reports namespace MediaBrowser.Api.Reports
{ {
public class BaseReportRequest : BaseItemsRequest public interface IReportsDownload : IReportsQuery
{ {
/// <summary> Gets or sets the minimum date. </summary>
/// <value> The minimum date. </value>
string MinDate { get; set; }
}
/// <summary> Interface for reports query. </summary>
public interface IReportsQuery : IReportsHeader
{
/// <summary>
/// Gets or sets a value indicating whether this MediaBrowser.Api.Reports.GetActivityLogs has
/// query limit. </summary>
/// <value>
/// true if this MediaBrowser.Api.Reports.GetActivityLogs has query limit, false if not. </value>
bool HasQueryLimit { get; set; }
/// <summary> Gets or sets who group this MediaBrowser.Api.Reports.GetActivityLogs. </summary>
/// <value> Describes who group this MediaBrowser.Api.Reports.GetActivityLogs. </value>
string GroupBy { get; set; }
/// <summary>
/// Skips over a given number of items within the results. Use for paging.
/// </summary>
/// <value>The start index.</value>
int? StartIndex { get; set; }
/// <summary>
/// The maximum number of items to return
/// </summary>
/// <value>The limit.</value>
int? Limit { get; set; }
}
public interface IReportsHeader
{
/// <summary> Gets or sets the report view. </summary>
/// <value> The report view. </value>
string ReportView { get; set; }
/// <summary> Gets or sets the report columns. </summary>
/// <value> The report columns. </value>
string ReportColumns { get; set; }
/// <summary> Gets or sets a list of types of the include items. </summary>
/// <value> A list of types of the include items. </value>
string IncludeItemTypes { get; set; }
}
public class BaseReportRequest : BaseItemsRequest, IReportsQuery
{
/// <summary> Gets or sets the report view. </summary>
/// <value> The report view. </value>
[ApiMember(Name = "ReportView", Description = "The report view. Values (ReportData, ReportStatistics, ReportActivities)", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")]
public string ReportView { get; set; }
/// <summary>
/// Gets or sets a value indicating whether this MediaBrowser.Api.Reports.BaseReportRequest has
/// query limit. </summary>
/// <value>
/// true if this MediaBrowser.Api.Reports.BaseReportRequest has query limit, false if not. </value>
[ApiMember(Name = "HasQueryLimit", Description = "Optional. If specified, results will include all records.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
public bool HasQueryLimit { get; set; }
/// <summary>
/// Gets or sets who group this MediaBrowser.Api.Reports.BaseReportRequest. </summary>
/// <value> Describes who group this MediaBrowser.Api.Reports.BaseReportRequest. </value>
[ApiMember(Name = "GroupBy", Description = "Optional. If specified, results will include grouped records.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public string GroupBy { get; set; }
/// <summary> Gets or sets the report columns. </summary>
/// <value> The report columns. </value>
[ApiMember(Name = "ReportColumns", Description = "Optional. The columns to show.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public string ReportColumns { get; set; }
/// <summary> /// <summary>
/// Gets or sets the user id. /// Gets or sets the user id.
/// </summary> /// </summary>
@ -63,11 +135,6 @@ namespace MediaBrowser.Api.Reports
[ApiMember(Name = "Ids", Description = "Optional. If specific items are needed, specify a list of item id's to retrieve. This allows multiple, comma delimited.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)] [ApiMember(Name = "Ids", Description = "Optional. If specific items are needed, specify a list of item id's to retrieve. This allows multiple, comma delimited.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
public string Ids { get; set; } public string Ids { get; set; }
public bool HasQueryLimit { get; set; }
public string GroupBy { get; set; }
public string ReportColumns { get; set; }
/// <summary> /// <summary>
/// Gets or sets the video types. /// Gets or sets the video types.
/// </summary> /// </summary>
@ -261,8 +328,22 @@ namespace MediaBrowser.Api.Reports
} }
[Route("/Reports/Headers", "GET", Summary = "Gets reports headers based on library items")] [Route("/Reports/Headers", "GET", Summary = "Gets reports headers based on library items")]
public class GetReportHeaders : BaseReportRequest, IReturn<List<ReportHeader>> public class GetReportHeaders : IReturn<List<ReportHeader>>, IReportsHeader
{ {
/// <summary> Gets or sets the report view. </summary>
/// <value> The report view. </value>
[ApiMember(Name = "ReportView", Description = "The report view. Values (ReportData, ReportStatistics, ReportActivities)", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")]
public string ReportView { get; set; }
/// <summary> Gets or sets a list of types of the include items. </summary>
/// <value> A list of types of the include items. </value>
[ApiMember(Name = "IncludeItemTypes", Description = "Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
public string IncludeItemTypes { get; set; }
/// <summary> Gets or sets the report columns. </summary>
/// <value> The report columns. </value>
[ApiMember(Name = "ReportColumns", Description = "Optional. The columns to show.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public string ReportColumns { get; set; }
} }
[Route("/Reports/Statistics", "GET", Summary = "Gets reports statistics based on library items")] [Route("/Reports/Statistics", "GET", Summary = "Gets reports statistics based on library items")]
@ -273,7 +354,7 @@ namespace MediaBrowser.Api.Reports
} }
[Route("/Reports/Items/Download", "GET", Summary = "Downloads report")] [Route("/Reports/Items/Download", "GET", Summary = "Downloads report")]
public class GetReportDownload : BaseReportRequest public class GetReportDownload : BaseReportRequest, IReportsDownload
{ {
public GetReportDownload() public GetReportDownload()
{ {
@ -281,6 +362,61 @@ namespace MediaBrowser.Api.Reports
} }
public ReportExportType ExportType { get; set; } public ReportExportType ExportType { get; set; }
/// <summary> Gets or sets the minimum date. </summary>
/// <value> The minimum date. </value>
[ApiMember(Name = "MinDate", Description = "Optional. The minimum date. Format = ISO", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST")]
public string MinDate { get; set; }
} }
[Route("/Reports/Activities", "GET", Summary = "Gets activities entries")]
public class GetActivityLogs : IReturn<ReportResult>, IReportsQuery, IReportsDownload
{
/// <summary> Gets or sets the report view. </summary>
/// <value> The report view. </value>
[ApiMember(Name = "ReportView", Description = "The report view. Values (ReportData, ReportStatistics, ReportActivities)", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")]
public string ReportView { get; set; }
/// <summary>
/// Gets or sets a value indicating whether this MediaBrowser.Api.Reports.GetActivityLogs has
/// query limit. </summary>
/// <value>
/// true if this MediaBrowser.Api.Reports.GetActivityLogs has query limit, false if not. </value>
[ApiMember(Name = "HasQueryLimit", Description = "Optional. If specified, results will include all records.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
public bool HasQueryLimit { get; set; }
/// <summary> Gets or sets who group this MediaBrowser.Api.Reports.GetActivityLogs. </summary>
/// <value> Describes who group this MediaBrowser.Api.Reports.GetActivityLogs. </value>
[ApiMember(Name = "GroupBy", Description = "Optional. If specified, results will include grouped records.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public string GroupBy { get; set; }
/// <summary> Gets or sets the report columns. </summary>
/// <value> The report columns. </value>
[ApiMember(Name = "ReportColumns", Description = "Optional. The columns to show.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public string ReportColumns { get; set; }
/// <summary>
/// Skips over a given number of items within the results. Use for paging.
/// </summary>
/// <value>The start index.</value>
[ApiMember(Name = "StartIndex", Description = "Optional. The record index to start at. All items with a lower index will be dropped from the results.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public int? StartIndex { get; set; }
/// <summary>
/// The maximum number of items to return
/// </summary>
/// <value>The limit.</value>
[ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public int? Limit { get; set; }
/// <summary> Gets or sets the minimum date. </summary>
/// <value> The minimum date. </value>
[ApiMember(Name = "MinDate", Description = "Optional. The minimum date. Format = ISO", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST")]
public string MinDate { get; set; }
[ApiMember(Name = "IncludeItemTypes", Description = "Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
public string IncludeItemTypes { get; set; }
}
} }

2245
MediaBrowser.Api/Reports/ReportsService.cs
View file

File diff suppressed because it is too large Load diff

417
MediaBrowser.Api/Reports/Stat/ReportStatBuilder.cs
View file

@ -9,206 +9,265 @@ using System.Threading.Tasks;
namespace MediaBrowser.Api.Reports namespace MediaBrowser.Api.Reports
{ {
/// <summary> A report stat builder. </summary> /// <summary> A report stat builder. </summary>
/// <seealso cref="T:MediaBrowser.Api.Reports.ReportBuilderBase"/> /// <seealso cref="T:MediaBrowser.Api.Reports.ReportBuilderBase"/>
public class ReportStatBuilder : ReportBuilderBase public class ReportStatBuilder : ReportBuilderBase
{ {
/// <summary> #region [Constructors]
/// Initializes a new instance of the MediaBrowser.Api.Reports.ReportStatBuilder class. </summary>
/// <param name="libraryManager"> Manager for library. </param>
public ReportStatBuilder(ILibraryManager libraryManager)
: base(libraryManager)
{
}
/// <summary> Gets report stat result. </summary> /// <summary>
/// <param name="items"> The items. </param> /// Initializes a new instance of the MediaBrowser.Api.Reports.ReportStatBuilder class. </summary>
/// <param name="reportRowType"> Type of the report row. </param> /// <param name="libraryManager"> Manager for library. </param>
/// <param name="topItem"> The top item. </param> public ReportStatBuilder(ILibraryManager libraryManager)
/// <returns> The report stat result. </returns> : base(libraryManager)
public ReportStatResult GetReportStatResult(BaseItem[] items, ReportViewType reportRowType, int topItem = 5) {
{ }
ReportStatResult result = new ReportStatResult();
result = this.GetResultGenres(result, items, topItem);
result = this.GetResultStudios(result, items, topItem);
result = this.GetResultPersons(result, items, topItem);
result = this.GetResultProductionYears(result, items, topItem);
result = this.GetResulProductionLocations(result, items, topItem);
result = this.GetResultCommunityRatings(result, items, topItem);
result = this.GetResultParentalRatings(result, items, topItem);
switch (reportRowType) #endregion
{
case ReportViewType.Season:
case ReportViewType.Series:
case ReportViewType.MusicAlbum:
case ReportViewType.MusicArtist:
case ReportViewType.Game:
break;
case ReportViewType.Movie:
case ReportViewType.BoxSet:
break; #region [Public Methods]
case ReportViewType.Book:
case ReportViewType.Episode: /// <summary> Gets report stat result. </summary>
case ReportViewType.Video: /// <param name="items"> The items. </param>
case ReportViewType.MusicVideo: /// <param name="reportIncludeItemTypes"> List of types of the report include items. </param>
case ReportViewType.Trailer: /// <param name="topItem"> The top item. </param>
case ReportViewType.Audio: /// <returns> The report stat result. </returns>
case ReportViewType.BaseItem: public ReportStatResult GetResult(BaseItem[] items, ReportIncludeItemTypes reportIncludeItemTypes, int topItem = 5)
default: {
break; ReportStatResult result = new ReportStatResult();
} result = this.GetResultGenres(result, items, topItem);
result = this.GetResultStudios(result, items, topItem);
result = this.GetResultPersons(result, items, topItem);
result = this.GetResultProductionYears(result, items, topItem);
result = this.GetResulProductionLocations(result, items, topItem);
result = this.GetResultCommunityRatings(result, items, topItem);
result = this.GetResultParentalRatings(result, items, topItem);
result.Groups = result.Groups.OrderByDescending(n => n.Items.Count()).ToList(); switch (reportIncludeItemTypes)
{
case ReportIncludeItemTypes.Season:
case ReportIncludeItemTypes.Series:
case ReportIncludeItemTypes.MusicAlbum:
case ReportIncludeItemTypes.MusicArtist:
case ReportIncludeItemTypes.Game:
break;
case ReportIncludeItemTypes.Movie:
case ReportIncludeItemTypes.BoxSet:
return result; break;
} case ReportIncludeItemTypes.Book:
case ReportIncludeItemTypes.Episode:
case ReportIncludeItemTypes.Video:
case ReportIncludeItemTypes.MusicVideo:
case ReportIncludeItemTypes.Trailer:
case ReportIncludeItemTypes.Audio:
case ReportIncludeItemTypes.BaseItem:
default:
break;
}
private ReportStatResult GetResultGenres(ReportStatResult result, BaseItem[] items, int topItem = 5) result.Groups = result.Groups.OrderByDescending(n => n.Items.Count()).ToList();
{
this.GetGroups(result, ReportHelper.GetServerLocalizedString("HeaderGenres"), topItem,
items.SelectMany(x => x.Genres)
.GroupBy(x => x)
.OrderByDescending(x => x.Count())
.Take(topItem)
.Select(x => new ReportStatItem
{
Name = x.Key,
Value = x.Count().ToString(),
Id = GetGenreID(x.Key)
}));
return result;
} return result;
}
private ReportStatResult GetResultStudios(ReportStatResult result, BaseItem[] items, int topItem = 5) #endregion
{
this.GetGroups(result, ReportHelper.GetServerLocalizedString("HeaderStudios"), topItem,
items.SelectMany(x => x.Studios)
.GroupBy(x => x)
.OrderByDescending(x => x.Count())
.Take(topItem)
.Select(x => new ReportStatItem
{
Name = x.Key,
Value = x.Count().ToString(),
Id = GetStudioID(x.Key)
})
);
return result; #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>
/// <seealso cref="M:MediaBrowser.Api.Reports.ReportBuilderBase.GetHeaders{H}(H)"/>
protected internal override List<ReportHeader> GetHeaders<H>(H request)
{
throw new NotImplementedException();
}
} #endregion
private ReportStatResult GetResultPersons(ReportStatResult result, BaseItem[] items, int topItem = 5) #region [Private Methods]
{
List<string> t = new List<string> { PersonType.Actor, PersonType.Composer, PersonType.Director, PersonType.GuestStar, PersonType.Producer, PersonType.Writer, "Artist", "AlbumArtist" };
foreach (var item in t)
{
this.GetGroups(result, ReportHelper.GetServerLocalizedString("Option" + item), topItem,
items.SelectMany(x => x.People)
.Where(n => n.Type == item)
.GroupBy(x => x.Name)
.OrderByDescending(x => x.Count())
.Take(topItem)
.Select(x => new ReportStatItem
{
Name = x.Key,
Value = x.Count().ToString(),
Id = GetPersonID(x.Key)
})
);
}
return result; /// <summary> Gets the groups. </summary>
} /// <param name="result"> The result. </param>
/// <param name="header"> The header. </param>
/// <param name="topItem"> The top item. </param>
/// <param name="top"> The top. </param>
private void GetGroups(ReportStatResult result, string header, int topItem, IEnumerable<ReportStatItem> top)
{
if (top.Count() > 0)
{
var group = new ReportStatGroup { Header = ReportStatGroup.FormatedHeader(header, topItem) };
group.Items.AddRange(top);
result.Groups.Add(group);
}
}
private ReportStatResult GetResultCommunityRatings(ReportStatResult result, BaseItem[] items, int topItem = 5) /// <summary> Gets resul production locations. </summary>
{ /// <param name="result"> The result. </param>
this.GetGroups(result, ReportHelper.GetServerLocalizedString("LabelCommunityRating"), topItem, /// <param name="items"> The items. </param>
items.Where(x => x.CommunityRating != null && x.CommunityRating > 0) /// <param name="topItem"> The top item. </param>
.GroupBy(x => x.CommunityRating) /// <returns> The resul production locations. </returns>
.OrderByDescending(x => x.Count()) private ReportStatResult GetResulProductionLocations(ReportStatResult result, BaseItem[] items, int topItem = 5)
.Take(topItem) {
.Select(x => new ReportStatItem this.GetGroups(result, ReportHelper.GetServerLocalizedString("HeaderCountries"), topItem,
{ items.OfType<IHasProductionLocations>()
Name = x.Key.ToString(), .Where(x => x.ProductionLocations != null)
Value = x.Count().ToString() .SelectMany(x => x.ProductionLocations)
}) .GroupBy(x => x)
); .OrderByDescending(x => x.Count())
.Take(topItem)
.Select(x => new ReportStatItem
{
Name = x.Key.ToString(),
Value = x.Count().ToString()
})
);
return result; return result;
} }
private ReportStatResult GetResultParentalRatings(ReportStatResult result, BaseItem[] items, int topItem = 5) /// <summary> Gets result community ratings. </summary>
{ /// <param name="result"> The result. </param>
this.GetGroups(result, ReportHelper.GetServerLocalizedString("HeaderParentalRatings"), topItem, /// <param name="items"> The items. </param>
items.Where(x => x.OfficialRating != null) /// <param name="topItem"> The top item. </param>
.GroupBy(x => x.OfficialRating) /// <returns> The result community ratings. </returns>
.OrderByDescending(x => x.Count()) private ReportStatResult GetResultCommunityRatings(ReportStatResult result, BaseItem[] items, int topItem = 5)
.Take(topItem) {
.Select(x => new ReportStatItem this.GetGroups(result, ReportHelper.GetServerLocalizedString("LabelCommunityRating"), topItem,
{ items.Where(x => x.CommunityRating != null && x.CommunityRating > 0)
Name = x.Key.ToString(), .GroupBy(x => x.CommunityRating)
Value = x.Count().ToString() .OrderByDescending(x => x.Count())
}) .Take(topItem)
); .Select(x => new ReportStatItem
{
Name = x.Key.ToString(),
Value = x.Count().ToString()
})
);
return result; return result;
} }
/// <summary> Gets result genres. </summary>
/// <param name="result"> The result. </param>
/// <param name="items"> The items. </param>
/// <param name="topItem"> The top item. </param>
/// <returns> The result genres. </returns>
private ReportStatResult GetResultGenres(ReportStatResult result, BaseItem[] items, int topItem = 5)
{
this.GetGroups(result, ReportHelper.GetServerLocalizedString("HeaderGenres"), topItem,
items.SelectMany(x => x.Genres)
.GroupBy(x => x)
.OrderByDescending(x => x.Count())
.Take(topItem)
.Select(x => new ReportStatItem
{
Name = x.Key,
Value = x.Count().ToString(),
Id = GetGenreID(x.Key)
}));
return result;
private ReportStatResult GetResultProductionYears(ReportStatResult result, BaseItem[] items, int topItem = 5) }
{
this.GetGroups(result, ReportHelper.GetServerLocalizedString("HeaderYears"), topItem,
items.Where(x => x.ProductionYear != null && x.ProductionYear > 0)
.GroupBy(x => x.ProductionYear)
.OrderByDescending(x => x.Count())
.Take(topItem)
.Select(x => new ReportStatItem
{
Name = x.Key.ToString(),
Value = x.Count().ToString()
})
);
return result; /// <summary> Gets result parental ratings. </summary>
} /// <param name="result"> The result. </param>
/// <param name="items"> The items. </param>
/// <param name="topItem"> The top item. </param>
/// <returns> The result parental ratings. </returns>
private ReportStatResult GetResultParentalRatings(ReportStatResult result, BaseItem[] items, int topItem = 5)
{
this.GetGroups(result, ReportHelper.GetServerLocalizedString("HeaderParentalRatings"), topItem,
items.Where(x => x.OfficialRating != null)
.GroupBy(x => x.OfficialRating)
.OrderByDescending(x => x.Count())
.Take(topItem)
.Select(x => new ReportStatItem
{
Name = x.Key.ToString(),
Value = x.Count().ToString()
})
);
private ReportStatResult GetResulProductionLocations(ReportStatResult result, BaseItem[] items, int topItem = 5) return result;
{ }
this.GetGroups(result, ReportHelper.GetServerLocalizedString("HeaderCountries"), topItem,
items.OfType<IHasProductionLocations>()
.Where(x => x.ProductionLocations != null)
.SelectMany(x => x.ProductionLocations)
.GroupBy(x => x)
.OrderByDescending(x => x.Count())
.Take(topItem)
.Select(x => new ReportStatItem
{
Name = x.Key.ToString(),
Value = x.Count().ToString()
})
);
return result; /// <summary> Gets result persons. </summary>
} /// <param name="result"> The result. </param>
/// <param name="items"> The items. </param>
/// <param name="topItem"> The top item. </param>
/// <returns> The result persons. </returns>
private ReportStatResult GetResultPersons(ReportStatResult result, BaseItem[] items, int topItem = 5)
{
List<string> t = new List<string> { PersonType.Actor, PersonType.Composer, PersonType.Director, PersonType.GuestStar, PersonType.Producer, PersonType.Writer, "Artist", "AlbumArtist" };
foreach (var item in t)
{
this.GetGroups(result, ReportHelper.GetServerLocalizedString("Option" + item), topItem,
items.SelectMany(x => x.People)
.Where(n => n.Type == item)
.GroupBy(x => x.Name)
.OrderByDescending(x => x.Count())
.Take(topItem)
.Select(x => new ReportStatItem
{
Name = x.Key,
Value = x.Count().ToString(),
Id = GetPersonID(x.Key)
})
);
}
return result;
}
/// <summary> Gets the groups. </summary> /// <summary> Gets result production years. </summary>
/// <param name="result"> The result. </param> /// <param name="result"> The result. </param>
/// <param name="header"> The header. </param> /// <param name="items"> The items. </param>
/// <param name="topItem"> The top item. </param> /// <param name="topItem"> The top item. </param>
/// <param name="top"> The top. </param> /// <returns> The result production years. </returns>
private void GetGroups(ReportStatResult result, string header, int topItem, IEnumerable<ReportStatItem> top) private ReportStatResult GetResultProductionYears(ReportStatResult result, BaseItem[] items, int topItem = 5)
{ {
if (top.Count() > 0) this.GetGroups(result, ReportHelper.GetServerLocalizedString("HeaderYears"), topItem,
{ items.Where(x => x.ProductionYear != null && x.ProductionYear > 0)
var group = new ReportStatGroup { Header = ReportStatGroup.FormatedHeader(header, topItem) }; .GroupBy(x => x.ProductionYear)
group.Items.AddRange(top); .OrderByDescending(x => x.Count())
result.Groups.Add(group); .Take(topItem)
} .Select(x => new ReportStatItem
} {
} Name = x.Key.ToString(),
Value = x.Count().ToString()
})
);
return result;
}
/// <summary> Gets result studios. </summary>
/// <param name="result"> The result. </param>
/// <param name="items"> The items. </param>
/// <param name="topItem"> The top item. </param>
/// <returns> The result studios. </returns>
private ReportStatResult GetResultStudios(ReportStatResult result, BaseItem[] items, int topItem = 5)
{
this.GetGroups(result, ReportHelper.GetServerLocalizedString("HeaderStudios"), topItem,
items.SelectMany(x => x.Studios)
.GroupBy(x => x)
.OrderByDescending(x => x.Count())
.Take(topItem)
.Select(x => new ReportStatItem
{
Name = x.Key,
Value = x.Count().ToString(),
Id = GetStudioID(x.Key)
})
);
return result;
}
#endregion
}
} }

7
MediaBrowser.Server.Implementations/Localization/Server/server.json
View file

@ -1448,6 +1448,7 @@
"OptionReportList": "List View", "OptionReportList": "List View",
"OptionReportStatistics": "Statistics", "OptionReportStatistics": "Statistics",
"OptionReportGrouping": "Grouping", "OptionReportGrouping": "Grouping",
"OptionReportActivities": "Activities Log",
"HeaderExport": "Export", "HeaderExport": "Export",
"HeaderColumns": "Columns", "HeaderColumns": "Columns",
"ButtonReset": "Reset", "ButtonReset": "Reset",
@ -1455,5 +1456,9 @@
"ButtonUnlockGuide": "Unlock Guide", "ButtonUnlockGuide": "Unlock Guide",
"LabelEnableFullScreen": "Enable fullscreen mode", "LabelEnableFullScreen": "Enable fullscreen mode",
"LabelEnableChromecastAc3Passthrough": "Enable Chromecast AC3 Passthrough", "LabelEnableChromecastAc3Passthrough": "Enable Chromecast AC3 Passthrough",
"LabelSyncPath": "Synced content path:" "LabelSyncPath": "Synced content path:",
"HeaderOverview": "Overview",
"HeaderShortOverview": "Short Overview",
"HeaderType": "Type",
"HeaderSeverity": "Severity"
} }