CRM/Import/DataSource/SQL.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   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 class CRM_Import_DataSource_SQL extends CRM_Import_DataSource {
  36
  37   /**
  38    * Provides information about the data source
  39    *
  40    * @return array collection of info about this data source
  41    *
  42    *
  43    */
  44   public function getInfo() {
  45     return array('title' => ts('SQL Query'));
  46   }
  47
  48   /**
  49    * Set variables up before form is built
  50    *
  51    */
  52   public function preProcess(&$form) {}
  53
  54   /**
  55    * This is function is called by the form object to get the DataSource's
  56    * form snippet. It should add all fields necesarry to get the data
  57    * uploaded to the temporary table in the DB.
  58    *
  59    * @param CRM_Core_Form $form
  60    *
  61    * @return void (operates directly on form argument)
  62    */
  63   public function buildQuickForm(&$form) {
  64     $form->add('hidden', 'hidden_dataSource', 'CRM_Import_DataSource_SQL');
  65     $form->add('textarea', 'sqlQuery', ts('Specify SQL Query'), 'rows=10 cols=45', TRUE);
  66     $form->addFormRule(array('CRM_Import_DataSource_SQL', 'formRule'), $form);
  67   }
  68
  69   /**
  70    * @param $fields
  71    * @param $files
  72    * @param CRM_Core_Form $form
  73    *
  74    * @return array|bool
  75    */
  76   public static function formRule($fields, $files, $form) {
  77     $errors = array();
  78
  79     // poor man's query validation (case-insensitive regex matching on word boundaries)
  80     $forbidden = array('ALTER', 'CREATE', 'DELETE', 'DESCRIBE', 'DROP', 'SHOW', 'UPDATE', 'information_schema');
  81     foreach ($forbidden as $pattern) {
  82       if (preg_match("/\\b$pattern\\b/i", $fields['sqlQuery'])) {
  83         $errors['sqlQuery'] = ts('The query contains the forbidden %1 command.', array(1 => $pattern));
  84       }
  85     }
  86
  87     return $errors ? $errors : TRUE;
  88   }
  89
  90   /**
  91    * Process the form submission
  92    *
  93    */
  94   public function postProcess(&$params, &$db, &$form) {
  95     $importJob = new CRM_Contact_Import_ImportJob(
  96       CRM_Utils_Array::value( 'import_table_name', $params ),
  97       $params['sqlQuery'], true
  98     );
  99
 100     $form->set('importTableName', $importJob->getTableName());
 101   }
 102 }