BxBasePage.php 43 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281
  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. require_once(BX_DIRECTORY_PATH_INC . 'design.inc.php');
  10. /**
  11. * Page representation.
  12. * @see BxDolPage
  13. */
  14. class BxBasePage extends BxDolPage
  15. {
  16. protected $_oTemplate;
  17. protected $_sStorage; //--- Storage object for page's images like custom cover, HTML block attachments, etc.
  18. protected $_oPageCacheObject = null;
  19. protected $_oBlockCacheObject = null;
  20. protected $_sJsClassName = '';
  21. protected $_sJsObjectName = '';
  22. protected $_aHtmlIds = [];
  23. protected $_bStickyColumns = false;
  24. protected $_bSubPage = false;
  25. public function __construct ($aObject, $oTemplate)
  26. {
  27. parent::__construct ($aObject);
  28. if ($oTemplate)
  29. $this->_oTemplate = $oTemplate;
  30. else
  31. $this->_oTemplate = BxDolTemplate::getInstance();
  32. $this->_sStorage = 'sys_images';
  33. $this->_sJsClassName = 'BxDolPage';
  34. $this->_sJsObjectName = 'oBxDolPage';
  35. $this->_bStickyColumns = isset($this->_aObject['sticky_columns']) && $this->_aObject['sticky_columns'] == 1;
  36. $sHtmlId = str_replace(array('_' , ' '), array('-', '-'), $this->_sObject);
  37. $this->_aHtmlIds = array(
  38. 'help_popup' => $sHtmlId . '-help-popup-',
  39. );
  40. $this->addMarkers(array('site_title' => getParam('site_title')));
  41. }
  42. public function performActionGetHelp ()
  43. {
  44. $iBlockId = (int)bx_get('block_id');
  45. if(empty($iBlockId))
  46. return;
  47. $aBlock = $this->_oQuery->getPageBlock($iBlockId);
  48. if(empty($aBlock) || !is_array($aBlock) || empty($aBlock['help']))
  49. return;
  50. echo $this->_oTemplate->parseHtmlByName('designbox_help_popup.html', array(
  51. 'content' => _t($aBlock['help'])
  52. ));
  53. }
  54. public function performActionGetShare ()
  55. {
  56. $aEmbedData = BxDolPage::getEmbedData(bx_get('url'));
  57. if(!isset($aEmbedData['url']))
  58. return;
  59. $sMenu = '';
  60. if(getParam('sys_a2a_enable') != 'on') {
  61. if(($oMenu = BxDolMenu::getObjectInstance('sys_social_sharing')) !== false) {
  62. $oMenu->addMarkers([
  63. 'url' => $aEmbedData['url'],
  64. 'img_url_encoded' => '',
  65. 'title_encoded' => ''
  66. ]);
  67. $sMenu = $oMenu->getCode();
  68. }
  69. }
  70. else
  71. $sMenu = getParam('sys_a2a_code');
  72. echo PopupBox('sys_share_popup', _t('_sys_txt_share_popup_header'), $this->_oTemplate->parseHtmlByName('designbox_share_popup.html', [
  73. 'url' => bx_process_output($aEmbedData['url']),
  74. 'menu' => $sMenu,
  75. 'code' => htmlspecialchars($aEmbedData['html']),
  76. ]), true);
  77. }
  78. public function performActionEmbed ()
  79. {
  80. $aCover = $this->getPageCoverImage();
  81. $sTitle = $this->_getPageTitle();
  82. $this->_oTemplate->getEmbed($this->_oTemplate->parseHtmlByName('embed_card.html', [
  83. 'title' => $sTitle,
  84. 'url' => BxDolPermalinks::getInstance()->permalink($this->_aObject['url']),
  85. 'bx_if:thumb' => [
  86. 'condition' => $this->isPageCover() && count($aCover) > 0,
  87. 'content' => [
  88. 'title' => $sTitle,
  89. 'url' => BxDolPermalinks::getInstance()->permalink($this->_aObject['url']),
  90. 'background' => BxDolCover::getInstance(BxDolTemplate::getInstance())->getCoverImageUrl($aCover)
  91. ],
  92. ],
  93. 'bx_if:no_thumb' => [
  94. 'condition' => count($aCover) == 0 || !$this->isPageCover(),
  95. 'content' => [
  96. 'title' => $sTitle,
  97. 'url' => BxDolPermalinks::getInstance()->permalink($this->_aObject['url']),
  98. ]
  99. ]
  100. ]
  101. ));
  102. }
  103. public function performActionCreativeSave()
  104. {
  105. if(!$this->isAllowedCreativeManage())
  106. return echoJson(['code' => 1]);
  107. $iId = 0;
  108. $sContent = '';
  109. if(($iId = bx_get('b')) === false || ($sContent = bx_get('c')) === false)
  110. return echoJson(['code' => 2]);
  111. $iId = bx_process_input($iId, BX_DATA_INT);
  112. $sContent = bx_process_input($sContent, BX_DATA_HTML);
  113. if(!$this->_oQuery->setPageBlockContent($iId, $sContent))
  114. return echoJson(['code' => 3]);
  115. return echoJson(['code' => 0]);
  116. }
  117. public function isAllowedCreativeManage()
  118. {
  119. return isAdmin();
  120. }
  121. /**
  122. * Very similar to BxBasePage::getCode
  123. * but adds css and js files which are needed for the corect page display
  124. */
  125. public function getCodeDynamic ()
  126. {
  127. // TODO: remake to use use collect* template methods
  128. $oTemplate = BxDolTemplate::getInstance();
  129. // get js&css before the page code is generated
  130. $aCssBefore = $oTemplate->getCss();
  131. $aJsBefore = $oTemplate->getJs();
  132. // generate page code
  133. $sContent = $this->getCode();
  134. // get js&css after the page code is generated
  135. $aCssAfter = $oTemplate->getCss();
  136. $aJsAfter = $oTemplate->getJs();
  137. // compare files which were added before and after page code is generated
  138. $f = function ($a1, $a2) {
  139. return strcasecmp($a1['url'], $a2['url']);
  140. };
  141. $aCssNew = array_udiff($aCssAfter, $aCssBefore, $f);
  142. $aJsNew = array_udiff($aJsAfter, $aJsBefore, $f);
  143. // add newly added js&css files in static mode
  144. $sCss = $sJs = '';
  145. foreach ($aCssNew as $a)
  146. $sCss .= $oTemplate->addCss($a['url'], true);
  147. foreach ($aJsNew as $a)
  148. $sJs .= $oTemplate->addJs($a['url'], true);
  149. return $sJs . $sCss . $sContent;
  150. }
  151. public function getIncludes ()
  152. {
  153. $oTemplate = BxDolTemplate::getInstance();
  154. // generate page code
  155. $this->getCode();
  156. // get js&css after the page code is generated
  157. $aCss = $oTemplate->getCss();
  158. $aJs = $oTemplate->getJs();
  159. // add js&css files in static mode
  160. $sResult = '';
  161. foreach ($aCss as $a)
  162. $sResult .= $oTemplate->addCss($a['url'], true);
  163. foreach ($aJs as $a)
  164. $sResult .= $oTemplate->addJs($a['url'], true);
  165. return $sResult;
  166. }
  167. /**
  168. * Get page code with automatic caching, adding necessary css/js files and system template vars.
  169. * @return string.
  170. */
  171. public function getCode ()
  172. {
  173. if (bx_get('dynamic') && ($iBlockId = (int)bx_get('pageBlock'))) {
  174. if (self::isLockedFromUnauthenticated($this->_aObject['uri']) || !$this->_isVisiblePage($this->_aObject)) {
  175. header('HTTP/1.0 403 Forbidden');
  176. exit;
  177. }
  178. bx_alert('system', 'page_output_block', 0, false, array(
  179. 'page_name' => $this->_sObject,
  180. 'page_object' => $this,
  181. 'page_query' => $this->_oQuery,
  182. 'block_id' => (int)$iBlockId,
  183. ));
  184. header( 'Content-type:text/html;charset=utf-8' );
  185. BxDolTemplate::getInstance()->collectingStart();
  186. $s = $this->_getBlockOnlyCode($iBlockId);
  187. $sCss = bx_get('includedCss');
  188. $sJs = bx_get('includedJs');
  189. echo BxDolTemplate::getInstance()->collectingEndGetCode($sCss ? @json_decode($sCss) : [], $sJs ? @json_decode($sJs) : []);
  190. echo $s;
  191. exit;
  192. }
  193. if (($mixedAvailable = $this->_isAvailablePage($this->_aObject)) !== true)
  194. return $this->_getPageNotFoundMsg($mixedAvailable);
  195. if (($mixedVisible = $this->_isVisiblePage($this->_aObject)) !== true)
  196. return $this->_getPageAccessDeniedMsg($mixedVisible);
  197. $this->_addJsCss();
  198. if (!$this->_bSubPage) {
  199. $this->_addSysTemplateVars();
  200. $this->_selectMenu();
  201. $this->_setSubmenu(array());
  202. }
  203. if (bx_is_dbg() || !getParam('sys_page_cache_enable') || !$this->_aObject['cache_lifetime'] || (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'POST')) {
  204. $sPageCode = $this->_getPageCode();
  205. }
  206. else {
  207. $oCache = $this->_getPageCacheObject();
  208. $sKey = $this->_getPageCacheKey();
  209. $sKeyCssJs = 'cssjs_' . $sKey;
  210. $mixedRet = $oCache->getData($sKey, $this->_aObject['cache_lifetime']);
  211. $aRetCssJs = $oCache->getData($sKeyCssJs, $this->_aObject['cache_lifetime']);
  212. if ($mixedRet !== null && $aRetCssJs !== null) {
  213. BxDolTemplate::getInstance()->collectingStart();
  214. BxDolTemplate::getInstance()->collectingInject($aRetCssJs['css'], $aRetCssJs['js']);
  215. $sPageCode = BxDolTemplate::getInstance()->collectingEndGetCode();
  216. $sPageCode .= $mixedRet;
  217. } else {
  218. BxDolTemplate::getInstance()->collectingStart();
  219. $sPageCode = $this->_getPageCode();
  220. $aPageCssJs = BxDolTemplate::getInstance()->collectingEndGetCode(array(), array(), 'array');
  221. $oCache->setData($sKey, $sPageCode, $this->_aObject['cache_lifetime']);
  222. $oCache->setData($sKeyCssJs, $aPageCssJs, $this->_aObject['cache_lifetime']);
  223. }
  224. }
  225. bx_alert('system', 'page_output', 0, false, array(
  226. 'page_name' => $this->_sObject,
  227. 'page_object' => $this,
  228. 'page_query' => $this->_oQuery,
  229. 'page_code' => &$sPageCode,
  230. 'sub_page' => $this->_bSubPage,
  231. ));
  232. if (!$this->_bSubPage)
  233. $sPageCode .= $this->getJsScript();
  234. return $sPageCode;
  235. }
  236. public function getJsClassName()
  237. {
  238. return $this->_sJsClassName;
  239. }
  240. public function getJsObjectName()
  241. {
  242. return $this->_sJsObjectName;
  243. }
  244. function _wrapInTagJsCode($sCode)
  245. {
  246. return "<script language=\"javascript\">\n<!--\n" . $sCode . "\n-->\n</script>";
  247. }
  248. public function getJsScript()
  249. {
  250. $sJsObjName = $this->getJsObjectName();
  251. $sJsObjClass = $this->getJsClassName();
  252. $sCode = "if(window['" . $sJsObjName . "'] == undefined) var " . $sJsObjName . " = new " . $sJsObjClass . "(" . json_encode(array(
  253. 'sObjName' => $sJsObjName,
  254. 'sObject' => $this->_sObject,
  255. 'sRootUrl' => BX_DOL_URL_ROOT,
  256. 'aHtmlIds' => $this->_aHtmlIds,
  257. 'isStickyColumns' => $this->_bStickyColumns
  258. )) . ");";
  259. return $this->_wrapInTagJsCode($sCode);
  260. }
  261. /**
  262. * Is page cover enabled.
  263. * @return string
  264. */
  265. public function isPageCover()
  266. {
  267. $bResult = false;
  268. switch((int)$this->_aObject['cover']) {
  269. case 1: //--- Enabled for all
  270. $bResult = true;
  271. break;
  272. case 2: //--- Enabled for visitors only
  273. $bResult = !isLogged();
  274. break;
  275. case 3: //--- Enabled for members only
  276. $bResult = isLogged();
  277. break;
  278. }
  279. return $bResult;
  280. }
  281. public function setSubPage($b = true)
  282. {
  283. $this->_bSubPage = $b;
  284. }
  285. public function setPageCover($bCover = true)
  286. {
  287. $this->_aObject['cover'] = (bool)$bCover;
  288. }
  289. public function getPageCoverImage($bTranscoder = true)
  290. {
  291. $iId = (int)$this->_aObject['cover_image'];
  292. if(empty($iId)) {
  293. $iId = (int)getParam('sys_site_cover_common');
  294. if(empty($iId))
  295. return array();
  296. }
  297. $aResult = array(
  298. 'id' => $iId
  299. );
  300. if($bTranscoder)
  301. $aResult['transcoder'] = BX_DOL_TRANSCODER_OBJ_COVER;
  302. else
  303. $aResult['object'] = $this->_sStorage;
  304. return $aResult;
  305. }
  306. public function getPageCoverParams()
  307. {
  308. $aParams = [
  309. 'title' => $this->_getPageTitle(),
  310. 'actions' => '',
  311. 'bx_if:image' => [
  312. 'condition' => false,
  313. 'content' => []
  314. ],
  315. 'bx_if:icon' => [
  316. 'condition' => false,
  317. 'content' => []
  318. ],
  319. ];
  320. if(($oMenuSubmenu = BxDolMenu::getObjectInstance('sys_site_submenu')) !== false) {
  321. $aCoverParams = $oMenuSubmenu->getPageCoverParams();
  322. if(!empty($aCoverParams) && is_array($aCoverParams))
  323. $aParams = $aCoverParams;
  324. }
  325. if(!empty($this->_aObject['cover_title'])) {
  326. $sCoverTitle = _t($this->_aObject['cover_title']);
  327. if($sCoverTitle && strcmp($sCoverTitle, $this->_aObject['cover_title']) != 0)
  328. $aParams['title'] = $sCoverTitle;
  329. }
  330. return $aParams;
  331. }
  332. /**
  333. * Get block title.
  334. * @return string
  335. */
  336. public function getBlockTitle ($aBlock)
  337. {
  338. return $this->_replaceMarkers(_t($aBlock['title']), array('block_id' => $aBlock['id']));
  339. }
  340. /**
  341. * Get help control if help is available for the block.
  342. * @return string
  343. */
  344. public function getBlockHelp ($aBlock)
  345. {
  346. if(empty($aBlock['help']) || empty(strip_tags(_t($aBlock['help']))))
  347. return '';
  348. return $this->_oTemplate->parseHtmlByName('designbox_help.html', array(
  349. 'js_object' => $this->_sJsObjectName,
  350. 'block_id' => $aBlock['id']
  351. ));
  352. }
  353. /**
  354. * Get code to load block asyncroniously
  355. * @param $aBlock block code
  356. * @param $iAsync if greater than 0 the it defines loading indicator for the block
  357. * @return HTML code string
  358. */
  359. public function getBlockAsyncCode($aBlock, $iAsync)
  360. {
  361. $aContentPlaceholder = $this->_oQuery->getPageBlockContentPlaceholder($iAsync);
  362. if (!$aContentPlaceholder)
  363. return _t('_sys_txt_error_occured');
  364. $oTemplate = $this->_oTemplate;
  365. if ('system' != $aContentPlaceholder['module']) {
  366. $oModule = BxDolModule::getInstance($aContentPlaceholder['module']);
  367. if (!$oModule)
  368. return _t('_sys_txt_error_occured');
  369. $oTemplate = $oModule->_oTemplate;
  370. }
  371. return $oTemplate->parseHtmlByName($aContentPlaceholder['template'], $aBlock);
  372. }
  373. /**
  374. * Get page array with all cells and blocks
  375. */
  376. public function getPageAPI ($aBlocks = [])
  377. {
  378. define('BX_API_PAGE', true);
  379. $query_string = '';
  380. if (isset(bx_get('params')[2]) && bx_get('params')[2] != ''){
  381. $array = json_decode(bx_get('params')[2], true);
  382. $query_string = http_build_query($array);
  383. parse_str($query_string, $_GET);
  384. }
  385. $sMetaTitle = $this->_getPageMetaTitle();
  386. $sName = $this->_getPageTitle();
  387. $a = [
  388. 'id' => $this->_aObject['id'],
  389. 'title' => $sMetaTitle ? $sMetaTitle : $sName,
  390. 'name' => $sName,
  391. 'uri' => $this->_aObject['uri'],
  392. 'url' => ((bx_get('params')[0] ? bx_get('params')[0] : $this->_aObject['uri'] ) . ($query_string != '' ? '?' . $query_string : '')),
  393. 'author' => $this->_aObject['author'],
  394. 'added' => $this->_aObject['added'],
  395. 'module' => $this->getModule(),
  396. 'type' => $this->getType (),
  397. 'layout' => str_replace('.html', '', $this->_aObject['template']),
  398. 'cover_block' => '',
  399. 'menu_top' => '',
  400. 'menu' => '',
  401. 'menu_bottom' => '',
  402. 'menu_add' => '',
  403. 'elements' => $this->getPageBlocksAPI($aBlocks),
  404. ];
  405. if (BxDolCover::getInstance($this)->isCover() && isset($this->_aProfileInfo)) {
  406. $oModule = BxDolModule::getInstance($this->getModule());
  407. $aContentInfo = bx_srv($this->getModule(), 'get_info', [$this->_aProfileInfo['content_id'], false]);
  408. $a['cover_block'] = [
  409. 'profile' => BxDolProfile::getData($this->_aProfileInfo['id'], [
  410. 'get_avatar' => 'getAvatarBig',
  411. 'with_info' => true
  412. ]),
  413. 'actions_menu' => '',
  414. 'meta_menu' => '',
  415. 'badges' => BxDolProfile::getInstance($this->_aProfileInfo['id'])->getBadges(),
  416. 'cover' => $oModule->serviceGetCover($this->_aProfileInfo['content_id']),
  417. 'allow_edit' => $oModule->checkAllowedChangeCover($aContentInfo) === CHECK_ACTION_RESULT_ALLOWED
  418. ];
  419. $CNF = $oModule->_oConfig->CNF;
  420. if(!empty($CNF['OBJECT_MENU_VIEW_ENTRY_META'])){
  421. $oMetaMenu = BxTemplMenu::getObjectInstance($CNF['OBJECT_MENU_VIEW_ENTRY_META']);
  422. $a['cover_block']['meta_menu'] = $oMetaMenu->getCodeAPI();
  423. }
  424. $oConnection = BxDolConnection::getObjectInstance($CNF['OBJECT_CONNECTIONS']);
  425. if ($oConnection){
  426. $a['cover_block']['members_list'] = $oConnection->getConnectedListAPI($this->_aProfileInfo['id'], false, BX_CONNECTIONS_CONTENT_TYPE_INITIATORS, 10);
  427. }
  428. if(!empty($CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY'])){
  429. $oActionMenu = BxTemplMenu::getObjectInstance($CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY_ALL']);
  430. $a['cover_block']['actions_menu'] = $oActionMenu->getCodeAPI();
  431. }
  432. }
  433. $sMenuTop = getParam('sys_api_menu_top');
  434. if (!empty($sMenuTop) && ($oMenuTop = BxDolMenu::getObjectInstance($sMenuTop)) !== false)
  435. $a['menu_top'] = $oMenuTop->getCodeAPI();
  436. if (($oMenuSubmenu = BxDolMenu::getObjectInstance('sys_site_submenu')) !== false) {
  437. if(($sSubmenu = $this->getSubMenu()) !== '')
  438. $oMenuSubmenu->setObjectSubmenu($sSubmenu, []);
  439. $a['menu'] = $oMenuSubmenu->getCodeAPI();
  440. }
  441. if (isLogged()) {
  442. /* temporatery commented
  443. if(($oMenuAddContent = BxDolMenu::getObjectInstance('sys_add_content')) !== false)
  444. $a['menu_add'] = $oMenuAddContent->getCodeAPI();
  445. */
  446. $o = BxDolProfile::getInstance();
  447. $a['user'] = BxDolProfile::getDataForPage($o);
  448. $oInformer = BxDolInformer::getInstance(BxDolTemplate::getInstance());
  449. $sRet = $oInformer ? $oInformer->display() : '';
  450. if ($sRet){
  451. $a['user']['informer'] = $sRet;
  452. }
  453. $sModuleNotifications = 'bx_notifications';
  454. if(BxDolRequest::serviceExists($sModuleNotifications, 'get_unread_notifications_num'))
  455. $a['user']['notifications'] = bx_srv($sModuleNotifications, 'get_unread_notifications_num', [$o->id()]);
  456. $oPayments = BxDolPayments::getInstance();
  457. if($oPayments->isActive())
  458. $a['user']['cart'] = $oPayments->getCartItemsCount();
  459. }
  460. $aExtras = [
  461. 'page' => $this,
  462. 'blocks' => $aBlocks,
  463. 'data' => &$a,
  464. ];
  465. if(!$this->_isAvailablePage($this->_aObject))
  466. $a['page_status'] = 404;
  467. else if(!$this->_isVisiblePage($this->_aObject))
  468. $a['page_status'] = 403;
  469. bx_alert('system', 'get_page_api', 0, 0, $aExtras);
  470. return $a;
  471. }
  472. public function getPageBlocksAPI($aBlocks = [])
  473. {
  474. $bBlocks = !empty($aBlocks) && is_array($aBlocks);
  475. $aFieldsUnset = ['object', 'cell_id', 'title_system', 'class', 'submenu', 'tabs', 'async', 'visible_for_levels', 'hidden_on', 'type', 'text', 'text_updated', 'help', 'cache_lifetime', 'active', 'active_api', 'copyable', 'deletable', 'order'];
  476. $aCells = $this->_oQuery->getPageBlocks(true);
  477. foreach($aCells as $sKey => &$aCell) {
  478. foreach($aCell as $i => $aBlock) {
  479. if(!$this->_isVisibleBlock($aBlock)) {
  480. unset($aCells[$sKey][$i]);
  481. continue;
  482. }
  483. $this->processPageBlock($aCells[$sKey][$i], true);
  484. $aBlock = $aCells[$sKey][$i];
  485. $sSource = '';
  486. if($aBlock['type'] == 'service') {
  487. $aContent = @unserialize($aBlock['content']);
  488. if(isset($aContent['module'], $aContent['method']))
  489. $sSource = $aContent['module'] . ':' . $aContent['method'];
  490. }
  491. else{
  492. $sSource = 'system:block_' . $aBlock['id'];
  493. }
  494. if($bBlocks && !in_array($sSource, $aBlocks)) {
  495. unset($aCells[$sKey][$i]);
  496. continue;
  497. }
  498. $sFunc = '_getBlock' . ucfirst($aBlock['type']);
  499. $mBlock = method_exists($this, $sFunc) ? $this->$sFunc($aBlock) : $aBlock['content'];
  500. $aCells[$sKey][$i] = array_merge($aCells[$sKey][$i], [
  501. 'title' => isset($mBlock['title']) ? $mBlock['title'] : $this->getBlockTitle($aBlock),
  502. 'content' => isset($mBlock['content']) ? $mBlock['content'] : $mBlock,
  503. 'menu' => isset($mBlock['menu']) ? $mBlock['menu'] : '',
  504. 'source' => $sSource
  505. ]);
  506. $aCells[$sKey][$i] = array_diff_key($aCells[$sKey][$i], array_flip($aFieldsUnset));
  507. }
  508. }
  509. return array_map('array_values', $aCells);
  510. }
  511. /**
  512. * Get page code vars
  513. * @return string
  514. */
  515. protected function _getPageCodeVars ()
  516. {
  517. $aHiddenOn = array(
  518. pow(2, BX_DB_HIDDEN_PHONE - 1) => 'bx-def-media-phone-hide',
  519. pow(2, BX_DB_HIDDEN_TABLET - 1) => 'bx-def-media-tablet-hide',
  520. pow(2, BX_DB_HIDDEN_DESKTOP - 1) => 'bx-def-media-desktop-hide',
  521. pow(2, BX_DB_HIDDEN_MOBILE - 1) => 'bx-def-mobile-app-hide'
  522. );
  523. $aVars = array (
  524. 'page_id' => 'bx-page-' . $this->_aObject['uri'],
  525. 'bx_if:show_layout_row_dump' => array(
  526. 'condition' => false,
  527. 'content' => array()
  528. )
  529. );
  530. $aBlocks = $this->_oQuery->getPageBlocks();
  531. foreach ($aBlocks as $sKey => $aCell) {
  532. $sCell = '';
  533. foreach ($aCell as $aBlock) {
  534. $this->processPageBlock($aBlock, false);
  535. $sContentWithBox = $this->_getBlockCodeWithCache($aBlock, $aBlock['async']);
  536. $sClassAdd = '';
  537. if(!empty($aBlock['class']))
  538. $sClassAdd .= ' ' . $aBlock['class'];
  539. if(!empty($aBlock['hidden_on']))
  540. foreach($aHiddenOn as $iHiddenOn => $sHiddenOnClass)
  541. if((int)$aBlock['hidden_on'] & $iHiddenOn)
  542. $sClassAdd .= ' ' . $sHiddenOnClass;
  543. if ($sContentWithBox)
  544. $sCell .= $this->_oTemplate->parseHtmlByName('designbox_container.html', array(
  545. 'class_add' => $sClassAdd,
  546. 'bx_if:show_html_id' => array(
  547. 'condition' => true,
  548. 'content' => array(
  549. 'html_id' => 'bx-page-block-' . $aBlock['id']
  550. ),
  551. ),
  552. 'content' => $sContentWithBox
  553. ));
  554. }
  555. $aVars[$sKey] = $sCell;
  556. }
  557. return $aVars;
  558. }
  559. /**
  560. * Process block values, especially if someting need to be overrided
  561. */
  562. protected function processPageBlock(&$aBlock, $bApi = false)
  563. {
  564. }
  565. /**
  566. * Get page code only.
  567. * @return string
  568. */
  569. protected function _getPageCode ()
  570. {
  571. $aVars = $this->_getPageCodeVars ();
  572. return $this->_oTemplate->parseHtmlByName($this->_aObject['template'], $aVars);
  573. }
  574. /**
  575. * Get one block code only.
  576. * @return string
  577. */
  578. protected function _getBlockOnlyCode ($iBlockId)
  579. {
  580. if (!($aBlock = $this->_oQuery->getPageBlock((int)$iBlockId)))
  581. return '';
  582. return $this->_getBlockCodeWithCache($aBlock, 0);
  583. }
  584. protected function _getBlockCodeWithCache(&$aBlock, $iAsync = 0)
  585. {
  586. if (bx_is_dbg() || !getParam('sys_pb_cache_enable') || !$aBlock['cache_lifetime'] || $iAsync || (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'POST')) {
  587. $sBlockCode = $this->_getBlockCode($aBlock, $iAsync);
  588. }
  589. else {
  590. $oCache = $this->_getBlockCacheObject();
  591. $sKey = $this->_getBlockCacheKey(false, $aBlock);
  592. $sKeyCssJs = 'cssjs_' . $sKey;
  593. $mixedRet = $oCache->getData($sKey, $aBlock['cache_lifetime']);
  594. $aRetCssJs = $oCache->getData($sKeyCssJs, $aBlock['cache_lifetime']);
  595. if ($mixedRet !== null && $aRetCssJs !== null) {
  596. BxDolTemplate::getInstance()->collectingStart();
  597. BxDolTemplate::getInstance()->collectingInject($aRetCssJs['css'], $aRetCssJs['js']);
  598. $sBlockCode = BxDolTemplate::getInstance()->collectingEndGetCode();
  599. $sBlockCode .= $mixedRet;
  600. } else {
  601. BxDolTemplate::getInstance()->collectingStart();
  602. $sBlockCode = $this->_getBlockCode($aBlock, $iAsync);
  603. $aBlockCssJs = BxDolTemplate::getInstance()->collectingEndGetCode(array(), array(), 'array');
  604. $oCache->setData($sKey, $sBlockCode, $aBlock['cache_lifetime']);
  605. $oCache->setData($sKeyCssJs, $aBlockCssJs, $aBlock['cache_lifetime']);
  606. }
  607. }
  608. return $sBlockCode;
  609. }
  610. /**
  611. * Get block code.
  612. * @return string
  613. */
  614. protected function _getBlockCode(&$aBlock, $iAsync = 0)
  615. {
  616. $sContentWithBox = '';
  617. $oFunctions = $this->_oTemplate->getTemplateFunctions();
  618. if (isset($GLOBALS['bx_profiler'])) $GLOBALS['bx_profiler']->beginPageBlock(_t($aBlock['title']), $aBlock['id']);
  619. $aDbNoTitle = [BX_DB_CONTENT_ONLY, BX_DB_PADDING_CONTENT_ONLY, BX_DB_NO_CAPTION, BX_DB_PADDING_NO_CAPTION];
  620. $sTitle = $this->getBlockTitle($aBlock);
  621. $sHelp = $this->getBlockHelp($aBlock);
  622. $sFunc = '_getBlock' . ucfirst($aBlock['type']);
  623. $bBlockVisible = $this->_isVisibleBlock($aBlock);
  624. if ($iAsync && $bBlockVisible) {
  625. $iDesignboxId = $aBlock['designbox_id'];
  626. $sHelpTitle = $sHelpContent = '';
  627. if(!in_array($iDesignboxId, $aDbNoTitle))
  628. $sHelpTitle = $sHelp;
  629. else
  630. $sHelpContent = $sHelp;
  631. $sContent = $this->getBlockAsyncCode($aBlock, $iAsync);
  632. $aParams = array(
  633. $sTitle . $sHelpTitle,
  634. $sContent . $sHelpContent,
  635. $iDesignboxId
  636. );
  637. $sContentWithBox = call_user_func_array(array($oFunctions, 'designBoxContent'), $aParams);
  638. }
  639. elseif ($bBlockVisible && method_exists($this, $sFunc)) {
  640. $mixedContent = $this->$sFunc($aBlock);
  641. if(!empty($aBlock['content_empty'])) {
  642. $sEmpty = _t($aBlock['content_empty']);
  643. $sRegExp = '/(<[A-Za-z0-9]+\b.[^<]*[\pPi\pPf]bx\-msg\-box\b.*[\pPi\pPf][^>]*>)(' . _t('_Empty') . ')(<\/[A-Za-z0-9]+>)/su';
  644. if(is_string($mixedContent))
  645. $mixedContent = preg_replace($sRegExp, "\${1}" . $sEmpty . "\${3}", $mixedContent);
  646. else if(is_array($mixedContent) && !empty($mixedContent['content']))
  647. $mixedContent['content'] = preg_replace($sRegExp, "\${1}" . $sEmpty . "\${3}", $mixedContent['content']);
  648. }
  649. $this->_oQuery->setReadOnlyMode(true);
  650. if(is_array($mixedContent) && !empty($mixedContent['content'])) {
  651. $iDesignboxId = isset($mixedContent['designbox_id']) ? $mixedContent['designbox_id'] : $aBlock['designbox_id'];
  652. $sHelpTitle = $sHelpContent = '';
  653. if(!in_array($iDesignboxId, $aDbNoTitle))
  654. $sHelpTitle = $sHelp;
  655. else
  656. $sHelpContent = $sHelp;
  657. $aParams = array(
  658. (isset($mixedContent['title']) ? $mixedContent['title'] : $sTitle) . $sHelpTitle,
  659. $mixedContent['content'] . $sHelpContent,
  660. $iDesignboxId
  661. );
  662. $mixedMenu = false;
  663. if(isset($mixedContent['menu']))
  664. $mixedMenu = $mixedContent['menu'];
  665. else if(!empty($aBlock['submenu']))
  666. $mixedMenu = $aBlock['submenu'];
  667. $aParams[] = $mixedMenu;
  668. if(isset($mixedContent['buttons']))
  669. $aParams[] = $mixedContent['buttons'];
  670. else if($mixedMenu)
  671. $aParams[] = (int)$aBlock['tabs'] == 1 ? true : array();
  672. if(isset($mixedContent['class']))
  673. $aBlock['class'] = $mixedContent['class'];
  674. }
  675. else if(is_string($mixedContent) && !empty($mixedContent)) {
  676. $iDesignboxId = $aBlock['designbox_id'];
  677. $sHelpTitle = $sHelpContent = '';
  678. if(!in_array($iDesignboxId, $aDbNoTitle))
  679. $sHelpTitle = $sHelp;
  680. else
  681. $sHelpContent = $sHelp;
  682. $aParams = array(
  683. $sTitle . $sHelpTitle,
  684. $mixedContent . $sHelpContent,
  685. $iDesignboxId
  686. );
  687. $mixedMenu = !empty($aBlock['submenu']) ? $aBlock['submenu'] : false;
  688. $aParams[] = $mixedMenu;
  689. if($mixedMenu)
  690. $aParams[] = (int)$aBlock['tabs'] == 1 ? true : array();
  691. }
  692. if(!empty($aParams))
  693. $sContentWithBox = call_user_func_array(array($oFunctions, 'designBoxContent'), $aParams);
  694. }
  695. if (isset($GLOBALS['bx_profiler'])) $GLOBALS['bx_profiler']->endPageBlock($aBlock['id'], $sContentWithBox ? false : true, false );
  696. return $sContentWithBox;
  697. }
  698. /**
  699. * Add necessary js and css files.
  700. */
  701. protected function _addJsCss()
  702. {
  703. $this->_oTemplate->addJs(array('BxDolPage.js', 'theia-sticky-sidebar/theia-sticky-sidebar.min.js', 'theia-sticky-sidebar/ResizeSensor.min.js'));
  704. $this->_oTemplate->addCss('page_layouts.css');
  705. }
  706. /**
  707. * Set system template variables, like page title, meta description, meta keywords and meta robots.
  708. */
  709. protected function _addSysTemplateVars ()
  710. {
  711. $oTemplate = BxDolTemplate::getInstance();
  712. $sPageTitle = $this->_getPageTitle();
  713. if ($sPageTitle)
  714. $oTemplate->setPageHeader ($sPageTitle);
  715. $sMetaTitle = $this->_getPageMetaTitle();
  716. if ($sMetaTitle)
  717. $oTemplate->setPageMetaTitle ($sMetaTitle);
  718. $sMetaDesc = $this->_getPageMetaDesc();
  719. if ($sMetaDesc)
  720. $oTemplate->setPageDescription ($sMetaDesc);
  721. $sMetaRobots = $this->_getPageMetaRobots();
  722. if ($sMetaRobots)
  723. $oTemplate->setPageMetaRobots ($sMetaRobots);
  724. $sMetaImage = $this->_getPageMetaImage();
  725. if ($sMetaImage)
  726. $oTemplate->addPageMetaImage($sMetaImage);
  727. $sMetaKeywords = $this->_getPageMetaKeywords();
  728. if ($sMetaKeywords)
  729. $oTemplate->addPageKeywords ($sMetaKeywords);
  730. }
  731. /**
  732. * Select menu from page properties.
  733. */
  734. protected function _selectMenu ()
  735. {
  736. BxDolMenu::setSelectedGlobal ($this->_aObject['module'], $this->_aObject['uri']);
  737. }
  738. /**
  739. * Set page submenu if it's specified
  740. */
  741. protected function _setSubmenu ($aParams)
  742. {
  743. if(empty($this->_aObject['submenu']) || $this->_aObject['submenu'] == 'disabled')
  744. return;
  745. $oMenuSubmenu = BxDolMenu::getObjectInstance('sys_site_submenu');
  746. if(!$oMenuSubmenu)
  747. return;
  748. $oMenuSubmenu->setObjectSubmenu($this->_aObject['submenu'], $aParams);
  749. }
  750. /**
  751. * Get content for 'raw' block type.
  752. * @return string
  753. */
  754. protected function _getBlockRaw ($aBlock)
  755. {
  756. if (bx_is_api()){
  757. return [bx_api_get_block('raw', ['title' => _t($aBlock['title']), 'content' => BxDolTemplate::getInstance()->parseHtmlByContent($aBlock['content'], array())])];
  758. }
  759. $s = '<div class="bx-page-raw-container bx-def-vanilla-html max-w-none">' . BxDolTemplate::getInstance()->parseHtmlByContent($aBlock['content'], array()) . '</div>';
  760. $s = $this->_replaceMarkers($s, array('block_id' => $aBlock['id']));
  761. $s = bx_process_macros($s);
  762. return $s;
  763. }
  764. /**
  765. * Get content for 'custom' block type.
  766. * @return string
  767. */
  768. protected function _getBlockCustom ($aBlock)
  769. {
  770. if (bx_is_api()){
  771. return [bx_api_get_block('custom', ['title' => _t($aBlock['title']), 'content' => BxDolTemplate::getInstance()->parseHtmlByContent($aBlock['content'], array())])];
  772. }
  773. $s = '<div class="bx-page-custom-container">' . BxDolTemplate::getInstance()->parseHtmlByContent($aBlock['content'], array()) . '</div>';
  774. $s = $this->_replaceMarkers($s, array('block_id' => $aBlock['id']));
  775. $s = bx_process_macros($s);
  776. return $s;
  777. }
  778. /**
  779. * Get content for 'html' block type.
  780. * @return string
  781. */
  782. protected function _getBlockHtml ($aBlock)
  783. {
  784. if (bx_is_api()){
  785. return [bx_api_get_block('html', ['title' => _t($aBlock['title']), 'content' => $aBlock['content']])];
  786. }
  787. $s = '<div class="bx-page-html-container bx-def-vanilla-html max-w-none">' . $aBlock['content'] . '</div>';
  788. $s = $this->_replaceMarkers($s, array('block_id' => $aBlock['id']));
  789. $s = bx_process_macros($s);
  790. return $s;
  791. }
  792. /**
  793. * Get content for 'creative' block type.
  794. * @return string
  795. */
  796. protected function _getBlockCreative ($aBlock)
  797. {
  798. if(bx_is_api())
  799. return [bx_api_get_block('creative', ['title' => _t($aBlock['title']), 'content' => $aBlock['content']])];
  800. $s = $this->_replaceMarkers($aBlock['content'], ['block_id' => $aBlock['id']]);
  801. $s = bx_process_macros($s);
  802. $bCanManage = $this->isAllowedCreativeManage();
  803. if($bCanManage) {
  804. $this->_oTemplate->addCss([
  805. BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'grapesjs/|grapes.min.css',
  806. ]);
  807. $this->_oTemplate->addJs([
  808. 'grapesjs/grapes.min.js',
  809. 'grapesjs/grapesjs-blocks-basic.js',
  810. 'grapesjs/grapesjs-style-bg.js',
  811. 'grapesjs/grapesjs-preset-webpage.min.js',
  812. ]);
  813. }
  814. return $this->_oTemplate->parseHtmlByName('block_creative.html', [
  815. 'block_id' => $aBlock['id'],
  816. 'content' => $s,
  817. 'bx_if:show_controls' => [
  818. 'condition' => $bCanManage,
  819. 'content' => [
  820. 'onclick_edit' => $this->_sJsObjectName . '.creativeEdit(this, ' . $aBlock['id'] . ')',
  821. 'onclick_save' => $this->_sJsObjectName . '.creativeSave(this, ' . $aBlock['id'] . ')'
  822. ]
  823. ]
  824. ]);
  825. }
  826. /**
  827. * Get content for 'wiki' block type.
  828. * @return string
  829. */
  830. protected function _getBlockWiki ($aBlock)
  831. {
  832. $oWiki = BxDolWiki::getObjectInstance($this->_aObject['module']);
  833. if (!$oWiki) {
  834. $sContent = _t('_sys_wiki_error_missing_wiki_object', $this->_aObject['module']);
  835. }
  836. else {
  837. $sContent = $oWiki->getBlockContent($aBlock['id'], false, (int)bx_get($aBlock['id'].'rev') ? (int)bx_get($aBlock['id'].'rev') : false);
  838. }
  839. $s = '<div id="bx-page-wiki-container-' . $aBlock['id'] . '" class="bx-page-wiki-container markdown-body bx-def-vanilla-html">' . $sContent . '</div>';
  840. $s = $this->_replaceMarkers($s, array('block_id' => $aBlock['id']));
  841. $s = bx_process_macros($s);
  842. return $s;
  843. }
  844. /**
  845. * Get content for 'lang' block type.
  846. * @return string
  847. */
  848. protected function _getBlockLang ($aBlock)
  849. {
  850. if (bx_is_api()){
  851. return [bx_api_get_block('lang', ['title' => _t($aBlock['title']), 'content' => bx_process_macros(_t(trim($aBlock['content'])))])];
  852. }
  853. $s = '<div class="bx-page-lang-container bx-def-vanilla-html max-w-none">' . _t(trim($aBlock['content'])) . '</div>';
  854. $s = $this->_replaceMarkers($s, array('block_id' => $aBlock['id']));
  855. $s = bx_process_macros($s);
  856. return $s;
  857. }
  858. /**
  859. * Get content for 'image' block type.
  860. * @return string
  861. */
  862. protected function _getBlockImage ($aBlock)
  863. {
  864. if (empty($aBlock['content']))
  865. return false;
  866. list($iFileId, $sAlign ) = explode('#', $aBlock['content']);
  867. $iFileId = (int)$iFileId;
  868. if (!$iFileId)
  869. return false;
  870. $oStorage = BxDolStorage::getObjectInstance(BX_DOL_STORAGE_OBJ_IMAGES);
  871. if (!$oStorage)
  872. return false;
  873. $sUrl = $oStorage->getFileUrlById($iFileId);
  874. if (!$sUrl)
  875. return false;
  876. $sStyleAdd = '';
  877. $sClassAdd = 'bx-page-image-container';
  878. $aAlign = ['left' => 'start', 'center' => 'center', 'right' => 'end'];
  879. if(array_key_exists($sAlign, $aAlign)) {
  880. $sClassAdd .= ' flex justify-' . $aAlign[$sAlign];
  881. $sStyleAdd = 'style="text-align:' . $sAlign . '"';
  882. }
  883. return '<div class="' . $sClassAdd . '" ' . $sStyleAdd . '><img src="' . $sUrl . '" /></div>';
  884. }
  885. /**
  886. * Get content for 'rss' block type.
  887. * @return string
  888. */
  889. protected function _getBlockRss ($aBlock)
  890. {
  891. if (empty($aBlock['content']))
  892. return false;
  893. list( $sUrl, $iNum ) = explode('#', $aBlock['content']);
  894. $iNum = (int)$iNum;
  895. return BxDolRss::getObjectInstance('sys_page_block')->getHolder($aBlock['id'], $iNum);
  896. }
  897. /**
  898. * Get content for 'menu' block type.
  899. * @return string
  900. */
  901. protected function _getBlockMenu ($aBlock)
  902. {
  903. $oMenu = BxTemplMenu::getObjectInstance($aBlock['content']);
  904. return $oMenu ? $oMenu->getCode () : '';
  905. }
  906. /**
  907. * Get content for 'service' block type.
  908. * @return string
  909. */
  910. protected function _getBlockService ($aBlock)
  911. {
  912. $aMarkers = array_merge($this->_aMarkers, [
  913. 'block_id' => $aBlock['id']
  914. ]);
  915. return BxDolService::callSerialized($aBlock['content'], $aMarkers);
  916. }
  917. /**
  918. * Get page title.
  919. * @return string
  920. */
  921. protected function _getPageTitle()
  922. {
  923. return $this->_replaceMarkers(_t($this->_aObject['title']));
  924. }
  925. /**
  926. * Get page meta description.
  927. * @return string
  928. */
  929. protected function _getPageMetaDesc()
  930. {
  931. return $this->_replaceMarkers(_t($this->_aObject['meta_description']));
  932. }
  933. /**
  934. * Get page meta title.
  935. * @return string
  936. */
  937. protected function _getPageMetaTitle()
  938. {
  939. return $this->_replaceMarkers(_t($this->_aObject['meta_title']));
  940. }
  941. /**
  942. * Get page meta image.
  943. * @return string
  944. */
  945. protected function _getPageMetaImage()
  946. {
  947. return '';
  948. }
  949. /**
  950. * Get page meta keywords.
  951. * @return string
  952. */
  953. protected function _getPageMetaKeywords()
  954. {
  955. return $this->_replaceMarkers(_t($this->_aObject['meta_keywords']));
  956. }
  957. /**
  958. * Get page meta robots.
  959. * @return string
  960. */
  961. protected function _getPageMetaRobots()
  962. {
  963. return _t($this->_aObject['meta_robots']);
  964. }
  965. /**
  966. * Get page not found message.
  967. * @return string
  968. */
  969. protected function _getPageNotFoundMsg ($mixedMsg = false)
  970. {
  971. $this->_oTemplate->displayPageNotFound();
  972. exit;
  973. }
  974. /**
  975. * Get access denied message.
  976. * @return string
  977. */
  978. protected function _getPageAccessDeniedMsg ($mixedMsg = false)
  979. {
  980. return MsgBox($mixedMsg !== false ? $mixedMsg : _t('_Access denied'));
  981. }
  982. /**
  983. * Get page cache object.
  984. * @return cache object instance
  985. */
  986. protected function _getPageCacheObject ()
  987. {
  988. return $this->_getCacheObject ();
  989. }
  990. /**
  991. * Get block cache object.
  992. * @return cache object instance
  993. */
  994. protected function _getBlockCacheObject ()
  995. {
  996. return $this->_getCacheObject ('Block', 'pb');
  997. }
  998. protected function _getCacheObject ($sSuffixObj = 'Page', $sSuffixParam = 'page')
  999. {
  1000. $sObj = '_o' . $sSuffixObj . 'CacheObject';
  1001. $sParam = 'sys_' . $sSuffixParam . '_cache_engine';
  1002. if ($this->{$sObj} != null) {
  1003. return $this->{$sObj};
  1004. } else {
  1005. $sEngine = getParam($sParam);
  1006. $this->{$sObj} = bx_instance ('BxDolCache' . $sEngine);
  1007. if (!$this->{$sObj}->isAvailable())
  1008. $this->{$sObj} = bx_instance ('BxDolCacheFile');
  1009. return $this->{$sObj};
  1010. }
  1011. }
  1012. /**
  1013. * Get page cache key.
  1014. * @param $isPrefixOnly return key prefix only.
  1015. * @return string
  1016. */
  1017. protected function _getPageCacheKey ($isPrefixOnly = false)
  1018. {
  1019. $s = 'page_' . $this->_aObject['object'] . '_';
  1020. if ($isPrefixOnly)
  1021. return $s;
  1022. $s .= $this->_getPageCacheParams ();
  1023. $s .= bx_site_hash() . '.php';
  1024. return $s;
  1025. }
  1026. /**
  1027. * Get block cache key.
  1028. * @param $isPrefixOnly return key prefix only.
  1029. * @return string
  1030. */
  1031. protected function _getBlockCacheKey ($isPrefixOnly = false, $aBlock = array())
  1032. {
  1033. $s = $this->_getPageCacheKey(true) . 'block_';
  1034. if ($isPrefixOnly)
  1035. return $s;
  1036. $s .= ($aBlock ? $aBlock['id'] : 0) . '_' . $this->_getPageCacheParams ();
  1037. $s .= bx_site_hash() . '.php';
  1038. return $s;
  1039. }
  1040. /**
  1041. * Additional cache key. In the case of dynamic page.
  1042. * For example - profile page, where each profile has own page.
  1043. * @return string
  1044. */
  1045. protected function _getPageCacheParams ()
  1046. {
  1047. return md5(serialize($_GET) . bx_lang_name());
  1048. }
  1049. /**
  1050. * Clean page cache.
  1051. * @param $isDelAllWithPagePrefix delete cache by prefix, it can be used for dynamic pages, like profile view, where for each profile separate cache is generated.
  1052. * @return string
  1053. */
  1054. protected function cleanCache ($isDelAllWithPagePrefix = false)
  1055. {
  1056. $a = ['Page', 'Block'];
  1057. $bRet = false;
  1058. foreach ($a as $s) {
  1059. $oCache = $this->{'_get' . $s . 'CacheObject'} ();
  1060. $sKey = $this->{'_get'. $s . 'CacheKey'} ($isDelAllWithPagePrefix);
  1061. if ($isDelAllWithPagePrefix)
  1062. $bRet = $bRet && $oCache->removeAllByPrefix($sKey);
  1063. else
  1064. $bRet = $bRet && $oCache->delData($sKey);
  1065. }
  1066. return $bRet;
  1067. }
  1068. }
  1069. /** @} */