<?php
//  ---------------------------------------------------------------------------------
//    _____   _             _                   _   _____
//   |  __ \ | |           | |    /\           (_) |  __ \
//   | |__) || |__    __ _ | |   /  \    _ __   _  | |__) |_ __  ___
//   |  ___/ | '_ \  / _` || |  / /\ \  | '_ \ | | |  ___/| '__|/ _ \
//   | |     | | | || (_| || | / ____ \ | |_) || | | |    | |  | (_) |
//   |_|     |_| |_| \__,_||_|/_/    \_\| .__/ |_| |_|    |_|   \___/
//                                      | |
//                                      |_|
//   PhalApi Pro 专业版
//   广州果创网络科技有限公司
//
//  ---------------------------------------------------------------------------------
//
//   一、协议的许可和权利
//    1. 您可以在完全遵守本协议的基础上，将本软件应用于商业用途；
//    2. 您可以在协议规定的约束和限制范围内修改本产品源代码或界面风格以适应您的要求；
//    3. 您拥有使用本产品中的全部内容资料、商品信息及其他信息的所有权，并独立承担与其内容相关的
//       法律义务；
//    4. 获得商业授权之后，您可以将本软件应用于商业用途，自授权时刻起，在技术支持期限内拥有通过
//       指定的方式获得指定范围内的技术支持服务；
//
//   二、协议的约束和限制
//    1. 未获商业授权之前，禁止将本软件用于商业用途（包括但不限于企业法人经营的产品、经营性产品
//       以及以盈利为目的或实现盈利产品）；
//    2. 未获商业授权之前，禁止在本产品的整体或在任何部分基础上发展任何派生版本、修改版本或第三
//       方版本用于重新开发；
//    3. 如果您未能遵守本协议的条款，您的授权将被终止，所被许可的权利将被收回并承担相应法律责任；
//
//   三、有限担保和免责声明
//    1. 本软件及所附带的文件是作为不提供任何明确的或隐含的赔偿或担保的形式提供的；
//    2. 用户出于自愿而使用本软件，您必须了解使用本软件的风险，在尚未获得商业授权之前，我们不承
//       诺提供任何形式的技术支持、使用担保，也不承担任何因使用本软件而产生问题的相关责任；
//    3. 广州果创网络科技有限公司不对使用本产品构建的商城中的内容信息承担责任，但在不侵犯用户隐
//       私信息的前提下，保留以任何方式获取用户信息及商品信息的权利；
//
//   有关本产品最终用户授权协议、商业授权与技术服务的详细内容，均由广州果创网络科技有限公司独家
//   提供。广州果创网络科技有限公司拥有在不事先通知的情况下，修改授权协议的权力，修改后的协议对
//   改变之日起的新授权用户生效。电子文本形式的授权协议如同双方书面签署的协议一样，具有完全的和
//   等同的法律效力。您一旦开始修改、安装或使用本产品，即被视为完全理解并接受本协议的各项条款，
//   在享有上述条款授予的权力的同时，受到相关的约束和限制。协议许可范围以外的行为，将直接违反本
//   授权协议并构成侵权，我们有权随时终止授权，责令停止损害，并保留追究相关责任的权力。
//
//  ---------------------------------------------------------------------------------

namespace Admin\Api;

use Admin\Common\Api;
use Base\Common\ToolUtil;
use Base\Domain\Apps as AppsDomain;



/**
 * 应用管理模块
 */
class Apps extends Api {

    public function getRules() {
        return array(
            'getAppList' => array(
                'appKey' => array('name' => 'app_key', 'max' => '64', 'desc' => 'app_key，用于区分客户端应用'),
                'appName' => array('name' => 'app_name', 'default' => '', 'max' => 50, 'desc' => '待搜索的应用名称'),
                'verifyStatus' => array('name' => 'verify_status', 'type' => 'int', 'desc' => '审核状态'),
                'page' => array('name' => 'page', 'type' => 'int', 'min' => 1, 'default' => 1, 'desc' => '第几页'),
                'perpage' => array('name' => 'perpage', 'type' => 'int', 'min' => 1, 'max' => 5000, 'default' => 10, 'desc' => '分页数量'),
            ),
            'getAppDropdownList' => array(
                'appName' => array('name' => 'app_name', 'default' => '', 'max' => 50, 'desc' => '待搜索的应用名称'),
            ),
            'alterAppStat' => array(
                'id' => array('name' => 'id', 'type' => 'int', 'required' => true, 'desc' => '要修改的应用id'),
                'type' => array('name' => 'type', 'type' => 'int', 'default' => 1, 'required' => true, 'desc' => '1解封应用，0锁定应用'),
            ),
            'addApp' => array(
                'appName' => array('name' => 'appName', 'require' => true, 'max' => 50, 'desc' => '应用名称'),
                'appKey' => array('name' => 'app_key', 'require' => true, 'max' => '64', 'desc' => 'app_key，用于区分客户端应用'),
                'appSecret' => array('name' => 'app_secret', 'require' => true, 'max' => 64, 'desc' => '应用密钥'),
                'appOwner' => array('name' => 'app_owner', 'require' => false, 'max' => 100, 'desc' => '申请机构'),
                'appUid' => array('name' => 'app_uid', 'require' => false, 'desc' => '账号ID'),
                'appLimit' => array('name' => 'app_limit', 'require' => false, 'default' => 0, 'type' => 'int', 'desc' => '应用每日接口限制，默认为0表示无限制'),
                'appIcon' => array('name' => 'app_icon', 'default' => '', 'max' => 255, 'desc' => '应用图标'),
                'applyReason' => array('name' => 'apply_reason', 'default' => '', 'max' => 2000, 'desc' => '申请说明'),
            ),
            'getAppSecret' => array(
                'id' => array('name' => 'id', 'type' => 'int', 'required' => true, 'desc' => '应用id'),
            ),
            'editApp' => array(
                'id' => array('name' => 'id', 'type' => 'int', 'required' => true, 'desc' => '要修改的应用id'),
                'appName' => array('name' => 'app_name',  'max' => 50, 'desc' => '应用名称'),
                'appSecret' => array('name' => 'app_secret',  'max' => 64, 'desc' => '应用密钥'),
                'appLimit' => array('name' => 'app_limit',  'type' => 'int', 'desc' => '应用每日接口限制，默认为0表示无限制'),
                'uid' => array('name' => 'uid',  'type' => 'int', 'desc' => '账号id'),
                'verifyStatus' => array('name' => 'verify_status', 'type' => 'int', 'desc' => '审核状态'),
                'appIcon' => array('name' => 'app_icon', 'max' => 255, 'desc' => '应用图标'),
                'applyReason' => array('name' => 'apply_reason', 'max' => 2000, 'desc' => '申请说明'),
                'allowIps' => array('name' => 'allow_ips', 'desc' => 'IP白名单'),
            ),
            'getAppInfo' => array(
                'id' => array('name' => 'id', 'type' => 'int', 'required' => true, 'desc' => '应用id'),
            ),
            'verifyAppStat' => array(
                'id' => array('name' => 'id', 'type' => 'int', 'required' => true, 'desc' => '要修改的应用id'),
                'type' => array('name' => 'type', 'type' => 'int', 'default' => 1, 'required' => true, 'desc' => '1审核通过 2审核不通过'),
            )
        );
    }

    /**
     * 获取所有应用数据
     * @desc 获取所有应用数据
     * @return array list 应用列表，没有时为空数组
     * @return int list[].id                id
     * @return string list[].app_key        应用app_key
     * @return string list[].app_secret     应用app_secret
     * @return string list[].app_name       应用名称
     * @return int list[].app_status        应用状态： 1表示正常使用，0表示禁止🈲️
     * @return string list[].add_time       添加时间
     * @return int list[].app_limit         应用每日请求限制次数
     * @return int list[].today_request     应用今日调用次数
     * @return int list[].uid               账号ID
     * @return string list[].app_owner      申请机构/授权机构
     * @return int list[].verify_status     审核状态，0待审核1审核通过2审核不通过
     * @return string list[].uidName        账号ID对应的用户名
     */
    public function getAppList(){
        $domain = new AppsDomain();
        return $domain->getAllApp($this->appKey, $this->appName, $this->verifyStatus, $this->page, $this->perpage);
    }
    
    /**
     * 获取应用下拉列表
     * @desc 获取应用下拉列表，最多返回前面1000个
     * @return array list 应用列表，没有时为空数组
     * @return int list[].id        id
     * @return string list[].app_key   应用app_key
     * @return string list[].app_secret        应用app_secret
     * @return string list[].app_name        应用名称
     * @return int list[].app_status        应用状态： 1表示正常使用，0表示禁止🈲️
     */
    public function getAppDropdownList(){
        $domain = new AppsDomain();
        return $domain->getAppDropdownList($this->appName);
    }
    
    /**
     * 获取应用密钥
     * @desc 根据id获取app密钥
     * @return string app_secret 密钥，失败时为空
     */
    public function getAppSecret(){
        $rs = array('app_secret' => '');
        $domain = new AppsDomain();
        $app = $domain->getAppById($this->id, 'app_secret');
        if (!empty($app)) {
            $rs['app_secret'] = $app['app_secret'];
        }
        return $rs;
    }

    /**
     * 获取应用信息
     * @desc 根据id获取应用信息
     * @return boolean isEmpty true表示数据为空，获取失败
     * @return array info 应用信息
     * @return int info[].id                id
     * @return string info[].app_key        应用app_key
     * @return string info[].app_secret     应用app_secret
     * @return string info[].app_name       应用名称
     * @return int info[].app_status        应用状态： 1表示正常使用，0表示禁止🈲️
     * @return string info[].add_time       添加时间
     * @return int info[].app_limit         应用每日请求限制次数
     * @return int info[].today_request     应用今日调用次数
     * @return int info[].uid               账号ID
     * @return string info[].uidName        账号ID对应的昵称
     * @return string info[].app_owner      申请机构/授权机构
     * @return int info[].verify_status     审核状态，0待审核1审核通过2审核不通过
     */
    public function getAppInfo(){
        $rs = array('isEmpty' => true, 'info' => array());
        $domain = new AppsDomain();
        $data = $domain->getAppById($this->id);
        if(!empty($data)){
            $rs['isEmpty'] = false;
            $data['allow_ips'] = strval($data['allow_ips']); // fixed null string
            $rs['info'] = $data;
        }
        return $rs;
    }

    /**
     * 修改应用状态
     * @desc 解封和锁定应用，type为1解封应用，0锁定应用
     * @return bool is_success 是否修改成功，true表示修改成功，false修改失败
     */
    public function alterAppStat(){
        $rs = array('is_success' => false);
        $status = $this->type == 1 ? 1 : 0;
        $domain = new AppsDomain();
        if($domain->alterAppStat($this->id, $status)){
            $rs['is_success'] = true;
        }
        return $rs;
    }

    /**
     * 新增应用
     * @desc 新增应用，app_key不能重复，app_secret可由前端生成。所创建的应用不受数量限制，且默认为通过状态。
     * @return bool is_add 是否新增成功，true表示新增成功，false新增失败
     */
    public function addApp(){
        $rs = array('is_add' => false);
        
        $moreInfo = array(
            'app_icon' => $this->appIcon,
            'apply_reason' => $this->applyReason,
        );
        
        $domain = new AppsDomain();
        // 默认审核通过
        $verifyStatus = 1;
        $appLimit = intval($this->appLimit);
        if($domain->addApp($this->appName, $this->appKey, $this->appSecret, $appLimit, $this->appUid, $this->appOwner, $verifyStatus, $moreInfo)){
            $rs['is_add'] = true;
        }
        return $rs;
    }

    /**
     * 生成随机appSecret
     * @desc 生成随机sppSecret，32位字符串
     * @return string appSecret 32位appSecret
     */
    public function createAppSecret(){
        $rs = array('appSecret' => '');
        $rs['appSecret'] = ToolUtil::createRandString(32);
        return $rs;
    }

    /**
     * 修改应用
     * @desc 修改应用名称，应用密钥，appKey无法修改
     * @return bool is_update 是否更新成功
     */
    public function editApp(){
        $rs = array('is_update' => false);
        $domain = new AppsDomain();
        $updateRows = $domain->editApp($this->id, $this->appName, $this->appSecret, $this->appLimit, $this->uid, $this->verifyStatus, $this->appIcon, $this->applyReason, $this->allowIps);
        if ($updateRows > 0) {
            $rs['is_update'] = true;
        }
        return $rs;
    }

    /**
     * 审核应用
     * @desc 审核应用接口，1审核通过 2审核不通过
     * @return bool is_success 是否审核成功，true表示审核成功，false审核失败
     */
    public function verifyAppStat(){
        $rs = array('is_success' => false);
        $verifyStatus = $this->type == 1 ? 1 : 2;
        $domain = new AppsDomain();
        if($domain->verifyAppStat($this->id, $verifyStatus)){
            $rs['is_success'] = true;
        }
        return $rs;
    }

}
