Overview

Namespaces

  • None
  • sinacloud
    • sae

Classes

  • SaeADPNS
  • SaeAPNS
  • SaeChannel
  • SaeDeferredJob
  • SaeFetchInternal
  • SaeKV
  • SaeMail
  • SaeMysql
  • SaeSegment
  • SaeTAdvance
  • SaeTaskQueue
  • SaeTClientV2
  • SaeTOAuthV2
  • SaeVCode
  • sinacloud\sae\Storage
  • vDisk

Exceptions

  • OAuthException
  • sinacloud\sae\StorageException
  • Overview
  • Namespace
  • Class
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 
<?php
/**
 * SAE DeferredJob
 *
 * @package sae
 * @version
 * @author Seeker Zhang
 */



/**
 * SAE DeferredJob<br />
 * 大文件导入导出服务
 *
 * <code>
 * <?php
 * $dj = new SaeDeferredJob();
 *
 * //添加任务
 * $taskID=$dj->addTask("import","mysql","bucketA","abc.sql","databaseA","tableA","callback.php");
 * if($taskID===false)
 *  var_dump($dj->errno(), $dj->errmsg());
 * else
 *  var_dump($taskID);
 *
 * $taskID=$dj->addTask("export","mysql","bucketB","abc.csv.zip","databaseB","tableB","csv.php", true);
 * if($taskID===false)
 *  var_dump($dj->errno(), $dj->errmsg());
 *
 * //获得任务状态
 * $ret=$dj->getStatus($taskID);
 * if($ret===false)
 *  var_dump($dj->errno(), $dj->errmsg());
 *
 * //删除任务
 * $ret=$dj->deleteTask($taskID);
 * if($ret===false)
 *  var_dump($dj->errno(), $dj->errmsg());
 *
 * ?>
 * </code>
 *
 * 错误码参考
 *  - errno: 0      成功
 *  - errno: -1     参数错误
 *  - errno: -2     数据库错误
 *  - errno: -3     没有找到taskid
 *  - errno: -4     已经删除过的taskid
 *  - errno: -5     任务已经开始执行
 *  - errno: -6     超过每天可执行任务数量上限
 *  - errno: -7     系统错误
 *  - errno: -8     未知错误
 *
 * @package sae
 * @author Seeker Zhang
 *
 */
class SaeDeferredJob extends SaeObject
{
    private $_accesskey = "";
    private $_secretkey = "";
    private $_errno=SAE_Success;
    private $_errmsg="OK";
    private $_post = array();

    /**
     * @ignore
     */
    const baseurl = "http://deferredjob.sae.sina.com.cn:81/rest.php";

    /**
     * 构造对象
     *
     */
    function __construct() {
        $this->_accesskey = SAE_ACCESSKEY;
        $this->_secretkey = SAE_SECRETKEY;
    }

    /**
     * 取得错误码
     *
     * @return int
     * @author Seeker Zhang
     */
    public function errno()
    {
        return $this->_errno;
    }

    /**
     * 取得错误信息
     *
     * @return string
     * @author Seeker Zhang
     */
    public function errmsg()
    {
        return $this->_errmsg;
    }

    /**
     * 添加任务
     *
     * @param string $tasktype 任务的类型:“import”|“export”。导入任务:“import”;导出任务:“export”。
     * @param string $dbtype 数据库的类型:“mysql”|“kvdb”。
     * @param stirng $stor_domain 存放导入/导出文件的storage的domain名称。
     * @param stirng $stor_filename 导入/导出文件名称,格式:prefix[.format][.compression],例:abc.csv.zip,服务根据format来判断数据类型,数据类型包括sql、csv。
     * @param stirng $dbname 导入/导出数据库的名称。
     * @param stirng $tbname 导入/导出数据库类型为mysql时,使用的表名。
     * @param stirng $callbackurl 任务成功时,调用的回调url,只支持应用默认版本中的url,为空时,不执行回调url。
     * @return mix 成功返回任务id,失败返回false。<br />
     * 注意:每天最多可执行10个任务。更多说明请查看文档中心。
     * @author Seeker Zhang
     */
    public function addTask($tasktype,$dbtype,$stor_domain,$stor_filename,$dbname,$tbname,$callbackurl,$ignore_errors=true){
            $this->_errno=SAE_Success;
            $this->_errmsg="OK";

        $tt=array('import','export');
        $dt=array('mysql', 'kvdb');

        $tasktype=trim($tasktype);
        if(!in_array($tasktype,$tt)){
            $this->setError("tasktype");
            return false;
        }
        $dbtype=trim($dbtype);
        if(!in_array($dbtype,$dt)){
            $this->setError("dbtype");
            return false;
        }

        $sf=trim($stor_filename);
        if(empty($sf)){
            $this->setError("stor filename");
            return false;
        }
        $dm=trim($stor_domain);
        if(empty($dm)){
            $this->setError("stor bucket");
            return false;
        }
        $md=trim($dbname);
        if(empty($md)){
            $this->setError("mysql database");
            return false;
        }

        $task=array('function'=>'add','tasktype'=>$tasktype,'dbtype'=>$dbtype,'stor_domain'=>$dm,'stor_filename'=>$sf,'dbname'=>$md,'tbname'=>$tbname,'callback'=>$callbackurl,'from'=>'api');
        if($ignore_errors === false) {
            $task['ignore_errors'] = 'false';
        }
        $ary=$this->postData($task);
        //return $ary;
        if($ary[0]==0){
            $taskid=$ary[2];
            return $taskid;
        }
        else{
            $this->_errno=$ary[0];
            $this->_errmsg=$ary[1];
            return false;
        }
    }

    /**
     * 获得任务状态
     *
     * @param int $taskID 任务的id。
     * @return mix 成功返回任务状态:未进入队列:waiting;等待执行:inqueue;执行中:excuting;完成:done;失败:abort。<br />
     *          失败返回false。
     * @author Seeker Zhang
     */
    public function getStatus($taskID){
            $this->_errno=SAE_Success;
            $this->_errmsg="OK";

        if(!is_numeric($taskID)){
            $this->setError("taskid");
            return false;
        }

        $task=array('function'=>'getstatus','id'=>$taskID);
        $ary=$this->postData($task);
        if($ary[0]==0){
            $status=$ary[2];
            return $status;
        }
        else{
            $this->_errno=$ary[0];
            $this->_errmsg=$ary[1];
            return false;
        }
    }

    /**
     * 删除任务
     *
     * @param int $taskID 任务的id。
     * @return bool 成功返回true,失败返回false,进入excuting状态的任务不能被删除。
     * @author Seeker Zhang
     */
    public function deleteTask($taskID){
            $this->_errno=SAE_Success;
            $this->_errmsg="OK";

        if(!is_numeric($taskID)){
            $this->setError("taskid");
            return false;
        }

        $task=array('function'=>'delete','id'=>$taskID);
        $ary=$this->postData($task);
        if($ary[0]==0){
            $status=$ary[2];
            return $status;
        }
        else{
            $this->_errno=$ary[0];
            $this->_errmsg=$ary[1];
            return false;
        }
    }

    private function postData($post) {
        $url = self::baseurl;
        $s = curl_init();
        curl_setopt($s,CURLOPT_URL,$url);
        curl_setopt($s,CURLOPT_HTTP_VERSION,CURL_HTTP_VERSION_1_0);
        curl_setopt($s,CURLOPT_TIMEOUT,5);
        curl_setopt($s,CURLOPT_RETURNTRANSFER,true);
        curl_setopt($s,CURLOPT_HEADER, 0);
        curl_setopt($s,CURLINFO_HEADER_OUT, true);
        curl_setopt($s,CURLOPT_HTTPHEADER, $this->genReqestHeader($post));
        curl_setopt($s,CURLOPT_POST,true);
        curl_setopt($s,CURLOPT_POSTFIELDS,$post);
        #curl_setopt($s, CURLOPT_VERBOSE, true);
        $ret = curl_exec($s);
        //var_dump($ret);
        $info = curl_getinfo($s);
        curl_close($s);
        if(empty($info['http_code'])) {
            $this->_errno = SAE_ErrInternal;
            $this->_errmsg = "deferredjob service segment fault";
        } else if($info['http_code'] != 200) {
            $hc=$info['http_code'];
            $this->_errno = SAE_ErrInternal;
            $this->_errmsg = "deferredjob service internal error";
        } else {
            $ret=substr($ret,0,-2);
            //echo "get data\n\t$ret";
            return explode("\t",$ret);
        }
        return false;
    }

    private function setError($msg=""){
        $this->_errno=-1;
        $this->_errmsg="parameter $msg error";
    }

    private function genSignature($content, $secretkey) {
        $sig = base64_encode(hash_hmac('sha256',$content,$secretkey,true));
        return $sig;
    }

    private function genReqestHeader($post) {
        $timestamp = date('Y-m-d H:i:s');
        $cont1 = "ACCESSKEY".$this->_accesskey."TIMESTAMP".$timestamp;
        $reqhead = array("JOBTimeStamp: $timestamp", "JOBAccessKey: ".$this->_accesskey, "JOBSignature: " . $this->genSignature($cont1, $this->_secretkey), "SAEAPPNAME: ".SAE_APPNAME);
        return $reqhead;
    }
}
API documentation generated by ApiGen