-
Notifications
You must be signed in to change notification settings - Fork 453
/
Feed.php
491 lines (430 loc) · 11.6 KB
/
Feed.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
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
<?php
namespace Concrete\Core\Entity\Page;
use Concrete\Core\Block\View\BlockView;
use Concrete\Core\Html\Object\HeadLink;
use Concrete\Core\Http\Request;
use Concrete\Core\Page\PageList;
use Concrete\Core\Page\Page;
use Concrete\Core\Permission\Access\Entity\GroupEntity;
use Doctrine\ORM\Mapping as ORM;
use Concrete\Core\Page\FeedEvent;
/**
* @ORM\Entity
* @ORM\Table(name="PageFeeds")
*/
class Feed
{
protected $itemsPerFeed = 20;
protected $checkPagePermissions = true;
/**
* @ORM\Column(type="string", nullable=true)
*/
protected $customTopicAttributeKeyHandle = null;
/**
* @ORM\Column(type="integer", options={"unsigned":true})
*/
protected $customTopicTreeNodeID = 0;
/**
* @ORM\Column(type="integer", options={"unsigned":true})
*/
protected $iconFID = 0;
/**
* @return mixed
*/
public function getIconFileID()
{
return $this->iconFID;
}
/**
* @param mixed $iconFID
*/
public function setIconFileID($iconFID)
{
$this->iconFID = $iconFID;
}
/**
* @param mixed $cParentID
*/
public function setParentID($cParentID)
{
$this->cParentID = $cParentID;
}
/**
* @return mixed
*/
public function getParentID()
{
return $this->cParentID;
}
/**
* @param mixed $pfDescription
*/
public function setDescription($pfDescription)
{
$this->pfDescription = $pfDescription;
}
/**
* @return mixed
*/
public function getDescription()
{
return $this->pfDescription;
}
/**
* @param mixed $pfDisplayAliases
*/
public function setDisplayAliases($pfDisplayAliases)
{
$this->pfDisplayAliases = $pfDisplayAliases;
}
/**
* @return mixed
*/
public function getDisplayAliases()
{
return $this->pfDisplayAliases;
}
/**
* @param mixed $pfDisplayFeaturedOnly
*/
public function setDisplayFeaturedOnly($pfDisplayFeaturedOnly)
{
$this->pfDisplayFeaturedOnly = $pfDisplayFeaturedOnly;
}
/**
* @return mixed
*/
public function getDisplayFeaturedOnly()
{
return $this->pfDisplayFeaturedOnly;
}
/**
* @return mixed
*/
public function getID()
{
return $this->pfID;
}
/**
* @param mixed $pfIncludeAllDescendents
*/
public function setIncludeAllDescendents($pfIncludeAllDescendents)
{
$this->pfIncludeAllDescendents = $pfIncludeAllDescendents;
}
/**
* @return mixed
*/
public function getIncludeAllDescendents()
{
return $this->pfIncludeAllDescendents;
}
/**
* @param mixed $pfTitle
*/
public function setTitle($pfTitle)
{
$this->pfTitle = $pfTitle;
}
/**
* @return mixed
*/
public function getTitle()
{
return $this->pfTitle;
}
/**
* @param string $format
* @return string
*/
public function getFeedDisplayTitle($format = 'html')
{
$value = t($this->getTitle());
switch ($format) {
case 'html':
return h($value);
case 'text':
default:
return $value;
}
}
/**
* @return mixed
*/
public function getCustomTopicAttributeKeyHandle()
{
return $this->customTopicAttributeKeyHandle;
}
/**
* @param mixed $customTopicAttributeKeyHandle
*/
public function setCustomTopicAttributeKeyHandle($customTopicAttributeKeyHandle)
{
$this->customTopicAttributeKeyHandle = $customTopicAttributeKeyHandle;
}
/**
* @return mixed
*/
public function getCustomTopicTreeNodeID()
{
return $this->customTopicTreeNodeID;
}
/**
* @param mixed $customTopicTreeNodeID
*/
public function setCustomTopicTreeNodeID($customTopicTreeNodeID)
{
$this->customTopicTreeNodeID = $customTopicTreeNodeID;
}
/**
* @param mixed $ptID
*/
public function setPageTypeID($ptID)
{
$this->ptID = $ptID;
}
/**
* @return mixed
*/
public function getPageTypeID()
{
return $this->ptID;
}
/**
* @ORM\Column(type="string")
*/
protected $pfDescription;
/**
* @ORM\Column(type="string")
*/
protected $pfHandle;
/**
* @param mixed $pfHandle
*/
public function setHandle($pfHandle)
{
$this->pfHandle = $pfHandle;
}
/**
* @return mixed
*/
public function getHandle()
{
return $this->pfHandle;
}
/**
* @ORM\Column(type="string")
*/
protected $pfTitle;
/**
* @ORM\Id @ORM\Column(type="integer", options={"unsigned":true})
* @ORM\GeneratedValue(strategy="AUTO")
*/
protected $pfID;
/**
* @ORM\Column(type="integer", options={"unsigned":true})
*/
protected $cParentID;
/**
* @ORM\Column(type="integer", options={"unsigned":true})
*/
protected $ptID = 0;
/**
* @ORM\Column(type="boolean")
*/
protected $pfIncludeAllDescendents = false;
/**
* @ORM\Column(type="boolean")
*/
protected $pfDisplayAliases = false;
/**
* @ORM\Column(type="string")
*/
protected $pfContentToDisplay = 'S'; // short description
/**
* @ORM\Column(type="string", nullable=true)
*/
protected $pfAreaHandleToDisplay;
public function displayShortDescriptionContent()
{
$this->pfContentToDisplay = 'S';
$this->pfAreaHandleToDisplay = null;
}
public function displayAreaContent($arHandle)
{
$this->pfContentToDisplay = 'A';
$this->pfAreaHandleToDisplay = $arHandle;
}
public function getTypeOfContentToDisplay()
{
return $this->pfContentToDisplay;
}
public function getAreaHandleToDisplay()
{
return $this->pfAreaHandleToDisplay;
}
public function getFeedURL()
{
return \URL::to('/rss/' . $this->getHandle());
}
/**
* @ORM\Column(type="boolean")
*/
protected $pfDisplayFeaturedOnly = false;
public function save()
{
$em = \ORM::entityManager();
$em->persist($this);
$em->flush();
}
public function delete()
{
$em = \ORM::entityManager();
$em->remove($this);
$em->flush();
}
public function ignorePermissions()
{
$this->checkPagePermissions = false;
}
/**
* @return \Concrete\Core\Page\PageList
*/
public function getPageListObject()
{
$pl = new PageList();
$pl->setItemsPerPage($this->itemsPerFeed);
$pl->sortByPublicDateDescending();
if (!$this->checkPagePermissions) {
$pl->ignorePermissions();
} else {
$vp = \Concrete\Core\Permission\Key\Key::getByHandle('view_page');
$guest = \Group::getByID(GUEST_GROUP_ID);
$access = GroupEntity::getOrCreate($guest);
// we set page permissions to be Guest group only, because
// authentication won't work with RSS feeds
$pl->setPermissionsChecker(function ($page) use ($vp, $access) {
$vp->setPermissionObject($page);
$pa = $vp->getPermissionAccessObject($page);
if (!is_object($pa)) {
return false;
}
return $pa->validateAccessEntities([$access]);
});
}
if ($this->cParentID) {
if ($this->pfIncludeAllDescendents) {
$parent = \Page::getByID($this->cParentID);
if (is_object($parent) && !$parent->isError()) {
$pl->filterByPath($parent->getCollectionPath());
}
} else {
$pl->filterByParentID($this->cParentID);
}
}
if ($this->getCustomTopicAttributeKeyHandle()) {
$pl->filterByTopic(intval($this->getCustomTopicTreeNodeID()));
}
if ($this->pfDisplayAliases) {
$pl->includeAliases();
}
if ($this->ptID) {
$pl->filterByPageTypeID($this->ptID);
}
if ($this->pfDisplayFeaturedOnly) {
$pl->filterByAttribute('is_featured', true);
}
return $pl;
}
protected function getPageFeedContent(Page $p)
{
$content = false;
switch ($this->pfContentToDisplay) {
case 'S':
$content = $p->getCollectionDescription();
break;
case 'A':
$a = new \Area($this->getAreaHandleToDisplay());
$blocks = $a->getAreaBlocksArray($p);
$r = Request::getInstance();
$r->setCurrentPage($p);
ob_start();
foreach ($blocks as $b) {
$bv = new BlockView($b);
$bv->render('view');
}
$content = ob_get_contents();
ob_end_clean();
break;
}
$f = $p->getAttribute('thumbnail');
if (is_object($f)) {
$content = '<p><img src="' . $f->getURL() . '" /></p>' . $content;
}
return $content;
}
/**
* Get the feed output in RSS form given a Request object.
*
* @param Request|null $request
*
* @return string|null The full RSS output as a string
*/
public function getOutput($request = null)
{
$pl = $this->getPageListObject();
$link = false;
if ($this->cParentID) {
$parent = Page::getByID($this->cParentID);
$link = $parent->getCollectionLink();
} else {
$link = \URL::to('/');
}
$pagination = $pl->getPagination();
$results = $pagination->getCurrentPageResults();
if (count($results)) {
$writer = new \Zend\Feed\Writer\Feed();
$writer->setTitle($this->getTitle());
$writer->setDescription($this->getDescription());
if ($this->getIconFileID()) {
$f = \File::getByID($this->getIconFileID());
if (is_object($f)) {
$data = [
'uri' => $f->getURL(),
'title' => $f->getTitle(),
'link' => (string) $link,
];
$writer->setImage($data);
}
}
$writer->setLink((string) $link);
foreach ($results as $p) {
$entry = $writer->createEntry();
$entry->setTitle($p->getCollectionName());
$entry->setDateCreated(strtotime($p->getCollectionDatePublic()));
$content = $this->getPageFeedContent($p);
if (!$content) {
$content = t('No Content.');
}
$entry->setDescription($content);
$entry->setLink((string) $p->getCollectionLink(true));
$writer->addEntry($entry);
}
$ev = new FeedEvent();
if (isset($parent)) {
$ev->setPageObject($parent);
}
$ev->setFeedObject($this);
$ev->setWriterObject($writer);
$ev->setRequest($request);
$ev = \Events::dispatch('on_page_feed_output', $ev);
$writer = $ev->getWriterObject();
return $writer->export('rss');
}
}
public function getHeadLinkElement()
{
$link = new HeadLink($this->getFeedURL(), 'alternate', 'application/rss+xml');
return $link;
}
}