Mirrors/uBlock
1
0
Fork 0
mirror of https://github.com/gorhill/uBlock.git synced 2024-11-06 02:42:33 +01:00
Code Issues Releases Wiki Activity

Merge pull request #1321 from AlexVallat/Legacy_Toolbar_Button

Browse Source 
Legacy (non Australis) toolbar button
This commit is contained in:
AlexVallat 2015-04-26 16:40:15 +01:00
commit 128e7bf9ff
6 changed files with 324 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
platform/firefox/css/legacy-toolbar-button.css Normal file
View File

@ -0,0 +1,42 @@
#uBlock-legacy-button {
list-style-image: url('../img/browsericons/icon-large.svg');
}
#uBlock-legacy-button.off {
list-style-image: url('../img/browsericons/icon-large-off.svg');
}
toolbar[iconsize="small"] #uBlock-legacy-button {
list-style-image: url('../img/browsericons/icon16.svg');
}
toolbar[iconsize="small"] #uBlock-legacy-button.off {
list-style-image: url('../img/browsericons/icon16-off.svg');
}
#uBlock-legacy-button[badge]::before {
position: fixed;
margin-top: -2px;
padding: 1px 2px;
font-size: 9px;
font-weight: bold;
color: #fff;
background: #666;
content: attr(badge);
}
/* This hack required because if the before content changes it de-pops the popup (without firing any events). So just hide it instead. Note, can't actually *hide* it, or the same thing happens. '*/
#uBlock-legacy-button[badge=""]::before {
padding: 0;
}
/* Override off state when in palette */
toolbarpaletteitem #uBlock-legacy-button.off {
list-style-image: url('../img/browsericons/icon-large.svg');
}
/* Override badge when in palette */
toolbarpaletteitem #uBlock-legacy-button[badge]::before {
content: none;
}
/* Prevent pale moon from showing the arrow underneath the button */
#uBlock-legacy-button .toolbarbutton-menu-dropmarker {
-moz-box-orient: horizontal;
}

14
platform/firefox/frameModule.js
View File

@ -294,13 +294,15 @@ const contentObserver = {
let doc = e.target;
doc.removeEventListener(e.type, docReady, true);
// It is possible, in some cases (#1140) for document-element-inserted to occur *before* nsIWebProgressListener.onLocationChange, so ensure that the URL is correct before continuing
let messageManager = doc.docShell.getInterface(Ci.nsIContentFrameMessageManager);
if (doc.docShell) {
// It is possible, in some cases (#1140) for document-element-inserted to occur *before* nsIWebProgressListener.onLocationChange, so ensure that the URL is correct before continuing
let messageManager = doc.docShell.getInterface(Ci.nsIContentFrameMessageManager);
messageManager.sendSyncMessage(locationChangedMessageName, {
url: loc.href,
noRefresh: true, // If the URL is the same, then don't refresh it so that if this occurs after onLocationChange, no the block count isn't reset
});
messageManager.sendSyncMessage(locationChangedMessageName, {
url: loc.href,
noRefresh: true, // If the URL is the same, then don't refresh it so that if this occurs after onLocationChange, no the block count isn't reset
});
}
lss(this.contentBaseURI + 'contentscript-end.js', sandbox);

12
platform/firefox/img/browsericons/icon-large-off.svg Normal file
View File

@ -0,0 +1,12 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 18.1.1, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
width="24px" height="24px" viewBox="0 0 16 16" enable-background="new 0 0 16 16" xml:space="preserve">
<path fill="#808080" d="M15.7,4.2c-1.3-1.3-2.6-2.6-3.9-3.9C11.6,0.1,11.3,0,11,0C9,0,7,0,5,0C4.6,0,4.4,0.1,4.2,0.3
C2.9,1.6,1.6,2.9,0.3,4.2C0.1,4.4,0,4.6,0,4.9C0,7,0,9,0,11c0,0.3,0.1,0.6,0.3,0.8c1.3,1.3,2.6,2.6,3.8,3.8C4.4,15.9,4.7,16,5,16
c1,0,2,0,3,0c1,0,2,0,3,0c0.3,0,0.5,0,0.8-0.3c1.3-1.3,2.6-2.6,3.9-3.9c0.2-0.2,0.3-0.4,0.3-0.7C16,9,16,7,16,4.9
C16,4.6,15.9,4.4,15.7,4.2z"/>
<path fill="#FFFFFF" d="M10.8,8c0,1,0,2,0,3c0,0.4-0.1,0.6-0.5,0.7C9.5,11.8,8.8,12,8.1,12c-1.6,0-2.5-0.7-2.7-2.3
C5.1,8,5.3,6.3,5.2,4.7c0-0.3,0.1-0.3,0.4-0.3c1-0.1,1.1-0.1,1.1,1c0,1.1,0,2.2,0,3.3c0,1.5,0.6,1.9,2.1,1.8c0.4,0,0.5-0.2,0.5-0.6
c0-1.6,0-3.3,0-4.9c0-0.6,0.2-0.7,0.8-0.7c0.5,0,0.8,0,0.7,0.7C10.7,6,10.8,7,10.8,8z"/>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 1.1 KiB

12
platform/firefox/img/browsericons/icon-large.svg Normal file
View File

@ -0,0 +1,12 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 18.1.1, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
width="24px" height="24px" viewBox="0 0 16 16" enable-background="new 0 0 16 16" xml:space="preserve">
<path fill="#800000" d="M15.7,4.2c-1.3-1.3-2.6-2.6-3.9-3.9C11.6,0.1,11.3,0,11,0C9,0,7,0,5,0C4.6,0,4.4,0.1,4.2,0.3
C2.9,1.6,1.6,2.9,0.3,4.2C0.1,4.4,0,4.6,0,4.9C0,7,0,9,0,11c0,0.3,0.1,0.6,0.3,0.8c1.3,1.3,2.6,2.6,3.8,3.8C4.4,15.9,4.7,16,5,16
c1,0,2,0,3,0c1,0,2,0,3,0c0.3,0,0.5,0,0.8-0.3c1.3-1.3,2.6-2.6,3.9-3.9c0.2-0.2,0.3-0.4,0.3-0.7C16,9,16,7,16,4.9
C16,4.6,15.9,4.4,15.7,4.2z"/>
<path fill="#FFFFFF" d="M10.8,8c0,1,0,2,0,3c0,0.4-0.1,0.6-0.5,0.7C9.5,11.8,8.8,12,8.1,12c-1.6,0-2.5-0.7-2.7-2.3
C5.1,8,5.3,6.3,5.2,4.7c0-0.3,0.1-0.3,0.4-0.3c1-0.1,1.1-0.1,1.1,1c0,1.1,0,2.2,0,3.3c0,1.5,0.6,1.9,2.1,1.8c0.4,0,0.5-0.2,0.5-0.6
c0-1.6,0-3.3,0-4.9c0-0.6,0.2-0.7,0.8-0.7c0.5,0,0.8,0,0.7,0.7C10.7,6,10.8,7,10.8,8z"/>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 1.1 KiB

292
platform/firefox/vapi-background.js
View File

@ -59,13 +59,18 @@ vAPI.app.restart = function() {
/******************************************************************************/
// Set default preferences for user to find in about:config
vAPI.localStorage.setDefaultBool("forceLegacyToolbarButton", false);
/******************************************************************************/
// List of things that needs to be destroyed when disabling the extension
// Only functions should be added to it
var cleanupTasks = [];
// This must be updated manually, every time a new task is added/removed
var expectedNumberOfCleanups = vAPI.fennec ? 7 : 8; // 8 instances of cleanupTasks.push, but one is unique to fennec, and two to desktop.
var expectedNumberOfCleanups = vAPI.fennec ? 7 : 9; // several instances of cleanupTasks.push, but one is unique to fennec, and three to desktop.
window.addEventListener('unload', function() {
for ( var cleanup of cleanupTasks ) {
@ -285,28 +290,42 @@ var windowWatcher = {
return;
}
var tabContainer;
var tabBrowser = getTabBrowser(this);
var attachToTabBrowser = function(window, tabBrowser) {
if (!tabBrowser) {
return;
}
var tabContainer;
if ( tabBrowser.deck ) {
// Fennec
tabContainer = tabBrowser.deck;
} else if ( tabBrowser.tabContainer ) {
// desktop Firefox
tabContainer = tabBrowser.tabContainer;
vAPI.contextMenu.register(window.document);
if (vAPI.toolbarButton.attachToNewWindow) {
vAPI.toolbarButton.attachToNewWindow(window);
}
} else {
return;
}
tabContainer.addEventListener('TabClose', tabWatcher.onTabClose);
tabContainer.addEventListener('TabSelect', tabWatcher.onTabSelect);
// when new window is opened TabSelect doesn't run on the selected tab?
}
var win = this;
var tabBrowser = getTabBrowser(win);
if ( !tabBrowser ) {
return;
}
if ( tabBrowser.deck ) {
// Fennec
tabContainer = tabBrowser.deck;
} else if ( tabBrowser.tabContainer ) {
// desktop Firefox
tabContainer = tabBrowser.tabContainer;
vAPI.contextMenu.register(this.document);
// On some platforms, the tab browser isn't immediately available, try waiting a bit
win.setTimeout(function() {
attachToTabBrowser(win, getTabBrowser(win));
}, 250);
} else {
return;
attachToTabBrowser(win, tabBrowser);
}
tabContainer.addEventListener('TabClose', tabWatcher.onTabClose);
tabContainer.addEventListener('TabSelect', tabWatcher.onTabSelect);
// when new window is opened TabSelect doesn't run on the selected tab?
},
observe: function(win, topic) {
@ -492,8 +511,11 @@ vAPI.tabs.get = function(tabId, callback) {
if ( tabId === null ) {
win = Services.wm.getMostRecentWindow('navigator:browser');
tab = getTabBrowser(win).selectedTab;
tabId = this.getTabId(tab);
var tabBrowser = getTabBrowser(win);
if (tabBrowser) {
tab = tabBrowser.selectedTab;
tabId = this.getTabId(tab);
}
} else {
tab = this.getTabsForIds(tabId);
if ( tab ) {
@ -1463,10 +1485,136 @@ vAPI.toolbarButton.init = function() {
return;
}
vAPI.messaging.globalMessageManager.addMessageListener(
location.host + ':closePopup',
vAPI.toolbarButton.onPopupCloseRequested
);
cleanupTasks.push(function() {
vAPI.messaging.globalMessageManager.removeMessageListener(
location.host + ':closePopup',
vAPI.toolbarButton.onPopupCloseRequested
);
});
var CustomizableUI;
try {
CustomizableUI = Cu.import('resource:///modules/CustomizableUI.jsm', null).CustomizableUI;
} catch (ex) {
var forceLegacyToolbarButton = vAPI.localStorage.getBool("forceLegacyToolbarButton");
if (!forceLegacyToolbarButton) {
try {
CustomizableUI = Cu.import('resource:///modules/CustomizableUI.jsm', null).CustomizableUI;
} catch (ex) {
}
}
if (!CustomizableUI) {
// Create a fallback non-customizable UI button
var sss = Cc["@mozilla.org/content/style-sheet-service;1"].getService(Ci.nsIStyleSheetService);
var styleSheetUri = Services.io.newURI(vAPI.getURL("css/legacy-toolbar-button.css"), null, null);
var legacyButtonId = "uBlock-legacy-button"; // NOTE: must match legacy-toolbar-button.css
this.id = legacyButtonId;
this.viewId = legacyButtonId + "-panel";
if (!sss.sheetRegistered(styleSheetUri, sss.AUTHOR_SHEET)) {
sss.loadAndRegisterSheet(styleSheetUri, sss.AUTHOR_SHEET); // Register global so it works in all windows, including palette
}
var addLegacyToolbarButton = function(window) {
var document = window.document;
var toolbox = document.getElementById('navigator-toolbox') || document.getElementById('mail-toolbox');
if (toolbox) {
var palette = toolbox.palette;
if (!palette) {
// palette might take a little longer to appear on some platforms, give it a small delay and try again
window.setTimeout(function() {
if (toolbox.palette) {
addLegacyToolbarButton(window);
}
}, 250);
return;
}
var toolbarButton = document.createElement('toolbarbutton');
toolbarButton.setAttribute('id', legacyButtonId);
toolbarButton.setAttribute('type', 'menu'); // type = panel would be more accurate, but doesn't look as good
toolbarButton.setAttribute('removable', 'true');
toolbarButton.setAttribute('class', 'toolbarbutton-1 chromeclass-toolbar-additional');
toolbarButton.setAttribute('label', vAPI.toolbarButton.label);
var toolbarButtonPanel = document.createElement("panel");
// toolbarButtonPanel.setAttribute('level', 'parent'); NOTE: Setting level to parent breaks the popup for PaleMoon under linux (mouse pointer misaligned with content). For some reason.
vAPI.toolbarButton.populatePanel(document, toolbarButtonPanel);
toolbarButtonPanel.addEventListener('popupshowing', vAPI.toolbarButton.onViewShowing);
toolbarButtonPanel.addEventListener('popuphiding', vAPI.toolbarButton.onViewHiding);
toolbarButton.appendChild(toolbarButtonPanel);
palette.appendChild(toolbarButton);
vAPI.toolbarButton.closePopup = function() {
toolbarButtonPanel.hidePopup();
}
if (!vAPI.localStorage.getBool('legacyToolbarButtonAdded')) {
// No button yet so give it a default location. If forcing the button, just put in in the palette rather than on any specific toolbar (who knows what toolbars will be available or visible!)
var toolbar = !forceLegacyToolbarButton && document.getElementById('nav-bar');
if (toolbar) {
toolbar.appendChild(toolbarButton);
toolbar.setAttribute('currentset', toolbar.currentSet);
document.persist(toolbar.id, 'currentset');
}
vAPI.localStorage.setBool('legacyToolbarButtonAdded', 'true');
} else {
// Find the place to put the button
var toolbars = toolbox.externalToolbars.slice();
for (var child of toolbox.children) {
if (child.localName === 'toolbar') {
toolbars.push(child);
}
}
for (var toolbar of toolbars) {
var currentsetString = toolbar.getAttribute('currentset');
if (currentsetString) {
var currentset = currentsetString.split(',');
var index = currentset.indexOf(legacyButtonId);
if (index >= 0) {
// Found our button on this toolbar - but where on it?
var before = null;
for (var i = index + 1; i < currentset.length; i++) {
before = document.getElementById(currentset[i]);
if (before) {
toolbar.insertItem(legacyButtonId, before);
break;
}
}
if (!before) {
toolbar.insertItem(legacyButtonId);
}
}
}
}
}
}
}
vAPI.toolbarButton.attachToNewWindow = function(win) {
addLegacyToolbarButton(win);
}
cleanupTasks.push(function() {
for ( var win of vAPI.tabs.getWindows() ) {
var toolbarButton = win.document.getElementById(legacyButtonId);
if (toolbarButton) {
toolbarButton.parentNode.removeChild(toolbarButton);
}
}
if (sss.sheetRegistered(styleSheetUri, sss.AUTHOR_SHEET)) {
sss.unregisterSheet(styleSheetUri, sss.AUTHOR_SHEET);
}
}.bind(this));
return;
}
@ -1573,17 +1721,14 @@ vAPI.toolbarButton.init = function() {
null
);
this.closePopup = function({target}) {
this.closePopup = function(tabBrowser) {
CustomizableUI.hidePanelForNode(
target.ownerDocument.getElementById(vAPI.toolbarButton.viewId)
tabBrowser.ownerDocument.getElementById(vAPI.toolbarButton.viewId)
);
};
CustomizableUI.createWidget(this);
vAPI.messaging.globalMessageManager.addMessageListener(
location.host + ':closePopup',
this.closePopup
);
cleanupTasks.push(function() {
if ( this.CUIEvents ) {
@ -1591,11 +1736,7 @@ vAPI.toolbarButton.init = function() {
}
CustomizableUI.destroyWidget(this.id);
vAPI.messaging.globalMessageManager.removeMessageListener(
location.host + ':closePopup',
this.closePopup
);
for ( var win of vAPI.tabs.getWindows() ) {
var panel = win.document.getElementById(this.viewId);
panel.parentNode.removeChild(panel);
@ -1610,35 +1751,67 @@ vAPI.toolbarButton.init = function() {
/******************************************************************************/
vAPI.toolbarButton.onPopupCloseRequested = function({target}) {
if (vAPI.toolbarButton.closePopup) {
vAPI.toolbarButton.closePopup(target);
}
}
/******************************************************************************/
vAPI.toolbarButton.onBeforeCreated = function(doc) {
var panel = doc.createElement('panelview');
vAPI.toolbarButton.populatePanel(doc, panel);
doc.getElementById('PanelUI-multiView').appendChild(panel);
doc.defaultView.QueryInterface(Ci.nsIInterfaceRequestor)
.getInterface(Ci.nsIDOMWindowUtils)
.loadSheet(this.styleURI, 1);
};
vAPI.toolbarButton.populatePanel = function(doc, panel) {
panel.setAttribute('id', this.viewId);
var iframe = doc.createElement('iframe');
iframe.setAttribute('type', 'content');
doc.getElementById('PanelUI-multiView')
.appendChild(panel)
.appendChild(iframe);
panel.appendChild(iframe);
var updateTimer = null;
var delayedResize = function() {
var delayedResize = function(attempts) {
if ( updateTimer ) {
return;
}
updateTimer = setTimeout(resizePopup, 10);
// Sanity check
attempts = (attempts || 0) + 1;
if (attempts > 1000) {
console.error('uBlock> delayedResize: giving up after too many attemps');
return;
}
updateTimer = setTimeout(resizePopup, 10, attempts);
};
var resizePopup = function() {
var resizePopup = function(attempts) {
updateTimer = null;
var body = iframe.contentDocument.body;
panel.parentNode.style.maxWidth = 'none';
// https://github.com/chrisaljoudi/uBlock/issues/730
// Voodoo programming: this recipe works
panel.style.height = iframe.style.height = body.clientHeight.toString() + 'px';
panel.style.width = iframe.style.width = body.clientWidth.toString() + 'px';
var toPixelString = pixels => pixels.toString() + 'px';
var clientHeight = body.clientHeight;
iframe.style.height = toPixelString(clientHeight);
panel.style.height = toPixelString(clientHeight + (panel.boxObject.height - panel.clientHeight));
var clientWidth = body.clientWidth;
iframe.style.width = toPixelString(clientWidth);
panel.style.width = toPixelString(clientWidth + (panel.boxObject.width - panel.clientWidth));
if ( iframe.clientHeight !== body.clientHeight || iframe.clientWidth !== body.clientWidth ) {
delayedResize();
delayedResize(attempts);
}
};
@ -1651,11 +1824,13 @@ vAPI.toolbarButton.onBeforeCreated = function(doc) {
return;
}
var placement = CustomizableUI.getPlacementOfWidget(widgetId);
if (placement.area === CustomizableUI.AREA_PANEL) {
// Add some overrides for displaying the popup correctly in a panel
win.QueryInterface(Ci.nsIInterfaceRequestor).getInterface(Ci.nsIDOMWindowUtils)
.loadSheet(Services.io.newURI(vAPI.getURL("css/popup-vertical.css"), null, null), Ci.nsIDOMWindowUtils.AUTHOR_SHEET);
if (CustomizableUI) {
var placement = CustomizableUI.getPlacementOfWidget(widgetId);
if (placement.area === CustomizableUI.AREA_PANEL) {
// Add some overrides for displaying the popup correctly in a panel
win.QueryInterface(Ci.nsIInterfaceRequestor).getInterface(Ci.nsIDOMWindowUtils)
.loadSheet(Services.io.newURI(vAPI.getURL("css/popup-vertical.css"), null, null), Ci.nsIDOMWindowUtils.AUTHOR_SHEET);
}
}
new win.MutationObserver(delayedResize).observe(win.document.body, {
@ -1668,10 +1843,6 @@ vAPI.toolbarButton.onBeforeCreated = function(doc) {
};
iframe.addEventListener('load', onPopupReady, true);
doc.defaultView.QueryInterface(Ci.nsIInterfaceRequestor)
.getInterface(Ci.nsIDOMWindowUtils)
.loadSheet(this.styleURI, 1);
};
/******************************************************************************/
@ -1798,11 +1969,18 @@ vAPI.contextMenu.register = function(doc) {
return;
}
if (doc.getElementById(this.menuItemId)) {
// Context menu already registered for this window
return;
}
var contextMenu = doc.getElementById('contentAreaContextMenu');
var menuitem = this.createContextMenuItem(doc);
menuitem.addEventListener('command', this.onCommand);
contextMenu.addEventListener('popupshowing', this.displayMenuItem);
contextMenu.insertBefore(menuitem, doc.getElementById('inspect-separator'));
if (contextMenu) {
var menuitem = this.createContextMenuItem(doc);
menuitem.addEventListener('command', this.onCommand);
contextMenu.addEventListener('popupshowing', this.displayMenuItem);
contextMenu.insertBefore(menuitem, doc.getElementById('inspect-separator'));
}
};
/******************************************************************************/

17
platform/firefox/vapi-common.js
View File

@ -119,9 +119,9 @@ vAPI.closePopup = function() {
// background page or auxiliary pages.
// This storage is optional, but it is nice to have, for a more polished user
// experience.
const branchName = 'extensions.' + location.host + '.';
vAPI.localStorage = {
PB: Services.prefs.getBranch('extensions.' + location.host + '.'),
PB: Services.prefs.getBranch(branchName),
str: Components.classes['@mozilla.org/supports-string;1']
.createInstance(Components.interfaces.nsISupportsString),
getItem: function(key) {
@ -142,6 +142,19 @@ vAPI.localStorage = {
this.str
);
},
getBool: function(key) {
try {
return this.PB.getBoolPref(key);
} catch (ex) {
return null;
}
},
setBool: function(key, value) {
this.PB.setBoolPref(key, value);
},
setDefaultBool: function(key, defaultValue) {
Services.prefs.getDefaultBranch(branchName).setBoolPref(key, defaultValue);
},
removeItem: function(key) {
this.PB.clearUserPref(key);
},