<?php
/*------------------------------------------------------------------------------
  $Id$

  AbanteCart, Ideal OpenSource Ecommerce Solution
  http://www.AbanteCart.com

  Copyright © 2011-2014 Belavier Commerce LLC

  This source file is subject to Open Software License (OSL 3.0)
  License details is bundled with this package in the file LICENSE.txt.
  It is also available at this URL:
  <http://www.opensource.org/licenses/OSL-3.0>

 UPGRADE NOTE:
   Do not edit or add to this file if you wish to upgrade AbanteCart to newer
   versions in the future. If you wish to customize AbanteCart for your
   needs please refer to http://www.AbanteCart.com for more information.
------------------------------------------------------------------------------*/
if (!defined('DIR_CORE')) {
	header('Location: static_pages/');
}
/** @noinspection PhpUndefinedClassInspection */

/**
 * Load form data, render output
 *
 * Class AForm
 * @property ALayout $layout
 * @property ACache $cache
 * @property ADB $db
 * @property AConfig $config
 * @property AHtml $html
 * @property ASession $session
 * @property ARequest $request
 * @property ALoader $load
 * @property ALanguageManager $language
 * @property ModelLocalisationCountry $model_localisation_country
 *
 */
class AForm {
	/**
	 * @var Registry
	 */
	protected $registry;
	/**
	 * @var array $form - form data array
	 * Array (
	 *      [form_id]
	 *      [form_name]
	 *      [controller]
	 *      [success_page]
	 *      [status]
	 *      [description] )
	 */
	private $form;
	/**
	 * @var array $fields - array of form fields
	 * Array
	 *   (
	 *       [field_id]
	 *       [form_id]
	 *       [field_name]
	 *       [element_type]
	 *       [sort_order]
	 *       [required]
	 *       [status]
	 *       [name]
	 *       [description]
	 *       [value]
	 *   )
	 */
	private $fields;
	/**
	 * @var $groups - fields groups
	 */
	private $groups;
	/**
	 * @var $page_id - current page id
	 */
	public $page_id;
	/**
	 * @var $errors - field_name -=> error
	 */
	protected $errors;
	/**
	 * @var $form_edit_action - ( ST = standard,  HS = highlight save,  HT = highlight )
	 */
	private $form_edit_action;

	/**
	 * @param  string $form_edit_action
	 */
	public function __construct($form_edit_action = '') {
		$this->registry = Registry::getInstance();
		$this->page_id = $this->layout->page_id;
		$this->errors = array();
		$this->form_edit_action = $form_edit_action;
	}

	public function __get($key) {
		return $this->registry->get($key);
	}

	public function __set($key, $value) {
		$this->registry->set($key, $value);
	}

	/**
	 * @param  array $errors - array of validation errors - field_name -=> error
	 * @void
	 */
	public function setErrors($errors) {
		$this->errors = $errors;
	}

	/**
	 * Sets the form and loads the data for the form from the database
	 *
	 * @param string $name
	 * @return null
	 * @internal param $fname - unique form name
	 */
	public function loadFromDb($name) {

		$this->_loadForm($name);
		// if no form return
		if (empty($this->form)) return null;

		$this->_loadFields();
		// if no fields no need to get groups
		if (empty($this->fields)) return null;

		$this->_loadGroups();
	}

	/**
	 * load form data into this->form variable
	 *
	 * @param string $name - unique form name
	 * @return null
	 */
	private function _loadForm($name) {

		$cache_name = 'forms.' . $name;
		$cache_name = preg_replace('/[^a-zA-Z0-9\.]/', '', $cache_name);
		$form = $this->cache->get($cache_name, (int)$this->config->get('storefront_language_id'), (int)$this->config->get('config_store_id'));
		if (isset($form)) {
			$this->form = $form;
			return null;
		}

		$query = $this->db->query("SELECT f.*, fd.description
                                    FROM " . $this->db->table("forms") . " f
                                    LEFT JOIN " . $this->db->table("form_descriptions") . " fd
                                        ON ( f.form_id = fd.form_id AND fd.language_id = '" . (int)$this->config->get('storefront_language_id') . "' )
                                    WHERE f.form_name = '" . $this->db->escape($name) . "'
                                            AND f.status = 1 "
		);

		if (!$query->num_rows) {
			$err = new AError('NOT EXIST Form with name ' . $name);
			$err->toDebug()->toLog();
			return null;
		}
		$this->cache->set($cache_name, $query->row, (int)$this->config->get('storefront_language_id'), (int)$this->config->get('config_store_id'));
		$this->form = $query->row;
	}

	/**
	 * load form fields data into this->fields variable
	 *
	 * @return void
	 */
	private function _loadFields() {

		$cache_name = 'forms.' . $this->form[ 'form_name' ] . '.fields';
		$cache_name = preg_replace('/[^a-zA-Z0-9\.]/', '', $cache_name);
		$fields = $this->cache->get($cache_name, (int)$this->config->get('storefront_language_id'), (int)$this->config->get('config_store_id'));
		if (!is_null($fields)) {
			$this->fields = $fields;
			return null;
		}

		$query = $this->db->query("
            SELECT f.*, fd.name, fd.description, fd.error_text
            FROM " . $this->db->table("fields") . " f
            LEFT JOIN " . $this->db->table("field_descriptions") . " fd
                ON ( f.field_id = fd.field_id AND fd.language_id = '" . (int)$this->config->get('storefront_language_id') . "' )
            WHERE f.form_id = '" . $this->form[ 'form_id' ] . "'
                AND f.status = 1
            ORDER BY f.sort_order"
		);
		$this->fields = array();
		if ($query->num_rows) {
			foreach ($query->rows as $row) {
				if ( has_value($row['settings']) ) {
					$row['settings'] = unserialize($row['settings']);
				}
				$this->fields[ $row[ 'field_id' ] ] = $row;
				$query = $this->db->query("
					SELECT *
					FROM " . $this->db->table("field_values") . " 
					WHERE field_id = '" . $row[ 'field_id' ] . "'
					AND language_id = '" . (int)$this->config->get('storefront_language_id') . "'"
				);
				if ($query->num_rows) {

					$values = unserialize($query->row[ 'value' ]);
					usort($values, array( 'self', '_sort_by_sort_order' ));
					foreach ($values as $value) {
						$this->fields[ $row[ 'field_id' ] ][ 'options' ][ $value[ 'name' ] ] = $value[ 'name' ];
					}
					$this->fields[ $row[ 'field_id' ] ][ 'value' ] = $values[ 0 ][ 'name' ];

				}
			}
		}
		$this->cache->set($cache_name, $this->fields, (int)$this->config->get('storefront_language_id'), (int)$this->config->get('config_store_id'));
	}

	/**
	 * @param array $a
	 * @param array $b
	 * @return int
	 */
	private function _sort_by_sort_order($a, $b) {
		if ($a[ 'sort_order' ] == $b[ 'sort_order' ]) {
			return 0;
		}
		return ($a[ 'sort_order' ] < $b[ 'sort_order' ]) ? -1 : 1;
	}

	/**
	 * load form fields groups data into this->groups variable
	 *
	 * @return void
	 */
	private function _loadGroups() {

		$cache_name = 'forms.' . $this->form[ 'form_name' ] . '.groups';
		$cache_name = preg_replace('/[^a-zA-Z0-9\.]/', '', $cache_name);
		$groups = $this->cache->get($cache_name, (int)$this->config->get('storefront_language_id'), (int)$this->config->get('config_store_id'));
		if (isset($groups)) {
			$this->groups = $groups;
			return null;
		}

		$query = $this->db->query("
            SELECT fg.*, fgd.name, fgd.description
            FROM " . $this->db->table("form_groups") . " g
                LEFT JOIN " . $this->db->table("fields_groups") . " fg ON ( g.group_id = fg.group_id)
                LEFT JOIN " . $this->db->table("fields_group_descriptions") . " fgd ON ( fg.group_id = fgd.group_id AND fgd.language_id = '" . (int)$this->config->get('storefront_language_id') . "' )
            WHERE g.form_id = '" . $this->form[ 'form_id' ] . "'
                AND g.status = 1
            ORDER BY g.sort_order, fg.sort_order"
		);
		$this->groups = array();
		if ($query->num_rows)
			foreach ($query->rows as $row) {
				if (empty($this->groups[ $row[ 'group_id' ] ])) {
					$this->groups[ $row[ 'group_id' ] ] = $row;
				}
				$this->groups[ $row[ 'group_id' ] ][ 'fields' ][ ] = $row[ 'field_id' ];
			}

		$this->cache->set($cache_name, $this->groups, (int)$this->config->get('storefront_language_id'), (int)$this->config->get('config_store_id'));
	}

	/**
	 * return form data
	 *
	 * @return array
	 */
	public function getForm() {
		return $this->form;
	}

	/**
	 * set form data
	 *
	 * @param array $form
	 * @return void
	 */
	public function setForm($form) {
		$this->form = $form;
	}

	/**
	 * get form fields array
	 *
	 * @return array of fields => value
	 */
	public function getFields() {

		$fields = array();

		foreach ($this->fields as $field) {
			$fields[ $field[ 'field_name' ] ] = array(
				'value' => $field[ 'value' ],
				'required' => $field[ 'required' ],
			);
		}

		return $fields;
	}

	/**
	 * Get given field, type, values and selected/default
	 *
	 * @param string $fname
	 * @return array with field data
	 */
	public function getField($fname) {
		foreach ($this->fields as $field) {
			if ($field[ 'field_name' ] == $fname) {
				return array(
					'field_name' => $field[ 'field_name' ],
					'element_type' => $field[ 'element_type' ],
					'required' => $field[ 'required' ],
					'name' => $field[ 'name' ],
					'value' => $field[ 'value' ],
					'settings' => $field['settings'],
					'description' => $field[ 'description' ],
				);
			}
		}

		$err = new AError('NOT EXIST Form field with name ' . $fname);
		$err->toDebug()->toLog();
		return null;
	}

	/**
	 * assign value(s) to given field name
	 *
	 * @param string $fname
	 * @param string $value
	 * @return void
	 */
	public function assign($fname, $value = '') {
		foreach ($this->fields as $key => $field) {
			if ($field[ 'field_name' ] == $fname) {
				$this->fields[ $key ][ 'value' ] = $value;
				break;
			}
		}
	}

	/**
	 * assign array of field with values.
	 *
	 * @param  array $values - array of field name -> value
	 * @return void
	 */
	public function batchAssign($values) {
		foreach ($values as $name => $value) {
			$this->assign($name, $value);
		}
	}

	/**
	 * load values to select, multiselect, checkbox group etc
	 * @param string $fname
	 * @param array $values
	 * @return void
	 */
	public function loadFieldOptions($fname, $values) {
		foreach ($this->fields as $key => $field) {
			if ($field[ 'field_name' ] == $fname) {
				$this->fields[ $key ][ 'options' ] = $values;
				break;
			}
		}
	}

	/**
	 * return field html
	 *
	 * @param array $data - array with field data
	 * @return object  - AHtml form element
	 */
	public function getFieldHtml($data) {
		$data[ 'form' ] = $this->form[ 'form_name' ];
		
		if ($data[ 'type' ] == 'form') {
			$data['javascript'] = $this->addFormJs();
		}
		
		return HtmlElementFactory::create($data);
	}

	/**
	 * Render the form elements only
	 *
	 * @return string html
	 */
	public function loadExtendedFields() {
		return $this->getFormHtml(true);
	}

	/**
	 * add javascript to implement form behaviour based on form_edit_action parameter
	 *
	 * @return string
	 */
	protected function addFormJs() {
		/**
		 * @var AHtml
		 */
		$html = $this->registry->get('html');
		/**
		 * @var ALanguageManager
		 */
		$language = $this->registry->get('language');
		$view = new AView($this->registry, 0);

		switch ($this->form_edit_action) {
			case 'ST': //standards
				$view->batchAssign(
					array(
						'id' => $this->form[ 'form_name' ],
					)
				);
				$output = $view->fetch('form/form_js_st.tpl');
				break;
			case 'HS': //highlight on change and show save button
				$view->batchAssign(
					array(
						'id' => $this->form[ 'form_name' ],
						'button_save' => $language->get('button_save'),
						'button_reset' => $language->get('button_reset'),
						'update' => $this->form[ 'update' ],
						'text_processing' => $language->get('text_processing'),
						'text_saved' => $language->get('text_saved'),
					)
				);
				$output = $view->fetch('form/form_js_hs.tpl');
				break;
			case 'HT': //highlight on change
				$view->batchAssign(
					array(
						'id' => $this->form[ 'form_name' ],
					)
				);
				$output = $view->fetch('form/form_js_ht.tpl');
				break;
			default:
				$output = '';
		}

		return $output;
	}

	/**
	 * Process and render the form with HTML output.
	 *
	 * @param bool $fieldsOnly
	 * @return string html
	 */
	public function getFormHtml($fieldsOnly = false) {

		// if no form was loaded return empty string
		if (empty($this->form)) return '';

		$fields_html = array();
		$view = new AView($this->registry, 0);

		foreach ($this->fields as $field) {

			$data = array(
				'type' => HtmlElementFactory::getElementType($field[ 'element_type' ]),
				'name' => $field[ 'field_name' ],
				'form' => $this->form[ 'form_name' ],
				'attr' => $field[ 'attributes' ],
				'required' => $field[ 'required' ],
				'value' => $field[ 'value' ],
				'options' => $field[ 'options' ],
			);

			switch ($data[ 'type' ]) {
				case 'multiselectbox' :
					$data[ 'name' ] .= '[]';
					break;
				case 'checkboxgroup' :
					$data[ 'name' ] .= '[]';
					break;
				case 'captcha' :
					$data[ 'captcha_url' ] = $this->html->getURL('common/captcha');
					break;
			}
			$item = HtmlElementFactory::create($data);

			switch ($data[ 'type' ]) {
				case 'IPaddress' :
				case 'hidden' :
					$fields_html[ $field[ 'field_id' ] ] = $item->getHtml();
					break;
				default:
					$view->batchAssign(
						array(
							'element_id' => $item->element_id,
							'title' => $field[ 'name' ],
							'description' => (!empty($this->form[ 'description' ]) ? $field[ 'description' ] : ''),
							'error' => (!empty($this->errors[ $field[ 'field_name' ] ]) ? $this->errors[ $field[ 'field_name' ] ] : ''),
							'item_html' => $item->getHtml(),
						)
					);
					$fields_html[ $field[ 'field_id' ] ] = $view->fetch('form/form_field.tpl');
			}
		}

		$output = '';
		if (!empty($this->groups)) {
			foreach ($this->groups as $group) {
				$view->batchAssign(
					array(
						'group' => $group,
						'fields_html' => $fields_html,
					)
				);
				$output .= $view->fetch('form/form_group.tpl');
			}
		} else {
			$view->batchAssign(array( 'fields_html' => $fields_html ));
			$output .= $view->fetch('form/form_no_group.tpl');
		}

		// add submit button and form open/close tag
		if (!$fieldsOnly) {
			$data = array(
				'type' => 'submit',
				'form' => $this->form[ 'form_name' ],
				'name' => $this->language->get('button_submit'),
			);
			$submit = HtmlElementFactory::create($data);

			$data = array(
				'type' => 'form',
				'name' => $this->form[ 'form_name' ],
				'attr' => ' class="form" ',
				'action' => $this->html->getSecureURL($this->form[ 'controller' ],'&form_id='.$this->form['form_id'],true),
			);
			$form_open = HtmlElementFactory::create($data);
			$form_close = $view->fetch('form/form_close.tpl');

			$js = $this->addFormJs();

			$view->batchAssign(
				array(
					'description' => $this->form[ 'description' ],
					'form' => $output,
					'form_open' => $js . $form_open->getHtml(),
					'form_close' => $form_close,
					'submit' => $submit,
				)
			);
			$output = $view->fetch('form/form.tpl');
		}

		return $output;
	}

	/**
	 * method for validation of data based on form fields requirements
	 * @param array $data - usually it's a $_POST
	 * @return array - array with error text for each of invalid field data
	 */
	public function validateFormData($data = array()){
		$errors = array();
		$this->_loadFields();
		$this->load->language('checkout/cart'); // load language for file upload text errors

		foreach($this->fields as $field){
			// for multivalue required fields
			if(in_array($field['element_type'], HtmlElementFactory::getMultivalueElements())
				&& !sizeof($data[$field['field_name']])
				&& $field['required']=='Y'
			){
				$errors[$field['field_name']] = $field['name'].' '.$this->language->get('text_field_required');
			}
			// for required string values
			if($field['required']=='Y' && !in_array($field['element_type'],array('K','U'))){
				if(!is_array( $data[$field['field_name']] )){
					$data[$field['field_name']] = trim($data[$field['field_name']]);
					if($data[$field['field_name']]==''){	//if empty string!
						$errors[$field['field_name']] = $field['name'].' '.$this->language->get('text_field_required');
					}
				}else{
					if(!$data[$field['field_name']]){	// if empty array
						$errors[$field['field_name']] = $field['name'].' '.$this->language->get('text_field_required');
					}
				}
			}
			// check by regexp
			if(has_value($field['regexp_pattern'])){
				if(!is_array($data[$field['field_name']])){ //for string value
					if(!preg_match($field['regexp_pattern'],$data[$field['field_name']])){
						if( ($data[$field['field_name']] && $field['required']!='Y') || $field['required']=='Y'){ // show error only for field with value or required
							$errors[$field['field_name']] .= ' '. $field['error_text'];
						}
					}
				}else{ // for array's values
					foreach($data[$field['field_name']] as $dd){
						if(!preg_match($field['regexp_pattern'],$dd)){
							if( ($dd && $field['required']!='Y') || $field['required']=='Y'){
								$errors[$field['field_name']] .= ' '. $field['error_text'];
							}
							break;
						}
					}
				}
			}

			//for captcha
			if($field['element_type']=='K'
				&& (!isset($this->session->data['captcha']) || $this->session->data['captcha'] != $data[$field['field_name']])
			){
				$errors[$field['field_name']] = $this->language->get('error_captcha');
			}
			// for file
			if($field['element_type']=='U' && ($this->request->files[$field['field_name']]['tmp_name'] || $field['required']=='Y') ){
				$fm = new AFile();
				$file_path_info = $fm->getUploadFilePath($data['settings']['directory'],
														$this->request->files[$field['field_name']]['name']);
				$file_data = array(
					'name' => $file_path_info['name'],
					'path' => $file_path_info['path'],
					'type' => $this->request->files[$field['field_name']]['type'],
					'tmp_name' => $this->request->files[$field['field_name']]['tmp_name'],
					'error' => $this->request->files[$field['field_name']]['error'],
					'size' => $this->request->files[$field['field_name']]['size'],
				);

				$file_errors = $fm->validateFileOption($field['settings'], $file_data);

				if ($file_errors) {
					$errors[$field['field_name']] .= implode(' ', $file_errors);
				}
			}
		}
		return $errors;
	}

	/**
	 * process uploads of files from form file element
	 * @param array $files - usually it's a $_FILES array
	 * @return array - list of absolute pathes of moved files
	 */
	public function processFileUploads($files=array()){
		if($this->fields){
			$this->_loadFields();
		}

		$output = array();
		foreach($this->fields as $field){
			if($field['element_type']!='U'){ continue;}

			$fm = new AFile();
			$file_path_info = $fm->getUploadFilePath($field['settings']['directory'],
													 $files[$field['field_name']]['name']);

			$result = move_uploaded_file($files[$field['field_name']]['tmp_name'], $file_path_info['path']);

			if($result){
				$output[$field['field_name']] = array('display_name'=>$field['name'],
													  'path'=>$file_path_info['path']);
			}else{
				$err = new AError("AForm error: can't to move uploaded file ".$files[$field['field_name']]['tmp_name']." to ".$file_path_info['path']);
				$err->toLog()->toDebug();
			}

			$dataset = new ADataset('file_uploads', 'admin');
			$dataset->addRows(
				array(
					'date_added' => date("Y-m-d H:i:s", time()),
					'name' => $file_path_info['name'],
					'type' => $files[$field['field_name']]['type'],
					'section' => 'AForm:'.$this->form[ 'form_name' ].":".$field['field_name'],
					'section_id' => '',
					'path' => $file_path_info['path'],
				)
			);
		}
		return $output;
	}
}