<?php
/**
 * iCalcreator, the PHP class package managing iCal (rfc2445/rfc5445) calendar information.
 *
 * This file is a part of iCalcreator.
 *
 * @author    Kjell-Inge Gustafsson, kigkonsult <ical@kigkonsult.se>
 * @copyright 2007-2022 Kjell-Inge Gustafsson, kigkonsult, All rights reserved
 * @link      https://kigkonsult.se
 * @license   Subject matter of licence is the software iCalcreator.
 *            The above copyright, link, package and version notices,
 *            this licence notice and the invariant [rfc5545] PRODID result use
 *            as implemented and invoked in iCalcreator shall be included in
 *            all copies or substantial portions of the iCalcreator.
 *
 *            iCalcreator is free software: you can redistribute it and/or modify
 *            it under the terms of the GNU Lesser General Public License as
 *            published by the Free Software Foundation, either version 3 of
 *            the License, or (at your option) any later version.
 *
 *            iCalcreator 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 Lesser General Public License for more details.
 *
 *            You should have received a copy of the GNU Lesser General Public License
 *            along with iCalcreator. If not, see <https://www.gnu.org/licenses/>.
 */
namespace Kigkonsult\Icalcreator;

use Exception;
use Kigkonsult\Icalcreator\Formatter\Property\Attendee;
use Kigkonsult\Icalcreator\Formatter\Property\Property;
use Kigkonsult\Icalcreator\Util\CalAddressFactory;
use Kigkonsult\Icalcreator\Util\DateIntervalFactory;
use Kigkonsult\Icalcreator\Util\DateTimeFactory;
use Kigkonsult\Icalcreator\Util\Util;

/**
 * class ValarmTest, testing Integers in
 *    PERCENT-COMPLETE    VTODO
 *    PRIORITY            VEVENT and VTODO
 *    SEQUENCE            VEVENT, VTODO, or VJOURNAL
 *    REPEAT              (VEVENT) VALARM
 *
 * @since  2.27.14 - 2019-01-24
 */
class ValarmTest extends DtBase
{
    /**
     * @var array|string[]
     */
    private static array $STCPAR = [ 'X-PARAM' => 'Y-vALuE' ];

    /**
     * valarmTest provider
     *
     * @return mixed[]
     * @throws Exception
     */
    public function valarmTestProvider() : array
    {
        $dataArr = [];

        // UID, optional in Valarm, rfc7094
        $uid = bin2hex( random_bytes( 16 )); // i.e. 32
        $dataArr[] = [
            101,
            IcalInterface::UID,
            $uid,
            self::$STCPAR,
            Pc::factory(
                $uid,
                self::$STCPAR
            ),
            Property::formatParams( self::$STCPAR ) . ':' . $uid
        ];

        // RELATED-TO
        $dataArr[] = [
            111,
            IcalInterface::RELATED_TO,
            null,
            self::$STCPAR,
            Pc::factory(
                '',
                []
            ),
            ':'
        ];

        $params = [ IcalInterface::RELTYPE => IcalInterface::SNOOZE ] + self::$STCPAR;
        $dataArr[] = [
            112,
            IcalInterface::RELATED_TO,
            $uid,
            $params,
            Pc::factory(
                $uid,
                $params
            ),
            Property::formatParams( $params ) . ':' . $uid
        ];

        // ACKNOWLEDGED
        $value     = DateTimeFactory::factory( DateTimeFactory::$AT . time(), IcalInterface::UTC );
        $dataArr[] = [
            121,
            IcalInterface::ACKNOWLEDGED,
            $value,
            self::$STCPAR,
            Pc::factory(
                clone $value,
                self::$STCPAR
            ),
            Property::formatParams( self::$STCPAR ) .
                $this->getDateTimeAsCreateLongString( $value, IcalInterface::UTC )
        ];

        // ACTION
        $dataArr[] = [
            131,
            IcalInterface::ACTION,
            null,
            self::$STCPAR,
            Pc::factory(
                '',
                []
            ),
            ':'
        ];

        $value = IcalInterface::AUDIO; // "DISPLAY" / "EMAIL
        $dataArr[] = [
            132,
            IcalInterface::ACTION,
            $value,
            self::$STCPAR,
            Pc::factory(
                $value,

                self::$STCPAR
            ),
            Property::formatParams( self::$STCPAR ) . ':' . $value
        ];

        // TRIGGER
        $dataArr[] = [
            141,
            IcalInterface::TRIGGER,
            null,
            self::$STCPAR,
            Pc::factory(
                '',
                []
            ),
            ':'
        ];

        $value = 'P1D';
        $dataArr[] = [
            142,
            IcalInterface::TRIGGER,
            $value,
            self::$STCPAR,
            Pc::factory(
                DateIntervalFactory::factory( $value ),
                self::$STCPAR
            ),
            Property::formatParams( self::$STCPAR ) . ':' . $value
        ];

        // DURATION
        $dataArr[] = [
            151,
            IcalInterface::DURATION,
            null,
            self::$STCPAR,
            Pc::factory(
                '',
                []
            ),
            ':'
        ];

        $value = 'P1D';
        $dataArr[] = [
            152,
            IcalInterface::DURATION,
            $value,
            self::$STCPAR,
            Pc::factory(
                DateIntervalFactory::factory( $value ),
                self::$STCPAR
            ),
            Property::formatParams( self::$STCPAR ) . ':' . $value
        ];

        // REPEAT
        $dataArr[] = [
            161,
            IcalInterface::REPEAT,
            null,
            self::$STCPAR,
            Pc::factory(
                '',
                []
            ),
            ':'
        ];

        $value = 3;
        $dataArr[] = [
            162,
            IcalInterface::REPEAT,
            $value,
            self::$STCPAR,
            Pc::factory(
                $value,
                self::$STCPAR
            ),
            Property::formatParams( self::$STCPAR ) . ':' . $value
        ];

        // ATTACH
        $getValue  = Pc::factory(
            '',
            []
        );
        $dataArr[] = [
            171,
            IcalInterface::ATTACH,
            null,
            self::$STCPAR,
            $getValue,
            ':'
        ];

        $value  = 'CID:jsmith.part3.960817T083000.xyzMail@example.com';
        $params = self::$STCPAR;
        $getValue  = Pc::factory(
            $value,
            $params
        );
        $dataArr[] = [
            172,
            IcalInterface::ATTACH,
            $value,
            $params,
            $getValue,
            Property::formatParams( $params ) . ':' . $value
        ];

        // ATTACH
        $value  = 'ftp://example.com/pub/reports/r-960812.ps';
        $params = [ IcalInterface::FMTTYPE => 'application/postscript' ] + self::$STCPAR;
        $getValue  = Pc::factory(
            $value,
            $params
        );
        $dataArr[] = [
            173,
            IcalInterface::ATTACH,
            $value,
            $params,
            $getValue,
            Property::formatParams( $params ) . ':' . $value
        ];

        // DESCRIPTION
        $dataArr[] = [
            181,
            IcalInterface::DESCRIPTION,
            null,
            self::$STCPAR,
            Pc::factory(
                '',
                []
            ),
            ':'
        ];

        $value  = 'Meeting to provide technical review for \'Phoenix\' design.\nHappy Face Conference Room. Phoenix design team MUST attend this meeting.\nRSVP to team leader.';
        $params = [
                IcalInterface::ALTREP   => 'http://example.org/altrep182.html',
                IcalInterface::LANGUAGE => 'EN'
            ] + self::$STCPAR;
        $dataArr[] = [
            182,
            IcalInterface::DESCRIPTION,
            $value,
            $params,
            Pc::factory(
                $value,
                $params
            ),
            Property::formatParams(
                $params,
                [ IcalInterface::ALTREP, IcalInterface::LANGUAGE ]
            ) . ':' . $value
        ];

        // PROXIMITY
        $dataArr[] = [
            191,
            IcalInterface::PROXIMITY,
            null,
            self::$STCPAR,
            Pc::factory(
                '',
                []
            ),
            ':'
        ];

        $dataArr[] = [
            192,
            IcalInterface::PROXIMITY,
            IcalInterface::ARRIVE,
            self::$STCPAR,
            Pc::factory(
                IcalInterface::ARRIVE,
                self::$STCPAR
            ),
            Property::formatParams( self::$STCPAR ) . ':' . IcalInterface::ARRIVE
        ];

        // STYLED-DESCRIPTION
        $dataArr[] = [
            201,
            IcalInterface::STYLED_DESCRIPTION,
            null,
            self::$STCPAR,
            Pc::factory(
                '',
                []
            ),
            ':'
        ];

        $value  = 'http://example.org/desc001.html';
        $params = [
                IcalInterface::VALUE    => IcalInterface::URI,
                IcalInterface::ALTREP   => 'http://example.org/altrep202.html', // skipped
                IcalInterface::LANGUAGE => 'EN'                                 // skipped
            ] + self::$STCPAR;
        $params2 = [
                IcalInterface::VALUE   => IcalInterface::URI,
                IcalInterface::DERIVED => IcalBase::FALSE
            ] + self::$STCPAR;
        $dataArr[] = [
            202,
            IcalInterface::STYLED_DESCRIPTION,
            $value,
            $params,
            Pc::factory(
                $value,
                $params2
            ),
            Property::formatParams(
                $params2,
                [ IcalInterface::ALTREP, IcalInterface::LANGUAGE ]
            ) . ':' . $value
        ];

        $value  = 'This is a longer styled description property with a number of meaningless words';
        $params = [
                IcalInterface::VALUE    => IcalInterface::TEXT,
                IcalInterface::ALTREP   => 'http://example.org/altrep203.html',
                IcalInterface::LANGUAGE => 'EN',
                IcalInterface::DERIVED  => IcalInterface::TRUE
            ] + self::$STCPAR;
        $dataArr[] = [
            203,
            IcalInterface::STYLED_DESCRIPTION,
            $value,
            $params,
            Pc::factory(
                $value,
                $params
            ),
            Property::formatParams(
                $params,
                [ IcalInterface::ALTREP, IcalInterface::LANGUAGE ]
            ) . ':' . $value
        ];

        // SUMMARY
        $dataArr[] = [
            211,
            IcalInterface::SUMMARY,
            null,
            self::$STCPAR,
            Pc::factory(
                '',
                []
            ),
            ':'
        ];

        $value  = 'Department Party';
        $params = [
                IcalInterface::ALTREP   => 'http://example.org/altrep212.html',
                IcalInterface::LANGUAGE => 'EN'
            ] + self::$STCPAR;
        $dataArr[] = [
            212,
            IcalInterface::SUMMARY,
            $value,
            $params,
            Pc::factory(
                $value,
                $params
            ),
            Property::formatParams(
                $params,
                [ IcalInterface::ALTREP, IcalInterface::LANGUAGE ]
            ) . ':' . $value
        ];

        // ATTENDEE
        $dataArr[] = [
            221,
            IcalInterface::ATTENDEE,
            null,
            self::$STCPAR,
            Pc::factory(
                '',
                []
            ),
            ':'
        ];

        $value  = 'MAILTO:ildoit@example.com';
        $params = self::$STCPAR;
        $getValue  = Pc::factory(
            CalAddressFactory::conformCalAddress( $value ),
            $params
        );
        $expectedString = trim( Attendee::format( IcalInterface::ATTENDEE, [ $getValue ], true ));
        $expectedString = str_replace( Util::$CRLF . ' ' , null, $expectedString);
        $expectedString = str_replace( '\,', ',', $expectedString );
        $expectedString = substr( $expectedString, 8 );
        $dataArr[] = [
            222,
            IcalInterface::ATTENDEE,
            $value,
            $params,
            $getValue,
            $expectedString
        ];

        /*
         *  x-prop ??
         */

        return $dataArr;
    }

    /**
     * valarmTest provider TEST multi Valarms
     *
     * @return mixed[]
     */
    public function valarmTestProviderTest() : array
    {
        $dataArr = [];

        $value  = 'Meeting to provide....';
        $params = [];
        $dataArr[] = [
            9999,
            IcalInterface::DESCRIPTION,
            $value,
            $params,
            Pc::factory(
                $value,
                $params
            ),
            Property::formatParams(
                $params,
                [ IcalInterface::ALTREP, IcalInterface::LANGUAGE ]
            ) . ':' . $value
        ];

        return $dataArr;
    }

    /**
     * Testing Valarm
     *
     * @test
     * @dataProvider valarmTestProvider
     * @ // dataProvider valarmTestProviderTest
     * @param int|string $caseIn
     * @param string $propName
     * @param mixed  $value
     * @param mixed  $params
     * @param Pc     $expectedGet
     * @param string $expectedString
     * @throws Exception
     */
    public function valarmTest(
        int|string $caseIn,
        string $propName,
        mixed  $value,
        mixed  $params,
        Pc     $expectedGet,
        string $expectedString
    ) : void
    {
        static $MULTIPROPS = [
            IcalInterface::ATTACH,
            IcalInterface::ATTENDEE,
            IcalInterface::DESCRIPTION,
            IcalInterface::RELATED_TO,
            IcalInterface::STYLED_DESCRIPTION
        ];
        static $pcInput = false;

        $c       = new Vcalendar();
        for( $cix = 0; $cix < 2; $cix++ ) {
            if( 0 === $cix ) {
                $comp = $c->newVevent();
            }
            else {
                $comp = $c->newVtodo();
            }
            $case = $caseIn . '-' . ( 1 + $cix);
            $comp->setXprop( 'x-case', $case )
                ->setXprop( 'x-time', self::getYmdHisDate());

            $a1 = $comp->newValarm()
                ->setXprop( 'x-case', $case )
                ->setXprop( 'x-time', self::getYmdHisDate());

            if( IcalInterface::DESCRIPTION === $propName ) {
                $vLocation1 = $a1->newVlocation( 'Office1' )
                    ->setDescription( $value, $params )
                    ->setXprop( 'x-time', self::getYmdHisDate())
                    ->setXprop( 'x-case', $case . ' location 1' ); // by-pass test
                $vLocation2 = $a1->newVlocation( 'Office2' )
                    ->setDescription( $value, $params )
                    ->setXprop( 'x-time', self::getYmdHisDate())
                    ->setXprop( 'x-case', $case . ' location 2' ); // by-pass test
            }

            [ $createMethod, $deleteMethod, $getMethod, $isMethod, $setMethod ] = self::getPropMethodnames( $propName );
            if( IcalInterface::UID !== $propName ) { // always (sort of...) set
                $this->assertFalse(
                    $a1->{$isMethod}(),
                    self::getErrMsg(  null, $case . '-1', __FUNCTION__, IcalInterface::VALARM, $isMethod )
                );
            }

            // set first
            if( $pcInput ) {
                $a1->{$setMethod}( Pc::factory( $value, $params ));
            }
            else {
                $a1->{$setMethod}( $value, $params );
            }
            $this->assertSame(
                ! empty( $value ),
                $a1->{$isMethod}(),
                self::getErrMsg(  null, $case . '-2', __FUNCTION__, IcalInterface::VALARM, $isMethod )
                    . ', exp: ' . ( empty( $value ) ? IcalInterface::FALSE : IcalInterface::TRUE )
            );

            $getValue = ( in_array( $propName, $MULTIPROPS, true ))
                ? $a1->{$getMethod}( null, true )
                : $a1->{$getMethod}( true );
            $this->assertEquals(
                $expectedGet,
                $getValue,
                self::getErrMsg(  null, $case . '-3', __FUNCTION__, IcalInterface::VALARM, $getMethod )
            );
            $actualString = $a1->{$createMethod}();
            $actualString = str_replace( [ Util::$CRLF . ' ', Util::$CRLF ], '', $actualString );
            $actualString = str_replace( '\,', ',', $actualString );
            $this->assertEquals(
                strtoupper( $propName ) . $expectedString,
                trim( $actualString ),
                self::getErrMsg(  null, $case . '-4', __FUNCTION__, 'Valarm', $createMethod )
            );
            if( $propName !== IcalInterface::UID ) { // sort of mandatory....
                $a1->{$deleteMethod}();
                $this->assertFalse(
                    $a1->{$isMethod}(),
                    self::getErrMsg(  '(after delete) ', $case . '-5', __FUNCTION__, 'Valarm', $isMethod )
                );
                $this->assertFalse(
                    $a1->{$getMethod}(),
                    self::getErrMsg(  '(after delete) ', $case . '-6', __FUNCTION__, 'Valarm', $getMethod )
                );
                $a1->{$setMethod}( $value, $params ); // set again
                $expected = ! empty( $value );
                $this->assertSame(
                    $expected,
                    $a1->{$isMethod}(),
                    self::getErrMsg(  '(exp ' .
                        ( $expected ? IcalInterface::TRUE : IcalInterface::FALSE ) .
                        ' after set) ', $case . '-7', __FUNCTION__, 'Valarm', $isMethod )
                    . PHP_EOL . ' iCal string ' . $a1->{$createMethod}() // test ###

                );
            } // end if propName !== UID

            $this->parseCalendarTest( $case, $c, $expectedString );

            // clone $a1 into 2 (incl cloned subs)
            $subs = [];
            while( $sub = $a1->getComponent()) { // return clone
                $subs[] = $sub;
            }
            $x = 1;
            while( $a1->deleteComponent( $x )) {
                ++$x;
            }
            $a11 = clone $a1;
            $a11->setXprop( 'x-clone', $case . ' clone 1' );
            $a12 = clone $a1;
            $a12->setXprop( 'x-clone', $case . ' clone 2' );
            foreach( $subs as $six => $sub ) {
                $sub->setXprop( 'x-clone', $case . ' clone ' . $six . '-1' );
                $a11->addSubComponent( $sub ); // set clone
                $sub->setXprop( 'x-clone', $case . ' clone ' . $six . '-2' );
                $a12->addSubComponent( $sub );
            }

            $compArr = [ $a11, $a12 ];
            $x = 1;
            while( $comp->deleteComponent( $x )) {
                ++$x;
            }
            $this->assertSame(
                0, $comp->countComponents(), $case .  '-5 deleteComponent-error 2, has ' . $comp->countComponents()
            );
            // set the cloned components
            foreach( $compArr as $subComp ) {
                $comp->setComponent( $subComp );
            }
            // check number of components
            $this->assertSame(
                count( $compArr ), $comp->countComponents(), $case .  '-6 setComponent-error 3, has ' . $comp->countComponents()
            );

        } // end for
    }

    private static function getYmdHisDate() : string
    {
        return DateTimeFactory::factory()->format( DateTimeFactory::$YmdHis );
    }
}