cName and pName v1.5 for osCommerce-ms2

by Chemo

What does this contribution do?

This contribution replaces the stock osCommerce method of passing the product_id and cPath parameters. The intent is to display the product name and category name as part of the URL.

How does this contribution work?

This contribution creates a cache file of product and category names then uses that to swap pName/products_id and cName/cPath parameters. Upon admin edting a category or product the cache files are deleted. Then on the next customer visit to the page each cache file is recreated. Each language gets a separate cache file.

This contribution is fully dynamic and presents less server load than the traditional mod_rewrite methods. In addition, this contribution supports multi-lingual stores.

Screenshots

URL with category name

URL with product name

URL with product and category name

How do I install this contribution?

STEP 1 - Upload the included files

The files should be located in the upload directory of this contribution.

• includes/seo_cache.php should be uploaded to your *catalog*/includes/ directory
• admin/includes/reset_seo_cache.php should be uploaded to your *catalog*/*admin directory*/includes/ directory.

You will need to edit these two files and fill in the correct value for the $cache_dir variable. I would suggest creating a folder OUTSIDE your webroot and give the webserver read/write permission.

STEP 2 - Edit *catalog*/includes/application_top.php

Find this code:

// include the language translations require(DIR_WS_LANGUAGES . $language . '.php');

Directly AFTER add this:

# include the cName and pName cache file include('includes/seo_cache.php'); if (isset($HTTP_GET_VARS['cName']) && defined(urldecode($HTTP_GET_VARS['cName']))) { $cPath = str_replace('cPath=', '', constant(urldecode($HTTP_GET_VARS['cName']))); $HTTP_GET_VARS['cPath'] = $cPath; } if (isset($HTTP_GET_VARS['pName']) && defined(urldecode($HTTP_GET_VARS['pName']))) { $pid = str_replace('products_id=', '', constant(urldecode($HTTP_GET_VARS['pName']))); $HTTP_GET_VARS['products_id'] = (int)$pid; }

STEP 3 - Edit *catalog*/includes/functions/html_output.php

Find the function tep_href_link()

//// // The HTML href link wrapper function function tep_href_link($page = '', $parameters = '', $connection = 'NONSSL', $add_session_id = true, $search_engine_safe = true) { global $request_type, $session_started, $SID; if (!tep_not_null($page)) { die('</td></tr></table></td></tr></table><br><br><font color="#ff0000"><b>Error!</b></font><br><br><b>Unable to determine the page link!<br><br>'); } if ($connection == 'NONSSL') { $link = HTTP_SERVER . DIR_WS_HTTP_CATALOG; } elseif ($connection == 'SSL') { if (ENABLE_SSL == true) { $link = HTTPS_SERVER . DIR_WS_HTTPS_CATALOG; } else { $link = HTTP_SERVER . DIR_WS_HTTP_CATALOG; } } else { die('</td></tr></table></td></tr></table><br><br><font color="#ff0000"><b>Error!</b></font><br><br><b>Unable to determine connection method on a link!<br><br>Known methods: NONSSL SSL</b><br><br>'); } if (tep_not_null($parameters)) { $link .= $page . '?' . tep_output_string($parameters); $separator = '&'; } else { $link .= $page; $separator = '?'; } while ( (substr($link, -1) == '&') || (substr($link, -1) == '?') ) $link = substr($link, 0, -1); // Add the session ID when moving from different HTTP and HTTPS servers, or when SID is defined if ( ($add_session_id == true) && ($session_started == true) && (SESSION_FORCE_COOKIE_USE == 'False') ) { if (tep_not_null($SID)) { $_sid = $SID; } elseif ( ( ($request_type == 'NONSSL') && ($connection == 'SSL') && (ENABLE_SSL == true) ) || ( ($request_type == 'SSL') && ($connection == 'NONSSL') ) ) { if (HTTP_COOKIE_DOMAIN != HTTPS_COOKIE_DOMAIN) { $_sid = tep_session_name() . '=' . tep_session_id(); } } } if ( (SEARCH_ENGINE_FRIENDLY_URLS == 'true') && ($search_engine_safe == true) ) { while (strstr($link, '&&')) $link = str_replace('&&', '&', $link); $link = str_replace('?', '/', $link); $link = str_replace('&', '/', $link); $link = str_replace('=', '/', $link); $separator = '?'; } if (isset($_sid)) { $link .= $separator . $_sid; } return $link; }

REPLACE WITH THIS CODE:

function implode_assoc($array, $inner_glue='=', $outer_glue='&') { $output = array(); foreach( $array as $key => $item ) $output[] = $key . $inner_glue . $item; return implode($outer_glue, $output); } //// // The HTML href link wrapper function function tep_href_link($page = '', $parameters = '', $connection = 'NONSSL', $add_session_id = true, $search_engine_safe = true) { global $request_type, $session_started, $SID; $seo = true; $seo_pages = array('index.php', 'product_info.php'); if ( !in_array($page, $seo_pages) ) $seo = false; if (!tep_not_null($page)) { die('</td></tr></table></td></tr></table><br><br><font color="#ff0000"><b>Error!</b></font><br><br><b>Unable to determine the page link!<br><br>'); } if ($connection == 'NONSSL') { $link = HTTP_SERVER . DIR_WS_HTTP_CATALOG; $seo_link = HTTP_SERVER . DIR_WS_HTTP_CATALOG; } elseif ($connection == 'SSL') { if (ENABLE_SSL == true) { $link = HTTPS_SERVER . DIR_WS_HTTPS_CATALOG; $seo_link = HTTPS_SERVER . DIR_WS_HTTPS_CATALOG; } else { $link = HTTP_SERVER . DIR_WS_HTTP_CATALOG; $seo_link = HTTP_SERVER . DIR_WS_HTTP_CATALOG; } } else { die('</td></tr></table></td></tr></table><br><br><font color="#ff0000"><b>Error!</b></font><br><br><b>Unable to determine connection method on a link!<br><br>Known methods: NONSSL SSL</b><br><br>'); } if (tep_not_null($parameters)) { $link .= $page . '?' . tep_output_string($parameters); # Start exploding the parameters to extract the values # Also, we could use parse_str($parameters) and would probably be more clean if ($seo){ $p = explode('&', $parameters); krsort($p); $params = array(); foreach ($p as $index => $valuepair) { $p2 = explode('=', $valuepair); switch ($p2[0]){ case 'products_id': if ( defined('PRODUCT_NAME_'.$p2[1]) ){ $params['pName'] = constant('PRODUCT_NAME_'.$p2[1]); } else { $seo = false; } break; case 'cPath': if ( defined('CATEGORY_NAME_'.$p2[1]) ){ $params['cName'] = constant('CATEGORY_NAME_'.$p2[1]); } else { $seo = false; } break; default: $params[$p2[0]] = $p2[1]; break; } } $params_stripped = implode_assoc($params); $seo_link .= $page . '?'.tep_output_string($params_stripped); } $separator = '&'; } else { $link .= $page; $separator = '?'; $seo = false; } while ( (substr($link, -1) == '&') || (substr($link, -1) == '?') ) $link = substr($link, 0, -1); // Add the session ID when moving from different HTTP and HTTPS servers, or when SID is defined if ( ($add_session_id == true) && ($session_started == true) && (SESSION_FORCE_COOKIE_USE == 'False') ) { if (tep_not_null($SID)) { $_sid = $SID; } elseif ( ( ($request_type == 'NONSSL') && ($connection == 'SSL') && (ENABLE_SSL == true) ) || ( ($request_type == 'SSL') && ($connection == 'NONSSL') ) ) { if (HTTP_COOKIE_DOMAIN != HTTPS_COOKIE_DOMAIN) { $_sid = tep_session_name() . '=' . tep_session_id(); } } } if ( (SEARCH_ENGINE_FRIENDLY_URLS == 'true') && ($search_engine_safe == true) ) { while (strstr($link, '&&')) $link = str_replace('&&', '&', $link); while (strstr($seo_link, '&&')) $seo_link = str_replace('&&', '&', $seo_link); $link = str_replace('?', '/', $link); $link = str_replace('&', '/', $link); $link = str_replace('=', '/', $link); $seo_link = str_replace('?', '/', $seo_link); $seo_link = str_replace('&', '/', $seo_link); $seo_link = str_replace('=', '/', $seo_link); $separator = '?'; } if (isset($_sid)) { $link .= $separator . $_sid; $seo_link .= $separator . $_sid; } if ($seo === true) return $seo_link; else return $link; }

STEP 4 - Edit *admin directory*/categories.php

Find this code:

if (tep_not_null($action)) {

Directly AFTER add this:

if ($action!='new_product_preview') include_once('includes/reset_seo_cache.php');

Notes

The installation is pretty straight forward. Before reporting any bugs please verify that the cache files are being written to file (cache directory variable).

Support

osCommerce is a community driven organization and as such the support base will fall entirely on the forum members. The base class is thoroughly commented and should be easy to follow for any coder. I offer limited support in-between paid projects (feeding my family comes first before volunteer time).

If you use this contribution and find it useful a small donation can be made via PayPal. This will enable me to offer one-on-one support and also fund releasing other contributions. In addition, if you make a donation it'll make you eligible for other performance optimization contributions that are not released!

Enter Donation amount: $

Credits

This contribution is original work. Enjoy!