From 7791afaeb651cbd5f48578d314fc833bca073be6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Alexandre=20Bult=C3=A9?= <alexandre@bulte.net>
Date: Mon, 9 Sep 2024 11:17:22 +0200
Subject: [PATCH 1/6] add connection step

---
 ecospheres_migrator/app.py                    | 75 +++++++++++++++----
 ecospheres_migrator/geonetwork.py             |  5 ++
 ecospheres_migrator/templates/base.html.j2    |  9 +++
 .../fragments/transform_job_status.html.j2    |  4 +-
 ecospheres_migrator/templates/header.html.j2  |  4 +-
 ecospheres_migrator/templates/login.html.j2   | 33 ++++++++
 ecospheres_migrator/templates/migrate.html.j2 |  4 +-
 ecospheres_migrator/templates/select.html.j2  | 19 +----
 .../templates/transform.html.j2               |  4 +-
 9 files changed, 118 insertions(+), 39 deletions(-)
 create mode 100644 ecospheres_migrator/templates/login.html.j2

diff --git a/ecospheres_migrator/app.py b/ecospheres_migrator/app.py
index 2d4d540..a2a12e2 100644
--- a/ecospheres_migrator/app.py
+++ b/ecospheres_migrator/app.py
@@ -3,7 +3,18 @@
 from datetime import datetime
 from pathlib import Path
 
-from flask import Flask, abort, redirect, render_template, request, send_file, session, url_for
+import requests
+from flask import (
+    Flask,
+    abort,
+    flash,
+    redirect,
+    render_template,
+    request,
+    send_file,
+    session,
+    url_for,
+)
 
 from ecospheres_migrator.migrator import Migrator
 from ecospheres_migrator.queue import get_job, get_queue
@@ -13,6 +24,46 @@
 
 
 @app.route("/")
+def login_form():
+    return render_template(
+        "login.html.j2",
+        url=session.get("url", ""),
+        username=session.get("username", ""),
+        password=session.get("password", ""),
+    )
+
+
+# TODO: allow GET and skip form? or select is enough
+@app.route("/login", methods=["POST"])
+def login():
+    url = request.form.get("url")
+    username = request.form.get("username")
+    password = request.form.get("password")
+    if not username or not password or not url:
+        abort(400, "Missing login parameter(s)")
+
+    migrator = Migrator(url=url, username=username, password=password)
+    try:
+        gn_info = migrator.gn.info()
+        print("GN info", gn_info)
+    except requests.exceptions.HTTPError as e:
+        flash(f"Problème d'authentification ({e})", "error")
+        return redirect(url_for("login_form"))
+    else:
+        authenticated = gn_info.get("me", {}).get("@authenticated", "false") == "true"
+        if not authenticated:
+            flash("Problème d'authentification (retour api geonetwork)", "error")
+            return redirect(url_for("login_form"))
+
+    session["url"] = url
+    session["username"] = username
+    session["password"] = password
+    return redirect(url_for("select"))
+
+
+# TODO: protect route (@authenticated)
+# and maybe pass url, username, password from decorator or helper
+@app.route("/select")
 def select():
     return render_template(
         "select.html.j2",
@@ -21,42 +72,36 @@ def select():
     )
 
 
+# TODO: protect route (@authenticated)
 @app.route("/select/preview", methods=["POST"])
 def select_preview():
-    url = request.form.get("url")
+    url = session.get("url")
+    username = session.get("username")
+    password = session.get("password")
     if not url:
         return "Veuillez entrer une URL de catalogue"
     query = request.form.get("query")
     if not query:
         return "Veuillez entrer une requête de recherche"
-    # Need auth to ensure the records retrieved in selection are consistent with
-    # the records that'll be updated during the migration. Otherwise we might miss
-    # things like workflow status.
-    # TODO: required auth? or skip items with drafts in migration? ...?
-    username = request.form.get("username")
-    password = request.form.get("password")
     migrator = Migrator(url=url, username=username, password=password)
     results = migrator.select(query=query)
     return render_template("fragments/select_preview.html.j2", results=results)
 
 
+# TODO: protect route (@authenticated)
 @app.route("/transform", methods=["POST"])
 def transform():
-    url = request.form.get("url")
+    url = session.get("url")
+    username = session.get("username")
+    password = session.get("password")
     if not url:
         abort(400, "Missing `url` parameter")
-    session["url"] = url
     query = request.form.get("query")
     if not query:
         abort(400, "Missing `query` parameter")
     transformation = request.form.get("transformation")
     if not transformation:
         abort(400, "Missing `transformation` parameter")
-    username = request.form.get("username")
-    password = request.form.get("password")
-    if username and password:
-        session["username"] = username
-        session["password"] = password
     migrator = Migrator(url=url, username=username, password=password)
     selection = migrator.select(query=query)
     job = get_queue().enqueue(migrator.transform, transformation, selection)
diff --git a/ecospheres_migrator/geonetwork.py b/ecospheres_migrator/geonetwork.py
index f5c0206..6e808c9 100644
--- a/ecospheres_migrator/geonetwork.py
+++ b/ecospheres_migrator/geonetwork.py
@@ -28,6 +28,11 @@ def __init__(self, url, username: str | None = None, password: str | None = None
             log.debug(f"Authenticating as: {username}")
         self.authenticate()
 
+    def info(self):
+        r = self.session.get(f"{self.api}/info?_content_type=json&type=me")
+        r.raise_for_status()
+        return r.json()
+
     def authenticate(self):
         r = self.session.post(f"{self.api}/info?_content_type=json&type=me")
         # don't abort on error here, it's expected
diff --git a/ecospheres_migrator/templates/base.html.j2 b/ecospheres_migrator/templates/base.html.j2
index 4191173..6717896 100644
--- a/ecospheres_migrator/templates/base.html.j2
+++ b/ecospheres_migrator/templates/base.html.j2
@@ -13,6 +13,15 @@
     {% include "header.html.j2" %}
     <main role="main" id="content">
       <div class="fr-container fr-mb-4w">
+        {% with messages = get_flashed_messages(with_categories=true) %}
+          {% if messages %}
+            {% for category, message in messages %}
+              <div class="fr-alert fr-alert--{{ category }} fr-mt-2w">
+                <p>{{ message }}</p>
+              </div>
+            {% endfor %}
+          {% endif %}
+        {% endwith %}
         {% block content %}
         {% endblock content %}
       </div>
diff --git a/ecospheres_migrator/templates/fragments/transform_job_status.html.j2 b/ecospheres_migrator/templates/fragments/transform_job_status.html.j2
index 909ef92..ddc151a 100644
--- a/ecospheres_migrator/templates/fragments/transform_job_status.html.j2
+++ b/ecospheres_migrator/templates/fragments/transform_job_status.html.j2
@@ -4,12 +4,12 @@
        hx-trigger="load delay:1s"
        hx-swap="outerHTML">{{ now }} — le job est en cours de traitement ({{ status }}).</div>
 {% elif status == "finished" %}
+  {# TODO: add normalized info about current connected catalog #}
   <p>Job terminé.</p>
   <p>Vous pouvez <a href="{{ url_for('transform_download_result', job_id=job.id) }}">télécharger le résultat</a>
   et appliquer vous-mêmes les modifications sur votre catalogue en important le fichier.</p>
   <p>Vous pouvez également utiliser le formulaire ci-dessous pour appliquer les modifications automatiquement
-  sur le catalogue {{ url }}. Pour ce faire, nous avons besoin d'identifiants privilégiés sur votre catalogue.
-  Ces identifiants sont transmis de manière sécurisée et nous ne les stockons pas.</p>
+  sur le catalogue {{ url }}.</p>
   <form action="{{ url_for('migrate', job_id=job.id) }}" method="post" class="fr-mt-2w">
     <div class="fr-select-group">
       <label class="fr-label" for="mode">Mode de mise à jour *</label>
diff --git a/ecospheres_migrator/templates/header.html.j2 b/ecospheres_migrator/templates/header.html.j2
index cfda416..b5deefc 100644
--- a/ecospheres_migrator/templates/header.html.j2
+++ b/ecospheres_migrator/templates/header.html.j2
@@ -23,7 +23,7 @@
             </div>
           </div>
           <div class="fr-header__service">
-            <a href="{{ url_for('select') }}" title="Accueil - Ecosphères migrator">
+            <a href="{{ url_for('login_form') }}" title="Accueil - Ecosphères migrator">
               <p class="fr-header__service-title">Ecosphères migrator</p>
             </a>
             <p class="fr-header__service-tagline">Migrations XML Geonetwork</p>
@@ -44,7 +44,7 @@
            aria-label="Menu principal">
         <ul class="fr-nav__list">
           <li class="fr-nav__item">
-            <a class="fr-nav__link" href="{{ url_for('select') }}" target="_self">Migration</a>
+            <a class="fr-nav__link" href="{{ url_for('login_form') }}" target="_self">Migration</a>
           </li>
           <li class="fr-nav__item">
             <a class="fr-nav__link" href="{{ url_for('documentation') }}" target="_self">Documentation</a>
diff --git a/ecospheres_migrator/templates/login.html.j2 b/ecospheres_migrator/templates/login.html.j2
new file mode 100644
index 0000000..0b42772
--- /dev/null
+++ b/ecospheres_migrator/templates/login.html.j2
@@ -0,0 +1,33 @@
+{% extends "base.html.j2" %}
+{% block content %}
+  <div class="fr-stepper fr-mt-4v">
+    <h2 class="fr-stepper__title">
+      Connexion au catalogue
+      <span class="fr-stepper__state">Étape 1 sur 4</span>
+    </h2>
+    <div class="fr-stepper__steps" data-fr-current-step="1" data-fr-steps="4"></div>
+    <p class="fr-stepper__details">
+      <span class="fr-text--bold">Étape suivante :</span> Sélection des données
+    </p>
+  </div>
+  <form method="post" action="{{ url_for('login') }}">
+    <div class="fr-input-group">
+      <label class="fr-label" for="query">URL du catalogue *
+        <span class="fr-hint-text">Ex : https://www.example.com/geonetwork/srv</span>
+      </label>
+      <input required class="fr-input" type="url" id="url" name="url" value="{{ url }}" />
+    </div>
+    <div class="fr-input-group">
+      <label class="fr-label" for="username">Identifiant sur le catalogue *</label>
+      <input required class="fr-input" type="text" id="username" name="username" value="{{ username }}" />
+    </div>
+    <div class="fr-input-group">
+      <label class="fr-label" for="password">Mot de passe sur le catalogue *</label>
+      <input required class="fr-input" type="password" id="password" name="password" value="{{ password }}" />
+    </div>
+    <div class="fr-hint-text">Les données de ce formulaire sont chiffrées et stockées uniquement sur votre navigateur.</div>
+    <div class="fr-mt-2w fr-grid-row">
+      <button type="submit" class="fr-btn">Suivant</button>
+    </div>
+  </form>
+{% endblock content %}
diff --git a/ecospheres_migrator/templates/migrate.html.j2 b/ecospheres_migrator/templates/migrate.html.j2
index 8b12c6f..5afa27f 100644
--- a/ecospheres_migrator/templates/migrate.html.j2
+++ b/ecospheres_migrator/templates/migrate.html.j2
@@ -3,9 +3,9 @@
   <div class="fr-stepper fr-mt-4v">
     <h2 class="fr-stepper__title">
       Migration des données
-      <span class="fr-stepper__state">Étape 3 sur 3</span>
+      <span class="fr-stepper__state">Étape 4 sur 4</span>
     </h2>
-    <div class="fr-stepper__steps" data-fr-current-step="3" data-fr-steps="3"></div>
+    <div class="fr-stepper__steps" data-fr-current-step="4" data-fr-steps="4"></div>
   </div>
   Votre traitement (job) porte l'identifiant <code>{{ job.id }}</code>.
   Son avancement est présenté ci-dessous.
diff --git a/ecospheres_migrator/templates/select.html.j2 b/ecospheres_migrator/templates/select.html.j2
index b214756..5082590 100644
--- a/ecospheres_migrator/templates/select.html.j2
+++ b/ecospheres_migrator/templates/select.html.j2
@@ -3,28 +3,15 @@
   <div class="fr-stepper fr-mt-4v">
     <h2 class="fr-stepper__title">
       Sélection des données à migrer
-      <span class="fr-stepper__state">Étape 1 sur 3</span>
+      <span class="fr-stepper__state">Étape 2 sur 4</span>
     </h2>
-    <div class="fr-stepper__steps" data-fr-current-step="1" data-fr-steps="3"></div>
+    <div class="fr-stepper__steps" data-fr-current-step="2" data-fr-steps="4"></div>
     <p class="fr-stepper__details">
       <span class="fr-text--bold">Étape suivante :</span> Transformation des données
     </p>
   </div>
   <form hx-validate="true" method="post" action="{{ url_for('transform') }}">
-    <div class="fr-input-group">
-      <label class="fr-label" for="query">URL du catalogue *
-        <span class="fr-hint-text">Ex : https://www.example.com/geonetwork/srv</span>
-      </label>
-      <input required class="fr-input" type="url" id="url" name="url" value="{{ url }}" />
-    </div>
-    <div class="fr-input-group">
-      <label class="fr-label" for="username">Identifiant sur le catalogue *</label>
-      <input required class="fr-input" type="text" id="username" name="username" />
-    </div>
-    <div class="fr-input-group">
-      <label class="fr-label" for="password">Mot de passe sur le catalogue *</label>
-      <input required class="fr-input" type="password" id="password" name="password" />
-    </div>
+    {# TODO: add info about current connected catalog #}
     <div class="fr-input-group">
       <label class="fr-label" for="query">Requête de recherche *
         <span class="fr-hint-text">Ex : _source=&lt;SOURCE_ID&gt;,type=dataset</span>
diff --git a/ecospheres_migrator/templates/transform.html.j2 b/ecospheres_migrator/templates/transform.html.j2
index 3c2fb10..1f01281 100644
--- a/ecospheres_migrator/templates/transform.html.j2
+++ b/ecospheres_migrator/templates/transform.html.j2
@@ -3,9 +3,9 @@
   <div class="fr-stepper fr-mt-4v">
     <h2 class="fr-stepper__title">
       Transformation des données
-      <span class="fr-stepper__state">Étape 2 sur 3</span>
+      <span class="fr-stepper__state">Étape 3 sur 4</span>
     </h2>
-    <div class="fr-stepper__steps" data-fr-current-step="2" data-fr-steps="3"></div>
+    <div class="fr-stepper__steps" data-fr-current-step="3" data-fr-steps="4"></div>
     <p class="fr-stepper__details">
       <span class="fr-text--bold">Étape suivante :</span> Migration des données (facultatif)
     </p>

From b6b2eb65dd47677d21fa5e8ea43491a18c1756b4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Alexandre=20Bult=C3=A9?= <alexandre@bulte.net>
Date: Mon, 9 Sep 2024 11:37:46 +0200
Subject: [PATCH 2/6] add authenticated decorator

---
 ecospheres_migrator/app.py | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/ecospheres_migrator/app.py b/ecospheres_migrator/app.py
index a2a12e2..48c6c71 100644
--- a/ecospheres_migrator/app.py
+++ b/ecospheres_migrator/app.py
@@ -16,6 +16,7 @@
     url_for,
 )
 
+from ecospheres_migrator.auth import authenticated
 from ecospheres_migrator.migrator import Migrator
 from ecospheres_migrator.queue import get_job, get_queue
 
@@ -33,7 +34,6 @@ def login_form():
     )
 
 
-# TODO: allow GET and skip form? or select is enough
 @app.route("/login", methods=["POST"])
 def login():
     url = request.form.get("url")
@@ -61,8 +61,6 @@ def login():
     return redirect(url_for("select"))
 
 
-# TODO: protect route (@authenticated)
-# and maybe pass url, username, password from decorator or helper
 @app.route("/select")
 def select():
     return render_template(
@@ -72,8 +70,9 @@ def select():
     )
 
 
-# TODO: protect route (@authenticated)
 @app.route("/select/preview", methods=["POST"])
+# TODO: pass url, username, password from decorator or helper
+@authenticated(redirect=False)
 def select_preview():
     url = session.get("url")
     username = session.get("username")
@@ -88,8 +87,8 @@ def select_preview():
     return render_template("fragments/select_preview.html.j2", results=results)
 
 
-# TODO: protect route (@authenticated)
 @app.route("/transform", methods=["POST"])
+@authenticated()
 def transform():
     url = session.get("url")
     username = session.get("username")
@@ -143,6 +142,7 @@ def transform_download_result(job_id: str):
 
 
 @app.route("/migrate/<job_id>", methods=["POST"])
+@authenticated()
 def migrate(job_id: str):
     transform_job = get_job(job_id)
     if not transform_job:

From 01569b6eea206f937979f71e7e66bcd4d6094870 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Alexandre=20Bult=C3=A9?= <alexandre@bulte.net>
Date: Mon, 9 Sep 2024 11:45:25 +0200
Subject: [PATCH 3/6] add connection_infos helper

---
 ecospheres_migrator/app.py  | 18 +++++-------------
 ecospheres_migrator/auth.py | 25 +++++++++++++++++++++++++
 2 files changed, 30 insertions(+), 13 deletions(-)
 create mode 100644 ecospheres_migrator/auth.py

diff --git a/ecospheres_migrator/app.py b/ecospheres_migrator/app.py
index 48c6c71..0e5d55d 100644
--- a/ecospheres_migrator/app.py
+++ b/ecospheres_migrator/app.py
@@ -16,7 +16,7 @@
     url_for,
 )
 
-from ecospheres_migrator.auth import authenticated
+from ecospheres_migrator.auth import authenticated, connection_infos
 from ecospheres_migrator.migrator import Migrator
 from ecospheres_migrator.queue import get_job, get_queue
 
@@ -71,12 +71,9 @@ def select():
 
 
 @app.route("/select/preview", methods=["POST"])
-# TODO: pass url, username, password from decorator or helper
 @authenticated(redirect=False)
 def select_preview():
-    url = session.get("url")
-    username = session.get("username")
-    password = session.get("password")
+    url, username, password = connection_infos()
     if not url:
         return "Veuillez entrer une URL de catalogue"
     query = request.form.get("query")
@@ -90,11 +87,7 @@ def select_preview():
 @app.route("/transform", methods=["POST"])
 @authenticated()
 def transform():
-    url = session.get("url")
-    username = session.get("username")
-    password = session.get("password")
-    if not url:
-        abort(400, "Missing `url` parameter")
+    url, username, password = connection_infos()
     query = request.form.get("query")
     if not query:
         abort(400, "Missing `query` parameter")
@@ -147,15 +140,14 @@ def migrate(job_id: str):
     transform_job = get_job(job_id)
     if not transform_job:
         abort(404)
-    username = session["username"]
-    password = session["password"]
+    url, username, password = connection_infos()
     mode = request.form.get("mode")
     group = request.form.get("group")
     overwrite = mode == "overwrite"
     if not overwrite and not group:
         # TODO: display group field only when needed
         abort(400, "Missing `group` parameter")
-    migrator = Migrator(url=session["url"], username=username, password=password)
+    migrator = Migrator(url=url, username=username, password=password)
     migrate_job = get_queue().enqueue(
         migrator.migrate, transform_job.result, overwrite=overwrite, group=group
     )
diff --git a/ecospheres_migrator/auth.py b/ecospheres_migrator/auth.py
new file mode 100644
index 0000000..1f6275c
--- /dev/null
+++ b/ecospheres_migrator/auth.py
@@ -0,0 +1,25 @@
+from functools import wraps
+
+from flask import abort, flash, session, url_for
+from flask import redirect as flask_redirect
+
+
+def authenticated(redirect: bool = True):
+    def decorator(f):
+        @wraps(f)
+        def decorated_function(*args, **kwargs):
+            if not all(k in session for k in ("url", "username", "password")):
+                if redirect:
+                    flash("Pas d'information de connexion trouvée en session", "error")
+                    return flask_redirect(url_for("login_form"))
+                else:
+                    abort(401, "Pas d'information de connexion trouvée en session")
+            return f(*args, **kwargs)
+
+        return decorated_function
+
+    return decorator
+
+
+def connection_infos() -> tuple[str, str, str]:
+    return session["url"], session["username"], session["password"]

From 8002475ac408a02541e6052830d8c6b3e3726dc5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Alexandre=20Bult=C3=A9?= <alexandre@bulte.net>
Date: Mon, 9 Sep 2024 11:53:36 +0200
Subject: [PATCH 4/6] remove print

---
 ecospheres_migrator/app.py | 1 -
 1 file changed, 1 deletion(-)

diff --git a/ecospheres_migrator/app.py b/ecospheres_migrator/app.py
index 0e5d55d..944fe18 100644
--- a/ecospheres_migrator/app.py
+++ b/ecospheres_migrator/app.py
@@ -45,7 +45,6 @@ def login():
     migrator = Migrator(url=url, username=username, password=password)
     try:
         gn_info = migrator.gn.info()
-        print("GN info", gn_info)
     except requests.exceptions.HTTPError as e:
         flash(f"Problème d'authentification ({e})", "error")
         return redirect(url_for("login_form"))

From 92e1b19f4e1755e457027c071d73856597962e79 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Alexandre=20Bult=C3=A9?= <alexandre@bulte.net>
Date: Wed, 11 Sep 2024 07:59:03 +0200
Subject: [PATCH 5/6] review: catch RequestException

---
 ecospheres_migrator/app.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/ecospheres_migrator/app.py b/ecospheres_migrator/app.py
index 944fe18..b0dc3be 100644
--- a/ecospheres_migrator/app.py
+++ b/ecospheres_migrator/app.py
@@ -45,7 +45,7 @@ def login():
     migrator = Migrator(url=url, username=username, password=password)
     try:
         gn_info = migrator.gn.info()
-    except requests.exceptions.HTTPError as e:
+    except requests.exceptions.RequestException as e:
         flash(f"Problème d'authentification ({e})", "error")
         return redirect(url_for("login_form"))
     else:

From 84f5390b672f3427ad6d11af1da06a69cbf91929 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Alexandre=20Bult=C3=A9?= <alexandre@bulte.net>
Date: Wed, 11 Sep 2024 10:50:26 +0200
Subject: [PATCH 6/6] review: catch migrator init exception

---
 ecospheres_migrator/app.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/ecospheres_migrator/app.py b/ecospheres_migrator/app.py
index b0dc3be..39251c7 100644
--- a/ecospheres_migrator/app.py
+++ b/ecospheres_migrator/app.py
@@ -42,8 +42,8 @@ def login():
     if not username or not password or not url:
         abort(400, "Missing login parameter(s)")
 
-    migrator = Migrator(url=url, username=username, password=password)
     try:
+        migrator = Migrator(url=url, username=username, password=password)
         gn_info = migrator.gn.info()
     except requests.exceptions.RequestException as e:
         flash(f"Problème d'authentification ({e})", "error")