cms-manage/app/Plugin.php

<?php


namespace app;

use app\model\AdminMenu;
use think\facade\Cache;
use think\facade\Db;
use think\View;

/**
 * 插件类
 */
abstract class Plugin
{
    /**
     * 视图实例对象
     * @var view
     * @access protected
     */
    private $view = null;

    public static $vendorLoaded = [];

    /**
     * $info = array(
     *  'name'=>'HelloWorld',
     *  'title'=>'HelloWorld',
     *  'description'=>'HelloWorld',
     *  'status'=>1,
     *  'author'=>'ThinkCMF',
     *  'version'=>'1.0'
     *  )
     */
    public $info = [];
    private $pluginPath = '';
    private $name = '';
    private $configFilePath = '';
    private $themeRoot = "";

    /**
     * Plugin constructor.
     */
    public function __construct()
    {

        $this->name = $this->getName();

        $nameCStyle = parse_name($this->name);

        $this->pluginPath     = CMS_ROOT . 'plugins/' . $nameCStyle . '/';
        $this->configFilePath = $this->pluginPath . 'config.php';

        if (empty(self::$vendorLoaded[$this->name])) {
            $pluginVendorAutoLoadFile = $this->pluginPath . 'vendor/autoload.php';
            if (file_exists($pluginVendorAutoLoadFile)) {
                require_once $pluginVendorAutoLoadFile;
            }

            self::$vendorLoaded[$this->name] = true;
        }

        $config = $this->getConfig();

        $theme = isset($config['theme']) ? $config['theme'] : '';

        //$depr = "/";

        $root = hcGetRoot();

        $themeDir = empty($theme) ? "" : '/' . $theme;

        $themePath = 'view' . $themeDir;

        $this->themeRoot = $this->pluginPath . $themePath . '/';

        $pluginRoot = "plugins/{$nameCStyle}";

        $cmfAdminThemePath    = config('template.cmf_admin_theme_path');
        $cmfAdminDefaultTheme = config('template.cmf_admin_default_theme');

        $adminThemePath = "{$cmfAdminThemePath}{$cmfAdminDefaultTheme}";

        $replaceConfig = [
            '__ROOT__'        => $root,
            '__PLUGIN_TMPL__' => $root . '/' . $pluginRoot . '/' . $themePath,
            '__PLUGIN_ROOT__' => $root . '/' . $pluginRoot,
            '__ADMIN_TMPL__'  => "{$root}/{$adminThemePath}",
            '__STATIC__'      => "{$root}/static",
            '__WEB_ROOT__'    => $root
        ];

        $app  = app();
        $view = new View($app);

        $this->view = $view;

        $this->view->engine()->config([
            'view_base'          => $this->themeRoot,
            'tpl_replace_string' => $replaceConfig
        ]);

        //加载多语言
        $langSet   = $app->lang->getLangSet();
        $lang_file = $this->pluginPath . "lang/" . $langSet . ".php";
        $app->lang->load($lang_file);

    }

    /**
     * 加载模板输出
     * @access protected
     * @param string $template 模板文件名
     * @return string
     * @throws \Exception
     */
    final protected function fetch($template)
    {
        if (!is_file($template)) {
            $engineConfig = config('view');
            $template     = $this->themeRoot . $template . '.' . $engineConfig['view_suffix'];
        }

        // 模板不存在 抛出异常
        if (!is_file($template)) {
            throw new TemplateNotFoundException('template not exists:' . $template, $template);
        }

        return $this->view->fetch($template);
    }

    /**
     * 渲染内容输出
     * @access protected
     * @param string $content 模板内容
     * @return mixed
     */
    final protected function display($content = '')
    {
        return $this->view->display($content);
    }

    /**
     * 模板变量赋值
     * @access protected
     * @param mixed $name  要显示的模板变量
     * @param mixed $value 变量的值
     * @return void
     */
    final protected function assign($name, $value = '')
    {
        $this->view->assign($name, $value);
    }

    /**
     * 获取插件名
     * @return string
     */
    final public function getName()
    {
        if (empty($this->name)) {
            $class = get_class($this);

            $this->name = substr($class, strrpos($class, '\\') + 1, -6);
        }

        return $this->name;

    }

    /**
     * 检查插件信息完整性
     * @return bool
     */
    final public function checkInfo()
    {
        $infoCheckKeys = ['name', 'title', 'description', 'status', 'author', 'version'];
        foreach ($infoCheckKeys as $value) {
            if (!array_key_exists($value, $this->info))
                return false;
        }
        return true;
    }

    /**
     * 获取插件根目录绝对路径
     * @return string
     */
    final public function getPluginPath()
    {

        return $this->pluginPath;
    }

    /**
     * 获取插件配置文件绝对路径
     * @return string
     */
    final public function getConfigFilePath()
    {
        return $this->configFilePath;
    }

    /**
     *
     * @return string
     */
    final public function getThemeRoot()
    {
        return $this->themeRoot;
    }

    /**
     * @return View
     */
    public function getView()
    {
        return $this->view;
    }

    /**
     * 获取插件的配置数组
     * @return array
     */
    final public function getConfig()
    {
        $name = $this->getName();

        if (PHP_SAPI != 'cli') {
            static $_config = [];
            if (isset($_config[$name])) {
                return $_config[$name];
            }
        }
        $pluginCofingKey = 'cmf_'.$name.'_plugin_config';
        if (Cache::has($pluginCofingKey)){
            return Cache::get($pluginCofingKey);
        }
        $ttl = mt_rand(600,6000);
        $config = Db::name('plugin')->cache('cmf_'.$name.'_plugin_config_db',$ttl)->where('name', $name)->value('config');

        if (!empty($config) && $config != "null") {
            $config = json_decode($config, true);
        } else {
            $config = $this->getDefaultConfig();
        }
        Cache::set($pluginCofingKey,$config,$ttl);
        $_config[$name] = $config;
        return $config;
    }

    /**
     * 获取插件的配置数组
     * @return array
     */
    final public function getDefaultConfig()
    {
        $config = [];
        if (file_exists($this->configFilePath)) {
            $tempArr = include $this->configFilePath;
            if (!empty($tempArr) && is_array($tempArr)) {
                foreach ($tempArr as $key => $value) {
                    if ($value['type'] == 'group') {
                        foreach ($value['options'] as $gkey => $gvalue) {
                            foreach ($gvalue['options'] as $ikey => $ivalue) {
                                $config[$ikey] = $ivalue['value'];
                            }
                        }
                    } else {
                        $config[$key] = $tempArr[$key]['value'];
                    }
                }
            }
        }

        return $config;
    }

    protected function installSql()
    {
        //执行安装sql
        $dbConfig = env();
        $sqlArr  = hcSplitSql($this->pluginPath . '/install.sql', $dbConfig['DATABASE_PREFIX'], $dbConfig['DATABASE_CHARSET']);
        $db = Db::connect();
        foreach ($sqlArr as $sql) {
            $sqlToExec = $sql . ';';
            $result = sp_execute_sql($db, $sqlToExec);
            if (!empty($result['error'])) {
                return false;
            }
        }
        return true;
    }

    public function editMenu($type = 1, $remark = '') {
        $adminMenuModel = new AdminMenu();
        if ($type == 1) { //安装
            $adminMenuModel->where('remark', $remark)->update(['status' => 1]);
        } else {//卸载
            $adminMenuModel->where('remark', $remark)->update(['status' => 2]);
        }
    }

    //必须实现安装
    abstract public function install();

    //必须卸载插件方法
    abstract public function uninstall();
}