From 33d628193ee06eb04bbd9a5ee243a1f391ba8155 Mon Sep 17 00:00:00 2001 From: taeyoung Date: Wed, 18 Nov 2015 15:47:57 +0900 Subject: [PATCH] plugin: add sample plugin - If Vendors want to add their own plugin, they can use the sample code for the plugin Change-Id: Ie6e7af9d5e7a1de4e6d7745da3bd8caca8c4fef8 Signed-off-by: taeyoung --- CMakeLists.txt | 1 - plugin_sample/CMakeLists.txt | 20 ++ plugin_sample/LICENSE | 201 +++++++++++++++++++++ .../packaging/system-info-external-plugin.manifest | 5 + .../packaging/system-info-external-plugin.spec | 42 +++++ plugin_sample/plugin.c | 92 ++++++++++ src/tizenid/CMakeLists.txt | 1 + 7 files changed, 361 insertions(+), 1 deletion(-) create mode 100644 plugin_sample/CMakeLists.txt create mode 100644 plugin_sample/LICENSE create mode 100644 plugin_sample/packaging/system-info-external-plugin.manifest create mode 100644 plugin_sample/packaging/system-info-external-plugin.spec create mode 100644 plugin_sample/plugin.c diff --git a/CMakeLists.txt b/CMakeLists.txt index 606e87b..5f1bd98 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -70,7 +70,6 @@ CONFIGURE_FILE( @ONLY ) INSTALL(FILES ${CMAKE_CURRENT_SOURCE_DIR}/${fw_name}.pc DESTINATION ${LIB_INSTALL_DIR}/pkgconfig) -INSTALL(FILES ${CMAKE_SOURCE_DIR}/packaging/tizenid.service DESTINATION lib/systemd/system) SET(PLUGIN_PC_NAME ${external_plugin}) CONFIGURE_FILE( diff --git a/plugin_sample/CMakeLists.txt b/plugin_sample/CMakeLists.txt new file mode 100644 index 0000000..ef9edef --- /dev/null +++ b/plugin_sample/CMakeLists.txt @@ -0,0 +1,20 @@ +CMAKE_MINIMUM_REQUIRED(VERSION 2.6) + +SET(SYSINFO_PLUGIN system-info-external-plugin) +SET(SRCS plugin.c) + +INCLUDE(FindPkgConfig) +pkg_check_modules(${SYSINFO_PLUGIN} REQUIRED + dlog + capi-system-info-plugin +) + +FOREACH(flag ${${SYSINFO_PLUGIN}_CFLAGS}) + SET(EXTRA_CFLAGS "${EXTRA_CFLAGS} ${flag}") +ENDFOREACH(flag) + +SET(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${EXTRA_CFLAGS}") + +ADD_LIBRARY(${SYSINFO_PLUGIN} SHARED ${SRCS}) +TARGET_LINK_LIBRARIES(${SYSINFO_PLUGIN} ${${SYSINFO_PLUGIN}_LDFLAGS}) +INSTALL(TARGETS ${SYSINFO_PLUGIN} DESTINATION lib COMPONENT RuntimeLibraries) diff --git a/plugin_sample/LICENSE b/plugin_sample/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/plugin_sample/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/plugin_sample/packaging/system-info-external-plugin.manifest b/plugin_sample/packaging/system-info-external-plugin.manifest new file mode 100644 index 0000000..97e8c31 --- /dev/null +++ b/plugin_sample/packaging/system-info-external-plugin.manifest @@ -0,0 +1,5 @@ + + + + + diff --git a/plugin_sample/packaging/system-info-external-plugin.spec b/plugin_sample/packaging/system-info-external-plugin.spec new file mode 100644 index 0000000..ca32cd2 --- /dev/null +++ b/plugin_sample/packaging/system-info-external-plugin.spec @@ -0,0 +1,42 @@ +Name: system-info-external-plugin +Summary: External plugin for System information library +Version: 0.0.1 +Release: 1 +Group: System/Libraries +License: Apache License, Version 2.0 +Source0: %{name}-%{version}.tar.gz +Source1001: %{name}.manifest +BuildRequires: cmake +BuildRequires: pkgconfig(dlog) +BuildRequires: pkgconfig(capi-system-info-plugin) + +Requires(post): /sbin/ldconfig +Requires(postun): /sbin/ldconfig + +%description + +%prep +%setup -q +cp %{SOURCE1001} . + +%build +cmake . -DCMAKE_INSTALL_PREFIX=/usr + +make %{?jobs:-j%jobs} + +%install +rm -rf %{buildroot} + +%make_install +mkdir -p %{buildroot}/usr/share/license +cp -f LICENSE %{buildroot}/usr/share/license/%{name} + +%post -p /sbin/ldconfig + +%postun -p /sbin/ldconfig + + +%files +%manifest %{name}.manifest +/usr/share/license/%{name} +%{_libdir}/libsystem-info-external-plugin.so diff --git a/plugin_sample/plugin.c b/plugin_sample/plugin.c new file mode 100644 index 0000000..aec341d --- /dev/null +++ b/plugin_sample/plugin.c @@ -0,0 +1,92 @@ +/* + * Copyright (c) 2015 Samsung Electronics Co., Ltd All Rights Reserved + * + * 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. +*/ + + +#include +#include +#include +#include +#include +#include + +#include + +#ifndef API +#define API __attribute__ ((visibility("default"))) +#endif + +#ifdef LOG_TAG +#undef LOG_TAG +#endif +#define LOG_TAG "SYSTEM_INFO_PLUGIN" + +#define ARRAY_SIZE(name) (sizeof(name)/sizeof(name[0])) + +static int get_sample(char *buf, unsigned int len) +{ + snprintf(buf, len, "Sample value"); + return 0; +} + +static const struct external_system_info_key { + const char *key; + const char *tag; + const char *type; + int (*get_value)(char *buf, unsigned int len); +} system_info_key[] = { + { "http://developer.tizen.org/tizen/sample" , TAG_CUSTOM, TYPE_STR, get_sample }, +}; + +static int get_value_external(const char *tag, + const char *key, const char *type, + char *buf, unsigned int len) +{ + int i; + int key_len, tag_len, type_len; + + if (!tag || !key || !type || !buf) + return -EINVAL; + + key_len = strlen(key); + tag_len = strlen(tag); + type_len = strlen(type); + if (key_len == 0 || tag_len == 0 || type_len == 0) + return -EINVAL; + + for (i = 0 ; i < ARRAY_SIZE(system_info_key) ; i++) { + if (strncmp(system_info_key[i].type, type, type_len)) + continue; + if (strncmp(system_info_key[i].tag, tag, tag_len)) + continue; + if (strncmp(system_info_key[i].key, key, key_len)) + continue; + + if (system_info_key[i].get_value) + return system_info_key[i].get_value(buf, len); + } + + LOGE("Failed to find system info key in the plugin (%s)", key); + return -EINVAL; +} + +const system_info_external_plugin_interface external_plugin = { + .get_value_external = get_value_external, +}; + +API const system_info_external_plugin_interface *system_info_get_external_plugin_interface(void) +{ + return &external_plugin; +} diff --git a/src/tizenid/CMakeLists.txt b/src/tizenid/CMakeLists.txt index 6fdaf6a..2955e2c 100755 --- a/src/tizenid/CMakeLists.txt +++ b/src/tizenid/CMakeLists.txt @@ -28,3 +28,4 @@ ADD_EXECUTABLE(${TIZENID} ${SRCS}) TARGET_LINK_LIBRARIES(${TIZENID} ${tizenid_pkgs_LDFLAGS}) INSTALL(TARGETS ${TIZENID} DESTINATION bin) +INSTALL(FILES ${CMAKE_SOURCE_DIR}/packaging/tizenid.service DESTINATION lib/systemd/system) -- 2.7.4