<?php

/*
 * Copyright (C) 2020-2026 Deciso B.V.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

namespace OPNsense\Base\FieldTypes;

/**
 * Protocol field type
 * @package OPNsense\Base\FieldTypes
 */
class ProtocolField extends BaseListField
{
    protected $internalChangeCase = 'UPPER';

    private $additionalOptions = [];

    /**
     * setter for maximum value
     * @param integer $value
     */
    public function setAddOptions($value)
    {
        if (is_array($value)) {
            $this->additionalOptions = $value;
        }
    }

    /**
     * generate validation data (list of protocols)
     */
    protected function actionPostLoadingEvent()
    {
        /* IPv6 extension headers are skipped by the packet filter, we cannot police them */
        $ipv6_ext = ['IPV6-ROUTE', 'IPV6-FRAG', 'IPV6-OPTS', 'IPV6-NONXT', 'MOBILITY-HEADER'];

        /* protocols that should be listed as priority if in the final list */
        $prio_set = ['TCP', 'UDP', 'TCP/UDP', 'ICMP', 'ESP', 'AH', 'GRE', 'IGMP', 'PIM', 'OSPF'];

        /* construct option hash to avoid repopulating options multiple times */
        $opt_hash = empty($this->additionalOptions) ? hash('sha256', json_encode($this->additionalOptions)) : '-';
        $opt_hash .= $this->internalIsRequired ? 'R' : 'O';
        $opt_hash .= $this->internalChangeCase;

        if ($this->hasStaticOptions($opt_hash)) {
            $this->internalOptionList = $this->getStaticOptions($opt_hash);
            return;
        }

        $any_label = gettext('any');
        $new_list = [];

        /* populate generic protocol options */
        foreach (explode("\n", file_get_contents('/etc/protocols')) as $line) {
            if (substr($line, 0, 1) != "#") {
                $parts = preg_split('/\s+/', $line);
                if (count($parts) >= 4 && $parts[1] > 0) {
                    $protocol = $this->applyChangeCase($parts[0]);
                    if (in_array(strtoupper($protocol), $ipv6_ext)) {
                        continue;
                    }
                    $new_list[$protocol] = strtoupper($protocol);
                }
            }
        }

        /* append additional options */
        foreach ($this->additionalOptions as $prop => $value) {
            /* allow overwriting all values, but make sure 'any' is lowercase and prepended last */
            if (strtolower($prop) == 'any') {
                $any_label = $value;
                continue;
            }

            $new_list[$this->applyChangeCase($prop)] = $value;
        }

        /* sort backwards to append 'any' last if needed */
        arsort($new_list, SORT_NATURAL | SORT_FLAG_CASE);

        foreach (array_reverse($prio_set) as $prio) {
            $prio = $this->applyChangeCase($prio);
            if (isset($new_list[$prio])) {
                $temp = $new_list[$prio];
                unset($new_list[$prio]);
                $new_list[$prio] = $temp;
            }
        }

        if ($this->internalIsRequired) {
            /* 'any' is not treated with ChangeCase for backwards compatibility  */
            $new_list['any'] = $any_label;
        }

        /* reverse and store the result */
        $this->internalOptionList = $this->setStaticOptions(array_reverse($new_list, true), $opt_hash);
    }

    /**
     * {@inheritdoc}
     */
    public function setValue($value)
    {
        $new_value = strtolower((string)$value) == 'any' ?
            strtolower((string)$value) : $this->applyChangeCase($value);

        /* if first set and not altered by the user, store initial value */
        if ($this->internalFieldLoaded === false && $this->internalInitialValue === false) {
            $this->internalInitialValue = $new_value;
        }

        $this->internalValue = $new_value;
    }
}
