Store Mode (Open | Closed | Maintenance) v2.0 Installation

Store Mode (Open | Closed | Maintenance) v2.0 - Installation Instruction

Works with osCommerce 2.2 rc2a and earlier with other contribution installed

Original contribution created by olsonsp4c

Added in June 2012 by reflex-ocasion

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

This contribution: http://addons.oscommerce.com/info/6332

Original contribution: http://addons.oscommerce.com/info/6332

Support Thread: http://forums.oscommerce.com/topic/319369-store-mode-open-closed-maintenance/

Description:

The purpose of this add-on is to set the mode of your store: Open, Closed, or Maintenance
The settings are defined in the Admin->Configuration->Store Mode and in the language files

Set Store Mode-> Open, Closed, or Maintenance

Open Store Mode:
Fully functioning ecommerce webstore
Additionally shows a message warning that we are on holidays and your order will be served on our return
Meanwhile, the shop is fully open and functional so that customers can continue to order
The message also included in the order confirmation email

Closed Store Mode:
While in Closed mode, your customers will be able to create accounts, browse the store, and add products to their basket; however, they will NOT be able to checkout until you reopen the store in the Admin. Your customers will see a friendly message on your index AND shopping cart pages informing them of this and telling them the date and time the store plans to reopen

Closed Store Features:
Allows your customers to create accounts
Allows your customers and search engines to browse
Allows your customers to add items to the cart
Saves shopping carts for delayed checkout
Prohibits customers from checking out of the store
Displays a friendly message on the index and shopping cart pages
Public notice before going offline

Maintenance Store Mode:
While in Maintenance mode, your customers will ONLY be able to access the Maintenance Page with an embedded contact form; however, you (the store owner) are granted full access to your website to test the changes you are making to your store. This is determined by the admin/owner's IP Adress which is automatically detected in the Admin section of this addon. As you browse your webstore, you will see a warning message at the top of your screen which reminds you that your store is in Maintenance Mode and that your customers will be expecting your store to return online at the date and time entered in the Admin. In order to see what your customers see while in Maintenance Mode you will either need to go to your store website from a different computer (with a different IP Address) or follow the steps in the Troubleshooting section. You must manually reopen the store in the Admin. While the store is in Open Mode, your customers are denied access to the Maintenance Page

Maintenance Store Features:
Choose filename (default is index_maintenance.php)
Hide the header
Hide the left column
Hide the right column
Hide the footer
Hide the product prices
Perform offline maintenance (admin's ip address bypasses the maintenance page)
Public notice before going offline
Display catalog side reminder to admin of offline status

v2.0 Detail

Added image to Maintenance page
Added a new option that displays a message warning that we are on holidays and your order will be served on our return. Meanwhile, the store remains open to the public
Added SQL in Spanish and German to choose

Use at your own risk

Before Adding This Contribution To Your Online Shop, You Should Back Up All Files Related To This Contribution

- INDEX -

Install in live store with other contribution installed
Changed files -

catalog/index.php
catalog/includes/languages/english/index.php
catalog/includes/languages/espanol/index.php
catalog/includes/languages/german/index.php
catalog/shopping_cart.php
catalog/includes/languages/english/shopping_cart.php
catalog/includes/languages/espanol/shopping_cart.php
catalog/includes/languages/german/shopping_cart.php
catalog/checkout_shipping.php
catalog/checkout_payment.php
catalog/includes/application_top.php
catalog/includes/header.php
catalog/admin/configuration.php
catalog/includes/classes/currencies.php
catalog/includes/languages/english.php
catalog/includes/languages/espanol.php
catalog/includes/languages/german.php
catalog/checkout_process.php
catalog/includes/languages/english/checkout_process.php
catalog/includes/languages/espanol/checkout_process.php
catalog/includes/languages/german/checkout_process.php

Update from older version please use a file compare tool to make necessary changes.

Admin Settings
Donate

- Install in live store with other contribution installed

Apply to oscommerce 2.2 rc2a and earlier with other contribution installed.

STEP 1.1

BACKUP YOUR DATABASE and THESE FILES NOW!

catalog/index.php
catalog/includes/languages/english/index.php
catalog/includes/languages/espanol/index.php
catalog/includes/languages/german/index.php
catalog/shopping_cart.php
catalog/includes/languages/english/shopping_cart.php
catalog/includes/languages/espanol/shopping_cart.php
catalog/includes/languages/german/shopping_cart.php
catalog/checkout_shipping.php
catalog/checkout_payment.php
catalog/includes/application_top.php
catalog/includes/header.php
catalog/admin/configuration.php
catalog/includes/classes/currencies.php
catalog/includes/languages/english.php
catalog/includes/languages/espanol.php
catalog/includes/languages/german.php
catalog/includes/classes/checkout_process.php
catalog/includes/languages/english/checkout_process.php
catalog/includes/languages/espanol/checkout_process.php
catalog/includes/languages/german/checkout_process.php

STEP 1.2

Upload following files to the corresponding folders:
- catalog\index_maintenance.php
- catalog\includes\languages\english\index_maintenance.php
- catalog\includes\languages\espanol\index_maintenance.php
- catalog\includes\languages\german\index_maintenance.php
- catalog\images\working.gif (is an animated gif)

STEP 1.3

Run the SQL script corresponding to your language in admin page, by using phpMyAdmin.

STEP 2.1

Open catalog/index.php

Find

Add AFTER

Save the file and move on.

STEP 2.2

Open catalog/includes/languages/english/index.php

Find (at the bottom just before)

Add BEFORE

//Store mode define('CLOSED_MESSAGE', STORE_NAME . ' is temporarily closed. You may create a account, login to your account, and add products to your shopping cart. Your shopping cart will be saved for delayed checkout. We plan to reopen: ');

Save the file and move on.

STEP 2.3

Open catalog/includes/languages/espanol/index.php

Find (at the bottom just before)

Add BEFORE

Save the file and move on.

STEP 2.3

Open catalog/includes/languages/german/index.php

Find (at the bottom just before)

Add BEFORE

Save the file and move on.

STEP 2.4

Open catalog/shopping_cart.php

Find

Add AFTER

Save the file and move on.

STEP 2.5

Open catalog/includes/languages/english/shopping_cart.php

Find (at the bottom just before)

Add AFTER (modify below TITLE_HOLIDAYS to suit your needs)

Save the file and move on.

STEP 2.6

Open catalog/includes/languages/espanol/shopping_cart.php

Find (at the bottom just before)

Add AFTER (modify below TITLE_HOLIDAYS to suit your needs)

Save the file and move on.

STEP 2.6

Open catalog/includes/languages/german/shopping_cart.php

Find (at the bottom just before)

Add AFTER (modify below TITLE_HOLIDAYS to suit your needs)

Save the file and move on.

STEP 2.7

Open catalog/checkout_shipping.php

Find (at the top of the file)

require('includes/application_top.php'); require('includes/classes/http_client.php');

Add AFTER

Save the file and move on.

STEP 2.8

Open catalog/checkout_payment.php

Find (at the top of the file)

require('includes/application_top.php');

Add AFTER

Save the file and move on.

STEP 2.9

Open catalog/includes/application_top.php

Find

// Shopping cart actions

Add BEFORE

Save the file and move on.

STEP 2.10

Open catalog/includes/header.php

Find

// check session.auto_start is disabled

Add BEFORE

Save the file and move on.

STEP 2.11

Open catalog/admin/configuration.php

Find

if (tep_not_null($action)) { switch ($action) { case 'save': $configuration_value = tep_db_prepare_input($HTTP_POST_VARS['configuration_value']); $cID = tep_db_prepare_input($HTTP_GET_VARS['cID']); tep_db_query("update " . TABLE_CONFIGURATION . " set configuration_value = '" . tep_db_input($configuration_value) . "', last_modified = now() where configuration_id = '" . (int)$cID . "'"); tep_redirect(tep_href_link(FILENAME_CONFIGURATION, 'gID=' . $HTTP_GET_VARS['gID'] . '&cID=' . $cID)); break; } }

REPLACE with this

// BOF: Store Mode
  if (tep_not_null($action)) {
    switch ($action) {
      case 'save':
        $configuration_value = tep_db_prepare_input($HTTP_POST_VARS['configuration_value']);
        $cID = tep_db_prepare_input($HTTP_GET_VARS['cID']);

tep_db_query("update " . TABLE_CONFIGURATION . " set configuration_value = '" . tep_db_input($configuration_value) . "', last_modified = now() where configuration_id = '" . (int)$cID . "'");

// set the OFFLINE_WARNING to false if STORE_MODE is set to Closed or Maintenance
        if ( (OFFLINE_WARNING == 'true') && (STORE_MODE != 'Open') ) {
          tep_db_query("update " . TABLE_CONFIGURATION . " set configuration_value = 'false', last_modified = '" . NOW . "' where configuration_key = 'OFFLINE_WARNING'");
	}

tep_redirect(tep_href_link(FILENAME_CONFIGURATION, 'gID=' . $HTTP_GET_VARS['gID'] . '&cID=' . $cID));
        break;
    }
  }

// Add for getting the actual IP (when not a fixed ip)
  if (MAINTENANCE_TESTING == 'true') {
    $IP_Admin = 'testing';
    tep_db_query("update " . TABLE_CONFIGURATION . " set configuration_value = '" . $IP_Admin . "' where configuration_key = 'OFFLINE_IP_ADDRESS'");
  } else {
    if ($HTTP_GET_VARS['gID'] == '1501') {
      $IP_Admin = tep_db_prepare_input(getenv(REMOTE_ADDR));
      $IP_Admin_DB_query = tep_db_query ("select configuration_value from " . TABLE_CONFIGURATION . " where configuration_key = 'OFFLINE_IP_ADDRESS'");
      $IP_Admin_DB = tep_db_fetch_array($IP_Admin_DB_query);
      if ($IP_Admin_DB['configuration_value'] != $IP_Admin) {
        tep_db_query("update " . TABLE_CONFIGURATION . " set configuration_value = '" . $IP_Admin . "' where configuration_key = 'OFFLINE_IP_ADDRESS'");
      }
    }
  }
// EOF: Store Mode

NOTE: The first block of code will automaticly set Admin->Configuration->Store Mode->Offline Warning to 'false' after you set the Admin->Configuration->Current Store Mode to "Closed" or "Maintenance". This way you will NOT forget to do it yourself and you'll avoid customer confusion.

NOTE: If you don't have a fixed IP number, the second block of code will get the actual IP of your admin computer and write it to the database.

Save the file and move on.

STEP 2.12

Open catalog/includes/classes/currencies.php

Find

return $format_string;

Add BEFORE

Save the file and move on.

STEP 2.13

Open catalog/includes/languages/english.php

Find (at the bottom just before)

Add BEFORE (modify below to suit your needs)

Save the file and move on.

STEP 2.14

Open catalog/includes/languages/espanol.php

Find (at the bottom just before)

Add BEFORE (modify below to suit your needs)

Save the file and move on.

STEP 2.14

Open catalog/includes/languages/german.php

Find (at the bottom just before)

Add BEFORE (modify below to suit your needs)

Save the file and move on.

STEP 2.15

Open catalog/checkout_process.php

Find

// lets start with the email confirmation $email_order = STORE_NAME . "\n" . EMAIL_SEPARATOR . "\n" . EMAIL_TEXT_ORDER_NUMBER . ' ' . $insert_id . "\n" . EMAIL_TEXT_INVOICE_URL . ' ' . tep_href_link(FILENAME_ACCOUNT_HISTORY_INFO, 'order_id=' . $insert_id, 'SSL', false) . "\n" . EMAIL_TEXT_DATE_ORDERED . ' ' . strftime(DATE_FORMAT_LONG) . "\n\n";

Add AFTER

Save the file and move on.

STEP 2.16

Open catalog/includes/languages/english/checkout_process.php

Find (at the bottom just before)

Add BEFORE

Save the file and move on.

STEP 2.17

Open catalog/includes/languages/espanol/checkout_process.php

Find (at the bottom just before)

Add BEFORE

Save the file and move on.

STEP 2.17

Open catalog/includes/languages/german/checkout_process.php

Find (at the bottom just before)

Add BEFORE

Save the files and upload to server. That's it!

Back to Index

- Post install support

Support thread is at: support thread

- Admin Settings

Store Mode settings are located under Configuration->Store Mode in admin page.
The online store can be placed in an open, closed or closed for maintenance.
In maintenance mode can enable or disable display the header, columns and the footer independently.
In open mode you can display a message warning that we are on holidays while the store is still open (and selling).

- End of file -

If you feel this Store Mode v2.0 and these installation instructions useful, a small donation is welcomed!

EUR €