<?php
/*
 +--------------------------------------------------------------------+
 | CiviCRM version 4.4                                                |
 +--------------------------------------------------------------------+
 | Copyright CiviCRM LLC (c) 2004-2013                                |
 +--------------------------------------------------------------------+
 | This file is a part of CiviCRM.                                    |
 |                                                                    |
 | CiviCRM is free software; you can copy, modify, and distribute it  |
 | under the terms of the GNU Affero General Public License           |
 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
 |                                                                    |
 | 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 and the CiviCRM Licensing Exception along                  |
 | with this program; if not, contact CiviCRM LLC                     |
 | at info[AT]civicrm[DOT]org. If you have questions about the        |
 | GNU Affero General Public License or the licensing of CiviCRM,     |
 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
 +--------------------------------------------------------------------+
 */

/**
 * File for the CiviCRM APIv3 Volunteer Project functions
 *
 * @package CiviVolunteer_APIv3
 * @subpackage API_Volunteer_Project
 * @copyright CiviCRM LLC (c) 2004-2013
 */


/**
 * Create or update a project
 *
 * @param array $params  Associative array of property
 *                       name/value pairs to insert in new 'project'
 * @example
 *
 * @return array api result array
 * {@getfields volunteer_project_create}
 * @access public
 */
function civicrm_api3_volunteer_project_create($params) {
  $project = CRM_Volunteer_BAO_Project::create($params);

  return civicrm_api3_create_success($project->toArray(), $params, 'VolunteerProject', 'create');
}

/**
 * Adjust Metadata for Create action
 *
 * The metadata is used for setting defaults, documentation & validation
 * @param array $params array or parameters determined by getfields
 */
function _civicrm_api3_volunteer_project_create_spec(&$params) {
  $params['title']['api.required'] = 1;
  $params['project_contacts'] = array(
    'title' => 'Project Contacts',
    'description' => 'Create or replace the project contact associations with
      this project. Array of [volunteer relationship type] => [contact IDs].
      See CRM_Volunteer_BAO_Project::create().',
    'type' => CRM_Utils_Type::T_STRING,
  );
  $params['profiles'] = array(
    'title' => 'Profiles',
    'description' => 'Create or replace the profile associations with
      this project. Array of arrays, where each child array is a set of
      parameters that could be passed to api.UFJoin.create. See
      CRM_Volunteer_BAO_Project::create().',
    'type' => CRM_Utils_Type::T_STRING,
  );
}

/**
 * Returns array of projects matching a set of one or more project properties
 *
 * @param array $params  Array of one or more valid
 *                       property_name=>value pairs. If $params is set
 *                       as null, all projects will be returned
 *
 * @return array  Array of matching projects
 * {@getfields volunteer_project_get}
 * @access public
 */
function civicrm_api3_volunteer_project_get($params) {

  //If we are in an editing context only show projects they can edit.
  $context = CRM_Utils_Array::value('context', $params);
  if ($context === 'edit' && !CRM_Volunteer_Permission::check('edit all volunteer projects')) {

    if (!isset($params['project_contacts'])) {
      $params['project_contacts'] = array();
    }

    $params['project_contacts']['volunteer_owner'] = array(CRM_Core_Session::getLoggedInContactID());
    unset($params['context']);
  }


  $result = CRM_Volunteer_BAO_Project::retrieve($params);
  foreach ($result as $k => $bao) {

    $result[$k] = $bao->toArray();
    $result[$k]['entity_attributes'] = $bao->getEntityAttributes();

    $profiles = civicrm_api3("UFJoin", "get", array(
      "entity_id" => $bao->id,
      "entity_table" => "civicrm_volunteer_project",
      "options" => array("limit" => 0),
      "sequential" => 1
    ));
    $result[$k]['profiles'] = $profiles['values'];
  }

  return civicrm_api3_create_success($result, $params, 'VolunteerProject', 'get');
}

function _civicrm_api3_volunteer_project_get_spec(&$params) {
  $params['id']['api.aliases'] = array('project_id');
  $params['context'] = array(
    'title' => 'Action Context',
    'description' => 'String representing the context in which permissions
    are evaluated. E.g You may have the right to view projects, but not edit them. This is for filtering only',
    'type' => CRM_Utils_Type::T_STRING,
  );
  $params['project_contacts'] = array(
    'title' => 'Project Contacts',
    'description' => 'Array of [volunteer relationship type] => [contact IDs].
      See CRM_Volunteer_BAO_Project::retrieve(). This parameter is used for
      filtering only; project contacts are not returned.',
    'type' => CRM_Utils_Type::T_STRING,
  );
  $params['proximity'] = array(
    'title' => 'Proximity',
    'description' => 'Array of parameters (lat, lon, radius, unit) by which to
      geographically limit results. See CRM_Volunteer_BAO_Project::retrieve().
      This parameter is used for filtering only; project contacts are not returned.',
    'type' => CRM_Utils_Type::T_STRING,
  );
}

/**
 * delete an existing project
 *
 * This method is used to delete any existing project. id of the project
 * to be deleted is required field in $params array
 *
 * @param array $params  array containing id of the project
 *                       to be deleted
 *
 * @return array  returns flag true if successfull, error
 *                message otherwise
 * {@getfields volunteer_project_delete}
 * @access public
 */
function civicrm_api3_volunteer_project_delete($params) {
  if (CRM_Volunteer_Permission::checkProjectPerms(CRM_Core_Action::DELETE, $params['id'])) {
    return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  } else {
    return civicrm_api3_create_error(ts('You do not have permission to delete this event'));
  }
}

function _civicrm_api3_volunteer_project_delete_spec(&$params) {
  $params['id']['api.required'] = 1;
}


/**
 * remove a UFJoin record
 *
 *
 *
 * @param array $params  array containing id of the profile
 *                       to be removed
 *
 * @return array  returns flag true if successfull, error
 *                message otherwise
 */
function civicrm_api3_volunteer_project_removeprofile($params) {
  return _civicrm_api3_basic_delete('CRM_Core_BAO_UFJoin', $params);
}

/**
 * Returns an key/value array of location blocks with proper names
 * Instead of the null values returned when using a crmEntityref
 * connected to the locBlock entity
 *
 * @param $params
 * @return array
 *
 */
function civicrm_api3_volunteer_project_locations($params) {

  $locations = array();

  $query = "
SELECT CONCAT_WS(' :: ' , ca.name, ca.street_address, ca.city, sp.name, ca.supplemental_address_1, ca.supplemental_address_2) title, lb.id
FROM   civicrm_loc_block lb
INNER JOIN civicrm_address ca   ON lb.address_id = ca.id
LEFT  JOIN civicrm_state_province sp ON ca.state_province_id = sp.id
ORDER BY sp.name, ca.city, ca.street_address ASC
";

  $dao = CRM_Core_DAO::executeQuery($query);
  while ($dao->fetch()) {
    //todo: Some sort of per-location permission check
    $locations[$dao->id] = $dao->title;
  }

  return civicrm_api3_create_success($locations, $params, 'VolunteerProject', 'locations');
}

/**
 * This method provides all data for a selected LocBlock
 *
 * @param $params
 * @return array
 *
 */
function civicrm_api3_volunteer_project_getlocblockdata($params) {
  //todo VOL-159: Check Permissions
  unset($params['check_permissions']);

  // Prevent chaining problems: for instance, if this API is chained to
  // api.volunteer_project.get, and the returned project has no loc_block_id,
  // we should return 0 loc_blocks instead of 25 (the API default limit).
  if (empty($params['id'])) {
    return civicrm_api3_create_success(array(), $params, 'VolunteerProject', 'getlocblockdata');
  }

  return civicrm_api3("LocBlock", "get", $params);
}

/**
 * Saves/creates an entire location block with a single call instead of
 * requiring a handful of calls/promises/resolutions from angular
 *
 * @param $params
 * @return array
 *
 */
function civicrm_api3_volunteer_project_savelocblock($params) {
  if (!empty($params['address']) && empty($params['address']['location_type_id'])) {
    $params['address']['location_type_id'] = 1;
  }

  if (!empty($params['address_2']) && empty($params['address_2']['location_type_id'])) {
    $params['address']['location_type_id'] = 2;
  }

  if (!empty($params['email']) && empty($params['email']['location_type_id'])) {
    $params['email']['location_type_id'] = 1;
  }

  if (!empty($params['email_2']) && empty($params['email_2']['location_type_id'])) {
    $params['email']['location_type_id'] = 2;
  }

  if (!empty($params['phone']) && empty($params['phone']['location_type_id'])) {
    $params['phone']['location_type_id'] = 1;
  }

  if (!empty($params['phone_2']) && empty($params['phone_2']['location_type_id'])) {
    $params['phone']['location_type_id'] = 2;
  }

  // Permissions check is not required; the purpose of this wrapper API is to
  // allow CiviVolunteer to determine whether the user should be able to create
  // a locblock. This is managed via the permissions checks around
  // api.volunteerProject.savelocblock. TODO: Check permissions on the project
  // in question in addition to general permission.
  $params['check_permissions'] = 0;
  $location = civicrm_api3('LocBlock', 'create', $params);
  return civicrm_api3_create_success($location, $params, "VolunteerProject", "savelocblock");
}