tripal_cv.api.inc 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862
  1. <?php
  2. /**
  3. * @file
  4. * Controlled Vocabulary API
  5. *
  6. * @defgroup tripal_cv_api CV Module API
  7. * @ingroup tripal_api
  8. * This module provides a set of functions to simplify working with
  9. * controlled vocabularies. Most of the API functions deal with retrieving
  10. * terms or their parent vocabularies.
  11. *
  12. * However, the API also supports
  13. * generation of trees for browsing a vocabulary as well as generation of
  14. * pie graphs for display of hierarchical counts of terms. Version 0.3b of
  15. * Tripal provides a feature browser and a feature summary chart uses
  16. * the API functions provided here. But in general charts and trees can be
  17. * created for any controlled vocabulary.
  18. *
  19. */
  20. /**
  21. * Purpose: To retrieve a chado controlled vocabulary object
  22. *
  23. * @param $select_values
  24. * An array meant to uniquely select a given controlled vocabulary
  25. *
  26. * @return
  27. * Chado controlled vocabulary object
  28. *
  29. * The controlled vocabulary is selected using tripal_core_chado select and as such the
  30. * $select_values array parameter meant to uniquely identify the controlled vocab to be
  31. * returned follows the same form as when using tripal_core_chado_select directly.
  32. *
  33. * Example Usage:
  34. * @code
  35. $select_values = array(
  36. 'name' => 'feature_property'
  37. );
  38. $cv_object = tripal_cv_get_cv($select_values);
  39. * @endcode
  40. * The above code selects the feature_property cv and returns the following object:
  41. * @code
  42. $cv_object = stdClass Object (
  43. [cv_id] => 13
  44. [name] => feature_property
  45. [definition] =>
  46. );
  47. * @endcode
  48. *
  49. * @ingroup tripal_cv_api
  50. */
  51. function tripal_cv_get_cv($select_values) {
  52. $columns = array(
  53. 'cv_id',
  54. 'name',
  55. 'definition',
  56. );
  57. $results = tripal_core_chado_select('cv', $columns, $select_values);
  58. if (sizeof($results) == 1) {
  59. return $results[0];
  60. }
  61. elseif (empty($results)) {
  62. watchdog('tripal_cv',
  63. 'tripal_cv_get_cv: No cv matches criteria values:%values',
  64. array('%values' => print_r($select_values, TRUE)),
  65. WATCHDOG_WARNING
  66. );
  67. return FALSE;
  68. }
  69. else {
  70. watchdog('tripal_cv',
  71. 'tripal_cv_get_cv: 2+ cvs match criteria values:%values',
  72. array('%values' => print_r($select_values, TRUE)),
  73. WATCHDOG_WARNING
  74. );
  75. }
  76. }
  77. // Purpose: To retrieve a chado cv object
  78. // @param $where_options
  79. // @code
  80. // array(
  81. // <column_name> => array(
  82. // 'type' => <type of column: INT/STRING>,
  83. // 'value' => <the vlaue you want to filter on>,
  84. // 'exact' => <if TRUE use =; if FALSE use ~>,
  85. // )
  86. // )
  87. // @endcode
  88. //
  89. // @return
  90. // Chado cv object with all fields from the chado cv table
  91. //
  92. // @ingroup tripal_cv_api
  93. //
  94. //function tripal_cv_get_cv ($where_options)
  95. /**
  96. * Retrieve a cv given the cv name
  97. *
  98. * @param $name
  99. * The name of the cv to be returned
  100. * @return
  101. * The cv object for the specified CV name
  102. *
  103. * @ingroup tripal_cv_api
  104. */
  105. function tripal_cv_get_cv_by_name($name) {
  106. $r = tripal_core_chado_select('cv', array('*'), array('name' => $name));
  107. return $r[0];
  108. }
  109. /**
  110. * Retrieve the cv object for the specified CV id
  111. *
  112. * NOTE: This function is deprecated.
  113. * @see tripal_core_chado_generate_vars()
  114. *
  115. * @param $cv_id
  116. * The unique identifier for the cv to retrieve
  117. *
  118. * @return
  119. * An object describing the cv
  120. *
  121. * @ingroup tripal_cv_api
  122. */
  123. function tripal_cv_get_cv_by_id($cv_id) {
  124. $r = tripal_core_chado_select('cv', array('*'), array('cv_id' => $cv_id));
  125. return $r;
  126. }
  127. /**
  128. * Retrieve the cv id for the specified CV by name
  129. *
  130. * NOTE: This function is deprecated.
  131. * @see tripal_core_chado_generate_vars()
  132. *
  133. * @param $cv_name
  134. * The unique name for the cv to retrieve
  135. *
  136. * @return
  137. * The numeric cv ID
  138. *
  139. * @ingroup tripal_cv_api
  140. */
  141. function tripal_cv_get_cv_id($cv_name) {
  142. $sql = "SELECT cv_id FROM {cv} WHERE name = :name";
  143. $cv = chado_query($sql, array(':name' => $cv_name))->fetchObject();
  144. return $cv->cv_id;
  145. }
  146. /**
  147. * Create an options array to be used in a form element which provides a
  148. * list of all chado cvs
  149. *
  150. * NOTE: This function is deprecated as of Tripal v1.0
  151. *
  152. * @return
  153. * An array(cv_id => name) for each cv in the chado cv table
  154. *
  155. * @ingroup tripal_cv_api
  156. */
  157. function tripal_cv_get_cv_options() {
  158. $results = tripal_core_chado_select('cv', array('cv_id', 'name'), array());
  159. $options = array();
  160. foreach ($results as $r) {
  161. $options[$r->cv_id] = $r->name;
  162. }
  163. return $options;
  164. }
  165. /**
  166. * Retrieve a chado cvterm object with a given name
  167. *
  168. * @param $cvterm_id
  169. * the cvterm.cvterm_id
  170. *
  171. * @return
  172. * cvterm array or FALSE on error
  173. *
  174. * @ingroup tripal_cv_api
  175. */
  176. function tripal_cv_get_cvterm_by_id($cvterm_id) {
  177. if (!is_numeric($cvterm_id)) {
  178. return FALSE;
  179. }
  180. $values = array('cvterm_id' => $cvterm_id);
  181. $options = array('statement_name' => 'sel_cvterm_id');
  182. $r = tripal_core_chado_select('cvterm', array('*'), $values, $options);
  183. if (!$r) {
  184. return FALSE;
  185. }
  186. return $r[0];
  187. }
  188. /**
  189. * Retrieve a chado cvterm object with a given name
  190. *
  191. * @param $name
  192. * the cvterm.name
  193. * @param $cv_id
  194. * the cv_id of the term you are looking for
  195. * @param $cv_name
  196. * the name of the CV
  197. *
  198. * @return
  199. * cvterm array or FALSE on error
  200. *
  201. * @ingroup tripal_cv_api
  202. */
  203. function tripal_cv_get_cvterm_by_name($name, $cv_id = NULL, $cv_name = 'tripal') {
  204. if ($cv_id) {
  205. $values = array(
  206. 'name' => $name,
  207. 'cv_id' => $cv_id,
  208. );
  209. $options = array(
  210. 'case_insensitive_columns' => array('name')
  211. );
  212. $r = tripal_core_chado_select('cvterm', array('*'), $values, $options);
  213. }
  214. elseif ($cv_name) {
  215. $values = array(
  216. 'name' => $name,
  217. 'cv_id' => array(
  218. 'name' => $cv_name,
  219. ),
  220. );
  221. $options = array('case_insensitive_columns' => array('name'));
  222. $r = tripal_core_chado_select('cvterm', array('*'), $values, $options);
  223. }
  224. else {
  225. $values = array('name' => $name);
  226. $options = array('case_insensitive_columns' => array('name'));
  227. $r = tripal_core_chado_select('cvterm', array('*'), $values, $options);
  228. }
  229. if (!$r) {
  230. return FALSE;
  231. }
  232. if (count($r) > 1) {
  233. watchdog('tripal_cv', "Cannot find a unique term for the term '%name' in the vocabulary '%cv'. Multiple entries exist for this name",
  234. array('%name' => $name, '%cv' => $cv_name ? $cv_name : $cv_id), WATCHDOG_ERROR);
  235. return FALSE;
  236. }
  237. if (count($r) == 0) {
  238. return FALSE;
  239. }
  240. return $r[0];
  241. }
  242. /**
  243. * Retrieve a chado cvterm object with a given name
  244. *
  245. * @param $synonym
  246. * the synonym of the term
  247. * @param $cv_id
  248. * the cv_id of the term you are looking for
  249. * @param $cv_name
  250. * the name of the CV
  251. *
  252. * @return
  253. * cvterm object
  254. *
  255. * @ingroup tripal_cv_api
  256. */
  257. function tripal_cv_get_cvterm_by_synonym($synonym, $cv_id = NULL, $cv_name = 'tripal') {
  258. // first find the CVTerm synonym
  259. $values = array(
  260. 'synonym' => $synonym,
  261. );
  262. $statement = "sel_cvtermsynonym_sy";
  263. if ($cv_id) {
  264. $values['cvterm_id'] = array('cv_id' => $cv_id);
  265. $statement = "sel_cvtermsynonym_sycv";
  266. }
  267. if ($cv_name) {
  268. $values['cvterm_id'] = array('cv_id' => array('name' => $cv_name));
  269. $statement = "sel_cvtermsynonym_sycv";
  270. }
  271. $options = array(
  272. 'statement_name' => $statement,
  273. 'case_insensitive_columns' => array('name')
  274. );
  275. $synonym = tripal_core_chado_select('cvtermsynonym', array('cvterm_id'), $values, $options);
  276. // if the synonym doens't exist or more than one record is returned then return false
  277. if (count($synonym) == 0) {
  278. return FALSE;
  279. }
  280. if (count($synonym) > 1) {
  281. return FALSE;
  282. }
  283. // get the cvterm
  284. $values = array('cvterm_id' => $synonym[0]->cvterm_id);
  285. $options = array('statement_name' => 'sel_cvterm_id');
  286. $cvterm = tripal_core_chado_select('cvterm', array('*'), $values, $options);
  287. return $cvterm[0];
  288. }
  289. /**
  290. * Create an options array to be used in a form element
  291. * which provides a list of all chado cvterms
  292. *
  293. * @param $cv_id
  294. * The chado cv_id;
  295. * only cvterms with the supplied cv_id will be returned
  296. * @return
  297. * An array(cvterm_id => name)
  298. * for each cvterm in the chado cvterm table where cv_id=that supplied
  299. *
  300. * @ingroup tripal_cv_api
  301. */
  302. function tripal_cv_get_cvterm_options($cv_id = 0) {
  303. if ($cv_id > 0) {
  304. $results = tripal_core_chado_select('cvterm', array('cvterm_id', 'name'), array('cv_id' => $cv_id));
  305. }
  306. else {
  307. $results = tripal_core_chado_select('cvterm', array('cvterm_id', 'name'), array());
  308. }
  309. $options = array();
  310. foreach ($results as $r) {
  311. $options[$r->cvterm_id] = $r->name;
  312. }
  313. return $options;
  314. }
  315. /**
  316. * Updates the cvtermpath table of Chado for the specified CV.
  317. *
  318. * @param $cv_id
  319. * The chado cv_id;
  320. * @param $job_id
  321. * This function is intended to be used with the Tripal Jobs API.
  322. * When this function is called as a job the $job_id is automatically
  323. * passed to this function.
  324. * @return
  325. * TRUE on success FALSE on failure
  326. *
  327. * @ingroup tripal_cv_api
  328. */
  329. function tripal_cv_update_cvtermpath($cvid, $job_id = NULL) {
  330. // TODO: need better error checking in this function
  331. // first get the controlled vocabulary name:
  332. $sql = "SELECT * FROM {cv} WHERE cv_id = :cv_id";
  333. $cv = chado_query($sql, array(':cv_id' => $cvid))->fetchObject();
  334. print "\nUpdating cvtermpath for $cv->name...\n";
  335. $previous = tripal_db_set_active('chado');
  336. try {
  337. $sql = "SELECT * FROM fill_cvtermpath(:name)";
  338. db_query($sql, array(':name' => $cv->name));
  339. tripal_db_set_active($previous);
  340. }
  341. catch (Exception $e) {
  342. tripal_db_set_active($previous);
  343. $error = $e->getMessage();
  344. watchdog('tripal_cv', "Could not fill cvtermpath table: @error", array('@error' => $error), WATCHDOG_ERROR);
  345. return FALSE;
  346. }
  347. return TRUE;
  348. }
  349. /**
  350. * Adds a controlled vocabular to the CV table of Chado.
  351. *
  352. * @param $name
  353. * The name of the controlled vocabulary. These are typically all lower case
  354. * with no special characters other than an undrescore (for spaces).
  355. * @param $comment
  356. * A description or definition of the vocabulary.
  357. *
  358. * @return
  359. * An object populated with fields from the newly added database.
  360. *
  361. * @ingroup tripal_cv_api
  362. */
  363. function tripal_cv_add_cv($name, $definition) {
  364. // insert/update values
  365. $ins_values = array(
  366. 'name' => $name,
  367. 'definition' => $definition
  368. );
  369. // see if the CV (default-namespace) exists already in the database
  370. $sel_values = array('name' => $name);
  371. $sel_options = array('statement_name' => 'sel_cv_na');
  372. $results = tripal_core_chado_select('cv', array('*'), $sel_values, $sel_options);
  373. // if it does not exists then add it
  374. if (count($results) == 0) {
  375. $ins_options = array('statement_name' => 'ins_cv_nade');
  376. $success = tripal_core_chado_insert('cv', $ins_values, $ins_options);
  377. if (!$success) {
  378. watchdog('tripal_cv', "Failed to create the CV record", NULL, WATCHDOG_WARNING);
  379. return FALSE;
  380. }
  381. $results = tripal_core_chado_select('cv', array('*'), $sel_values, $sel_options);
  382. }
  383. // if it already exists then do an update
  384. else {
  385. $upd_options = array('statement_name' => 'upd_cv_nade');
  386. $success = tripal_core_chado_update('cv', $sel_values, $ins_values, $upd_options);
  387. if (!$success) {
  388. watchdog('tripal_cv', "Failed to update the CV record", NULL, WATCHDOG_WARNING);
  389. return FALSE;
  390. }
  391. $results = tripal_core_chado_select('cv', array('*'), $sel_values, $sel_options);
  392. }
  393. // return the cv object
  394. return $results[0];
  395. }
  396. /**
  397. * Add's a CV term to the cvterm table. If the parent CV does not exist then
  398. * that too is added to the CV table. If the cvterm is a relationship term
  399. * then the $is_relationship argument should be set. The function will try
  400. * to first find the relationship in the relationship ontology for updating and
  401. * if it can't be found will add the relationship to the __global CV. All terms
  402. * must also have a corresponding database. This is specified in the term's
  403. * ID just before the colon (e.g. GO:003824). If the database does not exist
  404. * in the DB table then it will be added automatically. The accession (the
  405. * value just after the colon in the term's ID) will be added to the dbxref
  406. * table. If the CVterm already exists and $update is set (default) then the
  407. * cvterm is updated. If the CVTerm already exists and $update is not set, then
  408. * no changes are made and the CVTerm object is returned.
  409. *
  410. * @param $term
  411. * An associative array with the following keys: 'id', 'name' and 'namespace',
  412. * 'is_obsolete', and 'def'. Where 'id' is the term accession, 'name' is the
  413. * term name, 'namespace' is the CV name for the term, 'def' is the term
  414. * definition and 'is_obsolete' is present and set to 1 if the term is defunct.
  415. * The 'id' must be of the form <DB>:<ACCESSION>, where <DB> is the name of
  416. * the database to which the cvterm belongs and the <ACCESSION> is the
  417. * term's accession number in the database.
  418. * @param $defaultcv
  419. * Optional. The CV name to which the term
  420. * belongs. If this arugment is null or not provided then the function tries
  421. * to find a record in the CV table with the same name provided in the
  422. * $term[namespace]. If this field is provided then it overrides what the
  423. * value in $term[namespace]
  424. * @param $is_relationship
  425. * If this term is a relationship term then this value should be 1.
  426. * @param $update
  427. * By default this is set to 1. If the term exists it is automatically updated.
  428. * @param $dbname
  429. * In some cases the database name will not be part of the $term['id'] and it
  430. * needs to be explicitly set. Use this argument only if the database name
  431. * cannot be specififed in the term ID (e.g. <DB>:<ACCESSION>).
  432. *
  433. * @return
  434. * A CVTerm object
  435. *
  436. * @ingroup tripal_cv_api
  437. */
  438. function tripal_cv_add_cvterm($term, $defaultcv = '_global', $is_relationship = 0,
  439. $update = 1, $dbname = 'internal') {
  440. // get the term properties
  441. $id = $term['id'];
  442. $name = '';
  443. $cvname = '';
  444. $definition = '';
  445. $is_obsolete = 0;
  446. $accession = '';
  447. if (array_key_exists('name', $term)) {
  448. $name = $term['name'];
  449. }
  450. else {
  451. $name = $id;
  452. }
  453. if (array_key_exists('namespace', $term)) {
  454. $cvname = $term['namespace'];
  455. }
  456. else {
  457. $cvname = $defaultcv;
  458. }
  459. if (array_key_exists('def', $term)) {
  460. $definition = preg_replace('/^\"(.*)\"/', '\1', $term['def']);
  461. }
  462. else {
  463. $definition = '';
  464. }
  465. if (array_key_exists('is_obsolete', $term)) {
  466. $is_obsolete = $term['is_obsolete'];
  467. if (strcmp($is_obsolete, 'true') == 0) {
  468. $is_obsolete = 1;
  469. }
  470. }
  471. if (!$name and !$id) {
  472. watchdog('tripal_cv', "Cannot find cvterm without 'id' or 'name'", NULL, WATCHDOG_WARNING);
  473. return 0;
  474. }
  475. if (!$id) {
  476. $id = $name;
  477. }
  478. // get the accession and the database from the cvterm id
  479. if ($dbname) {
  480. $accession = $id;
  481. }
  482. if (preg_match('/^.+?:.*$/', $id)) {
  483. $accession = preg_replace('/^.+?:(.*)$/', '\1', $id);
  484. $dbname = preg_replace('/^(.+?):.*$/', '\1', $id);
  485. }
  486. // check that we have a database name, give a different message if it's a relationship
  487. if ($is_relationship and !$dbname) {
  488. watchdog('tripal_cv', "A database name is not provided for this relationship term: $id", NULL, WATCHDOG_WARNING);
  489. return 0;
  490. }
  491. if (!$is_relationship and !$dbname) {
  492. watchdog('tripal_cv', "A database identifier is missing from the term: $id", NULL, WATCHDOG_WARNING);
  493. return 0;
  494. }
  495. // make sure the CV name exists
  496. $cv = tripal_cv_add_cv($cvname, '');
  497. if (!$cv) {
  498. watchdog('tripal_cv', "Cannot find namespace '$cvname' when adding/updating $id", NULL, WATCHDOG_WARNING);
  499. return 0;
  500. }
  501. // this SQL statement will be used a lot to find a cvterm so just set it
  502. // here for easy reference below. Because CV terms can change their names
  503. // but accessions don't change, the following SQL finds cvterms based on
  504. // their accession rather than the name
  505. $cvtermsql = "
  506. SELECT CVT.name, CVT.cvterm_id, CV.cv_id, CV.name as cvname,
  507. DB.name as dbname, DB.db_id, DBX.accession
  508. FROM {cvterm} CVT
  509. INNER JOIN {dbxref} DBX on CVT.dbxref_id = DBX.dbxref_id
  510. INNER JOIN {db} DB on DBX.db_id = DB.db_id
  511. INNER JOIN {cv} CV on CV.cv_id = CVT.cv_id
  512. WHERE DBX.accession = :accession and DB.name = :name
  513. ";
  514. // add the database. The function will just return the DB object if the
  515. // database already exists.
  516. $db = tripal_db_add_db($dbname);
  517. if (!$db) {
  518. watchdog('tripal_cv', "Cannot find database '$dbname' in Chado.", NULL, WATCHDOG_WARNING);
  519. return 0;
  520. }
  521. // the cvterm table has two unique dependencies. We need to check both.
  522. // first check the (name, cv_id, is_obsolete) constraint
  523. $values = array(
  524. 'name' => $name,
  525. 'is_obsolete' => $is_obsolete,
  526. 'cv_id' => array(
  527. 'name' => $cvname,
  528. ),
  529. );
  530. $options = array('statement_name' => 'sel_cvterm_c1');
  531. $result = tripal_core_chado_select('cvterm', array('*'), $values, $options);
  532. // if the constraint is met then let's check it to see if
  533. // the database name matches the one we have been provided
  534. if (count($result) == 1) {
  535. $cvterm = $result[0];
  536. // get the dbxref record
  537. $values = array('dbxref_id' => $cvterm->dbxref_id);
  538. $options = array('statement_name' => 'sel_dbxref_id');
  539. $result = tripal_core_chado_select('dbxref', array('*'), $values, $options);
  540. $dbxref = $result[0];
  541. // get the db
  542. $values = array('db_id' => $dbxref->db_id);
  543. $options = array('statement_name' => 'sel_db_id');
  544. $result = tripal_core_chado_select('db', array('*'), $values, $options);
  545. $db_check = $result[0];
  546. // the database name for this existing term does not match that of the
  547. // one provided to this function. The CV name matches otherwise we
  548. // wouldn't have made it this far. So, let's swap the database for
  549. // this term
  550. if ($db_check->name != $db->name) {
  551. // look to see if the correct dbxref record already exists for this database
  552. $values = array(
  553. 'db_id' => $db->db_id,
  554. 'accession' => $accession,
  555. );
  556. $options = array('statement_name' => 'sel_dbxref_idac');
  557. $result = tripal_core_chado_select('dbxref', array('*'), $values, $options);
  558. // if we already have a good dbxref then we want to update our cvterm
  559. // to use this dbxref
  560. if (count($result) > 0) {
  561. $dbxref = $result[0];
  562. $match = array('cvterm_id' => $cvterm->cvterm_id);
  563. $values = array('dbxref_id' => $dbxref->dbxref_id);
  564. $options = array('statement_name' => 'upd_cvterm_db');
  565. $success = tripal_core_chado_update('cvterm', $match, $values, $options);
  566. if (!$success) {
  567. watchdog('tripal_cv', "Failed to correct the dbxref id for the cvterm " .
  568. "'$name' (id: $accession), for database $dbname", NULL, WATCHDOG_WARNING);
  569. return 0;
  570. }
  571. }
  572. // if we don't have the record then we want to delete our cvterm and let the code
  573. // below recreate it with the correct info
  574. else {
  575. $match = array('cvterm_id' => $cvterm->cvterm_id);
  576. $options = array('statement_name' => 'del_cvterm_cv');
  577. tripal_core_chado_delete('cvterm', $match, $options);
  578. }
  579. }
  580. // check that the accession matches. Sometimes an OBO can define the same term
  581. // multiple times but with different accessions. If this is the case we
  582. // can't do an insert or it will violate the constraint in the cvterm table.
  583. // so we'll need to add the record to the cvterm_dbxref table instead
  584. if ($dbxref->accession != $accession) {
  585. // get/add the dbxref fort his term
  586. $dbxref_new = tripal_db_add_dbxref($db->db_id, $accession);
  587. if (!$dbxref_new) {
  588. watchdog('tripal_cv', "Failed to find or insert the dbxref record for cvterm, " .
  589. "$name (id: $accession), for database $dbname", NULL, WATCHDOG_WARNING);
  590. return 0;
  591. }
  592. // check to see if the cvterm_dbxref record already exists
  593. $values = array(
  594. 'cvterm_id' => $cvterm->cvterm_id,
  595. 'dbxref_id' => $dbxref_new->dbxref_id,
  596. 'is_for_definition' => 1,
  597. );
  598. $options = array('statement_name' => 'sel_cvtermdbxref_cvdbis');
  599. $result = tripal_core_chado_select('cvterm_dbxref', array('*'), $values, $options);
  600. // if the cvterm_dbxref record does not exists then add it
  601. if (count($result)==0) {
  602. $options = array(
  603. 'statement_name' => 'ins_cvtermdbxref_cvdbis',
  604. 'return_record' => FALSE,
  605. );
  606. $success = tripal_core_chado_insert('cvterm_dbxref', $values, $options);
  607. if (!$success) {
  608. watchdog('tripal_cv', "Failed to find or insert the cvterm_dbxref record for a " .
  609. "duplicated cvterm: $name (id: $accession), for database $dbname", NULL, WATCHDOG_WARNING);
  610. return 0;
  611. }
  612. }
  613. // get the original cvterm with the same name and return that.
  614. $result = chado_query($cvtermsql, array(':accession' => $dbxref->accession, ':name' => $dbname));
  615. $cvterm = $result->fetchObject();
  616. return $cvterm;
  617. }
  618. // continue on, we've fixed the record if the db_id did not match,
  619. // we can now perform and updated if we need to.
  620. }
  621. // get the CVterm record
  622. $result = chado_query($cvtermsql, array(':accession' => $accession, ':name' => $dbname));
  623. $cvterm = $result->fetchObject();
  624. if (!$cvterm) {
  625. // check to see if the dbxref exists if not, add it
  626. $dbxref = tripal_db_add_dbxref($db->db_id, $accession);
  627. if (!$dbxref) {
  628. watchdog('tripal_cv', "Failed to find or insert the dbxref record for cvterm, " .
  629. "$name (id: $accession), for database $dbname", NULL, WATCHDOG_WARNING);
  630. return 0;
  631. }
  632. // check to see if the dbxref already has an entry in the cvterm table
  633. // this is the second constraint in the cvterm table
  634. $values = array('dbxref_id' => $dbxref->dbxref_id);
  635. $options = array('statement_name' => 'sel_cvterm_db');
  636. $check = tripal_core_chado_select('cvterm', array('cvterm_id'), $values, $options);
  637. if (count($check) == 0) {
  638. // now add the cvterm
  639. $ins_values = array(
  640. 'cv_id' => $cv->cv_id,
  641. 'name' => $name,
  642. 'definition' => $definition,
  643. 'dbxref_id' => $dbxref->dbxref_id,
  644. 'is_obsolete' => $is_obsolete,
  645. 'is_relationshiptype' => $is_relationship,
  646. );
  647. $ins_options = array('statement_name' => 'ins_cvterm_all');
  648. $success = tripal_core_chado_insert('cvterm', $ins_values, $ins_options);
  649. if (!$success) {
  650. if (!$is_relationship) {
  651. watchdog('tripal_cv', "Failed to insert the term: $name ($dbname)", NULL, WATCHDOG_WARNING);
  652. return 0;
  653. }
  654. else {
  655. watchdog('tripal_cv', "Failed to insert the relationship term: $name (cv: " . $cvname . " db: $dbname)", NULL, WATCHDOG_WARNING);
  656. return 0;
  657. }
  658. }
  659. }
  660. // this dbxref already exists in the cvterm table
  661. else {
  662. watchdog('tripal_cv', "The dbxref already exists for another cvterm record: $name (cv: " . $cvname . " db: $dbname)", NULL, WATCHDOG_WARNING);
  663. return 0;
  664. }
  665. $result = chado_query($cvtermsql, array(':accession' => $accession, ':name' => $dbname));
  666. $cvterm = $result->fetchObject();
  667. }
  668. // upate the cvterm
  669. elseif ($update) {
  670. $match = array('cvterm_id' => $cvterm->cvterm_id);
  671. $upd_values = array(
  672. 'name' => $name,
  673. 'definition' => $definition,
  674. 'is_obsolete' => $is_obsolete,
  675. 'is_relationshiptype' => $is_relationship,
  676. );
  677. $upd_options = array('statement_name' => 'upd_cvterm_nadeisis');
  678. $success = tripal_core_chado_update('cvterm', $match, $upd_values, $upd_options);
  679. if (!$success) {
  680. watchdog('tripal_cv', "Failed to update the term: $name", NULL, WATCHDOG_WARNING);
  681. return 0;
  682. }
  683. $result = chado_query($cvtermsql, array(':accession' => $accession, ':name' => $dbname));
  684. $cvterm = $result->fetchObject();
  685. }
  686. else {
  687. // do nothing, we have the cvterm but we don't want to update
  688. }
  689. // return the cvterm
  690. return $cvterm;
  691. }
  692. /**
  693. * This function allows other modules to programatically
  694. * submit an ontology for loading into Chado. This function
  695. * will add a job to the Jobs subsystem for parsing the ontology.
  696. * You can either pass a known OBO ID to the function or the URL
  697. * or full path the the ontology file. If a URL or file name is
  698. * passed then the $obo_name argument must also be provided. If
  699. * this is the first time the ontology has been provided to Tripal
  700. * then it will be added to the database and will be assigned a
  701. * unique OBO ID.
  702. *
  703. * @param $obo_id
  704. * If the ontology is already loaded into the Tripal tables then
  705. * use this argument to specify the unique ID for the ontology
  706. * that will be loaded
  707. * @param $obo_name
  708. * If the OBO has not been added before then use this argument
  709. * to specify the human readable name of the ontology.
  710. * @param $obo_url
  711. * If the OBO to be loaded is located on a remote server then
  712. * use this argument to provide the URL.
  713. * @param $obo_file
  714. * If the OBO is housed on the local file system of the server then
  715. * use this argument to specify the full path.
  716. *
  717. * @return
  718. * returns the job_id of the submitted job or FALSE if the job was not added
  719. *
  720. * @ingroup tripal_cv_api
  721. */
  722. function tripal_cv_submit_obo_job($obo_id = NULL, $obo_name = NULL, $obo_url = NULL, $obo_file = NULL) {
  723. global $user;
  724. if ($obo_id) {
  725. $sql = "SELECT * FROM {tripal_cv_obo} WHERE obo_id = :obo_id";
  726. $obo = db_query($sql, array(':obo_id' => $obo_id))->fetchObject();
  727. $args = array($obo_id);
  728. return tripal_add_job("Load OBO $obo->name", 'tripal_cv',
  729. "tripal_cv_load_obo_v1_2_id", $args, $user->uid);
  730. }
  731. else {
  732. if ($obo_url) {
  733. $args = array($obo_name, $obo_url);
  734. return tripal_add_job("Load OBO $obo_name", 'tripal_cv',
  735. "tripal_cv_load_obo_v1_2_url", $args, $user->uid);
  736. }
  737. elseif ($obo_file) {
  738. $args = array($obo_name, $obo_file);
  739. return tripal_add_job("Load OBO $obo_name", 'tripal_cv',
  740. "tripal_cv_load_obo_v1_2_file", $args, $user->uid);
  741. }
  742. }
  743. return FALSE;
  744. }
  745. /**
  746. * Add the obo to the tripal_cv_obo table in the Drupal database
  747. *
  748. * @param $name
  749. * The human readable name of this ontology
  750. * @param $path
  751. * The file path or URL of the ontology
  752. *
  753. * @return
  754. * Returns the ontology ID
  755. *
  756. * @ingroup tripal_cv_api
  757. */
  758. function tripal_cv_add_obo_ref($name, $path) {
  759. $record = new stdClass;
  760. $record->name = $name;
  761. $record->path = $path;
  762. drupal_write_record('tripal_cv_obo', $record);
  763. return $record->obo_id;
  764. }
  765. /**
  766. * This function is intended to be used in autocomplete forms
  767. * for searching for CV terms that begin with the provided string
  768. *
  769. * @param $cv_id
  770. * The CV ID in which to search for the term
  771. * @param $string
  772. * The string to search for
  773. *
  774. * @return
  775. * A json array of terms that begin with the provided string
  776. *
  777. * @ingroup tripal_cv_api
  778. */
  779. function tripal_cv_cvterm_name_autocomplete($cv_id, $string = '') {
  780. $sql = "
  781. SELECT cvterm_id, name
  782. FROM {cvterm}
  783. WHERE cv_id = :cv_id and name like :name
  784. ORDER by name
  785. LIMIT 25 OFFSET 0
  786. ";
  787. $results = chado_query($sql, array(':cv_id' => $cv_id, ':name' => $string . '%'));
  788. $items = array();
  789. foreach ($results as $term) {
  790. $items[$term->name] = $term->name;
  791. }
  792. drupal_json_output($items);
  793. }