<?php
/**
 *  File for the TestCase class
 *
 *  (PHP 5)
 *
 *   @author Walt Haas <walt@dharmatech.org> (801) 534-1262
 *   @copyright Copyright CiviCRM LLC (C) 2009
 *   @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html
 *              GNU Affero General Public License version 3
 *   @version   $Id: ActivityTest.php 31254 2010-12-15 10:09:29Z eileen $
 *   @package   CiviCRM
 *
 *   This file is part of CiviCRM
 *
 *   CiviCRM is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU Affero General Public License
 *   as published by the Free Software Foundation; either version 3 of
 *   the License, or (at your option) any later version.
 *
 *   CiviCRM 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/>.
 */

/**
 *  Include class definitions
 */
require_once 'CiviTest/CiviUnitTestCase.php';

/**
 *  Test APIv3 civicrm_case_* functions
 *
 *  @package CiviCRM_APIv3
 */
class api_v3_CaseTest extends CiviUnitTestCase {
  protected $_params;
  protected $_entity;
  protected $_apiversion =3;
  protected $followup_activity_type_value;
  protected $caseTypeId;
  protected $caseStatusGroup;
  protected $caseTypeGroup;
  protected $optionValues;

  /**
   *  Test setup for every test
   *
   *  Connect to the database, truncate the tables that will be used
   *  and redirect stdin to a temporary file
   */
  public function setUp() {
    $this->_entity = 'case';

    parent::setUp();
    // CRM-9404 - set-up is a bit cumbersome but had to put something in place to set up activity types & case types
    //. Using XML was causing breakage as id numbers were changing over time
    // & was really hard to troubleshoot as involved truncating option_value table to mitigate this & not leaving DB in a
    // state where tests could run afterwards without re-loading.
    $this->caseStatusGroup = $this->callAPISuccess('option_group', 'get', array(
      'name' => 'case_status',
      'format.only_id' => 1)
    );
    $this->caseTypeGroup = $this->callAPISuccess('option_group', 'get', array(
      'name' => 'case_type',
      'format.only_id' => 1)
    );
    $caseTypes = $this->callAPISuccess('option_value', 'Create', array(
        'option_group_id' => $this->caseTypeGroup,
        'name' => 'housing_support',
        'label' => "Housing Support",
        'sequential' => 1,
        'description' => 'Help homeless individuals obtain temporary and long-term housing',
      ));

    $this->caseTypeId = $caseTypes['values'][0]['value'];
    $this->optionValues[] = $caseTypes['id'];
    $optionValues = array(
      'Medical evaluation' => 'Medical evaluation',
      'Mental health evaluation' => "Mental health evaluation",
      'Secure temporary housing' => 'Secure temporary housing',
      'Long-term housing plan' => 'Long-term housing plan',
      'ADC referral' => 'ADC referral',
      'Income and benefits stabilization' => 'Income and benefits stabilization',
    );
    foreach ($optionValues as $name => $label) {
      $activityTypes = $this->callAPISuccess('option_value', 'Create', array(
          'option_group_id' => 2,
          'name' => $name,
          'label' => $label,
          'component_id' => 7,
        ));
      // store for cleanup
      $this->optionValues[] = $activityTypes['id'];
    }
    $tablesToTruncate = array(
      'civicrm_activity',
      'civicrm_contact',
      'civicrm_custom_group',
      'civicrm_custom_field',
      'civicrm_case',
      'civicrm_case_contact',
      'civicrm_case_activity',
      'civicrm_activity_contact',
      'civicrm_relationship',
      'civicrm_relationship_type',
    );

    $this->quickCleanup($tablesToTruncate);

    $activityTypes = $this->callAPISuccess('option_value', 'get', array(
      'option_group_id' => 2,
      'name' => 'Follow Up',
      'label' => 'Follow Up',
      'sequential' => 1,
    ));
    $this->followup_activity_type_value = $activityTypes['values'][0]['value'];
    //  Insert a row in civicrm_contact creating contact 17
    $op = new PHPUnit_Extensions_Database_Operation_Insert();
    $op->execute($this->_dbconn,
      new PHPUnit_Extensions_Database_DataSet_XMLDataSet(
        dirname(__FILE__) . '/dataset/contact_17.xml'
      )
    );

    //Create relationship types
    $relTypeParams = array(
      'name_a_b' => 'Case Coordinator is',
      'label_a_b' => 'Case Coordinator is',
      'name_b_a' => 'Case Coordinator',
      'label_b_a' => 'Case Coordinator',
      'description' => 'Case Coordinator',
      'contact_type_a' => 'Individual',
      'contact_type_b' => 'Individual',
      'is_reserved' => 0,
      'is_active' => 1,
    );
    $this->relationshipTypeCreate($relTypeParams);

    $relTypeParams = array(
      'name_a_b' => 'Homeless Services Coordinator is',
      'label_a_b' => 'Homeless Services Coordinator is',
      'name_b_a' => 'Homeless Services Coordinator',
      'label_b_a' => 'Homeless Services Coordinator',
      'description' => 'Homeless Services Coordinator',
      'contact_type_a' => 'Individual',
      'contact_type_b' => 'Individual',
      'is_reserved' => 0,
      'is_active' => 1,
    );
    $this->relationshipTypeCreate($relTypeParams);

    $relTypeParams = array(
      'name_a_b' => 'Health Services Coordinator is',
      'label_a_b' => 'Health Services Coordinator is',
      'name_b_a' => 'Health Services Coordinator',
      'label_b_a' => 'Health Services Coordinator',
      'description' => 'Health Services Coordinator',
      'contact_type_a' => 'Individual',
      'contact_type_b' => 'Individual',
      'is_reserved' => 0,
      'is_active' => 1,
    );
    $this->relationshipTypeCreate($relTypeParams);

    $relTypeParams = array(
      'name_a_b' => 'Senior Services Coordinator is',
      'label_a_b' => 'Senior Services Coordinator is',
      'name_b_a' => 'Senior Services Coordinator',
      'label_b_a' => 'Senior Services Coordinator',
      'description' => 'Senior Services Coordinator',
      'contact_type_a' => 'Individual',
      'contact_type_b' => 'Individual',
      'is_reserved' => 0,
      'is_active' => 1,
    );
    $this->relationshipTypeCreate($relTypeParams);

    $relTypeParams = array(
      'name_a_b' => 'Benefits Specialist is',
      'label_a_b' => 'Benefits Specialist is',
      'name_b_a' => 'Benefits Specialist',
      'label_b_a' => 'Benefits Specialist',
      'description' => 'Benefits Specialist',
      'contact_type_a' => 'Individual',
      'contact_type_b' => 'Individual',
      'is_reserved' => 0,
      'is_active' => 1,
    );
    $this->relationshipTypeCreate($relTypeParams);

    // enable the default custom templates for the case type xml files
    $this->customDirectories(array('template_path' => TRUE));

    // case is not enabled by default
    $enableResult = CRM_Core_BAO_ConfigSetting::enableComponent('CiviCase');
    $this->assertTrue($enableResult, 'Cannot enable CiviCase in line ' . __LINE__);

    $this->_params = array(
      'case_type_id' => $this->caseTypeId,
      'subject' => 'Test case',
      'contact_id' => 17,
    );

    // create a logged in USER since the code references it for source_contact_id
    $this->createLoggedInUser();
    $session = CRM_Core_Session::singleton();
    $this->_loggedInUser = $session->get('userID');
    /// note that activityType options are cached by the FULL set of options you pass in
    // ie. because Activity api includes campaign in it's call cache is not flushed unless
    // included in this call. Also note flush function doesn't work on this property as it sets to null not empty array
    CRM_Core_PseudoConstant::activityType(TRUE, TRUE, TRUE, 'name', TRUE);
  }

  /**
   * Tears down the fixture, for example, closes a network connection.
   * This method is called after a test is executed.
   *
   * @access protected
   */
  function tearDown() {
    foreach ($this->optionValues as $id) {
      $this->callAPISuccess('option_value', 'delete', array('id' => $id));
    }
    $tablesToTruncate = array(
      'civicrm_contact',
      'civicrm_activity',
      'civicrm_case',
      'civicrm_case_contact',
      'civicrm_case_activity',
      'civicrm_activity_contact',
      'civicrm_relationship',
      'civicrm_relationship_type',
    );
    $this->quickCleanup($tablesToTruncate, TRUE);

    $this->customDirectories(array('template_path' => FALSE));
  }

  /**
   * check with empty array
   */
  function testCaseCreateEmpty() {
    $result = $this->callAPIFailure('case', 'create', array());
  }

  /**
   * check if required fields are not passed
   */
  function testCaseCreateWithoutRequired() {
    $params = array(
      'subject' => 'this case should fail',
      'case_type_id' => 1,
    );

    $result = $this->callAPIFailure('case', 'create', $params);
  }

  /**
   * Test create function with valid parameters
   */
  function testCaseCreate() {
    // Create Case
    $params = $this->_params;
    // Test using label instead of value
    unset($params['case_type_id']);
    $params['case_type'] = 'Housing Support';
    $result = $this->callAPISuccess('case', 'create', $params);
    $id = $result['id'];

    // Check result
    $result = $this->callAPISuccess('case', 'get', array('id' => $id));
    $this->assertEquals($result['values'][$id]['id'], 1, 'in line ' . __LINE__);
    $this->assertEquals($result['values'][$id]['case_type_id'], $this->caseTypeId, 'in line ' . __LINE__);
    $this->assertEquals($result['values'][$id]['subject'], $params['subject'], 'in line ' . __LINE__);
  }

  /**
   * Test update (create with id) function with valid parameters
   */
  function testCaseUpdate() {
    // Create Case
    $params = $this->_params;
    // Test using name instead of value
    $params['case_type_id'] = 'housing_support';
    $result = $this->callAPISuccess('case', 'create', $params);
    $id = $result['id'];
    $result = $this->callAPISuccess('case', 'get', array('id' => $id));
    $case = $result['values'][$id];

    // Update Case
    $params = array('id' => $id);
    $params['subject'] = $case['subject'] = 'Something Else';
    $result = $this->callAPISuccess('case', 'create', $params);

    // Verify that updated case is exactly equal to the original with new subject
    $result = $this->callAPISuccess('case', 'get', array('case_id' => $id));
    $this->assertEquals($result['values'][$id], $case, 'in line ' . __LINE__);
  }

  /**
   * Test delete function with valid parameters
   */
  function testCaseDelete() {
    // Create Case
    $result = $this->callAPISuccess('case', 'create', $this->_params);

    // Move Case to Trash
    $id = $result['id'];
    $result = $this->callAPISuccess('case', 'delete', array('id' => $id, 'move_to_trash' => 1));

    // Check result - also check that 'case_id' works as well as 'id'
    $result = $this->callAPISuccess('case', 'get', array('case_id' => $id));
    $this->assertEquals(1, $result['values'][$id]['is_deleted'], 'in line ' . __LINE__);

    // Delete Case Permanently - also check that 'case_id' works as well as 'id'
    $result = $this->callAPISuccess('case', 'delete', array('case_id' => $id));

    // Check result - case should no longer exist
    $result = $this->callAPISuccess('case', 'get', array('id' => $id));
    $this->assertEquals(0, $result['count']);
  }

  /**
   * Test get function based on activity
   */
  function testCaseGetByActivity() {
    // Create Case
    $result = $this->callAPISuccess('case', 'create', $this->_params);
    $id = $result['id'];

    // Check result - we should get a list of activity ids
    $result = $this->callAPISuccess('case', 'get', array('id' => $id));
    $case = $result['values'][$id];
    $activity = $case['activities'][0];

    // Fetch case based on an activity id
    $result = $this->callAPISuccess('case', 'get', array('activity_id' => $activity, 'return' => 'activities,contacts'));
    $this->assertEquals(FALSE, empty($result['values'][$id]), 'in line ' . __LINE__);
    $this->assertEquals($result['values'][$id], $case, 'in line ' . __LINE__);
  }

  /**
   * Test get function based on contact id
   */
  function testCaseGetByContact() {
    // Create Case
    $result = $this->callAPISuccess('case', 'create', $this->_params);
    $id = $result['id'];

    // Store result for later
    $case = $this->callAPISuccess('case', 'getsingle', array('id' => $id));

    // Fetch case based on client contact id
    $result = $this->callAPISuccess('case', 'get', array('client_id' => $this->_params['contact_id'], 'return' => array('activities', 'contacts')));
    $this->assertAPIArrayComparison($result['values'][$id], $case);
  }

  /**
   * Test get function based on subject
   */
  function testCaseGetBySubject() {
    // Create Case
    $result = $this->callAPISuccess('case', 'create', $this->_params);
    $id = $result['id'];

    // Store result for later
    $case = $this->callAPISuccess('case', 'getsingle', array('id' => $id));

    // Fetch case based on client contact id
    $result = $this->callAPISuccess('case', 'get', array('subject' => $this->_params['subject'], 'return' => array('activities', 'contacts')));
    $this->assertAPIArrayComparison($result['values'][$id], $case);
  }

  /**
   * Test get function based on wrong subject
   */
  function testCaseGetByWrongSubject() {
    // Create Case
    $result = $this->callAPISuccess('case', 'create', $this->_params);
    $id = $result['id'];

    // Append 'wrong' to subject so that it is no longer the same
    $result = $this->callAPISuccess('case', 'get', array('subject' => $this->_params['subject'] . 'wrong', 'return' => array('activities', 'contacts')));
    $this->assertEquals(0, $result['count'], 'in line ' . __LINE__);
  }

  /**
   * Test get function with no criteria
   */
  function testCaseGetNoCriteria() {
    // Create Case
    $result = $this->callAPISuccess('case', 'create', $this->_params);
    $id = $result['id'];

    // Store result for later
    $case = $this->callAPISuccess('case', 'getsingle', array('id' => $id));

    $result = $this->callAPISuccess('case', 'get', array('return' => array('activities', 'contacts')));
    $this->assertAPIArrayComparison($result['values'][$id], $case);
  }

  /**
   *  Test activity api create for case activities
   */
  function testCaseActivityCreate() {
    // Create a case first
    $params = $this->_params;
    $result = $this->callAPISuccess('case', 'create', $params);
    $params = array(
      'case_id' => 1,
      // follow up
      'activity_type_id' => $this->followup_activity_type_value,
      'subject' => 'Test followup',
      'source_contact_id' => $this->_loggedInUser,
      'target_contact_id' => $this->_params['contact_id'],
    );
    $result = $this->callAPISuccess('activity', 'create', $params);
    $this->assertEquals($result['values'][$result['id']]['activity_type_id'], $params['activity_type_id'], 'in line ' . __LINE__);

    // might need this for other tests that piggyback on this one
    $this->_caseActivityId = $result['values'][$result['id']]['id'];

    // Check other DB tables populated properly - is there a better way to do this? assertDBState() requires that we know the id already.
    $dao = new CRM_Case_DAO_CaseActivity();
    $dao->case_id = 1;
    $dao->activity_id = $this->_caseActivityId;
    $this->assertEquals($dao->find(), 1, 'case_activity table not populated correctly in line ' . __LINE__);
    $dao->free();

    $dao = new CRM_Activity_DAO_ActivityContact();
    $dao->activity_id = $this->_caseActivityId;
    $dao->contact_id = $this->_params['contact_id'];
    $dao->record_type_id = 3;
    $this->assertEquals($dao->find(), 1, 'activity_contact table not populated correctly in line ' . __LINE__);
    $dao->free();

    // TODO: There's more things we could check
  }

  /**
   *  Test activity api update for case activities
   */
  function testCaseActivityUpdate() {
    // Need to create the case and activity before we can update it
    $this->testCaseActivityCreate();

    $params = array(
      'activity_id' => $this->_caseActivityId,
      'case_id' => 1,
      'activity_type_id' => 14,
      'source_contact_id' => $this->_loggedInUser,
      'subject' => 'New subject',
    );
    $result = $this->callAPISuccess('activity', 'create', $params);

    $this->assertEquals($result['values'][$result['id']]['subject'], $params['subject'], 'in line ' . __LINE__);

    // id should be one greater, since this is a new revision
    $this->assertEquals($result['values'][$result['id']]['id'],
      $this->_caseActivityId + 1,
      'in line ' . __LINE__
    );
    $this->assertEquals($result['values'][$result['id']]['original_id'],
      $this->_caseActivityId,
      'in line ' . __LINE__
    );

    // Check revision is as expected
    $revParams = array(
      'activity_id' => $this->_caseActivityId,
    );
    $revActivity = $this->callAPISuccess('activity', 'get', $revParams);
    $this->assertEquals($revActivity['values'][$this->_caseActivityId]['is_current_revision'],
      0);
    $this->assertEquals($revActivity['values'][$this->_caseActivityId]['is_deleted'],
      0
    );

    //TODO: check some more things
  }

  function testCaseActivityUpdateCustom() {
    // Create a case first
    $result = $this->callAPISuccess('case', 'create', $this->_params);

    // Create custom field group
    // Note the second parameter is Activity on purpose, not Case.
    $custom_ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, 'ActivityTest.php');

    // create activity
    $params = array(
      'case_id' => $result['id'],
      // follow up
      'activity_type_id' => 14,
      'subject' => 'Test followup',
      'source_contact_id' => $this->_loggedInUser,
      'target_contact_id' => $this->_params['contact_id'],
      'custom_' . $custom_ids['custom_field_id'] => "custom string",
    );
    $result = $this->callAPISuccess('activity', 'create', $params);

    $aid = $result['values'][$result['id']]['id'];

    // Update activity
    $params = array(
      'activity_id' => $aid,
      'case_id' => 1,
      'activity_type_id' => 14,
      'source_contact_id' => $this->_loggedInUser,
      'subject' => 'New subject',
    );
    $revAct = $this->callAPISuccess('activity', 'create', $params);

    // Retrieve revision and check custom fields got copied
    $revParams = array(
      'activity_id' => $aid + 1,
      'return.custom_' . $custom_ids['custom_field_id'] => 1,
    );
    $revAct = $this->callAPISuccess('activity', 'get', $revParams);

    $this->assertEquals($revAct['values'][$aid + 1]['custom_' . $custom_ids['custom_field_id']], "custom string",
      "Error message: " . CRM_Utils_Array::value('error_message', $revAct) . ' in line ' . __LINE__
    );

    $this->customFieldDelete($custom_ids['custom_field_id']);
    $this->customGroupDelete($custom_ids['custom_group_id']);
  }
}