Add GM.notification, GM.openInTab and GM.setClipboard #2590

xor10 · 2017-09-26T20:03:37Z

GM.openInTab(url, openInBackground = true)
GM.setClipboard(text)
GM.notification(details, ondone) / GM.notification(text, title, image, onclick)

Test script:

https://gist.githubusercontent.com/xor10/973c4fb17671dac987676e1b11d136ab/raw/39521431d17d61a7d8a161e2f4dec5668d9f7991/test_api.user.js

// ==UserScript==
// @name        Test
// @version     1.0.0
// @namespace   @XOR
// @include     *example.com*
// @grant       GM.notification
// @grant       GM.openInTab
// @grant       GM.setClipboard
// ==/UserScript==

GM.openInTab('https://www.google.com');
GM.setClipboard('Hello World');
GM.notification({text: 'This is a text', title: 'Notification 2', onclick: () => console.log('NotificationClick') });

arantius · 2017-09-28T16:48:02Z

src/bg/api-provider-source.js

@@ -172,4 +188,69 @@ function GM_xmlHttpRequest(d) {
  // TODO: Return an object which can be `.abort()`ed.
 }

+function GM_openInTab(url, openInBackground) {
+  let _url;


Please remove underscore prefixes.

arantius · 2017-09-28T16:48:04Z

src/bg/api-provider-source.js

+    _url = new URL(url, location.href);
+  } catch(e) {
+    throw new Error(
+        'GM.openInTab: Could not understand the URL: ' + url


Why is this split to a second line?

arantius · 2017-09-28T16:48:54Z

src/bg/api-provider-source.js

+    event.clipboardData.setData('text/plain', text);
+  }
+
+  document.addEventListener('copy', onCopy, true);


This will add a listener to the document every time setClipboard is called?

Sorry for my bad english, Anthony. If I don't remove the listener and a page script calls document.execCommand('copy') from event handler, onCopy() will be executed. I know it's a dirty solution, but it isn't possible to write to the clipboard on Firefox from background scripts.

arantius · 2017-09-28T16:49:36Z

src/bg/api-provider-source.js

+
+/*
+ * GM_notification(details, ondone)
+ * GM_notification(text, title, image, onclick)


What does this comment mean? I think you want some prose to explain the meaning of these two lines.

I'll remove this comment. The function is similar to GM_notification on Tampermonkey (https://tampermonkey.net/documentation.php#GM_notification), but there is no support to hightlight tab (it is not possible to do that on Firefox right now).

arantius · 2017-09-28T16:51:53Z

src/bg/api-provider-source.js

+  }
+
+  typeof opt.title !== 'string' && (opt.title = 'Greasemonkey');
+


What purpose does this blank line serve?

arantius · 2017-09-28T16:53:25Z

src/bg/api-provider-source.js

+    throw new Error('GM.notification: "text" must be a string');
+  }
+
+  typeof opt.title !== 'string' && (opt.title = 'Greasemonkey');


I'm not a fan of this, why not:

if (typeof opt.title != 'string') opt.title = 'Greasemonkey';

It's no longer, and easier to read.

arantius · 2017-09-28T16:53:40Z

src/bg/api-provider-source.js

+  typeof opt.image !== 'string' && (opt.image = 'skin/icon32.png');
+
+  let port = chrome.runtime.connect({name: 'UserScriptNotification'});
+


What's the significance of this blank line?

arantius · 2017-09-28T16:54:20Z

src/bg/api-provider-source.js

+    typeof opt[msgType] === 'function' && opt[msgType]();
+  });
+
+  port.postMessage({ name: 'create', details: { title: opt.title, text: opt.text, image: opt.image } });


Please keep all lines under 80 columns; try to follow formatting used throughout the rest of the code base.

arantius · 2017-09-28T16:55:26Z

src/bg/on-user-script-notification.js

+
+  port.onMessage.addListener(msg => {
+    switch (msg.name) {
+      case 'create': createNotification(msg.details, port); break;


One statement per line please.

(In some cases this makes sense, but not when followed by another branch with a different style.)

arantius · 2017-09-28T16:56:45Z

src/bg/on-user-script-open-in-tab.js

+    });
+}
+
+window.onApiOpenInTab = onApiOpenInTab;


This is the entire file, so you can skip the "private" wrapper and just put the public method directly in the global scope.

xor10 added 4 commits September 26, 2017 12:25

Add GM.openInTab

c22eb4d

Add GM.setClipboard

e91e532

Add GM.notification

4945b0d

Remove trailing spaces

e9914c6

arantius requested changes Sep 28, 2017

View reviewed changes

Fix code style

c8be5d7

arantius merged commit c8be5d7 into greasemonkey:master Oct 12, 2017

Sxderp mentioned this pull request Oct 19, 2017

Add GM_notification API #1194

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add GM.notification, GM.openInTab and GM.setClipboard #2590

Add GM.notification, GM.openInTab and GM.setClipboard #2590

xor10 commented Sep 26, 2017

arantius Sep 28, 2017

arantius Sep 28, 2017

arantius Sep 28, 2017

xor10 Sep 28, 2017 •

edited

arantius Sep 28, 2017

xor10 Sep 28, 2017

arantius Sep 28, 2017

arantius Sep 28, 2017

arantius Sep 28, 2017

arantius Sep 28, 2017

arantius Sep 28, 2017

arantius Sep 28, 2017

		}

		typeof opt.title !== 'string' && (opt.title = 'Greasemonkey');

		typeof opt.image !== 'string' && (opt.image = 'skin/icon32.png');

		let port = chrome.runtime.connect({name: 'UserScriptNotification'});

Add GM.notification, GM.openInTab and GM.setClipboard #2590

Add GM.notification, GM.openInTab and GM.setClipboard #2590

Conversation

xor10 commented Sep 26, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xor10 Sep 28, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xor10 Sep 28, 2017 •

edited