File Handler/Verbose.php | Akamai {OPEN} EdgeGrid Authentication for PHP

  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

<?php
/**
 * Akamai {OPEN} EdgeGrid Auth Client
 *
 * @author Davey Shafik <dshafik@akamai.com>
 * @copyright Copyright 2016 Akamai Technologies, Inc. All rights reserved.
 * @license Apache 2.0
 * @link https://github.com/akamai-open/AkamaiOPEN-edgegrid-php-client
 * @link https://developer.akamai.com
 * @link https://developer.akamai.com/introduction/Client_Auth.html
 */
namespace Akamai\Open\EdgeGrid\Handler;

use Akamai\Open\EdgeGrid\Exception\HandlerException\IOException;

/**
 * Verbose Response Guzzle Middleware Handler
 *
 * @package Akamai\Open\EdgeGrid\Client
 */
class Verbose
{
    protected $outputStream;

    protected $errorStream;

    /**
     * Verbose constructor.
     *
     * This method accepts stream resources or a valid stream URLs
     * (including file paths). It will use the output stream for
     * both output and error streams if no error stream is passed in.
     *
     * If neither is passed in, stdout and stderr are used.
     *
     * @param resource|string|null $outputStream
     * @param resource|string|null $errorStream
     * @throws \Akamai\Open\EdgeGrid\Exception\HandlerException\IOException
     */
    public function __construct($outputStream = null, $errorStream = null)
    {
        $errorStreamException = null;
        if (!is_resource($errorStream) && $errorStream !== null) {
            $fp = @fopen($errorStream, 'ab+');
            if (!$fp) {
                $errorStreamException = new IOException('Unable to use error stream: ' . (string) $errorStream);
            }
            $errorStream = $fp;
        }

        if (!is_resource($outputStream) && $outputStream !== null) {
            $fp = @fopen($outputStream, 'ab+');
            if (!$fp) {
                throw new IOException('Unable to use output stream: ' . (string) $outputStream);
            }
            $outputStream = $fp;
        }

        if ($errorStreamException instanceof \Exception) {
            throw $errorStreamException;
        }

        if ($outputStream !== null && $errorStream === null) {
            $errorStream = $outputStream;
        }

        if ($outputStream === null && $errorStream === null) {
            $errorStream = fopen('php://stderr', 'ab');
        }

        if ($outputStream === null) {
            $outputStream = fopen('php://output', 'ab');
        }

        $this->outputStream = $outputStream;
        $this->errorStream = $errorStream;
    }

    /**
     * Handle the request/response
     *
     * @param callable $handler
     * @return \Closure
     */
    public function __invoke(callable $handler)
    {
        $colors = [
            'red' => '',
            'yellow' => '',
            'cyan' => '',
            'reset' => '',
        ];

        if (PHP_SAPI === 'cli') {
            $colors = [
                'red' => "\x1b[31;01m",
                'yellow' => "\x1b[33;01m",
                'cyan' => "\x1b[36;01m",
                'reset' => "\x1b[39;49;00m",
            ];
        }

        return function (
            \Psr\Http\Message\RequestInterface $request,
            array $config
        ) use (
            $handler,
            $colors
        ) {
            fwrite($this->outputStream, "{$colors['cyan']}===> [VERBOSE] Request: \n");
            fwrite($this->outputStream, "{$colors['yellow']}" . $this->getBody($request));
            fwrite($this->outputStream, "{$colors['reset']}\n");

            return $handler($request, $config)->then(
                function (\Psr\Http\Message\ResponseInterface $response) use ($colors) {
                    $statusCode = $response->getStatusCode();
                    if ($statusCode > 299 && $statusCode < 400) {
                        fwrite($this->outputStream, "{$colors['cyan']}===> [VERBOSE] Redirected: ");
                        fwrite($this->outputStream, $response->getHeader('Location')[0]);
                        fwrite($this->outputStream, "{$colors['reset']}\n");
                    } else {
                        $responseBody = $this->getBody($response);

                        if ($statusCode > 399 && $statusCode < 600) {
                            fwrite($this->errorStream, "{$colors['red']}===> [ERROR] An error occurred: \n");
                            fwrite($this->errorStream, "{$colors['yellow']}" . $responseBody);
                            fwrite($this->errorStream, "{$colors['reset']}\n");
                        } else {
                            fwrite($this->outputStream, "{$colors['cyan']}===> [VERBOSE] Response: \n");
                            fwrite($this->outputStream, "{$colors['yellow']}" . $responseBody);
                            fwrite($this->outputStream, "{$colors['reset']}\n");
                        }
                    }

                    return $response;
                },
                function (\Exception $reason) use ($colors) {
                    fwrite($this->outputStream, "{$colors['red']}===> [ERROR] An error occurred: \n");
                    fwrite($this->outputStream, "{$colors['yellow']}");

                    $code = $reason->getCode();
                    if (!empty($code)) {
                        $code .= ': ';
                    }

                    $message = $reason->getMessage();

                    fwrite($this->outputStream, ((!empty($code)) ? $code : '') . $message);

                    $response = $reason instanceof \GuzzleHttp\Exception\RequestException
                        ? $reason->getResponse()
                        : false;

                    if ($response instanceof \Psr\Http\Message\ResponseInterface) {
                        $body = $response->getBody()->getContents();
                        if (!empty($body)) {
                            fwrite($this->outputStream, "\n{$colors['yellow']}" . $body);
                        }
                    }

                    fwrite($this->outputStream, "{$colors['reset']}\n");

                    return new \GuzzleHttp\Promise\RejectedPromise($reason);
                }
            );
        };
    }

    /**
     * Get response body
     *
     * @param \Psr\Http\Message\MessageInterface $message
     *
     * @return string
     */
    protected function getBody(\Psr\Http\Message\MessageInterface $message)
    {
        $body = trim($message->getBody());

        if ($message->getBody()->getSize() === 0 || empty($body)) {
            if ($message instanceof \Psr\Http\Message\ResponseInterface) {
                return 'No response body returned';
            }
            return 'No request body sent';
        }
        $result = json_decode($body);
        if ($result !== null) {
            return json_encode($result, JSON_PRETTY_PRINT);
        }

        return $body;
    }
}

Namespaces

Classes

Exceptions