Simple dispatcher and protocol for shell-based plugins, an improvement to hook scripts
Go Shell Makefile Python Ruby
Latest commit 7b91f76 Jul 2, 2015 @progrium Merge pull request #15 from alessio/master
Update crypto's import path

README.md

pluginhook

A simple plugin system for Bash programs that's better than just hook scripts.

Plugins as a better way

Let's take the core benefits of hook scripts and re-structure it slightly:

  1. Instead of focusing on hook scripts, we focus on plugins -- a directory of hook scripts
  2. Like hook scripts, plugins are active by being in a certain place. But they can be named anything
  3. Multiple plugins can handle a hook. Either for fanout event triggering, or for pipeline filtering

So what is a plugin? A directory full of hook scripts. When a hook is triggered, all arguments provided in the trigger are given to each hook script. They also receive STDIN in a pipelined fashion.

Triggering plugin hooks

You use the pluginhook command to trigger hooks as if you might call a traditional hook script directly. Where before you might have triggered by calling something like:

hooks/post-commit $REV $USER

You'd instead trigger like this:

pluginhook post-commit $REV $USER

The pluginhook command simply loops through all plugin directories found in the path defined by the environment variable PLUGIN_PATH and passes the same arguments to any hook scripts by that name. This means installing a plugin is as simple as putting it in your PLUGIN_PATH. Then any plugin that has the post-commit hook script will be run.

Pipeline filtering with plugins

You don't just get a "broadcast" mechanism for arguments. You also get stream pipelining. If you pipe a stream into pluginhook, it will be passed through each plugin hook, letting each plugin act as a filtering process. By clearly defining how a hook should be used and how it can play well with others, this becomes very powerful infrastructure.

Here is a plugin we'll call upper implementing a text hook (which would be in $PLUGIN_PATH/upper/text):

#!/usr/bin/env python
import sys
sys.stdout.write(sys.stdin.read().upper())

Here is a plugin we'll call reverse that also implements a text hook ($PLUGIN_PATH/reverse/text):

#!/usr/bin/env ruby
puts STDIN.read.strip.reverse

One plugin uses Python to implement the hook, the other uses Ruby. But it doesn't matter, they work together when you trigger the hook:

$ echo "hello world" | pluginhook text
DLROW OLLEH

Only plugins that implement a hook are used as filters for that hook, so there's no need to implement pass-through hooks if a plugin doesn't care about a hook.

If ordering is important, you can always rename your plugin directory to start with a number, which will define an order of execution. A plugin author might care about when it is run, but it's up to the user to take their advice or decide to run it in a different position in the order, by simply renaming the plugin script.

What's wrong with just hook scripts?

Lots of shell-based systems use hook scripts as a means to allow users to extend or customize behavior. Popular examples are Git and SVN, but many systems from libvirt to NPM to OS X use this pattern. Shell scripts make for a great way to expose hooks because the shell environment is ubiquitous and lets you easily call into scripts or programs written in your language of choice.

The standard implementation of hook scripts is to have a shell script with an execute bit in a particular location that's named after the hook. The most famous example is the "post-commit" hook of SVN, which if hooks/post-commit exists in your repository directory with an execute bit, it will trigger this script after each commit. Some systems let you register hooks by providing a location instead of using convention.

However, in either case, each hook points to one script. The only way for a third-party piece of software to "hook in" is to install itself as the one hook script, or have you manually install it by calling it from your existing hook script. What's more, if a third-party piece of software wants to use multiple hooks, you have to deal with this several times over. Not only is this a hassle, but leads to complex and non-obvious configurations.

Author

Jeff Lindsay progrium@gmail.com

License

MIT