Commit | Line | Data |
---|---|---|
04eee3f6 | 1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
3435af9a | 4 | | CiviCRM version 4.7 | |
04eee3f6 | 5 | +--------------------------------------------------------------------+ |
0f03f337 | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
04eee3f6 | 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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * | |
30 | * @package CRM | |
0f03f337 | 31 | * @copyright CiviCRM LLC (c) 2004-2017 |
04eee3f6 | 32 | * $Id$ |
33 | * | |
34 | */ | |
35 | ||
36 | /** | |
37 | * Main page for getting started dashlet | |
38 | */ | |
39 | class CRM_Dashlet_Page_GettingStarted extends CRM_Core_Page { | |
40 | ||
41 | const CHECK_TIMEOUT = 5; | |
e1674273 | 42 | const CACHE_DAYS = 5; |
04eee3f6 | 43 | const GETTING_STARTED_URL = 'https://alert.civicrm.org/welcome?prot=1&ver={ver}&uf={uf}&sid={sid}&lang={lang}&co={co}'; |
44 | ||
45 | /** | |
46 | * Define tokens available for getting started | |
47 | */ | |
48 | static $_tokens = array( | |
49 | 'crmurl' => array( | |
50 | 'configbackend' => 'civicrm/admin/configtask', | |
ea9c6310 | 51 | ), |
4175ee03 | 52 | ); |
04eee3f6 | 53 | |
54 | /** | |
55 | * Get the final, usable URL string (after interpolating any variables) | |
56 | * | |
57 | * @return FALSE|string | |
58 | */ | |
59 | public function gettingStartedUrl() { | |
60 | // Note: We use "*default*" as the default (rather than self::GETTING_STARTED_URL) so that future | |
61 | // developers can change GETTING_STARTED_URL without needing to update {civicrm_setting}. | |
1f957d1e | 62 | $url = Civi::settings()->get('gettingStartedUrl'); |
04eee3f6 | 63 | if ($url === '*default*') { |
64 | $url = self::GETTING_STARTED_URL; | |
65 | } | |
66 | return CRM_Utils_System::evalUrl($url); | |
67 | } | |
68 | ||
69 | /** | |
70 | * List gettingStarted page as dashlet. | |
71 | */ | |
72 | public function run() { | |
73 | $context = CRM_Utils_Request::retrieve('context', 'String', $this, FALSE, 'dashlet'); | |
04eee3f6 | 74 | |
7e90e573 JL |
75 | // Assign smarty variables. |
76 | $this->assign('context', $context); | |
04eee3f6 | 77 | $this->assign('gettingStarted', $this->_gettingStarted()); |
78 | ||
7e90e573 | 79 | // Use smarty to generate page. |
04eee3f6 | 80 | return parent::run(); |
81 | } | |
82 | ||
83 | /** | |
84 | * Load gettingStarted page from cache. | |
85 | * Refresh cache if expired | |
86 | * | |
87 | * @return array | |
88 | */ | |
89 | private function _gettingStarted() { | |
90 | // Fetch data from cache | |
91 | $cache = CRM_Core_DAO::executeQuery("SELECT data, created_date FROM civicrm_cache | |
92 | WHERE group_name = 'dashboard' AND path = 'gettingStarted'"); | |
93 | if ($cache->fetch()) { | |
94 | $expire = time() - (60 * 60 * 24 * self::CACHE_DAYS); | |
95 | // Refresh data after CACHE_DAYS | |
96 | if (strtotime($cache->created_date) < $expire) { | |
97 | $new_data = $this->_getHtml($this->gettingStartedUrl()); | |
98 | // If fetching the new html was successful, return it | |
99 | // Otherwise use the old cached data - it's better than nothing | |
100 | if ($new_data) { | |
101 | return $new_data; | |
102 | } | |
103 | } | |
104 | return unserialize($cache->data); | |
105 | } | |
106 | return $this->_getHtml($this->gettingStartedUrl()); | |
107 | } | |
108 | ||
109 | /** | |
110 | * Get html and cache results. | |
111 | * | |
112 | * @param $url | |
113 | * | |
114 | * @return array|NULL | |
115 | * array of gettingStarted items; or NULL if not available | |
116 | */ | |
117 | public function _getHtml($url) { | |
4175ee03 | 118 | |
04eee3f6 | 119 | $httpClient = new CRM_Utils_HttpClient(self::CHECK_TIMEOUT); |
120 | list ($status, $html) = $httpClient->get($url); | |
121 | if ($status !== CRM_Utils_HttpClient::STATUS_OK) { | |
122 | return NULL; | |
123 | } | |
4175ee03 | 124 | |
04eee3f6 | 125 | $tokensList = CRM_Utils_Token::getTokens($html); |
126 | $this->replaceLinkToken($tokensList, $html); | |
127 | if ($html) { | |
128 | CRM_Core_BAO_Cache::setItem($html, 'dashboard', 'gettingStarted'); | |
129 | } | |
130 | return $html; | |
131 | } | |
132 | ||
133 | ||
134 | /** | |
135 | * @param array $tokensList | |
4175ee03 | 136 | * @param string $str |
04eee3f6 | 137 | * |
4175ee03 | 138 | */ |
04eee3f6 | 139 | public function replaceLinkToken($tokensList, &$str) { |
4175ee03 | 140 | foreach ($tokensList as $categories => $tokens) { |
141 | foreach ($tokens as $token) { | |
04eee3f6 | 142 | $value = ''; |
143 | if (!empty(self::$_tokens[$categories][$token])) { | |
144 | $value = self::$_tokens[$categories][$token]; | |
145 | if ($categories == 'crmurl') { | |
5c4a9e59 | 146 | $value = CRM_Utils_System::url($value, "reset=1"); |
04eee3f6 | 147 | } |
148 | } | |
149 | CRM_Utils_Token::token_replace($categories, $token, $value, $str); | |
150 | } | |
151 | } | |
152 | } | |
153 | ||
154 | } |