[GTK] Add methods to add a user style sheet to the WebKit2 GTK+ API
[WebKit-https.git] / Source / WebKit2 / UIProcess / API / gtk / WebKitWebViewGroup.cpp
1 /*
2  * Copyright (C) 2013 Igalia S.L.
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public License
15  * along with this library; see the file COPYING.LIB.  If not, write to
16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  */
19
20 #include "config.h"
21 #include "WebKitWebViewGroup.h"
22
23 #include "ImmutableArray.h"
24 #include "WebKitPrivate.h"
25 #include "WebKitSettingsPrivate.h"
26 #include "WebKitWebViewGroupPrivate.h"
27 #include <glib/gi18n-lib.h>
28 #include <wtf/gobject/GRefPtr.h>
29 #include <wtf/text/CString.h>
30
31 using namespace WebKit;
32
33 /**
34  * SECTION: WebKitWebViewGroup
35  * @Short_description: Group of web views
36  * @Title: WebKitWebViewGroup
37  * @See_also: #WebKitWebView, #WebKitSettings
38  *
39  * A WebKitWebViewGroup represents a group of #WebKitWebView<!-- -->s that
40  * share things like settings. There's a default WebKitWebViewGroup where
41  * all #WebKitWebView<!-- -->s of the same #WebKitWebContext are added by default.
42  * To create a #WebKitWebView in a different WebKitWebViewGroup you can use
43  * webkit_web_view_new_with_group().
44  *
45  * WebKitWebViewGroups are identified by a unique name given when the group is
46  * created with webkit_web_view_group_new().
47  * WebKitWebViewGroups have a #WebKitSettings to control the settings of all
48  * #WebKitWebView<!-- -->s of the group. You can get the settings with
49  * webkit_web_view_group_get_settings() to handle the settings, or you can set
50  * your own #WebKitSettings with webkit_web_view_group_set_settings(). When
51  * the #WebKitSettings of a WebKitWebViewGroup changes, the signal notify::settings
52  * is emitted on the group.
53  */
54
55 enum {
56     PROP_0,
57
58     PROP_SETTINGS
59 };
60
61 struct _WebKitWebViewGroupPrivate {
62     RefPtr<WebPageGroup> pageGroup;
63     CString name;
64     GRefPtr<WebKitSettings> settings;
65 };
66
67 WEBKIT_DEFINE_TYPE(WebKitWebViewGroup, webkit_web_view_group, G_TYPE_OBJECT)
68
69 static void webkitWebViewGroupSetProperty(GObject* object, guint propId, const GValue* value, GParamSpec* paramSpec)
70 {
71     WebKitWebViewGroup* group = WEBKIT_WEB_VIEW_GROUP(object);
72
73     switch (propId) {
74     case PROP_SETTINGS:
75         webkit_web_view_group_set_settings(group, WEBKIT_SETTINGS(g_value_get_object(value)));
76         break;
77     default:
78         G_OBJECT_WARN_INVALID_PROPERTY_ID(object, propId, paramSpec);
79     }
80 }
81
82 static void webkitWebViewGroupGetProperty(GObject* object, guint propId, GValue* value, GParamSpec* paramSpec)
83 {
84     WebKitWebViewGroup* group = WEBKIT_WEB_VIEW_GROUP(object);
85
86     switch (propId) {
87     case PROP_SETTINGS:
88         g_value_set_object(value, webkit_web_view_group_get_settings(group));
89         break;
90     default:
91         G_OBJECT_WARN_INVALID_PROPERTY_ID(object, propId, paramSpec);
92     }
93 }
94
95 static void webkitWebViewGroupConstructed(GObject* object)
96 {
97     G_OBJECT_CLASS(webkit_web_view_group_parent_class)->constructed(object);
98
99     WebKitWebViewGroupPrivate* priv = WEBKIT_WEB_VIEW_GROUP(object)->priv;
100     priv->settings = adoptGRef(webkit_settings_new());
101 }
102
103 static void webkit_web_view_group_class_init(WebKitWebViewGroupClass* hitTestResultClass)
104 {
105     GObjectClass* objectClass = G_OBJECT_CLASS(hitTestResultClass);
106     objectClass->set_property = webkitWebViewGroupSetProperty;
107     objectClass->get_property = webkitWebViewGroupGetProperty;
108     objectClass->constructed = webkitWebViewGroupConstructed;
109
110     /**
111      * WebKitWebViewGroup:settings:
112      *
113      * The #WebKitSettings of the web view group.
114      */
115     g_object_class_install_property(
116         objectClass,
117         PROP_SETTINGS,
118         g_param_spec_object(
119             "settings",
120             _("Settings"),
121             _("The settings of the web view group"),
122             WEBKIT_TYPE_SETTINGS,
123             WEBKIT_PARAM_READWRITE));
124 }
125
126 static void webkitWebViewGroupAttachSettingsToPageGroup(WebKitWebViewGroup* group)
127 {
128     group->priv->pageGroup->setPreferences(webkitSettingsGetPreferences(group->priv->settings.get()));
129 }
130
131 WebKitWebViewGroup* webkitWebViewGroupCreate(WebPageGroup* pageGroup)
132 {
133     WebKitWebViewGroup* group = WEBKIT_WEB_VIEW_GROUP(g_object_new(WEBKIT_TYPE_WEB_VIEW_GROUP, NULL));
134     group->priv->pageGroup = pageGroup;
135     webkitWebViewGroupAttachSettingsToPageGroup(group);
136     return group;
137 }
138
139 WebPageGroup* webkitWebViewGroupGetPageGroup(WebKitWebViewGroup* group)
140 {
141     return group->priv->pageGroup.get();
142 }
143
144 /**
145  * webkit_web_view_group_new:
146  * @name: (allow-none): the name of the group
147  *
148  * Creates a new #WebKitWebViewGroup with the given @name.
149  * If @name is %NULL a unique identifier name will be created
150  * automatically.
151  * The newly created #WebKitWebViewGroup doesn't contain any
152  * #WebKitWebView, web views are added to the new group when created
153  * with webkit_web_view_new_with_group() passing the group.
154  *
155  * Returns: (transfer full): a new #WebKitWebViewGroup
156  */
157 WebKitWebViewGroup* webkit_web_view_group_new(const char* name)
158 {
159     WebKitWebViewGroup* group = WEBKIT_WEB_VIEW_GROUP(g_object_new(WEBKIT_TYPE_WEB_VIEW_GROUP, NULL));
160     group->priv->pageGroup = WebPageGroup::create(name ? String::fromUTF8(name) : String());
161     webkitWebViewGroupAttachSettingsToPageGroup(group);
162     return group;
163 }
164
165 /**
166  * webkit_web_view_group_get_name:
167  * @group: a #WebKitWebViewGroup
168  *
169  * Gets the name that uniquely identifies the #WebKitWebViewGroup.
170  *
171  * Returns: the name of @group
172  */
173 const char* webkit_web_view_group_get_name(WebKitWebViewGroup* group)
174 {
175     g_return_val_if_fail(WEBKIT_IS_WEB_VIEW_GROUP(group), 0);
176
177     WebKitWebViewGroupPrivate* priv = group->priv;
178     if (priv->name.isNull())
179         priv->name = priv->pageGroup->identifier().utf8();
180
181     return priv->name.data();
182 }
183
184 /**
185  * webkit_web_view_group_get_settings:
186  * @group: a #WebKitWebViewGroup
187  *
188  * Gets the #WebKitSettings of the #WebKitWebViewGroup.
189  *
190  * Returns: (transfer none): the settings of @group
191  */
192 WebKitSettings* webkit_web_view_group_get_settings(WebKitWebViewGroup* group)
193 {
194     g_return_val_if_fail(WEBKIT_IS_WEB_VIEW_GROUP(group), 0);
195
196     return group->priv->settings.get();
197 }
198
199 /**
200  * webkit_web_view_group_set_settings:
201  * @group: a #WebKitWebViewGroup
202  * @settings: a #WebKitSettings
203  *
204  * Sets a new #WebKitSettings for the #WebKitWebViewGroup. The settings will
205  * affect to all the #WebKitWebView<!-- -->s of the group.
206  * #WebKitWebViewGroup<!-- -->s always have a #WebKitSettings so if you just want to
207  * modify a setting you can use webkit_web_view_group_get_settings() and modify the
208  * returned #WebKitSettings instead.
209  * Setting the same #WebKitSettings multiple times doesn't have any effect.
210  * You can monitor the settings of a #WebKitWebViewGroup by connecting to the
211  * notify::settings signal of @group.
212  */
213 void webkit_web_view_group_set_settings(WebKitWebViewGroup* group, WebKitSettings* settings)
214 {
215     g_return_if_fail(WEBKIT_IS_WEB_VIEW_GROUP(group));
216     g_return_if_fail(WEBKIT_IS_SETTINGS(settings));
217
218     if (group->priv->settings == settings)
219         return;
220
221     group->priv->settings = settings;
222     webkitWebViewGroupAttachSettingsToPageGroup(group);
223     g_object_notify(G_OBJECT(group), "settings");
224 }
225
226 COMPILE_ASSERT_MATCHING_ENUM(WEBKIT_INJECTED_CONTENT_FRAMES_ALL, WebCore::InjectInAllFrames);
227 COMPILE_ASSERT_MATCHING_ENUM(WEBKIT_INJECTED_CONTENT_FRAMES_TOP_ONLY, WebCore::InjectInTopFrameOnly);
228
229 static PassRefPtr<ImmutableArray> toImmutableArray(const char* const* list)
230 {
231     if (!list)
232         return 0;
233
234     Vector<RefPtr<APIObject> > entries;
235     while (*list) {
236         entries.append(WebString::createFromUTF8String(*list));
237         list++;
238     }
239     return ImmutableArray::adopt(entries);
240 }
241
242 /**
243  * webkit_web_view_group_add_user_style_sheet:
244  * @group: a #WebKitWebViewGroup
245  * @source: the source of the style_sheet to inject
246  * @base_uri: (allow-none): the base URI to use when processing the style_sheet contents or %NULL for about:blank
247  * @whitelist: (array zero-terminated=1) (allow-none): a whitelist of URI patterns or %NULL
248  * @blacklist: (array zero-terminated=1) (allow-none): a blacklist of URI patterns or %NULL
249  * @injected_frames: a #WebKitInjectedContentFrames describing to which frames the style_sheet should apply
250  *
251  * Inject an external style sheet into pages. It is possible to only apply the style sheet
252  * to some URIs by passing non-null values for @whitelist or @blacklist. Passing a %NULL
253  * whitelist implies that all URIs are on the whitelist. The style sheet is applied if a URI matches
254  * the whitelist and not the blacklist. URI patterns must be of the form [protocol]://[host]/[path]
255  * where the host and path components can contain the wildcard character ('*') to represent zero
256  * or more other characters.
257  */
258 void webkit_web_view_group_add_user_style_sheet(WebKitWebViewGroup* group, const char* source, const char* baseURI, const char* const* whitelist, const char* const* blacklist, WebKitInjectedContentFrames injectedFrames)
259 {
260     g_return_if_fail(WEBKIT_IS_WEB_VIEW_GROUP(group));
261     g_return_if_fail(source);
262
263     RefPtr<ImmutableArray> webWhitelist = toImmutableArray(whitelist);
264     RefPtr<ImmutableArray> webBlacklist = toImmutableArray(blacklist);
265
266     // We always use UserStyleUserLevel to match the behavior of WKPageGroupAddUserStyleSheet.
267     group->priv->pageGroup->addUserStyleSheet(
268         String::fromUTF8(source),
269         String::fromUTF8(baseURI),
270         webWhitelist.get(),
271         webBlacklist.get(),
272         static_cast<WebCore::UserContentInjectedFrames>(injectedFrames),
273         WebCore::UserStyleUserLevel);
274 }
275
276 /**
277  * webkit_web_view_group_remove_all_user_style_sheets:
278  * @group: a #WebKitWebViewGroup
279  *
280  * Remove all style sheets previously injected into this #WebKitWebViewGroup 
281  * via webkit_web_view_group_add_user_style_sheet().
282  */
283 void webkit_web_view_group_remove_all_user_style_sheets(WebKitWebViewGroup* group)
284 {
285     g_return_if_fail(WEBKIT_IS_WEB_VIEW_GROUP(group));
286     group->priv->pageGroup->removeAllUserStyleSheets();
287 }