|
| 1 | +// |
| 2 | +// urlencode.go is a simple command line utility to encode a string in a URL friendly way. |
| 3 | +// |
| 4 | +// @author R. S. Doiel, <rsdoiel@caltech.edu> |
| 5 | +// |
| 6 | +// Copyright (c) 2021, Caltech |
| 7 | +// All rights not granted herein are expressly reserved by Caltech. |
| 8 | +// |
| 9 | +// Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: |
| 10 | +// |
| 11 | +// 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. |
| 12 | +// |
| 13 | +// 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. |
| 14 | +// |
| 15 | +// 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. |
| 16 | +// |
| 17 | +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 18 | +// |
| 19 | +package main |
| 20 | + |
| 21 | +import ( |
| 22 | + "flag" |
| 23 | + "fmt" |
| 24 | + "io/ioutil" |
| 25 | + "net/url" |
| 26 | + "path" |
| 27 | + "os" |
| 28 | + "strings" |
| 29 | + |
| 30 | + // CaltechLibrary Packages |
| 31 | + "github.com/caltechlibrary/datatools" |
| 32 | +) |
| 33 | + |
| 34 | +var ( |
| 35 | + helpText = `%{app_name}(1) user manual | version {version} {release_hash} |
| 36 | +% R. S. Doiel |
| 37 | +% {release_date} |
| 38 | +
|
| 39 | +# NAME |
| 40 | +
|
| 41 | +{app_name} |
| 42 | +
|
| 43 | +# SYNOPSIS |
| 44 | +
|
| 45 | +{app_name} [OPTIONS] [STRING] |
| 46 | +
|
| 47 | +# DESCRIPTION |
| 48 | +
|
| 49 | +{app_name} is a simple command line utility to URL encode content. By default |
| 50 | +it reads from standard input and writes to standard out. You can |
| 51 | +also specifty the string to encode as a command line parameter. |
| 52 | +
|
| 53 | +You can provide the string to encode as a command line parameter otherwise it |
| 54 | +will be read from standard input. |
| 55 | +
|
| 56 | +# OPTIONS |
| 57 | +
|
| 58 | +-help |
| 59 | +: display help |
| 60 | +
|
| 61 | +-license |
| 62 | +: display license |
| 63 | +
|
| 64 | +-version |
| 65 | +: display version |
| 66 | +
|
| 67 | +-query |
| 68 | +: Use URL query style encoding (use plus for spaces) |
| 69 | +
|
| 70 | +-newline |
| 71 | +: Append a trailing newline |
| 72 | +
|
| 73 | +# EXAMPLE |
| 74 | +
|
| 75 | +echo "This is the string to encode & nothing else!" | urlencode |
| 76 | +
|
| 77 | +would yield |
| 78 | +
|
| 79 | + This%20is%20the%20string%20to%20encode%20&%20nothing%20else%0A |
| 80 | +
|
| 81 | +` |
| 82 | + // Standard Options |
| 83 | + showHelp bool |
| 84 | + showLicense bool |
| 85 | + showVersion bool |
| 86 | + |
| 87 | + // App Options |
| 88 | + useQueryEscape bool |
| 89 | + newLine bool |
| 90 | +) |
| 91 | + |
| 92 | +func main() { |
| 93 | + appName := path.Base(os.Args[0]) |
| 94 | + version := datatools.Version |
| 95 | + license := datatools.LicenseText |
| 96 | + releaseDate := datatools.ReleaseDate |
| 97 | + releaseHash := datatools.ReleaseHash |
| 98 | + |
| 99 | + // Standard Options |
| 100 | + flag.BoolVar(&showHelp, "help", showHelp, "display help") |
| 101 | + flag.BoolVar(&showLicense, "license", showLicense, "display license") |
| 102 | + flag.BoolVar(&showVersion, "version", showVersion, "display version") |
| 103 | + flag.BoolVar(&newLine, "newline", false, "append a newline character") |
| 104 | + flag.BoolVar(&useQueryEscape, "query", false, "use query escape (pluses for spaces)") |
| 105 | + |
| 106 | + // Parse environment and options |
| 107 | + flag.Parse() |
| 108 | + args := flag.Args() |
| 109 | + |
| 110 | + in := os.Stdin |
| 111 | + out := os.Stdout |
| 112 | + eout := os.Stderr |
| 113 | + |
| 114 | + // Handle the default options |
| 115 | + if showHelp { |
| 116 | + fmt.Fprintf(out, "%s\n", datatools.FmtHelp(helpText, appName, version, releaseDate, releaseHash)) |
| 117 | + os.Exit(0) |
| 118 | + } |
| 119 | + if showLicense == true { |
| 120 | + fmt.Fprintf(out, "%s\n", license) |
| 121 | + os.Exit(0) |
| 122 | + } |
| 123 | + if showVersion == true { |
| 124 | + fmt.Fprintf(out, "datatools, %s %s %s\n", appName, version, releaseHash) |
| 125 | + os.Exit(0) |
| 126 | + } |
| 127 | + |
| 128 | + nl := "\n" |
| 129 | + if newLine == false { |
| 130 | + nl = "" |
| 131 | + } |
| 132 | + |
| 133 | + var src string |
| 134 | + |
| 135 | + if len(args) > 0 { |
| 136 | + src = strings.Join(args, " ") |
| 137 | + } else { |
| 138 | + buf, err := ioutil.ReadAll(in) |
| 139 | + if err != nil { |
| 140 | + fmt.Fprintf(eout, "%s\n", err) |
| 141 | + os.Exit(1) |
| 142 | + } |
| 143 | + src = fmt.Sprintf("%s", buf) |
| 144 | + } |
| 145 | + if useQueryEscape == true { |
| 146 | + fmt.Fprintf(out, "%s%s", url.QueryEscape(src), nl) |
| 147 | + } else { |
| 148 | + fmt.Fprintf(out, "%s%s", url.PathEscape(src), nl) |
| 149 | + } |
| 150 | +} |
0 commit comments