Getting started example of using 51Degrees device detection with User-Agent HTTP header values and User Agent Client Hint (UACH) header values.The example shows how to:
- Specify the name of the data file, properties the data set should be initialised with, and the configuration. using namespace FiftyoneDegrees;string fileName = "51Degrees-V4.1.hash";string propertiesString ="ScreenPixelsWidth,IsMobile,BrowserName,PlatformName,PlatformVersion,""SetHeaderPlatformAccept-CH";Common::RequiredPropertiesConfig *properties =new Common::RequiredPropertiesConfig(&propertiesString);
- Construct a new engine from the specified data file with the required properties and the specified configuration. using namespace FiftyoneDegrees;DeviceDetection::Hash::EngineHash *engine =dataFilePath,config,properties);
3a. Create a evidence instance and add a single HTTP User-Agent string to be processed.
using namespace FiftyoneDegrees;
evidence->operator[]("header.user-agent") = userAgent;
3b. Where UACH headers are being used add evidence for the Sec-CH-UA-Platform and Sec-CH-UA-Platform-Version HTTP header values.
using namespace FiftyoneDegrees;
evidence->operator[]("header.Sec-CH-UA-Platform") = uachPlatform;
evidence->operator[]("header.Sec-CH-UA-Platform-Version")= uachPlatformVersion;
- Process the evidence using the engine to retrieve the values associated with the User-Agent for the selected properties. using namespace FiftyoneDegrees;
5a. Extract the value of the IsMobile property as a string from the results.
if (value.hasValue()) {
string value = *value;
}
5b. If using UACH example then get the platform name and version.
Value<string> value = results->getValueAsString("PlatformName");
if (value.hasValue()) {
string value = *value;
Value<string> value = results->getValueAsString("PlatformVersion");
if (value.hasValue()) {
string value = *value;
- Release the memory used by the results and the evidence. delete results;delete evidence;
- Finally release the memory used by the engine. delete engine;
/* *********************************************************************
* This Original Work is copyright of 51 Degrees Mobile Experts Limited.
* Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
* Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
*
* This Original Work is licensed under the European Union Public Licence
* (EUPL) v.1.2 and is subject to its terms as set out below.
*
* If a copy of the EUPL was not distributed with this file, You can obtain
* one at https://opensource.org/licenses/EUPL-1.2.
*
* The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
* amended by the European Commission) shall be deemed incompatible for
* the purposes of the Work and the provisions of the compatibility
* clause in Article 5 of the EUPL shall not apply.
*
* If using the Work as, or as part of, a network application, by
* including the attribution notice(s) required under Article 5 of the EUPL
* in the end user terms of the application under an appropriate heading,
* such notice(s) shall fulfill the requirements of that article.
* ********************************************************************* */
#include "ExampleBase.hpp"
using namespace FiftyoneDegrees::Examples::Hash;
namespace FiftyoneDegrees {
namespace Examples {
namespace Hash {
public:
: ExampleBase(dataFilePath, config) {
};
void printResults(DeviceDetection::Hash::ResultsHash* results) {
cout << " PlatformName: " <<
(*results->getValueAsString("PlatformName")).c_str()
<< "\n";
cout << " PlatformVersion: " <<
(*results->getValueAsString("PlatformVersion")).c_str()
<< "\n";
cout << " IsMobile: " <<
(*results->getValueAsString("IsMobile")).c_str() << "\n";
cout << " Device ID: " <<
results->getDeviceId() << "\n";
}
void run() {
// Create an evidence instance to store and process
// User-Agents.
EvidenceDeviceDetection *evidence =
new EvidenceDeviceDetection();
cout << "Starting Getting Started Example.\n";
std::string deviceId_mobile;
{
// Carries out a match for a mobile User-Agent.
cout << "\n";
cout << "Mobile User-Agent: " <<
mobileUserAgent << "\n";
evidence->operator[]("header.user-agent")
= mobileUserAgent;
printResults(results);
deviceId_mobile = results->getDeviceId();
delete results;
};
{
// Carries out a match for a desktop User-Agent.
cout << "\n[---]\n";
cout << "Desktop User-Agent: " <<
desktopUserAgent << "\n";
evidence->operator[]("header.user-agent")
= desktopUserAgent;
printResults(results);
delete results;
};
{
// Carries out a match for a MediaHub User-Agent.
cout << "\n[---]\n";
cout << "MediaHub User-Agent: " <<
mediaHubUserAgent << "\n";
evidence->operator[]("header.user-agent")
= mediaHubUserAgent;
printResults(results);
delete results;
};
std::string deviceId_hintedHub;
{
// Carries out a match for a platform based on UACH headers.
cout << "\n(+)\n";
cout << "UACH Sec-CH-UA-Platform: " <<
uachPlatform << "\n";
cout << "UACH Sec-CH-UA-Platform-Version: " <<
uachPlatformVersion << "\n";
evidence->operator[]("header.Sec-CH-UA-Platform")
= uachPlatform;
evidence->operator[]("header.Sec-CH-UA-Platform-Version")
= uachPlatformVersion;
printResults(results);
deviceId_hintedHub = results->getDeviceId();
delete results;
};
{
// Carries out a match for a platform based on device ID.
cout << "\n(+)\n";
cout << "DeviceID: " << deviceId_mobile << " -- Mobile\n";
evidence->operator[]("query.51D_deviceId")
= deviceId_mobile.c_str();
printResults(results);
cout << " [control platform ID: " << deviceId_hintedHub << " -- MediaHub (hinted, no-deviceId)]\n";
delete results;
};
{
// Carries out a match for a platform with invalid device ID.
cout << "\n(+)\n";
const char* const deviceId_dummy = "123234-2244-1242-2412";
cout << "DeviceID: " << deviceId_dummy << " -- Dummy\n";
evidence->operator[]("query.51D_deviceId")
= deviceId_dummy;
printResults(results);
cout << " [control platform ID: " << deviceId_hintedHub << " -- MediaHub (hinted, no-deviceId)]\n";
delete results;
};
{
// Carries out a match for a mobile User-Agent with hinted MediaHub DeviceID.
EvidenceDeviceDetection* const evidence2 =
new EvidenceDeviceDetection();
cout << "\n[---]\n";
cout << "Mobile User-Agent: " <<
mobileUserAgent << "\n";
cout << "DeviceID: " << deviceId_hintedHub << " -- MediaHub (hinted)\n";
evidence2->operator[]("header.user-agent")
= mobileUserAgent;
// case-insensitive
evidence2->operator[]("query.51d_dEVIcEiD")
= deviceId_hintedHub.c_str();
DeviceDetection::Hash::ResultsHash* results = engine->process(evidence2);
printResults(results);
cout << " [control platform ID: " << deviceId_mobile << " -- Mobile (no-deviceId)]\n";
delete results;
delete evidence2;
};
// Free the evidence.
delete evidence;
cout << "\n";
}
};
}
}
}
extern "C" void fiftyoneDegreesExampleCPPGettingStartedRun(
ExampleParameters *params) {
// Call the actual function.
DeviceDetection::Hash::ConfigHash* cppConfig =
new DeviceDetection::Hash::ConfigHash(&configHash);
params->dataFilePath, cppConfig);
gettingStarted->run();
delete gettingStarted;
}
#ifndef TEST
int main(int argc, char* argv[]) {
if (argc > 1) {
strcpy(dataFilePath, argv[1]);
}
else {
status = fiftyoneDegreesFileGetPath(
dataDir,
dataFileName,
dataFilePath,
sizeof(dataFilePath));
}
if (status != FIFTYONE_DEGREES_STATUS_SUCCESS) {
ExampleBase::reportStatus(status, dataFileName);
fgetc(stdin);
return 1;
}
ExampleParameters params;
params.dataFilePath = dataFilePath;
// run the example
fiftyoneDegreesExampleMemCheck(
¶ms,
fiftyoneDegreesExampleCPPGettingStartedRun);
// Wait for a character to be pressed.
fgetc(stdin);
return 0;
}
#endif