InstitutionSearchDocBuilder.kt

/*
 * search-doc-service
 * Copyright (C) 2020 Memoriav
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

package org.memobase

import ch.memobase.rdf.MB
import ch.memobase.rdf.NS
import com.beust.klaxon.JsonArray
import com.beust.klaxon.JsonObject
import org.apache.logging.log4j.LogManager
import org.memobase.helpers.Date
import org.memobase.helpers.ElasticSearchWrapper
import org.memobase.helpers.Extract
import org.memobase.helpers.Constants
import org.memobase.helpers.JsonUtility
import org.memobase.helpers.TranslationMappers
import org.memobase.model.FacetContainer
import org.memobase.model.InstitutionSearchDoc
import org.memobase.model.LanguageContainer
import org.memobase.model.Schema


class InstitutionSearchDocBuilder(
    private val translationMappers: TranslationMappers,
    private val elasticSearchWrapper: ElasticSearchWrapper
) {
    private val log = LogManager.getLogger("InstitutionSearchDocBuilder")

    fun transform(key: String, input: Map<String, JsonObject>): Schema {
        val institution =
            input[JsonUtility.institutionTag] ?: throw InvalidInputException("No institution entity found in message $key.")
        val identifiers = mutableListOf<JsonObject>()
        val cantons = mutableListOf<FacetContainer>()
        val municipalities = mutableListOf<LanguageContainer>()
        val addresses = mutableListOf<String>()
        val postalCodes = mutableListOf<String>()

        input.values.forEach {
            when {
                it[Constants.ricoType] == Constants.LocationType.canton -> {
                    cantons.add(FacetContainer(extractAdminUnit(it, "canton", "NoCantonFound"), null, emptyList()))
                }
                it[Constants.ricoType] == Constants.LocationType.municipality -> {
                    municipalities.add(extractAdminUnit(it, "municipality", "NoCityFound"))
                }
                it[Constants.ricoType] == Constants.IdentifierType.main -> {
                    identifiers.add(it)
                }
                it[Constants.atType] == NS.rico + Constants.Place -> {
                    addresses.addAll(Extract.listOfStrings(it[Constants.wikidataAddresses]))
                    postalCodes.addAll(Extract.listOfStrings(it[Constants.wikidataPostalCodes]))
                }
            }
        }

        val type = institution[Constants.wikidataInstance].let {
            when (it) {
                is String -> listOf(translationMappers.getInstitutionType(it))
                is JsonArray<*> -> it.map { any -> translationMappers.getInstitutionType(any as String) }
                else -> {
                    log.error("Found no institution types on institution $key")
                    emptyList()
                }
            }
        }

        val name = extractLanguageContainer(institution[Constants.name], "NoNameFound")
        val description = extractLanguageContainer(institution[Constants.descriptiveNote], "NoDescriptionFound")
        val id = Extract.extractIdValue(identifiers, Constants.IdentifierType.main) ?: "NoIdentifierFound"
        val recordSetUris = Extract.listOfStrings(institution[Constants.isHolderOf])
        val recordSetIds = recordSetUris.map { it.substringAfterLast("/") }

        return InstitutionSearchDoc(
            institutionId = id,
            published = institution[Constants.isPublished].let {
                when (it) {
                    is Boolean -> it
                    is String -> it.toBoolean()
                    else -> {
                        log.error("Found no isPublished property on institution $key. Set to false.")
                        false
                    }
                }
            },
            type = type,
            name = name,
            description = description,
            documentType = recordSetIds.flatMap {
                elasticSearchWrapper.getDocumentTypesFromRecords(
                    it,
                    Constants.QueryFields.recordSetFacet
                )
            }.distinctBy { it.filter },
            keyVisualLink = institution[Constants.wikidataImage].let { if (it != null) it as String else "NoKeyVisualLinkDefined" },
            canton = cantons,
            city = municipalities,
            address = addresses,
            postalCodes = postalCodes,
            numberOfRecordSets = recordSetIds.count(),
            numberOfDocuments = recordSetIds
                .map { value -> elasticSearchWrapper.countNumberOfDocuments(value) }
                .sum(),
            teaserColor = institution[MB.institutionTeaserColor.localName].let {
                if (it == null) {
                    log.warn("No teaser colour found for institution $id.")
                    ""
                } else
                    it as String
            },
            teaserColorComputed = institution[MB.institutionComputedTeaserColor.localName].let {
                if (it == null) {
                    log.warn("No computed teaser colour found for institution $id.")
                    ""
                } else
                    it as String
            },
            lastUpdatedDate = Date.now
        )
    }

    private fun extractLanguageContainer(value: Any?, placeholder: String): LanguageContainer {
        return Extract.languageContainer("institution", value).let { items ->
            when {
                items.isEmpty() -> {
                    LanguageContainer.placeholder(placeholder)
                }
                items.size == 1 -> {
                    items[0]
                }
                else -> {
                    items.reduce { acc, languageContainer -> acc.merge(languageContainer) }
                }
            }
        }
    }

    private fun extractAdminUnit(item: JsonObject, parent: String, placeholder: String): LanguageContainer {
        return item[Constants.name].let { name ->
            Extract.languageContainer(parent, name).let {
                when {
                    it.isEmpty() -> LanguageContainer.placeholder(placeholder)
                    else -> it.reduce { acc, languageContainer -> acc.merge(languageContainer) }
                }
            }
        }
    }
}