BxDolStudioInstaller.php 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840
  1. <?php defined('BX_DOL') or die('hack attempt');
  2. /**
  3. * Copyright (c) BoonEx Pty Limited - http://www.boonex.com/
  4. * CC-BY License - http://creativecommons.org/licenses/by/3.0/
  5. *
  6. * @defgroup DolphinStudio Dolphin Studio
  7. * @{
  8. */
  9. bx_import('BxDolInstallerUtils');
  10. define("BX_DOL_STUDIO_INSTALLER_SUCCESS", 0);
  11. define("BX_DOL_STUDIO_INSTALLER_FAILED", 1);
  12. /**
  13. * Base class for Installer classes in modules engine.
  14. *
  15. * The class contains different check functions which are used during the installation process.
  16. * An object of the class is created automatically with Dolphin's modules installer.
  17. * Installation/Uninstallation process can be controlled with config.php file located in [module]/install/ folder.
  18. *
  19. *
  20. * Example of usage:
  21. * @see any module included in the default Dolphin's package.
  22. *
  23. *
  24. * Memberships/ACL:
  25. * Doesn't depend on user's membership.
  26. *
  27. *
  28. * Alerts:
  29. * no alerts available
  30. *
  31. */
  32. class BxDolStudioInstaller extends BxDolInstallerUtils
  33. {
  34. protected $oDb;
  35. protected $_aConfig;
  36. protected $_sBasePath;
  37. protected $_sHomePath;
  38. protected $_sModulePath;
  39. protected $_bUseFtp;
  40. protected $_aActions;
  41. protected $_bShowOnSuccess = false;
  42. function __construct($aConfig)
  43. {
  44. parent::__construct();
  45. $this->oDb = bx_instance('BxDolStudioInstallerQuery');
  46. $this->_aConfig = $aConfig;
  47. $this->_sBasePath = BX_DIRECTORY_PATH_MODULES;
  48. $this->_sHomePath = $this->_sBasePath . $aConfig['home_dir'];
  49. $this->_sModulePath = $this->_sBasePath . $aConfig['home_dir'];
  50. $this->_bUseFtp = BX_FORCE_USE_FTP_FILE_TRANSFER;
  51. $this->_aActions = array(
  52. 'perform_install' => array(
  53. 'title' => '',
  54. 'success' => _t('_adm_msg_modules_success_install'),
  55. 'failed' => ''
  56. ),
  57. 'perform_uninstall' => array(
  58. 'title' => '',
  59. 'success' => _t('_adm_msg_modules_success_uninstall'),
  60. 'failed' => ''
  61. ),
  62. 'perform_enable' => array(
  63. 'title' => '',
  64. 'success' => _t('_adm_msg_modules_success_enable'),
  65. 'failed' => ''
  66. ),
  67. 'perform_disable' => array(
  68. 'title' => '',
  69. 'success' => _t('_adm_msg_modules_success_disable'),
  70. 'failed' => ''
  71. ),
  72. 'check_script_version' => array(
  73. 'title' => _t('_adm_txt_modules_check_script_version'),
  74. ),
  75. 'check_dependencies' => array(
  76. 'title' => _t('_adm_txt_modules_check_dependencies'),
  77. ),
  78. 'show_introduction' => array(
  79. 'title' => _t('_adm_txt_modules_show_introduction'),
  80. ),
  81. 'check_permissions' => array(
  82. 'title' => _t('_adm_txt_modules_check_permissions'),
  83. ),
  84. 'change_permissions' => array(
  85. 'title' => _t('_adm_txt_modules_change_permissions'),
  86. ),
  87. 'move_sources' => array(
  88. 'title' => _t('_adm_txt_modules_move_sources'),
  89. ),
  90. 'execute_sql' => array(
  91. 'title' => _t('_adm_txt_modules_execute_sql'),
  92. ),
  93. 'install_language' => array(
  94. 'title' => _t('_adm_txt_modules_install_language'),
  95. ),
  96. 'update_languages' => array(
  97. 'title' => _t('_adm_txt_modules_update_languages'),
  98. ),
  99. 'update_relations' => array(
  100. 'title' => _t('_adm_txt_modules_update_relations'),
  101. ),
  102. 'process_deleted_profiles' => array(
  103. 'title' => _t('_adm_txt_modules_process_deleted_profiles'),
  104. ),
  105. 'recompile_global_paramaters' => array(
  106. 'title' => _t('_adm_txt_modules_recompile_global_paramaters'),
  107. ),
  108. 'recompile_menus' => array(
  109. 'title' => _t('_adm_txt_modules_recompile_menus'),
  110. ),
  111. 'recompile_site_stats' => array(
  112. 'title' => _t('_adm_txt_modules_recompile_site_stats'),
  113. ),
  114. 'recompile_comments' => array(
  115. 'title' => _t('_adm_txt_modules_recompile_comments'),
  116. ),
  117. 'recompile_member_actions' => array(
  118. 'title' => _t('_adm_txt_modules_recompile_member_actions'),
  119. ),
  120. 'recompile_votes' => array(
  121. 'title' => _t('_adm_txt_modules_recompile_votes'),
  122. ),
  123. 'recompile_search' => array(
  124. 'title' => _t('_adm_txt_modules_recompile_search'),
  125. ),
  126. 'recompile_injections' => array(
  127. 'title' => _t('_adm_txt_modules_recompile_injections'),
  128. ),
  129. 'recompile_permalinks' => array(
  130. 'title' => _t('_adm_txt_modules_recompile_permalinks'),
  131. ),
  132. 'recompile_alerts' => array(
  133. 'title' => _t('_adm_txt_modules_recompile_alerts'),
  134. ),
  135. 'clear_db_cache' => array(
  136. 'title' => _t('_adm_txt_modules_clear_db_cache'),
  137. ),
  138. 'show_conclusion' => array(
  139. 'title' => _t('_adm_txt_modules_show_conclusion'),
  140. ),
  141. );
  142. $this->_aNonHashableFiles = array(
  143. 'install',
  144. 'updates'
  145. );
  146. }
  147. public function install($aParams, $bAutoEnable = false)
  148. {
  149. $bAutoEnable = $bAutoEnable || (isset($aParams['auto_enable']) && (bool)$aParams['auto_enable']);
  150. //--- Check whether the module was already installed ---//
  151. if($this->oDb->isModule($this->_aConfig['home_uri']))
  152. return array(
  153. 'message' => _t('_adm_err_modules_already_installed'),
  154. 'result' => false
  155. );
  156. $aResult = array();
  157. bx_alert('system', 'before_install', 0, false, array ('config' => $this->_aConfig, 'result' => &$aResult));
  158. if ($aResult && !$aResult['result'])
  159. return $aResult;
  160. //--- Check mandatory settings ---//
  161. if($this->oDb->isModuleParamsUsed($this->_aConfig['home_uri'], $this->_aConfig['home_dir'], $this->_aConfig['db_prefix'], $this->_aConfig['class_prefix']))
  162. return array(
  163. 'message' => _t('_adm_txt_modules_params_used'),
  164. 'result' => false
  165. );
  166. //--- Check version compatibility ---//
  167. $bCompatible = false;
  168. if(isset($this->_aConfig['compatible_with']) && is_array($this->_aConfig['compatible_with']))
  169. foreach($this->_aConfig['compatible_with'] as $iKey => $sVersion) {
  170. $sVersion = '/^' . str_replace(array('.', 'x'), array('\.', '[A-Za-z0-9-]+'), $sVersion) . '$/is';
  171. $bCompatible = $bCompatible || (preg_match($sVersion, bx_get_ver()) > 0);
  172. }
  173. if(!$bCompatible)
  174. return array(
  175. 'message' => $this->_displayResult('check_script_version', false, '_adm_err_modules_wrong_version_script'),
  176. 'result' => false
  177. );
  178. //--- Check for available translations ---//
  179. $oFile = $this->_getFileManager();
  180. $sModuleUri = $this->_aConfig['home_uri'];
  181. $aLanguages = $this->oDb->getModulesBy(array('type' => 'languages'));
  182. foreach($aLanguages as $aLanguage) {
  183. if($aLanguage['uri'] == 'en')
  184. continue;
  185. $aLanguageConfig = self::getModuleConfig(BX_DIRECTORY_PATH_MODULES . $aLanguage['path'] . '/install/config.php');
  186. if(empty($aLanguageConfig))
  187. continue;
  188. if(!isset($aLanguageConfig['includes'][$sModuleUri]) || empty($aLanguageConfig['includes'][$sModuleUri]))
  189. continue;
  190. $sSrcPath = 'modules/' . $aLanguage['path'] . 'install/data/' . $aLanguageConfig['includes'][$sModuleUri];
  191. $sDstPath = $aLanguageConfig['includes'][$sModuleUri];
  192. $oFile->copy($sSrcPath, $sDstPath);
  193. }
  194. //--- Check actions ---//
  195. $aResult = $this->_perform('install');
  196. if($aResult['result']) {
  197. $sDependencies = "";
  198. if(isset($this->_aConfig['install']['check_dependencies']) && (int)$this->_aConfig['install']['check_dependencies'] == 1 && isset($this->_aConfig['dependencies']) && is_array($this->_aConfig['dependencies']))
  199. $this->_aConfig['dependencies'] = array_keys($this->_aConfig['dependencies']);
  200. $iModuleId = $this->oDb->insertModule($this->_aConfig);
  201. bx_import('BxDolModule');
  202. $sTitleKey = BxDolModule::getTitleKey($this->_aConfig['home_uri']);
  203. bx_import('BxDolStudioLanguagesUtils');
  204. $oLanguages = BxDolStudioLanguagesUtils::getInstance();
  205. $oLanguages->addLanguageString($sTitleKey, $this->_aConfig['title']);
  206. $oLanguages->compileLanguage();
  207. $aFiles = array();
  208. $this->hashFiles($this->_sModulePath, $aFiles);
  209. foreach($aFiles as $aFile)
  210. $this->oDb->insertModuleTrack($iModuleId, $aFile);
  211. $this->oDb->cleanMemory('sys_modules_' . $this->_aConfig['home_uri']);
  212. $this->oDb->cleanMemory('sys_modules_' . $iModuleId);
  213. $this->oDb->cleanMemory('sys_modules');
  214. }
  215. bx_alert('system', 'install', 0, false, array ('config' => $this->_aConfig, 'result' => &$aResult));
  216. if($aResult['result'] && $bAutoEnable) {
  217. $aResultEnable = $this->enable($aParams);
  218. $aResult['result'] = $aResult['result'] & $aResultEnable['result'];
  219. $aResult['message'] = $aResult['message'] . $aResultEnable['message'];
  220. }
  221. return $aResult;
  222. }
  223. public function uninstall($aParams, $bAutoDisable = false)
  224. {
  225. $bAutoDisable = $bAutoDisable || (isset($aParams['auto_disable']) && (bool)$aParams['auto_disable']);
  226. //--- Check whether the module was already uninstalled ---//
  227. if(!$this->oDb->isModule($this->_aConfig['home_uri']))
  228. return array(
  229. 'message' => _t('_adm_err_modules_already_uninstalled'),
  230. 'result' => false
  231. );
  232. if($bAutoDisable) {
  233. $aResultDisable = $this->disable($aParams);
  234. if(!$aResultDisable['result'])
  235. return $aResultDisable;
  236. }
  237. $aResult = array();
  238. bx_alert('system', 'before_uninstall', 0, false, array ('config' => $this->_aConfig, 'result' => &$aResult));
  239. if ($aResult && !$aResult['result'])
  240. return $aResult;
  241. //--- Check for dependent modules ---//
  242. $bDependent = false;
  243. $aDependents = $this->oDb->getDependent($this->_aConfig['home_uri']);
  244. if(is_array($aDependents) && !empty($aDependents)) {
  245. $bDependent = true;
  246. $sMessage = '<br />' . _t('_adm_err_modules_wrong_dependency_uninstall') . '<br />';
  247. foreach($aDependents as $aDependent)
  248. $sMessage .= $aDependent['title'] . '<br />';
  249. }
  250. if($bDependent)
  251. return array(
  252. 'message' => $this->_displayResult('check_dependencies', false, $sMessage),
  253. 'result' => false
  254. );
  255. $aResult = $this->_perform('uninstall');
  256. if($aResult['result']) {
  257. $iModuleId = $this->oDb->deleteModule($this->_aConfig);
  258. bx_import('BxDolModule');
  259. $sTitleKey = BxDolModule::getTitleKey($this->_aConfig['home_uri']);
  260. bx_import('BxDolStudioLanguagesUtils');
  261. $oLanguages = BxDolStudioLanguagesUtils::getInstance();
  262. $oLanguages->deleteLanguageString($sTitleKey);
  263. $oLanguages->compileLanguage();
  264. $this->oDb->cleanMemory ('sys_modules_' . $this->_aConfig['home_uri']);
  265. $this->oDb->cleanMemory ('sys_modules_' . $iModuleId);
  266. $this->oDb->cleanMemory ('sys_modules');
  267. }
  268. if($bAutoDisable) {
  269. $aResult['result'] = $aResultDisable['result'] & $aResult['result'];
  270. $aResult['message'] = $aResultDisable['message'] . $aResult['message'];
  271. }
  272. bx_alert('system', 'uninstall', 0, false, array ('config' => $this->_aConfig, 'result' => &$aResult));
  273. return $aResult;
  274. }
  275. public function delete()
  276. {
  277. $aError = array(
  278. 'message' => _t('_adm_err_modules_cannot_remove_package'),
  279. 'result' => false
  280. );
  281. $oFile = $this->_getFileManager();
  282. if(empty($oFile))
  283. return $aError;
  284. if(!$oFile->delete('modules/' . $this->_aConfig['home_dir']))
  285. return $aError;
  286. return array(
  287. 'message' => '', //_t('_adm_msg_modules_success_delete'),
  288. 'result' => true
  289. );
  290. }
  291. public function recompile($aParams)
  292. {
  293. bx_import('BxDolStudioLanguagesUtils');
  294. $oLanguages = BxDolStudioLanguagesUtils::getInstance();
  295. $aResult = array('message' => '', 'result' => false);
  296. $aLanguages = $this->oDb->getLanguages();
  297. if (isAdmin() && !empty($aLanguages)) {
  298. $this->_updateLanguage(false, current($aLanguages));
  299. $bResult = false;
  300. foreach($aLanguages as $aLanguage) {
  301. $bResult = $this->_updateLanguage(true, $aLanguage) && $oLanguages->compileLanguage($aLanguage['id']);
  302. $aResult['message'] .= $aLanguage['title'] . ': <span style="color:' . ($bResult ? 'green' : 'red') . '">' . _t($bResult ? '_adm_txt_modules_process_action_success' : '_adm_txt_modules_process_action_failed') . '</span><br />';
  303. $aResult['result'] |= $bResult;
  304. }
  305. }
  306. return $aResult;
  307. }
  308. public function enable($aParams)
  309. {
  310. $aModule = $this->oDb->getModuleByUri($this->_aConfig['home_uri']);
  311. //--- Check whether the module is installed ---//
  312. if(empty($aModule) || !is_array($aModule))
  313. return array(
  314. 'message' => _t('_adm_err_modules_module_not_installed'),
  315. 'result' => false
  316. );
  317. //--- Check whether the module is already enabled ---//
  318. if((int)$aModule['enabled'] != 0)
  319. return array(
  320. 'message' => _t('_adm_err_modules_already_enabled'),
  321. 'result' => false
  322. );
  323. $aResult = array();
  324. bx_alert('system', 'before_enable', 0, false, array ('config' => $this->_aConfig, 'result' => &$aResult));
  325. if ($aResult && !$aResult['result'])
  326. return $aResult;
  327. $aResult = $this->_perform('enable');
  328. if($aResult['result']) {
  329. $this->oDb->enableModuleByUri($aModule['uri']);
  330. $this->oDb->cleanMemory('sys_modules_' . $aModule['uri']);
  331. $this->oDb->cleanMemory('sys_modules_' . $aModule['id']);
  332. $this->oDb->cleanMemory('sys_modules');
  333. }
  334. bx_alert('system', 'enable', 0, false, array ('config' => $this->_aConfig, 'result' => &$aResult));
  335. return $aResult;
  336. }
  337. public function disable($aParams)
  338. {
  339. $aModule = $this->oDb->getModuleByUri($this->_aConfig['home_uri']);
  340. //--- Check whether the module is installed ---//
  341. if(empty($aModule) || !is_array($aModule))
  342. return array(
  343. 'message' => _t('_adm_err_modules_module_not_installed'),
  344. 'result' => false
  345. );
  346. //--- Check whether the module is already disabled ---//
  347. if((int)$aModule['enabled'] == 0)
  348. return array(
  349. 'message' => _t('_adm_err_modules_already_disabled'),
  350. 'result' => false
  351. );
  352. $aResult = array();
  353. bx_alert('system', 'before_disable', 0, false, array ('config' => $this->_aConfig, 'result' => &$aResult));
  354. if ($aResult && !$aResult['result'])
  355. return $aResult;
  356. //--- Check for dependent modules ---//
  357. $bDependent = false;
  358. $aDependents = $this->oDb->getDependent($this->_aConfig['home_uri']);
  359. if(is_array($aDependents) && !empty($aDependents)) {
  360. $bDependent = true;
  361. $sMessage = '<br />' . _t('_adm_err_modules_wrong_dependency_disable') . '<br />';
  362. foreach($aDependents as $aDependent)
  363. $sMessage .= $aDependent['title'] . '<br />';
  364. }
  365. if($bDependent)
  366. return array(
  367. 'message' => $this->_displayResult('check_dependencies', false, $sMessage),
  368. 'result' => false
  369. );
  370. $aResult = $this->_perform('disable');
  371. if($aResult['result']) {
  372. $this->oDb->disableModuleByUri($aModule['uri']);
  373. $this->oDb->cleanMemory('sys_modules_' . $aModule['uri']);
  374. $this->oDb->cleanMemory('sys_modules_' . $aModule['id']);
  375. $this->oDb->cleanMemory('sys_modules');
  376. }
  377. bx_alert('system', 'disable', 0, false, array ('config' => $this->_aConfig, 'result' => &$aResult));
  378. return $aResult;
  379. }
  380. protected function filePathWithoutBase($sPath)
  381. {
  382. return bx_ltrim_str($sPath, $this->_sModulePath);
  383. }
  384. function _perform($sOperationName)
  385. {
  386. if(!defined('BX_SKIP_INSTALL_CHECK') && !defined('BX_DOL_CRON_EXECUTE') && !$GLOBALS['logged']['admin'])
  387. return array('message' => '_adm_mod_err_only_admin_can_perform_operations_with_modules', 'result' => false);
  388. $sMessage = '';
  389. foreach($this->_aConfig[$sOperationName] as $sAction => $iEnabled) {
  390. $sMethod = 'action' . bx_gen_method_name($sAction);
  391. if($iEnabled == 0 || !method_exists($this, $sMethod))
  392. continue;
  393. $mixedResult = $this->$sMethod($sOperationName);
  394. //--- On Success ---//
  395. if((is_int($mixedResult) && (int)$mixedResult == BX_DOL_STUDIO_INSTALLER_SUCCESS) || (isset($mixedResult['code']) && (int)$mixedResult['code'] == BX_DOL_STUDIO_INSTALLER_SUCCESS)) {
  396. $sMessage .= $this->_displayResult($sAction, true, isset($mixedResult['content']) ? $mixedResult['content'] : '');
  397. continue;
  398. }
  399. //--- On Failed ---//
  400. $sMethodFailed = $sMethod . 'Failed';
  401. return array('message' => $this->_displayResult($sAction, false, method_exists($this, $sMethodFailed) ? $this->$sMethodFailed($mixedResult) : $this->actionOperationFailed($mixedResult)), 'result' => false);
  402. }
  403. if($this->_bShowOnSuccess)
  404. $sMessage = $this->_aActions['perform_' . $sOperationName]['success'] . $sMessage;
  405. return array('message' => $sMessage, 'result' => true);
  406. }
  407. function _displayResult($sAction, $bResult, $sResult = '')
  408. {
  409. $sMessage = $this->_aActions[$sAction]['title'] . ' ';
  410. if(!empty($sResult))
  411. $sResult = (substr($sResult, 0, 1) == '_' ? _t($sResult) : $sResult) . '<br />';
  412. if(!$bResult)
  413. return $sMessage . '<span style="color:red;">' . $sResult . '</span>';
  414. if($bResult && !in_array($sAction, array('show_introduction', 'show_conclusion')) && !$this->_bShowOnSuccess)
  415. return;
  416. return $sMessage . '<span style="color:green;">' . (!empty($sResult) ? $sResult : _t('_adm_txt_modules_process_action_success') . '<br />') . '</span>';
  417. }
  418. //--- Action Methods ---//
  419. function actionOperationFailed($mixedResult)
  420. {
  421. return _t('_adm_err_modules_process_action_failed');
  422. }
  423. function actionCheckDependencies($sOperation)
  424. {
  425. $sContent = '';
  426. if(in_array($sOperation, array('install', 'enable', 'update'))) {
  427. if(!isset($this->_aConfig['dependencies']) || !is_array($this->_aConfig['dependencies']))
  428. return BX_DOL_STUDIO_INSTALLER_SUCCESS;
  429. foreach($this->_aConfig['dependencies'] as $sModuleUri => $sModuleTitle)
  430. if(!$this->oDb->isModule($sModuleUri))
  431. $sContent .= $sModuleTitle . '<br />';
  432. if(!empty($sContent))
  433. $sContent = '<br />' . _t('_adm_err_modules_wrong_dependency_install') . '<br />' . $sContent;
  434. }
  435. return empty($sContent) ? BX_DOL_STUDIO_INSTALLER_SUCCESS : array('code' => BX_DOL_STUDIO_INSTALLER_FAILED, 'content' => $sContent);
  436. }
  437. function actionCheckDependenciesFailed($mixedResult)
  438. {
  439. return $mixedResult['content'];
  440. }
  441. function actionShowIntroduction($sOperation)
  442. {
  443. if(!isset($this->_aConfig[$sOperation . '_info']['introduction']))
  444. return BX_DOL_STUDIO_INSTALLER_FAILED;
  445. $sPath = $this->_sHomePath . 'install/info/' . $this->_aConfig[$sOperation . '_info']['introduction'];
  446. return file_exists($sPath) ? array("code" => BX_DOL_STUDIO_INSTALLER_SUCCESS, "content" => "<pre>" . file_get_contents($sPath) . "</pre>") : BX_DOL_STUDIO_INSTALLER_FAILED;
  447. }
  448. function actionShowConclusion($sOperation)
  449. {
  450. if(!isset($this->_aConfig[$sOperation . '_info']['conclusion']))
  451. return BX_DOL_STUDIO_INSTALLER_FAILED;
  452. $sPath = $this->_sHomePath . 'install/info/' . $this->_aConfig[$sOperation . '_info']['conclusion'];
  453. return file_exists($sPath) ? array("code" => BX_DOL_STUDIO_INSTALLER_SUCCESS, "content" => "<pre>" . file_get_contents($sPath) . "</pre>") : BX_DOL_STUDIO_INSTALLER_FAILED;
  454. }
  455. function actionCheckPermissions($sOperation)
  456. {
  457. if(!isset($this->_aConfig[$sOperation . '_permissions']) || !is_array($this->_aConfig[$sOperation . '_permissions']))
  458. return BX_DOL_STUDIO_INSTALLER_FAILED;
  459. $aResult = array();
  460. $aPermissions = $this->_aConfig[$sOperation . '_permissions'];
  461. foreach($aPermissions as $sPermissions => $aFiles) {
  462. $sCheckFunction = 'is' . ucfirst($sPermissions);
  463. $sCptPermissions = _t('_adm_txt_modules_' . $sPermissions);
  464. foreach($aFiles as $sFile)
  465. if(!BxDolInstallerUtils::$sCheckFunction(str_replace(BX_DIRECTORY_PATH_ROOT, '', $this->_sModulePath . $sFile)))
  466. $aResult[] = array('path' => $this->_sModulePath . $sFile, 'permissions' => $sCptPermissions);
  467. }
  468. return empty($aResult) ? BX_DOL_STUDIO_INSTALLER_SUCCESS : array('code' => BX_DOL_STUDIO_INSTALLER_FAILED, 'content' => $aResult);
  469. }
  470. function actionCheckPermissionsFailed($mixedResult)
  471. {
  472. $sResult = '<br />' . _t('_adm_err_modules_wrong_permissions_check') . '<br />';
  473. foreach($mixedResult['content'] as $aFile)
  474. $sResult .= _t('_adm_err_modules_wrong_permissions_msg', $aFile['path'], $aFile['permissions']) . '<br />';
  475. return $sResult;
  476. }
  477. function actionChangePermissions($sOperation)
  478. {
  479. if(!isset($this->_aConfig[$sOperation . '_permissions']) || !is_array($this->_aConfig[$sOperation . '_permissions']))
  480. return BX_DOL_STUDIO_INSTALLER_FAILED;
  481. $aChangeItems = array();
  482. $aPermissions = $this->_aConfig[$sOperation . '_permissions'];
  483. foreach($aPermissions as $sPermissions => $aFiles) {
  484. $sCheckFunction = 'is' . ucfirst($sPermissions);
  485. foreach($aFiles as $sFile) {
  486. $sPath = bx_ltrim_str($this->_sModulePath . $sFile, BX_DIRECTORY_PATH_ROOT);
  487. if(BxDolInstallerUtils::$sCheckFunction($sPath))
  488. continue;
  489. $aChangeItems[] = array('file' => $sFile, 'path' => $sPath, 'permissions' => $sPermissions);
  490. }
  491. }
  492. if(empty($aChangeItems))
  493. return BX_DOL_STUDIO_INSTALLER_SUCCESS;
  494. $oFile = $this->_getFileManager();
  495. if(empty($oFile))
  496. return array('code' => BX_DOL_STUDIO_INSTALLER_FAILED);
  497. $aResult = array();
  498. foreach($aChangeItems as $aChangeItem)
  499. if(!$oFile->setPermissions($aChangeItem['path'], $aChangeItem['permissions']))
  500. $aResult[] = array('path' => $this->_sModulePath . $aChangeItem['file'], 'permissions' => $aChangeItem['permissions']);
  501. return empty($aResult) ? BX_DOL_STUDIO_INSTALLER_SUCCESS : array('code' => BX_DOL_STUDIO_INSTALLER_FAILED, 'content' => $aResult);
  502. }
  503. function actionChangePermissionsFailed($mixedResult)
  504. {
  505. if(empty($mixedResult['content']))
  506. return $this->actionOperationFailed($mixedResult);
  507. $sResult = '<br />' . _t('_adm_err_modules_wrong_permissions_change') . '<br />';
  508. foreach($mixedResult['content'] as $aFile)
  509. $sResult .= _t('_adm_err_modules_wrong_permissions_msg', $aFile['path'], $aFile['permissions']) . '<br />';
  510. return $sResult;
  511. }
  512. function actionMoveSources($sOperation)
  513. {
  514. $oFile = $this->_getFileManager();
  515. $aInstalled = array_merge(array('system'), $this->oDb->getModulesUri());
  516. $bResult = true;
  517. foreach($this->_aConfig['includes'] as $sUri => $sPath) {
  518. if(!in_array($sUri, $aInstalled) || empty($sPath))
  519. continue;
  520. if($sOperation == 'install') {
  521. $sSrcPath = 'modules/' . $this->_aConfig['home_dir'] . 'install/data/' . $sPath;
  522. $sDstPath = $sPath;
  523. $bResult &= $oFile->copy($sSrcPath, $sDstPath);
  524. } else if($sOperation == 'uninstall')
  525. $bResult &= $oFile->delete($sPath);
  526. }
  527. return $bResult ? BX_DOL_STUDIO_INSTALLER_SUCCESS : BX_DOL_STUDIO_INSTALLER_FAILED;
  528. }
  529. function actionExecuteSql($sOperation)
  530. {
  531. switch($sOperation) {
  532. case 'install':
  533. $this->actionExecuteSql('disable');
  534. $this->actionExecuteSql('uninstall');
  535. break;
  536. case 'enable':
  537. $this->actionExecuteSql('disable');
  538. break;
  539. }
  540. bx_import('BxDolDb');
  541. $mixedResult = BxDolDb::getInstance()->executeSQL($this->_sHomePath . 'install/sql/' . $sOperation . '.sql');
  542. return $mixedResult === true ? BX_DOL_STUDIO_INSTALLER_SUCCESS : array('code' => BX_DOL_STUDIO_INSTALLER_FAILED, 'content' => $mixedResult);
  543. }
  544. function actionExecuteSqlFailed($mixedResult)
  545. {
  546. $sResult = '<br />' . _t('_adm_err_modules_wrong_mysql_query') . '<br />';
  547. foreach($mixedResult['content'] as $aQuery) {
  548. $sResult .= _t('_adm_err_modules_wrong_mysql_query_msg', $aQuery['error']) . '<br />';
  549. $sResult .= '<pre>' . $aQuery['query'] . '</pre>';
  550. }
  551. return $sResult;
  552. }
  553. function actionInstallLanguage($sOperation)
  554. {
  555. bx_import('BxDolStudioLanguagesUtils');
  556. $oLanguages = BxDolStudioLanguagesUtils::getInstance();
  557. $sLanguage = isset($this->_aConfig['home_uri']) ? $this->_aConfig['home_uri'] : '';
  558. $bResult = true;
  559. if($sOperation == 'install')
  560. $bResult = $oLanguages->installLanguage(array('path' => $this->_aConfig['home_dir'], 'uri' => $this->_aConfig['home_uri'], 'lang_category' => $this->_aConfig['language_category']),false);
  561. return $bResult && $oLanguages->compileLanguage(0, true) ? BX_DOL_STUDIO_INSTALLER_SUCCESS : BX_DOL_STUDIO_INSTALLER_FAILED;
  562. }
  563. function actionUpdateLanguages($sOperation)
  564. {
  565. if(!isset($this->_aConfig['language_category']) || empty($this->_aConfig['language_category']))
  566. return BX_DOL_STUDIO_INSTALLER_FAILED;
  567. bx_import('BxDolStudioLanguagesUtils');
  568. $oLanguages = BxDolStudioLanguagesUtils::getInstance();
  569. $bResult = true;
  570. $aResult = array();
  571. //--- Process Language Category ---//
  572. if($sOperation == 'install')
  573. $iCategoryId = $oLanguages->addLanguageCategory($this->_aConfig['language_category']);
  574. //--- Process languages' key=>value pears ---//
  575. $aModule = array(
  576. 'path' => $this->_aConfig['home_dir'],
  577. 'uri' => $this->_aConfig['home_uri'],
  578. 'lang_category' => $this->_aConfig['language_category']
  579. );
  580. if($sOperation == 'install')
  581. $bResult = $oLanguages->restoreLanguage(0, $aModule, false);
  582. else if($sOperation == 'uninstall')
  583. $bResult = $oLanguages->removeLanguageByModule($aModule, false);
  584. if($sOperation == 'uninstall' && $bResult)
  585. $oLanguages->deleteLanguageCategory($this->_aConfig['language_category']);
  586. return $bResult && $oLanguages->compileLanguage(0, true) ? BX_DOL_STUDIO_INSTALLER_SUCCESS : BX_DOL_STUDIO_INSTALLER_FAILED;
  587. }
  588. function actionUpdateRelations($sOperation)
  589. {
  590. if(!in_array($sOperation, array('install', 'uninstall', 'enable', 'disable')))
  591. return BX_DOL_STUDIO_INSTALLER_FAILED;
  592. if(empty($this->_aConfig['relations']) || !is_array($this->_aConfig['relations']))
  593. return BX_DOL_STUDIO_INSTALLER_SUCCESS;
  594. foreach($this->_aConfig['relations'] as $sModule) {
  595. if(!$this->oDb->isModuleByName($sModule))
  596. continue;
  597. $aRelation = $this->oDb->getRelationsBy(array('type' => 'module', 'value' => $sModule));
  598. if(empty($aRelation) || empty($aRelation['on_' . $sOperation]) || !BxDolRequest::serviceExists($aRelation['module'], $aRelation['on_' . $sOperation]))
  599. continue;
  600. BxDolService::call($aRelation['module'], $aRelation['on_' . $sOperation], array($this->_aConfig['home_uri']));
  601. }
  602. return BX_DOL_STUDIO_INSTALLER_SUCCESS;
  603. }
  604. function actionProcessDeletedProfiles($sOperation)
  605. {
  606. if(!in_array($sOperation, array('install', 'uninstall', 'enable', 'disable')))
  607. return BX_DOL_STUDIO_INSTALLER_FAILED;
  608. bx_import('BxDolProfileQuery');
  609. $o = BxDolProfileQuery::getInstance();
  610. $o->processDeletedProfiles();
  611. return BX_DOL_STUDIO_INSTALLER_SUCCESS;
  612. }
  613. function actionRecompileGlobalParamaters($sOperation)
  614. {
  615. $bResult = $this->oDb->cacheParamsClear();
  616. return $bResult ? BX_DOL_STUDIO_INSTALLER_SUCCESS : BX_DOL_STUDIO_INSTALLER_FAILED;
  617. }
  618. function actionRecompileMenus($sOperation)
  619. {
  620. $bResult = $this->oDb->cleanCache('sys_objects_menu');
  621. return $bResult ? BX_DOL_STUDIO_INSTALLER_SUCCESS : BX_DOL_STUDIO_INSTALLER_FAILED;
  622. }
  623. function actionRecompileSiteStats($sOperation)
  624. {
  625. $bResult = $this->oDb->cleanCache('sys_stat_site');
  626. return $bResult ? BX_DOL_STUDIO_INSTALLER_SUCCESS : BX_DOL_STUDIO_INSTALLER_FAILED;
  627. }
  628. function actionRecompileComments($sOperation)
  629. {
  630. $bResult = $this->oDb->cleanCache('sys_objects_cmts');
  631. return $bResult ? BX_DOL_STUDIO_INSTALLER_SUCCESS : BX_DOL_STUDIO_INSTALLER_FAILED;
  632. }
  633. function actionRecompileMemberActions($sOperation)
  634. {
  635. $bResult = $this->oDb->cleanCache('sys_objects_actions');
  636. return $bResult ? BX_DOL_STUDIO_INSTALLER_SUCCESS : BX_DOL_STUDIO_INSTALLER_FAILED;
  637. }
  638. function actionRecompileVotes($sOperation)
  639. {
  640. $bResult = $this->oDb->cleanCache('sys_objects_vote');
  641. return $bResult ? BX_DOL_STUDIO_INSTALLER_SUCCESS : BX_DOL_STUDIO_INSTALLER_FAILED;
  642. }
  643. function actionRecompileInjections($sOperation)
  644. {
  645. $bResult = $this->oDb->cleanCache('sys_injections.inc');
  646. $bResult = $bResult && $this->oDb->cleanCache('sys_injections_admin.inc');
  647. return $bResult ? BX_DOL_STUDIO_INSTALLER_SUCCESS : BX_DOL_STUDIO_INSTALLER_FAILED;
  648. }
  649. function actionRecompilePermalinks($sOperation)
  650. {
  651. $bResult = true;
  652. bx_import('BxDolPermalinks');
  653. $bResult = $bResult && BxDolPermalinks::getInstance()->cacheInvalidate();
  654. $bResult = $bResult && ($this->actionRecompileMenus($sOperation) == BX_DOL_STUDIO_INSTALLER_SUCCESS);
  655. return $bResult ? BX_DOL_STUDIO_INSTALLER_SUCCESS : BX_DOL_STUDIO_INSTALLER_FAILED;
  656. }
  657. function actionRecompileAlerts($sOperation)
  658. {
  659. $bResult = $this->oDb->cleanCache('sys_alerts');
  660. return $bResult ? BX_DOL_STUDIO_INSTALLER_SUCCESS : BX_DOL_STUDIO_INSTALLER_FAILED;
  661. }
  662. function actionClearDbCache($sOperation)
  663. {
  664. $oCache = $this->oDb->getDbCacheObject();
  665. $bResult = $oCache->removeAllByPrefix('db_');
  666. return $bResult ? BX_DOL_STUDIO_INSTALLER_SUCCESS : BX_DOL_STUDIO_INSTALLER_FAILED;
  667. }
  668. //--- Get/Set Methods ---//
  669. function getVendor()
  670. {
  671. return $this->_aConfig['vendor'];
  672. }
  673. function getName()
  674. {
  675. return $this->_aConfig['name'];
  676. }
  677. function getTitle()
  678. {
  679. return $this->_aConfig['title'];
  680. }
  681. function getHomeDir()
  682. {
  683. return $this->_aConfig['home_dir'];
  684. }
  685. //--- Protected methods ---//
  686. protected function _getFileManager()
  687. {
  688. $oFile = null;
  689. if($this->_bUseFtp) {
  690. bx_import('BxDolFtp');
  691. $oFile = new BxDolFtp(isset($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : 'localhost', getParam('sys_ftp_login'), getParam('sys_ftp_password'), getParam('sys_ftp_dir'));
  692. if(!$oFile->connect())
  693. return null;
  694. if(!$oFile->isDolphin())
  695. return null;
  696. }
  697. else {
  698. bx_import('BxDolFile');
  699. $oFile = BxDolFile::getInstance();
  700. }
  701. return $oFile;
  702. }
  703. }
  704. /** @} */