From bdef812b7e2eb064b31d534440e0e4b8767429a7 Mon Sep 17 00:00:00 2001 From: Romain Forlot Date: Sun, 8 Apr 2018 23:59:31 +0200 Subject: Add project skeleton Change-Id: Ieae59a0c66c9a9f7500f56e33cc0a98d572c0621 Signed-off-by: Romain Forlot --- src/CMakeLists.txt | 42 ++++++++ src/harvester-apidef.json | 193 +++++++++++++++++++++++++++++++++++++ src/harvester.c | 241 ++++++++++++++++++++++++++++++++++++++++++++++ src/harvester.h | 34 +++++++ 4 files changed, 510 insertions(+) create mode 100644 src/CMakeLists.txt create mode 100644 src/harvester-apidef.json create mode 100644 src/harvester.c create mode 100644 src/harvester.h (limited to 'src') diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt new file mode 100644 index 0000000..4707070 --- /dev/null +++ b/src/CMakeLists.txt @@ -0,0 +1,42 @@ +########################################################################### +# Copyright 2015, 2016, 2017 IoT.bzh +# +# author: Fulup Ar Foll +# contrib: Romain Forlot +# +# 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. +########################################################################### + +# Add target to project dependency list +PROJECT_TARGET_ADD(harvester) + + # Define project Targets + add_library(${TARGET_NAME} MODULE + ${TARGET_NAME}.c + ) + + set(OPENAPI_DEF "harvester-apidef" CACHE STRING "name and path to the JSON API definition without extension") + + # Binder exposes a unique public entry point + SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES + PREFIX "afb-" + LABELS "BINDINGV2" + LINK_FLAGS ${BINDINGS_LINK_FLAG} + OUTPUT_NAME ${TARGET_NAME} + ) + + # Library dependencies (include updates automatically) + TARGET_LINK_LIBRARIES(${TARGET_NAME} + afb-helpers + ${link_libraries}) + diff --git a/src/harvester-apidef.json b/src/harvester-apidef.json new file mode 100644 index 0000000..3ae3dee --- /dev/null +++ b/src/harvester-apidef.json @@ -0,0 +1,193 @@ +{ + "openapi": "3.0.0", + "$schema": "http://iot.bzh/download/openapi/schema-3.0/default-schema.json", + "info": { + "description": "", + "title": "harvester", + "version": "4.0", + "x-binding-c-generator": { + "api": "harvester", + "version": 2, + "prefix": "", + "postfix": "", + "start": null , + "onevent": null, + "init": "init", + "scope": "", + "private": false + } + }, + "servers": [ + { + "url": "ws://{host}:{port}/api/monitor", + "description": "TS caching binding", + "variables": { + "host": { + "default": "localhost" + }, + "port": { + "default": "1234" + } + }, + "x-afb-events": [ + { + "$ref": "#/components/schemas/afb-event" + } + ] + } + ], + "components": { + "schemas": { + "afb-reply": { + "$ref": "#/components/schemas/afb-reply-v2" + }, + "afb-event": { + "$ref": "#/components/schemas/afb-event-v2" + }, + "afb-reply-v2": { + "title": "Generic response.", + "type": "object", + "required": [ "jtype", "request" ], + "properties": { + "jtype": { + "type": "string", + "const": "afb-reply" + }, + "request": { + "type": "object", + "required": [ "status" ], + "properties": { + "status": { "type": "string" }, + "info": { "type": "string" }, + "token": { "type": "string" }, + "uuid": { "type": "string" }, + "reqid": { "type": "string" } + } + }, + "response": { "type": "object" } + } + }, + "afb-event-v2": { + "type": "object", + "required": [ "jtype", "event" ], + "properties": { + "jtype": { + "type": "string", + "const": "afb-event" + }, + "event": { "type": "string" }, + "data": { "type": "object" } + } + } + }, + "x-permissions": { + "monitor": { + "permission": "urn:AGL:permission:low-can:public:monitor" + }, + "write": { + "permission": "urn:AGL:permission::platform:can:write " + } + }, + "responses": { + "200": { + "description": "A complex object array response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/afb-reply" + } + } + } + } + } + }, + "paths": { + "/auth": { + "description": "Authenticate session to raise Level Of Assurance of the session", + "get": { + "x-permissions": { + "$ref": "#/components/x-permissions/write" + }, + "responses": { + "200": {"$ref": "#/components/responses/200"} + } + } + }, + "/write": { + "description": "Write a metric to local TSDB and Cloud service if available", + "get": { + "x-permissions": { + "LOA": 1 + }, + "parameters": [ + { + "in": "query", + "name": "host", + "required": false, + "schema": { "type": "string" } + }, + { + "in": "query", + "name": "port", + "required": false, + "schema": { "type": "integer" } + }, + { + "in": "query", + "name": "metric", + "required": true, + "schema": { "type": "object" }, + "parameters" : [ + { + "in": "query", + "name": "name", + "required": true, + "schema": { "type": "string" } + }, + { + "in": "query", + "name": "source", + "required": false, + "schema": { "type": "string" } + }, + { + "in": "query", + "name": "unit", + "required": false, + "schema": { "type": "string" } + }, + { + "in": "query", + "name": "identity", + "required": false, + "schema": { "type": "string" } + }, + { + "in": "query", + "name": "value", + "required": true, + "schema": { + "oneOf": [ + {"type": "boolean"}, + {"type": "integer"}, + {"type": "double"}, + {"type": "string"} + ] + } + }, + { + "in": "query", + "name": "timestamp", + "required": true, + "schema": { "type": "double" } + } + ] + } + ], + "responses": { + "200": {"$ref": "#/components/responses/200"} + } + } + } + } +} diff --git a/src/harvester.c b/src/harvester.c new file mode 100644 index 0000000..2120676 --- /dev/null +++ b/src/harvester.c @@ -0,0 +1,241 @@ +/* + * Copyright (C) 2015, 2016 "IoT.bzh" + * Author "Romain Forlot" + * + * 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. + */ + +#define _GNU_SOURCE +#include "harvester.h" +#include "harvester-apidef.h" +#include +#include + +#include "curl-wrap.h" +#include "wrap-json.h" + +#define DEFAULT_DB "agl-collector" +#define DEFAULT_DBHOST "localhost" +#define DEFAULT_DBPORT "8086" +#define URL_MAXIMUM_LENGTH 2047 + +int dbping() +{ + int ret = 0; + char *result; + size_t result_size; + CURL *request = curl_wrap_prepare_get("localhost:"DEFAULT_DBPORT"/ping",NULL, NULL); + curl_wrap_perform(request, &result, &result_size); + + if(curl_wrap_response_code_get(request) != 204) { + AFB_ERROR("TimeSeries DB not reachable"); + ret = -1; + } + + curl_easy_cleanup(request); + return ret; +} + +int create_database() +{ + int ret = 0; + char *result; + size_t result_size; + + // Declare query to be posted + const char **post_data; + post_data = malloc(sizeof(*post_data)); + post_data[0] = "q=CREATE DATABASE \""DEFAULT_DB"\""; + post_data[1] = NULL; + + CURL *request = curl_wrap_prepare_post("localhost:"DEFAULT_DBPORT"/query",NULL, 1, post_data); + curl_wrap_perform(request, &result, &result_size); + + if(curl_wrap_response_code_get(request) != 200) { + AFB_ERROR("Can't create database."); + ret = -1; + } + + curl_easy_cleanup(request); + free(post_data); + + if(ret == 0) + AFB_NOTICE("Database 'agl-collector' created"); + + return ret; +} + +void curl_cb(void *closure, int status, CURL *curl, const char *result, size_t size) +{ + struct afb_req *req = (struct afb_req*)closure; + long rep_code = curl_wrap_response_code_get(curl); + switch(rep_code) { + case 204: + AFB_DEBUG("Request correctly written"); + afb_req_success(*req, NULL, "Request has been successfully writen"); + break; + case 400: + afb_req_fail(*req, "Bad request", result); + break; + case 401: + afb_req_fail(*req, "Unauthorized access", result); + break; + case 404: + afb_req_fail(*req, "Not found", result); + AFB_NOTICE("Attempt to create the DB '"DEFAULT_DB"'"); + create_database(); + break; + case 500: + afb_req_fail_f(*req, "Timeout", "Overloaded server: %s", result); + break; + default: + afb_req_fail(*req, "Failure", "Unexpected behavior."); + break; + } +} + +int unpack_metric(json_object *m, const char **name, const char **source, const char **unit, const char **identity, json_object **jv, uint64_t *timestamp) +{ + if (wrap_json_unpack(m, "{ss,s?s,s?s,s?s,so,sI!}", + "name", name, + "source", source, + "unit", unit, + "identity", identity, + "value", jv, + "timestamp", timestamp)) + return -1; + else if (!json_object_is_type(*jv, json_type_boolean) && + !json_object_is_type(*jv, json_type_double) && + !json_object_is_type(*jv, json_type_int) && + !json_object_is_type(*jv, json_type_string)) + return -1; + + return 0; +} + +void concatenate(char* dest, const char* source, const char *sep) +{ + strncat(dest, sep, strlen(sep)); + strncat(dest, source, strlen(source)); +} + +char *make_query(char *query, const char *name, const char *source, const char *unit, const char *identity, json_object *jv, uint64_t timestamp) +{ + char *ts; + memset(query, 0, URL_MAXIMUM_LENGTH); + + strncat(query, name, strlen(name)); + if (source) { + concatenate(query, source, ","); + } + if (unit) { + concatenate(query, unit, ","); + } + if (identity) { + concatenate(query, identity, ","); + } + + concatenate(query, "value", " "); + concatenate(query, json_object_to_json_string(jv), "="); + asprintf(&ts, "%lu", timestamp); + concatenate(query, ts, " "); + + return query; +} + +CURL *make_curl_write_post(const char *url, struct json_object *metric) +{ + CURL *curl; + const char *name = NULL, + *source = NULL, + *unit = NULL, + *identity = NULL, + **post_data; + char query[URL_MAXIMUM_LENGTH]; + memset(query, 0, URL_MAXIMUM_LENGTH); + + post_data = malloc(sizeof(*post_data)); + + json_object *jv = NULL; + uint64_t timestamp = 0; + + if(unpack_metric(metric, &name, &source, &unit, &identity, &jv, ×tamp)) { + AFB_ERROR("ERROR UNPACKING metric. %s", json_object_to_json_string(metric)); + curl = NULL; + } + else { + make_query(query, name, source, unit, identity, jv, timestamp); + post_data[0] = query; + post_data[1] = NULL; + curl = curl_wrap_prepare_post(url, NULL, 1, post_data); + } + + free(post_data); + return curl; +} + +int do_write(struct afb_req req, const char* host, int port, json_object *metric) +{ + CURL *curl_request; + char url[URL_MAXIMUM_LENGTH]; // Safe limit for most popular web browser + memset(url, 0, sizeof(url)); + + // Handle default host and port + host = host ? host : DEFAULT_DBHOST; + port = port > 0 ? port : atoi(DEFAULT_DBPORT); + + strncat(url, host, strlen(host)); + strncat(url, ":"DEFAULT_DBPORT"/write?db="DEFAULT_DB, strlen(":"DEFAULT_DBPORT"/write?db="DEFAULT_DB)); + curl_request = make_curl_write_post(url, metric); + curl_wrap_do(curl_request, curl_cb, &req); + + return 0; +} + +void write(struct afb_req req) +{ + int port = -1; + const char *host = NULL; + + json_object *req_args = afb_req_json(req), + *metric = NULL; + + if(wrap_json_unpack(req_args, "{s?s,s?i,so!}", + "host", &host, + "port", &port, + "metric", &metric) || ! metric) + afb_req_fail(req, "Failed", "Error processing arguments. Miss metric\ + JSON object or malformed"); + else if(do_write(req, host, port, metric)) + afb_req_fail(req, "Failed", "Error processing metric JSON object.\ + Malformed !"); +} + +void auth(struct afb_req request) +{ + afb_req_session_set_LOA(request, 1); + afb_req_success(request, NULL, NULL); +} + +int init() +{ + int err = 0; + err = curl_global_init(CURL_GLOBAL_DEFAULT); + if (!err) + err = dbping(); + else { + AFB_ERROR("Something went wrong initiliazing libcurl. Abort"); + } + + return err; +} diff --git a/src/harvester.h b/src/harvester.h new file mode 100644 index 0000000..e67145c --- /dev/null +++ b/src/harvester.h @@ -0,0 +1,34 @@ +/* + * Copyright (C) 2015, 2016 "IoT.bzh" + * Author "Romain Forlot" + * + * 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. + */ + +#define AFB_BINDING_VERSION 2 +#include + +union port { + int i_port; + char c_port[5]; // Available ports 1-65535 +}; + +union metric_value { + enum metric_type {b = 0, i, d, str} type; + int b_value; + int i_value; + double d_value; + char *str_value; +}; + +int init(); -- cgit 1.2.3-korg