├── .envrc ├── shell.nix ├── .bors-hooks └── after-merge ├── bors.toml ├── bloohm.jpg ├── boot.py ├── .ghci ├── test └── Main.hs ├── default.nix ├── .gitignore ├── nix ├── sources.json └── sources.nix ├── app └── Main.hs ├── src └── Bloohm.hs ├── flake.nix ├── bloohm.cabal ├── flake.lock ├── README.md ├── code.py └── LICENSE /.envrc: -------------------------------------------------------------------------------- 1 | use flake 2 | -------------------------------------------------------------------------------- /shell.nix: -------------------------------------------------------------------------------- 1 | (import ./default.nix {}).shell 2 | -------------------------------------------------------------------------------- /.bors-hooks/after-merge: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | simformat . 3 | -------------------------------------------------------------------------------- /bors.toml: -------------------------------------------------------------------------------- 1 | status = [ "testing/bloohm" ] 2 | timeout_sec = 600 -------------------------------------------------------------------------------- /bloohm.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/shapr/bloohm/HEAD/bloohm.jpg -------------------------------------------------------------------------------- /boot.py: -------------------------------------------------------------------------------- 1 | import usb_cdc 2 | 3 | usb_cdc.enable(console=True, data=True) # Enable console and data 4 | -------------------------------------------------------------------------------- /.ghci: -------------------------------------------------------------------------------- 1 | :def hoogle \x -> return $ ":! hoogle --count=15 \"" ++ x ++ "\"" 2 | :def doc \x -> return $ ":!hoogle --info \"" ++ x ++ "\"" 3 | :set -XOverloadedStrings 4 | :set -XOverloadedLists 5 | -------------------------------------------------------------------------------- /test/Main.hs: -------------------------------------------------------------------------------- 1 | {-# LANGUAGE TemplateHaskell #-} 2 | 3 | module Main where 4 | 5 | import Hedgehog 6 | import Hedgehog.Main 7 | import Bloohm 8 | 9 | prop_test :: Property 10 | prop_test = property $ do 11 | doBloohm === "Bloohm" 12 | 13 | main :: IO () 14 | main = defaultMain [checkParallel $$(discover)] 15 | -------------------------------------------------------------------------------- /default.nix: -------------------------------------------------------------------------------- 1 | (import 2 | ( 3 | let lock = builtins.fromJSON (builtins.readFile ./flake.lock); in 4 | fetchTarball { 5 | url = "https://github.com/edolstra/flake-compat/archive/${lock.nodes.flake-compat.locked.rev}.tar.gz"; 6 | sha256 = lock.nodes.flake-compat.locked.narHash; 7 | } 8 | ) 9 | { src = ./.; } 10 | ).defaultNix 11 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # nix 2 | result 3 | result-* 4 | 5 | # haskell 6 | dist 7 | dist-* 8 | cabal-dev 9 | *.o 10 | *.hi 11 | *.hie 12 | *.chi 13 | *.chs.h 14 | *.dyn_o 15 | *.dyn_hi 16 | .hpc 17 | .hsenv 18 | .cabal-sandbox/ 19 | cabal.sandbox.config 20 | *.prof 21 | *.aux 22 | *.hp 23 | *.eventlog 24 | .stack-work/ 25 | cabal.project.local 26 | cabal.project.local~ 27 | .HTF/ 28 | .ghc.environment.* 29 | -------------------------------------------------------------------------------- /nix/sources.json: -------------------------------------------------------------------------------- 1 | { 2 | "nixpkgs": { 3 | "branch": "nixpkgs-unstable", 4 | "description": "Nix Packages collection", 5 | "homepage": null, 6 | "owner": "nixos", 7 | "repo": "nixpkgs", 8 | "rev": "e5b478271ea0af7b75d53c92cfa98bdb126b44a7", 9 | "sha256": "06hmxvnx2swk63i15zp1q70axf53x04f7ywwlnxlcfkk0prrmwbh", 10 | "type": "tarball", 11 | "url": "https://github.com/nixos/nixpkgs/archive/e5b478271ea0af7b75d53c92cfa98bdb126b44a7.tar.gz", 12 | "url_template": "https://github.com///archive/.tar.gz" 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /app/Main.hs: -------------------------------------------------------------------------------- 1 | {-# LANGUAGE LambdaCase #-} 2 | {-# LANGUAGE OverloadedStrings #-} 3 | {-# LANGUAGE ScopedTypeVariables #-} 4 | 5 | module Main where 6 | 7 | import Bloohm (findPos) 8 | import qualified Data.ByteString.Char8 as B 9 | import Data.List ( intercalate ) 10 | import ReadArgs (readArgs) 11 | import System.Environment (getArgs) 12 | import System.Hardware.Serialport 13 | ( hOpenSerial, 14 | defaultSerialSettings, 15 | CommSpeed(CS115200), 16 | SerialPortSettings(commSpeed) ) 17 | import System.IO ( hClose, hPutStr ) 18 | 19 | main :: IO () 20 | main = do 21 | (serialPort, color :: Color, dir, cmdline) <- readArgs 22 | let indices = findPos $ dir <> cmdline 23 | c = show color 24 | combined = (c <>) <$> (show <$> indices) -- 1,13 -> r1,r13 25 | total = intercalate "," combined 26 | h <- hOpenSerial serialPort $ defaultSerialSettings {commSpeed = CS115200} 27 | -- print $ "sending " <> total <> " to " <> serialPort 28 | hPutStr h total -- circuit python wants 29 | hClose h 30 | 31 | data Color = Red | Green | Blue | Yellow deriving (Read, Eq, Ord) 32 | 33 | instance Show Color where 34 | show = \case 35 | Red -> "r" 36 | Green -> "g" 37 | Blue -> "b" 38 | Yellow -> "y" 39 | -------------------------------------------------------------------------------- /src/Bloohm.hs: -------------------------------------------------------------------------------- 1 | module Bloohm where 2 | 3 | import Crypto.Hash (hashWith) 4 | import Crypto.Hash.Algorithms ( MD5(MD5) ) 5 | import Data.Bits ( Bits((.|.), shiftL) ) 6 | import qualified Data.ByteArray.Encoding as B (Base (..), convertToBase) 7 | import Data.ByteString (ByteString) 8 | import qualified Data.ByteString as BS 9 | import qualified Data.ByteString.Char8 as BS8 10 | import Data.List (sort) 11 | import Data.Word (Word8) 12 | 13 | doBloohm :: String 14 | doBloohm = "Bloohm" 15 | 16 | findPos :: String -> [Integer] 17 | findPos s = findBits $ BS8.pack s 18 | 19 | findBits :: ByteString -> [Integer] 20 | findBits bs = sort [int1, int2, int3] 21 | where wz = BS.unpack $ runhashMD5 bs 22 | wzThird = length wz `div` 3 23 | multipleOfThree = drop (length wz `mod` 3) wz 24 | (int1,ws) = tritMod wzThird multipleOfThree 25 | (int2,ws') = tritMod wzThird ws 26 | (int3,_) = tritMod wzThird ws' 27 | 28 | 29 | 30 | tritMod :: Int -> [Word8] -> (Integer,[Word8]) 31 | tritMod _ [] = error "tritMod got empty list" 32 | tritMod n ws = (roll (take n ws) `mod` 32, drop n ws) 33 | 34 | roll :: [Word8] -> Integer 35 | roll = foldr unstep 0 36 | where 37 | unstep b a = a `shiftL` 8 .|. fromIntegral b 38 | 39 | runhashMD5 :: ByteString -> ByteString 40 | runhashMD5 v = B.convertToBase B.Base16 $ hashWith MD5 v 41 | -------------------------------------------------------------------------------- /flake.nix: -------------------------------------------------------------------------------- 1 | { 2 | inputs = { 3 | # Temporary until `haskell-updates` is merged. Move it back to `nixpkgs-unstable` once it is. 4 | nixpkgs.url = "github:nixos/nixpkgs/nixpkgs-unstable"; 5 | flake-utils.url = "github:numtide/flake-utils/main"; 6 | flake-compat = { 7 | url = "github:edolstra/flake-compat/master"; 8 | flake = false; 9 | }; 10 | }; 11 | 12 | description = 13 | "process status display with automatic layout."; 14 | 15 | outputs = { self, nixpkgs, flake-utils, ... }: 16 | let 17 | overlay = se: su: { 18 | haskellPackages = su.haskellPackages.override { 19 | overrides = hse: hsu: { 20 | "bloohm" = hse.callCabal2nix "bloohm" self { }; 21 | }; 22 | }; 23 | bloohm = se.haskell.lib.justStaticExecutables se.haskellPackages.bloohm; 24 | }; 25 | in { 26 | inherit overlay; 27 | } // flake-utils.lib.eachDefaultSystem (system: 28 | let 29 | pkgs = import nixpkgs { 30 | inherit system; 31 | overlays = [ overlay ]; 32 | config = { allowBroken = true; }; # THIS MAKES ME SAD 33 | }; 34 | in { 35 | 36 | defaultPackage = pkgs.bloohm; 37 | devShell = pkgs.haskellPackages.shellFor { 38 | packages = p: [ p."bloohm" ]; 39 | buildInputs = [ 40 | pkgs.haskellPackages.haskell-language-server 41 | pkgs.haskellPackages.cabal-install 42 | pkgs.haskellPackages.ghcid 43 | pkgs.haskellPackages.ormolu 44 | pkgs.haskellPackages.hlint 45 | pkgs.nixpkgs-fmt 46 | pkgs.bash 47 | ]; 48 | withHoogle = false; 49 | }; 50 | }); 51 | } 52 | -------------------------------------------------------------------------------- /bloohm.cabal: -------------------------------------------------------------------------------- 1 | cabal-version: 3.4 2 | name: bloohm 3 | synopsis: visual bloom filter for neotrellis m4 output 4 | description: visual bloom filter for process status visualization 5 | version: 1.0.0.1 6 | homepage: https://github.com/shapr/bloohm 7 | license: BSD-3-Clause 8 | author: Shae Erisson 9 | maintainer: Shae Erisson 10 | copyright: Shae Erisson 11 | category: Embedded 12 | build-type: Simple 13 | 14 | source-repository head 15 | type: git 16 | location: https://github.com/shapr/bloohm.git 17 | 18 | library 19 | hs-source-dirs: src 20 | default-language: Haskell2010 21 | exposed-modules: Bloohm 22 | ghc-options: -Wall -fno-warn-name-shadowing 23 | build-depends: base >= 4.17 && < 4.20 24 | , crypton >= 0.32 && < 1.1 25 | , bytestring >= 0.11.5 && < 0.12 26 | , memory >= 0.18.0 && < 0.19 27 | 28 | executable bloohm 29 | main-is: Main.hs 30 | hs-source-dirs: app 31 | default-language: Haskell2010 32 | ghc-options: -threaded -O2 33 | build-depends: base >= 4.17 && < 4.20 34 | , bloohm 35 | , serialport >= 0.5.5 && < 0.6 36 | , bytestring >= 0.11.5 && < 0.12 37 | , ReadArgs >= 1.2.3 && < 1.3 38 | 39 | test-suite bloohm-tests 40 | type: exitcode-stdio-1.0 41 | hs-source-dirs: test 42 | main-is: Main.hs 43 | default-language: Haskell2010 44 | ghc-options: -Wall -threaded 45 | build-depends: base 46 | , bloohm 47 | , hedgehog 48 | -------------------------------------------------------------------------------- /flake.lock: -------------------------------------------------------------------------------- 1 | { 2 | "nodes": { 3 | "flake-compat": { 4 | "flake": false, 5 | "locked": { 6 | "lastModified": 1696426674, 7 | "narHash": "sha256-kvjfFW7WAETZlt09AgDn1MrtKzP7t90Vf7vypd3OL1U=", 8 | "owner": "edolstra", 9 | "repo": "flake-compat", 10 | "rev": "0f9255e01c2351cc7d116c072cb317785dd33b33", 11 | "type": "github" 12 | }, 13 | "original": { 14 | "owner": "edolstra", 15 | "ref": "master", 16 | "repo": "flake-compat", 17 | "type": "github" 18 | } 19 | }, 20 | "flake-utils": { 21 | "inputs": { 22 | "systems": "systems" 23 | }, 24 | "locked": { 25 | "lastModified": 1710146030, 26 | "narHash": "sha256-SZ5L6eA7HJ/nmkzGG7/ISclqe6oZdOZTNoesiInkXPQ=", 27 | "owner": "numtide", 28 | "repo": "flake-utils", 29 | "rev": "b1d9ab70662946ef0850d488da1c9019f3a9752a", 30 | "type": "github" 31 | }, 32 | "original": { 33 | "owner": "numtide", 34 | "ref": "main", 35 | "repo": "flake-utils", 36 | "type": "github" 37 | } 38 | }, 39 | "nixpkgs": { 40 | "locked": { 41 | "lastModified": 1713442664, 42 | "narHash": "sha256-LoExypse3c/uun/39u4bPTN4wejIF7hNsdITZO41qTw=", 43 | "owner": "nixos", 44 | "repo": "nixpkgs", 45 | "rev": "d764f230634fa4f86dc8d01c6af9619c7cc5d225", 46 | "type": "github" 47 | }, 48 | "original": { 49 | "owner": "nixos", 50 | "ref": "nixpkgs-unstable", 51 | "repo": "nixpkgs", 52 | "type": "github" 53 | } 54 | }, 55 | "root": { 56 | "inputs": { 57 | "flake-compat": "flake-compat", 58 | "flake-utils": "flake-utils", 59 | "nixpkgs": "nixpkgs" 60 | } 61 | }, 62 | "systems": { 63 | "locked": { 64 | "lastModified": 1681028828, 65 | "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=", 66 | "owner": "nix-systems", 67 | "repo": "default", 68 | "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", 69 | "type": "github" 70 | }, 71 | "original": { 72 | "owner": "nix-systems", 73 | "repo": "default", 74 | "type": "github" 75 | } 76 | } 77 | }, 78 | "root": "root", 79 | "version": 7 80 | } 81 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # bloohm 2 | visual bloom filter to display process status as neotrellis m4 output 3 | 4 | Thanks to @m-clare for pairing with me on the Haskell code, @darius for Python and shell script help, and @christian-blades-cb for nix help. 5 | 6 | # Why? 7 | I like to see process status on my very bright [RGB LED board](https://www.adafruit.com/product/4020). 8 | Until now, I could only turn the whole board colors, yellow for "process running" with red for "non-zero exit" and green for "zero exit code". 9 | 10 | I want the LEDs for output only, I don't want to do any logic on the neotrellis board. 11 | 12 | So, I took an idea from [bloom filters](https://en.wikipedia.org/wiki/Bloom_filter) and run the current directory and command line through three different hashes. 13 | I use the results modulus 32 to figure out which LEDs to update with process status colors. 14 | 15 | # What does it look like? 16 | 17 | In the image below you can see that one command has finished, and another command is in progress. 18 | 19 | ![bloohm](bloohm.jpg) 20 | 21 | # How to make it go? 22 | 0. Your NeoTrellis M4 must be running circuit python 8.x or later to be able to turn on the secondary serial port via boot.py ! 23 | 1. Install bloohm, then add the snippet below to your `~/.zshrc` (no idea if this works in bash). 24 | You may need to change `/dev/ttyACM1` to a different value, `dmesg` will probably show you the right name. 25 | 2. Load the `code.py` from this repository onto your NeoTrellis M4, and additionally copy the boot.py onto your NeoTrellis M4. 26 | 3. run "try ls", and your status LEDs should briefly turn yellow until the command is done, when they turn green. 27 | 28 | # The shell snippet 29 | 30 | ```zsh 31 | # for long running commands 32 | function try () { 33 | export thecmd="$*" 34 | bloohm "/dev/ttyACM1" Yellow $PWD:A $thecmd 35 | time $* && fin || die; # cargo install tally, replacement for time 36 | } 37 | 38 | function play_sound () { 39 | aplay -N -q $HOME/.bin/$1.au 40 | } 41 | 42 | function fin () { 43 | bloohm "/dev/ttyACM1" Green $PWD:A $thecmd 44 | play_sound monkey # monkey.wav from XEmacs https://bitbucket.org/xemacs/sounds-wav/src 45 | } 46 | 47 | function die() { 48 | bloohm "/dev/ttyACM1" Red $PWD:A $thecmd 49 | play_sound yeep # yeep.wav from XEmacs https://bitbucket.org/xemacs/sounds-wav/src 50 | play_sound yeep 51 | } 52 | ``` 53 | # TODO 54 | * benchmark 55 | * add tests 56 | * more docs 57 | * parameterize 58 | the mod 32 is baked into the source code, add a command line parameter? 59 | -------------------------------------------------------------------------------- /code.py: -------------------------------------------------------------------------------- 1 | import time 2 | import board 3 | import busio 4 | import adafruit_trellism4 5 | import adafruit_adxl34x 6 | import supervisor 7 | import usb_cdc 8 | 9 | # Set up Trellis and accelerometer 10 | trellis = adafruit_trellism4.TrellisM4Express(rotation=0) 11 | i2c = busio.I2C(board.ACCELEROMETER_SCL, board.ACCELEROMETER_SDA) 12 | sensor = adafruit_adxl34x.ADXL345(i2c) 13 | data_port = usb_cdc.data 14 | 15 | # set data_port timeout, is this a good value to set? 16 | data_port.timeout = 0 17 | 18 | #define colors 19 | black = (0,0,0) 20 | red = (255,0,0) 21 | green = (0,255,0) 22 | yellow = (255,255,0) 23 | off = (16,16,64) 24 | 25 | # enable tap to clear 26 | sensor.enable_tap_detection(threshold=50) 27 | brightness = 1.0 28 | trellis.pixels.fill((16,16,64)) 29 | 30 | # trellis.pixels.brightness(1) # full brightness on the LEDs, values go from 0 - 1, 0.3 is 30% brightness 31 | pixlsh = [[x,y] for x in range(trellis.pixels.width) for y in range(trellis.pixels.height) ] 32 | pixlsw = [[x,y] for y in range(trellis.pixels.height) for x in range(trellis.pixels.width) ] 33 | 34 | def linear_to_pair(n): 35 | try: 36 | ival = int(n) 37 | except ValueError: 38 | return (0,0) 39 | x = ival % trellis.pixels.width 40 | y = ival // trellis.pixels.width 41 | return (x,y) 42 | 43 | def countup(color,delay=0.01): 44 | #[setloc(x,y,color) for x in range(trellis.pixels.width) for y in range(trellis.pixels.height)] 45 | [setloc(xy[0],xy[1],color,delay) for xy in pixlsh] 46 | [setloc(xy[0],xy[1],color,delay) for xy in pixlsw] 47 | 48 | def setloc(x,y,color,delay): 49 | trellis.pixels[x,y] = color 50 | time.sleep(delay) 51 | 52 | def color(c): 53 | trellis.pixels.fill(c) 54 | 55 | def color_from_input(color_command): 56 | text_data = color_command.decode("utf-8") 57 | data = text_data.strip() 58 | color = off 59 | # print(data) 60 | for l in data.split(","): 61 | if l[0] == "r": 62 | color = red 63 | elif l[0] == "g": 64 | color = green 65 | elif l[0] == "y": 66 | color = yellow 67 | trellis.pixels[linear_to_pair(l[1:])] = color 68 | 69 | while True: 70 | pressed = trellis.pressed_keys 71 | if pressed: 72 | button_x_value = pressed[0][0] # first element of the list, first element of the x,y pair, should be 0-7 73 | brightness = (button_x_value + 3) / 10 74 | trellis.pixels.brightness = brightness 75 | print("set trellis brightness to",brightness) 76 | time.sleep(0.1) 77 | if data_port.in_waiting: 78 | # color_command = data_port.readline() 79 | # color_from_input(color_command) 80 | # combining the two lines above fixed the timing issue where some pixels were yellow and some were green! 81 | color_from_input(data_port.readline()) 82 | # check tap, no colors when detected 83 | if sensor.events['tap']: 84 | countup((16,16,64)) 85 | countup((5,5,5)) 86 | -------------------------------------------------------------------------------- /nix/sources.nix: -------------------------------------------------------------------------------- 1 | # This file has been generated by Niv. 2 | 3 | let 4 | 5 | # 6 | # The fetchers. fetch_ fetches specs of type . 7 | # 8 | 9 | fetch_file = pkgs: spec: 10 | if spec.builtin or true then 11 | builtins_fetchurl { inherit (spec) url sha256; } 12 | else 13 | pkgs.fetchurl { inherit (spec) url sha256; }; 14 | 15 | fetch_tarball = pkgs: name: spec: 16 | let 17 | ok = str: ! builtins.isNull (builtins.match "[a-zA-Z0-9+-._?=]" str); 18 | # sanitize the name, though nix will still fail if name starts with period 19 | name' = stringAsChars (x: if ! ok x then "-" else x) "${name}-src"; 20 | in 21 | if spec.builtin or true then 22 | builtins_fetchTarball { name = name'; inherit (spec) url sha256; } 23 | else 24 | pkgs.fetchzip { name = name'; inherit (spec) url sha256; }; 25 | 26 | fetch_git = spec: 27 | builtins.fetchGit { url = spec.repo; inherit (spec) rev ref; }; 28 | 29 | fetch_builtin-tarball = name: throw 30 | ''[${name}] The niv type "builtin-tarball" is deprecated. You should instead use `builtin = true`. 31 | $ niv modify ${name} -a type=tarball -a builtin=true''; 32 | 33 | fetch_builtin-url = name: throw 34 | ''[${name}] The niv type "builtin-url" will soon be deprecated. You should instead use `builtin = true`. 35 | $ niv modify ${name} -a type=file -a builtin=true''; 36 | 37 | # 38 | # Various helpers 39 | # 40 | 41 | # The set of packages used when specs are fetched using non-builtins. 42 | mkPkgs = sources: 43 | let 44 | sourcesNixpkgs = 45 | import (builtins_fetchTarball { inherit (sources.nixpkgs) url sha256; }) {}; 46 | hasNixpkgsPath = builtins.any (x: x.prefix == "nixpkgs") builtins.nixPath; 47 | hasThisAsNixpkgsPath = == ./.; 48 | in 49 | if builtins.hasAttr "nixpkgs" sources 50 | then sourcesNixpkgs 51 | else if hasNixpkgsPath && ! hasThisAsNixpkgsPath then 52 | import {} 53 | else 54 | abort 55 | '' 56 | Please specify either (through -I or NIX_PATH=nixpkgs=...) or 57 | add a package called "nixpkgs" to your sources.json. 58 | ''; 59 | 60 | # The actual fetching function. 61 | fetch = pkgs: name: spec: 62 | 63 | if ! builtins.hasAttr "type" spec then 64 | abort "ERROR: niv spec ${name} does not have a 'type' attribute" 65 | else if spec.type == "file" then fetch_file pkgs spec 66 | else if spec.type == "tarball" then fetch_tarball pkgs name spec 67 | else if spec.type == "git" then fetch_git spec 68 | else if spec.type == "builtin-tarball" then fetch_builtin-tarball name 69 | else if spec.type == "builtin-url" then fetch_builtin-url name 70 | else 71 | abort "ERROR: niv spec ${name} has unknown type ${builtins.toJSON spec.type}"; 72 | 73 | # Ports of functions for older nix versions 74 | 75 | # a Nix version of mapAttrs if the built-in doesn't exist 76 | mapAttrs = builtins.mapAttrs or ( 77 | f: set: with builtins; 78 | listToAttrs (map (attr: { name = attr; value = f attr set.${attr}; }) (attrNames set)) 79 | ); 80 | 81 | # https://github.com/NixOS/nixpkgs/blob/0258808f5744ca980b9a1f24fe0b1e6f0fecee9c/lib/lists.nix#L295 82 | range = first: last: if first > last then [] else builtins.genList (n: first + n) (last - first + 1); 83 | 84 | # https://github.com/NixOS/nixpkgs/blob/0258808f5744ca980b9a1f24fe0b1e6f0fecee9c/lib/strings.nix#L257 85 | stringToCharacters = s: map (p: builtins.substring p 1 s) (range 0 (builtins.stringLength s - 1)); 86 | 87 | # https://github.com/NixOS/nixpkgs/blob/0258808f5744ca980b9a1f24fe0b1e6f0fecee9c/lib/strings.nix#L269 88 | stringAsChars = f: s: concatStrings (map f (stringToCharacters s)); 89 | concatStrings = builtins.concatStringsSep ""; 90 | 91 | # fetchTarball version that is compatible between all the versions of Nix 92 | builtins_fetchTarball = { url, name, sha256 }@attrs: 93 | let 94 | inherit (builtins) lessThan nixVersion fetchTarball; 95 | in 96 | if lessThan nixVersion "1.12" then 97 | fetchTarball { inherit name url; } 98 | else 99 | fetchTarball attrs; 100 | 101 | # fetchurl version that is compatible between all the versions of Nix 102 | builtins_fetchurl = { url, sha256 }@attrs: 103 | let 104 | inherit (builtins) lessThan nixVersion fetchurl; 105 | in 106 | if lessThan nixVersion "1.12" then 107 | fetchurl { inherit url; } 108 | else 109 | fetchurl attrs; 110 | 111 | # Create the final "sources" from the config 112 | mkSources = config: 113 | mapAttrs ( 114 | name: spec: 115 | if builtins.hasAttr "outPath" spec 116 | then abort 117 | "The values in sources.json should not have an 'outPath' attribute" 118 | else 119 | spec // { outPath = fetch config.pkgs name spec; } 120 | ) config.sources; 121 | 122 | # The "config" used by the fetchers 123 | mkConfig = 124 | { sourcesFile ? ./sources.json 125 | , sources ? builtins.fromJSON (builtins.readFile sourcesFile) 126 | , pkgs ? mkPkgs sources 127 | }: rec { 128 | # The sources, i.e. the attribute set of spec name to spec 129 | inherit sources; 130 | 131 | # The "pkgs" (evaluated nixpkgs) to use for e.g. non-builtin fetchers 132 | inherit pkgs; 133 | }; 134 | in 135 | mkSources (mkConfig {}) // { __functor = _: settings: mkSources (mkConfig settings); } 136 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------