data_ui/data_ui.admin.inc

   1 <?php
   2 // $Id$
   3 /**
   4  * @file
   5  * Admin UI functions.
   6  */
   7
   8 /**
   9  * Overview over all tables.
  10  */
  11 function data_ui_overview() {
  12   $tables = data_get_all_tables();
  13   $rows = array();
  14   foreach ($tables as $table) {
  15     // Build operations depending on configuration status.
  16     $operations = array();
  17     if ($table->get('export_type') == EXPORT_IN_CODE) {
  18       $status = t('Default');
  19       $operations[] = l(t('Override'), 'admin/content/data/edit/'. $table->get('name'));
  20     }
  21     else if ($table->get('export_type') == (EXPORT_IN_CODE | EXPORT_IN_DATABASE)) {
  22       $status = t('Overridden');
  23       $operations[] = l(t('Edit'), 'admin/content/data/edit/'. $table->get('name'));
  24       $operations[] = l(t('Revert'), 'admin/content/data/revert/'. $table->get('name'));
  25     }
  26     else {
  27       $status = t('Normal');
  28       $operations[] = l(t('Edit'), 'admin/content/data/edit/'. $table->get('name'));
  29       $operations[] = l(t('Drop'), 'admin/content/data/drop/'. $table->get('name'));
  30     }
  31     if (module_exists('ctools')) {
  32       $operations[] = l(t('Export'), 'admin/content/data/export/'. $table->get('name'));
  33     }
  34
  35     $row = array();
  36     $row[] = $table->get('name');
  37     $row[] = $status;
  38     $row[] = implode(' | ', $operations);
  39
  40     $rows[] = $row;
  41   }
  42   $rows[] = array(
  43     l(t('Create new table'), 'admin/content/data/create'),
  44     '&nbsp;',
  45     '&nbsp;',
  46   );
  47   $header = array(t('Name'), t('Status'), t('Operations'));
  48   return theme('table', $header, $rows);
  49 }
  50
  51 /**
  52  * Comparison page.
  53  */
  54 function data_ui_compare() {
  55   $rows = array();
  56   $tables = data_get_all_tables();
  57   foreach ($tables as $table) {
  58     $row = array();
  59     $comp = $table->compareSchema();
  60     $row[] = $table->get('name');
  61     $status = $comp['status'];
  62     if ($status != 'same') {
  63       $status .= ' - '. l(t('adjust'), 'admin/content/data/compare/'. $table->get('name'));
  64     }
  65     $row[] = $status;
  66     $row[] = empty($comp['warning']) ? '-' : $comp['warning'];
  67     $rows[] = $row;
  68   }
  69   $header = array(t('Name'), t('Status'), t('Warnings'));
  70   return theme('table', $header, $rows);
  71 }
  72
  73 /**
  74  * Adjust table schema form: Present the user with the difference between schema information and
  75  * the actual schema in the Database and offer three options:
  76  *
  77  * - Adjust schema info,
  78  * - adjust database or
  79  * - leave it.
  80  */
  81 function data_ui_adjust_form(&$form_state, $table) {
  82   drupal_set_title(t('Adjust !table', array('!table' => $table->get('name'))));
  83   $comparison = $table->compareSchema();
  84
  85   $form = array();
  86   $form['#redirect'] = 'admin/content/data/compare';
  87   $form['#table'] = $table;
  88   $form['#comparison'] = $comparison;
  89   $form['comparison'] = array(
  90     '#type' => 'fieldset',
  91     '#title' => t('Comparison'),
  92   );
  93   $form['comparison']['comparison']['#value'] = theme('data_ui_schema_compare_table', $comparison);
  94
  95   if ($comparison['status'] == 'different') {
  96     $form['update_schema'] = array(
  97       '#type' => 'fieldset',
  98       '#title' => t('Option 1: Update schema information'),
  99       );
 100     $form['update_schema']['description'] = array(
 101       '#value' => t('<p>This option will update the schema information about this table.</p>'),
 102     );
 103     $form['update_schema']['submit'] = array(
 104       '#type' => 'submit',
 105       '#submit' => array('data_ui_adjust_form_submit_update_schema'),
 106       '#value' => t('Update schema information'),
 107     );
 108     $form['alter_table'] = array(
 109       '#type' => 'fieldset',
 110       '#title' => t('Option 2: Alter table'),
 111       );
 112     $form['alter_table']['description'] = array(
 113       '#value' => t('<p>Review the changes above carefully!
 114         This option will alter the database table and can very
 115         easily cause data loss.</p>'),
 116     );
 117     $form['alter_table']['submit'] = array(
 118       '#type' => 'submit',
 119       '#submit' => array('data_ui_adjust_form_submit_alter_table'),
 120       '#value' => t('Alter table'),
 121     );
 122   }
 123   elseif ($comparison['status'] == 'missing') {
 124     $form['alter_table'] = array(
 125       '#type' => 'fieldset',
 126       '#title' => t('Create table'),
 127       );
 128     $form['alter_table']['description'] = array(
 129       '#value' => t('<p>Create a new table from schema information.</p>'),
 130     );
 131     $form['alter_table']['submit'] = array(
 132       '#type' => 'submit',
 133       '#submit' => array('data_ui_adjust_form_submit_create_table'),
 134       '#value' => t('Create table'),
 135     );
 136   }
 137   $form['cancel'] = array(
 138     '#type' => 'fieldset',
 139     '#title' => t('Don\'t change anything'),
 140     );
 141   $form['cancel']['cancel'] = array(
 142     '#type' => 'submit',
 143     '#value' => t('Cancel'),
 144   );
 145   return $form;
 146 }
 147
 148 /**
 149  * Submit handler for data_ui_adjust_form().
 150  */
 151 function data_ui_adjust_form_submit_update_schema($form, &$form_state) {
 152   $table = $form['#table'];
 153   $schema = schema_invoke('inspect');
 154   if (isset($schema[$table->get('name')])) {
 155     $table->update(array('table_schema' => $schema[$table->get('name')]));
 156     drupal_set_message(t('Updated schema for !table', array('!table' => $table->get('name'))));
 157   }
 158   else {
 159     drupal_set_message(t('Error updating schema'), 'error');
 160   }
 161 }
 162
 163 /**
 164  * Submit handler for data_ui_adjust_form().
 165  */
 166 function data_ui_adjust_form_submit_alter_table($form, &$form_state) {
 167   $resolved = $resolved = array();
 168   if (isset($form['#comparison']['reasons'])) {
 169     foreach ($form['#comparison']['reasons'] as $field_reason) {
 170       if (_data_ui_alter_table($form['#table'], $field_reason)) {
 171         $resolved[] = $field_reason;
 172       }
 173       else {
 174         $unresolved[] = $field_reason;
 175       }
 176     }
 177   }
 178   if (count($resolved)) {
 179     drupal_set_message(t('Resolved') . theme_item_list($resolved));
 180   }
 181   if (count($unresolved)) {
 182     drupal_set_message(t('Could not resolve') . theme_item_list($unresolved), 'error');
 183   }
 184 }
 185
 186 /**
 187  * Submit handler for data_ui_adjust_form().
 188  */
 189 function data_ui_adjust_form_submit_create_table($form, &$form_state) {
 190   $table = $form['#table'];
 191   $ret = array();
 192   db_create_table($ret, $table->get('name'), $table->get('table_schema'));
 193   drupal_get_schema($table->get('name'), TRUE);
 194   if ($ret[0]['success']) {
 195     drupal_set_message(t('Created table !table', array('!table' => $table->get('name'))));
 196   }
 197   else {
 198     drupal_set_message(t('Error creating table'), 'error');
 199   }
 200 }
 201
 202 /**
 203  * Form callback for create table form.
 204  */
 205 function data_ui_create_form(&$form_state) {
 206   $form = array();
 207   if (!$form_state['storage']['field_num']) {
 208     $form['name'] = array(
 209       '#type' => 'textfield',
 210       '#title' => t('Table name'),
 211       '#description' => t('Machine readable name of the table - e. g. "my_table". Must only contain lower case letters and _.'),
 212       '#required' => TRUE,
 213     );
 214     $form['title'] = array(
 215       '#type' => 'textfield',
 216       '#title' => t('Table title'),
 217       '#description' => t('Natural name of the table - e. g. "My Table".'),
 218     );
 219     $form['field_num'] = array(
 220       '#type' => 'textfield',
 221       '#title' => t('Number of fields'),
 222       '#description' => t('The number of fields this table should contain.'),
 223       '#default_value' => 1,
 224       '#required' => TRUE,
 225     );
 226     $form['submit'] = array(
 227       '#type' => 'submit',
 228       '#value' => t('Next'),
 229     );
 230   }
 231   else {
 232     $form['help']['#value'] = t('Define the fields of the new table.');
 233     $form['fields'] = array(
 234       '#tree' => TRUE,
 235     );
 236     for ($i = 0; $i < $form_state['storage']['field_num']; $i++) {
 237       $form['fields']['field_'. $i] = _data_ui_field_form(TRUE);
 238     }
 239     $form['submit'] = array(
 240       '#type' => 'submit',
 241       '#value' => t('Create'),
 242     );
 243   }
 244   return $form;
 245 }
 246
 247 /**
 248  * Validate handler for create table form.
 249  */
 250 function data_ui_create_form_validate($form, &$form_state) {
 251   if (data_get_table(data_name($form_state['values']['name']))) {
 252     form_set_error('name', t('Name is already taken.'));
 253   }
 254   if (isset($form_state['values']['field_num'])) {
 255     if (is_numeric($form_state['values']['field_num'])) {
 256       if ($form_state['values']['field_num'] < 1) {
 257         form_set_error('field_num', t('At least one field must be created.'));
 258       }
 259     }
 260     else {
 261       form_set_error('field_num', t('Enter a number greater than 0.'));
 262     }
 263   }
 264   // Check for dupes.
 265   if (isset($form_state['values']['fields'])) {
 266     $names = array();
 267     foreach ($form_state['values']['fields'] as $field) {
 268       if (is_numeric($names[$field['name']])) {
 269         form_set_error('name', t('Names can\'t be numbers.'));
 270       }
 271       if (!isset($names[$field['name']])) {
 272         $names[$field['name']] = $field['name'];
 273       }
 274       else {
 275         form_set_error('name', t('Names must be unique.'));
 276       }
 277     }
 278   }
 279 }
 280
 281 /**
 282  * Submit handler for create table form.
 283  */
 284 function data_ui_create_form_submit($form, &$form_state) {
 285
 286   if (isset($form_state['values']['field_num'])) {
 287     $form_state['storage'] = $form_state['values'];
 288   }
 289   elseif (isset($form_state['values']['fields'])) {
 290
 291     // Create a schema from user input.
 292     $schema = $index = $primary = $meta = array();
 293     foreach ($form_state['values']['fields'] as $field) {
 294       $schema['fields'][$field['name']] = data_build_field_definition($field);
 295       $meta['fields'][$field['name']]['label'] = $field['label'];
 296
 297       // Limit index if field type is text.
 298       if (!empty($field['index'])) {
 299         $index[$field['name']] = data_get_index_definition($field['name'], $field['type']);
 300       }
 301       if (!empty($field['primary'])) {
 302         $primary[] = data_get_pk_definition($field['name'], $field['type']);
 303       }
 304     }
 305     $schema['indexes'] = $index;
 306     $schema['primary key'] = $primary;
 307
 308     // Create table.
 309     if ($table = data_create_table(data_name(trim($form_state['storage']['name'])), $schema, trim($form_state['storage']['title']))) {
 310       $meta = $table->update(array('meta' => $meta));
 311       drupal_set_message(t('Created table !table', array('!table' => $table->get('name'))));
 312     }
 313     else {
 314       drupal_set_message(t('Error creating table'), 'error');
 315     }
 316
 317     // Unset storage to enable redirect.
 318     unset($form_state['storage']);
 319     $form_state['redirect'] = 'admin/content/data';
 320   }
 321 }
 322
 323 /**
 324  * Form callback for revert table form.
 325  */
 326 function data_ui_revert_form(&$form_state, $table) {
 327   $form = array();
 328   $form['#redirect'] = 'admin/content/data';
 329   $form['#table'] = $table;
 330
 331   return confirm_form($form,
 332     t('Revert this table?'),
 333     'admin/content/data',
 334     t('Are you sure you would like to revert table !table? This will reset all information about this table its definition in code. This action cannot be undone.', array('!table' => $table->get('name'))),
 335     t('Revert'), t('Cancel')
 336   );
 337 }
 338
 339 /**
 340  * Submit handler for data_ui_revert_form().
 341  */
 342 function data_ui_revert_form_submit($form, &$form_state) {
 343   $table = $form['#table'];
 344   $table->revert();
 345 }
 346
 347 /**
 348  * Form callback for drop table form.
 349  */
 350 function data_ui_drop_form(&$form_state, $table) {
 351   $form = array();
 352   $form['#redirect'] = 'admin/content/data';
 353   $form['#table'] = $table;
 354
 355   return confirm_form($form,
 356     t('Drop this table?'),
 357     'admin/content/data',
 358     t('Are you sure you would like to drop table !table? This action cannot be undone.', array('!table' => $table->get('name'))),
 359     t('Drop'), t('Cancel')
 360   );
 361 }
 362
 363 /**
 364  * Submit handler for data_ui_drop_form().
 365  */
 366 function data_ui_drop_form_submit($form, &$form_state) {
 367   $table = $form['#table'];
 368   data_drop_table($table->get('name'));
 369 }
 370
 371 /**
 372  * Form callback for editing a table.
 373  */
 374 function data_ui_edit_form(&$form_state, $table) {
 375   drupal_set_title(t('Data table !table', array('!table' => $table->get('name'))));
 376   $schema = $table->get('table_schema');
 377   $meta = $table->get('meta');
 378
 379   $form = array();
 380   // Keep table.
 381   $form['table'] = array(
 382     '#type' => 'value',
 383     '#value' => $table,
 384   );
 385
 386   // Existing fields.
 387   $form['fields'] = array('#tree' => TRUE);
 388   if (isset($schema['fields'])) {
 389     foreach ($schema['fields'] as $field_name => $field) {
 390       $form['fields'][$field_name] = array();
 391       $form['fields'][$field_name]['selected'] = array(
 392         '#type' => 'checkbox',
 393       );
 394       $form['fields'][$field_name]['name'] = array('#value' => $field_name);
 395       $form['fields'][$field_name]['label'] = array(
 396         '#type' => 'textfield',
 397         '#size' => 20,
 398         '#default_value' => $meta['fields'][$field_name]['label'],
 399       );
 400       $form['fields'][$field_name]['type'] = array(
 401         '#type' => 'select',
 402         '#options' => data_get_field_types(),
 403         '#default_value' => $field['type'],
 404       );
 405       $form['fields'][$field_name]['unsigned'] = array(
 406         '#type' => 'checkbox',
 407         '#default_value' => $field['unsigned'],
 408       );
 409       $form['fields'][$field_name]['index'] = array(
 410         '#type' => 'checkbox',
 411         '#default_value' => isset($schema['indexes'][$field_name]),
 412       );
 413       $form['fields'][$field_name]['primary'] = array(
 414         '#type' => 'checkbox',
 415         '#default_value' => isset($schema['primary key']) ? in_array($field_name, $schema['primary key']) : FALSE,
 416       );
 417       if ($join = _data_ui_get_join($meta['join'], $field_name)) {
 418         $join = $join['left_table'] .'.'. $join['left_field'];
 419       }
 420       else {
 421         $join = t('<none>');
 422       }
 423       $join = l($join, 'admin/content/data/edit/'. $table->get('name') .'/join/'.$field_name);
 424       $form['fields'][$field_name]['join']['#value'] = $join;
 425     }
 426   }
 427
 428   // Add a new field.
 429   $form['new'] = _data_ui_field_form();
 430   $form['new']['primary'] = array(
 431     '#type' => 'markup',
 432     '#value' => '&nbsp;',
 433     );
 434   $form['new']['join'] = array(
 435     '#type' => 'markup',
 436     '#value' => '&nbsp;',
 437     );
 438   $form['new']['add'] = array(
 439     '#type' => 'submit',
 440     '#value' => t('Add new'),
 441   );
 442
 443   // Bulk operations.
 444   $options = array(
 445     t('Bulk operations'),
 446     'delete' => t('Delete all selected'),
 447   );
 448   $form['bulk_operation'] = array(
 449     '#type' => 'select',
 450     '#options' => $options,
 451   );
 452   $form['submit'] = array(
 453     '#type' => 'submit',
 454     '#value' => t('Save'),
 455   );
 456
 457   return $form;
 458 }
 459
 460 /**
 461  * Submit form.
 462  */
 463 function data_ui_edit_form_submit($form, &$form_state) {
 464   $table = $form_state['values']['table'];
 465   $schema = $table->get('table_schema');
 466
 467   if ($form_state['clicked_button']['#value'] == t('Save')) {
 468     $fields = $schema['fields'];
 469     $new_fields = $form_state['values']['fields'];
 470
 471     $new_index = array();
 472     $new_primary_key = array();
 473
 474     if (empty($form_state['values']['bulk_operation']) && isset($fields)) {
 475
 476       // Convert schema.
 477       foreach ($fields as $field_name => $field) {
 478         if ($new_spec = _data_ui_changed($new_fields[$field_name], $field)) {
 479           $table->changeField($field_name, $new_spec);
 480           drupal_set_message(t('Changed field !field_name', array('!field_name' => $field_name)));
 481         }
 482         if ($new_fields[$field_name]['index']) {
 483           $new_index[] = $field_name;
 484         }
 485         if ($new_fields[$field_name]['primary']) {
 486           $new_primary_key[] = $field_name;
 487         }
 488       }
 489       $table->changeIndex($new_index);
 490       $table->changePrimaryKey($new_primary_key);
 491
 492       // Update meta data.
 493       $meta = $table->get('meta');
 494       foreach ($new_fields as $field_name => $field) {
 495         $meta['fields'][$field_name]['label'] = $field['label'];
 496       }
 497       $table->update(array('meta' => $meta));
 498     }
 499     else {
 500       // Bulk updates.
 501       switch ($form_state['values']['bulk_operation']) {
 502         case 'delete':
 503           foreach ($new_fields as $field_name => $field) {
 504             if (!empty($field['selected'])) {
 505               // One field must stay.
 506               $schema = $table->get('table_schema');
 507               if (count($schema['fields']) > 1) {
 508                 $table->dropField($field_name);
 509                 drupal_set_message(t('Deleted field !field_name', array('!field_name' => $field_name)));
 510               }
 511               else {
 512                 drupal_set_message('You cannot delete all fields from a table, drop the table instead.', 'error');
 513               }
 514             }
 515           }
 516           break;
 517       }
 518     }
 519   }
 520   elseif ($form_state['clicked_button']['#value'] == t('Add new')) {
 521     $new = $form_state['values']['new'];
 522     $spec = data_build_field_definition($new);
 523     $table->addField($new['name'], $spec);
 524     if (!empty($new['index'])) {
 525       $table->addIndex($new['name']);
 526     }
 527     $meta = $table->get('meta');
 528     $meta['fields'][$new['name']]['label'] = $new['label'];
 529     $table->update(array('meta' => $meta));
 530   }
 531 }
 532
 533 /**
 534  * Join form.
 535  */
 536 function data_ui_join_form(&$form_state, $table, $field_name) {
 537   // drupal_set_title(t('Join field'));
 538
 539   $schema = $table->get('table_schema');
 540   $meta = $table->get('meta');
 541
 542   // Validate input.
 543   if (!isset($field_name) || !isset($schema['fields'][$field_name])) {
 544     drupal_set_message(t('Invalid field.'), 'error');
 545     drupal_goto('admin/content/data/edit/'. $table->get('name'));
 546   }
 547
 548   // List all tables that schema API knows about as optoins.
 549   // @todo: This is a looong list - needs some AHAH to scale better.
 550   $table_schemas = drupal_get_schema();
 551   ksort($table_schemas);
 552   $options = array();
 553   foreach ($table_schemas as $table_name => $schema) {
 554     if ($table->get('name') != $table_name) {
 555       foreach ($schema['fields'] as $name => $info) {
 556         $options[$table_name][$table_name .'.'. $name] = $table_name .'.'. $name;
 557       }
 558     }
 559   }
 560
 561   // Build form.
 562   $form = array();
 563   $form['#table'] = $table;
 564   $form['#field_name'] = $field_name;
 565   $form['#redirect'] = 'admin/content/data/edit/'. $table->get('name');
 566   $join = _data_ui_get_join($meta['join'], $field_name);
 567   $form['#original_join'] = $join;
 568   $form['left'] = array(
 569     '#type' => 'select',
 570     '#title' => t('Join !table_field to', array('!table_field' => $table->get('name') .'.'. $field_name)),
 571     '#options' => $options,
 572     '#default_value' => $join['left_table'] .'.'. $join['left_field'],
 573   );
 574   $form['inner_join'] = array(
 575     '#type' => 'radios',
 576     '#title' => t('Join type'),
 577     '#options' => array(t('Left join'), t('Inner join')),
 578     '#default_value' => $join['inner_join'] ? $join['inner_join'] : 0,
 579   );
 580
 581   // Use confirm form for its formatting.
 582   $form = confirm_form($form,
 583     t('Join field'),
 584     'admin/content/data/edit/'. $table->get('name'),
 585     '',
 586     t('Save'), t('Cancel')
 587   );
 588   $form['actions']['delete'] = array(
 589     '#type' => 'submit',
 590     '#value' => t('Delete'),
 591     '#submit' => array('data_ui_join_form_submit_delete'),
 592   );
 593   krsort($form['actions']);
 594
 595   return $form;
 596 }
 597
 598 /**
 599  * Submit handler for data_ui_join_form().
 600  */
 601 function data_ui_join_form_submit($form, &$form_state) {
 602   list($left_table, $left_field) = explode('.', $form_state['values']['left']);
 603   $form['#table']->link($left_table, $left_field, $form['#field_name'], $form_state['values']['inner_join']);
 604   drupal_set_message(t('Updated join information.'));
 605 }
 606
 607 /**
 608  * Submit handler for data_ui_join_form() - handles deletion.
 609  */
 610 function data_ui_join_form_submit_delete($form, &$form_state) {
 611   // Use the original join information.
 612   $form['#table']->unlink($form['#original_join']['left_table']);
 613   drupal_set_message(t('Removed join information.'));
 614 }
 615
 616 /**
 617  * Export form.
 618  */
 619 function data_ui_export_form(&$form_state, $table) {
 620   $code = data_export($table->get('name'));
 621
 622   $form['export'] = array(
 623     '#title' => t('Export table definition'),
 624     '#type' => 'textarea',
 625     '#value' => $code,
 626     '#rows' => substr_count($code, "\n"),
 627   );
 628   return $form;
 629 }
 630
 631 /**
 632  * Theme data_ui_create_form.
 633  */
 634 function theme_data_ui_create_form($form) {
 635
 636   // Render field definition form elements in a table.
 637   if (isset($form['fields'])) {
 638     $output = drupal_render($form['help']);
 639
 640     $rows = array();
 641     foreach (element_children($form['fields']) as $e) {
 642       $row = array();
 643       foreach (element_children($form['fields'][$e]) as $f) {
 644         $row[] = drupal_render($form['fields'][$e][$f]);
 645       }
 646       $rows[] = $row;
 647     }
 648     $header = array(t('Name *'), t('Label'), t('Type'), t('Unsigned'), t('Index'), t('Primary key'));
 649     $output .= theme('table', $header, $rows);
 650
 651     $output .= drupal_render($form);
 652     return $output;
 653   }
 654   return drupal_render($form);
 655 }
 656
 657 /**
 658  * Theme data_ui_admin_form.
 659  */
 660 function theme_data_ui_edit_form($form) {
 661
 662   // Format existing fields.
 663   $rows = array();
 664   foreach (element_children($form['fields']) as $e) {
 665     $row = array();
 666     foreach (element_children($form['fields'][$e]) as $f) {
 667       $row[] = drupal_render($form['fields'][$e][$f]);
 668     }
 669     $row[] = '&nbsp;';
 670     $rows[] = $row;
 671   }
 672
 673   // New fields form.
 674   $row = array('&nbsp;');
 675   foreach (element_children($form['new']) as $e) {
 676     $row[] = drupal_render($form['new'][$e]);
 677   }
 678   $rows[] = $row;
 679
 680   $header = array(t('Select'), t('Name'), t('Label'), t('Type'), t('Unsigned'), t('Index'), t('Primary key'), t('Joins'));
 681   $output .= theme('table', $header, $rows);
 682   $output .= drupal_render($form);
 683   return $output;
 684 }
 685
 686 /**
 687  * Theme a schema module comparison result. Ie. the result of schema_compare_table().
 688  *
 689  * @todo: move to schema module - write a patch.
 690  */
 691 function theme_data_ui_schema_compare_table($comparison) {
 692   $output = '';
 693   foreach ($comparison as $k => $v) {
 694     if (!empty($v)) {
 695       if (is_string($k)) {
 696         $output .= '<dl>';
 697         $output .= '<dt>'. ucfirst($k) .':</dt>';
 698         $output .= '<dd>';
 699         if (is_string($v)) {
 700           $output .= $v;
 701         }
 702         elseif (is_array($v)) {
 703           $output .= theme('item_list', $v);
 704         }
 705         $output .= '</dd>';
 706         $output .= '</dl>';
 707       }
 708     }
 709   }
 710   return $output;
 711 }
 712
 713 /**
 714  * Magic helper function. Detect changed between keys in $new and $field
 715  * and return a new field spec based on $field IF there are differences.
 716  *
 717  * Otherwise return FALSE.
 718  *
 719  * Currently checked: type, unsigned
 720  */
 721 function _data_ui_changed($new, $field) {
 722   $changed = FALSE;
 723   if ($field['type'] != $new['type']) {
 724     $field['type'] = $new['type'];
 725     $changed = TRUE;
 726   }
 727   if ($field['unsigned'] != $new['unsigned']) {
 728     $field['unsigned'] = $new['unsigned'];
 729     $changed = TRUE;
 730   }
 731   if ($changed) {
 732     return $field;
 733   }
 734   return FALSE;
 735 }
 736
 737 /**
 738  * Helper function that generates a form snippet for defining a field.
 739  */
 740 function _data_ui_field_form($required = FALSE) {
 741   $form = array();
 742   $form['#tree'] = TRUE;
 743   $form['name'] = array(
 744     '#type' => 'textfield',
 745     '#size' => 20,
 746     '#required' => $required,
 747   );
 748   $form['label'] = array(
 749     '#type' => 'textfield',
 750     '#size' => 20,
 751   );
 752   $form['type'] = array(
 753     '#type' => 'select',
 754     '#options' => data_get_field_types(),
 755   );
 756   $form['unsigned'] = array(
 757     '#type' => 'checkbox',
 758   );
 759   $form['index'] = array(
 760     '#type' => 'checkbox',
 761   );
 762   $form['primary'] = array(
 763     '#type' => 'checkbox',
 764   );
 765   return $form;
 766 }
 767
 768 /**
 769  * Helper function to get link information for a specific field.
 770  */
 771 function _data_ui_get_join($join, $field) {
 772   if (is_array($join)) {
 773     foreach ($join as $left_table => $info) {
 774       if ($info['field'] == $field) {
 775         $info['left_table'] = $left_table;
 776         return $info;
 777       }
 778     }
 779   }
 780   return FALSE;
 781 }
 782
 783 /**
 784  * Helper function for adjusting a table's real schema.
 785  * @todo: this should live in schema module and should use better defined $reason keys.
 786  */
 787 function _data_ui_alter_table($table, $field_reason) {
 788   list($field, $reason) = explode(': ', $field_reason);
 789   $schema = $table->get('table_schema');
 790
 791   switch ($reason) {
 792     case 'not in database':
 793       if (isset($schema['fields'][$field])) {
 794         return $table->addField($field, $schema['fields'][$field]);
 795       }
 796       return FALSE;
 797
 798     case 'missing in database':
 799       list($type, $field) = explode(' ', $field);
 800       // @todo: support multiple keys.
 801       if ($type == 'indexes') {
 802         return $table->addIndex($field);
 803       }
 804       elseif ($type == 'unique keys') {
 805         return $table->addUniqueKey($field);
 806       }
 807       elseif ($type == 'primary key') {
 808         return $table->addPrimaryKey($schema['primary keys']);
 809       }
 810       return FALSE;
 811
 812     case 'primary key:<br />declared': // @todo: yikes!
 813       $table->dropPrimaryKey();
 814       return $table->changePrimaryKey($schema['primary keys']);
 815     case 'missing in schema':
 816       if ($field == 'primary key') {
 817         return $table->dropPrimaryKey();
 818       }
 819       return FALSE;
 820
 821     case 'unexpected column in database':
 822       return $this->dropField($field);
 823
 824   }
 825   return FALSE;
 826 }