2 if (! defined ( 'sugarEntry' ) || ! sugarEntry)
3 die ( 'Not A Valid Entry Point' ) ;
4 /*********************************************************************************
5 * SugarCRM Community Edition is a customer relationship management program developed by
6 * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
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.
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
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
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.
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.
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 ********************************************************************************/
40 require_once ('modules/ModuleBuilder/parsers/ModuleBuilderParser.php') ;
42 class ParserLabel extends ModuleBuilderParser
45 function ParserLabel ($moduleName, $packageName = '' )
47 $this->moduleName = $moduleName;
48 if (!empty($packageName))
49 $this->packageName = $packageName ;
53 * Takes in the request params from a save request and processes
55 * @param REQUEST $params Labels as "label_".System label => Display label pairs
56 * @param string $language Language key, for example 'en_us'
58 function handleSave ($params , $language)
61 foreach ( $params as $key => $value )
63 if (preg_match ( '/^label_/', $key ) && strcmp ( $value, 'no_change' ) != 0)
65 $labels [ strtoupper(substr ( $key, 6 )) ] = remove_xss(from_html($value),false);
68 if (!empty($this->packageName)) //we are in Module builder
70 return self::addLabels ( $language, $labels, $this->moduleName, "custom/modulebuilder/packages/{$this->packageName}/modules/{$this->moduleName}/language" ) ;
73 return self::addLabels ( $language, $labels, $this->moduleName ) ;
78 * Remove a label from the language pack for a module
79 * @param string $language Language key, for example 'en_us'
80 * @param string $label The label to remove
81 * @param string $labelvalue The value of the label to remove
82 * @param string $moduleName Name of the module to which to add these labels
83 * @param string $basepath base path of the language file
84 * @param string $forRelationshipLabel whether this is a relationship label
86 static function removeLabel($language, $label, $labelvalue, $moduleName, $basepath = null, $forRelationshipLabel = false) {
87 $GLOBALS [ 'log' ]->debug ( "ParserLabel->removeLabels($language, \$label, \$labelvalue, $moduleName, $basepath );" ) ;
88 if (is_null ( $basepath ))
90 $deployedModule = true ;
91 $basepath = "custom/modules/$moduleName/language" ;
92 if($forRelationshipLabel){
93 $basepath = "custom/modules/$moduleName/Ext/Language" ;
95 if (! is_dir ( $basepath ))
97 $GLOBALS ['log']->debug("$basepath is not a directory.");
102 $filename = "$basepath/$language.lang.php" ;
103 if($forRelationshipLabel){
104 $filename = "$basepath/$language.lang.ext.php" ;
107 $dir_exists = is_dir ( $basepath ) ;
109 $mod_strings = array ( ) ;
113 if (file_exists ($filename))
115 // obtain $mod_strings
116 include ($filename) ;
118 $GLOBALS ['log']->debug("file $filename does not exist.");
122 $GLOBALS ['log']->debug("directory $basepath does not exist.");
128 if (isset($mod_strings[$label]) && $mod_strings[$label]==$labelvalue) {
129 unset($mod_strings[$label]);
135 if (! write_array_to_file ( "mod_strings", $mod_strings, $filename )) {
136 $GLOBALS [ 'log' ]->fatal ( "Could not write $filename" ) ;
138 // if we have a cache to worry about, then clear it now
139 if ($deployedModule) {
140 $GLOBALS ['log']->debug ( "PaserLabel->addLabels: clearing language cache" ) ;
141 $cache_key = "module_language." . $language . $moduleName ;
142 sugar_cache_clear ( $cache_key ) ;
143 LanguageManager::clearLanguageCache ( $moduleName, $language ) ;
152 * Add a set of labels to the language pack for a module, deployed or undeployed
153 * @param string $language Language key, for example 'en_us'
154 * @param array $labels The labels to add in the form of an array of System label => Display label pairs
155 * @param string $moduleName Name of the module to which to add these labels
156 * @param string $packageName If module is undeployed, name of the package to which it belongs
158 static function addLabels ($language , $labels , $moduleName , $basepath = null, $forRelationshipLabel = false)
161 $GLOBALS [ 'log' ]->debug ( "ParserLabel->addLabels($language, \$labels, $moduleName, $basepath );" ) ;
162 $GLOBALS [ 'log' ]->debug ( "\$labels:" . print_r ( $labels, true ) ) ;
164 $deployedModule = false ;
165 if (is_null ( $basepath ))
167 $deployedModule = true ;
168 $basepath = "custom/modules/$moduleName/language" ;
169 if($forRelationshipLabel){
170 $basepath = "custom/modules/$moduleName/Ext/Language" ;
172 if (! is_dir ( $basepath ))
174 mkdir_recursive($basepath);
178 $filename = "$basepath/$language.lang.php" ;
179 if($forRelationshipLabel){
180 $filename = "$basepath/$language.lang.ext.php" ;
182 $dir_exists = is_dir ( $basepath ) ;
184 $mod_strings = array ( ) ;
188 if (file_exists ( $filename ))
190 // obtain $mod_strings
191 include ($filename) ;
192 }else if($forRelationshipLabel){
193 $fh = fopen ($filename, 'a');
203 //$charset = (isset($app_strings['LBL_CHARSET'])) ? $app_strings['LBL_CHARSET'] : $GLOBALS['sugar_config']['default_charset'] ;
205 foreach ( $labels as $key => $value )
207 if (! isset ( $mod_strings [ $key ] ) || strcmp ( $value, $mod_strings [ $key ] ) != 0)
209 $mod_strings [$key] = htmlentities(html_entity_decode_utf8($value, ENT_QUOTES ), ENT_QUOTES ); // must match encoding used in view.labels.php
216 $GLOBALS [ 'log' ]->debug ( "ParserLabel->addLabels: writing new mod_strings to $filename" ) ;
217 $GLOBALS [ 'log' ]->debug ( "ParserLabel->addLabels: mod_strings=".print_r($mod_strings,true) ) ;
218 if (! write_array_to_file ( "mod_strings", $mod_strings, $filename ))
220 $GLOBALS [ 'log' ]->fatal ( "Could not write $filename" ) ;
223 // if we have a cache to worry about, then clear it now
226 SugarCache::cleanOpcodes();
227 $GLOBALS [ 'log' ]->debug ( "PaserLabel->addLabels: clearing language cache" ) ;
228 $cache_key = "module_language." . $language . $moduleName ;
229 sugar_cache_clear ( $cache_key ) ;
230 LanguageManager::clearLanguageCache ( $moduleName, $language ) ;
239 * Takes in the request params from a save request and processes
242 * @param string $language Language key, for example 'en_us'
244 function handleSaveRelationshipLabels ($metadata , $language)
246 foreach ( $metadata as $definition )
249 $labels[$definition [ 'system_label' ]] = $definition [ 'display_label' ];
250 self::addLabels ( $language, $labels, $definition [ 'module' ],null,true );
254 function addLabelsToAllLanguages($labels)
256 $langs = get_languages();
257 foreach($langs as $lang_key => $lang_display)
259 $this->addLabels($lang_key, $labels, $this->moduleName);