BxBaseServiceWiki.php 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
  1. <?php defined('BX_DOL') or die('hack attempt');
  2. /**
  3. * Copyright (c) UNA, Inc - https://una.io
  4. * MIT License - https://opensource.org/licenses/MIT
  5. *
  6. * @defgroup UnaBaseView UNA Base Representation Classes
  7. * @{
  8. */
  9. /**
  10. * Services for Wiki functionality
  11. */
  12. class BxBaseServiceWiki extends BxDol
  13. {
  14. protected $_bJsCssAdded = false;
  15. /**
  16. * @page service Service Calls
  17. * @section bx_system_general System Services
  18. * @subsection bx_system_general-wiki Wiki
  19. * @subsubsection bx_system_general-wiki_page wiki_page
  20. *
  21. * @code bx_srv('system', 'wiki_page', ["index"], 'TemplServiceWiki'); @endcode
  22. * @code {{~system:wiki_page:TemplServiceWiki["index"]~}} @endcode
  23. *
  24. * Display WIKI page.
  25. * @param $sUri categories object name
  26. *
  27. * @see BxBaseServiceWiki::serviceWikiPage
  28. */
  29. /**
  30. * @ref bx_system_general-wiki_page "wiki_page"
  31. */
  32. public function serviceWikiPage ($sWikiObjectUri, $sUri)
  33. {
  34. $oWiki = BxDolWiki::getObjectInstanceByUri($sWikiObjectUri);
  35. if (!$oWiki) {
  36. $oTemplate = BxDolTemplate::getInstance();
  37. $oTemplate->displayPageNotFound();
  38. return;
  39. }
  40. $oPage = BxDolPage::getObjectInstanceByModuleAndURI($oWiki->getObjectName(), $sUri);
  41. if ($oPage) {
  42. $_GET['i'] = $sUri;
  43. $oPage->displayPage();
  44. } else {
  45. if ($oWiki->isAllowed('add-page')) {
  46. $oPage = BxDolPage::getObjectInstanceByURI($sUri);
  47. $oTemplate = BxDolTemplate::getInstance();
  48. if ($oPage) {
  49. $oTemplate->displayErrorOccured(_t("_sys_wiki_error_page_exists", bx_process_output($sUri)));
  50. } else {
  51. $this->_addCssJs (true);
  52. $s = $oTemplate->parseHtmlByName('wiki_create_page.html', array(
  53. 'page_uri' => bx_process_output($sUri),
  54. 'action_uri' => $oWiki->getUri(),
  55. 'create_page' => _t('_sys_wiki_add_page'),
  56. 'text' => _t('_sys_wiki_add_page_text'),
  57. ));
  58. $oTemplate->setPageNameIndex (BX_PAGE_DEFAULT);
  59. $oTemplate->setPageHeader (_t('_sys_wiki_add_page'));
  60. $oTemplate->setPageContent ('page_main_code', $s);
  61. $oTemplate->getPageCode();
  62. }
  63. }
  64. else {
  65. $oTemplate = BxDolTemplate::getInstance();
  66. $oTemplate->displayPageNotFound();
  67. }
  68. }
  69. }
  70. /**
  71. * @page service Service Calls
  72. * @section bx_system_general System Services
  73. * @subsection bx_system_general-wiki Wiki
  74. * @subsubsection bx_system_general-wiki_action wiki_action
  75. *
  76. * @code bx_srv('system', 'wiki_action', [...], 'TemplServiceWiki'); @endcode
  77. *
  78. * Perform WIKI action.
  79. * @param $sWikiObjectUri wiki object URI
  80. *
  81. * @see BxBaseServiceWiki::serviceWikiAction
  82. */
  83. /**
  84. * @ref bx_system_general-wiki_action "wiki_action"
  85. */
  86. public function serviceWikiAction ($sWikiObjectUri, $sAction)
  87. {
  88. $oWiki = BxDolWiki::getObjectInstanceByUri($sWikiObjectUri);
  89. if (!$oWiki) {
  90. echoJson(array('code' => 1, 'actions' => 'ShowMsg', 'msg' => _t('_sys_wiki_error_missing_wiki_object', $sWikiObjectUri)));
  91. return;
  92. }
  93. $sMethod = 'action' . bx_gen_method_name($sAction, array('-'));
  94. if (!method_exists($oWiki, $sMethod) || !$oWiki->isAllowed($sAction)) {
  95. echoJson(array('code' => 2, 'actions' => 'ShowMsg', 'msg' => _t('_sys_wiki_error_action_not_allowed', $sAction, $sWikiObjectUri)));
  96. return;
  97. }
  98. $mixed = $oWiki->$sMethod();
  99. if (is_array($mixed))
  100. echoJson($mixed);
  101. else
  102. echo $mixed;
  103. }
  104. /**
  105. * @page service Service Calls
  106. * @section bx_system_general System Services
  107. * @subsection bx_system_general-wiki Wiki
  108. * @subsubsection bx_system_general-wiki_controls wiki_controls
  109. *
  110. * Get wiki block controls panel
  111. *
  112. * @see BxBaseServiceWiki::serviceWikiControls
  113. */
  114. /**
  115. * @ref bx_system_general-wiki_controls "wiki_controls"
  116. */
  117. public function serviceWikiControls ($oWikiObject, $aWikiVer, $aWikiVerLatest, $sBlockId)
  118. {
  119. $this->_addCssJs ();
  120. $sInfo = '';
  121. if ($aWikiVer && $aWikiVerLatest['revision'] == $aWikiVer['revision']) {
  122. $sInfo = bx_time_js($aWikiVer['added']);
  123. }
  124. elseif ($aWikiVer) {
  125. $oProfile = BxDolProfile::getInstanceMagic($aWikiVer['profile_id']);
  126. $sInfo = _t('_sys_wiki_view_rev', $aWikiVer['revision'], $oProfile->getUrl(), $oProfile->getDisplayName(), bx_time_js($aWikiVer['added']));
  127. }
  128. $o = BxDolTemplate::getInstance();
  129. $o->addJs('stackedit.js/stackedit.min.js');
  130. return $o->parseHtmlByName('wiki_controls.html', array(
  131. 'obj' => $oWikiObject->getObjectName(),
  132. 'block_id' => $sBlockId,
  133. 'info' => $sInfo,
  134. 'options' => json_encode(array(
  135. 'block_id' => $sBlockId,
  136. 'language' => isset($aWikiVer['language']) ? $aWikiVer['language'] : bx_lang_name(),
  137. 'wiki_action_uri' => $oWikiObject->getUri(),
  138. 't_confirm_block_deletion' => _t('_sys_wiki_confirm_block_deletion'),
  139. )),
  140. 'bx_if:menu' => array(
  141. 'condition' => $oWikiObject->isAllowed('history'),
  142. 'content' => array(
  143. 'obj' => $oWikiObject->getObjectName(),
  144. 'block_id' => $sBlockId,
  145. ),
  146. ),
  147. ));
  148. }
  149. /**
  150. * @page service Service Calls
  151. * @section bx_system_general System Services
  152. * @subsection bx_system_general-wiki Wiki
  153. * @subsubsection bx_system_general-wiki_add_block wiki_add_block
  154. *
  155. * Get "add wiki block" panel
  156. *
  157. * @see BxBaseServiceWiki::serviceWikiAddBlock
  158. */
  159. /**
  160. * @ref bx_system_general-wiki_add_block "wiki_add_block"
  161. */
  162. public function serviceWikiAddBlock ($oWikiObject, $sPageObject, $sCellId)
  163. {
  164. $this->_addCssJs ();
  165. if (!preg_match("/cell_(\d+)/", $sCellId, $aMatches))
  166. return '';
  167. $iCellId = $aMatches[1];
  168. $o = BxDolTemplate::getInstance();
  169. return $o->parseHtmlByName('wiki_add_block.html', array(
  170. 'add_block' => _t('_sys_wiki_add_block'),
  171. 'page' => $sPageObject,
  172. 'cell_id' => $iCellId,
  173. 'action_uri' => $oWikiObject->getUri(),
  174. ));
  175. }
  176. /**
  177. * @page service Service Calls
  178. * @section bx_system_general System Services
  179. * @subsection bx_system_general-wiki Wiki
  180. * @subsubsection bx_system_general-get_design_boxes get_design_boxes
  181. *
  182. * Get "design boxes" array
  183. *
  184. * @see BxBaseServiceWiki::serviceGetDesignBoxes
  185. */
  186. /**
  187. * @ref bx_system_general-get_design_boxes "get_design_boxes"
  188. */
  189. public function serviceGetDesignBoxes ()
  190. {
  191. $o = new BxDolStudioBuilderPageQuery();
  192. $aItems = array();
  193. if (!$o->getDesignBoxes(array('type' => 'all'), $aItems, false))
  194. return array();
  195. $a = array();
  196. foreach($aItems as $r)
  197. $a[$r['id']] = _t($r['title']);
  198. return $a;
  199. }
  200. /**
  201. * @page service Service Calls
  202. * @section bx_system_general System Services
  203. * @subsection bx_system_general-wiki Wiki
  204. * @subsubsection bx_system_general-pages_list pages_list
  205. *
  206. * Get list of pages in current module
  207. *
  208. * @see BxBaseServiceWiki::servicePagesList
  209. */
  210. /**
  211. * @ref bx_system_general-pages_list "pages_list"
  212. */
  213. public function servicePagesList ()
  214. {
  215. if (!($sPageObject = BxDolPageQuery::getPageObjectNameByURI(bx_get('i'))))
  216. return '';
  217. if (!($aPage = BxDolPageQuery::getPageObject ($sPageObject)))
  218. return '';
  219. if (!($oWiki = BxDolWiki::getObjectInstance($aPage['module'])))
  220. return '';
  221. BxDolTemplate::getInstance()->addCss(['wiki.css']);
  222. return $oWiki->getContents();
  223. }
  224. /**
  225. * @page service Service Calls
  226. * @section bx_system_general System Services
  227. * @subsection bx_system_general-wiki Wiki
  228. * @subsubsection bx_system_general-page_contents page_contents
  229. *
  230. * Get table of contents for current page, generated automatically from paragraphs headers
  231. *
  232. * @see BxBaseServiceWiki::servicePageContents
  233. */
  234. /**
  235. * @ref bx_system_general-page_contents "page_contents"
  236. */
  237. public function servicePageContents ()
  238. {
  239. $o = BxDolTemplate::getInstance();
  240. $o->addJs('toc.js');
  241. return $o->parseHtmlByName('wiki_page_contents.html', []);
  242. }
  243. protected function _addCssJs ($bAddPage = false)
  244. {
  245. if ($this->_bJsCssAdded)
  246. return false;
  247. $o = BxDolTemplate::getInstance();
  248. $o->addCss(['wiki.css']);
  249. $o->addJs('BxDolWiki.js');
  250. $o->addJsTranslation('_sys_wiki_external_editor_references_comment');
  251. if ($bAddPage)
  252. $o->addJs('studio/js/|forms.js');
  253. $this->_bJsCssAdded = true;
  254. }
  255. }
  256. /** @} */