4 * Read the schema specification and parse into internal data structures
6 class CRM_Core_CodeGen_Specification
{
10 protected $classNames;
16 * @param string $buildVersion
17 * Which version of the schema to build.
18 * @param bool $verbose
20 public function parse($schemaPath, $buildVersion, $verbose = TRUE) {
21 $this->buildVersion
= $buildVersion;
24 echo "Parsing schema description " . $schemaPath . "\n";
26 $dbXML = CRM_Core_CodeGen_Util_Xml
::parse($schemaPath);
29 echo "Extracting database information\n";
31 $this->database
= &$this->getDatabase($dbXML);
33 $this->classNames
= [];
35 // TODO: peel DAO-specific stuff out of getTables, and spec reading into its own class
37 echo "Extracting table information\n";
39 $this->tables
= $this->getTables($dbXML, $this->database
);
41 $this->resolveForeignKeys($this->tables
, $this->classNames
);
42 $this->tables
= $this->orderTables($this->tables
);
44 // add archive tables here
45 foreach ($this->tables
as $name => $table) {
46 if ($table['archive'] == 'true') {
47 $name = 'archive_' . $table['name'];
48 $table['name'] = $name;
49 $table['archive'] = 'false';
50 if (isset($table['foreignKey'])) {
51 foreach ($table['foreignKey'] as $fkName => $fkValue) {
52 if ($this->tables
[$fkValue['table']]['archive'] == 'true') {
53 $table['foreignKey'][$fkName]['table'] = 'archive_' . $table['foreignKey'][$fkName]['table'];
54 $table['foreignKey'][$fkName]['uniqName']
55 = str_replace('FK_', 'FK_archive_', $table['foreignKey'][$fkName]['uniqName']);
58 $archiveTables[$name] = $table;
69 public function &getDatabase(&$dbXML) {
70 $database = ['name' => trim((string ) $dbXML->name
)];
73 $this->checkAndAppend($attributes, $dbXML, 'character_set', 'DEFAULT CHARACTER SET ', '');
74 $this->checkAndAppend($attributes, $dbXML, 'collate', 'COLLATE ', '');
75 $database['attributes'] = $attributes;
77 $tableAttributes_modern = $tableAttributes_simple = '';
78 $this->checkAndAppend($tableAttributes_modern, $dbXML, 'table_type', 'ENGINE=', '');
79 $this->checkAndAppend($tableAttributes_simple, $dbXML, 'table_type', 'TYPE=', '');
80 $database['tableAttributes_modern'] = trim($tableAttributes_modern . ' ' . $attributes);
81 $database['tableAttributes_simple'] = trim($tableAttributes_simple);
83 $database['comment'] = $this->value('comment', $dbXML, '');
94 public function getTables($dbXML, &$database) {
96 foreach ($dbXML->tables
as $tablesXML) {
97 foreach ($tablesXML->table
as $tableXML) {
98 if ($this->value('drop', $tableXML, 0) > 0 && version_compare($this->value('drop', $tableXML, 0), $this->buildVersion
, '<=')) {
102 if (version_compare($this->value('add', $tableXML, 0), $this->buildVersion
, '<=')) {
103 $this->getTable($tableXML, $database, $tables);
113 * @param string $classNames
115 public function resolveForeignKeys(&$tables, &$classNames) {
116 foreach (array_keys($tables) as $name) {
117 $this->resolveForeignKey($tables, $classNames, $name);
123 * @param string $classNames
124 * @param string $name
126 public function resolveForeignKey(&$tables, &$classNames, $name) {
127 if (!array_key_exists('foreignKey', $tables[$name])) {
131 foreach (array_keys($tables[$name]['foreignKey']) as $fkey) {
132 $ftable = $tables[$name]['foreignKey'][$fkey]['table'];
133 if (!array_key_exists($ftable, $classNames)) {
134 echo "$ftable is not a valid foreign key table in $name\n";
137 $tables[$name]['foreignKey'][$fkey]['className'] = $classNames[$ftable];
138 $tables[$name]['foreignKey'][$fkey]['fileName'] = str_replace('_', '/', $classNames[$ftable]) . '.php';
139 $tables[$name]['fields'][$fkey]['FKClassName'] = $classNames[$ftable];
148 public function orderTables(&$tables) {
151 while (!empty($tables)) {
152 foreach (array_keys($tables) as $name) {
153 if ($this->validTable($tables, $ordered, $name)) {
154 $ordered[$name] = $tables[$name];
155 unset($tables[$name]);
165 * @param string $name
169 public function validTable(&$tables, &$valid, $name) {
170 if (!array_key_exists('foreignKey', $tables[$name])) {
174 foreach (array_keys($tables[$name]['foreignKey']) as $fkey) {
175 $ftable = $tables[$name]['foreignKey'][$fkey]['table'];
176 if (!array_key_exists($ftable, $valid) && $ftable !== $name) {
188 public function getTable($tableXML, &$database, &$tables) {
189 $name = trim((string ) $tableXML->name
);
190 $klass = trim((string ) $tableXML->class);
191 $base = $this->value('base', $tableXML);
192 $sourceFile = "xml/schema/{$base}/{$klass}.xml";
193 $daoPath = "{$base}/DAO/";
194 $baoPath = __DIR__
. '/../../../' . str_replace(' ', '', "{$base}/BAO/");
195 $useBao = $this->value('useBao', $tableXML, file_exists($baoPath . $klass . '.php'));
196 $pre = str_replace('/', '_', $daoPath);
197 $this->classNames
[$name] = $pre . $klass;
199 $localizable = FALSE;
200 foreach ($tableXML->field
as $fieldXML) {
201 if ($fieldXML->localizable
) {
210 'sourceFile' => $sourceFile,
211 'fileName' => $klass . '.php',
212 'objectName' => $klass,
213 'title' => $tableXML->title ?? self
::nameToTitle($klass),
214 'icon' => $tableXML->icon ??
NULL,
215 'labelName' => substr($name, 8),
216 'className' => $this->classNames
[$name],
217 'bao' => ($useBao ?
str_replace('DAO', 'BAO', $this->classNames
[$name]) : $this->classNames
[$name]),
219 'attributes_simple' => trim($database['tableAttributes_simple']),
220 'attributes_modern' => trim($database['tableAttributes_modern']),
221 'comment' => $this->value('comment', $tableXML),
222 'localizable' => $localizable,
223 'log' => $this->value('log', $tableXML, 'false'),
224 'archive' => $this->value('archive', $tableXML, 'false'),
228 foreach ($tableXML->field
as $fieldXML) {
229 if ($this->value('drop', $fieldXML, 0) > 0 && version_compare($this->value('drop', $fieldXML, 0), $this->buildVersion
, '<=')) {
233 if (version_compare($this->value('add', $fieldXML, 0), $this->buildVersion
, '<=')) {
234 $this->getField($fieldXML, $fields);
238 $table['fields'] = &$fields;
240 if ($this->value('primaryKey', $tableXML)) {
241 $this->getPrimaryKey($tableXML->primaryKey
, $fields, $table);
244 if ($this->value('index', $tableXML)) {
246 foreach ($tableXML->index
as $indexXML) {
247 if ($this->value('drop', $indexXML, 0) > 0 && version_compare($this->value('drop', $indexXML, 0), $this->buildVersion
, '<=')) {
251 $this->getIndex($indexXML, $fields, $index);
253 CRM_Core_BAO_SchemaHandler
::addIndexSignature($name, $index);
254 $table['index'] = &$index;
257 if ($this->value('foreignKey', $tableXML)) {
259 foreach ($tableXML->foreignKey
as $foreignXML) {
261 if ($this->value('drop', $foreignXML, 0) > 0 && version_compare($this->value('drop', $foreignXML, 0), $this->buildVersion
, '<=')) {
264 if (version_compare($this->value('add', $foreignXML, 0), $this->buildVersion
, '<=')) {
265 $this->getForeignKey($foreignXML, $fields, $foreign, $name);
268 $table['foreignKey'] = &$foreign;
271 if ($this->value('dynamicForeignKey', $tableXML)) {
272 $dynamicForeign = [];
273 foreach ($tableXML->dynamicForeignKey
as $foreignXML) {
274 if ($this->value('drop', $foreignXML, 0) > 0 && version_compare($this->value('drop', $foreignXML, 0), $this->buildVersion
, '<=')) {
277 if (version_compare($this->value('add', $foreignXML, 0), $this->buildVersion
, '<=')) {
278 $this->getDynamicForeignKey($foreignXML, $dynamicForeign, $name);
281 $table['dynamicForeignKey'] = $dynamicForeign;
284 $tables[$name] = &$table;
291 public function getField(&$fieldXML, &$fields) {
292 $name = trim((string ) $fieldXML->name
);
293 $field = ['name' => $name, 'localizable' => ((bool) $fieldXML->localizable
) ?
1 : 0];
294 $type = (string ) $fieldXML->type
;
298 $field['length'] = (int) $fieldXML->length
;
299 $field['sqlType'] = "$type({$field['length']})";
300 $field['phpType'] = 'string';
301 $field['crmType'] = 'CRM_Utils_Type::T_STRING';
302 $field['size'] = $this->getSize($fieldXML);
306 $field['sqlType'] = $field['phpType'] = $type;
307 $field['crmType'] = 'CRM_Utils_Type::T_' . strtoupper($type);
308 // CRM-13497 see fixme below
309 $field['rows'] = isset($fieldXML->html
) ?
$this->value('rows', $fieldXML->html
) : NULL;
310 $field['cols'] = isset($fieldXML->html
) ?
$this->value('cols', $fieldXML->html
) : NULL;
316 $field['sqlType'] = $field['phpType'] = $type;
317 $field['crmType'] = 'CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME';
321 // need this case since some versions of mysql do not have boolean as a valid column type and hence it
322 // is changed to tinyint. hopefully after 2 yrs this case can be removed.
323 $field['sqlType'] = 'tinyint';
324 $field['phpType'] = 'bool';
325 $field['crmType'] = 'CRM_Utils_Type::T_' . strtoupper($type);
329 $length = $fieldXML->length ?
$fieldXML->length
: '20,2';
330 $field['sqlType'] = 'decimal(' . $length . ')';
331 $field['phpType'] = 'float';
332 $field['crmType'] = 'CRM_Utils_Type::T_MONEY';
333 $field['precision'] = $length . ',';
337 $field['sqlType'] = 'double';
338 $field['phpType'] = 'float';
339 $field['crmType'] = 'CRM_Utils_Type::T_FLOAT';
343 $field['phpType'] = $this->value('phpType', $fieldXML, $type);
344 $field['sqlType'] = $type;
345 if ($type == 'int unsigned' ||
$type == 'tinyint') {
346 $field['phpType'] = 'int';
347 $field['crmType'] = 'CRM_Utils_Type::T_INT';
350 $field['crmType'] = $this->value('crmType', $fieldXML, 'CRM_Utils_Type::T_' . strtoupper($type));
355 $field['required'] = $this->value('required', $fieldXML);
356 $field['collate'] = $this->value('collate', $fieldXML);
357 $field['comment'] = $this->value('comment', $fieldXML);
358 $field['default'] = $this->value('default', $fieldXML);
359 $field['import'] = $this->value('import', $fieldXML);
360 if ($this->value('export', $fieldXML)) {
361 $field['export'] = $this->value('export', $fieldXML);
364 $field['export'] = $this->value('import', $fieldXML);
366 $field['rule'] = $this->value('rule', $fieldXML);
367 $field['title'] = $this->value('title', $fieldXML);
368 if (!$field['title']) {
369 $field['title'] = $this->composeTitle($name);
371 $field['headerPattern'] = $this->value('headerPattern', $fieldXML);
372 $field['dataPattern'] = $this->value('dataPattern', $fieldXML);
373 $field['uniqueName'] = $this->value('uniqueName', $fieldXML);
374 $field['uniqueTitle'] = $this->value('uniqueTitle', $fieldXML);
375 $field['serialize'] = $this->value('serialize', $fieldXML);
376 $field['html'] = $this->value('html', $fieldXML);
377 $field['contactType'] = $this->value('contactType', $fieldXML);
378 if (isset($fieldXML->permission
)) {
379 $field['permission'] = trim($this->value('permission', $fieldXML));
380 $field['permission'] = $field['permission'] ?
array_filter(array_map('trim', explode(',', $field['permission']))) : [];
381 if (isset($fieldXML->permission
->or)) {
382 $field['permission'][] = array_filter(array_map('trim', explode(',', $fieldXML->permission
->or)));
385 if (!empty($field['html'])) {
391 /* Fixme: prior to CRM-13497 these were in a flat structure
392 // CRM-13497 moved them to be nested within 'html' but there's no point
393 // making that change in the DAOs right now since we are in the process of
394 // moving to docrtine anyway.
395 // So translating from nested xml back to flat structure for now.
401 foreach ($validOptions as $htmlOption) {
402 if (!empty($fieldXML->html
->$htmlOption)) {
403 $field['html'][$htmlOption] = $this->value($htmlOption, $fieldXML->html
);
408 // in multilingual context popup, we need extra information to create appropriate widget
409 if ($fieldXML->localizable
) {
410 if (isset($fieldXML->html
)) {
411 $field['widget'] = (array) $fieldXML->html
;
415 $field['widget'] = ['type' => 'Text'];
417 if (isset($fieldXML->required
)) {
418 $field['widget']['required'] = $this->value('required', $fieldXML);
421 if (isset($fieldXML->localize_context
)) {
422 $field['localize_context'] = $fieldXML->localize_context
;
424 $field['add'] = $this->value('add', $fieldXML);
425 $field['pseudoconstant'] = $this->value('pseudoconstant', $fieldXML);
426 if (!empty($field['pseudoconstant'])) {
427 //ok this is a bit long-winded but it gets there & is consistent with above approach
428 $field['pseudoconstant'] = [];
430 // Fields can specify EITHER optionGroupName OR table, not both
431 // (since declaring optionGroupName means we are using the civicrm_option_value table)
434 // If table is specified, keyColumn and labelColumn are also required
437 // Non-translated machine name for programmatic lookup. Defaults to 'name' if that column exists
439 // Column to fetch in "abbreviate" context
441 // Where clause snippet (will be joined to the rest of the query with AND operator)
443 // callback function incase of static arrays
445 // Path to options edit form
448 foreach ($validOptions as $pseudoOption) {
449 if (!empty($fieldXML->pseudoconstant
->$pseudoOption)) {
450 $field['pseudoconstant'][$pseudoOption] = $this->value($pseudoOption, $fieldXML->pseudoconstant
);
453 if (!isset($field['pseudoconstant']['optionEditPath']) && !empty($field['pseudoconstant']['optionGroupName'])) {
454 $field['pseudoconstant']['optionEditPath'] = 'civicrm/admin/options/' . $field['pseudoconstant']['optionGroupName'];
456 // For now, fields that have option lists that are not in the db can simply
457 // declare an empty pseudoconstant tag and we'll add this placeholder.
458 // That field's BAO::buildOptions fn will need to be responsible for generating the option list
459 if (empty($field['pseudoconstant'])) {
460 $field['pseudoconstant'] = 'not in database';
463 $fields[$name] = &$field;
467 * @param string $name
471 public function composeTitle($name) {
472 $names = explode('_', strtolower($name));
474 for ($i = 0; $i < count($names); $i++
) {
475 if ($names[$i] === 'id' ||
$names[$i] === 'is') {
476 // id's do not get titles
480 if ($names[$i] === 'im') {
484 $names[$i] = ucfirst(trim($names[$i]));
487 $title = $title . ' ' . $names[$i];
493 * @param object $primaryXML
494 * @param array $fields
495 * @param array $table
497 public function getPrimaryKey(&$primaryXML, &$fields, &$table) {
498 $name = trim((string ) $primaryXML->name
);
500 // set the autoincrement property of the field
501 $auto = $this->value('autoincrement', $primaryXML);
502 if (isset($fields[$name])) {
503 $fields[$name]['autoincrement'] = $auto;
505 $fields[$name]['autoincrement'] = $auto;
508 'autoincrement' => $auto,
512 foreach ($primaryXML->fieldName
as $v) {
513 $fieldName = (string) ($v);
514 $length = (string) ($v['length']);
515 if (strlen($length) > 0) {
516 $fieldName = "$fieldName($length)";
518 $primaryKey['field'][] = $fieldName;
521 // when field array is empty set it to the name of the primary key.
522 if (empty($primaryKey['field'])) {
523 $primaryKey['field'][] = $name;
526 // all fieldnames have to be defined and should exist in schema.
527 foreach ($primaryKey['field'] as $fieldName) {
529 echo "Invalid field defination for index $name\n";
532 $parenOffset = strpos($fieldName, '(');
533 if ($parenOffset > 0) {
534 $fieldName = substr($fieldName, 0, $parenOffset);
536 if (!array_key_exists($fieldName, $fields)) {
537 echo "Table does not contain $fieldName\n";
543 $table['primaryKey'] = &$primaryKey;
551 public function getIndex(&$indexXML, &$fields, &$indices) {
552 //echo "\n\n*******************************************************\n";
553 //echo "entering getIndex\n";
556 // empty index name is fine
557 $indexName = trim((string) $indexXML->name
);
558 $index['name'] = $indexName;
559 $index['field'] = [];
562 foreach ($indexXML->fieldName
as $v) {
563 $fieldName = (string) ($v);
564 $length = (string) ($v['length']);
565 if (strlen($length) > 0) {
566 $fieldName = "$fieldName($length)";
568 $index['field'][] = $fieldName;
571 $index['localizable'] = FALSE;
572 foreach ($index['field'] as $fieldName) {
573 if (isset($fields[$fieldName]) and $fields[$fieldName]['localizable']) {
574 $index['localizable'] = TRUE;
579 // check for unique index
580 if ($this->value('unique', $indexXML)) {
581 $index['unique'] = TRUE;
584 // field array cannot be empty
585 if (empty($index['field'])) {
586 echo "No fields defined for index $indexName\n";
590 // all fieldnames have to be defined and should exist in schema.
591 foreach ($index['field'] as $fieldName) {
593 echo "Invalid field defination for index $indexName\n";
596 $parenOffset = strpos($fieldName, '(');
597 if ($parenOffset > 0) {
598 $fieldName = substr($fieldName, 0, $parenOffset);
600 if (!array_key_exists($fieldName, $fields)) {
601 echo "Table does not contain $fieldName\n";
606 $indices[$indexName] = &$index;
612 * @param $foreignKeys
613 * @param string $currentTableName
615 public function getForeignKey(&$foreignXML, &$fields, &$foreignKeys, &$currentTableName) {
616 $name = trim((string ) $foreignXML->name
);
618 /** need to make sure there is a field of type name */
619 if (!array_key_exists($name, $fields)) {
620 echo "foreign $name in $currentTableName does not have a field definition, ignoring\n";
624 /** need to check for existence of table and key **/
625 $table = trim($this->value('table', $foreignXML));
629 'uniqName' => "FK_{$currentTableName}_{$name}",
630 'key' => trim($this->value('key', $foreignXML)),
631 'import' => $this->value('import', $foreignXML, FALSE),
632 'export' => $this->value('import', $foreignXML, FALSE),
633 // we do this matching in a separate phase (resolveForeignKeys)
635 'onDelete' => $this->value('onDelete', $foreignXML, FALSE),
637 $foreignKeys[$name] = &$foreignKey;
642 * @param $dynamicForeignKeys
644 public function getDynamicForeignKey(&$foreignXML, &$dynamicForeignKeys) {
646 'idColumn' => trim($foreignXML->idColumn
),
647 'typeColumn' => trim($foreignXML->typeColumn
),
648 'key' => trim($this->value('key', $foreignXML)),
650 $dynamicForeignKeys[] = $foreignKey;
656 * @param null $default
658 * @return null|string
660 protected function value($key, &$object, $default = NULL) {
661 if (isset($object->$key)) {
662 return (string ) $object->$key;
670 * @param string $name
674 protected function checkAndAppend(&$attributes, &$object, $name, $pre = NULL, $post = NULL) {
675 if (!isset($object->$name)) {
679 $value = $pre . trim($object->$name) . $post;
680 $this->append($attributes, ' ', trim($value));
688 protected function append(&$str, $delim, $name) {
693 if (is_array($name)) {
694 foreach ($name as $n) {
711 $str .= $delim . $name;
717 * Sets the size property of a textfield.
719 * @param string $fieldXML
721 * @return null|string
723 protected function getSize($fieldXML) {
724 // Extract from <size> tag if supplied
725 if (!empty($fieldXML->html
) && $this->value('size', $fieldXML->html
)) {
726 return $this->value('size', $fieldXML->html
);
728 // Infer from <length> tag if <size> was not explicitly set or was invalid
729 // This map is slightly different from CRM_Core_Form_Renderer::$_sizeMapper
730 // Because we usually want fields to render as smaller than their maxlength
740 foreach ($sizes as $length => $name) {
741 if ($fieldXML->length
<= $length) {
742 return "CRM_Utils_Type::$name";
745 return 'CRM_Utils_Type::HUGE';
749 * Converts an entity name to a user friendly string.
751 * @param string $name
754 public static function nameToTitle(string $name) {
755 $name = preg_replace('/([a-z])([A-Z])/', '$1 $2', $name);
756 return CRM_Utils_String
::pluralize($name);