CHANGELOG.md

# CHANGELOG

## 2020-02-10

Instalation of the existing project with Django 

## 2020-03-16

* Initialization of Rest API, with Django (back-end)
    * Create Unit model for database
    * Add connection data fo database
* Initialization of the Angular project (front-end)
* Creation of a snippet to explain how to fix libgeos version trouble (available [here](https://gricad-gitlab.univ-grenoble-alpes.fr/Projets-INFO4/19-20/8/app-pghm/snippets/167))


## 2020-03-17

* Creation of contributing rules
* Start of model creation

##  2020-03-24

* Fixing problems created by a Django update:
    * MIDDLEWARE issue: Under definition of `MIDDLEWARE_CLASSES` array in `settings.py` add, if is not already done, `MIDDLEWARE = MIDDLEWARE_CLASSES`
    * WSGI issue: in `MIDDLEWARE_CLASSES` array in `settings.py` comment or remove the line `'django.contrib.auth.middleware.SessionAuthenticationMiddleware',`
* Continuation of the design
* Installation of the `django-rest-swagger` module. This module allows to generate the API documentation automatically (with the swagger style).
* Test of the `rest_framework` module with the creation of a feature that allows to get all users (GET htt://127.0.0.1/users)


## 2020-03-30

* Creation of the 'link' between a user (officer) and his unit.
* Improvement of the link (previously described). Create a PghmUser class that inherits of User (default class). Then add a foreign key field that points to the unit.
    * New class and field created
    * attempt to change the column by default of foreign key (use the unit's code instead of unit's id)
    * it remains to modify the forms of the admin part for take the change into account.
* TODO:
    * ~~CRUD on User and unit~~
    * ~~Finish API function~~
    * ~~Generate the documentation of what will have been done~~

## 2020-04-06

* Adding the unit field in user administration forms
* Creation of unit administration interfaces

## 2020-04-10
* API For users:
    *  GET | POST | UPDATE | DELETE
* API For units:
    * GET | POST | UPDATE | DELETE
    * A unit can be selected by its code
* Refactoring of views' code
* Implementation of automatic document generation

## 2020-05-12

* Back-end:
    * Webcam management
        * Model
        * API => CRUD
        * Admin form

## 2020-05-13

* Back-end:
    * External services management (feature to manage different external services such as IGN's API or OSM's API)
        * Model
        * Admin form
        * API => CRUD
        
    * Code refactored: now we are using the submodule system provided by Django and Python. So each resource is now a submodule

## 2020-05-18

* The connection between front-end and back-end is established (only for login)
* Redirection when you are not logged in works
* Redirection when you are logged in works too
* There was a bug with forms inside the side-left bar: the form controllers were missing. We added them now.
* Client for using the API is done. To know more about that module check the [wiki](https://gricad-gitlab.univ-grenoble-alpes.fr/Projets-INFO4/19-20/8/app-pghm/-/wikis/%5BFRONT%5D-API---Client).

## 2020-05-19

* Update API Client => Add Authorization in HTTP header
* Update Login process => Now we load the associated unit's information
* Load of OpenStreetMap with settings of the current unit

## 2020-05-22

* Adding map tiles => OpenStreet Map and OpenTopo Map
* Marker of the unit, with a popup which contains information about unit (coordinates,email, name)
* Display of coordinates in DD format and DMS formats
* Add controller to change map tiles
* Fix some bugs with the API client
* Preparation of the code to get the available services. The code is commented for the moment, because the only available service is the IGN one and the key at our disposal for the moment is not valid.
* Adding a new "sub-resource" to search a service by name

## 2020-05-26

* Add custom icon for makers
* Display all Gendarmerie units and the unit information (name, phone, address)
* The units are displayed according the current map bounds and zoom
* The Gendarmerie units are save in database (API side)

## 2020-05-29

* Refactoring the unit parts in Django side (API)
* Adding Police units
* Adding station resource
* Linking the station resource to webcam resource
* Use geojson for station
* Add the station layer on the map with their webcams acording the maps bounds
* Optimization of the addition/deletion of Gendarmerie units

**TODO**
* ~~Like Gendarmerie units, define when we call the api for stations~~
* ~~Optimization of API calls~~
* ~~Add image inside the popup of webcams~~

## 2020-06-04
* The API return GeoJSON for all models with (at least) a spacial field
* New version of the API Client. Now we can handle the GeoJSON format
* Update the map component to use GeoJSON data
* Webcam model has a new property: `is_active`. We have added this new property because some webcams are not active during the summer, but are active in winter and vice versa.

## 2020-06-05

* IGN map tiles added.
* The search engine added
    * The available services are:
        * BAN (data.gouv.fr)
        * Nomination (OSM)
        * IGN Toponyme (Look 4)
        * IGN Autocomplétion

> :warning: ~~**IMPORANT:** To test IGN services, we use an API key provided for developing. That key doesn't work for the IGN Autocomplétion service. She is rejected.~~

* The map is connected with the search engine. So now we can get map's center/bounds to filter the results by geometry. But for the moment We have difficulties with the geometry filter of Look4 service (IGN).

* TODO 
    * ~~Pretty CSS for search engine~~ 
    * ~~Link the map to the search engine~~
    * ~~Think about the select box: The user select the search service or the app do the search with all services?~~
        * ~~==> We keep it but we add an option 'All'~~

## 2020-06-08

* The search engine and the map are connected so that when you hover over one of the results (or click on it) the map displays the position of the result.
* TODO:
    * ~~Refactor the code of map and of the search egine before to merge on `master`~~

## 2020-06-11

* FRONT-END
    * Code of the search bar and search engine is refactored
    * The search engine now call the search engine of backend and send always the same parameters
    * There is an autocompletion for the search
* BACK-END
    * Adding the search engine
    * Adding of metadata (or category) for the search services
* TODO
    * ~~Add the right icon (Lake, Ski, Mountain, ....)~~
    * ~~Filter the search's results~~
    * ~~Use the right search service(s) according the selected activity(ies) and/or the object type(s)~~
    * ~~Remove the selectbox to select a service~~

## 2020-06-16

* Search egine : 
    * Filtering the result (back-end side)
    * Handling the error return from the search services 
    * New pretty CSS
* Remove the selectbox (of services)
* Add a page to manage webcams
* Generalization of the map component
* Generalization of the left side bar component
* Update the wecam

## 2020-06-17

* Add information about the last update (of a webcam):
    * Who made the update
    * Date of the update

## 2020-06-22

* Add coordibates conversion:
    * Lambert 93
    * UTM
    * DMS
    * DD
    * DMM

## 2020-06-24

* Added feature:
     * Double click on the map => popup with the city name, Gendarmerie/Police unit in charge of the current city, altitude of the city
        * To get the city name we use a reverse geocoding service from IGN, when that service is down, we use a datatbase made as a common repository for all user types  
        * You can select the information that you want via a flag system

## 2020-06-25

* Makefile for intallation
* Icon managment back-end side
* Display icon in django admin

## 2020-06-30

* **Back-end**
    * New model to translate search API result for the front-end
    * New model to filter the search result
    * Seperate the search services and the services to get more information about an object
    * Factoring code
    * Icon according the current result type (automatically in backend)
* **Front-end**
    * Reduction of API calls number
    * Bug with zoom and ovelays fixed

## 2020-07-01

* Improve performances of API
* Fix bugs:
    * Graphical bug, the gend units (or webcam). The bug was that when the user changes the view, there still are the objects from the previous view on the map. The sollution is to unsubscribe to the event which trigger the api to get gend units for example.
    * The autocomplete is fixed now. :warning: The autocomplete feature doesn't work with FireFox. The hypothesis is that the datalist (HTML element) doesn't work very well on FireFox.

## 2020-07-02
 
* A pretty CSS
* Fix some bugs:
    * The map did not move when the user hovered over a search result.
    * Graphical bugs with the map marker for polygon, linestring object

## 2020-07-06

* Removing some useless API call
* The API keys management is now handle by the back-end not by the front-end
* Change of sidebar version, from homemade to Leaflet version
* Pretty CSS
* Search bar, sort the results according where are coming from

## 2020-07-07

* Adding tests

## 2020-07-10

* Updating coordinates display 
    *  Maybe a possible opensource contribution
* Add to the base layers a new property: max zoom
* Fixing a bug about webcams: The bug was that when user add the webcam overlay, the webcams weren't displayed on the map
* Adding default baselayer for PGHM unit
* Set auto focus  on the search bar when the user opens the search tab
* Adding the feature aims to associtate overlays services to a category

## 2020-07-13

* Management of overlays services. :warning: **IMPORTANT:** :warning: The code works only for the overlays which work like a tile service.
* Creation of our angular library to use Leaflet.Coordinates with angular:
    * The basic features work using the original code
    * TODO: Add more feature to this library

## 2020-07-15

* Beta release
    * Testing it 
    * Fixing found bugs

## 2020-07-16

* Test to put in production the back-end (Django)
* Testing of Django permissions system to manage overlays and base layer
* New version of user & group model
    * User => the models uses email address to identify a user. The model requires first and last name
    * Group => the model has a new property: the overlay available for the group members
* Back-end handles the overlay services according the user's permissions

## 2020-07-17

* Fix bug with django permission
    * The bug was that Django tryed to get the user's groups (when we did `has_perm(...)`) an execption was raised about an incorrect type.  
    * The solution has been to override the method `get_group_permissions`
* Fix the search result dispaly:
    * Remove the empty tables
    * Fix trouble with the map center and the method `flyTo` of Leaflet
    * Display the polygon when there is one