Merge "Resolve the "Klocwork" detected defect and add debug feature." into tizen_2.2
[platform/framework/native/appfw.git] / src / app / FApp_AppInfo.cpp
1 //
2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
3 //
4 // Licensed under the Apache License, Version 2.0 (the License);
5 // you may not use this file except in compliance with the License.
6 // You may obtain a copy of the License at
7 //
8 //     http://www.apache.org/licenses/LICENSE-2.0
9 //
10 // Unless required by applicable law or agreed to in writing, software
11 // distributed under the License is distributed on an "AS IS" BASIS,
12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 // See the License for the specific language governing permissions and
14 // limitations under the License.
15 //
16
17 /**
18  * @file         FApp_AppInfo.cpp
19  * @brief       This is the implementation for the _AppInfo.cpp class.
20  */
21
22 #include <cstdio>
23 #include <cstring>
24 #include <unistd.h>
25 #include <limits.h>
26 #include <new>
27 #include <fcntl.h>
28 #include <unique_ptr.h>
29
30 #include <appinfo.h>
31
32 #include <FBaseErrors.h>
33 #include <FAppPkgPackageInfo.h>
34 #include <FBaseSysLog.h>
35
36 #include <FBaseRt_Process.h>
37 #include <FBase_StringConverter.h>
38
39 #include "FAppPkg_PackageInfoImpl.h"
40 #include "FApp_AppInfo.h"
41
42 using namespace Tizen::App::Package;
43 using namespace Tizen::Base;
44 using namespace Tizen::Base::Runtime;
45
46 extern "C"
47 {
48 void _OSP_EXPORT_
49 AppInfo_Update(void)
50 {
51         result r = Tizen::App::_AppInfo::GetInstance()->Construct();
52         if (IsFailed(r))
53         {
54                 SysLogException(NID_APP, E_SYSTEM, "Application initialization failure.");
55                 fprintf(stderr, "Application initialization failure.\n");
56
57                 _Process::Exit(-1);
58         }
59 }
60
61 void _OSP_EXPORT_
62 InitAppInfo(const char* packageId, const char* svcId, int argc, char* pArgv[], int fd)
63 {
64         AppInfo_Update();
65 }
66
67 void _OSP_EXPORT_
68 InitWebAppInfo(const char* appId, const char* rootPath)
69 {
70         result r = Tizen::App::_AppInfo::GetInstance()->Construct(appId, rootPath, Tizen::App::_APP_TYPE_WEB_APP);
71         if (IsFailed(r))
72         {
73                 SysLogException(NID_APP, E_SYSTEM, "Application initialization failure for %s.", appId);
74                 fprintf(stderr, "Application initialization failure for %s.\n", appId);
75
76                 _Process::Exit(-1);
77         }
78 }
79
80 extern void FBase_Initialize(void);
81
82 }
83
84 namespace Tizen { namespace App
85 {
86
87 const int MAX_APIVERSION = 8;
88 const int MAX_APPID = 10;
89 const char PACKAGE_PATH_FORMAT[] = "/opt/usr/apps/0000000000/";
90 const char PATH_ROOT[] = "/opt/usr/apps/";
91 const char APPINFO_FILE_PATH[] = "info/version.info";
92 const char COMPAT_FILE_PATH[] = "info/compat.info";
93 const char VIRTUAL_ROOT_FILE_PATH[] = "info/virtual.info";
94 const char TYPE_FILE_PATH[] = "info/type.info";
95 const char SUBMODE_NAME[] = "_AppControl";
96
97
98 _AppInfo::_AppInfo(void)
99         : __appState(TERMINATED)
100         , __appType(_APP_TYPE_NONE)
101         , __appRootDirFd(-1)
102         , __appHandlerType(_APP_HANDLER_NONE)
103         , __parentWindowHandle(-1)
104         , __pAppName(null)
105         , __pAppVersion(null)
106         , __isPackageInfoInitialized(false)
107         , __isSubMode(false)
108         , __isVirtualRoot(false)
109         , __isMultiWindow(false)
110 {
111         SysStaticAssert(sizeof(pid_t) == sizeof(int));
112
113         //FBase_Initialize();
114 }
115
116 _AppInfo::~_AppInfo(void)
117 {
118         delete __pAppName;
119         delete __pAppVersion;
120
121         // closing may or may not succeed
122         close(__appRootDirFd);
123 }
124
125 _AppInfo*
126 _AppInfo::GetInstance(void)
127 {
128         static _AppInfo info;
129
130         return &info;
131 }
132
133
134 result
135 _AppInfo::Construct(void)
136 {
137         SysAssertf(appinfo_is_initialized() == 1, "appinfo is not initialized.");
138
139         FBase_Initialize();
140
141         const char* pPackageId = appinfo_get_packageid();
142         const char* pExecName = appinfo_get_execname();
143
144
145         if (strncmp(pExecName, SUBMODE_NAME, strlen(SUBMODE_NAME)) == 0)
146         {
147                 SysLog(NID_APP, "Handling for submode.");
148                 const String& name = _PackageManagerImpl::GetInstance()->GetDefaultAppExecutableName(String(pPackageId));
149
150                 __isSubMode = true;
151
152                 std::unique_ptr<char[]> pActualExec(_StringConverter::CopyToCharArrayN(name));
153                 appinfo_update_submode_execname_and_appid(pActualExec.get());
154                 SysLog(NID_APP, "Executable name is changed to %s.", pActualExec.get());
155         }
156
157         result r = E_SUCCESS;
158         FILE* pFile = NULL;
159
160         {
161                 char appInfoPath[PATH_MAX] = {0, };
162
163                 int len = strlen(PACKAGE_PATH_FORMAT);
164                 strncpy(appInfoPath, PACKAGE_PATH_FORMAT, len);
165                 appInfoPath[len] = '\0';
166                 strncpy(appInfoPath + strlen(PATH_ROOT), pPackageId, MAX_APPID);
167
168                 // app root directory file descriptor
169                 __appRootDirFd = open(appInfoPath, O_RDONLY | O_CLOEXEC | O_DIRECTORY);
170                 __appRootPath = appInfoPath;
171                 
172                 SysLog(NID_APP, "App root directory (%s:%d) open.", appInfoPath, __appRootDirFd);
173
174                 int fd = openat(__appRootDirFd, APPINFO_FILE_PATH, O_RDONLY);
175                 SysAssertf(fd != -1, "Failed to open info file, errno: %d (%s)", errno, strerror(errno));
176
177                 pFile = fdopen(fd, "r");
178                 SysTryCatch(NID_APP, pFile != NULL, r = E_SYSTEM, E_SYSTEM, "[E_SYSTEM] Opening appinfo file (%s) failed : %s.", appInfoPath, strerror(errno));
179
180                 // sdcard
181                 char sdInfoPath[PATH_MAX] = {0, };
182                 strncpy(sdInfoPath, "/opt/storage/sdcard/app2sd/", strlen("/opt/storage/sdcard/app2sd/"));
183                 strncat(sdInfoPath, pPackageId, MAX_APPID);
184
185                 int sdFd = open(sdInfoPath, O_RDONLY);
186                 SysLog(NID_APP, "sd root directory (%s:%d) open.", sdInfoPath, sdFd);
187
188                 char apiVersion[MAX_APIVERSION] = {0, };
189                 char* pRet = fgets(apiVersion, MAX_APIVERSION - 1, pFile);
190                 SysTryCatch(NID_APP, pRet != NULL, r = E_SYSTEM, E_SYSTEM, "[E_SYSTEM] Reading appinfo file (%s) failed : %s.", appInfoPath, strerror(errno));
191
192                 fclose(pFile);
193                 // fd is closed when the stream is closed by fclose();
194
195                 appinfo_set_api_version(appinfo_get_api_version_from_str(apiVersion));
196
197                 // to reduce package manager overhead, libc API is used
198                 if (faccessat(__appRootDirFd, COMPAT_FILE_PATH, F_OK, 0) == 0)
199                 {
200                         SysLog(NID_APP, "OSP compatibility mode on.");
201                         appinfo_set_compat(1);
202                 }
203
204                 if (faccessat(__appRootDirFd, VIRTUAL_ROOT_FILE_PATH, F_OK, 0) == 0)
205                 {
206                         SysLog(NID_APP, "virtual root mode on.");
207                         __isVirtualRoot = true;
208                 }
209
210                 // type file may does not exist
211                 fd = openat(__appRootDirFd, TYPE_FILE_PATH, O_RDONLY);
212                 if (fd > 0)
213                 {
214                         pFile = fdopen(fd, "r");
215                         if (pFile)
216                         {
217                                 int i;
218                                 int line = fscanf(pFile, "%d", &i);
219
220                                 fclose(pFile);
221                                 // fd is closed when the stream is closed by fclose();
222
223                                 __appType = _APP_TYPE_UI_APP | i;
224                                 SysLog(NID_APP, "Reading app type %d -> %d", i, __appType);
225                         }
226                 }
227
228                 SysLog(NID_APP, "AppInfo [%s][%s.%s][%d].", appinfo_get_appid(), appinfo_get_packageid(), appinfo_get_execname(), appinfo_get_api_version());
229         }
230
231         return E_SUCCESS;
232
233 CATCH:
234         if (pFile != NULL)
235         {
236                 fclose(pFile);
237         }
238
239         return r;
240 }
241
242
243 // initialize app context only
244 result
245 _AppInfo::Construct(const char* appId, const char* appRoot, _AppType type)
246 {
247         SysAssertf(appId != null, "Valid appId required to launch application.");
248
249         FBase_Initialize();
250
251         if (appinfo_is_initialized() == 0)
252         {
253                 appinfo_init(appId, 0);
254         }
255
256         __appRootDirFd = open(appRoot, O_RDONLY | O_CLOEXEC | O_DIRECTORY);
257         appinfo_set_api_version(APP_INFO_VERSION_2_2);
258         __appType = type;
259
260         __appRootPath = appRoot;
261         if (__appRootPath[__appRootPath.GetLength()] != L'/')
262         {
263                 __appRootPath.Append(L'/');
264         }
265
266         SysLog(NID_APP, "AppInfo [%s][%s.%s][%ls][%d].", appinfo_get_appid(), appinfo_get_packageid(), appinfo_get_execname()), __appRootPath.GetPointer(), appinfo_get_api_version();
267
268         return E_SUCCESS;
269 }
270
271
272 result
273 _AppInfo::UpdateAppInfoFromPackageInfo(const PackageId& packageId)
274 {
275         _PackageManagerImpl* pPkg = _PackageManagerImpl::GetInstance();
276         SysTryReturnResult(NID_APP, pPkg != null, E_INVALID_STATE, "Invalid PackageManager instance.");
277
278         result r = E_SUCCESS;
279         std::unique_ptr<PackageInfo> pInfo(pPkg->GetPackageInfoN(packageId));
280         SysTryReturn(NID_APP, pInfo != null, r, r, "[%s] Propagating.", GetErrorMessage(r));
281
282         const _PackageInfoImpl* pPkgInfo = _PackageInfoImpl::GetInstance(pInfo.get());
283         SysTryReturnResult(NID_APP, pPkgInfo != null, E_INVALID_STATE, "Invalid PackageInfo instance.");
284
285         delete __pAppName;
286         __pAppName = new (std::nothrow) String(pPkgInfo->GetName());
287         SysTryCatch(NID_APP, __pAppName != null, r = E_OUT_OF_MEMORY, E_OUT_OF_MEMORY, "[E_OUT_OF_MEMORY] AppName allocation failure.");
288
289         delete __pAppVersion;
290         __pAppVersion = new (std::nothrow) String(pPkgInfo->GetVersion());
291         SysTryCatch(NID_APP, __pAppVersion != null, r = E_OUT_OF_MEMORY, E_OUT_OF_MEMORY, "[E_OUT_OF_MEMORY] AppVersion allocation failure.");
292
293         __isPackageInfoInitialized = true;
294
295         SysLog(NID_APP, "AppInfo updated [%ls][%ls].", __pAppName->GetPointer(), __pAppVersion->GetPointer());
296
297         return r;
298
299 CATCH:
300         delete __pAppName;
301         __pAppName = null;
302
303         delete __pAppVersion;
304         __pAppVersion = null;
305
306         return r;
307 }
308
309
310 _ApiVersion
311 _AppInfo::GetApiVersion(void)
312 {
313         return static_cast<_ApiVersion>(appinfo_get_api_version());
314 }
315
316
317 bool
318 _AppInfo::IsOspCompat(void)
319 {
320         return (appinfo_is_compat() == 1);
321 }
322
323 bool
324 _AppInfo::IsVirtualRoot(void)
325 {
326         return GetInstance()->__isVirtualRoot;
327 }
328
329 result
330 _AppInfo::SetApiVersion(_ApiVersion v)
331 {
332         appinfo_set_api_version(static_cast<app_info_version_e>(v));
333         return E_SUCCESS;
334 }
335
336
337 int
338 _AppInfo::GetProcessId(void)
339 {
340         static int processId = static_cast<int>(getpid());
341
342         return processId;
343 }
344
345 int
346 _AppInfo::GetAppRootDirFd(void)
347 {
348         return GetInstance()->__appRootDirFd;
349 }
350
351
352 AppId
353 _AppInfo::GetApplicationId(void)
354 {
355         return String(appinfo_get_appid());
356 }
357
358
359 PackageId
360 _AppInfo::GetPackageId(void)
361 {
362         return String(appinfo_get_packageid());
363 }
364
365
366 String
367 _AppInfo::GetAppExecutableName(void)
368 {
369         return String(appinfo_get_execname());
370 }
371
372
373 bool
374 _AppInfo::IsSubMode(void)
375 {
376         return GetInstance()->__isSubMode;
377 }
378
379
380 String
381 _AppInfo::GetAppName(void)
382 {
383         if (!GetInstance()->__isPackageInfoInitialized)
384         {
385                 const String& packageId = GetInstance()->GetPackageId();
386
387                 SysAssertf(!packageId.IsEmpty(), "PackageId is not initialized properly.");
388
389                 result r = GetInstance()->UpdateAppInfoFromPackageInfo(packageId);
390                 SysAssertf(r == E_SUCCESS, "AppInfo update failure due to package problem.");
391         }
392
393         return *(GetInstance()->__pAppName);
394 }
395
396
397 String
398 _AppInfo::GetAppRootPath(void)
399 {
400         return GetInstance()->__appRootPath;
401 }
402
403 String
404 _AppInfo::GetAppVersion(void)
405 {
406         if (!GetInstance()->__isPackageInfoInitialized)
407         {
408                 const String& packageId = GetInstance()->GetPackageId();
409
410                 SysAssertf(!packageId.IsEmpty(), "PackageId is not initialized properly.");
411
412                 result r = GetInstance()->UpdateAppInfoFromPackageInfo(packageId);
413                 SysAssertf(r == E_SUCCESS, "AppInfo update failure due to package problem.");
414         }
415
416         return *(GetInstance()->__pAppVersion);
417 }
418
419
420 AppState
421 _AppInfo::GetAppState(void)
422 {
423         return GetInstance()->__appState;
424 }
425
426
427 void
428 _AppInfo::SetAppState(AppState appState)
429 {
430         GetInstance()->__appState = appState;
431 }
432
433
434 int
435 _AppInfo::GetAppType(void)
436 {
437         return GetInstance()->__appType;
438 }
439
440
441 void
442 _AppInfo::SetAppType(_AppType appType)
443 {
444         GetInstance()->__appType |= appType;
445 }
446
447
448 int
449 _AppInfo::GetAppHandlerType(void)
450 {
451         return GetInstance()->__appHandlerType;
452 }
453
454
455 void
456 _AppInfo::SetAppHandlerType(int appHandlerType)
457 {
458         GetInstance()->__appHandlerType = appHandlerType;
459 }
460
461
462 unsigned int
463 _AppInfo::GetParentWindowHandle(void)
464 {
465         return GetInstance()->__parentWindowHandle;
466 }
467
468
469 void
470 _AppInfo::SetParentWindowHandle(unsigned int handle)
471 {
472         GetInstance()->__parentWindowHandle = handle;
473 }
474
475
476 void
477 _AppInfo::UpdatePackageInfo(bool update)
478 {
479         GetInstance()->__isPackageInfoInitialized = !update;
480 }
481
482 bool
483 _AppInfo::IsMultiWindow(void)
484 {
485         return GetInstance()->__isMultiWindow;
486 }
487
488 void
489 _AppInfo::SetMultiWindow(bool enable)
490 {
491         GetInstance()->__isMultiWindow = enable;
492 }
493
494 }} // Tizen::App