Files
PrestaShop/controllers/admin/AdminAccountingExportController.php

536 lines
18 KiB
PHP

<?php
/*
* 2007-2012 PrestaShop
*
* NOTICE OF LICENSE
*
* This source file is subject to the Open Software License (OSL 3.0)
* that is bundled with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://opensource.org/licenses/osl-3.0.php
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@prestashop.com so we can send you a copy immediately.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade PrestaShop to newer
* versions in the future. If you wish to customize PrestaShop for your
* needs please refer to http://www.prestashop.com for more information.
*
* @author PrestaShop SA <contact@prestashop.com>
* @copyright 2007-2012 PrestaShop SA
* @version Release: $Revision: 9841 $
* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
* International Registered Trademark & Property of PrestaShop SA
*/
class AdminAccountingExportControllerCore extends AdminController
{
public $exportTypeList = array();
public $downloadDir = '';
public $downloadFile = '';
public $file = '';
public $already_generated = false;
public $exportSelected = '';
public $fd = null;
public $date = array(
'begin' => '',
'end' => ''
);
public $prevent = array(
'errors' => array(),
'warn' => array(),
'hints' => array());
public $exportedFilePath = '';
public $acc_conf = array();
public $file_format;
public function __construct()
{
$this->className = 'Accounting';
$this->content = '';
$this->downloadDir = _PS_ADMIN_DIR_.'/export/';
$this->exportSelected = 'accounting_export';
$this->initExportFieldList();
parent::__construct();
}
/**
* Init the available fields by export type with associated translation
*/
protected function initExportFieldList()
{
$this->exportTypeList = array(
'accounting_export' => array(
'name' => $this->l('Accounting Export'),
'type' => 'accounting_export',
'file' => 'accounting_export.csv',
'fields' => array(
'invoice_date' => $this->l('Invoice Date', 'AdminTab', false, false),
'journal' => $this->l('Journal', 'AdminTab', false, false),
'account' => $this->l('Account', 'AdminTab', false, false),
'invoice_number' => $this->l('Invoice Number', 'AdminTab', false, false),
'credit' => $this->l('Credit (TTC)', 'AdminTab', false, false),
'debit' => $this->l('Debit (TVA+HT)', 'AdminTab', false, false),
'transaction_id' => $this->l('Transaction Number', 'AdminTab', false, false),
'payment_type' => $this->l('Payment Type', 'AdminTab', false, false),
'currency_code' => $this->l('Currency Code', 'AdminTab', false, false),
'wording' => $this->l('Wording', 'AdminTab', false, false)
),
'type' => 0
),
'reconciliation_export' => array(
'name' => $this->l('Reconciliation Export'),
'type' => 'reconciliation_export',
'file' => 'accounting_reconciliation_export.csv',
'fields' => array(
'invoice_number' => $this->l('Invoice Number', 'AdminTab', false, false),
'wording' => $this->l('Wording', 'AdminTab', false, false),
'total_paid_real' => $this->l('Total TTC', 'AdminTab', false, false),
'invoice_date' => $this->l('Invoice Date', 'AdminTab', false, false),
'transaction_id' => $this->l('Transaction Number', 'AdminTab', false, false),
'account_client' => $this->l('Account client', 'AdminTab', false, false)
),
'type' => 1
)
);
}
/**
* AdminController::setMedia() override
* @see AdminController::setMedia()
*/
public function setMedia()
{
parent::setMedia();
$this->addJqueryUi('ui.datepicker');
}
protected function checkRights()
{
if (!is_writeable($this->downloadDir))
$this->errors[] = $this->l('The download folder doesn\'t have the sufficient right');
if (!($this->fd = fopen($this->downloadFile, 'w+')))
$this->errors[] = $this->l('The file can\'t be opened or created, please check the rights');
@chmod($this->downloadFile, 0777);
}
public function getExportedList()
{
$exported_list = Accounting::getExportedList();
foreach ($exported_list as &$export)
foreach ($this->exportTypeList as $export_type)
{
$export['title'] = $this->l('Undefined');
if (((int)$export_type['type']) == ((int)$export['type']))
{
$export['title'] = $export_type['name'];
break;
}
}
return $exported_list;
}
/**
* AdminController::init() override
* @see AdminController::init()
*/
public function initContent()
{
$this->context->smarty->assign(array(
'begin_date' => Tools::getValue('begin_date'),
'end_date' => Tools::getValue('end_date'),
'file_format' => $this->file_format,
'export_type' => $this->exportSelected,
'urlDownload' => Tools::getShopDomain().'/download/',
'preventList' => $this->prevent,
'export_type_list' => $this->exportTypeList,
'exported_list' => $this->getExportedList(),
'already_generated' => Configuration::get('REQUEST_URI').$this->already_generated,
));
parent::initContent();
}
public function saveRangeDate()
{
$keys = array('`begin_to`', '`end_to`', '`type`', '`file`');
$values = array(
'"'.pSQL($this->date['begin']).'"',
'"'.pSQL($this->date['end']).'"',
(int)$this->exportTypeList[$this->exportSelected]['type'],
'"'.pSQL($this->file).'"'
);
if (!($id_acc_export = Tools::getValue('regenerate')))
$query = '
INSERT INTO `'._DB_PREFIX_.'accounting_export`
('.implode(', ', $keys).')
VALUES('.implode(', ', $values).')';
else
$query = 'UPDATE `'._DB_PREFIX_.'accounting_export`
SET `date` = CURRENT_TIMESTAMP, `file` = "'.pSQL($this->file).'"
WHERE `id_accounting_export` = '.(int)$id_acc_export;
Db::getInstance()->execute($query);
}
/**
* AdminController::postProcess() override
* @see AdminController::postProcess()
*/
public function postProcess()
{
$succeed = false;
if (Tools::isSubmit('accounting_export'))
{
$this->acc_conf = Accounting::getConfiguration();
$this->date['begin'] = Tools::getValue('begin_date');
$this->date['end'] = Tools::getValue('end_date');
$this->exportSelected = Tools::getValue('type');
$this->file_format = Tools::getValue('format');
$this->file = $this->exportSelected.'-'.$this->date['begin'].
'to'.$this->date['end'].'.'.$this->file_format;
$this->downloadFile = $this->downloadDir.$this->file;
// Depends of the number of order and the range dates
// Switch to ajax if there is any problems with time
ini_set('max_execution_time', 0);
if (!in_array($this->file_format, array('csv', 'txt')))
$this->prevent['error'][] = $this->l('Please select file format');
else if (!empty($this->date['begin']) && !empty($this->date['end']) &&
(Tools::getValue('regenerate') || !$this->isAlreadyGenerated()))
{
switch ($this->exportSelected)
{
case 'reconciliation_export':
$succeed = $this->runReconciliationExport();
break;
case 'accounting_export':
$succeed = $this->runGlobalExport();
break;
default:
$this->prevent['error'][] = $this->l('Please select a export type');
}
if ($succeed)
$this->saveRangeDate();
}
else if (!$this->already_generated)
$this->prevent['error'][] = $this->l('Please select the date');
}
else if (($file = Tools::getValue('download')) && file_exists($this->downloadDir.$file))
$this->launchDownloadFile($file);
}
public function isAlreadyGenerated()
{
$query = '
SELECT ae.`type`, ae.`id_accounting_export`
FROM `'._DB_PREFIX_.'accounting_export` ae
WHERE ae.`begin_to` = "'.pSQL($this->date['begin']).'"
AND ae.`end_to` = "'.pSQL($this->date['end']).'"
AND ae.`type` = '.(int)$this->exportTypeList[$this->exportSelected]['type'];
if (($entry = Db::getInstance()->getRow($query)) !== false)
{
if ($this->exportTypeList[$this->exportSelected]['type'] == $entry['type'])
{
$this->prevent['warn'][] = $this->l('This export has already be proceed with this file format');
$this->already_generated = $entry['id_accounting_export'];
}
else
{
$this->prevent['warn'][] = $this->l('This export has already be proceed with a different file format');
$this->already_generated = true;
}
}
return (bool)$this->already_generated;
}
/**
* Write the exported content tout a file
* @var array $list Result of the SQL query
*/
protected function writeExportToFile($list)
{
$this->checkRights();
if (!count($this->errors) && $this->fd !== null)
{
$buffer = '';
foreach ($this->exportTypeList[$this->exportSelected]['fields'] as $key => $translation)
$buffer .= '"'.$translation.'";';
fwrite($this->fd, mb_convert_encoding(rtrim($buffer, ';')."\r\n", 'UTF-16LE'));
// Bufferize line by line and write it to the file
// Todo :: Allow to configure the size of the buffer before flushing it
foreach ($list as $row)
{
$buffer = '';
foreach ($row as $col => $val)
$buffer .= '"'.$val.'";';
fwrite($this->fd, mb_convert_encoding(rtrim($buffer, ';')."\r\n", 'UTF-16LE'));
}
$this->confirmations[] = $this->l('Export has been successfully completed');
return true;
}
return false;
}
/**
* Start the reconciliation export type
*/
protected function runReconciliationExport()
{
$query = '
SELECT
CONCAT(\''.Configuration::get('PS_INVOICE_PREFIX').'\', LPAD(oi.`number`, 6, "0")) AS invoice_number,
CASE
WHEN (a.`company` != "" AND a.`company` IS NOT NULL) THEN a.`company`
ELSE a.`lastname`
END AS wording,
o.`total_paid_real`,
oi.`date_add` as invoice_date,
pcc.`transaction_id`,
CONCAT(\''.pSQL($this->acc_conf['customer_prefix']).'\', LPAD(c.`id_customer`, 6, "0")) AS account_client
FROM `'._DB_PREFIX_.'orders` o
LEFT JOIN `'._DB_PREFIX_.'customer` c ON c.`id_customer` = o.`id_customer`
LEFT JOIN `'._DB_PREFIX_.'address` a ON a.`id_customer` = o.`id_customer`
LEFT JOIN `'._DB_PREFIX_.'order_payment` pcc ON pcc.`id_order` = o.`id_order`
LEFT JOIN `'._DB_PREFIX_.'order_invoice` oi ON oi.`id_order` = o.`id_order`
WHERE o.`valid` = 1
AND oi.`date_add`
BETWEEN \''.pSQL($this->date['begin']).'\'
AND \''.pSQL($this->date['end']).'\'';
$list = Db::getInstance()->executeS($query);
return $this->writeExportToFile($list);
}
/**
* Generate a line for the CSV for the global export
*
* @param $row
* @param $line_number
* @return array
*/
protected function createLine($row, $line_number)
{
$line = array();
// Default Values
$line[0] = $row['invoice_date'];
$line[1] = $this->acc_conf['journal'];
$line[2] = ''; // account number
$line[3] = $row['invoice_number'];
$line[4] = 0.00; // Credit TTC (Total for first csv line, 0 for others)
$line[5] = 0.00; // Debit HT (0 For the first line, used for tax too)
$line[6] = $row['transaction_id'];
$line[7] = $row['payment_type'];
$line[8] = $row['currency_code'];
$line[9] = $row['wording'];
// Override case depending of the whished line
switch ($line_number)
{
case 0:
$line[2] = $row['account_client'];
$line[4] = $row['total_price_tax_incl'];
break;
case 1:
$line[2] = !empty($row['account']) ? $row['account'] :
Configuration::get('default_account_number', null, null, $row['id_shop']);
// Force an empty string if Configuration send false
$line[2] = empty($line[2]) ? '' : $line[2];
$line[5] = $row['product_price_ht'];
break;
case 2:
$line[2] = $row['tax_accounting_account_number'];
$line[5] = $row['tax_total_amount'];
break;
}
return $line;
}
/**
* Build an proper list to be written into the export file
*
* @param $db_details
* @return array
*/
protected function buildGlobalExportlist($db_details)
{
// List use to write data in csv file
$list = array();
// Cache list to merge easily the content with the same accounting for different invoice number
$cache_list = array();
$num = 0;
foreach ($db_details as $row)
{
// Init the list for the current invoice number
if (!array_key_exists($row['invoice_number'], $cache_list))
$cache_list[$row['invoice_number']] = array();
// Need to Generate 3 lines for a product
for ($i = 0; $i < 3; ++$i)
// Create the two first line and check if a tax exist for the last one
if ($i < 2 || ($i == 2 && $row['id_tax'] !== null))
{
// Generate a product line
$line = $this->createLine($row, $i);
if ($i == 0)
$list[$num++] = $line;
else
{
// Check if the account number hadn't already be used for this invoice number
// $line[3] = invoice_number, $line[2] = account_number
if (!array_key_exists($line[2], $cache_list[$line[3]]))
$cache_list[$line[3]][$line[2]] = array();
// If this id_product doesn't exist for this invoice number, then we create it as a cache
if (!in_array($row['id_product'], $cache_list[$line[3]][$line[2]]))
{
$cache_list[$line[3]][$line[2]][$row['id_product']] = array(
'position' => $num,
'id_order' => $row['id_order'],
'id_product_attribute' => $row['id_product_attribute'],
'quantity' => 1,
'advanced_stock_management' => $row['advanced_stock_management']);
$list[$num++] = $line;
}
else
{
// Merge amount retrieving the position in the list of the invoice number
// Some information could change (quantity) for the Stock movement price calculation
$pos = $cache_list[$line[3]][$line[2]][$row['id_product']]['position'];
$cache_list[$line[3]][$line[2]][$row['id_product']]['quantity'] += 1;
if (!$i)
$list[$pos][4] += $line[4];
else
$list[$pos][5] += $line[5];
}
}
}
}
// If advanced stock management enable then we foreach the cache_list to know
// if a product use the system to store back the movement price.
if (Configuration::get('PS_ADVANCED_STOCK_MANAGEMENT'))
foreach ($cache_list as $invoice_list)
foreach ($invoice_list as $product_list)
foreach ($product_list as $id_product => $product_detail)
if ($product_detail['advanced_stock_management'])
{
// Get stock product stock movement detail
$stock_mvt = StockMvt::getNegativeStockMvts(
$product_detail['id_order'],
$id_product,
$product_detail['id_product_attribute'],
$product_detail['quantity']);
// Store new price
$list[$product_detail['position']] = $stock_mvt['price_te'];
}
return $list;
}
/**
* Start the global export type
*
*/
protected function runGlobalExport()
{
$query = '
SELECT
od.`id_order`,
oi.`date_add` as invoice_date,
CASE
WHEN (acc_pzs.`account_number` != "" AND acc_pzs.`account_number` IS NOT NULL) THEN acc_pzs.`account_number`
WHEN (acc_zs.`account_number` != "" AND acc_zs.`account_number` IS NOT NULL) THEN acc_zs.`account_number`
ELSE ""
END AS account,
CONCAT(\''.Configuration::get('PS_INVOICE_PREFIX').'\', LPAD(oi.`number`, 6, "0")) AS invoice_number,
od.`total_price_tax_incl`,
od.`product_price` AS product_price_ht,
pcc.`transaction_id`,
o.`payment` AS payment_type,
currency.`iso_code` AS currency_code,
CONCAT(\''.pSQL($this->acc_conf['customer_prefix']).'\', LPAD(customer.`id_customer`, 6, "0")) AS account_client,
CASE
WHEN (customer.`account_number` != "" AND customer.`account_number` IS NOT NULL) THEN customer.`account_number`
WHEN (a.`company` != "" AND a.`company` IS NOT NULL) THEN a.`company`
ELSE a.`lastname`
END AS wording,
t.`account_number` AS tax_accounting_account_number,
t.`id_tax`,
o.`id_shop`,
odt.`total_amount` AS tax_total_amount,
od.`product_id` AS id_product,
od.`product_attribute_id` as id_product_attribute,
p.`advanced_stock_management`
FROM `'._DB_PREFIX_.'orders` o
LEFT JOIN `'._DB_PREFIX_.'customer` customer ON customer.`id_customer` = o.`id_customer`
LEFT JOIN `'._DB_PREFIX_.'address` a ON a.`id_customer` = o.`id_customer`
LEFT JOIN `'._DB_PREFIX_.'order_payment` pcc ON pcc.`id_order` = o.`id_order`
LEFT JOIN `'._DB_PREFIX_.'order_detail` od ON od.`id_order` = o.`id_order`
LEFT JOIN `'._DB_PREFIX_.'currency` currency ON currency.`id_currency` = o.`id_currency`
LEFT JOIN `'._DB_PREFIX_.'order_detail_tax` odt ON odt.`id_order_detail` = od.`id_order_detail`
LEFT JOIN `'._DB_PREFIX_.'tax` t ON t.`id_tax` = odt.`id_tax`
LEFT JOIN `'._DB_PREFIX_.'country` country ON country.`id_country` = a.`id_country`
LEFT JOIN `'._DB_PREFIX_.'product` p ON p.`id_product` = od.`product_id`
LEFT JOIN `'._DB_PREFIX_.'accounting_product_zone_shop` acc_pzs
ON (acc_pzs.`id_shop` = o.`id_shop`
AND acc_pzs.`id_zone` = country.`id_zone`
AND acc_pzs.`id_product` = od.`product_id`)
LEFT JOIN `'._DB_PREFIX_.'accounting_zone_shop` acc_zs
ON (acc_zs.`id_shop` = o.`id_shop`
AND acc_zs.`id_zone` = country.`id_zone`)
LEFT JOIN `'._DB_PREFIX_.'order_invoice` oi ON oi.id_order = o.id_order
WHERE o.`valid` = 1
AND oi.`date_add`
BETWEEN \''.pSQL($this->date['begin']).'\'
AND \''.pSQL($this->date['end']).'\'
ORDER BY o.`id_order` ASC';
$list = $this->buildGlobalExportlist(Db::getInstance()->executeS($query));
return $this->writeExportToFile($list);
}
/**
* Allow to download the last export file
* @var string File name
*/
protected function launchDownloadFile($fileName)
{
$path = $this->downloadDir.$fileName;
header('Content-length: '.filesize($path));
header('Content-Disposition: attachment; filename="'.$fileName.'"');
// Flush buffered data before reading the file
ob_clean();
flush();
@readfile($path);
exit();
}
}