/
Resource.php
444 lines (375 loc) · 14.8 KB
/
Resource.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
<?php
namespace Sterc\SeoSuite\Plugins;
use MODX\Revolution\modResource;
use Sterc\SeoSuite\Model\SeoSuiteResource;
use Sterc\SeoSuite\Model\SeoSuiteRedirect;
class Resource extends Base
{
/**
* Holds an array of the record to be used in JS.
* @var array
*/
protected $record = [];
/**
* Holds an array of all loaded sections.
* @var array
*/
protected $loaded = [];
/**
* Check if the user has the right permission.
*
* @access protected.
* @param String $section.
* @return Boolean.
*/
protected function hasPermission($section)
{
if (isset($this->seosuite->config[$section]['permission'])) {
return $this->seosuite->config[$section]['permission'];
}
return false;
}
/**
* Check if the SEO Suite is enabled for the current template.
*
* @access protected.
* @param Object $resource.
* @param String $mode.
* @return Boolean.
*/
protected function isEnabled($resource, $mode = 'create')
{
$template = (string) $resource->get('template');
$templates = $this->seosuite->config['disabled_templates'];
if (isset($_GET['template'])) {
$template = (string) $_GET['template'];
}
if ($template === '0') {
$template = (string) $this->modx->getOption('default_template', null, '0');
}
if ($template === '0') {
return false;
}
if (count($templates) >= 1) {
return !in_array($template, $templates, true);
}
return true;
}
/**
* Check if a section is loaded.
*
* @access protected.
* @param Null|String $section.
* @return Boolean.
*/
protected function isLoaded($section = null)
{
if ($section !== null) {
return in_array($section, $this->loaded, true);
}
return count($this->loaded) >= 1;
}
/**
* @access protected.
* @return Array.
*/
protected function getSeoSuiteFields()
{
$fields = [];
foreach ($_POST as $key => $value) {
if (preg_match('/^seosuite_(.*)/', $key, $matches)) {
$fields[$matches[1]] = $value;
}
}
foreach (['sitemap', 'searchable', 'canonical'] as $key) {
if (!isset($fields[$key])) {
$fields[$key] = 1;
if ($key === 'canonical') {
$fields[$key] = 0;
}
}
}
return $fields;
}
/**
*
*/
public function onMODXInit()
{
$version = $this->modx->getVersionData();
$version = (int) ($version['version'] . $version['major_version']);
if ($version < 27) {
$this->modx->loadClass('modResource');
$this->modx->map['modResource']['fieldMeta']['description'] = [
'dbtype' => 'text',
'phptype' => 'string',
'index' => 'fulltext',
'indexgrp' => 'content_ft_idx'
];
}
}
/**
* @access public.
* @param Object $event.
* @return void.
*/
public function onBeforeDocFormSave($event)
{
$resource =& $event->params['resource'];
if ($resource && $resource instanceof modResource) {
if ($resource->hasChildren() && (int) $this->modx->getOption('use_alias_path') === 1) {
$childIds = $this->modx->getChildIds($resource->get('id'), 99, ['context' => $resource->get('context_key')]);
$childResources = $this->modx->getIterator(modResource::class, [
'id:IN' => $childIds,
'uri_override' => false,
'deleted' => false
]);
foreach ($childResources as $childResource) {
$this->saveChildResourceRedirect($childResource, $resource->get('context_key'));
}
}
}
}
/**
* @access public.
* @param Object $event.
* @return void.
*/
public function onDocFormSave($event)
{
$resource =& $event->params['resource'];
if ($resource && $resource instanceof modResource) {
$this->seosuite->setResourceProperties($resource->get('id'), $this->getSeoSuiteFields());
$this->seosuite->setSocialProperties($resource->get('id'), $this->getSeoSuiteFields());
$this->seosuite->setRedirectProperties($resource);
}
}
/**
* @param $event
*/
public function onDocFormRender($event)
{
$resource =& $event->params['resource'];
$mode =& $event->params['mode'];
if ($this->isEnabled($resource, $mode)) {
if ($this->hasPermission('meta')) {
$this->loadMeta($resource);
}
if ($this->hasPermission('tab_seo')) {
$this->loadTabSeo($resource);
}
if ($this->hasPermission('tab_social')) {
$this->loadTabSocial($resource);
}
if ($this->isLoaded()) {
if (is_array($this->seosuite->config['lexicons'])) {
foreach ($this->seosuite->config['lexicons'] as $lexicon) {
$this->modx->controller->addLexiconTopic($lexicon);
}
} else {
$this->modx->controller->addLexiconTopic($this->seosuite->config['lexicons']);
}
$this->modx->controller->addHtml('<script type="text/javascript">
Ext.onReady(function() {
SeoSuite.config = ' . $this->modx->toJSON($this->seosuite->config) . ';
SeoSuite.record = ' . $this->modx->toJSON($this->record) . ';
});
</script>');
$this->modx->controller->addCss($this->seosuite->config['css_url'] . 'mgr/seosuite.css');
$this->modx->controller->addJavascript($this->seosuite->config['js_url'] . 'mgr/seosuite.js');
$this->modx->controller->addJavascript($this->seosuite->config['js_url'] . 'mgr/extras/extras.js');
/* Loading specific scripts for specific section. */
if ($this->isLoaded('meta')) {
$this->modx->regClientStartupScript($this->seosuite->config['js_url'] . 'mgr/resource/metatag.js?v=' . $this->seosuite->config['version']);
$this->modx->regClientStartupScript($this->seosuite->config['js_url'] . 'mgr/resource/resource.tab_meta.js?v=' . $this->seosuite->config['version']);
}
/* Loading specific scripts for specific section. */
if ($this->isLoaded('seo')) {
$this->modx->controller->addLastJavascript($this->seosuite->config['js_url'] . 'mgr/widgets/redirects.grid.js?v='. $this->seosuite->config['version']);
$this->modx->controller->addLastJavascript($this->seosuite->config['js_url'] . 'mgr/resource/resource.tab_seo.js?v='. $this->seosuite->config['version']);
}
/* Loading specific scripts for specific section. */
if ($this->isLoaded('social')) {
$this->modx->controller->addLastJavascript($this->seosuite->config['js_url'] . 'mgr/resource/resource.tab_social.js?v='. $this->seosuite->config['version']);
}
}
}
}
/**
* @TODO Fix it for duplicating child resources, I created a PR to fix this in MODX Core: https://github.com/modxcms/revolution/pull/14874
*
* @access public.
* @param Object $event.
* @return void.
*/
public function onResourceDuplicate($event)
{
$oldResource =& $event->params['oldResource'];
$newResource =& $event->params['newResource'];
if ($oldResource && $newResource) {
$this->seosuite->setResourceProperties($newResource->get('id'), $this->seosuite->getResourceProperties($oldResource->get('id')));
$this->seosuite->setSocialProperties($newResource->get('id'), $this->seosuite->getSocialProperties($oldResource->get('id')));
}
}
/**
* When creating a duplicate resource with Babels 'Create Translation'.
*
* @param Object $event
* @return void
*/
public function onBabelDuplicate($event)
{
$oldResource =& $event->params['original_resource'];
$newResource =& $event->params['duplicate_resource'];
if ($oldResource && $newResource) {
$this->seosuite->setResourceProperties($newResource->get('id'), $this->seosuite->getResourceProperties($oldResource->get('id')));
$this->seosuite->setSocialProperties($newResource->get('id'), $this->seosuite->getSocialProperties($oldResource->get('id')));
}
}
/**
* @access public.
* @param Object $event.
* @return void.
*/
public function onEmptyTrash($event)
{
foreach ((array) $event->params['ids'] as $id) {
$this->seosuite->removeResourceProperties($id);
$this->seosuite->removeSocialProperties($id);
}
}
/**
* Set placeholders for SeoSuite Meta data.
*/
public function onLoadWebDocument()
{
if ($this->isEnabled($this->modx->resource) && $this->seosuite->config['placeholder_plugin_enabled']) {
$this->modx->runSnippet('seosuiteMeta', [
'toPlaceholders' => true
]);
}
}
public function onPageNotFound()
{
}
public function onResourceBeforeSort()
{
list($sourceCtx, $resource) = explode('_', $this->modx->getOption('source', $_POST));
list($targetCtx, $target) = explode('_', $this->modx->getOption('target', $_POST));
switch ($this->modx->getOption('point', $_POST)) {
case 'above':
case 'below':
$tmpRes = $this->modx->getObject(modResource::class, $target);
if ($tmpRes) {
$target = $tmpRes->get('parent');
unset($tmpRes);
}
break;
}
$oldResource = $this->modx->getObject(modResource::class, $resource);
$modResource = $this->modx->getObject(modResource::class, $resource);
if ($oldResource && $modResource && $target !== $oldResource->get('parent')) {
$modResource->set('parent', $target);
$modResource->set('uri', '');
$uriChanged = false;
if ($oldResource->get('uri') != $modResource->get('uri') && $oldResource->get('uri') != '') {
$uriChanged = true;
}
if ($oldResource->get('alias') != $modResource->get('alias') && $oldResource->get('alias') != '') {
$newProperties['urls'][] = ['url' => $oldResource->get('uri')];
$uriChanged = true;
}
/* Recursive set redirects for drag/dropped resource, and its children (where uri_override is not set) . */
if ($uriChanged && (int) $this->modx->getOption('use_alias_path') === 1) {
$oldResource->set('isfolder', true);
$resourceOldBasePath = $oldResource->getAliasPath($oldResource->get('alias'), $oldResource->toArray());
$query = $this->modx->newQuery(modResource::class);
$query->where([
[
'uri:LIKE' => $resourceOldBasePath . '%',
'OR:id:=' => $oldResource->id
],
'uri_override' => false,
'published' => true,
'deleted' => false,
'context_key' => $modResource->get('context_key')
]);
$childResources = $this->modx->getIterator(modResource::class, $query);
foreach ($childResources as $childResource) {
$this->saveChildResourceRedirect($childResource, $sourceCtx);
}
}
}
}
public function onManagerPageBeforeRender()
{
}
public function saveChildResourceRedirect(modResource $modResource, string $contextKey)
{
if ($this->modx->getCount(SeoSuiteRedirect::class, ['old_url' => $modResource->get('uri'), 'context_key' => $modResource->get('context_key')])) {
// Redirect already exists
return false;
}
$data = [
'old_url' => $modResource->get('uri'),
'resource_id' => $modResource->get('id'),
'context_key' => $contextKey,
'new_url' => $modResource->get('id'),
'redirect_type' => 'HTTP/1.1 301 Moved Permanently'
];
$redirect = $this->modx->newObject(SeoSuiteRedirect::class);
$redirect->fromArray($data);
$redirect->save();
}
/**
* Load tab Meta.
*
* @access protected.
* @param Object $resource.
*/
protected function loadMeta($resource)
{
//$properties = $this->seosuite->getResourceProperties($resource->get('id'));
$seoSuiteResource = $this->modx->getObject(SeoSuiteResource::class, ['resource_id' => $resource->get('id')]);
if ($seoSuiteResource) {
$this->record['keywords'] = $seoSuiteResource->get('keywords');
$this->record['use_default_meta'] = $seoSuiteResource->get('use_default_meta');
$this->record['meta_title'] = $seoSuiteResource->get('meta_title');
$this->record['meta_description'] = $seoSuiteResource->get('meta_description');
} else {
$this->record['keywords'] = '';
$this->record['use_default_meta'] = 1;
$this->record['meta_title'] = json_decode($this->seosuite->config['meta']['default_meta_title'], true);
$this->record['meta_description'] = json_decode($this->seosuite->config['meta']['default_meta_description'], true);
}
$this->loaded[] = 'meta';
}
/**
* Load tab SEO.
*
* @access protected.
* @param Object $resource.
*/
protected function loadTabSeo($resource)
{
$properties = $this->seosuite->getResourceProperties($resource->get('id'));
foreach ((array) $properties as $key => $value) {
$this->record['seosuite_' . $key] = $value;
}
$this->loaded[] = 'seo';
}
/**
* Load tab social.
*
* @access public.
* @param Object $resource.
*/
protected function loadTabSocial($resource)
{
$properties = $this->seosuite->getSocialProperties($resource->get('id'));
foreach ((array) $properties as $key => $value) {
$this->record['seosuite_' . $key] = $value;
}
$this->loaded[] = 'social';
}
}