modules/netforum_views/netforum_views.module

<?php
// $Id: netforum_views.module,v 1.9 2007/12/14 05:10:38 jamesmichaelhill Exp $

/**
 * @file
 * The netFORUM Views module
 *
 *  Uses the netFORUM xWeb module to fetch a list of Objects from netFORUM and
 *  turn them into a page or a block for viewing.  It integrates tightly with the netFORUM
 *  Dynamic Facade Nodes module and uses the same syntax, but provides a different user interface
 *  and means of viewing a list.
 *
 *  Many functions and behavior of this module is patterend, copied, or adapted from the Views module
 * 
 */


/*
 * Implementation of hook_help()
 */
function netforum_views_help($section) {
  switch ($section) {
    case 'admin/help#netforum_views':
      return _netforum_views_help_add();
    case 'admin/build/netforum_views':
      return t('This screen shows all of the netFORUM views that are currently defined in your system.');
  }
}

/*
 * Because the add/edit page is kind of complicated.
 */
function _netforum_views_help_add() {
  $output = t('<p>A netforum view retrieves some information from netFORUM and displays it in a variety of formats, much like the Views module.</p>');
  $output .= t("<p>netFORUM views uses the same template format as !nfn.</p>\n", array("!nfn" => l(t('netFORUM nodes'), 'admin/help/netforum_node')));
  $output .= t("<p>Here's an example to show a list of ten upcoming meetings</p>");
  $output .= t("<pre>
  {BeginList}
    {BeginObjectName}Event @TOP 10{EndObjectName}
    {BeginWhere}evt_start_date > '{currentdate}' {EndWhere}
    {BeginColumns}evt_title, evt_start_date{EndColumns}
    {BeginOrderBy}evt_start_date desc {EndOrderBy}
    {BeginDetail}{ListRowNumber} - {BeginLink}{evt_title}{EndLink} - {evt_start_date}{EndDetail}
  {EndList}
  There are {ListRowCount} upcoming events!
</pre>");
  $output .= t("<p>Blocks and pages can also accept parameters and turn them into curly brackets to use with queries.  Since text between {BeginWhere} and {EndWhere} 
    is checked for conditional statements and curly brackets, clever use of parameters and links can be used to create a searchable directory of content.  For example, if you had a view
    that provided a page, and the url was www.example.com/individuals, then if you allowed get arguments and an argument called first_name_starts_with you could write a list with this where clause:
    <pre>{BeginWhere}
  ind_delete_flag = 0 
  {?first_name_starts_with!=''? AND ind_first_name like '{first_name_starts_with}%'??} 
{EndWhere}</pre>
    when someone went to www.example.com/individuals&fist_name_starts_with=jim the where clause would expand to 
    <pre>ind_delete_flag = 0 and ind_first_name like 'jim%'</pre> 
    and only people who's first name started with jim would be returned from netFORUM.</p><br><br>");
  return $output;
}

/*
 * Implementation of hook_perm()
 */
function netforum_views_perm() {
  return array('administer netFORUM views', 'access all netFORUM views');
}

/*
 * Implementation of hook_menu()
 */
function netforum_views_menu($may_cache) {
  $items = array();

  if ($may_cache) {
    $items[] = array('path' => 'admin/build/netforum_views',
      'title' => t('netFORUM views'),
      'callback' => 'netforum_views_admin_page',
      'access' => user_access('administer netFORUM views'),
      'description' => t('Views are customized lists of content on your system; they are highly configurable and give you control over how lists of content are presented.'),
      'type' => MENU_NORMAL_ITEM);
    $items[] = array('path' => 'admin/build/netforum_views/list',
      'title' => t('List'),
      'callback' => 'netforum_views_admin_page',
      'access' => user_access('administer netFORUM views'),
      'type' => MENU_DEFAULT_LOCAL_TASK,
      'weight' => '-1');
    $items[] = array('path' => 'admin/build/netforum_views/add',
      'title' => t('Add'),
      'callback' => 'netforum_views_admin_add_page',
      'access' => user_access('administer netFORUM views'),
      'type' => MENU_LOCAL_TASK);
    $items[] = array('path' => 'admin/build/netforum_views/delete',
      'title' => t('Edit view'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array('netforum_views_admin_delete_confirm'),
      'access' => user_access('administer netFORUM views'),
      'type' => MENU_CALLBACK);
    $items[] = array('path' => 'admin/build/netforum_views/refresh',
      'title' => t('Refresh View'),
      'callback' => 'netforum_views_refresh_data',
      'access' => user_access('administer netFORUM views'),
      'type' => MENU_CALLBACK);  
    netforum_views_menu_standard_items($items);
  }
  else {
    if (user_access('administer netFORUM views') && 
        arg(0) == 'admin' && 
        arg(1) == 'build' && 
        arg(2) == 'netforum_views') {
      $view = _netforum_views_load_view(arg(3));
      if ($view) {
        netforum_views_add_menu_items($items, $view, 'admin/build/netforum_views/' . arg(3), TRUE);
      }
    }
    netforum_views_menu_inline_items($items);
  }
  return $items;
}

function netforum_views_add_menu_items(&$items, $view, $url, $base = TRUE, $args = array()) {
  if (user_access('administer netFORUM views')) {
    if ($base) {
      // we also have to add the administrative 'view' of the view in some
      // cases
      $items[] = array('path' => $url,
        'title' => t('View'),
        'callback' => 'netforum_views_view_page',
        'callback arguments' => array_merge(array($view->name), $args),
        'access' => user_access('administer netFORUM views'),
        'type' => MENU_CALLBACK);
    }
    $items[] = array('path' => "$url/view",
      'title' => t('View'),
      'callback' => 'netforum_views_view_page',
      'callback arguments' => array_merge(array($view->name), $args),
      'access' => user_access('administer netFORUM views'),
      'weight' => -10,
      'type' => MENU_DEFAULT_LOCAL_TASK);
    $items[] = array('path' => "$url/edit",
      'title' => t('Edit'),
      'callback' => 'netforum_views_admin_edit_page',
      'callback arguments' => array($view->name),
      'access' => user_access('administer netFORUM views'),
      'weight' => -5,
      'type' => MENU_LOCAL_TASK);
    $items[] = array('path' => "$url/refresh",
      'title' => t('Refresh netFORUM data'),
      'callback' => 'netforum_views_refresh_data',
      'callback arguments' => array($view->vid, false),
      'access' => user_access('administer netFORUM views'),
      'weight' => 0,
      'type' => MENU_LOCAL_TASK);
  }
}

/**
 * Add the menu items for all non-inline views to the menu
 */
function netforum_views_menu_standard_items(&$items) {
  $result = db_query("SELECT * FROM {netforum_view} WHERE page = 1");

  while ($view = db_fetch_object($result)) {
    // unpack the array
    $view->access = ($view->access ? explode(', ', $view->access) : array());

    _netforum_views_create_menu_item($items, $view, $view->url);
  }
}

/**
 * Helper function to add a menu item for a view.
 */
function _netforum_views_create_menu_item(&$items, $view, $path, $local_task_type = MENU_NORMAL_ITEM, $args = array()) {
  $title = filter_xss_admin(netforum_views_get_title($view, 'menu'));
  $type = _netforum_views_menu_type($view);
  if ($type == MENU_LOCAL_TASK || $type == MENU_DEFAULT_LOCAL_TASK) {
    $weight = $view->menu_tab_weight;
  }
  $access = netforum_views_access($view);
  $items[] = _netforum_views_menu_item($path, $title, $view, $args, $access, $type, $weight);

  if ($type == MENU_DEFAULT_LOCAL_TASK) {
    switch ($view->menu_tab_default_parent_type) {
      case 'tab':
        $parent_type = MENU_LOCAL_TASK;
        break;
      case 'normal':
        $parent_type = MENU_NORMAL_ITEM;
        break;
      case 'existing':
        $parent_type = 0;
        break;
    }
    if ($parent_type) {
      $title = filter_xss_admin(netforum_views_get_title($view, 'menu-parent'));
      $weight = $view->menu_parent_tab_weight;
      $items[] = _netforum_views_menu_item(dirname($path), $title, $view, $args, $access, $parent_type, $weight);
    }
  }
}

/**
 * Helper function to create a menu item for a view.
 */
function _netforum_views_menu_item($path, $title, $view, $args, $access, $type, $weight = NULL) {
  array_unshift($args, $view->name);
  $retval = array('path' => $path,
    'title' => $title,
    'callback' => 'netforum_views_view_page',
    'callback arguments' => $args,
    'access' => user_access('access content') && $access,
    'type' => $type,
  );
  if ($weight !== NULL) {
    $retval['weight'] = $weight;
  }
  return $retval;
}

function _netforum_views_menu_type($view) {
  if ($view->menu) {
    if ($view->menu_tab_default) {
      $type = MENU_DEFAULT_LOCAL_TASK;
    }
    else if ($view->menu_tab) {
      $type = MENU_LOCAL_TASK;
    }
    else {
      $type = MENU_NORMAL_ITEM;
    }
  }
  else {
    $type = MENU_CALLBACK;
  }
  return $type;
}


function netforum_views_menu_inline_items(&$items) {
  $args = explode('/', $_GET['q']);
  $urls = netforum_views_get_all_urls();
  foreach ($urls as $view_name => $url) {
    if ($url{0} != '$' && strpos($url, '/$') === FALSE) {
      if (user_access('administer netFORUM views')) {
        $view_args = $args;

        foreach (explode('/', $url) as $num => $element) {
          if ($element != $args[$num]) {
            continue 2;
          }
          unset($view_args[$num]);
        }
        netforum_views_menu_admin_items($items, $view_name, $view_args, $args);
      }
    }
    else {
      // Do substitution on args.
      $use_view = $use_menu = FALSE;
      $menu_args = $view_args = $menu_path = array();

      foreach (explode('/', $url) as $num => $element) {
        if ($element{0} == '$') {
          // If we pass the token check, this view is definitely being used.
          list($token, $argument) = explode('-', $element);
          if ($tokens[$token] && function_exists($tokens[$token])) {
            if (!($use_view = $use_menu = $tokens[$token]($element, $argument, arg($num)))) {
              break;
            }
          }
          $menu_path[] = $view_args[] = arg($num);
        }
        else {
          unset($menu_args[$num]);
          $menu_path[] = $element;
          if ($element != arg($num)) {
            $use_menu = FALSE;
          }
        }
        // we are only using views that match our URL, up to the
        // point where we hit an inline arg.
        if (!$use_view && $element != arg($num)) {
          break;
        }
      }
      if ($use_view) {
        $path = implode('/', $menu_path);
        $view = netforum_views_get_view($view_name); 
        $view->args = $view_args;
        _netforum_views_create_menu_item($items, $view, $path, MENU_CALLBACK, $view_args);
      }

      if (user_access('administer netFORUM views') && $use_menu) {
        netforum_views_menu_admin_items($items, $view_name, $menu_args, $args);
      }
    }
  }
}

/**
 * Load all of the URLs we use; this is cached in a special manner
 * in an attempt to make the menu system both flexible and yet not
 * overly intensive.
 */
function netforum_views_get_all_urls() {
  $cache = cache_get("netforum_views_urls");
  if ($cache == 0) {
    $views = array();
    $used = array();
    // avoid creating empty path items by requiring an URL to be set
    $result = db_query("SELECT name, url FROM {netforum_view} WHERE page = 1 AND LENGTH(url) > 0");

    while ($view = db_fetch_object($result)) {
      $views[$view->name] = $view->url;
    }

    cache_set("netforum_views_urls", 'cache', serialize($views));
  }
  else {
    $views = unserialize($cache->data);
  }

  return $views;
}

/**
 * Add the adminstrative items to a view.
 */
function netforum_views_menu_admin_items(&$items, $view_name, $view_args, $args) {
  // Remove args that are tabs from $args.
  $tabs = array('edit', 'view', 'add', 'refresh');
  // See what the last arg is.
  $last_arg = array_pop($args);
  if (in_array($last_arg, $tabs)) {
    array_pop($view_args);
  }
  else {
    $args[] = $last_arg;
  }
  $view = netforum_views_get_view($view_name);  
  $path = implode('/', $args);
  netforum_views_add_menu_items($items, $view, $path, $path != $_GET['q'] && !empty($view_args), $view_args);
}

// ---------------------------------------------------------------------------
// Administrative Pages

/*
 * This page lists all system views and provides links to edit them.
 */
function netforum_views_admin_page() {

  $numViews = 25;

  drupal_set_title(t('administer netFORUM views'));

  $result = pager_query("SELECT vid, name, description, menu_title, page_title, block_title, url, page, menu, block FROM {netforum_view} ORDER BY name", $numViews);

  while ($view = db_fetch_object($result)) {
    $url = ($view->page ? l($view->url, $view->url) : t('No Page View'));
    $provides = array();
    if ($view->page) {
      $provides[] = 'Page';
    }
    if ($view->block) {
      $provides[] = 'Block';
    }
    if ($view->menu) {
      $provides[] = 'Menu';
    }

    $items[] = array(
      $view->name, 
      filter_xss_admin(netforum_views_get_title($view, 'admin')), 
      $view->description, 
      implode(', ', $provides), 
      $url, 
      theme('links', array(
        array('title' => t('Edit'), 'href' => "admin/build/netforum_views/$view->name/edit"), 
        array('title' => t('Refresh'), 'href' => "admin/build/netforum_views/refresh/$view->vid"),
        array('title' => t('Delete'), 'href' => "admin/build/netforum_views/delete/$view->vid"),
      ))
    );
  }

  if ($items) {
    $output = theme('table', array(t('View'), t('Title'), t('Description'), t('Provides'), t('URL'), t('Actions')), $items, array("cellpadding" => "4"), t('Existing Views'));
    $output .= theme('pager', NULL, $numViews);
  }
  else {
    $output .= t('<p>No views have currently been defined.</p>');
  }

  return $output;
}

/*
 * Provide a form to add a view. Allow adding a view from default templates.
 */
function netforum_views_admin_add_page($template = NULL) {

  $op = $_POST['op'];
  if ($op == t('Cancel')) {
    drupal_goto('admin/build/netforum_views');
  }

  drupal_set_title(t('Add a netFORUM View'));

  return drupal_get_form('netforum_views_edit_view', $view, $op);
}

/*
 * Provide a form to edit a view.
 */
function netforum_views_admin_edit_page($vid = '') {

  $op = $_POST['op'];
  if ($op == t('Cancel')) {
    drupal_goto('admin/build/netforum_views');
  }

  if ($op == t('Delete')) {
    drupal_goto("admin/build/netforum_views/delete/$vid");
  }

  if (!($view = _netforum_views_load_view($vid))) {
    drupal_goto('admin/build/netforum_views');
  }

  drupal_set_title(t('Edit view %n', array('%n' => $view->name)));
  return drupal_get_form('netforum_views_edit_view', $view, $op);
}

/*
 * Provide a form to confirm deletion of a view.
 */
function netforum_views_admin_delete_confirm($vid = '') {
  $view = _netforum_views_load_view($vid); 

  if (!$view) {
    return drupal_goto('admin/build/netforum_views');
  }

  $form['vid'] = array('#type' => 'value', '#value' => $view->vid);
// bdragon note: Did you mean to drop the above line on the floor with this?
  $form = confirm_form($form,
    t('Are you sure you want to delete %title?', array('%title' => $view->name)),
    $_GET['destination'] ? $_GET['destination'] : 'admin/build/netforum_views',
    t('This action cannot be undone.'),
    t('Delete'), t('Cancel')
  );
  return $form;
}

/*
 * Handle the submit button to delete a view.
 */
function netforum_views_admin_delete_confirm_submit($form_id, $form) {
  _netforum_views_delete_view((object) $form); 
  menu_rebuild();
}

/*
 * Get an empty view with basic defaults.
 */
function _netforum_views_get_default_view() {
  $view = new stdClass();
  $view->use_pager = true;
  $view->nodes_per_page = variable_get('default_nodes_main', 10);
  $view->page_header_format = variable_get('filter_default_format', 1);
  $view->page_footer_format = variable_get('filter_default_format', 1);
  $view->page_header_format = variable_get('filter_default_format', 1);
  $view->block_header_format = variable_get('filter_default_format', 1);
  $view->block_footer_format = variable_get('filter_default_format', 1);
  $view->block_header_format = variable_get('filter_default_format', 1);
  $view->vid = 0;

  return _views_check_arrays($view);
}

function netforum_views_build_list($view) {
  //cheat a bunch.
  $list_content = '';
  if (! empty($_POST['obj_type_name'])) {
    $list_content .= "{BeginList}\n";
    $list_content .= "{BeginObjectName}". filter_xss_admin($_POST['obj_type_name']) ."{EndObjectName}\n";
    if (! empty($_POST['query_name'])) {
      $list_content .= "{BeginQueryName}". filter_xss_admin($_POST['query_name']) ."{EndQueryName}\n";
    }
    else if (! empty($_POST['query_where']) && !empty($_POST['query_columns'])) {
      $list_content .= "{BeginColumns} ". filter_xss_admin($_POST['query_columns']) ." {EndColumns}\n";
      $list_content .= "{BeginWhere} ". filter_xss_admin($_POST['query_where']) ." {EndWhere}\n";
      if (!empty($_POST['query_orderby'])) {
        $list_content .= "{BeginOrderBy} ". filter_xss_admin($_POST['query_orderby']) ."{EndOrderBy}\n";
      }
    }
    $list_content .= "{BeginDetail} Everything in this section will be displayed for each result {EndDetail}\n";
    $list_content .= "{EndList}\n";
  }
  return $list_content;
}

/**
 * Determines if there is enough information to build a view query.
 *
 * This helps cut down on problems of people accidentally overwriting their view
 *
 */
function netforum_views_valid_build_request($view) {
  if (! empty($_POST['obj_type_name'])) {
    if (! empty($_POST['query_name'])) {
      return true;
    }
    else if (! empty($_POST['query_where']) && !empty($_POST['query_columns'])) {
      return true;
    }
  }
  return false;
}

/**
 * Display all the guts of a view in a form for editing.
 */
function netforum_views_edit_view($view, $op = '') {
  drupal_add_js(drupal_get_path('module', 'netforum_views') .'/jquery.netforum_views.js');
  drupal_set_html_head("<script type=\"text/javascript\">
      var BASE_URL = '". base_path() ."';
    </script>");

  // Put in all our add buttons, then process them to see if they've been hit.
  $form = array();
  
  if ($_POST['edit'] && $op != t('Save')) {
    drupal_set_message(t('You have modified this view; changes will not be recorded until you Save the form.'));
  }


  $form['vid'] = array(
    '#type' => 'value',
    '#value' => $view->vid,
  );
  $form['allbut'] = array(
    '#type' => 'value',
    '#value' => $allbut,
  );
  $form['changed'] = array(
    '#type' => 'hidden',
    '#value' => $view->changed,
  );

  $form['basic-info'] = array(
    '#type' => 'fieldset',
    '#collapsible' => true,
    '#collapsed' => ($allbut != NULL),
    '#title' => t('Basic Information'),
  );

  $form['basic-info']['name'] = array(
    '#type' => 'textfield',
    '#title' => t('Name'),
    '#default_value' => $view->name,
    '#size' => 20,
    '#maxlength' => 32,
    '#description' => t('The unique identifier of the view; it is only important for overridden views and views that modules or themes will need to use. Only alphanumeric and _ allowed here'),
    '#required' => true,
  );

  $form['basic-info']['access'] = array(
    '#type' => 'checkboxes',
    '#title' => t('Access'),
    '#default_value' => $view->access,
    '#options' => netforum_views_handler_filter_role(),
    '#description' => t('Only the checked roles will be able to see this view in any form; if no roles are checked, access will not be restricted.'),
  );

  $form['basic-info']['description'] = array(
    '#type' => 'textfield',
    '#title' => t('Description'),
    '#default_value' => $view->description,
    '#size' => 60,
    '#maxlength' => 255,
    '#description' => t('A description of the view for the admin list.'),
  );

  // page info

  $form['page-info'] = array(
    '#type' => 'fieldset',
    '#collapsible' => true,
    '#collapsed' => ($allbut != NULL || !$view->page),
    '#title' => t('Page'),
  );

  $form['page-info']['page'] = array(
    '#type' => 'checkbox',
    '#title' => t('Provide Page View'),
    '#return_value' => 1,
    '#default_value' => $view->page,
    '#description' => t('If checked this view will be provided as a page. If not checked, the fields in this group will be ignored.'),
  );

  $form['page-info']['url'] = array(
    '#type' => 'textfield',
    '#title' => t('URL'),
    '#default_value' => $view->url,
    '#size' => 60,
    '#maxlength' => 255,
    '#description' => t('Enter the URL to use for this view in the form of \'dir/dir\'. Do not begin or end the URL with a /. Example: \'view/tracker\'. This is required if providing a page view. You can also add $arg as a placeholder for arguments passed in the URL, for example \'user/$arg/tracker\' or \'node/$arg/related\'. Note that any arguments listed here will be required, even if they are listed as optional below. You do not need to list arguments at the end of the path. Do not try to use URLs such as taxonomy/term/$arg.'),
  );

  $form['page-info']['page_title'] = array(
    '#type' => 'textfield',
    '#title' => t('Title'),
    '#default_value' => $view->page_title,
    '#size' => 60,
    '#maxlength' => 255,
    '#description' => t('The title that be shown at the top of the view. May be blank. This title ignores arguments; if you want your title to take arguments into account, use the "title" field in the arguments section.'),
  );

  $form['page-info']['breadcrumb_no_home'] = array(
    '#type' => 'checkbox',
    '#title' => t('Breadcrumb trail should not include "Home"'),
    '#return_value' => 1,
    '#default_value' => $view->breadcrumb_no_home,
    '#description' => t('If checked the breadcrumb trail for this page will discard "Home". Usually you will not set this, but this is used for the Front Page View, where it IS Home and should not leave a trail to itself.'),
  );
  $form['page-info']['page_header_fieldset'] = array(
    '#type' => 'fieldset',
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#title' => t('Header'),
  );
  $form['page-info']['page_header_fieldset']['page_header'] = array(
    '#type' => 'textarea',
    '#default_value' => $view->page_header,
    '#cols' => 60,
    '#rows' => 6,
    '#description' => t('Text to display at the top of the view. May contain an explanation or links or whatever you like. Optional.'),
  );

  $form['page-info']['page_header_fieldset']['page_header_format'] = filter_form($view->page_header_format, 1, array('page_header_format'));

  $form['page-info']['page_footer_fieldset'] = array(
    '#type' => 'fieldset',
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#title' => t('Footer'),
  );
  $form['page-info']['page_footer_fieldset']['page_footer'] = array(
    '#type' => 'textarea',
    '#default_value' => $view->page_footer,
    '#cols' => 60,
    '#rows' => 6,
    '#description' => t('Text to display at the bottom of the view. May contain an explanation or links or whatever you like. Optional.'),
  );

  $form['page-info']['page_footer_fieldset']['page_footer_format'] = filter_form($view->page_footer_format, 1, array('page_footer_format'));

  $form['page-info']['page_empty_fieldset'] = array(
    '#type' => 'fieldset',
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#title' => t('Empty Text'),
  );
  $form['page-info']['page_empty_fieldset']['page_empty'] = array(
    '#type' => 'textarea',
    '#default_value' => $view->page_empty,
    '#cols' => 60,
    '#rows' => 6,
    '#description' => t('Text to display if a view returns no nodes. Optional.'),
  );

  $form['page-info']['page_empty_fieldset']['page_empty_format'] = filter_form($view->page_empty_format, 1, array('page_empty_format'));

  $form['page-info']['menu-info'] = array(
    '#type' => 'fieldset',
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#title' => t('Menu'),
  );

  $form['page-info']['menu-info']['menu'] = array(
    '#type' => 'checkbox',
    '#title' => t('Provide Menu'),
    '#return_value' => 1,
    '#default_value' => $view->menu,
    '#description' => t('If checked this view be given a menu entry in the Drupal menu system. If not checked the data in this group will be ignored.'),
  );

  $form['page-info']['menu-info']['menu_tab'] = array(
    '#type' => 'checkbox',
    '#title' => t('Provide Menu as Tab'),
    '#return_value' => 1,
    '#default_value' => $view->menu_tab,
    '#description' => t("If checked this view's menu entry will be provided as a tab rather than in the main menu system."),
  );

  $form['page-info']['menu-info']['menu_tab_weight'] = array(
    '#type' => 'textfield',
    '#title' => t('Tab Weight'),
    '#default_value' => $view->menu_tab_weight,
    '#width' => 10,
    '#description' => t('If this is a menu tab, select the weight; lower numbers will be further to the left.'),
  );

  $form['page-info']['menu-info']['menu_title'] = array(
    '#type' => 'textfield',
    '#title' => t('Menu Title'),
    '#default_value' => $view->menu_title,
    '#size' => 60,
    '#maxlength' => 255,
    '#description' => t('Enter the title to use for the menu entry or tab. If blank, the page title will be used.'),
  );

  $form['page-info']['menu-info']['default-tab'] = array(
    '#type' => 'fieldset',
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#title' => t('Default Menu Tab'),
  );

  $form['page-info']['menu-info']['default-tab']['menu_tab_default'] = array(
    '#type' => 'checkbox',
    '#title' => t('Make Default Menu Tab'),
    '#return_value' => 1,
    '#default_value' => $view->menu_tab_default,
    '#description' => t("If checked this view's menu entry will be provided as a tab, and will be the default tab for that URL path. For example, if the URL is 'tracker/all' and it is set as the default menu tab, it will be put into the menu as 'tracker' and 'tracker/all' will be the default tab. The following settings allow you to customize the parent item, for example 'tracker'. For tabs to work properly, one tab in the group must be set as the default."),
  );

  $form['page-info']['menu-info']['default-tab']['menu_tab_default_parent_type'] = array(
    '#type' => 'select',
    '#title' => t('Parent Menu Item Type'),
    '#default_value' => $view->menu_tab_default_parent_type,
    '#options' => array(
      'tab' => t("Tab"),
      'normal' => t("Normal menu item"),
      'existing' => t("Already exists (don't create)"),
    ),
    '#description' => t("Select type of parent item to use for this default menu tab. You can either specify the parent should be a tab (the default), a normal menu item, or to use the menu item that already exists at the specified URL. For example, if the URL for the default tab is 'tracker/all', then 'tracker' would already have to be a valid menu item to use this final choice."),
  );

  $form['page-info']['menu-info']['default-tab']['menu_parent_tab_weight'] = array(
    '#type' => 'textfield',
    '#title' => t('Tab Weight'),
    '#default_value' => $view->menu_parent_tab_weight,
    '#width' => 10,
    '#description' => t('If the parent menu item is a tab, select the weight; lower numbers will be further to the left.'),
  );

  $form['page-info']['menu-info']['default-tab']['menu_parent_title'] = array(
    '#type' => 'textfield',
    '#title' => t('Parent Menu Item Title'),
    '#default_value' => $view->menu_parent_title,
    '#size' => 60,
    '#maxlength' => 255,
    '#description' => t('If the Parent Menu Item is being defined by this view (if you set the %type_field to either %tab or %menu), you can specify its title here.  If blank, the menu title will be used if that is defined, or the page title if not.', array('%type_field' => t('Parent Menu Item Type'), '%tab' => t('Tab'), '%menu' => t('Normal menu item'))),
  );

  // block info

  $form['block-info'] = array(
    '#type' => 'fieldset',
    '#collapsible' => true,
    '#collapsed' => ($allbut != NULL || !$view->block),
    '#title' => t('Block'),
  );

  $form['block-info']['block'] = array(
    '#type' => 'checkbox',
    '#title' => t('Provide Block'),
    '#return_value' => 1,
    '#default_value' => $view->block,
    '#description' => t('If checked this view will be provided as a block. If checked title may not be blank.'),
  );

  $form['block-info']['block_title'] = array(
    '#type' => 'textfield',
    '#title' => t('Title'),
    '#default_value' => $view->block_title,
    '#size' => 60,
    '#maxlength' => 255,
    '#description' => t('The title that will be shown at the top of the block. May be blank.'),
  );

  $form['block-info']['block_header_fieldset'] = array(
    '#type' => 'fieldset',
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#title' => t('Header'),
  );
  $form['block-info']['block_header_fieldset']['block_use_page_header'] = array(
    '#type' => 'checkbox',
    '#title' => t('Use Page Header'),
    '#return_value' => 1,
    '#default_value' => $view->block_use_page_header,
    '#description' => t('If checked, use the Page Header for block view instead. If so, you should leave the Block Header blank.'),
  );

  $form['block-info']['block_header_fieldset']['block_header'] = array(
    '#type' => 'textarea',
    '#title' => t('Header'),
    '#default_value' => $view->block_header,
    '#cols' => 60,
    '#rows' => 6,
    '#description' => t('Text to display at the top of the view. May contain an explanation or links or whatever you like. Optional.'),
  );

  $form['block-info']['block_header_fieldset']['block_header_format'] = filter_form($view->block_header_format, 1, array( 'block_header_format'));

  $form['block-info']['block_footer_fieldset'] = array(
    '#type' => 'fieldset',
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#title' => t('Footer'),
  );
  $form['block-info']['block_footer_fieldset']['block_use_page_footer'] = array(
    '#type' => 'checkbox',
    '#title' => t('Use Page Footer'),
    '#return_value' => 1,
    '#default_value' => $view->block_use_page_footer,
    '#description' => t('If checked, use the page footer for block view instead. If so, you should leave the block footer blank.'),
  );

  $form['block-info']['block_footer_fieldset']['block_footer'] = array(
    '#type' => 'textarea',
    '#title' => t('Footer'),
    '#default_value' => $view->block_footer,
    '#cols' => 60,
    '#rows' => 6,
    '#description' => t('Text to display at the bottom of the view. May contain an explanation or links or whatever you like. Optional.'),
  );

  $form['block-info']['block_footer_fieldset']['block_footer_format'] = filter_form($view->block_footer_format, 1, array( 'block_footer_format'));

  $form['block-info']['block_empty_fieldset'] = array(
    '#type' => 'fieldset',
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#title' => t('Empty text'),
  );
  $form['block-info']['block_empty_fieldset']['block_use_page_empty'] = array(
    '#type' => 'checkbox',
    '#title' => t('Use Page empty'),
    '#return_value' => 1,
    '#default_value' => $view->block_use_page_empty,
    '#description' => t('If checked, use the Page Empty Text for block view instead. If so, you should leave the block empty text blank.'),
  );

  $form['block-info']['block_empty_fieldset']['block_empty'] = array(
    '#type' => 'textarea',
    '#title' => t('Empty text'),
    '#default_value' => $view->block_empty,
    '#cols' => 60,
    '#rows' => 6,
    '#description' => t('Text to display if a view results in no nodes. Optional.'),
  );

  $form['block-info']['block_empty_fieldset']['block_empty_format'] = filter_form($view->block_empty_format, 1, array( 'block_empty_format'));
  
  
  // arguments
  $form['argument-info'] = array(
    '#type' => 'fieldset',
    '#title' => t('View arguments'),
    '#collapsed' => !($view->argument_from_get || $view->argument_from_post),
    '#collapsible' => true,
  );
  
  $form['argument-info']['argument_list'] = array(
    '#type' => 'textfield',
    '#title' => t('Argument list'),
    '#size' => 70,
    '#default_value' => $view->argument_list,
    '#description' => t("Type the names of any arguments you want to use in your view here, separated by commas, spaces, or semicolons.  For example: start_date, meeting_type"),
  );
  
  $form['argument-info']['argument_from_get'] = array(
    '#type' => 'checkbox',
    '#title' => t('Accept arguments from GET parameters'),
    '#default_value' => $view->argument_from_get,
    '#description' => t('If this is checked, then when visiting the view page any arguments above put on the end of the url will become curly bracket codes in the list.  For example, http://www.example.com/upcoming_meetings&start_date=2007-10-10&meeting_type=webinar would make {start_date} equal to 2007-10-10 and {meeting_type} equal to webinar in the view body below.'),
  );
  
  $form['argument-info']['argument_from_post'] = array(
    '#type' => 'checkbox',
    '#title' => t('Accept arguments from POST parameters'),
    '#default_value' => $view->argument_from_post,
    '#description' => t('If this is checked, then any html forms that use the view page url as the action parameter will pass along the values to the list, much like the arguments from GET parameters option above.'),
  );
  
  
  // netFORUM details
  $form['netforum-info'] = array(
    '#type' => 'fieldset',
    '#collapsible' => true,
    '#title' => t('netFORUM Details'),
  );
  
  $form['netforum-info']['obj_type_name'] = array(
    '#type' => 'textfield',
    '#title' => t('Object Name'),
    '#size' => 50,
    '#autocomplete_path' => 'admin/content/netforum-object-autocomplete',
    '#description' => t("The name of the netFORUM object to list."),
  );
  
  $form['netforum-info']['query_name'] = array(
    '#type' => 'textfield',
    '#title' => t('Query Name'),
    '#size' => 50,
    '#description' => t("To use a pre-built query from iWeb, paste or type the name of the query here.  You can also define a query below."),
  );
  
  $form['netforum-info']['custom-query'] = array(
    '#type' => 'fieldset',
    '#title' => t('Define a query'),
    '#collapsible' => true,
    '#collapsed' => true,
  );
  
  $form['netforum-info']['custom-query']['query_columns'] = array(
    '#type' => 'textfield',
    '#title' => t('Query Columns'),
    '#size' => 50,
    '#description' => t("The list of columns to use in your list, separated by commas."),
  );
  
  $form['netforum-info']['custom-query']['query_where'] = array(
    '#type' => 'textfield',
    '#title' => t('Query Where'),
    '#size' => 50,
    '#description' => t("The criteria of the list, like start date or name"),
  );
  
  $form['netforum-info']['custom-query']['query_orderby'] = array(
    '#type' => 'textfield',
    '#title' => t('Query Order By'),
    '#size' => 50,
    '#description' => t("The list of fields to order the results by"),
  );
  
  $form['netforum-info']['build_list'] = array(
    '#type' => 'button',
    '#value' => t('Build View Body'),
  );
  
  $form['netforum-info']['obj_field_help'] = array(
    '#type' => 'textfield',
    '#title' => t('Find object fields'),
    '#size' => 70,
    '#autocomplete_path' => 'admin/content/netforum-object-fields-autocomplete/',
    '#default_value' => '',
    '#description' => t("Type the first few letters of what you're looking for to find the code."),
  );
  
  $form['netforum-info']['view_body'] = array(
    '#type' => 'textarea',
    '#title' => t('netFORUM view body'),
    '#cols' => 60,
    '#rows' => 15,
    '#default_value' => $view->view_body,
    '#description' => t('Use this area to define the content of the view.  Most likely it should contain a {BeginList} and {EndList}.  [!help]', array('!help' => l(t('help'), 'admin/help/netforum_views'))),
  );
  
  $form['netforum-info']['view_body_format'] = filter_form($view->view_body_format, 1, array('view_body_format'));
  
  
  if ($op == t('Build View Body') && netforum_views_valid_build_request($view) ) {
    $form['netforum-info']['view_body']['#value'] = netforum_views_build_list($view);
    $form['netforum-info']['custom-query']['#collapsed'] = false;
  }

  $form['save'] = array(
    '#type' => 'submit',
    '#value' => t('Save'),
  );
  if ($view->vid) {
    $form['delete'] = array(
      '#type' => 'submit',
      '#value' => t('Delete'),
    );
  }
  $form['cancel'] = array(
    '#type' => 'submit',
    '#value' => t('Cancel'),
  );

  return $form;
}

/**
 * separately build a piece of the form
 */
function netforum_views_build_form(&$form) { //TODO:  Delete this?
  // NOT REALLY SURE WHY THIS SORT OF WORKS. IT'S MAGIC THAT CHX POINTED ME TO
  // IN THE POLL MODULE.
  $form['#post'] = $_POST;
  $form = form_builder('netforum_views_edit_view', $form);
}


/**
 * Display the form built by _views_view_form()
 */
function theme_netforum_views_edit_view($form) {

  $output .= drupal_render($form['basic-info'], false);
  $output .= drupal_render($form['page-info'], false);
  $output .= drupal_render($form['block-info'], false);

  $allbut = $form['allbut']['#value'];

  // drupal_render wants a reference so use full array notation.

  // fields
  $collapsed = $allbut && $allbut != 'field';

  $output .= drupal_render($form, false);
  return $output;
}

/**
 * Validate that a view sent via form is OK.
 */
function netforum_views_edit_view_validate($form_id, $view, $form) {
  $op = $view['op'];

  if ($op != t('Save')) {
    return; // only validate on saving!
  }

  if ($view['vid']) {
    $changed = db_result(db_query("SELECT changed FROM {netforum_view} WHERE vid = %d", $view['vid']));
    if ($changed && $view['changed'] != $changed) {
      form_set_error('', t('Another user has modified this view, unable to save. You can get this error by using the Back button to re-edit a view after saving one; if you do this, be sure to Reload before making any changes!'));
      return;
    }
  }

  if (!$view['name']) {
    form_error($form['basic-info']['name'], t('View name is required.'));
  }

  // view name must be alphanumeric or underscores, no other punctuation.
  if (preg_match('/[^a-zA-Z0-9_]/', $view['name'])) {
    form_error($form['basic-info']['name'], t('View name must be alphanumeric or underscores only.'));
  }

  // test uniqueness of name
  $vid = db_result(db_query("SELECT vid FROM {netforum_view} WHERE name='%s'", $view['name']));
  if ($vid && $vid != $view['vid']) {
    form_error($form['basic-info']['name'], t('View name already in use.'));
  }

}

/**
 * Handle submit buttons on a view form.
 */
function netforum_views_edit_view_submit($form_id, $form) {
  $view = (object) $form;
  
  // Transform any data that requires it here.
  $view->access = array_keys(array_filter($view->access));

  // ensure for MYSQL 5 irritation reasons.
  $view->menu_tab_weight = intval($view->menu_tab_weight);

  $view_is_new = !$view->vid;

  $vid = _netforum_views_save_view($view);
  menu_rebuild();

  if ($form['vid']) {
    drupal_set_message(t('netFORUM view successfully saved.'));
  }
  else {
    drupal_set_message(t('netFORUM view successfully added.'));
  }

  if ($form['op'] == t('Save')) {
    $args = explode('/', $_GET['q']);
    if ($args[0] == 'admin' && $args[1] == 'build' && $args [2] == 'netforum_views') {
      return 'admin/build/netforum_views';
    }
    array_pop($args);
    return implode('/', $args);
  }
}

/*
 * Create a list of roles.
 */
function netforum_views_handler_filter_role() {
  $rids = array();
  $result = db_query("SELECT r.rid, r.name FROM {role} r ORDER BY r.name");
  while ($obj = db_fetch_object($result)) {
    $rids[$obj->rid] = $obj->name;
  }
  return $rids;
}

/**
 * Save a view to the database.
 */
