├── .gitignore ├── PKGBUILD ├── mpdfavd ├── gate.go ├── playcount_test.go ├── playlistgenerator.go ├── mpdfavd.go ├── playcount.go └── ratings.go ├── util.go ├── mpdfav-import ├── json.go ├── stickerdb.go ├── csv.go └── import.go ├── config.go ├── config_test.go ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /PKGBUILD: -------------------------------------------------------------------------------- 1 | # Maintainer: Vincent Petithory 2 | 3 | pkgname=mpdfav-git 4 | pkgver=r35.d7bc190 5 | pkgrel=1 6 | pkgdesc='Song playcounts and ratings for MPD' 7 | arch=('x86_64' 'i686' 'ARM') 8 | url='https://github.com/vincent-petithory/mpdfav' 9 | license=('GPL3') 10 | makedepends=('go' 'git') 11 | depends=('sqlite') 12 | optdepends=('mpd: for mpdfav to have a purpose') 13 | options=('!strip' '!emptydirs') 14 | source='git+https://github.com/vincent-petithory/mpdfav.git' 15 | md5sums=('SKIP') 16 | _gourl='github.com/vincent-petithory/mpdfav' 17 | 18 | pkgver() { 19 | cd "$srcdir/mpdfav" 20 | printf "r%s.%s" "$(git rev-list --count HEAD)" "$(git rev-parse --short HEAD)" 21 | } 22 | 23 | build() { 24 | p="$(dirname "${srcdir}/src/${_gourl}")" 25 | mkdir -p "$p" 26 | mv "$srcdir/mpdfav" "$p" 27 | export GOPATH="$srcdir" 28 | go get -v "${_gourl}/..." 29 | go install "${_gourl}/..." 30 | } 31 | 32 | package() { 33 | for b in mpdfavd mpdfav-import; do 34 | install -D -m755 "${srcdir}/bin/${b}" "${pkgdir}/usr/bin/${b}" 35 | done 36 | install -D -m644 "${srcdir}/src/${_gourl}/LICENSE" "${pkgdir}/usr/share/licenses/${pkgname}/LICENSE" 37 | } 38 | -------------------------------------------------------------------------------- /mpdfavd/gate.go: -------------------------------------------------------------------------------- 1 | /* Copyright (C) 2013 Vincent Petithory 2 | * 3 | * This file is part of mpdfav. 4 | * 5 | * mpdfav 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 | * mpdfav 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 mpdfav. If not, see . 17 | * 18 | */ 19 | 20 | package main 21 | 22 | type GateWaiter chan bool 23 | 24 | type Gate struct { 25 | waiters []GateWaiter 26 | opened bool 27 | } 28 | 29 | func (g Gate) Opened() bool { 30 | return g.opened 31 | } 32 | 33 | func (g *Gate) Waiter() GateWaiter { 34 | gw := make(GateWaiter) 35 | g.waiters = append(g.waiters, gw) 36 | return gw 37 | } 38 | 39 | func (g *Gate) Open() bool { 40 | if !g.opened { 41 | for _, waiter := range g.waiters { 42 | close(waiter) 43 | } 44 | g.opened = true 45 | } 46 | return g.opened 47 | } 48 | 49 | func NewGate() Gate { 50 | return Gate{make([]GateWaiter, 0), false} 51 | } 52 | -------------------------------------------------------------------------------- /util.go: -------------------------------------------------------------------------------- 1 | /* Copyright (C) 2013 Vincent Petithory 2 | * 3 | * This file is part of mpdfav. 4 | * 5 | * mpdfav 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 | * mpdfav 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 mpdfav. If not, see . 17 | * 18 | */ 19 | 20 | package mpdfav 21 | 22 | import ( 23 | . "github.com/vincent-petithory/mpdclient" 24 | "strconv" 25 | ) 26 | 27 | func AdjustIntStickerBy(mpdc *MPDClient, stickerName string, uri string, by int) (int, error) { 28 | value, err := mpdc.StickerGet( 29 | StickerSongType, 30 | uri, 31 | stickerName, 32 | ) 33 | if err != nil { 34 | return -1, err 35 | } 36 | if len(value) == 0 { 37 | value = "0" 38 | } 39 | intval, err := strconv.Atoi(value) 40 | if err != nil { 41 | return -1, err 42 | } 43 | newval := intval + by 44 | err = mpdc.StickerSet( 45 | StickerSongType, 46 | uri, 47 | stickerName, 48 | strconv.Itoa(newval), 49 | ) 50 | return newval, err 51 | } 52 | -------------------------------------------------------------------------------- /mpdfav-import/json.go: -------------------------------------------------------------------------------- 1 | /* Copyright (C) 2013 Vincent Petithory 2 | * 3 | * This file is part of mpdfav. 4 | * 5 | * mpdfav 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 | * mpdfav 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 mpdfav. If not, see . 17 | * 18 | */ 19 | 20 | package main 21 | 22 | import ( 23 | "encoding/json" 24 | . "github.com/vincent-petithory/mpdclient" 25 | "io" 26 | "io/ioutil" 27 | ) 28 | 29 | type JsonFeed struct { 30 | songStickers SongStickerList 31 | } 32 | 33 | func (feed *JsonFeed) Feed(ssCh chan SongSticker) error { 34 | defer close(ssCh) 35 | for _, ss := range feed.songStickers { 36 | ssCh <- ss 37 | } 38 | return nil 39 | } 40 | 41 | func (feed *JsonFeed) Close() error { 42 | return nil 43 | } 44 | 45 | func NewJsonFeed(r io.Reader) (SongStickerFeeder, error) { 46 | data, err := ioutil.ReadAll(r) 47 | if err != nil { 48 | return nil, err 49 | } 50 | var ssl SongStickerList 51 | err = json.Unmarshal(data, &ssl) 52 | if err != nil { 53 | return nil, err 54 | } 55 | return &JsonFeed{ssl}, nil 56 | } 57 | -------------------------------------------------------------------------------- /mpdfav-import/stickerdb.go: -------------------------------------------------------------------------------- 1 | /* Copyright (C) 2013 Vincent Petithory 2 | * 3 | * This file is part of mpdfav. 4 | * 5 | * mpdfav 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 | * mpdfav 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 mpdfav. If not, see . 17 | * 18 | */ 19 | 20 | package main 21 | 22 | import ( 23 | "database/sql" 24 | _ "github.com/mattn/go-sqlite3" 25 | . "github.com/vincent-petithory/mpdclient" 26 | ) 27 | 28 | type MPDStickerDBFeed struct { 29 | db *sql.DB 30 | } 31 | 32 | func (sd *MPDStickerDBFeed) Feed(ssCh chan SongSticker) error { 33 | rows, err := sd.db.Query("SELECT uri, name, value FROM sticker WHERE type='song'") 34 | if err != nil { 35 | return err 36 | } 37 | defer rows.Close() 38 | defer close(ssCh) 39 | 40 | for rows.Next() { 41 | var ss SongSticker 42 | rows.Scan(&ss.Uri, &ss.Name, &ss.Value) 43 | ssCh <- ss 44 | } 45 | return nil 46 | } 47 | 48 | func (sd *MPDStickerDBFeed) Close() error { 49 | return sd.db.Close() 50 | } 51 | 52 | func NewMPDStickerDBFeed(filepath string) (SongStickerFeeder, error) { 53 | db, err := sql.Open("sqlite3", filepath) 54 | if err != nil { 55 | return nil, err 56 | } 57 | err = db.Ping() 58 | if err != nil { 59 | return nil, err 60 | } 61 | return &MPDStickerDBFeed{db}, nil 62 | } 63 | -------------------------------------------------------------------------------- /mpdfavd/playcount_test.go: -------------------------------------------------------------------------------- 1 | /* Copyright (C) 2013 Vincent Petithory 2 | * 3 | * This file is part of mpdfav. 4 | * 5 | * mpdfav 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 | * mpdfav 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 mpdfav. If not, see . 17 | * 18 | */ 19 | 20 | package main 21 | 22 | import ( 23 | "testing" 24 | ) 25 | 26 | func TestConsiderSongPlayed(t *testing.T) { 27 | type CueTest struct { 28 | SongCues 29 | Precision uint 30 | Satisfy bool 31 | } 32 | cues := make(SongCues, 0) 33 | for i := 0.0; i < 1.0; i += 0.02 { 34 | cues = append(cues, float32(i)) 35 | } 36 | tests := []CueTest{ 37 | CueTest{ 38 | SongCues{ 39 | 0.01, 0.1, 0.3, 0.4, 0.5, 0.7, 0.9, 40 | }, 41 | 4, true, 42 | }, 43 | CueTest{ 44 | SongCues{ 45 | 0.01, 0.1, 0.8, 0.9, 46 | }, 47 | 4, false, 48 | }, 49 | CueTest{ 50 | SongCues{ 51 | 0.1, 0.2, 0.3, 52 | }, 53 | 4, false, 54 | }, 55 | CueTest{ 56 | SongCues{ 57 | 0.01, 0.4, 0.8, 58 | }, 59 | 4, false, 60 | }, 61 | CueTest{ 62 | cues, 63 | 4, true, 64 | }, 65 | } 66 | for _, test := range tests { 67 | satisfied := considerSongPlayed(test.SongCues, test.Precision) 68 | if test.Satisfy && !satisfied { 69 | t.Fatal("Expected cues to be satisfied, they weren't") 70 | } 71 | if !test.Satisfy && satisfied { 72 | t.Fatal("Expected cues to not be satisfied, they were") 73 | } 74 | } 75 | } 76 | -------------------------------------------------------------------------------- /mpdfav-import/csv.go: -------------------------------------------------------------------------------- 1 | /* Copyright (C) 2013 Vincent Petithory 2 | * 3 | * This file is part of mpdfav. 4 | * 5 | * mpdfav 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 | * mpdfav 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 mpdfav. If not, see . 17 | * 18 | */ 19 | 20 | package main 21 | 22 | import ( 23 | "encoding/csv" 24 | "fmt" 25 | . "github.com/vincent-petithory/mpdclient" 26 | "io" 27 | ) 28 | 29 | // CsvFeed implements importing song stickers from a csv file. 30 | // The csv file must use ',' as a separator, and contain 3 fields for each record. 31 | // With the records being uri, sticker name, sticker value, in that order. 32 | // The uri is, as usual, relative to the MPD music directory. 33 | type CsvFeed struct { 34 | r *csv.Reader 35 | } 36 | 37 | func (feed *CsvFeed) Feed(ssCh chan SongSticker) error { 38 | const NFields = 3 39 | defer close(ssCh) 40 | for { 41 | record, err := feed.r.Read() 42 | if err == io.EOF { 43 | return nil 44 | } 45 | if err != nil { 46 | return err 47 | } 48 | n := len(record) 49 | if n != NFields { 50 | return fmt.Errorf("Expected %d fields, got %d for field: \"%v\"", NFields, n, record) 51 | } 52 | songSticker := SongSticker{Uri: record[0], Name: record[1], Value: record[2]} 53 | ssCh <- songSticker 54 | } 55 | } 56 | 57 | func (feed *CsvFeed) Close() error { 58 | return nil 59 | } 60 | 61 | func NewCsvFeed(r io.Reader) (SongStickerFeeder, error) { 62 | // default csv decoder, using ',' as separator 63 | return &CsvFeed{r: csv.NewReader(r)}, nil 64 | } 65 | -------------------------------------------------------------------------------- /config.go: -------------------------------------------------------------------------------- 1 | /* Copyright (C) 2013 Vincent Petithory 2 | * 3 | * This file is part of mpdfav. 4 | * 5 | * mpdfav 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 | * mpdfav 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 mpdfav. If not, see . 17 | * 18 | */ 19 | 20 | package mpdfav 21 | 22 | import ( 23 | "bytes" 24 | "encoding/json" 25 | "io" 26 | "io/ioutil" 27 | ) 28 | 29 | type Config struct { 30 | PlaycountsEnabled bool 31 | MostPlayedPlaylistName string 32 | MostPlayedPlaylistLimit uint 33 | RatingsEnabled bool 34 | BestRatedPlaylistName string 35 | BestRatedPlaylistLimit uint 36 | MPDHost string 37 | MPDPort uint 38 | MPDPassword string 39 | } 40 | 41 | func DefaultConfig() *Config { 42 | c := Config{true, "Most Played", 50, true, "Best Rated", 50, "localhost", 6600, ""} 43 | return &c 44 | } 45 | 46 | func (c *Config) ReadFrom(r io.Reader) (n int64, err error) { 47 | data, err := ioutil.ReadAll(r) 48 | n = int64(len(data)) 49 | if err != nil { 50 | return 51 | } 52 | err = json.Unmarshal(data, c) 53 | return 54 | } 55 | 56 | func (c *Config) Read(p []byte) (n int, err error) { 57 | data, err := json.Marshal(c) 58 | p = data 59 | return len(p), err 60 | } 61 | 62 | func (c *Config) Write(p []byte) (n int, err error) { 63 | err = json.Unmarshal(p, c) 64 | return len(p), err 65 | } 66 | 67 | func (c *Config) WriteTo(w io.Writer) (n int64, err error) { 68 | data, err := json.Marshal(c) 69 | if err != nil { 70 | return int64(len(data)), err 71 | } 72 | // On writing to a Writer, it makes sense to 73 | // use a pretty-printed output 74 | var buf bytes.Buffer 75 | err = json.Indent(&buf, data, "", " ") 76 | if err != nil { 77 | return 0, err 78 | } 79 | buf.WriteByte('\n') 80 | n1, err := w.Write(buf.Bytes()) 81 | return int64(n1), err 82 | } 83 | -------------------------------------------------------------------------------- /mpdfavd/playlistgenerator.go: -------------------------------------------------------------------------------- 1 | /* Copyright (C) 2013 Vincent Petithory 2 | * 3 | * This file is part of mpdfav. 4 | * 5 | * mpdfav 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 | * mpdfav 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 mpdfav. If not, see . 17 | * 18 | */ 19 | 20 | package main 21 | 22 | import ( 23 | . "github.com/vincent-petithory/mpdclient" 24 | "log" 25 | "sort" 26 | "strconv" 27 | ) 28 | 29 | type songStickerChangeHandler func(SongSticker) 30 | 31 | func ListenSongStickerChange(songStickerChange chan SongSticker, handler songStickerChangeHandler) { 32 | for songSticker := range songStickerChange { 33 | handler(songSticker) 34 | } 35 | } 36 | 37 | func generatePlaylist(mpdc *MPDClient, stickerName string, playlistName string, max uint, descending bool) { 38 | log.Printf("playlist generator: regenerating %s\n", playlistName) 39 | err := mpdc.PlaylistClear(playlistName) 40 | if err != nil { 41 | log.Panic(err) 42 | } 43 | songStickers, err := mpdc.StickerFind(StickerSongType, "", stickerName) 44 | if err != nil { 45 | log.Panic(err) 46 | } 47 | sort.Sort(sort.Reverse(songStickers)) 48 | for i, songSticker := range songStickers { 49 | _, err = strconv.Atoi(songSticker.Value) 50 | if err != nil { 51 | continue 52 | } 53 | mpdc.PlaylistAdd(playlistName, songSticker.Uri) 54 | if uint(i+1) >= max { 55 | break 56 | } 57 | } 58 | } 59 | 60 | func generateBestRatedSongs(mpdc *MPDClient, playlistName string, max uint) songStickerChangeHandler { 61 | f := func(songSticker SongSticker) { 62 | generatePlaylist(mpdc, songSticker.Name, playlistName, max, true) 63 | } 64 | return songStickerChangeHandler(f) 65 | } 66 | 67 | func generateMostPlayedSongs(mpdc *MPDClient, playlistName string, max uint) songStickerChangeHandler { 68 | f := func(songSticker SongSticker) { 69 | generatePlaylist(mpdc, songSticker.Name, playlistName, max, true) 70 | } 71 | return songStickerChangeHandler(f) 72 | } 73 | -------------------------------------------------------------------------------- /config_test.go: -------------------------------------------------------------------------------- 1 | /* Copyright (C) 2013 Vincent Petithory 2 | * 3 | * This file is part of mpdfav. 4 | * 5 | * mpdfav 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 | * mpdfav 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 mpdfav. If not, see . 17 | * 18 | */ 19 | 20 | package mpdfav 21 | 22 | import ( 23 | "bytes" 24 | "testing" 25 | ) 26 | 27 | func TestConfig(t *testing.T) { 28 | c := DefaultConfig() 29 | expectedConfig := Config{false, "Most Played", 30, true, "Best Songs", 20, "192.168.0.255", 6601, "guessme"} 30 | 31 | // var buf bytes.Buffer 32 | var jsonBlob = []byte(`{ 33 | "PlaycountsEnabled": false, 34 | "MostPlayedPlaylistName": "Most Played", 35 | "MostPlayedPlaylistLimit": 30, 36 | "RatingsEnabled": true, 37 | "BestRatedPlaylistName": "Best Songs", 38 | "BestRatedPlaylistLimit": 20, 39 | "MPDHost": "192.168.0.255", 40 | "MPDPort": 6601, 41 | "MPDPassword": "guessme" 42 | }`) 43 | 44 | _, err := c.Write(jsonBlob) 45 | if err != nil { 46 | t.Fatal(err) 47 | } 48 | if *c != expectedConfig { 49 | t.Fatalf("Expected %v, got %v\n", expectedConfig, *c) 50 | } 51 | } 52 | 53 | func TestIncompleteConfig(t *testing.T) { 54 | c := DefaultConfig() 55 | expectedConfig := DefaultConfig() 56 | expectedConfig.PlaycountsEnabled = false 57 | expectedConfig.MPDHost = "192.168.0.255" 58 | 59 | var jsonBlob = []byte(`{ 60 | "PlaycountsEnabled": false, 61 | "MPDHost": "192.168.0.255" 62 | }`) 63 | 64 | _, err := c.Write(jsonBlob) 65 | if err != nil { 66 | t.Fatal(err) 67 | } 68 | if *c != *expectedConfig { 69 | t.Fatalf("Expected %v, got %v\n", expectedConfig, *c) 70 | } 71 | } 72 | 73 | func TestFullCycleReadWrite(t *testing.T) { 74 | var jsonBlob = []byte(`{ 75 | "MostPlayedPlaylistName": "Listen to this", 76 | "MPDHost": "192.168.0.255" 77 | }`) 78 | 79 | c1 := DefaultConfig() 80 | c1.MPDPassword = "random" 81 | c1.Write(jsonBlob) 82 | 83 | var buf bytes.Buffer 84 | c1.WriteTo(&buf) 85 | 86 | c2 := DefaultConfig() 87 | c2.ReadFrom(&buf) 88 | if *c1 != *c2 { 89 | t.Fatalf("%v and %v do not match\n", c1, c2) 90 | } 91 | } 92 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # mpdfav -- Song playcounts and ratings out-of-the-box for MPD. 2 | 3 | mpdfav provides auto-generated playlists from your music habits. Most played and Best rated playlists are currently available. 4 | 5 | While playcounts are of course automatic, ratings are up to you. 6 | 7 | Ratings in mpdfav are *not* the usual 0-5 stars. Instead, you vote "like" or "dislike" at the moment you hear a song, which will raise or lower the rating of that song. The more you listen and rate, the better mpdfav gets to know you! 8 | This approach has the advantage to be lightweight: you don't need to browse your music library and rate all those songs, and do that again later when your music tastes changes. 9 | Also, when your tastes change, you won't need to lower the 5 stars songs you liked previously best. The new songs you'll listen to and rate over time will seamlessly get their deserved rank. 10 | 11 | `mpdfav` makes use of MPD stickers to store its data. 12 | 13 | # Installation 14 | 15 | 1. [Install Go](http://golang.org/doc/install) if you didn't yet. 16 | 2. Install mpdfav and its dependancies: 17 | 18 | go get github.com/vincent-petithory/mpdfav/mpdfavd 19 | # if you also want the import utility (see below) 20 | go get github.com/vincent-petithory/mpdfav/mpdfav-import 21 | 22 | # Usage 23 | 24 | Start mpdfavd: 25 | 26 | mpdfavd 27 | 28 | If this is your first time running, it will create a default config in `$HOME/.mpdfav.json`: 29 | 30 | { 31 | "PlaycountsEnabled": true, 32 | "MostPlayedPlaylistName": "Most Played", 33 | "MostPlayedPlaylistLimit": 80, 34 | "RatingsEnabled": true, 35 | "BestRatedPlaylistName": "Best Rated", 36 | "BestRatedPlaylistLimit": 50, 37 | "MPDHost": "localhost", 38 | "MPDPort": 6600, 39 | "MPDPassword": "" 40 | } 41 | 42 | Adapt to your needs and re-run `mpdfavd`. Done. 43 | 44 | The last thing you need to know is how to rate a song. For that you need `mpc`, the command-line `mpd` client. 45 | 46 | # rate good the current song 47 | mpc sendmessage ratings like 48 | # or 49 | mpc sendmessage ratings + 50 | 51 | # rate bad a song 52 | mpc sendmessage ratings dislike 53 | # or 54 | mpc sendmessage ratings - 55 | 56 | Setting global key-bindings to 2 of those commands is recommended. 57 | 58 | ## Import from your previous music player 59 | 60 | In case you could dump playcounts / ratings from your previous music player, you can import them in mpdfav, with `mpdfav-import`. 61 | `mpdfav-import` uses the same config file than `mpdfavd`. 62 | For now it knows how to import from the formats below. 63 | 64 | * Another MPD sticker DB. 65 | * JSON; see below. 66 | * csv. 67 | 68 | In all file formats, the URIs of the songs are relative to your MPD music directory. 69 | 70 | ### JSON format 71 | 72 | Here's an example of a file format: 73 | 74 | [ 75 | { 76 | "Uri": "track-01.ogg", 77 | "Name": "playcount", 78 | "Value": "1" 79 | }, 80 | { 81 | "Uri": "path/to/yet/another/song.mp3", 82 | "Name": "playcount", 83 | "Value": "4" 84 | }, 85 | { 86 | "Uri": "path/to/another/track-02.ogg", 87 | "Name": "rating", 88 | "Value": "2" 89 | } 90 | ] 91 | 92 | ### CSV format 93 | 94 | This looks like the following: 95 | 96 | track-01.ogg,playcount,1 97 | path/to/yet/another/song.mp3,playcount,4 98 | path/to/another/track-02.ogg,rating,2 99 | 100 | # Things to improve 101 | 102 | ## mpdfavd 103 | 104 | * Limit ratings to one rating per song per client, if possible. (Currently no way to identify clients who sent a rating, since we use mpd channels) 105 | 106 | -------------------------------------------------------------------------------- /mpdfavd/mpdfavd.go: -------------------------------------------------------------------------------- 1 | /* Copyright (C) 2013 Vincent Petithory 2 | * 3 | * This file is part of mpdfav. 4 | * 5 | * mpdfav 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 | * mpdfav 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 mpdfav. If not, see . 17 | * 18 | */ 19 | 20 | package main 21 | 22 | import ( 23 | "flag" 24 | "fmt" 25 | . "github.com/vincent-petithory/mpdclient" 26 | . "github.com/vincent-petithory/mpdfav" 27 | "log" 28 | "os" 29 | "path/filepath" 30 | "sync" 31 | ) 32 | 33 | var ( 34 | defaultConfigFile string = os.ExpandEnv("$HOME/.mpdfav.json") 35 | configFile string 36 | conf *Config 37 | ) 38 | 39 | func startMpdService(mpdc *MPDClient, service func(*MPDClient, []chan SongSticker, chan bool), songStickerChangeHandlers []songStickerChangeHandler, wg *sync.WaitGroup, gate *Gate) { 40 | wg.Add(len(songStickerChangeHandlers)) 41 | channels := make([]chan SongSticker, len(songStickerChangeHandlers)) 42 | for i, songStickerChangeHandler := range songStickerChangeHandlers { 43 | ch := make(chan SongSticker) 44 | channels[i] = ch 45 | handler := songStickerChangeHandler 46 | go func() { 47 | defer wg.Done() 48 | ListenSongStickerChange(ch, handler) 49 | }() 50 | } 51 | wg.Add(1) 52 | go func() { 53 | defer func() { 54 | for i, _ := range channels { 55 | close(channels[i]) 56 | } 57 | // Notify all services to shutdown 58 | gate.Open() 59 | wg.Done() 60 | }() 61 | service(mpdc, channels, gate.Waiter()) 62 | }() 63 | } 64 | 65 | func startMpdServices() { 66 | var wg sync.WaitGroup 67 | 68 | var mpdc *MPDClient 69 | var err error 70 | if conf.MPDPassword != "" { 71 | mpdc, err = ConnectAuth(conf.MPDHost, conf.MPDPort, conf.MPDPassword) 72 | } else { 73 | mpdc, err = Connect(conf.MPDHost, conf.MPDPort) 74 | } 75 | if err != nil { 76 | log.Fatal(err) 77 | } 78 | defer mpdc.Close() 79 | 80 | gate := NewGate() 81 | 82 | if conf.PlaycountsEnabled { 83 | startMpdService(mpdc, RecordPlayCounts, []songStickerChangeHandler{generateMostPlayedSongs(mpdc, conf.MostPlayedPlaylistName, conf.MostPlayedPlaylistLimit)}, &wg, &gate) 84 | log.Println("Started Playcounts service...") 85 | } 86 | if conf.RatingsEnabled { 87 | startMpdService(mpdc, ListenRatings, []songStickerChangeHandler{generateBestRatedSongs(mpdc, conf.BestRatedPlaylistName, conf.BestRatedPlaylistLimit)}, &wg, &gate) 88 | log.Println("Started Ratings service...") 89 | } 90 | wg.Wait() 91 | } 92 | 93 | func init() { 94 | log.SetFlags(log.LstdFlags | log.Lmicroseconds | log.Lshortfile) 95 | flag.StringVar(&configFile, "config-file", defaultConfigFile, fmt.Sprintf("Use this config file instead of %s", defaultConfigFile)) 96 | } 97 | 98 | func main() { 99 | conf = DefaultConfig() 100 | flag.Parse() 101 | f, err := os.Open(configFile) 102 | if err != nil { 103 | if configFile == defaultConfigFile { 104 | log.Println("Default config file not found") 105 | log.Printf("Writing default config in %s\n", defaultConfigFile) 106 | df, err := os.OpenFile(defaultConfigFile, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0600) 107 | if err != nil { 108 | log.Fatal(err) 109 | } 110 | conf.WriteTo(df) 111 | df.Close() 112 | log.Printf("Please edit and restart %s\n", filepath.Base(os.Args[0])) 113 | os.Exit(0) 114 | } else { 115 | log.Fatal(err) 116 | } 117 | } else { 118 | n, err := conf.ReadFrom(f) 119 | if err != nil { 120 | log.Fatal(err) 121 | } 122 | if n == 0 { 123 | log.Fatalf("No data could be read from %s\n", configFile) 124 | } 125 | f.Close() 126 | } 127 | 128 | for { 129 | startMpdServices() 130 | log.Println("Restarting...") 131 | } 132 | } 133 | -------------------------------------------------------------------------------- /mpdfavd/playcount.go: -------------------------------------------------------------------------------- 1 | /* Copyright (C) 2013 Vincent Petithory 2 | * 3 | * This file is part of mpdfav. 4 | * 5 | * mpdfav 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 | * mpdfav 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 mpdfav. If not, see . 17 | * 18 | */ 19 | 20 | package main 21 | 22 | import ( 23 | . "github.com/vincent-petithory/mpdclient" 24 | . "github.com/vincent-petithory/mpdfav" 25 | "log" 26 | "strconv" 27 | "time" 28 | ) 29 | 30 | const ( 31 | songPlayedPrecision = 4 // Number of uniformly distributed cue points to statisfy 32 | tickMillis = 900 33 | PlaycountSticker = "playcount" 34 | ) 35 | 36 | type SongCues []float32 37 | 38 | type songStatusInfo struct { 39 | StatusInfo Info 40 | SongInfo Info 41 | SongCues SongCues 42 | } 43 | 44 | func incSongPlayCount(songInfo *Info, mpdc *MPDClient) (int, error) { 45 | newval, err := AdjustIntStickerBy(mpdc, PlaycountSticker, (*songInfo)["file"], 1) 46 | if err != nil { 47 | return -1, err 48 | } 49 | return newval, err 50 | } 51 | 52 | func considerSongPlayed(songCues SongCues, precision uint) bool { 53 | var cueStep float32 = 1.0 / (float32(precision) + 1.0) 54 | var curCue float32 = cueStep 55 | for _, cue := range songCues { 56 | for curCue < cue && cue < curCue+cueStep { 57 | curCue += cueStep 58 | } 59 | if curCue >= 1.0 { 60 | return true 61 | } 62 | } 63 | return false 64 | } 65 | 66 | func processStateUpdate(si *songStatusInfo, mpdc *MPDClient, channels []chan SongSticker) error { 67 | info, err := mpdc.Status() 68 | if err != nil { 69 | return err 70 | } 71 | 72 | if (*info)["songid"] != si.StatusInfo["songid"] { 73 | songPlayed := considerSongPlayed(si.SongCues, songPlayedPrecision) 74 | if songPlayed { 75 | playcount, err := incSongPlayCount(&si.SongInfo, mpdc) 76 | if err != nil { 77 | return err 78 | } 79 | 80 | songSticker := SongSticker{si.SongInfo["file"], PlaycountSticker, strconv.Itoa(playcount)} 81 | for _, channel := range channels { 82 | c := channel 83 | go func() { 84 | c <- songSticker 85 | }() 86 | } 87 | log.Printf("playcounts: %s playcount=%d\n", si.SongInfo["Title"], playcount) 88 | } 89 | si.SongCues = make(SongCues, 0) 90 | } else { 91 | current, total := si.StatusInfo.Progress() 92 | si.SongCues = append(si.SongCues, float32(current)/float32(total)) 93 | } 94 | si.StatusInfo = *info 95 | // We store the current song after processing, 96 | // since that should be the next song playing already. 97 | songInfo, err := mpdc.CurrentSong() 98 | if err != nil { 99 | return err 100 | } 101 | si.SongInfo = *songInfo 102 | if err != nil { 103 | return err 104 | } 105 | return nil 106 | } 107 | 108 | func RecordPlayCounts(mpdc *MPDClient, channels []chan SongSticker, quit chan bool) { 109 | defer func() { 110 | if err := recover(); err != nil { 111 | log.Printf("Panic in RecordPlayCounts: %s\n", err) 112 | } 113 | }() 114 | statusInfo, err := mpdc.Status() 115 | if err != nil { 116 | log.Panic(err) 117 | } 118 | songInfo, err := mpdc.CurrentSong() 119 | if err != nil { 120 | log.Panic(err) 121 | } 122 | 123 | si := songStatusInfo{*statusInfo, *songInfo, make([]float32, 0)} 124 | 125 | idleSub := mpdc.Idle("player") 126 | pollCh := time.Tick(tickMillis * time.Millisecond) 127 | ignorePoll := si.StatusInfo["state"] != "play" 128 | 129 | for { 130 | select { 131 | case <-pollCh: 132 | if !ignorePoll { 133 | err = processStateUpdate(&si, mpdc, channels) 134 | if err != nil { 135 | log.Panic(err) 136 | } 137 | } 138 | case <-idleSub.Ch: 139 | err := processStateUpdate(&si, mpdc, channels) 140 | if err != nil { 141 | log.Panic(err) 142 | } 143 | 144 | // Suspend poll goroutine if player is stopped or paused 145 | ignorePoll = si.StatusInfo["state"] != "play" 146 | case <-quit: 147 | return 148 | } 149 | } 150 | } 151 | -------------------------------------------------------------------------------- /mpdfavd/ratings.go: -------------------------------------------------------------------------------- 1 | /* Copyright (C) 2013 Vincent Petithory 2 | * 3 | * This file is part of mpdfav. 4 | * 5 | * mpdfav 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 | * mpdfav 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 mpdfav. If not, see . 17 | * 18 | */ 19 | 20 | package main 21 | 22 | import ( 23 | "errors" 24 | . "github.com/vincent-petithory/mpdclient" 25 | . "github.com/vincent-petithory/mpdfav" 26 | "log" 27 | "strconv" 28 | ) 29 | 30 | const ( 31 | RatingSticker = "rating" 32 | RatingsChannel = "ratings" 33 | ) 34 | 35 | var ErrInvalidRatingCode = errors.New("ratings: invalid rating code") 36 | 37 | func rateSong(songInfo *Info, rateMsg string, mpdc *MPDClient) (int, error) { 38 | // fail fast if the rateMsg is invalid 39 | var val int 40 | switch rateMsg { 41 | case "+": 42 | fallthrough 43 | case "like": 44 | val = 1 45 | case "-": 46 | fallthrough 47 | case "dislike": 48 | val = -1 49 | default: 50 | val = 0 51 | } 52 | if val == 0 { 53 | return -1, ErrInvalidRatingCode 54 | } 55 | 56 | newval, err := AdjustIntStickerBy(mpdc, RatingSticker, (*songInfo)["file"], val) 57 | if err != nil { 58 | return -1, err 59 | } 60 | return newval, err 61 | } 62 | 63 | func ListenRatings(mpdc *MPDClient, channels []chan SongSticker, quit chan bool) { 64 | defer func() { 65 | if err := recover(); err != nil { 66 | log.Printf("Panic in ListenRatings: %s\n", err) 67 | } 68 | }() 69 | err := mpdc.Subscribe(RatingsChannel) 70 | if err != nil { 71 | log.Panic(err) 72 | } 73 | 74 | statusInfo, err := mpdc.Status() 75 | if err != nil { 76 | log.Panic(err) 77 | } 78 | currentSongId := (*statusInfo)["songid"] 79 | 80 | clientsSentRating := make([]string, 0) 81 | 82 | msgsCh := make(chan ChannelMessage) 83 | playerCh := make(chan Info) 84 | 85 | go func() { 86 | idleSub := mpdc.Idle("message", "player") 87 | for { 88 | subsystem := <-idleSub.Ch 89 | switch subsystem { 90 | case "message": 91 | msgs, err := mpdc.ReadMessages() 92 | if err != nil { 93 | log.Panic(err) 94 | } else { 95 | for _, msg := range msgs { 96 | msgsCh <- msg 97 | } 98 | } 99 | case "player": 100 | statusInfo, err := mpdc.Status() 101 | if err != nil { 102 | log.Panic(err) 103 | } else { 104 | playerCh <- *statusInfo 105 | } 106 | } 107 | } 108 | }() 109 | 110 | for { 111 | select { 112 | case channelMessage := <-msgsCh: 113 | log.Println("Ratings: incoming message", channelMessage) 114 | if channelMessage.Channel != RatingsChannel { 115 | break 116 | } 117 | 118 | // FIXME find a way to Uidentify a client submitting a rating 119 | thisClientId := "0" 120 | clientExists := false 121 | for _, clientId := range clientsSentRating { 122 | if thisClientId == clientId { 123 | clientExists = true 124 | break 125 | } 126 | } 127 | if !clientExists { 128 | songInfo, err := mpdc.CurrentSong() 129 | if err == nil { 130 | if rating, err := rateSong(songInfo, channelMessage.Message, mpdc); err == nil { 131 | clientsSentRating = append(clientsSentRating, thisClientId) 132 | log.Printf("Ratings: %s rating=%d\n", (*songInfo)["Title"], rating) 133 | songSticker := SongSticker{(*songInfo)["file"], RatingSticker, strconv.Itoa(rating)} 134 | for _, channel := range channels { 135 | c := channel 136 | go func() { 137 | c <- songSticker 138 | }() 139 | } 140 | } else if err == ErrInvalidRatingCode { 141 | log.Println(err) 142 | } else { 143 | log.Panic(err) 144 | } 145 | } else { 146 | log.Panic(err) 147 | } 148 | } else { 149 | log.Printf("Client %s already rated\n", thisClientId) 150 | } 151 | case statusInfo := <-playerCh: 152 | if currentSongId != statusInfo["songid"] { 153 | clientsSentRating = make([]string, 0) 154 | } 155 | case <-quit: 156 | return 157 | } 158 | } 159 | } 160 | -------------------------------------------------------------------------------- /mpdfav-import/import.go: -------------------------------------------------------------------------------- 1 | /* Copyright (C) 2013 Vincent Petithory 2 | * 3 | * This file is part of mpdfav. 4 | * 5 | * mpdfav 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 | * mpdfav 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 mpdfav. If not, see . 17 | * 18 | */ 19 | 20 | package main 21 | 22 | import ( 23 | "flag" 24 | "fmt" 25 | . "github.com/vincent-petithory/mpdclient" 26 | . "github.com/vincent-petithory/mpdfav" 27 | "log" 28 | "os" 29 | "strconv" 30 | "sync" 31 | ) 32 | 33 | const ( 34 | FORMAT_MPD_STICKER_DB = "stickerdb" 35 | FORMAT_JSON = "json" 36 | FORMAT_CSV = "csv" 37 | ) 38 | 39 | var showHelp = flag.Bool("help", false, "Displays this help message.") 40 | var format = flag.String("format", FORMAT_MPD_STICKER_DB, fmt.Sprintf("Format of the data FILE. Valid values are: \"%s\", \"%s\", \"%s\".", FORMAT_MPD_STICKER_DB, FORMAT_JSON, FORMAT_CSV)) 41 | 42 | var ( 43 | defaultConfigFile string = os.ExpandEnv("$HOME/.mpdfav.json") 44 | configFile string 45 | conf *Config 46 | ) 47 | 48 | func ImportSongSticker(mpdc *MPDClient, ss SongSticker) error { 49 | val, err := strconv.Atoi(ss.Value) 50 | if err != nil { 51 | return err 52 | } 53 | _, err = AdjustIntStickerBy(mpdc, ss.Name, ss.Uri, val) 54 | return err 55 | } 56 | 57 | type SongStickerFeeder interface { 58 | Feed(ssCh chan SongSticker) error 59 | Close() error 60 | } 61 | 62 | func PrintHelp() { 63 | fmt.Fprintf(os.Stderr, `Usage: %s [OPTION] [FILE] 64 | Imports MPD sticker data from a source FILE of songs' sticker-like data. 65 | 66 | Options: 67 | `, os.Args[0]) 68 | flag.PrintDefaults() 69 | fmt.Fprintln(os.Stderr) 70 | } 71 | 72 | func init() { 73 | flag.StringVar(&configFile, "config-file", defaultConfigFile, fmt.Sprintf("Use this config file instead of %s", defaultConfigFile)) 74 | } 75 | 76 | func main() { 77 | conf = DefaultConfig() 78 | flag.Parse() 79 | if *showHelp { 80 | PrintHelp() 81 | os.Exit(0) 82 | } 83 | 84 | f, err := os.Open(configFile) 85 | if err != nil { 86 | log.Fatal(err) 87 | } else { 88 | n, err := conf.ReadFrom(f) 89 | if err != nil { 90 | log.Fatal(err) 91 | } 92 | if n == 0 { 93 | log.Fatalf("No data could be read from %s\n", configFile) 94 | } 95 | f.Close() 96 | } 97 | 98 | filepath := flag.Arg(0) 99 | if filepath == "" { 100 | PrintHelp() 101 | os.Exit(1) 102 | } 103 | 104 | // Create mpd client 105 | var mpdc *MPDClient 106 | if conf.MPDPassword != "" { 107 | mpdc, err = ConnectAuth(conf.MPDHost, conf.MPDPort, conf.MPDPassword) 108 | } else { 109 | mpdc, err = Connect(conf.MPDHost, conf.MPDPort) 110 | } 111 | if err != nil { 112 | log.Fatal(err) 113 | } 114 | defer mpdc.Close() 115 | 116 | // Create a feeder 117 | var feeder SongStickerFeeder 118 | switch *format { 119 | case FORMAT_MPD_STICKER_DB: 120 | feeder, err = NewMPDStickerDBFeed(filepath) 121 | if err != nil { 122 | log.Fatal(err) 123 | } 124 | case FORMAT_JSON: 125 | f, err = os.Open(filepath) 126 | if err != nil { 127 | log.Fatal(err) 128 | } 129 | defer f.Close() 130 | feeder, err = NewJsonFeed(f) 131 | if err != nil { 132 | log.Fatal(err) 133 | } 134 | case FORMAT_CSV: 135 | f, err = os.Open(filepath) 136 | if err != nil { 137 | log.Fatal(err) 138 | } 139 | defer f.Close() 140 | feeder, err = NewCsvFeed(f) 141 | if err != nil { 142 | log.Fatal(err) 143 | } 144 | default: 145 | PrintHelp() 146 | log.Fatalf("Invalid format %s\n", *format) 147 | 148 | } 149 | 150 | ssCh := make(chan SongSticker) 151 | defer feeder.Close() 152 | go feeder.Feed(ssCh) 153 | 154 | var wg sync.WaitGroup 155 | for ss := range ssCh { 156 | wg.Add(1) 157 | go func(ss SongSticker) { 158 | defer wg.Done() 159 | err := ImportSongSticker(mpdc, ss) 160 | switch err { 161 | case nil: 162 | fmt.Printf("[ OK ] %s: imported sticker « %s »\n", ss.Uri, ss.Name) 163 | case err.(*MPDError): 164 | fmt.Printf("[SKIP] %s: %s\n", ss.Uri, err) 165 | default: 166 | fmt.Printf("[ERR ] %v", err) 167 | } 168 | }(ss) 169 | } 170 | wg.Wait() 171 | } 172 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------