-
Notifications
You must be signed in to change notification settings - Fork 25
/
screenshotPageActionButton.uc.js
172 lines (170 loc) · 7.48 KB
/
screenshotPageActionButton.uc.js
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
// ==UserScript==
// @name Screenshot Page Action Button
// @version 1.3.3
// @author aminomancer
// @homepageURL https://github.com/aminomancer/uc.css.js
// @description Creates a screenshot button in the page actions area (the right side of the urlbar) that works just like the screenshot toolbar button.
// @downloadURL https://cdn.jsdelivr.net/gh/aminomancer/uc.css.js@master/JS/screenshotPageActionButton.uc.js
// @updateURL https://cdn.jsdelivr.net/gh/aminomancer/uc.css.js@master/JS/screenshotPageActionButton.uc.js
// @license This Source Code Form is subject to the terms of the Creative Commons Attribution-NonCommercial-ShareAlike International License, v. 4.0. If a copy of the CC BY-NC-SA 4.0 was not distributed with this file, You can obtain one at http://creativecommons.org/licenses/by-nc-sa/4.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
// ==/UserScript==
(function () {
// user preferences. add these in about:config if you want them to persist
// between script updates without having to reapply them.
const config = {
// if set to true, the screenshot action will not appear in private windows.
// this seems like a logical choice, but that's not how the built-in screenshot
// button or context menu item work, so this option is false by default.
"Disable in private browsing": Services.prefs.getBoolPref(
"screenshotPageActionButton.disableInPrivateBrowsing",
false
),
};
// get BrowserPageActions object from the top context for a given action/node (usually the window)
function browserPageActions(obj) {
if (obj.BrowserPageActions) return obj.BrowserPageActions;
return obj.ownerGlobal.BrowserPageActions;
}
class ScreenshotAction {
constructor() {
XPCOMUtils.defineLazyPreferenceGetter(
this,
"SCREENSHOT_BROWSER_COMPONENT",
"screenshots.browser.component.enabled",
false
);
// yields a node ID of #pageAction-urlbar-screenshot
this.id = "screenshot";
this.pref = "extensions.screenshots.disabled";
// use the icon defined in uc-globals.css, there are 2 options there — the
// camera icon from the devtools or the default screenshot icon that looks
// like scissors cutting a picture. I prefer the camera so that's the
// default if you have my theme installed. without the theme, it just uses
// the default built-in icon.
this.css = `#pageAction-urlbar-screenshot,#pageAction-panel-screenshot{list-style-image:var(--screenshot-icon,url("chrome://browser/skin/screenshot.svg"));}`;
this.muObserver = new MutationObserver(async function () {
let { screenshot } = BrowserPageActions;
if (screenshot.stringIsDone) return;
const titleString = await screenshot.getString();
let keyScreenshot = document.getElementById("key_screenshot");
const shortcut = keyScreenshot
? ` (${ShortcutUtils.prettifyShortcut(keyScreenshot)})`
: "";
if (!screenshot.action) return;
screenshot.action.setTooltip(titleString + shortcut, window);
screenshot.stringIsDone = !!shortcut;
if (shortcut) {
this.disconnect();
delete screenshot.muObserver;
}
});
// the action itself only needs to be registered once per app launch, not
// once per window. firefox internally handles replicating it across all
// windows so we want to stop here if this is the 2nd time the script has
// executed during a given runtime.
if (PageActions.actionForID("screenshot")) return;
// likewise, stylesheets loaded by the stylesheet XPCOM service are
// automatically dumped in every window, so it isn't necessary to register
// the stylesheet any more than once per session.
this.setStyle();
this.addAction();
this.muObserver.observe(document.documentElement, {
childList: true,
});
}
get action() {
return PageActions.actionForID(this.id);
}
get node() {
return BrowserPageActions.urlbarButtonNodeForActionID(this.id);
}
async getString() {
if (this.titleString) return this.titleString;
this.strings = await new Localization(["browser/screenshots.ftl"], true);
const formatted = await this.strings.formatMessages([
"screenshot-toolbarbutton",
]);
this.titleString = formatted[0].attributes[1].value;
return this.titleString;
}
async addAction() {
let title = await this.getString();
let keyScreenshot = document.getElementById("key_screenshot");
const shortcut = keyScreenshot
? ` (${ShortcutUtils.prettifyShortcut(keyScreenshot)})`
: "";
let tooltip = title + shortcut;
PageActions.addAction(
new PageActions.Action({
id: "screenshot",
title,
tooltip,
pinnedToUrlbar: true,
disablePrivateBrowsing: config[`Disable in private browsing`],
onCommand(event, buttonNode) {
browserPageActions(buttonNode).screenshot.onCommand(
event,
buttonNode
);
},
onBeforePlacedInWindow(win) {
browserPageActions(win).screenshot.onBeforePlacedInWindow(win);
},
})
);
}
// set the icon with CSS so it can be styled more easily by userChrome.css
setStyle() {
let sss = Cc["@mozilla.org/content/style-sheet-service;1"].getService(
Ci.nsIStyleSheetService
);
let uri = makeURI(
`data:text/css;charset=UTF=8,${encodeURIComponent(this.css)}`
);
if (sss.sheetRegistered(uri, sss.AUTHOR_SHEET)) return;
sss.loadAndRegisterSheet(uri, sss.AUTHOR_SHEET);
}
/**
* Screenshot extension observer
* @param {*} sub (notification subject)
* @param {string} top (notification topic)
* @param {string} data (notification data) is "false" if the extension is disabled on
* the active tab. we use this to hide the page action.
*/
observe(sub, top, data) {
if (sub === window) this.action.setDisabled(data === "true", sub);
}
/**
* Command handler — what to do when the button is clicked.
* @param {object} _e (the event that invoked us; not needed)
* @param {object} buttonNode (DOM node of the button that was activated)
*/
onCommand(_e, buttonNode) {
if (buttonNode === this.node) {
let { obs } = buttonNode.ownerGlobal.Services;
if (this.SCREENSHOT_BROWSER_COMPONENT) {
obs.notifyObservers(buttonNode.ownerGlobal, "menuitem-screenshot");
} else {
obs.notifyObservers(null, "menuitem-screenshot-extension", "toolbar");
}
}
}
/**
* Set up the screenshot extension listener and localization strings when a window is launched.
* @param {ChromeDocument} win (the window in which the button was placed)
*/
async onBeforePlacedInWindow(win) {
if (win !== window || this.isSetup) return;
win.Services.obs.addObserver(this, "toggle-screenshot-disable");
const titleString = await this.getString();
let keyScreenshot = document.getElementById("key_screenshot");
const shortcut = keyScreenshot
? ` (${ShortcutUtils.prettifyShortcut(keyScreenshot)})`
: "";
this.action.setTooltip(titleString + shortcut, win);
this.isSetup = true;
this.stringIsDone = !!shortcut;
}
}
BrowserPageActions.screenshot = new ScreenshotAction();
})();