tripal_views.views.inc 27 KB

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