1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197
|
/* * Copyright (C) 2016-2019 Mohammed Boujemaoui <mohabouje@gmail.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* the Software, and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#include "wintoastlib.h"
#include <memory>
#include <assert.h>
#include <unordered_map>
#include <array>
#pragma comment(lib,"shlwapi")
#pragma comment(lib,"user32")
#ifdef NDEBUG
#define DEBUG_MSG(str) do { } while ( false )
#else
#define DEBUG_MSG(str) do { std::wcout << str << std::endl; } while( false )
#endif
#define DEFAULT_SHELL_LINKS_PATH L"\\Microsoft\\Windows\\Start Menu\\Programs\\"
#define DEFAULT_LINK_FORMAT L".lnk"
#define STATUS_SUCCESS (0x00000000)
// Quickstart: Handling toast activations from Win32 apps in Windows 10
// https://blogs.msdn.microsoft.com/tiles_and_toasts/2015/10/16/quickstart-handling-toast-activations-from-win32-apps-in-windows-10/
using namespace WinToastLib;
namespace DllImporter {
// Function load a function from library
template <typename Function>
HRESULT loadFunctionFromLibrary(HINSTANCE library, LPCSTR name, Function &func) {
if (!library) {
return E_INVALIDARG;
}
func = reinterpret_cast<Function>(GetProcAddress(library, name));
return (func != nullptr) ? S_OK : E_FAIL;
}
typedef HRESULT(FAR STDAPICALLTYPE *f_SetCurrentProcessExplicitAppUserModelID)(__in PCWSTR AppID);
typedef HRESULT(FAR STDAPICALLTYPE *f_PropVariantToString)(_In_ REFPROPVARIANT propvar, _Out_writes_(cch) PWSTR psz, _In_ UINT cch);
typedef HRESULT(FAR STDAPICALLTYPE *f_RoGetActivationFactory)(_In_ HSTRING activatableClassId, _In_ REFIID iid, _COM_Outptr_ void ** factory);
typedef HRESULT(FAR STDAPICALLTYPE *f_WindowsCreateStringReference)(_In_reads_opt_(length + 1) PCWSTR sourceString, UINT32 length, _Out_ HSTRING_HEADER * hstringHeader, _Outptr_result_maybenull_ _Result_nullonfailure_ HSTRING * string);
typedef PCWSTR(FAR STDAPICALLTYPE *f_WindowsGetStringRawBuffer)(_In_ HSTRING string, _Out_ UINT32 *length);
typedef HRESULT(FAR STDAPICALLTYPE *f_WindowsDeleteString)(_In_opt_ HSTRING string);
static f_SetCurrentProcessExplicitAppUserModelID SetCurrentProcessExplicitAppUserModelID;
static f_PropVariantToString PropVariantToString;
static f_RoGetActivationFactory RoGetActivationFactory;
static f_WindowsCreateStringReference WindowsCreateStringReference;
static f_WindowsGetStringRawBuffer WindowsGetStringRawBuffer;
static f_WindowsDeleteString WindowsDeleteString;
template<class T>
_Check_return_ __inline HRESULT _1_GetActivationFactory(_In_ HSTRING activatableClassId, _COM_Outptr_ T** factory) {
return RoGetActivationFactory(activatableClassId, IID_INS_ARGS(factory));
}
template<typename T>
inline HRESULT Wrap_GetActivationFactory(_In_ HSTRING activatableClassId, _Inout_ Details::ComPtrRef<T> factory) noexcept {
return _1_GetActivationFactory(activatableClassId, factory.ReleaseAndGetAddressOf());
}
inline HRESULT initialize() {
HINSTANCE LibShell32 = LoadLibraryW(L"SHELL32.DLL");
HRESULT hr = loadFunctionFromLibrary(LibShell32, "SetCurrentProcessExplicitAppUserModelID", SetCurrentProcessExplicitAppUserModelID);
if (SUCCEEDED(hr)) {
HINSTANCE LibPropSys = LoadLibraryW(L"PROPSYS.DLL");
hr = loadFunctionFromLibrary(LibPropSys, "PropVariantToString", PropVariantToString);
if (SUCCEEDED(hr)) {
HINSTANCE LibComBase = LoadLibraryW(L"COMBASE.DLL");
const bool succeded = SUCCEEDED(loadFunctionFromLibrary(LibComBase, "RoGetActivationFactory", RoGetActivationFactory))
&& SUCCEEDED(loadFunctionFromLibrary(LibComBase, "WindowsCreateStringReference", WindowsCreateStringReference))
&& SUCCEEDED(loadFunctionFromLibrary(LibComBase, "WindowsGetStringRawBuffer", WindowsGetStringRawBuffer))
&& SUCCEEDED(loadFunctionFromLibrary(LibComBase, "WindowsDeleteString", WindowsDeleteString));
return succeded ? S_OK : E_FAIL;
}
}
return hr;
}
}
class WinToastStringWrapper {
public:
WinToastStringWrapper(_In_reads_(length) PCWSTR stringRef, _In_ UINT32 length) noexcept {
HRESULT hr = DllImporter::WindowsCreateStringReference(stringRef, length, &_header, &_hstring);
if (!SUCCEEDED(hr)) {
RaiseException(static_cast<DWORD>(STATUS_INVALID_PARAMETER), EXCEPTION_NONCONTINUABLE, 0, nullptr);
}
}
WinToastStringWrapper(_In_ const std::wstring &stringRef) noexcept {
HRESULT hr = DllImporter::WindowsCreateStringReference(stringRef.c_str(), static_cast<UINT32>(stringRef.length()), &_header, &_hstring);
if (FAILED(hr)) {
RaiseException(static_cast<DWORD>(STATUS_INVALID_PARAMETER), EXCEPTION_NONCONTINUABLE, 0, nullptr);
}
}
~WinToastStringWrapper() {
DllImporter::WindowsDeleteString(_hstring);
}
inline HSTRING Get() const noexcept {
return _hstring;
}
private:
HSTRING _hstring;
HSTRING_HEADER _header;
};
class InternalDateTime : public IReference<DateTime> {
public:
static INT64 Now() {
FILETIME now;
GetSystemTimeAsFileTime(&now);
return ((((INT64)now.dwHighDateTime) << 32) | now.dwLowDateTime);
}
InternalDateTime(DateTime dateTime) : _dateTime(dateTime) {}
InternalDateTime(INT64 millisecondsFromNow) {
_dateTime.UniversalTime = Now() + millisecondsFromNow * 10000;
}
virtual ~InternalDateTime() = default;
operator INT64() {
return _dateTime.UniversalTime;
}
HRESULT STDMETHODCALLTYPE get_Value(DateTime *dateTime) {
*dateTime = _dateTime;
return S_OK;
}
HRESULT STDMETHODCALLTYPE QueryInterface(const IID& riid, void** ppvObject) {
if (!ppvObject) {
return E_POINTER;
}
if (riid == __uuidof(IUnknown) || riid == __uuidof(IReference<DateTime>)) {
*ppvObject = static_cast<IUnknown*>(static_cast<IReference<DateTime>*>(this));
return S_OK;
}
return E_NOINTERFACE;
}
ULONG STDMETHODCALLTYPE Release() {
return 1;
}
ULONG STDMETHODCALLTYPE AddRef() {
return 2;
}
HRESULT STDMETHODCALLTYPE GetIids(ULONG*, IID**) {
return E_NOTIMPL;
}
HRESULT STDMETHODCALLTYPE GetRuntimeClassName(HSTRING*) {
return E_NOTIMPL;
}
HRESULT STDMETHODCALLTYPE GetTrustLevel(TrustLevel*) {
return E_NOTIMPL;
}
protected:
DateTime _dateTime;
};
namespace Util {
typedef LONG NTSTATUS, *PNTSTATUS;
typedef NTSTATUS(WINAPI* RtlGetVersionPtr)(PRTL_OSVERSIONINFOW);
inline RTL_OSVERSIONINFOW getRealOSVersion() {
HMODULE hMod = ::GetModuleHandleW(L"ntdll.dll");
if (hMod) {
RtlGetVersionPtr fxPtr = (RtlGetVersionPtr)::GetProcAddress(hMod, "RtlGetVersion");
if (fxPtr != nullptr) {
RTL_OSVERSIONINFOW rovi = { 0 };
rovi.dwOSVersionInfoSize = sizeof(rovi);
if (STATUS_SUCCESS == fxPtr(&rovi)) {
return rovi;
}
}
}
RTL_OSVERSIONINFOW rovi = { 0 };
return rovi;
}
inline HRESULT defaultExecutablePath(_In_ WCHAR* path, _In_ DWORD nSize = MAX_PATH) {
DWORD written = GetModuleFileNameExW(GetCurrentProcess(), nullptr, path, nSize);
DEBUG_MSG("Default executable path: " << path);
return (written > 0) ? S_OK : E_FAIL;
}
inline HRESULT commonShellLinksDirectory(_In_ const WCHAR* baseEnv, _In_ WCHAR* path, _In_ DWORD nSize) {
DWORD written = GetEnvironmentVariableW(baseEnv, path, nSize);
HRESULT hr = written > 0 ? S_OK : E_INVALIDARG;
if (SUCCEEDED(hr)) {
errno_t result = wcscat_s(path, nSize, DEFAULT_SHELL_LINKS_PATH);
hr = (result == 0) ? S_OK : E_INVALIDARG;
DEBUG_MSG("Default shell link path: " << path);
}
return hr;
}
inline HRESULT commonShellLinkPath(_In_ const WCHAR* baseEnv, const std::wstring& appname, _In_ WCHAR* path, _In_ DWORD nSize) {
HRESULT hr = commonShellLinksDirectory(baseEnv, path, nSize);
if (SUCCEEDED(hr)) {
const std::wstring appLink(appname + DEFAULT_LINK_FORMAT);
errno_t result = wcscat_s(path, nSize, appLink.c_str());
hr = (result == 0) ? S_OK : E_INVALIDARG;
DEBUG_MSG("Default shell link file path: " << path);
}
return hr;
}
inline HRESULT defaultUserShellLinkPath(const std::wstring& appname, _In_ WCHAR* path, _In_ DWORD nSize = MAX_PATH) {
return commonShellLinkPath(L"APPDATA", appname, path, nSize);
}
inline HRESULT defaultSystemShellLinkPath(const std::wstring& appname, _In_ WCHAR* path, _In_ DWORD nSize = MAX_PATH) {
return commonShellLinkPath(L"PROGRAMDATA", appname, path, nSize);
}
inline PCWSTR AsString(ComPtr<IXmlDocument> &xmlDocument) {
HSTRING xml;
ComPtr<IXmlNodeSerializer> ser;
HRESULT hr = xmlDocument.As<IXmlNodeSerializer>(&ser);
hr = ser->GetXml(&xml);
if (SUCCEEDED(hr))
return DllImporter::WindowsGetStringRawBuffer(xml, nullptr);
return nullptr;
}
inline PCWSTR AsString(HSTRING hstring) {
return DllImporter::WindowsGetStringRawBuffer(hstring, nullptr);
}
inline HRESULT setNodeStringValue(const std::wstring& string, IXmlNode *node, IXmlDocument *xml) {
ComPtr<IXmlText> textNode;
HRESULT hr = xml->CreateTextNode( WinToastStringWrapper(string).Get(), &textNode);
if (SUCCEEDED(hr)) {
ComPtr<IXmlNode> stringNode;
hr = textNode.As(&stringNode);
if (SUCCEEDED(hr)) {
ComPtr<IXmlNode> appendedChild;
hr = node->AppendChild(stringNode.Get(), &appendedChild);
}
}
return hr;
}
inline HRESULT setEventHandlers(_In_ IToastNotification* notification, _In_ std::shared_ptr<IWinToastHandler> eventHandler, _In_ INT64 expirationTime) {
EventRegistrationToken activatedToken, dismissedToken, failedToken;
HRESULT hr = notification->add_Activated(
Callback < Implements < RuntimeClassFlags<ClassicCom>,
ITypedEventHandler<ToastNotification*, IInspectable* >> >(
[eventHandler](IToastNotification*, IInspectable* inspectable)
{
IToastActivatedEventArgs *activatedEventArgs;
HRESULT hr = inspectable->QueryInterface(&activatedEventArgs);
if (SUCCEEDED(hr)) {
HSTRING argumentsHandle;
hr = activatedEventArgs->get_Arguments(&argumentsHandle);
if (SUCCEEDED(hr)) {
PCWSTR arguments = Util::AsString(argumentsHandle);
if (arguments && *arguments) {
eventHandler->toastActivated(static_cast<int>(wcstol(arguments, nullptr, 10)));
return S_OK;
}
}
}
eventHandler->toastActivated();
return S_OK;
}).Get(), &activatedToken);
if (SUCCEEDED(hr)) {
hr = notification->add_Dismissed(Callback < Implements < RuntimeClassFlags<ClassicCom>,
ITypedEventHandler<ToastNotification*, ToastDismissedEventArgs* >> >(
[eventHandler, expirationTime](IToastNotification*, IToastDismissedEventArgs* e)
{
ToastDismissalReason reason;
if (SUCCEEDED(e->get_Reason(&reason)))
{
if (reason == ToastDismissalReason_UserCanceled && expirationTime && InternalDateTime::Now() >= expirationTime)
reason = ToastDismissalReason_TimedOut;
eventHandler->toastDismissed(static_cast<IWinToastHandler::WinToastDismissalReason>(reason));
}
return S_OK;
}).Get(), &dismissedToken);
if (SUCCEEDED(hr)) {
hr = notification->add_Failed(Callback < Implements < RuntimeClassFlags<ClassicCom>,
ITypedEventHandler<ToastNotification*, ToastFailedEventArgs* >> >(
[eventHandler](IToastNotification*, IToastFailedEventArgs*)
{
eventHandler->toastFailed();
return S_OK;
}).Get(), &failedToken);
}
}
return hr;
}
inline HRESULT addAttribute(_In_ IXmlDocument *xml, const std::wstring &name, IXmlNamedNodeMap *attributeMap) {
ComPtr<ABI::Windows::Data::Xml::Dom::IXmlAttribute> srcAttribute;
HRESULT hr = xml->CreateAttribute(WinToastStringWrapper(name).Get(), &srcAttribute);
if (SUCCEEDED(hr)) {
ComPtr<IXmlNode> node;
hr = srcAttribute.As(&node);
if (SUCCEEDED(hr)) {
ComPtr<IXmlNode> pNode;
hr = attributeMap->SetNamedItem(node.Get(), &pNode);
}
}
return hr;
}
inline HRESULT createElement(_In_ IXmlDocument *xml, _In_ const std::wstring& root_node, _In_ const std::wstring& element_name, _In_ const std::vector<std::wstring>& attribute_names) {
ComPtr<IXmlNodeList> rootList;
HRESULT hr = xml->GetElementsByTagName(WinToastStringWrapper(root_node).Get(), &rootList);
if (SUCCEEDED(hr)) {
ComPtr<IXmlNode> root;
hr = rootList->Item(0, &root);
if (SUCCEEDED(hr)) {
ComPtr<ABI::Windows::Data::Xml::Dom::IXmlElement> audioElement;
hr = xml->CreateElement(WinToastStringWrapper(element_name).Get(), &audioElement);
if (SUCCEEDED(hr)) {
ComPtr<IXmlNode> audioNodeTmp;
hr = audioElement.As(&audioNodeTmp);
if (SUCCEEDED(hr)) {
ComPtr<IXmlNode> audioNode;
hr = root->AppendChild(audioNodeTmp.Get(), &audioNode);
if (SUCCEEDED(hr)) {
ComPtr<IXmlNamedNodeMap> attributes;
hr = audioNode->get_Attributes(&attributes);
if (SUCCEEDED(hr)) {
for (const auto& it : attribute_names) {
hr = addAttribute(xml, it, attributes.Get());
}
}
}
}
}
}
}
return hr;
}
}
WinToast* WinToast::instance() {
static WinToast instance;
return &instance;
}
WinToast::WinToast() :
_isInitialized(false),
_hasCoInitialized(false)
{
if (!isCompatible()) {
DEBUG_MSG(L"Warning: Your system is not compatible with this library ");
}
}
WinToast::~WinToast() {
if (_hasCoInitialized) {
CoUninitialize();
}
}
void WinToast::setAppName(_In_ const std::wstring& appName) {
_appName = appName;
}
void WinToast::setAppUserModelId(_In_ const std::wstring& aumi) {
_aumi = aumi;
DEBUG_MSG(L"Default App User Model Id: " << _aumi.c_str());
}
void WinToast::setShortcutPolicy(_In_ ShortcutPolicy shortcutPolicy) {
_shortcutPolicy = shortcutPolicy;
}
bool WinToast::isCompatible() {
DllImporter::initialize();
return !((DllImporter::SetCurrentProcessExplicitAppUserModelID == nullptr)
|| (DllImporter::PropVariantToString == nullptr)
|| (DllImporter::RoGetActivationFactory == nullptr)
|| (DllImporter::WindowsCreateStringReference == nullptr)
|| (DllImporter::WindowsDeleteString == nullptr));
}
bool WinToastLib::WinToast::isSupportingModernFeatures() {
constexpr auto MinimumSupportedVersion = 6;
return Util::getRealOSVersion().dwMajorVersion > MinimumSupportedVersion;
}
std::wstring WinToast::configureAUMI(_In_ const std::wstring &companyName,
_In_ const std::wstring &productName,
_In_ const std::wstring &subProduct,
_In_ const std::wstring &versionInformation)
{
std::wstring aumi = companyName;
aumi += L"." + productName;
if (subProduct.length() > 0) {
aumi += L"." + subProduct;
if (versionInformation.length() > 0) {
aumi += L"." + versionInformation;
}
}
if (aumi.length() > SCHAR_MAX) {
DEBUG_MSG("Error: max size allowed for AUMI: 128 characters.");
}
return aumi;
}
const std::wstring& WinToast::strerror(WinToastError error) {
static const std::unordered_map<WinToastError, std::wstring> Labels = {
{WinToastError::NoError, L"No error. The process was executed correctly"},
{WinToastError::NotInitialized, L"The library has not been initialized"},
{WinToastError::SystemNotSupported, L"The OS does not support WinToast"},
{WinToastError::ShellLinkNotCreated, L"The library was not able to create a Shell Link for the app"},
{WinToastError::InvalidAppUserModelID, L"The AUMI is not a valid one"},
{WinToastError::InvalidParameters, L"The parameters used to configure the library are not valid normally because an invalid AUMI or App Name"},
{WinToastError::NotDisplayed, L"The toast was created correctly but WinToast was not able to display the toast"},
{WinToastError::UnknownError, L"Unknown error"}
};
const auto iter = Labels.find(error);
assert(iter != Labels.end());
return iter->second;
}
enum WinToast::ShortcutResult WinToast::createShortcut() {
if (_aumi.empty() || _appName.empty()) {
DEBUG_MSG(L"Error: App User Model Id or Appname is empty!");
return SHORTCUT_MISSING_PARAMETERS;
}
if (!isCompatible()) {
DEBUG_MSG(L"Your OS is not compatible with this library! =(");
return SHORTCUT_INCOMPATIBLE_OS;
}
if (!_hasCoInitialized) {
HRESULT initHr = CoInitializeEx(nullptr, COINIT::COINIT_MULTITHREADED);
if (initHr != RPC_E_CHANGED_MODE) {
if (FAILED(initHr) && initHr != S_FALSE) {
DEBUG_MSG(L"Error on COM library initialization!");
return SHORTCUT_COM_INIT_FAILURE;
}
else {
_hasCoInitialized = true;
}
}
}
bool wasChanged;
HRESULT hr = validateShellLinkHelper(wasChanged);
if (SUCCEEDED(hr))
return wasChanged ? SHORTCUT_WAS_CHANGED : SHORTCUT_UNCHANGED;
hr = createShellLinkHelper();
return SUCCEEDED(hr) ? SHORTCUT_WAS_CREATED : SHORTCUT_CREATE_FAILED;
}
bool WinToast::initialize(_Out_ WinToastError* error) {
_isInitialized = false;
setError(error, WinToastError::NoError);
if (!isCompatible()) {
setError(error, WinToastError::SystemNotSupported);
DEBUG_MSG(L"Error: system not supported.");
return false;
}
if (_aumi.empty() || _appName.empty()) {
setError(error, WinToastError::InvalidParameters);
DEBUG_MSG(L"Error while initializing, did you set up a valid AUMI and App name?");
return false;
}
if (_shortcutPolicy != SHORTCUT_POLICY_IGNORE) {
if (createShortcut() < 0) {
setError(error, WinToastError::ShellLinkNotCreated);
DEBUG_MSG(L"Error while attaching the AUMI to the current proccess =(");
return false;
}
}
if (FAILED(DllImporter::SetCurrentProcessExplicitAppUserModelID(_aumi.c_str()))) {
setError(error, WinToastError::InvalidAppUserModelID);
DEBUG_MSG(L"Error while attaching the AUMI to the current proccess =(");
return false;
}
_isInitialized = true;
return _isInitialized;
}
bool WinToast::isInitialized() const {
return _isInitialized;
}
const std::wstring& WinToast::appName() const {
return _appName;
}
const std::wstring& WinToast::appUserModelId() const {
return _aumi;
}
HRESULT WinToast::validateShellLinkHelper(_Out_ bool& wasChanged) {
WCHAR path[MAX_PATH] = { L'\0' };
Util::defaultUserShellLinkPath(_appName, path);
// Check if the file exist
DWORD attr = GetFileAttributesW(path);
if (attr >= 0xFFFFFFF) {
// The shortcut may be in the system Start Menu.
WCHAR systemPath[MAX_PATH] = { L'\0' };
Util::defaultSystemShellLinkPath(_appName, systemPath);
attr = GetFileAttributesW(systemPath);
if (attr >= 0xFFFFFFF) {
DEBUG_MSG("Error, shell link not found. Try to create a new one in: " << path);
return E_FAIL;
}
wcscpy(path, systemPath);
}
// Let's load the file as shell link to validate.
// - Create a shell link
// - Create a persistant file
// - Load the path as data for the persistant file
// - Read the property AUMI and validate with the current
// - Review if AUMI is equal.
ComPtr<IShellLink> shellLink;
HRESULT hr = CoCreateInstance(CLSID_ShellLink, nullptr, CLSCTX_INPROC_SERVER, IID_PPV_ARGS(&shellLink));
if (SUCCEEDED(hr)) {
ComPtr<IPersistFile> persistFile;
hr = shellLink.As(&persistFile);
if (SUCCEEDED(hr)) {
hr = persistFile->Load(path, STGM_READ);
if (SUCCEEDED(hr)) {
ComPtr<IPropertyStore> propertyStore;
hr = shellLink.As(&propertyStore);
if (SUCCEEDED(hr)) {
PROPVARIANT appIdPropVar;
hr = propertyStore->GetValue(PKEY_AppUserModel_ID, &appIdPropVar);
if (SUCCEEDED(hr)) {
WCHAR AUMI[MAX_PATH];
hr = DllImporter::PropVariantToString(appIdPropVar, AUMI, MAX_PATH);
wasChanged = false;
if (FAILED(hr) || _aumi != AUMI) {
if (_shortcutPolicy == SHORTCUT_POLICY_REQUIRE_CREATE) {
// AUMI Changed for the same app, let's update the current value! =)
wasChanged = true;
PropVariantClear(&appIdPropVar);
hr = InitPropVariantFromString(_aumi.c_str(), &appIdPropVar);
if (SUCCEEDED(hr)) {
hr = propertyStore->SetValue(PKEY_AppUserModel_ID, appIdPropVar);
if (SUCCEEDED(hr)) {
hr = propertyStore->Commit();
if (SUCCEEDED(hr) && SUCCEEDED(persistFile->IsDirty())) {
hr = persistFile->Save(path, TRUE);
}
}
}
} else {
// Not allowed to touch the shortcut to fix the AUMI
hr = E_FAIL;
}
}
PropVariantClear(&appIdPropVar);
}
}
}
}
}
return hr;
}
HRESULT WinToast::createShellLinkHelper() {
if (_shortcutPolicy != SHORTCUT_POLICY_REQUIRE_CREATE) {
return E_FAIL;
}
WCHAR exePath[MAX_PATH]{L'\0'};
WCHAR slPath[MAX_PATH]{L'\0'};
Util::defaultUserShellLinkPath(_appName, slPath);
Util::defaultExecutablePath(exePath);
ComPtr<IShellLinkW> shellLink;
HRESULT hr = CoCreateInstance(CLSID_ShellLink, nullptr, CLSCTX_INPROC_SERVER, IID_PPV_ARGS(&shellLink));
if (SUCCEEDED(hr)) {
hr = shellLink->SetPath(exePath);
if (SUCCEEDED(hr)) {
hr = shellLink->SetArguments(L"");
if (SUCCEEDED(hr)) {
hr = shellLink->SetWorkingDirectory(exePath);
if (SUCCEEDED(hr)) {
ComPtr<IPropertyStore> propertyStore;
hr = shellLink.As(&propertyStore);
if (SUCCEEDED(hr)) {
PROPVARIANT appIdPropVar;
hr = InitPropVariantFromString(_aumi.c_str(), &appIdPropVar);
if (SUCCEEDED(hr)) {
hr = propertyStore->SetValue(PKEY_AppUserModel_ID, appIdPropVar);
if (SUCCEEDED(hr)) {
hr = propertyStore->Commit();
if (SUCCEEDED(hr)) {
ComPtr<IPersistFile> persistFile;
hr = shellLink.As(&persistFile);
if (SUCCEEDED(hr)) {
hr = persistFile->Save(slPath, TRUE);
}
}
}
PropVariantClear(&appIdPropVar);
}
}
}
}
}
}
return hr;
}
INT64 WinToast::showToast(_In_ const WinToastTemplate& toast, _In_ IWinToastHandler* handler, _Out_ WinToastError* error) {
setError(error, WinToastError::NoError);
INT64 id = -1;
if (!isInitialized()) {
setError(error, WinToastError::NotInitialized);
DEBUG_MSG("Error when launching the toast. WinToast is not initialized.");
return id;
}
if (!handler) {
setError(error, WinToastError::InvalidHandler);
DEBUG_MSG("Error when launching the toast. Handler cannot be nullptr.");
return id;
}
ComPtr<IToastNotificationManagerStatics> notificationManager;
HRESULT hr = DllImporter::Wrap_GetActivationFactory(WinToastStringWrapper(RuntimeClass_Windows_UI_Notifications_ToastNotificationManager).Get(), ¬ificationManager);
if (SUCCEEDED(hr)) {
ComPtr<IToastNotifier> notifier;
hr = notificationManager->CreateToastNotifierWithId(WinToastStringWrapper(_aumi).Get(), ¬ifier);
if (SUCCEEDED(hr)) {
ComPtr<IToastNotificationFactory> notificationFactory;
hr = DllImporter::Wrap_GetActivationFactory(WinToastStringWrapper(RuntimeClass_Windows_UI_Notifications_ToastNotification).Get(), ¬ificationFactory);
if (SUCCEEDED(hr)) {
ComPtr<IXmlDocument> xmlDocument;
HRESULT hr = notificationManager->GetTemplateContent(ToastTemplateType(toast.type()), &xmlDocument);
if (SUCCEEDED(hr)) {
for (std::size_t i = 0, fieldsCount = toast.textFieldsCount(); i < fieldsCount && SUCCEEDED(hr); i++) {
hr = setTextFieldHelper(xmlDocument.Get(), toast.textField(WinToastTemplate::TextField(i)), i);
}
// Modern feature are supported Windows > Windows 10
if (SUCCEEDED(hr) && isSupportingModernFeatures()) {
// Note that we do this *after* using toast.textFieldsCount() to
// iterate/fill the template's text fields, since we're adding yet another text field.
if (SUCCEEDED(hr)
&& !toast.attributionText().empty()) {
hr = setAttributionTextFieldHelper(xmlDocument.Get(), toast.attributionText());
}
std::array<WCHAR, 12> buf;
for (std::size_t i = 0, actionsCount = toast.actionsCount(); i < actionsCount && SUCCEEDED(hr); i++) {
_snwprintf_s(buf.data(), buf.size(), _TRUNCATE, L"%zd", i);
hr = addActionHelper(xmlDocument.Get(), toast.actionLabel(i), buf.data());
}
if (SUCCEEDED(hr)) {
hr = (toast.audioPath().empty() && toast.audioOption() == WinToastTemplate::AudioOption::Default)
? hr : setAudioFieldHelper(xmlDocument.Get(), toast.audioPath(), toast.audioOption());
}
if (SUCCEEDED(hr) && toast.duration() != WinToastTemplate::Duration::System) {
hr = addDurationHelper(xmlDocument.Get(),
(toast.duration() == WinToastTemplate::Duration::Short) ? L"short" : L"long");
}
if (SUCCEEDED(hr)) {
hr = addScenarioHelper(xmlDocument.Get(), toast.scenario());
}
} else {
DEBUG_MSG("Modern features (Actions/Sounds/Attributes) not supported in this os version");
}
if (SUCCEEDED(hr)) {
hr = toast.hasImage() ? setImageFieldHelper(xmlDocument.Get(), toast.imagePath()) : hr;
if (SUCCEEDED(hr)) {
ComPtr<IToastNotification> notification;
hr = notificationFactory->CreateToastNotification(xmlDocument.Get(), ¬ification);
if (SUCCEEDED(hr)) {
INT64 expiration = 0, relativeExpiration = toast.expiration();
if (relativeExpiration > 0) {
InternalDateTime expirationDateTime(relativeExpiration);
expiration = expirationDateTime;
hr = notification->put_ExpirationTime(&expirationDateTime);
}
if (SUCCEEDED(hr)) {
hr = Util::setEventHandlers(notification.Get(), std::shared_ptr<IWinToastHandler>(handler), expiration);
if (FAILED(hr)) {
setError(error, WinToastError::InvalidHandler);
}
}
if (SUCCEEDED(hr)) {
GUID guid;
hr = CoCreateGuid(&guid);
if (SUCCEEDED(hr)) {
id = guid.Data1;
_buffer[id] = notification;
DEBUG_MSG("xml: " << Util::AsString(xmlDocument));
hr = notifier->Show(notification.Get());
if (FAILED(hr)) {
setError(error, WinToastError::NotDisplayed);
}
}
}
}
}
}
}
}
}
}
return FAILED(hr) ? -1 : id;
}
ComPtr<IToastNotifier> WinToast::notifier(_In_ bool* succeded) const {
ComPtr<IToastNotificationManagerStatics> notificationManager;
ComPtr<IToastNotifier> notifier;
HRESULT hr = DllImporter::Wrap_GetActivationFactory(WinToastStringWrapper(RuntimeClass_Windows_UI_Notifications_ToastNotificationManager).Get(), ¬ificationManager);
if (SUCCEEDED(hr)) {
hr = notificationManager->CreateToastNotifierWithId(WinToastStringWrapper(_aumi).Get(), ¬ifier);
}
*succeded = SUCCEEDED(hr);
return notifier;
}
bool WinToast::hideToast(_In_ INT64 id) {
if (!isInitialized()) {
DEBUG_MSG("Error when hiding the toast. WinToast is not initialized.");
return false;
}
if (_buffer.find(id) != _buffer.end()) {
auto succeded = false;
auto notify = notifier(&succeded);
if (succeded) {
auto result = notify->Hide(_buffer[id].Get());
_buffer.erase(id);
return SUCCEEDED(result);
}
}
return false;
}
void WinToast::clear() {
auto succeded = false;
auto notify = notifier(&succeded);
if (succeded) {
auto end = _buffer.end();
for (auto it = _buffer.begin(); it != end; ++it) {
notify->Hide(it->second.Get());
}
_buffer.clear();
}
}
//
// Available as of Windows 10 Anniversary Update
// Ref: https://docs.microsoft.com/en-us/windows/uwp/design/shell/tiles-and-notifications/adaptive-interactive-toasts
//
// NOTE: This will add a new text field, so be aware when iterating over
// the toast's text fields or getting a count of them.
//
HRESULT WinToast::setAttributionTextFieldHelper(_In_ IXmlDocument *xml, _In_ const std::wstring& text) {
Util::createElement(xml, L"binding", L"text", { L"placement" });
ComPtr<IXmlNodeList> nodeList;
HRESULT hr = xml->GetElementsByTagName(WinToastStringWrapper(L"text").Get(), &nodeList);
if (SUCCEEDED(hr)) {
UINT32 nodeListLength;
hr = nodeList->get_Length(&nodeListLength);
if (SUCCEEDED(hr)) {
for (UINT32 i = 0; i < nodeListLength; i++) {
ComPtr<IXmlNode> textNode;
hr = nodeList->Item(i, &textNode);
if (SUCCEEDED(hr)) {
ComPtr<IXmlNamedNodeMap> attributes;
hr = textNode->get_Attributes(&attributes);
if (SUCCEEDED(hr)) {
ComPtr<IXmlNode> editedNode;
if (SUCCEEDED(hr)) {
hr = attributes->GetNamedItem(WinToastStringWrapper(L"placement").Get(), &editedNode);
if (FAILED(hr) || !editedNode) {
continue;
}
hr = Util::setNodeStringValue(L"attribution", editedNode.Get(), xml);
if (SUCCEEDED(hr)) {
return setTextFieldHelper(xml, text, i);
}
}
}
}
}
}
}
return hr;
}
HRESULT WinToast::addDurationHelper(_In_ IXmlDocument *xml, _In_ const std::wstring& duration) {
ComPtr<IXmlNodeList> nodeList;
HRESULT hr = xml->GetElementsByTagName(WinToastStringWrapper(L"toast").Get(), &nodeList);
if (SUCCEEDED(hr)) {
UINT32 length;
hr = nodeList->get_Length(&length);
if (SUCCEEDED(hr)) {
ComPtr<IXmlNode> toastNode;
hr = nodeList->Item(0, &toastNode);
if (SUCCEEDED(hr)) {
ComPtr<IXmlElement> toastElement;
hr = toastNode.As(&toastElement);
if (SUCCEEDED(hr)) {
hr = toastElement->SetAttribute(WinToastStringWrapper(L"duration").Get(),
WinToastStringWrapper(duration).Get());
}
}
}
}
return hr;
}
HRESULT WinToast::addScenarioHelper(_In_ IXmlDocument* xml, _In_ const std::wstring& scenario) {
ComPtr<IXmlNodeList> nodeList;
HRESULT hr = xml->GetElementsByTagName(WinToastStringWrapper(L"toast").Get(), &nodeList);
if (SUCCEEDED(hr)) {
UINT32 length;
hr = nodeList->get_Length(&length);
if (SUCCEEDED(hr)) {
ComPtr<IXmlNode> toastNode;
hr = nodeList->Item(0, &toastNode);
if (SUCCEEDED(hr)) {
ComPtr<IXmlElement> toastElement;
hr = toastNode.As(&toastElement);
if (SUCCEEDED(hr)) {
hr = toastElement->SetAttribute(WinToastStringWrapper(L"scenario").Get(),
WinToastStringWrapper(scenario).Get());
}
}
}
}
return hr;
}
HRESULT WinToast::setTextFieldHelper(_In_ IXmlDocument *xml, _In_ const std::wstring& text, _In_ UINT32 pos) {
ComPtr<IXmlNodeList> nodeList;
HRESULT hr = xml->GetElementsByTagName(WinToastStringWrapper(L"text").Get(), &nodeList);
if (SUCCEEDED(hr)) {
ComPtr<IXmlNode> node;
hr = nodeList->Item(pos, &node);
if (SUCCEEDED(hr)) {
hr = Util::setNodeStringValue(text, node.Get(), xml);
}
}
return hr;
}
HRESULT WinToast::setImageFieldHelper(_In_ IXmlDocument *xml, _In_ const std::wstring& path) {
assert(path.size() < MAX_PATH);
wchar_t imagePath[MAX_PATH] = L"file:///";
HRESULT hr = StringCchCatW(imagePath, MAX_PATH, path.c_str());
if (SUCCEEDED(hr)) {
ComPtr<IXmlNodeList> nodeList;
HRESULT hr = xml->GetElementsByTagName(WinToastStringWrapper(L"image").Get(), &nodeList);
if (SUCCEEDED(hr)) {
ComPtr<IXmlNode> node;
hr = nodeList->Item(0, &node);
if (SUCCEEDED(hr)) {
ComPtr<IXmlNamedNodeMap> attributes;
hr = node->get_Attributes(&attributes);
if (SUCCEEDED(hr)) {
ComPtr<IXmlNode> editedNode;
hr = attributes->GetNamedItem(WinToastStringWrapper(L"src").Get(), &editedNode);
if (SUCCEEDED(hr)) {
Util::setNodeStringValue(imagePath, editedNode.Get(), xml);
}
}
}
}
}
return hr;
}
HRESULT WinToast::setAudioFieldHelper(_In_ IXmlDocument *xml, _In_ const std::wstring& path, _In_opt_ WinToastTemplate::AudioOption option) {
std::vector<std::wstring> attrs;
if (!path.empty()) attrs.push_back(L"src");
if (option == WinToastTemplate::AudioOption::Loop) attrs.push_back(L"loop");
if (option == WinToastTemplate::AudioOption::Silent) attrs.push_back(L"silent");
Util::createElement(xml, L"toast", L"audio", attrs);
ComPtr<IXmlNodeList> nodeList;
HRESULT hr = xml->GetElementsByTagName(WinToastStringWrapper(L"audio").Get(), &nodeList);
if (SUCCEEDED(hr)) {
ComPtr<IXmlNode> node;
hr = nodeList->Item(0, &node);
if (SUCCEEDED(hr)) {
ComPtr<IXmlNamedNodeMap> attributes;
hr = node->get_Attributes(&attributes);
if (SUCCEEDED(hr)) {
ComPtr<IXmlNode> editedNode;
if (!path.empty()) {
if (SUCCEEDED(hr)) {
hr = attributes->GetNamedItem(WinToastStringWrapper(L"src").Get(), &editedNode);
if (SUCCEEDED(hr)) {
hr = Util::setNodeStringValue(path, editedNode.Get(), xml);
}
}
}
if (SUCCEEDED(hr)) {
switch (option) {
case WinToastTemplate::AudioOption::Loop:
hr = attributes->GetNamedItem(WinToastStringWrapper(L"loop").Get(), &editedNode);
if (SUCCEEDED(hr)) {
hr = Util::setNodeStringValue(L"true", editedNode.Get(), xml);
}
break;
case WinToastTemplate::AudioOption::Silent:
hr = attributes->GetNamedItem(WinToastStringWrapper(L"silent").Get(), &editedNode);
if (SUCCEEDED(hr)) {
hr = Util::setNodeStringValue(L"true", editedNode.Get(), xml);
}
default:
break;
}
}
}
}
}
return hr;
}
HRESULT WinToast::addActionHelper(_In_ IXmlDocument *xml, _In_ const std::wstring& content, _In_ const std::wstring& arguments) {
ComPtr<IXmlNodeList> nodeList;
HRESULT hr = xml->GetElementsByTagName(WinToastStringWrapper(L"actions").Get(), &nodeList);
if (SUCCEEDED(hr)) {
UINT32 length;
hr = nodeList->get_Length(&length);
if (SUCCEEDED(hr)) {
ComPtr<IXmlNode> actionsNode;
if (length > 0) {
hr = nodeList->Item(0, &actionsNode);
} else {
hr = xml->GetElementsByTagName(WinToastStringWrapper(L"toast").Get(), &nodeList);
if (SUCCEEDED(hr)) {
hr = nodeList->get_Length(&length);
if (SUCCEEDED(hr)) {
ComPtr<IXmlNode> toastNode;
hr = nodeList->Item(0, &toastNode);
if (SUCCEEDED(hr)) {
ComPtr<IXmlElement> toastElement;
hr = toastNode.As(&toastElement);
if (SUCCEEDED(hr))
hr = toastElement->SetAttribute(WinToastStringWrapper(L"template").Get(), WinToastStringWrapper(L"ToastGeneric").Get());
if (SUCCEEDED(hr))
hr = toastElement->SetAttribute(WinToastStringWrapper(L"duration").Get(), WinToastStringWrapper(L"long").Get());
if (SUCCEEDED(hr)) {
ComPtr<IXmlElement> actionsElement;
hr = xml->CreateElement(WinToastStringWrapper(L"actions").Get(), &actionsElement);
if (SUCCEEDED(hr)) {
hr = actionsElement.As(&actionsNode);
if (SUCCEEDED(hr)) {
ComPtr<IXmlNode> appendedChild;
hr = toastNode->AppendChild(actionsNode.Get(), &appendedChild);
}
}
}
}
}
}
}
if (SUCCEEDED(hr)) {
ComPtr<IXmlElement> actionElement;
hr = xml->CreateElement(WinToastStringWrapper(L"action").Get(), &actionElement);
if (SUCCEEDED(hr))
hr = actionElement->SetAttribute(WinToastStringWrapper(L"content").Get(), WinToastStringWrapper(content).Get());
if (SUCCEEDED(hr))
hr = actionElement->SetAttribute(WinToastStringWrapper(L"arguments").Get(), WinToastStringWrapper(arguments).Get());
if (SUCCEEDED(hr)) {
ComPtr<IXmlNode> actionNode;
hr = actionElement.As(&actionNode);
if (SUCCEEDED(hr)) {
ComPtr<IXmlNode> appendedChild;
hr = actionsNode->AppendChild(actionNode.Get(), &appendedChild);
}
}
}
}
}
return hr;
}
void WinToast::setError(_Out_ WinToastError* error, _In_ WinToastError value) {
if (error) {
*error = value;
}
}
WinToastTemplate::WinToastTemplate(_In_ WinToastTemplateType type) : _type(type) {
static constexpr std::size_t TextFieldsCount[] = { 1, 2, 2, 3, 1, 2, 2, 3};
_textFields = std::vector<std::wstring>(TextFieldsCount[type], L"");
}
WinToastTemplate::~WinToastTemplate() {
_textFields.clear();
}
void WinToastTemplate::setTextField(_In_ const std::wstring& txt, _In_ WinToastTemplate::TextField pos) {
const auto position = static_cast<std::size_t>(pos);
assert(position < _textFields.size());
_textFields[position] = txt;
}
void WinToastTemplate::setImagePath(_In_ const std::wstring& imgPath) {
_imagePath = imgPath;
}
void WinToastTemplate::setAudioPath(_In_ const std::wstring& audioPath) {
_audioPath = audioPath;
}
void WinToastTemplate::setAudioPath(_In_ AudioSystemFile file) {
static const std::unordered_map<AudioSystemFile, std::wstring> Files = {
{AudioSystemFile::DefaultSound, L"ms-winsoundevent:Notification.Default"},
{AudioSystemFile::IM, L"ms-winsoundevent:Notification.IM"},
{AudioSystemFile::Mail, L"ms-winsoundevent:Notification.Mail"},
{AudioSystemFile::Reminder, L"ms-winsoundevent:Notification.Reminder"},
{AudioSystemFile::SMS, L"ms-winsoundevent:Notification.SMS"},
{AudioSystemFile::Alarm, L"ms-winsoundevent:Notification.Looping.Alarm"},
{AudioSystemFile::Alarm2, L"ms-winsoundevent:Notification.Looping.Alarm2"},
{AudioSystemFile::Alarm3, L"ms-winsoundevent:Notification.Looping.Alarm3"},
{AudioSystemFile::Alarm4, L"ms-winsoundevent:Notification.Looping.Alarm4"},
{AudioSystemFile::Alarm5, L"ms-winsoundevent:Notification.Looping.Alarm5"},
{AudioSystemFile::Alarm6, L"ms-winsoundevent:Notification.Looping.Alarm6"},
{AudioSystemFile::Alarm7, L"ms-winsoundevent:Notification.Looping.Alarm7"},
{AudioSystemFile::Alarm8, L"ms-winsoundevent:Notification.Looping.Alarm8"},
{AudioSystemFile::Alarm9, L"ms-winsoundevent:Notification.Looping.Alarm9"},
{AudioSystemFile::Alarm10, L"ms-winsoundevent:Notification.Looping.Alarm10"},
{AudioSystemFile::Call, L"ms-winsoundevent:Notification.Looping.Call"},
{AudioSystemFile::Call1, L"ms-winsoundevent:Notification.Looping.Call1"},
{AudioSystemFile::Call2, L"ms-winsoundevent:Notification.Looping.Call2"},
{AudioSystemFile::Call3, L"ms-winsoundevent:Notification.Looping.Call3"},
{AudioSystemFile::Call4, L"ms-winsoundevent:Notification.Looping.Call4"},
{AudioSystemFile::Call5, L"ms-winsoundevent:Notification.Looping.Call5"},
{AudioSystemFile::Call6, L"ms-winsoundevent:Notification.Looping.Call6"},
{AudioSystemFile::Call7, L"ms-winsoundevent:Notification.Looping.Call7"},
{AudioSystemFile::Call8, L"ms-winsoundevent:Notification.Looping.Call8"},
{AudioSystemFile::Call9, L"ms-winsoundevent:Notification.Looping.Call9"},
{AudioSystemFile::Call10, L"ms-winsoundevent:Notification.Looping.Call10"},
};
const auto iter = Files.find(file);
assert(iter != Files.end());
_audioPath = iter->second;
}
void WinToastTemplate::setAudioOption(_In_ WinToastTemplate::AudioOption audioOption) {
_audioOption = audioOption;
}
void WinToastTemplate::setFirstLine(const std::wstring &text) {
setTextField(text, WinToastTemplate::FirstLine);
}
void WinToastTemplate::setSecondLine(const std::wstring &text) {
setTextField(text, WinToastTemplate::SecondLine);
}
void WinToastTemplate::setThirdLine(const std::wstring &text) {
setTextField(text, WinToastTemplate::ThirdLine);
}
void WinToastTemplate::setDuration(_In_ Duration duration) {
_duration = duration;
}
void WinToastTemplate::setExpiration(_In_ INT64 millisecondsFromNow) {
_expiration = millisecondsFromNow;
}
void WinToastLib::WinToastTemplate::setScenario(Scenario scenario) {
switch (scenario) {
case Scenario::Default: _scenario = L"Default"; break;
case Scenario::Alarm: _scenario = L"Alarm"; break;
case Scenario::IncomingCall: _scenario = L"IncomingCall"; break;
case Scenario::Reminder: _scenario = L"Reminder"; break;
}
}
void WinToastTemplate::setAttributionText(_In_ const std::wstring& attributionText) {
_attributionText = attributionText;
}
void WinToastTemplate::addAction(_In_ const std::wstring & label) {
_actions.push_back(label);
}
std::size_t WinToastTemplate::textFieldsCount() const {
return _textFields.size();
}
std::size_t WinToastTemplate::actionsCount() const {
return _actions.size();
}
bool WinToastTemplate::hasImage() const {
return _type < WinToastTemplateType::Text01;
}
const std::vector<std::wstring>& WinToastTemplate::textFields() const {
return _textFields;
}
const std::wstring& WinToastTemplate::textField(_In_ TextField pos) const {
const auto position = static_cast<std::size_t>(pos);
assert(position < _textFields.size());
return _textFields[position];
}
const std::wstring& WinToastTemplate::actionLabel(_In_ std::size_t position) const {
assert(position < _actions.size());
return _actions[position];
}
const std::wstring& WinToastTemplate::imagePath() const {
return _imagePath;
}
const std::wstring& WinToastTemplate::audioPath() const {
return _audioPath;
}
const std::wstring& WinToastTemplate::attributionText() const {
return _attributionText;
}
const std::wstring& WinToastLib::WinToastTemplate::scenario() const {
return _scenario;
}
INT64 WinToastTemplate::expiration() const {
return _expiration;
}
WinToastTemplate::WinToastTemplateType WinToastTemplate::type() const {
return _type;
}
WinToastTemplate::AudioOption WinToastTemplate::audioOption() const {
return _audioOption;
}
WinToastTemplate::Duration WinToastTemplate::duration() const {
return _duration;
}
|