CRM/Utils/SoapServer.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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
  31  * @copyright CiviCRM LLC (c) 2004-2013
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class handles all SOAP client requests.
  38  *
  39  * @package CRM
  40  * @copyright CiviCRM LLC (c) 2004-2013
  41  * $Id$
  42  *
  43  */
  44 class CRM_Utils_SoapServer {
  45
  46   /**
  47    * Number of seconds we should let a soap process idle
  48    * @static
  49    */
  50   static $soap_timeout = 0;
  51
  52   /**
  53    * Cache the actual UF Class
  54    */
  55   public $ufClass;
  56
  57   /**
  58    * Class constructor.  This caches the real user framework class locally,
  59    * so we can use it for authentication and validation.
  60    *
  61    * @param  string $uf       The userframework class
  62    */
  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);
  68   }
  69
  70   /**
  71    * Simple ping function to test for liveness.
  72    *
  73    * @param string $var   The string to be echoed
  74    *
  75    * @return string       $var
  76    * @access public
  77    */
  78   public function ping($var) {
  79     $session = CRM_Core_Session::singleton();
  80     $key = $session->get('key');
  81     $session->set('key', $var);
  82     return "PONG: $var ($key)";
  83   }
  84
  85   /**
  86    * Verify a SOAP key
  87    *
  88    * @param string $key   The soap key generated by authenticate()
  89    *
  90    * @return none
  91    * @access public
  92    */
  93   public function verify($key) {
  94     $session = CRM_Core_Session::singleton();
  95
  96     $soap_key = $session->get('soap_key');
  97     $t = time();
  98
  99     if ($key !== sha1($soap_key)) {
 100       throw new SoapFault('Client', 'Invalid key');
 101     }
 102
 103
 104     if (self::$soap_timeout &&
 105       $t > ($session->get('soap_time') + self::$soap_timeout)
 106     ) {
 107       throw new SoapFault('Client', 'Expired key');
 108     }
 109
 110     /* otherwise, we're ok.  update the timestamp */
 111
 112     $session->set('soap_time', $t);
 113   }
 114
 115   /**
 116    * Authentication wrapper to the UF Class
 117    *
 118    * @param string $name      Login name
 119    * @param string $pass      Password
 120    *
 121    * @return string           The SOAP Client key
 122    * @access public
 123    * @static
 124    */
 125   public function authenticate($name, $pass, $loadCMSBootstrap = FALSE) {
 126     require_once (str_replace('_', DIRECTORY_SEPARATOR, $this->ufClass) . '.php');
 127
 128     if ($this->ufClass == 'CRM_Utils_System_Joomla'){
 129       $loadCMSBootstrap = true;
 130     }
 131
 132     eval('$result =& ' . $this->ufClass . '::authenticate($name, $pass, $loadCMSBootstrap );');
 133
 134     if (empty($result)) {
 135       throw new SoapFault('Client', 'Invalid login');
 136     }
 137
 138     $session = CRM_Core_Session::singleton();
 139     $session->set('soap_key', $result[2]);
 140     $session->set('soap_time', time());
 141
 142     return sha1($result[2]);
 143   }
 144
 145   /*** MAILER API ***/
 146   public function mailer_event_bounce($key, $job, $queue, $hash, $body) {
 147     $this->verify($key);
 148     $params = array(
 149       'job_id' => $job,
 150       'time_stamp' => date('YmdHis'),
 151       'event_queue_id' => $queue,
 152       'hash' => $hash,
 153       'body' => $body,
 154       'version' => 3,
 155     );
 156     return civicrm_api('Mailing', 'event_bounce', $params);
 157   }
 158
 159   public function mailer_event_unsubscribe($key, $job, $queue, $hash) {
 160     $this->verify($key);
 161     $params = array(
 162       'job_id' => $job,
 163       'time_stamp' => date('YmdHis'),
 164       'org_unsubscribe' => 0,
 165       'event_queue_id' => $queue,
 166       'hash' => $hash,
 167       'version' => 3,
 168     );
 169     return civicrm_api('MailingGroup', 'event_unsubscribe', $params);
 170   }
 171
 172   public function mailer_event_domain_unsubscribe($key, $job, $queue, $hash) {
 173     $this->verify($key);
 174     $params = array(
 175       'job_id' => $job,
 176       'time_stamp' => date('YmdHis'),
 177       'org_unsubscribe' => 1,
 178       'event_queue_id' => $queue,
 179       'hash' => $hash,
 180       'version' => 3,
 181     );
 182     return civicrm_api('MailingGroup', 'event_domain_unsubscribe', $params);
 183   }
 184
 185   public function mailer_event_resubscribe($key, $job, $queue, $hash) {
 186     $this->verify($key);
 187     $params = array(
 188       'job_id' => $job,
 189       'time_stamp' => date('YmdHis'),
 190       'org_unsubscribe' => 0,
 191       'event_queue_id' => $queue,
 192       'hash' => $hash,
 193       'version' => 3,
 194     );
 195     return civicrm_api('MailingGroup', 'event_resubscribe', $params);
 196   }
 197
 198   public function mailer_event_subscribe($key, $email, $domain, $group) {
 199     $this->verify($key);
 200     $params = array(
 201       'email' => $email,
 202       'group_id' => $group,
 203       'version' => 3,
 204     );
 205     return civicrm_api('MailingGroup', 'event_subscribe', $params);
 206   }
 207
 208   public function mailer_event_confirm($key, $contact, $subscribe, $hash) {
 209     $this->verify($key);
 210     $params = array(
 211       'contact_id' => $contact,
 212       'subscribe_id' => $subscribe,
 213       'time_stamp' => date('YmdHis'),
 214       'event_subscribe_id' => $subscribe,
 215       'hash' => $hash,
 216       'version' => 3,
 217     );
 218     return civicrm_api('Mailing', 'event_confirm', $params);
 219   }
 220
 221   public function mailer_event_reply($key, $job, $queue, $hash, $bodyTxt, $rt, $bodyHTML = NULL, $fullEmail = NULL) {
 222     $this->verify($key);
 223     $params = array(
 224       'job_id' => $job,
 225       'event_queue_id' => $queue,
 226       'hash' => $hash,
 227       'bodyTxt' => $bodyTxt,
 228       'replyTo' => $rt,
 229       'bodyHTML' => $bodyHTML,
 230       'fullEmail' => $fullEmail,
 231       'time_stamp' => date('YmdHis'),
 232       'version' => 3,
 233     );
 234     return civicrm_api('Mailing', 'event_reply', $params);
 235   }
 236
 237   public function mailer_event_forward($key, $job, $queue, $hash, $email) {
 238     $this->verify($key);
 239     $params = array(
 240       'job_id' => $job,
 241       'event_queue_id' => $queue,
 242       'hash' => $hash,
 243       'email' => $email,
 244       'version' => 3,
 245     );
 246     return civicrm_api('Mailing', 'event_forward', $params);
 247   }
 248
 249   public function get_contact($key, $params) {
 250     $this->verify($key);
 251     $params['version'] = 3;
 252     return civicrm_api('contact', 'get', $params);
 253   }
 254 }
 255