├── .gitignore
├── entry.sh
├── .dockerignore
├── hlswatch.conf
├── nginx.conf
├── Makefile
├── state
├── viewer.go
├── stream.go
└── state.go
├── util
└── fs.go
├── version.go
├── handler
├── handler.go
├── stats.go
└── hls.go
├── Dockerfile
├── streamwatcher.go
├── config
├── conf.go
└── env.go
├── README.md
├── influx.go
├── main.go
└── LICENSE.txt
/.gitignore:
--------------------------------------------------------------------------------
1 | .idea/
2 | .build/
3 | misc/
4 | rootfs/usr/sbin/hlswatch
5 | .directory
6 |
--------------------------------------------------------------------------------
/entry.sh:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | /usr/sbin/hlswatch &
4 | /usr/sbin/nginx -g "daemon off;"
5 |
--------------------------------------------------------------------------------
/.dockerignore:
--------------------------------------------------------------------------------
1 | .build/
2 | .git/
3 | LICENSE.txt
4 | README.txt
5 | Makefile
6 | Dockerfile
7 |
--------------------------------------------------------------------------------
/hlswatch.conf:
--------------------------------------------------------------------------------
1 | [common]
2 | listen = ":3000"
3 | hls_path = "/tmp/hls"
4 | viewer_timeout = 15
5 |
6 |
--------------------------------------------------------------------------------
/nginx.conf:
--------------------------------------------------------------------------------
1 | worker_processes 4;
2 |
3 | events {
4 | worker_connections 1024;
5 | }
6 |
7 | rtmp_auto_push on;
8 | rtmp_auto_push_reconnect 1s;
9 | rtmp_socket_dir /tmp/;
10 |
11 | rtmp {
12 | server {
13 | listen 1935;
14 | chunk_size 4000;
15 |
16 | application live {
17 | live on;
18 |
19 | hls on;
20 | hls_fragment_naming system;
21 | hls_fragment 5s;
22 | hls_path /tmp/hls;
23 | hls_nested on;
24 | hls_cleanup on;
25 | }
26 | }
27 | }
28 |
29 | http {
30 | server {
31 | listen 80;
32 |
33 | location / {
34 | proxy_pass http://localhost:3000;
35 | }
36 | }
37 | }
38 |
--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
1 | # some metadata
2 | BUILD_DIR=.build
3 | PWD=$(shell pwd)
4 | BUILD_TIME=$(shell date)
5 | GIT_COMMIT=$(shell git rev-parse --short HEAD)
6 |
7 | # information about the go package to build
8 | GO_PACKAGE=github.com/faryon93/hlswatch
9 | GO_ARTIFACT=rootfs/usr/sbin/hlswatch
10 | GO_LD_FLAGS=-X "main.BUILD_TIME=$(BUILD_TIME)" -X "main.GIT_COMMIT=$(GIT_COMMIT)"
11 | GO_SRC=src
12 |
13 | # information about the docker image
14 | DOCKER_IMAGE=faryon93/nginx-hls:latest
15 |
16 | all: hlswatch
17 | docker build -t $(DOCKER_IMAGE) .
18 |
19 | hlswatch:
20 | # setup go build environment
21 | if [ ! -d $(PWD)/$(BUILD_DIR) ]; then \
22 | mkdir -p $(BUILD_DIR)/src/$(GO_PACKAGE); \
23 | rm -r $(BUILD_DIR)/src/$(GO_PACKAGE); \
24 | mkdir -p $(BUILD_DIR)/pkg; \
25 | ln -s $(PWD)/$(GO_SRC) $(BUILD_DIR)/src/$(GO_PACKAGE); \
26 | fi
27 |
28 | # get the dependencies
29 | GOPATH=$(PWD)/$(BUILD_DIR) go get $(GO_PACKAGE)
30 |
31 | # build a statically linked golang binary
32 | GOPATH=$(PWD)/$(BUILD_DIR) go build \
33 | -tags netgo -a \
34 | -ldflags '$(GO_LD_FLAGS)' \
35 | -o $(GO_ARTIFACT) \
36 | $(GO_PACKAGE)
37 |
38 | clean:
39 | rm -rf $(BUILD_DIR)/
--------------------------------------------------------------------------------
/state/viewer.go:
--------------------------------------------------------------------------------
1 | package state
2 | // hlswatch - keep track of hls viewer stats
3 | // Copyright (C) 2017 Maximilian Pachl
4 |
5 | // This program is free software: you can redistribute it and/or modify
6 | // it under the terms of the GNU General Public License as published by
7 | // the Free Software Foundation, either version 3 of the License, or
8 | // (at your option) any later version.
9 |
10 | // This program is distributed in the hope that it will be useful,
11 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | // GNU General Public License for more details.
14 |
15 | // You should have received a copy of the GNU General Public License
16 | // along with this program. If not, see .
17 |
18 | // --------------------------------------------------------------------------------------
19 | // imports
20 | // --------------------------------------------------------------------------------------
21 |
22 | import (
23 | "time"
24 | )
25 |
26 |
27 | // --------------------------------------------------------------------------------------
28 | // types
29 | // --------------------------------------------------------------------------------------
30 |
31 | type Viewer struct {
32 | FirstSeen time.Time
33 | LastSeen time.Time
34 | Ip string
35 | }
36 |
--------------------------------------------------------------------------------
/util/fs.go:
--------------------------------------------------------------------------------
1 | package util
2 | // hlswatch - keep track of hls viewer stats
3 | // Copyright (C) 2017 Maximilian Pachl
4 |
5 | // This program is free software: you can redistribute it and/or modify
6 | // it under the terms of the GNU General Public License as published by
7 | // the Free Software Foundation, either version 3 of the License, or
8 | // (at your option) any later version.
9 |
10 | // This program is distributed in the hope that it will be useful,
11 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | // GNU General Public License for more details.
14 |
15 | // You should have received a copy of the GNU General Public License
16 | // along with this program. If not, see .
17 |
18 | // --------------------------------------------------------------------------------------
19 | // imports
20 | // --------------------------------------------------------------------------------------
21 |
22 | import (
23 | "os"
24 | )
25 |
26 |
27 | // --------------------------------------------------------------------------------------
28 | // constructors
29 | // --------------------------------------------------------------------------------------
30 |
31 | func IsDir(path string) bool {
32 | finfo, err := os.Stat(path)
33 | if err != nil {
34 | return false
35 | }
36 |
37 | return finfo.IsDir()
38 | }
39 |
--------------------------------------------------------------------------------
/version.go:
--------------------------------------------------------------------------------
1 | package main
2 | // hlswatch - keep track of hls viewer stats
3 | // Copyright (C) 2017 Maximilian Pachl
4 |
5 | // This program is free software: you can redistribute it and/or modify
6 | // it under the terms of the GNU General Public License as published by
7 | // the Free Software Foundation, either version 3 of the License, or
8 | // (at your option) any later version.
9 |
10 | // This program is distributed in the hope that it will be useful,
11 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | // GNU General Public License for more details.
14 |
15 | // You should have received a copy of the GNU General Public License
16 | // along with this program. If not, see .
17 |
18 | // ----------------------------------------------------------------------------
19 | // variables
20 | // ----------------------------------------------------------------------------
21 |
22 | var (
23 | // release information
24 | APP_NAME = "hlswatch"
25 | APP_VERSION = "0.1.1"
26 |
27 | // filled by build tool
28 | GIT_COMMIT string
29 | BUILD_TIME string
30 | BUILD_NUMBER string
31 | )
32 |
33 |
34 | // ----------------------------------------------------------------------------
35 | // public functions
36 | // ----------------------------------------------------------------------------
37 |
38 | func GetAppIdentifier() (string) {
39 | str := APP_NAME + " " + APP_VERSION
40 | if len(BUILD_NUMBER) > 0 {
41 | str += "-" + BUILD_NUMBER
42 | }
43 |
44 | if len(GIT_COMMIT) > 0 {
45 | str += " (#" + GIT_COMMIT + ")"
46 | }
47 |
48 | if len(BUILD_TIME) > 0 {
49 | str += " " + BUILD_TIME
50 | }
51 |
52 | return str
53 | }
54 |
--------------------------------------------------------------------------------
/handler/handler.go:
--------------------------------------------------------------------------------
1 | package handler
2 | // hlswatch - keep track of hls viewer stats
3 | // Copyright (C) 2017 Maximilian Pachl
4 |
5 | // This program is free software: you can redistribute it and/or modify
6 | // it under the terms of the GNU General Public License as published by
7 | // the Free Software Foundation, either version 3 of the License, or
8 | // (at your option) any later version.
9 |
10 | // This program is distributed in the hope that it will be useful,
11 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | // GNU General Public License for more details.
14 |
15 | // You should have received a copy of the GNU General Public License
16 | // along with this program. If not, see .
17 |
18 | // --------------------------------------------------------------------------------------
19 | // imports
20 | // --------------------------------------------------------------------------------------
21 |
22 | import (
23 | "net/http"
24 | "encoding/json"
25 |
26 | "github.com/faryon93/hlswatch/state"
27 | )
28 |
29 |
30 | // --------------------------------------------------------------------------------------
31 | // types
32 | // --------------------------------------------------------------------------------------
33 |
34 | type Handler func(ctx *state.State, w http.ResponseWriter, r *http.Request)
35 |
36 |
37 | // --------------------------------------------------------------------------------------
38 | // public functions
39 | // --------------------------------------------------------------------------------------
40 |
41 | // Writes the JSON representation of v to the supplied http.ResposeWriter.
42 | // If an error occours while marshalling the object the http response
43 | // will be an internal server error.
44 | func Jsonify(w http.ResponseWriter, v interface{}) {
45 | js, err := json.Marshal(v)
46 | if err != nil {
47 | http.Error(w, err.Error(), http.StatusInternalServerError)
48 | return
49 | }
50 |
51 | w.Header().Set("Content-Type", "application/json")
52 | w.Write(js)
53 | }
54 |
--------------------------------------------------------------------------------
/handler/stats.go:
--------------------------------------------------------------------------------
1 | package handler
2 | // hlswatch - keep track of hls viewer stats
3 | // Copyright (C) 2017 Maximilian Pachl
4 |
5 | // This program is free software: you can redistribute it and/or modify
6 | // it under the terms of the GNU General Public License as published by
7 | // the Free Software Foundation, either version 3 of the License, or
8 | // (at your option) any later version.
9 |
10 | // This program is distributed in the hope that it will be useful,
11 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | // GNU General Public License for more details.
14 |
15 | // You should have received a copy of the GNU General Public License
16 | // along with this program. If not, see .
17 |
18 | // --------------------------------------------------------------------------------------
19 | // imports
20 | // --------------------------------------------------------------------------------------
21 |
22 | import (
23 | "net/http"
24 | "time"
25 |
26 | "github.com/faryon93/hlswatch/state"
27 | )
28 |
29 |
30 | // --------------------------------------------------------------------------------------
31 | // type
32 | // --------------------------------------------------------------------------------------
33 |
34 | type streamStats struct {
35 | // number of current viewers
36 | CurrentViewers int `json:"current_viewers"`
37 |
38 | // uptime of stream in seconds
39 | Uptime int `json:"uptime"`
40 | }
41 |
42 |
43 | // --------------------------------------------------------------------------------------
44 | // http handler
45 | // --------------------------------------------------------------------------------------
46 |
47 | func Stats(ctx *state.State, w http.ResponseWriter, r *http.Request) {
48 | timeout := time.Duration(ctx.Conf.Common.ViewerTimeout) * time.Second
49 |
50 | // construct the response
51 | response := make(map[string]streamStats)
52 | ctx.StreamsMutex.Lock()
53 | for streamName, stream := range ctx.Streams {
54 | response[streamName] = streamStats{
55 | CurrentViewers: stream.GetCurrentViewers(timeout),
56 | Uptime: int(stream.GetUptime().Seconds()),
57 | }
58 | }
59 | ctx.StreamsMutex.Unlock()
60 |
61 | Jsonify(w, response)
62 | }
63 |
--------------------------------------------------------------------------------
/state/stream.go:
--------------------------------------------------------------------------------
1 | package state
2 | // hlswatch - keep track of hls viewer stats
3 | // Copyright (C) 2017 Maximilian Pachl
4 |
5 | // This program is free software: you can redistribute it and/or modify
6 | // it under the terms of the GNU General Public License as published by
7 | // the Free Software Foundation, either version 3 of the License, or
8 | // (at your option) any later version.
9 |
10 | // This program is distributed in the hope that it will be useful,
11 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | // GNU General Public License for more details.
14 |
15 | // You should have received a copy of the GNU General Public License
16 | // along with this program. If not, see .
17 |
18 | // --------------------------------------------------------------------------------------
19 | // imports
20 | // --------------------------------------------------------------------------------------
21 |
22 | import (
23 | "time"
24 | "sync"
25 | )
26 |
27 |
28 | // --------------------------------------------------------------------------------------
29 | // types
30 | // --------------------------------------------------------------------------------------
31 |
32 | type Stream struct {
33 | sync.Mutex
34 | Viewers map[string]*Viewer
35 | StartTime time.Time
36 | }
37 |
38 |
39 | // --------------------------------------------------------------------------------------
40 | // constructors
41 | // --------------------------------------------------------------------------------------
42 |
43 | func NewStream() *Stream {
44 | return &Stream{
45 | Viewers: make(map[string]*Viewer),
46 | StartTime: time.Now(),
47 | }
48 | }
49 |
50 |
51 | // --------------------------------------------------------------------------------------
52 | // public members
53 | // --------------------------------------------------------------------------------------
54 |
55 | func (s *Stream) GetCurrentViewers(timeout time.Duration) int {
56 | count := 0
57 |
58 | s.Lock()
59 | for _, viewer := range s.Viewers {
60 | // only count those who did not time out already
61 | if viewer.LastSeen.Add(timeout).After(time.Now()) {
62 | count++
63 | }
64 | }
65 | s.Unlock()
66 |
67 | return count
68 | }
69 |
70 | func (s *Stream) GetUptime() time.Duration {
71 | return time.Now().Sub(s.StartTime)
72 | }
73 |
--------------------------------------------------------------------------------
/state/state.go:
--------------------------------------------------------------------------------
1 | package state
2 | // hlswatch - keep track of hls viewer stats
3 | // Copyright (C) 2017 Maximilian Pachl
4 |
5 | // This program is free software: you can redistribute it and/or modify
6 | // it under the terms of the GNU General Public License as published by
7 | // the Free Software Foundation, either version 3 of the License, or
8 | // (at your option) any later version.
9 |
10 | // This program is distributed in the hope that it will be useful,
11 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | // GNU General Public License for more details.
14 |
15 | // You should have received a copy of the GNU General Public License
16 | // along with this program. If not, see .
17 |
18 | // --------------------------------------------------------------------------------------
19 | // imports
20 | // --------------------------------------------------------------------------------------
21 |
22 | import (
23 | "github.com/faryon93/hlswatch/config"
24 | "sync"
25 | )
26 |
27 |
28 | // --------------------------------------------------------------------------------------
29 | // types
30 | // --------------------------------------------------------------------------------------
31 |
32 | type State struct {
33 | Conf *config.Conf
34 |
35 | CloseChan chan bool
36 |
37 | StreamsMutex sync.Mutex
38 | Streams map[string]*Stream
39 | }
40 |
41 |
42 | // --------------------------------------------------------------------------------------
43 | // constructors
44 | // --------------------------------------------------------------------------------------
45 |
46 | func New() *State {
47 | return &State{
48 | CloseChan: make(chan bool),
49 | Streams: make(map[string]*Stream),
50 | }
51 | }
52 |
53 |
54 | // --------------------------------------------------------------------------------------
55 | // public members
56 | // --------------------------------------------------------------------------------------
57 |
58 | func (s *State) GetStream(name string) (*Stream) {
59 | return s.Streams[name]
60 | }
61 |
62 | func (s *State) SetStream(name string, stream *Stream) {
63 | s.StreamsMutex.Lock()
64 | defer s.StreamsMutex.Unlock()
65 |
66 | s.Streams[name] = stream
67 | }
68 |
69 | func (s *State) RemoveStream(name string) {
70 | s.StreamsMutex.Lock()
71 | defer s.StreamsMutex.Unlock()
72 |
73 | delete(s.Streams, name)
74 | }
75 |
76 | func (s *State) Shutdown() {
77 | s.CloseChan <- true
78 | }
--------------------------------------------------------------------------------
/Dockerfile:
--------------------------------------------------------------------------------
1 | FROM golang:alpine as builder
2 | MAINTAINER Maximilian Pachl
3 | # setup the environment
4 | ENV TZ=Europe/Berlin
5 |
6 | # install dependencies
7 | RUN apk --update --no-cache add git gcc musl-dev tzdata
8 | WORKDIR /go/src/github.com/faryon93/hlswatch
9 | ADD ./ ./
10 |
11 | # build the go binary
12 | RUN go get github.com/faryon93/hlswatch && \
13 | go build -v -o /tmp/hlswatch .
14 |
15 | FROM alpine:latest
16 | MAINTAINER Maximilian Pachl
17 |
18 | # configuration and versions
19 | ENV NGINX_VERSION="1.13.11"
20 | ENV BUILD_TOOLS="g++ make pcre-dev openssl-dev unzip"
21 | ENV RUNTIME_LIBS="openssl pcre"
22 |
23 | # download the sources
24 | ADD http://nginx.org/download/nginx-$NGINX_VERSION.tar.gz /tmp
25 | ADD https://github.com/arut/nginx-rtmp-module/archive/master.zip /tmp/nginx-rtmp-master.zip
26 |
27 | # compile and install nginx
28 | RUN apk add --update $BUILD_TOOLS $RUNTIME_LIBS && \
29 | cd /tmp && \
30 | tar xzvf nginx-$NGINX_VERSION.tar.gz && \
31 | unzip nginx-rtmp-master.zip && \
32 | cd /tmp/nginx-$NGINX_VERSION && \
33 | ./configure --prefix=/usr \
34 | --modules-path=/var/lib/nginx/modules \
35 | --conf-path=/etc/nginx/nginx.conf \
36 | --pid-path=/var/run/nginx.pid \
37 | --lock-path=/var/run/nginx.lock \
38 | --sbin-path=/usr/sbin/nginx \
39 | --error-log-path=/var/log/nginx/error.log \
40 | --http-log-path=/var/log/nginx/access.log \
41 | --http-client-body-temp-path=/tmp/client_body_temp \
42 | --http-proxy-temp-path=/tmp/proxy_temp \
43 | --user=www \
44 | --group=www \
45 | --add-module=/tmp/nginx-rtmp-module-master \
46 | --without-http_fastcgi_module \
47 | --without-http_uwsgi_module \
48 | --without-http_scgi_module \
49 | --with-http_ssl_module \
50 | --with-http_v2_module && \
51 | make -j5 && \
52 | make install && \
53 | rm -r /usr/html && \
54 | # remove build tools
55 | rm -r /tmp/nginx-$NGINX_VERSION && \
56 | rm -r /tmp/nginx-rtmp-module-master && \
57 | rm /tmp/nginx-rtmp-master.zip && \
58 | rm /tmp/nginx-$NGINX_VERSION.tar.gz && \
59 | apk del $BUILD_TOOLS && \
60 | rm -rf /var/cache/apk/*
61 |
62 | # setup users
63 | RUN adduser -D -u 1000 -g 'www' www
64 |
65 | # network configuration
66 | EXPOSE 1935
67 | EXPOSE 80
68 | EXPOSE 443
69 |
70 | # setup the rootfs
71 | ADD hlswatch.conf /etc/
72 | ADD nginx.conf /etc/nginx/nginx.conf
73 | ADD entry.sh /
74 | COPY --from=builder /tmp/hlswatch /usr/sbin/hlswatch
75 | RUN mkdir /tmp/hls && \
76 | chmod 755 /entry.sh && \
77 | chmod 755 /usr/sbin/hlswatch
78 |
79 | # start command
80 | CMD ["/entry.sh"]
81 |
--------------------------------------------------------------------------------
/streamwatcher.go:
--------------------------------------------------------------------------------
1 | package main
2 | // hlswatch
3 | // Copyright (C) 2017 Maximilian Pachl
4 |
5 | // This program is free software: you can redistribute it and/or modify
6 | // it under the terms of the GNU General Public License as published by
7 | // the Free Software Foundation, either version 3 of the License, or
8 | // (at your option) any later version.
9 |
10 | // This program is distributed in the hope that it will be useful,
11 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | // GNU General Public License for more details.
14 |
15 | // You should have received a copy of the GNU General Public License
16 | // along with this program. If not, see .
17 |
18 | // --------------------------------------------------------------------------------------
19 | // imports
20 | // --------------------------------------------------------------------------------------
21 |
22 | import (
23 | "log"
24 | "path/filepath"
25 | "io/ioutil"
26 |
27 | "github.com/fsnotify/fsnotify"
28 |
29 | "github.com/faryon93/hlswatch/util"
30 | "github.com/faryon93/hlswatch/state"
31 | )
32 |
33 |
34 |
35 | // --------------------------------------------------------------------------------------
36 | // public functions
37 | // --------------------------------------------------------------------------------------
38 |
39 | func StreamWatcher(ctx *state.State) {
40 | watcher, err := fsnotify.NewWatcher()
41 | if err != nil {
42 | log.Println("[streamwatcher] failed to create fswatcher:", err.Error())
43 | return
44 | }
45 | defer watcher.Close()
46 |
47 | // monitor the hls data directory
48 | err = watcher.Add(ctx.Conf.Common.HlsPath)
49 | if err != nil {
50 | log.Println("[streamwatcher] failed to configure fs watcher:", err.Error())
51 | return
52 | }
53 |
54 | // index the currently available streams in fs
55 | files, _ := ioutil.ReadDir(ctx.Conf.Common.HlsPath)
56 | for _, f := range files {
57 | if f.IsDir() {
58 | log.Println("[streamwatcher] adding stream \"" + f.Name() + "\"")
59 | ctx.SetStream(f.Name(), state.NewStream())
60 | }
61 | }
62 |
63 | // from now on listen for all changes
64 | for {
65 | // wat for the next fs event
66 | event := <-watcher.Events
67 | streamName := filepath.Base(event.Name)
68 |
69 | // a new stream is created in fs
70 | if event.Op == fsnotify.Create && util.IsDir(event.Name) {
71 | log.Println("[streamwatcher] adding new stream \"" + streamName + "\"")
72 | ctx.SetStream(streamName, state.NewStream())
73 |
74 | // stream is removed from fs
75 | } else if event.Op == fsnotify.Remove {
76 | log.Println("[streamwatcher] removing stream \"" + streamName + "\"")
77 | ctx.RemoveStream(streamName)
78 | }
79 | }
80 | }
81 |
--------------------------------------------------------------------------------
/config/conf.go:
--------------------------------------------------------------------------------
1 | package config
2 | // hlswatch - keep track of hls viewer stats
3 | // Copyright (C) 2017 Maximilian Pachl
4 |
5 | // This program is free software: you can redistribute it and/or modify
6 | // it under the terms of the GNU General Public License as published by
7 | // the Free Software Foundation, either version 3 of the License, or
8 | // (at your option) any later version.
9 |
10 | // This program is distributed in the hope that it will be useful,
11 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | // GNU General Public License for more details.
14 |
15 | // You should have received a copy of the GNU General Public License
16 | // along with this program. If not, see .
17 |
18 | // --------------------------------------------------------------------------------------
19 | // imports
20 | // --------------------------------------------------------------------------------------
21 |
22 | import (
23 | "reflect"
24 |
25 | "github.com/BurntSushi/toml"
26 | )
27 |
28 |
29 | // --------------------------------------------------------------------------------------
30 | // constants
31 | // --------------------------------------------------------------------------------------
32 |
33 | const (
34 | ENV_PREFIX = "HLS"
35 | )
36 |
37 |
38 | // --------------------------------------------------------------------------------------
39 | // types
40 | // --------------------------------------------------------------------------------------
41 |
42 | type Conf struct {
43 | // common configuration options
44 | Common struct {
45 | Listen string `toml:"listen"`
46 | SslCertificate string `toml:"ssl_certificate"`
47 | SslPrivateKey string `toml:"ssl_privatekey"`
48 | HlsPath string `toml:"hls_path"`
49 | ViewerTimeout int `toml:"viewer_timeout"`
50 | } `toml:"common"`
51 |
52 | // influx database
53 | Influx struct {
54 | Address string `toml:"address" env:"ADDR"` // HLS_INFLUX_ADDR
55 | User string `toml:"user" env:"USER"` // HLS_INFLUX_USER
56 | Password string `toml:"password" env:"PASSWORD"` // HLS_INFLUX_PASSWORD
57 | Database string `toml:"database" env:"DB"` // HLS_INFLUX_DB
58 | } `toml:"influx" env:"INFLUX"`
59 | }
60 |
61 |
62 | // --------------------------------------------------------------------------------------
63 | // public functions
64 | // --------------------------------------------------------------------------------------
65 |
66 | func Load(path string) (*Conf, error) {
67 | // decode the conf file to struct
68 | var conf Conf
69 | if _, err := toml.DecodeFile(path, &conf); err != nil {
70 | return nil, err
71 | }
72 |
73 | // apply all configuration overrides from environment variables
74 | err := applyEnvOverrides(ENV_PREFIX, reflect.ValueOf(&conf))
75 | if err != nil {
76 | return nil, err
77 | }
78 |
79 | return &conf, nil
80 | }
81 |
82 |
83 | // --------------------------------------------------------------------------------------
84 | // public members
85 | // --------------------------------------------------------------------------------------
86 |
87 | func (c *Conf) IsSslEnabled() (bool) {
88 | return len(c.Common.SslCertificate) > 0 &&
89 | len(c.Common.SslPrivateKey) > 0
90 | }
91 |
92 |
--------------------------------------------------------------------------------
/config/env.go:
--------------------------------------------------------------------------------
1 | package config
2 | // hlswatch - keep track of hls viewer stats
3 | // Copyright (C) 2017 Maximilian Pachl
4 |
5 | // This program is free software: you can redistribute it and/or modify
6 | // it under the terms of the GNU General Public License as published by
7 | // the Free Software Foundation, either version 3 of the License, or
8 | // (at your option) any later version.
9 |
10 | // This program is distributed in the hope that it will be useful,
11 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | // GNU General Public License for more details.
14 |
15 | // You should have received a copy of the GNU General Public License
16 | // along with this program. If not, see .
17 |
18 | // --------------------------------------------------------------------------------------
19 | // imports
20 | // --------------------------------------------------------------------------------------
21 |
22 | import (
23 | "os"
24 | "reflect"
25 | "strconv"
26 | "errors"
27 | )
28 |
29 |
30 | // --------------------------------------------------------------------------------------
31 | // private members
32 | // --------------------------------------------------------------------------------------
33 |
34 | func applyEnvOverrides(prefix string, obj reflect.Value) (error) {
35 | // dereference the pointer if necessary
36 | if obj.Kind() == reflect.Ptr {
37 | obj = obj.Elem()
38 | }
39 |
40 | // we only want structs to parse
41 | if obj.Kind() != reflect.Struct {
42 | return errors.New("only structs are allowed")
43 | }
44 |
45 | for fieldIdx := 0; fieldIdx < obj.NumField(); fieldIdx++ {
46 | // some metadata for the currently inspected
47 | // field of the struct
48 | fieldType := obj.Type().Field(fieldIdx)
49 | fieldValue := obj.Field(fieldIdx)
50 | fieldTag := fieldType.Tag.Get("env")
51 |
52 | // we are only intrested in fields with "env" tags
53 | if len(fieldTag) > 0 {
54 | envVarName := fieldTag
55 | if len(prefix) > 0 {
56 | envVarName = prefix + "_" + envVarName
57 | }
58 |
59 | // another nested struct -> keep on interating
60 | if fieldType.Type.Kind() == reflect.Struct {
61 | applyEnvOverrides(envVarName, fieldValue)
62 |
63 | // finally we reached a real fieldValue type -> check env var
64 | // and override the fieldValue if needed
65 | } else {
66 | // an environment variable is specified by the user
67 | // so try to parse it and set the apropriate fieldValue
68 | overrideValue := os.Getenv(envVarName)
69 | if len(overrideValue) > 0 {
70 |
71 | // String
72 | if fieldType.Type.Kind() == reflect.String {
73 | fieldValue.SetString(overrideValue)
74 |
75 | // Integer
76 | } else if fieldType.Type.Kind() == reflect.Int {
77 | newValue, err := strconv.Atoi(overrideValue)
78 | if err != nil {
79 | continue
80 | }
81 |
82 | fieldValue.SetInt(int64(newValue))
83 |
84 | // Boolean
85 | } else if fieldType.Type.Kind() == reflect.Bool {
86 | newValue := false
87 | if overrideValue == "1" || overrideValue == "true" {
88 | newValue = true
89 | }
90 |
91 | fieldValue.SetBool(newValue)
92 | }
93 | }
94 | }
95 | }
96 | }
97 |
98 | return nil
99 | }
100 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # hlswatch - keep track of hls viewer stats
2 | hlswatch is a simple program to keep track of the concurrent viewer count of a [HLS](https://tools.ietf.org/html/draft-pantos-http-live-streaming-20) live stream. This piece of software is intended to be placed in front of a NGINX server with the [nginx-rtmp-module](https://github.com/arut/nginx-rtmp-module) installed and HLS encoding enabled.
3 | The NGINX server is used as a transcoding instance to translate an incoming RTMP stream into HLS compatible video fragments. Delivering the fragments and playlists to the clients is handled by hlswatch.
4 |
5 | To count the number of concurrent viewers hlswatch monitors the m3u8 playlist accesses per client. If the client does not issue a playlist reload in a certain amount of time it is considered as "not watching anymore".
6 |
7 | The gathered data can be obtained in two different ways:
8 |
9 | 1. The viewer counts are written to an [InfluxDB](https://www.influxdata.com/) database every second, if the the ```[influxdb]``` section is present in the config file. The tags ```node``` and ```stream``` are automatically populatet with the hostname and the stream name. The current count of concurrent viewers is stored in the value ```viewers```.
10 |
11 | 2. A REST endpoint is exposed on the address/port configured in ```common.listen```. A JSON object can be accessed at ```/stats```, which contains the current viewer numbers for each stream.
12 |
13 | **Keep in mind that this piece of software hasn't been tested in production!**
14 |
15 | ## Building
16 | The Go application is built as part of the Docker image build process.
17 | In order to build a fresh copy of *hlswatch* you just have to enter:
18 |
19 | $: docker build -t faryon93/hlswatch .
20 |
21 | ## Configuration
22 | Per default hlswatch uses ```/etc/hlswatch/hlswatch.conf``` as configuration file. If you want to change this path, just call hlswatch with your configuration file as the first argument.
23 |
24 | ```
25 | [common]
26 | listen = "0.0.0.0:3000" # listen port/address for REST interface
27 | hls_path = "/tmp/hls/" # path where nginx-rtmp stores the HLS fragments
28 | viewer_timeout = 15 # time in seconds when a viewer is considered not watching anymore
29 |
30 | [influx]
31 | address = "http://localhost:8086" # address of the influxdb server
32 | database = "hlswatch" # database name
33 | user = "hlswatch" # database user
34 | password = "hlswatch" # database password
35 | ```
36 |
37 | Some configuration parameters can be overriden by environment variables. See ```config/config.go``` for valid variable names. Note: Not all parameters can be replaced by environment variables.
38 |
39 | ## NGINX Setup
40 | Because this software is responsible for delivering all data to the client it is not necessary to serve the HLS fragments via nginx to the public. If you want all NGINX features like access control, compression, TLS Termination, ... you can reverse proxy incoming requests by NGINX to hlswatch.
41 | This software relies on some configuration option the nginx-rtmp-module offers. The settings `hls_cleanup` and `hls_nested` need to be enabled:
42 |
43 | ```
44 | rtmp {
45 | server {
46 | listen 1935;
47 | chunk_size 4000;
48 |
49 | application live {
50 | live on;
51 | hls on;
52 | hls_fragment_naming system;
53 | hls_fragment 5s;
54 | hls_path /tmp/hls;
55 | hls_nested on;
56 | }
57 | }
58 | }
59 | ```
60 |
61 | ## Tested Players
62 | The application was tested with the following web players:
63 |
64 | Player | Working |
65 | -------------------------------------------|---------|
66 | [clappr](https://github.com/clappr/clappr) | ✔ |
67 |
68 | ## Docker
69 | This repository contains a Dockerfile, which builds a container which contains an NGINX webserver compiled with the nginx-rtmp-module.
70 | The current version contained in the master branch is automatically pushed to [Docker Hub](https://hub.docker.com/r/faryon93/hlswatch/).
71 | Some configuration files to enable live streaming via RTMP and pass all HTTP requests to hlswatch is included by default.
72 | For production use you should consider adding SSL termination in NGINX and secure the access to hlswatchs statistics page.
73 |
74 | Running the container:
75 | ```
76 | $: docker run --rm -t -i \
77 | --name nginx-hls \
78 | -p 1935:1935 \
79 | -p 80:80 \
80 | -e HLS_INFLUX_ADDR=http://localhost:8086 \
81 | -e HLS_INFLUX_DB=hlswatch \
82 | -e HLS_INFLUX_USER=hlswatch \
83 | -e HLS_INFLUX_PASSWORD=hlswatch \
84 | faryon93/hlswatch
85 | ```
86 |
87 | ## ToDo
88 | - Caching of m3u8 playlist and video fragments in RAM
89 | - Disable directory listing in hlswatch
90 | - Execute hlswatch as unprivileged user (proper process supervision)
91 |
--------------------------------------------------------------------------------
/influx.go:
--------------------------------------------------------------------------------
1 | package main
2 | // hlswatch - keep track of hls viewer stats
3 | // Copyright (C) 2017 Maximilian Pachl
4 |
5 | // This program is free software: you can redistribute it and/or modify
6 | // it under the terms of the GNU General Public License as published by
7 | // the Free Software Foundation, either version 3 of the License, or
8 | // (at your option) any later version.
9 |
10 | // This program is distributed in the hope that it will be useful,
11 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | // GNU General Public License for more details.
14 |
15 | // You should have received a copy of the GNU General Public License
16 | // along with this program. If not, see .
17 |
18 | // --------------------------------------------------------------------------------------
19 | // imports
20 | // --------------------------------------------------------------------------------------
21 |
22 | import (
23 | "log"
24 | "os"
25 | "time"
26 |
27 | "github.com/influxdata/influxdb/client/v2"
28 |
29 | "github.com/faryon93/hlswatch/state"
30 | )
31 |
32 |
33 | // --------------------------------------------------------------------------------------
34 | // constants
35 | // --------------------------------------------------------------------------------------
36 |
37 | const (
38 | // influx connection options
39 | INFLUX_TIMEOUT = 500 * time.Millisecond
40 | INFLUX_FAIL_COUNT = 15
41 |
42 | // influx measurement description
43 | POINT_PRECISION = "s"
44 | STREAM_MEASUREMENT = "streams"
45 | TAG_NODE = "node"
46 | TAG_STREAM = "stream"
47 | VALUE_VIEWER = "viewers"
48 |
49 | // task options
50 | INFLUX_CYCLE_TIME = 1 * time.Second
51 | )
52 |
53 |
54 | // --------------------------------------------------------------------------------------
55 | // public functions
56 | // --------------------------------------------------------------------------------------
57 |
58 | func InfluxMetrics(ctx *state.State) {
59 | // connect to influxdb
60 | influx, err := client.NewHTTPClient(client.HTTPConfig{
61 | Addr: ctx.Conf.Influx.Address,
62 | Username: ctx.Conf.Influx.User,
63 | Password: ctx.Conf.Influx.Password,
64 | Timeout: INFLUX_TIMEOUT,
65 | })
66 | if err != nil {
67 | log.Println("[influx] failed to connect to influxdb:", err.Error())
68 | return
69 | }
70 |
71 | // check the connectivity
72 | _, _, err = influx.Ping(INFLUX_TIMEOUT)
73 | if err != nil {
74 | log.Println("[influx] failed to connect to influxdb:", err.Error())
75 | return
76 | }
77 |
78 | // some data needed for the measurements
79 | hostname, err := os.Hostname()
80 | if err != nil {
81 | log.Println("[influx] failed to query hostname:", err.Error())
82 | return
83 | }
84 | viewerTimeout := time.Duration(ctx.Conf.Common.ViewerTimeout) * time.Second
85 |
86 | // variables for runtime
87 | failCount := 0
88 |
89 | for {
90 | // A new batch of points
91 | bp, _ := client.NewBatchPoints(client.BatchPointsConfig{
92 | Database: ctx.Conf.Influx.Database,
93 | Precision: POINT_PRECISION,
94 | })
95 |
96 | startTime := time.Now()
97 |
98 | // save the numbers for all streams to influx db
99 | ctx.StreamsMutex.Lock()
100 | for streamName, stream := range ctx.Streams {
101 | count := stream.GetCurrentViewers(viewerTimeout)
102 | pt, _ := client.NewPoint(
103 | STREAM_MEASUREMENT,
104 | map[string]string{
105 | TAG_NODE: hostname,
106 | TAG_STREAM: streamName,
107 | },
108 | map[string]interface{}{
109 | VALUE_VIEWER: count,
110 | },
111 | startTime,
112 | )
113 | bp.AddPoint(pt)
114 | }
115 | ctx.StreamsMutex.Unlock()
116 |
117 | // write the datapoints to influx
118 | if len(bp.Points()) > 0 {
119 | err = influx.Write(bp)
120 | if err != nil {
121 | log.Println("[influx] failed to write datapoint:", err.Error())
122 |
123 | // check the fail count and disable this module if necessary
124 | failCount++
125 | if failCount >= INFLUX_FAIL_COUNT {
126 | log.Println("[influx] reached fail count, disabling module")
127 | return
128 | }
129 |
130 | // reset the failcount
131 | } else {
132 | failCount = 0
133 | }
134 | }
135 |
136 | time.Sleep(INFLUX_CYCLE_TIME)
137 | }
138 | }
139 |
--------------------------------------------------------------------------------
/main.go:
--------------------------------------------------------------------------------
1 | package main
2 | // hlswatch - keep track of hls viewer stats
3 | // Copyright (C) 2017 Maximilian Pachl
4 |
5 | // This program is free software: you can redistribute it and/or modify
6 | // it under the terms of the GNU General Public License as published by
7 | // the Free Software Foundation, either version 3 of the License, or
8 | // (at your option) any later version.
9 |
10 | // This program is distributed in the hope that it will be useful,
11 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | // GNU General Public License for more details.
14 |
15 | // You should have received a copy of the GNU General Public License
16 | // along with this program. If not, see .
17 |
18 | // --------------------------------------------------------------------------------------
19 | // imports
20 | // --------------------------------------------------------------------------------------
21 |
22 | import (
23 | "log"
24 | "runtime"
25 | "os"
26 | "os/signal"
27 | "net/http"
28 | "syscall"
29 | "context"
30 | "time"
31 |
32 | "github.com/faryon93/hlswatch/handler"
33 | "github.com/faryon93/hlswatch/state"
34 | "github.com/faryon93/hlswatch/config"
35 | )
36 |
37 |
38 | // --------------------------------------------------------------------------------------
39 | // constants
40 | // --------------------------------------------------------------------------------------
41 |
42 | const (
43 | SHUTDOWN_GRACEPERIOD = 5 * time.Second
44 | )
45 |
46 |
47 | // --------------------------------------------------------------------------------------
48 | // global variables
49 | // --------------------------------------------------------------------------------------
50 |
51 | var (
52 | // configuration options
53 | configFile = "/etc/hlswatch.conf"
54 |
55 | // runtime variables
56 | Ctx *state.State = state.New()
57 | )
58 |
59 |
60 | // --------------------------------------------------------------------------------------
61 | // application entry
62 | // --------------------------------------------------------------------------------------
63 |
64 | func main() {
65 | log.Println(GetAppIdentifier())
66 |
67 | // setup go environment to use all available cpu cores
68 | runtime.GOMAXPROCS(runtime.NumCPU())
69 | log.Println("using up to", runtime.NumCPU(), "cpu cores")
70 |
71 | // parse command line arguments
72 | if len(os.Args) > 1 {
73 | configFile = os.Args[1]
74 | }
75 |
76 | // load and parse the configuration file
77 | conf, err := config.Load(configFile)
78 | if err != nil {
79 | log.Println("failed to load configuration file:", err.Error())
80 | os.Exit(-1)
81 | }
82 | Ctx.Conf = conf
83 |
84 | // setup the http static file server serving the playlists
85 | // TODO: gzip compression for playlist, caching in ram
86 | rootfs := http.Dir(conf.Common.HlsPath)
87 | mux := http.NewServeMux()
88 | mux.Handle("/", handler.Hls(Ctx, http.FileServer(rootfs)))
89 | route(mux, "/stats", handler.Stats, Ctx)
90 | srv := &http.Server{Addr: conf.Common.Listen, Handler: mux}
91 |
92 | // serve the content via http
93 | go func() {
94 | var err error = nil
95 |
96 | // setup a tls server if configured
97 | if conf.IsSslEnabled() {
98 | err = srv.ListenAndServeTLS(conf.Common.SslCertificate,
99 | conf.Common.SslPrivateKey)
100 |
101 | // plain old http server
102 | } else {
103 | err = srv.ListenAndServe()
104 | }
105 |
106 | if err != nil {
107 | log.Println("failed to start http server:", err.Error())
108 | Ctx.Shutdown() // gracefull shutdown the application
109 | }
110 | }()
111 | log.Println("http is listening on", conf.Common.Listen)
112 |
113 | // fire the statistics computation task
114 | // TODO: close connections, ...
115 | go InfluxMetrics(Ctx)
116 | go StreamWatcher(Ctx)
117 |
118 | // wait for a signal to shutdown the application
119 | wait(os.Interrupt, syscall.SIGINT, syscall.SIGTERM)
120 | log.Println("gracefully shutting down application...")
121 |
122 | // gracefully shutdown the http server
123 | ctx, _ := context.WithTimeout(context.Background(), SHUTDOWN_GRACEPERIOD)
124 | srv.Shutdown(ctx)
125 |
126 | log.Println("application successfully exited")
127 | }
128 |
129 |
130 | // --------------------------------------------------------------------------------------
131 | // helper functions
132 | // --------------------------------------------------------------------------------------
133 |
134 | func wait(sig ...os.Signal) {
135 | signals := make(chan os.Signal)
136 | signal.Notify(signals, sig...)
137 |
138 | // wait for an OS signal or a signal by the close Channel
139 | select {
140 | case <- signals:
141 | case <- Ctx.CloseChan:
142 | }
143 | }
144 |
145 | func route(mux *http.ServeMux, pattern string, handler handler.Handler, ctx *state.State) {
146 | f := http.HandlerFunc(func (w http.ResponseWriter, r *http.Request) {
147 | handler(ctx, w, r)
148 | })
149 | mux.Handle(pattern, f)
150 | }
151 |
--------------------------------------------------------------------------------
/handler/hls.go:
--------------------------------------------------------------------------------
1 | package handler
2 | // hlswatch - keep track of hls viewer stats
3 | // Copyright (C) 2017 Maximilian Pachl
4 |
5 | // This program is free software: you can redistribute it and/or modify
6 | // it under the terms of the GNU General Public License as published by
7 | // the Free Software Foundation, either version 3 of the License, or
8 | // (at your option) any later version.
9 |
10 | // This program is distributed in the hope that it will be useful,
11 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | // GNU General Public License for more details.
14 |
15 | // You should have received a copy of the GNU General Public License
16 | // along with this program. If not, see .
17 |
18 | // --------------------------------------------------------------------------------------
19 | // imports
20 | // --------------------------------------------------------------------------------------
21 |
22 | import (
23 | "strings"
24 | "time"
25 | "errors"
26 | "net/http"
27 | "crypto/rand"
28 | "encoding/base64"
29 | "log"
30 |
31 | "github.com/faryon93/hlswatch/state"
32 | )
33 |
34 |
35 | // --------------------------------------------------------------------------------------
36 | // constants
37 | // --------------------------------------------------------------------------------------
38 |
39 | const (
40 | PLAYLIST_FILE_EXTENSION = "m3u8"
41 | TOKEN_URL_PARAMETER = "token"
42 | )
43 |
44 |
45 | // --------------------------------------------------------------------------------------
46 | // http handler
47 | // --------------------------------------------------------------------------------------
48 |
49 | func Hls(ctx *state.State, h http.Handler) http.Handler {
50 | f := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
51 | // headers applicable for all files
52 | w.Header().Set("Access-Control-Allow-Origin", "*")
53 |
54 | // We keep track of the concurrent users by watching the
55 | // m3u8 accesses. Each clients gets a unique token assigned
56 | // wich is used to identify it. In order to get the new video fragments
57 | // the client is supposed to reload the playlistfile periodically, we use
58 | // this circumstance to count the viewers based on a timeout value.
59 | if strings.Contains(r.URL.String(), PLAYLIST_FILE_EXTENSION) {
60 | // some meta information needed to process the request properly
61 | streamName, err := getStreamName(r.URL.Path)
62 | if err != nil {
63 | log.Println("invalid hls url requested:", r.URL.String())
64 | http.Error(w, "invalid streaming url", http.StatusNotAcceptable)
65 | return
66 | }
67 | stream := ctx.GetStream(streamName)
68 | if stream == nil {
69 | http.Error(w, "invalid hls stream", http.StatusNotFound)
70 | return
71 | }
72 |
73 | // get the viewer by its token
74 | token := r.URL.Query().Get(TOKEN_URL_PARAMETER)
75 | stream.Lock()
76 | viewer := stream.Viewers[token]
77 | stream.Unlock()
78 |
79 | // we do not want caching for the playlist, because it changes
80 | // everytime a new video fragment is created
81 | w.Header().Set("Cache-Control", "no-cache")
82 | w.Header().Set("Content-Type", "application/vnd.apple.mpegurl")
83 |
84 | // generate a new token if the client does not supply one
85 | if token == "" {
86 | token = nextToken()
87 |
88 | stream.Lock()
89 | stream.Viewers[token] = &state.Viewer{
90 | FirstSeen: time.Now(),
91 | LastSeen: time.Now(),
92 | Ip: r.RemoteAddr,
93 | }
94 | stream.Unlock()
95 |
96 | // assemble the url with the token appended
97 | query := r.URL.Query()
98 | query.Set(TOKEN_URL_PARAMETER, token)
99 | r.URL.RawQuery = query.Encode()
100 |
101 | // redirect the client to the url with the appended token
102 | http.Redirect(w, r, r.URL.String(), http.StatusSeeOther)
103 | return
104 |
105 | // the client supplied an invalid token -> wo do not handle this request
106 | } else if viewer == nil {
107 | http.Error(w, "invalid hls token", http.StatusNotAcceptable)
108 | return
109 | }
110 |
111 | // update the lastseen time, so we can keep track of the viewers
112 | viewer.LastSeen = time.Now()
113 | }
114 |
115 | // serve the requested file from fs
116 | h.ServeHTTP(w, r)
117 | })
118 |
119 | return f
120 | }
121 |
122 |
123 | // --------------------------------------------------------------------------------------
124 | // helper functions
125 | // --------------------------------------------------------------------------------------
126 |
127 | func getStreamName(url string) (string, error) {
128 | // the first "subdirectory" is the name of the stream
129 | parts := strings.SplitN(strings.Trim(url, "/"), "/", 2)
130 | if len(parts) < 2 {
131 | return "", errors.New("url to short to get stream name")
132 | }
133 |
134 | return parts[0], nil
135 | }
136 |
137 | func nextToken() string {
138 | key := make([]byte, 32)
139 | rand.Read(key)
140 |
141 | return base64.StdEncoding.EncodeToString(key)
142 | }
143 |
--------------------------------------------------------------------------------
/LICENSE.txt:
--------------------------------------------------------------------------------
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
--------------------------------------------------------------------------------