reverb.php 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480
  1. <?php
  2. class ControllerExtensionModuleReverb extends Controller {
  3. private $error = [];
  4. // -------------------------------------------------------------------------
  5. // Main settings page
  6. // -------------------------------------------------------------------------
  7. public function index() {
  8. $this->load->language('extension/module/reverb');
  9. $this->load->model('extension/module/reverb');
  10. $this->load->model('setting/setting');
  11. $this->load->model('catalog/category');
  12. $this->document->setTitle($this->language->get('heading_title'));
  13. if ($this->request->server['REQUEST_METHOD'] === 'POST' && $this->validate()) {
  14. $this->model_setting_setting->editSetting('module_reverb', $this->request->post);
  15. // Save category mappings separately (they come as a sub-array)
  16. if (isset($this->request->post['module_reverb_category_mappings'])) {
  17. $this->model_extension_module_reverb->saveCategoryMappings(
  18. $this->request->post['module_reverb_category_mappings']
  19. );
  20. }
  21. $this->session->data['success'] = $this->language->get('text_success');
  22. $this->response->redirect($this->url->link('extension/module/reverb', 'user_token=' . $this->session->data['user_token'], true));
  23. }
  24. $data = $this->buildBreadcrumbs();
  25. // Language strings required by the view
  26. $lang_keys = [
  27. 'tab_settings', 'tab_categories', 'tab_log',
  28. 'text_api_settings', 'text_shipping_settings', 'text_sync_settings', 'text_manual_sync',
  29. 'entry_api_token', 'help_api_token',
  30. 'entry_status', 'entry_sync_direction',
  31. 'text_sync_push', 'text_sync_both',
  32. 'entry_shipping_domestic', 'help_shipping_domestic',
  33. 'entry_shipping_international', 'help_shipping_international',
  34. 'help_sync_categories', 'button_sync_now',
  35. 'text_order_import', 'button_import_orders',
  36. 'entry_order_stores', 'help_order_stores', 'text_select_all', 'text_unselect_all',
  37. 'entry_default_qty', 'help_default_qty',
  38. 'text_category_mapping_help', 'text_no_categories',
  39. 'column_oc_category', 'column_reverb_category',
  40. 'column_date', 'column_product', 'column_direction', 'column_status', 'column_message',
  41. 'text_push', 'text_pull', 'text_error', 'text_no_log', 'button_clear_log',
  42. 'text_success', 'text_log_success',
  43. 'error_warning', 'error_api_token',
  44. ];
  45. foreach ($lang_keys as $key) {
  46. $data[$key] = $this->language->get($key);
  47. }
  48. // Global OC strings
  49. $data['text_enabled'] = $this->language->get('text_enabled');
  50. $data['text_disabled'] = $this->language->get('text_disabled');
  51. $data['button_save'] = $this->language->get('button_save');
  52. $data['button_cancel'] = $this->language->get('button_cancel');
  53. // Pull saved settings into $data
  54. $fields = [
  55. 'module_reverb_api_token',
  56. 'module_reverb_status',
  57. 'module_reverb_sync_direction',
  58. 'module_reverb_sync_categories',
  59. 'module_reverb_shipping_domestic',
  60. 'module_reverb_shipping_international',
  61. 'module_reverb_order_stores',
  62. 'module_reverb_default_qty',
  63. ];
  64. foreach ($fields as $key) {
  65. $data[$key] = $this->request->post[$key] ?? $this->config->get($key);
  66. }
  67. // Defaults
  68. $data['module_reverb_sync_direction'] = $data['module_reverb_sync_direction'] ?? 'push';
  69. $data['module_reverb_sync_categories'] = $data['module_reverb_sync_categories'] ?? [];
  70. $data['module_reverb_shipping_domestic'] = $data['module_reverb_shipping_domestic'] ?? '0.00';
  71. $data['module_reverb_shipping_international'] = $data['module_reverb_shipping_international'] ?? '0.00';
  72. $data['module_reverb_order_stores'] = $data['module_reverb_order_stores'] ?? [0];
  73. $data['module_reverb_default_qty'] = $data['module_reverb_default_qty'] ?? 1;
  74. // Stores list for the checkbox UI
  75. $this->load->model('setting/store');
  76. $stores = $this->model_setting_store->getStores();
  77. array_unshift($stores, ['store_id' => 0, 'name' => 'Default']);
  78. $data['stores'] = $stores;
  79. // All OC categories for the multi-select
  80. $data['categories'] = $this->getCategoryTree();
  81. // Category mappings for the mapping tab
  82. $data['category_mappings'] = $this->model_extension_module_reverb->getCategoryMappings();
  83. $data['reverb_categories'] = $this->model_extension_module_reverb->getReverbCategories();
  84. $data['reverb_categories_grouped'] = $this->model_extension_module_reverb->getReverbCategoriesGrouped();
  85. $data['module_reverb_category_mappings'] = $data['category_mappings'];
  86. // Sync log
  87. $data['sync_log'] = $this->model_extension_module_reverb->getSyncLog(200);
  88. // Alerts
  89. $data['error_warning'] = $this->error['warning'] ?? '';
  90. $data['success'] = $this->session->data['success'] ?? '';
  91. unset($this->session->data['success']);
  92. $data['action'] = $this->url->link('extension/module/reverb', 'user_token=' . $this->session->data['user_token'], true);
  93. $data['cancel'] = $this->url->link('marketplace/extension', 'user_token=' . $this->session->data['user_token'] . '&type=module', true);
  94. $data['sync_url'] = $this->url->link('extension/module/reverb/sync', 'user_token=' . $this->session->data['user_token'], true);
  95. $data['import_url'] = $this->url->link('extension/module/reverb/importOrders', 'user_token=' . $this->session->data['user_token'], true);
  96. $data['clear_log_url'] = $this->url->link('extension/module/reverb/clearLog', 'user_token=' . $this->session->data['user_token'], true);
  97. $data['categories_url'] = $this->url->link('extension/module/reverb/reverbCategories', 'user_token=' . $this->session->data['user_token'], true);
  98. $data['header'] = $this->load->controller('common/header');
  99. $data['column_left'] = $this->load->controller('common/column_left');
  100. $data['footer'] = $this->load->controller('common/footer');
  101. $this->response->setOutput($this->load->view('extension/module/reverb', $data));
  102. }
  103. // -------------------------------------------------------------------------
  104. // Install / Uninstall
  105. // -------------------------------------------------------------------------
  106. public function install() {
  107. $this->load->model('extension/module/reverb');
  108. $this->model_extension_module_reverb->install();
  109. // Register events for order pulling (admin side)
  110. $this->load->model('setting/event');
  111. $this->model_setting_event->addEvent(
  112. 'reverb',
  113. 'admin/model/catalog/product/editProduct/after',
  114. 'extension/module/reverb/eventProductSave'
  115. );
  116. $this->model_setting_event->addEvent(
  117. 'reverb',
  118. 'admin/model/catalog/product/addProduct/after',
  119. 'extension/module/reverb/eventProductAddSave'
  120. );
  121. }
  122. public function uninstall() {
  123. $this->load->model('extension/module/reverb');
  124. $this->model_extension_module_reverb->uninstall();
  125. $this->load->model('setting/event');
  126. $this->model_setting_event->deleteEventByCode('reverb');
  127. }
  128. // -------------------------------------------------------------------------
  129. // Event handlers (called by OC event system on product save)
  130. // -------------------------------------------------------------------------
  131. public function eventProductSave(&$route, &$args, &$output) {
  132. $product_id = (int)$args[0];
  133. $this->saveProductReverb($product_id);
  134. }
  135. public function eventProductAddSave(&$route, &$args, &$output) {
  136. // $output holds the new product_id for addProduct
  137. $product_id = (int)$output;
  138. if ($product_id) {
  139. $this->saveProductReverb($product_id);
  140. }
  141. }
  142. private function saveProductReverb($product_id) {
  143. if (!isset($this->request->post['reverb_sync_enabled'])) {
  144. return;
  145. }
  146. $this->load->model('extension/module/reverb');
  147. $this->model_extension_module_reverb->saveProductMap($product_id, [
  148. 'sync_enabled' => (int)(bool)$this->request->post['reverb_sync_enabled'],
  149. 'condition_uuid' => $this->request->post['reverb_condition_uuid'] ?? '',
  150. 'reverb_category_uuid' => $this->request->post['reverb_category_uuid'] ?? '',
  151. 'handmade' => (int)(bool)($this->request->post['reverb_handmade'] ?? 0),
  152. 'upc_does_not_apply' => (int)(bool)($this->request->post['reverb_upc_does_not_apply'] ?? 1),
  153. ]);
  154. }
  155. // -------------------------------------------------------------------------
  156. // Manual sync (AJAX)
  157. // -------------------------------------------------------------------------
  158. public function sync() {
  159. $this->load->language('extension/module/reverb');
  160. $this->load->model('extension/module/reverb');
  161. // Set JSON header first so any uncaught error still returns parseable JSON.
  162. $this->response->addHeader('Content-Type: application/json');
  163. // Discard any PHP notices/warnings buffered before this point so they
  164. // cannot corrupt the JSON response body.
  165. if (ob_get_level()) {
  166. ob_clean();
  167. }
  168. try {
  169. if (!$this->user->hasPermission('modify', 'extension/module/reverb')) {
  170. $this->response->setOutput(json_encode(['success' => false, 'error' => $this->language->get('error_permission')]));
  171. return;
  172. }
  173. $settings = $this->buildSettings();
  174. if (empty($settings['api_token'])) {
  175. $this->response->setOutput(json_encode(['success' => false, 'error' => $this->language->get('error_api_token')]));
  176. return;
  177. }
  178. $allowed_categories = $this->config->get('module_reverb_sync_categories');
  179. if (empty($allowed_categories)) {
  180. $this->response->setOutput(json_encode(['success' => false, 'error' => 'No sync categories configured. Select at least one category in the Settings tab.']));
  181. return;
  182. }
  183. $products = $this->model_extension_module_reverb->getSyncEnabledProducts((array)$allowed_categories);
  184. $pushed = 0;
  185. $errors = 0;
  186. foreach ($products as $product) {
  187. try {
  188. $this->model_extension_module_reverb->syncProductToReverb($product, $product, $settings);
  189. $pushed++;
  190. $this->safeLog($product['product_id'], 'push', 'success', 'Synced: ' . $product['name']);
  191. } catch (Exception $e) {
  192. $errors++;
  193. $this->safeLog($product['product_id'], 'push', 'error', $e->getMessage());
  194. }
  195. }
  196. $this->response->setOutput(json_encode([
  197. 'success' => true,
  198. 'message' => sprintf($this->language->get('text_sync_complete'), $pushed, $errors),
  199. ]));
  200. } catch (Exception $e) {
  201. $this->response->setOutput(json_encode(['success' => false, 'error' => $e->getMessage()]));
  202. }
  203. }
  204. // -------------------------------------------------------------------------
  205. // Order import (AJAX)
  206. // -------------------------------------------------------------------------
  207. public function importOrders() {
  208. $this->load->language('extension/module/reverb');
  209. $this->load->model('extension/module/reverb');
  210. $this->response->addHeader('Content-Type: application/json');
  211. if (ob_get_level()) {
  212. ob_clean();
  213. }
  214. try {
  215. if (!$this->user->hasPermission('modify', 'extension/module/reverb')) {
  216. $this->response->setOutput(json_encode(['success' => false, 'error' => $this->language->get('error_permission')]));
  217. return;
  218. }
  219. $settings = $this->buildSettings();
  220. if (empty($settings['api_token'])) {
  221. $this->response->setOutput(json_encode(['success' => false, 'error' => $this->language->get('error_api_token')]));
  222. return;
  223. }
  224. $result = $this->model_extension_module_reverb->importOrdersFromReverb($settings);
  225. $this->response->setOutput(json_encode([
  226. 'success' => true,
  227. 'message' => sprintf($this->language->get('text_orders_imported'), $result['imported'], $result['skipped']),
  228. ]));
  229. } catch (Exception $e) {
  230. $this->response->setOutput(json_encode(['success' => false, 'error' => $e->getMessage()]));
  231. }
  232. }
  233. private function safeLog($product_id, $direction, $status, $message) {
  234. try {
  235. $this->model_extension_module_reverb->log($product_id, $direction, $status, $message);
  236. } catch (Exception $e) {
  237. // Log table missing or unavailable — ignore silently.
  238. }
  239. }
  240. // -------------------------------------------------------------------------
  241. // Per-product Reverb tab (AJAX — loaded into product edit page)
  242. // URL: extension/module/reverb/productTab?product_id=N
  243. // -------------------------------------------------------------------------
  244. public function productTab() {
  245. if (!$this->user->isLogged()) {
  246. $this->response->setOutput('');
  247. return;
  248. }
  249. $this->load->language('extension/module/reverb');
  250. $this->load->model('extension/module/reverb');
  251. $product_id = isset($this->request->get['product_id']) ? (int)$this->request->get['product_id'] : 0;
  252. $reverb_row = $this->model_extension_module_reverb->getProductMap($product_id);
  253. $data = [
  254. 'product_id' => $product_id,
  255. 'reverb_sync_enabled' => $reverb_row ? (int)$reverb_row['sync_enabled'] : 0,
  256. 'reverb_condition_uuid' => $reverb_row ? $reverb_row['condition_uuid'] : '',
  257. 'reverb_category_uuid' => $reverb_row ? $reverb_row['reverb_category_uuid'] : '',
  258. 'reverb_listing_id' => $reverb_row ? $reverb_row['reverb_listing_id'] : '',
  259. 'reverb_handmade' => $reverb_row ? (int)$reverb_row['handmade'] : 0,
  260. 'reverb_upc_does_not_apply' => $reverb_row ? (int)$reverb_row['upc_does_not_apply'] : 1,
  261. 'reverb_conditions' => $this->model_extension_module_reverb->getListingConditions(),
  262. 'reverb_categories_grouped' => $this->model_extension_module_reverb->getReverbCategoriesGrouped(),
  263. 'clear_listing_url' => $this->url->link('extension/module/reverb/clearListingId', 'user_token=' . $this->session->data['user_token'], true),
  264. ];
  265. $this->response->setOutput($this->load->view('extension/module/reverb_product', $data));
  266. }
  267. // -------------------------------------------------------------------------
  268. // Clear Reverb listing ID from a product (AJAX)
  269. // -------------------------------------------------------------------------
  270. public function clearListingId() {
  271. $this->load->language('extension/module/reverb');
  272. $this->load->model('extension/module/reverb');
  273. $this->response->addHeader('Content-Type: application/json');
  274. if (!$this->user->hasPermission('modify', 'extension/module/reverb')) {
  275. $this->response->setOutput(json_encode(['success' => false, 'error' => $this->language->get('error_permission')]));
  276. return;
  277. }
  278. $product_id = (int)($this->request->get['product_id'] ?? 0);
  279. if (!$product_id) {
  280. $this->response->setOutput(json_encode(['success' => false, 'error' => 'Invalid product ID.']));
  281. return;
  282. }
  283. $this->model_extension_module_reverb->clearListingId($product_id);
  284. $this->response->setOutput(json_encode(['success' => true]));
  285. }
  286. // -------------------------------------------------------------------------
  287. // Clear sync log (AJAX)
  288. // -------------------------------------------------------------------------
  289. public function clearLog() {
  290. $this->load->language('extension/module/reverb');
  291. $this->load->model('extension/module/reverb');
  292. $this->response->addHeader('Content-Type: application/json');
  293. if (!$this->user->hasPermission('modify', 'extension/module/reverb')) {
  294. $this->response->setOutput(json_encode(['success' => false, 'error' => $this->language->get('error_permission')]));
  295. return;
  296. }
  297. $this->model_extension_module_reverb->clearSyncLog();
  298. $this->response->setOutput(json_encode(['success' => true, 'message' => $this->language->get('text_log_cleared')]));
  299. }
  300. // -------------------------------------------------------------------------
  301. // Reverb categories (AJAX — for category mapping dropdowns)
  302. // -------------------------------------------------------------------------
  303. public function reverbCategories() {
  304. $this->load->model('extension/module/reverb');
  305. $categories = $this->model_extension_module_reverb->getReverbCategories();
  306. $this->response->addHeader('Content-Type: application/json');
  307. $this->response->setOutput(json_encode(['categories' => $categories]));
  308. }
  309. // -------------------------------------------------------------------------
  310. // Per-product tab (loaded inline via OCMOD template include)
  311. // The data is passed through the OCMOD PHP patch, not via a separate request.
  312. // -------------------------------------------------------------------------
  313. // -------------------------------------------------------------------------
  314. // Helpers
  315. // -------------------------------------------------------------------------
  316. private function validate() {
  317. if (!$this->user->hasPermission('modify', 'extension/module/reverb')) {
  318. $this->error['warning'] = $this->language->get('error_permission');
  319. }
  320. $token = $this->request->post['module_reverb_api_token'] ?? '';
  321. if (empty(trim($token))) {
  322. $this->error['warning'] = $this->language->get('error_api_token');
  323. }
  324. return empty($this->error);
  325. }
  326. private function buildBreadcrumbs() {
  327. return [
  328. 'heading_title' => $this->language->get('heading_title'),
  329. 'breadcrumbs' => [
  330. [
  331. 'text' => $this->language->get('text_home'),
  332. 'href' => $this->url->link('common/dashboard', 'user_token=' . $this->session->data['user_token'], true),
  333. ],
  334. [
  335. 'text' => $this->language->get('text_extension'),
  336. 'href' => $this->url->link('marketplace/extension', 'user_token=' . $this->session->data['user_token'] . '&type=module', true),
  337. ],
  338. [
  339. 'text' => $this->language->get('heading_title'),
  340. 'href' => $this->url->link('extension/module/reverb', 'user_token=' . $this->session->data['user_token'], true),
  341. ],
  342. ],
  343. ];
  344. }
  345. private function buildSettings() {
  346. // config_url is often empty in OC3; fall back to the catalog constants from admin/config.php
  347. $store_url = $this->config->get('config_url');
  348. if (empty($store_url)) {
  349. if (defined('HTTPS_CATALOG')) {
  350. $store_url = HTTPS_CATALOG;
  351. } elseif (defined('HTTP_CATALOG')) {
  352. $store_url = HTTP_CATALOG;
  353. }
  354. }
  355. $order_stores = $this->config->get('module_reverb_order_stores');
  356. if (!is_array($order_stores) || empty($order_stores)) {
  357. $order_stores = [0];
  358. }
  359. return [
  360. 'api_token' => $this->config->get('module_reverb_api_token'),
  361. 'sync_direction' => $this->config->get('module_reverb_sync_direction') ?? 'push',
  362. 'shipping_domestic' => $this->config->get('module_reverb_shipping_domestic') ?? '0',
  363. 'shipping_international' => $this->config->get('module_reverb_shipping_international') ?? '0',
  364. 'currency' => $this->config->get('config_currency') ?? 'AUD',
  365. 'store_url' => $store_url ?? '',
  366. 'order_stores' => $order_stores,
  367. 'default_qty' => max(1, (int)($this->config->get('module_reverb_default_qty') ?? 1)),
  368. ];
  369. }
  370. private function getCategoryTree() {
  371. $language_id = (int)$this->config->get('config_language_id');
  372. $query = $this->db->query("
  373. SELECT c.category_id, c.parent_id, cd.name
  374. FROM `" . DB_PREFIX . "category` c
  375. LEFT JOIN `" . DB_PREFIX . "category_description` cd
  376. ON cd.category_id = c.category_id AND cd.language_id = '" . $language_id . "'
  377. WHERE c.status = 1
  378. ORDER BY c.parent_id ASC, cd.name ASC
  379. ");
  380. $all = $query->rows;
  381. $byPid = [];
  382. foreach ($all as $row) {
  383. $byPid[(int)$row['parent_id']][] = $row;
  384. }
  385. $result = [];
  386. $stack = [[0, '']];
  387. while ($stack) {
  388. [$pid, $indent] = array_pop($stack);
  389. if (empty($byPid[$pid])) {
  390. continue;
  391. }
  392. foreach (array_reverse($byPid[$pid]) as $cat) {
  393. $result[] = [
  394. 'category_id' => $cat['category_id'],
  395. 'name' => $indent . $cat['name'],
  396. ];
  397. array_push($stack, [(int)$cat['category_id'], $indent . '&nbsp;&nbsp;&nbsp;']);
  398. }
  399. }
  400. return $result;
  401. }
  402. }