aboutsummaryrefslogtreecommitdiffstats
path: root/embed/ephy-permission-manager.c
blob: e4e704ac823b5665421a2aa7d9ccaf50c74339bb (plain) (blame)
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
/*
 *  Copyright (C) 2003 Marco Pesenti Gritti
 *  Copyright (C) 2003 Christian Persch
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2, or (at your option)
 *  any later version.
 *
 *  This program 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 *  $Id$
 */

#include "config.h"

#include "ephy-permission-manager.h"
#include "ephy-embed-type-builtins.h"
#include "ephy-marshal.h"
#include "ephy-debug.h"

GType
ephy_permission_info_get_type (void)
{
    static GType type = 0;

    if (G_UNLIKELY (type == 0))
    {
        type = g_boxed_type_register_static ("EphyPermissionInfo",
                             (GBoxedCopyFunc) ephy_permission_info_copy,
                             (GBoxedFreeFunc) ephy_permission_info_free);
    }

    return type;
}

/**
 * ephy_permission_info_new:
 * @host: a host name
 * @type: an #EphyPermissionType
 * @allowed: whether @host should be allowed to do what @type specifies
 *
 * Return value: the new #EphyPermissionInfo
 **/
EphyPermissionInfo *
ephy_permission_info_new (const char *host,
              const char *type,
              EphyPermission permission)
{
    EphyPermissionInfo *info = g_new0 (EphyPermissionInfo, 1);

    info->host = g_strdup (host);
    info->qtype = g_quark_from_string (type);
    info->permission = permission;

    return info;
}

/**
 * ephy_permission_info_copy:
 * @info: an #EphyPermissionInfo
 *
 * Return value: a copy of @info
 **/
EphyPermissionInfo *
ephy_permission_info_copy (const EphyPermissionInfo *info)
{
    EphyPermissionInfo *copy = g_new0 (EphyPermissionInfo, 1);

    copy->host = g_strdup (info->host);
    copy->qtype = info->qtype;
    copy->permission = info->permission;

    return copy;
}

/**
 * ephy_permission_info_free:
 * @info: an #EphyPermissionInfo
 *
 * Frees @info.
 **/
void
ephy_permission_info_free (EphyPermissionInfo *info)
{
    if (info != NULL)
    {
        g_free (info->host);
        g_free (info);
    }
}

/* EphyPermissionManager */

static void ephy_permission_manager_base_init (gpointer g_class);

GType
ephy_permission_manager_get_type (void)
{
       static GType type = 0;

    if (G_UNLIKELY (type == 0))
    {
        const GTypeInfo our_info =
        {
        sizeof (EphyPermissionManagerIface),
        ephy_permission_manager_base_init,
        NULL,
        };
        
        type = g_type_register_static (G_TYPE_INTERFACE,
                           "EphyPermissionManager",
                           &our_info,
                           (GTypeFlags) 0);
    }

    return type;
}

static void
ephy_permission_manager_base_init (gpointer g_class)
{
    static gboolean initialised = FALSE;

    if (initialised == FALSE)
    {
    /**
     * EphyPermissionManager::permission-added
     * @manager: the #EphyPermissionManager
     * @info: a #EphyPermissionInfo
     *
     * The permission-added signal is emitted when a permission entry has
     * been added.
     */
    g_signal_new ("permission-added",
              EPHY_TYPE_PERMISSION_MANAGER,
              G_SIGNAL_RUN_FIRST,
              G_STRUCT_OFFSET (EphyPermissionManagerIface, added),
              NULL, NULL,
              g_cclosure_marshal_VOID__BOXED,
              G_TYPE_NONE,
              1,
              EPHY_TYPE_PERMISSION_INFO | G_SIGNAL_TYPE_STATIC_SCOPE);

    /**
     * EphyPermissionManager::permission-changed
     * @manager: the #EphyPermissionManager
     * @info: a #EphyPermissionInfo
     *
     * The permission-changed signal is emitted when a permission entry has
     * been changed.
     */
    g_signal_new ("permission-changed",
              EPHY_TYPE_PERMISSION_MANAGER,
              G_SIGNAL_RUN_FIRST,
              G_STRUCT_OFFSET (EphyPermissionManagerIface, changed),
              NULL, NULL,
              g_cclosure_marshal_VOID__BOXED,
              G_TYPE_NONE,
              1,
              EPHY_TYPE_PERMISSION_INFO | G_SIGNAL_TYPE_STATIC_SCOPE);

    /**
     * EphyPermissionManager::permission-deleted
     * @manager: the #EphyPermissionManager
     * @info: a #EphyPermissionInfo
     *
     * The permission-deleted signal is emitted when a permission entry has
     * been deleted.
     */
    g_signal_new ("permission-deleted",
              EPHY_TYPE_PERMISSION_MANAGER,
              G_SIGNAL_RUN_FIRST,
              G_STRUCT_OFFSET (EphyPermissionManagerIface, deleted),
              NULL, NULL,
              g_cclosure_marshal_VOID__BOXED,
              G_TYPE_NONE,
              1,
              EPHY_TYPE_PERMISSION_INFO | G_SIGNAL_TYPE_STATIC_SCOPE);

    /**
     * EphyPermissionManager::permissions-cleared
     * @manager: the #EphyPermissionManager
     *
     * The permissions-cleared signal is emitted when the permissions
     * database has been cleared.
     */
    g_signal_new ("permissions-cleared",
              EPHY_TYPE_PERMISSION_MANAGER,
              G_SIGNAL_RUN_FIRST,
              G_STRUCT_OFFSET (EphyPermissionManagerIface, cleared),
              NULL, NULL,
              g_cclosure_marshal_VOID__VOID,
              G_TYPE_NONE,
              0);

    initialised = TRUE;
    }
}

/**
 * ephy_permission_manager_add_permission:
 * @manager: the #EphyPermissionManager
 * @host: a website URL
 * @type: a string to identify the type of the permission
 * @permission: either %EPHY_PERMISSION_ALLOWED or %EPHY_PERMISSION_DENIED
 * 
 * Adds the specified permission to the permissions database.
 **/
void
ephy_permission_manager_add_permission (EphyPermissionManager *manager,
                    const char *host,
                    const char *type,
                    EphyPermission permission)
{
    EphyPermissionManagerIface *iface = EPHY_PERMISSION_MANAGER_GET_IFACE (manager);
    iface->add (manager, host, type, permission);
}

/**
 * ephy_permission_manager_remove_permission:
 * @manager: the #EphyPermissionManager
 * @host: a website URL
 * @type: a string to identify the type of the permission
 * 
 * Removes the specified permission from the permissions database. This implies
 * that the browser should use defaults when next visiting the specified
 * @host's web pages.
 **/
void
ephy_permission_manager_remove_permission (EphyPermissionManager *manager,
                       const char *host,
                       const char *type)
{
    EphyPermissionManagerIface *iface = EPHY_PERMISSION_MANAGER_GET_IFACE (manager);
    iface->remove (manager, host, type);
}

/**
 * ephy_permission_manager_clear_permission:
 * @manager: the #EphyPermissionManager
 * 
 * Clears the permissions database. This cannot be undone.
 **/
void
ephy_permission_manager_clear_permissions (EphyPermissionManager *manager)
{
    EphyPermissionManagerIface *iface = EPHY_PERMISSION_MANAGER_GET_IFACE (manager);
    iface->clear (manager);
}

/**
 * ephy_permission_manager_test_permission:
 * @manager: the #EphyPermissionManager
 * @host: a website URL
 * @type: a string to identify the type of the permission
 * 
 * Retrieves an #EphyPermissionType from the permissions database. If there is
 * no entry for this @type and @host, it will return %EPHY_PERMISSION_DEFAULT.
 * In that case, the caller may need to determine the appropriate default
 * behavior.
 *
 * Return value: the permission of type #EphyPermission
 **/
EphyPermission
ephy_permission_manager_test_permission (EphyPermissionManager *manager,
                     const char *host,
                     const char *type)
{
    EphyPermissionManagerIface *iface = EPHY_PERMISSION_MANAGER_GET_IFACE (manager);
    return iface->test (manager, host, type);
}

/**
 * ephy_permission_manager_list_permission:
 * @manager: the #EphyPermissionManager
 * @type: a string to identify the type of the permission
 * 
 * Lists all permission entries of type @type in the permissions database, each
 * as its own #EphyPermissionInfo. These entries must be freed using
 * ephy_permission_info_free().
 * 
 * Return value: the list of permission database entries
 **/
GList *
ephy_permission_manager_list_permissions (EphyPermissionManager *manager,
                     const char *type)
{
    EphyPermissionManagerIface *iface = EPHY_PERMISSION_MANAGER_GET_IFACE (manager);
    return iface->list (manager, type);
}