+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
18 """Logic for FMTM project routes."""
+
+
+
+
+
+
+
+
26 from asyncio
import gather
+
27 from concurrent.futures
import ThreadPoolExecutor, wait
+
28 from io
import BytesIO
+
29 from json
import dumps, loads
+
30 from typing
import List, Optional
+
31 from zipfile
import ZipFile
+
+
+
+
+
+
+
+
+
40 import shapely.wkb
as wkblib
+
+
42 from asgiref.sync
import async_to_sync
+
43 from fastapi
import File, HTTPException, UploadFile
+
44 from geoalchemy2.shape
import from_shape, to_shape
+
45 from geojson
import dump
+
46 from loguru
import logger
as log
+
47 from osm_fieldwork.basemapper
import create_basemap_file
+
48 from osm_fieldwork.data_models
import data_models_path
+
49 from osm_fieldwork.filter_data
import FilterData
+
50 from osm_fieldwork.json2osm
import json2osm
+
51 from osm_fieldwork.OdkCentral
import OdkAppUser
+
52 from osm_fieldwork.xlsforms
import xlsforms_path
+
53 from osm_rawdata.postgres
import PostgresClient
+
54 from shapely
import wkt
+
55 from shapely.geometry
import (
+
+
+
+
+
+
+
+
63 from shapely.ops
import transform
+
64 from sqlalchemy
import and_, column, func, inspect, select, table, text
+
65 from sqlalchemy.dialects.postgresql
import insert
+
66 from sqlalchemy.orm
import Session
+
67 from sqlalchemy.sql
import text
+
+
+
+
71 from app.db import db_models
+
+
+
+
+
+
+
78 QR_CODES_DIR =
"QR_codes/"
+
79 TASK_GEOJSON_DIR =
"geojson/"
+
80 TILESDIR =
"/opt/tiles"
+
+
+
83 async
def get_projects(
+
+
+
+
+
88 hashtags: List[str] =
None,
+
+
+
+
+
93 filters.append(db_models.DbProject.author_id == user_id)
+
+
+
96 filters.append(db_models.DbProject.hashtags.op(
"&&")(hashtags))
+
+
+
99 filters.append(db_models.DbProject.project_name_prefix.ilike(f
"%{search}%"))
+
+
+
+
103 db.query(db_models.DbProject)
+
104 .filter(and_(*filters))
+
105 .order_by(db_models.DbProject.id.desc())
+
+
+
+
+
110 project_count = db.query(db_models.DbProject).filter(and_(*filters)).count()
+
+
+
+
114 db.query(db_models.DbProject)
+
115 .order_by(db_models.DbProject.id.desc())
+
+
+
+
+
120 project_count = db.query(db_models.DbProject).count()
+
121 return project_count, await convert_to_app_projects(db_projects)
+
+
+
124 async
def get_project_summaries(
+
+
+
+
+
129 hashtags: str =
None,
+
+
+
132 project_count, db_projects = await get_projects(
+
133 db, user_id, skip, limit, hashtags, search
+
+
135 return project_count, await convert_to_project_summaries(db_projects)
+
+
+
138 async
def get_project(db: Session, project_id: int):
+
+
140 db.query(db_models.DbProject)
+
141 .filter(db_models.DbProject.id == project_id)
+
+
+
+
+
+
147 async
def get_project_by_id(db: Session, project_id: int):
+
+
149 db.query(db_models.DbProject)
+
150 .filter(db_models.DbProject.id == project_id)
+
151 .order_by(db_models.DbProject.id)
+
+
+
154 return await convert_to_app_project(db_project)
+
+
+
157 async
def get_project_info_by_id(db: Session, project_id: int):
+
+
159 db.query(db_models.DbProjectInfo)
+
160 .filter(db_models.DbProjectInfo.project_id == project_id)
+
161 .order_by(db_models.DbProjectInfo.project_id)
+
+
+
164 return await convert_to_app_project_info(db_project_info)
+
+
+
167 async
def delete_project_by_id(db: Session, project_id: int):
+
+
+
170 db.query(db_models.DbProject)
+
171 .filter(db_models.DbProject.id == project_id)
+
172 .order_by(db_models.DbProject.id)
+
+
+
+
176 db.delete(db_project)
+
+
178 except Exception
as e:
+
+
180 raise HTTPException(e)
from e
+
181 return f
"Project {project_id} deleted"
+
+
+
184 async
def partial_update_project_info(
+
185 db: Session, project_metadata: project_schemas.ProjectUpdate, project_id
+
+
+
188 db_project = await get_project_by_id(db, project_id)
+
+
+
+
+
193 status_code=428, detail=f
"Project with id {project_id} does not exist"
+
+
+
+
197 db_project_info = await get_project_info_by_id(db, project_id)
+
+
+
200 if project_metadata.name:
+
201 db_project.project_name_prefix = project_metadata.name
+
202 db_project_info.name = project_metadata.name
+
203 if project_metadata.description:
+
204 db_project_info.description = project_metadata.description
+
205 if project_metadata.short_description:
+
206 db_project_info.short_description = project_metadata.short_description
+
+
+
209 db.refresh(db_project)
+
+
211 return await convert_to_app_project(db_project)
+
+
+
214 async
def update_project_info(
+
215 db: Session, project_metadata: project_schemas.ProjectUpload, project_id
+
+
217 user = project_metadata.author
+
218 project_info = project_metadata.project_info
+
+
+
+
222 raise HTTPException(
"No user passed in")
+
+
224 raise HTTPException(
"No project info passed in")
+
+
+
227 db_user = await user_crud.get_user(db, user.id)
+
+
+
230 status_code=400, detail=f
"User {user.username} does not exist"
+
+
+
+
234 db_project = await get_project_by_id(db, project_id)
+
+
+
237 status_code=428, detail=f
"Project with id {project_id} does not exist"
+
+
+
+
241 project_info = project_metadata.project_info
+
+
+
244 db_project.author = db_user
+
245 db_project.project_name_prefix = project_info.name
+
+
+
248 db_project_info = await get_project_info_by_id(db, project_id)
+
+
+
251 db_project_info.name = project_info.name
+
252 db_project_info.short_description = project_info.short_description
+
253 db_project_info.description = project_info.description
+
+
+
256 db.refresh(db_project)
+
+
258 return await convert_to_app_project(db_project)
+
+
+
261 async
def create_project_with_project_info(
+
262 db: Session, project_metadata: project_schemas.ProjectUpload, odk_project_id: int
+
+
264 project_user = project_metadata.author
+
265 project_info = project_metadata.project_info
+
266 xform_title = project_metadata.xform_title
+
267 odk_credentials = project_metadata.odk_central
+
268 hashtags = project_metadata.hashtags
+
269 organisation_id = project_metadata.organisation_id
+
270 task_split_type = project_metadata.task_split_type
+
271 task_split_dimension = project_metadata.task_split_dimension
+
272 task_num_buildings = project_metadata.task_num_buildings
+
+
+
+
276 raise HTTPException(
"User details are missing")
+
+
278 raise HTTPException(
"Project info is missing")
+
279 if not odk_project_id:
+
280 raise HTTPException(
"ODK Central project id is missing")
+
+
+
283 "Creating project in FMTM database with vars: "
+
284 f
"project_user: {project_user} | "
+
285 f
"project_info: {project_info} | "
+
286 f
"xform_title: {xform_title} | "
+
287 f
"hashtags: {hashtags}| "
+
288 f
"organisation_id: {organisation_id}"
+
+
+
+
+
293 url = odk_credentials.odk_central_url
+
294 user = odk_credentials.odk_central_user
+
295 pw = odk_credentials.odk_central_password
+
+
+
298 log.debug(
"ODKCentral connection variables not set in function")
+
299 log.debug(
"Attempting extraction from environment variables")
+
300 url = settings.ODK_CENTRAL_URL
+
301 user = settings.ODK_CENTRAL_USER
+
302 pw = settings.ODK_CENTRAL_PASSWD
+
+
+
+
+
307 db_user = await user_crud.get_user(db, project_user.id)
+
+
+
310 status_code=400, detail=f
"User {project_user.username} does not exist"
+
+
+
+
+
+
316 lambda hashtag: hashtag
if hashtag.startswith(
"#")
else f
"#{hashtag}",
+
+
+
+
+
+
+
+
324 db_project = db_models.DbProject(
+
+
326 odkid=odk_project_id,
+
327 project_name_prefix=project_info.name,
+
328 xform_title=xform_title,
+
+
330 odk_central_user=user,
+
331 odk_central_password=pw,
+
+
333 organisation_id=organisation_id,
+
334 task_split_type=task_split_type,
+
335 task_split_dimension=task_split_dimension,
+
336 task_num_buildings=task_num_buildings,
+
+
+
+
+
+
+
343 db_project_info = db_models.DbProjectInfo(
+
+
345 name=project_info.name,
+
346 short_description=project_info.short_description,
+
347 description=project_info.description,
+
+
349 db.add(db_project_info)
+
+
+
352 db.refresh(db_project)
+
+
354 return await convert_to_app_project(db_project)
+
+
+
357 async
def upload_xlsform(
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
372 ins = insert(forms).values(title=name, xls=xlsform, category=category)
+
373 sql = ins.on_conflict_do_update(
+
374 constraint=
"xlsforms_title_key",
+
375 set_=dict(title=name, xls=xlsform, category=category),
+
+
+
+
+
380 except Exception
as e:
+
+
382 raise HTTPException(status=400, detail={
"message": str(e)})
from e
+
+
+
385 async
def update_multi_polygon_project_boundary(
+
+
+
+
+
390 """This function receives the project_id and boundary as a parameter
+
391 and creates a task for each polygon in the database.
+
392 This function also creates a project outline from the multiple polygons received.
+
+
+
395 if isinstance(boundary, str):
+
396 boundary = json.loads(boundary)
+
+
+
399 db_project = await get_project_by_id(db, project_id)
+
+
401 log.error(f
"Project {project_id} doesn't exist!")
+
+
+
+
405 if boundary[
"type"] ==
"Feature":
+
406 polygons = [boundary]
+
+
408 polygons = boundary[
"features"]
+
409 log.debug(f
"Processing {len(polygons)} task geometries")
+
410 for polygon
in polygons:
+
+
412 if polygon[
"geometry"][
"type"] ==
"MultiPolygon":
+
413 log.debug(
"Converting MultiPolygon to Polygon")
+
414 polygon[
"geometry"][
"type"] =
"Polygon"
+
415 polygon[
"geometry"][
"coordinates"] = polygon[
"geometry"][
"coordinates"][
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
430 db_task = db_models.DbTask(
+
431 project_id=project_id,
+
432 outline=wkblib.dumps(shape(polygon[
"geometry"]), hex=
True),
+
433 project_task_index=1,
+
+
+
+
+
+
439 db_task.project_task_name = str(db_task.id)
+
+
441 "Created database task | "
+
442 f
"Project ID {project_id} | "
+
443 f
"Task ID {db_task.project_task_name}"
+
+
+
+
+
+
449 f
"""SELECT ST_AsText(ST_ConvexHull(ST_Collect(outline)))
+
+
451 WHERE project_id={project_id};"""
+
+
+
454 log.debug(
"Generating project outline from tasks")
+
455 result = db.execute(query)
+
456 data = result.fetchone()
+
+
458 await update_project_location_info(db_project, data[0])
+
+
+
461 db.refresh(db_project)
+
462 log.debug(
"COMPLETE: creating project boundary, based on task boundaries")
+
+
+
465 except Exception
as e:
+
+
467 raise HTTPException(e)
from e
+
+
+
470 async
def preview_tasks(boundary: str, dimension: int):
+
471 """Preview tasks by returning a list of task objects."""
+
472 """Use a lambda function to remove the "z" dimension from each coordinate in the feature's geometry """
+
+
474 def remove_z_dimension(coord):
+
475 return coord.pop()
if len(coord) == 3
else None
+
+
477 """ Check if the boundary is a Feature or a FeatureCollection """
+
478 if boundary[
"type"] ==
"Feature":
+
479 features = [boundary]
+
480 elif boundary[
"type"] ==
"FeatureCollection":
+
481 features = boundary[
"features"]
+
482 elif boundary[
"type"] ==
"Polygon":
+
+
+
+
+
487 "geometry": boundary,
+
+
+
+
+
492 status_code=400, detail=f
"Invalid GeoJSON type: {boundary['type']}"
+
+
+
495 """ Apply the lambda function to each coordinate in its geometry ro remove the z-dimension - if it exists"""
+
+
497 for feature
in features:
+
498 list(map(remove_z_dimension, feature[
"geometry"][
"coordinates"][0]))
+
499 if feature[
"geometry"][
"type"] ==
"MultiPolygon":
+
500 multi_polygons.append(Polygon(feature[
"geometry"][
"coordinates"][0][0]))
+
+
502 """Update the boundary polyon on the database."""
+
+
504 boundary = multi_polygons[0]
+
505 for geom
in multi_polygons[1:]:
+
506 boundary = boundary.union(geom)
+
+
508 boundary = shape(features[0][
"geometry"])
+
+
510 minx, miny, maxx, maxy = boundary.bounds
+
+
+
513 value = dimension / 111139
+
+
515 nx = int((maxx - minx) / value)
+
516 ny = int((maxy - miny) / value)
+
+
+
519 xdiff = abs(maxx - minx)
+
520 ydiff = abs(maxy - miny)
+
+
522 gx, gy = np.linspace(minx, maxx, ny), np.linspace(miny, miny + xdiff, ny)
+
+
524 gx, gy = np.linspace(minx, minx + ydiff, nx), np.linspace(miny, maxy, nx)
+
+
+
+
528 for i
in range(len(gx) - 1):
+
529 for j
in range(len(gy) - 1):
+
+
+
+
+
534 [gx[i + 1], gy[j + 1]],
+
+
+
+
+
+
540 if boundary.intersection(poly):
+
541 feature = geojson.Feature(
+
542 geometry=boundary.intersection(poly), properties={
"id": str(id)}
+
+
+
+
546 geom = shape(feature[
"geometry"])
+
+
548 if geom.geom_type ==
"MultiPolygon":
+
+
550 polygons = geom.geoms
+
+
552 for x
in range(len(polygons)):
+
+
+
+
+
557 "geometry": mapping(polygons[x]),
+
+
559 grid.append(feature1)
+
+
+
+
563 collection = geojson.FeatureCollection(grid)
+
+
+
+
567 if len(collection[
"features"]) == 0:
+
568 boundary = mapping(boundary)
+
+
570 "type":
"FeatureCollection",
+
571 "features": [{
"type":
"Feature",
"geometry": boundary,
"properties": {}}],
+
+
+
+
+
+
+
578 async
def get_osm_extracts(boundary: str):
+
579 """Request an extract from raw-data-api and extract the file contents.
+
+
581 - The query is posted to raw-data-api and job initiated for fetching the extract.
+
582 - The status of the job is polled every few seconds, until 'SUCCESS' is returned.
+
583 - The resulting zip file is downloaded, extracted, and data returned.
+
+
+
+
+
+
+
590 "join_or": {
"building": [],
"highway": [],
"waterway": []}
+
+
+
+
+
+
+
597 json_boundary = json.loads(boundary)
+
598 if json_boundary.get(
"features",
None)
is not None:
+
599 query[
"geometry"] = json_boundary
+
+
+
602 query[
"geometry"] = json_boundary
+
+
+
605 query[
"fileName"] =
"extract"
+
+
607 query[
"outputType"] =
"geojson"
+
608 extract_filename = f
'{query["fileName"]}.{query["outputType"]}'
+
609 log.debug(f
"Setting data extract file name to: {extract_filename}")
+
+
611 log.debug(f
"Query for raw data api: {query}")
+
612 base_url = settings.UNDERPASS_API_URL
+
613 query_url = f
"{base_url}/snapshot/"
+
614 headers = {
"accept":
"application/json",
"Content-Type":
"application/json"}
+
+
+
617 result = requests.post(query_url, data=json.dumps(query), headers=headers)
+
+
619 if result.status_code == 200:
+
620 task_id = result.json()[
"task_id"]
+
+
+
+
+
625 task_url = f
"{base_url}/tasks/status/{task_id}"
+
+
627 result = requests.get(task_url, headers=headers)
+
628 if result.json()[
"status"] ==
"PENDING":
+
+
+
631 elif result.json()[
"status"] ==
"SUCCESS":
+
+
+
+
+
+
637 zip_url = result.json()[
"result"][
"download_url"]
+
638 result = requests.get(zip_url, headers=headers)
+
+
640 fp = BytesIO(result.content)
+
641 zfp = zipfile.ZipFile(fp,
"r")
+
642 zfp.extract(extract_filename,
"/tmp/")
+
643 data = json.loads(zfp.read(extract_filename))
+
+
645 for feature
in data[
"features"]:
+
646 properties = feature[
"properties"]
+
647 tags = properties.pop(
"tags", {})
+
648 properties.update(tags)
+
+
+
+
+
653 async
def split_into_tasks(
+
654 db: Session, project_geojson: str, no_of_buildings: int, has_data_extracts: bool
+
+
656 """Splits a project into tasks.
+
+
+
659 db (Session): A database session.
+
660 boundary (str): A GeoJSON string representing the boundary of the project to split into tasks.
+
661 no_of_buildings (int): The number of buildings to include in each task.
+
+
+
664 Any: A GeoJSON object containing the tasks for the specified project.
+
+
666 project_id = uuid.uuid4()
+
+
668 split_geom_geojson = []
+
+
670 async
def split_multi_geom_into_tasks():
+
+
+
673 split_polygon_into_tasks(
+
674 db, project_id, data, no_of_buildings, has_data_extracts
+
+
676 for data
in boundary_geoms
+
+
+
+
+
681 item
for sublist
in await gather(*split_poly)
for item
in sublist
if sublist
+
+
+
684 if project_geojson[
"type"] ==
"FeatureCollection":
+
685 log.debug(
"Project boundary GeoJSON = FeatureCollection")
+
686 boundary_geoms.extend(
+
687 feature[
"geometry"]
for feature
in project_geojson[
"features"]
+
+
689 geoms = await split_multi_geom_into_tasks()
+
690 split_geom_geojson.extend(geoms)
+
+
692 elif project_geojson[
"type"] ==
"GeometryCollection":
+
693 log.debug(
"Project boundary GeoJSON = GeometryCollection")
+
694 geometries = project_geojson[
"geometries"]
+
695 boundary_geoms.extend(iter(geometries))
+
696 geoms = await split_multi_geom_into_tasks()
+
697 split_geom_geojson.extend(geoms)
+
+
699 elif project_geojson[
"type"] ==
"Feature":
+
700 log.debug(
"Project boundary GeoJSON = Feature")
+
701 boundary_geoms = project_geojson[
"geometry"]
+
702 geom = await split_polygon_into_tasks(
+
703 db, project_id, boundary_geoms, no_of_buildings, has_data_extracts
+
+
705 split_geom_geojson.extend(geom)
+
+
707 elif project_geojson[
"type"] ==
"Polygon":
+
708 log.debug(
"Project boundary GeoJSON = Polygon")
+
709 boundary_geoms = project_geojson
+
710 geom = await split_polygon_into_tasks(
+
711 db, project_id, boundary_geoms, no_of_buildings, has_data_extracts
+
+
713 split_geom_geojson.extend(geom)
+
+
+
+
717 "Project boundary not one of: Polygon, Feature, GeometryCollection,"
+
718 " FeatureCollection. Task splitting failed."
+
+
+
721 "type":
"FeatureCollection",
+
722 "features": split_geom_geojson,
+
+
+
+
726 async
def split_polygon_into_tasks(
+
+
728 project_id: uuid.UUID,
+
+
730 no_of_buildings: int,
+
731 has_data_extracts: bool,
+
+
733 outline = shape(boundary_data)
+
734 db_task = db_models.DbProjectAOI(
+
735 project_id=project_id,
+
+
+
+
+
+
+
+
+
+
745 if not has_data_extracts:
+
746 data = await get_osm_extracts(json.dumps(boundary_data))
+
+
+
749 for feature
in data[
"features"]:
+
750 feature_shape = shape(feature[
"geometry"])
+
751 wkb_element = from_shape(feature_shape, srid=4326)
+
752 if feature[
"properties"].get(
"building") ==
"yes":
+
753 db_feature = db_models.DbBuildings(
+
754 project_id=project_id, geom=wkb_element, tags=feature[
"properties"]
+
+
+
757 elif "highway" in feature[
"properties"]:
+
758 db_feature = db_models.DbOsmLines(
+
759 project_id=project_id, geom=wkb_element, tags=feature[
"properties"]
+
+
+
+
+
+
+
+
+
768 DELETE FROM ways_poly
+
769 WHERE NOT ST_Within(ST_Centroid(ways_poly.geom), (SELECT geom FROM project_aoi WHERE project_id = '{project_id}'));
+
+
+
772 result = db.execute(query)
+
+
+
+
776 with open(
"app/db/split_algorithm.sql",
"r")
as sql_file:
+
777 query = sql_file.read()
+
778 log.debug(f
"STARTED project {project_id} task splitting")
+
779 result = db.execute(text(query), params={
"num_buildings": no_of_buildings})
+
780 result = result.fetchall()
+
781 db.query(db_models.DbBuildings).delete()
+
782 db.query(db_models.DbOsmLines).delete()
+
783 db.query(db_models.DbProjectAOI).delete()
+
+
785 log.debug(f
"COMPLETE project {project_id} task splitting")
+
+
787 features = result[0][0][
"features"]
+
+
+
790 f
"Project {project_id}: no tasks returned from splitting algorithm. "
+
791 f
"Params: 'num_buildings': {no_of_buildings}"
+
+
+
+
795 log.debug(f
"Project {project_id} split into {len(features)} tasks")
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
871 async
def update_project_boundary(
+
872 db: Session, project_id: int, boundary: str, dimension: int
+
+
+
875 db_project = await get_project_by_id(db, project_id)
+
+
877 log.error(f
"Project {project_id} doesn't exist!")
+
+
+
880 """Use a lambda function to remove the "z" dimension from each coordinate in the feature's geometry """
+
+
882 def remove_z_dimension(coord):
+
883 return coord.pop()
if len(coord) == 3
else None
+
+
885 """ Check if the boundary is a Feature or a FeatureCollection """
+
886 if boundary[
"type"] ==
"Feature":
+
887 features = [boundary]
+
888 elif boundary[
"type"] ==
"FeatureCollection":
+
889 features = boundary[
"features"]
+
890 elif boundary[
"type"] ==
"Polygon":
+
+
+
+
+
895 "geometry": boundary,
+
+
+
+
+
900 db.delete(db_project)
+
+
+
+
+
905 status_code=400, detail=f
"Invalid GeoJSON type: {boundary['type']}"
+
+
+
908 """ Apply the lambda function to each coordinate in its geometry """
+
+
910 for feature
in features:
+
911 list(map(remove_z_dimension, feature[
"geometry"][
"coordinates"][0]))
+
912 if feature[
"geometry"][
"type"] ==
"MultiPolygon":
+
913 multi_polygons.append(Polygon(feature[
"geometry"][
"coordinates"][0][0]))
+
+
915 """Update the boundary polyon on the database."""
+
+
917 outline = multi_polygons[0]
+
918 for geom
in multi_polygons[1:]:
+
919 outline = outline.union(geom)
+
+
921 outline = shape(features[0][
"geometry"])
+
+
923 await update_project_location_info(db_project, outline.wkt)
+
+
+
926 db.refresh(db_project)
+
927 log.debug(
"Added project boundary!")
+
+
929 result = await create_task_grid(db, project_id=project_id, delta=dimension)
+
+
+
932 db.query(db_models.DbFeatures).filter(
+
933 db_models.DbFeatures.project_id == project_id
+
+
+
+
937 db.query(db_models.DbTask).filter(
+
938 db_models.DbTask.project_id == project_id
+
+
+
+
942 for poly
in tasks[
"features"]:
+
+
944 task_name = str(poly[
"properties"][
"id"])
+
945 db_task = db_models.DbTask(
+
946 project_id=project_id,
+
947 project_task_name=task_name,
+
948 outline=wkblib.dumps(shape(poly[
"geometry"]), hex=
True),
+
+
+
+
952 project_task_index=1,
+
+
+
+
+
+
+
+
+
+
+
963 async
def update_project_with_zip(
+
+
+
966 project_name_prefix: str,
+
967 task_type_prefix: str,
+
968 uploaded_zip: UploadFile,
+
+
+
+
+
973 if uploaded_zip.content_type
not in [
+
+
975 "application/zip-compressed",
+
976 "application/x-zip-compressed",
+
+
+
+
980 detail=f
"File must be a zip. Uploaded file was {uploaded_zip.content_type}",
+
+
+
983 with ZipFile(io.BytesIO(uploaded_zip.file.read()),
"r")
as zip:
+
+
985 bad_file = zip.testzip()
+
+
+
988 status_code=400, detail=f
"Zip contained a bad file: {bad_file}"
+
+
+
+
992 listed_files = zip.namelist()
+
+
994 if QR_CODES_DIR
not in listed_files:
+
+
+
997 detail=f
"Zip must contain directory named {QR_CODES_DIR}",
+
+
+
1000 if TASK_GEOJSON_DIR
not in listed_files:
+
1001 raise HTTPException(
+
+
1003 detail=f
"Zip must contain directory named {TASK_GEOJSON_DIR}",
+
+
+
1006 outline_filename = f
"{project_name_prefix}.geojson"
+
1007 if outline_filename
not in listed_files:
+
1008 raise HTTPException(
+
+
1010 detail=f
'Zip must contain file named "{outline_filename}" that contains a FeatureCollection outlining the project',
+
+
+
1013 task_outlines_filename = f
"{project_name_prefix}_polygons.geojson"
+
1014 if task_outlines_filename
not in listed_files:
+
1015 raise HTTPException(
+
+
1017 detail=f
'Zip must contain file named "{task_outlines_filename}" that contains a FeatureCollection where each Feature outlines a task',
+
+
+
+
1021 db_project = await get_project_by_id(db, project_id)
+
+
1023 raise HTTPException(
+
1024 status_code=428, detail=f
"Project with id {project_id} does not exist"
+
+
+
+
1028 db_project.project_name_prefix = project_name_prefix
+
1029 db_project.task_type_prefix = task_type_prefix
+
+
+
1032 outline_shape = await get_outline_from_geojson_file_in_zip(
+
1033 zip, outline_filename, f
"Could not generate Shape from {outline_filename}"
+
+
1035 await update_project_location_info(db_project, outline_shape.wkt)
+
+
+
1038 project_tasks_feature_collection = await get_json_from_zip(
+
+
1040 task_outlines_filename,
+
1041 f
"Could not generate FeatureCollection from {task_outlines_filename}",
+
+
+
+
+
+
1047 db_project.total_tasks = len(project_tasks_feature_collection[
"features"])
+
1048 for feature
in project_tasks_feature_collection[
"features"]:
+
1049 task_name = feature[
"properties"][
"task"]
+
+
+
+
1053 f
"{project_name_prefix}_{task_type_prefix}__{task_name}.png"
+
+
1055 db_qr = await get_dbqrcode_from_file(
+
+
1057 QR_CODES_DIR + qr_filename,
+
1058 f
"QRCode for task {task_name} does not exist. File should be in {qr_filename}",
+
+
+
+
+
1063 task_outline_shape = await get_shape_from_json_str(
+
+
1065 f
"Could not create task outline for {task_name} using {feature}",
+
+
+
+
1069 task_geojson_filename = (
+
1070 f
"{project_name_prefix}_{task_type_prefix}__{task_name}.geojson"
+
+
1072 task_geojson = await get_json_from_zip(
+
+
1074 TASK_GEOJSON_DIR + task_geojson_filename,
+
1075 f
"Geojson for task {task_name} does not exist",
+
+
+
+
+
+
1081 task = db_models.DbTask(
+
1082 project_id=project_id,
+
1083 project_task_index=feature[
"properties"][
"fid"],
+
1084 project_task_name=task_name,
+
+
1086 qr_code_id=db_qr.id,
+
1087 outline=task_outline_shape.wkt,
+
+
1089 initial_feature_count=len(task_geojson[
"features"]),
+
+
+
+
+
1094 task_count = task_count + 1
+
1095 db_project.last_updated = timestamp()
+
+
+
+
1099 db.refresh(db_project)
+
+
+
+
+
1104 except HTTPException
as e:
+
+
+
+
1108 except Exception
as e:
+
1109 raise HTTPException(
+
+
1111 detail=f
"{task_count} tasks were created before the following error was thrown: {e}, on feature: {feature}",
+
+
+
+
+
+
+
+
+
1120 async
def read_xlsforms(
+
+
+
+
1124 """Read the list of XLSForms from the disk."""
+
+
1126 package_name =
"osm_fieldwork"
+
1127 for xls
in os.listdir(directory):
+
1128 if xls.endswith(
".xls")
or xls.endswith(
".xlsx"):
+
1129 file_name = xls.split(
".")[0]
+
1130 yaml_file_name = f
"data_models/{file_name}.yaml"
+
1131 if pkg_resources.resource_exists(package_name, yaml_file_name):
+
1132 xlsforms.append(xls)
+
+
+
+
1136 inspect(db_models.DbXForm)
+
+
1138 "xlsforms", column(
"title"), column(
"xls"), column(
"xml"), column(
"id")
+
+
+
+
+
1143 for xlsform
in xlsforms:
+
1144 infile = f
"{directory}/{xlsform}"
+
1145 if os.path.getsize(infile) <= 0:
+
1146 log.warning(f
"{infile} is empty!")
+
+
1148 xls = open(infile,
"rb")
+
1149 name = xlsform.split(
".")[0]
+
+
+
+
1153 ins = insert(forms).values(title=name, xls=data)
+
1154 sql = ins.on_conflict_do_update(
+
1155 constraint=
"xlsforms_title_key", set_=dict(title=name, xls=data)
+
+
+
+
+
+
+
+
1163 async
def get_odk_id_for_project(db: Session, project_id: int):
+
1164 """Get the odk project id for the fmtm project id."""
+
+
+
+
+
+
1170 where = f
"id={project_id}"
+
1171 sql = select(project).where(text(where))
+
+
1173 result = db.execute(sql)
+
+
+
1176 if result.rowcount != 1:
+
1177 log.warning(str(sql))
+
+
1179 project_info = result.first()
+
1180 return project_info.odkid
+
+
+
1183 async
def upload_custom_data_extracts(
+
+
+
+
1187 category: str =
"buildings",
+
+
1189 """Uploads custom data extracts to the database.
+
+
+
1192 db (Session): The database session object.
+
1193 project_id (int): The ID of the project.
+
1194 contents (str): The custom data extracts contents.
+
+
+
1197 bool: True if the upload is successful.
+
+
1199 project = await get_project(db, project_id)
+
1200 log.debug(f
"Uploading custom data extract for project: {project}")
+
+
+
1203 raise HTTPException(status_code=404, detail=
"Project not found")
+
+
1205 project_geojson = db.query(func.ST_AsGeoJSON(project.outline)).scalar()
+
1206 log.debug(f
"Generated project geojson: {project_geojson}")
+
1207 json.loads(project_geojson)
+
+
1209 features_data = json.loads(contents)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
1223 for feature
in features_data[
"features"]:
+
1224 feature_shape = shape(feature[
"geometry"])
+
1225 if isinstance(feature_shape, MultiPolygon):
+
1226 wkb_element = from_shape(
+
1227 Polygon(feature[
"geometry"][
"coordinates"][0][0]), srid=4326
+
+
1229 elif isinstance(feature_shape, MultiLineString):
+
1230 wkb_element = from_shape(
+
1231 LineString(feature[
"geometry"][
"coordinates"][0]), srid=4326
+
+
+
1234 wkb_element = from_shape(feature_shape, srid=4326)
+
+
+
1237 feature[
"properties"][
"title"] =
""
+
1238 properties = flatten_dict(feature[
"properties"])
+
+
1240 db_feature = db_models.DbFeatures(
+
1241 project_id=project_id,
+
1242 geometry=wkb_element,
+
1243 properties=properties,
+
1244 category_title=category,
+
+
+
+
+
+
+
+
1252 def flatten_dict(d, parent_key="", sep="_"):
+
1253 """Recursively flattens a nested dictionary into a single-level dictionary.
+
+
+
1256 d (dict): The input dictionary.
+
1257 parent_key (str): The parent key (used for recursion).
+
1258 sep (str): The separator character to use in flattened keys.
+
+
+
1261 dict: The flattened dictionary.
+
+
+
1264 for k, v
in d.items():
+
1265 new_key = f
"{parent_key}{sep}{k}" if parent_key
else k
+
1266 if isinstance(v, dict):
+
1267 items.update(flatten_dict(v, new_key, sep=sep))
+
+
+
+
+
+
+
1274 def generate_task_files(
+
+
+
+
+
+
1280 odk_credentials: project_schemas.ODKCentral,
+
+
1282 project_log = log.bind(task=
"create_project", project_id=project_id)
+
+
1284 project_log.info(f
"Generating files for task {task_id}")
+
+
1286 get_project_sync = async_to_sync(get_project)
+
1287 project = get_project_sync(db, project_id)
+
+
1289 odk_id = project.odkid
+
1290 project_name = project.project_name_prefix
+
1291 category = project.xform_title
+
1292 name = f
"{project_name}_{category}_{task_id}"
+
+
+
1295 project_log.info(f
"Creating odkcentral app user for task {task_id}")
+
1296 appuser = central_crud.create_appuser(odk_id, name, odk_credentials)
+
+
+
+
1300 project_log.error(
"Couldn't create appuser for project")
+
+
+
+
1304 project_log.info(f
"Creating qr code for task {task_id}")
+
1305 create_qr_sync = async_to_sync(create_qrcode)
+
1306 qr_code = create_qr_sync(
+
+
+
1309 appuser.json()[
"token"],
+
+
1311 odk_credentials.odk_central_url,
+
+
+
1314 get_task_sync = async_to_sync(tasks_crud.get_task)
+
1315 task = get_task_sync(db, task_id)
+
1316 task.qr_code_id = qr_code[
"qr_code_id"]
+
+
+
+
+
1321 xform = f
"/tmp/{name}.xml"
+
1322 extracts = f
"/tmp/{name}.geojson"
+
+
+
1325 xform_id = f
"{name}".split(
"_")[2]
+
+
+
+
+
+
+
1332 SET task_id={task_id}
+
+
+
+
1336 WHERE project_id={project_id}
+
1337 AND ST_IsValid(geometry)
+
1338 AND ST_IsValid('{task.outline}'::Geometry)
+
1339 AND ST_Contains('{task.outline}'::Geometry, ST_Centroid(geometry))
+
+
+
+
1343 result = db.execute(query)
+
+
+
+
1347 f
"""SELECT jsonb_build_object(
+
1348 'type', 'FeatureCollection',
+
1349 'features', jsonb_agg(feature)
+
+
+
1352 SELECT jsonb_build_object(
+
+
+
1355 'geometry', ST_AsGeoJSON(geometry)::jsonb,
+
1356 'properties', properties
+
+
+
1359 WHERE project_id={project_id} and task_id={task_id}
+
+
+
+
1363 result = db.execute(query)
+
+
1365 features = result.fetchone()[0]
+
+
1367 upload_media =
False if features[
"features"]
is None else True
+
+
+
1370 with open(extracts,
"w")
as jsonfile:
+
1371 jsonfile.truncate(0)
+
1372 dump(features, jsonfile)
+
+
+
1375 f
"Generating xform for task: {task_id} "
+
1376 f
"using xform: {xform} | form_type: {form_type}"
+
+
1378 outfile = central_crud.generate_updated_xform(xlsform, xform, form_type)
+
+
+
1381 project_log.info(f
"Uploading media in {task_id}")
+
1382 result = central_crud.create_odk_xform(
+
1383 odk_id, task_id, outfile, odk_credentials,
False, upload_media
+
+
+
+
1387 project_log.info(f
"Updating role for app user in task {task_id}")
+
+
+
+
+
1392 url = odk_credentials.odk_central_url
+
1393 user = odk_credentials.odk_central_user
+
1394 pw = odk_credentials.odk_central_password
+
+
+
1397 log.debug(
"ODKCentral connection variables not set in function")
+
1398 log.debug(
"Attempting extraction from environment variables")
+
1399 url = settings.ODK_CENTRAL_URL
+
1400 user = settings.ODK_CENTRAL_USER
+
1401 pw = settings.ODK_CENTRAL_PASSWD
+
+
1403 odk_app = OdkAppUser(url, user, pw)
+
+
+
1406 projectId=odk_id, xform=xform_id, actorId=appuser.json()[
"id"]
+
+
1408 except Exception
as e:
+
+
+
1411 project.extract_completed_count += 1
+
+
+
+
+
+
+
+
1419 def generate_appuser_files(
+
+
+
1422 extract_polygon: bool,
+
1423 custom_xls_form: str,
+
1424 extracts_contents: str,
+
+
+
1427 background_task_id: Optional[uuid.UUID] =
None,
+
+
1429 """Generate the files for each appuser.
+
+
1431 QR code, new XForm, and the OSM data extract.
+
+
+
1434 - db: the database session
+
1435 - project_id: Project ID
+
1436 - extract_polygon: boolean to determine if we should extract the polygon
+
1437 - custom_xls_form: the xls file to upload if we have a custom form
+
1438 - category: the category of the project
+
1439 - form_type: weather the form is xls, xlsx or xml
+
1440 - background_task_id: the task_id of the background task running this function.
+
+
+
1443 project_log = log.bind(task=
"create_project", project_id=project_id)
+
+
1445 project_log.info(f
"Starting generate_appuser_files for project {project_id}")
+
+
+
+
+
1450 column(
"project_name_prefix"),
+
1451 column(
"xform_title"),
+
+
1453 column(
"odk_central_url"),
+
1454 column(
"odk_central_user"),
+
1455 column(
"odk_central_password"),
+
+
+
+
1459 where = f
"id={project_id}"
+
+
1461 project.c.project_name_prefix,
+
1462 project.c.xform_title,
+
+
1464 project.c.odk_central_url,
+
1465 project.c.odk_central_user,
+
1466 project.c.odk_central_password,
+
1467 geoalchemy2.functions.ST_AsGeoJSON(project.c.outline).label(
"outline"),
+
1468 ).where(text(where))
+
1469 result = db.execute(sql)
+
+
+
1472 if result.rowcount != 1:
+
1473 log.warning(str(sql))
+
1474 if result.rowcount < 1:
+
1475 raise HTTPException(status_code=400, detail=
"Project not found")
+
+
1477 raise HTTPException(status_code=400, detail=
"Multiple projects found")
+
+
1479 one = result.first()
+
+
+
+
+
1484 "odk_central_url": one.odk_central_url,
+
1485 "odk_central_user": one.odk_central_user,
+
1486 "odk_central_password": one.odk_central_password,
+
+
+
1489 odk_credentials = project_schemas.ODKCentral(**odk_credentials)
+
+
1491 xform_title = one.xform_title
if one.xform_title
else None
+
+
1493 category = xform_title
+
+
1495 xlsform = f
"/tmp/{category}.{form_type}"
+
1496 contents = custom_xls_form
+
1497 with open(xlsform,
"wb")
as f:
+
+
+
1500 xlsform = f
"{xlsforms_path}/{xform_title}.xls"
+
+
+
1503 if extracts_contents
is not None:
+
1504 project_log.info(
"Uploading data extracts")
+
1505 upload_extract_sync = async_to_sync(upload_custom_data_extracts)
+
1506 upload_extract_sync(db, project_id, extracts_contents)
+
+
+
+
1510 db.query(db_models.DbProject)
+
1511 .filter(db_models.DbProject.id == project_id)
+
+
+
1514 config_file_contents = project.form_config_file
+
+
1516 project_log.info(
"Extracting Data from OSM")
+
+
1518 config_path =
"/tmp/config.yaml"
+
1519 if config_file_contents:
+
1520 with open(config_path,
"w", encoding=
"utf-8")
as config_file_handle:
+
1521 config_file_handle.write(config_file_contents.decode(
"utf-8"))
+
+
1523 config_path = f
"{data_models_path}/{category}.yaml"
+
+
+
1526 pg = PostgresClient(
"underpass", config_path)
+
1527 outline = json.loads(one.outline)
+
1528 boundary = {
"type":
"Feature",
"properties": {},
"geometry": outline}
+
1529 data_extract = pg.execQuery(boundary)
+
1530 filter = FilterData(xlsform)
+
+
1532 updated_data_extract = {
"type":
"FeatureCollection",
"features": []}
+
1533 filtered_data_extract = (
+
1534 filter.cleanData(data_extract)
+
+
1536 else updated_data_extract
+
+
+
+
1540 feature_mappings = []
+
+
1542 for feature
in filtered_data_extract[
"features"]:
+
+
1544 feature[
"properties"][
"title"] =
""
+
+
1546 feature_shape = shape(feature[
"geometry"])
+
+
+
1549 if extract_polygon
and (
+
1550 not shape(outline).contains(shape(feature_shape.centroid))
+
+
+
+
1554 wkb_element = from_shape(feature_shape, srid=4326)
+
+
1556 "project_id": project_id,
+
1557 "category_title": category,
+
1558 "geometry": wkb_element,
+
1559 "properties": feature[
"properties"],
+
+
1561 updated_data_extract[
"features"].append(feature)
+
1562 feature_mappings.append(feature_mapping)
+
+
1564 db.bulk_insert_mappings(db_models.DbFeatures, feature_mappings)
+
+
+
+
1568 get_task_lists_sync = async_to_sync(tasks_crud.get_task_lists)
+
1569 tasks_list = get_task_lists_sync(db, project_id)
+
+
+
1572 def wrap_generate_task_files(task):
+
1573 """Func to wrap and return errors from thread.
+
+
1575 Also passes it's own database session for thread safety.
+
1576 If we pass a single db session to multiple threads,
+
1577 there may be inconsistencies or errors.
+
+
+
1580 generate_task_files(
+
+
+
+
+
+
+
+
1588 except Exception
as e:
+
1589 log.exception(str(e))
+
+
+
1592 with ThreadPoolExecutor()
as executor:
+
+
+
1595 executor.submit(wrap_generate_task_files, task)
+
1596 for task
in tasks_list
+
+
+
+
+
1601 if background_task_id:
+
+
1603 update_bg_task_sync = async_to_sync(
+
1604 update_background_task_status_in_database
+
+
1606 update_bg_task_sync(db, background_task_id, 4)
+
+
1608 except Exception
as e:
+
+
+
1611 if background_task_id:
+
+
1613 update_bg_task_sync = async_to_sync(
+
1614 update_background_task_status_in_database
+
+
1616 update_bg_task_sync(db, background_task_id, 2, str(e))
+
+
+
+
+
+
1622 async
def create_qrcode(
+
+
+
+
+
1627 odk_central_url: str =
None,
+
+
+
1630 log.debug(f
"Generating base64 encoded QR settings for token: {token}")
+
1631 qrcode_data = await central_crud.create_qrcode(
+
1632 odk_id, token, project_name, odk_central_url
+
+
+
1635 log.debug(
"Generating QR code from base64 settings")
+
1636 qrcode = segno.make(qrcode_data, micro=
False)
+
+
1638 log.debug(
"Saving to buffer and decoding")
+
1639 buffer = io.BytesIO()
+
1640 qrcode.save(buffer, kind=
"png", scale=5)
+
1641 qrcode_binary = buffer.getvalue()
+
+
1643 log.debug(f
"Writing QR code to database for token {token}")
+
1644 qrdb = db_models.DbQrCode(image=qrcode_binary)
+
+
+
1647 codes = table(
"qr_code", column(
"id"))
+
1648 sql = select(sqlalchemy.func.count(codes.c.id))
+
1649 result = db.execute(sql)
+
1650 rows = result.fetchone()[0]
+
1651 return {
"data": qrcode,
"id": rows + 1,
"qr_code_id": qrdb.id}
+
+
+
1654 async
def get_project_geometry(db: Session, project_id: int):
+
1655 """Retrieves the geometry of a project.
+
+
+
1658 db (Session): The database session.
+
1659 project_id (int): The ID of the project.
+
+
+
1662 str: A geojson of the project outline.
+
+
1664 projects = table(
"projects", column(
"outline"), column(
"id"))
+
1665 where = f
"projects.id={project_id}"
+
1666 sql = select(geoalchemy2.functions.ST_AsGeoJSON(projects.c.outline)).where(
+
+
+
1669 result = db.execute(sql)
+
+
1671 if result.rowcount != 1:
+
1672 log.warning(str(sql))
+
+
1674 row = eval(result.first()[0])
+
1675 return json.dumps(row)
+
+
+
1678 async
def get_task_geometry(db: Session, project_id: int):
+
1679 """Retrieves the geometry of tasks associated with a project.
+
+
+
1682 db (Session): The database session.
+
1683 project_id (int): The ID of the project.
+
+
+
1686 str: A geojson of the task boundaries
+
+
1688 db_tasks = await tasks_crud.get_tasks(db, project_id,
None)
+
+
1690 for task
in db_tasks:
+
1691 geom = to_shape(task.outline)
+
+
1693 geometry = geom.__geo_interface__
+
+
+
+
1697 feature = {
"type":
"Feature",
"geometry": geometry,
"properties": properties}
+
1698 features.append(feature)
+
+
1700 feature_collection = {
"type":
"FeatureCollection",
"features": features}
+
1701 return json.dumps(feature_collection)
+
+
+
1704 async
def get_project_features_geojson(db: Session, project_id: int):
+
+
1706 db.query(db_models.DbFeatures)
+
1707 .filter(db_models.DbFeatures.project_id == project_id)
+
+
+
+
1711 """Get a geojson of all features for a task."""
+
+
1713 f
"""SELECT jsonb_build_object(
+
1714 'type', 'FeatureCollection',
+
1715 'features', jsonb_agg(feature)
+
+
+
1718 SELECT jsonb_build_object(
+
+
+
1721 'geometry', ST_AsGeoJSON(geometry)::jsonb,
+
1722 'properties', properties
+
+
+
1725 WHERE project_id={project_id}
+
+
+
+
+
1730 result = db.execute(query)
+
1731 features = result.fetchone()[0]
+
+
+
1734 task_feature_mapping = {feat.id: feat.task_id
for feat
in db_features}
+
+
1736 for feature
in features[
"features"]:
+
1737 if (feat_id := feature[
"id"])
in task_feature_mapping:
+
1738 feature[
"properties"][
"task_id"] = task_feature_mapping[feat_id]
+
+
+
+
+
1743 async
def create_task_grid(db: Session, project_id: int, delta: int):
+
+
+
1746 projects = table(
"projects", column(
"outline"), column(
"id"))
+
1747 where = f
"projects.id={project_id}"
+
1748 sql = select(geoalchemy2.functions.ST_AsGeoJSON(projects.c.outline)).where(
+
+
+
1751 result = db.execute(sql)
+
+
1753 if result.rowcount != 1:
+
1754 log.warning(str(sql))
+
+
1756 data = result.fetchall()
+
1757 boundary = shape(loads(data[0][0]))
+
1758 minx, miny, maxx, maxy = boundary.bounds
+
+
+
1761 value = delta / 111139
+
+
1763 nx = int((maxx - minx) / value)
+
1764 ny = int((maxy - miny) / value)
+
+
+
+
+
+
1770 gx, gy = np.linspace(minx, maxx, ny), np.linspace(miny, miny + xdiff, ny)
+
+
1772 gx, gy = np.linspace(minx, minx + ydiff, nx), np.linspace(miny, maxy, nx)
+
+
+
+
+
1777 for i
in range(len(gx) - 1):
+
1778 for j
in range(len(gy) - 1):
+
+
+
+
+
1783 [gx[i + 1], gy[j + 1]],
+
+
+
+
+
+
1789 if boundary.intersection(poly):
+
1790 feature = geojson.Feature(
+
1791 geometry=boundary.intersection(poly), properties={
"id": str(id)}
+
+
+
1794 geom = shape(feature[
"geometry"])
+
+
1796 if geom.geom_type ==
"MultiPolygon":
+
+
1798 polygons = geom.geoms
+
+
1800 for x
in range(len(polygons)):
+
+
+
+
+
1805 "properties": {
"id": str(id)},
+
1806 "geometry": mapping(polygons[x]),
+
+
1808 grid.append(feature1)
+
+
+
1811 grid.append(feature)
+
+
1813 collection = geojson.FeatureCollection(grid)
+
+
+
1816 out = dumps(collection)
+
+
+
+
1820 result = json.loads(out)
+
1821 if len(result[
"features"]) == 0:
+
1822 geom = loads(data[0][0])
+
+
1824 "type":
"FeatureCollection",
+
+
+
+
+
1829 "properties": {
"id": project_id},
+
+
+
+
1833 out = json.dumps(out)
+
+
+
1836 except Exception
as e:
+
+
+
+
1840 async
def get_json_from_zip(zip, filename: str, error_detail: str):
+
+
1842 with zip.open(filename)
as file:
+
+
1844 return json.loads(data)
+
1845 except Exception
as e:
+
1846 raise HTTPException(status_code=400, detail=f
"{error_detail} ----- Error: {e}")
+
+
+
1849 async
def get_outline_from_geojson_file_in_zip(
+
1850 zip, filename: str, error_detail: str, feature_index: int = 0
+
+
+
1853 with zip.open(filename)
as file:
+
+
1855 json_dump = json.loads(data)
+
1856 check_crs(json_dump)
+
1857 feature_collection = geojson.FeatureCollection(json_dump)
+
1858 feature = feature_collection[
"features"][feature_index]
+
1859 geom = feature[
"geometry"]
+
1860 shape_from_geom = shape(geom)
+
1861 return shape_from_geom
+
1862 except Exception
as e:
+
+
1864 raise HTTPException(
+
+
1866 detail=f
"{error_detail} ----- Error: {e} ----",
+
+
+
+
1870 async
def get_shape_from_json_str(feature: str, error_detail: str):
+
+
1872 geom = feature[
"geometry"]
+
+
1874 except Exception
as e:
+
+
1876 raise HTTPException(
+
+
1878 detail=f
"{error_detail} ----- Error: {e} ---- Json: {feature}",
+
+
+
+
1882 async
def get_dbqrcode_from_file(zip, qr_filename: str, error_detail: str):
+
+
1884 with zip.open(qr_filename)
as qr_file:
+
1885 binary_qrcode = qr_file.read()
+
+
1887 return db_models.DbQrCode(
+
1888 filename=qr_filename,
+
1889 image=binary_qrcode,
+
+
+
1892 raise HTTPException(
+
1893 status_code=400, detail=f
"{qr_filename} is an empty file"
+
+
1895 except Exception
as e:
+
+
1897 raise HTTPException(
+
1898 status_code=400, detail=f
"{error_detail} ----- Error: {e}"
+
+
+
+
+
+
+
+
+
+
+
1909 async
def convert_to_app_project(db_project: db_models.DbProject):
+
+
+
1912 log.debug(
"convert_to_app_project called, but no project provided")
+
+
+
1915 log.debug(
"Converting db project to app project")
+
1916 app_project: project_schemas.Project = db_project
+
+
1918 if db_project.outline:
+
1919 log.debug(
"Converting project outline to geojson")
+
1920 app_project.outline_geojson = geometry_to_geojson(
+
1921 db_project.outline, {
"id": db_project.id}, db_project.id
+
+
+
1924 app_project.project_tasks = db_project.tasks
+
+
+
+
+
1929 async
def convert_to_app_project_info(db_project_info: db_models.DbProjectInfo):
+
+
+
1932 app_project_info: project_schemas.ProjectInfo = db_project_info
+
1933 return app_project_info
+
+
+
+
+
1938 async
def convert_to_app_projects(
+
1939 db_projects: List[db_models.DbProject],
+
1940 ) -> List[project_schemas.ProjectOut]:
+
+
1942 if db_projects
and len(db_projects) > 0:
+
+
1944 async
def convert_project(project):
+
1945 return await convert_to_app_project(project)
+
+
1947 app_projects = await gather(
+
1948 *[convert_project(project)
for project
in db_projects]
+
+
1950 return [project
for project
in app_projects
if project
is not None]
+
+
+
+
+
1955 async
def convert_to_project_summary(db_project: db_models.DbProject):
+
+
+
1958 summary: project_schemas.ProjectSummary = db_project
+
+
1960 if db_project.project_info:
+
1961 summary.location_str = db_project.location_str
+
1962 summary.title = db_project.project_info.name
+
1963 summary.description = db_project.project_info.short_description
+
+
1965 summary.num_contributors = (
+
1966 db_project.tasks_mapped + db_project.tasks_validated
+
+
1968 summary.organisation_logo = (
+
1969 db_project.organisation.logo
if db_project.organisation
else None
+
+
+
+
+
+
+
+
1977 async
def convert_to_project_summaries(
+
1978 db_projects: List[db_models.DbProject],
+
1979 ) -> List[project_schemas.ProjectSummary]:
+
+
1981 if db_projects
and len(db_projects) > 0:
+
+
1983 async
def convert_summary(project):
+
1984 return await convert_to_project_summary(project)
+
+
1986 project_summaries = await gather(
+
1987 *[convert_summary(project)
for project
in db_projects]
+
+
1989 return [summary
for summary
in project_summaries
if summary
is not None]
+
+
+
+
+
1994 async
def convert_to_project_feature(db_project_feature: db_models.DbFeatures):
+
+
1996 if db_project_feature:
+
1997 app_project_feature: project_schemas.Feature = db_project_feature
+
+
1999 if db_project_feature.geometry:
+
2000 app_project_feature.geometry = geometry_to_geojson(
+
2001 db_project_feature.geometry,
+
2002 db_project_feature.properties,
+
2003 db_project_feature.id,
+
+
+
2006 return app_project_feature
+
+
+
+
+
2011 async
def convert_to_project_features(
+
2012 db_project_features: List[db_models.DbFeatures],
+
2013 ) -> List[project_schemas.Feature]:
+
+
2015 if db_project_features
and len(db_project_features) > 0:
+
+
2017 async
def convert_feature(project_feature):
+
2018 return await convert_to_project_feature(project_feature)
+
+
2020 app_project_features = await gather(
+
2021 *[convert_feature(feature)
for feature
in db_project_features]
+
+
2023 return [feature
for feature
in app_project_features
if feature
is not None]
+
+
+
+
+
2028 async
def get_project_features(db: Session, project_id: int, task_id: int =
None):
+
+
+
2031 db.query(db_models.DbFeatures)
+
2032 .filter(db_models.DbFeatures.project_id == project_id)
+
2033 .filter(db_models.DbFeatures.task_id == task_id)
+
+
+
+
+
2038 db.query(db_models.DbFeatures)
+
2039 .filter(db_models.DbFeatures.project_id == project_id)
+
+
+
2042 return await convert_to_project_features(features)
+
+
+
2045 async
def get_extract_completion_count(project_id: int, db: Session):
+
+
2047 db.query(db_models.DbProject)
+
2048 .filter(db_models.DbProject.id == project_id)
+
+
+
2051 return project.extract_completed_count
+
+
+
2054 async
def get_background_task_status(task_id: uuid.UUID, db: Session):
+
2055 """Get the status of a background task."""
+
+
2057 db.query(db_models.BackgroundTasks)
+
2058 .filter(db_models.BackgroundTasks.id == str(task_id))
+
+
+
+
2062 log.warning(f
"No background task with found with UUID: {task_id}")
+
2063 raise HTTPException(status_code=404, detail=
"Task not found")
+
2064 return task.status, task.message
+
+
+
2067 async
def insert_background_task_into_database(
+
2068 db: Session, name: str =
None, project_id=
None
+
+
2070 """Inserts a new task into the database
+
+
2072 db: database session
+
2073 name: name of the task.
+
2074 project_id: associated project id
+
+
+
2077 task_id(uuid.uuid4): The background task uuid for tracking.
+
+
2079 task_id = uuid.uuid4()
+
+
2081 task = db_models.BackgroundTasks(
+
2082 id=str(task_id), name=name, status=1, project_id=project_id
+
+
+
+
+
+
+
+
+
+
2092 async
def update_background_task_status_in_database(
+
2093 db: Session, task_id: uuid.UUID, status: int, message: str =
None
+
+
2095 """Updates the status of a task in the database
+
+
2097 db: database session
+
2098 task_id: uuid of the task
+
2099 status: status of the task.
+
+
2101 db.query(db_models.BackgroundTasks).filter(
+
2102 db_models.BackgroundTasks.id == str(task_id)
+
+
+
2105 db_models.BackgroundTasks.status: status,
+
2106 db_models.BackgroundTasks.message: message,
+
+
+
+
+
+
+
+
+
2115 def add_custom_extract_to_db(
+
+
+
2118 background_task_id: uuid.UUID,
+
+
+
2121 """Insert geojson features into db for a project.
+
+
+
2124 db: database session
+
2125 project_id: id of the project
+
2126 features: features to be added.
+
+
+
+
+
2131 project_id = uuid.uuid4()
+
2132 if feature_type ==
"buildings":
+
2133 for feature
in features[
"features"]:
+
+
2135 feature_geometry = feature[
"geometry"]
+
2136 feature_shape = shape(feature_geometry)
+
+
2138 wkb_element = from_shape(feature_shape, srid=4326)
+
2139 building_obj = db_models.DbBuildings(
+
2140 project_id=project_id,
+
+
2142 tags=feature[
"properties"],
+
+
2144 db.add(building_obj)
+
+
+
+
+
+
+
+
2152 update_bg_task_sync = async_to_sync(
+
2153 update_background_task_status_in_database
+
+
2155 update_bg_task_sync(db, background_task_id, 4)
+
+
2157 elif feature_type ==
"lines":
+
2158 for feature
in features[
"features"]:
+
+
2160 feature_geometry = feature[
"geometry"]
+
2161 feature_shape = shape(feature_geometry)
+
2162 feature[
"properties"][
"highway"] =
"yes"
+
+
2164 wkb_element = from_shape(feature_shape, srid=4326)
+
2165 db_feature = db_models.DbOsmLines(
+
2166 project_id=project_id,
+
+
2168 tags=feature[
"properties"],
+
+
+
+
+
+
+
+
+
+
+
2179 update_bg_task_sync = async_to_sync(
+
2180 update_background_task_status_in_database
+
+
2182 update_bg_task_sync(db, background_task_id, 4)
+
+
+
2185 except Exception
as e:
+
+
+
2188 update_bg_task_sync = async_to_sync(update_background_task_status_in_database)
+
2189 update_bg_task_sync(db, background_task_id, 2, str(e))
+
+
+
2192 async
def update_project_form(
+
2193 db: Session, project_id: int, form_type: str, form: UploadFile = File(
None)
+
+
2195 project = await get_project(db, project_id)
+
2196 category = project.xform_title
+
2197 project_title = project.project_name_prefix
+
2198 odk_id = project.odkid
+
+
+
2201 odk_credentials = project_schemas.ODKCentral(
+
2202 odk_central_url=project.odk_central_url,
+
2203 odk_central_user=project.odk_central_user,
+
2204 odk_central_password=project.odk_central_password,
+
+
+
+
2208 xlsform = f
"/tmp/custom_form.{form_type}"
+
2209 contents = await form.read()
+
2210 with open(xlsform,
"wb")
as f:
+
+
+
2213 xlsform = f
"{xlsforms_path}/{category}.xls"
+
+
2215 db.query(db_models.DbFeatures).filter(
+
2216 db_models.DbFeatures.project_id == project_id
+
+
+
+
+
2221 pg = PostgresClient(
"underpass")
+
+
2223 f
"/tmp/{project_title}_{category}.geojson"
+
+
+
2226 extract_polygon =
True if project.data_extract_type ==
"polygon" else False
+
+
2228 project = table(
"projects", column(
"outline"))
+
+
+
+
2232 geoalchemy2.functions.ST_AsGeoJSON(project.c.outline).label(
"outline"),
+
2233 ).where(text(f
"id={project_id}"))
+
2234 result = db.execute(sql)
+
2235 project_outline = result.first()
+
+
2237 final_outline = json.loads(project_outline.outline)
+
+
2239 outline_geojson = pg.getFeatures(
+
2240 boundary=final_outline,
+
+
2242 polygon=extract_polygon,
+
2243 xlsfile=f
"{category}.xls",
+
+
+
+
2247 updated_outline_geojson = {
"type":
"FeatureCollection",
"features": []}
+
+
+
2250 feature_mappings = []
+
+
2252 for feature
in outline_geojson[
"features"]:
+
+
2254 feature[
"properties"][
"title"] =
""
+
+
2256 feature_shape = shape(feature[
"geometry"])
+
+
+
+
+
+
2262 wkb_element = from_shape(feature_shape, srid=4326)
+
+
2264 "project_id": project_id,
+
2265 "category_title": category,
+
2266 "geometry": wkb_element,
+
2267 "properties": feature[
"properties"],
+
+
2269 updated_outline_geojson[
"features"].append(feature)
+
2270 feature_mappings.append(feature_mapping)
+
+
+
2273 db_feature = db_models.DbFeatures(
+
2274 project_id=project_id,
+
2275 category_title=category,
+
2276 geometry=wkb_element,
+
2277 properties=feature[
"properties"],
+
+
+
+
+
2282 tasks_list = await tasks_crud.get_task_lists(db, project_id)
+
+
2284 for task
in tasks_list:
+
2285 task_obj = await tasks_crud.get_task(db, task)
+
+
+
+
+
+
+
+
+
+
+
+
2297 WHERE project_id={project_id} and ST_Intersects(geometry, '{task_obj.outline}'::Geometry)
+
+
+
+
+
2302 result = db.execute(query)
+
+
+
+
2306 f
"""SELECT jsonb_build_object(
+
2307 'type', 'FeatureCollection',
+
2308 'features', jsonb_agg(feature)
+
+
+
2311 SELECT jsonb_build_object(
+
+
+
2314 'geometry', ST_AsGeoJSON(geometry)::jsonb,
+
2315 'properties', properties
+
+
+
2318 WHERE project_id={project_id} and task_id={task}
+
+
+
+
2322 result = db.execute(query)
+
2323 features = result.fetchone()[0]
+
+
2325 xform = f
"/tmp/{project_title}_{category}_{task}.xml"
+
2326 extracts = f
"/tmp/{project_title}_{category}_{task}.geojson"
+
+
+
2329 with open(extracts,
"w")
as jsonfile:
+
2330 jsonfile.truncate(0)
+
2331 dump(features, jsonfile)
+
+
2333 outfile = central_crud.generate_updated_xform(xlsform, xform, form_type)
+
+
+
2336 result = central_crud.create_odk_xform(
+
2337 odk_id, task, xform, odk_credentials,
True,
True,
False
+
+
+
+
+
+
2343 async
def update_odk_credentials_in_db(
+
2344 project_instance: project_schemas.ProjectUpload,
+
2345 odk_central_cred: project_schemas.ODKCentral,
+
+
+
+
2349 project_instance.odkid = odkid
+
2350 project_instance.odk_central_url = odk_central_cred.odk_central_url
+
2351 project_instance.odk_central_user = odk_central_cred.odk_central_user
+
2352 project_instance.odk_central_password = odk_central_cred.odk_central_password
+
+
+
2355 db.refresh(project_instance)
+
+
+
2358 async
def get_extracted_data_from_db(db: Session, project_id: int, outfile: str):
+
2359 """Get the geojson of those features for this project."""
+
+
2361 f
"""SELECT jsonb_build_object(
+
2362 'type', 'FeatureCollection',
+
2363 'features', jsonb_agg(feature)
+
+
+
2366 SELECT jsonb_build_object(
+
+
+
2369 'geometry', ST_AsGeoJSON(geometry)::jsonb,
+
2370 'properties', properties
+
+
+
2373 WHERE project_id={project_id}
+
+
+
+
2377 result = db.execute(query)
+
2378 features = result.fetchone()[0]
+
+
+
2381 with open(outfile,
"w")
as jsonfile:
+
2382 jsonfile.truncate(0)
+
2383 dump(features, jsonfile)
+
+
+
+
2387 def get_project_tiles(
+
+
+
2390 background_task_id: uuid.UUID,
+
+
2392 output_format: str =
"mbtiles",
+
+
+
2395 """Get the tiles for a project.
+
+
+
2398 project_id (int): ID of project to create tiles for.
+
2399 background_task_id (uuid.UUID): UUID of background task to track.
+
2400 source (str): Tile source ("esri", "bing", "topo", "google", "oam").
+
2401 output_format (str, optional): Default "mbtiles".
+
2402 Other options: "pmtiles", "sqlite3".
+
2403 tms (str, optional): Default None. Custom TMS provider URL.
+
+
+
2406 tiles_path_id = uuid.uuid4()
+
2407 tiles_dir = f
"{TILESDIR}/{tiles_path_id}"
+
2408 outfile = f
"{tiles_dir}/{project_id}_{source}tiles.{output_format}"
+
+
2410 tile_path_instance = db_models.DbTilesPath(
+
2411 project_id=project_id,
+
2412 background_task_id=str(background_task_id),
+
+
+
+
+
+
+
2419 db.add(tile_path_instance)
+
+
+
+
2423 log.debug(f
"Getting bbox for project: {project_id}")
+
+
2425 f
"""SELECT ST_XMin(ST_Envelope(outline)) AS min_lon,
+
2426 ST_YMin(ST_Envelope(outline)) AS min_lat,
+
2427 ST_XMax(ST_Envelope(outline)) AS max_lon,
+
2428 ST_YMax(ST_Envelope(outline)) AS max_lat
+
+
2430 WHERE id = {project_id};"""
+
+
+
2433 result = db.execute(query)
+
2434 project_bbox = result.fetchone()
+
2435 log.debug(f
"Extracted project bbox: {project_bbox}")
+
+
+
2438 min_lon, min_lat, max_lon, max_lat = project_bbox
+
+
2440 log.error(f
"Failed to get bbox from project: {project_id}")
+
+
+
2443 "Creating basemap with params: "
+
2444 f
"boundary={min_lon},{min_lat},{max_lon},{max_lat} | "
+
2445 f
"outfile={outfile} | "
+
+
2447 f
"outdir={tiles_dir} | "
+
2448 f
"source={source} | "
+
+
+
+
2452 create_basemap_file(
+
2453 boundary=f
"{min_lon},{min_lat},{max_lon},{max_lat}",
+
+
+
+
+
+
+
+
2461 log.info(f
"Basemap created for project ID {project_id}: {outfile}")
+
+
2463 tile_path_instance.status = 4
+
+
+
+
2467 update_bg_task_sync = async_to_sync(update_background_task_status_in_database)
+
2468 update_bg_task_sync(db, background_task_id, 4)
+
+
2470 log.info(f
"Tiles generation process completed for project id {project_id}")
+
+
2472 except Exception
as e:
+
+
2474 log.error(f
"Tiles generation process failed for project id {project_id}")
+
+
2476 tile_path_instance.status = 2
+
+
+
+
2480 update_bg_task_sync = async_to_sync(update_background_task_status_in_database)
+
2481 update_bg_task_sync(db, background_task_id, 2, str(e))
+
+
+
2484 async
def get_mbtiles_list(db: Session, project_id: int):
+
+
+
+
2488 db_models.DbTilesPath.id,
+
2489 db_models.DbTilesPath.project_id,
+
2490 db_models.DbTilesPath.status,
+
2491 db_models.DbTilesPath.tile_source,
+
+
2493 .filter(db_models.DbTilesPath.project_id == str(project_id))
+
+
+
+
2497 processed_tiles_list = [
+
+
+
2500 "project_id": x.project_id,
+
2501 "status": x.status.name,
+
2502 "tile_source": x.tile_source,
+
+
+
+
+
2507 return processed_tiles_list
+
+
2509 except Exception
as e:
+
+
2511 raise HTTPException(status_code=400, detail=str(e))
+
+
+
2514 async
def convert_geojson_to_osm(geojson_file: str):
+
2515 """Convert a GeoJSON file to OSM format."""
+
2516 return json2osm(geojson_file)
+
+
+
2519 async
def get_address_from_lat_lon(latitude, longitude):
+
2520 """Get address using Nominatim, using lat,lon."""
+
2521 base_url =
"https://nominatim.openstreetmap.org/reverse"
+
+
+
+
+
+
+
+
2529 headers = {
"Accept-Language":
"en"}
+
+
2531 response = requests.get(base_url, params=params, headers=headers)
+
2532 data = response.json()
+
2533 address = data[
"address"][
"country"]
+
+
2535 if response.status_code == 200:
+
2536 if "city" in data[
"address"]:
+
2537 city = data[
"address"][
"city"]
+
2538 address = f
"{city}" +
"," + address
+
+
+
2541 return "Address not found."
+
+
+
2544 async
def update_project_location_info(
+
2545 db_project: sqlalchemy.orm.declarative_base, project_boundary: str
+
+
2547 """Update project boundary, centroid, address.
+
+
+
2550 db_project(sqlalchemy.orm.declarative_base): The project database record.
+
2551 project_boundary(str): WKT string geometry.
+
+
2553 db_project.outline = project_boundary
+
2554 centroid = (wkt.loads(project_boundary)).centroid.wkt
+
2555 db_project.centroid = centroid
+
2556 geometry = wkt.loads(centroid)
+
2557 longitude, latitude = geometry.x, geometry.y
+
2558 address = await get_address_from_lat_lon(latitude, longitude)
+
2559 db_project.location_str = address
if address
is not None else ""
+
+
+
2562 def convert_geojson_to_epsg4326(input_geojson):
+
2563 source_crs = pyproj.CRS(
+
2564 input_geojson.get(
"crs", {}).get(
"properties", {}).get(
"name",
"EPSG:4326")
+
+
2566 transformer = pyproj.Transformer.from_crs(source_crs,
"EPSG:4326", always_xy=
True)
+
+
+
2569 transformed_features = []
+
2570 for feature
in input_geojson.get(
"features", []):
+
2571 geom = shape(feature.get(
"geometry", {}))
+
2572 transformed_geom = transform(transformer.transform, geom)
+
2573 transformed_feature = {
+
+
2575 "geometry": transformed_geom.__geo_interface__,
+
2576 "properties": feature.get(
"properties", {}),
+
+
2578 transformed_features.append(transformed_feature)
+
+
+
2581 output_geojson = {
"type":
"FeatureCollection",
"features": transformed_features}
+
+
2583 return output_geojson
+
+
+
2586 def check_crs(input_geojson: dict):
+
2587 log.debug(
"validating coordinate reference system")
+
+
2589 def is_valid_crs(crs_name):
+
+
2591 "urn:ogc:def:crs:OGC:1.3:CRS84",
+
2592 "urn:ogc:def:crs:EPSG::4326",
+
+
+
2595 return crs_name
in valid_crs_list
+
+
2597 def is_valid_coordinate(coord):
+
2598 return -180 <= coord[0] <= 180
and -90 <= coord[1] <= 90
+
+
2600 error_message =
"ERROR: Unsupported coordinate system, it is recommended to use a GeoJSON file in WGS84(EPSG 4326) standard."
+
2601 if "crs" in input_geojson:
+
2602 crs = input_geojson[
"crs"][
"properties"][
"name"]
+
2603 if not is_valid_crs(crs):
+
2604 log.error(error_message)
+
2605 raise HTTPException(status_code=400, detail=error_message)
+
+
+
2608 if input_geojson[
"type"] ==
"FeatureCollection":
+
2609 coordinates = input_geojson[
"features"][0][
"geometry"][
"coordinates"]
+
2610 elif input_geojson[
"type"] ==
"Feature":
+
2611 coordinates = input_geojson[
"geometry"][
"coordinates"]
+
+
2613 input_geojson[
"features"][0][
"geometry"][
"type"]
+
2614 if input_geojson[
"type"] ==
"FeatureCollection"
+
2615 else input_geojson[
"geometry"][
"type"]
+
+
+
2618 if geometry_type ==
"MultiPolygon":
+
2619 first_coordinate = coordinates[0][0][
+
+
+
+
2623 first_coordinate = coordinates[0][0]
+
+
2625 if not is_valid_coordinate(first_coordinate):
+
2626 log.error(error_message)
+
2627 raise HTTPException(status_code=400, detail=error_message)
+
+
+
2630 async
def get_tasks_count(db: Session, project_id: int):
+
+
2632 db.query(db_models.DbProject)
+
2633 .filter(db_models.DbProject.id == project_id)
+
+
+
2636 task_count = len(db_task.tasks)
+
+
+
+
2640 async
def get_pagination(page: int, count: int, results_per_page: int, total: int):
+
2641 total_pages = (count + results_per_page - 1) // results_per_page
+
2642 hasNext = (page * results_per_page) < count
+
+
+
2645 pagination = project_schemas.PaginationInfo(
+
+
+
2648 nextNum=page + 1
if hasNext
else None,
+
+
+
2651 prevNum=page - 1
if hasPrev
else None,
+
2652 perPage=results_per_page,
+
+
+
+
+
+
+
+
+
+
+
+
+
First off, We are really glad you're reading this, because we need volunteer developers to help improve the Field Mapping Tasking Manager (FMTM)! 
Thank you¶