vr-shopxo-source/app/service/ConfigService.php

<?php
// +----------------------------------------------------------------------
// | ShopXO 国内领先企业级B2C免费开源电商系统
// +----------------------------------------------------------------------
// | Copyright (c) 2011~2099 http://shopxo.net All rights reserved.
// +----------------------------------------------------------------------
// | Licensed ( https://opensource.org/licenses/mit-license.php )
// +----------------------------------------------------------------------
// | Author: Devil
// +----------------------------------------------------------------------
namespace app\service;

use think\facade\Db;
use app\service\SystemService;
use app\service\ResourcesService;

/**
 * 配置服务层
 * @author   Devil
 * @blog     http://gong.gg/
 * @version  0.0.1
 * @datetime 2016-12-01T21:51:08+0800
 */
class ConfigService
{
    // 不参与缓存的配置
    public static $not_cache_field_list = [
        'common_agreement_userregister',
        'common_agreement_userprivacy',
        'common_agreement_userlogout',
    ];

    // 富文本,不实例化的字段
    public static $rich_text_list = [
        'common_agreement_userregister',
        'common_agreement_userprivacy',
        'common_agreement_userlogout',
        'common_email_currency_template',
        'home_footer_info',
        'home_email_user_reg_template',
        'home_email_user_forget_pwd_template',
        'home_email_user_email_binding_template',
        'home_site_close_reason',
        'common_site_type',
        'common_self_extraction_address',
        'home_index_floor_top_right_keywords',
        'home_index_floor_manual_mode_goods',
        'home_index_floor_left_top_category',
        'admin_email_login_template',
        'home_email_login_template',
        'home_site_security_record_url',
        'home_site_company_license',
        'common_default_payment',
        'common_domain_multilingual_bind_list',
        'common_multilingual_choose_list',
        'common_regex_mobile',
        'common_regex_tel',
        'common_regex_id_card',
        'common_app_customer_service_custom',
        'common_app_home_data_diy_mode',
    ];

    // 附件字段列表
    public static $attachment_field_list = [
        'admin_logo',
        'admin_login_logo',
        'admin_login_ad_images',
        'home_site_logo',
        'home_site_logo_wap',
        'home_site_logo_app',
        'home_site_logo_square',
        'home_site_title_icon',
        'common_customer_store_qrcode',
        'home_site_user_register_bg_images',
        'home_site_user_login_ad1_images',
        'home_site_user_login_ad2_images',
        'home_site_user_login_ad3_images',
        'home_site_user_forgetpwd_ad1_images',
        'home_site_user_forgetpwd_ad2_images',
        'home_site_user_forgetpwd_ad3_images',
    ];

    // 字符串转数组字段列表, 默认使用英文逗号处理 [ , ]
    public static $string_to_array_field_list = [
        'common_images_verify_rules',
        'home_user_login_type',
        'home_user_reg_type',
        'admin_login_type',
        'home_site_app_state',
        'home_search_params_type',
        'common_user_verify_bind_mobile_list',
        'common_user_onekey_bind_mobile_list',
        'common_user_address_platform_import_list',
        'common_app_user_base_popup_pages',
        'common_app_user_base_popup_client',
        'common_token_created_rules',
        'common_buy_datetime_info',
        'common_buy_extraction_contact_info',
    ];

    // json数组字段
    public static $data_json_array_field_list = [
        'common_site_type',
        'common_default_payment',
        'common_domain_multilingual_bind_list',
        'common_multilingual_choose_list',
        'common_app_customer_service_custom',
        'common_app_home_data_diy_mode',
    ];

    // 二维数组附件字段
    public static $data_array_attachment_field_list = [
        'common_multilingual_choose_list' => 'icon'
    ];

    // 需要文件缓存的key
    public static $file_cache_keys = [
        // 伪静态后缀
        'home_seo_url_html_suffix',

        // 前端默认主题
        'common_default_theme',

        // 时区
        'common_timezone',

        // 是否开启缓存
        'common_data_is_use_cache',
        'common_data_is_use_redis_cache',
        'common_cache_data_redis_host',
        'common_cache_data_redis_port',
        'common_cache_data_redis_password',
        'common_cache_data_redis_expire',
        'common_cache_data_redis_prefix',

        // session是否开启redis缓存
        'common_session_is_use_cache',
        'common_cache_session_redis_prefix',

        // 站点域名地址和cdn地址
        'common_domain_host',
        'common_cdn_attachment_host',
        'common_cdn_public_host',

        // h5地址
        'common_app_h5_url',

        // 编辑器配置信息
        'home_max_limit_image',
        'home_max_limit_video',
        'home_max_limit_file',

        // 是否采用https连接商店
        'common_is_https_connect_store',

        // cookie有效域名
        'common_cookie_domain',

        // 多语言可选列表和默认值
        'common_multilingual_choose_list',
        'common_multilingual_admin_default_value',
        'common_multilingual_user_default_value',
    ];

    /**
     * 配置列表，唯一标记作为key
     * @author   Devil
     * @blog    http://gong.gg/
     * @version 1.0.0
     * @date    2018-12-07
     * @desc    description
     * @param   [array]          $params [输入参数]
     */
    public static function ConfigList($params = [])
    {
        $field = isset($params['field']) ? $params['field'] : 'only_tag,name,describe,value,error_tips';
        $data = Db::name('Config')->column($field, 'only_tag');
        if(!empty($data))
        {
            $lang = MyLang('common_config');
            foreach($data as $k=>&$v)
            {
                // 字符串转数组
                foreach(self::$string_to_array_field_list as $fv)
                {
                    if($k == $fv)
                    {
                        $v['value'] = (!isset($v['value']) || $v['value'] == '' || is_array($v['value'])) ? [] : explode(',', $v['value']);
                    }
                }

                // json数据数组
                foreach(self::$data_json_array_field_list as $fv)
                {
                    if($k == $fv)
                    {
                        $v['value'] = empty($v['value']) ? [] : json_decode($v['value'], true);
                    }
                }

                // 数组附件字段
                foreach(self::$data_array_attachment_field_list as $fk=>$fv)
                {
                    if(!empty($data[$fk]) && is_array($data[$fk]) && !empty($data[$fk]['value']) && is_array($data[$fk]['value']))
                    {
                        foreach($data[$fk]['value'] as $fkk=>$fvv)
                        {
                            if(!empty($fvv[$fv]))
                            {
                                $data[$fk]['value'][$fkk][$fv] = ResourcesService::AttachmentPathViewHandle($fvv[$fv]);
                            }
                        }
                    }
                }

                // 多语言定义
                if(!empty($lang) && is_array($lang) && array_key_exists($k, $lang) && is_array($lang[$k]))
                {
                    $temp = $lang[$k];
                    if(array_key_exists('name', $temp))
                    {
                        $v['name'] = $temp['name'];
                    }
                    if(array_key_exists('desc', $temp))
                    {
                        $v['describe'] = $temp['desc'];
                    }
                    if(array_key_exists('tips', $temp))
                    {
                        $v['error_tips'] = $temp['tips'];
                    }
                }
            }
        }
        return $data;
    }

    /**
     * 配置数据保存
     * @author   Devil
     * @blog     http://gong.gg/
     * @version  0.0.1
     * @datetime 2017-01-02T23:08:19+0800
     * @param   [array]          $params [输入参数]
     */
    public static function ConfigSave($params = [])
    {
        // 参数校验
        if(empty($params))
        {
            return DataReturn(MyLang('params_empty_tips'), -1);
        }

        // 当前参数中不存在则移除
        $data_fields = self::$attachment_field_list;
        foreach($data_fields as $key=>$field)
        {
            if(!isset($params[$field]))
            {
                unset($data_fields[$key]);
            }
        }

        // 获取附件
        $attachment = ResourcesService::AttachmentParams($params, $data_fields);
        foreach($attachment['data'] as $k=>$v)
        {
            $params[$k] = $v;
        }

        // 循环保存数据
        $success = 0;

        // 开始更新数据
        foreach($params as $k=>$v)
        {
            // 数据是数组则转为json字符串
            if(is_array($v))
            {
                $v = empty($v) ? '' : json_encode($v, JSON_UNESCAPED_UNICODE);
            } else {
                // 富文本处理
                if(in_array($k, self::$rich_text_list))
                {
                    $v = ResourcesService::ContentStaticReplace($v, 'add');
                } else {
                    $v = htmlentities($v);
                }
            }
            if(Db::name('Config')->where(['only_tag'=>$k])->update(['value'=>$v, 'upd_time'=>time()]) !== false)
            {
                $success++;

                // 单条配置缓存删除
                MyCache($k, null);
                MyCache($k.'_row_data', null);
            }
        }
        if($success > 0)
        {
            // 删除所有配置的缓存数据
            MyCache(SystemService::CacheKey('shopxo.cache_common_my_config_key'), null);

            // 所有配置信息更新
            self::ConfigInit(1);

            // 是否需要更新路由规则
            $ret = self::RouteSeparatorHandle($params);
            if($ret['code'] != 0)
            {
                return $ret;
            }

            // 浏览器图标
            $ret = self::SiteTitleIconHandle($params);
            if($ret['code'] != 0)
            {
                return $ret;
            }

            // 站点默认首页配置
            $ret = self::SiteDefaultIndexHandle($params);
            if($ret['code'] != 0)
            {
                return $ret;
            }

            return DataReturn(MyLang('operate_success').'['.$success.']');
        }
        return DataReturn(MyLang('operate_fail'), -100);
    }

    /**
     * 系统配置信息初始化
     * @author   Devil
     * @blog     http://gong.gg/
     * @version  0.0.1
     * @datetime 2017-01-03T21:36:55+0800
     * @param    [int] $status [是否更新数据,0否,1是]
     */
    public static function ConfigInit($status = 0)
    {
        $key = SystemService::CacheKey('shopxo.cache_common_my_config_key');
        $data = MyCache($key);
        if($data === null || $status == 1 || MyEnv('app_debug') || MyInput('lang') || MyFileConfig('common_data_is_use_cache') != 1)
        {
            static $is_init_config_data = false;
            if($status == 1 || $is_init_config_data === false)
            {
                // 所有配置
                $data = Db::name('Config')->column('value', 'only_tag');
                if(!empty($data))
                {
                    // 数据处理
                    // 字符串转数组
                    foreach(self::$string_to_array_field_list as $fv)
                    {
                        if(isset($data[$fv]))
                        {
                            $data[$fv] = ($data[$fv] == '') ? [] : explode(',', $data[$fv]);
                        }
                    }

                    // json数据数组
                    foreach(self::$data_json_array_field_list as $fv)
                    {
                        if(isset($data[$fv]))
                        {
                            $data[$fv] = empty($data[$fv]) ? [] : json_decode($data[$fv], true);
                        }
                    }

                    // 单附件字段
                    foreach(self::$attachment_field_list as $fv)
                    {
                        if(!empty($data[$fv]))
                        {
                            $data[$fv] = ResourcesService::AttachmentPathViewHandle($data[$fv]);
                        }
                    }

                    // 数组附件字段
                    foreach(self::$data_array_attachment_field_list as $fk=>$fv)
                    {
                        if(!empty($data[$fk]) && is_array($data[$fk]))
                        {
                            foreach($data[$fk] as $fkk=>$fvv)
                            {
                                if(!empty($fvv[$fv]))
                                {
                                    $data[$fk][$fkk][$fv] = ResourcesService::AttachmentPathViewHandle($fvv[$fv]);
                                }
                            }
                        }
                    }

                    // 数据处理
                    foreach($data as $k=>&$v)
                    {
                        // 不参与缓存的配置
                        if(in_array($k, self::$not_cache_field_list))
                        {
                            unset($data[$k]);
                            continue;
                        }

                        // 富文本字段处理
                        if(in_array($k, self::$rich_text_list))
                        {
                            $v = ResourcesService::ContentStaticReplace($v, 'get');
                        }

                        // 数据文件缓存
                        if(in_array($k, self::$file_cache_keys))
                        {
                            MyFileConfig($k, $v);
                        }
                    }
                } else {
                    $data = [];
                }

                // 所有配置缓存集合
                MyCache($key, $data);

                // 已初始化状态
                $is_init_config_data = true;
            }
        }
        return $data;
    }

    /**
     * 站点默认首页配置
     * @author  Devil
     * @blog    http://gong.gg/
     * @version 1.0.0
     * @date    2024-02-03
     * @desc    description
     * @param   [array]           $params [输入参数]
     */
    public static function SiteDefaultIndexHandle($params = [])
    {
        if(array_key_exists('common_site_default_index', $params))
        {
            // 默认首页配置
            $dir = APP_PATH.'index'.DS.'config';
            $home_file = $dir.DS.'home.php';
            // 是否有权限操作文件
            if(file_exists($home_file))
            {
                if(!is_writable($home_file))
                {
                    return DataReturn(MyLang('common_service.config.default_index_config_file_no_power_tips').'['.$home_file.']', -1);
                }
            } else {
                if(!is_writable($dir))
                {
                    return DataReturn(MyLang('common_service.config.default_index_config_dir_no_power_tips').'['.$dir.']', -1);
                }
            }

            // 是否设置默认首页
            if(empty($params['common_site_default_index']))
            {
                if(file_exists($home_file))
                {
                    if(!\base\FileUtil::UnlinkFile($home_file))
                    {
                        return DataReturn(MyLang('common_service.config.default_index_deploy_fail').'['.$home_file.']', -1);
                    }
                }
            } else {
                $arr = explode('|', $params['common_site_default_index']);
                if(count($arr) == 2)
                {
                    // get s参数值
                    $value = '';
                    switch($arr[0])
                    {
                        // 插件
                        case 'plugins' :
                            $value = 'plugins/index/pluginsname/'.$arr[1].'/pluginscontrol/index/pluginsaction/index';
                            break;

                        // 页面设计
                        case 'design' :
                            $value = 'design/index/id/'.$arr[1];
                            break;

                        // 自定义页面
                        case 'custom_view' :
                            $value = 'customview/index/id/'.$arr[1];
                            break;
                    }

                    // 站点默认首页处理值钩子
                    $hook_name = 'plugins_service_config_site_default_index_value';
                    MyEventTrigger($hook_name,
                        [
                            'hook_name'   => $hook_name,
                            'is_backend'  => true,
                            'value'       => &$value,
                        ]);

                    // 空则错误提示
                    if(empty($value))
                    {
                        return DataReturn(MyLang('common_service.config.default_index_type_not_undefined').'['.$arr[0].']', -1);
                    }

                    // 生成域名配置文件
                    $ret = @file_put_contents($home_file, "<?php
// +----------------------------------------------------------------------
// | ShopXO 国内领先企业级B2C免费开源电商系统
// +----------------------------------------------------------------------
// | Copyright (c) 2011~2099 http://shopxo.net All rights reserved.
// +----------------------------------------------------------------------
// | Licensed ( https://opensource.org/licenses/mit-license.php )
// +----------------------------------------------------------------------
// | Author: Devil
// +----------------------------------------------------------------------

// 默认首页配置文件\nreturn '".$value."';\n?>");
                    if($ret === false)
                    {
                        return DataReturn(MyLang('common_service.config.default_index_deploy_fail').'['.$home_file.']', -1);
                    }
                }
            }
        }
        return DataReturn(MyLang('handle_noneed'), 0);
    }

    /**
     * 浏览器图标处理
     * @author   Devil
     * @blog     http://gong.gg/
     * @version  0.0.1
     * @datetime 2017-01-02T23:08:19+0800
     * @param   [array]          $params [输入参数]
     */
    public static function SiteTitleIconHandle($params = [])
    {
        if(!empty($params['home_site_title_icon']))
        {
            $file = RequestGet($params['home_site_title_icon']);
            if(!empty($file))
            {
                $ico_file = ROOT.'public'.DS.'favicon.ico';
                if(!is_writable($ico_file))
                {
                    return DataReturn(MyLang('common_service.config.site_title_icon_power_tips').'['.$ico_file.']', -1);
                }
                if(file_put_contents($ico_file, $file) === false)
                {
                    return DataReturn(MyLang('common_service.config.site_title_icon_fail_tips').'['.$ico_file.']', -1);
                }
                return DataReturn(MyLang('handle_success'), 0);
            }
        }
        return DataReturn(MyLang('handle_noneed'), 0);
    }

    /**
     * 路由规则处理
     * @author   Devil
     * @blog     http://gong.gg/
     * @version  0.0.1
     * @datetime 2017-01-02T23:08:19+0800
     * @param   [array]          $params [输入参数]
     */
    public static function RouteSeparatorHandle($params = [])
    {
        if(array_key_exists('home_seo_url_model', $params))
        {
            // 模块组
            $route_arr = ['admin', 'index', 'api'];

            // 后端+前端都生成对应的路由定义规则、为了后台进入前端url保持一致
            foreach($route_arr as $module)
            {
                // 文件目录
                if(!is_writable(APP_PATH.$module.DS.'route'))
                {
                    return DataReturn(MyLang('common_service.config.route_dir_no_power_tips').'[./app/'.$module.'/route]', -11);
                }

                // 路配置文件权限
                $route_file_php = APP_PATH.$module.DS.'route'.DS.'route.php';
                if(file_exists($route_file_php) && !is_writable($route_file_php))
                {
                    return DataReturn(MyLang('common_service.config.route_file_no_power_tips').'[./app/'.$module.'/route/route.php]', -11);
                }

                // pathinfo+短地址模式
                if($params['home_seo_url_model'] == 2)
                {
                    // 伪静态规则配置文件
                    $route_file = APP_PATH.'route'.DS.'route.config';
                    $module_route_file = APP_PATH.$module.DS.'route'.DS.'route.config';
                    if(file_exists($module_route_file))
                    {
                        $route_file = $module_route_file;
                    }
                    if(!file_exists($route_file))
                    {
                        return DataReturn(MyLang('common_service.config.route_file_config_no_exist_tips').'[./app/route/route.config]', -14);
                    }

                    // 开始生成规则文件
                    if(file_put_contents($route_file_php, file_get_contents($route_file)) === false)
                    {
                        return DataReturn(MyLang('common_service.config.route_file_create_fail_tips'), -10);
                    }

                // 兼容模式+pathinfo模式
                } else {
                    if(file_exists($route_file_php) && @unlink($route_file_php) === false)
                    {
                        return DataReturn(MyLang('common_service.config.route_file_handle_fail_tips'), -10);
                    }
                }
            }
            return DataReturn(MyLang('handle_success'), 0);
        }
        return DataReturn(MyLang('handle_noneed'), 0);
    }

    /**
     * 根据唯一标记获取条配置内容
     * @author   Devil
     * @blog    http://gong.gg/
     * @version 1.0.0
     * @date    2019-05-16
     * @desc    description
     * @param   [string]           $key [唯一标记]
     */
    public static function ConfigContentRow($key)
    {
        $cache_key = $key.'_row_data';
        $data = MyCache($cache_key);
        if($data === null)
        {
            $data = Db::name('Config')->where(['only_tag'=>$key])->field('name,value,type,upd_time')->find();
            if(!empty($data))
            {
                // 富文本处理
                if(in_array($key, self::$rich_text_list))
                {
                    $data['value'] = ResourcesService::ContentStaticReplace($data['value'], 'get');
                }
                $data['upd_time_time'] = empty($data['upd_time']) ? null : date('Y-m-d H:i:s', $data['upd_time']);
            } else {
                $data = [];
            }
            MyCache($cache_key, $data);
        }
        return DataReturn(MyLang('operate_success'), 0, $data);
    }

    /**
     * 站点自提模式 - 自提地址列表
     * @author  Devil
     * @blog    http://gong.gg/
     * @version 1.0.0
     * @date    2019-11-13
     * @desc    description
     * @param   [string]          $value  [自提的配置数据]
     * @param   [array]           $params [输入参数]
     */
    public static function SiteTypeExtractionAddressList($value = null, $params = [])
    {
        // 未指定内容则从缓存读取
        if(empty($value))
        {
            $value = MyC('common_self_extraction_address');
        }

        // 数据处理
        $data = [];
        if(!empty($value) && is_string($value))
        {
            $temp_data = json_decode($value, true);
            if(!empty($temp_data) && is_array($temp_data))
            {
                $data = $temp_data;
            }
        }
        if(!empty($data))
        {
            foreach($data as &$v)
            {
                if(array_key_exists('logo', $v))
                {
                    $v['logo'] = ResourcesService::AttachmentPathViewHandle($v['logo']);
                }
            }
        }

        // 自提点地址列表数据钩子
        $hook_name = 'plugins_service_site_extraction_address_list';
        MyEventTrigger($hook_name, [
            'hook_name'     => $hook_name,
            'is_backend'    => true,
            'data'          => &$data,
        ]);

        // 数据距离处理
        if(!empty($data) && is_array($data) && !empty($params))
        {
            $lng = empty($params['lng']) ? (empty($params['user_lng']) ? '' : $params['user_lng']) : $params['lng'];
            $lat = empty($params['lat']) ? (empty($params['user_lat']) ? '' : $params['user_lat']) : $params['lat'];
            if(!empty($lng) && !empty($lat))
            {
                $unit = 'km';
                foreach($data as &$v)
                {
                    if(!empty($v) && is_array($v))
                    {
                        // 计算距离
                        $v['distance_value'] = \base\GeoTransUtil::GetDistance($v['lng'], $v['lat'], $lng, $lat, 2);
                        $v['distance_unit'] = $unit;
                    }
                }

                // 根据距离排序
                if(count($data) > 1 && array_sum(array_column($data, 'distance_value')) > 0)
                {
                    $data = ArrayQuickSort($data, 'distance_value');
                }
            }
        }
        return DataReturn(MyLang('operate_success'), 0, $data);
    }

    /**
     * 站点虚拟模式 - 虚拟销售信息
     * @author  Devil
     * @blog    http://gong.gg/
     * @version 1.0.0
     * @date    2019-11-19
     * @desc    description
     * @param   [array]          $params [输入参数]
     */
    public static function SiteFictitiousConfig($params = [])
    {
        // 标题
        $title = MyC('common_site_fictitious_return_title', '密钥信息', true);

        // 提示信息
        $tips =  MyC('common_site_fictitious_return_tips', null, true);

        // 返回数据
        $result = [
            'title'  => $title,
            'tips'   => empty($tips) ? '' : str_replace("\n", '<br />', $tips),
        ];
        return DataReturn(MyLang('operate_success'), 0, $result);
    }

    /**
     * 字段空值数据处理
     * @author  Devil
     * @blog    http://gong.gg/
     * @version 1.0.0
     * @date    2022-04-10
     * @desc    description
     * @param   [array]          $params [输入参数]
     * @param   [array]          $fields [字段列表]
     * @return  [array]                  [处理的数据]
     */
    public static function FieldsEmptyDataHandle($params, $fields)
    {
        if(!empty($fields))
        {
            foreach($fields as $fv)
            {
                if(!isset($params[$fv]))
                {
                    $params[$fv] = '';
                }
            }
        }
        return $params;
    }

    /**
     * 短信模板配置
     * @author  Devil
     * @blog    http://gong.gg/
     * @version 1.0.0
     * @date    2023-11-18
     * @desc    description
     * @param   [string]          $key [模板key]
     */
    public static function SmsTemplateValue($key)
    {
        // 读取短信配置信息
        $value = MyC($key);

        // 短信配置读取钩子
        $hook_name = 'plugins_service_config_sms_template_value';
        MyEventTrigger($hook_name,
        [
            'hook_name'   => $hook_name,
            'is_backend'  => true,
            'key'         => $key,
            'value'       => &$value,
        ]);

        return $value;
    }
}
?>