1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
|
/*
* Copyright (C) 2013-2014 Intel Corporation.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* Authors:
* José Bollo <jose.bollo@open.eurogiciel.org>
* Stéphane Desneux <stephane.desneux@open.eurogiciel.org>
* Jean-Benoit Martin <jean-benoit.martin@open.eurogiciel.org>
*
*/
#ifndef LIBTIZEN_PLATFORM_WRAPPER_PRIVATE
#define LIBTIZEN_PLATFORM_WRAPPER_PRIVATE
#ifdef __cplusplus
extern "C" {
#endif
#include <sys/types.h>
#include <tzplatform_variables.h>
//=================================================================================
//======================== COMMON APIs (No context) ===============================
//=================================================================================
/*
Return the count of variables.
*/
extern
int tzplatform_getcount();
/*
Return the name of the variable 'id' as a string.
Return NULL if 'id' is invalid.
*/
extern
const char* tzplatform_getname(enum tzplatform_variable id);
/*
Return the id of the variable of 'name'.
Return _TZPLATFORM_VARIABLES_INVALID_ if 'name' doesn't match a
valid variable name.
*/
extern
enum tzplatform_variable tzplatform_getid(const char *name);
//=================================================================================
//====================== GLOBAL APIs (default global context) =====================
//=================================================================================
/*
Enforces the removal of the previously evaluated tizen platform variables.
Call this function in case of changing of user inside the application.
*/
extern
void tzplatform_reset();
/*
Set the user used for UID/EUID/USER/EUSER computations.
Using uid==(uid_t)-1 reset the context as if tzplatform_reset_user
was called.
Returns 0 if uid is valid or -1 if not valid.
*/
extern
int tzplatform_set_user(uid_t uid);
/*
*/
extern
uid_t tzplatform_get_user();
/*
Reset the user context to use the values returned by
getuid and geteuid.
*/
extern
void tzplatform_reset_user();
/*
Return the integer value of the tizen plaform variable 'id'.
*/
extern
int tzplatform_getenv_int(enum tzplatform_variable id);
/*
Return the string resulting of the concatenation of string value of the
tizen plaform variable 'id' and the given string 'str'.
The returned value is an allocated unique string that MUST not be freed.
Can return NULL in case of internal error.
Example:
if TZ_SYS_HOME == "/opt/home" then calling
tzplatform_mkstr(TZ_SYS_HOME,"-yes")
will return "/opt/home-yes"
*/
extern
const char* tzplatform_mkstr(enum tzplatform_variable id, const char *str);
/*
Return the string resulting of the path-concatenation of string value of the
tizen plaform variable 'id' and the given strings 'path' and 'path2'.
path-concatenation is the concatenation taking care of / characters.
The returned value is an allocated unique string that MUST not be freed.
Can return NULL in case of internal error.
Example:
if TZ_SYS_HOME == "/opt/home" then calling
tzplatform_mkpath3(TZ_SYS_HOME,"yes","no")
will return "/opt/home/yes/no"
*/
extern
const char* tzplatform_mkpath3(enum tzplatform_variable id, const char *path,
const char *path2);
/*
Return the string resulting of the path-concatenation of string value of the
tizen plaform variable 'id' and the given strings 'path', 'path2' and 'path3'.
path-concatenation is the concatenation taking care of / characters.
The returned value is an allocated unique string that MUST not be freed.
Can return NULL in case of internal error.
Example:
if TZ_SYS_HOME == "/opt/home" then calling
tzplatform_mkpath4(TZ_SYS_HOME,"yes","no","/maybe")
will return "/opt/home/yes/no/maybe"
*/
extern
const char* tzplatform_mkpath4(enum tzplatform_variable id, const char *path,
const char *path2, const char *path3);
/*
Return the uid for a given user name, stored in variable <id>
Retun -1 in case of error.
Example:
if TZ_USER_NAME=="app" then calling:
tzplatform_getuid(TZ_USER_NAME)
will return the uid of the user 'app'
*/
extern
uid_t tzplatform_getuid(enum tzplatform_variable id);
/*
Return the gid for a given user name, stored in variable <id>
Retun -1 in case of error.
Example:
if TZ_USER_NAME=="app" then calling:
tzplatform_getuid(TZ_USER_NAME)
will return the gid of the user 'app'
*/
extern
gid_t tzplatform_getgid(enum tzplatform_variable id);
//=================================================================================
//============================ UID-based APIs =====================================
//=================================================================================
/*
In the following APIs, a 'uid' parameter is added to the form of GLOBAL APIs.
How-to-use is the same with GLOBAL APIs, but contexts are internally created and set for each uid.
uid should be one of root(0), owner(5001), and so on.
*/
extern
const char* tzplatform_uid_getenv(uid_t uid, enum tzplatform_variable id);
extern
const char* tzplatform_uid_mkpath(uid_t uid, enum tzplatform_variable id, const char *path);
extern
const char* tzplatform_uid_mkpath3(uid_t uid, enum tzplatform_variable id, const char *path,
const char *path2);
extern
const char* tzplatform_uid_mkpath4(uid_t uid, enum tzplatform_variable id, const char *path,
const char *path2, const char *path3);
//=================================================================================
//============================ CONTEXTUAL APIs ====================================
//=================================================================================
struct tzplatform_context;
/*
Creates a new platform 'context'.
Return 0 in case of success or a negative value in case of error.
*/
extern
int tzplatform_context_create(struct tzplatform_context **context);
/*
Destroys the platform 'context' previously created with 'tzplatform_context_create'.
The destroyed context must not be used after calling this function.
*/
extern
void tzplatform_context_destroy(struct tzplatform_context *context);
/*
Enforces the removal of the previously evaluated tizen platform variables.
*/
extern
void tzplatform_context_reset(struct tzplatform_context *context);
/*
Set the user used for UID/EUID/USER/EUSER computations.
Using uid==(uid_t)-1 reset the context as if tzplatform_context_reset_user
was called.
Returns 0 if uid is valid or -1 if not valid.
*/
extern
int tzplatform_context_set_user(struct tzplatform_context *context, uid_t uid);
/*
Get the user set to the context.
*/
extern
uid_t tzplatform_context_get_user(struct tzplatform_context *context);
/*
Reset the user context to use the values returned by
getuid and geteuid.
*/
extern
void tzplatform_context_reset_user(struct tzplatform_context *context);
/*
Return the read-only string value of the tizen plaform variable 'id'.
The returned value is an allocated unique string that MUST not be freed.
Can return NULL in case of internal error or when 'id' isn't defined.
*/
extern
const char* tzplatform_context_getenv(struct tzplatform_context *context,
enum tzplatform_variable id);
/*
Return the integer value of the tizen plaform variable 'id'.
*/
extern
int tzplatform_context_getenv_int(struct tzplatform_context *context,
enum tzplatform_variable id);
/*
Return the string resulting of the concatenation of string value of the
tizen plaform variable 'id' and the given string 'str'.
The returned value is an allocated unique string that MUST not be freed.
Can return NULL in case of internal error.
Example:
if TZ_SYS_HOME == "/opt/home" then calling
tzplatform_context_mkstr(context, TZ_SYS_HOME,"-yes")
will return "/opt/home-yes"
*/
extern
const char* tzplatform_context_mkstr(struct tzplatform_context *context,
enum tzplatform_variable id, const char *str);
/*
Return the string resulting of the path-concatenation of string value of the
tizen plaform variable 'id' and the given string 'path'.
path-concatenation is the concatenation taking care of / characters.
The returned value is an allocated unique string that MUST not be freed.
Can return NULL in case of internal error.
Example:
if TZ_SYS_HOME == "/opt/home" then calling
tzplatform_context_mkpath(context, TZ_SYS_HOME,"yes")
will return "/opt/home/yes"
*/
extern
const char* tzplatform_context_mkpath(struct tzplatform_context *context,
enum tzplatform_variable id, const char *path);
/*
Return the string resulting of the path-concatenation of string value of the
tizen plaform variable 'id' and the given strings 'path' and 'path2'.
path-concatenation is the concatenation taking care of / characters.
The returned value is an allocated unique string that MUST not be freed.
Can return NULL in case of internal error.
Example:
if TZ_SYS_HOME == "/opt/home" then calling
tzplatform_context_mkpath3(context, TZ_SYS_HOME,"yes","no")
will return "/opt/home/yes/no"
*/
extern
const char* tzplatform_context_mkpath3(struct tzplatform_context *context,
enum tzplatform_variable id, const char *path,
const char *path2);
/*
Return the string resulting of the path-concatenation of string value of the
tizen plaform variable 'id' and the given strings 'path', 'path2' and 'path3'.
path-concatenation is the concatenation taking care of / characters.
The returned value is an allocated unique string that MUST not be freed.
Can return NULL in case of internal error.
Example:
if TZ_SYS_HOME == "/opt/home" then calling
tzplatform_context_mkpath4(context, TZ_SYS_HOME,"yes","no","/maybe")
will return "/opt/home/yes/no/maybe"
*/
extern
const char* tzplatform_context_mkpath4(struct tzplatform_context *context,
enum tzplatform_variable id, const char *path,
const char *path2, const char *path3);
/*
Return the uid for a given user name, stored in variable <id>
Retun -1 in case of error.
Example:
if TZ_USER_NAME=="app" then calling:
tzplatform_context_getuid(context, TZ_USER_NAME)
will return the uid of the user 'app'
*/
extern
uid_t tzplatform_context_getuid(struct tzplatform_context *context, enum tzplatform_variable id);
/*
Return the gid for a given user name, stored in variable <id>
Retun -1 in case of error.
Example:
if TZ_USER_NAME=="app" then calling:
tzplatform_context_getuid(context, TZ_USER_NAME)
will return the gid of the user 'app'
*/
extern
gid_t tzplatform_context_getgid(struct tzplatform_context *context, enum tzplatform_variable id);
/*
Return 1 if given uid is in the system admin group (named "system")
Return 0 if not
Return -1 in case of error.
Example:
tzplatform_has_system_group(1000)
will return 0 or 1 depends on right of given uid.
NOTE :
* If you pass the -1 value to this function it will take the current uid given
* by the POSIX function getuid();
*** WARNING : ***
* This is a temporary feature
* This will be managed by Cynara
*/
extern
int tzplatform_has_system_group(uid_t uid);
#ifdef __cplusplus
}
#endif
#endif /* LIBTIZEN_PLATFORM_WRAPPER_PRIVATE */
|
