-
Notifications
You must be signed in to change notification settings - Fork 1
/
FieldtypeOembed.module
executable file
·423 lines (350 loc) · 11.4 KB
/
FieldtypeOembed.module
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
<?php
/**
* COPYRIGHT NOTICE
* Copyright (c) 2023 Neue Rituale GbR
* @author NR <code@neuerituale.com>
*/
namespace ProcessWire;
// load vendors
use \Essence\Di\Container;
use \Essence\Essence;
use \Essence\Media;
use \Essence\Provider;
/**
* Class FieldtypeOembed
*
* @method string wakeupValue(Page $page, Field $field, $value)
* @method array sleepValue(Page $page, Field $field, $value)
* @method Oembed formatValue(Page $page, Field $field, $value)
* @method bool validateEssenceResult($essenceResult)
* @method Essence getEssence($configuration = [])
* @method array arrayMapKeys(array $array, callable $callable, array $options = [])
* @method array filterProps(array $out)
*
* @package ProcessWire
*/
class FieldtypeOembed extends FieldtypeURL implements Module, ConfigurableModule {
const MysqlDatetimeFormat = 'Y-m-d H:i:s';
const refreshLog = 'oembed-refresh';
const installEssenceMsg = '';
private ?Essence $essence = null;
public static function getModuleInfo(): array {
return [
'title' => 'Oembed',
'version' => 116,
'summary' => 'Collect and store Oembed Data',
'href' => 'https://github.com/neuerituale/FieldtypeOembed',
'icon' => 'globe',
'installs' => 'InputfieldOembed',
];
}
public function install(){
if(
!class_exists("\Essence\Essence") &&
!file_exists(__DIR__ . '/vendor/autoload.php')
) $this->warning($this->installEssenceMsg, Notice::allowMarkdown);
}
public function __construct() {
require_once(__DIR__ . '/Oembed.php');
$this->installEssenceMsg = $this->_("Please install the Essence library via `composer install` in the FieldtypeOembed module directory.");
parent::__construct();
}
public function init() {
// find hook name and init lazy cron hook
$hookName = $this->timeFuncs[$this->cronSchedule] ?? false;
if($hookName) $this->addHook('LazyCron::' . $hookName, $this, 'refreshOembedData');
}
/**
* Return the database schema that defines an Event
* @param Field $field
* @return array
*/
public function getDatabaseSchema(Field $field): array {
$schema = parent::getDatabaseSchema($field);
$schema['oembed'] = 'JSON';
$schema['expires'] = 'DATETIME';
return $schema;
}
/**
* Return the Inputfield used to collect input for a field of this type
* @param Page $page
* @param Field $field
* @return InputfieldURL
* @throws WirePermissionException
*/
public function getInputfield(Page $page, Field $field): InputfieldURL {
/** @var InputfieldURL $inputfield */
$inputfield = $this->modules->get('InputfieldOembed');
$inputfield->set('noRelative', $field->get('noRelative'));
$inputfield->set('addRoot', $field->get('addRoot'));
$inputfield->set('cacheTime', $field->get('cacheTime'));
return $inputfield;
}
/**
* Return a blank ready-to-populate value
*
* @param Page $page
* @param Field $field
* @return Oembed
*
*/
public function getBlankValue(Page $page, Field $field): Oembed {
return new Oembed($page, $field);
}
/**
* Given a raw value from DB
* @param Page $page
* @param Field $field
* @param array|int|string $value
* @return string
*/
public function ___wakeupValue(Page $page, Field $field, $value): string {
$oembedObj = $this->getBlankValue($page, $field);
$oembedData = json_decode($value['oembed'],JSON_OBJECT_AS_ARRAY);
if(is_array($oembedData)) $oembedObj->setArray($oembedData);
$page->setQuietly('_oembedObj' . $field->name, $oembedObj);
$page->setQuietly('_oembedExpires' . $field->name, $this->datetime->date('ts', $value['expires']));
return $value['data'];
}
/**
* For storage in DB
* @param Page $page
* @param Field $field
* @param array|float|int|object|string $value
* @return array
*/
public function ___sleepValue(Page $page, Field $field, $value): array {
// get raw data
if($value instanceof Oembed) $value = $page->getUnformatted($field->name);
$oembedData = $this->fetch($value);
return [
'data' => $value,
'oembed' => json_encode($oembedData, JSON_FORCE_OBJECT | JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES),
'expires' => $oembedData
? $this->datetime->date(self::MysqlDatetimeFormat, time() + $field->get('cacheTime'))
: 0
];
}
/**
* Format a value for front-end output
* @param Page $page
* @param Field $field
* @param string $value
* @return Oembed
*/
public function ___formatValue(Page $page, Field $field, $value) {
return $page->get('_oembedObj' . $field->name);
}
/**
* @param Page $page
* @param Field $field
* @param $value
* @return bool
*/
public function isDeleteValue(Page $page, Field $field, $value): bool {
return empty($value);
}
/**
* Fetch Data
* @param $url
* @return array
*/
public function fetch($url): array {
/** @var Essence $essence */
$essence = $this->getEssence();
/** @var Media $embed */
$embed = $essence->extract($url);
if(!$this->validateEssenceResult($embed)) return [];
// get properties and rewrite keys (camelCase)
$props = $embed->filledProperties();
return $this->arrayMapKeys($props, [$this->sanitizer, 'camelCase']);
}
/**
* Validate response (hookable)
* @param $essenceResult
* @return bool
*/
public function ___validateEssenceResult($essenceResult): bool {
return (
$essenceResult instanceof Media &&
!empty($essenceResult->get('type'))
);
}
/**
* Get the essence instance
* @param $configuration
* @return Essence
* @throws \Exception
*/
public function ___getEssence($configuration = []): Essence {
if($this->essence instanceof Essence) return $this->essence;
// check global essence class and include autoload
if(!class_exists("\Essence\Essence")) {
if(!file_exists(__DIR__ . '/vendor/autoload.php')) throw new \Exception($this->installEssenceMsg);
require_once(/*NoCompile*/__DIR__ . '/vendor/autoload.php');
}
// parse customProviders JSON and add to configuration array;
try { $customProviders = json_decode($this->customProviders, JSON_OBJECT_AS_ARRAY);}
catch(\Exception $e) { /* ignore */ }
if(isset($customProviders) && is_array($customProviders) && count($customProviders))
$configuration = array_merge($configuration, $this->makeCustomProvidersConfig($customProviders));
// return instance
$this->essence = new Essence($configuration);
return $this->essence;
}
/**
* @param $customProviders
* @return array
*/
private function makeCustomProvidersConfig($customProviders): array {
$configuration = [];
$configuration['filters'] = [];
foreach($customProviders as $key => $value) {
// skip existing configs
if(array_key_exists($key, $configuration)) continue;
try {
// Add new provider
if(is_array($value)) {
$configuration[$key] = \Essence\Di\Container::unique(function(Container $C) use ($value) {
/** @var Provider\MetaTags|Provider\OEmbed|Provider $provider */
$provider = $C->get($value['class'] . 'Provider');
if(array_key_exists('endpoint', $value) && method_exists($provider, 'setEndpoint'))
$provider->setEndpoint($value['endpoint']);
return $provider;
});
$configuration['filters'][$key] = $value['filter'] ?? false;
}
// Disabled provider
else {
$configuration['filters'][$key] = false;
}
} catch(\Exception $e) { /* ignore */ }
}
return $configuration;
}
/**
* Method called when the field is database-queried from a $pages->find() selector
* @param DatabaseQuerySelect|PageFinderDatabaseQuerySelect
* @param string $table
* @param string $subfield
* @param string $operator
* @param string $value
* @return DatabaseQuerySelect|PageFinderDatabaseQuerySelect
*/
public function getMatchQuery($query, $table, $subfield, $operator, $value) {
if($subfield === 'data') {
return parent::getMatchQuery($query, $table, $subfield, $operator, $value);
} else {
// sanitize names
$field = $this->sanitizer->fieldName($subfield);
$table = $this->database->escapeTable($table);
// convert to timestamp
if($subfield === 'expires') {
$value = $this->datetime->date(self::MysqlDatetimeFormat, $value);
$query->where("$table.expires{$operator}?", $value);
$query->where("$table.expires>?", 0);
} else {
// cast to int or float
if(is_numeric($value)) $value = $value*1;
if($this->database->isOperator($operator, WireDatabasePDO::operatorTypeComparison)) {
if(!strlen($value)) {
$col = "JSON_EXTRACT(oembed, \"$.$field\")";
if($operator === '=') {
$where = "$col IS NULL OR $col='' OR JSON_CONTAINS(oembed, '{\"$field\": null}')=1";
} else {
$where = "$col IS NOT NULL AND $col !='' AND JSON_CONTAINS(oembed, '{\"$field\": null}')!=1";
}
$query->where($where);
} else {
$query->where("JSON_CONTAINS(oembed, ?, '$.$field') $operator 1", json_encode($value));
}
} else {
throw new \mysqli_sql_exception('Invalid operator for subfield: ' . $operator);
}
}
return $query;
}
}
/**
* Field Config
* @param Field $field
* @return InputfieldWrapper
* @throws WireException
* @throws WirePermissionException
*/
public function ___getConfigInputfields(Field $field): InputfieldWrapper {
// defaults
if(is_null($field->get('noRelative'))) $field->set('noRelative', 1);
if(is_null($field->get('cacheTime'))) $field->set('cacheTime', 8640000);
$inputfields = parent::___getConfigInputfields($field);
/** @var InputfieldRadios $f */
$f = $this->modules->get('InputfieldInteger');
$f->attr('name', 'cacheTime');
$f->label = $this->_('Cachetime');
$f->columnWidth = 33;
$f->description = sprintf(
$this->_('The number of seconds an API response should be cached for. The default cache time is %1$s (%2$s days). %3$s means no cache (not recommended).'),
'`8640000`',
'100',
'`0`'
);
$f->value = $field->get('cacheTime');
// add before noRelative
$noRelative = $inputfields->get('noRelative');
$inputfields->insertBefore($f, $noRelative);
// hide noRelative field
$noRelative->collapsed = Inputfield::collapsedHidden;
return $inputfields;
}
/**
* array_map for the keys
* @param array $array
* @param callable $callable
* @param array $options
* @return array
*/
public function ___arrayMapKeys(array $array, callable $callable, array $options = []): array {
$options = array_merge([
'recursive' => false
], $options);
$out = [];
foreach ($array as $key => $value) {
$out[$callable($key, $options)] = is_array($value && $options['recursive'])
? $this->arrayMapKeys($value, $callable, $options)
: $value
;
}
return $this->filterProps($out);
}
/**
* Filter props for hooking
* @param array $out
* @return array
*/
public function ___filterProps(array $out) : array { return $out; }
/**
* Refresh all oembed fields. Respect the expires time
* @param $event
* @return void
*/
public function refreshOembedData($event = null) {
foreach(wire()->fields->findByType($this) as $field) {
$expiredPages = $this->pages->findMany("{$field->name}.expires<now,check_access=0,include=hidden");
foreach($expiredPages as $expiredPage) {
try {
$expiredPage->of(false);
$expiredPage->save($field->name);
wire()->log->save(
self::refreshLog,
'Refresh Oembed Data From URL ' . $expiredPage->getUnformatted($field->name)
);
} catch(\Exception $exception) {
wire()->log->save(
self::refreshLog,
'Error in field ' . $expiredPage->getUnformatted($field->name) . ': ' . $exception->getMessage()
);
}
}
}
}
}