CRM/Contribute/Import/Form/DataSource.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class gets the name of the file to upload
  38  */
  39 class CRM_Contribute_Import_Form_DataSource extends CRM_Core_Form {
  40
  41   /**
  42    * Function to set variables up before form is built
  43    *
  44    * @return void
  45    * @access public
  46    */
  47   public function preProcess() {
  48     $session = CRM_Core_Session::singleton();
  49     $session->pushUserContext(CRM_Utils_System::url('civicrm/contribute/import', 'reset=1'));
  50   }
  51
  52   /**
  53    * Function to actually build the form
  54    *
  55    * @return void
  56    * @access public
  57    */
  58   public function buildQuickForm() {
  59     //Setting Upload File Size
  60     $config = CRM_Core_Config::singleton();
  61     if ($config->maxImportFileSize >= 8388608) {
  62       $uploadFileSize = 8388608;
  63     }
  64     else {
  65       $uploadFileSize = $config->maxImportFileSize;
  66     }
  67     $uploadSize = round(($uploadFileSize / (1024 * 1024)), 2);
  68
  69     $this->assign('uploadSize', $uploadSize);
  70
  71     $this->add('file', 'uploadFile', ts('Import Data File'), 'size=30 maxlength=255', TRUE);
  72
  73     $this->addRule('uploadFile', ts('A valid file must be uploaded.'), 'uploadedfile');
  74     $this->addRule('uploadFile', ts('File size should be less than %1 MBytes (%2 bytes)', array(1 => $uploadSize, 2 => $uploadFileSize)), 'maxfilesize', $uploadFileSize);
  75     $this->setMaxFileSize($uploadFileSize);
  76     $this->addRule('uploadFile', ts('Input file must be in CSV format'), 'utf8File');
  77
  78     $this->addElement('checkbox', 'skipColumnHeader', ts('First row contains column headers'));
  79
  80     $duplicateOptions = array();
  81     $duplicateOptions[] = $this->createElement('radio',
  82       NULL, NULL, ts('Insert new contributions'), CRM_Import_Parser::DUPLICATE_SKIP
  83     );
  84     $duplicateOptions[] = $this->createElement('radio',
  85       NULL, NULL, ts('Update existing contributions'), CRM_Import_Parser::DUPLICATE_UPDATE
  86     );
  87     $this->addGroup($duplicateOptions, 'onDuplicate',
  88       ts('Import mode')
  89     );
  90
  91     //get the saved mapping details
  92     $mappingArray = CRM_Core_BAO_Mapping::getMappings(CRM_Core_OptionGroup::getValue('mapping_type',
  93         'Import Contribution',
  94         'name'
  95       ));
  96     $this->assign('savedMapping', $mappingArray);
  97     $this->add('select', 'savedMapping', ts('Mapping Option'), array('' => ts('- select -')) + $mappingArray);
  98     $this->addElement('submit', 'loadMapping', ts('Load Mapping'), NULL, array('onclick' => 'checkSelect()'));
  99
 100     if ($loadeMapping = $this->get('loadedMapping')) {
 101       $this->assign('loadedMapping', $loadeMapping);
 102       $this->setDefaults(array('savedMapping' => $loadeMapping));
 103     }
 104
 105     $this->setDefaults(array(
 106       'onDuplicate' =>
 107         CRM_Import_Parser::DUPLICATE_SKIP,
 108       ));
 109
 110     //contact types option
 111     $contactOptions = array();
 112     if (CRM_Contact_BAO_ContactType::isActive('Individual')) {
 113       $contactOptions[] = $this->createElement('radio',
 114         NULL, NULL, ts('Individual'), CRM_Import_Parser::CONTACT_INDIVIDUAL
 115       );
 116     }
 117     if (CRM_Contact_BAO_ContactType::isActive('Household')) {
 118       $contactOptions[] = $this->createElement('radio',
 119         NULL, NULL, ts('Household'), CRM_Import_Parser::CONTACT_HOUSEHOLD
 120       );
 121     }
 122     if (CRM_Contact_BAO_ContactType::isActive('Organization')) {
 123       $contactOptions[] = $this->createElement('radio',
 124         NULL, NULL, ts('Organization'), CRM_Import_Parser::CONTACT_ORGANIZATION
 125       );
 126     }
 127
 128     $this->addGroup($contactOptions, 'contactType',
 129       ts('Contact Type')
 130     );
 131
 132     $this->setDefaults(array(
 133       'contactType' =>
 134         CRM_Import_Parser::CONTACT_INDIVIDUAL,
 135       ));
 136
 137     //build date formats
 138     CRM_Core_Form_Date::buildAllowedDateFormats($this);
 139
 140     $this->addButtons(array(
 141         array(
 142           'type' => 'upload',
 143           'name' => ts('Continue >>'),
 144           'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 145           'isDefault' => TRUE,
 146         ),
 147         array(
 148           'type' => 'cancel',
 149           'name' => ts('Cancel'),
 150         ),
 151       )
 152     );
 153   }
 154
 155   /**
 156    * Process the uploaded file
 157    *
 158    * @return void
 159    * @access public
 160    */
 161   public function postProcess() {
 162     $this->controller->resetPage('MapField');
 163
 164     $fileName         = $this->controller->exportValue($this->_name, 'uploadFile');
 165     $skipColumnHeader = $this->controller->exportValue($this->_name, 'skipColumnHeader');
 166     $onDuplicate      = $this->controller->exportValue($this->_name, 'onDuplicate');
 167     $contactType      = $this->controller->exportValue($this->_name, 'contactType');
 168     $dateFormats      = $this->controller->exportValue($this->_name, 'dateFormats');
 169     $savedMapping     = $this->controller->exportValue($this->_name, 'savedMapping');
 170
 171     $this->set('onDuplicate', $onDuplicate);
 172     $this->set('contactType', $contactType);
 173     $this->set('dateFormats', $dateFormats);
 174     $this->set('savedMapping', $savedMapping);
 175
 176     $session = CRM_Core_Session::singleton();
 177     $session->set("dateTypes", $dateFormats);
 178
 179     $config = CRM_Core_Config::singleton();
 180     $seperator = $config->fieldSeparator;
 181
 182     $mapper = array();
 183
 184     $parser = new CRM_Contribute_Import_Parser_Contribution($mapper);
 185     $parser->setMaxLinesToProcess(100);
 186     $parser->run($fileName, $seperator,
 187       $mapper,
 188       $skipColumnHeader,
 189       CRM_Import_Parser::MODE_MAPFIELD, $contactType
 190     );
 191
 192     // add all the necessary variables to the form
 193     $parser->set($this);
 194   }
 195
 196   /**
 197    * Return a descriptive name for the page, used in wizard header
 198    *
 199    * @return string
 200    * @access public
 201    */
 202   public function getTitle() {
 203     return ts('Upload Data');
 204   }
 205 }
 206