<?php
    /*********************************************************************************
     * Zurmo is a customer relationship management program developed by
     * Zurmo, Inc. Copyright (C) 2017 Zurmo Inc.
     *
     * Zurmo is free software; you can redistribute it and/or modify it under
     * the terms of the GNU Affero General Public License version 3 as published by the
     * Free Software Foundation with the addition of the following permission added
     * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
     * IN WHICH THE COPYRIGHT IS OWNED BY ZURMO, ZURMO DISCLAIMS THE WARRANTY
     * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
     *
     * Zurmo 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 Affero General Public License for more
     * details.
     *
     * You should have received a copy of the GNU Affero General Public License along with
     * this program; if not, see http://www.gnu.org/licenses or write to the Free
     * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
     * 02110-1301 USA.
     *
     * You can contact Zurmo, Inc. with a mailing address at 27 North Wacker Drive
     * Suite 370 Chicago, IL 60606. or at email address contact@zurmo.com.
     *
     * The interactive user interfaces in original and modified versions
     * of this program must display Appropriate Legal Notices, as required under
     * Section 5 of the GNU Affero General Public License version 3.
     *
     * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
     * these Appropriate Legal Notices must retain the display of the Zurmo
     * logo and Zurmo copyright notice. If the display of the logo is not reasonably
     * feasible for technical reasons, the Appropriate Legal Notices must display the words
     * "Copyright Zurmo Inc. 2017. All rights reserved".
     ********************************************************************************/

    /**
     * Walkthrough test for when required attributes are not placed and should be before a view can be accessed.
     */
    class RequiredAttributesViewValidityWalkthroughTest extends ZurmoWalkthroughBaseTest
    {
        public static $activateDefaultLanguages = true;

        public static function setUpBeforeClass()
        {
            parent::setUpBeforeClass();
            SecurityTestHelper::createSuperAdmin();
            ContactsModule::loadStartingData();
            $super = User::getByUsername('super');
            Yii::app()->user->userModel = $super;
        }

        public function testRequiredAttributesAreMissingFromLayout()
        {
            $super = $this->logoutCurrentUserLoginNewUserAndGetByUsername('super');
            $account = AccountTestHelper::createAccountByNameForOwner('aTestAccount', $super);
            $content = $this->runControllerWithNoExceptionsAndGetContent('accounts/default/create');
            $this->assertNotContains('There are required fields missing from the following layout', $content);
            $content = $this->runControllerWithNoExceptionsAndGetContent('accounts/default/list');
            $this->assertNotContains('There are required fields missing from the following layout', $content);
            $this->setGetArray (array('id' => $account->id));
            $content = $this->runControllerWithNoExceptionsAndGetContent('accounts/default/edit');
            $this->assertNotContains('There are required fields missing from the following layout', $content);

            //Now create an attribute that is required.
            $this->createTextCustomFieldByModule('AccountsModule', 'text');

            $content = $this->runControllerWithExitExceptionAndGetContent('accounts/default/create');
            $this->assertContains('There are required fields missing from the following layout', $content);
            $content = $this->runControllerWithNoExceptionsAndGetContent('accounts/default/list');
            $this->assertNotContains('There are required fields missing from the following layout', $content);
            $this->setGetArray (array('id' => $account->id));
            $content = $this->runControllerWithExitExceptionAndGetContent('accounts/default/edit');
            $this->assertContains('There are required fields missing from the following layout', $content);

            //Remove the new field.
            $modelAttributesAdapterClassName = TextAttributeForm::getModelAttributeAdapterNameForSavingAttributeFormData();
            $adapter = new $modelAttributesAdapterClassName(new Account());
            $adapter->removeAttributeMetadata('text');
            RequiredAttributesValidViewUtil::resolveToRemoveAttributeAsMissingRequiredAttribute('Account', 'text');
            $account = new Account();
            $this->assertFalse($account->isAttribute('text'));
            unset($account);
        }

        /**
         * @depends testRequiredAttributesAreMissingFromLayout
         */
        public function testMakingAlreadyPlacedNonrequiredStandardAttributeRequiredAndThenMakingItUnrequired()
        {
            $super   = $this->logoutCurrentUserLoginNewUserAndGetByUsername('super');
            $content = $this->runControllerWithNoExceptionsAndGetContent('accounts/default/create');
            $this->assertNotContains('There are required fields missing from the following layout', $content);

            //Now make industry required.
            $attributeForm = AttributesFormFactory::createAttributeFormByAttributeName(new Account(), 'industry');
            $this->assertFalse($attributeForm->isRequired);
            $attributeForm->isRequired       = true;
            $modelAttributesAdapterClassName = $attributeForm::getModelAttributeAdapterNameForSavingAttributeFormData();
            $adapter = new $modelAttributesAdapterClassName(new Account());
            try
            {
                $adapter->setAttributeMetadataFromForm($attributeForm);
            }
            catch (FailedDatabaseSchemaChangeException $e)
            {
                echo $e->getMessage();
                $this->fail();
            }
            RequiredAttributesValidViewUtil::resolveToSetAsMissingRequiredAttributesByModelClassName('Account', 'industry');
            RedBeanModelsCache::forgetAll();

            $content = $this->runControllerWithNoExceptionsAndGetContent('accounts/default/create');
            $this->assertNotContains('There are required fields missing from the following layout', $content);

            //Now make industry unrequired.
            $attributeForm = AttributesFormFactory::createAttributeFormByAttributeName(new Account(), 'industry');
            $this->assertTrue($attributeForm->isRequired);
            $attributeForm->isRequired       = false;
            $modelAttributesAdapterClassName = $attributeForm::getModelAttributeAdapterNameForSavingAttributeFormData();
            $adapter = new $modelAttributesAdapterClassName(new Account());
            try
            {
                $adapter->setAttributeMetadataFromForm($attributeForm);
            }
            catch (FailedDatabaseSchemaChangeException $e)
            {
                echo $e->getMessage();
                $this->fail();
            }
            RequiredAttributesValidViewUtil::resolveToRemoveAttributeAsMissingRequiredAttribute('Account', 'industry');
            RedBeanModelsCache::forgetAll();

            //Confirm industry is truly unrequired.
            $attributeForm = AttributesFormFactory::createAttributeFormByAttributeName(new Account(), 'industry');
            $this->assertFalse($attributeForm->isRequired);

            //Now the layout should not show an error message.
            $content = $this->runControllerWithNoExceptionsAndGetContent('accounts/default/create');
            $this->assertNotContains('There are required fields missing from the following layout', $content);
        }

        /**
         * @depends testMakingAlreadyPlacedNonrequiredStandardAttributeRequiredAndThenMakingItUnrequired
         */
        public function testRequiredContactAttributesProperlyAreRequiredToBePlacedInLeadLayouts()
        {
            $super = $this->logoutCurrentUserLoginNewUserAndGetByUsername('super');
            $contact = ContactTestHelper::createContactByNameForOwner('aTestContact', $super);
            $lead    = LeadTestHelper::createLeadByNameForOwner('aTestLead', $super);
            $content = $this->runControllerWithNoExceptionsAndGetContent('contacts/default/create');
            $this->assertNotContains('There are required fields missing from the following layout', $content);
            $content = $this->runControllerWithNoExceptionsAndGetContent('contacts/default/list');
            $this->assertNotContains('There are required fields missing from the following layout', $content);
            $this->setGetArray (array('id' => $contact->id));
            $content = $this->runControllerWithNoExceptionsAndGetContent('contacts/default/edit');
            $this->assertNotContains('There are required fields missing from the following layout', $content);
            //Now check lead layouts.
            $content = $this->runControllerWithNoExceptionsAndGetContent('leads/default/create');
            $this->assertNotContains('There are required fields missing from the following layout', $content);
            $content = $this->runControllerWithNoExceptionsAndGetContent('leads/default/list');
            $this->assertNotContains('There are required fields missing from the following layout', $content);
            $this->setGetArray (array('id' => $lead->id));
            $content = $this->runControllerWithNoExceptionsAndGetContent('leads/default/edit');
            $this->assertNotContains('There are required fields missing from the following layout', $content);

            //Now create an attribute that is required.
            $this->createTextCustomFieldByModule('ContactsModule', 'text');

            $content = $this->runControllerWithExitExceptionAndGetContent('contacts/default/create');
            $this->assertContains('There are required fields missing from the following layout', $content);
            $content = $this->runControllerWithNoExceptionsAndGetContent('contacts/default/list');
            $this->assertNotContains('There are required fields missing from the following layout', $content);
            $this->setGetArray (array('id' => $contact->id));
            $content = $this->runControllerWithExitExceptionAndGetContent('contacts/default/edit');
            $this->assertContains('There are required fields missing from the following layout', $content);
            //Now check lead layouts. They should follow the same pattern as contacts.
            $content = $this->runControllerWithExitExceptionAndGetContent('leads/default/create');
            $this->assertContains('There are required fields missing from the following layout', $content);
            $content = $this->runControllerWithNoExceptionsAndGetContent('leads/default/list');
            $this->assertNotContains('There are required fields missing from the following layout', $content);
            $this->setGetArray (array('id' => $lead->id));
            $content = $this->runControllerWithExitExceptionAndGetContent('leads/default/edit');
            $this->assertContains('There are required fields missing from the following layout', $content);
        }

        //todo: test note inlineEditSave
        //todo: testing calculated and dependent dropdown attributes, that they do not affect this at all.
        //todo: test out multiple custom fields not placed, make sure array of config for RequiredAttributesValidViewUtil is working ok.
    }
?>