BxBasePage.php 35 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087
  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. 'menu_add' => '',
  348. 'elements' => $this->getPageBlocksAPI($aBlocks),
  349. ];
  350. if (BxDolCover::getInstance($this)->isCover() && isset($this->_aProfileInfo)) {
  351. $oModule = BxDolModule::getInstance($this->getModule());
  352. $a['cover_block'] = [
  353. 'profile' => BxDolProfile::getData($this->_aProfileInfo['id'], [
  354. 'get_avatar' => 'getAvatarBig',
  355. 'with_info' => true
  356. ]),
  357. 'actions_menu' => '',
  358. 'meta_menu' => '',
  359. 'cover' => $oModule->serviceGetCover($this->_aProfileInfo['content_id'])
  360. ];
  361. $CNF = $oModule->_oConfig->CNF;
  362. if(!empty($CNF['OBJECT_MENU_VIEW_ENTRY_META'])){
  363. $oMetaMenu = BxTemplMenu::getObjectInstance($CNF['OBJECT_MENU_VIEW_ENTRY_META']);
  364. $a['cover_block']['meta_menu'] = $oMetaMenu->getCodeAPI();
  365. }
  366. if(!empty($CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY'])){
  367. $oActionMenu = BxTemplMenu::getObjectInstance($CNF['OBJECT_MENU_ACTIONS_VIEW_ENTRY_ALL']);
  368. $a['cover_block']['actions_menu'] = $oActionMenu->getCodeAPI();
  369. }
  370. }
  371. $sMenuTop = getParam('sys_api_menu_top');
  372. if (!empty($sMenuTop) && ($oMenuTop = BxDolMenu::getObjectInstance($sMenuTop)) !== false)
  373. $a['menu_top'] = $oMenuTop->getCodeAPI();
  374. if (($oMenuSubmenu = BxDolMenu::getObjectInstance('sys_site_submenu')) !== false) {
  375. if(($sSubmenu = $this->getSubMenu()) !== '')
  376. $oMenuSubmenu->setObjectSubmenu($sSubmenu, []);
  377. $a['menu'] = $oMenuSubmenu->getCodeAPI();
  378. }
  379. if (isLogged()) {
  380. if(($oMenuAddContent = BxDolMenu::getObjectInstance('sys_add_content')) !== false)
  381. $a['menu_add'] = $oMenuAddContent->getCodeAPI();
  382. $o = BxDolProfile::getInstance();
  383. $a['user'] = [
  384. 'id' => $o->id(),
  385. 'display_name' => $o->getDisplayName(),
  386. 'url' => $o->getUrl(),
  387. 'avatar' => $o->getAvatar(),
  388. 'info' => $o->getInfo(),
  389. 'notifications' => 0,
  390. 'active' => $o->isActive(),
  391. 'status' => $o->getStatus(),
  392. ];
  393. $sModuleNotifications = 'bx_notifications';
  394. if(BxDolRequest::serviceExists($sModuleNotifications, 'get_unread_notifications_num'))
  395. $a['user']['notifications'] = bx_srv($sModuleNotifications, 'get_unread_notifications_num', [$o->id()]);
  396. }
  397. return $a;
  398. }
  399. public function getPageBlocksAPI($aBlocks = [])
  400. {
  401. $bBlocks = !empty($aBlocks) && is_array($aBlocks);
  402. $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'];
  403. $aCells = $this->_oQuery->getPageBlocks(true);
  404. foreach($aCells as $sKey => &$aCell) {
  405. foreach($aCell as $i => $aBlock) {
  406. if(!$this->_isVisibleBlock($aBlock)) {
  407. unset($aCells[$sKey][$i]);
  408. continue;
  409. }
  410. $this->processPageBlock($aCells[$sKey][$i], true);
  411. $aBlock = $aCells[$sKey][$i];
  412. $sSource = '';
  413. if($aBlock['type'] == 'service') {
  414. $aContent = @unserialize($aBlock['content']);
  415. if(isset($aContent['module'], $aContent['method']))
  416. $sSource = $aContent['module'] . ':' . $aContent['method'];
  417. }
  418. if($bBlocks && !in_array($sSource, $aBlocks)) {
  419. unset($aCells[$sKey][$i]);
  420. continue;
  421. }
  422. $sFunc = '_getBlock' . ucfirst($aBlock['type']);
  423. $mBlock = method_exists($this, $sFunc) ? $this->$sFunc($aBlock) : $aBlock['content'];
  424. $aCells[$sKey][$i] = array_merge($aCells[$sKey][$i], [
  425. 'title' => isset($mBlock['title']) ? $mBlock['title'] : $this->getBlockTitle($aBlock),
  426. 'content' => isset($mBlock['content']) ? $mBlock['content'] : $mBlock,
  427. 'menu' => isset($mBlock['menu']) ? $mBlock['menu'] : '',
  428. 'source' => $sSource
  429. ]);
  430. $aCells[$sKey][$i] = array_diff_key($aCells[$sKey][$i], array_flip($aFieldsUnset));
  431. }
  432. }
  433. return array_map('array_values', $aCells);
  434. }
  435. /**
  436. * Get page code vars
  437. * @return string
  438. */
  439. protected function _getPageCodeVars ()
  440. {
  441. $aHiddenOn = array(
  442. pow(2, BX_DB_HIDDEN_PHONE - 1) => 'bx-def-media-phone-hide',
  443. pow(2, BX_DB_HIDDEN_TABLET - 1) => 'bx-def-media-tablet-hide',
  444. pow(2, BX_DB_HIDDEN_DESKTOP - 1) => 'bx-def-media-desktop-hide',
  445. pow(2, BX_DB_HIDDEN_MOBILE - 1) => 'bx-def-mobile-app-hide'
  446. );
  447. $aVars = array (
  448. 'page_id' => 'bx-page-' . $this->_aObject['uri'],
  449. 'bx_if:show_layout_row_dump' => array(
  450. 'condition' => false,
  451. 'content' => array()
  452. )
  453. );
  454. $aBlocks = $this->_oQuery->getPageBlocks();
  455. foreach ($aBlocks as $sKey => $aCell) {
  456. $sCell = '';
  457. foreach ($aCell as $aBlock) {
  458. $this->processPageBlock($aBlock, false);
  459. $sContentWithBox = $this->_getBlockCodeWithCache($aBlock, $aBlock['async']);
  460. $sClassAdd = '';
  461. if(!empty($aBlock['class']))
  462. $sClassAdd .= ' ' . $aBlock['class'];
  463. if(!empty($aBlock['hidden_on']))
  464. foreach($aHiddenOn as $iHiddenOn => $sHiddenOnClass)
  465. if((int)$aBlock['hidden_on'] & $iHiddenOn)
  466. $sClassAdd .= ' ' . $sHiddenOnClass;
  467. if ($sContentWithBox)
  468. $sCell .= $this->_oTemplate->parseHtmlByName('designbox_container.html', array(
  469. 'class_add' => $sClassAdd,
  470. 'bx_if:show_html_id' => array(
  471. 'condition' => true,
  472. 'content' => array(
  473. 'html_id' => 'bx-page-block-' . $aBlock['id']
  474. ),
  475. ),
  476. 'content' => $sContentWithBox
  477. ));
  478. }
  479. $aVars[$sKey] = $sCell;
  480. }
  481. return $aVars;
  482. }
  483. /**
  484. * Process block values, especially if someting need to be overrided
  485. */
  486. protected function processPageBlock(&$aBlock, $bApi = false)
  487. {
  488. }
  489. /**
  490. * Get page code only.
  491. * @return string
  492. */
  493. protected function _getPageCode ()
  494. {
  495. $aVars = $this->_getPageCodeVars ();
  496. return $this->_oTemplate->parseHtmlByName($this->_aObject['template'], $aVars);
  497. }
  498. /**
  499. * Get one block code only.
  500. * @return string
  501. */
  502. protected function _getBlockOnlyCode ($iBlockId)
  503. {
  504. if (!($aBlock = $this->_oQuery->getPageBlock((int)$iBlockId)))
  505. return '';
  506. return $this->_getBlockCodeWithCache($aBlock, 0);
  507. }
  508. protected function _getBlockCodeWithCache(&$aBlock, $iAsync = 0)
  509. {
  510. if (!getParam('sys_pb_cache_enable') || !$aBlock['cache_lifetime'] || $iAsync || (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'POST')) {
  511. $sBlockCode = $this->_getBlockCode($aBlock, $iAsync);
  512. }
  513. else {
  514. $oCache = $this->_getBlockCacheObject();
  515. $sKey = $this->_getBlockCacheKey(false, $aBlock);
  516. $sKeyCssJs = 'cssjs_' . $sKey;
  517. $mixedRet = $oCache->getData($sKey, $aBlock['cache_lifetime']);
  518. $aRetCssJs = $oCache->getData($sKeyCssJs, $aBlock['cache_lifetime']);
  519. if ($mixedRet !== null && $aRetCssJs !== null) {
  520. BxDolTemplate::getInstance()->collectingStart();
  521. BxDolTemplate::getInstance()->collectingInject($aRetCssJs['css'], $aRetCssJs['js']);
  522. $sBlockCode = BxDolTemplate::getInstance()->collectingEndGetCode();
  523. $sBlockCode .= $mixedRet;
  524. } else {
  525. BxDolTemplate::getInstance()->collectingStart();
  526. $sBlockCode = $this->_getBlockCode($aBlock, $iAsync);
  527. $aBlockCssJs = BxDolTemplate::getInstance()->collectingEndGetCode(array(), array(), 'array');
  528. $oCache->setData($sKey, $sBlockCode, $aBlock['cache_lifetime']);
  529. $oCache->setData($sKeyCssJs, $aBlockCssJs, $aBlock['cache_lifetime']);
  530. }
  531. }
  532. return $sBlockCode;
  533. }
  534. /**
  535. * Get block code.
  536. * @return string
  537. */
  538. protected function _getBlockCode(&$aBlock, $iAsync = 0)
  539. {
  540. $sContentWithBox = '';
  541. $oFunctions = $this->_oTemplate->getTemplateFunctions();
  542. if (isset($GLOBALS['bx_profiler'])) $GLOBALS['bx_profiler']->beginPageBlock(_t($aBlock['title']), $aBlock['id']);
  543. $aDbNoTitle = [BX_DB_CONTENT_ONLY, BX_DB_PADDING_CONTENT_ONLY, BX_DB_NO_CAPTION, BX_DB_PADDING_NO_CAPTION];
  544. $sTitle = $this->getBlockTitle($aBlock);
  545. $sHelp = $this->getBlockHelp($aBlock);
  546. $sFunc = '_getBlock' . ucfirst($aBlock['type']);
  547. $bBlockVisible = $this->_isVisibleBlock($aBlock);
  548. if ($iAsync && $bBlockVisible) {
  549. $iDesignboxId = $aBlock['designbox_id'];
  550. $sHelpTitle = $sHelpContent = '';
  551. if(!in_array($iDesignboxId, $aDbNoTitle))
  552. $sHelpTitle = $sHelp;
  553. else
  554. $sHelpContent = $sHelp;
  555. $sContent = $this->getBlockAsyncCode($aBlock, $iAsync);
  556. $aParams = array(
  557. $sTitle . $sHelpTitle,
  558. $sContent . $sHelpContent,
  559. $iDesignboxId
  560. );
  561. $sContentWithBox = call_user_func_array(array($oFunctions, 'designBoxContent'), $aParams);
  562. }
  563. elseif ($bBlockVisible && method_exists($this, $sFunc)) {
  564. $mixedContent = $this->$sFunc($aBlock);
  565. $this->_oQuery->setReadOnlyMode(true);
  566. if(is_array($mixedContent) && !empty($mixedContent['content'])) {
  567. $iDesignboxId = isset($mixedContent['designbox_id']) ? $mixedContent['designbox_id'] : $aBlock['designbox_id'];
  568. $sHelpTitle = $sHelpContent = '';
  569. if(!in_array($iDesignboxId, $aDbNoTitle))
  570. $sHelpTitle = $sHelp;
  571. else
  572. $sHelpContent = $sHelp;
  573. $aParams = array(
  574. (isset($mixedContent['title']) ? $mixedContent['title'] : $sTitle) . $sHelpTitle,
  575. $mixedContent['content'] . $sHelpContent,
  576. $iDesignboxId
  577. );
  578. $mixedMenu = false;
  579. if(isset($mixedContent['menu']))
  580. $mixedMenu = $mixedContent['menu'];
  581. else if(!empty($aBlock['submenu']))
  582. $mixedMenu = $aBlock['submenu'];
  583. $aParams[] = $mixedMenu;
  584. if(isset($mixedContent['buttons']))
  585. $aParams[] = $mixedContent['buttons'];
  586. else if($mixedMenu)
  587. $aParams[] = (int)$aBlock['tabs'] == 1 ? true : array();
  588. if(isset($mixedContent['class']))
  589. $aBlock['class'] = $mixedContent['class'];
  590. }
  591. else if(is_string($mixedContent) && !empty($mixedContent)) {
  592. $iDesignboxId = $aBlock['designbox_id'];
  593. $sHelpTitle = $sHelpContent = '';
  594. if(!in_array($iDesignboxId, $aDbNoTitle))
  595. $sHelpTitle = $sHelp;
  596. else
  597. $sHelpContent = $sHelp;
  598. $aParams = array(
  599. $sTitle . $sHelpTitle,
  600. $mixedContent . $sHelpContent,
  601. $iDesignboxId
  602. );
  603. $mixedMenu = !empty($aBlock['submenu']) ? $aBlock['submenu'] : false;
  604. $aParams[] = $mixedMenu;
  605. if($mixedMenu)
  606. $aParams[] = (int)$aBlock['tabs'] == 1 ? true : array();
  607. }
  608. if(!empty($aParams))
  609. $sContentWithBox = call_user_func_array(array($oFunctions, 'designBoxContent'), $aParams);
  610. }
  611. if (isset($GLOBALS['bx_profiler'])) $GLOBALS['bx_profiler']->endPageBlock($aBlock['id'], $sContentWithBox ? false : true, false );
  612. return $sContentWithBox;
  613. }
  614. /**
  615. * Add necessary js and css files.
  616. */
  617. protected function _addJsCss()
  618. {
  619. $this->_oTemplate->addJs(array('BxDolPage.js', 'theia-sticky-sidebar/theia-sticky-sidebar.min.js', 'theia-sticky-sidebar/ResizeSensor.min.js'));
  620. $this->_oTemplate->addCss('page_layouts.css');
  621. }
  622. /**
  623. * Set system template variables, like page title, meta description, meta keywords and meta robots.
  624. */
  625. protected function _addSysTemplateVars ()
  626. {
  627. $oTemplate = BxDolTemplate::getInstance();
  628. $sPageTitle = $this->_getPageTitle();
  629. if ($sPageTitle)
  630. $oTemplate->setPageHeader ($sPageTitle);
  631. $sMetaDesc = $this->_getPageMetaDesc();
  632. if ($sMetaDesc)
  633. $oTemplate->setPageDescription ($sMetaDesc);
  634. $sMetaRobots = $this->_getPageMetaRobots();
  635. if ($sMetaRobots)
  636. $oTemplate->setPageMetaRobots ($sMetaRobots);
  637. $sMetaImage = $this->_getPageMetaImage();
  638. if ($sMetaImage)
  639. $oTemplate->addPageMetaImage($sMetaImage);
  640. $sMetaKeywords = $this->_getPageMetaKeywords();
  641. if ($sMetaKeywords)
  642. $oTemplate->addPageKeywords ($sMetaKeywords);
  643. }
  644. /**
  645. * Select menu from page properties.
  646. */
  647. protected function _selectMenu ()
  648. {
  649. BxDolMenu::setSelectedGlobal ($this->_aObject['module'], $this->_aObject['uri']);
  650. }
  651. /**
  652. * Set page submenu if it's specified
  653. */
  654. protected function _setSubmenu ($aParams)
  655. {
  656. if(empty($this->_aObject['submenu']) || $this->_aObject['submenu'] == 'disabled')
  657. return;
  658. $oMenuSubmenu = BxDolMenu::getObjectInstance('sys_site_submenu');
  659. if(!$oMenuSubmenu)
  660. return;
  661. $oMenuSubmenu->setObjectSubmenu($this->_aObject['submenu'], $aParams);
  662. }
  663. /**
  664. * Get content for 'raw' block type.
  665. * @return string
  666. */
  667. protected function _getBlockRaw ($aBlock)
  668. {
  669. $s = '<div class="bx-page-raw-container">' . BxDolTemplate::getInstance()->parseHtmlByContent($aBlock['content'], array()) . '</div>';
  670. $s = $this->_replaceMarkers($s, array('block_id' => $aBlock['id']));
  671. $s = bx_process_macros($s);
  672. return $s;
  673. }
  674. /**
  675. * Get content for 'custom' block type.
  676. * @return string
  677. */
  678. protected function _getBlockCustom ($aBlock)
  679. {
  680. $s = '<div class="bx-page-custom-container">' . BxDolTemplate::getInstance()->parseHtmlByContent($aBlock['content'], array()) . '</div>';
  681. $s = $this->_replaceMarkers($s, array('block_id' => $aBlock['id']));
  682. $s = bx_process_macros($s);
  683. return $s;
  684. }
  685. /**
  686. * Get content for 'html' block type.
  687. * @return string
  688. */
  689. protected function _getBlockHtml ($aBlock)
  690. {
  691. $s = '<div class="bx-page-html-container">' . $aBlock['content'] . '</div>';
  692. $s = $this->_replaceMarkers($s, array('block_id' => $aBlock['id']));
  693. $s = bx_process_macros($s);
  694. return $s;
  695. }
  696. /**
  697. * Get content for 'wiki' block type.
  698. * @return string
  699. */
  700. protected function _getBlockWiki ($aBlock)
  701. {
  702. $oWiki = BxDolWiki::getObjectInstance($this->_aObject['module']);
  703. if (!$oWiki) {
  704. $sContent = _t('_sys_wiki_error_missing_wiki_object', $this->_aObject['module']);
  705. }
  706. else {
  707. $sContent = $oWiki->getBlockContent($aBlock['id'], false, (int)bx_get($aBlock['id'].'rev') ? (int)bx_get($aBlock['id'].'rev') : false);
  708. }
  709. $s = '<div id="bx-page-wiki-container-' . $aBlock['id'] . '" class="bx-page-wiki-container markdown-body bx-def-vanilla-html">' . $sContent . '</div>';
  710. $s = $this->_replaceMarkers($s, array('block_id' => $aBlock['id']));
  711. $s = bx_process_macros($s);
  712. return $s;
  713. }
  714. /**
  715. * Get content for 'lang' block type.
  716. * @return string
  717. */
  718. protected function _getBlockLang ($aBlock)
  719. {
  720. $s = '<div class="bx-page-lang-container">' . _t(trim($aBlock['content'])) . '</div>';
  721. $s = $this->_replaceMarkers($s, array('block_id' => $aBlock['id']));
  722. $s = bx_process_macros($s);
  723. return $s;
  724. }
  725. /**
  726. * Get content for 'image' block type.
  727. * @return string
  728. */
  729. protected function _getBlockImage ($aBlock)
  730. {
  731. if (empty($aBlock['content']))
  732. return false;
  733. list($iFileId, $sAlign ) = explode('#', $aBlock['content']);
  734. $iFileId = (int)$iFileId;
  735. if (!$iFileId)
  736. return false;
  737. $oStorage = BxDolStorage::getObjectInstance(BX_DOL_STORAGE_OBJ_IMAGES);
  738. if (!$oStorage)
  739. return false;
  740. $sUrl = $oStorage->getFileUrlById($iFileId);
  741. if (!$sUrl)
  742. return false;
  743. $sStyleAdd = '';
  744. if ('center' == $sAlign || 'left' == $sAlign || 'right' == $sAlign)
  745. $sStyleAdd = 'style="text-align:' . $sAlign . '"';
  746. return '<div class="bx-page-image-container" ' . $sStyleAdd . '><img src="' . $sUrl . '" /></div>';
  747. }
  748. /**
  749. * Get content for 'rss' block type.
  750. * @return string
  751. */
  752. protected function _getBlockRss ($aBlock)
  753. {
  754. if (empty($aBlock['content']))
  755. return false;
  756. list( $sUrl, $iNum ) = explode('#', $aBlock['content']);
  757. $iNum = (int)$iNum;
  758. return BxDolRss::getObjectInstance('sys_page_block')->getHolder($aBlock['id'], $iNum);
  759. }
  760. /**
  761. * Get content for 'menu' block type.
  762. * @return string
  763. */
  764. protected function _getBlockMenu ($aBlock)
  765. {
  766. $oMenu = BxTemplMenu::getObjectInstance($aBlock['content']);
  767. return $oMenu ? $oMenu->getCode () : '';
  768. }
  769. /**
  770. * Get content for 'service' block type.
  771. * @return string
  772. */
  773. protected function _getBlockService ($aBlock)
  774. {
  775. return BxDolService::callSerialized($aBlock['content'], $this->_aMarkers);
  776. }
  777. /**
  778. * Get page title.
  779. * @return string
  780. */
  781. protected function _getPageTitle()
  782. {
  783. return $this->_replaceMarkers(_t($this->_aObject['title']));
  784. }
  785. /**
  786. * Get page meta description.
  787. * @return string
  788. */
  789. protected function _getPageMetaDesc()
  790. {
  791. return $this->_replaceMarkers(_t($this->_aObject['meta_description']));
  792. }
  793. /**
  794. * Get page meta image.
  795. * @return string
  796. */
  797. protected function _getPageMetaImage()
  798. {
  799. return '';
  800. }
  801. /**
  802. * Get page meta keywords.
  803. * @return string
  804. */
  805. protected function _getPageMetaKeywords()
  806. {
  807. return $this->_replaceMarkers(_t($this->_aObject['meta_keywords']));
  808. }
  809. /**
  810. * Get page meta robots.
  811. * @return string
  812. */
  813. protected function _getPageMetaRobots()
  814. {
  815. return _t($this->_aObject['meta_robots']);
  816. }
  817. /**
  818. * Get access denied message HTML.
  819. * @return string
  820. */
  821. protected function _getPageAccessDeniedMsg ()
  822. {
  823. return MsgBox(_t('_Access denied'));
  824. }
  825. /**
  826. * Get page cache object.
  827. * @return cache object instance
  828. */
  829. protected function _getPageCacheObject ()
  830. {
  831. return $this->_getCacheObject ();
  832. }
  833. /**
  834. * Get block cache object.
  835. * @return cache object instance
  836. */
  837. protected function _getBlockCacheObject ()
  838. {
  839. return $this->_getCacheObject ('Block', 'pb');
  840. }
  841. protected function _getCacheObject ($sSuffixObj = 'Page', $sSuffixParam = 'page')
  842. {
  843. $sObj = '_o' . $sSuffixObj . 'CacheObject';
  844. $sParam = 'sys_' . $sSuffixParam . '_cache_engine';
  845. if ($this->{$sObj} != null) {
  846. return $this->{$sObj};
  847. } else {
  848. $sEngine = getParam($sParam);
  849. $this->{$sObj} = bx_instance ('BxDolCache' . $sEngine);
  850. if (!$this->{$sObj}->isAvailable())
  851. $this->{$sObj} = bx_instance ('BxDolCacheFile');
  852. return $this->{$sObj};
  853. }
  854. }
  855. /**
  856. * Get page cache key.
  857. * @param $isPrefixOnly return key prefix only.
  858. * @return string
  859. */
  860. protected function _getPageCacheKey ($isPrefixOnly = false)
  861. {
  862. $s = 'page_' . $this->_aObject['object'] . '_';
  863. if ($isPrefixOnly)
  864. return $s;
  865. $s .= $this->_getPageCacheParams ();
  866. $s .= bx_site_hash() . '.php';
  867. return $s;
  868. }
  869. /**
  870. * Get block cache key.
  871. * @param $isPrefixOnly return key prefix only.
  872. * @return string
  873. */
  874. protected function _getBlockCacheKey ($isPrefixOnly = false, $aBlock = array())
  875. {
  876. $s = $this->_getPageCacheKey(true) . 'block_';
  877. if ($isPrefixOnly)
  878. return $s;
  879. $s .= ($aBlock ? $aBlock['id'] : 0) . '_' . $this->_getPageCacheParams ();
  880. $s .= bx_site_hash() . '.php';
  881. return $s;
  882. }
  883. /**
  884. * Additional cache key. In the case of dynamic page.
  885. * For example - profile page, where each profile has own page.
  886. * @return string
  887. */
  888. protected function _getPageCacheParams ()
  889. {
  890. return md5(serialize($_GET) . bx_lang_name());
  891. }
  892. /**
  893. * Clean page cache.
  894. * @param $isDelAllWithPagePrefix delete cache by prefix, it can be used for dynamic pages, like profile view, where for each profile separate cache is generated.
  895. * @return string
  896. */
  897. protected function cleanCache ($isDelAllWithPagePrefix = false)
  898. {
  899. $a = ['Page', 'Block'];
  900. $bRet = false;
  901. foreach ($a as $s) {
  902. $oCache = $this->{'_get' . $s . 'CacheObject'} ();
  903. $sKey = $this->{'_get'. $s . 'CacheKey'} ($isDelAllWithPagePrefix);
  904. if ($isDelAllWithPagePrefix)
  905. $bRet = $bRet && $oCache->removeAllByPrefix($sKey);
  906. else
  907. $bRet = $bRet && $oCache->delData($sKey);
  908. }
  909. return $bRet;
  910. }
  911. }
  912. /** @} */