encoding = in_array(Tools::strtoupper($encoding), PayzenApi::$SUPPORTED_ENCODINGS) ?
Tools::strtoupper($encoding) : 'UTF-8';
// parameters' regular expressions
$ans = '[^<>]'; // Any character (except the dreadful "<" and ">")
$an63 = '#^[A-Za-z0-9]{0,63}$#u';
$ans255 = '#^' . $ans . '{0,255}$#u';
$ans127 = '#^' . $ans . '{0,127}$#u';
$supzero = '[1-9]\d*';
$regex_payment_cfg = '#^(SINGLE|MULTI:first=\d+;count=' . $supzero . ';period=' . $supzero . ')$#u';
// AAAAMMJJhhmmss
$regex_trans_date = '#^\d{4}(1[0-2]|0[1-9])(3[01]|[1-2]\d|0[1-9])(2[0-3]|[0-1]\d)([0-5]\d){2}$#u';
$regex_mail = '#^[^@]+@[^@]+\.\w{2,4}$#u'; // TODO plus restrictif
$regex_params = '#^([^&=]+=[^&=]*)?(&[^&=]+=[^&=]*)*$#u'; // name1=value1&name2=value2...
$regex_ship_type = '#^RECLAIM_IN_SHOP|RELAY_POINT|RECLAIM_IN_STATION|PACKAGE_DELIVERY_COMPANY|ETICKET$#u';
// defining all parameters and setting formats and default values
$this->addField('signature', 'Signature', '#^[0-9a-f]{40}$#u', true);
$this->addField('vads_action_mode', 'Action mode', '#^INTERACTIVE|SILENT$#u', true, 11);
$this->addField('vads_amount', 'Amount', '#^' . $supzero . '$#u', true);
$this->addField('vads_available_languages', 'Available languages', '#^(|[A-Za-z]{2}(;[A-Za-z]{2})*)$#u', false, 2);
$this->addField('vads_capture_delay', 'Capture delay', '#^\d*$#u');
$this->addField('vads_card_number', 'Card number', '#^\d{13,19}$#u');
$this->addField('vads_contracts', 'Contracts', $ans255);
$this->addField('vads_contrib', 'Contribution', $ans255);
$this->addField('vads_ctx_mode', 'Mode', '#^TEST|PRODUCTION$#u', true);
$this->addField('vads_currency', 'Currency', '#^\d{3}$#u', true, 3);
$this->addField('vads_cust_address', 'Customer address', $ans255);
$this->addField('vads_cust_antecedents', 'Customer history', '#^NONE|NO_INCIDENT|INCIDENT$#u');
$this->addField('vads_cust_cell_phone', 'Customer cell phone', $an63, false, 63);
$this->addField('vads_cust_city', 'Customer city', '#^' . $ans . '{0,63}$#u', false, 63);
$this->addField('vads_cust_country', 'Customer country', '#^[A-Za-z]{2}$#u', false, 2);
$this->addField('vads_cust_email', 'Customer email', $regex_mail, false, 127);
$this->addField('vads_cust_first_name', 'Customer first name', $an63, false, 63);
$this->addField('vads_cust_id', 'Customer id', $an63, false, 63);
$this->addField('vads_cust_last_name', 'Customer last name', $an63, false, 63);
$this->addField('vads_cust_legal_name', 'Customer legal name', '#^' . $ans . '{0,100}$#u', false, 100);
$this->addField('vads_cust_name', 'Customer name', $ans127, false, 127);
$this->addField('vads_cust_phone', 'Customer phone', $an63, false, 63);
$this->addField('vads_cust_state', 'Customer state/region', '#^' . $ans . '{0,63}$#u', false, 63);
$this->addField('vads_cust_status', 'Customer status (private or company)', '#^PRIVATE|COMPANY$#u', false, 7);
$this->addField('vads_cust_title', 'Customer title', '#^' . $ans . '{0,63}$#u', false, 63);
$this->addField('vads_cust_zip', 'Customer zip code', $an63, false, 63);
$this->addField('vads_cvv', 'Card verification number', '#^\d{3,4}$#u');
$this->addField('vads_expiry_month', 'Month of card expiration', '#^\d[0-2]{1}$#u');
$this->addField('vads_expiry_year', 'Year of card expiration', '#^20[0-9]{2}$#u');
$this->addField('vads_identifier', 'Identifier', '#^'.$ans.'{0,50}$#u', false, 50);
$this->addField('vads_insurance_amount', 'The amount of insurance', '#^' . $supzero . '$#u', false, 12);
$this->addField('vads_language', 'Language', '#^[A-Za-z]{2}$#u', false, 2);
$this->addField('vads_nb_products', 'Number of products', '#^' . $supzero . '$#u', false);
$this->addField('vads_order_id', 'Order id', '#^[A-za-z0-9]{0,12}$#u', false, 12);
$this->addField('vads_order_info', 'Order info', $ans255);
$this->addField('vads_order_info2', 'Order info 2', $ans255);
$this->addField('vads_order_info3', 'Order info 3', $ans255);
$this->addField('vads_page_action', 'Page action', '#^PAYMENT$#u', true, 7);
$this->addField('vads_payment_cards', 'Payment cards', '#^([A-Za-z0-9\-_]+;)*[A-Za-z0-9\-_]*$#u', false, 127);
$this->addField('vads_payment_config', 'Payment config', $regex_payment_cfg, true);
$this->addField('vads_payment_src', 'Payment source', '#^$#u', false, 0);
$this->addField('vads_redirect_error_message', 'Redirection error message', $ans255, false);
$this->addField('vads_redirect_error_timeout', 'Redirection error timeout', $ans255, false);
$this->addField('vads_redirect_success_message', 'Redirection success message', $ans255, false);
$this->addField('vads_redirect_success_timeout', 'Redirection success timeout', $ans255, false);
$this->addField('vads_return_get_params', 'GET return parameters', $regex_params, false);
$this->addField('vads_return_mode', 'Return mode', '#^NONE|GET|POST$#u', false, 4);
$this->addField('vads_return_post_params', 'POST return parameters', $regex_params, false);
$this->addField('vads_ship_to_city', 'Shipping city', '#^' . $ans . '{0,63}$#u', false, 63);
$this->addField('vads_ship_to_country', 'Shipping country', '#^[A-Za-z]{2}$#u', false, 2);
$this->addField('vads_ship_to_delay', 'Delay of shipping', '#^INFERIOR_EQUALS|SUPERIOR|IMMEDIATE|ALWAYS$#u', false, 15);
$this->addField('vads_ship_to_delivery_company_name', 'Name of the delivery company', $ans127, false, 127);
$this->addField('vads_ship_to_first_name', 'Shipping first name', $an63, false, 63);
$this->addField('vads_ship_to_last_name', 'Shipping last name', $an63, false, 63);
$this->addField('vads_ship_to_legal_name', 'Shipping legal name', '#^' . $ans . '{0,100}$#u', false, 100);
$this->addField('vads_ship_to_name', 'Shipping name', '#^' . $ans . '{0,127}$#u', false, 127);
$this->addField('vads_ship_to_phone_num', 'Shipping phone', $ans255, false, 63);
$this->addField('vads_ship_to_speed', 'Speed of the shipping method', '#^STANDARD|EXPRESS|PRIORITY$#u', false, 8);
$this->addField('vads_ship_to_state', 'Shipping state', $an63, false, 63);
$this->addField('vads_ship_to_status', 'Shipping status (private or company)', '#^PRIVATE|COMPANY$#u', false, 7);
$this->addField('vads_ship_to_street', 'Shipping street', $ans127, false, 127);
$this->addField('vads_ship_to_street2', 'Shipping street (2)', $ans127, false, 127);
$this->addField('vads_ship_to_type', 'Type of the shipping method', $regex_ship_type, false, 24);
$this->addField('vads_ship_to_zip', 'Shipping zip code', $an63, false, 63);
$this->addField('vads_shipping_amount', 'The amount of shipping', '#^' . $supzero . '$#u', false, 12);
$this->addField('vads_shop_name', 'Shop name', $ans127);
$this->addField('vads_shop_url', 'Shop URL', '#^https?://(\w+(:\w*)?@)?(\S+)(:[0-9]+)?[\w\#!:.?+=&%@`~;,|!\-/]*$#u');
$this->addField('vads_site_id', 'Shop ID', '#^\d{8}$#u', true, 8);
$this->addField('vads_tax_amount', 'The amount of tax', '#^' . $supzero . '$#u', false, 12);
$this->addField('vads_theme_config', 'Theme configuration', '#^[^;=]+=[^;=]*(;[^;=]+=[^;=]*)*;?$#u');
$this->addField('vads_threeds_mpi', 'Enable / disable 3D Secure', '#^[0-2]$#u', false);
$this->addField('vads_trans_date', 'Transaction date', $regex_trans_date, true, 14);
$this->addField('vads_trans_id', 'Transaction ID', '#^[0-8]\d{5}$#u', true, 6);
$this->addField('vads_url_cancel', 'Cancel URL', $ans127, false, 127);
$this->addField('vads_url_error', 'Error URL', $ans127, false, 127);
$this->addField('vads_url_referral', 'Referral URL', $ans127, false, 127);
$this->addField('vads_url_refused', 'Refused URL', $ans127, false, 127);
$this->addField('vads_url_return', 'Return URL', $ans127, false, 127);
$this->addField('vads_url_success', 'Success URL', $ans127, false, 127);
$this->addField('vads_user_info', 'User info', $ans255);
$this->addField('vads_validation_mode', 'Validation mode', '#^[01]?$#u', false, 1);
$this->addField('vads_version', 'Platform version', '#^V2$#u', true, 2);
// set some default values
$this->set('vads_version', 'V2');
$this->set('vads_page_action', 'PAYMENT');
$this->set('vads_action_mode', 'INTERACTIVE');
$this->set('vads_payment_config', 'SINGLE');
$timestamp = time();
$this->set('vads_trans_id', PayzenApi::generateTransId($timestamp));
$this->set('vads_trans_date', gmdate('YmdHis', $timestamp));
}
/**
* Shortcut function used in constructor to build requestParameters.
*
* @param string $name
* @param string $label
* @param string $regex
* @param boolean $required
* @param mixed $value
* @return boolean
*/
private function addField($name, $label, $regex, $required = false, $length = 255, $value = null)
{
$this->requestParameters[$name] = new PayzenField($name, $label, $regex, $required, $length);
if ($value !== null) {
return $this->set($name, $value);
}
return true;
}
/**
* Shortcut for setting multiple values with one array.
*
* @param array[string][mixed] $parameters
* @return boolean
*/
public function setFromArray($parameters)
{
$ok = true;
foreach ($parameters as $name => $value) {
$ok &= $this->set($name, $value);
}
return $ok;
}
/**
* General getter that retrieves a request parameter with its name.
* Adds "vads_" to the name if necessary.
* Example : $site_id = $request->get('site_id');
*
* @param string $name
* @return mixed
*/
public function get($name)
{
if (! $name || ! is_string($name)) {
return null;
}
// shortcut notation compatibility
$name = (Tools::substr($name, 0, 5) != 'vads_') ? 'vads_' . $name : $name;
if ($name == 'vads_key_test') {
return $this->keyTest;
} elseif ($name == 'vads_key_prod') {
return $this->keyProd;
} elseif ($name == 'vads_platform_url') {
return $this->platformUrl;
} elseif ($name == 'vads_redirect_enabled') {
return $this->redirectEnabled;
} elseif (key_exists($name, $this->requestParameters)) {
return $this->requestParameters[$name]->getValue();
} else {
return null;
}
}
/**
* Set a request parameter with its name and the provided value.
* Adds "vads_" to the name if necessary.
* Example : $request->set('site_id', '12345678');
*
* @param string $name
* @param mixed $value
* @return boolean
*/
public function set($name, $value)
{
if (! $name || ! is_string($name)) {
return false;
}
// shortcut notation compatibility
$name = (Tools::substr($name, 0, 5) != 'vads_') ? 'vads_' . $name : $name;
if (is_string($value)) {
// trim value before set
$value = trim($value);
// convert the parameters' values if they are not encoded in UTF-8
if ($this->encoding !== 'UTF-8') {
$value = iconv($this->encoding, 'UTF-8', $value);
}
// delete < and > characters from $value and replace multiple spaces by one
$value = preg_replace(array('#[<>]+#u', '#\s+#u'), array('', ' '), $value);
}
// search appropriate setter
if ($name == 'vads_key_test') {
return $this->setCertificate($value, 'TEST');
} elseif ($name == 'vads_key_prod') {
return $this->setCertificate($value, 'PRODUCTION');
} elseif ($name == 'vads_platform_url') {
return $this->setPlatformUrl($value);
} elseif ($name == 'vads_redirect_enabled') {
return $this->setRedirectEnabled($value);
} elseif (key_exists($name, $this->requestParameters)) {
return $this->requestParameters[$name]->setValue($value);
} else {
return false;
}
}
/**
* Set multi payment configuration.
*
* @param $total_in_cents total order amount in cents
* @param $first_in_cents amount of the first payment in cents
* @param $count total number of payments
* @param $period number of days between 2 payments
* @return boolean
*/
public function setMultiPayment($total_in_cents = null, $first_in_cents = null, $count = 3, $period = 30)
{
$result = true;
if (is_numeric($count) && $count > 1 && is_numeric($period) && $period > 0) {
// default values for first and total
$total_in_cents = ($total_in_cents === null) ? $this->get('amount') : $total_in_cents;
$first_in_cents = ($first_in_cents === null) ? round($total_in_cents / $count) : $first_in_cents;
// check parameters
if (is_numeric($total_in_cents) && $total_in_cents > $first_in_cents
&& $total_in_cents > 0 && is_numeric($first_in_cents) && $first_in_cents > 0) {
// set value to payment_config
$payment_config = 'MULTI:first=' . $first_in_cents . ';count=' . $count . ';period=' . $period;
$result &= $this->set('amount', $total_in_cents);
$result &= $this->set('payment_config', $payment_config);
}
}
return $result;
}
/**
* Set target URL of the payment form.
*
* @param string $url
* @return boolean
*/
public function setPlatformUrl($url)
{
if (preg_match('#^https?://([^/]+/)+$#u', $url)) {
$this->platformUrl = $url;
return true;
} else {
return false;
}
}
/**
* Enable/disable vads_redirect_* parameters.
*
* @param mixed $enabled
* false, 0, null, negative integer or 'false' to disable
* @return boolean
*/
public function setRedirectEnabled($enabled)
{
$this->redirectEnabled = ($enabled && $enabled != '0' && Tools::strtolower($enabled) != 'false');
return true;
}
/**
* Set TEST or PRODUCTION certificate.
*
* @param string $key
* @param string $mode
* @return boolean
*/
public function setCertificate($key, $mode)
{
if ($mode == 'TEST') {
$this->keyTest = $key;
} elseif ($mode == 'PRODUCTION') {
$this->keyProd = $key;
} else {
return false;
}
return true;
}
/**
* Add a product info as request parameters.
*
* @param string $label
* @param int $amount
* @param int $qty
* @param string $ref
* @param string $type
* @return boolean
*/
public function addProduct($label, $amount, $qty, $ref, $type)
{
$index = $this->get('nb_products') ? $this->get('nb_products') : 0;
$ok = true;
// add product info as request parameters
$ok &= $this->addField('vads_product_label' . $index, 'Product label', '#^[^<>"+-]{0,255}$#u', false, 255, $label);
$ok &= $this->addField('vads_product_amount' . $index, 'Product amount', '#^[1-9]\d*$#u', false, 12, $amount);
$ok &= $this->addField('vads_product_qty' . $index, 'Product quantity', '#^[1-9]\d*$#u', false, 255, $qty);
$ok &= $this->addField('vads_product_ref' . $index, 'Product reference', '#^[A-Za-z0-9]{0,64}$#u', false, 64, $ref);
$ok &= $this->addField('vads_product_type' . $index, 'Product type', '#^' . implode('|', self::$ACCORD_CATEGORIES) . '$#u', false, 30, $type);
// increment the number of products
$ok &= $this->set('nb_products', $index + 1);
return $ok;
}
/**
* Add extra info as a request parameter.
*
* @param string $key
* @param string $value
* @return boolean
*/
public function addExtInfo($key, $value)
{
return $this->addField('vads_ext_info_' . $key, 'Extra info ' . $key, '#^.{0,255}$#u', false, 255, $value);
}
/**
* Return certificate according to current mode, false if mode was not set.
*
* @return string|boolean
*/
public function getCertificate()
{
switch ($this->requestParameters['vads_ctx_mode']->getValue()) {
case 'TEST':
return $this->keyTest;
case 'PRODUCTION':
return $this->keyProd;
default:
return false;
}
}
/**
* Generate signature from a list of PayzenField.
*
* @param array[string][PayzenField] $fields
* @return string
*/
private function generateSignature($fields = null, $hashed = true)
{
if (! is_array($fields)) {
$fields = $this->requestParameters;
}
$params = array();
foreach ($fields as $field) {
if ($field->isRequired() || $field->isFilled()) {
$params[$field->getName()] = $field->getValue();
}
}
return PayzenApi::sign($params, $this->getCertificate(), $hashed);
}
/**
* Unset the value of optionnal fields if they are invalid.
*/
public function clearInvalidOptionnalFields()
{
$fields = $this->getRequestFields();
foreach ($fields as $field) {
if (! $field->isValid() && ! $field->isRequired()) {
$field->setValue(null);
}
}
}
/**
* Check all payment fields.
*
* @param array[string] $errors will be filled with the names of invalid fields
* @return boolean
*/
public function isRequestReady(&$errors = null)
{
$errors = is_array($errors) ? $errors : array();
foreach ($this->getRequestFields() as $field) {
if (! $field->isValid()) {
$errors[] = $field->getName();
}
}
return count($errors) == 0;
}
/**
* Return the list of fields to send to the payment platform.
*
* @return array[string][PayzenField] a list of PayzenField
*/
public function getRequestFields()
{
$fields = $this->requestParameters;
// filter redirect_* parameters if redirect is disabled
if (! $this->redirectEnabled) {
$redirect_fields = array(
'vads_redirect_success_timeout',
'vads_redirect_success_message',
'vads_redirect_error_timeout',
'vads_redirect_error_message'
);
foreach ($redirect_fields as $field_name) {
unset($fields[$field_name]);
}
}
foreach ($fields as $field_name => $field) {
if (! $field->isFilled() && ! $field->isRequired()) {
unset($fields[$field_name]);
}
}
// compute signature
$fields['signature']->setValue($this->generateSignature($fields));
// return the list of fields
return $fields;
}
/**
* Return the URL of the payment page with urlencoded parameters (GET-like URL).
*
* @return string
*/
public function getRequestUrl()
{
$fields = $this->getRequestFields();
$url = $this->platformUrl . '?';
foreach ($fields as $field) {
if (! $field->isFilled()) {
continue;
}
$url .= $field->getName() . '=' . rawurlencode($field->getValue()) . '&';
}
$url = Tools::substr($url, 0, - 1); // remove last &
return $url;
}
/**
* Return the HTML form to send to the payment platform.
*
* @param string $form_add
* @param string $input_type
* @param string $input_add
* @param string $btn_type
* @param string $btn_value
* @param string $btn_add
* @return string
*/
public function getRequestHtmlForm(
$form_add = '',
$input_type = 'hidden',
$input_add = '',
$btn_type = 'submit',
$btn_value = 'Pay',
$btn_add = '',
$escape = true
) {
$html = '';
$html .= '';
return $html;
}
/**
* Return the HTML inputs of fields to send to the payment page.
*
* @param string $input_type
* @param string $input_add
* @return string
*/
public function getRequestHtmlFields($input_type = 'hidden', $input_add = '', $escape = true)
{
$fields = $this->getRequestFields();
$html = '';
$format = '\n";
foreach ($fields as $field) {
if (! $field->isFilled()) {
continue;
}
// convert special chars to HTML entities to avoid data truncation
if ($escape) {
$value = htmlspecialchars($field->getValue(), ENT_QUOTES, 'UTF-8');
}
$html .= sprintf($format, $field->getName(), $value);
}
return $html;
}
/**
* Return the html fields to send to the payment page as a key/value array.
*
* @param bool $for_log
* @return array[string][string]
*/
public function getRequestFieldsArray($for_log = false, $escape = true)
{
$fields = $this->getRequestFields();
$sensitive_data = array('vads_card_number', 'vads_cvv', 'vads_expiry_month', 'vads_expiry_year');
$result = array();
foreach ($fields as $field) {
if (! $field->isFilled()) {
continue;
}
$value = $field->getValue();
if ($for_log && in_array($field->getName(), $sensitive_data)) {
$value = str_repeat('*', Tools::strlen($value));
}
// convert special chars to HTML entities to avoid data truncation
if ($escape) {
$value = htmlspecialchars($value, ENT_QUOTES, 'UTF-8');
}
$result[$field->getName()] = $value;
}
return $result;
}
}
}