tripal_views.views.inc 27 KB

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