osCommerce Online Merchant v2.2 RC2 Upgrade Notes

The following upgrade guide is based on the osCommerce 2.2 Release Candidate 1 release. If you have not yet updated to this release please review its upgrade guide in the extras directory (upgrade-22rc1.html) before applying these changes.

The following changes should be performed in order to upgrade an existing osCommerce Online Merchant v2.2 RC1 store to v2.2 RC2.

Legend: [SQL] Database Changes; [A] Administration Tool; [C] Catalog

[SQL] Database changes
[A] Allow Administration Tool elements to be dynamically controlled
[C] Update download delivery routine
[C] Remove redundant currencies
[C] Update the navigation history class
[C] Update the order totals class
[C] Checkout procedure update
[C] Update product notifications
[AC] Improve register_globals compatibility layer
[AC] Introduce public orders and downloads status flags
[C] Update the free shipping method title
[C] Update credit card error messages
[A] Update File Manager
[A] Update the table block class
[A] MySQL 5.0 Strict Mode compatibility updates
[A] Update http_build_query() compatibility function
[A] Update Newsletter Manager
[AC] Update database session storage handler
[A] Update administration of categories
[C] Update processing of Address Book entries
[A] Update administration of product attributes
[A] Protect includes directory from direct HTTP requests
[A] Display module version if available
[A] Update database backup and restoration
[C] Update new products module

[SQL] Database changes

Add indexes to increase performance
Add public and download status flag fields to the orders_status table
Increase payment_method field size on the orders table
Increase the last_page_url field size on the whos_online table

[A] Allow Administration Tool elements to be dynamically controlled

Add toggleDivBlock() Javascript function to admin/includes/general.js to allow elements on the Administration Tool to be dynamically controlled.

Affected Files
catalog/admin/includes/general.js

File: catalog/admin/includes/general.js (online) (raw)

[C] Update download delivery routine

Fix downloads when "Download by redirect" and "SEFU" are both enabled.
Fallback to readfile() download delivery mechanism if direct download files.

Affected Files
catalog/download.php

File: catalog/download.php (online) (raw)

[C] Remove redundant currencies

Remove the secondary ex-euro currencies from display.

Affected Files
catalog/includes/classes/currencies.php

File: catalog/includes/classes/currencies.php (online) (raw)

[C] Update navigation history class

Make sure $parameters is an array in the navigation history class.

Affected Files
catalog/includes/classes/navigation_history.php

File: catalog/includes/classes/navigation_history.php (online) (raw)

[C] Update order totals class

Calling $order_total_modules->process() multiple times would duplicate the output data due to the modules already being instantiated.

Affected Files
catalog/includes/classes/order_total.php

File: catalog/includes/classes/order_total.php (online) (raw)

Checkout procedure update

Introduce the ability to show additional checkout buttons on the shopping cart page for certain payment methods (eg, PayPal Express Checkout).
Introduce the ability to define foreign shipping and billing addresses during the checkout procedure (eg, the shipping address provided by PayPal Express Checkout).
Move the logic of storing the credit card number in the database from the order class to the payment module level.
Add extra checks to the checkout process file.
Don't query for a shipping address if the order only contains virtual products.
Update the shipping address when a mixed (virtual+physical) order is being made.

Affected Files
catalog/checkout_payment.php
catalog/checkout_process.php
catalog/checkout_shipping.php
catalog/shopping_cart.php
catalog/includes/header.php
catalog/includes/classes/order.php
catalog/includes/classes/payment.php
catalog/includes/functions/general.php
catalog/includes/modules/payment/cc.php
catalog/includes/languages/english/shopping_cart.php
catalog/includes/languages/espanol/shopping_cart.php
catalog/includes/languages/german/shopping_cart.php

File: catalog/checkout_payment.php (online) (raw)
File: catalog/checkout_process.php (online) (raw)
File: catalog/checkout_shipping.php (online) (raw)
File: catalog/shopping_cart.php (online) (raw)
File: catalog/includes/header.php (online) (raw)
File: catalog/includes/classes/order.php (online) (raw)

31	31		function rowOutEffect(object) {
32	32		if (object.className == 'dataTableRowOver') object.className = 'dataTableRow';
33	33		}
	34	+
	35	+	function toggleDivBlock(id) {
	36	+	if (document.getElementById) {
	37	+	itm = document.getElementById(id);
	38	+	} else if (document.all){
	39	+	itm = document.all[id];
	40	+	} else if (document.layers){
	41	+	itm = document.layers[id];
	42	+	}
	43	+
	44	+	if (itm) {
	45	+	if (itm.style.display != "none") {
	46	+	itm.style.display = "none";
	47	+	} else {
	48	+	itm.style.display = "block";
	49	+	}
	50	+	}
	51	+	}

90	90		umask(0000);
91	91		mkdir(DIR_FS_DOWNLOAD_PUBLIC . $tempdir, 0777);
92	92		symlink(DIR_FS_DOWNLOAD . $downloads['orders_products_filename'], DIR_FS_DOWNLOAD_PUBLIC . $tempdir . '/' . $downloads['orders_products_filename']);
93		-	tep_redirect(DIR_WS_DOWNLOAD_PUBLIC . $tempdir . '/' . $downloads['orders_products_filename']);
94		-	} else {
95		-	// This will work on all systems, but will need considerable resources
96		-	// We could also loop with fread($fp, 4096) to save memory
97		-	readfile(DIR_FS_DOWNLOAD . $downloads['orders_products_filename']);
	93	+	if (file_exists(DIR_FS_DOWNLOAD_PUBLIC . $tempdir . '/' . $downloads['orders_products_filename'])) {
	94	+	tep_redirect(tep_href_link(DIR_WS_DOWNLOAD_PUBLIC . $tempdir . '/' . $downloads['orders_products_filename']));
	95	+	}
98	96		}
	97	+
	98	+	// Fallback to readfile() delivery method. This will work on all systems, but will need considerable resources
	99	+	readfile(DIR_FS_DOWNLOAD . $downloads['orders_products_filename']);
99	100		?>

40	40		if ($calculate_currency_value == true) {
41	41		$rate = (tep_not_null($currency_value)) ? $currency_value : $this->currencies[$currency_type]['value'];
42	42		$format_string = $this->currencies[$currency_type]['symbol_left'] . number_format(tep_round($number * $rate, $this->currencies[$currency_type]['decimal_places']), $this->currencies[$currency_type]['decimal_places'], $this->currencies[$currency_type]['decimal_point'], $this->currencies[$currency_type]['thousands_point']) . $this->currencies[$currency_type]['symbol_right'];
43		-	// if the selected currency is in the european euro-conversion and the default currency is euro,
44		-	// the currency will displayed in the national currency and euro currency
45		-	if ( (DEFAULT_CURRENCY == 'EUR') && ($currency_type == 'DEM' \|\| $currency_type == 'BEF' \|\| $currency_type == 'LUF' \|\| $currency_type == 'ESP' \|\| $currency_type == 'FRF' \|\| $currency_type == 'IEP' \|\| $currency_type == 'ITL' \|\| $currency_type == 'NLG' \|\| $currency_type == 'ATS' \|\| $currency_type == 'PTE' \|\| $currency_type == 'FIM' \|\| $currency_type == 'GRD') ) {
46		-	$format_string .= ' <small>[' . $this->format($number, true, 'EUR') . ']</small>';
47		-	}
48	43		} else {
49	44		$format_string = $this->currencies[$currency_type]['symbol_left'] . number_format(tep_round($number, $this->currencies[$currency_type]['decimal_places']), $this->currencies[$currency_type]['decimal_places'], $this->currencies[$currency_type]['decimal_point'], $this->currencies[$currency_type]['thousands_point']) . $this->currencies[$currency_type]['symbol_right'];
50	45		}

127	127		function filter_parameters($parameters) {
128	128		$clean = array();
129	129
130		-	reset($parameters);
131		-	while (list($key, $value) = each($parameters)) {
132		-	if (strpos($key, '_nh-dns') < 1) {
133		-	$clean[$key] = $value;
	130	+	if (is_array($parameters)) {
	131	+	reset($parameters);
	132	+	while (list($key, $value) = each($parameters)) {
	133	+	if (strpos($key, '_nh-dns') < 1) {
	134	+	$clean[$key] = $value;
	135	+	}
134	136		}
135	137		}
136	138

38	38		while (list(, $value) = each($this->modules)) {
39	39		$class = substr($value, 0, strrpos($value, '.'));
40	40		if ($GLOBALS[$class]->enabled) {
	41	+	$GLOBALS[$class]->output = array();
41	42		$GLOBALS[$class]->process();
42	43
43	44		for ($i=0, $n=sizeof($GLOBALS[$class]->output); $i<$n; $i++) {

52	52		$billto = $customer_default_address_id;
53	53		} else {
54	54		// verify the selected billing address
55		-	$check_address_query = tep_db_query("select count(*) as total from " . TABLE_ADDRESS_BOOK . " where customers_id = '" . (int)$customer_id . "' and address_book_id = '" . (int)$billto . "'");
56		-	$check_address = tep_db_fetch_array($check_address_query);
	55	+	if ( (is_array($billto) && empty($billto)) \|\| is_numeric($billto) ) {
	56	+	$check_address_query = tep_db_query("select count(*) as total from " . TABLE_ADDRESS_BOOK . " where customers_id = '" . (int)$customer_id . "' and address_book_id = '" . (int)$billto . "'");
	57	+	$check_address = tep_db_fetch_array($check_address_query);
57	58
58		-	if ($check_address['total'] != '1') {
59		-	$billto = $customer_default_address_id;
60		-	if (tep_session_is_registered('payment')) tep_session_unregister('payment');
	59	+	if ($check_address['total'] != '1') {
	60	+	$billto = $customer_default_address_id;
	61	+	if (tep_session_is_registered('payment')) tep_session_unregister('payment');
	62	+	}
61	63		}
62	64		}
63	65

17	17		$navigation->set_snapshot(array('mode' => 'SSL', 'page' => FILENAME_CHECKOUT_PAYMENT));
18	18		tep_redirect(tep_href_link(FILENAME_LOGIN, '', 'SSL'));
19	19		}
20		-
21		-	if (!tep_session_is_registered('sendto')) {
22		-	tep_redirect(tep_href_link(FILENAME_CHECKOUT_PAYMENT, '', 'SSL'));
	20	+
	21	+	// if there is nothing in the customers cart, redirect them to the shopping cart page
	22	+	if ($cart->count_contents() < 1) {
	23	+	tep_redirect(tep_href_link(FILENAME_SHOPPING_CART));
23	24		}
24	25
	26	+	// if no shipping method has been selected, redirect the customer to the shipping method selection page
	27	+	if (!tep_session_is_registered('shipping') \|\| !tep_session_is_registered('sendto')) {
	28	+	tep_redirect(tep_href_link(FILENAME_CHECKOUT_SHIPPING, '', 'SSL'));
	29	+	}
	30	+
25	31		if ( (tep_not_null(MODULE_PAYMENT_INSTALLED)) && (!tep_session_is_registered('payment')) ) {
26	32		tep_redirect(tep_href_link(FILENAME_CHECKOUT_PAYMENT, '', 'SSL'));
27	33		}
		…	…
46	52		require(DIR_WS_CLASSES . 'order.php');
47	53		$order = new order;
48	54
	55	+	// Stock Check
	56	+	$any_out_of_stock = false;
	57	+	if (STOCK_CHECK == 'true') {
	58	+	for ($i=0, $n=sizeof($order->products); $i<$n; $i++) {
	59	+	if (tep_check_stock($order->products[$i]['id'], $order->products[$i]['qty'])) {
	60	+	$any_out_of_stock = true;
	61	+	}
	62	+	}
	63	+	// Out of Stock
	64	+	if ( (STOCK_ALLOW_CHECKOUT != 'true') && ($any_out_of_stock == true) ) {
	65	+	tep_redirect(tep_href_link(FILENAME_SHOPPING_CART));
	66	+	}
	67	+	}
	68	+
	69	+	$payment_modules->update_status();
	70	+
	71	+	if ( ( is_array($payment_modules->modules) && (sizeof($payment_modules->modules) > 1) && !is_object($$payment) ) \|\| (is_object($$payment) && ($$payment->enabled == false)) ) {
	72	+	tep_redirect(tep_href_link(FILENAME_CHECKOUT_PAYMENT, 'error_message=' . urlencode(ERROR_NO_PAYMENT_MODULE_SELECTED), 'SSL'));
	73	+	}
	74	+
49	75		require(DIR_WS_CLASSES . 'order_total.php');
50	76		$order_total_modules = new order_total;
51	77
		…	…
66	92		'customers_telephone' => $order->customer['telephone'],
67	93		'customers_email_address' => $order->customer['email_address'],
68	94		'customers_address_format_id' => $order->customer['format_id'],
69		-	'delivery_name' => $order->delivery['firstname'] . ' ' . $order->delivery['lastname'],
	95	+	'delivery_name' => trim($order->delivery['firstname'] . ' ' . $order->delivery['lastname']),
70	96		'delivery_company' => $order->delivery['company'],
71	97		'delivery_street_address' => $order->delivery['street_address'],
72	98		'delivery_suburb' => $order->delivery['suburb'],

30	30		$sendto = $customer_default_address_id;
31	31		} else {
32	32		// verify the selected shipping address
33		-	$check_address_query = tep_db_query("select count(*) as total from " . TABLE_ADDRESS_BOOK . " where customers_id = '" . (int)$customer_id . "' and address_book_id = '" . (int)$sendto . "'");
34		-	$check_address = tep_db_fetch_array($check_address_query);
	33	+	if ( (is_array($sendto) && empty($sendto)) \|\| is_numeric($sendto) ) {
	34	+	$check_address_query = tep_db_query("select count(*) as total from " . TABLE_ADDRESS_BOOK . " where customers_id = '" . (int)$customer_id . "' and address_book_id = '" . (int)$sendto . "'");
	35	+	$check_address = tep_db_fetch_array($check_address_query);
35	36
36		-	if ($check_address['total'] != '1') {
37		-	$sendto = $customer_default_address_id;
38		-	if (tep_session_is_registered('shipping')) tep_session_unregister('shipping');
	37	+	if ($check_address['total'] != '1') {
	38	+	$sendto = $customer_default_address_id;
	39	+	if (tep_session_is_registered('shipping')) tep_session_unregister('shipping');
	40	+	}
39	41		}
40	42		}
41	43

12	12
13	13		require("includes/application_top.php");
14	14
	15	+	if ($cart->count_contents() > 0) {
	16	+	include(DIR_WS_CLASSES . 'payment.php');
	17	+	$payment_modules = new payment;
	18	+	}
	19	+
15	20		require(DIR_WS_LANGUAGES . $language . '/' . FILENAME_SHOPPING_CART);
16	21
17	22		$breadcrumb->add(NAVBAR_TITLE, tep_href_link(FILENAME_SHOPPING_CART));
		…	…
202	207		</table></td>
203	208		</tr>
204	209		<?php
	210	+	$initialize_checkout_methods = $payment_modules->checkout_initialization_method();
	211	+
	212	+	if (!empty($initialize_checkout_methods)) {
	213	+	?>
	214	+	<tr>
	215	+	<td><?php echo tep_draw_separator('pixel_trans.gif', '100%', '10'); ?></td>
	216	+	</tr>
	217	+	<tr>
	218	+	<td align="right" class="main" style="padding-right: 50px;"><?php echo TEXT_ALTERNATIVE_CHECKOUT_METHODS; ?></td>
	219	+	</tr>
	220	+	<?php
	221	+	reset($initialize_checkout_methods);
	222	+	while (list(, $value) = each($initialize_checkout_methods)) {
	223	+	?>
	224	+	<tr>
	225	+	<td><?php echo tep_draw_separator('pixel_trans.gif', '100%', '10'); ?></td>
	226	+	</tr>
	227	+	<tr>
	228	+	<td align="right" class="main"><?php echo $value; ?></td>
	229	+	</tr>
	230	+	<?php
	231	+	}
	232	+	}
205	233		} else {
206	234		?>
207	235		<tr>

69	69		?>
70	70		<table border="0" width="100%" cellspacing="0" cellpadding="2">
71	71		<tr class="headerError">
72		-	<td class="headerError"><?php echo htmlspecialchars(urldecode($HTTP_GET_VARS['error_message'])); ?></td>
	72	+	<td class="headerError"><?php echo htmlspecialchars(stripslashes(urldecode($HTTP_GET_VARS['error_message']))); ?></td>
73	73		</tr>
74	74		</table>
75	75		<?php
		…	…
79	79		?>
80	80		<table border="0" width="100%" cellspacing="0" cellpadding="2">
81	81		<tr class="headerInfo">
82		-	<td class="headerInfo"><?php echo htmlspecialchars($HTTP_GET_VARS['info_message']); ?></td>
	82	+	<td class="headerInfo"><?php echo htmlspecialchars(stripslashes(urldecode($HTTP_GET_VARS['info_message']))); ?></td>
83	83		</tr>
84	84		</table>
85	85		<?php

76	76		'telephone' => $order['customers_telephone'],
77	77		'email_address' => $order['customers_email_address']);
78	78
79		-	$this->delivery = array('name' => $order['delivery_name'],
	79	+	$this->delivery = array('name' => trim($order['delivery_name']),
80	80		'company' => $order['delivery_company'],
81	81		'street_address' => $order['delivery_street_address'],
82	82		'suburb' => $order['delivery_suburb'],
		…	…
131	131		}
132	132
133	133		function cart() {
134		-	global $HTTP_POST_VARS, $customer_id, $sendto, $billto, $cart, $languages_id, $currency, $currencies, $shipping, $payment, $comments;
	134	+	global $HTTP_POST_VARS, $customer_id, $sendto, $billto, $cart, $languages_id, $currency, $currencies, $shipping, $payment, $comments, $customer_default_address_id;
135	135
136	136		$this->content_type = $cart->get_content_type();
137	137
	138	+	if ( ($this->content_type != 'virtual') && ($sendto == false) ) {
	139	+	$sendto = $customer_default_address_id;
	140	+	}
	141	+
138	142		$customer_address_query = tep_db_query("select c.customers_firstname, c.customers_lastname, c.customers_telephone, c.customers_email_address, ab.entry_company, ab.entry_street_address, ab.entry_suburb, ab.entry_postcode, ab.entry_city, ab.entry_zone_id, z.zone_name, co.countries_id, co.countries_name, co.countries_iso_code_2, co.countries_iso_code_3, co.address_format_id, ab.entry_state from " . TABLE_CUSTOMERS . " c, " . TABLE_ADDRESS_BOOK . " ab left join " . TABLE_ZONES . " z on (ab.entry_zone_id = z.zone_id) left join " . TABLE_COUNTRIES . " co on (ab.entry_country_id = co.countries_id) where c.customers_id = '" . (int)$customer_id . "' and ab.customers_id = '" . (int)$customer_id . "' and c.customers_default_address_id = ab.address_book_id");
139	143		$customer_address = tep_db_fetch_array($customer_address_query);
140	144
141		-	$shipping_address_query = tep_db_query("select ab.entry_firstname, ab.entry_lastname, ab.entry_company, ab.entry_street_address, ab.entry_suburb, ab.entry_postcode, ab.entry_city, ab.entry_zone_id, z.zone_name, ab.entry_country_id, c.countries_id, c.countries_name, c.countries_iso_code_2, c.countries_iso_code_3, c.address_format_id, ab.entry_state from " . TABLE_ADDRESS_BOOK . " ab left join " . TABLE_ZONES . " z on (ab.entry_zone_id = z.zone_id) left join " . TABLE_COUNTRIES . " c on (ab.entry_country_id = c.countries_id) where ab.customers_id = '" . (int)$customer_id . "' and ab.address_book_id = '" . (int)$sendto . "'");
142		-	$shipping_address = tep_db_fetch_array($shipping_address_query);
143		-
144		-	$billing_address_query = tep_db_query("select ab.entry_firstname, ab.entry_lastname, ab.entry_company, ab.entry_street_address, ab.entry_suburb, ab.entry_postcode, ab.entry_city, ab.entry_zone_id, z.zone_name, ab.entry_country_id, c.countries_id, c.countries_name, c.countries_iso_code_2, c.countries_iso_code_3, c.address_format_id, ab.entry_state from " . TABLE_ADDRESS_BOOK . " ab left join " . TABLE_ZONES . " z on (ab.entry_zone_id = z.zone_id) left join " . TABLE_COUNTRIES . " c on (ab.entry_country_id = c.countries_id) where ab.customers_id = '" . (int)$customer_id . "' and ab.address_book_id = '" . (int)$billto . "'");
145		-	$billing_address = tep_db_fetch_array($billing_address_query);
	145	+	if (is_array($sendto) && !empty($sendto)) {
	146	+	$shipping_address = array('entry_firstname' => $sendto['firstname'],
	147	+	'entry_lastname' => $sendto['lastname'],
	148	+	'entry_company' => $sendto['company'],
	149	+	'entry_street_address' => $sendto['street_address'],
	150	+	'entry_suburb' => $sendto['suburb'],
	151	+	'entry_postcode' => $sendto['postcode'],
	152	+	'entry_city' => $sendto['city'],
	153	+	'entry_zone_id' => $sendto['zone_id'],
	154	+	'zone_name' => $sendto['zone_name'],
	155	+	'entry_country_id' => $sendto['country_id'],
	156	+	'countries_id' => $sendto['country_id'],
	157	+	'countries_name' => $sendto['country_name'],
	158	+	'countries_iso_code_2' => $sendto['country_iso_code_2'],
	159	+	'countries_iso_code_3' => $sendto['country_iso_code_3'],
	160	+	'address_format_id' => $sendto['address_format_id'],
	161	+	'entry_state' => $sendto['zone_name']);
	162	+	} elseif (is_numeric($sendto)) {
	163	+	$shipping_address_query = tep_db_query("select ab.entry_firstname, ab.entry_lastname, ab.entry_company, ab.entry_street_address, ab.entry_suburb, ab.entry_postcode, ab.entry_city, ab.entry_zone_id, z.zone_name, ab.entry_country_id, c.countries_id, c.countries_name, c.countries_iso_code_2, c.countries_iso_code_3, c.address_format_id, ab.entry_state from " . TABLE_ADDRESS_BOOK . " ab left join " . TABLE_ZONES . " z on (ab.entry_zone_id = z.zone_id) left join " . TABLE_COUNTRIES . " c on (ab.entry_country_id = c.countries_id) where ab.customers_id = '" . (int)$customer_id . "' and ab.address_book_id = '" . (int)$sendto . "'");
	164	+	$shipping_address = tep_db_fetch_array($shipping_address_query);
	165	+	} else {
	166	+	$shipping_address = array('entry_firstname' => null,
	167	+	'entry_lastname' => null,
	168	+	'entry_company' => null,
	169	+	'entry_street_address' => null,
	170	+	'entry_suburb' => null,
	171	+	'entry_postcode' => null,
	172	+	'entry_city' => null,
	173	+	'entry_zone_id' => null,
	174	+	'zone_name' => null,
	175	+	'entry_country_id' => null,
	176	+	'countries_id' => null,
	177	+	'countries_name' => null,
	178	+	'countries_iso_code_2' => null,
	179	+	'countries_iso_code_3' => null,
	180	+	'address_format_id' => 0,
	181	+	'entry_state' => null);
	182	+	}
146	183
147		-	$tax_address_query = tep_