_Internal.cpp

Go to the documentation of this file.

// Project: uLib
// Module: A handful of small internal subroutines used by various implementation modules.
// Note: These function id's have two leading underscores to mark them as global internals.
// Parameter validation is generally absent. It is assumed callers constrain their arguments.
// Author: Love Nystrom

// ADDED May 2021 due to their need in various modules.
// TODO: During revisions !in the whole code base!, try to
// use these instead of local variants wherever applicable,
// to homogenize and lean out implementation.

#include <uLib/UtilFunc.h>
#include <uLib/StrFunc.h>
#include <uLib/_Internal.h>

bool __EnableProcPrivilege( IN CSTR Privilege, OUT LUID_AND_ATTRIBUTES* pPrv, OUT HANDLE* pToken )
//
// Enable a privilege for the current process and return the token handle and previous state.
//
{
    ACCESS_MASK Access = TOKEN_ADJUST_PRIVILEGES| TOKEN_QUERY;
    BOOL ok = OpenProcessToken( GetCurrentProcess(), Access, pToken );
    if ( ok ) ok = EnablePrivilege( *pToken, Privilege, true, pPrv );
    else *pToken = NULL;
    return bool_cast( ok );
}

bool __GetRoot( OUT TSTR Root, IN UINT ccRoot, IN CSTR PathName )
//
// Return the root component of a filepath.
//
{
    TCHAR szRoot[ MAX_PATH ];
    _tcscpy_s( szRoot, MAX_PATH, SkipPathPrefix( PathName ));
    // PathStripToRoot handles both DOS paths and UNC paths (\\server\share\path).
    // Alas, UNC paths w/o leading \\ and NT device paths are *not* handled.
    BOOL ok = PathStripToRoot( szRoot );
    if (ok) _tcsncpyz( Root, szRoot, ccRoot );
    return bool_cast( ok );
}

typedef TCHAR _ROOT_BUF[ 80 ]; // Should be sufficient for sane share names as well.

DWORD __GetVolumeFlags( CSTR PathName )
//
// Get the file system ability flags of PathName's containing volume.
//
{
    DWORD Flags; _ROOT_BUF szRoot = S_BLANK;
    BOOL ok = __GetRoot( szRoot, dimof(szRoot), PathName );
    if (ok) ok = GetVolumeInformation( szRoot, NULL,0, NULL, NULL, &Flags, NULL, 0 );
    if (!ok) Flags = 0;
    return Flags;
}

DWORD __GetVolumeId( CSTR PathName )
//
// Get the S/N of PathName's containing volume.
//
{
    DWORD VolSN; _ROOT_BUF szRoot = S_BLANK;
    BOOL ok = __GetRoot( szRoot, dimof(szRoot), PathName );
    if (ok) ok = GetVolumeInformation( szRoot, NULL,0, &VolSN, NULL, NULL, NULL, 0 );
    if (!ok) VolSN = 0;
    return VolSN;
}

DWORD __GetHandleVolumeId( HANDLE hObj )
//
// Get the S/N of the volume of an open FS object.
//
{
    BY_HANDLE_FILE_INFORMATION info; // Since Win2k
    return GetFileInformationByHandle( hObj, &info ) ? info.dwVolumeSerialNumber : 0;
}

CSTR __ChangeToDirOf( CSTR PathName )
//
// F.ex. when creating relative links, it's best to work in the link dir.
//
{
    TCHAR Dir[ MAX_PATH ];
    _tcscpy_s( Dir, MAX_PATH, PathName );
    PathRemoveFileSpec( Dir );
    return ChangeDirectory( Dir );
}

// EOF