BxBaseReport.php 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676
  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 UnaBaseView UNA Base Representation Classes
  7. * @{
  8. */
  9. /**
  10. * @see BxDolReport
  11. */
  12. class BxBaseReport extends BxDolReport
  13. {
  14. protected $_bCssJsAdded;
  15. protected $_sJsObjClass;
  16. protected $_sJsObjName;
  17. protected $_sStylePrefix;
  18. protected $_aHtmlIds;
  19. protected $_aElementDefaults;
  20. protected $_aElementDefaultsApi;
  21. protected $_aElementParamsApi; //--- Params from DefaultsApi array to be passed to Api
  22. public function __construct($sSystem, $iId, $iInit = true, $oTemplate = false)
  23. {
  24. parent::__construct($sSystem, $iId, $iInit, $oTemplate);
  25. $this->_bCssJsAdded = false;
  26. $this->_sJsObjClass = 'BxDolReport';
  27. $this->_sJsObjName = 'oReport' . bx_gen_method_name($sSystem, array('_' , '-')) . $iId;
  28. $this->_sStylePrefix = 'bx-report';
  29. $sHtmlId = str_replace(array('_' , ' '), array('-', '-'), $sSystem) . '-' . $iId;
  30. $this->_aHtmlIds = array(
  31. 'main' => 'bx-report-' . $sHtmlId,
  32. 'counter' => 'bx-report-counter-' . $sHtmlId,
  33. 'do_link' => 'bx-report-do-link-' . $sHtmlId,
  34. 'do_popup' => 'bx-report-do-popup-' . $sHtmlId,
  35. 'do_form' => 'bx-report-do-form-' . $sHtmlId,
  36. 'by_popup' => 'bx-report-by-popup-' . $sHtmlId
  37. );
  38. $this->_aElementDefaults = array(
  39. 'show_do_report_as_button' => false,
  40. 'show_do_report_as_button_small' => false,
  41. 'show_do_report_icon' => true,
  42. 'show_do_report_label' => false,
  43. 'show_counter' => true,
  44. 'show_counter_only' => true
  45. );
  46. if($this->_bApi) {
  47. $aTypes = BxDolFormQuery::getDataItems($this->_sTypesPreList);
  48. $this->_aElementDefaultsApi = array_merge($this->_aElementDefaults, [
  49. 'show_counter' => true,
  50. 'types' => array_map(function($sType) use ($aTypes) {
  51. return ['name' => $sType, 'title' => $aTypes[$sType]];
  52. }, $this->_aTypes)
  53. ]);
  54. $this->_aElementParamsApi = ['is_reported', 'types'];
  55. }
  56. $this->_sTmplContentElementBlock = $this->_oTemplate->getHtml('report_element_block.html');
  57. $this->_sTmplContentElementInline = $this->_oTemplate->getHtml('report_element_inline.html');
  58. $this->_sTmplContentDoAction = $this->_oTemplate->getHtml('report_do_report.html');
  59. $this->_sTmplContentDoActionLabel = $this->_oTemplate->getHtml('report_do_report_label.html');
  60. }
  61. public function report($aParams = [])
  62. {
  63. if (!$this->isEnabled())
  64. return ['code' => 1, 'message' => _t('_report_err_not_enabled')];
  65. if(!$this->isAllowedReport())
  66. return ['code' => 2, 'message' => $this->msgErrAllowedReport()];
  67. $iAuthorId = $this->_getAuthorId();
  68. $iObjectId = $this->_iId;
  69. $iObjectAuthorId = $this->_oQuery->getObjectAuthorId($iObjectId);
  70. $bPerformed = $this->isPerformed($iObjectId, $iAuthorId);
  71. if($bPerformed) {
  72. if(!$this->isUndo())
  73. return ['code' => 4, 'message' => _t('_report_err_duplicate_report')];
  74. if(($iId = $this->_oQuery->putReport($iObjectId, $iAuthorId, true)) !== false) {
  75. $this->_trigger();
  76. bx_alert($this->_sSystem, 'undoReport', $iObjectId, $iAuthorId, array('report_id' => $iId, 'report_author_id' => $iAuthorId, 'object_author_id' => $iObjectAuthorId));
  77. /**
  78. * @hooks
  79. * @hookdef hook-report-undo 'report', 'undo' - hook on cancel report
  80. * - $unit_name - equals `report`
  81. * - $action - equals `undo`
  82. * - $object_id - report id
  83. * - $sender_id - profile_id for report's author
  84. * - $extra_params - array of additional params with the following array keys:
  85. * - `object_system` - [string] system name, ex: bx_posts
  86. * - `object_id` - [int] reported object id
  87. * - `object_author_id` - [int] author's profile_id for reported object_id
  88. * @hook @ref hook-report-undo
  89. */
  90. bx_alert('report', 'undo', $iId, $iAuthorId, array('object_system' => $this->_sSystem, 'object_id' => $iObjectId, 'object_author_id' => $iObjectAuthorId));
  91. $aReport = $this->_getReport($iObjectId, true);
  92. $aResult = $this->_returnReportData($iObjectId, $iAuthorId, $iId, $aReport, !$bPerformed);
  93. if(($oSockets = BxDolSockets::getInstance()) && $oSockets->isEnabled())
  94. $oSockets->sendEvent($this->getSocketName(), $iObjectId, 'reported', json_encode($this->_returnReportDataForSocket($aResult)));
  95. return $aResult;
  96. }
  97. }
  98. $oForm = $this->_getFormObject();
  99. $oForm->initChecker();
  100. if($oForm->isSubmittedAndValid() || ($this->_bApi && !empty($aParams) && is_array($aParams)))
  101. return $this->_report($bPerformed, $aParams, $oForm);
  102. $sPopupId = $this->_aHtmlIds['do_popup'];
  103. $sPopupContent = BxTemplFunctions::getInstance()->transBox($sPopupId, $this->_oTemplate->parseHtmlByName('report_do_report_form.html', array(
  104. 'style_prefix' => $this->_sStylePrefix,
  105. 'js_object' => $this->getJsObjectName(),
  106. 'form' => $oForm->getCode(),
  107. 'form_id' => $oForm->id,
  108. )));
  109. return ['popup' => $sPopupContent, 'popup_id' => $sPopupId];
  110. }
  111. public function getJsObjectName()
  112. {
  113. return $this->_sJsObjName;
  114. }
  115. public function getJsScript($bDynamicMode = false, $aParams = [])
  116. {
  117. $sJsObjName = $this->getJsObjectName();
  118. $aJsObjParams = [
  119. 'sObjName' => $sJsObjName,
  120. 'sSystem' => $this->getSystemName(),
  121. 'iAuthorId' => $this->_getAuthorId(),
  122. 'iObjId' => $this->getId(),
  123. 'sRootUrl' => BX_DOL_URL_ROOT,
  124. 'sSocket' => $this->getSocketName(),
  125. 'sStylePrefix' => $this->_sStylePrefix,
  126. 'aHtmlIds' => $this->_aHtmlIds,
  127. 'sUnreportConfirm' => bx_js_string(_t('_report_do_unreport_confirm'))
  128. ];
  129. if(($sK = 'js_params') && isset($aParams[$sK]) && is_array($aParams[$sK]))
  130. $aJsObjParams = array_merge($aJsObjParams, $aParams[$sK]);
  131. $sCode = "var " . $sJsObjName . " = new " . $this->_sJsObjClass . "(" . json_encode($aJsObjParams) . ");";
  132. return $this->_oTemplate->_wrapInTagJsCode($sCode);
  133. }
  134. public function getJsClick()
  135. {
  136. return $this->getJsObjectName() . '.report(this)';
  137. }
  138. public function getCounter($aParams = [])
  139. {
  140. $aParams = array_merge($this->_aElementDefaults, $aParams);
  141. $bShowDoReportAsButtonSmall = isset($aParams['show_do_report_as_button_small']) && $aParams['show_do_report_as_button_small'] == true;
  142. $bShowDoReportAsButton = !$bShowDoReportAsButtonSmall && isset($aParams['show_do_report_as_button']) && $aParams['show_do_report_as_button'] == true;
  143. $aReport = $this->_getReport($this->getId());
  144. $sClass = 'sys-action-counter';
  145. if(isset($aParams['show_counter_only']) && (bool)$aParams['show_counter_only'] === true)
  146. $sClass .= ' sys-ac-only';
  147. $sClass .= ' ' . $this->_sStylePrefix . '-counter';
  148. if($bShowDoReportAsButtonSmall)
  149. $sClass .= ' bx-btn-small-height';
  150. if($bShowDoReportAsButton)
  151. $sClass .= ' bx-btn-height';
  152. return $this->_oTemplate->parseLink('javascript:void(0)', (int)$aReport['count'] > 0 ? $this->_getCounterLabel($aReport['count']) : '', array(
  153. 'id' => $this->_aHtmlIds['counter'],
  154. 'class' => $sClass,
  155. 'title' => _t('_report_do_report_by'),
  156. 'onclick' => 'javascript:' . $this->getJsObjectName() . '.toggleByPopup(this)'
  157. ));
  158. }
  159. public function getCounterAPI($aParams = [])
  160. {
  161. $aParams = array_merge($this->_aElementDefaultsApi, $aParams);
  162. return $this->_getReport();
  163. }
  164. public function getElementBlock($aParams = array())
  165. {
  166. $aParams['usage'] = BX_DOL_REPORT_USAGE_BLOCK;
  167. return $this->getElement($aParams);
  168. }
  169. public function getElementInline($aParams = array())
  170. {
  171. $aParams['usage'] = BX_DOL_REPORT_USAGE_INLINE;
  172. return $this->getElement($aParams);
  173. }
  174. public function getElement($aParams = array())
  175. {
  176. $aParams = array_merge($this->_aElementDefaults, $aParams);
  177. $bDynamicMode = isset($aParams['dynamic_mode']) && $aParams['dynamic_mode'] === true;
  178. $bShowDoReportAsButtonSmall = isset($aParams['show_do_report_as_button_small']) && $aParams['show_do_report_as_button_small'] == true;
  179. $bShowDoReportAsButton = !$bShowDoReportAsButtonSmall && isset($aParams['show_do_report_as_button']) && $aParams['show_do_report_as_button'] == true;
  180. $bShowCounter = isset($aParams['show_counter']) && $aParams['show_counter'] === true && $this->isAllowedReportView();
  181. $iObjectId = $this->getId();
  182. $iAuthorId = $this->_getAuthorId();
  183. $aReport = $this->_getReport($iObjectId);
  184. if(!$this->isAllowedReport() && (!$this->isAllowedReportView() || (int)$aReport['count'] == 0))
  185. return '';
  186. $aParams['is_reported'] = $this->isPerformed($iObjectId, $iAuthorId) ? true : false;
  187. $sTmplName = $this->{'_getTmplContentElement' . bx_gen_method_name(!empty($aParams['usage']) ? $aParams['usage'] : BX_DOL_REPORT_USAGE_DEFAULT)}();
  188. return $this->_oTemplate->parseHtmlByContent($sTmplName, array(
  189. 'style_prefix' => $this->_sStylePrefix,
  190. 'html_id' => $this->_aHtmlIds['main'],
  191. 'class' => $this->_sStylePrefix . ($bShowDoReportAsButton ? '-button' : '') . ($bShowDoReportAsButtonSmall ? '-button-small' : ''),
  192. 'count' => $aReport['count'],
  193. 'do_report' => $this->_getDoReport($aParams),
  194. 'bx_if:show_counter' => array(
  195. 'condition' => $bShowCounter,
  196. 'content' => array(
  197. 'style_prefix' => $this->_sStylePrefix,
  198. 'bx_if:show_hidden' => array(
  199. 'condition' => (int)$aReport['count'] == 0,
  200. 'content' => array()
  201. ),
  202. 'counter' => $this->getCounter(array_merge($aParams, [
  203. 'show_counter_only' => false
  204. ]))
  205. )
  206. ),
  207. 'script' => $this->getJsScript($bDynamicMode, $aParams)
  208. ));
  209. }
  210. public function getElementAPI($aParams = [])
  211. {
  212. if(!$this->_bApi)
  213. return;
  214. if(!$this->isEnabled())
  215. return bx_api_get_msg('_report_err_not_enabled');
  216. $aParams = array_merge($this->_aElementDefaultsApi, $aParams);
  217. $iObjectId = $this->getId();
  218. $iAuthorId = $this->_getAuthorId();
  219. $bCount = $this->_isCount();
  220. $isAllowedReport = $this->isAllowedReport();
  221. $isAllowedReportView = $this->isAllowedReportView();
  222. $aParams['is_reported'] = $this->isPerformed($iObjectId, $iAuthorId);
  223. $aParams['track'] = $aParams['is_reported'] ? $this->_getTrack($iObjectId, $iAuthorId) : [];
  224. //--- Do Report
  225. $bDoReport = $this->_isShowDoReport($aParams, $isAllowedReport, $isAllowedReportView, $bCount);
  226. $aDoReport = $bDoReport ? $this->_getDoReport($aParams, $isAllowedReport) : [];
  227. //--- Counter
  228. $bCounter = $this->_isShowCounter($aParams, $isAllowedReport, $isAllowedReportView, $bCount);
  229. $aCounter = $bCounter ? $this->getCounterAPI(array_merge($aParams, [
  230. 'show_counter_only' => false,
  231. 'show_script' => false
  232. ])) : [];
  233. if(!$bDoReport && !$bCounter)
  234. return bx_api_get_msg('');
  235. return [
  236. 'type' => 'reports',
  237. 'system' => $this->_sSystem,
  238. 'object_id' => $this->_iId,
  239. 'params' => array_intersect_key($aParams, array_flip($this->_aElementParamsApi)),
  240. 'action' => $aDoReport,
  241. 'counter' => $aCounter
  242. ];
  243. }
  244. public function getReportedByWithComments($sObjectNotes)
  245. {
  246. $aTmplReports = array();
  247. $aTypes = BxDolForm::getDataItems('sys_report_types');
  248. $aReports = $this->_oQuery->getPerformedBy($this->getId());
  249. foreach($aReports as $aReport) {
  250. list($sUserName, $sUserUrl, $sUserIcon, $sUserUnit) = $this->_getAuthorInfo($aReport['author_id']);
  251. $sText = bx_process_output($aReport['text'], BX_DATA_TEXT_MULTILINE);
  252. $oCmtsNotes = BxDolCmts::getObjectInstance($sObjectNotes, -$aReport['id'], true, $this->_oTemplate);
  253. $aCmtsNotes = $oCmtsNotes->getCommentsBlock(array(), array('in_designbox' => false));
  254. $iCmtsNotesCount = $oCmtsNotes->getCommentsCount();
  255. $aTmplReports[] = array(
  256. 'style_prefix' => $this->_sStylePrefix,
  257. 'user_name' => $sUserName,
  258. 'id' => $aReport['id'],
  259. 'user_url' => $sUserUrl,
  260. 'type' => $aTypes[$aReport['type']],
  261. 'comments_count' => _t('_report_comments_count', $iCmtsNotesCount),
  262. 'comments' => $aCmtsNotes['content'],
  263. 'date' => bx_time_js($aReport['date']),
  264. 'bx_if:show_text' => array(
  265. 'condition' => strlen($sText) > 0,
  266. 'content' => array(
  267. 'text' => $sText
  268. )
  269. )
  270. );
  271. }
  272. if(empty($aTmplReports))
  273. return '';
  274. return $this->_oTemplate->parseHtmlByName('report_by_list_with_comments.html', array(
  275. 'style_prefix' => $this->_sStylePrefix,
  276. 'bx_repeat:list' => $aTmplReports
  277. ));
  278. }
  279. public function getPerformedByAPI($aParams = [])
  280. {
  281. $aValues = $this->_oQuery->getPerformedBy($this->getId());
  282. $aTmplUsers = [];
  283. foreach($aValues as $mValue) {
  284. $mValue = is_array($mValue) ? $mValue : ['author_id' => (int)$mValue, 'reaction' => ''];
  285. $aTmplUsers[] = BxDolProfile::getData($mValue['author_id']);
  286. }
  287. return [
  288. 'performed_by' => $aTmplUsers
  289. ];
  290. }
  291. /**
  292. * Internal methods.
  293. */
  294. protected function _report($bPerformed, $aParams, &$oForm)
  295. {
  296. $iAuthorId = $this->_getAuthorId();
  297. $iAuthorNip = bx_get_ip_hash($this->_getAuthorIp());
  298. $iObjectId = $this->_bApi ? $this->_iId : $oForm->getCleanValue('object_id');
  299. $iObjectAuthorId = $this->_oQuery->getObjectAuthorId($iObjectId);
  300. if(!$this->isAllowedReport(true))
  301. return ['code' => 2, 'message' => $this->msgErrAllowedReport()];
  302. $sType = $this->_bApi ? $aParams['type'] : $oForm->getCleanValue('type');
  303. if(!in_array($sType, $this->_aTypes))
  304. return ['code' => 5, 'message' => _t('_report_err_wrong_type')];
  305. $sText = $this->_bApi ? $aParams['text'] : $oForm->getCleanValue('text');
  306. $sText = bx_process_input($sText, BX_DATA_TEXT_MULTILINE);
  307. $iId = (int)$oForm->insert(['object_id' => $iObjectId, 'author_id' => $iAuthorId, 'author_nip' => $iAuthorNip, 'type' => $sType, 'text' => $sText, 'date' => time()]);
  308. if($iId != 0 && $this->_oQuery->putReport($iObjectId, $iAuthorId)) {
  309. if(!empty($this->_sObjectCmts) && ($oCmts = BxDolCmts::getObjectInstance($this->_sObjectCmts, $this->getId()))) {
  310. $sCmtText = '_report_comment';
  311. if(!empty($sText))
  312. $sCmtText = '_report_comment_with_note';
  313. $aTypes = BxDolForm::getDataItems('sys_report_types');
  314. $oCmts->add([
  315. 'cmt_author_id' => $iAuthorId,
  316. 'cmt_parent_id' => 0,
  317. 'cmt_text' => _t($sCmtText, $aTypes[$sType], $sText)
  318. ]);
  319. }
  320. $aTemplate = BxDolEmailTemplates::getInstance()->parseTemplate('t_Reported', [
  321. 'report_type' => $sType,
  322. 'report_text' => $sText,
  323. 'report_url' => $this->getBaseUrl(),
  324. ]);
  325. if($aTemplate)
  326. sendMail(getParam('site_email'), $aTemplate['Subject'], $aTemplate['Body']);
  327. if(($mixedParams = $this->_prepareAuditParams($iObjectId, ['type' => $sType, 'text' => $sText]))) {
  328. $iAuditObjectId = (int)$mixedParams['object_id'];
  329. $sAuditActionName = $mixedParams['action_name'];
  330. unset($mixedParams['object_id'], $mixedParams['action_name']);
  331. bx_audit($iAuditObjectId, $this->_sSystem, $sAuditActionName, $mixedParams);
  332. }
  333. $aReport = $this->_getReport($iObjectId, true);
  334. $iBlockContentAfter = (int)getParam('sys_security_block_content_after_n_reports');
  335. if ($iBlockContentAfter > 0 && $aReport['count'] >= $iBlockContentAfter){
  336. $oModule = BxDolModule::getInstance($this->_aSystem['module_name']);
  337. if($oModule)
  338. $oModule->_oDb->updateStatusAdmin($iObjectId, false);
  339. }
  340. $this->_trigger();
  341. bx_alert($this->_sSystem, 'doReport', $iObjectId, $iAuthorId, ['report_id' => $iId, 'report_author_id' => $iAuthorId, 'object_author_id' => $iObjectAuthorId, 'type' => $sType, 'text' => $sText]);
  342. /**
  343. * @hooks
  344. * @hookdef hook-report-do 'report', 'do' - hook on create new report
  345. * - $unit_name - equals `report`
  346. * - $action - equals `do`
  347. * - $object_id - report id
  348. * - $sender_id - profile_id for report's author
  349. * - $extra_params - array of additional params with the following array keys:
  350. * - `object_system` - [string] system name, ex: bx_posts
  351. * - `object_id` - [int] reported object id
  352. * - `object_author_id` - [int] author's profile_id for reported object_id
  353. * - `type` - [string] report type
  354. * - `text` - [bool] report text
  355. * @hook @ref hook-report-do
  356. */
  357. bx_alert('report', 'do', $iId, $iAuthorId, ['object_system' => $this->_sSystem, 'object_id' => $iObjectId, 'object_author_id' => $iObjectAuthorId, 'type' => $sType, 'text' => $sText]);
  358. if(($sModule = $this->_aSystem['module_name']) && ($sMethod = 'get_moderators') && bx_is_srv($sModule, $sMethod)) {
  359. $aModerators = bx_srv($sModule, $sMethod, [$iObjectId]);
  360. if(!empty($aModerators) && is_array($aModerators))
  361. foreach($aModerators as $iModeratorId)
  362. /**
  363. * @hooks
  364. * @hookdef hook-bx_base_general-reported_content '{module_name}', 'reported_content' - hook to notify admins/moderators about newly reported content
  365. * - $unit_name - module name
  366. * - $action - equals `reported_content`
  367. * - $object_id - content id
  368. * - $sender_id - report author profile id
  369. * - $extra_params - array of additional params with the following array keys:
  370. * - `object_author_id` - [int] admin/moderator profile id
  371. * - `report_id` - [int] report id
  372. * - `report_type` - [string] report type
  373. * - `report_text` - [string] message attached to report
  374. * @hook @ref hook-bx_base_general-reported_content
  375. */
  376. bx_alert($this->_sSystem, 'reported_content', $iObjectId, $iAuthorId, [
  377. 'object_author_id' => (int)$iModeratorId,
  378. 'report_id' => $iId,
  379. 'report_type' => $sType,
  380. 'report_text' => $sText
  381. ]);
  382. }
  383. $aResult = $this->_returnReportData($iObjectId, $iAuthorId, $iId, $aReport, !$bPerformed);
  384. if(($oSockets = BxDolSockets::getInstance()) && $oSockets->isEnabled())
  385. $oSockets->sendEvent($this->getSocketName(), $iObjectId, 'reported', json_encode($this->_returnReportDataForSocket($aResult)));
  386. return $aResult;
  387. }
  388. return ['code' => 3, 'message' => _t('_report_err_cannot_perform_action')];
  389. }
  390. protected function _getDoReport($aParams = [])
  391. {
  392. $bReported = isset($aParams['is_reported']) && $aParams['is_reported'] === true;
  393. $bShowDoReportAsButtonSmall = isset($aParams['show_do_report_as_button_small']) && $aParams['show_do_report_as_button_small'] == true;
  394. $bShowDoReportAsButton = !$bShowDoReportAsButtonSmall && isset($aParams['show_do_report_as_button']) && $aParams['show_do_report_as_button'] == true;
  395. $bDisabled = !$this->isAllowedReport() || ($bReported && !$this->isUndo());
  396. $sTitle = call_user_func_array('_t', $this->_getTitleDoReport($bReported, $aParams));
  397. if($this->_bApi)
  398. return [
  399. 'is_undo' => $this->isUndo(),
  400. 'is_reported' => $bReported,
  401. 'is_disabled' => $bDisabled,
  402. 'title' => $sTitle,
  403. ];
  404. $sClass = '';
  405. if($bShowDoReportAsButton)
  406. $sClass = 'bx-btn';
  407. else if ($bShowDoReportAsButtonSmall)
  408. $sClass = 'bx-btn bx-btn-small';
  409. if($bDisabled)
  410. $sClass .= $bShowDoReportAsButton || $bShowDoReportAsButtonSmall ? ' bx-btn-disabled' : 'bx-report-disabled';
  411. if($bReported)
  412. $sClass .= ' bx-report-reported';
  413. return $this->_oTemplate->parseHtmlByContent($this->_getTmplContentDoAction(), array(
  414. 'style_prefix' => $this->_sStylePrefix,
  415. 'html_id' => $this->_aHtmlIds['do_link'],
  416. 'class' => $sClass,
  417. 'title' => bx_html_attribute($sTitle),
  418. 'bx_if:show_onclick' => array(
  419. 'condition' => !$bDisabled,
  420. 'content' => array(
  421. 'js_object' => $this->getJsObjectName()
  422. )
  423. ),
  424. 'do_report' => $this->_getLabelDoReport($aParams),
  425. ));
  426. }
  427. protected function _getCounterLabel($iCount)
  428. {
  429. return _t('_report_counter', $iCount);
  430. }
  431. protected function _getLabelDoReport($aParams = [])
  432. {
  433. $bReported = isset($aParams['is_reported']) && $aParams['is_reported'] === true;
  434. return $this->_oTemplate->parseHtmlByContent($this->_getTmplContentDoActionLabel(), [
  435. 'style_prefix' => $this->_sStylePrefix,
  436. 'bx_if:show_icon' => [
  437. 'condition' => isset($aParams['show_do_report_icon']) && $aParams['show_do_report_icon'] == true,
  438. 'content' => [
  439. 'style_prefix' => $this->_sStylePrefix,
  440. 'name' => $this->_getIconDoReport($bReported)
  441. ]
  442. ],
  443. 'bx_if:show_text' => [
  444. 'condition' => isset($aParams['show_do_report_label']) && $aParams['show_do_report_label'] == true,
  445. 'content' => [
  446. 'style_prefix' => $this->_sStylePrefix,
  447. 'text' => call_user_func_array('_t', $this->_getTitleDoReport($bReported, $aParams))
  448. ]
  449. ]
  450. ]);
  451. }
  452. protected function _getReportedBy()
  453. {
  454. $aTmplReports = array();
  455. $aTypes = BxDolForm::getDataItems('sys_report_types');
  456. $aReports = $this->_oQuery->getPerformedBy($this->getId());
  457. foreach($aReports as $aReport) {
  458. list($sUserName, $sUserUrl, $sUserIcon, $sUserUnit) = $this->_getAuthorInfo($aReport['author_id']);
  459. $sText = bx_process_output($aReport['text'], BX_DATA_TEXT_MULTILINE);
  460. $aTmplReports[] = array(
  461. 'style_prefix' => $this->_sStylePrefix,
  462. 'user_unit' => $sUserUnit,
  463. 'type' => $aTypes[$aReport['type']],
  464. 'bx_if:show_text' => array(
  465. 'condition' => strlen($sText) > 0,
  466. 'content' => array(
  467. 'text' => $sText
  468. )
  469. )
  470. );
  471. }
  472. if(empty($aTmplReports))
  473. $aTmplReports = MsgBox(_t('_Empty'));
  474. return $this->_oTemplate->parseHtmlByName('report_by_list.html', array(
  475. 'style_prefix' => $this->_sStylePrefix,
  476. 'bx_repeat:list' => $aTmplReports
  477. ));
  478. }
  479. protected function _returnReportData($iObjectId, $iAuthorId, $iReportId, $aData, $bPerformed)
  480. {
  481. $bUndo = $this->isUndo();
  482. if(empty($aData) || !is_array($aData))
  483. $aData = $this->_getReport($iObjectId);
  484. $aResult = array(
  485. 'eval' => $this->getJsObjectName() . '.onReport(oData, oElement)',
  486. 'code' => 0,
  487. 'id' => $iReportId,
  488. 'count' => $aData['count'],
  489. 'countf' => (int)$aData['count'] > 0 ? $this->_getCounterLabel($aData['count']) : '',
  490. 'label_icon' => $this->_getIconDoReport($bPerformed),
  491. 'label_title' => call_user_func_array('_t', $this->_getTitleDoReport($bPerformed)),
  492. 'reported' => $bPerformed,
  493. 'disabled' => $bPerformed && !$bUndo,
  494. );
  495. $aResult['api'] = [
  496. 'performer_id' => $iAuthorId,
  497. 'is_reported' => $aResult['reported'],
  498. 'is_disabled' => $aResult['disabled'],
  499. 'icon' => $aResult['label_icon'],
  500. 'title' => $aResult['label_title'],
  501. 'counter' => $this->_getReport()
  502. ];
  503. return $aResult;
  504. }
  505. protected function _returnReportDataForSocket($aData, $aMask = [])
  506. {
  507. if(empty($aMask) || !is_array($aMask))
  508. $aMask = ['code', 'count', 'countf', 'api'];
  509. return array_intersect_key($aData, array_flip($aMask));
  510. }
  511. private function _prepareAuditParams($iObjectId, $aData)
  512. {
  513. $sModule = $this->_sSystem;
  514. $sKeyObjectContentInfo = 'OBJECT_CONTENT_INFO';
  515. $sActionName = '_sys_audit_action_report';
  516. if ($this->_sSystem == 'sys_cmts'){
  517. $aCommentData = BxDolCmtsQuery::getInfoByUniqId($iObjectId);
  518. $oComment = BxDolCmts::getObjectInstance($aCommentData['system_name'], $aCommentData['cmt_object_id']);
  519. $aComment = $oComment->getCommentSimple($aCommentData['cmt_id']);
  520. $aSystem = $oComment->getSystemInfo();
  521. $sModule = $aSystem['module'];
  522. $aData['comment_id'] = $aCommentData['cmt_id'];
  523. $aData['comment_author_id'] = $aComment['cmt_author_id'];
  524. $aData['comment_text'] = $aComment['cmt_text'];
  525. $iObjectId = $aCommentData['cmt_object_id'];
  526. $sKeyObjectContentInfo = 'OBJECT_CMTS_CONTENT_INFO';
  527. $sActionName = '_sys_audit_action_report_comment';
  528. }
  529. $oModule = BxDolModule::getInstance($sModule);
  530. if ($oModule) {
  531. $CNF = $oModule->_oConfig->CNF;
  532. $aContentInfo = BxDolRequest::serviceExists($sModule, 'get_all') ? BxDolService::call($sModule, 'get_all', array(array('type' => 'id', 'id' => $iObjectId))) : array();
  533. return [
  534. 'content_title' => !empty($CNF['FIELD_TITLE']) ? $aContentInfo[$CNF['FIELD_TITLE']] : '',
  535. 'content_info_object' => !empty($CNF[$sKeyObjectContentInfo]) ? $CNF[$sKeyObjectContentInfo] : '',
  536. 'data' => $aData,
  537. 'action_name' => $sActionName,
  538. 'object_id' => $iObjectId
  539. ];
  540. }
  541. return false;
  542. }
  543. protected function _isShowDoReport($aParams, $isAllowedReport, $isAllowedReportView, $bCount)
  544. {
  545. $bShowDoReport = !isset($aParams['show_do_report']) || (bool)$aParams['show_do_report'] === true;
  546. return $bShowDoReport && ($isAllowedReport || ($isAllowedReportView && $bCount));
  547. }
  548. protected function _isShowCounter($aParams, $isAllowedReport, $isAllowedReportView, $bCount)
  549. {
  550. $bShowCounter = isset($aParams['show_counter']) && (bool)$aParams['show_counter'] === true;
  551. return $bShowCounter && $isAllowedReportView && ($isAllowedReport || $bCount);
  552. }
  553. }
  554. /** @} */