Chg: update image tag in helm values to v2.9.0-RC2

https://telecominfraproject.atlassian.net/browse/WIFI-12342

.clang-format

@@ -0,0 +1,178 @@
+---
+Language:        Cpp
+# BasedOnStyle:  LLVM
+AccessModifierOffset: -2
+AlignAfterOpenBracket: Align
+AlignArrayOfStructures: None
+AlignConsecutiveMacros: None
+AlignConsecutiveAssignments: None
+AlignConsecutiveBitFields: None
+AlignConsecutiveDeclarations: None
+AlignEscapedNewlines: Right
+AlignOperands:   Align
+AlignTrailingComments: true
+AllowAllArgumentsOnNextLine: true
+AllowAllConstructorInitializersOnNextLine: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortEnumsOnASingleLine: true
+AllowShortBlocksOnASingleLine: Never
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: All
+AllowShortLambdasOnASingleLine: All
+AllowShortIfStatementsOnASingleLine: Never
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: MultiLine
+AttributeMacros:
+  - __capability
+BinPackArguments: true
+BinPackParameters: true
+BraceWrapping:
+  AfterCaseLabel:  false
+  AfterClass:      false
+  AfterControlStatement: Never
+  AfterEnum:       false
+  AfterFunction:   false
+  AfterNamespace:  false
+  AfterObjCDeclaration: false
+  AfterStruct:     false
+  AfterUnion:      false
+  AfterExternBlock: false
+  BeforeCatch:     false
+  BeforeElse:      false
+  BeforeLambdaBody: false
+  BeforeWhile:     false
+  IndentBraces:    false
+  SplitEmptyFunction: true
+  SplitEmptyRecord: true
+  SplitEmptyNamespace: true
+BreakBeforeBinaryOperators: None
+BreakBeforeConceptDeclarations: true
+BreakBeforeBraces: Attach
+BreakBeforeInheritanceComma: false
+BreakInheritanceList: BeforeColon
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializersBeforeComma: false
+BreakConstructorInitializers: BeforeColon
+BreakAfterJavaFieldAnnotations: false
+BreakStringLiterals: true
+ColumnLimit:     100
+CommentPragmas:  '^ IWYU pragma:'
+CompactNamespaces: false
+ConstructorInitializerAllOnOneLineOrOnePerLine: false
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DeriveLineEnding: true
+DerivePointerAlignment: false
+DisableFormat:   false
+EmptyLineAfterAccessModifier: Never
+EmptyLineBeforeAccessModifier: LogicalBlock
+ExperimentalAutoDetectBinPacking: false
+FixNamespaceComments: true
+ForEachMacros:
+  - foreach
+  - Q_FOREACH
+  - BOOST_FOREACH
+IfMacros:
+  - KJ_IF_MAYBE
+IncludeBlocks:   Preserve
+IncludeCategories:
+  - Regex:           '^"(llvm|llvm-c|clang|clang-c)/'
+    Priority:        2
+    SortPriority:    0
+    CaseSensitive:   false
+  - Regex:           '^(<|"(gtest|gmock|isl|json)/)'
+    Priority:        3
+    SortPriority:    0
+    CaseSensitive:   false
+  - Regex:           '.*'
+    Priority:        1
+    SortPriority:    0
+    CaseSensitive:   false
+IncludeIsMainRegex: '(Test)?$'
+IncludeIsMainSourceRegex: ''
+IndentAccessModifiers: false
+IndentCaseLabels: false
+IndentCaseBlocks: false
+IndentGotoLabels: true
+IndentPPDirectives: None
+IndentExternBlock: AfterExternBlock
+IndentRequires:  false
+IndentWidth:     4
+IndentWrappedFunctionNames: false
+InsertTrailingCommas: None
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLinesAtTheStartOfBlocks: true
+LambdaBodyIndentation: Signature
+MacroBlockBegin: ''
+MacroBlockEnd:   ''
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: All
+ObjCBinPackProtocolList: Auto
+ObjCBlockIndentWidth: 2
+ObjCBreakBeforeNestedBlockParam: true
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: true
+PenaltyBreakAssignment: 2
+PenaltyBreakBeforeFirstCallParameter: 19
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakString: 1000
+PenaltyBreakTemplateDeclaration: 10
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 60
+PenaltyIndentedWhitespace: 0
+PointerAlignment: Right
+PPIndentWidth:   -1
+ReferenceAlignment: Pointer
+ReflowComments:  true
+ShortNamespaceLines: 1
+SortIncludes:    CaseSensitive
+SortJavaStaticImport: Before
+SortUsingDeclarations: true
+SpaceAfterCStyleCast: false
+SpaceAfterLogicalNot: false
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCaseColon: false
+SpaceBeforeCpp11BracedList: false
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
+SpaceBeforeParens: ControlStatements
+SpaceAroundPointerQualifiers: Default
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceInEmptyBlock: false
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles:  Never
+SpacesInConditionalStatement: false
+SpacesInContainerLiterals: true
+SpacesInCStyleCastParentheses: false
+SpacesInLineCommentPrefix:
+  Minimum:         1
+  Maximum:         -1
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+SpaceBeforeSquareBrackets: false
+BitFieldColonSpacing: Both
+Standard:        Latest
+StatementAttributeLikeMacros:
+  - Q_EMIT
+StatementMacros:
+  - Q_UNUSED
+  - QT_REQUIRE_VERSION
+TabWidth:        4
+UseCRLF:         false
+UseTab:          Always
+WhitespaceSensitiveMacros:
+  - STRINGIZE
+  - PP_STRINGIZE
+  - BOOST_PP_STRINGIZE
+  - NS_SWIFT_NAME
+  - CF_SWIFT_NAME
+...
+

.github/workflows/ci.yml

@@ -13,6 +13,7 @@ on:
   pull_request:
     branches:
       - main
+      - 'release/*'
 
 defaults:
   run:
@@ -26,7 +27,7 @@ jobs:
       DOCKER_REGISTRY_USERNAME: ucentral
     steps:
     - name: Checkout actions repo
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
       with:
         repository: Telecominfraproject/.github
         path: github
@@ -39,6 +40,16 @@ jobs:
         registry_user: ucentral
         registry_password: ${{ secrets.DOCKER_REGISTRY_PASSWORD }}
 
+    - name: Notify on failure via Slack
+      if: failure() && github.ref == 'refs/heads/main'
+      uses: rtCamp/action-slack-notify@v2
+      env:
+        SLACK_USERNAME: GitHub Actions failure notifier
+        SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
+        SLACK_COLOR: "${{ job.status }}"
+        SLACK_ICON: https://raw.githubusercontent.com/quintessence/slack-icons/master/images/github-logo-slack-icon.png
+        SLACK_TITLE: Docker build failed for OWProv service
+
   trigger-testing:
     if: startsWith(github.ref, 'refs/pull/')
     runs-on: ubuntu-latest
@@ -47,11 +58,11 @@ jobs:
     - name: Get base branch name and set as output
       id: get_base_branch
       run: |
-        echo ::set-output name=branch::$(echo ${GITHUB_BASE_REF##*/})
-        echo ::set-output name=owgw_branch::$(echo ${GITHUB_BASE_REF##*/} | sed 's/main/master/g')
+        echo "branch=$(echo ${GITHUB_BASE_REF##*/})" >> $GITHUB_OUTPUT
+        echo "owgw_branch=$(echo ${GITHUB_BASE_REF##*/} | sed 's/main/master/g')" >> $GITHUB_OUTPUT
 
     - name: Checkout actions repo
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
       with:
         repository: Telecominfraproject/.github
         path: github
@@ -67,4 +78,26 @@ jobs:
         workflow: ow_docker-compose.yml
         token: ${{ secrets.WLAN_TESTING_PAT }}
         ref: master
-        inputs: '{"owgw_version": "${{ env.OWGW_BASE_BRANCH }}", "owgwui_version": "${{ env.BASE_BRANCH }}", "owsec_version": "${{ env.BASE_BRANCH }}", "owfms_version": "${{ env.BASE_BRANCH }}", "owprov_version": "${{ github.sha }}", "owprovui_version": "${{ env.BASE_BRANCH }}"}'
+        inputs: '{"deployment_version": "${{ env.BASE_BRANCH }}", "owgw_version": "${{ env.OWGW_BASE_BRANCH }}", "owsec_version": "${{ env.BASE_BRANCH }}", "owfms_version": "${{ env.BASE_BRANCH }}", "owprov_version": "${{ github.sha }}", "owanalytics_version": "${{ env.BASE_BRANCH }}", "owsub_version": "${{ env.BASE_BRANCH }}", "microservice": "all"}'
+
+  trigger-deploy-to-dev:
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/main'
+    needs:
+      - docker
+    steps:
+    - name: Checkout actions repo
+      uses: actions/checkout@v2
+      with:
+        repository: Telecominfraproject/.github
+        path: github
+
+    - name: Trigger deployment of the latest version to dev instance and wait for result
+      uses: ./github/composite-actions/trigger-workflow-and-wait
+      with:
+        owner: Telecominfraproject
+        repo: wlan-testing
+        workflow: ucentralgw-dev-deployment.yaml
+        token: ${{ secrets.WLAN_TESTING_PAT }}
+        ref: master
+        inputs: '{"force_latest": "true"}'

.github/workflows/cleanup.yml

@@ -4,6 +4,7 @@ on:
   pull_request:
     branches:
       - main
+      - 'release/*'
     types: [ closed ]
 
 defaults:
@@ -16,4 +17,10 @@ jobs:
     steps:
       - run: |
           export PR_BRANCH_TAG=$(echo ${GITHUB_HEAD_REF#refs/heads/} | tr '/' '-')
-          curl -uucentral:${{ secrets.DOCKER_REGISTRY_PASSWORD }} -X DELETE "https://tip.jfrog.io/artifactory/tip-wlan-cloud-ucentral/owprov/$PR_BRANCH_TAG"
+
+          if [[ ! $PR_BRANCH_TAG =~ (main|master|release-*) ]]; then
+            echo "PR branch is $PR_BRANCH_TAG, deleting Docker image"
+            curl -s -uucentral:${{ secrets.DOCKER_REGISTRY_PASSWORD }} -X DELETE "https://tip.jfrog.io/artifactory/tip-wlan-cloud-ucentral/owprov/$PR_BRANCH_TAG"
+          else
+            echo "PR branch is $PR_BRANCH_TAG, not deleting Docker image"
+          fi

.github/workflows/enforce-jira-issue-key.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout actions repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           repository: Telecominfraproject/.github
           path: github

.github/workflows/openapi-pages.yml

@@ -0,0 +1,41 @@
+name: Update OpenAPI docs on GitHub Pages
+
+on:
+  push:
+    paths:
+      - 'openapi/**'
+    branches:
+      - main
+  workflow_dispatch:
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  docsgen:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Generate static HTML page with docs from OpenAPI definition
+        run: |
+          docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli:v6.2.1 generate -i https://raw.githubusercontent.com/Telecominfraproject/wlan-cloud-owprov/main/openapi/owprov.yaml -g html2 --skip-validate-spec -o /local/
+
+      - name: Update OpenAPI docs
+        run: |
+          mkdir tmp-docs
+          mv index.html tmp-docs/index.html
+          mkdir -p ~/.ssh
+          ssh-keyscan -H github.com >> ~/.ssh/known_hosts
+          echo https://tip-automation:${{ secrets.GIT_PUSH_PAT }}@github.com > ~/.git-credentials
+          git config --global credential.helper store
+          git config --global user.email "tip-automation@telecominfraproject.com"
+          git config --global user.name "TIP Automation User"
+          git pull
+          git checkout gh-pages || git checkout -b gh-pages
+          rm -rf docs
+          mv tmp-docs docs
+          git add docs
+          git commit -m'Update OpenAPI docs for GitHub pages'
+          git push --set-upstream origin gh-pages

.github/workflows/release.yml

@@ -0,0 +1,46 @@
+name: Release chart package
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  helm-package:
+    runs-on: ubuntu-20.04
+    env:
+      HELM_REPO_URL: https://tip.jfrog.io/artifactory/tip-wlan-cloud-ucentral-helm/
+      HELM_REPO_USERNAME: ucentral
+    steps:
+      - name: Checkout uCentral assembly chart repo
+        uses: actions/checkout@v3
+        with:
+          path: wlan-cloud-owprov
+
+      - name: Build package
+        working-directory: wlan-cloud-owprov/helm
+        run: |
+          helm plugin install https://github.com/aslafy-z/helm-git --version 0.10.0
+          helm repo add bitnami https://charts.bitnami.com/bitnami
+          helm repo update
+          helm dependency update
+          mkdir dist
+          helm package . -d dist
+
+      - name: Generate GitHub release body
+        working-directory: wlan-cloud-owprov/helm
+        run: |
+          pip3 install yq -q
+          echo "Docker image - tip-tip-wlan-cloud-ucentral.jfrog.io/owprov:$GITHUB_REF_NAME" > release.txt
+          echo "Helm charted may be attached to this release" >> release.txt
+          echo "Deployment artifacts may be found in https://github.com/Telecominfraproject/wlan-cloud-ucentral-deploy/tree/$GITHUB_REF_NAME" >> release.txt
+
+      - name: Create GitHub release
+        uses: softprops/action-gh-release@v1
+        with:
+          body_path: wlan-cloud-owprov/helm/release.txt
+          files: wlan-cloud-owprov/helm/dist/*

BUILDING.md

@@ -0,0 +1,190 @@
+# Building from source
+In order to build the OWPROV, you will need to install its dependencies, which includes the following:
+- cmake
+- boost
+- POCO 1.10.1 or later
+- a C++17 compiler
+- openssl
+- libpq-dev (PortgreSQL development libraries)
+- mysql-client (MySQL client)
+- librdkafka
+- cppkafka
+
+The build is done in 2 parts. The first part is to build a local copy of the framework tailored to your environment. This
+framework is called [Poco](https://github.com/pocoproject/poco). The version used in this project has a couple of fixes
+from the master copy needed for cmake. Please use the version of this [Poco fix](https://github.com/AriliaWireless/poco). Building
+Poco may take several minutes depending on the platform you are building on.
+
+## Ubuntu
+These instructions have proven to work on Ubuntu 20.4.
+```bash
+sudo apt install git cmake g++ libssl-dev libmariadb-dev 
+sudo apt install libpq-dev libaprutil1-dev apache2-dev libboost-all-dev
+sudo apt install librdkafka-dev // default-libmysqlclient-dev
+sudo apt install nlohmann-json-dev
+
+cd ~
+git clone https://github.com/AriliaWireless/poco --branch poco-tip-v1
+cd poco
+mkdir cmake-build
+cd cmake-build
+cmake ..
+cmake --build . --config Release
+sudo cmake --build . --target install
+
+cd ~
+git clone https://github.com/AriliaWireless/cppkafka --branch tip-v1
+cd cppkafka
+mkdir cmake-build
+cd cmake-build
+cmake ..
+cmake --build . --config Release
+sudo cmake --build . --target install
+
+cd ~
+git clone https://github.com/AriliaWireless/valijson --branch tip-v1
+cd valijson
+mkdir cmake-build
+cd cmake-build
+cmake ..
+cmake --build . --config Release
+sudo cmake --build . --target install
+
+git clone https://github.com/fmtlib/fmt --branch 9.0.0 /fmtlib
+cd fmtlib
+mkdir cmake-build
+cd cmake-build
+cmake ..
+make
+make install
+
+cd ~
+git clone https://github.com/Telecominfraproject/wlan-cloud-owprov
+cd wlan-cloud-owprov
+mkdir cmake-build
+cd cmake-build
+cmake ..
+make -j 8
+```
+
+## Fedora
+The following instructions have proven to work on Fedora 33
+```bash
+sudo yum install cmake g++ openssl-devel mysql-devel mysql apr-util-devel boost boost-devel
+sudo yum install yaml-cpp-devel lua-devel 
+sudo dnf install postgresql.x86_64 librdkafka-devel
+sudo dnf install postgresql-devel json-devel
+
+git clone https://github.com/AriliaWireless/poco --branch poco-tip-v1
+cd poco
+mkdir cmake-build
+cd cmake-build
+cmake ..
+cmake --build . --config Release
+sudo cmake --build . --target install
+
+git clone https://github.com/AriliaWireless/cppkafka --branch tip-v1
+cd cppkafka
+mkdir cmake-build
+cd cmake-build
+cmake ..
+cmake --build . --config Release
+sudo cmake --build . --target install
+
+cd ~
+git clone https://github.com/AriliaWireless/valijson --branch tip-v1
+cd valijson
+mkdir cmake-build
+cd cmake-build
+cmake ..
+cmake --build . --config Release
+sudo cmake --build . --target install
+
+cd ~
+git clone https://github.com/Telecominfraproject/wlan-cloud-owprov
+cd wlan-cloud-owprov
+mkdir cmake-build
+cd cmake-build
+cmake ..
+make
+```
+
+## macOS Build
+The following instructions have proven to work on macOS Big Sur. You need to install [Homebrew](https://brew.sh/). You must also have installed [XCode for OS X](https://www.freecodecamp.org/news/how-to-download-and-install-xcode/).
+```bash
+brew install openssl \
+	cmake \
+	libpq \
+	mysql-client \
+	apr \
+	apr-util \
+	boost \
+	yaml-cpp \
+	postgresql \
+	librdkafka \
+	nlohmann-json \
+	fmt
+
+git clone https://github.com/AriliaWireless/poco --branch poco-tip-v1
+pushd poco
+mkdir cmake-build
+push cmake-build
+cmake -DOPENSSL_ROOT_DIR=</path/to/openssl> -DENABLE_NETSSL=1 -DENABLE_JWT=1 -DENABLE_CRYPTO=1 ..
+cmake --build . --config Release
+sudo cmake --build . --target install
+popd
+popd
+
+git clone https://github.com/AriliaWireless/cppkafka --branch tip-v1
+pushd cppkafka
+mkdir cmake-build
+pushd cmake-build
+cmake ..
+cmake --build . --config Release
+sudo cmake --build . --target install
+popd
+popd
+
+git clone https://github.com/AriliaWireless/valijson --branch tip-v1
+cd valijson
+mkdir cmake-build
+cd cmake-build
+cmake ..
+cmake --build . --config Release
+sudo cmake --build . --target install
+popd
+popd
+
+git clone https://github.com/Telecominfraproject/wlan-cloud-owprov
+pushd wlan-cloud-owprov
+mkdir cmake-build
+pushd cmake-build
+cmake ..
+make -j
+popd
+popd
+```
+
+## Raspberry
+The build on a rPI takes a while. You can shorten that build time and requirements by disabling all the larger database
+support. You can build with only SQLite support by not installing the packages for PostgreSQL, and MySQL by
+adding -DSMALL_BUILD=1 on the cmake build line.
+
+```bash
+sudo apt install git cmake g++ libssl-dev libaprutil1-dev apache2-dev libboost-all-dev libyaml-cpp-dev
+git clone https://github.com/stephb9959/poco
+cd poco
+mkdir cmake-build
+cd cmake-build
+cmake ..
+cmake --build . --config Release
+sudo cmake --build . --target install
+
+cd ~
+git clone https://github.com/Telecominfraproject/wlan-cloud-owprov
+cd wlan-cloud-owprov
+mkdir cmake-build
+cd cmake-build
+cmake -DSMALL_BUILD=1 ..
+make
+```

CMakeLists.txt

@@ -1,5 +1,5 @@
 cmake_minimum_required(VERSION 3.13)
-project(owprov VERSION 2.5.0)
+project(owprov VERSION 2.9.0)
 
 set(CMAKE_CXX_STANDARD 17)
 
@@ -27,29 +27,24 @@ endif()
 
 find_package(Git QUIET)
 if(GIT_FOUND AND EXISTS "${PROJECT_SOURCE_DIR}/.git")
-    execute_process(COMMAND ${GIT_EXECUTABLE} describe --always --tags
+    execute_process(COMMAND ${GIT_EXECUTABLE} rev-parse --short HEAD
             WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
             RESULT_VARIABLE GIT_RESULT
             OUTPUT_VARIABLE GIT_HASH)
     if(NOT GIT_RESULT EQUAL "0")
-        message(FATAL_ERROR "git describe --always --tags failed with ${GIT_RESULT}")
+        message(FATAL_ERROR "git rev-parse --short HEAD failed with ${GIT_RESULT}")
     endif()
     string(REGEX REPLACE "\n$" "" GIT_HASH "${GIT_HASH}")
 endif()
 
 add_definitions(-DAWS_CUSTOM_MEMORY_MANAGEMENT)
 
-set(BUILD_SHARED_LIBS 1)
-set(Boost_USE_STATIC_LIBS OFF)
-set(Boost_USE_MULTITHREADED ON)
-set(Boost_USE_STATIC_RUNTIME OFF)
-
-find_package(Boost      REQUIRED system)
 find_package(OpenSSL    REQUIRED)
-find_package(AWSSDK     REQUIRED COMPONENTS s3)
+find_package(ZLIB       REQUIRED)
 find_package(Poco       REQUIRED COMPONENTS Crypto JWT Net Util NetSSL Data DataSQLite)
 find_package(nlohmann_json  REQUIRED)
-find_package(nlohmann_json_schema_validator REQUIRED)
+find_package(fmt        REQUIRED)
+# find_package(valijson   REQUIRED)
 
 if(SMALL_BUILD)
     find_package(Poco REQUIRED COMPONENTS Crypto JWT Net Util NetSSL Data DataSQLite)
@@ -64,6 +59,14 @@ include_directories(/usr/local/include  /usr/local/opt/openssl/include src inclu
 
 configure_file(src/ow_version.h.in ${PROJECT_SOURCE_DIR}/src/ow_version.h @ONLY)
 
+add_definitions(-DPOCO_LOG_DEBUG="1")
+
+add_compile_options(-Wall -Wextra)
+if(ASAN)
+    add_compile_options(-fsanitize=address)
+    add_link_options(-fsanitize=address)
+endif()
+
 add_executable(owprov
         build
         src/ow_version.h.in
@@ -72,20 +75,64 @@ add_executable(owprov
         src/framework/MicroService.h
         src/framework/OpenWifiTypes.h
         src/framework/orm.h
-        src/framework/RESTAPI_errors.h
-        src/framework/RESTAPI_protocol.h
         src/framework/StorageClass.h
-        src/framework/uCentral_Protocol.h
+        src/framework/MicroServiceErrorHandler.h
+        src/framework/UI_WebSocketClientServer.cpp
+        src/framework/UI_WebSocketClientServer.h
+        src/framework/utils.h
+        src/framework/utils.cpp
+        src/framework/AppServiceRegistry.h
+        src/framework/SubSystemServer.cpp
+        src/framework/SubSystemServer.h
+        src/framework/RESTAPI_utils.h
+        src/framework/UI_WebSocketClientNotifications.cpp
+        src/framework/AuthClient.cpp
+        src/framework/AuthClient.h
+        src/framework/MicroServiceNames.h
+        src/framework/MicroServiceFuncs.h
+        src/framework/OpenAPIRequests.cpp
+        src/framework/OpenAPIRequests.h
+        src/framework/MicroServiceFuncs.cpp
+        src/framework/ALBserver.cpp
+        src/framework/ALBserver.h
+        src/framework/KafkaManager.cpp
+        src/framework/KafkaManager.h
+        src/framework/RESTAPI_RateLimiter.h
+        src/framework/WebSocketLogger.h
+        src/framework/RESTAPI_GenericServerAccounting.h
+        src/framework/CIDR.h
+        src/framework/RESTAPI_Handler.cpp
+        src/framework/RESTAPI_Handler.h
+        src/framework/RESTAPI_ExtServer.h
+        src/framework/RESTAPI_ExtServer.cpp
+        src/framework/RESTAPI_IntServer.cpp
+        src/framework/RESTAPI_IntServer.h
+        src/framework/RESTAPI_SystemCommand.h
+        src/framework/RESTAPI_WebSocketServer.h
+        src/framework/RESTAPI_SystemConfiguration.h
+        src/framework/EventBusManager.cpp
+        src/framework/EventBusManager.h
+        src/framework/RESTAPI_PartHandler.h
+        src/framework/MicroService.cpp
+        src/framework/MicroServiceExtra.h
         src/framework/ConfigurationValidator.cpp
         src/framework/ConfigurationValidator.h
+        src/UI_Prov_WebSocketNotifications.h
+        src/UI_Prov_WebSocketNotifications.cpp
         src/RESTObjects/RESTAPI_SecurityObjects.h src/RESTObjects/RESTAPI_SecurityObjects.cpp
-        src/RESTObjects/RESTAPI_ProvObjects.cpp src/RESTObjects/RESTAPI_ProvObjects.h
         src/RESTObjects/RESTAPI_GWobjects.h src/RESTObjects/RESTAPI_GWobjects.cpp
         src/RESTObjects/RESTAPI_FMSObjects.h src/RESTObjects/RESTAPI_FMSObjects.cpp
+        src/RESTObjects/RESTAPI_CertObjects.cpp src/RESTObjects/RESTAPI_CertObjects.h
+        src/RESTObjects/RESTAPI_OWLSobjects.cpp src/RESTObjects/RESTAPI_OWLSobjects.h
+        src/RESTObjects/RESTAPI_ProvObjects.cpp src/RESTObjects/RESTAPI_ProvObjects.h
+        src/RESTObjects/RESTAPI_AnalyticsObjects.cpp src/RESTObjects/RESTAPI_AnalyticsObjects.h
+        src/RESTObjects/RESTAPI_SubObjects.cpp src/RESTObjects/RESTAPI_SubObjects.h
+
         src/RESTAPI/RESTAPI_routers.cpp
         src/Daemon.cpp src/Daemon.h
         src/Dashboard.h src/Dashboard.cpp
         src/StorageService.cpp src/StorageService.h
+
         src/storage/storage_entity.cpp src/storage/storage_entity.h
         src/storage/storage_policies.cpp src/storage/storage_policies.h
         src/storage/storage_venue.cpp src/storage/storage_venue.h
@@ -95,6 +142,14 @@ add_executable(owprov
         src/storage/storage_management_roles.cpp src/storage/storage_management_roles.h
         src/storage/storage_configurations.cpp src/storage/storage_configurations.h
         src/storage/storage_tags.cpp src/storage/storage_tags.h
+        src/storage/storage_operataor.cpp src/storage/storage_operataor.h
+        src/storage/storage_sub_devices.cpp src/storage/storage_sub_devices.h
+        src/storage/storage_service_class.cpp src/storage/storage_service_class.h
+        src/storage/storage_maps.cpp src/storage/storage_maps.h
+        src/storage/storage_signup.cpp src/storage/storage_signup.h
+        src/storage/storage_variables.cpp src/storage/storage_variables.h
+        src/storage/storage_overrides.cpp src/storage/storage_overrides.h
+
         src/RESTAPI/RESTAPI_entity_handler.cpp src/RESTAPI/RESTAPI_entity_handler.h
         src/RESTAPI/RESTAPI_contact_handler.cpp src/RESTAPI/RESTAPI_contact_handler.h
         src/RESTAPI/RESTAPI_location_handler.cpp src/RESTAPI/RESTAPI_location_handler.h
@@ -104,7 +159,6 @@ add_executable(owprov
         src/RESTAPI/RESTAPI_inventory_list_handler.cpp src/RESTAPI/RESTAPI_inventory_list_handler.h
         src/RESTAPI/RESTAPI_entity_list_handler.cpp src/RESTAPI/RESTAPI_entity_list_handler.h
         src/RESTAPI/RESTAPI_configurations_handler.cpp src/RESTAPI/RESTAPI_configurations_handler.h
-        src/RESTAPI/RESTAPI_webSocketServer.h src/RESTAPI/RESTAPI_webSocketServer.cpp
         src/RESTAPI/RESTAPI_contact_list_handler.cpp src/RESTAPI/RESTAPI_contact_list_handler.h
         src/RESTAPI/RESTAPI_location_list_handler.cpp src/RESTAPI/RESTAPI_location_list_handler.h
         src/RESTAPI/RESTAPI_venue_list_handler.cpp src/RESTAPI/RESTAPI_venue_list_handler.h
@@ -113,6 +167,15 @@ add_executable(owprov
         src/RESTAPI/RESTAPI_managementRole_list_handler.cpp src/RESTAPI/RESTAPI_managementRole_list_handler.h
         src/RESTAPI/RESTAPI_configurations_list_handler.cpp src/RESTAPI/RESTAPI_configurations_list_handler.h
         src/RESTAPI/RESTAPI_iptocountry_handler.cpp src/RESTAPI/RESTAPI_iptocountry_handler.h
+        src/RESTAPI/RESTAPI_signup_handler.h src/RESTAPI/RESTAPI_signup_handler.cpp
+        src/RESTAPI/RESTAPI_asset_server.cpp src/RESTAPI/RESTAPI_asset_server.h
+        src/RESTAPI/RESTAPI_db_helpers.h
+        src/RESTAPI/RESTAPI_map_handler.cpp src/RESTAPI/RESTAPI_map_handler.h
+        src/RESTAPI/RESTAPI_map_list_handler.cpp src/RESTAPI/RESTAPI_map_list_handler.h
+        src/RESTAPI/RESTAPI_variables_handler.cpp src/RESTAPI/RESTAPI_variables_handler.h
+        src/RESTAPI/RESTAPI_variables_list_handler.cpp src/RESTAPI/RESTAPI_variables_list_handler.h
+        src/RESTAPI/RESTAPI_overrides_handler.cpp src/RESTAPI/RESTAPI_overrides_handler.h
+
         src/FindCountry.h
         src/sdks/SDK_gw.cpp src/sdks/SDK_gw.h
         src/sdks/SDK_prov.cpp src/sdks/SDK_prov.h
@@ -122,18 +185,35 @@ add_executable(owprov
         src/AutoDiscovery.cpp src/AutoDiscovery.h
         src/ConfigSanityChecker.cpp src/ConfigSanityChecker.h
         src/TagServer.cpp src/TagServer.h
-        src/RESTAPI/RESTAPI_db_helpers.h
         src/JobController.cpp src/JobController.h
         src/JobRegistrations.cpp
-        src/storage/storage_jobs.cpp src/storage/storage_jobs.h
-        src/WebSocketClientServer.cpp src/WebSocketClientServer.h
-        src/storage/storage_maps.cpp src/storage/storage_maps.h
-        src/RESTAPI/RESTAPI_map_handler.cpp src/RESTAPI/RESTAPI_map_handler.h
-        src/RESTAPI/RESTAPI_map_list_handler.cpp src/RESTAPI/RESTAPI_map_list_handler.h)
+        src/Signup.cpp src/Signup.h
+        src/DeviceTypeCache.h
+        src/FileDownloader.cpp src/FileDownloader.h
+        src/Tasks/VenueConfigUpdater.h
+        src/libs/croncpp.h
+        src/Kafka_ProvUpdater.cpp src/Kafka_ProvUpdater.h
+        src/RESTAPI/RESTAPI_sub_devices_list_handler.cpp src/RESTAPI/RESTAPI_sub_devices_list_handler.h
+        src/RESTAPI/RESTAPI_sub_devices_handler.cpp src/RESTAPI/RESTAPI_sub_devices_handler.h
+        src/RESTAPI/RESTAPI_service_class_list_handler.cpp src/RESTAPI/RESTAPI_service_class_list_handler.h
+        src/RESTAPI/RESTAPI_service_class_handler.cpp src/RESTAPI/RESTAPI_service_class_handler.h
+        src/RESTAPI/RESTAPI_operators_list_handler.cpp src/RESTAPI/RESTAPI_operators_list_handler.h
+        src/RESTAPI/RESTAPI_operators_handler.cpp src/RESTAPI/RESTAPI_operators_handler.h
+        src/storage/storage_op_contacts.cpp src/storage/storage_op_contacts.h
+        src/storage/storage_op_locations.cpp src/storage/storage_op_locations.h
+        src/RESTAPI/RESTAPI_op_contact_list_handler.cpp src/RESTAPI/RESTAPI_op_contact_list_handler.h
+        src/RESTAPI/RESTAPI_op_contact_handler.cpp src/RESTAPI/RESTAPI_op_contact_handler.h
+        src/RESTAPI/RESTAPI_op_location_list_handler.cpp src/RESTAPI/RESTAPI_op_location_list_handler.h
+        src/RESTAPI/RESTAPI_op_location_handler.cpp src/RESTAPI/RESTAPI_op_location_handler.h
+        src/ProvWebSocketClient.cpp src/ProvWebSocketClient.h
+        src/Tasks/VenueRebooter.h src/Tasks/VenueUpgrade.h
+        src/sdks/SDK_fms.cpp src/sdks/SDK_fms.h
+        src/RESTAPI/RESTAPI_overrides_handler.cpp src/RESTAPI/RESTAPI_overrides_handler.h)
 
 target_link_libraries(owprov PUBLIC
-        ${Poco_LIBRARIES} ${MySQL_LIBRARIES}
-        ${Boost_LIBRARIES}
-        ${ZLIB_LIBRARIES} ${AWSSDK_LINK_LIBRARIES}
-        CppKafka::cppkafka nlohmann_json_schema_validator)
+        ${Poco_LIBRARIES}
+        ${MySQL_LIBRARIES}
+        ${ZLIB_LIBRARIES}
+        CppKafka::cppkafka
+        fmt::fmt)
 

CONFIGURATION.md

@@ -0,0 +1,243 @@
+# OWPROV Configuration
+Here is the list of parameters you can configure in the `owprov.properties` file.
+
+## OWPROV Specific Parameters
+### Default firmware management rules
+FMS is already integrated with OpenWifi. In order to allow it to upgrade devices automatically, you should
+set the following values.
+```properties 
+firmware.updater.upgrade = <true/false>
+firmware.updater.releaseonly = <true/false>
+```
+#### firmware.updater.upgrade
+Should FMS attempt to upgrade devices by default.
+
+#### firmware.updater.releaseonly
+Should only RC software be used during upgrades.
+
+### Google Map API Key
+To support geocoding help, you need to configuration the following in the configuration file. Geocoding is used
+when creating location and when reporting analytics.
+```properties
+geocodeapi = google
+google.apikey = ********************************
+```
+
+### IP to Country Parameters
+The controller has the ability to find the location of the IP of each Access Points. This uses an external IP location service. Currently,
+the controller supports 3 services. Please note that these services will require to obtain an API key or token, and these may cause you to incur
+additional fees. Here is the list of the services supported:
+- ip2location: ip2location.com
+- ipdata: ipdata.co
+- ipinfo: ipinfo.io
+
+```properties
+iptocountry.default = US
+iptocountry.provider = ipinfo
+#iptocountry.provider = ipdata
+#iptocountry.provider = ip2location
+iptocountry.ipinfo.token =
+iptocountry.ipdata.apikey =
+iptocountry.ip2location.apikey =
+```
+
+#### iptocountry.default
+This is the country code to be used if no information can be found at one of the providers or you have not configured any of the providers.
+
+#### iptocountry.provider
+You must select onf of the possible services and the fill the appropriate token or api key parameter.
+
+## Generic OpenWiFi SDK parameters
+### REST API External parameters
+These are the parameters required for the configuration of the external facing REST API server
+```properties
+openwifi.restapi.host.0.backlog = 100
+openwifi.restapi.host.0.security = relaxed
+openwifi.restapi.host.0.rootca = $OWPROV_ROOT/certs/restapi-ca.pem
+openwifi.restapi.host.0.address = *
+openwifi.restapi.host.0.port = 16004
+openwifi.restapi.host.0.cert = $OWPROV_ROOT/certs/restapi-cert.pem
+openwifi.restapi.host.0.key = $OWPROV_ROOT/certs/restapi-key.pem
+openwifi.restapi.host.0.key.password = mypassword
+```
+
+#### openwifi.restapi.host.0.backlog
+This is the number of concurrent REST API calls that maybe be kept in the backlog for processing. That's a good rule of thumb. Never go above 500.
+#### openwifi.restapi.host.0.rootca
+This is the root file of your own certificate CA in `pem` format.
+#### openwifi.restapi.host.0.cert
+This is your own server certificate in `pem` format..
+#### openwifi.restapi.host.0.key
+This is the private key associated with your own certificate in `pem` format.
+#### openwifi.restapi.host.0.address
+Leve this a `*` in the case you want to bind to all interfaces on your gateway host or select the address of a single interface.
+#### openwifi.restapi.host.0.port
+The port on which the REST API server is listening. By default, this is 16002.
+#### openwifi.restapi.host.0.security
+Leave this as `relaxed` for now for devices.
+#### openwifi.restapi.host.0.key.password
+If you key file uses a password, please enter it here.
+
+### REST API Intra microservice parameters
+The following parameters describe the configuration for the inter-microservice HTTP server. You may use the same certificate/key
+you are using for your extenral server or another certificate.
+```properties
+openwifi.internal.restapi.host.0.backlog = 100
+openwifi.internal.restapi.host.0.security = relaxed
+openwifi.internal.restapi.host.0.rootca = $OWPROV_ROOT/certs/restapi-ca.pem
+openwifi.internal.restapi.host.0.address = *
+openwifi.internal.restapi.host.0.port = 17004
+openwifi.internal.restapi.host.0.cert = $OWPROV_ROOT/certs/restapi-cert.pem
+openwifi.internal.restapi.host.0.key = $OWPROV_ROOT/certs/restapi-key.pem
+openwifi.internal.restapi.host.0.key.password = mypassword
+```
+
+#### openwifi.internal.host.0.backlog
+This is the number of concurrent REST API calls that maybe be kept in the backlog for processing. That's a good rule of thumb. Never go above 500.
+#### openwifi.internal.host.0.rootca
+This is the root file of your own certificate CA in `pem` format.
+#### openwifi.internal.host.0.cert
+This is your own server certificate in `pem` format..
+#### openwifi.internal.host.0.key
+This is the private key associated with your own certificate in `pem` format.
+#### openwifi.internal.host.0.address
+Leve this a `*` in the case you want to bind to all interfaces on your gateway host or select the address of a single interface.
+#### openwifi.internal.host.0.port
+The port on which the REST API server is listening. By default, this is 17002.
+#### openwifi.internal.host.0.security
+Leave this as `relaxed` for now for devices.
+#### openwifi.internal.host.0.key.password
+If you key file uses a password, please enter it here.
+
+### Microservice information
+These are different Microservie parameters. Following is a brief explanation.
+```properties
+openwifi.service.key = $OWPROV_ROOT/certs/restapi-key.pem
+openwifi.service.key.password = mypassword
+openwifi.system.data = $OWPROV_ROOT/data
+openwifi.system.uri.private = https://localhost:17004
+openwifi.system.uri.public = https://ucentral.example.com:16004
+openwifi.system.uri.ui = https://provisionins-ui.example.com
+openwifi.security.restapi.disable = false
+openwifi.system.commandchannel = /tmp/app.ucentralprov
+openwifi.autoprovisioning = true
+```
+#### openwifi.service.key
+From time to time, the microservice must encrypt information. This is the key it should use. You may use the
+same keey as you RESTAPI or your server.
+#### openwifi.service.key.password
+The password for the `openwifi.service.key`
+#### openwifi.system.data
+The location of system data. This path must exist.
+#### openwifi.system.uri.private
+The URI to reach the controller on the internal port.
+#### openwifi.system.uri.public
+The URI to reach the controller from the outside world.
+#### openwifi.system.uri.ui
+The URI of the UI to manage this service
+#### openwifi.security.restapi.disable
+This allows to disable security for internal and external API calls. This should only be used if the controller
+sits behind an application load balancer that will actually do TLS. Setting this to `true` disables security.
+#### openwifi.system.commandchannel
+The UNIX socket command channel used by this service.
+#### openwifi.autoprovisioning
+Allow unknown devices to be provisioned by the system.
+
+### ALB Support
+In order to support an application load balancer health check verification, your need to provide the following parameters.
+```properties
+alb.enable = true
+alb.port = 16104
+```
+
+### Kafka
+The controller use Kafka, like all the other microservices. You must configure the kafka section in order for the
+system to work.
+```properties
+openwifi.kafka.group.id = provisioning
+openwifi.kafka.client.id = provisioning1
+openwifi.kafka.enable = true
+openwifi.kafka.brokerlist = my_Kafka.example.com:9092
+openwifi.kafka.auto.commit = false
+openwifi.kafka.queue.buffering.max.ms = 50
+```
+
+### openwifi.kafka.group.id
+The group ID is a single word that should identify the type of service tuning. In the case `provisioning`
+### openwifi.kafka.client.id
+The client ID is a single service within that group ID. Each participant must have a unique client ID.
+### openwifi.kafka.enable
+Kafka should always be enabled.
+### openwifi.kafka.brokerlist
+The list of servers where your Kafka server is running. Comma separated.
+### openwifi.kafka.auto.commit
+Auto commit flag in Kafka. Leave as `false`.
+### openwifi.kafka.queue.buffering.max.ms
+Kafka buffering. Leave as `50`.
+### Kafka security
+If you intend to use SSL, you should look into Kafka Connect and specify the certificates below.
+```properties
+penwifi.kafka.ssl.ca.location =
+openwifi.kafka.ssl.certificate.location =
+openwifi.kafka.ssl.key.location =
+openwifi.kafka.ssl.key.password =
+```
+
+### DB Type
+The controller supports 3 types of Database. SQLite should only be used for sites with less than 100 APs or for testing in the lab.
+In order to select which database to use, you must set the `storage.type` value to sqlite, postgresql, or mysql.
+
+```properties
+storage.type = sqlite
+#storage.type = postgresql
+#storage.type = mysql
+```
+
+### Storage SQLite parameters
+Additional parameters to set for SQLite. The only important one is `storage.type.sqlite.db` which is the database name on disk.
+```properties
+storage.type.sqlite.db = provisioning.db
+storage.type.sqlite.idletime = 120
+storage.type.sqlite.maxsessions = 128
+```
+
+### Storage Postgres
+Additional parameters to set if you select Postgres for your database. You must specify `host`, `username`, `password`,
+`database`, and `port`.
+```properties
+storage.type.postgresql.maxsessions = 64
+storage.type.postgresql.idletime = 60
+storage.type.postgresql.host = localhost
+storage.type.postgresql.username = provisioning
+storage.type.postgresql.password = provisioning
+storage.type.postgresql.database = provisioning
+storage.type.postgresql.port = 5432
+storage.type.postgresql.connectiontimeout = 60
+```
+
+### Storage MySQL/MariaDB
+Additional parameters to set if you select mysql for your database. You must specify `host`, `username`, `password`,
+`database`, and `port`.
+```properties
+storage.type.mysql.maxsessions = 64
+storage.type.mysql.idletime = 60
+storage.type.mysql.host = localhost
+storage.type.postgresql.username = provisioning
+storage.type.postgresql.password = provisioning
+storage.type.postgresql.database = provisioning
+storage.type.mysql.port = 3306
+storage.type.mysql.connectiontimeout = 60
+```
+
+### Logging Parameters
+The microservice provides extensive logging. If you would like to keep logging on disk, set the `logging.type = file`. If you only want
+console logging, `set logging.type = console`. When selecting file, `logging.path` must exist. `logging.level` sets the
+basic logging level for the entire controller. `logging.websocket` disables WebSocket logging.
+
+```properties
+logging.type = file
+logging.path = $OWPROV_ROOT/logs
+logging.level = information
+logging.asynch = true
+logging.websocket = false
+```

CONTRIBUTING.md

@@ -0,0 +1,38 @@
+# How to Contribute
+
+We'd love to accept your patches and contributions to this project. There are
+just a few small guidelines you need to follow.
+
+## Version of C++
+This project is based on the C++17 standard and compiles as-is on most platforms 
+using either clang or g++. Do not use C++21 or C++23 features for now. Some core 
+libraries used in this project do not support C++21 or C++23 yet.
+
+## Variable Naming
+Naming of pretty much anything uses Pascal naming. Longer explicit names using casing. 
+Member variable naming adds a `_` at the end of the vars. Try to
+keep this standard going. Sometimes you must override a base class function and then of course
+you need to follow the base class.
+
+## This is a cmake project
+This is a cmake project, and you need to adhere to the cmake rules. If you need
+to add a package to the CMakeList, you need to ensure that the package is available
+on all required platforms and compiles. Remember that this project runs on Linux, OS X, 
+and the Raspberry PI.
+
+## Licensed packages
+When adding a package, you must also state the licensing for the package. MIT, BSD, Apache licenses
+are acceptable. No commercial licenses are allowed. 
+
+## clang formatting
+Please format your code using the included `.clang-format` file included in the project.
+
+```bash
+clang-format -i --style=<project root>/.clang-format myfile.cpp
+```
+
+## Pull Requests
+All submissions, including submissions by project members, require review. We
+accept GitHub pull requests. Please create a branch with the Jira name for addressing the issue you are fixing or the 
+feature you are implementing.
+Create a pull-request from the branch into master. 

Dockerfile

@@ -1,16 +1,22 @@
-FROM alpine:3.15 AS build-base
+ARG DEBIAN_VERSION=11.5-slim
+ARG POCO_VERSION=poco-tip-v2
+ARG CPPKAFKA_VERSION=tip-v1
+ARG VALIJASON_VERSION=tip-v1
 
-RUN apk add --update --no-cache \
+FROM debian:$DEBIAN_VERSION AS build-base
+
+RUN apt-get update && apt-get install --no-install-recommends -y \
     make cmake g++ git \
-    unixodbc-dev postgresql-dev mariadb-dev \
-    librdkafka-dev boost-dev openssl-dev \
-    zlib-dev nlohmann-json \
-    curl-dev
+    libpq-dev libmariadb-dev libmariadbclient-dev-compat \
+    librdkafka-dev libboost-all-dev libssl-dev \
+    zlib1g-dev nlohmann-json3-dev ca-certificates libcurl4-openssl-dev libfmt-dev
 
 FROM build-base AS poco-build
 
-ADD https://api.github.com/repos/stephb9959/poco/git/refs/heads/master version.json
-RUN git clone https://github.com/stephb9959/poco /poco
+ARG POCO_VERSION
+
+ADD https://api.github.com/repos/AriliaWireless/poco/git/refs/tags/${POCO_VERSION} version.json
+RUN git clone https://github.com/AriliaWireless/poco --branch ${POCO_VERSION} /poco
 
 WORKDIR /poco
 RUN mkdir cmake-build
@@ -21,8 +27,10 @@ RUN cmake --build . --target install
 
 FROM build-base AS cppkafka-build
 
-ADD https://api.github.com/repos/stephb9959/cppkafka/git/refs/heads/master version.json
-RUN git clone https://github.com/stephb9959/cppkafka /cppkafka
+ARG CPPKAFKA_VERSION
+
+ADD https://api.github.com/repos/AriliaWireless/cppkafka/git/refs/tags/${CPPKAFKA_VERSION} version.json
+RUN git clone https://github.com/AriliaWireless/cppkafka --branch ${CPPKAFKA_VERSION} /cppkafka
 
 WORKDIR /cppkafka
 RUN mkdir cmake-build
@@ -31,30 +39,17 @@ RUN cmake ..
 RUN cmake --build . --config Release -j8
 RUN cmake --build . --target install
 
-FROM build-base AS json-schema-validator-build
+FROM build-base AS valijson-build
 
-ADD https://api.github.com/repos/pboettch/json-schema-validator/git/refs/heads/master version.json
-RUN git clone https://github.com/pboettch/json-schema-validator /json-schema-validator
+ARG VALIJASON_VERSION
 
-WORKDIR /json-schema-validator
+ADD https://api.github.com/repos/AriliaWireless/valijson/git/refs/tags/${VALIJASON_VERSION} version.json
+RUN git clone https://github.com/AriliaWireless/valijson --branch ${VALIJASON_VERSION} /valijson
+
+WORKDIR /valijson
 RUN mkdir cmake-build
 WORKDIR cmake-build
 RUN cmake ..
-RUN make
-RUN make install
-
-FROM build-base AS aws-sdk-cpp-build
-
-ADD https://api.github.com/repos/aws/aws-sdk-cpp/git/refs/heads/main version.json
-RUN git clone --recurse-submodules https://github.com/aws/aws-sdk-cpp /aws-sdk-cpp
-
-WORKDIR /aws-sdk-cpp
-RUN mkdir cmake-build
-WORKDIR cmake-build
-RUN cmake .. -DBUILD_ONLY="sns;s3" \
-             -DCMAKE_BUILD_TYPE=Release \
-             -DCMAKE_CXX_FLAGS="-Wno-error=stringop-overflow -Wno-error=uninitialized" \
-             -DAUTORUN_UNIT_TESTS=OFF
 RUN cmake --build . --config Release -j8
 RUN cmake --build . --target install
 
@@ -69,10 +64,7 @@ COPY --from=poco-build /usr/local/include /usr/local/include
 COPY --from=poco-build /usr/local/lib /usr/local/lib
 COPY --from=cppkafka-build /usr/local/include /usr/local/include
 COPY --from=cppkafka-build /usr/local/lib /usr/local/lib
-COPY --from=json-schema-validator-build /usr/local/include /usr/local/include
-COPY --from=json-schema-validator-build /usr/local/lib /usr/local/lib
-COPY --from=aws-sdk-cpp-build /usr/local/include /usr/local/include
-COPY --from=aws-sdk-cpp-build /usr/local/lib /usr/local/lib
+COPY --from=valijson-build /usr/local/include /usr/local/include
 
 WORKDIR /owprov
 RUN mkdir cmake-build
@@ -80,21 +72,21 @@ WORKDIR /owprov/cmake-build
 RUN cmake ..
 RUN cmake --build . --config Release -j8
 
-FROM alpine:3.15
+FROM debian:$DEBIAN_VERSION
 
 ENV OWPROV_USER=owprov \
     OWPROV_ROOT=/owprov-data \
     OWPROV_CONFIG=/owprov-data
 
-RUN addgroup -S "$OWPROV_USER" && \
-    adduser -S -G "$OWPROV_USER" "$OWPROV_USER"
+RUN useradd "$OWPROV_USER"
 
 RUN mkdir /openwifi
 RUN mkdir -p "$OWPROV_ROOT" "$OWPROV_CONFIG" && \
     chown "$OWPROV_USER": "$OWPROV_ROOT" "$OWPROV_CONFIG"
 
-RUN apk add --update --no-cache librdkafka su-exec gettext ca-certificates bash jq curl \
-    mariadb-connector-c libpq unixodbc postgresql-client
+RUN apt-get update && apt-get install --no-install-recommends -y \
+    librdkafka++1 gosu gettext ca-certificates bash jq curl wget \
+    libmariadb-dev-compat libpq5 postgresql-client libfmt7
 
 COPY readiness_check /readiness_check
 COPY test_scripts/curl/cli /cli
@@ -103,14 +95,13 @@ COPY owprov.properties.tmpl /
 COPY docker-entrypoint.sh /
 COPY wait-for-postgres.sh /
 RUN wget https://raw.githubusercontent.com/Telecominfraproject/wlan-cloud-ucentral-deploy/main/docker-compose/certs/restapi-ca.pem \
-    -O /usr/local/share/ca-certificates/restapi-ca-selfsigned.pem
+    -O /usr/local/share/ca-certificates/restapi-ca-selfsigned.crt
 
 COPY --from=owprov-build /owprov/cmake-build/owprov /openwifi/owprov
-COPY --from=cppkafka-build /cppkafka/cmake-build/src/lib/* /usr/local/lib
-COPY --from=poco-build /poco/cmake-build/lib/* /usr/local/lib
-COPY --from=aws-sdk-cpp-build /aws-sdk-cpp/cmake-build/aws-cpp-sdk-core/libaws-cpp-sdk-core.so /usr/local/lib
-COPY --from=aws-sdk-cpp-build /aws-sdk-cpp/cmake-build/aws-cpp-sdk-s3/libaws-cpp-sdk-s3.so /usr/local/lib
-COPY --from=aws-sdk-cpp-build /aws-sdk-cpp/cmake-build/aws-cpp-sdk-sns/libaws-cpp-sdk-sns.so /usr/local/lib
+COPY --from=cppkafka-build /cppkafka/cmake-build/src/lib/* /usr/local/lib/
+COPY --from=poco-build /poco/cmake-build/lib/* /usr/local/lib/
+
+RUN ldconfig
 
 EXPOSE 16005 17005 16105
 

README.md

@@ -1,11 +1,23 @@
-# OpenWiFi Provisioning
+<p align="center">
+    <img src="images/project/logo.svg" width="200"/>
+</p>
 
-## Build from source.
-You need:
-- https://github.com/pboettch/json-schema-validator.git
-- https://github.com/nlohmann/json.git
+# OpenWiFi Provisioning Service (OWPROV)
+## What is it?
+The OWPROV is a service for the TIP OpenWiFi CloudSDK (OWSDK).
+OWPROV manages groups of access points through the use of entities and vanues. OWPROV, like all other OWSDK microservices, is
+defined using an OpenAPI definition and uses the ucentral communication protocol to interact with Access Points. To use
+the OWPROV, you either need to [build it](#building) or use the [Docker version](#docker).
 
-build and install them.
+## OpenAPI
+You may get static page with OpenAPI docs generated from the definition on [GitHub Page](https://telecominfraproject.github.io/wlan-cloud-owprov/).
+Also, you may use [Swagger UI](https://petstore.swagger.io/#/) with OpenAPI definition file raw link (i.e. [latest version file](https://raw.githubusercontent.com/Telecominfraproject/wlan-cloud-owprov/main/openapi/owprov.yaml)) to get interactive docs page.
+
+## Building
+To build the microservice from source, please follow the instructions in [here](./BUILDING.md)
+
+## Docker
+To use the CLoudSDK deployment please follow [here](https://github.com/Telecominfraproject/wlan-cloud-ucentral-deploy)
 
 ## Root entity
 It's UUID value is 0000-0000-0000. Its parent entity must be empty.
@@ -46,24 +58,77 @@ You may modify the following fields in the POST
 - You may include an array of devices UUIDs
 - Topology and design cannot be set
 
-## Geocoding
-To support geocoding help, you need to configuration the following in the configuration file. Geocoding is used
-when creating location and when reporting analytics.
-``` 
-geocodeapi = google
-google.apikey = **********************************
+#### Expected directory layout
+From the directory where your cloned source is, you will need to create the `certs`, `logs`, and `uploads` directories.
+```bash
+mkdir certs
+mkdir certs/cas
+mkdir logs
+mkdir uploads
 ```
-Currently, only google Geocoding is supported. Additional methods may be added in the future.
-
-## Default firmware management rules
-FMS is already integrated with OpenWifi. In order to allow it to upgrade devices automatically, you should 
-set the following values.
-``` 
-firmware.updater.upgrade = <true/false>
-firmware.updater.releaseonly = <true/false>
+You should now have the following:
+```text
+--+-- certs
+  |   +--- cas
+  +-- cmake
+  +-- cmake-build
+  +-- logs
+  +-- src
+  +-- test_scripts
+  +-- openapi
+  +-- uploads
+  +-- owsec.properties
 ```
-### firmware.updater.upgrade
-Should FMS attempt to upgrade devices by default.
 
-### firmware.updater.releaseonly
-Should only RC software be used during upgrades.
+### Certificate
+The OWFMS uses a certificate to provide security for the REST API Certificate to secure the Northbound API.
+
+#### The `certs` directory
+For all deployments, you will need the following `certs` directory, populated with the proper files.
+
+```text
+certs ---+--- restapi-ca.pem
+         +--- restapi-cert.pem
+         +--- restapi-key.pem
+```
+
+## Firewall Considerations
+| Port  | Description                                    | Configurable |
+|:------|:-----------------------------------------------|:------------:|
+| 16004 | Default port for REST API Access to the OWPROV |     yes      |
+
+### Environment variables
+The following environment variables should be set from the root directory of the service. They tell the OWGW process where to find
+the configuration and the root directory.
+```bash
+export OWGW_ROOT=`pwd`
+export OWGW_CONFIG=`pwd`
+```
+You can run the shell script `set_env.sh` from the microservice root.
+
+### OWPROV Service Configuration
+The configuration is kept in a file called `owprov.properties`. To understand the content of this file,
+please look [here](https://github.com/Telecominfraproject/wlan-cloud-owprov/blob/main/CONFIGURATION.md)
+
+## Kafka topics
+Toe read more about Kafka, follow the [document](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/main/KAFKA.md)
+
+## Contributions
+We need more contributors. Should you wish to contribute,
+please follow the [contributions](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/master/CONTRIBUTING.md) document.
+
+## Pull Requests
+Please create a branch with the Jira addressing the issue you are fixing or the feature you are implementing.
+Create a pull-request from the branch into master.
+
+## Additional OWSDK Microservices
+Here is a list of additional OWSDK microservices
+| Name | Description | Link | OpenAPI |
+| :--- | :--- | :---: | :---: |
+| OWSEC | Security Service | [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralsec) | [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralsec/blob/main/openpapi/owsec.yaml) |
+| OWGW | Controller Service | [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw) | [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/master/openapi/owgw.yaml) |
+| OWFMS | Firmware Management Service | [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralfms) | [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralfms/blob/main/openapi/owfms.yaml) |
+| OWPROV | Provisioning Service | [here](https://github.com/Telecominfraproject/wlan-cloud-owprov) | [here](https://github.com/Telecominfraproject/wlan-cloud-owprov/blob/main/openapi/owprov.yaml) |
+| OWANALYTICS | Analytics Service | [here](https://github.com/Telecominfraproject/wlan-cloud-analytics) | [here](https://github.com/Telecominfraproject/wlan-cloud-analytics/blob/main/openapi/owanalytics.yaml) |
+| OWSUB | Subscriber Service | [here](https://github.com/Telecominfraproject/wlan-cloud-userportal) | [here](https://github.com/Telecominfraproject/wlan-cloud-userportal/blob/main/openapi/userportal.yaml) |
+

SUBSCRIBERS.md

@@ -0,0 +1,6 @@
+# Subscribers Architecture
+
+## Overview
+The goal is to provide multiple WISPs with access to a set of subscribers. All subscribers will fall in the default WISP and can be moved to any other WISP later. You can use the source IP to detect which WISP to select.
+Entities can be generic entities when created OR WISP entities. 
+

build

@@ -1 +1 @@
-139
+21

docker-entrypoint.sh

@@ -1,11 +1,11 @@
-#!/bin/sh
+#!/bin/bash
 set -e
 
 if [ "$SELFSIGNED_CERTS" = 'true' ]; then
     update-ca-certificates
 fi
 
-if [[ "$TEMPLATE_CONFIG" = 'true' && ! -f "$OWPROV_CONFIG"/owprov.properties ]]; then
+if [[ "$TEMPLATE_CONFIG" = 'true' ]]; then
   RESTAPI_HOST_ROOTCA=${RESTAPI_HOST_ROOTCA:-"\$OWPROV_ROOT/certs/restapi-ca.pem"} \
   RESTAPI_HOST_PORT=${RESTAPI_HOST_PORT:-"16005"} \
   RESTAPI_HOST_CERT=${RESTAPI_HOST_CERT:-"\$OWPROV_ROOT/certs/restapi-cert.pem"} \
@@ -24,8 +24,13 @@ if [[ "$TEMPLATE_CONFIG" = 'true' && ! -f "$OWPROV_CONFIG"/owprov.properties ]];
   SYSTEM_URI_PRIVATE=${SYSTEM_URI_PRIVATE:-"https://localhost:17005"} \
   SYSTEM_URI_PUBLIC=${SYSTEM_URI_PUBLIC:-"https://localhost:16005"} \
   SYSTEM_URI_UI=${SYSTEM_URI_UI:-"http://localhost"} \
+  SECURITY_RESTAPI_DISABLE=${SECURITY_RESTAPI_DISABLE:-"false"} \
   KAFKA_ENABLE=${KAFKA_ENABLE:-"true"} \
   KAFKA_BROKERLIST=${KAFKA_BROKERLIST:-"localhost:9092"} \
+  KAFKA_SSL_CA_LOCATION=${KAFKA_SSL_CA_LOCATION:-""} \
+  KAFKA_SSL_CERTIFICATE_LOCATION=${KAFKA_SSL_CERTIFICATE_LOCATION:-""} \
+  KAFKA_SSL_KEY_LOCATION=${KAFKA_SSL_KEY_LOCATION:-""} \
+  KAFKA_SSL_KEY_PASSWORD=${KAFKA_SSL_KEY_PASSWORD:-""} \
   STORAGE_TYPE=${STORAGE_TYPE:-"sqlite"} \
   STORAGE_TYPE_POSTGRESQL_HOST=${STORAGE_TYPE_POSTGRESQL_HOST:-"localhost"} \
   STORAGE_TYPE_POSTGRESQL_USERNAME=${STORAGE_TYPE_POSTGRESQL_USERNAME:-"owprov"} \
@@ -44,7 +49,7 @@ if [ "$1" = '/openwifi/owprov' -a "$(id -u)" = '0' ]; then
     if [ "$RUN_CHOWN" = 'true' ]; then
       chown -R "$OWPROV_USER": "$OWPROV_ROOT" "$OWPROV_CONFIG"
     fi
-    exec su-exec "$OWPROV_USER" "$@"
+    exec gosu "$OWPROV_USER" "$@"
 fi
 
 exec "$@"

helm/.gitignore

@@ -1 +1,3 @@
 *.swp
+Chart.lock
+charts/

helm/Chart.yaml

@@ -5,14 +5,14 @@ name: owprov
 version: 0.1.0
 dependencies:
 - name: postgresql
-  repository: https://charts.bitnami.com/bitnami
+  repository: https://tip.jfrog.io/artifactory/tip-wlan-cloud-ucentral-helm/
   version: 10.9.2
   condition: postgresql.enabled
 - name: mysql
-  repository: https://charts.bitnami.com/bitnami
+  repository: https://tip.jfrog.io/artifactory/tip-wlan-cloud-ucentral-helm/
   version: 8.8.3
   condition: mysql.enabled
 - name: mariadb
-  repository: https://charts.bitnami.com/bitnami
+  repository: https://tip.jfrog.io/artifactory/tip-wlan-cloud-ucentral-helm/
   version: 9.4.2
   condition: mariadb.enabled

helm/README.md

@@ -70,8 +70,8 @@ The following table lists the configurable parameters of the chart and their def
 | persistence.size | string | Defines PV size | `'10Gi'` |
 | public_env_variables | hash | Defines list of environment variables to be passed to the Provisioning | |
 | configProperties | hash | Configuration properties that should be passed to the application in `owprov.properties`. May be passed by key in set (i.e. `configProperties."rtty\.token"`) | |
-| certs | hash | Defines files (keys and certificates) that should be passed to the Provisioning (PEM format is adviced to be used) (see `volumes.owprov` on where it is mounted) |  |
-
+| existingCertsSecret | string | Existing Kubernetes secret containing all required certificates and private keys for microservice operation. If set, certificates from `certs` key are ignored | `""` |
+| certs | hash | Defines files (keys and certificates) that should be passed to the Gateway (PEM format is adviced to be used) (see `volumes.owprov` on where it is mounted). If `existingCertsSecret` is set, certificates passed this way will not be used. |  |
 
 Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
 

helm/templates/_helpers.tpl

@@ -30,3 +30,13 @@ Create chart name and version as used by the chart label.
 {{- define "owprov.chart" -}}
 {{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}}
 {{- end -}}
+
+{{- define "owprov.ingress.apiVersion" -}}
+  {{- if .Capabilities.APIVersions.Has "networking.k8s.io/v1" -}}
+      {{- print "networking.k8s.io/v1" -}}
+  {{- else if .Capabilities.APIVersions.Has "networking.k8s.io/v1beta1" -}}
+    {{- print "networking.k8s.io/v1beta1" -}}
+  {{- else -}}
+    {{- print "extensions/v1beta1" -}}
+  {{- end -}}
+{{- end -}}

helm/templates/deployment.yaml

@@ -1,4 +1,5 @@
 {{- $root := . -}}
+{{- $storageType := index .Values.configProperties "storage.type" -}}
 ---
 apiVersion: apps/v1
 kind: Deployment
@@ -46,6 +47,39 @@ spec:
             - -timeout
             - 600s
 
+{{- if eq $storageType "postgresql" }}
+        - name: wait-postgres
+          image: "{{ .Values.images.owprov.repository }}:{{ .Values.images.owprov.tag }}"
+          imagePullPolicy: {{ .Values.images.owprov.pullPolicy }}
+          command:
+            - /wait-for-postgres.sh
+            - {{ index .Values.configProperties "storage.type.postgresql.host" }}
+            - echo
+            - "PostgreSQL is ready"
+          env:
+            - name: KUBERNETES_DEPLOYED
+              value: "{{ now }}"
+          {{- range $key, $value := .Values.public_env_variables }}
+            - name: {{ $key }}
+              value: {{ $value | quote }}
+          {{- end }}
+          {{- range $key, $value := .Values.secret_env_variables }}
+            - name: {{ $key }}
+              valueFrom:
+                secretKeyRef:
+                  name: {{ include "owprov.fullname" $root }}-env
+                  key: {{ $key }}
+          {{- end }}
+          volumeMounts:
+          {{- range .Values.volumes.owprov }}
+          - name: {{ .name }}
+            mountPath: {{ .mountPath }}
+            {{- if .subPath }}
+            subPath: {{ .subPath }}
+            {{- end }}
+          {{- end }}
+{{- end }}
+
       containers:
 
         - name: owprov
@@ -97,8 +131,10 @@ spec:
             {{- toYaml . | nindent 12 }}
           {{- end }}
 
+      {{- with .Values.securityContext }}
       securityContext:
-        fsGroup: 101
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
 
       imagePullSecrets:
       {{- range $image, $imageValue := .Values.images }}

helm/templates/ingress.yaml

@@ -2,7 +2,7 @@
 {{- range $ingress, $ingressValue := .Values.ingresses }}
 {{- if $ingressValue.enabled }}
 ---
-apiVersion: extensions/v1beta1
+apiVersion: {{ include "owprov.ingress.apiVersion" $root }}
 kind: Ingress
 metadata:
   name: {{ include "owprov.fullname" $root }}-{{ $ingress }}
@@ -36,9 +36,23 @@ spec:
       paths:
       {{- range $ingressValue.paths }}
         - path: {{ .path }}
+          {{- if $root.Capabilities.APIVersions.Has "networking.k8s.io/v1" }}
+          pathType: {{ .pathType | default "ImplementationSpecific" }}
+          {{- end }}
           backend:
+            {{- if $root.Capabilities.APIVersions.Has "networking.k8s.io/v1" }}
+            service:
+              name: {{ include "owprov.fullname" $root }}-{{ .serviceName }}
+              port:
+              {{- if kindIs "string" .servicePort }}
+                name: {{ .servicePort }}
+              {{- else }}
+                number: {{ .servicePort }}
+              {{- end }}
+            {{- else }}
             serviceName: {{ include "owprov.fullname" $root }}-{{ .serviceName }}
             servicePort: {{ .servicePort }}
+            {{- end }}
       {{- end }}
   {{- end }}
 

helm/values.yaml

@@ -9,7 +9,7 @@ fullnameOverride: ""
 images:
   owprov:
     repository: tip-tip-wlan-cloud-ucentral.jfrog.io/owprov
-    tag: main
+    tag: v2.9.0-RC2
     pullPolicy: Always
 #    regcred:
 #      registry: tip-tip-wlan-cloud-ucentral.jfrog.io
@@ -54,6 +54,7 @@ ingresses:
     - restapi.chart-example.local
     paths:
     - path: /
+      pathType: ImplementationSpecific
       serviceName: owprov
       servicePort: restapi
 
@@ -70,7 +71,7 @@ volumes:
       mountPath: /owprov-data/certs
       volumeDefinition: |
         secret:
-          secretName: {{ include "owprov.fullname" . }}-certs
+          secretName: {{ if .Values.existingCertsSecret }}{{ .Values.existingCertsSecret }}{{ else }}{{ include "owprov.fullname" . }}-certs{{ end }}
     # Change this if you want to use another volume type
     - name: persist
       mountPath: /owprov-data/persist
@@ -90,6 +91,9 @@ resources: {}
   #  cpu: 100m
   #  memory: 128Mi
 
+securityContext:
+  fsGroup: 1000
+
 nodeSelector: {}
 
 tolerations: []
@@ -148,6 +152,10 @@ configProperties:
   openwifi.kafka.brokerlist: localhost:9092
   openwifi.kafka.auto.commit: false
   openwifi.kafka.queue.buffering.max.ms: 50
+  openwifi.kafka.ssl.ca.location: ""
+  openwifi.kafka.ssl.certificate.location: ""
+  openwifi.kafka.ssl.key.location: ""
+  openwifi.kafka.ssl.key.password: ""
   # Storage
   storage.type: sqlite # (sqlite|postgresql|mysql|odbc)
   ## SQLite
@@ -176,6 +184,7 @@ configProperties:
   openwifi.system.uri.public: https://localhost:16005
   openwifi.system.uri.ui: https://localhost
   openwifi.system.commandchannel: /tmp/app_owprov
+  iptocountry.provider: ipinfo
   # Logging
   logging.type: console
   logging.path: $OWPROV_ROOT/logs
@@ -193,6 +202,9 @@ configProperties:
   storage.type.mysql.username: stephb
   storage.type.mysql.password: snoopy99
 
+# NOTE: List of required certificates may be found in "certs" key. Alternative way to pass required certificates is to create external secret with all required certificates and set secret name in "existingCertsSecret" key. Details may be found in https://github.com/Telecominfraproject/wlan-cloud-ucentral-deploy/tree/main/chart#tldr
+existingCertsSecret: ""
+
 certs:
   # restapi-ca.pem: ""
   # restapi-cert.pem: ""

images/project/logo.svg

@@ -0,0 +1,165 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generator: Adobe Illustrator 24.2.3, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 viewBox="0 0 141.5 185.6" style="enable-background:new 0 0 141.5 185.6;" xml:space="preserve">
+<style type="text/css">
+	.st0{fill:#414141;}
+	.st1{fill:#FFFFFF;}
+	.st2{fill:#FED206;}
+	.st3{fill:#EB6F53;}
+	.st4{fill:#3BA9B6;}
+</style>
+<g>
+	<g>
+		<path class="st0" d="M120.7,183.9H21.5c-10.8,0-19.5-8.7-19.5-19.5V20.5c0-10.8,8.7-19.5,19.5-19.5h99.2
+			c10.8,0,19.5,8.7,19.5,19.5v143.9C140.2,175.2,131.5,183.9,120.7,183.9z"/>
+		<g>
+			<g>
+				<g>
+					<path class="st1" d="M46.3,166.2v-3.4h-1.2v-0.6h3.1v0.6H47v3.4H46.3z"/>
+				</g>
+				<g>
+					<path class="st1" d="M49,166.2v-4h2.7v0.6h-2v1h2v0.6h-2v1.1h2v0.6H49z"/>
+				</g>
+				<g>
+					<path class="st1" d="M52.6,166.2v-4h0.7v3.4h1.8v0.6H52.6z"/>
+				</g>
+				<g>
+					<path class="st1" d="M55.7,166.2v-4h2.7v0.6h-2v1h2v0.6h-2v1.1h2v0.6H55.7z"/>
+				</g>
+				<g>
+					<path class="st1" d="M59.1,164.2c0-1.2,0.9-2.1,2.1-2.1c0.8,0,1.3,0.4,1.6,0.9l-0.6,0.3c-0.2-0.3-0.6-0.6-1-0.6
+						c-0.8,0-1.4,0.6-1.4,1.4c0,0.8,0.6,1.4,1.4,1.4c0.4,0,0.8-0.3,1-0.6l0.6,0.3c-0.3,0.5-0.8,0.9-1.6,0.9
+						C60,166.3,59.1,165.5,59.1,164.2z"/>
+				</g>
+				<g>
+					<path class="st1" d="M63.2,164.2c0-1.2,0.8-2.1,2-2.1c1.2,0,2,0.9,2,2.1c0,1.2-0.8,2.1-2,2.1C64,166.3,63.2,165.4,63.2,164.2z
+						 M66.5,164.2c0-0.8-0.5-1.4-1.3-1.4c-0.8,0-1.3,0.6-1.3,1.4c0,0.8,0.5,1.4,1.3,1.4C66,165.7,66.5,165,66.5,164.2z"/>
+				</g>
+				<g>
+					<path class="st1" d="M71.3,166.2v-3.1l-1.2,3.1h-0.3l-1.2-3.1v3.1h-0.7v-4h1l1.1,2.7l1.1-2.7h1v4H71.3z"/>
+				</g>
+				<g>
+					<path class="st1" d="M75.7,166.2v-4h0.7v4H75.7z"/>
+				</g>
+				<g>
+					<path class="st1" d="M80.4,166.2l-2.1-2.8v2.8h-0.7v-4h0.7l2,2.8v-2.8h0.7v4H80.4z"/>
+				</g>
+				<g>
+					<path class="st1" d="M82.3,166.2v-4H85v0.6h-2v1h2v0.6h-2v1.7H82.3z"/>
+				</g>
+				<g>
+					<path class="st1" d="M87.9,166.2l-0.9-1.5h-0.7v1.5h-0.7v-4h1.7c0.8,0,1.3,0.5,1.3,1.2c0,0.7-0.5,1.1-0.9,1.2l1,1.6H87.9z
+						 M88,163.5c0-0.4-0.3-0.6-0.7-0.6h-1v1.3h1C87.7,164.1,88,163.9,88,163.5z"/>
+				</g>
+				<g>
+					<path class="st1" d="M92.4,166.2l-0.3-0.8h-1.8l-0.3,0.8h-0.8l1.6-4h0.9l1.6,4H92.4z M91.2,162.9l-0.7,1.9h1.4L91.2,162.9z"/>
+				</g>
+				<g>
+					<path class="st1" d="M95.8,166.2v-4h1.5c0.8,0,1.2,0.5,1.2,1.2c0,0.6-0.4,1.2-1.2,1.2h-1.2v1.7H95.8z M98.2,163.4
+						c0-0.5-0.3-0.9-0.9-0.9h-1.1v1.7h1.1C97.8,164.3,98.2,163.9,98.2,163.4z"/>
+				</g>
+				<g>
+					<path class="st1" d="M101.5,166.2l-1.1-1.6h-0.9v1.6h-0.3v-4h1.5c0.7,0,1.2,0.4,1.2,1.2c0,0.7-0.5,1.1-1.1,1.1l1.2,1.7H101.5z
+						 M101.6,163.4c0-0.5-0.4-0.9-0.9-0.9h-1.1v1.7h1.1C101.2,164.3,101.6,163.9,101.6,163.4z"/>
+				</g>
+				<g>
+					<path class="st1" d="M102.8,164.2c0-1.2,0.8-2.1,1.9-2.1c1.2,0,1.9,0.9,1.9,2.1c0,1.2-0.8,2.1-1.9,2.1
+						C103.6,166.3,102.8,165.4,102.8,164.2z M106.3,164.2c0-1-0.6-1.7-1.6-1.7c-1,0-1.6,0.7-1.6,1.7c0,1,0.6,1.7,1.6,1.7
+						C105.7,166,106.3,165.2,106.3,164.2z"/>
+				</g>
+				<g>
+					<path class="st1" d="M106.9,165.8l0.2-0.3c0.2,0.2,0.4,0.4,0.8,0.4c0.5,0,0.9-0.4,0.9-0.9v-2.8h0.3v2.8c0,0.8-0.5,1.2-1.2,1.2
+						C107.5,166.3,107.2,166.1,106.9,165.8z"/>
+				</g>
+				<g>
+					<path class="st1" d="M110.4,166.2v-4h2.5v0.3h-2.2v1.5h2.1v0.3h-2.1v1.6h2.2v0.3H110.4z"/>
+				</g>
+				<g>
+					<path class="st1" d="M113.5,164.2c0-1.2,0.9-2.1,2-2.1c0.6,0,1.1,0.3,1.5,0.7l-0.3,0.2c-0.3-0.3-0.7-0.6-1.2-0.6
+						c-0.9,0-1.7,0.7-1.7,1.7c0,1,0.7,1.7,1.7,1.7c0.5,0,0.9-0.2,1.2-0.6l0.3,0.2c-0.4,0.4-0.8,0.7-1.5,0.7
+						C114.4,166.3,113.5,165.5,113.5,164.2z"/>
+				</g>
+				<g>
+					<path class="st1" d="M118.7,166.2v-3.7h-1.3v-0.3h2.9v0.3H119v3.7H118.7z"/>
+				</g>
+			</g>
+			<g>
+				<polygon class="st1" points="26.3,163.8 31.6,158.5 36.9,163.8 37.7,163.8 31.6,157.6 25.5,163.8 				"/>
+				<polygon class="st1" points="36.9,164.7 31.6,170 26.3,164.7 25.5,164.7 31.6,170.8 37.7,164.7 				"/>
+				<polygon class="st1" points="31,163.8 36.3,158.5 41.6,163.8 42.5,163.8 36.3,157.6 30.2,163.8 				"/>
+				<polygon class="st1" points="41.6,164.7 36.3,170 31,164.7 30.2,164.7 36.3,170.8 42.5,164.7 				"/>
+			</g>
+		</g>
+		<g>
+			<path class="st1" d="M33.2,100.7c-4.6,0-8.3,3.7-8.3,8.3s3.7,8.3,8.3,8.3s8.3-3.7,8.3-8.3S37.8,100.7,33.2,100.7z"/>
+		</g>
+		<g>
+			<g>
+				<g>
+					<path class="st2" d="M33.2,35.2c40.7,0,73.8,33.1,73.8,73.8c0,0.7,0,1.4,0,2.1c0,1.7,0.6,3.3,1.7,4.6c1.2,1.2,2.8,1.9,4.5,2
+						l0.2,0c3.5,0,6.3-2.7,6.4-6.2c0-0.8,0-1.7,0-2.5c0-47.7-38.8-86.6-86.6-86.6c-0.8,0-1.7,0-2.5,0c-1.7,0-3.3,0.8-4.5,2
+						c-1.2,1.2-1.8,2.9-1.7,4.6c0.1,3.5,3,6.3,6.6,6.2C31.8,35.2,32.5,35.2,33.2,35.2z"/>
+				</g>
+			</g>
+		</g>
+		<g>
+			<g>
+				<g>
+					<path class="st3" d="M33.2,60.5c26.7,0,48.5,21.7,48.5,48.5c0,0.6,0,1.3,0,2c-0.1,1.7,0.5,3.3,1.7,4.6c1.2,1.3,2.7,2,4.4,2.1
+						c1.7,0.1,3.3-0.5,4.6-1.7c1.2-1.2,2-2.7,2-4.4c0-0.9,0.1-1.8,0.1-2.6c0-33.8-27.5-61.2-61.2-61.2c-0.8,0-1.6,0-2.6,0.1
+						c-1.7,0.1-3.3,0.8-4.4,2.1c-1.2,1.3-1.8,2.9-1.7,4.6s0.8,3.3,2.1,4.4c1.3,1.2,2.9,1.8,4.6,1.7C31.9,60.5,32.6,60.5,33.2,60.5z"
+						/>
+				</g>
+			</g>
+		</g>
+		<g>
+			<g>
+				<g>
+					<path class="st4" d="M33.2,86.7c12.3,0,22.3,10,22.3,22.3c0,0.5,0,1.1-0.1,1.8c-0.3,3.5,2.3,6.6,5.8,6.9
+						c3.5,0.3,6.6-2.3,6.9-5.8c0.1-1,0.1-1.9,0.1-2.8c0-19.3-15.7-35.1-35.1-35.1c-0.9,0-1.8,0-2.8,0.1c-1.7,0.1-3.2,0.9-4.3,2.2
+						c-1.1,1.3-1.6,2.9-1.5,4.6c0.1,1.7,0.9,3.2,2.2,4.3c1.3,1.1,2.9,1.6,4.6,1.5C32.1,86.7,32.7,86.7,33.2,86.7z"/>
+				</g>
+			</g>
+		</g>
+	</g>
+	<g>
+		<path class="st1" d="M35.8,130.4c1.1,0.6,2.1,1.5,2.7,2.6c0.7,1.1,1,2.3,1,3.7s-0.3,2.6-1,3.7c-0.7,1.1-1.6,2-2.7,2.6
+			c-1.1,0.6-2.4,1-3.8,1s-2.7-0.3-3.8-1c-1.1-0.6-2.1-1.5-2.7-2.6c-0.7-1.1-1-2.3-1-3.7c0-1.3,0.3-2.6,1-3.7c0.7-1.1,1.6-2,2.7-2.6
+			c1.1-0.6,2.4-0.9,3.8-0.9C33.4,129.5,34.7,129.8,35.8,130.4z M29.9,132.9c-0.7,0.4-1.2,0.9-1.6,1.6s-0.6,1.4-0.6,2.2
+			c0,0.8,0.2,1.6,0.6,2.3c0.4,0.7,0.9,1.2,1.6,1.6c0.7,0.4,1.4,0.6,2.1,0.6c0.8,0,1.5-0.2,2.1-0.6c0.6-0.4,1.2-0.9,1.5-1.6
+			c0.4-0.7,0.6-1.4,0.6-2.3c0-0.8-0.2-1.6-0.6-2.2s-0.9-1.2-1.5-1.6c-0.6-0.4-1.4-0.6-2.1-0.6C31.3,132.3,30.6,132.5,29.9,132.9z"/>
+		<path class="st1" d="M50.6,133.6c0.8,0.5,1.4,1.1,1.8,2c0.4,0.8,0.6,1.8,0.6,2.9c0,1.1-0.2,2-0.6,2.8c-0.4,0.8-1,1.5-1.8,1.9
+			c-0.8,0.5-1.6,0.7-2.6,0.7c-0.7,0-1.4-0.1-2-0.4s-1.1-0.7-1.5-1.2v5.4h-3.1V133h3.1v1.6c0.4-0.5,0.9-1,1.4-1.2s1.2-0.4,2-0.4
+			C48.9,132.9,49.8,133.1,50.6,133.6z M49.1,140.5c0.5-0.6,0.7-1.3,0.7-2.2c0-0.9-0.2-1.6-0.7-2.1c-0.5-0.6-1.1-0.8-1.9-0.8
+			s-1.4,0.3-1.9,0.8c-0.5,0.6-0.8,1.3-0.8,2.1c0,0.9,0.2,1.6,0.8,2.2s1.1,0.8,1.9,0.8S48.6,141,49.1,140.5z"/>
+		<path class="st1" d="M63.4,134.4c0.9,1,1.4,2.4,1.4,4.2c0,0.3,0,0.6,0,0.7H57c0.2,0.7,0.5,1.2,1,1.6c0.5,0.4,1.1,0.6,1.8,0.6
+			c0.5,0,1-0.1,1.5-0.3s0.9-0.5,1.3-0.9l1.6,1.6c-0.5,0.6-1.2,1.1-2,1.4c-0.8,0.3-1.6,0.5-2.6,0.5c-1.1,0-2.1-0.2-3-0.7
+			s-1.5-1.1-2-1.9c-0.5-0.8-0.7-1.8-0.7-2.9c0-1.1,0.2-2.1,0.7-2.9s1.1-1.5,2-1.9c0.8-0.5,1.8-0.7,2.9-0.7
+			C61.2,132.9,62.5,133.4,63.4,134.4z M61.8,137.5c0-0.7-0.3-1.3-0.7-1.7s-1-0.6-1.7-0.6c-0.7,0-1.2,0.2-1.7,0.6
+			c-0.4,0.4-0.7,1-0.9,1.7H61.8z"/>
+		<path class="st1" d="M76.2,134c0.7,0.7,1.1,1.7,1.1,3v6.8h-3.1v-5.9c0-0.7-0.2-1.2-0.6-1.6s-0.9-0.6-1.5-0.6
+			c-0.8,0-1.4,0.3-1.8,0.8c-0.4,0.5-0.7,1.2-0.7,2v5.3h-3.1V133h3.1v1.9c0.7-1.3,2-2,3.7-2C74.6,132.8,75.5,133.2,76.2,134z"/>
+		<path class="st1" d="M96,129.7h3.3l-4.7,14h-3.3l-2.9-10.1l-3,10.1h-3.2l-4.7-14h3.4l3,10.7l3-10.7H90l3.1,10.7L96,129.7z"/>
+		<path class="st1" d="M103.3,128.7c0.3,0.3,0.5,0.7,0.5,1.2s-0.2,0.9-0.5,1.2c-0.3,0.3-0.7,0.5-1.2,0.5c-0.5,0-0.9-0.2-1.2-0.5
+			c-0.3-0.3-0.5-0.7-0.5-1.2c0-0.5,0.2-0.9,0.5-1.2c0.3-0.3,0.7-0.5,1.2-0.5C102.6,128.2,103,128.3,103.3,128.7z M100.6,133h3.1
+			v10.8h-3.1V133z"/>
+		<path class="st1" d="M106.5,129.7h10.1l0,2.6h-6.9v3.4h6.3v2.6h-6.3v5.3h-3.2V129.7z"/>
+		<path class="st1" d="M120.9,128.7c0.3,0.3,0.5,0.7,0.5,1.2s-0.2,0.9-0.5,1.2c-0.3,0.3-0.7,0.5-1.2,0.5c-0.5,0-0.9-0.2-1.2-0.5
+			c-0.3-0.3-0.5-0.7-0.5-1.2c0-0.5,0.2-0.9,0.5-1.2c0.3-0.3,0.7-0.5,1.2-0.5C120.1,128.2,120.5,128.3,120.9,128.7z M118.1,133h3.1
+			v10.8h-3.1V133z"/>
+	</g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+</svg>

openapi/ow_or_ameriband.yaml

@@ -0,0 +1,268 @@
+openapi: 3.0.1
+info:
+  title: OpenWiFi Open roaming Ameriband Provisioning Model
+  description: Registration of an OpenRoaming profile with Ameriband for TIP OpenWifi.
+  version: 1.0.0
+  license:
+    name: BSD3
+    url: https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/master/LICENSE
+
+servers:
+  - url: 'https://tip.regiatration.ameriband.com:8001/api/v1'
+
+security:
+  - bearerAuth: []
+
+components:
+  securitySchemes:
+    bearerAuth:
+      type: http
+      scheme: bearer
+
+  responses:
+    NotFound:
+      description: The specified resource was not found.
+      content:
+        application/json:
+          schema:
+            properties:
+              ErrorCode:
+                type: integer
+              ErrorDetails:
+                type: string
+              ErrorDescription:
+                type: string
+
+    Unauthorized:
+      description: The requested does not have sufficient rights to perform the operation.
+      content:
+        application/json:
+          schema:
+            properties:
+              ErrorCode:
+                type: integer
+                enum:
+                  - 0     # Success
+                  - 8     # INVALID_TOKEN
+                  - 9     # EXPIRED_TOKEN
+              ErrorDetails:
+                type: string
+              ErrorDescription:
+                type: string
+
+    Success:
+      description: The requested operation was performed.
+      content:
+        application/json:
+          schema:
+            properties:
+              Operation:
+                type: string
+              Details:
+                type: string
+              Code:
+                type: integer
+
+    BadRequest:
+      description: The requested operation failed.
+      content:
+        application/json:
+          schema:
+            properties:
+              ErrorCode:
+                type: integer
+              ErrorDetails:
+                type: string
+              ErrorDescription:
+                type: integer
+
+  schemas:
+    RegistrationRequest:
+      type: object
+      properties:
+        orgRequestId:
+          type: string
+          format: uuid
+          minLength: 36
+          maxLength: 36
+          example:
+            Client will generate a UUID that must be returned in the response.
+        orgAcceptedTermsAndConditions:
+          type: boolean
+          default: false
+        orgLegalName:
+          type: string
+          minLength: 1
+        orgWebSite:
+          type: string
+          format: url
+          minLength: 1
+        orgContact:
+          type: string
+          minLength: 1
+          example:
+            John Smith
+        orgEmail:
+          type: string
+          format: email
+          minLength: 1
+        orgPhone:
+          type: string
+          example:
+            (607)555-1234 or +1(223)555-1222
+        orgLocation:
+          type: string
+          example:
+            Boston, NH - LA, CA
+        orgCertificate:
+          type: string
+          minLength: 1
+          example:
+            This must be the entire PEM file content of the certificate, encoded using base64
+
+    RegistrationResponse:
+      type: object
+      properties:
+        orgRequestId:
+          type: string
+          format: uuid
+          minLength: 36
+          maxLength: 36
+          example:
+            This should be the same orgRequestId passed during registration.
+        orgNASID:
+          type: string
+          minLength: 10
+          description:
+            This is the NASID generated by Ameriband. It will be used by the operator as NASID when contacting Ameriband.
+        ameribandCertificate:
+          type: string
+          minLength: 1
+          example:
+            This must be the entire PEM file content of the certificate, encoded using base64
+
+    RegistrationInformationRequest:
+      type: object
+      properties:
+        link:
+          description: This should be the link where a potential registrant can read the terms and conditions of registering with Ameriband.
+          type: string
+          format: url
+          minLength: 1
+          example:
+            https://ameriband.com/romain-registration.html
+
+paths:
+  /termsAndConditions:
+    get:
+      summary: The registrant must be given a chance to view the terms and conditions of the relationship they are entering into
+      operationId: getTermsAndConditions
+      responses:
+        200:
+          description: Sucessfully retrieved Terms and Conditions
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/RegistrationInformationRequest'
+        404:
+          $ref: '#/components/responses/Unauthorized'
+
+  /registration:
+    get:
+      tags:
+        - Registration
+      operationId: getRegistrationInformation
+      summary: This should return the information from a registration based on the NASID
+      parameters:
+        - in: query
+          name: orgNASID
+          schema:
+            type: string
+          required: true
+          example:
+            This is the orgNASID returned during registration.
+      responses:
+        200:
+          $ref: '#/components/schemas/RegistrationResponse'
+        403:
+          $ref: '#/components/responses/Unauthorized'
+        404:
+          $ref: '#/components/responses/NotFound'
+
+    post:
+      summary: Called when the registrant ahs read the T&Cs and iw willing to submit their information to enter in a partnership
+      tags:
+        - Registration
+      operationId: createRegistration
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/RegistrationRequest'
+      responses:
+        200:
+          description: Succesfully registered
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/RegistrationResponse'
+        400:
+          description: Registration failed due to  missing or incomplete information
+          $ref: '#/components/responses/BadRequest'
+        403:
+          $ref: '#/components/responses/Unauthorized'
+
+    put:
+      summary: Called when the registrant needs to update its information with Ameriband. The does not generate a new NASID.
+      tags:
+        - Registration
+      operationId: updateRegistration
+      parameters:
+        - in: query
+          name: orgNASID
+          schema:
+            type: string
+          required: true
+          example:
+            This is the orgNASID returned during registration.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/RegistrationRequest'
+      responses:
+        200:
+          description: Succesfully found the information based on the orgNASID
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/RegistrationResponse'
+        400:
+          $ref: '#/components/responses/BadRequest'
+        403:
+          $ref: '#/components/responses/Unauthorized'
+        404:
+          $ref: '#/components/responses/NotFound'
+
+    delete:
+      tags:
+        - Registration
+      summary: When a registrant wants to terminate a relationship with Ameriband. Ameriband should also delete all information from the registrant
+      operationId: deleteRegistration
+      parameters:
+        - in: query
+          name: orgNASID
+          schema:
+            type: string
+          required: true
+          example:
+            This is the orgNASID returned during registration.
+      responses:
+        204:
+          $ref: '#/components/responses/Success'
+        403:
+          $ref: '#/components/responses/Unauthorized'
+        404:
+          $ref: '#/components/responses/NotFound'

openapi/rrm_provider.yaml

@@ -0,0 +1,174 @@
+openapi: 3.0.1
+info:
+  title: OpenWiFi RRM Provider Model
+  description: Definitions and APIs to manages an OpenWiFi RRM Providers.
+  version: 1.0.0
+  license:
+    name: BSD3
+    url: https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/master/LICENSE
+
+servers:
+  - url: 'https://localhost:16022/api/v1'
+
+security:
+  - bearerAuth: []
+  - ApiKeyAuth: []
+
+components:
+  securitySchemes:
+    ApiKeyAuth:
+      type: apiKey
+      in: header
+      name: X-API-KEY
+    bearerAuth:
+      type: http
+      scheme: bearer
+      bearerFormat: JWT
+
+  responses:
+    NotFound:
+      $ref: 'https://github.com/Telecominfraproject/wlan-cloud-ucentralsec/blob/main/openpapi/owsec.yaml#/components/responses/NotFound'
+    Unauthorized:
+      $ref: 'https://github.com/Telecominfraproject/wlan-cloud-ucentralsec/blob/main/openpapi/owsec.yaml#/components/responses/Unauthorized'
+    Success:
+      $ref: 'https://github.com/Telecominfraproject/wlan-cloud-ucentralsec/blob/main/openpapi/owsec.yaml#/components/responses/Success'
+    BadRequest:
+      $ref: 'https://github.com/Telecominfraproject/wlan-cloud-ucentralsec/blob/main/openpapi/owsec.yaml#/components/responses/BadRequest'
+
+  schemas:
+
+    Provider:
+      type: object
+      properties:
+        vendor:
+          description: The name of the vendor for display.
+          type: string
+          minLength: 1
+          maxLength: 128
+        vendorShortname:
+          description: A shortname for the vendor. Only letters and numbers are allowed. This is the name used internally.
+          type: string
+          minLength: 4
+          maxLength: 16
+        version:
+          description: An identifier that will help users identify the version of the RRM module they are using.
+          type: string
+        about:
+          description: A link to the Vendor page for this RRM Module
+          type: string
+
+
+    Algorithm:
+      type: object
+      properties:
+        name:
+          description: A display for this algorithm.
+          type: string
+          minLength: 1
+          maxLength: 128
+        description:
+          description: A description of the algorithm.
+          type: string
+        shortName:
+          description: This is the name used internally.
+          type: string
+          minLength: 4
+          maxLength: 16
+        parameterFormat:
+          description: this is a Regex used to validate the input. If this is empty, no validation will be performed.
+          type: string
+        parameterSamples:
+          description: These samples will be displayed in the UI to the user trying to configure the options
+          type: array
+          items:
+            type: string
+        helper:
+          description: A link to a web page or PDF document explaining the algorithm and its parameters
+          type: string
+
+    Algorithms:
+      description: The list of all algorithms supported by the vendor
+      type: array
+      items:
+        $ref: '#/components/schemas/Algorithm'
+
+paths:
+  /provider:
+    get:
+      tags:
+        - RRM
+      operationId: getProvider
+      summary: Retrieve information about the provider for this RRM Module
+      responses:
+        200:
+          $ref: '#/components/schemas/Provider'
+        400:
+          $ref: '#/components/responses/BadRequest'
+        403:
+          $ref: '#/components/responses/Unauthorized'
+        404:
+          $ref: '#/components/responses/NotFound'
+
+  /algorithms:
+    get:
+      tags:
+        - RRM
+      operationId: getAlgorithms
+      summary: Retrieve a lists of algorithms supported in the module.
+      responses:
+        200:
+          $ref: '#/components/schemas/Algorithms'
+        400:
+          $ref: '#/components/responses/BadRequest'
+        403:
+          $ref: '#/components/responses/Unauthorized'
+        404:
+          $ref: '#/components/responses/NotFound'
+
+  /runRRM:
+    put:
+      tags:
+        - RRM
+      operationId: runRRMNow
+      summary: Run a specific or default RRM algorithm. The UI user or CLI user will have the ability to run an algorithm on demand.
+      parameters:
+        - in: query
+          description:
+          name: venue
+          schema:
+            type: string
+            format: uuid
+          required: true
+        - in: query
+          description: Perform RRM without updating anything. This may be used by an admin to see what RRM would do.
+          name: mock
+          schema:
+            type: boolean
+            default: false
+          required: false
+        - in: query
+          description: Specify the RRM algorithm to use. If omitted, select the default algorithm.
+          schema:
+            type: string
+          required: false
+        - in: query
+          description: Specify the parameters to use with the RRM algorithm to use. If omitted, select the default parameters.
+          schema:
+            type: string
+          required: false
+      responses:
+        200:
+          description: Return the list of actions that were or would be performed.
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: string
+        400:
+          $ref: '#/components/responses/BadRequest'
+        403:
+          $ref: '#/components/responses/Unauthorized'
+        404:
+          $ref: '#/components/responses/NotFound'
+

owprov.properties

@@ -34,9 +34,11 @@ openwifi.system.uri.private = https://localhost:17005
 openwifi.system.uri.public = https://ucentral.dpaas.arilia.com:16005
 openwifi.system.commandchannel = /tmp/app.owprov
 openwifi.system.uri.ui = owprov-ui.arilia.com
+openwifi.security.restapi.disable = false
 
 firmware.updater.upgrade = false
 firmware.updater.releaseonly = false
+rrm.default = false;
 
 geocodeapi = google
 google.apikey = **********************************
@@ -65,6 +67,13 @@ openwifi.kafka.enable = true
 openwifi.kafka.brokerlist = a1.arilia.com:9092
 openwifi.kafka.auto.commit = false
 openwifi.kafka.queue.buffering.max.ms = 50
+openwifi.kafka.ssl.ca.location =
+openwifi.kafka.ssl.certificate.location =
+openwifi.kafka.ssl.key.location =
+openwifi.kafka.ssl.key.password =
+
+signup.graceperiod = 3600
+signup.lingerperiod = 84400
 
 #
 # This section select which form of persistence you need
@@ -107,4 +116,4 @@ storage.type.mysql.connectiontimeout = 60
 ########################################################################
 logging.type = file
 logging.path = $OWPROV_ROOT/logs
-logging.level = debug
+logging.level = debug

owprov.properties.tmpl

@@ -39,6 +39,7 @@ openwifi.system.uri.private = ${SYSTEM_URI_PRIVATE}
 openwifi.system.uri.public = ${SYSTEM_URI_PUBLIC}
 openwifi.system.commandchannel = /tmp/app.ucentralfms
 openwifi.system.uri.ui = ${SYSTEM_URI_UI}
+openwifi.security.restapi.disable = ${SECURITY_RESTAPI_DISABLE}
 
 #############################
 # Generic information for all micro services
@@ -58,6 +59,10 @@ openwifi.kafka.enable = ${KAFKA_ENABLE}
 openwifi.kafka.brokerlist = ${KAFKA_BROKERLIST}
 openwifi.kafka.auto.commit = false
 openwifi.kafka.queue.buffering.max.ms = 50
+openwifi.kafka.ssl.ca.location = ${KAFKA_SSL_CA_LOCATION}
+openwifi.kafka.ssl.certificate.location = ${KAFKA_SSL_CERTIFICATE_LOCATION}
+openwifi.kafka.ssl.key.location = ${KAFKA_SSL_KEY_LOCATION}
+openwifi.kafka.ssl.key.password = ${KAFKA_SSL_KEY_PASSWORD}
 
 #
 # This section select which form of persistence you need

src/APConfig.cpp

@@ -5,257 +5,374 @@
 #include "APConfig.h"
 #include "StorageService.h"
 
+#include "Poco/JSON/Parser.h"
+#include "Poco/StringTokenizer.h"
+#include "fmt/format.h"
+
 namespace OpenWifi {
 
-    APConfig::APConfig(const std::string &SerialNumber, const std::string &DeviceType, Poco::Logger &L, bool Explain)
-        :   SerialNumber_(SerialNumber),
-            DeviceType_(DeviceType),
-            Logger_(L),
-            Explain_(Explain)
-    {}
+	APConfig::APConfig(const std::string &SerialNumber, const std::string &DeviceType,
+					   Poco::Logger &L, bool Explain)
+		: SerialNumber_(SerialNumber), DeviceType_(DeviceType), Logger_(L), Explain_(Explain) {}
 
-    bool APConfig::FindRadio(const std::string &Band, const Poco::JSON::Array::Ptr &Arr, Poco::JSON::Object::Ptr & Radio) {
-        for(const auto &i:*Arr) {
-            auto R = i.extract<Poco::JSON::Object::Ptr>();
-            if(R->has("band") && R->get("band").toString()==Band) {
-                Radio = R;
-                return true;
-            }
-        }
-        return false;
-    }
+	APConfig::APConfig(const std::string &SerialNumber, Poco::Logger &L)
+		: SerialNumber_(SerialNumber), Logger_(L) {
+		Explain_ = false;
+		Sub_ = true;
+	}
 
-    bool APConfig::RemoveBand(const std::string &Band, const Poco::JSON::Array::Ptr &A_in,Poco::JSON::Array::Ptr &A_Out) {
-        for(const auto &i:*A_in) {
-            auto R = i.extract<Poco::JSON::Object::Ptr>();
-            if(R->has("band") && R->get("band").toString()==Band) {
-            } else {
-                A_Out->add(i);
-            }
-        }
-        return false;
-    }
+	bool APConfig::FindRadio(const std::string &Band, const Poco::JSON::Array::Ptr &Arr,
+							 Poco::JSON::Object::Ptr &Radio) {
+		for (const auto &i : *Arr) {
+			auto R = i.extract<Poco::JSON::Object::Ptr>();
+			if (R->has("band") && R->get("band").toString() == Band) {
+				Radio = R;
+				return true;
+			}
+		}
+		return false;
+	}
 
-    static void ShowJSON(const char *S, const Poco::JSON::Object::Ptr &Obj) {
-        /*
-        std::stringstream O;
-        Poco::JSON::Stringifier::stringify(Obj,O);
-        std::cout << S << ":" << std::endl;
-        std::cout << ">>>" << std::endl << O.str() << std::endl << "<<<" << std::endl;
-         */
-    }
+	bool APConfig::RemoveBand(const std::string &Band, const Poco::JSON::Array::Ptr &A_in,
+							  Poco::JSON::Array::Ptr &A_Out) {
+		for (const auto &i : *A_in) {
+			auto R = i.extract<Poco::JSON::Object::Ptr>();
+			if (R->has("band") && R->get("band").toString() == Band) {
+			} else {
+				A_Out->add(i);
+			}
+		}
+		return false;
+	}
 
-    bool APConfig::mergeArray(const std::string &K, const Poco::JSON::Array::Ptr &A , const Poco::JSON::Array::Ptr &B, Poco::JSON::Array &Arr) {
-        if(K=="radios") {
-            auto BB=Poco::makeShared<Poco::JSON::Array>();
-            BB = B;
-            for(const auto &i:*A) {
-                auto A_Radio = i.extract<Poco::JSON::Object::Ptr>();
-                // std::cout << "Radio A:" << std::endl;
-                // ShowJSON(A_Radio);
-                if(A_Radio->has("band")) {
-                    std::string Band = A_Radio->get("band").toString();
-                    // std::cout << "Looking for band: " << Band << std::endl;
-                    auto B_Radio=Poco::makeShared<Poco::JSON::Object>();
-                    if(FindRadio(Band,B,B_Radio)) {
-                        ShowJSON("Data to be merged", B_Radio);
-                        auto RR = Poco::makeShared<Poco::JSON::Object>();
-                        merge(A_Radio, B_Radio,RR);
-                        ShowJSON("Merged data", RR);
-                        auto CC = Poco::makeShared<Poco::JSON::Array>();
-                        RemoveBand(Band, BB, CC );
-                        BB = CC;
-                        Arr.add(RR);
-                    } else {
-                        Arr.add(A_Radio);
-                    }
-                }
-            }
-            for(const auto &i:*BB)
-                Arr.add(i);
-        } else {
-            Arr = *A;
-        }
-        return true;
-    }
+	[[maybe_unused]] static void ShowJSON([[maybe_unused]] const char *S,
+										  [[maybe_unused]] const Poco::JSON::Object::Ptr &Obj) {
+		/*
+		std::stringstream O;
+		Poco::JSON::Stringifier::stringify(Obj,O);
+		std::cout << S << ":" << std::endl;
+		std::cout << ">>>" << std::endl << O.str() << std::endl << "<<<" << std::endl;
+		 */
+	}
 
-    bool APConfig::merge(const Poco::JSON::Object::Ptr & A, const Poco::JSON::Object::Ptr & B, Poco::JSON::Object::Ptr &C) {
-        for(const auto &i:*A) {
-            const std::string & K = i.first;
-            //  std::cout << "KEY: " << K << std::endl;
-            if(B->has(K)) {
-                if(A->isArray(K)) {
-                    //  std::cout << "ISARRAY" << std::endl;
-                    if(B->isArray(K)) {
-                        Poco::JSON::Array   Arr;
-                        auto AR1=A->getArray(K);
-                        auto AR2=B->getArray(K);
-                        mergeArray(K,AR1,AR2,Arr);
-                        C->set(K,Arr);
-                    } else {
-                        C->set(K,A->getArray(K));
-                    }
-                }
-                else if(A->isObject(K) && B->isObject(K)) {
-                    //  std::cout << "ISOBJECT" << std::endl;
-                    auto R=Poco::makeShared<Poco::JSON::Object>();
-                    merge(A->getObject(K),B->getObject(K),R);
-                    C->set(K,R);
-                }
-                else {
-                    C->set(K,i.second);
-                }
-            } else {
-                C->set(K,i.second);
-            }
-        }
+	bool APConfig::ReplaceVariablesInObject(const Poco::JSON::Object::Ptr &Original,
+											Poco::JSON::Object::Ptr &Result) {
+		// get all the names and expand
+		auto Names = Original->getNames();
+		for (const auto &i : Names) {
+			if (i == "__variableBlock") {
+				if (Original->isArray(i)) {
+					auto UUIDs = Original->getArray(i);
+					for (const auto &uuid : *UUIDs) {
+						ProvObjects::VariableBlock VB;
+						if (StorageService()->VariablesDB().GetRecord("id", uuid, VB)) {
+							for (const auto &var : VB.variables) {
+								Poco::JSON::Parser P;
+								auto VariableBlockInfo =
+									P.parse(var.value).extract<Poco::JSON::Object::Ptr>();
+								auto VarNames = VariableBlockInfo->getNames();
+								for (const auto &j : VarNames) {
+									Result->set(j, VariableBlockInfo->get(j));
+								}
+							}
+						}
+					}
+				}
+			} else if (Original->isArray(i)) {
+				auto Arr = Poco::makeShared<Poco::JSON::Array>();
+				auto Obj = Original->getArray(i);
+				ReplaceVariablesInArray(Obj, Arr);
+				Result->set(i, Arr);
+			} else if (Original->isObject(i)) {
+				auto Expanded = Poco::makeShared<Poco::JSON::Object>();
+				auto Obj = Original->getObject(i);
+				ReplaceVariablesInObject(Obj, Expanded);
+				Result->set(i, Expanded);
+			} else {
+				Result->set(i, Original->get(i));
+			}
+		}
+		return true;
+	}
 
-        for(const auto &i:*B) {
-            const std::string & K = i.first;
-            if(!A->has(K)) {
-                // std::cout << "Before leave" << std::endl;
-                // ShowJSON(C);
-                C->set(K, i.second);
-                // std::cout << "After leave" << std::endl;
-                // ShowJSON(C);
-            }
-        }
+	bool APConfig::ReplaceVariablesInArray(const Poco::JSON::Array::Ptr &Original,
+										   Poco::JSON::Array::Ptr &ResultArray) {
 
-        return true;
-    }
+		for (const auto &element : *Original) {
 
-    bool APConfig::Get(Poco::JSON::Object::Ptr &Configuration) {
-        if(Config_.empty()) {
-            Explanation_.clear();
-            try {
-                ProvObjects::InventoryTag   D;
-                if(StorageService()->InventoryDB().GetRecord("serialNumber", SerialNumber_, D)) {
-                    if(!D.deviceConfiguration.empty()) {
-                        AddConfiguration(D.deviceConfiguration);
-                    }
-                    if(!D.entity.empty()) {
-                        AddEntityConfig(D.entity);
-                    } else if(!D.venue.empty()) {
-                        AddVenueConfig(D.venue);
-                    }
-                }
-                //  Now we have all the config we need.
-            } catch (const Poco::Exception &E ) {
-                Logger_.log(E);
-            }
-        }
+			if (element.isArray()) {
+				auto Expanded = Poco::makeShared<Poco::JSON::Array>();
+				const auto &Object = element.extract<Poco::JSON::Array::Ptr>();
+				ReplaceVariablesInArray(Object, Expanded);
+				ResultArray->add(Expanded);
+			} else if (element.isStruct()) {
+				auto Expanded = Poco::makeShared<Poco::JSON::Object>();
+				const auto &Object = element.extract<Poco::JSON::Object::Ptr>();
+				ReplaceVariablesInObject(Object, Expanded);
+				ResultArray->add(Expanded);
+			} else if (element.isString() || element.isNumeric() || element.isBoolean() ||
+					   element.isInteger() || element.isSigned()) {
+				ResultArray->add(element);
+			} else {
+				auto Expanded = Poco::makeShared<Poco::JSON::Object>();
+				const auto &Object = element.extract<Poco::JSON::Object::Ptr>();
+				ReplaceVariablesInObject(Object, Expanded);
+				ResultArray->add(Expanded);
+			}
+		}
+		return true;
+	}
 
-        //  So we have sections...
-        //      interfaces
-        //      metrics
-        //      radios
-        //      services
-        //      globals
-        //      unit
-        auto Tmp=Poco::makeShared<Poco::JSON::Object>();
-        std::set<std::string>   Sections;
-        for(const auto &i:Config_) {
-            ShowJSON("Iteration Start:", Tmp);
-            Poco::JSON::Parser  P;
-            auto O = P.parse(i.element.configuration).extract<Poco::JSON::Object::Ptr>();
-            auto Names = O->getNames();
-            auto SectionInfo = O->get(Names[0]);
-            auto InsertInfo = Sections.insert(Names[0]);
-            if(InsertInfo.second) {
-                if(Explain_) {
-                    Poco::JSON::Object  ExObj;
-                    ExObj.set("from-uuid", i.info.id);
-                    ExObj.set("from-name", i.info.name);
-                    ExObj.set("action", "added");
-                    ExObj.set("element",SectionInfo);
-                    Explanation_.add(ExObj);
-                }
-                Tmp->set(Names[0],O->get(Names[0]));
-            } else {
-                if(Explain_) {
-                    Poco::JSON::Object  ExObj;
-                    ExObj.set("from-uuid", i.info.id);
-                    ExObj.set("from-name", i.info.name);
-                    ExObj.set("action", "ignored");
-                    ExObj.set("reason","weight insufficient");
-                    ExObj.set("element",SectionInfo);
-                    Explanation_.add(ExObj);
-                }
-            }
-        }
-        Configuration = Tmp;
-        if(Config_.empty())
-            return false;
+	bool APConfig::Get(Poco::JSON::Object::Ptr &Configuration) {
+		if (Config_.empty()) {
+			Explanation_.clear();
+			try {
+				if (!Sub_) {
+					ProvObjects::InventoryTag D;
+					if (StorageService()->InventoryDB().GetRecord("serialNumber", SerialNumber_,
+																  D)) {
+						if (!D.deviceConfiguration.empty()) {
+							// std::cout << "Adding device specific configuration: " << D.deviceConfiguration.size() << std::endl;
+							AddConfiguration(D.deviceConfiguration);
+						} else {
+							// std::cout << "No device specific configuration." << std::endl;
+						}
+						if (!D.entity.empty()) {
+							AddEntityConfig(D.entity);
+						} else if (!D.venue.empty()) {
+							AddVenueConfig(D.venue);
+						}
+					}
+				} else {
+					ProvObjects::SubscriberDevice D;
+					if (StorageService()->SubscriberDeviceDB().GetRecord("serialNumber",
+																		 SerialNumber_, D)) {
+						if (!D.configuration.empty()) {
+							AddConfiguration(D.configuration);
+						}
+					}
+				}
+				//  Now we have all the config we need.
+			} catch (const Poco::Exception &E) {
+				Logger_.log(E);
+			}
+		}
 
-        return true;
-    }
+		try {
+			std::set<std::string> Sections;
+			for (const auto &i : Config_) {
+				Poco::JSON::Parser P;
+				auto O = P.parse(i.element.configuration).extract<Poco::JSON::Object::Ptr>();
+				auto Names = O->getNames();
+				for (const auto &SectionName : Names) {
+					auto InsertInfo = Sections.insert(SectionName);
+					if (InsertInfo.second) {
+						if (O->isArray(SectionName)) {
+							auto OriginalArray = O->getArray(SectionName);
+							if (Explain_) {
+								Poco::JSON::Object ExObj;
+								ExObj.set("from-uuid", i.info.id);
+								ExObj.set("from-name", i.info.name);
+								ExObj.set("action", "added");
+								ExObj.set("element", OriginalArray);
+								Explanation_.add(ExObj);
+							}
+							auto ExpandedArray = Poco::makeShared<Poco::JSON::Array>();
+							ReplaceVariablesInArray(OriginalArray, ExpandedArray);
+							Configuration->set(SectionName, ExpandedArray);
+						} else if (O->isObject(SectionName)) {
+							auto OriginalSection =
+								O->get(SectionName).extract<Poco::JSON::Object::Ptr>();
+							if (Explain_) {
+								Poco::JSON::Object ExObj;
+								ExObj.set("from-uuid", i.info.id);
+								ExObj.set("from-name", i.info.name);
+								ExObj.set("action", "added");
+								ExObj.set("element", OriginalSection);
+								Explanation_.add(ExObj);
+							}
+							auto ExpandedSection = Poco::makeShared<Poco::JSON::Object>();
+							ReplaceVariablesInObject(OriginalSection, ExpandedSection);
+							Configuration->set(SectionName, ExpandedSection);
+						} else {
+                            poco_warning(Logger(), fmt::format("Unknown config element type: {}",O->get(SectionName).toString()));
+						}
+					} else {
+						if (Explain_) {
+							Poco::JSON::Object ExObj;
+							ExObj.set("from-uuid", i.info.id);
+							ExObj.set("from-name", i.info.name);
+							ExObj.set("action", "ignored");
+							ExObj.set("reason", "weight insufficient");
+							ExObj.set("element", O->get(SectionName));
+							Explanation_.add(ExObj);
+						}
+					}
+				}
+			}
 
-    static bool DeviceTypeMatch(const std::string &DeviceType, const Types::StringVec & Types) {
-        for(const auto &i:Types) {
-            if(i=="*" || Poco::icompare(DeviceType,i)==0)
-                return true;
-        }
-        return false;
-    }
+			//  Apply overrides...
+			ProvObjects::ConfigurationOverrideList COL;
+			if (StorageService()->OverridesDB().GetRecord("serialNumber", SerialNumber_, COL)) {
+				for (const auto &col : COL.overrides) {
+					const auto Tokens = Poco::StringTokenizer(col.parameterName, ".");
+					if (Tokens[0] == "radios" && Tokens.count() == 3) {
+						std::uint64_t RadioIndex = std::strtoull(Tokens[1].c_str(), nullptr, 10);
+						if (RadioIndex < MaximumPossibleRadios) {
+							auto RadioArray = Configuration->getArray("radios");
+							if (RadioIndex < RadioArray->size()) {
+								auto IndexedRadio =
+									RadioArray->get(RadioIndex).extract<Poco::JSON::Object::Ptr>();
+								if (Tokens[2] == "tx-power") {
+									IndexedRadio->set(
+										"rx-power",
+										std::strtoull(col.parameterValue.c_str(), nullptr, 10));
+									if (Explain_) {
+										Poco::JSON::Object ExObj;
+										ExObj.set("from-name", "overrides");
+										ExObj.set("override", col.parameterName);
+										ExObj.set("source", col.source);
+										ExObj.set("reason", col.reason);
+										ExObj.set("value", col.parameterValue);
+										Explanation_.add(ExObj);
+									}
+									RadioArray->set(RadioIndex, IndexedRadio);
+									Configuration->set("radios", RadioArray);
+								} else if (Tokens[2] == "channel") {
+									if (col.parameterValue == "auto") {
+										IndexedRadio->set("channel", "auto");
+									} else {
+										IndexedRadio->set(
+											"channel",
+											std::strtoull(col.parameterValue.c_str(), nullptr, 10));
+									}
+									// std::cout << "Setting channel in radio " << RadioIndex << std::endl;
+									if (Explain_) {
+										Poco::JSON::Object ExObj;
+										ExObj.set("from-name", "overrides");
+										ExObj.set("override", col.parameterName);
+										ExObj.set("source", col.source);
+										ExObj.set("reason", col.reason);
+										ExObj.set("value", col.parameterValue);
+										Explanation_.add(ExObj);
+									}
+									RadioArray->set(RadioIndex, IndexedRadio);
+									Configuration->set("radios", RadioArray);
+								} else {
+									poco_error(
+										Logger(),
+										fmt::format("{}: Unsupported override variable name {}",
+													col.parameterName));
+								}
+							}
+						} else {
+							poco_error(Logger(), fmt::format("{}: radio index out of range in {}",
+															 col.parameterName));
+						}
+					} else {
+						poco_error(Logger(),
+								   fmt::format("{}: Unsupported override variable name {}",
+											   col.parameterName));
+					}
+				}
+			}
+		} catch (...) {
+		}
+		return !Config_.empty();
+	}
 
-    void APConfig::AddConfiguration(const Types::UUIDvec_t &UUIDs) {
-        for(const auto &i:UUIDs)
-            AddConfiguration(i);
-    }
+	static bool DeviceTypeMatch(const std::string &DeviceType, const Types::StringVec &Types) {
+		for (const auto &i : Types) {
+			if (i == "*" || Poco::icompare(DeviceType, i) == 0)
+				return true;
+		}
+		return false;
+	}
 
-    void APConfig::AddConfiguration(const std::string &UUID) {
+	void APConfig::AddConfiguration(const ProvObjects::DeviceConfigurationElementVec &Elements) {
+		for (const auto &i : Elements) {
+			if (i.weight == 0) {
+				VerboseElement VE{.element = i, .info = ProvObjects::ObjectInfo{}};
+				Config_.push_back(VE);
+			} else {
+				// we need to insert after everything bigger or equal
+				auto Hint = std::lower_bound(Config_.cbegin(), Config_.cend(), i.weight,
+											 [](const VerboseElement &Elem, uint64_t Value) {
+												 return Elem.element.weight >= Value;
+											 });
+				VerboseElement VE{.element = i, .info = ProvObjects::ObjectInfo{}};
+				Config_.insert(Hint, VE);
+			}
+		}
+	}
 
-        ProvObjects::DeviceConfiguration    Config;
-        if(UUID.empty())
-            return;
+	void APConfig::AddConfiguration(const Types::UUIDvec_t &UUIDs) {
+		for (const auto &i : UUIDs)
+			AddConfiguration(i);
+	}
 
-        if(StorageService()->ConfigurationDB().GetRecord("id", UUID,Config)) {
-            //  find where to insert into this list using the weight.
-            if(!Config.configuration.empty()) {
-                if(DeviceTypeMatch(DeviceType_,Config.deviceTypes)) {
-                    for(const auto &i:Config.configuration) {
-                        if(i.weight==0) {
-                            VerboseElement  VE{ .element = i, .info = Config.info};
-                            Config_.push_back(VE);
-                        } else {
-                            // we need to insert after everything bigger or equal
-                            auto Hint = std::lower_bound(Config_.cbegin(),Config_.cend(),i.weight,
-                                                         [](const VerboseElement &Elem, int Value) {
-                                return Elem.element.weight>=Value; });
-                            VerboseElement  VE{ .element = i, .info = Config.info};
-                            Config_.insert(Hint,VE);
-                        }
-                    }
-                } else {
-                    Poco::JSON::Object  ExObj;
-                    ExObj.set("from-uuid", Config.info.id);
-                    ExObj.set("from-name",Config.info.name );
-                    ExObj.set("action", "ignored");
-                    ExObj.set("reason", "deviceType mismatch");
-                    Explanation_.add(ExObj);
-                }
-            }
-        }
-    }
+	void APConfig::AddConfiguration(const std::string &UUID) {
+		if (UUID.empty())
+			return;
 
-    void APConfig::AddEntityConfig(const std::string &UUID) {
-        ProvObjects::Entity E;
-        if(StorageService()->EntityDB().GetRecord("id",UUID,E)) {
-            AddConfiguration(E.deviceConfiguration);
-            if(!E.parent.empty())
-                AddEntityConfig(E.parent);
-        }
-    }
+		ProvObjects::DeviceConfiguration Config;
+		if (StorageService()->ConfigurationDB().GetRecord("id", UUID, Config)) {
+			if (!Config.configuration.empty()) {
+				if (DeviceTypeMatch(DeviceType_, Config.deviceTypes)) {
+					for (const auto &i : Config.configuration) {
+						if (i.weight == 0) {
+							VerboseElement VE{.element = i, .info = Config.info};
+							Config_.push_back(VE);
+						} else {
+							// we need to insert after everything bigger or equal
+							auto Hint =
+								std::lower_bound(Config_.cbegin(), Config_.cend(), i.weight,
+												 [](const VerboseElement &Elem, uint64_t Value) {
+													 return Elem.element.weight >= Value;
+												 });
+							VerboseElement VE{.element = i, .info = Config.info};
+							Config_.insert(Hint, VE);
+						}
+					}
+				} else {
+					Poco::JSON::Object ExObj;
+					ExObj.set("from-uuid", Config.info.id);
+					ExObj.set("from-name", Config.info.name);
+					ExObj.set("action", "ignored");
+					ExObj.set("reason", "deviceType mismatch");
+					Explanation_.add(ExObj);
+				}
+			} else {
+				poco_error(Logger(),
+						   fmt::format("Device configuration for {} is empty.", SerialNumber_));
+			}
+		} else {
+			poco_error(Logger(),
+					   fmt::format("Invalid device configuration UUID for {}.", SerialNumber_));
+		}
+	}
 
-    void APConfig::AddVenueConfig(const std::string &UUID) {
-        ProvObjects::Venue V;
-        if(StorageService()->VenueDB().GetRecord("id",UUID,V)) {
-            AddConfiguration(V.deviceConfiguration);
-            if(!V.entity.empty()) {
-                AddEntityConfig(V.entity);
-            } else if(!V.parent.empty()) {
-                AddVenueConfig(V.parent);
-            }
-        }
-    }
-}
+	void APConfig::AddEntityConfig(const std::string &UUID) {
+		ProvObjects::Entity E;
+		if (StorageService()->EntityDB().GetRecord("id", UUID, E)) {
+			AddConfiguration(E.configurations);
+			if (!E.parent.empty()) {
+				AddEntityConfig(E.parent);
+			}
+		} else {
+		}
+	}
+
+	void APConfig::AddVenueConfig(const std::string &UUID) {
+		ProvObjects::Venue V;
+		if (StorageService()->VenueDB().GetRecord("id", UUID, V)) {
+			AddConfiguration(V.configurations);
+			if (!V.entity.empty()) {
+				AddEntityConfig(V.entity);
+			} else if (!V.parent.empty()) {
+				AddVenueConfig(V.parent);
+			}
+		} else {
+		}
+	}
+} // namespace OpenWifi

src/APConfig.h

@@ -4,43 +4,59 @@
 
 #pragma once
 
-#include <string>
 #include "Poco/Logger.h"
 #include "RESTObjects//RESTAPI_ProvObjects.h"
+#include <string>
 
 namespace OpenWifi {
 
-    struct VerboseElement {
-        ProvObjects::DeviceConfigurationElement     element;
-        ProvObjects::ObjectInfo                     info;
-    };
-    typedef std::vector<VerboseElement> ConfigVec;
+	constexpr std::uint64_t MaximumPossibleRadios = 6;
 
-    class APConfig {
-        public:
-            explicit APConfig(const std::string & SerialNumber, const std::string & DeviceType, Poco::Logger & L, bool Explain=false);
+	struct VerboseElement {
+		ProvObjects::DeviceConfigurationElement element;
+		ProvObjects::ObjectInfo info;
+	};
+	typedef std::vector<VerboseElement> ConfigVec;
 
+	class APConfig {
+	  public:
+		explicit APConfig(const std::string &SerialNumber, const std::string &DeviceType,
+						  Poco::Logger &L, bool Explain = false);
+		explicit APConfig(const std::string &SerialNumber, Poco::Logger &L);
 
-            [[nodiscard]] bool Get(Poco::JSON::Object::Ptr &Configuration);
+		[[nodiscard]] bool Get(Poco::JSON::Object::Ptr &Configuration);
 
-            void AddConfiguration(const std::string &UUID);
-            void AddConfiguration(const Types::UUIDvec_t &UUID);
-            void AddVenueConfig(const std::string &UUID);
-            void AddEntityConfig(const std::string &UUID);
-            const Poco::JSON::Array & Explanation() { return Explanation_; };
-        private:
-            std::string                 SerialNumber_;
-            std::string                 DeviceType_;
-            Poco::Logger                & Logger_;
-            std::string                 CompleteConfig_;
-            ConfigVec                   Config_;
-            Types::StringPairVec        Errors;
-            bool                        Explain_=false;
-            Poco::JSON::Array           Explanation_;
+		void AddConfiguration(const std::string &UUID);
+		void AddConfiguration(const Types::UUIDvec_t &UUID);
+		void AddConfiguration(const ProvObjects::DeviceConfigurationElementVec &Elements);
+		void AddVenueConfig(const std::string &UUID);
+		void AddEntityConfig(const std::string &UUID);
+		const Poco::JSON::Array &Explanation() { return Explanation_; };
 
-            bool FindRadio(const std::string &Band, const Poco::JSON::Array::Ptr &Arr, Poco::JSON::Object::Ptr & Radio);
-            bool mergeArray(const std::string &K, const Poco::JSON::Array::Ptr &A , const Poco::JSON::Array::Ptr &B, Poco::JSON::Array &Arr);
-            bool merge(const Poco::JSON::Object::Ptr & A, const Poco::JSON::Object::Ptr & B, Poco::JSON::Object::Ptr &C);
-            bool RemoveBand(const std::string &Band, const Poco::JSON::Array::Ptr &A_in,Poco::JSON::Array::Ptr &A_Out);
-    };
-}
+	  private:
+		std::string SerialNumber_;
+		std::string DeviceType_;
+		Poco::Logger &Logger_;
+		std::string CompleteConfig_;
+		ConfigVec Config_;
+		Types::StringPairVec Errors;
+		bool Explain_ = false;
+		Poco::JSON::Array Explanation_;
+		bool Sub_ = false;
+		Poco::Logger &Logger() { return Logger_; }
+
+		bool ReplaceVariablesInArray(const Poco::JSON::Array::Ptr &O,
+									 Poco::JSON::Array::Ptr &Result);
+		bool ReplaceVariablesInObject(const Poco::JSON::Object::Ptr &Original,
+									  Poco::JSON::Object::Ptr &Result);
+
+		bool FindRadio(const std::string &Band, const Poco::JSON::Array::Ptr &Arr,
+					   Poco::JSON::Object::Ptr &Radio);
+		bool mergeArray(const std::string &K, const Poco::JSON::Array::Ptr &A,
+						const Poco::JSON::Array::Ptr &B, Poco::JSON::Array &Arr);
+		bool merge(const Poco::JSON::Object::Ptr &A, const Poco::JSON::Object::Ptr &B,
+				   Poco::JSON::Object::Ptr &C);
+		bool RemoveBand(const std::string &Band, const Poco::JSON::Array::Ptr &A_in,
+						Poco::JSON::Array::Ptr &A_Out);
+	};
+} // namespace OpenWifi

src/AutoDiscovery.cpp

@@ -3,72 +3,87 @@
 //
 
 #include "AutoDiscovery.h"
-#include "framework/uCentral_Protocol.h"
-#include "framework/KafkaTopics.h"
+#include "Poco/JSON/Parser.h"
 #include "StorageService.h"
+#include "framework/KafkaManager.h"
+#include "framework/KafkaTopics.h"
+#include "framework/ow_constants.h"
 
 namespace OpenWifi {
 
-    int AutoDiscovery::Start() {
-        Running_ = true;
-        Types::TopicNotifyFunction F = [this](const std::string &Key, const std::string &Payload) { this->ConnectionReceived(Key,Payload); };
-        ConnectionWatcherId_ = KafkaManager()->RegisterTopicWatcher(KafkaTopics::CONNECTION, F);
-        Worker_.start(*this);
-        return 0;
-    };
+	int AutoDiscovery::Start() {
+		poco_information(Logger(), "Starting...");
+		Running_ = true;
+		Types::TopicNotifyFunction F = [this](const std::string &Key, const std::string &Payload) {
+			this->ConnectionReceived(Key, Payload);
+		};
+		ConnectionWatcherId_ = KafkaManager()->RegisterTopicWatcher(KafkaTopics::CONNECTION, F);
+		Worker_.start(*this);
+		return 0;
+	};
 
-    void AutoDiscovery::Stop() {
-        Running_ = false;
-        KafkaManager()->UnregisterTopicWatcher(KafkaTopics::CONNECTION, ConnectionWatcherId_);
-        Queue_.wakeUpAll();
-        Worker_.join();
-    };
+	void AutoDiscovery::Stop() {
+		poco_information(Logger(), "Stopping...");
+		Running_ = false;
+		KafkaManager()->UnregisterTopicWatcher(KafkaTopics::CONNECTION, ConnectionWatcherId_);
+		Queue_.wakeUpAll();
+		Worker_.join();
+		poco_information(Logger(), "Stopped...");
+	};
 
-    void AutoDiscovery::run() {
-        Poco::AutoPtr<Poco::Notification>	Note(Queue_.waitDequeueNotification());
-        while(Note && Running_) {
-            auto Msg = dynamic_cast<DiscoveryMessage *>(Note.get());
-            if(Msg!= nullptr) {
-                try {
-                    Poco::JSON::Parser Parser;
-                    auto Object = Parser.parse(Msg->Payload()).extract<Poco::JSON::Object::Ptr>();
+	void AutoDiscovery::run() {
+		Poco::AutoPtr<Poco::Notification> Note(Queue_.waitDequeueNotification());
+		Utils::SetThreadName("auto-discovery");
+		while (Note && Running_) {
+			auto Msg = dynamic_cast<DiscoveryMessage *>(Note.get());
+			if (Msg != nullptr) {
+				try {
+					Poco::JSON::Parser Parser;
+					auto Object = Parser.parse(Msg->Payload()).extract<Poco::JSON::Object::Ptr>();
 
-                    if (Object->has(uCentralProtocol::PAYLOAD)) {
-                        auto PayloadObj = Object->getObject(uCentralProtocol::PAYLOAD);
-                        std::string ConnectedIP, SerialNumber, DeviceType;
-                        if (PayloadObj->has(uCentralProtocol::CONNECTIONIP))
-                            ConnectedIP = PayloadObj->get(uCentralProtocol::CONNECTIONIP).toString();
-                        if (PayloadObj->has(uCentralProtocol::CAPABILITIES)) {
-                            auto CapObj = PayloadObj->getObject(uCentralProtocol::CAPABILITIES);
-                            if (CapObj->has(uCentralProtocol::COMPATIBLE)) {
-                                DeviceType = CapObj->get(uCentralProtocol::COMPATIBLE).toString();
-                                SerialNumber = PayloadObj->get(uCentralProtocol::SERIAL).toString();
-                            }
-                        } else if (PayloadObj->has(uCentralProtocol::PING)) {
-                            auto PingMessage = PayloadObj->getObject(uCentralProtocol::PING);
-                            if (PingMessage->has(uCentralProtocol::FIRMWARE) &&
-                                PingMessage->has(uCentralProtocol::SERIALNUMBER) &&
-                                PingMessage->has(uCentralProtocol::COMPATIBLE)) {
-                                if (PingMessage->has(uCentralProtocol::CONNECTIONIP))
-                                    ConnectedIP = PingMessage->get(uCentralProtocol::CONNECTIONIP).toString();
-                                SerialNumber = PingMessage->get(uCentralProtocol::SERIALNUMBER).toString();
-                                DeviceType = PingMessage->get(uCentralProtocol::COMPATIBLE).toString();
-                            }
-                        }
-                        if (!SerialNumber.empty()) {
-                            StorageService()->InventoryDB().CreateFromConnection(SerialNumber, ConnectedIP, DeviceType);
-                        }
-                    }
-                } catch (const Poco::Exception &E) {
-                    Logger().log(E);
-                } catch (...) {
+					if (Object->has(uCentralProtocol::PAYLOAD)) {
+						auto PayloadObj = Object->getObject(uCentralProtocol::PAYLOAD);
+						std::string ConnectedIP, SerialNumber, DeviceType;
+						if (PayloadObj->has(uCentralProtocol::CONNECTIONIP))
+							ConnectedIP =
+								PayloadObj->get(uCentralProtocol::CONNECTIONIP).toString();
+						if (PayloadObj->has(uCentralProtocol::CAPABILITIES)) {
+							auto CapObj = PayloadObj->getObject(uCentralProtocol::CAPABILITIES);
+							if (CapObj->has(uCentralProtocol::COMPATIBLE)) {
+								DeviceType = CapObj->get(uCentralProtocol::COMPATIBLE).toString();
+								SerialNumber = PayloadObj->get(uCentralProtocol::SERIAL).toString();
+							}
+						} else if (PayloadObj->has(uCentralProtocol::PING)) {
+							auto PingMessage = PayloadObj->getObject(uCentralProtocol::PING);
+							if (PingMessage->has(uCentralProtocol::FIRMWARE) &&
+								PingMessage->has(uCentralProtocol::SERIALNUMBER) &&
+								PingMessage->has(uCentralProtocol::COMPATIBLE)) {
+								if (PingMessage->has(uCentralProtocol::CONNECTIONIP))
+									ConnectedIP =
+										PingMessage->get(uCentralProtocol::CONNECTIONIP).toString();
+								SerialNumber =
+									PingMessage->get(uCentralProtocol::SERIALNUMBER).toString();
+								DeviceType =
+									PingMessage->get(uCentralProtocol::COMPATIBLE).toString();
+							}
+						}
+						std::string Locale;
+						if (PayloadObj->has("locale"))
+							Locale = PayloadObj->get("locale").toString();
 
-                }
-            } else {
+						if (!SerialNumber.empty()) {
+							StorageService()->InventoryDB().CreateFromConnection(
+								SerialNumber, ConnectedIP, DeviceType, Locale);
+						}
+					}
+				} catch (const Poco::Exception &E) {
+					Logger().log(E);
+				} catch (...) {
+				}
+			} else {
+			}
+			Note = Queue_.waitDequeueNotification();
+		}
+	}
 
-            }
-            Note = Queue_.waitDequeueNotification();
-        }
-    }
-
-}
+} // namespace OpenWifi

src/AutoDiscovery.h

@@ -4,53 +4,52 @@
 
 #pragma once
 
-#include "framework/MicroService.h"
 #include "framework/OpenWifiTypes.h"
+#include "framework/SubSystemServer.h"
+
+#include "Poco/Notification.h"
+#include "Poco/NotificationQueue.h"
 
 namespace OpenWifi {
 
-    class DiscoveryMessage : public Poco::Notification {
-        public:
-            explicit DiscoveryMessage(const std::string &Key, const std::string &Payload ) :
-                Key_(Key),
-                Payload_(Payload) {}
-            const std::string & Key() { return Key_; }
-            const std::string & Payload() { return Payload_; }
-        private:
-            std::string     Key_;
-            std::string     Payload_;
-    };
+	class DiscoveryMessage : public Poco::Notification {
+	  public:
+		explicit DiscoveryMessage(const std::string &Key, const std::string &Payload)
+			: Key_(Key), Payload_(Payload) {}
+		const std::string &Key() { return Key_; }
+		const std::string &Payload() { return Payload_; }
 
-    class AutoDiscovery : public SubSystemServer, Poco::Runnable {
-        public:
+	  private:
+		std::string Key_;
+		std::string Payload_;
+	};
 
-            static auto instance() {
-                static auto instance_ = new AutoDiscovery;
-                return instance_;
-            }
+	class AutoDiscovery : public SubSystemServer, Poco::Runnable {
+	  public:
+		static auto instance() {
+			static auto instance_ = new AutoDiscovery;
+			return instance_;
+		}
 
-            int Start() override;
-            void Stop() override;
-            void ConnectionReceived( const std::string & Key, const std::string & Payload) {
-                std::lock_guard G(Mutex_);
-                Logger().information(Poco::format("Device(%s): Connection/Ping message.", Key));
-                Queue_.enqueueNotification( new DiscoveryMessage(Key,Payload));
-            }
-            void run() override;
+		int Start() override;
+		void Stop() override;
+		void ConnectionReceived(const std::string &Key, const std::string &Payload) {
+			std::lock_guard G(Mutex_);
+			poco_trace(Logger(), Poco::format("Device(%s): Connection/Ping message.", Key));
+			Queue_.enqueueNotification(new DiscoveryMessage(Key, Payload));
+		}
+		void run() override;
 
-        private:
-            uint64_t                                ConnectionWatcherId_=0;
-            Poco::NotificationQueue                 Queue_;
-            Poco::Thread                            Worker_;
-            std::atomic_bool                        Running_=false;
+	  private:
+		uint64_t ConnectionWatcherId_ = 0;
+		Poco::NotificationQueue Queue_;
+		Poco::Thread Worker_;
+		std::atomic_bool Running_ = false;
 
-            AutoDiscovery() noexcept:
-                SubSystemServer("AutoDiscovery", "AUTO-DISCOVERY", "discovery")
-                {
-                }
-        };
+		AutoDiscovery() noexcept
+			: SubSystemServer("AutoDiscovery", "AUTO-DISCOVERY", "discovery") {}
+	};
 
-    inline auto AutoDiscovery() { return AutoDiscovery::instance(); }
-
-}
+	inline auto AutoDiscovery() { return AutoDiscovery::instance(); }
 
+} // namespace OpenWifi

src/ConfigSanityChecker.cpp

@@ -4,50 +4,44 @@
 
 #include "ConfigSanityChecker.h"
 #include "nlohmann/json.hpp"
-#include <iostream>
 #include <iomanip>
+#include <iostream>
 
 namespace OpenWifi {
 
-    bool ConfigSanityChecker::Check() {
-        try {
-            auto Doc = nlohmann::json::parse(Config_);
+	bool ConfigSanityChecker::Check() {
+		try {
+			auto Doc = nlohmann::json::parse(Config_);
 
-            for(const auto &[key,value]:Doc.items()) {
-                for(const auto &i:Funcs_)
-                    if(i.first==key)
-                        i.second(value);
-            }
-            return true;
-        } catch ( ... ) {
+			for (const auto &[key, value] : Doc.items()) {
+				for (const auto &i : Funcs_)
+					if (i.first == key)
+						i.second(value);
+			}
+			return true;
+		} catch (...) {
+		}
+		return false;
+	}
 
-        }
-        return false;
-    }
+	void ConfigSanityChecker::Check_radios([[maybe_unused]] nlohmann::json &d) {
+		std::cout << "Validating radios" << std::endl;
+	};
 
-    void ConfigSanityChecker::Check_radios(nlohmann::json &d) {
-        std::cout << "Validating radios" << std::endl;
+	void ConfigSanityChecker::Check_interfaces([[maybe_unused]] nlohmann::json &d) {
+		std::cout << "Validating interfaces" << std::endl;
+	};
 
-    };
+	void ConfigSanityChecker::Check_metrics([[maybe_unused]] nlohmann::json &d) {
+		std::cout << "Validating metrics" << std::endl;
+	};
 
-    void ConfigSanityChecker::Check_interfaces(nlohmann::json &d) {
-        std::cout << "Validating interfaces" << std::endl;
+	void ConfigSanityChecker::Check_services([[maybe_unused]] nlohmann::json &d) {
+		std::cout << "Validating services" << std::endl;
+	};
 
-    };
+	void ConfigSanityChecker::Check_uuid([[maybe_unused]] nlohmann::json &d) {
+		std::cout << "Validating uuid" << std::endl;
+	};
 
-    void ConfigSanityChecker::Check_metrics(nlohmann::json &d) {
-        std::cout << "Validating metrics" << std::endl;
-
-    };
-
-    void ConfigSanityChecker::Check_services(nlohmann::json &d) {
-        std::cout << "Validating services" << std::endl;
-
-    };
-
-    void ConfigSanityChecker::Check_uuid(nlohmann::json &d) {
-        std::cout << "Validating uuid" << std::endl;
-
-    };
-
-}
+} // namespace OpenWifi

src/ConfigSanityChecker.h

@@ -4,59 +4,57 @@
 
 #pragma once
 
-#include <string>
-#include <list>
-#include <functional>
-#include <map>
-#include <vector>
-#include <utility>
 #include "nlohmann/json.hpp"
+#include <functional>
+#include <list>
+#include <map>
+#include <string>
+#include <utility>
+#include <vector>
 
 namespace OpenWifi {
-    struct SanityError {
-        std::string     Cause;
-        std::string     Reason;
-        std::string     Severity;
-    };
+	struct SanityError {
+		std::string Cause;
+		std::string Reason;
+		std::string Severity;
+	};
 
-    typedef std::list<SanityError>  SanityErrorList;
+	typedef std::list<SanityError> SanityErrorList;
 
-    class ConfigSanityChecker {
-        public:
-            explicit ConfigSanityChecker(std::string Config, std::string DeviceType) :
-                Config_(std::move(Config)),
-                DeviceType_(std::move(DeviceType)){}
+	class ConfigSanityChecker {
+	  public:
+		explicit ConfigSanityChecker(std::string Config, std::string DeviceType)
+			: Config_(std::move(Config)), DeviceType_(std::move(DeviceType)) {}
 
-            bool Check();
-            const SanityErrorList & Errors() { return Errors_; }
-            const SanityErrorList & Warnings() { return Warnings_; }
+		bool Check();
+		const SanityErrorList &Errors() { return Errors_; }
+		const SanityErrorList &Warnings() { return Warnings_; }
 
-            typedef std::function<void(nlohmann::json &)>   CheckFuncType;
+		typedef std::function<void(nlohmann::json &)> CheckFuncType;
 
-            struct KeyToFunc {
-                std::string        Key;
-                CheckFuncType      Func;
-            };
-            typedef std::pair<std::string, CheckFuncType>   FuncPair;
-            typedef std::vector<FuncPair>    FuncList;
+		struct KeyToFunc {
+			std::string Key;
+			CheckFuncType Func;
+		};
+		typedef std::pair<std::string, CheckFuncType> FuncPair;
+		typedef std::vector<FuncPair> FuncList;
 
-            void Check_radios(nlohmann::json &);
-            void Check_interfaces(nlohmann::json &);
-            void Check_metrics(nlohmann::json &);
-            void Check_services(nlohmann::json &);
-            void Check_uuid(nlohmann::json &);
+		void Check_radios(nlohmann::json &);
+		void Check_interfaces(nlohmann::json &);
+		void Check_metrics(nlohmann::json &);
+		void Check_services(nlohmann::json &);
+		void Check_uuid(nlohmann::json &);
 
-        private:
-            std::string         Config_;
-            std::string         DeviceType_;
-            SanityErrorList     Errors_;
-            SanityErrorList     Warnings_;
-            FuncList            Funcs_{
-                std::make_pair("radios", [this](nlohmann::json &d){ this->Check_radios(d);} ) ,
-                std::make_pair("interfaces", [this](nlohmann::json &d){ this->Check_interfaces(d);} ),
-                std::make_pair("metrics", [this](nlohmann::json &d){ this->Check_metrics(d);} ),
-                std::make_pair("services", [this](nlohmann::json &d){ this->Check_services(d);} ),
-                std::make_pair("uuid", [this](nlohmann::json &d){ this->Check_uuid(d);} )
-                };
-    };
-}
+	  private:
+		std::string Config_;
+		std::string DeviceType_;
+		SanityErrorList Errors_;
+		SanityErrorList Warnings_;
+		FuncList Funcs_{
+			std::make_pair("radios", [this](nlohmann::json &d) { this->Check_radios(d); }),
+			std::make_pair("interfaces", [this](nlohmann::json &d) { this->Check_interfaces(d); }),
+			std::make_pair("metrics", [this](nlohmann::json &d) { this->Check_metrics(d); }),
+			std::make_pair("services", [this](nlohmann::json &d) { this->Check_services(d); }),
+			std::make_pair("uuid", [this](nlohmann::json &d) { this->Check_uuid(d); })};
+	};
+} // namespace OpenWifi

src/Daemon.cpp

@@ -6,71 +6,91 @@
 //	Arilia Wireless Inc.
 //
 
+#include "Poco/Environment.h"
+#include "Poco/Net/SSLManager.h"
 #include "Poco/Util/Application.h"
 #include "Poco/Util/Option.h"
-#include "Poco/Environment.h"
 
-#include "Daemon.h"
-#include "StorageService.h"
 #include "AutoDiscovery.h"
-#include "framework/ConfigurationValidator.h"
-#include "SerialNumberCache.h"
-#include "JobController.h"
-#include "WebSocketClientServer.h"
+#include "Daemon.h"
+#include "DeviceTypeCache.h"
+#include "FileDownloader.h"
 #include "FindCountry.h"
+#include "JobController.h"
+#include "SerialNumberCache.h"
+#include "Signup.h"
+#include "StorageService.h"
+#include "UI_Prov_WebSocketNotifications.h"
+#include "framework/ConfigurationValidator.h"
+#include "framework/UI_WebSocketClientServer.h"
 
 namespace OpenWifi {
 	class Daemon *Daemon::instance_ = nullptr;
 
 	class Daemon *Daemon::instance() {
 		if (instance_ == nullptr) {
-			instance_ = new Daemon(vDAEMON_PROPERTIES_FILENAME,
-								   vDAEMON_ROOT_ENV_VAR,
-								   vDAEMON_CONFIG_ENV_VAR,
-								   vDAEMON_APP_NAME,
-								   vDAEMON_BUS_TIMER,
-								   SubSystemVec{
-									   OpenWifi::StorageService(),
-									   ConfigurationValidator(),
-									   SerialNumberCache(),
-									   AutoDiscovery(),
-									   JobController(),
-									   WebSocketClientServer(),
-                                       FindCountryFromIP()
-								   });
+			instance_ = new Daemon(vDAEMON_PROPERTIES_FILENAME, vDAEMON_ROOT_ENV_VAR,
+								   vDAEMON_CONFIG_ENV_VAR, vDAEMON_APP_NAME, vDAEMON_BUS_TIMER,
+								   SubSystemVec{OpenWifi::StorageService(), DeviceTypeCache(),
+												ConfigurationValidator(), SerialNumberCache(),
+												AutoDiscovery(), JobController(),
+												UI_WebSocketClientServer(), FindCountryFromIP(),
+												Signup(), FileDownloader()});
 		}
 		return instance_;
 	}
 
-	void Daemon::initialize() {
-	    if(MicroService::instance().ConfigGetBool("firmware.updater.upgrade",false)) {
-	        if(MicroService::instance().ConfigGetBool("firmware.updater.releaseonly",false)) {
-	            FWRules_ = ProvObjects::upgrade_release_only;
-	        } else {
-	            FWRules_ = ProvObjects::upgrade_latest;
-	        }
-	    } else {
-	        FWRules_ = ProvObjects::dont_upgrade;
-	    }
-    }
+	void Daemon::PostInitialization([[maybe_unused]] Poco::Util::Application &self) {
+		if (MicroService::instance().ConfigGetBool("firmware.updater.upgrade", false)) {
+			if (MicroService::instance().ConfigGetBool("firmware.updater.releaseonly", false)) {
+				FWRules_ = ProvObjects::upgrade_release_only;
+			} else {
+				FWRules_ = ProvObjects::upgrade_latest;
+			}
+		} else {
+			FWRules_ = ProvObjects::dont_upgrade;
+		}
 
-    void MicroServicePostInitialization() {
-        Daemon()->initialize();
+		WebSocketProcessor_ = std::make_unique<ProvWebSocketClient>(logger());
+
+		AssetDir_ = MicroService::instance().DataDir() + "/wwwassets";
+		Poco::File DataDir(AssetDir_);
+		if (!DataDir.exists()) {
+			try {
+				DataDir.createDirectory();
+			} catch (const Poco::Exception &E) {
+				logger().log(E);
+			}
+		}
 	}
-}
+
+	void DaemonPostInitialization(Poco::Util::Application &self) {
+		Daemon()->PostInitialization(self);
+		ProvWebSocketNotifications::Register();
+	}
+
+} // namespace OpenWifi
 
 int main(int argc, char **argv) {
+	int ExitCode;
 	try {
+		Poco::Net::SSLManager::instance().initializeServer(nullptr, nullptr, nullptr);
 		auto App = OpenWifi::Daemon::instance();
-		auto ExitCode =  App->run(argc, argv);
-		delete App;
-
-		return ExitCode;
-
+		ExitCode = App->run(argc, argv);
+		Poco::Net::SSLManager::instance().shutdown();
 	} catch (Poco::Exception &exc) {
-		std::cerr << exc.displayText() << std::endl;
-		return Poco::Util::Application::EXIT_SOFTWARE;
+		ExitCode = Poco::Util::Application::EXIT_SOFTWARE;
+		std::cout << exc.displayText() << std::endl;
+	} catch (std::exception &exc) {
+		ExitCode = Poco::Util::Application::EXIT_TEMPFAIL;
+		std::cout << exc.what() << std::endl;
+	} catch (...) {
+		ExitCode = Poco::Util::Application::EXIT_TEMPFAIL;
+		std::cout << "Exception on closure" << std::endl;
 	}
+
+	std::cout << "Exitcode: " << ExitCode << std::endl;
+	return ExitCode;
 }
 
 // end of namespace

src/Daemon.h

@@ -9,46 +9,48 @@
 #pragma once
 
 #include <array>
-#include <iostream>
 #include <cstdlib>
-#include <vector>
+#include <iostream>
 #include <set>
+#include <vector>
 
 #include "Dashboard.h"
-#include "framework/MicroService.h"
-#include "framework/OpenWifiTypes.h"
+#include "ProvWebSocketClient.h"
 #include "RESTObjects/RESTAPI_ProvObjects.h"
+#include "framework/MicroService.h"
+#include "framework/MicroServiceNames.h"
+#include "framework/OpenWifiTypes.h"
 
 namespace OpenWifi {
 
-	static const char * vDAEMON_PROPERTIES_FILENAME = "owprov.properties";
-	static const char * vDAEMON_ROOT_ENV_VAR = "OWPROV_ROOT";
-	static const char * vDAEMON_CONFIG_ENV_VAR = "OWPROV_CONFIG";
-	static const char * vDAEMON_APP_NAME = uSERVICE_PROVISIONING.c_str() ;
-	static const uint64_t vDAEMON_BUS_TIMER = 10000;
+	[[maybe_unused]] static const char *vDAEMON_PROPERTIES_FILENAME = "owprov.properties";
+	[[maybe_unused]] static const char *vDAEMON_ROOT_ENV_VAR = "OWPROV_ROOT";
+	[[maybe_unused]] static const char *vDAEMON_CONFIG_ENV_VAR = "OWPROV_CONFIG";
+	[[maybe_unused]] static const char *vDAEMON_APP_NAME = uSERVICE_PROVISIONING.c_str();
+	[[maybe_unused]] static const uint64_t vDAEMON_BUS_TIMER = 10000;
 
-    class Daemon : public MicroService {
-		public:
-			explicit Daemon(const std::string & PropFile,
-							const std::string & RootEnv,
-							const std::string & ConfigEnv,
-							const std::string & AppName,
-						  	uint64_t 	BusTimer,
-							const SubSystemVec & SubSystems) :
-				MicroService( PropFile, RootEnv, ConfigEnv, AppName, BusTimer, SubSystems) {};
+	class Daemon : public MicroService {
+	  public:
+		explicit Daemon(const std::string &PropFile, const std::string &RootEnv,
+						const std::string &ConfigEnv, const std::string &AppName, uint64_t BusTimer,
+						const SubSystemVec &SubSystems)
+			: MicroService(PropFile, RootEnv, ConfigEnv, AppName, BusTimer, SubSystems){};
 
-			void initialize();
-			static Daemon *instance();
-			inline OpenWifi::ProvisioningDashboard & GetDashboard() { return DB_; }
-			Poco::Logger & Log() { return Poco::Logger::get(AppName()); }
-			ProvObjects::FIRMWARE_UPGRADE_RULES FirmwareRules() const { return FWRules_; }
-	  	private:
-			static Daemon 				        *instance_;
-			OpenWifi::ProvisioningDashboard		DB_{};
-			ProvObjects::FIRMWARE_UPGRADE_RULES FWRules_{ProvObjects::dont_upgrade};
+		static Daemon *instance();
+		inline OpenWifi::ProvisioningDashboard &GetDashboard() { return DB_; }
+		Poco::Logger &Log() { return Poco::Logger::get(AppName()); }
+		ProvObjects::FIRMWARE_UPGRADE_RULES FirmwareRules() const { return FWRules_; }
+		inline const std::string &AssetDir() { return AssetDir_; }
+		void PostInitialization(Poco::Util::Application &self);
 
-    };
-
-	inline Daemon * Daemon() { return Daemon::instance(); }
-}
+	  private:
+		static Daemon *instance_;
+		OpenWifi::ProvisioningDashboard DB_{};
+		ProvObjects::FIRMWARE_UPGRADE_RULES FWRules_{ProvObjects::dont_upgrade};
+		std::string AssetDir_;
+		std::unique_ptr<ProvWebSocketClient> WebSocketProcessor_;
+	};
 
+	inline Daemon *Daemon() { return Daemon::instance(); }
+	void DaemonPostInitialization(Poco::Util::Application &self);
+} // namespace OpenWifi

src/Dashboard.cpp

@@ -6,15 +6,15 @@
 //	Arilia Wireless Inc.
 //
 #include "Dashboard.h"
-#include "StorageService.h"
+#include "framework/utils.h"
 
 namespace OpenWifi {
 	void ProvisioningDashboard::Create() {
-		uint64_t Now = std::time(nullptr);
-		if(LastRun_==0 || (Now-LastRun_)>120) {
+		uint64_t Now = Utils::Now();
+		if (LastRun_ == 0 || (Now - LastRun_) > 120) {
 			DB_.reset();
 			//  Todo: call dashboard creation code.
 			LastRun_ = Now;
 		}
 	}
-}
+} // namespace OpenWifi

src/Dashboard.h

@@ -8,17 +8,21 @@
 
 #pragma once
 
-#include "framework/OpenWifiTypes.h"
 #include "RESTObjects/RESTAPI_ProvObjects.h"
+#include "framework/OpenWifiTypes.h"
 
 namespace OpenWifi {
 	class ProvisioningDashboard {
 	  public:
-			void Create();
-			[[nodiscard]] const ProvObjects::Report & Report() const { return DB_;}
-			inline void Reset() { LastRun_=0; DB_.reset(); }
+		void Create();
+		[[nodiscard]] const ProvObjects::Report &Report() const { return DB_; }
+		inline void Reset() {
+			LastRun_ = 0;
+			DB_.reset();
+		}
+
 	  private:
-	        ProvObjects::Report  	DB_{};
-			uint64_t 				LastRun_=0;
+		ProvObjects::Report DB_{};
+		uint64_t LastRun_ = 0;
 	};
-}
+} // namespace OpenWifi

src/DeviceTypeCache.h

@@ -0,0 +1,124 @@
+//
+// Created by stephane bourque on 2022-02-23.
+//
+
+#pragma once
+
+#include <set>
+
+#include "framework/AppServiceRegistry.h"
+#include "framework/MicroServiceNames.h"
+#include "framework/OpenAPIRequests.h"
+#include "framework/SubSystemServer.h"
+
+#include "Poco/Timer.h"
+
+namespace OpenWifi {
+
+	class DeviceTypeCache : public SubSystemServer {
+	  public:
+		inline static auto instance() {
+			static auto instance_ = new DeviceTypeCache;
+			return instance_;
+		}
+
+		inline int Start() final {
+			InitializeCache();
+			TimerCallback_ = std::make_unique<Poco::TimerCallback<DeviceTypeCache>>(
+				*this, &DeviceTypeCache::onTimer);
+			Timer_.setStartInterval(60 * 1000);				// first run in 60 seconds
+			Timer_.setPeriodicInterval(1 * 60 * 60 * 1000); // 1 hours
+			Timer_.start(*TimerCallback_);
+			return 0;
+		}
+
+		inline void Stop() final { Timer_.stop(); }
+
+		inline void onTimer([[maybe_unused]] Poco::Timer &timer) { UpdateDeviceTypes(); }
+
+		inline bool IsAcceptableDeviceType(const std::string &D) const {
+			return (DeviceTypes_.find(D) != DeviceTypes_.end());
+		};
+		inline bool AreAcceptableDeviceTypes(const Types::StringVec &S,
+											 bool WildCardAllowed = true) const {
+			for (const auto &i : S) {
+				if (WildCardAllowed && i == "*") {
+					//   We allow wildcards
+				} else if (DeviceTypes_.find(i) == DeviceTypes_.end())
+					return false;
+			}
+			return true;
+		}
+
+	  private:
+		std::atomic_bool Initialized_ = false;
+		Poco::Timer Timer_;
+		std::set<std::string> DeviceTypes_;
+		std::unique_ptr<Poco::TimerCallback<DeviceTypeCache>> TimerCallback_;
+
+		inline DeviceTypeCache() noexcept
+			: SubSystemServer("DeviceTypes", "DEV-TYPES", "devicetypes") {}
+
+		inline void InitializeCache() {
+			std::lock_guard G(Mutex_);
+
+			Initialized_ = true;
+			std::string DeviceTypes;
+			if (AppServiceRegistry().Get("deviceTypes", DeviceTypes)) {
+				Poco::JSON::Parser P;
+				try {
+					auto O = P.parse(DeviceTypes).extract<Poco::JSON::Array::Ptr>();
+					for (const auto &i : *O) {
+						DeviceTypes_.insert(i.toString());
+					}
+				} catch (...) {
+				}
+			}
+		}
+
+		inline bool UpdateDeviceTypes() {
+			try {
+				Types::StringPairVec QueryData;
+
+				QueryData.push_back(std::make_pair("deviceSet", "true"));
+				OpenAPIRequestGet Req(uSERVICE_FIRMWARE, "/api/v1/firmwares", QueryData, 10000);
+
+				auto Response = Poco::makeShared<Poco::JSON::Object>();
+				auto StatusCode = Req.Do(Response);
+				if (StatusCode == Poco::Net::HTTPResponse::HTTP_OK) {
+					if (Response->isArray("deviceTypes")) {
+						std::lock_guard G(Mutex_);
+						DeviceTypes_.clear();
+						auto Array = Response->getArray("deviceTypes");
+						for (const auto &i : *Array) {
+							// std::cout << "Adding deviceType:" << i.toString() << std::endl;
+							DeviceTypes_.insert(i.toString());
+						}
+						SaveCache();
+						return true;
+					}
+				} else {
+				}
+			} catch (const Poco::Exception &E) {
+				Logger().log(E);
+			}
+			return false;
+		}
+
+		inline void SaveCache() {
+			std::lock_guard G(Mutex_);
+
+			Poco::JSON::Array Arr;
+			for (auto const &i : DeviceTypes_)
+				Arr.add(i);
+
+			std::stringstream OS;
+			Arr.stringify(OS);
+
+			AppServiceRegistry().Set("deviceTypes", OS.str());
+		}
+	};
+
+	inline auto DeviceTypeCache() { return DeviceTypeCache::instance(); }
+
+} // namespace OpenWifi

src/FileDownloader.cpp

@@ -0,0 +1,47 @@
+//
+// Created by stephane bourque on 2022-03-11.
+//
+
+#include "FileDownloader.h"
+#include "Daemon.h"
+
+namespace OpenWifi {
+	int FileDownloader::Start() {
+		poco_information(Logger(), "Starting...");
+		TimerCallback_ =
+			std::make_unique<Poco::TimerCallback<FileDownloader>>(*this, &FileDownloader::onTimer);
+		Timer_.setStartInterval(20 * 1000);				// first run in 20 seconds
+		Timer_.setPeriodicInterval(2 * 60 * 60 * 1000); // 1 hours
+		Timer_.start(*TimerCallback_);
+		return 0;
+	}
+
+	void FileDownloader::Stop() {
+		poco_information(Logger(), "Stopping...");
+		Timer_.stop();
+		poco_information(Logger(), "Stopped...");
+	}
+
+	void FileDownloader::onTimer([[maybe_unused]] Poco::Timer &timer) {
+		const static std::vector<std::pair<std::string, std::string>> Files{
+			{"https://raw.githubusercontent.com/blogic/ucentral-schema/main/ucentral.schema.json",
+			 "ucentral.schema.json"},
+			{"https://ucentral.io/ucentral.schema.pretty.json", "ucentral.schema.pretty.json"}};
+
+		Utils::SetThreadName("file-dmnldr");
+
+		for (const auto &[url, filename] : Files) {
+			try {
+				std::string FileContent;
+				if (Utils::wgets(url, FileContent)) {
+					std::ofstream OutputStream(Daemon()->AssetDir() + "/" + filename,
+											   std::ios_base::out | std::ios_base::trunc);
+					OutputStream << FileContent;
+					Logger().warning(Poco::format("File %s was downloaded", url));
+				}
+			} catch (...) {
+				Logger().warning(Poco::format("File %s could not be downloaded", url));
+			}
+		}
+	}
+} // namespace OpenWifi

src/FileDownloader.h

@@ -0,0 +1,32 @@
+//
+// Created by stephane bourque on 2022-03-11.
+//
+
+#pragma once
+#include "Poco/Timer.h"
+#include "framework/SubSystemServer.h"
+
+namespace OpenWifi {
+
+	class FileDownloader : public SubSystemServer {
+	  public:
+		static auto instance() {
+			static auto instance_ = new FileDownloader;
+			return instance_;
+		}
+
+		int Start() override;
+		void Stop() override;
+		void onTimer(Poco::Timer &timer);
+
+	  private:
+		Poco::Timer Timer_;
+		std::unique_ptr<Poco::TimerCallback<FileDownloader>> TimerCallback_;
+		std::atomic_bool Running_ = false;
+
+		FileDownloader() noexcept
+			: SubSystemServer("FileDownloader", "FILE-DOWNLOADER", "downloader") {}
+	};
+
+	inline auto FileDownloader() { return FileDownloader::instance(); }
+} // namespace OpenWifi

src/FindCountry.h

@@ -4,79 +4,79 @@
 
 #pragma once
 
-#include "framework/MicroService.h"
 #include "Poco/Net/IPAddress.h"
+
+#include "framework/MicroServiceFuncs.h"
+#include "framework/SubSystemServer.h"
+
 #include "nlohmann/json.hpp"
 
 namespace OpenWifi {
 
 	class IPToCountryProvider {
 	  public:
-		virtual bool Init() = 0 ;
-		virtual Poco::URI URI(const std::string & IPAddress) = 0;
-		virtual std::string Country( const std::string & Response ) = 0 ;
-		virtual ~IPToCountryProvider() {
-		};
+		virtual bool Init() = 0;
+		virtual Poco::URI URI(const std::string &IPAddress) = 0;
+		virtual std::string Country(const std::string &Response) = 0;
+		virtual ~IPToCountryProvider(){};
 	};
 
 	class IPInfo : public IPToCountryProvider {
 	  public:
 		static std::string Name() { return "ipinfo"; }
 		inline bool Init() override {
-			Key_ = MicroService::instance().ConfigGetString("iptocountry.ipinfo.token", "");
+			Key_ = MicroServiceConfigGetString("iptocountry.ipinfo.token", "");
 			return !Key_.empty();
 		}
 
-		[[nodiscard]] inline Poco::URI URI(const std::string & IPAddress) override {
-			Poco::URI	U("https://ipinfo.io");
+		[[nodiscard]] inline Poco::URI URI(const std::string &IPAddress) override {
+			Poco::URI U("https://ipinfo.io");
 			U.setPath("/" + IPAddress);
-			U.addQueryParameter("token",Key_);
+			U.addQueryParameter("token", Key_);
 			return U;
 		}
 
-		inline std::string Country( const std::string & Response ) override {
+		inline std::string Country(const std::string &Response) override {
 			try {
 				nlohmann::json IPInfo = nlohmann::json::parse(Response);
 				if (IPInfo.contains("country") && IPInfo["country"].is_string()) {
 					return IPInfo["country"];
 				}
 			} catch (...) {
-
 			}
 			return "";
 		}
 
 	  private:
 		std::string Key_;
-
 	};
 
 	class IPData : public IPToCountryProvider {
 	  public:
 		static std::string Name() { return "ipdata"; }
 		inline bool Init() override {
-			Key_ = MicroService::instance().ConfigGetString("iptocountry.ipdata.apikey", "");
+			Key_ = MicroServiceConfigGetString("iptocountry.ipdata.apikey", "");
 			return !Key_.empty();
 		}
 
-		[[nodiscard]] inline Poco::URI URI(const std::string & IPAddress) override {
-			Poco::URI	U("https://api.ipdata.co");
+		[[nodiscard]] inline Poco::URI URI(const std::string &IPAddress) override {
+			Poco::URI U("https://api.ipdata.co");
 			U.setPath("/" + IPAddress);
-			U.addQueryParameter("api-key",Key_);
+			U.addQueryParameter("api-key", Key_);
 			return U;
 		}
 
-		inline std::string Country( const std::string & Response ) override {
+		inline std::string Country(const std::string &Response) override {
 			try {
 				nlohmann::json IPInfo = nlohmann::json::parse(Response);
 				if (IPInfo.contains("country_code") && IPInfo["country_code"].is_string()) {
 					return IPInfo["country_code"];
 				}
 			} catch (...) {
-
 			}
 			return "";
 		}
+
 	  private:
 		std::string Key_;
 	};
@@ -85,37 +85,37 @@ namespace OpenWifi {
 	  public:
 		static std::string Name() { return "ip2location"; }
 		inline bool Init() override {
-			Key_ = MicroService::instance().ConfigGetString("iptocountry.ip2location.apikey", "");
+			Key_ = MicroServiceConfigGetString("iptocountry.ip2location.apikey", "");
 			return !Key_.empty();
 		}
 
-		[[nodiscard]] inline Poco::URI URI(const std::string & IPAddress) override {
-			Poco::URI	U("https://api.ip2location.com/v2");
+		[[nodiscard]] inline Poco::URI URI(const std::string &IPAddress) override {
+			Poco::URI U("https://api.ip2location.com/v2");
 			U.setPath("/");
 			U.addQueryParameter("ip", IPAddress);
 			U.addQueryParameter("package", "WS1");
-			U.addQueryParameter("key",Key_);
+			U.addQueryParameter("key", Key_);
 			return U;
 		}
 
-		inline std::string Country( const std::string & Response ) override {
+		inline std::string Country(const std::string &Response) override {
 			try {
 				nlohmann::json IPInfo = nlohmann::json::parse(Response);
 				if (IPInfo.contains("country_code") && IPInfo["country_code"].is_string()) {
 					return IPInfo["country_code"];
 				}
 			} catch (...) {
-
 			}
 			return "";
 		}
+
 	  private:
 		std::string Key_;
 	};
 
-	template<typename BaseClass, typename T, typename... Args>
-	std::unique_ptr<BaseClass> IPLocationProvider(const std::string & RequestProvider ) {
-		if(T::Name()==RequestProvider) {
+	template <typename BaseClass, typename T, typename... Args>
+	std::unique_ptr<BaseClass> IPLocationProvider(const std::string &RequestProvider) {
+		if (T::Name() == RequestProvider) {
 			return std::make_unique<T>();
 		}
 		if constexpr (sizeof...(Args) == 0) {
@@ -133,37 +133,40 @@ namespace OpenWifi {
 		}
 
 		inline int Start() final {
-			ProviderName_ = MicroService::instance().ConfigGetString("iptocountry.provider","");
-			if(!ProviderName_.empty()) {
-				Provider_ = IPLocationProvider<IPToCountryProvider, IPInfo, IPData, IP2Location>(ProviderName_);
-				if(Provider_!= nullptr) {
+			poco_notice(Logger(), "Starting...");
+			ProviderName_ = MicroServiceConfigGetString("iptocountry.provider", "");
+			if (!ProviderName_.empty()) {
+				Provider_ = IPLocationProvider<IPToCountryProvider, IPInfo, IPData, IP2Location>(
+					ProviderName_);
+				if (Provider_ != nullptr) {
 					Enabled_ = Provider_->Init();
 				}
 			}
-			Default_ = MicroService::instance().ConfigGetString("iptocountry.default", "US");
+			Default_ = MicroServiceConfigGetString("iptocountry.default", "US");
 			return 0;
 		}
 
 		inline void Stop() final {
+			poco_notice(Logger(), "Stopping...");
+			//	Nothing to do - just to provide the same look at the others.
+			poco_notice(Logger(), "Stopped...");
 		}
 
-		[[nodiscard]] static inline std::string ReformatAddress(const std::string & I )
-		{
-			if(I.substr(0,7) == "::ffff:")
-			{
-				std::string ip = I.substr(7 );
+		[[nodiscard]] static inline std::string ReformatAddress(const std::string &I) {
+			if (I.substr(0, 7) == "::ffff:") {
+				std::string ip = I.substr(7);
 				return ip;
 			}
 			return I;
 		}
 
-		inline std::string Get(const Poco::Net::IPAddress & IP) {
+		inline std::string Get(const Poco::Net::IPAddress &IP) {
 			if (!Enabled_)
 				return Default_;
 			return Get(ReformatAddress(IP.toString()));
 		}
 
-		inline std::string Get(const std::string & IP) {
+		inline std::string Get(const std::string &IP) {
 			if (!Enabled_)
 				return Default_;
 			try {
@@ -171,10 +174,10 @@ namespace OpenWifi {
 				std::string Response;
 				if (Utils::wgets(URL, Response)) {
 					auto Answer = Provider_->Country(Response);
-					if(!Answer.empty())
+					if (!Answer.empty())
 						return Answer;
 				}
-			} catch(...) {
+			} catch (...) {
 			}
 			return Default_;
 		}
@@ -182,17 +185,14 @@ namespace OpenWifi {
 		inline auto Enabled() const { return Enabled_; }
 
 	  private:
-		bool 									Enabled_=false;
-		std::string 							Default_;
-		std::unique_ptr<IPToCountryProvider>	Provider_;
-		std::string 							ProviderName_;
+		bool Enabled_ = false;
+		std::string Default_;
+		std::unique_ptr<IPToCountryProvider> Provider_;
+		std::string ProviderName_;
 
-		FindCountryFromIP() noexcept:
-			SubSystemServer("IpToCountry", "IPTOC-SVR", "iptocountry")
-		{
-		}
+		FindCountryFromIP() noexcept : SubSystemServer("IpToCountry", "IPTOC-SVR", "iptocountry") {}
 	};
 
 	inline auto FindCountryFromIP() { return FindCountryFromIP::instance(); }
 
-}
+} // namespace OpenWifi

src/JobController.cpp

@@ -3,35 +3,63 @@
 //
 
 #include "JobController.h"
+#include "fmt/format.h"
+#include "framework/utils.h"
 
 namespace OpenWifi {
 
-    void RegisterJobTypes();
+	void RegisterJobTypes();
 
-    int JobController::Start() {
+	int JobController::Start() {
+		poco_information(Logger(), "Starting...");
+		RegisterJobTypes();
+		if (!Running_)
+			Thr_.start(*this);
 
-        RegisterJobTypes();
+		return 0;
+	}
 
-        if(!Running_)
-            Thr_.start(*this);
+	void JobController::Stop() {
+		if (Running_) {
+			poco_information(Logger(), "Stopping...");
+			Running_ = false;
+			Thr_.join();
+			poco_information(Logger(), "Stopped...");
+		}
+	}
 
-        return 0;
-    }
+	void JobController::run() {
+		Running_ = true;
+		Utils::SetThreadName("job-controller");
+		while (Running_) {
+			Poco::Thread::trySleep(2000);
 
-    void JobController::Stop() {
-        if(Running_) {
-            Running_ = false;
-            Thr_.join();
-        }
-    }
+			std::lock_guard G(Mutex_);
 
-    void JobController::run() {
-        Running_ = true ;
+			for (auto &current_job : jobs_) {
+				if (current_job != nullptr) {
+					if (current_job->Started() == 0 && Pool_.used() < Pool_.available()) {
+						poco_information(current_job->Logger(),
+										 fmt::format("Starting {}: {}", current_job->JobId(),
+													 current_job->Name()));
+						current_job->Start();
+						Pool_.start(*current_job);
+					}
+				}
+			}
 
-        while(Running_) {
-            Poco::Thread::trySleep(2000);
-        }
-
-    }
-
-}
+			for (auto it = jobs_.begin(); it != jobs_.end();) {
+				auto current_job = *it;
+				if (current_job != nullptr && current_job->Completed() != 0) {
+					poco_information(
+						current_job->Logger(),
+						fmt::format("Completed {}: {}", current_job->JobId(), current_job->Name()));
+					it = jobs_.erase(it);
+					delete current_job;
+				} else {
+					++it;
+				}
+			}
+		}
+	}
+} // namespace OpenWifi

src/JobController.h

@@ -4,128 +4,72 @@
 
 #pragma once
 
-#include <vector>
-#include <utility>
+#include "RESTObjects/RESTAPI_SecurityObjects.h"
+#include "framework/SubSystemServer.h"
+#include "framework/utils.h"
 #include <functional>
-#include "framework/MicroService.h"
+#include <list>
+#include <utility>
+#include <vector>
 
 namespace OpenWifi {
 
-    class Job {
-        public:
-            struct Parameter {
-                std::string name;
-                std::string value;
-                inline void to_json(Poco::JSON::Object &Obj) const {
-                    RESTAPI_utils::field_to_json(Obj,"name",name);
-                    RESTAPI_utils::field_to_json(Obj,"value",value);
-                }
+	class Job : public Poco::Runnable {
+	  public:
+		Job(const std::string &JobID, const std::string &name,
+			const std::vector<std::string> &parameters, uint64_t when,
+			const SecurityObjects::UserInfo &UI, Poco::Logger &L)
+			: jobId_(JobID), name_(name), parameters_(parameters), when_(when), userinfo_(UI),
+			  Logger_(L){};
 
-                inline bool from_json(const Poco::JSON::Object::Ptr &Obj) {
-                    try {
-                        RESTAPI_utils::field_from_json(Obj,"name",name);
-                        RESTAPI_utils::field_from_json(Obj,"value",value);
-                        return true;
-                    } catch (...) {
+		virtual void run() = 0;
+		[[nodiscard]] std::string Name() const { return name_; }
+		const SecurityObjects::UserInfo &UserInfo() const { return userinfo_; }
+		Poco::Logger &Logger() { return Logger_; }
+		const std::string &JobId() const { return jobId_; }
+		const std::string &Parameter(int x) const { return parameters_[x]; }
+		uint64_t When() const { return when_; }
+		void Start() { started_ = Utils::Now(); }
+		uint64_t Started() const { return started_; }
+		uint64_t Completed() const { return completed_; }
+		void Complete() { completed_ = Utils::Now(); }
 
-                    }
-                    return false;
-                }
-            };
+	  private:
+		std::string jobId_;
+		std::string name_;
+		std::vector<std::string> parameters_;
+		uint64_t when_ = 0;
+		SecurityObjects::UserInfo userinfo_;
+		Poco::Logger &Logger_;
+		uint64_t started_ = 0;
+		uint64_t completed_ = 0;
+	};
 
-            struct Status {
-                Types::UUID_t   UUID;
-                uint64_t        Start = 0 ;
-                uint64_t        Progress = 0 ;
-                uint64_t        Completed = 0 ;
-                std::string     CurrentDisplay;
-            };
+	class JobController : public SubSystemServer, Poco::Runnable {
+	  public:
+		static auto instance() {
+			static auto instance_ = new JobController;
+			return instance_;
+		}
 
-            struct Result {
-                int         Error=0;
-                std::string Reason;
-            };
+		int Start() override;
+		void Stop() override;
+		void run() override;
+		inline void wakeup() { Thr_.wakeUp(); }
 
-            typedef std::vector<Parameter>       Parameters;
-            typedef std::vector<Parameters>      ParametersVec;
-            typedef std::function<bool(const Parameters &Parameters, Result &Result, bool &Retry)>  WorkerFunction;
-            typedef std::vector<Status>          Statuses;
+		void AddJob(Job *newJob) {
+			std::lock_guard G(Mutex_);
+			jobs_.push_back(newJob);
+		}
 
-            Job(std::string Title,
-                         std::string Description,
-                         std::string RegisteredName,
-                         ParametersVec Parameters,
-                         bool Parallel=true) :
-                    Title_(std::move(Title)),
-                    Description_(std::move(Description)),
-                    RegisteredName_(std::move(RegisteredName)),
-                    Parameters_(std::move(Parameters)),
-                    Parallel_(Parallel)
-                {
-                    UUID_ = MicroService::instance().CreateUUID();
-                }
+	  private:
+		Poco::Thread Thr_;
+		std::atomic_bool Running_ = false;
+		std::list<Job *> jobs_;
+		Poco::ThreadPool Pool_;
 
-            [[nodiscard]] inline const Types::UUID_t & ID() const { return UUID_; }
-
-        private:
-            Types::UUID_t       UUID_;
-            std::string         Title_;
-            std::string         Description_;
-            std::string         RegisteredName_;
-            ParametersVec       Parameters_;
-            bool                Parallel_=true;
-    };
-
-    class JobRegistry {
-        public:
-            static auto instance() {
-                static auto instance_ = new JobRegistry;
-                return instance_;
-            }
-
-            inline void RegisterJobType( const std::string & JobType, Job::WorkerFunction Function) {
-                    JobTypes_[JobType] = std::move(Function);
-            }
-
-            inline bool Execute(const std::string &JobType, const Job::Parameters & Params, Job::Result &Result, bool & Retry) {
-                auto Hint = JobTypes_.find(JobType);
-                if(Hint != end(JobTypes_)) {
-                    Hint->second(Params, Result, Retry);
-                    return true;
-                }
-                return false;
-            }
-
-        private:
-            std::map<std::string,Job::WorkerFunction>  JobTypes_;
-    };
-
-    inline auto JobRegistry() { return JobRegistry::instance(); }
-
-    class JobController : public SubSystemServer, Poco::Runnable {
-        public:
-            static auto instance() {
-                static auto instance_ = new JobController;
-                return instance_;
-            }
-
-            int Start() override;
-            void Stop() override;
-            void run() override;
-            inline void wakeup() { Thr_.wakeUp(); }
-
-            bool JobList(Job::Statuses & Statuses);
-
-        private:
-            Poco::Thread            Thr_;
-            std::atomic_bool        Running_=false;
-
-        JobController() noexcept:
-            SubSystemServer("JobController", "JOB-SVR", "job")
-            {
-            }
-    };
-    inline auto JobController() { return JobController::instance(); }
-
-}
+		JobController() noexcept : SubSystemServer("JobController", "JOB-SVR", "job") {}
+	};
+	inline auto JobController() { return JobController::instance(); }
 
+} // namespace OpenWifi

src/JobRegistrations.cpp

@@ -4,8 +4,6 @@
 
 namespace OpenWifi {
 
-    void RegisterJobTypes() {
+	void RegisterJobTypes() {}
 
-    }
-
-}
+} // namespace OpenWifi

src/Kafka_ProvUpdater.cpp

@@ -0,0 +1,5 @@
+//
+// Created by stephane bourque on 2022-04-01.
+//
+
+#include "Kafka_ProvUpdater.h"

src/Kafka_ProvUpdater.h

@@ -0,0 +1,48 @@
+//
+// Created by stephane bourque on 2022-04-01.
+//
+
+#pragma once
+
+#include "RESTObjects/RESTAPI_ProvObjects.h"
+#include "framework/KafkaManager.h"
+#include "framework/KafkaTopics.h"
+
+namespace OpenWifi {
+
+	enum ProvisioningOperation { creation = 0, modification, removal };
+
+	template <typename ObjectType>
+	inline bool UpdateKafkaProvisioningObject(ProvisioningOperation op, const ObjectType &obj) {
+		static std::vector<std::string> Ops{"creation", "modification", "removal"};
+
+		std::string OT{"object"};
+		if constexpr (std::is_same_v<ObjectType, ProvObjects::Venue>) {
+			OT = "Venue";
+		}
+		if constexpr (std::is_same_v<ObjectType, ProvObjects::Entity>) {
+			OT = "Entity";
+		}
+		if constexpr (std::is_same_v<ObjectType, ProvObjects::InventoryTag>) {
+			OT = "InventoryTag";
+		}
+		if constexpr (std::is_same_v<ObjectType, ProvObjects::Contact>) {
+			OT = "Contact";
+		}
+		if constexpr (std::is_same_v<ObjectType, ProvObjects::Location>) {
+			OT = "Location";
+		}
+		if constexpr (std::is_same_v<ObjectType, ProvObjects::DeviceConfiguration>) {
+			OT = "DeviceConfiguration";
+		}
+
+		Poco::JSON::Object Payload;
+		obj.to_json(Payload);
+		Payload.set("ObjectType", OT);
+		std::ostringstream OS;
+		Payload.stringify(OS);
+		KafkaManager()->PostMessage(KafkaTopics::PROVISIONING_CHANGE, Ops[op], OS.str());
+
+		return true;
+	}
+} // namespace OpenWifi

src/ProvWebSocketClient.cpp

@@ -0,0 +1,183 @@
+//
+// Created by stephane bourque on 2022-04-28.
+//
+
+#include "ProvWebSocketClient.h"
+
+#include "SerialNumberCache.h"
+#include "StorageService.h"
+#include "framework/UI_WebSocketClientServer.h"
+#include "sdks/SDK_sec.h"
+
+namespace OpenWifi {
+
+	ProvWebSocketClient::ProvWebSocketClient(Poco::Logger &Logger) : Logger_(Logger) {
+		UI_WebSocketClientServer()->SetProcessor(this);
+	}
+
+	ProvWebSocketClient::~ProvWebSocketClient() {
+		UI_WebSocketClientServer()->SetProcessor(nullptr);
+	}
+
+	void ProvWebSocketClient::ws_command_serial_number_search(const Poco::JSON::Object::Ptr &O,
+															  bool &Done, std::string &Answer) {
+		Done = false;
+		auto Prefix = ORM::Escape(O->get("serial_prefix").toString());
+		Poco::toLowerInPlace(Prefix);
+		Logger().information(Poco::format("serial_number_search: %s", Prefix));
+		if (!Prefix.empty() && Prefix.length() < 13) {
+			std::vector<uint64_t> Numbers;
+			SerialNumberCache()->FindNumbers(Prefix, 50, Numbers);
+			Poco::JSON::Array Arr;
+			for (const auto &i : Numbers)
+				Arr.add(Utils::int_to_hex(i));
+			Poco::JSON::Object RetObj;
+			RetObj.set("serialNumbers", Arr);
+			std::ostringstream SS;
+			Poco::JSON::Stringifier::stringify(RetObj, SS);
+			Answer = SS.str();
+		}
+	}
+
+	void ProvWebSocketClient::ws_command_address_completion(const Poco::JSON::Object::Ptr &O,
+															bool &Done, std::string &Answer) {
+		Done = false;
+		auto Address = O->get("address").toString();
+		Answer = GoogleGeoCodeCall(Address);
+	}
+
+	void ProvWebSocketClient::ws_command_exit([[maybe_unused]] const Poco::JSON::Object::Ptr &O,
+											  bool &Done, std::string &Answer) {
+		Done = true;
+		Answer = R"lit({ "closing" : "Goodbye! Aurevoir! Hasta la vista!" })lit";
+	}
+
+	void ProvWebSocketClient::ws_command_invalid([[maybe_unused]] const Poco::JSON::Object::Ptr &O,
+												 bool &Done, std::string &Answer) {
+		Done = false;
+		Answer = std::string{R"lit({ "error" : "invalid command" })lit"};
+	}
+
+	void ProvWebSocketClient::ws_command_subuser_search(const Poco::JSON::Object::Ptr &O,
+														bool &Done, std::string &Answer) {
+		Done = false;
+		auto operatorId = ORM::Escape(O->get("operatorId").toString());
+		std::string nameSearch, emailSearch;
+		OpenWifi::RESTAPIHandler::AssignIfPresent(O, "nameSearch", nameSearch);
+		OpenWifi::RESTAPIHandler::AssignIfPresent(O, "emailSearch", emailSearch);
+		SecurityObjects::UserInfoList Users;
+		SDK::Sec::Subscriber::Search(nullptr, operatorId, nameSearch, emailSearch, Users);
+
+		Poco::JSON::Array Arr;
+		for (const auto &i : Users.users) {
+			Poco::JSON::Object OO;
+			OO.set("name", i.name);
+			OO.set("email", i.email);
+			OO.set("id", i.id);
+			i.to_json(OO);
+			Arr.add(OO);
+		}
+		Poco::JSON::Object ObjAnswer;
+		ObjAnswer.set("users", Arr);
+		std::ostringstream SS;
+		Poco::JSON::Stringifier::stringify(ObjAnswer, SS);
+		Answer = SS.str();
+	}
+
+	void ProvWebSocketClient::ws_command_subdevice_search(const Poco::JSON::Object::Ptr &O,
+														  bool &Done, std::string &Answer) {
+		Done = false;
+		auto operatorId = O->get("operatorId").toString();
+		auto Prefix = O->get("serial_prefix").toString();
+		Poco::toLowerInPlace(Prefix);
+		std::string Query;
+
+		if (Prefix[0] == '*') {
+			Query = fmt::format(" operatorId='{}' and (right(serialNumber,{})='{}' or "
+								"right(realMacAddress,{})='{}' ) ",
+								operatorId, Prefix.size() - 1, Prefix.substr(1), Prefix.size() - 1,
+								Prefix.substr(1));
+		} else {
+			Query = fmt::format(" operatorId='{}' and (left(serialNumber,{})='{}'  or "
+								"left(realMacAddress,{})='{}' ) ",
+								operatorId, Prefix.size(), Prefix, Prefix.size(), Prefix);
+		}
+
+		std::vector<ProvObjects::SubscriberDevice> SubDevices;
+
+		StorageService()->SubscriberDeviceDB().GetRecords(0, 200, SubDevices, Query);
+		Poco::JSON::Array Arr;
+		for (const auto &i : SubDevices) {
+			Arr.add(i.serialNumber);
+		}
+		Poco::JSON::Object RetObj;
+		RetObj.set("serialNumbers", Arr);
+		std::ostringstream SS;
+		Poco::JSON::Stringifier::stringify(RetObj, SS);
+		Answer = SS.str();
+	}
+
+	void
+	ProvWebSocketClient::Processor(const Poco::JSON::Object::Ptr &O, std::string &Result,
+								   bool &Done,
+								   [[maybe_unused]] const SecurityObjects::UserInfo &UserInfo) {
+		try {
+			if (O->has("command") && O->has("id")) {
+				auto id = (uint64_t)O->get("id");
+				std::string Answer;
+				auto Command = O->get("command").toString();
+				if (Command == "serial_number_search" && O->has("serial_prefix")) {
+					ws_command_serial_number_search(O, Done, Answer);
+				} else if (UI_WebSocketClientServer()->GeoCodeEnabled() &&
+						   Command == "address_completion" && O->has("address")) {
+					ws_command_address_completion(O, Done, Answer);
+				} else if (UI_WebSocketClientServer()->GeoCodeEnabled() &&
+						   Command == "subuser_search" && O->has("operatorId")) {
+					ws_command_subuser_search(O, Done, Answer);
+				} else if (UI_WebSocketClientServer()->GeoCodeEnabled() &&
+						   Command == "subdevice_search" && O->has("operatorId") &&
+						   O->has("serial_prefix")) {
+					ws_command_subdevice_search(O, Done, Answer);
+				} else if (Command == "exit") {
+					ws_command_exit(O, Done, Answer);
+				} else {
+					ws_command_invalid(O, Done, Answer);
+				}
+
+				Result = fmt::format("{{ \"command_response_id\" : {} , \"response\" : {}  }}", id,
+									 Answer);
+			}
+		} catch (const Poco::Exception &E) {
+			Logger().log(E);
+		}
+	}
+
+	std::string ProvWebSocketClient::GoogleGeoCodeCall(const std::string &A) {
+		try {
+			std::string URI = {"https://maps.googleapis.com/maps/api/geocode/json"};
+			Poco::URI uri(URI);
+
+			uri.addQueryParameter("address", A);
+			uri.addQueryParameter("key", UI_WebSocketClientServer()->GoogleApiKey());
+
+			Poco::Net::HTTPSClientSession session(uri.getHost(), uri.getPort());
+			Poco::Net::HTTPRequest req(Poco::Net::HTTPRequest::HTTP_GET, uri.getPathAndQuery(),
+									   Poco::Net::HTTPMessage::HTTP_1_1);
+			session.sendRequest(req);
+			Poco::Net::HTTPResponse res;
+			std::istream &rs = session.receiveResponse(res);
+			if (res.getStatus() == Poco::Net::HTTPResponse::HTTP_OK) {
+				std::ostringstream os;
+				Poco::StreamCopier::copyStream(rs, os);
+				return os.str();
+			} else {
+				std::ostringstream os;
+				Poco::StreamCopier::copyStream(rs, os);
+				return R"lit({ "error: )lit" + os.str() + R"lit( })lit";
+			}
+		} catch (...) {
+		}
+		return "{ \"error\" : \"No call made\" }";
+	}
+
+} // namespace OpenWifi

src/ProvWebSocketClient.h

@@ -0,0 +1,34 @@
+//
+// Created by stephane bourque on 2022-04-28.
+//
+
+#pragma once
+
+#include "framework/UI_WebSocketClientServer.h"
+
+namespace OpenWifi {
+
+	class ProvWebSocketClient : public UI_WebSocketClientProcessor {
+	  public:
+		explicit ProvWebSocketClient(Poco::Logger &Logger);
+		virtual ~ProvWebSocketClient();
+		virtual void Processor(const Poco::JSON::Object::Ptr &O, std::string &Answer, bool &Done,
+							   const SecurityObjects::UserInfo &UserInfo);
+		void ws_command_serial_number_search(const Poco::JSON::Object::Ptr &O, bool &Done,
+											 std::string &Answer);
+		void ws_command_address_completion(const Poco::JSON::Object::Ptr &O, bool &Done,
+										   std::string &Answer);
+		void ws_command_exit(const Poco::JSON::Object::Ptr &O, bool &Done, std::string &Answer);
+		void ws_command_invalid(const Poco::JSON::Object::Ptr &O, bool &Done, std::string &Answer);
+		void ws_command_subuser_search(const Poco::JSON::Object::Ptr &O, bool &Done,
+									   std::string &Answer);
+		void ws_command_subdevice_search(const Poco::JSON::Object::Ptr &O, bool &Done,
+										 std::string &Answer);
+		std::string GoogleGeoCodeCall(const std::string &A);
+
+	  private:
+		Poco::Logger &Logger_;
+		inline Poco::Logger &Logger() { return Logger_; }
+	};
+
+} // namespace OpenWifi

src/RESTAPI/RESTAPI_asset_server.cpp

@@ -0,0 +1,21 @@
+//
+// Created by stephane bourque on 2021-07-10.
+//
+
+#include "RESTAPI_asset_server.h"
+#include "Daemon.h"
+#include "Poco/File.h"
+#include "framework/ow_constants.h"
+
+namespace OpenWifi {
+	void RESTAPI_asset_server::DoGet() {
+		Poco::File AssetFile;
+
+		std::string AssetName = GetBinding(RESTAPI::Protocol::ID, "");
+		AssetFile = Daemon()->AssetDir() + "/" + AssetName;
+		if (!AssetFile.isFile()) {
+			return NotFound();
+		}
+		SendFile(AssetFile);
+	}
+} // namespace OpenWifi

src/RESTAPI/RESTAPI_asset_server.h

@@ -0,0 +1,27 @@
+//
+// Created by stephane bourque on 2021-07-10.
+//
+
+#pragma once
+#include "StorageService.h"
+#include "framework/RESTAPI_Handler.h"
+
+namespace OpenWifi {
+	class RESTAPI_asset_server : public RESTAPIHandler {
+	  public:
+		RESTAPI_asset_server(const RESTAPIHandler::BindingMap &bindings, Poco::Logger &L,
+							 RESTAPI_GenericServerAccounting &Server, uint64_t TransactionId,
+							 bool Internal)
+			: RESTAPIHandler(bindings, L,
+							 std::vector<std::string>{Poco::Net::HTTPRequest::HTTP_GET,
+													  Poco::Net::HTTPRequest::HTTP_OPTIONS},
+							 Server, TransactionId, Internal, false) {}
+		static auto PathName() { return std::list<std::string>{"/wwwassets/{id}"}; };
+		void DoGet() final;
+		void DoPost() final{};
+		void DoDelete() final{};
+		void DoPut() final{};
+
+	  private:
+	};
+} // namespace OpenWifi

src/RESTAPI/RESTAPI_configurations_handler.cpp

@@ -6,222 +6,244 @@
 //	Arilia Wireless Inc.
 //
 
-#include "framework/MicroService.h"
-
 #include "RESTAPI_configurations_handler.h"
+#include "DeviceTypeCache.h"
+#include "RESTAPI/RESTAPI_db_helpers.h"
 #include "RESTObjects/RESTAPI_ProvObjects.h"
 #include "StorageService.h"
-#include "framework/RESTAPI_errors.h"
 #include "framework/ConfigurationValidator.h"
-#include "RESTAPI/RESTAPI_db_helpers.h"
 
-namespace OpenWifi{
+namespace OpenWifi {
 
-    void RESTAPI_configurations_handler::DoGet() {
-        std::string UUID = GetBinding("uuid","");
-        ProvObjects::DeviceConfiguration   Existing;
-        if(UUID.empty() || !DB_.GetRecord("id", UUID, Existing)) {
-            return NotFound();
-        }
+	void RESTAPI_configurations_handler::DoGet() {
+		std::string UUID = GetBinding("uuid", "");
+		ProvObjects::DeviceConfiguration Existing;
+		if (UUID.empty() || !DB_.GetRecord("id", UUID, Existing)) {
+			return NotFound();
+		}
 
-        Poco::JSON::Object  Answer;
-        std::string Arg;
-        if(HasParameter("expandInUse",Arg) && Arg=="true") {
-            Storage::ExpandedListMap    M;
-            std::vector<std::string>    Errors;
-            Poco::JSON::Object          Inner;
-            if(StorageService()->ExpandInUse(Existing.inUse,M,Errors)) {
-                for(const auto &[type,list]:M) {
-                    Poco::JSON::Array   ObjList;
-                    for(const auto &i:list.entries) {
-                        Poco::JSON::Object  O;
-                        i.to_json(O);
-                        ObjList.add(O);
-                    }
-                    Inner.set(type,ObjList);
-                }
-            }
-            Answer.set("entries", Inner);
-            return ReturnObject(Answer);
-        } else if(HasParameter("computedAffected",Arg) && Arg=="true") {
-            Types::UUIDvec_t DeviceSerialNumbers;
-            DB_.GetListOfAffectedDevices(UUID,DeviceSerialNumbers);
-            return ReturnObject("affectedDevices", DeviceSerialNumbers);
-        } else if(QB_.AdditionalInfo) {
-            AddExtendedInfo(Existing,Answer);
-        }
-        Existing.to_json(Answer);
-        ReturnObject(Answer);
-    }
+		Poco::JSON::Object Answer;
+		std::string Arg;
+		if (HasParameter("expandInUse", Arg) && Arg == "true") {
+			Storage::ExpandedListMap M;
+			std::vector<std::string> Errors;
+			Poco::JSON::Object Inner;
+			if (StorageService()->ExpandInUse(Existing.inUse, M, Errors)) {
+				for (const auto &[type, list] : M) {
+					Poco::JSON::Array ObjList;
+					for (const auto &i : list.entries) {
+						Poco::JSON::Object O;
+						i.to_json(O);
+						ObjList.add(O);
+					}
+					Inner.set(type, ObjList);
+				}
+			}
+			Answer.set("entries", Inner);
+			return ReturnObject(Answer);
+		} else if (HasParameter("computedAffected", Arg) && Arg == "true") {
+			Types::UUIDvec_t DeviceSerialNumbers;
+			DB_.GetListOfAffectedDevices(UUID, DeviceSerialNumbers);
+			return ReturnObject("affectedDevices", DeviceSerialNumbers);
+		} else if (QB_.AdditionalInfo) {
+			AddExtendedInfo(Existing, Answer);
+		}
+		Existing.to_json(Answer);
+		ReturnObject(Answer);
+	}
 
-    void RESTAPI_configurations_handler::DoDelete() {
-        std::string UUID = GetBinding("uuid","");
-        ProvObjects::DeviceConfiguration   Existing;
-        if(UUID.empty() || !DB_.GetRecord("id", UUID, Existing)) {
-            return NotFound();
-        }
+	void RESTAPI_configurations_handler::DoDelete() {
+		std::string UUID = GetBinding("uuid", "");
+		ProvObjects::DeviceConfiguration Existing;
+		if (UUID.empty() || !DB_.GetRecord("id", UUID, Existing)) {
+			return NotFound();
+		}
 
-        if(!Existing.inUse.empty()) {
-            return BadRequest(RESTAPI::Errors::StillInUse);
-        }
+		if (!Existing.inUse.empty()) {
+			return BadRequest(RESTAPI::Errors::StillInUse);
+		}
 
-        if(DB_.DeleteRecord("id", UUID)) {
-            return OK();
-        }
-        InternalError(RESTAPI::Errors::CouldNotBeDeleted);
-    }
+		DB_.DeleteRecord("id", UUID);
+		MoveUsage(StorageService()->PolicyDB(), DB_, Existing.managementPolicy, "",
+				  Existing.info.id);
+		RemoveMembership(StorageService()->VenueDB(), &ProvObjects::Venue::configurations,
+						 Existing.venue, Existing.info.id);
+		RemoveMembership(StorageService()->EntityDB(), &ProvObjects::Entity::configurations,
+						 Existing.entity, Existing.info.id);
+		for (const auto &i : Existing.variables)
+			RemoveMembership(StorageService()->VariablesDB(),
+							 &ProvObjects::VariableBlock::configurations, i, Existing.info.id);
 
-    bool RESTAPI_configurations_handler::ValidateConfigBlock(const ProvObjects::DeviceConfiguration &Config, std::string & Error) {
-        static const std::vector<std::string> SectionNames{ "globals", "interfaces", "metrics", "radios", "services", "unit" };
+		return OK();
+	}
 
-        for(const auto &i:Config.configuration) {
-            Poco::JSON::Parser  P;
-            if(i.name.empty()) {
-                BadRequest(RESTAPI::Errors::NameMustBeSet);
-                return false;
-            }
-            auto Blocks = P.parse(i.configuration).extract<Poco::JSON::Object::Ptr>();
-            auto N = Blocks->getNames();
-            for(const auto &j:N) {
-                if(std::find(SectionNames.cbegin(),SectionNames.cend(),j)==SectionNames.cend()) {
-                    BadRequest(RESTAPI::Errors::ConfigBlockInvalid);
-                    return false;
-                }
-            }
+	void RESTAPI_configurations_handler::DoPost() {
+		auto UUID = GetBinding("uuid", "");
+		if (UUID.empty()) {
+			return BadRequest(RESTAPI::Errors::MissingUUID);
+		}
 
-            if(ValidateUCentralConfiguration(i.configuration, Error)) {
-                /* nothing to do */ ;
-            } else {
-                // std::cout << "Block: " << std::endl << ">>>" << std::endl << i.configuration << std::endl << ">>> REJECTED" << std::endl;
-                return false;
-            }
+		const auto &RawObject = ParsedBody_;
+		std::string Arg;
+		if (HasParameter("validateOnly", Arg) && Arg == "true") {
+			if (!RawObject->has("configuration")) {
+				return BadRequest(RESTAPI::Errors::MustHaveConfigElement);
+			}
+			auto Config = RawObject->get("configuration").toString();
+			Poco::JSON::Object Answer;
+			std::vector<std::string> Error;
+			auto Res =
+				ValidateUCentralConfiguration(Config, Error, GetBoolParameter("strict", true));
+			Answer.set("valid", Res);
+			Answer.set("error", Error);
+			return ReturnObject(Answer);
+		}
 
-        }
-        return true;
-    }
+		ProvObjects::DeviceConfiguration NewObject;
+		if (!NewObject.from_json(RawObject)) {
+			return BadRequest(RESTAPI::Errors::InvalidJSONDocument);
+		}
 
-    void RESTAPI_configurations_handler::DoPost() {
-        auto UUID = GetBinding("uuid","");
-        if(UUID.empty()) {
-            return BadRequest(RESTAPI::Errors::MissingUUID);
-        }
+		if ((RawObject->has("deviceRules") && !ValidDeviceRules(NewObject.deviceRules, *this))) {
+			return;
+		}
 
-        std::string Arg;
-        if(HasParameter("validateOnly",Arg) && Arg=="true") {
-            auto Body = ParseStream();
-            if(!Body->has("configuration")) {
-                return BadRequest("Must have 'configuration' element.");
-            }
-            auto Config=Body->get("configuration").toString();
-            Poco::JSON::Object  Answer;
-            std::string Error;
-            auto Res = ValidateUCentralConfiguration(Config,Error);
-            Answer.set("valid",Res);
-            Answer.set("error", Error);
-            return ReturnObject(Answer);
-        }
+		if (!ProvObjects::CreateObjectInfo(RawObject, UserInfo_.userinfo, NewObject.info)) {
+			return BadRequest(RESTAPI::Errors::NameMustBeSet);
+		}
 
-        ProvObjects::DeviceConfiguration C;
-        Poco::JSON::Object::Ptr Obj = ParseStream();
-        if (!C.from_json(Obj)) {
-            return BadRequest(RESTAPI::Errors::InvalidJSONDocument);
-        }
+		if (!NewObject.entity.empty() &&
+			!StorageService()->EntityDB().Exists("id", NewObject.entity)) {
+			return BadRequest(RESTAPI::Errors::EntityMustExist);
+		}
 
-        if(!ProvObjects::CreateObjectInfo(Obj,UserInfo_.userinfo,C.info)) {
-            return BadRequest(RESTAPI::Errors::NameMustBeSet);
-        }
+		if (!NewObject.venue.empty() &&
+			!StorageService()->VenueDB().Exists("id", NewObject.venue)) {
+			return BadRequest(RESTAPI::Errors::VenueMustExist);
+		}
 
-        if(!C.managementPolicy.empty() && !StorageService()->PolicyDB().Exists("id",C.managementPolicy)) {
-            return BadRequest(RESTAPI::Errors::UnknownId);
-        }
+		if (!NewObject.managementPolicy.empty() &&
+			!StorageService()->PolicyDB().Exists("id", NewObject.managementPolicy)) {
+			return BadRequest(RESTAPI::Errors::UnknownManagementPolicyUUID);
+		}
 
-        C.inUse.clear();
-        if(C.deviceTypes.empty() || !StorageService()->AreAcceptableDeviceTypes(C.deviceTypes, true)) {
-            return BadRequest(RESTAPI::Errors::InvalidDeviceTypes);
-        }
+		NewObject.inUse.clear();
+		if (NewObject.deviceTypes.empty() ||
+			!DeviceTypeCache()->AreAcceptableDeviceTypes(NewObject.deviceTypes, true)) {
+			return BadRequest(RESTAPI::Errors::InvalidDeviceTypes);
+		}
 
-        std::string Error;
-        if(!ValidateConfigBlock(C,Error)) {
-            return BadRequest(RESTAPI::Errors::ConfigBlockInvalid + ", error: " + Error);
-        }
+		std::vector<std::string> Errors;
+		if (!ValidateConfigBlock(NewObject, Errors)) {
+			return BadRequest(RESTAPI::Errors::ConfigBlockInvalid);
+		}
 
-        if(DB_.CreateRecord(C)) {
-            DB_.GetRecord("id", C.info.id, C);
-            if(!C.managementPolicy.empty())
-                StorageService()->PolicyDB().AddInUse("id",C.managementPolicy,DB_.Prefix(), C.info.id);
+		if (DB_.CreateRecord(NewObject)) {
+			MoveUsage(StorageService()->PolicyDB(), DB_, "", NewObject.managementPolicy,
+					  NewObject.info.id);
+			AddMembership(StorageService()->VenueDB(), &ProvObjects::Venue::configurations,
+						  NewObject.venue, NewObject.info.id);
+			AddMembership(StorageService()->EntityDB(), &ProvObjects::Entity::configurations,
+						  NewObject.entity, NewObject.info.id);
 
-            Poco::JSON::Object  Answer;
-            C.to_json(Answer);
-            return ReturnObject(Answer);
-        }
-        InternalError(RESTAPI::Errors::RecordNotCreated);
-    }
+			ConfigurationDB::RecordName AddedRecord;
+			DB_.GetRecord("id", NewObject.info.id, AddedRecord);
+			Poco::JSON::Object Answer;
+			AddedRecord.to_json(Answer);
+			return ReturnObject(Answer);
+		}
+		InternalError(RESTAPI::Errors::RecordNotCreated);
+	}
 
-    void RESTAPI_configurations_handler::DoPut() {
-        auto UUID = GetBinding("uuid","");
-        ProvObjects::DeviceConfiguration    Existing;
-        if(UUID.empty() || !DB_.GetRecord("id", UUID, Existing)) {
-            return NotFound();
-        }
+	void RESTAPI_configurations_handler::DoPut() {
+		auto UUID = GetBinding("uuid", "");
+		ProvObjects::DeviceConfiguration Existing;
+		if (UUID.empty() || !DB_.GetRecord("id", UUID, Existing)) {
+			return NotFound();
+		}
 
-        ProvObjects::DeviceConfiguration    NewConfig;
-        auto ParsedObj = ParseStream();
-        if (!NewConfig.from_json(ParsedObj)) {
-            return BadRequest(RESTAPI::Errors::InvalidJSONDocument);
-        }
+		ProvObjects::DeviceConfiguration NewObject;
+		const auto &RawObject = ParsedBody_;
+		if (!NewObject.from_json(RawObject)) {
+			return BadRequest(RESTAPI::Errors::InvalidJSONDocument);
+		}
 
-        if(!UpdateObjectInfo(ParsedObj, UserInfo_.userinfo, Existing.info)) {
-            return BadRequest(RESTAPI::Errors::NameMustBeSet);
-        }
+		if ((RawObject->has("deviceRules") && !ValidDeviceRules(NewObject.deviceRules, *this))) {
+			return;
+		}
 
-        if(!NewConfig.deviceTypes.empty() && !StorageService()->AreAcceptableDeviceTypes(NewConfig.deviceTypes, true)) {
-            return BadRequest(RESTAPI::Errors::InvalidDeviceTypes);
-        }
+		if (!UpdateObjectInfo(RawObject, UserInfo_.userinfo, Existing.info)) {
+			return BadRequest(RESTAPI::Errors::NameMustBeSet);
+		}
 
-        std::string Error;
-        if(!ValidateConfigBlock( NewConfig,Error)) {
-            return BadRequest(RESTAPI::Errors::ConfigBlockInvalid + ", error: " + Error);
-        }
+		if (!NewObject.deviceTypes.empty() &&
+			!DeviceTypeCache()->AreAcceptableDeviceTypes(NewObject.deviceTypes, true)) {
+			return BadRequest(RESTAPI::Errors::InvalidDeviceTypes);
+		}
 
-        if(ParsedObj->has("configuration")) {
-            Existing.configuration = NewConfig.configuration;
-        }
+		if (!NewObject.deviceTypes.empty())
+			Existing.deviceTypes = NewObject.deviceTypes;
 
-        std::string MovePolicy;
-        bool        MovingPolicy=false;
-        if(AssignIfPresent(ParsedObj,"managementPolicy",MovePolicy)) {
-            if(!MovePolicy.empty() && !StorageService()->PolicyDB().Exists("id",NewConfig.managementPolicy)) {
-                return BadRequest(RESTAPI::Errors::UnknownManagementPolicyUUID);
-            }
-            MovingPolicy = NewConfig.managementPolicy != Existing.managementPolicy;
-        }
+		std::vector<std::string> Errors;
+		if (!ValidateConfigBlock(NewObject, Errors)) {
+			return BadRequest(RESTAPI::Errors::ConfigBlockInvalid);
+		}
 
-        if(!NewConfig.deviceTypes.empty())
-            Existing.deviceTypes = NewConfig.deviceTypes;
+		if (RawObject->has("configuration")) {
+			Existing.configuration = NewObject.configuration;
+		}
 
-        AssignIfPresent(ParsedObj, "rrm", Existing.rrm);
-        AssignIfPresent(ParsedObj,"firmwareUpgrade",Existing.firmwareUpgrade);
-        AssignIfPresent(ParsedObj,"firmwareRCOnly", Existing.firmwareRCOnly);
+		std::string FromPolicy, ToPolicy;
+		if (!CreateMove(RawObject, "managementPolicy",
+						&ConfigurationDB::RecordName::managementPolicy, Existing, FromPolicy,
+						ToPolicy, StorageService()->PolicyDB()))
+			return BadRequest(RESTAPI::Errors::EntityMustExist);
 
-        if(!NewConfig.variables.empty())
-            Existing.variables = NewConfig.variables;
+		std::string FromEntity, ToEntity;
+		if (!CreateMove(RawObject, "entity", &ConfigurationDB::RecordName::entity, Existing,
+						FromEntity, ToEntity, StorageService()->EntityDB()))
+			return BadRequest(RESTAPI::Errors::EntityMustExist);
 
-        if(DB_.UpdateRecord("id",UUID,Existing)) {
-            if(MovingPolicy) {
-                if(!Existing.managementPolicy.empty())
-                    StorageService()->PolicyDB().DeleteInUse("id",Existing.managementPolicy,DB_.Prefix(),Existing.info.id);
-                if(!MovePolicy.empty())
-                    StorageService()->PolicyDB().AddInUse("id",MovePolicy,DB_.Prefix(),Existing.info.id);
-                Existing.managementPolicy = MovePolicy;
-            }
-            DB_.UpdateRecord("id", UUID, Existing);
+		std::string FromVenue, ToVenue;
+		if (!CreateMove(RawObject, "venue", &ConfigurationDB::RecordName::venue, Existing,
+						FromVenue, ToVenue, StorageService()->VenueDB()))
+			return BadRequest(RESTAPI::Errors::VenueMustExist);
 
-            ProvObjects::DeviceConfiguration    D;
-            DB_.GetRecord("id",UUID,D);
-            Poco::JSON::Object  Answer;
-            D.to_json(Answer);
-            return ReturnObject(Answer);
-        }
-        InternalError(RESTAPI::Errors::RecordNotUpdated);
-    }
-}
+		Types::UUIDvec_t FromVariables, ToVariables;
+		if (RawObject->has("variables")) {
+			for (const auto &i : NewObject.variables) {
+				if (!i.empty() && !StorageService()->VariablesDB().Exists("id", i)) {
+					return BadRequest(RESTAPI::Errors::VariableMustExist);
+				}
+			}
+			for (const auto &i : Existing.variables)
+				FromVariables.emplace_back(i);
+			for (const auto &i : NewObject.variables)
+				ToVariables.emplace_back(i);
+			FromVariables = Existing.variables;
+			ToVariables = NewObject.variables;
+			Existing.variables = ToVariables;
+		}
+
+		if (RawObject->has("deviceRules"))
+			Existing.deviceRules = NewObject.deviceRules;
+
+		if (DB_.UpdateRecord("id", UUID, Existing)) {
+			ManageMembership(StorageService()->VariablesDB(),
+							 &ProvObjects::VariableBlock::configurations, FromVariables,
+							 ToVariables, Existing.info.id);
+			ManageMembership(StorageService()->VenueDB(), &ProvObjects::Venue::configurations,
+							 FromVenue, ToVenue, Existing.info.id);
+			ManageMembership(StorageService()->EntityDB(), &ProvObjects::Entity::configurations,
+							 FromEntity, ToEntity, Existing.info.id);
+			MoveUsage(StorageService()->PolicyDB(), DB_, FromPolicy, ToPolicy, Existing.info.id);
+
+			ProvObjects::DeviceConfiguration D;
+			DB_.GetRecord("id", UUID, D);
+			Poco::JSON::Object Answer;
+			D.to_json(Answer);
+			return ReturnObject(Answer);
+		}
+		InternalError(RESTAPI::Errors::RecordNotUpdated);
+	}
+} // namespace OpenWifi

src/RESTAPI/RESTAPI_configurations_handler.h

@@ -5,34 +5,31 @@
 //	Created by Stephane Bourque on 2021-03-04.
 //	Arilia Wireless Inc.
 //
-#pragma once
 
-#include "framework/MicroService.h"
-#include "RESTObjects/RESTAPI_ProvObjects.h"
+#pragma once
 #include "StorageService.h"
+#include "framework/RESTAPI_Handler.h"
 
 namespace OpenWifi {
-    class RESTAPI_configurations_handler : public RESTAPIHandler {
-    public:
-        RESTAPI_configurations_handler(const RESTAPIHandler::BindingMap &bindings, Poco::Logger &L, RESTAPI_GenericServer & Server, uint64_t TransactionId, bool Internal)
-        : RESTAPIHandler(bindings, L,
-                         std::vector<std::string>{
-            Poco::Net::HTTPRequest::HTTP_GET, Poco::Net::HTTPRequest::HTTP_POST,
-            Poco::Net::HTTPRequest::HTTP_PUT, Poco::Net::HTTPRequest::HTTP_DELETE,
-            Poco::Net::HTTPRequest::HTTP_OPTIONS},
-            Server,
-            TransactionId,
-            Internal),
-            DB_(StorageService()->ConfigurationDB()){}
+	class RESTAPI_configurations_handler : public RESTAPIHandler {
+	  public:
+		RESTAPI_configurations_handler(const RESTAPIHandler::BindingMap &bindings, Poco::Logger &L,
+									   RESTAPI_GenericServerAccounting &Server,
+									   uint64_t TransactionId, bool Internal)
+			: RESTAPIHandler(bindings, L,
+							 std::vector<std::string>{Poco::Net::HTTPRequest::HTTP_GET,
+													  Poco::Net::HTTPRequest::HTTP_POST,
+													  Poco::Net::HTTPRequest::HTTP_PUT,
+													  Poco::Net::HTTPRequest::HTTP_DELETE,
+													  Poco::Net::HTTPRequest::HTTP_OPTIONS},
+							 Server, TransactionId, Internal) {}
+		static auto PathName() { return std::list<std::string>{"/api/v1/configuration/{uuid}"}; };
 
-        static const std::list<const char *> PathName() { return std::list<const char *>{"/api/v1/configurations/{uuid}"}; };
-
-        void DoGet();
-        void DoPost();
-        void DoPut();
-        void DoDelete();
-    private:
-        bool ValidateConfigBlock(const ProvObjects::DeviceConfiguration &Config, std::string & Error);
-        ConfigurationDB     &DB_;
-    };
-}
+	  private:
+		ConfigurationDB &DB_ = StorageService()->ConfigurationDB();
+		void DoGet();
+		void DoPost();
+		void DoPut();
+		void DoDelete();
+	};
+} // namespace OpenWifi

src/RESTAPI/RESTAPI_configurations_list_handler.cpp

@@ -4,23 +4,12 @@
 
 #include "RESTAPI_configurations_list_handler.h"
 
+#include "RESTAPI_db_helpers.h"
 #include "RESTObjects/RESTAPI_ProvObjects.h"
 #include "StorageService.h"
-#include "RESTAPI_db_helpers.h"
 
-namespace OpenWifi{
-    void RESTAPI_configurations_list_handler::DoGet() {
-        if(!QB_.Select.empty()) {
-            return ReturnRecordList<decltype(StorageService()->ConfigurationDB()),
-                    ProvObjects::DeviceConfiguration>("configurations",StorageService()->ConfigurationDB(),*this );
-        } else if(QB_.CountOnly) {
-            Poco::JSON::Object  Answer;
-            auto C = StorageService()->ConfigurationDB().Count();
-            return ReturnCountOnly(C);
-        } else {
-            ProvObjects::DeviceConfigurationVec Configs;
-            StorageService()->ConfigurationDB().GetRecords(QB_.Offset,QB_.Limit,Configs);
-            return MakeJSONObjectArray("configurations", Configs, *this);
-        }
-    }
-}
+namespace OpenWifi {
+	void RESTAPI_configurations_list_handler::DoGet() {
+		return ListHandler<ConfigurationDB>("configurations", DB_, *this);
+	}
+} // namespace OpenWifi

src/RESTAPI/RESTAPI_configurations_list_handler.h

@@ -3,27 +3,28 @@
 //
 
 #pragma once
-
-#include "framework/MicroService.h"
+#include "StorageService.h"
+#include "framework/RESTAPI_Handler.h"
 
 namespace OpenWifi {
 
-    class RESTAPI_configurations_list_handler : public RESTAPIHandler {
-    public:
-        RESTAPI_configurations_list_handler(const RESTAPIHandler::BindingMap &bindings, Poco::Logger &L, RESTAPI_GenericServer & Server, uint64_t TransactionId, bool Internal)
-        : RESTAPIHandler(bindings, L,
-                         std::vector<std::string>{
-            Poco::Net::HTTPRequest::HTTP_GET,
-            Poco::Net::HTTPRequest::HTTP_OPTIONS},
-            Server,
-            TransactionId,
-            Internal) {}
+	class RESTAPI_configurations_list_handler : public RESTAPIHandler {
+	  public:
+		RESTAPI_configurations_list_handler(const RESTAPIHandler::BindingMap &bindings,
+											Poco::Logger &L,
+											RESTAPI_GenericServerAccounting &Server,
+											uint64_t TransactionId, bool Internal)
+			: RESTAPIHandler(bindings, L,
+							 std::vector<std::string>{Poco::Net::HTTPRequest::HTTP_GET,
+													  Poco::Net::HTTPRequest::HTTP_OPTIONS},
+							 Server, TransactionId, Internal) {}
+		static auto PathName() { return std::list<std::string>{"/api/v1/configuration"}; };
 
-        static const std::list<const char *> PathName() { return std::list<const char *>{"/api/v1/configurations"}; };
-
-        void DoGet() final;
-        void DoPost() final {};
-        void DoPut() final {};
-        void DoDelete() final {};
-    };
-}
+	  private:
+		ConfigurationDB &DB_ = StorageService()->ConfigurationDB();
+		void DoGet() final;
+		void DoPost() final{};
+		void DoPut() final{};
+		void DoDelete() final{};
+	};
+} // namespace OpenWifi

src/RESTAPI/RESTAPI_contact_handler.cpp

@@ -8,197 +8,171 @@
 
 #include "RESTAPI_contact_handler.h"
 
-#include "framework/RESTAPI_protocol.h"
-#include "framework/RESTAPI_errors.h"
-#include "RESTObjects/RESTAPI_ProvObjects.h"
 #include "RESTAPI_db_helpers.h"
+#include "RESTObjects/RESTAPI_ProvObjects.h"
+#include "framework/ow_constants.h"
 
-namespace OpenWifi{
-    void RESTAPI_contact_handler::DoGet() {
+namespace OpenWifi {
+	void RESTAPI_contact_handler::DoGet() {
 
-        std::string UUID = GetBinding("uuid","");
-        ProvObjects::Contact   Existing;
-        if(UUID.empty() || !DB_.GetRecord("id", UUID, Existing)) {
-            return NotFound();
-        }
+		std::string UUID = GetBinding("uuid", "");
+		ProvObjects::Contact Existing;
+		if (UUID.empty() || !DB_.GetRecord("id", UUID, Existing)) {
+			return NotFound();
+		}
 
-        Poco::JSON::Object  Answer;
-        std::string Arg;
+		Poco::JSON::Object Answer;
+		std::string Arg;
 
-        if(HasParameter("expandInUse",Arg) && Arg=="true") {
-            Storage::ExpandedListMap    M;
-            std::vector<std::string>    Errors;
-            Poco::JSON::Object  Inner;
-            if(StorageService()->ExpandInUse(Existing.inUse,M,Errors)) {
-                for(const auto &[type,list]:M) {
-                    Poco::JSON::Array   ObjList;
-                    for(const auto &i:list.entries) {
-                        Poco::JSON::Object  O;
-                        i.to_json(O);
-                        ObjList.add(O);
-                    }
-                    Inner.set(type,ObjList);
-                }
-            }
-            Answer.set("entries", Inner);
-            return ReturnObject(Answer);
-        } else if(QB_.AdditionalInfo) {
-            AddExtendedInfo(Existing, Answer);
-        }
+		if (HasParameter("expandInUse", Arg) && Arg == "true") {
+			Storage::ExpandedListMap M;
+			std::vector<std::string> Errors;
+			Poco::JSON::Object Inner;
+			if (StorageService()->ExpandInUse(Existing.inUse, M, Errors)) {
+				for (const auto &[type, list] : M) {
+					Poco::JSON::Array ObjList;
+					for (const auto &i : list.entries) {
+						Poco::JSON::Object O;
+						i.to_json(O);
+						ObjList.add(O);
+					}
+					Inner.set(type, ObjList);
+				}
+			}
+			Answer.set("entries", Inner);
+			return ReturnObject(Answer);
+		} else if (QB_.AdditionalInfo) {
+			AddExtendedInfo(Existing, Answer);
+		}
 
-        Existing.to_json(Answer);
-        ReturnObject(Answer);
-    }
+		Existing.to_json(Answer);
+		ReturnObject(Answer);
+	}
 
-    void RESTAPI_contact_handler::DoDelete() {
+	void RESTAPI_contact_handler::DoDelete() {
 
-        std::string UUID = GetBinding("uuid","");
-        ProvObjects::Contact   Existing;
-        if(UUID.empty() || !DB_.GetRecord("id", UUID, Existing)) {
-            return NotFound();
-        }
+		std::string UUID = GetBinding("uuid", "");
+		ProvObjects::Contact Existing;
+		if (UUID.empty() || !DB_.GetRecord("id", UUID, Existing)) {
+			return NotFound();
+		}
 
-        bool Force=false;
-        std::string Arg;
-        if(HasParameter("force",Arg) && Arg=="true")
-            Force=true;
+		bool Force = false;
+		std::string Arg;
+		if (HasParameter("force", Arg) && Arg == "true")
+			Force = true;
 
-        if(!Force && !Existing.inUse.empty()) {
-            return BadRequest(RESTAPI::Errors::StillInUse);
-        }
+		if (!Force && !Existing.inUse.empty()) {
+			return BadRequest(RESTAPI::Errors::StillInUse);
+		}
 
-        if(DB_.DeleteRecord("id",UUID)) {
-            if(!Existing.entity.empty())
-                StorageService()->EntityDB().DeleteLocation("id",Existing.entity,UUID);
-            return OK();
-        }
-        InternalError(RESTAPI::Errors::CouldNotBeDeleted);
-    }
+		DB_.DeleteRecord("id", UUID);
+		RemoveMembership(StorageService()->EntityDB(), &ProvObjects::Entity::contacts,
+						 Existing.entity, Existing.info.id);
+		MoveUsage(StorageService()->PolicyDB(), DB_, Existing.info.id, "", Existing.info.id);
+		return OK();
+	}
 
-    void RESTAPI_contact_handler::DoPost() {
-        std::string UUID = GetBinding(RESTAPI::Protocol::UUID,"");
+	void RESTAPI_contact_handler::DoPost() {
+		std::string UUID = GetBinding(RESTAPI::Protocol::UUID, "");
 
-        if(UUID.empty()) {
-            return BadRequest(RESTAPI::Errors::MissingUUID);
-        }
+		if (UUID.empty()) {
+			return BadRequest(RESTAPI::Errors::MissingUUID);
+		}
 
-        auto Obj = ParseStream();
-        ProvObjects::Contact NewObject;
-        if (!NewObject.from_json(Obj)) {
-            return BadRequest(RESTAPI::Errors::InvalidJSONDocument);
-        }
+		const auto &Obj = ParsedBody_;
+		ProvObjects::Contact NewObject;
+		if (!NewObject.from_json(Obj)) {
+			return BadRequest(RESTAPI::Errors::InvalidJSONDocument);
+		}
 
-        if(!ProvObjects::CreateObjectInfo(Obj,UserInfo_.userinfo,NewObject.info)) {
-            return BadRequest(RESTAPI::Errors::NameMustBeSet);
-        }
+		if (!ProvObjects::CreateObjectInfo(Obj, UserInfo_.userinfo, NewObject.info)) {
+			return BadRequest(RESTAPI::Errors::NameMustBeSet);
+		}
 
-        if(NewObject.entity.empty() || !StorageService()->EntityDB().Exists("id",NewObject.entity)) {
-            return BadRequest(RESTAPI::Errors::EntityMustExist);
-        }
+		if (NewObject.entity.empty() &&
+			!StorageService()->EntityDB().Exists("id", NewObject.entity)) {
+			return BadRequest(RESTAPI::Errors::EntityMustExist);
+		}
 
-        if(!NewObject.managementPolicy.empty() && !StorageService()->PolicyDB().Exists("id",NewObject.managementPolicy)) {
-            return BadRequest(RESTAPI::Errors::UnknownManagementPolicyUUID);
-        }
+		if (!NewObject.managementPolicy.empty() &&
+			!StorageService()->PolicyDB().Exists("id", NewObject.managementPolicy)) {
+			return BadRequest(RESTAPI::Errors::UnknownManagementPolicyUUID);
+		}
 
-        NewObject.inUse.clear();
+		NewObject.inUse.clear();
 
-        if(DB_.CreateRecord(NewObject)) {
+		if (DB_.CreateRecord(NewObject)) {
+			AddMembership(StorageService()->EntityDB(), &ProvObjects::Entity::contacts,
+						  NewObject.entity, NewObject.info.id);
+			MoveUsage(StorageService()->PolicyDB(), DB_, "", NewObject.managementPolicy,
+					  NewObject.info.id);
 
-            StorageService()->EntityDB().AddContact("id",NewObject.entity,NewObject.info.id);
-            if(!NewObject.managementPolicy.empty())
-                StorageService()->PolicyDB().AddInUse("id",NewObject.managementPolicy,DB_.Prefix(),NewObject.info.id);
+			ProvObjects::Contact NewContact;
+			StorageService()->ContactDB().GetRecord("id", NewObject.info.id, NewContact);
 
-            ProvObjects::Contact    NewContact;
-            StorageService()->ContactDB().GetRecord("id", NewObject.info.id, NewContact);
+			Poco::JSON::Object Answer;
+			NewContact.to_json(Answer);
+			ReturnObject(Answer);
+			return;
+		}
+		InternalError(RESTAPI::Errors::RecordNotCreated);
+	}
 
-            Poco::JSON::Object Answer;
-            NewContact.to_json(Answer);
-            ReturnObject(Answer);
-            return;
-        }
-        InternalError(RESTAPI::Errors::RecordNotCreated);
-    }
+	void RESTAPI_contact_handler::DoPut() {
+		std::string UUID = GetBinding(RESTAPI::Protocol::UUID, "");
+		ProvObjects::Contact Existing;
+		if (UUID.empty() || !DB_.GetRecord("id", UUID, Existing)) {
+			return NotFound();
+		}
 
-    void RESTAPI_contact_handler::DoPut() {
-        std::string UUID = GetBinding(RESTAPI::Protocol::UUID,"");
-        ProvObjects::Contact   Existing;
-        if(UUID.empty() || !DB_.GetRecord("id", UUID, Existing)) {
-            return NotFound();
-        }
+		const auto &RawObject = ParsedBody_;
+		ProvObjects::Contact NewObject;
+		if (!NewObject.from_json(RawObject)) {
+			return BadRequest(RESTAPI::Errors::InvalidJSONDocument);
+		}
 
-        auto RawObject = ParseStream();
-        ProvObjects::Contact NewObject;
-        if (!NewObject.from_json(RawObject)) {
-            return BadRequest(RESTAPI::Errors::InvalidJSONDocument);
-        }
+		if (!UpdateObjectInfo(RawObject, UserInfo_.userinfo, Existing.info)) {
+			return BadRequest(RESTAPI::Errors::NameMustBeSet);
+		}
 
-        if(!UpdateObjectInfo(RawObject, UserInfo_.userinfo, Existing.info)) {
-            return BadRequest(RESTAPI::Errors::NameMustBeSet);
-        }
+		std::string FromPolicy, ToPolicy;
+		if (!CreateMove(RawObject, "managementPolicy", &ContactDB::RecordName::managementPolicy,
+						Existing, FromPolicy, ToPolicy, StorageService()->PolicyDB()))
+			return BadRequest(RESTAPI::Errors::EntityMustExist);
 
-        std::string MoveToPolicy, MoveFromPolicy;
-        bool MovingPolicy=false;
-        if(AssignIfPresent(RawObject,"managementPolicy",MoveToPolicy)) {
-            if(!MoveToPolicy.empty() && !StorageService()->PolicyDB().Exists("id",MoveToPolicy)) {
-                return BadRequest(RESTAPI::Errors::UnknownManagementPolicyUUID);
-            }
-            MoveFromPolicy = Existing.managementPolicy;
-            MovingPolicy = MoveToPolicy != Existing.managementPolicy;
-        }
+		std::string FromEntity, ToEntity;
+		if (!CreateMove(RawObject, "entity", &ContactDB::RecordName::entity, Existing, FromEntity,
+						ToEntity, StorageService()->EntityDB()))
+			return BadRequest(RESTAPI::Errors::EntityMustExist);
 
-        std::string MoveToEntity,MoveFromEntity;
-        bool MovingEntity=false;
-        if(AssignIfPresent(RawObject,"entity",MoveToEntity)) {
-            if(!MoveToEntity.empty() && !StorageService()->EntityDB().Exists("id",MoveToEntity)) {
-                return BadRequest(RESTAPI::Errors::EntityMustExist);
-            }
-            MoveFromEntity = Existing.entity;
-            MovingEntity = MoveToEntity != Existing.entity ;
-        }
+		AssignIfPresent(RawObject, "title", Existing.title);
+		AssignIfPresent(RawObject, "salutation", Existing.salutation);
+		AssignIfPresent(RawObject, "firstname", Existing.firstname);
+		AssignIfPresent(RawObject, "lastname", Existing.lastname);
+		AssignIfPresent(RawObject, "initials", Existing.initials);
+		AssignIfPresent(RawObject, "visual", Existing.visual);
+		AssignIfPresent(RawObject, "primaryEmail", Existing.primaryEmail);
+		AssignIfPresent(RawObject, "secondaryEmail", Existing.secondaryEmail);
+		AssignIfPresent(RawObject, "accessPIN", Existing.accessPIN);
+		if (RawObject->has("type"))
+			Existing.type = NewObject.type;
+		if (RawObject->has("mobiles"))
+			Existing.mobiles = NewObject.mobiles;
+		if (RawObject->has("phones"))
+			Existing.phones = NewObject.phones;
 
-        AssignIfPresent(RawObject, "title", Existing.title);
-        AssignIfPresent(RawObject, "salutation", Existing.salutation);
-        AssignIfPresent(RawObject, "firstname", Existing.firstname);
-        AssignIfPresent(RawObject, "lastname", Existing.lastname);
-        AssignIfPresent(RawObject, "initials", Existing.initials);
-        AssignIfPresent(RawObject, "visual", Existing.visual);
-        AssignIfPresent(RawObject, "primaryEmail", Existing.primaryEmail);
-        AssignIfPresent(RawObject, "secondaryEmail", Existing.secondaryEmail);
-        AssignIfPresent(RawObject, "accessPIN", Existing.accessPIN);
-        if(RawObject->has("type"))
-            Existing.type = NewObject.type;
-        if(RawObject->has("mobiles"))
-            Existing.mobiles = NewObject.mobiles;
-        if(RawObject->has("phones"))
-            Existing.phones = NewObject.phones;
+		if (DB_.UpdateRecord("id", UUID, Existing)) {
+			MoveUsage(StorageService()->PolicyDB(), DB_, FromPolicy, ToPolicy, Existing.info.id);
+			ManageMembership(StorageService()->EntityDB(), &ProvObjects::Entity::contacts,
+							 FromEntity, ToEntity, Existing.info.id);
 
-        Existing.entity = MoveToEntity;
-        Existing.managementPolicy = MoveToPolicy;
-
-        if(DB_.UpdateRecord("id", UUID, Existing)) {
-
-            if(MovingPolicy) {
-                if(!MoveFromPolicy.empty())
-                    StorageService()->PolicyDB().DeleteInUse("id",MoveFromPolicy,DB_.Prefix(),Existing.info.id);
-                if(!MoveToPolicy.empty())
-                    StorageService()->PolicyDB().AddInUse("id", MoveToPolicy, DB_.Prefix(), Existing.info.id);
-            }
-
-            if(MovingEntity) {
-                if(!MoveFromEntity.empty()) {
-                    StorageService()->EntityDB().DeleteContact("id", MoveFromEntity, Existing.info.id);
-                }
-                if(!MoveToEntity.empty()) {
-                    StorageService()->EntityDB().AddContact("id", MoveToEntity, Existing.info.id);
-                }
-            }
-
-            ProvObjects::Contact    NewObjectAdded;
-            DB_.GetRecord("id", UUID, NewObjectAdded);
-            Poco::JSON::Object  Answer;
-            NewObjectAdded.to_json(Answer);
-            return ReturnObject(Answer);
-        }
-        InternalError(RESTAPI::Errors::RecordNotUpdated);
-    }
-}
+			ProvObjects::Contact NewObjectAdded;
+			DB_.GetRecord("id", UUID, NewObjectAdded);
+			Poco::JSON::Object Answer;
+			NewObjectAdded.to_json(Answer);
+			return ReturnObject(Answer);
+		}
+		InternalError(RESTAPI::Errors::RecordNotUpdated);
+	}
+} // namespace OpenWifi

src/RESTAPI/RESTAPI_contact_handler.h

@@ -7,30 +7,29 @@
 //
 
 #pragma once
-
-#include "framework/MicroService.h"
 #include "StorageService.h"
+#include "framework/RESTAPI_Handler.h"
 
 namespace OpenWifi {
-    class RESTAPI_contact_handler : public RESTAPIHandler {
-    public:
-        RESTAPI_contact_handler(const RESTAPIHandler::BindingMap &bindings, Poco::Logger &L, RESTAPI_GenericServer & Server, uint64_t TransactionId, bool Internal)
-        : RESTAPIHandler(bindings, L,
-                         std::vector<std::string>{
-            Poco::Net::HTTPRequest::HTTP_GET, Poco::Net::HTTPRequest::HTTP_POST,
-            Poco::Net::HTTPRequest::HTTP_PUT, Poco::Net::HTTPRequest::HTTP_DELETE,
-            Poco::Net::HTTPRequest::HTTP_OPTIONS},
-            Server,
-            TransactionId,
-            Internal),
-            DB_(StorageService()->ContactDB()){}
-        static const std::list<const char *> PathName() { return std::list<const char *>{"/api/v1/contact/{uuid}"}; };
+	class RESTAPI_contact_handler : public RESTAPIHandler {
+	  public:
+		RESTAPI_contact_handler(const RESTAPIHandler::BindingMap &bindings, Poco::Logger &L,
+								RESTAPI_GenericServerAccounting &Server, uint64_t TransactionId,
+								bool Internal)
+			: RESTAPIHandler(bindings, L,
+							 std::vector<std::string>{Poco::Net::HTTPRequest::HTTP_GET,
+													  Poco::Net::HTTPRequest::HTTP_POST,
+													  Poco::Net::HTTPRequest::HTTP_PUT,
+													  Poco::Net::HTTPRequest::HTTP_DELETE,
+													  Poco::Net::HTTPRequest::HTTP_OPTIONS},
+							 Server, TransactionId, Internal) {}
+		static auto PathName() { return std::list<std::string>{"/api/v1/contact/{uuid}"}; };
 
-    private:
-        void DoGet() final;
-        void DoPost() final;
-        void DoPut() final;
-        void DoDelete() final;
-        ContactDB       &DB_;
-    };
-}
+	  private:
+		ContactDB &DB_ = StorageService()->ContactDB();
+		void DoGet() final;
+		void DoPost() final;
+		void DoPut() final;
+		void DoDelete() final;
+	};
+} // namespace OpenWifi

src/RESTAPI/RESTAPI_contact_list_handler.cpp

@@ -4,23 +4,12 @@
 
 #include "RESTAPI_contact_list_handler.h"
 
+#include "RESTAPI_db_helpers.h"
 #include "RESTObjects/RESTAPI_ProvObjects.h"
 #include "StorageService.h"
-#include "RESTAPI_db_helpers.h"
 
-namespace OpenWifi{
-    void RESTAPI_contact_list_handler::DoGet() {
-        if(!QB_.Select.empty()) {
-            return ReturnRecordList<decltype(StorageService()->ContactDB()),
-            ProvObjects::Contact>("contacts",StorageService()->ContactDB(),*this );
-        } else if(QB_.CountOnly) {
-            Poco::JSON::Object  Answer;
-            auto C = StorageService()->ContactDB().Count();
-            return ReturnCountOnly(C);
-        } else {
-            ProvObjects::ContactVec Contacts;
-            StorageService()->ContactDB().GetRecords(QB_.Offset,QB_.Limit,Contacts);
-            return MakeJSONObjectArray("contacts", Contacts, *this);
-        }
-    }
-}
+namespace OpenWifi {
+	void RESTAPI_contact_list_handler::DoGet() {
+		return ListHandler<ContactDB>("contacts", DB_, *this);
+	}
+} // namespace OpenWifi

src/RESTAPI/RESTAPI_contact_list_handler.h

@@ -3,27 +3,27 @@
 //
 
 #pragma once
-
-#include "framework/MicroService.h"
-#include "RESTObjects/RESTAPI_ProvObjects.h"
+#include "StorageService.h"
+#include "framework/RESTAPI_Handler.h"
 
 namespace OpenWifi {
 
-    class RESTAPI_contact_list_handler : public RESTAPIHandler {
-    public:
-        RESTAPI_contact_list_handler(const RESTAPIHandler::BindingMap &bindings, Poco::Logger &L, RESTAPI_GenericServer & Server, uint64_t TransactionId, bool Internal)
-        : RESTAPIHandler(bindings, L,
-                         std::vector<std::string>{
-            Poco::Net::HTTPRequest::HTTP_GET,
-            Poco::Net::HTTPRequest::HTTP_OPTIONS},
-            Server,
-            TransactionId,
-            Internal) {}
-        static const std::list<const char *> PathName() { return std::list<const char *>{"/api/v1/contact"}; };
+	class RESTAPI_contact_list_handler : public RESTAPIHandler {
+	  public:
+		RESTAPI_contact_list_handler(const RESTAPIHandler::BindingMap &bindings, Poco::Logger &L,
+									 RESTAPI_GenericServerAccounting &Server,
+									 uint64_t TransactionId, bool Internal)
+			: RESTAPIHandler(bindings, L,
+							 std::vector<std::string>{Poco::Net::HTTPRequest::HTTP_GET,
+													  Poco::Net::HTTPRequest::HTTP_OPTIONS},
+							 Server, TransactionId, Internal) {}
+		static auto PathName() { return std::list<std::string>{"/api/v1/contact"}; };
 
-        void DoGet() final;
-        void DoPost() final {};
-        void DoPut() final {};
-        void DoDelete() final {};
-    };
-}
+	  private:
+		ContactDB &DB_ = StorageService()->ContactDB();
+		void DoGet() final;
+		void DoPost() final{};
+		void DoPut() final{};
+		void DoDelete() final{};
+	};
+} // namespace OpenWifi

src/RESTAPI/RESTAPI_db_helpers.h

@@ -4,212 +4,727 @@
 
 #pragma once
 
+#include "Poco/StringTokenizer.h"
 #include "RESTObjects/RESTAPI_ProvObjects.h"
 #include "StorageService.h"
-#include "framework/MicroService.h"
-#include "framework/RESTAPI_errors.h"
+#include "framework/ConfigurationValidator.h"
+#include "libs/croncpp.h"
+#include "sdks/SDK_sec.h"
 
 namespace OpenWifi {
 
-    static void AddInfoBlock(const ProvObjects::ObjectInfo & O, Poco::JSON::Object &J) {
-        J.set("name", O.name);
-        J.set("description", O.description);
-        J.set("id", O.id);
-    }
+	inline static void AddInfoBlock(const ProvObjects::ObjectInfo &O, Poco::JSON::Object &J) {
+		J.set("name", O.name);
+		J.set("description", O.description);
+		J.set("id", O.id);
+	}
 
-    template <typename R, typename Q = decltype(R{}.entity)> void Extend_entity(const R &T, Poco::JSON::Object &EI ) {
-        if constexpr(std::is_same_v<Q,std::string>) {
-            if(!T.entity.empty()) {
-                Poco::JSON::Object  EntObj;
-                ProvObjects::Entity Entity;
-                if(StorageService()->EntityDB().GetRecord("id",T.entity,Entity)) {
-                    AddInfoBlock(Entity.info, EntObj);
-                }
-                EI.set("entity",EntObj);
-            }
-        }
-    }
-    template <typename... Ts> void Extend_entity(Ts... args) {
-        static_assert( sizeof...(args) == 2);
-    }
+	template <typename R, typename Q = decltype(R{}.entity)>
+	void Extend_entity(const R &T, Poco::JSON::Object &EI) {
+		if constexpr (std::is_same_v<Q, std::string>) {
+			if (!T.entity.empty()) {
+				Poco::JSON::Object EntObj;
+				ProvObjects::Entity Entity;
+				if (StorageService()->EntityDB().GetRecord("id", T.entity, Entity)) {
+					AddInfoBlock(Entity.info, EntObj);
+				}
+				EI.set("entity", EntObj);
+			}
+		}
+	}
+	template <typename... Ts> void Extend_entity(Ts... args) {
+		static_assert(sizeof...(args) == 2);
+	}
 
-    template <typename R, typename Q = decltype(R{}.managementPolicy)> void Extend_managementPolicy(const R &T, Poco::JSON::Object &EI ) {
-        if constexpr(std::is_same_v<Q,std::string>) {
-            if(!T.managementPolicy.empty()) {
-                Poco::JSON::Object  PolObj;
-                ProvObjects::ManagementPolicy Policy;
-                if(StorageService()->PolicyDB().GetRecord("id",T.managementPolicy,Policy)) {
-                    AddInfoBlock(Policy.info, PolObj);
-                }
-                EI.set("managementPolicy",PolObj);
-            }
-        }
-    }
-    template <typename... Ts> void Extend_managementPolicy(Ts... args) {
-        static_assert( sizeof...(args) == 2);
-    }
+	template <typename R, typename Q = decltype(R{}.managementPolicy)>
+	void Extend_managementPolicy(const R &T, Poco::JSON::Object &EI) {
+		if constexpr (std::is_same_v<Q, std::string>) {
+			if (!T.managementPolicy.empty()) {
+				Poco::JSON::Object PolObj;
+				ProvObjects::ManagementPolicy Policy;
+				if (StorageService()->PolicyDB().GetRecord("id", T.managementPolicy, Policy)) {
+					AddInfoBlock(Policy.info, PolObj);
+				}
+				EI.set("managementPolicy", PolObj);
+			}
+		}
+	}
+	template <typename... Ts> void Extend_managementPolicy(Ts... args) {
+		static_assert(sizeof...(args) == 2);
+	}
 
-    template <typename R, typename Q = decltype(R{}.venue)> void Extend_venue(const R &T, Poco::JSON::Object &EI ) {
-        if constexpr(std::is_same_v<Q,std::string>) {
-            if(!T.venue.empty()) {
-                Poco::JSON::Object  VenObj;
-                ProvObjects::Venue Venue;
-                if(StorageService()->VenueDB().GetRecord("id",T.venue,Venue)) {
-                    AddInfoBlock(Venue.info, VenObj);
-                }
-                EI.set("venue",VenObj);
-            }
-        }
-    }
-    template <typename... Ts> void Extend_venue(Ts... args) {
-        static_assert( sizeof...(args) == 2);
-    }
+	template <typename R, typename Q = decltype(R{}.venue)>
+	void Extend_venue(const R &T, Poco::JSON::Object &EI) {
+		if constexpr (std::is_same_v<Q, std::string>) {
+			if (!T.venue.empty()) {
+				Poco::JSON::Object VenObj;
+				ProvObjects::Venue Venue;
+				if (StorageService()->VenueDB().GetRecord("id", T.venue, Venue)) {
+					AddInfoBlock(Venue.info, VenObj);
+				}
+				EI.set("venue", VenObj);
+			}
+		}
+	}
+	template <typename... Ts> void Extend_venue(Ts... args) { static_assert(sizeof...(args) == 2); }
 
-    template <typename R, typename Q = decltype(R{}.contact)> void Extend_contact(const R &T, Poco::JSON::Object &EI ) {
-        if constexpr(std::is_same_v<Q,std::string>) {
-            if(!T.contact.empty()) {
-                Poco::JSON::Object  ConObj;
-                ProvObjects::Contact Contact;
-                if(StorageService()->ContactDB().GetRecord("id",T.contact,Contact)) {
-                    AddInfoBlock(Contact.info, ConObj);
-                }
-                EI.set("contact",ConObj);
-            }
-        }
-    }
-    template <typename... Ts> void Extend_contact(Ts... args) {
-        static_assert( sizeof...(args) == 2);
-    }
+	template <typename R, typename Q = decltype(R{}.contact)>
+	void Extend_contact(const R &T, Poco::JSON::Object &EI) {
+		if constexpr (std::is_same_v<Q, std::string>) {
+			if (!T.contact.empty()) {
+				Poco::JSON::Object ConObj;
+				ProvObjects::Contact Contact;
+				if (StorageService()->ContactDB().GetRecord("id", T.contact, Contact)) {
+					AddInfoBlock(Contact.info, ConObj);
+				}
+				EI.set("contact", ConObj);
+			}
+		}
+	}
+	template <typename... Ts> void Extend_contact(Ts... args) {
+		static_assert(sizeof...(args) == 2);
+	}
 
-    template <typename R, typename Q = decltype(R{}.location)> void Extend_location(const R &T, Poco::JSON::Object &EI ) {
-        if constexpr(std::is_same_v<Q,std::string>) {
-            if(!T.location.empty()) {
-                Poco::JSON::Object  LocObj;
-                ProvObjects::Location Location;
-                if(StorageService()->LocationDB().GetRecord("id",T.location,Location)) {
-                    AddInfoBlock(Location.info, LocObj);
-                }
-                EI.set("location",LocObj);
-            }
-        }
-    }
-    template <typename... Ts> void Extend_location(Ts... args) {
-        static_assert( sizeof...(args) == 2);
-    }
+	template <typename R, typename Q = decltype(R{}.location)>
+	void Extend_location(const R &T, Poco::JSON::Object &EI) {
+		if constexpr (std::is_same_v<Q, std::string>) {
+			if (!T.location.empty()) {
+				Poco::JSON::Object LocObj;
+				ProvObjects::Location Location;
+				if (StorageService()->LocationDB().GetRecord("id", T.location, Location)) {
+					AddInfoBlock(Location.info, LocObj);
+				}
+				EI.set("location", LocObj);
+			}
+		}
+	}
+	template <typename... Ts> void Extend_location(Ts... args) {
+		static_assert(sizeof...(args) == 2);
+	}
 
-    template <typename R, typename Q = decltype(R{}.deviceConfiguration)> void Extend_deviceConfiguration(const R &T, Poco::JSON::Object &EI ) {
-        if constexpr(std::is_same_v<Q,std::string>) {
-            if(!T.deviceConfiguration.empty()) {
-                Poco::JSON::Object  DevObj;
-                ProvObjects::DeviceConfiguration DevConf;
-                if(StorageService()->ConfigurationDB().GetRecord("id",T.deviceConfiguration,DevConf)) {
-                    AddInfoBlock(DevConf.info, DevObj);
-                }
-                EI.set("deviceConfiguration",DevObj);
-            }
-        }
-        if constexpr(std::is_same_v<Q,Types::UUIDvec_t>) {
-            if(!T.deviceConfiguration.empty()) {
-                Poco::JSON::Array  ObjArr;
-                ProvObjects::DeviceConfiguration DevConf;
-                for(const auto &i:T.deviceConfiguration) {
-                    if(StorageService()->ConfigurationDB().GetRecord("id",i,DevConf)) {
-                        Poco::JSON::Object  InnerObj;
-                        AddInfoBlock(DevConf.info, InnerObj);
-                        ObjArr.add(InnerObj);
-                    }
-                }
-                EI.set("deviceConfiguration",ObjArr);
-            }
-        }
-    }
+	template <typename R, typename Q = decltype(R{}.deviceConfiguration)>
+	void Extend_deviceConfiguration(const R &T, Poco::JSON::Object &EI) {
+		if constexpr (std::is_same_v<Q, std::string>) {
+			if (!T.deviceConfiguration.empty()) {
+				Poco::JSON::Object DevObj;
+				ProvObjects::DeviceConfiguration DevConf;
+				if (StorageService()->ConfigurationDB().GetRecord("id", T.deviceConfiguration,
+																  DevConf)) {
+					AddInfoBlock(DevConf.info, DevObj);
+				}
+				EI.set("deviceConfiguration", DevObj);
+			}
+		}
+		if constexpr (std::is_same_v<Q, Types::UUIDvec_t>) {
+			if (!T.deviceConfiguration.empty()) {
+				Poco::JSON::Array ObjArr;
+				ProvObjects::DeviceConfiguration DevConf;
+				for (const auto &i : T.deviceConfiguration) {
+					if (StorageService()->ConfigurationDB().GetRecord("id", i, DevConf)) {
+						Poco::JSON::Object InnerObj;
+						AddInfoBlock(DevConf.info, InnerObj);
+						ObjArr.add(InnerObj);
+					}
+				}
+				EI.set("deviceConfiguration", ObjArr);
+			}
+		}
+	}
 
-    template <typename... Ts> void Extend_deviceConfiguration(Ts... args) {
-        static_assert( sizeof...(args) == 2);
-    }
+	template <typename... Ts> void Extend_deviceConfiguration(Ts... args) {
+		static_assert(sizeof...(args) == 2);
+	}
 
-    template <typename R> bool AddExtendedInfo(const R & T, Poco::JSON::Object &O) {
-        Poco::JSON::Object  EI;
-        Extend_entity(T,EI);
-        Extend_deviceConfiguration(T,EI);
-        Extend_location(T,EI);
-        Extend_contact(T,EI);
-        Extend_venue(T,EI);
-        Extend_managementPolicy(T,EI);
-        O.set("extendedInfo", EI);
-        return true;
-    }
+	template <typename R> bool AddExtendedInfo(const R &T, Poco::JSON::Object &O) {
+		Poco::JSON::Object EI;
+		Extend_entity(T, EI);
+		Extend_deviceConfiguration(T, EI);
+		Extend_location(T, EI);
+		Extend_contact(T, EI);
+		Extend_venue(T, EI);
+		Extend_managementPolicy(T, EI);
+		O.set("extendedInfo", EI);
+		return true;
+	}
 
-    template <typename T> void MakeJSONObjectArray(const char * ArrayName, const std::vector<T> & V, RESTAPIHandler & R) {
-        Poco::JSON::Array   ObjArray;
-        for(const auto &i:V) {
-            Poco::JSON::Object  Obj;
-            i.to_json(Obj);
-            if(R.NeedAdditionalInfo())
-                AddExtendedInfo(i,Obj);
-            ObjArray.add(Obj);
-        }
-        Poco::JSON::Object  Answer;
-        Answer.set(ArrayName,ObjArray);
-        return R.ReturnObject(Answer);
-    }
+	template <typename T>
+	void MakeJSONObjectArray(const char *ArrayName, const std::vector<T> &V, RESTAPIHandler &R) {
+		Poco::JSON::Array ObjArray;
+		for (const auto &i : V) {
+			Poco::JSON::Object Obj;
+			i.to_json(Obj);
+			if (R.NeedAdditionalInfo())
+				AddExtendedInfo(i, Obj);
+			ObjArray.add(Obj);
+		}
+		Poco::JSON::Object Answer;
+		Answer.set(ArrayName, ObjArray);
+		return R.ReturnObject(Answer);
+	}
 
-//    ReturnRecordList<decltype(StorageService()->InventoryDB()),
-//            ProvObjects::InventoryTag>("taglist",StorageService()->InventoryDB(),*this );
+	inline static bool is_uuid(const std::string &u) { return u.find('-') != std::string::npos; }
 
-    inline static bool is_uuid(const std::string &u) {
-        return u.find('-') != std::string::npos;
-    }
+	template <typename DB>
+	void ReturnRecordList(const char *ArrayName, DB &DBInstance, RESTAPIHandler &R) {
+		Poco::JSON::Array ObjArr;
+		for (const auto &i : R.SelectedRecords()) {
+			ProvObjects::InventoryTag E;
+			if (DBInstance.GetRecord(is_uuid(i) ? "id" : "serialNumber", i, E)) {
+				Poco::JSON::Object Obj;
+				E.to_json(Obj);
+				if (R.NeedAdditionalInfo())
+					AddExtendedInfo(E, Obj);
+				ObjArr.add(Obj);
+			} else {
+				return R.BadRequest(RESTAPI::Errors::UnknownId);
+			}
+		}
+		Poco::JSON::Object Answer;
+		Answer.set(ArrayName, ObjArr);
+		return R.ReturnObject(Answer);
+	}
 
-    template <typename DB> void ReturnRecordList(const char *ArrayName,DB & DBInstance, RESTAPIHandler & R) {
-        Poco::JSON::Array   ObjArr;
-        for(const auto &i:R.SelectedRecords()) {
-            ProvObjects::InventoryTag E;
-            if(DBInstance.GetRecord(is_uuid(i) ? "id" : "serialNumber",i,E)) {
-                Poco::JSON::Object  Obj;
-                E.to_json(Obj);
-                if(R.NeedAdditionalInfo())
-                    AddExtendedInfo(E,Obj);
-                ObjArr.add(Obj);
-            } else {
-                return R.BadRequest(RESTAPI::Errors::UnknownId + i);
-            }
-        }
-        Poco::JSON::Object  Answer;
-        Answer.set(ArrayName, ObjArr);
-        return R.ReturnObject(Answer);
-    }
+	template <typename DB, typename Record>
+	void ReturnRecordList(const char *ArrayName, DB &DBInstance, RESTAPIHandler &R) {
+		Poco::JSON::Array ObjArr;
+		for (const auto &i : R.SelectedRecords()) {
+			Record E;
+			if (DBInstance.GetRecord("id", i, E)) {
+				Poco::JSON::Object Obj;
+				E.to_json(Obj);
+				if (R.NeedAdditionalInfo())
+					AddExtendedInfo(E, Obj);
+				ObjArr.add(Obj);
+			} else {
+				return R.BadRequest(RESTAPI::Errors::UnknownId);
+			}
+		}
+		Poco::JSON::Object Answer;
+		Answer.set(ArrayName, ObjArr);
+		return R.ReturnObject(Answer);
+	}
 
-    template <typename DB, typename Record> void ReturnRecordList(const char *ArrayName,DB & DBInstance, RESTAPIHandler & R) {
-        Poco::JSON::Array   ObjArr;
-        for(const auto &i:R.SelectedRecords()) {
-            Record E;
-            if(DBInstance.GetRecord("id",i,E)) {
-                Poco::JSON::Object  Obj;
-                E.to_json(Obj);
-                if(R.NeedAdditionalInfo())
-                    AddExtendedInfo(E,Obj);
-                ObjArr.add(Obj);
-            } else {
-                return R.BadRequest(RESTAPI::Errors::UnknownId + i);
-            }
-        }
-        Poco::JSON::Object  Answer;
-        Answer.set(ArrayName, ObjArr);
-        return R.ReturnObject(Answer);
-    }
+	inline bool NormalizeMac(std::string &Mac) {
+		Poco::replaceInPlace(Mac, ":", "");
+		Poco::replaceInPlace(Mac, "-", "");
+		if (Mac.size() != 12)
+			return false;
+		for (const auto &i : Mac) {
+			if (!std::isxdigit(i))
+				return false;
+		}
+		Poco::toLowerInPlace(Mac);
+		return true;
+	}
 
-    inline bool NormalizeMac(std::string & Mac) {
-        Poco::replaceInPlace(Mac,":","");
-        Poco::replaceInPlace(Mac,"-","");
-        if(Mac.size()!=12)
-            return false;
-        for(const auto &i:Mac) {
-            if(!std::isxdigit(i))
-                return false;
-        }
-        Poco::toLowerInPlace(Mac);
-        return true;
-    }
+	typedef std::tuple<std::string, std::string, std::string> triplet_t;
 
-}
+	inline void AddLocationTriplet(const std::string &id, std::vector<triplet_t> &IDs) {
+		ProvObjects::Location L;
+		if (StorageService()->LocationDB().GetRecord("id", id, L)) {
+			IDs.emplace_back(std::make_tuple(L.info.name, L.info.description, L.info.id));
+		}
+	}
+
+	inline void AddLocationTriplet(const std::vector<std::string> &id,
+								   std::vector<triplet_t> &IDs) {
+		for (const auto &i : id)
+			AddLocationTriplet(i, IDs);
+	}
+
+	inline void GetLocationsForEntity(const std::string &ID, std::vector<triplet_t> &IDs) {
+		ProvObjects::Entity Existing;
+		if (StorageService()->EntityDB().template GetRecord("id", ID, Existing)) {
+			if (!Existing.locations.empty()) {
+				AddLocationTriplet(Existing.locations, IDs);
+			}
+			if (!Existing.parent.empty()) {
+				GetLocationsForEntity(Existing.parent, IDs);
+			}
+			if (ID == EntityDB::RootUUID())
+				return;
+		}
+	}
+
+	inline void GetLocationsForVenue(const std::string &ID, std::vector<triplet_t> &IDs) {
+		ProvObjects::Venue Existing;
+		if (StorageService()->VenueDB().template GetRecord("id", ID, Existing)) {
+			if (!Existing.parent.empty()) {
+				GetLocationsForVenue(Existing.parent, IDs);
+			}
+			ProvObjects::Entity E;
+			if (StorageService()->EntityDB().GetRecord("id", Existing.entity, E)) {
+				AddLocationTriplet(E.locations, IDs);
+			}
+			return;
+		}
+	}
+
+	template <typename DB>
+	void ListHandler(const char *BlockName, DB &DBInstance, RESTAPIHandler &R) {
+		auto Entity = R.GetParameter("entity", "");
+		auto Venue = R.GetParameter("venue", "");
+
+		typedef typename DB::RecordVec RecVec;
+		typedef typename DB::RecordName RecType;
+
+		if constexpr (std::is_same_v<RecType, ProvObjects::Venue>) {
+			auto LocationsForVenue = R.GetParameter("locationsForVenue", "");
+			if (!LocationsForVenue.empty()) {
+				std::vector<triplet_t> IDs;
+				GetLocationsForVenue(LocationsForVenue, IDs);
+				Poco::JSON::Array A;
+				for (const auto &[name, description, uuid] : IDs) {
+					Poco::JSON::Object O;
+					O.set("name", name);
+					O.set("description", description);
+					O.set("uuid", uuid);
+					A.add(O);
+				}
+				Poco::JSON::Object Answer;
+				Answer.set("locations", A);
+				return R.ReturnObject(Answer);
+			}
+		}
+
+		if (!R.QB_.Select.empty()) {
+			return ReturnRecordList<decltype(DBInstance), RecType>(BlockName, DBInstance, R);
+		}
+		if (!Entity.empty()) {
+			RecVec Entries;
+			DBInstance.GetRecords(R.QB_.Offset, R.QB_.Limit, Entries, " entity=' " + Entity + "'");
+			if (R.QB_.CountOnly)
+				return R.ReturnCountOnly(Entries.size());
+			return MakeJSONObjectArray(BlockName, Entries, R);
+		}
+		if (!Venue.empty()) {
+			RecVec Entries;
+			DBInstance.GetRecords(R.QB_.Offset, R.QB_.Limit, Entries, " venue=' " + Venue + "'");
+			if (R.QB_.CountOnly)
+				return R.ReturnCountOnly(Entries.size());
+			return MakeJSONObjectArray(BlockName, Entries, R);
+		} else if (R.QB_.CountOnly) {
+			Poco::JSON::Object Answer;
+			auto C = DBInstance.Count();
+			return R.ReturnCountOnly(C);
+		} else {
+			RecVec Entries;
+			DBInstance.GetRecords(R.QB_.Offset, R.QB_.Limit, Entries);
+			return MakeJSONObjectArray(BlockName, Entries, R);
+		}
+	}
+
+	template <typename db_type>
+	void ListHandlerForOperator(const char *BlockName, db_type &DB, RESTAPIHandler &R,
+								const Types::UUID_t &OperatorId,
+								const Types::UUID_t &subscriberId = "") {
+		typedef typename db_type::RecordVec RecVec;
+		typedef typename db_type::RecordName RecType;
+
+		auto whereClause =
+			subscriberId.empty()
+				? fmt::format(" operatorId='{}'", OperatorId)
+				: fmt::format(" operatorId='{}' and subscriberId='{}' ", OperatorId, subscriberId);
+
+		if (R.QB_.CountOnly) {
+			auto Count = DB.Count(whereClause);
+			return R.ReturnCountOnly(Count);
+		}
+
+		if (!R.QB_.Select.empty()) {
+			return ReturnRecordList<decltype(DB), RecType>(BlockName, DB, R);
+		}
+
+		RecVec Entries;
+		DB.GetRecords(R.QB_.Offset, R.QB_.Limit, Entries, whereClause);
+		return MakeJSONObjectArray(BlockName, Entries, R);
+	}
+
+	template <typename db_type, typename ObjectDB>
+	void MoveUsage(db_type &DB_InUse, ObjectDB &DB, const std::string &From, const std::string &To,
+				   const std::string &Id) {
+		if (From != To) {
+			if (!From.empty())
+				DB_InUse.DeleteInUse("id", From, DB.Prefix(), Id);
+			if (!To.empty())
+				DB_InUse.AddInUse("id", To, DB.Prefix(), Id);
+		}
+	}
+
+	template <typename db_type, typename ObjectDB>
+	void MoveUsage(db_type &DB_InUse, ObjectDB &DB, const Types::UUIDvec_t &From,
+				   const Types::UUIDvec_t &To, const std::string &Id) {
+		if (From != To) {
+			if (!From.empty()) {
+				for (const auto &i : From)
+					DB_InUse.DeleteInUse("id", i, DB.Prefix(), Id);
+			}
+			if (!To.empty()) {
+				for (const auto &i : To)
+					DB_InUse.AddInUse("id", i, DB.Prefix(), Id);
+			}
+		}
+	}
+
+	template <typename db_type>
+	void MoveChild(db_type &DB, const std::string &Parent, const std::string &Child,
+				   const std::string &Id) {
+		if (Parent != Child) {
+			if (!Parent.empty())
+				DB.InUse.DeleteInUse("id", Parent, Id);
+			if (!Child.empty())
+				DB.AddInUse("id", Child, Id);
+		}
+	}
+
+	template <typename db_type, typename Member>
+	void RemoveMembership(db_type &DB, Member T, const std::string &Obj, const std::string &Id) {
+		if (!Obj.empty())
+			DB.ManipulateVectorMember(T, "id", Obj, Id, false);
+	}
+
+	template <typename db_type, typename Member>
+	void AddMembership(db_type &DB, Member T, const std::string &Obj, const std::string &Id) {
+		if (!Obj.empty())
+			DB.ManipulateVectorMember(T, "id", Obj, Id, true);
+	}
+
+	template <typename db_type, typename Member>
+	void ManageMembership(db_type &DB, Member T, const std::string &From, const std::string &To,
+						  const std::string &Id) {
+		RemoveMembership(DB, T, From, Id);
+		AddMembership(DB, T, To, Id);
+	}
+
+	template <typename db_type, typename Member>
+	void ManageMembership(db_type &DB, Member T, const Types::UUIDvec_t &From,
+						  const Types::UUIDvec_t &To, const std::string &Id) {
+		if (From != To) {
+			for (const auto &i : From) {
+				RemoveMembership(DB, T, i, Id);
+			}
+			for (const auto &i : To) {
+				AddMembership(DB, T, i, Id);
+			}
+		}
+	}
+
+	template <typename Member, typename Rec, typename db_type>
+	bool CreateMove(const Poco::JSON::Object::Ptr &RawObj, const char *fieldname, Member T,
+					Rec &Existing, std::string &From, std::string &To, db_type &TheDB) {
+		if (RawObj->has(fieldname)) {
+			From = Existing.*T;
+			To = RawObj->get(fieldname).toString();
+			if (!To.empty() && !TheDB.Exists("id", To))
+				return false;
+			Existing.*T = To;
+		}
+		return true;
+	}
+
+	inline std::string FindParentEntity(const ProvObjects::Venue &V) {
+		if (V.parent.empty())
+			return V.entity;
+		ProvObjects::Venue P;
+		if (StorageService()->VenueDB().GetRecord("id", V.parent, P))
+			return FindParentEntity(P);
+		return EntityDB::RootUUID();
+	}
+
+	inline bool ValidateConfigBlock(const ProvObjects::DeviceConfiguration &Config,
+									std::vector<std::string> &Errors) {
+		static const std::vector<std::string> SectionNames{
+			"globals",	   "interfaces", "metrics", "radios",	  "services",	"unit",
+			"definitions", "ethernet",	 "switch",	"config-raw", "third-party"};
+
+		for (const auto &i : Config.configuration) {
+			Poco::JSON::Parser P;
+			if (i.name.empty()) {
+				Errors.push_back("Name is empty");
+				return false;
+			}
+
+			try {
+				auto Blocks = P.parse(i.configuration).extract<Poco::JSON::Object::Ptr>();
+				auto N = Blocks->getNames();
+				for (const auto &j : N) {
+					if (std::find(SectionNames.cbegin(), SectionNames.cend(), j) ==
+						SectionNames.cend()) {
+						Errors.push_back("Unknown block name");
+						return false;
+					}
+				}
+			} catch (const Poco::JSON::JSONException &E) {
+				Errors.push_back("Invalid JSON document");
+				return false;
+			}
+
+			try {
+				if (ValidateUCentralConfiguration(i.configuration, Errors, true)) {
+					// std::cout << "Block: " << i.name << " is valid" << std::endl;
+				} else {
+					return false;
+				}
+			} catch (...) {
+				Errors.push_back("Invalid configuration caused an exception");
+				return false;
+			}
+		}
+		return true;
+	}
+
+	template <typename Type>
+	std::map<std::string, std::string> CreateObjects(Type &NewObject, RESTAPIHandler &R,
+													 std::vector<std::string> &Errors) {
+		std::map<std::string, std::string> Result;
+
+		auto createObjects = R.GetParameter("createObjects", "");
+		if (!createObjects.empty()) {
+			Poco::JSON::Parser P;
+			auto Objects = P.parse(createObjects).extract<Poco::JSON::Object::Ptr>();
+			if (Objects->isArray("objects")) {
+				auto ObjectsArray = Objects->getArray("objects");
+				for (const auto &i : *ObjectsArray) {
+					auto Object = i.extract<Poco::JSON::Object::Ptr>();
+					if (Object->has("location")) {
+						auto LocationDetails =
+							Object->get("location").extract<Poco::JSON::Object::Ptr>();
+						ProvObjects::Location LC;
+						if (LC.from_json(LocationDetails)) {
+							if constexpr (std::is_same_v<Type, ProvObjects::Venue>) {
+								std::string ParentEntity = FindParentEntity(NewObject);
+								ProvObjects::CreateObjectInfo(R.UserInfo_.userinfo, LC.info);
+								LC.entity = ParentEntity;
+								if (StorageService()->LocationDB().CreateRecord(LC)) {
+									NewObject.location = LC.info.id;
+									AddMembership(StorageService()->EntityDB(),
+												  &ProvObjects::Entity::locations, ParentEntity,
+												  LC.info.id);
+									Result["location"] = LC.info.id;
+								}
+							}
+							if constexpr (std::is_same_v<Type, ProvObjects::Operator>) {
+								std::string ParentEntity = FindParentEntity(NewObject);
+								ProvObjects::CreateObjectInfo(R.UserInfo_.userinfo, LC.info);
+								LC.entity = ParentEntity;
+								if (StorageService()->LocationDB().CreateRecord(LC)) {
+									NewObject.location = LC.info.id;
+									AddMembership(StorageService()->EntityDB(),
+												  &ProvObjects::Entity::locations, ParentEntity,
+												  LC.info.id);
+									Result["location"] = LC.info.id;
+								}
+							}
+						} else {
+							Errors.push_back("Invalid JSON document");
+							break;
+						}
+					} else if (Object->has("contact")) {
+						auto ContactDetails =
+							Object->get("contact").extract<Poco::JSON::Object::Ptr>();
+						ProvObjects::Contact CC;
+						if (CC.from_json(ContactDetails)) {
+							std::cout << "contact decoded: " << CC.info.name << std::endl;
+						} else {
+							std::cout << "contact not decoded." << std::endl;
+						}
+					} else if (Object->has("configuration")) {
+						auto ConfigurationDetails =
+							Object->get("configuration")
+								.template extract<Poco::JSON::Object::Ptr>();
+						ProvObjects::DeviceConfiguration DC;
+						if (DC.from_json(ConfigurationDetails)) {
+							if constexpr (std::is_same_v<Type, ProvObjects::InventoryTag>) {
+								if (!ValidateConfigBlock(DC, Errors)) {
+									break;
+								}
+								ProvObjects::CreateObjectInfo(R.UserInfo_.userinfo, DC.info);
+								if (StorageService()->ConfigurationDB().CreateRecord(DC)) {
+									NewObject.deviceConfiguration = DC.info.id;
+									Result["configuration"] = DC.info.id;
+								}
+							}
+						} else {
+							Errors.push_back("Invalid JSON document");
+							break;
+						}
+					}
+				}
+			}
+		}
+		return Result;
+	}
+
+	inline bool ValidSchedule(const std::string &v) {
+		try {
+			auto cron = cron::make_cron(v);
+			return true;
+		} catch (cron::bad_cronexpr const &ex) {
+		}
+		return false;
+	}
+
+	inline bool ValidRRM(const std::string &v) {
+		if ((v == "no") || (v == "inherit"))
+			return true;
+		try {
+			Poco::JSON::Parser P;
+			auto O = P.parse(v).extract<Poco::JSON::Object::Ptr>();
+
+			ProvObjects::RRMDetails D;
+			if (D.from_json(O)) {
+				return ValidSchedule(D.schedule);
+			}
+		} catch (...) {
+		}
+		return false;
+	}
+
+	inline bool ValidDeviceRules(const ProvObjects::DeviceRules &DR) {
+		return (ValidRRM(DR.rrm)) &&
+			   (DR.firmwareUpgrade == "yes" || DR.firmwareUpgrade == "no" ||
+				DR.firmwareUpgrade == "inherit") &&
+			   (DR.rcOnly == "yes" || DR.rcOnly == "no" || DR.rcOnly == "inherit");
+	}
+
+	inline bool ValidDeviceRules(const ProvObjects::DeviceRules &DR, RESTAPIHandler &H) {
+		if (ValidDeviceRules(DR))
+			return true;
+		H.BadRequest(RESTAPI::Errors::InvalidRRM);
+		return false;
+	}
+
+	inline bool ValidSourceIP([[maybe_unused]] const std::vector<std::string> &IPs) { return true; }
+
+	inline bool ValidPeriod(const std::string &P) {
+		return (P == "hourly" || P == "daily" || P == "monthly" || P == "yearly" ||
+				P == "quarterly" || P == "lifetime" || P == "custom1" || P == "custom2" ||
+				P == "custom3" || P == "custom4");
+	}
+
+	inline bool ValidContactType(const std::string &contact) {
+		auto C = Poco::toLower(contact);
+		return (C == "subscriber" || C == "user" || C == "installer" || C == "csr" ||
+				C == "manager" || C == "businessowner" || C == "technician" || C == "corporate");
+	}
+
+	inline bool ValidContactType(const std::string &contact, RESTAPIHandler &H) {
+		auto C = Poco::toLower(contact);
+		if (C == "subscriber" || C == "user" || C == "installer" || C == "csr" || C == "manager" ||
+			C == "businessowner" || C == "technician" || C == "corporate")
+			return true;
+		H.BadRequest(RESTAPI::Errors::InvalidContactType);
+		return false;
+	}
+
+	inline bool ValidLocationType(const std::string &location) {
+		auto C = Poco::toLower(location);
+		return (C == "service" || C == "equipment" || C == "auto" || C == "manual" ||
+				C == "special" || C == "unknown" || C == "corporate");
+	}
+
+	inline bool ValidLocationType(const std::string &location, RESTAPIHandler &H) {
+		auto C = Poco::toLower(location);
+		if ((C == "service" || C == "equipment" || C == "auto" || C == "manual" || C == "special" ||
+			 C == "unknown" || C == "corporate"))
+			return true;
+		H.BadRequest(RESTAPI::Errors::InvalidLocationType);
+		return false;
+	}
+
+	template <typename DBType>
+	bool ValidDbId(const Types::UUID_t &uuid, DBType &DB, bool AllowEmpty,
+				   const RESTAPI::Errors::msg &Error, RESTAPIHandler &H) {
+		if (!AllowEmpty && uuid.empty()) {
+			H.BadRequest(Error);
+			return false;
+		}
+		if (uuid.empty())
+			return true;
+		if (!DB.Exists("id", uuid)) {
+			H.BadRequest(Error);
+			return false;
+		}
+		return true;
+	}
+
+	inline bool ValidSubscriberId(const Types::UUID_t &uuid, bool AllowEmpty, RESTAPIHandler &H) {
+		if (!AllowEmpty && uuid.empty()) {
+			H.BadRequest(RESTAPI::Errors::InvalidSubscriberId);
+			return false;
+		}
+		if (uuid.empty())
+			return true;
+		SecurityObjects::UserInfo NewSubInfo;
+		if (!SDK::Sec::Subscriber::Get(&H, uuid, NewSubInfo)) {
+			H.BadRequest(RESTAPI::Errors::InvalidSubscriberId);
+			return false;
+		}
+		return true;
+	}
+
+	inline bool ValidSubscriberId(const Types::UUID_t &uuid, bool AllowEmpty, std::string &email,
+								  RESTAPIHandler &H) {
+		if (!AllowEmpty && uuid.empty()) {
+			H.BadRequest(RESTAPI::Errors::InvalidSubscriberId);
+			return false;
+		}
+		if (uuid.empty())
+			return true;
+		SecurityObjects::UserInfo NewSubInfo;
+		if (!SDK::Sec::Subscriber::Get(&H, uuid, NewSubInfo)) {
+			H.BadRequest(RESTAPI::Errors::InvalidSubscriberId);
+			return false;
+		}
+		email = NewSubInfo.email;
+		return true;
+	}
+
+	inline bool ValidSerialNumber(const std::string &serialNumber, bool AllowEmpty,
+								  RESTAPIHandler &H) {
+		if (!AllowEmpty && serialNumber.empty()) {
+			H.BadRequest(RESTAPI::Errors::InvalidSerialNumber);
+			return false;
+		}
+
+		if (!Utils::ValidSerialNumber(serialNumber)) {
+			H.BadRequest(RESTAPI::Errors::InvalidSerialNumber);
+			return false;
+		}
+		return true;
+	}
+
+	template <typename DBType, typename DBRecordType>
+	void ReturnUpdatedObject(DBType &DB, const DBRecordType &R, RESTAPIHandler &H) {
+		if (DB.UpdateRecord("id", R.info.id, R)) {
+			DBRecordType Updated;
+			DB.GetRecord("id", R.info.id, Updated);
+			Poco::JSON::Object Answer;
+			Updated.to_json(Answer);
+			return H.ReturnObject(Answer);
+		} else {
+			H.InternalError(RESTAPI::Errors::RecordNotUpdated);
+		}
+	}
+
+	template <typename DBType, typename DBRecordType>
+	void ReturnCreatedObject(DBType &DB, const DBRecordType &R, RESTAPIHandler &H) {
+		if (DB.CreateRecord(R)) {
+			DBRecordType Updated;
+			DB.GetRecord("id", R.info.id, Updated);
+			Poco::JSON::Object Answer;
+			Updated.to_json(Answer);
+			return H.ReturnObject(Answer);
+		} else {
+			H.InternalError(RESTAPI::Errors::RecordNotCreated);
+		}
+	}
+
+	template <typename DBType> void ReturnFieldList(DBType &DB, RESTAPIHandler &H) {
+		Types::StringVec Fields;
+		DB.GetFieldNames(Fields);
+		Poco::JSON::Object Answer;
+		RESTAPI_utils::field_to_json(Answer, "list", Fields);
+		return H.ReturnObject(Answer);
+	}
+} // namespace OpenWifi

src/RESTAPI/RESTAPI_entity_handler.cpp

@@ -6,229 +6,176 @@
 //	Arilia Wireless Inc.
 //
 
-
 #include "RESTAPI_entity_handler.h"
 
+#include "RESTAPI_db_helpers.h"
 #include "RESTObjects/RESTAPI_ProvObjects.h"
 #include "RESTObjects/RESTAPI_SecurityObjects.h"
 #include "StorageService.h"
-#include "RESTAPI_db_helpers.h"
 
-namespace OpenWifi{
+#include "framework/CIDR.h"
 
-    void RESTAPI_entity_handler::DoGet() {
-        std::string UUID = GetBinding("uuid", "");
-        ProvObjects::Entity Existing;
-        if(UUID.empty() || !DB_.GetRecord("id",UUID,Existing)) {
-            return NotFound();
-        }
+namespace OpenWifi {
 
-        Poco::JSON::Object Answer;
-        Existing.to_json(Answer);
-        if(NeedAdditionalInfo())
-            AddExtendedInfo( Existing, Answer);
-        ReturnObject(Answer);
-    }
+	void RESTAPI_entity_handler::DoGet() {
+		std::string UUID = GetBinding("uuid", "");
+		ProvObjects::Entity Existing;
+		if (UUID.empty() || !DB_.GetRecord("id", UUID, Existing)) {
+			return NotFound();
+		}
 
-    void RESTAPI_entity_handler::DoDelete() {
-        std::string UUID = GetBinding("uuid", "");
-        ProvObjects::Entity Existing;
-        if(UUID.empty() || !DB_.GetRecord("id",UUID,Existing)) {
-            return NotFound();
-        }
+		Poco::JSON::Object Answer;
+		Existing.to_json(Answer);
+		if (NeedAdditionalInfo())
+			AddExtendedInfo(Existing, Answer);
+		ReturnObject(Answer);
+	}
 
-        if(UUID == EntityDB::RootUUID()) {
-            return BadRequest(RESTAPI::Errors::CannotDeleteRoot);
-        }
+	void RESTAPI_entity_handler::DoDelete() {
+		std::string UUID = GetBinding("uuid", "");
+		ProvObjects::Entity Existing;
+		if (UUID.empty() || !DB_.GetRecord("id", UUID, Existing)) {
+			return NotFound();
+		}
 
-        if( !Existing.children.empty() || !Existing.devices.empty() || !Existing.venues.empty() || !Existing.locations.empty()
-            || !Existing.contacts.empty()) {
-            return BadRequest(RESTAPI::Errors::StillInUse);
-        }
+		if (UUID == EntityDB::RootUUID()) {
+			return BadRequest(RESTAPI::Errors::CannotDeleteRoot);
+		}
 
-        if(!Existing.deviceConfiguration.empty()) {
-            for(auto &i:Existing.deviceConfiguration)
-                StorageService()->ConfigurationDB().DeleteInUse("id", i, DB_.Prefix(), Existing.info.id);
-        }
+		if (!Existing.children.empty() || !Existing.devices.empty() || !Existing.venues.empty() ||
+			!Existing.locations.empty() || !Existing.contacts.empty() ||
+			!Existing.configurations.empty()) {
+			return BadRequest(RESTAPI::Errors::StillInUse);
+		}
 
-        if(DB_.DeleteRecord("id",UUID)) {
-            DB_.DeleteChild("id",Existing.parent,UUID);
-            return OK();
-        }
-        InternalError(RESTAPI::Errors::CouldNotBeDeleted);
-    }
+		MoveUsage(StorageService()->PolicyDB(), DB_, Existing.managementPolicy, "",
+				  Existing.info.id);
+		DB_.DeleteRecord("id", UUID);
+		DB_.DeleteChild("id", Existing.parent, UUID);
+		return OK();
+	}
 
-    void RESTAPI_entity_handler::DoPost() {
-        std::string UUID = GetBinding("uuid", "");
-        if(UUID.empty()) {
-            return BadRequest(RESTAPI::Errors::MissingUUID);
-        }
+	void RESTAPI_entity_handler::DoPost() {
+		std::string UUID = GetBinding("uuid", "");
+		if (UUID.empty()) {
+			return BadRequest(RESTAPI::Errors::MissingUUID);
+		}
 
-        if(!DB_.RootExists() && UUID != EntityDB::RootUUID()) {
-            return BadRequest(RESTAPI::Errors::MustCreateRootFirst);
-        }
+		if (UUID == EntityDB::RootUUID()) {
+			return BadRequest(RESTAPI::Errors::MissingOrInvalidParameters);
+		}
 
-        auto Obj = ParseStream();
-        ProvObjects::Entity NewEntity;
-        if (!NewEntity.from_json(Obj)) {
-            return BadRequest(RESTAPI::Errors::InvalidJSONDocument);
-        }
+		const auto &RawObject = ParsedBody_;
+		ProvObjects::Entity NewEntity;
+		if (!NewEntity.from_json(RawObject)) {
+			return BadRequest(RESTAPI::Errors::InvalidJSONDocument);
+		}
 
-        if(!ProvObjects::CreateObjectInfo(Obj,UserInfo_.userinfo,NewEntity.info)) {
-            return BadRequest(RESTAPI::Errors::NameMustBeSet);
-        }
+		if ((RawObject->has("deviceRules") && !ValidDeviceRules(NewEntity.deviceRules, *this))) {
+			return;
+		}
 
-        //  When creating an entity, it cannot have any relations other that parent, notes, name, description. Everything else
-        //  must be conveyed through PUT.
-        NewEntity.info.id = (UUID==EntityDB::RootUUID()) ? UUID : MicroService::CreateUUID();
+		if (!ProvObjects::CreateObjectInfo(RawObject, UserInfo_.userinfo, NewEntity.info)) {
+			return BadRequest(RESTAPI::Errors::NameMustBeSet);
+		}
 
-        if(UUID==EntityDB::RootUUID()) {
-            NewEntity.parent="";
-        } else if(NewEntity.parent.empty() || !DB_.Exists("id",NewEntity.parent)) {
-            return BadRequest(RESTAPI::Errors::ParentUUIDMustExist);
-        }
+		//  When creating an entity, it cannot have any relations other that parent, notes, name,
+		//  description. Everything else must be conveyed through PUT.
+		NewEntity.info.id = (UUID == EntityDB::RootUUID()) ? UUID : MicroServiceCreateUUID();
 
-        if(!NewEntity.deviceConfiguration.empty()) {
-            for(auto &i:NewEntity.deviceConfiguration)
-                if(!StorageService()->ConfigurationDB().Exists("id",i)) {
-                    return BadRequest(RESTAPI::Errors::ConfigurationMustExist);
-                }
-        }
+		if (UUID == EntityDB::RootUUID()) {
+			NewEntity.parent = "";
+		} else if (NewEntity.parent.empty() || !DB_.Exists("id", NewEntity.parent)) {
+			return BadRequest(RESTAPI::Errors::ParentUUIDMustExist);
+		}
 
-        if(!NewEntity.managementPolicy.empty() && !StorageService()->PolicyDB().Exists("id", NewEntity.managementPolicy)){
-            return BadRequest(RESTAPI::Errors::UnknownManagementPolicyUUID);
-        }
+		if (!NewEntity.managementPolicy.empty() &&
+			!StorageService()->PolicyDB().Exists("id", NewEntity.managementPolicy)) {
+			return BadRequest(RESTAPI::Errors::UnknownManagementPolicyUUID);
+		}
 
-        if(!NewEntity.sourceIP.empty() && !CIDR::ValidateIpRanges(NewEntity.sourceIP)) {
-            return BadRequest(RESTAPI::Errors::InvalidIPRanges);
-        }
+		if (!NewEntity.sourceIP.empty() && !CIDR::ValidateIpRanges(NewEntity.sourceIP)) {
+			return BadRequest(RESTAPI::Errors::InvalidIPRanges);
+		}
 
-        NewEntity.venues.clear();
-        NewEntity.children.clear();
-        NewEntity.contacts.clear();
-        NewEntity.locations.clear();
+		NewEntity.venues.clear();
+		NewEntity.children.clear();
+		NewEntity.contacts.clear();
+		NewEntity.locations.clear();
+		NewEntity.deviceConfiguration.clear();
+		NewEntity.managementRoles.clear();
 
-        if(DB_.CreateShortCut(NewEntity)) {
-            if(UUID==EntityDB::RootUUID()) {
-                DB_.CheckForRoot();
-            } else {
-                DB_.AddChild("id",NewEntity.parent,NewEntity.info.id);
-            }
+		if (DB_.CreateRecord(NewEntity)) {
+			MoveUsage(StorageService()->PolicyDB(), DB_, "", NewEntity.managementPolicy,
+					  NewEntity.info.id);
+			DB_.AddChild("id", NewEntity.parent, NewEntity.info.id);
 
-            Poco::JSON::Object  Answer;
-            NewEntity.to_json(Answer);
-            return ReturnObject(Answer);
-        }
-        InternalError(RESTAPI::Errors::RecordNotCreated);
-    }
+			Poco::JSON::Object Answer;
+			NewEntity.to_json(Answer);
+			return ReturnObject(Answer);
+		}
+		InternalError(RESTAPI::Errors::RecordNotCreated);
+	}
 
-    /*
-     * Put is a complex operation, it contains commands only.
-     *      addContact=UUID, delContact=UUID,
-     *      addLocation=UUID, delLocation=UUID,
-     *      addVenue=UUID, delVenue=UUID,
-     *      addEntity=UUID, delEntity=UUID
-     *      addDevice=UUID, delDevice=UUID
-     */
+	/*
+	 * Put is a complex operation, it contains commands only.
+	 *      addContact=UUID, delContact=UUID,
+	 *      addLocation=UUID, delLocation=UUID,
+	 *      addVenue=UUID, delVenue=UUID,
+	 *      addEntity=UUID, delEntity=UUID
+	 *      addDevice=UUID, delDevice=UUID
+	 */
 
-    void RESTAPI_entity_handler::DoPut() {
-        std::string UUID = GetBinding("uuid", "");
-        ProvObjects::Entity Existing;
-        if(UUID.empty() || !DB_.GetRecord("id",UUID,Existing)) {
-            return NotFound();
-        }
+	void RESTAPI_entity_handler::DoPut() {
+		std::string UUID = GetBinding("uuid", "");
+		ProvObjects::Entity Existing;
+		if (UUID.empty() || !DB_.GetRecord("id", UUID, Existing)) {
+			return NotFound();
+		}
 
-        auto RawObject = ParseStream();
-        ProvObjects::Entity NewEntity;
-        if(!NewEntity.from_json(RawObject)) {
-            return BadRequest(RESTAPI::Errors::InvalidJSONDocument);
-        }
+		const auto &RawObject = ParsedBody_;
+		ProvObjects::Entity NewEntity;
+		if (!NewEntity.from_json(RawObject)) {
+			return BadRequest(RESTAPI::Errors::InvalidJSONDocument);
+		}
 
-        if(!UpdateObjectInfo(RawObject, UserInfo_.userinfo, Existing.info)) {
-            return BadRequest(RESTAPI::Errors::NameMustBeSet);
-        }
+		if ((RawObject->has("deviceRules") && !ValidDeviceRules(NewEntity.deviceRules, *this))) {
+			return;
+		}
 
-        std::string NewManagementPolicy;
-        Types::UUIDvec_t NewConfiguration;
-        bool        MovingConfiguration=false,
-                    MovingManagementPolicy=false;
-        if(RawObject->has("deviceConfiguration")) {
-            if(!NewEntity.deviceConfiguration.empty()) {
-                for(auto &i:NewEntity.deviceConfiguration) {
-                    if(!StorageService()->ConfigurationDB().Exists("id",i)) {
-                        return BadRequest(RESTAPI::Errors::ConfigurationMustExist);
-                    }
-                }
-                NewConfiguration = NewEntity.deviceConfiguration;
-            }
-            MovingConfiguration = Existing.deviceConfiguration != NewConfiguration;
-        }
-        if(AssignIfPresent(RawObject,"managementPolicy",NewManagementPolicy)) {
-            if(!NewManagementPolicy.empty() && !StorageService()->PolicyDB().Exists("id",NewManagementPolicy)) {
-                return BadRequest(RESTAPI::Errors::UnknownManagementPolicyUUID);
-            }
-            MovingManagementPolicy = Existing.managementPolicy != NewManagementPolicy;
-        }
+		if (!UpdateObjectInfo(RawObject, UserInfo_.userinfo, Existing.info)) {
+			return BadRequest(RESTAPI::Errors::NameMustBeSet);
+		}
 
-        if(RawObject->has("sourceIP")) {
-            if(!NewEntity.sourceIP.empty() && !CIDR::ValidateIpRanges(NewEntity.sourceIP)) {
-                return BadRequest(RESTAPI::Errors::InvalidIPRanges);
-            }
-            Existing.sourceIP = NewEntity.sourceIP;
-        }
+		std::string FromPolicy, ToPolicy;
+		if (!CreateMove(RawObject, "managementPolicy", &EntityDB::RecordName::managementPolicy,
+						Existing, FromPolicy, ToPolicy, StorageService()->PolicyDB()))
+			return BadRequest(RESTAPI::Errors::UnknownManagementPolicyUUID);
 
-        std::string Error;
-        if(!StorageService()->Validate(Parameters_,Error)) {
-            return BadRequest(Error);
-        }
+		if (RawObject->has("sourceIP")) {
+			if (!NewEntity.sourceIP.empty() && !CIDR::ValidateIpRanges(NewEntity.sourceIP)) {
+				return BadRequest(RESTAPI::Errors::InvalidIPRanges);
+			}
+			Existing.sourceIP = NewEntity.sourceIP;
+		}
 
-        AssignIfPresent(RawObject, "rrm", Existing.rrm);
+		RESTAPI::Errors::msg Error;
+		if (!StorageService()->Validate(Parameters_, Error)) {
+			return BadRequest(Error);
+		}
 
-        if(DB_.UpdateRecord("id",UUID,Existing)) {
-            for(const auto &i:*Request) {
-                std::string Child{i.second};
-                auto UUID_parts = Utils::Split(Child,':');
-                if(i.first=="add" && UUID_parts[0] == "con") {
-                    DB_.AddContact("id", UUID, UUID_parts[1]);
-                    StorageService()->ContactDB().AddInUse("id",UUID_parts[1],DB_.Prefix(), UUID);
-                } else if (i.first == "del" && UUID_parts[0] == "con") {
-                    DB_.DeleteContact("id", UUID, UUID_parts[1]);
-                    StorageService()->ContactDB().DeleteInUse("id",UUID_parts[1],DB_.Prefix(),UUID);
-                } else if (i.first == "add" && UUID_parts[0] == "loc") {
-                    DB_.AddLocation("id", UUID, UUID_parts[1]);
-                    StorageService()->LocationDB().AddInUse("id",UUID_parts[1],DB_.Prefix(),UUID);
-                } else if (i.first == "del" && UUID_parts[0] == "loc") {
-                    DB_.DeleteLocation("id", UUID, UUID_parts[1]);
-                    StorageService()->LocationDB().DeleteInUse("id",UUID_parts[1],DB_.Prefix(),UUID);
-                }
-            }
+		if (RawObject->has("deviceRules"))
+			Existing.deviceRules = NewEntity.deviceRules;
 
-            if(MovingConfiguration) {
-                if(!Existing.deviceConfiguration.empty())
-                    for(auto &i:Existing.deviceConfiguration)
-                        StorageService()->ConfigurationDB().DeleteInUse("id",i,DB_.Prefix(),Existing.info.id);
-                if(!NewConfiguration.empty())
-                    for(auto &i:NewConfiguration)
-                        StorageService()->ConfigurationDB().AddInUse("id",i,DB_.Prefix(),Existing.info.id);
-                Existing.deviceConfiguration = NewConfiguration;
-            }
+		if (DB_.UpdateRecord("id", UUID, Existing)) {
+			MoveUsage(StorageService()->PolicyDB(), DB_, FromPolicy, ToPolicy, Existing.info.id);
 
-            if(MovingManagementPolicy) {
-                if(!Existing.managementPolicy.empty())
-                    StorageService()->PolicyDB().DeleteInUse("id",Existing.managementPolicy, DB_.Prefix(), Existing.info.id);
-                if(!NewManagementPolicy.empty())
-                    StorageService()->PolicyDB().AddInUse("id", NewManagementPolicy, DB_.Prefix(), Existing.info.id);
-                Existing.managementPolicy = NewManagementPolicy;
-            }
-
-            DB_.UpdateRecord("id", Existing.info.id, Existing);
-
-            Poco::JSON::Object  Answer;
-            ProvObjects::Entity NewRecord;
-            StorageService()->EntityDB().GetRecord("id",UUID, NewRecord);
-            NewRecord.to_json(Answer);
-            return ReturnObject(Answer);
-        }
-        InternalError(RESTAPI::Errors::RecordNotUpdated);
-    }
-}
+			Poco::JSON::Object Answer;
+			ProvObjects::Entity NewRecord;
+			StorageService()->EntityDB().GetRecord("id", UUID, NewRecord);
+			NewRecord.to_json(Answer);
+			return ReturnObject(Answer);
+		}
+		InternalError(RESTAPI::Errors::RecordNotUpdated);
+	}
+} // namespace OpenWifi

src/RESTAPI/RESTAPI_entity_handler.h

@@ -7,32 +7,29 @@
 //
 
 #pragma once
-
-#include "framework/MicroService.h"
 #include "StorageService.h"
+#include "framework/RESTAPI_Handler.h"
 
 namespace OpenWifi {
-    class RESTAPI_entity_handler : public RESTAPIHandler {
-    public:
-        RESTAPI_entity_handler(const RESTAPIHandler::BindingMap &bindings, Poco::Logger &L, RESTAPI_GenericServer & Server, uint64_t TransactionId, bool Internal)
-        : RESTAPIHandler(bindings, L,
-                         std::vector<std::string>{
-                                Poco::Net::HTTPRequest::HTTP_GET,
-                                Poco::Net::HTTPRequest::HTTP_POST,
-                                Poco::Net::HTTPRequest::HTTP_PUT,
-                                Poco::Net::HTTPRequest::HTTP_DELETE,
-                                Poco::Net::HTTPRequest::HTTP_OPTIONS},
-                                Server,
-                                TransactionId,
-                                Internal),
-                                DB_(StorageService()->EntityDB()){}
-        static const std::list<const char *> PathName() { return std::list<const char *>{"/api/v1/entity/{uuid}"}; };
+	class RESTAPI_entity_handler : public RESTAPIHandler {
+	  public:
+		RESTAPI_entity_handler(const RESTAPIHandler::BindingMap &bindings, Poco::Logger &L,
+							   RESTAPI_GenericServerAccounting &Server, uint64_t TransactionId,
+							   bool Internal)
+			: RESTAPIHandler(bindings, L,
+							 std::vector<std::string>{Poco::Net::HTTPRequest::HTTP_GET,
+													  Poco::Net::HTTPRequest::HTTP_POST,
+													  Poco::Net::HTTPRequest::HTTP_PUT,
+													  Poco::Net::HTTPRequest::HTTP_DELETE,
+													  Poco::Net::HTTPRequest::HTTP_OPTIONS},
+							 Server, TransactionId, Internal) {}
+		static auto PathName() { return std::list<std::string>{"/api/v1/entity/{uuid}"}; };
 
-    private:
-        EntityDB        & DB_;
-        void DoGet() final;
-        void DoPost() final ;
-        void DoPut() final;
-        void DoDelete() final;
-    };
-}
+	  private:
+		EntityDB &DB_ = StorageService()->EntityDB();
+		void DoGet() final;
+		void DoPost() final;
+		void DoPut() final;
+		void DoDelete() final;
+	};
+} // namespace OpenWifi

src/RESTAPI/RESTAPI_entity_list_handler.cpp

@@ -6,37 +6,35 @@
 //	Arilia Wireless Inc.
 //
 
-#include "framework/MicroService.h"
 #include "RESTAPI_entity_list_handler.h"
-#include "StorageService.h"
 #include "RESTAPI_db_helpers.h"
+#include "StorageService.h"
 
-namespace OpenWifi{
+namespace OpenWifi {
 
-    void RESTAPI_entity_list_handler::DoGet() {
-        if(!QB_.Select.empty()) {
-            return ReturnRecordList<decltype(StorageService()->EntityDB()),
-            ProvObjects::Entity>("entities",StorageService()->EntityDB(),*this );
-        } else if(QB_.CountOnly) {
-            auto C = StorageService()->EntityDB().Count();
-            return ReturnCountOnly(C);
-        } else if (GetBoolParameter("getTree",false)) {
-            Poco::JSON::Object  FullTree;
-            StorageService()->EntityDB().BuildTree(FullTree);
-            return ReturnObject(FullTree);
-        } else {
-            ProvObjects::EntityVec Entities;
-            StorageService()->EntityDB().GetRecords(QB_.Offset, QB_.Limit,Entities);
-            return MakeJSONObjectArray("entities", Entities, *this);
-        }
-    }
+	void RESTAPI_entity_list_handler::DoGet() {
+		if (!QB_.Select.empty()) {
+			return ReturnRecordList<decltype(DB_), ProvObjects::Entity>("entities", DB_, *this);
+		} else if (QB_.CountOnly) {
+			auto C = DB_.Count();
+			return ReturnCountOnly(C);
+		} else if (GetBoolParameter("getTree", false)) {
+			Poco::JSON::Object FullTree;
+			DB_.BuildTree(FullTree);
+			return ReturnObject(FullTree);
+		} else {
+			EntityDB::RecordVec Entities;
+			DB_.GetRecords(QB_.Offset, QB_.Limit, Entities);
+			return MakeJSONObjectArray("entities", Entities, *this);
+		}
+	}
 
-    void RESTAPI_entity_list_handler::DoPost() {
-        if (GetBoolParameter("setTree",false)) {
-            auto FullTree = ParseStream();
-            StorageService()->EntityDB().ImportTree(FullTree);
-            return OK();
-        }
-        BadRequest(RESTAPI::Errors::MissingOrInvalidParameters);
-    }
-}
+	void RESTAPI_entity_list_handler::DoPost() {
+		if (GetBoolParameter("setTree", false)) {
+			const auto &FullTree = ParsedBody_;
+			DB_.ImportTree(FullTree);
+			return OK();
+		}
+		BadRequest(RESTAPI::Errors::MissingOrInvalidParameters);
+	}
+} // namespace OpenWifi

src/RESTAPI/RESTAPI_entity_list_handler.h

@@ -6,28 +6,28 @@
 //	Arilia Wireless Inc.
 //
 
-
 #pragma once
-
-#include "framework/MicroService.h"
+#include "StorageService.h"
+#include "framework/RESTAPI_Handler.h"
 
 namespace OpenWifi {
-    class RESTAPI_entity_list_handler : public RESTAPIHandler {
-    public:
-        RESTAPI_entity_list_handler(const RESTAPIHandler::BindingMap &bindings, Poco::Logger &L, RESTAPI_GenericServer & Server, uint64_t TransactionId, bool Internal)
-        : RESTAPIHandler(bindings, L,
-                         std::vector<std::string>{
-            Poco::Net::HTTPRequest::HTTP_GET,
-            Poco::Net::HTTPRequest::HTTP_POST,
-            Poco::Net::HTTPRequest::HTTP_OPTIONS},
-            Server,
-            TransactionId,
-            Internal) {}
-        static const std::list<const char *> PathName() { return std::list<const char *>{"/api/v1/entity"}; };
+	class RESTAPI_entity_list_handler : public RESTAPIHandler {
+	  public:
+		RESTAPI_entity_list_handler(const RESTAPIHandler::BindingMap &bindings, Poco::Logger &L,
+									RESTAPI_GenericServerAccounting &Server, uint64_t TransactionId,
+									bool Internal)
+			: RESTAPIHandler(bindings, L,
+							 std::vector<std::string>{Poco::Net::HTTPRequest::HTTP_GET,
+													  Poco::Net::HTTPRequest::HTTP_POST,
+													  Poco::Net::HTTPRequest::HTTP_OPTIONS},
+							 Server, TransactionId, Internal) {}
+		static auto PathName() { return std::list<std::string>{"/api/v1/entity"}; };
 
-        void DoGet() final;
-        void DoPost() final ;
-        void DoPut() final {};
-        void DoDelete() final {};
-    };
-}
+	  private:
+		EntityDB &DB_ = StorageService()->EntityDB();
+		void DoGet() final;
+		void DoPost() final;
+		void DoPut() final{};
+		void DoDelete() final{};
+	};
+} // namespace OpenWifi

src/RESTAPI/RESTAPI_inventory_handler.h

@@ -7,32 +7,33 @@
 //
 
 #pragma once
-
-#include "framework/MicroService.h"
 #include "StorageService.h"
+#include "framework/RESTAPI_Handler.h"
 
 namespace OpenWifi {
-    class RESTAPI_inventory_handler : public RESTAPIHandler {
-    public:
-        RESTAPI_inventory_handler(const RESTAPIHandler::BindingMap &bindings, Poco::Logger &L, RESTAPI_GenericServer & Server, uint64_t TransactionId, bool Internal)
-        : RESTAPIHandler(bindings, L,
-                         std::vector<std::string>{
-            Poco::Net::HTTPRequest::HTTP_GET, Poco::Net::HTTPRequest::HTTP_POST,
-            Poco::Net::HTTPRequest::HTTP_PUT, Poco::Net::HTTPRequest::HTTP_DELETE,
-            Poco::Net::HTTPRequest::HTTP_OPTIONS},
-            Server,
-            TransactionId,
-            Internal),
-            DB_(StorageService()->InventoryDB()){}
-        static const std::list<const char *> PathName() { return std::list<const char *>{"/api/v1/inventory/{serialNumber}"}; };
+	class RESTAPI_inventory_handler : public RESTAPIHandler {
+	  public:
+		RESTAPI_inventory_handler(const RESTAPIHandler::BindingMap &bindings, Poco::Logger &L,
+								  RESTAPI_GenericServerAccounting &Server, uint64_t TransactionId,
+								  bool Internal)
+			: RESTAPIHandler(bindings, L,
+							 std::vector<std::string>{Poco::Net::HTTPRequest::HTTP_GET,
+													  Poco::Net::HTTPRequest::HTTP_POST,
+													  Poco::Net::HTTPRequest::HTTP_PUT,
+													  Poco::Net::HTTPRequest::HTTP_DELETE,
+													  Poco::Net::HTTPRequest::HTTP_OPTIONS},
+							 Server, TransactionId, Internal) {}
+		static auto PathName() {
+			return std::list<std::string>{"/api/v1/inventory/{serialNumber}"};
+		};
 
-    private:
-        void DoGet() final;
-        void DoPost() final;
-        void DoPut() final;
-        void DoDelete() final;
-        void PerformClaim(const std::string &SerialNumber, const std::string & Claimer ,
-                          std::string & ClaimId, uint64_t &ErrorCode, Poco::JSON::Object &Answer);
-        InventoryDB     &DB_;
-    };
-}
+	  private:
+		InventoryDB &DB_ = StorageService()->InventoryDB();
+		void DoGet() final;
+		void DoPost() final;
+		void DoPut() final;
+		void DoDelete() final;
+		void PerformClaim(const std::string &SerialNumber, const std::string &Claimer,
+						  std::string &ClaimId, uint64_t &ErrorCode, Poco::JSON::Object &Answer);
+	};
+} // namespace OpenWifi

src/RESTAPI/RESTAPI_inventory_list_handler.cpp

@@ -6,105 +6,132 @@
 //	Arilia Wireless Inc.
 //
 
-
 #include "RESTAPI_inventory_list_handler.h"
-#include "StorageService.h"
-#include "framework/RESTAPI_errors.h"
 #include "RESTAPI/RESTAPI_db_helpers.h"
+#include "StorageService.h"
 
-namespace OpenWifi{
-    void RESTAPI_inventory_list_handler::SendList( const ProvObjects::InventoryTagVec & Tags, bool SerialOnly) {
-        Poco::JSON::Array   Array;
-        for(const auto &i:Tags) {
-            if(SerialOnly) {
-                Array.add(i.serialNumber);
-            } else {
-                Poco::JSON::Object  O;
-                i.to_json(O);
-                if(QB_.AdditionalInfo)
-                    AddExtendedInfo(i,O);
-                Array.add(O);
-            }
-        }
-        Poco::JSON::Object  Answer;
-        if(SerialOnly)
-            Answer.set("serialNumbers", Array);
-        else
-            Answer.set("taglist", Array);
-        ReturnObject(Answer);
-    }
+namespace OpenWifi {
+	void RESTAPI_inventory_list_handler::SendList(const ProvObjects::InventoryTagVec &Tags,
+												  bool SerialOnly) {
+		Poco::JSON::Array Array;
+		for (const auto &i : Tags) {
+			if (SerialOnly) {
+				Array.add(i.serialNumber);
+			} else {
+				Poco::JSON::Object O;
+				i.to_json(O);
+				if (QB_.AdditionalInfo)
+					AddExtendedInfo(i, O);
+				Array.add(O);
+			}
+		}
+		Poco::JSON::Object Answer;
+		if (SerialOnly)
+			Answer.set("serialNumbers", Array);
+		else
+			Answer.set("taglist", Array);
+		ReturnObject(Answer);
+	}
 
-    void RESTAPI_inventory_list_handler::DoGet() {
-        std::string UUID;
-        std::string Arg;
+	void RESTAPI_inventory_list_handler::DoGet() {
 
-        bool SerialOnly=false;
-        if(HasParameter("serialOnly",Arg) && Arg=="true")
-            SerialOnly=true;
+		if (GetBoolParameter("orderSpec")) {
+			return ReturnFieldList(DB_, *this);
+		}
 
-        std::string OrderBy{" ORDER BY serialNumber ASC "};
-        if(HasParameter("orderBy",Arg)) {
-            if(!StorageService()->InventoryDB().PrepareOrderBy(Arg,OrderBy)) {
-                return BadRequest(RESTAPI::Errors::InvalidLOrderBy);
-            }
-        }
+		bool SerialOnly = GetBoolParameter("serialOnly");
 
-        if(!QB_.Select.empty()) {
-            return ReturnRecordList<decltype(StorageService()->InventoryDB())>("taglist",StorageService()->InventoryDB(),*this );
-        } else if(HasParameter("entity",UUID)) {
-            if(QB_.CountOnly) {
-                auto C = StorageService()->InventoryDB().Count( StorageService()->InventoryDB().OP("entity",ORM::EQ,UUID));
-                return ReturnCountOnly( C);
-            }
-            ProvObjects::InventoryTagVec Tags;
-            StorageService()->InventoryDB().GetRecords(QB_.Offset, QB_.Limit, Tags, StorageService()->InventoryDB().OP("entity",ORM::EQ,UUID), OrderBy);
-            return SendList(Tags, SerialOnly);
-        } else if(HasParameter("venue",UUID)) {
-            if(QB_.CountOnly) {
-                auto C = StorageService()->InventoryDB().Count(StorageService()->InventoryDB().OP("venue",ORM::EQ,UUID));
-                return ReturnCountOnly( C);
-            }
-            ProvObjects::InventoryTagVec Tags;
-            StorageService()->InventoryDB().GetRecords(QB_.Offset, QB_.Limit, Tags, StorageService()->InventoryDB().OP("venue",ORM::EQ,UUID), OrderBy);
-            return SendList( Tags, SerialOnly);
-        } else if(HasParameter("unassigned",Arg) && Arg=="true") {
-            if(QB_.CountOnly) {
-                std::string Empty;
-                auto C = StorageService()->InventoryDB().Count( InventoryDB::OP( StorageService()->InventoryDB().OP("venue",ORM::EQ,Empty),
-                                                                          ORM::AND, StorageService()->InventoryDB().OP("entity",ORM::EQ,Empty) ));
-                return ReturnCountOnly(C);
-            }
-            ProvObjects::InventoryTagVec Tags;
-            std::string Empty;
-            StorageService()->InventoryDB().GetRecords(QB_.Offset, QB_.Limit, Tags, InventoryDB::OP( StorageService()->InventoryDB().OP("venue",ORM::EQ,Empty),
-                                                                                              ORM::AND, StorageService()->InventoryDB().OP("entity",ORM::EQ,Empty) ) , OrderBy );
-            return SendList(Tags, SerialOnly);
-        } else if (HasParameter("subscriber",Arg) && !Arg.empty()) {
-            // looking for device(s) for a specific subscriber...
-            ProvObjects::InventoryTagVec Tags;
-            StorageService()->InventoryDB().GetRecords(0,100,Tags," subscriber='" + Arg + "'");
-            if(SerialOnly) {
-                std::vector<std::string>    SerialNumbers;
-                std::transform(cbegin(Tags), cend(Tags), std::back_inserter(SerialNumbers), [](const auto &T) { return T.serialNumber; });
-                return ReturnObject("serialNumbers",SerialNumbers);
-            } else {
-                return MakeJSONObjectArray("taglist", Tags, *this);
-            }
-        } else if (QB_.CountOnly) {
-            auto C = StorageService()->InventoryDB().Count();
-            return ReturnCountOnly(C);
-        } else if (GetBoolParameter("rrmOnly",false)) {
-            Types::UUIDvec_t   DeviceList;
-            StorageService()->InventoryDB().GetRRMDeviceList(DeviceList);
-            if(QB_.CountOnly)
-                return ReturnCountOnly(DeviceList.size());
-            else {
-                return ReturnObject("serialNumbers",DeviceList);
-            }
-        } else {
-            ProvObjects::InventoryTagVec Tags;
-            StorageService()->InventoryDB().GetRecords(QB_.Offset,QB_.Limit,Tags,"",OrderBy);
-            return MakeJSONObjectArray("taglist", Tags, *this);
-        }
-    }
-}
+		std::string UUID;
+		std::string Arg, Arg2;
+
+		std::string OrderBy{" ORDER BY serialNumber ASC "};
+		if (HasParameter("orderBy", Arg)) {
+			if (!DB_.PrepareOrderBy(Arg, OrderBy)) {
+				return BadRequest(RESTAPI::Errors::InvalidLOrderBy);
+			}
+		}
+
+		if (!QB_.Select.empty()) {
+			return ReturnRecordList<decltype(DB_)>("taglist", DB_, *this);
+		} else if (HasParameter("entity", UUID)) {
+			if (QB_.CountOnly) {
+				auto C = DB_.Count(StorageService()->InventoryDB().OP("entity", ORM::EQ, UUID));
+				return ReturnCountOnly(C);
+			}
+			ProvObjects::InventoryTagVec Tags;
+			DB_.GetRecords(QB_.Offset, QB_.Limit, Tags, DB_.OP("entity", ORM::EQ, UUID), OrderBy);
+			return SendList(Tags, SerialOnly);
+		} else if (HasParameter("venue", UUID)) {
+			if (QB_.CountOnly) {
+				auto C = DB_.Count(DB_.OP("venue", ORM::EQ, UUID));
+				return ReturnCountOnly(C);
+			}
+			ProvObjects::InventoryTagVec Tags;
+			DB_.GetRecords(QB_.Offset, QB_.Limit, Tags, DB_.OP("venue", ORM::EQ, UUID), OrderBy);
+			return SendList(Tags, SerialOnly);
+		} else if (GetBoolParameter("subscribersOnly") && GetBoolParameter("unassigned")) {
+			if (QB_.CountOnly) {
+				auto C = DB_.Count(" devClass='subscriber' and subscriber='' ");
+				return ReturnCountOnly(C);
+			}
+			ProvObjects::InventoryTagVec Tags;
+			DB_.GetRecords(QB_.Offset, QB_.Limit, Tags, " devClass='subscriber' and subscriber='' ",
+						   OrderBy);
+			if (QB_.CountOnly) {
+				auto C = DB_.Count(DB_.OP("venue", ORM::EQ, UUID));
+				return ReturnCountOnly(C);
+			}
+			return SendList(Tags, SerialOnly);
+		} else if (GetBoolParameter("subscribersOnly")) {
+			if (QB_.CountOnly) {
+				auto C = DB_.Count(" devClass='subscriber' and subscriber!='' ");
+				return ReturnCountOnly(C);
+			}
+			ProvObjects::InventoryTagVec Tags;
+			DB_.GetRecords(QB_.Offset, QB_.Limit, Tags,
+						   " devClass='subscriber' and subscriber!='' ", OrderBy);
+			return SendList(Tags, SerialOnly);
+		} else if (GetBoolParameter("unassigned")) {
+			if (QB_.CountOnly) {
+				std::string Empty;
+				auto C = DB_.Count(InventoryDB::OP(DB_.OP("venue", ORM::EQ, Empty), ORM::AND,
+												   DB_.OP("entity", ORM::EQ, Empty)));
+				return ReturnCountOnly(C);
+			}
+			ProvObjects::InventoryTagVec Tags;
+			std::string Empty;
+			DB_.GetRecords(QB_.Offset, QB_.Limit, Tags,
+						   InventoryDB::OP(DB_.OP("venue", ORM::EQ, Empty), ORM::AND,
+										   DB_.OP("entity", ORM::EQ, Empty)),
+						   OrderBy);
+			return SendList(Tags, SerialOnly);
+		} else if (HasParameter("subscriber", Arg) && !Arg.empty()) {
+			// looking for device(s) for a specific subscriber...
+			ProvObjects::InventoryTagVec Tags;
+			DB_.GetRecords(0, 100, Tags, " subscriber='" + ORM::Escape(Arg) + "'");
+			if (SerialOnly) {
+				std::vector<std::string> SerialNumbers;
+				std::transform(cbegin(Tags), cend(Tags), std::back_inserter(SerialNumbers),
+							   [](const auto &T) { return T.serialNumber; });
+				return ReturnObject("serialNumbers", SerialNumbers);
+			} else {
+				return MakeJSONObjectArray("taglist", Tags, *this);
+			}
+		} else if (QB_.CountOnly) {
+			auto C = DB_.Count();
+			return ReturnCountOnly(C);
+		} else if (GetBoolParameter("rrmOnly")) {
+			Types::UUIDvec_t DeviceList;
+			DB_.GetRRMDeviceList(DeviceList);
+			if (QB_.CountOnly)
+				return ReturnCountOnly(DeviceList.size());
+			else {
+				return ReturnObject("serialNumbers", DeviceList);
+			}
+		} else {
+			ProvObjects::InventoryTagVec Tags;
+			DB_.GetRecords(QB_.Offset, QB_.Limit, Tags, "", OrderBy);
+			return MakeJSONObjectArray("taglist", Tags, *this);
+		}
+	}
+} // namespace OpenWifi

src/RESTAPI/RESTAPI_inventory_list_handler.h

@@ -7,29 +7,29 @@
 //
 
 #pragma once
-
-#include "framework/MicroService.h"
-#include "RESTObjects/RESTAPI_ProvObjects.h"
+#include "StorageService.h"
+#include "framework/RESTAPI_Handler.h"
 
 namespace OpenWifi {
 
-    class RESTAPI_inventory_list_handler : public RESTAPIHandler {
-    public:
-        RESTAPI_inventory_list_handler(const RESTAPIHandler::BindingMap &bindings, Poco::Logger &L, RESTAPI_GenericServer & Server, uint64_t TransactionId, bool Internal)
-        : RESTAPIHandler(bindings, L,
-                         std::vector<std::string>{
-            Poco::Net::HTTPRequest::HTTP_GET,
-            Poco::Net::HTTPRequest::HTTP_OPTIONS},
-            Server,
-            TransactionId,
-            Internal) {}
-        static const std::list<const char *> PathName() { return std::list<const char *>{"/api/v1/inventory"}; };
+	class RESTAPI_inventory_list_handler : public RESTAPIHandler {
+	  public:
+		RESTAPI_inventory_list_handler(const RESTAPIHandler::BindingMap &bindings, Poco::Logger &L,
+									   RESTAPI_GenericServerAccounting &Server,
+									   uint64_t TransactionId, bool Internal)
+			: RESTAPIHandler(bindings, L,
+							 std::vector<std::string>{Poco::Net::HTTPRequest::HTTP_GET,
+													  Poco::Net::HTTPRequest::HTTP_OPTIONS},
+							 Server, TransactionId, Internal) {}
+		static auto PathName() { return std::list<std::string>{"/api/v1/inventory"}; };
 
-        void DoGet() final;
-        void DoPost() final {};
-        void DoPut() final {};
-        void DoDelete() final {};
+	  private:
+		InventoryDB &DB_ = StorageService()->InventoryDB();
+		void DoGet() final;
+		void DoPost() final{};
+		void DoPut() final{};
+		void DoDelete() final{};
 
-        void SendList(const ProvObjects::InventoryTagVec & Tags, bool SerialOnly);
-    };
-}
+		void SendList(const ProvObjects::InventoryTagVec &Tags, bool SerialOnly);
+	};
+} // namespace OpenWifi