3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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 * This class handles all SOAP client requests.
32 * @copyright CiviCRM LLC (c) 2004-2017
34 class CRM_Utils_SoapServer
{
37 * Number of seconds we should let a soap process idle
39 static $soap_timeout = 0;
42 * Cache the actual UF Class
47 * Class constructor. This caches the real user framework class locally,
48 * so we can use it for authentication and validation.
50 * @internal param string $uf The userframework class
52 public function __construct() {
53 // any external program which call SoapServer is responsible for
54 // creating and attaching the session
55 $args = func_get_args();
56 $this->ufClass
= array_shift($args);
60 * Simple ping function to test for liveness.
63 * The string to be echoed.
67 public function ping($var) {
68 $session = CRM_Core_Session
::singleton();
69 $key = $session->get('key');
70 $session->set('key', $var);
71 return "PONG: $var ($key)";
78 * The soap key generated by authenticate().
82 public function verify($key) {
83 $session = CRM_Core_Session
::singleton();
85 $soap_key = $session->get('soap_key');
88 if ($key !== sha1($soap_key)) {
89 throw new SoapFault('Client', 'Invalid key');
92 if (self
::$soap_timeout &&
93 $t > ($session->get('soap_time') + self
::$soap_timeout)
95 throw new SoapFault('Client', 'Expired key');
98 // otherwise, we're ok. update the timestamp
100 $session->set('soap_time', $t);
104 * Authentication wrapper to the UF Class.
106 * @param string $name
108 * @param string $pass
111 * @param bool $loadCMSBootstrap
115 * The SOAP Client key
117 public function authenticate($name, $pass, $loadCMSBootstrap = FALSE) {
118 require_once str_replace('_', DIRECTORY_SEPARATOR
, $this->ufClass
) . '.php';
120 if ($this->ufClass
== 'CRM_Utils_System_Joomla'
121 ||
$this->ufClass
== 'CRM_Utils_System_WordPress') {
122 $loadCMSBootstrap = TRUE;
125 $result = CRM_Utils_System
::authenticate($name, $pass, $loadCMSBootstrap);
127 if (empty($result)) {
128 throw new SoapFault('Client', 'Invalid login');
131 $session = CRM_Core_Session
::singleton();
132 $session->set('soap_key', $result[2]);
133 $session->set('soap_time', time());
135 return sha1($result[2]);
144 * @param string $hash
145 * @param string $body
150 public function mailer_event_bounce($key, $job, $queue, $hash, $body) {
154 'time_stamp' => date('YmdHis'),
155 'event_queue_id' => $queue,
160 $result = civicrm_api('Mailing', 'event_bounce', $params);
161 return CRM_Utils_Array
::encode_items($result);
165 * Mailer event unsubscribe.
170 * @param string $hash
175 public function mailer_event_unsubscribe($key, $job, $queue, $hash) {
179 'time_stamp' => date('YmdHis'),
180 'org_unsubscribe' => 0,
181 'event_queue_id' => $queue,
185 $result = civicrm_api('MailingGroup', 'event_unsubscribe', $params);
186 return CRM_Utils_Array
::encode_items($result);
198 public function mailer_event_domain_unsubscribe($key, $job, $queue, $hash) {
202 'time_stamp' => date('YmdHis'),
203 'org_unsubscribe' => 1,
204 'event_queue_id' => $queue,
208 $result = civicrm_api('MailingGroup', 'event_domain_unsubscribe', $params);
209 return CRM_Utils_Array
::encode_items($result);
221 public function mailer_event_resubscribe($key, $job, $queue, $hash) {
225 'time_stamp' => date('YmdHis'),
226 'org_unsubscribe' => 0,
227 'event_queue_id' => $queue,
231 $result = civicrm_api('MailingGroup', 'event_resubscribe', $params);
232 return CRM_Utils_Array
::encode_items($result);
244 public function mailer_event_subscribe($key, $email, $domain, $group) {
248 'group_id' => $group,
251 $result = civicrm_api('MailingGroup', 'event_subscribe', $params);
252 return CRM_Utils_Array
::encode_items($result);
264 public function mailer_event_confirm($key, $contact, $subscribe, $hash) {
267 'contact_id' => $contact,
268 'subscribe_id' => $subscribe,
269 'time_stamp' => date('YmdHis'),
270 'event_subscribe_id' => $subscribe,
274 $result = civicrm_api('Mailing', 'event_confirm', $params);
275 return CRM_Utils_Array
::encode_items($result);
285 * @param null $bodyHTML
286 * @param null $fullEmail
291 public function mailer_event_reply($key, $job, $queue, $hash, $bodyTxt, $rt, $bodyHTML = NULL, $fullEmail = NULL) {
295 'event_queue_id' => $queue,
297 'bodyTxt' => $bodyTxt,
299 'bodyHTML' => $bodyHTML,
300 'fullEmail' => $fullEmail,
301 'time_stamp' => date('YmdHis'),
304 $result = civicrm_api('Mailing', 'event_reply', $params);
305 return CRM_Utils_Array
::encode_items($result);
318 public function mailer_event_forward($key, $job, $queue, $hash, $email) {
322 'event_queue_id' => $queue,
327 $result = civicrm_api('Mailing', 'event_forward', $params);
328 return CRM_Utils_Array
::encode_items($result);
333 * @param array $params
338 public function get_contact($key, $params) {
340 $params['version'] = 3;
341 $result = civicrm_api('contact', 'get', $params);
342 return CRM_Utils_Array
::encode_items($result);