Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
e7112fa7 | 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
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 | |
e7112fa7 | 31 | * @copyright CiviCRM LLC (c) 2004-2015 |
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; | |
43 | const BLOG_URL = 'https://civicrm.org/blog/feed'; | |
6a488035 | 44 | |
4b030206 TO |
45 | /** |
46 | * Get the final, usable URL string (after interpolating any variables) | |
47 | * | |
48 | * @return FALSE|string | |
49 | */ | |
50 | public function getBlogUrl() { | |
51 | // Note: We use "*default*" as the default (rather than self::BLOG_URL) so that future | |
52 | // developers can change BLOG_URL without needing to update {civicrm_setting}. | |
53 | $url = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'blogUrl', NULL, '*default*'); | |
54 | if ($url === '*default*') { | |
55 | $url = self::BLOG_URL; | |
56 | } | |
57 | return CRM_Utils_System::evalUrl($url); | |
58 | } | |
59 | ||
6a488035 | 60 | /** |
fe482240 | 61 | * List blog articles as dashlet. |
6a488035 | 62 | */ |
00be9182 | 63 | public function run() { |
6a488035 TO |
64 | $context = CRM_Utils_Request::retrieve('context', 'String', $this, FALSE, 'dashlet'); |
65 | $this->assign('context', $context); | |
66 | ||
67 | $this->assign('blog', $this->_getBlog()); | |
68 | ||
69 | return parent::run(); | |
70 | } | |
71 | ||
72 | /** | |
fe482240 | 73 | * Load blog articles from cache. |
6a488035 TO |
74 | * Refresh cache if expired |
75 | * | |
76 | * @return array | |
6a488035 TO |
77 | */ |
78 | private function _getBlog() { | |
79 | // Fetch data from cache | |
80 | $cache = CRM_Core_DAO::executeQuery("SELECT data, created_date FROM civicrm_cache | |
81 | WHERE group_name = 'dashboard' AND path = 'blog'"); | |
82 | if ($cache->fetch()) { | |
83 | $expire = time() - (60 * 60 * 24 * self::CACHE_DAYS); | |
84 | // Refresh data after CACHE_DAYS | |
85 | if (strtotime($cache->created_date) < $expire) { | |
4b030206 | 86 | $new_data = $this->_getFeed($this->getBlogUrl()); |
6a488035 TO |
87 | // If fetching the new rss feed was successful, return it |
88 | // Otherwise use the old cached data - it's better than nothing | |
89 | if ($new_data) { | |
90 | return $new_data; | |
91 | } | |
92 | } | |
93 | return unserialize($cache->data); | |
94 | } | |
4b030206 | 95 | return $this->_getFeed($this->getBlogUrl()); |
6a488035 TO |
96 | } |
97 | ||
98 | /** | |
fe482240 | 99 | * Parse rss feed and cache results. |
6a488035 | 100 | * |
77b97be7 EM |
101 | * @param $url |
102 | * | |
72b3a70c CW |
103 | * @return array|NULL |
104 | * array of blog items; or NULL if not available | |
6a488035 | 105 | */ |
4b030206 | 106 | public function _getFeed($url) { |
14026aa8 | 107 | $httpClient = new CRM_Utils_HttpClient(self::CHECK_TIMEOUT); |
8c2d418b | 108 | list ($status, $rawFeed) = $httpClient->get($url); |
14026aa8 TO |
109 | if ($status !== CRM_Utils_HttpClient::STATUS_OK) { |
110 | return NULL; | |
111 | } | |
112 | $feed = @simplexml_load_string($rawFeed); | |
113 | ||
6a488035 TO |
114 | $blog = array(); |
115 | if ($feed && !empty($feed->channel->item)) { | |
116 | foreach ($feed->channel->item as $item) { | |
117 | $item = (array) $item; | |
118 | // Clean up description - remove tags that would break dashboard layout | |
119 | $description = preg_replace('#<h[1-3][^>]*>(.+?)</h[1-3][^>]*>#s', '<h4>$1</h4>', $item['description']); | |
608e6658 | 120 | $item['description'] = strip_tags($description, "<a><p><h4><h5><h6><b><i><em><strong><ol><ul><li><dd><dt><code><pre><br/>"); |
6a488035 TO |
121 | $blog[] = $item; |
122 | } | |
123 | if ($blog) { | |
124 | CRM_Core_BAO_Cache::setItem($blog, 'dashboard', 'blog'); | |
125 | } | |
126 | } | |
127 | return $blog; | |
128 | } | |
96025800 | 129 | |
6a488035 | 130 | } |