User
Difference between revisions of "Seb35/bluell.js"
< User:Seb35
| Line 452: | Line 452: | ||
return; | return; | ||
} | } | ||
| − | |||
function escapeCsv( val ) { | function escapeCsv( val ) { | ||
| Line 472: | Line 471: | ||
].join( ',' ); | ].join( ',' ); | ||
} ).join( "\n" ) ); | } ).join( "\n" ) ); | ||
| − | |||
$('#sndlib-savefiltersearch a').attr( { | $('#sndlib-savefiltersearch a').attr( { | ||
Revision as of 11:57, 30 September 2021
// Development in final phase of the interface for displaying contributions
$( function (){
if( !/^LinguaLibre:Explore_the_sound_library(\/[a-z_-]+)?$/.test( mw.config.get( 'wgPageName' ) ) ) {
return;
}
// Parameters
const nbTotalResults = 100; // Total number of results requested to SPARQL endpoint
const nbResultsPerPage = 10; // Number of results displayed per page
// User messages to be translated
const messages = {
'msg-no-results': {
en: 'No results.',
de: 'Keine Ergebnisse.',
fr: 'Pas de résultat.',
//qqq: 'Message when there are no results.',
},
'button-gosearch': {
en: 'Search',
de: 'Suchen',
fr: 'Rechercher',
//qqq: 'Button where the user clicks to search.',
},
'button-resetsearch': {
en: 'Reset',
de: 'Löschen',
fr: 'Effacer',
//qqq: 'Button where the user clicks to reset the form.',
},
'button-datasets': {
en: 'Datasets',
de: 'Datensätze',
fr: 'Jeux de données',
//qqq: 'Button - link to datasets.',
},
'placeholder': {
en: ' Select or type',
fr: ' Sélectionner ou écrire',
//qqq: 'Placeholder for the fields.',
},
};
const userLanguage = mw.config.get( 'wgPageContentLanguage' );
mw.loader.using( ['oojs', 'oojs-ui', 'mediawiki.api', 'ext.recordWizard.wikibase'], function () {
oouiSelectors = {
'speaker': null,
'gender': null,
'language': null,
'proficiency': null,
};
var sparqlGlobal = {
'speaker': 'SELECT ?speaker ?speakerLabel ?gender ?language ?proficiency WHERE { ?speaker prop:P2 entity:Q3 . OPTIONAL { ?speaker prop:P8 ?gender } . OPTIONAL { ?speaker llp:P4 ?statement . ?statement llv:P4 ?language . OPTIONAL { ?statement llq:P16 ?proficiency } } . SERVICE wikibase:label { bd:serviceParam wikibase:language "' + userLanguage + ',fr,en" } } ORDER BY ?speakerLabel',
'gender': 'SELECT DISTINCT ?gender ?genderLabel WHERE { ?gender prop:P2 entity:Q7 . SERVICE wikibase:label { bd:serviceParam wikibase:language "' + userLanguage + ',fr,en" } } ORDER BY ?gender',
'language': 'SELECT DISTINCT ?language ?languageLabel WHERE { ?language prop:P2 entity:Q4 . SERVICE wikibase:label { bd:serviceParam wikibase:language "' + userLanguage + ',fr,en" } } ORDER BY ?languageLabel',
'proficiency': 'SELECT DISTINCT ?proficiency ?proficiencyLabel WHERE { ?proficiency prop:P2 entity:Q5 . SERVICE wikibase:label { bd:serviceParam wikibase:language "' + userLanguage + ',fr,en" } } ORDER BY ?proficiency',
};
const htmlElements = {
'speaker': '#sndlib-filteruser',
'gender': '#sndlib-filtergender',
'language': '#sndlib-filterlanguage',
'proficiency': '#sndlib-filterlevelofproficiency',
};
const unknown = {};
request = {
'speaker': '',
'gender': '',
'language': '',
'proficiency': '',
};
lastRequest = {
'speaker': '',
'gender': '',
'language': '',
'proficiency': '',
};
speakersCriteria = [];
list = {
'speaker': null,
'gender': null,
'language': null,
'proficiency': null,
};
mapping = {
'speaker': null,
'gender': null,
'language': null,
'proficiency': null,
};
automaticField = {
'speaker': null,
'gender': null,
'language': null,
'proficiency': null,
};
// Helper function to obtain the Qvalue of some selector
function getQValue( type ) {
var rawValue;
if( type === 'speaker' || type === 'language' ) {
rawValue = oouiSelectors[type].getValue();
} else {
rawValue = oouiSelectors[type].getMenu().findSelectedItem() ? oouiSelectors[type].getMenu().findSelectedItem().getData() : '';
}
rawValue = rawValue.trim();
if( !rawValue ) {
return null;
} else if( /^Q[0-9]+$/.test( rawValue ) ) {
return rawValue;
} else if( /\((Q[0-9]+)\)$/.test( rawValue ) ) {
return rawValue.replace( /.*\((Q[0-9]+)\)$/, '$1' );
} else {
return '';
}
}
// Helper function to dedupe a sorted list
function dedupe( arr, fn ) {
if( fn ) {
return arr.filter( function( x, i, a ) {
return !i || fn( x ) !== fn( a[i-1] );
} );
}
return arr.filter( function( x, i, a ) {
return !i || x !== a[i-1];
} );
}
// Returns the list of items of a given type for a restricted list of Qids
function getListSelectorFromQids( type, qids ) {
const indexes = dedupe( qids.map( function( x ) {
return mapping[type][x];
} ).sort( function( a, b ) { return a-b; } ) );
const r = indexes.map( function( x ) {
return list[type][x];
} );
return r;
}
// Initialise a selector and keep the list in memory the result for later reuse
function updateSelector( type, force ) {
return function( values, emptyValue ) {
if( emptyValue === undefined ) {
emptyValue = true;
}
console.debug( 'updateSelector('+type+','+force+')('+(values?values.length:'null')+' values,'+(emptyValue===true?'true':(emptyValue===null?'null':(emptyValue===false?'false':'autre')))+')' );
const widgetType = type === 'speaker' || type === 'language' ? 'ComboBoxInputWidget' : 'DropdownWidget';
if( !list[type] ) {
// Save the list in a global variable to quickly filter then
// We dedupe because the 'speaker' (only) has duplicate (ordered) values
const v = values.results.bindings;
list[type] = dedupe( v, function( x ) { return x[type].value; } );
if( widgetType === 'DropdownWidget' ) {
var emptyItem = [ {} ];
emptyItem[0][type] = { value: '' };
emptyItem[0][type+'Label'] = { value: ' ' };
list[type] = emptyItem.concat( list[type] );
}
values = list[type];
// Save the mapping Qxx → index to update the list from a list of Qxx (see doQuery)
console.debug( type, list[type] );
mapping[type] = list[type].reduce( function( o, x, i ) {
o[ x[type].value.substr( 31 ) ] = i;
return o;
}, {} );
// Save the global matrix: speaker x gender x language x proficiency
if( type === 'speaker' ) {
speakersCriteria = v.map( function( x ) {
return [
x.speaker.value.substr( 31 ),
!x.gender || x.gender.type === 'bnode' ? unknown : x.gender.value.substr( 31 ),
!x.language || x.language.type === 'bnode' ? unknown : x.language.value.substr( 31 ),
!x.proficiency || x.proficiency.type === 'bnode' ? unknown : x.proficiency.value.substr( 31 ),
];
} );
}
}
// Never update manual selectors (except if the user forces the reset)
if( !force && getQValue( type ) && automaticField[type] === false ) {
console.debug( 'updateSelector('+type+','+force+')('+(values?values.length:'null')+' values): abort1' );
return;
}
if( force || values === null ) {
values = list[type];
}
// If there are at least one unknown value, reset the selector
if( values.filter( function( x ) { return x === undefined; } ).length ) {
values = list[type];
console.debug( 'updateSelector('+type+','+force+')('+(values?values.length:'null')+' values): abort2' );
}
// For dropdowns, add an empty item if there is none
if( widgetType === 'DropdownWidget' && values.length && values[0][type].value ) {
var emptyItem = [ {} ];
emptyItem[0][type] = { value: '' };
emptyItem[0][type+'Label'] = { value: ' ' };
values = emptyItem.concat( values );
}
// Create the OOUI selector
oouiSelectors[type] = new OO.ui[widgetType]( {
placeholder: messages['placeholder'][userLanguage] ? messages['placeholder'][userLanguage] : messages['placeholder'].en,
menu: {
filterFromInput: true,
items: values.map( function( x ) {
return new OO.ui.MenuOptionWidget( {
data: widgetType === 'ComboBoxInputWidget' ? x[ type + 'Label' ].value + " (" + x[type].value.substr( 31 ) + ")" : x[type].value.substr( 31 ),
label: x[ type + 'Label' ].value
} );
} )
}
} );
if( widgetType === 'DropdownWidget' && values.length > 2 ) {
oouiSelectors[type].getMenu().items[0].toggle( false );
}
if( widgetType === 'ComboBoxInputWidget' && values.length === 1 ) {
oouiSelectors[type].setValue( values[0][ type + 'Label' ].value + " (" + values[0][type].value.substr( 31 ) + ")" );
// For dropdown, when there is one real value, there is also the empty value as first option
} else if( widgetType === 'DropdownWidget' && values.length === 2 ) {
oouiSelectors[type].getMenu().selectItemByData( values[1][type].value.substr( 31 ) );
}
$( htmlElements[type] ).html('').append(
oouiSelectors[type].$element
);
if( !force ) {
console.debug( '!force', type, getQValue( type ), automaticField[type] );
if( automaticField[type] !== false ) {
automaticField[type] = getQValue( type ) ? true : emptyValue;
}
console.debug( 'updateSelector('+type+','+force+')('+(values?values.length:'null')+' values): on passe en automatique' );
} else {
automaticField[type] = null;
console.debug( 'updateSelector('+type+','+force+')('+(values?values.length:'null')+' values): on passe en manuel' );
}
if( widgetType === 'ComboBoxInputWidget' ) {
oouiSelectors[type].on( 'change', function() {
if( getQValue( type ) === '' ) {
return;
}
onChange( type );
} );
} else {
oouiSelectors[type].getMenu().on( 'select', function( item ) {
if( item.getData() === '' ) {
item.toggle( false );
} else {
oouiSelectors[type].getMenu().items[0].toggle( true );
}
onChange( type );
} );
}
};
}
function onChange( type ) {
// Logique ternaire pour les sélecteurs :
// - null := sélecteur indéterminé, pouvant être réduit sous l’influence d’autres sélecteurs
// - false := sélecteur manuel, n’étant jamais réduit sous l’influence d’autres sélecteurs et étant toujours étendus (=comprend toutes les valeurs possibles)
// - true := sélecteur automatique, étant toujours réduit sous l’influence d’autres sélecteurs
console.debug( 'onChange('+type+')' );
var state = {
speaker: getQValue( 'speaker' ),
gender: getQValue( 'gender' ),
language: getQValue( 'language' ),
proficiency: getQValue( 'proficiency' ),
};
var nbFilled = 1, emptyValue = true;
if( state[type] ) {
if( state[type] !== request[type] ) {
automaticField[type] = false;
console.debug( 'onChange('+type+'): on passe en manuel' );
}
} else {
automaticField[type] = null;
emptyValue = null;
nbFilled = ( automaticField.language === false && state.language ? 1 : 0 )
+ ( automaticField.speaker === false && state.speaker ? 1 : 0 )
+ ( automaticField.gender === false && state.gender ? 1 : 0 )
+ ( automaticField.proficiency === false && state.proficiency ? 1 : 0 );
if( nbFilled > 1 ) {
automaticField[type] = false;
emptyValue = true;
if( type !== 'speaker' && !state.speaker && automaticField.speaker === true ) {
automaticField.speaker = emptyValue;
}
if( type !== 'gender' && !state.gender && automaticField.gender === true ) {
automaticField.gender = emptyValue;
}
if( type !== 'language' && !state.language && automaticField.language === true ) {
automaticField.language = emptyValue;
}
if( type !== 'proficiency' && !state.proficiency && automaticField.proficiency === true ) {
automaticField.proficiency = emptyValue;
}
} else {
emptyValue = null;
if( !state.speaker ) {
automaticField.speaker = emptyValue;
}
if( !state.gender ) {
automaticField.gender = emptyValue;
}
if( !state.language ) {
automaticField.language = emptyValue;
}
if( !state.proficiency ) {
automaticField.proficiency = emptyValue;
}
}
}
console.debug( nbFilled, state[type], emptyValue, automaticField );
// Do not reduce fields above one change by the user, else it leads to a bad User Experience
// because fields change themselves with a hardly-understandable logic
//var nbFilled = ( state.language ? 1 : 0 ) + ( state.speaker ? 1 : 0 ) + ( state.gender ? 1 : 0 ) + ( state.proficiency ? 1 : 0 );
//if( nbFilled > 1 ) {
// return;
//}
var potentialSpeakers = speakersCriteria;
if( state.language ) {
potentialSpeakers = reduceSpeakers( 2, state.language, potentialSpeakers );
}
if( state.speaker ) {
potentialSpeakers = reduceSpeakers( 0, state.speaker, potentialSpeakers );
}
if( state.gender ) {
potentialSpeakers = reduceSpeakers( 1, state.gender, potentialSpeakers );
}
if( state.proficiency ) {
potentialSpeakers = reduceSpeakers( 3, state.proficiency, potentialSpeakers );
}
var listSpeaker = automaticField.speaker !== false ? getListSelectorFromQids( 'speaker', dedupe( potentialSpeakers.map( function( x ) { return x[0]; } ) ) ) : null;
var listGender = automaticField.gender !== false ? getListSelectorFromQids( 'gender', dedupe( potentialSpeakers.map( function( x ) { return x[1]; } ) ) ) : null;
var listLanguage = automaticField.language !== false ? getListSelectorFromQids( 'language', dedupe( potentialSpeakers.map( function( x ) { return x[2]; } ) ) ) : null;
var listProficiency = automaticField.proficiency !== false ? getListSelectorFromQids( 'proficiency', dedupe( potentialSpeakers.map( function( x ) { return x[3]; } ) ) ) : null;
// Update the selectors with the restricted values
updateSelector( 'speaker' )( listSpeaker, emptyValue );
updateSelector( 'gender' )( listGender, emptyValue );
updateSelector( 'language' )( listLanguage, emptyValue );
updateSelector( 'proficiency' )( listProficiency, emptyValue );
request = {
speaker: getQValue( 'speaker' ),
gender: getQValue( 'gender' ),
language: getQValue( 'language' ),
proficiency: getQValue( 'proficiency' ),
};
console.debug( automaticField );
}
function initSelectors() {
$.getJSON(
'https://lingualibre.org/bigdata/namespace/wdq/sparql',
{
query: sparqlGlobal['speaker']
}
).done( updateSelector( 'speaker', true ) );
$.getJSON(
'https://lingualibre.org/bigdata/namespace/wdq/sparql',
{
query: sparqlGlobal['gender']
}
).done( updateSelector( 'gender', true ) );
$.getJSON(
'https://lingualibre.org/bigdata/namespace/wdq/sparql',
{
query: sparqlGlobal['language']
}
).done( updateSelector( 'language', true ) );
$.getJSON(
'https://lingualibre.org/bigdata/namespace/wdq/sparql',
{
query: sparqlGlobal['proficiency']
}
).done( updateSelector( 'proficiency', true ) );
$('#sndlib-savefiltersearch').wrapInner( '<a style="color:white"></a>' );
}
function reset() {
lastRequest = {
speaker: '',
gender: '',
language: '',
proficiency: '',
};
updateSelector( 'speaker', true )( list.speaker );
updateSelector( 'gender', true )( list.gender );
updateSelector( 'language', true )( list.language );
updateSelector( 'proficiency', true )( list.proficiency );
$( '#sndlib-audioresults' ).html( '' );
$( '#sndlib-audioPages' ).html( '' );
}
function reduceSpeakers( index, value, arr ) {
return arr.filter( function( x ) {
return x[index] === value;
} );
}
// Add button 'Search'
$( '#sndlib-gosearch' ).html('').append(
( new OO.ui.ButtonInputWidget( {
label: messages['button-gosearch'][userLanguage] ? messages['button-gosearch'][userLanguage] : messages['button-gosearch'].en
} ) ).on( 'click', doQuery ).$element
);
// Add button 'Reset'
$( '#sndlib-resetsearch' ).html('').append(
( new OO.ui.ButtonInputWidget( {
label: messages['button-resetsearch'][userLanguage] ? messages['button-resetsearch'][userLanguage] : messages['button-resetsearch'].en
} ) ).on( 'click', reset ).$element
);
// Add button 'Datasets' - it seems that OOUI ButtonWidget.setHref does not work
var buttonDatasetsA = $( '<a href="https://lingualibre.org/datasets/"></a>' );
var buttonDatasets = new OO.ui.ButtonInputWidget( {
label: messages['button-datasets'][userLanguage] ? messages['button-datasets'][userLanguage] : messages['button-datasets'].en,
} );
var buttonDatasetsLinked = buttonDatasetsA.append( buttonDatasets.$element );
$( '#sndlib-datasetsButton' ).html('').append( buttonDatasetsLinked );
function setDownloadLink( data ) {
if ( data.results === undefined || data.results.bindings === undefined ) {
displayError( 'error: no result from SPARQL' );
return;
}
function escapeCsv( val ) {
if( !val ) {
return '""';
}
return '"' + val.value.replaceAll( '"', '""' ) + '"';
}
var csv = 'data:application/csv;charset=utf-8,' + encodeURIComponent( data.results.bindings.map( function( x ) {
return [
escapeCsv( x.speakerName ),
escapeCsv( x.genderLabel ),
escapeCsv( x.languageLabel ),
escapeCsv( x.proficiencyLabel ),
escapeCsv( x.word ),
escapeCsv( x.file ),
escapeCsv( x.date ),
].join( ',' );
} ).join( "\n" ) );
$('#sndlib-savefiltersearch a').attr( {
download: 'export-lili.csv',
href: csv,
} );
}
// Display results
function createAudioBoxesForSearch( data ) {
if ( data.results === undefined || data.results.bindings === undefined ) {
displayError( 'error: no result from SPARQL' );
return;
}
if ( data.results.bindings.length < 1 ) {
$( '#sndlib-audioresults' ).html( messages['msg-no-results'][userLanguage] ? messages['msg-no-results'][userLanguage] : messages['msg-no-results'].en );
$( '#sndlib-audioPages' ).html( '' );
return;
}
var length = data.results.bindings.length <= nbTotalResults ? data.results.bindings.length : nbTotalResults;
var moreResults = data.results.bindings.length > nbTotalResults;
console.debug( 'SPARQL results', data.results.bindings );
function displayAudioBoxes( index ) {
$( '#sndlib-audioresults' ).html( '' );
for( var i = 0; i < nbResultsPerPage && i+index*nbResultsPerPage < length; i++ ) {
var box = $( '<div class="audiobox"> <div class="ab-playbutton"><i></i></div> <div> <div class="ab-title">...</div> <div class="ab-metadata">...</div> </div> </div>' );
var audiobox = new AudioBox( data.results.bindings[ i+index*nbResultsPerPage ].record.value.substr( 31 ), box );
$( '#sndlib-audioresults' ).append( box );
}
function applyFn( i ) {
return function() {
displayAudioBoxes( i );
return false;
}
}
$( '#sndlib-audioPages' ).html( '' );
for( var i = 0; i < Math.ceil( length/nbResultsPerPage ); i++ ) {
var link = $( '<a href="#"' + ( i === index ? ' class="selected"' : '' ) + '>' + (i+1) + '</a>' ).on( 'click', applyFn( i ) );
$( '#sndlib-audioPages' ).append( link ).append( i < Math.ceil( length/nbResultsPerPage )-1 ? ' ' : '' );
}
if( moreResults ) {
$( '#sndlib-audioPages' ).append( ' (et bien d’autres résultats)' );
}
}
displayAudioBoxes( 0 );
var recordsEntities = data.results.bindings.map( function( x ) {
return 'entity:' + x.record.value.substr( 31 );
} ).join( ',' );
console.debug( recordsEntities );
console.debug( 'SELECT ?record ?speakerName ?languageLabel ?word ?file ?date ?proficiencyLabel ?genderLabel WHERE { ?record prop:P2 entity:Q2 ; prop:P4 ?language ; prop:P5 ?speaker ; prop:P7 ?word ; prop:P3 ?file ; prop:P6 ?date . ?speaker llp:P4 [ llv:P4 ?language ; llq:P16 ?proficiency ] ; prop:P8 ?gender . ?speaker rdfs:label ?speakerName . FILTER( ?record IN (' + recordsEntities + ') ) . FILTER( LANG( ?speakerName ) = "en" ) . SERVICE wikibase:label { bd:serviceParam wikibase:language "' + userLanguage + ',fr,en" } }' );
$.getJSON(
'https://lingualibre.org/bigdata/namespace/wdq/sparql',
{
query: 'SELECT ?record ?speakerName ?languageLabel ?word ?file ?date ?proficiencyLabel ?genderLabel WHERE { ?record prop:P2 entity:Q2 ; prop:P4 ?language ; prop:P5 ?speaker ; prop:P7 ?word ; prop:P3 ?file ; prop:P6 ?date . ?speaker llp:P4 [ llv:P4 ?language ; llq:P16 ?proficiency ] ; prop:P8 ?gender . ?speaker rdfs:label ?speakerName . FILTER( ?record IN (' + recordsEntities + ') ) . FILTER( LANG( ?speakerName ) = "en" ) . SERVICE wikibase:label { bd:serviceParam wikibase:language "' + userLanguage + ',fr,en" } }'
}
).done( setDownloadLink );
}
// Do SPARQL request from filters
function doQuery() {
request = {
speaker: getQValue( 'speaker' ),
gender: getQValue( 'gender' ),
language: getQValue( 'language' ),
proficiency: getQValue( 'proficiency' ),
};
if( JSON.stringify( request ) === JSON.stringify( lastRequest ) ) {
return;
}
lastRequest = request;
// When all fields are empty, do not query
if( !request.speaker && !request.gender && !request.language && !request.proficiency ) {
return;
}
var potentialSpeakers = speakersCriteria;
var query = "SELECT ?record ?speaker ?language WHERE { ?record prop:P2 entity:Q2 ; prop:P4 ?language ; prop:P5 ?speaker . ";
if( request.language ) {
query += "?record prop:P4 entity:" + request.language + " . ";
potentialSpeakers = reduceSpeakers( 2, request.language, potentialSpeakers );
}
if( request.speaker ) {
query += "?record prop:P5 entity:" + request.speaker + " . ";
potentialSpeakers = reduceSpeakers( 0, request.speaker, potentialSpeakers );
}
if( request.gender ) {
potentialSpeakers = reduceSpeakers( 1, request.gender, potentialSpeakers );
}
if( request.proficiency ) {
potentialSpeakers = reduceSpeakers( 3, request.proficiency, potentialSpeakers );
query += "?speaker llp:P4 [ llv:P4 ?language ; llq:P16 entity:" + request.proficiency + " ] . ";
}
if( potentialSpeakers.length < speakersCriteria.length ) {
var listSpeakers = dedupe( potentialSpeakers.map( function( x ) {
return 'entity:' + x[0];
} ) ).join();
query += 'FILTER( ?speaker IN (' + listSpeakers + ') )';
}
query += "} LIMIT " + (nbTotalResults+1);
// Voir https://commons.wikimedia.org/wiki/Category:Throbbers - il faut que le fond soit transparent
$( '#sndlib-audioresults' ).html( '' ).append( '<img src="https://upload.wikimedia.org/wikipedia/commons/7/7a/Balls.gif" width="50" />' );
// Execute the request
var result = $.getJSON(
'https://lingualibre.org/bigdata/namespace/wdq/sparql',
{
query: query,
//Accept: 'application/sparql-results+json'
}
);
result.then( createAudioBoxesForSearch, displayError );
}
initSelectors();
} );
} );