BxBasePage.php 35 KB

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