modules/wishlist/wishlist.module

<?php
/* $Id: wishlist.module,v 1.44 2008/01/26 23:01:53 smclewin Exp $ */
// Wishlist management module for Drupal
// Written by Scott McLewin and Melanie Paul-McLewin
// drupal AT mclewin DOT com


/** PHP4 compatibliibility **/
if (!function_exists("stripos")) {
  function stripos($str,$needle) {
   return strpos(strtolower($str),strtolower($needle));
  }
}

/**
 * Hook to return permission supported by this module
 *
 * @return
 *   create wishlists  - authority to do "create content -> wishlist"
 *   edit own wishlist - authority to edit your own wishlist
 *   admin wishlist    - authority to administer the wishlist module
 *   access wishlists  - rights to view, purchase and return items on wishlists
 */
function wishlist_perm() {
  return array ("create wishlists", "edit own wishlist", "admin wishlist", "access wishlists", 'reveal purchase status');
}

 
/**
 * load hook to bring in the wishlist specific node fields
 *
 * @param $node
 *   Core node record entries
 * @return
 *   A wishlist object, which will be combined with $node
 */
function wishlist_load($node) {
   $wishlist = db_fetch_object(db_query('SELECT * FROM {wishlist} WHERE nid = %d', $node->nid));
  
   $wishlist->item_quantity_purchased = _wishlist_get_node_quantity_purchased($node->nid);
   
   return $wishlist;
}
 

/**
 * node_name hook to return this module's name for nodes it creates
 *
 * @return
 *   Name of the node type created by this module
 */
function wishlist_node_name() {
  return 'wishlist';
}
 

/**
 * node_info hook to return this module's name and description for wishlist nodes
 *
 * @return
 *   Name of the node type created by this module
 */
function wishlist_node_info() {
  return array(
        'wishlist' => 
             array(
                'name' => t('Wishlist'), 
                'module' => 'wishlist',
                'description' => t('A wishlist allows you maintain a collection
                                    of items you want for a special occasion, such as a holiday,
									birthday or just for the fun of it.  The wishlist is just a list, 
                                    to purchase items users will be directed to the appropriate source.')
             )
        );
}

/**
* @desc Register the wishlist module's theme functions
*/
function wishlist_theme() {
    return array(
        'wishlist_username' => array(
            'arguments' => array('uid' => null, 'defaultname' => null)
        ),
        'wishlist_node_url' => array(
            'arguments' => array('url' => null, 'node' => null)
        )
    );
}


/**
 * Help hook
 *
 * @param $section
 *   Which help URL has been requested
 * @return
 *   Help text to display
 */
function wishlist_help($path, $arg) {
  $output ="";
 
  switch ($path) {
     case 'admin/help#wishlist':
      break;
    case 'node/add#wishlist':
      $output = t("Add an item to one of your wishlist categories.");
      break;
  }
  return $output;
}
 
 
/**
 * Access hook for the wishlist module
 *
 * @param $op
 *   Operation the user is requesting
 * @param $node
 *   Node on which the user is requesting the operation
 * @return
 *   TRUE/FALSE based on checking permissions
 */
function wishlist_access($op, $node) {
  global $user;

  if ($op == 'create') {
    return user_access('create wishlists');
  }
 
  if ($op == 'update' || $op == 'delete' || $op == 'view') {
    if (user_access('edit own wishlist') && ($user->uid == $node->uid)) {
      return TRUE;
    }
  }
}
 

/**
 * Generates the optional links under the node display
 *
 * @param
 *   See hook_link documentation 
 * @return
 *   Array of structured links
 */
function wishlist_link($type, $node = 0, $main=0) {
  global $user;	
  $links = array();
 
  if ($type == 'node' && $node->type == 'wishlist') {
    // Don't display a redundant edit link if they are node administrators.
    if (wishlist_access('update', $node) && !user_access('administer nodes')) {
        $links['wishlist_edit_this_item'] = array(
        	'title' => t('Edit this wishlist item'),
        	'href' => "node/$node->nid/edit"
        );
    }

    // If the user has access rights to wishlists, then add links to handle purchases
    if (user_access('access wishlists') && !_wishlist_hide_purchase_info($node)) {
      // Only place the purchase link up if there are any items left
      if($node->item_quantity_purchased < $node->item_quantity_requested) {
         $links['wishlist_get_this_gift'] = array(
         	'title' => t('Get this gift'),
         	'href' => "wishlist/item/$node->nid/purchase"
         );
      }
    } else if(!$user->uid) {
      // If the user is not logged in, then give them the opportunity to do so.
  		$links['wishlist_login_or_register'] = array(
  			'title' => t('<a href="@login">Login</a> or <a href="@register">register</a> to purchase wishlist items', array('@login' => url('user/login'), '@register' => url('user/register'))),
  			'html' => TRUE
  		);
    }
  }
  return $links;
} 
 
 
function wishlist_cron() {
	$expire_days = variable_get('wishlist_item_expire_days', 30);
	// If the automatic expiration feature is disabled, return.
	if($expire_days == 0) {
		return;
	}
	
	// Calculate the time before which we will go looking for items that are fully purchased.
	$time = time() - ($expire_days*24*60*60);

	watchdog('wishlist', "Removing items purchased before @dt", array('@dt' =>format_date($time)));
	
	// Pull back all of the items that have been fully purchased where the last
	// transaction was over 'wishlist_item_expire_days' ago and is public.  Move
	// these to the user's private list.  Do this in batches of 100.
	// For wishlist installations that pre-date the addition of the purch_date field, the bought items
	// will be moved into the user's private list reguardless of when the last purchase was.
	$sql = "SELECT p.*, MAX(p.purch_date) as compare_date, SUM(p.wishlist_purch_quantity) as purchased, n.title, n.nid, w.item_is_public, w.item_quantity_requested FROM {wishlist_purchased} p 
 			INNER JOIN {node} n ON n.nid = p.wishlist_purch_nid
			INNER JOIN {wishlist} w ON n.nid = w.nid
 			WHERE w.item_is_public = 1
			AND p.purch_date != 0
			GROUP BY n.nid 
			HAVING purchased >= w.item_quantity_requested
            AND compare_date < %d
			ORDER BY compare_date LIMIT 100";
	$result = db_query($sql, $time);

	while($row = db_fetch_object($result)) {
		watchdog('wishlist', 'Hiding purchased item @title.  It now appears only on the users private list.', array('@title' => $row->title.' '));
  		db_query("UPDATE {node} SET status=0 WHERE nid=%d", $row->nid);
  		db_query('UPDATE {wishlist} SET item_is_public=0 WHERE nid=%d', $row->nid);
	}
}
 
/**
 * Wishlist node specific form edit/entry generation through hook_form.
 *
 * @param $node
 *   See hook_form on http://www.drupaldocs.org for parameter details
 * @return
 *   See hook_form on http://www.drupaldocs.org for return value details
 */
function wishlist_form(&$node) {
   $output = '';

  $form['title'] = array(
    '#type' => 'textfield',
    '#title' => t('Title'),
    '#default_value' => $node->title,
    '#size' => 60,
    '#maxlength' => 128,
    '#description' => NULL,
    '#attributes' => NULL,
    '#required' => TRUE,
  );

  // In order to be able to attach taxonomy terms to this node, we need
  // to display the appropriate form elements.
  if (function_exists('taxonomy_node_form')) {
    $output .= implode('', taxonomy_node_form('wishlist', $node));
  }   
  
  // IF the item_priority field is set to 0 then assume this is a newly initialized
  // record and set reasonable defaults on other entries as well.
  if ($node->item_priority == 0) {
     $node->item_priority = 3;
     $node->item_is_public = TRUE;
  }
  
  if ($node->item_currency == "") {
     $node->item_currency = variable_get("wishlist_default_currency", "USD");
  }


  $form["item_is_public"] = array(
    '#type' => 'checkbox',
    '#title' => t("Public wish list item"),
    '#return_value' => TRUE,
    '#default_value' => $node->item_is_public,
    '#description' => t("Makes this item visible to anybody.  If you uncheck this only you will be able to view the entry and this node will be set to 'unpublished'."),
  );

  $form["body"] = array(
    '#type' => 'textarea',
    '#title' => t("Item Description"),
    '#default_value' => $node->body,
    '#cols' => 60,
    '#rows' => 18,
    '#description' => t("Give a brief description of the item that you are adding to your wishlist and/or note why you want it"),
  );

  // If the admin has hidden the currency field then add the currency to the 
  // title of the estimated cost field.
  if(false == variable_get("wishlist_show_currency", TRUE)) {
  	 $est_cost_currency = t(' (in @currency)', array('@currency' => $node->item_currency));
  } else {
  	 $est_cost_currency = '';
  }
  
  $form["item_est_cost"] = array(
    '#type' => 'textfield',
    '#title' => t("Estimated Cost").$est_cost_currency,
    '#default_value' => $node->item_est_cost,
    '#size' => 5,
    '#maxlength' => 5,
    '#description' => t("If you know about how much the item will cost, enter it here."),
  );
  
  if(variable_get("wishlist_show_currency", TRUE)) {
	  $form["item_currency"] = array(
	    '#type' => 'textfield',
	    '#title' => t("Currency"),
	    '#default_value' => $node->item_currency,
	    '#size' => 5,
	    '#maxlength' => 5,
	    '#description' => t("Enter the three character ISO currency code for the value in the Estimated Cost field. e.g. USD for US Dollars, THB for Thai Baht, etc"),
	  );
  } else {
  	  // If the currency value is not shown we still need to pass through
  	  // the default.  Do that through a hidden field.
	  $form["item_currency"] = array(
	    '#type' => 'hidden',
	    '#default_value' => $node->item_currency,
	    '#size' => 5,
	    '#maxlength' => 5,
	  );
  }
  $form["item_url1"] = array(
    '#type' => 'textfield',
    '#title' => t("Primary URL"),
    '#default_value' => $node->item_url1,
    '#size' => 60,
    '#maxlength' => 250,
    '#description' => t("Enter the URL from which the item can be purchased.  Use the form 'http://www.example.com'"),
  );

  $form["item_url2"] = array(
    '#type' => 'textfield',
    '#title' => t("Secondary URL"),
    '#default_value' => $node->item_url2,
    '#size' => 60,
    '#maxlength' => 250,
    '#description' => t("Optionally enter another URL from which the item can be purchased.  Use the form 'http://www.example.com'"),
  );

  $form["item_quantity_requested"] = array(
    '#type' => 'textfield',
    '#title' => t("Quantity Requested"),
    '#default_value' => $node->item_quantity_requested,
    '#size' => 5,
    '#maxlength' => 5,
    '#description' => t("Enter the number of this item that you would like if one is not enough"),
  );

  $options = _wishlist_get_item_priority_array();

  $form["item_priority"] = array(
    '#type' => 'select',
    '#title' => t("Priority"),
    '#default_value' => $node->item_priority,
    '#options' => $options,
    '#description' => t("Rate the importance of this item to help your friends and family select a gift"),
    '#extra' => FALSE,
  );

  return $form;
}
 
/**
 * Implementation of wishlist_validate().
 *
 * Our "quantity" field requires a number to be entered. This hook lets
 * us ensure that the user entered an appropriate value before we try
 * inserting anything into the database.
 *
 * Errors should be signaled with form_set_error().
 */
function wishlist_validate(&$node) {
	// We allow 0 as a quantity for placeholder wishlist items, such as pointers to a wishlist
	// on a shopping web site.
	if($node->item_quantity_requested == '') {
	  	form_set_error('item_quantity_requested', t('Please enter the quantity requested.'));
	} else if (!is_numeric($node->item_quantity_requested)) {
      form_set_error('item_quantity_requested', t('The requested quantity must be a number.'));
    } else if($node->item_quantity_requested < 0) {
    	form_set_error('item_quantity_requested', t('The requested quantitiy cannot be negative.'));
    }

 	if($node->item_est_cost == '') {
 		form_set_error('item_est_cost', t('You must enter a cost for this wishlist item'));
 	} else if (!is_numeric($node->item_est_cost)) {
      	form_set_error('item_est_cost', t('You must enter a numeric value for the cost.'));
    }
} 
 
 
/**
 * Implementation of wishlist_insert().
 *
 * As a new node is being inserted into the database, we need to do our own
 * database inserts.
 */
function wishlist_insert($node) {
  $node->item_url1 = _wishlist_correct_url($node->item_url1);
  $node->item_url2 = _wishlist_correct_url($node->item_url2);
  
  db_query("INSERT INTO {wishlist} (nid,         item_is_public,        item_est_cost,        item_url1,         item_url2,        item_quantity_requested,        item_priority,        item_currency) VALUES 
                                   (%d,          %d,                        %d,                   '%s',              '%s',             %d,                             %d,                   '%s')", 
				    $node->nid,  $node->item_is_public, $node->item_est_cost, $node->item_url1,  $node->item_url2, $node->item_quantity_requested, $node->item_priority[0], $node->item_currency);
				    
				    
  // If this item is not public, then unpublish it.  I personally think this is a little hack, 
  // but I was unable to work out how to prevent a node from loading if it is "private".  wishlist_load
  // cannot return a value that prevents the node from being brought in.  While the display logic in 
  // wishlist_view can be suppressed, that only gets rid of the wishlist specific display elements.
  // The item name and description, which are in the node table, are both displayed.
  // Before running this logic, test to see if the item_is_public member even exists.  If it does not,
  // then it means this call to hook_validate is taking place as the $node is being built for the first
  // time.  Don't go setting the status to unpublished in that case.
  if (!$node->item_is_public) {
  	db_query("UPDATE {node} SET status=0 WHERE nid=%d", $node->nid);
  }
				    
}
 
/**
 * Implementation of wishlist_update().
 *
 * As an existing node is being updated in the database, we need to do our own
 * database updates.
 */
function wishlist_update($node) {
  	$node->item_url1 = _wishlist_correct_url($node->item_url1);
  	$node->item_url2 = _wishlist_correct_url($node->item_url2);
	db_query("UPDATE {wishlist} SET item_is_public= %d, item_est_cost= '%s', item_url1= '%s', item_url2= '%s', item_quantity_requested= %d, item_currency='%s', item_priority=%d WHERE nid=%d", $node->item_is_public, $node->item_est_cost, $node->item_url1, $node->item_url2, $node->item_quantity_requested, $node->item_currency, $node->item_priority[0], $node->nid);
    // If this item is not public, then unpublish it.  I personally think this is a little hack, 
    // but I was unable to work out how to prevent a node from loading if it is "private".  wishlist_load
    // cannot return a value that prevents the node from being brought in.  While the display logic in 
    // wishlist_view can be suppressed, that only gets rid of the wishlist specific display elements.
    // The item name and description, which are in the node table, are both displayed.
    // Before running this logic, test to see if the item_is_public member even exists.  If it does not,
    // then it means this call to hook_validate is taking place as the $node is being built for the first
    // time.  Don't go setting the status to unpublished in that case.
    if (!$node->item_is_public) {
  	  db_query("UPDATE {node} SET status=0 WHERE nid=%d", $node->nid);
    }
}


/**
 * Implementation of wishlist_delete().
 *
 * When a node is deleted, we need to clean up related tables.
 */
function wishlist_delete($node) {
  db_query('DELETE FROM {wishlist_purchased} WHERE wishlist_purch_nid = %d', $node->nid);
  db_query('DELETE FROM {wishlist} WHERE nid = %d', $node->nid);
} 
 
 
/**
* @desc Hook_init implementation
* 
* Add the wishlist css file to the page.
*/
function wishlist_init() {
  drupal_add_css(drupal_get_path('module', 'wishlist') .'/wishlist.css');  
}
 
/**
 * hook_menu implementation
 *
 * @param 
 *   See hook_menu in http://www.drupaldocs.org for parameter details
 * @return
 *   See hook_menu in http://www.drupaldocs.org for return code details
 */
function wishlist_menu() {
    $items['admin/settings/wishlist'] = array(
        'title' => 'Wishlist settings',
        'description' => 'Configure the wishlist module\'s settings.',
        'page callback' => 'drupal_get_form',
        'page arguments' => array('wishlist_admin_settings'),
        'access arguments' => array('administer site configuration'),
        'type' => MENU_NORMAL_ITEM,
        'file' => 'wishlist.admin.inc'
    );
    $items['wishlist/%'] = array(
        'title' => 'Wish lists', 
        'page callback' => 'wishlist_page', 
        'access arguments' => array('access wishlists'),
        'type' => MENU_NORMAL_ITEM,
        'file' => 'wishlist.page.inc'
    );
    $items['wishlist'] = array(
        'title' => 'Wish lists', 
        'page callback' => 'wishlist_page', 
        'access arguments' => array('access wishlists'),
        'type' => MENU_NORMAL_ITEM,
        'file' => 'wishlist.page.inc'
    );
    $items['admin/content/wishlist'] = array(
        'title' => 'Wishlist purchases', 
        'page callback' => 'wishlist_admin_page', 
        'access arguments' => array('admin wishlist'), 
        'description' => 'Manage and view the wishlist purchase records for your site.',
        'type' => MENU_NORMAL_ITEM,
        'file' => 'wishlist.admin.inc'
    );
    $items['admin/content/wishlist/delete'] = array(
        'title' => 'Delete wishlist item', 
        'page callback' => '_wishlist_admin_delete_item', 
        'access arguments' => array('admin wishlist'),
        'type' => MENU_CALLBACK,
        'file' => 'wishlist.admin.inc'
    );
    return $items;
}

/**
* @desc use hook_menu_alter to put the proper permissions on the wishlist add menu
*/
function wishlist_menu_alter(&$callbacks) {
    $callbacks['node/add/wishlist']['access callback'] = 'user_access';
    $callbacks['node/add/wishlist']['access arguments'] = array('create wishlists');
}


/**
 * hook_block implementation
 *
 * @param 
 *   See hook_block in http://www.drupaldocs.org for parameter details
 * @return
 *   See hook_block in http://www.drupaldocs.org for return code details
 */
function wishlist_block($op = "list", $delta = 0) {
  if ($op == "list") {
    $blocks[0]["info"] = t("Wishlists");
    return $blocks;
  }
  elseif ($op == 'view') {
    $result = db_query_range(db_rewrite_sql("SELECT n.nid, n.title, n.uid, u.name FROM {node} n INNER JOIN {users} u ON n.uid = u.uid WHERE n.type='%s' GROUP BY u.uid ORDER BY u.name DESC"), 'wishlist', 0, variable_get("wishlist_block_max_names", "5"));
    
    $has_rows = false;
    while ($account = db_fetch_object($result)) {
        $items[] = format_wishlists($account);
        $has_rows = true;
    } 
    // If the site has no wishlists, then return an empty block
    if(false == $has_rows) {
        $block["subject"] = "";
        $block["content"] = "";
        return $block;
    }
    

    $block_content = theme('item_list', $items);
    
    // add a more link to our page that displays all the links
    $block_content .=
         "<div class='more-link'>".
         l(t("More"), "wishlist", array('attributes' => array("title" => t("View all wishlists."))))
         ."</div>";

    $block["subject"] = t("Wishlists");
    $block["content"] = $block_content;
    return $block;
  }
}
 
/**
 * Allows for a site to theme the username.  An example reason to do this 
 * would be to display the user's real name from a site specific profile system
 * rather than to use the name in the Drupal user record.  The output will be
 * truncated to 15 characters.  It should contain no markup.
 * 
 */
function theme_wishlist_username($uid, $defaultname) {
	return $defaultname;
}

/**
 * Formats the wishlist item title with (or without) appropriate links to the full record
 *
 * @param $object
 *   The wishlist node to format
 * @param $append_text
 *   Optional text to tack on the end of the user's name.
 * @return
 *   Formatted text ready for display
 */
function format_wishlists($object, $append_text="") {
  global $user;
  
  if ($object->uid && $object->name) {
    $fullname = theme('wishlist_username', $object->uid, $object->name);
  	
    // Shorten the name when it is too long or it will break many tables.
    if (drupal_strlen($fullname) > 20) {
      $name = truncate_utf8($fullname, 15) .'...';
    } else {
   	  $name = $fullname;
    }

    $output = l($name.$append_text, 'wishlist/'. $object->uid, array('title' => t('View wishlist items for ').check_plain($fullname)));
  }
  else if ($object->name) {
    // Sometimes modules display content composed by people who are
    // not registered members of the site (e.g. mailing list or news
    // aggregator modules). This clause enables modules to display
    // the true author of the content.
    if ($object->homepage) {
      $output = '<a href="'. $object->homepage .'">'. check_plain($object->name.$append_text).'</a>';
    }
    else {
      $output = check_plain($object->name.$append_text);
    }

    $output .= ' ('. t('not verified') .')';
  }
  else {
    $output = variable_get('anonymous', 'Anonymous');
  }
  
  // If the curent user is logged in, then also look for new items.
  if($user->uid && $object->uid) {
  	   $sql = "SELECT COUNT(n.nid) FROM {node} n 
               INNER JOIN {users} u ON n.uid = u.uid 
               LEFT JOIN {history} h ON n.nid = h.nid AND h.uid = %d 
               WHERE n.status = 1 
               AND u.uid = %d
               AND n.type = 'wishlist' 
               AND n.created > %d 
               AND h.nid IS NULL";
  	   $sql = db_rewrite_sql($sql);
  	   $new_count = db_result(db_query($sql, $user->uid, $object->uid, NODE_NEW_LIMIT));
  	   if($new_count > 0) {
  	   	  $output .= '<span class="new-wishlist-items">'.t('@count new', array('@count' => $new_count)).'</span>';
  	   }
  }
  return $output;
}
 

/**
 * hook_view implementation
 *
 * @param 
 *   See hook_view in http://www.drupaldocs.org for parameter details
 * @return
 *   See hook_view in http://www.drupaldocs.org for return code details
 */
function wishlist_view($node, $teaser = FALSE, $page = FALSE) {
  $node = node_prepare($node, $teaser);
	
  if($page) {
     $giftee_account = user_load(array('uid' => $node->uid));
     
     $breadcrumb[] = l(t('Home'), NULL);
     $breadcrumb[] = l(t('All wishlists'),  'wishlist');
     $breadcrumb[] = l(t("@name's wishlist", array('@name' => $giftee_account->name)), 'wishlist/'.$node->uid);
     drupal_set_breadcrumb($breadcrumb);
  }   

  $node->content['wishlist'] = array(
  	'#value' => _wishlist_render_view($node, $teaser),
  	'#weight' => 1
  );

  return $node;
}

/**
 * Builds the primary view of a wishlist item.
 *
 * @param 
 *   See hook_view in http://www.drupaldocs.org for parameter details
 * @return
 *   an output buffer ready to do further processing on (such as call theme('page', ...)
 */
function _wishlist_render_view($node, $teaser = FALSE) {
  global $user;
   
  $output = "<div class='wishlist'>";
  $output .= '<div class="wl_spacer">&nbsp;</div>';
  $output .= '<div class="main-body">';
  $output .= "<div class='item_est_cost'>".t("Estimated Cost")." "._wishlist_currency_str($node->item_currency).$node->item_est_cost."</div>";
  $output .= theme('wishlist_node_url', $node->item_url1, $node);
  $output .= theme('wishlist_node_url', $node->item_url2, $node);
  if(!$teaser) {
	  $output .= _wishlist_render_purchased_items($node); 
  }	  
  $output .= "<div class='changed'>".t("Last updated on")." ".format_date($node->changed, "small")."</div>";
  $output .= '</div>';
  $output .= '<div class="purchase-info">';
  $output .= _wishlist_get_reveal_form($node->uid);
  
  $priority_str = _wishlist_get_item_priority_array();
  // Depending on the context in which this is called the item priority value is either a value or an array of values
  $output .= "<div class='priority'>".$priority_str[is_array($node->item_priority) ? $node->item_priority[0] : $node->item_priority]."</div>";

  
  $output .= "<div class='requested'>".t("Requested")." ".$node->item_quantity_requested."</div>";
  if(_wishlist_hide_purchase_info($node)) {
  	$output .= "<div class='purchased'>".t("Purchase details hidden")."</div>";
  } else {
  	$output .= "<div class='purchased'>".t("Purchased")." ".$node->item_quantity_purchased."</div>";
  }	
 
  // Under a preview of a new node there is nothing to see and no nid value just yet.  Skip this code 
  if(!is_null($node->nid) && $node->nid > 0) {
     // Retrieve all of the records showing what the currently logged in user purchaed on this item.
     $result = db_query(db_rewrite_sql("SELECT p.wishlist_purch_wid, p.wishlist_purch_buyer_uid, p.wishlist_purch_quantity FROM {wishlist_purchased} p WHERE p.wishlist_purch_buyer_uid=%d AND p.wishlist_purch_nid=%d", "p", "wishlist_purch_buyer_nid"),$user->uid, $node->nid);

     $header = array(
         array('data' => t("Quantity<br>You<br>Purchased")),
         array('data' => t("Action"))
     );
    
     $rows = array();  // if there were no records, we don't want an undefined variable notification
     while($wishlist_purch = db_fetch_object($result)) {
         if ($wishlist_purch->wishlist_purch_quantity > 1) {
            $action_str = t("Return these items");
         } else {
            $action_str = t("Return this item");
         }
         $rows[] = array(
            array("data" => $wishlist_purch->wishlist_purch_quantity),
            array("data" => l($action_str, "wishlist/item/$node->nid/return/$wishlist_purch->wishlist_purch_wid"))
         );
  
     }
  
     if ($rows) {
        $output .= "<div class='wishlist_purchased'>".theme('table', $header, $rows)."</div>";
     }
  }
  // end the purchase-info div
  $output .= '</div>';
  $output .= '<div class="wl_spacer">&nbsp;</div>';
  // end the wishlist div
  $output .= '</div>';
  
  return $output;  
}

/**
 * Returns the HTML to display a table showing who purchased which gifts for the user, and when.
 * This is part of the node display.  It will only show for users who have 'admin wishlist' or 
 * 'reveal purchase status' permissions.
 *
 * @param node $node
 */
function _wishlist_render_purchased_items($node) {
	global $user;
	
	// Don't show this during a preview.
	if(!$node->nid) {
		return '';
	}
	
	// To view this region, the user must either have reveal purchase status 
	// or be an administrator.
	if(!user_access('admin wishlist') && !user_access('reveal purchase status')) {
		return '';
	}

	// If this is not your entry, then you cannot see the
	// purchase details UNLESS you are an admin.
	if($user->uid != $node->uid) {
		if(!user_access('admin wishlist')) {
			return '';
		}
	}	

	// If the site is configured to hide details from the list owner
	// then check to see if this user, the owner, has the right to reveal
	// and reveal mode is turned on.  If not, do not show this region.
	if(variable_get("wishlist_hide_purchase_info_own", FALSE) && ($user->uid == $node->uid)) {
	    if(user_access('reveal purchase status') && isset($_GET['wl_reveal']) && ($_GET['wl_reveal'] != 1)) {
			return '';
		}
	}
	
	$sql = "SELECT p.*, u.name FROM {wishlist_purchased} p 
            INNER JOIN {users} u ON u.uid = p.wishlist_purch_buyer_uid 
            WHERE p.wishlist_purch_nid = %d";
	$result = db_query($sql, $node->nid);

    $header = array(
         array('data' => t('Purchaser')),
         array('data' => t('On')),
         array('data' => t('Quantity'))
    );
	$rows = array();
	
	while($row = db_fetch_object($result)) {
		$rows[] = array(
			array('data' => check_plain($row->name)),
			array('data' => ($row->purch_date != 0) ? format_date($row->purch_date, 'custom', 'j M y') : t('unknown')),
			array('data' => $row->wishlist_purch_quantity)
		);
	}
	
	// If there is no purchaser record, return nothing to display
	if(empty($rows)) {
		return '';
	}
	
	$output = '<div class="who-purchased">';
	$output .= '<fieldset><legend>'.t('Gift purchase record').'</legend>'.theme('table', $header, $rows).'</fieldset>';
	$output .= '</div>';
	
	return $output;
}


/**
 * Returns a display string based on the currency code passed in.  If the code is not known, the output is set to the input.
 *
 * @param $currency
 *   A three character ISO currency code to translate into display text, if possible 
 *
 * @return
 *   A currency code to display on the page
 */
function _wishlist_currency_str($currency) {

   $output = $currency;
   
   switch(drupal_strtoupper($currency)) {
      case "USD":
         $output = "$";
	 break;
      case "HKD":
         $output = "HK$";
	 break;
      case "GBP":
         $output = "&pound;";
	 break;
      case "JPY":
         $output = "&#165;";
	 break;
      case "EUR":
         $output = "&euro;";
	 break;
   }

   return $output;
}

/**
 * Gets an associative array (suitable for form_select()) mapping item_priority values to text
 *
 * @return
 *   An associative array relating item_priority values to text strings.
 */
function _wishlist_get_item_priority_array() {
  // Values for the item_priority field
  $options = array(
     "1" => t("I really want this"),
     "2" => t("I'd love to have this"),
     "3" => t("Nice to have"),
     "4" => t("Thinking about it"),
     "5" => t("Don't get this for me")
  );
  return $options;
}


/**
 * Gets display text for the URL that truncates and removes the http:// protocol header
 *
 * @param $url
 *   The text of the URL string from which to strip away http://
 * @param $maxlength
 *   The maximum length for the return string.  If the string will exceen this length it will be trimmed and ... added to the end
 * @return
 *   A display ready URL fragment
 */
function _wishlist_url($url, $maxlength) {
   $url = str_replace("http://", "", drupal_strtolower(check_plain($url)));
   if (drupal_strlen($url) > $maxlength) {
      $url = truncate_utf8($url, $maxlength-3)."...";
   } 
   return $url;
}

/**
 * Returns the number of items purchased for the node $nid
 *
 * @param $nid
 *   The node to check for purchases against
 * @return
 *   A number - the count of items from that node which have already been purchased.
 */
function _wishlist_get_node_quantity_purchased($nid) {

   // Retrieve the count of the number of this item that have been purchased from the wishlist and
   // return the result
   $result = db_query(db_rewrite_sql("SELECT SUM(wishlist_purch_quantity) as quantity_purchased FROM {wishlist_purchased} WHERE wishlist_purch_nid = %d", "p", "wishlist_purch_nid"), $nid);
   $item_quantity_purchased = 0;
   if($purchased = db_fetch_object($result)) {
      if (!is_null($purchased->quantity_purchased)) {
         $item_quantity_purchased = $purchased->quantity_purchased;
      }
   } 
   
   return $item_quantity_purchased;
}


/**
 * Given a URL will check to make sure it contains http or https.
 * 
 * @param $url Inbound url to check
 * 
 * @return Corrected URL (or the original if no change needed)
 */
function _wishlist_correct_url($url) {
	// check the URL for http and add it if needed
	if ($url) {
		if((stripos($url, "http://") === false) && (stripos($url, "https://") === false)) {
			$url = 'http://'.$url;						
		}
	}
  
	return $url;
}

/**
 * Utility function to determine whether or not to hide information
 * about the purchase details of a wishlist item.
 * 
 * @param $node   The active/current wishlist node 
 */
function _wishlist_hide_purchase_info($node) {
	global $user;

	
	// On private items, we don't hide anything.  Only the user can see these anyway.
	if($node->item_is_public == FALSE && $user->uid == $node->uid) {
		return false;
	}
	
	// If this is an anonymous user see if we are configured to hide purchase information
	if(!$user->uid) {
		if(variable_get("wishlist_hide_purchase_info_anonymous", FALSE)) {
			return true;
		}
	}

	// if it is the user's own wishlist entry, and the site is configure to hide purchase details by 
	// default, then return true unless the user has chosen to reveal items.
	if($user->uid == $node->uid) {
		// If this user is authorized to reveal items, then check
		// for the wl_reveal GET parameter.  If it is non-zero, then
		// we won't hide the purchase details.
		if(user_access('reveal purchase status')) {
			if(isset($_GET['wl_reveal']) && ($_GET['wl_reveal'] != 0)) {
				return false;
			}
		}
		
		if(variable_get("wishlist_hide_purchase_info_own", FALSE)) {
			return true;
		}
	}
	
	return false;
}


/**
 * Theme function to display the links at the bottom of the node view.
 * 
 * @param $url   The URL to format
 * @param $node  The node being displayed
 */
function theme_wishlist_node_url($url, $node) {
	global $user;
	
	if($url == '') {
		return '';
	}
	
	$output = '<div class="item_url">';
	// If purchase info is hidden, or if all of the items were purchase (if there were any!), do not show
	// the full links to the item.
  	if((($node->item_quantity_requested != 0) && ($node->item_quantity_purchased >= $node->item_quantity_requested)) 
         || _wishlist_hide_purchase_info($node)) {
		$output .= _wishlist_url($url, 30);
    } else {
        if(variable_get("wishlist_url_in_new_window", FALSE)) {
           $url_link_target["target"] = "_wishlist_url_window";
        } 
    	$output .= t("See")." ".l(_wishlist_url($url, 50), $url, array('attributes' => array('target' => $url_link_target)));
    }
    
    if(_wishlist_hide_purchase_info($node)) {
    	// If the user is anonymous, then offer a login.  Otherwise we are here 
    	// because the user is attempting to view their own wishlist 
    	// and the site does not share status with them.
    	if(!$user->uid) {
 	    	$output .= ' - '.l(t("Login to see full link"), "user/login");
    	}	
    } else if (($node->item_quantity_purchased >= $node->item_quantity_requested) && $node->item_quantity_requested != 0) {
		$output .= ' - '.t('None left to purchase');
    }

	$output .= '</div>';
    
    return $output;
}

/**
 * Returns a form that will allow the user to reval-all on their lists.  This
 * form will only be shown when a user is viewing their own
 * list or items and when the site is configured to hide the purchased
 * status from them.
 */
function _wishlist_get_reveal_form($wishlist_uid) {
	global $user;

	// Only show the form when the list/item is for the current user
	if($user->uid != $wishlist_uid) {
		return '';
	}

	// If the site is not configured to hide the purchased status, then do
	// not bother with this form.
	if(!variable_get("wishlist_hide_purchase_info_own", FALSE)) {
		return '';
	}
	
	// And finally if the user is not authorized to reveal purchased
	// status, don't show this form.
	if(!user_access('reveal purchase status')) {
		return '';
	}

	
	$output = '<div class="reveal-form">';

	$output .= drupal_get_form('wishlist_reveal_form');
	
	$output .= '</div>';
	
	return $output;
}

/*
 * defines the form used to show the 'Show purchase details' menu option
 * 
 */
function wishlist_reveal_form() {
    $form['wishlist_reveal'] = array(
	  '#type' => 'select',
  	  '#name' => 'wishlist_reveal',
  	  '#title' => '',
  	  '#default_value' => (isset($_GET['wl_reveal']) ? $_GET['wl_reveal'] : 0),
  	  '#options' => array(0 => t('Hide purchase details'), 1 => t('Show purchase details')),
  	  '#description' => '',
  	  '#multiple' => $multiple = FALSE,
  	  '#required' => $required = FALSE,
  	  '#attributes' => array('onChange' => "top.location.href='/".$_GET['q']."?wl_reveal='+this.value"),
    );
	
    return $form;
}

/**
 * Implementation of hook_views_tables().
 * 
 * Initial views support contributed by draco2002 http://drupal.org/user/76079
 */
function wishlist_views_tables() {
  $tables['wishlist'] = array(
    'name' => 'wishlist',
    'join' => array(
      'left' => array(
        'table' => 'node',
        'field' => 'nid'
      ),
      'right' => array(
        'field' => 'nid'
      ),
    ),
    'fields' => array(
      'item_est_cost' => array(
        'name' => t('Wishlist: Est. Cost'),
        'sortable' => TRUE,
      ),
      'item_url1' => array(
        'name' => t('Wishlist: Item URL 1'),
        'sortable' => TRUE,
      ),
      'item_url2' => array(
        'name' => t('Wishlist: Item URL 2'),
        'sortable' => TRUE,
      ),
      'item_quantity_requested' => array(
        'name' => t('Wishlist: Quantity Requested'),
        'sortable' => TRUE,
      ),
      'item_currency' => array(
        'name' => t('Wishlist: Est. Cost Currency'),
        'sortable' => TRUE,
      ),
      'item_priority' => array(
        'name' => t('Wishlist: Display Priority'),
        'sortable' => TRUE,
      ),
    ),
   'filters' => array(
      'item_is_public' => array(
        'name' => t('Wishlist: Item Is Public'),
                'operator' => array('=' => t('Equals')),
        'list' => 'views_handler_operator_yesno',
        'list-type' => 'select',
        'help' => t('Filter items by public or private status'),
         ),
        ),        
    'sorts' => array(
      'item_priority' => array(
        'name' => t('Wishlist: Display Priority'),
        'help' => t('Sort by display priority'),
      ),
    ),
  );

  return $tables;
}


?>