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
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 8 -*- */
/*
* soup-session-feature.c: Miscellaneous session feature-provider interface
*
* Copyright (C) 2008 Red Hat, Inc.
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include "soup-session-feature-private.h"
#include "soup.h"
#include "soup-message-private.h"
/**
* SoupSessionFeature:
*
* Interface for miscellaneous [class@Session] features.
*
* #SoupSessionFeature is the interface used by classes that extend
* the functionality of a [class@Session]. Some features like HTTP
* authentication handling are implemented internally via
* `SoupSessionFeature`s. Other features can be added to the session
* by the application. (Eg, [class@Logger], [class@CookieJar].)
*
* See [method@Session.add_feature], etc, to add a feature to a session.
**/
/**
* SoupSessionFeatureInterface:
* @parent: The parent interface.
* @attach: Perform setup when a feature is added to a session
* @detach: Perform cleanup when a feature is removed from a session
* @request_queued: Proxies the session's [signal@Session::request_queued] signal
* @request_unqueued: Proxies the session's [signal@Session::request_unqueued] signal
* @add_feature: adds a sub-feature to the main feature
* @remove_feature: removes a sub-feature from the main feature
* @has_feature: tests if the feature includes a sub-feature
*
* The interface implemented by [iface@SessionFeature]s.
**/
G_DEFINE_INTERFACE (SoupSessionFeature, soup_session_feature, G_TYPE_OBJECT)
void
soup_session_feature_attach (SoupSessionFeature *feature,
SoupSession *session)
{
SoupSessionFeatureInterface *iface;
g_return_if_fail (SOUP_IS_SESSION_FEATURE (feature));
g_return_if_fail (SOUP_IS_SESSION (session));
iface = SOUP_SESSION_FEATURE_GET_IFACE (feature);
if (iface->attach)
iface->attach (feature, session);
}
void
soup_session_feature_detach (SoupSessionFeature *feature,
SoupSession *session)
{
SoupSessionFeatureInterface *iface;
g_return_if_fail (SOUP_IS_SESSION_FEATURE (feature));
g_return_if_fail (SOUP_IS_SESSION (session));
iface = SOUP_SESSION_FEATURE_GET_IFACE (feature);
if (iface->detach)
iface->detach (feature, session);
}
static void
soup_session_feature_default_init (SoupSessionFeatureInterface *iface)
{
}
void
soup_session_feature_request_queued (SoupSessionFeature *feature,
SoupMessage *msg)
{
SoupSessionFeatureInterface *iface;
g_return_if_fail (SOUP_IS_SESSION_FEATURE (feature));
g_return_if_fail (SOUP_IS_MESSAGE (msg));
if (soup_message_disables_feature (msg, feature))
return;
iface = SOUP_SESSION_FEATURE_GET_IFACE (feature);
if (iface->request_queued)
iface->request_queued (feature, msg);
}
void
soup_session_feature_request_unqueued (SoupSessionFeature *feature,
SoupMessage *msg)
{
SoupSessionFeatureInterface *iface;
g_return_if_fail (SOUP_IS_SESSION_FEATURE (feature));
g_return_if_fail (SOUP_IS_MESSAGE (msg));
if (soup_message_disables_feature (msg, feature))
return;
iface = SOUP_SESSION_FEATURE_GET_IFACE (feature);
if (iface->request_unqueued)
iface->request_unqueued (feature, msg);
}
/**
* soup_session_feature_add_feature:
* @feature: the "base" feature
* @type: the #GType of a "sub-feature"
*
* Adds a "sub-feature" of type @type to the base feature @feature.
*
* This is used for features that can be extended with multiple
* different types. Eg, the authentication manager can be extended
* with subtypes of [class@Auth].
*
* Returns: %TRUE if @feature accepted @type as a subfeature.
*/
gboolean
soup_session_feature_add_feature (SoupSessionFeature *feature,
GType type)
{
SoupSessionFeatureInterface *feature_iface =
SOUP_SESSION_FEATURE_GET_IFACE (feature);
if (feature_iface->add_feature)
return feature_iface->add_feature (feature, type);
else
return FALSE;
}
/**
* soup_session_feature_remove_feature:
* @feature: the "base" feature
* @type: the #GType of a "sub-feature"
*
* Removes the "sub-feature" of type @type from the base feature
* @feature.
*
* See [method@SessionFeature.add_feature].
*
* Returns: %TRUE if @type was removed from @feature
*/
gboolean
soup_session_feature_remove_feature (SoupSessionFeature *feature,
GType type)
{
SoupSessionFeatureInterface *feature_iface =
SOUP_SESSION_FEATURE_GET_IFACE (feature);
if (feature_iface->remove_feature)
return feature_iface->remove_feature (feature, type);
else
return FALSE;
}
/**
* soup_session_feature_has_feature:
* @feature: the "base" feature
* @type: the #GType of a "sub-feature"
*
* Tests if @feature has a "sub-feature" of type @type.
*
* See [method@SessionFeature.add_feature].
*
* Returns: %TRUE if @feature has a subfeature of type @type
*/
gboolean
soup_session_feature_has_feature (SoupSessionFeature *feature,
GType type)
{
SoupSessionFeatureInterface *feature_iface =
SOUP_SESSION_FEATURE_GET_IFACE (feature);
if (feature_iface->has_feature)
return feature_iface->has_feature (feature, type);
else
return FALSE;
}
|
