service/core/REST/SugarRestJSON.php

   1 <?php
   2 if(!defined('sugarEntry'))define('sugarEntry', true);
   3 /*********************************************************************************
   4  * SugarCRM Community Edition is a customer relationship management program developed by
   5  * SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU Affero General Public License version 3 as published by the
   9  * Free Software Foundation with the addition of the following permission added
  10  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  11  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  12  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License along with
  20  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  21  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA.
  23  *
  24  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  25  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  26  *
  27  * The interactive user interfaces in modified source and object code versions
  28  * of this program must display Appropriate Legal Notices, as required under
  29  * Section 5 of the GNU Affero General Public License version 3.
  30  *
  31  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  32  * these Appropriate Legal Notices must retain the display of the "Powered by
  33  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  34  * technical reasons, the Appropriate Legal Notices must display the words
  35  * "Powered by SugarCRM".
  36  ********************************************************************************/
  37
  38
  39 require_once('service/core/REST/SugarRestSerialize.php');
  40
  41 /**
  42  * This class is a JSON implementation of REST protocol
  43  * @api
  44  */
  45 class SugarRestJSON extends SugarRestSerialize{
  46
  47         /**
  48          * It will json encode the input object and echo's it
  49          *
  50          * @param array $input - assoc array of input values: key = param name, value = param type
  51          * @return String - echos json encoded string of $input
  52          */
  53         function generateResponse($input){
  54                 $json = getJSONObj();
  55                 ob_clean();
  56                 header('Content-Type: application/json; charset=UTF-8');
  57                 if (isset($this->faultObject)) {
  58                         $this->generateFaultResponse($this->faultObject);
  59                 } else {
  60                         // JSONP support
  61                         if ( isset($_GET["jsoncallback"]) ) {
  62                                 echo $_GET["jsoncallback"] . "(";
  63                         }
  64                         echo $json->encode($input);
  65                         if ( isset($_GET["jsoncallback"]) ) {
  66                                 echo ")";
  67                         }
  68                 }
  69         } // fn
  70
  71         /**
  72          * This method calls functions on the implementation class and returns the output or Fault object in case of error to client
  73          *
  74          * @return unknown
  75          */
  76         function serve(){
  77                 $GLOBALS['log']->info('Begin: SugarRestJSON->serve');
  78                 $json_data = !empty($_REQUEST['rest_data'])? $GLOBALS['RAW_REQUEST']['rest_data']: '';
  79                 if(empty($_REQUEST['method']) || !method_exists($this->implementation, $_REQUEST['method'])){
  80                         $er = new SoapError();
  81                         $er->set_error('invalid_call');
  82                         $this->fault($er);
  83                 }else{
  84                         $method = $_REQUEST['method'];
  85                         $json = getJSONObj();
  86                         $data = $json->decode($json_data);
  87                         if(!is_array($data))$data = array($data);
  88                         $res = call_user_func_array(array( $this->implementation, $method),$data);
  89                         $GLOBALS['log']->info('End: SugarRestJSON->serve');
  90                         return $res;
  91                 } // else
  92         } // fn
  93
  94         /**
  95          * This function sends response to client containing error object
  96          *
  97          * @param SoapError $errorObject - This is an object of type SoapError
  98          * @access public
  99          */
 100         function fault($errorObject){
 101                 $this->faultServer->faultObject = $errorObject;
 102         } // fn
 103
 104         function generateFaultResponse($errorObject){
 105                 $error = $errorObject->number . ': ' . $errorObject->name . '<br>' . $errorObject->description;
 106                 $GLOBALS['log']->error($error);
 107                 $json = getJSONObj();
 108                 ob_clean();
 109                 // JSONP support
 110                 if ( isset($_GET["jsoncallback"]) ) {
 111                         echo $_GET["jsoncallback"] . "(";
 112                 }
 113                 echo $json->encode($errorObject);
 114                 if ( isset($_GET["jsoncallback"]) ) {
 115                         echo ")";
 116                 }
 117         } // fn
 118
 119
 120 } // class