X-Cart:After the upgrade

From X-Cart 4 Classic
Revision as of 11:53, 10 September 2010 by Ivka (talk | contribs) (Created page with 'After you have upgraded the development copy of your store, it is important to make sure that everything works correctly before your start replacing your live store with the upgr…')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

After you have upgraded the development copy of your store, it is important to make sure that everything works correctly before your start replacing your live store with the upgraded copy. The Post-Upgrade Checklist further in this section covers the basic X-Cart functionality and is intended to help you test most critical features.

Besides, after an upgrade it is important to carry out a number of tasks that pertain to the store maintenance (see section Basic Maintenance Jobs) and restore the original file permissions that were modified during the upgrade (see section Restoring File Permissions).

Basic Maintenance Jobs

After you have upgraded the store you need to carry out some basic maintenance-related tasks, which include regenerating the Blowfish key and cleaning the template cache.

Regenerating the Blowfish key

To regenerate the Blowfish key:

  1. Log in to the X-Cart Admin area.
  2. Go to the the Summary section (Administration menu -> Summary).
  3. In the Summary section, go to the section Tools/Re-generate Blowfish encryption key.
  4. Click the Regenerate button.

Cleaning the template cache

To clean the template cache:

  1. Log in to the X-Cart Admin area.
  2. Go to the the Summary section (Administration menu -> Summary).
  3. In the Summary section, go to the section Tools/Clear templates cache.
  4. Click the Clean button.

Restoring File Permissions

Original file permissions get changed during an upgrade, and you need to restore them after the upgrade to ensure correct functioning of the store. The instructions below describe what permissions must be set for X-Cart files and folders. The examples are provided for the Apache web server running on a UNIX-based operating system. If you use a different bundle, please refer to the documentation for the web server and operating system you use, or contact your hosting team for help.

General info

The exact set of file permissions would depend on whether the scripts are run in the privileged mode or non-privileged mode. The privileged mode means that scripts are run under the user who is the owner of the files while in the non-privileged mode scripts are run under a different user. This implies two different approaches to setting up file permissions:

  • In the privileged mode, permissions must be granted to the owner of the files only as the scripts run under that user. Permissions for the members of the files' group and other users must be disabled then.
  • In the non-privileged mode, permissions must be granted to the owner of the files, members of the files' group and other users who are not the owner of the file or members of the group.

On the Apache web server running on a UNIX-based operating system you can find out the current mode by running in a web browser the PHP script below. The script will display two user names: the name of the script owner who put the files to the server through FTP or SSH, and the name of the user who runs the scripts. If the two names coincide, the privileged mode is enabled; otherwise, you work in the non-privileged mode.

<?php

$processUser = posix_getpwuid(posix_geteuid());

print get_current_user() . " / " . $processUser['name'];

?>

On a UNIX-based operating system file permissions for a file are changed through the the following shell command.

chmod <permissions_code> <file_path>

The permissions_code part must be a three-digit number where each digit represents a different component of the permission set: file owner, members of the group who the file owner belongs to and other users who are not the file owner or group members. Each digit is a sum of three digits, which can be 0 (no permission), 1 (execute a file or search in a directory), 2 (write) or 4 (read). Below is a list of all available values and their meaning:

  • 0 : No permission
  • 1 : Execute/search
  • 2 : Write
  • 3 : Write and execute/search
  • 4 : Read
  • 5 : Read and execute/search
  • 6 : Read and write
  • 7 : Read, write and execute/search

For example, the permissions code 740 for a file would mean that the file owner can read, write and execute the file (7), the group members can only read the file (4) and other users can do nothing with the file (0); the permissions code 511 for a directory would mean that the file owner read the contents of the directory and search in the directory (5) while the group members and other users can only search in the directory (1).

Setting up file permissions for X-Cart files and directories

Scripts and directories containing scripts

Privileged Mode Non-privileged Mode
Directories: 711
  • Owner: read, write and search
  • Group: search
  • Other: search

Files: 600

  • Owner: read and write
  • Group: no permission
  • Other: no permission
Directories: 777
  • Owner: read, write and search
  • Group: read, write and search
  • Other: read, write and search

Files: 644

  • Owner: read and write
  • Group: read
  • Other: read

These permissions must be set for directories admin, customer, include, mail, modules, partner, payment, provider, shipping and upgrade and their subdirectories, and for all *.php files from these directories and the X-Cart root directory.

Templates and directories containing templates

Privileged Mode Non-privileged Mode
Directories: 711
  • Owner: read, write and search
  • Group: search
  • Other: search

Files: 644

  • Owner: read and write
  • Group: read
  • Other: read
Directories: 777
  • Owner: read, write and search
  • Group: read, write and search
  • Other: read, write and search

Files: 666

  • Owner: read and write
  • Group: read and write
  • Other: read and write

These permissions must be set for the directory skin1 and all its subdirectories, and for all files in the directory skin1 and its subdirectories.

Temporary and service directories: Directory .pgp

Privileged Mode Non-privileged Mode
Directories: 700
  • Owner: read, write and search
  • Group: no permission
  • Other: no permission

Files: 600

  • Owner: read and write
  • Group: no permission
  • Other: no permission
Directories: 755
  • Owner: read, write and search
  • Group: read and search
  • Other: read and search

Files: 644

  • Owner: read and write
  • Group: read
  • Other: read

These permissions must be set for the directory .pgp and its subdirectories, and for all files in the directory .pgp and its subdirectories.

Temporary and service directories: Directories catalog and images

Privileged Mode Non-privileged Mode
Directories: 711
  • Owner: read, write and search
  • Group: search
  • Other: search

Files: 644

  • Owner: read and write
  • Group: read
  • Other: read
Directories: 755
  • Owner: read, write and search
  • Group: read and search
  • Other: read and search

Files: 644

  • Owner: read and write
  • Group: read
  • Other: read

These permissions must be set for the directories catalog and images and their subdirectories, and for all files in the directories catalog and images and their subdirectories.

Temporary and service directories: Directory files

Privileged Mode Non-privileged Mode
Directories: 700
  • Owner: read, write and search
  • Group: no permission
  • Other: no permission

Files: 600

  • Owner: read and write
  • Group: no permission
  • Other: no permission
Directories: 777
  • Owner: read, write and search
  • Group: read, write and search
  • Other: read, write and search

Files: 666

  • Owner: read and write
  • Group: read and write
  • Other: read and write

These permissions must be set for the directory files and its subdirectories, and for all files in the the directory files and its subdirectories.

Temporary and service directories: Subdirectories of directory var (excl. var/cache)

Privileged Mode Non-privileged Mode
Directories: 700
  • Owner: read, write and search
  • Group: no permission
  • Other: no permission

Files: 600

  • Owner: read and write
  • Group: no permission
  • Other: no permission
Directories: 755
  • Owner: read, write and search
  • Group: read and search
  • Other: read and search

Files: 644

  • Owner: read and write
  • Group: read
  • Other: read

These permissions must be set for all subdirectories in the directory var (excluding the subdirectory cache), and for all files in the subdirectories of the directory var (excluding the subdirectory cache).

Temporary and service directories: Directories var and var/cache

Privileged Mode Non-privileged Mode
Directories: 711
  • Owner: read, write and search
  • Group: search
  • Other: search

Files: 600

  • Owner: read and write
  • Group: no permission
  • Other: no permission
Directories: 755
  • Owner: read, write and search
  • Group: read and search
  • Other: read and search

Files: 644

  • Owner: read and write
  • Group: read
  • Other: read

These permissions must be set up for the directory var and its subdirectory cache, and for all files in the directory var and its subdirectory cache.