├── .gitignore ├── .travis.yml ├── fs_helpers.go ├── README.md ├── event_handlers.go ├── main_buckets_ui.go ├── byte_conversions.go ├── main.go ├── bucket_explorer_ui.go ├── s3_tree.go ├── session.go ├── ui_objects.go └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | # Binaries for programs and plugins 2 | *.exe 3 | *.exe~ 4 | *.dll 5 | *.so 6 | *.dylib 7 | 8 | # Test binary, build with `go test -c` 9 | *.test 10 | 11 | # Output of the go coverage tool, specifically when used with LiteIDE 12 | *.out 13 | debug.log 14 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: go 2 | 3 | go: 4 | - 1.10.x 5 | 6 | before_install: 7 | - go get -t ./... 8 | 9 | install: 10 | - go get github.com/mitchellh/gox 11 | 12 | script: 13 | - gox -os="linux windows" -arch="amd64" -output="./build/{{.Dir}}-{{.OS}}-{{.Arch}}" 14 | - gox -os="darwin" -arch="amd64" -output="./build/{{.Dir}}-macOS-{{.Arch}}" 15 | 16 | deploy: 17 | - provider: releases 18 | file_glob: true 19 | skip_cleanup: true 20 | api_key: "${GITHUB_TOKEN}" 21 | file: "./build/*" 22 | on: 23 | tags: true 24 | -------------------------------------------------------------------------------- /fs_helpers.go: -------------------------------------------------------------------------------- 1 | /** 2 | This file is part of s3explorer. 3 | 4 | s3explorer is free software: you can redistribute it and/or modify 5 | it under the terms of the GNU General Public License as published by 6 | the Free Software Foundation, either version 3 of the License, or 7 | (at your option) any later version. 8 | 9 | s3explorer is distributed in the hope that it will be useful, 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | GNU General Public License for more details. 13 | 14 | You should have received a copy of the GNU General Public License 15 | along with s3explorer. If not, see . 16 | **/ 17 | 18 | package main 19 | 20 | import "os" 21 | 22 | func FileExists(path string) bool { 23 | 24 | // Return true if file exists on system 25 | 26 | if _, err := os.Stat(logFile); err == nil { 27 | return true 28 | } 29 | return false 30 | } 31 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # s3explorer 2 | Terminal Based S3 File Explorer 3 | 4 | ### Download 5 | 6 | There are pre-compiled binaries in the [releases](https://github.com/tinyzimmer/s3explorer/releases) section. 7 | 8 | #### AWS Credentials 9 | 10 | - Refer to the AWS documentation to configure your credentials. 11 | `s3explorer` loads credentials in the following order: 12 | - Environment credentials 13 | - Shared credentials file (e.g. `$HOME/.aws/credentials`) 14 | - EC2 Instance Profile 15 | 16 | ### Building From Source 17 | 18 | 19 | **Dependencies** 20 | - github.com/aws/aws-sdk-go 21 | - github.com/gizak/termui 22 | 23 | 24 | ```bash 25 | # Using `go get` 26 | $> go get github.com/aws/aws-sdk-go 27 | $> go get github.com/gizak/termui 28 | $> go get github.com/tinyzimmer/s3explorer 29 | 30 | # From git or source code tarball 31 | # ensure dependencies as listed above 32 | $> git clone https://github.com/tinyzimmer/s3explorer # or download archive 33 | $> cd s3explorer 34 | $> go build . 35 | ``` 36 | 37 | ### Usage 38 | 39 | ```bash 40 | $> s3explorer <-d [debug file]> 41 | ``` 42 | 43 | The program will list all of the S3 Buckets you have access to and present them in a file explorer format. You can descend into the buckets and directories therein with your keyboard. 44 | -------------------------------------------------------------------------------- /event_handlers.go: -------------------------------------------------------------------------------- 1 | /** 2 | This file is part of s3explorer. 3 | 4 | s3explorer is free software: you can redistribute it and/or modify 5 | it under the terms of the GNU General Public License as published by 6 | the Free Software Foundation, either version 3 of the License, or 7 | (at your option) any later version. 8 | 9 | s3explorer is distributed in the hope that it will be useful, 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | GNU General Public License for more details. 13 | 14 | You should have received a copy of the GNU General Public License 15 | along with s3explorer. If not, see . 16 | **/ 17 | 18 | package main 19 | 20 | import ( 21 | "fmt" 22 | "log" 23 | "os" 24 | 25 | "github.com/gizak/termui" 26 | ) 27 | 28 | func SetDefaultHandlers(exitFunc func()) { 29 | 30 | // Always set "q" to exit with any relevant deferred functions 31 | 32 | SetExitHandler(exitFunc) 33 | } 34 | 35 | func SetExitHandler(exitFunc func()) { 36 | 37 | // Run a prepared function and exit the program 38 | 39 | termui.Handle("/sys/kbd/q", func(termui.Event) { 40 | log.Println("Received User Requested Exit") 41 | log.Println("Running extra handlers") 42 | exitFunc() 43 | log.Println("Stopping Event loop") 44 | termui.StopLoop() 45 | fmt.Println() 46 | os.Exit(EXIT_USER_REQUESTED) 47 | }) 48 | } 49 | 50 | func SetBackHandler(runFuncs ...func()) { 51 | 52 | // Set the back handler to a prepared function 53 | 54 | termui.Handle("/sys/kbd/b", func(termui.Event) { 55 | log.Println("Received request, running handlers") 56 | for _, runFunc := range runFuncs { 57 | runFunc() 58 | } 59 | }) 60 | } 61 | -------------------------------------------------------------------------------- /main_buckets_ui.go: -------------------------------------------------------------------------------- 1 | /** 2 | This file is part of s3explorer. 3 | 4 | s3explorer is free software: you can redistribute it and/or modify 5 | it under the terms of the GNU General Public License as published by 6 | the Free Software Foundation, either version 3 of the License, or 7 | (at your option) any later version. 8 | 9 | s3explorer is distributed in the hope that it will be useful, 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | GNU General Public License for more details. 13 | 14 | You should have received a copy of the GNU General Public License 15 | along with s3explorer. If not, see . 16 | **/ 17 | 18 | package main 19 | 20 | import ( 21 | "os" 22 | 23 | "github.com/gizak/termui" 24 | ) 25 | 26 | func RenderBucketListing(buckets []BucketWithDisplay) { 27 | 28 | // Set the selection pointer 29 | 30 | var selection int 31 | selection = 0 32 | 33 | // Create a UI ready list and render 34 | 35 | list := CreateBucketList(buckets, selection) 36 | termui.Render(list, RenderHelp()) 37 | 38 | // up goes up 39 | 40 | termui.Handle("/sys/kbd/", func(termui.Event) { 41 | if selection == 0 { 42 | return 43 | } else { 44 | selection -= 1 45 | list := CreateBucketList(buckets, selection) 46 | termui.Render(list, RenderHelp()) 47 | } 48 | }) 49 | 50 | // down goes sideways 51 | 52 | termui.Handle("/sys/kbd/", func(termui.Event) { 53 | if selection == len(buckets)-1 { 54 | return 55 | } else { 56 | selection += 1 57 | list := CreateBucketList(buckets, selection) 58 | termui.Render(list, RenderHelp()) 59 | } 60 | }) 61 | 62 | // enter loads the bucket 63 | 64 | termui.Handle("/sys/kbd/", func(termui.Event) { 65 | termui.ResetHandlers() 66 | p := RenderMessage("Loading Bucket", buckets[selection].displayString) 67 | termui.Render(p) 68 | RenderBucketExplorer(buckets[selection]) 69 | }) 70 | 71 | } 72 | 73 | func ReloadMainBucketsWithError(err error) { 74 | 75 | // Render an error to the screen and reload the bucket listing 76 | 77 | RenderError(err.Error()) 78 | ReloadMainBuckets() 79 | } 80 | 81 | func ReloadMainBuckets() { 82 | 83 | // Retrieve a fresh bucket listing and reload main screen 84 | 85 | termui.ResetHandlers() 86 | SetDefaultHandlers(func() { return }) 87 | termui.Clear() 88 | buckets, err := s3Session.GetBucketWithDisplayStrings() 89 | if err != nil { 90 | os.Exit(EXIT_FAILED_BUCKET_LISTING) 91 | } 92 | RenderBucketListing(buckets) 93 | } 94 | -------------------------------------------------------------------------------- /byte_conversions.go: -------------------------------------------------------------------------------- 1 | /** 2 | This file is part of s3explorer. 3 | 4 | s3explorer is free software: you can redistribute it and/or modify 5 | it under the terms of the GNU General Public License as published by 6 | the Free Software Foundation, either version 3 of the License, or 7 | (at your option) any later version. 8 | 9 | s3explorer is distributed in the hope that it will be useful, 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | GNU General Public License for more details. 13 | 14 | You should have received a copy of the GNU General Public License 15 | along with s3explorer. If not, see . 16 | **/ 17 | 18 | package main 19 | 20 | import ( 21 | "log" 22 | "math" 23 | "strconv" 24 | ) 25 | 26 | func RoundUp(input float64, places int) (newVal float64) { 27 | var round float64 28 | pow := math.Pow(10, float64(places)) 29 | digit := pow * input 30 | round = math.Ceil(digit) 31 | newVal = round / pow 32 | return 33 | } 34 | 35 | func ByteFormat(inputNum float64, precision int) string { 36 | 37 | log.Printf("Formatting input %v to human readable with precision %v\n", inputNum, precision) 38 | 39 | if precision <= 0 { 40 | precision = 1 41 | } 42 | 43 | var unit string 44 | var returnVal float64 45 | 46 | if inputNum >= 1000000000000000000000000 { 47 | returnVal = RoundUp((inputNum / 1208925819614629174706176), precision) 48 | unit = " YB" // yottabyte 49 | } else if inputNum >= 1000000000000000000000 { 50 | returnVal = RoundUp((inputNum / 1180591620717411303424), precision) 51 | unit = " ZB" // zettabyte 52 | } else if inputNum >= 10000000000000000000 { 53 | returnVal = RoundUp((inputNum / 1152921504606846976), precision) 54 | unit = " EB" // exabyte 55 | } else if inputNum >= 1000000000000000 { 56 | returnVal = RoundUp((inputNum / 1125899906842624), precision) 57 | unit = " PB" // petabyte 58 | } else if inputNum >= 1000000000000 { 59 | returnVal = RoundUp((inputNum / 1099511627776), precision) 60 | unit = " TB" // terrabyte 61 | } else if inputNum >= 1000000000 { 62 | returnVal = RoundUp((inputNum / 1073741824), precision) 63 | unit = " GB" // gigabyte 64 | } else if inputNum >= 1000000 { 65 | returnVal = RoundUp((inputNum / 1048576), precision) 66 | unit = " MB" // megabyte 67 | } else if inputNum >= 1000 { 68 | returnVal = RoundUp((inputNum / 1024), precision) 69 | unit = " KB" // kilobyte 70 | } else { 71 | returnVal = inputNum 72 | unit = " B" // byte 73 | } 74 | 75 | return strconv.FormatFloat(returnVal, 'f', precision, 64) + unit 76 | 77 | } 78 | -------------------------------------------------------------------------------- /main.go: -------------------------------------------------------------------------------- 1 | /** 2 | This file is part of s3explorer. 3 | 4 | s3explorer is free software: you can redistribute it and/or modify 5 | it under the terms of the GNU General Public License as published by 6 | the Free Software Foundation, either version 3 of the License, or 7 | (at your option) any later version. 8 | 9 | s3explorer is distributed in the hope that it will be useful, 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | GNU General Public License for more details. 13 | 14 | You should have received a copy of the GNU General Public License 15 | along with s3explorer. If not, see . 16 | **/ 17 | 18 | package main 19 | 20 | import ( 21 | "flag" 22 | "fmt" 23 | "io" 24 | "log" 25 | "os" 26 | ) 27 | 28 | const ( 29 | VERSION = "v0.1" 30 | 31 | // Dump logs to /dev/null by default 32 | DEFAULT_LOG_FILE = os.DevNull 33 | 34 | // FS Options 35 | DEFAULT_DIRECTORY_MODE = 0755 36 | DEFAULT_FILE_MODE = 0644 37 | 38 | // Exit Codes 39 | EXIT_USER_REQUESTED = 0 // user exit 40 | EXIT_FAILED_NO_TERMINAL = 1 // termui.Init() failed 41 | EXIT_FAILED_NO_LOGGER = 2 // Unable to access log file or /dev/null 42 | EXIT_FAILED_AWS_CONNECT = 3 // Could not connect to AWS S3 API 43 | EXIT_FAILED_BUCKET_LISTING = 4 // Could not get initial bucket listing 44 | 45 | // UI Options 46 | RIGHT_BUFFER = 10 47 | LOWER_BUFFER = 10 48 | CHECK_TERM_SLEEP_INTERVAL = 1 49 | MIN_TERM_HEIGHT_REQUIRED = 15 50 | 51 | // AWS Options 52 | DEFAULT_REGION = "us-west-2" // Used for root-level ListBuckets operations 53 | ) 54 | 55 | var ( 56 | s3Session S3Session // initial s3 session 57 | localDelimiter string // local filesystem path delimiter 58 | logFile string // log file 59 | currentWorkingDir string // starting local working directory 60 | versionDump bool // version dump 61 | ) 62 | 63 | func dumpVersion() { 64 | 65 | // Print the version and exit 66 | 67 | fmt.Printf("s3explorer version: %s\n", VERSION) 68 | os.Exit(EXIT_USER_REQUESTED) 69 | } 70 | 71 | func init() { 72 | 73 | // Debug will print a chatty logfile 74 | 75 | flag.StringVar(&logFile, "d", DEFAULT_LOG_FILE, "Path to write debug logs") 76 | flag.BoolVar(&versionDump, "v", false, "Print version and exit") 77 | flag.Parse() 78 | 79 | if versionDump { 80 | dumpVersion() 81 | } 82 | 83 | var err error 84 | var logWriter io.Writer 85 | 86 | if FileExists(logFile) && logFile != os.DevNull { 87 | 88 | // Remove pre-existing log file if exists 89 | 90 | os.Remove(logFile) 91 | logWriter, err = os.Create(logFile) 92 | if err != nil { 93 | fmt.Printf("Error: Failed to create log file %s\n", logFile) 94 | os.Exit(EXIT_FAILED_NO_LOGGER) 95 | } 96 | 97 | } else { 98 | 99 | // Otherwise just open the log file 100 | 101 | logWriter, err = os.Create(logFile) 102 | if err != nil { 103 | fmt.Printf("Error: Failed to create log file %s\n", logFile) 104 | os.Exit(EXIT_FAILED_NO_LOGGER) 105 | } 106 | 107 | } 108 | 109 | // Set the logger 110 | log.SetOutput(logWriter) 111 | log.Println("Started Debug Log") 112 | 113 | // Get Current Working Directory if we can (we start here for saving files) 114 | 115 | currentWorkingDir, err = os.Getwd() 116 | if err != nil { 117 | log.Println("Error: (non-fatal) Could not get working directory") 118 | } else { 119 | log.Printf("Got current working directory: %s\n", currentWorkingDir) 120 | } 121 | 122 | // Create an initial s3 session for bucket listing 123 | // ListBuckets returns buckets for all regions 124 | 125 | s3Session, err = InitSession(DEFAULT_REGION) 126 | if err != nil { 127 | fmt.Printf("Error: %s\n", err.Error()) 128 | os.Exit(EXIT_FAILED_AWS_CONNECT) 129 | } 130 | 131 | // Get the local delimiter. 132 | // It's actually safe to use a POSIX path delimiter on Windows, but this feels safer 133 | 134 | localDelimiter = GetLocalDelimiter() 135 | log.Println("Finished init") 136 | } 137 | 138 | func main() { 139 | 140 | // Start the UI 141 | 142 | RunUi() 143 | 144 | } 145 | -------------------------------------------------------------------------------- /bucket_explorer_ui.go: -------------------------------------------------------------------------------- 1 | /** 2 | This file is part of s3explorer. 3 | 4 | s3explorer is free software: you can redistribute it and/or modify 5 | it under the terms of the GNU General Public License as published by 6 | the Free Software Foundation, either version 3 of the License, or 7 | (at your option) any later version. 8 | 9 | s3explorer is distributed in the hope that it will be useful, 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | GNU General Public License for more details. 13 | 14 | You should have received a copy of the GNU General Public License 15 | along with s3explorer. If not, see . 16 | **/ 17 | 18 | package main 19 | 20 | import ( 21 | "log" 22 | "os" 23 | "path" 24 | "path/filepath" 25 | 26 | "github.com/gizak/termui" 27 | ) 28 | 29 | func RenderBucketExplorerListing(bucket BucketWithDisplay, nodes []*Node, selection int, deferFunc func()) { 30 | 31 | // Get a UI ready list depending on where the selection pointer is 32 | 33 | list := CreateDirectoryList(bucket.displayString, nodes, selection) 34 | termui.Clear() 35 | termui.Render(list, RenderHelp()) 36 | 37 | // Set default handlers and defer tempdir removal 38 | 39 | SetDefaultHandlers(deferFunc) 40 | 41 | // Up key moves up 42 | 43 | termui.Handle("/sys/kbd/", func(termui.Event) { 44 | if selection == 0 { 45 | return 46 | } else { 47 | selection -= 1 48 | list := CreateDirectoryList(bucket.displayString, nodes, selection) 49 | termui.Render(list, RenderHelp()) 50 | } 51 | }) 52 | 53 | // Down key moves down 54 | 55 | termui.Handle("/sys/kbd/", func(termui.Event) { 56 | if selection == len(nodes)-1 { 57 | return 58 | } else { 59 | selection += 1 60 | list := CreateDirectoryList(bucket.displayString, nodes, selection) 61 | termui.Render(list, RenderHelp()) 62 | } 63 | }) 64 | 65 | // Enter descends the directory or initiates a download for a file 66 | 67 | termui.Handle("/sys/kbd/", func(termui.Event) { 68 | 69 | if nodes[selection].Info.IsDir { 70 | 71 | // A directory was selected 72 | 73 | log.Printf("Selected Directory: %s\n", nodes[selection].DisplayString) 74 | 75 | SetBackHandler(func() { 76 | termui.ResetHandlers() 77 | if nodes[0].Parent == nil { 78 | log.Println("Reached directory root, returning to buckets") 79 | deferFunc() 80 | ReloadMainBuckets() 81 | } else { 82 | log.Printf("Going back to directory: %+v\n", nodes[0].Parent.DisplayString) 83 | listing := GetNodeDirectory(nodes[0].Parent) 84 | RenderBucketExplorerListing(bucket, listing, 0, deferFunc) 85 | } 86 | }) 87 | 88 | // Call parent function for selected node 89 | 90 | log.Printf("Descending into node: %+v\n", nodes[selection].DisplayString) 91 | listing := GetNodeDirectory(nodes[selection]) 92 | RenderBucketExplorerListing(bucket, listing, 0, deferFunc) 93 | 94 | } else { 95 | 96 | // A File was selected 97 | 98 | log.Printf("File Selected: %s\n", nodes[selection].DisplayString) 99 | 100 | // Current downloads default to working directory 101 | 102 | dest := filepath.Join(currentWorkingDir, path.Base(*nodes[selection].S3Object.Key)) 103 | p := CreateDownloadPrompt(dest) 104 | termui.Render(p) 105 | 106 | // Create an AWS Session in the region of the bucket 107 | 108 | sess, err := InitSession(bucket.region) 109 | if err != nil { 110 | log.Println(err) 111 | RenderError(err.Error()) 112 | return 113 | } 114 | 115 | // Download the file 116 | 117 | err = sess.DownloadObject(bucket, nodes[selection], dest) 118 | if err != nil { 119 | log.Println(err) 120 | RenderError(err.Error()) 121 | } else { 122 | p := CreateFinishedDownloadPrompt(dest) 123 | termui.Render(p) 124 | } 125 | } 126 | 127 | }) 128 | 129 | } 130 | 131 | func RenderBucketExplorer(bucket BucketWithDisplay) { 132 | 133 | // init selection pointer 134 | 135 | var selection int 136 | selection = 0 137 | 138 | // get AWS session in region of bucket 139 | 140 | sess, err := InitSession(bucket.region) 141 | if err != nil { 142 | log.Println(err) 143 | os.Exit(EXIT_FAILED_AWS_CONNECT) 144 | } 145 | 146 | // retrieve all objects for bucket 147 | 148 | objects, err := sess.GetBucketObjects(bucket) 149 | if err != nil { 150 | ReloadMainBucketsWithError(err) 151 | return 152 | 153 | } 154 | 155 | // create a local mock filesystem for easier indexing 156 | 157 | mockFsRoot, err := CreateMockFs(objects) 158 | if err != nil { 159 | ReloadMainBucketsWithError(err) 160 | } 161 | 162 | // Set clean function to pass to all default handlers 163 | 164 | deferFunc := func() { 165 | log.Printf("Cleaning Temp Directory: %s\n", mockFsRoot) 166 | err := os.RemoveAll(mockFsRoot) 167 | if err != nil { 168 | log.Printf("Error cleaning Temp (%s): %s\n", mockFsRoot, err) 169 | } 170 | } 171 | 172 | // Evaluate the directory tree 173 | 174 | tree, err := NewTree(objects, mockFsRoot) 175 | if err != nil { 176 | ReloadMainBucketsWithError(err) 177 | } 178 | 179 | // Get a listing for the root node 180 | 181 | listing := GetNodeDirectory(tree) 182 | if err != nil { 183 | ReloadMainBucketsWithError(err) 184 | } 185 | 186 | // Render the bucket explorer 187 | 188 | SetBackHandler(ReloadMainBuckets, deferFunc) 189 | RenderBucketExplorerListing(bucket, listing, selection, deferFunc) 190 | 191 | } 192 | -------------------------------------------------------------------------------- /s3_tree.go: -------------------------------------------------------------------------------- 1 | /** 2 | This file is part of s3explorer. 3 | 4 | s3explorer is free software: you can redistribute it and/or modify 5 | it under the terms of the GNU General Public License as published by 6 | the Free Software Foundation, either version 3 of the License, or 7 | (at your option) any later version. 8 | 9 | s3explorer is distributed in the hope that it will be useful, 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | GNU General Public License for more details. 13 | 14 | You should have received a copy of the GNU General Public License 15 | along with s3explorer. If not, see . 16 | **/ 17 | 18 | package main 19 | 20 | import ( 21 | "io/ioutil" 22 | "log" 23 | "os" 24 | "path" 25 | "path/filepath" 26 | "runtime" 27 | "strings" 28 | "time" 29 | 30 | "github.com/aws/aws-sdk-go/service/s3" 31 | ) 32 | 33 | type FileInfo struct { 34 | Name string 35 | Size int64 36 | Mode os.FileMode 37 | ModTime time.Time 38 | IsDir bool 39 | } 40 | 41 | func fileInfoFromInterface(v os.FileInfo) (info *FileInfo, display string) { 42 | info = &FileInfo{v.Name(), v.Size(), v.Mode(), v.ModTime(), v.IsDir()} 43 | if info.IsDir { 44 | display = info.Name + localDelimiter 45 | } else { 46 | display = info.Name 47 | } 48 | return 49 | } 50 | 51 | type Node struct { 52 | FullPath string 53 | DisplayString string 54 | Info *FileInfo 55 | Children []*Node 56 | Parent *Node 57 | S3Object *s3.Object 58 | } 59 | 60 | func CreateMockFs(objects []*s3.Object) (tempDir string, err error) { 61 | 62 | // Get a temp directory using the system defaults 63 | 64 | log.Println("Creating Mock filesystem for bucket indexing") 65 | tempDir, err = ioutil.TempDir("", "") 66 | if err != nil { 67 | return 68 | } 69 | 70 | // iterate through the s3 objects 71 | 72 | for _, obj := range objects { 73 | 74 | // split per POSIX methods 75 | 76 | dir, file := path.Split(*obj.Key) 77 | 78 | // ensure local path delimiter is used 79 | 80 | sanitizedDir := strings.Replace(dir, "/", localDelimiter, -1) 81 | 82 | // If the length of the dir string is greater than zero, 83 | // Recursively create the directories 84 | 85 | if len(dir) > 0 { 86 | err := os.MkdirAll(path.Join(tempDir, sanitizedDir), DEFAULT_DIRECTORY_MODE) 87 | if err != nil { 88 | log.Printf("Error: %s\n", err.Error()) 89 | } 90 | } 91 | if len(file) > 0 { 92 | 93 | // If we have a file, touch an empty file to represent the node 94 | 95 | sysFile, err := os.Create(path.Join(tempDir, sanitizedDir, file)) 96 | if err != nil { 97 | log.Printf("Error: %s\n", err.Error()) 98 | } 99 | sysFile.Close() 100 | } 101 | } 102 | log.Println("Created mock filesystem") 103 | return 104 | } 105 | 106 | func MatchS3Object(objects []*s3.Object, root string, path string) *s3.Object { 107 | 108 | // find the local path string that coorelates with a remote s3 object 109 | 110 | sanitized := strings.Replace(strings.Replace(path, root+localDelimiter, "", 1), localDelimiter, "/", -1) 111 | for _, obj := range objects { 112 | if *obj.Key == sanitized { 113 | return obj 114 | } 115 | } 116 | return nil 117 | } 118 | 119 | // Create directory hierarchy. 120 | 121 | func NewTree(objects []*s3.Object, root string) (result *Node, err error) { 122 | log.Printf("Creating node tree for bucket filesystem at: %s\n", root) 123 | absRoot, err := filepath.Abs(root) 124 | if err != nil { 125 | return 126 | } 127 | parents := make(map[string]*Node) 128 | walkFunc := func(path string, info os.FileInfo, err error) error { 129 | if err != nil { 130 | return err 131 | } 132 | cInfo, display := fileInfoFromInterface(info) 133 | var objectMatch *s3.Object 134 | if len(objects) > 0 { 135 | objectMatch = MatchS3Object(objects, root, path) 136 | } else { 137 | objectMatch = nil 138 | } 139 | parents[path] = &Node{ 140 | FullPath: path, 141 | DisplayString: display, 142 | Info: cInfo, 143 | Children: make([]*Node, 0), 144 | S3Object: objectMatch, 145 | } 146 | return nil 147 | } 148 | if err = filepath.Walk(absRoot, walkFunc); err != nil { 149 | return 150 | } 151 | for path, node := range parents { 152 | parentPath := filepath.Dir(path) 153 | parent, exists := parents[parentPath] 154 | if !exists { // If a parent does not exist, this is the root. 155 | result = node 156 | } else { 157 | node.Parent = parent 158 | parent.Children = append(parent.Children, node) 159 | } 160 | } 161 | log.Println("Finished indexing bucket fs") 162 | return 163 | } 164 | 165 | func GetLocalDelimiter() string { 166 | 167 | // If windows return \ else return / 168 | 169 | log.Println("Checking local delimiter") 170 | if runtime.GOOS == "windows" { 171 | return "\\" 172 | } else { 173 | return "/" 174 | } 175 | } 176 | 177 | func GetSubdirs(node *Node) (nodes []*Node) { 178 | 179 | // Get subdirs for a node 180 | 181 | log.Printf("Getting subdirs for node: %+v\n", node) 182 | for _, child := range node.Children { 183 | if child.Info.IsDir { 184 | nodes = append(nodes, child) 185 | } 186 | } 187 | return 188 | } 189 | 190 | func GetFiles(node *Node) (nodes []*Node) { 191 | 192 | // Get files for a node 193 | 194 | log.Printf("Getting files for node: %+v\n", node) 195 | for _, child := range node.Children { 196 | if !child.Info.IsDir { 197 | nodes = append(nodes, child) 198 | } 199 | } 200 | return 201 | } 202 | 203 | func GetNodeDirectory(node *Node) (nodes []*Node) { 204 | 205 | // Create a sorted list of nodes (subdirs, then files) 206 | 207 | log.Printf("Creating node directory tree for node focus: %+v\n", node) 208 | if node.Parent != nil { 209 | nodes = append(nodes, &Node{ 210 | FullPath: node.Parent.FullPath, 211 | DisplayString: "..", 212 | Info: node.Parent.Info, 213 | Children: node.Parent.Children, 214 | Parent: node.Parent.Parent, 215 | S3Object: node.Parent.S3Object, 216 | }) 217 | } 218 | nodes = append(nodes, GetSubdirs(node)...) 219 | nodes = append(nodes, GetFiles(node)...) 220 | return 221 | } 222 | -------------------------------------------------------------------------------- /session.go: -------------------------------------------------------------------------------- 1 | /** 2 | This file is part of s3explorer. 3 | 4 | s3explorer is free software: you can redistribute it and/or modify 5 | it under the terms of the GNU General Public License as published by 6 | the Free Software Foundation, either version 3 of the License, or 7 | (at your option) any later version. 8 | 9 | s3explorer is distributed in the hope that it will be useful, 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | GNU General Public License for more details. 13 | 14 | You should have received a copy of the GNU General Public License 15 | along with s3explorer. If not, see . 16 | **/ 17 | 18 | package main 19 | 20 | import ( 21 | "context" 22 | "errors" 23 | "fmt" 24 | "log" 25 | "os" 26 | "path/filepath" 27 | 28 | "github.com/aws/aws-sdk-go/aws" 29 | "github.com/aws/aws-sdk-go/aws/awserr" 30 | "github.com/aws/aws-sdk-go/aws/client" 31 | "github.com/aws/aws-sdk-go/aws/credentials" 32 | "github.com/aws/aws-sdk-go/aws/credentials/ec2rolecreds" 33 | "github.com/aws/aws-sdk-go/aws/ec2metadata" 34 | "github.com/aws/aws-sdk-go/aws/session" 35 | "github.com/aws/aws-sdk-go/service/s3" 36 | "github.com/aws/aws-sdk-go/service/s3/s3manager" 37 | ) 38 | 39 | type S3Session struct { 40 | S3Service *s3.S3 41 | ConfigProvider *client.ConfigProvider 42 | Buckets []*s3.Bucket 43 | } 44 | 45 | type BucketWithDisplay struct { 46 | bucket *s3.Bucket 47 | displayString string 48 | region string 49 | } 50 | 51 | func (s S3Session) DownloadObject(bucket BucketWithDisplay, node *Node, dest string) (err error) { 52 | 53 | log.Printf("\nDownload Call:\n\tBucket: %+v\n\tNode: %+v\n\tDestination: %s\n", bucket, node, dest) 54 | 55 | // sanity check 56 | 57 | if node.S3Object == nil { 58 | err = errors.New(fmt.Sprintf("No s3 object associated with node: %+v\n", node)) 59 | log.Println(err) 60 | return 61 | } 62 | 63 | // Check if dest already exists 64 | 65 | if FileExists(dest) { 66 | log.Println("Removing pre-existing file") 67 | os.Remove(dest) 68 | } 69 | 70 | // Recursively create needed directories 71 | 72 | path, _ := filepath.Split(dest) 73 | log.Printf("Recursively creating directory: %s\n", path) 74 | err = os.MkdirAll(path, DEFAULT_DIRECTORY_MODE) 75 | if err != nil { 76 | return 77 | } 78 | 79 | log.Printf("Creating destination path: %s\n", dest) 80 | 81 | // Open a file 82 | 83 | file, err := os.Create(dest) 84 | if err != nil { 85 | return 86 | } 87 | defer file.Close() 88 | 89 | log.Printf("Getting downloader for region: %s\n", bucket.region) 90 | 91 | // Create a downloader with the s3 client and custom options 92 | 93 | downloader := s3manager.NewDownloaderWithClient(s.S3Service, func(d *s3manager.Downloader) { 94 | d.PartSize = 64 * 1024 * 1024 // 64MB per part 95 | }) 96 | 97 | n, err := downloader.Download(file, &s3.GetObjectInput{ 98 | Bucket: bucket.bucket.Name, 99 | Key: node.S3Object.Key, 100 | }) 101 | 102 | if err != nil { 103 | log.Printf("failed to download file: %v\n", err) 104 | } 105 | 106 | log.Printf("file downloaded, %d bytes\n", n) 107 | return 108 | } 109 | 110 | func (s S3Session) GetBucketObjects(bucket BucketWithDisplay) (objects []*s3.Object, err error) { 111 | 112 | // For a given bucket, retrieve a list of all its objects 113 | 114 | log.Printf("Listing Objects for Bucket: %s\n", bucket.displayString) 115 | err = s.S3Service.ListObjectsV2Pages(&s3.ListObjectsV2Input{ 116 | Bucket: bucket.bucket.Name, 117 | }, 118 | func(page *s3.ListObjectsV2Output, lastPage bool) bool { 119 | objects = append(objects, page.Contents...) 120 | return true 121 | }) 122 | return 123 | } 124 | 125 | func (s S3Session) GetBucketWithDisplayStrings() (bucketStrings []BucketWithDisplay, err error) { 126 | 127 | // Get all buckets, and attach a display string to it 128 | 129 | buckets, err := s.GetBucketListing() 130 | if err != nil { 131 | return 132 | } 133 | for _, bucket := range buckets { 134 | region, err := s.GetBucketRegion(bucket) 135 | if err != nil { 136 | RenderError(err.Error()) 137 | } 138 | displayBucket := BucketWithDisplay{ 139 | bucket: bucket, 140 | displayString: fmt.Sprintf("%s (%s)", *bucket.Name, region), 141 | region: region, 142 | } 143 | bucketStrings = append(bucketStrings, displayBucket) 144 | } 145 | return 146 | } 147 | 148 | func (s S3Session) GetBucketRegion(bucket *s3.Bucket) (region string, err error) { 149 | 150 | // Get the region for a bucket 151 | 152 | log.Printf("Retrieving region for bucket: %s\n", *bucket.Name) 153 | ctx := context.Background() 154 | region, err = s3manager.GetBucketRegionWithClient(ctx, s.S3Service, *bucket.Name) 155 | if err != nil { 156 | if aerr, ok := err.(awserr.Error); ok && aerr.Code() == "NotFound" { 157 | region = "unknown" 158 | } else { 159 | log.Printf("Unknown Error: %s\n", err.Error()) 160 | } 161 | } 162 | return 163 | } 164 | 165 | func (s S3Session) GetBucketListing() (buckets []*s3.Bucket, err error) { 166 | 167 | log.Println("Listing Buckets") 168 | resp, err := s.S3Service.ListBuckets(&s3.ListBucketsInput{}) 169 | if err != nil { 170 | return 171 | } 172 | buckets = resp.Buckets 173 | log.Println("Retrieved bucket list") 174 | return 175 | } 176 | 177 | func (s S3Session) RefreshBucketListing() (err error) { 178 | buckets, err := s.GetBucketListing() 179 | log.Println("Refreshed Bucket Listing") 180 | if err != nil { 181 | return 182 | } 183 | s.Buckets = buckets 184 | return 185 | } 186 | 187 | func InitSession(region string) (s3session S3Session, err error) { 188 | 189 | creds, err := getCreds() 190 | if err != nil { 191 | return 192 | } 193 | 194 | sess := session.Must(session.NewSession(&aws.Config{ 195 | Credentials: creds, 196 | Region: aws.String(region), 197 | })) 198 | 199 | s3session.S3Service = s3.New(sess) 200 | log.Printf("Connected to S3 in Region: %s\n", region) 201 | return 202 | } 203 | 204 | func getCreds() (creds *credentials.Credentials, err error) { 205 | sess := session.Must(session.NewSession()) 206 | creds = credentials.NewChainCredentials( 207 | []credentials.Provider{ 208 | &credentials.EnvProvider{}, 209 | &credentials.SharedCredentialsProvider{}, 210 | &ec2rolecreds.EC2RoleProvider{ 211 | Client: ec2metadata.New(sess), 212 | }, 213 | }) 214 | _, err = creds.Get() 215 | if err != nil { 216 | return 217 | } 218 | log.Println("Got AWS Credentials") 219 | return 220 | } 221 | -------------------------------------------------------------------------------- /ui_objects.go: -------------------------------------------------------------------------------- 1 | /** 2 | This file is part of s3explorer. 3 | 4 | s3explorer is free software: you can redistribute it and/or modify 5 | it under the terms of the GNU General Public License as published by 6 | the Free Software Foundation, either version 3 of the License, or 7 | (at your option) any later version. 8 | 9 | s3explorer is distributed in the hope that it will be useful, 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | GNU General Public License for more details. 13 | 14 | You should have received a copy of the GNU General Public License 15 | along with s3explorer. If not, see . 16 | **/ 17 | 18 | package main 19 | 20 | import ( 21 | "errors" 22 | "fmt" 23 | "log" 24 | "os" 25 | "strings" 26 | "time" 27 | 28 | "github.com/gizak/termui" 29 | ) 30 | 31 | func RunUi() { 32 | 33 | // Init the termina UI 34 | 35 | err := termui.Init() 36 | if err != nil { 37 | fmt.Printf("Error: %s\n", err) 38 | os.Exit(EXIT_FAILED_NO_TERMINAL) 39 | } 40 | defer termui.Close() 41 | 42 | // Get an initial bucket listing 43 | 44 | buckets, err := s3Session.GetBucketWithDisplayStrings() 45 | if err != nil { 46 | fmt.Printf("Error: %s\n", err.Error()) 47 | os.Exit(EXIT_FAILED_BUCKET_LISTING) 48 | } 49 | 50 | // Set the exit handler and load the main buckets screen 51 | 52 | SetDefaultHandlers(func() { return }) 53 | RenderBucketListing(buckets) 54 | termui.Loop() 55 | } 56 | 57 | func HaveTermSpace(maxHeight int) bool { 58 | 59 | // Determine if we have terminal space to render the desired objets height 60 | 61 | if maxHeight < 2 { 62 | log.Println("Warning: Terminal height is too small!") 63 | return false 64 | } 65 | return true 66 | } 67 | 68 | func GetNodeListHeight(nodes []*Node) int { 69 | 70 | // Get the height available to list a section of nodes 71 | 72 | max := termui.TermHeight() - LOWER_BUFFER 73 | if (len(nodes) + 2) < max { 74 | return (len(nodes) + 2) 75 | } 76 | return max 77 | } 78 | 79 | func GetBucketListHeight(buckets []BucketWithDisplay) int { 80 | 81 | // Get the height available to list a section of buckets 82 | 83 | max := termui.TermHeight() - LOWER_BUFFER 84 | if (len(buckets) + 2) < max { 85 | return (len(buckets) + 2) 86 | } 87 | return max 88 | } 89 | 90 | func GetStringListHeight(strings []string) int { 91 | 92 | // Get the height available to list a section of strings 93 | 94 | max := termui.TermHeight() - LOWER_BUFFER 95 | if (len(strings) + 2) < max { 96 | return (len(strings) + 2) 97 | } 98 | return max 99 | } 100 | 101 | func RenderHelp() (p *termui.Par) { 102 | 103 | // Create a par for the default help window 104 | 105 | arrows := "\u2195\ufe0f" 106 | returnArrow := "\u21b2" 107 | helpText := fmt.Sprintf("%v navigate - %v open - quit - back", arrows, returnArrow) 108 | p = termui.NewPar(helpText) 109 | p.Height = 3 110 | p.Width = len(helpText) + 3 111 | p.TextFgColor = termui.ColorWhite 112 | p.BorderLabel = "Help" 113 | p.BorderFg = termui.ColorCyan 114 | p.Y = termui.TermHeight() - 5 115 | return 116 | } 117 | 118 | func RenderMessage(label string, message string) (p *termui.Par) { 119 | 120 | // Create a par for a generic message 121 | 122 | p = termui.NewPar(message) 123 | p.Height = 3 124 | p.Width = termui.TermWidth() - RIGHT_BUFFER 125 | p.TextFgColor = termui.ColorWhite 126 | p.BorderLabel = label 127 | p.BorderFg = termui.ColorCyan 128 | return 129 | } 130 | 131 | func RenderError(errorMessage string) { 132 | 133 | // Create and immediately render an error 134 | 135 | p := termui.NewPar(errorMessage) 136 | p.Height = 3 137 | p.Width = termui.TermWidth() - RIGHT_BUFFER 138 | p.TextFgColor = termui.ColorWhite 139 | p.BorderLabel = "Error" 140 | p.BorderFg = termui.ColorCyan 141 | termui.Render(p) 142 | time.Sleep(time.Duration(time.Second * 2)) 143 | } 144 | 145 | func CreateDownloadPrompt(dest string) (p *termui.Par) { 146 | 147 | // Create a download prompt 148 | 149 | msg := fmt.Sprintf("Downloading to %s", dest) 150 | p = termui.NewPar(msg) 151 | p.Height = 5 152 | p.Width = termui.TermWidth() - RIGHT_BUFFER 153 | p.TextFgColor = termui.ColorWhite 154 | p.Border = false 155 | p.Y = termui.TermHeight() - 10 156 | return 157 | } 158 | 159 | func CreateFinishedDownloadPrompt(dest string) (p *termui.Par) { 160 | 161 | // Create a finished download prompt 162 | 163 | msg := fmt.Sprintf("File Downloaded: %s", dest) 164 | p = termui.NewPar(msg) 165 | p.Height = 5 166 | p.Width = termui.TermWidth() - RIGHT_BUFFER 167 | p.TextFgColor = termui.ColorWhite 168 | p.Border = false 169 | p.Y = termui.TermHeight() - 10 170 | return 171 | } 172 | 173 | func CreateBucketList(buckets []BucketWithDisplay, selection int) *termui.List { 174 | 175 | // Create a list of buckets 176 | 177 | var displayStrings []string 178 | 179 | // Figure the display strings 180 | for _, bucket := range buckets { 181 | displayStrings = append(displayStrings, bucket.displayString) 182 | } 183 | 184 | // Get the list to render 185 | listing, err := GetDirectoryDisplayListing(displayStrings, selection) 186 | if err != nil { 187 | RenderError(err.Error()) 188 | return &termui.List{} 189 | } 190 | 191 | // create the list 192 | 193 | ls := termui.NewList() 194 | ls.Items = listing 195 | ls.ItemFgColor = termui.ColorYellow 196 | ls.BorderLabel = "S3 Buckets" 197 | ls.Height = GetBucketListHeight(buckets) 198 | ls.Width = termui.TermWidth() - RIGHT_BUFFER 199 | ls.Y = 0 200 | return ls 201 | } 202 | 203 | func TruncateFilename(filename string) (truncated string, space int) { 204 | 205 | // truncate a filename and determine space until size 206 | 207 | if len(filename) >= termui.TermWidth()/4 { 208 | truncated = fmt.Sprintf("%s...", filename[:(termui.TermWidth()/4)-3]) 209 | } else { 210 | truncated = filename 211 | } 212 | space = (termui.TermWidth() / 2) - len(truncated) 213 | return 214 | } 215 | 216 | func GetDirectoryDisplayListing(objects []string, selection int) (listing []string, err error) { 217 | 218 | // hilight the currently selected entry 219 | 220 | var index int 221 | index = 0 222 | for _, obj := range objects { 223 | if index == selection { 224 | listing = append(listing, fmt.Sprintf("[[%v] %s](bg-blue)", index, obj)) 225 | } else { 226 | listing = append(listing, fmt.Sprintf("[%v] %s", index, obj)) 227 | } 228 | index += 1 229 | } 230 | 231 | // Find the height needed for the object 232 | 233 | maxHeight := GetStringListHeight(objects) 234 | 235 | // If not enough height available, render error 236 | if !HaveTermSpace(maxHeight) { 237 | err = errors.New("Please expand the height of your terminal") 238 | log.Println(err) 239 | return 240 | } 241 | 242 | // Otherwise return a scope around the currently selected node 243 | if len(listing) > 0 { 244 | if maxHeight <= (selection + 2) { 245 | listing = listing[(selection - 2):] 246 | } 247 | } 248 | return 249 | } 250 | 251 | func CreateDirectoryList(title string, nodes []*Node, selection int) *termui.List { 252 | 253 | var displayStrings []string 254 | 255 | for _, node := range nodes { 256 | var display string 257 | if !node.Info.IsDir { 258 | file, space := TruncateFilename(node.DisplayString) 259 | display = fmt.Sprintf("%s%s%v", file, strings.Repeat(" ", space), ByteFormat(float64(*node.S3Object.Size), 1)) 260 | } else { 261 | display = node.DisplayString 262 | } 263 | displayStrings = append(displayStrings, display) 264 | } 265 | 266 | listing, err := GetDirectoryDisplayListing(displayStrings, selection) 267 | if err != nil { 268 | RenderError(err.Error()) 269 | return &termui.List{} 270 | } 271 | 272 | ls := termui.NewList() 273 | ls.Items = listing 274 | ls.ItemFgColor = termui.ColorYellow 275 | ls.BorderLabel = title 276 | ls.Height = GetNodeListHeight(nodes) 277 | ls.Width = termui.TermWidth() - RIGHT_BUFFER 278 | ls.Y = 0 279 | return ls 280 | } 281 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------