ProfileManager.h

/*
 *  Copyright (C) 2013-2018 Team Kodi
 *  This file is part of Kodi - https://kodi.tv
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *  See LICENSES/README.md for more information.
 */

#pragma once

#include "profiles/Profile.h"
#include "settings/lib/ISettingCallback.h"
#include "settings/lib/ISettingsHandler.h"
#include "threads/CriticalSection.h"

#include <memory>
#include <stdint.h>
#include <vector>

class CEventLog;
class CEventLogManager;
class CSettings;
class TiXmlNode;

class CProfileManager : protected ISettingsHandler,
                         protected ISettingCallback
{
public:
  CProfileManager();
  CProfileManager(const CProfileManager&) = delete;
  CProfileManager& operator=(CProfileManager const&) = delete;
  ~CProfileManager() override;

  void Initialize(const std::shared_ptr<CSettings>& settings);
  void Uninitialize();

  void OnSettingsLoaded() override;
  void OnSettingsSaved() const override;
  void OnSettingsCleared() override;

  bool Load();
  bool Save() const;
  void Clear();

  bool LoadProfile(unsigned int index);
  void LogOff();

  bool DeleteProfile(unsigned int index);

  void CreateProfileFolders();

  const CProfile& GetMasterProfile() const;

  const CProfile& GetCurrentProfile() const;

  const CProfile* GetProfile(unsigned int index) const;

  CProfile* GetProfile(unsigned int index);

  int GetProfileIndex(const std::string &name) const;

  size_t GetNumberOfProfiles() const { return m_profiles.size(); }

  void AddProfile(const CProfile &profile);

  bool UsingLoginScreen() const { return m_usingLoginScreen; }

  void ToggleLoginScreen()
  {
    m_usingLoginScreen = !m_usingLoginScreen;
    Save();
  }

  bool IsMasterProfile() const { return m_currentProfile == 0; }

  void UpdateCurrentProfileDate();

  void LoadMasterProfileForLogin();

  uint32_t GetLastUsedProfileIndex() const { return m_lastUsedProfile; }

  uint32_t GetCurrentProfileIndex() const { return m_currentProfile; }

  int GetNextProfileId() const { return m_nextProfileId; }

  int GetCurrentProfileId() const { return GetCurrentProfile().getId(); }

  int GetAutoLoginProfileId() const { return m_autoLoginProfile; }

  void SetAutoLoginProfileId(const int profileId)
  {
    m_autoLoginProfile = profileId;
    Save();
  }

  bool GetProfileName(const unsigned int profileId, std::string& name) const;

  std::string GetUserDataFolder() const;
  std::string GetProfileUserDataFolder() const;
  std::string GetDatabaseFolder() const;
  std::string GetCDDBFolder() const;
  std::string GetThumbnailsFolder() const;
  std::string GetVideoThumbFolder() const;
  std::string GetBookmarksThumbFolder() const;
  std::string GetLibraryFolder() const;
  std::string GetSavestatesFolder() const;
  std::string GetSettingsFile() const;

  // uses HasSlashAtEnd to determine if a directory or file was meant
  std::string GetUserDataItem(const std::string& strFile) const;

  // Event log access
  CEventLog &GetEventLog();

protected:
  // implementation of ISettingCallback
  void OnSettingAction(const std::shared_ptr<const CSetting>& setting) override;

private:
  void SetCurrentProfileId(unsigned int profileId);

  void PrepareLoadProfile(unsigned int profileIndex);
  void FinalizeLoadProfile();

  // Construction parameters
  std::shared_ptr<CSettings> m_settings;

  std::vector<CProfile> m_profiles;
  bool m_usingLoginScreen = false;
  bool m_profileLoadedForLogin = false;
  bool m_previousProfileLoadedForLogin = false;
  int m_autoLoginProfile = -1;
  unsigned int m_lastUsedProfile = 0;
  unsigned int m_currentProfile =
      0; // do not modify directly, use SetCurrentProfileId() function instead
  int m_nextProfileId =
      0; // for tracking the next available id to give to a new profile to ensure id's are not re-used
  mutable CCriticalSection m_critical;

  // Event properties
  std::unique_ptr<CEventLogManager> m_eventLogs;
};