<?php

/*
 *
 * File ini bagian dari:
 *
 * OpenSID
 *
 * Sistem informasi desa sumber terbuka untuk memajukan desa
 *
 * Aplikasi dan source code ini dirilis berdasarkan lisensi GPL V3
 *
 * Hak Cipta 2009 - 2015 Combine Resource Institution (http://lumbungkomunitas.net/)
 * Hak Cipta 2016 - 2025 Perkumpulan Desa Digital Terbuka (https://opendesa.id)
 *
 * Dengan ini diberikan izin, secara gratis, kepada siapa pun yang mendapatkan salinan
 * dari perangkat lunak ini dan file dokumentasi terkait ("Aplikasi Ini"), untuk diperlakukan
 * tanpa batasan, termasuk hak untuk menggunakan, menyalin, mengubah dan/atau mendistribusikan,
 * asal tunduk pada syarat berikut:
 *
 * Pemberitahuan hak cipta di atas dan pemberitahuan izin ini harus disertakan dalam
 * setiap salinan atau bagian penting Aplikasi Ini. Barang siapa yang menghapus atau menghilangkan
 * pemberitahuan ini melanggar ketentuan lisensi Aplikasi Ini.
 *
 * PERANGKAT LUNAK INI DISEDIAKAN "SEBAGAIMANA ADANYA", TANPA JAMINAN APA PUN, BAIK TERSURAT MAUPUN
 * TERSIRAT. PENULIS ATAU PEMEGANG HAK CIPTA SAMA SEKALI TIDAK BERTANGGUNG JAWAB ATAS KLAIM, KERUSAKAN ATAU
 * KEWAJIBAN APAPUN ATAS PENGGUNAAN ATAU LAINNYA TERKAIT APLIKASI INI.
 *
 * @package   OpenSID
 * @author    Tim Pengembang OpenDesa
 * @copyright Hak Cipta 2009 - 2015 Combine Resource Institution (http://lumbungkomunitas.net/)
 * @copyright Hak Cipta 2016 - 2025 Perkumpulan Desa Digital Terbuka (https://opendesa.id)
 * @license   http://www.gnu.org/licenses/gpl.html GPL V3
 * @link      https://github.com/OpenSID/OpenSID
 *
 */

namespace App\Libraries;

/**
 * User Agent Class
 *
 * Identifies the platform, browser, robot, or mobile device of the browsing agent
 *
 * @category	User Agent
 *
 * @see		https://codeigniter.com/userguide3/libraries/user_agent.html
 */
class UserAgent
{
    /**
     * Current user-agent
     *
     * @var string
     */
    public $agent;

    /**
     * Flag for if the user-agent belongs to a browser
     *
     * @var bool
     */
    public $is_browser = false;

    /**
     * Flag for if the user-agent is a robot
     *
     * @var bool
     */
    public $is_robot = false;

    /**
     * Flag for if the user-agent is a mobile browser
     *
     * @var bool
     */
    public $is_mobile = false;

    /**
     * Languages accepted by the current user agent
     *
     * @var array
     */
    public $languages = [];

    /**
     * Character sets accepted by the current user agent
     *
     * @var array
     */
    public $charsets = [];

    /**
     * List of platforms to compare against current user agent
     *
     * @var array
     */
    public $platforms = [];

    /**
     * List of browsers to compare against current user agent
     *
     * @var array
     */
    public $browsers = [];

    /**
     * List of mobile browsers to compare against current user agent
     *
     * @var array
     */
    public $mobiles = [];

    /**
     * List of robots to compare against current user agent
     *
     * @var array
     */
    public $robots = [];

    /**
     * Current user-agent platform
     *
     * @var string
     */
    public $platform = '';

    /**
     * Current user-agent browser
     *
     * @var string
     */
    public $browser = '';

    /**
     * Current user-agent version
     *
     * @var string
     */
    public $version = '';

    /**
     * Current user-agent mobile name
     *
     * @var string
     */
    public $mobile = '';

    /**
     * Current user-agent robot name
     *
     * @var string
     */
    public $robot = '';

    /**
     * HTTP Referer
     *
     * @var mixed
     */
    public $referer;

    // --------------------------------------------------------------------

    /**
     * Constructor
     *
     * Sets the User Agent and runs the compilation routine
     *
     * @return void
     */
    public function __construct()
    {
        $this->_load_agent_file();

        if (isset($_SERVER['HTTP_USER_AGENT'])) {
            $this->agent = trim((string) $_SERVER['HTTP_USER_AGENT']);
            $this->_compile_data();
        }
    }

    // --------------------------------------------------------------------

    /**
     * Is Browser
     *
     * @param string $key
     *
     * @return bool
     */
    public function is_browser($key = null)
    {
        if ( ! $this->is_browser) {
            return false;
        }

        // No need to be specific, it's a browser
        if ($key === null) {
            return true;
        }

        // Check for a specific browser
        return isset($this->browsers[$key]) && $this->browser === $this->browsers[$key];
    }

    // --------------------------------------------------------------------

    /**
     * Is Robot
     *
     * @param string $key
     *
     * @return bool
     */
    public function is_robot($key = null)
    {
        if ( ! $this->is_robot) {
            return false;
        }

        // No need to be specific, it's a robot
        if ($key === null) {
            return true;
        }

        // Check for a specific robot
        return isset($this->robots[$key]) && $this->robot === $this->robots[$key];
    }

    // --------------------------------------------------------------------

    /**
     * Is Mobile
     *
     * @param string $key
     *
     * @return bool
     */
    public function is_mobile($key = null)
    {
        if ( ! $this->is_mobile) {
            return false;
        }

        // No need to be specific, it's a mobile
        if ($key === null) {
            return true;
        }

        // Check for a specific robot
        return isset($this->mobiles[$key]) && $this->mobile === $this->mobiles[$key];
    }

    // --------------------------------------------------------------------

    /**
     * Is this a referral from another site?
     *
     * @return bool
     */
    public function is_referral()
    {
        if ( $this->referer === null) {
            if (empty($_SERVER['HTTP_REFERER'])) {
                $this->referer = false;
            } else {
                $referer_host = @parse_url((string) $_SERVER['HTTP_REFERER'], PHP_URL_HOST);
                $own_host     = parse_url((string) config_item('base_url'), PHP_URL_HOST);

                $this->referer = ($referer_host && $referer_host !== $own_host);
            }
        }

        return $this->referer;
    }

    // --------------------------------------------------------------------

    /**
     * Agent String
     *
     * @return string
     */
    public function agent_string()
    {
        return $this->agent;
    }

    // --------------------------------------------------------------------

    /**
     * Get Platform
     *
     * @return string
     */
    public function platform()
    {
        return $this->platform;
    }

    // --------------------------------------------------------------------

    /**
     * Get Browser Name
     *
     * @return string
     */
    public function browser()
    {
        return $this->browser;
    }

    // --------------------------------------------------------------------

    /**
     * Get the Browser Version
     *
     * @return string
     */
    public function version()
    {
        return $this->version;
    }

    // --------------------------------------------------------------------

    /**
     * Get The Robot Name
     *
     * @return string
     */
    public function robot()
    {
        return $this->robot;
    }
    // --------------------------------------------------------------------

    /**
     * Get the Mobile Device
     *
     * @return string
     */
    public function mobile()
    {
        return $this->mobile;
    }

    // --------------------------------------------------------------------
    /**
     * Get the referrer
     */
    public function referrer(): string
    {
        return empty($_SERVER['HTTP_REFERER']) ? '' : trim((string) $_SERVER['HTTP_REFERER']);
    }

    // --------------------------------------------------------------------

    /**
     * Get the accepted languages
     *
     * @return array
     */
    public function languages()
    {
        if (count($this->languages) === 0) {
            $this->_set_languages();
        }

        return $this->languages;
    }

    // --------------------------------------------------------------------

    /**
     * Get the accepted Character Sets
     *
     * @return array
     */
    public function charsets()
    {
        if (count($this->charsets) === 0) {
            $this->_set_charsets();
        }

        return $this->charsets;
    }

    // --------------------------------------------------------------------
    /**
     * Test for a particular language
     *
     * @param string $lang
     */
    public function accept_lang($lang = 'en'): bool
    {
        return in_array(strtolower($lang), $this->languages(), true);
    }

    // --------------------------------------------------------------------
    /**
     * Test for a particular character set
     *
     * @param string $charset
     */
    public function accept_charset($charset = 'utf-8'): bool
    {
        return in_array(strtolower($charset), $this->charsets(), true);
    }

    // --------------------------------------------------------------------
    /**
     * Parse a custom user-agent string
     *
     * @param string $string
     */
    public function parse($string): void
    {
        // Reset values
        $this->is_browser = false;
        $this->is_robot   = false;
        $this->is_mobile  = false;
        $this->browser    = '';
        $this->version    = '';
        $this->mobile     = '';
        $this->robot      = '';

        // Set the new user-agent string and parse it, unless empty
        $this->agent = $string;

        if ( ! empty($string)) {
            $this->_compile_data();
        }
    }

    // --------------------------------------------------------------------

    /**
     * Compile the User Agent Data
     *
     * @return bool
     */
    protected function _load_agent_file()
    {
        $configAgent     = config('user_agents');
        $this->platforms = $configAgent['platforms'];
        $this->browsers  = $configAgent['browsers'];
        $this->mobiles   = $configAgent['mobiles'];
        $this->robots    = $configAgent['robots'];
    }

    // --------------------------------------------------------------------

    /**
     * Compile the User Agent Data
     *
     * @return bool
     */
    protected function _compile_data()
    {
        $this->_set_platform();

        foreach (['_set_robot', '_set_browser', '_set_mobile'] as $function) {
            if ($this->{$function}() === true) {
                break;
            }
        }
    }

    // --------------------------------------------------------------------
    /**
     * Set the Platform
     */
    protected function _set_platform(): bool
    {
        if (is_array($this->platforms) && $this->platforms !== []) {
            foreach ($this->platforms as $key => $val) {
                if (preg_match('|' . preg_quote($key) . '|i', $this->agent)) {
                    $this->platform = $val;

                    return true;
                }
            }
        }

        $this->platform = 'Unknown Platform';

        return false;
    }

    // --------------------------------------------------------------------
    /**
     * Set the Browser
     */
    protected function _set_browser(): bool
    {
        if (is_array($this->browsers) && $this->browsers !== []) {
            foreach ($this->browsers as $key => $val) {
                if (preg_match('|' . $key . '.*?([0-9\.]+)|i', $this->agent, $match)) {
                    $this->is_browser = true;
                    $this->version    = $match[1];
                    $this->browser    = $val;
                    $this->_set_mobile();

                    return true;
                }
            }
        }

        return false;
    }

    // --------------------------------------------------------------------
    /**
     * Set the Robot
     */
    protected function _set_robot(): bool
    {
        if (is_array($this->robots) && $this->robots !== []) {
            foreach ($this->robots as $key => $val) {
                if (preg_match('|' . preg_quote($key) . '|i', $this->agent)) {
                    $this->is_robot = true;
                    $this->robot    = $val;
                    $this->_set_mobile();

                    return true;
                }
            }
        }

        return false;
    }

    // --------------------------------------------------------------------
    /**
     * Set the Mobile Device
     */
    protected function _set_mobile(): bool
    {
        if (is_array($this->mobiles) && $this->mobiles !== []) {
            foreach ($this->mobiles as $key => $val) {
                if (false !== (stripos($this->agent, (string) $key))) {
                    $this->is_mobile = true;
                    $this->mobile    = $val;

                    return true;
                }
            }
        }

        return false;
    }

    // --------------------------------------------------------------------

    /**
     * Set the accepted languages
     *
     * @return void
     */
    protected function _set_languages()
    {
        if ((count($this->languages) === 0) && ! empty($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
            $this->languages = explode(',', (string) preg_replace('/(;\s?q=[0-9\.]+)|\s/i', '', strtolower(trim((string) $_SERVER['HTTP_ACCEPT_LANGUAGE']))));
        }

        if (count($this->languages) === 0) {
            $this->languages = ['Undefined'];
        }
    }

    // --------------------------------------------------------------------

    /**
     * Set the accepted character sets
     *
     * @return void
     */
    protected function _set_charsets()
    {
        if ((count($this->charsets) === 0) && ! empty($_SERVER['HTTP_ACCEPT_CHARSET'])) {
            $this->charsets = explode(',', (string) preg_replace('/(;\s?q=.+)|\s/i', '', strtolower(trim((string) $_SERVER['HTTP_ACCEPT_CHARSET']))));
        }

        if (count($this->charsets) === 0) {
            $this->charsets = ['Undefined'];
        }
    }
}
