include/JSON.php

   1 <?php
   2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
   3
   4 /*********************************************************************************
   5  * SugarCRM is a customer relationship management program developed by
   6  * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
   7  *
   8  * This program is free software; you can redistribute it and/or modify it under
   9  * the terms of the GNU Affero General Public License version 3 as published by the
  10  * Free Software Foundation with the addition of the following permission added
  11  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  12  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  13  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  14  *
  15  * This program is distributed in the hope that it will be useful, but WITHOUT
  16  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  17  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  18  * details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License along with
  21  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  22  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  23  * 02110-1301 USA.
  24  *
  25  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  26  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  27  *
  28  * The interactive user interfaces in modified source and object code versions
  29  * of this program must display Appropriate Legal Notices, as required under
  30  * Section 5 of the GNU Affero General Public License version 3.
  31  *
  32  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  33  * these Appropriate Legal Notices must retain the display of the "Powered by
  34  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  35  * technical reasons, the Appropriate Legal Notices must display the words
  36  * "Powered by SugarCRM".
  37  ********************************************************************************/
  38
  39 /*********************************************************************************
  40
  41  * Description:  Includes generic helper functions used throughout the application.
  42  * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  43  * All Rights Reserved.
  44  * Contributor(s): ______________________________________..
  45  ********************************************************************************/
  46
  47 class JSON
  48 {
  49     /**
  50      * JSON encode a string
  51      *
  52      * @param string $string
  53      * @param bool $addSecurityEnvelope defaults to false
  54      * @return string
  55      */
  56     public static function encode($string, $addSecurityEnvelope = false)
  57     {
  58         $encodedString = json_encode($string);
  59
  60         if($addSecurityEnvelope) {
  61             $encodedString = "while(1);/*" . $encodedString . "*/";
  62         }
  63
  64         return $encodedString;
  65     }
  66
  67     /**
  68      * JSON decode a string
  69      *
  70      * @param string $string
  71      * @param bool $examineEnvelope Default false, true to extract and verify envelope
  72      * @return string
  73      */
  74     public static function decode($string, $examineEnvelope=false)
  75     {
  76         if ($examineEnvelope) {
  77             $meta = json_decode($string,true);
  78             if($meta['asychronous_key'] != $_SESSION['asychronous_key']) {
  79                 $GLOBALS['log']->fatal("*** SECURITY: received asynchronous call with invalid ['asychronous_key'] value. Possible CSRF attack.");
  80                 return '';
  81             }
  82
  83             return $meta['jsonObject'];
  84         }
  85
  86         return json_decode($string,true);
  87     }
  88
  89     /**
  90      * @deprecated use JSON::encode() instead
  91      */
  92     public static function encodeReal($string)
  93     {
  94         return self::encode($string);
  95     }
  96
  97     /**
  98      * @deprecated use JSON::decode() instead
  99      */
 100     public static function decodeReal($string)
 101     {
 102         return self::decode($string);
 103     }
 104 }