commit 184f135779bcdf115f7d70b4001c42c30c4edd81 Author: Elizabeth Cray Date: Sun Aug 9 13:17:23 2026 -0400 Initial mock-up cache tool diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1d196fd --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +package-lock.json +osm_data.json +osm_data.geojson +.env +node_modules diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..b15d587 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# The Birdcage + +This is a simple tool to cache OSM queries into PostgreSQL. + +## Setup + +You need these packages installed: +- Node.js +- curl +- ogr2ogr (part of the GDAL suite) + +## Usage + +1. Configure your `.env` file with the appropriate OSM query, PostgreSQL connection details, and layer name. The OSM query must be url encoded! +2. Run the cache script diff --git a/cache.sh b/cache.sh new file mode 100755 index 0000000..f474e2d --- /dev/null +++ b/cache.sh @@ -0,0 +1,48 @@ +#!/bin/bash +# Copyright (c) 2026 Elizabeth Cray +SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd ) +source $SCRIPT_DIR/.env + +if ! command -v ogr2ogr >/dev/null 2>&1; then + echo "ogr2ogr is not installed. Please install it and try again." + exit 1 +fi + +if ! command -v curl >/dev/null 2>&1; then + echo "curl is not installed. Please install it and try again." + exit 1 +fi + +if ! command -v node >/dev/null 2>&1; then + echo "Node.js is not installed. Please install it and try again." + exit 1 +fi + +if [ -f "$SCRIPT_DIR/osm_data.json" ]; then + rm "$SCRIPT_DIR/osm_data.json" +fi + +curl --connect-timeout 950 --location --globoff "$OSM_QUERY" --output "$SCRIPT_DIR/osm_data.json" + +if [ -f "$SCRIPT_DIR/osm_data.json" ]; then + echo "OSM data downloaded to $SCRIPT_DIR/osm_data.json" + RESULTLINE=`head -n1 $SCRIPT_DIR/osm_data.json` + if [ -z "$RESULTLINE" ]; then + echo "OSM data file is empty." + exit 1 + fi + if [[ $RESULTLINE == "" ]]; then + echo "OSM data file contains an error." + exit 1 + fi + if [ -f "$SCRIPT_DIR/osm_data.geojson" ]; then + rm "$SCRIPT_DIR/osm_data.geojson" + fi + node "$SCRIPT_DIR/convert_osm.js" + echo "OSM data converted to GeoJSON at $SCRIPT_DIR/osm_data.geojson" + ogr2ogr -f "PostgreSQL" PG:"$PGSQL_URL" "$SCRIPT_DIR/osm_data.geojson" -nln "$LAYER_NAME" + echo "OSM data imported into PostgreSQL layer $LAYER_NAME" +else + echo "Failed to download OSM data." + exit 1 +fi diff --git a/convert_osm.js b/convert_osm.js new file mode 100644 index 0000000..15293c1 --- /dev/null +++ b/convert_osm.js @@ -0,0 +1,26 @@ +// Copyright (c) 2026 Elizabeth Cray +const fs = require('fs'); +require('dotenv').config(); + +const osmData = JSON.parse(fs.readFileSync('osm_data.json', 'utf8')); + +const geoJsonTemplate = { + type: "FeatureCollection", + features: [], +}; + +if (osmData && osmData.elements && osmData.elements.length > 0) { + osmData.elements.forEach(element => { + if (element.type === 'node' && element.lat && element.lon) { + geoJsonTemplate.features.push({ + type: "Feature", + geometry: { + type: "Point", + coordinates: [element.lon, element.lat], + }, + properties: element.tags || {}, + }); + } + }); + fs.writeFileSync('osm_data.geojson', JSON.stringify(geoJsonTemplate, null, 2)); +} diff --git a/example.env b/example.env new file mode 100644 index 0000000..a68c922 --- /dev/null +++ b/example.env @@ -0,0 +1,3 @@ +OSM_QUERY="https://overpass-api.de/api/interpreter?data=[timeout%3A900][out%3Ajson]%3Bnode[%22man_made%22%3D%22surveillance%22][%22surveillance%3Atype%22%3D%22ALPR%22]%3Bout%20body%3B" +PGSQL_URL="host=example.com dbname=public user=postgres password=password" +LAYER_NAME="Flock_Cameras" diff --git a/package.json b/package.json new file mode 100644 index 0000000..57f5f01 --- /dev/null +++ b/package.json @@ -0,0 +1,19 @@ +{ + "name": "birdcage", + "version": "1.0.0", + "description": "Convert OSM queries into cached data on PostGIS", + "repository": { + "type": "git", + "url": "Gitea:liz/birdcage.git" + }, + "license": "Apache-2.0", + "author": "Elizabeth Cray", + "type": "commonjs", + "main": "convert_osm.js", + "scripts": { + "test": "./cache.sh" + }, + "dependencies": { + "dotenv": "^17.4.2" + } +}