erp5_web_renderjs_ui: add an access page gadget

This gadget can be used to replicate the xhtml access page.

erp5_web_renderjs_ui: add an access page gadget
This gadget can be used to replicate the xhtml access page.
2f0fd720 · Romain Courteaud · 965b7189 · 2f0fd720 · 2f0fd720 · 2f0fd720
Commit 2f0fd720 authored Feb 04, 2021 by Romain Courteaud
6 changed files
--- a/bt5/erp5_web_renderjs_ui/PathTemplateItem/web_page_module/rjs_gadget_erp5_page_access_html.html
+++ b/bt5/erp5_web_renderjs_ui/PathTemplateItem/web_page_module/rjs_gadget_erp5_page_access_html.html
+<!DOCTYPE html>
+<html>
+  <!--
+    data-i18n=Home
+  -->
+  <head>
+    <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
+    <meta name="viewport" content="width=device-width" />
+    <title>ERP5 Access</title>
+    <link rel="http://www.renderjs.org/rel/interface" href="interface_page.html">
+
+    <!-- renderjs -->
+    <script src="rsvp.js" type="text/javascript"></script>
+    <script src="renderjs.js" type="text/javascript"></script>
+
+    <!-- custom script -->
+    <script src="jiodev.js" type="text/javascript"></script>
+    <script src="gadget_global.js" type="text/javascript"></script>
+    <script src="domsugar.js" type="text/javascript"></script>
+
+    <script src="gadget_erp5_page_access.js" type="text/javascript"></script>
+
+  </head>
+  <body>
+    <ul>
+    </ul>
+  </body>
+</html>
\ No newline at end of file
--- a/bt5/erp5_web_renderjs_ui/PathTemplateItem/web_page_module/rjs_gadget_erp5_page_access_html.xml
+++ b/bt5/erp5_web_renderjs_ui/PathTemplateItem/web_page_module/rjs_gadget_erp5_page_access_html.xml
--- a/bt5/erp5_web_renderjs_ui/PathTemplateItem/web_page_module/rjs_gadget_erp5_page_access_js.js
+++ b/bt5/erp5_web_renderjs_ui/PathTemplateItem/web_page_module/rjs_gadget_erp5_page_access_js.js
+/*jslint nomen: true, indent: 2, maxerr: 3, maxlen: 80 */
+/*global domsugar, window, rJS, RSVP */
+(function (domsugar, window, rJS, RSVP) {
+  "use strict";
+
+  var URL_DISPLAY_PARAMETER = 'view',
+    MAIN_SCOPE = 'sub_gadget';
+
+  function searchERP5Action(gadget, jio_key, action_name) {
+    return gadget.jio_getAttachment(jio_key, 'links')
+      .push(function (document_view) {
+        var action, action_data, i, j;
+        for (i = 0; i < Object.keys(document_view._links).length; i = i + 1) {
+          action = Object.keys(document_view._links)[i];
+          if (document_view._links.hasOwnProperty(action)) {
+            if (document_view._links[action].constructor !== Array) {
+              document_view._links[action] = [document_view._links[action]];
+            }
+            for (j = 0;  j < document_view._links[action].length; j = j + 1) {
+              action_data = document_view._links[action][j];
+              if (action_data.name === action_name) {
+                return action_data.href;
+              }
+            }
+          }
+        }
+        throw new Error('Action not found: ' + action_name);
+      });
+  }
+
+  function loadChildGadget(gadget, gadget_url, must_declare, callback) {
+    var queue,
+      child_gadget;
+    if (must_declare) {
+      queue = gadget.declareGadget(gadget_url, {scope: MAIN_SCOPE});
+    } else {
+      queue = gadget.getDeclaredGadget(MAIN_SCOPE);
+    }
+    return queue
+      .push(function (result) {
+        child_gadget = result;
+        if (callback) {
+          return callback(result);
+        }
+      })
+      .push(function (result) {
+        if (must_declare) {
+          domsugar(gadget.element, [child_gadget.element]);
+        }
+        return result;
+      });
+  }
+
+  function renderEmbeddedForm(gadget, jio_key, action_name, must_declare) {
+    return searchERP5Action(gadget, jio_key, action_name)
+      .push(function (action_href) {
+        return loadChildGadget(gadget, "gadget_erp5_page_form.html",
+                               must_declare,
+                               function (form_gadget) {
+            return form_gadget.render({
+              jio_key: jio_key,
+              view: action_href
+            });
+          });
+      });
+  }
+
+  rJS(window)
+    /////////////////////////////////////////////////////////////////
+    // Acquired methods
+    /////////////////////////////////////////////////////////////////
+    .declareAcquiredMethod("updateHeader", "updateHeader")
+    .declareAcquiredMethod("updatePanel", "updatePanel")
+    .declareAcquiredMethod("getTranslationDict", "getTranslationDict")
+    .declareAcquiredMethod("getUrlForList", "getUrlForList")
+    .declareAcquiredMethod("redirect", "redirect")
+    .declareAcquiredMethod("jio_getAttachment", "jio_getAttachment")
+
+    .declareMethod('triggerSubmit', function () {
+      return;
+    })
+
+    .allowPublicAcquisition('updateHeader', function () {
+      return;
+    })
+    .allowPublicAcquisition('updatePanel', function () {
+      return;
+    })
+
+    ////////////////////////////////////////////////////////////////////
+    // Go
+    ////////////////////////////////////////////////////////////////////
+    .declareMethod('render', function (options, action_list) {
+      if (action_list === undefined) {
+        action_list = [];
+      }
+      return this.changeState({
+        display_step: options[URL_DISPLAY_PARAMETER] || undefined,
+        action_list: JSON.stringify(action_list),
+        // Force display in any case to refresh the menus
+        render_timestamp: new Date().getTime(),
+        first_render: true
+      });
+    })
+    .onStateChange(function (modification_dict) {
+      var gadget = this,
+        _,
+        action_list = JSON.parse(gadget.state.action_list),
+        url_list;
+
+      if ((gadget.state.display_step === undefined) &&
+          (action_list.length > 0)) {
+        // display the first action by default
+        return gadget.redirect({
+          command: 'change',
+          options: {
+            view: 0
+          }
+        });
+      }
+
+      return gadget.getTranslationDict(['Home'])
+        .push(function (translation_dict) {
+          _ = translation_dict;
+          var url_for_list = [{
+            command: 'history_previous'
+          }],
+            i;
+          for (i = 0; i < action_list.length; i += 1) {
+            url_for_list.push({
+              command: 'change',
+              options: {
+                view: i
+              }
+            });
+          }
+          return gadget.getUrlForList(url_for_list);
+        })
+        .push(function (result) {
+          url_list = result;
+          return gadget.updateHeader({
+            page_title: _.Home,
+            page_icon: 'home',
+            front_url: url_list[0]
+          });
+        })
+
+        .push(function () {
+          var first_render = modification_dict.hasOwnProperty('first_render'),
+            element_list = [],
+            i,
+            active,
+            matching_action_index = -1,
+            promise_list = [],
+            extra_menu_list = [];
+
+          // Try to display the matching action
+          for (i = 0; i < action_list.length; i += 1) {
+            if (gadget.state.display_step === i.toString()) {
+              matching_action_index = i;
+              active = true;
+            } else {
+              active = false;
+            }
+            // Prepare to display action list if no action found
+            element_list.push(
+              domsugar('li', [
+                domsugar('a', {
+                  href: url_list[i + 1],
+                  text: action_list[i].title
+                })
+              ])
+            );
+            extra_menu_list.push({
+              href: url_list[i + 1],
+              title: action_list[i].title,
+              active: active
+            });
+          }
+
+          if (matching_action_index === -1) {
+            // XXX hacky, but enough to force reloading the page gadget
+            // during the next render
+            gadget.state.first_render = false;
+            domsugar(gadget.element, [
+              domsugar('img', {src: 'gadget_erp5_panel.png'}),
+              domsugar('ul', {
+                'class': 'document-listview'
+              }, element_list)
+            ]);
+          } else {
+            promise_list.push(renderEmbeddedForm(
+              gadget,
+              action_list[matching_action_index].jio_key,
+              action_list[matching_action_index].erp5_action,
+              first_render
+            ));
+          }
+
+          promise_list.push(gadget.updatePanel({
+            extra_menu_list: extra_menu_list
+          }));
+          return RSVP.all(promise_list);
+        });
+    });
+
+}(domsugar, window, rJS, RSVP));
\ No newline at end of file
--- a/bt5/erp5_web_renderjs_ui/PathTemplateItem/web_page_module/rjs_gadget_erp5_page_access_js.xml
+++ b/bt5/erp5_web_renderjs_ui/PathTemplateItem/web_page_module/rjs_gadget_erp5_page_access_js.xml
--- a/bt5/erp5_web_renderjs_ui/SkinTemplateItem/portal_skins/erp5_web_renderjs/WebSection_getPrecacheManifest.py
+++ b/bt5/erp5_web_renderjs_ui/SkinTemplateItem/portal_skins/erp5_web_renderjs/WebSection_getPrecacheManifest.py
@@ -105,6 +105,8 @@ url_list = [
  'gadget_erp5_page_tab.js',
  'gadget_erp5_page_worklist.html',
  'gadget_erp5_page_worklist.js',
+  'gadget_erp5_page_access.html',
+  'gadget_erp5_page_access.js',
  'gadget_erp5_panel.html',
  'gadget_erp5_panel.js',
  'gadget_erp5_panel.png',

--- a/bt5/erp5_web_renderjs_ui_test/PathTemplateItem/portal_tests/renderjs_ui_interface_validator_zuite/testERP5Interface.zpt
+++ b/bt5/erp5_web_renderjs_ui_test/PathTemplateItem/portal_tests/renderjs_ui_interface_validator_zuite/testERP5Interface.zpt
@@ -13,7 +13,7 @@
 <tal:block metal:use-macro="here/Zuite_CommonTemplate/macros/init" />

 <tal:block tal:define="check_configuration python: {'precache_reference': '../renderjs_runner/WebSection_getPrecacheManifest',
-                                                    'gadget_count': 71}">
+                                                    'gadget_count': 72}">
  <tal:block metal:use-macro="here/Zuite_CommonTemplateForRenderjsUiInterface/macros/run_app_interface_check" />
 </tal:block>