Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
8c9251b3 | 6 | | Copyright CiviCRM LLC (c) 2004-2018 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
11 | | under the terms of the GNU Affero General Public License | | |
12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
13 | | | | |
14 | | CiviCRM is distributed in the hope that it will be useful, but | | |
15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
17 | | See the GNU Affero General Public License for more details. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License and the CiviCRM Licensing Exception along | | |
21 | | with this program; if not, contact CiviCRM LLC | | |
22 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
23 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
25 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
8c9251b3 | 31 | * @copyright CiviCRM LLC (c) 2004-2018 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | ||
36 | /** | |
37 | * Main page for blog dashlet | |
38 | */ | |
39 | class CRM_Dashlet_Page_Blog extends CRM_Core_Page { | |
40 | ||
14026aa8 TO |
41 | const CHECK_TIMEOUT = 5; |
42 | const CACHE_DAYS = 1; | |
618febd8 | 43 | const NEWS_URL = 'https://civicrm.org/news-feed.rss'; |
6a488035 | 44 | |
4b030206 | 45 | /** |
b6f31f2a | 46 | * Gets url for blog feed. |
4b030206 | 47 | * |
b6f31f2a | 48 | * @return string |
4b030206 | 49 | */ |
618febd8 CW |
50 | public function getNewsUrl() { |
51 | // Note: We use "*default*" as the default (rather than self::NEWS_URL) so that future | |
52 | // developers can change NEWS_URL without needing to update {civicrm_setting}. | |
aaffa79f | 53 | $url = Civi::settings()->get('blogUrl'); |
4b030206 | 54 | if ($url === '*default*') { |
618febd8 | 55 | $url = self::NEWS_URL; |
4b030206 TO |
56 | } |
57 | return CRM_Utils_System::evalUrl($url); | |
58 | } | |
59 | ||
b6f31f2a CW |
60 | /** |
61 | * Output data to template. | |
62 | */ | |
63 | public function run() { | |
b6f31f2a | 64 | $this->assign('feeds', $this->getData()); |
6a488035 TO |
65 | return parent::run(); |
66 | } | |
67 | ||
68 | /** | |
b6f31f2a CW |
69 | * Load feeds from cache. |
70 | * | |
71 | * Refresh cache if expired. | |
6a488035 TO |
72 | * |
73 | * @return array | |
6a488035 | 74 | */ |
b6f31f2a | 75 | protected function getData() { |
6a488035 TO |
76 | // Fetch data from cache |
77 | $cache = CRM_Core_DAO::executeQuery("SELECT data, created_date FROM civicrm_cache | |
618febd8 | 78 | WHERE group_name = 'dashboard' AND path = 'newsfeed'"); |
6a488035 TO |
79 | if ($cache->fetch()) { |
80 | $expire = time() - (60 * 60 * 24 * self::CACHE_DAYS); | |
81 | // Refresh data after CACHE_DAYS | |
82 | if (strtotime($cache->created_date) < $expire) { | |
b6f31f2a | 83 | $new_data = $this->getFeeds(); |
6a488035 TO |
84 | // If fetching the new rss feed was successful, return it |
85 | // Otherwise use the old cached data - it's better than nothing | |
618febd8 | 86 | if ($new_data) { |
6a488035 TO |
87 | return $new_data; |
88 | } | |
89 | } | |
90 | return unserialize($cache->data); | |
91 | } | |
b6f31f2a | 92 | return $this->getFeeds(); |
6a488035 TO |
93 | } |
94 | ||
95 | /** | |
b6f31f2a CW |
96 | * Fetch all feeds & cache results. |
97 | * | |
98 | * @return array | |
99 | */ | |
100 | protected function getFeeds() { | |
618febd8 CW |
101 | $newsFeed = $this->getFeed($this->getNewsUrl()); |
102 | // If unable to fetch the feed, return empty results. | |
103 | if (!$newsFeed) { | |
104 | return array(); | |
b6f31f2a | 105 | } |
618febd8 CW |
106 | $feeds = $this->formatItems($newsFeed); |
107 | CRM_Core_BAO_Cache::setItem($feeds, 'dashboard', 'newsfeed'); | |
b6f31f2a CW |
108 | return $feeds; |
109 | } | |
110 | ||
111 | /** | |
112 | * Parse a single rss feed. | |
6a488035 | 113 | * |
77b97be7 EM |
114 | * @param $url |
115 | * | |
72b3a70c CW |
116 | * @return array|NULL |
117 | * array of blog items; or NULL if not available | |
6a488035 | 118 | */ |
b6f31f2a | 119 | protected function getFeed($url) { |
14026aa8 | 120 | $httpClient = new CRM_Utils_HttpClient(self::CHECK_TIMEOUT); |
8c2d418b | 121 | list ($status, $rawFeed) = $httpClient->get($url); |
14026aa8 TO |
122 | if ($status !== CRM_Utils_HttpClient::STATUS_OK) { |
123 | return NULL; | |
124 | } | |
b6f31f2a CW |
125 | return @simplexml_load_string($rawFeed); |
126 | } | |
14026aa8 | 127 | |
b6f31f2a CW |
128 | /** |
129 | * @param string $feed | |
130 | * @return array | |
131 | */ | |
132 | protected function formatItems($feed) { | |
618febd8 CW |
133 | $result = array(); |
134 | if ($feed && !empty($feed->channel)) { | |
135 | foreach ($feed->channel as $channel) { | |
136 | $content = array( | |
137 | 'title' => (string) $channel->title, | |
138 | 'description' => (string) $channel->description, | |
139 | 'name' => strtolower(CRM_Utils_String::munge($channel->title, '-')), | |
140 | 'items' => array(), | |
141 | ); | |
142 | foreach ($channel->item as $item) { | |
143 | $item = (array) $item; | |
144 | $item['title'] = strip_tags($item['title']); | |
e7df6b4f | 145 | // Clean up description - remove tags & styles that would break dashboard layout |
618febd8 | 146 | $description = preg_replace('#<h[1-3][^>]*>(.+?)</h[1-3][^>]*>#s', '<h4>$1</h4>', $item['description']); |
e7df6b4f CW |
147 | $description = strip_tags($description, "<a><p><h4><h5><h6><b><i><em><strong><ol><ul><li><dd><dt><code><pre><br><hr>"); |
148 | $description = preg_replace('/(<[^>]+) style=["\'].*?["\']/i', '$1', $description); | |
618febd8 CW |
149 | // Add paragraph markup if it's missing. |
150 | if (strpos($description, '<p') === FALSE) { | |
151 | $description = '<p>' . $description . '</p>'; | |
152 | } | |
153 | $item['description'] = $description; | |
154 | $content['items'][] = $item; | |
155 | } | |
156 | if ($content['items']) { | |
157 | $result[] = $content; | |
d383174a | 158 | } |
6a488035 TO |
159 | } |
160 | } | |
618febd8 | 161 | return $result; |
6a488035 | 162 | } |
96025800 | 163 | |
6a488035 | 164 | } |