Skip to content

erp5
erp5
Commit d37ce208 authored by Titouan Soulard's avatar Titouan Soulard
Browse files
Options

erp5_action_information_api: initial version of AI API

parent b51e56e0
Hide whitespace changes
Inline Side-by-side
Showing with 859 additions and 0 deletions
bt5/erp5_action_information_api/ActionTemplateItem/portal_types/Action%20Information%20API/view.xml 0 → 100644
View file @ d37ce208
<?xml version="1.0"?>
<ZopeData>
<record id="1" aka="AAAAAAAAAAE=">
<pickle>
<global name="ActionInformation" module="Products.CMFCore.ActionInformation"/>
</pickle>
<pickle>
<dictionary>
<item>
<key> <string>action</string> </key>
<value>
<persistent> <string encoding="base64">AAAAAAAAAAI=</string> </persistent>
</value>
</item>
<item>
<key> <string>categories</string> </key>
<value>
<tuple>
<string>action_type/object_view</string>
</tuple>
</value>
</item>
<item>
<key> <string>category</string> </key>
<value> <string>object_view</string> </value>
</item>
<item>
<key> <string>condition</string> </key>
<value> <string></string> </value>
</item>
<item>
<key> <string>description</string> </key>
<value>
<none/>
</value>
</item>
<item>
<key> <string>icon</string> </key>
<value> <string></string> </value>
</item>
<item>
<key> <string>id</string> </key>
<value> <string>view</string> </value>
</item>
<item>
<key> <string>permissions</string> </key>
<value>
<tuple>
<string>View</string>
</tuple>
</value>
</item>
<item>
<key> <string>priority</string> </key>
<value> <float>7.0</float> </value>
</item>
<item>
<key> <string>title</string> </key>
<value> <string>Action Information API View</string> </value>
</item>
<item>
<key> <string>visible</string> </key>
<value> <int>1</int> </value>
</item>
</dictionary>
</pickle>
</record>
<record id="2" aka="AAAAAAAAAAI=">
<pickle>
<global name="Expression" module="Products.CMFCore.Expression"/>
</pickle>
<pickle>
<dictionary>
<item>
<key> <string>text</string> </key>
<value> <string>string:${object_url}/WebSection_view</string> </value>
</item>
</dictionary>
</pickle>
</record>
</ZopeData>
bt5/erp5_action_information_api/DocumentTemplateItem/portal_components/document.erp5.ActionInformationAPI.py 0 → 100644
View file @ d37ce208
# -*- coding: utf-8 -*-
##############################################################################
#
# Copyright (c) 2023 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
import zope.component
import zope.interface
from zope.publisher.browser import BrowserView
from zope.publisher.interfaces import IPublishTraverse
from zope.publisher.interfaces.browser import IBrowserPublisher
from zExceptions import NotFound, Unauthorized
from ZPublisher.BaseRequest import DefaultPublishTraverse
from ZPublisher.interfaces import UseTraversalDefault
from AccessControl import ClassSecurityInfo
from Products.ERP5Type import Permissions, PropertySheet
from Products.ERP5Type.XMLObject import XMLObject
class IActionInformationAPIRequest(zope.interface.Interface): # pylint:disable=inherit-non-class
"""Marker interface to register error handler
"""
@zope.component.adapter(Exception, IActionInformationAPIRequest)
class ActionInformationAPIErrorHandlerView(BrowserView):
"""Error handler for requests
"""
def __call__(self):
return self.__parent__.handleException(self.context, self.request)
zope.component.getGlobalSiteManager().registerAdapter(
ActionInformationAPIErrorHandlerView,
provided=IActionInformationAPIRequest,
name=u'index.html',
)
@zope.interface.implementer(IPublishTraverse, IBrowserPublisher)
class ActionInformationAPIPublisher(object):
"""Wrapper for traversal
"""
def __init__(self, context, request):
self.context = context
zope.interface.alsoProvides(request, IActionInformationAPIRequest)
# Disable redirection to login page
def unauthorized():
raise Unauthorized()
request.response.unauthorized = unauthorized
def __getattr__(self, name):
return getattr(self.context, name)
def __getitem__(self, name):
return self.context[name]
def publishTraverse(self, request, name):
return self
def browserDefault(self, request):
return ActionInformationAPIView(self.context, request), ()
class ActionInformationAPIView(BrowserView):
"""Wrapper View class to inherit from BrowserView
"""
def __call__(self, *args, **kw):
return self.context.handleRequest(self.request)
@zope.interface.implementer(IPublishTraverse)
class ActionInformationAPI(XMLObject):
portal_type = "Action Information API"
# Declarative security
security = ClassSecurityInfo()
security.declareObjectProtected(Permissions.AccessContentsInformation)
# Declarative properties
property_sheets = (
PropertySheet.Base,
PropertySheet.XMLObject,
)
def generateActionList(self, category_name, url):
portal = self.getPortalObject()
base_url = portal.portal_callables.absolute_url().strip()
action_type_filter = portal.portal_categories.action_type.object_api[category_name]
raw_action_list = portal.portal_catalog(
portal_type="Action Information",
action_type__uid=action_type_filter.getUid()
)
hyperdocument = []
action_dict = {}
for item in raw_action_list:
# XXX: for now, expects reference to be the same as action URL
callable_url = base_url + "/" + str(item.getProperty("reference"))
request_schema = callable_url + "/getInputJSONSchema"
hyperdocument.append({
"$schemaRequest": request_schema,
"$schemaResponse": callable_url + "/getOutputJSONSchema",
"method": "POST",
"url": url
})
action_dict[request_schema] = item
return (json.dumps({ "links": hyperdocument }, indent=2).encode(), action_dict)
def handleException(self, exception, request):
response = request.response
error_log = { "status": 500, "msg": str(exception) }
if isinstance(exception, NotFound):
error_log["status"] = 404
elif isinstance(exception, Unauthorized):
error_log["status"] = 403
del error_log["msg"]
response.setHeader("Content-Type", "application/json")
response.setStatus(error_log["status"], lock=True)
response.setBody(json.dumps(error_log, indent=2).encode(), lock=True)
def handleRequest(self, request):
portal = self.getPortalObject()
(hyperdocument, actions) = self.generateActionList("pet_store", request.getURL())
response = request.RESPONSE
request_content_type = request.getHeader("content-type")
if request_content_type and request_content_type != "application/json":
raise NotImplementedError("Cannot server Content-Type {}".format(request_content_type))
response.setHeader("Content-Type", "application/json")
if request.get("method").lower() != "post":
return hyperdocument
request_json = request.get("BODY")
if not request_json:
return hyperdocument
request_body = json.loads(request_json)
request_schema = request_body.get("$schemaDocument")
request_object_ref = request_body.get("reference")
if not request_schema or not request_object_ref:
return hyperdocument
found_action = ""
for schema_url in actions:
if schema_url == request_schema:
found_action = actions[schema_url]
break
if not found_action:
raise NotFound("Schema {} unavailable".format(request_schema))
portal_type = found_action.getParentValue().getId()
request_object = portal.portal_catalog.getResultValue(portal_type=portal_type, id=request_object_ref)
if not request_object:
raise NotFound("Object {} not found".format(request_object_ref))
action_output = request_object.getTypeInfo().getDefaultViewFor(request_object, view=found_action.getProperty("reference"))(request_body)
action_output["status"] = 200
return json.dumps(action_output, indent=2).encode()
def publishTraverse(self, request, name):
adapter = DefaultPublishTraverse(self, request)
try:
obj = adapter.publishTraverse(request, name)
except (KeyError, AttributeError):
return ActionInformationAPIPublisher(self, request)
return obj
def __bobo_traverse__(self, request, name):
raise UseTraversalDefault
bt5/erp5_action_information_api/DocumentTemplateItem/portal_components/document.erp5.ActionInformationAPI.xml 0 → 100644
View file @ d37ce208
<?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>ActionInformationAPI</string> </value>
</item>
<item>
<key> <string>description</string> </key>
<value>
<none/>
</value>
</item>
<item>
<key> <string>id</string> </key>
<value> <string>document.erp5.ActionInformationAPI</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/PathTemplateItem/portal_categories/action_type/object_api.xml 0 → 100644
View file @ d37ce208
<?xml version="1.0"?>
<ZopeData>
<record id="1" aka="AAAAAAAAAAE=">
<pickle>
<global name="Category" module="erp5.portal_type"/>
</pickle>
<pickle>
<dictionary>
<item>
<key> <string>_Add_portal_content_Permission</string> </key>
<value>
<tuple>
<string>Assignor</string>
<string>Manager</string>
</tuple>
</value>
</item>
<item>
<key> <string>_Add_portal_folders_Permission</string> </key>
<value>
<tuple>
<string>Assignor</string>
<string>Manager</string>
</tuple>
</value>
</item>
<item>
<key> <string>_Copy_or_Move_Permission</string> </key>
<value>
<tuple>
<string>Assignor</string>
<string>Manager</string>
</tuple>
</value>
</item>
<item>
<key> <string>_Delete_objects_Permission</string> </key>
<value>
<tuple>
<string>Assignor</string>
<string>Manager</string>
</tuple>
</value>
</item>
<item>
<key> <string>_Modify_portal_content_Permission</string> </key>
<value>
<tuple>
<string>Assignee</string>
<string>Assignor</string>
<string>Manager</string>
<string>Owner</string>
</tuple>
</value>
</item>
<item>
<key> <string>_count</string> </key>
<value>
<persistent> <string encoding="base64">AAAAAAAAAAI=</string> </persistent>
</value>
</item>
<item>
<key> <string>_mt_index</string> </key>
<value>
<persistent> <string encoding="base64">AAAAAAAAAAM=</string> </persistent>
</value>
</item>
<item>
<key> <string>_tree</string> </key>
<value>
<persistent> <string encoding="base64">AAAAAAAAAAQ=</string> </persistent>
</value>
</item>
<item>
<key> <string>description</string> </key>
<value>
<none/>
</value>
</item>
<item>
<key> <string>id</string> </key>
<value> <string>object_api</string> </value>
</item>
<item>
<key> <string>title</string> </key>
<value> <string>object_api</string> </value>
</item>
</dictionary>
</pickle>
</record>
<record id="2" aka="AAAAAAAAAAI=">
<pickle>
<global name="Length" module="BTrees.Length"/>
</pickle>
<pickle> <int>0</int> </pickle>
</record>
<record id="3" aka="AAAAAAAAAAM=">
<pickle>
<global name="OOBTree" module="BTrees.OOBTree"/>
</pickle>
<pickle>
<none/>
</pickle>
</record>
<record id="4" aka="AAAAAAAAAAQ=">
<pickle>
<global name="OOBTree" module="BTrees.OOBTree"/>
</pickle>
<pickle>
<none/>
</pickle>
</record>
</ZopeData>
bt5/erp5_action_information_api/PathTemplateItem/portal_categories/api_type.xml 0 → 100644
View file @ d37ce208
<?xml version="1.0"?>
<ZopeData>
<record id="1" aka="AAAAAAAAAAE=">
<pickle>
<global name="Base Category" module="erp5.portal_type"/>
</pickle>
<pickle>
<dictionary>
<item>
<key> <string>_Add_portal_content_Permission</string> </key>
<value>
<tuple>
<string>Assignor</string>
<string>Manager</string>
</tuple>
</value>
</item>
<item>
<key> <string>_Add_portal_folders_Permission</string> </key>
<value>
<tuple>
<string>Assignor</string>
<string>Manager</string>
</tuple>
</value>
</item>
<item>
<key> <string>_Copy_or_Move_Permission</string> </key>
<value>
<tuple>
<string>Assignor</string>
<string>Manager</string>
</tuple>
</value>
</item>
<item>
<key> <string>_Delete_objects_Permission</string> </key>
<value>
<tuple>
<string>Assignor</string>
<string>Manager</string>
</tuple>
</value>
</item>
<item>
<key> <string>_Modify_portal_content_Permission</string> </key>
<value>
<tuple>
<string>Assignee</string>
<string>Assignor</string>
<string>Manager</string>
<string>Owner</string>
</tuple>
</value>
</item>
<item>
<key> <string>_count</string> </key>
<value>
<persistent> <string encoding="base64">AAAAAAAAAAI=</string> </persistent>
</value>
</item>
<item>
<key> <string>_mt_index</string> </key>
<value>
<persistent> <string encoding="base64">AAAAAAAAAAM=</string> </persistent>
</value>
</item>
<item>
<key> <string>_tree</string> </key>
<value>
<persistent> <string encoding="base64">AAAAAAAAAAQ=</string> </persistent>
</value>
</item>
<item>
<key> <string>description</string> </key>
<value>
<none/>
</value>
</item>
<item>
<key> <string>id</string> </key>
<value> <string>api_type</string> </value>
</item>
<item>
<key> <string>title</string> </key>
<value> <string>API Type</string> </value>
</item>
</dictionary>
</pickle>
</record>
<record id="2" aka="AAAAAAAAAAI=">
<pickle>
<global name="Length" module="BTrees.Length"/>
</pickle>
<pickle> <int>0</int> </pickle>
</record>
<record id="3" aka="AAAAAAAAAAM=">
<pickle>
<global name="OOBTree" module="BTrees.OOBTree"/>
</pickle>
<pickle>
<none/>
</pickle>
</record>
<record id="4" aka="AAAAAAAAAAQ=">
<pickle>
<global name="OOBTree" module="BTrees.OOBTree"/>
</pickle>
<pickle>
<none/>
</pickle>
</record>
</ZopeData>
bt5/erp5_action_information_api/PathTemplateItem/portal_categories/api_type/open_api.xml 0 → 100644
View file @ d37ce208
<?xml version="1.0"?>
<ZopeData>
<record id="1" aka="AAAAAAAAAAE=">
<pickle>
<global name="Category" module="erp5.portal_type"/>
</pickle>
<pickle>
<dictionary>
<item>
<key> <string>_Add_portal_content_Permission</string> </key>
<value>
<tuple>
<string>Assignor</string>
<string>Manager</string>
</tuple>
</value>
</item>
<item>
<key> <string>_Add_portal_folders_Permission</string> </key>
<value>
<tuple>
<string>Assignor</string>
<string>Manager</string>
</tuple>
</value>
</item>
<item>
<key> <string>_Copy_or_Move_Permission</string> </key>
<value>
<tuple>
<string>Assignor</string>
<string>Manager</string>
</tuple>
</value>
</item>
<item>
<key> <string>_Delete_objects_Permission</string> </key>
<value>
<tuple>
<string>Assignor</string>
<string>Manager</string>
</tuple>
</value>
</item>
<item>
<key> <string>_Modify_portal_content_Permission</string> </key>
<value>
<tuple>
<string>Assignee</string>
<string>Assignor</string>
<string>Manager</string>
<string>Owner</string>
</tuple>
</value>
</item>
<item>
<key> <string>description</string> </key>
<value>
<none/>
</value>
</item>
<item>
<key> <string>id</string> </key>
<value> <string>open_api</string> </value>
</item>
<item>
<key> <string>title</string> </key>
<value> <string>OpenAPI</string> </value>
</item>
</dictionary>
</pickle>
</record>
</ZopeData>
bt5/erp5_action_information_api/PathTemplateItem/portal_categories/api_type/slap_api.xml 0 → 100644
View file @ d37ce208
<?xml version="1.0"?>
<ZopeData>
<record id="1" aka="AAAAAAAAAAE=">
<pickle>
<global name="Category" module="erp5.portal_type"/>
</pickle>
<pickle>
<dictionary>
<item>
<key> <string>_Add_portal_content_Permission</string> </key>
<value>
<tuple>
<string>Assignor</string>
<string>Manager</string>
</tuple>
</value>
</item>
<item>
<key> <string>_Add_portal_folders_Permission</string> </key>
<value>
<tuple>
<string>Assignor</string>
<string>Manager</string>
</tuple>
</value>
</item>
<item>
<key> <string>_Copy_or_Move_Permission</string> </key>
<value>
<tuple>
<string>Assignor</string>
<string>Manager</string>
</tuple>
</value>
</item>
<item>
<key> <string>_Delete_objects_Permission</string> </key>
<value>
<tuple>
<string>Assignor</string>
<string>Manager</string>
</tuple>
</value>
</item>
<item>
<key> <string>_Modify_portal_content_Permission</string> </key>
<value>
<tuple>
<string>Assignee</string>
<string>Assignor</string>
<string>Manager</string>
<string>Owner</string>
</tuple>
</value>
</item>
<item>
<key> <string>description</string> </key>
<value>
<none/>
</value>
</item>
<item>
<key> <string>id</string> </key>
<value> <string>slap_api</string> </value>
</item>
<item>
<key> <string>title</string> </key>
<value> <string>SlapOS API</string> </value>
</item>
</dictionary>
</pickle>
</record>
</ZopeData>
bt5/erp5_action_information_api/PortalTypeAllowedContentTypeTemplateItem/allowed_content_types.xml 0 → 100644
View file @ d37ce208
<allowed_content_type_list>
<portal_type id="Web Service Tool">
<item>Action Information API</item>
</portal_type>
</allowed_content_type_list>
\ No newline at end of file
bt5/erp5_action_information_api/PortalTypeTemplateItem/portal_types/Action%20Information%20API.xml 0 → 100644
View file @ d37ce208
<?xml version="1.0"?>
<ZopeData>
<record id="1" aka="AAAAAAAAAAE=">
<pickle>
<global name="Base Type" module="erp5.portal_type"/>
</pickle>
<pickle>
<dictionary>
<item>
<key> <string>content_icon</string> </key>
<value>
<none/>
</value>
</item>
<item>
<key> <string>description</string> </key>
<value> <string>Web Section making API actions available using HTTP requests</string> </value>
</item>
<item>
<key> <string>id</string> </key>
<value> <string>Action Information API</string> </value>
</item>
<item>
<key> <string>init_script</string> </key>
<value>
<none/>
</value>
</item>
<item>
<key> <string>permission</string> </key>
<value>
<none/>
</value>
</item>
<item>
<key> <string>type_class</string> </key>
<value> <string>ActionInformationAPI</string> </value>
</item>
<item>
<key> <string>type_interface</string> </key>
<value>
<tuple/>
</value>
</item>
</dictionary>
</pickle>
</record>
</ZopeData>
bt5/erp5_action_information_api/PortalTypeWorkflowChainTemplateItem/workflow_chain_type.xml 0 → 100644
View file @ d37ce208
<workflow_chain>
<chain>
<type>Action Information API</type>
<workflow>edit_workflow</workflow>
</chain>
</workflow_chain>
\ No newline at end of file
bt5/erp5_action_information_api/SkinTemplateItem/portal_skins/erp5_action_information_api.xml 0 → 100644
View file @ d37ce208
<?xml version="1.0"?>
<ZopeData>
<record id="1" aka="AAAAAAAAAAE=">
<pickle>
<global name="Folder" module="OFS.Folder"/>
</pickle>
<pickle>
<dictionary>
<item>
<key> <string>_objects</string> </key>
<value>
<tuple/>
</value>
</item>
<item>
<key> <string>id</string> </key>
<value> <string>erp5_action_information_api</string> </value>
</item>
<item>
<key> <string>title</string> </key>
<value> <string>Action Information API</string> </value>
</item>
</dictionary>
</pickle>
</record>
</ZopeData>
bt5/erp5_action_information_api/bt/dependency_list 0 → 100644
View file @ d37ce208
erp5_base
erp5_ingestion
erp5_ingestion_mysql_innodb_catalog
erp5_web_service
\ No newline at end of file
bt5/erp5_action_information_api/bt/template_action_path_list 0 → 100644
View file @ d37ce208
Action Information API | view
\ No newline at end of file
bt5/erp5_action_information_api/bt/template_document_id_list 0 → 100644
View file @ d37ce208
document.erp5.ActionInformationAPI
\ No newline at end of file
bt5/erp5_action_information_api/bt/template_path_list 0 → 100644
View file @ d37ce208
portal_categories/action_type/object_api
portal_categories/api_type
portal_categories/api_type/**
\ No newline at end of file
bt5/erp5_action_information_api/bt/template_portal_type_allowed_content_type_list 0 → 100644
View file @ d37ce208
Web Service Tool | Action Information API
\ No newline at end of file
bt5/erp5_action_information_api/bt/template_portal_type_id_list 0 → 100644
View file @ d37ce208
Action Information API
\ No newline at end of file
bt5/erp5_action_information_api/bt/template_portal_type_workflow_chain_list 0 → 100644
View file @ d37ce208
Action Information API | edit_workflow
\ No newline at end of file
bt5/erp5_action_information_api/bt/template_skin_id_list 0 → 100644
View file @ d37ce208
erp5_action_information_api
\ No newline at end of file
bt5/erp5_action_information_api/bt/title 0 → 100644
View file @ d37ce208
erp5_action_information_api
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7