From 602449cf58f9e9630a6cb17f7dd6e8927b05b88f Mon Sep 17 00:00:00 2001
From: Mike Simpson <mike.simpson@ncl.ac.uk>
Date: Thu, 3 Aug 2023 16:42:12 +0100
Subject: [PATCH] Add Original Land Use (Order) to Key

Copied code from Current Land Use (Land Use Category) to automatically calculate the Land Use Order for Original Land Use and then visualise it on the map. #1219
---
 app/map_styles/polygon.xml                    | 77 +++++++++++++++++++
 app/src/api/config/dataFields.ts              |  8 ++
 .../domainLogic/processBuildingUpdate.ts      | 36 ++++++++-
 app/src/frontend/building/data-container.tsx  | 11 ++-
 .../building/data-containers/land-use.tsx     |  1 +
 .../building/data-containers/typology.tsx     | 34 ++++++++
 .../frontend/config/category-maps-config.ts   | 23 ++++++
 app/src/frontend/config/data-fields-config.ts | 11 +++
 app/src/frontend/config/tileserver-config.ts  |  1 +
 app/src/tiles/dataDefinition.ts               |  9 +++
 migrations/045.typology_changes.down.sql      |  2 +
 migrations/045.typology_changes.up.sql        |  9 +++
 12 files changed, 220 insertions(+), 2 deletions(-)
 create mode 100644 migrations/045.typology_changes.down.sql
 create mode 100644 migrations/045.typology_changes.up.sql

diff --git a/app/map_styles/polygon.xml b/app/map_styles/polygon.xml
index 40fb04db..5023f6aa 100644
--- a/app/map_styles/polygon.xml
+++ b/app/map_styles/polygon.xml
@@ -913,6 +913,83 @@
             <LineSymbolizer stroke="#888" stroke-width="3.0"/>
         </Rule>
     </Style>
+    <Style name="original_landuse">
+        <Rule>
+            <Filter>[typology_original_use_order] = "Agriculture And Fisheries"</Filter>
+            <PolygonSymbolizer fill="#73ccd1" />
+        </Rule>
+        <Rule>
+            <Filter>[typology_original_use_order] = "Minerals"</Filter>
+            <PolygonSymbolizer fill="#45cce3" />
+        </Rule>
+        <Rule>
+            <Filter>[typology_original_use_order] = "Unclassified, presumed non-residential"</Filter>
+            <PolygonSymbolizer fill="#6c6f8e" />
+        </Rule>
+        <Rule>
+            <Filter>[typology_original_use_order] = "Recreation And Leisure"</Filter>
+            <PolygonSymbolizer fill="#ffbfbf" />
+        </Rule>
+        <Rule>
+            <Filter>[typology_original_use_order] = "Transport"</Filter>
+            <PolygonSymbolizer fill="#b3de69" />
+        </Rule>
+        <Rule>
+            <Filter>[typology_original_use_order] = "Utilities And Infrastructure"</Filter>
+            <PolygonSymbolizer fill="#cccccc" />
+        </Rule>
+        <Rule>
+            <Filter>[typology_original_use_order] = "Residential" and not ([typology_original_use_order] = "Garden buildings") and not ([typology_original_use_order] = "Hotels, boarding and guest houses") and not ([typology_original_use_verified])</Filter>
+            <PolygonSymbolizer fill="#252aa6" />
+        </Rule>
+        <Rule>
+            <Filter>[typology_original_use_order] = "Residential" and not ([typology_original_use_order] = "Garden buildings") and not ([typology_original_use_order] = "Hotels, boarding and guest houses") and ([typology_original_use_verified])</Filter>
+            <PolygonSymbolizer fill="#7025a6" />
+        </Rule>
+        <Rule>
+            <Filter>[typology_original_use_order] = "Residential" and [typology_original_use_order] = "Hotels, boarding and guest houses"</Filter>
+            <PolygonSymbolizer fill="#3c4194" />
+        </Rule>
+        <Rule>
+            <Filter>[typology_original_use_order] = "Residential" and [typology_original_use_order] = "Garden buildings" </Filter>
+            <PolygonSymbolizer fill="#1157fa" />
+        </Rule>
+        <Rule>
+            <Filter>[typology_original_use_order] = "Community Services"</Filter>
+            <PolygonSymbolizer fill="#fa667d" />
+        </Rule>
+        <Rule>
+            <Filter>[typology_original_use_order] = "Retail"</Filter>
+            <PolygonSymbolizer fill="#ff8c00" />
+        </Rule>
+        <Rule>
+            <Filter>[typology_original_use_order] = "Industry And Business"</Filter>
+            <PolygonSymbolizer fill="#f5f58f" />
+        </Rule>
+        <Rule>
+            <Filter>[typology_original_use_order] = "Vacant And Derelict"</Filter>
+            <PolygonSymbolizer fill="#ffffff" />
+        </Rule>
+        <Rule>
+            <Filter>[typology_original_use_order] = "Defence"</Filter>
+            <PolygonSymbolizer fill="#898944" />
+        </Rule>
+        <Rule>
+            <Filter>[typology_original_use_order] = "Mixed Use"</Filter>
+            <PolygonSymbolizer fill="#e5050d" />
+        </Rule>
+
+        <Rule>
+            <MaxScaleDenominator>8530</MaxScaleDenominator>
+            <MinScaleDenominator>4264</MinScaleDenominator>
+            <LineSymbolizer stroke="#888" stroke-width="0.8"/>
+        </Rule>
+        <Rule>
+            <MaxScaleDenominator>4264</MaxScaleDenominator>
+            <MinScaleDenominator>0</MinScaleDenominator>
+            <LineSymbolizer stroke="#888" stroke-width="3.0"/>
+        </Rule>
+    </Style>
     <Style name="disaster_severity">
         <Rule>
             <Filter>[disaster_severity] = "Building destroyed"</Filter>
diff --git a/app/src/api/config/dataFields.ts b/app/src/api/config/dataFields.ts
index a14a1b4f..c0db758b 100644
--- a/app/src/api/config/dataFields.ts
+++ b/app/src/api/config/dataFields.ts
@@ -965,6 +965,14 @@ export const buildingAttributesConfig = valueType<DataFieldConfig>()({ /* eslint
         verify: true
     },
     typology_original_use : {
+        edit: true,
+        derivedEdit: true,
+        verify: true
+    },
+    typology_original_use_verified: {
+        edit: true,
+    },
+    typology_original_use_order : {
         edit: true,
         verify: true
     },
diff --git a/app/src/api/services/domainLogic/processBuildingUpdate.ts b/app/src/api/services/domainLogic/processBuildingUpdate.ts
index 2169c793..e753c6cb 100644
--- a/app/src/api/services/domainLogic/processBuildingUpdate.ts
+++ b/app/src/api/services/domainLogic/processBuildingUpdate.ts
@@ -9,7 +9,7 @@ import { ArgumentError } from '../../errors/general';
 import { updateLandUse } from './landUse';
 
 /**
- * Process land use classifications - derive land use order from land use groups
+ * Process current land use classifications - derive land use order from land use groups
  */
 async function processCurrentLandUseClassifications(
     buildingId: number,
@@ -40,6 +40,37 @@ async function processCurrentLandUseClassifications(
     }
 }
 
+/**
+ * Process original land use classifications - derive land use order from land use groups
+ */
+async function processOriginalLandUseClassifications(
+    buildingId: number,
+    buildingUpdate: Partial<BuildingAttributes>,
+    t?: ITask<any>
+): Promise<any> {
+    const currentBuildingData = await getBuildingData(buildingId);
+
+    try {
+        const currentLandUseUpdate = await updateLandUse(
+            {
+                landUseGroup: currentBuildingData.typology_original_use,
+                landUseOrder: currentBuildingData.typology_original_use_order
+            }, {
+                landUseGroup: buildingUpdate.typology_original_use
+            }
+        );
+
+        return Object.assign({}, buildingUpdate, {
+            typology_original_use: currentLandUseUpdate.landUseGroup,
+            typology_original_use_order: currentLandUseUpdate.landUseOrder,
+        });
+    } catch (error) {
+        if(error instanceof ArgumentError && error.argumentName === 'landUseUpdate') {
+            error.argumentName = 'buildingUpdate';
+        }
+        throw error;
+    }
+}
 
 /**
  * Process Dynamics data - check field relationships and sort demolished buildings by construction date
@@ -81,6 +112,9 @@ export async function processBuildingUpdate(buildingId: number, {attributes, use
     if(hasAnyOwnProperty(attributes, ['current_landuse_group'])) {
         attributes = await processCurrentLandUseClassifications(buildingId, attributes, t);
     }
+    if(hasAnyOwnProperty(attributes, ['typology_original_use'])) {
+        attributes = await processOriginalLandUseClassifications(buildingId, attributes, t);
+    }
     if(hasAnyOwnProperty(attributes, ['demolished_buildings', 'dynamics_has_demolished_buildings'])) {
         attributes = await processDynamicsDemolishedBuildings(buildingId, attributes, t);
     }
diff --git a/app/src/frontend/building/data-container.tsx b/app/src/frontend/building/data-container.tsx
index c72fd216..e5d7604d 100644
--- a/app/src/frontend/building/data-container.tsx
+++ b/app/src/frontend/building/data-container.tsx
@@ -99,7 +99,9 @@ const withCopyEdit: (wc: React.ComponentType<CategoryViewProps>) => DataContaine
                                      'likes_total',
                                      'community_type_worth_keeping_total',
                                      'community_local_significance_total',
-                                     'community_expected_planning_application_total'
+                                     'community_expected_planning_application_total',
+                                     'typology_original_use',
+                                     'typology_original_use_verified'
                                     ]
             for (let key in dataFields) {  
                 let fieldName = props.building == undefined ? undefined : props.building[key];    
@@ -286,6 +288,13 @@ const withCopyEdit: (wc: React.ComponentType<CategoryViewProps>) => DataContaine
 
                 this.doSubmit(edits);
             }
+            if (slug == 'typology_original_use'){
+                const edits = {
+                    'typology_original_use_verified': true
+                };
+
+                this.doSubmit(edits);
+            }
             console.log(slug + " verify button clicked")
         }
 
diff --git a/app/src/frontend/building/data-containers/land-use.tsx b/app/src/frontend/building/data-containers/land-use.tsx
index a9e92b8c..56235feb 100644
--- a/app/src/frontend/building/data-containers/land-use.tsx
+++ b/app/src/frontend/building/data-containers/land-use.tsx
@@ -138,6 +138,7 @@ const UseView: React.FunctionComponent<CategoryViewProps> = (props) => {
                             />
                         </>
                     }
+                    <hr/>
                     {
                         props.mode != 'view' &&
                         <div>
diff --git a/app/src/frontend/building/data-containers/typology.tsx b/app/src/frontend/building/data-containers/typology.tsx
index 736f418e..a79bcec0 100644
--- a/app/src/frontend/building/data-containers/typology.tsx
+++ b/app/src/frontend/building/data-containers/typology.tsx
@@ -35,6 +35,10 @@ const TypeView: React.FunctionComponent<CategoryViewProps> = (props) => {
         e.preventDefault();
         props.onMapColourScale('building_attachment_form')
     }
+    const switchToLandUseMapStyle = (e) => {
+        e.preventDefault();
+        props.onMapColourScale('original_landuse')
+    }
 
     return (
         <Fragment>
@@ -216,6 +220,15 @@ const TypeView: React.FunctionComponent<CategoryViewProps> = (props) => {
                 }
             </DataEntryGroup>
             <DataEntryGroup name="Original Use">
+                {(props.mapColourScale == "original_landuse") ? 
+                    <button className={`map-switcher-inline enabled-state btn btn-outline btn-outline-dark ${darkLightTheme}`} onClick={switchToClassificationMapStyle}>
+                        {'Click to change map to show typology classification.'}
+                    </button>
+                :
+                    <button className={`map-switcher-inline disabled-state btn btn-outline btn-outline-dark ${darkLightTheme}`} onClick={switchToLandUseMapStyle}>
+                        {"Click here to change map to original land use."}
+                    </button>
+                }
                 <MultiDataEntry
                     title={dataFields.typology_original_use.title}
                     slug="typology_original_use"
@@ -267,6 +280,27 @@ const TypeView: React.FunctionComponent<CategoryViewProps> = (props) => {
                         />
                     </>
                 }
+                <hr/>
+                {
+                    props.mode != 'view' &&
+                    <div>
+                        <div className={`alert alert-dark`} role="alert" style={{ fontSize: 13, backgroundColor: "#f6f8f9" }}>
+                            <i>
+                                Below is a more general classification for the original land use of this building, automatically derived from the information above.
+                            </i>
+                        </div>
+                    </div>
+                }
+                <DataEntry
+                    title={dataFields.typology_original_use_order.title}
+                    tooltip={dataFields.typology_original_use_order.tooltip}
+                    slug="typology_original_use_order"
+                    value={props.building.typology_original_use_order}
+                    mode={props.mode}
+                    disabled={true}
+                    copy={props.copy}
+                    onChange={props.onChange}
+                />
             </DataEntryGroup>
             <DataEntryGroup name="Attachment/Adjacency">
                 {(props.mapColourScale == "building_attachment_form") ? 
diff --git a/app/src/frontend/config/category-maps-config.ts b/app/src/frontend/config/category-maps-config.ts
index 42d387c1..58d7a62c 100644
--- a/app/src/frontend/config/category-maps-config.ts
+++ b/app/src/frontend/config/category-maps-config.ts
@@ -348,6 +348,29 @@ export const categoryMapsConfig: {[key in Category]: CategoryMapDefinition[]} =
                 ]
             }
         },
+        {
+        mapStyle: 'original_landuse',
+            legend: {
+                title: 'Original Land Use',
+                elements: [
+                    { color: '#e5050d', text: 'Mixed Use' },
+                    { subtitle: 'Single use:'},
+                    { color: '#252aa6', text: 'Residential (unverified)' },
+                    { color: '#7025a6', text: 'Residential (verified)' },
+                    { color: '#ff8c00', text: 'Retail' },
+                    { color: '#f5f58f', text: 'Industry & Business' },
+                    { color: '#fa667d', text: 'Community Services' },
+                    { color: '#ffbfbf', text: 'Recreation & Leisure' },
+                    { color: '#b3de69', text: 'Transport' },
+                    { color: '#cccccc', text: 'Utilities & Infrastructure' },
+                    { color: '#898944', text: 'Defence' },
+                    { color: '#73ccd1', text: 'Agriculture' },
+                    { color: '#45cce3', text: 'Minerals' },
+                    { color: '#ffffff', text: 'Vacant & Derelict' },
+                    { color: '#6c6f8e', text: 'Unclassified, presumed non-residential' }
+                ]
+            },
+        },
         {
             mapStyle: 'building_attachment_form',
             legend: {
diff --git a/app/src/frontend/config/data-fields-config.ts b/app/src/frontend/config/data-fields-config.ts
index 66f913ec..2b643b27 100644
--- a/app/src/frontend/config/data-fields-config.ts
+++ b/app/src/frontend/config/data-fields-config.ts
@@ -1833,6 +1833,17 @@ export const dataFields = { /* eslint-disable @typescript-eslint/camelcase */
         tooltip: "Land use Groups as classified by [NLUD](https://www.gov.uk/government/statistics/national-land-use-database-land-use-and-land-cover-classification)",
         example: ["", ""],
     },
+    typology_original_use_verified: {
+        category: Category.LandUse,
+        title: 'Has this land use been manually verified?',
+        example: true,
+    },
+    typology_original_use_order: {
+        category: Category.Typology,
+        title: "Original land use (order)",
+        tooltip: "Land use Order as classified by [NLUD](https://www.gov.uk/government/statistics/national-land-use-database-land-use-and-land-cover-classification)",
+        example: "",
+    },
     typology_original_use_source_type: {
         category: Category.Typology,
         title: "Source type",
diff --git a/app/src/frontend/config/tileserver-config.ts b/app/src/frontend/config/tileserver-config.ts
index 73c2d4b7..ec6a2bcc 100644
--- a/app/src/frontend/config/tileserver-config.ts
+++ b/app/src/frontend/config/tileserver-config.ts
@@ -21,6 +21,7 @@ export type BuildingMapTileset =
     'sust_dec' |
     'building_attachment_form' |
     'landuse' |
+    'original_landuse' |
     'dynamics_demolished_count' |
     'disaster_severity' |
     'team' |
diff --git a/app/src/tiles/dataDefinition.ts b/app/src/tiles/dataDefinition.ts
index a10cff9f..c2a464f9 100644
--- a/app/src/tiles/dataDefinition.ts
+++ b/app/src/tiles/dataDefinition.ts
@@ -266,6 +266,15 @@ const LAYER_QUERIES = {
             buildings
         WHERE
             current_landuse_order IS NOT NULL`,
+    original_landuse: `
+        SELECT
+            geometry_id,
+            typology_original_use_order,
+            typology_original_use[1] as typology_original_use,
+            typology_original_use_verified
+        FROM
+            buildings
+        WHERE typology_original_use IS NOT NULL`,
     disaster_severity: `
         SELECT
             geometry_id,
diff --git a/migrations/045.typology_changes.down.sql b/migrations/045.typology_changes.down.sql
new file mode 100644
index 00000000..9797cd12
--- /dev/null
+++ b/migrations/045.typology_changes.down.sql
@@ -0,0 +1,2 @@
+ALTER TABLE buildings DROP COLUMN IF EXISTS typology_original_use_order;
+ALTER TABLE buildings DROP COLUMN IF NOT EXISTS typology_original_use_verified;
\ No newline at end of file
diff --git a/migrations/045.typology_changes.up.sql b/migrations/045.typology_changes.up.sql
new file mode 100644
index 00000000..ca2ecbd4
--- /dev/null
+++ b/migrations/045.typology_changes.up.sql
@@ -0,0 +1,9 @@
+ALTER TABLE buildings ADD COLUMN IF NOT EXISTS typology_original_use_order text;
+
+ALTER TABLE buildings ADD COLUMN IF NOT EXISTS typology_original_use_verified BOOLEAN NOT NULL DEFAULT FALSE;
+
+UPDATE buildings as b
+SET typology_original_use_verified = TRUE
+FROM building_verification as v
+WHERE b.building_id = v.building_id
+AND v.attribute = 'current_landuse_group';
\ No newline at end of file