// TortoiseSVN - a Windows shell extension for easy version control

// External Cache Copyright (C) 2005-2006, 2008, 2010, 2014, 2021 - TortoiseSVN

// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.

// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software Foundation,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
#pragma once

#include "StatusCacheEntry.h"
#include "TSVNPath.h"

/**
 * \ingroup TSVNCache
 * Holds the status for a folder and all files and folders directly inside
 * that folder.
 */
class CCachedDirectory
{
public:
    using CachedDirMap = std::map<CTSVNPath, CCachedDirectory*>;

    CCachedDirectory();
    CCachedDirectory(const CTSVNPath& directoryPath);
    ~CCachedDirectory();
    CStatusCacheEntry GetStatusForMember(const CTSVNPath& path, bool bRecursive, bool bFetch = true);
    CStatusCacheEntry GetCacheStatusForMember(const CTSVNPath& path);
    CStatusCacheEntry GetOwnStatus(bool bRecursive);
    bool              IsOwnStatusValid() const;
    void              Invalidate();
    void              RefreshStatus(bool bRecursive);
    void              RefreshMostImportant(bool bUpdateShell = true);
    BOOL              SaveToDisk(FILE* pFile);
    BOOL              LoadFromDisk(FILE* pFile);
    /// Get the current full status of this folder
    svn_wc_status_kind GetCurrentFullStatus() const { return m_currentFullStatus; }

private:
    static svn_error_t* GetStatusCallback(void* baton, const char* path, const svn_client_status_t* status, apr_pool_t* pool);
    void                AddEntry(const CTSVNPath& path, const svn_client_status_t* pSVNStatus, bool needsLock, bool forceNormal);
    CStringA            GetCacheKey(const CTSVNPath& path) const;
    CString             GetFullPathString(const CStringA& cacheKey) const;
    void                UpdateChildDirectoryStatus(const CTSVNPath& childDir, svn_wc_status_kind childStatus);
    bool                SvnUpdateMembersStatus();

    // Calculate the complete, composite status from ourselves, our files, and our descendants
    svn_wc_status_kind CalculateRecursiveStatus();

    // Update our composite status and deal with things if it's changed
    void UpdateCurrentStatus();
    void SetChildStatus(const CTSVNPath& childDir, svn_wc_status_kind childStatus);
    void SetChildStatus(const CStringA& childPath, svn_wc_status_kind childStatus);

private:
    CComAutoCriticalSection m_critSec;

    volatile LONG m_fetchingStatus;
    // The cache of files and directories within this directory
    using CacheEntryMap = std::map<CStringA, CStatusCacheEntry>;
    CacheEntryMap m_entryCache;

    /// A vector if iterators to child directories - used to put-together recursive status
    using ChildDirStatus = std::map<CStringA, svn_wc_status_kind>;
    ChildDirStatus m_childDirectories;

    // The timestamp of the .SVN\wc.db file. For an unversioned directory, this will be zero
    __int64 m_wcDbFileTime;

    // The path of the directory with this object looks after
    CTSVNPath m_directoryPath;

    // The status of THIS directory (not a composite of children or members)
    CStatusCacheEntry m_ownStatus;

    // Our current fully recursive status
    svn_wc_status_kind m_currentFullStatus;
    bool               m_bCurrentFullStatusValid;

    // The most important status from all our file entries
    svn_wc_status_kind m_mostImportantFileStatus;

    svn_client_ctx_t* m_pCtx;

    friend class CSVNStatusCache;
};