PrestaShop /controllers/admin/AdminDashboardController.php

Language PHP Lines 385
MD5 Hash 18c118fc0465699c58b35f3028ee8e86
Repository https://github.com/netplayer/PrestaShop.git View Raw File View Project SPDX
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
<?php
/*
* 2007-2014 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-2014 PrestaShop SA
*  @license    http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
*  International Registered Trademark & Property of PrestaShop SA
*/

class AdminDashboardControllerCore extends AdminController
{
	public function __construct()
	{
		$this->bootstrap = true;
		$this->display = 'view';

		parent::__construct();
		
		if (Tools::isSubmit('profitability_conf') || Tools::isSubmit('submitOptionsconfiguration'))
			$this->fields_options = $this->getOptionFields();
	}

	public function setMedia()
	{
		parent::setMedia();

		$this->addJqueryUI('ui.datepicker');
		$this->addJS(array(
			_PS_JS_DIR_.'vendor/d3.v3.min.js',
			__PS_BASE_URI__.$this->admin_webpath.'/themes/'.$this->bo_theme.'/js/vendor/nv.d3.min.js',
			_PS_JS_DIR_.'/admin-dashboard.js',
		));
		$this->addCSS(__PS_BASE_URI__.$this->admin_webpath.'/themes/'.$this->bo_theme.'/css/vendor/nv.d3.css');
	}

	public function initPageHeaderToolbar()
	{
		parent::initPageHeaderToolbar();

		$this->page_header_toolbar_title = $this->l('Dashboard');
		$this->page_header_toolbar_btn = array();
	}
	
	protected function getOptionFields()
	{
		$forms = array();
		$currency = new Currency(Configuration::get('PS_CURRENCY_DEFAULT'));
		$carriers = Carrier::getCarriers($this->context->language->id, true);
		$modules = Module::getModulesOnDisk(true);
		
		$forms = array(
			'payment' => array('title' => $this->l('Average bank fees per payment method'), 'id' => 'payment'),
			'carriers' => array('title' => $this->l('Average shipping fees per shipping method'), 'id' => 'carriers'),
			'other' => array('title' => $this->l('Other settings'), 'id' => 'other')
		);
		foreach ($forms as &$form)
		{
			$form['icon'] = 'tab-preferences';
			$form['fields'] = array();
			$form['submit'] = array('title' => $this->l('Save'));
		}

		foreach ($modules as $module)
			if (isset($module->tab) && $module->tab == 'payments_gateways' && $module->id)
			{
				$moduleClass = Module::getInstanceByName($module->name);
				if (!$moduleClass->isEnabledForShopContext())
					continue;

				$forms['payment']['fields']['CONF_'.strtoupper($module->name).'_FIXED'] = array(
					'title' => $module->displayName,
					'desc' => sprintf($this->l('Choose a fixed fee for each order placed in %1$s with %2$s.'), $currency->iso_code, $module->displayName),
					'validation' => 'isPrice',
					'cast' => 'floatval',
					'type' => 'text',
					'defaultValue' => '0',
					'suffix' => $currency->iso_code
				);
				$forms['payment']['fields']['CONF_'.strtoupper($module->name).'_VAR'] = array(
					'title' => $module->displayName,
					'desc' => sprintf($this->l('Choose a variable fee for each order placed in %1$s with %2$s. It will be applied on the total paid with taxes.'), $currency->iso_code, $module->displayName),
					'validation' => 'isPercentage',
					'cast' => 'floatval',
					'type' => 'text',
					'defaultValue' => '0',
					'suffix' => '%'
				);
				
				if (Currency::isMultiCurrencyActivated())
				{
					$forms['payment']['fields']['CONF_'.strtoupper($module->name).'_FIXED_FOREIGN'] = array(
						'title' => $module->displayName,
						'desc' => sprintf($this->l('Choose a fixed fee for each order placed with a foreign currency with %s.'), $module->displayName),
						'validation' => 'isPrice',
						'cast' => 'floatval',
						'type' => 'text',
						'defaultValue' => '0',
						'suffix' => $currency->iso_code
					);
					$forms['payment']['fields']['CONF_'.strtoupper($module->name).'_VAR_FOREIGN'] = array(
						'title' => $module->displayName,
						'desc' => sprintf($this->l('Choose a variable fee for each order placed with a foreign currency with %s. It will be applied on the total paid with taxes.'), $module->displayName),
						'validation' => 'isPercentage',
						'cast' => 'floatval',
						'type' => 'text',
						'defaultValue' => '0',
						'suffix' => '%'
					);
				}
			}

		foreach ($carriers as $carrier)
		{
			$forms['carriers']['fields']['CONF_'.strtoupper($carrier['id_reference']).'_SHIP'] = array(
				'title' => $carrier['name'],
				'desc' => sprintf($this->l('For the carrier named %s, indicate the domestic delivery costs  in percentage of the price charged to customers.'), $carrier['name']),
				'validation' => 'isPercentage',
				'cast' => 'floatval',
				'type' => 'text',
				'defaultValue' => '0',
				'suffix' => '%'
			);
			$forms['carriers']['fields']['CONF_'.strtoupper($carrier['id_reference']).'_SHIP_OVERSEAS'] = array(
				'title' => $carrier['name'],
				'desc' => sprintf($this->l('For the carrier named %s, indicate the overseas delivery costs in percentage of the price charged to customers.'), $carrier['name']),
				'validation' => 'isPercentage',
				'cast' => 'floatval',
				'type' => 'text',
				'defaultValue' => '0',
				'suffix' => '%'
			);
		}

		$forms['carriers']['description'] = $this->l('Method: Indicate the percentage of your carrier margin. For example, if you charge $10 of shipping fees to your customer for each shipment, but you really pay $4 to this carrier, then you should indicate "40" in the percentage field.');

		$forms['other']['fields']['CONF_AVERAGE_PRODUCT_MARGIN'] = array(
			'title' => $this->l('Average gross margin'),
			'desc' => $this->l('You should calculate this percentage as follows: ((total sales revenue) - (cost of goods sold)) / (total sales revenue) * 100. This value is only used to calculate the Dashboard approximate gross margin, if you do not specify the wholesale price for each product.'),
			'validation' => 'isPercentage',
			'cast' => 'intval',
			'type' => 'text',
			'defaultValue' => '0',
			'suffix' => '%'
		);

		$forms['other']['fields']['CONF_ORDER_FIXED'] = array(
			'title' => $this->l('Other fees per order'),
			'desc' => $this->l('You should calculate this value by making the sum of all of your additional costs per order.'),
			'validation' => 'isPrice',
			'cast' => 'floatval',
			'type' => 'text',
			'defaultValue' => '0',
			'suffix' => $currency->iso_code
		);

		return $forms;
	}

	public function renderView()
	{
		if (Tools::isSubmit('profitability_conf'))
			return parent::renderOptions();

		// $translations = array(
		// 	'Calendar' => $this->l('Calendar', 'AdminStatsTab'),
		// 	'Day' => $this->l('Day', 'AdminStatsTab'),
		// 	'Month' => $this->l('Month', 'AdminStatsTab'),
		// 	'Year' => $this->l('Year', 'AdminStatsTab'),
		// 	'From' => $this->l('From:', 'AdminStatsTab'),
		// 	'To' => $this->l('To:', 'AdminStatsTab'),
		// 	'Save' => $this->l('Save', 'AdminStatsTab')
		// );

		$calendar_helper = new HelperCalendar();

		$calendar_helper->setDateFrom(Tools::getValue('date_from', $this->context->employee->stats_date_from));
		$calendar_helper->setDateTo(Tools::getValue('date_to', $this->context->employee->stats_date_to));

		$stats_compare_from = $this->context->employee->stats_compare_from;
		$stats_compare_to = $this->context->employee->stats_compare_to;

		if (is_null($stats_compare_from) || $stats_compare_from == '0000-00-00')
			$stats_compare_from = null;

		if (is_null($stats_compare_to) || $stats_compare_to == '0000-00-00')
			$stats_compare_to = null;

		$calendar_helper->setCompareDateFrom($stats_compare_from);
		$calendar_helper->setCompareDateTo($stats_compare_to);
		$calendar_helper->setCompareOption(Tools::getValue('compare_date_option', $this->context->employee->stats_compare_option));

		$params = array(
			'date_from' => $this->context->employee->stats_date_from,
			'date_to' => $this->context->employee->stats_date_to
		);
		
		$this->tpl_view_vars = array(
			'date_from' => $this->context->employee->stats_date_from,
			'date_to' => $this->context->employee->stats_date_to,
			'hookDashboardZoneOne' => Hook::exec('dashboardZoneOne', $params),
			'hookDashboardZoneTwo' => Hook::exec('dashboardZoneTwo', $params),
			//'translations' => $translations,
			'action' => '#',
			'warning' => $this->getWarningDomainName(),
			'new_version_url' => Tools::getCurrentUrlProtocolPrefix().'api.prestashop.com/version/check_version.php?v='._PS_VERSION_.'&lang='.$this->context->language->iso_code,
			'dashboard_use_push' => Configuration::get('PS_DASHBOARD_USE_PUSH'),
			'calendar' => $calendar_helper->generate(),
			'PS_DASHBOARD_SIMULATION' => Configuration::get('PS_DASHBOARD_SIMULATION'),
			'datepickerFrom' => Tools::getValue('datepickerFrom', $this->context->employee->stats_date_from),
			'datepickerTo' => Tools::getValue('datepickerTo', $this->context->employee->stats_date_to),
			'preselect_date_range' => Tools::getValue('preselectDateRange', $this->context->employee->preselect_date_range)
		);
		return parent::renderView();
	}

	public function postProcess()
	{
		if (Tools::isSubmit('submitDateRealTime'))
		{
			if ($use_realtime = (int)Tools::getValue('submitDateRealTime'))
			{
				$this->context->employee->stats_date_from = date('Y-m-d');
				$this->context->employee->stats_date_to = date('Y-m-d');
				$this->context->employee->stats_compare_option = HelperCalendar::DEFAULT_COMPARE_OPTION;
				$this->context->employee->stats_compare_from = null;
				$this->context->employee->stats_compare_to = null;
				$this->context->employee->update();
			}
			Configuration::updateValue('PS_DASHBOARD_USE_PUSH', $use_realtime);
		}

		if (Tools::isSubmit('submitDateRange'))
		{
			$this->context->employee->stats_date_from = Tools::getValue('date_from');
			$this->context->employee->stats_date_to = Tools::getValue('date_to');
			$this->context->employee->preselect_date_range = Tools::getValue('preselectDateRange');

			if (Tools::getValue('datepicker_compare'))
			{
				$this->context->employee->stats_compare_from = Tools::getValue('compare_date_from');
				$this->context->employee->stats_compare_to = Tools::getValue('compare_date_to');
				$this->context->employee->stats_compare_option = Tools::getValue('compare_date_option');
			}
			else
			{
				$this->context->employee->stats_compare_from = null;
				$this->context->employee->stats_compare_to = null;
				$this->context->employee->stats_compare_option = HelperCalendar::DEFAULT_COMPARE_OPTION;
			}

			$this->context->employee->update();
		}

		parent::postProcess();
	}
	
	protected function getWarningDomainName()
	{
		$warning = false;
		if (Shop::isFeatureActive())
			return;

		$shop = Context::getContext()->shop;
		if ($_SERVER['HTTP_HOST'] != $shop->domain && $_SERVER['HTTP_HOST'] != $shop->domain_ssl && Tools::getValue('ajax') == false)
		{
			$warning = $this->l('You are currently connected under the following domain name:').' <span style="color: #CC0000;">'.$_SERVER['HTTP_HOST'].'</span><br />';
			if (Configuration::get('PS_MULTISHOP_FEATURE_ACTIVE'))
				$warning .= sprintf($this->l('This is different from the shop domain name set in the Multistore settings: "%s".'), $shop->domain).'
				'.preg_replace('@{link}(.*){/link}@', '<a href="index.php?controller=AdminShopUrl&id_shop_url='.(int)$shop->id.'&updateshop_url&token='.Tools::getAdminTokenLite('AdminShopUrl').'">$1</a>', $this->l('If this is your main domain, please {link}change it now{/link}.'));
			else
				$warning .= $this->l('This is different from the domain name set in the "SEO & URLs" tab.').'
				'.preg_replace('@{link}(.*){/link}@', '<a href="index.php?controller=AdminMeta&token='.Tools::getAdminTokenLite('AdminMeta').'#meta_fieldset_shop_url">$1</a>', $this->l('If this is your main domain, please {link}change it now{/link}.'));
		}
		return $warning;
	}
	
	public function ajaxProcessRefreshDashboard()
	{
		$id_module = null;
		if ($module = Tools::getValue('module'))
		{
			$module_obj = Module::getInstanceByName($module);
			if (Validate::isLoadedObject($module_obj))
				$id_module = $module_obj->id;
		}

		$params = array(
			'date_from' => $this->context->employee->stats_date_from,
			'date_to' => $this->context->employee->stats_date_to,
			'compare_from' => $this->context->employee->stats_compare_from,
			'compare_to' => $this->context->employee->stats_compare_to,
			'dashboard_use_push' => (int)Tools::getValue('dashboard_use_push'),
			'extra' => (int)Tools::getValue('extra')
		);
		
		die(Tools::jsonEncode(Hook::exec('dashboardData', $params, $id_module, true, true, (int)Tools::getValue('dashboard_use_push'))));
	}

	public function ajaxProcessSetSimulationMode()
	{
		Configuration::updateValue('PS_DASHBOARD_SIMULATION', (int)Tools::getValue('PS_DASHBOARD_SIMULATION'));
		die ('k'.Configuration::get('PS_DASHBOARD_SIMULATION').'k');
	}

	public function ajaxProcessGetBlogRss()
	{
		$return = array('has_errors' => false, 'rss' => array());
		if (!$this->isFresh('/config/xml/blog-'.$this->context->language->iso_code.'.xml', 86400))
			if (!$this->refresh('/config/xml/blog-'.$this->context->language->iso_code.'.xml', 'https://api.prestashop.com/rss/blog/blog-'.$this->context->language->iso_code.'.xml'))
				$return['has_errors'] = true;
		
		if (!$return['has_errors'])
		{
			$rss = simpleXML_load_file(_PS_ROOT_DIR_.'/config/xml/blog-'.$this->context->language->iso_code.'.xml');
			$articles_limit = 2;
			foreach ($rss->channel->item as $item)
			{
				if ($articles_limit > 0 && Validate::isCleanHtml((string)$item->title) && Validate::isCleanHtml((string)$item->description))
					$return['rss'][] = array(
						'date' => Tools::displayDate(date('Y-m-d', strtotime((string)$item->pubDate))),
						'title' => (string)Tools::htmlentitiesUTF8($item->title),
						'short_desc' => Tools::truncateString(strip_tags((string)$item->description), 150),
						'link' => (string)$item->link,
					);
				else
					break;
				$articles_limit --;
			}
		}
		die(Tools::jsonEncode($return));
	}
	
	public function ajaxProcessSaveDashConfig()
	{
		$return = array('has_errors' => false, 'errors' => array());
		$module = Tools::getValue('module');
		$hook = Tools::getValue('hook');
		$configs = Tools::getValue('configs');

		$params = array(
			'date_from' => $this->context->employee->stats_date_from,
			'date_to' => $this->context->employee->stats_date_to
		);
		
		if (Validate::isModuleName($module) && $module_obj = Module::getInstanceByName($module))
		{
			if (Validate::isLoadedObject($module_obj) && method_exists($module_obj, 'validateDashConfig'))
				$return['errors'] = $module_obj->validateDashConfig($configs);
			if (!count($return['errors']))
			{
				if (Validate::isLoadedObject($module_obj) && method_exists($module_obj, 'saveDashConfig'))
					$return['has_errors'] = $module_obj->saveDashConfig($configs);
				else if (is_array($configs) && count($configs))
					foreach ($configs as $name => $value)
						if (Validate::isConfigName($name))
							Configuration::updateValue($name, $value);
			}
			else
				$return['has_errors'] = true;
		}
		
		if (Validate::isHookName($hook) && method_exists($module_obj, $hook))
			$return['widget_html'] = $module_obj->$hook($params);

		die(Tools::jsonEncode($return));
	}	
}
Back to Top