From 31c2d9853288fa1addac3c7c3b97a9e9d084c531 Mon Sep 17 00:00:00 2001 From: Luke Pulverenti Date: Fri, 5 Apr 2013 15:34:33 -0400 Subject: [PATCH] Added a display preferences manager --- MediaBrowser.Api/DisplayPreferencesService.cs | 18 ++-- .../Library/IDisplayPreferencesManager.cs | 28 ++++++ .../Library/IUserManager.cs | 25 ++--- .../MediaBrowser.Controller.csproj | 1 + .../Library/DisplayPreferencesManager.cs | 93 +++++++++++++++++++ .../Library/UserManager.cs | 71 +------------- ...MediaBrowser.Server.Implementations.csproj | 1 + MediaBrowser.ServerApplication/App.xaml.cs | 2 +- .../ApplicationHost.cs | 22 +++-- .../LibraryExplorer.xaml.cs | 22 +++-- .../MainWindow.xaml.cs | 6 +- 11 files changed, 175 insertions(+), 114 deletions(-) create mode 100644 MediaBrowser.Controller/Library/IDisplayPreferencesManager.cs create mode 100644 MediaBrowser.Server.Implementations/Library/DisplayPreferencesManager.cs diff --git a/MediaBrowser.Api/DisplayPreferencesService.cs b/MediaBrowser.Api/DisplayPreferencesService.cs index 99b37444cf..8372ecd36b 100644 --- a/MediaBrowser.Api/DisplayPreferencesService.cs +++ b/MediaBrowser.Api/DisplayPreferencesService.cs @@ -32,7 +32,7 @@ namespace MediaBrowser.Api /// Gets or sets the id. /// /// The id. - [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")] + [ApiMember(Name = "Id", Description = "Item Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")] public Guid Id { get; set; } } @@ -42,23 +42,23 @@ namespace MediaBrowser.Api public class DisplayPreferencesService : BaseApiService { /// - /// The _user manager + /// The _display preferences manager /// - private readonly IUserManager _userManager; + private readonly IDisplayPreferencesManager _displayPreferencesManager; /// /// The _json serializer /// private readonly IJsonSerializer _jsonSerializer; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// - /// The user manager. /// The json serializer. - public DisplayPreferencesService(IUserManager userManager, IJsonSerializer jsonSerializer) + /// The display preferences manager. + public DisplayPreferencesService(IJsonSerializer jsonSerializer, IDisplayPreferencesManager displayPreferencesManager) { - _userManager = userManager; _jsonSerializer = jsonSerializer; + _displayPreferencesManager = displayPreferencesManager; } /// @@ -67,7 +67,7 @@ namespace MediaBrowser.Api /// The request. public object Get(GetDisplayPreferences request) { - var task = _userManager.GetDisplayPreferences(request.Id); + var task = _displayPreferencesManager.GetDisplayPreferences(request.Id); return ToOptimizedResult(task.Result); } @@ -86,7 +86,7 @@ namespace MediaBrowser.Api // Serialize to json and then back so that the core doesn't see the request dto type var displayPreferences = _jsonSerializer.DeserializeFromString(_jsonSerializer.SerializeToString(request)); - var task = _userManager.SaveDisplayPreferences(displayPreferences, CancellationToken.None); + var task = _displayPreferencesManager.SaveDisplayPreferences(displayPreferences, CancellationToken.None); Task.WaitAll(task); } diff --git a/MediaBrowser.Controller/Library/IDisplayPreferencesManager.cs b/MediaBrowser.Controller/Library/IDisplayPreferencesManager.cs new file mode 100644 index 0000000000..f1d782b1d0 --- /dev/null +++ b/MediaBrowser.Controller/Library/IDisplayPreferencesManager.cs @@ -0,0 +1,28 @@ +using MediaBrowser.Model.Entities; +using System; +using System.Threading; +using System.Threading.Tasks; + +namespace MediaBrowser.Controller.Library +{ + /// + /// Interface IDisplayPreferencesManager + /// + public interface IDisplayPreferencesManager + { + /// + /// Gets the display preferences. + /// + /// The display preferences id. + /// DisplayPreferences. + Task GetDisplayPreferences(Guid displayPreferencesId); + + /// + /// Saves display preferences for an item + /// + /// The display preferences. + /// The cancellation token. + /// Task. + Task SaveDisplayPreferences(DisplayPreferences displayPreferences, CancellationToken cancellationToken); + } +} diff --git a/MediaBrowser.Controller/Library/IUserManager.cs b/MediaBrowser.Controller/Library/IUserManager.cs index 1c276ffebd..ad46cf7c33 100644 --- a/MediaBrowser.Controller/Library/IUserManager.cs +++ b/MediaBrowser.Controller/Library/IUserManager.cs @@ -1,7 +1,6 @@ using MediaBrowser.Common.Events; using MediaBrowser.Controller.Entities; using MediaBrowser.Model.Connectivity; -using MediaBrowser.Model.Entities; using System; using System.Collections.Generic; using System.Threading; @@ -9,6 +8,9 @@ using System.Threading.Tasks; namespace MediaBrowser.Controller.Library { + /// + /// Interface IUserManager + /// public interface IUserManager { /// @@ -173,7 +175,7 @@ namespace MediaBrowser.Controller.Library Task ChangePassword(User user, string newPassword); /// - /// Saves display preferences for an item + /// Saves the user data. /// /// The user id. /// The user data id. @@ -184,26 +186,11 @@ namespace MediaBrowser.Controller.Library CancellationToken cancellationToken); /// - /// Gets the display preferences. + /// Gets the user data. /// /// The user id. /// The user data id. - /// Task{DisplayPreferences}. + /// Task{UserItemData}. Task GetUserData(Guid userId, Guid userDataId); - - /// - /// Gets the display preferences. - /// - /// The display preferences id. - /// DisplayPreferences. - Task GetDisplayPreferences(Guid displayPreferencesId); - - /// - /// Saves display preferences for an item - /// - /// The display preferences. - /// The cancellation token. - /// Task. - Task SaveDisplayPreferences(DisplayPreferences displayPreferences, CancellationToken cancellationToken); } } diff --git a/MediaBrowser.Controller/MediaBrowser.Controller.csproj b/MediaBrowser.Controller/MediaBrowser.Controller.csproj index 2e7a8a994f..48662fe220 100644 --- a/MediaBrowser.Controller/MediaBrowser.Controller.csproj +++ b/MediaBrowser.Controller/MediaBrowser.Controller.csproj @@ -88,6 +88,7 @@ + diff --git a/MediaBrowser.Server.Implementations/Library/DisplayPreferencesManager.cs b/MediaBrowser.Server.Implementations/Library/DisplayPreferencesManager.cs new file mode 100644 index 0000000000..a8e51a75b3 --- /dev/null +++ b/MediaBrowser.Server.Implementations/Library/DisplayPreferencesManager.cs @@ -0,0 +1,93 @@ +using MediaBrowser.Controller; +using MediaBrowser.Controller.Library; +using MediaBrowser.Model.Entities; +using MediaBrowser.Model.Logging; +using System; +using System.Collections.Concurrent; +using System.Threading; +using System.Threading.Tasks; + +namespace MediaBrowser.Server.Implementations.Library +{ + /// + /// Class DisplayPreferencesManager + /// + public class DisplayPreferencesManager : IDisplayPreferencesManager + { + /// + /// The _logger + /// + private readonly ILogger _logger; + + /// + /// The _display preferences + /// + private readonly ConcurrentDictionary> _displayPreferences = new ConcurrentDictionary>(); + + /// + /// Initializes a new instance of the class. + /// + /// The logger. + public DisplayPreferencesManager(ILogger logger) + { + _logger = logger; + } + + /// + /// Gets the display preferences. + /// + /// The display preferences id. + /// DisplayPreferences. + public Task GetDisplayPreferences(Guid displayPreferencesId) + { + return _displayPreferences.GetOrAdd(displayPreferencesId, keyName => RetrieveDisplayPreferences(displayPreferencesId)); + } + + /// + /// Retrieves the display preferences. + /// + /// The display preferences id. + /// DisplayPreferences. + private async Task RetrieveDisplayPreferences(Guid displayPreferencesId) + { + var displayPreferences = await Kernel.Instance.DisplayPreferencesRepository.GetDisplayPreferences(displayPreferencesId).ConfigureAwait(false); + + return displayPreferences ?? new DisplayPreferences { Id = displayPreferencesId }; + } + + /// + /// Saves display preferences for an item + /// + /// The display preferences. + /// The cancellation token. + /// Task. + public async Task SaveDisplayPreferences(DisplayPreferences displayPreferences, CancellationToken cancellationToken) + { + if (displayPreferences == null) + { + throw new ArgumentNullException("displayPreferences"); + } + if (displayPreferences.Id == Guid.Empty) + { + throw new ArgumentNullException("displayPreferences.Id"); + } + + try + { + await Kernel.Instance.DisplayPreferencesRepository.SaveDisplayPreferences(displayPreferences, + cancellationToken).ConfigureAwait(false); + + var newValue = Task.FromResult(displayPreferences); + + // Once it succeeds, put it into the dictionary to make it available to everyone else + _displayPreferences.AddOrUpdate(displayPreferences.Id, newValue, delegate { return newValue; }); + } + catch (Exception ex) + { + _logger.ErrorException("Error saving display preferences", ex); + + throw; + } + } + } +} diff --git a/MediaBrowser.Server.Implementations/Library/UserManager.cs b/MediaBrowser.Server.Implementations/Library/UserManager.cs index a122e2c6d6..682ec9a8c8 100644 --- a/MediaBrowser.Server.Implementations/Library/UserManager.cs +++ b/MediaBrowser.Server.Implementations/Library/UserManager.cs @@ -5,7 +5,6 @@ using MediaBrowser.Controller.Configuration; using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Library; using MediaBrowser.Model.Connectivity; -using MediaBrowser.Model.Entities; using MediaBrowser.Model.Logging; using System; using System.Collections.Concurrent; @@ -99,11 +98,6 @@ namespace MediaBrowser.Server.Implementations.Library /// The configuration manager. private IServerConfigurationManager ConfigurationManager { get; set; } - /// - /// The _user data - /// - private readonly ConcurrentDictionary> _displayPreferences = new ConcurrentDictionary>(); - private readonly ConcurrentDictionary> _userData = new ConcurrentDictionary>(); /// @@ -165,63 +159,6 @@ namespace MediaBrowser.Server.Implementations.Library } #endregion - /// - /// Gets the display preferences. - /// - /// The display preferences id. - /// DisplayPreferences. - public Task GetDisplayPreferences(Guid displayPreferencesId) - { - return _displayPreferences.GetOrAdd(displayPreferencesId, keyName => RetrieveDisplayPreferences(displayPreferencesId)); - } - - /// - /// Retrieves the display preferences. - /// - /// The display preferences id. - /// DisplayPreferences. - private async Task RetrieveDisplayPreferences(Guid displayPreferencesId) - { - var displayPreferences = await Kernel.Instance.DisplayPreferencesRepository.GetDisplayPreferences(displayPreferencesId).ConfigureAwait(false); - - return displayPreferences ?? new DisplayPreferences { Id = displayPreferencesId }; - } - - /// - /// Saves display preferences for an item - /// - /// The display preferences. - /// The cancellation token. - /// Task. - public async Task SaveDisplayPreferences(DisplayPreferences displayPreferences, CancellationToken cancellationToken) - { - if (displayPreferences == null) - { - throw new ArgumentNullException("displayPreferences"); - } - if (displayPreferences.Id == Guid.Empty) - { - throw new ArgumentNullException("displayPreferences.Id"); - } - - try - { - await Kernel.Instance.DisplayPreferencesRepository.SaveDisplayPreferences(displayPreferences, - cancellationToken).ConfigureAwait(false); - - var newValue = Task.FromResult(displayPreferences); - - // Once it succeeds, put it into the dictionary to make it available to everyone else - _displayPreferences.AddOrUpdate(displayPreferences.Id, newValue, delegate { return newValue; }); - } - catch (Exception ex) - { - _logger.ErrorException("Error saving display preferences", ex); - - throw; - } - } - /// /// Gets a User by Id /// @@ -802,11 +739,11 @@ namespace MediaBrowser.Server.Implementations.Library } /// - /// Gets the display preferences. + /// Gets the user data. /// /// The user id. /// The user data id. - /// Task{DisplayPreferences}. + /// Task{UserItemData}. public Task GetUserData(Guid userId, Guid userDataId) { var key = userId + userDataId.ToString(); @@ -815,11 +752,11 @@ namespace MediaBrowser.Server.Implementations.Library } /// - /// Retrieves the display preferences. + /// Retrieves the user data. /// /// The user id. /// The user data id. - /// DisplayPreferences. + /// Task{UserItemData}. private async Task RetrieveUserData(Guid userId, Guid userDataId) { var userdata = await Kernel.Instance.UserDataRepository.GetUserData(userId, userDataId).ConfigureAwait(false); diff --git a/MediaBrowser.Server.Implementations/MediaBrowser.Server.Implementations.csproj b/MediaBrowser.Server.Implementations/MediaBrowser.Server.Implementations.csproj index 043ef08450..f2593f1c5a 100644 --- a/MediaBrowser.Server.Implementations/MediaBrowser.Server.Implementations.csproj +++ b/MediaBrowser.Server.Implementations/MediaBrowser.Server.Implementations.csproj @@ -130,6 +130,7 @@ + diff --git a/MediaBrowser.ServerApplication/App.xaml.cs b/MediaBrowser.ServerApplication/App.xaml.cs index 35f203a629..3161048f04 100644 --- a/MediaBrowser.ServerApplication/App.xaml.cs +++ b/MediaBrowser.ServerApplication/App.xaml.cs @@ -165,7 +165,7 @@ namespace MediaBrowser.ServerApplication await CompositionRoot.Init(); - var win = new MainWindow(CompositionRoot.LogManager, CompositionRoot, CompositionRoot.ServerConfigurationManager, CompositionRoot.UserManager, CompositionRoot.LibraryManager, CompositionRoot.JsonSerializer); + var win = new MainWindow(CompositionRoot.LogManager, CompositionRoot, CompositionRoot.ServerConfigurationManager, CompositionRoot.UserManager, CompositionRoot.LibraryManager, CompositionRoot.JsonSerializer, CompositionRoot.DisplayPreferencesManager); win.Show(); } diff --git a/MediaBrowser.ServerApplication/ApplicationHost.cs b/MediaBrowser.ServerApplication/ApplicationHost.cs index 131d0a7e7f..c782eac188 100644 --- a/MediaBrowser.ServerApplication/ApplicationHost.cs +++ b/MediaBrowser.ServerApplication/ApplicationHost.cs @@ -1,8 +1,4 @@ -using System.Diagnostics; -using System.Net.Cache; -using System.Net.Http; -using System.Net.Sockets; -using MediaBrowser.Api; +using MediaBrowser.Api; using MediaBrowser.Common; using MediaBrowser.Common.Configuration; using MediaBrowser.Common.Constants; @@ -46,8 +42,10 @@ using MediaBrowser.ServerApplication.Implementations; using MediaBrowser.WebDashboard.Api; using System; using System.Collections.Generic; +using System.Diagnostics; using System.IO; using System.Linq; +using System.Net.Sockets; using System.Reflection; using System.Threading; using System.Threading.Tasks; @@ -140,6 +138,11 @@ namespace MediaBrowser.ServerApplication /// /// The UDP server. private UdpServer UdpServer { get; set; } + /// + /// Gets or sets the display preferences manager. + /// + /// The display preferences manager. + internal IDisplayPreferencesManager DisplayPreferencesManager { get; set; } /// /// The full path to our startmenu shortcut @@ -212,8 +215,11 @@ namespace MediaBrowser.ServerApplication ProviderManager = new ProviderManager(HttpClient, ServerConfigurationManager, DirectoryWatchers, LogManager); RegisterSingleInstance(ProviderManager); + DisplayPreferencesManager = new DisplayPreferencesManager(LogManager.GetLogger("DisplayPreferencesManager")); + RegisterSingleInstance(DisplayPreferencesManager); + RegisterSingleInstance(() => new LuceneSearchEngine()); - + SetKernelProperties(); SetStaticProperties(); } @@ -409,8 +415,8 @@ namespace MediaBrowser.ServerApplication public override void Shutdown() { App.Instance.Dispatcher.Invoke(App.Instance.Shutdown); - } - + } + /// /// Registers the server with administrator access. /// diff --git a/MediaBrowser.ServerApplication/LibraryExplorer.xaml.cs b/MediaBrowser.ServerApplication/LibraryExplorer.xaml.cs index c72cf03407..84b3d0c5f0 100644 --- a/MediaBrowser.ServerApplication/LibraryExplorer.xaml.cs +++ b/MediaBrowser.ServerApplication/LibraryExplorer.xaml.cs @@ -33,7 +33,7 @@ namespace MediaBrowser.ServerApplication private readonly IJsonSerializer _jsonSerializer; private readonly ILibraryManager _libraryManager; - private readonly IUserManager _userManager; + private readonly IDisplayPreferencesManager _displayPreferencesManager; /// /// The current user @@ -42,12 +42,18 @@ namespace MediaBrowser.ServerApplication /// /// Initializes a new instance of the class. /// - public LibraryExplorer(IJsonSerializer jsonSerializer, ILogger logger, IApplicationHost appHost, IUserManager userManager, ILibraryManager libraryManager) + /// The json serializer. + /// The logger. + /// The app host. + /// The user manager. + /// The library manager. + /// The display preferences manager. + public LibraryExplorer(IJsonSerializer jsonSerializer, ILogger logger, IApplicationHost appHost, IUserManager userManager, ILibraryManager libraryManager, IDisplayPreferencesManager displayPreferencesManager) { _logger = logger; _jsonSerializer = jsonSerializer; _libraryManager = libraryManager; - _userManager = userManager; + _displayPreferencesManager = displayPreferencesManager; InitializeComponent(); lblVersion.Content = "Version: " + appHost.ApplicationVersion; @@ -91,7 +97,7 @@ namespace MediaBrowser.ServerApplication var currentFolder = folder; Task.Factory.StartNew(() => { - var prefs = ddlProfile.SelectedItem != null ? _userManager.GetDisplayPreferences(currentFolder.GetDisplayPreferencesId((ddlProfile.SelectedItem as User).Id)).Result ?? new DisplayPreferences { SortBy = ItemSortBy.SortName } : new DisplayPreferences { SortBy = ItemSortBy.SortName }; + var prefs = ddlProfile.SelectedItem != null ? _displayPreferencesManager.GetDisplayPreferences(currentFolder.GetDisplayPreferencesId((ddlProfile.SelectedItem as User).Id)).Result ?? new DisplayPreferences { SortBy = ItemSortBy.SortName } : new DisplayPreferences { SortBy = ItemSortBy.SortName }; var node = new TreeViewItem { Tag = currentFolder }; var subChildren = currentFolder.GetChildren(CurrentUser, prefs.IndexBy); @@ -144,7 +150,7 @@ namespace MediaBrowser.ServerApplication var subFolder = item as Folder; if (subFolder != null) { - var prefs = _userManager.GetDisplayPreferences(subFolder.GetDisplayPreferencesId(user.Id)).Result; + var prefs = _displayPreferencesManager.GetDisplayPreferences(subFolder.GetDisplayPreferencesId(user.Id)).Result; AddChildren(node, OrderBy(subFolder.GetChildren(user), user, prefs.SortBy), user); node.Header = item.Name + " (" + node.Items.Count + ")"; @@ -201,7 +207,7 @@ namespace MediaBrowser.ServerApplication var prefs = await - _userManager.GetDisplayPreferences(folder.GetDisplayPreferencesId((ddlProfile.SelectedItem as User).Id)); + _displayPreferencesManager.GetDisplayPreferences(folder.GetDisplayPreferencesId((ddlProfile.SelectedItem as User).Id)); ddlIndexBy.SelectedItem = prefs != null ? prefs.IndexBy ?? LocalizedStrings.Instance.GetString("NoneDispPref") @@ -360,7 +366,7 @@ namespace MediaBrowser.ServerApplication var folder = treeItem != null ? treeItem.Tag as Folder : null; - var prefs = folder != null ? _userManager.GetDisplayPreferences(folder.GetDisplayPreferencesId(CurrentUser.Id)).Result : new DisplayPreferences {SortBy = ItemSortBy.SortName}; + var prefs = folder != null ? _displayPreferencesManager.GetDisplayPreferences(folder.GetDisplayPreferencesId(CurrentUser.Id)).Result : new DisplayPreferences { SortBy = ItemSortBy.SortName }; if (folder != null && prefs.IndexBy != ddlIndexBy.SelectedItem as string) { //grab UI context so we can update within the below task @@ -401,7 +407,7 @@ namespace MediaBrowser.ServerApplication var folder = treeItem != null ? treeItem.Tag as Folder : null; - var prefs = folder != null ? _userManager.GetDisplayPreferences(folder.GetDisplayPreferencesId(CurrentUser.Id)).Result : new DisplayPreferences(); + var prefs = folder != null ? _displayPreferencesManager.GetDisplayPreferences(folder.GetDisplayPreferencesId(CurrentUser.Id)).Result : new DisplayPreferences(); if (folder != null && prefs.SortBy != ddlSortBy.SelectedItem as string) { //grab UI context so we can update within the below task diff --git a/MediaBrowser.ServerApplication/MainWindow.xaml.cs b/MediaBrowser.ServerApplication/MainWindow.xaml.cs index f64b7c9d7d..d3ad61a7da 100644 --- a/MediaBrowser.ServerApplication/MainWindow.xaml.cs +++ b/MediaBrowser.ServerApplication/MainWindow.xaml.cs @@ -43,6 +43,7 @@ namespace MediaBrowser.ServerApplication private readonly IUserManager _userManager; private readonly ILibraryManager _libraryManager; private readonly IJsonSerializer _jsonSerializer; + private readonly IDisplayPreferencesManager _displayPreferencesManager; /// /// Initializes a new instance of the class. @@ -51,7 +52,7 @@ namespace MediaBrowser.ServerApplication /// The logger. /// The app host. /// logger - public MainWindow(ILogManager logManager, IApplicationHost appHost, IServerConfigurationManager configurationManager, IUserManager userManager, ILibraryManager libraryManager, IJsonSerializer jsonSerializer) + public MainWindow(ILogManager logManager, IApplicationHost appHost, IServerConfigurationManager configurationManager, IUserManager userManager, ILibraryManager libraryManager, IJsonSerializer jsonSerializer, IDisplayPreferencesManager displayPreferencesManager) { if (logManager == null) { @@ -73,6 +74,7 @@ namespace MediaBrowser.ServerApplication _userManager = userManager; _libraryManager = libraryManager; _jsonSerializer = jsonSerializer; + _displayPreferencesManager = displayPreferencesManager; InitializeComponent(); @@ -223,7 +225,7 @@ namespace MediaBrowser.ServerApplication /// The instance containing the event data. private void cmOpenExplorer_click(object sender, RoutedEventArgs e) { - new LibraryExplorer(_jsonSerializer, _logger, _appHost, _userManager, _libraryManager).Show(); + new LibraryExplorer(_jsonSerializer, _logger, _appHost, _userManager, _libraryManager, _displayPreferencesManager).Show(); } ///