/*** * ==++== * * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * * ==--== * =+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+ * * Various common utilities. * * For the latest on this and related APIs, please see http://casablanca.codeplex.com. * * =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- ****/ #pragma once #include #include #include #include #include #include #include "pplx/pplxtasks.h" #include "cpprest/details/basic_types.h" #if !defined(_WIN32) || (_MSC_VER >= 1700) #include #endif #ifndef _WIN32 #include #if !defined(ANDROID) && !defined(__ANDROID__) // CodePlex 269 #include #endif #endif /// Various utilities for string conversions and date and time manipulation. namespace utility { // Left over from VS2010 support, remains to avoid breaking. typedef std::chrono::seconds seconds; /// Functions for converting to/from std::chrono::seconds to xml string. namespace timespan { /// /// Converts a timespan/interval in seconds to xml duration string as specified by /// http://www.w3.org/TR/xmlschema-2/#duration /// _ASYNCRTIMP utility::string_t __cdecl seconds_to_xml_duration(utility::seconds numSecs); /// /// Converts an xml duration to timespan/interval in seconds /// http://www.w3.org/TR/xmlschema-2/#duration /// _ASYNCRTIMP utility::seconds __cdecl xml_duration_to_seconds(const utility::string_t ×panString); } /// Functions for Unicode string conversions. namespace conversions { /// /// Converts a UTF-16 string to a UTF-8 string. /// /// A two byte character UTF-16 string. /// A single byte character UTF-8 string. _ASYNCRTIMP std::string __cdecl utf16_to_utf8(const utf16string &w); /// /// Converts a UTF-8 string to a UTF-16 /// /// A single byte character UTF-8 string. /// A two byte character UTF-16 string. _ASYNCRTIMP utf16string __cdecl utf8_to_utf16(const std::string &s); /// /// Converts a ASCII (us-ascii) string to a UTF-16 string. /// /// A single byte character us-ascii string. /// A two byte character UTF-16 string. _ASYNCRTIMP utf16string __cdecl usascii_to_utf16(const std::string &s); /// /// Converts a Latin1 (iso-8859-1) string to a UTF-16 string. /// /// A single byte character UTF-8 string. /// A two byte character UTF-16 string. _ASYNCRTIMP utf16string __cdecl latin1_to_utf16(const std::string &s); /// /// Converts a Latin1 (iso-8859-1) string to a UTF-8 string. /// /// A single byte character UTF-8 string. /// A single byte character UTF-8 string. _ASYNCRTIMP utf8string __cdecl latin1_to_utf8(const std::string &s); /// /// Converts to a platform dependent Unicode string type. /// /// A single byte character UTF-8 string. /// A platform dependent string type. _ASYNCRTIMP utility::string_t __cdecl to_string_t(std::string &&s); /// /// Converts to a platform dependent Unicode string type. /// /// A two byte character UTF-16 string. /// A platform dependent string type. _ASYNCRTIMP utility::string_t __cdecl to_string_t(utf16string &&s); /// /// Converts to a platform dependent Unicode string type. /// /// A single byte character UTF-8 string. /// A platform dependent string type. _ASYNCRTIMP utility::string_t __cdecl to_string_t(const std::string &s); /// /// Converts to a platform dependent Unicode string type. /// /// A two byte character UTF-16 string. /// A platform dependent string type. _ASYNCRTIMP utility::string_t __cdecl to_string_t(const utf16string &s); /// /// Converts to a UTF-16 from string. /// /// A single byte character UTF-8 string. /// A two byte character UTF-16 string. _ASYNCRTIMP utf16string __cdecl to_utf16string(const std::string &value); /// /// Converts to a UTF-16 from string. /// /// A two byte character UTF-16 string. /// A two byte character UTF-16 string. _ASYNCRTIMP utf16string __cdecl to_utf16string(utf16string value); /// /// Converts to a UTF-8 string. /// /// A single byte character UTF-8 string. /// A single byte character UTF-8 string. _ASYNCRTIMP std::string __cdecl to_utf8string(std::string value); /// /// Converts to a UTF-8 string. /// /// A two byte character UTF-16 string. /// A single byte character UTF-8 string. _ASYNCRTIMP std::string __cdecl to_utf8string(const utf16string &value); /// /// Encode the given byte array into a base64 string /// _ASYNCRTIMP utility::string_t __cdecl to_base64(const std::vector& data); /// /// Encode the given 8-byte integer into a base64 string /// _ASYNCRTIMP utility::string_t __cdecl to_base64(uint64_t data); /// /// Decode the given base64 string to a byte array /// _ASYNCRTIMP std::vector __cdecl from_base64(const utility::string_t& str); template utility::string_t print_string(const Source &val, const std::locale &loc) { utility::ostringstream_t oss; oss.imbue(loc); oss << val; if (oss.bad()) { throw std::bad_cast(); } return oss.str(); } template utility::string_t print_string(const Source &val) { return print_string(val, std::locale()); } template Target scan_string(const utility::string_t &str, const std::locale &loc) { Target t; utility::istringstream_t iss(str); iss.imbue(loc); iss >> t; if (iss.bad()) { throw std::bad_cast(); } return t; } template Target scan_string(const utility::string_t &str) { return scan_string(str, std::locale()); } } namespace details { /// /// Cross platform RAII container for setting thread local locale. /// class scoped_c_thread_locale { public: _ASYNCRTIMP scoped_c_thread_locale(); _ASYNCRTIMP ~scoped_c_thread_locale(); #if !defined(ANDROID) && !defined(__ANDROID__) // CodePlex 269 #ifdef _WIN32 typedef _locale_t xplat_locale; #else typedef locale_t xplat_locale; #endif static _ASYNCRTIMP xplat_locale __cdecl c_locale(); #endif private: #ifdef _WIN32 std::string m_prevLocale; int m_prevThreadSetting; #elif !(defined(ANDROID) || defined(__ANDROID__)) locale_t m_prevLocale; #endif scoped_c_thread_locale(const scoped_c_thread_locale &); scoped_c_thread_locale & operator=(const scoped_c_thread_locale &); }; /// /// Our own implementation of alpha numeric instead of std::isalnum to avoid /// taking global lock for performance reasons. /// inline bool __cdecl is_alnum(char ch) { return (ch >= '0' && ch <= '9') || (ch >= 'A' && ch <= 'Z') || (ch >= 'a' && ch <= 'z'); } /// /// Simplistic implementation of make_unique. A better implementation would be based on variadic templates /// and therefore not be compatible with Dev10. /// template std::unique_ptr<_Type> make_unique() { return std::unique_ptr<_Type>(new _Type()); } template std::unique_ptr<_Type> make_unique(_Arg1&& arg1) { return std::unique_ptr<_Type>(new _Type(std::forward<_Arg1>(arg1))); } template std::unique_ptr<_Type> make_unique(_Arg1&& arg1, _Arg2&& arg2) { return std::unique_ptr<_Type>(new _Type(std::forward<_Arg1>(arg1), std::forward<_Arg2>(arg2))); } template std::unique_ptr<_Type> make_unique(_Arg1&& arg1, _Arg2&& arg2, _Arg3&& arg3) { return std::unique_ptr<_Type>(new _Type(std::forward<_Arg1>(arg1), std::forward<_Arg2>(arg2), std::forward<_Arg3>(arg3))); } /// /// Cross platform utility function for performing case insensitive string comparision. /// /// First string to compare. /// Second strong to compare. /// true if the strings are equivalent, false otherwise inline bool str_icmp(const utility::string_t &left, const utility::string_t &right) { #ifdef _WIN32 return _wcsicmp(left.c_str(), right.c_str()) == 0; #else return boost::iequals(left, right); #endif } #ifdef _WIN32 /// /// Category error type for Windows OS errors. /// class windows_category_impl : public std::error_category { public: virtual const char *name() const CPPREST_NOEXCEPT { return "windows"; } _ASYNCRTIMP virtual std::string message(int errorCode) const CPPREST_NOEXCEPT; _ASYNCRTIMP virtual std::error_condition default_error_condition(int errorCode) const CPPREST_NOEXCEPT; }; /// /// Gets the one global instance of the windows error category. /// /// An error category instance. _ASYNCRTIMP const std::error_category & __cdecl windows_category(); #else /// /// Gets the one global instance of the linux error category. /// /// An error category instance. _ASYNCRTIMP const std::error_category & __cdecl linux_category(); #endif /// /// Gets the one global instance of the current platform's error category. /// _ASYNCRTIMP const std::error_category & __cdecl platform_category(); /// /// Creates an instance of std::system_error from a OS error code. /// inline std::system_error __cdecl create_system_error(unsigned long errorCode) { std::error_code code((int)errorCode, platform_category()); return std::system_error(code, code.message()); } /// /// Creates a std::error_code from a OS error code. /// inline std::error_code __cdecl create_error_code(unsigned long errorCode) { return std::error_code((int)errorCode, platform_category()); } /// /// Creates the corresponding error message from a OS error code. /// inline utility::string_t __cdecl create_error_message(unsigned long errorCode) { return utility::conversions::to_string_t(create_error_code(errorCode).message()); } } class datetime { public: typedef uint64_t interval_type; /// /// Defines the supported date and time string formats. /// enum date_format { RFC_1123, ISO_8601 }; /// /// Returns the current UTC time. /// static _ASYNCRTIMP datetime __cdecl utc_now(); /// /// An invalid UTC timestamp value. /// enum:interval_type { utc_timestamp_invalid = static_cast(-1) }; /// /// Returns seconds since Unix/POSIX time epoch at 01-01-1970 00:00:00. /// If time is before epoch, utc_timestamp_invalid is returned. /// static interval_type utc_timestamp() { const auto seconds = utc_now().to_interval() / _secondTicks; if (seconds >= 11644473600LL) { return seconds - 11644473600LL; } else { return utc_timestamp_invalid; } } datetime() : m_interval(0) { } /// /// Creates datetime from a string representing time in UTC in RFC 1123 format. /// /// Returns a datetime of zero if not successful. static _ASYNCRTIMP datetime __cdecl from_string(const utility::string_t& timestring, date_format format = RFC_1123); /// /// Returns a string representation of the datetime. /// _ASYNCRTIMP utility::string_t to_string(date_format format = RFC_1123) const; /// /// Returns the integral time value. /// interval_type to_interval() const { return m_interval; } datetime operator- (interval_type value) const { return datetime(m_interval - value); } datetime operator+ (interval_type value) const { return datetime(m_interval + value); } bool operator== (datetime dt) const { return m_interval == dt.m_interval; } bool operator!= (const datetime& dt) const { return !(*this == dt); } static interval_type from_milliseconds(unsigned int milliseconds) { return milliseconds*_msTicks; } static interval_type from_seconds(unsigned int seconds) { return seconds*_secondTicks; } static interval_type from_minutes(unsigned int minutes) { return minutes*_minuteTicks; } static interval_type from_hours(unsigned int hours) { return hours*_hourTicks; } static interval_type from_days(unsigned int days) { return days*_dayTicks; } bool is_initialized() const { return m_interval != 0; } private: friend int operator- (datetime t1, datetime t2); static const interval_type _msTicks = static_cast(10000); static const interval_type _secondTicks = 1000*_msTicks; static const interval_type _minuteTicks = 60*_secondTicks; static const interval_type _hourTicks = 60*60*_secondTicks; static const interval_type _dayTicks = 24*60*60*_secondTicks; #ifdef _WIN32 // void* to avoid pulling in windows.h static _ASYNCRTIMP bool __cdecl datetime::system_type_to_datetime(/*SYSTEMTIME*/ void* psysTime, uint64_t seconds, datetime * pdt); #else static datetime timeval_to_datetime(const timeval &time); #endif // Private constructor. Use static methods to create an instance. datetime(interval_type interval) : m_interval(interval) { } // Storing as hundreds of nanoseconds 10e-7, i.e. 1 here equals 100ns. interval_type m_interval; }; #ifndef _WIN32 // temporary workaround for the fact that // utf16char is not fully supported in GCC class cmp { public: static int icmp(std::string left, std::string right) { size_t i; for (i = 0; i < left.size(); ++i) { if (i == right.size()) return 1; auto l = cmp::tolower(left[i]); auto r = cmp::tolower(right[i]); if (l > r) return 1; if (l < r) return -1; } if (i < right.size()) return -1; return 0; } private: static char tolower(char c) { if (c >= 'A' && c <= 'Z') return static_cast(c - 'A' + 'a'); return c; } }; #endif inline int operator- (datetime t1, datetime t2) { auto diff = (t1.m_interval - t2.m_interval); // Round it down to seconds diff /= 10 * 1000 * 1000; return static_cast(diff); } /// /// Nonce string generator class. /// class nonce_generator { public: /// /// Define default nonce length. /// enum { default_length = 32 }; /// /// Nonce generator constructor. /// /// Length of the generated nonce string. nonce_generator(int length=default_length) : m_random(static_cast(utility::datetime::utc_timestamp())), m_length(length) {} /// /// Generate a nonce string containing random alphanumeric characters (A-Za-z0-9). /// Length of the generated string is set by length(). /// /// The generated nonce string. _ASYNCRTIMP utility::string_t generate(); /// /// Get length of generated nonce string. /// /// Nonce string length. int length() const { return m_length; } /// /// Set length of the generated nonce string. /// /// Lenght of nonce string. void set_length(int length) { m_length = length; } private: static const utility::string_t c_allowed_chars; std::mt19937 m_random; int m_length; }; } // namespace utility;