n_ua.c

/*!
 * @file n_ua.c
 *
 * Written by Ray Ozzie and Blues Inc. team.
 *
 * Copyright (c) 2019 Blues Inc. MIT License. Use of this source code is
 * governed by licenses granted by the copyright holder including that found in
 * the
 * <a href="https://github.com/blues/note-c/blob/master/LICENSE">LICENSE</a>
 * file.
 *
 */

#ifndef NOTE_C_LOW_MEM

#include "n_lib.h"

// Override-able statics
static char *n_agent = (char *) ("note-c" " " NOTE_C_VERSION);
static int n_cpu_cores = 0;
static int n_cpu_mem = 0;
static int n_cpu_mhz = 0;
static char *n_cpu_vendor = NULL;
static char *n_os_family = NULL;
static char *n_os_name = NULL;
static char *n_os_platform = NULL;
static char *n_os_version = NULL;

#if defined(ARDUINO_ARCH_ARC32)
static char *n_cpu_name = (char *) "arc32";
#elif defined(ARDUINO_ARCH_AVR)
static char *n_cpu_name = (char *) "avr";
#elif defined(ARDUINO_ARCH_ESP32)
static char *n_cpu_name = (char *) "esp32";
#elif defined(ARDUINO_ARCH_ESP8266)
static char *n_cpu_name = (char *) "esp8266";
#elif defined(ARDUINO_ARCH_MEGAAVR)
static char *n_cpu_name = (char *) "megaavr";
#elif defined(ARDUINO_ARCH_NRF52840)
static char *n_cpu_name = (char *) "nrf52840";
#elif defined(ARDUINO_ARCH_NRF52)
static char *n_cpu_name = (char *) "nrf52";
#elif defined(ARDUINO_ARCH_NRF51)
static char *n_cpu_name = (char *) "nrf51";
#elif defined(ARDUINO_ARCH_PIC32)
static char *n_cpu_name = (char *) "pic32";
#elif defined(ARDUINO_ARCH_SAMD)
static char *n_cpu_name = (char *) "samd";
#elif defined(ARDUINO_ARCH_SAM)
static char *n_cpu_name = (char *) "sam";
#elif defined(ARDUINO_ARCH_SPRESENSE)
static char *n_cpu_name = (char *) "spresence";
#elif defined(ARDUINO_ARCH_STM32F0)
static char *n_cpu_name = (char *) "stm32f0";
#elif defined(ARDUINO_ARCH_STM32F1)
static char *n_cpu_name = (char *) "stm32f1";
#elif defined(ARDUINO_ARCH_STM32F4)
static char *n_cpu_name = (char *) "stm32f4";
#elif defined(ARDUINO_ARCH_STM32G0)
static char *n_cpu_name = (char *) "stm32g0";
#elif defined(ARDUINO_SWAN_R5)
static char *n_cpu_name = (char *) "swan_r5";
#elif defined(ARDUINO_ARCH_STM32L4)
static char *n_cpu_name = (char *) "stm32l4";
#elif defined(ARDUINO_ARCH_STM32U5)
static char *n_cpu_name = (char *) "stm32u5";
#elif defined(ARDUINO_ARCH_STM32)
static char *n_cpu_name = (char *) "stm32";
#else
static char *n_cpu_name = NULL;
#endif

/**************************************************************************/
/*!
    @brief  Override-able method to add more data to the user agent object
  @returns a `J` cJSON object with the user agent object.
*/
/**************************************************************************/
#if defined(_MSC_VER)
void NoteUserAgentUpdate(J *ua)
#else
__attribute__((weak)) void NoteUserAgentUpdate(J *ua)
#endif
{
    ((void)ua);	// avoid compiler warning
}

/**************************************************************************/
/*!
    @brief  Override-able method to return user agent object
  @returns a `J` cJSON object with the user agent object.
*/
/**************************************************************************/
#if defined(_MSC_VER)
J *NoteUserAgent()
#else
__attribute__((weak)) J *NoteUserAgent()
#endif
{

    J *ua = JCreateObject();
    if (ua == NULL) {
        return ua;
    }

#if defined(__cplusplus)
#define PLUS " c++"
#else
#define PLUS ""
#endif

#if defined(__ICCARM__)
    char *compiler = (char *) ("iar arm" PLUS " " NOTE_C_STRINGIZE(__VER__));
#elif defined(__IAR_SYSTEMS_ICC__)
    char *compiler = (char *) ("iar" PLUS " " NOTE_C_STRINGIZE(__VER__));
#elif defined(__clang__)
    char *compiler = (char *) ("clang" PLUS " " __VERSION__);
#elif defined(__ATOLLIC__) && defined(__GNUC__)
    char *compiler = (char *) ("atollic gcc" PLUS " " __VERSION__);
#elif defined(__GNUC__)
    char *compiler = (char *) ("gcc" PLUS " " __VERSION__);
#elif defined(_MSC_FULL_VER)
    char *compiler = (char *) ("msc" PLUS " " _MSC_FULL_VER);
#elif defined(__STDC_VERSION___)
    char *compiler = (char *) ("STDC" PLUS " " __STDC_VERSION__);
#else
    char *compiler = (char *) ("unknown" PLUS " " __VERSION__)
#endif

    JAddStringToObject(ua, "agent", n_agent);
    JAddStringToObject(ua, "compiler", compiler);
    JAddStringToObject(ua, "req_interface", _noteActiveInterface());

    // Add CPU Details
    if (n_cpu_cores != 0) {
        JAddNumberToObject(ua, "cpu_cores", n_cpu_cores);
    }
    if (n_cpu_mem != 0) {
        JAddNumberToObject(ua, "cpu_mem", n_cpu_mem);
    }
    if (n_cpu_mhz != 0) {
        JAddNumberToObject(ua, "cpu_mhz", n_cpu_mhz);
    }
    if (n_cpu_name != NULL) {
        JAddStringToObject(ua, "cpu_name", n_cpu_name);
    }
    if (n_cpu_vendor != NULL) {
        JAddStringToObject(ua, "cpu_vendor", n_cpu_vendor);
    }

    // Add Operating System Details
    if (n_os_family != NULL) {
        JAddStringToObject(ua, "os_family", n_os_family);
    }
    if (n_os_name != NULL) {
        JAddStringToObject(ua, "os_name", n_os_name);
    }
    if (n_os_platform != NULL) {
        JAddStringToObject(ua, "os_platform", n_os_platform);
    }
    if (n_os_version != NULL) {
        JAddStringToObject(ua, "os_version", n_os_version);
    }

    // Add more data to the UA from a higher level
    NoteUserAgentUpdate(ua);

    return ua;

}

/**************************************************************************/
/*!
    @brief  Set key UA fields from a higher level library context
*/
/**************************************************************************/
void NoteSetUserAgent(char *agent)
{
    n_agent = agent;
}

/**************************************************************************/
/*!
    @brief  Set key UA fields from a higher level library context
*/
/**************************************************************************/
void NoteSetUserAgentOS(char *os_name, char *os_platform, char *os_family, char *os_version)
{
    n_os_family = os_family;
    n_os_name = os_name;
    n_os_platform = os_platform;
    n_os_version = os_version;
}

/**************************************************************************/
/*!
    @brief  Set key UA fields from a higher level library context
*/
/**************************************************************************/
void NoteSetUserAgentCPU(int cpu_mem, int cpu_mhz, int cpu_cores, char *cpu_vendor, char *cpu_name)
{
    n_cpu_cores = cpu_cores;
    n_cpu_mem = cpu_mem;
    n_cpu_mhz = cpu_mhz;
    n_cpu_name = cpu_name;
    n_cpu_vendor = cpu_vendor;
}

#endif