├── .gitignore ├── Cargo.lock ├── Cargo.toml ├── LICENSE ├── README.md ├── demo.gif └── src ├── config.rs ├── engine.rs ├── main.rs ├── suggestion_adapter.rs └── util.rs /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | **/*.rs.bk -------------------------------------------------------------------------------- /Cargo.lock: -------------------------------------------------------------------------------- 1 | # This file is automatically @generated by Cargo. 2 | # It is not intended for manual editing. 3 | [[package]] 4 | name = "base64" 5 | version = "0.10.1" 6 | source = "registry+https://github.com/rust-lang/crates.io-index" 7 | dependencies = [ 8 | "byteorder 1.3.1 (registry+https://github.com/rust-lang/crates.io-index)", 9 | ] 10 | 11 | [[package]] 12 | name = "byteorder" 13 | version = "1.3.1" 14 | source = "registry+https://github.com/rust-lang/crates.io-index" 15 | 16 | [[package]] 17 | name = "cc" 18 | version = "1.0.36" 19 | source = "registry+https://github.com/rust-lang/crates.io-index" 20 | 21 | [[package]] 22 | name = "cfg-if" 23 | version = "0.1.7" 24 | source = "registry+https://github.com/rust-lang/crates.io-index" 25 | 26 | [[package]] 27 | name = "crossterm" 28 | version = "0.9.4" 29 | source = "registry+https://github.com/rust-lang/crates.io-index" 30 | dependencies = [ 31 | "crossterm_cursor 0.2.2 (registry+https://github.com/rust-lang/crates.io-index)", 32 | "crossterm_input 0.3.4 (registry+https://github.com/rust-lang/crates.io-index)", 33 | "crossterm_screen 0.2.2 (registry+https://github.com/rust-lang/crates.io-index)", 34 | "crossterm_style 0.3.2 (registry+https://github.com/rust-lang/crates.io-index)", 35 | "crossterm_terminal 0.2.3 (registry+https://github.com/rust-lang/crates.io-index)", 36 | "crossterm_utils 0.2.2 (registry+https://github.com/rust-lang/crates.io-index)", 37 | ] 38 | 39 | [[package]] 40 | name = "crossterm_cursor" 41 | version = "0.2.2" 42 | source = "registry+https://github.com/rust-lang/crates.io-index" 43 | dependencies = [ 44 | "crossterm_utils 0.2.2 (registry+https://github.com/rust-lang/crates.io-index)", 45 | "crossterm_winapi 0.1.2 (registry+https://github.com/rust-lang/crates.io-index)", 46 | "winapi 0.3.7 (registry+https://github.com/rust-lang/crates.io-index)", 47 | ] 48 | 49 | [[package]] 50 | name = "crossterm_input" 51 | version = "0.3.4" 52 | source = "registry+https://github.com/rust-lang/crates.io-index" 53 | dependencies = [ 54 | "crossterm_screen 0.2.2 (registry+https://github.com/rust-lang/crates.io-index)", 55 | "crossterm_utils 0.2.2 (registry+https://github.com/rust-lang/crates.io-index)", 56 | "crossterm_winapi 0.1.2 (registry+https://github.com/rust-lang/crates.io-index)", 57 | "libc 0.2.54 (registry+https://github.com/rust-lang/crates.io-index)", 58 | "winapi 0.3.7 (registry+https://github.com/rust-lang/crates.io-index)", 59 | ] 60 | 61 | [[package]] 62 | name = "crossterm_screen" 63 | version = "0.2.2" 64 | source = "registry+https://github.com/rust-lang/crates.io-index" 65 | dependencies = [ 66 | "crossterm_utils 0.2.2 (registry+https://github.com/rust-lang/crates.io-index)", 67 | "crossterm_winapi 0.1.2 (registry+https://github.com/rust-lang/crates.io-index)", 68 | "winapi 0.3.7 (registry+https://github.com/rust-lang/crates.io-index)", 69 | ] 70 | 71 | [[package]] 72 | name = "crossterm_style" 73 | version = "0.3.2" 74 | source = "registry+https://github.com/rust-lang/crates.io-index" 75 | dependencies = [ 76 | "crossterm_utils 0.2.2 (registry+https://github.com/rust-lang/crates.io-index)", 77 | "crossterm_winapi 0.1.2 (registry+https://github.com/rust-lang/crates.io-index)", 78 | "winapi 0.3.7 (registry+https://github.com/rust-lang/crates.io-index)", 79 | ] 80 | 81 | [[package]] 82 | name = "crossterm_terminal" 83 | version = "0.2.3" 84 | source = "registry+https://github.com/rust-lang/crates.io-index" 85 | dependencies = [ 86 | "crossterm_cursor 0.2.2 (registry+https://github.com/rust-lang/crates.io-index)", 87 | "crossterm_utils 0.2.2 (registry+https://github.com/rust-lang/crates.io-index)", 88 | "crossterm_winapi 0.1.2 (registry+https://github.com/rust-lang/crates.io-index)", 89 | "libc 0.2.54 (registry+https://github.com/rust-lang/crates.io-index)", 90 | ] 91 | 92 | [[package]] 93 | name = "crossterm_utils" 94 | version = "0.2.2" 95 | source = "registry+https://github.com/rust-lang/crates.io-index" 96 | dependencies = [ 97 | "crossterm_winapi 0.1.2 (registry+https://github.com/rust-lang/crates.io-index)", 98 | "libc 0.2.54 (registry+https://github.com/rust-lang/crates.io-index)", 99 | "winapi 0.3.7 (registry+https://github.com/rust-lang/crates.io-index)", 100 | ] 101 | 102 | [[package]] 103 | name = "crossterm_winapi" 104 | version = "0.1.2" 105 | source = "registry+https://github.com/rust-lang/crates.io-index" 106 | dependencies = [ 107 | "winapi 0.3.7 (registry+https://github.com/rust-lang/crates.io-index)", 108 | ] 109 | 110 | [[package]] 111 | name = "directories" 112 | version = "1.0.2" 113 | source = "registry+https://github.com/rust-lang/crates.io-index" 114 | dependencies = [ 115 | "libc 0.2.54 (registry+https://github.com/rust-lang/crates.io-index)", 116 | "winapi 0.3.7 (registry+https://github.com/rust-lang/crates.io-index)", 117 | ] 118 | 119 | [[package]] 120 | name = "json" 121 | version = "0.11.13" 122 | source = "registry+https://github.com/rust-lang/crates.io-index" 123 | 124 | [[package]] 125 | name = "lazy_static" 126 | version = "1.3.0" 127 | source = "registry+https://github.com/rust-lang/crates.io-index" 128 | 129 | [[package]] 130 | name = "libc" 131 | version = "0.2.54" 132 | source = "registry+https://github.com/rust-lang/crates.io-index" 133 | 134 | [[package]] 135 | name = "log" 136 | version = "0.4.6" 137 | source = "registry+https://github.com/rust-lang/crates.io-index" 138 | dependencies = [ 139 | "cfg-if 0.1.7 (registry+https://github.com/rust-lang/crates.io-index)", 140 | ] 141 | 142 | [[package]] 143 | name = "minreq" 144 | version = "1.1.2" 145 | source = "registry+https://github.com/rust-lang/crates.io-index" 146 | dependencies = [ 147 | "rustls 0.15.2 (registry+https://github.com/rust-lang/crates.io-index)", 148 | "webpki 0.19.1 (registry+https://github.com/rust-lang/crates.io-index)", 149 | "webpki-roots 0.16.0 (registry+https://github.com/rust-lang/crates.io-index)", 150 | ] 151 | 152 | [[package]] 153 | name = "percent-encoding" 154 | version = "1.0.1" 155 | source = "registry+https://github.com/rust-lang/crates.io-index" 156 | 157 | [[package]] 158 | name = "proc-macro2" 159 | version = "0.4.30" 160 | source = "registry+https://github.com/rust-lang/crates.io-index" 161 | dependencies = [ 162 | "unicode-xid 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)", 163 | ] 164 | 165 | [[package]] 166 | name = "quote" 167 | version = "0.6.12" 168 | source = "registry+https://github.com/rust-lang/crates.io-index" 169 | dependencies = [ 170 | "proc-macro2 0.4.30 (registry+https://github.com/rust-lang/crates.io-index)", 171 | ] 172 | 173 | [[package]] 174 | name = "ring" 175 | version = "0.14.6" 176 | source = "registry+https://github.com/rust-lang/crates.io-index" 177 | dependencies = [ 178 | "cc 1.0.36 (registry+https://github.com/rust-lang/crates.io-index)", 179 | "lazy_static 1.3.0 (registry+https://github.com/rust-lang/crates.io-index)", 180 | "libc 0.2.54 (registry+https://github.com/rust-lang/crates.io-index)", 181 | "spin 0.5.0 (registry+https://github.com/rust-lang/crates.io-index)", 182 | "untrusted 0.6.2 (registry+https://github.com/rust-lang/crates.io-index)", 183 | "winapi 0.3.7 (registry+https://github.com/rust-lang/crates.io-index)", 184 | ] 185 | 186 | [[package]] 187 | name = "rustls" 188 | version = "0.15.2" 189 | source = "registry+https://github.com/rust-lang/crates.io-index" 190 | dependencies = [ 191 | "base64 0.10.1 (registry+https://github.com/rust-lang/crates.io-index)", 192 | "log 0.4.6 (registry+https://github.com/rust-lang/crates.io-index)", 193 | "ring 0.14.6 (registry+https://github.com/rust-lang/crates.io-index)", 194 | "sct 0.5.0 (registry+https://github.com/rust-lang/crates.io-index)", 195 | "untrusted 0.6.2 (registry+https://github.com/rust-lang/crates.io-index)", 196 | "webpki 0.19.1 (registry+https://github.com/rust-lang/crates.io-index)", 197 | ] 198 | 199 | [[package]] 200 | name = "sct" 201 | version = "0.5.0" 202 | source = "registry+https://github.com/rust-lang/crates.io-index" 203 | dependencies = [ 204 | "ring 0.14.6 (registry+https://github.com/rust-lang/crates.io-index)", 205 | "untrusted 0.6.2 (registry+https://github.com/rust-lang/crates.io-index)", 206 | ] 207 | 208 | [[package]] 209 | name = "sefr" 210 | version = "0.3.2" 211 | dependencies = [ 212 | "crossterm 0.9.4 (registry+https://github.com/rust-lang/crates.io-index)", 213 | "directories 1.0.2 (registry+https://github.com/rust-lang/crates.io-index)", 214 | "json 0.11.13 (registry+https://github.com/rust-lang/crates.io-index)", 215 | "minreq 1.1.2 (registry+https://github.com/rust-lang/crates.io-index)", 216 | "percent-encoding 1.0.1 (registry+https://github.com/rust-lang/crates.io-index)", 217 | "serde 1.0.91 (registry+https://github.com/rust-lang/crates.io-index)", 218 | "toml 0.4.10 (registry+https://github.com/rust-lang/crates.io-index)", 219 | "webbrowser 0.5.1 (registry+https://github.com/rust-lang/crates.io-index)", 220 | ] 221 | 222 | [[package]] 223 | name = "serde" 224 | version = "1.0.91" 225 | source = "registry+https://github.com/rust-lang/crates.io-index" 226 | dependencies = [ 227 | "serde_derive 1.0.91 (registry+https://github.com/rust-lang/crates.io-index)", 228 | ] 229 | 230 | [[package]] 231 | name = "serde_derive" 232 | version = "1.0.91" 233 | source = "registry+https://github.com/rust-lang/crates.io-index" 234 | dependencies = [ 235 | "proc-macro2 0.4.30 (registry+https://github.com/rust-lang/crates.io-index)", 236 | "quote 0.6.12 (registry+https://github.com/rust-lang/crates.io-index)", 237 | "syn 0.15.34 (registry+https://github.com/rust-lang/crates.io-index)", 238 | ] 239 | 240 | [[package]] 241 | name = "spin" 242 | version = "0.5.0" 243 | source = "registry+https://github.com/rust-lang/crates.io-index" 244 | 245 | [[package]] 246 | name = "syn" 247 | version = "0.15.34" 248 | source = "registry+https://github.com/rust-lang/crates.io-index" 249 | dependencies = [ 250 | "proc-macro2 0.4.30 (registry+https://github.com/rust-lang/crates.io-index)", 251 | "quote 0.6.12 (registry+https://github.com/rust-lang/crates.io-index)", 252 | "unicode-xid 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)", 253 | ] 254 | 255 | [[package]] 256 | name = "toml" 257 | version = "0.4.10" 258 | source = "registry+https://github.com/rust-lang/crates.io-index" 259 | dependencies = [ 260 | "serde 1.0.91 (registry+https://github.com/rust-lang/crates.io-index)", 261 | ] 262 | 263 | [[package]] 264 | name = "unicode-xid" 265 | version = "0.1.0" 266 | source = "registry+https://github.com/rust-lang/crates.io-index" 267 | 268 | [[package]] 269 | name = "untrusted" 270 | version = "0.6.2" 271 | source = "registry+https://github.com/rust-lang/crates.io-index" 272 | 273 | [[package]] 274 | name = "webbrowser" 275 | version = "0.5.1" 276 | source = "registry+https://github.com/rust-lang/crates.io-index" 277 | dependencies = [ 278 | "widestring 0.4.0 (registry+https://github.com/rust-lang/crates.io-index)", 279 | "winapi 0.3.7 (registry+https://github.com/rust-lang/crates.io-index)", 280 | ] 281 | 282 | [[package]] 283 | name = "webpki" 284 | version = "0.19.1" 285 | source = "registry+https://github.com/rust-lang/crates.io-index" 286 | dependencies = [ 287 | "ring 0.14.6 (registry+https://github.com/rust-lang/crates.io-index)", 288 | "untrusted 0.6.2 (registry+https://github.com/rust-lang/crates.io-index)", 289 | ] 290 | 291 | [[package]] 292 | name = "webpki-roots" 293 | version = "0.16.0" 294 | source = "registry+https://github.com/rust-lang/crates.io-index" 295 | dependencies = [ 296 | "untrusted 0.6.2 (registry+https://github.com/rust-lang/crates.io-index)", 297 | "webpki 0.19.1 (registry+https://github.com/rust-lang/crates.io-index)", 298 | ] 299 | 300 | [[package]] 301 | name = "widestring" 302 | version = "0.4.0" 303 | source = "registry+https://github.com/rust-lang/crates.io-index" 304 | 305 | [[package]] 306 | name = "winapi" 307 | version = "0.3.7" 308 | source = "registry+https://github.com/rust-lang/crates.io-index" 309 | dependencies = [ 310 | "winapi-i686-pc-windows-gnu 0.4.0 (registry+https://github.com/rust-lang/crates.io-index)", 311 | "winapi-x86_64-pc-windows-gnu 0.4.0 (registry+https://github.com/rust-lang/crates.io-index)", 312 | ] 313 | 314 | [[package]] 315 | name = "winapi-i686-pc-windows-gnu" 316 | version = "0.4.0" 317 | source = "registry+https://github.com/rust-lang/crates.io-index" 318 | 319 | [[package]] 320 | name = "winapi-x86_64-pc-windows-gnu" 321 | version = "0.4.0" 322 | source = "registry+https://github.com/rust-lang/crates.io-index" 323 | 324 | [metadata] 325 | "checksum base64 0.10.1 (registry+https://github.com/rust-lang/crates.io-index)" = "0b25d992356d2eb0ed82172f5248873db5560c4721f564b13cb5193bda5e668e" 326 | "checksum byteorder 1.3.1 (registry+https://github.com/rust-lang/crates.io-index)" = "a019b10a2a7cdeb292db131fc8113e57ea2a908f6e7894b0c3c671893b65dbeb" 327 | "checksum cc 1.0.36 (registry+https://github.com/rust-lang/crates.io-index)" = "a0c56216487bb80eec9c4516337b2588a4f2a2290d72a1416d930e4dcdb0c90d" 328 | "checksum cfg-if 0.1.7 (registry+https://github.com/rust-lang/crates.io-index)" = "11d43355396e872eefb45ce6342e4374ed7bc2b3a502d1b28e36d6e23c05d1f4" 329 | "checksum crossterm 0.9.4 (registry+https://github.com/rust-lang/crates.io-index)" = "fafcaf662688decaa4bb9239ed4de786771a46bbffcfd5bf31a653eb3af1b474" 330 | "checksum crossterm_cursor 0.2.2 (registry+https://github.com/rust-lang/crates.io-index)" = "6eb8aa62914ae4481cd9398a059a49181a2a32fce3c566a7894dd690397dd8e3" 331 | "checksum crossterm_input 0.3.4 (registry+https://github.com/rust-lang/crates.io-index)" = "9d085c483302b615454b5d131138a99ec328518d0caae7cf1309834daf71e60f" 332 | "checksum crossterm_screen 0.2.2 (registry+https://github.com/rust-lang/crates.io-index)" = "dd3fd5ece76b710c942e1048a584e0d521827cc1b8ba10e39ec4a6a8666e5b6a" 333 | "checksum crossterm_style 0.3.2 (registry+https://github.com/rust-lang/crates.io-index)" = "3d807fe7cb35ee23577f354ee5c92aecefd98f9a42c71bb5797cae505013c65b" 334 | "checksum crossterm_terminal 0.2.3 (registry+https://github.com/rust-lang/crates.io-index)" = "caa8baea20b746aca362dc89007cd7afdf8bc65b7799397375096847e1f5976e" 335 | "checksum crossterm_utils 0.2.2 (registry+https://github.com/rust-lang/crates.io-index)" = "9e4790046a26dd8a86db162119382383ddea0c45eab77e278d920eeeeafb7381" 336 | "checksum crossterm_winapi 0.1.2 (registry+https://github.com/rust-lang/crates.io-index)" = "71dc52848cd3c5e06d5d0e193c0d64ce93b71502e124723a33bf615ef7089610" 337 | "checksum directories 1.0.2 (registry+https://github.com/rust-lang/crates.io-index)" = "72d337a64190607d4fcca2cb78982c5dd57f4916e19696b48a575fa746b6cb0f" 338 | "checksum json 0.11.13 (registry+https://github.com/rust-lang/crates.io-index)" = "9ad0485404155f45cce53a40d4b2d6ac356418300daed05273d9e26f91c390be" 339 | "checksum lazy_static 1.3.0 (registry+https://github.com/rust-lang/crates.io-index)" = "bc5729f27f159ddd61f4df6228e827e86643d4d3e7c32183cb30a1c08f604a14" 340 | "checksum libc 0.2.54 (registry+https://github.com/rust-lang/crates.io-index)" = "c6785aa7dd976f5fbf3b71cfd9cd49d7f783c1ff565a858d71031c6c313aa5c6" 341 | "checksum log 0.4.6 (registry+https://github.com/rust-lang/crates.io-index)" = "c84ec4b527950aa83a329754b01dbe3f58361d1c5efacd1f6d68c494d08a17c6" 342 | "checksum minreq 1.1.2 (registry+https://github.com/rust-lang/crates.io-index)" = "2be05cd45a9f6d5c179a34fd986433f49c85dbe57a09bd1004a1a1a9d524ed7c" 343 | "checksum percent-encoding 1.0.1 (registry+https://github.com/rust-lang/crates.io-index)" = "31010dd2e1ac33d5b46a5b413495239882813e0369f8ed8a5e266f173602f831" 344 | "checksum proc-macro2 0.4.30 (registry+https://github.com/rust-lang/crates.io-index)" = "cf3d2011ab5c909338f7887f4fc896d35932e29146c12c8d01da6b22a80ba759" 345 | "checksum quote 0.6.12 (registry+https://github.com/rust-lang/crates.io-index)" = "faf4799c5d274f3868a4aae320a0a182cbd2baee377b378f080e16a23e9d80db" 346 | "checksum ring 0.14.6 (registry+https://github.com/rust-lang/crates.io-index)" = "426bc186e3e95cac1e4a4be125a4aca7e84c2d616ffc02244eef36e2a60a093c" 347 | "checksum rustls 0.15.2 (registry+https://github.com/rust-lang/crates.io-index)" = "f271e3552cd835fa28c541c34a7e8fdd8cdff09d77fe4eb8f6c42e87a11b096e" 348 | "checksum sct 0.5.0 (registry+https://github.com/rust-lang/crates.io-index)" = "2f5adf8fbd58e1b1b52699dc8bed2630faecb6d8c7bee77d009d6bbe4af569b9" 349 | "checksum serde 1.0.91 (registry+https://github.com/rust-lang/crates.io-index)" = "a72e9b96fa45ce22a4bc23da3858dfccfd60acd28a25bcd328a98fdd6bea43fd" 350 | "checksum serde_derive 1.0.91 (registry+https://github.com/rust-lang/crates.io-index)" = "101b495b109a3e3ca8c4cbe44cf62391527cdfb6ba15821c5ce80bcd5ea23f9f" 351 | "checksum spin 0.5.0 (registry+https://github.com/rust-lang/crates.io-index)" = "44363f6f51401c34e7be73db0db371c04705d35efbe9f7d6082e03a921a32c55" 352 | "checksum syn 0.15.34 (registry+https://github.com/rust-lang/crates.io-index)" = "a1393e4a97a19c01e900df2aec855a29f71cf02c402e2f443b8d2747c25c5dbe" 353 | "checksum toml 0.4.10 (registry+https://github.com/rust-lang/crates.io-index)" = "758664fc71a3a69038656bee8b6be6477d2a6c315a6b81f7081f591bffa4111f" 354 | "checksum unicode-xid 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)" = "fc72304796d0818e357ead4e000d19c9c174ab23dc11093ac919054d20a6a7fc" 355 | "checksum untrusted 0.6.2 (registry+https://github.com/rust-lang/crates.io-index)" = "55cd1f4b4e96b46aeb8d4855db4a7a9bd96eeeb5c6a1ab54593328761642ce2f" 356 | "checksum webbrowser 0.5.1 (registry+https://github.com/rust-lang/crates.io-index)" = "c01efd7cb6939b7f34983f1edff0550e5b21b49e2db4495656295922df8939ac" 357 | "checksum webpki 0.19.1 (registry+https://github.com/rust-lang/crates.io-index)" = "4f7e1cd7900a3a6b65a3e8780c51a3e6b59c0e2c55c6dc69578c288d69f7d082" 358 | "checksum webpki-roots 0.16.0 (registry+https://github.com/rust-lang/crates.io-index)" = "c10fa4212003ba19a564f25cd8ab572c6791f99a03cc219c13ed35ccab00de0e" 359 | "checksum widestring 0.4.0 (registry+https://github.com/rust-lang/crates.io-index)" = "effc0e4ff8085673ea7b9b2e3c73f6bd4d118810c9009ed8f1e16bd96c331db6" 360 | "checksum winapi 0.3.7 (registry+https://github.com/rust-lang/crates.io-index)" = "f10e386af2b13e47c89e7236a7a14a086791a2b88ebad6df9bf42040195cf770" 361 | "checksum winapi-i686-pc-windows-gnu 0.4.0 (registry+https://github.com/rust-lang/crates.io-index)" = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6" 362 | "checksum winapi-x86_64-pc-windows-gnu 0.4.0 (registry+https://github.com/rust-lang/crates.io-index)" = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f" 363 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "sefr" 3 | version = "0.3.2" 4 | authors = ["Dmitry Narkevich "] 5 | edition = "2018" 6 | description = "Terminal program for interactively opening search engines / parametric URLs." 7 | repository = "https://github.com/efskap/sefr" 8 | readme = "README.md" 9 | keywords = ["terminal", "search"] 10 | categories = ["command-line-utilities"] 11 | license = "GPL-3.0-or-later" 12 | 13 | [dependencies] 14 | crossterm = "0.9.4" 15 | minreq = { version = "1.1.2", features = ["https"] } 16 | json = "0.11" 17 | webbrowser = "0.5" 18 | toml = "0.4" 19 | serde = {version = "1.0", features = ["derive"]} 20 | directories = "1.0" 21 | percent-encoding = "1.0.1" 22 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # sefr (Search Engine FRontend) 2 | 3 | [![Crates.io](https://img.shields.io/crates/v/sefr.svg)![Crates.io](https://img.shields.io/crates/d/sefr.svg)](https://crates.io/crates/sefr) 4 | 5 | Terminal program for interactively opening search engines / parametric URLs 6 | It's kinda like surfraw but with interactive suggestions (via parsing opensearch json). 7 | 8 | ![](https://github.com/efskap/sefr/raw/master/demo.gif "demo gif") 9 | 10 | ## Motivation 11 | 12 | I use custom url bar search engines a lot, but browser support for them is frustrating. 13 | 14 | - Firefox has a really obtuse way of defining them, doesn't let you specify suggestion endpoints, and still doesn't sync them. 15 | - Chrome makes defining them easy, syncs them, but doesn't let you specify suggestion endpoints. 16 | - Vivaldi makes defining them easy, lets you specify suggestion endpoints, but doesn't sync them. 17 | 18 | e.g. in stock Firefox, while you can create a bookmark keyword so that when you type "r foo" in your url bar, 19 | it automatically goes to "reddit.com/r/foo", you can't get completions, and you can't set it as the default search engine. 20 | 21 | This is meant to be a customizable crossplatform solution, and since it uses your default browser ([more details](https://github.com/amodm/webbrowser-rs#examples)), you can integrate it into a GUI workflow with a global hotkey (see below). 22 | 23 | ## Installation 24 | 25 | There are two ways to install `sefr`: 26 | 1. Clone this repository, install [the Rust toolchain](https://rustup.rs/), and either call `cargo run` in the cloned directory to try it out, or `cargo build` to create a binary located at `target/debug/sefr`. 27 | 2. Install via cargo by calling `cargo install sefr`. This should make it runnable from anywhere. 28 | 29 | A convenient way to integrate it into your desktop environment is by mapping a global hotkey to launch it in a lightweight terminal, making for rofi-like UX. 30 | 31 | For example, I currently use this in KDE (using the fantastically lightweight [suckless terminal](https://st.suckless.org/)), globally bound to Super+s, with a kwin rule that hides window decorations for wmclass=`sefr st`: 32 | 33 | ```sh 34 | st -n sefr -g 70x18 -f 'Monospace:size=14' -e ~/src/sefr/target/debug/sefr 35 | ``` 36 | 37 | For i3, this works well. Not sure why I have to specify `$BROWSER`. 38 | 39 | ```sh 40 | for_window [instance="^sefr$"] floating enable, resize set 640 480, move position center 41 | bindsym Mod4+s exec BROWSER=/usr/bin/firefox st -n sefr -f 'Monospace:size=14' -e ~/src/sefr/target/debug/sefr 42 | ``` 43 | 44 | ## Configuration / Customization 45 | 46 | ### Config file 47 | On its first startup, `sefr` will automatically generate a TOML configuration file in the config directory provided by the [directories crate](https://crates.io/crates/directories). Any subsequent changes should be made inside it. 48 | 49 | e.g. For Linux, the config file will be found in `~/.config/sefr/config.toml`. 50 | 51 | ### Adding new engines 52 | __Warning: The current configuration format might be changed in the future!__ 53 | 54 | New engines can be added for use by `sefr` by adding them to the `config.toml` file. 55 | 56 | A basic engine definition looks like this: 57 | 58 | ```toml 59 | [engines.yt] 60 | name = "YouTube" 61 | search_url = "https://www.youtube.com/results?q=%s" 62 | suggestion_url = "http://suggestqueries.google.com/complete/search?client=firefox&ds=yt&q=%s" 63 | ``` 64 | 65 | - `[engines.PREFIX]` defines what _prefix_ (also known as a _keyword_ or _trigger_) activates the engine. 66 | - `name` is the name of the engine, used for the prompt text if not defined in the prompt section (more on that later). 67 | - `search_url` is opened in your browser with `%s` replaced by the search term when enter is pressed. 68 | - `suggestion_url` (optional) is the endpoint queried for suggestions (with `%s` replaced by the search term) while typing. It must return [OpenSearch suggestions schema json](http://www.opensearch.org/Specifications/OpenSearch/Extensions/Suggestions). 69 | - `space_becomes` (optional, ` ` (space) by default) is what spaces are replaced with before urls are urlencoded and requested. 70 | - In the default config, `engines.r` (Subreddit) has it set to a blank string, because subreddits can't have spaces in their names (note that this value prevents spaces from being entered into the input buffer when the engine is selected so that space can be used to select a suggestion without performing a search). 71 | - If you wanted to have a wikipedia search engine that goes directly to the article without the redirect in the default config, you could set `space_becomes` to `_` in order to format the article name in the correct format. 72 | 73 | The engine used when no prefix is entered is defined as `_default` in the config, and it is obligatory for the program to start. Example: 74 | 75 | ```toml 76 | [engines._default] 77 | name = "Google" 78 | search_url = "https://www.google.com/search?q=%s" 79 | suggestion_url = "https://www.google.com/complete/search?client=chrome&q=%s" 80 | ``` 81 | 82 | Along with this, there is also an optional `prompt` section which handles the prompt displayed when the engine is called. It will usually look like this: 83 | 84 | ```toml 85 | [engines.yt.prompt] 86 | icon = " ▶ " 87 | icon_bg = "Red" 88 | icon_fg = "White" 89 | text = " Youtube " 90 | text_bg = "White" 91 | text_fg = "Black" 92 | ``` 93 | 94 | The following fields are supported, and all are optional: 95 | - `icon`: the icon displayed in the prompt 96 | - `icon_bg`: background color of the icon 97 | - `icon_fg`: foreground color of the icon 98 | - `text`: The text displayed after the icon in the prompt 99 | - `text_bg`: background color for the text 100 | - `text_fg`: foreground color for the text 101 | 102 | Note that `icon` and `text` are padded with whitespace for aesthetics in the example configuration, but this is not required. 103 | 104 | The fields are all strings except for colors (`*_bg`, `*_fg`). They can be strings (corresponding to [the color names here](https://github.com/TimonPost/crossterm/blob/master/crossterm_style/src/enums/color.rs)), 8-bit numbers (corresponding to [Ansi color codes](https://jonasjacek.github.io/colors/)), or 8-bit RGB tuples like `[255,255,255]` 105 | 106 | If this section is left out for a particular engine, a basic prompt displaying the engine's name will be used. 107 | 108 | ### Keybindings 109 | 110 | Keybindings are a work in progress, but all of the current functions are rebindable under the `[keybinds]` section. 111 | Keybinds are in a vim-like syntax (e.g. ``, ``, ``), but there are a few things to note: 112 | 113 | - The binding and action are double quoted. So the entire binding is a line like `"" = "DeleteChar"`. 114 | 115 | - All bindings are in except single characters (e.g. the literal letter `p`, as in `"p" = "Exit"`). 116 | But why would you make a binding like that? 117 | 118 | - `Ctrl` is represented by `C-` (e.g. `` means 'control + w'). `Alt` is represented by either `A-` or `M-`. 119 | 120 | - Everything inside `<`angle brackets`>` is case-insensitive except the normal key after a modifier. 121 | That is, ``, ``, ``, and `` all mean the same thing ('alt + p') but `` means 'alt + shift + p'. 122 | 123 | - So that means there is no "shift" modifier. To register 'alt + shift + s' you'd write `` or ``. 124 | 125 | - 'shift + tab' is represented by ``. 126 | 127 | - 'enter' can be `` or ``. 'backspace' can be `` or ``. 128 | 129 | - An empty string represents the `NULL` character, whatever that is. 130 | 131 | - If you assign two functions two the same key, the one registered later will override the first. 132 | 133 | Excerpt from the default config: 134 | 135 | ```toml 136 | [keybinds] 137 | "" = "SelectPrev" 138 | "" = "DeleteChar" 139 | "" = "Exit" 140 | ``` 141 | 142 | ## Progress 143 | 144 | This project is currently in its **alpha** stage but is relatively stable. 145 | 146 | - [x] Prompt 147 | - [x] Suggestions request / json parse 148 | - [x] Definable engines with prefixes, prompts, and endpoints 149 | - [x] Browser launching 150 | - [x] Selection of suggestions w/ prefix edge cases 151 | - [x] TOML file config 152 | - [ ] Use real cursor for rendering input buffer, and be able to move it 153 | - [x] Configurable keybindings 154 | - [ ] Better feedback for when suggestion endpoints misbehave 155 | - [ ] CLI args, e.g. providing the initial input buffer through an argument for aliasing. 156 | -------------------------------------------------------------------------------- /demo.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/efskap/sefr/d6ef437b6aa5c3c4683c54916f21d550d859f4cd/demo.gif -------------------------------------------------------------------------------- /src/config.rs: -------------------------------------------------------------------------------- 1 | // ************************************************************************* 2 | // * Copyright (C) 2019 Dmitry Narkevich (me@dmitry.lol) * 3 | // * * 4 | // * This program 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 | // * This program 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 this program. If not, see . * 16 | // ************************************************************************* 17 | 18 | use crate::*; 19 | 20 | use directories::ProjectDirs; 21 | use serde::de::SeqAccess; 22 | use serde::ser::SerializeSeq; 23 | use serde::{Deserialize, Deserializer, Serialize, Serializer}; 24 | use std::error::Error; 25 | use std::fmt; 26 | use std::fs; 27 | use std::hash::{Hash, Hasher}; 28 | use std::str::FromStr; 29 | 30 | const DEFAULT_NAME: &str = "%%DEFAULT%%"; 31 | 32 | #[derive(PartialEq, Eq)] 33 | pub struct KeyBind(pub KeyEvent); 34 | 35 | impl fmt::Display for KeyBind { 36 | fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result { 37 | match &self.0 { 38 | KeyEvent::Char('\n') => { 39 | fmt.write_str(&format!("")).unwrap(); 40 | } 41 | KeyEvent::Char('\t') => { 42 | fmt.write_str(&format!("")).unwrap(); 43 | } 44 | KeyEvent::Char(c) => { 45 | fmt.write_str(&format!("{}", c)).unwrap(); 46 | } 47 | special => { 48 | fmt.write_str("<").unwrap(); 49 | match special { 50 | KeyEvent::Ctrl(c) => { 51 | fmt.write_str(&format!("C-{}", c)).unwrap(); 52 | } 53 | KeyEvent::Alt(c) => { 54 | fmt.write_str(&format!("M-{}", c)).unwrap(); 55 | } 56 | KeyEvent::F(n) => { 57 | fmt.write_str(&format!("F{}", n)).unwrap(); 58 | } 59 | x => { 60 | fmt.write_str(&format!("{:?}", x)).unwrap(); 61 | } 62 | } 63 | fmt.write_str(">").unwrap(); 64 | } 65 | } 66 | Ok(()) 67 | } 68 | } 69 | impl FromStr for KeyBind { 70 | type Err = ConfigError; 71 | 72 | fn from_str(s: &str) -> Result { 73 | if s.is_empty() { 74 | return Ok(KeyBind(KeyEvent::Null)); 75 | } 76 | if s.len() == 1 { 77 | return Ok(KeyBind(KeyEvent::Char(s.chars().next().unwrap()))); 78 | } 79 | if s.starts_with('<') { 80 | let inside = s.trim_matches(|p| p == '<' || p == '>'); 81 | 82 | if inside.to_lowercase().starts_with('f') { 83 | return Ok(KeyBind(KeyEvent::F(u8::from_str(&inside[1..]).or(Err( 84 | Self::Err::new(&format!( 85 | "Could not parse '{}' as a function key (e.g. )", 86 | s 87 | )), 88 | ))?))); 89 | } 90 | if inside.contains('-') { 91 | // it's a control character combo 92 | let parts: Vec = inside.split('-').map(|x| x.to_string()).collect(); 93 | let control_char = &parts[0].to_lowercase(); //.and_then(|z| Some(z.to_lowercase().as_str())); 94 | match control_char.as_ref() { 95 | "c" => { 96 | return Ok(KeyBind(KeyEvent::Ctrl( 97 | parts 98 | .get(1) 99 | .and_then(|x| x.chars().next()) 100 | .ok_or(Self::Err::new(&format!( 101 | "Could not parse '{}' as a ctrl combo (e.g. )", 102 | s 103 | )))?, 104 | ))); 105 | } 106 | "m" | "a" => { 107 | return Ok(KeyBind(KeyEvent::Alt( 108 | parts 109 | .get(1) 110 | .and_then(|x| x.chars().next()) 111 | .ok_or(Self::Err::new(&format!( 112 | "Could not parse '{}' as a meta combo (e.g. or )", 113 | s 114 | )))?, 115 | ))); 116 | } 117 | _ => { 118 | return Err(Self::Err::new(&format!( 119 | "Unrecognized control char in '{}'", 120 | s 121 | ))) 122 | } 123 | } 124 | } else { 125 | // it's just a special char 126 | return Ok(KeyBind(match inside.to_lowercase().as_ref() { 127 | "bs" | "backspace" => Ok(KeyEvent::Backspace), 128 | "enter" | "cr" => Ok(KeyEvent::Char('\n')), 129 | "tab" => Ok(KeyEvent::Char('\t')), 130 | "backtab" => Ok(KeyEvent::BackTab), 131 | "esc" => Ok(KeyEvent::Esc), 132 | "up" => Ok(KeyEvent::Up), 133 | "down" => Ok(KeyEvent::Down), 134 | "left" => Ok(KeyEvent::Left), 135 | "right" => Ok(KeyEvent::Right), 136 | "home" => Ok(KeyEvent::Home), 137 | "end" => Ok(KeyEvent::End), 138 | "pageup" => Ok(KeyEvent::PageUp), 139 | "pagedown" => Ok(KeyEvent::PageDown), 140 | "delete" | "del" => Ok(KeyEvent::Delete), 141 | "insert" => Ok(KeyEvent::Insert), 142 | "null" => Ok(KeyEvent::Null), 143 | _ => Err(Self::Err::new(&format!("Unrecognized special key: {}", s))), 144 | }?)); 145 | } 146 | } 147 | Err(Self::Err::new(&format!( 148 | "Unrecognized keymap format: {}", 149 | s 150 | ))) 151 | } 152 | } 153 | impl<'de> Deserialize<'de> for KeyBind { 154 | fn deserialize(deserializer: D) -> Result 155 | where 156 | D: Deserializer<'de>, 157 | { 158 | let s = String::deserialize(deserializer)?; 159 | FromStr::from_str(&s).map_err(de::Error::custom) 160 | } 161 | } 162 | impl Serialize for KeyBind { 163 | fn serialize(&self, serializer: S) -> Result 164 | where 165 | S: Serializer, 166 | { 167 | self.to_string().serialize(serializer) 168 | } 169 | } 170 | impl Hash for KeyBind { 171 | fn hash(&self, state: &mut H) { 172 | self.to_string().hash(state); 173 | } 174 | } 175 | 176 | #[derive(Serialize, Deserialize)] 177 | pub struct Config { 178 | pub engines: HashMap, 179 | pub keybinds: HashMap, 180 | } 181 | 182 | #[derive(Clone, PartialEq)] 183 | pub enum SuggestionAdapterName { 184 | OpenSearch, 185 | JsonPath(String), 186 | } 187 | impl fmt::Display for SuggestionAdapterName { 188 | fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result { 189 | match self { 190 | SuggestionAdapterName::OpenSearch => fmt.write_str("opensearch")?, 191 | SuggestionAdapterName::JsonPath(x) => { 192 | fmt.write_str("json:")?; 193 | fmt.write_str(x)? 194 | } 195 | }; 196 | Ok(()) 197 | } 198 | } 199 | impl FromStr for SuggestionAdapterName { 200 | type Err = ConfigError; 201 | 202 | fn from_str(s: &str) -> Result { 203 | let lower = s.to_lowercase(); 204 | if lower == "opensearch" { 205 | return Ok(SuggestionAdapterName::OpenSearch); 206 | }; 207 | if lower.starts_with("json:") { 208 | let jsonpath = &s["json:".len()..]; 209 | return Ok(SuggestionAdapterName::JsonPath(jsonpath.into())); 210 | } 211 | return Err(Self::Err::new(&format!( 212 | "Unrecognized suggestion adapter string: {}", 213 | s 214 | ))); 215 | } 216 | } 217 | 218 | impl<'de> Deserialize<'de> for SuggestionAdapterName { 219 | fn deserialize(deserializer: D) -> Result 220 | where 221 | D: Deserializer<'de>, 222 | { 223 | let s = String::deserialize(deserializer)?; 224 | FromStr::from_str(&s).map_err(de::Error::custom) 225 | } 226 | } 227 | impl Serialize for SuggestionAdapterName { 228 | fn serialize(&self, serializer: S) -> Result 229 | where 230 | S: Serializer, 231 | { 232 | self.to_string().serialize(serializer) 233 | } 234 | } 235 | impl Default for SuggestionAdapterName { 236 | fn default() -> SuggestionAdapterName { 237 | SuggestionAdapterName::OpenSearch 238 | } 239 | } 240 | #[derive(Serialize, Deserialize, Clone)] 241 | pub enum BindableAction { 242 | SelectNext, 243 | SelectPrev, 244 | DeleteWord, 245 | DeleteChar, 246 | Exit, 247 | Submit, 248 | ClearInput, 249 | AddChar(char), 250 | } 251 | 252 | #[derive(Debug)] 253 | pub struct ConfigError { 254 | details: String, 255 | } 256 | 257 | impl ConfigError { 258 | pub fn new(msg: &str) -> ConfigError { 259 | ConfigError { 260 | details: msg.to_string(), 261 | } 262 | } 263 | } 264 | 265 | impl fmt::Display for ConfigError { 266 | fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { 267 | write!(f, "{}", self.details) 268 | } 269 | } 270 | 271 | impl Error for ConfigError { 272 | fn description(&self) -> &str { 273 | &self.details 274 | } 275 | } 276 | 277 | fn load_config_from_file() -> Result { 278 | let proj_dirs = ProjectDirs::from("com", "efskap", "sefr") 279 | .ok_or(ConfigError::new("Couldn't get config dir."))?; 280 | let config_dir = proj_dirs.config_dir(); 281 | fs::create_dir_all(config_dir).or(Err(ConfigError::new(&format!( 282 | "Couldn't create dir {:?}.", 283 | config_dir 284 | ))))?; 285 | let config_path = config_dir.join("config.toml"); 286 | let default_toml = format!( 287 | "{}", 288 | toml::Value::try_from(&get_default_config()).or_else(|e| Err(ConfigError::new( 289 | &format!( 290 | "Could not serialize default config to TOML. This... shouldn't happen. {:?}", 291 | e 292 | ) 293 | )))? 294 | ); 295 | if !config_path.exists() { 296 | fs::write(&config_path, default_toml).or(Err(ConfigError::new(&format!( 297 | "Could not write default config to {:?}.", 298 | config_path 299 | ))))?; 300 | println!( 301 | "Wrote default config to {:?}. Edit it and enjoy!", 302 | config_path 303 | ); 304 | } 305 | toml::from_str( 306 | &fs::read_to_string(&config_path).or(Err(ConfigError::new(&format!( 307 | "Could not read path {:?}.", 308 | config_path 309 | ))))?, 310 | ) 311 | .map_err(|e| { 312 | ConfigError::new(&format!( 313 | " ↳ Could not parse TOML file {:?}:\n ↳ {}", 314 | config_path, e 315 | )) 316 | }) 317 | } 318 | 319 | fn validate_config(config: &mut Config) { 320 | let default = config 321 | .engines 322 | .remove("_default") 323 | .expect("No '_default' search engine found!!!"); 324 | config.engines.insert("".to_string(), default); 325 | 326 | // first fix em up 327 | for eng in config.engines.values_mut() { 328 | // if user didn't specify prompt text, just set it to the engine name with padding 329 | // of course this won't happen if they set it to an empty string. 330 | if eng.prompt.text == DEFAULT_NAME { 331 | eng.prompt.text = format!(" {} ", eng.name); 332 | } 333 | } 334 | // then get rid of invalid ones 335 | let bad_prefixes: Vec = config.engines 336 | .iter().filter_map(|(k,v)| { 337 | if k.contains(' ') { 338 | println!("Prefixes have to be a single word, so engine '{}' with prefix '{}' will be ignored.", v.name, k); 339 | return Some(k.clone()); 340 | } 341 | None 342 | }).collect(); 343 | 344 | for prefix in bad_prefixes { 345 | config.engines.remove(&prefix); 346 | } 347 | } 348 | 349 | pub fn get_config() -> Config { 350 | if let Some(proj_dirs) = ProjectDirs::from("com", "efskap", "sefr") { 351 | proj_dirs.config_dir(); 352 | } 353 | 354 | let mut config = match load_config_from_file() { 355 | Ok(x) => x, 356 | Err(e) => { 357 | println!( 358 | "{}{}Error!{} Could not load config:\n{}\nUsing default config.", 359 | Attribute::Bold, 360 | Colored::Fg(Color::Red), 361 | Attribute::Reset, 362 | e 363 | ); 364 | get_default_config() 365 | } 366 | }; 367 | validate_config(&mut config); 368 | config 369 | } 370 | 371 | fn get_default_config() -> Config { 372 | let mut engs = HashMap::new(); 373 | engs.insert( 374 | "_default".to_string(), 375 | Engine { 376 | name: "Google".to_string(), 377 | suggestion_url: "https://www.google.com/complete/search?client=chrome&q=%s".to_string(), 378 | search_url: "https://www.google.com/search?q=%s".to_string(), 379 | space_becomes: "+".into(), 380 | suggestion_adapter: Default::default(), 381 | prompt: Prompt { 382 | icon_fg: Color::White, 383 | icon_bg: Color::Blue, 384 | icon: String::from(" g "), 385 | text_fg: Color::Black, 386 | text_bg: Color::White, 387 | text: String::from(" Google "), 388 | }, 389 | }, 390 | ); 391 | engs.insert( 392 | "ddg".to_string(), 393 | Engine { 394 | name: "DuckDuckGo".to_string(), 395 | suggestion_url: "https://duckduckgo.com/ac/?q=%s&type=list".to_string(), 396 | search_url: "https://duckduckgo.com/?q=%s".to_string(), 397 | space_becomes: "+".into(), 398 | suggestion_adapter: Default::default(), 399 | prompt: Prompt { 400 | icon_fg: Color::White, 401 | icon_bg: Color::Rgb { 402 | r: 222, 403 | g: 88, 404 | b: 51, 405 | }, 406 | icon: String::from(" ♞ "), 407 | text_fg: Color::Black, 408 | text_bg: Color::White, 409 | text: DEFAULT_NAME.into(), 410 | }, 411 | }, 412 | ); 413 | engs.insert( 414 | "g".to_string(), 415 | Engine { 416 | name: "Google (I'm Feeling Lucky)".to_string(), 417 | suggestion_url: "https://www.google.com/complete/search?client=chrome&q=%s".to_string(), 418 | search_url: "https://www.google.com/search?btnI&q=%s".to_string(), 419 | space_becomes: "+".into(), 420 | suggestion_adapter: Default::default(), 421 | prompt: Prompt { 422 | icon_fg: Color::White, 423 | icon_bg: Color::Blue, 424 | icon: String::from(" g "), 425 | text_fg: Color::Black, 426 | text_bg: Color::White, 427 | text: " I'm Feeling Lucky ".into(), 428 | }, 429 | }, 430 | ); 431 | engs.insert( 432 | "red".to_string(), 433 | Engine { 434 | name: "Reddit".to_string(), 435 | suggestion_url: "https://www.google.com/complete/search?client=chrome&q=%s".to_string(), 436 | search_url: "https://www.google.com/search?q=site:reddit.com+%s".to_string(), 437 | space_becomes: "+".into(), 438 | suggestion_adapter: Default::default(), 439 | prompt: Prompt { 440 | icon_fg: Color::White, 441 | icon_bg: Color::Rgb { 442 | r: 255, 443 | g: 69, 444 | b: 0, 445 | }, 446 | icon: String::from(" ⬬ "), 447 | text_fg: Color::Black, 448 | text_bg: Color::White, 449 | text: DEFAULT_NAME.into(), 450 | }, 451 | }, 452 | ); 453 | engs.insert( 454 | "wkt".to_string(), 455 | Engine { 456 | name: "Wiktionary".to_string(), 457 | suggestion_url: "https://en.wiktionary.org/w/api.php?action=opensearch&search=%s&limit=15&namespace=0&format=json".to_string(), 458 | search_url: "https://www.wiktionary.org/search-redirect.php?family=wiktionary&language=en&search=%s&go=Go".to_string(), 459 | space_becomes: "+".into(), 460 | suggestion_adapter: Default::default(), 461 | prompt: Prompt { 462 | icon_fg: Color::Black, 463 | icon_bg: Color::White, 464 | icon: String::from("['w]"), 465 | text_fg: Color::Black, 466 | text_bg: Color::White, 467 | text: DEFAULT_NAME.into() 468 | }, 469 | }, 470 | ); 471 | engs.insert( 472 | "w".to_string(), 473 | Engine { 474 | name: "Wikipedia".to_string(), 475 | suggestion_url: "https://en.wikipedia.org/w/api.php?action=opensearch&search=%s&limit=15&namespace=0&format=json".to_string(), 476 | search_url: "https://www.wikipedia.org/search-redirect.php?family=wikipedia&language=en&search=%s&language=en&go=Go".to_string(), 477 | space_becomes: "+".into(), 478 | suggestion_adapter: Default::default(), 479 | prompt: Prompt { 480 | icon_fg: Color::Black, 481 | icon_bg: Color::White, 482 | icon: String::from(" W "), 483 | text_fg: Color::Black, 484 | text_bg: Color::White, 485 | text: DEFAULT_NAME.into() 486 | }, 487 | }, 488 | ); 489 | engs.insert( 490 | "yt".to_string(), 491 | Engine { 492 | name: "YouTube".to_string(), 493 | suggestion_url: 494 | "http://suggestqueries.google.com/complete/search?client=firefox&ds=yt&q=%s" 495 | .to_string(), 496 | search_url: "https://www.youtube.com/results?q=%s".to_string(), 497 | space_becomes: "+".into(), 498 | suggestion_adapter: Default::default(), 499 | prompt: Prompt { 500 | icon_fg: Color::White, 501 | icon_bg: Color::Red, 502 | icon: String::from(" ▶ "), 503 | text_fg: Color::Black, 504 | text_bg: Color::White, 505 | text: DEFAULT_NAME.into(), 506 | }, 507 | }, 508 | ); 509 | engs.insert( 510 | "r".to_string(), 511 | Engine { 512 | name: "Subreddit".to_string(), 513 | suggestion_url: "https://www.reddit.com/api/search_reddit_names.json?query=%s" 514 | .to_string(), 515 | search_url: "https://www.reddit.com/r/%s".to_string(), 516 | space_becomes: "".into(), // subreddits dont have spaces 517 | suggestion_adapter: SuggestionAdapterName::JsonPath("names".into()), 518 | prompt: Prompt { 519 | icon_fg: Color::White, 520 | icon_bg: Color::Rgb { 521 | r: 255, 522 | g: 69, 523 | b: 0, 524 | }, 525 | icon: String::from(" ⬬ "), 526 | text_fg: Color::Black, 527 | text_bg: Color::White, 528 | text: DEFAULT_NAME.into(), 529 | }, 530 | }, 531 | ); 532 | let mut keybinds = HashMap::new(); 533 | 534 | keybinds.insert(KeyBind(KeyEvent::Ctrl('c')), BindableAction::Exit); 535 | keybinds.insert(KeyBind(KeyEvent::Esc), BindableAction::Exit); 536 | keybinds.insert(KeyBind(KeyEvent::Char('\n')), BindableAction::Submit); 537 | keybinds.insert(KeyBind(KeyEvent::Ctrl('w')), BindableAction::DeleteWord); 538 | keybinds.insert(KeyBind(KeyEvent::Ctrl('n')), BindableAction::SelectNext); 539 | keybinds.insert(KeyBind(KeyEvent::Char('\t')), BindableAction::SelectNext); 540 | keybinds.insert(KeyBind(KeyEvent::Down), BindableAction::SelectNext); 541 | keybinds.insert(KeyBind(KeyEvent::Ctrl('p')), BindableAction::SelectPrev); 542 | keybinds.insert(KeyBind(KeyEvent::BackTab), BindableAction::SelectPrev); 543 | keybinds.insert(KeyBind(KeyEvent::Up), BindableAction::SelectPrev); 544 | keybinds.insert(KeyBind(KeyEvent::Backspace), BindableAction::DeleteChar); 545 | 546 | Config { 547 | engines: engs, 548 | keybinds, 549 | } 550 | } 551 | pub fn serialize_color(x: &Color, s: S) -> Result 552 | where 553 | S: Serializer, 554 | { 555 | match x { 556 | Color::Rgb { r, g, b } => { 557 | let mut state = s.serialize_seq(Some(3))?; 558 | state.serialize_element(r)?; 559 | state.serialize_element(g)?; 560 | state.serialize_element(b)?; 561 | state.end() 562 | } 563 | Color::AnsiValue(v) => s.serialize_u8(*v), 564 | x => s.serialize_str(&format!("{:?}", x)), 565 | } 566 | } 567 | 568 | pub fn deserialize_color<'de, D>(d: D) -> Result 569 | where 570 | D: Deserializer<'de>, 571 | { 572 | d.deserialize_any(ColorVisitor) 573 | } 574 | 575 | use serde::de::{self, Visitor}; 576 | 577 | struct ColorVisitor; 578 | 579 | impl<'de> Visitor<'de> for ColorVisitor { 580 | type Value = Color; 581 | 582 | fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result { 583 | formatter.write_str("A string (name), u8 number (ansi color), or an [r,g,b] u8 array") 584 | } 585 | 586 | fn visit_str(self, value: &str) -> Result 587 | where 588 | E: de::Error, 589 | { 590 | Color::from_str(value).or_else(|_| { 591 | Err(E::custom(format!( 592 | "Invalid color name: {}. See crossterm's Color enum for valid values.", 593 | value 594 | ))) 595 | }) 596 | } 597 | 598 | fn visit_u8(self, value: u8) -> Result 599 | where 600 | E: de::Error, 601 | { 602 | Ok(Color::AnsiValue(value)) 603 | } 604 | 605 | fn visit_seq(self, mut seq: A) -> Result 606 | where 607 | A: SeqAccess<'de>, 608 | { 609 | let r: u8 = match seq.next_element()? { 610 | Some(nth) => nth, 611 | None => { 612 | return Err(de::Error::custom(format!( 613 | "R component invalid, should be a value 0-255." 614 | ))); 615 | } 616 | }; 617 | let g: u8 = match seq.next_element()? { 618 | Some(nth) => nth, 619 | None => { 620 | return Err(de::Error::custom(format!( 621 | "G component invalid, should be a value 0-255." 622 | ))); 623 | } 624 | }; 625 | let b: u8 = match seq.next_element()? { 626 | Some(nth) => nth, 627 | None => { 628 | return Err(de::Error::custom(format!( 629 | "B component invalid, should be a value 0-255." 630 | ))); 631 | } 632 | }; 633 | Ok(Color::Rgb { r, g, b }) 634 | } 635 | } 636 | -------------------------------------------------------------------------------- /src/engine.rs: -------------------------------------------------------------------------------- 1 | // ************************************************************************* 2 | // * Copyright (C) 2019 Dmitry Narkevich (me@dmitry.lol) * 3 | // * * 4 | // * This program 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 | // * This program 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 this program. If not, see . * 16 | // ************************************************************************* 17 | 18 | use crate::*; 19 | use crate::config::*; 20 | 21 | use std::fmt::{Formatter,Display}; 22 | use serde::{Deserialize, Serialize}; 23 | use percent_encoding::{utf8_percent_encode, DEFAULT_ENCODE_SET}; 24 | 25 | const DEFAULT_NAME: &str = "%%DEFAULT%%"; 26 | 27 | 28 | 29 | #[derive(Serialize, Deserialize)] 30 | pub struct Engine { 31 | #[serde(default = "default_prompt")] 32 | pub prompt: Prompt, 33 | pub name: String, 34 | #[serde(default)] 35 | pub suggestion_url: String, 36 | pub search_url: String, 37 | #[serde(default = "_default_space_becomes", skip_serializing_if = "_is_default_space_becomes")] 38 | pub space_becomes: String, 39 | #[serde(default, skip_serializing_if = "is_default")] 40 | pub suggestion_adapter: SuggestionAdapterName 41 | } 42 | 43 | impl Engine { 44 | fn encode(&self, s: &str) -> String { 45 | utf8_percent_encode(&s.replace(" ", &self.space_becomes), DEFAULT_ENCODE_SET).to_string().replace("+", "%2B").into() 46 | } 47 | pub fn format_suggestion_url(&self, search_term: &str) -> String { 48 | self.suggestion_url 49 | .replace("%s", &self.encode(&search_term)) 50 | } 51 | pub fn format_search_url(&self, search_term: &str) -> String { 52 | self.search_url 53 | .replace("%s", &self.encode(&search_term)) 54 | } 55 | } 56 | 57 | #[derive(Clone, Deserialize, Serialize)] 58 | pub struct Prompt { 59 | #[serde( 60 | deserialize_with = "deserialize_color", 61 | serialize_with = "serialize_color", 62 | default = "_white" 63 | )] 64 | pub icon_fg: Color, 65 | #[serde( 66 | deserialize_with = "deserialize_color", 67 | serialize_with = "serialize_color", 68 | default = "_black" 69 | )] 70 | pub icon_bg: Color, 71 | #[serde(default)] 72 | pub icon: String, 73 | #[serde( 74 | deserialize_with = "deserialize_color", 75 | serialize_with = "serialize_color", 76 | default = "_black" 77 | )] 78 | pub text_fg: Color, 79 | #[serde( 80 | deserialize_with = "deserialize_color", 81 | serialize_with = "serialize_color", 82 | default = "_white" 83 | )] 84 | pub text_bg: Color, 85 | // TODO: figure out how Option is serialized instead of this heck 86 | #[serde(default = "_default_name", skip_serializing_if = "_is_default_name")] 87 | pub text: String, 88 | } 89 | impl Prompt { 90 | pub fn to_short(&self) -> ShortPrompt { 91 | ShortPrompt(self) 92 | } 93 | 94 | } 95 | impl Display for Prompt { 96 | fn fmt(&self, f: &mut Formatter) -> Result<(), std::fmt::Error> { 97 | write!(f, 98 | "{}{}{}{}", 99 | Colored::Fg(self.icon_fg), 100 | Colored::Bg(self.icon_bg), 101 | self.icon, 102 | Attribute::Reset 103 | )?; // icon 104 | write!(f, 105 | "{}{}{}{}", 106 | Colored::Fg(self.text_fg), 107 | Colored::Bg(self.text_bg), 108 | self.text, 109 | Attribute::Reset 110 | )?; // promptt text 111 | Ok(()) 112 | } 113 | } 114 | 115 | pub struct ShortPrompt<'a> (&'a Prompt); 116 | 117 | impl<'a> Display for ShortPrompt<'a> { 118 | fn fmt(& self, f: &mut Formatter) -> Result<(), std::fmt::Error> { 119 | write!(f, 120 | "{}{}{}{}", 121 | Colored::Fg(self.0.icon_fg), 122 | Colored::Bg(self.0.icon_bg), 123 | self.0.icon, 124 | Attribute::Reset 125 | )?; // icon 126 | Ok(()) 127 | } 128 | } 129 | 130 | // TODO: this should prolly return slices, not Strings 131 | pub fn match_engine<'a, 'b>( 132 | input_line: &'b str, 133 | engines: &'a HashMap, 134 | ) -> (&'a Engine, String, String) { 135 | let default_engine = engines.get("").unwrap(); 136 | 137 | // escape search engine keyword with question mark like Chrome 138 | if input_line.starts_with("?") { 139 | return (default_engine, String::new(), input_line[1..].to_string()); 140 | } 141 | 142 | let words: Vec<&str> = input_line.split_whitespace().collect(); 143 | 144 | // in the empty case, or if a keyword is typed but there's no space after it, skip matching. 145 | if words.len() < 1 || (words.len() == 1 && !input_line.ends_with(" ")) { 146 | return (default_engine, String::new(), input_line.trim().to_string()); 147 | } 148 | 149 | let potential_prefix = words.first().unwrap(); 150 | match engines.get(&potential_prefix.to_string()) { 151 | Some(engine) => { 152 | let search_term = input_line[potential_prefix.len()..].trim().to_string(); 153 | (engine, potential_prefix.to_string(), search_term) 154 | } 155 | None => (default_engine, String::new(), input_line.trim().to_string()), 156 | } 157 | } 158 | 159 | fn default_prompt() -> Prompt { 160 | Prompt { 161 | icon_fg: Color::White, 162 | icon_bg: Color::Blue, 163 | icon: String::from(" > "), 164 | text_fg: Color::Black, 165 | text_bg: Color::White, 166 | text: String::from(DEFAULT_NAME), 167 | } 168 | } 169 | 170 | fn _default_name() -> String { 171 | DEFAULT_NAME.into() 172 | } 173 | fn _is_default_name(s: &str) -> bool { 174 | s == _default_name() 175 | } 176 | fn _default_space_becomes() -> String { 177 | " ".into() 178 | } 179 | fn _is_default_space_becomes(s: &str) -> bool { 180 | s == _default_space_becomes() 181 | } 182 | fn _white() -> Color { 183 | Color::White 184 | } 185 | fn _black() -> Color { 186 | Color::Black 187 | } 188 | -------------------------------------------------------------------------------- /src/main.rs: -------------------------------------------------------------------------------- 1 | // ************************************************************************* 2 | // * Copyright (C) 2019 Dmitry Narkevich (me@dmitry.lol) * 3 | // * * 4 | // * This program 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 | // * This program 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 this program. If not, see . * 16 | // ************************************************************************* 17 | 18 | extern crate crossterm; 19 | extern crate directories; 20 | extern crate json; 21 | extern crate minreq; 22 | extern crate serde; 23 | extern crate toml; 24 | extern crate webbrowser; 25 | 26 | use crossterm::{ 27 | input, Attribute, ClearType, Color, Colored, Crossterm, InputEvent, KeyEvent, RawScreen, 28 | }; 29 | 30 | use std::cmp::min; 31 | use std::collections::HashMap; 32 | use std::result::Result; 33 | use std::sync::mpsc; 34 | use std::thread; 35 | 36 | mod config; 37 | mod engine; 38 | mod suggestion_adapter; 39 | mod util; 40 | 41 | use config::*; 42 | use engine::*; 43 | use suggestion_adapter::*; 44 | use util::*; 45 | 46 | #[allow(unused_must_use)] 47 | fn main() { 48 | let (tx, rx) = mpsc::channel(); 49 | 50 | let config = get_config(); 51 | let engines = config.engines; 52 | let _screen = RawScreen::into_raw_mode(); 53 | let crossterm = Crossterm::new(); 54 | let mut cursor = crossterm.cursor(); 55 | let terminal = crossterm.terminal(); 56 | 57 | let input = input(); 58 | let mut stdin = input.read_sync(); 59 | let mut input_buf = String::new(); 60 | 61 | let keybindings = config.keybinds; 62 | let input_tx = tx.clone(); 63 | let input_thread = thread::spawn(move || loop { 64 | let key = stdin.next(); 65 | match key { 66 | Some(InputEvent::Keyboard(k)) => { 67 | let keybind = KeyBind { 0: k }; 68 | match keybindings.get(&keybind) { 69 | Some(BindableAction::Submit) => { 70 | input_tx.send(UiMsg::OnInput(BindableAction::Submit)); 71 | break; 72 | } 73 | Some(BindableAction::Exit) => { 74 | input_tx.send(UiMsg::OnInput(BindableAction::Exit)); 75 | break; 76 | } 77 | Some(act) => { 78 | input_tx.send(UiMsg::OnInput(act.clone())); 79 | } 80 | None => { 81 | if let KeyEvent::Char(c) = keybind.0 { 82 | input_tx.send(UiMsg::OnInput(BindableAction::AddChar(c))); 83 | } 84 | } 85 | } 86 | } 87 | _ => {} 88 | } 89 | }); 90 | 91 | cursor.hide(); 92 | let mut input_line: String = String::from(""); 93 | let mut suggs: Option = None; 94 | let mut prompt = &engines.get("").expect("No default engine set.").prompt; 95 | let mut waiting_for_term: Option = None; // the term for which we are expecting suggestions (in case of out-of-order resolves) 96 | let mut selected_n: Option = None; 97 | 98 | let mut prev_engine: Option<&Engine> = None; 99 | let mut refresh_completions = true; 100 | 101 | let mut t_w: u16; 102 | // main UI loop 103 | loop { 104 | t_w = terminal.terminal_size().0; // refresh terminal width in case it was resized 105 | let (engine, prefix, search_term) = match_engine(&input_line, &engines); 106 | if let Some(ref prev_engine) = prev_engine { 107 | // if the engine has changed (based on suggestion url) 108 | if prev_engine.suggestion_url != engine.suggestion_url { 109 | suggs = None; // clear the list that gets drawn asap 110 | refresh_completions = true; // and force an update 111 | } 112 | } 113 | prev_engine = Some(&engine); 114 | if refresh_completions { 115 | prompt = &engine.prompt; 116 | if search_term.is_empty() { 117 | suggs = None; 118 | waiting_for_term = None; 119 | } else { 120 | waiting_for_term = Some(search_term.clone()); 121 | let url = engine.format_suggestion_url(&search_term); 122 | let tx2 = tx.clone(); 123 | // TODO: this should be done with boxed traits I think? 124 | let sugg_adapter = engine.suggestion_adapter.clone(); 125 | let search_term2 = search_term.clone(); 126 | // spawn a separate thread to do the http request and send the result to the 127 | // channel that this thread is receiving on 128 | if !url.is_empty() { 129 | thread::spawn(move || { 130 | let resolved_suggs = match sugg_adapter { 131 | SuggestionAdapterName::OpenSearch => { 132 | OpenSearchAdapter::get(url, search_term2) 133 | } 134 | SuggestionAdapterName::JsonPath(path) => { 135 | JsonPathAdapter(path).get(url, search_term2) 136 | } 137 | }; 138 | match resolved_suggs{ 139 | Ok(resolved_suggs) => { 140 | tx2.send(UiMsg::SetSuggestions(resolved_suggs)); 141 | } 142 | Err(e) => { 143 | // hacky but i want the error to be seen 144 | for _ in 1..20 { 145 | println!("Error: {}", e); 146 | } 147 | } 148 | } 149 | }); 150 | } 151 | } 152 | refresh_completions = false; 153 | selected_n = None; 154 | } 155 | cursor.move_left(t_w); 156 | terminal.clear(ClearType::CurrentLine); 157 | 158 | let full_prompt_line = format!("{} {}_", prompt, input_line); 159 | if full_prompt_line.len() >= t_w as usize { 160 | let short_prompt = format!("{}", prompt.to_short()); 161 | print!("{}", short_prompt); 162 | // 2 = spacer + cursor 163 | // TODO: don't count control characters for length 164 | let room_for_input_line = (t_w as usize) 165 | .checked_sub(short_prompt.len() + 2) 166 | .unwrap_or(0); 167 | let truncated_input_line = truncate_from_end(&input_line, room_for_input_line); 168 | println!(" {}_", truncated_input_line); 169 | } else { 170 | // just printing full_prompt_line doesn't preserve colours for some reason 171 | println!("{} {}_", prompt, input_line); 172 | } 173 | 174 | let suggest_lines = 15; /*if let Some(ref suggs) = suggs { 175 | suggs.sugg_terms.len() 176 | } else { 177 | 0 178 | }; */ 179 | let selectable_lines = if let Some(ref suggs) = suggs { 180 | min(suggest_lines, suggs.sugg_terms.len()) 181 | } else { 182 | 0 183 | }; 184 | for n in 0..suggest_lines { 185 | terminal.clear(ClearType::CurrentLine); 186 | cursor.move_left(t_w); 187 | 188 | if let Some(ref suggs) = suggs { 189 | match suggs.sugg_terms.get(n) { 190 | Some(line) => { 191 | let line_trunc = truncate_from_end(&line, t_w as usize); 192 | match selected_n { 193 | Some(selected_n) if selected_n == n => { 194 | print!( 195 | "{}{}{}{}", 196 | Colored::Fg(Color::Black), 197 | Colored::Bg(Color::White), 198 | line_trunc, 199 | Attribute::Reset 200 | ); 201 | } 202 | _ => { 203 | print!("{}", line_trunc); 204 | } 205 | } 206 | } 207 | None => {} // outside sugg bounds 208 | } 209 | } 210 | 211 | println!(); 212 | } 213 | let msg = rx.recv().unwrap(); 214 | match msg { 215 | UiMsg::SetSuggestions(suggestion_update) => { 216 | if let Some(ref expected_term) = waiting_for_term { 217 | if &suggestion_update.term == expected_term { 218 | suggs = Some(suggestion_update); 219 | } 220 | } 221 | } 222 | UiMsg::OnInput(key) => { 223 | refresh_completions = true; 224 | match key { 225 | BindableAction::Submit => { 226 | input_buf.clear(); 227 | let url = engine.format_search_url(&search_term); 228 | for _ in 0..suggest_lines { 229 | cursor.move_up(1); 230 | terminal.clear(ClearType::CurrentLine); 231 | } 232 | cursor.move_left(t_w); 233 | println!("Opening {}", url); 234 | terminal.clear(ClearType::CurrentLine); 235 | webbrowser::open(&url).expect("Couldn't open browser."); 236 | break; 237 | } 238 | BindableAction::SelectNext => { 239 | if let Some(ref suggs) = suggs { 240 | selected_n = Some(if let Some(selected_n) = selected_n { 241 | selected_n + 1 242 | } else { 243 | 0 244 | }); 245 | if selected_n.unwrap() >= selectable_lines { 246 | selected_n = Some(0); 247 | } 248 | if let Some(selected) = suggs.sugg_terms.get(selected_n.unwrap()) { 249 | let (_, interfering_prefix, _) = match_engine(&selected, &engines); 250 | input_line = input_line_from_selection( 251 | &interfering_prefix, 252 | &prefix, 253 | &selected, 254 | ); 255 | refresh_completions = false; 256 | } 257 | } 258 | } 259 | BindableAction::SelectPrev => { 260 | if let Some(ref suggs) = suggs { 261 | selected_n = Some( 262 | selected_n 263 | .unwrap_or(0) 264 | .checked_sub(1) 265 | .unwrap_or(selectable_lines.checked_sub(1).unwrap_or(0)), 266 | ); 267 | if let Some(selected) = suggs.sugg_terms.get(selected_n.unwrap()) { 268 | let (_, interfering_prefix, _) = match_engine(&selected, &engines); 269 | input_line = input_line_from_selection( 270 | &interfering_prefix, 271 | &prefix, 272 | &selected, 273 | ); 274 | refresh_completions = false; 275 | } 276 | } 277 | } 278 | 279 | BindableAction::DeleteChar => { 280 | input_line.pop(); 281 | selected_n = None; 282 | } 283 | BindableAction::Exit => { 284 | terminal.clear(ClearType::CurrentLine); 285 | for _ in 0..suggest_lines { 286 | cursor.move_up(1); 287 | terminal.clear(ClearType::CurrentLine); 288 | } 289 | break; 290 | } 291 | BindableAction::DeleteWord => { 292 | // delete last word (trim, then delete backwards until first 293 | // word character or beginning of line 294 | input_line = input_line 295 | .trim_end() 296 | .trim_end_matches(|x: char| !x.is_whitespace()) 297 | .to_string(); 298 | } 299 | BindableAction::AddChar(character) => { 300 | // if we don't want spaces in the search term, like with subreddits 301 | // just make space only select a suggestion if one is highlighted 302 | if !(character == ' ' && engine.space_becomes.is_empty()) { 303 | input_line.push(character as char); 304 | } 305 | selected_n = None; 306 | } 307 | _ => {} 308 | } 309 | } 310 | }; 311 | cursor.move_up(suggest_lines as u16 + 1); 312 | } 313 | cursor.show(); 314 | cursor.move_left(t_w); 315 | 316 | input_thread.join(); 317 | } 318 | 319 | fn input_line_from_selection( 320 | prefix_in_result: &str, 321 | current_prefix: &str, 322 | selected_result: &str, 323 | ) -> String { 324 | if !prefix_in_result.is_empty() { 325 | // selected_result starts with a prefix that matches one of our engines 326 | if !current_prefix.is_empty() { 327 | // but we already have a prefix entered, so no escaping needed 328 | // just use the result while keeping our existing prefix 329 | format!("{} {}", current_prefix, selected_result) 330 | } else { 331 | // don't want the prefix in the result to trigger an engine, so escape it 332 | format!("?{}", selected_result) 333 | } 334 | } else { 335 | // no conflict, so just use the result while keeping our existing prefix 336 | if !current_prefix.is_empty() { 337 | format!("{} {}", current_prefix, selected_result) 338 | } else { 339 | // our prefix is empty, and the result doesn't start with a prefix 340 | // this is a separate branch so that a space isn't inserted before the result 341 | format!("{}", selected_result) 342 | } 343 | } 344 | } 345 | 346 | // mirrors opensearch schema 347 | #[derive(Debug)] 348 | pub struct Suggestions { 349 | term: String, 350 | sugg_terms: Vec, 351 | //descriptions: Vec, 352 | //urls: Vec 353 | } 354 | 355 | enum UiMsg { 356 | SetSuggestions(Suggestions), 357 | OnInput(BindableAction), 358 | } 359 | -------------------------------------------------------------------------------- /src/suggestion_adapter.rs: -------------------------------------------------------------------------------- 1 | // ************************************************************************* 2 | // * Copyright (C) 2019 Dmitry Narkevich (me@dmitry.lol) * 3 | // * * 4 | // * This program 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 | // * This program 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 this program. If not, see . * 16 | // ************************************************************************* 17 | 18 | use crate::*; 19 | 20 | pub trait SuggestionAdapter { 21 | fn get(url:String, term: String) -> Result>; 22 | 23 | } 24 | pub struct OpenSearchAdapter; 25 | impl SuggestionAdapter for OpenSearchAdapter { 26 | fn get(url: String, _term: String) -> Result> { 27 | let text = minreq::get(url).send()?.body; 28 | let data = json::parse(&text)?; 29 | let term = data[0] 30 | .as_str() 31 | .ok_or("first array value not a string")? 32 | .to_string(); 33 | let sugg_terms: Vec = data[1].members().map(|opt|opt.as_str().expect("one of the values in the second value (which should be an array) is not a string").to_string()).collect(); // todo: error handling 34 | Ok(Suggestions { term, sugg_terms }) 35 | } 36 | } 37 | pub struct JsonPathAdapter(pub String); 38 | impl JsonPathAdapter { 39 | pub fn get(self, url: String, term: String) -> Result> { 40 | let text = minreq::get(url).send()?.body; 41 | let data = json::parse(&text)?; 42 | let path = self.0.split('.'); 43 | let mut obj = data; 44 | 45 | for segment in path { 46 | obj = obj[segment].take(); 47 | } 48 | 49 | if !obj.is_array() { 50 | return Err(Box::new(ConfigError::new(&format!("JsonPath '{}' doesn't lead to an array!", &self.0)))); 51 | } 52 | 53 | let sugg_terms: Vec = obj.members().map(|opt|opt.as_str().expect("non-string value under jsonpath target").to_string()).collect(); // todo: error handling 54 | Ok(Suggestions { term, sugg_terms }) 55 | } 56 | } 57 | -------------------------------------------------------------------------------- /src/util.rs: -------------------------------------------------------------------------------- 1 | // ************************************************************************* 2 | // * Copyright (C) 2019 Dmitry Narkevich (me@dmitry.lol) * 3 | // * * 4 | // * This program 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 | // * This program 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 this program. If not, see . * 16 | // ************************************************************************* 17 | 18 | use crate::*; 19 | 20 | pub fn truncate_from_end(s: &str, n: usize) -> String { 21 | if s.len() <= n { 22 | s.into() 23 | } else { 24 | let delta = s.len() - n; // how many characters don't fit 25 | let truncd = &s[delta..]; 26 | let non_dots = &truncd[min(3, truncd.len())..]; // part of string that doesn't get turned into dots 27 | let with_dots = format!("...{}", non_dots); 28 | with_dots[with_dots.len().checked_sub(n).unwrap_or(0)..].into() 29 | } 30 | } 31 | 32 | pub fn is_default(t: &T) -> bool { 33 | t == &T::default() 34 | } 35 | 36 | #[cfg(test)] 37 | mod tests { 38 | use super::*; 39 | 40 | #[test] 41 | fn no_trunc() { 42 | assert_eq!(truncate_from_end("abcd", 5), "abcd"); 43 | assert_eq!(truncate_from_end("abcd", 4), "abcd"); 44 | assert_eq!(truncate_from_end("", 4), ""); 45 | } 46 | 47 | #[test] 48 | fn trunc() { 49 | assert_eq!(truncate_from_end("abcd", 0), ""); 50 | assert_eq!(truncate_from_end("abcd", 1), "."); 51 | assert_eq!(truncate_from_end("ab", 1), "."); 52 | assert_eq!(truncate_from_end("abcd", 2), ".."); 53 | assert_eq!(truncate_from_end("abcd", 3), "..."); 54 | assert_eq!(truncate_from_end("abcde", 4), "...e"); 55 | assert_eq!(truncate_from_end("the quick brown", 8), "...brown"); 56 | 57 | } 58 | } 59 | 60 | --------------------------------------------------------------------------------