├── README.md ├── river.go └── LICENSE /README.md: -------------------------------------------------------------------------------- 1 | river 2 | ===== 3 | 4 | A personal music server 5 | 6 | About 7 | ----- 8 | 9 | River is a personal music streaming server that is designed to be an alternative 10 | to proprietary streaming services. Users set up the River server on the computer 11 | where they store their music library, and stream their songs via client 12 | programs. Clients can be built by using the small JSON API provided by the 13 | server. Songs in the user's library can be streamed in the Ogg Opus or MP3 14 | formats (note that [all major browsers support at least one of these 15 | formats](https://en.wikipedia.org/wiki/HTML5_Audio#Supported_browsers_2)). 16 | When a stream is requested, songs are automatically transcoded to the requested 17 | format, if necessary. 18 | 19 | River integrates with existing music libraries, so setting up River streams your 20 | music without interfering or conflicting with other tools. The server is 21 | designed to be simple to set up for anyone with basic knowledge of the command 22 | line who is capable of configuring dynamic DNS (or owns a static global IP). 23 | 24 | Building 25 | -------- 26 | 27 | go build 28 | 29 | ### FFmpeg/LibAV 30 | 31 | River calls `ffmpeg`/`avconv` and `ffprobe`/`avprobe` to transcode and read 32 | audio files. If your operating system has a package manager, look for a package 33 | called `ffmpeg` or `libav-tools` and install it. Otherwise, download an FFmpeg 34 | build from [the official website](https://www.ffmpeg.org/download.html), and 35 | either copy the `ffmpeg` and `ffprobe` executables to this directory, somewhere 36 | in your system's PATH, or add the location of the executables to your system's 37 | PATH. Windows and OS X (`darwin`) releases come with the executables bundled, 38 | as they lack an official package manager. 39 | 40 | Usage 41 | ----- 42 | 43 | river [-cert file] [-key file] [-port port] directory 44 | 45 | river serves the music in the given directory. The music can be accessed via a 46 | client on port 21313, or on the port named by the -port flag. If the -cert and 47 | -key flags are specified, river will listen for HTTPS connections; otherwise, 48 | river will listen for HTTP connections. 49 | 50 | [river-web](https://github.com/wwalexander/river-web) is a browser-based River 51 | client. 52 | 53 | ### API 54 | 55 | Note that track and disc numbers should begin at `1`. Numbers lower than 56 | `1` indicate that the field is missing or should be treated as such. 57 | 58 | All API methods besides `OPTIONS` require basic authentication, where the 59 | password matches the password given to the server by the user. Clients will need 60 | to prompt the user for the password before accessing the API. 61 | 62 | If you are building a browser client, note that direct `src` links to the stream 63 | URLs will not work due to the required authentication. You can use URL-based 64 | basic authentication (`protocol://:password@host...`) in `src` attributes, but 65 | this is unsupported in Internet Explorer and probably other browsers soon. You 66 | can use `URL.createObjectURL` in JavaScript instead, e.g.: 67 | 68 | ```javascript 69 | var audio = document.createElement("audio"); 70 | var xhr = new XMLHttpRequest(); 71 | 72 | xhr.onload = function() { 73 | var source = document.createElement("source"); 74 | source.src = URL.createObjectURL(xhr.response); 75 | source.type = "audio/ogg"; 76 | audio.appendChild(source); 77 | } 78 | 79 | xhr.open("GET", "https://www.mydomain.com/songs/iswkgapo.opus"); 80 | xhr.responseType = "blob"; 81 | xhr.setRequestHeader("Authorization", "Basic " + btoa(":asanisimasa"); 82 | xhr.send(); 83 | ``` 84 | 85 | However, this method requires the entire file to be downloaded before playback 86 | begins. 87 | 88 | #### Get a list of songs in the library 89 | 90 | ```http 91 | GET /songs 92 | ``` 93 | 94 | ```http 95 | HTTP/1.1 200 OK 96 | Content-Type: application/json 97 | ``` 98 | 99 | ```json 100 | [ 101 | { 102 | "id": "iswkgapo", 103 | "path": "Bob Dylan/Bringing It All Back Home/Mr. Tambourine Man.flac", 104 | "time": "2015-05-28T10:06:04-08:00", 105 | "artist": "Bob Dylan", 106 | "album": "Bringing It All Back Home", 107 | "disc": 2, 108 | "track": 1, 109 | "title": "Mr. Tambourine Man", 110 | "fmt": "flac", 111 | "codec": "flac" 112 | }, 113 | { 114 | "id": "wybtohyc", 115 | "path": "Neutral Milk Hotel/In the Aeroplane over the Sea/Holland, 1945.flac", 116 | "time": "2015-05-28T10:06:04-08:00", 117 | "artist": "Neutral Milk Hotel", 118 | "album": "In the Aeroplane over the Sea", 119 | "disc": 0, 120 | "track": 6, 121 | "title": "Holland, 1945", 122 | "fmt": "flac", 123 | "codec": "flac" 124 | } 125 | ] 126 | ``` 127 | 128 | ### Get info for a specific song in the library 129 | 130 | ```http 131 | GET /songs/wybtohyc 132 | ``` 133 | 134 | ```http 135 | HTTP/1.1 200 OK 136 | Content-Type: application/json 137 | ``` 138 | 139 | ```json 140 | { 141 | "id": "wybtohyc", 142 | "path": "Neutral Milk Hotel/In the Aeroplane over the Sea/Holland, 1945.flac", 143 | "time": "2015-05-28T10:06:04-08:00", 144 | "artist": "Neutral Milk Hotel", 145 | "album": "In the Aeroplane over the Sea", 146 | "disc": 0, 147 | "track": 6, 148 | "title": "Holland, 1945", 149 | "fmt": "flac", 150 | "codec": "flac" 151 | } 152 | ``` 153 | 154 | #### Reload the library (i.e. after adding music or editing tags) 155 | 156 | ```http 157 | PUT /songs 158 | ``` 159 | 160 | ```http 161 | HTTP/1.1 200 OK 162 | Content-Type: application/json 163 | ``` 164 | 165 | ```json 166 | [ 167 | { 168 | "id": "iswkgapo", 169 | "path": "Bob Dylan/Bringing It All Back Home/Mr. Tambourine Man.flac", 170 | "time": "2015-05-28T10:06:04-08:00", 171 | "artist": "Bob Dylan", 172 | "album": "Bringing It All Back Home", 173 | "disc": 2, 174 | "track": 1, 175 | "title": "Mr. Tambourine Man", 176 | "fmt": "flac", 177 | "codec": "flac" 178 | }, 179 | { 180 | "id": "ihnqqjce", 181 | "path": "Neutral Milk Hotel/Ferris Wheel on Fire/Home.flac", 182 | "time": "2015-05-28T10:06:04-08:00", 183 | "artist": "Neutral Milk Hotel", 184 | "album": "Ferris Wheel on Fire", 185 | "disc": 0, 186 | "track": 3, 187 | "title": "Home", 188 | "fmt": "flac", 189 | "codec": "flac" 190 | }, 191 | { 192 | "id": "wybtohyc", 193 | "path": "Neutral Milk Hotel/In the Aeroplane over the Sea/Holland, 1945.flac", 194 | "time": "2015-05-28T10:06:04-08:00", 195 | "artist": "Neutral Milk Hotel", 196 | "album": "In the Aeroplane over the Sea", 197 | "disc": 0, 198 | "track": 6, 199 | "title": "Holland, 1945", 200 | "fmt": "flac", 201 | "codec": "flac" 202 | } 203 | ] 204 | ``` 205 | 206 | #### Get the stream for a song 207 | 208 | ##### Opus 209 | 210 | ```http 211 | GET /songs/wybtohyc.opus 212 | ``` 213 | 214 | ```http 215 | HTTP/1.1 200 OK 216 | Content-Type: audio/ogg 217 | ``` 218 | 219 | ##### MP3 220 | 221 | ```http 222 | GET /songs/wybtohyc.mp3 223 | ``` 224 | 225 | ```http 226 | HTTP/1.1 200 OK 227 | Content-Type: audio/mpeg 228 | ``` 229 | -------------------------------------------------------------------------------- /river.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "crypto/rand" 5 | "encoding/json" 6 | "errors" 7 | "flag" 8 | "fmt" 9 | "golang.org/x/crypto/bcrypt" 10 | "golang.org/x/crypto/ssh/terminal" 11 | "log" 12 | "math/big" 13 | "net/http" 14 | "os" 15 | "os/exec" 16 | "path" 17 | "path/filepath" 18 | "reflect" 19 | "regexp" 20 | "sort" 21 | "strconv" 22 | "strings" 23 | "sync" 24 | "time" 25 | ) 26 | 27 | const ( 28 | marshalPath = ".library.json" 29 | streamDirPath = ".stream" 30 | ) 31 | 32 | const ( 33 | idLeastByte = 'a' 34 | idGreatestByte = 'z' 35 | idLength = 8 36 | ) 37 | 38 | const ( 39 | fportName = "port" 40 | fcertName = "cert" 41 | fkeyName = "key" 42 | ) 43 | 44 | const ( 45 | httpOptions = "OPTIONS" 46 | httpGet = "GET" 47 | httpPut = "PUT" 48 | ) 49 | 50 | // Afmt represents an audio format supported by ffmpeg/avconv. 51 | type Afmt struct { 52 | // Fmt is the format's name in ffmpeg/avconv. 53 | Fmt string 54 | // Codec is the format's codec in ffprobe/avprobe. 55 | Codec string 56 | // Encoder is the format's encoder in ffmpeg/avconv. 57 | Encoder string 58 | // Mime is the MIME type of the format. 59 | Mime string 60 | // Args are the encoder-specific ffmpeg/avconv arguments to use. 61 | Args []string 62 | } 63 | 64 | var afmts = map[string]Afmt{ 65 | ".opus": { 66 | Fmt: "ogg", 67 | Codec: "opus", 68 | Encoder: "libopus", 69 | Mime: "audio/ogg; codecs=\"opus\"", 70 | Args: []string{ 71 | "-b:a", "128000", 72 | "-compression_level", "0", 73 | }, 74 | }, 75 | ".mp3": { 76 | Fmt: "mp3", 77 | Codec: "mp3", 78 | Encoder: "libmp3lame", 79 | Mime: "audio/mpeg; codecs=\"mp3\"", 80 | Args: []string{ 81 | "-q", "4", 82 | }, 83 | }, 84 | } 85 | 86 | // Song represents a song in a library. 87 | type Song struct { 88 | // ID is the unique ID of the Song. 89 | ID string `json:"id"` 90 | // Path is the path to the Song's source file. 91 | Path string `json:"path"` 92 | // Time is the last time the Song's source file was modified. 93 | Time time.Time `json:"time"` 94 | // Artist is the Song's artist. 95 | Artist string `json:"artist"` 96 | // Album is the album the Song comes from. 97 | Album string `json:"album"` 98 | // Disc is the album disc the Song comes from. 99 | Disc int `json:"disc"` 100 | // Track is the Song's track number on the disc it comes from. 101 | Track int `json:"track"` 102 | // Title is the Song's title. 103 | Title string `json:"title"` 104 | // Fmt is the Song's format in ffmpeg/avconv. 105 | Fmt string `json:"fmt"` 106 | // Codec is the Song's codec in ffprobe/avprobe. 107 | Codec string `json:"codec"` 108 | } 109 | 110 | // ByTags sorts Songs case-insensitively with the following priority: 111 | // artist, album, disc number, track number, title, library path 112 | type ByTags []*Song 113 | 114 | func (t ByTags) Len() int { return len(t) } 115 | func (t ByTags) Swap(i, j int) { t[i], t[j] = t[j], t[i] } 116 | 117 | func compareFold(s, t string) (eq bool, less bool) { 118 | sLower := strings.ToLower(s) 119 | tLower := strings.ToLower(t) 120 | return sLower == tLower, sLower < tLower 121 | } 122 | 123 | func (t ByTags) Less(i, j int) bool { 124 | if eq, less := compareFold(t[i].Artist, t[j].Artist); !eq { 125 | return less 126 | } 127 | if eq, less := compareFold(t[i].Album, t[j].Album); !eq { 128 | return less 129 | } 130 | if t[i].Disc != t[j].Disc { 131 | return t[i].Disc < t[j].Disc 132 | } 133 | if t[i].Track != t[j].Track { 134 | return t[i].Track < t[j].Track 135 | } 136 | if eq, less := compareFold(t[i].Title, t[j].Title); !eq { 137 | return less 138 | } 139 | _, less := compareFold(t[i].Path, t[j].Path) 140 | return less 141 | } 142 | 143 | // Encoder encodes streaming files. 144 | type Encoder struct { 145 | convCmd string 146 | encoding map[string]*sync.Mutex 147 | mutex *sync.Mutex 148 | } 149 | 150 | // NewEncoder returns a new Encoder which uses convCmd as the encoding tool. 151 | func NewEncoder(convCmd string) *Encoder { 152 | return &Encoder{ 153 | convCmd: convCmd, 154 | encoding: make(map[string]*sync.Mutex), 155 | mutex: &sync.Mutex{}, 156 | } 157 | } 158 | 159 | // Encode encodes src to the audio format specified by af, writing to dest. 160 | func (e *Encoder) Encode(s *Song, dest string, src string, af Afmt) error { 161 | e.mutex.Lock() 162 | defer e.mutex.Unlock() 163 | mutex, ok := e.encoding[dest] 164 | if !ok { 165 | mutex = &sync.Mutex{} 166 | e.encoding[dest] = mutex 167 | } 168 | mutex.Lock() 169 | defer mutex.Unlock() 170 | _, err := os.Stat(dest) 171 | if err == nil { 172 | return nil 173 | } else if err != nil && !os.IsNotExist(err) { 174 | return err 175 | } 176 | args := []string{ 177 | "-i", src, 178 | "-codec", af.Encoder, 179 | "-metadata", fmt.Sprintf("artist=%s", s.Artist), 180 | "-metadata", fmt.Sprintf("album=%s", s.Album), 181 | "-metadata", fmt.Sprintf("disc=%d", s.Disc), 182 | "-metadata", fmt.Sprintf("track=%d", s.Track), 183 | "-metadata", fmt.Sprintf("title=%s", s.Title), 184 | "-f", af.Fmt, 185 | } 186 | args = append(args, af.Args...) 187 | args = append(args, dest) 188 | err = exec.Command(e.convCmd, args...).Run() 189 | if err != nil { 190 | if _, err := os.Stat(dest); err == nil { 191 | os.Remove(dest) 192 | } 193 | } 194 | return nil 195 | } 196 | 197 | // Library represents a music library and server. 198 | type Library struct { 199 | // Path is the path to the library directory. 200 | Path string `json:"path"` 201 | // SongsByPath maps Song.Paths to Songs. 202 | SongsByPath map[string]*Song `json:"songsByPath"` 203 | // SongsByID maps Song.IDs to Songs. 204 | SongsByID map[string]*Song `json:"songsByID"` 205 | sorted []*Song 206 | probeCmd string 207 | mutex *sync.RWMutex 208 | enc *Encoder 209 | hash []byte 210 | songRE *regexp.Regexp 211 | streamRE *regexp.Regexp 212 | } 213 | 214 | func isKind(val interface{}, kind reflect.Kind) bool { 215 | return reflect.TypeOf(val).Kind() == kind 216 | } 217 | 218 | func (l *Library) probeCmdError() error { 219 | return fmt.Errorf("malformed %s output", l.probeCmd) 220 | } 221 | 222 | type tags struct { 223 | Format map[string]interface{} `json:"format"` 224 | Streams []map[string]interface{} `json:"streams"` 225 | } 226 | 227 | func valRaw(key string, cont map[string]interface{}) (val string, ok bool) { 228 | tags, ok := cont["tags"].(map[string]interface{}) 229 | if !ok { 230 | return 231 | } 232 | if val, ok = tags[strings.ToLower(key)].(string); ok { 233 | return val, ok 234 | } 235 | val, ok = tags[strings.ToUpper(key)].(string) 236 | return 237 | } 238 | 239 | func (t tags) val(key string) (val string, ok bool) { 240 | if val, ok := valRaw(key, t.Format); ok { 241 | return val, ok 242 | } 243 | for _, stream := range t.Streams { 244 | if val, ok := valRaw(key, stream); ok { 245 | return val, ok 246 | } 247 | } 248 | return 249 | } 250 | 251 | func valInt(valString string) (val int) { 252 | val, _ = strconv.Atoi(strings.Split(valString, "/")[0]) 253 | return 254 | } 255 | 256 | func (l *Library) absPath(path string) string { 257 | return filepath.Join(l.Path, path) 258 | } 259 | 260 | func (l *Library) relPath(path string) (rel string, err error) { 261 | return filepath.Rel(l.Path, path) 262 | } 263 | 264 | func genID(length int) (string, error) { 265 | idBytes := make([]byte, 0, length) 266 | for i := 0; i < cap(idBytes); i++ { 267 | n, err := rand.Int(rand.Reader, 268 | big.NewInt(int64(idGreatestByte-idLeastByte))) 269 | if err != nil { 270 | return "", err 271 | } 272 | idBytes = append(idBytes, byte(n.Int64())+idLeastByte) 273 | } 274 | return string(idBytes), nil 275 | } 276 | 277 | func (l *Library) newSong(path string) (s *Song, err error) { 278 | abs := l.absPath(path) 279 | cmd := exec.Command(l.probeCmd, 280 | "-print_format", "json", 281 | "-show_format", 282 | "-show_streams", 283 | abs) 284 | stdout, err := cmd.StdoutPipe() 285 | if err != nil { 286 | return 287 | } 288 | if err = cmd.Start(); err != nil { 289 | return 290 | } 291 | var t tags 292 | if err = json.NewDecoder(stdout).Decode(&t); err != nil { 293 | return 294 | } 295 | if err = cmd.Wait(); err != nil { 296 | return 297 | } 298 | score, ok := t.Format["probe_score"] 299 | if !ok || !isKind(score, reflect.Float64) { 300 | return nil, l.probeCmdError() 301 | } 302 | if score.(float64) < 25 { 303 | return nil, errors.New("undeterminable file type") 304 | } 305 | fmt, ok := t.Format["format_name"] 306 | if !ok || !isKind(fmt, reflect.String) { 307 | return nil, l.probeCmdError() 308 | } 309 | s = &Song{ 310 | Path: path, 311 | Fmt: fmt.(string), 312 | } 313 | audio := false 314 | for _, stream := range t.Streams { 315 | codecTypeRaw, ok := stream["codec_type"] 316 | if !ok || !isKind(codecTypeRaw, reflect.String) { 317 | return nil, l.probeCmdError() 318 | } 319 | if codecType := codecTypeRaw.(string); codecType == "audio" { 320 | audio = true 321 | codec := stream["codec_name"] 322 | if !ok || !isKind(codec, reflect.String) { 323 | return nil, l.probeCmdError() 324 | } 325 | s.Codec = codec.(string) 326 | } 327 | } 328 | if !audio { 329 | return nil, errors.New("no audio stream") 330 | } 331 | sOld, ok := l.SongsByPath[s.Path] 332 | if ok { 333 | s.ID = sOld.ID 334 | } else { 335 | id, err := genID(idLength) 336 | if err != nil { 337 | return nil, err 338 | } 339 | s.ID = id 340 | } 341 | songFile, err := os.Open(abs) 342 | if err != nil { 343 | return 344 | } 345 | fi, err := songFile.Stat() 346 | if err != nil { 347 | return 348 | } 349 | s.Time = fi.ModTime() 350 | songFile.Close() 351 | s.Artist, _ = t.val("artist") 352 | s.Album, _ = t.val("album") 353 | disc, ok := t.val("disc") 354 | if !ok { 355 | disc, _ = t.val("discnumber") 356 | } 357 | s.Disc = valInt(disc) 358 | track, ok := t.val("track") 359 | if !ok { 360 | track, _ = t.val("tracknumber") 361 | } 362 | s.Track = valInt(track) 363 | s.Title, _ = t.val("title") 364 | return 365 | } 366 | 367 | func deleteStream(s *Song) (err error) { 368 | for ext := range afmts { 369 | path := streamPath(s, ext) 370 | if _, err = os.Stat(path); err == nil { 371 | if err = os.Remove(path); err != nil { 372 | return 373 | } 374 | } else if !os.IsNotExist(err) { 375 | return 376 | } 377 | } 378 | return 379 | } 380 | 381 | func (l *Library) marshal() (err error) { 382 | db, err := os.OpenFile(marshalPath, os.O_CREATE|os.O_TRUNC, 0666) 383 | if err != nil { 384 | return 385 | } 386 | defer db.Close() 387 | err = json.NewEncoder(db).Encode(l) 388 | return 389 | } 390 | 391 | func (l *Library) reload() (err error) { 392 | filepath.Walk(l.Path, func(path string, info os.FileInfo, err error) error { 393 | if err != nil || info.IsDir() { 394 | return nil 395 | } 396 | rel, err := l.relPath(path) 397 | if err != nil { 398 | return nil 399 | } 400 | sOld, ok := l.SongsByPath[rel] 401 | reload := false 402 | if ok { 403 | fi, err := os.Stat(path) 404 | if err != nil { 405 | return nil 406 | } 407 | reload = fi.ModTime().After(sOld.Time) 408 | } else { 409 | reload = true 410 | } 411 | if reload { 412 | s, err := l.newSong(rel) 413 | if err != nil { 414 | return nil 415 | } 416 | l.SongsByPath[rel] = s 417 | l.SongsByID[s.ID] = s 418 | deleteStream(s) 419 | } 420 | return nil 421 | }) 422 | for path, s := range l.SongsByPath { 423 | if _, err := os.Stat(l.absPath(path)); os.IsNotExist(err) { 424 | delete(l.SongsByPath, path) 425 | delete(l.SongsByID, s.ID) 426 | deleteStream(s) 427 | } 428 | } 429 | l.sorted = make(ByTags, 0, len(l.SongsByPath)) 430 | for _, s := range l.SongsByPath { 431 | l.sorted = append(l.sorted, s) 432 | } 433 | sort.Sort(ByTags(l.sorted)) 434 | err = l.marshal() 435 | return 436 | } 437 | 438 | func chooseCmd(s, t string) (string, error) { 439 | _, errs := exec.LookPath(s) 440 | _, errt := exec.LookPath(t) 441 | if errs == nil { 442 | return s, nil 443 | } else if errt == nil { 444 | return t, nil 445 | } 446 | return "", fmt.Errorf("could not find '%s' or '%s' executable", s, t) 447 | } 448 | 449 | // NewLibrary returns a new Library for path which requires an authentication 450 | // password whose bcrypt hash compares with hash. 451 | func NewLibrary(path string, hash []byte) (l *Library, err error) { 452 | l = &Library{ 453 | hash: hash, 454 | mutex: &sync.RWMutex{}, 455 | } 456 | l.probeCmd, err = chooseCmd("ffprobe", "avprobe") 457 | if err != nil { 458 | return nil, err 459 | } 460 | convCmd, err := chooseCmd("ffmpeg", "avconv") 461 | if err != nil { 462 | return nil, err 463 | } 464 | l.enc = NewEncoder(convCmd) 465 | songREFmt := fmt.Sprintf("^\\/songs\\/[%c-%c]{%d}", 466 | idLeastByte, 467 | idGreatestByte, 468 | idLength) 469 | if l.songRE, err = regexp.Compile(songREFmt + "$"); err != nil { 470 | return nil, err 471 | } 472 | if l.streamRE, err = regexp.Compile(songREFmt + "\\..+$"); err != nil { 473 | return nil, err 474 | } 475 | if db, err := os.Open(marshalPath); err == nil { 476 | defer db.Close() 477 | if err = json.NewDecoder(db).Decode(l); err != nil { 478 | return nil, err 479 | } 480 | } 481 | if l.Path != path { 482 | l.Path = path 483 | l.SongsByPath = make(map[string]*Song) 484 | l.SongsByID = make(map[string]*Song) 485 | } 486 | l.reload() 487 | return 488 | } 489 | 490 | func httpError(w http.ResponseWriter, status int) { 491 | http.Error(w, http.StatusText(status), status) 492 | } 493 | 494 | func (l *Library) putSongs(w http.ResponseWriter, r *http.Request) error { 495 | l.mutex.Lock() 496 | defer l.mutex.Unlock() 497 | if err := l.reload(); err != nil { 498 | httpError(w, http.StatusInternalServerError) 499 | return err 500 | } 501 | return nil 502 | } 503 | 504 | func (l *Library) getSongs(w http.ResponseWriter) { 505 | w.Header().Set("Content-Type", "application/json") 506 | l.mutex.RLock() 507 | defer l.mutex.RUnlock() 508 | json.NewEncoder(w).Encode(l.sorted) 509 | } 510 | 511 | func streamPath(s *Song, ext string) string { 512 | return filepath.Join(streamDirPath, s.ID) + ext 513 | } 514 | 515 | func (l *Library) getSong(w http.ResponseWriter, r *http.Request) { 516 | w.Header().Set("Content-Type", "application/json") 517 | l.mutex.RLock() 518 | defer l.mutex.RUnlock() 519 | s, ok := l.SongsByID[path.Base(r.URL.Path)] 520 | if !ok { 521 | httpError(w, http.StatusNotFound) 522 | return 523 | } 524 | json.NewEncoder(w).Encode(s) 525 | } 526 | 527 | func (l *Library) getStream(w http.ResponseWriter, r *http.Request) { 528 | l.mutex.RLock() 529 | defer l.mutex.RUnlock() 530 | base := path.Base(r.URL.Path) 531 | ext := path.Ext(base) 532 | s, ok := l.SongsByID[strings.TrimSuffix(base, ext)] 533 | if !ok { 534 | httpError(w, http.StatusNotFound) 535 | return 536 | } 537 | af, ok := afmts[ext] 538 | if !ok { 539 | httpError(w, http.StatusNotFound) 540 | return 541 | } 542 | w.Header().Set("Content-Type", af.Mime) 543 | absPath := l.absPath(s.Path) 544 | if s.Fmt == af.Fmt && s.Codec == af.Codec { 545 | http.ServeFile(w, r, absPath) 546 | return 547 | } 548 | streamPath := streamPath(s, ext) 549 | if l.enc.Encode(s, streamPath, absPath, af) != nil { 550 | httpError(w, http.StatusInternalServerError) 551 | return 552 | } 553 | http.ServeFile(w, r, streamPath) 554 | } 555 | 556 | func (l *Library) ServeHTTP(w http.ResponseWriter, r *http.Request) { 557 | w.Header().Set("Access-Control-Allow-Origin", "*") 558 | w.Header().Set("Access-Control-Allow-Headers", "Authorization") 559 | if r.Method != httpOptions { 560 | _, password, ok := r.BasicAuth() 561 | if !ok || 562 | bcrypt.CompareHashAndPassword(l.hash, []byte(password)) != nil { 563 | w.Header().Set("WWW-Authenticate", "Basic realm=\"River\"") 564 | httpError(w, http.StatusUnauthorized) 565 | return 566 | } 567 | } 568 | handle := func(methodHandlers map[string]func()) { 569 | switch r.Method { 570 | case httpOptions: 571 | allowedMethods := make([]string, 0, len(methodHandlers)) 572 | for method := range methodHandlers { 573 | allowedMethods = append(allowedMethods, method) 574 | } 575 | w.Header().Set("Access-Control-Allow-Methods", strings.Join(allowedMethods, ", ")) 576 | w.WriteHeader(http.StatusOK) 577 | default: 578 | handler, ok := methodHandlers[r.Method] 579 | if !ok { 580 | httpError(w, http.StatusMethodNotAllowed) 581 | return 582 | } 583 | handler() 584 | } 585 | } 586 | switch { 587 | case r.URL.Path == "/songs": 588 | handle(map[string]func(){ 589 | httpPut: func() { 590 | if err := l.putSongs(w, r); err != nil { 591 | return 592 | } 593 | l.getSongs(w) 594 | }, 595 | httpGet: func() { 596 | l.getSongs(w) 597 | }, 598 | }) 599 | case l.songRE.MatchString(r.URL.Path): 600 | handle(map[string]func(){ 601 | httpGet: func() { 602 | l.getSong(w, r) 603 | }, 604 | }) 605 | case l.streamRE.MatchString(r.URL.Path): 606 | handle(map[string]func(){ 607 | httpGet: func() { 608 | l.getStream(w, r) 609 | }, 610 | }) 611 | default: 612 | httpError(w, http.StatusNotFound) 613 | } 614 | } 615 | 616 | func getHash() (hash []byte, err error) { 617 | fmt.Print("Enter a password: ") 618 | password, err := terminal.ReadPassword(int(os.Stdin.Fd())) 619 | fmt.Println() 620 | if err != nil { 621 | return 622 | } 623 | hash, err = bcrypt.GenerateFromPassword(password, bcrypt.DefaultCost) 624 | return 625 | } 626 | 627 | const usage = `usage: river [-cert file] [-key file] [-port port] directory 628 | 629 | river serves the music in the given directory. The music can be accessed via a 630 | client on port 21313, or on the port named by the -port flag. If the -cert and 631 | -key flags are specified, river will listen for HTTPS connections; otherwise, 632 | river will listen for HTTP connections.` 633 | 634 | func main() { 635 | fcert := flag.String(fcertName, "", "the TLS certificate to use") 636 | fkey := flag.String(fkeyName, "", "the TLS key to use") 637 | fport := flag.Uint(fportName, 21313, "the port to listen on") 638 | flag.Usage = func() { 639 | fmt.Fprintln(os.Stderr, usage) 640 | } 641 | flag.Parse() 642 | args := flag.Args() 643 | if len(args) != 1 { 644 | flag.Usage() 645 | os.Exit(1) 646 | } 647 | libraryPath := args[0] 648 | fcertSet := false 649 | fkeySet := false 650 | flag.Visit(func(f *flag.Flag) { 651 | if f.Name == fcertName { 652 | fcertSet = true 653 | } 654 | if f.Name == fkeyName { 655 | fkeySet = true 656 | } 657 | }) 658 | if (fcertSet && !fkeySet) || (!fcertSet && fkeySet) { 659 | flag.Usage() 660 | os.Exit(1) 661 | } 662 | noTLS := !fcertSet && !fkeySet 663 | if noTLS { 664 | log.Println("no TLS files specified: connections are insecure!") 665 | } 666 | hash, err := getHash() 667 | if err != nil { 668 | log.Fatal(err) 669 | } 670 | os.Mkdir(streamDirPath, os.ModeDir) 671 | l, err := NewLibrary(libraryPath, hash) 672 | if err != nil { 673 | log.Fatal(err) 674 | } 675 | http.Handle("/", l) 676 | addr := fmt.Sprintf(":%d", *fport) 677 | if noTLS { 678 | err = http.ListenAndServe(addr, nil) 679 | } else { 680 | err = http.ListenAndServeTLS(addr, *fcert, *fkey, nil) 681 | } 682 | log.Fatal(err) 683 | } 684 | -------------------------------------------------------------------------------- /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 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 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 | {project} Copyright (C) {year} {fullname} 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 | 676 | --------------------------------------------------------------------------------