tripal_core.install 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177
  1. <?php
  2. /************************************************************************
  3. * Implementation of hook_install();
  4. *
  5. * @ingroup tripal_core
  6. */
  7. function tripal_core_install(){
  8. // make the data directory for this module
  9. $data_dir = file_directory_path() . "/tripal";
  10. if(!file_check_directory($data_dir,FILE_CREATE_DIRECTORY)){
  11. $message = "Cannot create directory $data_dir. This module may not ".
  12. "behave correctly without this directory. Please create ".
  13. "the directory manually or fix the problem and reinstall.";
  14. drupal_set_message($message,'error');
  15. watchdog('tripal_core',$message,array(),WATCHDOG_ERROR);
  16. }
  17. // create the tables that manage materialized views and jobs
  18. drupal_install_schema('tripal_core');
  19. }
  20. /**
  21. * Update for Drupal 6.x, Tripal 0.4
  22. * This update adjusts the materialized view by adding a 'cvterm_id' column
  23. *
  24. * @ingroup tripal_feature
  25. */
  26. function tripal_core_update_6000(){
  27. // recreate the materialized view
  28. db_add_field($ret, 'tripal_mviews', 'status', array('type' => 'text', 'size' => 'normal', 'not null' => FALSE));
  29. db_add_field($ret, 'tripal_mviews', 'comment', array('type' => 'text', 'size' => 'normal', 'not null' => FALSE));
  30. // create the custom tables table
  31. $ret = array();
  32. $schema = tripal_core_custom_tables_schema();
  33. db_create_table($ret,'tripal_custom_tables',$schema['tripal_custom_tables']);
  34. $ret = array(
  35. '#finished' => 1,
  36. );
  37. return $ret;
  38. }
  39. /************************************************************************
  40. * Implementation of hook_schema().
  41. *
  42. * @ingroup tripal_core
  43. */
  44. function tripal_core_schema() {
  45. $schema = tripal_core_get_schemas();
  46. return $schema;
  47. }
  48. /************************************************************************
  49. * Implementation of hook_uninstall()
  50. *
  51. * @ingroup tripal_core
  52. */
  53. function tripal_core_uninstall(){
  54. drupal_uninstall_schema('tripal_core');
  55. }
  56. /************************************************************************
  57. * This function simply defines all tables needed for the module to work
  58. * correctly. By putting the table definitions in a separate function we
  59. * can easily provide the entire list for hook_install or individual
  60. * tables for an update.
  61. *
  62. * @ingroup tripal_core
  63. */
  64. function tripal_core_get_schemas (){
  65. $schema = array();
  66. // get all the various schema parts and join them together
  67. $temp = tripal_core_jobs_schema();
  68. foreach ($temp as $table => $arr){
  69. $schema[$table] = $arr;
  70. }
  71. $temp = tripal_core_mviews_schema();
  72. foreach ($temp as $table => $arr){
  73. $schema[$table] = $arr;
  74. }
  75. $temp = tripal_core_custom_tables_schema();
  76. foreach ($temp as $table => $arr){
  77. $schema[$table] = $arr;
  78. }
  79. return $schema;
  80. }
  81. /************************************************************************
  82. *
  83. *
  84. * @ingroup tripal_core
  85. */
  86. function tripal_core_mviews_schema(){
  87. $schema = array();
  88. $schema['tripal_mviews'] = array(
  89. 'fields' => array(
  90. 'mview_id' => array('type' => 'serial', 'unsigned' => TRUE, 'not null' => TRUE),
  91. 'name' => array('type' => 'varchar','length' => 255, 'not null' => TRUE),
  92. 'modulename' => array('type' => 'varchar','length' => 50, 'not null' => TRUE, 'description' => 'The module name that provides the callback for this job'),
  93. 'mv_table' => array('type' => 'varchar','length' => 128, 'not null' => TRUE),
  94. 'mv_specs' => array('type' => 'text', 'size' => 'normal', 'not null' => TRUE),
  95. 'indexed' => array('type' => 'text', 'size' => 'normal', 'not null' => TRUE),
  96. 'query' => array('type' => 'text', 'size' => 'normal', 'not null' => TRUE),
  97. 'special_index' => array('type' => 'text', 'size' => 'normal', 'not null' => FALSE),
  98. 'last_update' => array('type' => 'int', 'not null' => FALSE, 'description' => 'UNIX integer time'),
  99. 'status' => array('type' => 'text', 'size' => 'normal', 'not null' => FALSE),
  100. 'comment' => array('type' => 'text', 'size' => 'normal', 'not null' => FALSE),
  101. ),
  102. 'indexes' => array(
  103. 'mview_id' => array('mview_id')
  104. ),
  105. 'unique keys' => array(
  106. 'mv_table' => array('mv_table'),
  107. 'mv_name' => array('name'),
  108. ),
  109. 'primary key' => array('mview_id'),
  110. );
  111. return $schema;
  112. }
  113. /************************************************************************
  114. *
  115. *
  116. * @ingroup tripal_core
  117. */
  118. function tripal_core_jobs_schema(){
  119. $schema = array();
  120. $schema['tripal_jobs'] = array(
  121. 'fields' => array(
  122. 'job_id' => array('type' => 'serial', 'unsigned' => TRUE, 'not null' => TRUE),
  123. 'uid' => array ('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE, 'description' => 'The Drupal userid of the submitee'),
  124. 'job_name' => array('type' => 'varchar','length' => 255, 'not null' => TRUE),
  125. 'modulename' => array('type' => 'varchar','length' => 50, 'not null' => TRUE, 'description' => 'The module name that provides the callback for this job'),
  126. 'callback' => array('type' => 'varchar','length' => 255, 'not null' => TRUE),
  127. 'arguments' => array('type' => 'text', 'size' => 'normal', 'not null' => FALSE),
  128. 'progress' => array('type' => 'int', 'unsigned' => TRUE, 'default' => 0, 'not null' => FALSE, 'description' => 'a value from 0 to 100 indicating percent complete'),
  129. 'status' => array('type' => 'varchar','length' => 50, 'not null' => TRUE),
  130. 'submit_date' => array ('type' => 'int', 'not null' => TRUE, 'description' => 'UNIX integer submit time'),
  131. 'start_time' => array ('type' => 'int', 'not null' => FALSE, 'description' => 'UNIX integer start time'),
  132. 'end_time' => array ('type' => 'int', 'not null' => FALSE, 'description' => 'UNIX integer end time'),
  133. 'error_msg' => array('type' => 'text','size' => 'normal', 'not null' => FALSE),
  134. 'pid' => array ('type' => 'int', 'unsigned' => TRUE, 'not null' => FALSE, 'description' => 'The process id for the job'),
  135. 'priority' => array ('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE, 'default' => '0', 'description' => 'The job priority'),
  136. 'mlock' => array ('type' => 'int', 'unsigned' => TRUE, 'not null' => FALSE, 'description' => 'If set to 1 then all jobs for the module are held until this one finishes'),
  137. 'lock' => array ('type' => 'int', 'unsigned' => TRUE, 'not null' => FALSE, 'description' => 'If set to 1 then all jobs are held until this one finishes'),
  138. ),
  139. 'indexes' => array(
  140. 'job_id' => array('job_id'),
  141. 'job_name' => array('job_name')
  142. ),
  143. 'primary key' => array('job_id'),
  144. );
  145. return $schema;
  146. }
  147. /************************************************************************
  148. *
  149. *
  150. * @ingroup tripal_core
  151. */
  152. function tripal_core_custom_tables_schema(){
  153. $schema = array();
  154. $schema['tripal_custom_tables'] = array(
  155. 'fields' => array(
  156. 'table_id' => array('type' => 'serial', 'unsigned' => TRUE, 'not null' => TRUE),
  157. 'table_name' => array ('type' => 'varchar', 'length' => 255, 'not null' => TRUE),
  158. 'schema' => array('type' => 'text','not null' => TRUE),
  159. ),
  160. 'indexes' => array(
  161. 'table_id' => array('table_id'),
  162. ),
  163. 'primary key' => array('table_id'),
  164. );
  165. return $schema;
  166. }
  167. ?>