diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..4947287 --- /dev/null +++ b/LICENSE @@ -0,0 +1,177 @@ + + 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 \ No newline at end of file diff --git a/README.md b/README.md index a7858c7..2827d3b 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,23 @@ 2、Provide the framework and interface for developers to develop wallpaper, and develop wallpaper applications; +**subsystem architecture diagram** +![](figures/subsystem_architecture.png "subsystem architecture diagram") + +#### Warehouse path +/base/miscservices/wallpaper + +#### Introduction to framework code +/base/miscservices/wallpaper +├── figures # architecture diagram +├── frameworks/innerkitsimpl # interface provided for app +├── interfaces # interface code provided by module +│ ├── innerkits # inter service interface +│ └── kits # napi interface +├── sa_profile # module contains the config files of system services and processes +├── services # implementation of wallpaper manager service +├── test # unit test of interface +└── utils # module contains log printing and constants for ordered commonEvent #### Interface Introduction **Table 1** Main method of wallpaper service @@ -51,6 +68,60 @@ +JS APIs instructions +``` +//get pixelmap callback with callback +wallpaper.getPixelMap(WALLPAPER_SYSTEM, function (err, data) { + console.info('wallpaperXTS ===> testGetPixelMapCallbackSystem err : ' + JSON.stringify(err)); + console.info('wallpaperXTS ===> testGetPixelMapCallbackSystem data : ' + JSON.stringify(data)); + if(err){ + expect(null).assertFail(); + } + if((data != undefined) && (data != null) && (data != '')){ + expect(true).assertTrue(); + } + }) + +//get pixelmap callback with Promise +wallpaper.getPixelMap(WALLPAPER_SYSTEM).then((data) => { + console.info('wallpaperXTS ===> testGetPixelMapPromiseSystem data : ' + data); + console.info('wallpaperXTS ===> testGetPixelMapPromiseSystem data : ' + JSON.stringify(data)); + if((data != undefined) && (data != null) && (data != '')){ + expect(true).assertTrue(); + } + }).catch((err) => { + console.info('wallpaperXTS ===> testGetPixelMapPromiseSystem err : ' + err); + console.info('wallpaperXTS ===> testGetPixelMapPromiseSystem err : ' + JSON.stringify(err)); + if(err){ + expect(null).assertFail(); + } + }); + +//set pixelmap callback with callback +wallpaper.setWallpaper(pixelmap, WALLPAPER_SYSTEM, function (err, data) { + console.info('wallpaperXTS ===> testSetWallpaperPixelMapCallbackSystem err : ' + JSON.stringify(err)); + console.info('wallpaperXTS ===> testSetWallpaperPixelMapCallbackSystem data : ' + JSON.stringify(data)); + if(err){ + expect(null).assertFail(); + } + if((data != undefined) && (data != null) && (data != '')){ + expect(true).assertTrue(); + } + }); + +//set pixelmap callback with Promise +wallpaper.setWallpaper(pixelmap, WALLPAPER_SYSTEM).then((data) => { + console.info('wallpaperXTS ===> testSetWallpaperPixelMapPromiseSystem data : ' + JSON.stringify(data)); + if((data != undefined) && (data != null) && (data != '')){ + expect(true).assertTrue(); + } + }).catch((err) => { + console.info('wallpaperXTS ===> testSetWallpaperPixelMapPromiseSystem err : ' + JSON.stringify(err)); + if(err){ + expect(null).assertFail(); + } + }); +``` #### Participation contribution diff --git a/README.zh.md b/README.zh.md index 98773bb..387b719 100644 --- a/README.zh.md +++ b/README.zh.md @@ -4,6 +4,28 @@ 1、为系统提供壁纸服务能力，支持系统显示、设置、切换壁纸等功能； 2、为开发者提供开发壁纸的框架和接口，支持开发者开发壁纸应用； +**图 1** 子系统架构图 +![](figures/subsystem_architecture_zh.png "子系统架构图") + +#### 仓路径 + +/base/miscservices/wallpaper + +#### 框架代码介绍 + +``` +/base/miscservices/wallpaper +├── figures # 构架图 +├── frameworks/innerkitsimpl # 对应用提供的接口 +├── interfaces/kits # 组件对外提供的接口代码 +│ ├── jskits # 服务间接口 +│ └── napi # js接口解析成napi接口 +├── profile # 组件包含的系统服务的配置文件和进程的配置文件 +├── services # 壁纸管理服务实现 +├── test # 接口的单元测试 +└── utils # 组件包含日志打印和有序公共事件定义的常量 +``` + #### 接口说明 **表 1** 壁纸服务开放的主要方法 @@ -49,6 +71,60 @@ +js 接口使用说明 +``` +//获取壁纸callback方式 +wallpaper.getPixelMap(WALLPAPER_SYSTEM, function (err, data) { + console.info('wallpaperXTS ===> testGetPixelMapCallbackSystem err : ' + JSON.stringify(err)); + console.info('wallpaperXTS ===> testGetPixelMapCallbackSystem data : ' + JSON.stringify(data)); + if(err){ + expect(null).assertFail(); + } + if((data != undefined) && (data != null) && (data != '')){ + expect(true).assertTrue(); + } + }) + +//获取壁纸Promise方式 +wallpaper.getPixelMap(WALLPAPER_SYSTEM).then((data) => { + console.info('wallpaperXTS ===> testGetPixelMapPromiseSystem data : ' + data); + console.info('wallpaperXTS ===> testGetPixelMapPromiseSystem data : ' + JSON.stringify(data)); + if((data != undefined) && (data != null) && (data != '')){ + expect(true).assertTrue(); + } + }).catch((err) => { + console.info('wallpaperXTS ===> testGetPixelMapPromiseSystem err : ' + err); + console.info('wallpaperXTS ===> testGetPixelMapPromiseSystem err : ' + JSON.stringify(err)); + if(err){ + expect(null).assertFail(); + } + }); + +//设置壁纸callback方式 +wallpaper.setWallpaper(pixelmap, WALLPAPER_SYSTEM, function (err, data) { + console.info('wallpaperXTS ===> testSetWallpaperPixelMapCallbackSystem err : ' + JSON.stringify(err)); + console.info('wallpaperXTS ===> testSetWallpaperPixelMapCallbackSystem data : ' + JSON.stringify(data)); + if(err){ + expect(null).assertFail(); + } + if((data != undefined) && (data != null) && (data != '')){ + expect(true).assertTrue(); + } + }); + +//设置壁纸Promise方式 +wallpaper.setWallpaper(pixelmap, WALLPAPER_SYSTEM).then((data) => { + console.info('wallpaperXTS ===> testSetWallpaperPixelMapPromiseSystem data : ' + JSON.stringify(data)); + if((data != undefined) && (data != null) && (data != '')){ + expect(true).assertTrue(); + } + }).catch((err) => { + console.info('wallpaperXTS ===> testSetWallpaperPixelMapPromiseSystem err : ' + JSON.stringify(err)); + if(err){ + expect(null).assertFail(); + } + }); +``` #### 参与贡献 diff --git a/figures/subsystem_architecture.png b/figures/subsystem_architecture.png new file mode 100644 index 0000000..9d2f35c Binary files /dev/null and b/figures/subsystem_architecture.png differ diff --git a/figures/subsystem_architecture_zh.png b/figures/subsystem_architecture_zh.png new file mode 100644 index 0000000..5ab1bd3 Binary files /dev/null and b/figures/subsystem_architecture_zh.png differ diff --git a/frameworks/kits/extension/src/js_wallpaper_extension.cpp b/frameworks/kits/extension/src/js_wallpaper_extension.cpp index 6788e4f..bc59e26 100644 --- a/frameworks/kits/extension/src/js_wallpaper_extension.cpp +++ b/frameworks/kits/extension/src/js_wallpaper_extension.cpp @@ -31,7 +31,6 @@ namespace OHOS { namespace AbilityRuntime { namespace { constexpr size_t ARGC_ONE = 1; -constexpr size_t ARGC_TWO = 2; } JsWallpaperExtension* JsWallpaperExtension::jsWallpaperExtension = NULL; using namespace OHOS::AppExecFwk; @@ -224,17 +223,6 @@ void JsWallpaperExtension::OnCommand(const AAFwk::Want &want, bool restart, int __func__, restart ? "true" : "false", startId); - // wrap want - HandleScope handleScope(jsRuntime_); - NativeEngine* nativeEngine = &jsRuntime_.GetNativeEngine(); - napi_value napiWant = OHOS::AppExecFwk::WrapWant(reinterpret_cast(nativeEngine), want); - NativeValue* nativeWant = reinterpret_cast(napiWant); - // wrap startId - napi_value napiStartId = nullptr; - napi_create_int32(reinterpret_cast(nativeEngine), startId, &napiStartId); - NativeValue* nativeStartId = reinterpret_cast(napiStartId); - NativeValue* argv[] = {nativeWant, nativeStartId}; - CallObjectMethod("onRequest", argv, ARGC_TWO); HILOG_INFO("%{public}s end.", __func__); } diff --git a/services/src/wallpaper_service.cpp b/services/src/wallpaper_service.cpp index d879497..8ed5ad5 100644 --- a/services/src/wallpaper_service.cpp +++ b/services/src/wallpaper_service.cpp @@ -251,8 +251,7 @@ int WallpaperService::GetDisplayId() std::string WallpaperService::GetWallpaperDir(int userId) { - std::string sWallpaperPath = "/data"; - sWallpaperPath = WALLPAPER_USERID_PATH + std::to_string(userId_); + std::string sWallpaperPath = WALLPAPER_USERID_PATH + std::to_string(userId_); return sWallpaperPath; } @@ -462,6 +461,8 @@ bool WallpaperService::SetWallpaperByMap(int fd, int wallpaperType, int length) int32_t bufsize = read(fd, paperBuf, length); if (bufsize <= 0) { HILOG_ERROR("read fd faild"); + delete[] paperBuf; + close(fd); return false; } close(fd); @@ -476,9 +477,11 @@ bool WallpaperService::SetWallpaperByMap(int fd, int wallpaperType, int length) HILOG_INFO(" CreateImageSource"); std::unique_ptr imageSource = OHOS::Media::ImageSource::CreateImageSource(std::move(tmpStream), opts, errorCode); - + delete stringBuf; + delete[] paperBuf; if (errorCode != 0) { HILOG_ERROR("ImageSource::CreateImageSource failed,errcode= %{public}d", errorCode); + mtx.unlock(); return false; } @@ -487,11 +490,13 @@ bool WallpaperService::SetWallpaperByMap(int fd, int wallpaperType, int length) tmp = imageSource->CreatePixelMap(decodeOpts, errorCode); if (errorCode != 0) { HILOG_ERROR("ImageSource::CreatePixelMap failed,errcode= %{public}d", errorCode); + mtx.unlock(); return false; } int64_t packedSize = WritePixelMapToFile(url, std::move(tmp)); if (packedSize <= 0) { HILOG_ERROR("WritePixelMapToFile faild"); + mtx.unlock(); return false; } mtx.unlock(); @@ -503,28 +508,41 @@ bool WallpaperService::SetWallpaperByFD(int fd, int wallpaperType, int length) HILOG_INFO("SetWallpaperByFD"); std::string url = wallpaperTmpFullPath_; if (length == 0 || length > FOO_MAX_LEN) { + close(fd); + mtx.unlock(); return false; } char* paperBuf = new char[length]; int readSize = read(fd, paperBuf, length); if (readSize <= 0) { HILOG_ERROR("read from fd fail"); + delete[] paperBuf; + close(fd); + mtx.unlock(); return false; } int fdw = open(url.c_str(), O_WRONLY | O_CREAT, 0770); if (fdw == -1) { HILOG_ERROR("WallpaperService:: fdw fail"); + delete[] paperBuf; + close(fd); + mtx.unlock(); return false; } int writeSize = write(fdw, paperBuf, length); if (writeSize <= 0) { HILOG_ERROR("write to fdw fail"); + close(fd); + close(fdw); + delete[] paperBuf; + mtx.unlock(); return false; } close(fd); close(fdw); mtx.unlock(); + delete[] paperBuf; return SetWallpaperBackupData(url, wallpaperType); } @@ -534,10 +552,12 @@ bool WallpaperService::SetWallpaperBackupData(std::string uriOrPixelMap, int wal mtx.lock(); HILOG_INFO("set wallpaper and backup data Start."); if (wallpaperType != WALLPAPER_LOCKSCREEN && wallpaperType != WALLPAPER_SYSTEM) { + mtx.unlock(); return false; } if (!OHOS::FileExists(uriOrPixelMap)) { + mtx.unlock(); return false; } WallpaperData tmpWP(userId_, @@ -549,6 +569,7 @@ bool WallpaperService::SetWallpaperBackupData(std::string uriOrPixelMap, int wal bool ret = GetWallpaperSafeLocked(userId_, wallpaperType, tmpWP); if (!ret) { HILOG_ERROR("GetWallpaperSafeLocked failed !"); + mtx.unlock(); return false; } @@ -572,9 +593,11 @@ bool WallpaperService::SetWallpaperBackupData(std::string uriOrPixelMap, int wal callbackProxy->OnCall(wallpaperType); } } else { + mtx.unlock(); return false; } if (remove(uriOrPixelMap.c_str()) < 0) { + mtx.unlock(); return false; } mtx.unlock(); @@ -596,37 +619,47 @@ IWallpaperService::mapFD WallpaperService::GetPixelMap(int wallpaperType) if (!OHOS::FileExists(filePath)) { HILOG_ERROR("file is not exist!"); + mtx.unlock(); return mapFd; } FILE *pixmap = fopen(filePath.c_str(), "rb"); if (pixmap == nullptr) { HILOG_ERROR("fopen faild"); + mtx.unlock(); return mapFd; } int fend = fseek(pixmap, 0, SEEK_END); if (fend != 0) { HILOG_ERROR("fseek faild"); + fclose(pixmap); + mtx.unlock(); return mapFd; } int length = ftell(pixmap); if (length <= 0) { HILOG_ERROR("ftell faild"); + fclose(pixmap); + mtx.unlock(); return mapFd; } mapFd.size = length; int fset = fseek(pixmap, 0, SEEK_SET); if (fset != 0) { HILOG_ERROR("fseek faild"); + fclose(pixmap); + mtx.unlock(); return mapFd; } int closeRes = fclose(pixmap); if (closeRes != 0) { HILOG_ERROR("fclose faild"); + mtx.unlock(); return mapFd; } int fd = open(filePath.c_str(), O_RDONLY, 0770); if (fd < 0) { HILOG_ERROR("open faild"); + mtx.unlock(); return mapFd; } mapFd.fd = fd; diff --git a/services/src/wallpaper_service_stub.cpp b/services/src/wallpaper_service_stub.cpp index 5a18c8c..c42231e 100644 --- a/services/src/wallpaper_service_stub.cpp +++ b/services/src/wallpaper_service_stub.cpp @@ -75,7 +75,6 @@ int32_t WallpaperServiceStub::OnRemoteRequest(uint32_t code, MessageParcel &data } int32_t WallpaperServiceStub::OnSetWallpaperByMap(MessageParcel &data, MessageParcel &reply) { - int32_t ret = -1; HILOG_INFO("WallpaperServiceStub::SetWallpaperUri start."); int fd = data.ReadFileDescriptor(); @@ -84,12 +83,11 @@ int32_t WallpaperServiceStub::OnSetWallpaperByMap(MessageParcel &data, MessagePa bool bFlag = SetWallpaperByMap(fd, wallpaperType, length); reply.WriteBool(bFlag); - ret = bFlag == true ? 0:-1; + int32_t ret = bFlag == true ? 0:-1; return ret; } int32_t WallpaperServiceStub::OnSetWallpaperUriByFD(MessageParcel &data, MessageParcel &reply) { -int32_t ret = -1; HILOG_INFO("WallpaperServiceStub::SetWallpaperUri start."); int fd = data.ReadFileDescriptor(); @@ -100,7 +98,7 @@ HILOG_INFO("SetWallpaperByFD start"); bool bFlag = SetWallpaperByFD(fd, wallpaperType, length); reply.WriteBool(bFlag); -ret = bFlag == true ? 0:-1; +int32_t ret = bFlag == true ? 0:-1; return ret; }