3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
37 * This class handles all SOAP client requests.
40 * @copyright CiviCRM LLC (c) 2004-2014
44 class CRM_Utils_SoapServer
{
47 * Number of seconds we should let a soap process idle
50 static $soap_timeout = 0;
53 * Cache the actual UF Class
58 * Class constructor. This caches the real user framework class locally,
59 * so we can use it for authentication and validation.
61 * @internal param string $uf The userframework class
63 public function __construct() {
64 // any external program which call SoapServer is responsible for
65 // creating and attaching the session
66 $args = func_get_args();
67 $this->ufClass
= array_shift($args);
71 * Simple ping function to test for liveness.
73 * @param string $var The string to be echoed
77 public function ping($var) {
78 $session = CRM_Core_Session
::singleton();
79 $key = $session->get('key');
80 $session->set('key', $var);
81 return "PONG: $var ($key)";
87 * @param string $key The soap key generated by authenticate()
92 public function verify($key) {
93 $session = CRM_Core_Session
::singleton();
95 $soap_key = $session->get('soap_key');
98 if ($key !== sha1($soap_key)) {
99 throw new SoapFault('Client', 'Invalid key');
103 if (self
::$soap_timeout &&
104 $t > ($session->get('soap_time') + self
::$soap_timeout)
106 throw new SoapFault('Client', 'Expired key');
109 /* otherwise, we're ok. update the timestamp */
111 $session->set('soap_time', $t);
115 * Authentication wrapper to the UF Class
117 * @param string $name Login name
118 * @param string $pass Password
120 * @param bool $loadCMSBootstrap
123 * @return string The SOAP Client key
126 public function authenticate($name, $pass, $loadCMSBootstrap = FALSE) {
127 require_once (str_replace('_', DIRECTORY_SEPARATOR
, $this->ufClass
) . '.php');
129 if ($this->ufClass
== 'CRM_Utils_System_Joomla'){
130 $loadCMSBootstrap = true;
133 $className = $this->ufClass
;
134 $result =& $className::authenticate($name, $pass, $loadCMSBootstrap );
136 if (empty($result)) {
137 throw new SoapFault('Client', 'Invalid login');
140 $session = CRM_Core_Session
::singleton();
141 $session->set('soap_key', $result[2]);
142 $session->set('soap_time', time());
144 return sha1($result[2]);
148 public function mailer_event_bounce($key, $job, $queue, $hash, $body) {
152 'time_stamp' => date('YmdHis'),
153 'event_queue_id' => $queue,
158 return civicrm_api('Mailing', 'event_bounce', $params);
170 public function mailer_event_unsubscribe($key, $job, $queue, $hash) {
174 'time_stamp' => date('YmdHis'),
175 'org_unsubscribe' => 0,
176 'event_queue_id' => $queue,
180 return civicrm_api('MailingGroup', 'event_unsubscribe', $params);
192 public function mailer_event_domain_unsubscribe($key, $job, $queue, $hash) {
196 'time_stamp' => date('YmdHis'),
197 'org_unsubscribe' => 1,
198 'event_queue_id' => $queue,
202 return civicrm_api('MailingGroup', 'event_domain_unsubscribe', $params);
214 public function mailer_event_resubscribe($key, $job, $queue, $hash) {
218 'time_stamp' => date('YmdHis'),
219 'org_unsubscribe' => 0,
220 'event_queue_id' => $queue,
224 return civicrm_api('MailingGroup', 'event_resubscribe', $params);
236 public function mailer_event_subscribe($key, $email, $domain, $group) {
240 'group_id' => $group,
243 return civicrm_api('MailingGroup', 'event_subscribe', $params);
255 public function mailer_event_confirm($key, $contact, $subscribe, $hash) {
258 'contact_id' => $contact,
259 'subscribe_id' => $subscribe,
260 'time_stamp' => date('YmdHis'),
261 'event_subscribe_id' => $subscribe,
265 return civicrm_api('Mailing', 'event_confirm', $params);
275 * @param null $bodyHTML
276 * @param null $fullEmail
281 public function mailer_event_reply($key, $job, $queue, $hash, $bodyTxt, $rt, $bodyHTML = NULL, $fullEmail = NULL) {
285 'event_queue_id' => $queue,
287 'bodyTxt' => $bodyTxt,
289 'bodyHTML' => $bodyHTML,
290 'fullEmail' => $fullEmail,
291 'time_stamp' => date('YmdHis'),
294 return civicrm_api('Mailing', 'event_reply', $params);
307 public function mailer_event_forward($key, $job, $queue, $hash, $email) {
311 'event_queue_id' => $queue,
316 return civicrm_api('Mailing', 'event_forward', $params);
321 * @param array $params
326 public function get_contact($key, $params) {
328 $params['version'] = 3;
329 return civicrm_api('contact', 'get', $params);