diff --git a/README.md b/README.md index ed40026..2201ed0 100644 --- a/README.md +++ b/README.md @@ -1,116 +1,3 @@ # Rosenrot -Rosenrot is a small browser forked from an earlier version of [rose](https://github.com/mini-rose/rose). It has some additional quality of life improvements tailored to my (@NunoSempere) tastes and setup, and detailed installation instructions for Debian 12. - -![](https://raw.githubusercontent.com/NunoSempere/rosenrot-browser/master/images/3-init.png) - -![](https://raw.githubusercontent.com/NunoSempere/rosenrot-browser/master/images/7-hello-world-search.png) - -![](https://raw.githubusercontent.com/NunoSempere/rosenrot-browser/master/images/6-multiple-tabs.png) - -### Installation and usage - -You can see detailed instructions [here](./user-scripts/debian-12/install-with-dependencies.sh), for Debian 12 in particular—though they should generalize easily to other distributions. - -The general steps are to install dependencies, and then - -``` -make build -make install # or sudo make install -rose -``` - -You can also collect some profiling info, and then use that to get a perhaps faster version: - -``` -make fast ## will ask you to use the browser for a bit -make install -rose -``` - -You can also create a rose.desktop file so that it will show up in your desktop environment. You can see this documented [here](./user-scripts/debian-12/install-with-dependencies.sh). - -## Features - -- Tabs, cookies, caching -- Minimal ui, autohiding elements -- ~454L core code (the rose.c file) -- Customize appearance of the browser through css -- Built-in rose-mklink script for in-shell static links -- Optional adblocking through [wyebadblock](https://github.com/jun7/wyebadblock) -- Plugin system, seeded with: - - Libre redirect: Redirect annoying websites to open source frontends - - Readability: Strip webpages of unnecessary elements for ease of reading with a custom shortcut - - Custom style: Override the css of predetermined websites - - Max number of tabs (by default 8), configurable. - - Stand in plugin: Mimick function definitions which do nothing for the above plugins so that they can be quickly removed - -You can see some screenshots in the [images](./images) folder. - -## Similar projects - -Here are some similar projects that I could find (minimalist, mostly based on webkit): - -- [Surf](https://git.suckless.org/surf/). Suckless community. Similar goals, higher coding standards, less actively maintained. -- [Rose](https://github.com/mini-rose/rose-browser). Lua integrations, supports compilation with GTK4. Every now and then, the developer nukes the git history and tries some different approach. -- [Epiphany](https://gitlab.gnome.org/GNOME/epiphany). GNOME. Clean browser, distributed via flathub, aimed at nontechnical users. Seems actively maintained. -- [Vimb](https://github.com/fanglingsu/vimb). Reasonably actively maintained, vim keybindings. -- [Nyxt](https://github.com/atlas-engineer/nyxt). Emphasis on sophisticated key bindings. -- [Wyeb](https://github.com/jun7/wyeb) -- [Luakit](https://github.com/luakit/luakit) -- ~~[Qutebrowser](https://github.com/qutebrowser/qutebrowser). More actively maintained. I don't understand the tech stack.~~ [Based](https://github.com/qutebrowser/qutebrowser/blob/main/doc/faq.asciidoc) on [Chromium](https://wiki.qt.io/QtWebEngine) - -Here are other projects I haven't checked out as much: [netsurf](https://www.netsurf-browser.org/), [uzbl](https://www.uzbl.org/), [edbrowse](https://github.com/CMB/edbrowse), - -Here are projects with their own rendering engines which could appeal to users of rosenrot: - -- [lynx](https://lynx.invisible-island.net/) (links, elinks), [w3m](https://w3m.sourceforge.net/): command line browsers. -- [dillo](https://github.com/dillo-browser/dillo/). Has its own rendering engine, and no javascript. -- [Ladybird](https://github.com/SerenityOS/serenity/tree/master/Ladybird). SerenityOS. Uses its own html and javascript engine. Compiling it on a mainstream Linux distribution, and documenting instructions could be an interesting project, but the few times I've tried that I've failed. -- [servo](https://github.com/servo/servo). Firefox/Mozilla. An in-development browser engine written in Rust, meant to replace Gecko. Could be extremely cool once it is ready, but it has been many years in development. - -### Relationship with [rose](https://github.com/mini-rose/rose) - -- Rose is a small browser based on webkit2gtk. Previously, it described itself as aiming to be a "basement for creating your own browser using [the] gtk and webkit libraries". It has since diverged into a more featureful small browser with lua bindings, and rebased its history. You can see the original, minimal version [here](https://github.com/NunoSempere/rosenrot-browser/blob/a45d1c70f58586fed97df70650e5d066b73d0a0d/rose.c). -- The current version offers compilation with both GTK3 and GTK4, and an up to date version of webkit. -- Rosenrot is my (@NunoSempere's) fork from that earlier minimal rose. It has accumulated quality of life features and, honestly, cruft, that I like, like a "readability" plugin that simplifies annoying websites like [Matt Levine's Money Stuff newsletter](https://www.bloomberg.com/opinion/articles/2022-10-18/matt-levine-s-money-stuff-credit-suisse-was-a-reverse-meme-stock). It also incorporates ad-blocking. -- Rosenrot is also a song by the German hardcore rock band [Rammstein](https://www.youtube.com/watch?v=af59U2BRRAU). - -### Comparison with [surf](https://git.suckless.org/surf/file/surf.c.html) - -- Surf is another browser based on GTK/Webkit, from the suckless community. -- It is significantly more complex: surf.c has [2170](https://git.suckless.org/surf/file/surf.c.html) lines, vs rose.c's [454](https://git.nunosempere.com/open.source/rosenrot/src/branch/master/rose.c). -- I find its code messier and harder to understand. -- Conversely, surf has significantly more configuration options, and digs deeper into webkit internals. -- Anecdotically, surf feels slower, though I haven't tested this rigorously. -- surf has a larger community, with patches and modifications. -- surf is more opinionated, but also less amateurish. -- Like rosenrot until very recently, it [uses](https://git.suckless.org/surf/file/config.mk.html#l15) an obsolete & deprecated version of [webkit](https://blogs.gnome.org/mcatanzaro/2023/03/21/webkitgtk-api-for-gtk-4-is-now-stable/) -- My recommendation would be to use rosenrot, and if you find some feature missing, either look how surf does it and import it to rose, or move to surf. - - But then again, I've built rosenrot to cater to my own tastes, so I'd say that. - -## Folk wisdom - -Of general interest: - -- I just found out that you can inspect a GTK application with the GTK explorer if you set a certain command-line variable. Try this with `make inspect`. -- Static variables keep their value between invocations. -- By default the searchbar is pretty gigantic. I've made this so because I'm a bit myopic, but also work with my laptop in a laptop stand. Anyways, if you are a more normal person you can change this in the style.css. -- The style.css usage isn't updated until installation. This is because by default rose uses the theme located in /usr/share/themes/rose/style.css, and that file isn't updated until make install. - -The "architecture" of the application looks as follows: - -![](https://raw.githubusercontent.com/NunoSempere/rosenrot-browser/master/images/0-architecture.png) - -## webkit2gtk-4.0 vs webkit2gtk-4.1 vs webkit2gtk-6.0 - -See [this blog post](https://blogs.gnome.org/mcatanzaro/2023/03/21/webkitgtk-api-for-gtk-4-is-now-stable/) for details. webkit2gtk-4.0 is deprecated, webkit2gtk-4.1 is the current [stable](https://webkitgtk.org/reference/webkit2gtk/stable/index.html) release and uses GTK3. webkit2gtk-6.0 is the current [unstable](https://webkitgtk.org/reference/webkitgtk/unstable/index.html) release, and uses GTK4. - -Migration instructions for migration to webkit2gtk-6 and GTK4 can be seen [here](https://github.com/WebKit/WebKit/blob/ed1422596dce5ff012e64a38faf402ac1674fc7e/Source/WebKit/gtk/migrating-to-webkitgtk-6.0.md) and [here](https://docs.gtk.org/gtk4/migrating-3to4.html). - -Rosenrot is currently on the stable webkit2gtk-4.1 release using GTK3, and has removed deprecated webkit apis. It has plans to eventually migrate to webkit2gtk-6.0 eventually but not soon, because the GTK4 rewrite seems onerous. - -## Ubuntu 20.04 - -A previous version of this repository was based on Ubuntu 20.04. You can still see documentation for that distribution [here](https://git.nunosempere.com/open.source/rosenrot/src/commit/8a1e0be30df52d5a21109297fd5bbc20efec1b3b), particularly a video installing rosenrot in a fresh Ubuntu 20.04 virtual machine [here](https://video.nunosempere.com/w/t3oAvJLPHTSAMViQ6zbwTV). However, that uses the webkit2gtk-4.0 library. Instead, I recommend adapting the Debian 12 instructions. - +This branch contains a minimalist version of rosenrot, similar in many ways to the original version of rose. diff --git a/TODO.md b/TODO.md index eb3f6b0..33e88cd 100644 --- a/TODO.md +++ b/TODO.md @@ -1,57 +1,3 @@ # To do -- [ ] Settle on a C standard (C11?), and use safer string handling functions provided by it. - - See make lint for purported insecurities -- [ ] Document creating new applications, e.g., as in [Asana for Linux](https://git.nunosempere.com/NunoSempere/asana-for-linux) - - [ ] This time, use something other than Whatsapp as an example syslink. -- [ ] Fix bug about distorted audio. Maybe related to [this pipewire issue]()? - - See whether it even exists at all -- [ ] Upgrade to GTK-4 / Webkitgtk 6.0? Will take a fair amount of time, since GTK4 redesigns the application model somewhat. - - Instructions for webkit-6.0 [here](https://github.com/WebKit/WebKit/blob/ed1422596dce5ff012e64a38faf402ac1674fc7e/Source/WebKit/gtk/migrating-to-webkitgtk-6.0.md) - - Instructions for GTK-4 [here](https://docs.gtk.org/gtk4/migrating-3to4.html) - - [ ] Prepare for GTK-3 to GTK-4 transition - - [ ] Understand wtf is going on with signals and events: . - - [ ] Remove webkit2gtk-4.1 and download webkit2gtk-6.0 - - [ ] Attempt to compile - -# Previously done - -- [x] Fix PageUp/PageDown shortcuts. -- ~~[ ] Set [`webkit_web_context_set_sandbox_enabled`](), as recommended [here]()~~. Irrelevant with upgrade to libsoup3. -- [x] Update to webkit2gtk-4.1 - - [x] Change README and point to last Ubuntu 20.04 commit -- [x] Add list of similar projects: -- [x] Add comparisons against rose & surf - - [x] Compare against rose - - [x] Compare against surf -- [x] ~~Doesn't work with when Spanish is selected as the language, for some reason~~ => Previously misdiagnosed. The real issue was that it freezes when interacting with [Espanso](https://espanso.org/) substitutions, which I had set-up automatically on my machine when using words containing an ñ, like my own name, Nuño. -- [x] Add css for js alerts - - [x] Add custom alert whose css can be customized - - [ ] ~~Debug problems, e.g., this version is non-blocking.~~ => will leave as is -- [x] Figure out better way to have plugins => stand_in code seems superfluous -- [x] Double check newtab/next-tab behavior => custom style now loading correctly. -- [x] Add a shortcut for hiding the search tab. => Already exists: Ctrl+K -- [x] Find out what each of the css elements refers to. => done, see make inspect -- [x] Figure out if downloading files is doable. => it is -- [x] Look at using relative rather than absolute paths for configuration. => now makefile is a bit smarter -- [x] Streamline installation a bit - - [x] Substitute paths in makefile - - [x] Create cache directory automatically -- [x] Add an installation video walkthrough. Done, [here](https://video.nunosempere.com/w/t3oAvJLPHTSAMViQ6zbwTV) -- [x] Document `stand_in.c` better -- [x] Use a makefile. - - [x] Add clean, uninstall to makefile -- [x] Mask user agent -- [x] Launch with more than one tab from command line -- [x] Figure out merge with upstream -- [x] String substitution on uri in order to redirect to better frontends. -- [x] Present "standard" browser keybindings as an alternative. -- [x] Fix zoom in new tab -- [x] Reader mode -- [x] Add reader mode to config.def. -- [x] Make tab bar slightly prettier. -- [x] Add "open in new window" functionality. - - Useful for opening links in new tab when clicking on them and selecting that option - - And for actually opening links with the href new_tab option. - - Links: [1](), [2](), [3](), [4]() - +- [ ] Create minimalist version of rosenrot diff --git a/images/0-architecture.png b/images/0-architecture.png deleted file mode 100644 index ebc6ee9..0000000 Binary files a/images/0-architecture.png and /dev/null differ diff --git a/images/1-startup.png b/images/1-startup.png deleted file mode 100644 index 1691ee6..0000000 Binary files a/images/1-startup.png and /dev/null differ diff --git a/images/2-blog.png b/images/2-blog.png deleted file mode 100644 index ceb423e..0000000 Binary files a/images/2-blog.png and /dev/null differ diff --git a/images/3-init.png b/images/3-init.png deleted file mode 100644 index 49526e5..0000000 Binary files a/images/3-init.png and /dev/null differ diff --git a/images/4-money-stuff-raw.png b/images/4-money-stuff-raw.png deleted file mode 100644 index 2b8c959..0000000 Binary files a/images/4-money-stuff-raw.png and /dev/null differ diff --git a/images/5-money-stuff-readability.png b/images/5-money-stuff-readability.png deleted file mode 100644 index d9afdbd..0000000 Binary files a/images/5-money-stuff-readability.png and /dev/null differ diff --git a/images/6-multiple-tabs.png b/images/6-multiple-tabs.png deleted file mode 100644 index 27bcc91..0000000 Binary files a/images/6-multiple-tabs.png and /dev/null differ diff --git a/images/7-hello-world-search.png b/images/7-hello-world-search.png deleted file mode 100644 index 74ac428..0000000 Binary files a/images/7-hello-world-search.png and /dev/null differ diff --git a/images/architecture.excalidraw b/images/architecture.excalidraw deleted file mode 100644 index 4125af2..0000000 --- a/images/architecture.excalidraw +++ /dev/null @@ -1,1621 +0,0 @@ -{ - "type": "excalidraw", - "version": 2, - "source": "https://excalidraw.com", - "elements": [ - { - "type": "rectangle", - "version": 292, - "versionNonce": 463851677, - "isDeleted": false, - "id": "lBjbsP-_NqzXWwmwk8A_X", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 329.9536803142096, - "y": 5275.360621605454, - "strokeColor": "#1971c2", - "backgroundColor": "transparent", - "width": 569.850017875787, - "height": 511.1985001194681, - "seed": 1544920861, - "groupIds": [], - "frameId": null, - "roundness": { - "type": 3 - }, - "boundElements": [], - "updated": 1707673753423, - "link": null, - "locked": false - }, - { - "type": "rectangle", - "version": 151, - "versionNonce": 1697833011, - "isDeleted": false, - "id": "D38guL0T8tAKru7Rric51", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 381.2549731527413, - "y": 5422.697051010744, - "strokeColor": "#1971c2", - "backgroundColor": "transparent", - "width": 449.99293922783875, - "height": 285.72208894312826, - "seed": 1269652371, - "groupIds": [], - "frameId": null, - "roundness": { - "type": 3 - }, - "boundElements": [], - "updated": 1707673769129, - "link": null, - "locked": false - }, - { - "type": "text", - "version": 149, - "versionNonce": 39022033, - "isDeleted": false, - "id": "fFflEFFbQ4RRZ_eoByT6u", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 417.58882466308546, - "y": 5538.950319223284, - "strokeColor": "#1971c2", - "backgroundColor": "transparent", - "width": 367.1739196777344, - "height": 135, - "seed": 990822387, - "groupIds": [], - "frameId": null, - "roundness": null, - "boundElements": [], - "updated": 1707683157130, - "link": null, - "locked": false, - "fontSize": 36, - "fontFamily": 1, - "text": "\n- redirect if annoying\n- set custom style", - "textAlign": "left", - "verticalAlign": "top", - "containerId": null, - "originalText": "\n- redirect if annoying\n- set custom style", - "lineHeight": 1.25, - "baseline": 122 - }, - { - "type": "rectangle", - "version": 208, - "versionNonce": 215694365, - "isDeleted": false, - "id": "K-pKhA9fp5y9wAqulAG4u", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 438.1575179165558, - "y": 5110.275434716198, - "strokeColor": "#1971c2", - "backgroundColor": "transparent", - "width": 311.2534437057402, - "height": 142.91078863950042, - "seed": 844345885, - "groupIds": [], - "frameId": null, - "roundness": { - "type": 3 - }, - "boundElements": [ - { - "type": "text", - "id": "QcXv_ZjKNXXlWXMrl5QCk" - } - ], - "updated": 1707672960762, - "link": null, - "locked": false - }, - { - "type": "text", - "version": 175, - "versionNonce": 28815485, - "isDeleted": false, - "id": "QcXv_ZjKNXXlWXMrl5QCk", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 520.3277196888595, - "y": 5159.230829035949, - "strokeColor": "#1971c2", - "backgroundColor": "transparent", - "width": 146.9130401611328, - "height": 45, - "seed": 212952701, - "groupIds": [], - "frameId": null, - "roundness": null, - "boundElements": [], - "updated": 1707672960762, - "link": null, - "locked": false, - "fontSize": 36, - "fontFamily": 1, - "text": "load_uri", - "textAlign": "center", - "verticalAlign": "middle", - "containerId": "K-pKhA9fp5y9wAqulAG4u", - "originalText": "load_uri", - "lineHeight": 1.25, - "baseline": 35 - }, - { - "type": "rectangle", - "version": 121, - "versionNonce": 1630623891, - "isDeleted": false, - "id": "L5ptkBpEItORiR21JrXNI", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 1661.157899040488, - "y": 5156.947956050425, - "strokeColor": "#2f9e44", - "backgroundColor": "transparent", - "width": 630.9615879030628, - "height": 373.3702566162666, - "seed": 305373757, - "groupIds": [], - "frameId": null, - "roundness": { - "type": 3 - }, - "boundElements": [], - "updated": 1707673702525, - "link": null, - "locked": false - }, - { - "type": "rectangle", - "version": 283, - "versionNonce": 1061180947, - "isDeleted": false, - "id": "kTn3xLEawZVegYqBQKAkU", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 1634.5922790423188, - "y": 5581.239549379173, - "strokeColor": "#2f9e44", - "backgroundColor": "transparent", - "width": 688.764684838534, - "height": 192.0593832722834, - "seed": 2059495219, - "groupIds": [], - "frameId": null, - "roundness": { - "type": 3 - }, - "boundElements": [ - { - "type": "text", - "id": "Bf-8Lm_N3VLGxGi5-3DiP" - } - ], - "updated": 1707673706526, - "link": null, - "locked": false - }, - { - "type": "text", - "version": 362, - "versionNonce": 798104499, - "isDeleted": false, - "id": "Bf-8Lm_N3VLGxGi5-3DiP", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 1699.2898375260388, - "y": 5654.769241015314, - "strokeColor": "#2f9e44", - "backgroundColor": "transparent", - "width": 559.3695678710938, - "height": 45, - "seed": 924059859, - "groupIds": [], - "frameId": null, - "roundness": null, - "boundElements": [], - "updated": 1707673706526, - "link": null, - "locked": false, - "fontSize": 36, - "fontFamily": 1, - "text": "handle_signal_create_new_tab", - "textAlign": "center", - "verticalAlign": "middle", - "containerId": "kTn3xLEawZVegYqBQKAkU", - "originalText": "handle_signal_create_new_tab", - "lineHeight": 1.25, - "baseline": 35 - }, - { - "type": "rectangle", - "version": 213, - "versionNonce": 1201318259, - "isDeleted": false, - "id": "2IpPyxs-x8Wz_kBqVa6CX", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 1682.9828836653555, - "y": 5286.247648117623, - "strokeColor": "#2f9e44", - "backgroundColor": "transparent", - "width": 567.3478333445603, - "height": 209.05727764828148, - "seed": 828279123, - "groupIds": [], - "frameId": null, - "roundness": { - "type": 3 - }, - "boundElements": [], - "updated": 1707673695733, - "link": null, - "locked": false - }, - { - "type": "rectangle", - "version": 120, - "versionNonce": 1691912531, - "isDeleted": false, - "id": "bnaXbVm0k4aYZLAvbDsAd", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 1447.4287644530762, - "y": 4935.233271680985, - "strokeColor": "#2f9e44", - "backgroundColor": "transparent", - "width": 980.1651284240668, - "height": 1000.0333404867163, - "seed": 1353279059, - "groupIds": [], - "frameId": null, - "roundness": { - "type": 3 - }, - "boundElements": [ - { - "id": "OOGhcBFCoNkQmPrl9pRrp", - "type": "arrow" - } - ], - "updated": 1707673626112, - "link": null, - "locked": false - }, - { - "type": "text", - "version": 35, - "versionNonce": 289395647, - "isDeleted": false, - "id": "4_Mza9X2bhxxRMV-25Uot", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 1884.7487932437105, - "y": 5022.873697835296, - "strokeColor": "#2f9e44", - "backgroundColor": "transparent", - "width": 164.4130401611328, - "height": 45, - "seed": 256892275, - "groupIds": [], - "frameId": null, - "roundness": null, - "boundElements": [], - "updated": 1707683157130, - "link": null, - "locked": false, - "fontSize": 36, - "fontFamily": 1, - "text": "New tabs", - "textAlign": "left", - "verticalAlign": "top", - "containerId": null, - "originalText": "New tabs", - "lineHeight": 1.25, - "baseline": 32 - }, - { - "type": "rectangle", - "version": 113, - "versionNonce": 571646781, - "isDeleted": false, - "id": "O0Alf80_Bn5JTcGMp1MoV", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 214.92743269900393, - "y": 4940.194365644143, - "strokeColor": "#1971c2", - "backgroundColor": "transparent", - "width": 813.0659476519272, - "height": 915.0533139079181, - "seed": 2044070291, - "groupIds": [], - "frameId": null, - "roundness": { - "type": 3 - }, - "boundElements": [ - { - "id": "rgYQgvixyEZ0igTE5fZQB", - "type": "arrow" - }, - { - "id": "OOGhcBFCoNkQmPrl9pRrp", - "type": "arrow" - }, - { - "id": "u-ugk9JQxAw2y5eNv5Yfh", - "type": "arrow" - } - ], - "updated": 1707673774042, - "link": null, - "locked": false - }, - { - "type": "text", - "version": 27, - "versionNonce": 36146097, - "isDeleted": false, - "id": "1xAPTzwqmBuUmYgRtoZUm", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 467.06286594298115, - "y": 5005.352960752135, - "strokeColor": "#1971c2", - "backgroundColor": "transparent", - "width": 235.17391967773438, - "height": 45, - "seed": 2070282547, - "groupIds": [], - "frameId": null, - "roundness": null, - "boundElements": [], - "updated": 1707683157131, - "link": null, - "locked": false, - "fontSize": 36, - "fontFamily": 1, - "text": "Load content", - "textAlign": "left", - "verticalAlign": "top", - "containerId": null, - "originalText": "Load content", - "lineHeight": 1.25, - "baseline": 32 - }, - { - "type": "rectangle", - "version": 204, - "versionNonce": 1437022781, - "isDeleted": false, - "id": "hAR8oBD352ZvGSkOnh6SN", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 1529.4312644428865, - "y": 6121.548024776036, - "strokeColor": "#e03131", - "backgroundColor": "transparent", - "width": 892.3894547399203, - "height": 524.1017432599529, - "seed": 1221527987, - "groupIds": [], - "frameId": null, - "roundness": { - "type": 3 - }, - "boundElements": [ - { - "id": "hrDotwFBpFULoOICzu5H1", - "type": "arrow" - }, - { - "id": "u-ugk9JQxAw2y5eNv5Yfh", - "type": "arrow" - } - ], - "updated": 1707673563657, - "link": null, - "locked": false - }, - { - "type": "rectangle", - "version": 159, - "versionNonce": 475047773, - "isDeleted": false, - "id": "zeYWzr8lPNlcL_AOgSJL6", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 1747.570908934867, - "y": 6291.52696853602, - "strokeColor": "#e03131", - "backgroundColor": "transparent", - "width": 487.2729721119563, - "height": 130.31719021598838, - "seed": 1569142781, - "groupIds": [], - "frameId": null, - "roundness": { - "type": 3 - }, - "boundElements": [ - { - "type": "text", - "id": "XQdjVyJWffmfcqxY9N2ub" - } - ], - "updated": 1707673563657, - "link": null, - "locked": false - }, - { - "type": "text", - "version": 115, - "versionNonce": 769504189, - "isDeleted": false, - "id": "XQdjVyJWffmfcqxY9N2ub", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 1908.1530508135988, - "y": 6334.185563644014, - "strokeColor": "#e03131", - "backgroundColor": "transparent", - "width": 166.1086883544922, - "height": 45, - "seed": 65177661, - "groupIds": [], - "frameId": null, - "roundness": null, - "boundElements": [], - "updated": 1707673563657, - "link": null, - "locked": false, - "fontSize": 36, - "fontFamily": 1, - "text": "show_bar", - "textAlign": "center", - "verticalAlign": "middle", - "containerId": "zeYWzr8lPNlcL_AOgSJL6", - "originalText": "show_bar", - "lineHeight": 1.25, - "baseline": 35 - }, - { - "type": "rectangle", - "version": 175, - "versionNonce": 919221277, - "isDeleted": false, - "id": "S05UWy65Aw7t3e_FKj6wF", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 1671.080384242874, - "y": 6453.006965108006, - "strokeColor": "#e03131", - "backgroundColor": "transparent", - "width": 662.9178806639407, - "height": 124.65122542398876, - "seed": 1399809459, - "groupIds": [], - "frameId": null, - "roundness": { - "type": 3 - }, - "boundElements": [ - { - "type": "text", - "id": "cUKDAAqD6NId7B9-gW2Mt" - } - ], - "updated": 1707673563657, - "link": null, - "locked": false - }, - { - "type": "text", - "version": 182, - "versionNonce": 50833533, - "isDeleted": false, - "id": "cUKDAAqD6NId7B9-gW2Mt", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 1721.1480281881254, - "y": 6492.83257782, - "strokeColor": "#e03131", - "backgroundColor": "transparent", - "width": 562.7825927734375, - "height": 45, - "seed": 1299164371, - "groupIds": [], - "frameId": null, - "roundness": null, - "boundElements": [], - "updated": 1707673563657, - "link": null, - "locked": false, - "fontSize": 36, - "fontFamily": 1, - "text": "handle_signal_bar_press_enter", - "textAlign": "center", - "verticalAlign": "middle", - "containerId": "S05UWy65Aw7t3e_FKj6wF", - "originalText": "handle_signal_bar_press_enter", - "lineHeight": 1.25, - "baseline": 35 - }, - { - "type": "text", - "version": 117, - "versionNonce": 1051526111, - "isDeleted": false, - "id": "-jDLBavavoJt3OpRHv4ll", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 486.8937427149799, - "y": 6351.019598852015, - "strokeColor": "#9c36b5", - "backgroundColor": "transparent", - "width": 288.89129638671875, - "height": 45, - "seed": 913909523, - "groupIds": [], - "frameId": null, - "roundness": null, - "boundElements": [], - "updated": 1707683157131, - "link": null, - "locked": false, - "fontSize": 36, - "fontFamily": 1, - "text": "handle_shortcut", - "textAlign": "left", - "verticalAlign": "top", - "containerId": null, - "originalText": "handle_shortcut", - "lineHeight": 1.25, - "baseline": 32 - }, - { - "type": "rectangle", - "version": 121, - "versionNonce": 1757871805, - "isDeleted": false, - "id": "L5MRksGchbiVRhzoFbOpb", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 435.9000595869843, - "y": 6308.524862912019, - "strokeColor": "#9c36b5", - "backgroundColor": "transparent", - "width": 390.9515706479651, - "height": 124.65122542398876, - "seed": 1926801363, - "groupIds": [], - "frameId": null, - "roundness": { - "type": 3 - }, - "boundElements": [], - "updated": 1707673251407, - "link": null, - "locked": false - }, - { - "type": "text", - "version": 99, - "versionNonce": 293399953, - "isDeleted": false, - "id": "2Y9_gUQQFGzNZEu8t6uFs", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 447.23198917098307, - "y": 6504.000648236001, - "strokeColor": "#9c36b5", - "backgroundColor": "transparent", - "width": 408.1956481933594, - "height": 45, - "seed": 1896165373, - "groupIds": [], - "frameId": null, - "roundness": null, - "boundElements": [], - "updated": 1707683157131, - "link": null, - "locked": false, - "fontSize": 36, - "fontFamily": 1, - "text": "handle_signal_keypress", - "textAlign": "left", - "verticalAlign": "top", - "containerId": null, - "originalText": "handle_signal_keypress", - "lineHeight": 1.25, - "baseline": 32 - }, - { - "type": "rectangle", - "version": 114, - "versionNonce": 1180316541, - "isDeleted": false, - "id": "1rI6IPuRKyVZy2I6pNp8U", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 413.23620041898675, - "y": 6464.338894692005, - "strokeColor": "#9c36b5", - "backgroundColor": "transparent", - "width": 504.27086648795466, - "height": 138.81613740398734, - "seed": 983950195, - "groupIds": [], - "frameId": null, - "roundness": { - "type": 3 - }, - "boundElements": [], - "updated": 1707673251407, - "link": null, - "locked": false - }, - { - "type": "rectangle", - "version": 117, - "versionNonce": 373164445, - "isDeleted": false, - "id": "ZJDyrJsYvkhB_BzYIvayb", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 274.42006301499896, - "y": 6132.8799543600335, - "strokeColor": "#9c36b5", - "backgroundColor": "transparent", - "width": 798.9010356719282, - "height": 543.932620031951, - "seed": 1295829843, - "groupIds": [], - "frameId": null, - "roundness": { - "type": 3 - }, - "boundElements": [ - { - "id": "rgYQgvixyEZ0igTE5fZQB", - "type": "arrow" - }, - { - "id": "hKROsWtUG2MVFm6pbsAa9", - "type": "arrow" - }, - { - "id": "hrDotwFBpFULoOICzu5H1", - "type": "arrow" - } - ], - "updated": 1707673567319, - "link": null, - "locked": false - }, - { - "type": "text", - "version": 27, - "versionNonce": 54472703, - "isDeleted": false, - "id": "Q46NuA9EPguz4jqy-C0f2", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 467.0628659429814, - "y": 6200.871531864027, - "strokeColor": "#9c36b5", - "backgroundColor": "transparent", - "width": 396.3043518066406, - "height": 45, - "seed": 663162195, - "groupIds": [], - "frameId": null, - "roundness": null, - "boundElements": [], - "updated": 1707683157131, - "link": null, - "locked": false, - "fontSize": 36, - "fontFamily": 1, - "text": "Shortcuts and actions", - "textAlign": "left", - "verticalAlign": "top", - "containerId": null, - "originalText": "Shortcuts and actions", - "lineHeight": 1.25, - "baseline": 32 - }, - { - "type": "arrow", - "version": 101, - "versionNonce": 191281149, - "isDeleted": false, - "id": "rgYQgvixyEZ0igTE5fZQB", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 596.2489821052908, - "y": 6127.213989568034, - "strokeColor": "#9c36b5", - "backgroundColor": "transparent", - "width": 8.864939853058445, - "height": 266.30034522397546, - "seed": 523993811, - "groupIds": [], - "frameId": null, - "roundness": { - "type": 2 - }, - "boundElements": [], - "updated": 1707673774042, - "link": null, - "locked": false, - "startBinding": { - "elementId": "ZJDyrJsYvkhB_BzYIvayb", - "gap": 5.6659647919991585, - "focus": -0.16746411483253631 - }, - "endBinding": { - "elementId": "O0Alf80_Bn5JTcGMp1MoV", - "gap": 5.665964791997794, - "focus": 0.1173541054782275 - }, - "lastCommittedPoint": null, - "startArrowhead": null, - "endArrowhead": "arrow", - "points": [ - [ - 0, - 0 - ], - [ - -8.864939853058445, - -266.30034522397546 - ] - ] - }, - { - "type": "arrow", - "version": 23, - "versionNonce": 686349203, - "isDeleted": false, - "id": "hKROsWtUG2MVFm6pbsAa9", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 1078.9870634789268, - "y": 6138.545919152033, - "strokeColor": "#9c36b5", - "backgroundColor": "transparent", - "width": 376.7866586679661, - "height": 218.13964449198193, - "seed": 1393157853, - "groupIds": [], - "frameId": null, - "roundness": { - "type": 2 - }, - "boundElements": [], - "updated": 1707673280037, - "link": null, - "locked": false, - "startBinding": { - "elementId": "ZJDyrJsYvkhB_BzYIvayb", - "focus": -0.06311111111110633, - "gap": 5.665964791999613 - }, - "endBinding": null, - "lastCommittedPoint": null, - "startArrowhead": null, - "endArrowhead": "arrow", - "points": [ - [ - 0, - 0 - ], - [ - 376.7866586679661, - -218.13964449198193 - ] - ] - }, - { - "type": "arrow", - "version": 216, - "versionNonce": 1565835027, - "isDeleted": false, - "id": "hrDotwFBpFULoOICzu5H1", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 1087.4860106669257, - "y": 6427.510123544007, - "strokeColor": "#9c36b5", - "backgroundColor": "transparent", - "width": 424.9473593999619, - "height": 0, - "seed": 328404211, - "groupIds": [], - "frameId": null, - "roundness": { - "type": 2 - }, - "boundElements": [], - "updated": 1707673569787, - "link": null, - "locked": false, - "startBinding": { - "elementId": "ZJDyrJsYvkhB_BzYIvayb", - "focus": 0.08333333333333513, - "gap": 14.164911979998578 - }, - "endBinding": { - "elementId": "hAR8oBD352ZvGSkOnh6SN", - "focus": -0.1675675675675617, - "gap": 16.99789437599884 - }, - "lastCommittedPoint": null, - "startArrowhead": null, - "endArrowhead": "arrow", - "points": [ - [ - 0, - 0 - ], - [ - 424.9473593999619, - 0 - ] - ] - }, - { - "type": "arrow", - "version": 104, - "versionNonce": 1758239933, - "isDeleted": false, - "id": "OOGhcBFCoNkQmPrl9pRrp", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 1435.9428453748942, - "y": 5360.4529481605805, - "strokeColor": "#2f9e44", - "backgroundColor": "transparent", - "width": 393.7845530439645, - "height": 13.2858147107072, - "seed": 482123795, - "groupIds": [], - "frameId": null, - "roundness": { - "type": 2 - }, - "boundElements": [], - "updated": 1707673774042, - "link": null, - "locked": false, - "startBinding": { - "elementId": "bnaXbVm0k4aYZLAvbDsAd", - "gap": 11.485919078181837, - "focus": 0.17603894030176798 - }, - "endBinding": { - "elementId": "O0Alf80_Bn5JTcGMp1MoV", - "gap": 14.164911979998578, - "focus": -0.02077151335312082 - }, - "lastCommittedPoint": null, - "startArrowhead": null, - "endArrowhead": "arrow", - "points": [ - [ - 0, - 0 - ], - [ - -393.7845530439645, - 13.2858147107072 - ] - ] - }, - { - "type": "rectangle", - "version": 167, - "versionNonce": 1561289395, - "isDeleted": false, - "id": "AlUiNslcnYyZfAjv_2JMm", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 1583.2579299668814, - "y": 4421.758587176188, - "strokeColor": "#1e1e1e", - "backgroundColor": "transparent", - "width": 606.2582327439459, - "height": 390.95157064796416, - "seed": 1299739283, - "groupIds": [], - "frameId": null, - "roundness": { - "type": 3 - }, - "boundElements": [], - "updated": 1707673578348, - "link": null, - "locked": false - }, - { - "type": "text", - "version": 135, - "versionNonce": 931861361, - "isDeleted": false, - "id": "K0CghXN_uWQwYvTExNr05", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 1724.907049766869, - "y": 4484.0841998881815, - "strokeColor": "#1e1e1e", - "backgroundColor": "transparent", - "width": 303.15216064453125, - "height": 45, - "seed": 641161555, - "groupIds": [], - "frameId": null, - "roundness": null, - "boundElements": [], - "updated": 1707683157132, - "link": null, - "locked": false, - "fontSize": 36, - "fontFamily": 1, - "text": "Initialize and run", - "textAlign": "left", - "verticalAlign": "top", - "containerId": null, - "originalText": "Initialize and run", - "lineHeight": 1.25, - "baseline": 32 - }, - { - "type": "rectangle", - "version": 167, - "versionNonce": 1954976243, - "isDeleted": false, - "id": "N5lcCnRhJYGZLkcFGkfbe", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 1724.907049766868, - "y": 4656.8961260441665, - "strokeColor": "#1e1e1e", - "backgroundColor": "transparent", - "width": 328.62595793597075, - "height": 121.8182430279885, - "seed": 1080775827, - "groupIds": [], - "frameId": null, - "roundness": { - "type": 3 - }, - "boundElements": [ - { - "type": "text", - "id": "e6tfFYraAdaCqKf28dLvN" - } - ], - "updated": 1707673578348, - "link": null, - "locked": false - }, - { - "type": "text", - "version": 154, - "versionNonce": 2087050131, - "isDeleted": false, - "id": "e6tfFYraAdaCqKf28dLvN", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 1826.5026367670798, - "y": 4695.305247558161, - "strokeColor": "#1e1e1e", - "backgroundColor": "transparent", - "width": 125.43478393554688, - "height": 45, - "seed": 1034146483, - "groupIds": [], - "frameId": null, - "roundness": null, - "boundElements": [], - "updated": 1707673578348, - "link": null, - "locked": false, - "fontSize": 36, - "fontFamily": 1, - "text": "config.h", - "textAlign": "center", - "verticalAlign": "middle", - "containerId": "N5lcCnRhJYGZLkcFGkfbe", - "originalText": "config.h", - "lineHeight": 1.25, - "baseline": 35 - }, - { - "type": "text", - "version": 135, - "versionNonce": 687265823, - "isDeleted": false, - "id": "IK0wfqCqtOvFtoF7rkfM_", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 1818.3954688348604, - "y": 4571.906654164174, - "strokeColor": "#1e1e1e", - "backgroundColor": "transparent", - "width": 99.06521606445312, - "height": 45, - "seed": 503642525, - "groupIds": [], - "frameId": null, - "roundness": null, - "boundElements": [], - "updated": 1707683157132, - "link": null, - "locked": false, - "fontSize": 36, - "fontFamily": 1, - "text": "main.c", - "textAlign": "left", - "verticalAlign": "top", - "containerId": null, - "originalText": "main.c", - "lineHeight": 1.25, - "baseline": 32 - }, - { - "type": "text", - "version": 69, - "versionNonce": 681147729, - "isDeleted": false, - "id": "Kx8WB56e2RavWYFlO2cGn", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 489.7267251109794, - "y": 5481.2940032800925, - "strokeColor": "#1971c2", - "backgroundColor": "transparent", - "width": 269.3043518066406, - "height": 45, - "seed": 1122901651, - "groupIds": [], - "frameId": null, - "roundness": null, - "boundElements": [], - "updated": 1707683157132, - "link": null, - "locked": false, - "fontSize": 36, - "fontFamily": 1, - "text": "Optional plugins", - "textAlign": "left", - "verticalAlign": "top", - "containerId": null, - "originalText": "Optional plugins", - "lineHeight": 1.25, - "baseline": 32 - }, - { - "type": "text", - "version": 147, - "versionNonce": 1707375679, - "isDeleted": false, - "id": "vC0onKP_9vX3ixH76Pe7G", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 1702.2431905988706, - "y": 6183.873637488028, - "strokeColor": "#e03131", - "backgroundColor": "transparent", - "width": 613.8695678710938, - "height": 45, - "seed": 1754289821, - "groupIds": [], - "frameId": null, - "roundness": null, - "boundElements": [], - "updated": 1707683157133, - "link": null, - "locked": false, - "fontSize": 36, - "fontFamily": 1, - "text": "Top bar for urls, search and find ", - "textAlign": "left", - "verticalAlign": "top", - "containerId": null, - "originalText": "Top bar for urls, search and find ", - "lineHeight": 1.25, - "baseline": 32 - }, - { - "type": "arrow", - "version": 273, - "versionNonce": 591128925, - "isDeleted": false, - "id": "u-ugk9JQxAw2y5eNv5Yfh", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 1515.2663524628852, - "y": 6123.4617791436385, - "strokeColor": "#e03131", - "backgroundColor": "transparent", - "width": 481.6070073199544, - "height": 325.3664279363484, - "seed": 2127178397, - "groupIds": [], - "frameId": null, - "roundness": { - "type": 2 - }, - "boundElements": [], - "updated": 1707673777208, - "link": null, - "locked": false, - "startBinding": { - "elementId": "hAR8oBD352ZvGSkOnh6SN", - "focus": -0.0902848528387189, - "gap": 14.164911980001307 - }, - "endBinding": { - "elementId": "O0Alf80_Bn5JTcGMp1MoV", - "focus": 0.16648899211389898, - "gap": 5.665964791999613 - }, - "lastCommittedPoint": null, - "startArrowhead": null, - "endArrowhead": "arrow", - "points": [ - [ - 0, - 0 - ], - [ - -481.6070073199544, - -325.3664279363484 - ] - ] - }, - { - "type": "text", - "version": 147, - "versionNonce": 603958065, - "isDeleted": false, - "id": "sPhKUdkpNyJCCbt_r0LiU", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 36.44954175102009, - "y": 4561.204091910091, - "strokeColor": "#c2255c", - "backgroundColor": "transparent", - "width": 1391.521728515625, - "height": 112.36221017407769, - "seed": 1216168221, - "groupIds": [], - "frameId": null, - "roundness": null, - "boundElements": [], - "updated": 1707683157134, - "link": null, - "locked": false, - "fontSize": 89.88976813926215, - "fontFamily": 1, - "text": "Rough architecture of rosenrot", - "textAlign": "left", - "verticalAlign": "top", - "containerId": null, - "originalText": "Rough architecture of rosenrot", - "lineHeight": 1.25, - "baseline": 79 - }, - { - "type": "text", - "version": 106, - "versionNonce": 1569234015, - "isDeleted": false, - "id": "yee1lhHS6ghMhO_e1j08Z", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 1784.3996800828627, - "y": 5322.646989104106, - "strokeColor": "#2f9e44", - "backgroundColor": "transparent", - "width": 362.15216064453125, - "height": 45, - "seed": 1236843613, - "groupIds": [], - "frameId": null, - "roundness": null, - "boundElements": [], - "updated": 1707683157135, - "link": null, - "locked": false, - "fontSize": 36, - "fontFamily": 1, - "text": "create_new_webview", - "textAlign": "left", - "verticalAlign": "top", - "containerId": null, - "originalText": "create_new_webview", - "lineHeight": 1.25, - "baseline": 32 - }, - { - "type": "rectangle", - "version": 84, - "versionNonce": 1350510771, - "isDeleted": false, - "id": "LMwdgqzKNCT3uH7TaK5_P", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 1753.2368737268662, - "y": 5404.803478588098, - "strokeColor": "#2f9e44", - "backgroundColor": "transparent", - "width": 195.4757853239821, - "height": 76.49052469199341, - "seed": 979800371, - "groupIds": [], - "frameId": null, - "roundness": { - "type": 3 - }, - "boundElements": [ - { - "type": "text", - "id": "gyuIu-KcZvrJ6XlsdvmlC" - } - ], - "updated": 1707673695733, - "link": null, - "locked": false - }, - { - "type": "text", - "version": 72, - "versionNonce": 1654495827, - "isDeleted": false, - "id": "gyuIu-KcZvrJ6XlsdvmlC", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 1802.333462372744, - "y": 5420.548740934095, - "strokeColor": "#2f9e44", - "backgroundColor": "transparent", - "width": 97.28260803222656, - "height": 45, - "seed": 1247440083, - "groupIds": [], - "frameId": null, - "roundness": null, - "boundElements": [], - "updated": 1707673695733, - "link": null, - "locked": false, - "fontSize": 36, - "fontFamily": 1, - "text": "cache", - "textAlign": "center", - "verticalAlign": "middle", - "containerId": "LMwdgqzKNCT3uH7TaK5_P", - "originalText": "cache", - "lineHeight": 1.25, - "baseline": 35 - }, - { - "type": "rectangle", - "version": 104, - "versionNonce": 926734323, - "isDeleted": false, - "id": "s1hSl1gNctBPfZVaIi0gx", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 1972.7930094168469, - "y": 5397.721022598097, - "strokeColor": "#2f9e44", - "backgroundColor": "transparent", - "width": 195.4757853239821, - "height": 76.49052469199341, - "seed": 1473909011, - "groupIds": [], - "frameId": null, - "roundness": { - "type": 3 - }, - "boundElements": [ - { - "type": "text", - "id": "PB6kry_fKCvxsgmBtH-BD" - } - ], - "updated": 1707673695733, - "link": null, - "locked": false - }, - { - "type": "text", - "version": 111, - "versionNonce": 1550016915, - "isDeleted": false, - "id": "PB6kry_fKCvxsgmBtH-BD", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 1994.3243819982715, - "y": 5413.466284944094, - "strokeColor": "#2f9e44", - "backgroundColor": "transparent", - "width": 152.4130401611328, - "height": 45, - "seed": 591165107, - "groupIds": [], - "frameId": null, - "roundness": null, - "boundElements": [], - "updated": 1707673695733, - "link": null, - "locked": false, - "fontSize": 36, - "fontFamily": 1, - "text": "style.css", - "textAlign": "center", - "verticalAlign": "middle", - "containerId": "s1hSl1gNctBPfZVaIi0gx", - "originalText": "style.css", - "lineHeight": 1.25, - "baseline": 35 - }, - { - "type": "text", - "version": 43, - "versionNonce": 304422161, - "isDeleted": false, - "id": "neK9NTR33ct1doVxU9tDD", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 1727.7400321628684, - "y": 5200.828746076117, - "strokeColor": "#2f9e44", - "backgroundColor": "transparent", - "width": 478.36956787109375, - "height": 45, - "seed": 1269716797, - "groupIds": [], - "frameId": null, - "roundness": null, - "boundElements": [], - "updated": 1707683157135, - "link": null, - "locked": false, - "fontSize": 36, - "fontFamily": 1, - "text": "notebook_create_new_tab", - "textAlign": "left", - "verticalAlign": "top", - "containerId": null, - "originalText": "notebook_create_new_tab", - "lineHeight": 1.25, - "baseline": 32 - }, - { - "type": "text", - "version": 64, - "versionNonce": 1679014015, - "isDeleted": false, - "id": "sf9SE5B7Dp_E-ut2VHonj", - "fillStyle": "hachure", - "strokeWidth": 4, - "strokeStyle": "solid", - "roughness": 2, - "opacity": 100, - "angle": 0, - "x": 367.9084820829903, - "y": 5328.312953896106, - "strokeColor": "#1971c2", - "backgroundColor": "transparent", - "width": 500.3043518066406, - "height": 45, - "seed": 1641031187, - "groupIds": [], - "frameId": null, - "roundness": null, - "boundElements": [], - "updated": 1707683157135, - "link": null, - "locked": false, - "fontSize": 36, - "fontFamily": 1, - "text": "handle_signal_load_changed", - "textAlign": "left", - "verticalAlign": "top", - "containerId": null, - "originalText": "handle_signal_load_changed", - "lineHeight": 1.25, - "baseline": 32 - } - ], - "appState": { - "gridSize": null, - "viewBackgroundColor": "#ffffff" - }, - "files": {} -} \ No newline at end of file diff --git a/images/flower-imgs/rose-homepage-2.png b/images/flower-imgs/rose-homepage-2.png deleted file mode 100644 index 2770c78..0000000 Binary files a/images/flower-imgs/rose-homepage-2.png and /dev/null differ diff --git a/images/flower-imgs/rose-homepage.png b/images/flower-imgs/rose-homepage.png deleted file mode 100644 index 9944beb..0000000 Binary files a/images/flower-imgs/rose-homepage.png and /dev/null differ diff --git a/images/flower-imgs/rose-src.txt b/images/flower-imgs/rose-src.txt deleted file mode 100644 index b41762d..0000000 --- a/images/flower-imgs/rose-src.txt +++ /dev/null @@ -1 +0,0 @@ -https://www.onlygfx.com/red-rose-png-image-transparent/ diff --git a/images/flower-imgs/rose.png b/images/flower-imgs/rose.png deleted file mode 100644 index 9944beb..0000000 Binary files a/images/flower-imgs/rose.png and /dev/null differ diff --git a/images/flower-imgs/rose2.png b/images/flower-imgs/rose2.png deleted file mode 100644 index 6ab0658..0000000 Binary files a/images/flower-imgs/rose2.png and /dev/null differ diff --git a/images/flower-imgs/rosenrot-desktop-icon.png b/images/flower-imgs/rosenrot-desktop-icon.png deleted file mode 100644 index 163494f..0000000 Binary files a/images/flower-imgs/rosenrot-desktop-icon.png and /dev/null differ diff --git a/makefile b/makefile index d9cab30..616551c 100644 --- a/makefile +++ b/makefile @@ -1,9 +1,5 @@ # C compiler CC=gcc # alternatives: tcc, clang, zig cc -WARNINGS=-Wall -OPTIMIZED_SOME=-O3 -OPTIMIZED_MORE=-Ofast -march=native -funit-at-a-time -flto # binary will not be compatible with other computers, but may be much faster -DEBUG= # -g # Dependencies DEPS='webkit2gtk-4.1' @@ -14,27 +10,12 @@ LIBS=`pkg-config --libs ${DEPS}` SRC=rosenrot.c CONFIG=config.h -# Plugins -include plugins/plugins.mk -# PLUGINS=./plugins/stand_in/stand_in.c - ## Formatter STYLE_BLUEPRINT="{BasedOnStyle: webkit, AllowShortIfStatementsOnASingleLine: true, IndentCaseLabels: true, AllowShortEnumsOnASingleLine: true}" FORMATTER=clang-format -i -style=$(STYLE_BLUEPRINT) -# Runtime files -MAINTAINER_CACHE_DIR=/home/nuno/.cache/rosenrot -USER_CACHE_DIR=/home/`whoami`/.cache/rosenrot -RUNTIME_FILES_DIR=/opt/rosenrot/ - -build: $(SRC) $(PLUGINS) $(CONFIG) constants user_cache - $(CC) $(WARNINGS) $(OPTIMIZED_MORE) $(DEBUG) $(INCS) $(PLUGINS) $(SRC) -o rosenrot $(LIBS) $(ADBLOCK) - -constants: - @echo "# Computing constants" - cd plugins/readability/ && sh recompute_READABILITY_N.sh - cd plugins/style && sh recompute_STYLE_N.sh - @echo +build: $(SRC) $(CONFIG) user_cache + $(CC) $(INCS) $(SRC) -o rosenrot $(LIBS) $(ADBLOCK) user_cache: @if [ `id -u` -eq 0 ]; then echo "can't run make user_cache with sudo, because USER_CACHE_DIR would be /home/root/.cache"; return 1; fi @@ -44,21 +25,11 @@ user_cache: sed -i "s|$(MAINTAINER_CACHE_DIR)|$(USER_CACHE_DIR)|g" {} + @echo -runtime_files: - sudo mkdir -p /opt/rosenrot/ - sudo cp style.css /opt/rosenrot/ - sudo cp -r images/flower-imgs /opt/rosenrot/ - sudo cp plugins/style/style.js /opt/rosenrot/ - sudo cp plugins/readability/readability.js /opt/rosenrot/ - -install: rosenrot runtime_files +install: rosenrot cp -f rosenrot /usr/bin - cp rosenrot-mklink /usr/bin uninstall: - rm -r /opt/rosenrot rm /usr/bin/rosenrot - rm /usr/bin/rosenrot-mklink rm $(USER_CACHE_DIR) clean: @@ -69,30 +40,4 @@ format: $(SRC) $(PLUGINS) $(FORMATTER) $(SRC) $(PLUGINS) $(rosenrot.h) lint: - clang-tidy $(SRC) $(PLUGINS) -- -Wall -O3 $(INCS) -o rosenrot $(LIBS) -## A few more commands: - -fast: $(SRC) $(PLUGINS) $(CONFIG) - rm -f *.gcda - GIO_MODULE_DIR=/usr/lib/x86_64-linux-gnu/gio/modules/ - $(CC) $(WARNINGS) $(OPTIMIZED_MORE) -fprofile-generate $(INCS) $(PLUGINS) $(SRC) -o rosenrot $(LIBS) $(ADBLOCK) - @echo "Now use the browser for a while to gather some profiling data" - sleep 2 - ./rosenrot - $(CC) $(WARNINGS) $(OPTIMIZED_MORE) -fprofile-use $(INCS) $(PLUGINS) $(SRC) -o rosenrot $(LIBS) $(ADBLOCK) - rm -f *.gcda - -inspect: rosenrot - GTK_DEBUG=interactive ./rosenrot - -diagnose_deprecations: rosenrot - G_ENABLE_DIAGNOSTIC=1 ./rosenrot - -view-gtk3-version: - dpkg -l libgtk-3-0 - -twitter: - sudo mkdir -p /usr/bin/rosenrot-browser - sudo cp rosenrot /usr/bin/rosenrot-browser/twitter - -# COMPILETIME_DEPRECATION_WARNINGS=#-DGDK_DISABLE_DEPRECATED -DGTK_DISABLE_DEPRECATED # turns out that webkit2gtk-4.1 is using some deprecated stuff, lol + clang-tidy $(SRC) -- -Wall $(INCS) -o rosenrot $(LIBS) diff --git a/plugins/libre_redirect/README.md b/plugins/libre_redirect/README.md deleted file mode 100644 index f3f58c9..0000000 --- a/plugins/libre_redirect/README.md +++ /dev/null @@ -1,3 +0,0 @@ -## About - -This code automatically redirects webpage to their open-source frontends. It is based on \ No newline at end of file diff --git a/plugins/libre_redirect/libre_redirect.c b/plugins/libre_redirect/libre_redirect.c deleted file mode 100644 index 55ddb84..0000000 --- a/plugins/libre_redirect/libre_redirect.c +++ /dev/null @@ -1,66 +0,0 @@ -#include -#include - -#include "../strings/strings.h" - -#define LIBRE_N 50 - -/* Inspired by https://libredirect.github.io/, but in C. */ -int libre_redirect(const char* uri, char* output) -{ - int len_uri = strlen(uri); - int len_output = strlen(output); - - if ((len_output - len_uri) < LIBRE_N) { - fprintf(stderr, "Not enough memory\n"); - return 1; // not enough memory. - } else { - char* annoying_sites[] = { - "https://www.reddit.com", - "https://www.youtube.com", - "https://google.com", - "https://medium.com", - "https://translate.google.com", - "https://www.bloomberg.com", - "https://www.royalroad.com", - "https://genius.com", - // "https://archive.org", - // "https://twitter.com" - }; - - char* alternatives[] = { - "https://old.reddit.com", // "https://teddit.nunosempere.com", - "https://invidious.private.coffee", - "https://search.nunosempere.com", - "https://scribe.rip", - "https://translate.riverside.rocks", - "https://archive.is/https://www.bloomberg.com", - "https://royalread.nunosempere.com", - "https://dumb.vern.cc", - // "https://wayback.nunosempere.com", - // "https://nitter.net" - }; - - int len = sizeof(annoying_sites) / sizeof(annoying_sites[0]); - for (int i = 0; i < len; i++) { - str_init(output, len_output); - int replace_check = str_replace_start(uri, annoying_sites[i], - alternatives[i], output); - switch (replace_check) { - case 0: // no match found - break; - case 1: // str_replace_start somehow failed - fprintf(stderr, "str_replace_start failed\n"); - return 1; - break; - case 2: // match succeeded - return 2; - break; - default: - fprintf(stderr, "Unreachable state\n"); - } - } - strcpy(output, uri); - } - return 0; -} diff --git a/plugins/libre_redirect/libre_redirect.h b/plugins/libre_redirect/libre_redirect.h deleted file mode 100644 index 7addeb0..0000000 --- a/plugins/libre_redirect/libre_redirect.h +++ /dev/null @@ -1,5 +0,0 @@ -#pragma once - -#define LIBRE_N 50 - -int libre_redirect(const char* uri, char* uri_filtered); diff --git a/plugins/libre_redirect/str_replace_test/build-example.sh b/plugins/libre_redirect/str_replace_test/build-example.sh deleted file mode 100644 index a9f8022..0000000 --- a/plugins/libre_redirect/str_replace_test/build-example.sh +++ /dev/null @@ -1,11 +0,0 @@ -#!/bin/bash -CC=gcc - -FLAGS="-std=c99 -Wall -lm" - -SRC=example.c -REQS="../str_replace_start.c ../libre_redirect.c" - -echo -e "\n\n\n" -$CC $FLAGS $SRC $REQS -o example - diff --git a/plugins/libre_redirect/str_replace_test/example.c b/plugins/libre_redirect/str_replace_test/example.c deleted file mode 100644 index b93634a..0000000 --- a/plugins/libre_redirect/str_replace_test/example.c +++ /dev/null @@ -1,19 +0,0 @@ -#include "../libre_redirect.h" -#include -#include - -int main() -{ - char uri[] = "https://reddit.com/r/blah"; - - int l = LIBRE_N + strlen(uri) + 1; - char uri_filtered[l]; - str_init(uri_filtered, l); - - if (!libre_redirect(uri, uri_filtered)) { - printf("Filtered uri: %s\n", uri_filtered); - } else { - printf("Uri: %s\n", uri); - // failure; do something with the original uri. - } -} diff --git a/plugins/plugins.h b/plugins/plugins.h deleted file mode 100644 index 5f7e726..0000000 --- a/plugins/plugins.h +++ /dev/null @@ -1,5 +0,0 @@ -#include "strings/strings.h" -#include "libre_redirect/libre_redirect.h" -#include "readability/readability.h" -#include "shortcuts/shortcuts.h" -#include "style/style.h" diff --git a/plugins/plugins.mk b/plugins/plugins.mk deleted file mode 100644 index f8d000f..0000000 --- a/plugins/plugins.mk +++ /dev/null @@ -1,17 +0,0 @@ -## Shared -COMMON_CODE=./plugins/strings/strings.c - -## Plugins -CUSTOM_STYLES=./plugins/style/style.c -SHORTCUTS=./plugins/shortcuts/shortcuts.c -READABILITY=./plugins/readability/readability.c -LIBRE_REDIRECT=./plugins/libre_redirect/libre_redirect.c - -ADBLOCK='-L/usr/lib/wyebrowser/adblock.so' # optional adblocking; depends on https://github.com/jun7/wyebadblock - -STAND_IN=./plugins/stand_in/stand_in.c # gives function definitions for the above, which do nothing - -PLUGINS=$(COMMON_CODE) $(CUSTOM_STYLES) $(SHORTCUTS) $(READABILITY) $(LIBRE_REDIRECT) -# PLUGINS=$(STAND_IN) - - diff --git a/plugins/readability/README.md b/plugins/readability/README.md deleted file mode 100644 index 2a19a8e..0000000 --- a/plugins/readability/README.md +++ /dev/null @@ -1,2 +0,0 @@ -This code reimplements firefox readability mode. Code taken from - diff --git a/plugins/readability/readability b/plugins/readability/readability deleted file mode 100755 index 2c70985..0000000 Binary files a/plugins/readability/readability and /dev/null differ diff --git a/plugins/readability/readability.c b/plugins/readability/readability.c deleted file mode 100644 index 33df917..0000000 --- a/plugins/readability/readability.c +++ /dev/null @@ -1,31 +0,0 @@ -#include -#include -#include -#define READABILITY_N 88067 + 1000 - -void read_readability_js(char* string) -{ - FILE* fp = fopen("/opt/rosenrot/readability.js", "r"); - if (!fp) { // fp is NULL, fopen failed - fprintf(stderr, "Failed to open file\n"); - fprintf(stderr, "Consider running $ sudo make runtime_files\n"); - string = NULL; - return; - } - int i = 0; - int c; - while ((c = fgetc(fp)) != EOF) { - string[i++] = c; - } - string[i] = '\0'; - fclose(fp); -} - -/* -int main(){ - char* readability_js = malloc(READABILITY_N+1); - read_readability_js(readability_js); - printf("%s", readability_js); - free(readability_js); -} -*/ diff --git a/plugins/readability/readability.h b/plugins/readability/readability.h deleted file mode 100644 index 9dab8c1..0000000 --- a/plugins/readability/readability.h +++ /dev/null @@ -1,5 +0,0 @@ -#pragma once - -#define READABILITY_N 88067 + 1000 - -void read_readability_js(char* string); diff --git a/plugins/readability/readability.js b/plugins/readability/readability.js deleted file mode 100644 index bf7169d..0000000 --- a/plugins/readability/readability.js +++ /dev/null @@ -1,2726 +0,0 @@ -/*eslint-env es6:false*/ -/* - * Copyright (c) 2010 Arc90 Inc - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -/* - * This code is heavily based on Arc90's readability.js (1.7.1) script - * available at: http://code.google.com/p/arc90labs-readability - */ - -/** - * Public constructor. - * @param {HTMLDocument} doc The document to parse. - * @param {Object} options The options object. - */ -function Readability(doc, options) { - // In some older versions, people passed a URI as the first argument. Cope: - if (options && options.documentElement) { - doc = options; - options = arguments[2]; - } else if (!doc || !doc.documentElement) { - throw new Error( - "First argument to Readability constructor should be a document object." - ); - } - options = options || {}; - - this._doc = doc; - this._docJSDOMParser = this._doc.firstChild.__JSDOMParser__; - this._articleTitle = null; - this._articleByline = null; - this._articleDir = null; - this._articleSiteName = null; - this._attempts = []; - - // Configurable options - this._debug = !!options.debug; - this._maxElemsToParse = - options.maxElemsToParse || this.DEFAULT_MAX_ELEMS_TO_PARSE; - this._nbTopCandidates = - options.nbTopCandidates || this.DEFAULT_N_TOP_CANDIDATES; - this._charThreshold = options.charThreshold || this.DEFAULT_CHAR_THRESHOLD; - this._classesToPreserve = this.CLASSES_TO_PRESERVE.concat( - options.classesToPreserve || [] - ); - this._keepClasses = !!options.keepClasses; - this._serializer = - options.serializer || - function (el) { - return el.innerHTML; - }; - this._disableJSONLD = !!options.disableJSONLD; - - // Start with all flags set - this._flags = - this.FLAG_STRIP_UNLIKELYS | - this.FLAG_WEIGHT_CLASSES | - this.FLAG_CLEAN_CONDITIONALLY; - - // Control whether log messages are sent to the console - if (this._debug) { - let logNode = function (node) { - if (node.nodeType == node.TEXT_NODE) { - return `${node.nodeName} ("${node.textContent}")`; - } - let attrPairs = Array.from(node.attributes || [], function (attr) { - return `${attr.name}="${attr.value}"`; - }).join(" "); - return `<${node.localName} ${attrPairs}>`; - }; - this.log = function () { - if (typeof dump !== "undefined") { - var msg = Array.prototype.map - .call(arguments, function (x) { - return x && x.nodeName ? logNode(x) : x; - }) - .join(" "); - dump("Reader: (Readability) " + msg + "\n"); - } else if (typeof console !== "undefined") { - let args = Array.from(arguments, (arg) => { - if (arg && arg.nodeType == this.ELEMENT_NODE) { - return logNode(arg); - } - return arg; - }); - args.unshift("Reader: (Readability)"); - console.log.apply(console, args); - } - }; - } else { - this.log = function () {}; - } -} - -Readability.prototype = { - FLAG_STRIP_UNLIKELYS: 0x1, - FLAG_WEIGHT_CLASSES: 0x2, - FLAG_CLEAN_CONDITIONALLY: 0x4, - - // https://developer.mozilla.org/en-US/docs/Web/API/Node/nodeType - ELEMENT_NODE: 1, - TEXT_NODE: 3, - - // Max number of nodes supported by this parser. Default: 0 (no limit) - DEFAULT_MAX_ELEMS_TO_PARSE: 0, - - // The number of top candidates to consider when analysing how - // tight the competition is among candidates. - DEFAULT_N_TOP_CANDIDATES: 5, - - // Element tags to score by default. - DEFAULT_TAGS_TO_SCORE: "section,h2,h3,h4,h5,h6,p,td,pre" - .toUpperCase() - .split(","), - - // The default number of chars an article must have in order to return a result - DEFAULT_CHAR_THRESHOLD: 500, - - // All of the regular expressions in use within readability. - // Defined up here so we don't instantiate them repeatedly in loops. - REGEXPS: { - // NOTE: These two regular expressions are duplicated in - // Readability-readerable.js. Please keep both copies in sync. - unlikelyCandidates: - /-ad-|ai2html|banner|breadcrumbs|combx|comment|community|cover-wrap|disqus|extra|footer|gdpr|header|legends|menu|related|remark|replies|rss|shoutbox|sidebar|skyscraper|social|sponsor|supplemental|ad-break|agegate|pagination|pager|popup|yom-remote/i, - okMaybeItsACandidate: /and|article|body|column|content|main|shadow/i, - - positive: - /article|body|content|entry|hentry|h-entry|main|page|pagination|post|text|blog|story/i, - negative: - /-ad-|hidden|^hid$| hid$| hid |^hid |banner|combx|comment|com-|contact|foot|footer|footnote|gdpr|masthead|media|meta|outbrain|promo|related|scroll|share|shoutbox|sidebar|skyscraper|sponsor|shopping|tags|tool|widget/i, - extraneous: - /print|archive|comment|discuss|e[\-]?mail|share|reply|all|login|sign|single|utility/i, - byline: /byline|author|dateline|writtenby|p-author/i, - replaceFonts: /<(\/?)font[^>]*>/gi, - normalize: /\s{2,}/g, - videos: - /\/\/(www\.)?((dailymotion|youtube|youtube-nocookie|player\.vimeo|v\.qq)\.com|(archive|upload\.wikimedia)\.org|player\.twitch\.tv)/i, - shareElements: /(\b|_)(share|sharedaddy)(\b|_)/i, - nextLink: /(next|weiter|continue|>([^\|]|$)|»([^\|]|$))/i, - prevLink: /(prev|earl|old|new|<|«)/i, - tokenize: /\W+/g, - whitespace: /^\s*$/, - hasContent: /\S$/, - hashUrl: /^#.+/, - srcsetUrl: /(\S+)(\s+[\d.]+[xw])?(\s*(?:,|$))/g, - b64DataUrl: /^data:\s*([^\s;,]+)\s*;\s*base64\s*,/i, - // See: https://schema.org/Article - jsonLdArticleTypes: - /^Article|AdvertiserContentArticle|NewsArticle|AnalysisNewsArticle|AskPublicNewsArticle|BackgroundNewsArticle|OpinionNewsArticle|ReportageNewsArticle|ReviewNewsArticle|Report|SatiricalArticle|ScholarlyArticle|MedicalScholarlyArticle|SocialMediaPosting|BlogPosting|LiveBlogPosting|DiscussionForumPosting|TechArticle|APIReference$/, - }, - - UNLIKELY_ROLES: [ - "menu", - "menubar", - "complementary", - "navigation", - "alert", - "alertdialog", - "dialog", - ], - - DIV_TO_P_ELEMS: new Set([ - "BLOCKQUOTE", - "DL", - "DIV", - "IMG", - "OL", - "P", - "PRE", - "TABLE", - "UL", - ]), - - ALTER_TO_DIV_EXCEPTIONS: ["DIV", "ARTICLE", "SECTION", "P"], - - PRESENTATIONAL_ATTRIBUTES: [ - "align", - "background", - "bgcolor", - "border", - "cellpadding", - "cellspacing", - "frame", - "hspace", - "rules", - "style", - "valign", - "vspace", - ], - - DEPRECATED_SIZE_ATTRIBUTE_ELEMS: ["TABLE", "TH", "TD", "HR", "PRE"], - - // The commented out elements qualify as phrasing content but tend to be - // removed by readability when put into paragraphs, so we ignore them here. - PHRASING_ELEMS: [ - // "CANVAS", "IFRAME", "SVG", "VIDEO", - "ABBR", - "AUDIO", - "B", - "BDO", - "BR", - "BUTTON", - "CITE", - "CODE", - "DATA", - "DATALIST", - "DFN", - "EM", - "EMBED", - "I", - "IMG", - "INPUT", - "KBD", - "LABEL", - "MARK", - "MATH", - "METER", - "NOSCRIPT", - "OBJECT", - "OUTPUT", - "PROGRESS", - "Q", - "RUBY", - "SAMP", - "SCRIPT", - "SELECT", - "SMALL", - "SPAN", - "STRONG", - "SUB", - "SUP", - "TEXTAREA", - "TIME", - "VAR", - "WBR", - ], - - // These are the classes that readability sets itself. - CLASSES_TO_PRESERVE: ["page"], - - // These are the list of HTML entities that need to be escaped. - HTML_ESCAPE_MAP: { - lt: "<", - gt: ">", - amp: "&", - quot: '"', - apos: "'", - }, - - /** - * Run any post-process modifications to article content as necessary. - * - * @param Element - * @return void - **/ - _postProcessContent: function (articleContent) { - // Readability cannot open relative uris so we convert them to absolute uris. - this._fixRelativeUris(articleContent); - - this._simplifyNestedElements(articleContent); - - if (!this._keepClasses) { - // Remove classes. - this._cleanClasses(articleContent); - } - }, - - /** - * Iterates over a NodeList, calls `filterFn` for each node and removes node - * if function returned `true`. - * - * If function is not passed, removes all the nodes in node list. - * - * @param NodeList nodeList The nodes to operate on - * @param Function filterFn the function to use as a filter - * @return void - */ - _removeNodes: function (nodeList, filterFn) { - // Avoid ever operating on live node lists. - if (this._docJSDOMParser && nodeList._isLiveNodeList) { - throw new Error("Do not pass live node lists to _removeNodes"); - } - for (var i = nodeList.length - 1; i >= 0; i--) { - var node = nodeList[i]; - var parentNode = node.parentNode; - if (parentNode) { - if (!filterFn || filterFn.call(this, node, i, nodeList)) { - parentNode.removeChild(node); - } - } - } - }, - - /** - * Iterates over a NodeList, and calls _setNodeTag for each node. - * - * @param NodeList nodeList The nodes to operate on - * @param String newTagName the new tag name to use - * @return void - */ - _replaceNodeTags: function (nodeList, newTagName) { - // Avoid ever operating on live node lists. - if (this._docJSDOMParser && nodeList._isLiveNodeList) { - throw new Error("Do not pass live node lists to _replaceNodeTags"); - } - for (const node of nodeList) { - this._setNodeTag(node, newTagName); - } - }, - - /** - * Iterate over a NodeList, which doesn't natively fully implement the Array - * interface. - * - * For convenience, the current object context is applied to the provided - * iterate function. - * - * @param NodeList nodeList The NodeList. - * @param Function fn The iterate function. - * @return void - */ - _forEachNode: function (nodeList, fn) { - Array.prototype.forEach.call(nodeList, fn, this); - }, - - /** - * Iterate over a NodeList, and return the first node that passes - * the supplied test function - * - * For convenience, the current object context is applied to the provided - * test function. - * - * @param NodeList nodeList The NodeList. - * @param Function fn The test function. - * @return void - */ - _findNode: function (nodeList, fn) { - return Array.prototype.find.call(nodeList, fn, this); - }, - - /** - * Iterate over a NodeList, return true if any of the provided iterate - * function calls returns true, false otherwise. - * - * For convenience, the current object context is applied to the - * provided iterate function. - * - * @param NodeList nodeList The NodeList. - * @param Function fn The iterate function. - * @return Boolean - */ - _someNode: function (nodeList, fn) { - return Array.prototype.some.call(nodeList, fn, this); - }, - - /** - * Iterate over a NodeList, return true if all of the provided iterate - * function calls return true, false otherwise. - * - * For convenience, the current object context is applied to the - * provided iterate function. - * - * @param NodeList nodeList The NodeList. - * @param Function fn The iterate function. - * @return Boolean - */ - _everyNode: function (nodeList, fn) { - return Array.prototype.every.call(nodeList, fn, this); - }, - - /** - * Concat all nodelists passed as arguments. - * - * @return ...NodeList - * @return Array - */ - _concatNodeLists: function () { - var slice = Array.prototype.slice; - var args = slice.call(arguments); - var nodeLists = args.map(function (list) { - return slice.call(list); - }); - return Array.prototype.concat.apply([], nodeLists); - }, - - _getAllNodesWithTag: function (node, tagNames) { - if (node.querySelectorAll) { - return node.querySelectorAll(tagNames.join(",")); - } - return [].concat.apply( - [], - tagNames.map(function (tag) { - var collection = node.getElementsByTagName(tag); - return Array.isArray(collection) ? collection : Array.from(collection); - }) - ); - }, - - /** - * Removes the class="" attribute from every element in the given - * subtree, except those that match CLASSES_TO_PRESERVE and - * the classesToPreserve array from the options object. - * - * @param Element - * @return void - */ - _cleanClasses: function (node) { - var classesToPreserve = this._classesToPreserve; - var className = (node.getAttribute("class") || "") - .split(/\s+/) - .filter(function (cls) { - return classesToPreserve.indexOf(cls) != -1; - }) - .join(" "); - - if (className) { - node.setAttribute("class", className); - } else { - node.removeAttribute("class"); - } - - for (node = node.firstElementChild; node; node = node.nextElementSibling) { - this._cleanClasses(node); - } - }, - - /** - * Converts each and uri in the given element to an absolute URI, - * ignoring #ref URIs. - * - * @param Element - * @return void - */ - _fixRelativeUris: function (articleContent) { - var baseURI = this._doc.baseURI; - var documentURI = this._doc.documentURI; - function toAbsoluteURI(uri) { - // Leave hash links alone if the base URI matches the document URI: - if (baseURI == documentURI && uri.charAt(0) == "#") { - return uri; - } - - // Otherwise, resolve against base URI: - try { - return new URL(uri, baseURI).href; - } catch (ex) { - // Something went wrong, just return the original: - } - return uri; - } - - var links = this._getAllNodesWithTag(articleContent, ["a"]); - this._forEachNode(links, function (link) { - var href = link.getAttribute("href"); - if (href) { - // Remove links with javascript: URIs, since - // they won't work after scripts have been removed from the page. - if (href.indexOf("javascript:") === 0) { - // if the link only contains simple text content, it can be converted to a text node - if ( - link.childNodes.length === 1 && - link.childNodes[0].nodeType === this.TEXT_NODE - ) { - var text = this._doc.createTextNode(link.textContent); - link.parentNode.replaceChild(text, link); - } else { - // if the link has multiple children, they should all be preserved - var container = this._doc.createElement("span"); - while (link.firstChild) { - container.appendChild(link.firstChild); - } - link.parentNode.replaceChild(container, link); - } - } else { - link.setAttribute("href", toAbsoluteURI(href)); - } - } - }); - - var medias = this._getAllNodesWithTag(articleContent, [ - "img", - "picture", - "figure", - "video", - "audio", - "source", - ]); - - this._forEachNode(medias, function (media) { - var src = media.getAttribute("src"); - var poster = media.getAttribute("poster"); - var srcset = media.getAttribute("srcset"); - - if (src) { - media.setAttribute("src", toAbsoluteURI(src)); - } - - if (poster) { - media.setAttribute("poster", toAbsoluteURI(poster)); - } - - if (srcset) { - var newSrcset = srcset.replace( - this.REGEXPS.srcsetUrl, - function (_, p1, p2, p3) { - return toAbsoluteURI(p1) + (p2 || "") + p3; - } - ); - - media.setAttribute("srcset", newSrcset); - } - }); - }, - - _simplifyNestedElements: function (articleContent) { - var node = articleContent; - - while (node) { - if ( - node.parentNode && - ["DIV", "SECTION"].includes(node.tagName) && - !(node.id && node.id.startsWith("readability")) - ) { - if (this._isElementWithoutContent(node)) { - node = this._removeAndGetNext(node); - continue; - } else if ( - this._hasSingleTagInsideElement(node, "DIV") || - this._hasSingleTagInsideElement(node, "SECTION") - ) { - var child = node.children[0]; - for (var i = 0; i < node.attributes.length; i++) { - child.setAttribute( - node.attributes[i].name, - node.attributes[i].value - ); - } - node.parentNode.replaceChild(child, node); - node = child; - continue; - } - } - - node = this._getNextNode(node); - } - }, - - /** - * Get the article title as an H1. - * - * @return string - **/ - _getArticleTitle: function () { - var doc = this._doc; - var curTitle = ""; - var origTitle = ""; - - try { - curTitle = origTitle = doc.title.trim(); - - // If they had an element with id "title" in their HTML - if (typeof curTitle !== "string") - curTitle = origTitle = this._getInnerText( - doc.getElementsByTagName("title")[0] - ); - } catch (e) { - /* ignore exceptions setting the title. */ - } - - var titleHadHierarchicalSeparators = false; - function wordCount(str) { - return str.split(/\s+/).length; - } - - // If there's a separator in the title, first remove the final part - if (/ [\|\-\\\/>»] /.test(curTitle)) { - titleHadHierarchicalSeparators = / [\\\/>»] /.test(curTitle); - curTitle = origTitle.replace(/(.*)[\|\-\\\/>»] .*/gi, "$1"); - - // If the resulting title is too short (3 words or fewer), remove - // the first part instead: - if (wordCount(curTitle) < 3) - curTitle = origTitle.replace(/[^\|\-\\\/>»]*[\|\-\\\/>»](.*)/gi, "$1"); - } else if (curTitle.indexOf(": ") !== -1) { - // Check if we have an heading containing this exact string, so we - // could assume it's the full title. - var headings = this._concatNodeLists( - doc.getElementsByTagName("h1"), - doc.getElementsByTagName("h2") - ); - var trimmedTitle = curTitle.trim(); - var match = this._someNode(headings, function (heading) { - return heading.textContent.trim() === trimmedTitle; - }); - - // If we don't, let's extract the title out of the original title string. - if (!match) { - curTitle = origTitle.substring(origTitle.lastIndexOf(":") + 1); - - // If the title is now too short, try the first colon instead: - if (wordCount(curTitle) < 3) { - curTitle = origTitle.substring(origTitle.indexOf(":") + 1); - // But if we have too many words before the colon there's something weird - // with the titles and the H tags so let's just use the original title instead - } else if (wordCount(origTitle.substr(0, origTitle.indexOf(":"))) > 5) { - curTitle = origTitle; - } - } - } else if (curTitle.length > 150 || curTitle.length < 15) { - var hOnes = doc.getElementsByTagName("h1"); - - if (hOnes.length === 1) curTitle = this._getInnerText(hOnes[0]); - } - - curTitle = curTitle.trim().replace(this.REGEXPS.normalize, " "); - // If we now have 4 words or fewer as our title, and either no - // 'hierarchical' separators (\, /, > or ») were found in the original - // title or we decreased the number of words by more than 1 word, use - // the original title. - var curTitleWordCount = wordCount(curTitle); - if ( - curTitleWordCount <= 4 && - (!titleHadHierarchicalSeparators || - curTitleWordCount != - wordCount(origTitle.replace(/[\|\-\\\/>»]+/g, "")) - 1) - ) { - curTitle = origTitle; - } - - return curTitle; - }, - - /** - * Prepare the HTML document for readability to scrape it. - * This includes things like stripping javascript, CSS, and handling terrible markup. - * - * @return void - **/ - _prepDocument: function () { - var doc = this._doc; - - // Remove all style tags in head - this._removeNodes(this._getAllNodesWithTag(doc, ["style"])); - - if (doc.body) { - this._replaceBrs(doc.body); - } - - this._replaceNodeTags(this._getAllNodesWithTag(doc, ["font"]), "SPAN"); - }, - - /** - * Finds the next node, starting from the given node, and ignoring - * whitespace in between. If the given node is an element, the same node is - * returned. - */ - _nextNode: function (node) { - var next = node; - while ( - next && - next.nodeType != this.ELEMENT_NODE && - this.REGEXPS.whitespace.test(next.textContent) - ) { - next = next.nextSibling; - } - return next; - }, - - /** - * Replaces 2 or more successive
elements with a single

. - * Whitespace between
elements are ignored. For example: - *

foo
bar


abc
- * will become: - *
foo
bar

abc

- */ - _replaceBrs: function (elem) { - this._forEachNode(this._getAllNodesWithTag(elem, ["br"]), function (br) { - var next = br.nextSibling; - - // Whether 2 or more
elements have been found and replaced with a - //

block. - var replaced = false; - - // If we find a
chain, remove the
s until we hit another node - // or non-whitespace. This leaves behind the first
in the chain - // (which will be replaced with a

later). - while ((next = this._nextNode(next)) && next.tagName == "BR") { - replaced = true; - var brSibling = next.nextSibling; - next.parentNode.removeChild(next); - next = brSibling; - } - - // If we removed a
chain, replace the remaining
with a

. Add - // all sibling nodes as children of the

until we hit another
- // chain. - if (replaced) { - var p = this._doc.createElement("p"); - br.parentNode.replaceChild(p, br); - - next = p.nextSibling; - while (next) { - // If we've hit another

, we're done adding children to this

. - if (next.tagName == "BR") { - var nextElem = this._nextNode(next.nextSibling); - if (nextElem && nextElem.tagName == "BR") break; - } - - if (!this._isPhrasingContent(next)) break; - - // Otherwise, make this node a child of the new

. - var sibling = next.nextSibling; - p.appendChild(next); - next = sibling; - } - - while (p.lastChild && this._isWhitespace(p.lastChild)) { - p.removeChild(p.lastChild); - } - - if (p.parentNode.tagName === "P") this._setNodeTag(p.parentNode, "DIV"); - } - }); - }, - - _setNodeTag: function (node, tag) { - this.log("_setNodeTag", node, tag); - if (this._docJSDOMParser) { - node.localName = tag.toLowerCase(); - node.tagName = tag.toUpperCase(); - return node; - } - - var replacement = node.ownerDocument.createElement(tag); - while (node.firstChild) { - replacement.appendChild(node.firstChild); - } - node.parentNode.replaceChild(replacement, node); - if (node.readability) replacement.readability = node.readability; - - for (var i = 0; i < node.attributes.length; i++) { - try { - replacement.setAttribute( - node.attributes[i].name, - node.attributes[i].value - ); - } catch (ex) { - /* it's possible for setAttribute() to throw if the attribute name - * isn't a valid XML Name. Such attributes can however be parsed from - * source in HTML docs, see https://github.com/whatwg/html/issues/4275, - * so we can hit them here and then throw. We don't care about such - * attributes so we ignore them. - */ - } - } - return replacement; - }, - - /** - * Prepare the article node for display. Clean out any inline styles, - * iframes, forms, strip extraneous

tags, etc. - * - * @param Element - * @return void - **/ - _prepArticle: function (articleContent) { - this._cleanStyles(articleContent); - - // Check for data tables before we continue, to avoid removing items in - // those tables, which will often be isolated even though they're - // visually linked to other content-ful elements (text, images, etc.). - this._markDataTables(articleContent); - - this._fixLazyImages(articleContent); - - // Clean out junk from the article content - this._cleanConditionally(articleContent, "form"); - this._cleanConditionally(articleContent, "fieldset"); - this._clean(articleContent, "object"); - this._clean(articleContent, "embed"); - this._clean(articleContent, "footer"); - this._clean(articleContent, "link"); - this._clean(articleContent, "aside"); - - // Clean out elements with little content that have "share" in their id/class combinations from final top candidates, - // which means we don't remove the top candidates even they have "share". - - var shareElementThreshold = this.DEFAULT_CHAR_THRESHOLD; - - this._forEachNode(articleContent.children, function (topCandidate) { - this._cleanMatchedNodes(topCandidate, function (node, matchString) { - return ( - this.REGEXPS.shareElements.test(matchString) && - node.textContent.length < shareElementThreshold - ); - }); - }); - - this._clean(articleContent, "iframe"); - this._clean(articleContent, "input"); - this._clean(articleContent, "textarea"); - this._clean(articleContent, "select"); - this._clean(articleContent, "button"); - this._cleanHeaders(articleContent); - - // Do these last as the previous stuff may have removed junk - // that will affect these - this._cleanConditionally(articleContent, "table"); - this._cleanConditionally(articleContent, "ul"); - this._cleanConditionally(articleContent, "div"); - - // replace H1 with H2 as H1 should be only title that is displayed separately - this._replaceNodeTags( - this._getAllNodesWithTag(articleContent, ["h1"]), - "h2" - ); - - // Remove extra paragraphs - this._removeNodes( - this._getAllNodesWithTag(articleContent, ["p"]), - function (paragraph) { - var imgCount = paragraph.getElementsByTagName("img").length; - var embedCount = paragraph.getElementsByTagName("embed").length; - var objectCount = paragraph.getElementsByTagName("object").length; - // At this point, nasty iframes have been removed, only remain embedded video ones. - var iframeCount = paragraph.getElementsByTagName("iframe").length; - var totalCount = imgCount + embedCount + objectCount + iframeCount; - - return totalCount === 0 && !this._getInnerText(paragraph, false); - } - ); - - this._forEachNode( - this._getAllNodesWithTag(articleContent, ["br"]), - function (br) { - var next = this._nextNode(br.nextSibling); - if (next && next.tagName == "P") br.parentNode.removeChild(br); - } - ); - - // Remove single-cell tables - this._forEachNode( - this._getAllNodesWithTag(articleContent, ["table"]), - function (table) { - var tbody = this._hasSingleTagInsideElement(table, "TBODY") - ? table.firstElementChild - : table; - if (this._hasSingleTagInsideElement(tbody, "TR")) { - var row = tbody.firstElementChild; - if (this._hasSingleTagInsideElement(row, "TD")) { - var cell = row.firstElementChild; - cell = this._setNodeTag( - cell, - this._everyNode(cell.childNodes, this._isPhrasingContent) - ? "P" - : "DIV" - ); - table.parentNode.replaceChild(cell, table); - } - } - } - ); - }, - - /** - * Initialize a node with the readability object. Also checks the - * className/id for special names to add to its score. - * - * @param Element - * @return void - **/ - _initializeNode: function (node) { - node.readability = { contentScore: 0 }; - - switch (node.tagName) { - case "DIV": - node.readability.contentScore += 5; - break; - - case "PRE": - case "TD": - case "BLOCKQUOTE": - node.readability.contentScore += 3; - break; - - case "ADDRESS": - case "OL": - case "UL": - case "DL": - case "DD": - case "DT": - case "LI": - case "FORM": - node.readability.contentScore -= 3; - break; - - case "H1": - case "H2": - case "H3": - case "H4": - case "H5": - case "H6": - case "TH": - node.readability.contentScore -= 5; - break; - } - - node.readability.contentScore += this._getClassWeight(node); - }, - - _removeAndGetNext: function (node) { - var nextNode = this._getNextNode(node, true); - node.parentNode.removeChild(node); - return nextNode; - }, - - /** - * Traverse the DOM from node to node, starting at the node passed in. - * Pass true for the second parameter to indicate this node itself - * (and its kids) are going away, and we want the next node over. - * - * Calling this in a loop will traverse the DOM depth-first. - */ - _getNextNode: function (node, ignoreSelfAndKids) { - // First check for kids if those aren't being ignored - if (!ignoreSelfAndKids && node.firstElementChild) { - return node.firstElementChild; - } - // Then for siblings... - if (node.nextElementSibling) { - return node.nextElementSibling; - } - // And finally, move up the parent chain *and* find a sibling - // (because this is depth-first traversal, we will have already - // seen the parent nodes themselves). - do { - node = node.parentNode; - } while (node && !node.nextElementSibling); - return node && node.nextElementSibling; - }, - - // compares second text to first one - // 1 = same text, 0 = completely different text - // works the way that it splits both texts into words and then finds words that are unique in second text - // the result is given by the lower length of unique parts - _textSimilarity: function (textA, textB) { - var tokensA = textA - .toLowerCase() - .split(this.REGEXPS.tokenize) - .filter(Boolean); - var tokensB = textB - .toLowerCase() - .split(this.REGEXPS.tokenize) - .filter(Boolean); - if (!tokensA.length || !tokensB.length) { - return 0; - } - var uniqTokensB = tokensB.filter((token) => !tokensA.includes(token)); - var distanceB = uniqTokensB.join(" ").length / tokensB.join(" ").length; - return 1 - distanceB; - }, - - _checkByline: function (node, matchString) { - if (this._articleByline) { - return false; - } - - if (node.getAttribute !== undefined) { - var rel = node.getAttribute("rel"); - var itemprop = node.getAttribute("itemprop"); - } - - if ( - (rel === "author" || - (itemprop && itemprop.indexOf("author") !== -1) || - this.REGEXPS.byline.test(matchString)) && - this._isValidByline(node.textContent) - ) { - this._articleByline = node.textContent.trim(); - return true; - } - - return false; - }, - - _getNodeAncestors: function (node, maxDepth) { - maxDepth = maxDepth || 0; - var i = 0, - ancestors = []; - while (node.parentNode) { - ancestors.push(node.parentNode); - if (maxDepth && ++i === maxDepth) break; - node = node.parentNode; - } - return ancestors; - }, - - /*** - * grabArticle - Using a variety of metrics (content score, classname, element types), find the content that is - * most likely to be the stuff a user wants to read. Then return it wrapped up in a div. - * - * @param page a document to run upon. Needs to be a full document, complete with body. - * @return Element - **/ - _grabArticle: function (page) { - this.log("**** grabArticle ****"); - var doc = this._doc; - var isPaging = page !== null; - page = page ? page : this._doc.body; - - // We can't grab an article if we don't have a page! - if (!page) { - this.log("No body found in document. Abort."); - return null; - } - - var pageCacheHtml = page.innerHTML; - - while (true) { - this.log("Starting grabArticle loop"); - var stripUnlikelyCandidates = this._flagIsActive( - this.FLAG_STRIP_UNLIKELYS - ); - - // First, node prepping. Trash nodes that look cruddy (like ones with the - // class name "comment", etc), and turn divs into P tags where they have been - // used inappropriately (as in, where they contain no other block level elements.) - var elementsToScore = []; - var node = this._doc.documentElement; - - let shouldRemoveTitleHeader = true; - - while (node) { - if (node.tagName === "HTML") { - this._articleLang = node.getAttribute("lang"); - } - - var matchString = node.className + " " + node.id; - - if (!this._isProbablyVisible(node)) { - this.log("Removing hidden node - " + matchString); - node = this._removeAndGetNext(node); - continue; - } - - // Check to see if this node is a byline, and remove it if it is. - if (this._checkByline(node, matchString)) { - node = this._removeAndGetNext(node); - continue; - } - - if (shouldRemoveTitleHeader && this._headerDuplicatesTitle(node)) { - this.log( - "Removing header: ", - node.textContent.trim(), - this._articleTitle.trim() - ); - shouldRemoveTitleHeader = false; - node = this._removeAndGetNext(node); - continue; - } - - // Remove unlikely candidates - if (stripUnlikelyCandidates) { - if ( - this.REGEXPS.unlikelyCandidates.test(matchString) && - !this.REGEXPS.okMaybeItsACandidate.test(matchString) && - !this._hasAncestorTag(node, "table") && - !this._hasAncestorTag(node, "code") && - node.tagName !== "BODY" && - node.tagName !== "A" - ) { - this.log("Removing unlikely candidate - " + matchString); - node = this._removeAndGetNext(node); - continue; - } - - if (this.UNLIKELY_ROLES.includes(node.getAttribute("role"))) { - this.log( - "Removing content with role " + - node.getAttribute("role") + - " - " + - matchString - ); - node = this._removeAndGetNext(node); - continue; - } - } - - // Remove DIV, SECTION, and HEADER nodes without any content(e.g. text, image, video, or iframe). - if ( - (node.tagName === "DIV" || - node.tagName === "SECTION" || - node.tagName === "HEADER" || - node.tagName === "H1" || - node.tagName === "H2" || - node.tagName === "H3" || - node.tagName === "H4" || - node.tagName === "H5" || - node.tagName === "H6") && - this._isElementWithoutContent(node) - ) { - node = this._removeAndGetNext(node); - continue; - } - - if (this.DEFAULT_TAGS_TO_SCORE.indexOf(node.tagName) !== -1) { - elementsToScore.push(node); - } - - // Turn all divs that don't have children block level elements into p's - if (node.tagName === "DIV") { - // Put phrasing content into paragraphs. - var p = null; - var childNode = node.firstChild; - while (childNode) { - var nextSibling = childNode.nextSibling; - if (this._isPhrasingContent(childNode)) { - if (p !== null) { - p.appendChild(childNode); - } else if (!this._isWhitespace(childNode)) { - p = doc.createElement("p"); - node.replaceChild(p, childNode); - p.appendChild(childNode); - } - } else if (p !== null) { - while (p.lastChild && this._isWhitespace(p.lastChild)) { - p.removeChild(p.lastChild); - } - p = null; - } - childNode = nextSibling; - } - - // Sites like http://mobile.slate.com encloses each paragraph with a DIV - // element. DIVs with only a P element inside and no text content can be - // safely converted into plain P elements to avoid confusing the scoring - // algorithm with DIVs with are, in practice, paragraphs. - if ( - this._hasSingleTagInsideElement(node, "P") && - this._getLinkDensity(node) < 0.25 - ) { - var newNode = node.children[0]; - node.parentNode.replaceChild(newNode, node); - node = newNode; - elementsToScore.push(node); - } else if (!this._hasChildBlockElement(node)) { - node = this._setNodeTag(node, "P"); - elementsToScore.push(node); - } - } - node = this._getNextNode(node); - } - - /** - * Loop through all paragraphs, and assign a score to them based on how content-y they look. - * Then add their score to their parent node. - * - * A score is determined by things like number of commas, class names, etc. Maybe eventually link density. - **/ - var candidates = []; - this._forEachNode(elementsToScore, function (elementToScore) { - if ( - !elementToScore.parentNode || - typeof elementToScore.parentNode.tagName === "undefined" - ) - return; - - // If this paragraph is less than 25 characters, don't even count it. - var innerText = this._getInnerText(elementToScore); - if (innerText.length < 25) return; - - // Exclude nodes with no ancestor. - var ancestors = this._getNodeAncestors(elementToScore, 5); - if (ancestors.length === 0) return; - - var contentScore = 0; - - // Add a point for the paragraph itself as a base. - contentScore += 1; - - // Add points for any commas within this paragraph. - contentScore += innerText.split(",").length; - - // For every 100 characters in this paragraph, add another point. Up to 3 points. - contentScore += Math.min(Math.floor(innerText.length / 100), 3); - - // Initialize and score ancestors. - this._forEachNode(ancestors, function (ancestor, level) { - if ( - !ancestor.tagName || - !ancestor.parentNode || - typeof ancestor.parentNode.tagName === "undefined" - ) - return; - - if (typeof ancestor.readability === "undefined") { - this._initializeNode(ancestor); - candidates.push(ancestor); - } - - // Node score divider: - // - parent: 1 (no division) - // - grandparent: 2 - // - great grandparent+: ancestor level * 3 - if (level === 0) var scoreDivider = 1; - else if (level === 1) scoreDivider = 2; - else scoreDivider = level * 3; - ancestor.readability.contentScore += contentScore / scoreDivider; - }); - }); - - // After we've calculated scores, loop through all of the possible - // candidate nodes we found and find the one with the highest score. - var topCandidates = []; - for (var c = 0, cl = candidates.length; c < cl; c += 1) { - var candidate = candidates[c]; - - // Scale the final candidates score based on link density. Good content - // should have a relatively small link density (5% or less) and be mostly - // unaffected by this operation. - var candidateScore = - candidate.readability.contentScore * - (1 - this._getLinkDensity(candidate)); - candidate.readability.contentScore = candidateScore; - - this.log("Candidate:", candidate, "with score " + candidateScore); - - for (var t = 0; t < this._nbTopCandidates; t++) { - var aTopCandidate = topCandidates[t]; - - if ( - !aTopCandidate || - candidateScore > aTopCandidate.readability.contentScore - ) { - topCandidates.splice(t, 0, candidate); - if (topCandidates.length > this._nbTopCandidates) - topCandidates.pop(); - break; - } - } - } - - var topCandidate = topCandidates[0] || null; - var neededToCreateTopCandidate = false; - var parentOfTopCandidate; - - // If we still have no top candidate, just use the body as a last resort. - // We also have to copy the body node so it is something we can modify. - if (topCandidate === null || topCandidate.tagName === "BODY") { - // Move all of the page's children into topCandidate - topCandidate = doc.createElement("DIV"); - neededToCreateTopCandidate = true; - // Move everything (not just elements, also text nodes etc.) into the container - // so we even include text directly in the body: - while (page.firstChild) { - this.log("Moving child out:", page.firstChild); - topCandidate.appendChild(page.firstChild); - } - - page.appendChild(topCandidate); - - this._initializeNode(topCandidate); - } else if (topCandidate) { - // Find a better top candidate node if it contains (at least three) nodes which belong to `topCandidates` array - // and whose scores are quite closed with current `topCandidate` node. - var alternativeCandidateAncestors = []; - for (var i = 1; i < topCandidates.length; i++) { - if ( - topCandidates[i].readability.contentScore / - topCandidate.readability.contentScore >= - 0.75 - ) { - alternativeCandidateAncestors.push( - this._getNodeAncestors(topCandidates[i]) - ); - } - } - var MINIMUM_TOPCANDIDATES = 3; - if (alternativeCandidateAncestors.length >= MINIMUM_TOPCANDIDATES) { - parentOfTopCandidate = topCandidate.parentNode; - while (parentOfTopCandidate.tagName !== "BODY") { - var listsContainingThisAncestor = 0; - for ( - var ancestorIndex = 0; - ancestorIndex < alternativeCandidateAncestors.length && - listsContainingThisAncestor < MINIMUM_TOPCANDIDATES; - ancestorIndex++ - ) { - listsContainingThisAncestor += Number( - alternativeCandidateAncestors[ancestorIndex].includes( - parentOfTopCandidate - ) - ); - } - if (listsContainingThisAncestor >= MINIMUM_TOPCANDIDATES) { - topCandidate = parentOfTopCandidate; - break; - } - parentOfTopCandidate = parentOfTopCandidate.parentNode; - } - } - if (!topCandidate.readability) { - this._initializeNode(topCandidate); - } - - // Because of our bonus system, parents of candidates might have scores - // themselves. They get half of the node. There won't be nodes with higher - // scores than our topCandidate, but if we see the score going *up* in the first - // few steps up the tree, that's a decent sign that there might be more content - // lurking in other places that we want to unify in. The sibling stuff - // below does some of that - but only if we've looked high enough up the DOM - // tree. - parentOfTopCandidate = topCandidate.parentNode; - var lastScore = topCandidate.readability.contentScore; - // The scores shouldn't get too low. - var scoreThreshold = lastScore / 3; - while (parentOfTopCandidate.tagName !== "BODY") { - if (!parentOfTopCandidate.readability) { - parentOfTopCandidate = parentOfTopCandidate.parentNode; - continue; - } - var parentScore = parentOfTopCandidate.readability.contentScore; - if (parentScore < scoreThreshold) break; - if (parentScore > lastScore) { - // Alright! We found a better parent to use. - topCandidate = parentOfTopCandidate; - break; - } - lastScore = parentOfTopCandidate.readability.contentScore; - parentOfTopCandidate = parentOfTopCandidate.parentNode; - } - - // If the top candidate is the only child, use parent instead. This will help sibling - // joining logic when adjacent content is actually located in parent's sibling node. - parentOfTopCandidate = topCandidate.parentNode; - while ( - parentOfTopCandidate.tagName != "BODY" && - parentOfTopCandidate.children.length == 1 - ) { - topCandidate = parentOfTopCandidate; - parentOfTopCandidate = topCandidate.parentNode; - } - if (!topCandidate.readability) { - this._initializeNode(topCandidate); - } - } - - // Now that we have the top candidate, look through its siblings for content - // that might also be related. Things like preambles, content split by ads - // that we removed, etc. - var articleContent = doc.createElement("DIV"); - if (isPaging) articleContent.id = "readability-content"; - - var siblingScoreThreshold = Math.max( - 10, - topCandidate.readability.contentScore * 0.2 - ); - // Keep potential top candidate's parent node to try to get text direction of it later. - parentOfTopCandidate = topCandidate.parentNode; - var siblings = parentOfTopCandidate.children; - - for (var s = 0, sl = siblings.length; s < sl; s++) { - var sibling = siblings[s]; - var append = false; - - this.log( - "Looking at sibling node:", - sibling, - sibling.readability - ? "with score " + sibling.readability.contentScore - : "" - ); - this.log( - "Sibling has score", - sibling.readability ? sibling.readability.contentScore : "Unknown" - ); - - if (sibling === topCandidate) { - append = true; - } else { - var contentBonus = 0; - - // Give a bonus if sibling nodes and top candidates have the example same classname - if ( - sibling.className === topCandidate.className && - topCandidate.className !== "" - ) - contentBonus += topCandidate.readability.contentScore * 0.2; - - if ( - sibling.readability && - sibling.readability.contentScore + contentBonus >= - siblingScoreThreshold - ) { - append = true; - } else if (sibling.nodeName === "P") { - var linkDensity = this._getLinkDensity(sibling); - var nodeContent = this._getInnerText(sibling); - var nodeLength = nodeContent.length; - - if (nodeLength > 80 && linkDensity < 0.25) { - append = true; - } else if ( - nodeLength < 80 && - nodeLength > 0 && - linkDensity === 0 && - nodeContent.search(/\.( |$)/) !== -1 - ) { - append = true; - } - } - } - - if (append) { - this.log("Appending node:", sibling); - - if (this.ALTER_TO_DIV_EXCEPTIONS.indexOf(sibling.nodeName) === -1) { - // We have a node that isn't a common block level element, like a form or td tag. - // Turn it into a div so it doesn't get filtered out later by accident. - this.log("Altering sibling:", sibling, "to div."); - - sibling = this._setNodeTag(sibling, "DIV"); - } - - articleContent.appendChild(sibling); - // Fetch children again to make it compatible - // with DOM parsers without live collection support. - siblings = parentOfTopCandidate.children; - // siblings is a reference to the children array, and - // sibling is removed from the array when we call appendChild(). - // As a result, we must revisit this index since the nodes - // have been shifted. - s -= 1; - sl -= 1; - } - } - - if (this._debug) - this.log("Article content pre-prep: " + articleContent.innerHTML); - // So we have all of the content that we need. Now we clean it up for presentation. - this._prepArticle(articleContent); - if (this._debug) - this.log("Article content post-prep: " + articleContent.innerHTML); - - if (neededToCreateTopCandidate) { - // We already created a fake div thing, and there wouldn't have been any siblings left - // for the previous loop, so there's no point trying to create a new div, and then - // move all the children over. Just assign IDs and class names here. No need to append - // because that already happened anyway. - topCandidate.id = "readability-page-1"; - topCandidate.className = "page"; - } else { - var div = doc.createElement("DIV"); - div.id = "readability-page-1"; - div.className = "page"; - while (articleContent.firstChild) { - div.appendChild(articleContent.firstChild); - } - articleContent.appendChild(div); - } - - if (this._debug) - this.log("Article content after paging: " + articleContent.innerHTML); - - var parseSuccessful = true; - - // Now that we've gone through the full algorithm, check to see if - // we got any meaningful content. If we didn't, we may need to re-run - // grabArticle with different flags set. This gives us a higher likelihood of - // finding the content, and the sieve approach gives us a higher likelihood of - // finding the -right- content. - var textLength = this._getInnerText(articleContent, true).length; - if (textLength < this._charThreshold) { - parseSuccessful = false; - page.innerHTML = pageCacheHtml; - - if (this._flagIsActive(this.FLAG_STRIP_UNLIKELYS)) { - this._removeFlag(this.FLAG_STRIP_UNLIKELYS); - this._attempts.push({ - articleContent: articleContent, - textLength: textLength, - }); - } else if (this._flagIsActive(this.FLAG_WEIGHT_CLASSES)) { - this._removeFlag(this.FLAG_WEIGHT_CLASSES); - this._attempts.push({ - articleContent: articleContent, - textLength: textLength, - }); - } else if (this._flagIsActive(this.FLAG_CLEAN_CONDITIONALLY)) { - this._removeFlag(this.FLAG_CLEAN_CONDITIONALLY); - this._attempts.push({ - articleContent: articleContent, - textLength: textLength, - }); - } else { - this._attempts.push({ - articleContent: articleContent, - textLength: textLength, - }); - // No luck after removing flags, just return the longest text we found during the different loops - this._attempts.sort(function (a, b) { - return b.textLength - a.textLength; - }); - - // But first check if we actually have something - if (!this._attempts[0].textLength) { - return null; - } - - articleContent = this._attempts[0].articleContent; - parseSuccessful = true; - } - } - - if (parseSuccessful) { - // Find out text direction from ancestors of final top candidate. - var ancestors = [parentOfTopCandidate, topCandidate].concat( - this._getNodeAncestors(parentOfTopCandidate) - ); - this._someNode(ancestors, function (ancestor) { - if (!ancestor.tagName) return false; - var articleDir = ancestor.getAttribute("dir"); - if (articleDir) { - this._articleDir = articleDir; - return true; - } - return false; - }); - return articleContent; - } - } - }, - - /** - * Check whether the input string could be a byline. - * This verifies that the input is a string, and that the length - * is less than 100 chars. - * - * @param possibleByline {string} - a string to check whether its a byline. - * @return Boolean - whether the input string is a byline. - */ - _isValidByline: function (byline) { - if (typeof byline == "string" || byline instanceof String) { - byline = byline.trim(); - return byline.length > 0 && byline.length < 100; - } - return false; - }, - - /** - * Converts some of the common HTML entities in string to their corresponding characters. - * - * @param str {string} - a string to unescape. - * @return string without HTML entity. - */ - _unescapeHtmlEntities: function (str) { - if (!str) { - return str; - } - - var htmlEscapeMap = this.HTML_ESCAPE_MAP; - return str - .replace(/&(quot|amp|apos|lt|gt);/g, function (_, tag) { - return htmlEscapeMap[tag]; - }) - .replace( - /&#(?:x([0-9a-z]{1,4})|([0-9]{1,4}));/gi, - function (_, hex, numStr) { - var num = parseInt(hex || numStr, hex ? 16 : 10); - return String.fromCharCode(num); - } - ); - }, - - /** - * Try to extract metadata from JSON-LD object. - * For now, only Schema.org objects of type Article or its subtypes are supported. - * @return Object with any metadata that could be extracted (possibly none) - */ - _getJSONLD: function (doc) { - var scripts = this._getAllNodesWithTag(doc, ["script"]); - - var metadata; - - this._forEachNode(scripts, function (jsonLdElement) { - if ( - !metadata && - jsonLdElement.getAttribute("type") === "application/ld+json" - ) { - try { - // Strip CDATA markers if present - var content = jsonLdElement.textContent.replace( - /^\s*\s*$/g, - "" - ); - var parsed = JSON.parse(content); - if ( - !parsed["@context"] || - !parsed["@context"].match(/^https?\:\/\/schema\.org$/) - ) { - return; - } - - if (!parsed["@type"] && Array.isArray(parsed["@graph"])) { - parsed = parsed["@graph"].find(function (it) { - return (it["@type"] || "").match(this.REGEXPS.jsonLdArticleTypes); - }); - } - - if ( - !parsed || - !parsed["@type"] || - !parsed["@type"].match(this.REGEXPS.jsonLdArticleTypes) - ) { - return; - } - - metadata = {}; - - if ( - typeof parsed.name === "string" && - typeof parsed.headline === "string" && - parsed.name !== parsed.headline - ) { - // we have both name and headline element in the JSON-LD. They should both be the same but some websites like aktualne.cz - // put their own name into "name" and the article title to "headline" which confuses Readability. So we try to check if either - // "name" or "headline" closely matches the html title, and if so, use that one. If not, then we use "name" by default. - - var title = this._getArticleTitle(); - var nameMatches = this._textSimilarity(parsed.name, title) > 0.75; - var headlineMatches = - this._textSimilarity(parsed.headline, title) > 0.75; - - if (headlineMatches && !nameMatches) { - metadata.title = parsed.headline; - } else { - metadata.title = parsed.name; - } - } else if (typeof parsed.name === "string") { - metadata.title = parsed.name.trim(); - } else if (typeof parsed.headline === "string") { - metadata.title = parsed.headline.trim(); - } - if (parsed.author) { - if (typeof parsed.author.name === "string") { - metadata.byline = parsed.author.name.trim(); - } else if ( - Array.isArray(parsed.author) && - parsed.author[0] && - typeof parsed.author[0].name === "string" - ) { - metadata.byline = parsed.author - .filter(function (author) { - return author && typeof author.name === "string"; - }) - .map(function (author) { - return author.name.trim(); - }) - .join(", "); - } - } - if (typeof parsed.description === "string") { - metadata.excerpt = parsed.description.trim(); - } - if (parsed.publisher && typeof parsed.publisher.name === "string") { - metadata.siteName = parsed.publisher.name.trim(); - } - return; - } catch (err) { - this.log(err.message); - } - } - }); - return metadata ? metadata : {}; - }, - - /** - * Attempts to get excerpt and byline metadata for the article. - * - * @param {Object} jsonld — object containing any metadata that - * could be extracted from JSON-LD object. - * - * @return Object with optional "excerpt" and "byline" properties - */ - _getArticleMetadata: function (jsonld) { - var metadata = {}; - var values = {}; - var metaElements = this._doc.getElementsByTagName("meta"); - - // property is a space-separated list of values - var propertyPattern = - /\s*(dc|dcterm|og|twitter)\s*:\s*(author|creator|description|title|site_name)\s*/gi; - - // name is a single value - var namePattern = - /^\s*(?:(dc|dcterm|og|twitter|weibo:(article|webpage))\s*[\.:]\s*)?(author|creator|description|title|site_name)\s*$/i; - - // Find description tags. - this._forEachNode(metaElements, function (element) { - var elementName = element.getAttribute("name"); - var elementProperty = element.getAttribute("property"); - var content = element.getAttribute("content"); - if (!content) { - return; - } - var matches = null; - var name = null; - - if (elementProperty) { - matches = elementProperty.match(propertyPattern); - if (matches) { - // Convert to lowercase, and remove any whitespace - // so we can match below. - name = matches[0].toLowerCase().replace(/\s/g, ""); - // multiple authors - values[name] = content.trim(); - } - } - if (!matches && elementName && namePattern.test(elementName)) { - name = elementName; - if (content) { - // Convert to lowercase, remove any whitespace, and convert dots - // to colons so we can match below. - name = name.toLowerCase().replace(/\s/g, "").replace(/\./g, ":"); - values[name] = content.trim(); - } - } - }); - - // get title - metadata.title = - jsonld.title || - values["dc:title"] || - values["dcterm:title"] || - values["og:title"] || - values["weibo:article:title"] || - values["weibo:webpage:title"] || - values["title"] || - values["twitter:title"]; - - if (!metadata.title) { - metadata.title = this._getArticleTitle(); - } - - // get author - metadata.byline = - jsonld.byline || - values["dc:creator"] || - values["dcterm:creator"] || - values["author"]; - - // get description - metadata.excerpt = - jsonld.excerpt || - values["dc:description"] || - values["dcterm:description"] || - values["og:description"] || - values["weibo:article:description"] || - values["weibo:webpage:description"] || - values["description"] || - values["twitter:description"]; - - // get site name - metadata.siteName = jsonld.siteName || values["og:site_name"]; - - // in many sites the meta value is escaped with HTML entities, - // so here we need to unescape it - metadata.title = this._unescapeHtmlEntities(metadata.title); - metadata.byline = this._unescapeHtmlEntities(metadata.byline); - metadata.excerpt = this._unescapeHtmlEntities(metadata.excerpt); - metadata.siteName = this._unescapeHtmlEntities(metadata.siteName); - - return metadata; - }, - - /** - * Check if node is image, or if node contains exactly only one image - * whether as a direct child or as its descendants. - * - * @param Element - **/ - _isSingleImage: function (node) { - if (node.tagName === "IMG") { - return true; - } - - if (node.children.length !== 1 || node.textContent.trim() !== "") { - return false; - } - - return this._isSingleImage(node.children[0]); - }, - - /** - * Find all