Product Release Information

Product:	File Attachment Support for osCommerce 2.2
Release Number:	1.0.1
Release Date:	Dec 8, 2009
Customer Support:	For more information or support, please visit our website or contact us from the online form

Introduction

This document describes how to install and get started with File Attachment Support Module.

Features of the File Attachment Support module:

• Allow user add file attachment to the order on check out, or view/edit order page, user can also remove or download existing attachments
• Allow admin set allowed file type, number of upload files and maximum file size for upload
• Shows attachment file size, date, and uploader ("by admin" or "by customer")
• Allow admin add file attachment to the order(s), admin can also remove or download existing attachments
• Allow admin to turn on off the file upload feature
• Ajax based uploading, fast and easy to use
• Easy installation, seamless integration with osCommerce 2.2

Minimal System Requirements

System requirements are described in the release notes.

Installation

What other software must be installed first?

Before you can install this product, you must obtain access to a web server with the following:

• PHP 4.x with :
• GD Library
• mCrypt
• Register Globals set to On via httpd.conf, php.ini or .htaccess
• The Apache Webserver
• MySQL database
• The Linux / Unix Operating System
• osCommerce 2.2 or later

How do I install osCommerce : File Attachment Support Module?

Please follow these steps:

1. Upload the files to your catalog directory on the webserver.
2. Open shopping_cart.php file, after
   <td align="right" class="main"><?php echo '<a href="' . tep_href_link(FILENAME_CHECKOUT_SHIPPING, '', 'SSL') . '">' . tep_image_button('button_checkout.gif', IMAGE_BUTTON_CHECKOUT) . '</a>'; ?></td> <td width="10"><?php echo tep_draw_separator('pixel_trans.gif', '10', '1'); ?></td> </tr> </table></td> </tr> </table></td> </tr> <?php
   add
   if (defined('MODULE_ADDONS_FILEATTACHMENT_STATUS') && MODULE_ADDONS_FILEATTACHMENT_STATUS == 'True') { $files = array(); $uploaddir = DIR_FS_CATALOG . 'order_files/'; if (isset($_SESSION[tep_session_id()]['files']) && is_array($_SESSION[tep_session_id()]['files'])) { foreach ($_SESSION[tep_session_id()]['files'] as $idx => $file) { if (file_exists($uploaddir . $file['target_name'])) { $files[$idx] = $file; } else { unset($_SESSION[tep_session_id()]['files'][$idx]); } } } ?> <script type="text/javascript" src="includes/javascript/ajaxfileupload.js"></script> <tr> <td><?php echo tep_draw_separator('pixel_trans.gif', '1', '10'); ?></td> </tr> <?php if (sizeof($files) < MODULE_ADDONS_FILEATTACHMENT_MAX_FILE_NUMBER) { ?> <tr> <td><table border="0" width="100%" cellspacing="0" cellpadding="0"> <tr> <td class="main" align="center"><?php echo TEXT_FILE_COMMENT; ?><input type="text" id="file_comment" value="" size="35" /></td> <td class="main"><input type="button" style="cursor: pointer;" id="buttonUpload" name="buttonUpload" value="Upload New File" /></td> <td class="main"><img id="loading" src="<?php echo DIR_WS_IMAGES; ?>uploading.gif" style="visibility:hidden;"></td> </tr> </table></td> </tr> <?php } ?> <tr> <td><?php echo tep_draw_separator('pixel_trans.gif', '1', '10'); ?></td> </tr> <tr> <td align="center"> <div id="file_div" align="center"> <?php if (sizeof($files) > 0) { ?> <table border="0" width="90%" cellspacing="1" cellpadding="3" style="background-color: #000000;" align="center"> <tr> <td class="main" style="background-color: #FFFFFF;"><b><?php echo TEXT_FILE_NAME; ?></b></td> <td class="main" style="background-color: #FFFFFF;" align="center"><?php echo TEXT_FILE_SIZE; ?></td> <td class="main" style="background-color: #FFFFFF;" align="center"><?php echo TEXT_FILE_UPLOADER; ?></td> <td class="main" style="background-color: #FFFFFF;" align="center"><?php echo TEXT_FILE_DATE; ?></td> <td class="main" style="background-color: #FFFFFF;" align="center"> </td> </tr> <?php foreach ($files as $idx => $file) { ?> <tr> <td class="main" style="background-color: #FFFFFF;"><a href="<?php echo tep_href_link('order_files.php', 'action=shopping_cart_download&id=' . $idx); ?>" title="<?php echo $file['comment']; ?>"><?php echo $file['name']; ?></a></td> <td class="main" style="background-color: #FFFFFF;" align="center"><?php echo resizeBytes($file['size']); ?></td> <td class="main" style="background-color: #FFFFFF;" align="center">Customer</td> <td class="main" style="background-color: #FFFFFF;" align="center"><?php echo $file['date']; ?></td> <td class="main" style="background-color: #FFFFFF;" align="center"><a href="javascript: void(0);" onclick="deleteFile(<?php echo $idx; ?>)">Delete</a></td> </tr> <?php } ?> </table> <?php } ?> </div> </td> </tr> <tr> <td><?php echo tep_draw_separator('pixel_trans.gif', '1', '10'); ?></td> </tr> <script type="text/javascript"><!-- var url = '<?php echo tep_href_link('order_files.php', '1=1', $request_type); ?>'; new AjaxUpload('#buttonUpload', { action: url + '&action=shopping_cart_upload', name: 'userfile', autoSubmit: true, onSubmit: function(file, extension) { <?php if (defined('MODULE_ADDONS_FILEATTACHMENT_ALLOWED_FILE_TYPE') && tep_not_null(MODULE_ADDONS_FILEATTACHMENT_ALLOWED_FILE_TYPE)) { ?> if (! (extension && /^(<?php echo str_replace(' ', '', MODULE_ADDONS_FILEATTACHMENT_ALLOWED_FILE_TYPE); ?>)$/.test(extension))) { alert('<?php echo sprintf(TEXT_FILE_INVALID_FILE_EXTENSION, MODULE_ADDONS_FILEATTACHMENT_ALLOWED_FILE_TYPE); ?>'); return false; } <?php } ?> data = { file_comment: document.getElementById('file_comment').value}; this.setData(data); document.getElementById('buttonUpload').disabled = true; document.getElementById('loading').style.visibility = 'visible'; }, onComplete: function(file, response) { document.getElementById('buttonUpload').disabled = false; document.getElementById('loading').style.visibility = 'hidden'; document.getElementById('file_div').innerHTML = response; } }); function deleteFile(id) { if (confirm('<?php echo TEXT_FILE_DELETE_CONFIRM; ?>')) { window.location = url + '&action=shopping_cart_delete&id=' + id; } } --></script> <?php }


3. Open includes/languages/english.php file, before last
   ?>
   add
   define('TABLE_ORDER_FILES', 'order_files'); define('TEXT_FILE_COMMENT', 'File Comment: '); define('TEXT_FILE_NAME', 'File Name'); define('TEXT_FILE_SIZE', 'File Size'); define('TEXT_FILE_UPLOADER', 'Uploader'); define('TEXT_FILE_DATE', 'Upload Date'); define('TEXT_FILE_INVALID_FILE_EXTENSION', 'Invalid file extension.\nOnly %s files are allowed.'); define('TEXT_FILE_DELETE_CONFIRM', 'Do you really want to delete this file?'); define('TEXT_FILE_FAILED', 'Upload failed.\nPlease check the permission of order_files/ directory, make sure it\\\'s writable.'); define('TEXT_FILE_TOO_BIG', 'File is too big, please make sure your file is smaller than %s');


4. Open includes/functions/general.php file, before last
   ?>
   add
   function resizeBytes($size) { $count = 0; $format = array('B', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'); while (($size / 1024) > 1 && $count < 8) { $size = $size / 1024; $count++; } $return = number_format($size, 0, '.', ',') . ' ' . $format[$count]; return $return; }


5. Open checkout_process.php file, after
   $cart->reset(true);
   add
   if (defined('MODULE_ADDONS_FILEATTACHMENT_STATUS') && MODULE_ADDONS_FILEATTACHMENT_STATUS == 'True') { if (isset($_SESSION[tep_session_id()]['files'])) { $files = $_SESSION[tep_session_id()]['files']; foreach ($files as $file) { $sql_data = array('orders_id' => $insert_id, 'file_name' => $file['target_name'], 'display_name' => $file['name'], 'file_comment' => $file['comment'], 'file_uploader' => 1, 'upload_date' => $file['date']); tep_db_perform(TABLE_ORDER_FILES, $sql_data); } unset($_SESSION[tep_session_id()]['files']); } }


6. Open account_history_info.php file, after
   if (DOWNLOAD_ENABLED == 'true') include(DIR_WS_MODULES . 'downloads.php'); ?> <tr> <td><?php echo tep_draw_separator('pixel_trans.gif', '100%', '10'); ?></td> </tr>
   add
   <?php $orders_id = (int)$_GET['order_id']; if (defined('MODULE_ADDONS_FILEATTACHMENT_STATUS') && MODULE_ADDONS_FILEATTACHMENT_STATUS == 'True') { $files = array(); $filedir = DIR_FS_CATALOG . 'order_files/'; $file_query = tep_db_query("select * from " . TABLE_ORDER_FILES . " where orders_id = " . $orders_id); while ($file_data = tep_db_fetch_array($file_query)) { if (file_exists($filedir . $file_data['file_name'])) { $files[] = $file_data; } else { tep_db_query("delete from " . TABLE_ORDER_FILES . " where order_files_id = " . $file_data['order_files_id']); } } ?> <script type="text/javascript" src="includes/javascript/ajaxfileupload.js"></script> <?php $order_files_query = tep_db_query("select * from " . TABLE_ORDER_FILES . " where orders_id = " . $orders_id); if (tep_db_num_rows($order_files_query) < MODULE_ADDONS_FILEATTACHMENT_MAX_FILE_NUMBER) { ?> <tr> <td><table border="0" width="100%" cellspacing="0" cellpadding="0"> <tr> <td align="center" class="main"><?php echo TEXT_FILE_COMMENT; ?><input type="text" id="file_comment" value="" size="35" /></td> <td class="main"><input type="button" style="cursor: pointer;" id="buttonUpload" name="buttonUpload" value="Upload New File" /></td> <td class="main"><img id="loading" src="<?php echo DIR_WS_IMAGES; ?>uploading.gif" style="visibility:hidden;"></td> </tr> </table></td> </tr> <?php } ?> <tr> <td><?php echo tep_draw_separator('pixel_trans.gif', '1', '10'); ?></td> </tr> <tr> <td class="main" align="center"> <div id="file_div" align="center"> <?php if (sizeof($files) > 0) { ?> <table border="0" width="100%" cellspacing="1" cellpadding="3" style="background-color: #000000;" align="center"> <tr> <td class="main" style="background-color: #FFFFFF;"><b><?php echo TEXT_FILE_NAME; ?></b></td> <td class="main" style="background-color: #FFFFFF;" align="center"><?php echo TEXT_FILE_SIZE; ?></td> <td class="main" style="background-color: #FFFFFF;" align="center"><?php echo TEXT_FILE_UPLOADER; ?></td> <td class="main" style="background-color: #FFFFFF;" align="center"><?php echo TEXT_FILE_DATE; ?></td> <td class="main" style="background-color: #FFFFFF;" align="center"> </td> </tr> <?php foreach ($files as $file) { ?> <tr> <td class="main" style="background-color: #FFFFFF;"><a href="<?php echo tep_href_link('order_files.php', 'action=download&id=' . $file['order_files_id'] . '&orders_id=' . $orders_id); ?>" title="<?php echo $file['file_comment']; ?>"><?php echo $file['display_name']; ?></a></td> <td class="main" style="background-color: #FFFFFF;" align="center"><?php echo resizeBytes(filesize($filedir . $file['file_name'])); ?></td> <td class="main" style="background-color: #FFFFFF;" align="center"><?php echo ($file['file_uploader'] == 1 ? 'Customer' : 'Admin'); ?></td> <td class="main" style="background-color: #FFFFFF;" align="center"><?php echo $file['upload_date']; ?></td> <td class="main" style="background-color: #FFFFFF;" align="center"><a href="javascript: void(0);" onclick="deleteFile(<?php echo $file['order_files_id']; ?>)">Delete</a></td> </tr> <?php } ?> </table> <?php } ?> </div> </td> </tr> <script type="text/javascript"><!-- var url = '<?php echo tep_href_link('order_files.php', 'orders_id=' . $orders_id, $request_type); ?>'; new AjaxUpload('#buttonUpload', { action: url + '&action=upload', name: 'userfile', autoSubmit: true, onSubmit: function(file, extension) { <?php if (defined('MODULE_ADDONS_FILEATTACHMENT_ALLOWED_FILE_TYPE') && tep_not_null(MODULE_ADDONS_FILEATTACHMENT_ALLOWED_FILE_TYPE)) { ?> if (! (extension && /^(<?php echo str_replace(' ', '', MODULE_ADDONS_FILEATTACHMENT_ALLOWED_FILE_TYPE); ?>)$/.test(extension))) { alert('<?php echo sprintf(TEXT_FILE_INVALID_FILE_EXTENSION, MODULE_ADDONS_FILEATTACHMENT_ALLOWED_FILE_TYPE); ?>'); return false; } <?php } ?> data = { file_comment: document.getElementById('file_comment').value}; this.setData(data); document.getElementById('buttonUpload').disabled = true; document.getElementById('loading').style.visibility = 'visible'; }, onComplete: function(file, response) { document.getElementById('buttonUpload').disabled = false; document.getElementById('loading').style.visibility = 'hidden'; document.getElementById('file_div').innerHTML = response; } }); function deleteFile(id) { if (confirm('<?php echo TEXT_FILE_DELETE_CONFIRM; ?>')) { window.location = url + '&action=delete&id=' + id; } } --></script> <?php } ?> <tr> <td><?php echo tep_draw_separator('pixel_trans.gif', '1', '10'); ?></td> </tr>


7. Open admin/includes/languages/english.php file, after last
   ?>
   add
   define('TABLE_ORDER_FILES', 'order_files'); define('TEXT_FILE_COMMENT', 'File Comment: '); define('TEXT_FILE_NAME', 'File Name'); define('TEXT_FILE_SIZE', 'File Size'); define('TEXT_FILE_UPLOADER', 'Uploader'); define('TEXT_FILE_DATE', 'Upload Date'); define('TEXT_FILE_DELETE_CONFIRM', 'Do you really want to delete this file?'); define('TEXT_FILE_FAILED', 'Upload failed.\nPlease check the permission of order_files/ directory, make sure it\\\'s writable.'); define('TEXT_FILE_TOO_BIG', 'File is too big, please make sure your file is smaller than %s');


8. Open admin/includes/functions/general.php file, after last
   ?>
   add
   function resizeBytes($size) { $count = 0; $format = array('B', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'); while (($size / 1024) > 1 && $count < 8) { $size = $size / 1024; $count++; } $return = number_format($size, 0, '.', ',') . ' ' . $format[$count]; return $return; }


9. Open admin/orders.php file, before
   <tr> <td colspan="2" align="right"><?php echo '<a href="' . tep_href_link(FILENAME_ORDERS_INVOICE, 'oID=' . $HTTP_GET_VARS['oID']) . '" TARGET="_blank">' . tep_image_button('button_invoice.gif', IMAGE_ORDERS_INVOICE) . '</a> <a href="' . tep_href_link(FILENAME_ORDERS_PACKINGSLIP, 'oID=' . $HTTP_GET_VARS['oID']) . '" TARGET="_blank">' . tep_image_button('button_packingslip.gif', IMAGE_ORDERS_PACKINGSLIP) . '</a> <a href="' . tep_href_link(FILENAME_ORDERS, tep_get_all_get_params(array('action'))) . '">' . tep_image_button('button_back.gif', IMAGE_BACK) . '</a>'; ?></td> </tr>
   add
   <?php $orders_id = (int)$_GET['oID']; if (defined('MODULE_ADDONS_FILEATTACHMENT_STATUS') && MODULE_ADDONS_FILEATTACHMENT_STATUS == 'True') { $files = array(); $filedir = DIR_FS_CATALOG . 'order_files/'; $file_query = tep_db_query("select * from " . TABLE_ORDER_FILES . " where orders_id = " . $orders_id); while ($file_data = tep_db_fetch_array($file_query)) { if (file_exists($filedir . $file_data['file_name'])) { $files[] = $file_data; } else { tep_db_query("delete from " . TABLE_ORDER_FILES . " where order_files_id = " . $file_data['order_files_id']); } } ?> <script type="text/javascript" src="includes/javascript/ajaxfileupload.js"></script> <?php $order_files_query = tep_db_query("select * from " . TABLE_ORDER_FILES . " where orders_id = " . $orders_id); if (tep_db_num_rows($order_files_query) < MODULE_ADDONS_FILEATTACHMENT_MAX_FILE_NUMBER) { ?> <tr> <td><?php echo tep_draw_separator('pixel_trans.gif', '1', '10'); ?></td> </tr> <tr> <td><table border="0" width="100%" cellspacing="0" cellpadding="0"> <tr> <td class="main" align="center"><?php echo TEXT_FILE_COMMENT; ?><input type="text" id="file_comment" value="" size="35" /></td> <td class="main"><input type="button" style="cursor: pointer;" id="buttonUpload" name="buttonUpload" value="Upload New File" /></td> <td class="main"><img id="loading" src="<?php echo DIR_WS_IMAGES; ?>uploading.gif" style="visibility:hidden;"></td> </tr> </table></td> </tr> <?php } ?> <tr> <td align="center"> <div id="file_div" align="center"> <?php if (sizeof($files) > 0) { ?> <table border="0" width="100%" cellspacing="1" cellpadding="3" style="background-color: #000000;" align="center"> <tr> <td class="main" style="background-color: #FFFFFF;"><b><?php echo TEXT_FILE_NAME; ?></b></td> <td class="main" style="background-color: #FFFFFF;" align="center"><?php echo TEXT_FILE_SIZE; ?></td> <td class="main" style="background-color: #FFFFFF;" align="center"><?php echo TEXT_FILE_UPLOADER; ?></td> <td class="main" style="background-color: #FFFFFF;" align="center"><?php echo TEXT_FILE_DATE; ?></td> <td class="main" style="background-color: #FFFFFF;" align="center"> </td> </tr> <?php foreach ($files as $file) { ?> <tr> <td class="main" style="background-color: #FFFFFF;"><a href="<?php echo tep_href_link('order_files.php', 'action=download&id=' . $file['order_files_id'] . '&orders_id=' . $orders_id); ?>" title="<?php echo $file['file_comment']; ?>"><?php echo $file['display_name']; ?></a></td> <td class="main" style="background-color: #FFFFFF;" align="center"><?php echo resizeBytes(filesize($filedir . $file['file_name'])); ?></td> <td class="main" style="background-color: #FFFFFF;" align="center"><?php echo ($file['file_uploader'] == 1 ? 'Customer' : 'Admin'); ?></td> <td class="main" style="background-color: #FFFFFF;" align="center"><?php echo $file['upload_date']; ?></td> <td class="main" style="background-color: #FFFFFF;" align="center"><a href="javascript: void(0);" onclick="deleteFile(<?php echo $file['order_files_id']; ?>)">Delete</a></td> </tr> <?php } ?> </table> <?php } ?> </div> </td> </tr> <tr> <td><?php echo tep_draw_separator('pixel_trans.gif', '1', '10'); ?></td> </tr> <script type="text/javascript"><!-- var url = '<?php echo tep_href_link('order_files.php', 'orders_id=' . $orders_id, $request_type); ?>'; new AjaxUpload('#buttonUpload', { action: url + '&action=upload', name: 'userfile', autoSubmit: true, onSubmit: function(file, extension) { data = { file_comment: document.getElementById('file_comment').value}; this.setData(data); document.getElementById('buttonUpload').disabled = true; document.getElementById('loading').style.visibility = 'visible'; }, onComplete: function(file, response) { document.getElementById('buttonUpload').disabled = false; document.getElementById('loading').style.visibility = 'hidden'; document.getElementById('file_div').innerHTML = response; } }); function deleteFile(id) { if (confirm('<?php echo TEXT_FILE_DELETE_CONFIRM; ?>')) { window.location = url + '&action=delete&id=' + id; } } --></script> <?php } ?>


10. Run SQL statement in phpMyAdmin:
    INSERT INTO configuration (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, date_added) VALUES ('Enable File Attachment Module', 'MODULE_ADDONS_FILEATTACHMENT_STATUS', 'True', 'Select True to enable File Attachment.', '119', '10', 'tep_cfg_select_option(array(\'True\', \'False\'), ', now()); INSERT INTO configuration (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, date_added) VALUES ('Max File Size(KB)', 'MODULE_ADDONS_FILEATTACHMENT_MAX_FILE_SIZE', '2000', 'Max file size for a single file(KB).', '119', '20', now()); INSERT INTO configuration (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, date_added) VALUES ('Max Number of Files', 'MODULE_ADDONS_FILEATTACHMENT_MAX_FILE_NUMBER', '5', 'Max number of files for one order.', '119', '30', now()); INSERT INTO configuration (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, date_added) VALUES ('Allowed File Type', 'MODULE_ADDONS_FILEATTACHMENT_ALLOWED_FILE_TYPE', '', '<b>e.g.:</b>   jpg|png|jpeg|gif<br /><br />Leave emapt for allowed any file types.', '119', '30', now()); INSERT INTO configuration_group (configuration_group_id, configuration_group_title, sort_order, visible) VALUES (119, 'File Attachment', 119, 1); CREATE TABLE order_files (order_files_id INT( 11 ) NOT NULL AUTO_INCREMENT PRIMARY KEY , orders_id INT( 11 ) NOT NULL , file_name VARCHAR( 255 ) NOT NULL , display_name VARCHAR( 255 ) NOT NULL , file_comment text NOT NULL, file_uploader INT( 1 ) NOT NULL , upload_date DATETIME NOT NULL , INDEX ( orders_id ));

How can I uninstall osCommerce : File Attachment Support Module?

    Delete all files that you added

    Restore all files that you changed

    Run SQL statement in phpMyAdmin:
         delete from configuration where configuration_key in ('MODULE_ADDONS_FILEATTACHMENT_STATUS', 'MODULE_ADDONS_FILEATTACHMENT_MAX_FILE_SIZE', 'MODULE_ADDONS_FILEATTACHMENT_MAX_FILE_NUMBER', 'MODULE_ADDONS_FILEATTACHMENT_ALLOWED_FILE_TYPE'); delete from configuration_group where configuration_group_id = 119; drop table order_files;

What if I encounter problems?

    Please see the troubleshooting section in the FAQ.