tripal_views.views.inc 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776
  1. <?php
  2. include('views/handlers/views_handler_join_chado_through_linking.inc');
  3. include('views/handlers/views_handler_join_chado_aggregator.inc');
  4. include('tripal_views.api.inc');
  5. // TEMPORARY
  6. include('views/chado_linking.TMP.inc');
  7. /**
  8. * @file
  9. * Tripal Views Integration
  10. *
  11. * @defgroup views Views Integration
  12. * @{
  13. * Provide rules for formatting and composition of fields
  14. * @}
  15. *
  16. * @defgroup views_field_handlers Views Field Handlers
  17. * @{
  18. * Provide rules for formatting and composition of fields
  19. * @}
  20. * @ingroup views
  21. *
  22. * @defgroup views_filter_handlers Views Filter Handlers
  23. * @{
  24. * Provide the ability to filter based on specified data
  25. * @}
  26. * @ingroup views
  27. *
  28. * @defgroup views_sort_handlers Views Sort Handlers
  29. * @{
  30. * Provide methods describing how specific data should be sorted
  31. * @}
  32. * @ingroup views
  33. *
  34. * @defgroup views_argument_handlers Views Arguement Handlers
  35. * @{
  36. * Provide the ability to filter pased on arguments in the path of the view
  37. * @}
  38. * @ingroup views
  39. */
  40. /**
  41. * Implements hook_views_handlers()
  42. *
  43. * Purpose: Register all custom handlers with views
  44. * where a handler describes either "the type of field",
  45. * "how a field should be filtered", "how a field should be sorted"
  46. *
  47. * @return
  48. * An array of handler definitions
  49. *
  50. * @ingroup tripal_views
  51. */
  52. function tripal_views_views_handlers() {
  53. return array(
  54. 'info' => array(
  55. 'path' => drupal_get_path('module', 'tripal_views') . '/views/handlers',
  56. ),
  57. 'handlers' => array(
  58. // Custom Chado Handlers
  59. 'chado_views_handler_field_aggregate' => array(
  60. 'parent' => 'chado_views_handler_field',
  61. ),
  62. 'chado_views_handler_filter_select_cvterm' => array(
  63. 'parent' => 'views_handler_filter_chado_select_cvterm_name',
  64. ),
  65. 'chado_views_handler_filter_select_string' => array(
  66. 'parent' => 'chado_views_handler_filter_string',
  67. ),
  68. // Join Handlers
  69. 'views_handler_join_chado_aggregator' => array(
  70. 'parent' => 'views_join',
  71. ),
  72. 'views_handler_join_chado_through_linking' => array(
  73. 'parent' => 'views_join',
  74. ),
  75. // Other Custom Handlers
  76. 'views_handler_filter_no_results' => array(
  77. 'parent' => 'views_handler_filter'
  78. ),
  79. // Old Handlers (deprecated)
  80. 'views_handler_field_node_optional' => array(
  81. 'parent' => 'views_handler_field_node',
  82. ),
  83. 'views_handler_field_chado_count' => array(
  84. 'parent' => 'views_handler_field',
  85. ),
  86. 'views_handler_field_dbxref_accession_link' => array(
  87. 'parent' => 'views_handler_field',
  88. ),
  89. 'views_handler_field_readable_date' => array(
  90. 'parent' => 'views_handler_field',
  91. ),
  92. // Old handlers with new counterparts (deprecated)
  93. 'views_handler_filter_chado_select_string' => array(
  94. 'parent' => 'views_handler_filter_string',
  95. ),
  96. 'views_handler_filter_chado_select_cvterm_name' => array(
  97. 'parent' => 'views_handler_filter_string',
  98. ),
  99. // Wrappers for Default Views Handlers-----
  100. // Field Handlers
  101. 'chado_views_handler_field' => array(
  102. 'parent' => 'views_handler_field'
  103. ),
  104. 'chado_views_handler_field_boolean' => array(
  105. 'parent' => 'views_handler_field_boolean'
  106. ),
  107. 'chado_views_handler_field_counter' => array(
  108. 'parent' => 'views_handler_field_counter'
  109. ),
  110. 'chado_views_handler_field_custom' => array(
  111. 'parent' => 'views_handler_field_custom'
  112. ),
  113. 'chado_views_handler_field_date' => array(
  114. 'parent' => 'views_handler_field_date'
  115. ),
  116. 'chado_views_handler_field_markup' => array(
  117. 'parent' => 'views_handler_field_markup'
  118. ),
  119. 'chado_views_handler_field_math' => array(
  120. 'parent' => 'views_handler_field_math'
  121. ),
  122. 'chado_views_handler_field_numeric' => array(
  123. 'parent' => 'views_handler_field_numeric'
  124. ),
  125. // Filter Handlers
  126. 'chado_views_handler_filter_string' => array(
  127. 'parent' => 'views_handler_filter_string',
  128. ),
  129. 'chado_views_handler_filter_boolean_operator' => array(
  130. 'parent' => 'views_handler_filter_boolean_operator',
  131. ),
  132. 'chado_views_handler_filter_date' => array(
  133. 'parent' => 'views_handler_filter_date',
  134. ),
  135. 'chado_views_handler_filter_equality' => array(
  136. 'parent' => 'views_handler_filter_equality',
  137. ),
  138. 'chado_views_handler_filter_float' => array(
  139. 'parent' => 'views_handler_filter_float',
  140. ),
  141. 'chado_views_handler_filter_numeric' => array(
  142. 'parent' => 'views_handler_filter_numeric',
  143. ),
  144. 'views_handler_filter_file_upload' => array(
  145. 'parent' => 'views_handler_filter',
  146. ),
  147. // Sort Handlers
  148. 'chado_views_handler_sort' => array(
  149. 'parent' => 'views_handler_sort'
  150. ),
  151. ),
  152. );
  153. }
  154. /**
  155. * Implements hook_views_pre_render
  156. *
  157. * Purpose: Intercepts the view after the query has been executed
  158. * All the results are stored in $view->result
  159. * Looking up the NID here ensures the query is only executed once
  160. * for all stocks in the table.
  161. *
  162. * @todo add if !<chado/drupal same db> around NID portion
  163. *
  164. * @ingroup tripal_views
  165. */
  166. function tripal_views_views_pre_render(&$view) {
  167. //Add Node IDs in to every table that needs them
  168. // @see tripal_views.views.inc
  169. tripal_views_add_node_ids_to_view($view);
  170. // We need to unset the exposed_input for the view so we can repopulate that
  171. // variable. This is necessary if we're using the file_upload_combo
  172. // custom form element which adds the file_path variable to the $_GET after the
  173. // view has populated the $view->exposed_input variable
  174. unset($view->exposed_input);
  175. // we want to add to the bottom of the views the form for downloading
  176. // results in other formats (e.g. Excel, FASTA, CSV, etc.). The Views Data
  177. // Export module provides small images at the bottom, but we want to provide
  178. // a more intutitive interface for getting different file formats
  179. $form = drupal_get_form('tripal_views_data_export_download_form', $view, $display_id, $args);
  180. $view->attachment_after = $form;
  181. }
  182. /**
  183. * Adds nid fields to all pertinent view results
  184. *
  185. * Purpose: To add basetable_nid fields to all result arrays of a view
  186. * only if the basetable_nid field is added. This function will only be
  187. * called if chado/drupal are not in the same database (ie: only if
  188. * a join between the base and node table isn't possible.
  189. *
  190. * Note: Supports adding Node IDs to analysis, feature, library, organism, stock
  191. *
  192. * @param $view
  193. * the view object passed to hook_views_pre_render
  194. *
  195. * @return the views object with nids added to the result array
  196. *
  197. * @ingroup tripal_views
  198. */
  199. function tripal_views_add_node_ids_to_view(&$view) {
  200. //-----Analysis----------------------------------------------
  201. if (!empty($view->field['analysis_nid'])) {
  202. // retrieve the analysis_id for each record in the views current page
  203. $analysis_ids = array();
  204. foreach ($view->result as $row_num => $row) {
  205. if (!empty($row->analysis_id)) {
  206. //we're looking at analysis id field already in table
  207. $analysis_ids[$row_num] = $row->analysis_id;
  208. }
  209. else {
  210. //we're looking at analysis id added by field handler
  211. $analysis_ids[$row_num] = $row->analysis_analysis_id;
  212. }
  213. }
  214. $unique_analysis_ids = array_filter($analysis_ids);
  215. $unique_analysis_ids = array_unique($unique_analysis_ids);
  216. if (!empty($unique_analysis_ids)) {
  217. // Using the list of analysis_ids from the view
  218. // lookup the NIDs from drupal
  219. // and add that to the results of the view
  220. $sql = "SELECT nid, analysis_id FROM {chado_analysis} WHERE analysis_id IN (" . implode(',', $unique_analysis_ids) . ")";
  221. $resource = db_query($sql);
  222. while ($r = db_fetch_object($resource)) {
  223. $keys = array_keys($analysis_ids, $r->analysis_id);
  224. foreach ($keys as $k) {
  225. $view->result[$k]->analysis_nid = $r->nid;
  226. }
  227. }
  228. } // if there are any analysis'
  229. } //end of case for analysis NID
  230. //-----Feature-----------------------------------------------
  231. if (!empty($view->field['feature_nid'])) {
  232. // retrieve the feature_id for each record in the views current page
  233. $feature_ids = array();
  234. foreach ($view->result as $row_num => $row) {
  235. if (!empty($row->feature_id)) {
  236. //we're looking at feature id field already in table
  237. $feature_ids[$row_num] = $row->feature_id;
  238. }
  239. else {
  240. //we're looking at feature id added by field handler
  241. $feature_ids[$row_num] = $row->feature_feature_id;
  242. }
  243. }
  244. $unique_feature_ids = array_filter($feature_ids);
  245. $unique_feature_ids = array_unique($unique_feature_ids);
  246. if (!empty($unique_feature_ids)) {
  247. // Using the list of feature_ids from the view
  248. // lookup the NIDs from drupal
  249. // and add that to the results of the view
  250. $sql = "SELECT nid, feature_id FROM {chado_feature} WHERE feature_id IN (" . implode(',', $unique_feature_ids) . ")";
  251. $resource = db_query($sql);
  252. while ($r = db_fetch_object($resource)) {
  253. $keys = array_keys($feature_ids, $r->feature_id);
  254. foreach ($keys as $k) {
  255. $view->result[$k]->feature_nid = $r->nid;
  256. }
  257. }
  258. } // if there are any features
  259. } //end of case for feature NID
  260. //-----Library-----------------------------------------------
  261. if (!empty($view->field['library_nid'])) {
  262. // retrieve the library_id for each record in the views current page
  263. $library_ids = array();
  264. foreach ($view->result as $row_num => $row) {
  265. if (!empty($row->library_id)) {
  266. //we're looking at library id field already in table
  267. $library_ids[$row_num] = $row->library_id;
  268. }
  269. else {
  270. //we're looking at library id added by field handler
  271. $library_ids[$row_num] = $row->library_library_id;
  272. }
  273. }
  274. $unique_library_ids = array_filter($library_ids);
  275. $unique_library_ids = array_unique($unique_library_ids);
  276. if (!empty($unique_library_ids)) {
  277. // Using the list of library_ids from the view
  278. // lookup the NIDs from drupal
  279. // and add that to the results of the view
  280. $sql = "SELECT nid, library_id FROM {chado_library} WHERE library_id IN (" . implode(',', $unique_library_ids) . ")";
  281. $resource = db_query($sql);
  282. while ($r = db_fetch_object($resource)) {
  283. $keys = array_keys($library_ids, $r->library_id);
  284. foreach ($keys as $k) {
  285. $view->result[$k]->library_nid = $r->nid;
  286. }
  287. }
  288. } // if there are libraries
  289. } //end of case for library NID
  290. //-----Organism----------------------------------------------
  291. if (!empty($view->field['organism_nid'])) {
  292. // retrieve the organism_id for each record in the views current page
  293. $organism_ids = array();
  294. foreach ($view->result as $row_num => $row) {
  295. if (!empty($row->organism_id)) {
  296. //we're looking at organism id field already in table
  297. $organism_ids[$row_num] = $row->organism_id;
  298. }
  299. else {
  300. //we're looking at organism id added by field handler
  301. $organism_ids[$row_num] = $row->organism_organism_id;
  302. }
  303. }
  304. $unique_organism_ids = array_filter($organism_ids);
  305. $unique_organism_ids = array_unique($unique_organism_ids);
  306. if (!empty($unique_organism_ids)) {
  307. // Using the list of organism_ids from the view
  308. // lookup the NIDs from drupal
  309. // and add that to the results of the view
  310. $sql = "SELECT nid, organism_id FROM {chado_organism} WHERE organism_id IN (" . implode(',', $unique_organism_ids) . ")";
  311. $resource = db_query($sql);
  312. while ($r = db_fetch_object($resource)) {
  313. $keys = array_keys($organism_ids, $r->organism_id);
  314. foreach ($keys as $k) {
  315. $view->result[$k]->organism_nid = $r->nid;
  316. }
  317. }
  318. } // if there are organisms
  319. } //end of case for organism NID
  320. //-----Stock-------------------------------------------------
  321. if (!empty($view->field['stock_nid'])) {
  322. // retrieve the stock_id for each record in the views current page
  323. $stock_ids = array();
  324. foreach ($view->result as $row_num => $row) {
  325. if (!empty($row->stock_id)) {
  326. //we're looking at stock id field already in table
  327. $stock_ids[$row_num] = $row->stock_id;
  328. }
  329. else {
  330. //we're looking at stock id added by field handler
  331. $stock_ids[$row_num] = $row->stock_stock_id;
  332. }
  333. }
  334. $unique_stock_ids = array_filter($stock_ids);
  335. $unique_stock_ids = array_unique($unique_stock_ids);
  336. if (!empty($unique_stock_ids)) {
  337. // Using the list of stock_ids from the view
  338. // lookup the NIDs from drupal
  339. // and add that to the results of the view
  340. $sql = "SELECT nid, stock_id FROM {chado_stock} WHERE stock_id IN (" . implode(',', $unique_stock_ids) . ")";
  341. $resource = db_query($sql);
  342. while ($r = db_fetch_object($resource)) {
  343. $keys = array_keys($stock_ids, $r->stock_id);
  344. foreach ($keys as $k) {
  345. $view->result[$k]->stock_nid = $r->nid;
  346. }
  347. }
  348. } //if there are stocks
  349. } //end of case for stock NID
  350. return $view;
  351. }
  352. /**
  353. * Generates a dynamic data array for Views
  354. *
  355. * Purpose: This function is a hook used by the Views module. It populates and
  356. * returns a data array that specifies for the Views module the base table,
  357. * the tables it joins with and handlers. The data array is populated
  358. * using the data stored in the tripal_views tables.
  359. *
  360. * @return a data array formatted for the Views module
  361. *
  362. * @ingroup tripal_views
  363. */
  364. function tripal_views_views_data() {
  365. // Define Global Fields
  366. // Filter handler that lets the admin say:
  367. // "Show no results until they enter search parameters"
  368. $data['views']['search_results'] = array(
  369. 'title' => t('Search Results'),
  370. 'help' => t('Delay results until Apply/Search is clicked by the user.'),
  371. 'filter' => array(
  372. 'handler' => 'views_handler_filter_no_results',
  373. ),
  374. );
  375. $tvi_query = db_query('SELECT * FROM {tripal_views}');
  376. while ($tvi_row = db_fetch_object($tvi_query)) {
  377. // check to see if this is the lightest (drupal-style) priority setup for this table
  378. // if not then don't use this definition
  379. $lightest_priority_setup = tripal_views_is_lightest_priority_setup($tvi_row->setup_id, $tvi_row->table_name);
  380. if (!$lightest_priority_setup) {
  381. continue;
  382. }
  383. // ids we'll use for queries
  384. $setup_id = $tvi_row->setup_id;
  385. $mview_id = $tvi_row->mview_id;
  386. // holds the base table name and fields
  387. $base_table = '';
  388. $base_fields = array();
  389. // indicated whether the current table is a base table or not
  390. $is_base_table = $tvi_row->base_table;
  391. // populate the base table name and fields. If an $mview_id is given
  392. // then get the materialized view info, otherwise get the Chado table info
  393. if ($mview_id) {
  394. // get the base table name from the materialized view
  395. $sql = "SELECT name, mv_specs FROM {tripal_mviews} WHERE mview_id = %d";
  396. $mview_table = db_fetch_object(db_query($sql, $mview_id));
  397. $base_table = $mview_table->name;
  398. // get the columns in this materialized view. They are separated by commas
  399. // where the first word is the column name and the rest is the type
  400. $columns = explode(",", $mview_table->mv_specs);
  401. foreach ($columns as $column) {
  402. $column = trim($column); // trim trailing and leading spaces
  403. preg_match("/^(.*?)\ (.*?)$/", $column, $matches);
  404. $column_name = $matches[1];
  405. $column_type = $matches[2];
  406. $base_fields[$column_name] = array(
  407. 'column_name' => $column_name,
  408. 'type' => $column_type,
  409. );
  410. }
  411. // get the field name and descriptions
  412. $sql = "SELECT * FROM {tripal_views_field} WHERE setup_id=%d";
  413. $query = db_query($sql, $setup_id);
  414. while ($field = db_fetch_object($query)) {
  415. $base_fields[$field->column_name]['name'] = $field->name;
  416. $base_fields[$field->column_name]['help'] = $field->description;
  417. }
  418. }
  419. else {
  420. $base_table = $tvi_row->table_name;
  421. // The chado table could be a regular Chado table or a custom table
  422. // in the chado database. Therefore we'll check both
  423. $table_desc = module_invoke_all('chado_' . $base_table . '_schema');
  424. if (!$table_desc) {
  425. $table_desc = tripal_get_chado_custom_schema($base_table);
  426. }
  427. $fields = $table_desc['fields'];
  428. if (!is_array($fields)) {
  429. $fields = array();
  430. drupal_set_message(t('No fields were described for this table (%table) through the Tripal Schema API.', array('%table' => $base_table)), 'error');
  431. }
  432. foreach ($fields as $column => $attrs) {
  433. $base_fields[$column] = array(
  434. 'column_name' => $column,
  435. 'type' => $attrs['type'],
  436. );
  437. }
  438. // get the field name and descriptions
  439. $sql = "SELECT * FROM {tripal_views_field} WHERE setup_id=%d";
  440. $query = db_query($sql, $setup_id);
  441. while ($field = db_fetch_object($query)) {
  442. $base_fields[$field->column_name]['name'] = $field->name;
  443. $base_fields[$field->column_name]['help'] = $field->description;
  444. }
  445. }
  446. // Setup the base table info in the data array
  447. $data[$base_table]['table']['group'] = t("$tvi_row->name");
  448. if ($is_base_table) {
  449. $data[$base_table]['table']['base'] = array(
  450. 'group' => "$tvi_row->name",
  451. 'title' => "$tvi_row->name",
  452. 'help' => $tvi_row->comment,
  453. );
  454. }
  455. else {
  456. $data[$base_table]['table'] = array(
  457. 'group' => "$tvi_row->name",
  458. 'title' => "$tvi_row->name",
  459. 'help' => $tvi_row->comment,
  460. );
  461. }
  462. // first add the fields
  463. foreach ($base_fields as $column_name => $base_field) {
  464. $data[$base_table][$column_name] = array(
  465. 'title' => t($base_field['name']),
  466. 'help' => t($base_field['help']),
  467. 'field' => array(
  468. 'click sortable' => TRUE,
  469. ),
  470. );
  471. // now add the handlers
  472. $sql = "SELECT * FROM {tripal_views_handlers} WHERE setup_id = %d AND column_name = '%s'";
  473. $handlers = db_query($sql, $setup_id, $column_name);
  474. while ($handler = db_fetch_object($handlers)) {
  475. $data[$base_table][$column_name][$handler->handler_type]['handler'] = $handler->handler_name;
  476. };
  477. }
  478. // now add the joins
  479. $sql = "SELECT * FROM {tripal_views_join} WHERE setup_id = %d";
  480. $joins = db_query($sql, $setup_id);
  481. if (!isset($joins)) {
  482. $joins = array();
  483. }
  484. while ($join = db_fetch_object($joins)) {
  485. $left_table = $join->left_table;
  486. $left_field = $join->left_field;
  487. $base_field = $join->base_field;
  488. $handler = $join->handler;
  489. // add join entry
  490. $data[$base_table]['table']['join'][$left_table] = array(
  491. 'left_field' => $left_field,
  492. 'field' => $base_field,
  493. );
  494. if ($handler) {
  495. $data[$base_table]['table']['join'][$left_table]['handler'] = $handler;
  496. }
  497. // check to see if the join table is one that correlates with Drupal nodes
  498. // if so, there will be a chado_<table_name> table in the Drupal database
  499. // if there is, then we need to add the linking join information
  500. if (db_table_exists("chado_$left_table")) {
  501. // join the mview to the linker table
  502. $data[$base_table]['table']['join']["chado_$left_table"] = array(
  503. 'left_field' => $left_field,
  504. 'field' => $base_field,
  505. );
  506. }
  507. }
  508. }
  509. // TEMPORARY: needed to join chado base tables to node linking tables
  510. // currently done using old-style data arrays
  511. $data = tripal_views_TEMPORARY_chado_linking_data($data);
  512. return $data;
  513. }
  514. /**
  515. *
  516. * @ingroup tripal_views
  517. */
  518. function tripal_views_views_data_alter(&$data) {
  519. $tvi_query = db_query('SELECT * FROM {tripal_views}');
  520. // iterate through the views that we manage
  521. while ($tvi_row = db_fetch_object($tvi_query)) {
  522. //ids we'll use for queries
  523. $mview_id = $tvi_row->mview_id;
  524. $setup_id = $tvi_row->setup_id;
  525. // iterate through the columns and alter the existing data array for
  526. // joins to other tables
  527. $sql = "SELECT * FROM {tripal_views_join} WHERE setup_id = %d";
  528. $joins = db_query($sql, $setup_id);
  529. while ($join = db_fetch_object($joins)) {
  530. $left_table = $join->left_table;
  531. $left_field = $join->left_field;
  532. $base_field = $join->base_field;
  533. $base_table = $join->base_table;
  534. // add the recipricol join entries for each column
  535. if (array_key_exists($left_table, $data)) {
  536. $data[$left_table]['table']['join'][$base_table] = array(
  537. 'left_field' => $base_field,
  538. 'field' => $left_field,
  539. );
  540. }
  541. // check to see if this table is one that correlates with Drupal nodes
  542. // if so, there will be a chado_<table_name> table in the Drupal database
  543. // if there is, then we need to add the linking join information. We did
  544. // this step in the hook_views_data function above, but now we need
  545. // to add the reciprical joins
  546. if (db_table_exists("chado_$left_table")) {
  547. // join the linker table to the mview
  548. if (array_key_exists("chado_$left_table", $data)) {
  549. $data["chado_$left_table"]['table']['join'][$base_table] = array(
  550. 'left_field' => $base_field,
  551. 'field' => $left_field,
  552. );
  553. // Join the node table to the view by way of the chado linker table
  554. $data['node']['table']['join'][$base_table] = array(
  555. 'left_table' => "chado_$left_table",
  556. 'left_field' => 'nid',
  557. 'field' => 'nid',
  558. );
  559. }
  560. }
  561. }
  562. }
  563. return $data;
  564. }
  565. /**
  566. * Implementation of hook_views_plugins().
  567. */
  568. function tripal_views_views_plugins() {
  569. $tc_path = drupal_get_path('module', 'tripal_views');
  570. $style_defaults = array(
  571. 'path' => $tc_path . '/views_data_export/plugins',
  572. 'parent' => 'views_data_export',
  573. 'theme' => 'views_data_export',
  574. 'theme path' => $tc_path . '/views_data_export/theme',
  575. 'theme file' => 'tripal_views_data_export.theme.inc',
  576. 'uses row plugin' => FALSE,
  577. 'uses fields' => TRUE,
  578. 'uses options' => TRUE,
  579. 'type' => 'data_export',
  580. );
  581. // add FASTA format as a new style for the existing views_export_data Display
  582. return array(
  583. 'style' => array(
  584. 'views_data_export_fasta' => array(
  585. 'title' => t('FASTA file'),
  586. 'help' => t('Display results in FASTA format. All fields in results are on the definition line while the feature.residues field must be present .'),
  587. 'handler' => 'tripal_views_plugin_style_export_fasta',
  588. // Views Data Export element that will be used to set additional headers when serving the feed.
  589. 'export headers' => array('Content-type: text/plain; charset=utf-8'),
  590. // Views Data Export element mostly used for creating some additional classes and template names.
  591. 'export feed type' => 'fasta',
  592. 'export feed text' => 'FASTA',
  593. 'export feed file' => '%view.fna',
  594. 'export feed icon' => $tc_path . '/views_data_export/images/fasta.png',
  595. 'additional themes' => array(
  596. 'views_data_export_fasta_header' => 'style',
  597. 'views_data_export_fasta_body' => 'style',
  598. 'views_data_export_fasta_footer' => 'style',
  599. ),
  600. 'additional themes base' => 'views_data_export_fasta',
  601. ) + $style_defaults,
  602. ),
  603. );
  604. }
  605. /**
  606. * Implementation of hook_views_pre_view().
  607. */
  608. function tripal_views_views_pre_view(&$view, &$display_id, &$args) {
  609. // merge the $_GET and $_POST into the $_GET. This is because
  610. // Views and Views Data Export modules only uses the $_GET variable but
  611. // file uploads require $_POST. We need to make sure these two modules
  612. // have access to everything needed for this view to work properlys
  613. $_GET = array_merge($_GET, $_POST);
  614. }
  615. /**
  616. * Implementation of hook_views_pre_build().
  617. */
  618. /* function tripal_views_views_pre_render(&$view, &$display_id, &$args){
  619. // we want to add to the bottom of the views the form for downloading
  620. // results in other formats (e.g. Excel, FASTA, CSV, etc.). The Views Data
  621. // Export module provides small images at the bottom, but we want to provide
  622. // a more intutitive interface for getting different file formats
  623. $form = drupal_get_form('tripal_views_data_export_download_form',$view,$display_id,$args);
  624. $view->attachment_after = $form;
  625. }*/
  626. /**
  627. * the Download Views data export form
  628. */
  629. function tripal_views_data_export_download_form(&$form_state, $view, $display_id, $args) {
  630. $form = array();
  631. $urls = array();
  632. // get any export_data_export displays
  633. $displays = $view->display;
  634. $options = array();
  635. $default = '';
  636. $current_display = $view->current_display;
  637. foreach ($displays as $name => $display) {
  638. if (preg_match("/^views_data_export/", $name)) {
  639. // only add this display to the form if it is attached
  640. $display_options = $display->display_options;
  641. if (strcmp($display_options['displays'][$current_display], $current_display) != 0) {
  642. continue;
  643. }
  644. // set the first item as default
  645. if (!$default) {
  646. $default = $display->id;
  647. }
  648. $path = $display->display_options['path'];
  649. $query = $view->get_exposed_input(); // retrieves elements in $_GET array
  650. $urls[$display->id]['path'] = $path;
  651. $urls[$display->id]['query'] = $query;
  652. // add the new item to the options array
  653. $options[$display->id] = $display->display_title;
  654. }
  655. }
  656. // only generate the form if we have views_data_export displays attached
  657. // to this view
  658. if (count($options) > 0) {
  659. $form_state['storage']['urls'] = $urls;
  660. $form['#cache'] = TRUE;
  661. // we want the form to redirect to a new window
  662. $form['#attributes']['target'] = "_blank";
  663. // now build the form elements
  664. $form['downloads'] = array(
  665. '#type' => 'fieldset',
  666. '#title' => 'Download Results',
  667. '#collapsible' => TRUE,
  668. '#collapsed' => FALSE
  669. );
  670. $form['downloads']['file_type'] = array(
  671. '#title' => t('File format'),
  672. '#type' => 'radios',
  673. '#options' => $options,
  674. '#required' => TRUE,
  675. '#default_value' => $default,
  676. '#description' => t('Please select a file format to download'),
  677. );
  678. $form['downloads']['submit'] = array(
  679. '#value' => t('Download Results'),
  680. '#type' => 'submit',
  681. );
  682. }
  683. return $form;
  684. }
  685. /**
  686. * Submit for the Download Views data export form
  687. */
  688. function tripal_views_data_export_download_form_submit($form, &$form_state) {
  689. $urls = $form_state['storage']['urls'];
  690. $display_id = $form_state['values']['file_type'];
  691. drupal_goto($urls[$display_id]['path'], $urls[$display_id]['query']);
  692. }