-
Notifications
You must be signed in to change notification settings - Fork 0
/
bibliography.php
144 lines (136 loc) · 4.33 KB
/
bibliography.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
<?php
namespace Grav\Plugin;
use Grav\Common\Data;
use Grav\Common\Plugin;
use Grav\Common\Grav;
use Grav\Common\Page\Page;
use Grav\Common\Data\Blueprints;
use RocketTheme\Toolbox\Event\Event;
use Seboettg\CiteProc\StyleSheet;
use Seboettg\CiteProc\CiteProc;
/**
* Bibliography Plugin Class
*
* Reads a Bibliography-file (.json) with academic references
* and renders it as footnotes at the end of the page.
* Allows for a variety of styles and languages using CSL.
*
* Class BibliographyPlugin
*
* @package Grav\Plugin
* @return string Formatted Markdown Footnotes
* @author Ole Vik <git@olevik.me>
* @license MIT License by Ole Vik
*/
class BibliographyPlugin extends Plugin
{
/**
* Register events
*
* @return void
*/
public static function getSubscribedEvents()
{
return [
'onPluginsInitialized' => ['onPluginsInitialized', 0]
];
}
/**
* Composer autoload.
*
* @return \Composer\Autoload\ClassLoader
*/
public function autoload(): \Composer\Autoload\ClassLoader
{
return include __DIR__ . '/vendor/autoload.php';
}
/**
* Initialize events
*
* @return void
*/
public function onPluginsInitialized()
{
if ($this->config->get('system.debugger.enabled')) {
$this->grav['debugger']->startTimer('bibliography', 'Bibliography');
}
if ($this->isAdmin()) {
$this->active = false;
$this->enable(
[
'onBlueprintCreated' => ['onBlueprintCreated', 0]
]
);
} else {
$this->enable(
[
'onPageContentRaw' => ['onPageContentRaw', 0]
]
);
}
if ($this->config->get('system.debugger.enabled')) {
$this->grav['debugger']->stopTimer('bibliography');
}
}
/**
* Process raw Markdown and footnotes
*
* @param Event $event RocketTheme\Toolbox\Event\Event
*
* @return void
*/
public function onPageContentRaw(Event $event)
{
$page = $this->grav['page'];
$extra = [
"csl-entry" => function ($cslItem, $renderedText) {
return '[^' . trim($cslItem->id, "[]") . ']: ' . $renderedText;
}
];
if (!$this->config->get('system.pages.markdown.extra')) {
$this->grav['log']->warning('Bibliography: Markdown Extra disabled, returning ...');
return;
}
if (!isset($page->header()->bibliography) || $page->header()->bibliography == "") {
$this->grav['log']->warning('Bibliography: No bibliography set, returning ...');
return;
}
$bibliography = $page->header()->bibliography;
$library = 'user://data/bibliography/' . $bibliography;
if (!file_exists($library)) {
$this->grav['log']->warning('Bibliography: Referenced library does not exist, returning ...');
return;
}
$fileinfo = pathinfo($library);
if (!$fileinfo['extension'] == 'json') {
$this->grav['log']->warning('Bibliography: Referenced library is not JSON, returning ...');
return;
}
$raw = $page->getRawContent();
$Style = $page->header()->bibliography_style ?? $this->config->get('plugins.bibliography.style') ?? 'apa-5th-edition';
$Locale = $page->header()->bibliography_lang ?? $this->config->get('plugins.bibliography.locale') ?? 'en-US';
$style = StyleSheet::loadStyleSheet($Style);
$citeProc = new CiteProc($style, $Locale, $extra);
$file = file_get_contents($library);
$data = json_decode($file);
$biblio = $citeProc->render($data, "bibliography");
$biblio = strip_tags($biblio);
$biblio = implode("\n", array_map('trim', explode("\n", $biblio)));
$raw .= "\n\n" . $biblio;
$page->setRawContent($raw);
}
/**
* Register blueprints
*
* @param Event $event RocketTheme\Toolbox\Event\Event
*
* @return void
*/
public function onBlueprintCreated(Event $event)
{
$blueprint = $event['blueprint'];
$blueprints = new Blueprints(__DIR__ . '/blueprints/');
$extends = $blueprints->get($this->name);
$blueprint->extend($extends, true);
}
}