Merge pull request #90 from Telecominfraproject/version_update

WIFI-14165: release 3.2 version update

.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:
@@ -25,41 +26,78 @@ jobs:
       DOCKER_REGISTRY_URL: tip-tip-wlan-cloud-ucentral.jfrog.io
       DOCKER_REGISTRY_USERNAME: ucentral
     steps:
-    - uses: actions/checkout@v2
+    - name: Checkout actions repo
-
+      uses: actions/checkout@v3
-    - name: Build Docker image
-      run: docker build -t wlan-cloud-owfms:${{ github.sha }} .
-
-    - name: Tag Docker image
-      run: |
-        TAGS="${{ github.sha }}"
-        if [[ ${GITHUB_REF} == "refs/heads/"* ]]
-        then
-          CURRENT_TAG=$(echo ${GITHUB_REF#refs/heads/} | tr '/' '-')
-          TAGS="$TAGS $CURRENT_TAG"
-        else
-          if [[ ${GITHUB_REF} == "refs/tags/"* ]]
-          then
-            CURRENT_TAG=$(echo ${GITHUB_REF#refs/tags/} | tr '/' '-')
-            TAGS="$TAGS $CURRENT_TAG"
-          else # PR build
-            CURRENT_TAG=$(echo ${GITHUB_HEAD_REF#refs/heads/} | tr '/' '-')
-            TAGS="$TAGS $CURRENT_TAG"
-          fi
-        fi
-        echo "Result tags: $TAGS"
-        for tag in $TAGS; do
-          docker tag wlan-cloud-owfms:${{ github.sha }} ${{ env.DOCKER_REGISTRY_URL }}/owfms:$tag
-        done
-    - name: Log into Docker registry
-      if: startsWith(github.ref, 'refs/tags/') || startsWith(github.ref, 'refs/pull/') || github.ref == 'refs/heads/main'
-      uses: docker/login-action@v1
       with:
-        registry: ${{ env.DOCKER_REGISTRY_URL }}
+        repository: Telecominfraproject/.github
-        username: ${{ env.DOCKER_REGISTRY_USERNAME }}
+        path: github
-        password: ${{ secrets.DOCKER_REGISTRY_PASSWORD }}
 
-    - name: Push Docker images
+    - name: Build and push Docker image
-      if: startsWith(github.ref, 'refs/tags/') || startsWith(github.ref, 'refs/pull/') || github.ref == 'refs/heads/main'
+      uses: ./github/composite-actions/docker-image-build
+      with:
+        image_name: owfms
+        registry: tip-tip-wlan-cloud-ucentral.jfrog.io
+        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 OWFMS service
+
+  trigger-testing:
+    if: startsWith(github.ref, 'refs/pull/')
+    runs-on: ubuntu-latest
+    needs: docker
+    steps:
+    - name: Get base branch name and set as output
+      id: get_base_branch
       run: |
-        docker images | grep ${{ env.DOCKER_REGISTRY_URL }}/owfms | awk -F ' ' '{print $1":"$2}' | xargs -I {} docker push {}
+        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@v3
+      with:
+        repository: Telecominfraproject/.github
+        path: github
+
+    - name: Trigger testing of OpenWifi Docker Compose deployment and wait for result
+      uses: ./github/composite-actions/trigger-workflow-and-wait
+      env:
+        BASE_BRANCH: ${{ steps.get_base_branch.outputs.branch }}
+        OWGW_BASE_BRANCH: ${{ steps.get_base_branch.outputs.owgw_branch }}
+      with:
+        owner: Telecominfraproject
+        repo: wlan-testing
+        workflow: ow_docker-compose.yml
+        token: ${{ secrets.WLAN_TESTING_PAT }}
+        ref: master
+        inputs: '{"deployment_version": "${{ env.BASE_BRANCH }}", "owgw_version": "${{ env.OWGW_BASE_BRANCH }}", "owsec_version": "${{ env.BASE_BRANCH }}", "owfms_version": "${{ github.sha }}", "owprov_version": "${{ env.BASE_BRANCH }}", "owanalytics_version": "${{ env.BASE_BRANCH }}", "owsub_version": "${{ env.BASE_BRANCH }}", "microservice": "owfms"}'
+
+  trigger-deploy-to-dev:
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/main'
+    needs:
+      - docker
+    steps:
+    - name: Checkout actions repo
+      uses: actions/checkout@v3
+      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/owfms/$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/owfms/$PR_BRANCH_TAG"
+          else
+            echo "PR branch is $PR_BRANCH_TAG, not deleting Docker image"
+          fi

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

@@ -0,0 +1,24 @@
+name: Ensure Jira issue is linked
+
+on:
+  pull_request:
+    types: [opened, edited, reopened, synchronize]
+    branches:
+      - 'release/*'
+
+jobs:
+  check_for_issue_key:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout actions repo
+        uses: actions/checkout@v2
+        with:
+          repository: Telecominfraproject/.github
+          path: github
+
+      - name: Run JIRA check
+        uses: ./github/composite-actions/enforce-jira-issue-key
+        with:
+          jira_base_url: ${{ secrets.TIP_JIRA_URL }}
+          jira_user_email: ${{ secrets.TIP_JIRA_USER_EMAIL }}
+          jira_api_token: ${{ secrets.TIP_JIRA_API_TOKEN }}

.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-ucentralfms/main/openapi/owfms.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@v2
+        with:
+          path: wlan-cloud-ucentralfms
+
+      - name: Build package
+        working-directory: wlan-cloud-ucentralfms/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-ucentralfms/helm
+        run: |
+          pip3 install yq -q
+          echo "Docker image - tip-tip-wlan-cloud-ucentral.jfrog.io/owfms:$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-ucentralfms/helm/release.txt
+          files: wlan-cloud-ucentralfms/helm/dist/*

.gitignore

@@ -20,5 +20,4 @@ _deps
 *.zip
 result.json
 pidfile
-
+test_scripts/curl/result.json
-

BUILDING.md

@@ -0,0 +1,121 @@
+# Building from source
+In order to build OWFMS, 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
+
+Building is a 2 part process. The first part is to build a local copy of the framework tailored to your environment. This
+framework is [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/Telecominfraproject/wlan-cloud-lib-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 libmariabd-dev unixodbc-dev
+sudo apt install libpq-dev libaprutil1-dev apache2-dev libboost-all-dev
+sudo apt install librdkafka-dev liblua5.3-dev
+
+git clone https://github.com/Telecominfraproject/wlan-cloud-lib-poco --branch poco-tip-v1 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-lib-cppkafka --branch tip-v1 cppkafka
+cd cppkafka
+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-ucentralgw
+cd wlan-cloud-ucentralgw
+mkdir cmake-build
+cd cmake-build
+cmake ..
+make
+cd ../..
+```
+
+## Fedora
+The following instructions have proven to work on Fedora 33
+```bash
+sudo yum install cmake g++ openssl-devel unixODBC-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
+
+git clone https://github.com/Telecominfraproject/wlan-cloud-lib-poco --branch poco-tip-v1 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-lib-cppkafka --branch tip-v1 cppkafka
+cd cppkafka
+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-ucentralfms
+cd wlan-cloud-ucentralfms
+mkdir cmake-build
+cd cmake-build
+cmake ..
+make
+cd ../..
+
+```
+
+## Mac OSX Build
+The following instructions have proven to work on OSX 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 \
+    unixodbc librdkafka
+
+git clone https://github.com/Telecominfraproject/wlan-cloud-lib-poco --branch poco-tip-v1 poco
+cd poco
+mkdir cmake-build
+cd cmake-build
+cmake ..
+cmake --build . --config Release -j
+sudo cmake --build . --target install
+cd ../..
+
+git clone https://github.com/Telecominfraproject/wlan-cloud-lib-cppkafka --branch tip-v1 cppkafka
+cd cppkafka
+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-ucentralfms
+cd wlan-cloud-ucentralfms
+mkdir cmake-build
+cd cmake-build
+cmake ..
+make -j
+cd ../..
+```

CMakeLists.txt

@@ -1,5 +1,5 @@
 cmake_minimum_required(VERSION 3.13)
-project(owfms VERSION 2.4.0)
+project(owfms VERSION 3.2.0)
 
 set(CMAKE_CXX_STANDARD 17)
 
@@ -15,27 +15,37 @@ if(UNIX AND NOT APPLE)
 endif()
 
 if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/build)
-    file(READ build BUILD_NUM)
+    file(READ ${CMAKE_CURRENT_SOURCE_DIR}/build BUILD_NUM)
     if(BUILD_INCREMENT)
         MATH(EXPR BUILD_NUM "${BUILD_NUM}+1")
-        file(WRITE build ${BUILD_NUM})
+        file(WRITE ${CMAKE_CURRENT_SOURCE_DIR}/build ${BUILD_NUM})
     endif()
 else()
     set(BUILD_NUM 1)
-    file(WRITE build ${BUILD_NUM})
+    file(WRITE ${CMAKE_CURRENT_SOURCE_DIR}/build ${BUILD_NUM})
 endif()
 
-set(BUILD_SHARED_LIBS 1)
+find_package(Git QUIET)
-add_definitions(-DAPP_VERSION="${CMAKE_PROJECT_VERSION}" -DBUILD_NUMBER="${BUILD_NUM}" -DAWS_CUSTOM_MEMORY_MANAGEMENT)
+if(GIT_FOUND AND EXISTS "${PROJECT_SOURCE_DIR}/.git")
+    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 rev-parse --short HEAD failed with ${GIT_RESULT}")
+    endif()
+    string(REGEX REPLACE "\n$" "" GIT_HASH "${GIT_HASH}")
+endif()
 
-set(Boost_USE_STATIC_LIBS OFF)
+# set(BUILD_SHARED_LIBS 1)
-set(Boost_USE_MULTITHREADED ON)
+# add_definitions(-DAWS_CUSTOM_MEMORY_MANAGEMENT)
-set(Boost_USE_STATIC_RUNTIME OFF)
 
-find_package(Boost      REQUIRED system)
 find_package(OpenSSL    REQUIRED)
-find_package(AWSSDK     REQUIRED COMPONENTS s3)
+find_package(fmt        REQUIRED)
+find_package(ZLIB       REQUIRED)
 find_package(Poco       REQUIRED COMPONENTS Crypto JWT Net Util NetSSL Data DataSQLite)
+find_package(AWSSDK     REQUIRED COMPONENTS s3)
+find_package(ZLIB       REQUIRED)
 
 if(SMALL_BUILD)
     find_package(Poco REQUIRED COMPONENTS Crypto JWT Net Util NetSSL Data DataSQLite)
@@ -48,21 +58,74 @@ endif()
 
 include_directories(/usr/local/include  /usr/local/opt/openssl/include src include/kafka /usr/local/opt/mysql-client/include)
 
+configure_file(src/ow_version.h.in ${PROJECT_SOURCE_DIR}/src/ow_version.h @ONLY)
+
+add_compile_options(-Wall -Wextra)
+add_definitions(-DPOCO_LOG_DEBUG="1" -DBOOST_NO_CXX98_FUNCTION_BASE=1)
+
+if(ASAN)
+    add_compile_options(-fsanitize=address)
+    add_link_options(-fsanitize=address)
+endif()
+
 add_executable( owfms
         build
+        src/ow_version.h.in
         src/framework/CountryCodes.h
         src/framework/KafkaTopics.h
         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/UI_WebSocketClientNotifications.cpp
+        src/framework/UI_WebSocketClientNotifications.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/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/RESTAPI_SystemConfiguration.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/EventBusManager.cpp
+        src/framework/EventBusManager.h
+        src/framework/RESTAPI_PartHandler.h
+        src/framework/MicroService.cpp
+        src/framework/MicroServiceExtra.h
+        src/framework/default_device_types.h
         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_firmwaresHandler.cpp src/RESTAPI/RESTAPI_firmwaresHandler.h
         src/RESTAPI/RESTAPI_firmwareHandler.cpp src/RESTAPI/RESTAPI_firmwareHandler.h
         src/RESTAPI/RESTAPI_historyHandler.cpp src/RESTAPI/RESTAPI_historyHandler.h
@@ -70,28 +133,31 @@ add_executable( owfms
         src/RESTAPI/RESTAPI_connectedDevicesHandler.cpp src/RESTAPI/RESTAPI_connectedDevicesHandler.h
         src/RESTAPI/RESTAPI_deviceReportHandler.cpp src/RESTAPI/RESTAPI_deviceReportHandler.h
         src/RESTAPI/RESTAPI_connectedDeviceHandler.cpp src/RESTAPI/RESTAPI_connectedDeviceHandler.h
-        src/storage/storage_tables.cpp
+        src/RESTAPI/RESTAPI_Routers.cpp
-        src/storage/storage_firmwares.cpp
-        src/storage/storage_firmwares.h src/storage/storage_history.cpp
-        src/storage/storage_history.h src/storage/storage_deviceTypes.cpp
-        src/storage/storage_deviceInfo.cpp src/storage/storage_deviceInfo.h
-        src/APIServers.cpp
         src/Dashboard.cpp src/Dashboard.h
         src/Daemon.cpp src/Daemon.h
         src/StorageService.cpp src/StorageService.h
         src/ManifestCreator.cpp src/ManifestCreator.h
-        src/framework/MicroService.h
         src/NewConnectionHandler.cpp src/NewConnectionHandler.h
         src/LatestFirmwareCache.cpp src/LatestFirmwareCache.h
         src/DeviceCache.cpp src/DeviceCache.h
         src/FirmwareCache.cpp src/FirmwareCache.h
         src/SDK/Prov_SDK.cpp src/SDK/Prov_SDK.h
         src/AutoUpdater.cpp src/AutoUpdater.h src/SDK/GW_SDK.cpp src/SDK/GW_SDK.h
-        )
+        src/NewCommandHandler.cpp src/NewCommandHandler.h
+        src/storage/orm_history.cpp src/storage/orm_history.h
+        src/storage/orm_firmwares.cpp src/storage/orm_firmwares.h
+        src/storage/orm_deviceInfo.cpp src/storage/orm_deviceInfo.h
+        src/RESTAPI/RESTAPI_deviceInformation_handler.cpp
+        src/RESTAPI/RESTAPI_deviceInformation_handler.h)
 
-target_link_libraries(owfms PUBLIC
+target_link_libraries( owfms PUBLIC
-        ${Poco_LIBRARIES} ${MySQL_LIBRARIES}
+        ${Poco_LIBRARIES}
-        ${Boost_LIBRARIES}
+        ${MySQL_LIBRARIES}
-        ${ZLIB_LIBRARIES} ${AWSSDK_LINK_LIBRARIES}
+        ${ZLIB_LIBRARIES}
-        CppKafka::cppkafka )
+        ${AWSSDK_LINK_LIBRARIES}
+        fmt::fmt
+        resolv
+        CppKafka::cppkafka
+    )
 

CONFIGURATION.md

@@ -0,0 +1,250 @@
+# OWFMS Configuration
+Here is the list of parameters you can configure in the `owfms.properties` file.
+
+## OWFMS Specific Parameters
+### OWFMS behaviour
+```properties
+firmwaredb.refresh = 86400
+firmwaredb.maxage = 90
+autoupdater.enabled = true
+```
+#### firmwaredb.refresh
+How often to refresh the FMS DB, in seconds. Should never be less than 6 hours. It does take 10-20 minutes to 
+create a refresh. The default is 24 hours. 
+
+#### firmwaredb.maxage
+The maximum age of firmware kept in the DB (in days). Do not go more than 6 months. The default is 3 months.
+
+#### autoupdater.enabled
+The determins if the FMS autoupdates its database. You should leave this to `true`.
+
+
+### S3 information
+The actual data for all the firmware is kept in a TIP bucket. The following parameters allow you to change the bucket.
+You should never need to do this unless you need to implement your own FMS server.
+
+```properties
+s3.bucketname = ucentral-ap-firmware
+s3.region = us-east-1
+s3.secret = *******************************************
+s3.key =  *******************************************
+s3.retry = 60
+s3.bucket.uri = ucentral-ap-firmware.s3.amazonaws.com
+s3.endpoint.https = true
+s3.endpointOverride = ""
+s3.useVirtualAdressing = true
+```
+
+#### s3.bucketname
+The S3 bucket name.
+#### s3.region
+The region for this bucket.
+#### s3.secret
+The AWS secret for access to this S3 bucket
+#### s3.key
+The AWS key for access for this S3 bucket
+#### s3.retry = 60
+The AWS retry window in seconds.
+#### s3.bucket.uri = ucentral-ap-firmware.s3.amazonaws.com
+The URI to the S3 bucket
+#### s3.endpointOverride = ""
+The Endpoint Address to override if you using a different provider that not AWS.
+#### s3.endpoint.https = true
+The Endpoint Method if you using a HTTP endpoint
+#### s3.useVirtualAdressing = true
+In a virtual-hosted–style URI, the bucket name is part of the domain name in the URL. (Not supported by all providers)
+
+## 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 = $OWFMS_ROOT/certs/restapi-ca.pem
+openwifi.restapi.host.0.address = *
+openwifi.restapi.host.0.port = 16004
+openwifi.restapi.host.0.cert = $OWFMS_ROOT/certs/restapi-cert.pem
+openwifi.restapi.host.0.key = $OWFMS_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 = $OWFMS_ROOT/certs/restapi-ca.pem
+openwifi.internal.restapi.host.0.address = *
+openwifi.internal.restapi.host.0.port = 17004
+openwifi.internal.restapi.host.0.cert = $OWFMS_ROOT/certs/restapi-cert.pem
+openwifi.internal.restapi.host.0.key = $OWFMS_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 = $OWFMS_ROOT/certs/restapi-key.pem
+openwifi.service.key.password = mypassword
+openwifi.system.data = $OWFMS_ROOT/data
+openwifi.system.uri.private = https://localhost:17004
+openwifi.system.uri.public = https://ucentral.dpaas.arilia.com:16002
+openwifi.system.uri.ui = https://ucentral-ui.arilia.com
+openwifi.security.restapi.disable = false
+openwifi.system.commandchannel = /tmp/app.ucentralfms
+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 = firmware
+openwifi.kafka.client.id = firmware1
+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 `firmware`
+### 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 = firmware.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 = firmware
+storage.type.postgresql.password = firmware
+storage.type.postgresql.database = firmware
+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 = firmware
+storage.type.postgresql.password = firmware
+storage.type.postgresql.database = firmware
+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 = $OWFMS_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,36 +1,23 @@
-FROM alpine AS builder
+ARG DEBIAN_VERSION=11.5-slim
+ARG POCO_VERSION=poco-tip-v2
+ARG CPPKAFKA_VERSION=tip-v1
+ARG VALIJASON_VERSION=tip-v1
+ARG APP_NAME=owfms
+ARG APP_HOME_DIR=/openwifi
 
-RUN apk add --update --no-cache \
+FROM debian:$DEBIAN_VERSION AS build-base
-    openssl openssh \
-    ncurses-libs \
-    bash util-linux coreutils curl libcurl \
-    make cmake gcc g++ libstdc++ libgcc git zlib-dev \
-    openssl-dev boost-dev curl-dev util-linux-dev \
-    unixodbc-dev postgresql-dev mariadb-dev \
-    librdkafka-dev
 
-RUN git clone https://github.com/stephb9959/poco /poco
+RUN apt-get update && apt-get install --no-install-recommends -y \
-RUN git clone https://github.com/stephb9959/cppkafka /cppkafka
+    make cmake g++ git curl zip unzip pkg-config \
-RUN git clone https://github.com/nlohmann/json /json
+    libpq-dev libmariadb-dev libmariadbclient-dev-compat \
-RUN git clone https://github.com/pboettch/json-schema-validator /json-schema-validator
+    librdkafka-dev libboost-all-dev libssl-dev \
-RUN git clone --recurse-submodules https://github.com/aws/aws-sdk-cpp /aws-sdk-cpp
+    zlib1g-dev ca-certificates libcurl4-openssl-dev libfmt-dev
 
-WORKDIR /aws-sdk-cpp
+FROM build-base AS poco-build
-RUN mkdir cmake-build
-WORKDIR cmake-build
-RUN cmake .. -DBUILD_ONLY="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
 
-WORKDIR /cppkafka
+ARG POCO_VERSION
-RUN mkdir cmake-build
+ADD https://api.github.com/repos/Telecominfraproject/wlan-cloud-lib-poco/git/refs/tags/${POCO_VERSION} version.json
-WORKDIR cmake-build
+RUN git clone https://github.com/Telecominfraproject/wlan-cloud-lib-poco --branch ${POCO_VERSION} /poco
-RUN cmake ..
-RUN cmake --build . --config Release -j8
-RUN cmake --build . --target install
 
 WORKDIR /poco
 RUN mkdir cmake-build
@@ -39,58 +26,87 @@ RUN cmake ..
 RUN cmake --build . --config Release -j8
 RUN cmake --build . --target install
 
-WORKDIR /json
+FROM build-base AS cppkafka-build
+
+ARG CPPKAFKA_VERSION
+
+ADD https://api.github.com/repos/Telecominfraproject/wlan-cloud-lib-cppkafka/git/refs/tags/${CPPKAFKA_VERSION} version.json
+RUN git clone https://github.com/Telecominfraproject/wlan-cloud-lib-cppkafka --branch ${CPPKAFKA_VERSION} /cppkafka
+
+WORKDIR /cppkafka
 RUN mkdir cmake-build
 WORKDIR cmake-build
 RUN cmake ..
-RUN make
-RUN make install
-
-WORKDIR /json-schema-validator
-RUN mkdir cmake-build
-WORKDIR cmake-build
-RUN cmake ..
-RUN make
-RUN make install
-
-ADD CMakeLists.txt build /owfms/
-ADD cmake /owfms/cmake
-ADD src /owfms/src
-
-WORKDIR /owfms
-RUN mkdir cmake-build
-WORKDIR /owfms/cmake-build
-RUN cmake ..
 RUN cmake --build . --config Release -j8
+RUN cmake --build . --target install
 
-FROM alpine
+FROM build-base AS app-build
 
-ENV OWFMS_USER=owfms \
+ARG APP_NAME
-    OWFMS_ROOT=/owfms-data \
-    OWFMS_CONFIG=/owfms-data
 
-RUN addgroup -S "$OWFMS_USER" && \
+ADD CMakeLists.txt build /${APP_NAME}/
-    adduser -S -G "$OWFMS_USER" "$OWFMS_USER"
+ADD overlays /${APP_NAME}/overlays
+ADD cmake /${APP_NAME}/cmake
+ADD src /${APP_NAME}/src
+ADD .git /${APP_NAME}/.git
+ARG VCPKG_VERSION=2022.11.14
 
-RUN mkdir /openwifi
+RUN git clone --depth 1 --branch ${VCPKG_VERSION} https://github.com/microsoft/vcpkg && \
-RUN mkdir -p "$OWFMS_ROOT" "$OWFMS_CONFIG" && \
+    ./vcpkg/bootstrap-vcpkg.sh && \
-    chown "$OWFMS_USER": "$OWFMS_ROOT" "$OWFMS_CONFIG"
+    mkdir /vcpkg/custom-triplets && \
-RUN apk add --update --no-cache librdkafka curl-dev mariadb-connector-c libpq unixodbc su-exec gettext ca-certificates bash jq curl
+    cp /vcpkg/triplets/x64-linux.cmake /vcpkg/custom-triplets/x64-linux.cmake && \
+    sed -i 's/set(VCPKG_LIBRARY.*/set(VCPKG_LIBRARY_LINKAGE dynamic)/g' /vcpkg/custom-triplets/x64-linux.cmake && \
+    ./vcpkg/vcpkg install aws-sdk-cpp[s3]:x64-linux json-schema-validator:x64-linux --overlay-triplets=/vcpkg/custom-triplets --overlay-ports=/owfms/overlays
 
-COPY --from=builder /owfms/cmake-build/owfms /openwifi/owfms
+COPY --from=poco-build /usr/local/include /usr/local/include
-COPY --from=builder /cppkafka/cmake-build/src/lib/* /lib/
+COPY --from=poco-build /usr/local/lib /usr/local/lib
-COPY --from=builder /poco/cmake-build/lib/* /lib/
+COPY --from=cppkafka-build /usr/local/include /usr/local/include
-COPY --from=builder /aws-sdk-cpp/cmake-build/aws-cpp-sdk-core/libaws-cpp-sdk-core.so /lib/
+COPY --from=cppkafka-build /usr/local/lib /usr/local/lib
-COPY --from=builder /aws-sdk-cpp/cmake-build/aws-cpp-sdk-s3/libaws-cpp-sdk-s3.so /lib/
 
-COPY owfms.properties.tmpl /
+WORKDIR /${APP_NAME}
-COPY docker-entrypoint.sh /
+RUN mkdir cmake-build
-RUN wget https://raw.githubusercontent.com/Telecominfraproject/wlan-cloud-ucentral-deploy/main/docker-compose/certs/restapi-ca.pem \
+WORKDIR /${APP_NAME}/cmake-build
-    -O /usr/local/share/ca-certificates/restapi-ca-selfsigned.pem
+RUN cmake -DCMAKE_TOOLCHAIN_FILE=/vcpkg/scripts/buildsystems/vcpkg.cmake ..
+RUN cmake --build . --config Release -j8
+
+FROM debian:$DEBIAN_VERSION
+
+ARG APP_NAME
+ARG APP_HOME_DIR
+
+ENV APP_NAME=$APP_NAME \
+    APP_USER=$APP_NAME \
+    APP_ROOT=/$APP_NAME-data \
+    APP_CONFIG=/$APP_NAME-data \
+    APP_HOME_DIR=$APP_HOME_DIR
+
+RUN useradd $APP_USER
+
+RUN mkdir $APP_HOME_DIR
+RUN mkdir -p "$APP_ROOT" "$APP_CONFIG" && \
+    chown "$APP_USER": "$APP_ROOT" "$APP_CONFIG"
+
+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 sqlite3
 
 COPY readiness_check /readiness_check
+COPY test_scripts/curl/cli /cli
+
+COPY $APP_NAME.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.crt
+
+COPY --from=app-build /$APP_NAME/cmake-build/$APP_NAME $APP_HOME_DIR/$APP_NAME
+COPY --from=app-build /vcpkg/installed/x64-linux/lib/ /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 16004 17004 16104
 
 ENTRYPOINT ["/docker-entrypoint.sh"]
-CMD ["/openwifi/owfms"]
+CMD ${APP_HOME_DIR}/${APP_NAME}

README.md

@@ -1,3 +1,7 @@
+<p align="center">
+    <img src="images/project/logo.svg" width="200"/>
+</p>
+
 # uCentralFMS
 
 ## What is this?
@@ -5,215 +9,87 @@ The uCentralFMS is a micro-service part of the OpenWiFi ecosystem. uCentralFMS i
 to facilitate the task of upgrade and maintaining the proper firmware for all the devices 
 used in your OpenWiFi solution. You may either [build it](#building) or use the [Docker version](#docker).
 
+## OpenAPI
+You may get static page with OpenAPI docs generated from the definition on [GitHub Page](https://telecominfraproject.github.io/wlan-cloud-ucentralfms/).
+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-ucentralfms/main/openapi/owfms.yaml)) to get interactive docs page.
+
 ## Building
-In order to build the uCentralFMS, you will need to install its dependencies, which includes the following:
+To build the microservice from source, please follow the instructions in [here](./BUILDING.md)
-- cmake
-- boost
-- POCO 1.10.1 or later
-- a C++17 compiler
-- openssl
-- libpq-dev (PortgreSQL development libraries)
-- mysql-client (MySQL client)
-- librdkafka
-- cppkafka
 
-Building is a 2 part process. The first part is to build a local copy of the framework tailored to your environment. This
+## Docker
-framework is [Poco](https://github.com/pocoproject/poco). The version used in this project has a couple of fixes
+To use the CLoudSDK deployment please follow [here](https://github.com/Telecominfraproject/wlan-cloud-ucentral-deploy)
-from the master copy needed for cmake. Please use the version of this [Poco fix](https://github.com/stephb9959/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.
-```
-sudo apt install git cmake g++ libssl-dev libmariabd-dev unixodbc-dev 
-sudo apt install libpq-dev libaprutil1-dev apache2-dev libboost-all-dev
-sudo apt install librdkafka-dev liblua5.3-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
-
-git clone https://github.com/stephb9959/cppkafka
-cd cppkafka
-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-ucentralgw
-cd wlan-cloud-ucentralgw
-mkdir cmake-build
-cd cmake-build
-cmake ..
-make
-```
-
-### Fedora
-The following instructions have proven to work on Fedora 33
-```
-sudo yum install cmake g++ openssl-devel unixODBC-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
-
-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
-
-git clone https://github.com/stephb9959/cppkafka
-cd cppkafka
-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-ucentralfms
-cd wlan-cloud-ucentralfms
-mkdir cmake-build
-cd cmake-build
-cmake ..
-make
-
-```
-
-### OSX Build
-The following instructions have proven to work on OSX 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/).
-```
-brew install openssl
-brew install cmake
-brew install libpq
-brew install mysql-client
-brew install apr
-brew install apr-util
-brew install boost
-brew install yaml-cpp
-brew install postgresql
-brew install unixodbc
-brew install librdkafka
-
-git clone https://github.com/stephb9959/poco
-cd poco
-mkdir cmake-build 
-cd cmake-build
-cmake ..
-cmake --build . --config Release -j
-sudo cmake --build . --target install
-
-git clone https://github.com/stephb9959/cppkafka
-cd cppkafka
-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-ucentralfms
-cd wlan-cloud-ucentralfms
-mkdir cmake-build
-cd cmake-build
-cmake ..
-make -j
-```
-
-### After completing the build
-After completing the build, you can remove the Poco source as it is no longer needed.
 
 #### Expected directory layout
-From the directory where your cloned source is, you will need to create the `certs`, `logs`, and `data`.
+From the directory where your cloned source is, you will need to create the `certs`, `logs`, and `uploads` directories.
-```shell
+```bash
 mkdir certs
+mkdir certs/cas
 mkdir logs
-mkdir data
+mkdir uploads
+```
+You should now have the following:
+```text
+--+-- certs
+  |   +--- cas
+  +-- cmake
+  +-- cmake-build
+  +-- logs
+  +-- src
+  +-- test_scripts
+  +-- openapi
+  +-- uploads
+  +-- owsec.properties
 ```
 
-### Certificates
+### Certificate
-Love'em of hate'em, we gotta use'em. So we tried to make this as easy as possible for you.
+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.
 
-```asm
+```text
-certs ---+--- 
+certs ---+--- restapi-ca.pem
-         +--- restapi-ca.pem
          +--- restapi-cert.pem
          +--- restapi-key.pem
 ```
 
-### Configuration
+## Firewall Considerations
-The configuration is kep in the file `owfms.properties`. This is a text file read by the service at startup time.
+| Port  | Description                                   | Configurable |
+|:------|:----------------------------------------------|:------------:|
+| 16003 | Default port for REST API Access to the OWFMS |     yes      |
 
-#### Basic configuration
+### Environment variables
-You must set the environment variables:
+The following environment variables should be set from the root directory of the service. They tell the OWGW process where to find
-- OWFMS_ROOT: represents where the root of the installation is for this service.
+the configuration and the root directory.
-- OWFMS_CONFIG: represents the path where the configuration is kept.
+```bash
-
+export OWGW_ROOT=`pwd`
-#### The file section
+export OWGW_CONFIG=`pwd`
-#### RESTAPI
-```json
-openwifi.restapi.host.0.backlog = 100
-openwifi.restapi.host.0.security = relaxed
-openwifi.restapi.host.0.rootca = $OWFMS_ROOT/certs/restapi-ca.pem
-openwifi.restapi.host.0.address = *
-openwifi.restapi.host.0.port = 16004
-openwifi.restapi.host.0.cert = $OWFMS_ROOT/certs/restapi-cert.pem
-openwifi.restapi.host.0.key = $OWFMS_ROOT/certs/restapi-key.pem
-openwifi.restapi.host.0.key.password = mypassword
 ```
-Of importance are the `.port` which should point to the port used.
+You can run the shell script `set_env.sh` from the microservice root.
 
-#### Internal microservice interface
+### OWFMS Service Configuration
-```json
+The configuration is kept in a file called `owfms.properties`. To understand the content of this file,
-openwifi.internal.restapi.host.0.backlog = 100
+please look [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralfms/blob/main/CONFIGURATION.md)
-openwifi.internal.restapi.host.0.security = relaxed
-openwifi.internal.restapi.host.0.rootca = $OWFMS_ROOT/certs/restapi-ca.pem
-openwifi.internal.restapi.host.0.address = *
-openwifi.internal.restapi.host.0.port = 17004
-openwifi.internal.restapi.host.0.cert = $OWFMS_ROOT/certs/restapi-cert.pem
-openwifi.internal.restapi.host.0.key = $OWFMS_ROOT/certs/restapi-key.pem
-openwifi.internal.restapi.host.0.key.password = mypassword
-```
-You can leave all the default values for this one. 
 
-#### System values
+## Kafka topics
-In the following values, you need to change `.uri.public` and `uri.ui`. The `.uri.public` must point to an externally available FQDN to access the service. The `.uri.ui` must point to web server running 
+Toe read more about Kafka, follow the [document](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/main/KAFKA.md)
-the UI for the service. `firmwaredb.refresh` tells the service how often to refresh the firmware database in seconds. `firmwaredb.maxage` tells the service how old you
-want to accept release for. This value is in days.
 
-```json
+## Contributions
-openwifi.service.key = $OWFMS_ROOT/certs/restapi-key.pem
+We need more contributors. Should you wish to contribute,
-openwifi.service.key.password = mypassword
+please follow the [contributions](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/master/CONTRIBUTING.md) document.
-openwifi.system.data = $OWFMS_ROOT/data
-openwifi.system.debug = false
-openwifi.system.uri.private = https://localhost:17004
-openwifi.system.uri.public = https://ucentral.dpaas.arilia.com:16004
-openwifi.system.commandchannel = /tmp/app.owfms
-openwifi.system.uri.ui = ucentral-ui.arilia.com
-firmwaredb.refresh = 1800
-firmwaredb.maxage = 90
-```
 
-#### S3 configuration
+## Pull Requests
-The service mua read the information about firmware from an Amazon S3 Bucket. You need to replace `s3.secret` and `s3.key` with your own. 
+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.
 
-```json
+## Additional OWSDK Microservices
-s3.bucketname = ucentral-ap-firmware
+Here is a list of additional OWSDK microservices
-s3.region = us-east-1
+| Name | Description | Link | OpenAPI |
-s3.secret = *******************************************
+| :--- | :--- | :---: | :---: |
-s3.key =  *******************************************
+| OWSEC | Security Service | [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralsec) | [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralsec/blob/main/openpapi/owsec.yaml) |
-s3.retry = 60
+| OWGW | Controller Service | [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw) | [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/master/openapi/owgw.yaml) |
-s3.bucket.uri = ucentral-ap-firmware.s3.amazonaws.com
+| 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) |
 
-```

build

@@ -1 +1 @@
-24
+1

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 "$OWFMS_CONFIG"/owfms.properties ]]; then
+if [[ "$TEMPLATE_CONFIG" = 'true' ]]; then
   RESTAPI_HOST_ROOTCA=${RESTAPI_HOST_ROOTCA:-"\$OWFMS_ROOT/certs/restapi-ca.pem"} \
   RESTAPI_HOST_PORT=${RESTAPI_HOST_PORT:-"16004"} \
   RESTAPI_HOST_CERT=${RESTAPI_HOST_CERT:-"\$OWFMS_ROOT/certs/restapi-cert.pem"} \
@@ -22,6 +22,12 @@ if [[ "$TEMPLATE_CONFIG" = 'true' && ! -f "$OWFMS_CONFIG"/owfms.properties ]]; t
   SYSTEM_URI_PRIVATE=${SYSTEM_URI_PRIVATE:-"https://localhost:17004"} \
   SYSTEM_URI_PUBLIC=${SYSTEM_URI_PUBLIC:-"https://localhost:16004"} \
   SYSTEM_URI_UI=${SYSTEM_URI_UI:-"http://localhost"} \
+  SECURITY_RESTAPI_DISABLE=${SECURITY_RESTAPI_DISABLE:-"false"} \
+  FIRMWAREDB_REFRESH=${FIRMWAREDB_REFRESH:-"86400"} \
+  FIRMWAREDB_MAXAGE=${FIRMWAREDB_MAXAGE:-"90"} \
+  S3_VIRTUAL_ADRESSING=${S3_VIRTUAL_ADRESSING:-"true"} \
+  S3_HTTPS=${S3_HTTPS:-"true"} \
+  S3_ENDPOINT=${S3_ENDPOINT:-""} \
   S3_BUCKETNAME=${S3_BUCKETNAME:-"ucentral-ap-firmware"} \
   S3_REGION=${S3_REGION:-"us-east-1"} \
   S3_SECRET=${S3_SECRET:-"*******************************************"} \
@@ -29,6 +35,10 @@ if [[ "$TEMPLATE_CONFIG" = 'true' && ! -f "$OWFMS_CONFIG"/owfms.properties ]]; t
   S3_BUCKET_URI=${S3_BUCKET_URI:-"ucentral-ap-firmware.s3.amazonaws.com"} \
   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:-"owfms"} \
@@ -47,7 +57,7 @@ if [ "$1" = '/openwifi/owfms' -a "$(id -u)" = '0' ]; then
     if [ "$RUN_CHOWN" = 'true' ]; then
       chown -R "$OWFMS_USER": "$OWFMS_ROOT" "$OWFMS_CONFIG"
     fi
-    exec su-exec "$OWFMS_USER" "$@"
+    exec gosu "$OWFMS_USER" "$@"
 fi
 
 exec "$@"

helm/.gitignore

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

helm/Chart.yaml

@@ -5,14 +5,14 @@ name: owfms
 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,7 +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 Firmware | |
 | configProperties | hash | Configuration properties that should be passed to the application in `owfms.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 Firmware (PEM format is adviced to be used) (see `volumes.owfms` 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.owfms` 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 "owfms.chart" -}}
 {{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}}
 {{- end -}}
+
+{{- define "owfms.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
@@ -13,6 +14,7 @@ spec:
   replicas: {{ .Values.replicaCount }}
   strategy:
     type: {{ .Values.strategyType }}
+  revisionHistoryLimit: {{ .Values.revisionHistoryLimit }}
   selector:
     matchLabels:
       app.kubernetes.io/name: {{ include "owfms.name" . }}
@@ -35,6 +37,49 @@ spec:
         {{- end }}
     spec:
 
+      initContainers:
+        - name: wait-kafka
+          image: "{{ .Values.images.dockerize.repository }}:{{ .Values.images.dockerize.tag }}"
+          imagePullPolicy: {{ .Values.images.dockerize.pullPolicy }}
+          args:
+            - -wait
+            - tcp://{{ index .Values.configProperties "openwifi.kafka.brokerlist" }}
+            - -timeout
+            - 600s
+
+{{- if eq $storageType "postgresql" }}
+        - name: wait-postgres
+          image: "{{ .Values.images.owfms.repository }}:{{ .Values.images.owfms.tag }}"
+          imagePullPolicy: {{ .Values.images.owfms.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 "owfms.fullname" $root }}-env
+                  key: {{ $key }}
+          {{- end }}
+          volumeMounts:
+          {{- range .Values.volumes.owfms }}
+          - name: {{ .name }}
+            mountPath: {{ .mountPath }}
+            {{- if .subPath }}
+            subPath: {{ .subPath }}
+            {{- end }}
+          {{- end }}
+{{- end }}
+
       containers:
 
         - name: owfms
@@ -86,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 "owfms.ingress.apiVersion" $root }}
 kind: Ingress
 metadata:
   name: {{ include "owfms.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 "owfms.fullname" $root }}-{{ .serviceName }}
+              port:
+              {{- if kindIs "string" .servicePort }}
+                name: {{ .servicePort }}
+              {{- else }}
+                number: {{ .servicePort }}
+              {{- end }}
+            {{- else }}
             serviceName: {{ include "owfms.fullname" $root }}-{{ .serviceName }}
             servicePort: {{ .servicePort }}
+            {{- end }}
       {{- end }}
   {{- end }}
 

helm/values.yaml

@@ -1,6 +1,7 @@
 # System
 replicaCount: 1
 strategyType: Recreate
+revisionHistoryLimit: 2
 
 nameOverride: ""
 fullnameOverride: ""
@@ -14,10 +15,14 @@ images:
 #      registry: tip-tip-wlan-cloud-ucentral.jfrog.io
 #      username: username
 #      password: password
+  dockerize:
+    repository: tip-tip-wlan-cloud-ucentral.jfrog.io/dockerize
+    tag: 0.16.0
+    pullPolicy: IfNotPresent
 
 services:
   owfms:
-    type: LoadBalancer
+    type: ClusterIP
     ports:
       restapi:
         servicePort: 16004
@@ -38,8 +43,6 @@ checks:
       exec:
         command:
           - /readiness_check
-      failureThreshold: 1
-
 
 ingresses:
   restapi:
@@ -51,6 +54,7 @@ ingresses:
     - restapi.chart-example.local
     paths:
     - path: /
+      pathType: ImplementationSpecific
       serviceName: owfms
       servicePort: restapi
 
@@ -67,7 +71,7 @@ volumes:
       mountPath: /owfms-data/certs
       volumeDefinition: |
         secret:
-          secretName: {{ include "owfms.fullname" . }}-certs
+          secretName: {{ if .Values.existingCertsSecret }}{{ .Values.existingCertsSecret }}{{ else }}{{ include "owfms.fullname" . }}-certs{{ end }}
     # Change this if you want to use another volume type
     - name: persist
       mountPath: /owfms-data/persist
@@ -87,6 +91,9 @@ resources: {}
   #  cpu: 100m
   #  memory: 128Mi
 
+securityContext:
+  fsGroup: 1000
+
 nodeSelector: {}
 
 tolerations: []
@@ -136,11 +143,14 @@ configProperties:
   openwifi.internal.restapi.host.0.cert: $OWFMS_ROOT/certs/restapi-cert.pem
   openwifi.internal.restapi.host.0.key: $OWFMS_ROOT/certs/restapi-key.pem
   # Firmware Microservice Specific Section
+  s3.endpointOverride: ""
+  s3.useVirtualAdressing: true
+  s3.endpoint.https: true
   s3.bucketname: ucentral-ap-firmware
   s3.region: us-east-1
   s3.retry: 60
   s3.bucket.uri: ucentral-ap-firmware.s3.amazonaws.com
-  firmwaredb.refresh: 1800
+  firmwaredb.refresh: 86400
   # ALB
   alb.enable: "true"
   alb.port: 16104
@@ -151,6 +161,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
@@ -180,22 +194,9 @@ configProperties:
   openwifi.system.uri.ui: https://localhost
   openwifi.system.commandchannel: /tmp/app_owfms
   # Logging
-  logging.formatters.f1.class: PatternFormatter
+  logging.type: console
-  logging.formatters.f1.pattern: "%Y-%m-%d %H:%M:%S %s: [%p] %t"
+  logging.path: $OWFMS_ROOT/logs
-  logging.formatters.f1.times: UTC
+  logging.level: debug
-  logging.channels.c1.class: ConsoleChannel
-  logging.channels.c1.formatter: f1
-  logging.channels.c2.class: FileChannel
-  logging.channels.c2.path: /tmp/log_owfms
-  logging.channels.c2.formatter.class: PatternFormatter
-  logging.channels.c2.formatter.pattern: "%Y-%m-%d %H:%M:%S %s: [%p] %t"
-  logging.channels.c2.rotation: "20 M"
-  logging.channels.c2.archive: timestamp
-  logging.channels.c2.purgeCount: 20
-  logging.channels.c3.class: ConsoleChannel
-  logging.channels.c3.pattern: "%s: [%p] %t"
-  logging.loggers.root.channel: c1
-  logging.loggers.root.level: debug
 
   # -> Secret part
   # REST API
@@ -212,6 +213,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/owfms.yaml

@@ -2,7 +2,7 @@ openapi: 3.0.1
 info:
   title: uCentral Firmware Service API
   description: A process to manage new uCentral firmware distribution.
-  version: 2.0.0
+  version: 2.5.0
   license:
     name: BSD3
     url: https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/master/LICENSE
@@ -30,53 +30,13 @@ components:
 
   responses:
     NotFound:
-      description: The specified resource was not found.
+      $ref: 'https://github.com/Telecominfraproject/wlan-cloud-ucentralsec/blob/main/openpapi/owsec.yaml#/components/responses/NotFound'
-      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.
+      $ref: 'https://github.com/Telecominfraproject/wlan-cloud-ucentralsec/blob/main/openpapi/owsec.yaml#/components/responses/Unauthorized'
-      content:
-        application/json:
-          schema:
-            properties:
-              ErrorCode:
-                type: integer
-                enum:
-                  - 0     # Success
-                  - 1     # PASSWORD_CHANGE_REQUIRED,
-                  - 2     # INVALID_CREDENTIALS,
-                  - 3     # PASSWORD_ALREADY_USED,
-                  - 4     # USERNAME_PENDING_VERIFICATION,
-                  - 5     # PASSWORD_INVALID,
-                  - 6     # INTERNAL_ERROR,
-                  - 7     # ACCESS_DENIED,
-                  - 8     # INVALID_TOKEN
-              ErrorDetails:
-                type: string
-              ErrorDescription:
-                type: string
-
     Success:
-      description: The requested operation was performed.
+      $ref: 'https://github.com/Telecominfraproject/wlan-cloud-ucentralsec/blob/main/openpapi/owsec.yaml#/components/responses/Success'
-      content:
+    BadRequest:
-        application/json:
+      $ref: 'https://github.com/Telecominfraproject/wlan-cloud-ucentralsec/blob/main/openpapi/owsec.yaml#/components/responses/BadRequest'
-          schema:
-            properties:
-              Operation:
-                type: string
-              Details:
-                type: string
-              Code:
-                type: integer
 
   schemas:
     FirmwareDetails:
@@ -135,6 +95,25 @@ components:
           items:
             $ref: '#/components/schemas/FirmwareDetails'
 
+    DeviceCurrentInfo:
+      type: object
+      properties:
+        serialNumber:
+          type: string
+        revision:
+          type: string
+        upgraded:
+          type: integer
+          format: int64
+
+    DeviceCurrentInfoList:
+      type: object
+      properties:
+        devices:
+          type: array
+          items:
+            $ref: '#/components/schemas/DeviceCurrentInfo'
+
     RevisionHistoryEntry:
       type: object
       properties:
@@ -252,6 +231,37 @@ components:
         totalSecondsOld:
           $ref: '#/components/schemas/TagIntPairList'
 
+    DeviceInformation:
+      type: object
+      properties:
+        serialNumber:
+          type: string
+        history:
+          $ref: '#/components/schemas/RevisionHistoryEntryList'
+        currentFirmware:
+          type: string
+        currentFirmwareDate:
+          type: integer
+          format: int64
+        latestFirmware:
+          type: string
+        latestFirmwareDate:
+          type: integer
+          format: int64
+        latestFirmwareAvailable:
+          type: boolean
+
+    ExtraSystemConfiguration:
+      type: array
+      items:
+        type: object
+        properties:
+          parameterName:
+            type: string
+          parameterValue:
+            type: string
+
+
     #########################################################################################
     ##
     ## These are endpoints that all services in the uCentral stack must provide
@@ -343,6 +353,33 @@ components:
                 type: integer
                 format: int64
 
+    SystemResources:
+      type: object
+      properties:
+        numberOfFileDescriptors:
+          type: integer
+          format: int64
+        currRealMem:
+          type: integer
+          format: int64
+        peakRealMem:
+          type: integer
+          format: int64
+        currVirtMem:
+          type: integer
+          format: int64
+        peakVirtMem:
+          type: integer
+          format: int64
+
+    SystemCommandResults:
+      type: object
+      oneOf:
+        - $ref: '#/components/schemas/SystemResources'
+        - $ref: '#/components/schemas/SystemInfoResults'
+        - $ref: '#/components/schemas/StringList'
+        - $ref: '#/components/schemas/TagValuePairList'
+
     SystemCommandSetLogLevel:
       type: object
       properties:
@@ -450,9 +487,10 @@ paths:
           required: false
         - in: query
           name: latestOnly
-          description: Return only the latest firwares
+          description: Return only the latest firmware
           schema:
             type: boolean
+            default: false
           required: false
         - in: query
           name: deviceType
@@ -463,19 +501,61 @@ paths:
           name: revisionSet
           schema:
             type: boolean
+            default: false
           required: false
         - in: query
           name: deviceSet
           schema:
             type: boolean
           required: false
+        - in: query
+          name: rcOnly
+          schema:
+            type: boolean
+            default: false
+          required: false
+        - in: query
+          name: updateTimeOnly
+          schema:
+            type: boolean
+          required: false
       responses:
         200:
           description: List firmwares
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/FirmwareDetailsList'
+                oneOf:
+                  - type: object
+                    properties:
+                      lastUpdateTime:
+                        type: integer
+                        format: int64
+                  - $ref: '#/components/schemas/FirmwareDetailsList'
+                  - $ref: '#/components/schemas/FirmwareDetails'
+        403:
+          $ref: '#/components/responses/Unauthorized'
+        404:
+          $ref: '#/components/responses/NotFound'
+
+    put:
+      tags:
+        - Firmware
+      summary: Force a DB refresh.
+      description: Force a DB refresh.
+      operationId: updateFirmwareList
+      parameters:
+        - in: query
+          description: Force the firmware DB update
+          name: update
+          schema:
+            type: boolean
+          required: false
+      responses:
+        200:
+          $ref: '#/components/responses/Success'
+        400:
+          $ref: '#/components/responses/BadRequest'
         403:
           $ref: '#/components/responses/Unauthorized'
         404:
@@ -622,13 +702,31 @@ paths:
           schema:
             type: string
           required: false
+        - in: query
+          description: Return current device list and current firmware
+          name: currentList
+          schema:
+            type: boolean
+            default: false
+          required: false
+          example: You must set {serialNumber} to 000000000000
+        - in: query
+          description: Return current device list and current firmware
+          name: unknownList
+          schema:
+            type: boolean
+            default: false
+          required: false
+          example: You must set {serialNumber} to 000000000000
       responses:
         200:
           description: List of device history upgrade.
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/RevisionHistoryEntryList'
+                oneOf:
+                  - $ref: '#/components/schemas/RevisionHistoryEntryList'
+                  - $ref: '#/components/schemas/DeviceCurrentInfoList'
         403:
           $ref: '#/components/responses/Unauthorized'
         404:
@@ -672,19 +770,19 @@ paths:
       operationId: getFirmwareAge
       parameters:
         - in: query
-          description: The exact current verion of the firmware on that device.
+          description: The exact current version of the firmware on that device.
           name: revision
           schema:
             type: string
           required: true
         - in: query
-          description: The exact current verion of the firmware on that device.
+          description: The exact current version of the firmware on that device.
           name: deviceType
           schema:
             type: string
           required: true
         - in: query
-          description: Specify lits of serial  numbers to retrive age for
+          description: Specify list of serial  numbers to retrieve age for
           name: select
           schema:
             type: string
@@ -783,6 +881,28 @@ paths:
         404:
           $ref: '#/components/responses/NotFound'
 
+  /deviceInformation/{serialNumber}:
+    get:
+      tags:
+        - Device Information
+      summary: receive a repor on a single decide
+      parameters:
+        - in: path
+          name: serialNumber
+          schema:
+            type: string
+            example:
+              aabbccdd1234
+          required: true
+      responses:
+        200:
+          $ref: '#/components/schemas/DeviceInformation'
+        403:
+          $ref: '#/components/responses/Unauthorized'
+        404:
+          $ref: '#/components/responses/NotFound'
+
+
   #########################################################################################
   ##
   ## These are endpoints that all services in the uCentral stack must provide
@@ -832,16 +952,75 @@ paths:
             type: string
             enum:
               - info
+              - extraConfiguration
+              - resources
           required: true
-
       responses:
         200:
-          description: Successfull command execution
+          $ref: '#/components/schemas/SystemCommandResults'
-          content:
+        403:
-            application/json:
+          $ref: '#/components/responses/Unauthorized'
-              schema:
+        404:
-                oneOf:
+          $ref: '#/components/responses/NotFound'
-                  - $ref: '#/components/schemas/SystemInfoResults'
+
+  /systemConfiguration:
+    get:
+      tags:
+        - SystemConfiguration
+      summary: Retrieve system configuration items
+      operationId: getSystemConfiguration
+      parameters:
+        - in: query
+          description: Which parameters you want to retrieve
+          name: entries
+          schema:
+            type: string
+            example:
+              - element1
+              - element1,element2,element3
+          required: false
+      responses:
+        200:
+          description: List of configuration elements
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/ExtraSystemConfiguration'
+        403:
+          $ref: '#/components/responses/Unauthorized'
+        404:
+          $ref: '#/components/responses/NotFound'
+
+    put:
+      tags:
+        - SystemConfiguration
+      summary: Set some or all system configuration
+      operationId: setSystemConfiguration
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/ExtraSystemConfiguration'
+
+      responses:
+        200:
+          $ref: '#/components/schemas/ExtraSystemConfiguration'
+        403:
+          $ref: '#/components/responses/Unauthorized'
+        404:
+          $ref: '#/components/responses/NotFound'
+
+    delete:
+      tags:
+        - SystemConfiguration
+      summary: Delete all additional system configuration
+      operationId: deleteSystemConfiguration
+
+      responses:
+        200:
+          $ref: '#/components/responses/Success'
         403:
           $ref: '#/components/responses/Unauthorized'
         404:

overlays/curl/portfile.cmake

@@ -0,0 +1 @@
+set(VCPKG_POLICY_EMPTY_PACKAGE enabled)

overlays/curl/vcpkg.json

@@ -0,0 +1,4 @@
+{
+    "name": "curl",
+    "version-string": "7.74.0-1.3+deb11u3"
+}

overlays/openssl/portfile.cmake

@@ -0,0 +1 @@
+set(VCPKG_POLICY_EMPTY_PACKAGE enabled)

overlays/openssl/vcpkg.json

@@ -0,0 +1,4 @@
+{
+    "name": "openssl",
+    "version-string": "1.1.1n-0+deb11u3"
+}

overlays/zlib/portfile.cmake

@@ -0,0 +1 @@
+set(VCPKG_POLICY_EMPTY_PACKAGE enabled)

overlays/zlib/vcpkg.json

@@ -0,0 +1,4 @@
+{
+    "name": "zlib",
+    "version-string": "1:1.2.11.dfsg-2+deb11u2"
+}

owfms.properties

@@ -35,12 +35,16 @@ openwifi.system.uri.private = https://localhost:17004
 openwifi.system.uri.public = https://ucentral.dpaas.arilia.com:16004
 openwifi.system.commandchannel = /tmp/app.owfms
 openwifi.system.uri.ui = ucentral-ui.arilia.com
+openwifi.security.restapi.disable = false
+
 firmwaredb.refresh = 1800
 firmwaredb.maxage = 90
 
 #
 # Firmware Microservice Specific Section
 #
+s3.useVirtualAdressing = true
+s3.endpoint.https = true
 s3.bucketname = ucentral-ap-firmware
 s3.region = us-east-1
 s3.secret = *******************************************
@@ -68,6 +72,10 @@ 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 =
 
 #
 # This section select which form of persistence you need
@@ -108,37 +116,9 @@ storage.type.mysql.connectiontimeout = 60
 # Logging: please leave as is for now.
 #
 ########################################################################
-logging.formatters.f1.class = PatternFormatter
+logging.type = file
-logging.formatters.f1.pattern = %s: [%p] %t
+logging.path = $OWFMS_ROOT/logs
-logging.formatters.f1.times = UTC
+logging.level = debug
-logging.channels.c1.class = ConsoleChannel
-logging.channels.c1.formatter = f1
-
-# This is where the logs will be written. This path MUST exist
-logging.channels.c2.class = FileChannel
-logging.channels.c2.path = $OWFMS_ROOT/logs/log
-logging.channels.c2.formatter.class = PatternFormatter
-logging.channels.c2.formatter.pattern = %Y-%m-%d %H:%M:%S %s: [%p] %t
-logging.channels.c2.rotation = 20 M
-logging.channels.c2.archive = timestamp
-logging.channels.c2.purgeCount = 20
-logging.channels.c3.class = ConsoleChannel
-logging.channels.c3.pattern = %s: [%p] %t
-
-# External Channel
-logging.loggers.root.channel = c2
-logging.loggers.root.level = debug
-
-# Inline Channel with PatternFormatter
-# logging.loggers.l1.name = logger1
-# logging.loggers.l1.channel.class = ConsoleChannel
-# logging.loggers.l1.channel.pattern = %s: [%p] %t
-# logging.loggers.l1.level = information
-# SplitterChannel
-# logging.channels.splitter.class = SplitterChannel
-# logging.channels.splitter.channels = l1,l2
-# logging.loggers.l2.name = logger2
-# logging.loggers.l2.channel = splitter
 
 
 

owfms.properties.tmpl

@@ -36,12 +36,17 @@ 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}
-firmwaredb.refresh = 1800
+openwifi.security.restapi.disable = ${SECURITY_RESTAPI_DISABLE}
-firmwaredb.maxage = 90
+
+firmwaredb.refresh = ${FIRMWAREDB_REFRESH}
+firmwaredb.maxage = ${FIRMWAREDB_MAXAGE}
 
 #
 # Firmware Microservice Specific Section
 #
+s3.useVirtualAdressing = ${S3_VIRTUAL_ADRESSING}
+s3.endpointOverride = ${S3_ENDPOINT}
+s3.endpoint.https = ${S3_HTTPS}
 s3.bucketname = ${S3_BUCKETNAME}
 s3.region = ${S3_REGION}
 s3.secret = ${S3_SECRET}
@@ -67,6 +72,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
@@ -104,37 +113,6 @@ storage.type.mysql.connectiontimeout = 60
 # Logging: please leave as is for now.
 #
 ########################################################################
-logging.formatters.f1.class = PatternFormatter
+logging.type = console
-logging.formatters.f1.pattern = %Y-%m-%d %H:%M:%S %s: [%p] %t
+logging.path = $OWFMS_ROOT/logs
-logging.formatters.f1.times = UTC
+logging.level = debug
-logging.channels.c1.class = ConsoleChannel
-logging.channels.c1.formatter = f1
-
-# This is where the logs will be written. This path MUST exist
-logging.channels.c2.class = FileChannel
-logging.channels.c2.path = $OWFMS_ROOT/logs/log
-logging.channels.c2.formatter.class = PatternFormatter
-logging.channels.c2.formatter.pattern = %Y-%m-%d %H:%M:%S %s: [%p] %t
-logging.channels.c2.rotation = 20 M
-logging.channels.c2.archive = timestamp
-logging.channels.c2.purgeCount = 20
-logging.channels.c3.class = ConsoleChannel
-logging.channels.c3.pattern = %s: [%p] %t
-
-# External Channel
-logging.loggers.root.channel = c1
-logging.loggers.root.level = debug
-
-# Inline Channel with PatternFormatter
-# logging.loggers.l1.name = logger1
-# logging.loggers.l1.channel.class = ConsoleChannel
-# logging.loggers.l1.channel.pattern = %s: [%p] %t
-# logging.loggers.l1.level = information
-# SplitterChannel
-# logging.channels.splitter.class = SplitterChannel
-# logging.channels.splitter.channels = l1,l2
-# logging.loggers.l2.name = logger2
-# logging.loggers.l2.channel = splitter
-
-
-

readiness_check

@@ -13,29 +13,29 @@ then
   exit 1
 fi
 
-if [[ "${OWSEC}" == "" ]]
-then
-  echo "You must set the variable OWSEC in order to use this script. Something like"
-  echo "OWSEC=security.isp.com:16001"
-  exit 1
-fi
-
-if [[ "${OWSEC_USERNAME}" == "" ]]
-then
-  echo "You must set the variable OWSEC_USERNAME in order to use this script. Something like"
-  echo "OWSEC_USERNAME=tip@ucentral.com"
-  exit 1
-fi
-
-if [[ "${OWSEC_PASSWORD}" == "" ]]
-then
-  echo "You must set the variable OWSEC_PASSWORD in order to use this script. Something like"
-  echo "OWSEC_PASSWORD=openwifi"
-  exit 1
-fi
-
 if [[ "${READINESS_METHOD}" == "systeminfo" ]]
 then
+  if [[ "${OWSEC}" == "" ]]
+  then
+    echo "You must set the variable OWSEC in order to use this script. Something like"
+    echo "OWSEC=security.isp.com:16001"
+    exit 1
+  fi
+
+  if [[ "${OWSEC_USERNAME}" == "" ]]
+  then
+    echo "You must set the variable OWSEC_USERNAME in order to use this script. Something like"
+    echo "OWSEC_USERNAME=tip@ucentral.com"
+    exit 1
+  fi
+
+  if [[ "${OWSEC_PASSWORD}" == "" ]]
+  then
+    echo "You must set the variable OWSEC_PASSWORD in order to use this script. Something like"
+    echo "OWSEC_PASSWORD=openwifi"
+    exit 1
+  fi
+
   # Get OAuth token from OWSEC and cache it or use cached one
   payload="{ \"userId\" : \"$OWSEC_USERNAME\" , \"password\" : \"$OWSEC_PASSWORD\" }"
   if [[ -f "/tmp/token" ]]

src/APIServers.cpp

@@ -1,41 +0,0 @@
-//
-// Created by stephane bourque on 2021-10-23.
-//
-
-#include "framework/MicroService.h"
-
-#include "RESTAPI/RESTAPI_firmwareHandler.h"
-#include "RESTAPI/RESTAPI_firmwaresHandler.h"
-#include "RESTAPI/RESTAPI_firmwareAgeHandler.h"
-#include "RESTAPI/RESTAPI_connectedDeviceHandler.h"
-#include "RESTAPI/RESTAPI_connectedDevicesHandler.h"
-#include "RESTAPI/RESTAPI_historyHandler.h"
-#include "RESTAPI/RESTAPI_deviceReportHandler.h"
-
-namespace OpenWifi {
-
-    Poco::Net::HTTPRequestHandler * RESTAPI_external_server(const char *Path, RESTAPIHandler::BindingMap &Bindings,
-                                                            Poco::Logger & L, RESTAPI_GenericServer & S) {
-        return  RESTAPI_Router<
-            RESTAPI_firmwaresHandler,
-            RESTAPI_firmwareHandler,
-            RESTAPI_system_command,
-            RESTAPI_firmwareAgeHandler,
-            RESTAPI_connectedDevicesHandler,
-            RESTAPI_connectedDeviceHandler,
-            RESTAPI_historyHandler,
-            RESTAPI_deviceReportHandler
-            >(Path,Bindings,L, S);
-    }
-
-    Poco::Net::HTTPRequestHandler * RESTAPI_internal_server(const char *Path, RESTAPIHandler::BindingMap &Bindings,
-                                                            Poco::Logger & L, RESTAPI_GenericServer & S) {
-        return RESTAPI_Router_I<
-            RESTAPI_firmwaresHandler,
-            RESTAPI_firmwareHandler,
-            RESTAPI_system_command,
-            RESTAPI_connectedDevicesHandler,
-            RESTAPI_connectedDeviceHandler
-            >(Path, Bindings, L, S);
-    }
-}

src/AutoUpdater.cpp

@@ -3,102 +3,127 @@
 //
 
 #include "AutoUpdater.h"
-#include "SDK/Prov_SDK.h"
-#include "SDK/GW_SDK.h"
 #include "LatestFirmwareCache.h"
+#include "SDK/GW_SDK.h"
+#include "SDK/Prov_SDK.h"
 #include "StorageService.h"
 
+#include "framework/MicroServiceFuncs.h"
+#include "framework/utils.h"
+
+#include "fmt/format.h"
+
 namespace OpenWifi {
 
-    int AutoUpdater::Start() {
+	int AutoUpdater::Start() {
-        Running_ = true;
+		poco_information(Logger(), "Starting...");
-        AutoUpdaterFrequency_ = MicroService::instance().ConfigGetInt("autoupdater.frequency",600);
+		AutoUpdaterEnabled_ = MicroServiceConfigGetBool("autoupdater.enabled", false);
-        AutoUpdaterEnabled_ = MicroService::instance().ConfigGetBool("autoupdater.enabled", false);
+		if (AutoUpdaterEnabled_) {
-        if(AutoUpdaterEnabled_)
+			Running_ = false;
-            Thr_.start(*this);
+			AutoUpdaterFrequency_ = MicroServiceConfigGetInt("autoupdater.frequency", 600);
-        return 0;
+			AutoUpdaterCallBack_ =
-    }
+				std::make_unique<Poco::TimerCallback<AutoUpdater>>(*this, &AutoUpdater::onTimer);
+			Timer_.setStartInterval(5 * 60 * 1000); // first run in 5 minutes
+			Timer_.setPeriodicInterval(AutoUpdaterFrequency_ * 1000);
+			Timer_.start(*AutoUpdaterCallBack_);
+		}
+		return 0;
+	}
 
-    void AutoUpdater::Stop() {
+	void AutoUpdater::Stop() {
-        Running_ = false;
+		poco_information(Logger(), "Stopping...");
-        if(AutoUpdaterEnabled_) {
+		Running_ = false;
-            Thr_.wakeUp();
+		if (AutoUpdaterEnabled_) {
-            Thr_.join();
+			Timer_.stop();
-        }
+		}
-    }
+		poco_information(Logger(), "Stopped...");
+	}
 
-    void AutoUpdater::ToBeUpgraded(std::string serialNumber, std::string DeviceType) {
+	void AutoUpdater::ToBeUpgraded(std::string serialNumber, std::string DeviceType) {
-        if(!AutoUpdaterEnabled_)
+		if (!AutoUpdaterEnabled_)
-            return;
+			return;
-        std::lock_guard G(Mutex_);
+		std::lock_guard G(Mutex_);
-        Queue_.emplace_back(std::make_pair(std::move(serialNumber),std::move(DeviceType)));
+		Queue_.emplace_back(std::make_pair(std::move(serialNumber), std::move(DeviceType)));
-    }
+	}
 
-    void AutoUpdater::run() {
+	void AutoUpdater::onTimer([[maybe_unused]] Poco::Timer &timer) {
-        while(Running_) {
+		Utils::SetThreadName("auto-updater");
-            Poco::Thread::trySleep(2000);
+		Running_ = true;
-            if(!Running_)
+		std::unique_lock L(Mutex_);
-                break;
+		while (!Queue_.empty() && Running_) {
-            std::unique_lock    L(Mutex_);
+			auto Entry = Queue_.front();
-            while(!Queue_.empty() && Running_) {
+			Queue_.pop_front();
-                auto Entry = Queue_.front();
+			try {
-                Queue_.pop_front();
+				poco_debug(Logger(), fmt::format("Preparing to upgrade {}", Entry.first));
-                try {
+				auto CacheEntry = Cache_.find(Entry.first);
-                    Logger_.debug(Poco::format("Preparing to upgrade %s",Entry.first));
+				uint64_t now = Utils::Now();
-                    auto CacheEntry = Cache_.find(Entry.first);
+				std::string firmwareUpgrade;
-                    uint64_t Now = std::time(nullptr);
+				if (CacheEntry == Cache_.end() || (CacheEntry->second.LastCheck - now) > 300) {
-                    std::string firmwareUpgrade;
+					//  get the firmware settings for that device.
-                    bool        firmwareRCOnly;
+					SerialCache C;
-                    if(CacheEntry == Cache_.end() || (CacheEntry->second.LastCheck-Now)>300) {
+					C.LastCheck = now;
-                        //  get the firmware settings for that device.
+					bool firmwareRCOnly;
-                        SerialCache     C;
+					if (OpenWifi::SDK::Prov::GetFirmwareOptions(Entry.first, firmwareUpgrade,
-                        C.LastCheck = Now;
+																firmwareRCOnly)) {
-                        if(OpenWifi::SDK::Prov::GetFirmwareOptions(Entry.first, firmwareUpgrade, firmwareRCOnly)) {
+						poco_debug(Logger(),
-                            Logger_.debug(Poco::format("Found firmware options for %s",Entry.first));
+								   fmt::format("Found firmware options for {}", Entry.first));
-                            C.firmwareRCOnly = firmwareRCOnly;
+						C.firmwareRCOnly = firmwareRCOnly;
-                            C.firmwareUpgrade = firmwareUpgrade;
+						C.firmwareUpgrade = firmwareUpgrade;
-                        } else {
+					} else {
-                            Logger_.debug(Poco::format("Found no firmware options for %s",Entry.first));
+						poco_debug(Logger(),
-                            C.firmwareRCOnly = firmwareRCOnly;
+								   fmt::format("Found no firmware options for {}", Entry.first));
-                            C.firmwareUpgrade = firmwareUpgrade;
+						C.firmwareRCOnly = firmwareRCOnly;
-                        }
+						C.firmwareUpgrade = firmwareUpgrade;
-                        Cache_[Entry.first] = C;
+					}
-                    } else {
+					Cache_[Entry.first] = C;
+				} else {
+				}
 
-                    }
+				if (firmwareUpgrade == "no") {
+					poco_information(
+						Logger(),
+						fmt::format("Device {} not upgradable. Provisioning service settings.",
+									Entry.first));
+					continue;
+				}
 
-                    if(firmwareUpgrade=="no") {
+				LatestFirmwareCacheEntry fwEntry;
-                        Logger_.information(Poco::format("Device %s not upgradable. Provisioning service settings.",Entry.first));
+				FMSObjects::Firmware fwDetails;
-                        continue;
+				auto LF = LatestFirmwareCache()->FindLatestFirmware(Entry.second, fwEntry);
-                    }
+				if (LF) {
+					if (StorageService()->FirmwaresDB().GetFirmware(fwEntry.Id, fwDetails)) {
+						//  send the command to upgrade this device...
+						poco_information(Logger(), fmt::format("Upgrading {} to version {}",
+															   Entry.first, fwEntry.Revision));
+						if (OpenWifi::SDK::GW::SendFirmwareUpgradeCommand(Entry.first,
+																		  fwDetails.uri)) {
+							poco_information(
+								Logger(), fmt::format("Upgrade command sent for {}", Entry.first));
+						} else {
+							poco_information(
+								Logger(),
+								fmt::format("Upgrade command not sent for {}", Entry.first));
+						}
+					} else {
+						poco_information(Logger(),
+										 fmt::format("Firmware for device {} ({}) cannot be found.",
+													 Entry.first, Entry.second));
+					}
+				} else {
+					poco_information(Logger(),
+									 fmt::format("Firmware for device {} ({}) cannot be found.",
+												 Entry.first, Entry.second));
+				}
+			} catch (...) {
+				poco_information(
+					Logger(),
+					fmt::format("Exception during auto update for device {}.", Entry.first));
+			}
+		}
+	}
 
-                    LatestFirmwareCacheEntry    fwEntry;
+	void AutoUpdater::reinitialize([[maybe_unused]] Poco::Util::Application &self) {
-                    FMSObjects::Firmware        fwDetails;
+		poco_information(Logger(), "Reinitializing.");
-                    auto LF = LatestFirmwareCache()->FindLatestFirmware(Entry.second, fwEntry );
+		Reset();
-                    if(LF) {
+	}
-                        if(StorageService()->GetFirmware(fwEntry.Id,fwDetails)) {
+} // namespace OpenWifi
-                            //  send the command to upgrade this device...
-                            Logger_.information(Poco::format("Upgrading %s to version %s", Entry.first, fwEntry.Revision));
-                            if(OpenWifi::SDK::GW::SendFirmwareUpgradeCommand(Entry.first,fwDetails.uri)) {
-                                Logger_.information(Poco::format("Upgrade command sent for %s",Entry.first));
-                            } else {
-                                Logger_.information(Poco::format("Upgrade command not sent for %s",Entry.first));
-                            }
-                        } else {
-                            Logger_.information(Poco::format("Firmware for device %s (%s) cannot be found.", Entry.first, Entry.second ));
-                        }
-                    } else {
-                        Logger_.information(Poco::format("Firmware for device %s (%s) cannot be found.", Entry.first, Entry.second ));
-                    }
-                } catch (...) {
-                    Logger_.information(Poco::format("Exception during auto update for device %s.", Entry.first ));
-                }
-            }
-        }
-    }
-
-    void AutoUpdater::reinitialize(Poco::Util::Application &self) {
-        Logger_.information("Reinitializing.");
-        Reset();
-    }
-}

src/AutoUpdater.h

@@ -2,53 +2,52 @@
 // Created by stephane bourque on 2021-10-04.
 //
 
-#ifndef OWFMS_AUTOUPDATER_H
+#pragma once
-#define OWFMS_AUTOUPDATER_H
 
-#include "framework/MicroService.h"
 #include <deque>
+
+#include "Poco/Timer.h"
 #include "Poco/Util/Application.h"
+#include "framework/SubSystemServer.h"
 
 namespace OpenWifi {
-class AutoUpdater : public SubSystemServer, Poco::Runnable {
-    public:
 
-    struct SerialCache {
+	class AutoUpdater : public SubSystemServer { // };, Poco::Runnable {
-            uint64_t        LastCheck=0;
+	  public:
-            std::string     firmwareUpgrade;
+		struct SerialCache {
-            bool            firmwareRCOnly=false;
+			uint64_t LastCheck = 0;
-        };
+			std::string firmwareUpgrade;
+			bool firmwareRCOnly = false;
+		};
 
-        static AutoUpdater *instance() {
+		static auto instance() {
-            static AutoUpdater *instance_ = new AutoUpdater;
+			static auto instance_ = new AutoUpdater;
-            return instance_;
+			return instance_;
-        }
+		}
 
-        int Start() override;
+		int Start() override;
-        void Stop() override;
+		void Stop() override;
-        void run() final;
+		void ToBeUpgraded(std::string serialNumber, std::string DeviceType);
-        void ToBeUpgraded(std::string serialNumber, std::string DeviceType);
+		inline void Reset() {
-        inline void Reset() {
+			std::lock_guard G(Mutex_);
-            std::lock_guard   G(Mutex_);
+			Cache_.clear();
-            Cache_.clear();
+			Queue_.clear();
-            Queue_.clear();
+		}
-        }
+		void reinitialize(Poco::Util::Application &self) final;
-        void reinitialize(Poco::Util::Application &self) final;
+		void onTimer(Poco::Timer &timer);
 
-    private:
+	  private:
-        std::atomic_bool                                Running_=false;
+		std::atomic_bool Running_ = false;
-        Poco::Thread                                    Thr_;
+		std::map<std::string, SerialCache> Cache_;
-        std::map<std::string,SerialCache>               Cache_;
+		std::deque<std::pair<std::string, std::string>> Queue_;
-        std::deque<std::pair<std::string,std::string>>  Queue_;
+		uint64_t AutoUpdaterFrequency_ = 600;
-        uint64_t                            AutoUpdaterFrequency_=600;
+		bool AutoUpdaterEnabled_ = true;
-        bool                                AutoUpdaterEnabled_=true;
+		Poco::Timer Timer_;
-        explicit AutoUpdater() noexcept:
+		std::unique_ptr<Poco::TimerCallback<AutoUpdater>> AutoUpdaterCallBack_;
-        SubSystemServer("AutoUpdater", "AUTO-UPDATER", "autoupdater")
-            {
-            }
-    };
 
-    inline AutoUpdater * AutoUpdater() { return AutoUpdater::instance(); }
+		explicit AutoUpdater() noexcept
-}
+			: SubSystemServer("AutoUpdater", "AUTO-UPDATER", "autoupdater") {}
+	};
 
-#endif //OWFMS_AUTOUPDATER_H
+	inline auto AutoUpdater() { return AutoUpdater::instance(); }
+} // namespace OpenWifi

src/Daemon.cpp

@@ -3,68 +3,62 @@
 //
 
 #include <aws/core/Aws.h>
-#include <aws/s3/model/CreateBucketRequest.h>
-#include <aws/s3/model/PutObjectRequest.h>
 #include <aws/s3/model/AccessControlPolicy.h>
-#include <aws/s3/model/PutBucketAclRequest.h>
+#include <aws/s3/model/CreateBucketRequest.h>
 #include <aws/s3/model/GetBucketAclRequest.h>
+#include <aws/s3/model/PutBucketAclRequest.h>
+#include <aws/s3/model/PutObjectRequest.h>
 
+#include "AutoUpdater.h"
 #include "Daemon.h"
-#include "StorageService.h"
-#include "ManifestCreator.h"
-#include "NewConnectionHandler.h"
-#include "LatestFirmwareCache.h"
 #include "DeviceCache.h"
 #include "FirmwareCache.h"
-#include "AutoUpdater.h"
+#include "LatestFirmwareCache.h"
+#include "ManifestCreator.h"
+#include "NewCommandHandler.h"
+#include "NewConnectionHandler.h"
+#include "StorageService.h"
+
+#include "framework/UI_WebSocketClientServer.h"
 
 namespace OpenWifi {
-    class Daemon *Daemon::instance_ = nullptr;
+	class Daemon *Daemon::instance_ = nullptr;
 
-    class Daemon *Daemon::instance() {
+	class Daemon *Daemon::instance() {
-        if (instance_ == nullptr) {
+		if (instance_ == nullptr) {
-            instance_ = new Daemon(vDAEMON_PROPERTIES_FILENAME,
+			instance_ = new Daemon(
-                                   vDAEMON_ROOT_ENV_VAR,
+				vDAEMON_PROPERTIES_FILENAME, vDAEMON_ROOT_ENV_VAR, vDAEMON_CONFIG_ENV_VAR,
-                                   vDAEMON_CONFIG_ENV_VAR,
+				vDAEMON_APP_NAME, vDAEMON_BUS_TIMER,
-                                   vDAEMON_APP_NAME,
+				SubSystemVec{StorageService(), FirmwareCache(), LatestFirmwareCache(),
-                                   vDAEMON_BUS_TIMER,
+							 DeviceCache(), NewConnectionHandler(), ManifestCreator(),
-                                   SubSystemVec{
+							 AutoUpdater(), NewCommandHandler(), UI_WebSocketClientServer()});
-                                            StorageService(),
+		}
-                                            FirmwareCache(),
+		return instance_;
-                                            LatestFirmwareCache(),
+	}
-                                            DeviceCache(),
-                                            NewConnectionHandler(),
-                                            ManifestCreator(),
-                                            AutoUpdater()
-                                   });
-        }
-        return instance_;
-    }
 
-    void Daemon::initialize(Poco::Util::Application &self) {
+	void Daemon::PostInitialization([[maybe_unused]] Poco::Util::Application &self) {}
-        MicroService::initialize(*this);
-    }
 
-    void MicroServicePostInitialization() {
+	void DaemonPostInitialization(Poco::Util::Application &self) {
+		Daemon()->PostInitialization(self);
+	}
 
-    }
+} // namespace OpenWifi
-}
 
 int main(int argc, char **argv) {
-    SSL_library_init();
+	SSL_library_init();
-    Aws::SDKOptions AwsOptions;
+	Aws::SDKOptions AwsOptions;
-    AwsOptions.memoryManagementOptions.memoryManager = nullptr;
+	AwsOptions.memoryManagementOptions.memoryManager = nullptr;
-    AwsOptions.cryptoOptions.initAndCleanupOpenSSL = false;
+	AwsOptions.cryptoOptions.initAndCleanupOpenSSL = false;
-    AwsOptions.httpOptions.initAndCleanupCurl = true;
+	AwsOptions.httpOptions.initAndCleanupCurl = true;
 
-    Aws::InitAPI(AwsOptions);
+	Aws::InitAPI(AwsOptions);
 
-    int ExitCode=0;
+	int ExitCode = 0;
-    {
+	{
-        auto App = OpenWifi::Daemon::instance();
+		auto App = OpenWifi::Daemon::instance();
-        ExitCode = App->run(argc, argv);
+		ExitCode = App->run(argc, argv);
-    }
+	}
 
-    ShutdownAPI(AwsOptions);
+	ShutdownAPI(AwsOptions);
-    return ExitCode;
+	return ExitCode;
 }

src/Daemon.h

@@ -6,40 +6,37 @@
 #define UCENTRALFWS_DAEMON_H
 
 #include "framework/MicroService.h"
+#include "framework/MicroServiceNames.h"
 #include "framework/OpenWifiTypes.h"
-#include "RESTObjects/RESTAPI_FMSObjects.h"
+
 #include "Dashboard.h"
+#include "RESTObjects/RESTAPI_FMSObjects.h"
 
 namespace OpenWifi {
 
-    static const char * vDAEMON_PROPERTIES_FILENAME = "owfms.properties";
+	[[maybe_unused]] static const char *vDAEMON_PROPERTIES_FILENAME = "owfms.properties";
-    static const char * vDAEMON_ROOT_ENV_VAR = "OWFMS_ROOT";
+	[[maybe_unused]] static const char *vDAEMON_ROOT_ENV_VAR = "OWFMS_ROOT";
-    static const char * vDAEMON_CONFIG_ENV_VAR = "OWFMS_CONFIG";
+	[[maybe_unused]] static const char *vDAEMON_CONFIG_ENV_VAR = "OWFMS_CONFIG";
-    static const char * vDAEMON_APP_NAME = uSERVICE_FIRMWARE.c_str();
+	[[maybe_unused]] static const char *vDAEMON_APP_NAME = uSERVICE_FIRMWARE.c_str();
-    static const uint64_t vDAEMON_BUS_TIMER = 10000;
+	[[maybe_unused]] static const uint64_t vDAEMON_BUS_TIMER = 10000;
 
-    class Daemon : public MicroService {
+	class Daemon : public MicroService {
-    public:
+	  public:
-        explicit Daemon(const std::string & PropFile,
+		explicit Daemon(const std::string &PropFile, const std::string &RootEnv,
-                        const std::string & RootEnv,
+						const std::string &ConfigEnv, const std::string &AppName, uint64_t BusTimer,
-                        const std::string & ConfigEnv,
+						const SubSystemVec &SubSystems)
-                        const std::string & AppName,
+			: MicroService(PropFile, RootEnv, ConfigEnv, AppName, BusTimer, SubSystems){};
-                        uint64_t 	BusTimer,
-                        const SubSystemVec & SubSystems) :
-                MicroService( PropFile, RootEnv, ConfigEnv, AppName, BusTimer, SubSystems) {};
 
-        void initialize(Poco::Util::Application &self);
+		void PostInitialization(Poco::Util::Application &self);
-        static Daemon *instance();
+		static Daemon *instance();
-        inline void ResetDashboard() { DB_.Reset(); }
+		inline DeviceDashboard &GetDashboard() { return DB_; }
-        inline void CreateDashboard() { DB_.Create(); }
-        inline const FMSObjects::DeviceReport & GetDashboard() { return DB_.Report(); }
 
-    private:
+	  private:
-        static Daemon 				*instance_;
+		static Daemon *instance_;
-        DeviceDashboard             DB_;
+		DeviceDashboard DB_;
-    };
+	};
 
-    inline Daemon * Daemon() { return Daemon::instance(); }
+	inline Daemon *Daemon() { return Daemon::instance(); }
-}
+} // namespace OpenWifi
 
-#endif //UCENTRALFWS_DAEMON_H
+#endif // UCENTRALFWS_DAEMON_H

src/Dashboard.cpp

@@ -4,15 +4,47 @@
 
 #include "Dashboard.h"
 #include "StorageService.h"
+#include "framework/utils.h"
 
 namespace OpenWifi {
-	void DeviceDashboard::Create() {
-		uint64_t Now = std::time(nullptr);
 
-		if(LastRun_==0 || (Now-LastRun_)>120) {
+	bool DeviceDashboard::Get(FMSObjects::DeviceReport &D, Poco::Logger &Logger) {
-			DB_.reset();
+		uint64_t Now = Utils::Now();
-			StorageService()->GenerateDeviceReport(DB_);
+		if (!ValidDashboard_ || LastRun_ == 0 || (Now - LastRun_) > 120) {
-			LastRun_ = Now;
+			Generate(D, Logger);
+		} else {
+			std::lock_guard G(DataMutex_);
+			D = DB_;
+		}
+		return ValidDashboard_;
+	};
+
+	void DeviceDashboard::Generate(FMSObjects::DeviceReport &D, Poco::Logger &Logger) {
+		if (GeneratingDashboard_.load()) {
+			// std::cout << "Trying to generate dashboard but already being generated" << std::endl;
+			while (GeneratingDashboard_.load()) {
+				Poco::Thread::trySleep(100);
+			}
+			std::lock_guard G(DataMutex_);
+			D = DB_;
+		} else {
+			GeneratingDashboard_ = true;
+			ValidDashboard_ = false;
+			try {
+				// std::cout << "Generating dashboard." << std::endl;
+				poco_information(Logger, "DASHBOARD: Generating a new dashboard.");
+				FMSObjects::DeviceReport NewData;
+				StorageService()->DevicesDB().GenerateDeviceReport(NewData);
+				LastRun_ = Utils::Now();
+				NewData.snapshot = LastRun_;
+				D = NewData;
+				std::lock_guard G(DataMutex_);
+				DB_ = NewData;
+				ValidDashboard_ = true;
+			} catch (...) {
+			}
+			GeneratingDashboard_ = false;
 		}
 	}
-}
+
+} // namespace OpenWifi

src/Dashboard.h

@@ -2,22 +2,26 @@
 // Created by stephane bourque on 2021-07-21.
 //
 
-#ifndef UCENTRALGW_DASHBOARD_H
+#pragma once
-#define UCENTRALGW_DASHBOARD_H
 
-#include "framework/OpenWifiTypes.h"
+#include <mutex>
+
+#include "Poco/Logger.h"
 #include "RESTObjects/RESTAPI_FMSObjects.h"
+#include "framework/OpenWifiTypes.h"
 
 namespace OpenWifi {
 	class DeviceDashboard {
 	  public:
-			void Create();
+		bool Get(FMSObjects::DeviceReport &D, Poco::Logger &Logger);
-			const FMSObjects::DeviceReport & Report() const { return DB_;}
-			inline void Reset() { LastRun_=0; DB_.reset(); }
-	  private:
-            FMSObjects::DeviceReport  	DB_;
-			uint64_t 				LastRun_=0;
-	};
-}
 
-#endif // UCENTRALGW_DASHBOARD_H
+	  private:
+		std::mutex DataMutex_;
+		volatile std::atomic_bool GeneratingDashboard_ = false;
+		volatile bool ValidDashboard_ = false;
+		FMSObjects::DeviceReport DB_;
+		uint64_t LastRun_ = 0;
+
+		void Generate(FMSObjects::DeviceReport &D, Poco::Logger &Logger);
+	};
+} // namespace OpenWifi

src/DeviceCache.cpp

@@ -6,42 +6,39 @@
 
 namespace OpenWifi {
 
-    int DeviceCache::Start() {
+	int DeviceCache::Start() {
-        return 0;
+		poco_information(Logger(), "Starting...");
-    }
+		return 0;
+	}
 
-    void DeviceCache::Stop() {
+	void DeviceCache::Stop() {
-    }
+		poco_information(Logger(), "Stopping...");
+		poco_information(Logger(), "Stopped...");
+	}
 
-    void DeviceCache::AddToCache(
+	void DeviceCache::AddToCache(const std::string &SerialNumber, const std::string &DeviceType,
-                        const std::string &SerialNumber, const std::string & DeviceType,
+								 const std::string &Host, const std::string &Revision) {
-                        const std::string &Host, const std::string &Revision) {
+		std::lock_guard G(Mutex_);
-        std::lock_guard G(Mutex_);
+		auto Device = DeviceCache_.find(SerialNumber);
-        auto Device = DeviceCache_.find(SerialNumber);
 
-        if(Device==DeviceCache_.end()) {
+		if (Device == DeviceCache_.end()) {
-            DeviceCache_[SerialNumber]=DeviceCacheEntry{
+			DeviceCache_[SerialNumber] =
-                                                .deviceType=DeviceType,
+				DeviceCacheEntry{.deviceType = DeviceType, .host = Host, .revision = Revision};
-                                                .host=Host,
+		} else {
-                                                .revision=Revision};
+			Device->second.revision = Revision;
-        } else {
+			Device->second.host = Host;
-            Device->second.revision=Revision;
+			Device->second.deviceType = DeviceType;
-            Device->second.host=Host;
+		}
-            Device->second.deviceType=DeviceType;
+	}
-        }
-    }
 
-    bool DeviceCache::GetDevice(const std::string &SerialNumber, DeviceCacheEntry & E) {
+	bool DeviceCache::GetDevice(const std::string &SerialNumber, DeviceCacheEntry &E) {
-        std::lock_guard G(Mutex_);
+		std::lock_guard G(Mutex_);
-        auto Device = DeviceCache_.find(SerialNumber);
+		auto Device = DeviceCache_.find(SerialNumber);
-        if(Device==DeviceCache_.end())
+		if (Device == DeviceCache_.end())
-            return false;
+			return false;
-        E=Device->second;
+		E = Device->second;
-        return true;
+		return true;
-    }
+	}
 
-
+	void DeviceCache::DumpCache() {}
-    void DeviceCache::DumpCache() {
+} // namespace OpenWifi
-
-    }
-}

src/DeviceCache.h

@@ -2,47 +2,40 @@
 // Created by stephane bourque on 2021-07-13.
 //
 
-#ifndef UCENTRALFMS_DEVICECACHE_H
+#pragma once
-#define UCENTRALFMS_DEVICECACHE_H
 
+#include "framework/SubSystemServer.h"
 #include <string>
-#include "framework/MicroService.h"
 
 namespace OpenWifi {
 
-    struct DeviceCacheEntry {
+	struct DeviceCacheEntry {
-        std::string     deviceType;
+		std::string deviceType;
-        std::string     host;
+		std::string host;
-        std::string     revision;
+		std::string revision;
-    };
+	};
-    typedef std::map<std::string, DeviceCacheEntry> DeviceCacheMap;
+	typedef std::map<std::string, DeviceCacheEntry> DeviceCacheMap;
 
-    class DeviceCache : public SubSystemServer {
+	class DeviceCache : public SubSystemServer {
-    public:
+	  public:
-        static DeviceCache *instance() {
+		static auto instance() {
-            static DeviceCache *instance_ = new DeviceCache;
+			static auto instance_ = new DeviceCache;
-            return instance_;
+			return instance_;
-        }
+		}
 
-        int Start() override;
+		int Start() override;
-        void Stop() override;
+		void Stop() override;
-        void AddToCache(const std::string &serialNumber, const std::string & DeviceType,
+		void AddToCache(const std::string &serialNumber, const std::string &DeviceType,
-                        const std::string &Host, const std::string &Revision);
+						const std::string &Host, const std::string &Revision);
-        void DumpCache();
+		void DumpCache();
-        bool GetDevice(const std::string &SerialNumber, DeviceCacheEntry & E);
+		bool GetDevice(const std::string &SerialNumber, DeviceCacheEntry &E);
 
-    private:
+	  private:
-        std::atomic_bool    Running_=false;
+		std::atomic_bool Running_ = false;
-        DeviceCacheMap      DeviceCache_;
+		DeviceCacheMap DeviceCache_;
-        explicit DeviceCache() noexcept:
+		explicit DeviceCache() noexcept
-                SubSystemServer("DeviceCache", "DEVICE-CACHE", "devicecache")
+			: SubSystemServer("DeviceCache", "DEVICE-CACHE", "devicecache") {}
-        {
+	};
-        }
-    };
 
-    inline DeviceCache * DeviceCache() { return DeviceCache::instance(); }
+	inline auto DeviceCache() { return DeviceCache::instance(); }
-}
+} // namespace OpenWifi
-
-
-
-#endif //UCENTRALFMS_DEVICECACHE_H

src/FirmwareCache.cpp

@@ -6,20 +6,25 @@
 
 namespace OpenWifi {
 
-    int FirmwareCache::Start() {
+	int FirmwareCache::Start() {
-        return 0;
+		poco_information(Logger(), "Starting...");
-    }
+		return 0;
+	}
 
-    void FirmwareCache::Stop() {
+	void FirmwareCache::Stop() {
+		poco_information(Logger(), "Stopping...");
+		poco_information(Logger(), "Stopped...");
+	}
 
-    }
+	std::shared_ptr<FMSObjects::Firmware>
+	GetFirmware([[maybe_unused]] const std::string &DeviceType,
+				[[maybe_unused]] const std::string &Revision) {
+		return nullptr;
+	}
 
-    std::shared_ptr<FMSObjects::Firmware> GetFirmware(const std::string & DeviceType, const std::string & Revision) {
+	std::shared_ptr<FMSObjects::Firmware>
-        return nullptr;
+	AddFirmware([[maybe_unused]] const FMSObjects::Firmware &F) {
-    }
+		return nullptr;
+	}
 
-    std::shared_ptr<FMSObjects::Firmware> AddFirmware(const FMSObjects::Firmware &F) {
+} // namespace OpenWifi
-        return nullptr;
-    }
-
-}

src/FirmwareCache.h

@@ -2,45 +2,39 @@
 // Created by stephane bourque on 2021-07-26.
 //
 
-#ifndef UCENTRALFMS_FIRMWARECACHE_H
+#pragma once
-#define UCENTRALFMS_FIRMWARECACHE_H
 
 #include <map>
 #include <memory>
 
 #include "RESTObjects/RESTAPI_FMSObjects.h"
-#include "framework/MicroService.h"
+#include "framework/SubSystemServer.h"
 
 namespace OpenWifi {
 
-    typedef std::map<std::string,std::shared_ptr<FMSObjects::Firmware>> FirmwareCacheMap;
+	typedef std::map<std::string, std::shared_ptr<FMSObjects::Firmware>> FirmwareCacheMap;
 
-    class FirmwareCache: public SubSystemServer {
+	class FirmwareCache : public SubSystemServer {
-    public:
+	  public:
-        static FirmwareCache *instance() {
+		static auto instance() {
-            static FirmwareCache *instance_= new FirmwareCache;
+			static auto instance_ = new FirmwareCache;
-            return instance_;
+			return instance_;
-        }
+		}
 
-        int Start() override;
+		int Start() override;
-        void Stop() override;
+		void Stop() override;
 
-        std::shared_ptr<FMSObjects::Firmware> GetFirmware(const std::string & DeviceType, const std::string & Revision);
+		std::shared_ptr<FMSObjects::Firmware> GetFirmware(const std::string &DeviceType,
-        std::shared_ptr<FMSObjects::Firmware> AddFirmware(const FMSObjects::Firmware &F);
+														  const std::string &Revision);
+		std::shared_ptr<FMSObjects::Firmware> AddFirmware(const FMSObjects::Firmware &F);
 
+	  private:
+		std::atomic_bool Running_ = false;
+		FirmwareCacheMap Cache_;
+		explicit FirmwareCache() noexcept
+			: SubSystemServer("FirmwareCache", "FIRMWARE-CACHE", "firmwarecache") {}
+	};
 
-    private:
+	inline auto FirmwareCache() { return FirmwareCache::instance(); }
-        std::atomic_bool        Running_=false;
-        FirmwareCacheMap        Cache_;
-        explicit FirmwareCache() noexcept:
-                SubSystemServer("FirmwareCache", "FIRMWARE-CACHE", "firmwarecache")
-        {
-        }
-    };
 
-    inline FirmwareCache * FirmwareCache() { return FirmwareCache::instance(); }
+} // namespace OpenWifi
-
-}
-
-
-#endif //UCENTRALFMS_FIRMWARECACHE_H

src/LatestFirmwareCache.cpp

@@ -7,58 +7,91 @@
 
 namespace OpenWifi {
 
-    int LatestFirmwareCache::Start() {
+	int LatestFirmwareCache::Start() {
-        StorageService()->PopulateLatestFirmwareCache();
+		poco_information(Logger(), "Starting...");
-        return 0;
+		StorageService()->FirmwaresDB().PopulateLatestFirmwareCache();
-    }
+		return 0;
+	}
 
-    void LatestFirmwareCache::Stop() {
+	void LatestFirmwareCache::Stop() {
-    }
+		poco_information(Logger(), "Stopping...");
+		poco_information(Logger(), "Stopped...");
+	}
 
-    bool LatestFirmwareCache::AddToCache(const std::string & DeviceType, const std::string &Revision, const std::string &Id, uint64_t TimeStamp) {
+	bool LatestFirmwareCache::AddToCache(const std::string &DeviceType, const std::string &Revision,
-        std::lock_guard G(Mutex_);
+										 const std::string &Id, uint64_t TimeStamp) {
+		std::lock_guard G(Mutex_);
 
-        RevisionSet_.insert(Revision);
+		RevisionSet_.insert(Revision);
-        DeviceSet_.insert(DeviceType);
+		DeviceSet_.insert(DeviceType);
-        auto E = Cache_.find(DeviceType);
-        if((E==Cache_.end()) || (TimeStamp >= E->second.TimeStamp)) {
-            Cache_[DeviceType] = LatestFirmwareCacheEntry{  .Id=Id,
-                                                            .TimeStamp=TimeStamp,
-                                                            .Revision=Revision};
-            return true;
-        }
-        return false;
-    }
 
-    bool LatestFirmwareCache::FindLatestFirmware(const std::string &DeviceType, LatestFirmwareCacheEntry &Entry )  {
+		auto E = Cache_.find(DeviceType);
-        std::lock_guard G(Mutex_);
+		if ((E == Cache_.end()) || (TimeStamp >= E->second.TimeStamp)) {
+			Cache_[DeviceType] =
+				LatestFirmwareCacheEntry{.Id = Id, .TimeStamp = TimeStamp, .Revision = Revision};
+		}
 
-        auto E=Cache_.find(DeviceType);
+		if (!IsRC(Revision))
-        if(E!=Cache_.end()) {
+			return true;
-            Entry = E->second;
-            return true;
-        }
 
-        return false;
+		auto rcE = rcCache_.find(DeviceType);
-    }
+		if ((rcE == rcCache_.end()) || (TimeStamp >= rcE->second.TimeStamp)) {
+			rcCache_[DeviceType] =
+				LatestFirmwareCacheEntry{.Id = Id, .TimeStamp = TimeStamp, .Revision = Revision};
+		}
+		return true;
+	}
 
-    bool LatestFirmwareCache::IsLatest(const std::string &DeviceType, const std::string &Revision) {
+	bool LatestFirmwareCache::FindLatestFirmware(const std::string &DeviceType,
-        std::lock_guard G(Mutex_);
+												 LatestFirmwareCacheEntry &Entry) {
+		std::lock_guard G(Mutex_);
 
-        auto E=Cache_.find(DeviceType);
+		auto E = Cache_.find(DeviceType);
-        if(E!=Cache_.end()) {
+		if (E != Cache_.end()) {
-            return E->second.Revision==Revision;
+			Entry = E->second;
-        }
+			return true;
-        return false;
+		}
-    }
+		return false;
+	}
 
+	bool LatestFirmwareCache::FindLatestRCOnlyFirmware(const std::string &DeviceType,
+													   LatestFirmwareCacheEntry &Entry) {
+		std::lock_guard G(Mutex_);
 
-    void LatestFirmwareCache::DumpCache() {
+		auto E = rcCache_.find(DeviceType);
-        std::lock_guard G(Mutex_);
+		if (E != rcCache_.end()) {
+			Entry = E->second;
+			return true;
+		}
+		return false;
+	}
 
-        for( auto &[Id,E]:Cache_) {
+	bool LatestFirmwareCache::IsLatest(const std::string &DeviceType, const std::string &Revision) {
-            std::cout << "Device: " << Id << "    ID:" << E.Id << std::endl;
+		std::lock_guard G(Mutex_);
-        }
 
-    }
+		auto E = Cache_.find(DeviceType);
-}
+		if (E != Cache_.end()) {
+			return E->second.Revision == Revision;
+		}
+		return false;
+	}
+
+	bool LatestFirmwareCache::IsLatestRCOnly(const std::string &DeviceType,
+											 const std::string &Revision) {
+		std::lock_guard G(Mutex_);
+
+		auto E = rcCache_.find(DeviceType);
+		if (E != rcCache_.end()) {
+			return E->second.Revision == Revision;
+		}
+		return false;
+	}
+
+	void LatestFirmwareCache::DumpCache() {
+		std::lock_guard G(Mutex_);
+
+		for (auto &[Id, E] : Cache_) {
+			std::cout << "Device: " << Id << "    ID:" << E.Id << std::endl;
+		}
+	}
+} // namespace OpenWifi

src/LatestFirmwareCache.h

@@ -2,55 +2,73 @@
 // Created by stephane bourque on 2021-07-13.
 //
 
-#ifndef UCENTRALFMS_LATESTFIRMWARECACHE_H
+#pragma once
-#define UCENTRALFMS_LATESTFIRMWARECACHE_H
 
 #include "Poco/JSON/Object.h"
+#include "Poco/JWT/Signer.h"
 #include "Poco/Net/HTTPServerRequest.h"
 #include "Poco/Net/HTTPServerResponse.h"
-#include "Poco/JWT/Signer.h"
 #include "Poco/SHA2Engine.h"
+#include "Poco/StringTokenizer.h"
+
 #include "RESTObjects/RESTAPI_SecurityObjects.h"
-#include "framework/MicroService.h"
+#include "framework/SubSystemServer.h"
 
 namespace OpenWifi {
 
-    struct LatestFirmwareCacheEntry {
+	struct LatestFirmwareCacheEntry {
-        std::string     Id;
+		std::string Id;
-        uint64_t        TimeStamp=0;
+		uint64_t TimeStamp = 0;
-        std::string     Revision;
+		std::string Revision;
-    };
+	};
-    typedef std::map<std::string, LatestFirmwareCacheEntry> LatestFirmwareCacheMap;
+	typedef std::map<std::string, LatestFirmwareCacheEntry> LatestFirmwareCacheMap;
+	typedef std::map<std::string, LatestFirmwareCacheEntry> rcOnlyLatestFirmwareCacheMap;
 
-    class LatestFirmwareCache : public SubSystemServer {
+	class LatestFirmwareCache : public SubSystemServer {
-    public:
+	  public:
-        static LatestFirmwareCache *instance() {
+		static auto instance() {
-            static LatestFirmwareCache *instance_ = new LatestFirmwareCache;
+			static auto instance_ = new LatestFirmwareCache;
-            return instance_;
+			return instance_;
-        }
+		}
 
-        int Start() override;
+		int Start() override;
-        void Stop() override;
+		void Stop() override;
-        bool AddToCache(const std::string & DeviceType, const std::string & Revision, const std::string &Id, uint64_t TimeStamp);
+		bool AddToCache(const std::string &DeviceType, const std::string &Revision,
-        // void AddRevision(const std::string &Revision);
+						const std::string &Id, uint64_t TimeStamp);
-        bool FindLatestFirmware(const std::string &DeviceType, LatestFirmwareCacheEntry &Entry );
+		// void AddRevision(const std::string &Revision);
-        void DumpCache();
+		bool FindLatestFirmware(const std::string &DeviceType, LatestFirmwareCacheEntry &Entry);
-        inline Types::StringSet GetRevisions() { std::lock_guard G(Mutex_); return RevisionSet_; };
+		bool FindLatestRCOnlyFirmware(const std::string &DeviceType,
-        inline Types::StringSet GetDevices() { std::lock_guard G(Mutex_); return DeviceSet_; };
+									  LatestFirmwareCacheEntry &Entry);
-        bool IsLatest(const std::string &DeviceType, const std::string &Revision);
 
-    private:
+		inline static bool IsRC(const std::string &Revision) {
-        LatestFirmwareCacheMap      Cache_;
+			// OpenWrt 21.02-SNAPSHOT r16399+120-c67509efd7 / TIP-v2.5.0-36b5478
-        Types::StringSet            RevisionSet_;
+			auto Tokens = Poco::StringTokenizer(Revision, "/", Poco::StringTokenizer::TOK_TRIM);
-        Types::StringSet            DeviceSet_;
+			if (Tokens.count() != 2)
-        explicit LatestFirmwareCache() noexcept:
+				return false;
-                SubSystemServer("FirmwareCache", "FIRMWARE-CACHE", "FirmwareCache")
+			return (Tokens[1].substr(0, 5) == "TIP-v");
-        {
+		}
-        }
-    };
 
-    inline LatestFirmwareCache * LatestFirmwareCache() { return LatestFirmwareCache::instance(); }
+		void DumpCache();
-}
+		inline Types::StringSet GetRevisions() {
+			std::lock_guard G(Mutex_);
+			return RevisionSet_;
+		};
+		inline Types::StringSet GetDevices() {
+			std::lock_guard G(Mutex_);
+			return DeviceSet_;
+		};
+		bool IsLatest(const std::string &DeviceType, const std::string &Revision);
+		bool IsLatestRCOnly(const std::string &DeviceType, const std::string &Revision);
 
+	  private:
+		LatestFirmwareCacheMap Cache_;
+		rcOnlyLatestFirmwareCacheMap rcCache_;
+		Types::StringSet RevisionSet_;
+		Types::StringSet DeviceSet_;
+		explicit LatestFirmwareCache() noexcept
+			: SubSystemServer("LatestFirmwareCache", "LATEST-FIRMWARE-CACHE",
+							  "LatestFirmwareCache") {}
+	};
 
-#endif //UCENTRALFMS_LATESTFIRMWARECACHE_H
+	inline auto LatestFirmwareCache() { return LatestFirmwareCache::instance(); }
+} // namespace OpenWifi

src/ManifestCreator.cpp

@@ -6,309 +6,355 @@
 #include "Poco/JSON/Parser.h"
 #include "Poco/JSON/Stringifier.h"
 
+#include <aws/s3/model/GetObjectRequest.h>
 #include <aws/s3/model/ListObjectsRequest.h>
 #include <aws/s3/model/ListObjectsV2Request.h>
-#include <aws/s3/model/GetObjectRequest.h>
 
+#include "LatestFirmwareCache.h"
 #include "ManifestCreator.h"
 #include "StorageService.h"
-#include "LatestFirmwareCache.h"
+
+#include "fmt/format.h"
+#include "framework/utils.h"
 
 namespace OpenWifi {
 
-    void ManifestCreator::run() {
+	void ManifestCreator::onTimer([[maybe_unused]] Poco::Timer &timer) {
-        Running_ = true;
+		Utils::SetThreadName("manifest");
-        bool FirstRun = true;
+		RunUpdateTask();
+	}
 
-        while(Running_) {
+	bool ManifestCreator::RunUpdateTask() {
-            Poco::Thread::trySleep(FirstRun ? 10000 : DBRefresh_*1000);
+		if (!UpdateRunning_.test_and_set(std::memory_order_acquire)) {
-            if(!Running_)
+			poco_information(Logger(), "Performing DB refresh");
-                break;
+			RunnerThread_.start(*this);
-            FirstRun = false;
+			return true;
-            Logger_.information("Performing DB refresh");
+		} else {
-            S3BucketContent BucketList;
+			poco_information(Logger(), "DB refresh already in progress");
-            StorageService()->RemoveOldFirmware();
+			return false;
-            ReadBucket(BucketList);
+		}
-            if(!Running_)
+	}
-                break;
-            Logger_.information(Poco::format("Found %Lu firmware entries in S3 repository.",(uint64_t)BucketList.size()));
-            ComputeManifest(BucketList);
-            AddManifestToDB(BucketList);
-        }
-    }
 
-    bool ManifestCreator::ComputeManifest(S3BucketContent &BucketContent) {
+	void ManifestCreator::run() {
+		S3BucketContent BucketList;
+		StorageService()->FirmwaresDB().RemoveOldFirmware();
+		ReadBucket(BucketList);
+		poco_information(Logger(), fmt::format("Found {} firmware entries in S3 repository.",
+											   BucketList.size()));
+		ComputeManifest(BucketList);
+		AddManifestToDB(BucketList);
+		LastUpdate_ = Utils::Now();
+		UpdateRunning_.clear(std::memory_order_release);
+	}
 
-        uint64_t Limit = std::time(nullptr) - MaxAge_, Rejected=0, Accepted=0, BadFormat=0, MissingJson=0;
+	bool ManifestCreator::ComputeManifest(S3BucketContent &BucketContent) {
-        for(auto &[Name,Entry]:BucketContent) {
-            std::string C = Entry.S3ContentManifest;
 
-            try {
+		uint64_t Limit = Utils::Now() - MaxAge_, Rejected = 0, Accepted = 0, BadFormat = 0,
-                Poco::JSON::Parser  P;
+				 MissingJson = 0;
-                auto ParsedContent = P.parse(Entry.S3ContentManifest).extract<Poco::JSON::Object::Ptr>();
+		for (auto &[Name, Entry] : BucketContent) {
+			std::string C = Entry.S3ContentManifest;
 
-                if( ParsedContent->has("image") &&
+			try {
-                    ParsedContent->has("compatible") &&
+				Poco::JSON::Parser P;
-                    ParsedContent->has("revision") &&
+				auto ParsedContent =
-                    ParsedContent->has("timestamp"))
+					P.parse(Entry.S3ContentManifest).extract<Poco::JSON::Object::Ptr>();
-                {
-                    Entry.Timestamp = ParsedContent->get("timestamp");
-                    if(Entry.Timestamp>Limit) {
-                        Entry.Compatible = ParsedContent->get("compatible").toString();
-                        Entry.Revision = ParsedContent->get("revision").toString();
-                        Entry.Image = ParsedContent->get("image").toString();
-                        auto FullNme = Name + "-upgrade.bin";
-                        if(FullNme!=Entry.Image) {
-                            Logger_.error(Poco::format("MANIFEST(%s): Image name does not match manifest name (%s).",Name,Entry.Image));
-                            Entry.Valid = false;
-                            BadFormat++;
-                            continue;
-                        }
-                        Accepted++;
-                        Entry.Valid = true;
-                    } else {
-                        Rejected++;
-                        Entry.Valid = false;
-                    }
-                } else {
-                    Logger_.error(Poco::format("MANIFEST(%s): Entry does not have a valid JSON manifest.",Name));
-                    MissingJson++;
-                    Entry.Valid = false;
-                }
-            } catch (const Poco::Exception  &E ) {
-                Logger_.log(E);
-            }
-        }
 
-        Logger_.information(Poco::format("Accepted %Lu firmwares.", Accepted));
+				if (ParsedContent->has("image") && ParsedContent->has("compatible") &&
-        Logger_.information(Poco::format("Rejected %Lu too old firmwares.", Rejected));
+					ParsedContent->has("revision") && ParsedContent->has("timestamp")) {
-        Logger_.information(Poco::format("Rejected %Lu bad JSON.", BadFormat));
+					Entry.Timestamp = ParsedContent->get("timestamp");
-        Logger_.information(Poco::format("Rejected %Lu missing JSON.", MissingJson));
+					if (Entry.Timestamp > Limit) {
+						Entry.Compatible = ParsedContent->get("compatible").toString();
+						Entry.Revision = ParsedContent->get("revision").toString();
+						Entry.Image = ParsedContent->get("image").toString();
+						auto FullNme = Name + "-upgrade.bin";
+						if (FullNme != Entry.Image) {
+							poco_error(
+								Logger(),
+								fmt::format(
+									"MANIFEST({}): Image name does not match manifest name ({}).",
+									Name, Entry.Image));
+							Entry.Valid = false;
+							BadFormat++;
+							continue;
+						}
+						Accepted++;
+						Entry.Valid = true;
+					} else {
+						Rejected++;
+						Entry.Valid = false;
+					}
+				} else {
+					poco_error(
+						Logger(),
+						fmt::format("MANIFEST({}): Entry does not have a valid JSON manifest.",
+									Name));
+					MissingJson++;
+					Entry.Valid = false;
+				}
+			} catch (const Poco::Exception &E) {
+				Logger().log(E);
+			}
+		}
 
-        return true;
+		poco_information(Logger(), fmt::format("Accepted {} firmwares.", Accepted));
-    }
+		poco_information(Logger(), fmt::format("Rejected {} too old firmwares.", Rejected));
+		poco_information(Logger(), fmt::format("Rejected {} bad JSON.", BadFormat));
+		poco_information(Logger(), fmt::format("Rejected {} missing JSON.", MissingJson));
 
-    bool ManifestCreator::AddManifestToDB(S3BucketContent & BucketContent) {
+		return true;
+	}
 
-        for(auto &[Release,BucketEntry]:BucketContent) {
+	bool ManifestCreator::AddManifestToDB(S3BucketContent &BucketContent) {
-            FMSObjects::Firmware    F;
-            auto R = Release;
 
-            // skip staging releases.
+		//  remove all staging names
-            if(BucketEntry.URI.find("-staging-")!=std::string::npos)
+		for (auto it = BucketContent.begin(); it != end(BucketContent);) {
-                continue;
+			if (it->second.URI.find("-staging-") != std::string::npos) {
+				it = BucketContent.erase(it);
+			} else {
+				++it;
+			}
+		}
 
-            if(BucketEntry.Valid && !StorageService()->GetFirmwareByName(R,BucketEntry.Compatible,F)) {
+		//  Now remove all DB entries that do not appear in the Latest manifest
-                F.id = MicroService::instance().CreateUUID();
+		auto RemovedEntries =
-                F.release = Release;
+			StorageService()->FirmwaresDB().RemoveOldDBEntriesNotInManifest(BucketContent);
-                F.size = BucketEntry.S3Size;
+		poco_information(Logger(), fmt::format("Removed {} DB entries that no longer are relevant.",
-                F.created = std::time(nullptr);
+											   RemovedEntries));
-                F.imageDate = BucketEntry.S3TimeStamp;
-                F.image = BucketEntry.S3Name;
-                F.uri = BucketEntry.URI;
-                F.revision = BucketEntry.Revision;
-                F.deviceType = BucketEntry.Compatible;
-                if(StorageService()->AddFirmware(F)) {
-                    Logger_.information(Poco::format("Adding firmware '%s'",Release));
-                } else {
-                }
-            }
-        }
-        return true;
-    }
 
-    int ManifestCreator::Start() {
+		for (auto &[Release, BucketEntry] : BucketContent) {
-        S3BucketName_ = MicroService::instance().ConfigGetString("s3.bucketname");
+			FMSObjects::Firmware F;
-        S3Region_ = MicroService::instance().ConfigGetString("s3.region");
+			auto R = Release;
-        S3Secret_ = MicroService::instance().ConfigGetString("s3.secret");
-        S3Key_ = MicroService::instance().ConfigGetString("s3.key");
-        S3Retry_ = MicroService::instance().ConfigGetInt("s3.retry",60);
 
-        DBRefresh_ = MicroService::instance().ConfigGetInt("firmwaredb.refresh",30*60);
+			if (BucketEntry.Valid &&
-        MaxAge_ = MicroService::instance().ConfigGetInt("firmwaredb.maxage",90) * 24 * 60 * 60;
+				!StorageService()->FirmwaresDB().GetFirmwareByName(R, BucketEntry.Compatible, F)) {
+				F.id = MicroServiceCreateUUID();
+				F.release = Release;
+				F.size = BucketEntry.S3Size;
+				F.created = Utils::Now();
+				F.imageDate = BucketEntry.S3TimeStamp;
+				F.image = BucketEntry.Image;
+				F.uri = BucketEntry.URI;
+				F.revision = BucketEntry.Revision;
+				F.deviceType = BucketEntry.Compatible;
+				if (StorageService()->FirmwaresDB().AddFirmware(F)) {
+					poco_information(Logger(),
+									 fmt::format("Adding firmware '{}', size={}", Release, F.size));
+				} else {
+				}
+			}
+		}
+		return true;
+	}
 
-        AwsConfig_.enableTcpKeepAlive = true;
+	int ManifestCreator::Start() {
-        AwsConfig_.enableEndpointDiscovery = true;
+		Running_ = true;
-        AwsConfig_.useDualStack = true;
+		S3EndpointOverride_ = MicroServiceConfigGetString("s3.endpointOverride", "");
-        if(!S3Region_.empty())
+		S3EndpointHttps_ = MicroServiceConfigGetBool("s3.endpoint.https", true);
-            AwsConfig_.region = S3Region_;
+		S3UseVirtualAdressing_  = MicroServiceConfigGetBool("s3.useVirtualAdressing", true);
-        AwsCreds_.SetAWSAccessKeyId(S3Key_);
+		S3BucketName_ = MicroServiceConfigGetString("s3.bucketname", "");
-        AwsCreds_.SetAWSSecretKey(S3Secret_);
+		S3Region_ = MicroServiceConfigGetString("s3.region", "");
+		S3Secret_ = MicroServiceConfigGetString("s3.secret", "");
+		S3Key_ = MicroServiceConfigGetString("s3.key", "");
+		S3Retry_ = MicroServiceConfigGetInt("s3.retry", 60);
 
-        Worker_.start(*this);
+		DBRefresh_ = MicroServiceConfigGetInt("firmwaredb.refresh", 24 * 60 * 60);
-        return 0;
+		MaxAge_ = MicroServiceConfigGetInt("firmwaredb.maxage", 90) * 24 * 60 * 60;
-    }
 
-    void ManifestCreator::Stop() {
+		AwsConfig_.enableTcpKeepAlive = true;
-        if(Running_) {
+		AwsConfig_.enableEndpointDiscovery = true;
-            Running_ = false;
+		AwsConfig_.useDualStack = true;
-            Worker_.wakeUp();
+		if(!S3EndpointHttps_)
-            Worker_.join();
+			AwsConfig_.scheme = Aws::Http::Scheme::HTTP;
-        }
+		if(!S3EndpointOverride_.empty()) {
-    }
+			AwsConfig_.endpointOverride = Aws::String(S3EndpointOverride_);
+			AwsConfig_.useDualStack = false;
+		}
+		if (!S3Region_.empty())
+			AwsConfig_.region = S3Region_;
+		AwsCreds_.SetAWSAccessKeyId(S3Key_);
+		AwsCreds_.SetAWSSecretKey(S3Secret_);
 
-    bool ManifestCreator::Update() {
+		ManifestCreatorCallBack_ = std::make_unique<Poco::TimerCallback<ManifestCreator>>(
-        Worker_.wakeUp();
+			*this, &ManifestCreator::onTimer);
-        return true;
+		Timer_.setStartInterval(1 * 60 * 1000); // first run in 1 hour
-    }
+		Timer_.setPeriodicInterval((long)(DBRefresh_ * 1000));
+		Timer_.start(*ManifestCreatorCallBack_);
 
-    void ManifestCreator::CloseBucket() {
+		return 0;
-    }
+	}
 
-    bool ManifestCreator::GetBucketObjectContent(Aws::S3::S3Client &S3Client, const std::string &ObjectName,
+	void ManifestCreator::Stop() {
-                                                 std::string &ObjectContent) {
+		if (Running_) {
-        Aws::S3::Model::GetObjectRequest Request;
+			Running_ = false;
-        Request.SetBucket(S3BucketName_.c_str());
+			Timer_.stop();
-        Request.SetKey(ObjectName.c_str());
+		}
+	}
 
-        Aws::S3::Model::GetObjectOutcome get_object_outcome = S3Client.GetObject(Request);
+	void ManifestCreator::CloseBucket() {}
 
-        if (get_object_outcome.IsSuccess())
+	bool ManifestCreator::GetBucketObjectContent(Aws::S3::S3Client &S3Client,
-        {
+												 const std::string &ObjectName,
-            auto & FileData = get_object_outcome.GetResultWithOwnership().GetBody();
+												 std::string &ObjectContent) {
-            std::string O;
+		Aws::S3::Model::GetObjectRequest Request;
-            std::ostringstream OS(O);
+		Request.SetBucket(S3BucketName_.c_str());
-            OS << FileData.rdbuf();
+		Request.SetKey(ObjectName.c_str());
-            ObjectContent = OS.str();
-            return true;
-        }
-        return false;
-    }
 
-    bool ManifestCreator::ReadBucket(S3BucketContent & Bucket) {
+		Aws::S3::Model::GetObjectOutcome get_object_outcome = S3Client.GetObject(Request);
-        static const std::string JSON(".json");
-        static const std::string UPGRADE("-upgrade.bin");
 
-        std::string     URIBase = "https://";
+		if (get_object_outcome.IsSuccess()) {
-        URIBase += MicroService::instance().ConfigGetString("s3.bucket.uri");
+			auto &FileData = get_object_outcome.GetResultWithOwnership().GetBody();
+			std::string O;
+			std::ostringstream OS(O);
+			OS << FileData.rdbuf();
+			ObjectContent = OS.str();
+			return true;
+		}
+		return false;
+	}
 
-        Bucket.clear();
+	bool ManifestCreator::ReadBucket(S3BucketContent &Bucket) {
+		static const std::string JSON(".json");
+		static const std::string UPGRADE("-upgrade.bin");
 
-        Aws::S3::Model::ListObjectsV2Request Request;
+		std::string URIBase = "https://";
-        Request.WithBucket(S3BucketName_.c_str());
+		URIBase += MicroServiceConfigGetString("s3.bucket.uri", "");
-        Aws::S3::S3Client S3Client(AwsCreds_,AwsConfig_);
-        Request.SetMaxKeys(100);
-        Aws::S3::Model::ListObjectsV2Outcome Outcome;
 
-        bool isDone=false;
+		Bucket.clear();
-        int Count=0, Runs=0;
 
-        while(!isDone) {
+		Aws::S3::Model::ListObjectsV2Request Request;
-            Outcome = S3Client.ListObjectsV2(Request);
+		Request.WithBucket(S3BucketName_.c_str());
-            if(!Outcome.IsSuccess()) {
+		Aws::S3::S3Client S3Client(AwsCreds_, AwsConfig_, Aws::Client::AWSAuthV4Signer::PayloadSigningPolicy::Never, S3UseVirtualAdressing_);
-                Logger_.error(Poco::format("Error while doing ListObjectsV2: %s, %s",
+		Request.SetMaxKeys(100);
-                                           std::string{Outcome.GetError().GetExceptionName()},
+		Aws::S3::Model::ListObjectsV2Outcome Outcome;
-                                           std::string{Outcome.GetError().GetMessage()}));
-                return false;
-            }
-            Aws::Vector<Aws::S3::Model::Object> objects = Outcome.GetResult().GetContents();
-            Runs++;
-            for (const auto &Object : objects) {
-                Count++;
-                // std::cout << "Run: " << Runs << "  Count: " << Count << std::endl;
-                Poco::Path FileName(Object.GetKey().c_str());
-                if (!Running_)
-                    return false;
-                if (FileName.getExtension() == "json") {
-                    std::string Release = FileName.getBaseName();
-                    std::string Content;
 
-                    if (GetBucketObjectContent(S3Client, FileName.getFileName(), Content)) {
+		bool isDone = false;
-                        // std::cout << "Object: " << FileName.getFileName() << std::endl;
+		int Count = 0, Runs = 0;
-                        // std::cout << "Content: " << Content << std::endl;
-                        Poco::JSON::Parser P;
-                        auto ParsedContent = P.parse(Content).extract<Poco::JSON::Object::Ptr>();
-                        if (ParsedContent->has("image") &&
-                            ParsedContent->has("compatible") &&
-                            ParsedContent->has("revision") &&
-                            ParsedContent->has("timestamp")) {
-                            auto It = Bucket.find(Release);
-                            uint64_t TimeStamp = ParsedContent->get("timestamp");
-                            auto Compatible = ParsedContent->get("compatible").toString();
-                            auto Revision = ParsedContent->get("revision").toString();
-                            // std::cout << "Revision from bucket in JSON" << Revision << std::endl;
-                            auto Image = ParsedContent->get("image").toString();
-                            if (It != Bucket.end()) {
-                                It->second.Timestamp = TimeStamp;
-                                It->second.Compatible = Compatible;
-                                It->second.Revision = Revision;
-                                It->second.Image = Image;
-                                It->second.S3ContentManifest = Content;
-                            } else {
-                                Bucket.emplace(Release, S3BucketEntry{
-                                        .S3ContentManifest = Content,
-                                        .Revision = Revision,
-                                        .Image = Image,
-                                        .Compatible = Compatible,
-                                        .Timestamp = TimeStamp});
-                            }
-                        }
-                    }
-                } else if (FileName.getExtension() == "bin") {
-                    //  we must remove -upgrade, so
-                    const auto &ReleaseName = FileName.getBaseName().substr(0, FileName.getBaseName().size() - 8);
-                    auto It = Bucket.find(ReleaseName);
-                    auto S3TimeStamp = (uint64_t) (Object.GetLastModified().Millis() / 1000);
-                    uint64_t S3Size = Object.GetSize();
-                    std::string URI = URIBase + "/" + FileName.getFileName();
-                    if (It != Bucket.end()) {
-                        It->second.S3TimeStamp = S3TimeStamp;
-                        It->second.S3Size = S3Size;
-                        It->second.S3Name = ReleaseName;
-                        It->second.URI = URI;
-                    } else {
-                        Bucket.emplace(ReleaseName, S3BucketEntry{
-                                .S3Name = ReleaseName,
-                                .S3TimeStamp = S3TimeStamp,
-                                .S3Size = S3Size,
-                                .URI = URI});
-                    }
-                } else {
-                    // std::cout << "Ignoring " << FileName.getFileName() << std::endl;
-                }
-            }
 
-            isDone = !Outcome.GetResult().GetIsTruncated();
+		while (!isDone) {
-            if(!isDone) {
+			Outcome = S3Client.ListObjectsV2(Request);
-                // std::cout << "Going for next run..." << std::endl;
+			if (!Outcome.IsSuccess()) {
-                // auto Token = Outcome.GetResult().GetContinuationToken();
+				poco_error(Logger(), fmt::format("Error while doing ListObjectsV2: {}, {}",
-                auto Token = Outcome.GetResult().GetNextContinuationToken();
+												 std::string{Outcome.GetError().GetExceptionName()},
-                Request.SetContinuationToken(Token);
+												 std::string{Outcome.GetError().GetMessage()}));
-                // std::cout << "Continuation set..." << std::endl;
+				return false;
-            }
+			}
-        }
+			Aws::Vector<Aws::S3::Model::Object> objects = Outcome.GetResult().GetContents();
+			Runs++;
+			for (const auto &Object : objects) {
+				Count++;
+				// std::cout << "Run: " << Runs << "  Count: " << Count << std::endl;
+				Poco::Path FileName(Object.GetKey().c_str());
+				if (!Running_)
+					return false;
+				if (FileName.getExtension() == "json") {
+					std::string Release = FileName.getBaseName();
+					std::string Content;
 
-        // std::cout << "Count:" << Count << "  Runs:" << Runs << std::endl;
+					if (GetBucketObjectContent(S3Client, FileName.getFileName(), Content)) {
-        if(!Outcome.IsSuccess()) {
+						// std::cout << "Object: " << FileName.getFileName() << std::endl;
-            Logger_.error(Poco::format("Error while doing ListObjectsV2: %s, %s",
+						// std::cout << "Content: " << Content << std::endl;
-                                       std::string{Outcome.GetError().GetExceptionName()},
+						Poco::JSON::Parser P;
-                                       std::string{Outcome.GetError().GetMessage()}));
+						auto ParsedContent = P.parse(Content).extract<Poco::JSON::Object::Ptr>();
-            return false;
+						if (ParsedContent->has("image") && ParsedContent->has("compatible") &&
-        }
+							ParsedContent->has("revision") && ParsedContent->has("timestamp")) {
-        return true;
+							auto It = Bucket.find(Release);
-    }
+							uint64_t TimeStamp = ParsedContent->get("timestamp");
+							auto Compatible = ParsedContent->get("compatible").toString();
+							auto Revision = ParsedContent->get("revision").toString();
+							// std::cout << "Revision from bucket in JSON" << Revision << std::endl;
+							auto Image = ParsedContent->get("image").toString();
+							if (It != Bucket.end()) {
+								It->second.Timestamp = TimeStamp;
+								It->second.Compatible = Compatible;
+								It->second.Revision = Revision;
+								It->second.Image = Image;
+								It->second.S3ContentManifest = Content;
+							} else {
+								Bucket.emplace(Release, S3BucketEntry{.Valid = false,
+																	  .S3Name = "",
+																	  .S3ContentManifest = Content,
+																	  .S3TimeStamp = 0,
+																	  .S3Size = 0,
+																	  .Revision = Revision,
+																	  .Image = Image,
+																	  .Compatible = Compatible,
+																	  .Timestamp = TimeStamp,
+																	  .URI = ""});
+							}
+						}
+					}
+				} else if (FileName.getExtension() == "bin") {
+					//  we must remove -upgrade, so
+					const auto &ReleaseName =
+						FileName.getBaseName().substr(0, FileName.getBaseName().size() - 8);
+					auto It = Bucket.find(ReleaseName);
+					auto S3TimeStamp = (uint64_t)(Object.GetLastModified().Millis() / 1000);
+					uint64_t S3Size = Object.GetSize();
+					std::string URI = URIBase + "/" + FileName.getFileName();
+					if (It != Bucket.end()) {
+						It->second.S3TimeStamp = S3TimeStamp;
+						It->second.S3Size = S3Size;
+						It->second.S3Name = ReleaseName;
+						It->second.URI = URI;
+					} else {
 
-    void S3BucketEntry::Print() const {
+						Bucket.emplace(ReleaseName, S3BucketEntry{.Valid = false,
-        if(Valid) {
+																  .S3Name = "",
-            std::cout << "  Name: " << S3Name << std::endl;
+																  .S3ContentManifest = "",
-            std::cout << "  Size: " << S3Size << std::endl;
+																  .S3TimeStamp = S3TimeStamp,
-            std::cout << "  Date: " << S3TimeStamp << std::endl;
+																  .S3Size = S3Size,
-            std::cout << "  Latest: " << S3ContentManifest << std::endl;
+																  .Revision = "",
-            std::cout << "  Image: " << Image << std::endl;
+																  .Image = "",
-            std::cout << "  Revision: " << Revision << std::endl;
+																  .Compatible = "",
-            std::cout << "  Compatible: " << Compatible << std::endl;
+																  .Timestamp = 0,
-            std::cout << "  Timestamp: " << Timestamp << std::endl;
+																  .URI = URI});
-            std::cout << "  URI: " << URI << std::endl;
+					}
-        } else {
+				} else {
+					// std::cout << "Ignoring " << FileName.getFileName() << std::endl;
+				}
+			}
 
-        }
+			isDone = !Outcome.GetResult().GetIsTruncated();
-    }
+			if (!isDone) {
+				// std::cout << "Going for next run..." << std::endl;
+				// auto Token = Outcome.GetResult().GetContinuationToken();
+				auto Token = Outcome.GetResult().GetNextContinuationToken();
+				Request.SetContinuationToken(Token);
+				// std::cout << "Continuation set..." << std::endl;
+			}
+		}
 
-    void Print(const S3BucketContent &B) {
+		// std::cout << "Count:" << Count << "  Runs:" << Runs << std::endl;
-        for(const auto &[Name,Entry]:B) {
+		if (!Outcome.IsSuccess()) {
-            std::cout << "Release:" << Name << std::endl;
+			poco_error(Logger(), fmt::format("Run({},{}) Error while doing ListObjectsV2: {}, {}",
-            Entry.Print();
+                                             Runs, Count,
-        }
+											 std::string{Outcome.GetError().GetExceptionName()},
-    }
+											 std::string{Outcome.GetError().GetMessage()}));
+			return false;
+		}
+		return true;
+	}
 
-}
+	void S3BucketEntry::Print() const {
+		if (Valid) {
+			std::cout << "  Name: " << S3Name << std::endl;
+			std::cout << "  Size: " << S3Size << std::endl;
+			std::cout << "  Date: " << S3TimeStamp << std::endl;
+			std::cout << "  Latest: " << S3ContentManifest << std::endl;
+			std::cout << "  Image: " << Image << std::endl;
+			std::cout << "  Revision: " << Revision << std::endl;
+			std::cout << "  Compatible: " << Compatible << std::endl;
+			std::cout << "  Timestamp: " << Timestamp << std::endl;
+			std::cout << "  URI: " << URI << std::endl;
+		} else {
+		}
+	}
+
+	void Print(const S3BucketContent &B) {
+		for (const auto &[Name, Entry] : B) {
+			std::cout << "Release:" << Name << std::endl;
+			Entry.Print();
+		}
+	}
+
+} // namespace OpenWifi

src/ManifestCreator.h

@@ -2,74 +2,80 @@
 // Created by stephane bourque on 2021-06-02.
 //
 
-#ifndef UCENTRALFWS_MANIFESTCREATOR_H
+#pragma once
-#define UCENTRALFWS_MANIFESTCREATOR_H
 
 #include <aws/core/Aws.h>
-#include <aws/s3/S3Client.h>
 #include <aws/core/auth/AWSCredentials.h>
+#include <aws/s3/S3Client.h>
 
-#include "framework/MicroService.h"
+#include "Poco/Timer.h"
+#include "framework/SubSystemServer.h"
 
 namespace OpenWifi {
 
-    struct S3BucketEntry {
+	struct S3BucketEntry {
-        bool            Valid = false;
+		bool Valid = false;
-        std::string     S3Name;
+		std::string S3Name;
-        std::string     S3ContentManifest;
+		std::string S3ContentManifest;
-        uint64_t        S3TimeStamp = 0;
+		uint64_t S3TimeStamp = 0;
-        uint64_t        S3Size = 0;
+		uint64_t S3Size = 0;
-        std::string     Revision;
+		std::string Revision;
-        std::string     Image;
+		std::string Image;
-        std::string     Compatible;
+		std::string Compatible;
-        uint64_t        Timestamp = 0;
+		uint64_t Timestamp = 0;
-        std::string     URI;
+		std::string URI;
-        void            Print() const;
+		void Print() const;
-    };
+	};
-    typedef std::map<const std::string, S3BucketEntry>    S3BucketContent;
+	typedef std::map<const std::string, S3BucketEntry> S3BucketContent;
 
-    class ManifestCreator : public SubSystemServer, Poco::Runnable {
+	class ManifestCreator : public SubSystemServer, Poco::Runnable {
-    public:
+	  public:
-        static ManifestCreator *instance() {
+		static auto instance() {
-            static ManifestCreator *instance_ = new ManifestCreator;
+			static auto instance_ = new ManifestCreator;
-            return instance_;
+			return instance_;
-        }
+		}
 
-        void run() override;
+		int Start() override;
-        int Start() override;
+		void Stop() override;
-        void Stop() override;
-        bool Update();
 
-        bool ComputeManifest(S3BucketContent & BucketContent);
+		bool ComputeManifest(S3BucketContent &BucketContent);
-        bool AddManifestToDB(S3BucketContent & BucketContent);
+		bool AddManifestToDB(S3BucketContent &BucketContent);
-        bool InitBucket();
+		bool InitBucket();
-        bool ReadBucket(S3BucketContent & Bucket);
+		bool ReadBucket(S3BucketContent &Bucket);
-        bool GetBucketObjectContent(Aws::S3::S3Client &S3Client, const std::string &ObjectName, std::string & ObjectContent);
+		bool GetBucketObjectContent(Aws::S3::S3Client &S3Client, const std::string &ObjectName,
-        void CloseBucket();
+									std::string &ObjectContent);
-        void Print(const S3BucketContent &B);
+		void CloseBucket();
-        uint64_t MaxAge() const { return MaxAge_; }
+		void Print(const S3BucketContent &B);
+		uint64_t MaxAge() const { return MaxAge_; }
+		void onTimer(Poco::Timer &timer);
+		bool RunUpdateTask();
+		void run() override;
+		std::uint64_t LastUpdate() const { return LastUpdate_; }
 
-    private:
+	  private:
-        static ManifestCreator      *instance_;
+		std::atomic_bool Running_ = false;
-        Poco::Thread                Worker_;
+		Aws::String S3EndpointOverride_;
-        std::atomic_bool            Running_ = false;
+		bool S3EndpointHttps_;
-        Aws::String                 S3BucketName_;
+		bool S3UseVirtualAdressing_;
-        Aws::String                 S3Region_;
+		Aws::String S3BucketName_;
-        Aws::String                 S3Key_;
+		Aws::String S3Region_;
-        Aws::String                 S3Secret_;
+		Aws::String S3Key_;
-        uint64_t                    S3Retry_;
+		Aws::String S3Secret_;
-        Aws::Client::ClientConfiguration    AwsConfig_{"ARILIA"};
+		uint64_t S3Retry_;
-        Aws::Auth::AWSCredentials           AwsCreds_;
+		Aws::Client::ClientConfiguration AwsConfig_{"ARILIA"};
-        uint64_t                     DBRefresh_ = 30 * 60;
+		Aws::Auth::AWSCredentials AwsCreds_;
-        uint64_t                    MaxAge_ = 0 ;
+		uint64_t DBRefresh_ = 30 * 60;
+		uint64_t MaxAge_ = 0;
+		Poco::Timer Timer_;
+		std::unique_ptr<Poco::TimerCallback<ManifestCreator>> ManifestCreatorCallBack_;
+		std::atomic_flag UpdateRunning_ = ATOMIC_FLAG_INIT;
+		Poco::Thread RunnerThread_;
+		std::uint64_t LastUpdate_ = 0;
 
-        ManifestCreator() noexcept:
+		ManifestCreator() noexcept
-                SubSystemServer("ManifestCreator", "MANIFEST-MGR", "manifestcreator") {
+			: SubSystemServer("ManifestCreator", "MANIFEST-MGR", "manifestcreator") {}
-        }
+	};
-    };
 
-    inline ManifestCreator * ManifestCreator() { return ManifestCreator::instance(); };
+	inline auto ManifestCreator() { return ManifestCreator::instance(); };
 
-}
+} // namespace OpenWifi
-
-#endif //UCENTRALFWS_MANIFESTCREATOR_H

src/NewCommandHandler.cpp

@@ -0,0 +1,99 @@
+//
+// Created by stephane bourque on 2021-11-21.
+//
+
+#include "NewCommandHandler.h"
+#include "StorageService.h"
+
+#include "fmt/format.h"
+#include "framework/KafkaManager.h"
+#include "nlohmann/json.hpp"
+
+namespace OpenWifi {
+
+	void NewCommandHandler::run() {
+		Running_ = true;
+		Utils::SetThreadName("cmd-handler");
+		while (Running_) {
+			Poco::Thread::trySleep(2000);
+
+			if (!Running_)
+				break;
+
+			while (!NewCommands_.empty()) {
+				if (!Running_)
+					break;
+
+				Types::StringPair S;
+				{
+					std::lock_guard G(Mutex_);
+					S = NewCommands_.front();
+					NewCommands_.pop();
+				}
+
+				try {
+					auto SerialNumber = S.first;
+					auto M = nlohmann::json::parse(S.second);
+
+					std::string EndPoint;
+
+					if (M.contains(uCentralProtocol::SYSTEM)) {
+						auto SystemObj = M[uCentralProtocol::SYSTEM];
+						if (SystemObj.contains(uCentralProtocol::HOST))
+							EndPoint = SystemObj[uCentralProtocol::HOST];
+					}
+
+					if (M.contains(uCentralProtocol::PAYLOAD)) {
+						auto PayloadSection = M[uCentralProtocol::PAYLOAD];
+						if (PayloadSection.contains("command")) {
+							auto Command = PayloadSection["command"];
+							if (Command == "delete_device") {
+								auto pSerialNumber = PayloadSection["payload"]["serialNumber"];
+								if (pSerialNumber == SerialNumber) {
+									poco_debug(
+										Logger(),
+										fmt::format("Removing device '{}' from upgrade history.",
+													SerialNumber));
+									StorageService()->HistoryDB().DeleteHistory(SerialNumber);
+									poco_debug(
+										Logger(),
+										fmt::format("Removing device '{}' from device table.",
+													SerialNumber));
+									StorageService()->DevicesDB().DeleteDevice(SerialNumber);
+								}
+							}
+						}
+					}
+				} catch (const Poco::Exception &E) {
+					Logger().log(E);
+				}
+			}
+		}
+	};
+
+	int NewCommandHandler::Start() {
+		Types::TopicNotifyFunction F = [this](std::string s1, std::string s2) {
+			this->CommandReceived(s1, s2);
+		};
+		WatcherId_ = KafkaManager()->RegisterTopicWatcher(KafkaTopics::COMMAND, F);
+		Worker_.start(*this);
+		return 0;
+	};
+
+	void NewCommandHandler::Stop() {
+		KafkaManager()->UnregisterTopicWatcher(KafkaTopics::COMMAND, WatcherId_);
+		Running_ = false;
+		Worker_.wakeUp();
+		Worker_.join();
+	};
+
+	bool NewCommandHandler::Update() {
+		Worker_.wakeUp();
+		return true;
+	}
+
+	void NewCommandHandler::CommandReceived(const std::string &Key, const std::string &Message) {
+		std::lock_guard G(Mutex_);
+		NewCommands_.push(std::make_pair(Key, Message));
+	}
+} // namespace OpenWifi

src/NewCommandHandler.h

@@ -0,0 +1,36 @@
+//
+// Created by stephane bourque on 2021-11-21.
+//
+
+#pragma once
+
+#include "framework/OpenWifiTypes.h"
+#include "framework/SubSystemServer.h"
+
+namespace OpenWifi {
+
+	class NewCommandHandler : public SubSystemServer, Poco::Runnable {
+	  public:
+		static auto instance() {
+			static auto instance_ = new NewCommandHandler;
+			return instance_;
+		}
+
+		void run() override;
+		int Start() override;
+		void Stop() override;
+		bool Update();
+		void CommandReceived(const std::string &Key, const std::string &Message);
+
+	  private:
+		Poco::Thread Worker_;
+		std::atomic_bool Running_ = false;
+		int WatcherId_ = 0;
+		Types::StringPairQueue NewCommands_;
+
+		NewCommandHandler() noexcept
+			: SubSystemServer("NewCommandHandler", "NEWCOM-MGR", "commanmdhandler") {}
+	};
+	inline auto NewCommandHandler() { return NewCommandHandler::instance(); };
+
+} // namespace OpenWifi

src/NewConnectionHandler.cpp

@@ -3,138 +3,178 @@
 //
 
 #include "NewConnectionHandler.h"
-#include "framework/KafkaTopics.h"
+#include "AutoUpdater.h"
-#include "framework/OpenWifiTypes.h"
+#include "DeviceCache.h"
+#include "LatestFirmwareCache.h"
 #include "Poco/JSON/Object.h"
 #include "Poco/JSON/Parser.h"
 #include "StorageService.h"
-#include "LatestFirmwareCache.h"
+#include "framework/KafkaTopics.h"
-#include "framework/uCentral_Protocol.h"
+#include "framework/OpenWifiTypes.h"
-#include "DeviceCache.h"
+#include "framework/ow_constants.h"
-#include "AutoUpdater.h"
+
+#include "fmt/format.h"
+#include "framework/KafkaManager.h"
 
 /*
 { "system" : { "id" : 6715803232063 , "host" : "https://localhost:17002" } ,
- "payload" : "{"capabilities":{"compatible":"linksys_ea8300","model":"Linksys EA8300 (Dallas)","network":{"lan":["eth0"],"wan":["eth1"]},"platform":"ap","switch":{"switch0":{"enable":true,"ports":[{"device":"eth0","need_tag":false,"num":0,"want_untag":true},{"num":1,"role":"lan"},{"num":2,"role":"lan"},{"num":3,"role":"lan"},{"num":4,"role":"lan"}],"reset":true,"roles":[{"device":"eth0","ports":"1 2 3 4 0","role":"lan"}]}},"wifi":{"platform/soc/a000000.wifi":{"band":["2G"],"channels":[1,2,3,4,5,6,7,8,9,10,11],"frequencies":[2412,2417,2422,2427,2432,2437,2442,2447,2452,2457,2462],"ht_capa":6639,"htmode":["HT20","HT40","VHT20","VHT40","VHT80"],"rx_ant":3,"tx_ant":3,"vht_capa":865687986},"platform/soc/a800000.wifi":{"band":["5G"],"channels":[36,40,44,48,52,56,60,64],"frequencies":[5180,5200,5220,5240,5260,5280,5300,5320],"ht_capa":6639,"htmode":["HT20","HT40","VHT20","VHT40","VHT80"],"rx_ant":3,"tx_ant":3,"vht_capa":865687986},"soc/40000000.pci/pci0000:00/0000:00:00.0/0000:01:00.0":{"band":["5G"],"channels":[100,104,108,112,116,120,124,128,132,136,140,144,149,153,157,161,165],"frequencies":[5500,5520,5540,5560,5580,5600,5620,5640,5660,5680,5700,5720,5745,5765,5785,5805,5825],"ht_capa":6639,"htmode":["HT20","HT40","VHT20","VHT40","VHT80"],"rx_ant":3,"tx_ant":3,"vht_capa":865696178}}},"firmware":"OpenWrt 21.02-SNAPSHOT r16011+53-6fd65c6573 / TIP-devel-0825cb93","serial":"24f5a207a130","uuid":1623866223}}
+ "payload" : "{"capabilities":{"compatible":"linksys_ea8300","model":"Linksys EA8300
+(Dallas)","network":{"lan":["eth0"],"wan":["eth1"]},"platform":"ap","switch":{"switch0":{"enable":true,"ports":[{"device":"eth0","need_tag":false,"num":0,"want_untag":true},{"num":1,"role":"lan"},{"num":2,"role":"lan"},{"num":3,"role":"lan"},{"num":4,"role":"lan"}],"reset":true,"roles":[{"device":"eth0","ports":"1
+2 3 4
+0","role":"lan"}]}},"wifi":{"platform/soc/a000000.wifi":{"band":["2G"],"channels":[1,2,3,4,5,6,7,8,9,10,11],"frequencies":[2412,2417,2422,2427,2432,2437,2442,2447,2452,2457,2462],"ht_capa":6639,"htmode":["HT20","HT40","VHT20","VHT40","VHT80"],"rx_ant":3,"tx_ant":3,"vht_capa":865687986},"platform/soc/a800000.wifi":{"band":["5G"],"channels":[36,40,44,48,52,56,60,64],"frequencies":[5180,5200,5220,5240,5260,5280,5300,5320],"ht_capa":6639,"htmode":["HT20","HT40","VHT20","VHT40","VHT80"],"rx_ant":3,"tx_ant":3,"vht_capa":865687986},"soc/40000000.pci/pci0000:00/0000:00:00.0/0000:01:00.0":{"band":["5G"],"channels":[100,104,108,112,116,120,124,128,132,136,140,144,149,153,157,161,165],"frequencies":[5500,5520,5540,5560,5580,5600,5620,5640,5660,5680,5700,5720,5745,5765,5785,5805,5825],"ht_capa":6639,"htmode":["HT20","HT40","VHT20","VHT40","VHT80"],"rx_ant":3,"tx_ant":3,"vht_capa":865696178}}},"firmware":"OpenWrt
+21.02-SNAPSHOT r16011+53-6fd65c6573 /
+TIP-devel-0825cb93","serial":"24f5a207a130","uuid":1623866223}}
  */
 
-
 namespace OpenWifi {
 
-    void NewConnectionHandler::run() {
+	void NewConnectionHandler::run() {
-        Running_ = true ;
+		Utils::SetThreadName("conn-handler");
-        while(Running_) {
+		Running_ = true;
-            Poco::Thread::trySleep(2000);
+		while (Running_) {
+			Poco::Thread::trySleep(2000);
 
-            if(!Running_)
+			if (!Running_)
-                break;
+				break;
 
-            while(!NewConnections_.empty()) {
+			while (!NewConnections_.empty()) {
-                if(!Running_)
+				if (!Running_)
-                    break;
+					break;
 
-                Types::StringPair  S;
+				Types::StringPair S;
-                {
+				{
-                    std::lock_guard G(Mutex_);
+					std::lock_guard G(Mutex_);
-                    S = NewConnections_.front();
+					S = NewConnections_.front();
-                    NewConnections_.pop();
+					NewConnections_.pop();
-                }
+				}
 
-                try {
+				try {
-                    auto SerialNumber = S.first;
+					auto SerialNumber = S.first;
-                    Poco::JSON::Parser  Parser;
+					Poco::JSON::Parser Parser;
-                    auto Object = Parser.parse(S.second).extract<Poco::JSON::Object::Ptr>();
+					auto Object = Parser.parse(S.second).extract<Poco::JSON::Object::Ptr>();
 
-                    std::string EndPoint;
+					std::string EndPoint;
 
-                    if(Object->has(uCentralProtocol::SYSTEM)) {
+					if (Object->has(uCentralProtocol::SYSTEM)) {
-                        auto SystemObj = Object->getObject(uCentralProtocol::SYSTEM);
+						auto SystemObj = Object->getObject(uCentralProtocol::SYSTEM);
-                        if(SystemObj->has(uCentralProtocol::HOST))
+						if (SystemObj->has(uCentralProtocol::HOST))
-                            EndPoint = SystemObj->get(uCentralProtocol::HOST).toString();
+							EndPoint = SystemObj->get(uCentralProtocol::HOST).toString();
-                    }
+					}
 
-                    if(Object->has(uCentralProtocol::PAYLOAD)) {
+					if (Object->has(uCentralProtocol::PAYLOAD)) {
-                        auto PayloadObj = Object->getObject(uCentralProtocol::PAYLOAD);
+						auto PayloadObj = Object->getObject(uCentralProtocol::PAYLOAD);
-                        if(PayloadObj->has(uCentralProtocol::CAPABILITIES)) {
+						if (PayloadObj->has(uCentralProtocol::CAPABILITIES)) {
-                            // std::cout << "CAPABILITIES:" << SerialNumber << std::endl;
+							// std::cout << "CAPABILITIES:" << SerialNumber << std::endl;
-                            auto CapObj = PayloadObj->getObject(uCentralProtocol::CAPABILITIES);
+							auto CapObj = PayloadObj->getObject(uCentralProtocol::CAPABILITIES);
-                            if(CapObj->has(uCentralProtocol::COMPATIBLE)) {
+							if (CapObj->has(uCentralProtocol::COMPATIBLE)) {
-                                auto DeviceType = CapObj->get(uCentralProtocol::COMPATIBLE).toString();
+								auto DeviceType =
-                                auto Serial = PayloadObj->get(uCentralProtocol::SERIAL).toString();
+									CapObj->get(uCentralProtocol::COMPATIBLE).toString();
-                                auto Revision = Storage::TrimRevision(PayloadObj->get(uCentralProtocol::FIRMWARE).toString());
+								auto Serial = PayloadObj->get(uCentralProtocol::SERIAL).toString();
-                                // std::cout << "ConnectionEvent: SerialNumber: " << SerialNumber << " DeviceType: " << DeviceType << " Revision:" << Revision << std::endl;
+								auto Revision = Storage::TrimRevision(
-                                FMSObjects::FirmwareAgeDetails  FA;
+									PayloadObj->get(uCentralProtocol::FIRMWARE).toString());
-                                if(StorageService()->ComputeFirmwareAge(DeviceType, Revision, FA)) {
+								// std::cout << "ConnectionEvent: SerialNumber: " << SerialNumber <<
-                                    StorageService()->SetDeviceRevision(SerialNumber, Revision, DeviceType, EndPoint);
+								// " DeviceType: " << DeviceType << " Revision:" << Revision <<
-                                    if(FA.age)
+								// std::endl;
-                                        Logger_.information(Poco::format("Device %s connection. Firmware is %s older than latest.",SerialNumber, Utils::SecondsToNiceText(FA.age)));
+								FMSObjects::FirmwareAgeDetails FA;
-                                    else
+								if (StorageService()->FirmwaresDB().ComputeFirmwareAge(
-                                        Logger_.information(Poco::format("Device %s connection. Device firmware is up to date.",SerialNumber));
+										DeviceType, Revision, FA)) {
-                                }
+									StorageService()->DevicesDB().SetDeviceRevision(
-                                else {
+										SerialNumber, Revision, DeviceType, EndPoint);
-                                    Logger_.information(Poco::format("Device %s connection. Firmware age cannot be determined",SerialNumber));
+									if (FA.age)
-                                }
+										poco_information(
+											Logger(),
+											fmt::format("Device {} connection. Firmware is {} "
+														"older than latest.",
+														SerialNumber,
+														Utils::SecondsToNiceText(FA.age)));
+									else
+										poco_information(Logger(),
+														 fmt::format("Device {} connection. Device "
+																	 "firmware is up to date.",
+																	 SerialNumber));
+								} else {
+									poco_information(Logger(),
+													 fmt::format("Device {} connection. Firmware "
+																 "age cannot be determined.",
+																 SerialNumber));
+								}
 
-                                if(!LatestFirmwareCache()->IsLatest(DeviceType, Revision)) {
+								if (!LatestFirmwareCache()->IsLatest(DeviceType, Revision)) {
-                                    // std::cout << "Device (connection): " << SerialNumber << " to be upgraded ... " << std::endl;
+									// std::cout << "Device (connection): " << SerialNumber << " to
-                                    AutoUpdater()->ToBeUpgraded(SerialNumber, DeviceType);
+									// be upgraded ... " << std::endl;
-                                }
+									AutoUpdater()->ToBeUpgraded(SerialNumber, DeviceType);
-                                DeviceCache()->AddToCache(Serial, DeviceType, EndPoint, Revision);
+								}
-                            }
+								DeviceCache()->AddToCache(Serial, DeviceType, EndPoint, Revision);
-                        } else if(PayloadObj->has(uCentralProtocol::DISCONNECTION)) {
+							}
-                            auto DisconnectMessage = PayloadObj->getObject(uCentralProtocol::DISCONNECTION);
+						} else if (PayloadObj->has(uCentralProtocol::DISCONNECTION)) {
-                            if(DisconnectMessage->has(uCentralProtocol::SERIALNUMBER) && DisconnectMessage->has(uCentralProtocol::TIMESTAMP)) {
+							auto DisconnectMessage =
-                                auto SNum = DisconnectMessage->get(uCentralProtocol::SERIALNUMBER).toString();
+								PayloadObj->getObject(uCentralProtocol::DISCONNECTION);
-                                auto Timestamp = DisconnectMessage->get(uCentralProtocol::TIMESTAMP);
+							if (DisconnectMessage->has(uCentralProtocol::SERIALNUMBER) &&
-                                StorageService()->SetDeviceDisconnected(SNum,EndPoint);
+								DisconnectMessage->has(uCentralProtocol::TIMESTAMP)) {
-                                // std::cout << "DISCONNECTION:" << SerialNumber << std::endl;
+								auto SNum = DisconnectMessage->get(uCentralProtocol::SERIALNUMBER)
-                            }
+												.toString();
-                        } else if(PayloadObj->has(uCentralProtocol::PING)) {
+								auto Timestamp =
-                            // std::cout << "PING:" << SerialNumber << std::endl;
+									DisconnectMessage->get(uCentralProtocol::TIMESTAMP);
-                            auto PingMessage = PayloadObj->getObject(uCentralProtocol::PING);
+								StorageService()->DevicesDB().SetDeviceDisconnected(SNum, EndPoint);
-                            if( PingMessage->has(uCentralProtocol::FIRMWARE) &&
+								// std::cout << "DISCONNECTION:" << SerialNumber << std::endl;
-                            PingMessage->has(uCentralProtocol::SERIALNUMBER) &&
+							}
-                            PingMessage->has(uCentralProtocol::COMPATIBLE)) {
+						} else if (PayloadObj->has(uCentralProtocol::PING)) {
-                                auto Revision = Storage::TrimRevision(PingMessage->get(uCentralProtocol::FIRMWARE).toString());
+							// std::cout << "PING:" << SerialNumber << std::endl;
-                                auto Serial = PingMessage->get( uCentralProtocol::SERIALNUMBER).toString();
+							auto PingMessage = PayloadObj->getObject(uCentralProtocol::PING);
-                                auto DeviceType = PingMessage->get( uCentralProtocol::COMPATIBLE).toString();
+							if (PingMessage->has(uCentralProtocol::FIRMWARE) &&
-                                StorageService()->SetDeviceRevision(Serial, Revision, DeviceType, EndPoint);
+								PingMessage->has(uCentralProtocol::SERIALNUMBER) &&
-                                DeviceCache()->AddToCache(Serial, DeviceType, EndPoint, Revision);
+								PingMessage->has(uCentralProtocol::COMPATIBLE)) {
-                                if(!LatestFirmwareCache()->IsLatest(DeviceType, Revision)) {
+								auto Revision = Storage::TrimRevision(
-                                    // std::cout << "Device(ping): " << SerialNumber << " to be upgraded ... " << std::endl;
+									PingMessage->get(uCentralProtocol::FIRMWARE).toString());
-                                    AutoUpdater()->ToBeUpgraded(SerialNumber, DeviceType);
+								auto Serial =
-                                }
+									PingMessage->get(uCentralProtocol::SERIALNUMBER).toString();
-                            }
+								auto DeviceType =
-                        }
+									PingMessage->get(uCentralProtocol::COMPATIBLE).toString();
-                    }
+								StorageService()->DevicesDB().SetDeviceRevision(
-                } catch (const Poco::Exception &E) {
+									Serial, Revision, DeviceType, EndPoint);
-                    Logger_.log(E);
+								DeviceCache()->AddToCache(Serial, DeviceType, EndPoint, Revision);
-                }
+								if (!LatestFirmwareCache()->IsLatest(DeviceType, Revision)) {
-            }
+									// std::cout << "Device(ping): " << SerialNumber << " to be
-        }
+									// upgraded ... " << std::endl;
-    };
+									AutoUpdater()->ToBeUpgraded(SerialNumber, DeviceType);
+								}
+							}
+						}
+					}
+				} catch (const Poco::Exception &E) {
+					Logger().log(E);
+				}
+			}
+		}
+	};
 
-    int NewConnectionHandler::Start() {
+	int NewConnectionHandler::Start() {
-        Types::TopicNotifyFunction F = [this](std::string s1,std::string s2) { this->ConnectionReceived(s1,s2); };
+		poco_information(Logger(), "Starting...");
-        ConnectionWatcherId_ = KafkaManager()->RegisterTopicWatcher(KafkaTopics::CONNECTION, F);
+		Types::TopicNotifyFunction F = [this](std::string s1, std::string s2) {
-        Worker_.start(*this);
+			this->ConnectionReceived(s1, s2);
-        return 0;
+		};
-    };
+		ConnectionWatcherId_ = KafkaManager()->RegisterTopicWatcher(KafkaTopics::CONNECTION, F);
+		Worker_.start(*this);
+		return 0;
+	};
 
-    void NewConnectionHandler::Stop() {
+	void NewConnectionHandler::Stop() {
-        KafkaManager()->UnregisterTopicWatcher(KafkaTopics::CONNECTION, ConnectionWatcherId_);
+		poco_information(Logger(), "Stopping...");
-        Running_ = false;
+		KafkaManager()->UnregisterTopicWatcher(KafkaTopics::CONNECTION, ConnectionWatcherId_);
-        Worker_.wakeUp();
+		Running_ = false;
-        Worker_.join();
+		Worker_.wakeUp();
-    };
+		Worker_.join();
+		poco_information(Logger(), "Stopped...");
+	};
 
-    bool NewConnectionHandler::Update() {
+	bool NewConnectionHandler::Update() {
-        Worker_.wakeUp();
+		Worker_.wakeUp();
-        return true;
+		return true;
-    }
+	}
 
-    void NewConnectionHandler::ConnectionReceived( const std::string & Key, const std::string & Message) {
+	void NewConnectionHandler::ConnectionReceived(const std::string &Key,
-        std::lock_guard G(Mutex_);
+												  const std::string &Message) {
-        NewConnections_.push(std::make_pair(Key,Message));
+		std::lock_guard G(Mutex_);
-    }
+		NewConnections_.push(std::make_pair(Key, Message));
-}
+	}
+} // namespace OpenWifi

src/NewConnectionHandler.h

@@ -2,43 +2,35 @@
 // Created by stephane bourque on 2021-07-13.
 //
 
-#ifndef UCENTRALFMS_NEWCONNECTIONHANDLER_H
+#pragma once
-#define UCENTRALFMS_NEWCONNECTIONHANDLER_H
 
-
-#include "framework/MicroService.h"
 #include "framework/OpenWifiTypes.h"
+#include "framework/SubSystemServer.h"
 
 namespace OpenWifi {
 
-    class NewConnectionHandler : public SubSystemServer, Poco::Runnable {
+	class NewConnectionHandler : public SubSystemServer, Poco::Runnable {
-    public:
+	  public:
+		static auto instance() {
+			static auto instance_ = new NewConnectionHandler;
+			return instance_;
+		}
 
-        static NewConnectionHandler *instance() {
+		void run() override;
-            static NewConnectionHandler *instance_ = new NewConnectionHandler;
+		int Start() override;
-            return instance_;
+		void Stop() override;
-        }
+		bool Update();
 
-        void run() override;
+		void ConnectionReceived(const std::string &Key, const std::string &Message);
-        int Start() override;
-        void Stop() override;
-        bool Update();
 
-        void ConnectionReceived( const std::string & Key, const std::string & Message);
+	  private:
+		Poco::Thread Worker_;
+		std::atomic_bool Running_ = false;
+		uint64_t ConnectionWatcherId_ = 0;
+		Types::StringPairQueue NewConnections_;
 
-    private:
+		NewConnectionHandler() noexcept
-        Poco::Thread                Worker_;
+			: SubSystemServer("ConnectionHandler", "NEWCONN-MGR", "connectionhandler") {}
-        std::atomic_bool            Running_ = false;
+	};
-        int                         ConnectionWatcherId_=0;
+	inline auto NewConnectionHandler() { return NewConnectionHandler::instance(); };
-        int                         HealthcheckWatcherId_=0;
+} // namespace OpenWifi
-        Types::StringPairQueue      NewConnections_;
-
-        NewConnectionHandler() noexcept:
-                SubSystemServer("ConnectionHandler", "NEWCONN-MGR", "connectionhandler") {
-        }
-
-    };
-    inline NewConnectionHandler * NewConnectionHandler() { return NewConnectionHandler::instance(); };
-}
-
-#endif //UCENTRALFMS_NEWCONNECTIONHANDLER_H

src/RESTAPI/RESTAPI_Routers.cpp

@@ -0,0 +1,41 @@
+//
+// Created by stephane bourque on 2021-10-23.
+//
+
+#include "RESTAPI/RESTAPI_connectedDeviceHandler.h"
+#include "RESTAPI/RESTAPI_connectedDevicesHandler.h"
+#include "RESTAPI/RESTAPI_deviceInformation_handler.h"
+#include "RESTAPI/RESTAPI_deviceReportHandler.h"
+#include "RESTAPI/RESTAPI_firmwareAgeHandler.h"
+#include "RESTAPI/RESTAPI_firmwareHandler.h"
+#include "RESTAPI/RESTAPI_firmwaresHandler.h"
+#include "RESTAPI/RESTAPI_historyHandler.h"
+#include "framework/RESTAPI_Handler.h"
+#include "framework/RESTAPI_SystemCommand.h"
+#include "framework/RESTAPI_SystemConfiguration.h"
+#include "framework/RESTAPI_WebSocketServer.h"
+
+namespace OpenWifi {
+
+	Poco::Net::HTTPRequestHandler *
+	RESTAPI_ExtRouter(const std::string &Path, RESTAPIHandler::BindingMap &Bindings,
+					  Poco::Logger &L, RESTAPI_GenericServerAccounting &S, uint64_t TransactionId) {
+		return RESTAPI_Router<RESTAPI_firmwaresHandler, RESTAPI_system_configuration, RESTAPI_firmwareHandler,
+							  RESTAPI_system_command, RESTAPI_firmwareAgeHandler,
+							  RESTAPI_connectedDevicesHandler, RESTAPI_connectedDeviceHandler,
+							  RESTAPI_historyHandler, RESTAPI_deviceReportHandler,
+							  RESTAPI_deviceInformation_handler, RESTAPI_webSocketServer>(
+			Path, Bindings, L, S, TransactionId);
+	}
+
+	Poco::Net::HTTPRequestHandler *
+	RESTAPI_IntRouter(const std::string &Path, RESTAPIHandler::BindingMap &Bindings,
+					  Poco::Logger &L, RESTAPI_GenericServerAccounting &S, uint64_t TransactionId) {
+		return RESTAPI_Router_I<RESTAPI_firmwaresHandler, RESTAPI_system_configuration, RESTAPI_firmwareHandler,
+								RESTAPI_system_command, RESTAPI_firmwareAgeHandler,
+								RESTAPI_connectedDevicesHandler, RESTAPI_connectedDeviceHandler,
+								RESTAPI_historyHandler, RESTAPI_deviceReportHandler,
+								RESTAPI_deviceInformation_handler>(Path, Bindings, L, S,
+																   TransactionId);
+	}
+} // namespace OpenWifi

src/RESTAPI/RESTAPI_connectedDeviceHandler.cpp

@@ -5,24 +5,23 @@
 #include "RESTAPI_connectedDeviceHandler.h"
 #include "RESTObjects/RESTAPI_FMSObjects.h"
 #include "StorageService.h"
-#include "framework/RESTAPI_protocol.h"
+#include "framework/ow_constants.h"
-#include "framework/RESTAPI_errors.h"
 
 namespace OpenWifi {
 
-    void RESTAPI_connectedDeviceHandler::DoGet() {
+	void RESTAPI_connectedDeviceHandler::DoGet() {
-        auto SerialNumber = GetBinding(RESTAPI::Protocol::SERIALNUMBER,"");
+		auto SerialNumber = GetBinding(RESTAPI::Protocol::SERIALNUMBER, "");
 
-        if(SerialNumber.empty()) {
+		if (SerialNumber.empty()) {
-            return BadRequest(RESTAPI::Errors::MissingSerialNumber);
+			return BadRequest(RESTAPI::Errors::MissingSerialNumber);
-        }
+		}
 
-        FMSObjects::DeviceConnectionInformation DevInfo;
+		FMSObjects::DeviceConnectionInformation DevInfo;
-        if(StorageService()->GetDevice(SerialNumber, DevInfo)) {
+		if (StorageService()->DevicesDB().GetDevice(SerialNumber, DevInfo)) {
-            Poco::JSON::Object  Answer;
+			Poco::JSON::Object Answer;
-            DevInfo.to_json(Answer);
+			DevInfo.to_json(Answer);
-            return ReturnObject(Answer);
+			return ReturnObject(Answer);
-        }
+		}
-        NotFound();
+		NotFound();
-    }
+	}
-}
+} // namespace OpenWifi

src/RESTAPI/RESTAPI_connectedDeviceHandler.h

@@ -5,25 +5,27 @@
 #ifndef UCENTRALFMS_RESTAPI_CONNECTEDDEVICEHANDLER_H
 #define UCENTRALFMS_RESTAPI_CONNECTEDDEVICEHANDLER_H
 
-#include "framework/MicroService.h"
+#include "framework/RESTAPI_Handler.h"
 
 namespace OpenWifi {
-    class RESTAPI_connectedDeviceHandler : public RESTAPIHandler {
+	class RESTAPI_connectedDeviceHandler : public RESTAPIHandler {
-    public:
+	  public:
-        RESTAPI_connectedDeviceHandler(const RESTAPIHandler::BindingMap &bindings, Poco::Logger &L, RESTAPI_GenericServer & Server, bool Internal)
+		RESTAPI_connectedDeviceHandler(const RESTAPIHandler::BindingMap &bindings, Poco::Logger &L,
-                : RESTAPIHandler(bindings, L,
+									   RESTAPI_GenericServerAccounting &Server,
-                                 std::vector<std::string>
+									   uint64_t TransactionId, bool Internal)
-                                         {Poco::Net::HTTPRequest::HTTP_GET,
+			: RESTAPIHandler(bindings, L,
-                                          Poco::Net::HTTPRequest::HTTP_OPTIONS},
+							 std::vector<std::string>{Poco::Net::HTTPRequest::HTTP_GET,
-                                          Server,
+													  Poco::Net::HTTPRequest::HTTP_OPTIONS},
-                                          Internal) {}
+							 Server, TransactionId, Internal) {}
-        static const std::list<const char *> PathName() { return std::list<const char *>{"/api/v1/connectedDevice/{serialNumber}"};}
+		static auto PathName() {
+			return std::list<std::string>{"/api/v1/connectedDevice/{serialNumber}"};
+		}
 
-        void DoGet() final;
+		void DoGet() final;
-        void DoDelete() final {};
+		void DoDelete() final{};
-        void DoPost() final {};
+		void DoPost() final{};
-        void DoPut() final {};
+		void DoPut() final{};
-    };
+	};
-}
+} // namespace OpenWifi
 
-#endif //UCENTRALFMS_RESTAPI_CONNECTEDDEVICEHANDLER_H
+#endif // UCENTRALFMS_RESTAPI_CONNECTEDDEVICEHANDLER_H

src/RESTAPI/RESTAPI_connectedDevicesHandler.cpp

@@ -2,29 +2,29 @@
 // Created by stephane bourque on 2021-07-18.
 //
 
-#include "Poco/JSON/Object.h"
 #include "Poco/JSON/Array.h"
+#include "Poco/JSON/Object.h"
 
 #include "RESTAPI_connectedDevicesHandler.h"
 #include "RESTObjects/RESTAPI_FMSObjects.h"
 #include "StorageService.h"
-#include "framework/RESTAPI_protocol.h"
+#include "framework/ow_constants.h"
 
 namespace OpenWifi {
-    void RESTAPI_connectedDevicesHandler::DoGet() {
+	void RESTAPI_connectedDevicesHandler::DoGet() {
-        std::vector<FMSObjects::DeviceConnectionInformation> Devices;
+		std::vector<FMSObjects::DeviceConnectionInformation> Devices;
-        Poco::JSON::Object AnswerObj;
+		Poco::JSON::Object AnswerObj;
-        Poco::JSON::Array AnswerArr;
+		Poco::JSON::Array AnswerArr;
-        if (StorageService()->GetDevices(QB_.Offset, QB_.Limit, Devices)) {
+		if (StorageService()->DevicesDB().GetDevices(QB_.Offset, QB_.Limit, Devices)) {
-            for (const auto &i:Devices) {
+			for (const auto &i : Devices) {
-                Poco::JSON::Object Obj;
+				Poco::JSON::Object Obj;
-                i.to_json(Obj);
+				i.to_json(Obj);
-                AnswerArr.add(Obj);
+				AnswerArr.add(Obj);
-            }
+			}
-            AnswerObj.set(RESTAPI::Protocol::DEVICES, AnswerArr);
+			AnswerObj.set(RESTAPI::Protocol::DEVICES, AnswerArr);
-            return ReturnObject(AnswerObj);
+			return ReturnObject(AnswerObj);
-        }
+		}
-        AnswerObj.set(RESTAPI::Protocol::DEVICES, AnswerArr);
+		AnswerObj.set(RESTAPI::Protocol::DEVICES, AnswerArr);
-        ReturnObject(AnswerObj);
+		ReturnObject(AnswerObj);
-    }
+	}
-}
+} // namespace OpenWifi

src/RESTAPI/RESTAPI_connectedDevicesHandler.h

@@ -5,26 +5,24 @@
 #ifndef UCENTRALFMS_RESTAPI_CONNECTEDDEVICESHANDLER_H
 #define UCENTRALFMS_RESTAPI_CONNECTEDDEVICESHANDLER_H
 
-
+#include "framework/RESTAPI_Handler.h"
-#include "framework/MicroService.h"
 
 namespace OpenWifi {
-    class RESTAPI_connectedDevicesHandler : public RESTAPIHandler {
+	class RESTAPI_connectedDevicesHandler : public RESTAPIHandler {
-    public:
+	  public:
-        RESTAPI_connectedDevicesHandler(const RESTAPIHandler::BindingMap &bindings, Poco::Logger &L, RESTAPI_GenericServer & Server, bool Internal)
+		RESTAPI_connectedDevicesHandler(const RESTAPIHandler::BindingMap &bindings, Poco::Logger &L,
-                : RESTAPIHandler(bindings, L,
+										RESTAPI_GenericServerAccounting &Server,
-                                 std::vector<std::string>
+										uint64_t TransactionId, bool Internal)
-                                         {Poco::Net::HTTPRequest::HTTP_GET,
+			: RESTAPIHandler(bindings, L,
-                                          Poco::Net::HTTPRequest::HTTP_OPTIONS},
+							 std::vector<std::string>{Poco::Net::HTTPRequest::HTTP_GET,
-                                          Server,
+													  Poco::Net::HTTPRequest::HTTP_OPTIONS},
-                                          Internal) {}
+							 Server, TransactionId, Internal) {}
-        static const std::list<const char *> PathName() { return std::list<const char *>{"/api/v1/connectedDevices"};}
+		static auto PathName() { return std::list<std::string>{"/api/v1/connectedDevices"}; }
-        void DoGet()  final;
+		void DoGet() final;
-        void DoDelete() final {};
+		void DoDelete() final{};
-        void DoPost() final {};
+		void DoPost() final{};
-        void DoPut() final {};
+		void DoPut() final{};
+	};
+} // namespace OpenWifi
 
-    };
+#endif // UCENTRALFMS_RESTAPI_CONNECTEDDEVICESHANDLER_H
-}
-
-#endif //UCENTRALFMS_RESTAPI_CONNECTEDDEVICESHANDLER_H

src/RESTAPI/RESTAPI_deviceInformation_handler.cpp

@@ -0,0 +1,47 @@
+//
+// Created by stephane bourque on 2022-03-04.
+//
+
+#include "RESTAPI_deviceInformation_handler.h"
+#include "LatestFirmwareCache.h"
+#include "StorageService.h"
+
+namespace OpenWifi {
+	void RESTAPI_deviceInformation_handler::DoGet() {
+		auto SerialNumber = GetBinding("serialNumber", "");
+
+		if (SerialNumber.empty() || !Utils::ValidSerialNumber(SerialNumber)) {
+			return BadRequest(RESTAPI::Errors::MissingOrInvalidParameters);
+		}
+
+		FMSObjects::DeviceInformation DI;
+
+		//  Let's get the history
+		StorageService()->HistoryDB().GetHistory(SerialNumber, 0, 100, DI.history.history);
+
+		// Let's get the DeviceConnectionInformation
+		FMSObjects::DeviceConnectionInformation DCI;
+		StorageService()->DevicesDB().GetDevice(SerialNumber, DCI);
+
+		LatestFirmwareCacheEntry LFE;
+		LatestFirmwareCache()->FindLatestFirmware(DCI.deviceType, LFE);
+
+		FMSObjects::Firmware Latest;
+		StorageService()->FirmwaresDB().GetFirmware(LFE.Id, Latest);
+
+		DI.serialNumber = SerialNumber;
+		DI.currentFirmware = DCI.revision;
+		DI.latestFirmware = LFE.Revision;
+		DI.latestFirmwareDate = LFE.TimeStamp;
+		DI.latestFirmwareURI = Latest.uri;
+		FirmwaresDB::RecordName FI;
+		StorageService()->FirmwaresDB().GetFirmwareByRevision(DCI.revision, DCI.deviceType, FI);
+		DI.currentFirmwareDate = FI.imageDate;
+
+		DI.latestFirmwareAvailable = (LFE.Revision != DCI.revision);
+
+		Poco::JSON::Object Answer;
+		DI.to_json(Answer);
+		return ReturnObject(Answer);
+	}
+} // namespace OpenWifi

src/RESTAPI/RESTAPI_deviceInformation_handler.h

@@ -0,0 +1,27 @@
+//
+// Created by stephane bourque on 2022-03-04.
+//
+
+#pragma once
+
+#include "framework/RESTAPI_Handler.h"
+
+namespace OpenWifi {
+	class RESTAPI_deviceInformation_handler : public RESTAPIHandler {
+	  public:
+		RESTAPI_deviceInformation_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/deviceInformation/{serialNumber}"};
+		}
+		void DoGet() final;
+		void DoDelete() final{};
+		void DoPost() final{};
+		void DoPut() final{};
+	};
+} // namespace OpenWifi

src/RESTAPI/RESTAPI_deviceReportHandler.cpp

@@ -3,16 +3,19 @@
 //
 
 #include "RESTAPI_deviceReportHandler.h"
-#include "StorageService.h"
-#include "RESTObjects/RESTAPI_FMSObjects.h"
-#include "Poco/JSON/Object.h"
 #include "Daemon.h"
+#include "Poco/JSON/Object.h"
+#include "RESTObjects/RESTAPI_FMSObjects.h"
 
 namespace OpenWifi {
-    void RESTAPI_deviceReportHandler::DoGet() {
+	void RESTAPI_deviceReportHandler::DoGet() {
-        Daemon()->CreateDashboard();
+		poco_information(Logger(), fmt::format("GET-DASHBOARD: {}", Requester()));
-        Poco::JSON::Object  O;
+		FMSObjects::DeviceReport Data;
-        Daemon()->GetDashboard().to_json(O);
+		if (Daemon()->GetDashboard().Get(Data, Logger())) {
-        ReturnObject(O);
+			Poco::JSON::Object Answer;
-    }
+			Data.to_json(Answer);
-}
+			return ReturnObject(Answer);
+		}
+		return BadRequest(RESTAPI::Errors::InternalError);
+	}
+} // namespace OpenWifi

src/RESTAPI/RESTAPI_deviceReportHandler.h

@@ -2,28 +2,24 @@
 // Created by stephane bourque on 2021-07-19.
 //
 
-#ifndef UCENTRALFMS_RESTAPI_DEVICEREPORTHANDLER_H
+#pragma once
-#define UCENTRALFMS_RESTAPI_DEVICEREPORTHANDLER_H
 
-#include "framework/MicroService.h"
+#include "framework/RESTAPI_Handler.h"
 
 namespace OpenWifi {
-    class RESTAPI_deviceReportHandler : public RESTAPIHandler {
+	class RESTAPI_deviceReportHandler : public RESTAPIHandler {
-    public:
+	  public:
-        RESTAPI_deviceReportHandler(const RESTAPIHandler::BindingMap &bindings, Poco::Logger &L, RESTAPI_GenericServer & Server, bool Internal)
+		RESTAPI_deviceReportHandler(const RESTAPIHandler::BindingMap &bindings, Poco::Logger &L,
-                : RESTAPIHandler(bindings, L,
+									RESTAPI_GenericServerAccounting &Server, uint64_t TransactionId,
-                                 std::vector<std::string>
+									bool Internal)
-                                         {Poco::Net::HTTPRequest::HTTP_GET,
+			: RESTAPIHandler(bindings, L,
-                                          Poco::Net::HTTPRequest::HTTP_OPTIONS},
+							 std::vector<std::string>{Poco::Net::HTTPRequest::HTTP_GET,
-                                          Server,
+													  Poco::Net::HTTPRequest::HTTP_OPTIONS},
-                                 Internal) {}
+							 Server, TransactionId, Internal) {}
-        static const std::list<const char *> PathName() { return std::list<const char *>{"/api/v1/deviceReport"};}
+		static auto PathName() { return std::list<std::string>{"/api/v1/deviceReport"}; }
-        void DoGet()  final;
+		void DoGet() final;
-        void DoDelete() final {};
+		void DoDelete() final{};
-        void DoPost() final {};
+		void DoPost() final{};
-        void DoPut() final {};
+		void DoPut() final{};
-    };
+	};
-}
+} // namespace OpenWifi
-
-
-#endif //UCENTRALFMS_RESTAPI_DEVICEREPORTHANDLER_H

src/RESTAPI/RESTAPI_firmwareAgeHandler.cpp

@@ -4,59 +4,57 @@
 
 #include "RESTAPI_firmwareAgeHandler.h"
 
-#include "StorageService.h"
-#include "Poco/JSON/Parser.h"
 #include "DeviceCache.h"
-#include "framework/uCentral_Protocol.h"
+#include "Poco/JSON/Parser.h"
-#include "framework/RESTAPI_protocol.h"
+#include "StorageService.h"
-#include "framework/RESTAPI_errors.h"
+#include "framework/ow_constants.h"
 
 namespace OpenWifi {
-    void RESTAPI_firmwareAgeHandler::DoGet() {
+	void RESTAPI_firmwareAgeHandler::DoGet() {
-        if (!QB_.Select.empty()) {
+		if (!QB_.Select.empty()) {
-            Poco::JSON::Array Objects;
+			Poco::JSON::Array Objects;
-            std::vector<std::string> Numbers = Utils::Split(QB_.Select);
+			for (auto &i : SelectedRecords()) {
-            for (auto &i : Numbers) {
+				DeviceCacheEntry E;
-                DeviceCacheEntry E;
+				if (DeviceCache()->GetDevice(i, E)) {
-                if (DeviceCache()->GetDevice(i, E)) {
+					FMSObjects::FirmwareAgeDetails FA;
-                    FMSObjects::FirmwareAgeDetails FA;
+					if (StorageService()->FirmwaresDB().ComputeFirmwareAge(E.deviceType, E.revision,
-                    if(StorageService()->ComputeFirmwareAge(E.deviceType,E.revision,FA)) {
+																		   FA)) {
-                        Poco::JSON::Object  O;
+						Poco::JSON::Object O;
-                        FA.to_json(O);
+						FA.to_json(O);
-                        O.set(uCentralProtocol::SERIALNUMBER,i);
+						O.set(uCentralProtocol::SERIALNUMBER, i);
-                        Objects.add(O);
+						Objects.add(O);
-                    } else {
+					} else {
-                        Poco::JSON::Object  O;
+						Poco::JSON::Object O;
-                        O.set(uCentralProtocol::SERIALNUMBER,i);
+						O.set(uCentralProtocol::SERIALNUMBER, i);
-                        Objects.add(O);
+						Objects.add(O);
-                    }
+					}
-                } else {
+				} else {
-                    Poco::JSON::Object  O;
+					Poco::JSON::Object O;
-                    O.set(uCentralProtocol::SERIALNUMBER,i);
+					O.set(uCentralProtocol::SERIALNUMBER, i);
-                    Objects.add(O);
+					Objects.add(O);
-                }
+				}
-            }
+			}
-            Poco::JSON::Object Answer;
+			Poco::JSON::Object Answer;
-            Answer.set(RESTAPI::Protocol::AGES, Objects);
+			Answer.set(RESTAPI::Protocol::AGES, Objects);
-            return ReturnObject(Answer);
+			return ReturnObject(Answer);
-        } else {
+		} else {
-            auto DeviceType = GetParameter(RESTAPI::Protocol::DEVICETYPE, "");
+			auto DeviceType = ORM::Escape(GetParameter(RESTAPI::Protocol::DEVICETYPE, ""));
-            auto Revision = GetParameter(RESTAPI::Protocol::REVISION, "");
+			auto Revision = ORM::Escape(GetParameter(RESTAPI::Protocol::REVISION, ""));
 
-            if (DeviceType.empty() || Revision.empty()) {
+			if (DeviceType.empty() || Revision.empty()) {
-                return BadRequest(RESTAPI::Errors::BothDeviceTypeRevision);
+				return BadRequest(RESTAPI::Errors::BothDeviceTypeRevision);
-            }
+			}
 
-            Revision = Storage::TrimRevision(Revision);
+			Revision = Storage::TrimRevision(Revision);
 
-            FMSObjects::FirmwareAgeDetails FA;
+			FMSObjects::FirmwareAgeDetails FA;
-            if (StorageService()->ComputeFirmwareAge(DeviceType, Revision, FA)) {
+			if (StorageService()->FirmwaresDB().ComputeFirmwareAge(DeviceType, Revision, FA)) {
-                Poco::JSON::Object Answer;
+				Poco::JSON::Object Answer;
 
-                FA.to_json(Answer);
+				FA.to_json(Answer);
-                return ReturnObject(Answer);
+				return ReturnObject(Answer);
-            }
+			}
-            NotFound();
+			NotFound();
-        }
+		}
-    }
+	}
-}
+} // namespace OpenWifi

src/RESTAPI/RESTAPI_firmwareAgeHandler.h

@@ -5,24 +5,24 @@
 #ifndef UCENTRALFMS_RESTAPI_FIRMWAREAGEHANDLER_H
 #define UCENTRALFMS_RESTAPI_FIRMWAREAGEHANDLER_H
 
-#include "framework/MicroService.h"
+#include "framework/RESTAPI_Handler.h"
 
 namespace OpenWifi {
-    class RESTAPI_firmwareAgeHandler : public RESTAPIHandler {
+	class RESTAPI_firmwareAgeHandler : public RESTAPIHandler {
-    public:
+	  public:
-        RESTAPI_firmwareAgeHandler(const RESTAPIHandler::BindingMap &bindings, Poco::Logger &L, RESTAPI_GenericServer & Server, bool Internal)
+		RESTAPI_firmwareAgeHandler(const RESTAPIHandler::BindingMap &bindings, Poco::Logger &L,
-                : RESTAPIHandler(bindings, L,
+								   RESTAPI_GenericServerAccounting &Server, uint64_t TransactionId,
-                                 std::vector<std::string>
+								   bool Internal)
-                                         {Poco::Net::HTTPRequest::HTTP_GET,
+			: RESTAPIHandler(bindings, L,
-                                          Poco::Net::HTTPRequest::HTTP_OPTIONS},
+							 std::vector<std::string>{Poco::Net::HTTPRequest::HTTP_GET,
-                                          Server,
+													  Poco::Net::HTTPRequest::HTTP_OPTIONS},
-                                          Internal) {}
+							 Server, TransactionId, Internal) {}
-        static const std::list<const char *> PathName() { return std::list<const char *>{"/api/v1/firmwareAge"};}
+		static auto PathName() { return std::list<std::string>{"/api/v1/firmwareAge"}; }
-        void DoGet()  final;
+		void DoGet() final;
-        void DoDelete() final {};
+		void DoDelete() final{};
-        void DoPost() final {};
+		void DoPost() final{};
-        void DoPut() final {};
+		void DoPut() final{};
-    };
+	};
-}
+} // namespace OpenWifi
 
-#endif //UCENTRALFMS_RESTAPI_FIRMWAREAGEHANDLER_H
+#endif // UCENTRALFMS_RESTAPI_FIRMWAREAGEHANDLER_H

src/RESTAPI/RESTAPI_firmwareHandler.cpp

@@ -4,92 +4,92 @@
 
 #include "Poco/JSON/Parser.h"
 
-#include "RESTAPI_firmwareHandler.h"
+#include "RESTAPI/RESTAPI_firmwareHandler.h"
 #include "StorageService.h"
-#include "framework/uCentral_Protocol.h"
+#include "framework/MicroServiceFuncs.h"
-#include "framework/RESTAPI_protocol.h"
+#include "framework/ow_constants.h"
-#include "framework/RESTAPI_errors.h"
+#include "framework/utils.h"
 
 namespace OpenWifi {
-    void
+	void RESTAPI_firmwareHandler::DoPost() {
-    RESTAPI_firmwareHandler::DoPost() {
+		const auto &Obj = ParsedBody_;
-        auto Obj = ParseStream();
+		FMSObjects::Firmware F;
-        FMSObjects::Firmware F;
+		if (!F.from_json(Obj)) {
-        if (!F.from_json(Obj)) {
+			return BadRequest(RESTAPI::Errors::InvalidJSONDocument);
-            return BadRequest(RESTAPI::Errors::InvalidJSONDocument);
+		}
-        }
+		F.id = MicroServiceCreateUUID();
-        F.id = MicroService::instance().CreateUUID();
+		if (StorageService()->FirmwaresDB().AddFirmware(F)) {
-        if(StorageService()->AddFirmware(F)) {
+			Poco::JSON::Object Answer;
-            Poco::JSON::Object  Answer;
+			F.to_json(Answer);
-            F.to_json(Answer);
+			return ReturnObject(Answer);
-            return ReturnObject(Answer);
+		}
-        }
+		BadRequest(RESTAPI::Errors::RecordNotCreated);
-        BadRequest(RESTAPI::Errors::RecordNotCreated);
+	}
-    }
 
-    void
+	void RESTAPI_firmwareHandler::DoGet() {
-    RESTAPI_firmwareHandler::DoGet() {
+		auto UUID = GetBinding(uCentralProtocol::ID, "");
-        auto UUID = GetBinding(uCentralProtocol::ID, "");
 
-        if(UUID.empty()) {
+		if (UUID.empty()) {
-            return BadRequest(RESTAPI::Errors::MissingUUID);
+			return BadRequest(RESTAPI::Errors::MissingUUID);
-        }
+		}
 
-        FMSObjects::Firmware F;
+		FMSObjects::Firmware F;
-        if (StorageService()->GetFirmware(UUID, F)) {
+		if (StorageService()->FirmwaresDB().GetFirmware(UUID, F)) {
-            Poco::JSON::Object Object;
+			Poco::JSON::Object Object;
-            F.to_json(Object);
+			F.to_json(Object);
-            return ReturnObject(Object);
+			return ReturnObject(Object);
-        }
+		}
-        NotFound();
+		NotFound();
-    }
+	}
 
-    void
+	void RESTAPI_firmwareHandler::DoDelete() {
-    RESTAPI_firmwareHandler::DoDelete() {
+		auto UUID = GetBinding(uCentralProtocol::ID, "");
-        auto UUID = GetBinding(uCentralProtocol::ID, "");
+		if (UUID.empty()) {
-        if(UUID.empty()) {
+			return BadRequest(RESTAPI::Errors::MissingUUID);
-            return BadRequest(RESTAPI::Errors::MissingUUID);
+		}
-        }
 
-        if (StorageService()->DeleteFirmware(UUID)) {
+		if (StorageService()->FirmwaresDB().DeleteFirmware(UUID)) {
-            return OK();
+			return OK();
-        }
+		}
-        BadRequest(RESTAPI::Errors::CouldNotBeDeleted);
+		BadRequest(RESTAPI::Errors::CouldNotBeDeleted);
-    }
+	}
 
-    void RESTAPI_firmwareHandler::DoPut() {
+	void RESTAPI_firmwareHandler::DoPut() {
-        auto UUID = GetBinding(uCentralProtocol::ID, "");
+		auto UUID = GetBinding(uCentralProtocol::ID, "");
-        if(UUID.empty()) {
+		if (UUID.empty()) {
-            return BadRequest(RESTAPI::Errors::MissingUUID);
+			return BadRequest(RESTAPI::Errors::MissingUUID);
-        }
+		}
 
-        FMSObjects::Firmware    F;
+		FMSObjects::Firmware F;
-        if(!StorageService()->GetFirmware(UUID, F)) {
+		if (!StorageService()->FirmwaresDB().GetFirmware(UUID, F)) {
-            return NotFound();
+			return NotFound();
-        }
+		}
 
-        auto Obj = ParseStream();
+		const auto &Obj = ParsedBody_;
-        FMSObjects::Firmware    NewFirmware;
+		FMSObjects::Firmware NewFirmware;
-        if(!NewFirmware.from_json(Obj)) {
+		if (!NewFirmware.from_json(Obj)) {
-            return BadRequest(RESTAPI::Errors::InvalidJSONDocument);
+			return BadRequest(RESTAPI::Errors::InvalidJSONDocument);
-        }
+		}
 
-        if(Obj->has(RESTAPI::Protocol::DESCRIPTION))
+		if (Obj->has(RESTAPI::Protocol::DESCRIPTION))
-            F.description = Obj->get(RESTAPI::Protocol::DESCRIPTION).toString();
+			F.description = Obj->get(RESTAPI::Protocol::DESCRIPTION).toString();
-        if(Obj->has(RESTAPI::Protocol::NOTES)) {
+		if (Obj->has(RESTAPI::Protocol::NOTES)) {
-            SecurityObjects::NoteInfoVec NIV;
+			SecurityObjects::NoteInfoVec NIV;
-            NIV = RESTAPI_utils::to_object_array<SecurityObjects::NoteInfo>(Obj->get(RESTAPI::Protocol::NOTES).toString());
+			NIV = RESTAPI_utils::to_object_array<SecurityObjects::NoteInfo>(
-            for(auto const &i:NIV) {
+				Obj->get(RESTAPI::Protocol::NOTES).toString());
-                SecurityObjects::NoteInfo   ii{.created=(uint64_t)std::time(nullptr), .createdBy=UserInfo_.userinfo.email, .note=i.note};
+			for (auto const &i : NIV) {
-                F.notes.push_back(ii);
+				SecurityObjects::NoteInfo ii{.created = (uint64_t)Utils::Now(),
-            }
+											 .createdBy = UserInfo_.userinfo.email,
-        }
+											 .note = i.note};
+				F.notes.push_back(ii);
+			}
+		}
 
-        if(StorageService()->UpdateFirmware(UUID, F)) {
+		if (StorageService()->FirmwaresDB().UpdateFirmware(UUID, F)) {
-            Poco::JSON::Object  Answer;
+			Poco::JSON::Object Answer;
-            F.to_json(Answer);
+			F.to_json(Answer);
-            return ReturnObject(Answer);
+			return ReturnObject(Answer);
-        }
+		}
-        BadRequest(RESTAPI::Errors::RecordNotUpdated);
+		BadRequest(RESTAPI::Errors::RecordNotUpdated);
-    }
+	}
-}
+} // namespace OpenWifi

src/RESTAPI/RESTAPI_firmwareHandler.h

@@ -5,27 +5,27 @@
 #ifndef UCENTRALFWS_RESTAPI_FIRMWAREHANDLER_H
 #define UCENTRALFWS_RESTAPI_FIRMWAREHANDLER_H
 
-#include "framework/MicroService.h"
+#include "framework/RESTAPI_Handler.h"
 
 namespace OpenWifi {
-    class RESTAPI_firmwareHandler : public RESTAPIHandler {
+	class RESTAPI_firmwareHandler : public RESTAPIHandler {
-    public:
+	  public:
-        RESTAPI_firmwareHandler(const RESTAPIHandler::BindingMap &bindings, Poco::Logger &L, RESTAPI_GenericServer & Server, bool Internal)
+		RESTAPI_firmwareHandler(const RESTAPIHandler::BindingMap &bindings, Poco::Logger &L,
-                : RESTAPIHandler(bindings, L,
+								RESTAPI_GenericServerAccounting &Server, uint64_t TransactionId,
-                                 std::vector<std::string>
+								bool Internal)
-                                         {Poco::Net::HTTPRequest::HTTP_GET,
+			: RESTAPIHandler(bindings, L,
-                                          Poco::Net::HTTPRequest::HTTP_POST,
+							 std::vector<std::string>{Poco::Net::HTTPRequest::HTTP_GET,
-                                          Poco::Net::HTTPRequest::HTTP_PUT,
+													  Poco::Net::HTTPRequest::HTTP_POST,
-                                          Poco::Net::HTTPRequest::HTTP_DELETE,
+													  Poco::Net::HTTPRequest::HTTP_PUT,
-                                          Poco::Net::HTTPRequest::HTTP_OPTIONS},
+													  Poco::Net::HTTPRequest::HTTP_DELETE,
-                                          Server,
+													  Poco::Net::HTTPRequest::HTTP_OPTIONS},
-                                          Internal) {}
+							 Server, TransactionId, Internal) {}
-        static const std::list<const char *> PathName() { return std::list<const char *>{"/api/v1/firmware/{id}"};}
+		static auto PathName() { return std::list<std::string>{"/api/v1/firmware/{id}"}; }
-        void DoGet()  final;
+		void DoGet() final;
-        void DoDelete() final;
+		void DoDelete() final;
-        void DoPost() final;
+		void DoPost() final;
-        void DoPut() final;
+		void DoPut() final;
-    };
+	};
-}
+} // namespace OpenWifi
 
-#endif //UCENTRALFWS_RESTAPI_FIRMWAREHANDLER_H
+#endif // UCENTRALFWS_RESTAPI_FIRMWAREHANDLER_H

src/RESTAPI/RESTAPI_firmwaresHandler.cpp

@@ -3,93 +3,124 @@
 //
 
 #include "RESTAPI_firmwaresHandler.h"
-#include "StorageService.h"
 #include "LatestFirmwareCache.h"
-#include "framework/RESTAPI_protocol.h"
+#include "StorageService.h"
+#include "framework/ow_constants.h"
 
 namespace OpenWifi {
-    void
+	void RESTAPI_firmwaresHandler::DoGet() {
-    RESTAPI_firmwaresHandler::DoGet() {
+		std::string DeviceType = ORM::Escape(GetParameter(RESTAPI::Protocol::DEVICETYPE, ""));
-        std::string DeviceType = GetParameter(RESTAPI::Protocol::DEVICETYPE, "");
+		bool IdOnly = GetBoolParameter(RESTAPI::Protocol::IDONLY);
-        bool IdOnly = GetBoolParameter(RESTAPI::Protocol::IDONLY, false);
+		bool LatestOnly = GetBoolParameter(RESTAPI::Protocol::LATESTONLY);
-        bool RevisionSet = GetBoolParameter(RESTAPI::Protocol::REVISIONSET, false);
+		bool rcOnly = GetBoolParameter("rcOnly");
-        bool LatestOnly = GetBoolParameter(RESTAPI::Protocol::LATESTONLY, false);
-        bool DeviceSet = GetBoolParameter(RESTAPI::Protocol::DEVICESET, false);
 
-        if(DeviceSet) {
+		if (GetBoolParameter("updateTimeOnly")) {
-            auto Revisions = LatestFirmwareCache()->GetDevices();
+			Poco::JSON::Object Answer;
-            Poco::JSON::Array ObjectArray;
+			Answer.set("lastUpdateTime", ManifestCreator()->LastUpdate());
-            for (const auto &i:Revisions) {
+			return ReturnObject(Answer);
-                ObjectArray.add(i);
+		}
-            }
-            Poco::JSON::Object RetObj;
-            RetObj.set(RESTAPI::Protocol::DEVICETYPES, ObjectArray);
-            return ReturnObject(RetObj);
-        }
 
-        if(RevisionSet) {
+		if (GetBoolParameter(RESTAPI::Protocol::DEVICESET)) {
-            auto Revisions = LatestFirmwareCache()->GetRevisions();
+			auto Revisions = LatestFirmwareCache()->GetDevices();
-            Poco::JSON::Array ObjectArray;
+			Poco::JSON::Array ObjectArray;
-            for (const auto &i:Revisions) {
+			for (const auto &i : Revisions) {
-                ObjectArray.add(i);
+				ObjectArray.add(i);
-            }
+			}
-            Poco::JSON::Object RetObj;
+			Poco::JSON::Object RetObj;
-            RetObj.set(RESTAPI::Protocol::REVISIONS, ObjectArray);
+			RetObj.set(RESTAPI::Protocol::DEVICETYPES, ObjectArray);
-            return ReturnObject(RetObj);
+			return ReturnObject(RetObj);
-        }
+		}
 
-        // special cases: if latestOnly and deviceType
+		if (GetBoolParameter(RESTAPI::Protocol::REVISIONSET)) {
-        if(!DeviceType.empty()) {
+			auto Revisions = LatestFirmwareCache()->GetRevisions();
-            if(LatestOnly) {
+			Poco::JSON::Array ObjectArray;
-                LatestFirmwareCacheEntry    Entry;
+			for (const auto &i : Revisions) {
-                if(!LatestFirmwareCache()->FindLatestFirmware(DeviceType,Entry)) {
+				ObjectArray.add(i);
-                    return NotFound();
+			}
-                }
+			Poco::JSON::Object RetObj;
+			RetObj.set(RESTAPI::Protocol::REVISIONS, ObjectArray);
+			return ReturnObject(RetObj);
+		}
 
-                FMSObjects::Firmware    F;
+		// special cases: if latestOnly and deviceType
-                if(StorageService()->GetFirmware(Entry.Id,F)) {
+		if (!DeviceType.empty()) {
-                    Poco::JSON::Object  Answer;
+			if (LatestOnly) {
-                    F.to_json(Answer);
+				LatestFirmwareCacheEntry Entry;
-                    return ReturnObject(Answer);
+				if (rcOnly) {
-                }
+					if (!LatestFirmwareCache()->FindLatestRCOnlyFirmware(DeviceType, Entry)) {
-                return NotFound();
+						return NotFound();
-            } else {
+					}
-                std::vector<FMSObjects::Firmware> List;
+				} else {
-                if (StorageService()->GetFirmwares(QB_.Offset, QB_.Limit, DeviceType, List)) {
+					if (!LatestFirmwareCache()->FindLatestFirmware(DeviceType, Entry)) {
-                    Poco::JSON::Array ObjectArray;
+						return NotFound();
-                    for (const auto &i:List) {
+					}
-                        if(IdOnly) {
+				}
-                            ObjectArray.add(i.id);
-                        } else {
-                            Poco::JSON::Object Obj;
-                            i.to_json(Obj);
-                            ObjectArray.add(Obj);
-                        }
-                    }
-                    Poco::JSON::Object RetObj;
-                    RetObj.set(RESTAPI::Protocol::FIRMWARES, ObjectArray);
-                    return ReturnObject(RetObj);
-                } else {
-                    return NotFound();
-                }
-            }
-        }
 
-        std::vector<FMSObjects::Firmware> List;
+				FMSObjects::Firmware F;
-        Poco::JSON::Array ObjectArray;
+				if (StorageService()->FirmwaresDB().GetFirmware(Entry.Id, F)) {
-        Poco::JSON::Object Answer;
+					Poco::JSON::Object Answer;
-        if (StorageService()->GetFirmwares(QB_.Offset, QB_.Limit, DeviceType, List)) {
+					F.to_json(Answer);
-            for (const auto &i:List) {
+					return ReturnObject(Answer);
-                if(IdOnly) {
+				}
-                    ObjectArray.add(i.id);
+				return NotFound();
-                } else {
+			} else {
-                    Poco::JSON::Object Obj;
+				std::vector<FMSObjects::Firmware> List;
-                    i.to_json(Obj);
+				if (StorageService()->FirmwaresDB().GetFirmwares(QB_.Offset, QB_.Limit, DeviceType,
-                    ObjectArray.add(Obj);
+																 List)) {
-                }
+					Poco::JSON::Array ObjectArray;
-            }
+					for (const auto &i : List) {
-        }
+						if (rcOnly && !LatestFirmwareCache::IsRC(i.revision))
-        Answer.set(RESTAPI::Protocol::FIRMWARES, ObjectArray);
+							continue;
-        ReturnObject(Answer);
+						if (IdOnly) {
-    }
+							ObjectArray.add(i.id);
-}
+						} else {
+							Poco::JSON::Object Obj;
+							i.to_json(Obj);
+							ObjectArray.add(Obj);
+						}
+					}
+					Poco::JSON::Object RetObj;
+					RetObj.set(RESTAPI::Protocol::FIRMWARES, ObjectArray);
+					return ReturnObject(RetObj);
+				} else {
+					return NotFound();
+				}
+			}
+		}
+
+		std::vector<FMSObjects::Firmware> List;
+		Poco::JSON::Array ObjectArray;
+		Poco::JSON::Object Answer;
+		if (StorageService()->FirmwaresDB().GetFirmwares(QB_.Offset, QB_.Limit, DeviceType, List)) {
+			for (const auto &i : List) {
+				if (rcOnly && !LatestFirmwareCache::IsRC(i.revision))
+					continue;
+				if (IdOnly) {
+					ObjectArray.add(i.id);
+				} else {
+					Poco::JSON::Object Obj;
+					i.to_json(Obj);
+					ObjectArray.add(Obj);
+				}
+			}
+		}
+		Answer.set(RESTAPI::Protocol::FIRMWARES, ObjectArray);
+		ReturnObject(Answer);
+	}
+
+	void RESTAPI_firmwaresHandler::DoPut() {
+		if (UserInfo_.userinfo.userRole != SecurityObjects::ROOT &&
+			UserInfo_.userinfo.userRole != SecurityObjects::ADMIN) {
+			return UnAuthorized(RESTAPI::Errors::ACCESS_DENIED);
+		}
+
+		if (GetBoolParameter("update")) {
+			if (ManifestCreator()->RunUpdateTask()) {
+				return OK();
+			}
+			return BadRequest(RESTAPI::Errors::FirmwareBDInProgress);
+		}
+
+		return BadRequest(RESTAPI::Errors::MissingOrInvalidParameters);
+	}
+} // namespace OpenWifi

src/RESTAPI/RESTAPI_firmwaresHandler.h

@@ -5,25 +5,26 @@
 #ifndef UCENTRALFWS_RESTAPI_FIRMWARESHANDLER_H
 #define UCENTRALFWS_RESTAPI_FIRMWARESHANDLER_H
 
-#include "framework/MicroService.h"
+#include "framework/RESTAPI_Handler.h"
 
 namespace OpenWifi {
-    class RESTAPI_firmwaresHandler : public RESTAPIHandler {
+	class RESTAPI_firmwaresHandler : public RESTAPIHandler {
-    public:
+	  public:
-        RESTAPI_firmwaresHandler(const RESTAPIHandler::BindingMap &bindings, Poco::Logger &L, RESTAPI_GenericServer & Server, bool Internal)
+		RESTAPI_firmwaresHandler(const RESTAPIHandler::BindingMap &bindings, Poco::Logger &L,
-                : RESTAPIHandler(bindings, L,
+								 RESTAPI_GenericServerAccounting &Server, uint64_t TransactionId,
-                                 std::vector<std::string>
+								 bool Internal)
-                                         {Poco::Net::HTTPRequest::HTTP_GET,
+			: RESTAPIHandler(bindings, L,
-                                          Poco::Net::HTTPRequest::HTTP_OPTIONS},
+							 std::vector<std::string>{Poco::Net::HTTPRequest::HTTP_GET,
-                                          Server,
+													  Poco::Net::HTTPRequest::HTTP_PUT,
-                                          Internal) {}
+													  Poco::Net::HTTPRequest::HTTP_OPTIONS},
+							 Server, TransactionId, Internal) {}
 
-        static const std::list<const char *> PathName() { return std::list<const char *>{"/api/v1/firmwares"};}
+		static auto PathName() { return std::list<std::string>{"/api/v1/firmwares"}; }
-        void DoGet()  final;
+		void DoGet() final;
-        void DoDelete() final {};
+		void DoDelete() final{};
-        void DoPost() final {};
+		void DoPost() final{};
-        void DoPut() final {};
+		void DoPut() final;
-    };
+	};
-}
+} // namespace OpenWifi
 
-#endif //UCENTRALFWS_RESTAPI_FIRMWARESHANDLER_H
+#endif // UCENTRALFWS_RESTAPI_FIRMWARESHANDLER_H

src/RESTAPI/RESTAPI_historyHandler.cpp

@@ -4,43 +4,62 @@
 
 #include "RESTAPI_historyHandler.h"
 #include "StorageService.h"
-#include "framework/RESTAPI_protocol.h"
+#include "framework/ow_constants.h"
-#include "framework/RESTAPI_errors.h"
 
 namespace OpenWifi {
-    void
+	void RESTAPI_historyHandler::DoGet() {
-    RESTAPI_historyHandler::DoGet() {
+		auto SerialNumber = ORM::Escape(GetBinding(RESTAPI::Protocol::SERIALNUMBER, ""));
-        auto SerialNumber = GetBinding(RESTAPI::Protocol::SERIALNUMBER, "");
 
-        if(SerialNumber.empty()) {
+		if (SerialNumber.empty()) {
-            return BadRequest(RESTAPI::Errors::MissingSerialNumber);
+			return BadRequest(RESTAPI::Errors::MissingSerialNumber);
-        }
+		}
 
-        FMSObjects::RevisionHistoryEntryVec H;
+		auto unknownList = GetBoolParameter("unknownList");
-        if (StorageService()->GetHistory(SerialNumber, QB_.Offset, QB_.Limit, H)) {
+		if (SerialNumber == "000000000000" && unknownList) {
-            Poco::JSON::Array A;
+			// so let's get all the devices, filter the latest record
-            for (auto const &i:H) {
+			FMSObjects::DeviceCurrentInfoList L;
-                Poco::JSON::Object O;
+			StorageService()->HistoryDB().GetUnknownDeviceFirmwares(QB_.Offset, QB_.Limit,
-                i.to_json(O);
+																	L.devices);
-                A.add(O);
+			Poco::JSON::Object Answer;
-            }
+			L.to_json(Answer);
-            Poco::JSON::Object Answer;
+			return ReturnObject(Answer);
-            Answer.set(RESTAPI::Protocol::HISTORY, A);
+		}
-            return ReturnObject(Answer);
-        }
-        NotFound();
-    }
 
-    void RESTAPI_historyHandler::DoDelete() {
+		auto currentList = GetBoolParameter("currentList");
-        auto SerialNumber = GetBinding(RESTAPI::Protocol::SERIALNUMBER, "");
+		if (SerialNumber == "000000000000" && currentList) {
-        auto Id = GetParameter(RESTAPI::Protocol::ID, "");
+			// so let's get all the devices, filter the latest record
-        if (SerialNumber.empty() || Id.empty()) {
+			FMSObjects::DeviceCurrentInfoList L;
-            return BadRequest(RESTAPI::Errors::IdOrSerialEmpty);
+			StorageService()->HistoryDB().GetDeviceFirmwares(QB_.Offset, QB_.Limit, L.devices);
-        }
+			Poco::JSON::Object Answer;
+			L.to_json(Answer);
+			return ReturnObject(Answer);
+		}
 
-        if (!StorageService()->DeleteHistory(SerialNumber, Id)) {
+		FMSObjects::RevisionHistoryEntryVec H;
-            return OK();
+		if (StorageService()->HistoryDB().GetHistory(SerialNumber, QB_.Offset, QB_.Limit, H)) {
-        }
+			Poco::JSON::Array A;
-        NotFound();
+			for (auto const &i : H) {
-    }
+				Poco::JSON::Object O;
-}
+				i.to_json(O);
+				A.add(O);
+			}
+			Poco::JSON::Object Answer;
+			Answer.set(RESTAPI::Protocol::HISTORY, A);
+			return ReturnObject(Answer);
+		}
+		NotFound();
+	}
+
+	void RESTAPI_historyHandler::DoDelete() {
+		auto SerialNumber = GetBinding(RESTAPI::Protocol::SERIALNUMBER, "");
+		auto Id = GetParameter(RESTAPI::Protocol::ID, "");
+		if (SerialNumber.empty() || Id.empty()) {
+			return BadRequest(RESTAPI::Errors::IdOrSerialEmpty);
+		}
+
+		if (!StorageService()->HistoryDB().DeleteHistory(SerialNumber, Id)) {
+			return OK();
+		}
+		NotFound();
+	}
+} // namespace OpenWifi