tripal_views.views.inc 27 KB

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