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: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 

<?php
/**
 * SAE TaskQueue服务 
 *
 * @package sae 
 * @version $Id$
 * @author Elmer Zhang
 */



/**
 * SAE TaskQueue<br />
 * 任务队列服务
 *
 * <code>
 * <?php
 * $queue = new SaeTaskQueue('test');
 * 
 * //添加单个任务
 * $queue->addTask("/page1.php");
 * $queue->addTask("/page2.php", "key=value", true);
 * 
 * //批量添加任务
 * $array = array();
 * $array[] = array('url'=>"/page3.php", "postdata"=>"act=test");
 * $array[] = array('url'=>"/page4.php", "postdata"=>"act=test", "prior"=>true);
 * $queue->addTask($array);
 * 
 * //将任务推入队列
 * $ret = $queue->push();
 *
 * //任务添加失败时输出错误码和错误信息
 * if ($ret === false)
 *      var_dump($queue->errno(), $queue->errmsg());
 * ?>
 * </code>
 *
 * 错误码参考：
 *  - errno: 0      成功
 *  - errno: 1      认证失败
 *  - errno: 3      参数错误
 *  - errno: 10     队列不存在
 *  - errno: 11     队列已满或剩余长度不足
 *  - errno: 500    服务内部错误
 *  - errno: 999    未知错误
 *  - errno: 403    权限不足或超出配额
 *
 * @package sae
 * @author Elmer Zhang
 *
 */
class SaeTaskQueue extends SaeObject
{
    private $_accesskey = "";   
    private $_secretkey = "";
    private $_errno=SAE_Success;
    private $_errmsg="OK";
    private $_post = array();

    /**
     * @ignore
     */
    const post_limitsize = 8388608;

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

    /**
     * 构造对象
     *
     * @param string $queue_name 队列名称
     */
    function __construct($queue_name) {
        $this->_accesskey = SAE_ACCESSKEY;
        $this->_secretkey = SAE_SECRETKEY;

        $this->_queue_name = $queue_name;
        $this->_post['name'] = $queue_name;
        $this->_post['queue'] = array();
    }

    /**
     * 添加任务
     * 
     * @param string|array $tasks 任务要访问的URL或以数组方式传递的多条任务。添加多条任务时的数组格式：
     * <code>
     * <?php
     * $tasks = array( array("url" => "/test.php", //只支持相对URL，且"/"开头
     *                       "postdata" => "data", //要POST的数据。可选
     *                       "prior" => false,  //是否优先执行，默认为false，如果设为true，则将此任务插入到队列最前面。可选
     *                       "options" => array('key1' => 'value1', ....),  //附加参数，可选。
     * ), ................);
     * ?>
     * </code>
     * @param string $postdata 要POST的数据。可选，且仅当$tasks为URL时有效
     * @param bool prior 是否优先执行，默认为false，如果设为true，则将此任务插入到队列最前面。可选，且仅当$tasks为URL时有效
     * @param array options 附加参数，可选，且仅当$tasks为URL时有效。目前支持的参数：
     *  - delay, 延时执行，单位秒，最大延时600秒。
     * @return bool
     * @author Elmer Zhang
     */
    function addTask($tasks, $postdata = NULL, $prior = false, $options = array()) {
        if ( is_string($tasks) ) {
            if ( !$this->checkTaskUrl($tasks) ) {
                $this->_errno = SAE_ErrParameter;
                $this->_errmsg = "Unavailable tasks";
                return false;
            }

            //添加单条任务
            $item = array();
            $item['url'] = $tasks;
            if ($postdata != NULL) $item['postdata'] = base64_encode($postdata);
            if ($prior) $item['prior'] = true;
            $this->setOptions($item, $options);
            $this->_post['queue'][] = $item;

        } elseif ( is_array($tasks) ) {
            if ( empty($tasks) ) {
                $this->_errno = SAE_ErrParameter;
                $this->_errmsg = "Unavailable tasks";
                return false;
            }

            //添加多条任务
            foreach($tasks as $k => $v) {
                if (is_array($v) && isset($v['url']) && $this->checkTaskUrl($v['url'])) {
                    if (isset($v['postdata'])) {
                        $v['postdata'] = base64_encode($v['postdata']);
                    }
                    if (isset($v['options'])) {
                        $this->setOptions($v, $v['options']);
                        unset($v['options']);
                    }
                    $this->_post['queue'][] = $v;
                } elseif (isset($tasks['url']) && $this->checkTaskUrl($tasks['url'])) {
                    if (isset($tasks['postdata'])) {
                        $tasks['postdata'] = base64_encode($tasks['postdata']);
                    }
                    if (isset($tasks['options'])) {
                        $this->setOptions($tasks, $tasks['options']);
                        unset($tasks['options']);
                    }
                    $this->_post['queue'][] = $tasks;
                    break;
                } else {
                    $this->_post['queue'] = array();
                    $this->_errno = SAE_ErrParameter;
                    $this->_errmsg = "Unavailable tasks";
                    return false;
                }
            }
        }

        return true;
    }

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

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

    /**
     * 设置key
     *
     * 只有使用其他应用的key时才需要调用
     *
     * @param string $accesskey 
     * @param string $secretkey 
     * @return void
     * @author Elmer Zhang
     * @ignore
     */
    public function setAuth( $accesskey, $secretkey) {
        $accesskey = trim($accesskey);
        $secretkey = trim($secretkey);
        $this->_accesskey = $accesskey;
        $this->_secretkey = $secretkey;
        return true;
    }

    /**
     * 将任务列表推入队列
     *
     * @return bool
     * @author Elmer Zhang
     */
    public function push() {
        $post = json_encode($this->_post);
        if (strlen($post) > self::post_limitsize) {
            $this->_errno = SAE_ErrParameter;
            $this->_errmsg = "The post data is too large.";
            return false;
        }
        if (count($this->_post['queue']) > 0) {
            $this->_post['queue'] = array();
            return $this->postData(array("taskqueue"=>$post));
        } else {
            $this->_errno = SAE_ErrParameter;
            $this->_errmsg = "The queue is empty.";
            return false;
        }
    }

    /**
     * 查询队列剩余长度（可再添加的任务数）
     * 
     * @return int
     * @author Elmer Zhang
     */
    function leftLength() {
        $this->_act = 'leftlen';
        //$this->_post['name'] = $this->_queue_name;

        return $this->send();
    }

    /**
     * 查询队列当前长度（剩余未执行的任务数）
     * 
     * @return int
     * @author Elmer Zhang
     */
    function curLength() {
        $this->_act = 'curlen';
        //$this->_post['name'] = $this->_queue_name;

        return $this->send();
    }

    /**
     * @author Elmer Zhang
     */
    private function send() {
        $post = urlencode(json_encode($this->_post));
        if ($post) {
            return $this->postData(array("params"=>$post, "act"=>$this->_act));
        } else {
            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, 1);
        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); 
        $ret = curl_exec($s);
        // exception handle, if error happens, set errno/errmsg, and return false
        $info = curl_getinfo($s);
        $error = curl_error($s);
        curl_close($s);
        //print_r($info);
        //echo 'abab';
        //print_r($ret);
        //echo 'abab';
        if(empty($info['http_code'])) {
            $this->_errno = SAE_ErrInternal;
            $this->_errmsg = $error;
        } else if($info['http_code'] != 200) {
            $this->_errno = SAE_ErrInternal;
            $code = $info['http_code'];
            $this->_errmsg = "taskqueue service internal error, httpcode isn't 200, code: $code";
        } else {
            if($info['size_download'] == 0) { // get MailError header
                $header = substr($ret, 0, $info['header_size']);
                $taskheader = $this->extractCustomHeader("TaskQueueError", $header);
                if($taskheader == false) { // not found MailError header
                    $this->_errno = SAE_ErrUnknown;
                    $this->_errmsg = "unknown error";
                } else {
                    $err = explode(",", $taskheader, 2);
                    $this->_errno = trim($err[0]);
                    $this->_errmsg = trim($err[1]);
                }
            } else {
                $body = substr($ret, -$info['size_download']);
                $body = json_decode(trim($body), true);
                $this->_errno = $body['errno'];
                $this->_errmsg = $body['errmsg'];
                if ($body['errno'] == 0) {
                    if (isset($body['data'])) {
                        return $body['data'];
                    } else {
                        return true;
                    }
                }
            }
        }
        return false;
    }

    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("TimeStamp: $timestamp","AccessKey: ".$this->_accesskey, "Signature: " . $this->genSignature($cont1, $this->_secretkey));
        //print_r($reqhead);
        return $reqhead;
    }

    private function extractCustomHeader($key, $header) {
        $pattern = '/'.$key.':(.*?)'."\n/";
        if (preg_match($pattern, $header, $result)) {
            return $result[1];
        } else {
            return false;
        }
    }

    private function setOptions(&$item, $options) {
        if (is_array($options) && !empty($options)) {
            foreach($options as $k => $v) {
                switch ($k) {
                    case 'delay':
                        $item['delay'] = intval($v);
                        break;
                    default:
                        break;
                }
            }
        }
    }

    private function checkTaskUrl(&$url) {
        if (substr($url, 0, 1) === '/') {
            $url = sprintf('http://%d.%s.applinzi.com%s', SAE_APPVERSION, SAE_APPNAME, $url);
        }   
        $url = filter_var($url, FILTER_VALIDATE_URL);
        return $url;
    } 
}