Wikipedia:Huggle/Huggle3

This page documents how to set up and install Huggle 3 in case you want to perform beta testing, or are just curious to try out the new Huggle.

Please keep in mind that Huggle 3 is currently incomplete. There may be bugs, glitches, and other vulnerabilities. Exercise caution if testing on production wikis.

FAQ

What is Huggle 3?

Huggle 3 is a complete rewrite of Huggle 2x, largely due to the reason that Huggle 2 was written in VB, and that produced binaries which can run only on Windows. Some people managed to run them on Linux as well, but the performance was always bad and not everything worked properly. Huggle 3 is cross-platform and can be natively compiled on every popular platform, including Linux, OSX and Windows.

Because it has been rewritten mostly from scratch, it may contain fewer features than the old Huggle (but a few new ones may have slipped in). Unless you want to help beta test the program, it is recommended that you stick with Huggle 2 until it is complete.

I am receiving errors such as "Unable to parse a diff for PAGENAME, fallback to web rendering". What is that?

This mean that Huggle was, for some reason, unable to get a diff using API. It's likely that the server that was processing the API request didn't hear anything from a lagged SQL slave server, and the requested revision couldn't be displayed. The developers are aware of this bug and a fix will be available soon.

Where did the drop-down menu to select a different revert reason go?

Huggle uses Qt which renders this kind of button in an odd way. You need to click and hold on the revert button for the menu to appear.

I don't see the "English Wikipedia" in the project list. What happened?

You need to hit the Reload button in the login form.

Changes

Speed and memory usage

Huggle is now written in C++, running natively, with no need for an interpreter. Therefore it runs much faster and requires less operating memory. It also uses WebKit instead of Internet Explorer in order to display HTML, which is much faster and contains no known leaks.

Performance

Edits are first downloaded before they are put into the queue, so that moving to the next edit in the queue is much snappier (depending on your hardware). On the other hand though, it takes slightly longer for an edit to appear in the queue.

Reporting

Huggle 3 contains a sophisticated reporting system that can be used on any wiki, not just en.wiki. For each report, you can pick from a list of edits that are vandalism, and include them inside of the report. Unlike Huggle 2, automatic reporting is not available in order to reduce the number of false reports, which the old Huggle was prone to.

Good edit

Every edit can be flagged as a good edit, which is just the opposite of reverting an edit. The user gets a negative score (users with a very low score get whitelisted), and if they don't have a talk page, it is created with a welcome message and other users of Huggle are notified about this user being a constructive editor. When you flag an edit as a good edit, it is not reverted, and you are automatically taken to the next edit. The keyboard shortcut is G.

Prediction

All edits are put into the queue after they are post-processed, so that the content of diff is pre-parsed and checked against a list of words and other common vandalism patterns. The edits are scored and then sorted in queue by score, instead of type.

HAN system

The Huggle Anti-vandalism Network (HAN) is a new system that allows all users of Huggle (and compatible tools or bots) to cooperate when dealing with vandals. Users share their information about suspicious edits, reverts, deletes, etc. so that they minimize edit conflicts and maximize the potential as a true anti-vandalism team.

Extensions

There are far less features in the latest Huggle; mostly those that were seldom used were excluded. Any extra functionalities, especially features that only work on certain wikis, will be supported and available through optional extensions.

Portability

Huggle can be booted from any device, including flash drives or network drives. The --chroot option also allows Huggle to store its configuration files there, so that it can be made completely portable, with no need for any installation and easily used on any operating system. You can even mix multiple binaries, built for different OS and have them share same configuration files. That will let you use same Huggle with same config on any platform.

Security

Huggle 3 supports SSL through OpenSSL libraries, which makes it safe to use even when using unsecured wireless or mobile Internet.

How to make Huggle 3 behave more like the old Huggle

In System, Options...

• In tab Reverting, uncheck "Require confirmation for revert of edit that was made in user space"
• In tab Feed, check "Remove old edits from the queue if a newer edit to same page is received"
• In tab Performance, check "Switch to the latest revision of the page in case the currently loaded edit is not the latest revision"
• In tab Performance, in frame When you revert or change of displayed edit, check "Retrieve your own edit"

Known issues

• Personal config doesn't really work so far; if you start using Huggle 3 your personal config from Huggle 2 will be destroyed
  •  Fixed The config will now be saved under huggle3.css in your userspace
• (Ctrl+S) Delete on zhwiki does not work (4 ERROR: no diff available for 美国麻将 unable to rescore)
• Page protection requests, page deletion, etc. are glitchy  Fixed
• Tagging interfaces are not implemented (in the meantime you can use Twinkle)
• Software rollback doesn't work yet, so you can't use Huggle if you don't have rollback rights  Fixed
• Localization for many items is missing
• Preferences contains very few items  Fixed
• There is no way to change the queue filters  Fixed
• Only 1 queue is available (this will probably be the way the initial version will work, since there is no real need for multiple queues)
• Some pages don't have cute diff (ERROR: no diff available for PAGE unable to rescore). This has several possible reasons; most of them are fixable except for one where the slave cache of the WMF cluster doesn't contain the data for diff yet (APIs use different slave servers). Will hopefully be fixed soon.

How to install

Prebuilt packages

Windows

Installer: 3.4.12

Ubuntu

• Use ppa ppa:huggle-devs/ppa

  sudo add-apt-repository ppa:huggle-devs/ppa

  sudo apt-get update

  sudo apt-get install huggle

Debian

Use ppa ppa:benapetr/huggle

• Create /etc/apt/sources.list.d/huggle.list containing

  deb http://ppa.launchpad.net/huggle-devs/ppa/ubuntu trusty main

  deb-src http://ppa.launchpad.net/huggle-devs/ppa/ubuntu trusty main

• Execute (some warnings regarding trust and keys may be displayed)

  sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys F3D77590

  sudo apt-get update

  sudo apt-get install huggle

Updated Sept. 2014

Mac OS X

Installer: Version 3.1.1

Source code

Windows

See this video tutorial on how to install Huggle — http://www.youtube.com/watch?v=aQsALFMGimI

• Download and install Qt SDK from http://qt-project.org/downloads#qt-creator
• Download the source code from GitHub:

  git clone http://github.com/huggle/huggle3-qt-lx

• Open the source code in Qt Creator
• Create empty version.txt in folder Huggle
• Build it

Linux

• Download Qt SDK and python-dev
  • For Debian / Ubuntu Qt4

    sudo apt-get install python-dev libqt4-dev libqt4-webkit libqt4-network qt4-qmake libqtwebkit-dev libqt4-dev-bin qt4-dev-tools make g++ gcc

  • For Debian / Ubuntu Qt5

    sudo apt-get install pyqt5-dev-tools qt5-qmake python-dev make g++ gcc

• Get source code

  git clone http://github.com/huggle/huggle3-qt-lx

  cd huggle3-qt-lx/huggle

• Build it

  ./configure

  cd huggle_release

  make

• Start Huggle

  ./huggle

Mac OS

Guide on GitHub