view pkg/controllers/surveys.go @ 5574:271888ef85bc surveysperbottleneckid

Finalize use of bottleneck id instead of name. Main feaure is the restructuring of the /surveys endpoint. The endpoint now takes queryparameters as qualifiers. /surveys?id={id} returns surveys to a given bottleck {id} /surveys?name={name} & date={date} returns surveys for given {name} of a bottleneck and {date} for a surveydate. This is needed mainly because there is some backwards incompatibility when reviewing sounding results where the summary of a sr import contains only the name instead of the id of the according bottleneck. To bridge this mismatch the survey endpoint could be queried for the sr to review given the surveydate and the name of the bottleneck. Premise is here, that a date and a bottleneck's name is specific enough to identify the correct survey with the correct bottleneck.
author Thomas Junk <thomas.junk@intevation.de>
date Wed, 21 Jul 2021 14:33:35 +0200
parents 3b842e951317
children 6709530f002e
line wrap: on
line source

// This is Free Software under GNU Affero General Public License v >= 3.0
// without warranty, see README.md and license for details.
//
// SPDX-License-Identifier: AGPL-3.0-or-later
// License-Filename: LICENSES/AGPL-3.0.txt
//
// Copyright (C) 2018, 2019 by via donau
//   – Österreichische Wasserstraßen-Gesellschaft mbH
// Software engineering by Intevation GmbH
//
// Author(s):
//  * Sascha Wilde <sascha.wilde@intevation.de>
//  * Sascha L. Teichmann <sascha.teichmann@intevation.de>
//  * Bernhard Reiter <bernhard.reiter@intevation.de>

package controllers

import (
	"database/sql"
	"net/http"

	"gemma.intevation.de/gemma/pkg/models"

	mw "gemma.intevation.de/gemma/pkg/middleware"
)

const (
	listSurveysByIdSQL = `
SELECT DISTINCT
  s.bottleneck_id,
  s.date_info::text,
  s.depth_reference,
  COALESCE(g.objname, 'ERROR: MISSING GAUGE') AS gauge_objname,
  r.value AS waterlevel_value,
  COALESCE(s.surtyp, 'ERROR: MISSING SURVEY TYPE') AS surtype
FROM waterway.bottlenecks AS b
  JOIN waterway.sounding_results AS s ON b.bottleneck_id = s.bottleneck_id
  LEFT JOIN waterway.gauges AS g
    ON b.gauge_location = g.location AND s.date_info::timestamptz <@ g.validity
  LEFT JOIN waterway.gauges_reference_water_levels AS r
    ON s.depth_reference = r.depth_reference
      AND g.location = r.location AND g.validity = r.validity
WHERE b.bottleneck_id = $1`

	listSurveysByNameDateSQL = `
SELECT DISTINCT
	s.bottleneck_id,
	s.date_info::text,
	s.depth_reference,
	COALESCE(g.objname, 'ERROR: MISSING GAUGE') AS gauge_objname,
	r.value AS waterlevel_value,
	COALESCE(s.surtyp, 'ERROR: MISSING SURVEY TYPE') AS surtype
FROM waterway.bottlenecks AS b
	JOIN waterway.sounding_results AS s ON b.bottleneck_id = s.bottleneck_id
	LEFT JOIN waterway.gauges AS g
	  ON b.gauge_location = g.location AND s.date_info::timestamptz <@ g.validity
	LEFT JOIN waterway.gauges_reference_water_levels AS r
	  ON s.depth_reference = r.depth_reference
		AND g.location = r.location AND g.validity = r.validity
WHERE b.objnam = $1 and s.date_info = $2`
)

func listSurveys(req *http.Request) (jr mw.JSONResult, err error) {

	v := req.URL.Query()
	bottleneckName := v.Get("name")
	date := v.Get("date")
	id := v.Get("id")
	var rows *sql.Rows
	surveys := []*models.Survey{}

	if date == "" && bottleneckName == "" && id != "" {
		rows, err = mw.JSONConn(req).QueryContext(req.Context(), listSurveysByIdSQL, id)
	} else if date != "" && bottleneckName != "" && id == "" {
		rows, err = mw.JSONConn(req).QueryContext(req.Context(), listSurveysByNameDateSQL, bottleneckName, date)
	} else {
		jr = mw.JSONResult{
			Result: struct {
				Surveys []*models.Survey `json:"surveys"`
			}{surveys},
		}
		return
	}
	if err != nil {
		return
	}
	defer rows.Close()
	// as we do not use the values here, we could simply the code here
	// to work without an explicit mdels/surverys.go
	// (like done in controllers/search.go)
	for rows.Next() {
		var survey models.Survey
		var surType string
		var level sql.NullInt64
		if err = rows.Scan(
			&survey.BottleneckID,
			&survey.DateInfo,
			&survey.DepthReference,
			&survey.ReferenceGauge,
			&level,
			&surType,
		); err != nil {
			return
		}
		switch {
		case level.Valid:
			survey.WaterLevelValue = &level.Int64
		case survey.DepthReference == "ZPG":
			survey.WaterLevelValue = new(int64)
		}
		survey.SurveyType = models.SurveyType(surType)
		surveys = append(surveys, &survey)
	}

	if err = rows.Err(); err != nil {
		return
	}

	jr = mw.JSONResult{
		Result: struct {
			Surveys []*models.Survey `json:"surveys"`
		}{surveys},
	}
	return
}