aspnetcore/src/CommonLib/utility.cxx

602 lines
13 KiB
C++

// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.
#include"stdafx.h"
// static
HRESULT
UTILITY::SplitUrl(
PCWSTR pszDestinationUrl,
BOOL *pfSecure,
STRU *pstrDestination,
STRU *pstrUrl
)
/*++
Routine Description:
Split the URL specified for forwarding into its specific components
The format of the URL looks like
http[s]://destination[:port]/path
when port is omitted, the default port for that specific protocol is used
when host is omitted, it gets the same value as the destination
Arguments:
pszDestinationUrl - the url to be split up
pfSecure - SSL to be used in forwarding?
pstrDestination - destination
pDestinationPort - port
pstrUrl - URL
Return Value:
HRESULT
--*/
{
HRESULT hr;
//
// First determine if the target is secure
//
if (_wcsnicmp(pszDestinationUrl, L"http://", 7) == 0)
{
*pfSecure = FALSE;
pszDestinationUrl += 7;
}
else if (_wcsnicmp(pszDestinationUrl, L"https://", 8) == 0)
{
*pfSecure = TRUE;
pszDestinationUrl += 8;
}
else
{
return HRESULT_FROM_WIN32(ERROR_INVALID_DATA);
}
if (*pszDestinationUrl == L'\0')
{
return HRESULT_FROM_WIN32(ERROR_INVALID_DATA);
}
//
// Find the 3rd slash corresponding to the url
//
LPCWSTR pszSlash = wcschr(pszDestinationUrl, L'/');
if (pszSlash == NULL)
{
if (FAILED(hr = pstrUrl->Copy(L"/", 1)) ||
FAILED(hr = pstrDestination->Copy(pszDestinationUrl)))
{
return hr;
}
}
else
{
if (FAILED(hr = pstrUrl->Copy(pszSlash)) ||
FAILED(hr = pstrDestination->Copy(pszDestinationUrl,
(DWORD)(pszSlash - pszDestinationUrl))))
{
return hr;
}
}
return S_OK;
}
// Change a hexadecimal digit to its numerical equivalent
#define TOHEX( ch ) \
((ch) > L'9' ? \
(ch) >= L'a' ? \
(ch) - L'a' + 10 : \
(ch) - L'A' + 10 \
: (ch) - L'0')
// static
HRESULT
UTILITY::UnEscapeUrl(
PCWSTR pszUrl,
DWORD cchUrl,
bool fCopyQuery,
STRA * pstrResult
)
{
HRESULT hr;
CHAR pch[2];
pch[1] = '\0';
DWORD cchStart = 0;
DWORD index = 0;
while (index < cchUrl &&
(fCopyQuery || pszUrl[index] != L'?'))
{
switch (pszUrl[index])
{
case L'%':
if (iswxdigit(pszUrl[index+1]) && iswxdigit(pszUrl[index+2]))
{
if (index > cchStart &&
FAILED(hr = pstrResult->AppendW(pszUrl + cchStart,
index - cchStart)))
{
return hr;
}
cchStart = index+3;
pch[0] = static_cast<CHAR>(TOHEX(pszUrl[index+1]) * 16 +
TOHEX(pszUrl[index+2]));
if (FAILED(hr = pstrResult->Append(pch, 1)))
{
return hr;
}
index += 3;
break;
}
__fallthrough;
default:
index++;
}
}
if (index > cchStart)
{
return pstrResult->AppendW(pszUrl + cchStart,
index - cchStart);
}
return S_OK;
}
// static
HRESULT
UTILITY::UnEscapeUrl(
PCWSTR pszUrl,
DWORD cchUrl,
STRU * pstrResult
)
{
HRESULT hr;
WCHAR pch[2];
pch[1] = L'\0';
DWORD cchStart = 0;
DWORD index = 0;
bool fInQuery = FALSE;
while (index < cchUrl)
{
switch (pszUrl[index])
{
case L'%':
if (iswxdigit(pszUrl[index+1]) && iswxdigit(pszUrl[index+2]))
{
if (index > cchStart &&
FAILED(hr = pstrResult->Append(pszUrl + cchStart,
index - cchStart)))
{
return hr;
}
cchStart = index+3;
pch[0] = static_cast<WCHAR>(TOHEX(pszUrl[index+1]) * 16 +
TOHEX(pszUrl[index+2]));
if (FAILED(hr = pstrResult->Append(pch, 1)))
{
return hr;
}
index += 3;
if (pch[0] == L'?')
{
fInQuery = TRUE;
}
break;
}
index++;
break;
case L'/':
if (fInQuery)
{
if (index > cchStart &&
FAILED(hr = pstrResult->Append(pszUrl + cchStart,
index - cchStart)))
{
return hr;
}
cchStart = index+1;
if (FAILED(hr = pstrResult->Append(L"\\", 1)))
{
return hr;
}
index += 1;
break;
}
__fallthrough;
default:
index++;
}
}
if (index > cchStart)
{
return pstrResult->Append(pszUrl + cchStart,
index - cchStart);
}
return S_OK;
}
HRESULT
UTILITY::EscapeAbsPath(
IHttpRequest * pRequest,
STRU * strEscapedUrl
)
{
HRESULT hr = S_OK;
STRU strAbsPath;
LPCWSTR pszAbsPath = NULL;
LPCWSTR pszFindStr = NULL;
hr = strAbsPath.Copy( pRequest->GetRawHttpRequest()->CookedUrl.pAbsPath,
pRequest->GetRawHttpRequest()->CookedUrl.AbsPathLength / sizeof(WCHAR) );
if(FAILED(hr))
{
goto Finished;
}
pszAbsPath = strAbsPath.QueryStr();
pszFindStr = wcschr(pszAbsPath, L'?');
while(pszFindStr != NULL)
{
strEscapedUrl->Append( pszAbsPath, pszFindStr - pszAbsPath);
strEscapedUrl->Append(L"%3F");
pszAbsPath = pszFindStr + 1;
pszFindStr = wcschr(pszAbsPath, L'?');
}
strEscapedUrl->Append(pszAbsPath);
strEscapedUrl->Append(pRequest->GetRawHttpRequest()->CookedUrl.pQueryString,
pRequest->GetRawHttpRequest()->CookedUrl.QueryStringLength / sizeof(WCHAR));
Finished:
return hr;
}
// static
bool
UTILITY::IsValidAttributeNameChar(
WCHAR ch
)
{
//
// Values based on ASP.NET rendering for cookie names. RFC 2965 is not clear
// what the non-special characters are.
//
return ch == L'\t' || (ch > 31 && ch < 127);
}
// static
bool
UTILITY::FindInMultiString(
PCWSTR pszMultiString,
PCWSTR pszStringToFind
)
{
while (*pszMultiString != L'\0')
{
if (wcscmp(pszMultiString, pszStringToFind) == 0)
{
return TRUE;
}
pszMultiString += wcslen(pszMultiString) + 1;
}
return FALSE;
}
// static
bool
UTILITY::IsValidQueryStringName(
PCWSTR pszName
)
{
while (*pszName != L'\0')
{
WCHAR c = *pszName;
if (c != L'-' && c != L'_' && c != L'+' &&
c != L'.' && c != L'*' && c != L'$' && c != L'%' && c != L',' &&
!iswalnum(c))
{
return FALSE;
}
pszName++;
}
return TRUE;
}
// static
bool
UTILITY::IsValidHeaderName(
PCWSTR pszName
)
{
while (*pszName != L'\0')
{
WCHAR c = *pszName;
if (c != L'-' && c != L'_' && c != L'+' &&
c != L'.' && c != L'*' && c != L'$' && c != L'%'
&& !iswalnum(c))
{
return FALSE;
}
pszName++;
}
return TRUE;
}
HRESULT
UTILITY::IsPathUnc(
__in LPCWSTR pszPath,
__out BOOL * pfIsUnc
)
{
HRESULT hr = S_OK;
STRU strTempPath;
if ( pszPath == NULL || pfIsUnc == NULL )
{
hr = E_INVALIDARG;
goto Finished;
}
hr = MakePathCanonicalizationProof( (LPWSTR) pszPath, &strTempPath );
if ( FAILED(hr) )
{
goto Finished;
}
//
// MakePathCanonicalizationProof will map \\?\UNC, \\.\UNC and \\ to \\?\UNC
//
(*pfIsUnc) = ( _wcsnicmp( strTempPath.QueryStr(), L"\\\\?\\UNC\\", 8 /* sizeof \\?\UNC\ */) == 0 );
Finished:
return hr;
}
HRESULT
UTILITY::ConvertPathToFullPath(
_In_ LPCWSTR pszPath,
_In_ LPCWSTR pszRootPath,
_Out_ STRU* pStruFullPath
)
{
HRESULT hr = S_OK;
STRU strFileFullPath;
LPWSTR pszFullPath = NULL;
// if relative path, prefix with root path and then convert to absolute path.
if ( pszPath[0] == L'.' )
{
hr = strFileFullPath.Copy(pszRootPath);
if(FAILED(hr))
{
goto Finished;
}
if(!strFileFullPath.EndsWith(L"\\"))
{
hr = strFileFullPath.Append(L"\\");
if(FAILED(hr))
{
goto Finished;
}
}
}
hr = strFileFullPath.Append( pszPath );
if (FAILED(hr))
{
goto Finished;
}
pszFullPath = new WCHAR[ strFileFullPath.QueryCCH() + 1];
if ( pszFullPath == NULL )
{
hr = E_OUTOFMEMORY;
goto Finished;
}
if(_wfullpath( pszFullPath,
strFileFullPath.QueryStr(),
strFileFullPath.QueryCCH() + 1 ) == NULL )
{
hr = HRESULT_FROM_WIN32( ERROR_INVALID_PARAMETER );
goto Finished;
}
// convert to canonical path
hr = MakePathCanonicalizationProof( pszFullPath, pStruFullPath );
if (FAILED(hr))
{
goto Finished;
}
Finished:
if ( pszFullPath != NULL )
{
delete[] pszFullPath;
pszFullPath = NULL;
}
return hr;
}
HRESULT
UTILITY::EnsureDirectoryPathExist(
_In_ LPCWSTR pszPath
)
{
HRESULT hr = S_OK;
STRU struPath;
DWORD dwPosition = 0;
BOOL fDone = FALSE;
BOOL fUnc = FALSE;
struPath.Copy(pszPath);
hr = IsPathUnc(pszPath, &fUnc);
if (FAILED(hr))
{
goto Finished;
}
if (fUnc)
{
// "\\?\UNC\"
dwPosition = 8;
}
else if (struPath.IndexOf(L'?', 0) != -1)
{
// sceanrio "\\?\"
dwPosition = 4;
}
while (!fDone)
{
dwPosition = struPath.IndexOf(L'\\', dwPosition + 1);
if (dwPosition == -1)
{
// not found '/'
fDone = TRUE;
goto Finished;
}
else if (dwPosition ==0)
{
hr = ERROR_INTERNAL_ERROR;
goto Finished;
}
else if (struPath.QueryStr()[dwPosition-1] == L':')
{
// skip volume case
continue;
}
else
{
struPath.QueryStr()[dwPosition] = L'\0';
}
if (!CreateDirectory(struPath.QueryStr(), NULL) &&
ERROR_ALREADY_EXISTS != GetLastError())
{
hr = HRESULT_FROM_WIN32(GetLastError());
fDone = TRUE;
goto Finished;
}
struPath.QueryStr()[dwPosition] = L'\\';
}
Finished:
return hr;
}
HRESULT
UTILITY::FindHighestDotNetVersion(
_In_ std::vector<std::wstring> vFolders,
_Out_ STRU *pstrResult
)
{
HRESULT hr = S_OK;
fx_ver_t max_ver(-1, -1, -1);
for (const auto& dir : vFolders)
{
fx_ver_t fx_ver(-1, -1, -1);
if (fx_ver_t::parse(dir, &fx_ver, false))
{
// TODO using max instead of std::max works
max_ver = max(max_ver, fx_ver);
}
}
hr = pstrResult->Copy(max_ver.as_str().c_str());
// we check FAILED(hr) outside of function
return hr;
}
BOOL
UTILITY::DirectoryExists(
_In_ STRU *pstrPath
)
{
WIN32_FILE_ATTRIBUTE_DATA data;
if (pstrPath->IsEmpty())
{
return false;
}
return GetFileAttributesExW(pstrPath->QueryStr(), GetFileExInfoStandard, &data);
}
VOID
UTILITY::FindDotNetFolders(
_In_ PCWSTR pszPath,
_Out_ std::vector<std::wstring> *pvFolders
)
{
HANDLE handle = NULL;
WIN32_FIND_DATAW data = { 0 };
handle = FindFirstFileExW(pszPath, FindExInfoStandard, &data, FindExSearchNameMatch, NULL, 0);
if (handle == INVALID_HANDLE_VALUE)
{
return;
}
do
{
std::wstring folder(data.cFileName);
pvFolders->push_back(folder);
} while (FindNextFileW(handle, &data));
FindClose(handle);
}
BOOL
UTILITY::CheckIfFileExists(
_In_ PCWSTR pszFilePath
)
{
HANDLE hFileHandle = INVALID_HANDLE_VALUE;
SECURITY_ATTRIBUTES saAttr;
BOOL fFileExists = FALSE;
saAttr.nLength = sizeof(SECURITY_ATTRIBUTES);
saAttr.bInheritHandle = TRUE;
saAttr.lpSecurityDescriptor = NULL;
hFileHandle = CreateFile(pszFilePath,
GENERIC_READ,
FILE_SHARE_READ,
&saAttr,
OPEN_EXISTING,
FILE_ATTRIBUTE_NORMAL,
NULL);
fFileExists = hFileHandle != INVALID_HANDLE_VALUE || GetLastError() == ERROR_SHARING_VIOLATION;
if (fFileExists)
{
CloseHandle(hFileHandle);
}
return fFileExists;
}