From aae19268406e715425348e89a732d21380ec706f Mon Sep 17 00:00:00 2001
From: Steffen Jost <s.jost@fraport.de>
Date: Thu, 26 Oct 2023 17:55:20 +0200
Subject: [PATCH] chore(firm): add explanation to firm page and clean
 navigation

---
 .../utils/navigation/menu/de-de-formal.msg    |  2 +
 .../uniworx/utils/navigation/menu/en-eu.msg   |  2 +
 src/Foundation/Navigation.hs                  | 20 +++++++--
 src/Handler/Firm.hs                           | 21 ++++-----
 templates/i18n/firm-all/de-de-formal.hamlet   | 42 ++++++++++++++++++
 templates/i18n/firm-all/en-eu.hamlet          | 43 +++++++++++++++++++
 6 files changed, 116 insertions(+), 14 deletions(-)
 create mode 100644 templates/i18n/firm-all/de-de-formal.hamlet
 create mode 100644 templates/i18n/firm-all/en-eu.hamlet

diff --git a/messages/uniworx/utils/navigation/menu/de-de-formal.msg b/messages/uniworx/utils/navigation/menu/de-de-formal.msg
index 9e1c55f5a..373cfc0e6 100644
--- a/messages/uniworx/utils/navigation/menu/de-de-formal.msg
+++ b/messages/uniworx/utils/navigation/menu/de-de-formal.msg
@@ -134,6 +134,8 @@ MenuLmsLearners: Export Benutzer E‑Learning
 MenuLmsReport: Ergebnisse E‑Learning
 
 MenuFirms: Firmen
+MenuFirmUsers: Angehörige
+MenuFirmSupervisors: Ansprechpartner
 
 MenuSap: SAP Schnittstelle
 
diff --git a/messages/uniworx/utils/navigation/menu/en-eu.msg b/messages/uniworx/utils/navigation/menu/en-eu.msg
index 6145f0d81..c46f047da 100644
--- a/messages/uniworx/utils/navigation/menu/en-eu.msg
+++ b/messages/uniworx/utils/navigation/menu/en-eu.msg
@@ -135,6 +135,8 @@ MenuLmsLearners: E‑learning Users
 MenuLmsReport: E‑learning Results
 
 MenuFirms: Companies
+MenuFirmUsers: Associates
+MenuFirmSupervisors: Supervisors
 
 MenuSap: SAP Interface 
 
diff --git a/src/Foundation/Navigation.hs b/src/Foundation/Navigation.hs
index 4c405b25f..e53e6b3ae 100644
--- a/src/Foundation/Navigation.hs
+++ b/src/Foundation/Navigation.hs
@@ -123,10 +123,10 @@ breadcrumb ProblemFbutNoR       = i18nCrumb MsgProblemsRWithoutFHeading   $ Just
 breadcrumb ProblemAvsSynchR     = i18nCrumb MsgProblemsAvsSynchHeading    $ Just AdminProblemsR
 breadcrumb ProblemAvsErrorR     = i18nCrumb MsgProblemsAvsErrorHeading    $ Just ProblemAvsSynchR
 
-breadcrumb FirmAllR         = i18nCrumb MsgMenuFirms            Nothing
-breadcrumb FirmR{}          = i18nCrumb MsgMenuFirms          $ Just FirmAllR
-breadcrumb FirmUsersR{}     = i18nCrumb MsgMenuFirms          $ Just FirmAllR
-breadcrumb FirmSupersR{}    = i18nCrumb MsgMenuFirms          $ Just FirmAllR
+breadcrumb FirmAllR         = i18nCrumb MsgMenuFirms              Nothing
+breadcrumb FirmR{}          = i18nCrumb MsgMenuAdminHeading     $ Just   FirmAllR  -- TODO: change heading or remove
+breadcrumb FirmUsersR{}     = i18nCrumb MsgMenuFirmUsers        $ Just   FirmAllR
+breadcrumb (FirmSupersR fsh)= i18nCrumb MsgMenuFirmSupervisors  $ Just $ FirmUsersR fsh
 
 breadcrumb PrintCenterR     = i18nCrumb MsgMenuApc              Nothing
 breadcrumb PrintSendR       = i18nCrumb MsgMenuPrintSend      $ Just PrintCenterR
@@ -2425,6 +2425,18 @@ pageActions (FirmR fsh) = return
     , navChildren = []
     }
   ]
+pageActions (FirmUsersR fsh) = return
+  [ NavPageActionPrimary
+    { navLink = defNavLink MsgTableCompanyNrSupers $ FirmSupersR fsh
+    , navChildren = []
+    }  
+  ]
+pageActions (FirmSupersR fsh) = return
+  [ NavPageActionPrimary
+    { navLink = defNavLink MsgTableCompanyNrUsers  $ FirmUsersR fsh
+    , navChildren = []
+    }
+  ]
 pageActions PrintCenterR = do
   openDays <- useRunDB $ Ex.select $ do
     pj <- Ex.from $ Ex.table @PrintJob
diff --git a/src/Handler/Firm.hs b/src/Handler/Firm.hs
index f49fd755f..62e4a3079 100644
--- a/src/Handler/Firm.hs
+++ b/src/Handler/Firm.hs
@@ -65,6 +65,9 @@ postFirmR fsh = do
   siteLayoutMsg (SomeMessage fsh) $ do
     setTitle $ citext2Html fsh
     [whamlet|
+      <h2>PROVISORISCHE DEBUG SEITE 
+      <p>Diese Seite wird in der finalen Version nicht mehr enthalten sein.
+
       <h3>#{length csuper} Company Default Supervisors (non-foreign only)
       <ul>
         $forall u <- csuper
@@ -177,7 +180,7 @@ firmCountEmployeeSupervised = E.subSelectCount . fromUserCompany (Just fltr)
 
 firmCountEmployeeRerouted :: E.SqlExpr (Entity Company) -> E.SqlExpr (E.Value Word64)
 firmCountEmployeeRerouted = E.subSelectCount . fromUserCompany (Just fltr)
-  where 
+  where   
     fltr usrc = E.exists $ do
       usrSuper <- E.from $ E.table @UserSupervisor
       E.where_ $ usrSuper E.^. UserSupervisorUser E.==. usrc E.^. UserCompanyUser
@@ -257,18 +260,19 @@ mkFirmAllTable isAdmin uid = do
           [ if not isAdmin then mempty else -- guardOnM idAdmin $
             dbSelect (applying _2) id (return . view (resultAllCompanyEntity . _entityKey))
           , sortable (Just "name")          (i18nCell MsgTableCompany)                 $ \(view resultAllCompany -> firm) ->
-              anchorCell (FirmR $ companyShorthand firm) . toWgt $ companyName firm
+              anchorCell (FirmUsersR $ companyShorthand firm) . toWgt $ companyName firm
           , sortable (Just "short")         (i18nCell MsgTableCompanyShort)            $ \(view resultAllCompany -> firm) ->
               let fsh = companyShorthand firm
-              in  anchorCell (FirmR fsh) $ toWgt fsh
+              in  anchorCell (FirmUsersR fsh) $ toWgt fsh
           , sortable (Just "avsnr")         (i18nCell MsgTableCompanyNo)               $ \(view resultAllCompany -> firm) ->
               anchorCell (FirmR $ companyShorthand firm) $ toWgt $ companyAvsId firm
           , sortable (Just "users")         (i18nCell MsgTableCompanyNrUsers)          $ \(view resultAllCompanyUsers               -> nr) -> wgtCell $ word2widget nr
-          , sortable (Just "supervisors")   (i18nCell MsgTableCompanyNrSupersDefault)  $ \(view resultAllCompanySupervisors         -> nr) -> wgtCell $ word2widget nr
+          , sortable (Just "supervisors")   (i18nCell MsgTableCompanyNrSupersDefault)  $ \row -> 
+              anchorCell (FirmSupersR $ row ^. resultAllCompany . _companyShorthand) $ word2widget $ row ^. resultAllCompanySupervisors
+          , sortable (Just "reroute-def")   (i18nCell MsgTableCompanyNrRerouteDefault) $ \(view resultAllCompanyDefaultReroutes     -> nr) -> wgtCell $ word2widget nr
           , sortable (Just "emp-supervised")(i18nCell MsgTableCompanyNrEmpSupervised)  $ \(view resultAllCompanyEmployeeSupervised  -> nr) -> wgtCell $ word2widget nr
           , sortable (Just "emp-rerouted")  (i18nCell MsgTableCompanyNrEmpRerouted)    $ \(view resultAllCompanyEmployeeRerouted    -> nr) -> wgtCell $ word2widget nr
-          , sortable (Just "emp-rer-post")  (i18nCell MsgTableCompanyNrEmpRerPost)     $ \(view resultAllCompanyEmpRerPost          -> nr) -> wgtCell $ word2widget nr
-          , sortable (Just "reroute-def")   (i18nCell MsgTableCompanyNrRerouteDefault) $ \(view resultAllCompanyDefaultReroutes     -> nr) -> wgtCell $ word2widget nr
+          , sortable (Just "emp-rer-post")  (i18nCell MsgTableCompanyNrEmpRerPost)     $ \(view resultAllCompanyEmpRerPost          -> nr) -> wgtCell $ word2widget nr          
           , sortable (Just "foreigners")    (i18nCell MsgTableCompanyNrForeignSupers)  $ \(view resultAllCompanyForeignSupers       -> nr) -> wgtCell $ word2widget nr
           , sortable (Just "reroute-act")   (i18nCell MsgTableCompanyNrRerouteActive)  $ \(view resultAllCompanyActiveReroutes      -> nr) -> wgtCell $ word2widget nr
           , sortable (Just "reroute-all")   (i18nCell MsgTableCompanyNrRerouteActive)  $ \(view resultAllCompanyActiveReroutes'     -> nr) -> wgtCell $ word2widget nr
@@ -352,10 +356,7 @@ postFirmAllR = do
     (FirmAllActResetSupervisionData, fids) -> addMessage Info $ text2Html $ "Reset "  <> tshow (length fids) <> " companies. TODO"
   siteLayoutMsg MsgMenuFirms $ do
     setTitleI MsgMenuFirms
-    --     $(widgetFile "firm-all")
-    [whamlet|!!!STUB!!!TO DO!!!
-        ^{firmTable}
-    |]
+    $(i18nWidgetFile "firm-all")
 
 
 -----------------------
diff --git a/templates/i18n/firm-all/de-de-formal.hamlet b/templates/i18n/firm-all/de-de-formal.hamlet
new file mode 100644
index 000000000..e4e59fc3e
--- /dev/null
+++ b/templates/i18n/firm-all/de-de-formal.hamlet
@@ -0,0 +1,42 @@
+$newline never
+
+$# SPDX-FileCopyrightText: 2023 Steffen Jost <s.jost@fraport.de>
+$#
+$# SPDX-License-Identifier: AGPL-3.0-or-later
+
+<section>
+
+
+  <p>
+    Die Daten der Firmen wurden aus dem Ausweisverwaltungssystem (AVS) der Fraport AG
+    importiert und werden regelmäßig aktualisiert, 
+    wenn Fahrlizenzinhaber oder deren Verwalter über das AVS einer Firma zugeordnet wurden.
+  <p>
+    ^{firmTable}
+
+  <h3> Hinweis zur Entwicklungsversion
+  <p>
+    Die Spalten zeigen derzeit folgende Informationen
+      <ol>
+        <li> Firmenname
+        <li> Firmenkürzel
+        <li> AVS Firmennummer
+        <li> Anzahl der derzeit zugeordneten Firmenangehörigen. Eine Personen kann mehreren Firmen gleichzeitig angehören.
+        <li> Anzahl der Standard Ansprechpartner, welche einer neu in FRADrive eingetragnen Person dieser Firma derzeit zugeordnet werden. Eine Person kann beliebig viele Ansprechpartner haben. Wirkt sich nicht auf vorhandene Firmenangehörige aus.
+        <li> Anzahl der Standard Ansprechpartner der Firma mit Benachrichtigungsumleitung. Hat eine Person mehrere Ansprechpartner mit Umleitung, so wird ein Brief oder Email an alle Ansprechpartner verschickt. #
+             Ein Person kann auch ihr eigener Ansprechpartner sein, um eine Benachrichtigung sowohl an die Person selbst als auch an einen Ansprechpartner zu senden. #
+             Wirkt sich nicht auf vorhandene Firmenangehörige aus, sondern nur auf neu in FRADrive hinzukommende Firmenangehörige.
+        <li> Anzahl Firmenangehörige, für die derzeit mindestens ein Ansprechpartner eingetragen ist. Ansprechpartner müssen nicht notwendigerweise der gleichen Firma angehören!
+        <li> Anzahl Firmenangehörige, für die derzeit mindestens eine Benachrichtigungsumleitung an einen Ansprechpartner eingetragen ist. Ansprechpartner müssen nicht notwendigerweise der gleichen Firma angehören!
+        <li> Anzahl Firmenangehörige, für die derzeit mindestens eine Benachrichtigungsumleitung an einen Ansprechpartner eingetragen ist, welcher den Versand per Briefpost bevorzugt. #
+             Ob ein Ansprechpartner Email oder Briefpost wünscht ist eine individuelle Einstellung des Ansprechpartners und gilt für alle Benachrichtigungen an diesen Ansprechpartner.
+        <li> Anzahl der firmenfremden Ansprechpartner, welche mindestens einen Firmenangehörigen betreuen. Bei manchen Firmen ist es normal, dass die Ansprechpartner einer anderen Firma angehören, aber oft ist nur ein Fehler durch Firmenwechsel.
+        <li> Anzahl der Ansprechpartner mit derzeit aktiver Benachrichtigungsumleitung, egal ob Brief oder Email.
+        <li> Gesamtzahl der Brief und Emails, welche bei Benachrichtigung aller Firmenangehörigen derzeit verschickt würden. 
+          <p>
+            Dies ist also die Gesamtzahl aller derzeit aktiven Benachrichtigungsumleitungen. 
+          <p>
+            <em>
+              Beispiel: Für eine Firma mit 2 Angehörigen, für die ein Mitarbeiter 1 Ansprechpartner mit aktiver Umleitung und einen Mitarbeiter mit 3 Ansprechpartnern mit aktiver Umleitung hätte, #
+              würde hier die Zahl 4 stehen, da bei einer Benachrichtigung an beide Mitarbeiter insgesamt 4 Briefe oder Emails versendet würden.
+
diff --git a/templates/i18n/firm-all/en-eu.hamlet b/templates/i18n/firm-all/en-eu.hamlet
new file mode 100644
index 000000000..d1a659458
--- /dev/null
+++ b/templates/i18n/firm-all/en-eu.hamlet
@@ -0,0 +1,43 @@
+$newline never
+
+$# SPDX-FileCopyrightText: 2023 Steffen Jost <s.jost@fraport.de>
+$#
+$# SPDX-License-Identifier: AGPL-3.0-or-later
+
+<section>
+
+
+  <p>
+    Data of all companies that were taken from the id card management system (AVS) of Fraport AG.
+    A company is importet and regularly update if a driving licence holder or their supervisor
+    are associated with that company through the AVS.
+
+  <p>
+    ^{firmTable}
+
+  <h3>Development Version Notes (TODO: translated paragraph)
+  <p>
+    Die Spalten zeigen derzeit folgende Informationen
+      <ol>
+        <li> Firmenname
+        <li> Firmenkürzel
+        <li> AVS Firmennummer
+        <li> Anzahl der derzeit zugeordneten Firmenangehörigen. Eine Personen kann mehreren Firmen gleichzeitig angehören.
+        <li> Anzahl der Standard Ansprechpartner, welche einer neu in FRADrive eingetragnen Person dieser Firma derzeit zugeordnet werden. Eine Person kann beliebig viele Ansprechpartner haben. Wirkt sich nicht auf vorhandene Firmenangehörige aus.
+        <li> Anzahl der Standard Ansprechpartner der Firma mit Benachrichtigungsumleitung. Hat eine Person mehrere Ansprechpartner mit Umleitung, so wird ein Brief oder Email an alle Ansprechpartner verschickt. #
+             Ein Person kann auch ihr eigener Ansprechpartner sein, um eine Benachrichtigung sowohl an die Person selbst als auch an einen Ansprechpartner zu senden. #
+             Wirkt sich nicht auf vorhandene Firmenangehörige aus, sondern nur auf neu in FRADrive hinzukommende Firmenangehörige.
+        <li> Anzahl Firmenangehörige, für die derzeit mindestens ein Ansprechpartner eingetragen ist. Ansprechpartner müssen nicht notwendigerweise der gleichen Firma angehören!
+        <li> Anzahl Firmenangehörige, für die derzeit mindestens eine Benachrichtigungsumleitung an einen Ansprechpartner eingetragen ist. Ansprechpartner müssen nicht notwendigerweise der gleichen Firma angehören!
+        <li> Anzahl Firmenangehörige, für die derzeit mindestens eine Benachrichtigungsumleitung an einen Ansprechpartner eingetragen ist, welcher den Versand per Briefpost bevorzugt. #
+             Ob ein Ansprechpartner Email oder Briefpost wünscht ist eine individuelle Einstellung des Ansprechpartners und gilt für alle Benachrichtigungen an diesen Ansprechpartner.
+        <li> Anzahl der firmenfremden Ansprechpartner, welche mindestens einen Firmenangehörigen betreuen. Bei manchen Firmen ist es normal, dass die Ansprechpartner einer anderen Firma angehören, aber oft ist nur ein Fehler durch Firmenwechsel.
+        <li> Anzahl der Ansprechpartner mit derzeit aktiver Benachrichtigungsumleitung, egal ob Brief oder Email.
+        <li> Gesamtzahl der Brief und Emails, welche bei Benachrichtigung aller Firmenangehörigen derzeit verschickt würden. 
+          <p>
+            Dies ist also die Gesamtzahl aller derzeit aktiven Benachrichtigungsumleitungen. 
+          <p>
+            <em>
+              Beispiel: Für eine Firma mit 2 Angehörigen, für die ein Mitarbeiter 1 Ansprechpartner mit aktiver Umleitung und einen Mitarbeiter mit 3 Ansprechpartnern mit aktiver Umleitung hätte, #
+              würde hier die Zahl 4 stehen, da bei einer Benachrichtigung an beide Mitarbeiter insgesamt 4 Briefe oder Emails versendet würden.
+