<?php

/**
 * CommonFunctionsTest.php
 *
 * -Description-
 *
 * 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 3 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, see <https://www.gnu.org/licenses/>.
 *
 * @link       https://www.librenms.org
 *
 * @copyright  2016 Tony Murray
 * @author     Tony Murray <murraytony@gmail.com>
 */

namespace LibreNMS\Tests;

use App\Facades\LibrenmsConfig;
use Illuminate\Support\Str;
use LibreNMS\Enum\PortAssociationMode;
use LibreNMS\Util\Clean;
use LibreNMS\Util\StringHelpers;
use LibreNMS\Util\Validate;

final class CommonFunctionsTest extends TestCase
{
    public function testStrContains(): void
    {
        $data = 'This is a test. Just Testing.';

        $this->assertTrue(Str::contains($data, 'Just'));
        $this->assertFalse(Str::contains($data, 'just'));

        $this->assertTrue(Str::contains($data, 'juSt', ignoreCase: true));
        $this->assertFalse(Str::contains($data, 'nope', ignoreCase: true));

        $this->assertTrue(Str::contains($data, ['not', 'this', 'This']));
        $this->assertFalse(Str::contains($data, ['not', 'this']));

        $this->assertTrue(Str::contains($data, ['not', 'thIs'], ignoreCase: true));
        $this->assertFalse(Str::contains($data, ['not', 'anything'], ignoreCase: true));
    }

    public function testStartsWith(): void
    {
        $data = 'This is a test. Just Testing that.';

        $this->assertTrue(Str::startsWith($data, 'This'));
        $this->assertFalse(Str::startsWith($data, 'this'));

        $this->assertTrue(Str::startsWith($data, ['this', 'Test', 'This']));
        $this->assertFalse(Str::startsWith($data, ['this', 'Test']));
    }

    public function testEndsWith(): void
    {
        $data = 'This is a test. Just Testing';

        $this->assertTrue(Str::endsWith($data, 'Testing'));
        $this->assertFalse(Str::endsWith($data, 'testing'));

        $this->assertTrue(Str::endsWith($data, ['this', 'Testing', 'This']));
        $this->assertFalse(Str::endsWith($data, ['this', 'Test']));
    }

    public function testRrdDescriptions(): void
    {
        $data = 'Toner, S/N:CR_UM-16021314488.';
        $this->assertEquals('Toner, S/N CR_UM-16021314488.', \LibreNMS\Data\Store\Rrd::safeDescr($data));
    }

    public function testSetNull(): void
    {
        $this->assertNull(set_null('BAD-DATA'));
        $this->assertEquals(0, set_null(0));
        $this->assertEquals(25, set_null(25));
        $this->assertEquals(-25, set_null(-25));
        $this->assertEquals(99, set_null(' ', 99));
        $this->assertNull(set_null(-25, null, 0));
        $this->assertEquals(2, set_null(2, 0, 2));
    }

    public function testDisplay(): void
    {
        $this->assertEquals('&lt;html&gt;string&lt;/html&gt;', Clean::html('<html>string</html>', []));
        $this->assertEquals('&lt;script&gt;alert("test")&lt;/script&gt;', Clean::html('<script>alert("test")</script>', []));
        $this->assertEquals("Is your name O'reilly?", Clean::html("Is your name O\'reilly?", []));
        $this->assertEquals("Is your name O'reilly?", Clean::html("Is your name O\'reilly?"));
        $this->assertEquals('', Clean::html(''));
        $this->assertEquals('', Clean::html(null));

        $tmp_config = [
            'HTML.Allowed' => 'b,iframe,i,ul,li,h1,h2,h3,h4,br,p',
            'HTML.Trusted' => true,
            'HTML.SafeIframe' => true,
        ];

        $this->assertEquals('<b>Bold</b>', Clean::html('<b>Bold</b>', $tmp_config));
        $this->assertEquals('', Clean::html('<script>alert("test")</script>', $tmp_config));
    }

    public function testStringToClass(): void
    {
        $this->assertSame('LibreNMS\OS\Os', StringHelpers::toClass('OS', 'LibreNMS\\OS\\'));
        $this->assertSame('SpacesName', StringHelpers::toClass('spaces name', null));
        $this->assertSame('DashName', StringHelpers::toClass('dash-name', null));
        $this->assertSame('UnderscoreName', StringHelpers::toClass('underscore_name', null));
        $this->assertSame('LibreNMS\\AllOfThemName', StringHelpers::toClass('all OF-thEm_NaMe', 'LibreNMS\\'));
    }

    public function testIsValidHostname(): void
    {
        $this->assertTrue(Validate::hostname('a'), 'a');
        $this->assertTrue(Validate::hostname('a.'), 'a.');
        $this->assertTrue(Validate::hostname('0'), '0');
        $this->assertTrue(Validate::hostname('a.b'), 'a.b');
        $this->assertTrue(Validate::hostname('localhost'), 'localhost');
        $this->assertTrue(Validate::hostname('google.com'), 'google.com');
        $this->assertTrue(Validate::hostname('news.google.co.uk'), 'news.google.co.uk');
        $this->assertTrue(Validate::hostname('xn--fsqu00a.xn--0zwm56d'), 'xn--fsqu00a.xn--0zwm56d');
        $this->assertTrue(Validate::hostname('www.averylargedomainthatdoesnotreallyexist.com'), 'www.averylargedomainthatdoesnotreallyexist.com');
        $this->assertTrue(Validate::hostname('cont-ains.h-yph-en-s.com'), 'cont-ains.h-yph-en-s.com');
        $this->assertTrue(Validate::hostname('cisco-3750x'), 'cisco-3750x');
        $this->assertTrue(Validate::hostname('cisco_3750x'), 'cisco_3750x');
        $this->assertFalse(Validate::hostname('goo gle.com'), 'goo gle.com');
        $this->assertFalse(Validate::hostname('google..com'), 'google..com');
        $this->assertFalse(Validate::hostname('google.com '), 'google.com ');
        $this->assertFalse(Validate::hostname('google-.com'), 'google-.com');
        $this->assertFalse(Validate::hostname('.google.com'), '.google.com');
        $this->assertFalse(Validate::hostname('..google.com'), '..google.com');
        $this->assertFalse(Validate::hostname('<script'), '<script');
        $this->assertFalse(Validate::hostname('alert('), 'alert(');
        $this->assertFalse(Validate::hostname('.'), '.');
        $this->assertFalse(Validate::hostname('..'), '..');
        $this->assertFalse(Validate::hostname(' '), 'Just a space');
        $this->assertFalse(Validate::hostname('-'), '-');
        $this->assertFalse(Validate::hostname(''), 'Empty string');
    }

    public function testResolveGlues(): void
    {
        $this->dbSetUp();

        $this->assertFalse(ResolveGlues(['dbSchema'], 'device_id'));

        $this->assertSame(['devices.device_id'], ResolveGlues(['devices'], 'device_id'));
        $this->assertSame(['sensors.device_id'], ResolveGlues(['sensors'], 'device_id'));

        // does not work right with current code
//        $expected = array('bill_data.bill_id', 'bill_ports.port_id', 'ports.device_id');
//        $this->assertSame($expected, ResolveGlues(array('bill_data'), 'device_id'));

        $expected = ['application_metrics.app_id', 'applications.device_id'];
        $this->assertSame($expected, ResolveGlues(['application_metrics'], 'device_id'));

        $expected = ['state_translations.state_index_id', 'sensors_to_state_indexes.sensor_id', 'sensors.device_id'];
        $this->assertSame($expected, ResolveGlues(['state_translations'], 'device_id'));

        $expected = ['ipv4_addresses.port_id', 'ports.device_id'];
        $this->assertSame($expected, ResolveGlues(['ipv4_addresses'], 'device_id'));

        $this->dbTearDown();
    }

    public function testFormatHostname(): void
    {
        $device_dns = [
            'hostname' => 'test.librenms.org',
            'sysName' => 'Testing DNS',
        ];
        $invalid_dns = [
            'hostname' => 'Not DNS',
            'sysName' => 'Testing Invalid DNS',
        ];
        $device_ip = [
            'hostname' => '192.168.1.2',
            'sysName' => 'Testing IP',
        ];
        $invalid_ip = [
            'hostname' => '256.168.1.2',
            'sysName' => 'Testing Invalid IP',
        ];
        $custom_display = [
            'hostname' => 'test.librenms.org',
            'sysName' => 'sysName',
            'display' => 'Custom Display ({{ $hostname }} {{ $sysName }})',
        ];

        // default {{ $hostname }}
        LibrenmsConfig::set('device_display_default', null);
        $this->assertEquals('test.librenms.org', format_hostname($device_dns));
        $this->assertEquals('Not DNS', format_hostname($invalid_dns));
        $this->assertEquals('192.168.1.2', format_hostname($device_ip));
        $this->assertEquals('256.168.1.2', format_hostname($invalid_ip));
        $this->assertEquals('Custom Display (test.librenms.org sysName)', format_hostname($custom_display));

        // ip to sysname
        LibrenmsConfig::set('device_display_default', '{{ $sysName_fallback }}');
        $this->assertEquals('test.librenms.org', format_hostname($device_dns));
        $this->assertEquals('Not DNS', format_hostname($invalid_dns));
        $this->assertEquals('Testing IP', format_hostname($device_ip));
        $this->assertEquals('256.168.1.2', format_hostname($invalid_ip));
        $this->assertEquals('Custom Display (test.librenms.org sysName)', format_hostname($custom_display));

        // sysname
        LibrenmsConfig::set('device_display_default', '{{ $sysName }}');
        $this->assertEquals('Testing DNS', format_hostname($device_dns));
        $this->assertEquals('Testing Invalid DNS', format_hostname($invalid_dns));
        $this->assertEquals('Testing IP', format_hostname($device_ip));
        $this->assertEquals('Testing Invalid IP', format_hostname($invalid_ip));
        $this->assertEquals('Custom Display (test.librenms.org sysName)', format_hostname($custom_display));

        // custom
        $custom_ip = ['display' => 'IP: {{ $ip }}', 'hostname' => '1.1.1.1', 'ip' => '2.2.2.2'];
        $this->assertEquals('IP: 1.1.1.1', format_hostname($custom_ip));
        $custom_ip['hostname'] = 'not_ip';
        $this->assertEquals('IP: 2.2.2.2', format_hostname($custom_ip));
        $custom_ip['overwrite_ip'] = '3.3.3.3';
        $this->assertEquals('IP: 3.3.3.3', format_hostname($custom_ip));
    }

    public function testPortAssociation(): void
    {
        $modes = [
            1 => 'ifIndex',
            2 => 'ifName',
            3 => 'ifDescr',
            4 => 'ifAlias',
        ];

        $this->assertEquals($modes, PortAssociationMode::getModes());
        $this->assertEquals('ifIndex', PortAssociationMode::getName(1));
        $this->assertEquals(1, PortAssociationMode::getId('ifIndex'));
        $this->assertNull(PortAssociationMode::getName(666));
        $this->assertNull(PortAssociationMode::getId('lucifer'));
    }
}
