2 # bibtex_to_paper opens the paper corresponding to a bibtex key
3 # and is released under the terms of the GNU GPL version 3, or any
4 # later version, at your option. See the file README and COPYING for
6 # Copyright 2014 by Don Armstrong <don@donarmstrong.com>.
16 use File::Basename qw(basename);
17 use File::Spec qw(rel2abs);
27 bibtex_to_paper - opens the paper corresponding to a bibtex key
31 bibtex_to_paper [options] bibtexkey
34 --bibtex, -b bibtex file to look up key in
35 --bibtex-cache, -c bibtex cache file
36 --build-cache, -B build cache using bibtex files
37 --search-by-pmid Search term is a pmid instead of a bibtex key
38 --pdf-dir pdf directory
39 --pdfviewer, -p pdf viewer to use
40 --only-print Only print PDF file name
41 --debug, -d debugging level (Default 0)
42 --help, -h display this help
43 --man, -m display manual
51 Bibtex file to look key up in
53 =item B<--bibtex-cache, -c>
55 Bibtex cache file; rebuilt if bibtex file changes
57 =item B<--pdfviewer, -p>
59 PDF viewer to use; defaults to evince unless a .xoj exists, in which
64 Only print the PDF file name, don't open it.
68 Debug verbosity. (Default 0)
72 Display brief usage information.
89 my %options = (debug => 0,
94 'bibtex_cache' => File::Spec->catfile(User->Home,'.bibtex_to_paper_cache'),
98 'build_cache|build-cache!',
100 'bibtex_cache|bibtex-cache|c=s',
102 'only_print|only-print!',
103 'search_by_pmid|search-by-pmid!',
104 'clear_cache|clear-cache!',
105 'papers_directory|papers-directory=s@',
106 'debug|d+','help|h|?','man|m');
108 pod2usage() if $options{help};
109 pod2usage({verbose=>2}) if $options{man};
111 $DEBUG = $options{debug};
114 if (not exists $options{bibtex} and
115 not exists $options{bibtex_cache}) {
117 "You must give at least one of --bibtex".
121 pod2usage(join("\n",@USAGE_ERRORS)) if @USAGE_ERRORS;
129 if (exists $options{bibtex_cache}) {
131 if (-e $options{bibtex_cache}) {
132 ($dbh,$sth) = open_cache($options{bibtex_cache});
134 ($dbh,$sth) = initialize_database($options{bibtex_cache});
138 if (exists $options{clear_cache}) {
139 clear_cache($dbh,$sth);
142 if (exists $options{build_cache}) {
143 $options{bibtex} //= [];
146 @{ref $options{bibtex}?$options{bibtex}:[$options{bibtex}]},
150 if (exists $options{bibtex}) {
151 for my $bibtex_file (@{ref $options{bibtex}?$options{bibtex}:[$options{bibtex}]}) {
152 parse_bibtex_file($bibtex_file,\%entries);
156 if (exists $options{papers_directory} and
160 load_papers_into_database($dbh,$sth,$options{papers_directory});
164 p %entries if $DEBUG;
165 if (keys %entries and
168 load_bibtex_entries_into_database($dbh,$sth,\%entries);
173 for my $bibtex_key (@ARGV) {
174 open_bibtex_key(\%options,$dbh,$sth,\%entries,$bibtex_key);
181 $sth->{clear_papers_cache}->execute();
182 $sth->{clear_bibtex_cache}->execute();
185 sub load_papers_into_database {
186 my ($dbh,$sth,$dir) = @_;
188 my @dirs = ref($dir)?@{$dir}:$dir;
190 my $actually_load_it = sub {
192 $File::Find::prune = 1;
195 return unless /\.pdf$/;
200 insert_or_replace_papers($dbh,$sth,basename($File::Find::name),File::Spec->rel2abs($_),$xoj);
204 find($actually_load_it,@dirs);
207 sub insert_or_replace_papers {
208 my ($dbh,$sth,$file_name,$file_loc,$has_xoj) = @_;
209 $sth->{insert_papers}->execute($file_name,$file_loc,$has_xoj);
210 $sth->{insert_papers}->finish();
213 sub load_bibtex_entries_into_database {
214 my ($dbh,$sth,$entries) = @_;
215 for my $entry (keys %{$entries}) {
216 next unless defined $entries->{$entry};
217 $sth->{insert_bibtex}->execute($entry,@{$entries->{$entry}}{qw(file_name pmid doi html)});
218 $sth->{insert_bibtex}->finish();
219 print STDERR "inserted $entry {".join(',',map {defined $_?"'$_'":"'undef'"} %{$entries->{$entry}})."}\n" if $DEBUG;
223 sub open_bibtex_key {
224 my ($options,$dbh,$sth,$entries,$bibtex_key) = @_;
225 if (not defined $dbh) {
226 open_entry($dbh,$sth,$entries->{$bibtex_key},$options);
229 if ($options->{search_by_pmid}) {
230 $entry = select_entry_from_pmid($dbh,$sth,$bibtex_key);
232 $entry = select_entry_from_bibtex_key($dbh,$sth,$bibtex_key);
235 open_entry($dbh,$sth,$entry,$options);
242 if (not defined $child) {
243 die "Unable to fork for some reason: $!";
246 foreach (0 .. (POSIX::sysconf (&POSIX::_SC_OPEN_MAX) || 1024))
248 open (STDIN, "</dev/null");
249 open (STDOUT, ">/dev/null");
250 open (STDERR, ">&STDOUT");
259 my ($file_name,$options,$has_xoj) = @_;
260 print STDERR "opening $file_name\n" if $DEBUG;
262 fork_exec('xournal',$file_name);
264 fork_exec('xournal',$file_name)
270 fork_exec('sensible-browser',$file);
274 my ($dbh,$sth,$entry,$options) = @_;
276 return unless defined $entry and ref $entry and keys %{$entry};
278 print STDERR "Entry: \n";
281 if (defined $entry->{file_name} and length $entry->{file_name}) {
282 my $paper = select_one($dbh,$sth->{select_papers_by_name},$entry->{file_name});
283 if (not defined $paper) {
284 my ($pmid) = $entry->{file_name} =~ /pmid_(\d+)/;
285 if (defined $pmid and length $pmid) {
286 $paper = select_one($dbh,$sth->{select_papers_by_pmid},'%pmid_'.$pmid.'.%');
290 print STDERR $entry->{file_name} if $DEBUG;
291 if (defined $paper) {
292 if ($options->{only_print}) {
293 print $paper->{path};
296 open_pdf($paper->{path},$options,$paper->{has_xoj});
299 print STDERR "Unable to find paper\n" if $DEBUG;
302 if (defined $entry->{doi}) {
303 if ($options->{only_print}) {
307 my $url = $entry->{doi};
308 $url =~ s{^doi://}{http://dx.doi.org/};
309 open_browser($url,$options);
312 if (defined $entry->{html}) {
313 if ($options->{only_print}) {
314 print $entry->{html};
317 open_browser($entry->{html},$options);
322 sub select_entry_from_pmid{
323 my ($dbh,$sth,$pmid) = @_;
325 return select_one($dbh,$sth->{select_bibtex_by_pmid},$pmid);
329 sub select_entry_from_bibtex_key{
330 my ($dbh,$sth,$bibtex_key) = @_;
332 my $entry = select_one($dbh,$sth->{select_bibtex_by_key},$bibtex_key);
333 if (not defined $entry) {
334 print STDERR "Unable to find entry by exact search\n" if $DEBUG;
335 $bibtex_key =~ s/:.*$//;
336 $entry = select_one($dbh,$sth->{select_bibtex_by_approximate_key},$bibtex_key.'%');
338 print STDERR "Found entry\n" if $DEBUG and defined $entry;
343 my ($dbh,$sth,@bind_vals) = @_;
344 $sth->execute(@bind_vals) or
345 die "Unable to select one: ".$dbh->errstr();
346 my $results = $sth->fetchall_arrayref({});
348 return ref($results)?$results->[0]:undef;
351 sub parse_bibtex_file {
352 my ($file,$entries) = @_;
354 my $bibfile = Text::BibTeX::File->new($file)
355 or die "Unable to open $file for reading: $!";
358 while ($entry = Text::BibTeX::Entry->new($bibfile)) {
359 print STDERR "In Entry ".$entry->metatype() if $DEBUG;
360 if ($entry->metatype() == BTE_COMMENT) {
361 push @entry_comments,$entry->value();
362 } elsif ($entry->metatype() == BTE_REGULAR) {
363 my $entry_key = $entry->key();
364 if (not defined $entry_key) {
365 @entry_comments = ();
369 # if there is a file comment, use it as the file name
370 for my $comment (@entry_comments) {
371 next unless $comment =~ /^\s*file(?:name)?:?\s*(.+?)\s*$/i;
372 next unless length $1;
373 $entry_data{file_name} = $1.'.pdf';
376 my %field_prefix = (doi => 'doi://',
381 my %field_name = (doi => 'doi',
384 file => 'file_name',);
385 for my $field (qw(file doi html pmid)) {
386 my $field_value = $entry->get($field);
387 if (defined $field_value and $field_value =~ /\S+/) {
388 $entry_data{$field_name{$field}} =
389 $field_prefix{$field}.$field_value if
390 not defined $entry_data{$field_name{$field}};
393 $entries->{$entry_key} = {} if not defined $entries->{$entry_key};
394 for my $field (keys %entry_data) {
395 $entries->{$entry_key}{$field} = $entry_data{$field} if
396 defined $entry_data{$field};
398 # reset the entry comments
399 @entry_comments = ();
403 print STDERR "\n" if $DEBUG;
409 sub initialize_database {
411 return open_cache($cache,1);
415 my ($cache,$initialize) = @_;
416 my $dbh = DBI->connect("dbi:SQLite:dbname=$cache","","") or
417 die "Unable to open/create database $cache";
419 $dbh->do("DROP TABLE IF EXISTS bibtex;");
420 $dbh->do("DROP TABLE IF EXISTS papers;");
422 CREATE TABLE bibtex (
423 bibtex_key TEXT PRIMARY KEY,
431 CREATE UNIQUE INDEX bibtex_file_name ON bibtex(file_name);
434 CREATE UNIQUE INDEX bibtex_bibtex_key ON bibtex(bibtex_key);
437 CREATE INDEX bibtex_pmid ON bibtex(pmid);
440 CREATE TABLE papers (
441 file_name TEXT PRIMARY KEY,
447 CREATE UNIQUE INDEX papers_path ON papers(path);
450 CREATE UNIQUE INDEX papers_file_name ON papers(file_name);
454 (insert_papers => <<'EOF',
455 INSERT OR REPLACE INTO papers(file_name,path,has_xoj) VALUES (?,?,?);
457 insert_bibtex => <<'EOF',
458 INSERT OR REPLACE INTO bibtex (bibtex_key,file_name,pmid,doi,html) VALUES (?,?,?,?,?);
460 select_papers_by_name => <<'EOF',
461 SELECT * FROM papers WHERE file_name = ?;
463 select_papers_by_pmid => <<'EOF',
464 SELECT * FROM papers WHERE file_name LIKE ?;
466 select_papers_by_path => <<'EOF',
467 SELECT * FROM papers WHERE path = ?;
469 select_bibtex_by_key => <<'EOF',
470 SELECT * FROM bibtex WHERE bibtex_key = ?;
472 select_bibtex_by_approximate_key => <<'EOF',
473 SELECT * FROM bibtex WHERE bibtex_key LIKE ?;
475 select_bibtex_by_file_name => <<'EOF',
476 SELECT * FROM bibtex WHERE file_name = ?;
478 select_bibtex_by_pmid => <<'EOF',
479 SELECT * FROM bibtex WHERE pmid = ?;
481 clear_papers_cache => <<'EOF',
484 clear_bibtex_cache => <<'EOF',
489 for my $key (keys %s) {
490 $st->{$key}=$dbh->prepare($s{$key}) //
491 die "Unable to prepare sql statement: ".$dbh->errstr;