Index: openacs-4/packages/ecommerce/tcl/ecommerce-money-computations-procs.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/ecommerce/tcl/ecommerce-money-computations-procs.tcl,v
diff -u -r1.5 -r1.6
--- openacs-4/packages/ecommerce/tcl/ecommerce-money-computations-procs.tcl	19 Mar 2002 00:34:25 -0000	1.5
+++ openacs-4/packages/ecommerce/tcl/ecommerce-money-computations-procs.tcl	26 May 2002 04:36:49 -0000	1.6
@@ -18,7 +18,13 @@
   @author ported by Jerry Asher (jerry@theashergroup.com)
 }
 
-ad_proc ec_lowest_price_and_price_name_for_an_item { product_id user_id {offer_code ""} } { returns the lowest price and price name for an item } {
+ad_proc ec_lowest_price_and_price_name_for_an_item { 
+    product_id
+    user_id
+    {offer_code ""} 
+} { 
+    Returns the lowest price and price name for an item
+} {
     set lowest_price 0
     set lowest_price_name ""
     set reg_price [db_string get_price "select price from ec_products where product_id=:product_id"]
@@ -73,19 +79,40 @@
 # I've included the product_id, order_id, and shipping_method in the arguments because they're
 # always already known in any environment where I intend to call this procedure, so I might as
 # well save two database hits.
-ad_proc ec_shipping_price_for_one_item {item_id product_id order_id shipping_method} { returns the shipping price for one item } {
-    # get shipping, shipping_additional, default_shipping_per_item, weight, weight_shipping_cost
-    # to determine regular shipping price
 
-    db_1row get_shipping_info "select shipping, shipping_additional, weight from ec_products where product_id=:product_id"
-    
-    db_1row get_default_shipping_info "select default_shipping_per_item, weight_shipping_cost from ec_admin_settings"
+ad_proc ec_shipping_price_for_one_item {
+    item_id 
+    product_id
+    order_id
+    shipping_method
+} { 
+    returns the shipping price for one item 
+} {
 
+    # Get shipping, shipping_additional, default_shipping_per_item,
+    # weight, weight_shipping_cost to determine regular shipping price
+
+    db_1row get_shipping_info "
+	select shipping, shipping_additional, weight 
+	from ec_products 
+	where product_id=:product_id"
     
-    # calculate regular shipping price
+    db_1row get_default_shipping_info "
+	select default_shipping_per_item, weight_shipping_cost 
+	from ec_admin_settings"
+    
+    # Calculate regular shipping price
+
     if { ![empty_string_p $shipping_additional] } {
-	# find out if this is the first instance of the product in this order, or a later instance
-	set first_instance [db_string get_first_item "select min(item_id) from ec_items where product_id=:product_id and order_id:order_id"]
+
+	# Find out if this is the first instance of the product in
+	# this order, or a later instance
+
+	set first_instance [db_string get_first_item "
+	    select min(item_id) 
+	    from ec_items 
+	    where product_id = :product_id 
+	    and order_id = :order_id"]
 	if { $item_id != $first_instance } {
 	    set reg_shipping $shipping_additional
 	} elseif { ![empty_string_p $shipping] } {
@@ -102,9 +129,13 @@
     }
 
     set total_shipping_cost $reg_shipping
-    # see if we have to add something for express shipping
+
+    # See if we have to add something for express shipping
+
     if { $shipping_method == "express" } {
-	db_1row get_exp_info "select add_exp_amount_per_item, add_exp_amount_by_weight from ec_admin_settings"
+	db_1row get_exp_info "
+	    select add_exp_amount_per_item, add_exp_amount_by_weight 
+	    from ec_admin_settings"
 
 	if { ![empty_string_p $add_exp_amount_per_item] } {
 	    set total_shipping_cost [expr $total_shipping_cost + $add_exp_amount_per_item]
@@ -116,37 +147,63 @@
     return $total_shipping_cost
 }
 
-# Returns price, price_name, shipping, price_tax, and shipping_tax (all in a list) for one item.
-# I will make user_class_id_list default_shipping_per_item, weight_shipping_cost,
-# add_exp_amount_per_item, add_exp_amount_by_weight, tax_rate, and shipping_p arguments
-# because they are constant, so I don't want to have to pull them from the database each
-# time (this procedure is called from within a loop)
-# For preconfirmed orders.
-ad_proc ec_price_price_name_shipping_price_tax_shipping_tax_for_one_item { product_id offer_code item_id order_id {user_class_id_list {}} {shipping_method "no shipping"} {default_shipping_per_item 0} {weight_shipping_cost 0} {add_exp_amount_per_item 0} {add_exp_amount_by_weight 0} {tax_rate 0} {shipping_p "f"}} { Returns price, price_name, shipping, price_tax, and shipping_tax (all in a list) for one item. } {
+ad_proc ec_price_price_name_shipping_price_tax_shipping_tax_for_one_item { 
+    product_id
+    offer_code 
+    item_id
+    order_id
+    {user_class_id_list {}} 
+    {shipping_method "no shipping"} 
+    {default_shipping_per_item 0}
+    {weight_shipping_cost 0}
+    {add_exp_amount_per_item 0}
+    {add_exp_amount_by_weight 0}
+    {tax_rate 0}
+    {shipping_p "f"}
+} { 
+    Returns price, price_name, shipping, price_tax, and shipping_tax
+    (all in a list) for one item. 
 
+    Made user_class_id_list default_shipping_per_item,
+    weight_shipping_cost, add_exp_amount_per_item,
+    add_exp_amount_by_weight, tax_rate, and shipping_p arguments
+    because they are constant, so they don't have to be pulled them
+    from the database each time (this procedure is called from
+    within a loop)
+
+    For preconfirmed orders.
+} {
+
     ##
     ## Part 1: Get Price & Price Name
     ##
 
     set lowest_price 0
     set lowest_price_name "none"
-    set reg_price [db_string get_item_price "select price from ec_products where product_id=:product_id"]
+    set reg_price [db_string get_item_price "
+	select price 
+	from ec_products
+	where product_id = :product_id"]
     if { ![empty_string_p $reg_price] } {
 	set lowest_price $reg_price
 	set lowest_price_name "Our Price"
     }
+
     if { [llength $user_class_id_list] > 0 } {
-	db_foreach get_price_and_name "select p.price, c.user_class_name
-	from ec_product_user_class_prices p, ec_user_classes c
-	where p.product_id=:product_id
-	and p.user_class_id=c.user_class_id
-	and p.user_class_id in ([join $user_class_id_list ", "])" {
+	db_foreach get_price_and_name "
+	    select p.price, c.user_class_name
+	    from ec_product_user_class_prices p, ec_user_classes c
+	    where p.product_id=:product_id
+	    and p.user_class_id=c.user_class_id
+	    and p.user_class_id in ([join $user_class_id_list ", "])" {
 	
-
 	    if { ![empty_string_p $price] && $price < $lowest_price } {
 		set lowest_price $price
-	    # only include the user_class_name in the name of the price if
-	    # the user is allowed to see what user classes they're in
+
+		# Only include the user_class_name in the name of the
+		# price if the user is allowed to see what user
+		# classes they're in
+
 		if { [ad_parameter -package_id [ec_id] UserClassUserViewP ecommerce] == 1 } {
 		    set lowest_price_name "$user_class_name Price"
 		} else {
@@ -161,12 +218,11 @@
     } else {
 	set or_part_of_query ""
     }
-    db_foreach get_sale_prices "select sale_price, sale_name
-    from ec_sale_prices_current
-    where product_id=:product_id
-    and (offer_code is null $or_part_of_query)
-    " {
-    
+    db_foreach get_sale_prices "
+	select sale_price, sale_name
+	from ec_sale_prices_current
+	where product_id=:product_id
+	and (offer_code is null $or_part_of_query)" {
 	
 	if { ![empty_string_p $sale_price] && $sale_price < $lowest_price } {
 	    set lowest_price $sale_price
@@ -175,20 +231,33 @@
     }
 
     # To return:
+
     set price_to_return $lowest_price
     set price_name_to_return $lowest_price_name
 
     ##
     ## Part 2: Determine Shipping Cost
     ##
 
-   db_1row get_shipping_costs "select shipping, shipping_additional, weight from ec_products where product_id=:product_id"
-
+    db_1row get_shipping_costs "
+	select case when no_shipping_avail_p = 'f' then shipping else null end as shipping, 
+	    case when no_shipping_avail_p = 'f' then shipping_additional else null end as shipping_additional, 
+	    case when no_shipping_avail_p = 'f' then weight else null end as weight
+	from ec_products 
+	where product_id = :product_id"
     
-    # calculate regular shipping price
+    # Calculate regular shipping price
+
     if { ![empty_string_p $shipping_additional] } {
-	# find out if this is the first instance of the product in this order, or a later instance
-	set first_instance [db_string get_first_instance "select min(item_id) from ec_items where product_id=:product_id and order_id=:order_id"]
+
+	# Find out if this is the first instance of the product in
+	# this order, or a later instance
+
+	set first_instance [db_string get_first_instance "
+	    select min(item_id) 
+	    from ec_items
+	    where product_id = :product_id
+	    and order_id = :order_id"]
 	if { $item_id != $first_instance } {
 	    set reg_shipping $shipping_additional
 	} elseif { ![empty_string_p $shipping] } {
@@ -205,7 +274,9 @@
     }
 
     set total_shipping_cost $reg_shipping
-    # see if we have to add something for express shipping
+
+    # See if we have to add something for express shipping
+
     if { $shipping_method == "express" } {
 	if { ![empty_string_p $add_exp_amount_per_item] } {
 	    set total_shipping_cost [expr $total_shipping_cost + $add_exp_amount_per_item]
@@ -216,6 +287,7 @@
     }
     
     # To return:
+
     set shipping_to_return $total_shipping_cost
 
     ##
@@ -227,47 +299,58 @@
 	set shipping_tax_to_return 0
     } else { 
 	set price_tax_to_return [expr $price_to_return * $tax_rate]
-    
 	if { $shipping_p == "f" } {
 	    set shipping_tax_to_return 0
 	} else {
 	    set shipping_tax_to_return [expr $shipping_to_return * $tax_rate]
 	}
     }
-
     return [list $price_to_return $price_name_to_return $shipping_to_return $price_tax_to_return $shipping_tax_to_return]
-
 }
 
-# returns a list containing the total price, total shipping, gift_certificate amount
-# and total tax for an order
-# this assumes all prices and shipping and tax charges are filled in for the order
-# and items
-# gift_certificate amount is: taken from database for confirmed orders, or calculated
-#                             for not yet confirmed orders
-# Note: the price it shows is really price charged minus price refunded, similarly
-# for shipping and tax.
-ad_proc ec_price_shipping_gift_certificate_and_tax_in_an_order { order_id } { returns a list containing the total price, total shipping, gift_certificate amount and total tax for an order } {
+ad_proc ec_price_shipping_gift_certificate_and_tax_in_an_order { 
+    order_id 
+} { 
 
-    db_1row get_confirmed_info {
+    Returns a list containing the total price, total shipping,
+    gift_certificate amount and total tax for an order.  This
+    assumes all prices and shipping and tax charges are filled in
+    for the order and items.
+
+    gift_certificate amount is taken from database for confirmed
+    orders, or calculated for not yet confirmed orders.
+
+    Note: the price it shows is really price charged minus price
+    refunded, similarly for shipping and tax.
+
+} {
+
+    db_1row get_confirmed_info "
 	select confirmed_date, user_id,
-	       ec_total_price(:order_id) as total_price,
-	       ec_total_shipping(:order_id) as total_shipping,
-	       ec_total_tax(:order_id) as total_tax
+	    ec_total_price(:order_id) as total_price,
+	    ec_total_shipping(:order_id) as total_shipping,
+	    ec_total_tax(:order_id) as total_tax
 	from ec_orders
-	where order_id = :order_id
-    }
+	where order_id = :order_id"
 
-    # if order has been confirmed, use the gift certificate amount actually used
-    # otherwise determine what it will be using ec_gift_certificate_balance($user_id)
+    # If order has been confirmed, use the gift certificate amount
+    # actually used otherwise determine what it will be using
+    # ec_gift_certificate_balance($user_id)
 
     if { [empty_string_p $confirmed_date] } {
-	set gift_certificate_balance [db_string get_ec_gc_bal "select ec_gift_certificate_balance(:user_id) from dual"]
+	set gift_certificate_balance [db_string get_ec_gc_bal "
+	    select ec_gift_certificate_balance(:user_id) 
+            from dual"]
 	set gift_certificate_amount [ec_min [expr $total_price + $total_shipping + $total_tax] $gift_certificate_balance]
     } else {
-	# the gift certificate amount is always up-to-date (includes reinstatements)
-	set gift_certificate_amount [db_string get_gc_amount "select ec_order_gift_cert_amount(:order_id) from dual"]
+
+	# The gift certificate amount is always up-to-date (includes
+	# reinstatements)
+
+	set gift_certificate_amount [db_string get_gc_amount "
+	    select ec_order_gift_cert_amount(:order_id) 
+            from dual"]
     }
 
     return [list $total_price $total_shipping $gift_certificate_amount $total_tax]
-}
\ No newline at end of file
+}