From ee46c5c6a74bf4041049d72e2c13dd9925f075e1 Mon Sep 17 00:00:00 2001
From: Maxime Besson <maxime.besson@worteks.com>
Date: Thu, 20 Aug 2020 00:26:55 +0200
Subject: [PATCH] Add an option to change the doc URL prefix (#2285)

---
 Makefile                                                    | 2 ++
 lemonldap-ng-common/lemonldap-ng.ini                        | 2 ++
 lemonldap-ng-manager/lib/Lemonldap/NG/Manager.pm            | 6 +++++-
 lemonldap-ng-manager/site/htdocs/static/languages/ar.json   | 1 -
 lemonldap-ng-manager/site/htdocs/static/languages/en.json   | 1 -
 lemonldap-ng-manager/site/htdocs/static/languages/es.json   | 1 -
 lemonldap-ng-manager/site/htdocs/static/languages/fr.json   | 1 -
 lemonldap-ng-manager/site/htdocs/static/languages/he.json   | 1 -
 lemonldap-ng-manager/site/htdocs/static/languages/it.json   | 1 -
 lemonldap-ng-manager/site/htdocs/static/languages/pl.json   | 1 -
 lemonldap-ng-manager/site/htdocs/static/languages/tr.json   | 1 -
 lemonldap-ng-manager/site/htdocs/static/languages/vi.json   | 1 -
 lemonldap-ng-manager/site/htdocs/static/languages/zh.json   | 1 -
 .../site/htdocs/static/languages/zh_TW.json                 | 1 -
 lemonldap-ng-manager/site/templates/api.tpl                 | 2 +-
 lemonldap-ng-manager/site/templates/manager.tpl             | 2 +-
 lemonldap-ng-manager/site/templates/viewer.tpl              | 2 +-
 17 files changed, 12 insertions(+), 15 deletions(-)

diff --git a/Makefile b/Makefile
index bc0f9777e..892a749bb 100644
--- a/Makefile
+++ b/Makefile
@@ -65,6 +65,7 @@ MANAGERSITEDIR=$(MANAGERDIR)/htdocs
 MANAGERAPIDIR=$(MANAGERDIR)/api
 MANAGERSTATICDIR=$(MANAGERSITEDIR)/static
 MANAGERRELATIVESTATICDIR=/static
+MANAGERRELATIVEDOCDIR=/doc
 MANAGERTEMPLATESDIR=$(MANAGERSITEDIR)/templates
 DOCDIR=$(DOCUMENTROOT)
 DEFDOCDIR=$(DOCUMENTROOT)/doc
@@ -806,6 +807,7 @@ install_manager_site:	install_conf_dir
 	@rm -rf $$(find ${RMANAGERSTATICDIR} \
 		$(RMANAGERTEMPLATESDIR) $(RCONFDIR) -type d -name .svn)
 	@$(PERL) -i -pe 's#__MANAGERSTATICDIR__#$(MANAGERRELATIVESTATICDIR)#g' $(RCONFDIR)/$(CONFFILENAME)
+	@$(PERL) -i -pe 's#__MANAGERDOCDIR__#$(MANAGERRELATIVEDOCDIR)#g' $(RCONFDIR)/$(CONFFILENAME)
 	@$(PERL) -i -pe 's#__MANAGERTEMPLATESDIR__#$(MANAGERTEMPLATESDIR)#g' $(RCONFDIR)/$(CONFFILENAME)
 
 install_portal_site:	install_conf_dir
diff --git a/lemonldap-ng-common/lemonldap-ng.ini b/lemonldap-ng-common/lemonldap-ng.ini
index 96dd33103..cf39453ae 100644
--- a/lemonldap-ng-common/lemonldap-ng.ini
+++ b/lemonldap-ng-common/lemonldap-ng.ini
@@ -376,6 +376,8 @@ protection   = manager
 
 ; staticPrefix: relative (or URL) location of static HTML components
 staticPrefix = __MANAGERSTATICDIR__
+; docPrefix: relative (or URL) location of embedded documentation
+docPrefix = __MANAGERDOCDIR__
 
 ; instanceName: Display current LLNG instance into Manager
 ;instanceName = Demo
diff --git a/lemonldap-ng-manager/lib/Lemonldap/NG/Manager.pm b/lemonldap-ng-manager/lib/Lemonldap/NG/Manager.pm
index 8dadc7bf0..cd88ffbaf 100644
--- a/lemonldap-ng-manager/lib/Lemonldap/NG/Manager.pm
+++ b/lemonldap-ng-manager/lib/Lemonldap/NG/Manager.pm
@@ -167,7 +167,11 @@ sub tplParams {
     my $res = eval {
         $self->hLoadedPlugins->{viewer}->brwRule->( $req, $req->{userData} );
     } || 0;
-    return ( VERSION => $VERSION, ALLOWBROWSER => $res );
+    return (
+        VERSION      => $VERSION,
+        ALLOWBROWSER => $res,
+        DOC_PREFIX   => ( $self->{docPrefix} || '/doc' ),
+    );
 }
 
 sub javascript {
diff --git a/lemonldap-ng-manager/site/htdocs/static/languages/ar.json b/lemonldap-ng-manager/site/htdocs/static/languages/ar.json
index 3e27afb09..7b1e72593 100644
--- a/lemonldap-ng-manager/site/htdocs/static/languages/ar.json
+++ b/lemonldap-ng-manager/site/htdocs/static/languages/ar.json
@@ -1,5 +1,4 @@
 {
-"/doc/":"/doc/",
 "2faSessions":"2ndFA sessions explorer",
 "2ndFA":"Second Factors",
 "ADPwdExpireWarning":"تحذير انتهاء صلاحية كلمة المرور",
diff --git a/lemonldap-ng-manager/site/htdocs/static/languages/en.json b/lemonldap-ng-manager/site/htdocs/static/languages/en.json
index 7ae26df74..b88d726fc 100644
--- a/lemonldap-ng-manager/site/htdocs/static/languages/en.json
+++ b/lemonldap-ng-manager/site/htdocs/static/languages/en.json
@@ -1,5 +1,4 @@
 {
-"/doc/":"/doc/",
 "2faSessions":"2ndFA sessions explorer",
 "2ndFA":"Second Factors",
 "ADPwdExpireWarning":"Password expire warning",
diff --git a/lemonldap-ng-manager/site/htdocs/static/languages/es.json b/lemonldap-ng-manager/site/htdocs/static/languages/es.json
index 1062ab18b..e19b5051c 100644
--- a/lemonldap-ng-manager/site/htdocs/static/languages/es.json
+++ b/lemonldap-ng-manager/site/htdocs/static/languages/es.json
@@ -1,5 +1,4 @@
 {
-"/doc/":"/doc/",
 "2faSessions":"Explorador de sesiones 2snFA",
 "2ndFA":"Segundos Factores",
 "ADPwdExpireWarning":"Alerta de caducidad de la contraseña",
diff --git a/lemonldap-ng-manager/site/htdocs/static/languages/fr.json b/lemonldap-ng-manager/site/htdocs/static/languages/fr.json
index 23050a177..f7fa50c31 100644
--- a/lemonldap-ng-manager/site/htdocs/static/languages/fr.json
+++ b/lemonldap-ng-manager/site/htdocs/static/languages/fr.json
@@ -1,5 +1,4 @@
 {
-"/doc/":"/doc/",
 "2faSessions":"Explorateur sessions 2ndFA",
 "2ndFA":"Seconds Facteurs",
 "ADPwdExpireWarning":"Avertissement avant expiration du mot de passe",
diff --git a/lemonldap-ng-manager/site/htdocs/static/languages/he.json b/lemonldap-ng-manager/site/htdocs/static/languages/he.json
index f15bdf6dd..37c722e9c 100644
--- a/lemonldap-ng-manager/site/htdocs/static/languages/he.json
+++ b/lemonldap-ng-manager/site/htdocs/static/languages/he.json
@@ -1,5 +1,4 @@
 {
-"/doc/":"/doc/",
 "2faSessions":"חוקר הפעלות אימות דו־שלבי",
 "2ndFA":"גורמים נוספים",
 "ADPwdExpireWarning":"אזהרת תפוגת סיסמה",
diff --git a/lemonldap-ng-manager/site/htdocs/static/languages/it.json b/lemonldap-ng-manager/site/htdocs/static/languages/it.json
index 70c4d465e..013b4a2f0 100644
--- a/lemonldap-ng-manager/site/htdocs/static/languages/it.json
+++ b/lemonldap-ng-manager/site/htdocs/static/languages/it.json
@@ -1,5 +1,4 @@
 {
-"/doc/":"/doc/",
 "2faSessions":"Esploratore di sessioni 2ndFA",
 "2ndFA":"Secondi fattori",
 "ADPwdExpireWarning":"Avviso di scadenza password",
diff --git a/lemonldap-ng-manager/site/htdocs/static/languages/pl.json b/lemonldap-ng-manager/site/htdocs/static/languages/pl.json
index fbac50aee..9c446af5b 100644
--- a/lemonldap-ng-manager/site/htdocs/static/languages/pl.json
+++ b/lemonldap-ng-manager/site/htdocs/static/languages/pl.json
@@ -1,5 +1,4 @@
 {
-"/doc/":"/doc/",
 "2faSessions":"Eksplorator sesji 2ndFA",
 "2ndFA":"Drugie czynniki",
 "ADPwdExpireWarning":"Ostrzeżenie o wygaśnięciu hasła",
diff --git a/lemonldap-ng-manager/site/htdocs/static/languages/tr.json b/lemonldap-ng-manager/site/htdocs/static/languages/tr.json
index aa605b949..a46a79586 100644
--- a/lemonldap-ng-manager/site/htdocs/static/languages/tr.json
+++ b/lemonldap-ng-manager/site/htdocs/static/languages/tr.json
@@ -1,5 +1,4 @@
 {
-"/doc/":"/doc/",
 "2faSessions":"2ndFA oturumları gezgini",
 "2ndFA":"İki Faktörlü Kimlik Doğrulama",
 "ADPwdExpireWarning":"Parola kullanım süresi uyarısı",
diff --git a/lemonldap-ng-manager/site/htdocs/static/languages/vi.json b/lemonldap-ng-manager/site/htdocs/static/languages/vi.json
index 685f88293..98cea0e64 100644
--- a/lemonldap-ng-manager/site/htdocs/static/languages/vi.json
+++ b/lemonldap-ng-manager/site/htdocs/static/languages/vi.json
@@ -1,5 +1,4 @@
 {
-"/doc/":"/doc/",
 "2faSessions":"2ndFA sessions explorer",
 "2ndFA":"Second Factors",
 "ADPwdExpireWarning":"Cảnh báo mật khẩu hết hạn",
diff --git a/lemonldap-ng-manager/site/htdocs/static/languages/zh.json b/lemonldap-ng-manager/site/htdocs/static/languages/zh.json
index 84b7b021c..bc2231811 100644
--- a/lemonldap-ng-manager/site/htdocs/static/languages/zh.json
+++ b/lemonldap-ng-manager/site/htdocs/static/languages/zh.json
@@ -1,5 +1,4 @@
 {
-"/doc/":"/zh-doc/",
 "2faSessions":"雙因素驗證工作階段探索程式",
 "2ndFA":"雙因素",
 "ADPwdExpireWarning":"密码过期警告",
diff --git a/lemonldap-ng-manager/site/htdocs/static/languages/zh_TW.json b/lemonldap-ng-manager/site/htdocs/static/languages/zh_TW.json
index e74bba6f2..444d61af7 100644
--- a/lemonldap-ng-manager/site/htdocs/static/languages/zh_TW.json
+++ b/lemonldap-ng-manager/site/htdocs/static/languages/zh_TW.json
@@ -1,5 +1,4 @@
 {
-"/doc/":"/doc/",
 "2faSessions":"雙因素驗證工作階段探索程式",
 "2ndFA":"雙因素",
 "ADPwdExpireWarning":"密碼過期警告",
diff --git a/lemonldap-ng-manager/site/templates/api.tpl b/lemonldap-ng-manager/site/templates/api.tpl
index f07d325cf..0a7d1debe 100644
--- a/lemonldap-ng-manager/site/templates/api.tpl
+++ b/lemonldap-ng-manager/site/templates/api.tpl
@@ -7,7 +7,7 @@
     <div class="container text-center">
         <h1>LemonLDAP::NG Manager API</h1>
         <hr />
-        <a href="/doc/pages/manager-api/index.html" class="btn btn-lg btn-primary">API Reference</a>
+        <a href="<TMPL_VAR NAME="DOC_PREFIX">/pages/manager-api/index.html" class="btn btn-lg btn-primary">API Reference</a>
     </div>
 </body>
 </html>
diff --git a/lemonldap-ng-manager/site/templates/manager.tpl b/lemonldap-ng-manager/site/templates/manager.tpl
index ba67eb0d0..4e1b509f2 100644
--- a/lemonldap-ng-manager/site/templates/manager.tpl
+++ b/lemonldap-ng-manager/site/templates/manager.tpl
@@ -61,7 +61,7 @@
       <div id="bottom" ng-if="showH" class="hidden-xs">
         <div class="panel panel-default">
           <div class="panel-body">
-            <iframe id="helpframe" width="100%" height="100%" ng-src="{{translate('/doc/')+'pages/documentation/current/'+helpUrl}}" frameborder="0"></iframe>
+            <iframe id="helpframe" width="100%" height="100%" ng-src="{{'<TMPL_VAR NAME="DOC_PREFIX">/pages/documentation/current/'+helpUrl}}" frameborder="0"></iframe>
           </div>
         </div> 
       </div>
diff --git a/lemonldap-ng-manager/site/templates/viewer.tpl b/lemonldap-ng-manager/site/templates/viewer.tpl
index 95a777b18..6cde85cde 100644
--- a/lemonldap-ng-manager/site/templates/viewer.tpl
+++ b/lemonldap-ng-manager/site/templates/viewer.tpl
@@ -59,7 +59,7 @@
       <div id="bottom" ng-if="showH" class="hidden-xs">
         <div class="panel panel-default">
           <div class="panel-body">
-            <iframe id="helpframe" width="100%" height="100%" ng-src="{{translate('/doc/')+'pages/documentation/current/'+helpUrl}}" frameborder="0"></iframe>
+            <iframe id="helpframe" width="100%" height="100%" ng-src="{{'<TMPL_VAR NAME="DOC_PREFIX">/pages/documentation/current/'+helpUrl}}" frameborder="0"></iframe>
           </div>
         </div>
       </div>