33a588e850305d7fdcfecbd657b465c877edbecb
[framework/appfw/alarm-manager.git] / include / alarm-internal.h
1 /*
2  *  alarm-manager
3  *
4  * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
5  *
6  * Contact: Venkatesha Sarpangala <sarpangala.v@samsung.com>, Jayoun Lee <airjany@samsung.com>,
7  * Sewook Park <sewook7.park@samsung.com>, Jaeho Lee <jaeho81.lee@samsung.com>
8  *
9  * Licensed under the Apache License, Version 2.0 (the "License");
10  * you may not use this file except in compliance with the License.
11  * You may obtain a copy of the License at
12  *
13  * http://www.apache.org/licenses/LICENSE-2.0
14  *
15  * Unless required by applicable law or agreed to in writing, software
16  * distributed under the License is distributed on an "AS IS" BASIS,
17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18  * See the License for the specific language governing permissions and
19  * limitations under the License.
20  *
21  */
22
23
24
25
26 #ifndef _ALARM_INTERNAL_H
27 #define _ALARM_INTERNAL_H
28
29 #define MAX_SNOOZE_CNT 5
30 #define REPEAT_MODE_ONCE 0x80
31
32 #define SIG_TIMER 0x32
33 #define ALARM_INFO_MAX 100
34
35 #include "alarm.h"
36 #include <dbus/dbus-glib.h>
37 #include <glib.h>
38 #include <dlog.h>
39 #include <bundle.h>
40 #include <appsvc.h>
41
42 #define INIT_ALARM_LIST_SIZE 64
43 #define INIT_SCHEDULED_ALARM_LIST_SIZE 32
44 #define MAX_BUNDLE_NAME_LEN 2048
45 #define MAX_SERVICE_NAME_LEN 256
46 #define MAX_PKG_NAME_LEN MAX_SERVICE_NAME_LEN-8
47
48 #define SYSTEM_TIME_CHANGED "setting_time_changed"
49
50 #ifdef LOG_TAG
51 #undef LOG_TAG
52 #endif
53 #define LOG_TAG "ALARM_MANAGER"
54
55 /*Application ID for native application which is not launched by application 
56 server.*/
57 #define ALARM_NATIVE_APP_ID 99999
58 /*  Application Instance ID for native application which is not launched by 
59 application server.*/
60 #define ALARM_NATIVE_APP_INST_ID 99999
61 /*  Prefix of dbus service name of native application.*/
62 #define ALARM_NATIVE_APP_DBUS_SVC_NAME_PREFIX "NATIVE"
63
64 /* how to send expire event : gproxy or low level dbus
65 * if you want to use gproxy for receiving expire_event, please enable 
66 * _EXPIRE_ALARM_INTERFACE_IS_DBUS_GPROXY_ feature
67 * otherwise, lowlevel dbus interface will be used for receiving expire_event.
68 * Now we use low level dbus instead of gproxy
69 */
70 /*#define       _EXPIRE_ALARM_INTERFACE_IS_DBUS_GPROXY_ */
71
72 typedef struct {
73         DBusGConnection *bus;
74         DBusGProxy *proxy;
75         alarm_cb_t alarm_handler;
76         void *user_param;
77         int pid;                /* this specifies pid*/
78         GQuark quark_app_service_name;  /*dbus_service_name is converted 
79          to quark value*/
80          GQuark quark_app_service_name_mod;
81 } alarm_context_t;
82
83 typedef union {
84         int day_of_week;                        /**< days of a week */
85         time_t interval;
86 } alarm_interval_u;
87
88 /**
89 * This struct has mode of an alarm
90 */
91 typedef struct {
92         alarm_interval_u u_interval;
93         alarm_repeat_mode_t repeat;     /**< repeat mode */
94 } alarm_mode_t;
95
96 /**
97 *  This enumeration has alarm type
98
99 typedef enum
100 {
101         ALARM_TYPE_DEFAULT = 0x0,       
102         ALARM_TYPE_RELATIVE = 0x01,     
103         ALARM_TYPE_VOLATILE = 0x02,     
104 }alarm_type_t;
105 */
106 #define ALARM_TYPE_RELATIVE             0x80000000      /**< relative  */
107 #define ALARM_TYPE_WITHCB               0x40000000      /**< withcb  */
108
109
110 /**
111 * This struct has the information of an alarm
112 */
113
114 typedef struct {
115         alarm_date_t start; /**< start time of the alarm */
116         alarm_date_t end;   /**< end time of the alarm */
117         alarm_mode_t mode;      /**< mode of alarm */
118         int alarm_type;     /**< alarm type*/
119         int reserved_info;
120 } alarm_info_t;
121
122 bool _send_alarm_create(alarm_context_t context, alarm_info_t *alarm,
123                          alarm_id_t *id, const char *dst_service_name,const char *dst_service_name_mod,
124                          int *error_code);
125 bool _send_alarm_create_appsvc(alarm_context_t context, alarm_info_t *alarm_info,
126                         alarm_id_t *alarm_id, bundle *b,int *error_code);
127 bool _send_alarm_update(alarm_context_t context, int pid, alarm_id_t alarm_id,
128                          alarm_info_t *alarm_info, int *error_code);
129 bool _send_alarm_delete(alarm_context_t context, alarm_id_t alarm_id,
130                          int *error_code);
131 bool _send_alarm_get_list_of_ids(alarm_context_t context, int maxnum_of_ids,
132                                   alarm_id_t *alarm_id, int *num_of_ids,
133                                   int *error_code);
134 bool _send_alarm_get_number_of_ids(alarm_context_t context, int *num_of_ids,
135                                     int *error_code);
136 bool _send_alarm_get_info(alarm_context_t context, alarm_id_t alarm_id,
137                            alarm_info_t *alarm_info, int *error_code);
138 bool _send_alarm_reset(alarm_context_t context, int *error_code);
139
140 bool _send_alarm_power_on(alarm_context_t context, bool on_off,
141                            int *error_code);
142 bool _send_alarm_check_next_duetime(alarm_context_t context, int *error_code);
143 bool _send_alarm_power_off(alarm_context_t context, int *error_code);
144 bool _remove_from_scheduled_alarm_list(int pid, alarm_id_t alarm_id);
145 bool _load_alarms_from_registry();
146 bool _alarm_find_mintime_power_on(time_t *min_time);
147 bundle *_send_alarm_get_appsvc_info(alarm_context_t context, alarm_id_t alarm_id, int *error_code);
148 bool _send_alarm_set_rtc_time(alarm_context_t context, alarm_date_t *time, int *error_code);
149
150 /*  alarm manager*/
151 typedef struct {
152         time_t start;
153         time_t end;
154
155         int alarm_id;
156         int pid;
157         GQuark quark_app_unique_name;   /*the fullpath of application's pid is
158                 converted to quark value.*/
159         GQuark quark_app_service_name;  /*dbus_service_name is converted  to
160                 quark value.app_service_name is a service name  of application
161                 that creates alarm_info.*/
162         GQuark quark_app_service_name_mod;
163         GQuark quark_dst_service_name;  /*dbus_service_name is converted to 
164                 quark value.app_service_name is a service name  for 
165                 dst_service_name of alarm_create_extend().*/
166         GQuark quark_dst_service_name_mod;
167         time_t due_time;
168
169         GQuark quark_bundle;    /*Bundle Content containing app-svc info*/
170
171         alarm_info_t alarm_info;
172
173 } __alarm_info_t;
174
175 typedef struct {
176         bool used;
177         __alarm_info_t *__alarm_info;
178 } __alarm_entry_t;
179
180 typedef struct {
181         timer_t timer;
182         time_t c_due_time;
183         GSList *alarms;
184         int gmt_idx;
185         int dst;
186         DBusGConnection *bus;
187 } __alarm_server_context_t;
188
189 typedef struct {
190         bool used;
191         alarm_id_t alarm_id;
192         int pid;
193         __alarm_info_t *__alarm_info;
194 } __scheduled_alarm_t;
195
196 typedef struct {
197         char service_name[MAX_SERVICE_NAME_LEN];
198         alarm_id_t alarm_id;
199 } __expired_alarm_t;
200
201 time_t _alarm_next_duetime(__alarm_info_t *alarm_info);
202 bool _alarm_schedule();
203 bool _clear_scheduled_alarm_list();
204 bool _add_to_scheduled_alarm_list(__alarm_info_t *__alarm_info);
205
206 bool _save_alarms(__alarm_info_t *__alarm_info);
207 bool _delete_alarms(alarm_id_t alarm_id);
208 bool _update_alarms(__alarm_info_t *__alarm_info);
209
210 timer_t _alarm_create_timer();
211 bool _alarm_destory_timer(timer_t timer);
212 bool _alarm_set_timer(__alarm_server_context_t *alarm_context, timer_t timer,
213                        time_t due_time, alarm_id_t id);
214 bool _alarm_disable_timer(__alarm_server_context_t alarm_context);
215 bool _init_scheduled_alarm_list();
216
217 int _set_rtc_time(time_t _time);
218 int _set_sys_time(time_t _time);
219 int _set_time(time_t _time);
220
221
222 #ifdef _DEBUG_MODE_
223 #define ALARM_MGR_LOG_PRINT(FMT, ARG...)  do { printf("%5d", getpid()); printf
224         ("%s() : "FMT"\n", __FUNCTION__, ##ARG); } while (false)
225 #define ALARM_MGR_EXCEPTION_PRINT(FMT, ARG...)  do { printf("%5d", getpid()); 
226         printf("%s() : "FMT"\n", __FUNCTION__, ##ARG); } while (false)
227 #define ALARM_MGR_ASSERT_PRINT(FMT, ARG...) do { printf("%5d", getpid()); printf
228         ("%s() : "FMT"\n", __FUNCTION__, ##ARG); } while (false)
229 #else
230 #define ALARM_MGR_LOG_PRINT(FMT, ARG...) SLOGD(FMT, ##ARG);
231 #define ALARM_MGR_EXCEPTION_PRINT(FMT, ARG...) SLOGW(FMT, ##ARG);
232 #define ALARM_MGR_ASSERT_PRINT(FMT, ARG...) SLOGE(FMT, ##ARG);
233 #endif
234
235 /* int alarmmgr_check_next_duetime();*/
236
237
238 #endif /*_ALARM_INTERNAL_H*/