291 lines
10 KiB
PHP
Executable File
291 lines
10 KiB
PHP
Executable File
<?php
|
|
if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
|
|
/*********************************************************************************
|
|
* SugarCRM is a customer relationship management program developed by
|
|
* SugarCRM, Inc. Copyright (C) 2004-2010 SugarCRM Inc.
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify it under
|
|
* the terms of the GNU Affero General Public License version 3 as published by the
|
|
* Free Software Foundation with the addition of the following permission added
|
|
* to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
|
|
* IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
|
|
* OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
|
|
*
|
|
* This program is distributed in the hope that it will be useful, but WITHOUT
|
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
* FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
|
|
* details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License along with
|
|
* this program; if not, see http://www.gnu.org/licenses or write to the Free
|
|
* Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
|
* 02110-1301 USA.
|
|
*
|
|
* You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
|
|
* SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
|
|
*
|
|
* The interactive user interfaces in modified source and object code versions
|
|
* of this program must display Appropriate Legal Notices, as required under
|
|
* Section 5 of the GNU Affero General Public License version 3.
|
|
*
|
|
* In accordance with Section 7(b) of the GNU Affero General Public License version 3,
|
|
* these Appropriate Legal Notices must retain the display of the "Powered by
|
|
* SugarCRM" logo. If the display of the logo is not reasonably feasible for
|
|
* technical reasons, the Appropriate Legal Notices must display the words
|
|
* "Powered by SugarCRM".
|
|
********************************************************************************/
|
|
|
|
/**
|
|
* sugar_mkdir
|
|
* Call this function instead of mkdir to apply preconfigured permission
|
|
* settings when creating the directory. This method is basically
|
|
* a wrapper to the PHP mkdir function except that it supports setting
|
|
* the mode value by using the configuration file (if set). The mode is
|
|
* 0777 by default.
|
|
*
|
|
* @param $pathname - String value of the directory to create
|
|
* @param $mode - The integer value of the permissions mode to set the created directory to
|
|
* @param $recursive - boolean value indicating whether or not to create recursive directories if needed
|
|
* @param $context
|
|
* @return boolean - Returns true on success false on failure
|
|
*/
|
|
function sugar_mkdir($pathname, $mode=null, $recursive=false, $context='') {
|
|
$mode = get_mode('dir_mode', $mode);
|
|
|
|
if ( sugar_is_dir($pathname,$mode) )
|
|
return true;
|
|
|
|
$result = false;
|
|
if(empty($mode))
|
|
$mode = 0777;
|
|
if(empty($context)) {
|
|
$result = mkdir($pathname, $mode, $recursive);
|
|
} else {
|
|
$result = mkdir($pathname, $mode, $recursive, $context);
|
|
}
|
|
|
|
if($result){
|
|
if(!sugar_chmod($pathname, $mode)){
|
|
return false;
|
|
}
|
|
if(!empty($GLOBALS['sugar_config']['default_permissions']['user'])){
|
|
if(!sugar_chown($pathname)){
|
|
return false;
|
|
}
|
|
}
|
|
if(!empty($GLOBALS['sugar_config']['default_permissions']['group'])){
|
|
if(!sugar_chgrp($pathname)) {
|
|
return false;
|
|
}
|
|
}
|
|
}
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* sugar_fopen
|
|
* Call this function instead of fopen to apply preconfigured permission
|
|
* settings when creating the the file. This method is basically
|
|
* a wrapper to the PHP fopen function except that it supports setting
|
|
* the mode value by using the configuration file (if set). The mode is
|
|
* 0777 by default.
|
|
*
|
|
* @param $filename - String value of the file to create
|
|
* @param $mode - The integer value of the permissions mode to set the created file to
|
|
* @param $$use_include_path - boolean value indicating whether or not to search the the included_path
|
|
* @param $context
|
|
* @return boolean - Returns a file pointer on success, false otherwise
|
|
*/
|
|
function sugar_fopen($filename, $mode, $use_include_path=false, $context=null){
|
|
//check to see if the file exists, if not then use touch to create it.
|
|
if(!file_exists($filename)){
|
|
sugar_touch($filename);
|
|
}
|
|
|
|
if(empty($context)) {
|
|
return fopen($filename, $mode, $use_include_path);
|
|
} else {
|
|
return fopen($filename, $mode, $use_include_path, $context);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* sugar_file_put_contents
|
|
* Call this function instead of file_put_contents to apply preconfigured permission
|
|
* settings when creating the the file. This method is basically
|
|
* a wrapper to the PHP file_put_contents function except that it supports setting
|
|
* the mode value by using the configuration file (if set). The mode is
|
|
* 0777 by default.
|
|
*
|
|
* @param $filename - String value of the file to create
|
|
* @param $data - The data to be written to the file
|
|
* @param $flags - int as specifed by file_put_contents parameters
|
|
* @param $context
|
|
* @return int - Returns the number of bytes written to the file, false otherwise.
|
|
*/
|
|
function sugar_file_put_contents($filename, $data, $flags=null, $context=null){
|
|
//check to see if the file exists, if not then use touch to create it.
|
|
if(!file_exists($filename)){
|
|
sugar_touch($filename);
|
|
}
|
|
|
|
if(empty($flags)) {
|
|
return file_put_contents($filename, $data);
|
|
} elseif(empty($context)) {
|
|
return file_put_contents($filename, $data, $flags);
|
|
} else{
|
|
return file_put_contents($filename, $data, $flags, $context);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* sugar_touch
|
|
* Attempts to set the access and modification times of the file named in the filename
|
|
* parameter to the value given in time . Note that the access time is always modified,
|
|
* regardless of the number of parameters. If the file does not exist it will be created.
|
|
* This method is basically a wrapper to the PHP touch method except that created files
|
|
* may be set with the permissions specified in the configuration file (if set).
|
|
*
|
|
* @param $filename - The name of the file being touched.
|
|
* @param $time - The touch time. If time is not supplied, the current system time is used.
|
|
* @param $atime - If present, the access time of the given filename is set to the value of atime
|
|
* @return boolean - Returns TRUE on success or FALSE on failure.
|
|
*
|
|
*/
|
|
function sugar_touch($filename, $time=null, $atime=null) {
|
|
|
|
$result = false;
|
|
|
|
if(!empty($atime) && !empty($time)) {
|
|
$result = touch($filename, $time, $atime);
|
|
} else if(!empty($time)) {
|
|
$result = touch($filename, $time);
|
|
} else {
|
|
$result = touch($filename);
|
|
}
|
|
|
|
if(!$result) return $result;
|
|
|
|
if(!empty($GLOBALS['sugar_config']['default_permissions']['file_mode'])){
|
|
sugar_chmod($filename, $GLOBALS['sugar_config']['default_permissions']['file_mode']);
|
|
}
|
|
if(!empty($GLOBALS['sugar_config']['default_permissions']['user'])){
|
|
sugar_chown($filename);
|
|
}
|
|
if(!empty($GLOBALS['sugar_config']['default_permissions']['group'])){
|
|
sugar_chgrp($filename);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* sugar_chmod
|
|
* Attempts to change the permission of the specified filename to the mode value specified in the
|
|
* default_permissions configuration; otherwise, it will use the mode value.
|
|
*
|
|
* @param string filename - Path to the file
|
|
* @param int $mode The integer value of the permissions mode to set the created directory to
|
|
* @return boolean Returns TRUE on success or FALSE on failure.
|
|
*/
|
|
function sugar_chmod($filename, $mode=null) {
|
|
if ( !is_int($mode) )
|
|
$mode = (int) $mode;
|
|
if(!is_windows()){
|
|
if(!isset($mode)){
|
|
$mode = get_mode('file_mode', $mode);
|
|
}
|
|
if(isset($mode) && $mode > 0){
|
|
return @chmod($filename, $mode);
|
|
}else{
|
|
return false;
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* sugar_chown
|
|
* Attempts to change the owner of the file filename to the user specified in the
|
|
* default_permissions configuration; otherwise, it will use the user value.
|
|
*
|
|
* @param filename - Path to the file
|
|
* @param user - A user name or number
|
|
* @return boolean - Returns TRUE on success or FALSE on failure.
|
|
*/
|
|
function sugar_chown($filename, $user='') {
|
|
if(!is_windows()){
|
|
if(strlen($user)){
|
|
return chown($filename, $user);
|
|
}else{
|
|
if(strlen($GLOBALS['sugar_config']['default_permissions']['user'])){
|
|
$user = $GLOBALS['sugar_config']['default_permissions']['user'];
|
|
return chown($filename, $user);
|
|
}else{
|
|
return false;
|
|
}
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* sugar_chgrp
|
|
* Attempts to change the group of the file filename to the group specified in the
|
|
* default_permissions configuration; otherwise it will use the group value.
|
|
*
|
|
* @param filename - Path to the file
|
|
* @param group - A group name or number
|
|
* @return boolean - Returns TRUE on success or FALSE on failure.
|
|
*/
|
|
function sugar_chgrp($filename, $group='') {
|
|
if(!is_windows()){
|
|
if(!empty($group)){
|
|
return chgrp($filename, $group);
|
|
}else{
|
|
if(!empty($GLOBALS['sugar_config']['default_permissions']['group'])){
|
|
$group = $GLOBALS['sugar_config']['default_permissions']['group'];
|
|
return chgrp($filename, $group);
|
|
}else{
|
|
return false;
|
|
}
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* get_mode
|
|
*
|
|
* Will check to see if there is a default mode defined in the config file, otherwise return the
|
|
* $mode given as input
|
|
*
|
|
* @param int $mode - the mode being passed by the calling function. This value will be overridden by a value
|
|
* defined in the config file.
|
|
* @return int - the mode either found in the config file or passed in via the input parameter
|
|
*/
|
|
function get_mode($key = 'dir_mode', $mode=null) {
|
|
if ( !is_int($mode) )
|
|
$mode = (int) $mode;
|
|
if(!class_exists('SugarConfig', true)) {
|
|
require 'include/SugarObjects/SugarConfig.php';
|
|
}
|
|
if(!is_windows()){
|
|
$conf_inst=SugarConfig::getInstance();
|
|
$mode = $conf_inst->get('default_permissions.'.$key, $mode);
|
|
}
|
|
return $mode;
|
|
}
|
|
|
|
function sugar_is_dir($path, $mode='r'){
|
|
if(defined('TEMPLATE_URL'))return is_dir($path, $mode);
|
|
return is_dir($path);
|
|
}
|
|
|
|
function sugar_is_file($path, $mode='r'){
|
|
if(defined('TEMPLATE_URL'))return is_file($path, $mode);
|
|
return is_file($path);
|
|
}
|
|
|
|
?>
|