Skip to content

Latest commit

 

History

History
248 lines (228 loc) · 8.68 KB

todo.md

File metadata and controls

248 lines (228 loc) · 8.68 KB
Raw

OAI-PMH server for lodel

Docs

SPEC

  • upgrade script

    • add
      • id_oai: should be site short name
      • prefixe_doi
      • openaire_access_level : openAccess, embargoedAccess, restrictedAccess

  • harvest

    • one url for all sites, sites are haversted using sets
    • from date
    • from set
    • must be able to know latest documents from all site: must have a table with all document and their location
    • must update documents list
      • cron
        • script to fill the database
      • trigger
      • both
    • type of documents
      • should be in a config file
      • classe "publications", type "numero" issue other
      • classe "publications", type "souspartie" part other
      • classe "textes", type "article" article article
      • classe "textes", type "chronique" article other
      • classe "textes", types "compterendu" et "notedelecture" review review
      • classe "textes", type "editorial"

  • entry script

    • oai.php
      • connect to lodel (load lodel main config)
      • create OAI server
      • sets
      • records
      • send response

  • config file

    • our database name
    • credentials are in lodel config

  • database

    • list of sites
      • id
      • name # lodel name, site of origin
      • title # pretty name
      • set # journals || book
      • oai_id # set
      • upd # last update
      • description OPTIONS.METADONNEESSITE.DROITSAUTEUR OPTIONS.EXTRA.OPENAIRE_ACCESS_LEVEL OPTIONS.METADONNEESSITE.EDITEUR OPTIONS.METADONNEESSITE.TITRESITE site_url OPTIONS.EXTRA.PREFIXE_DOI OPTIONS.METADONNEESSITE.ISSN OPTIONS.METADONNEESSITE.ISSN_ELECTRONIQUE OPTIONS.METADONNEESSITE.LANGUEPRINCIPALE
    • list of documents (should be able to list identifiers)
      • id
      • identity # id sur le site lodel
      • title
      • date
      • set
      • site # of origin (lodel name) => NO is same as set
      • class (lodel class)
      • type (lodel type)
      • type_dc => NO is same as class, type
      • type_oa => NO is same as class, type

  • plugin lodel (optional)

    • update oai lists when documents are updated

  • script

    • update list of sites
    • update list of documents
    • delete list of sites and documents

  • records:

    • dc record dc:title title dc:creator creator[] dc:contibutor contributor[] dc:rights rights, accessrights dc:date issued, embargoed dc:publisher publisher[] dc:identifier identifier_url, identifier_doi dc:language language dc:type type[] dc:coverage coverage[] dc:subjects subjects[] dc:description abstract[] or description dc:relation issn, eissn
    • qdc dcterms:title title dcterms:alternative alternative[] dcterms:creator creator[] dcterms:contibutor contributor[] dcterms:issued issued dcterms:accessRights accessrights dcterms:available embargoed dcterms:publisher publisher[] dcterms:identifier identifier_url, identifier_doi dcterms:isPartOf issn, eissn dcterms:hasFormat ? dcterms:language language dcterms:type type[] dcterms:rights rights dcterms:extent extend dcterms:spatial spatial[] dcterms:temporal temporal[] dcterms:subjects subjects[] dctems:abstract abstract[] dctems:description description dcterms:bibliographicalCitation bibliographicCitation[issue]
    • mets

Protocol

Librairies

Rsync auto

while inotifywait -r -e attrib,modify,create,delete,move .; do rsync -avz --delete --exclude-from=.rsyncignore . /target done

project structure

/ index.php : entry point config.php.txt => config.php tools/ setup.php : database setup (or reinit) update_db.php : update sets and records inc/ init.php : load everything config.php : take care of config lodel.php : lodel connection sql.php : sql functions oai.php : oai functions utils.php : other functions record.php : record functions

Mets

omg j'ai pas envie de faire ce format… va fallir 10 ans pour écrire et comprendre la spec :

  • only for publications, numero

  • <mets:dmdSec ID=""> : list of all document of the structure

    • attr: ID : uniq id → oai_id : elem id
    • <mets:mdWrap MDTYPE="DC" LABEL="Dublin Core Descriptive Metadata" MIMETYPE="text/xml">
      • mets:xmlData
        • qdc of document

  • mets:fileSec

    • <mets:fileGrp ID="FG:site_oai:255"> : list of class==texte document and their format
      • <mets:file ID="site_oai:xhtml:255" MIMETYPE="text/html"> <mets:FLocat LOCTYPE="URL" xlink:href="http://edinum.org/site/255"/> </mets:file> TODO: what other formats ?
        • PDF (included files)
        • TEI

  • mets:structMap : list of all element, nested

    • <mets:div LABEL="titre" TYPE="mets_type" DMDID="reference to dmd id" ID="reference to nothing">
      • <mets:fptr FILEID="reference to fileSec id"/>

    types: 'publications' => [ 'numero' => ['mets'=>'issue'], 'souspartie' => ['mets'=>'part'], ], 'textes' => [ 'article' => ['mets'=>'article'], 'chronique' => ['mets'=>'article'], 'compterendu' => ['mets'=>'review'], 'notedelecture' => ['mets'=>'review'], 'editorial' => ['mets'=>'introduction'], ],

    mets : func mets(id, map, dmd, file) dmd[] = oai_id:elem_id + qdc map = map[] titre + dmd_id if class == texte filegrp[] = FG:oai_id:elem_id foreach type of file filegrp[][] = oai_id:file_type:elem_id map fptr else foreach children mets(children_id, map, dmd, file)

Create xml tree

(&$parent, $tree) name, value, attr, children if children foreach children recurs (me, $child)

TODO:

  • better error description in server
  • dates must be UTC
    • double check modification dates it is important for incremental harvest (YES it is)
  • site name oai-pmh could be a config (change all connect_site())
  • re-read file section for mets, must find docannexe, url for pdf or TEI could be config or user function