export-v2.php 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710
  1. <?php
  2. // Copyright (C) 2015-2016 Combodo SARL
  3. //
  4. // This file is part of iTop.
  5. //
  6. // iTop is free software; you can redistribute it and/or modify
  7. // it under the terms of the GNU Affero General Public License as published by
  8. // the Free Software Foundation, either version 3 of the License, or
  9. // (at your option) any later version.
  10. //
  11. // iTop is distributed in the hope that it will be useful,
  12. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. // GNU Affero General Public License for more details.
  15. //
  16. // You should have received a copy of the GNU Affero General Public License
  17. // along with iTop. If not, see <http://www.gnu.org/licenses/>
  18. /**
  19. * Export data specified by an OQL or a query phrasebook entry
  20. *
  21. * @copyright Copyright (C) 2015-2016 Combodo SARL
  22. * @license http://opensource.org/licenses/AGPL-3.0
  23. */
  24. if (!defined('__DIR__')) define('__DIR__', dirname(__FILE__));
  25. require_once(__DIR__.'/../approot.inc.php');
  26. require_once(APPROOT.'/application/application.inc.php');
  27. require_once(APPROOT.'/application/nicewebpage.class.inc.php');
  28. require_once(APPROOT.'/application/ajaxwebpage.class.inc.php');
  29. require_once(APPROOT.'/application/csvpage.class.inc.php');
  30. require_once(APPROOT.'/application/itopwebpage.class.inc.php');
  31. require_once(APPROOT.'/application/xmlpage.class.inc.php');
  32. require_once(APPROOT.'/application/clipage.class.inc.php');
  33. require_once(APPROOT.'/application/excelexporter.class.inc.php');
  34. require_once(APPROOT.'/core/bulkexport.class.inc.php');
  35. require_once(APPROOT.'/application/startup.inc.php');
  36. function ReportErrorAndExit($sErrorMessage)
  37. {
  38. if (utils::IsModeCLI())
  39. {
  40. $oP = new CLIPage("iTop - Export");
  41. $oP->p('ERROR: '.$sErrorMessage);
  42. $oP->output();
  43. exit -1;
  44. }
  45. else
  46. {
  47. $oP = new WebPage("iTop - Export");
  48. $oP->p('ERROR: '.$sErrorMessage);
  49. $oP->output();
  50. exit -1;
  51. }
  52. }
  53. function ReportErrorAndUsage($sErrorMessage)
  54. {
  55. if (utils::IsModeCLI())
  56. {
  57. $oP = new CLIPage("iTop - Export");
  58. $oP->p('ERROR: '.$sErrorMessage);
  59. Usage($oP);
  60. $oP->output();
  61. exit -1;
  62. }
  63. else
  64. {
  65. $oP = new WebPage("iTop - Export");
  66. $oP->p('ERROR: '.$sErrorMessage);
  67. Usage($oP);
  68. $oP->output();
  69. exit -1;
  70. }
  71. }
  72. function Usage(Page $oP)
  73. {
  74. if (Utils::IsModeCLI())
  75. {
  76. $oP->p('Usage: php '.basename(__FILE__).' --auth_user=<user> --auth_pwd=<password> --expression=<OQL Query> --query=<phrasebook_id> [--arg_xxx=<query_arguments>] [--no_localize=0|1] [--format=<format>] [--format-options...]');
  77. $oP->p("Parameters:");
  78. $oP->p(" * auth_user: the iTop user account for authentication");
  79. $oP->p(" * auth_pwd: the password of the iTop user account");
  80. }
  81. else
  82. {
  83. $oP->p("Parameters:");
  84. }
  85. $oP->p(" * expression: an OQL expression (e.g. SELECT Contact WHERE name LIKE 'm%')");
  86. $oP->p(" * query: (alternative to 'expression') the id of an entry from the query phrasebook");
  87. $oP->p(" * arg_xxx: (needed if the query has parameters) the value of the parameter 'xxx'");
  88. $aSupportedFormats = BulkExport::FindSupportedFormats();
  89. $oP->p(" * format: (optional, default is html) the desired output format. Can be one of '".implode("', '", array_keys($aSupportedFormats))."'");
  90. foreach($aSupportedFormats as $sFormatCode => $sLabel)
  91. {
  92. $oExporter = BulkExport::FindExporter($sFormatCode);
  93. if ($oExporter !== null)
  94. {
  95. if (!Utils::IsModeCLI())
  96. {
  97. $oP->add('<hr/>');
  98. }
  99. $oExporter->DisplayUsage($oP);
  100. if (!Utils::IsModeCLI())
  101. {
  102. $oP->add('</div>');
  103. }
  104. }
  105. }
  106. if (!Utils::IsModeCLI())
  107. {
  108. //$oP->add('</pre>');
  109. }
  110. }
  111. function DisplayExpressionForm(WebPage $oP, $sAction, $sExpression = '', $sExceptionMessage = '')
  112. {
  113. $oP->add('<fieldset><legend>'.Dict::S('Core:BulkExport:ScopeDefinition').'</legend>');
  114. $oP->add('<form id="export-form" action="'.$sAction.'" method="post">');
  115. $oP->add('<input type="hidden" name="interactive" value="1">');
  116. $oP->add('<table style="width:100%" class="export_parameters">');
  117. $sExpressionHint = empty($sExceptionMessage) ? '' : '<tr><td colspan="2">'.htmlentities($sExceptionMessage, ENT_QUOTES, 'UTF-8').'</td></tr>';
  118. $oP->add('<tr><td class="column-label"><span style="white-space: nowrap;"><input type="radio" name="query_mode" value="oql" id="radio_oql" checked><label for="radio_oql">'.Dict::S('Core:BulkExportLabelOQLExpression').'</label></span></td>');
  119. $oP->add('<td><textarea style="width:100%" cols="70" rows="8" name="expression" id="textarea_oql" placeholder="'.Dict::S('Core:BulkExportQueryPlaceholder').'">'.htmlentities($sExpression, ENT_QUOTES, 'UTF-8').'</textarea></td></tr>');
  120. $oP->add($sExpressionHint);
  121. $oP->add('<tr><td class="column-label"><span style="white-space: nowrap;"><input type="radio" name="query_mode" value="phrasebook" id="radio_phrasebook"><label for="radio_phrasebook">'.Dict::S('Core:BulkExportLabelPhrasebookEntry').'</label></span></td>');
  122. $oP->add('<td><select name="query" id="select_phrasebook">');
  123. $oP->add('<option value="">'.Dict::S('UI:SelectOne').'</option>');
  124. $oSearch = DBObjectSearch::FromOQL('SELECT QueryOQL');
  125. $oQueries = new DBObjectSet($oSearch);
  126. while ($oQuery = $oQueries->Fetch())
  127. {
  128. $oP->add('<option value="'.$oQuery->GetKey().'">'.htmlentities($oQuery->Get('name'), ENT_QUOTES, 'UTF-8').'</option>');
  129. }
  130. $oP->add('</select></td></tr>');
  131. $oP->add('<tr><td colspan="2" style="text-align:right"><button type="submit" id="next-btn">'.Dict::S('UI:Button:Next').'</button></td></tr>');
  132. $oP->add('</table>');
  133. $oP->add('</form>');
  134. $oP->add('</fieldset>');
  135. $oP->p('<a target="_blank" href="'.utils::GetAbsoluteUrlAppRoot().'webservices/export-v2.php">'.Dict::S('Core:BulkExportCanRunNonInteractive').'</a>');
  136. $oP->p('<a target="_blank" href="'.utils::GetAbsoluteUrlAppRoot().'webservices/export.php">'.Dict::S('Core:BulkExportLegacyExport').'</a>');
  137. $sJSEmptyOQL = json_encode(Dict::S('Core:BulkExportMessageEmptyOQL'));
  138. $sJSEmptyQueryId = json_encode(Dict::S('Core:BulkExportMessageEmptyPhrasebookEntry'));
  139. $oP->add_ready_script(
  140. <<<EOF
  141. var colWidth = 0;
  142. $('td.column-label').each(function() {
  143. var jLabel = $(this).find('span');
  144. colWidth = Math.max(colWidth, jLabel.width());
  145. });
  146. $('td.column-label').each(function() {
  147. var jLabel = $(this).width(colWidth);
  148. });
  149. $('#textarea_oql').on('change keyup', function() {
  150. $('#radio_oql').prop('checked', true);
  151. });
  152. $('#select_phrasebook').on('change', function() {
  153. $('#radio_phrasebook').prop('checked', true);
  154. });
  155. $('#export-form').on('submit', function() {
  156. if ($('#radio_oql').prop('checked'))
  157. {
  158. var sOQL = $('#textarea_oql').val();
  159. if (sOQL == '')
  160. {
  161. alert($sJSEmptyOQL);
  162. return false;
  163. }
  164. }
  165. else
  166. {
  167. var sQueryId = $('#select_phrasebook').val();
  168. if (sQueryId == '')
  169. {
  170. alert($sJSEmptyQueryId);
  171. return false;
  172. }
  173. }
  174. return true;
  175. });
  176. EOF
  177. );
  178. }
  179. function DisplayForm(WebPage $oP, $sAction = '', $sExpression = '', $sQueryId = '', $sFormat = null)
  180. {
  181. $oExportSearch = null;
  182. $oP->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/tabularfieldsselector.js');
  183. $oP->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery.dragtable.js');
  184. $oP->add_linked_stylesheet(utils::GetAbsoluteUrlAppRoot().'css/dragtable.css');
  185. $oP->add('<form id="export-form" action="'.$sAction.'" method="post" data-state="not-yet-started">');
  186. $bExpressionIsValid = true;
  187. $sExpressionError = '';
  188. if (($sExpression === null) && ($sQueryId === null))
  189. {
  190. $bExpressionIsValid = false;
  191. }
  192. else if ($sExpression !== '')
  193. {
  194. try
  195. {
  196. $oExportSearch = DBObjectSearch::FromOQL($sExpression);
  197. }
  198. catch(OQLException $e)
  199. {
  200. $bExpressionIsValid = false;
  201. $sExpressionError = $e->getMessage();
  202. }
  203. }
  204. if (!$bExpressionIsValid)
  205. {
  206. DisplayExpressionForm($oP, $sAction, $sExpression, $sExpressionError);
  207. return;
  208. }
  209. if ($sExpression !== '')
  210. {
  211. $oP->add('<input type="hidden" name="expression" value="'.htmlentities($sExpression, ENT_QUOTES, 'UTF-8').'">');
  212. $oExportSearch = DBObjectSearch::FromOQL($sExpression);
  213. }
  214. else
  215. {
  216. $oQuery = MetaModel::GetObject('QueryOQL', $sQueryId);
  217. $oExportSearch = DBObjectSearch::FromOQL($oQuery->Get('oql'));
  218. $oP->add('<input type="hidden" name="query" value="'.htmlentities($sQueryId, ENT_QUOTES, 'UTF-8').'">');
  219. }
  220. $aFormPartsByFormat = array();
  221. $aAllFormParts = array();
  222. if ($sFormat == null)
  223. {
  224. // No specific format chosen
  225. $sDefaultFormat = utils::ReadParam('format', 'xlsx');
  226. $oP->add('<p>'.Dict::S('Core:BulkExport:ExportFormatPrompt').' <select name="format" id="format_selector">');
  227. $aSupportedFormats = BulkExport::FindSupportedFormats();
  228. asort($aSupportedFormats);
  229. foreach($aSupportedFormats as $sFormatCode => $sLabel)
  230. {
  231. $sSelected = ($sFormatCode == $sDefaultFormat) ? 'selected' : '';
  232. $oP->add('<option value="'.$sFormatCode.'" '.$sSelected.'>'.htmlentities($sLabel, ENT_QUOTES, 'UTF-8').'</option>');
  233. $oExporter = BulkExport::FindExporter($sFormatCode);
  234. $oExporter->SetObjectList($oExportSearch);
  235. $aParts = $oExporter->EnumFormParts();
  236. foreach($aParts as $sPartId => $void)
  237. {
  238. $aAllFormParts[$sPartId] = $oExporter;
  239. }
  240. $aFormPartsByFormat[$sFormatCode] = array_keys($aParts);
  241. }
  242. $oP->add('</select></p>');
  243. }
  244. else
  245. {
  246. // One specific format was chosen
  247. $oP->add('<input type="hidden" name="format" value="'.htmlentities($sFormat, ENT_QUOTES, 'UTF-8').'">');
  248. $oExporter = BulkExport::FindExporter($sFormat, $oExportSearch);
  249. $aParts = $oExporter->EnumFormParts();
  250. foreach($aParts as $sPartId => $void)
  251. {
  252. $aAllFormParts[$sPartId] = $oExporter;
  253. }
  254. $aFormPartsByFormat[$sFormat] = array_keys($aAllFormParts);
  255. }
  256. foreach($aAllFormParts as $sPartId => $oExport)
  257. {
  258. $oP->add('<div class="form_part" id="form_part_'.$sPartId.'">');
  259. $oExport->DisplayFormPart($oP, $sPartId);
  260. $oP->add('</div>');
  261. }
  262. $oP->add('</form>');
  263. $oP->add('<div id="export-feedback" style="display:none;"><p class="export-message" style="text-align:center;">'.Dict::S('ExcelExport:PreparingExport').'</p><div class="export-progress-bar" style="max-width:30em; margin-left:auto;margin-right:auto;"><div class="export-progress-message" style="text-align:center;"></div></div></div>');
  264. $oP->add('<button type="button" id="export-btn">'.Dict::S('UI:Button:Export').'</button>');
  265. $oP->add('<div id="export_text_result" style="display:none;">');
  266. $oP->add('<div>'.Dict::S('Core:BulkExport:ExportResult').'</div>');
  267. $oP->add('<textarea id="export_content" style="width:100%;min-height:15em;"></textarea>');
  268. $oP->add('</div>');
  269. $sJSParts = json_encode($aFormPartsByFormat);
  270. $sJSCancel = json_encode(Dict::S('UI:Button:Cancel'));
  271. $sJSClose = json_encode(Dict::S('UI:Button:Done'));
  272. $oP->add_ready_script(
  273. <<<EOF
  274. window.aFormParts = $sJSParts;
  275. $('#format_selector').on('change init', function() {
  276. ExportToggleFormat($(this).val());
  277. }).trigger('init');
  278. $('.export-progress-bar').progressbar({
  279. value: 0,
  280. change: function() {
  281. $('.export-progress-message').text( $(this).progressbar( "value" ) + "%" );
  282. },
  283. complete: function() {
  284. $('.export-progress-message').text( '100 %' );
  285. }
  286. });
  287. ExportInitButton('#export-btn');
  288. EOF
  289. );
  290. }
  291. function InteractiveShell($sExpression, $sQueryId, $sFormat, $sFileName, $sMode)
  292. {
  293. if ($sMode == 'dialog')
  294. {
  295. $oP = new ajax_page('');
  296. $oP->add('<div id="interactive_export_dlg">');
  297. $sExportBtnLabel = json_encode(Dict::S('UI:Button:Export'));
  298. $sJSTitle = json_encode(htmlentities(utils::ReadParam('dialog_title', '', false, 'raw_data'), ENT_QUOTES, 'UTF-8'));
  299. $oP->add_ready_script(
  300. <<<EOF
  301. $('#interactive_export_dlg').dialog({
  302. autoOpen: true,
  303. modal: true,
  304. width: '80%',
  305. title: $sJSTitle,
  306. close: function() { $('#export-form').attr('data-state', 'cancelled'); $(this).remove(); },
  307. buttons: [
  308. {text: $sExportBtnLabel, id: 'export-dlg-submit', click: function() {} }
  309. ]
  310. });
  311. setTimeout(function() { $('#interactive_export_dlg').dialog('option', { position: { my: "center", at: "center", of: window }}); $('#export-btn').hide(); ExportInitButton('#export-dlg-submit'); }, 100);
  312. EOF
  313. );
  314. }
  315. else
  316. {
  317. $oP = new iTopWebPage('iTop Export');
  318. $oP->SetBreadCrumbEntry('ui-tool-export', Dict::S('Menu:ExportMenu'), Dict::S('Menu:ExportMenu+'), '', utils::GetAbsoluteUrlAppRoot().'images/wrench.png');
  319. }
  320. if ($sExpression === null)
  321. {
  322. // No expression supplied, let's check if phrasebook entry is given
  323. if ($sQueryId !== null)
  324. {
  325. $oSearch = DBObjectSearch::FromOQL('SELECT QueryOQL WHERE id = :query_id', array('query_id' => $sQueryId));
  326. $oQueries = new DBObjectSet($oSearch);
  327. if ($oQueries->Count() > 0)
  328. {
  329. $oQuery = $oQueries->Fetch();
  330. $sExpression = $oQuery->Get('oql');
  331. $sFields = trim($oQuery->Get('fields'));
  332. }
  333. else
  334. {
  335. ReportErrorAndExit("Invalid query phrasebook identifier: '$sQueryId'");
  336. }
  337. }
  338. else
  339. {
  340. if (utils::IsModeCLI())
  341. {
  342. Usage();
  343. ReportErrorAndExit("No expression or query phrasebook identifier supplied.");
  344. }
  345. else
  346. {
  347. // form to enter an OQL query or pick a query phrasebook identifier
  348. DisplayForm($oP, utils::GetAbsoluteUrlAppRoot().'webservices/export-v2.php', $sExpression, $sQueryId, $sFormat);
  349. $oP->output();
  350. exit;
  351. }
  352. }
  353. }
  354. if ($sFormat !== null)
  355. {
  356. $oExporter = BulkExport::FindExporter($sFormat);
  357. if ($oExporter === null)
  358. {
  359. $aSupportedFormats = BulkExport::FindSupportedFormats();
  360. ReportErrorAndExit("Invalid output format: '$sFormat'. The supported formats are: ".implode(', ', array_keys($aSupportedFormats)));
  361. }
  362. else
  363. {
  364. DisplayForm($oP, utils::GetAbsoluteUrlAppRoot().'webservices/export-v2.php', $sExpression, $sQueryId, $sFormat);
  365. }
  366. }
  367. else
  368. {
  369. DisplayForm($oP, utils::GetAbsoluteUrlAppRoot().'webservices/export-v2.php', $sExpression, $sQueryId, $sFormat);
  370. }
  371. if ($sMode == 'dialog')
  372. {
  373. $oP->add('</div>');
  374. }
  375. $oP->output();
  376. }
  377. /**
  378. * Checks the parameters and returns the appropriate exporter (if any)
  379. * @param string $sExpression The OQL query to export or null
  380. * @param string $sQueryId The entry in the query phrasebook if $sExpression is null
  381. * @param string $sFormat The code of export format: csv, pdf, html, xlsx
  382. * @throws MissingQueryArgument
  383. * @return Ambigous <iBulkExport, NULL>
  384. */
  385. function CheckParameters($sExpression, $sQueryId, $sFormat)
  386. {
  387. $oExporter = null;
  388. if (($sExpression === null) && ($sQueryId === null))
  389. {
  390. ReportErrorAndUsage("Missing parameter. The parameter 'expression' or 'query' must be specified.");
  391. }
  392. // Either $sExpression or $sQueryId must be specified
  393. if ($sExpression === null)
  394. {
  395. $oSearch = DBObjectSearch::FromOQL('SELECT QueryOQL WHERE id = :query_id', array('query_id' => $sQueryId));
  396. $oQueries = new DBObjectSet($oSearch);
  397. if ($oQueries->Count() > 0)
  398. {
  399. $oQuery = $oQueries->Fetch();
  400. $sExpression = $oQuery->Get('oql');
  401. $sFields = $oQuery->Get('fields');
  402. if (strlen($sFields) == 0)
  403. {
  404. $sFields = trim($oQuery->Get('fields'));
  405. }
  406. }
  407. else
  408. {
  409. ReportErrorAndExit("Invalid query phrasebook identifier: '$sQueryId'");
  410. }
  411. }
  412. if ($sFormat === null)
  413. {
  414. ReportErrorAndUsage("Missing parameter 'format'.");
  415. }
  416. // Check if the supplied query is valid (and all the parameters are supplied
  417. try
  418. {
  419. $oSearch = DBObjectSearch::FromOQL($sExpression);
  420. $aArgs = array();
  421. foreach($oSearch->GetQueryParams() as $sParam => $foo)
  422. {
  423. $value = utils::ReadParam('arg_'.$sParam, null, true, 'raw_data');
  424. if (!is_null($value))
  425. {
  426. $aArgs[$sParam] = $value;
  427. }
  428. else
  429. {
  430. throw new MissingQueryArgument("Missing parameter '--arg_$sParam'");
  431. }
  432. }
  433. $oSearch->SetInternalParams($aArgs);
  434. $sFormat = utils::ReadParam('format', 'html', true /* Allow CLI */, 'raw_data');
  435. $oExporter = BulkExport::FindExporter($sFormat, $oSearch);
  436. if ($oExporter == null)
  437. {
  438. $aSupportedFormats = BulkExport::FindSupportedFormats();
  439. ReportErrorAndExit("Invalid output format: '$sFormat'. The supported formats are: ".implode(', ', array_keys($aSupportedFormats)));
  440. }
  441. }
  442. catch(MissingQueryArgument $e)
  443. {
  444. ReportErrorAndUsage("Invalid OQL query: '$sExpression'.\n".$e->getMessage());
  445. }
  446. catch(OQLException $e)
  447. {
  448. ReportErrorAndExit("Invalid OQL query: '$sExpression'.\n".$e->getMessage());
  449. }
  450. catch(Exception $e)
  451. {
  452. ReportErrorAndExit($e->getMessage());
  453. }
  454. $oExporter->SetFormat($sFormat);
  455. $oExporter->SetChunkSize(EXPORTER_DEFAULT_CHUNK_SIZE);
  456. $oExporter->SetObjectList($oSearch);
  457. $oExporter->ReadParameters();
  458. return $oExporter;
  459. }
  460. function DoExport(WebPage $oP, BulkExport $oExporter, $bInteractive = false)
  461. {
  462. $oExporter->SetHttpHeaders($oP);
  463. $exportResult = $oExporter->GetHeader();
  464. $aStatus = array();
  465. do
  466. {
  467. $exportResult .= $oExporter->GetNextChunk($aStatus);
  468. }
  469. while (($aStatus['code'] != 'done') && ($aStatus['code'] != 'error'));
  470. if ($aStatus['code'] == 'error')
  471. {
  472. $oExporter->Cleanup();
  473. ReportErrorAndExit("Export failed: '{$aStatus['message']}'");
  474. }
  475. else
  476. {
  477. $exportResult .= $oExporter->GetFooter();
  478. $sMimeType = $oExporter->GetMimeType();
  479. if (substr($sMimeType, 0, 5) == 'text/')
  480. {
  481. $sMimeType .= ';charset='.strtolower($oExporter->GetCharacterSet());
  482. }
  483. $oP->SetContentType($sMimeType);
  484. $oP->SetContentDisposition('attachment', $oExporter->GetDownloadFileName());
  485. $oP->add($exportResult);
  486. $oExporter->Cleanup();
  487. }
  488. }
  489. /////////////////////////////////////////////////////////////////////////////
  490. //
  491. // Command Line mode
  492. //
  493. /////////////////////////////////////////////////////////////////////////////
  494. if (utils::IsModeCLI())
  495. {
  496. try
  497. {
  498. // Do this before loging, in order to allow setting user credentials from within the file
  499. utils::UseParamFile();
  500. }
  501. catch(Exception $e)
  502. {
  503. echo "Error: ".$e->GetMessage()."<br/>\n";
  504. exit -2;
  505. }
  506. $sAuthUser = utils::ReadParam('auth_user', null, true /* Allow CLI */, 'raw_data');
  507. $sAuthPwd = utils::ReadParam('auth_pwd', null, true /* Allow CLI */, 'raw_data');
  508. if ($sAuthUser == null)
  509. {
  510. ReportErrorAndUsage("Missing parameter '--auth_user'");
  511. }
  512. if ($sAuthPwd == null)
  513. {
  514. ReportErrorAndUsage("Missing parameter '--auth_pwd'");
  515. }
  516. if (UserRights::CheckCredentials($sAuthUser, $sAuthPwd))
  517. {
  518. UserRights::Login($sAuthUser); // Login & set the user's language
  519. }
  520. else
  521. {
  522. ReportErrorAndExit("Access restricted or wrong credentials for user '$sAuthUser'");
  523. }
  524. $sExpression = utils::ReadParam('expression', null, true /* Allow CLI */, 'raw_data');
  525. $sQueryId = utils::ReadParam('query', null, true /* Allow CLI */, 'raw_data');
  526. $bLocalize = (utils::ReadParam('no_localize', 0) != 1);
  527. if (($sExpression == null) && ($sQueryId == null))
  528. {
  529. ReportErrorAndUsage("Missing parameter. At least one of '--expression' or '--query' must be specified.");
  530. }
  531. if ($sExpression === null)
  532. {
  533. $oSearch = DBObjectSearch::FromOQL('SELECT QueryOQL WHERE id = :query_id', array('query_id' => $sQueryId));
  534. $oQueries = new DBObjectSet($oSearch);
  535. if ($oQueries->Count() > 0)
  536. {
  537. $oQuery = $oQueries->Fetch();
  538. $sExpression = $oQuery->Get('oql');
  539. }
  540. else
  541. {
  542. ReportErrorAndExit("Invalid query phrasebook identifier: '$sQueryId'");
  543. }
  544. }
  545. try
  546. {
  547. $oSearch = DBObjectSearch::FromOQL($sExpression);
  548. $aArgs = array();
  549. foreach($oSearch->GetQueryParams() as $sParam => $foo)
  550. {
  551. $value = utils::ReadParam('arg_'.$sParam, null, true, 'raw_data');
  552. if (!is_null($value))
  553. {
  554. $aArgs[$sParam] = $value;
  555. }
  556. else
  557. {
  558. throw new MissingQueryArgument("Missing parameter '--arg_$sParam'");
  559. }
  560. }
  561. $oSearch->SetInternalParams($aArgs);
  562. $sFormat = utils::ReadParam('format', 'html', true /* Allow CLI */, 'raw_data');
  563. $oExporter = BulkExport::FindExporter($sFormat);
  564. if ($oExporter == null)
  565. {
  566. $aSupportedFormats = BulkExport::FindSupportedFormats();
  567. ReportErrorAndExit("Invalid output format: '$sFormat'. The supported formats are: ".implode(', ', array_keys($aSupportedFormats)));
  568. }
  569. $oExporter->SetFormat($sFormat);
  570. $oExporter->SetChunkSize(EXPORTER_DEFAULT_CHUNK_SIZE);
  571. $oExporter->SetObjectList($oSearch);
  572. $oExporter->ReadParameters();
  573. $exportResult = $oExporter->GetHeader();
  574. $aStatus = array();
  575. do
  576. {
  577. $exportResult .= $oExporter->GetNextChunk($aStatus);
  578. }
  579. while (($aStatus['code'] != 'done') && ($aStatus['code'] != 'error'));
  580. if ($aStatus['code'] == 'error')
  581. {
  582. ReportErrorAndExit("Export failed: '{$aStatus['message']}'");
  583. }
  584. else
  585. {
  586. $exportResult .= $oExporter->GetFooter();
  587. echo $exportResult;
  588. }
  589. $oExporter->Cleanup();
  590. }
  591. catch(MissingQueryArgument $e)
  592. {
  593. ReportErrorAndUsage("Invalid OQL query: '$sExpression'.\n".$e->getMessage());
  594. }
  595. catch(OQLException $e)
  596. {
  597. ReportErrorAndExit("Invalid OQL query: '$sExpression'.\n".$e->getMessage());
  598. }
  599. catch(Exception $e)
  600. {
  601. ReportErrorAndExit($e->getMessage());
  602. }
  603. exit;
  604. }
  605. /////////////////////////////////////////////////////////////////////////////
  606. //
  607. // Web Server mode
  608. //
  609. /////////////////////////////////////////////////////////////////////////////
  610. try
  611. {
  612. require_once(APPROOT.'/application/loginwebpage.class.inc.php');
  613. // Main parameters
  614. $sExpression = utils::ReadParam('expression', null, true /* Allow CLI */, 'raw_data');
  615. $sQueryId = utils::ReadParam('query', null, true /* Allow CLI */, 'raw_data');
  616. $sFormat = utils::ReadParam('format', null, true /* Allow CLI */);
  617. $sFileName = utils::ReadParam('filename', '', true, 'string');
  618. $bInteractive = utils::ReadParam('interactive', false);
  619. $sMode = utils::ReadParam('mode', '');
  620. LoginWebPage::DoLogin(); // Check user rights and prompt if needed
  621. ApplicationContext::SetUrlMakerClass('iTopStandardURLMaker');
  622. if ($bInteractive)
  623. {
  624. InteractiveShell($sExpression, $sQueryId, $sFormat, $sFileName, $sMode);
  625. }
  626. else
  627. {
  628. $oExporter = CheckParameters($sExpression, $sQueryId, $sFormat);
  629. $sMimeType = $oExporter->GetMimeType();
  630. if ($sMimeType == 'text/html')
  631. {
  632. $oP = new NiceWebPage('iTop export');
  633. $oP->add_style("body { overflow: auto; }");
  634. $oP->add_ready_script("$('table.listResults').tablesorter({widgets: ['MyZebra']});");
  635. }
  636. else
  637. {
  638. $oP = new ajax_page('iTop export');
  639. $oP->SetContentType($oExporter->GetMimeType());
  640. }
  641. DoExport($oP, $oExporter, false);
  642. $oP->output();
  643. }
  644. }
  645. catch (BulkExportMissingParameterException $e)
  646. {
  647. $oP = new ajax_page('iTop Export');
  648. $oP->add($e->getMessage());
  649. Usage($oP);
  650. $oP->output();
  651. }
  652. catch (Exception $e)
  653. {
  654. $oP = new WebPage('iTop Export');
  655. $oP->add('Error: '.$e->getMessage());
  656. IssueLog::Error($e->getMessage()."\n".$e->getTraceAsString());
  657. $oP->output();
  658. }