Mirrors
/
uBlock
mirror of https://github.com/gorhill/uBlock.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add 'View source...' entry in context menu 

This new context menu entry will be available only when the
advanced setting `filterAuthorMode` is set to `true`. See:

https://github.com/gorhill/uBlock/wiki/Advanced-settings#filterauthormode

The purpose is for filter list maintainers to easily access
the source code of web pages when investigating filter issues,
without having to necessarily go through the logger.

Additionally an input field to enter URL directly has been
added to the code viewer for convenience.
This commit is contained in:
Raymond Hill 2023-03-11 15:55:51 -05:00
parent bed362d375
commit e2dd008388
No known key found for this signature in database
GPG Key ID: 25E1490B761470C2
5 changed files with 221 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/_locales/en/messages.json
View File

@ -1217,6 +1217,10 @@
"message": "Temporarily allow large media elements", "message": "Temporarily allow large media elements",
"description": "A context menu entry, present when large media elements have been blocked on the current site" "description": "A context menu entry, present when large media elements have been blocked on the current site"
}, },
"contextMenuViewSource": {
"message": "View source…",
"description": "A context menu entry, to view the source code of the target resource"
},
"shortcutCapturePlaceholder": { "shortcutCapturePlaceholder": {
"message": "Type a shortcut", "message": "Type a shortcut",
"description": "Placeholder string for input field used to capture a keyboard shortcut" "description": "Placeholder string for input field used to capture a keyboard shortcut"

4
src/code-viewer.html
View File

@ -15,6 +15,10 @@
</head> </head>
<body class="loading"> <body class="loading">
<div id="header">
<div><input type="url" value="" spellcheck="false" autofocus="false"></div>
<div id="pastURLs"></div>
</div>
<div id="content" class="codeMirrorContainer codeMirrorBreakAll"></div> <div id="content" class="codeMirrorContainer codeMirrorBreakAll"></div>
<script src="lib/codemirror/lib/codemirror.js"></script> <script src="lib/codemirror/lib/codemirror.js"></script>

37
src/css/code-viewer.css
View File

@ -8,6 +8,43 @@ body {
padding: 0; padding: 0;
width: 100vw; width: 100vw;
} }
#header {
background-color: var(--cm-gutter-surface);
border-bottom: 1px solid var(--surface-1);
padding: var(--default-gap-xsmall);
position: relative;
z-index: 1000000;
}
#header input[type="url"] {
box-sizing: border-box;
font-size: var(--font-size-smaller);
width: 100%;
}
#header:focus-within #pastURLs {
display: flex;
}
#pastURLs {
background-color: var(--surface-0);
border: 1px solid var(--border-1);
display: none;
flex-direction: column;
font-size: var(--font-size-smaller);
position: absolute;
}
#pastURLs > span {
cursor: pointer;
overflow: hidden;
padding: 2px 4px;
text-overflow: ellipsis;
white-space: nowrap;
width: 75vw;
}
#pastURLs > span.selected {
font-weight: bold;
}
#pastURLs > span:hover {
background-color: var(--surface-1);
}
#content { #content {
flex-grow: 1; flex-grow: 1;
} }

170
src/js/code-viewer.js
View File

@ -29,64 +29,29 @@ import { dom, qs$ } from './dom.js';
/******************************************************************************/ /******************************************************************************/
(async ( ) => { const urlToTextMap = new Map();
const params = new URLSearchParams(document.location.search); const params = new URLSearchParams(document.location.search);
const url = params.get('url'); let fromURL = '';
const a = qs$('.cm-search-widget .sourceURL'); const cmEditor = new CodeMirror(qs$('#content'), {
dom.attr(a, 'href', url);
dom.attr(a, 'title', url);
const response = await fetch(url);
const text = await response.text();
let mime = response.headers.get('Content-Type') || '';
mime = mime.replace(/\s*;.*$/, '').trim();
let value = '';
switch ( mime ) {
case 'text/css':
value = beautifier.css(text, { indent_size: 2 });
break;
case 'text/html':
case 'application/xhtml+xml':
case 'application/xml':
case 'image/svg+xml':
value = beautifier.html(text, { indent_size: 2 });
break;
case 'text/javascript':
case 'application/javascript':
case 'application/x-javascript':
value = beautifier.js(text, { indent_size: 4 });
break;
case 'application/json':
value = beautifier.js(text, { indent_size: 2 });
break;
default:
value = text;
break;
}
const cmEditor = new CodeMirror(qs$('#content'), {
autofocus: true, autofocus: true,
gutters: [ 'CodeMirror-linenumbers' ], gutters: [ 'CodeMirror-linenumbers' ],
lineNumbers: true, lineNumbers: true,
lineWrapping: true, lineWrapping: true,
matchBrackets: true, matchBrackets: true,
mode: mime,
styleActiveLine: { styleActiveLine: {
nonEmpty: true, nonEmpty: true,
}, },
value, });
});
uBlockDashboard.patchCodeMirrorEditor(cmEditor); uBlockDashboard.patchCodeMirrorEditor(cmEditor);
if ( dom.cl.has(dom.html, 'dark') ) { if ( dom.cl.has(dom.html, 'dark') ) {
dom.cl.add('#content .cm-s-default', 'cm-s-night'); dom.cl.add('#content .cm-s-default', 'cm-s-night');
dom.cl.remove('#content .cm-s-default', 'cm-s-default'); dom.cl.remove('#content .cm-s-default', 'cm-s-default');
} }
// Convert resource URLs into clickable links to code viewer // Convert resource URLs into clickable links to code viewer
cmEditor.addOverlay({ cmEditor.addOverlay({
re: /\b(?:href|src)=["']([^"']+)["']/g, re: /\b(?:href|src)=["']([^"']+)["']/g,
match: null, match: null,
token: function(stream) { token: function(stream) {
@ -116,20 +81,109 @@ import { dom, qs$ } from './dom.js';
stream.skipToEnd(); stream.skipToEnd();
return null; return null;
}, },
}); });
dom.on('#content', 'click', '.cm-href', ev => { /******************************************************************************/
const href = ev.target.textContent;
async function fetchResource(url) {
if ( urlToTextMap.has(url) ) {
return urlToTextMap.get(url);
}
let response, text;
try { try {
const toURL = new URL(href, url); response = await fetch(url);
vAPI.messaging.send('codeViewer', { text = await response.text();
what: 'gotoURL', } catch(reason) {
details: { return;
url: `code-viewer.html?url=${encodeURIComponent(toURL.href)}`, }
select: true, let mime = response.headers.get('Content-Type') || '';
}, mime = mime.replace(/\s*;.*$/, '').trim();
}); switch ( mime ) {
case 'text/css':
text = beautifier.css(text, { indent_size: 2 });
break;
case 'text/html':
case 'application/xhtml+xml':
case 'application/xml':
case 'image/svg+xml':
text = beautifier.html(text, { indent_size: 2 });
break;
case 'text/javascript':
case 'application/javascript':
case 'application/x-javascript':
text = beautifier.js(text, { indent_size: 4 });
break;
case 'application/json':
text = beautifier.js(text, { indent_size: 2 });
break;
default:
break;
}
urlToTextMap.set(url, { mime, text });
return { mime, text };
}
/******************************************************************************/
function updatePastURLs(url) {
const list = qs$('#pastURLs');
let current;
for ( let i = 0; i < list.children.length; i++ ) {
const span = list.children[i];
dom.cl.remove(span, 'selected');
if ( span.textContent !== url ) { continue; }
current = span;
}
if ( current === undefined ) {
current = document.createElement('span');
current.textContent = url;
list.prepend(current);
}
dom.cl.add(current, 'selected');
}
/******************************************************************************/
async function setURL(resourceURL) {
const input = qs$('#header input[type="url"]');
let to;
try {
to = new URL(resourceURL, fromURL || undefined);
} catch(ex) { } catch(ex) {
} }
}); if ( to === undefined ) { return; }
})(); if ( /^https?:\/\/./.test(to.href) === false ) { return; }
if ( to.href === fromURL ) { return; }
let r;
try {
r = await fetchResource(to.href);
} catch(reason) {
}
if ( r === undefined ) { return; }
fromURL = to.href;
dom.attr(input, 'value', to.href);
input.value = to;
const a = qs$('.cm-search-widget .sourceURL');
dom.attr(a, 'href', to);
dom.attr(a, 'title', to);
cmEditor.setOption('mode', r.mime || '');
cmEditor.setValue(r.text);
updatePastURLs(to.href);
cmEditor.focus();
}
/******************************************************************************/
setURL(params.get('url'));
dom.on('#header input[type="url"]', 'change', ev => {
setURL(ev.target.value);
});
dom.on('#pastURLs', 'mousedown', 'span', ev => {
setURL(ev.target.textContent);
});
dom.on('#content', 'click', '.cm-href', ev => {
setURL(ev.target.textContent);
});

54
src/js/contextmenu.js
View File

@ -40,6 +40,14 @@ if ( vAPI.contextMenu === undefined ) {
/******************************************************************************/ /******************************************************************************/
const BLOCK_ELEMENT_BIT = 0b00001;
const BLOCK_RESOURCE_BIT = 0b00010;
const TEMP_ALLOW_LARGE_MEDIA_BIT = 0b00100;
const SUBSCRIBE_TO_LIST_BIT = 0b01000;
const VIEW_SOURCE_BIT = 0b10000;
/******************************************************************************/
const onBlockElement = function(details, tab) { const onBlockElement = function(details, tab) {
if ( tab === undefined ) { return; } if ( tab === undefined ) { return; }
if ( /^https?:\/\//.test(tab.url) === false ) { return; } if ( /^https?:\/\//.test(tab.url) === false ) { return; }
@ -112,6 +120,18 @@ const onTemporarilyAllowLargeMediaElements = function(details, tab) {
/******************************************************************************/ /******************************************************************************/
const onViewSource = function(details, tab) {
if ( tab === undefined ) { return; }
const url = details.linkUrl || details.frameUrl || details.pageUrl || '';
if ( /^https?:\/\//.test(url) === false ) { return; }
µb.openNewTab({
url: `code-viewer.html?url=${self.encodeURIComponent(url)}`,
select: true,
});
};
/******************************************************************************/
const onEntryClicked = function(details, tab) { const onEntryClicked = function(details, tab) {
if ( details.menuItemId === 'uBlock0-blockElement' ) { if ( details.menuItemId === 'uBlock0-blockElement' ) {
return onBlockElement(details, tab); return onBlockElement(details, tab);
@ -128,6 +148,9 @@ const onEntryClicked = function(details, tab) {
if ( details.menuItemId === 'uBlock0-temporarilyAllowLargeMediaElements' ) { if ( details.menuItemId === 'uBlock0-temporarilyAllowLargeMediaElements' ) {
return onTemporarilyAllowLargeMediaElements(details, tab); return onTemporarilyAllowLargeMediaElements(details, tab);
} }
if ( details.menuItemId === 'uBlock0-viewSource' ) {
return onViewSource(details, tab);
}
}; };
/******************************************************************************/ /******************************************************************************/
@ -162,7 +185,14 @@ const menuEntries = {
title: i18n$('contextMenuTemporarilyAllowLargeMediaElements'), title: i18n$('contextMenuTemporarilyAllowLargeMediaElements'),
contexts: [ 'all' ], contexts: [ 'all' ],
documentUrlPatterns: [ 'http://*/*', 'https://*/*' ], documentUrlPatterns: [ 'http://*/*', 'https://*/*' ],
} },
viewSource: {
id: 'uBlock0-viewSource',
title: i18n$('contextMenuViewSource'),
contexts: [ 'page', 'frame', 'link' ],
documentUrlPatterns: [ 'http://*/*', 'https://*/*' ],
targetUrlPatterns: [ 'http://*/*', 'https://*/*' ],
},
}; };
/******************************************************************************/ /******************************************************************************/
@ -175,32 +205,38 @@ const update = function(tabId = undefined) {
const pageStore = µb.pageStoreFromTabId(tabId); const pageStore = µb.pageStoreFromTabId(tabId);
if ( pageStore && pageStore.getNetFilteringSwitch() ) { if ( pageStore && pageStore.getNetFilteringSwitch() ) {
if ( pageStore.shouldApplySpecificCosmeticFilters(0) ) { if ( pageStore.shouldApplySpecificCosmeticFilters(0) ) {
newBits |= 0b0001; newBits |= BLOCK_ELEMENT_BIT;
} else { } else {
newBits |= 0b0010; newBits |= BLOCK_RESOURCE_BIT;
} }
if ( pageStore.largeMediaCount !== 0 ) { if ( pageStore.largeMediaCount !== 0 ) {
newBits |= 0b0100; newBits |= TEMP_ALLOW_LARGE_MEDIA_BIT;
} }
} }
newBits |= 0b1000; newBits |= SUBSCRIBE_TO_LIST_BIT;
}
if ( µb.hiddenSettings.filterAuthorMode ) {
newBits |= VIEW_SOURCE_BIT;
} }
if ( newBits === currentBits ) { return; } if ( newBits === currentBits ) { return; }
currentBits = newBits; currentBits = newBits;
const usedEntries = []; const usedEntries = [];
if ( newBits & 0b0001 ) { if ( (newBits & BLOCK_ELEMENT_BIT) !== 0 ) {
usedEntries.push(menuEntries.blockElement); usedEntries.push(menuEntries.blockElement);
usedEntries.push(menuEntries.blockElementInFrame); usedEntries.push(menuEntries.blockElementInFrame);
} }
if ( newBits & 0b0010 ) { if ( (newBits & BLOCK_RESOURCE_BIT) !== 0 ) {
usedEntries.push(menuEntries.blockResource); usedEntries.push(menuEntries.blockResource);
} }
if ( newBits & 0b0100 ) { if ( (newBits & TEMP_ALLOW_LARGE_MEDIA_BIT) !== 0 ) {
usedEntries.push(menuEntries.temporarilyAllowLargeMediaElements); usedEntries.push(menuEntries.temporarilyAllowLargeMediaElements);
} }
if ( newBits & 0b1000 ) { if ( (newBits & SUBSCRIBE_TO_LIST_BIT) !== 0 ) {
usedEntries.push(menuEntries.subscribeToList); usedEntries.push(menuEntries.subscribeToList);
} }
if ( (newBits & VIEW_SOURCE_BIT) !== 0 ) {
usedEntries.push(menuEntries.viewSource);
}
vAPI.contextMenu.setEntries(usedEntries, onEntryClicked); vAPI.contextMenu.setEntries(usedEntries, onEntryClicked);
}; };