donrec.php

<?php
/*-------------------------------------------------------+
| SYSTOPIA Donation Receipts Extension                   |
| Copyright (C) 2013-2016 SYSTOPIA                       |
| Author: B. Endres (endres -at- systopia.de)            |
| http://www.systopia.de/                                |
+--------------------------------------------------------+
| License: AGPLv3, see LICENSE file                      |
+--------------------------------------------------------*/

require_once 'donrec.civix.php';
require_once 'CRM/Donrec/DataStructure.php';
require_once 'CRM/Donrec/Logic/Template.php';
require_once 'CRM/Donrec/Logic/Settings.php';

use CRM_Donrec_ExtensionUtil as E;

/**
 * Implementation of hook_civicrm_config
 */
function donrec_civicrm_config(&$config) {
  _donrec_civix_civicrm_config($config);
}

/**
 * Implementation of hook_civicrm_xmlMenu
 *
 * @param $files array(string)
 */
function donrec_civicrm_xmlMenu(&$files) {
  _donrec_civix_civicrm_xmlMenu($files);
}

/**
 * Implementation of hook_civicrm_install
 */
function donrec_civicrm_install() {
  return _donrec_civix_civicrm_install();
}

/**
 * Implementation of hook_civicrm_uninstall
 */
function donrec_civicrm_uninstall() {
  return _donrec_civix_civicrm_uninstall();
}

/**
 * Implementation of hook_civicrm_enable
 */
function donrec_civicrm_enable() {
  return _donrec_civix_civicrm_enable();
}

/**
 * Implementation of hook_civicrm_disable
 */
function donrec_civicrm_disable() {
  return _donrec_civix_civicrm_disable();
}

/**
 * Implementation of hook_civicrm_upgrade
 *
 * @param $op string, the type of operation being performed; 'check' or 'enqueue'
 * @param $queue CRM_Queue_Queue, (for 'enqueue') the modifiable list of pending up upgrade tasks
 *
 * @return mixed  based on op. for 'check', returns array(boolean) (TRUE if upgrades are pending)
 *                for 'enqueue', returns void
 */
function donrec_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
  return _donrec_civix_civicrm_upgrade($op, $queue);
}

/**
 * Implementation of hook_civicrm_managed
 *
 * Generate a list of entities to create/deactivate/delete when this module
 * is installed, disabled, uninstalled.
 */
function donrec_civicrm_managed(&$entities) {
  return _donrec_civix_civicrm_managed($entities);
}

/**
 * Implementation of hook_civicrm_caseTypes
 *
 * Generate a list of case-types
 *
 * Note: This hook only runs in CiviCRM 4.4+.
 */
function donrec_civicrm_caseTypes(&$caseTypes) {
  _donrec_civix_civicrm_caseTypes($caseTypes);
}

/**
* Add an action for creating donation receipts after doing a search
*
* @param string $objectType specifies the component
* @param array $tasks the list of actions
*
* @access public
*/
function donrec_civicrm_searchTasks($objectType, &$tasks) {
  // add DONATION RECEIPT task to contact list
  if ($objectType == 'contact') {
    if (CRM_Core_Permission::check('create and withdraw receipts')) {
      $tasks[] = array(
          'title' => E::ts('Issue donation receipt(s)'),
          'class' => 'CRM_Donrec_Form_Task_DonrecTask',
          'result' => false);
      $tasks[] = array(
          'title' => E::ts('Withdraw donation receipt(s)'),
          'class' => 'CRM_Donrec_Form_Task_DonrecResetTask',
          'result' => false);
    }
  }

  // add REBOOK task to contribution list
  if ($objectType == 'contribution') {
    if (CRM_Core_Permission::check('create and withdraw receipts')) {
      $tasks[] = array(
          'title' => E::ts('Issue donation receipt(s)'),
          'class' => 'CRM_Donrec_Form_Task_ContributeTask',
          'result' => false);
    }
    if (CRM_Core_Permission::check('edit contributions')) {
      $tasks[] = array(
          'title'  => E::ts('Rebook to contact'),
          'class'  => 'CRM_Donrec_Form_Task_RebookTask',
          'result' => false);
    }
  }
}

/**
 *  1) add an extra search column 'receipted'
 *  2) modify actions for rebook
 */
function donrec_civicrm_searchColumns($objectName, &$headers,  &$values, &$selector) {
  if ($objectName == 'contribution') {
    // ************************************
    // **      ADD CONTRIBUTED COLUMN    **
    // ************************************

    // save last element (action list)
    $actionList = array_pop($headers);
    // insert new column
    $headers[] = array(
      'name' => E::ts('Receipted'),
      // Provide a weight lower than the "actions" column.
      'weight' => $actionList['weight'] - 1,
      'field_name' => 'is_receipted',
    );

    $receipted_contribution_ids = array();

    // insert new values
    foreach ($values as $id => $value ) {
      $item_id = CRM_Donrec_Logic_ReceiptItem::hasValidReceiptItem($value['contribution_id'], TRUE);
      if($item_id === FALSE) {
        $values[$id]['is_receipted'] = E::ts('No');
      }else{
        $receipted_contribution_ids[] = $value['contribution_id'];    // save as receipted for rebook (see below)
        $values[$id]['is_receipted'] = sprintf('<a href="%s">%s</a>', CRM_Utils_System::url(
        'civicrm/contact/view',
        "reset=1&cid={$value['contact_id']}&rid=$item_id&selectedChild=donation_receipts",
        TRUE, NULL, TRUE),
        E::ts('Yes'));
      }
    }
    // restore last element
    $headers[] = $actionList;


    // ************************************
    // **       ADD REBOOK ACTION        **
    // ************************************
    // only offer rebook only if the user has the correct permissions
    if (CRM_Core_Permission::check('edit contributions')) {
      $contribution_status_complete = (int) CRM_Core_OptionGroup::getValue('contribution_status', 'Completed', 'name');
      $title = E::ts('Rebook');
      $url = CRM_Utils_System::url('civicrm/donrec/rebook', "contributionIds=__CONTRIBUTION_ID__");
      $action = "<a title=\"$title\" class=\"action-item action-item\" href=\"$url\">$title</a>";

      // add 'rebook' action link to each row
      foreach ($values as $rownr => $row) {
        $contribution_status_id = $row['contribution_status_id'];
        // ... but only for completed contributions
        if ($contribution_status_id==$contribution_status_complete) {
          // receipted contributions cannot be rebooked either...
          if (!in_array($row['contribution_id'], $receipted_contribution_ids)) {
            // this contribution is o.k. => add the rebook action
            $contribution_id = $row['contribution_id'];
            $this_action = str_replace('__CONTRIBUTION_ID__', $contribution_id, $action);
            $values[$rownr]['action'] = str_replace('</span>', $this_action.'</span>', $row['action']);
          }
        }
      }
    }
  }
}


/**
 * The extra search column (see above) does not alter the template,
 * so we inject javascript into the template-content.
 */
function donrec_civicrm_alterContent(&$content, $context, $tplName, &$object) {
  // The contribution search results template has changed in 4.7.20, allowing
  // to add columns and values in hook_civicrm_searchColumns() implementations.
  // Prior to 4.7.20, this has to be done using the following approach.
  // @link https://lab.civicrm.org/dev/core/commit/4fb5fcf3b17af6c9f5bf49ecc69902c5b0b78c24
  // Commit that introduced the new behavior.
  if (version_compare(CRM_Utils_System::version(), '4.7.20', '<')) {
    // get page- resp. form-class of the object
    $class_name = get_class($object);
    if ($class_name == 'CRM_Contribute_Page_Tab' ||
      $class_name == 'CRM_Contribute_Form_Search' ||
      $class_name == 'CRM_Contribute_Page_DashBoard') {
      // parse the template with smarty
      $smarty = CRM_Core_Smarty::singleton();
      $path = __DIR__ . '/templates/CRM/Contribute/ReceiptedColumn.tpl';
      $html = $smarty->fetch($path);
      // append the html to the content
      $content .= $html;
    }
  }
}


/**
 * Set permissions for runner/engine API call
 */
function donrec_civicrm_alterAPIPermissions($entity, $action, &$params, &$permissions) {
  // TODO: adjust to correct permission
  $permissions['donation_receipt_engine']['next'] = array('create and withdraw receipts');
  $permissions['donation_receipt']['view'] = array('view and copy receipts');
  $permissions['donation_receipt']['delete'] = array('delete receipts');
  $permissions['donation_receipt']['copy'] = array('view and copy receipts');
  $permissions['donation_receipt']['withdraw'] = array('create and withdraw receipts');
}

/**
 * Custom permissions
 */
 function donrec_civicrm_permission(&$permissions) {
  $prefix = E::ts('DonationReceipts') . ': ';

  $permissions['view and copy receipts'] = $prefix . E::ts('view and create copies of receipts');
  $permissions['create and withdraw receipts'] = $prefix . E::ts('create and withdraw receipts');
  $permissions['delete receipts'] = $prefix . E::ts('delete receipts');
 }

/**
 * Add headers to sent donation receipts
 */
function donrec_civicrm_alterMailParams(&$params, $context) {
  CRM_Donrec_Exporters_EmailPDF::addDonrecMailCodeHeader($params, $context);
}

/**
 * Set settings
 */
function donrec_civicrm_alterSettingsFolders(&$metaDataFolders = NULL){
  static $configured = FALSE;
  if ($configured) return;
  $configured = TRUE;

  $extRoot = dirname( __FILE__ ) . DIRECTORY_SEPARATOR;
  $extDir = $extRoot . 'settings';
  if(!in_array($extDir, $metaDataFolders)){
    $metaDataFolders[] = $extDir;
  }
}

function donrec_civicrm_tabs(&$tabs, $contactID) {
  if (CRM_Core_Permission::check('view and copy receipts') || CRM_Core_Permission::check('create and withdraw receipts')) {
    $url = CRM_Utils_System::url( 'civicrm/donrec/tab',
                                  "reset=1&snippet=1&force=1&cid=$contactID" );
    $tabs[] = array( 'id'    => 'donation_receipts',
                     'url'   => $url,
                     'title' => E::ts('Donation receipts'),
                     'count' => CRM_Donrec_Logic_Receipt::getReceiptCountForContact($contactID),
                     'weight' => 300);
  }
}

/*
 * return errors if a receipted contribution is going to be changed
 */
 //TODO: the pre-hook need the same informations than this one and is called
 // afterwards. Is it possible to make these informations available for it?
function donrec_civicrm_validateForm( $formName, &$fields, &$files, &$form, &$errors ) {
  // Validate contribution_form for already existing contributions.
  // Therefore we need a contribution-id.
  if ($formName == 'CRM_Contribute_Form_Contribution' && !empty($form->_id)) {
    // Validate the contribution values to be set.
    $errors += CRM_Donrec_Logic_Settings::validateContribution($form->_id, $form->_values, $fields);
  }
}

/*
 * Implements hook_civicrm_pre().
 */
function donrec_civicrm_pre( $op, $objectName, $id, &$params ) {
  // Check for forbidden changes on receipted contributions.
  if ($objectName == 'Contribution' && ($op == 'edit' || $op == 'delete')) {

    $has_item = CRM_Donrec_Logic_ReceiptItem::hasValidReceiptItem($id);
    $in_snapshot = CRM_Donrec_Logic_Snapshot::isInOpenSnapshot($id);

    if ($has_item || $in_snapshot) {
      if ($op == 'edit') {
        // Get the contribution.
        $query = "
          SELECT *
          FROM civicrm_contribution
          WHERE id = $id";
        $result = CRM_Core_DAO::executeQuery($query);
        $result->fetch();

        // Validate the contribution values to be set.
        CRM_Donrec_Logic_Settings::validateContribution($id, (array)$result, $params, TRUE);
      } elseif ($op == 'delete') {
        $message = sprintf(E::ts("This contribution [%d] must not be deleted because it has a receipt or is going to be receipted!"), $id);
        throw new Exception($message);
      }
    }
  }
  return;
}

/**
 * Prune the "find contributions" and "advanced contact search" forms
 * by removing the fields that don't make sense or don't work
 */
function donrec_civicrm_buildForm($formName, &$form) {
  if ($formName=='CRM_Contribute_Form_Search') {
    $item_fields = CRM_Donrec_Logic_ReceiptItem::getCustomFields();

    // remove unwanted fields
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'financial_type_id');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'total_amount');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'non_deductible_amount');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'currency');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'contribution_hash');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'issued_on');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'receive_date');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'issued_in');
    $form->assign('field_ids_to_remove', implode(',', $field_ids_to_remove));
    CRM_Core_Region::instance('page-body')->add(array(
      'template' => 'CRM/Donrec/Form/Search/RemoveFields.snippet.tpl'
    ));

    // DISABLED: date field search doesn't work
    // CRM_Utils_DonrecHelper::relabelDateField($form, $item_fields, 'issued_on', E::E::ts("Issed On - From"), ts("Issed On - To"));
    // CRM_Utils_DonrecHelper::relabelDateField($form, $item_fields, 'receive_date', E::E::ts("Received - From"), ts("Received - To"));

    // override the standard fields
    $status_id = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'status');
    if ($status_id) $form->add('select', "custom_{$status_id}",
        E::ts('Status'),
        // TODO: use future status definitions
        array(  ''                => E::ts('- any -'),
                'original'        => E::ts('original'),
                'copy'            => E::ts('copy'),
                'withdrawn'       => E::ts('withdrawn'),
                'withdrawn_copy'  => E::ts('withdrawn_copy'),
                ));
    $status_id = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'type');
    if ($status_id) $form->add('select', "custom_{$status_id}",
        E::ts('Type'),
        // TODO: use future status definitions
        array(  ''        => E::ts('- any -'),
                'single'  => E::ts('single receipt'),
                'bulk'    => E::ts('bulk receipt'),
                ));
    $status_id = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'issued_in');
    if ($status_id) $form->add('text', "custom_{$status_id}", E::ts('Receipt ID'));
    $status_id = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'issued_by');
    if ($status_id) $form->add('text', "custom_{$status_id}", E::ts('Issued by contact'));




  } elseif ($formName=='CRM_Contact_Form_Search_Advanced') {

    // remove unwanted fields
    $item_fields = CRM_Donrec_Logic_Receipt::getCustomFields();
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'issued_on');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'original_file');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'contact_type');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'gender');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'prefix');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'display_name');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'postal_greeting_display');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'email_greeting_display');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'addressee_display');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'street_address');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'supplemental_address_1');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'supplemental_address_2');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'supplemental_address_3');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'postal_code');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'city');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'country');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'shipping_addressee_display');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'shipping_street_address');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'shipping_supplemental_address_1');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'shipping_supplemental_address_2');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'shipping_supplemental_address_3');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'shipping_postal_code');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'shipping_city');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'shipping_country');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'date_from');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'date_to');

    // remove unwanted fields from receipt items (in contribution tab)
    $item_fields_receipt = CRM_Donrec_Logic_ReceiptItem::getCustomFields();
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields_receipt, 'financial_type_id');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields_receipt, 'total_amount');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields_receipt, 'non_deductible_amount');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields_receipt, 'currency');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields_receipt, 'contribution_hash');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields_receipt, 'issued_on');
    $field_ids_to_remove[] = CRM_Utils_DonrecHelper::getFieldID($item_fields_receipt, 'receive_date');

    $form->assign('field_ids_to_remove', implode(',', $field_ids_to_remove));
    CRM_Core_Region::instance('page-body')->add(array(
      'template' => 'CRM/Donrec/Form/Search/RemoveFields.snippet.tpl'
    ));

    // DISABLED: date field search doesn't work
    //CRM_Utils_DonrecHelper::relabelDateField($form, $item_fields, 'issued_on', E::E::ts("Issed On - From"), ts("Issed On - To"));

    // override the standard fields
    $status_id = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'status');
    if ($status_id) $form->add('select', "custom_{$status_id}",
        E::ts('Status'),
        // TODO: use future status definitions
        array(  ''                => E::ts('- any -'),
                'original'        => E::ts('original'),
                'copy'            => E::ts('copy'),
                'withdrawn'       => E::ts('withdrawn'),
                'withdrawn_copy'  => E::ts('withdrawn_copy'),
                ));
    $status_id = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'type');
    if ($status_id) $form->add('select', "custom_{$status_id}",
        E::ts('Type'),
        // TODO: use future status definitions
        array(  ''        => E::ts('- any -'),
                'single'  => E::ts('single receipt'),
                'bulk'    => E::ts('bulk receipt'),
                ));
    $status_id = CRM_Utils_DonrecHelper::getFieldID($item_fields, 'issued_by');
    if ($status_id) $form->add('text', "custom_{$status_id}", E::ts('Issued by contact'));


    // override the receipt_item standard fields
    $status_id = CRM_Utils_DonrecHelper::getFieldID($item_fields_receipt, 'status');
    if ($status_id) $form->add('select', "custom_{$status_id}",
        E::ts('Status'),
        // TODO: use future status definitions
        array(  ''                => E::ts('- any -'),
                'original'        => E::ts('original'),
                'copy'            => E::ts('copy'),
                'withdrawn'       => E::ts('withdrawn'),
                'withdrawn_copy'  => E::ts('withdrawn_copy'),
                ));
    $status_id = CRM_Utils_DonrecHelper::getFieldID($item_fields_receipt, 'type');
    if ($status_id) $form->add('select', "custom_{$status_id}",
        E::ts('Type'),
        // TODO: use future status definitions
        array(  ''        => E::ts('- any -'),
                'single'  => E::ts('single receipt'),
                'bulk'    => E::ts('bulk receipt'),
                ));
    $status_id = CRM_Utils_DonrecHelper::getFieldID($item_fields_receipt, 'issued_in');
    if ($status_id) $form->add('text', "custom_{$status_id}", E::ts('Receipt ID'));
    $status_id = CRM_Utils_DonrecHelper::getFieldID($item_fields_receipt, 'issued_by');
    if ($status_id) $form->add('text', "custom_{$status_id}", E::ts('Issued by contact'));
  }
}