agregoreweb / agregore-browser Goto Github PK

Shortcut	Does	Is configurable
Alt	Show Menu Bar	-
Ctrl+N	New Window	+
F11	Fullscreen	-
Ctrl+M	Minimize	-
Ctrl+W	Close	-
Ctrl+Shift+I	Open Devtools	+
Ctrl+]	Navigate Forward	+
Ctrl+[	Navigate Backward	+
Ctrl+L	Focus URL Bar	+
Ctrl+F	Find in page	-
Ctrl+R	Reload	+
Ctrl+Shift+R	Hard Reload	+
	Learn More	+
	Open Extensions Folder	+
Ctrl+.	Edit Config File	+

Other features

Web Extension support
Built-in Markdown/Gemini/JSON rendering extension
Built-in QR code scanner and generator extension
- Generate a QR code for the current page
- Scan a QR code from the browser action window.
- Right click a link or image to generate a QR code for it
Built-in ad blocker (ublock origin)
Built-in support for creating web archives via ArchiveWeb.page
Open links in new windows (right click on element)
Find text on the page (ctrl+f to bring into focus, esc to hide)
Autocomplete URLs from history (type in the URL bar, up/down to navigate, right to autocomplete)
Persist open windows when quitting
Save files from pages (any protocol, right click it)
Set as default browser (click Set As Default in the menu bar (ALT))
Set as default Torrent handler (click Set as Default Torrent in the menu bar (ALT))
Auto-convert SSB sigils, BitTorrent magnet links, /ipfs/Qm paths, and /ipns/ paths to proper URLs.
Configure whether the menu bar should be visible by default (edit .agregorerc autoHideMenuBar property)

Docs

Check out the documentation.

Contributing

Feel free to open a Github issue if you wish to tackle one of the items on the roadmap, or message @RangerMauve directly on whatever platform you can find them on.

This project uses the StandardJS code style. Please format your code with standard --fix or run npm run lint.

To build from source do the following:

Set up node.js (at least Node 18), git, and yarn
Set up Node-gyp and its dependencies for your OS
fork the repo
Pull your fork to your computer
Load submodules with git submodule update --init --recursive
Run yarn or npm install to install dependencies
Run yarn start or npm start to start the browser and test your changes
After coding, when ready to submit, run npm run lint or yarn lint to check code style
Push to your clone
Submit a pull request

Other notes:

To debug extensions, run yarn debug to have devtools opened for their background pages
If you're interested in a CLI for these protocols, check out curld cURL for Distributed Web. That project supports the same protocols as Agregore, but in a terminal way.
To download the latest versions of ArchiveWeb.page or Ublock Origin, run yarn download-extennsions

agregore-browser's People

Contributors

Stargazers

Watchers

Forkers

ninabreznik project-renard-survey tatecarson metanomial tojin12341za prm3theus deltaf1 cinnamon-bun kygost sshyran brechtcs nevrax kyorohiro abao td-17 lumenpink humbletim pineappleclout agregkit jedahan alfonsotech hexadecible jolindroth bytebrowser gardenappl wjl110 artisynthz ironeagle-ir var52yt techie177 avert pantyhose-x parsec-wallet micahscopes arualcat resession gg-big-org blipranger mey1212 timechain-academy josephmturner pinkdiamond1 p2plabs-dev akhileshthite 22388o gabrewsw alex313031 gnu-linux-libre arealayer sgnconnects kais-radwan kamek437 kanerazh khmashwl easrng tripledoublev arskan17 christianwol-ff j-a-c-k-goes philientaylor gungungun

agregore-browser's Issues

Agregore fails gemini client torture test

Visiting gemini://gemini.conman.org/test/torture yields the following error:

Google Authentication

Google login is not working, on attempting to log in, user is presented with "This browser or app may not be secure".

Related issues:

Perhaps this relates to something about needing to get OAuth?

Best lead I could find is the last comment in the Beaker issue

Gravit Designer's desktop linux app (also based on electron) had the same issue,
they "fixed" it by opening google-oauth dialog in the "real" browser instead of pop-up window with login+password

New window creation breaks after a while, breaks history

Sometimes when I close a window it messes up state somewhere in electron.

Any new windows have a blank view for the web contents.

Not sure how to reproduce consistantly but it might be related to windows created from links.

This also breaks saving window history on close, which is annoying.

.eth blockchain domain support

Now that Agregore supports IPFS...

.eth blockchain domains can link to IPFS content.
terarocket.eth for example links to an IPFS dns-link domain.

You manage .eth domains at ens.domains via Web3
https://app.ens.domains

When clicking a link opens a new window, right click is bound to the parent.

Open a new window from a link (not from right clicking the link)
Right click somewhere on the new window
Use Back or some such
It'll go back on the parent window

This is probably a side effect of attaching context menus at the top level window instead of in a global handler somewhere. 🤔

Can't open app on macOS

Installed prerelease 2 (prebuilt version) but when attempting to open it, I get this dialog:

Usually pretty good with these dialogs and resolving them but this one's new to me 😅

OS: macOS Catalina 10.15.5

Ctrl+Click opens a raw window

Control clicking a link opens a raw window (a window without URL bar)
Interestingly, it also triggers the alt menu.

Gemini links with a port seem to fail

I haven't done much investigating on this one, so apologies if I'm missing anything obvious, and please let me know if you're having trouble recreating this bug, but it seems like gemini links with a port always redirect to port 1965 (the default gemini port)

In particular, I noticed this when trying to click a link on my website (gemini://emii.gay/en/) to gemini://emii.gay:1965. Instead of taking me to that page, I was brought to gemini://emii.gay/. This also seems to be the case when directly typing it into the browser.

Again, I haven't done much experimenting to pin this down, but it's 2:30am in the morning so please forgive me if I've missed something.

Automate builds

Should set up some sort of CI with Travis or the such.

Currently doing it manually on Linux, might be messing up the Mac build. #5

https://www.electron.build/multi-platform-build

Sometimes navigation isn't detected

Every now and then when the page navigates, it won't be updated in the omni-box

Might need to listen on a different event or more types of events

Also affects navigation buttons.

Help menu not hidden when in full screen

Enabling the help menu while in full screen causes it to be shown.

This would be an issue if it were to be defaulted as shown.

Ability to save page as a desktop link

In line with the theme of leaving more up to the OS, it'd be useful to save pages as desktop shortcuts that would launch Agregore.

It might be useful to investigate if we can save hyperlinks instead of hardcoding to open Agregore.

This could be done via the shell.writeShortcutLink API.

This seems to be windows-only for now, but we might have more luck with the create-desktop-shortcuts module which seems to be cross-platform with some caveats.

Ideally we should extract the website favicon or some other useful image along with the title. This would be a good place to look for PWA manifests, too.

We should prompt the user for an output path first.

This should be a new menu item. Maybe Window -> Create Desktop Shortcut and ctrl+b as the accelerator

Community Building

Here's some stuff I'd like to tackle for helping build up the community around agregore and stuff related to it

Add markdown rendering

It'd be nice if markdown files got rendered similarly to how gemini files are rendered right now.

Progress is going to be here for now: https://github.com/RangerMauve/agregore-md-render

Hyper UTF-8 rendering

@RangerMauve I think we've discussed this before but I couldn't see an issue.

Hyper pages don't render in UTF-8.

Gemini pages render as plain text

In release 25, Gemini pages render as uninterpreted plain black text on a white background.

Possibly the Gemini extension is not running?

My extensions folder is empty.

Files being opened by agregore from the FS and links aren't working

It looks like agregore sometimes swallows the initial URL it gets opened with when it gets a link.

Development Roadmap

Here's the current state of the Agregore development roadmap.

Feel free to propose new features in Github issues or comment here if you want to tackle an item that's on the roadmap.

Roadmap / TODOs

DNS

Relates to #75
While current DNS is kinda decentralised, it isn't really.

It would be good to look at alternatives and implement them on a browser level, like we do for protocols.

I've researched a bit and here's what I've found:

ENS - Etereum Name Service - Not particularly light, expensive. Well known and well connected. PoW.
- I bought an ENS name.
  - I regret it. As it isn't very light transfer fees are expensive. Listed name prices are also inaccurate.
- Implementation notes: #75
Namecoin - PoW.
- Cheap
EmerDNS - Seems pretty dead. PoW.
- Not sure if this would require setup even if it was working.
BNS - Blockstack Name Service - Very heavy. Strongly tied to Bitcoin. PoW (probably)
~~Handshake - Distributed. PoW.~~ Looks like this isn't actually a name service

Todo: References for statements made in this issue.

Query: Anyone know of any good DNS options. Something accessible is the key. Ideally as light weight (in the not evaporating oceans sense) and distributed as possible.

Service workers

I saw service workers/PWAs on the development roadmap:

Spec lists this as being HTTPS only.

Shall Agregore break this?

No page found has no error page

Trying to visit a bad URL just gives a blank page.

Extract Gemini page rendering into extension

At the moment the protocol handler intercepts gemini pages and converts them to HTML, this should be done as an extension so that it will work for all protocols.

Broken folder links in directory listing

Links to sub-folders in the directory listing do not include a trailing slash, and redirect to a broken link as per #13.

Steps to reproduce

Navigate to a hyper/dat url with a sub-folder (example dat://daa1a5dcffa522c78d1fe5949c247fe985e4319e2a5bf0db456b0d29adab0482)
Click on a link to a subfolder (in the example click test)

Expected behaviour

Clicking subsequent links in the directory listing will lead to files and folders within that directory

Actual Behaviour

The URL in the navbar is missing a trailing slash and so #13 comes into effect.

Agregore logo isn't showing up as window icon

Not sure why this is happening since I've got the icon.png in the build folder just as electron-builder said to do

Auto-update

Maybe we can auto update via a hyper:// archive? :o

https://www.electron.build/auto-update

Should have a CLI flag to disable it for people that want to test old versions.

Agregore not redrawing when resizing on large screens

Agregore doesn't seem to be redrawing when it is resized on my 4K monitor.

It does on my 2K (1080p) monitor.

OS: Windows 10
Version: 1.0.0-17

DRM Video Streaming

I was trying Netflix and other streaming services with Agregore last night.
Apparently Netflix uses a shitty DRM protected thing
The others failed too, they came up with errors but nothing that would show how to fix them.

What I've tested:

Netflix - Doesn't work
Stan - Doesn't work
Binge - Doesn't work
ABC iView - Doesn't work
YouTube - Works
Crunchyroll - Works

Not sure if there's anything we can do to improve support.

AdBlock enhancement

As it currently is, the AdBlock extension gives a noticeable delay on loading times.

Perhaps one way we could improve it to start with is to assume that ads are only going to come from HTTP or HTTPS?

Another, if we wanted to increase speed on HTTP/S at the cost of blocking, is to give a few generic regex searches based on the list?
Block stuff that contains things like 'ads','affiliate','stat', things with subdomain 'ad' or 'ads'.
Or an inbetween, to prevent false blocks might be to check the above queries and if it matches one, then search the list?

Add ability to change the color scheme for the browser

Might be good to have a styles property in the config which can be modified to change the style of the browser.

Maybe have something like text, background, links, highlights?

I think a good place to serve it would be with CSS variables defined in a agregore:// URL.

Chrome extensions

Chrome extensions work, Firefox extensions don't.

How I installed:

Find extension on Chrome Web Store
https://crxextractor.com/
Drop in extensions folder

Results:
Works but fucks up top bar:

To do:

Make it not fuck up top bar

HTTP status code for unwriteable archive/hyperdrive

Consider changing the status code from 500 to 405 Method not Allowed (or 403 Unauthorized). 405 also returns which methods are allowed and so could be useful for protocols with more granular permission systems.

Location bar url set to about:blank

Working well, but just noticed one minor issue: when clicking the sample 'Dat Foundation Blog' link, the page loads, but the location bar gets reset to 'about:blank'. (My guess would be that maybe its coming from an iframe that should be ignored and not set the location).

URL bar stays active for full screen content

When opening full screen content, for example a video, the URL bar stays visible.

Not finishing with a / on a directory leads to all sorts of funkiness

hyper://833d(...)/client/ is a directory, going to URL hyper://833d(...)/client:

At first caused an error to print (cannot replicate and I reloaded too fast to get a good look).
Then started (and continues to) load an old copy of the directory's index.html.

hyper://833d(...)/client/assets gives the more expected result of an index but perhaps should still correct the URL to make it hyper://833d(...)/client/assets/

Behaviour in other browsers:
Beaker:

Mauve's blog hyper://94f0(...)/posts doesn't correct itself but does load correct content
hyper://833d(...)/client corrects itself to hyper://833d(...)/client/
- (strange inconsistancy)

Chrome:

Corrects itself (https://beaker.dev/docs -> https://beaker.dev/docs/)

Broken relative file links in directory listing

When accessing a URL such as hyper://94f0cab7f60fcc2a711df11c85db5e0594d11e8a3efd04a06f46a3c34d03c418/posts and omitting the trailing slash, the browser does not append a trailing slash, and so relative links on the page don't function as intended.

Steps to reproduce

Access a URL to a directory with files in a hyperdrive/dat archive and omit the trailing slash
Click one of the links to a file in the directory

Expected behaviour

The filename is appended to the URL with a slash in between and the user navigates to the file

Actual behaviour

The browser does not append the trailing slash to the URL in the navbar, and the link becomes relative to one layer higher than intended

Some gemini requests terminate before completion

This article (gemini://gemini.circumlunar.space/~solderpunk/gemlog/progress-toward-offline-first.gmi) sometimes only displays up to the point shown below. Refreshing the page sometimes fixes it. The request in the inspector still says 200.

Gemini TOFU

Gemini TLS certificates use a TOFU system for authentication. I noticed the README said "No certificate management code yet" for Gemini, so I hoped my blog post on implementing TOFU could be of use. I don't know Javascript so I can't contribute directly, but I hope this helps!

gemini://makeworld.space/gemlog/2020-07-03-tofu-rec.gmi (Portal)

Let me know if you have any questions! Note that this post doesn't discuss general certificate checks that should be done, like expiry date and hostname (and subjectAltName) validation.

Special mouse buttons not working

The back and forward buttons on my ELECOM HUGE is not functioning in Agregore.

Will look into this

Configurable Keybinds?

I've already found https://github.com/RangerMauve/agregore-browser/blob/master/app/menu.js so I have my preferred keybindings set up locally, but do you think having these configurable would be useful? Or even just have the entire menu template read from a local file instead of hardcoded, so we can do crazy things with it

[fwiw, personally used to Alt+Left and Alt+Right to navigate]

Some gemini files are not properly rendered as gemini markup

Navigating to a gemini url that is serving a gemtext file sometimes displays the plain text markup (and on my system displays improperly decoded characters)

Reproduce

navigate to gemini://apintandaparma.club/~ajc/log/2020-08-18.gmi

Expected Result

The gemini markup is rendered to HTML

Actual Result

The markup is displayed as plain text, and certain characters (such as a ') seem to be rendering as the wrong encoding.

System

Manjaro Linux 64-bit

Suggested fix

Looking at the network trace, the two files I saw this happen on have the "lang" parameter added to the content-type header. (e.g. content-type: text/gemini; lang=en)https://github.com/RangerMauve/agregore-browser/blob/master/app/protocols/gemini-protocol.js#L30 should be updated to parse the content-type header more properly then check the MIME type and subtype instead of just comparing the strings directly.

Add GUN protocol

It'd be cool to flush out a gun-fetch protocol handler.

Main stuff that we'd need to figure out:

What goes in the hostname as the 'origin'?
How should sync work?
Is there one global GUN or should we have named GUN instances per 'origin' kinda like names in hyper://
The path portion of the URL should probably be split and used to invoke .get sequentially
Should the username stuff go in the username portion? (pending on electron fix for this)

cc @amark

Ability to install extensions from a link

Have a special link format that looks like agregore://extension/install?url=URL_OF_EXTENSION_HERE
The URL should have a protocol and path so we can support loading from subfolders and from arbitrary protocols in the future.
Intercept this in the new-window event and show users a dialog to confirm the installation
Try to read the extension's manifest and prompt the user with a name and the permissions it requires using the electron.dialog API.
On accepting add to the extensions.urls list in the config and load it immediately
Should have a "Don't show this again" checkbox to prevent this origin from requesting extension adds again.

Depends on folder sync

Refresh button should load using accessed URL not typed URL

If user types a URL in the URL bar and then abandons it and later clicks refresh, the URL typed will be the URL loaded.

In other browsers and, perhaps, the expected behaviour is for the current page/URL to refresh and perhaps the URL bar to fresh to its accessed URL.

Trying to edit configuration file on Windows fails

Going to Help Menu>Help>Edit Configuration File throws an error on Windows:

Fetch permissions

Unless if I'm mistaken, there is a lot of room for abuse with PUT and DELETE. We should make a permissions pop up eventually.

Perhaps approve permissions by URL, with temporary and permanent options?

Clicking on a URL in the history redirects to the welcome page

Using the mouse instead of the keyboard to access a suggested URL from the history redirects back to the welcome page instead of proceeding to the selected page as expected.

Extension to support Beaker APIs

DatArchive API for dat:// domains
beaker.* APIs for hyper:// domains

It could be done via content scripts which wrap over top of the fetch() API that agregore provides.

Ability to configure browser "shell"

Pass in a URL for loading the browser shell
Should have a browser.html which will define the browser chrome for the URL bar and the such
Should have a theme.css to export CSS variables for the browser theme (to be used in stuff like the markdown rendering extension)
Should have a welcome.html to load as the home page in new tabs (optional?)

This will give people the ability to fully customize the browser UI of Agregore and anything relying on styling.

One thing that will be done is a modification to the IPC API to enable creating multiple browserViews and resizing them / destroying them dynamically. This will enable folks to build tabs themselves if they want to.

Also, it'd be good to have an IPC message for getting the set of capabilities a browser is providing so that extensions could account for older versions or newer versions and prompt users to update or downgrade.

The URL should be configurable in the .agregorerc file for now, maybe a shell parameter.

Ideally the agregore:// protocol should try to redirect the hyper:// URL of the shell when one exists. Or maybe to load content from it?

Create file navigation app based on fetch protocol

Beaker has a built in library tool, I think it'd be nice to create a similar library tool that's just a hyper:// web app that uses the fetch API for inspect archive contents.

Progress is here: https://github.com/RangerMauve/hyper-navigator

More than willing to take a PR for something community based.

Next steps would be to add an extension which gives you a "view source" browser action that opens the current page

Render gemini links each on their own line

Gemini links are rendered as inline elements like this...

But I believe they should be rendered as block elements like this:

I made a PR to gemini-to-html to fix this:

RangerMauve/gemini-to-html#1

agregoreweb / agregore-browser Goto Github PK

agregore-browser's Introduction

Agregore Browser

Videos

Goals

Features

Keyboard Shortcuts

Other features

Docs

Contributing

agregore-browser's People

Contributors

Stargazers

Watchers

Forkers

agregore-browser's Issues

Roadmap / TODOs

Steps to reproduce

Expected behaviour

Actual Behaviour

Steps to reproduce

Expected behaviour

Actual behaviour

Reproduce

Expected Result

Actual Result

System

Suggested fix

Recommend Projects

Recommend Topics

Recommend Org