+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
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 typing
import List, Optional, Union
+
30 from zipfile
import ZipFile
+
+
+
+
+
+
+
37 import shapely.wkb
as wkblib
+
+
39 from asgiref.sync
import async_to_sync
+
40 from fastapi
import File, HTTPException, UploadFile
+
41 from fastapi.concurrency
import run_in_threadpool
+
42 from fmtm_splitter.splitter
import split_by_sql, split_by_square
+
43 from geoalchemy2.shape
import from_shape, to_shape
+
44 from geojson
import Feature, FeatureCollection
+
45 from loguru
import logger
as log
+
46 from osm_fieldwork.basemapper
import create_basemap_file
+
47 from osm_fieldwork.data_models
import data_models_path
+
48 from osm_fieldwork.filter_data
import FilterData
+
49 from osm_fieldwork.json2osm
import json2osm
+
50 from osm_fieldwork.OdkCentral
import OdkAppUser
+
51 from osm_fieldwork.xlsforms
import xlsforms_path
+
52 from osm_rawdata.postgres
import PostgresClient
+
53 from shapely
import wkt
+
54 from shapely.geometry
import (
+
+
+
+
+
+
+
61 from sqlalchemy
import and_, column, func, inspect, select, table, text
+
62 from sqlalchemy.dialects.postgresql
import insert
+
63 from sqlalchemy.orm
import Session
+
+
+
+
67 from app.db import db_models
+
+
+
+
+
+
+
74 QR_CODES_DIR =
"QR_codes/"
+
75 TASK_GEOJSON_DIR =
"geojson/"
+
76 TILESDIR =
"/opt/tiles"
+
+
+
79 async
def get_projects(
+
+
+
+
+
84 hashtags: List[str] =
None,
+
+
+
87 """Get all projects."""
+
+
+
90 filters.append(db_models.DbProject.author_id == user_id)
+
+
+
93 filters.append(db_models.DbProject.hashtags.op(
"&&")(hashtags))
+
+
+
96 filters.append(db_models.DbProject.project_name_prefix.ilike(f
"%{search}%"))
+
+
+
+
100 db.query(db_models.DbProject)
+
101 .filter(and_(*filters))
+
102 .order_by(db_models.DbProject.id.desc())
+
+
+
+
+
107 project_count = db.query(db_models.DbProject).filter(and_(*filters)).count()
+
+
+
+
111 db.query(db_models.DbProject)
+
112 .order_by(db_models.DbProject.id.desc())
+
+
+
+
+
117 project_count = db.query(db_models.DbProject).count()
+
118 return project_count, await convert_to_app_projects(db_projects)
+
+
+
121 async
def get_project_summaries(
+
+
+
+
+
126 hashtags: str =
None,
+
+
+
129 """Get project summary details for main page."""
+
130 project_count, db_projects = await get_projects(
+
131 db, user_id, skip, limit, hashtags, search
+
+
133 return project_count, await convert_to_project_summaries(db_projects)
+
+
+
136 async
def get_project(db: Session, project_id: int):
+
137 """Get a single project."""
+
+
139 db.query(db_models.DbProject)
+
140 .filter(db_models.DbProject.id == project_id)
+
+
+
+
+
+
146 async
def get_project_by_id(db: Session, project_id: int):
+
147 """Get a single project by id."""
+
+
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):
+
158 """Get the project info only by id."""
+
+
160 db.query(db_models.DbProjectInfo)
+
161 .filter(db_models.DbProjectInfo.project_id == project_id)
+
162 .order_by(db_models.DbProjectInfo.project_id)
+
+
+
165 return await convert_to_app_project_info(db_project_info)
+
+
+
168 async
def delete_project_by_id(db: Session, project_id: int):
+
169 """Delete a project by id."""
+
+
+
172 db.query(db_models.DbProject)
+
173 .filter(db_models.DbProject.id == project_id)
+
174 .order_by(db_models.DbProject.id)
+
+
+
+
178 db.delete(db_project)
+
+
180 except Exception
as e:
+
+
182 raise HTTPException(e)
from e
+
183 return f
"Project {project_id} deleted"
+
+
+
186 async
def partial_update_project_info(
+
187 db: Session, project_metadata: project_schemas.ProjectUpdate, project_id
+
+
189 """Partial project update for PATCH."""
+
+
191 db_project = await get_project_by_id(db, project_id)
+
+
+
+
+
196 status_code=428, detail=f
"Project with id {project_id} does not exist"
+
+
+
+
200 db_project_info = await get_project_info_by_id(db, project_id)
+
+
+
203 if project_metadata.name:
+
204 db_project.project_name_prefix = project_metadata.name
+
205 db_project_info.name = project_metadata.name
+
206 if project_metadata.description:
+
207 db_project_info.description = project_metadata.description
+
208 if project_metadata.short_description:
+
209 db_project_info.short_description = project_metadata.short_description
+
+
+
212 db.refresh(db_project)
+
+
214 return await convert_to_app_project(db_project)
+
+
+
217 async
def update_project_info(
+
218 db: Session, project_metadata: project_schemas.ProjectUpload, project_id
+
+
220 """Full project update for PUT."""
+
221 user = project_metadata.author
+
222 project_info = project_metadata.project_info
+
+
+
+
226 raise HTTPException(
"No user passed in")
+
+
228 raise HTTPException(
"No project info passed in")
+
+
+
231 db_user = await user_crud.get_user(db, user.id)
+
+
+
234 status_code=400, detail=f
"User {user.username} does not exist"
+
+
+
+
238 db_project = await get_project_by_id(db, project_id)
+
+
+
241 status_code=428, detail=f
"Project with id {project_id} does not exist"
+
+
+
+
245 project_info = project_metadata.project_info
+
+
+
248 db_project.author = db_user
+
249 db_project.project_name_prefix = project_info.name
+
+
+
252 db_project_info = await get_project_info_by_id(db, project_id)
+
+
+
255 db_project_info.name = project_info.name
+
256 db_project_info.short_description = project_info.short_description
+
257 db_project_info.description = project_info.description
+
+
+
260 db.refresh(db_project)
+
+
262 return await convert_to_app_project(db_project)
+
+
+
265 async
def create_project_with_project_info(
+
266 db: Session, project_metadata: project_schemas.ProjectUpload, odk_project_id: int
+
+
268 """Create a new project, including all associated info."""
+
269 project_user = project_metadata.author
+
270 project_info = project_metadata.project_info
+
271 xform_title = project_metadata.xform_title
+
272 odk_credentials = project_metadata.odk_central
+
273 hashtags = project_metadata.hashtags
+
274 organisation_id = project_metadata.organisation_id
+
275 task_split_type = project_metadata.task_split_type
+
276 task_split_dimension = project_metadata.task_split_dimension
+
277 task_num_buildings = project_metadata.task_num_buildings
+
+
+
+
281 raise HTTPException(
"User details are missing")
+
+
283 raise HTTPException(
"Project info is missing")
+
284 if not odk_project_id:
+
285 raise HTTPException(
"ODK Central project id is missing")
+
+
+
288 "Creating project in FMTM database with vars: "
+
289 f
"project_user: {project_user} | "
+
290 f
"project_info: {project_info} | "
+
291 f
"xform_title: {xform_title} | "
+
292 f
"hashtags: {hashtags}| "
+
293 f
"organisation_id: {organisation_id}"
+
+
+
+
+
298 url = odk_credentials.odk_central_url
+
299 user = odk_credentials.odk_central_user
+
300 pw = odk_credentials.odk_central_password
+
+
+
303 log.debug(
"ODKCentral connection variables not set in function")
+
304 log.debug(
"Attempting extraction from environment variables")
+
305 url = settings.ODK_CENTRAL_URL
+
306 user = settings.ODK_CENTRAL_USER
+
307 pw = settings.ODK_CENTRAL_PASSWD
+
+
+
+
+
312 db_user = await user_crud.get_user(db, project_user.id)
+
+
+
315 status_code=400, detail=f
"User {project_user.username} does not exist"
+
+
+
+
+
+
321 lambda hashtag: hashtag
if hashtag.startswith(
"#")
else f
"#{hashtag}",
+
+
+
+
+
+
+
+
329 db_project = db_models.DbProject(
+
+
331 odkid=odk_project_id,
+
332 project_name_prefix=project_info.name,
+
333 xform_title=xform_title,
+
+
335 odk_central_user=user,
+
336 odk_central_password=pw,
+
+
338 organisation_id=organisation_id,
+
339 task_split_type=task_split_type,
+
340 task_split_dimension=task_split_dimension,
+
341 task_num_buildings=task_num_buildings,
+
+
+
+
+
+
+
348 db_project_info = db_models.DbProjectInfo(
+
+
350 name=project_info.name,
+
351 short_description=project_info.short_description,
+
352 description=project_info.description,
+
+
354 db.add(db_project_info)
+
+
+
357 db.refresh(db_project)
+
+
359 return await convert_to_app_project(db_project)
+
+
+
362 async
def upload_xlsform(
+
+
+
+
+
+
368 """Upload a custom XLSForm from the user."""
+
+
+
+
+
+
+
+
+
+
378 ins = insert(forms).values(title=name, xls=xlsform, category=category)
+
379 sql = ins.on_conflict_do_update(
+
380 constraint=
"xlsforms_title_key",
+
381 set_=dict(title=name, xls=xlsform, category=category),
+
+
+
+
+
386 except Exception
as e:
+
+
388 raise HTTPException(status=400, detail={
"message": str(e)})
from e
+
+
+
391 async
def update_multi_polygon_project_boundary(
+
+
+
+
+
396 """Update the boundary for a project & update tasks.
+
+
398 TODO requires refactoring, as it has too large of
+
399 a scope. It should update a project boundary only, then manage
+
400 tasks in another function.
+
+
402 This function receives the project_id and boundary as a parameter
+
403 and creates a task for each polygon in the database.
+
404 This function also creates a project outline from the multiple
+
+
+
+
408 if isinstance(boundary, str):
+
409 boundary = json.loads(boundary)
+
+
+
412 db_project = await get_project_by_id(db, project_id)
+
+
414 log.error(f
"Project {project_id} doesn't exist!")
+
+
+
+
418 if boundary[
"type"] ==
"Feature":
+
419 polygons = [boundary]
+
+
421 polygons = boundary[
"features"]
+
422 log.debug(f
"Processing {len(polygons)} task geometries")
+
423 for polygon
in polygons:
+
+
425 if polygon[
"geometry"][
"type"] ==
"MultiPolygon":
+
426 log.debug(
"Converting MultiPolygon to Polygon")
+
427 polygon[
"geometry"][
"type"] =
"Polygon"
+
428 polygon[
"geometry"][
"coordinates"] = polygon[
"geometry"][
"coordinates"][
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
443 db_task = db_models.DbTask(
+
444 project_id=project_id,
+
445 outline=wkblib.dumps(shape(polygon[
"geometry"]), hex=
True),
+
446 project_task_index=1,
+
+
+
+
+
+
452 db_task.project_task_name = str(db_task.id)
+
+
454 "Created database task | "
+
455 f
"Project ID {project_id} | "
+
456 f
"Task ID {db_task.project_task_name}"
+
+
+
+
+
+
462 f
"""SELECT ST_AsText(ST_ConvexHull(ST_Collect(outline)))
+
+
464 WHERE project_id={project_id};"""
+
+
+
467 log.debug(
"Generating project outline from tasks")
+
468 result = db.execute(query)
+
469 data = result.fetchone()
+
+
471 await update_project_location_info(db_project, data[0])
+
+
+
474 db.refresh(db_project)
+
475 log.debug(
"COMPLETE: creating project boundary, based on task boundaries")
+
+
+
478 except Exception
as e:
+
+
480 raise HTTPException(e)
from e
+
+
+
483 async
def preview_split_by_square(boundary: str, meters: int):
+
484 """Preview split by square for a project boundary.
+
+
486 Use a lambda function to remove the "z" dimension from each
+
487 coordinate in the feature's geometry.
+
+
+
490 def remove_z_dimension(coord):
+
491 """Remove z dimension from geojson."""
+
492 return coord.pop()
if len(coord) == 3
else None
+
+
494 """ Check if the boundary is a Feature or a FeatureCollection """
+
495 if boundary[
"type"] ==
"Feature":
+
496 features = [boundary]
+
497 elif boundary[
"type"] ==
"FeatureCollection":
+
498 features = boundary[
"features"]
+
499 elif boundary[
"type"] ==
"Polygon":
+
+
+
+
+
504 "geometry": boundary,
+
+
+
+
+
509 status_code=400, detail=f
"Invalid GeoJSON type: {boundary['type']}"
+
+
+
+
+
+
515 for feature
in features:
+
516 list(map(remove_z_dimension, feature[
"geometry"][
"coordinates"][0]))
+
517 if feature[
"geometry"][
"type"] ==
"MultiPolygon":
+
518 multi_polygons.append(Polygon(feature[
"geometry"][
"coordinates"][0][0]))
+
+
+
+
522 boundary = multi_polygons[0]
+
523 for geom
in multi_polygons[1:]:
+
524 boundary = boundary.union(geom)
+
+
526 return await run_in_threadpool(
+
527 lambda: split_by_square(
+
+
+
+
+
+
+
534 async
def get_osm_extracts(boundary: str) -> dict:
+
535 """Request an extract from raw-data-api and extract the file contents.
+
+
537 - The query is posted to raw-data-api and job initiated for fetching the extract.
+
538 - The status of the job is polled every few seconds, until 'SUCCESS' is returned.
+
539 - The resulting zip file is downloaded, extracted, and data returned.
+
+
+
+
+
+
+
+
+
+
+
+
551 "join_or": {
"building": [],
"highway": [],
"waterway": []}
+
+
+
+
+
+
+
558 aoi = geojson.loads(boundary)
+
+
+
561 if isinstance(aoi, FeatureCollection):
+
562 aoi = aoi.get(
"features")[0]
+
563 if isinstance(aoi, Feature):
+
564 aoi = aoi.get(
"geometry")
+
565 query[
"geometry"] = aoi
+
+
+
568 query[
"fileName"] =
"extract"
+
+
570 query[
"outputType"] =
"geojson"
+
571 extract_filename = f
'{query["fileName"]}.{query["outputType"]}'
+
572 log.debug(f
"Setting data extract file name to: {extract_filename}")
+
+
574 log.debug(f
"Query for raw data api: {query}")
+
575 base_url = settings.UNDERPASS_API_URL
+
576 query_url = f
"{base_url}/snapshot/"
+
577 headers = {
"accept":
"application/json",
"Content-Type":
"application/json"}
+
+
+
+
581 result = requests.post(query_url, data=json.dumps(query), headers=headers)
+
582 result.raise_for_status()
+
583 except requests.exceptions.HTTPError:
+
584 error_dict = result.json()
+
585 error_dict[
"status_code"] = result.status_code
+
586 log.error(f
"Failed to get extract from raw data api: {error_dict}")
+
+
+
589 task_id = result.json()[
"task_id"]
+
+
+
592 task_url = f
"{base_url}/tasks/status/{task_id}"
+
+
594 result = requests.get(task_url, headers=headers)
+
595 if result.json()[
"status"] ==
"PENDING":
+
+
+
598 elif result.json()[
"status"] ==
"SUCCESS":
+
+
+
+
+
+
604 zip_url = result.json()[
"result"][
"download_url"]
+
605 result = requests.get(zip_url, headers=headers)
+
+
607 fp = BytesIO(result.content)
+
608 zfp = zipfile.ZipFile(fp,
"r")
+
609 zfp.extract(extract_filename,
"/tmp/")
+
610 data = geojson.loads(zfp.read(extract_filename))
+
+
+
+
614 async
def split_geojson_into_tasks(
+
+
616 project_geojson: Union[dict, FeatureCollection],
+
617 no_of_buildings: int,
+
618 custom_data_extract: Optional[str] =
None,
+
+
620 """Splits a project into tasks.
+
+
+
623 db (Session): A database session.
+
624 project_geojson (str): A GeoJSON string representing the boundary of
+
625 the project to split into tasks.
+
626 no_of_buildings (int): The number of buildings to include in each task.
+
627 custom_data_extract (str, optional): A GeoJSON string containing a
+
+
+
+
631 Any: A GeoJSON object containing the tasks for the specified project.
+
+
+
+
635 aoi_id = uuid.uuid4()
+
+
637 if custom_data_extract:
+
+
639 extract_geojson = await {}
+
+
+
642 extract_geojson = await get_osm_extracts(json.dumps(project_geojson))
+
643 if status_code := extract_geojson.get(
"status_code",
None):
+
+
645 status_code=status_code,
+
646 detail=(f
"Failed to get data extract for reason: {extract_geojson}"),
+
+
+
649 log.debug(f
"STARTED task splitting with id: {aoi_id}")
+
650 features = await run_in_threadpool(
+
651 lambda: split_by_sql(
+
+
+
654 num_buildings=no_of_buildings,
+
655 osm_extract=extract_geojson,
+
+
+
658 log.debug(f
"COMPLETE task splitting with id: {aoi_id}")
+
+
+
+
662 async
def update_project_boundary(
+
663 db: Session, project_id: int, boundary: str, meters: int
+
+
665 """Update the boundary for a project and update tasks."""
+
+
667 db_project = await get_project_by_id(db, project_id)
+
+
669 log.error(f
"Project {project_id} doesn't exist!")
+
+
+
+
+
674 def remove_z_dimension(coord):
+
675 """Remove the z dimension from a geojson."""
+
676 return coord.pop()
if len(coord) == 3
else None
+
+
678 """ Check if the boundary is a Feature or a FeatureCollection """
+
679 if boundary[
"type"] ==
"Feature":
+
680 features = [boundary]
+
681 elif boundary[
"type"] ==
"FeatureCollection":
+
682 features = boundary[
"features"]
+
683 elif boundary[
"type"] ==
"Polygon":
+
+
+
+
+
688 "geometry": boundary,
+
+
+
+
+
+
694 status_code=400, detail=f
"Invalid GeoJSON type: {boundary['type']}"
+
+
+
697 """ Apply the lambda function to each coordinate in its geometry """
+
+
699 for feature
in features:
+
700 list(map(remove_z_dimension, feature[
"geometry"][
"coordinates"][0]))
+
701 if feature[
"geometry"][
"type"] ==
"MultiPolygon":
+
702 multi_polygons.append(Polygon(feature[
"geometry"][
"coordinates"][0][0]))
+
+
704 """Update the boundary polygon on the database."""
+
+
706 outline = multi_polygons[0]
+
707 for geom
in multi_polygons[1:]:
+
708 outline = outline.union(geom)
+
+
710 outline = shape(features[0][
"geometry"])
+
+
712 await update_project_location_info(db_project, outline.wkt)
+
+
+
715 db.refresh(db_project)
+
716 log.debug(
"Finished updating project boundary")
+
+
718 log.debug(
"Splitting tasks")
+
719 tasks = split_by_square(
+
+
+
+
723 for poly
in tasks[
"features"]:
+
+
725 task_id = str(poly.get(
"properties", {}).get(
"id")
or poly.get(
"id"))
+
726 db_task = db_models.DbTask(
+
727 project_id=project_id,
+
728 project_task_name=task_id,
+
729 outline=wkblib.dumps(shape(poly[
"geometry"]), hex=
True),
+
+
+
+
733 project_task_index=1,
+
+
+
+
+
+
+
+
+
+
+
744 async
def update_project_with_zip(
+
+
+
747 project_name_prefix: str,
+
748 task_type_prefix: str,
+
749 uploaded_zip: UploadFile,
+
+
751 """Update a project from a zip file.
+
+
753 TODO ensure that logged in user is user who created this project,
+
754 return 403 (forbidden) if not authorized.
+
+
+
757 if uploaded_zip.content_type
not in [
+
+
759 "application/zip-compressed",
+
760 "application/x-zip-compressed",
+
+
+
+
764 detail=f
"File must be a zip. Uploaded file was {uploaded_zip.content_type}",
+
+
+
767 with ZipFile(io.BytesIO(uploaded_zip.file.read()),
"r")
as zip:
+
+
769 bad_file = zip.testzip()
+
+
+
772 status_code=400, detail=f
"Zip contained a bad file: {bad_file}"
+
+
+
+
776 listed_files = zip.namelist()
+
+
778 if QR_CODES_DIR
not in listed_files:
+
+
+
781 detail=f
"Zip must contain directory named {QR_CODES_DIR}",
+
+
+
784 if TASK_GEOJSON_DIR
not in listed_files:
+
+
+
787 detail=f
"Zip must contain directory named {TASK_GEOJSON_DIR}",
+
+
+
790 outline_filename = f
"{project_name_prefix}.geojson"
+
791 if outline_filename
not in listed_files:
+
+
+
+
795 f
"Zip must contain file named '{outline_filename}' "
+
796 "that contains a FeatureCollection outlining the project"
+
+
+
+
800 task_outlines_filename = f
"{project_name_prefix}_polygons.geojson"
+
801 if task_outlines_filename
not in listed_files:
+
+
+
+
805 f
"Zip must contain file named '{task_outlines_filename}' "
+
806 "that contains a FeatureCollection where each Feature "
+
+
+
+
+
+
812 db_project = await get_project_by_id(db, project_id)
+
+
+
815 status_code=428, detail=f
"Project with id {project_id} does not exist"
+
+
+
+
819 db_project.project_name_prefix = project_name_prefix
+
820 db_project.task_type_prefix = task_type_prefix
+
+
+
823 outline_shape = await get_outline_from_geojson_file_in_zip(
+
824 zip, outline_filename, f
"Could not generate Shape from {outline_filename}"
+
+
826 await update_project_location_info(db_project, outline_shape.wkt)
+
+
+
829 project_tasks_feature_collection = await get_json_from_zip(
+
+
831 task_outlines_filename,
+
832 f
"Could not generate FeatureCollection from {task_outlines_filename}",
+
+
+
+
+
+
838 db_project.total_tasks = len(project_tasks_feature_collection[
"features"])
+
839 for feature
in project_tasks_feature_collection[
"features"]:
+
840 task_name = feature[
"properties"][
"task"]
+
+
+
+
844 f
"{project_name_prefix}_{task_type_prefix}__{task_name}.png"
+
+
846 db_qr = await get_dbqrcode_from_file(
+
+
848 QR_CODES_DIR + qr_filename,
+
+
850 f
"QRCode for task {task_name} does not exist. "
+
851 f
"File should be in {qr_filename}"
+
+
+
+
+
+
857 task_outline_shape = await get_shape_from_json_str(
+
+
859 f
"Could not create task outline for {task_name} using {feature}",
+
+
+
+
863 task_geojson_filename = (
+
864 f
"{project_name_prefix}_{task_type_prefix}__{task_name}.geojson"
+
+
866 task_geojson = await get_json_from_zip(
+
+
868 TASK_GEOJSON_DIR + task_geojson_filename,
+
869 f
"Geojson for task {task_name} does not exist",
+
+
+
+
+
+
875 task = db_models.DbTask(
+
876 project_id=project_id,
+
877 project_task_index=feature[
"properties"][
"fid"],
+
878 project_task_name=task_name,
+
+
+
881 outline=task_outline_shape.wkt,
+
+
883 initial_feature_count=len(task_geojson[
"features"]),
+
+
+
+
+
888 task_count = task_count + 1
+
889 db_project.last_updated = timestamp()
+
+
+
+
893 db.refresh(db_project)
+
+
+
+
+
+
899 except HTTPException
as e:
+
+
+
+
+
904 except Exception
as e:
+
+
+
+
908 f
"{task_count} tasks were created before the "
+
909 f
"following error was thrown: {e}, on feature: {feature}"
+
+
+
+
+
+
+
+
+
+
919 async
def read_xlsforms(
+
+
+
+
923 """Read the list of XLSForms from the disk."""
+
+
925 package_name =
"osm_fieldwork"
+
926 for xls
in os.listdir(directory):
+
927 if xls.endswith(
".xls")
or xls.endswith(
".xlsx"):
+
928 file_name = xls.split(
".")[0]
+
929 yaml_file_name = f
"data_models/{file_name}.yaml"
+
930 if pkg_resources.resource_exists(package_name, yaml_file_name):
+
+
+
+
+
935 inspect(db_models.DbXForm)
+
+
937 "xlsforms", column(
"title"), column(
"xls"), column(
"xml"), column(
"id")
+
+
+
+
+
942 for xlsform
in xlsforms:
+
943 infile = f
"{directory}/{xlsform}"
+
944 if os.path.getsize(infile) <= 0:
+
945 log.warning(f
"{infile} is empty!")
+
+
947 xls = open(infile,
"rb")
+
948 name = xlsform.split(
".")[0]
+
+
+
+
952 ins = insert(forms).values(title=name, xls=data)
+
953 sql = ins.on_conflict_do_update(
+
954 constraint=
"xlsforms_title_key", set_=dict(title=name, xls=data)
+
+
+
+
+
+
+
+
962 async
def get_odk_id_for_project(db: Session, project_id: int):
+
963 """Get the odk project id for the fmtm project id."""
+
+
+
+
+
+
969 where = f
"id={project_id}"
+
970 sql = select(project).where(text(where))
+
+
972 result = db.execute(sql)
+
+
+
975 if result.rowcount != 1:
+
976 log.warning(str(sql))
+
+
978 project_info = result.first()
+
979 return project_info.odkid
+
+
+
982 async
def upload_custom_data_extracts(
+
+
+
+
986 category: str =
"buildings",
+
+
988 """Uploads custom data extracts to the database.
+
+
+
991 db (Session): The database session object.
+
992 project_id (int): The ID of the project.
+
993 contents (str): The custom data extracts contents.
+
994 category (str, optional): The category assigned to the custom data extract.
+
995 Defaults to 'buildings'.
+
+
+
998 bool: True if the upload is successful.
+
+
1000 project = await get_project(db, project_id)
+
1001 log.debug(f
"Uploading custom data extract for project: {project}")
+
+
+
1004 raise HTTPException(status_code=404, detail=
"Project not found")
+
+
1006 project_geojson = db.query(func.ST_AsGeoJSON(project.outline)).scalar()
+
1007 log.debug(f
"Generated project geojson: {project_geojson}")
+
1008 json.loads(project_geojson)
+
+
1010 features_data = json.loads(contents)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
1024 for feature
in features_data[
"features"]:
+
1025 feature_shape = shape(feature[
"geometry"])
+
1026 if isinstance(feature_shape, MultiPolygon):
+
1027 wkb_element = from_shape(
+
1028 Polygon(feature[
"geometry"][
"coordinates"][0][0]), srid=4326
+
+
1030 elif isinstance(feature_shape, MultiLineString):
+
1031 wkb_element = from_shape(
+
1032 LineString(feature[
"geometry"][
"coordinates"][0]), srid=4326
+
+
+
1035 wkb_element = from_shape(feature_shape, srid=4326)
+
+
+
+
1039 feature[
"properties"][
"title"] =
""
+
1040 properties = flatten_dict(feature[
"properties"])
+
+
1042 db_feature = db_models.DbFeatures(
+
1043 project_id=project_id,
+
1044 geometry=wkb_element,
+
1045 properties=properties,
+
1046 category_title=category,
+
+
+
+
+
+
+
+
1054 def flatten_dict(d, parent_key="", sep="_"):
+
1055 """Recursively flattens a nested dictionary into a single-level dictionary.
+
+
+
1058 d (dict): The input dictionary.
+
1059 parent_key (str): The parent key (used for recursion).
+
1060 sep (str): The separator character to use in flattened keys.
+
+
+
1063 dict: The flattened dictionary.
+
+
+
1066 for k, v
in d.items():
+
1067 new_key = f
"{parent_key}{sep}{k}" if parent_key
else k
+
1068 if isinstance(v, dict):
+
1069 items.update(flatten_dict(v, new_key, sep=sep))
+
+
+
+
+
+
+
1076 def generate_task_files(
+
+
+
+
+
+
1082 odk_credentials: project_schemas.ODKCentral,
+
+
1084 """Generate all files for a task."""
+
1085 project_log = log.bind(task=
"create_project", project_id=project_id)
+
+
1087 project_log.info(f
"Generating files for task {task_id}")
+
+
1089 get_project_sync = async_to_sync(get_project)
+
1090 project = get_project_sync(db, project_id)
+
+
1092 odk_id = project.odkid
+
1093 project_name = project.project_name_prefix
+
1094 category = project.xform_title
+
1095 name = f
"{project_name}_{category}_{task_id}"
+
+
+
1098 project_log.info(f
"Creating odkcentral app user for task {task_id}")
+
1099 appuser = central_crud.create_appuser(odk_id, name, odk_credentials)
+
+
+
+
1103 project_log.error(
"Couldn't create appuser for project")
+
+
+
+
1107 project_log.info(f
"Creating qr code for task {task_id}")
+
1108 create_qr_sync = async_to_sync(create_qrcode)
+
1109 qr_code = create_qr_sync(
+
+
+
1112 appuser.json()[
"token"],
+
+
1114 odk_credentials.odk_central_url,
+
+
+
1117 get_task_sync = async_to_sync(tasks_crud.get_task)
+
1118 task = get_task_sync(db, task_id)
+
1119 task.qr_code_id = qr_code[
"qr_code_id"]
+
+
+
+
+
1124 xform = f
"/tmp/{name}.xml"
+
1125 extracts = f
"/tmp/{name}.geojson"
+
+
+
1128 xform_id = f
"{name}".split(
"_")[2]
+
+
+
+
+
+
+
1135 SET task_id={task_id}
+
+
+
+
1139 WHERE project_id={project_id}
+
1140 AND ST_IsValid(geometry)
+
1141 AND ST_IsValid('{task.outline}'::Geometry)
+
1142 AND ST_Contains('{task.outline}'::Geometry, ST_Centroid(geometry))
+
+
+
+
1146 result = db.execute(query)
+
+
+
+
1150 f
"""SELECT jsonb_build_object(
+
1151 'type', 'FeatureCollection',
+
1152 'features', jsonb_agg(feature)
+
+
+
1155 SELECT jsonb_build_object(
+
+
+
1158 'geometry', ST_AsGeoJSON(geometry)::jsonb,
+
1159 'properties', properties
+
+
+
1162 WHERE project_id={project_id} and task_id={task_id}
+
+
+
+
1166 result = db.execute(query)
+
+
1168 features = result.fetchone()[0]
+
+
1170 upload_media =
False if features[
"features"]
is None else True
+
+
+
+
1174 with open(extracts,
"w")
as jsonfile:
+
1175 jsonfile.truncate(0)
+
1176 geojson.dump(features, jsonfile)
+
+
+
1179 f
"Generating xform for task: {task_id} "
+
1180 f
"using xform: {xform} | form_type: {form_type}"
+
+
1182 outfile = central_crud.generate_updated_xform(xlsform, xform, form_type)
+
+
+
1185 project_log.info(f
"Uploading media in {task_id}")
+
1186 result = central_crud.create_odk_xform(
+
1187 odk_id, task_id, outfile, odk_credentials,
False, upload_media
+
+
+
+
1191 project_log.info(f
"Updating role for app user in task {task_id}")
+
+
+
+
+
1196 url = odk_credentials.odk_central_url
+
1197 user = odk_credentials.odk_central_user
+
1198 pw = odk_credentials.odk_central_password
+
+
+
1201 log.debug(
"ODKCentral connection variables not set in function")
+
1202 log.debug(
"Attempting extraction from environment variables")
+
1203 url = settings.ODK_CENTRAL_URL
+
1204 user = settings.ODK_CENTRAL_USER
+
1205 pw = settings.ODK_CENTRAL_PASSWD
+
+
1207 odk_app = OdkAppUser(url, user, pw)
+
+
+
1210 projectId=odk_id, xform=xform_id, actorId=appuser.json()[
"id"]
+
+
1212 except Exception
as e:
+
+
+
1215 project.extract_completed_count += 1
+
+
+
+
+
+
+
+
1223 def generate_appuser_files(
+
+
+
1226 extract_polygon: bool,
+
1227 custom_xls_form: str,
+
1228 extracts_contents: str,
+
+
+
1231 background_task_id: Optional[uuid.UUID] =
None,
+
+
1233 """Generate the files for a project.
+
+
1235 QR code, new XForm, and the OSM data extract.
+
+
+
1238 - db: the database session
+
1239 - project_id: Project ID
+
1240 - extract_polygon: boolean to determine if we should extract the polygon
+
1241 - custom_xls_form: the xls file to upload if we have a custom form
+
1242 - category: the category of the project
+
1243 - form_type: weather the form is xls, xlsx or xml
+
1244 - background_task_id: the task_id of the background task running this function.
+
+
+
1247 project_log = log.bind(task=
"create_project", project_id=project_id)
+
+
1249 project_log.info(f
"Starting generate_appuser_files for project {project_id}")
+
+
+
+
+
1254 column(
"project_name_prefix"),
+
1255 column(
"xform_title"),
+
+
1257 column(
"odk_central_url"),
+
1258 column(
"odk_central_user"),
+
1259 column(
"odk_central_password"),
+
+
+
+
1263 where = f
"id={project_id}"
+
+
1265 project.c.project_name_prefix,
+
1266 project.c.xform_title,
+
+
1268 project.c.odk_central_url,
+
1269 project.c.odk_central_user,
+
1270 project.c.odk_central_password,
+
1271 geoalchemy2.functions.ST_AsGeoJSON(project.c.outline).label(
"outline"),
+
1272 ).where(text(where))
+
1273 result = db.execute(sql)
+
+
+
1276 if result.rowcount != 1:
+
1277 log.warning(str(sql))
+
1278 if result.rowcount < 1:
+
1279 raise HTTPException(status_code=400, detail=
"Project not found")
+
+
1281 raise HTTPException(status_code=400, detail=
"Multiple projects found")
+
+
1283 one = result.first()
+
+
+
+
+
1288 "odk_central_url": one.odk_central_url,
+
1289 "odk_central_user": one.odk_central_user,
+
1290 "odk_central_password": one.odk_central_password,
+
+
+
1293 odk_credentials = project_schemas.ODKCentral(**odk_credentials)
+
+
1295 xform_title = one.xform_title
if one.xform_title
else None
+
+
1297 category = xform_title
+
+
1299 xlsform = f
"/tmp/{category}.{form_type}"
+
1300 contents = custom_xls_form
+
1301 with open(xlsform,
"wb")
as f:
+
+
+
1304 xlsform = f
"{xlsforms_path}/{xform_title}.xls"
+
+
+
1307 if extracts_contents
is not None:
+
1308 project_log.info(
"Uploading data extracts")
+
1309 upload_extract_sync = async_to_sync(upload_custom_data_extracts)
+
1310 upload_extract_sync(db, project_id, extracts_contents)
+
+
+
+
1314 db.query(db_models.DbProject)
+
1315 .filter(db_models.DbProject.id == project_id)
+
+
+
1318 config_file_contents = project.form_config_file
+
+
1320 project_log.info(
"Extracting Data from OSM")
+
+
1322 config_path =
"/tmp/config.yaml"
+
1323 if config_file_contents:
+
1324 with open(config_path,
"w", encoding=
"utf-8")
as config_file_handle:
+
1325 config_file_handle.write(config_file_contents.decode(
"utf-8"))
+
+
1327 config_path = f
"{data_models_path}/{category}.yaml"
+
+
+
1330 pg = PostgresClient(
"underpass", config_path)
+
1331 outline = json.loads(one.outline)
+
1332 boundary = {
"type":
"Feature",
"properties": {},
"geometry": outline}
+
1333 data_extract = pg.execQuery(boundary)
+
1334 filter = FilterData(xlsform)
+
+
1336 updated_data_extract = {
"type":
"FeatureCollection",
"features": []}
+
1337 filtered_data_extract = (
+
1338 filter.cleanData(data_extract)
+
+
1340 else updated_data_extract
+
+
+
+
1344 feature_mappings = []
+
+
1346 for feature
in filtered_data_extract[
"features"]:
+
+
+
1349 feature[
"properties"][
"title"] =
""
+
+
1351 feature_shape = shape(feature[
"geometry"])
+
+
+
+
1355 if extract_polygon
and (
+
1356 not shape(outline).contains(shape(feature_shape.centroid))
+
+
+
+
1360 wkb_element = from_shape(feature_shape, srid=4326)
+
+
1362 "project_id": project_id,
+
1363 "category_title": category,
+
1364 "geometry": wkb_element,
+
1365 "properties": feature[
"properties"],
+
+
1367 updated_data_extract[
"features"].append(feature)
+
1368 feature_mappings.append(feature_mapping)
+
+
1370 db.bulk_insert_mappings(db_models.DbFeatures, feature_mappings)
+
+
+
+
1374 get_task_id_list_sync = async_to_sync(tasks_crud.get_task_id_list)
+
1375 task_list = get_task_id_list_sync(db, project_id)
+
+
+
1378 def wrap_generate_task_files(task):
+
1379 """Func to wrap and return errors from thread.
+
+
1381 Also passes it's own database session for thread safety.
+
1382 If we pass a single db session to multiple threads,
+
1383 there may be inconsistencies or errors.
+
+
+
1386 generate_task_files(
+
+
+
+
+
+
+
+
1394 except Exception
as e:
+
1395 log.exception(str(e))
+
+
+
1398 with ThreadPoolExecutor()
as executor:
+
+
+
1401 executor.submit(wrap_generate_task_files, task)
+
1402 for task
in task_list
+
+
+
+
+
1407 if background_task_id:
+
+
1409 update_bg_task_sync = async_to_sync(
+
1410 update_background_task_status_in_database
+
+
1412 update_bg_task_sync(db, background_task_id, 4)
+
+
1414 except Exception
as e:
+
+
+
1417 if background_task_id:
+
+
1419 update_bg_task_sync = async_to_sync(
+
1420 update_background_task_status_in_database
+
+
1422 update_bg_task_sync(db, background_task_id, 2, str(e))
+
+
+
+
+
+
1428 async
def create_qrcode(
+
+
+
+
+
1433 odk_central_url: str =
None,
+
+
1435 """Create a QR code for a task."""
+
+
1437 log.debug(f
"Generating base64 encoded QR settings for token: {token}")
+
1438 qrcode_data = await central_crud.create_qrcode(
+
1439 odk_id, token, project_name, odk_central_url
+
+
+
1442 log.debug(
"Generating QR code from base64 settings")
+
1443 qrcode = segno.make(qrcode_data, micro=
False)
+
+
1445 log.debug(
"Saving to buffer and decoding")
+
1446 buffer = io.BytesIO()
+
1447 qrcode.save(buffer, kind=
"png", scale=5)
+
1448 qrcode_binary = buffer.getvalue()
+
+
1450 log.debug(f
"Writing QR code to database for token {token}")
+
1451 qrdb = db_models.DbQrCode(image=qrcode_binary)
+
+
+
1454 codes = table(
"qr_code", column(
"id"))
+
1455 sql = select(sqlalchemy.func.count(codes.c.id))
+
1456 result = db.execute(sql)
+
1457 rows = result.fetchone()[0]
+
1458 return {
"data": qrcode,
"id": rows + 1,
"qr_code_id": qrdb.id}
+
+
+
1461 async
def get_project_geometry(db: Session, project_id: int):
+
1462 """Retrieves the geometry of a project.
+
+
+
1465 db (Session): The database session.
+
1466 project_id (int): The ID of the project.
+
+
+
1469 str: A geojson of the project outline.
+
+
1471 projects = table(
"projects", column(
"outline"), column(
"id"))
+
1472 where = f
"projects.id={project_id}"
+
1473 sql = select(geoalchemy2.functions.ST_AsGeoJSON(projects.c.outline)).where(
+
+
+
1476 result = db.execute(sql)
+
+
1478 if result.rowcount != 1:
+
1479 log.warning(str(sql))
+
+
1481 row = eval(result.first()[0])
+
1482 return json.dumps(row)
+
+
+
1485 async
def get_task_geometry(db: Session, project_id: int):
+
1486 """Retrieves the geometry of tasks associated with a project.
+
+
+
1489 db (Session): The database session.
+
1490 project_id (int): The ID of the project.
+
+
+
1493 str: A geojson of the task boundaries
+
+
1495 db_tasks = await tasks_crud.get_tasks(db, project_id,
None)
+
+
1497 for task
in db_tasks:
+
1498 geom = to_shape(task.outline)
+
+
1500 geometry = geom.__geo_interface__
+
+
+
+
1504 feature = {
"type":
"Feature",
"geometry": geometry,
"properties": properties}
+
1505 features.append(feature)
+
+
1507 feature_collection = {
"type":
"FeatureCollection",
"features": features}
+
1508 return json.dumps(feature_collection)
+
+
+
1511 async
def get_project_features_geojson(db: Session, project_id: int):
+
1512 """Get a geojson of all features for a task."""
+
+
1514 db.query(db_models.DbFeatures)
+
1515 .filter(db_models.DbFeatures.project_id == project_id)
+
+
+
+
+
1520 f
"""SELECT jsonb_build_object(
+
1521 'type', 'FeatureCollection',
+
1522 'features', jsonb_agg(feature)
+
+
+
1525 SELECT jsonb_build_object(
+
+
+
1528 'geometry', ST_AsGeoJSON(geometry)::jsonb,
+
1529 'properties', properties
+
+
+
1532 WHERE project_id={project_id}
+
+
+
+
+
1537 result = db.execute(query)
+
1538 features = result.fetchone()[0]
+
+
+
1541 task_feature_mapping = {feat.id: feat.task_id
for feat
in db_features}
+
+
1543 for feature
in features[
"features"]:
+
1544 if (feat_id := feature[
"id"])
in task_feature_mapping:
+
1545 feature[
"properties"][
"task_id"] = task_feature_mapping[feat_id]
+
+
+
+
+
1550 async
def get_json_from_zip(zip, filename: str, error_detail: str):
+
1551 """Extract json file from zip."""
+
+
1553 with zip.open(filename)
as file:
+
+
1555 return json.loads(data)
+
1556 except Exception
as e:
+
+
1558 raise HTTPException(
+
1559 status_code=400, detail=f
"{error_detail} ----- Error: {e}"
+
+
+
+
1563 async
def get_outline_from_geojson_file_in_zip(
+
1564 zip, filename: str, error_detail: str, feature_index: int = 0
+
+
1566 """Parse geojson outline within a zip."""
+
+
1568 with zip.open(filename)
as file:
+
+
1570 json_dump = json.loads(data)
+
1571 check_crs(json_dump)
+
1572 feature_collection = geojson.FeatureCollection(json_dump)
+
1573 feature = feature_collection[
"features"][feature_index]
+
1574 geom = feature[
"geometry"]
+
1575 shape_from_geom = shape(geom)
+
1576 return shape_from_geom
+
1577 except Exception
as e:
+
+
1579 raise HTTPException(
+
+
1581 detail=f
"{error_detail} ----- Error: {e} ----",
+
+
+
+
1585 async
def get_shape_from_json_str(feature: str, error_detail: str):
+
1586 """Parse geojson outline within a zip to shapely geom."""
+
+
1588 geom = feature[
"geometry"]
+
+
1590 except Exception
as e:
+
+
1592 raise HTTPException(
+
+
1594 detail=f
"{error_detail} ----- Error: {e} ---- Json: {feature}",
+
+
+
+
1598 async
def get_dbqrcode_from_file(zip, qr_filename: str, error_detail: str):
+
1599 """Get qr code from database during import."""
+
+
1601 with zip.open(qr_filename)
as qr_file:
+
1602 binary_qrcode = qr_file.read()
+
+
1604 return db_models.DbQrCode(
+
1605 filename=qr_filename,
+
1606 image=binary_qrcode,
+
+
+
1609 raise HTTPException(
+
1610 status_code=400, detail=f
"{qr_filename} is an empty file"
+
+
1612 except Exception
as e:
+
+
1614 raise HTTPException(
+
1615 status_code=400, detail=f
"{error_detail} ----- Error: {e}"
+
+
+
+
+
+
+
+
+
+
+
1626 async
def convert_to_app_project(db_project: db_models.DbProject):
+
1627 """Legacy function to convert db models --> Pydantic.
+
+
1629 TODO refactor to use Pydantic model methods instead.
+
+
+
1632 log.debug(
"convert_to_app_project called, but no project provided")
+
+
+
1635 log.debug(
"Converting db project to app project")
+
1636 app_project: project_schemas.Project = db_project
+
+
1638 if db_project.outline:
+
1639 log.debug(
"Converting project outline to geojson")
+
1640 app_project.outline_geojson = geometry_to_geojson(
+
1641 db_project.outline, {
"id": db_project.id}, db_project.id
+
+
+
1644 app_project.project_tasks = db_project.tasks
+
+
+
+
+
1649 async
def convert_to_app_project_info(db_project_info: db_models.DbProjectInfo):
+
1650 """Legacy function to convert db models --> Pydantic.
+
+
1652 TODO refactor to use Pydantic model methods instead.
+
+
+
1655 app_project_info: project_schemas.ProjectInfo = db_project_info
+
1656 return app_project_info
+
+
+
+
+
1661 async
def convert_to_app_projects(
+
1662 db_projects: List[db_models.DbProject],
+
1663 ) -> List[project_schemas.ProjectOut]:
+
1664 """Legacy function to convert db models --> Pydantic.
+
+
1666 TODO refactor to use Pydantic model methods instead.
+
+
1668 if db_projects
and len(db_projects) > 0:
+
+
1670 async
def convert_project(project):
+
1671 return await convert_to_app_project(project)
+
+
1673 app_projects = await gather(
+
1674 *[convert_project(project)
for project
in db_projects]
+
+
1676 return [project
for project
in app_projects
if project
is not None]
+
+
+
+
+
1681 async
def convert_to_project_summary(db_project: db_models.DbProject):
+
1682 """Legacy function to convert db models --> Pydantic.
+
+
1684 TODO refactor to use Pydantic model methods instead.
+
+
+
1687 summary: project_schemas.ProjectSummary = db_project
+
+
1689 if db_project.project_info:
+
1690 summary.location_str = db_project.location_str
+
1691 summary.title = db_project.project_info.name
+
1692 summary.description = db_project.project_info.short_description
+
+
1694 summary.num_contributors = (
+
1695 db_project.tasks_mapped + db_project.tasks_validated
+
+
1697 summary.organisation_logo = (
+
1698 db_project.organisation.logo
if db_project.organisation
else None
+
+
+
+
+
+
+
+
1706 async
def convert_to_project_summaries(
+
1707 db_projects: List[db_models.DbProject],
+
1708 ) -> List[project_schemas.ProjectSummary]:
+
1709 """Legacy function to convert db models --> Pydantic.
+
+
1711 TODO refactor to use Pydantic model methods instead.
+
+
1713 if db_projects
and len(db_projects) > 0:
+
+
1715 async
def convert_summary(project):
+
1716 return await convert_to_project_summary(project)
+
+
1718 project_summaries = await gather(
+
1719 *[convert_summary(project)
for project
in db_projects]
+
+
1721 return [summary
for summary
in project_summaries
if summary
is not None]
+
+
+
+
+
1726 async
def convert_to_project_feature(db_project_feature: db_models.DbFeatures):
+
1727 """Legacy function to convert db models --> Pydantic.
+
+
1729 TODO refactor to use Pydantic model methods instead.
+
+
1731 if db_project_feature:
+
1732 app_project_feature: project_schemas.Feature = db_project_feature
+
+
1734 if db_project_feature.geometry:
+
1735 app_project_feature.geometry = geometry_to_geojson(
+
1736 db_project_feature.geometry,
+
1737 db_project_feature.properties,
+
1738 db_project_feature.id,
+
+
+
1741 return app_project_feature
+
+
+
+
+
1746 async
def convert_to_project_features(
+
1747 db_project_features: List[db_models.DbFeatures],
+
1748 ) -> List[project_schemas.Feature]:
+
1749 """Legacy function to convert db models --> Pydantic.
+
+
1751 TODO refactor to use Pydantic model methods instead.
+
+
1753 if db_project_features
and len(db_project_features) > 0:
+
+
1755 async
def convert_feature(project_feature):
+
1756 return await convert_to_project_feature(project_feature)
+
+
1758 app_project_features = await gather(
+
1759 *[convert_feature(feature)
for feature
in db_project_features]
+
+
1761 return [feature
for feature
in app_project_features
if feature
is not None]
+
+
+
+
+
1766 async
def get_project_features(db: Session, project_id: int, task_id: int =
None):
+
1767 """Get features from database for a project."""
+
+
+
1770 db.query(db_models.DbFeatures)
+
1771 .filter(db_models.DbFeatures.project_id == project_id)
+
1772 .filter(db_models.DbFeatures.task_id == task_id)
+
+
+
+
+
1777 db.query(db_models.DbFeatures)
+
1778 .filter(db_models.DbFeatures.project_id == project_id)
+
+
+
1781 return await convert_to_project_features(features)
+
+
+
1784 async
def get_background_task_status(task_id: uuid.UUID, db: Session):
+
1785 """Get the status of a background task."""
+
+
1787 db.query(db_models.BackgroundTasks)
+
1788 .filter(db_models.BackgroundTasks.id == str(task_id))
+
+
+
+
1792 log.warning(f
"No background task with found with UUID: {task_id}")
+
1793 raise HTTPException(status_code=404, detail=
"Task not found")
+
1794 return task.status, task.message
+
+
+
1797 async
def insert_background_task_into_database(
+
1798 db: Session, name: str =
None, project_id: str =
None
+
+
1800 """Inserts a new task into the database.
+
+
+
1803 db (Session): database session
+
1804 name (str): name of the task.
+
1805 project_id (str): associated project id
+
+
+
1808 task_id (uuid.uuid4): The background task uuid for tracking.
+
+
1810 task_id = uuid.uuid4()
+
+
1812 task = db_models.BackgroundTasks(
+
1813 id=str(task_id), name=name, status=1, project_id=project_id
+
+
+
+
+
+
+
+
+
+
1823 async
def update_background_task_status_in_database(
+
1824 db: Session, task_id: uuid.UUID, status: int, message: str =
None
+
+
1826 """Updates the status of a task in the database.
+
+
+
1829 db (Session): database session.
+
1830 task_id (uuid.UUID): uuid of the task.
+
1831 status (int): status of the task.
+
1832 message (str): optional message to add to the db task.
+
+
+
+
+
1837 db.query(db_models.BackgroundTasks).filter(
+
1838 db_models.BackgroundTasks.id == str(task_id)
+
+
+
1841 db_models.BackgroundTasks.status: status,
+
1842 db_models.BackgroundTasks.message: message,
+
+
+
+
+
+
+
+
+
+
1852 def add_custom_extract_to_db(
+
+
+
1855 background_task_id: uuid.UUID,
+
+
+
1858 """Insert geojson features into db for a project.
+
+
+
1861 db: database session.
+
1862 features: features to be added.
+
1863 background_task_id (uuid.UUID): Task ID for database.
+
1864 feature_type (str): feature type category in OSM.
+
+
+
+
+
1869 project_id = uuid.uuid4()
+
1870 if feature_type ==
"buildings":
+
1871 for feature
in features[
"features"]:
+
+
1873 feature_geometry = feature[
"geometry"]
+
1874 feature_shape = shape(feature_geometry)
+
+
1876 wkb_element = from_shape(feature_shape, srid=4326)
+
1877 building_obj = db_models.DbBuildings(
+
1878 project_id=project_id,
+
+
1880 tags=feature[
"properties"],
+
+
1882 db.add(building_obj)
+
+
+
+
+
+
+
+
1890 update_bg_task_sync = async_to_sync(
+
1891 update_background_task_status_in_database
+
+
1893 update_bg_task_sync(db, background_task_id, 4)
+
+
1895 elif feature_type ==
"lines":
+
1896 for feature
in features[
"features"]:
+
+
1898 feature_geometry = feature[
"geometry"]
+
1899 feature_shape = shape(feature_geometry)
+
1900 feature[
"properties"][
"highway"] =
"yes"
+
+
1902 wkb_element = from_shape(feature_shape, srid=4326)
+
1903 db_feature = db_models.DbOsmLines(
+
1904 project_id=project_id,
+
+
1906 tags=feature[
"properties"],
+
+
+
+
+
+
+
+
+
+
+
1917 update_bg_task_sync = async_to_sync(
+
1918 update_background_task_status_in_database
+
+
1920 update_bg_task_sync(db, background_task_id, 4)
+
+
+
1923 except Exception
as e:
+
+
+
1926 update_bg_task_sync = async_to_sync(update_background_task_status_in_database)
+
1927 update_bg_task_sync(db, background_task_id, 2, str(e))
+
+
+
1930 async
def update_project_form(
+
1931 db: Session, project_id: int, form_type: str, form: UploadFile = File(
None)
+
+
1933 """Upload a new custom XLSForm for a project."""
+
1934 project = await get_project(db, project_id)
+
1935 category = project.xform_title
+
1936 project_title = project.project_name_prefix
+
1937 odk_id = project.odkid
+
+
+
1940 odk_credentials = project_schemas.ODKCentral(
+
1941 odk_central_url=project.odk_central_url,
+
1942 odk_central_user=project.odk_central_user,
+
1943 odk_central_password=project.odk_central_password,
+
+
+
+
1947 xlsform = f
"/tmp/custom_form.{form_type}"
+
1948 contents = await form.read()
+
1949 with open(xlsform,
"wb")
as f:
+
+
+
1952 xlsform = f
"{xlsforms_path}/{category}.xls"
+
+
1954 db.query(db_models.DbFeatures).filter(
+
1955 db_models.DbFeatures.project_id == project_id
+
+
+
+
+
1960 pg = PostgresClient(
"underpass")
+
+
1962 f
"/tmp/{project_title}_{category}.geojson"
+
+
+
1965 extract_polygon =
True if project.data_extract_type ==
"polygon" else False
+
+
1967 project = table(
"projects", column(
"outline"))
+
+
+
+
1971 geoalchemy2.functions.ST_AsGeoJSON(project.c.outline).label(
"outline"),
+
1972 ).where(text(f
"id={project_id}"))
+
1973 result = db.execute(sql)
+
1974 project_outline = result.first()
+
+
1976 final_outline = json.loads(project_outline.outline)
+
+
1978 outline_geojson = pg.getFeatures(
+
1979 boundary=final_outline,
+
+
1981 polygon=extract_polygon,
+
1982 xlsfile=f
"{category}.xls",
+
+
+
+
1986 updated_outline_geojson = {
"type":
"FeatureCollection",
"features": []}
+
+
+
1989 feature_mappings = []
+
+
1991 for feature
in outline_geojson[
"features"]:
+
+
+
1994 feature[
"properties"][
"title"] =
""
+
+
1996 feature_shape = shape(feature[
"geometry"])
+
+
+
+
+
+
+
+
+
+
+
2007 wkb_element = from_shape(feature_shape, srid=4326)
+
+
2009 "project_id": project_id,
+
2010 "category_title": category,
+
2011 "geometry": wkb_element,
+
2012 "properties": feature[
"properties"],
+
+
2014 updated_outline_geojson[
"features"].append(feature)
+
2015 feature_mappings.append(feature_mapping)
+
+
+
2018 db_feature = db_models.DbFeatures(
+
2019 project_id=project_id,
+
2020 category_title=category,
+
2021 geometry=wkb_element,
+
2022 properties=feature[
"properties"],
+
+
+
+
+
2027 tasks_list = await tasks_crud.get_task_id_list(db, project_id)
+
+
2029 for task
in tasks_list:
+
2030 task_obj = await tasks_crud.get_task(db, task)
+
+
+
+
+
+
+
+
+
+
+
2041 WHERE project_id={project_id} and
+
2042 ST_Intersects(geometry, '{task_obj.outline}'::Geometry)
+
+
+
+
2046 result = db.execute(query)
+
+
+
+
2050 f
"""SELECT jsonb_build_object(
+
2051 'type', 'FeatureCollection',
+
2052 'features', jsonb_agg(feature)
+
+
+
2055 SELECT jsonb_build_object(
+
+
+
2058 'geometry', ST_AsGeoJSON(geometry)::jsonb,
+
2059 'properties', properties
+
+
+
2062 WHERE project_id={project_id} and task_id={task}
+
+
+
+
2066 result = db.execute(query)
+
2067 features = result.fetchone()[0]
+
+
2069 xform = f
"/tmp/{project_title}_{category}_{task}.xml"
+
+
2071 extracts = f
"/tmp/{project_title}_{category}_{task}.geojson"
+
+
+
+
2075 with open(extracts,
"w")
as jsonfile:
+
2076 jsonfile.truncate(0)
+
2077 geojson.dump(features, jsonfile)
+
+
2079 outfile = central_crud.generate_updated_xform(xlsform, xform, form_type)
+
+
+
2082 result = central_crud.create_odk_xform(
+
2083 odk_id, task, xform, odk_credentials,
True,
True,
False
+
+
+
+
+
+
2089 async
def update_odk_credentials_in_db(
+
2090 project_instance: project_schemas.ProjectUpload,
+
2091 odk_central_cred: project_schemas.ODKCentral,
+
+
+
+
2095 """Update odk credentials for a project."""
+
2096 project_instance.odkid = odkid
+
2097 project_instance.odk_central_url = odk_central_cred.odk_central_url
+
2098 project_instance.odk_central_user = odk_central_cred.odk_central_user
+
2099 project_instance.odk_central_password = odk_central_cred.odk_central_password
+
+
+
2102 db.refresh(project_instance)
+
+
+
2105 async
def get_extracted_data_from_db(db: Session, project_id: int, outfile: str):
+
2106 """Get the geojson of those features for this project."""
+
+
2108 f
"""SELECT jsonb_build_object(
+
2109 'type', 'FeatureCollection',
+
2110 'features', jsonb_agg(feature)
+
+
+
2113 SELECT jsonb_build_object(
+
+
+
2116 'geometry', ST_AsGeoJSON(geometry)::jsonb,
+
2117 'properties', properties
+
+
+
2120 WHERE project_id={project_id}
+
+
+
+
2124 result = db.execute(query)
+
2125 features = result.fetchone()[0]
+
+
+
+
2129 with open(outfile,
"w")
as jsonfile:
+
2130 jsonfile.truncate(0)
+
2131 geojson.dump(features, jsonfile)
+
+
+
+
2135 def get_project_tiles(
+
+
+
2138 background_task_id: uuid.UUID,
+
+
2140 output_format: str =
"mbtiles",
+
+
+
2143 """Get the tiles for a project.
+
+
+
2146 db (Session): SQLAlchemy db session.
+
2147 project_id (int): ID of project to create tiles for.
+
2148 background_task_id (uuid.UUID): UUID of background task to track.
+
2149 source (str): Tile source ("esri", "bing", "topo", "google", "oam").
+
2150 output_format (str, optional): Default "mbtiles".
+
2151 Other options: "pmtiles", "sqlite3".
+
2152 tms (str, optional): Default None. Custom TMS provider URL.
+
+
+
2155 tiles_path_id = uuid.uuid4()
+
2156 tiles_dir = f
"{TILESDIR}/{tiles_path_id}"
+
2157 outfile = f
"{tiles_dir}/{project_id}_{source}tiles.{output_format}"
+
+
2159 tile_path_instance = db_models.DbTilesPath(
+
2160 project_id=project_id,
+
2161 background_task_id=str(background_task_id),
+
+
+
+
+
+
+
2168 db.add(tile_path_instance)
+
+
+
+
2172 log.debug(f
"Getting bbox for project: {project_id}")
+
+
2174 f
"""SELECT ST_XMin(ST_Envelope(outline)) AS min_lon,
+
2175 ST_YMin(ST_Envelope(outline)) AS min_lat,
+
2176 ST_XMax(ST_Envelope(outline)) AS max_lon,
+
2177 ST_YMax(ST_Envelope(outline)) AS max_lat
+
+
2179 WHERE id = {project_id};"""
+
+
+
2182 result = db.execute(query)
+
2183 project_bbox = result.fetchone()
+
2184 log.debug(f
"Extracted project bbox: {project_bbox}")
+
+
+
2187 min_lon, min_lat, max_lon, max_lat = project_bbox
+
+
2189 log.error(f
"Failed to get bbox from project: {project_id}")
+
+
+
2192 "Creating basemap with params: "
+
2193 f
"boundary={min_lon},{min_lat},{max_lon},{max_lat} | "
+
2194 f
"outfile={outfile} | "
+
+
2196 f
"outdir={tiles_dir} | "
+
2197 f
"source={source} | "
+
+
+
+
2201 create_basemap_file(
+
2202 boundary=f
"{min_lon},{min_lat},{max_lon},{max_lat}",
+
+
+
+
+
+
+
+
2210 log.info(f
"Basemap created for project ID {project_id}: {outfile}")
+
+
2212 tile_path_instance.status = 4
+
+
+
+
2216 update_bg_task_sync = async_to_sync(update_background_task_status_in_database)
+
2217 update_bg_task_sync(db, background_task_id, 4)
+
+
2219 log.info(f
"Tiles generation process completed for project id {project_id}")
+
+
2221 except Exception
as e:
+
2222 log.exception(str(e))
+
2223 log.error(f
"Tiles generation process failed for project id {project_id}")
+
+
2225 tile_path_instance.status = 2
+
+
+
+
2229 update_bg_task_sync = async_to_sync(update_background_task_status_in_database)
+
2230 update_bg_task_sync(db, background_task_id, 2, str(e))
+
+
+
2233 async
def get_mbtiles_list(db: Session, project_id: int):
+
2234 """List mbtiles in database for a project."""
+
+
+
+
2238 db_models.DbTilesPath.id,
+
2239 db_models.DbTilesPath.project_id,
+
2240 db_models.DbTilesPath.status,
+
2241 db_models.DbTilesPath.tile_source,
+
+
2243 .filter(db_models.DbTilesPath.project_id == str(project_id))
+
+
+
+
2247 processed_tiles_list = [
+
+
+
2250 "project_id": x.project_id,
+
2251 "status": x.status.name,
+
2252 "tile_source": x.tile_source,
+
+
+
+
+
2257 return processed_tiles_list
+
+
2259 except Exception
as e:
+
+
2261 raise HTTPException(status_code=400, detail=str(e))
from e
+
+
+
2264 async
def convert_geojson_to_osm(geojson_file: str):
+
2265 """Convert a GeoJSON file to OSM format."""
+
2266 return json2osm(geojson_file)
+
+
+
2269 async
def get_address_from_lat_lon(latitude, longitude):
+
2270 """Get address using Nominatim, using lat,lon."""
+
2271 base_url =
"https://nominatim.openstreetmap.org/reverse"
+
+
+
+
+
+
+
+
2279 headers = {
"Accept-Language":
"en"}
+
+
2281 response = requests.get(base_url, params=params, headers=headers)
+
2282 data = response.json()
+
2283 address = data[
"address"][
"country"]
+
+
2285 if response.status_code == 200:
+
2286 if "city" in data[
"address"]:
+
2287 city = data[
"address"][
"city"]
+
2288 address = f
"{city}" +
"," + address
+
+
+
2291 return "Address not found."
+
+
+
2294 async
def update_project_location_info(
+
2295 db_project: sqlalchemy.orm.declarative_base, project_boundary: str
+
+
2297 """Update project boundary, centroid, address.
+
+
+
2300 db_project(sqlalchemy.orm.declarative_base): The project database record.
+
2301 project_boundary(str): WKT string geometry.
+
+
2303 db_project.outline = project_boundary
+
2304 centroid = (wkt.loads(project_boundary)).centroid.wkt
+
2305 db_project.centroid = centroid
+
2306 geometry = wkt.loads(centroid)
+
2307 longitude, latitude = geometry.x, geometry.y
+
2308 address = await get_address_from_lat_lon(latitude, longitude)
+
2309 db_project.location_str = address
if address
is not None else ""
+
+
+
2312 def check_crs(input_geojson: Union[dict, FeatureCollection]):
+
2313 """Validate CRS is valid for a geojson."""
+
2314 log.debug(
"validating coordinate reference system")
+
+
2316 def is_valid_crs(crs_name):
+
+
2318 "urn:ogc:def:crs:OGC:1.3:CRS84",
+
2319 "urn:ogc:def:crs:EPSG::4326",
+
+
+
2322 return crs_name
in valid_crs_list
+
+
2324 def is_valid_coordinate(coord):
+
2325 return -180 <= coord[0] <= 180
and -90 <= coord[1] <= 90
+
+
+
2328 "ERROR: Unsupported coordinate system, it is recommended to use a "
+
2329 "GeoJSON file in WGS84(EPSG 4326) standard."
+
+
2331 if "crs" in input_geojson:
+
2332 crs = input_geojson.get(
"crs", {}).get(
"properties", {}).get(
"name")
+
2333 if not is_valid_crs(crs):
+
2334 log.error(error_message)
+
2335 raise HTTPException(status_code=400, detail=error_message)
+
+
+
2338 if input_geojson[
"type"] ==
"FeatureCollection":
+
2339 coordinates = input_geojson[
"features"][0][
"geometry"][
"coordinates"]
+
2340 elif input_geojson[
"type"] ==
"Feature":
+
2341 coordinates = input_geojson[
"geometry"][
"coordinates"]
+
+
2343 input_geojson[
"features"][0][
"geometry"][
"type"]
+
2344 if input_geojson[
"type"] ==
"FeatureCollection"
+
2345 else input_geojson[
"geometry"][
"type"]
+
+
+
2348 if geometry_type ==
"MultiPolygon":
+
2349 first_coordinate = coordinates[0][0][
+
+
+
+
2353 first_coordinate = coordinates[0][0]
+
+
2355 if not is_valid_coordinate(first_coordinate):
+
2356 log.error(error_message)
+
2357 raise HTTPException(status_code=400, detail=error_message)
+
+
+
2360 async
def get_tasks_count(db: Session, project_id: int):
+
2361 """Get number of tasks for a project."""
+
+
2363 db.query(db_models.DbProject)
+
2364 .filter(db_models.DbProject.id == project_id)
+
+
+
2367 task_count = len(db_task.tasks)
+
+
+
+
2371 async
def get_pagination(page: int, count: int, results_per_page: int, total: int):
+
2372 """Pagination result for splash page."""
+
2373 total_pages = (count + results_per_page - 1) // results_per_page
+
2374 hasNext = (page * results_per_page) < count
+
+
+
2377 pagination = project_schemas.PaginationInfo(
+
+
+
2380 nextNum=page + 1
if hasNext
else None,
+
+
+
2383 prevNum=page - 1
if hasPrev
else None,
+
2384 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¶