Skip to content
Snippets Groups Projects
Commit e0d748ea authored by Jerome Chauveau's avatar Jerome Chauveau
Browse files

initial commit (from max-v2 repo)

parent 9badf0cf
No related branches found
No related tags found
No related merge requests found
# max-db-bundle # max-db-bundle
Bundle de gestion des sources XML de MaX.
## Getting started ## Installation manuelle
To make it easy for you to get started with GitLab, here's a list of recommended next steps. Cloner ce dépôt dans `/path/to/max-v2/.max/basex/webapp/max/bundles`
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
## Add your files
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
```
cd existing_repo
git remote add origin https://git.unicaen.fr/chauveau/max-db-bundle.git
git branch -M master
git push -uf origin master
```
## Integrate with your tools
- [ ] [Set up project integrations](https://git.unicaen.fr/chauveau/max-db-bundle/-/settings/integrations)
## Collaborate with your team
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
## Test and Deploy
Use the built-in continuous integration in GitLab.
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
***
# Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
## Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
## Name
Choose a self-explaining name for your project.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
## License
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
xquery version "3.0";
(:~
: MaX DB
:)
module namespace max-db = 'https://certic.unicaen.fr/max/max-db';
import module namespace database = 'https://certic.unicaen.fr/max/database' at '../../core/database.xqm';
import module namespace templating = 'https://certic.unicaen.fr/max/templating' at '../../core/templating.xqm';
(:~
: Returns the index page with list of xml files
: @return HTML page
:)
declare
%rest:GET
%output:method("html")
%output:html-version("5.0")
%output:encoding("UTF-8")
%rest:path("/bundles/max-db")
function max-db:index(){
let $sources := db:list-details($database:max-db)
let $templateDoc := doc('./templates/index.html')
let $collections := max-db:max-collections()
return templating:eval-template(
$templateDoc,
map{'sources': $sources, 'collections': $collections})
};
(:~
: delete source file
: @param $path file path
:)
declare
%rest:DELETE
%updating
%rest:path("/bundles/max-db/{$path=.+}")
function max-db:delete($path as xs:string){
if(db:exists($database:max-db, $path))
then db:delete($database:max-db, $path)
else fn:error(fn:QName('https://certic.unicaen.fr/max/max-db', 'err:source-not-found'), 'source file does not exist')
};
(:~
: add source file
: @param $path file path
: @param $file file to add
:)
declare
%rest:POST
%updating
%rest:form-param("path","{$path}")
%rest:form-param("file","{$file}")
%rest:path("/bundles/max-db/post")
function max-db:post($path as xs:string, $file as map(*)){
let $key := map:keys($file)
let $input := $file($key)
return db:put($database:max-db, fetch:binary-doc($input), $path)
};
(:~
: move source file
: @param $sourcepath file path
: @param $collection target collection
:)
declare
%rest:POST
%updating
%rest:query-param("sourcePath", "{$sourcePath}")
%rest:query-param("collection", "{$collection}")
%rest:path("/bundles/max-db/move")
function max-db:move($sourcePath as xs:string, $collection as xs:string){
let $sourceName := tokenize($sourcePath,'/')[last()]
let $doc := doc($database:max-db || '/' || $sourcePath)
return (db:put($database:max-db, $doc , $collection || $sourceName), db:delete($database:max-db, $sourcePath))
};
declare %private function max-db:max-collections() as xs:string*{
let $prefix := '/max/'
let $collections := distinct-values(for $i in collection('max/')
let $path := replace(replace(base-uri($i),tokenize(base-uri($i),'/')[last()],''),$prefix,'')
return if($path='')then() else $path)
return $collections
};
let currentSource = null;
let modal = null;
function deleteSource(source) {
if (confirm(`Supprimer ${source} ?`)) {
fetch(`/bundles/max-db/${source}`, { method: 'DELETE' }).then((res) => {
if (res.status == 200)
document.getElementById(source).remove()
else {
res.text().then((message) => alert(`Une erreur est survenue, suppression impossible. \n\n ${message}).`))
}
})
}
}
function openMoveSourceDialog(source) {
document.getElementById('modal-title').innerHTML=`Déplacer <em>${source}</em>`
if(!modal)
modal = new bootstrap.Modal(document.getElementById('move-source-modal'))
currentSource = source;
modal.show()
}
function doMoveSource(){
const collection = document.getElementById('move-collection-select').value
console.debug('Move ' + currentSource + ' to '+ collection)
modal.hide()
fetch(`/bundles/max-db/move?sourcePath=${currentSource}&collection=${collection}`, {method: 'POST'}).then((res) => {
if(res.status == 200)
window.location.reload();
else {
res.text().then((message) => alert(`Une erreur est survenue, déplacement impossible. \n\n ${message}).`))
}
})
}
async function dropHandler(ev) {
ev.preventDefault();
const droppedFiles = await DirectoryDropReader.getFilesFromDropEvent(ev)
const files = droppedFiles[0]
for(let i = 0; i < files.length; i++){
const f = files[i]
var data = new FormData()
data.append('file', f)
data.append('path', f.webkitRelativePath)
await fetch('/bundles/max-db/post', {
method: 'POST',
body: data,
})
}
window.location.reload();
}
function dragOverHandler(ev) {
ev.preventDefault();
}
/**
* DropDir helper class
*/
class DirectoryDropReader {
constructor() {
this.files = []
}
static async getFilesFromDropEvent(e) {
let items = e.dataTransfer.items;
let result = [];
for (let i = 0; i < items.length; i += 1) {
let ddr = new DirectoryDropReader();
let entry = items[i].webkitGetAsEntry();
if (entry) {
let r = await ddr.traverse(items[i].webkitGetAsEntry());
result.push(ddr.getFiles());
}
}
return result;
}
traverse(item) {
this.files = [];
let self = this;
if (item.isFile) {
return new Promise((resolve) => {
item.file((f) => {
this.files.push(f);
resolve(this.files);
});
});
}
const reader = item.createReader();
// Resolved when the entire directory is traversed
return new Promise((resolve, reject) => {
const iterationAttempts = [];
function readEntries() {
// According to the FileSystem API spec, readEntries() must be called until
// it calls the callback with an empty array. Seriously??
reader.readEntries((entries) => {
if (!entries.length) {
// Done iterating this particular directory
resolve(Promise.all(iterationAttempts));
} else {
// Add a list of promises for each directory entry. If the entry is itself
// a directory, then that promise won't resolve until it is fully traversed.
iterationAttempts.push(Promise.all(entries.map((ientry) => {
if (ientry.isFile) {
// DO SOMETHING WITH FILES
ientry.file((f) => self.files.push(f))
return true;
}
// DO SOMETHING WITH DIRECTORIES
return self.traverse(ientry);
})));
// Try calling readEntries() again for the same dir, according to spec
readEntries();
}
}, error => reject(error));
}
readEntries();
});
}
readFiles(item) {
if (item.isDirectory) {
let directoryReader = item.createReader();
directoryReader.readEntries((entries) => {
entries.forEach((entry) => {
this.readFiles(entry);
});
});
}
else {
item.file((f) => this.files.push(f))
}
}
getFiles() {
return this.files;
}
}
\ No newline at end of file
<!DOCTYPE html>
<html>
<head>
<title>MaX DB Bundle</title>
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/js/bootstrap.bundle.min.js" integrity="sha384-YvpcrYf0tY3lHB60NNkmXc5s9fDVZLESaAA55NDzOxhy9GkcIdslK1eN7N6jIeHz" crossorigin="anonymous"></script>
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH" crossorigin="anonymous"></link>
<script src="{templating:static('max-db','max-db.js')}"></script>
</head>
<body>
<header>
<h1 class="text-center">Gestion des sources XML de MaX</h1>
</header>
<main class="container">
<a style="position: fixed; bottom :5px; left: 5px; background-color: #333; padding: 2px 5px; color: white" href="/about.html">?</a>
<section class="mt-3">
<h3>Ajout de sources</h3>
<div class="mt-5 mb-5 d-flex justify-content-center align-items-center"
id="drop_zone"
ondrop="dropHandler(event);"
ondragover="dragOverHandler(event);"
style="min-height:100px;border: dashed 4px #ddd;">
<p>Déposez un ou plusieurs fichiers XML dans cette <i>zone</i></p>
</div>
</section>
<section>
<h3>Sources XML ({count($sources)})</h3>
<table class="table">
<thead>
<tr>
<th scope="col">Nom du fichier</th>
<th scope="col">Taille</th>
<th scope="col">Dernière modification</th>
<th class="text-center" scope="col">Actions</th>
</tr>
</thead>
<tbody>
{
for $source in $sources
return if($source/@type="xml")
then <tr id="{$source/data()}">
<td>{$source/data()}</td>
<td>{string($source/@size)}</td>
<td>{string($source/@modified-date)}</td>
<td class="text-center">
<button title="supprimer" class="btn" onclick="deleteSource('{$source/data()}')">&#9747;</button>
<button title="déplacer" class="btn" onclick="openMoveSourceDialog('{$source/data()}')">&#x21ab;</button>
</td>
</tr>
else()
}
</tbody>
</table>
</section>
<div class="modal fade" id="move-source-modal" data-bs-backdrop="static" data-bs-keyboard="false" tabindex="-1" aria-labelledby="staticBackdropLabel" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<h1 class="modal-title fs-5" id="modal-title"></h1>
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
</div>
<div class="modal-body">
<select class="form-control" id="move-collection-select">
{for $c in $collections
return <option value="{$c}">{$c}</option>
}
</select>
</div>
<div class="modal-footer">
<button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Annuler</button>
<button type="button" class="btn btn-primary" onclick="doMoveSource()">Valider</button>
</div>
</div>
</div>
</div>
</main>
</body>
</html>
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment