honeybadger-io/honeybadger-php

<?php

namespace Honeybadger;

use Honeybadger\Concerns\FiltersData;

class Environment
{
    use FiltersData;

    const KEY_WHITELIST = [
        'argv',
        'argc',
        'APP_ENV',
        'AUTH_TYPE',
        'DOCUMENT_ROOT',
        'GATEWAY_INTERFACE',
        'HTTPS',
        'ORIG_PATH_INFO',
        'PATH_INFO',
        'PATH_TRANSLATED',
        'PHP_AUTH_DIGEST',
        'PHP_AUTH_USER',
        'PHP_AUTH_PW',
        'PHP_SELF',
        'REDIRECT_REMOTE_USER',
        'REMOTE_ADDR',
        'REMOTE_HOST',
        'REMOTE_PORT',
        'REMOTE_USER',
        'REQUEST_METHOD',
        'REQUEST_TIME',
        'REQUEST_TIME_FLOAT',
        'SCRIPT_NAME',
        'SERVER_ADDR',
        'SERVER_NAME',
        'SERVER_SOFTWARE',
        'SERVER_PROTOCOL',
        'SCRIPT_FILENAME',
        'SERVER_ADMIN',
        'SERVER_PORT',
        'SERVER_SIGNATURE',
    ];

    /**
     * @var array
     */
    protected $includeKeys = [];

    /**
     * @var array
     */
    protected $server = [];

    public function __construct(array $server = null, array $env = null)
    {
        $this->server = array_merge(
            $server ?? $_SERVER,
            $env ?? $_ENV
        );

        $this->keysToFilter = ['HTTP_AUTHORIZATION'];
    }

    /**
     * @return array
     */
    public function values(): array
    {
        return $this->filter($this->data());
    }

    /**
     * @param  array  $keysToInclude
     * @return \Honeybadger\Environment
     */
    public function include(array $keysToInclude): self
    {
        $this->includeKeys = array_merge($this->includeKeys, $keysToInclude);

        return $this;
    }

    /**
     * @return array
     */
    private function data(): array
    {
        return array_filter($this->server, function ($key) {
            return $this->autoIncludeKey($key) || in_array($key, $this->includeKeys);
        }, ARRAY_FILTER_USE_KEY);
    }

    /**
     * @param  string  $key
     * @return bool
     */
    private function whitelistKey(string $key): bool
    {
        return in_array($key, self::KEY_WHITELIST);
    }

    /**
     * @param  string  $key
     * @return bool
     */
    private function httpKey(string $key): bool
    {
        return strpos($key, 'HTTP_') === 0;
    }

    /**
     * @param  string  $key
     * @return bool
     */
    private function autoIncludeKey(string $key): bool
    {
        return $this->whitelistKey($key) || $this->httpKey($key);
    }
}