├── caches └── .gitignore ├── queries ├── .gitignore ├── default-fulltext.json ├── default-id.json ├── default-fulltext-landscape.json ├── default-random-asian-art.json ├── default-random-landscape.json └── default-random-oil-painting.json ├── example.png ├── CODE_OF_CONDUCT.md ├── README.md ├── aic.sh └── LICENSE /caches/.gitignore: -------------------------------------------------------------------------------- 1 | * 2 | !.gitignore 3 | -------------------------------------------------------------------------------- /queries/.gitignore: -------------------------------------------------------------------------------- 1 | * 2 | !.gitignore 3 | !default-* 4 | -------------------------------------------------------------------------------- /example.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/art-institute-of-chicago/aic-bash/HEAD/example.png -------------------------------------------------------------------------------- /queries/default-fulltext.json: -------------------------------------------------------------------------------- 1 | { 2 | "resources": "artworks", 3 | "fields": [ 4 | "id", 5 | "title", 6 | "artist_display", 7 | "date_display", 8 | "image_id" 9 | ], 10 | "limit": "VAR_LIMIT", 11 | "q": "VAR_FULLTEXT", 12 | "query": { 13 | "bool": { 14 | "filter": [ 15 | { 16 | "term": { 17 | "is_public_domain": true 18 | } 19 | }, 20 | { 21 | "exists": { 22 | "field": "image_id" 23 | } 24 | } 25 | ] 26 | } 27 | } 28 | } 29 | -------------------------------------------------------------------------------- /queries/default-id.json: -------------------------------------------------------------------------------- 1 | { 2 | "resources": "artworks", 3 | "fields": [ 4 | "id", 5 | "title", 6 | "artist_display", 7 | "date_display", 8 | "image_id" 9 | ], 10 | "limit": 1, 11 | "query": { 12 | "bool": { 13 | "filter": [ 14 | { 15 | "term": { 16 | "id": "VAR_ID" 17 | } 18 | }, 19 | { 20 | "term": { 21 | "is_public_domain": true 22 | } 23 | }, 24 | { 25 | "exists": { 26 | "field": "image_id" 27 | } 28 | } 29 | ] 30 | } 31 | } 32 | } 33 | 34 | 35 | 36 | -------------------------------------------------------------------------------- /queries/default-fulltext-landscape.json: -------------------------------------------------------------------------------- 1 | { 2 | "resources": "artworks", 3 | "fields": [ 4 | "id", 5 | "title", 6 | "artist_display", 7 | "date_display", 8 | "image_id" 9 | ], 10 | "limit": "VAR_LIMIT", 11 | "q": "VAR_FULLTEXT", 12 | "query": { 13 | "bool": { 14 | "filter": [ 15 | { 16 | "term": { 17 | "subject_ids": "TM-8657" 18 | } 19 | }, 20 | { 21 | "term": { 22 | "is_public_domain": true 23 | } 24 | }, 25 | { 26 | "exists": { 27 | "field": "image_id" 28 | } 29 | } 30 | ] 31 | } 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /queries/default-random-asian-art.json: -------------------------------------------------------------------------------- 1 | { 2 | "resources": "artworks", 3 | "fields": [ 4 | "id", 5 | "title", 6 | "artist_display", 7 | "date_display", 8 | "image_id" 9 | ], 10 | "boost": false, 11 | "limit": 1, 12 | "query": { 13 | "function_score": { 14 | "query": { 15 | "bool": { 16 | "filter": [ 17 | { 18 | "term": { 19 | "department_id": "PC-7" 20 | } 21 | }, 22 | { 23 | "term": { 24 | "is_public_domain": true 25 | } 26 | }, 27 | { 28 | "exists": { 29 | "field": "image_id" 30 | } 31 | } 32 | ] 33 | } 34 | }, 35 | "boost_mode": "replace", 36 | "random_score": { 37 | "field": "id", 38 | "seed": "VAR_SEED" 39 | } 40 | } 41 | } 42 | } 43 | -------------------------------------------------------------------------------- /queries/default-random-landscape.json: -------------------------------------------------------------------------------- 1 | { 2 | "resources": "artworks", 3 | "fields": [ 4 | "id", 5 | "title", 6 | "artist_display", 7 | "date_display", 8 | "image_id" 9 | ], 10 | "boost": false, 11 | "limit": 1, 12 | "query": { 13 | "function_score": { 14 | "query": { 15 | "bool": { 16 | "filter": [ 17 | { 18 | "term": { 19 | "subject_ids": "TM-8657" 20 | } 21 | }, 22 | { 23 | "term": { 24 | "is_public_domain": true 25 | } 26 | }, 27 | { 28 | "exists": { 29 | "field": "image_id" 30 | } 31 | } 32 | ] 33 | } 34 | }, 35 | "boost_mode": "replace", 36 | "random_score": { 37 | "field": "id", 38 | "seed": "VAR_SEED" 39 | } 40 | } 41 | } 42 | } 43 | -------------------------------------------------------------------------------- /queries/default-random-oil-painting.json: -------------------------------------------------------------------------------- 1 | { 2 | "resources": "artworks", 3 | "fields": [ 4 | "id", 5 | "title", 6 | "artist_display", 7 | "date_display", 8 | "image_id" 9 | ], 10 | "boost": false, 11 | "limit": 1, 12 | "query": { 13 | "function_score": { 14 | "query": { 15 | "bool": { 16 | "filter": [ 17 | { 18 | "term": { 19 | "material_ids": "TM-2451" 20 | } 21 | }, 22 | { 23 | "term": { 24 | "is_public_domain": true 25 | } 26 | }, 27 | { 28 | "exists": { 29 | "field": "image_id" 30 | } 31 | } 32 | ] 33 | } 34 | }, 35 | "boost_mode": "replace", 36 | "random_score": { 37 | "field": "id", 38 | "seed": "VAR_SEED" 39 | } 40 | } 41 | } 42 | } 43 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, gender identity and expression, level of experience, 9 | nationality, personal appearance, race, religion, or sexual identity and 10 | orientation. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contributes to creating a positive environment 15 | include: 16 | 17 | * Using welcoming and inclusive language 18 | * Being respectful of differing viewpoints and experiences 19 | * Gracefully accepting constructive criticism 20 | * Focusing on what is best for the community 21 | * Showing empathy towards other community members 22 | 23 | Examples of unacceptable behavior by participants include: 24 | 25 | * The use of sexualized language or imagery and unwelcome sexual attention or 26 | advances 27 | * Trolling, insulting/derogatory comments, and personal or political attacks 28 | * Public or private harassment 29 | * Publishing others' private information, such as a physical or electronic 30 | address, without explicit permission 31 | * Other conduct which could reasonably be considered inappropriate in a 32 | professional setting 33 | 34 | ## Our Responsibilities 35 | 36 | Project maintainers are responsible for clarifying the standards of acceptable 37 | behavior and are expected to take appropriate and fair corrective action in 38 | response to any instances of unacceptable behavior. 39 | 40 | Project maintainers have the right and responsibility to remove, edit, or 41 | reject comments, commits, code, wiki edits, issues, and other contributions 42 | that are not aligned to this Code of Conduct, or to ban temporarily or 43 | permanently any contributor for other behaviors that they deem inappropriate, 44 | threatening, offensive, or harmful. 45 | 46 | ## Scope 47 | 48 | This Code of Conduct applies both within project spaces and in public spaces 49 | when an individual is representing the project or its community. Examples of 50 | representing a project or community include using an official project e-mail 51 | address, posting via an official social media account, or acting as an appointed 52 | representative at an online or offline event. Representation of a project may be 53 | further defined and clarified by project maintainers. 54 | 55 | ## Enforcement 56 | 57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 58 | reported by contacting the project team at engineering@artic.edu. All 59 | complaints will be reviewed and investigated and will result in a response that 60 | is deemed necessary and appropriate to the circumstances. The project team is 61 | obligated to maintain confidentiality with regard to the reporter of an incident. 62 | Further details of specific enforcement policies may be posted separately. 63 | 64 | Project maintainers who do not follow or enforce the Code of Conduct in good 65 | faith may face temporary or permanent repercussions as determined by other 66 | members of the project's leadership. 67 | 68 | ## Attribution 69 | 70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 71 | available at [http://contributor-covenant.org/version/1/4][version] 72 | 73 | [homepage]: http://contributor-covenant.org 74 | [version]: http://contributor-covenant.org/version/1/4/ 75 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![Art Institute of Chicago](https://raw.githubusercontent.com/Art-Institute-of-Chicago/template/master/aic-logo.gif) 2 | 3 | # aic-bash 4 | > A bash script to query our API for public domain artworks and render them as ASCII art 5 | 6 | Just a small side-project we did to show what could be done with our museum's API. 7 | 8 | The Art Institute of Chicago (AIC) offers all of its public data via a centralized, searchable API. There, you can find data on artworks, artists, and places represented in our collection, and much more besides. For more information, check out our [Open Access](https://www.artic.edu/open-access) initiatives. 9 | 10 | 11 | ![Screenshot](example.png) 12 | 13 | 14 | ## Requirements 15 | 16 | Please read this section in its entirety before installing anything. 17 | 18 | * A terminal with [truecolor (24bit) support](https://gist.github.com/XVilka/8346728) (recommendations below) 19 | * [Bash v4.2](https://www.tldp.org/LDP/abs/html/bashver4.html#AEN21220) (Feb. 2011) or higher 20 | * [coreutils](https://www.gnu.org/software/coreutils/) (for [realpath](https://unix.stackexchange.com/questions/101080/realpath-command-not-found)) 21 | * [jq](https://stedolan.github.io/jq/) 22 | * [jp2a](https://csl.name/jp2a/) v1.0.6 23 | * [ImageMagick](http://www.imagemagick.org) (only for `--ratio`) 24 | 25 | **Not all terminals support truecolor!** See [termstandard/colors](https://github.com/termstandard/colors) for more information. 26 | 27 | New to the command-line life? From testing, we recommend the following: 28 | 29 | * **macOS**: [iTerm2 v3](https://www.iterm2.com/) 30 | * **Win 10**: [Cmder + WSL](https://conemu.github.io/en/BashOnWindows.html#true-color) (see [Maximus5/ConEmu#920](https://github.com/Maximus5/ConEmu/issues/920)) 31 | 32 | Note that the default [Terminal.app](https://en.wikipedia.org/wiki/Terminal_(macOS)) which ships with macOS does *not* support truecolor. 33 | 34 | Likewise, macOS's default bash is locked to `3.2.57(1)-release` due to licensing issues. Instructions for upgrading: 35 | 36 | * [macos - Update bash to version 4.0 on OSX - Ask Different](https://apple.stackexchange.com/questions/193411/update-bash-to-version-4-0-on-osx) 37 | 38 | Lastly, **jq** and **jp2a** must be reachable via `$PATH`. You can install them using a package manager of your choice. 39 | 40 | ```bash 41 | # macOS with Homebrew 42 | brew install jq coreutils 43 | brew install https://raw.githubusercontent.com/Homebrew/homebrew-core/31b5579ccb72ccf24e9d01962e422aece563cff5/Formula/jp2a.rb 44 | 45 | # Ubuntu with APT 46 | sudo apt-get install jq jp2a coreutils 47 | ``` 48 | 49 | 50 | ### Debugging jp2a issues 51 | 52 | On macOS, if you see errors such as the following: 53 | 54 | ```bash 55 | $ ./aic.sh --id 27992 56 | ./aic.sh: line 428: 16#'cl,''l:'..........; : syntax error: invalid arithmetic operator (error token is "'cl,''l:'..........; ") 57 | 58 | $ ./aic.sh --id 28560 59 | ./aic.sh: line 428: 16#,.''ooolxOc.;cooollllcllollllcclllllllloxxdxxdocclollc:cdxxxdlcokxdoolccldddxdddddddll;clcc,c : syntax error: operand expected (error token is ".''ooolxOc.;cooollllcllollllcclllllllloxxdxxdocclollc:cdxxxdlcokxdoolccldddxdddddddll;clcc,c ") 60 | ``` 61 | 62 | ...you probably have jp2a v1.0.7, which is broken. Check here for more context: 63 | 64 | * https://github.com/cslarsen/jp2a/issues/8 65 | 66 | You can confirm this by running `brew info`: 67 | 68 | ```bash 69 | $ brew info jp2a 70 | jp2a: stable 1.0.7 (bottled) 71 | Convert JPG images to ASCII 72 | https://csl.name/jp2a/ 73 | /usr/local/Cellar/jp2a/1.0.7 (9 files, 67.7KB) * <-- this should be 1.0.6_1 74 | Poured from bottle on 2019-09-06 at 15:59:33 75 | From: https://github.com/Homebrew/homebrew-core/blob/master/Formula/jp2a.rb 76 | ``` 77 | 78 | You can fix this by running the following commands: 79 | 80 | ```bash 81 | brew unlink jp2a 82 | brew install https://raw.githubusercontent.com/Homebrew/homebrew-core/31b5579ccb72ccf24e9d01962e422aece563cff5/Formula/jp2a.rb 83 | ``` 84 | 85 | On Ubuntu, you should be fine. Double-check that `1.0.6-6build1` is installed. 86 | 87 | 88 | ## Installation 89 | 90 | For now, just clone this repository to wherever you store code on your system: 91 | 92 | ```bash 93 | git clone https://github.com/art-institute-of-chicago/aic-bash 94 | 95 | ``` 96 | 97 | If you'd like to run `aic.sh` from anywhere, you can add the repository directory to your `$PATH`: 98 | 99 | ```bash 100 | # Add this to your ~/.bashrc or equivalent, then open a new terminal instance 101 | export PATH=/path/to/aic-bash:$PATH 102 | ``` 103 | 104 | You can also run `aic.sh` when you start a new terminal session: 105 | 106 | ```bash 107 | # Add this to your ~/.bashrc or equivalent, then open a new terminal instance 108 | /path/to/aic-bash/aic.sh --quality medium --ratio 120 109 | ``` 110 | 111 | Adjust `quality` to reduce color artifacts or improve performance. 112 | 113 | The `--ratio 120` is aimed at iTerm users. Although terminal fonts tend to be monospace, not all of them will have the same aspect ratio for each character. We can use `ratio` to stretch or compress the width to compensate for these differences. In this example, `--ratio 120` will stretch the width to 120% of original, which is ideal for iTerm users who use default settings. 114 | 115 | 116 | ## Usage 117 | 118 | ```bash 119 | $ ./aic.sh -h 120 | usage: aic.sh [options] [query] 121 | -c, --cache [num] Cache results of this query for [num] seconds. 122 | [num] defaults to 1 hour (3600 sec) if blank. 123 | Use cached results if available. 124 | -i, --id Retrieve specific artwork via numeric id. 125 | -j, --json Path to JSON file containing a query to run. 126 | -l, --limit How many artworks to retrieve. Defaults to 1. 127 | One random artwork from results will be shown. 128 | -n, --no-fill Disable background color fill. 129 | -q, --quality Affects width of image retrieved from server. 130 | Reduces color artifacts. Valid options: 131 | h, high = 843x (default) 132 | m, medium = 400x 133 | l, low = 200x 134 | -r, --ratio Stretch the width by this percent of original. 135 | Useful to compensate for terminal font aspect. 136 | (iTerm users, try `120` for less stretching.) 137 | -s, --seed For random queries. Defaults to timestamp. 138 | [query] (Optional) Full-text search string. 139 | ``` 140 | 141 | `aic.sh` has four modes of operation: 142 | 143 | 1. Running it without any arguments will return a random public domain oil painting. 144 | 145 | 2. Running it with the `-i` or `--id` option will look up a specific artwork by its identifier: 146 | 147 | ```bash 148 | # Stacks of Wheat (End of Summer) by Claude Monet 149 | ./aic.sh --id 64818 150 | ``` 151 | 152 | 3. Running it with a string argument will perform a full-text search and show the first result: 153 | 154 | ```bash 155 | # The Bedroom by Vincent Van Gogh 156 | ./aic.sh bedroom 157 | 158 | # Be sure to use quotes when searching for phrases! 159 | ./aic.sh "la grande jatte" 160 | 161 | # With --limit, show a random artwork from the top results 162 | ./aic.sh --limit 10 "mountains" 163 | ``` 164 | 165 | 4. Running it with `-j` or `--json` will query our API using a query stored in the specified JSON file: 166 | 167 | ```bash 168 | # Just some example queries we included for reference 169 | ./aic.sh --json "queries/default-random-asian-art.json" 170 | ./aic.sh --json "queries/default-random-landscape.json" 171 | ``` 172 | 173 | Please note that these queries will only return public domain artworks. 174 | 175 | Under the hood, all of its queries are stored as JSON files in the `./queries` directory. 176 | 177 | We treat JSON files as query templates. Before executing a JSON query, we replace the following text: 178 | 179 | * `VAR_FULLTEXT` is replaced by whatever is specified in the `[query]` argument 180 | * `VAR_SEED` is replaced by the value of the `--seed` option or the current Unix timestamp 181 | * `VAR_LIMIT` is replaced by the value of the `--limit` option 182 | * `VAR_ID` is replaced by the value of the `--id` option 183 | 184 | So if the query supports it, you can combine `--json` with full-text search: 185 | 186 | ```bash 187 | # Flower Girl in Holland by George Hitchcock 188 | ./aic.sh --json "queries/default-fulltext-landscape.json" "holland" 189 | ``` 190 | 191 | If you want to write custom queries for use with `--json`, feel free to store them in the `./queries` directory. 192 | 193 | Any file in `./queries` that doesn't begin with `default-*` will be ignored by version control. 194 | 195 | The `--limit ` option provides a way to randomize search, assuming that the query in question uses `VAR_LIMIT`. 196 | 197 | Here, "limit" indicates how many results should be returned on each page from the API. Internally, we show a random result from the first page. By default, limit is set to `1`, so the top result will always be shown. Specifying a greater limit means that we will select a random artwork from the top `` results from the API. For performance, limit is capped at 100. 198 | 199 | Limit is meant to work primarily in conjunction with full-text search. For example: 200 | 201 | ```bash 202 | # Show a random artwork from the top 50 results for "paperweight" 203 | ./aic.sh --limit 50 "paperweight" 204 | ``` 205 | 206 | If you are writing your own queries, and you'd like to select a random artwork from a category, with no regard to [relevance](https://www.elastic.co/guide/en/elasticsearch/guide/current/relevance-intro.html) or [popularity](https://github.com/art-institute-of-chicago/data-aggregator/blob/3b80579b0840fcbbff589b1b26a2bd6aec5bade0/app/Models/Collections/Artwork.php#L616-L629), consider avoiding the use of `VAR_LIMIT`. Instead, use [term](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-term-query.html) queries with [function_score](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-function-score-query.html) and `"boost": false`. See [queries/default-random-landscape.json](queries/default-random-landscape.json) for an example. 207 | 208 | Lastly, `--cache [num]` allows you to cache the API response, so that the script won't have to hit the API each time it runs the same query. This is useful for running full-text search with high limit. For example: 209 | 210 | ```bash 211 | # Show a random artwork from the top 100 results for "paperweight" 212 | # Results will be cached for 1 day (86400 seconds) 213 | ./aic.sh --limit 100 --cache 86400 "paperweight" 214 | ``` 215 | 216 | After running this query once, it will cache the results. If you run it again within the 24-hour window, it'll show a new random paperweight from the top 100 results without needing to re-query the API. 217 | 218 | If you use `--cache` without specifying `[num]`, it'll default to 3600 seconds, i.e. 1 hour. 219 | 220 | 221 | ## Contributing 222 | 223 | We encourage your contributions. Please fork this repository and make your changes in a separate branch. To better understand how we organize our code, please review our [version control guidelines](https://docs.google.com/document/d/1B-27HBUc6LDYHwvxp3ILUcPTo67VFIGwo5Hiq4J9Jjw). 224 | 225 | ```bash 226 | # Clone the repo to your computer 227 | git clone git@github.com:your-github-account/aic-bash.git 228 | 229 | # Enter the folder that was created by the clone 230 | cd aic-bash 231 | 232 | # Start a feature branch 233 | git checkout -b feature/good-short-description 234 | 235 | # ... make some changes, commit your code 236 | 237 | # Push your branch to GitHub 238 | git push origin feature/good-short-description 239 | ``` 240 | 241 | Then on GitHub, [create a Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request) to merge your changes into our `develop` branch. 242 | 243 | This project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its [terms](CODE_OF_CONDUCT.md). 244 | 245 | We welcome bug reports and questions under GitHub's [Issues](issues). For other concerns, you can reach our engineering team at [engineering@artic.edu](mailto:engineering@artic.edu) 246 | 247 | 248 | ## Licensing 249 | 250 | This project is licensed under the [GNU Affero General Public License Version 3](LICENSE). 251 | -------------------------------------------------------------------------------- /aic.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | if ! [ -x "$(command -v jq)" ]; then 4 | echo 'Please install jq: https://stedolan.github.io/jq/' >&2 5 | exit 1 6 | fi 7 | 8 | if ! [ -x "$(command -v jp2a)" ]; then 9 | echo 'Please install jp2a: https://csl.name/jp2a/' >&2 10 | exit 1 11 | fi 12 | 13 | if [ -x "$(command -v md5sum)" ]; then 14 | BIN_MD5='md5sum' 15 | elif [ -x "$(command -v gmd5sum)" ]; then 16 | BIN_MD5='gmd5sum' 17 | else 18 | echo 'Please install md5sum: https://linux.die.net/man/1/md5sum' >&2 19 | exit 1 20 | fi 21 | 22 | # https://stackoverflow.com/questions/59895/getting-the-source-directory-of-a-bash-script-from-within 23 | DIR_SCRIPT="$(dirname "${BASH_SOURCE[0]}")" 24 | DIR_QUERIES="$DIR_SCRIPT/queries" 25 | DIR_CACHES="$DIR_SCRIPT/caches" 26 | 27 | FILE_IMAGE="/tmp/aic-bash.jpg" 28 | FILE_RESPONSE="/tmp/aic-bash.json" 29 | 30 | API_URL='https://api.artic.edu/api/v1/search' 31 | 32 | OPT_FILL='--fill' # fill background by default 33 | OPT_SIZE='843' # default for artwork detail pages 34 | 35 | # we define default OPT_LIMIT later, so that we can validate options 36 | MAX_LIMIT='100' # hard cap on --limit for serverside performance 37 | 38 | # Clear stale cached results 39 | for FILE_CACHE in "$DIR_CACHES"/*.txt; do 40 | [ -e "$FILE_CACHE" ] || continue 41 | CACHE_MAXAGE="$(jq -r '.maxage' "$FILE_CACHE")" 42 | CACHE_AGE="$(( $(date '+%s') - $(date -r "$FILE_CACHE" '+%s') ))" 43 | if [ $CACHE_AGE -gt $CACHE_MAXAGE ]; then 44 | rm "$FILE_CACHE" 45 | fi 46 | done 47 | 48 | # Check what options were passed 49 | while test $# != 0; do 50 | case "$1" in 51 | -c|--cache) 52 | if [ ! -z "$2" ] && [[ $2 =~ ^[0-9]+$ ]] ; then 53 | OPT_CACHE=$2; 54 | shift 2 55 | else 56 | OPT_CACHE=3600; 57 | shift 1 58 | fi 59 | ;; 60 | -i|--id) 61 | if [ -z "$2" ] || ! [[ $2 =~ ^[0-9]+$ ]] ; then 62 | echo "Please provide a numeric id for the --id option." >&2 63 | exit 1 64 | fi 65 | OPT_ID=$2; 66 | shift 2 67 | ;; 68 | -j|--json) 69 | if [ -z "$2" ] || [[ $2 =~ ^- ]] ; then 70 | echo "Please provide a path for the --json option." >&2 71 | exit 1 72 | fi 73 | OPT_JSON=$2; 74 | shift 2 75 | ;; 76 | -l|--limit) 77 | if [ -z "$2" ] || ! [[ $2 =~ ^[0-9]+$ ]] ; then 78 | echo "Please provide a number for the --limit option." >&2 79 | exit 1 80 | fi 81 | if [ "$2" -gt $MAX_LIMIT ] ; then 82 | echo "Please keep --limit under $MAX_LIMIT." >&2 83 | exit 1 84 | fi 85 | if [ "$2" -lt 1 ] ; then 86 | echo "Please set --limit to at least 1." >&2 87 | exit 1 88 | fi 89 | OPT_LIMIT=$2; 90 | shift 2 91 | ;; 92 | -n|--no-fill) 93 | OPT_FILL=''; 94 | shift 95 | ;; 96 | -q|--quality) 97 | if [ "$2" = 'h' ] || [ "$2" = 'high' ] ; then 98 | OPT_SIZE='843' 99 | elif [ "$2" = 'm' ] || [ "$2" = 'medium' ] ; then 100 | OPT_SIZE='400' 101 | elif [ "$2" = 'l' ] || [ "$2" = 'low' ] ; then 102 | OPT_SIZE='200' 103 | else 104 | echo "Please provide a valid value for the --quality option:" >&2 105 | echo " h, m, l, high, medium, low" >&2 106 | exit 1 107 | fi 108 | shift 2 109 | ;; 110 | -r|--ratio) 111 | if [ -z "$2" ] || ! [[ $2 =~ ^[0-9]+$ ]] ; then 112 | echo "Please provide a percentage for the --ratio option." >&2 113 | exit 1 114 | fi 115 | if ! [ "$2" -gt 0 ] ; then 116 | echo "Please keep --ratio above 0." >&2 117 | exit 1 118 | fi 119 | if ! [ -x "$(command -v convert)" ]; then 120 | echo 'The --ratio option requires ImageMagick: https://imagemagick.org' >&2 121 | exit 1 122 | fi 123 | OPT_RATIO=$2; 124 | shift 2 125 | ;; 126 | -s|--seed) 127 | if [ -z "$2" ] || [[ $2 =~ ^- ]] ; then 128 | echo "Please provide a value for the --seed option." >&2 129 | exit 1 130 | fi 131 | OPT_SEED=$2; 132 | shift 2 133 | ;; 134 | -*) 135 | echo "usage: $(basename $0) [options] [query]" 136 | echo " -c, --cache [num] Cache results of this query for [num] seconds." 137 | echo " [num] defaults to 1 hour (3600 sec) if blank." 138 | echo " Use cached results if available." 139 | echo " -i, --id Retrieve specific artwork via numeric id." 140 | echo " -j, --json Path to JSON file containing a query to run." 141 | echo " -l, --limit How many artworks to retrieve. Defaults to 1." 142 | echo " One random artwork from results will be shown." 143 | echo " -n, --no-fill Disable background color fill." 144 | echo " -q, --quality Affects width of image retrieved from server." 145 | echo " Reduces color artifacts. Valid options:" 146 | echo " h, high = 843x (default)" 147 | echo " m, medium = 400x" 148 | echo " l, low = 200x" 149 | echo " -r, --ratio Stretch the width by this percent of original." 150 | echo " Useful to compensate for terminal font aspect." 151 | echo " (iTerm users, try \`120\` for less stretching.)" 152 | echo " -s, --seed For random queries. Defaults to timestamp." 153 | echo " [query] (Optional) Full-text search string." 154 | exit 1 155 | ;; 156 | *) 157 | # This allows positional arguments (i.e. full-text search) to work 158 | break 159 | ;; 160 | esac 161 | done 162 | 163 | # Check if the positional argument for full-text was passed 164 | if [ ! -z "$1" ]; then 165 | OPT_FULLTEXT=$1 166 | shift 167 | fi 168 | 169 | if [ ! -z "$OPT_ID" ]; then 170 | OPT_JSON="$DIR_QUERIES/default-id.json" 171 | elif [ -z "$OPT_JSON" ]; then 172 | if [ -z "$OPT_FULLTEXT" ]; then 173 | OPT_JSON="$DIR_QUERIES/default-random-oil-painting.json" 174 | else 175 | OPT_JSON="$DIR_QUERIES/default-fulltext.json" 176 | fi 177 | fi 178 | 179 | # Normalize JSON path for validation output 180 | OPT_JSON="$(realpath "$OPT_JSON")" 181 | 182 | # Ensure the JSON file exists 183 | if [ ! -f "$OPT_JSON" ]; then 184 | echo "JSON file not found: $OPT_JSON" >&2 185 | exit 1 186 | fi 187 | 188 | # Get our request body from the JSON file 189 | API_QUERY="$(cat "$OPT_JSON")" 190 | 191 | # Ensure the query is valid JSON 192 | if ! jq -e . 2>&1 >/dev/null <<< "${API_QUERY}"; then 193 | echo "File is not valid JSON: $OPT_JSON" >&2 194 | exit 1 195 | fi 196 | 197 | # Function to validate that JSON file has placeholders to support options 198 | function checkjson() { 199 | if [ ! -z "$1" ] && [[ $API_QUERY != *"$2"* ]]; then 200 | echo "$3 was passed, but JSON file is missing '$2' placeholder:" >&2 201 | echo " $OPT_JSON" >&2 202 | exit 1 203 | fi 204 | } 205 | 206 | # Replace "VAR_SEED" in query with the --seed parameter 207 | checkjson "$OPT_SEED" 'VAR_SEED' 'Seed' 208 | if [ -z "$OPT_SEED" ]; then 209 | OPT_SEED="$(date +"%T")" # use current timestamp by default 210 | fi 211 | API_QUERY="$(echo "$API_QUERY" | sed "s/VAR_SEED/$OPT_SEED/g")" 212 | 213 | # Replace "VAR_FULLTEXT" in query with the supplied text 214 | checkjson "$OPT_FULLTEXT" 'VAR_FULLTEXT' 'Full-text query' 215 | API_QUERY="$(echo "$API_QUERY" | sed "s/VAR_FULLTEXT/$OPT_FULLTEXT/g")" 216 | 217 | # Replace "VAR_ID" in query with the --id parameter 218 | checkjson "$OPT_ID" 'VAR_ID' 'Identifier' 219 | API_QUERY="$(echo "$API_QUERY" | sed "s/VAR_ID/$OPT_ID/g")" 220 | 221 | # Replace "VAR_LIMIT" in query with the --limit parameter 222 | checkjson "$OPT_LIMIT" 'VAR_LIMIT' 'Limit' 223 | if [ -z "$OPT_LIMIT" ]; then 224 | OPT_LIMIT='1' # retrieve one result by default 225 | fi 226 | API_QUERY="$(echo "$API_QUERY" | sed "s/VAR_LIMIT/$OPT_LIMIT/g")" 227 | 228 | # Generate cache filename by hashing the query 229 | FILE_CACHE="$DIR_CACHES/$(echo -n "$API_QUERY" | $BIN_MD5 | awk '{print $1}').txt" 230 | 231 | # Determine if the cache file needs to be deleted 232 | if [ -f "$FILE_CACHE" ]; then 233 | if [ -z "$OPT_CACHE" ]; then 234 | # Delete cache file if the cache option was omitted 235 | rm "$FILE_CACHE" 236 | else 237 | # Delete cache file if it is older than the passed cache time 238 | CACHE_AGE="$(( $(date '+%s') - $(date -r "$FILE_CACHE" '+%s') ))" 239 | if [ $CACHE_AGE -gt $OPT_CACHE ]; then 240 | rm "$FILE_CACHE" 241 | fi 242 | fi 243 | fi 244 | 245 | # Helper for saving the cache file with (optional) specific modified time 246 | function savecache() { 247 | jq -n --arg maxage "$OPT_CACHE" --argjson response "$1" '{"maxage":$maxage,"response":$response}' > "$FILE_CACHE" 248 | if [ ! -z "$2" ]; then 249 | touch -t "$2" "$FILE_CACHE" 250 | fi 251 | } 252 | 253 | # If the cache file still exists, use it 254 | if [ -f "$FILE_CACHE" ]; then 255 | 256 | API_CACHE="$(cat "$FILE_CACHE")" 257 | 258 | API_RESPONSE="$(echo "$API_CACHE" | jq -r '.response')" 259 | API_COUNT="$(echo "$API_RESPONSE" | jq -r '.data | length')" 260 | 261 | # Update maxage in cache file to match cache option, but preserve its modified time 262 | CACHE_MAXAGE="$(echo "$API_CACHE" | jq -r '.maxage')" 263 | if [ $CACHE_MAXAGE -ne $OPT_CACHE ]; then 264 | savecache "$API_RESPONSE" "$(date -r "$FILE_CACHE" +'%Y%m%d%H%M.%S')" 265 | fi 266 | 267 | else 268 | 269 | # Actually query the API! Ensure that the request succeeded 270 | STATUS="$(curl -s -H "Content-Type: application/json; charset=UTF-8" -d "$API_QUERY" -w %{http_code} -m 5 "$API_URL" -o "$FILE_RESPONSE")" 271 | 272 | if [ ! "$STATUS" = "200" ]; then 273 | echo "Sorry, we are having trouble connecting to our API. Try again later!" >&2 274 | exit 1 275 | fi 276 | 277 | API_RESPONSE="$(cat "$FILE_RESPONSE")" 278 | API_COUNT="$(echo "$API_RESPONSE" | jq -r '.data | length')" 279 | 280 | # Exit early if there's no results 281 | if [ "$API_COUNT" = '0' ]; then 282 | echo "Sorry, we couldn't find any results matching your criteria." >&2 283 | exit 1 284 | fi 285 | 286 | # If the cache option was passed, save response to the cache file 287 | if [ ! -z "$OPT_CACHE" ]; then 288 | savecache "$API_RESPONSE" 289 | fi 290 | 291 | fi 292 | 293 | # Select random artwork from results 294 | API_INDEX=$(( RANDOM % $API_COUNT )) 295 | 296 | # Parse artwork fields using jq 297 | # https://stedolan.github.io/jq/ 298 | ARTWORK_ID="$(echo "$API_RESPONSE" | jq -r ".data[$API_INDEX].id")" 299 | ARTWORK_TITLE="$(echo "$API_RESPONSE" | jq -r ".data[$API_INDEX].title")" 300 | ARTWORK_DATE="$(echo "$API_RESPONSE" | jq -r ".data[$API_INDEX].date_display")" 301 | ARTWORK_ARTIST="$(echo "$API_RESPONSE" | jq -r ".data[$API_INDEX].artist_display")" 302 | IMAGE_ID="$(echo "$API_RESPONSE" | jq -r ".data[$API_INDEX].image_id")" 303 | 304 | # We'll need to leave space for outputting artwork info 305 | # To do so, we need to estimate how many lines the info will take to render 306 | function linecount() { 307 | 308 | COLS="$(tput cols)" 309 | L=0 310 | 311 | # Account for line wrap in narrow consoles 312 | while IFS=$'\n' read -ra ROWS; do 313 | for ROW in "${ROWS[@]}"; do 314 | 315 | # https://stackoverflow.com/questions/2395284/round-a-divided-number-in-bash 316 | L="$(( ${L}+(${#ROW}+${COLS}-1)/${COLS} ))" 317 | 318 | done 319 | done <<< "$1" 320 | 321 | echo "$L" 322 | } 323 | 324 | # Not the same algorithm as on the website, but accurate enough for simpler titles 325 | # https://stackoverflow.com/questions/47050589/create-url-friendly-slug-with-pure-bash 326 | # https://unix.stackexchange.com/questions/13711/differences-between-sed-on-mac-osx-and-other-standard-sed 327 | slugify () { 328 | echo "$1" | iconv -c -t ascii//TRANSLIT | sed -E s/[~\^]+//g | sed -E s/[^a-zA-Z0-9]+/-/g | sed -E s/^-+\|-+$//g | tr A-Z a-z 329 | } 330 | 331 | # Build output lines so we can measure them, mirroring website conventions 332 | OUTPUT_TITLE_DATE="$ARTWORK_TITLE, $ARTWORK_DATE" 333 | OUTPUT_ARTIST="$ARTWORK_ARTIST" 334 | OUTPUT_URL="https://www.artic.edu/artworks/$ARTWORK_ID/$(slugify "$ARTWORK_TITLE")" 335 | OUTPUT_TOMBSTONE="$OUTPUT_TITLE_DATE"$'\n'"$OUTPUT_ARTIST"$'\n'"$OUTPUT_URL" 336 | 337 | # Now that the tombstone is ready, abort early if there's no image 338 | if [ "$IMAGE_ID" = "null" ]; then 339 | echo -e "\033[0;31mUnfortunately, this artwork has no preferred image.\033[0m" >&2 340 | echo "$OUTPUT_TOMBSTONE" 341 | exit 1 342 | fi 343 | 344 | # Download image from AIC's IIIF server 345 | STATUS="$(curl -s "https://www.artic.edu/iiif/2/$IMAGE_ID/full/$OPT_SIZE,/0/default.jpg" -w %{http_code} -m 5 --output "$FILE_IMAGE")" 346 | 347 | if [ ! "$STATUS" = "200" ]; then 348 | echo "Sorry, we are having trouble downloading the image. Try again later!" >&2 349 | exit 1 350 | fi 351 | 352 | # If the ratio option was passed, stretch the image width 353 | # Compensates for differences in monospace font aspect ratios 354 | if [ ! -z "$OPT_RATIO" ]; then 355 | convert "$FILE_IMAGE" -resize "$OPT_RATIO%x100%" "$FILE_IMAGE" 356 | fi 357 | 358 | # We cheat here and modify the built-in variable for terminal height 359 | # This causes jp2a to underestimate when doing --term-fit 360 | OLD_LINES="$(tput lines)" 361 | export LINES="$(( ${OLD_LINES}-$(linecount "$OUTPUT_TOMBSTONE") ))" 362 | 363 | # https://github.com/cslarsen/jp2a 364 | INPUT="$(jp2a --term-fit --color --html $OPT_FILL "$FILE_IMAGE")" 365 | 366 | # Restore the hacked term variable 367 | export LINES="$OLD_LINES" 368 | 369 | # Remove HTML tags from beginning and end 370 | INPUT="${INPUT:449}" 371 | INPUT="${INPUT::-29}" 372 | INPUT="${INPUT::-5}" #
373 | 374 | # Replace   with a placeholder character that's not in the character map 375 | # https://github.com/cslarsen/jp2a/blob/61d205f6959d88e0cc8d8879fe7d66eb0932ecca/src/options.c#L69 376 | INPUT="${INPUT// /&}" 377 | 378 | # Replace
with actual newlines 379 | INPUT="${INPUT///$'\n'}" 380 | 381 | # Start building our output for rendering 382 | OUTPUT='' 383 | 384 | # For performance, we'll do just one check here, rather than inside the loops 385 | # This causes code duplication, so be sure to double check when you make changes 386 | if [ ! "$OPT_FILL" = '--fill' ]; then 387 | 388 | # Split HTML by
into rows 389 | while IFS=$'\n' read -ra ROWS; do 390 | for ROW in "${ROWS[@]}"; do 391 | 392 | # Transform spans into space-separated quadruples of R G B [Char], using pipes as span-separators 393 | ROW="$(echo "$ROW" | sed -E "s/(.)<\/span>/\1 \2 \3 \4|/g")" 394 | 395 | # Discard the last pipe 396 | ROW="${ROW::-1}" 397 | 398 | # Split row into columns using pipes 399 | while IFS='|' read -ra COLS; do 400 | for COL in "${COLS[@]}"; do 401 | 402 | # Split column into values using spaces 403 | COL=($COL) 404 | 405 | # Convert RGB hex to decimal 406 | R="$(( 16#${COL[0]} ))" 407 | G="$(( 16#${COL[1]} ))" 408 | B="$(( 16#${COL[2]} ))" 409 | 410 | # Get character and fix spaces 411 | C="${COL[3]//&/ }" 412 | 413 | # https://gist.github.com/XVilka/8346728 414 | OUTPUT+="\033[38;2;${R};${G};${B}m${C}" 415 | 416 | done 417 | done <<< "$ROW" 418 | 419 | # Reset color and insert newline 420 | OUTPUT+='\033[0m\n' 421 | 422 | done 423 | done <<< "$INPUT" 424 | 425 | else 426 | 427 | # Split HTML by
into rows 428 | while IFS=$'\n' read -ra ROWS; do 429 | for ROW in "${ROWS[@]}"; do 430 | 431 | # Transform spans into space-separated quadruples of R G B [Char], using pipes as span-separators 432 | ROW="$(echo "$ROW" | sed -E "s/(.)<\/span>/\1 \2 \3 \4 \5 \6 \7|/g")" 433 | 434 | # Discard the last pipe 435 | ROW="${ROW::-1}" 436 | 437 | # Split row into columns using pipes 438 | while IFS='|' read -ra COLS; do 439 | for COL in "${COLS[@]}"; do 440 | 441 | # Split column into values using spaces 442 | COL=($COL) 443 | 444 | # Handle the background color 445 | R="$(( 16#${COL[3]} ))" 446 | G="$(( 16#${COL[4]} ))" 447 | B="$(( 16#${COL[5]} ))" 448 | 449 | # https://gist.github.com/XVilka/8346728 450 | OUTPUT+="\033[48;2;${R};${G};${B}m" 451 | 452 | # Handle the foreground color 453 | R="$(( 16#${COL[0]} ))" 454 | G="$(( 16#${COL[1]} ))" 455 | B="$(( 16#${COL[2]} ))" 456 | 457 | # Get character and fix spaces 458 | C="${COL[6]//&/ }" 459 | 460 | # https://gist.github.com/XVilka/8346728 461 | OUTPUT+="\033[38;2;${R};${G};${B}m${C}" 462 | 463 | done 464 | done <<< "$ROW" 465 | 466 | # Reset color and insert newline 467 | OUTPUT+='\033[0m\n' 468 | 469 | done 470 | done <<< "$INPUT" 471 | 472 | fi 473 | 474 | printf "$OUTPUT" 475 | 476 | # Output artwork info 477 | echo "$OUTPUT_TOMBSTONE" 478 | 479 | # Clean up temporary files 480 | if [ -f "$FILE_IMAGE" ]; then 481 | rm "$FILE_IMAGE" 482 | fi 483 | 484 | if [ -f "$FILE_RESPONSE" ]; then 485 | rm "$FILE_RESPONSE" 486 | fi 487 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 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 Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------