nettika/geary
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Rename ClientWebView to Components.WebView per code style

Browse source
This commit is contained in:
Michael Gratton 2019-11-25 21:58:48 +11:00 • committed by Michael James Gratton
parent 99d4e1bdce
commit ceb9c9764a
22 changed files with 72 additions and 72 deletions
Download patch file Download diff file Expand all files Collapse all files

2
po/POTFILES.in
View file

@ -31,7 +31,6 @@ src/client/application/goa-mediator.vala
src/client/application/main.vala
src/client/application/secret-mediator.vala
src/client/client-action.vala
src/client/components/client-web-view.vala
src/client/components/components-attachment-pane.vala
src/client/components/components-entry-undo.vala
src/client/components/components-in-app-notification.vala
@ -39,6 +38,7 @@ src/client/components/components-inspector.vala
src/client/components/components-placeholder-pane.vala
src/client/components/components-preferences-window.vala
src/client/components/components-validator.vala
src/client/components/components-web-view.vala
src/client/components/count-badge.vala
src/client/components/folder-popover.vala
src/client/components/icon-factory.vala

4
src/client/accounts/accounts-editor-edit-pane.vala
View file

@ -718,7 +718,7 @@ internal class Accounts.RemoveMailboxCommand : Application.Command {
internal class Accounts.SignatureChangedCommand : Application.Command {
private ClientWebView signature_view;
private Components.WebView signature_view;
private Geary.AccountInformation account;
private string old_value;
@ -728,7 +728,7 @@ internal class Accounts.SignatureChangedCommand : Application.Command {
private bool new_enabled = false;
public SignatureChangedCommand(ClientWebView signature_view,
public SignatureChangedCommand(Components.WebView signature_view,
Geary.AccountInformation account) {
this.signature_view = signature_view;
this.account = account;

4
src/client/accounts/accounts-signature-web-view.vala
View file

@ -8,14 +8,14 @@
/**
* A class for editing signatures in the accounts editor.
*/
public class Accounts.SignatureWebView : ClientWebView {
public class Accounts.SignatureWebView : Components.WebView {
private static WebKit.UserScript? app_script = null;
public static new void load_resources()
throws GLib.Error {
SignatureWebView.app_script = ClientWebView.load_app_script(
SignatureWebView.app_script = Components.WebView.load_app_script(
"signature-web-view.js"
);
}

4
src/client/application/application-controller.vala
View file

@ -134,13 +134,13 @@ internal class Application.Controller : Geary.BaseObject {
this.upgrade_dialog = new UpgradeDialog(application);
// Initialise WebKit and WebViews
ClientWebView.init_web_context(
Components.WebView.init_web_context(
this.application.config,
this.application.get_web_extensions_dir(),
this.application.get_user_cache_directory().get_child("web-resources")
);
try {
ClientWebView.load_resources(
Components.WebView.load_resources(
this.application.get_user_config_directory()
);
Composer.WebView.load_resources();

38
src/client/components/client-web-view.vala → src/client/components/components-web-view.vala
View file

@ -14,7 +14,7 @@
* integration, Inspector support, and remote and inline image
* handling.
*/
public abstract class ClientWebView : WebKit.WebView, Geary.BaseInterface {
public abstract class Components.WebView : WebKit.WebView, Geary.BaseInterface {
/** URI Scheme and delimiter for internal resource loads. */
@ -86,13 +86,13 @@ public abstract class ClientWebView : WebKit.WebView, Geary.BaseInterface {
context.set_cache_model(WebKit.CacheModel.DOCUMENT_VIEWER);
context.register_uri_scheme("cid", (req) => {
ClientWebView? view = req.get_web_view() as ClientWebView;
WebView? view = req.get_web_view() as WebView;
if (view != null) {
view.handle_cid_request(req);
}
});
context.register_uri_scheme("geary", (req) => {
ClientWebView? view = req.get_web_view() as ClientWebView;
WebView? view = req.get_web_view() as WebView;
if (view != null) {
view.handle_internal_request(req);
}
@ -113,25 +113,25 @@ public abstract class ClientWebView : WebKit.WebView, Geary.BaseInterface {
update_spellcheck(context, config);
});
ClientWebView.default_context = context;
WebView.default_context = context;
}
/**
* Loads static resources used by ClientWebView.
* Loads static resources used by WebView.
*/
public static void load_resources(GLib.File user_dir)
throws GLib.Error {
ClientWebView.script = load_app_script(
"client-web-view.js"
WebView.script = load_app_script(
"components-web-view.js"
);
ClientWebView.allow_remote_images = load_app_script(
"client-web-view-allow-remote-images.js"
WebView.allow_remote_images = load_app_script(
"components-web-view-allow-remote-images.js"
);
foreach (string name in new string[] { USER_CSS, USER_CSS_LEGACY }) {
GLib.File stylesheet = user_dir.get_child(name);
try {
ClientWebView.user_stylesheet = load_user_stylesheet(stylesheet);
WebView.user_stylesheet = load_user_stylesheet(stylesheet);
break;
} catch (GLib.IOError.NOT_FOUND err) {
// All good, try the next one or just exit
@ -298,7 +298,7 @@ public abstract class ClientWebView : WebKit.WebView, Geary.BaseInterface {
public signal void remote_image_load_blocked();
protected ClientWebView(Application.Configuration config,
protected WebView(Application.Configuration config,
WebKit.UserContentManager? custom_manager = null) {
WebKit.Settings setts = new WebKit.Settings();
setts.allow_modal_dialogs = false;
@ -320,13 +320,13 @@ public abstract class ClientWebView : WebKit.WebView, Geary.BaseInterface {
WebKit.UserContentManager content_manager =
custom_manager ?? new WebKit.UserContentManager();
content_manager.add_script(ClientWebView.script);
if (ClientWebView.user_stylesheet != null) {
content_manager.add_style_sheet(ClientWebView.user_stylesheet);
content_manager.add_script(WebView.script);
if (WebView.user_stylesheet != null) {
content_manager.add_style_sheet(WebView.user_stylesheet);
}
Object(
web_context: ClientWebView.default_context,
web_context: WebView.default_context,
user_content_manager: content_manager,
settings: setts
);
@ -375,7 +375,7 @@ public abstract class ClientWebView : WebKit.WebView, Geary.BaseInterface {
"monospace-font", SettingsBindFlags.DEFAULT);
}
~ClientWebView() {
~WebView() {
base_unref();
}
@ -434,11 +434,11 @@ public abstract class ClientWebView : WebKit.WebView, Geary.BaseInterface {
public void allow_remote_image_loading() {
// Use a separate script here since we need to update the
// value of window.geary.allow_remote_image_loading after it
// was first created by client-web-view.js (which is loaded at
// was first created by components-web-view.js (which is loaded at
// the start of page load), but before the page load is
// started (so that any remote images present are actually
// loaded).
this.user_content_manager.add_script(ClientWebView.allow_remote_images);
this.user_content_manager.add_script(WebView.allow_remote_images);
}
/**
@ -514,7 +514,7 @@ public abstract class ClientWebView : WebKit.WebView, Geary.BaseInterface {
JavaScriptMessageHandler handler) {
// XXX can't use the delegate directly, see b.g.o Bug
// 604781. However the workaround below creates a circular
// reference, causing ClientWebView instances to leak. So to
// reference, causing WebView instances to leak. So to
// work around that we need to record handler ids and
// disconnect them when being destroyed.
ulong id = this.user_content_manager.script_message_received[name].connect(

6
src/client/composer/composer-web-view.vala
View file

@ -9,7 +9,7 @@
/**
* A WebView for editing messages in the composer.
*/
public class Composer.WebView : ClientWebView {
public class Composer.WebView : Components.WebView {
// WebKit message handler names
@ -83,10 +83,10 @@ public class Composer.WebView : ClientWebView {
public static new void load_resources()
throws Error {
WebView.app_style = ClientWebView.load_app_stylesheet(
WebView.app_style = Components.WebView.load_app_stylesheet(
"composer-web-view.css"
);
WebView.app_script = ClientWebView.load_app_script(
WebView.app_script = Components.WebView.load_app_script(
"composer-web-view.js"
);
}

8
src/client/composer/composer-widget.vala
View file

@ -1283,7 +1283,7 @@ public class Composer.Widget : Gtk.EventBox, Geary.BaseInterface {
email.inline_files.set_all(this.inline_files);
email.cid_files.set_all(this.cid_files);
email.img_src_prefix = ClientWebView.INTERNAL_URL_PREFIX;
email.img_src_prefix = Components.WebView.INTERNAL_URL_PREFIX;
try {
if (!for_draft) {
@ -2051,7 +2051,7 @@ public class Composer.Widget : Gtk.EventBox, Geary.BaseInterface {
string unique_filename;
add_inline_part(byte_buffer, filename, out unique_filename);
this.editor.insert_image(
ClientWebView.INTERNAL_URL_PREFIX + unique_filename
Components.WebView.INTERNAL_URL_PREFIX + unique_filename
);
} catch (Error error) {
warning("Failed to paste image %s", error.message);
@ -2705,7 +2705,7 @@ public class Composer.Widget : Gtk.EventBox, Geary.BaseInterface {
string unique_filename;
add_inline_part(file_buffer, path, out unique_filename);
this.editor.insert_image(
ClientWebView.INTERNAL_URL_PREFIX + unique_filename
Components.WebView.INTERNAL_URL_PREFIX + unique_filename
);
} catch (Error err) {
attachment_failed(err.message);
@ -2804,7 +2804,7 @@ public class Composer.Widget : Gtk.EventBox, Geary.BaseInterface {
}
this.editor.insert_image(
ClientWebView.INTERNAL_URL_PREFIX + unique_filename
Components.WebView.INTERNAL_URL_PREFIX + unique_filename
);
}
}

4
src/client/conversation-viewer/conversation-email.vala
View file

@ -906,8 +906,8 @@ public class ConversationEmail : Gtk.Box, Geary.BaseInterface {
Geary.Memory.Buffer? content) {
var main = get_toplevel() as Application.MainWindow;
if (main != null) {
if (uri.has_prefix(ClientWebView.CID_URL_PREFIX)) {
string cid = uri.substring(ClientWebView.CID_URL_PREFIX.length);
if (uri.has_prefix(Components.WebView.CID_URL_PREFIX)) {
string cid = uri.substring(Components.WebView.CID_URL_PREFIX.length);
try {
Geary.Attachment attachment = this.email.get_attachment_by_content_id(
cid

4
src/client/conversation-viewer/conversation-message.vala
View file

@ -1077,7 +1077,7 @@ public class ConversationMessage : Gtk.Grid, Geary.BaseInterface {
return "<img alt=\"%s\" class=\"%s\" src=\"%s%s\" />".printf(
clean_filename,
REPLACED_IMAGE_CLASS,
ClientWebView.CID_URL_PREFIX,
Components.WebView.CID_URL_PREFIX,
Geary.HTML.escape_markup(id)
);
}
@ -1358,7 +1358,7 @@ public class ConversationMessage : Gtk.Grid, Geary.BaseInterface {
alt_text = (string) alt_maybe;
}
if (uri.has_prefix(ClientWebView.CID_URL_PREFIX)) {
if (uri.has_prefix(Components.WebView.CID_URL_PREFIX)) {
// We can get the data directly from the attachment, so
// don't bother getting it from the web view
save_image(uri, alt_text, null);

6
src/client/conversation-viewer/conversation-web-view.vala
View file

@ -6,7 +6,7 @@
* (version 2.1 or later). See the COPYING file in this distribution.
*/
public class ConversationWebView : ClientWebView {
public class ConversationWebView : Components.WebView {
private const string DECEPTIVE_LINK_CLICKED = "deceptiveLinkClicked";
@ -41,10 +41,10 @@ public class ConversationWebView : ClientWebView {
public static new void load_resources()
throws Error {
ConversationWebView.app_script = ClientWebView.load_app_script(
ConversationWebView.app_script = Components.WebView.load_app_script(
"conversation-web-view.js"
);
ConversationWebView.app_stylesheet = ClientWebView.load_app_stylesheet(
ConversationWebView.app_stylesheet = Components.WebView.load_app_stylesheet(
"conversation-web-view.css"
);
}

2
src/client/meson.build
View file

@ -28,7 +28,6 @@ geary_client_vala_sources = files(
'client-action.vala',
'components/client-web-view.vala',
'components/components-attachment-pane.vala',
'components/components-entry-undo.vala',
'components/components-inspector.vala',
@ -39,6 +38,7 @@ geary_client_vala_sources = files(
'components/components-placeholder-pane.vala',
'components/components-preferences-window.vala',
'components/components-validator.vala',
'components/components-web-view.vala',
'components/count-badge.vala',
'components/folder-popover.vala',
'components/icon-factory.vala',

12
test/client/components/client-web-view-test-case.vala → test/client/components/components-web-view-test-case.vala
View file

@ -6,22 +6,22 @@
*/
public abstract class ClientWebViewTestCase<V> : TestCase {
public abstract class Components.WebViewTestCase<V> : TestCase {
protected V? test_view = null;
protected Application.Configuration? config = null;
protected ClientWebViewTestCase(string name) {
protected WebViewTestCase(string name) {
base(name);
this.config = new Application.Configuration(Application.Client.SCHEMA_ID);
this.config.enable_debug = true;
ClientWebView.init_web_context(
WebView.init_web_context(
this.config,
File.new_for_path(_BUILD_ROOT_DIR).get_child("src"),
File.new_for_path("/tmp") // XXX use something better here
);
try {
ClientWebView.load_resources(GLib.File.new_for_path("/tmp"));
WebView.load_resources(GLib.File.new_for_path("/tmp"));
} catch (GLib.Error err) {
assert_not_reached();
}
@ -34,7 +34,7 @@ public abstract class ClientWebViewTestCase<V> : TestCase {
protected abstract V set_up_test_view();
protected virtual void load_body_fixture(string html = "") {
ClientWebView client_view = (ClientWebView) this.test_view;
WebView client_view = (WebView) this.test_view;
client_view.load_html(html);
while (!client_view.is_content_loaded) {
Gtk.main_iteration();
@ -42,7 +42,7 @@ public abstract class ClientWebViewTestCase<V> : TestCase {
}
protected WebKit.JavascriptResult run_javascript(string command) throws Error {
ClientWebView view = (ClientWebView) this.test_view;
WebView view = (WebView) this.test_view;
view.run_javascript.begin(
command, null, (obj, res) => { async_complete(res); }
);

10
test/client/components/client-web-view-test.vala → test/client/components/components-web-view-test.vala
View file

@ -5,10 +5,10 @@
* (version 2.1 or later). See the COPYING file in this distribution.
*/
public class ClientWebViewTest : TestCase {
public class Components.WebViewTest : TestCase {
public ClientWebViewTest() {
base("ClientWebViewTest");
public WebViewTest() {
base("Components.WebViewTest");
add_test("init_web_context", init_web_context);
add_test("load_resources", load_resources);
}
@ -18,7 +18,7 @@ public class ClientWebViewTest : TestCase {
Application.Client.SCHEMA_ID
);
config.enable_debug = true;
ClientWebView.init_web_context(
WebView.init_web_context(
config,
File.new_for_path(_BUILD_ROOT_DIR).get_child("src"),
File.new_for_path("/tmp") // XXX use something better here
@ -27,7 +27,7 @@ public class ClientWebViewTest : TestCase {
public void load_resources() throws GLib.Error {
try {
ClientWebView.load_resources(GLib.File.new_for_path("/tmp"));
WebView.load_resources(GLib.File.new_for_path("/tmp"));
} catch (GLib.Error err) {
assert_not_reached();
}

2
test/client/composer/composer-web-view-test.vala
View file

@ -5,7 +5,7 @@
* (version 2.1 or later). See the COPYING file in this distribution.
*/
public class Composer.WebViewTest : ClientWebViewTestCase<Composer.WebView> {
public class Composer.WebViewTest : Components.WebViewTestCase<Composer.WebView> {
public WebViewTest() {

16
test/js/client-page-state-test.vala → test/js/components-page-state-test.vala
View file

@ -5,24 +5,24 @@
* (version 2.1 or later). See the COPYING file in this distribution.
*/
class ClientPageStateTest : ClientWebViewTestCase<ClientWebView> {
class Components.PageStateTest : WebViewTestCase<WebView> {
private class TestClientWebView : ClientWebView {
private class TestWebView : Components.WebView {
public TestClientWebView(Application.Configuration config) {
public TestWebView(Application.Configuration config) {
base(config);
}
}
public ClientPageStateTest() {
base("ClientPageStateTest");
public PageStateTest() {
base("Components.PageStateTest");
add_test("content_loaded", content_loaded);
try {
ClientWebView.load_resources(GLib.File.new_for_path("/tmp"));
WebView.load_resources(GLib.File.new_for_path("/tmp"));
} catch (GLib.Error err) {
assert_not_reached();
}
@ -45,7 +45,7 @@ class ClientPageStateTest : ClientWebViewTestCase<ClientWebView> {
assert(content_loaded_triggered);
}
protected override ClientWebView set_up_test_view() {
protected override WebView set_up_test_view() {
WebKit.UserScript test_script;
test_script = new WebKit.UserScript(
"var geary = new PageState()",
@ -55,7 +55,7 @@ class ClientPageStateTest : ClientWebViewTestCase<ClientWebView> {
null
);
ClientWebView view = new TestClientWebView(this.config);
WebView view = new TestWebView(this.config);
view.get_user_content_manager().add_script(test_script);
return view;
}

2
test/js/composer-page-state-test.vala
View file

@ -5,7 +5,7 @@
* (version 2.1 or later). See the COPYING file in this distribution.
*/
class Composer.PageStateTest : ClientWebViewTestCase<Composer.WebView> {
class Composer.PageStateTest : Components.WebViewTestCase<Composer.WebView> {
public const string COMPLETE_BODY_TEMPLATE =
"""<div id="geary-body" dir="auto">%s<div><br></div><div><br></div></div><div id="geary-signature" dir="auto"></div>""";

2
test/js/conversation-page-state-test.vala
View file

@ -5,7 +5,7 @@
* (version 2.1 or later). See the COPYING file in this distribution.
*/
class ConversationPageStateTest : ClientWebViewTestCase<ConversationWebView> {
class ConversationPageStateTest : Components.WebViewTestCase<ConversationWebView> {
public ConversationPageStateTest() {
base("ConversationPageStateTest");

6
test/meson.build
View file

@ -82,16 +82,16 @@ geary_test_client_sources = [
'client/accounts/accounts-manager-test.vala',
'client/application/application-client-test.vala',
'client/application/application-configuration-test.vala',
'client/components/client-web-view-test.vala',
'client/components/client-web-view-test-case.vala',
'client/components/components-validator-test.vala',
'client/components/components-web-view-test-case.vala',
'client/components/components-web-view-test.vala',
'client/composer/composer-web-view-test.vala',
'client/util/util-avatar-test.vala',
'client/util/util-cache-test.vala',
'client/util/util-email-test.vala',
'client/util/util-js-test.vala',
'js/client-page-state-test.vala',
'js/components-page-state-test.vala',
'js/composer-page-state-test.vala',
'js/conversation-page-state-test.vala',

6
test/test-client.vala
View file

@ -51,9 +51,9 @@ int main(string[] args) {
client.add_suite(new Accounts.ManagerTest().get_suite());
client.add_suite(new Application.ClientTest().get_suite());
client.add_suite(new Application.ConfigurationTest().get_suite());
client.add_suite(new ClientWebViewTest().get_suite());
client.add_suite(new Composer.WebViewTest().get_suite());
client.add_suite(new Components.ValidatorTest().get_suite());
client.add_suite(new Components.WebViewTest().get_suite());
client.add_suite(new Composer.WebViewTest().get_suite());
client.add_suite(new Util.Avatar.Test().get_suite());
client.add_suite(new Util.Cache.Test().get_suite());
client.add_suite(new Util.Email.Test().get_suite());
@ -61,7 +61,7 @@ int main(string[] args) {
TestSuite js = new TestSuite("js");
js.add_suite(new ClientPageStateTest().get_suite());
js.add_suite(new Components.PageStateTest().get_suite());
js.add_suite(new Composer.PageStateTest().get_suite());
js.add_suite(new ConversationPageStateTest().get_suite());

0
ui/client-web-view-allow-remote-images.js → ui/components-web-view-allow-remote-images.js
View file

2
ui/client-web-view.js → ui/components-web-view.js
View file

@ -6,7 +6,7 @@
*/
/**
* Application logic for ClientWebView and subclasses.
* Application logic for Components.WebView and subclasses.
*/
let PageState = function() {

4
ui/org.gnome.Geary.gresource.xml
View file

@ -9,8 +9,8 @@
<file compressed="true" preprocess="xml-stripblanks">accounts_editor_servers_pane.ui</file>
<file compressed="true" preprocess="xml-stripblanks">application-main-window.ui</file>
<file compressed="true" preprocess="xml-stripblanks">certificate_warning_dialog.glade</file>
<file compressed="true">client-web-view.js</file>
<file compressed="true">client-web-view-allow-remote-images.js</file>
<file compressed="true">components-web-view.js</file>
<file compressed="true">components-web-view-allow-remote-images.js</file>
<file compressed="true" preprocess="xml-stripblanks">components-attachment-pane.ui</file>
<file compressed="true" preprocess="xml-stripblanks">components-attachment-pane-menus.ui</file>
<file compressed="true" preprocess="xml-stripblanks">components-attachment-view.ui</file>