modules/oi/oi.module

<?php

// $Id: oi.module,v 1.2 2009/06/24 18:27:59 pukku Exp $

/**
 * @file
 *
 * OI provides a hierarchical access control system, among other things.
 */

/**
 * Constants for membership types
 */
define('OI_REMOVE', -1);
define('OI_NONE', 0);
define('OI_MEMBER', 1);
define('OI_ACCESS_ONLY', 2);

/**
 * Implementation of hook_perm().
 */
function oi_perm () {
  $ret = array(
    'manage oi entities', 
    'manage oi entity membership',
    'control access using oi',
    'restrict access to any oi entity',
  );
  
  if (module_exists('site_user_list')) {
    $ret[] = 'search site user list using any oi entity';
    $ret[] = 'search site user list using own oi entities';
  }
  
  return $ret;
}

/**
 * Implementation of hook_menu().
 */
function oi_menu () {
  $items = array();
  
  $items['admin/settings/oi'] = array(
    'title' => 'Organizational Infrastructure',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('oi_admin_settings_form'),
    'access arguments' => array('administer site configuration'),
    'type' => MENU_NORMAL_ITEM,
  );
  $items['admin/settings/oi/entity_type_edit'] = array(
    'title' => 'Edit entity type',
    'page callback' => 'oi_settings_entity_type_form_dispatch',
    'access arguments' => array('access administration pages'),
    'type' => MENU_CALLBACK,
  );
  $items['admin/settings/oi/entity_type_delete'] = array(
    'title' => 'Delete entity type',
    'page callback' => 'oi_settings_entity_type_delete',
    'access arguments' => array('access administration pages'),
    'type' => MENU_CALLBACK,
  );

  $items['admin/settings/oi/entity_type_role_edit'] = array(
    'title' => 'Edit entity type role',
    'page callback' => 'oi_settings_entity_type_role_dispatch',
    'access arguments' => array('access administration pages'),
    'type' => MENU_CALLBACK,
  );
  $items['admin/settings/oi/entity_type_role_delete'] = array(
    'title' => 'Delete entity type role',
    'page callback' => 'oi_settings_entity_type_role_delete',
    'access arguments' => array('access administration pages'),
    'type' => MENU_CALLBACK,
  );
  
  $items['admin/settings/oi/entity_type_field_edit'] = array(
    'title' => 'Edit entity type field',
    'page callback' => 'oi_settings_entity_type_field_dispatch',
    'access arguments' => array('access administration pages'),
    'type' => MENU_CALLBACK,
  );
  $items['admin/settings/oi/entity_type_field_delete'] = array(
    'title' => 'Delete entity type field',
    'page callback' => 'oi_settings_entity_type_field_delete',
    'access arguments' => array('access administration pages'),
    'type' => MENU_CALLBACK,
  );
  
  
  $items['admin/user/oi'] = array(
    'title' => 'OI Entities',
    'page callback' => 'oi_entities_list',
    'access arguments' => array('manage oi entities'),
    'type' => MENU_NORMAL_ITEM,
  );
  $items['admin/user/oi/entity_add_edit'] = array(
    'title' => 'Add or Edit OI Entity',
    'page callback' => 'oi_entities_form_dispatch',
    'access arguments' => array('manage oi entities'),
    'type' => MENU_CALLBACK,
  );
  $items['admin/user/oi/entity_delete'] = array(
    'title' => 'Delete OI Entity',
    'page callback' => 'oi_entities_delete_dispatch',
    'access arguments' => array('manage oi entities'),
    'type' => MENU_CALLBACK,
  );
  $items['admin/user/oi/entity_data_edit'] = array(
    'title' => 'Edit Entity Data',
    'page callback' => 'oi_entities_data_edit',
    'access arguments' => array('manage oi entities'),
    'type' => MENU_CALLBACK,
  );
  $items['admin/user/oi/entity_role_edit'] = array(
    'title' => 'Edit Entity Role',
    'page callback' => 'oi_entities_role_form_dispatch',
    'access arguments' => array('manage oi entities'),
    'type' => MENU_CALLBACK,
  );
  $items['admin/user/oi/entity_field_edit'] = array(
    'title' => 'Edit Entity Field',
    'page callback' => 'oi_entities_field_form_dispatch',
    'access arguments' => array('manage oi entities'),
    'type' => MENU_CALLBACK,
  );

  return $items;
}

/**
 * Implementation of hook_init().
 */
function oi_init () {
  drupal_add_css(drupal_get_path('module', 'oi') . '/oi.css');
}

/**
 * @defgroup helper-functions
 * @{
 */

/**
 * Equivalent to Perl DBIs $db->selectcol_array().
 */
function oi_db_get_column ($query) {
    $ret = array();
    while($a = db_fetch_array($query)) {
        $ret[] = array_shift($a);
    }
    return $ret;
}

function _oi_get_dashes ($count, $dashes = '--') {
    $dash = str_repeat($dashes, $count);
    return $dash;
}

/**
 * @}
 */
 
/**
 * Implementation of hook_theme().
 */
function oi_theme () {
  return array(
    'oi_settings_display_entity_type' => array(
      'arguments' => array(
        'etname' => NULL,
        'roles' => array(),
        'fields' => array(),
      ),
    ),
    'oi_user_edit' => array(
      'arguments' => array(
        'form' => NULL,
      ),
    ),
    'oi_restriction_note' => array(
      'arguments' => array(
        'eidisplays' => NULL,
      ),
    ),
    'oi_roles_text' => array(
      'arguments' => array(
        'roles_text' => NULL,
      ),
    ),
  );
}


/**
 * @defgroup settings-form
 * @{
 */

/**
 * Implementation of hook_settings().
 */
function oi_admin_settings_form () {
  $entity_types = _oi_get_entity_types();
  
  $header = array(t('Type'), t('Operations'));

  $rows = array();
  _oi_entity_types_list_recurse_rows($entity_types['tree'], $entity_types['types'], $rows);
  
  if (count($rows) == 0) {
    $rows[] = array(array('colspan' => 2, 'data' => t('No entity types defined.')));
  }
  
  $form = array();
  
  $node_access_status = variable_get('oi_node_access_enabled', false);
  $form['toggle_oi_restrictions'] = array(
    '#type' => 'fieldset',
    '#title' => t('Toggle Access Restrictions'),
  );
  $form['toggle_oi_restrictions']['toggle_oi_restrictions_button'] = array(
    '#type' => 'submit',
    '#suffix' => '<p>' . t('OI node access permissions are currently ' . ($node_access_status ? 'on' : 'off') . '.  You may change this by clicking on this button.  Turning permissions off does not delete the information about permissions already assigned, it just prevents it from having any effect.') . '</p>',
    '#value' => $node_access_status ? t('Turn Access Restrictions Off') : t('Turn Access Restrictions On'),
    '#oi_toggle_curr_value' => $node_access_status,
  );

  $form['entity_types'] = array(
    '#type' => 'fieldset',
    '#title' => t('Entity Types'),
  );
  $form['entity_types'][] = array(
    '#type' => 'markup',
    '#value' => theme('table', $header, $rows)
          . '<p>' . l(t('Add new entity type'), 'admin/settings/oi/entity_type_edit') . '</p>',
  );
  
  $form['oi_name_display'] = array(
    '#type' => 'fieldset',
    '#title' => t('Display settings'),
  );
  $form['oi_name_display']['oi_name_display_string'] = array(
    '#type' => 'textfield',
    '#title' => t('Name display settings'),
    '#description' => t('Determine how OI will display user names.  Use @field_name to indicate a field from profile.module.  You may also use @uid, @name, @mail to get non-profile.module items'),
    '#default_value' => variable_get('oi_name_display_string', '@name'),
  );
  $form['oi_name_display'][] = array(
    '#type' => 'submit',
    '#value' => t('Save display settings'),
  );

  return $form;
}

function oi_admin_settings_form_submit ($form, &$form_state) {
  if (array_key_exists('#oi_toggle_curr_value', $form_state['clicked_button'])) {
    oi_toggle_node_access();
    $message = '';
    if ($form_states['clicked_button']['#oi_toggle_curr_value']) {
      $message = 'Access restrictions via OI disabled';
    }
    else {
      $message = 'Access restrictions via OI enabled';
    }
    drupal_set_message($message);
  }
  else {
    $display_string = $form_state['values']['oi_name_display_string'];
    variable_set('oi_name_display_string', $display_string);
    
    // precompute the select-from sql for speed...
    preg_match_all('/@([A-Za-z_]+)/', $display_string, $matches);
    $cols = array();
    $joins = array();
    
    $cols['uid'] = 'u.uid as "@uid"';
    $cols['name'] = 'u.name as "@name"';
    $cols['mail'] = 'u.mail as "@mail"';
    
    foreach ($matches[1] as $field_name) {
      if (!isset($cols[$field_name])) {
        $fid = db_result(db_query("SELECT fid FROM {profile_fields} WHERE name = '%s'", $field_name));
        $tbl = 't_' . $fid;
        
        $cols[$field_name] = "$tbl.value as \"@$field_name\"";
        $joins[] = "LEFT OUTER JOIN {profile_values} as $tbl on (u.uid = $tbl.uid and $tbl.fid = $fid)";
      }
    }
    
    $sql = 'SELECT ' . implode(', ', $cols) . ' '
       . 'FROM {users} as u ' . implode(' ', $joins);
    
    variable_set('oi_name_display_sql', $sql);
     
    drupal_set_message('Changes saved.');
  }
}

function _oi_entity_types_list_recurse_rows ($tree, $info, &$rows, $depth = 0) {
  foreach ($tree as $etid => $children) {
    $roles = array();
    $rq = db_query("SELECT * FROM {oi_entity_type_roles} WHERE etid = %d ORDER BY rtweight", $etid);
    while($r = db_fetch_array($rq)) {
      $roles[] = $r['rtdisplay'];
    }
    $fields = array();
    $fq = db_query("SELECT * FROM {oi_entity_type_fields} WHERE etid = %d ORDER BY ftweight", $etid);
    while($f = db_fetch_array($fq)) {
      $fields[] = $f['ftdisplay'];
    }
  
    $rows[] = array(
      theme('oi_settings_display_entity_type', $info[$etid]['etname'], $roles, $fields),
      l(t('edit'), "admin/settings/oi/entity_type_edit/$etid") . ' | ' . l(t('delete'), "admin/settings/oi/entity_type_delete/$etid"),
    );
    _oi_entity_types_list_recurse_rows($children, $info, $rows, $depth + 1);
  }
}

function theme_oi_settings_display_entity_type ($etname, $roles = array(), $fields = array()) {
  $roles_text = implode(', ', $roles);
  if ($roles_text == '') {
    $roles_text = 'Roles: <em>(no roles)</em>';
  }
  else {
    $roles_text = 'Roles: ' . $roles_text;
  }
  
  $fields_text = implode(', ', $fields);
  if ($fields_text == '') {
    $fields_text = 'Fields: <em>(no fields)</em>';
  }
  else {
    $fields_text = 'Fields: ' . $fields_text;
  }
  
  return '<div class="oi_settings_display_entity_type_name">' . $etname . '</div>'
       . '<div class="oi_settings_display_entity_type_roles">' . $roles_text . '</div>'
       . '<div class="oi_settings_display_entity_type_fields">' . $fields_text . '</div>';
}

/**
 * @}
 */


function oi_settings_entity_type_form_dispatch ($etid = 0) {
  return drupal_get_form('oi_settings_entity_type_form', $etid);
}

function oi_settings_entity_type_form (&$form_state, $etid = 0) {
  $defaults = array(
    'etid' => $etid,
    'etname' => '',
    'parent_etid' => 0,
  );
  
  if ($etid != 0) {
    $defaults = db_fetch_array(db_query("SELECT * FROM {oi_entity_types} WHERE etid = %d", $etid));
  }

  $form = array();
  
  $form['etid'] = array(
    '#type' => 'value',
    '#value' => $etid,
  );

  $form['etname'] = array(
    '#type' => 'textfield',
    '#title' => t('Entity type name'),
    '#description' => t('The name of this entity type'),
    '#default_value' => $defaults['etname'],
    '#size' => 60,
    '#maxlength' => 100,
    '#required' => true,
  );
  
  $form[] = array(
    '#type' => 'submit',
    '#value' => t('Save entity type'),
  );
  
  $form[] = array(
    '#type' => 'markup',
    '#value' => _oi_settings_entity_type_role_list($defaults['etid']),
  );
  
  $form[] = array(
    '#type' => 'markup',
    '#value' => _oi_settings_entity_type_field_list($defaults['etid']),
  );
  
  return $form;
}

function oi_settings_entity_type_form_submit ($form, &$form_state) {
  if ($form_state['values']['etid'] == 0) {
    // a new entity type
    db_query("INSERT INTO {oi_entity_types} (etname) VALUES ('%s')", $form_state['values']['etname']);
    drupal_set_message(t('The entity type %etname was added', array('%etname' => $form_state['values']['etname'])));
  }
  else {
    // updating
    db_query("UPDATE {oi_entity_types} SET etname = '%s' WHERE etid = %d", $form_state['values']['etname'], $form_state['values']['etid']);
    drupal_set_message(t('The entity type %etname was updated', array('%etname' => $form_state['values']['etname'])));
  }
  
  $form_state['redirect'] = '/admin/settings/oi';
}


function oi_settings_entity_type_delete ($etid = 0) {
  if ($etid == 0) {
    drupal_set_message('You cannot delete a non-existant entity!');
    drupal_goto('admin/settings/oi');
  }
  else {
    return drupal_get_form('oi_settings_entity_type_delete_form', $etid);
  }
}

function oi_settings_entity_type_delete_form (&$form_state, $etid) {
  $etname = db_result(db_query("SELECT etname FROM {oi_entity_types} WHERE etid = %d", $etid));

  //** TODO: put in a check here to make sure that this entity type is not in use!
  $used = false;
  if ($used) {
    drupal_set_message(t('You cannot delete the entity type %etname because it is in use.', array('%etname' => $etname)));
    drupal_goto('admin/settings/oi');
    return;
  }

  $form = array();
  $form['etid'] = array(
    '#type' => 'value',
    '#value' => $etid,
  );
  $form['etname'] = array(
    '#type' => 'value',
    '#value' => $etname,
  );
  
  return confirm_form($form,
            t('Are you sure you want to delete the entity type %etname', array('%etname' => $etname)),
            'admin/settings/oi',
            '',
            t('Delete'),
            t('Cancel'));
}

function oi_settings_entity_type_delete_form_submit ($form, &$form_state) {
  db_query("DELETE FROM {oi_entity_types} WHERE etid = %d", $form_state['values']['etid']);
  db_query("DELETE FROM {oi_entity_type_roles} WHERE etid = %d", $form_state['values']['etid']);
  
  drupal_set_message(t('The entity type %etname and all role definitions for that type were deleted.', array('%etname' => $form_state['values']['etname'])));
  
  $form_state['redirect'] = 'admin/settings/oi';
}

/**
 * @defgroup roles
 * @{
 */

function _oi_settings_entity_type_role_list ($etid) {
  if (!isset($etid) or ($etid == '') or ($etid == 0)) {
    return '';
  }
  
  $q = db_query("SELECT * FROM {oi_entity_type_roles} WHERE etid = %d ORDER BY rtweight", $etid);
 
  $header = array(t('Role'), '', t('Operations'));
  $rows = array();
  
  while($r = db_fetch_array($q)) {
    $rtid = $r['rtid'];
    $rows[] = array($r['rtdisplay'],
            $r['rtname'],
            l(t('edit'), "admin/settings/oi/entity_type_role_edit/$etid/$rtid") . ' | ' . l(t('delete'), "admin/settings/oi/entity_type_role_delete/$etid/$rtid")
    );
  }
  
  if (!count($rows)) {
    $rows[] = array(array('colspan' => 3, 'data' => '<em>No roles for this entity type</em>'));
  }
  
  $output = theme('table', $header, $rows)
      . '<p>' . l(t('Add new role'), "admin/settings/oi/entity_type_role_edit/$etid") . '</p>';
  
  return $output;
}


function oi_settings_entity_type_role_dispatch ($etid = 0, $rtid = 0) {
  $entity_type = db_fetch_array(db_query("SELECT * FROM {oi_entity_types} WHERE etid = %d", $etid));
  if (!isset($entity_type) or !is_array($entity_type)) {
    drupal_set_message("You must add roles to existing entity types.");
    drupal_goto('admin/settings/oi');
    return;
  }
  else {
    return drupal_get_form('oi_settings_entity_type_role_form', $entity_type, $rtid);
  }
}

function oi_settings_entity_type_role_form (&$form_state, $et, $rtid = 0) {
  
  $defaults = array(
    'etid' => $et['etid'],
    'rtid' => $rtid,
    'rtname' => '',
    'rtdisplay' => '',
    'rtweight' => 0,
  );

  if ($rtid != 0) {
    $defaults = db_fetch_array(db_query("SELECT * FROM {oi_entity_type_roles} WHERE rtid = %d", $rtid));
  }

  $form = array();
  
  $role_name = 'adding a new role';
  if ($defaults['rtname'] != '') {
    $role_name = 'editing role ' . theme('placeholder', $defaults['rtname']);
  }
  $form[] = array(
    '#type' => 'markup',
    '#value' => $role_name . ' to entity type ' . theme('placeholder', $entity_type['etname']),
  );
  
  $form['etid'] = array(
    '#type' => 'value',
    '#value' => $defaults['etid'],
  );
  
  $form['rtid'] = array(
    '#type' => 'value',
    '#value' => $defaults['rtid'],
  );
  
  $form['rtname'] = array(
    '#type' => 'textfield',
    '#title' => t('Role short name'),
    '#description' => t('A short (internal) name for the role.  No spaces or capitol letters, please.'),
    '#default_value' => $defaults['rtname'],
    '#required' => true,
  );
  
  $form['rtdisplay'] = array(
    '#type' => 'textfield',
    '#title' => t('Role display name'),
    '#description' => t('A display name for the role.'),
    '#default_value' => $defaults['rtdisplay'],
    '#required' => true,
  );
  
  $form['rtweight'] = array(
    '#type' => 'weight',
    '#title' => 'Role Weight',
    '#default_value' => $defaults['rtweight'],
  );
    
  
  $form[] = array(
    '#type' => 'submit',
    '#value' => t('Save entity type role'),
  );

  return $form;
}

function oi_settings_entity_type_role_form_submit ($form, &$form_state) {
  if ($form_state['values']['rtid'] == 0) {
    // new role
    db_query("INSERT INTO {oi_entity_type_roles} (etid, rtname, rtdisplay, rtweight) VALUES (%d, '%s', '%s', %d)", $form_state['values']['etid'], $form_state['values']['rtname'], $form_state['values']['rtdisplay'], $form_state['values']['rtweight']);
    drupal_set_message(t('The entity type role was added'));
  }
  else {
    // updating
    db_query("UPDATE {oi_entity_type_roles} SET rtname = '%s', rtdisplay = '%s', rtweight = %d WHERE rtid = %d", $form_state['values']['rtname'], $form_state['values']['rtdisplay'], $form_state['values']['rtweight'], $form_state['values']['rtid']);
    drupal_set_message(t('The entity type role was updated'));
  }
  
  $form_state['redirect'] = "admin/settings/oi/entity_type_edit/" . $form_state['values']['etid'];
}


function oi_settings_entity_type_role_delete ($etid, $rtid) {
  return drupal_get_form('oi_settings_entity_type_role_delete_form', $etid, $rtid);
}

function oi_settings_entity_type_role_delete_form (&$form_state, $etid, $rtid) {
  $etname = db_result(db_query("SELECT etname FROM {oi_entity_types} WHERE etid = %d", $etid));
  $rtname = db_result(db_query("SELECT rtname FROM {oi_entity_type_roles} WHERE rtid = %d", $rtid));
  
  //** TODO: put a check in here to see if the role is being used
  $used = false;
  if ($used) {
    drupal_set_message(t('You cannot delete the role %rtname because it is in use', array('%rtname' => $rtname)));
    drupal_goto("admin/settings/oi/entity_type_edit/$etid");
    return;
  }
  
  $form = array();
  $form['rtid'] = array(
    '#type' => 'value',
    '#value' => $rtid,
  );
  $form['rtname'] = array(
    '#type' => 'value',
    '#value' => $rtname,
  );
  $form['etid'] = array(
    '#type' => 'value',
    '#value' => $etid,
  );
  $form['etname'] = array(
    '#type' => 'value',
    '#value' => $etname,
  );
  
  return confirm_form($form,
            t('Are you sure you want to delete the role %role from entity type %type', array('%role' => $rtname, '%type' => $etname)),
            "admin/settings/oi/entity_type_edit/$etid",
            '',
            t('Delete'),
            t('Cancel'));
}

function oi_settings_entity_type_role_delete_form_submit ($form, &$form_state) {
  db_query("DELETE FROM {oi_entity_type_roles} WHERE rtid = %d", $form_state['values']['rtid']);
  
  drupal_set_message(t('The entity type role %role for type %type has been deleted.', array('%role' => $form_state['values']['rtname'], '%type' => $form_state['values']['etname'])));
  $form_state['redirect'] = "admin/settings/oi/entity_type_edit/" . $form_state['values']['etid'];
}

/**
 * @}
 */


/**
 * @defgroup fields
 * @{
 */

function _oi_settings_entity_type_field_list ($etid) {
  if (!isset($etid) or ($etid == '') or ($etid == 0)) {
    return '';
  }
  
  $q = db_query("SELECT * FROM {oi_entity_type_fields} WHERE etid = %d ORDER BY ftweight", $etid);
 
  $header = array(t('Field'), '', '', t('Operations'));
  $rows = array();
  
  while($r = db_fetch_array($q)) {
    $ftid = $r['ftid'];
    $rows[] = array($r['ftdisplay'],
            $r['ftname'],
            $r['fttype'],
            l(t('edit'), "admin/settings/oi/entity_type_field_edit/$etid/$ftid") . ' | ' . l(t('delete'), "admin/settings/oi/entity_type_field_delete/$etid/$ftid")
    );
  }
  
  if (!count($rows)) {
    $rows[] = array(array('colspan' => 4, 'data' => '<em>No fields for this entity type</em>'));
  }
  
  $output = theme('table', $header, $rows)
      . '<p>' . l(t('Add new field'), "admin/settings/oi/entity_type_field_edit/$etid") . '</p>';
  
  return $output;
}


function oi_settings_entity_type_field_dispatch ($etid = 0, $ftid = 0) {
  $entity_type = db_fetch_array(db_query("SELECT * FROM {oi_entity_types} WHERE etid = %d", $etid));
  if (!isset($entity_type) or !is_array($entity_type)) {
    drupal_set_message("You must add fields to existing entity types.");
    drupal_goto('admin/settings/oi');
    return;
  }
  else {
    return drupal_get_form('oi_settings_entity_type_field_form', $entity_type, $ftid);
  }
}

function oi_settings_entity_type_field_form (&$form_state, $et, $ftid = 0) {
  
  $defaults = array(
    'etid' => $et['etid'],
    'ftid' => $ftid,
    'ftname' => '',
    'ftdisplay' => '',
    'fttype' => '',
    'ftparameters' => '',
    'ftweight' => 0,
  );
  
  if ($ftid != 0) {
    $defaults = db_fetch_array(db_query("SELECT * FROM {oi_entity_type_fields} WHERE ftid = %d", $ftid));
  }

  $form = array();
  
  $field_name = 'adding a new field';
  if ($defaults['ftname'] != '') {
    $field_name = 'editing field ' . theme('placeholder', $defaults['ftname']);
  }
  $form[] = array(
    '#type' => 'markup',
    '#value' => $field_name . ' to entity type ' . theme('placeholder', $entity_type['etname']),
  );
  
  $form['etid'] = array(
    '#type' => 'value',
    '#value' => $defaults['etid'],
  );
  
  $form['ftid'] = array(
    '#type' => 'value',
    '#value' => $defaults['ftid'],
  );
  
  $form['ftname'] = array(
    '#type' => 'textfield',
    '#title' => t('field short name'),
    '#description' => t('A short (internal) name for the field.  No spaces or capitol letters, please.'),
    '#default_value' => $defaults['ftname'],
    '#required' => true,
  );
  
  $form['ftdisplay'] = array(
    '#type' => 'textfield',
    '#title' => t('field display name'),
    '#description' => t('A display name for the field.'),
    '#default_value' => $defaults['ftdisplay'],
    '#required' => true,
  );
  
  $form['fttype'] = array(
    '#type' => 'select',
    '#title' => t('field type'),
    '#description' => t(''),
    '#default_value' => $defaults['fttype'],
    '#options' => array(
      'text' => 'Text data',
      'email' => 'Email address',
      'url' => 'URL',
    ),
  );

  $form['ftweight'] = array(
    '#type' => 'weight',
    '#title' => 'Field Weight',
    '#default_value' => $defaults['ftweight'],
  );

  $form[] = array(
    '#type' => 'submit',
    '#value' => t('Save entity type field'),
  );
  
  return $form;
}

function oi_settings_entity_type_field_form_submit ($form, &$form_state) {
  if ($form_state['values']['ftid'] == 0) {
    // new field
    db_query("INSERT INTO {oi_entity_type_fields} (etid, ftname, ftdisplay, fttype, ftweight) VALUES (%d, '%s', '%s', '%s', %d)", $form_state['values']['etid'], $form_state['values']['ftname'], $form_state['values']['ftdisplay'], $form_state['values']['fttype'], $form_state['values']['ftweight']);
    drupal_set_message(t('The entity type field was added'));
  }
  else {
    // updating
    db_query("UPDATE {oi_entity_type_fields} SET ftname = '%s', ftdisplay = '%s', fttype = '%s', ftweight = %d WHERE ftid = %d", $form_state['values']['ftname'], $form_state['values']['ftdisplay'], $form_state['values']['fttype'], $form_state['values']['ftweight'], $form_state['values']['ftid']);
    drupal_set_message(t('The entity type field was updated'));
  }
  
  $form_state['redirect'] = "admin/settings/oi/entity_type_edit/" . $form_state['values']['etid'];
}

function oi_settings_entity_type_field_delete ($etid, $ftid) {
  return drupal_get_form('oi_settings_entity_type_field_delete_form', $etid, $ftid);
}

function oi_settings_entity_type_field_delete_form (&$form_state, $etid, $ftid) {
  $ftname = db_result(db_query("SELECT ftname FROM {oi_entity_type_fields} WHERE ftid = %d", $ftid));
  $etname = db_result(db_query("SELECT etname FROM {oi_entity_types} WHERE etid = %d", $etid));
  
  //** TODO: put a check in here to see if the field is being used
  $used = false;
  if ($used) {
    drupal_set_message(t('You cannot delete the field %ftname because it is in use', array('%ftname' => $ftname)));
    drupal_goto("admin/settings/oi/entity_type_edit/$etid");
    return;
  }
  
  $form = array();
  $form['ftid'] = array(
    '#type' => 'value',
    '#value' => $ftid,
  );
  $form['ftname'] = array(
    '#type' => 'value',
    '#value' => $ftname,
  );
  $form['etid'] = array(
    '#type' => 'value',
    '#value' => $etid,
  );
  $form['etname'] = array(
    '#type' => 'value',
    '#value' => $etname,
  );
  
  return confirm_form($form,
            t('Are you sure you want to delete the field %field from entity type %type', array('%field' => $ftname, '%type' => $etname)),
            "admin/settings/oi/entity_type_edit/$etid",
            '',
            t('Delete'),
            t('Cancel'));
}

function oi_settings_entity_type_field_delete_form_submit ($form, &$form_state) {
  db_query("DELETE FROM {oi_entity_type_fields} WHERE ftid = %d", $form_state['values']['ftid']);
  
  drupal_set_message(t('The entity type field %field for type %type has been deleted.', array('%field' => $form_state['values']['ftname'], '%type' => $form_state['values']['etname'])));
  $form_state['redirect'] = "admin/settings/oi/entity_type_edit/" . $form_state['values']['etid'];
}

/**
 * @}
 */


/* Parent and recursive function to get entity types tree.
 * the database has fields to allow hierarchical entity types, however
 * I'm not sure that it's actually worth the bother of implementing them
 */

function _oi_get_entity_types () {
  $return = array();
  
  $e_q = db_query("SELECT * FROM {oi_entity_types}");
  while($e_r = db_fetch_array($e_q)) {
    $return['types'][$e_r['etid']] = array(
      'etid' => $e_r['etid'],
      'etname' => $e_r['etname'],
      'parent_etid' => $e_r['parent_etid'],
    );
  }
  
  $return['tree'] = _oi_get_entity_types_tree();

  return $return;
}

function _oi_get_entity_types_tree ($parent = 0) {
  $e_q = db_query("SELECT etid FROM {oi_entity_types} WHERE parent_etid = %d", $parent);
  $ret = array();
  while($e_r = db_fetch_array($e_q)) {
    $ret[$e_r['etid']] = _oi_get_entity_types_tree($e_r['etid']);
  }
  return $ret;
}


/* Parent and recursive function to create a "select" options array of entity types.
 * this array is flat, but tries to indicate the hierarchy by prefixing
 * the names of items with dashes.  This would be used to create a pop-up menu
 * of the entity types for a form item.
 */

function oi_entity_types_select_array ($none = '<none>') {
  $data = _oi_get_entity_types();
  $select = array(0 => $none);
  _oi_entity_types_select_array_recurse($data['tree'], $data['types'], $select);
  
  return $select;
}

function _oi_entity_types_select_array_recurse ($tree, $data, &$select, $count = 0) {
  foreach ($tree as $etid => $children) {
    $select[$etid] = _oi_get_dashes($count) . ' ' . $data[$etid]['etname'];
    _oi_entity_types_select_array_recurse($children, $data, $select, $count+1);
  }
}


/**
 * @defgroup entities
 * @{
 */

function oi_entities_list () {
  $entities = _oi_get_entities();
  
  $header = array(
    t('Entities'),
    t('Operations'),
  );
  
  $rows = array();
  _oi_entities_list_recurse_rows($entities['tree'], $entities['entities'], $rows);
  
  if (count($rows) == 0) {
    $rows[] = array(array('colspan' => 2, 'data' => t('No entities defined')));
  }
  
  $output = theme('table', $header, $rows, array('class' => 'oi-entity-table'))
      . '<p>' . l(t('Add new entity'), "admin/user/oi/entity_add_edit") . '</p>';

  return $output;
  
}

function _oi_entities_list_recurse_rows ($tree, $info, &$rows, $depth = 0) {
  foreach ($tree as $eid => $children) {
    $rows[] = array(
      _oi_get_dashes($depth, '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;')
      . $info[$eid]['display'],
      l(t('edit data'), "admin/user/oi/entity_data_edit/$eid") . ' | ' .
        l(t('edit entity'), "admin/user/oi/entity_add_edit/$eid") . ' | ' .
        l(t('delete'), "admin/user/oi/entity_delete/$eid")
    );
    _oi_entities_list_recurse_rows($children, $info, $rows, $depth + 1);
  }
}

function oi_entities_form_dispatch ($eid = 0) {
  return drupal_get_form('oi_entities_form', $eid);
}

function oi_entities_form (&$form_state, $eid = 0) {
  $defaults = array(
    'eid' => 0,
    'etid' => null,
    'name' => null,
    'display' => null,
    'parent_eid' => 0,
    'propagate_membership' => 1,
    'weight' => 0,
  );
  
  if ($eid != 0) {
    $defaults = db_fetch_array(db_query("SELECT * FROM {oi_entities} WHERE eid = %d", $eid));
  }
  
  $form = array();
  
  $form['eid'] = array(
    '#type' => 'value',
    '#value' => $eid,
  );
  $form['name'] = array(
    '#type' => 'textfield',
    '#title' => t('Internal entity name'),
    '#description' => t('A short name for the entity.  This is used for internal purposes, and should be lowercase letters, numbers, and underscores only.'),
    '#default_value' => $defaults['name'],
    '#maxlength' => 100,
    '#required' => true,
  );
  
  $form['display'] = array(
    '#type' => 'textfield',
    '#title' => t('Display entity name'),
    '#description' => t('A display name for the entity.  This may contain spaces, capitol letters, punctuation, etc...'),
    '#default_value' => $defaults['display'],
    '#required' => true,
  );
  
  if ($defaults['etid'] == null) {
    $form['etid'] = array(
      '#type' => 'select',
      '#title' => t('Entity type'),
      '#description' => t('What type of entity this is.'),
      '#default_value' => $defaults['etid'],
      '#options' => oi_entity_types_select_array(''),
      '#required' => true,
    );
  }
  else {
    $form['etid'] = array(
      '#type' => 'value',
      '#value' => $defaults['etid'],
    );
    $form[] = array(
      '#type' => 'markup',
      '#value' => '<p>' . t('This entity is of type %type', array('%type' => db_result(db_query('SELECT etname FROM {oi_entity_types} WHERE etid = %d', $defaults['etid'])))) . '</p>',
    );
  }
  
  $form['parent_eid'] = array(
    '#type' => 'select',
    '#title' => t('Parent entity'),
    '#default_value' => $defaults['parent_eid'],
    '#options' => oi_entities_select_array('<root>'),
    '#required' => true,
  );
  
  $form['propagate_membership'] = array(
    '#type' => 'checkbox',
    '#title' => t('Propagate membership up the tree'),
    '#default_value' => $defaults['propagate_membership'],
    '#description' => t("If you don't know what this setting does, you should probably leave it alone"),
  );
  
  $form['weight'] = array(
    '#type' => 'weight',
    '#title' => t('Weight'),
    '#default_value' => $defaults['weight'],
    '#delta' => 30,
  );
  
  $form[] = array(
    '#type' => 'submit',
    '#value' => 'Save entity',
  );
    
  return $form;
}

function oi_entities_form_validate ($form, &$form_state) {
  if ($form_state['values']['etid'] == 0) {
    form_set_error('etid', 'You must supply an entity type for this entity');
  }
}

function oi_entities_form_submit ($form, &$form_state) {
  if (!isset($form_state['values']['eid']) or ($form_state['values']['eid'] == 0)) {
    // new record
    db_query("INSERT INTO {oi_entities} (etid, name, display, parent_eid, propagate_membership, weight) values (%d, '%s', '%s', %d, %d, %d)",
          $form_state['values']['etid'], $form_state['values']['name'], $form_state['values']['display'], $form_state['values']['parent_eid'], $form_state['values']['propagate_membership'], $form_state['values']['weight']);
    drupal_set_message(t('The entity %display was created.', array('%display' => $form_state['values']['display'])));
  }
  else {
    // updating
    db_query("UPDATE {oi_entities} SET name = '%s', display = '%s', parent_eid = %d, propagate_membership = %d, weight = %d WHERE eid = %d",
         $form_state['values']['name'], $form_state['values']['display'], $form_state['values']['parent_eid'], $form_state['values']['propagate_membership'], $form_state['values']['weight'], $form_state['values']['eid']);
    drupal_set_message(t('The entity %display was updated.', array('%display' => $form_state['values']['display'])));
  }
  
  $form_state['redirect'] = 'admin/user/oi';
}

function oi_entities_delete_dispatch ($eid) {
  return drupal_get_form('oi_entities_delete_form', $eid);
}

function oi_entities_delete_form (&$form_state, $eid) {
  $form = array();
  
  $display = db_result(db_query("SELECT display FROM {oi_entities} WHERE eid = %d", $eid));
  
  $form['eid'] = array(
    '#type' => 'value',
    '#value' => $eid,
  );
  $form['display'] = array(
    '#type' => 'value',
    '#value' => $display,
  );
  
  return confirm_form($form,
            t('Are you sure you want to delete the entity %display and all of the information associated with it?',
               array('%display' =>  $display)),
            'admin/user/oi',
            t('This will delete the entity, any field information for that entity, and remove any users from the entity.  If there is any content which is restricted to the view of this entity, it will be set to the default restriction entity.'),
            t('Delete'),
            t('Cancel'));
}

function oi_entities_delete_form_submit ($form, &$form_state) {
  db_query("DELETE FROM {oi_entities} WHERE eid = %d", $form_state['values']['eid']);
  db_query("DELETE FROM {oi_entity_roles} WHERE eid = %d", $form_state['values']['eid']);
  db_query("DELETE FROM {oi_entity_fields} WHERE eid = %d", $form_state['values']['eid']);
  // more deletes here...
  // need to do recursive delete?
  
  drupal_set_message(t('The entity %display and associted information has been deleted.',
             array('%display' => $form_state['values']['display'])));
  $form_state['redirect'] = 'admin/user/oi';
}


function oi_entities_data_edit ($eid) {
  $output = '';
  
  $entity = db_fetch_array(db_query("SELECT * FROM {oi_entities} WHERE eid = %d", $eid));
  
  $output .= _oi_entities_data_edit_get_roles_table($entity);
  $output .= _oi_entities_data_edit_get_fields_table($entity);
  
  return $output;
}

function _oi_entities_data_edit_get_roles_table ($entity) {
  // get a list of all the roles for this entity
  
  $roles = array();
  $roles_q = db_query("SELECT * FROM {oi_entity_type_roles} WHERE etid = %d ORDER BY rtweight", $entity['etid']);
  while($r_a = db_fetch_array($roles_q)) {
    $roles[$r_a['rtid']] = $r_a['rtdisplay'];
  }
  
  if (count($roles) == 0) {
    // there are no roles for this entity type
    return theme('box', t('Roles for %entity', array('%entity' => $entity['display'])),
              '<p>There are no roles defined for this entity type</p>');
  }
  
  $header = array(
    t('Role'),
    t('User(s)'),
    ''
  );
  
  $rows = array();
  
  foreach ($roles as $rtid => $rtdisplay) {
    // get a list of all the existing users
    $uid_q = db_query("SELECT uid FROM {oi_entity_roles} WHERE eid = %d and rtid = %d", $entity['eid'], $rtid);
    $uids = o