erp5_action_information_api: WIP SPLIT state-of-the-art component

ALSO remove API from allowed content in API

bt5/erp5_action_information_api/DocumentTemplateItem/portal_components/document.erp5.ActionInformationAPIWebSection.py

+##############################################################################
+#
+# Copyright (c) 2024 Nexedi SA and Contributors. All Rights Reserved.
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsability of assessing all potential
+# consequences resulting from its eventual inadequacies and bugs
+# End users who are looking for a ready-to-use solution with commercial
+# garantees and support are strongly adviced to contract a Free Software
+# Service Company
+#
+# This program is Free Software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+#
+##############################################################################
+
+import json
+
+from AccessControl import ClassSecurityInfo
+from zExceptions import NotFound
+
+from Products.ERP5Type import Permissions, PropertySheet
+
+from erp5.component.mixin.DocumentExtensibleTraversableMixin import DocumentExtensibleTraversableMixin
+from erp5.component.document.WebSection import WebSection
+
+def _handleJSONError(RESPONSE, exception):
+  RESPONSE.setStatus(exception.status_code, lock=True)
+  RESPONSE.setBody(exception.json, lock=True)
+
+class ActionInformationAPIException(Exception):
+  def __init__(self, message, json_dict):
+    super(ActionInformationAPIException, self).__init__(message)
+
+    self.status_code = json_dict["status_code"]
+    self.json = json.dumps(json_dict)
+
+class ActionInformationAPIWebSection(WebSection):
+  """
+  Type of Web Section defining an API.
+  """
+  meta_type = "ERP5 Action Information API Web Section"
+  portal_type = "Action Information API Web Section"
+
+  # Declarative security
+  security = ClassSecurityInfo()
+  security.declareObjectProtected(Permissions.AccessContentsInformation)
+
+  property_sheets = ( PropertySheet.Base
+                    , PropertySheet.XMLObject
+                    , PropertySheet.CategoryCore
+                    , PropertySheet.DublinCore
+                    , PropertySheet.VariationRange
+                    , PropertySheet.Arrow
+                    )
+
+  security.declareProtected(Permissions.View, "__bobo_traverse__")
+  def __bobo_traverse__(self, REQUEST, name):
+    mime_type = self.getMimeType()
+    if mime_type is not None:
+      REQUEST.response.setHeader("Content-Type", mime_type)
+
+    document = None
+    try:
+      # Inheritance as follows: jIOWebSection <| WebSection <| (Domain, DocumentExtensibleTraversableMixin)
+      # Use DocumentExtensibleTraversableMixin traversal to avoid ERP5 HTML 404 page.
+      document = DocumentExtensibleTraversableMixin.__bobo_traverse__(self, REQUEST, name)
+    # This NotFound catches objects not found during traversal
+    except NotFound as e:
+      error_message = str(e)
+      error_context = {
+        "status_code": 404,
+        "error_message": error_message,
+        "error_name": "NotFound",
+        "text_content": REQUEST.getBody()
+      }
+      error = ActionInformationAPIException(error_message, error_context)
+      # Ensure to return JSON error and re-raise
+      _handleJSONError(REQUEST.response, error)
+      #raise
+      return "{}"
+
+    return document

bt5/erp5_action_information_api/DocumentTemplateItem/portal_components/document.erp5.ActionInformationAPIWebSection.xml

+<?xml version="1.0"?>
+<ZopeData>
+  <record id="1" aka="AAAAAAAAAAE=">
+    <pickle>
+      <global name="Document Component" module="erp5.portal_type"/>
+    </pickle>
+    <pickle>
+      <dictionary>
+        <item>
+            <key> <string>default_reference</string> </key>
+            <value> <string>ActionInformationAPIWebSection</string> </value>
+        </item>
+        <item>
+            <key> <string>description</string> </key>
+            <value>
+              <none/>
+            </value>
+        </item>
+        <item>
+            <key> <string>id</string> </key>
+            <value> <string>document.erp5.ActionInformationAPIWebSection</string> </value>
+        </item>
+        <item>
+            <key> <string>sid</string> </key>
+            <value>
+              <none/>
+            </value>
+        </item>
+        <item>
+            <key> <string>text_content_error_message</string> </key>
+            <value>
+              <tuple/>
+            </value>
+        </item>
+        <item>
+            <key> <string>text_content_warning_message</string> </key>
+            <value>
+              <tuple/>
+            </value>
+        </item>
+        <item>
+            <key> <string>version</string> </key>
+            <value> <string>erp5</string> </value>
+        </item>
+        <item>
+            <key> <string>workflow_history</string> </key>
+            <value>
+              <persistent> <string encoding="base64">AAAAAAAAAAI=</string> </persistent>
+            </value>
+        </item>
+      </dictionary>
+    </pickle>
+  </record>
+  <record id="2" aka="AAAAAAAAAAI=">
+    <pickle>
+      <global name="PersistentMapping" module="Persistence.mapping"/>
+    </pickle>
+    <pickle>
+      <dictionary>
+        <item>
+            <key> <string>data</string> </key>
+            <value>
+              <dictionary>
+                <item>
+                    <key> <string>component_validation_workflow</string> </key>
+                    <value>
+                      <persistent> <string encoding="base64">AAAAAAAAAAM=</string> </persistent>
+                    </value>
+                </item>
+              </dictionary>
+            </value>
+        </item>
+      </dictionary>
+    </pickle>
+  </record>
+  <record id="3" aka="AAAAAAAAAAM=">
+    <pickle>
+      <global name="WorkflowHistoryList" module="Products.ERP5Type.Workflow"/>
+    </pickle>
+    <pickle>
+      <dictionary>
+        <item>
+            <key> <string>_log</string> </key>
+            <value>
+              <list>
+                <dictionary>
+                  <item>
+                      <key> <string>action</string> </key>
+                      <value> <string>validate</string> </value>
+                  </item>
+                  <item>
+                      <key> <string>validation_state</string> </key>
+                      <value> <string>validated</string> </value>
+                  </item>
+                </dictionary>
+              </list>
+            </value>
+        </item>
+      </dictionary>
+    </pickle>
+  </record>
+</ZopeData>

bt5/erp5_action_information_api/PortalTypeAllowedContentTypeTemplateItem/allowed_content_types.xml

 <allowed_content_type_list>
- <portal_type id="Action Information API Web Section">
-  <item>Action Information API Web Section</item>
- </portal_type>
  <portal_type id="Web Section">
   <item>Action Information API Web Section</item>
  </portal_type>

bt5/erp5_action_information_api/bt/template_document_id_list

+document.erp5.ActionInformationAPIWebSection
\ No newline at end of file

bt5/erp5_action_information_api/bt/template_portal_type_allowed_content_type_list

-Action Information API Web Section | Action Information API Web Section
 Web Section | Action Information API Web Section
 Web Site | Action Information API Web Section
\ No newline at end of file