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
|
/*
Copyright (C) 2012 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; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
/**
* @file ewk_security_origin.h
* @brief Security Origin API.
*
* Security Origin is the mechanism that defines the access limits of a website.
* Based on information such as domain, protocol and port, you can grant or not
* authorization for accessing data and performing certain tasks. Database quota
* can also be defined based on the security origin.
*
* The database related functions will do nothing if WebKit is built without Web
* SQL Database support.
*/
#ifndef ewk_security_origin_h
#define ewk_security_origin_h
#include <Eina.h>
#ifdef __cplusplus
extern "C" {
#endif
typedef struct _Ewk_Security_Origin Ewk_Security_Origin;
/**
* Returns the protocol of the security origin.
*
* @param o security origin object
*
* It returns a internal string which should not
* be modified. The string is guaranteed to be stringshared.
*
* @return the protocol scheme or @c NULL if there is not a protocol scheme
*/
EAPI const char *ewk_security_origin_protocol_get(const Ewk_Security_Origin *o);
/**
* Returns the host of the security origin.
*
* It returns a internal string which should not
* be modified. The string is guaranteed to be stringshared.
*
* @param o security origin object
*
* @return the host domain or @c NULL if there is not a host scheme
*/
EAPI const char *ewk_security_origin_host_get(const Ewk_Security_Origin *o);
/**
* Convert this Ewk_Security_Origin into a string.
* The string representation of a security origin is similar to a URL, except it lacks a path component.
* The string representation does not encode the value of the security origin's domain property.
*
* @param o security origin object
*
* @return the string representation of security origin or @c NULL if there is not a proper security origin scheme
*/
EAPI const char *ewk_security_origin_string_get(const Ewk_Security_Origin *o);
/**
* Returns the port of the security origin.
*
* @param o security origin object
*
* @return the port or @c 0 if there is not a proper security origin scheme
*/
EAPI uint32_t ewk_security_origin_port_get(const Ewk_Security_Origin *o);
/**
* Retrieves the usage of a database for a security origin.
*
* This function won't work if Web SQL Database was not enabled when
* building WebKit and will just return 0.
*
* @param o security origin object or @c 0 if there is not a proper security origin scheme
*
* @return the usage in bytes
*/
EAPI uint64_t ewk_security_origin_web_database_usage_get(const Ewk_Security_Origin *o);
/**
* Retrieves the quota of a database for a security origin.
*
* This function won't work if Web SQL Database was not enabled when
* building WebKit and will just return 0.
*
* @param o security origin object
*
* @return the quota in bytes or @c 0 if there is not a proper security origin scheme
*/
EAPI uint64_t ewk_security_origin_web_database_quota_get(const Ewk_Security_Origin *o);
/**
* Sets the database usage quota for a security origin.
*
* This function won't work if Web SQL Database was not enabled when
* building WebKit.
*
* @param o security origin object
* @param quota the usage quota in bytes
*/
EAPI void ewk_security_origin_web_database_quota_set(const Ewk_Security_Origin *o, uint64_t quota);
/**
* Sets the application cache usage quota for a security origin.
*
* @param o security origin object
* @param quota the usage quota in bytes
*/
EAPI void ewk_security_origin_application_cache_quota_set(const Ewk_Security_Origin *o, int64_t quota);
/**
* Clears the application cache for a security origin.
*
* @param o security origin object.
*/
EAPI void ewk_security_origin_application_cache_clear(const Ewk_Security_Origin *o);
/**
* Return the list of web databases in the security origin.
*
* Each item of the list should be release using ewk_web_database_free() or
* use ewk_web_database_list_free() as convenience.
*
* This function won't work if Web SQL Database was not enabled when
* building WebKit and will just return @c NULL.
*
* @param o security origin object
*
* @return list of web databases in the security origin or @c NULL if there is not a proper security origin scheme
*
* @see ewk_web_database_free()
* @see ewk_web_database_list_free()
*/
EAPI Eina_List *ewk_security_origin_web_database_get_all(const Ewk_Security_Origin *o);
/**
* Release all resources allocated by a security origin object.
*
* @param o security origin object
*/
EAPI void ewk_security_origin_free(Ewk_Security_Origin *o);
/**
* Creates a security origin for a url.
*
* @param url the url for the security origin.
*
* @return the security origin object
*/
EAPI Ewk_Security_Origin *ewk_security_origin_new_from_string(const char *url);
#ifdef __cplusplus
}
#endif
#endif // ewk_security_origin_h
|
