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 +--------------------------------------------------------------------+
29 * This class handles all REST client requests.
32 * @copyright CiviCRM LLC (c) 2004-2014
35 class CRM_Utils_REST
{
38 * Number of seconds we should let a REST process idle
41 static $rest_timeout = 0;
44 * Cache the actual UF Class
49 * Class constructor. This caches the real user framework class locally,
50 * so we can use it for authentication and validation.
52 * @internal param string $uf The userframework class
54 public function __construct() {
55 // any external program which call Rest Server is responsible for
56 // creating and attaching the session
57 $args = func_get_args();
58 $this->ufClass
= array_shift($args);
62 * Simple ping function to test for liveness.
65 * The string to be echoed.
69 public static function ping($var = NULL) {
70 $session = CRM_Core_Session
::singleton();
71 $key = $session->get('key');
72 //$session->set( 'key', $var );
73 return self
::simple(array('message' => "PONG: $key"));
76 // Generates values needed for error messages
78 * @param string $message
82 public static function error($message = 'Unknown Error') {
84 'error_message' => $message,
90 // Generates values needed for non-error responses.
92 * @param array $params
96 public static function simple($params) {
97 $values = array('is_error' => 0);
105 public function run() {
106 $result = self
::handle();
107 return self
::output($result);
113 public function bootAndRun() {
114 $response = $this->loadCMSBootstrap();
115 if (is_array($response)) {
116 return self
::output($response);
126 public static function output(&$result) {
127 $requestParams = CRM_Utils_Request
::exportValues();
130 if (is_scalar($result)) {
134 $result = self
::simple(array('result' => $result));
136 elseif (is_array($result)) {
137 if (CRM_Utils_Array
::isHierarchical($result)) {
140 elseif (!array_key_exists('is_error', $result)) {
141 $result['is_error'] = 0;
145 $result = self
::error('Could not interpret return values from function.');
148 if (!empty($requestParams['json'])) {
149 header('Content-Type: application/json');
150 $json = json_encode(array_merge($result));
151 if (!empty($requestParams['prettyprint'])) {
152 // Used by the api explorer
153 return self
::jsonFormated($json);
158 if (isset($result['count'])) {
159 $count = ' count="' . $result['count'] . '" ';
164 $xml = "<?xml version=\"1.0\"?>
165 <ResultSet xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" $count>
167 // check if this is a single element result (contact_get etc)
170 foreach ($result['values'] as $n => $v) {
171 $xml .= "<Result>\n" . CRM_Utils_Array
::xml($v) . "</Result>\n";
175 $xml .= "<Result>\n" . CRM_Utils_Array
::xml($result) . "</Result>\n";
178 $xml .= "</ResultSet>\n";
187 public static function jsonFormated($json) {
197 for ($i = 0; $i < strlen($json); $i++
) {
213 $result .= $char . $newline . str_repeat($tab, $tabcount);
223 $result = trim($result) . $newline . str_repeat($tab, $tabcount) . $char;
228 if ($inquote ||
$inarray) {
232 $result .= $char . $newline . str_repeat($tab, $tabcount);
237 $inquote = !$inquote;
270 public static function handle() {
271 $requestParams = CRM_Utils_Request
::exportValues();
273 // Get the function name being called from the q parameter in the query string
274 $q = CRM_Utils_array
::value('q', $requestParams);
275 // or for the rest interface, from fnName
276 $r = CRM_Utils_array
::value('fnName', $requestParams);
280 $entity = CRM_Utils_array
::value('entity', $requestParams);
281 if (empty($entity) && !empty($q)) {
282 $args = explode('/', $q);
283 // If the function isn't in the civicrm namespace, reject the request.
284 if ($args[0] != 'civicrm') {
285 return self
::error('Unknown function invocation.');
288 // If the query string is malformed, reject the request.
289 // Does this mean it will reject it
290 if ((count($args) != 3) && ($args[1] != 'ping')) {
291 return self
::error('Unknown function invocation.');
295 if ($args[1] == 'ping') {
300 // or the new format (entity+action)
302 $args[0] = 'civicrm';
303 $args[1] = CRM_Utils_array
::value('entity', $requestParams);
304 $args[2] = CRM_Utils_array
::value('action', $requestParams);
307 // Everyone should be required to provide the server key, so the whole
308 // interface can be disabled in more change to the configuration file.
309 // first check for civicrm site key
310 if (!CRM_Utils_System
::authenticateKey(FALSE)) {
311 $docLink = CRM_Utils_System
::docURL2("Managing Scheduled Jobs", TRUE, NULL, NULL, NULL, "wiki");
312 $key = CRM_Utils_array
::value('key', $requestParams);
314 return self
::error("FATAL: mandatory param 'key' missing. More info at: " . $docLink);
316 return self
::error("FATAL: 'key' is incorrect. More info at: " . $docLink);
319 // At this point we know we are not calling ping which does not require authentication.
320 // Therefore, at this point we need to make sure we're working with a trusted user.
321 // Valid users are those who provide a valid server key and API key
325 // Check and see if a valid secret API key is provided.
326 $api_key = CRM_Utils_Request
::retrieve('api_key', 'String', $store, FALSE, NULL, 'REQUEST');
327 if (!$api_key ||
strtolower($api_key) == 'null') {
328 return self
::error("FATAL: mandatory param 'api_key' (user key) missing");
330 $valid_user = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $api_key, 'id', 'api_key');
332 // If we didn't find a valid user, die
333 if (empty($valid_user)) {
334 return self
::error("User API key invalid");
337 return self
::process($args, self
::buildParamList());
342 * @param array $params
346 public static function process(&$args, $params) {
347 $params['check_permissions'] = TRUE;
348 $fnName = $apiFile = NULL;
349 // clean up all function / class names. they should be alphanumeric and _ only
350 for ($i = 1; $i <= 3; $i++
) {
351 if (!empty($args[$i])) {
352 $args[$i] = CRM_Utils_String
::munge($args[$i]);
356 // incase of ajax functions className is passed in url
357 if (isset($params['className'])) {
358 $params['className'] = CRM_Utils_String
::munge($params['className']);
360 // functions that are defined only in AJAX.php can be called via
362 if (!CRM_Core_Page_AJAX
::checkAuthz('method', $params['className'], $params['fnName'])) {
363 return self
::error('Unknown function invocation.');
366 return call_user_func(array($params['className'], $params['fnName']), $params);
369 if (!array_key_exists('version', $params)) {
370 $params['version'] = 3;
373 if ($params['version'] == 2) {
374 $result['is_error'] = 1;
375 $result['error_message'] = "FATAL: API v2 not accessible from ajax/REST";
376 $result['deprecated'] = "Please upgrade to API v3";
380 if ($_SERVER['REQUEST_METHOD'] == 'GET' && strtolower(substr($args[2], 0, 3)) != 'get') {
381 // get only valid for non destructive methods
382 require_once 'api/v3/utils.php';
383 return civicrm_api3_create_error("SECURITY: All requests that modify the database must be http POST, not GET.",
385 'IP' => $_SERVER['REMOTE_ADDR'],
386 'level' => 'security',
387 'referer' => $_SERVER['HTTP_REFERER'],
388 'reason' => 'Destructive HTTP GET',
393 // trap all fatal errors
394 $errorScope = CRM_Core_TemporaryErrorScope
::create(array('CRM_Utils_REST', 'fatal'));
395 $result = civicrm_api($args[1], $args[2], $params);
398 if ($result === FALSE) {
399 return self
::error('Unknown error.');
405 * @return array|mixed|null
407 public static function &buildParamList() {
408 $requestParams = CRM_Utils_Request
::exportValues();
420 if (array_key_exists('json', $requestParams) && $requestParams['json'][0] == "{") {
421 $params = json_decode($requestParams['json'], TRUE);
422 if ($params === NULL) {
423 CRM_Utils_JSON
::output(array('is_error' => 1, 'error_message', 'Unable to decode supplied JSON.'));
426 foreach ($requestParams as $n => $v) {
427 if (!array_key_exists($n, $skipVars)) {
431 if (array_key_exists('return', $requestParams) && is_array($requestParams['return'])) {
432 foreach ($requestParams['return'] as $key => $v) {
433 $params['return.' . $key] = 1;
442 public static function fatal($pearError) {
443 header('Content-Type: text/xml');
445 $error['code'] = $pearError->getCode();
446 $error['error_message'] = $pearError->getMessage();
447 $error['mode'] = $pearError->getMode();
448 $error['debug_info'] = $pearError->getDebugInfo();
449 $error['type'] = $pearError->getType();
450 $error['user_info'] = $pearError->getUserInfo();
451 $error['to_string'] = $pearError->toString();
452 $error['is_error'] = 1;
454 echo self
::output($error);
456 CRM_Utils_System
::civiExit();
459 public static function APIDoc() {
461 CRM_Utils_System
::setTitle("API Parameters");
462 $template = CRM_Core_Smarty
::singleton();
463 return CRM_Utils_System
::theme(
464 $template->fetch('CRM/Core/APIDoc.tpl')
468 public static function ajaxDoc() {
469 return CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/api/explorer'));
472 /** used to load a template "inline", eg. for ajax, without having to build a menu for each template */
473 static function loadTemplate () {
474 $request = CRM_Utils_Request
::retrieve('q', 'String');
475 if (FALSE !== strpos($request, '..')) {
476 die ("SECURITY FATAL: the url can't contain '..'. Please report the issue on the forum at civicrm.org");
479 $request = split('/', $request);
480 $entity = _civicrm_api_get_camel_name($request[2]);
481 $tplfile = _civicrm_api_get_camel_name($request[3]);
483 $tpl = 'CRM/' . $entity . '/Page/Inline/' . $tplfile . '.tpl';
484 $smarty = CRM_Core_Smarty
::singleton();
485 CRM_Utils_System
::setTitle("$entity::$tplfile inline $tpl");
486 if (!$smarty->template_exists($tpl)) {
487 header("Status: 404 Not Found");
488 die ("Can't find the requested template file templates/$tpl");
490 if (array_key_exists('id', $_GET)) {// special treatmenent, because it's often used
491 $smarty->assign('id', (int) $_GET['id']);// an id is always positive
493 $pos = strpos(implode(array_keys($_GET)), '<');
495 if ($pos !== FALSE) {
496 die ("SECURITY FATAL: one of the param names contains <");
498 $param = array_map('htmlentities', $_GET);
500 $smarty->assign_by_ref("request", $param);
502 if (! array_key_exists('HTTP_X_REQUESTED_WITH', $_SERVER) ||
503 $_SERVER['HTTP_X_REQUESTED_WITH'] != "XMLHttpRequest" ) {
505 $smarty->assign('tplFile', $tpl);
506 $config = CRM_Core_Config
::singleton();
507 $content = $smarty->fetch('CRM/common/'. strtolower($config->userFramework
) .'.tpl');
509 if (!defined('CIVICRM_UF_HEAD') && $region = CRM_Core_Region
::instance('html-header', FALSE)) {
510 CRM_Utils_System
::addHTMLHead($region->render(''));
512 CRM_Utils_System
::appendTPLFile($tpl, $content);
514 return CRM_Utils_System
::theme($content);
518 $content = "<!-- .tpl file embeded: $tpl -->\n";
519 CRM_Utils_System
::appendTPLFile($tpl, $content);
520 echo $content . $smarty->fetch($tpl);
521 CRM_Utils_System
::civiExit();
525 /** This is a wrapper so you can call an api via json (it returns json too)
526 * http://example.org/civicrm/api/json?entity=Contact&action=Get"&json={"contact_type":"Individual","email.get.email":{}} to take all the emails from individuals
527 * works for POST & GET (POST recommended)
529 public static function ajaxJson() {
530 $requestParams = CRM_Utils_Request
::exportValues();
532 require_once 'api/v3/utils.php';
533 // Why is $config undefined -- $config = CRM_Core_Config::singleton();
534 if (!$config->debug
&& (!array_key_exists('HTTP_X_REQUESTED_WITH', $_SERVER) ||
535 $_SERVER['HTTP_X_REQUESTED_WITH'] != "XMLHttpRequest"
537 $error = civicrm_api3_create_error("SECURITY ALERT: Ajax requests can only be issued by javascript clients, eg. CRM.api3().",
539 'IP' => $_SERVER['REMOTE_ADDR'],
540 'level' => 'security',
541 'referer' => $_SERVER['HTTP_REFERER'],
542 'reason' => 'CSRF suspected',
545 CRM_Utils_JSON
::output($error);
547 if (empty($requestParams['entity'])) {
548 CRM_Utils_JSON
::output(civicrm_api3_create_error('missing entity param'));
550 if (empty($requestParams['entity'])) {
551 CRM_Utils_JSON
::output(civicrm_api3_create_error('missing entity entity'));
553 if (!empty($requestParams['json'])) {
554 $params = json_decode($requestParams['json'], TRUE);
556 $entity = CRM_Utils_String
::munge(CRM_Utils_Array
::value('entity', $requestParams));
557 $action = CRM_Utils_String
::munge(CRM_Utils_Array
::value('action', $requestParams));
558 if (!is_array($params)) {
559 CRM_Utils_JSON
::output(array('is_error' => 1, 'error_message', 'invalid json format: ?{"param_with_double_quote":"value"}'));
562 $params['check_permissions'] = TRUE;
563 $params['version'] = 3;
564 $_GET['json'] = $requestParams['json'] = 1; // $requestParams is local-only; this line seems pointless unless there's a side-effect influencing other functions
565 if (!$params['sequential']) {
566 $params['sequential'] = 1;
569 // trap all fatal errors
570 $errorScope = CRM_Core_TemporaryErrorScope
::create(array('CRM_Utils_REST', 'fatal'));
571 $result = civicrm_api($entity, $action, $params);
574 echo self
::output($result);
576 CRM_Utils_System
::civiExit();
579 public static function ajax() {
580 $requestParams = CRM_Utils_Request
::exportValues();
582 // this is driven by the menu system, so we can use permissioning to
583 // restrict calls to this etc
584 // the request has to be sent by an ajax call. First line of protection against csrf
585 $config = CRM_Core_Config
::singleton();
586 if (!$config->debug
&&
587 (!array_key_exists('HTTP_X_REQUESTED_WITH', $_SERVER) ||
588 $_SERVER['HTTP_X_REQUESTED_WITH'] != "XMLHttpRequest"
591 require_once 'api/v3/utils.php';
592 $error = civicrm_api3_create_error("SECURITY ALERT: Ajax requests can only be issued by javascript clients, eg. CRM.api3().",
594 'IP' => $_SERVER['REMOTE_ADDR'],
595 'level' => 'security',
596 'referer' => $_SERVER['HTTP_REFERER'],
597 'reason' => 'CSRF suspected',
600 CRM_Utils_JSON
::output($error);
603 $q = CRM_Utils_Array
::value('fnName', $requestParams);
605 $entity = CRM_Utils_Array
::value('entity', $requestParams);
606 $action = CRM_Utils_Array
::value('action', $requestParams);
607 if (!$entity ||
!$action) {
608 $err = array('error_message' => 'missing mandatory params "entity=" or "action="', 'is_error' => 1);
609 echo self
::output($err);
610 CRM_Utils_System
::civiExit();
612 $args = array('civicrm', $entity, $action);
615 $args = explode('/', $q);
618 // get the class name, since all ajax functions pass className
619 $className = CRM_Utils_Array
::value('className', $requestParams);
621 // If the function isn't in the civicrm namespace, reject the request.
622 if (($args[0] != 'civicrm' && count($args) != 3) && !$className) {
623 return self
::error('Unknown function invocation.');
626 // Support for multiple api calls
627 if (isset($entity) && $entity === 'api3') {
628 $result = self
::processMultiple();
631 $result = self
::process($args, self
::buildParamList());
634 echo self
::output($result);
636 CRM_Utils_System
::civiExit();
640 * Callback for multiple ajax api calls from CRM.api3()
643 public static function processMultiple() {
645 foreach (json_decode($_REQUEST['json'], TRUE) as $key => $call) {
651 $output[$key] = self
::process($args, CRM_Utils_Array
::value(2, $call, array()));
657 * @return array|NULL NULL if execution should proceed; array if the response is already known
659 public function loadCMSBootstrap() {
660 $requestParams = CRM_Utils_Request
::exportValues();
661 $q = CRM_Utils_array
::value('q', $requestParams);
662 $args = explode('/', $q);
664 // Proceed with bootstrap for "?entity=X&action=Y"
665 // Proceed with bootstrap for "?q=civicrm/X/Y" but not "?q=civicrm/ping"
667 if (count($args) == 2 && $args[1] == 'ping') {
668 return NULL; // this is pretty wonky but maybe there's some reason I can't see
670 if (count($args) != 3) {
671 return self
::error('ERROR: Malformed REST path');
673 if ($args[0] != 'civicrm') {
674 return self
::error('ERROR: Malformed REST path');
676 // Therefore we have reasonably well-formed "?q=civicrm/X/Y"
679 if (!CRM_Utils_System
::authenticateKey(FALSE)) {
680 // FIXME: At time of writing, this doesn't actually do anything because
681 // authenticateKey abends, but that's a bad behavior which sends a
682 // malformed response.
683 return self
::error('Failed to authenticate key');
689 $api_key = CRM_Utils_Request
::retrieve('api_key', 'String', $store, FALSE, NULL, 'REQUEST');
690 if (empty($api_key)) {
691 return self
::error("FATAL: mandatory param 'api_key' (user key) missing");
693 $contact_id = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $api_key, 'id', 'api_key');
695 $uid = CRM_Core_BAO_UFMatch
::getUFId($contact_id);
700 CRM_Utils_System
::loadBootStrap(array('uid' => $uid), TRUE, FALSE);
704 return self
::error('ERROR: No CMS user associated with given api-key');