wikibase-cli/lib/generate_select_sparql_query.js

A command-line interface to Wikibase

import formatStatementElementValue from './format_statement_element_value.js'

export function generateSelectSparqlQuery (program) {
  let { count: countResults, labels: selectLabels, lang, qualifierProperty, qualifierObject, statementProperty } = program

  const useSubSnaks = (qualifierProperty != null || qualifierObject != null)

  selectLabels = selectLabels && !countResults

  if (program.subject && program.property && program.object) {
    console.log('At maximum two main statement elements should be set')
    process.exit(1)
  }

  let select = ''
  let triple
  if (useSubSnaks) {
    triple = `?subject ?pProperty ?statement .
  ?statement ?psProperty ?object .
  ?statement ?pqProperty ?pqObject .`
  } else if (statementProperty) {
    triple = `?subject ?psProperty ?object .`
  } else {
    triple = '?subject ?property ?object .'
  }

  const setElement = (elName, value) => {
    value = value || program[elName]
    if (value) {
      value = formatStatementElementValue[elName](value)
      triple = triple.replace(`?${elName}`, value)
    } else {
      if (countResults) {
        // Get a count by selecting the first missing variable
        if (select === '') select = `(COUNT(?${elName}) AS ?count)`
      } else {
        select += `?${elName} `
        if (selectLabels && elName !== 'property') select += `?${elName}Label `
      }
      // If the property isn't set, specify that we want only direct/truthy claims
      // and not every statements and qualifiers
      if (elName === 'property') {
        triple += '\n  ?prop wikibase:directClaim ?property .'
        if (selectLabels) select += '?propLabel '
      }
    }
  }

  setElement('subject')
  if (useSubSnaks) {
    setElement('pProperty', program.property)
    setElement('psProperty', statementProperty || program.property)
    if (qualifierProperty) setElement('pqProperty', qualifierProperty)
    if (qualifierObject) setElement('pqObject', qualifierObject)
  } else if (statementProperty) {
    setElement('psProperty', statementProperty)
  } else {
    setElement('property')
  }
  setElement('object')

  if (selectLabels) {
    // Include [AUTO_LANGUAGE], especially useful if program.open === true
    if (lang === 'en') {
      lang = 'en,[AUTO_LANGUAGE]'
    } else {
      // Include English as a fallback
      lang = `${lang},[AUTO_LANGUAGE],en`
    }
    triple += `
  SERVICE wikibase:label {
    bd:serviceParam wikibase:language "${lang}" .
  }`
  }

  const { limit } = program

  let sparql = `SELECT ${select.trim()} WHERE {
  ${triple}
}`
  if (limit) sparql += `\nLIMIT ${limit}`

  return sparql
}