jamesfengcao/uweb
2
0
Fork 0
mirror of https://github.com/torappinfo/uweb.git synced 2024-08-14 23:54:59 +00:00
Code Issues 3 Projects Releases 1 Packages Wiki Activity

ebrowser 1.0.33

Browse source
This commit is contained in:
James Feng Cao 2024-06-25 06:06:51 +08:00
parent 536ff07ffa
commit 1577313e59
9 changed files with 98 additions and 184 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

116
ebrowser.md
View file

@ -1,116 +0,0 @@
### [Ebrowser](https://github.com/torappinfo/ebrowser): keyboard-friendly minimal suckless web browser
Ebrowser is designed with the philosophy of [Android uweb browser](https://github.com/torappinfo/uweb) ([gitlab](https://gitlab.com/jamesfengcao/uweb)).
- lightweight (less than 20k bytes) without bundled electron.
- much less memory footprint than edge/chrome browser and highly performant.
- keyboard friendly with vim-style keymaps and command line support in address bar.
- [global redirection](https://uweb.surge.sh/en/redirect/index.html#) to bypass censorship.
- user scripts at will. Ex. pressing "tr" to translate the page (need mapkeys.json config).
- customizable.
Note: Usually electron apps are heavyweight as they use browsers for simple things. Ebrowser uses core chromium effectively and very lightweight. Recommend to install electron separately.
#### Installing (for Windows, MacOS and Linux)
##### Install with prebuilt binaries
You can find prebuilt binaries [here](https://github.com/torappinfo/ebrowser/releases).
##### Install with nodejs
npm install electron
npm install ebrowser
Run ebrowser
electron ~/node_modules/ebrowser
Later on, you can run "npm install electron" to update electron/chromium or "npm install ebrowser" to update ebrowser independently.
##### Update app quickly without updating chromium
Pressing "Alt" to show the menu bar and choose "Check for updates" under "Help". OR
Type ":update" in the address bar and press "enter" key to update.
Mirror urls could be used like ":update https://uwebzh.netlify.app/misc/ebrowser". All the mirrors listed on [uweb browser](https://uwebzh.netlify.app/en/readme/index.html) could be used. The update url needs to be changed accordingly to be the folder "misc/ebrowser" under the mirror site root url.
#### Key shortcuts
- CTRL+C: stop loading
- CTRL+G: address bar to show page url
- CTRL+L: focus to address bar
- CTRL+T: new Tab
- CTRL+SHIFT+T: restore closed Tab
- CTRL+TAB: switch to next tab
- CTRL+SHIFT+TAB: switch to previous tab
- CTRL+W: close Tab
- ALT+<-: go backward
- ALT+->: go forward
- CTRL+SHIFT+R: enable global redirection ("gredirect.json")
- CTRL+R: disable global redirection
- ESC: remove focus. similar to vi normal mode.
- F1: Help
- F5: page refresh/reload
- F12: devtools
#### Address bar commands
- "/" for find-in-page
- ":" for address bar commands
- ac [bookmark/history path w/o ext] : load ".rec" file for autocomplete.
- b [bookmarkfilename w/o ext] : bookmark current page in file.
- bml [filename w/o extension]: load/execute the javascript file.
- cert : allow invalid certificates w/o arguments, otherwise restore to default.
- clear : the arguments could be
- cache : clear cache
- dns : clear dns cache
- storage: clear site storage data.
- {[options](https://www.electronjs.org/docs/latest/api/session#sescleardataoptions)}
- ext [extension path]: load unpacked Chrome extension.
- gr [gredirect index]: global redirection with corresponding index. Use the first global redirection url if no argument. Disable global redirection with any index out of the range.
- js [js code] : execute JS code at OS level. Note: "javascript:..." is special url and thus works in the current web page, while ":js ..." commands can do any OS operations.
- nc/uc : No Cookie forwarding/Use Cookie forwarding with global redirection.
- nh/uh for No/Use url history.
- nj/uj for No/Use external Javascript files.
- nr/ur for No/Use "redirect.json" for domain redirection.
- np : no proxy.
- up [proxyName] : use proxy. privous proxy or the first proxy in proxy.json w/o [proxyName]. ":up" command also disables global and domain redirections, which are not restored by ":np".
- ua [useragentName] : set user agent for future tabs. default user agent w/o arguments.
- update [updateurl] : update the app. updateurl is optional.
- pdf [filename w/o extension] {[options](https://www.electronjs.org/docs/latest/api/web-contents#contentsprinttopdfoptions)} : print to PDF file. All arguments are optional; empty option "{}" to capture long screenshot as vector graphics.
- "!" address bar commands
"!xx ..." evaluates "xx.js" with the whole text as arguments[0].
#### Commands in no-focus mode (this mode is similar to vi Normal mode)
Pressing "ESC" to enter no-focus mode if not sure.
- ":" for address bar commands
- "/" for find-in-page with address bar
- "!" for "!" address bar commands
The other commands are defined in "mapkeys.json", which will map keys to address bar commands.
#### Configuration files
- "config": lines of address bar commands.
- "search.json": search engines as shortcut-queryUrl pairs.
- "default.autoc": predefined strings for address bar auto completion.
- "gredirect.json": global redirection urls as array of urls
- "redirect.json": domain-replacementDomain pairs, default to be applied.
- "mapkeys.json": keys-addressbarCommands pairs. The addressbar commands are multiple lines of address bar command separated by "\n".
- "proxy.json": name-[ProxyConfig](https://www.electronjs.org/docs/latest/api/structures/proxy-config) pairs
- "uas.json" : name-useragent pairs
#### Javascript at three levels
- Web page: urls like "javascript:" or bookmarklet command ":bml" run in web page.
- Browser (or renderer process) : "!xx" evaluates "xx.js", which could manipulate address bar etc.
- OS level (or main process) : ":js" to execute the following js code with all OS APIs available.
#### New usages
- Vector designing with web tech to replace Adobe Illustrator/Inkscape.
- Design with web tech.
- Printing to pdf with customized paper size.
- Magnify the pdf paper size to the required size.
OR
- Adjust window width and use addressbar command line ":Pdf {}" to export vector graphics.
- Use imageMagick to convert to any other vector graphics format.
#### License
You can copy or modify the code/program under the terms of the GPL3.0 or later versions.

16
en/ebrowserreadme/index.html
View file

@ -95,6 +95,7 @@ npm install ebrowser
<ul>
<li>ac [bookmark/history path w/o ext] : load &quot;.rec&quot; file for autocomplete.</li>
<li>b [bookmarkfilename w/o ext] : bookmark current page in file.</li>
<li>bjs : Browser-level JavaScript execution.</li>
<li>bml [filename w/o extension]: load/execute the javascript file.</li>
<li>cert : allow invalid certificates w/o arguments, otherwise restore to default.</li>
<li>clear : the arguments could be
@ -109,8 +110,6 @@ npm install ebrowser
<li>gr [gredirect index]: global redirection with corresponding index. Use the first global redirection url if no argument. Disable global redirection with any index out of the range.</li>
<li>js [js code] : execute JS code at OS level. Note: &quot;javascript:...&quot; is special url and thus works in the current web page, while &quot;:js ...&quot; commands can do any OS operations.</li>
<li>nc/uc : No Cookie forwarding/Use Cookie forwarding with global redirection.</li>
<li>nh/uh for No/Use url history.</li>
<li>nj/uj for No/Use external Javascript files.</li>
<li>nr/ur for No/Use &quot;redirect.json&quot; for domain redirection.</li>
<li>np : no proxy.</li>
<li>up [proxyName] : use proxy. privous proxy or the first proxy in proxy.json w/o [proxyName]. &quot;:up&quot; command also disables global and domain redirections, which are not restored by &quot;:np&quot;.</li>
@ -144,9 +143,20 @@ npm install ebrowser
<h4 id="javascript-at-three-levels">Javascript at three levels</h4>
<ul>
<li>Web page: urls like &quot;javascript:&quot; or bookmarklet command &quot;:bml&quot; run in web page.</li>
<li>Browser (or renderer process) : &quot;!xx&quot; evaluates &quot;xx.js&quot;, which could manipulate address bar etc.</li>
<li>Browser (or renderer process) :
<ul>
<li>&quot;:bjs&quot; to execute the following js code at browser level.</li>
<li>&quot;!xx&quot; evaluates &quot;xx.js&quot;, which could manipulate address bar etc.</li>
</ul>
</li>
<li>OS level (or main process) : &quot;:js&quot; to execute the following js code with all OS APIs available.</li>
</ul>
<h5 id="examples-for-jsbjs-commands">examples for &quot;:js&quot;/&quot;:bjs&quot; commands</h5>
<pre><code>:js bJS=true //allow external Javascript files for web pages
:js bJS=false //disallow external Javascript files for web pages
:bjs bHistory=true //to record url history
:bjs bQueryHistory=true //to record query/command history
</code></pre>
<h4 id="new-usages">New usages</h4>
<ul>
<li>

2
en/index.xml
View file

@ -6,7 +6,7 @@
<description>Recent content on uweb browser: unlimited power</description>
<generator>Hugo</generator>
<language>en</language>
<lastBuildDate>Mon, 24 Jun 2024 10:28:02 +0800</lastBuildDate>
<lastBuildDate>Mon, 24 Jun 2024 19:36:44 +0800</lastBuildDate>
<atom:link href="/en/index.xml" rel="self" type="application/rss+xml" />
<item>
<title>Text selection/processing</title>

6
en/sitemap.xml
View file

@ -71,7 +71,7 @@
/>
</url><url>
<loc>/en/</loc>
<lastmod>2024-06-24T10:28:02+08:00</lastmod>
<lastmod>2024-06-24T19:36:44+08:00</lastmod>
<xhtml:link
rel="alternate"
hreflang="zh"
@ -508,7 +508,7 @@
/>
</url><url>
<loc>/en/ebrowserreadme/</loc>
<lastmod>2024-06-24T09:46:43+08:00</lastmod>
<lastmod>2024-06-24T19:36:44+08:00</lastmod>
</url><url>
<loc>/en/mirrors/</loc>
<lastmod>2024-06-18T23:17:17+08:00</lastmod>
@ -539,7 +539,7 @@
/>
</url><url>
<loc>/en/unlist/</loc>
<lastmod>2024-06-24T10:28:02+08:00</lastmod>
<lastmod>2024-06-24T19:36:44+08:00</lastmod>
<xhtml:link
rel="alternate"
hreflang="zh"

14
misc/ebrowser/README.md
View file

@ -55,6 +55,7 @@ Mirror urls could be used like ":update https://uwebzh.netlify.app/misc/ebrowser
- ":" for address bar commands
- ac [bookmark/history path w/o ext] : load ".rec" file for autocomplete.
- b [bookmarkfilename w/o ext] : bookmark current page in file.
- bjs : Browser-level JavaScript execution.
- bml [filename w/o extension]: load/execute the javascript file.
- cert : allow invalid certificates w/o arguments, otherwise restore to default.
- clear : the arguments could be
@ -66,8 +67,6 @@ Mirror urls could be used like ":update https://uwebzh.netlify.app/misc/ebrowser
- gr [gredirect index]: global redirection with corresponding index. Use the first global redirection url if no argument. Disable global redirection with any index out of the range.
- js [js code] : execute JS code at OS level. Note: "javascript:..." is special url and thus works in the current web page, while ":js ..." commands can do any OS operations.
- nc/uc : No Cookie forwarding/Use Cookie forwarding with global redirection.
- nh/uh for No/Use url history.
- nj/uj for No/Use external Javascript files.
- nr/ur for No/Use "redirect.json" for domain redirection.
- np : no proxy.
- up [proxyName] : use proxy. privous proxy or the first proxy in proxy.json w/o [proxyName]. ":up" command also disables global and domain redirections, which are not restored by ":np".
@ -97,9 +96,18 @@ The other commands are defined in "mapkeys.json", which will map keys to address
#### Javascript at three levels
- Web page: urls like "javascript:" or bookmarklet command ":bml" run in web page.
- Browser (or renderer process) : "!xx" evaluates "xx.js", which could manipulate address bar etc.
- Browser (or renderer process) :
- ":bjs" to execute the following js code at browser level.
- "!xx" evaluates "xx.js", which could manipulate address bar etc.
- OS level (or main process) : ":js" to execute the following js code with all OS APIs available.
##### examples for ":js"/":bjs" commands
:js bJS=true //allow external Javascript files for web pages
:js bJS=false //disallow external Javascript files for web pages
:bjs bHistory=true //to record url history
:bjs bQueryHistory=true //to record query/command history
#### New usages
- Vector designing with web tech to replace Adobe Illustrator/Inkscape.
- Design with web tech.

85
misc/ebrowser/index.html
View file

@ -49,6 +49,7 @@ You should have received a copy of the GNU General Public License along with thi
}
.autocomplete-items div {
cursor: pointer;
background-color: #fff;
}
.autocomplete-items div:hover {
background-color: #e9e9e9;
@ -65,8 +66,13 @@ You should have received a copy of the GNU General Public License along with thi
var closedUrls = [];
var autocStrArray = [];
var defaultSE = "https://www.bing.com/search?q=%s";
var historyFile = path.join(__dirname,'history.rec');
var bHistory = false;
var bQueryHistory = false;
var autocMode = 0; //0 for substring, 1 for startsWith
const JSPREFIX_LOAD = "(async ()=>{let d=document;async function _loadJs(u){var a=d.createElement('script');a.type='text/javascript';a.async=false;a.src=u;d.body.appendChild(a);await new Promise(resolve=>a.onload=resolve)}";
const BML_md = JSPREFIX_LOAD + "await _loadJs('https://cdn.jsdelivr.net/npm/marked@12.0.2/marked.min.js');let b=d.body;b.innerHTML=marked.parse(b.textContent)})()";
let lastKeys;
let lastKeys_millis = 0;
@ -78,7 +84,10 @@ You should have received a copy of the GNU General Public License along with thi
initSearchEngines(jsonString,false);
});
fs.readFile(path.join(__dirname,'mapkeys.json'), 'utf8', (err, jsonStr) => {
if (err) return;
if (err) {
coloncommand(":js fetch2file(repositoryurl,'mapkeys.json')");
return;
}
try {
mapKeys = JSON.parse(jsonStr);
}catch(e){}
@ -126,9 +135,24 @@ You should have received a copy of the GNU General Public License along with thi
iTab = i;
tabs.children[iTab].classList.add('curWV');
}
function cbFinishLoad(e){
let tab = e.target;
let js = tab.dataset.jsonce;
if(js){
tab.dataset.jsonce = null;
tab.executeJavaScript(js,false);
}
if(!bHistory) return;
let histItem = tab.getTitle()+" "+tab.getURL()+"\n";
fs.appendFile(historyFile, histItem, (err) => {});
}
function initTab(tab){
tab.allowpopups = true;
tab.addEventListener('did-finish-load',cbFinishLoad);
}
function newTab(){
var tab = document.createElement('webview');
tab.allowpopups = true;
initTab(tab);
tabs.appendChild(tab);
}
function tabInc(num){
@ -195,24 +219,36 @@ You should have received a copy of the GNU General Public License along with thi
}
return;
}
SCROLL: do {
let h = -32;
switch(key){
case "PageDown":
tabs.children[iTab].src =
"javascript:window.scrollBy(0,3*document.documentElement.clientHeight/4)";
return;
case "PageUp":
tabs.children[iTab].src = "javascript:window.scrollBy(0,-3*document.documentElement.clientHeight/4)";
return;
case "ArrowDown":
if(inputE !== document.activeElement || 0==inputE.nextElementSibling.children.length)
tabs.children[iTab].src="javascript:window.scrollBy(0,32)";
return;
case "ArrowUp":
if(inputE !== document.activeElement || 0==inputE.nextElementSibling.children.length)
tabs.children[iTab].src="javascript:window.scrollBy(0,-32)";
return;
case " ":
if(inputE === document.activeElement) return;
if(e.shiftKey){
h = -3*document.documentElement.clientHeight/4;
break;
}
case "PageDown":
h = 3*document.documentElement.clientHeight/4;
break;
case "PageUp":
h = -3*document.documentElement.clientHeight/4;
break;
case "ArrowDown":
h = 32;
case "ArrowUp":
if(inputE === document.activeElement &&
0!==inputE.nextElementSibling.children.length)
return;
break;
default:
break SCROLL;
}
let js = `javascript:window.scrollBy(0,${h})`;
tabs.children[iTab].src = js;
return;
}while(false);
if(inputE === document.activeElement){
if (9===e.keyCode){//tab completion
}
@ -269,6 +305,9 @@ You should have received a copy of the GNU General Public License along with thi
case "b":
bookmark(args);
return;
case "bjs":
eval(cmd.slice(5));
return;
case "bml":
bml(args);
return;
@ -375,15 +414,16 @@ You should have received a copy of the GNU General Public License along with thi
}
}
var url=q;
NOREC: do{
do {
if(q.length>12){
let c6 = q.charCodeAt(6);
if(47===c6){// '/'
let c5 = q.charCodeAt(5);
if(47===c5 && 58===q.charCodeAt(4))//http/file urls
break;
break NOREC;
if(58===c5 && 47===q.charCodeAt(7))//https://
break;
break NOREC;
}else if(q.startsWith("javascript:")){
tabs.children[iTab].executeJavaScript(q.substring(11),false);
recQueryHistory(q);
@ -398,13 +438,13 @@ You should have received a copy of the GNU General Public License along with thi
}
if(q.indexOf('.')>0){
url = 'https://'+q;
break;
break NOREC;
}
url = defaultSE.replace('%s',q);
recQueryHistory(q);
break;
}
url = bang(q, iS);
}while(false);
recQueryHistory(q);
}while(false);
tabs.children[iTab].src=url;
@ -501,6 +541,7 @@ function autocomplete(inp,container,arr) {
</div>
<script>
tabs = document.body.children[1];
initTab(tabs.children[0]);
{
let inp = document.forms[0].q;
autocomplete(inp,inp.nextElementSibling,autocStrArray);

5
misc/ebrowser/package.json
View file

@ -1,4 +1,4 @@
{"version":"1.0.31",
{"version":"1.0.33",
"name": "ebrowser",
"description": "The keyboard-friendly minimal suckless web browser",
"main": "webview.js",
@ -6,7 +6,8 @@
"webview.js",
"index.html",
"package.json",
"README.md"
"README.md",
"mapkeys.json"
],
"scripts": {
"release": "electron-builder"

42
misc/ebrowser/webview.js
View file

@ -39,7 +39,6 @@ var gredirect;
var redirects;
var bRedirect = true;
var bJS = true;
var bHistory = false;
var bForwardCookie = false;
var proxies = {};
var proxy;
@ -48,7 +47,6 @@ var defaultUA =
"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/" +
process.versions.chrome +" Safari/537.36";
app.userAgentFallback = defaultUA;
var historyFile = path.join(__dirname,'history.rec');
fs.readFile(path.join(__dirname,'redirect.json'), 'utf8', (err, jsonString) => {
if (err) return;
@ -139,7 +137,7 @@ app.on ('web-contents-created', (event, contents) => {
//contents.on('focus', ()=>{cbFocus(contents)});
//contents.on('blur',()=>{cbBlur()});
contents.session.webRequest.onBeforeRequest(interceptRequest);
contents.on('did-finish-load',()=>{cbFinishLoad(contents)});
//contents.on('did-finish-load',()=>{cbFinishLoad(contents)});
}
});
@ -194,7 +192,7 @@ function addrCommand(cmd){
else
gredirect_disable();
return;
case "js"://exetute js
case "js"://execute js
eval(cmd.slice(4));
return;
case "nc":
@ -208,18 +206,6 @@ function addrCommand(cmd){
}
forwardCookie();
return;
case "nh":
bHistory = false;
win.webContents.executeJavaScript("bQueryHistory=false",false);
return;
case "uh":
bHistory = true;
win.webContents.executeJavaScript("bQueryHistory=true",false);
return;
case "nj":
bJS = false; return;
case "uj":
bJS = true; return;
case "np":
session.defaultSession.setProxy ({mode:"direct"});
bRedirect = true;
@ -275,12 +261,6 @@ function cbConsoleMsg(e, level, msg, line, sourceid){
console.log(msg);
}
function cbFinishLoad(webContents){
if(!bHistory) return;
let histItem = webContents.getTitle()+" "+webContents.getURL()+"\n";
fs.appendFile(historyFile, histItem, (err) => {});
}
function cbFocus(webContents){
let js = "if(focusMesg){let m=focusMesg;focusMesg=null;m}";
win.webContents.executeJavaScript(js,false).then((r)=>{
@ -393,7 +373,7 @@ function topMenu(){
win.webContents.executeJavaScript(js,false)
}},
{ label: 'getURL', accelerator: 'Ctrl+G', click: ()=>{
let js="{let q=document.forms[0].q;q.focus();q.value=tabs.children[iTab].src}"
let js="{let q=document.forms[0].q;q.focus();q.value=tabs.children[iTab].getURL()}"
win.webContents.executeJavaScript(js,false)
}},
{ label: 'Select', accelerator: 'Ctrl+L', click:()=>{
@ -457,7 +437,7 @@ if(e)e.blur();try{tabs.children[iTab].stopFindInPage('clearSelection')}catch(er)
win.webContents.executeJavaScript(js,false);
}},
{ label: 'Reload', accelerator: 'F5', click: ()=>{
win.webContents.executeJavaScript("tabs.children[iTab].reload()",false);
win.webContents.executeJavaScript("tabs.children[iTab].reloadIgnoringCache()",false);
}},
{ label: 'Devtools', accelerator: 'F12', click: ()=>{
let js = "try{tabs.children[iTab].openDevTools()}catch(e){console.log(e)}";
@ -612,17 +592,7 @@ async function writeFile(filename, str){
function help(){
const readme = "README.md";
const htmlFN = path.join(__dirname,readme+".html");
if(!fs.existsSync(htmlFN)){
const readmeP = path.join(__dirname,readme);
try {
fs.copyFileSync(readmeP, htmlFN);
const postscript ="<script src='https://cdn.jsdelivr.net/npm/marked@12.0.2/marked.min.js'></script><script>var d=document;var b=d.body;var t=b.textContent;t=t.slice(0,t.length-253);b.innerHTML=marked.parse(t);d.title=d.title||b.firstElementChild.innerText.trim();</script>";
fs.appendFileSync(htmlFN,postscript);
}catch(e){
htmlFN = readmeP;
}
}
let js=`tabs.children[iTab].src="file://${htmlFN}"`;
const htmlFN = path.join(__dirname,readme);
let js=`{let t=tabs.children[iTab];t.dataset.jsonce=BML_md;t.src="file://${htmlFN}"}`;
win.webContents.executeJavaScript(js,false)
}

2
sitemap.xml
View file

@ -4,7 +4,7 @@
<sitemap>
<loc>/en/sitemap.xml</loc>
<lastmod>2024-06-24T10:28:02+08:00</lastmod>
<lastmod>2024-06-24T19:36:44+08:00</lastmod>
</sitemap>