CRM/Import/Form/DataSource.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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  * @package CRM
  30  * @copyright CiviCRM LLC (c) 2004-2019
  31  */
  32
  33 /**
  34  * Base class for upload-only import forms (all but Contact import).
  35  */
  36 abstract class CRM_Import_Form_DataSource extends CRM_Core_Form {
  37
  38   /**
  39    * Set variables up before form is built.
  40    */
  41   public function preProcess() {
  42     $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this, FALSE);
  43     $params = "reset=1";
  44     if ($this->_id) {
  45       $params .= "&id={$this->_id}";
  46     }
  47     CRM_Core_Session::singleton()->pushUserContext(CRM_Utils_System::url(static::PATH, $params));
  48
  49     // check for post max size
  50     CRM_Utils_Number::formatUnitSize(ini_get('post_max_size'), TRUE);
  51   }
  52
  53   /**
  54    * Common form elements.
  55    */
  56   public function buildQuickForm() {
  57     $config = CRM_Core_Config::singleton();
  58
  59     $uploadFileSize = CRM_Utils_Number::formatUnitSize($config->maxFileSize . 'm', TRUE);
  60
  61     //Fetch uploadFileSize from php_ini when $config->maxFileSize is set to "no limit".
  62     if (empty($uploadFileSize)) {
  63       $uploadFileSize = CRM_Utils_Number::formatUnitSize(ini_get('upload_max_filesize'), TRUE);
  64     }
  65     $uploadSize = round(($uploadFileSize / (1024 * 1024)), 2);
  66
  67     $this->assign('uploadSize', $uploadSize);
  68
  69     $this->add('File', 'uploadFile', ts('Import Data File'), 'size=30 maxlength=255', TRUE);
  70     $this->setMaxFileSize($uploadFileSize);
  71     $this->addRule('uploadFile', ts('File size should be less than %1 MBytes (%2 bytes)', [
  72       1 => $uploadSize,
  73       2 => $uploadFileSize,
  74     ]), 'maxfilesize', $uploadFileSize);
  75     $this->addRule('uploadFile', ts('A valid file must be uploaded.'), 'uploadedfile');
  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     $this->add('text', 'fieldSeparator', ts('Import Field Separator'), ['size' => 2], TRUE);
  81     $this->setDefaults(['fieldSeparator' => $config->fieldSeparator]);
  82     $mappingArray = CRM_Core_BAO_Mapping::getCreateMappingValues('Import ' . static::IMPORT_ENTITY);
  83
  84     $this->assign('savedMapping', $mappingArray);
  85     $this->add('select', 'savedMapping', ts('Mapping Option'), ['' => ts('- select -')] + $mappingArray);
  86
  87     if ($loadedMapping = $this->get('loadedMapping')) {
  88       $this->assign('loadedMapping', $loadedMapping);
  89       $this->setDefaults(['savedMapping' => $loadedMapping]);
  90     }
  91
  92     //build date formats
  93     CRM_Core_Form_Date::buildAllowedDateFormats($this);
  94
  95     $this->addButtons([
  96         [
  97           'type' => 'upload',
  98           'name' => ts('Continue'),
  99           'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 100           'isDefault' => TRUE,
 101         ],
 102         [
 103           'type' => 'cancel',
 104           'name' => ts('Cancel'),
 105         ],
 106     ]);
 107   }
 108
 109   /**
 110    * A long-winded way to add one radio element to the form.
 111    */
 112   protected function addContactTypeSelector() {
 113     //contact types option
 114     $contactOptions = [];
 115     if (CRM_Contact_BAO_ContactType::isActive('Individual')) {
 116       $contactOptions[] = $this->createElement('radio',
 117         NULL, NULL, ts('Individual'), CRM_Import_Parser::CONTACT_INDIVIDUAL
 118       );
 119     }
 120     if (CRM_Contact_BAO_ContactType::isActive('Household')) {
 121       $contactOptions[] = $this->createElement('radio',
 122         NULL, NULL, ts('Household'), CRM_Import_Parser::CONTACT_HOUSEHOLD
 123       );
 124     }
 125     if (CRM_Contact_BAO_ContactType::isActive('Organization')) {
 126       $contactOptions[] = $this->createElement('radio',
 127         NULL, NULL, ts('Organization'), CRM_Import_Parser::CONTACT_ORGANIZATION
 128       );
 129     }
 130
 131     $this->addGroup($contactOptions, 'contactType',
 132       ts('Contact Type')
 133     );
 134
 135     $this->setDefaults([
 136       'contactType' => CRM_Import_Parser::CONTACT_INDIVIDUAL,
 137     ]);
 138   }
 139
 140   /**
 141    * Store form values.
 142    *
 143    * @param array $names
 144    */
 145   protected function storeFormValues($names) {
 146     foreach ($names as $name) {
 147       $this->set($name, $this->controller->exportValue($this->_name, $name));
 148     }
 149   }
 150
 151   /**
 152    * Common form postProcess.
 153    *
 154    * @param string $parserClassName
 155    *
 156    * @param string|null $entity
 157    *   Entity to set for paraser currently only for custom import
 158    */
 159   protected function submitFileForMapping($parserClassName, $entity = NULL) {
 160     $this->controller->resetPage('MapField');
 161
 162     $fileName = $this->controller->exportValue($this->_name, 'uploadFile');
 163     $skipColumnHeader = $this->controller->exportValue($this->_name, 'skipColumnHeader');
 164
 165     $session = CRM_Core_Session::singleton();
 166     $session->set("dateTypes", $this->get('dateFormats'));
 167
 168     $separator = $this->controller->exportValue($this->_name, 'fieldSeparator');
 169
 170     $mapper = [];
 171
 172     $parser = new $parserClassName($mapper);
 173     if ($entity) {
 174       $parser->setEntity($this->get($entity));
 175     }
 176     $parser->setMaxLinesToProcess(100);
 177     $parser->run($fileName,
 178       $separator,
 179       $mapper,
 180       $skipColumnHeader,
 181       CRM_Import_Parser::MODE_MAPFIELD,
 182       $this->get('contactType')
 183     );
 184
 185     // add all the necessary variables to the form
 186     $parser->set($this);
 187   }
 188
 189   /**
 190    * Return a descriptive name for the page, used in wizard header.
 191    *
 192    * @return string
 193    */
 194   public function getTitle() {
 195     return ts('Upload Data');
 196   }
 197
 198 }