PageRenderTime 86ms CodeModel.GetById 34ms RepoModel.GetById 0ms app.codeStats 0ms

/src/TTinstaller.php

https://github.com/oveas/terra-terra
PHP | 705 lines | 454 code | 43 blank | 208 comment | 71 complexity | 29ef726bb6f21fe5157e85b8b28e6566 MD5 | raw file
Possible License(s): LGPL-3.0, GPL-3.0 
    

  1. <?php
    2. 

  2. /**
    3. 

  3.  * \file
    4. 

  4.  * \ingroup TT_SO_LAYER
    5. 

  5.  * This file defines the class to install applications
    6. 

  6.  * \copyright{2007-2011} Oscar van Eijk, Oveas Functionality Provider
    7. 

  7.  * \license
    8. 

  8.  * This file is part of Terra-Terra.
    9. 

  9.  *
    10. 

  10.  * Terra-Terra is free software: you can redistribute it and/or modify
    11. 

  11.  * it under the terms of the GNU General Public License as published by
    12. 

  12.  * the Free Software Foundation, either version 3 of the License, or
    13. 

  13.  * any later version.
    14. 

  14.  *
    15. 

  15.  * Terra-Terra is distributed in the hope that it will be useful,
    16. 

  16.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
    17. 

  17.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    18. 

  18.  * GNU General Public License for more details.
    19. 

  19.  *
    20. 

  20.  * You should have received a copy of the GNU General Public License
    21. 

  21.  * along with Terra-Terra. If not, see http://www.gnu.org/licenses/.
    22. 

  22.  */
    23. 

  23. 

  24. /**
    25. 

  25.  * \ingroup TT_SO_LAYER
    26. 

  26.  * Abstract class to install applications
    27. 

  27.  * \brief Application installer
    28. 

  28.  * \author Oscar van Eijk, Oveas Functionality Provider
    29. 

  29.  * \version Apr 19, 2011 -- O van Eijk -- Initial version for OWL-PHP
    30. 

  30.  */
    31. 

  31. abstract class TTinstaller
    32. 

  32. {
    33. 

  33. 	/**
    34. 

  34. 	 * Array with registered rights and their bitvalues
    35. 

  35. 	 */
    36. 

  36. 	private static $rights = array();
    37. 

  37. 

  38. 	/**
    39. 

  39. 	 * Array with registered groups and their IDs
    40. 

  40. 	 */
    41. 

  41. 	private static $groups = array();
    42. 

  42. 

  43. 	/**
    44. 

  44. 	 * Preload TT data that can be used during the application install. Skip this when we're installing TT itself
    45. 

  45. 	 * \author Oscar van Eijk, Oveas Functionality Provider
    46. 

  46. 	 */
    47. 

  47. 	public static function construct()
    48. 

  48. 	{
    49. 

  49. 		if (defined('TT__BASE__INSTALL')) {
    50. 

  50. 			return;
    51. 

  51. 		}
    52. 

  52. 		$dataset = new DataHandler();
    53. 

  53. 		if (ConfigHandler::get ('database', 'tttables', true)) {
    54. 

  54. 			$dataset->setPrefix(ConfigHandler::get ('database', 'ttprefix'));
    55. 

  55. 		}
    56. 

  56. 		$dataset->setTablename('group');
    57. 

  57. 		$dataset->set('aid', TT_ID);
    58. 

  58. 		$dataset->setKey('aid');
    59. 

  59. 		$dataset->prepare();
    60. 

  60. 		$dataset->db($_data, __LINE__, __FILE__);
    61. 

  61. 		foreach ($_data as $_grp) {
    62. 

  62. 			self::$groups[$_grp['groupname'] . '__AID__' . TT_ID] = $_grp['gid'];
    63. 

  63. 		}
    64. 

  64. 	}
    65. 

  65. 

  66. 	/**
    67. 

  67. 	 * Register an application in the database
    68. 

  68. 	 * \param[in] $code Application code
    69. 

  69. 	 * \param[in] $url URL (relative from the document root) where the application will be installed. When empty or null, defaults to the lowercase application name
    70. 

  70. 	 * \param[in] $name Name of the application
    71. 

  71. 	 * \param[in] $version Version number of the application
    72. 

  72. 	 * \param[in] $released Optional release date of the application
    73. 

  73. 	 * \param[in] $description Optional description
    74. 

  74. 	 * \param[in] $link Optional link to the applications homepage
    75. 

  75. 	 * \param[in] $author Optional name of the copyright holder
    76. 

  76. 	 * \param[in] $license Optional license
    77. 

  77. 	 * \return The application ID
    78. 

  78. 	 * \author Oscar van Eijk, Oveas Functionality Provider
    79. 

  79. 	 * \todo Error checking
    80. 

  80. 	 */
    81. 

  81. 	private static function installApplication ($code, $url, $name, $version, $released = null, $description = '', $link = '', $author = '', $license = '')
    82. 

  82. 	{
    83. 

  83. 		OutputHandler::output('Create application ' . $name . ' (' . $code . ')', TT_OUTPUT_NOW);
    84. 

  84. 		$dataset = new DataHandler();
    85. 

  85. 		if (ConfigHandler::get ('database', 'tttables', true)) {
    86. 

  86. 			$dataset->setPrefix(ConfigHandler::get ('database', 'ttprefix'));
    87. 

  87. 		}
    88. 

  88. 		if (!$url) {
    89. 

  89. 			$url = strtolower($name);
    90. 

  90. 		}
    91. 

  91. 		$dataset->setTablename('applications');
    92. 

  92. 		$dataset->set('code', $code);
    93. 

  93. 		$dataset->set('url', $url);
    94. 

  94. 		$dataset->set('name', $name);
    95. 

  95. 		$dataset->set('version', $version);
    96. 

  96. 		$dataset->set('released', $released);
    97. 

  97. 		$dataset->set('description', $description);
    98. 

  98. 		$dataset->set('link', $link);
    99. 

  99. 		$dataset->set('author',$author);
    100. 

  100. 		$dataset->set('license', $license);
    101. 

  101. 		$dataset->set('enabled', '0');
    102. 

  102. 		$dataset->prepare(DATA_WRITE);
    103. 

  103. 		$dataset->db($_dummy, __LINE__, __FILE__);
    104. 

  104. 		return ($dataset->insertedId());
    105. 

  105. 	}
    106. 

  106. 

  107. 	/**
    108. 

  108. 	 * Enable an application
    109. 

  109. 	 * \param[in] $id Application ID
    110. 

  110. 	 * \author Oscar van Eijk, Oveas Functionality Provider
    111. 

  111. 	 */
    112. 

  112. 	public static function enableApplication ($id)
    113. 

  113. 	{
    114. 

  114. 		$dataset = new DataHandler();
    115. 

  115. 		if (ConfigHandler::get ('database', 'tttables', true)) {
    116. 

  116. 			$dataset->setPrefix(ConfigHandler::get ('database', 'ttprefix'));
    117. 

  117. 		}
    118. 

  118. 		$dataset->setTablename('applications');
    119. 

  119. 		$dataset->set('aid', $id);
    120. 

  120. 		$dataset->set('enabled', 1);
    121. 

  121. 		$dataset->setKey('aid');
    122. 

  122. 		$dataset->prepare(DATA_UPDATE);
    123. 

  123. 		$dataset->db($_dummy, __LINE__, __FILE__);
    124. 

  124. 	}
    125. 

  125. 

  126. 	/**
    127. 

  127. 	 * Parse a given SQL file
    128. 

  128. 	 * \param[in] $fname Full path specification of the file containing SQL statements
    129. 

  129. 	 * \return An array with all SQL statements from the file, or null when an error occured
    130. 

  130. 	 * \author Oscar van Eijk, Oveas Functionality Provider
    131. 

  131. 	 */
    132. 

  132. 	public static function parseSQLFile ($fname)
    133. 

  133. 	{
    134. 

  134. 		if (!file_exists($fname)) {
    135. 

  135. 			return null;
    136. 

  136. 		}
    137. 

  137. 		$statement = '';
    138. 

  138. 		$queries = array();
    139. 

  139. 		if (!($_fh = fopen($fname, 'r'))) {
    140. 

  140. 			return null;
    141. 

  141. 		}
    142. 

  142. 		while (($_line = fgets($_fh, 4096)) !== false) {
    143. 

  143. 			$_line = uncommentLine($_line, TT_COMMENT_SQL);
    144. 

  144. 			if (preg_match('/;\s*$/', $_line)) {
    145. 

  145. 				$statement .= (' ' . $_line);
    146. 

  146. 				TTdbg_add(TTDEBUG_TT_S04, $statement, 'SQL statement');
    147. 

  147. 				$queries[] = self::setTablePrefix($statement);
    148. 

  148. 				$statement = '';
    149. 

  149. 			} elseif ($_line == '') {
    150. 

  150. 				continue;
    151. 

  151. 			} else {
    152. 

  152. 				$statement .= (' ' . $_line);
    153. 

  153. 			}
    154. 

  154. 		}
    155. 

  155. 		fclose($_fh);
    156. 

  156. 		return ($queries);
    157. 

  157. 	}
    158. 

  158. 

  159. 	/**
    160. 

  160. 	 * This method adds the tableprefix to all tablenames in an SQL statement as read from the SQL file
    161. 

  161. 	 * \param $statement Complete SQL statements
    162. 

  162. 	 * \return Same SQL statement with tables prefix added
    163. 

  163. 	 * \author Oscar van Eijk, Oveas Functionality Provider
    164. 

  164. 	 */
    165. 

  165. 	private static function setTablePrefix ($statement)
    166. 

  166. 	{
    167. 

  167. 		$_tablePrefix = ConfigHandler::get ('database', 'ttprefix');

    168. 

  168. 		$_checkList = array(

    169. 

  169. 			 '/CREATE\s+(\w+\s+)?(INDEX)\s+(`?\w+`?)\s+([\s\w]+?)?\s*ON\s+(`)?(\w+)(`)?\s+/i' => "CREATE \${1} \${2} \${3} \${4} ON \${5}$_tablePrefix\${6}\${7} "
    170. 

  170. 			,'/DROP\s+TABLE\s+(IF\s+EXISTS\s+)?(`)?(\w+)(`)?/i' => "DROP TABLE \${1} \${2}$_tablePrefix\${3}\${4} "
    171. 

  171. 			,'/CREATE\s+TABLE\s+(IF\s+NOT\s+EXISTS\s+)?(`)?(\w+)(`)?/i' => "CREATE TABLE \${1} \${2}$_tablePrefix\${3}\${4} "
    172. 

  172. 			,'/REFERENCES\s+(`?)(\w+)(`?)\s+/i' => "REFERENCES \${1}$_tablePrefix\${2}\${3} "
    173. 

  173. 			,'/INSERT\s+INTO\s+(`?)(\w+)(`?)\s+/i' => "INSERT INTO \${1}$_tablePrefix\${2}\${3} "
    174. 

  174. 			,'/FROM\s+(`?)(\w+)(`?)\s+/i' => "FROM \${1}$_tablePrefix\${2}\${3} "
    175. 

  175. 		);

    176. 

  176. 		

    177. 

  177. 		foreach ($_checkList as $_pattern => $_replacement) {

    178. 

  178. 			if (preg_match($_pattern, $statement)) {

    179. 

  179. 				$statement = preg_replace($_pattern, $_replacement, $statement);

    180. 

  180. 			}

    181. 

  181. 		}

    182. 

  182. 		return $statement;

    183. 

  183. 	}
    184. 

  184. 	
    185. 

  185. 	/**
    186. 

  186. 	 * Check an SQL statement and look for table names. When a tablename has been found, the
    187. 

  187. 	 * table prefix will be added.
    188. 

  188. 	 *
    189. 

  189. 	 * The following SQL queries are supported by the regular expressions (with and without backticks):
    190. 

  190. 	 * 	- CREATE [TEMPORARY] TABLE [IF NOT EXISTS] `tblname`
    191. 

  191. 	 * 	- ALTER [IGNORE] TABLE `tblname`
    192. 

  192. 	 * 	- DROP [TEMPORARY] TABLE [IF EXISTS] `tblname`
    193. 

  193. 	 * 	- INSERT [insert type] [IGNORE] [INTO] `tblname` (...)
    194. 

  194. 	 * 	- CREATE [type] INDEX [name] [using type] ON `tblname` (...)
    195. 

  195. 	 * \param[in] $q SQL query
    196. 

  196. 	 * \param[in] $prefix Prefix, or null to use the default
    197. 

  197. 	 * \return SQL statement with the prefixed tablename
    198. 

  198. 	 * \todo Add support for UPDATE, DELETE, RENAME and other statements that *might* occur in SQL install files
    199. 

  199. 	 * \todo Add support for other databases (e.g. Oracle, using quotes iso backticks)
    200. 

  200. 	 * \todo Handle constraints ([...] REFERENCES `tblname` (...))
    201. 

  201. 	 * \author Oscar van Eijk, Oveas Functionality Provider
    202. 

  202. 	 * \deprecated setTablePrefix() is used now
    203. 

  203. 	 */
    204. 

  204. 	private static function addTablePrefix ($q, $prefix)
    205. 

  205. 	{
    206. 

  206. 		// Abuse a datahandler to get the proper db handler
    207. 

  207. 		$_d = new DataHandler();
    208. 

  208. 		if ($prefix !== null) {
    209. 

  209. 			$_d->setPrefix($prefix);
    210. 

  210. 		} else {
    211. 

  211. 			$_d->setPrefix(ConfigHandler::get('database', 'prefix', null, true));
    212. 

  212. 		}
    213. 

  213. 		$db = $_d->getDbLink();
    214. 

  214. 		$tblRegEx = '((create|drop|alter)\s+((temporary|ignore)\s+)?(table)(\s*if\s*(not\s*)?(exists))?)';
    215. 

  215. 		$idxRegEx = '((create)\s+((unique|fulltext|spatial)\s+)?((index\s+)([a-z_`]+\s*)(using\s+[a-z]+\s+)?on))';
    216. 

  216. 		$insRegEx = '((insert)(\s*(low_priority|delayed|high_priority))?(\s*ignore\s*)?(\s*into)?)';
    217. 

  217. 

  218. 		$tblName = '\s+`?([a-z_]+)`?\s*';
    219. 

  219. 		$_regexp = "/^\s*($tblRegEx|$idxRegEx|$insRegEx)$tblName/i";
    220. 

  220. 		preg_match ($_regexp, $q, $matches);
    221. 

  221. 		if (count($matches) > 24) {
    222. 

  222. 			$_tblName = $db->tablename($matches[24], true);
    223. 

  223. 			$q = preg_replace("/$matches[24]/", $_tblName, $q);
    224. 

  224. 		}
    225. 

  225. 		return $q;
    226. 

  226. 	}
    227. 

  227. 

  228. 	/**
    229. 

  229. 	 * Execute the queries from a given SQL file to install all tables for this application
    230. 

  230. 	 * \param[in] $sqlFile Full path specification of the file containing SQL statements
    231. 

  231. 	 * \param[in] $prefix Table prefix to add if it's not in the SQL file. Specify 'false' to disable adding the prefix
    232. 

  232. 	 * \return Boolean indicating success (true) or any failure (false)
    233. 

  233. 	 * \author Oscar van Eijk, Oveas Functionality Provider
    234. 

  234. 	 */
    235. 

  235. 	public static function installTables($sqlFile, $prefix = null)
    236. 

  236. 	{
    237. 

  237. 		if (($q = self::parseSQLFile($sqlFile)) === null) {
    238. 

  238. 			trigger_error('Error reading SQL file ' . $sqlFile, E_USER_ERROR);
    239. 

  239. 			return false;
    240. 

  240. 		}
    241. 

  241. 		if (count($q) == 0) {
    242. 

  242. 			return true; // Noting to do
    243. 

  243. 		}
    244. 

  244. 		$db = TT::factory('DbHandler');
    245. 

  245. 		foreach ($q as $_qry) {
    246. 

  246. 			// Fix for the MySQL Workbench bug #63956 (http://bugs.mysql.com/bug.php?id=63956)
    247. 

  247. 			if (preg_match('/^\s*CREATE\s*(.*?)INDEX\s*.?fk\_/i', $_qry)) {

    248. 

  248. 				$_qry = preg_replace('/fk_/', 'fk', $_qry);

    249. 

  249. 			}

    250. 

  250. 			
    251. 

  251. //			if ($prefix !== false) {
    252. 

  252. //				$_qry = self::addTablePrefix($_qry, $prefix);
    253. 

  253. //			}
    254. 

  254. 			TTdbg_add(TTDEBUG_TT_LOOP, $_qry, 'SQL statement');
    255. 

  255. 			
    256. 

  256. 

  257. 			$_logPtrn = '/((create|drop|alter)\s+((temporary|ignore)\s+)?(table)(\s*if\s*(not\s*)?(exists))?)\s+(`)?(\w+)(`)/i';
    258. 

  258. 			if (preg_match($_logPtrn, $_qry, $_m)) {
    259. 

  259. 				OutputHandler::output(ucfirst(strtolower($_m[2])) . ' table ' . $_m[10], TT_OUTPUT_NOW);
    260. 

  260. 			}
    261. 

  261. 				
    262. 

  262. 			$db->setQuery ($_qry);
    263. 

  263. 			$db->write($_dummy, __LINE__, __FILE__);
    264. 

  264. 		}
    265. 

  265. 		return true;
    266. 

  266. 	}
    267. 

  267. 

  268. 	/**
    269. 

  269. 	 * Set the rights bitvalue for a given group
    270. 

  270. 	 * \param[in] $aid Application ID.
    271. 

  271. 	 * \param[in] $grp Group name. This can be an existing TT group
    272. 

  272. 	 * \param[in] $rights Array with right identifiers
    273. 

  273. 	 * \return Boolean indicating success (true) or any failure (false)
    274. 

  274. 	 * \author Oscar van Eijk, Oveas Functionality Provider
    275. 

  275. 	 */
    276. 

  276. 	private static function addGroupRights($aid, $grp, array $rights)
    277. 

  277. 	{
    278. 

  278. 		if (array_key_exists($grp . '__AID__' . $aid, self::$groups)) {
    279. 

  279. 			$_grpID = self::$groups[$grp . '__AID__' . $aid];
    280. 

  280. 		} else {
    281. 

  281. 			if (array_key_exists($grp . '__AID__' . TT_ID, self::$groups)) {
    282. 

  282. 				$_grpID = self::$groups[$grp . '__AID__' . TT_ID];
    283. 

  283. 			} else {
    284. 

  284. 				trigger_error('Group ' . $grp . ' has not been registered yet', E_USER_ERROR);
    285. 

  285. 				return false;
    286. 

  286. 			}
    287. 

  287. 		}
    288. 

  288. 		$_val = 0;
    289. 

  289. 		foreach ($rights as $_r) {
    290. 

  290. 			if (!array_key_exists($_r, self::$rights)) {
    291. 

  291. 				trigger_error('Rightsbit ' . $_r . ' has not been registered yet', E_USER_ERROR);
    292. 

  292. 				return false;
    293. 

  293. 			}
    294. 

  294. 			OutputHandler::output('Adding right ' . $_r . ' to group ' . $grp, TT_OUTPUT_NOW);
    295. 

  295. 			$_val += self::$rights[$_r];
    296. 

  296. 		}
    297. 

  297. 		$dataset = new DataHandler();
    298. 

  298. 		if (ConfigHandler::get ('database', 'tttables', true)) {
    299. 

  299. 			$dataset->setPrefix(ConfigHandler::get ('database', 'ttprefix'));
    300. 

  300. 		}
    301. 

  301. 		$dataset->setTablename('grouprights');
    302. 

  302. 		$dataset->set('aid', $aid);
    303. 

  303. 		$dataset->set('gid', $_grpID);
    304. 

  304. 		$dataset->set('right', $_val);
    305. 

  305. 		$dataset->prepare(DATA_WRITE);
    306. 

  306. 		$dataset->db($_dummy, __LINE__, __FILE__);
    307. 

  307. 		return (true);
    308. 

  308. 	}
    309. 

  309. 

  310. 	/**
    311. 

  311. 	 * Add the application specific groups to the database
    312. 

  312. 	 * \param[in] $aid Application ID
    313. 

  313. 	 * \param[in] $grps Array of groups in the format (groupname => groupdescription)
    314. 

  314. 	 * \return Boolean indicating success (true) or any failure (false)
    315. 

  315. 	 * \author Oscar van Eijk, Oveas Functionality Provider
    316. 

  316. 	 */
    317. 

  317. 	private static function addGroups($aid, array $grps)
    318. 

  318. 	{
    319. 

  319. 		$dataset = new DataHandler();
    320. 

  320. 		if (ConfigHandler::get ('database', 'tttables', true)) {
    321. 

  321. 			$dataset->setPrefix(ConfigHandler::get ('database', 'ttprefix'));
    322. 

  322. 		}
    323. 

  323. 		$dataset->setTablename('group');
    324. 

  324. 		foreach ($grps as $_grp => $_desc) {
    325. 

  325. 			OutputHandler::output('Add group ' . $_grp, TT_OUTPUT_NOW);
    326. 

  326. 			$dataset->set('groupname', $_grp);
    327. 

  327. 			$dataset->set('description', $_desc);
    328. 

  328. 			$dataset->set('aid', $aid);
    329. 

  329. 			$dataset->prepare(DATA_WRITE);
    330. 

  330. 			$dataset->db($_dummy, __LINE__, __FILE__);
    331. 

  331. 			$_id = $dataset->insertedId();
    332. 

  332. 			self::$groups[$_grp . '__AID__' . $aid] = $_id;
    333. 

  333. 		}
    334. 

  334. 		return true;
    335. 

  335. 	}
    336. 

  336. 

  337. 	/**
    338. 

  338. 	 * Add the application specific rights to the database
    339. 

  339. 	 * \param[in] $aid Application ID
    340. 

  340. 	 * \param[in] $rights Array of rights in the format name => description
    341. 

  341. 	 * \return Boolean indicating success (true) or any failure (false)
    342. 

  342. 	 * \author Oscar van Eijk, Oveas Functionality Provider
    343. 

  343. 	 */
    344. 

  344. 	private static function addRights($aid, array $rights)
    345. 

  345. 	{
    346. 

  346. 		$dataset = new DataHandler();
    347. 

  347. 		if (ConfigHandler::get ('database', 'tttables', true)) {
    348. 

  348. 			$dataset->setPrefix(ConfigHandler::get ('database', 'ttprefix'));
    349. 

  349. 		}
    350. 

  350. 		$dataset->setTablename('rights');
    351. 

  351. 		$dataset->set('aid', $aid);
    352. 

  352. 		$dataset->set('rid', null, null
    353. 

  353. 				,array('function' => array('max')
    354. 

  354. 						,'name' => array('rid'))
    355. 

  355. 				,array('match' => array(DBMATCH_NONE))
    356. 

  356. 		);
    357. 

  357. 		$dataset->prepare();
    358. 

  358. 		$dataset->db($_rid, __LINE__, __FILE__);
    359. 

  359. 		if (count($_rid) == 0) {
    360. 

  360. 			$rid = 1;
    361. 

  361. 		} else {
    362. 

  362. 			$rid = $_rid[0]['rid'] + 1;
    363. 

  363. 		}
    364. 

  364. 		$dataset->reset(DATA_RESET_FULL);
    365. 

  365. 

  366. 		foreach ($rights as $_right => $_descr) {
    367. 

  367. 			OutputHandler::output('Create rightsbit ' . $_right, TT_OUTPUT_NOW);
    368. 

  368. 			$dataset->set('rid', $rid);
    369. 

  369. 			$dataset->set('name', $_right);
    370. 

  370. 			$dataset->set('aid', $aid);
    371. 

  371. 			$dataset->set('description', $_descr);
    372. 

  372. 			$dataset->prepare(DATA_WRITE);
    373. 

  373. 			$dataset->db($_dummy, __LINE__, __FILE__);
    374. 

  374. 			self::$rights[$_right] = pow(2, $rid-1);
    375. 

  375. 			$rid++;
    376. 

  376. 		}
    377. 

  377. 		return true;
    378. 

  378. 	}
    379. 

  379. 

  380. 	/**
    381. 

  381. 	 * Add an application specific dynamic config item. It is set or overwritten in the current
    382. 

  382. 	 * configuration immediately.
    383. 

  383. 	 * \param[in] $aid Application ID
    384. 

  384. 	 * \param[in] $section Name of the configuration section
    385. 

  385. 	 * \param[in] $item Name of the configuration item
    386. 

  386. 	 * \param[in] $value Value of the configuration item
    387. 

  387. 	 * \param[in] $protect True if this is a protected item
    388. 

  388. 	 * \param[in] $hide True if this is an hidden item
    389. 

  389. 	 * \param[in] $group An optional groupname to which this item belongs
    390. 

  390. 	 * \return Boolean indicating success (true) or any failure (false)
    391. 

  391. 	 * \author Oscar van Eijk, Oveas Functionality Provider
    392. 

  392. 	 */
    393. 

  393. 	private static function addConfig ($aid, $section, $item, $value, $protect = false, $hide = false, $group = null)
    394. 

  394. 	{
    395. 

  395. 		if ($group === null) {
    396. 

  396. 			$_grpID = 0;
    397. 

  397. 		} else {
    398. 

  398. 			if (array_key_exists($grp . '__AID__' . $aid, self::$groups)) {
    399. 

  399. 				$_grpID = self::$groups[$grp . '__AID__' . $aid];
    400. 

  400. 			} else {
    401. 

  401. 				trigger_error('Group ' . $grp . ' has not been registered yet', E_USER_ERROR);
    402. 

  402. 				return false;
    403. 

  403. 			}
    404. 

  404. 		}
    405. 

  405. 		$dataset = new DataHandler();
    406. 

  406. 		if (ConfigHandler::get ('database', 'tttables', true)) {
    407. 

  407. 			$dataset->setPrefix(ConfigHandler::get ('database', 'ttprefix'));
    408. 

  408. 		}
    409. 

  409. 

  410. 		OutputHandler::output('Set configuration item [' . $section . ']->' . $item . ' with value ' . $value, TT_OUTPUT_NOW);
    411. 

  411. 		$_secId = ConfigHandler::configSection($section, true);
    412. 

  412. 		$dataset->setTablename('config');
    413. 

  413. 		$dataset->set('aid', $aid);
    414. 

  414. 		$dataset->set('gid', $_grpID);
    415. 

  415. 		$dataset->set('uid', 0);
    416. 

  416. 		$dataset->set('sid', $_secId);
    417. 

  417. 		$dataset->set('name', $item);
    418. 

  418. 		$dataset->set('value', $value);
    419. 

  419. 		$dataset->set('protect', ($protect === true)?1:0);
    420. 

  420. 		$dataset->set('hide', ($hide === true)?1:0);
    421. 

  421. 		$dataset->prepare(DATA_WRITE);
    422. 

  422. 		$dataset->db($_dummy, __LINE__, __FILE__);
    423. 

  423. 		ConfigHandler::set($section, $item, $value, true);
    424. 

  424. 		return (true);
    425. 

  425. 	}
    426. 

  426. 

  427. 	/**
    428. 

  428. 	 *Add a user for this application
    429. 

  429. 	 * \param[in] $aid Application ID
    430. 

  430. 	 * \param[in] $username Given username
    431. 

  431. 	 * \param[in] $password Given password
    432. 

  432. 	 * \param[in] $email Given username
    433. 

  433. 	 * \param[in] $group Name of the primary group
    434. 

  434. 	 * \param[in] $memberships Array with groupnames for additional memberships
    435. 

  435. 	 * \return True on success
    436. 

  436. 	 * \note The default group and the additional memberships must be part of the application being installed
    437. 

  437. 	 * If no primary group is given, the new user will be member of the default group from the TT configuration
    438. 

  438. 	 * \author Oscar van Eijk, Oveas Functionality Provider
    439. 

  439. 	 */
    440. 

  440. 	private static function addUser($aid, $username, $password, $email, $group, $memberships = null)
    441. 

  441. 	{
    442. 

  442. 		$grpObj = new Group();
    443. 

  443. 		$group = $grpObj->getGroupByName($group, $aid);
    444. 

  444. 		if (TTInstallerUser::getReference()->registerUser($aid, $username, $password, $email, $group, $memberships) < 0) {
    445. 

  445. 			return false;
    446. 

  446. 		}
    447. 

  447. 		OutputHandler::output('User ' . $username . ' added in group ' . $group, TT_OUTPUT_NOW);
    448. 

  448. 		return true;
    449. 

  449. 	}
    450. 

  450. 	
    451. 

  451. 	/**
    452. 

  452. 	 * Method to install an application using an XML file
    453. 

  453. 	 * \param[in] unknown $xmlFile
    454. 

  454. 	 * \return New application ID or false on failures
    455. 

  455. 	 * \todo Improved error handling, user input, configuration settings, layout, generate .htaccess for the ttadmin directory, logging to browser and a hell of a lot more....
    456. 

  456. 	 */
    457. 

  457. 	public static function installXMLFile($xmlFile)
    458. 

  458. 	{
    459. 

  459. 		TTloader::getClass('xmlhandler', TT_BO_INC);
    460. 

  460. 		
    461. 

  461. 		$xmlInstaller = new XmlHandler($xmlFile);
    462. 

  462. 		$xmlInstaller->parse();
    463. 

  463. 

  464. 		if ($xmlInstaller->childExists('sqlfiles')) {
    465. 

  465. 			// Load the SQL installation script(s)
    466. 

  466. 			for ($_cnt = 0; ($_xmlObj = $xmlInstaller->getNodeByPath("sqlfiles/script,$_cnt")) !== null; $_cnt++) {
    467. 

  467. 				$_xmlData = $xmlInstaller->getNodeData($_xmlObj);
    468. 

  468. 				self::installTables(TT_ROOT . $_xmlData['name'], false);
    469. 

  469. 			}
    470. 

  470. 		}
    471. 

  471. 

  472. 		// Get the application rootnode
    473. 

  473. 		if (($_xmlObj = $xmlInstaller->getNodeByPath()) === null) {
    474. 

  474. 			trigger_error('Error fetching the \'application\' rootnode', E_USER_ERROR);
    475. 

  475. 			return false;
    476. 

  476. 		}
    477. 

  477. 

  478. 		// Check for presence of all required attributes
    479. 

  479. 		$_xmlData = $xmlInstaller->getNodeData($_xmlObj);
    480. 

  480. 		if (!array_key_exists('code', $_xmlData)) {
    481. 

  481. 			trigger_error('application code not set', E_USER_ERROR);
    482. 

  482. 			return false;
    483. 

  483. 		}
    484. 

  484. 		if (!array_key_exists('url', $_xmlData)) {
    485. 

  485. 			trigger_error('application url not set', E_USER_ERROR);
    486. 

  486. 			return false;
    487. 

  487. 		}
    488. 

  488. 		if (!array_key_exists('name', $_xmlData)) {
    489. 

  489. 			trigger_error('application name not set', E_USER_ERROR);
    490. 

  490. 			return false;
    491. 

  491. 		}
    492. 

  492. 		if (!array_key_exists('version', $_xmlData)) {
    493. 

  493. 			trigger_error('application version not set', E_USER_ERROR);
    494. 

  494. 			return false;
    495. 

  495. 		}
    496. 

  496. 

  497. 		// Load the application
    498. 

  498. 		$_applicationID = self::installApplication(
    499. 

  499. 				 $_xmlData['code']
    500. 

  500. 				,$_xmlData['url']
    501. 

  501. 				,$_xmlData['name']
    502. 

  502. 				,$_xmlData['version']
    503. 

  503. 				,array_key_exists('released',$_xmlData) ? $_xmlData['released'] : null
    504. 

  504. 				,array_key_exists('description',$_xmlData) ? $_xmlData['description'] : ''
    505. 

  505. 				,array_key_exists('link',$_xmlData) ? $_xmlData['link'] : ''
    506. 

  506. 				,array_key_exists('author',$_xmlData) ? $_xmlData['author'] : ''
    507. 

  507. 				,array_key_exists('license',$_xmlData) ? $_xmlData['license'] : ''
    508. 

  508. 		);
    509. 

  509. 		
    510. 

  510. 		if ($xmlInstaller->childExists('configuration')) {
    511. 

  511. 			// Load the configuration
    512. 

  512. 			for ($_cntC = 0; ($_xmlObj = $xmlInstaller->getNodeByPath("configuration,$_cntC")) !== null; $_cntC++) {
    513. 

  513. 				// configuration itself has no data, continue with the sections
    514. 

  514. 				for ($_cntS = 0; ($_xmlObj = $xmlInstaller->getNodeByPath("configuration,$_cntC/items,$_cntS")) !== null; $_cntS++) {
    515. 

  515. 					// configuration itself has no data, continue with the sections
    516. 

  516. 					$_xmlData = $xmlInstaller->getNodeData($_xmlObj);
    517. 

  517. 					if (!array_key_exists('section', $_xmlData)) {
    518. 

  518. 						trigger_error("No section name in path 'configuration,$_cntC/items,$_cntS'", E_USER_ERROR);
    519. 

  519. 						return false;
    520. 

  520. 					}
    521. 

  521. 					$_sectionName = $_xmlData['section'];
    522. 

  522. 

  523. 					// Get all items for this section
    524. 

  524. 					for ($_cntI = 0; ($_xmlObj = $xmlInstaller->getNodeByPath("configuration,$_cntC/items,$_cntS/item,$_cntI")) !== null; $_cntI++) {
    525. 

  525. 						$_xmlData = $xmlInstaller->getNodeData($_xmlObj);
    526. 

  526. 						if (!array_key_exists('id', $_xmlData)) {
    527. 

  527. 							trigger_error("No item id in path 'configuration,$_cntC/items,$_cntS'/item,$_cntI", E_USER_ERROR);
    528. 

  528. 							return false;
    529. 

  529. 						}
    530. 

  530. 						// Store this configuration item
    531. 

  531. 						self::addConfig($_applicationID, $_sectionName, $_xmlData[ 'id'], $_xmlData['_TTnodeText']);
    532. 

  532. 					}
    533. 

  533. 				}
    534. 

  534. 			}
    535. 

  535. 		}
    536. 

  536. 

  537. 		if ($xmlInstaller->childExists('rights')) {
    538. 

  538. 			// Get all application rights
    539. 

  539. 			$_rights = array();
    540. 

  540. 			for ($_cntR = 0; ($_xmlObj = $xmlInstaller->getNodeByPath("rights,$_cntR")) !== null; $_cntR++) {
    541. 

  541. 				// rights element itself has no data
    542. 

  542. 				for ($_cntI = 0; ($_xmlObj = $xmlInstaller->getNodeByPath("rights,$_cntR/right,$_cntI")) !== null; $_cntI++) {
    543. 

  543. 					$_xmlData = $xmlInstaller->getNodeData($_xmlObj);
    544. 

  544. 					if (!array_key_exists('id', $_xmlData)) {
    545. 

  545. 						trigger_error("No rights id in path 'rights,$_cntR/right,$_cntI'", E_USER_ERROR);
    546. 

  546. 						return false;
    547. 

  547. 					}
    548. 

  548. 					$_rights[$_xmlData['id']] = $_xmlData['_TTnodeText'];
    549. 

  549. 				}
    550. 

  550. 			}
    551. 

  551. 			// Store the application rights
    552. 

  552. 			self::addRights($_applicationID, $_rights);
    553. 

  553. 		}
    554. 

  554. 

  555. 		if ($xmlInstaller->childExists('groups')) {
    556. 

  556. 			// Create groups
    557. 

  557. 			$_groups = array();
    558. 

  558. 			$_groupRights = array();
    559. 

  559. 			for ($_cntG = 0; ($_xmlObj = $xmlInstaller->getNodeByPath("groups,$_cntG")) !== null; $_cntG++) {
    560. 

  560. 				// group element itself has no data
    561. 

  561. 				for ($_cntN = 0; ($_xmlObj = $xmlInstaller->getNodeByPath("groups,$_cntG/group,$_cntN")) !== null; $_cntN++) {
    562. 

  562. 					// Fetch group data
    563. 

  563. 					$_xmlData = $xmlInstaller->getNodeData($_xmlObj);
    564. 

  564. 					if (!array_key_exists('name', $_xmlData)) {
    565. 

  565. 						trigger_error("No groupname in path 'groups,$_cntG/group,$_cntN'", E_USER_ERROR);
    566. 

  566. 						return false;
    567. 

  567. 					}
    568. 

  568. 					$_groupName = $_xmlData['name'];
    569. 

  569. 					$_groups[$_groupName] = (array_key_exists('description', $_xmlData) ? $_xmlData[ 'description'] : '');
    570. 

  570. 			
    571. 

  571. 					// Continue with the grouprights
    572. 

  572. 					$_grpRights = array();
    573. 

  573. 					for ($_cntI = 0; ($_xmlObj = $xmlInstaller->getNodeByPath("groups,$_cntG/group,$_cntN/right,$_cntI")) !== null; $_cntI++) {
    574. 

  574. 						$_xmlData = $xmlInstaller->getNodeData($_xmlObj);
    575. 

  575. 						// TODO check if the right exists, might be from this XML or an already existing right ID
    576. 

  576. 						$_grpRights[] = $_xmlData['_TTnodeText'];
    577. 

  577. 					}
    578. 

  578. 					// Save the grouprights
    579. 

  579. 					$_groupRights[$_groupName] = $_grpRights;
    580. 

  580. 				}
    581. 

  581. 				self::addGroups($_applicationID, $_groups);
    582. 

  582. 			}
    583. 

  583. 			// Now store the grouprights
    584. 

  584. 			foreach ($_groupRights as $_groupName => $_grpRights) {
    585. 

  585. 				self::addGroupRights($_applicationID, $_groupName, $_grpRights);
    586. 

  586. 			}
    587. 

  587. 		}
    588. 

  588. 

  589. 		if ($xmlInstaller->childExists('users')) {
    590. 

  590. 			// Store the users
    591. 

  591. 			for ($_cntU = 0; ($_xmlObj = $xmlInstaller->getNodeByPath("users,$_cntU")) !== null; $_cntU++) {
    592. 

  592. 				// users element itself has no data
    593. 

  593. 				for ($_cntN = 0; ($_xmlObj = $xmlInstaller->getNodeByPath("users,$_cntU/user,$_cntN")) !== null; $_cntN++) {
    594. 

  594. 					// Fetch user data
    595. 

  595. 					$_xmlData = $xmlInstaller->getNodeData($_xmlObj);
    596. 

  596. 					if (!array_key_exists('name', $_xmlData)) {
    597. 

  597. 						trigger_error("No username in path 'users,$_cntU/user,$_cntN'", E_USER_ERROR);
    598. 

  598. 						return false;
    599. 

  599. 					}
    600. 

  600. 					if (!array_key_exists('group', $_xmlData)) {
    601. 

  601. 						trigger_error("No primary group in path 'groups,$_cntU/user,$_cntN'", E_USER_ERROR);
    602. 

  602. 						return false;
    603. 

  603. 					}
    604. 

  604. 					$_userName = $_xmlData['name'];
    605. 

  605. 					$_userGroup = $_xmlData['group'];
    606. 

  606. 					$_userPassword = (array_key_exists('password', $_xmlData) ? $_xmlData[ 'password'] : '');
    607. 

  607. 					$_userEmail = (array_key_exists('email', $_xmlData) ? $_xmlData[ 'email'] : '');
    608. 

  608. 			
    609. 

  609. 					// Continue with the memberships
    610. 

  610. 					$_memberShips = array();
    611. 

  611. 					for ($_cntM = 0; ($_xmlObj = $xmlInstaller->getNodeByPath("users,$_cntU/user,$_cntN/membership,$_cntM")) !== null; $_cntM++) {
    612. 

  612. 						$_xmlData = $xmlInstaller->getNodeData($_xmlObj);
    613. 

  613. 						// TODO check if the group exists, might be from this XML or an already existing right ID when this installer is generalised
    614. 

  614. 						$_memberShips[] = $_xmlData['_TTnodeText'];
    615. 

  615. 					}
    616. 

  616. 					// Store the users
    617. 

  617. 					self::addUser(
    618. 

  618. 						 $_applicationID
    619. 

  619. 						,$_userName
    620. 

  620. 						,$_userPassword
    621. 

  621. 						,$_userEmail
    622. 

  622. 						,$_userGroup
    623. 

  623. 						,$_memberShips
    624. 

  624. 					);
    625. 

  625. 				}
    626. 

  626. 			}
    627. 

  627. 		}
    628. 

  628. 

  629. 		return $_applicationID;
    630. 

  630. 	}
    631. 

  631. }
    632. 

  632. 

  633. // TT_ROOT must be defined by the application
    634. 

  634. if (!defined('TT_ROOT')) {
    635. 

  635. 	trigger_error('TT_ROOT must be defined by the application', E_USER_ERROR);
    636. 

  636. }
    637. 

  637. 

  638. // Make sure the loader does not attempt to load the application
    639. 

  639. define('TT___INSTALLER', 1);
    640. 

  640. require (TT_ROOT . '/TTloader.php');
    641. 

  641. 

  642. /**
    643. 

  643.  * Helper class to add users during the installation process
    644. 

  644.  * \brief TTInstallerUser User
    645. 

  645.  * \author Oscar van Eijk, Oveas Functionality Provider
    646. 

  646.  * \version Nov 22, 2011 -- O van Eijk -- initial version
    647. 

  647.  */
    648. 

  648. class TTInstallerUser extends User
    649. 

  649. {
    650. 

  650. 	/**
    651. 

  651. 	 * Self reference
    652. 

  652. 	 */
    653. 

  653. 	private static $instance;
    654. 

  654. 

  655. 	/**
    656. 

  656. 	 * Object constructor
    657. 

  657. 	 */
    658. 

  658. 	private function __construct()
    659. 

  659. 	{
    660. 

  660. 		parent::construct();
    661. 

  661. 		TTInstallerUser::$instance = $this;
    662. 

  662. 	}
    663. 

  663. 	/**
    664. 

  664. 	 * Instantiate the singleton or return its reference
    665. 

  665. 	 */
    666. 

  666. 	static public function getReference()
    667. 

  667. 	{
    668. 

  668. 		if (!TTInstallerUser::$instance instanceof TTInstallerUser) {
    669. 

  669. 			TTInstallerUser::$instance = new self();
    670. 

  670. 		}
    671. 

  671. 		return TTInstallerUser::$instance;
    672. 

  672. 	}
    673. 

  673. 

  674. 

  675. 	/**
    676. 

  676. 	 * Register a new username
    677. 

  677. 	 * \param[in] $aid Application ID
    678. 

  678. 	 * \param[in] $username Given username
    679. 

  679. 	 * \param[in] $password Given password
    680. 

  680. 	 * \param[in] $email Given username
    681. 

  681. 	 * \param[in] $group Primary Group
    682. 

  682. 	 * \param[in] $memberships Array with additional memberships
    683. 

  683. 	 * \return New user ID or -1 on failure
    684. 

  684. 	 * \author Oscar van Eijk, Oveas Functionality Provider
    685. 

  685. 	 */
    686. 

  686. 	public function registerUser($aid, $username, $password, $email, $group, $memberships)
    687. 

  687. 	{
    688. 

  688. 		if (($_uid = parent::register($username, $email, $password, $password, $group, false)) < 0) {
    689. 

  689. 			return -1;
    690. 

  690. 		}
    691. 

  691. 		if ($memberships !== null) {
    692. 

  692. 			foreach ($memberships as $_grp) {
    693. 

  693. 				if (parent::addMembership($_grp, $aid, $_uid) === false) {
    694. 

  694. 					; // Ignore failures here
    695. 

  695. 				}
    696. 

  696. 			}
    697. 

  697. 		}
    698. 

  698. 		return $_uid;
    699. 

  699. 	}
    700. 

  700. }
    701. 

  701. 

  702. TTinstaller::construct();
    703. 

  703. if (TTCache::get(TTCACHE_OBJECTS, 'user') === null) {
    704. 

  704. 	TTInstallerUser::getReference(); // Force the user object to exist in cache
    705. 

  705. }
    706. 

  706.