include/JSON.php

   1 <?php
   2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
   3
   4 /*********************************************************************************
   5  * SugarCRM Community Edition 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     /**
  51      * JSON encode a string
  52      *
  53      * @param string $string
  54      * @param bool $addSecurityEnvelope defaults to false
  55      * @return string
  56      */
  57     public static function encode($string, $addSecurityEnvelope = false, $encodeSpecial = false)
  58     {
  59         $encodedString = json_encode($string);
  60
  61         if($addSecurityEnvelope) {
  62             $encodedString = "while(1);/*" . $encodedString . "*/";
  63         }
  64
  65
  66         if ($encodeSpecial)
  67         {
  68             $charMap = array('<' => '\u003C', '>' => '\u003E', "'" => '\u0027', '&' => '\u0026');
  69             foreach($charMap as $c => $enc)
  70             {
  71                 $encodedString = str_replace($c, $enc, $encodedString);
  72             }
  73         }
  74
  75         return $encodedString;
  76     }
  77
  78     /**
  79      * JSON decode a string
  80      *
  81      * @param string $string
  82      * @param bool $examineEnvelope Default false, true to extract and verify envelope
  83      * @return string
  84      */
  85     public static function decode($string, $examineEnvelope=false, $assoc = true)
  86     {
  87         if ($examineEnvelope) {
  88             $meta = json_decode($string,true);
  89             if($meta['asychronous_key'] != $_SESSION['asychronous_key']) {
  90                 $GLOBALS['log']->fatal("*** SECURITY: received asynchronous call with invalid ['asychronous_key'] value. Possible CSRF attack.");
  91                 return '';
  92             }
  93
  94             return $meta['jsonObject'];
  95         }
  96
  97         return json_decode($string,$assoc);
  98     }
  99
 100     /**
 101      * @deprecated use JSON::encode() instead
 102      */
 103     public static function encodeReal($string)
 104     {
 105         return self::encode($string);
 106     }
 107
 108     /**
 109      * @deprecated use JSON::decode() instead
 110      */
 111     public static function decodeReal($string)
 112     {
 113         return self::decode($string);
 114     }
 115 }