├── cli ├── cli.go ├── unit_test.go ├── unit.go ├── logger.go ├── memory.go ├── app.go ├── monitor.go ├── info.go └── ui.go ├── .gitignore ├── redistop.png ├── version └── version.go ├── monitor ├── info.go ├── bulk.go ├── cpu.go ├── redis.go ├── memory.go └── monitor.go ├── go.mod ├── circular ├── circular_test.go └── circular.go ├── README.md ├── Makefile ├── stats └── stats.go ├── main.go ├── go.sum └── LICENSE /cli/cli.go: -------------------------------------------------------------------------------- 1 | package cli 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | bin/ 2 | .gocache 3 | -------------------------------------------------------------------------------- /redistop.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/factorysh/redistop/HEAD/redistop.png -------------------------------------------------------------------------------- /version/version.go: -------------------------------------------------------------------------------- 1 | package version 2 | 3 | var version = "" 4 | 5 | // Version of redistop 6 | func Version() string { 7 | return version 8 | } 9 | -------------------------------------------------------------------------------- /monitor/info.go: -------------------------------------------------------------------------------- 1 | package monitor 2 | 3 | import "github.com/mediocregopher/radix/v3" 4 | 5 | func (r *RedisServer) Info() (map[string]string, error) { 6 | var bulk string 7 | err := r.pool.Do(radix.Cmd(&bulk, "INFO")) 8 | if err != nil { 9 | return nil, err 10 | } 11 | return BulkTable(bulk) 12 | } 13 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/factorysh/redistop 2 | 3 | go 1.16 4 | 5 | require ( 6 | github.com/gdamore/tcell/v2 v2.4.1-0.20210905002822-f057f0a857a1 7 | github.com/guptarohit/asciigraph v0.5.3 8 | github.com/mediocregopher/radix/v3 v3.8.0 9 | github.com/rivo/tview v0.0.0-20220307222120-9994674d60a8 10 | github.com/stretchr/testify v1.7.1 11 | ) 12 | -------------------------------------------------------------------------------- /cli/unit_test.go: -------------------------------------------------------------------------------- 1 | package cli 2 | 3 | import ( 4 | "testing" 5 | 6 | "github.com/stretchr/testify/assert" 7 | ) 8 | 9 | func TestUnit(t *testing.T) { 10 | assert.Equal(t, "42.00", DisplayUnit(42)) 11 | assert.Equal(t, "4.81k", DisplayUnit(4807)) 12 | assert.Equal(t, "42.00M", DisplayUnit(42000000)) 13 | assert.Equal(t, "42.00T", DisplayUnit(42000000000)) 14 | } 15 | -------------------------------------------------------------------------------- /circular/circular_test.go: -------------------------------------------------------------------------------- 1 | package circular 2 | 3 | import ( 4 | "testing" 5 | 6 | "github.com/stretchr/testify/assert" 7 | ) 8 | 9 | func TestCircular(t *testing.T) { 10 | c := NewCircular(5, 2.0) 11 | c.Add(12) 12 | c.Next() 13 | c.Add(10) 14 | assert.Equal(t, []float64{0, 0, 0, 6, 5}, c.Values()) 15 | assert.Equal(t, []float64{0, 6, 5}, c.LastValues(3)) 16 | } 17 | -------------------------------------------------------------------------------- /cli/unit.go: -------------------------------------------------------------------------------- 1 | package cli 2 | 3 | import "fmt" 4 | 5 | func DisplayUnit(value float64) string { 6 | if value > 1000*1000*1000 { 7 | return fmt.Sprintf("%.2fT", value/1000000000) 8 | } 9 | if value > 1000*1000 { 10 | return fmt.Sprintf("%.2fM", value/1000000) 11 | } 12 | if value > 1000 { 13 | return fmt.Sprintf("%.2fk", value/1000) 14 | } 15 | return fmt.Sprintf("%.2f", value) 16 | } 17 | -------------------------------------------------------------------------------- /monitor/bulk.go: -------------------------------------------------------------------------------- 1 | package monitor 2 | 3 | import ( 4 | "strings" 5 | ) 6 | 7 | func BulkTable(bulk string) (map[string]string, error) { 8 | s := make(map[string]string) 9 | lines := strings.Split(bulk, "\r\n") 10 | for _, line := range lines { 11 | if strings.HasPrefix(line, "#") { 12 | continue 13 | } 14 | values := strings.Split(line, ":") 15 | if len(values) > 1 { 16 | s[values[0]] = values[1][:len(values[1])] 17 | } 18 | } 19 | return s, nil 20 | } 21 | -------------------------------------------------------------------------------- /monitor/cpu.go: -------------------------------------------------------------------------------- 1 | package monitor 2 | 3 | import ( 4 | "time" 5 | ) 6 | 7 | type CPU struct { 8 | sys float64 9 | user float64 10 | ts time.Time 11 | } 12 | 13 | func NewCPU(sys, user float64) *CPU { 14 | return &CPU{ 15 | sys: sys, 16 | user: user, 17 | ts: time.Now(), 18 | } 19 | } 20 | 21 | func (c *CPU) Tick(sys, user float64) (float64, float64) { 22 | now := time.Now() 23 | delta := now.Sub(c.ts) 24 | s := (sys - c.sys) / delta.Seconds() * 100 25 | u := (user - c.user) / delta.Seconds() * 100 26 | c.sys = sys 27 | c.user = user 28 | c.ts = now 29 | return s, u 30 | } 31 | -------------------------------------------------------------------------------- /cli/logger.go: -------------------------------------------------------------------------------- 1 | package cli 2 | 3 | import ( 4 | "fmt" 5 | "sync" 6 | "time" 7 | 8 | "github.com/rivo/tview" 9 | ) 10 | 11 | type Logger struct { 12 | block *tview.TextView 13 | wg *sync.WaitGroup 14 | } 15 | 16 | func (l *Logger) Printf(tpl string, args ...interface{}) { 17 | l.block.SetText(fmt.Sprintf(tpl, args...)) 18 | if l.wg == nil { 19 | l.wg = &sync.WaitGroup{} 20 | l.wg.Add(1) 21 | go func() { 22 | l.wg.Wait() 23 | l.wg = nil 24 | l.block.SetText("") 25 | }() 26 | } else { 27 | l.wg.Add(1) 28 | } 29 | time.AfterFunc(5*time.Second, func() { 30 | l.wg.Done() 31 | }) 32 | } 33 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Redis Top 2 | ========= 3 | 4 | Redistop uses [MONITOR](https://redis.io/commands/monitor) to watch Redis 5 | commands and shows per command and per host statistics. 6 | 7 | > Because MONITOR streams back all commands, its use comes at a cost. 8 | 9 | Redistop uses INFO command too. 10 | 11 | Example 12 | ------- 13 | 14 | ![Redis Top screenshot](redistop.png) 15 | 16 | Build 17 | ----- 18 | 19 | If you have recent golang dev enironment set, you can build it with the Makefile 20 | 21 | make 22 | 23 | If you need a Linux compilation, or juste using Docker: 24 | 25 | make docker-build 26 | 27 | License 28 | ------- 29 | 30 | GPL v3 31 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | GIT_VERSION?=$(shell git describe --tags --always --abbrev=42 --dirty) 2 | 3 | build: bin 4 | go build \ 5 | -o bin/redistop \ 6 | -ldflags "-X github.com/factorysh/redistop/version.version=$(GIT_VERSION)" \ 7 | . 8 | 9 | bin: 10 | mkdir -p bin 11 | 12 | docker-build: 13 | mkdir -p .gocache 14 | docker run -t \ 15 | -v `pwd`:/src \ 16 | -v `pwd`/.gocache:/.cache \ 17 | -e GOCACHE=/.cache \ 18 | -u `id -u` \ 19 | -w /src \ 20 | bearstech/golang-dev \ 21 | make 22 | docker run -t \ 23 | -v `pwd`:/src \ 24 | -w /src/bin \ 25 | bearstech/upx \ 26 | upx redistop 27 | 28 | test: 29 | go test -cover \ 30 | github.com/factorysh/redistop/circular 31 | -------------------------------------------------------------------------------- /cli/memory.go: -------------------------------------------------------------------------------- 1 | package cli 2 | 3 | import ( 4 | "fmt" 5 | "time" 6 | ) 7 | 8 | func (a *App) MemoryLoop() { 9 | go func() { 10 | for { 11 | m, err := a.redis.Memory() 12 | if err != nil { 13 | a.log.Printf("Memory Error : %s", err.Error()) 14 | } else { 15 | a.ui.header.GetCell(0, 4).Text = fmt.Sprintf("keys: %d", m.KeysCount) 16 | a.ui.header.GetCell(0, 5).Text = fmt.Sprintf("mem: %s", DisplayUnit(float64(m.PeakAllocated))) 17 | } 18 | kv, err := a.redis.Info() 19 | if err != nil { 20 | a.log.Printf("Info Memory Error : %s", err.Error()) 21 | } else { 22 | a.ui.app.QueueUpdate(func() { 23 | a.ui.memories.SetTitle(fmt.Sprintf("Memory [ %s ]", kv["maxmemory_policy"])) 24 | for i, line := range m.Table() { 25 | for j, col := range line { 26 | a.ui.memories.GetCell(i, j).Text = col 27 | } 28 | } 29 | }) 30 | } 31 | 32 | time.Sleep(5 * time.Second) 33 | } 34 | }() 35 | } 36 | -------------------------------------------------------------------------------- /circular/circular.go: -------------------------------------------------------------------------------- 1 | package circular 2 | 3 | type Circular struct { 4 | points []int 5 | scale float64 6 | poz int 7 | } 8 | 9 | func NewCircular(size int, scale float64) *Circular { 10 | return &Circular{ 11 | points: make([]int, size), 12 | scale: scale, 13 | poz: 0, 14 | } 15 | } 16 | 17 | // Add value to the current one 18 | func (c *Circular) Add(value int) { 19 | c.points[c.poz] += value 20 | } 21 | 22 | // Next move current value to the next slot 23 | func (c *Circular) Next() { 24 | c.poz++ 25 | if c.poz >= len(c.points) { 26 | c.poz = 0 27 | } 28 | c.points[c.poz] = 0 29 | } 30 | 31 | // Values return values, scaled, with right padding 32 | func (c *Circular) Values() []float64 { 33 | v := make([]float64, len(c.points)) 34 | l := len(c.points) 35 | for i := 0; i < len(c.points); i++ { 36 | j := l - c.poz + i - 1 37 | if j >= l { 38 | j -= l 39 | } 40 | if j < 0 { 41 | j += l 42 | } 43 | v[j] = float64(c.points[i]) / c.scale 44 | j++ 45 | } 46 | return v 47 | } 48 | 49 | func (c *Circular) LastValues(size int) []float64 { 50 | if size >= len(c.points) { 51 | return c.Values() 52 | } 53 | return c.Values()[len(c.points)-size:] 54 | } 55 | -------------------------------------------------------------------------------- /monitor/redis.go: -------------------------------------------------------------------------------- 1 | package monitor 2 | 3 | import ( 4 | "time" 5 | 6 | "github.com/mediocregopher/radix/v3" 7 | ) 8 | 9 | type RedisServer struct { 10 | address string 11 | password string 12 | pool *radix.Pool 13 | } 14 | 15 | func Redis(address, password string) (*RedisServer, error) { 16 | r := &RedisServer{ 17 | address: address, 18 | password: password, 19 | } 20 | var err error 21 | r.pool, err = r.makePool() 22 | if err != nil { 23 | return nil, err 24 | } 25 | return r, nil 26 | } 27 | 28 | func (r *RedisServer) makePool() (*radix.Pool, error) { 29 | opts := []radix.DialOpt{ 30 | radix.DialConnectTimeout(2 * time.Second), 31 | } 32 | if r.password != "" { 33 | opts = append(opts, radix.DialAuthPass(r.password)) 34 | } 35 | p, err := radix.NewPool("tcp", r.address, 1, radix.PoolConnFunc(func(network, addr string) (radix.Conn, error) { 36 | conn, err := radix.Dial("tcp", r.address, opts...) 37 | if err != nil { 38 | return nil, err 39 | } 40 | var pong string 41 | err = conn.Do(radix.Cmd(&pong, "PING")) 42 | if err != nil { 43 | return nil, err 44 | } 45 | return conn, nil 46 | })) 47 | if err != nil { 48 | return nil, err 49 | } 50 | return p, nil 51 | } 52 | -------------------------------------------------------------------------------- /stats/stats.go: -------------------------------------------------------------------------------- 1 | package stats 2 | 3 | import ( 4 | "sort" 5 | 6 | "github.com/factorysh/redistop/monitor" 7 | ) 8 | 9 | type Stats struct { 10 | Commands map[string]int 11 | Ips map[string]int 12 | } 13 | 14 | type KV struct { 15 | K string 16 | V int 17 | } 18 | 19 | type ByValue []KV 20 | 21 | func (a ByValue) Len() int { return len(a) } 22 | func (a ByValue) Swap(i, j int) { a[i], a[j] = a[j], a[i] } 23 | func (a ByValue) Less(i, j int) bool { 24 | if a[i].V == a[j].V { 25 | return a[i].K < a[j].K 26 | } 27 | return a[i].V < a[j].V 28 | } 29 | 30 | func Count(data map[string]int) ByValue { 31 | r := make(ByValue, len(data)) 32 | i := 0 33 | for k, v := range data { 34 | r[i] = KV{k, v} 35 | i++ 36 | } 37 | sort.Sort(r) 38 | return r 39 | } 40 | 41 | func New() *Stats { 42 | return &Stats{ 43 | Commands: make(map[string]int), 44 | Ips: make(map[string]int), 45 | } 46 | } 47 | 48 | func (s *Stats) Feed(line monitor.Line) { 49 | _, ok := s.Commands[line.Command] 50 | if ok { 51 | s.Commands[line.Command] += 1 52 | } else { 53 | s.Commands[line.Command] = 1 54 | } 55 | _, ok = s.Ips[line.IP] 56 | if ok { 57 | s.Ips[line.IP] += 1 58 | } else { 59 | s.Ips[line.IP] = 1 60 | } 61 | } 62 | 63 | func (s *Stats) Reset() { 64 | s.Commands = make(map[string]int) 65 | s.Ips = make(map[string]int) 66 | } 67 | -------------------------------------------------------------------------------- /cli/app.go: -------------------------------------------------------------------------------- 1 | package cli 2 | 3 | import ( 4 | "fmt" 5 | "time" 6 | 7 | "github.com/factorysh/redistop/monitor" 8 | 9 | _log "log" 10 | ) 11 | 12 | type AppConfig struct { 13 | Host string 14 | Password string 15 | Frequency time.Duration // Stats per commands and per IPs, every freq seconds 16 | } 17 | 18 | type App struct { 19 | config *AppConfig 20 | redis *monitor.RedisServer 21 | log *Logger 22 | ui *AppUI 23 | } 24 | 25 | func NewApp(cfg *AppConfig) *App { 26 | if cfg.Frequency == 0 { 27 | cfg.Frequency = 2 * time.Second 28 | } 29 | return &App{ 30 | config: cfg, 31 | } 32 | } 33 | 34 | func (a *App) Serve() error { 35 | _log.Printf("Connecting to redis://%s\n", a.config.Host) 36 | var err error 37 | a.redis, err = monitor.Redis(a.config.Host, a.config.Password) 38 | if err != nil { 39 | return err 40 | } 41 | 42 | a.ui = NewAppUI() 43 | 44 | infos, err := a.redis.Info() 45 | if err != nil { 46 | return err 47 | } 48 | 49 | a.ui.header.SetTitle( 50 | fmt.Sprintf("Redis Top -[ v%s/%s pid: %s port: %s hz: %s uptime: %sd ]", 51 | infos["redis_version"], 52 | infos["multiplexing_api"], 53 | infos["process_id"], 54 | infos["tcp_port"], 55 | infos["hz"], 56 | infos["uptime_in_days"], 57 | )) 58 | 59 | a.log = &Logger{ 60 | block: a.ui.errorPanel, 61 | } 62 | 63 | a.MonitorLoop() 64 | a.InfoLoop() 65 | a.MemoryLoop() 66 | 67 | return a.ui.app.Run() 68 | } 69 | -------------------------------------------------------------------------------- /main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "flag" 5 | "fmt" 6 | "log" 7 | "os" 8 | "runtime/pprof" 9 | "time" 10 | 11 | "github.com/factorysh/redistop/cli" 12 | "github.com/factorysh/redistop/version" 13 | ) 14 | 15 | func main() { 16 | fFlag := flag.Duration("f", 2*time.Second, "Frequency") 17 | hFlag := flag.Bool("h", false, "Help") 18 | vFlag := flag.Bool("V", false, "Version") 19 | cpuprofile := flag.String("cpuprofile", "", "write cpu profile to file") 20 | 21 | flag.Parse() 22 | 23 | if *cpuprofile != "" { 24 | f, err := os.Create(*cpuprofile) 25 | if err != nil { 26 | log.Fatal(err) 27 | } 28 | pprof.StartCPUProfile(f) 29 | defer pprof.StopCPUProfile() 30 | } 31 | 32 | if *hFlag { 33 | fmt.Printf(`RedisTop %s 34 | top for Redis, group by command and client IP 35 | 36 | Usage: 37 | redistop [[localhost:6379] password] 38 | Options: 39 | -f 2s : Refresh frequency 40 | -h : Help 41 | -V : Version 42 | 43 | You can set REDISTOP_PASSWORD 44 | `, version.Version()) 45 | return 46 | } 47 | if *vFlag { 48 | fmt.Println(version.Version()) 49 | return 50 | } 51 | 52 | host := "localhost:6379" 53 | args := flag.Args() 54 | if len(args) > 1 { 55 | host = args[1] 56 | } 57 | var password string 58 | if len(args) > 2 { 59 | password = args[2] 60 | } 61 | p := os.Getenv("REDISTOP_PASSWORD") 62 | if p != "" { 63 | password = p 64 | } 65 | 66 | app := cli.NewApp(&cli.AppConfig{ 67 | Host: host, 68 | Password: password, 69 | Frequency: *fFlag, 70 | }) 71 | 72 | err := app.Serve() 73 | if err != nil { 74 | log.Fatal(err) 75 | } else { 76 | log.Println("Bye") 77 | } 78 | 79 | } 80 | -------------------------------------------------------------------------------- /monitor/memory.go: -------------------------------------------------------------------------------- 1 | package monitor 2 | 3 | import ( 4 | "fmt" 5 | "strconv" 6 | 7 | "github.com/mediocregopher/radix/v3" 8 | ) 9 | 10 | type MemoryStats struct { 11 | PeakAllocated int64 12 | DatasetBytes int64 13 | KeysCount int64 14 | Fragmentation float64 15 | ReplicationBacklog int64 16 | } 17 | 18 | func (r *RedisServer) Memory() (*MemoryStats, error) { 19 | m := &MemoryStats{} 20 | var mem map[string]interface{} 21 | err := r.pool.Do(radix.Cmd(&mem, "MEMORY", "STATS")) 22 | if err != nil { 23 | return nil, err 24 | } 25 | for k, v := range mem { 26 | //fmt.Printf("%s => %v\n", k, v) 27 | switch k { 28 | case "peak.allocated": 29 | vv, ok := v.(int64) 30 | if !ok { 31 | return nil, fmt.Errorf("not an int : %v", v) 32 | } 33 | m.PeakAllocated = vv 34 | case "dataset.bytes": 35 | vv, ok := v.(int64) 36 | if !ok { 37 | return nil, fmt.Errorf("not an int : %v", v) 38 | } 39 | m.DatasetBytes = vv 40 | case "keys.count": 41 | vv, ok := v.(int64) 42 | if !ok { 43 | return nil, fmt.Errorf("not an int : %v", v) 44 | } 45 | m.KeysCount = vv 46 | case "fragmentation": 47 | vv, ok := v.([]byte) 48 | if !ok { 49 | return nil, fmt.Errorf("not a string : %v", v) 50 | } 51 | vvv, err := strconv.ParseFloat(string(vv), 64) 52 | if err != nil { 53 | return nil, err 54 | } 55 | m.Fragmentation = vvv 56 | case "replication.backlog": 57 | vv, ok := v.(int64) 58 | if !ok { 59 | return nil, fmt.Errorf("not an int : %v", v) 60 | } 61 | m.ReplicationBacklog = vv 62 | } 63 | } 64 | return m, err 65 | } 66 | 67 | func (m *MemoryStats) Table() [][]string { 68 | return [][]string{ 69 | {"peak allocated", fmt.Sprintf("%d", m.PeakAllocated)}, 70 | {"dataset", fmt.Sprintf("%d bytes", m.DatasetBytes)}, 71 | {"fragmentation", fmt.Sprintf("%.2f", m.Fragmentation)}, 72 | {"repl.backlog", fmt.Sprintf("%d", m.ReplicationBacklog)}, 73 | } 74 | } 75 | -------------------------------------------------------------------------------- /monitor/monitor.go: -------------------------------------------------------------------------------- 1 | package monitor 2 | 3 | import ( 4 | "bufio" 5 | "context" 6 | "fmt" 7 | "net" 8 | "regexp" 9 | "strconv" 10 | "strings" 11 | "time" 12 | ) 13 | 14 | type Line struct { 15 | ts float32 16 | n int 17 | IP string 18 | port int 19 | Command string 20 | } 21 | 22 | func (r *RedisServer) Monitor(ctx context.Context, evt func(bool)) (chan Line, chan error) { 23 | // IPv4 +1619454979.381488 [1 172.29.1.2:57676] "brpop" 24 | // IPv6 +1621757323.274428 [9 [::1]:38824] "DEL" "f00dc225-1975-4590-8a37-9b0ea4ec5acc" 25 | // LUA +1621757323.279920 [9 lua] "DEL" "f00dc225-1975-4590-8a37-9b0ea4ec5acc" 26 | 27 | line := regexp.MustCompile(`^\+(\d+\.\d+) \[(\d+) ([\d\.]+|\[[0-9a-f\:]+\]|lua):?(\d+)?\] "(.*?)"`) 28 | 29 | lines := make(chan Line) 30 | errors := make(chan error) 31 | 32 | go func() { 33 | for { 34 | conn, err := net.Dial("tcp", r.address) 35 | if err != nil { 36 | errors <- err 37 | evt(false) 38 | time.Sleep(5 * time.Second) 39 | continue 40 | } 41 | reader := bufio.NewReader(conn) 42 | if r.password != "" { 43 | fmt.Fprintf(conn, "AUTH %s\n", r.password) 44 | resp, err := reader.ReadString('\n') 45 | if err != nil { 46 | errors <- err 47 | evt(false) 48 | continue 49 | } 50 | if !strings.HasPrefix(resp, "+OK") { 51 | errors <- fmt.Errorf("auth failed, bad password") 52 | evt(false) 53 | continue 54 | } 55 | } 56 | _, err = fmt.Fprintln(conn, "MONITOR") 57 | if err != nil { 58 | errors <- err 59 | evt(false) 60 | continue 61 | } 62 | for { 63 | resp, err := reader.ReadString('\n') 64 | if err != nil { 65 | errors <- fmt.Errorf("monitor can't read %v", err) 66 | break 67 | } 68 | l := line.FindStringSubmatch(resp) 69 | if len(l) != 6 { 70 | continue 71 | } 72 | ts, err := strconv.ParseFloat(l[1], 32) 73 | if err != nil { 74 | errors <- fmt.Errorf("monitor %v %v", l, err) 75 | break 76 | } 77 | n, err := strconv.Atoi(l[2]) 78 | if err != nil { 79 | errors <- fmt.Errorf("monitor %v %v", l, err) 80 | break 81 | } 82 | port, err := strconv.Atoi("0"+l[4]) 83 | if err != nil { 84 | errors <- fmt.Errorf("monitor %v %v", l, err) 85 | break 86 | } 87 | evt(true) 88 | lines <- Line{ 89 | ts: float32(ts), 90 | n: n, 91 | IP: l[3], 92 | port: port, 93 | Command: strings.ToUpper(l[5]), 94 | } 95 | } 96 | evt(false) 97 | } 98 | }() 99 | 100 | return lines, errors 101 | } 102 | -------------------------------------------------------------------------------- /cli/monitor.go: -------------------------------------------------------------------------------- 1 | package cli 2 | 3 | import ( 4 | "context" 5 | "fmt" 6 | "sync" 7 | "time" 8 | 9 | "github.com/factorysh/redistop/circular" 10 | "github.com/factorysh/redistop/stats" 11 | "github.com/gdamore/tcell/v2" 12 | "github.com/rivo/tview" 13 | ) 14 | 15 | func (a *App) MonitorLoop() { 16 | 17 | statz := stats.New() 18 | lock := sync.Mutex{} 19 | 20 | lines, monitorErrors := a.redis.Monitor(context.TODO(), func(ok bool) { 21 | if !ok { 22 | a.ui.Alert("Not connected") 23 | } 24 | }) 25 | 26 | go func() { 27 | for { 28 | err := <-monitorErrors 29 | a.ui.Alert(fmt.Sprintf("%v", err)) 30 | } 31 | }() 32 | 33 | go func() { 34 | for line := range lines { 35 | lock.Lock() 36 | statz.Feed(line) 37 | lock.Unlock() 38 | } 39 | }() 40 | 41 | go func() { 42 | scale := float64(a.config.Frequency) / float64(time.Second) 43 | values := circular.NewCircular(250, scale) 44 | for { 45 | time.Sleep(a.config.Frequency) 46 | a.ui.monitorIsReady = true 47 | 48 | a.ui.grid.RemoveItem(a.ui.splash) 49 | a.ui.grid.AddItem(a.ui.cmds, 2, 0, 1, 1, 0, 0, false). 50 | AddItem(a.ui.ips, 2, 1, 1, 1, 0, 0, false) 51 | 52 | lock.Lock() 53 | s := stats.Count(statz.Commands) 54 | ip := stats.Count(statz.Ips) 55 | statz.Reset() 56 | lock.Unlock() 57 | for _, i := range s { 58 | values.Add(i.V) 59 | } 60 | _, _, w, _ := a.ui.graph.GetInnerRect() 61 | vv := values.LastValues(w - 7) 62 | var m float64 = 0 63 | for _, v := range vv { 64 | if v > m { 65 | m = v 66 | } 67 | } 68 | values.Next() 69 | a.ui.app.QueueUpdateDraw(func() { 70 | a.ui.graph.SetSeries(vv) 71 | a.ui.graph.SetTitle(fmt.Sprintf("Commands [current: %.1f max: %.1f]", 72 | vv[len(vv)-1], 73 | m, 74 | )) 75 | a.ui.cmds.Clear() 76 | size := len(s) 77 | _, _, w, _ := a.ui.cmds.GetInnerRect() 78 | if size > 0 { 79 | for i, kv := range s { 80 | a.ui.cmds.SetCell(size-i-1, 0, 81 | tview.NewTableCell(fmt.Sprintf("%-*s", w/2, kv.K)).SetAttributes(tcell.AttrBold)) 82 | a.ui.cmds.SetCell(size-i-1, 1, 83 | tview.NewTableCell(fmt.Sprintf("%.1f", float64(kv.V)/scale)). 84 | SetAlign(tview.AlignRight)) 85 | } 86 | } 87 | 88 | a.ui.ips.Clear() 89 | size = len(ip) 90 | _, _, w, _ = a.ui.ips.GetInnerRect() 91 | if size > 0 { 92 | for i, kv := range ip { 93 | a.ui.ips.SetCell(size-i-1, 0, 94 | tview.NewTableCell(fmt.Sprintf("%-*s", w/2, kv.K)).SetAttributes(tcell.AttrItalic)) 95 | a.ui.ips.SetCellSimple(size-i-1, 1, fmt.Sprintf("%.1f", float64(kv.V)/scale)) 96 | } 97 | } 98 | }) 99 | 100 | } 101 | }() 102 | 103 | } 104 | -------------------------------------------------------------------------------- /cli/info.go: -------------------------------------------------------------------------------- 1 | package cli 2 | 3 | import ( 4 | "fmt" 5 | "strconv" 6 | "time" 7 | 8 | "github.com/factorysh/redistop/monitor" 9 | ) 10 | 11 | func (a *App) InfoLoop() { 12 | 13 | go func() { 14 | var cpu *monitor.CPU 15 | for { 16 | kv, err := a.redis.Info() 17 | if err != nil { 18 | a.log.Printf("Info Error : %s", err.Error()) 19 | } else { 20 | a.ui.app.QueueUpdate(func() { 21 | if kv["instantaneous_ops_per_sec"] == "" { 22 | a.ui.header.GetCell(0, 1).Text = "️0 op" 23 | } else { 24 | ops, err := strconv.ParseFloat(kv["instantaneous_ops_per_sec"], 32) 25 | if err != nil { 26 | a.log.Printf("Float parse error: %s %s", kv["instantaneous_ops_per_sec"], err) 27 | a.ui.header.GetCell(0, 1).Text = "☠️" 28 | } else { 29 | a.ui.header.GetCell(0, 1).Text = fmt.Sprintf("%s ops/s", DisplayUnit(ops)) 30 | } 31 | } 32 | iips, err := strconv.ParseFloat(kv["instantaneous_input_kbps"], 32) 33 | if err != nil { 34 | a.log.Printf("Float parse error: %s %s", kv["instantaneous_input_kbps"], err) 35 | a.ui.header.GetCell(0, 2).Text = "☠️" 36 | } else { 37 | a.ui.header.GetCell(0, 2).Text = fmt.Sprintf("in: %sb/s", DisplayUnit(iips)) 38 | } 39 | iops, err := strconv.ParseFloat(kv["instantaneous_output_kbps"], 32) 40 | if err != nil { 41 | a.log.Printf("Float parse error: %s %s", kv["instantaneous_output_kbps"], err) 42 | a.ui.header.GetCell(0, 3).Text = "☠️" 43 | } else { 44 | a.ui.header.GetCell(0, 3).Text = fmt.Sprintf("out: %sb/s", DisplayUnit(iops)) 45 | } 46 | }) 47 | 48 | sys, err := strconv.ParseFloat(kv["used_cpu_sys"], 64) 49 | if err != nil { 50 | a.log.Printf("%s %s", kv["used_cpu_sys"], err.Error()) 51 | } else { 52 | user, err := strconv.ParseFloat(kv["used_cpu_user"], 64) 53 | if err != nil { 54 | a.log.Printf("%s %s", kv["used_cpu_sys"], err.Error()) 55 | } else { 56 | if cpu == nil { 57 | cpu = monitor.NewCPU(sys, user) 58 | } else { 59 | s, u := cpu.Tick(sys, user) 60 | a.ui.app.QueueUpdateDraw(func() { 61 | a.ui.header.GetCell(0, 0).Text = fmt.Sprintf("s: %.1f%% u: %.1f%%", s, u) 62 | }) 63 | } 64 | } 65 | } 66 | 67 | a.ui.keyspaces.GetCell(0, 0).Text = small("hits", kv["keyspace_hits"]) 68 | a.ui.keyspaces.GetCell(0, 1).Text = small("misses", kv["keyspace_misses"]) 69 | 70 | a.ui.pubsub.GetCell(0, 0).Text = small("channels", kv["pubsub_channels"]) 71 | a.ui.pubsub.GetCell(0, 1).Text = small("patterns", kv["pubsub_patterns"]) 72 | 73 | a.ui.clients.GetCell(0, 0).Text = small("connected", kv["connected_clients"]) 74 | a.ui.clients.GetCell(0, 1).Text = small("blocked", kv["blocked_clients"]) 75 | a.ui.clients.GetCell(1, 0).Text = small("tracking", kv["tracking_clients"]) 76 | 77 | a.ui.persistence.GetCell(0, 0).Text = "status" 78 | if kv["loading"] == "1" { 79 | a.ui.persistence.GetCell(0, 1).Text = "loading" 80 | } else { 81 | if kv["rdb_bgsave_in_progress"] == "1" { 82 | a.ui.persistence.GetCell(0, 1).Text = "rdb_bgsave_in_progress" 83 | } else { 84 | if kv["aof_rewrite_in_progress"] == "1" { 85 | a.ui.persistence.GetCell(0, 1).Text = "aof_rewrite_in_progress" 86 | } 87 | } 88 | } 89 | a.ui.persistence.GetCell(1, 0).Text = "rdb_changes_since_last_save" 90 | a.ui.persistence.GetCell(1, 1).Text = kv["rdb_changes_since_last_save"] 91 | a.ui.persistence.GetCell(2, 0).Text = "rdb_last_save_time" 92 | a.ui.persistence.GetCell(2, 1).Text = kv["rdb_last_save_time"] 93 | 94 | } 95 | time.Sleep(time.Second) 96 | } 97 | }() 98 | 99 | } 100 | 101 | func small(left, right string) string { 102 | return fmt.Sprintf("%s%*s", left, 18-len(left), right) 103 | } 104 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 2 | github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= 3 | github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 4 | github.com/gdamore/encoding v1.0.0 h1:+7OoQ1Bc6eTm5niUzBa0Ctsh6JbMW6Ra+YNuAtDBdko= 5 | github.com/gdamore/encoding v1.0.0/go.mod h1:alR0ol34c49FCSBLjhosxzcPHQbf2trDkoo5dl+VrEg= 6 | github.com/gdamore/tcell/v2 v2.4.1-0.20210905002822-f057f0a857a1 h1:QqwPZCwh/k1uYqq6uXSb9TRDhTkfQbO80v8zhnIe5zM= 7 | github.com/gdamore/tcell/v2 v2.4.1-0.20210905002822-f057f0a857a1/go.mod h1:Az6Jt+M5idSED2YPGtwnfJV0kXohgdCBPmHGSYc1r04= 8 | github.com/guptarohit/asciigraph v0.5.3 h1:jtVQFC7KX6cQowPntN6rtXmI9O+FuXNeVa3fzf8t120= 9 | github.com/guptarohit/asciigraph v0.5.3/go.mod h1:dYl5wwK4gNsnFf9Zp+l06rFiDZ5YtXM6x7SRWZ3KGag= 10 | github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY= 11 | github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0= 12 | github.com/mattn/go-runewidth v0.0.13 h1:lTGmDsbAYt5DmK6OnoV7EuIF1wEIFAcxld6ypU4OSgU= 13 | github.com/mattn/go-runewidth v0.0.13/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w= 14 | github.com/mediocregopher/radix/v3 v3.8.0 h1:HI8EgkaM7WzsrFpYAkOXIgUKbjNonb2Ne7K6Le61Pmg= 15 | github.com/mediocregopher/radix/v3 v3.8.0/go.mod h1:8FL3F6UQRXHXIBSPUs5h0RybMF8i4n7wVopoX3x7Bv8= 16 | github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= 17 | github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= 18 | github.com/rivo/tview v0.0.0-20220307222120-9994674d60a8 h1:xe+mmCnDN82KhC010l3NfYlA8ZbOuzbXAzSYBa6wbMc= 19 | github.com/rivo/tview v0.0.0-20220307222120-9994674d60a8/go.mod h1:WIfMkQNY+oq/mWwtsjOYHIZBuwthioY2srOmljJkTnk= 20 | github.com/rivo/uniseg v0.2.0 h1:S1pD9weZBuJdFmowNwbpi7BJ8TNftyUImj/0WQi72jY= 21 | github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= 22 | github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= 23 | github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= 24 | github.com/stretchr/testify v1.7.1 h1:5TQK59W5E3v0r2duFAb7P95B6hEeOyEnHRa8MjYSMTY= 25 | github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= 26 | golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= 27 | golang.org/x/sys v0.0.0-20210309074719-68d13333faf2 h1:46ULzRKLh1CwgRq2dC5SlBzEqqNCi8rreOZnNrbqcIY= 28 | golang.org/x/sys v0.0.0-20210309074719-68d13333faf2/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= 29 | golang.org/x/term v0.0.0-20201210144234-2321bbc49cbf/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= 30 | golang.org/x/term v0.0.0-20210220032956-6a3ed077a48d h1:SZxvLBoTP5yHO3Frd4z4vrF+DBX9vMVanchswa69toE= 31 | golang.org/x/term v0.0.0-20210220032956-6a3ed077a48d/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= 32 | golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= 33 | golang.org/x/text v0.3.6 h1:aRYxNxv6iGQlyVaZmk6ZgYEDa+Jg18DxebPSrd6bg1M= 34 | golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= 35 | golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= 36 | golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898 h1:/atklqdjdhuosWIl6AIbOeHJjicWYPqR9bpxqxYG2pA= 37 | golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= 38 | gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= 39 | gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= 40 | gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo= 41 | gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= 42 | -------------------------------------------------------------------------------- /cli/ui.go: -------------------------------------------------------------------------------- 1 | package cli 2 | 3 | import ( 4 | "strings" 5 | "sync" 6 | 7 | "github.com/gdamore/tcell/v2" 8 | "github.com/guptarohit/asciigraph" 9 | 10 | "github.com/rivo/tview" 11 | ) 12 | 13 | type AppUI struct { 14 | app *tview.Application 15 | grid *tview.Grid 16 | header *tview.Table 17 | graph *GraphBox 18 | splash *tview.Box 19 | cmds *tview.Table 20 | ips *tview.Table 21 | memories *tview.Table 22 | pile *tview.Flex 23 | keyspaces *tview.Table 24 | clients *tview.Table 25 | persistence *tview.Table 26 | pubsub *tview.Table 27 | errorPanel *tview.TextView 28 | monitorIsReady bool 29 | } 30 | 31 | type GraphBox struct { 32 | *tview.Box 33 | lock *sync.Mutex 34 | series []float64 35 | } 36 | 37 | func NewGraphBox() *GraphBox { 38 | g := &GraphBox{ 39 | Box: tview.NewBox(), 40 | series: make([]float64, 0), 41 | lock: &sync.Mutex{}, 42 | } 43 | g.SetBorder(true) 44 | return g 45 | } 46 | 47 | func (g *GraphBox) SetSeries(series []float64) { 48 | g.series = series 49 | } 50 | 51 | func (g *GraphBox) Draw(screen tcell.Screen) { 52 | g.lock.Lock() 53 | defer g.lock.Unlock() 54 | g.DrawForSubclass(screen, g) 55 | if len(g.series) > 0 { 56 | x, y, width, height := g.GetInnerRect() 57 | p := asciigraph.Plot(g.series, asciigraph.Height(height-1)) 58 | for i, line := range strings.Split(p, "\n") { 59 | fullLine := make([]rune, width) 60 | for j := 0; j < width; j++ { 61 | fullLine[j] = ' ' 62 | } 63 | copy(fullLine, []rune(line)) 64 | screen.SetContent(x, y+i, fullLine[0], fullLine[1:], tcell.StyleDefault) 65 | } 66 | } 67 | } 68 | 69 | func (g *GraphBox) GetInnerRect() (int, int, int, int) { 70 | x, y, width, height := g.GetRect() 71 | return x + 1, y + 1, width - 2, height - 2 72 | } 73 | 74 | const art = ` 75 | _._ 76 | _.-''__ ''-._ 77 | _.-'' '. '_. ''-._ 78 | .-'' .-'''. '''\/ _.,_ ''-._ 79 | ( ' , .-' | ', ) 80 | |'-._'-...-' __...-.''-._|'' _.-'| 81 | | '-._ '._ / _.-' | 82 | '-._ '-._ '-./ _.-' _.-' 83 | |'-._'-._ '-.__.-' _.-'_.-'| 84 | | '-._'-._ _.-'_.-' | 85 | '-._ '-._'-.__.-'_.-' _.-' 86 | |'-._'-._ '-.__.-' _.-'_.-'| 87 | | '-._'-._ _.-'_.-' | 88 | '-._ '-._'-.__.-'_.-' _.-' 89 | '-._ '-.__.-' _.-' 90 | '-._ _.-' 91 | '-.__.-' 92 | ` 93 | 94 | func NewAppUI() *AppUI { 95 | appUI := &AppUI{ 96 | app: tview.NewApplication(), 97 | monitorIsReady: false, 98 | } 99 | appUI.fundation() 100 | return appUI 101 | } 102 | 103 | func (a *AppUI) fundation() { 104 | a.header = tview.NewTable().SetFixed(1, 4) 105 | a.header.SetBorder(true) 106 | a.header.SetTitle("Redistop") 107 | for i := 0; i < 4; i++ { 108 | a.header.SetCell(0, i, tview.NewTableCell("*")) 109 | } 110 | a.graph = NewGraphBox() 111 | a.graph.SetBorder(true).SetMouseCapture( 112 | func(action tview.MouseAction, event *tcell.EventMouse) (tview.MouseAction, *tcell.EventMouse) { 113 | if action == tview.MouseLeftDoubleClick { 114 | _, _, _, h := a.graph.GetInnerRect() 115 | if h <= 5 { 116 | a.grid.SetRows(3, 12, 0, 1) 117 | } else { 118 | if h <= 12 { 119 | a.grid.SetRows(3, 17, 0, 1) 120 | } else { 121 | a.grid.SetRows(3, 7, 0, 1) 122 | } 123 | } 124 | } 125 | return action, event 126 | }) 127 | 128 | a.splash = tview.NewBox() 129 | a.splash.SetDrawFunc(func(screen tcell.Screen, x int, y int, width int, height int) (int, int, int, int) { 130 | xs := (width - 34) / 2 131 | ys := (height - 16) / 2 132 | for i, line := range strings.Split(art, "\n") { 133 | for j, l := range line { 134 | screen.SetCell(x+xs+j, y+ys+i, tcell.StyleDefault, l) 135 | } 136 | } 137 | return a.splash.GetInnerRect() 138 | }) 139 | 140 | a.cmds = tview.NewTable() 141 | a.cmds.SetBorder(true) 142 | a.cmds.SetSeparator(tcell.RuneVLine) 143 | a.cmds.SetTitle("By command/s") 144 | 145 | a.ips = tview.NewTable() 146 | a.ips.SetBorder(true) 147 | a.ips.SetSeparator(tcell.RuneVLine) 148 | a.ips.SetTitle("By IP/s") 149 | 150 | a.errorPanel = tview.NewTextView().SetTextColor(tcell.GetColor("red")).SetMaxLines(1) 151 | 152 | a.pile = tview.NewFlex() 153 | a.pile.SetDirection(tview.FlexRow) 154 | 155 | a.grid = tview.NewGrid().SetRows(3, 7, 0, 1).SetColumns(0, 0, 40). 156 | AddItem(a.header, 0, 0, 1, 3, 0, 0, false). 157 | AddItem(a.graph, 1, 0, 1, 3, 0, 0, false). 158 | AddItem(a.splash, 2, 0, 1, 2, 0, 0, false). 159 | AddItem(a.pile, 2, 2, 1, 1, 0, 0, false). 160 | AddItem(a.errorPanel, 3, 0, 1, 3, 0, 0, false) 161 | 162 | a.app.SetRoot(a.grid, true).SetFocus(a.grid).EnableMouse(true) 163 | 164 | a.keyspaces = tview.NewTable() 165 | a.keyspaces.SetBorder(true) 166 | a.keyspaces.SetTitle("Keyspace") 167 | a.keyspaces.SetCellSimple(0, 0, "") 168 | a.keyspaces.SetCellSimple(0, 1, "") 169 | a.pile.AddItem(a.keyspaces, 3, 1, false) 170 | 171 | a.pubsub = tview.NewTable() 172 | a.pubsub.SetBorder(true) 173 | a.pubsub.SetTitle("Pubsub") 174 | a.pubsub.SetCellSimple(0, 0, "") 175 | a.pubsub.SetCellSimple(0, 1, "") 176 | a.pile.AddItem(a.pubsub, 3, 1, false) 177 | 178 | a.memories = tview.NewTable() 179 | a.memories.SetBorder(true) 180 | a.memories.SetTitle("Memory") 181 | for i := 0; i < 4; i++ { 182 | a.memories.SetCellSimple(i, 0, "") 183 | a.memories.SetCellSimple(i, 1, "") 184 | } 185 | a.pile.AddItem(a.memories, 6, 1, false) 186 | 187 | a.clients = tview.NewTable() 188 | a.clients.SetBorder(true) 189 | a.clients.SetTitle("Clients") 190 | for i := 0; i < 2; i++ { 191 | a.clients.SetCellSimple(i, 0, "") 192 | a.clients.SetCellSimple(i, 1, "") 193 | } 194 | a.pile.AddItem(a.clients, 4, 1, false) 195 | 196 | a.persistence = tview.NewTable() 197 | a.persistence.SetBorder(true) 198 | a.persistence.SetTitle("Persistance") 199 | for i := 0; i < 3; i++ { 200 | a.persistence.SetCellSimple(i, 0, "") 201 | a.persistence.SetCellSimple(i, 1, "") 202 | } 203 | a.pile.AddItem(a.persistence, 5, 1, false) 204 | 205 | } 206 | 207 | func (a *AppUI) Alert(msg string) { 208 | a.app.QueueUpdateDraw(func() { 209 | a.errorPanel.SetText(msg) 210 | }) 211 | } 212 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 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 General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------