RecycleBin5 Class Reference

Inheritance diagram for RecycleBin5:

Collaboration diagram for RecycleBin5:

Public Member Functions
	RecycleBin5 ()
virtual	~RecycleBin5 ()
HRESULT	Init (_In_ LPCWSTR VolumePath)
STDMETHODIMP	QueryInterface (_In_ REFIID riid, _Out_ void **ppvObject) override
	STDMETHODIMP_ (ULONG) AddRef() override
	STDMETHODIMP_ (ULONG) Release() override
STDMETHODIMP	DeleteFile (_In_ LPCWSTR szFileName) override
STDMETHODIMP	EmptyRecycleBin () override
STDMETHODIMP	EnumObjects (_Out_ IRecycleBinEnumList **ppEnumList) override
STDMETHODIMP	GetDirectory (LPWSTR szPath) override
STDMETHODIMP	Delete (_In_ LPCWSTR pDeletedFileName, _In_ DELETED_FILE_RECORD *pDeletedFile) override
STDMETHODIMP	Restore (_In_ LPCWSTR pDeletedFileName, _In_ DELETED_FILE_RECORD *pDeletedFile) override
STDMETHODIMP	RemoveFromDatabase (_In_ LPCWSTR pDeletedFileName, _In_ DELETED_FILE_RECORD *pDeletedFile) override
STDMETHODIMP	OnClosing (_In_ IRecycleBinEnumList *prbel) override

Protected Attributes
LONG	m_ref
HANDLE	m_hInfo
HANDLE	m_hInfoMapped
DWORD	m_EnumeratorCount
CStringW	m_VolumePath
CStringW	m_Folder

Detailed Description

Definition at line 129 of file recyclebin_v5.cpp.

Constructor & Destructor Documentation

RecycleBin5()

RecycleBin5::RecycleBin5

(

)

Definition at line 666 of file recyclebin_v5.cpp.

    : m_ref(1)
    , m_hInfo(NULL)
    , m_hInfoMapped(NULL)
    , m_EnumeratorCount(0)
{
}

~RecycleBin5()

RecycleBin5::~RecycleBin5 ( )

virtual

Definition at line 202 of file recyclebin_v5.cpp.

{
    TRACE("(%p)\n", this);
 
    if (m_hInfo && m_hInfo != INVALID_HANDLE_VALUE)
        CloseHandle(m_hInfo);
    if (m_hInfoMapped)
        CloseHandle(m_hInfoMapped);
}

Member Function Documentation

Delete()

STDMETHODIMP RecycleBin5::Delete ( _In_ LPCWSTR  pDeletedFileName, _In_ DELETED_FILE_RECORD *  pDeletedFile  )

override

Definition at line 456 of file recyclebin_v5.cpp.

{
 
    TRACE("(%p, %s, %p)\n", this, debugstr_w(pDeletedFileName), pDeletedFile);
 
    int res = IntDeleteRecursive(pDeletedFileName);
    if (!res)
        return HResultFromWin32(GetLastError());
    res = RemoveFromDatabase(pDeletedFileName, pDeletedFile);
    if (res == 0)
        SHUpdateRecycleBinIcon(); // Full --> Empty
    return res;
}

DeleteFile()

STDMETHODIMP RecycleBin5::DeleteFile ( _In_ LPCWSTR  szFileName )

override

Definition at line 222 of file recyclebin_v5.cpp.

{
    LPWSTR szFullName = NULL;
    DWORD dwBufferLength = 0;
    LPWSTR lpFilePart;
    LPCWSTR Extension;
    CStringW DeletedFileName;
    WCHAR szUniqueId[64];
    DWORD len;
    HANDLE hFile = INVALID_HANDLE_VALUE;
    PINFO2_HEADER pHeader = NULL;
    PDELETED_FILE_RECORD pDeletedFile;
    ULARGE_INTEGER FileSize;
    DWORD dwAttributes, dwEntries;
    SYSTEMTIME SystemTime;
    DWORD ClusterSize, BytesPerSector, SectorsPerCluster;
    HRESULT hr;
    WIN32_FIND_DATAW wfd = {};
 
    TRACE("(%p, %s)\n", this, debugstr_w(szFileName));
 
    if (m_EnumeratorCount != 0)
        return HRESULT_FROM_WIN32(ERROR_SHARING_VIOLATION);
 
    /* Get full file name */
    while (TRUE)
    {
        len = GetFullPathNameW(szFileName, dwBufferLength, szFullName, &lpFilePart);
        if (len == 0)
        {
            if (szFullName)
                CoTaskMemFree(szFullName);
            return HResultFromWin32(GetLastError());
        }
        else if (len < dwBufferLength)
            break;
        if (szFullName)
            CoTaskMemFree(szFullName);
        dwBufferLength = len;
        szFullName = (LPWSTR)CoTaskMemAlloc(dwBufferLength * sizeof(WCHAR));
        if (!szFullName)
            return HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY);
    }
 
    /* Check if file exists */
    dwAttributes = GetFileAttributesW(szFullName);
    if (dwAttributes == INVALID_FILE_ATTRIBUTES)
    {
        CoTaskMemFree(szFullName);
        return HResultFromWin32(GetLastError());
    }
 
    if (dwBufferLength < 2 || szFullName[1] != ':')
    {
        /* Not a local file */
        CoTaskMemFree(szFullName);
        return HRESULT_FROM_WIN32(ERROR_INVALID_NAME);
    }
 
    hFile = CreateFileW(szFullName, 0, 0, NULL, OPEN_EXISTING, (dwAttributes & FILE_ATTRIBUTE_DIRECTORY) ? FILE_FLAG_BACKUP_SEMANTICS : 0, NULL);
    if (hFile == INVALID_HANDLE_VALUE)
    {
        hr = HResultFromWin32(GetLastError());
        goto cleanup;
    }
 
    /* Increase INFO2 file size */
    CloseHandle(m_hInfoMapped);
    SetFilePointer(m_hInfo, sizeof(DELETED_FILE_RECORD), NULL, FILE_END);
    SetEndOfFile(m_hInfo);
    m_hInfoMapped = CreateFileMappingW(m_hInfo, NULL, PAGE_READWRITE | SEC_COMMIT, 0, 0, NULL);
    if (!m_hInfoMapped)
    {
        hr = HResultFromWin32(GetLastError());
        goto cleanup;
    }
 
    /* Open INFO2 file */
    pHeader = (PINFO2_HEADER)MapViewOfFile(m_hInfoMapped, FILE_MAP_WRITE, 0, 0, 0);
    if (!pHeader)
    {
        hr = HResultFromWin32(GetLastError());
        goto cleanup;
    }
 
    /* Get number of entries */
    FileSize.u.LowPart = GetFileSize(m_hInfo, &FileSize.u.HighPart);
    if (FileSize.u.LowPart < sizeof(INFO2_HEADER))
    {
        hr = HResultFromWin32(GetLastError());
        goto cleanup;
    }
    dwEntries = (DWORD)((FileSize.QuadPart - sizeof(INFO2_HEADER)) / sizeof(DELETED_FILE_RECORD)) - 1;
    pDeletedFile = ((PDELETED_FILE_RECORD)(pHeader + 1)) + dwEntries;
 
    /* Get file size */
#if 0
    if (!GetFileSizeEx(hFile, (PLARGE_INTEGER)&FileSize))
    {
        hr = HResultFromWin32(GetLastError());
        goto cleanup;
    }
#else
    FileSize.u.LowPart = GetFileSize(hFile, &FileSize.u.HighPart);
    if (FileSize.u.LowPart == INVALID_FILE_SIZE && GetLastError() != NO_ERROR)
    {
        hr = HResultFromWin32(GetLastError());
        goto cleanup;
    }
#endif
    /* Check if file size is > 4Gb */
    if (FileSize.u.HighPart != 0)
    {
        /* Yes, this recyclebin can't support this file */
        hr = HRESULT_FROM_WIN32(ERROR_NOT_SUPPORTED);
        goto cleanup;
    }
    pHeader->dwTotalLogicalSize += FileSize.u.LowPart;
 
    /* Generate new name */
    Extension = PathFindExtensionW(szFullName);
    ZeroMemory(pDeletedFile, sizeof(DELETED_FILE_RECORD));
    if (dwEntries == 0)
        pDeletedFile->dwRecordUniqueId = 0;
    else
    {
        PDELETED_FILE_RECORD pLastDeleted = ((PDELETED_FILE_RECORD)(pHeader + 1)) + dwEntries - 1;
        pDeletedFile->dwRecordUniqueId = pLastDeleted->dwRecordUniqueId + 1;
    }
 
    pDeletedFile->dwDriveNumber = tolower(szFullName[0]) - 'a';
    _ultow(pDeletedFile->dwRecordUniqueId, szUniqueId, 10);
 
    DeletedFileName = m_Folder;
    DeletedFileName += L"\\D";
    DeletedFileName += (WCHAR)(L'a' + pDeletedFile->dwDriveNumber);
    DeletedFileName += szUniqueId;
    DeletedFileName += Extension;
 
    /* Get cluster size */
    if (!GetDiskFreeSpaceW(m_VolumePath, &SectorsPerCluster, &BytesPerSector, NULL, NULL))
    {
        hr = HResultFromWin32(GetLastError());
        goto cleanup;
    }
    ClusterSize = BytesPerSector * SectorsPerCluster;
 
    /* Get current time */
    GetSystemTime(&SystemTime);
    if (!SystemTimeToFileTime(&SystemTime, &pDeletedFile->DeletionTime))
    {
        hr = HResultFromWin32(GetLastError());
        goto cleanup;
    }
    pDeletedFile->dwPhysicalFileSize = ROUND_UP(FileSize.u.LowPart, ClusterSize);
 
    /* Set name */
    wcscpy(pDeletedFile->FileNameW, szFullName);
    if (WideCharToMultiByte(CP_ACP, 0, pDeletedFile->FileNameW, -1, pDeletedFile->FileNameA, MAX_PATH, NULL, NULL) == 0)
    {
        hr = HRESULT_FROM_WIN32(ERROR_INVALID_NAME);
        SetLastError(ERROR_INVALID_NAME);
        goto cleanup;
    }
 
    wfd.dwFileAttributes = dwAttributes;
    wfd.nFileSizeLow = FileSize.u.LowPart;
    GetFileTime(hFile, &wfd.ftCreationTime, &wfd.ftLastAccessTime, &wfd.ftLastWriteTime);
 
    /* Move file */
    if (MoveFileW(szFullName, DeletedFileName))
        hr = S_OK;
    else
        hr = HResultFromWin32(GetLastError());
 
    if (SUCCEEDED(hr))
    {
        RECYCLEBINFILEIDENTITY ident = { pDeletedFile->DeletionTime, DeletedFileName };
        CRecycleBin_NotifyRecycled(szFullName, &wfd, &ident);
    }
 
cleanup:
    if (pHeader)
        UnmapViewOfFile(pHeader);
    if (hFile != INVALID_HANDLE_VALUE)
        CloseHandle(hFile);
    CoTaskMemFree(szFullName);
    return hr;
}

EmptyRecycleBin()

STDMETHODIMP RecycleBin5::EmptyRecycleBin ( )

override

Definition at line 412 of file recyclebin_v5.cpp.

{
    TRACE("(%p)\n", this);
 
    while (TRUE)
    {
        IRecycleBinEnumList *prbel;
        HRESULT hr = EnumObjects(&prbel);
        if (!SUCCEEDED(hr))
            return hr;
 
        IRecycleBinFile *prbf;
        hr = prbel->Next(1, &prbf, NULL);
        prbel->Release();
        if (hr == S_FALSE)
            return S_OK;
        hr = prbf->Delete();
        prbf->Release();
        if (!SUCCEEDED(hr))
            return hr;
    }
}

EnumObjects()

STDMETHODIMP RecycleBin5::EnumObjects ( _Out_ IRecycleBinEnumList **  ppEnumList )

override

Definition at line 435 of file recyclebin_v5.cpp.

{
    TRACE("(%p, %p)\n", this, ppEnumList);
 
    IUnknown *pUnk;
    HRESULT hr = RecycleBin5Enum_Constructor(this, m_hInfo, m_hInfoMapped, m_Folder, &pUnk);
    if (!SUCCEEDED(hr))
        return hr;
 
    IRecycleBinEnumList *prbel;
    hr = pUnk->QueryInterface(IID_IRecycleBinEnumList, (void **)&prbel);
    if (SUCCEEDED(hr))
    {
        m_EnumeratorCount++;
        *ppEnumList = prbel;
    }
 
    pUnk->Release();
    return hr;
}

Referenced by EmptyRecycleBin().

GetDirectory()

STDMETHODIMP RecycleBin5::GetDirectory ( LPWSTR  szPath )

inlineoverride

Definition at line 146 of file recyclebin_v5.cpp.

    {
        if (!m_Folder[0])
            return E_UNEXPECTED;
        lstrcpynW(szPath, m_Folder, MAX_PATH);
        return S_OK;
    }

Init()

HRESULT RecycleBin5::Init

(

_In_ LPCWSTR

VolumePath

)

Definition at line 674 of file recyclebin_v5.cpp.

{
    DWORD FileSystemFlags;
    LPCWSTR RecycleBinDirectory;
    HANDLE tokenHandle = INVALID_HANDLE_VALUE;
    PTOKEN_USER TokenUserInfo = NULL;
    LPWSTR StringSid = NULL;
    DWORD Needed;
    INT len;
    HRESULT hr;
 
    m_VolumePath = VolumePath;
 
    /* Get information about file system */
    if (!GetVolumeInformationW(VolumePath, NULL, 0, NULL, NULL, &FileSystemFlags, NULL, 0))
    {
        hr = HRESULT_FROM_WIN32(GetLastError());
        goto cleanup;
    }
 
    if (!(FileSystemFlags & FILE_PERSISTENT_ACLS))
    {
        RecycleBinDirectory = RECYCLE_BIN_DIRECTORY_WITHOUT_ACL;
    }
    else
    {
        RecycleBinDirectory = RECYCLE_BIN_DIRECTORY_WITH_ACL;
 
        /* Get user SID */
        if (!OpenProcessToken(GetCurrentProcess(), TOKEN_QUERY, &tokenHandle))
        {
            hr = HRESULT_FROM_WIN32(GetLastError());
            goto cleanup;
        }
        if (GetTokenInformation(tokenHandle, TokenUser, NULL, 0, &Needed))
        {
            hr = E_FAIL;
            goto cleanup;
        }
        if (GetLastError() != ERROR_INSUFFICIENT_BUFFER)
        {
            hr = HRESULT_FROM_WIN32(GetLastError());
            goto cleanup;
        }
        TokenUserInfo = (PTOKEN_USER)HeapAlloc(GetProcessHeap(), 0, Needed);
        if (!TokenUserInfo)
        {
            hr = E_OUTOFMEMORY;
            goto cleanup;
        }
        if (!GetTokenInformation(tokenHandle, TokenUser, TokenUserInfo, (DWORD)Needed, &Needed))
        {
            hr = HRESULT_FROM_WIN32(GetLastError());
            goto cleanup;
        }
        if (!ConvertSidToStringSidW(TokenUserInfo->User.Sid, &StringSid))
        {
            hr = HRESULT_FROM_WIN32(GetLastError());
            goto cleanup;
        }
    }
 
    m_Folder = VolumePath;
    m_Folder += RecycleBinDirectory;
    if (StringSid)
    {
        m_Folder += L'\\';
        m_Folder += StringSid;
    }
    len = m_Folder.GetLength();
    m_Folder += L"\\" RECYCLE_BIN_FILE_NAME;
 
    m_hInfo = CreateFileW(m_Folder, GENERIC_READ | GENERIC_WRITE, 0, NULL, OPEN_EXISTING, 0, NULL);
    if (m_hInfo == INVALID_HANDLE_VALUE &&
        (GetLastError() == ERROR_PATH_NOT_FOUND || GetLastError() == ERROR_FILE_NOT_FOUND))
    {
        m_Folder = m_Folder.Left(len);
        hr = RecycleBin5_Create(m_Folder, TokenUserInfo ? TokenUserInfo->User.Sid : NULL);
        m_Folder += L"\\" RECYCLE_BIN_FILE_NAME;
        if (!SUCCEEDED(hr))
            goto cleanup;
        m_hInfo = CreateFileW(m_Folder, GENERIC_READ | GENERIC_WRITE, 0, NULL, OPEN_EXISTING, 0, NULL);
    }
 
    if (m_hInfo == INVALID_HANDLE_VALUE)
    {
        hr = HRESULT_FROM_WIN32(GetLastError());
        goto cleanup;
    }
 
    m_hInfoMapped = CreateFileMappingW(m_hInfo, NULL, PAGE_READWRITE | SEC_COMMIT, 0, 0, NULL);
    if (!m_hInfoMapped)
    {
        hr = HRESULT_FROM_WIN32(GetLastError());
        goto cleanup;
    }
 
    m_Folder = m_Folder.Left(len);
    hr = S_OK;
 
cleanup:
    if (tokenHandle != INVALID_HANDLE_VALUE)
        CloseHandle(tokenHandle);
    HeapFree(GetProcessHeap(), 0, TokenUserInfo);
    if (StringSid)
        LocalFree(StringSid);
    return hr;
}

Referenced by RecycleBin5_Constructor().

OnClosing()

STDMETHODIMP RecycleBin5::OnClosing ( _In_ IRecycleBinEnumList *  prbel )

override

Definition at line 545 of file recyclebin_v5.cpp.

{
    TRACE("(%p, %p)\n", this, prbel);
    m_EnumeratorCount--;
    return S_OK;
}

QueryInterface()

STDMETHODIMP RecycleBin5::QueryInterface ( _In_ REFIID  riid, _Out_ void **  ppvObject  )

override

Definition at line 175 of file recyclebin_v5.cpp.

{
    TRACE("(%p, %s, %p)\n", this, debugstr_guid(&riid), ppvObject);
 
    if (!ppvObject)
        return E_POINTER;
 
    if (IsEqualIID(riid, IID_IUnknown) || IsEqualIID(riid, IID_IRecycleBin))
        *ppvObject = static_cast<IRecycleBin5 *>(this);
    else if (IsEqualIID(riid, IID_IRecycleBin5))
        *ppvObject = static_cast<IRecycleBin5 *>(this);
    else
    {
        *ppvObject = NULL;
        return E_NOINTERFACE;
    }
 
    AddRef();
    return S_OK;
}

RemoveFromDatabase()

STDMETHODIMP RecycleBin5::RemoveFromDatabase ( _In_ LPCWSTR  pDeletedFileName, _In_ DELETED_FILE_RECORD *  pDeletedFile  )

override

Definition at line 491 of file recyclebin_v5.cpp.

{
    ULARGE_INTEGER FileSize;
    PINFO2_HEADER pHeader;
    DELETED_FILE_RECORD *pRecord, *pLast;
    DWORD dwEntries, i;
 
    TRACE("(%p, %s, %p)\n", this, debugstr_w(pDeletedFileName), pDeletedFile);
 
    if (m_EnumeratorCount != 0)
        return HRESULT_FROM_WIN32(ERROR_SHARING_VIOLATION);
 
    pHeader = (PINFO2_HEADER)MapViewOfFile(m_hInfoMapped, FILE_MAP_WRITE, 0, 0, 0);
    if (!pHeader)
        return HRESULT_FROM_WIN32(GetLastError());
 
    FileSize.u.LowPart = GetFileSize(m_hInfo, &FileSize.u.HighPart);
    if (FileSize.u.LowPart == 0)
    {
        UnmapViewOfFile(pHeader);
        return HRESULT_FROM_WIN32(GetLastError());
    }
    dwEntries = (DWORD)((FileSize.QuadPart - sizeof(INFO2_HEADER)) / sizeof(DELETED_FILE_RECORD));
 
    pRecord = (DELETED_FILE_RECORD *)(pHeader + 1);
    for (i = 0; i < dwEntries; i++)
    {
        if (pRecord->dwRecordUniqueId == pDeletedFile->dwRecordUniqueId)
        {
            /* Clear last entry in the file */
            MoveMemory(pRecord, pRecord + 1, (dwEntries - i - 1) * sizeof(DELETED_FILE_RECORD));
            pLast = pRecord + (dwEntries - i - 1);
            ZeroMemory(pLast, sizeof(DELETED_FILE_RECORD));
            UnmapViewOfFile(pHeader);
 
            /* Resize file */
            CloseHandle(m_hInfoMapped);
            SetFilePointer(m_hInfo, -(LONG)sizeof(DELETED_FILE_RECORD), NULL, FILE_END);
            SetEndOfFile(m_hInfo);
            m_hInfoMapped = CreateFileMappingW(m_hInfo, NULL, PAGE_READWRITE | SEC_COMMIT, 0, 0, NULL);
            if (!m_hInfoMapped)
                return HResultFromWin32(GetLastError());
            dwEntries--;
            return FAILED((int)dwEntries) ? INT_MAX : dwEntries;
        }
        pRecord++;
    }
 
    UnmapViewOfFile(pHeader);
    return HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND);
}

Referenced by Delete(), and Restore().

Restore()

STDMETHODIMP RecycleBin5::Restore ( _In_ LPCWSTR  pDeletedFileName, _In_ DELETED_FILE_RECORD *  pDeletedFile  )

override

Definition at line 472 of file recyclebin_v5.cpp.

{
 
    TRACE("(%p, %s, %p)\n", this, debugstr_w(pDeletedFileName), pDeletedFile);
 
    int res = SHELL_SingleFileOperation(NULL, FO_MOVE, pDeletedFileName, pDeletedFile->FileNameW, 0);
    if (res)
    {
        ERR("SHFileOperationW failed with 0x%x\n", res);
        return E_FAIL;
    }
    res = RemoveFromDatabase(pDeletedFileName, pDeletedFile);
    if (res == 0)
        SHUpdateRecycleBinIcon(); // Full --> Empty
    return res;
}

STDMETHODIMP_() [1/2]

RecycleBin5::STDMETHODIMP_ ( ULONG  )

override

STDMETHODIMP_() [2/2]

RecycleBin5::STDMETHODIMP_ ( ULONG  )

override

Member Data Documentation

m_EnumeratorCount

DWORD RecycleBin5::m_EnumeratorCount

protected

Definition at line 170 of file recyclebin_v5.cpp.

Referenced by DeleteFile(), EnumObjects(), OnClosing(), and RemoveFromDatabase().

m_Folder

CStringW RecycleBin5::m_Folder

protected

Definition at line 172 of file recyclebin_v5.cpp.

Referenced by DeleteFile(), EnumObjects(), GetDirectory(), and Init().

m_hInfo

HANDLE RecycleBin5::m_hInfo

protected

Definition at line 168 of file recyclebin_v5.cpp.

Referenced by DeleteFile(), EnumObjects(), Init(), RemoveFromDatabase(), and ~RecycleBin5().

m_hInfoMapped

HANDLE RecycleBin5::m_hInfoMapped

protected

Definition at line 169 of file recyclebin_v5.cpp.

Referenced by DeleteFile(), EnumObjects(), Init(), RemoveFromDatabase(), and ~RecycleBin5().

m_ref

LONG RecycleBin5::m_ref

protected

Definition at line 167 of file recyclebin_v5.cpp.

Referenced by STDMETHODIMP_().

m_VolumePath

CStringW RecycleBin5::m_VolumePath

protected

Definition at line 171 of file recyclebin_v5.cpp.

Referenced by DeleteFile(), and Init().

---

The documentation for this class was generated from the following file:

• dll/win32/shell32/shellrecyclebin/recyclebin_v5.cpp