Gedcom::FOAF - Output FOAF files from Gedcom individuals and families

Gedcom-FOAF documentation Contained in the Gedcom-FOAF distribution.

Index

Code Index:

NAME

Top

Gedcom::FOAF - Output FOAF files from Gedcom individuals and families

SYNOPSIS

Top

    use Gedcom;
    use Gedcom::FOAF;

    my $gedcom = Gedcom->new( gedcom_file => 'myfamily.ged' );
    my $i = $gedcom->get_individual( 'Butch Cassidy' );

    # print the individual's FOAF
    print $i->as_foaf;

    my( $f ) = $i->famc;

    # print the individual's family's (as a child) FOAF
    print $f->as_foaf;

DESCRIPTION

Top

This module provides as_foaf methods to individual and family records. The resulting files can be parsed and crawled (scuttered) by any code that understands the FOAF and RDF specs.

URL TEMPLATES

Top

You can supply 3 different url templates.

* individual
* family
* photo

These templates are used to link between foaf representations of individuals and families, plus provide photo urls for their profiles. The individual and family templates will have an xref param, and the photo template will have a photo param.

    {
        individual => 'http://foo.com/i/{xref}?fmt=foaf',
        family     => 'http://foo.com/f/{xref}?fmt=foaf',
        photo      => 'http://foo.com/static/photos/{photo}',
    }

METHODS

Top

Gedcom::Individual

as_foaf( \%opts )

Generates a FOAF (XML) string from the Gedcom::Individual object. Pass in the url templates as described above to suit your needs.

label_name

Generates a string suitable for an foaf:name element.

Gedcom::Family

as_foaf( \%opts )

Generates a FOAF (XML) string from the Gedcom::Family object. Pass in the url templates as described above to suit your needs.

AUTHOR

Top

Brian Cassidy <bricas@cpan.org>

COPYRIGHT AND LICENSE

Top

Copyright 2005-2009 by Brian Cassidy

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

Gedcom-FOAF documentation Contained in the Gedcom-FOAF distribution. 
package Gedcom::FOAF;


use strict;
use warnings;

use XML::LibXML;

our $VERSION = '0.05';

my %namespaces = (
    rdf  => 'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
    rdfs => 'http://www.w3.org/2000/01/rdf-schema#',
    rel  => 'http://purl.org/vocab/relationship/',
    foaf => 'http://xmlns.com/foaf/0.1/',
    bio  => 'http://purl.org/vocab/bio/0.1/'
);

my %compat_urls = (
    individual => '{xref}.xml',
    family     => '{xref}.xml',
    photo      => 'photos/{photo}'
);

sub _prep_opts {
    my $opts = shift;

    if ( ref $opts ) {
        $opts->{ $_ } ||= '' for keys %compat_urls;
        return $opts;
    }

    my $base = $opts || '';
    $opts = { map { $_ => "${base}$compat_urls{ $_ }" } keys %compat_urls };

    return $opts;
}

package Gedcom::Individual;


sub as_foaf {
    my $self = shift;
    my $opts = Gedcom::FOAF::_prep_opts( shift );
    my $xml  = XML::LibXML::Document->new( '1.0', 'UTF-8' );

    my $rdf = $xml->createElement( 'RDF' );

    $rdf->setNamespace( $namespaces{ rdf },  'rdf' );
    $rdf->setNamespace( $namespaces{ rdfs }, 'rdfs', 0 );
    $rdf->setNamespace( $namespaces{ rel },  'rel', 0 );
    $rdf->setNamespace( $namespaces{ foaf }, 'foaf', 0 );
    $rdf->setNamespace( $namespaces{ bio },  'bio', 0 );

    $xml->setDocumentElement( $rdf );

    for ( $self->famc, $self->fams ) {
        $rdf->appendChild( $_->_foaf_seealso( $self, $opts ) );
    }

    my $xref = $self->xref;
    ( my $href = $opts->{ individual } ) =~ s{\{xref\}}{$xref}g;

    my $person = $xml->createElement( 'foaf:Person' );
    $person->setAttribute( 'rdf:about' => "$href#$xref" );

    my $name = $xml->createElement( 'foaf:name' );
    $name->appendText( $self->label_name );

    my $firstname = $xml->createElement( 'foaf:givenname' );
    $firstname->appendText( $self->given_names );

    my $lastname = $xml->createElement( 'foaf:family_name' );
    $lastname->appendText( $self->surname );

    $person->appendChild( $name );
    $person->appendChild( $firstname );
    $person->appendChild( $lastname );

    for my $photo ( $self->tag_value( 'PHOT' ) ) {
        ( my $href = $opts->{ photo } ) =~ s{\{photo\}}{$photo}g;
        my $depic = $xml->createElement( 'foaf:depiction' );
        $depic->setAttribute( 'rdf:resource' => $href );

        $person->appendChild( $depic );
    }

    $person->appendChild( $self->_foaf_event( 'birth' ) ) if $self->birth;
    $person->appendChild( $self->_foaf_event( 'death' ) ) if $self->death;

    my $sex = $self->sex eq 'M' ? 'male' : $self->sex eq 'F' ? 'female' : '';

    if ( $sex ) {
        my $gender = $xml->createElement( 'foaf:gender' );
        $gender->appendText( $sex );
        $person->appendChild( $gender );
    }

    for (
        $self->_foaf_rel( 'parents',  'child',   $opts ),
        $self->_foaf_rel( 'spouse',   'spouse',  $opts ),
        $self->_foaf_rel( 'siblings', 'sibling', $opts ),
        $self->_foaf_rel( 'children', 'parent',  $opts ),
        )
    {
        $person->appendChild( $_ );
    }

    $rdf->addChild( $person );

    for ( $self->parents, $self->siblings, $self->spouse, $self->children ) {
        $rdf->addChild( $_->_foaf_seealso( $opts ) );
    }

    return $xml->toString( 1 );
}

sub _foaf_event {
    my $self = shift;
    my $name = lc( shift );

    my $event = XML::LibXML::Element->new( 'bio:event' );
    my $type  = XML::LibXML::Element->new( 'bio:' . ucfirst( $name ) );
    my $date  = XML::LibXML::Element->new( 'bio:date' );
    my $place = XML::LibXML::Element->new( 'bio:place' );

    $date->appendText( $self->get_value( "$name date" )   || 'UNKNOWN' );
    $place->appendText( $self->get_value( "$name place" ) || 'UNKNOWN' );

    $type->appendChild( $date );
    $type->appendChild( $place );

    $event->appendChild( $type );

    return $event;
}

sub _foaf_rel {
    my $self   = shift;
    my $method = shift;
    my $rel    = shift;
    my $opts   = shift;

    my @rels;

    for my $person ( $self->$method ) {
        my $xref = $person->xref;
        ( my $href = $opts->{ individual } ) =~ s{\{xref\}}{$xref}g;
        my $element = XML::LibXML::Element->new( 'rel:' . $rel . 'Of' );
        $element->setAttribute( 'rdf:resource' => "$href#$xref" );
        push @rels, $element;
    }

    return @rels;
}

sub _foaf_seealso {
    my $self = shift;
    my $opts = shift;
    my $xref = $self->xref;
    ( my $href = $opts->{ individual } ) =~ s{\{xref\}}{$xref}g;

    my $person = XML::LibXML::Element->new( 'foaf:Person' );
    $person->setAttribute( 'rdf:about' => "$href#$xref" );

    my $name = XML::LibXML::Element->new( 'foaf:name' );
    $name->appendText( $self->label_name );

    my $seealso = XML::LibXML::Element->new( 'rdfs:seeAlso' );
    $seealso->setAttribute( 'rdf:resource' => "$href#$xref" );

    $person->appendChild( $name );
    $person->appendChild( $seealso );

    return $person;
}


sub label_name {
    my $self = shift;

    return join( ' ', $self->given_names, $self->surname );
}

package Gedcom::Family;


sub as_foaf {
    my $self = shift;
    my $opts = Gedcom::FOAF::_prep_opts( shift );
    my $xml  = XML::LibXML::Document->new( '1.0', 'UTF-8' );

    my $rdf = $xml->createElement( 'RDF' );

    $rdf->setNamespace( $namespaces{ rdf },  'rdf' );
    $rdf->setNamespace( $namespaces{ rdfs }, 'rdfs', 0 );
    $rdf->setNamespace( $namespaces{ foaf }, 'foaf', 0 );
    $rdf->setNamespace( $namespaces{ bio },  'bio', 0 );

    $xml->setDocumentElement( $rdf );
    my $xref  = $self->xref;
    my $group = $xml->createElement( 'foaf:Group' );
    ( my $href = $opts->{ family } ) =~ s{\{xref\}}{$xref}g;
    $group->setAttribute( 'rdf:about' => "$href#$xref" );

    my $label = $xml->createElement( 'rdfs:label' );

    my $husband = $self->husband;
    my $wife    = $self->wife;
    $husband = $husband ? $husband->label_name : '(Unknown)';
    $wife    = $wife    ? $wife->label_name    : '(Unknown)';

    $label->appendText(
        join( ' ', 'The Family of', $husband, 'and', $wife ) );
    $group->appendChild( $label );

    my $type = $xml->createElement( 'rdf:type' );
    $type->setAttribute(
        'rdf:resource' => 'http://xmlns.com/wordnet/1.6/Family' );
    $group->appendChild( $type );

    foreach my $event ( $self->marriage ) {
        my $bioevent = $xml->createElement( 'bio:event' );
        my $marriage = $xml->createElement( 'bio:Marriage' );

        if ( my $datevalue = $event->date ) {
            my $date = $xml->createElement( 'bio:date' );
            $date->appendText( $datevalue );
            $marriage->appendChild( $date );
        }

        if ( my $placevalue = $event->place ) {
            my $place = $xml->createElement( 'bio:place' );
            $place->appendText( $placevalue );
            $marriage->appendChild( $place );
        }

        $bioevent->appendChild( $marriage );

        $group->appendChild( $marriage );
    }

    $rdf->appendChild( $group );

    for my $person ( $self->parents, $self->children ) {
        my $xref = $person->xref;
        ( my $href = $opts->{ individual } ) =~ s{\{xref\}}{$xref}g;

        my $member = $xml->createElement( 'foaf:member' );
        $member->setAttribute( 'rdf:resource' => "$href#$xref" );
        $group->appendChild( $member );

        $rdf->appendChild( $person->_foaf_seealso( $opts ) );
    }

    return $xml->toString( 1 );
}

sub _foaf_seealso {
    my $self   = shift;
    my $person = shift;
    my $opts   = shift;

    my $fxref = $self->xref;
    my $pxref = $person->xref;
    ( my $fhref = $opts->{ family } )     =~ s{\{xref\}}{$fxref}ge;
    ( my $phref = $opts->{ individual } ) =~ s{\{xref\}}{$pxref}ge;

    my $group = XML::LibXML::Element->new( 'foaf:Group' );
    $group->setAttribute( 'rdf:about' => "$fhref#$fxref" );

    my $seealso = XML::LibXML::Element->new( 'rdfs:seeAlso' );
    $seealso->setAttribute( 'rdf:resource' => "$fhref#$fxref" );

    my $member = XML::LibXML::Element->new( 'foaf:member' );
    $member->setAttribute( 'rdf:resource' => "$phref#$pxref" );

    $group->appendChild( $seealso );
    $group->appendChild( $member );

    return $group;
}


1;