3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.3 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * Manage the download, validation, and rendering of community messages
31 class CRM_Core_CommunityMessages
{
33 const DEFAULT_MESSAGES_URL
= 'https://alert.civicrm.org/alert?prot=1&ver={ver}&uf={uf}&sid={sid}&lang={lang}&co={co}';
34 const DEFAULT_PERMISSION
= 'administer CiviCRM';
37 * Default time to wait before retrying
39 const DEFAULT_RETRY
= 7200; // 2 hours
42 * @var CRM_Utils_HttpClient
47 * @var CRM_Utils_Cache_Interface
54 protected $messagesUrl;
57 * Create default instance
59 * @return CRM_Core_CommunityMessages
61 public static function create() {
62 return new CRM_Core_CommunityMessages(
63 new CRM_Utils_Cache_SqlGroup(array(
64 'group' => 'community-messages',
67 CRM_Utils_HttpClient
::singleton()
72 * @param CRM_Utils_Cache_Interface $cache
73 * @param CRM_Utils_HttpClient $client
75 public function __construct($cache, $client, $messagesUrl = NULL) {
76 $this->cache
= $cache;
77 $this->client
= $client;
78 if ($messagesUrl === NULL) {
79 $this->messagesUrl
= CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'communityMessagesUrl', NULL, '*default*');
82 $this->messagesUrl
= $messagesUrl;
84 if ($this->messagesUrl
=== '*default*') {
85 $this->messagesUrl
= self
::DEFAULT_MESSAGES_URL
;
90 * Get the messages document (either from the cache or by downloading)
94 public function getDocument() {
96 $document = $this->cache
->get('communityMessages');
98 if (empty($document) ||
!is_array($document)) {
100 'messages' => array(),
101 'expires' => 0, // ASAP
102 'ttl' => self
::DEFAULT_RETRY
,
103 'retry' => self
::DEFAULT_RETRY
,
108 if ($document['expires'] <= CRM_Utils_Time
::getTimeRaw()) {
109 $newDocument = $this->fetchDocument();
110 if ($newDocument && $this->validateDocument($newDocument)) {
111 $document = $newDocument;
112 $document['expires'] = CRM_Utils_Time
::getTimeRaw() +
$document['ttl'];
115 // keep the old messages for now, try again later
116 $document['expires'] = CRM_Utils_Time
::getTimeRaw() +
$document['retry'];
122 $this->cache
->set('communityMessages', $document);
129 * Download document from URL and parse as JSON
131 * @return NULL|array parsed JSON
133 public function fetchDocument() {
134 list($status, $json) = $this->client
->get($this->getRenderedUrl());
135 if ($status != CRM_Utils_HttpClient
::STATUS_OK ||
empty($json)) {
138 $doc = json_decode($json, TRUE);
139 if (empty($doc) ||
json_last_error() != JSON_ERROR_NONE
) {
146 * Get the final, usable URL string (after interpolating any variables)
148 * @return FALSE|string
150 public function getRenderedUrl() {
151 return CRM_Utils_System
::evalUrl($this->messagesUrl
);
157 public function isEnabled() {
158 return $this->messagesUrl
!== FALSE && $this->messagesUrl
!== 'FALSE';
162 * Pick a message to display
166 public function pick() {
167 $document = $this->getDocument();
169 foreach ($document['messages'] as $message) {
170 if (!isset($message['perms'])) {
171 $message['perms'] = array(self
::DEFAULT_PERMISSION
);
173 if (!CRM_Core_Permission
::checkAnyPerm($message['perms'])) {
177 if (isset($message['components'])) {
178 $enabled = array_keys(CRM_Core_Component
::getEnabledComponents());
179 if (count(array_intersect($enabled, $message['components'])) == 0) {
184 $messages[] = $message;
186 if (empty($messages)) {
190 $idx = rand(0, count($messages) - 1);
191 return $messages[$idx];
195 * @param string $markup
198 public static function evalMarkup($markup) {
199 $config = CRM_Core_Config
::singleton();
201 'resourceUrl' => rtrim($config->resourceBase
, '/'),
202 'ver' => CRM_Utils_System
::version(),
203 'uf' => $config->userFramework
,
204 'php' => phpversion(),
205 'sid' => md5('sid_' . (defined('CIVICRM_SITE_KEY') ? CIVICRM_SITE_KEY
: '') . '_' . $config->userFrameworkBaseURL
),
206 'baseUrl' => $config->userFrameworkBaseURL
,
207 'lang' => $config->lcMessages
,
208 'co' => $config->defaultContactCountry
,
211 foreach ($vals as $k => $v) {
212 $vars['%%' . $k . '%%'] = $v;
213 $vars['{{' . $k . '}}'] = urlencode($v);
215 return strtr($markup, $vars);
219 * Ensure that a document is well-formed
221 * @param array $document
224 public function validateDocument($document) {
225 if (!isset($document['ttl']) ||
!is_integer($document['ttl'])) {
228 if (!isset($document['retry']) ||
!is_integer($document['retry'])) {
231 if (!isset($document['messages']) ||
!is_array($document['messages'])) {
234 foreach ($document['messages'] as $message) {
235 // TODO validate $message['markup']