.svn/pristine/a4/a47a0b4624b67e44bc4036a82c57230aa306d670.svn-base

   1 # This module is part of Refence, and is released under the terms of
   2 # the GPL version 2, or any later version. See the file README and
   3 # COPYING for more information.
   4 # Copyright 2003 by Don Armstrong <don@donarmstrong.com>.
   5 # $Id$
   6
   7 package Reference::Retrieve::PubMed;
   8
   9 =head1 NAME
  10
  11 Reference::Retrieve::PubMed -- Reference Retrieval from PubMed
  12
  13 =head1 SYNOPSIS
  14
  15      my $reference = Reference::Retrieve::PubMed::get_reference(-pmid=>123456);
  16      my @references = Reference::Retrieve::PubMed::get_reference(-query=>'John Smith[AUTHOR] AND 230[Pages]',limit=>50);
  17
  18
  19 =head1 DESCRIPTION
  20
  21 Uh. Retreives references from pubmed. Yeah.
  22
  23 =head1 BUGS
  24
  25 None known.
  26
  27 =cut
  28
  29
  30 use strict;
  31 use vars qw($REVISION $DEBUG);
  32 use Carp;
  33
  34 use LWP::UserAgent;
  35 use XML::Simple qw(:strict);
  36 use Reference;
  37
  38 use HTML::Entities;
  39
  40 use Params::Validate qw(:types validate_with);
  41
  42 BEGIN{
  43      ($REVISION) = q$LastChangedRevision$ =~ /\$LastChangedRevision:\s+([^\s+])/;
  44      $DEBUG = 0 unless defined $DEBUG;
  45 }
  46
  47
  48 =head2 get_reference
  49
  50 =head3 Usage
  51
  52      my $reference = Reference::Retrieve::PubMed::get_reference(-pmid=>123456);
  53      my @references = Reference::Retrieve::PubMed::get_reference(-query=>'John Smith[AUTHOR] AND 230[Pages]',-limit=>50);
  54      my @references = Reference::Retrieve::PubMed::get_reference(-query=>{author=>'John Smith', pages=>'230'},-limit=>50)
  55
  56 =head3 Function
  57
  58 Retrives a reference from pubmed
  59
  60 =head3 Returns
  61
  62 In scalar context, effectively assumes -limit=>1 and returns the
  63 highest listed reference according to the order, etc. [Probably only
  64 usefull with -pmid.] In list context, returns all results (or until it
  65 hits the -limit.)
  66
  67 =head3 Args
  68
  69 list of arguments to select a reference or collection of references from.
  70
  71
  72 =cut
  73
  74 sub get_reference{
  75      my %options = validate_with(params => @_,
  76                                  spec   => {pubmed_site  => {default => 'http://www.ncbi.nlm.nih.gov'},
  77                                             pmid_query   => {default => '/entrez/query.fcgi?cmd=Text&db=PubMed&dopt=XML&uid='},
  78                                             search_query => {default => '/htbin-post/Entrez/query?db=m&form=4&dispmax=100&html=no&dopt=u&term='},
  79                                             ua_agent     => {default => "DA Reference::Retreive::PubMed/$REVISION"},
  80                                             email        => {default => "don+referenceretrieve$REVISION\@donarmstrong.com"},
  81                                            },
  82                                  allow_extra => 1,
  83                                 );
  84      my $ua = new LWP::UserAgent(agent => $options{ua_agent});
  85 }
  86
  87 sub get_reference_by_pmid($;@){
  88      my %options = validate_with(params => \@_,
  89                                  spec   => {pmid => {type => SCALAR|ARRAYREF,
  90                                                      #regex => qr/^\d+$/,
  91                                                     },
  92                                             pubmed_site  => {default => 'http://www.ncbi.nlm.nih.gov'},
  93                                             pmid_query   => {default => '/entrez/eutils/efetch.fcgi?db=pubmed&retmode=xml&rettype=full&id='},
  94                                             search_query => {default => '/htbin-post/Entrez/query?db=m&form=4&dispmax=100&html=no&dopt=u&term='},
  95                                             ua_agent     => {default => "DA Reference::Retreive::PubMed/$REVISION"},
  96                                             email        => {default => "don+referenceretrieve$REVISION\@donarmstrong.com"},
  97                                             useragent    => {optional => 1},
  98                                            },
  99                                  allow_extra => 1,
 100                                 );
 101      my $pmid = $options{pmid};
 102
 103      my $ua;
 104      if ($options{useragent}) {
 105           $ua = $options{useragent};
 106      }
 107      else {
 108           $ua = new LWP::UserAgent(agent=>$options{ua_agent});
 109      }
 110      my $url = "$options{pubmed_site}$options{pmid_query}" . (ref($pmid) ? (join('&id=',@{$pmid})) : $pmid);
 111      print STDERR "url: $url" if $DEBUG;
 112      my $request = HTTP::Request->new('GET', $url);
 113      my $response = $ua->request($request);
 114      $response = $response->content;
 115      print STDERR "response: $response" if $DEBUG;
 116
 117      # For some dumb reason, they send us xml with html
 118      # entities. Ditch them.
 119      #$response = decode_entities($response);
 120      # It's even more freaking broken; they don't double encode them.
 121      #$response =~ s/\&gt;(\s|$)/>$1/gso;
 122      #$response =~ s/(?:(\s)\&lt;|&lt;(\/))/$1<$2/gso;
 123      $response =~ s/&quot;/"/gso;
 124
 125      # Ditch any doctype
 126      $response =~ s/^\s*<\?xml[^>]+>\s*//gso;
 127      $response =~ s/^\s*<\!DOCTYPE[^>]+>\s*//gso;
 128      # There is also a Pubmedarticleset
 129      $response =~ s/^\s*<PubmedArticleSet>\s*//gso;
 130      $response =~ s#</PubmedArticleSet>\s*$##gso;
 131
 132      # Add the opt so we get an array of PubMedArticle
 133      $response = "<opt>$response</opt>";
 134
 135      print STDERR $response if $DEBUG;
 136
 137      # Figure out if there was an error in the search.
 138
 139      # Response should be in XML. Parse it.
 140      my $xa = new XML::Simple;
 141
 142      my $ref_struct = $xa->XMLin($response, ForceArray => [ 'PubmedArticle' ],KeyAttr=>[]);
 143
 144      use Data::Dumper;
 145      print STDERR Dumper($ref_struct) if $DEBUG;
 146      # Handle the XML structure
 147      my @references;
 148      foreach my $ref (@{$ref_struct->{PubmedArticle}}) {
 149           my $reference =  _create_reference_from_xml($ref,$ua);
 150           if (not defined $reference) {
 151                warn "Unable to create reference for $ref->{MedlineCitation}->{PMID}\n";
 152           }
 153           push @references, $reference;
 154      }
 155      if (wantarray) {
 156           return @references;
 157      }
 158      return $references[0];
 159 }
 160
 161 sub _create_reference_from_xml($$){
 162      my ($ref,$ua) = @_;
 163
 164      # Figure out what type of reference this is. We only support
 165      # Journal Articles right now.
 166      my $types = {'journal article'=>'article',
 167                   'letter'         =>'article',
 168                  };
 169      my $ref_type = undef;
 170      my $reference = undef;
 171      foreach my $type (keys %{$types}) {
 172           if (ref($ref->{MedlineCitation}->{Article}->{PublicationTypeList}->{PublicationType}) eq 'ARRAY'){
 173                my $pubtypes;
 174                @{$pubtypes}{map {lc} @{$ref->{MedlineCitation}->{Article}->{PublicationTypeList}->{PublicationType}}} =
 175                     (1) x @{$ref->{MedlineCitation}->{Article}->{PublicationTypeList}->{PublicationType}};
 176                if ($pubtypes->{$type}) {
 177                     $ref_type = $types->{$type};
 178                     last;
 179                }
 180                else {
 181                     next;
 182                }
 183           }
 184           elsif (lc($ref->{MedlineCitation}->{Article}->{PublicationTypeList}->{PublicationType}) eq lc($type)) {
 185                $ref_type = $types->{$type};
 186                last;
 187           }
 188      }
 189      if (not defined $ref_type) {
 190           warn "Unsupported PublicationType: ".(ref($ref->{MedlineCitation}->{Article}->{PublicationTypeList}->{PublicationType})?
 191                                                 join(',',@{$ref->{MedlineCitation}->{Article}->{PublicationTypeList}->{PublicationType}}):
 192                                                 $ref->{MedlineCitation}->{Article}->{PublicationTypeList}->{PublicationType});
 193           print STDERR Dumper($ref);
 194           $ref_type = 'article';
 195      }
 196      local $_ = $ref_type;
 197      if (/article/) {
 198           use Reference::Type::Article;
 199           $reference = new Reference::Type::Article;
 200           my $xml_mapping = {author     => [ _fix_medline_authors($ref->{MedlineCitation}->{Article}->{AuthorList}) ],
 201                              title      => [_fix_medline_title($ref->{MedlineCitation}->{Article}->{ArticleTitle})],
 202                              abstract   => $ref->{MedlineCitation}->{Article}->{Abstract}->{AbstractText},
 203                              journal    => [_fix_medline_journal($ref->{MedlineCitation}->{Article}->{Journal},
 204                                                                  $ref->{MedlineCitation}->{Article}->{MedlineJournalInfo},
 205                                                                  $ua,
 206                                                                  #@_, # configuration
 207                                                                 )],
 208                              _fix_ids($ref),
 209                              # pmid       => $ref->{MedlineCitation}->{PMID},
 210                              # medline_id => $ref->{MedlineCitation}->{MedlineID},
 211                              volume     => [_fix_medline_ditch_empty($ref->{MedlineCitation}->{Article}->{Journal}->{JournalIssue}->{Volume})],
 212                              date       => [_fix_medline_pubdate($ref->{MedlineCitation}->{Article}->{Journal}->{JournalIssue}->{PubDate})],
 213                              number     => [_fix_medline_ditch_empty($ref->{MedlineCitation}->{Article}->{Journal}->{JournalIssue}->{Issue})],
 214                              pages      => [_fix_medline_pages($ref->{MedlineCitation}->{Article}->{Pagination}->{MedlinePgn})],
 215 #                            keywords   => [_fix_medline_keywords($ref->{MedlineCitation}->{MeshHeadingList},
 216 #                                                                 $ref->{MedlineCitation}->{ChemicalList},
 217 #                                                                )],
 218 #                            &_find_pubmed_links($ref->{MedlineCitation}->{PMID},$ua),
 219                             };
 220           # Deal with author
 221
 222           foreach my $reference_key (keys %{$xml_mapping}) {
 223                my $method = $reference->can($reference_key);
 224                die "Reference::Type::Article was unable to handle $reference_key" if not $method;
 225                if (defined $xml_mapping->{$reference_key} and $method) {
 226                     if (ref($xml_mapping->{$reference_key})) {
 227                          &{$method}($reference,@{$xml_mapping->{$reference_key}});
 228                     }
 229                     else {
 230                          &{$method}($reference,$xml_mapping->{$reference_key});
 231                     }
 232                }
 233                else {
 234                     warn "Reference_key $reference_key was not defined or unable to handle type of key."
 235                          if not defined $xml_mapping->{$reference_key} and $DEBUG;
 236                }
 237           }
 238           return $reference;
 239      }
 240 }
 241
 242 sub _fix_medline_title($){
 243      my $title = shift;
 244
 245      $title =~ s/\.$//;
 246      return $title;
 247 }
 248
 249
 250 sub _fix_medline_authors($){
 251      my $author_list = shift;
 252      $author_list = $author_list->{Author};
 253      my @authors;
 254      $author_list = [$author_list] if ref($author_list) ne 'ARRAY';
 255      foreach my $author (@{$author_list}) {
 256           my %au;
 257           $au{first} = $author->{ForeName} if exists $author->{ForeName};
 258           $au{last}  = $author->{LastName} if exists $author->{LastName};
 259           $au{initials} = $author->{Initials} if exists $author->{Initials};
 260           $au{full};
 261           push @authors,\%au;
 262      }
 263      return (author=>\@authors);
 264 }
 265
 266 =head2 _fix_medline_journal
 267
 268 =head3 Usage
 269
 270      $reference->journal(_fix_medline_journal($ref->{MedlineCitation}->{Article}->{Journal},
 271                                               $ref->{MedlineCitation}->{Article}->{MedlineJournalInfo},
 272                                               $ua,));
 273
 274 =head3 Function
 275
 276 From the medline citation informatino returns a properly formatted
 277 list of information for the journal reference listing.
 278
 279 =head3 Args
 280
 281 Journal information hashref
 282
 283 medline journal information hashref
 284
 285 user agent
 286
 287 =cut
 288
 289 sub _fix_medline_journal($$$;){
 290      my ($journal,$medline_journal,$ua) = @_;
 291      # journal takes fullname, issn, medlineabbr, pmid, and nlmuid
 292      # Try to supply as much as possible.
 293      # Use esearch to get pmjournalid
 294      # http://eutils.ncbi.nlm.nih.gov/entrez/eutils/esearch.fcgi?db=journals&term=0021-9258
 295      # use esummary to retreive the journalid
 296      # <?xml version="1.0"?>
 297      # <!DOCTYPE eSearchResult PUBLIC "-//NLM//DTD eSearchResult, 11 May 2002//EN" "http://www.ncbi.nlm.nih.gov/entrez/query/DTD/eSearch_020511.dtd">
 298      # <eSearchResult>
 299      #  <Count>1</Count>
 300      #  <RetMax>1</RetMax>
 301      #  <RetStart>0</RetStart>
 302      #  <IdList>
 303      #          <Id>4559</Id>
 304      #
 305      #  </IdList>
 306      #  <TranslationSet>
 307      #  </TranslationSet>
 308      #  <TranslationStack>
 309      #          <TermSet>
 310      #                  <Term>0021-9258[All Fields]</Term>
 311      #                  <Field>All Fields</Field>
 312      #                  <Count>1</Count>
 313      #
 314      #                  <Explode>Y</Explode>
 315      #          </TermSet>
 316      #  </TranslationStack>
 317      # </eSearchResult>
 318
 319      my $ISSN = $journal->{ISSN};
 320      if (ref $ISSN) {
 321           $ISSN = $ISSN->{content};
 322      }
 323      my $url = qq(http://eutils.ncbi.nlm.nih.gov/entrez/eutils/esearch.fcgi?db=journals&term=$ISSN);
 324      print STDERR "url: $url" if $DEBUG;
 325      my $request = HTTP::Request->new('GET', $url);
 326      my $response = $ua->request($request);
 327      $response = $response->content;
 328      print STDERR "response: $response" if $DEBUG;
 329
 330      my ($journal_id) = $response =~ m#<Id>\s*(\d+)\s*</Id>#i;
 331
 332      # http://eutils.ncbi.nlm.nih.gov/entrez/eutils/efetch.fcgi?db=journals&id=4559
 333      #      <?xml version="1.0"?>
 334      # <!DOCTYPE eSummaryResult PUBLIC "-//NLM//DTD eSummaryResult, 11 May 2002//EN" "http://www.ncbi.nlm.nih.gov/entrez/query/DTD/eSummary_020511.dtd">
 335      # <eSummaryResult>
 336      # <DocSum>
 337      #  <Id>4559</Id>
 338      #  <Item Name="Title" Type="String">The Journal of biological chemistry.</Item>
 339      #  <Item Name="MedAbbr" Type="String">J Biol Chem</Item>
 340      #  <Item Name="IsoAbbr" Type="String">J. Biol. Chem.</Item>
 341      #  <Item Name="NlmId" Type="String">2985121R</Item>
 342      #
 343      #  <Item Name="pISSN" Type="String">0021-9258</Item>
 344      #  <Item Name="eISSN" Type="String">1083-351X</Item>
 345      #  <Item Name="PublicationStartYear" Type="String">1905</Item>
 346      #  <Item Name="PublicationEndYear" Type="String"></Item>
 347      #  <Item Name="Publisher" Type="String">American Society for Biochemistry and Molecular Biology</Item>
 348      #  <Item Name="Language" Type="String">eng</Item>
 349      #
 350      #  <Item Name="Country" Type="String">United States</Item>
 351      # </DocSum>
 352      #
 353      # </eSummaryResult>
 354      $url = qq(http://eutils.ncbi.nlm.nih.gov/entrez/eutils/esummary.fcgi?db=journals&id=$journal_id);
 355      print STDERR "url: $url" if $DEBUG;
 356      $request = HTTP::Request->new('GET', $url);
 357      $response = $ua->request($request);
 358      $response = $response->content;
 359      print STDERR "response: $response" if $DEBUG;
 360
 361      my %journal;
 362      while ($response =~ m{^\s*(?:(?:<id>\s*(\d+)</id>)| # Match ids
 363                            (?:<item\s+name=\"([^\"]+)\"\s+Type=\"String\">\s*([^<]+?)\.?</item>))\s* # Match item Name clauses
 364                            $}ixmg) {
 365           if (not defined $2) {
 366                $journal{id} = $1;
 367           }
 368           else {
 369                $journal{lc($2)} = $3;
 370           }
 371      }
 372      my %journal_mapping = (title       => q(title),
 373                             medlineabbr => q(medabbr),
 374                             isoabbr     => q(isoabbr),
 375                             nlmid       => q(nlmid),
 376                             issn        => q(pissn),
 377                             eissn       => q(eissn),
 378                             publisher   => q(publisher),
 379                             pmid    => q(id)
 380                            );
 381      my @journal_entry;
 382      foreach my $key (keys %journal_mapping) {
 383           push @journal_entry,($key=>$journal{$journal_mapping{$key}});
 384      }
 385      return @journal_entry;
 386 }
 387
 388 =head2
 389
 390 =head3 Usage
 391
 392      $reference->date(_fix_medline_pubdate($ref->{MedlineCitation}->{Article}->{Journal}->{JournalIssue}->{PubDate}));
 393
 394 =head3 Function
 395
 396 =head3 Returns
 397
 398 =head3 Args
 399
 400 =cut
 401
 402 sub _fix_medline_pubdate($){
 403      my ($date) = shift;
 404      return (year=>$date->{Year},month=>$date->{Month},day=>$date->{Day}) if exists $date->{Year};
 405      # Ok... punt.
 406      if (exists $date->{MedlineDate}) {
 407           my ($year,$month,$day) = split /\s+/,$date->{MedlineDate};
 408           return (year=>$year,month=>$month,day=>$day)
 409      }
 410 }
 411
 412 =head2 _fix_medline_pages
 413
 414 =head3 Usage
 415
 416      pages      => [_fix_medline_pages($ref->{MedlineCitation}->{Article}->{Pagination}->{MedlinePgn})],
 417
 418 =head3 Function
 419
 420 Returns output with a list of pages appropriate for an Article type of
 421 reference.
 422
 423 =cut
 424
 425 sub _fix_medline_pages($){
 426      my ($pagination) = @_;
 427      my ($start,$stop) = $pagination =~ /(\d*)\s*\-\s*(\d*)/;
 428      my @return;
 429      push @return, (start=>$start) if defined $start and $start ne '';
 430      push @return, (stop=>$stop) if defined $stop and $stop ne '';
 431      return @return;
 432 }
 433
 434 sub _find_pubmed_links($$){
 435      my ($pmid,$ua) = @_;
 436      return ();
 437      #http://eutils.ncbi.nlm.nih.gov/entrez/query/static/elink_help.html
 438      my $url = "http://eutils.ncbi.nlm.nih.gov/entrez/eutils/elink.fcgi?dbfrom=pubmed&cmd=llinks&id=" . (ref($pmid) ? (join('&id=',@{$pmid})) : $pmid);
 439      print STDERR "url: $url" if $DEBUG;
 440      my $request = HTTP::Request->new('GET', $url);
 441      my $response = $ua->request($request);
 442      $response = $response->content;
 443      print STDERR "response: $response" if $DEBUG;
 444
 445      # Response should be in XML. Parse it.
 446      my $xa = new XML::Simple;
 447
 448      my $ref_struct = $xa->XMLin($response, ForceArray => ['IdUrlSet'], KeyAttr=>[]);
 449
 450      use Data::Dumper;
 451      print STDERR Dumper($ref_struct);# if $DEBUG;
 452      # Rearange data around Id.
 453      my $links = {};
 454      map {$links->{$_->{Id}}=$_->{ObjUrl}} @{$ref_struct->{LinkSet}->{IdUrlList}->{IdUrlSet}};
 455      foreach my $obj_url (@{$links->{$pmid}->{ObjUrl}}) {
 456           next unless $obj_url->{SubjectType} = 'publishers/providers';
 457           #@links = _find_links_from_url($obj_url->{Url},$ua);
 458      }
 459      # Find publisher link
 460      # If no publisher link, use the first aggregator link.
 461 }
 462
 463 =head2 _fix_ids
 464
 465      _fix_ids
 466
 467
 468
 469 =cut
 470
 471 sub _fix_ids {
 472      my ($ref) = @_;
 473
 474      my %ids_known = (medline => 'medline_id',
 475                       pubmed  => 'pmid',
 476                       doi     => 'doi',
 477                      );
 478      my %ids;
 479      if (exists $ref->{PubmedData}{ArticleIdList}{ArticleId}) {
 480           for my $art_id (ref($ref->{PubmedData}{ArticleIdList}{ArticleId}) eq 'ARRAY' ?
 481                @{$ref->{PubmedData}{ArticleIdList}{ArticleId}}:
 482                     ($ref->{PubmedData}{ArticleIdList}{ArticleId})) {
 483                if (exists $ids_known{$art_id->{IdType}}) {
 484                     $ids{$ids_known{$art_id->{IdType}}} = $art_id->{content};
 485                }
 486           }
 487      }
 488      if (not exists $ids{pmid}) {
 489           $ids{pmid} = $ref->{MedlineCitation}->{PMID} if defined $ref->{MedlineCitation}->{PMID};
 490      }
 491      if (not exists $ids{medline_id}) {
 492           $ids{medline_id} = $ref->{MedlineCitation}->{MedlineID} if defined $ref->{MedlineCitation}->{MedlineID};
 493      }
 494      return %ids;
 495 }
 496
 497
 498 =head2 _find_links_from_url
 499
 500 =head3 Usage
 501
 502 =head3 Function
 503
 504 =head3 Returns
 505
 506 =head3 Args
 507
 508 =cut
 509
 510 sub _find_links_from_url($$){
 511      my ($link,$ua) = @_;
 512
 513
 514
 515 }
 516
 517 sub _fix_medline_ditch_empty($){
 518      my ($value) = @_;
 519
 520      if (ref($value)) {
 521           if (ref($value) eq 'HASH') {
 522                if (scalar keys %{$value} > 0) {
 523                     return $value;
 524                }
 525                else {
 526                     return '';
 527                }
 528           }
 529           elsif (ref($value) eq 'ARRAY') {
 530                if (scalar @{$value} > 0) {
 531                     return $value;
 532                }
 533                else {
 534                     return '';
 535                }
 536           }
 537           else {
 538                return '';
 539           }
 540      }
 541      else {
 542           return $value if defined $value;
 543           return '';
 544      }
 545 }
 546
 547
 548 1;
 549
 550
 551 __END__
 552
 553
 554
 555
 556
 557