search

midori-browser / core

Midori Web Browser - a lightweight, fast and free web browser using WebKit and GTK+
https://www.midori-browser.org/
GNU Lesser General Public License v2.1
406 stars 68 forks source link
browser gtk3 webkit

readme

CircleCI Snap Status FlatHub Telegram Twitter Donate BountySource Patreon

Midori a lightweight, fast and free web browser

Midori Screenshot

Midori is a lightweight yet powerful web browser which runs just as well on little embedded computers named for delicious pastries as it does on beefy machines with a core temperature exceeding that of planet earth. And it looks good doing that, too. Oh, and of course it's free software.

Privacy out of the box

Productivity features

Please report comments, suggestions and bugs to: https://github.com/midori-browser/core/issues

Join the #midori IRC channel on Freenode or the Telegram group!

Installing Midori on Linux

If your distro supports snaps you can install the latest stable version of Midori from the snap store with a single command:

snap install midori

Spoilers: For those more adventurous types out there, trying out the preview of the next version is only the switch of a channel away.

You can also install Midori from FlatHub.

flatpak install flathub org.midori_browser.Midori

Installing Midori on Android

You can opt-in for the beta release on the Play Store.

Building from source

Requirements

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 Midori:

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).

Midori can be run without being installed.

_build/midori

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

Release process

We're on a 8/4 cycle which means 8 weeks of features and 4 weeks of stabilization capped at a release once every 3 months ie. at the last of the third month.

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

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

Propose a PR for the release. Publish the release on https://github.com/midori-browser/core/releases Promote snap on https://snapcraft.io/midori/release to the stable channel

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/midori
run
…
bt

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

env G_MESSAGES_DEBUG=all gdb _build/midori

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

file midori.exe
run
…
bt

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

# Revert only d54c7e45
git revert d54c7e45

Contributing code

Coding style and quality

Midori code should in general have:

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/core.git

Prepare to pull in updates from upstream:

git remote add upstream https://github.com/midori-browser/core.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 Midori:

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

Midori for Android

The easiest way to build, develop and test Midori 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

Midori for Windows

For Linux developers

Dependencies

Midori 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 Midori 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 Midori archive with a helper script

32-bit build:

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

64-bit build:

env MINGW_PREFIX="/usr/x86_64-w64-mingw32/sys-root/mingw/" ./win32/makedist/makedist.midori 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

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

Using download-mingw-rpm.py

See Fedora 18 packages.

Spoilers: Use msys.bat to launch a shell