X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FCore%2FDAO.php;h=9dea4c8676c42c669c29ef1ff6012a5e55c7a365;hb=9ab99c19a4663b23a3175405e07b27b6eadafcd8;hp=3e50ccf7f52c726c1b5b0fecf4540976be5b20ea;hpb=6a8a864774d6e5f5e272879f89890bcf6b3d592a;p=civicrm-core.git diff --git a/CRM/Core/DAO.php b/CRM/Core/DAO.php index 3e50ccf7f5..9dea4c8676 100644 --- a/CRM/Core/DAO.php +++ b/CRM/Core/DAO.php @@ -1,7 +1,7 @@ _connect(); + $this->query("SET NAMES utf8"); } /** @@ -598,7 +601,7 @@ LIKE %1 * * @return boolean true if CONSTRAINT keyword exists, false otherwise */ - function schemaRequiresRebuilding($tables = array("civicrm_contact")) { + static function schemaRequiresRebuilding($tables = array("civicrm_contact")) { $show = array(); foreach($tables as $tableName){ if (!array_key_exists($tableName, $show)) { @@ -1262,6 +1265,11 @@ SELECT contact_id $numObjects = 1, $createOnly = FALSE ) { + //this is a test function also backtrace is set for the test suite it sometimes unsets itself + // so we re-set here in case + $config = CRM_Core_Config::singleton(); + $config->backtrace = TRUE; + static $counter = 0; CRM_Core_DAO::$_testEntitiesToSkip = array( 'CRM_Core_DAO_Worldregion', @@ -1293,6 +1301,10 @@ SELECT contact_id //skip the FK if it is not required // if it's contact id we should create even if not required // we'll have a go @ fetching first though + // we WILL create campaigns though for so tests with a campaign pseudoconstant will complete + if($FKClassName === 'CRM_Campaign_DAO_Campaign' && $daoName != $FKClassName) { + $required = TRUE; + } if (!$required && $dbName != 'contact_id') { $fkDAO = new $FKClassName; if($fkDAO->find(TRUE)){ @@ -1317,10 +1329,12 @@ SELECT contact_id continue; } // Pick an option value if needed - $options = $daoName::buildOptions($dbName); - if ($options) { - $object->$dbName = key($options); - continue; + if ($value['type'] !== CRM_Utils_Type::T_BOOLEAN) { + $options = $daoName::buildOptions($dbName, 'create'); + if ($options) { + $object->$dbName = key($options); + continue; + } } switch ($value['type']) { @@ -1330,7 +1344,6 @@ SELECT contact_id $object->$dbName = $counter; break; - case CRM_Utils_Type::T_BOOL: case CRM_Utils_Type::T_BOOLEAN: if (isset($value['default'])) { $object->$dbName = $value['default']; @@ -1345,7 +1358,12 @@ SELECT contact_id case CRM_Utils_Type::T_DATE: case CRM_Utils_Type::T_TIMESTAMP: + case CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME: $object->$dbName = '19700101'; + if($dbName == 'end_date') { + // put this in the future + $object->$dbName = '20200101'; + } break; case CRM_Utils_Type::T_TIME: @@ -1415,8 +1433,12 @@ SELECT contact_id static function deleteTestObjects($daoName, $params = array( )) { + //this is a test function also backtrace is set for the test suite it sometimes unsets itself + // so we re-set here in case + $config = CRM_Core_Config::singleton(); + $config->backtrace = TRUE; - $object = new $daoName ( ); + $object = new $daoName(); $object->id = CRM_Utils_Array::value('id', $params); $deletions = array(); // array(array(0 => $daoName, 1 => $daoParams)) @@ -1525,11 +1547,11 @@ SELECT contact_id * @param $tableName string the specific table requiring a rebuild; or NULL to rebuild all tables * @see CRM-9716 */ - static function triggerRebuild($tableName = NULL) { + static function triggerRebuild($tableName = NULL, $force = FALSE) { $info = array(); $logging = new CRM_Logging_Schema; - $logging->triggerInfo($info, $tableName); + $logging->triggerInfo($info, $tableName, $force); CRM_Core_I18n_Schema::triggerInfo($info, $tableName); CRM_Contact_BAO_Contact::triggerInfo($info, $tableName); @@ -1543,6 +1565,23 @@ SELECT contact_id self::createTriggers($info); } + /** + * Because sql functions are sometimes lost, esp during db migration, we check here to avoid numerous support requests + * @see http://issues.civicrm.org/jira/browse/CRM-13822 + * TODO: Alternative solutions might be + * * Stop using functions and find another way to strip numeric characters from phones + * * Give better error messages (currently a missing fn fatals with "unknown error") + */ + static function checkSqlFunctionsExist() { + if (!self::$_checkedSqlFunctionsExist) { + self::$_checkedSqlFunctionsExist = TRUE; + $dao = CRM_Core_DAO::executeQuery("SHOW function status WHERE db = database() AND name = 'civicrm_strip_non_numeric'"); + if (!$dao->fetch()) { + self::triggerRebuild(); + } + } + } + /** * Wrapper function to drop triggers * @@ -1649,7 +1688,8 @@ SELECT contact_id foreach ($events as $whenName => $parts) { $varString = implode("\n", $parts['variables']); $sqlString = implode("\n", $parts['sql']); - $triggerName = "{$tableName}_{$whenName}_{$eventName}"; + $validName = CRM_Core_DAO::shortenSQLName($tableName, 48, TRUE); + $triggerName = "{$validName}_{$whenName}_{$eventName}"; $triggerSQL = "CREATE TRIGGER $triggerName $whenName $eventName ON $tableName FOR EACH ROW BEGIN $varString $sqlString END"; CRM_Core_DAO::executeQuery("DROP TRIGGER IF EXISTS $triggerName"); @@ -1758,9 +1798,9 @@ EOS; * This function can be overridden by each BAO to add more logic related to context. * The overriding function will generally call the lower-level CRM_Core_PseudoConstant::get * - * @param String $fieldName - * @param String $context: @see CRM_Core_DAO::buildOptionsContext - * @param Array $props: whatever is known about this bao object + * @param string $fieldName + * @param string $context: @see CRM_Core_DAO::buildOptionsContext + * @param array $props: whatever is known about this bao object */ public static function buildOptions($fieldName, $context = NULL, $props = array()) { // If a given bao does not override this function @@ -1768,6 +1808,29 @@ EOS; return CRM_Core_PseudoConstant::get($baoName, $fieldName, array(), $context); } + /** + * Populate option labels for this object's fields. + * + * @throws exception if called directly on the base class + */ + public function getOptionLabels() { + $fields = $this->fields(); + if ($fields === NULL) { + throw new Exception ('Cannot call getOptionLabels on CRM_Core_DAO'); + } + foreach ($fields as $field) { + $name = CRM_Utils_Array::value('name', $field); + if ($name && isset($this->$name)) { + $label = CRM_Core_PseudoConstant::getLabel(get_class($this), $name, $this->$name); + if ($label !== FALSE) { + // Append 'label' onto the field name + $labelName = $name . '_label'; + $this->$labelName = $label; + } + } + } + } + /** * Provides documentation and validation for the buildOptions $context param * @@ -1782,10 +1845,126 @@ EOS; ); // Validation: enforce uniformity of this param if ($context !== NULL && !isset($contexts[$context])) { - throw new exception("'$context' is not a valid context for buildOptions."); + throw new Exception("'$context' is not a valid context for buildOptions."); } return $contexts; } -} + /** + * SQL version of api function to assign filters to the DAO based on the syntax + * $field => array('IN' => array(4,6,9)) + * OR + * $field => array('LIKE' => array('%me%)) + * etc + * + * @param $fieldname string name of fields + * @param $filter array filter to be applied indexed by operator + * @param $type String type of field (not actually used - nor in api @todo ) + * @param $alias String alternative field name ('as') @todo- not actually used + * @param bool $returnSanitisedArray return a sanitised array instead of a clause + * this is primarily so we can add filters @ the api level to the Query object based fields + * @todo a better solutution would be for the query object to apply these filters based on the + * api supported format (but we don't want to risk breakage in alpha stage & query class is scary + * @todo @time of writing only IN & NOT IN are supported for the array style syntax (as test is + * required to extend further & it may be the comments per above should be implemented. It may be + * preferable to not double-banger the return context next refactor of this - but keeping the attention + * in one place has some advantages as we try to extend this format + * + * @return NULL|string|array a string is returned if $returnSanitisedArray is not set, otherwise and Array or NULL + * depending on whether it is supported as yet + **/ + public static function createSQLFilter($fieldName, $filter, $type, $alias = NULL, $returnSanitisedArray = FALSE) { + // http://issues.civicrm.org/jira/browse/CRM-9150 - stick with 'simple' operators for now + // support for other syntaxes is discussed in ticket but being put off for now + $acceptedSQLOperators = array('=', '<=', '>=', '>', '<', 'LIKE', "<>", "!=", "NOT LIKE", 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN'); + foreach ($filter as $operator => $criteria) { + if (in_array($operator, $acceptedSQLOperators)) { + switch ($operator) { + // unary operators + case 'IS NULL': + case 'IS NOT NULL': + if(!$returnSanitisedArray) { + return (sprintf('%s %s', $fieldName, $operator)); + } + else{ + return NULL; // not yet implemented (tests required to implement) + } + break; + + // ternary operators + case 'BETWEEN': + case 'NOT BETWEEN': + if (empty($criteria[0]) || empty($criteria[1])) { + throw new Exception("invalid criteria for $operator"); + } + if(!$returnSanitisedArray) { + return (sprintf('%s ' . $operator . ' "%s" AND "%s"', $fieldName, CRM_Core_DAO::escapeString($criteria[0]), CRM_Core_DAO::escapeString($criteria[1]))); + } + else{ + return NULL; // not yet implemented (tests required to implement) + } + break; + + // n-ary operators + case 'IN': + case 'NOT IN': + if (empty($criteria)) { + throw new Exception("invalid criteria for $operator"); + } + $escapedCriteria = array_map(array( + 'CRM_Core_DAO', + 'escapeString' + ), $criteria); + if(!$returnSanitisedArray) { + return (sprintf('%s %s ("%s")', $fieldName, $operator, implode('", "', $escapedCriteria))); + } + return $escapedCriteria; + break; + + // binary operators + + default: + if(!$returnSanitisedArray) { + return(sprintf('%s %s "%s"', $fieldName, $operator, CRM_Core_DAO::escapeString($criteria))); + } + else{ + return NULL; // not yet implemented (tests required to implement) + } + } + } + } + } + + /** + * SQL has a limit of 64 characters on various names: + * table name, trigger name, column name ... + * + * For custom groups and fields we generated names from user entered input + * which can be longer than this length, this function helps with creating + * strings that meet various criteria. + * + * @param string $string - the string to be shortened + * @param int $length - the max length of the string + */ + public static function shortenSQLName($string, $length = 60, $makeRandom = FALSE) { + // early return for strings that meet the requirements + if (strlen($string) <= $length) { + return $string; + } + + // easy return for calls that dont need a randomized uniq string + if (! $makeRandom) { + return substr($string, 0, $length); + } + // the string is longer than the length and we need a uniq string + // for the same tablename we need the same uniq string everytime + // hence we use md5 on the string, which is not random + // we'll append 8 characters to the end of the tableName + $md5string = substr(md5($string), 0, 8); + return substr($string, 0, $length - 8) . "_{$md5string}"; + } + + function setApiFilter(&$params) {} + +}