class.ilECSResult.php

Go to the documentation of this file.

<?php
/*
    +-----------------------------------------------------------------------------+
    | ILIAS open source                                                           |
    +-----------------------------------------------------------------------------+
    | Copyright (c) 1998-2006 ILIAS open source, University of Cologne            |
    |                                                                             |
    | This program is free software; you can redistribute it and/or               |
    | modify it under the terms of the GNU General Public License                 |
    | as published by the Free Software Foundation; either version 2              |
    | of the License, or (at your option) any later version.                      |
    |                                                                             |
    | This program is distributed in the hope that it will be useful,             |
    | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
    | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
    | GNU General Public License for more details.                                |
    |                                                                             |
    | You should have received a copy of the GNU General Public License           |
    | along with this program; if not, write to the Free Software                 |
    | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
    +-----------------------------------------------------------------------------+
*/

include_once('./Services/WebServices/ECS/classes/class.ilECSConnectorException.php');

class ilECSResult
{
    const RESULT_TYPE_JSON = 1;
    const RESULT_TYPE_URL_LIST = 2;
    
    const HEADER_ECS_SENDER = 'X-EcsSender';
    
    protected $log;
    
    protected $result_string = '';
    protected $result_header = '';
    protected $http_code = '';
    protected $result;
    protected $result_type;
    protected $header_parsing = false;
    
    protected $headers = array();
    protected $header_map = array();
    
    public function __construct($a_res, $with_headers = false, $a_type = self::RESULT_TYPE_JSON)
    {
        global $DIC;

        $ilLog = $DIC['ilLog'];
        
        $this->log = $ilLog;
        
        $this->result_string = $a_res;
        $this->result_type = $a_type;
        
        if ($with_headers) {
            $this->header_parsing = true;
        }
    
        $this->init();
    }
    
    public function setHTTPCode($a_code)
    {
        $this->http_code = $a_code;
    }
    
    public function getHTTPCode()
    {
        return $this->http_code;
    }
    
    public function getPlainResultString()
    {
        return $this->result_string;
    }

    public function getResult()
    {
        return $this->result;
    }

    public function setHeaders($a_headers)
    {
        $this->headers = $a_headers;
    }
    
    public function getHeaders()
    {
        return $this->headers ? $this->headers : array();
    }
    
    private function init()
    {
        if ($this->header_parsing and $this->result_string) {
            $this->splitHeader();
            $this->parseHeader();
        }

        
        switch ($this->result_type) {
            case self::RESULT_TYPE_JSON:
                if ($this->result_string) {
                    $this->result = json_decode($this->result_string);
                } else {
                    $this->result = array();
                }
                break;

            case self::RESULT_TYPE_URL_LIST:
                $this->result = $this->parseUriList($this->result_string);
                break;
        }
        return true;
    }
    
    private function splitHeader()
    {
        $pos = strpos($this->result_string, "\r\n\r\n");
        if ($pos !== false) {
            $this->result_header = substr($this->result_string, 0, $pos + 2);
            $this->result_string = substr($this->result_string, $pos + 2, -1);
            return true;
        } else {
            $this->log->write(__METHOD__ . ': Cannot find header entry');
            throw new ilECSConnectorException('Cannot find header part.');
        }
    }
    
    private function parseHeader()
    {
        // In the moment only look for "Location:" value
        $location_start = strpos($this->result_header, "Location:");
        if ($location_start !== false) {
            $location_start += 10;
            $location_end = strpos($this->result_header, "\r\n", $location_start);
            
            $location = substr($this->result_header, $location_start, $location_end - $location_start);
            $this->headers['Location'] = $location;
        }
        
        $ecs_sender = strpos($this->result_header, self::HEADER_ECS_SENDER);
        if ($ecs_sender !== false) {
            $sender_start = +13;
            $sender_end = strpos($this->result_header, "\r\n", $sender_start);
            $sender = substr($this->result_header, $sender_start, $sender_end - $sender_start);
            
            $senders_arr = explode(',', $sender);
            $this->header_map[self::HEADER_ECS_SENDER] = $senders_arr;
        }
        return true;
    }

    private function parseUriList($a_content)
    {
        include_once 'Services/WebServices/ECS/classes/class.ilECSUriList.php';
        $list = new ilECSUriList();
        $lines = explode("\n", $this->getPlainResultString());
        foreach ($lines as $line) {
            $line = trim($line);
            if (!strlen($line)) {
                continue;
            }
            $uri_parts = explode("/", $line);
            $list->add($line, array_pop($uri_parts));
        }

        return $list;
    }
}