Skip to content

Use the dts-inspired document endpoint for xml, help, mei #277

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fmacca wants to merge 8 commits into
base: develop
Choose a base branch
from
Open

Use the dts-inspired document endpoint for xml, help, mei #277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
57989ab
replace getMusicInMdiv with document
fmacca May 20, 2026
9822d77
Merge branch 'develop' into 202-ftr-use-dts-oriented-document-endpoint
fmacca Jun 30, 2026
5e36ba7
Merge tag 'develop' into 202-ftr-use-dts-oriented-document-endpoint
fmacca Sep 1, 2026
468ffcd
substitute getXml.xql call with dts document endpoint
fmacca Sep 1, 2026
9a3c033
substitute getHeader.xql call with dts document endpoint
fmacca Sep 1, 2026
abdd461
explicit htmlParameter for text view api call
fmacca Sep 1, 2026
4c54ec9
substitute getHelp.xql call with dts document endpoint
fmacca Sep 1, 2026
434fc35
Merge branch 'develop' into 202-ftr-use-dts-oriented-document-endpoint
fmacca Sep 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 28 additions & 11 deletions app/controller/window/HeaderView.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,16 +41,33 @@ Ext.define('EdiromOnline.controller.window.HeaderView', {

var uri = view.uri;
var type = view.type;

window.doAJAXRequest('data/xql/getHeader.xql',
'GET',
{
uri: uri,
type: type
},
Ext.bind(function(response){
view.setContent(response.responseText);
}, this)
);

if(type == 'work' || type == 'source' || type == 'recording') {
// for mei files, the request goes to v2 API - relative to backendURI
window.doAJAXRequest('api/document',
'GET',
{
resource: uri,
ref: 'meiHead',
mediaType: 'text/html',
htmlProfile: 'edirom-header',
idPrefix: view.id + '_'
},
Ext.bind(function(response){
view.setContent(response.responseText);
}, this)
);
} else { // anything else, included 'text' (see backend issue #27)
window.doAJAXRequest('data/xql/getHeader.xql',
'GET',
{
uri: uri,
type: type
},
Ext.bind(function(response){
view.setContent(response.responseText);
}, this)
);
}
}
});
6 changes: 5 additions & 1 deletion app/controller/window/HelpWindow.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,13 @@ Ext.define('EdiromOnline.controller.window.HelpWindow', {
var backendURL = configController.getConfig('backendURL');
var backendPath = configController.getConfig('backendPath');

window.doAJAXRequest('data/xql/getHelp.xql',
// request goes to v2 API - relative to backendURI
window.doAJAXRequest('api/document',
'GET',
{
resource: 'help_' + window.getLanguage(),
mediaType: 'text/html',
htmlProfile: 'edirom-help',
lang: window.getLanguage(),
idPrefix: win.id
},
Expand Down
36 changes: 26 additions & 10 deletions app/controller/window/XmlView.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,16 +47,32 @@ Ext.define('EdiromOnline.controller.window.XmlView', {
var uri = xmlview.uri;
var internalId = xmlview.internalId;

window.doAJAXRequest('data/xql/getXml.xql',
'GET',
{
uri: uri,
internalId: internalId
},
Ext.bind(function(response){
xmlview.setXmlContent(response.responseText);
}, this)
);
if(internalId) {
// request goes to v2 API - relative to backendURI
window.doAJAXRequest('api/document',
'GET',
{
resource: uri,
ref: internalId,
mediaType: 'text/xml'
},
Ext.bind(function(response){
xmlview.setXmlContent(response.responseText);
}, this)
);
} else {
// request goes to v2 API - relative to backendURI
window.doAJAXRequest('api/document',
'GET',
{
resource: uri,
mediaType: 'text/xml'
},
Ext.bind(function(response){
xmlview.setXmlContent(response.responseText);
}, this)
);
}
},

resize: function(xmlview, width, height){
Expand Down
3 changes: 2 additions & 1 deletion app/controller/window/text/TextView.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,8 @@ Ext.define('EdiromOnline.controller.window.text.TextView', {
{
resource: uri,
idPrefix: view.id + '_',
mediaType: 'text/html'
mediaType: 'text/html',
htmlProfile: 'edirom-text'
},
Ext.bind(function(response){
this.contentLoaded(view, response.responseText);
Expand Down
2 changes: 1 addition & 1 deletion app/view/window/image/VerovioImage.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Ext.define('EdiromOnline.view.window.image.VerovioImage', {
var edition = "${edition}";
var movementId = "";
var appBasePath = "${backendURL}";
var meiUrl = appBasePath + "/data/xql/getMusicInMdiv.xql?uri=" + uri + "&edition=" + edition;
var meiUrl = appBasePath + "api/document?resource=" + uri + "&tree=musicStructure&mediaType=application/mei%2Bxml";
</script>

<div id="output">
Expand Down
4 changes: 2 additions & 2 deletions resources/js/verovio-view.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ function initializeComponent() {
var initWidth = Math.floor($(document).width() * 100.0 / 33.0);

// Build initial MEI URL (without movementId)
var meiUrl = appBasePath + "/data/xql/getMusicInMdiv.xql?uri=" + uri + "&edition=" + edition;
var meiUrl = appBasePath + "api/document?resource=" + uri + "&tree=musicStructure&mediaType=application/mei%2Bxml";

// Create the component element
var renderer = document.createElement('edirom-verovio-renderer');
Expand Down Expand Up @@ -119,7 +119,7 @@ function showMovement(movementId) {
var initWidth = Math.floor(width * 100.0 / 33.0);

// Build MEI URL with movementId
var meiUrl = appBasePath + "/data/xql/getMusicInMdiv.xql?uri=" + uri + "&edition=" + edition + "&movementId=" + movementId;
var meiUrl = appBasePath + "api/document?resource=" + uri + "&tree=musicStructure&mediaType=application/mei%2Bxml&ref=" + movementId;

// Get or create the component
var renderer = document.getElementById('verovio-renderer');
Expand Down