modules/civinode/civinode_cck.module

<?php
/**
 * New CiviNode Framework for CCK Support.
 * 
 * Much thanks to dopry and other CCK documenters, since this version
 * is being done from scratch the better to use the newest bestest APIs
 * 
 */

function civinode_cck_menu($can_cache) {
  $items = array();
  if (!$can_cache) {
    _civinode_cck_initialize();
  }
  else {
    
    return $items;  
  }
}


function _civinode_cck_initialize() {
  static $initialized, $is_crm_init;
  if ($initialized)
    return $is_crm_init;
  if (!module_exists('civinode'))
    return false;
  if (!$initialized and module_exists('views')) {
    require_once drupal_get_path('module', 'civinode') . '/civinode_views.inc';
  }
  $initialized = TRUE;
  $is_crm_init = civinode_check_init();
  return $is_crm_init;
}

//TODO more types
function _civinode_cck_supported_types() {
  return array('' => t('-- select data type --'),
               'contact' => t('CiviCRM Contact'),
               'group' => t('CiviCRM Group'));
}

/**
 * Implementation of hook_field_info().
 * 
 * @return array ('fieldtype' => array('label' => 'example'))
 *  the only key for the fieldtype  array is label. 
 */
function civinode_cck_field_info() {
  return array(
      //'civicrm_contact_field' => array('label' => t('CiviCRM Contact Field')),
      //'civicrm_contact_fieldgroup' => array('label' => t('CiviCRM Field Group')),
      'civicrm_contact'  => array('label' => t('CiviCRM Contact')),
      'civicrm_group' =>  array('label' => t('CiviCRM Group')),
  ); 
}


/**
 * Implementation of hook_field_settings().
 * @param op 
 *    one of form, filters, validate, save, database columns
 * @param field
 *      the field we are working on
 */
function civinode_cck_field_settings($op, $field) {
  _civinode_cck_initialize();
  $field_type = $field['type'];
  switch ($op) {
    // This will be included on the add field form and
    // will be shared across all instances of this field.
    case 'form':
      $form = array();

      if ($field_type == 'civicrm_contact' or
      $field_type == 'civicrm_group') {
        $default_group = $field['default_group_id'];
        
        $form['default_group_id'] =
          civinode_group_selector(t('Default CiviCRM Group'),
                                  t('Default CiviCRM Group To Draw Contacts From'));
        $form['default_group_id']['#default_value'] =
          $field['default_group_id'];
      }

      if ($field_type == 'civicrm_contact') {
        $form['default_profile_id'] =
          civinode_profile_selector(t('CiviCRM Profile'),
                                    t('CiviCRM Profile For Displaying Contacts'));
        $form['default_profile_id']['#default_value'] =
          $field['default_profile_id'];
      }

      //This will display our supported types.  Contacts
      //have subtypes here (a crm field group, a contact ref, a contact
      //rendered as a profile
      /**
      $form['civicrm_type'] = array(
        '#type' => 'select',
        '#title' => t('Kind of CiviCRM Data'),
        //To add
        '#default_value' => $field['settings']['civicrm_type'],
      );
      **/

      
      return $form;

    // this will be called when the field settings form is being validated, 
    // before the widget settings form is displayed.
    case 'validate':
      //unless we use autocomplete for groups, we will not need this
      break;

    // these are the key values to save from the field settings form. 
    // They will be used in the form's submit handler
    case 'save':
      return array('default_group_id', 'default_profile_id');

    // database columns op return the db structure required to store this field.
    // *cck has it's own little DDL. They're simple string replacements in an SQL query.
    case 'database columns':
     $columns = array(
 /*        'description' => array(
          'type' => 'text', 
          'not null' => TRUE, 
          'default' => "''"
        ),
        'description_format' => array(
          'type' => 'int',
          'not null' => TRUE,
          'default' => 0
        ),
*/        'object_id' => array(
          'type' => 'int', 
          'not null' => TRUE, 
          'default' => 0, 'sortable' => FALSE
        ),
        //This is related to the entity_table field
        //used in various CiviCRM tables (contact, group, etc.)
        'entity_type' => array(
          'type' => 'varchar', 
          'length' => 50, 
          'not null' => TRUE, 
          'default' => "'civicrm_contact'", 
          'sortable' => TRUE
        ),
        //Some data types have object fields, contacts
        //in particular.
        'entity_subfield' => array(
          'type' => 'varchar',
          'length' => 120,
          'default' => "'display_name'"
        ),
      );
      return $columns;
      
    case 'callbacks'://pairs up with cck_address_field::view
      //return array(
      //  'view' => CONTENT_CALLBACK_CUSTOM,
      break;
      
    //Views module support
    case 'tables':
      //$db_info = content_database_info($field);
      $tables = civinode_views_field_item_table($field);
      return $tables;
      
    case 'tables_default':
      $tables = content_views_field_tables($field);
      // whatever additions / modifications needed on the default definitions
      return $tables;
      
    case 'arguments':
      break;
      
    case 'filters':
      break; 
  }
}

/**
 * Implementation of hook_field().
 * @param op
 *      the operation
 *  @param node
 *      the node we're working with.
 *  @param field
 *      the field we're working on with its settings.
 *  @param items
 *     the data for this field
 *   @param teaser
 *     are we a tease?
 *   @param page
 *     is the spotlight on us?
 */
function civinode_cck_field($op, $node, $field, &$items) {
  $fieldname = $field['field_name'];
  switch ($op) {
    //  content.module has already loaded the data from our 'database columns' 
    // for us in itemd. if we need or override the data we have in items 
    // (an nid or fid, or some reference) we do it here.
    //  @return array('fieldname' => array('key' => 'value'))
    case 'load':
       //this is where we interact with CiviCRM for data.
       //error_log('grab data for field ' . $fieldname);
       break;

    // This is where we define a default view these days. If you wish to shortcut 
    // the formatter system you'd do it here. Formatters are a very useful power 
    // output mechanism. I suggest you use it. This hook may be deprecated in the 
    // future.
    case 'view':      
      foreach ($items as $delta => $item) {
        $object_id = $item['object_id'];
        switch ($field['type']) {
          case 'civicrm_contact':
            $profile = civinode_get_default_profile_id(0);
            $output = theme('crm_profile_cid', $profile, $object_id);
            $items[$delta]['view'] = $output;//cck_address_format($field, $item, 'default', $node);
            break;
          case 'civicrm_group':
            $items[$delta]['view'] = "Group ID {$object_id}";
            break;
        }
        
      }
      return theme('field', $node, $field, $items, $teaser, $page);

    // Validate the data we recieved from our widgets.
    case 'validate':
      /**
       if ($field['global_settings']['imagerequired']) { 
         foreach ($items as $delta => $item) {
           if (!isset($item['imageurl'])) {
             // we'll need to construct some way to get this fieldname
             $err_field = $field['field_name'].']['.$delta.']['. $field['widget_settings']['imageurl_fieldname'];
             $err_msg = t('The') .' '. $field['widget_settings']['imageurl_fieldtitle'] .' '. t('is required');
             form_set_error($err_field, $err_msg);
           }
         }
      }
      **/
      break;

    // we're submitting this node. This isn't a preview....  Do whatcha gotta do.
    case 'submit':
      //write to our magic caches to get stuff written back
      break;
   
    // Here you get a chance to save data before content.module puts data in your 
    // 'database columns'. You could create a node and pass an nid back, save a file,
    // query an external service and overwrite node_data['key'] with a foreign key value,
    // write data to your own database table and return its key...
    case 'insert':
      //write a whole CiviCRM object here.
       break;

    // Here again you get to alter the data coming from the widget before it gets to the 
    // content.module on update..
    case 'update':
      //write a whole CiviCRM object here.
      break;

   // You get this before content.module has a chance to delete, so you can stop
   // the process if there are any problems.
   case 'delete':
       break;
  }
  return $output;
}


/**
 * Implementation of hook_widget_info().
 * @return array (
 *                 'widgettype' => array(
 *                    'label' => 'string', 
 *                    'field types' => array('fieldtype', ...)
 *                  )
 *                )
 */
function civinode_cck_widget_info() {
  return array(
    'civicrm_contact_frame' => array(
      'label' => 'CiviCRM Contact Field Group',
      'field types' => array('civicrm_fld_group'),
    ),
    'civinode_cck_contact' =>
      array('label' => t('Contact Autocompletor'),
      'field types' => array('civicrm_contact'),),
    'civinode_cck_contact_select' =>
      array('label' => t('Contact Selector (10 or less contacts)'),
      'field types' => array('civicrm_contact')),
    'civinode_cck_group'=>
      array('label' => t('Group Selector'),
      'field types' => array('civicrm_group'),),
  ); 
}

/**
 * Implementation of hook_widget_settings().
 */
function civinode_cck_widget_settings($op, $widget) {
  switch ($op) {
    // settings form to be displayed during field creation.
    case 'form':
      /**
       * what is this exactly?
       *
      
      $form['crm_cck_datatype'] = array (
        '#type' => 'hidden',
        '#value' => 'imageurl',
      ); 
      $form['imageurl_fieldtitle'] = array (
        '#type' => 'hidden',
        '#value' => 'Image Url',
      );
      **/
      $form = array(); 
      return $form;
   
    // settings form validation.
    case 'validate':
      break;

    // form keys to save for settings form.
    case 'save':
      break; //don't know about next line
      //return array('imageurl_fieldname', 'imageurl_fieldtitle');
  }
}


/**
 * Implementation of hook_widget().
 */
function civinode_cck_widget($op, $node, $field, &$items) {
  $fieldname = $field['field_name'];
//      $output = "$op $fieldname:\n";
//      ob_start();
//      print_r($items);
//      $output .= ob_get_clean();
//      error_log($output);
      switch ($field['type']) {
        case 'civicrm_contact':
          $data_type = 'contact';
          break;
        case 'civicrm_group':
          $data_type = 'group';
          break;
        default:
          $data_type = 'unsupported';
          break;
      }

  switch ($op) {
    case 'submit':
      break;
    case 'load':
      break;
    case 'form':
      $form = array();
     
      // Create our form and set #tree == true so the $item structure will be maintained
      // for later usage in the process form values op.
      if ($field['multiple']) {
        $form[$fieldname] = array(
        '#type' => 'fieldset',
        //'#title' => t($field['widget']['label']),
        '#weight' => $field['widget']['weight'],
        '#collapsible' => TRUE,
        '#collapsed' => FALSE,
        '#description' => $field['widget']['description'],
        '#tree' => TRUE,
        );
      }
      else {
        $form[$fieldname] = array('#tree' => TRUE);
      }

      // Iterate through field values. 
      foreach($items as $delta => $item) {
        //$entity_type = $item['entity_type'];
        $form[$fieldname][$delta] = _civinode_cck_widget_manual_item_form($data_type, $field, $delta, $item, $delta);
      }   
      if ($field['multiple']) {
        //we want to start from 0, so that
        //we know when to add a label
        if (!isset($delta))
          $delta = -1; 
        $form[$fieldname][$delta+1] =  _civinode_cck_widget_manual_item_form($data_type, $field, $delta+1);
        $form[$fieldname][$delta+2] =  _civinode_cck_widget_manual_item_form($data_type, $field, $delta+2);
      }   
      elseif (count($items) == 0) {
        $form[$fieldname][0] = _civinode_cck_widget_manual_item_form($data_type, $field, 0, $item);
      }   
      return $form;

    case 'prepare form values':
      return;

    case 'validate':
      return;

    case 'submit':
      return;

    case 'process form values':
      $fieldname = $field['field_name'];
      foreach ($items as $delta => $item) {
//        $errstr = "widget:pfv($delta) \n";
//        ob_start();
//        print_r($item);
//        $errstr .= ob_get_clean();
//        error_log($errstr);
        //unpack dojo data
        if (!is_array($item)) {
          $items[$delta] = array();
          $items[$delta]['entity_type'] = $field['type'];
          $items[$delta]['object_id'] = $item;
        }
        else if (is_array($item) and isset($item['cbox']) and $item['cbox']['key']) {
          $object_id = $item['cbox']['key'];
          $items[$delta]['object_id'] = $object_id;
          $items[$delta]['entity_type'] = 'contact';
          unset($items[$delta]['cbox']);
        }
        else { //if ($delta > 0) {
          //chuck out empty items
          unset($items[$delta]);
        }        
      }
      break;

      return;
  }
}


/**
 * Implementation of hook_field_formatter_info().
 */
function civinode_cck_field_formatter_info() {
  $formatters = array(
    'default' => array(
      'label' => t('Default'),
      'field types' => array('civicrm_contact', 'civicrm_group'),
    ),
    'link' => array(
      'label' => t('Link'),
      'field types' => array('civicrm_contact'),
    ),
    'profiled' => array(
      'label' => t('Contact Profile'),
      'field types' => array('civicrm_contact'),
    ),
  );
  return $formatters;
}

/**
 * Implementation of hook_field_formatter().
 */
function civinode_cck_field_formatter($field, $item, $formatter) {
  // switch formatter in case we implement multiple formatters.
  switch ($formatter) {
    case 'profiled':
      return theme('civinode_cck_profiled_contact', $item, $field);
      break;
      
    case 'link':
      if ($field['type'] == 'civicrm_contact')
        return theme('civinode_cck_formatter_contact', $item, 'display_name', 'link');
      else if ($field['type'] == 'civicrm_group')
        return theme('civinode_cck_formatter_group', $item, NULL, 'link');
      else 
        return theme('civinode_cck_formatter_default', $item);
      
    
    default:
    case 'default':
      if ($field['type'] == 'civicrm_contact')
        return theme('civinode_cck_formatter_contact', $item);
      else if ($field['type'] == 'civicrm_group')
        return theme('civinode_cck_formatter_group', $item);
      else 
        return theme('civinode_cck_formatter_default', $item);
      break;
  }
}

/**
 * callback functions for the theme
 */

function theme_civinode_cck_formatter_contact($item, $crm_field = 'display_name', $fmt = 'plain') {
  $output = '';
  $object_id = $item['object_id'];
  if (!$object_id)
    return '';
  $contact = array();
  _civinode_cck_cache_mgr('fetch', NULL, $object_id, $contact);
  if (civinode_check_error($contact))
    return "oops $object_id";
  $desc = $contact[$crm_field];
  switch ($fmt) {     
    case 'link':
      $desc = l($desc, "civicrm/contact/view", array(), 
                "reset=1&cid=$object_id", NULL, FALSE, TRUE);
      break;
   case 'plain':
   default:
     $desc = check_plain($desc);
     break;   
  }
  $output .= $desc;
  return $output;
}


function theme_civinode_cck_profiled_contact($item, $field) {
  $output = '';
  $object_id = $item['object_id'];
  if (!$object_id) {
    return ""; //may want to make this themeable
  }
  //TODO get correct profile from widget info
  if ($field['default_profile_id'])
    $default_profile = $field['default_profile_id'];
  else
    $default_profile = civinode_get_default_profile_id(0);
    
  $contact = civinode_util_load_cdata($object_id, $default_profile);
  if (civinode_check_error($contact))
    return "";  //again, this may need theming
  
  $output .= theme('crm_contact', $contact, $field);
  return $output;
}

function theme_crm_contact($contact_array, $field) {
  //For now, we do a table
  $contact_id = $contact_array['contact_id'];
  $rows = array();
  $header = array();
  $pid = $field['default_profile_id'] ? 
    $field['default_profile_id'] : 
      civinode_get_default_profile_id(0);
  $classes = "crm-profile  crm-profile-$pid";
  //Get the fields and render them
  $field_list = civinode_get_profile_field_list($pid, 'view');
  $output = "<div class='$classes'>\n";
  foreach ($field_list as $node_field => $field) {
    $field_desc = civinode_get_field_info($pid, $field, 'view');
    if (!isset($contact_array[$node_field]) or empty($contact_array[$node_field]))
      continue;
    $f_title = $field_desc['title'];
    if (!$f_title)
      $f_title = $node_field;
    $rows[] = 
      array(
        array('data' => $f_title, 'header' => 1, 
              'class' => 'civinode-profile-header'),
        array('data' => $contact_array[$node_field])
        );
  }
  $output .= theme('table', $header, $rows);
  $output .= "</div>";

  return $output;
}

function theme_civinode_cck_formatter_group($item) {
  $output = '';
  $object_id = $item['object_id'];
  $group_obj = civinode_get_group_by_id($object_id);
  if (!$group_obj) {
    //do something lame that will help us debug
    return theme('civinode_cck_formatter_default', $item);
  }
  $desc = t('%name (gid=%id)', 
            array('%name' => $group_obj->title,
                  '%id' => $group_obj->id)
           );
  $output .= $desc;
  return $output;
}

function theme_civinode_cck_formatter_default($item) {
  $output = '';
  /**
  if (isset($item['imageurl'])) {
    $output .= l('<img src="'. check_plain($item['imageurl']) .'" />', $item['target_url'], array(), 
                        NULL, NULL, FALSE, TRUE);
  } else {
    $output .= check_markup($item['description'], $item['description_format']);
  }
  $output .= l(t('Link'), $item['target_url']);
  **/
  $output .= "{$item['entity_type']} ID = {$item['object_id']}";
  return $output;
}

function _civinode_cck_cache_mgr($op, $field, &$contact_id, &$data) {
  //our "singleton simulcrum"
  static $cache;
  if (!isset($cache)) {
    $cache = array();
  }
  if ($op == 'fetch') {
    if (!isset($cache[$field][$contact_id])) {
      $data = civinode_util_load_cdata($contact_id);
      $cache[$field][$contact_id] = $data;
    }
    else
      $data = $cache[$field][$contact_id];
  }
  
  return NULL;
}

function _civicrm_cck_display_modes() {
  return 
    array('' => t('-- select display mode --'),
          'link' => t('Link To CiviCRM'),
          'profile' => t('Use CiviCRM Profile'),
    );
}

/**
 * Helper function to generate forms for each $item.
 * This code assumes that the $form will in the larger form api structure
 * as $hl_form['field_id'][$delta] = $form;  at the level of ['field_id'] we
 * either have the desc and title (as a field set) or just the #tree item.
 */
function _civinode_cck_widget_manual_item_form($type, $field, $delta = 0, $item = array()) {
  $form = array(); //ultimate return value
  $form_chunk = array(); //ll fields
  $raw_fieldname =  $field['field_name'];
  $fieldname = $raw_fieldname . "_$delta";
  $is_multiple = $field['multiple'];
  $widget_type = $field['widget']['type'];
  $group_id = $field['default_group_id'];
  if (!$group_id)
    $group_id = 0;
  $object_id = $item['object_id'];
  if (!$is_multiple) {
    //We need to add the label?  May be better to add higher up
    $label = $field['widget']['label'];
    $label = $label ? $label : $fieldname;
    $desc = $field['widget']['description'];
    $form['#title'] = $label;
    if ($desc) {
      $form['#description'] = $desc;
    }
  }
  else {
    //we only want a label on the first item
    if ($delta == 0)
      $label = $field['widget']['label'];
    else
      $label = NULL;
    $desc = NULL;
  }

  if ($type == 'contact') {
    //have a contact?
    if ($object_id) {
      $contact = array();
      _civinode_cck_cache_mgr('fetch', NULL, $object_id, $contact);
      $object_id = $contact['contact_id'];      
    }
    if ($widget_type == 'civinode_cck_contact_select') {
      $options = civinode_group_contact_popup(TRUE, $group_id);
      $form_chunk =
        array('#type' => 'select',
              '#options' => $options,
              '#default_value' => $object_id ? $object_id : 0,
              '#weight' => $field['widget']['weight'],
        );
    }
    else if ($widget_type == 'civinode_cck_contact') {
      $sortname = '';
      $key = NULL;
      if ($object_id) {
        $key = $object_id;
        $sortname = $contact['sort_name'];
      }
      $form_chunk = 
        civinode_contact_autoselect_widget($fieldname, $label, 
                                           $key, $sortname,
                                           $group_id,
                                           $desc);
    }
  
  }
      
  else if ($type == 'group') {
    if ($item['object_id'])
      $group_id = $item['object_id'];
    $form_chunk = 
      civinode_group_selector($label, $field['widget']['description'],
                              $group_id);
     
  }

  $form = array_merge($form, $form_chunk);
  return $form;
}

function _civinode_cck_widget_manual_item_form_old($type, $field, $delta = 0, $item = array()) {

  $fieldname = $field['widget']['field_name'];
  if ($delta)
    $fieldname .= "_$delta";
  $widget_type = $field['widget']['type'];
  $label = $field['widget']['label'];
  $label = $label ? $label : $fieldname;
  $group_id = $field['default_group_id'];
  if (!$group_id)
    $group_id = 0;
 
  if ($type == 'contact') {
    $object_id = $item['object_id'];
    if (is_array($object_id)) {
      $object_id = $object_id['cbox']['key'];
    }
    if ($object_id) {
      $contact = array();
      _civinode_cck_cache_mgr('fetch', NULL, $object_id, $contact);

      if ($contact['sort_name']) {
        $value = $contact['sort_name'];
      }
      else {
        //object id is not available, so do not use it
        error_log("civinode_cck error -- Contact $object_id not found");
        $object_id = NULL;
      }
    }
    if ($widget_type == 'civinode_cck_contact_select') {
      $options = civinode_group_contact_popup(TRUE, $group_id);
      $form['object_id'] =
        array('#type' => 'select',
              '#title' => $label,
              '#options' => $options,
              '#default_value' => $object_id ? $object_id : 0,
              '#description' => $field['widget']['description'],
              '#weight' => $field['widget']['weight'],
        
        );
    }
    else if ($widget_type == 'civinode_cck_contact') {
      $form['object_id'] = 
        civinode_contact_autoselect_widget($fieldname, $label, 
                                           $object_id, $value,
                                           $group_id,
                                           $field['widget']['description']);
    }
  }
  elseif ($type == 'group') {
    if ($item['object_id'])
      $group_id = $item['object_id'];
    $form['object_id'] = 
      civinode_group_selector($label, $field['widget']['description'],
                              $group_id);
  }
    //TODO other data types by object_id
    $form['entity_type'] =
    array('#type' => 'hidden',
          '#value' => $type, //$item['entity_type'],
    );
  return $form;
}