BxBaseModNotificationsDb.php 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498
  1. <?php defined('BX_DOL') or die('hack attempt');
  2. /**
  3. * Copyright (c) UNA, Inc - https://una.io
  4. * MIT License - https://opensource.org/licenses/MIT
  5. *
  6. * @defgroup BaseNotifications Base classes for Notifications like modules
  7. * @ingroup UnaModules
  8. *
  9. * @{
  10. */
  11. /*
  12. * Module database queries
  13. */
  14. class BxBaseModNotificationsDb extends BxBaseModGeneralDb
  15. {
  16. protected $_oConfig;
  17. protected $_sTable;
  18. protected $_sTableHandlers;
  19. protected $_sTableSettings;
  20. protected $_sTableSettings2Users;
  21. protected $_sHandlerMask;
  22. protected $_aDeliveryTypes;
  23. public function __construct(&$oConfig)
  24. {
  25. parent::__construct($oConfig);
  26. $this->_oConfig = $oConfig;
  27. $this->_sTable = $this->_sPrefix . 'events';
  28. $this->_sTableHandlers = $this->_sPrefix . 'handlers';
  29. $this->_sTableSettings = $this->_sPrefix . 'settings';
  30. $this->_sTableSettings2Users = $this->_sPrefix . 'settings2users';
  31. $this->_sHandlerMask = "%s-%s";
  32. $this->_aDeliveryTypes = array(BX_BASE_MOD_NTFS_DTYPE_SITE);
  33. }
  34. public function getAlertHandlerId()
  35. {
  36. $sQuery = $this->prepare("SELECT `id` FROM `sys_alerts_handlers` WHERE `name`=? LIMIT 1", $this->_oConfig->getObject('alert'));
  37. return (int)$this->getOne($sQuery);
  38. }
  39. public function insertData($aData)
  40. {
  41. $aHandlers = array();
  42. $aHandlerDescriptor = $this->_oConfig->getHandlerDescriptor();
  43. //--- Update Timeline Handlers ---//
  44. foreach($aData['handlers'] as $aHandler) {
  45. $sContent = $sPrivacy = '';
  46. $bInsert = $aHandler['type'] == BX_BASE_MOD_NTFS_HANDLER_TYPE_INSERT;
  47. if($bInsert) {
  48. if(empty($aHandler['module_class']))
  49. $aHandler['module_class'] = 'Module';
  50. $sContent = serialize(array_intersect_key($aHandler, $aHandlerDescriptor));
  51. $sPrivacy = !empty($aHandler['module_event_privacy']) ? $aHandler['module_event_privacy'] : '';
  52. }
  53. $sQuery = $this->prepare("INSERT INTO
  54. `{$this->_sTableHandlers}`
  55. SET
  56. `group`=?,
  57. `type`=?,
  58. `alert_unit`=?,
  59. `alert_action`=?,
  60. `content`=?,
  61. `privacy`=?", $aHandler['group'], $aHandler['type'], $aHandler['alert_unit'], $aHandler['alert_action'], $sContent, $sPrivacy);
  62. if(!$this->query($sQuery))
  63. continue;
  64. $aHandlers[sprintf($this->_sHandlerMask, $aHandler['alert_unit'], $aHandler['alert_action'])] = (int)$this->lastId();
  65. }
  66. //--- Update Settings ---//
  67. if(!empty($aData['settings']) && is_array($aData['settings']))
  68. foreach($aData['settings'] as $aSetting) {
  69. $sHandler = sprintf($this->_sHandlerMask, $aSetting['unit'], $aSetting['action']);
  70. if(empty($aHandlers[$sHandler]))
  71. continue;
  72. foreach($this->_aDeliveryTypes as $sDeliveryType) {
  73. $iOrder = (int)$this->getSetting(array('by' => 'delivery_max_order', 'delivery' => $sDeliveryType));
  74. foreach($aSetting['types'] as $sType) {
  75. $sTitle = $this->_oConfig->getHandlersActionTitle($aSetting['unit'], $aSetting['action'], $sType);
  76. $this->query("INSERT INTO `{$this->_sTableSettings}` SET `group`=:group, `handler_id`=:handler_id, `type`=:type, `delivery`=:delivery, `title`=:title, `order`=:order", array(
  77. 'group' => $aSetting['group'],
  78. 'handler_id' => (int)$aHandlers[$sHandler],
  79. 'type' => $sType,
  80. 'delivery' => $sDeliveryType,
  81. 'title' => strcmp($sTitle, _t($sTitle)) !== 0 ? $sTitle : '',
  82. 'order' => ++$iOrder
  83. ));
  84. }
  85. }
  86. }
  87. //--- Update System Alerts ---//
  88. $iHandlerId = $this->getAlertHandlerId();
  89. foreach($aData['alerts'] as $aAlert) {
  90. $sQuery = $this->prepare("INSERT INTO
  91. `sys_alerts`
  92. SET
  93. `unit`=?,
  94. `action`=?,
  95. `handler_id`=?", $aAlert['unit'], $aAlert['action'], $iHandlerId);
  96. $this->query($sQuery);
  97. }
  98. }
  99. public function deleteData($aData)
  100. {
  101. $aHandlers = array();
  102. //--- Update Timeline Handlers ---//
  103. foreach($aData['handlers'] as $aHandler) {
  104. $sHandler = sprintf($this->_sHandlerMask, $aHandler['alert_unit'], $aHandler['alert_action']);
  105. $aBindings = array(
  106. 'alert_unit' => $aHandler['alert_unit'],
  107. 'alert_action' => $aHandler['alert_action'],
  108. 'group' => $aHandler['group'],
  109. 'type' => $aHandler['type']
  110. );
  111. $aHandlers[$sHandler] = $this->getOne("SELECT `id` FROM `{$this->_sTableHandlers}` WHERE (`alert_unit`=:alert_unit AND `alert_action`=:alert_action) OR (`group`=:group AND `type`=:type) LIMIT 1", $aBindings);
  112. $this->query("DELETE FROM `{$this->_sTableHandlers}` WHERE (`alert_unit`=:alert_unit AND `alert_action`=:alert_action) OR (`group`=:group AND `type`=:type) LIMIT 1", $aBindings);
  113. }
  114. //--- Update Settings ---//
  115. if(!empty($aData['settings']) && is_array($aData['settings']))
  116. foreach($aData['settings'] as $aSetting) {
  117. $sHandler = sprintf($this->_sHandlerMask, $aSetting['unit'], $aSetting['action']);
  118. if(empty($aHandlers[$sHandler]))
  119. continue;
  120. foreach($aSetting['types'] as $sType)
  121. $this->query("DELETE FROM `ts`, `tsu` USING `{$this->_sTableSettings}` AS `ts` LEFT JOIN `{$this->_sTableSettings2Users}` AS `tsu` ON `ts`.`id`=`tsu`.`setting_id` WHERE `ts`.`handler_id`=:handler_id AND `ts`.`type`=:type", array(
  122. 'handler_id' => (int)$aHandlers[$sHandler],
  123. 'type' => $sType,
  124. ));
  125. }
  126. //--- Update System Alerts ---//
  127. $iHandlerId = $this->getAlertHandlerId();
  128. foreach($aData['alerts'] as $aAlert) {
  129. $sQuery = $this->prepare("DELETE FROM
  130. `sys_alerts`
  131. WHERE
  132. `unit`=? AND
  133. `action`=? AND
  134. `handler_id`=?
  135. LIMIT 1", $aAlert['unit'], $aAlert['action'], $iHandlerId);
  136. $this->query($sQuery);
  137. }
  138. }
  139. public function deleteModuleEvents($aData)
  140. {
  141. //Delete system events.
  142. foreach($aData['handlers'] as $aHandler)
  143. $this->deleteEvent(array('type' => $aHandler['alert_unit'], 'action' => $aHandler['alert_action']));
  144. }
  145. public function activateModuleEvents($aData, $bActivate = true)
  146. {
  147. $iActivate = $bActivate ? 1 : 0;
  148. //Activate (deactivate) system events.
  149. foreach($aData['handlers'] as $aHandler)
  150. $this->updateEvent(array('active' => $iActivate), array('type' => $aHandler['alert_unit'], 'action' => $aHandler['alert_action']));
  151. }
  152. public function getHandlers($aParams = array())
  153. {
  154. $aMethod = array('name' => 'getAll', 'params' => array(0 => 'query'));
  155. $sWhereClause = '';
  156. if(!empty($aParams))
  157. switch($aParams['type']) {
  158. case 'by_type':
  159. $aMethod['params'][1] = array(
  160. 'type' => $aParams['value']
  161. );
  162. $sWhereClause = "AND `type`=:type";
  163. break;
  164. case 'by_group_key_type':
  165. $aMethod['name'] = 'getAllWithKey';
  166. $aMethod['params'][1] = 'type';
  167. $aMethod['params'][2] = array(
  168. 'group' => $aParams['group']
  169. );
  170. $sWhereClause = "AND `group`=:group";
  171. break;
  172. }
  173. $aMethod['params'][0] = "SELECT * FROM `{$this->_sTableHandlers}` WHERE 1 " . $sWhereClause;
  174. return call_user_func_array(array($this, $aMethod['name']), $aMethod['params']);
  175. }
  176. public function getSetting($aParams = array())
  177. {
  178. $CNF = &$this->_oConfig->CNF;
  179. $aMethod = array('name' => 'getAll', 'params' => array(0 => 'query'));
  180. $sSelectClause = "`ts`.*, `th`.`alert_unit` AS `unit`, `th`.`alert_action` AS `action`";
  181. $sJoinClause = $sWhereClause = $sGroupClause = $sOrderClause = $sLimitClause = "";
  182. switch($aParams['by']) {
  183. case 'id':
  184. $aMethod['name'] = 'getRow';
  185. $aMethod['params'][1] = array(
  186. 'id' => $aParams['id']
  187. );
  188. $sWhereClause = " AND `ts`.`id`=:id";
  189. break;
  190. case 'tsu_id':
  191. $aMethod['name'] = 'getRow';
  192. $aMethod['params'][1] = array(
  193. 'id' => $aParams['id']
  194. );
  195. $sJoinClause = "LEFT JOIN `" . $this->_sTableSettings2Users . "` AS `tsu` ON `ts`.`id`=`tsu`.`setting_id`";
  196. $sWhereClause = " AND `tsu`.`id`=:id";
  197. break;
  198. case 'tsu_allowed':
  199. $aMethod['name'] = 'getRow';
  200. $aMethod['params'][1] = array(
  201. 'handler_id' => $aParams['handler_id'],
  202. 'delivery' => $aParams['delivery'],
  203. 'type' => $aParams['type'],
  204. 'user_id' => $aParams['user_id']
  205. );
  206. $sSelectClause = "`ts`.`active` AS `active_adm`, IF(NOT ISNULL(`tsu`.`active`), `tsu`.`active`, `ts`.`value`) AS `active_pnl`";
  207. $sJoinClause = "LEFT JOIN `" . $this->_sTableSettings2Users . "` AS `tsu` ON `ts`.`id`=`tsu`.`setting_id` AND `tsu`.`user_id`=:user_id";
  208. $sWhereClause = " AND `ts`.`handler_id`=:handler_id AND `ts`.`delivery`=:delivery AND `ts`.`type`=:type";
  209. break;
  210. case 'delivery_max_order':
  211. $aMethod['name'] = 'getOne';
  212. $aMethod['params'][1] = array(
  213. 'delivery' => $aParams['delivery'],
  214. );
  215. $sSelectClause = "`ts`.`order`";
  216. $sWhereClause = " AND `ts`.`delivery`=:delivery";
  217. $sOrderClause = "`ts`.`order` DESC";
  218. $sLimitClause = "1";
  219. break;
  220. case 'group_type_delivery':
  221. $aMethod['name'] = 'getColumn';
  222. $aMethod['params'][1] = array(
  223. 'group' => $aParams['group'],
  224. 'delivery' => $aParams['delivery'],
  225. 'type' => $aParams['type']
  226. );
  227. $sSelectClause = "`ts`.`id`";
  228. $sWhereClause = " AND `ts`.`group`=:group AND `ts`.`delivery`=:delivery AND `ts`.`type`=:type";
  229. if($aParams['active'])
  230. $sWhereClause .= " AND `ts`.`active`='1'";
  231. break;
  232. case 'user_id_pairs':
  233. $aMethod['name'] = 'getPairs';
  234. $aMethod['params'][1] = 'id';
  235. $aMethod['params'][2] = 'active';
  236. $aMethod['params'][3] = array(
  237. 'user_id' => $aParams['user_id']
  238. );
  239. $sSelectClause = "`ts`.`id` AS `id`, `tsu`.`active` AS `active`";
  240. $sJoinClause = "LEFT JOIN `" . $this->_sTableSettings2Users . "` AS `tsu` ON `ts`.`id`=`tsu`.`setting_id`";
  241. $sWhereClause = " AND `tsu`.`user_id`=:user_id";
  242. break;
  243. case 'all_active':
  244. $sWhereClause = " AND `ts`.`active`='1'";
  245. break;
  246. case 'all_inactive':
  247. $sWhereClause = " AND `ts`.`active`='0'";
  248. break;
  249. }
  250. $sOrderClause = !empty($sOrderClause) ? "ORDER BY " . $sOrderClause : $sOrderClause;
  251. $sLimitClause = !empty($sLimitClause) ? "LIMIT " . $sLimitClause : $sLimitClause;
  252. $aMethod['params'][0] = "SELECT
  253. " . $sSelectClause . "
  254. FROM `" . $this->_sTableSettings . "` AS `ts`
  255. LEFT JOIN `" . $this->_sTableHandlers . "` AS `th` ON `ts`.`handler_id`=`th`.`id` " . $sJoinClause . "
  256. WHERE 1" . $sWhereClause . " " . $sGroupClause . " " . $sOrderClause . " " . $sLimitClause;
  257. return call_user_func_array(array($this, $aMethod['name']), $aMethod['params']);
  258. }
  259. public function updateSetting($aParamsSet, $aParamsWhere)
  260. {
  261. if(empty($aParamsSet) || empty($aParamsWhere))
  262. return false;
  263. $sSql = "UPDATE `{$this->_sTableSettings}` SET " . $this->arrayToSQL($aParamsSet) . " WHERE " . $this->arrayToSQL($aParamsWhere, " AND ");
  264. return $this->query($sSql);
  265. }
  266. public function activateSettingById($bActive, $mixedId)
  267. {
  268. if(!is_array($mixedId))
  269. $mixedId = array($mixedId);
  270. return $this->query("UPDATE `{$this->_sTableSettings}` SET `active`=:active WHERE `id` IN (" . $this->implode_escape($mixedId) . ")", array(
  271. 'active' => (int)$bActive
  272. ));
  273. }
  274. public function activateSettingByIdUser($bActive, $iUserId, $mixedSettingId)
  275. {
  276. if(!is_array($mixedSettingId))
  277. $mixedSettingId = array($mixedSettingId);
  278. return $this->query("UPDATE `{$this->_sTableSettings2Users}` SET `active`=:active WHERE `user_id`=:user_id AND `setting_id` IN (" . $this->implode_escape($mixedSettingId) . ")", array(
  279. 'user_id' => $iUserId,
  280. 'active' => (int)$bActive
  281. ));
  282. }
  283. public function changeSettingById($sField, $mixedValue, $mixedId)
  284. {
  285. if(!is_array($mixedId))
  286. $mixedId = array($mixedId);
  287. return $this->query("UPDATE `{$this->_sTableSettings}` SET `" . $sField . "`=:value WHERE `id` IN (" . $this->implode_escape($mixedId) . ")", array(
  288. 'value' => $mixedValue
  289. ));
  290. }
  291. public function changeSettingByIdUser($sField, $mixedValue, $iUserId, $mixedSettingId)
  292. {
  293. if(!is_array($mixedSettingId))
  294. $mixedSettingId = array($mixedSettingId);
  295. return $this->query("UPDATE `{$this->_sTableSettings2Users}` SET `" . $sField . "`=:value WHERE `user_id`=:user_id AND `setting_id` IN (" . $this->implode_escape($mixedSettingId) . ")", array(
  296. 'user_id' => $iUserId,
  297. 'value' => $mixedValue
  298. ));
  299. }
  300. public function initSettingUser($iUserId)
  301. {
  302. $aSettingsAll = $this->getSetting(array('by' => 'all_active'));
  303. $aSettingsUser = $this->getSetting(array('by' => 'user_id_pairs', 'user_id' => $iUserId));
  304. foreach($aSettingsAll as $aSetting) {
  305. if(isset($aSettingsUser[$aSetting['id']]))
  306. continue;
  307. $this->insertSettingUser(array(
  308. 'user_id' => $iUserId,
  309. 'setting_id' => $aSetting['id'],
  310. 'active' => $aSetting['value']
  311. ));
  312. }
  313. $aSettingsAll = $this->getSetting(array('by' => 'all_inactive'));
  314. foreach($aSettingsAll as $aSetting) {
  315. if(!isset($aSettingsUser[$aSetting['id']]))
  316. continue;
  317. $this->deleteSettingUser(array(
  318. 'user_id' => $iUserId,
  319. 'setting_id' => $aSetting['id']
  320. ));
  321. }
  322. }
  323. public function insertSettingUser($aParamsSet)
  324. {
  325. if(empty($aParamsSet))
  326. return 0;
  327. if((int)$this->query("INSERT INTO `{$this->_sTableSettings2Users}` SET " . $this->arrayToSQL($aParamsSet)) <= 0)
  328. return 0;
  329. return (int)$this->lastId();
  330. }
  331. public function deleteSettingUser($aParamsWhere)
  332. {
  333. if(empty($aParamsWhere))
  334. return false;
  335. return (int)$this->query("DELETE FROM `{$this->_sTableSettings2Users}` WHERE " . $this->arrayToSQL($aParamsWhere, ' AND ')) <= 0;
  336. }
  337. public function insertEvent($aParamsSet)
  338. {
  339. if(empty($aParamsSet))
  340. return 0;
  341. $aSet = array();
  342. foreach($aParamsSet as $sKey => $sValue)
  343. $aSet[] = "`" . $sKey . "`=:" . $sKey;
  344. if(!isset($aParamsSet['date']))
  345. $aSet[] = "`date`=UNIX_TIMESTAMP()";
  346. if((int)$this->query("INSERT INTO `{$this->_sTable}` SET " . implode(", ", $aSet), $aParamsSet) <= 0)
  347. return 0;
  348. return (int)$this->lastId();
  349. }
  350. public function updateEvent($aParamsSet, $aParamsWhere)
  351. {
  352. if(empty($aParamsSet) || empty($aParamsWhere))
  353. return false;
  354. $sSql = "UPDATE `{$this->_sTable}` SET " . $this->arrayToSQL($aParamsSet) . " WHERE " . $this->arrayToSQL($aParamsWhere, " AND ");
  355. return $this->query($sSql);
  356. }
  357. public function deleteEvent($aParams, $sWhereAddon = "")
  358. {
  359. $sSql = "DELETE FROM `{$this->_sTable}` WHERE " . $this->arrayToSQL($aParams, " AND ") . $sWhereAddon;
  360. return $this->query($sSql);
  361. }
  362. public function getEvents($aParams)
  363. {
  364. list($sMethod, $sSelectClause, $sJoinClause, $sWhereClause, $sOrderClause, $sLimitClause) = $this->_getSqlPartsEvents($aParams);
  365. $sSql = "SELECT {select}
  366. FROM `{$this->_sTable}`
  367. LEFT JOIN `{$this->_sTableHandlers}` ON `{$this->_sTable}`.`type`=`{$this->_sTableHandlers}`.`alert_unit` AND `{$this->_sTable}`.`action`=`{$this->_sTableHandlers}`.`alert_action` " . $sJoinClause . "
  368. WHERE 1 " . $sWhereClause . " {order} {limit}";
  369. return $this->$sMethod(str_replace(array('{select}', '{order}', '{limit}'), array($sSelectClause, $sOrderClause, $sLimitClause), $sSql));
  370. }
  371. protected function _getSqlPartsEvents($aParams)
  372. {
  373. $sMethod = 'getAll';
  374. $sSelectClause = "`{$this->_sTable}`.*";
  375. $sJoinClause = $sWhereClause = $sOrderClause = $sLimitClause = "";
  376. switch($aParams['browse']) {
  377. case 'id':
  378. $sMethod = 'getRow';
  379. $sWhereClause = $this->prepareAsString("AND `{$this->_sTable}`.`id`=? ", $aParams['value']);
  380. $sLimitClause = "LIMIT 1";
  381. break;
  382. case 'first':
  383. $sMethod = 'getRow';
  384. list($sJoinClause, $sWhereClause) = $this->_getSqlPartsEventsList($aParams);
  385. $sOrderClause = "ORDER BY `{$this->_sTable}`.`date` DESC, `{$this->_sTable}`.`id` DESC";
  386. $sLimitClause = "LIMIT 1";
  387. break;
  388. case 'list':
  389. list($sJoinClause, $sWhereClause) = $this->_getSqlPartsEventsList($aParams);
  390. $sOrderClause = "ORDER BY `{$this->_sTable}`.`date` DESC, `{$this->_sTable}`.`id` DESC";
  391. $sLimitClause = isset($aParams['per_page']) ? "LIMIT " . $aParams['start'] . ", " . $aParams['per_page'] : "";
  392. break;
  393. }
  394. return array($sMethod, $sSelectClause, $sJoinClause, $sWhereClause, $sOrderClause, $sLimitClause);
  395. }
  396. protected function _getSqlPartsEventsList($aParams)
  397. {
  398. $sJoinClause = $sWhereClause = "";
  399. return array($sJoinClause, $sWhereClause);
  400. }
  401. }
  402. /** @} */