include/SugarTinyMCE.php

   1 <?php
   2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
   3 /*********************************************************************************
   4  * SugarCRM Community Edition is a customer relationship management program developed by
   5  * SugarCRM, Inc. Copyright (C) 2004-2012 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
  40  * Description:
  41  * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc. All Rights
  42  * Reserved. Contributor(s): ______________________________________..
  43  *********************************************************************************/
  44
  45
  46 /**
  47  * PHP wrapper class for Javascript driven TinyMCE WYSIWYG HTML editor
  48  */
  49 class SugarTinyMCE {
  50         var $jsroot = "include/javascript/tiny_mce/";
  51         var $customConfigFile = 'custom/include/tinyButtonConfig.php';
  52         var $customDefaultConfigFile = 'custom/include/tinyMCEDefaultConfig.php';
  53         var $buttonConfigs = array(
  54                         'default' => array(
  55                                                 'buttonConfig' => "code,help,separator,bold,italic,underline,strikethrough,separator,justifyleft,justifycenter,justifyright,
  56                                                                 justifyfull,separator,forecolor,backcolor,separator,styleselect,formatselect,fontselect,fontsizeselect,",
  57                             'buttonConfig2' => "cut,copy,paste,pastetext,pasteword,selectall,separator,search,replace,separator,bullist,numlist,separator,outdent,
  58                                                                 indent,separator,ltr,rtl,separator,undo,redo,separator, link,unlink,anchor,image,separator,sub,sup,separator,charmap,
  59                                                                 visualaid",
  60                             'buttonConfig3' => "tablecontrols,separator,advhr,hr,removeformat,separator,insertdate,inserttime,separator,preview"),
  61                 'email_compose' => array(
  62                                                 'buttonConfig' => "code,help,separator,bold,italic,underline,strikethrough,separator,bullist,numlist,separator,justifyleft,justifycenter,justifyright,
  63                                                                 justifyfull,separator,forecolor,backcolor,separator,styleselect,formatselect,fontselect,fontsizeselect,",
  64                             'buttonConfig2' => "",
  65                             'buttonConfig3' => ""),
  66                 'email_compose_light' => array(
  67                                                 'buttonConfig' => "code,help,separator,bold,italic,underline,strikethrough,separator,bullist,numlist,separator,justifyleft,justifycenter,justifyright,
  68                                                                 justifyfull,separator,forecolor,backcolor,separator,styleselect,formatselect,fontselect,fontsizeselect,",
  69                             'buttonConfig2' => "",
  70                             'buttonConfig3' => ""),
  71         );
  72
  73         var $pluginsConfig = array(
  74             'email_compose_light' => 'insertdatetime,paste,directionality,safari',
  75         'email_compose' => 'advhr,insertdatetime,table,preview,paste,searchreplace,directionality,fullpage',
  76         );
  77
  78         var $defaultConfig = array(
  79             'convert_urls' => false,
  80             'height' => 300,
  81                 'width' => '100%',
  82                 'theme' => 'advanced',
  83                 'theme_advanced_toolbar_align' => "left",
  84                 'theme_advanced_toolbar_location'       => "top",
  85                 'theme_advanced_buttons1'       => "",
  86                 'theme_advanced_buttons2'       => "",
  87                 'theme_advanced_buttons3'       => "",
  88                 'strict_loading_mode'   => true,
  89                 'mode'  => 'exact',
  90                 'language' => 'en',
  91             'plugins' => 'advhr,insertdatetime,table,preview,paste,searchreplace,directionality',
  92                 'elements'      => '',
  93         'extended_valid_elements' => 'style,hr[class|width|size|noshade],@[class|style]',
  94         'content_css' => 'include/javascript/tiny_mce/themes/advanced/skins/default/content.css',
  95
  96         );
  97
  98
  99         /**
 100          * Sole constructor
 101          */
 102         function SugarTinyMCE() {
 103
 104                 $this->overloadButtonConfigs();
 105                 $this->overloadDefaultConfigs();
 106         }
 107
 108         /**
 109          * Returns the Javascript necessary to initialize a TinyMCE instance for a given <textarea> or <div>
 110          * @param string target Comma delimited list of DOM ID's, <textarea id='someTarget'>
 111          * @return string
 112          */
 113         function getInstance($targets = "") {
 114                 global $json;
 115
 116                 if(empty($json)) {
 117                         $json = getJSONobj();
 118                 }
 119
 120                 $config = $this->defaultConfig;
 121                 //include tinymce lang file
 122         $lang = substr($GLOBALS['current_language'], 0, 2);
 123         if(file_exists('include/javascript/tiny_mce/langs/'.$lang.'.js'))
 124         {
 125                         $config['language'] = $lang;
 126         }
 127                 $config['directionality'] = SugarThemeRegistry::current()->directionality;
 128                 $config['elements'] = $targets;
 129                 $config['theme_advanced_buttons1'] = $this->buttonConfigs['default']['buttonConfig'];
 130                 $config['theme_advanced_buttons2'] = $this->buttonConfigs['default']['buttonConfig2'];
 131                 $config['theme_advanced_buttons3'] = $this->buttonConfigs['default']['buttonConfig3'];
 132
 133                 $jsConfig = $json->encode($config);
 134
 135                 $instantiateCall = '';
 136                 if (!empty($targets)) {
 137                         $exTargets = explode(",", $targets);
 138                         foreach($exTargets as $instance) {
 139                                 //$instantiateCall .= "tinyMCE.execCommand('mceAddControl', false, document.getElementById('{$instance}'));\n";
 140                         }
 141                 }
 142                 $path = getJSPath('include/javascript/tiny_mce/tiny_mce.js');
 143                 $ret =<<<eoq
 144 <script type="text/javascript" language="Javascript" src="$path"></script>
 145
 146 <script type="text/javascript" language="Javascript">
 147 <!--
 148 if (!SUGAR.util.isTouchScreen()) {
 149     tinyMCE.init({$jsConfig});
 150         {$instantiateCall}
 151 }
 152 else {
 153 eoq;
 154 $exTargets = explode(",", $targets);
 155 foreach($exTargets as $instance) {
 156 $ret .=<<<eoq
 157     document.getElementById('$instance').style.width = '100%';
 158     document.getElementById('$instance').style.height = '100px';
 159 eoq;
 160 }
 161 $ret .=<<<eoq
 162 }
 163 -->
 164 </script>
 165
 166 eoq;
 167                 return $ret;
 168         }
 169
 170     function getConfig($type = 'default') {
 171         global $json;
 172
 173         if(empty($json)) {
 174             $json = getJSONobj();
 175         }
 176
 177         $config = $this->defaultConfig;
 178         //include tinymce lang file
 179         $lang = substr($GLOBALS['current_language'], 0, 2);
 180         if(file_exists('include/javascript/tiny_mce/langs/'.$lang.'.js'))
 181                         $config['language'] = $lang;
 182                 $config['theme_advanced_buttons1'] = $this->buttonConfigs[$type]['buttonConfig'];
 183         $config['theme_advanced_buttons2'] = $this->buttonConfigs[$type]['buttonConfig2'];
 184         $config['theme_advanced_buttons3'] = $this->buttonConfigs[$type]['buttonConfig3'];
 185
 186         if(isset($this->pluginsConfig[$type]))
 187             $config['plugins'] = $this->pluginsConfig[$type];
 188
 189         $jsConfig = $json->encode($config);
 190         return "var tinyConfig = ".$jsConfig.";";
 191
 192     }
 193
 194     /**
 195      * This function takes in html code that has been produced (and somewhat mauled) by TinyMCE
 196      * and returns a cleaned copy of it.
 197      *
 198      * @param $html
 199      * @return $html with all the tinyMCE specific html removed
 200      */
 201     function cleanEncodedMCEHtml($html) {
 202         $html = str_replace("mce:script", "script", $html);
 203         $html = str_replace("mce_src=", "src=", $html);
 204         $html = str_replace("mce_href=", "href=", $html);
 205         return $html;
 206     }
 207
 208     /**
 209      * Reload the default button configs by allowing admins to specify
 210      * which tinyMCE buttons will be displayed in a seperate config file.
 211      *
 212      */
 213     private function overloadButtonConfigs()
 214     {
 215         if( file_exists( $this->customConfigFile ) )
 216         {
 217             require_once($this->customConfigFile);
 218
 219             if(!isset($buttonConfigs))
 220                 return;
 221
 222             foreach ($buttonConfigs as $k => $v)
 223             {
 224                 if( isset($this->buttonConfigs[$k]) )
 225                     $this->buttonConfigs[$k] = $v;
 226             }
 227         }
 228     }
 229
 230     /**
 231      * Reload the default tinyMCE config, preserving our default extended
 232      * allowable tag set.
 233      *
 234      */
 235     private function overloadDefaultConfigs()
 236     {
 237         if( file_exists( $this->customDefaultConfigFile ) )
 238         {
 239             require_once($this->customDefaultConfigFile);
 240
 241             if(!isset($defaultConfig))
 242                 return;
 243
 244             foreach ($defaultConfig as $k => $v)
 245             {
 246                 if( isset($this->defaultConfig[$k]) ){
 247
 248                         if($k == "extended_valid_elements"){
 249                                 $this->defaultConfig[$k] .= "," . $v;
 250                         }
 251                         else{
 252                                 $this->defaultConfig[$k] = $v;
 253                         }
 254                 }
 255             }
 256         }
 257     }
 258
 259 } // end class def