forked from phillord/kcite
-
Notifications
You must be signed in to change notification settings - Fork 0
/
kcite.php
1377 lines (1065 loc) · 42.8 KB
/
kcite.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/*
Plugin Name: Kcite
Plugin URI: http://knowledgeblog.org/kcite-plugin
Description: Add references and bibliography to blogposts
Version: 1.6.3
Author: Simon Cockell, Phillip Lord
Author URI: http://knowledgeblog.org
Email: knowledgeblog@googlegroups.com
Copyright (c) 2010-13. Simon Cockell (s.j.cockell@newcastle.ac.uk)
Phillip Lord (phillip.lord@newcastle.ac.uk)
Newcastle University.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
require_once( dirname( __FILE__ ) . "/kcite-admin.php");
class KCite{
static $entrez_slug="&email=knowledgeblog%40googlegroups.com&tool=kcite";
static $bibliography;
// store a cached version. In case of a mismatch, we ignore cache.
//(progn (forward-line)(end-of-line)(zap-to-char -1 ?=)(insert "= " (number-to-string (float-time)))(insert ";"))
static $kcite_cache_version = 1348841955.255003;
// have we met any shortcodes, else block
static $add_script = false;
// block javascript and use fallback
static $block_javascript = false;
static $stubs = array
(
"doi" => "http://dx.doi.org/",
"pubmed" => "http://www.ncbi.nlm.nih.gov/pubmed/",
"arxiv" => "http://arxiv.org/abs/",
"url" => "",
);
static $id_matchers = array
(
"doi" => array( "#http://dx\.doi\.org/(\S+)#", "#doi:(\S+)#" ),
"pubmed" => array( "#http://www\.ncbi\.nlm\.nih\.gov/pubmed/(\S+)#", "#pubmed:(\S+)#" ),
"arxiv" => array( "#http://arxiv\.org/abs/(\S+)#", "#arxiv:(\S+)#" ),
"url" => array( "#(http\S+)#" ),
);
/**
* Adds filters and hooks necessary initializiation.
*/
function init(){
//add bibliography to post content
// priority 12 is lower than shortcode (11), so can assure that this runs
// after the shortcode filter does, otherwise, it is all going to work
// very badly.
add_filter('the_content', array(__CLASS__,'bibliography_filter'),12 );
// add a filter to specify the sections
add_filter('the_content',
array(__CLASS__, 'bibliography_section_filter'),14 );
add_shortcode( "cite",
array( __CLASS__, "cite_shortcode" ));
add_shortcode( "fullcite",
array( __CLASS__, "fullcite_shortcode" ));
add_action( 'wp_footer',
array( __CLASS__, 'add_script' ) );
add_option( 'kcite_citation_render_client', true );
add_option( 'kcite_citation_timeout', 60 );
add_option( 'kcite_fallback_identifier', 'doi' );
add_option( 'kcite_greycite_permalink', true );
add_option( 'kcite_greycite_private', false );
add_option( 'kcite_cache_references', true );
add_option( 'kcite_user_cache_version', time() );
add_filter('plugin_action_links', array(__CLASS__, 'refman_settings_link'), 9, 2 );
// json download bib
add_filter( "query_vars",
array( __CLASS__, "kcite_query_vars" ) );
add_action( "template_redirect",
array( __CLASS__, "kcite_template_redirect" ) );
}
function kcite_query_vars( $query_vars ){
$query_vars[] = "kcite-format";
$query_vars[] = "kcite-p";
return $query_vars;
}
function kcite_template_redirect(){
global $wp_query;
if( $wp_query->query_vars["kcite-format"] == "json"
&& $wp_query->query_vars[ "kcite-p" ] > 0
){
$cites_array = self::cites_as_post_metadata
( (int)$wp_query->query_vars[ "kcite-p" ] );
// no references
if( count( $cites_array ) == 0 ){
exit;
}
self::$bibliography = new Bibliography();
self::$bibliography->section = $wp_query->query_vars[ "kcite-p" ];
self::$bibliography->add_cites_array( $cites_array );
$cites = self::resolve_metadata( self::$bibliography->get_cites() );
$cite_json = self::citation_combine_json( $cites );
print( $cite_json );
exit;
}
}
/**
* Section filter -- defines a section header
*/
function bibliography_section_filter($content){
$postid = get_the_ID();
return
"<div class=\"kcite-section\" kcite-section-id=\"$postid\">
$content
</div> <!-- kcite-section $postid -->";
}
function javascript_render_p(){
return get_option( "kcite_citation_render_client" ) && !self::$block_javascript;
}
function get_timeout(){
// if we have blocked javascript, we probably waiting for a human
if( self::$block_javascript ){
return 2;
}
if( is_feed() ){
return 30;
}
return get_option( 'kcite_citation_timeout' );
}
function add_script(){
echo "<!-- Kcite Plugin Installed";
if( !self::$add_script ){
echo ": Disabled as there are no shortcodes-->\n";
return;
}
echo "-->\n";
if( self::javascript_render_p() ){
// load enqueue the scripts
// wp_enqueue_script( "xmle4x", plugins_url( "kcite-citeproc/xmle4x.js", __FILE__ ), false, null, true );
wp_enqueue_script( "xmldom", plugins_url( "kcite-citeproc/xmldom.js",__FILE__ ), false, null, true );
wp_enqueue_script( "citeproc", plugins_url( "kcite-citeproc/citeproc.js",__FILE__ ), false, null, true );
wp_enqueue_script( "jquery" );
wp_enqueue_script( "jquery-ui-core" );
wp_enqueue_script( "jquery-ui-widget" );
wp_enqueue_script( "jquery-ui-button");
//wp_enqueue_script( "jquery.cookie", plugins_url( "kcite-citeproc/jquery.cookie.js",__FILE__ ), false, null, true );
wp_enqueue_script( "kcite_locale_style",
plugins_url( "kcite-citeproc/kcite_locale_style.js", __FILE__ ), false, null, true );
wp_enqueue_script( "kcite", plugins_url( "kcite-citeproc/kcite.js",__FILE__ ), false, null, true );
// and print them or they won't be printed because the footers already done
// not sure that we need this any more
//wp_print_scripts( "xmle4x" );
wp_print_scripts( "xmldom" );
wp_print_scripts( "citeproc" );
wp_print_scripts( "jquery" );
wp_print_scripts( "jquery-ui-core" );
wp_print_scripts( "jquery-ui-widget");
wp_print_scripts( "jquery-ui-button" );
wp_print_scripts( "jquery.cookie" );
wp_print_scripts( "kcite_locale_style" );
wp_print_scripts( "kcite" );
}
}
function instantiate_bibliography(){
// lazy instantiate bib
if( !isset( self::$bibliography ) ){
self::$bibliography = new Bibliography();
self::$bibliography->section = get_the_ID();
}
}
function fullcite_shortcode($atts,$content){
self::$add_script = true;
self::instantiate_bibliography();
// store citation in bibliography. Replace anchor.
$cite = new Citation();
$cite->source="inline";
// need a fake identifier which enables us to test if anything has changed.
$cite->identifier= md5( $atts["author"] . $atts["title"] . $atts["date"] . $atts["location"] );
$cite->resolution_source = $atts;
return self::add_citation_to_bibliography( $cite );
}
/**
* citation short code
*/
function cite_shortcode($atts,$content)
{
// we have a short code, so remember this for later
self::$add_script = true;
// extract attributes as local vars
extract( shortcode_atts
(
array(
"source" => false,
), $atts ) );
self::instantiate_bibliography();
// store citation in bibliography. Replace anchor.
$cite = new Citation();
$cite->identifier=$content;
// TODO -- really need to fix this bit to recognise certain sources,
// in particular all the URL based ones.
if( !$source ){
// let's try guessing
foreach( self::$id_matchers as $id_type => $regexps ){
foreach( $regexps as $regexp ){
$i = preg_match( $regexp, $cite->identifier, $matches );
if( $i > 0 ){
$source = $id_type;
$cite->identifier = $matches[ 1 ];
break 2;
}
}
}
}
// still not set? take default and hope.
if( !$source ){
$source = get_option("kcite_fallback_identifier");
}
$cite->source=$source;
$cite->tagatts=$atts;
return self::add_citation_to_bibliography( $cite );
}
function add_citation_to_bibliography( $cite ){
if( !self::javascript_render_p() || is_feed() ){
$citation = self::$bibliography->add_cite( $cite );
$anchor = $citation->anchor;
$bibindex = $citation->bibindex;
return
"<span id=\"cite_$anchor\" name=\"citation\">" .
"<a href=\"#$anchor\">[$bibindex]</a></span>";
}
else{
$stubs = self::$stubs;
$url = "$stubs[$source]{$cite->identifier}";
$in_text = "<a href=\"$url\">$url</a>";
$anchor = self::$bibliography->add_cite( $cite )->anchor;
return "<span class=\"kcite\" kcite-id=\"$anchor\">($in_text)</span>";
}
}
function bibliography_filter($content) {
$bib_html = self::get_html_bibliography();
// delete the bib -- or it will appear on subsequent posts
self::$bibliography = null;
return $content . $bib_html;
}
function cites_as_post_metadata( $postid, $bibliography=false ){
// last parameter means "single" -- that is get the single value
// that is a serialized array. We have added multiple post-metadata
// elements, but the order isn't consistent in my hands, and that
// is important here.
$metadata_cites = get_post_meta( $postid, "_kcite-cites", true );
// get_post_meta returns an empty string if there is no metadata, which
// will happen if the post has no references. We are expecting an array (wp normally
// deserializes for us), so replace with an array.
if( !is_array( $metadata_cites ) ){
$metadata_cites = array();
}
// there is no bibliography, so we can return what should be an empty array at this point.
if( !$bibliography ){
return $metadata_cites;
}
$cites_changed = false;
// get the real bibliography
$cites_array = $bibliography->get_cites_array();
// if the number of references have changed then so has the bibliography
if( count($cites_array) != $metadata_cites ){
$cites_changed = true;
}
else{
for( $i = 0;$i < count($cites_array);$i++ ){
if( (! array_key_exists( $i, $metadata_cites ) ) ||
$cites_array[ $i ][ 0 ] != $metadata_cites[ $i ][ 0 ] ||
$cites_array[ $i ][ 1 ] != $metadata_cites[ $i ][ 1 ] ){
$cites_changed = true;
break;
}
}
}
if( $cites_changed ){
delete_post_meta( $postid, "_kcite-cites" );
add_post_meta( $postid, "_kcite-cites",
$cites_array );
return get_post_meta( $postid, "_kcite-cites", true );
}
return $metadata_cites;
}
function get_html_bibliography(){
// check the bib has been set, otherwise there have been no cites.
if( !isset( self::$bibliography ) ){
return "<!-- kcite active, but no citations found -->";
}
$cites = self::$bibliography->get_cites();
$postid = get_the_ID();
$temp = self::cites_as_post_metadata( $postid, self::$bibliography );
if( !self::javascript_render_p() || is_feed() ){
// get the metadata which we are going to use for the bibliography.
$cites = self::resolve_metadata($cites);
// it would make more sense to operate this over the citation
// objects rather than the JSON, but this was coded as a quick way
// of rendering after citeproc-js turned out to be a lot of work.
// Now this is meant to be a fall back, and it will need recoding at
// some point, but it's not urgent.
$bibliography =
self::build_bibliography
( self::citation_combine( $cites ) );
return $bibliography;
}
$home_url = home_url();
$script = <<<EOT
<h2>Bibliography</h2>
<div class="kcite-bibliography"></div>
<script type="text/javascript">var citeproc_controls=false;
var blog_home_url="$home_url"
</script>
EOT;
return $script;
}
/**
* Builds the HTML for the bibliography.
*
* Array contains the citation objects as JSON translated into a PhP array.
*
*/
private function build_bibliography($pub_array) {
$i = 1;
$bib_string = "<h2>References</h2>
<ol>
";
$temp = strval( $pub_array );
foreach ($pub_array as $pub) {
$anchor = "<a name='". $pub['id'] . "'></a>";
if( array_key_exists( "timeout", $pub ) ){
if( array_key_exists( "source", $pub ) ){
$source = $pub[ "source" ] . ":";
}
else{
$source = "";
}
$bib_string .=
"<li>$anchor" . $source . $pub["identifier"] .
" <i>(Timed out)</i></li>\n";
$i++;
continue;
}
if (array_key_exists( "error", $pub ) && $pub['error']){
//sufficient missing to assume no publication retrieved...
if (array_key_exists( "DOI", $pub ) && $pub['DOI']) {
$bib_string .= "<li>$anchor<a href='http://dx.doi.org/".
$pub['DOI']."'>DOI:".$pub['DOI'].
"</a> <i>(KCite cannot find metadata for this paper)</i></li>\n";
}
if (array_key_exists( "PMID", $pub ) && $pub['PMID']) {
$bib_string .= "<li>$anchor<a href='http://www.ncbi.nlm.nih.gov/pubmed/"
.$pub['PMID']."'>PMID:".$pub['DOI'].
"</a> <i>(KCite cannot find metadata for this paper)</i></li>\n";
}
}
else {
$bib_string .= "<li>$anchor
";
//
// author
//
if( array_key_exists( "author", $pub ) ){
$author_count = 1;
$author_total = count($pub['author']);
foreach ($pub['author'] as $author) {
$author_string = "";
// this is how citeproc from data cite comes
if( array_key_exists( "literal", $author ) ){
$author_string = $author["literal"] . "., ";
}
else{
//get author initials
$firsts = $author['given'];
$words = explode(' ', $firsts);
$initials = "";
foreach ($words as $word) {
$initials .= strtoupper(substr($word,0,1)).".";
}
$author_string = $initials." ".$author['family'].", ";
}
$bib_string .= $author_string;
if ($author_count == ($author_total - 1)) {
$bib_string .= "and ";
}
$author_count++;
}
}
//
// title
//
if (array_key_exists( "title", $pub) ){
$bib_string .= '"'.$pub['title'].'"';
}
if ($pub['container-title']) {
$bib_string .= ', <i>'.$pub['container-title'].'</i>';
}
if (array_key_exists("volume", $pub)){
$bib_string .= ', vol. '.$pub['volume'];
}
if (array_key_exists("page", $pub) ) {
$bib_string .= ', pp. '.$pub['page'];
}
if (array_key_exists("issued", $pub)){
if(array_key_exists("date-parts", $pub["issued"])){
if(array_key_exists( 0, $pub["issued"]["date-parts"])){
if(array_key_exists( 0, $pub["issued"]["date-parts"][0])){
$bib_string .= ', '.$pub['issued']['date-parts'][0][0] . ". ";
}
}
}
if(array_key_exists("raw", $pub["issued"] ) ){
$bib_string .= ", " . $pub["issued"]["raw"] . ". ";
}
}
$bib_string .= '<a href="' . $pub["URL"] . '">' . $pub["URL"] . '</a>';
$bib_string .= "
</li>
";
}
$i++;
}
$bib_string .= "</ol>
";
if( self::$bibliography->contains_timeout ){
$bib_string .= <<<EOT
<p><a href="http://knowledgeblog.org/kcite-plugin/">Kcite</a> was unable to
retrieve citation information for all the references, due to a timeout. This
is done to prevent an excessive number of requests to the services providing
this information. More references should appear on subsequent page views</p>
EOT;
}
return $bib_string;
}
/**
* Expands citation objects to include full details.
* This can be used to build the JSON.
*/
private function resolve_metadata($cites) {
$start_time = time();
// short timeout for feed, option for page
$timeout = self::get_timeout();
foreach ($cites as $cite) {
//print( "resolve metadata {$cite->source}:{$cite->identifier}\n" );
// check whether this is all taking too long
if( time() - $start_time > $timeout ){
$cite->error = true;
$cite->timeout = true;
self::$bibliography->contains_timeout = true;
//print( "resolve timeout {$cite->source}:{$cite->identifier}\n" );
continue;
}
// check whether we have a cached version
// if so we are sorted
$slug = self::transient_slug( $cite );
$cache = get_option( $slug );
if( get_option( "kcite_cache_references" ) && $cache ){
if( array_key_exists( "kcite_cache_version", $cache ) &&
$cache[ "kcite_cache_version" ] == self::$kcite_cache_version &&
array_key_exists( "kcite_cache_user_version", $cache ) &&
$cache[ "kcite_cache_user_version" ] ==
get_option( "kcite_user_cache_version" )
){
//print( "Accepted cache\n" );
$cite->json = $cache;
}
}
// take the internal cached version from the json which might be nil
$cache = $cite->json;
// the cache exists and has not expired
if( $cache &&
array_key_exists( "kcite_cache_expiretime", $cache ) &&
(intval( $cache[ "kcite_cache_expiretime" ] ) > time()) ){
$cite->resolved = true;
$time = time();
continue;
}
if($cite->source=="inline"){
// all of this is fake and needs to parse the vars above.
// $cite->resolution_source data
$atts=$cite->resolution_source;
$authors_explode = explode( ";", $atts["author"] );
foreach( $authors_explode as $auth ){
$author_comps = explode( ".", $auth );
$author_array = array();
$author_array['surname'] = $author_comps[ 0 ];
$author_array['given_name'] = $author_comps[ 1 ];
$cite->authors[] = $author_array;
}
$cite->journal_title = $atts["location"];
$cite->title = $atts["title"];
$date_array = array();
$cite->pub_date['year'] = $atts["date"];
$cite = self::citation_generate_json( $cite );
$cite->resolved = true;
}
if ($cite->source == 'doi') {
// should work on datacite or crossref lookup
$cite = self::dx_doi_lookup($cite);
if($cite->resolved && $cite->resolved_from=="dx-doi" ){
$cite = self::get_crossref_metadata($cite);
}
}
if ($cite->source == 'pubmed') {
$cite = self::pubmed_id_lookup($cite);
if ($cite->resolved) {
$cite = self::get_pubmed_metadata($cite);
}
}
if( $cite->source == "arxiv"){
$cite = self::arxiv_id_lookup($cite);
if($cite->resolved){
$cite = self::get_arxiv_metadata($cite);
}
}
// resolve these from metadata given in cite tag
if( $cite->source == "url" ){
$cite = self::greycite_uri_lookup($cite);
if($cite->resolved){
$cite = self::get_greycite_metadata($cite, $fh);
}
}
if( !$cite->resolved ){
if ( $cite->json ){
// we have not managed to resolve from the sources
// but we do have a cache, albeit one that is old
// so use this, but the metadata as stale
$cite->resolved = true;
$cite->stable = true;
continue;
}
// if we don't recognise the type then we have an error
$cite->error = true;
}
}
return $cites;
}
private function transient_slug($cite)
{
// slug has to be 45 chars or less
return "kcite" . crc32( $cite->source . $cite->identifier );
}
/**
* Attempt to resolve metadata for a citation object
* @param string $pub_doi A doi representing a reference
* @return
*/
private function dx_doi_lookup($cite) {
$url = "http://dx.doi.org/{$cite->identifier}";
$params = array(
// the order here is important, as both datacite and crossrefs content negotiation is broken.
// crossref only return the highest match, but do check other content
// types. So, should return json. Datacite is broken, so only return the first
// content type, which should be XML.
// datacite now returns JSON, so this should be much simpler
'headers' =>
array( 'Accept' =>
"application/citeproc+json"),
);
$wpresponse = wp_remote_get( $url, $params );
//print( $url );
//print( "wp response" );
//print_r( $wpresponse );
if( is_wp_error( $wpresponse ) ){
return $cite;
}
$response = wp_remote_retrieve_body( $wpresponse );
$status = wp_remote_retrieve_response_code( $wpresponse );
$headers = wp_remote_retrieve_headers( $wpresponse );
$contenttype = $headers["content-type"];
$cite->response_code = $status;
// it's probably not a DOI at all. Need to check some more here.
if( $status == 404 ){
return $cite;
}
if( $contenttype == "application/citeproc+json" ){
// crossref DOI
$cite->resolved = true;
$cite->resolution_source=$response;
$cite->resolved_from="dx-doi";
return $cite;
}
// if( $contenttype == "application/x-datacite+xml" ){
// //datacite DOI
// $cite->resolved = true;
// $cite->resolution_source=$response;
// $cite->resolved_from="datacite";
//
// return $cite;
// }
// so it's a DOI which is neither datacite nor crossref -- we should turn this into a URL, therefore.
return $cite;
}
/**
* Look up pubmed ID on pubmed
* @param Citation the citation to resolve
* @return null if DOI does not resolve, or raw pubmed XML
*/
private function pubmed_id_lookup($cite) {
$url = "http://eutils.ncbi.nlm.nih.gov/entrez/eutils/efetch.fcgi?"
. self::$entrez_slug . "&db=pubmed&retmode=xml&id="
.$cite->identifier;
$wpresponse = wp_remote_get( $url );
if( is_wp_error( $wpresponse ) ){
return $cite;
}
$status = wp_remote_retrieve_response_code( $wpresponse );
$cite->response_code = $status;
if( $status != 200 ){
return $cite;
}
$xml = wp_remote_retrieve_body( $wpresponse );
if (preg_match('/(Error|ERROR)>/', $xml)) {
//handles fetch failure
return $cite;
}
$cite->resolved = true;
$cite->resolution_source = $xml;
$cite->resolved_from = "pubmed";
return $cite;
}
private function arxiv_id_lookup($cite){
//print( "fetching arxiv" );
$url = "http://export.arxiv.org/oai2?verb=GetRecord&identifier=oai:arXiv.org:"
. $cite->identifier . "&metadataPrefix=arXiv";
$wpresponse = wp_remote_get( $url, $params );
//print( $url . "\n" );
//print_r( $wpresponse );
if( is_wp_error( $wpresponse ) ){
return $cite;
}
$status = wp_remote_retrieve_response_code( $wpresponse );
$cite->response_code = $status;
if( $status != 200 ){
return $cite;
}
$xml = wp_remote_retrieve_body( $wpresponse );
$cite->resolved = true;
$cite->resolution_source = $xml;
$cite->resolved_from = "arxiv";
return $cite;
}
private function greycite_uri_lookup($cite){
$url = "http://greycite.knowledgeblog.org/json?uri=" . $cite->identifier;
if( get_option( "kcite_greycite_private" ) ){
$params = array
(
'headers' =>
array( 'X-greycite-no-store' => 'true' )
);
}
else{
if( get_option( "kcite_greycite_permalink" ) ){
$params = array
(
'headers' =>
array( 'X-greycite-permalink' => get_permalink( $cite->bibliography->section ) )
);
}
}
$wpresponse = wp_remote_get( $url, $params );
if( is_wp_error( $wpresponse ) ){
return $cite;
}
$status = wp_remote_retrieve_response_code( $wpresponse );
$cite->response_code = $status;
if( $status != 200 ){
return $cite;
}
$response = wp_remote_retrieve_body( $wpresponse );
// greycite worked
$cite->resolved = true;
$cite->resolution_source=$response;
$cite->resolved_from="greycite";
return $cite;
}
/**
* Parses XML in a citation object into a PhP array
* @param Citation object
* @return Citation with parsedXML now containing SimpleXMLElement object
*/
private function parse_xml($cite) {
$cite->parsedXML = new SimpleXMLElement( $cite->resolution_source );
return $cite;
}
/**
* @param array of Citation objects
* @return php array ready for JSON encoding
*/
private function citation_combine($cites){
$citep = array();
$item_number = 1;
$cite_length = count($cites);
foreach ($cites as $cite) {
$item_string = $cite->anchor;
// take the json and combine it
if( $cite->json ){
$item = $cite->json;
// add in the ID string
$item["id"] = "$item_string";
$item["resolved"] = true;
// we finished!
$citep[ $item_string ] = $item;
continue;
}
// we should now be in an error condition, so generate some temporary JSON with no metadata.
$item = array();
$item["source"] = $cite->source;
$item["identifier"] = $cite->identifier;
$item["resolved"] = $cite->resolved;
$item["id" ] = "$item_string";
$item["URL"] = self::$stubs[$cite->source] . $cite->identifier;
// timed out overall, so don't have the metadata
if( $cite->timeout ){
$item["timeout"] = true;
}
// there was an error of some sort (normally no metadata)
if( $cite->error ){
$item["error"] = true;
$item["response-code"] = $cite->response_code;
}
// just didn't resolve
$citep[ $item_string ] = $item;
}
return $citep;
}
private function citation_generate_json( $cite )
{
$item = array();
$item[ "title" ] = $cite->title;
$authors = array();
foreach ($cite->authors as $author) {
$auth = array();
$auth["family"] = $author[ "surname" ];
$auth["given"] = $author[ "given_name" ];
$authors[] = $auth;
}
$item[ "author" ] = $authors;
$item[ "container-title" ] = $cite->journal_title;
// dates -- only if we have year
if( $cite->pub_date[ 'year' ] ){
$issued = array();
$date_parts = array();
$date_parts[] = (int)$cite->pub_date[ 'year' ];
// month and day if existing or nothing
if(array_key_exists( "month", $cite->pub_date)){
$date_parts[] = (int)$cite->pub_date[ 'month' ];
}
if(array_key_exists( "day", $cite->pub_date)){
$date_parts[] = (int)$cite->pub_date[ 'day' ];
}
$issued[ "date-parts" ] = array( $date_parts );
$item[ "issued" ] = $issued;
}
if($cite->first_page){
$item[ "page" ] =
$cite->first_page . "-" . $cite->last_page;
}
if( $cite->volume ){
$item[ "volume" ] = $cite->volume;
}
if( $cite->issue ){
$item[ "issue" ] = $cite->issue;
}
if( $cite->reported_doi ){
$item[ "DOI" ] = $cite->reported_doi;
}
$item[ "type" ] = "article-journal";
if( $cite->url ){
$item["URL"] = $cite->url;
}
$cite->json = $item;
// now that we have made this JSON, we should cache it.
self::cache_json( $cite );
return $cite;
}