Support for different core contexts via CLI parameter -coreContext <v…

…1.0|v1.3|v1.4|v1.5|v1.6|v1.7> (v1.6 is default)

CHANGES_NEXT_RELEASE

@@ -1,2 +1,3 @@
 Fixed issues:
 #280  Protection for POST /temporal/entities against usage when troe is not enabled
+#280  Support for different core contexts via CLI parameter -coreContext <v1.0|v1.3|v1.4|v1.5|v1.6|v1.7> (v1.6 is default)

src/app/orionld/orionld.cpp

@@ -121,6 +121,7 @@ extern "C"
 #include "orionld/prometheus/promInit.h"                      // promInit
 #include "orionld/mongoc/mongocInit.h"                        // mongocInit
 #include "orionld/mongoc/mongocServerVersionGet.h"            // mongocServerVersionGet
+#include "orionld/context/orionldCoreContext.h"               // ORIONLD_CORE_CONTEXT_URL_*
 #include "orionld/context/orionldContextFromUrl.h"            // contextDownloadListInit, contextDownloadListRelease
 #include "orionld/contextCache/orionldContextCacheRelease.h"  // orionldContextCacheRelease
 #include "orionld/rest/orionldServiceInit.h"                  // orionldServiceInit
@@ -252,6 +253,7 @@ bool            experimental = false;
 bool            mongocOnly   = false;
 bool            debugCurl    = false;
 int             cSubCounters;
+char            coreContextVersion[64];
 
 
 
@@ -338,6 +340,7 @@ int             cSubCounters;
 #define DBURI_DESC             "complete URI for database connection"
 #define DEBUG_CURL_DESC        "turn on debugging of libcurl - to the broker's logfile"
 #define CSUBCOUNTERS_DESC      "number of subscription counter updates before flush from sub-cache to DB (0: never, 1: always)"
+#define CORE_CONTEXT_DESC      "Core context version (v1.0|v1.3|v1.4|v1.5|v1.6|v1.7) - v1.6 is default"
 
 
 
@@ -360,6 +363,8 @@ int             cSubCounters;
 */
 PaArgument paArgs[] =
 {
+  { "-coreContext",           coreContextVersion,       "CORE_CONTEXT",              PaString,  PaOpt,  _i ORIONLD_CORE_CONTEXT_URL_DEFAULT, PaNL, PaNL, CORE_CONTEXT_DESC },
+
   { "-noswap",                &noswap,                  "NOSWAP",                    PaBool,    PaHid,  false,           false,  true,             NOSWAP_DESC              },
   { "-fg",                    &fg,                      "FOREGROUND",                PaBool,    PaOpt,  false,           false,  true,             FG_DESC                  },
   { "-localIp",               bindAddress,              "LOCALIP",                   PaString,  PaOpt,  IP_ALL,          PaNL,   PaNL,             LOCALIP_DESC             },
@@ -783,6 +788,7 @@ static void versionInfo(void)
   LM_K(("-----------------------------------------"));
   LM_K(("orionld version:    %s", orionldVersion));
   LM_K(("based on orion:     %s", ORION_VERSION));
+  LM_K(("core @context:      %s", coreContextUrl));
   LM_K(("git hash:           %s", GIT_HASH));
   LM_K(("build branch:       %s", ORIONLD_BRANCH));
   LM_K(("compiled by:        %s", COMPILED_BY));
@@ -883,6 +889,24 @@ void regCachePresent(void)
 
 
 
+// -----------------------------------------------------------------------------
+//
+// coreContextUrlSetup -
+//
+static char* coreContextUrlSetup(const char* version)
+{
+  if      (strcmp(version, "v1.0") == 0)    return ORIONLD_CORE_CONTEXT_URL_V1_0;
+  else if (strcmp(version, "v1.3") == 0)    return ORIONLD_CORE_CONTEXT_URL_V1_3;
+  else if (strcmp(version, "v1.4") == 0)    return ORIONLD_CORE_CONTEXT_URL_V1_4;
+  else if (strcmp(version, "v1.5") == 0)    return ORIONLD_CORE_CONTEXT_URL_V1_5;
+  else if (strcmp(version, "v1.6") == 0)    return ORIONLD_CORE_CONTEXT_URL_V1_6;
+  else if (strcmp(version, "v1.7") == 0)    return ORIONLD_CORE_CONTEXT_URL_V1_7;
+
+  return NULL;
+}
+
+
+
 #define LOG_FILE_LINE_FORMAT "time=DATE | lvl=TYPE | corr=CORR_ID | trans=TRANS_ID | from=FROM_IP | srv=SERVICE | subsrv=SUB_SERVICE | comp=Orion | op=FILE[LINE]:FUNC | msg=TEXT"
 /* ****************************************************************************
 *
@@ -1009,6 +1033,11 @@ int main(int argC, char* argV[])
     strncpy(paLogLevel, "DEBUG", sizeof(paLogLevel) - 1);
 
   paParse(paArgs, argC, (char**) argV, 1, false);
+
+  coreContextUrl = coreContextUrlSetup(coreContextVersion);
+  if (coreContextUrl == NULL)
+    LM_X(1, ("Invalid version for the Core Context: %s (valid: v1.0|v1.3|v1.4|v1.5|v1.6|v1.7)", coreContextVersion));
+
   lmTimeFormat(0, (char*) "%Y-%m-%dT%H:%M:%S");
 
 #if 0
@@ -1078,7 +1107,6 @@ int main(int argC, char* argV[])
   }
 
   notificationModeParse(notificationMode, &notificationQueueSize, &notificationThreadNum);
-
   LM_I(("Orion Context Broker is running"));
 
   versionInfo();

src/lib/logMsg/traceLevels.h

@@ -87,6 +87,7 @@ typedef enum TraceLevels
   LmtContexts = 80,                    // Contexts
   LmtContextTree,                      // Context Tree
   LmtContextCache,                     // Context Cache
+  LmtCoreContext,                      // Core Context
 
   // GeoJSON
   LmtGeoJSON = 90,                     // GeoJSON ... everything (for now)

src/lib/orionld/common/orionldState.cpp

@@ -94,7 +94,7 @@ Kjson             kjson;
 Kjson*            kjsonP;
 uint16_t          portNo                   = 0;
 int               dbNameLen;
-char*             coreContextUrl           = (char*) ORIONLD_CORE_CONTEXT_URL_V1_0;
+char*             coreContextUrl           = (char*) ORIONLD_CORE_CONTEXT_URL_DEFAULT;  // v1.6, see orionld/context/orionldCoreContext.h
 char              orionldHostName[128];
 int               orionldHostNameLen       = -1;
 OrionldGeoIndex*  geoIndexList             = NULL;

src/lib/orionld/context/orionldContextFromBuffer.cpp

@@ -71,6 +71,7 @@ OrionldContext* orionldContextFromBuffer(char* url, OrionldContextOrigin origin,
     return NULL;
   }
 
+  LM_T(LmtCoreContext, ("Parsed the context buffer into a KjNode tree and looked up the @context member"));
   OrionldContext* contextP = orionldContextFromTree(url, origin, id, contextNodeP);
   return contextP;
 }

src/lib/orionld/context/orionldContextFromTree.cpp

@@ -47,31 +47,6 @@ extern "C"
 
 
 
-// -----------------------------------------------------------------------------
-//
-// willBeSimplified -
-//
-bool willBeSimplified(KjNode* contextTreeP, int* itemsInArrayP)
-{
-  int  itemsInArray  = 0;
-  int  itemsToRemove = 0;
-
-  for (KjNode* itemP = contextTreeP->value.firstChildP; itemP != NULL; itemP = itemP->next)
-  {
-    ++itemsInArray;
-    if ((itemP->type == KjString) && (strcmp(itemP->value.s, coreContextUrl) == 0))
-      ++itemsToRemove;
-  }
-
-  if (itemsInArray - itemsToRemove > 1)  // More than one item in array - must stay array
-    return false;
-
-  *itemsInArrayP = itemsInArray;
-  return true;
-}
-
-
-
 // -----------------------------------------------------------------------------
 //
 // orionldContextFromTree -

src/lib/orionld/context/orionldContextFromUrl.cpp

@@ -38,6 +38,11 @@
 #include "orionld/context/orionldContextFromUrl.h"               // Own interface
 
 
+
+// -----------------------------------------------------------------------------
+//
+// StringListItem -
+//
 typedef struct StringListItem
 {
   char                    name[256];
@@ -250,6 +255,7 @@ OrionldContext* orionldContextFromUrl(char* url, char* id)
   if (buffer == NULL)
     return NULL;
 
+  LM_T(LmtCoreContext, ("Downloaded the conext '%s'", url));
   contextP = orionldContextFromBuffer(url, OrionldContextDownloaded, id, buffer);
   if (contextP == NULL)
   {

src/lib/orionld/context/orionldContextItemExpand.cpp

@@ -65,7 +65,7 @@ char* orionldContextItemExpand
   OrionldContextItem**  contextItemPP
 )
 {
-  OrionldContextItem*  contextItemP;
+  OrionldContextItem*  contextItemP = NULL;
   char*                colonP;
 
   if (contextP == NULL)
@@ -75,7 +75,8 @@ char* orionldContextItemExpand
     return orionldContextPrefixExpand(contextP, shortName, colonP);
 
   // 1. Lookup in Core Context
-  contextItemP = orionldContextItemLookup(orionldCoreContextP, shortName, NULL);
+  if (orionldCoreContextP != NULL)
+    contextItemP = orionldContextItemLookup(orionldCoreContextP, shortName, NULL);
 
   // 2. Lookup in given context (unless it's the Core Context)
   if ((contextItemP == NULL) && (contextP != orionldCoreContextP))

src/lib/orionld/context/orionldContextSimplify.cpp

@@ -33,6 +33,7 @@ extern "C"
 
 #include "orionld/context/OrionldContext.h"                      // OrionldContext
 #include "orionld/common/orionldState.h"                         // coreContextUrl
+#include "orionld/context/orionldCoreContext.h"                  // ORIONLD_CORE_CONTEXT_URL_V1_BASE
 #include "orionld/context/orionldContextSimplify.h"              // Own interface
 
 
@@ -58,7 +59,7 @@ KjNode* orionldContextSimplify(KjNode* contextTreeP, int* itemsInArrayP)
   {
     KjNode* next = nodeP->next;
 
-    if ((nodeP->type == KjString) && (strcmp(nodeP->value.s, coreContextUrl) == 0))
+    if ((nodeP->type == KjString) && (strncmp(nodeP->value.s, ORIONLD_CORE_CONTEXT_URL_V1_BASE, 52) == 0))
       kjChildRemove(contextTreeP, nodeP);
     else
       ++itemsInArray;

src/lib/orionld/context/orionldCoreContext.cpp

@@ -55,7 +55,8 @@ int orionldDefaultUrlLen;
 //
 // builtinCoreContext
 //
-const char* builtinCoreContext = "{ \"@context\": {"
+const char* builtinCoreContextUrl = ORIONLD_CORE_CONTEXT_URL_V1_0;
+const char* builtinCoreContext    = "{ \"@context\": {"
   "\"ngsi-ld\": \"https://uri.etsi.org/ngsi-ld/\","
   "\"id\": \"@id\","
   "\"type\": \"@type\","

src/lib/orionld/context/orionldCoreContext.h

@@ -38,7 +38,14 @@ extern "C"
 //
 // ORIONLD_CORE_CONTEXT_URL -
 //
-#define ORIONLD_CORE_CONTEXT_URL_V1_0  (char*) "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld"
+#define ORIONLD_CORE_CONTEXT_URL_V1_BASE    (char*) "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context"
+#define ORIONLD_CORE_CONTEXT_URL_V1_0       (char*) "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld"
+#define ORIONLD_CORE_CONTEXT_URL_V1_3       (char*) "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context-v1.3.jsonld"
+#define ORIONLD_CORE_CONTEXT_URL_V1_4       (char*) "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context-v1.4.jsonld"
+#define ORIONLD_CORE_CONTEXT_URL_V1_5       (char*) "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context-v1.5.jsonld"
+#define ORIONLD_CORE_CONTEXT_URL_V1_6       (char*) "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context-v1.6.jsonld"
+#define ORIONLD_CORE_CONTEXT_URL_V1_7       (char*) "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context-v1.7.jsonld"
+#define ORIONLD_CORE_CONTEXT_URL_DEFAULT    (char*) "v1.6"
 
 
 
@@ -64,4 +71,14 @@ extern char* orionldDefaultUrl;
 //
 extern int orionldDefaultUrlLen;
 
+
+
+// -----------------------------------------------------------------------------
+//
+// builtinCoreContext -
+//
+extern const char* builtinCoreContextUrl;
+extern const char* builtinCoreContext;
+
+
 #endif  // SRC_LIB_ORIONLD_CONTEXT_ORIONLDCORECONTEXT_H_

src/lib/orionld/contextCache/orionldContextCacheInit.cpp

@@ -36,7 +36,7 @@ extern "C"
 
 #include "orionld/common/orionldState.h"                         // dbHost, coreContextUrl, builtinCoreContext
 #include "orionld/mongoc/mongocContextCacheGet.h"                // mongocContextCacheGet
-#include "orionld/context/orionldCoreContext.h"                  // orionldCoreContextP
+#include "orionld/context/orionldCoreContext.h"                  // orionldCoreContextP, builtinCoreContextUrl, builtinCoreContext
 #include "orionld/context/orionldContextFromUrl.h"               // orionldContextFromUrl
 #include "orionld/context/orionldContextFromTree.h"              // orionldContextFromTree
 #include "orionld/context/orionldContextFromBuffer.h"            // orionldContextFromBuffer
@@ -120,6 +120,7 @@ void orionldContextCacheInit(void)
   //
 
   // 1. Find the Core Context
+  LM_T(LmtCoreContext, ("Trying to find the core context (%s)", coreContextUrl));
   if (contextArray != NULL)
   {
     KjNode* contextNodeP = contextArray->value.firstChildP;
@@ -151,9 +152,10 @@ void orionldContextCacheInit(void)
     }
   }
 
-  // Still no core context? - download it
+  // Still no core context? - try to download it
   if (orionldCoreContextP == NULL)
   {
+    LM_T(LmtCoreContext, ("Still no core context - trying to download it (%s)", coreContextUrl));
     orionldCoreContextP = orionldContextFromUrl(coreContextUrl, NULL);
     if (orionldCoreContextP == NULL)
       LM_W(("Unable to download the core context (%s: %s)", orionldState.pd.title, orionldState.pd.detail));
@@ -162,7 +164,7 @@ void orionldContextCacheInit(void)
   // Still no core context? - use the default core context, meant for airgapped setups
   if (orionldCoreContextP == NULL)
   {
-    LM_T(LmtContextCache, ("No network?  Getting the core context from builtin"));
+    LM_T(LmtCoreContext, ("Still no core context - no network?  Getting the core context from builtin"));
 
     //
     // The builtin core context is a string in a read-only segment.
@@ -175,13 +177,13 @@ void orionldContextCacheInit(void)
       LM_X(1, ("Out of memory trying to allocate %d bytes for the built-in Core Context"));
 
     memcpy(buf, builtinCoreContext, bufLen + 1);
-    orionldCoreContextP = orionldContextFromBuffer(coreContextUrl, OrionldContextBuiltinCoreContext, coreContextUrl, buf);
+    orionldCoreContextP = orionldContextFromBuffer(coreContextUrl, OrionldContextBuiltinCoreContext, (char*) builtinCoreContextUrl, buf);
     free(buf);
     LM_T(LmtContextCache, ("Core Context at %p", orionldCoreContextP));
     if (orionldCoreContextP == NULL)
       LM_X(1, ("Unable to create the core context from in-compiled default core context (%s: %s)", orionldState.pd.title, orionldState.pd.detail));
+    LM_W(("Falling back to Built-in Core Context (hard-coded copy of %s)", builtinCoreContextUrl));
   }
-  LM_T(LmtContextCache, ("Core Context at %p", orionldCoreContextP));
 
   if (contextArray == NULL)
     return;

src/lib/orionld/dbModel/dbModelFromApiSubscription.cpp

@@ -34,7 +34,7 @@ extern "C"
 
 #include "orionld/common/orionldState.h"                       // orionldState
 #include "orionld/common/orionldError.h"                       // orionldError
-#include "orionld/context/orionldCoreContext.h"                // ORIONLD_CORE_CONTEXT_URL_V1_0
+#include "orionld/context/orionldCoreContext.h"                // orionldCoreContextP
 #include "orionld/context/orionldContextSimplify.h"            // orionldContextSimplify
 #include "orionld/dbModel/dbModelFromApiKeyValues.h"           // dbModelFromApiKeyValues
 #include "orionld/dbModel/dbModelFromApiCoordinates.h"         // dbModelFromApiCoordinates
@@ -514,7 +514,7 @@ bool dbModelFromApiSubscription(KjNode* apiSubscriptionP, bool patch)
       // For now, I'll just overwrite the context with the Core Context
       //
       orionldState.payloadContextNode->type    = KjString;
-      orionldState.payloadContextNode->value.s = (char*) ORIONLD_CORE_CONTEXT_URL_V1_0;
+      orionldState.payloadContextNode->value.s = orionldCoreContextP->url;
       LM_W(("Warning - the context is not a string - changing it for the Core Context (API Spec v1.6)"));
     }
 

src/lib/orionld/forwarding/distOpSend.cpp

@@ -680,7 +680,7 @@ bool distOpSend(DistOp* distOpP, const char* dateHeader, const char* xForwardedF
         kjChildRemove(distOpP->requestBody, contextP);
 
       if (distOpP->regP->contextP == NULL)
-        contextP = kjString(orionldState.kjsonP, "@context", ORIONLD_CORE_CONTEXT_URL_V1_0);
+        contextP = kjString(orionldState.kjsonP, "@context", orionldCoreContextP->url);
       else
         contextP = kjString(orionldState.kjsonP, "@context", distOpP->regP->contextP->url);
 

src/lib/orionld/notifications/notificationSend.cpp

@@ -763,7 +763,7 @@ int notificationSend(OrionldAlterationMatch* mAltP, double timestamp, CURL** cur
   if ((addLinkHeader == true) && (ngsiv2 == false))  // Add Link header - but not if NGSIv2 Cross Notification
   {
     char         linkHeader[512];
-    const char*  link = (mAltP->subP->ldContext == "")? ORIONLD_CORE_CONTEXT_URL_V1_0 : mAltP->subP->ldContext.c_str();
+    const char*  link = (mAltP->subP->ldContext == "")? orionldCoreContextP->url : mAltP->subP->ldContext.c_str();
 
     snprintf(linkHeader, sizeof(linkHeader), "Link: <%s>; rel=\"http://www.w3.org/ns/json-ld#context\"; type=\"application/ld+json\"\r\n", link);
 

test/functionalTest/cases/0000_cli/bool_option_with_value.test

@@ -46,6 +46,7 @@ Usage: orionld  [option '-U' (extended usage)]
                 [option '-logLevel' <initial log level (NONE, FATAL, ERROR, WARN, INFO, DEBUG)>]
                 [option '-logAppend' (append to log-file)]
 
+                [option '-coreContext' <Core context version (v1.0|v1.3|v1.4|v1.5|v1.6|v1.7) - v1.6 is default>]
                 [option '-fg' (don't start as daemon)]
                 [option '-localIp' <IP to receive new connections>]
                 [option '-port' <port to receive new connections>]

test/functionalTest/cases/0000_cli/command_line_options.test

@@ -35,6 +35,7 @@ Usage: orionld  [option '-U' (extended usage)]
                 [option '-logLevel' <initial log level (NONE, FATAL, ERROR, WARN, INFO, DEBUG)>]
                 [option '-logAppend' (append to log-file)]
 
+                [option '-coreContext' <Core context version (v1.0|v1.3|v1.4|v1.5|v1.6|v1.7) - v1.6 is default>]
                 [option '-fg' (don't start as daemon)]
                 [option '-localIp' <IP to receive new connections>]
                 [option '-port' <port to receive new connections>]

test/functionalTest/cases/0000_ngsild/ngsild_GET_with_keyValues.test

@@ -106,7 +106,7 @@ HTTP/1.1 200 OK
 Content-Length: 186
 Content-Type: application/json
 Date: REGEX(.*)
-Link: <https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld>; rel="http://www.w3.org/ns/json-ld#context"; type="application/ld+json"
+Link: <https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-contextREGEX(.*)
 
 {
   "id": "urn:ngsi-ld:T:2018-11-22T10:00:00",
@@ -133,7 +133,7 @@ HTTP/1.1 200 OK
 Content-Length: 114
 Content-Type: application/json
 Date: REGEX(.*)
-Link: <https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld>; rel="http://www.w3.org/ns/json-ld#context"; type="application/ld+json"
+Link: <https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-contextREGEX(.*)
 
 {
   "id": "urn:ngsi-ld:T:2018-11-22T10:00:00",
@@ -153,7 +153,7 @@ HTTP/1.1 200 OK
 Content-Length: 222
 Content-Type: application/json
 Date: REGEX(.*)
-Link: <https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld>; rel="http://www.w3.org/ns/json-ld#context"; type="application/ld+json"
+Link: <https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-contextREGEX(.*)
 
 [
   {

test/functionalTest/cases/0000_ngsild/ngsild_GET_with_sysAttrs.test

@@ -90,7 +90,7 @@ HTTP/1.1 200 OK
 Content-Length: 295
 Content-Type: application/json
 Date: REGEX(.*)
-Link: <https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld>; rel="http://www.w3.org/ns/json-ld#context"; type="application/ld+json"
+Link: <https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-contextREGEX(.*)
 
 {
   "id": "urn:ngsi-ld:T:2018-11-22T10:00:00",
@@ -113,7 +113,7 @@ HTTP/1.1 200 OK
 Content-Length: 295
 Content-Type: application/json
 Date: REGEX(.*)
-Link: <https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld>; rel="http://www.w3.org/ns/json-ld#context"; type="application/ld+json"
+Link: <https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-contextREGEX(.*)
 
 {
   "id": "urn:ngsi-ld:T:2018-11-22T10:00:00",