Raphael a lightweight web browser

Raphael is a fork of the Midori web browser to incorporate some bug fixes and security changes in the last webkit based version available.

Privacy out of the box

• Adblock filter list support
• Private browsing
• Manage cookies and scripts

Productivity features

• Open a 1000 tabs instantly
• Easy web apps creation
• Customizable side panels
• User scripts and styles a la Greasemonkey
• Web developer tools powered by WebKit
• Cross-browser extensions compatible with Chrome, Firefox, Opera and Vivaldi

Installing from MidnightBSD

mport install raphael

Building from source

Requirements

• GLib 2.46.2
• GTK 3.12
• WebKitGTK 2.16.6
• libsoup 2.48.0
• sqlite 3.6.19
• Vala 0.30
• GCR 2.32
• Libpeas
• JSON-Glib 0.12

Install dependencies on Astian OS, Ubuntu, Debian or other Debian-based distros:

sudo apt install cmake valac libwebkit2gtk-4.0-dev libgcr-3-dev libpeas-dev libsqlite3-dev libjson-glib-dev libarchive-dev intltool libxml2-utils

Install dependencies on openSUSE:

sudo zypper in cmake vala gcc webkit2gtk3-devel libgcr-devel libpeas-devel sqlite3-devel json-glib-devel libarchive-devel fdupes gettext-tools intltool libxml2-devel

Install dependencies on Fedora:

sudo dnf install gcc cmake intltool vala libsoup-devel sqlite-devel webkit2gtk3-devel gcr-devel json-glib-devel libpeas-devel libarchive-devel libxml2-devel

Use CMake to build Raphael:

mkdir _build
cd _build
cmake -DCMAKE_INSTALL_PREFIX=/usr ..
make
sudo make install

Spoilers: Pass -G Ninja to CMake to use Ninja instead of make (install ninja-build on Ubuntu/ Debian).

Raphael can be run without being installed.

_build/raphael

Testing

Unit tests

You'll want to unit test the code if you're testing a new version or contributed your own changes:

xvfb-run make check

Manual checklist

• Browser window starts up normally, with optional URL(s) on the command line
• Tabs have icons, a close button if there's more than one and can be switched
• Urlbar suggests from typed search or URL, completes from history and highlights key
• Private data can be cleared
• Shortcuts window shows most important hotkeys
• Download button lists on-going and finished downloads
• javascript:alert("test"), javascript:confirm("test") and javascript:input("test") work
• Websites can (un)toggle fullscreen mode
• Shrinking the window moves browser and page actions into the respective menus

Release process

TBD

Update CORE_VERSION in CMakeLists.txt to 10.0. Add a section to CHANGELOG.md. Add release to data/org.midnightbsd.Raphael.appdata.xml.in.

git commit -p -v -m "Release Raphael 10.0"
git checkout -B release-10.0
git push origin HEAD
git archive --prefix=raphael-v10.0/ -o raphael-v10.0.tar.gz -9 HEAD

Troubleshooting

Testing an installed release may reveal crashers or memory corruption which require investigating from a local build and obtaining a stacktrace (backtrace, crash log).

gdb _build/raphael
run
…
bt

If the problem is a warning, not a crash GLib has a handy feature

env G_MESSAGES_DEBUG=all gdb _build/raphael

On Windows you can open the folder where Raphael is installed and double-click gdb.exe which opens a command window:

file raphael.exe
run
…
bt

To verify a regression you might need to revert a particular change:

# Revert only d54c7e45
git revert d54c7e45

If the screen is "blank" as in web pages won't render and you get an EGL initilization error. Try the following: set this in the environment: WEBKIT_DISABLE_COMPOSITING_MODE=1

try running as root to see if it works. (not recommended for security reasons normally)

If these work, you may need to get your user added to the video group on your OS. This also seems to be an issue with some newer mesa releases (22.x) or on systems that use wayland like Ubuntu. [[https://bugs.webkit.org/show_bug.cgi?id=238513]]

Contributing code

Coding style and quality

Raphael code should in general have:

• 4 space indentation, no tabs
• Between 80 to 120 columns
• Use // or /* */ style comments
• Call variables animal and animal_shelter instead of camelCase
• Keep a space between functions/ keywords and round parentheses
• Prefer new Gtk.Widget () over using Gtk; new Widget ()
• Raphael and GLib namespaces should be omitted
• Don't use private specifiers (which is the default)
• Stick to standard Vala-style curly parentheses on the same line
• Cuddled } else { and } catch (Error error) {

Working with Git

If you haven't yet, check that GitHub has your SSH key.

Spoilers: You can create an SSH key with Passwords and Keys aka Seahorse or ssh-keygen -t rsa and specify Host github.com with User git in your SSH config. See GitHub docs for further details.

Fork the project on GitHub.

# USERNAME is your GitHub username
git clone git@github.com:USERNAME/raphael.git

Prepare to pull in updates from upstream:

git remote add upstream https://github.com/midnightbsd/raphael.git

Spoilers: The code used to be hosted at lp:midori and git.xfce.org/apps/midori respectively.

The development master (trunk, tip) is the latest iteration of the next release.

git checkout upstream/master

Pick a name for your feature branch:

git checkout -B myfeature

Remember to keep your branch updated:

git pull -r upstream master

Tell git your name if you haven't yet:

git config user.email "<email@address>"
git config user.name "Real Name"

See what you did so far

git diff

Get an overview of changed and new files:

git status -u

Add new files, move/ rename or delete:

git add FILENAME
mv OLDFILE NEWFILE
rm FILENAME

Commit all current changes, selected interactively:

git commit -p -v

If you have one or more related bug reports you should mention them in the commit message. Once these commits are merged the bug will automatically be closed and the commit log shows clickable links to the reports:

Fixes: #123

If you've made several commits:

git log

In the case you committed something wrong or want to amend it:

git reset --soft HEAD^

If you end up with unrelated debugging code or other patches in the current changes it's sometimes handy to temporarily clean up. This may be seen as git's version of bzr shelve:

git stash save
git commit -p -v
git stash apply

As a general rule of thumb, git COMMAND --help gives you an explanation of any command and git --help -a lists all available commands.

Push your branch and propose it for merging into master.

git push origin HEAD

This will automatically request a review from other developers who can then comment on it and provide feedback.

Extensions

Cross-browser web extensions

The following API specification is supported by Raphael:

manifest.json
  name
  version
  description
  background:
    page: *.html
    scripts:
    - *.js
  browser_action:
    default_popup: *.html
    default_icon: *.png
    default_title
  sidebar_action:
    default_panel: *.html
    default_icon: *.png
    default_title
  content_scripts:
    js:
    - *.js
    css:
    - *.css
  manifest_version: 2

*.js
  browser (chrome)
    tabs
      create
      - url: uri
      executeScript
      - code: string
    notifications
      create
      - title: string
        message: string

Jargon (from Midori)

• freeze: a period of bug fixes eg. 4/2 cycle means 4 weeks of features and 2 weeks of stabilization
• PR: pull request, a branch proposed for review, analogous to MR (merge request) with Bazaar
• ninja: an internal tab, usually empty label, used for taking screenshots
• fortress: user of an ancient release like 0.4.3 as found on Raspberry Pie, Debian, Ubuntu
• katze, sokoke, tabby: legacy API names and coincidentally cat breeds
• web extension: a cross-browser extension (plugin) - or in a webkit context, the multi-process api

Raphael for Android

The easiest way to build, develop and test Raphael on Android is with Android Studio (snap).

When working with the command line, setting JAVA_HOME is paramount:

export JAVA_HOME=/snap/android-studio/current/android-studio/jre/

Afterwards you can run commands like so:

./gradlew lint test

Raphael for Windows

For Linux developers

Dependencies

Raphael for Windows is compiled on a Linux host and MinGW stack. For the current build Fedora 18 packages are used. Packages needed are listed below:

yum install gcc vala intltool

For a native build

yum install libsoup-devel webkitgtk3-devel sqlite-devel

For cross-compilation

yum install mingw{32,64}-webkitgtk3 mingw{32,64}-glib-networking mingw{32,64}-gdb mingw{32,64}-gstreamer-plugins-good

Packages needed when assembling the archive

yum install faenza-icon-theme p7zip mingw32-nsis greybird-gtk3-theme

Installing those should get you the packages needed to successfully build and develop Raphael for Win32.

Building

For 32-bit builds:

mkdir _mingw32
cd _mingw32
mingw32-cmake .. -DCMAKE_INSTALL_PREFIX=/usr/i686-w64-mingw32/sys-root/mingw -DCMAKE_VERBOSE_MAKEFILE=0
make
sudo make install

For 64-bit builds:

mkdir _mingw64
cd _mingw64
mingw64-cmake .. -DCMAKE_INSTALL_PREFIX=/usr/x86_64-w64-mingw32/sys-root/mingw -DCMAKE_VERBOSE_MAKEFILE=0
make
sudo make install

Once built and tested you can assemble the Raphael archive with a helper script

32-bit build:

env MINGW_PREFIX="/usr/i686-w64-mingw32/sys-root/mingw" ./win32/makedist/makedist.raphael

64-bit build:

env MINGW_PREFIX="/usr/x86_64-w64-mingw32/sys-root/mingw/" ./win32/makedist/makedist.raphael x64

Testing

For testing your changes a real system is recommended because WebKitGTK+ doesn't work properly under Wine. Mounting your MinGW directories as a network drive or shared folder in a Windows VM is a good option.

For Windows developers

Prerequisites

• MinGW mingw64 rubenvb/ gcc 4.8.0 (Releases)
• 7zip (32bit Installer) to extract archives
• Python3 to use download-mingw-rpm.py.
• download-mingw-rpm.py to fetch and unpack rpm's
• Msys contains shell and some small utilities
• CMake (Installer)
• Vala

Spoilers: 32-bit versions are known to be more stable at the time of this writing.

Using download-mingw-rpm.py

• Launch cmd.exe and navigate to the folder where the script was saved.
• Make sure that Python can access 7z.exe.
• Run the following command and wait for it to extract the packages into your current directory:
• c:\Python33\python.exe download-mingw-rpm.py -u http://ftp.wsisiz.edu.pl/pub/linux/fedora/linux/updates/18/i386/ --deps mingw32-webkitgtk mingw32-glib-networking mingw32-gdb mingw32-gstreamer-plugins-good

See Fedora 18 packages.

Spoilers: Use msys.bat to launch a shell