Merge pull request #17 from webos-tools/develop

nhamkthd · web-flow · commit 690fa3c1926c · 2024-10-16T13:57:18.000+07:00
[Release 3.1.3] Add native_service for apollo, fixbug ares-setup-device device name with "-"
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,10 @@
+## 3.1.3 (October 14, 2024)
+### ares-generate
+* Added "native_service" template for apollo platform.
+
+### ares-setup-device
+* Fixed a bug that device name can not be added with "-".
+
 
 ## 3.1.2 (August 07, 2024)
 ### ares-config
diff --git a/bin/ares-setup-device.js b/bin/ares-setup-device.js
@@ -9,6 +9,7 @@
 const async = require('async'),
     inquirer = require('inquirer'),
     nopt = require('nopt'),
+    abbrev = require("abbrev"),
     log = require('npmlog'),
     path = require('path'),
     Ssdp = require('ssdp-js'),
@@ -66,7 +67,7 @@ const shortHands = {
     "R": ["--reset"]
 };
 
-const argv = nopt(knownOpts, shortHands, process.argv, 2 /* drop 'node' & 'ares-*.js'*/);
+const argv = getArgv();
 
 log.heading = processName;
 log.level = argv.level || 'warn';
@@ -186,7 +187,7 @@ function _queryAddRemove(ssdpDevices, next) {
                     if (ssdpDevice) {
                         if (ssdpDevice.op === 'modify') return inqChoices;
                         else return ['add'];
-                    }
+                    } 
                     if (deviceNames.length > 1) return totChoices;
                     // deveice list has emulator only > unsupported remove option
                     return inqChoices.concat(dfChoices);
@@ -261,7 +262,7 @@ function _queryDeviceInfo(selDevice, next) {
     const deviceName = selDevice.name,
         resolver = this.resolver || (this.resolver = new novacom.Resolver()),
         defaultDeviceInfo = appdata.getConfig(true).defaultDeviceInfo;
-
+    
     questions = [{
         type: "input",
         name: "ip",
@@ -379,7 +380,7 @@ function _queryDeviceInfo(selDevice, next) {
           username: answers.user,
           default: answers.default
         };
-
+       
         if (answers.user !== 'prisoner' && ["add", "modify"].includes(mode)) {
             if (answers.auth_type && answers.auth_type === "password") {
                 inDevice.password = answers.password;
@@ -523,3 +524,50 @@ function finish(err, value) {
         cliControl.end();
     }
 }
+
+function getArgv() {
+    let argv = nopt(knownOpts, shortHands, process.argv, 2 /* drop 'node' & 'ares-*.js'*/);
+    let mode = checkMode(argv);
+    return (mode && argv[mode] === 'true') ? reParse(argv, mode) : argv; 
+}
+
+function checkMode(argv) {
+    if (argv.add) return 'add';
+    if (argv.modify) return 'modify';
+    if (argv.remove) return 'remove';
+    return (argv.default) ? 'default' : null;
+}
+
+function reParse(argv, mode) {
+    let nameIndex = -1;
+    let cookedNameIndex = -1;
+    let abbrevOpts = abbrev(Object.keys(knownOpts))
+    
+    for (let i = 0; i < argv.argv.original.length; i++) {
+        if (argv.argv.original[i].match(/^-{2,}$/)) {
+            nameIndex = i;
+            break;
+        }
+    }
+    cookedNameIndex = argv.argv.cooked.indexOf('--');
+    if (cookedNameIndex <= 0 || !argv.argv.cooked[cookedNameIndex - 1].match(/^-/) || abbrevOpts[argv.argv.cooked[cookedNameIndex - 1].replace(/^-+/, "")] != mode) {
+        return argv;
+    }
+
+    argv[mode] = argv.argv.original[nameIndex];
+    if (nameIndex != -1 && cookedNameIndex != -1 && nameIndex + 1 < argv.argv.original.length) {
+        const remainArgv = nopt(knownOpts, shortHands, argv.argv.original, nameIndex + 1);
+        for (const option in remainArgv) {
+            if (remainArgv.hasOwnProperty(option)) {
+                if (!argv.hasOwnProperty(option)) {
+                    argv[option] = remainArgv[option];
+                } else if (Array.isArray(argv[option])) {
+                    argv[option] = argv[option].concat(remainArgv[option]);
+                }
+            }
+        }
+        argv.argv.remain = remainArgv.argv.remain;     
+        argv.argv.cooked = argv.argv.cooked.splice(0, cookedNameIndex + 1).concat(remainArgv.argv.cooked);
+    }
+    return argv
+}
diff --git a/files/conf-base/template-conf/apollo-sdk-templates.json b/files/conf-base/template-conf/apollo-sdk-templates.json
@@ -43,6 +43,11 @@
         ],
         "description": "services.json, package.json for JS service"
     },
+    "native_service": {
+        "type": "nativeservice",
+        "path": "$cli-root/files/templates/apollo-sdk-templates/native-service",
+        "description": "native service for Apollo"
+    },
     "icon": {
         "type": "icon",
         "path": "$cli-root/files/templates/apollo-sdk-templates/icon",
diff --git a/files/templates/apollo-sdk-templates/native-service/CMakeLists.txt b/files/templates/apollo-sdk-templates/native-service/CMakeLists.txt
@@ -0,0 +1,72 @@
+# Copyright (c) 2020-2024 LG Electronics, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+cmake_minimum_required(VERSION 2.8.7)
+project(nativeService C)
+
+# set link directory
+#link_directories(${CMAKE_SOURCE_DIR}/pkg_$ENV{ARCH}/lib)
+
+# ---
+# add include files
+include_directories(${CMAKE_SOURCE_DIR})
+include_directories(${CMAKE_SOURCE_DIR}/src)
+include_directories(${CMAKE_SOURCE_DIR}/include)
+
+# ---
+# find required packages
+include(FindPkgConfig)
+
+pkg_check_modules(GTHREAD2 REQUIRED gthread-2.0)
+include_directories(${GTHREAD2_INCLUDE_DIRS})
+
+pkg_check_modules(PBNJSON REQUIRED pbnjson_c)
+include_directories(${PBNJSON_INCLUDE_DIRS})
+
+# -- check for glib 2.0
+pkg_check_modules(GLIB2 REQUIRED glib-2.0)
+include_directories(${GLIB2_INCLUDE_DIRS})
+
+pkg_check_modules(LS2 REQUIRED luna-service2)
+include_directories(${LS2_INCLUDE_DIRS})
+
+pkg_check_modules(PMLOG REQUIRED PmLogLib)
+include_directories(${PMLOG_INCLUDE_DIRS})
+
+# ---
+# create executable file
+set(BIN_NAME echo_service)
+
+set(SRC_LIST
+    ${CMAKE_SOURCE_DIR}/src/main.c
+)
+
+set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_SOURCE_DIR}/pkg_$ENV{OECORE_TARGET_ARCH}/")
+add_executable(${BIN_NAME} ${SRC_LIST})
+
+# ignore shared library
+set(CMAKE_EXE_LINKER_FLAGS "-Wl,--allow-shlib-undefined")
+set_target_properties(${BIN_NAME} PROPERTIES LINKER_LANGUAGE C)
+
+target_link_libraries (${BIN_NAME}
+    ${GTHREAD2_LDFLAGS}
+    ${PBNJSON_LDFLAGS}
+    ${LS2_LDFLAGS}
+    ${GLIB2_LDFLAGS}
+    ${PMLOG_LDFLAGS}
+)
+
+file(COPY ${CMAKE_SOURCE_DIR}/services.json DESTINATION "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}")
diff --git a/files/templates/apollo-sdk-templates/native-service/services.json b/files/templates/apollo-sdk-templates/native-service/services.json
@@ -0,0 +1,11 @@
+{
+    "id": "com.domain.app.service",
+    "description": "Native echo service",
+    "engine": "native",
+    "executable": "echo_service",
+    "services": [ {
+      "name": "com.domain.app.service",
+      "description": "Native echo service"
+    }]
+  }
+  
diff --git a/files/templates/apollo-sdk-templates/native-service/src/main.c b/files/templates/apollo-sdk-templates/native-service/src/main.c
@@ -0,0 +1,144 @@
+// Copyright (c) 2020-2024 LG Electronics, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// SPDX-License-Identifier: Apache-2.0
+
+#include <stdlib.h>
+#include <string.h>
+#include <glib.h>
+#include <stdio.h>
+#include <glib-object.h>
+#include <luna-service2/lunaservice.h>
+#include <pbnjson.h>
+
+// This service name
+#define SERVICE_NAME "SERVICE_ID"
+#define BUF_SIZE 64
+
+// Main loop for aliving background service
+GMainLoop *gmainLoop;
+
+LSHandle  *sh = NULL;
+LSMessage *message;
+
+// Declare of each method
+// All method format must be : bool function(LSHandle*, LSMessage*, void*)
+bool echo(LSHandle *sh, LSMessage *message, void *data);
+
+LSMethod sampleMethods[] = {
+    {"echo", echo},   // luna://SERVICE_ID/echo
+};
+
+
+/*
+ * Define luna://SERVICE_ID/echo
+ *  - A method that always returns the same value
+ *
+ * +----------------------------+            +--------------------------------+
+ * |   APP_ID          |            | SERVICE_ID        |
+ * |   Foreground Application   |            |        Background Service      |
+ * +----------------------------+            +--------------------------------+
+ *   |                                                                        |
+ *   |                                                                        |
+ *   | 1. Request to luna://SERVICE_ID/echo                      |
+ *   |    with parameters { input: "Hello, World!" }                          |
+ *   |                                                                        |
+ *   | ---------------------------------------------------------------------> |
+ *   |                                                                        |
+ *   |                                                                        |
+ *   |            2. Response to APP_ID                              |
+ *   |               with result '{ "echoMessage" : "Hello, World!" }'        |
+ *   |                                                                        |
+ *   | <--------------------------------------------------------------------- |
+ *   |                                                                        |
+ *  \|/                                                                      \|/
+ *   '                                                                        '
+ */
+bool echo(LSHandle *sh, LSMessage *message, void *data)
+{
+    LSError lserror;
+    JSchemaInfo schemaInfo;
+    jvalue_ref parsed = {0}, value = {0};
+    jvalue_ref jobj = {0}, jreturnValue = {0};
+    const char *input = NULL;
+    char buf[BUF_SIZE] = {0, };
+
+    LSErrorInit(&lserror);
+
+    // Initialize schema
+    jschema_info_init (&schemaInfo, jschema_all(), NULL, NULL);
+
+    // get message from LS2 and parsing to make object
+    parsed = jdom_parse(j_cstr_to_buffer(LSMessageGetPayload(message)), DOMOPT_NOOPT, &schemaInfo);
+
+    if (jis_null(parsed)) {
+        j_release(&parsed);
+        return true;
+    }
+
+    // Get value from payload.input
+    value = jobject_get(parsed, j_cstr_to_buffer("input"));
+
+    // JSON Object to string without schema validation check
+    input = jvalue_tostring_simple(value);
+
+    /**
+     * JSON create test
+     */
+    jobj = jobject_create();
+    if (jis_null(jobj)) {
+        j_release(&jobj);
+        return true;
+    }
+
+    jreturnValue = jboolean_create(TRUE);
+    jobject_set(jobj, j_cstr_to_buffer("returnValue"), jreturnValue);
+    jobject_set(jobj, j_cstr_to_buffer("echoMessage"), value);
+
+    LSMessageReply(sh, message, jvalue_tostring_simple(jobj), &lserror);
+
+    j_release(&parsed);
+    return true;
+}
+
+// Register background service and initialize
+int main(int argc, char* argv[])
+{
+    LSError lserror;
+    LSHandle  *handle = NULL;
+    bool bRetVal = FALSE;
+
+    LSErrorInit(&lserror);
+
+    // create a GMainLoop
+    gmainLoop = g_main_loop_new(NULL, FALSE);
+
+    bRetVal = LSRegister(SERVICE_NAME, &handle, &lserror);
+    if (FALSE== bRetVal) {
+        LSErrorFree( &lserror );
+        return 0;
+    }
+    sh = LSMessageGetConnection(message);
+
+    LSRegisterCategory(handle,"/",sampleMethods, NULL, NULL, &lserror);
+
+    LSGmainAttach(handle, gmainLoop, &lserror);
+
+    // run to check continuously for new events from each of the event sources
+    g_main_loop_run(gmainLoop);
+    // Decreases the reference count on a GMainLoop object by one
+    g_main_loop_unref(gmainLoop);
+
+    return 0;
+}
diff --git a/lib/base/setup-device.js b/lib/base/setup-device.js
@@ -142,7 +142,10 @@ const async = require('async'),
                 return next(errHndl.getErrMsg("INVALID_MODE"));
             }
             if (options[mode].match(/^-/)) {
-                return next(errHndl.getErrMsg("EMPTY_VALUE", "DEVICE_NAME"));
+                let indexMode = options.argv.cooked.indexOf("--" + mode);
+                if (indexMode != -1 && options.argv.cooked.length > indexMode + 2 && !options.argv.cooked[indexMode + 2].match(/^--[a-z]+$/)) {
+                    return next(errHndl.getErrMsg("EMPTY_VALUE", "DEVICE_NAME"));
+                }
             }
             const argName = (options.info) ? "info" : mode;
             const inDevice = _getParams(options, argName);
diff --git a/lib/generator.js b/lib/generator.js
diff --git a/npm-shrinkwrap.json b/npm-shrinkwrap.json
diff --git a/package.json b/package.json

Original file line number	Diff line number	Diff line change
`@@ -142,7 +142,10 @@ const async = require('async'),`
`142`	`142`	`return next(errHndl.getErrMsg("INVALID_MODE"));`
`143`	`143`	`}`
`144`	`144`	`if (options[mode].match(/^-/)) {`
`145`		`- return next(errHndl.getErrMsg("EMPTY_VALUE", "DEVICE_NAME"));`
	`145`	`+ let indexMode = options.argv.cooked.indexOf("--" + mode);`
	`146`	`+ if (indexMode != -1 && options.argv.cooked.length > indexMode + 2 && !options.argv.cooked[indexMode + 2].match(/^--[a-z]+$/)) {`
	`147`	`+ return next(errHndl.getErrMsg("EMPTY_VALUE", "DEVICE_NAME"));`
	`148`	`+ }`
`146`	`149`	`}`
`147`	`150`	`const argName = (options.info) ? "info" : mode;`
`148`	`151`	`const inDevice = _getParams(options, argName);`