-
Notifications
You must be signed in to change notification settings - Fork 8
/
twigfeeds.php
322 lines (301 loc) · 12.3 KB
/
twigfeeds.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
<?php
/**
* TwigFeeds Plugin
*
* PHP version 8
*
* @category Extensions
* @package Grav
* @subpackage Presentation
* @author Ole Vik <[email protected]>
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @link https://github.com/OleVik/grav-plugin-twigfeeds
*/
namespace Grav\Plugin;
use Grav\Common\Plugin;
use RocketTheme\Toolbox\Event\Event;
use Grav\Plugin\TwigFeedsPlugin\API\Parser;
use Grav\Plugin\TwigFeedsPlugin\API\Manifest;
use Grav\Plugin\TwigFeedsPlugin\Utilities;
/**
* Parse RSS and Atom feeds with Twig
*
* Exposes RSS and Atom feeds to Grav, making them available for use in Twig.
* This means you can define a RSS feed in the plugin-configuration, then
* access them for iteration in Twig-templates.
*
* Class TwigFeedsPlugin
*
* @category Extensions
* @package Grav\Plugin
* @author Ole Vik <[email protected]>
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @link https://github.com/OleVik/grav-plugin-twigfeeds
*/
class TwigFeedsPlugin extends Plugin
{
/**
* Register events with Grav
*
* @return array
*/
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 the plugin and events
*
* @return void
*/
public function onPluginsInitialized()
{
if (version_compare(PHP_VERSION, '8.0.0') < 0) {
$this->grav['log']->error('TwigFeeds-plugin v5 requires PHP v8 or above');
return;
}
$this->enable(
[
'onBeforeCacheClear' => ['onBeforeCacheClear', 0],
'onTwigSiteVariables' => ['outputFeeds', 0],
'onTwigPageVariables' => ['outputFeeds', 0]
]
);
}
/**
* Register cache-location with onBeforeCacheClear-event
*
* @param RocketTheme\Toolbox\Event\Event $event Event-handler
*
* @return void
*/
public function onBeforeCacheClear(Event $event)
{
$remove = isset($event['remove']) ? $event['remove'] : 'standard';
$paths = $event['paths'];
if (in_array($remove, ['all', 'standard', 'cache-only']) && !in_array('cache://', $paths)) {
$paths[] = 'cache://twigfeeds/';
$event['paths'] = $paths;
}
}
/**
* Declare config from plugin-config
*
* @return array Plugin configuration
*/
public function config()
{
$config = (array) $this->config->get('plugins.twigfeeds');
$config['locator'] = $this->grav['locator'];
$config['config_file'] = $config['locator']->findResource('user://config', true) . '/plugins/twigfeeds.yaml';
if ($config['static_cache']) {
$config['cache_path'] = $config['locator']->findResource('user://data', true) . '/twigfeeds/';
} else {
$config['cache_path'] = $config['locator']->findResource('cache://', true) . '/twigfeeds/';
}
$config['blueprint_path'] = $config['locator']->findResource('user://plugins/twigfeeds/blueprints.yaml', true);
return $config;
}
/**
* Logs and outputs messages to debugger
*
* @param string $msg Message to output
*
* @return string Debug messages logged and output to Debugger
*/
protected function debug($msg)
{
if (is_array($msg)) {
$this->grav['debugger']->addMessage($msg);
} else {
$this->grav['debugger']->addMessage('TwigFeeds: ' . $msg);
$this->grav['log']->debug('TwigFeeds: ' . $msg);
}
}
/**
* Builds array of feeds for iteration, using cache-mechanism if enabled
*
* @return array Feeds
*/
public function outputFeeds()
{
if ($this->isAdmin() || $this->config()['enabled'] != true) {
return;
}
if (isset($this->grav['twig']->twig_vars['twig_feeds'])) {
return;
}
$config = $this->config();
$utility = new Utilities($config);
$config['now'] = $utility->now;
$manifest = new Manifest($config, $utility);
$parser = new Parser($config);
$cache = $config['cache'];
$debug = $config['debug'];
if ($debug && (array) $this->config->get('system.debugger.enabled')) {
$this->grav['debugger']->startTimer('twigfeeds', 'TwigFeeds');
}
if ($cache) {
/* Create Manifest */
$manifestFile = $config['cache_path'] . 'manifest.json';
if (!file_exists($manifestFile)) {
$debug ? $this->debug('Manifest does not exist, writing it') : null;
$content = $manifest->manifestStructure($config['config_file']);
$content['data'] = $config['twig_feeds'];
$call = $manifest->writeManifest($manifestFile, $content);
$debug ? $this->debug($call) : null;
} else {
/* Test versions */
$manifestVersion = $utility->getVersion($manifestFile, 'manifest');
$blueprintVersion = $utility->getVersion($config['blueprint_path'], 'blueprint');
$versionCompare = $utility->compareSemVer($manifestVersion, $blueprintVersion);
$major = $versionCompare['compare']['major'];
$minor = $versionCompare['compare']['minor'];
if ($major == 'greater' || $minor == 'greater') {
$versionDiff = $blueprintVersion . ' != ' . $manifestVersion;
$debug ? $this->debug('Versions different (' . $versionDiff . '), busting cache') : null;
$bustCache = true;
} else {
$debug ? $this->debug('Versions equal, continuing') : null;
}
/* Test contents of manifest and config */
$content = $manifest->readManifest($manifestFile);
$call = $manifest->compare($content);
if ($call['state'] == 'changed') {
$callback = $call['state'];
$debug ? $this->debug('Config (' . $callback . ') and manifest unequal, busting cache') : null;
$bustCache = true;
} else {
$debug ? $this->debug('Config and manifest equal, continuing') : null;
}
/* If necessary, bust cache */
if (isset($bustCache)) {
$call = $manifest->bustCache();
$debug ? $this->debug($call) : null;
/* Update manifest */
$debug ? $this->debug('Updating manifest') : null;
$content = $manifest->manifestStructure($manifestFile);
$call = $manifest->writeManifest($manifestFile, $content);
$debug ? $this->debug($call) : null;
}
}
/* Parse feeds */
$content = $manifest->readManifest($manifestFile);
foreach ($content['data'] as $entry => $data) {
$data['title'] = $data['filename'];
$data['source'] = $entry;
$data['now'] = $utility->now;
$data['cache'] = true;
if (!$config['pass_headers']) {
unset($data['etag']);
unset($data['last_modified']);
}
$path = $config['cache_path'] . $data['filename'];
if (!file_exists($path)) {
$debug ? $this->debug('Can\'t find ' . $data['filename'] . ', writing it') : null;
$call = $parser->parseFeed($data, $path);
if ($config['silence_security'] && $call == null) {
continue;
}
if ($debug && isset($call['callback'])) {
$this->debug($call['callback']);
}
if (isset($call['data']['etag'])) {
$content['data'][$entry]['etag'] = $call['data']['etag'];
}
if (isset($call['data']['last_modified'])) {
$content['data'][$entry]['last_modified'] = $call['data']['last_modified'];
}
$content['data'][$entry]['last_checked'] = $utility->now;
$content['data'][$entry]['last_checked_date'] = $utility->humanDate($utility->now);
} else {
$then = $utility->humanDate($data['last_checked'] + $data['cache_time']);
$now = $utility->humanDate($utility->now);
if (($data['last_checked'] + $data['cache_time']) > $utility->now) {
$debug ? $this->debug($then . ' is after ' . $now . ', skip ' . $entry) : null;
} else {
$debug ? $this->debug($then . ' is before ' . $now . ', download ' . $entry) : null;
$call = $parser->parseFeed($data, $path);
if ($config['silence_security'] && $call == null) {
continue;
}
if ($debug && isset($call['callback'])) {
$this->debug($call['callback']);
}
if (isset($call['data']['etag'])) {
$content['data'][$entry]['etag'] = $call['data']['etag'];
}
if (isset($call['data']['last_modified'])) {
$content['data'][$entry]['last_modified'] = $call['data']['last_modified'];
}
$content['data'][$entry]['last_checked'] = $utility->now;
$content['data'][$entry]['last_checked_date'] = $utility->humanDate($utility->now);
}
}
}
$debug ? $this->debug('Updating manifest') : null;
$call = $manifest->updateManifest($manifestFile, $content);
$debug ? $this->debug($call) : null;
}
/* Read data into Twig-variable */
$feed_items = array();
if ($cache) {
foreach ($content['data'] as $source => $data) {
$filename = $config['cache_path'] . $data['filename'];
$content = $parser->readFeed($filename);
if ($content) {
$feed_items[$content['name']] = $content;
} else {
$debug ? $this->debug('Could not find ' . $filename . ', continuing') : null;
}
}
} else {
foreach ($config['twig_feeds'] as $feed) {
$feed['now'] = $utility->now;
$feed['cache'] = 'no';
if (isset($feed['start'])) {
$start = $feed['start'];
} else {
$start = 0;
}
if (isset($feed['end'])) {
$end = $feed['end'];
} else {
$end = 50;
}
$feed['amount'] = abs($start - $end);
$resource = $parser->parseFeed($feed);
if ($config['silence_security'] && $resource == null) {
continue;
}
if (isset($feed['name'])) {
$name = $feed['name'];
} elseif (isset($resource['data']['title'])) {
$name = $resource['data']['title'];
} else {
$name = $feed['source'];
}
$feed_items[$name] = $feed;
if (isset($resource['data']) && !empty($resource['data'])) {
$feed_items[$name] = array_merge($feed, $resource['data']);
}
$debug ? $this->debug($resource['data']) : null;
}
}
$this->grav['twig']->twig_vars['twig_feeds'] = $feed_items;
if ($debug && (array) $this->config->get('system.debugger.enabled')) {
$this->grav['debugger']->stopTimer('twigfeeds');
}
}
}