Ultimate SEO URLs v2.0 for CRE Loaded

by Chemo

What does this contribution do?

This contribution builds on the cName contibution and 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.

Currently, this contribution supports 2 different methods for creating search engine friendly URLs.  A store owner may toggle between the two methods at leisure from the convenience of an admin control panel setting group.

METHOD #1 - cName (v1.X series)

This method does NOT use mod_rewrite and is suitable for any store on any server operating system.  This is advantageous to some since a store hosted on a Windows server that uses IIS (and not Apache) cannot use mod_rewrite based transformers.  This method is the fastest and most compatible SEO URL contribution currently available.

This method will work on any server.

METHOD #2 - Rewrite (v2.X series)

This method is the most advantageous with respect to optimizing for search engines.  It rewrites all category and product URLs to appear as static HTML files.  Although faster than other mod_rewrite based contributions this one is still slower than METHOD #1 by a few milliseconds.  In addition, this contribution does not add significant overhead to the server resources.

This method relies on Apache mod_rewrite so is not compatible with Windows/IIS servers or Front Page Extensions.

NEW IN THIS RELEASE:

This release is also bundled with the new osC Advanced Cache Class. This moves the cache off the filesystem and into the database.

Why store cache in the database? Well, there were some store owners that had trouble with setting up a cache directory and also getting the permissions correct. This is an elegant solution to those problems since there is no need to enter any path or setup any directory with the right permissions. Also, the cache class will serve as the backbone of my future releases (osC Advanced Templating Engine, osC Search Engine / Spider, more performance enhancements, etc).

Installation of the cache class is a 2 step process: upload the file and call the install script in your browser. That is it! Install couldn't be easier! The directions below are bundled...

How does this contribution work?

This contribution creates a cache of product, manufacturer, and category names then uses that to swap pName/products_id, mName/manufacturers_id and cName/cPath parameters. Upon admin edting a category or product the cache is 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 most traditional mod_rewrite methods. In addition, this contribution supports multi-lingual stores, unlimited nested categories, and duplicates (categories and products).

Screenshots

Admin Control Panel Options

Version 1.X (cName) Screenshots

URL with category name

URL with product name

URL with product and category name

URL with manufacturer name

http://yourdomain.com/index.php?mName=touchstone-entertainment

Version 2.X (Rewrite) Screenshots

URL with category name

URL with product name

URL with manufacturer name

http://yourdomain.com/touchstone-entertainment-m-15.html

How do I install this contribution?

Upload 3 new files, modify 4 existing files, done. Install should take about 5 minutes.

Before you install this it should be noted that it is NOT COMPATIBLE with the stock osCommerce option of SEF URLs. Be sure to turn this off if you have it enabled!

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
• includes/classes/cache.class.php should be uploaded to your *catalog*/includes/classes directory
• admin/includes/reset_seo_cache.php should be uploaded to your *catalog*/*admin directory*/includes directory
• install-seo.php should be uploaded to your *catalog* directory
• install-cache.php should be uploaded to your *catalog* directory

STEP 2 - Install the database settings

In step #1 you should have uploaded a file to your catalog directory called "install-seo.php". Call that file in your web browser.  Read the page...there are 2 options => install or uninstall.  Select the install link and it will add all the settings. If you are upgrading first UNINSTALL then re-install.

In step #1 you should have uploaded a file to your catalog directory called "install-cache.php". Call that file in your web browser. Read the page...there are 2 options => install or uninstall. Select the install link and it will add the cache table. Do this even if you are upgrading.

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

3 (1) Find this code:

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

3 (1) Directly AFTER add this:

# include the cache class include('includes/classes/cache.class.php'); $cache = new cache($languages_id); # include the Ultimate SEO URLs cache file include('includes/seo_cache.php'); # Get the cache - no parameters will get all GLOBAL cache entries for this language $cache->get_cache('GLOBAL'); 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; }

3 (2) Find this code:

if (DISPLAY_CART == 'true') { $goto = FILENAME_SHOPPING_CART; $parameters = array('action', 'cPath', 'products_id', 'pid'); } else { $goto = basename($PHP_SELF); if ($HTTP_GET_VARS['action'] == 'buy_now') { $parameters = array('action', 'pid', 'products_id'); } else { $parameters = array('action', 'pid'); } }

3 (2) REPLACE WITH THIS:

if (DISPLAY_CART == 'true') { $goto = FILENAME_SHOPPING_CART; $parameters = array('action', 'cPath', 'products_id', 'pid', 'cName', 'pName'); } else { $goto = basename($PHP_SELF); if ($HTTP_GET_VARS['action'] == 'buy_now') { $parameters = array('action', 'pid', 'products_id', 'pName'); } else { $parameters = array('action', 'pid'); } }

3 (3) Find this code:

// performed by the 'buy now' button in product listings and review page case 'buy_now' : if (isset($HTTP_GET_VARS['products_id'])) { //Wishlist 2.0.1 Modification if (tep_session_is_registered('customer_id')) { tep_db_query("delete from " . TABLE_WISHLIST . " WHERE customers_id=$customer_id AND products_id=$products_id"); } // End Wishlist 2.0.1 Modification if (tep_has_product_attributes($HTTP_GET_VARS['products_id'])) { tep_redirect(tep_href_link(FILENAME_PRODUCT_INFO, 'products_id=' . $HTTP_GET_VARS['products_id'])); } else { $cart->add_cart($HTTP_GET_VARS['products_id'], $cart->get_quantity($HTTP_GET_VARS['products_id'])+1); } } tep_redirect(tep_href_link($goto, tep_get_all_get_params($parameters))); break;

3 (3) REPLACE WITH THIS:

// performed by the 'buy now' button in product listings and review page case 'buy_now' : if (isset($HTTP_GET_VARS['products_id'])) { //Wishlist 2.0.1 Modification if (tep_session_is_registered('customer_id')) { tep_db_query("delete from " . TABLE_WISHLIST . " WHERE customers_id=$customer_id AND products_id=$products_id"); } // End Wishlist 2.0.1 Modification if (tep_has_product_attributes($HTTP_GET_VARS['products_id'])) { tep_redirect(tep_href_link(FILENAME_PRODUCT_INFO, 'products_id=' . $HTTP_GET_VARS['products_id'])); } else { $cart->add_cart($HTTP_GET_VARS['products_id'], $cart->get_quantity($HTTP_GET_VARS['products_id'])+1); } } if ( (defined('SEO_URLS') && SEO_URLS == 'true') && (defined('SEO_URLS_TYPE') && SEO_URLS_TYPE == 'Rewrite') ){ $cPath = tep_get_product_path($HTTP_GET_VARS['products_id']); $cPath_array = tep_parse_category_path($cPath); $cPath = implode('_', $cPath_array); tep_redirect(tep_href_link($goto, 'cPath=' . $cPath . '&' . tep_get_all_get_params($parameters))); } else { tep_redirect(tep_href_link($goto, tep_get_all_get_params($parameters))); } break;

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

4 (1) Find the function tep_href_link()

function tep_href_link($page = '', $parameters = '', $connection = 'NONSSL', $add_session_id = true, $search_engine_safe = true) { global $request_type, $session_started, $SID, $spider_flag; 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) && !$spider_flag) { $link .= $separator . $_sid; } return $link; }

4 (1a) 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); } function short_name($str, $limit=3){ if (defined('SEO_URLS_FILTER_SHORT_WORDS')) $limit = SEO_URLS_FILTER_SHORT_WORDS; $foo = explode('-', $str); foreach($foo as $index => $value){ switch (true){ case ( strlen($value) <= $limit ): continue; default: $container[] = $value; break; } } # end foreach $container = ( sizeof($container) > 1 ? implode('-', $container) : $str ); return $container; } //// // 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, $spider_flag; $seo = ( defined('SEO_URLS') ? SEO_URLS : false ); $seo_rewrite_type = ( defined('SEO_URLS_TYPE') ? SEO_URLS_TYPE : false ); $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 ($page == '/') $page = ''; if ($connection == 'NONSSL') { $link = HTTP_SERVER . DIR_WS_HTTP_CATALOG; $seo_link = HTTP_SERVER . DIR_WS_HTTP_CATALOG; $seo_rewrite_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; $seo_rewrite_link = HTTPS_SERVER . DIR_WS_HTTPS_CATALOG; } else { $link = HTTP_SERVER . DIR_WS_HTTP_CATALOG; $seo_link = HTTP_SERVER . DIR_WS_HTTP_CATALOG; $seo_rewrite_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 = '&'; # Start exploding the parameters to extract the values # Also, we could use parse_str($parameters) and would probably be more clean if ($seo == 'true'){ $p = explode('&', $parameters); krsort($p); $params = array(); if ( $seo_rewrite_type == 'Rewrite' ){ foreach ($p as $index => $valuepair) { $p2 = explode('=', $valuepair); switch ($p2[0]){ case 'products_id': $rewrite_product = true; if ( defined('PRODUCT_NAME_'.$p2[1]) ){ $rewrite_page_product = short_name(constant('PRODUCT_NAME_'.$p2[1])) . '-p-' . $p2[1] . '.html'; } else { $seo = false; } break; case 'cPath': $rewrite_category = true; if ( defined('CATEGORY_NAME_'.$p2[1]) ){ $rewrite_page_category = short_name(constant('CATEGORY_NAME_'.$p2[1])) . '-c-' . $p2[1] . '.html'; } else { $seo = false; } break; // manufacturer addition by WebPixie case 'manufacturers_id': $rewrite_manufacturer = true; if ( defined('MANUFACTURER_NAME_'.$p2[1]) ){ $rewrite_page_manufacturer = short_name(constant('MANUFACTURER_NAME_'.$p2[1])) . '-m-' . $p2[1] . '.html'; } else { $seo = false; } break; // end manufacturer addition by WebPixie default: $params[$p2[0]] = $p2[1]; break; } # switch } # end foreach $params_stripped = implode_assoc($params); switch (true){ case ( $rewrite_product && $rewrite_category ): case ( $rewrite_product ): $rewrite_page = $rewrite_page_product; $rewrite_category = false; break; case ( $rewrite_category ): $rewrite_page = $rewrite_page_category; break; // manufacturer addition by WebPixie case ( $rewrite_manufacturer ): $rewrite_page = $rewrite_page_manufacturer; break; // end manufacturer addition by WebPixie default: $seo = false; break; } #end switch true $seo_rewrite_link .= $rewrite_page . ( tep_not_null($params_stripped) ? '?'.tep_output_string($params_stripped) : '' ); $separator = ( tep_not_null($params_stripped) ? '&' : '?' ); } else { 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; // manufacturer addition by WebPixie case 'manufacturers_id': if ( defined('MANUFACTURER_NAME_'.$p2[1]) ){ $params['mName'] = constant('MANUFACTURER_NAME_'.$p2[1]); } else { $seo = false; } break; // end manufacturer addition by WebPixie default: $params[$p2[0]] = $p2[1]; break; } # switch } # end foreach $params_stripped = implode_assoc($params); $seo_link .= $page . '?'.tep_output_string($params_stripped); $separator = '&'; } # end if/else } # end if $seo } else { $link .= $page; $separator = '?'; $seo = false; } # end if(tep_not_null($parameters) 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); $seo_rewrite_link = str_replace('?', '/', $seo_rewrite_link); $seo_rewrite_link = str_replace('&', '/', $seo_rewrite_link); $seo_rewrite_link = str_replace('=', '/', $seo_rewrite_link); $separator = '?'; } if (isset($_sid) && !$spider_flag) { $link .= $separator . $_sid; $seo_link .= $separator . $_sid; $seo_rewrite_link .= $separator . $_sid; } if ($seo == 'true') { return ($seo_rewrite_type == 'Rewrite' ? $seo_rewrite_link : $seo_link); } else { return $link; } }

STEP 5 - Edit *catalog*/includes/modules/product_listing.php

5 (1) Find this code:

case 'PRODUCT_LIST_BUY_NOW': $lc_align = 'center'; $lc_text = '<a href="' . tep_href_link(basename($PHP_SELF), tep_get_all_get_params(array('action')) . 'action=buy_now&products_id=' . $listing['products_id']) . '">' . tep_template_image_button('button_buy_now.gif', IMAGE_BUTTON_BUY_NOW) . '</a> '; break;

5 (1) REPLACE WITH THIS:

case 'PRODUCT_LIST_BUY_NOW': $lc_align = 'center'; $lc_text = '<a href="' . tep_href_link(basename($PHP_SELF), tep_get_all_get_params(array('action', 'pName')) . 'action=buy_now&products_id=' . $listing['products_id']) . '">' . tep_template_image_button('button_buy_now.gif', IMAGE_BUTTON_BUY_NOW) . '</a> '; break;

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

6 (1) Find this code:

$action = (isset($HTTP_GET_VARS['action']) ? $HTTP_GET_VARS['action'] : '');

6 (1) Directly AFTER add this:

// Ultimate SEO URLs - by Chemo // If the action will affect the cache entries if ( eregi("(insert|update|setflag)", $action) ) include_once('includes/reset_seo_cache.php');

STEP 7 - Edit *admin directory*/includes/functions/general.php

Add this code to the file just above the ending ?> tag:

// Ultimate SEO URLs - by Chemo // Funtion to reset SEO URLs database cache entries function tep_reset_cache_data_seo_urls($action){ switch ($action){ case 'reset': tep_db_query("DELETE FROM cache WHERE cache_name LIKE '%seo_urls%'"); tep_db_query("UPDATE configuration SET configuration_value='false' WHERE configuration_key='SEO_URLS_CACHE_RESET'"); break; default: break; } # The return value is used to set the value upon viewing # It's NOT returining a false to indicate failure!! return 'false'; }

STEP 8 - Edit .htaccess file (in your catalog directory)

If you don't have an .htaccess file in your catalog folder create one.

If you are on a Windows/IIS server skip this step - you won't be able to use the rewrite method.

8 (1a) If your store is located in a FOLDER add this to the /folder/.htaccess file:

NOTE: you will have to edit the "folder" to match your directory name!

Options +FollowSymLinks RewriteEngine On # Change "folder" to your catalog directory name RewriteBase /folder/ RewriteRule ^(.*)-p-(.*).html$ product_info.php?products_id=$2&%{QUERY_STRING} RewriteRule ^(.*)-c-(.*).html$ index.php?cPath=$2&%{QUERY_STRING} RewriteRule ^(.*)-m-(.*).html$ index.php?manufacturers_id=$2&%{QUERY_STRING}

8 (1b) If your store is located in the root add this to the /.htaccess file:

Options +FollowSymLinks RewriteEngine On RewriteBase / RewriteRule ^(.*)-p-(.*).html$ product_info.php?products_id=$2&%{QUERY_STRING} RewriteRule ^(.*)-c-(.*).html$ index.php?cPath=$2&%{QUERY_STRING} RewriteRule ^(.*)-m-(.*).html$ index.php?manufacturers_id=$2&%{QUERY_STRING}

STEP 9 - Configure the settings

Admin Control Panel => Configuration => Enable SEO URLs => true

Admin Control Panel => Configuration => Choose URL Type => cName or Rewrite

Admin Control Panel => Configuration => Filter Short Words => 3

Admin Control Panel => Configuration => Reset SEO URLs Cache => false

NOTE: The filter short words option will remove all words less than or equal to the number! You can set this to 0 to disable.

Notes

The installation is pretty straight forward. I anticipate the biggest source of errors will be with modifying the WRONG .htaccess file.  It should be the one in your catalog directory.  So, if your store is located in a folder (i.e. - www.domain.com/catalog/ ) then you should edit/create the .htaccess in THAT folder.  For those that don't know you can have an .htaccess file in each folder and your site is NOT limited to just 1 in the root.

Support

Following the massive requests for me to install my contributions on store owners sites I will start taking them up on their offer. If you would like me to install this or any other contribution on your site just shoot me an email (link at top of page). Upgrade or installation of Ultimate SEO URLs will be set at $50 per install. Sound steep? Well, $20 of that will go toward the osCommerce development team so they can keep coding too. You get this installed hassle free. I get $30 for my time. The osCommerce team gets $20 for just being so damn cool. Everyone wins. :-)

osCommerce is a community driven organization and as such the support base will fall entirely on the forum members. The base code 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!

After all the contributions I've coded and released I'm beginning to think nobody reads this far down...

Enter Donation amount: $

Credits

This contribution is original work. Enjoy!

Additional credit goes to WebPixie and Fred Doherty for their additions. Further credit goes to claroque for development support.