Clone officiel du projet LdapSaisie
Find a file
Benjamin Renard 0ec390e1fe Add API feature
Some major changes have been made to handle this new feature :
- LSsession now have a flag about API mode. The displayTemplate() and
  displayAjaxReturn() methods have been adjust to correctly handle this
  mode.
- LSauth system have been adjust to handle a custom API mode :
  - LSauthMethod can support or not this mode : the $api_mode_supported
    permit to defined if supported (default, false). Currently, only
    HTTP (default in API mode) and annonymous mode support it.
  - An api_access parameter permit to configure witch type of user
    LSobject types could use the API. This flag must be set to True to
    allow a type of LSobject (default: False). In a same way, a
    web_access parameter now permit to disable Web access for some
    types of users (but this parameter is optional and its default value
    is True).
  - The HTTP method is the privileged first method for API mode. In this
    mode, if auth data aren't present in environment, it will request it
    by triggered a 403 HTTP error. Realm can be configured with new
    LSAUTHMETHOD_HTTP_API_REALM constant.
- The LStemplate system handle API mode to correctly react on errors: it
  return a JSON answer instead of HTML page. Error pages also now return
  adjusted HTTP code (404 or 500).
- The LSurl system have been adjust to handle API mode :
  - On declaring handlers, we could now specify if it's an API view with
    new $api_mode paremeter of add_handler() method
  - The LSurlRequest object have a new attribute to check if it's an API
    request
  - The error_404() method handle the API mode to return JSON answer.
    Furthermore, if no handlers matched with the requested URL, API mode
    is automatically enabled if the requested URL starts with 'api/'.
- LSform implement it own API mode flag and a new submited flag that
  be toggle via the new setSubmited() method. Some major changes also
  occured on LSformElement classes to specifically handle API
  input/output for each types of attributes:
  - a new getApiValue() method permit to retrieve the API value of the
    attribute (on show API view)
  - the getPostData() method now have to correctly handle API input for
    the attribute (on create/modify API views). A programmatic way have
    been adopted for each types of attributes.
- The LSimport and LScli create/modify commands also evolved to enable
  API mode of the LSform. This permit to take advantage of the new
  capability of LSform/LSformElement to handle input values with a
  programmatic way.
- New routes have been add to handle API views. All this new routes
  start with 'api/1.0/' and use the same URL schema as the web UI. The
  API currently permit to search/show/add/modify/remove LSobjects and
  manages their relations.
2021-02-03 14:40:28 +01:00
config.local upgradeFromGit.sh : add gettext MO file change detection 2019-06-17 14:02:31 +02:00
debian Release 3.0.2-1 Debian package 2020-09-30 11:35:51 +02:00
doc Add API feature 2021-02-03 14:40:28 +01:00
logos Add logos 2017-07-21 11:36:12 +02:00
lsexample Improve POSIX support and add examples to handle this type of attributes 2020-09-11 13:54:08 +02:00
src Add API feature 2021-02-03 14:40:28 +01:00
tests Massive change of files organisation to move all files outside web-root 2020-05-06 12:17:35 +02:00
.gitignore gitignore : Added exclude of *~ files 2011-05-20 17:44:08 +02:00
AUTHORS Massive change of files organisation to move all files outside web-root 2020-05-06 12:17:35 +02:00
buildDoc.sh buildDoc.sh : Added buildDocExports.sh exection if is defined 2011-05-20 17:54:39 +02:00
buildDocExports.sh Doc : add support to EPUB doc generation and exportation 2014-08-13 02:23:26 +02:00
checkDocExportsNecessity.sh Scripts : Changed shebang /bin/sh by /bin/bash specifically 2011-05-20 17:46:59 +02:00
checkUpgrade.sh Scripts : Changed shebang /bin/sh by /bin/bash specifically 2011-05-20 17:46:59 +02:00
INSTALL Update doc 2020-05-06 12:31:24 +02:00
LICENSE Massive change of files organisation to move all files outside web-root 2020-05-06 12:17:35 +02:00
upgradeFromGit.sh Fix some typo in upgradeFromGit.sh 2020-05-06 12:52:13 +02:00