Skip to content

Commit

Permalink
Merge pull request #100 from Edirom/issue-92
Browse files Browse the repository at this point in the history 
add CRUD module and API endpoints
  • Loading branch information
@AnastasiaWawilow
AnastasiaWawilow authored Jun 3, 2022
2 parents 7e6e201 + 47d2067 commit fcc7fab
Show file tree
Hide file tree
Showing 14 changed files with 974 additions and 490 deletions.
25 changes: 25 additions & 0 deletions confirm.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<div xmlns="http://www.w3.org/1999/xhtml" id="confirm_modal" class="modal">
<!-- Credits to https://www.w3schools.com/howto/howto_css_login_form.asp -->
<span class="close-modal close" title="Close Modal">×</span>

<!-- Modal Content -->
<form class="modal-content animate">
<div class="container">
<h1 id="confirm_modal_heading">Some heading given as @title attribute on the form</h1>
</div>

<div class="container">
<p id="confirm_modal_statusmessage">Some error message</p>
</div>

<div class="container" id="confirm_modal_body">
<!-- Nothing to see here. The content gets cloned via Javascript from the original form -->
<label><b>Some label</b></label>
<input type="text" name="test" required="required" disabled="disabled" size="40" value="Some input text"/>
</div>

</form>
<script type="text/javascript" src="../resources/js/confirm.js">
//
</script>
</div>
143 changes: 141 additions & 2 deletions data/controller.xql
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
xquery version "3.0";
xquery version "3.1";

declare namespace exist="http://exist.sourceforge.net/NS/exist";
declare namespace request="http://exist-db.org/xquery/request";
declare namespace session="http://exist-db.org/xquery/session";
declare namespace response="http://exist-db.org/xquery/response";
declare namespace transform="http://exist-db.org/xquery/transform";

declare namespace output="http://www.w3.org/2010/xslt-xquery-serialization";
declare namespace sm="http://exist-db.org/xquery/securitymanager";
import module namespace config="https://github.com/edirom/mermeid/config" at "../modules/config.xqm";
import module namespace crud="https://github.com/edirom/mermeid/crud" at "../modules/crud.xqm";
import module namespace common="https://github.com/edirom/mermeid/common" at "../modules/common.xqm";
import module namespace xmldb="http://exist-db.org/xquery/xmldb";

import module namespace console="http://exist-db.org/xquery/console";
Expand All @@ -16,6 +20,44 @@ declare variable $exist:controller external;
declare variable $exist:prefix external;
declare variable $exist:root external;

(:~
: Wrapper function for outputting JSON
:
: @param $response-body the response body
: @param $response-code the response status code
:)
declare %private function local:stream-json($response-body, $response-code as xs:integer) as empty-sequence() {
response:set-status-code($response-code),
response:stream(
serialize($response-body,
<output:serialization-parameters>
<output:method>json</output:method>
</output:serialization-parameters>
),
'method=text media-type=application/json encoding=utf-8'
)
};

(:~
: Wrapper function for redirecting to the main page
:)
declare %private function local:redirect-to-main-page() as element(exist:dispatch) {
<dispatch xmlns="http://exist.sourceforge.net/NS/exist">
<redirect url="{config:link-to-app('modules/list_files.xq')}"/>
</dispatch>
};

(:~
: Check whether the overwrite flag is set
: Considered positive (string) values include '1', 'yes', 'ja', 'y', 'on', 'true', 'true()'
: everything else will be `false()`
: @return boolean true() or false()
:)
declare %private function local:overwrite() as xs:boolean {
let $overwriteString := request:get-parameter('overwrite', 'false')
return $overwriteString = ('1', 'yes', 'ja', 'y', 'on', 'true', 'true()') (: some string values that are considered boolean "true()" :)
};

(console:log('/data Controller'),
if (ends-with($exist:resource, ".xml")) then
(console:log('/data Controller: XML data session: '||session:exists()),
Expand Down Expand Up @@ -63,6 +105,103 @@ if (ends-with($exist:resource, ".xml")) then
}
default return (response:set-status-code(405), <_/>)
)
(:~
: copy files endpoint
: For POST requests with Accept header 'application/json' the response
: of the crud operation (a map object) is returned as JSON, for all other
: Accept headers the client is redirected to the main page (after the
: execution of the crud operation)
:)
else if($exist:path = '/copy' and request:get-method() eq 'POST') then
let $source := request:get-parameter('source', '')
let $target := request:get-parameter('target', util:uuid() || '.xml') (: generate a unique filename if none is provided :)
let $title := request:get-parameter('title', ()) (: empty titles will get passed on and filled in later :)
let $overwrite := local:overwrite()
let $backend-response := crud:copy($source, $target, $overwrite, $title)
return
if(request:get-header('Accept') eq 'application/json')
then local:stream-json(map:remove($backend-response, 'document-node'), $backend-response?code)
else local:redirect-to-main-page()
(:~
: delete files endpoint
: For POST requests with Accept header 'application/json' the response
: of the crud operation (an array) is returned as JSON, for all other
: Accept headers the client is redirected to the main page (after the
: execution of the crud operation)
:)
else if($exist:path = '/delete' and request:get-method() eq 'POST') then
let $filename := request:get-parameter('filename', '')
let $backend-response := crud:delete($filename)
return
if(request:get-header('Accept') eq 'application/json')
then local:stream-json($backend-response, $backend-response(1)?code)
else local:redirect-to-main-page()
(:~
: read files endpoint
: For GET requests with Accept header 'application/json' the response
: of the crud operation (a map object) is returned as JSON, for an
: "application/xml" the raw XML document is returned
:)
else if($exist:path = '/read' and request:get-method() eq 'GET') then
let $filename := request:get-parameter('filename', '')
let $backend-response := crud:read($filename)
return
if(request:get-header('Accept') eq 'application/json')
then local:stream-json(map:remove($backend-response, 'document-node'), $backend-response?code)
else if(contains(request:get-header('Accept'), 'application/xml'))
then $backend-response?document-node
else ()
(:~
: rename files endpoint
: this simply chains a "copy" and a "delete" (if the first operation was successfull)
: the returned object is a merge of the copy-response and the delete-response with a precedence for the former
:)
else if($exist:path = '/rename' and request:get-method() eq 'POST') then
let $source := request:get-parameter('source', '')
let $target := request:get-parameter('target', util:uuid() || '.xml') (: generate a unique filename if none is provided :)
let $title := request:get-parameter('title', ()) (: empty titles will get passed on and filled in later :)
let $overwrite := local:overwrite()
let $backend-response-copy := crud:copy($source, $target, $overwrite, $title)
let $update-references :=
if($backend-response-copy instance of map(*) and $backend-response-copy?code = 200)
then common:update-targets(collection($config:data-root), $source, $target, false())
else console:log($backend-response-copy)
let $backend-response-delete :=
if($update-references instance of map(*) and $update-references?replacements ge 0)
then crud:delete($source)
else console:log($update-references)
return
if(request:get-header('Accept') eq 'application/json')
then if($backend-response-delete instance of array(*))
then local:stream-json(map:remove(map:merge(($backend-response-delete(1), $backend-response-copy)), 'document-node'), $backend-response-copy?code)
else (
local:stream-json($backend-response-copy, $backend-response-copy?code),
console:log($backend-response-delete)
)
else local:redirect-to-main-page()
(:~
: create files endpoint
:
:)
else if($exist:path = '/create' and request:get-method() eq 'POST') then
let $templatepath := request:get-parameter('template', $config:app-root || '/forms/model/new_file.xml')
let $title := request:get-parameter('title', '')
let $username := common:get-current-username() => string()
let $change-message := 'file created with MerMEId'
let $template :=
if(doc-available($templatepath))
then doc($templatepath) => common:set-mei-title-in-memory($title) => common:add-change-entry-to-revisionDesc-in-memory($username, $change-message)
else ()
let $filename := request:get-parameter('filename', common:mermeid-id('file') || '.xml')
let $overwrite := local:overwrite()
let $backend-response :=
if($template and $filename)
then crud:create($template, $filename, $overwrite)
else ()
return
if(request:get-header('Accept') eq 'application/json' and $backend-response instance of map(*))
then local:stream-json(map:remove($backend-response, 'document-node'), $backend-response?code)
else local:redirect-to-main-page()
else
(: everything else is passed through :)
(console:log('/data Controller: passthrough'),
Expand Down
Loading

0 comments on commit fcc7fab

Please sign in to comment.