Ultimate SEO v3 (and v2.200) [Support Thread]

Affected Environments
This affects users with multiple (and custom) product types. Without this patch, the correct templates will not be loaded to display the product type.

Credits
Thanks to vkd1980 for finding this bug in the released code.

Notes
I forgot to include the updated index.php with support for additional product types when v2.200 and v2.205 was packaged. I will be including this patch in the next version.

Help Wanted - Documentation
Do you have excellent technical writing skills and attention to detail? If so, any help writing documentation for this module would be appreciated! Currently, I feel the documentation for installation, configuration, and usage are a little lacking. I may work on this a little in my spare time, but life, work, and volunteer activities tend to keep me very busy.

Help Wanted - Translation
Do you read and write multiple languages? If so, any help updating (or creating new) versions of the language specific files would be appreciated! This is an area the module could use some help. While I can understand more then one spoken language... I would need to revert to using a translation utility to generate written translations. I feel someone fluent (or better yet a native speaker) in a non-English language could provide far better and useful translations.

Hello,

after installation of SEO module to clean ZenCart 1.5 everything was ok. When I added product than category name was missing in URL:

http://www.domain.com//-p-1.html

When I added seccond product to same category I get blank page at all. In debug files is:

PHP Fatal error:  Call to a member function MoveNext() on a non-object in /var/www/web/includes/classes/seo.url.php on line 848

sql from function get_parent_categories_path looks like this

SELECT c.parent_id AS p_id, cd.categories_name AS name FROM categories c LEFT JOIN categories_description cd ON c.categories_id=cd.categories_id AND cd.language_id='2'WHERE c.categories_id='0'

c.categories_id='0' should be 1. In $categories_id variable is no value.

Any idea what to do? At this time I have to completly remove SEO module from ZenCart installation.

Thanks in advance.

SupuS

SupuS:

http://www.domain.com//-p-1.html

> SupuS

That url doesn't look correct at all. Shouldn't be double slashes after .com. And the url is missing the product name.

A link or non-linked text address to your site might help.

There seems to be a bug in the script causing a blank page, but it only affects stores using a database prefix because the table names are hard coded.

Here's the solution. Edit includes/classes/seo.url.php file as follows:
find (line 613) /* START SEO-ADD-PRODUCT-CAT PATCH * * Patched to use SEO_ADD_PRODUCT_CAT * This allows the use of a directory structure for urls. * @author Andrew Ballanger */ if($this->attributes['SEO_ADD_PRODUCT_CAT'] == 'true') { $sql = 'SELECT pd.products_name AS pName, ptc.categories_id AS c_id ' . 'FROM products_description AS pd ' . 'LEFT JOIN products AS p ' . 'ON pd.products_id=p.products_id ' . 'LEFT JOIN products_to_categories AS ptc ' . 'ON pd.products_id=ptc.products_id ' . 'WHERE pd.products_id=\'' . (int)$pID . '\' ' . 'AND language_id=\'' . (int)$this->languages_id . '\' LIMIT 1'; } and replace with: ```
/* START SEO-ADD-PRODUCT-CAT PATCH
*
* Patched to use SEO_ADD_PRODUCT_CAT
* This allows the use of a directory structure for urls.
* @author Andrew Ballanger
*/
if($this->attributes['SEO_ADD_PRODUCT_CAT'] == 'true')
{
$sql = 'SELECT pd.products_name AS pName, ptc.categories_id AS c_id ' .
'FROM ' . TABLE_PRODUCTS_DESCRIPTION . ' AS pd ' .
'LEFT JOIN ' . TABLE_PRODUCTS . ' AS p ' .
'ON pd.products_id=p.products_id ' .
'LEFT JOIN ' . TABLE_PRODUCTS_TO_CATEGORIES . ' AS ptc ' .
'ON pd.products_id=ptc.products_id ' .
'WHERE pd.products_id='' . (int)$pID . '' ' .
'AND language_id='' . (int)$this->languages_id . '' LIMIT 1';
}

find (line 825) ```
function get_parent_categories_path(&$path, $categories_id, &$cPath = array())
	{
		$sql = 'SELECT c.parent_id AS p_id, cd.categories_name AS name ' .
			'FROM categories c ' .
			'LEFT JOIN categories_description cd ' .
			'ON c.categories_id=cd.categories_id ' .
			'AND cd.language_id=\'' . (int)$this->languages_id . '\'' .
			'WHERE c.categories_id=\'' . (int)$categories_id . '\'';

		$parent = $this->db->Execute($sql, false, true, 43200);

and replace with ```
function get_parent_categories_path(&$path, $categories_id, &$cPath = array())
{
$sql = 'SELECT c.parent_id AS p_id, cd.categories_name AS name ' .
'FROM ' . TABLE_CATEGORIES . ' c ' .
'LEFT JOIN ' . TABLE_CATEGORIES_DESCRIPTION . ' cd ' .
'ON c.categories_id=cd.categories_id ' .
'AND cd.language_id='' . (int)$this->languages_id . ''' .
'WHERE c.categories_id='' . (int)$categories_id . ''';

	$parent = $this->db->Execute($sql, false, true, 43200);

Changes are highlighted in red. Hope it helps...

@balihr, Thanks for the catch, I'll go back through the code before the next release and look for any SQL statements where the table names are used directly.

@SupuS, It looks like you are using either more then one language or a non-english language.

Before you add balihr's changes, please use the "Product Cache Generation Patch" previously posted in this thread.

My Guess
Another consideration (I've not completely dug through all the code from the original module): if no name is found in the database for the language the web browser is set to use. When this occurs, it may cause the current code base to omit names in the URLs (If I remember correctly, the module does not attempt to fall back to another language if no language specific result is found).

Fix for Guess
If the target audience for your store includes more than one language, please make sure you add translations for all the languages. For example, if your target audience is Spanish and English, you need to make sure you define category and product names for both the Spanish and English languages using the admin interface.

hi
i have just downloaded this what file do i upload to my server am using 1.5.0 zencart
this is a fresh install of this and there is 4 files a licence file
1 file is affected_files_150
1 file is new_files_150
1 file is new files 150 czech
1 file is new file 150 english
this is a fresh install so nothing from this plugin has been installed before which of the 4 files do i upload to my server
thanks??

There are more then 4 files in those directories. Start by extracting the entire zip file.

Most plugins include a readme. This is always a good place to start with any new mod / plugin. The readme files include more information on how each of the four folders you mentioned are used.

In addition, I should note each of those four directories are organized further into "includes" and "your_admin_folder". Files under "includes" go into the "includes" folder of your Zen Cart installation. Files under "your_admin_folder" go into the admin folder of your Zen Cart installation.

From the README (English language) distributed in the zip file:

===========================================================
INSTALLATION INSTRUCTIONS
===========================================================

1. Copy files from `new_files_150` and `new_files_150_English` to your Zen Cart install
2a. If you haven't made changes to Zen Cart, Copy and replace files from `affected_files_150` to your Zen Cart install
2b. If you have made changes to your Zen Cart, you will need to merge your versions with this version
3. A sample .htaccess file is included. Simply rename to .htaccess and edit to match your site
4. Config the module in CONFIGURATION

For step three, see notes on the .htaccess file.

I would also highly recommend the following before making your Zen Cart installation live (and accessible to Search Engines).1. Install any relevant patches released (after the version you are using was released)
2. Finalize category and product names
3. Configure the settings for "Ultimate SEO"
4. Make sure the URLs match what you desire

after much tinkering on an install on a fresh 1.5 site which generated blank white pages, I have figured out that there are two files that are breaking the site:

/affected_files_150/includes/auto_loaders/config.ultimate_seo.php
/affected_files_150/includes/functions/html_output.php

Again, this is a fresh 1.5 install.

.htaccess path was modified.

Does anyone have any ideas?

Thank you,

I have installed 2.2 on a fresh 1.5 zencart. It breaks the site. After enabling/disabling one file at a time, I found the two files that are breaking the catalog side of the site:
affected_files_150/includes/functions/html_output.php
includes/auto_loaders/config.ultimate_seo.php

the path in the .htaccess file has been modifed.

Does this give anyone a clue in how I can continue troubleshooting?

the site is at https://www.custombookmarker.com

thank you!

NOTICE & WARNING
This module was written with compatibility for Zen Cart 1.5.0. Optional support was included for Query Cache from Data Diggers based upon a branch of Query Cache 1.9 Alpha.

A different implementation of Query Cache has been included in the Zen Cart 1.5.1 release. The Zen Cart 1.5.1 version of Query Cache does not include a function vital to the operation of Ultimate SEO. Due to the code changes in Query Cache this plugin does not work w/ Zen Cart 1.5.1.

I am currently working on making some changes to this plugin (and also modifying the stock Zen Cart 1.5.1 version of Query Cache) to address the issues. I will also be rolling the latest patches, fixes, and updates from my development version of Ultimate SEO into the next release of the plugin.

lhungil:

NOTICE & WARNING
This module was written with compatibility for Zen Cart 1.5.0. Optional support was included for Query Cache from Data Diggers based upon a branch of Query Cache 1.9 Alpha.

A different implementation of Query Cache has been included in the Zen Cart 1.5.1 release. The Zen Cart 1.5.1 version of Query Cache does not include a function vital to the operation of Ultimate SEO. Due to the code changes in Query Cache this plugin does not work w/ Zen Cart 1.5.1.

I am currently working on making some changes to this plugin (and also modifying the stock Zen Cart 1.5.1 version of Query Cache) to address the issues. I will also be rolling the latest patches, fixes, and updates from my development version of Ultimate SEO into the next release of the plugin.

Thanks for your response. do you have a general idea of when that might be?

styledata:

Thanks for your response. do you have a general idea of when that might be?

Zen Cart 1.5.1 was released 18 Sep 2012 - basically yesterday! :D

Keep in mind as part of the next release I will be including changes to the underlying database abstraction layer of Zen Cart as well as modified versions of the Query Cache present in Zen Cart 1.5.1. Since these updates change how the entire application (Zen Cart) will access the database, I do want to take some time to test my changes.

Before I release the next public version I will be releasing a beta version to anyone interested in helping test the changes. Once any bugs found during beta testing are fixed, I will make a public release. I am hoping to have a beta version ready to go tonight or tomorrow. If no major issues show up during beta testing you can probably expect a public release sometime next week.

DONE LIST

• Update ZC 1.5.1 implementation of Query Cache
• Update ZC 1.5.1 MySQL Query Factory
• Product Cache Generation patch applied
• Product Types Cache patch applied
• Test on clean Zen Cart 1.5.0
• Test on heavily modified Zen Cart 1.5.0

TODO LIST

• Remove hard coded table names from SQL Queries
• Test on clean Zen Cart 1.5.1
• Test on heavily modified Zen Cart 1.5.1

Status Update
I have finished coding the necessary changes and have completed testing against:- Clean 1.5.0

• Clean 1.5.1
• Clean 1.5.0
• Production 1.5.0 + Custom Product Types + Edit Orders 4.0 + Admin New Order RC1.1 + Admin New Customer 1.0 + Price Markup + Drop Shipping + Freight Accessorials + YRC Drop Shipping + UPS Drop Shipping + Other Modules
• Development 1.5.1 + Custom Product Types + Edit Orders 4.0 + Admin New Order RC1.1 + Admin New Customer 1.0 + Price Markup + Drop Shipping + Freight Accessorials + YRC Drop Shipping + UPS Drop Shipping + Other Modules
  I will be uploading the new version tomorrow for approval.

Changes
The following is taken from the English release notes.

• Enhancement: Support for Zen Cart 1.5.1
• Enhancement: Updated Zen Cart 1.5.1 Query Cache to add the ability to remove an item from the cache before expiration.
• Enhancement: Updated Zen Cart 1.5.1 MySQL query_factory to always return a value from the "Execute()" method.
• Enhancement: Updated Zen Cart 1.5.1 MySQL query_factory to provide better support for cached values.
• Enhancement: Updated htaccess_sample to include a line supporting linked products when "categories as directories" is enabled.
• Enhancement: Included the handler for Custom Product Types.
• Bugfix: Removed hardcoded table names. Installations with database prefixes will now work.
• Bugfix: The Product Cache is now generated correctly for multi-language (and non-english language) Zen Carts.

Ultimate SEO demo site:

http://demo.zen-cart.cn

Affected Environments
This affects users with multiple languages installed. Without this patch, EZ-Pages may not load the correct page based upon language.

Credits
Thanks to neteasy for finding this bug and submitting a patch.

Notes
The needed changes will be incorporated in the next release.

Notes
The next version includes a number of enhancements to the Zen Cart 1.5.1 implementation of "Query Cache" and the handling of the Zen Cart 1.5 "file" / "database" cache. Please backup your installation and database before installing version 2.207 of "Ultimate SEO".

The latest version is awaiting review / approval to be added to the plugin section of the Zen Cart website. Please be patient and while you are waiting think about donating to the Zen Cart team!

Updates / Fixes

• Removed hardcoded table names. Installations with database prefixes will now work.
• The Product Cache is now generated correctly for multi-language (and non-english language) Zen Carts.
• Support for "Multi-Language EZ Pages" plugin.

Enhancements / New Features

• Included the handler for Custom Product Types. This will look at requests to display a product and load the correct handler based upon the product type.
• Updated htaccess_sample. Includes a new line to better support linked products when as directories is enabled. Basically the line passes the category path to Zen Cart so "Ultimate SEO" does not need to fall back to using the product_master_category_id.
• Updated ZC 1.5.1 Query Cache to add the ability to remove an item from the cache before expiration.
• Updated ZC 1.5.1 MySQL query_factory to always return a value from the "Execute()" method.
• Updated ZC 1.5.1 MySQL query_factory to provide better support for cached values.

Hope this is the correct place to post this support question.
his plugin works perfectly on the site I am setting up (Yarnstyle.com, Zen 1.5.0) EXCEPT for the add to cart functionality is not working. :)
I suspect it is something I need to change in the .htaccess file....it currently looks like this:

##### NOTE: Replace /shop/ with the relative web path of your catalog in the "Rewrite Base" line below:

Options +FollowSymLinks
RewriteEngine On
RewriteBase /

# From Ultimate SEO URLs
RewriteRule ^(.*)-c-([^/])/(.*)-p-(.*).html$ index\.php?main_page=product_info&products_id=$4&cpath=$2 [L]
RewriteRule ^(.*)-p-(.*).html$ index\.php?main_page=product_info&products_id=$2&%{QUERY_STRING} [L]

#Normal Ultimate SEO URLs (disable if using ADD_PRODUCT_CAT)
#RewriteRule ^(.*)-c-(.*).html$ index\.php?main_page=index&cPath=$2&%{QUERY_STRING} [L]

# ADD_PRODUCT_CAT Ultimate SEO URLs (disable if not using ADD_PRODUCT_CAT)
RewriteRule ^(.*)-c-(.*).html$ $1-c-$2/ [R=301,L]
RewriteRule ^(.*)-c-([^/]+)$ %{REQUEST_URI}/ [R=301,L]
RewriteRule ^(.*)-c-([^/]+)/$ index\.php?main_page=index&cPath=$2&%{QUERY_STRING} [L]

RewriteRule ^(.*)-m-([0-9]+).html$ index\.php?main_page=index&manufacturers_id=$2&%{QUERY_STRING} [L]
RewriteRule ^(.*)-pi-([0-9]+).html$ index\.php?main_page=popup_image&pID=$2&%{QUERY_STRING} [L]
RewriteRule ^(.*)-pr-([0-9]+).html$ index\.php?main_page=product_reviews&products_id=$2&%{QUERY_STRING} [L]
RewriteRule ^(.*)-pri-([0-9]+).html$ index\.php?main_page=product_reviews_info&products_id=$2&%{QUERY_STRING} [L]
RewriteRule ^(.*)-ezp-([0-9]+).html$ index\.php?main_page=page&id=$2&%{QUERY_STRING} [L]

# All other pages
# Don't rewrite real files or directories
RewriteCond %{REQUEST_FILENAME} !-f [NC] 
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*).html$ index\.php?main_page=$1&%{QUERY_STRING} [L]

# Handle when a resource is not found (404 Error Page)
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ index\.php?main_page=page_not_found&%{QUERY_STRING} [L]

All of the demo sites for this plugin seem to have a url that looks like this when you click add to cart:
/index.php?main_page=shopping_cart&number_of_uploads=0

On our site, it looks like this:
http://yarnstyle.com/bernat-c-1/sashay-yarn-mambo-p-2.html?action=add_product&cpath=

I have verified the add to cart button works when I turn this plugin off so it has something to do with this installation. Any advice on where I should look to make changes?

Would this mod will help the search engines to find your more or less?

craftideasweekly:

All of the demo sites for this plugin seem to have a url that looks like this when you click add to cart:
/index.php?main_page=shopping_cart&number_of_uploads=0

On our site, it looks like this:
http://yarnstyle.com/bernat-c-1/sashay-yarn-mambo-p-2.html?action=add_product&cpath=

I have verified the add to cart button works when I turn this plugin off so it has something to do with this installation. Any advice on where I should look to make changes?

For all of the demo sites I've seen, including my stock 1.5.0 and 1.5.1 test sites, and my development site (lots of modules, different templates, etc) If you pull up the source and look at the "Form Action" you will see a URL like the first one you listed. This is the correct URL.

If you want to verify, you can take a look at "init_includes/init_cart_handler.php". This file handles some prep work (such as setting up parameters for a redirect to the shopping cart if configured). See also "Admin -> Configuration -> My Store -> Display Cart After Adding Product". It then loads main_cart_actions.php to handle the action "add_product". The shopping cart class then adds the product and redirects the request.

Your .htaccess file looks okay, although you can safely remove the [NC] from:

# Don't rewrite real files or directories
RewriteCond %{REQUEST_FILENAME} !-f [NC] 
RewriteCond %{REQUEST_FILENAME} !-d

Take a look for any debug files generated in your log directory (the cache directory in 1.5.0). Anything there? These typically will show you if an error occurred.

Looking at your site, it looks like your installation (including modifications to templates and installed modules) does not appear to ever add the product to the cart. As "action=add_product" has been added to the end of the URL it should be triggering the code in both init_cart_handler.php and main_cart_actions.php.

Have changes been made to "init_cart_handler.php", "main_cart_actions.php", or "config.core.php"?