export.inc

  1. 7.x ctools/includes/export.inc
  2. 6.x ctools/includes/export.inc

Contains code to make it easier to have exportable objects.

Documentation for exportable objects is contained in help/export.html

Functions

Namesort descending Description
ctools_export_crud_delete Delete a single exportable object.
ctools_export_crud_disable Disable a certain object.
ctools_export_crud_enable Enable a certain object.
ctools_export_crud_export Get the exported code of a single exportable object.
ctools_export_crud_import Turn exported code into an object.
ctools_export_crud_load Load a single exportable object.
ctools_export_crud_load_all Load all exportable objects of a given type.
ctools_export_crud_load_multiple Load multiple exportable objects.
ctools_export_crud_new Create a new object for the given $table.
ctools_export_crud_save Save a single exportable object.
ctools_export_crud_set_status Change the status of a certain object.
ctools_export_default_list Default function for listing bulk exportable objects.
ctools_export_default_to_hook_code Default function to export objects to code.
ctools_export_form Provide a form for displaying an export.
ctools_export_get_schema Get the schema for a given table.
ctools_export_get_schemas Gets the schemas for all tables with ctools object metadata.
ctools_export_get_schemas_by_module
ctools_export_load_object Load some number of exportable objects.
ctools_export_load_object_reset Reset all static caches in ctools_export_load_object() or static caches for a given table in ctools_export_load_object().
ctools_export_new_object Create a new object based upon schema values.
ctools_export_object Export an object into code.
ctools_export_set_object_status Set the status of a default $object as a variable.
ctools_export_set_status Set the status of a default $object as a variable.
ctools_export_to_hook_code Convert a group of objects to code based upon input and return this as a larger export.
ctools_export_unpack_object Unpack data loaded from the database onto an object.
ctools_get_default_object Get the default version of an object, if it exists.
ctools_var_export Export a field.
_ctools_export_filter_export_tables
_ctools_export_get_defaults Call the hook to get all default objects of the given type from the export. If configured properly, this could include loading up an API to get default objects.
_ctools_export_get_defaults_from_cache Attempt to load default objects from cache.
_ctools_export_get_some_defaults Get a limited number of default objects.
_ctools_export_unpack_object Unpack data loaded from the database onto an object.

Constants

Namesort descending Description
EXPORT_IN_CODE A bit flag used to let us know if an object is a 'default' in code.
EXPORT_IN_DATABASE A bit flag used to let us know if an object is in the database.

File

ctools/includes/export.inc
View source
  1. <?php
  2. /**
  3. * @file
  4. * Contains code to make it easier to have exportable objects.
  5. *
  6. * Documentation for exportable objects is contained in help/export.html
  7. */
  8. /**
  9. * A bit flag used to let us know if an object is in the database.
  10. */
  11. define('EXPORT_IN_DATABASE', 0x01);
  12. /**
  13. * A bit flag used to let us know if an object is a 'default' in code.
  14. */
  15. define('EXPORT_IN_CODE', 0x02);
  16. /**
  17. * @defgroup export_crud CRUD functions for export.
  18. * @{
  19. * export.inc supports a small number of CRUD functions that should always
  20. * work for every exportable object, no matter how complicated. These
  21. * functions allow complex objects to provide their own callbacks, but
  22. * in most cases, the default callbacks will be used.
  23. *
  24. * Note that defaults are NOT set in the $schema because it is presumed
  25. * that a module's personalized CRUD functions will already know which
  26. * $table to use and not want to clutter up the arguments with it.
  27. */
  28. /**
  29. * Create a new object for the given $table.
  30. *
  31. * @param $table
  32. * The name of the table to use to retrieve $schema values. This table
  33. * must have an 'export' section containing data or this function
  34. * will fail.
  35. * @param $set_defaults
  36. * If TRUE, which is the default, then default values will be retrieved
  37. * from schema fields and set on the object.
  38. *
  39. * @return
  40. * The loaded object.
  41. */
  42. function ctools_export_crud_new($table, $set_defaults = TRUE) {
  43. $schema = ctools_export_get_schema($table);
  44. $export = $schema['export'];
  45. if (!empty($export['create callback']) && function_exists($export['create callback'])) {
  46. return $export['create callback']($set_defaults);
  47. }
  48. else {
  49. return ctools_export_new_object($table, $set_defaults);
  50. }
  51. }
  52. /**
  53. * Load a single exportable object.
  54. *
  55. * @param $table
  56. * The name of the table to use to retrieve $schema values. This table
  57. * must have an 'export' section containing data or this function
  58. * will fail.
  59. * @param $name
  60. * The unique ID to load. The field for this ID will be specified by
  61. * the export key, which normally defaults to 'name'.
  62. *
  63. * @return
  64. * The loaded object.
  65. */
  66. function ctools_export_crud_load($table, $name) {
  67. $schema = ctools_export_get_schema($table);
  68. $export = $schema['export'];
  69. if (!empty($export['load callback']) && function_exists($export['load callback'])) {
  70. return $export['load callback']($name);
  71. }
  72. else {
  73. $result = ctools_export_load_object($table, 'names', array($name));
  74. if (isset($result[$name])) {
  75. return $result[$name];
  76. }
  77. }
  78. }
  79. /**
  80. * Load multiple exportable objects.
  81. *
  82. * @param $table
  83. * The name of the table to use to retrieve $schema values. This table
  84. * must have an 'export' section containing data or this function
  85. * will fail.
  86. * @param $names
  87. * An array of unique IDs to load. The field for these IDs will be specified
  88. * by the export key, which normally defaults to 'name'.
  89. *
  90. * @return
  91. * An array of the loaded objects.
  92. */
  93. function ctools_export_crud_load_multiple($table, array $names) {
  94. $schema = ctools_export_get_schema($table);
  95. $export = $schema['export'];
  96. $results = array();
  97. if (!empty($export['load multiple callback']) && function_exists($export['load multiple callback'])) {
  98. $results = $export['load multiple callback']($names);
  99. }
  100. else {
  101. $results = ctools_export_load_object($table, 'names', $names);
  102. }
  103. // Ensure no empty results are returned.
  104. return array_filter($results);
  105. }
  106. /**
  107. * Load all exportable objects of a given type.
  108. *
  109. * @param $table
  110. * The name of the table to use to retrieve $schema values. This table
  111. * must have an 'export' section containing data or this function
  112. * will fail.
  113. * @param $reset
  114. * If TRUE, the static cache of all objects will be flushed prior to
  115. * loading all. This can be important on listing pages where items
  116. * might have changed on the page load.
  117. * @return
  118. * An array of all loaded objects, keyed by the unique IDs of the export key.
  119. */
  120. function ctools_export_crud_load_all($table, $reset = FALSE) {
  121. $schema = ctools_export_get_schema($table);
  122. if (empty($schema['export'])) {
  123. return array();
  124. }
  125. $export = $schema['export'];
  126. if ($reset) {
  127. ctools_export_load_object_reset($table);
  128. }
  129. if (!empty($export['load all callback']) && function_exists($export['load all callback'])) {
  130. return $export['load all callback']($reset);
  131. }
  132. else {
  133. return ctools_export_load_object($table, 'all');
  134. }
  135. }
  136. /**
  137. * Save a single exportable object.
  138. *
  139. * @param $table
  140. * The name of the table to use to retrieve $schema values. This table
  141. * must have an 'export' section containing data or this function
  142. * will fail.
  143. * @param $object
  144. * The fully populated object to save.
  145. *
  146. * @return
  147. * Failure to write a record will return FALSE. Otherwise SAVED_NEW or
  148. * SAVED_UPDATED is returned depending on the operation performed. The
  149. * $object parameter contains values for any serial fields defined by the $table
  150. */
  151. function ctools_export_crud_save($table, &$object) {
  152. $schema = ctools_export_get_schema($table);
  153. $export = $schema['export'];
  154. if (!empty($export['save callback']) && function_exists($export['save callback'])) {
  155. return $export['save callback']($object);
  156. }
  157. else {
  158. // Objects should have a serial primary key. If not, simply fail to write.
  159. if (empty($export['primary key'])) {
  160. return FALSE;
  161. }
  162. $key = $export['primary key'];
  163. if ($object->export_type & EXPORT_IN_DATABASE) {
  164. // Existing record.
  165. $update = array($key);
  166. }
  167. else {
  168. // New record.
  169. $update = array();
  170. $object->export_type = EXPORT_IN_DATABASE;
  171. }
  172. return drupal_write_record($table, $object, $update);
  173. }
  174. }
  175. /**
  176. * Delete a single exportable object.
  177. *
  178. * This only deletes from the database, which means that if an item is in
  179. * code, then this is actually a revert.
  180. *
  181. * @param $table
  182. * The name of the table to use to retrieve $schema values. This table
  183. * must have an 'export' section containing data or this function
  184. * will fail.
  185. * @param $object
  186. * The fully populated object to delete, or the export key.
  187. */
  188. function ctools_export_crud_delete($table, $object) {
  189. $schema = ctools_export_get_schema($table);
  190. $export = $schema['export'];
  191. if (!empty($export['delete callback']) && function_exists($export['delete callback'])) {
  192. return $export['delete callback']($object);
  193. }
  194. else {
  195. // If we were sent an object, get the export key from it. Otherwise
  196. // assume we were sent the export key.
  197. $value = is_object($object) ? $object->{$export['key']} : $object;
  198. db_delete($table)
  199. ->condition($export['key'], $value)
  200. ->execute();
  201. }
  202. }
  203. /**
  204. * Get the exported code of a single exportable object.
  205. *
  206. * @param $table
  207. * The name of the table to use to retrieve $schema values. This table
  208. * must have an 'export' section containing data or this function
  209. * will fail.
  210. * @param $object
  211. * The fully populated object to delete, or the export key.
  212. * @param $indent
  213. * Any indentation to apply to the code, in case this object is embedded
  214. * into another, for example.
  215. *
  216. * @return
  217. * A string containing the executable export of the object.
  218. */
  219. function ctools_export_crud_export($table, $object, $indent = '') {
  220. $schema = ctools_export_get_schema($table);
  221. $export = $schema['export'];
  222. if (!empty($export['export callback']) && function_exists($export['export callback'])) {
  223. return $export['export callback']($object, $indent);
  224. }
  225. else {
  226. return ctools_export_object($table, $object, $indent);
  227. }
  228. }
  229. /**
  230. * Turn exported code into an object.
  231. *
  232. * Note: If the code is poorly formed, this could crash and there is no
  233. * way to prevent this.
  234. *
  235. * @param $table
  236. * The name of the table to use to retrieve $schema values. This table
  237. * must have an 'export' section containing data or this function
  238. * will fail.
  239. * @param $code
  240. * The code to eval to create the object.
  241. *
  242. * @return
  243. * An object created from the export. This object will NOT have been saved
  244. * to the database. In the case of failure, a string containing all errors
  245. * that the system was able to determine.
  246. */
  247. function ctools_export_crud_import($table, $code) {
  248. $schema = ctools_export_get_schema($table);
  249. $export = $schema['export'];
  250. if (!empty($export['import callback']) && function_exists($export['import callback'])) {
  251. return $export['import callback']($code);
  252. }
  253. else {
  254. ob_start();
  255. eval($code);
  256. ob_end_clean();
  257. if (empty(${$export['identifier']})) {
  258. $errors = ob_get_contents();
  259. if (empty($errors)) {
  260. $errors = t('No item found.');
  261. }
  262. return $errors;
  263. }
  264. $item = ${$export['identifier']};
  265. // Set these defaults just the same way that ctools_export_new_object sets
  266. // them.
  267. $item->export_type = NULL;
  268. $item->{$export['export type string']} = t('Local');
  269. return $item;
  270. }
  271. }
  272. /**
  273. * Change the status of a certain object.
  274. *
  275. * @param $table
  276. * The name of the table to use to enable a certain object. This table
  277. * must have an 'export' section containing data or this function
  278. * will fail.
  279. * @param $object
  280. * The fully populated object to enable, or the machine readable name.
  281. * @param $status
  282. * The status, in this case, is whether or not it is 'disabled'.
  283. */
  284. function ctools_export_crud_set_status($table, $object, $status) {
  285. $schema = ctools_export_get_schema($table);
  286. $export = $schema['export'];
  287. if (!empty($export['status callback']) && function_exists($export['status callback'])) {
  288. $export['status callback']($object, $status);
  289. }
  290. else {
  291. if (is_object($object)) {
  292. ctools_export_set_object_status($object, $status);
  293. }
  294. else {
  295. ctools_export_set_status($table, $object, $status);
  296. }
  297. }
  298. }
  299. /**
  300. * Enable a certain object.
  301. *
  302. * @param $table
  303. * The name of the table to use to enable a certain object. This table
  304. * must have an 'export' section containing data or this function
  305. * will fail.
  306. * @param $object
  307. * The fully populated object to enable, or the machine readable name.
  308. */
  309. function ctools_export_crud_enable($table, $object) {
  310. return ctools_export_crud_set_status($table, $object, FALSE);
  311. }
  312. /**
  313. * Disable a certain object.
  314. *
  315. * @param $table
  316. * The name of the table to use to disable a certain object. This table
  317. * must have an 'export' section containing data or this function
  318. * will fail.
  319. * @param $object
  320. * The fully populated object to disable, or the machine readable name.
  321. */
  322. function ctools_export_crud_disable($table, $object) {
  323. return ctools_export_crud_set_status($table, $object, TRUE);
  324. }
  325. /**
  326. * @}
  327. */
  328. /**
  329. * Load some number of exportable objects.
  330. *
  331. * This function will cache the objects, load subsidiary objects if necessary,
  332. * check default objects in code and properly set them up. It will cache
  333. * the results so that multiple calls to load the same objects
  334. * will not cause problems.
  335. *
  336. * It attempts to reduce, as much as possible, the number of queries
  337. * involved.
  338. *
  339. * @param $table
  340. * The name of the table to be loaded from. Data is expected to be in the
  341. * schema to make all this work.
  342. * @param $type
  343. * A string to notify the loader what the argument is
  344. * - all: load all items. This is the default. $args is unused.
  345. * - names: $args will be an array of specific named objects to load.
  346. * - conditions: $args will be a keyed array of conditions. The conditions
  347. * must be in the schema for this table or errors will result.
  348. * @param $args
  349. * An array of arguments whose actual use is defined by the $type argument.
  350. */
  351. function ctools_export_load_object($table, $type = 'all', $args = array()) {
  352. $cache = &drupal_static(__FUNCTION__);
  353. $cache_table_exists = &drupal_static(__FUNCTION__ . '_table_exists', array());
  354. $cached_database = &drupal_static('ctools_export_load_object_all');
  355. if (!array_key_exists($table, $cache_table_exists)) {
  356. $cache_table_exists[$table] = db_table_exists($table);
  357. }
  358. $schema = ctools_export_get_schema($table);
  359. if (empty($schema) || !$cache_table_exists[$table]) {
  360. return array();
  361. }
  362. $export = $schema['export'];
  363. if (!isset($cache[$table])) {
  364. $cache[$table] = array();
  365. }
  366. // If fetching all and cached all, we've done so and we are finished.
  367. if ($type == 'all' && !empty($cached_database[$table])) {
  368. return $cache[$table];
  369. }
  370. $return = array();
  371. // Don't load anything we've already cached.
  372. if ($type == 'names' && !empty($args)) {
  373. foreach ($args as $id => $name) {
  374. if (isset($cache[$table][$name])) {
  375. $return[$name] = $cache[$table][$name];
  376. unset($args[$id]);
  377. }
  378. }
  379. // If nothing left to load, return the result.
  380. if (empty($args)) {
  381. return $return;
  382. }
  383. }
  384. // Build the query
  385. $query = db_select($table, 't__0')->fields('t__0');
  386. $alias_count = 1;
  387. if (!empty($schema['join'])) {
  388. foreach ($schema['join'] as $join_key => $join) {
  389. if ($join_schema = drupal_get_schema($join['table'])) {
  390. $query->join($join['table'], 't__' . $alias_count, 't__0.' . $join['left_key'] . ' = ' . 't__' . $alias_count . '.' . $join['right_key']);
  391. $query->fields('t__' . $alias_count);
  392. $alias_count++;
  393. // Allow joining tables to alter the query through a callback.
  394. if (isset($join['callback']) && function_exists($join['callback'])) {
  395. $join['callback']($query, $schema, $join_schema);
  396. }
  397. }
  398. }
  399. }
  400. $conditions = array();
  401. $query_args = array();
  402. // If they passed in names, add them to the query.
  403. if ($type == 'names') {
  404. $query->condition($export['key'], $args, 'IN');
  405. }
  406. else if ($type == 'conditions') {
  407. foreach ($args as $key => $value) {
  408. if (isset($schema['fields'][$key])) {
  409. $query->condition($key, $value);
  410. }
  411. }
  412. }
  413. $result = $query->execute();
  414. $status = variable_get($export['status'], array());
  415. // Unpack the results of the query onto objects and cache them.
  416. foreach ($result as $data) {
  417. if (isset($schema['export']['object factory']) && function_exists($schema['export']['object factory'])) {
  418. $object = $schema['export']['object factory']($schema, $data);
  419. }
  420. else {
  421. $object = _ctools_export_unpack_object($schema, $data, $export['object']);
  422. }
  423. $object->table = $table;
  424. $object->{$export['export type string']} = t('Normal');
  425. $object->export_type = EXPORT_IN_DATABASE;
  426. // Determine if default object is enabled or disabled.
  427. if (isset($status[$object->{$export['key']}])) {
  428. $object->disabled = $status[$object->{$export['key']}];
  429. }
  430. $cache[$table][$object->{$export['key']}] = $object;
  431. if ($type == 'conditions') {
  432. $return[$object->{$export['key']}] = $object;
  433. }
  434. }
  435. // Load subrecords.
  436. if (isset($export['subrecords callback']) && function_exists($export['subrecords callback'])) {
  437. $export['subrecords callback']($cache[$table]);
  438. }
  439. if ($type == 'names' && !empty($args) && !empty($export['cache defaults'])) {
  440. $defaults = _ctools_export_get_some_defaults($table, $export, $args);
  441. }
  442. else {
  443. $defaults = _ctools_export_get_defaults($table, $export);
  444. }
  445. if ($defaults) {
  446. foreach ($defaults as $object) {
  447. if ($type == 'conditions') {
  448. // if this does not match all of our conditions, skip it.
  449. foreach ($args as $key => $value) {
  450. if (!isset($object->$key)) {
  451. continue 2;
  452. }
  453. if (is_array($value)) {
  454. if (!in_array($object->$key, $value)) {
  455. continue 2;
  456. }
  457. }
  458. else if ($object->$key != $value) {
  459. continue 2;
  460. }
  461. }
  462. }
  463. else if ($type == 'names') {
  464. if (!in_array($object->{$export['key']}, $args)) {
  465. continue;
  466. }
  467. }
  468. // Determine if default object is enabled or disabled.
  469. if (isset($status[$object->{$export['key']}])) {
  470. $object->disabled = $status[$object->{$export['key']}];
  471. }
  472. if (!empty($cache[$table][$object->{$export['key']}])) {
  473. $cache[$table][$object->{$export['key']}]->{$export['export type string']} = t('Overridden');
  474. $cache[$table][$object->{$export['key']}]->export_type |= EXPORT_IN_CODE;
  475. $cache[$table][$object->{$export['key']}]->export_module = isset($object->export_module) ? $object->export_module : NULL;
  476. if ($type == 'conditions') {
  477. $return[$object->{$export['key']}] = $cache[$table][$object->{$export['key']}];
  478. }
  479. }
  480. else {
  481. $object->{$export['export type string']} = t('Default');
  482. $object->export_type = EXPORT_IN_CODE;
  483. $object->in_code_only = TRUE;
  484. $object->table = $table;
  485. $cache[$table][$object->{$export['key']}] = $object;
  486. if ($type == 'conditions') {
  487. $return[$object->{$export['key']}] = $object;
  488. }
  489. }
  490. }
  491. }
  492. // If fetching all, we've done so and we are finished.
  493. if ($type == 'all') {
  494. $cached_database[$table] = TRUE;
  495. return $cache[$table];
  496. }
  497. if ($type == 'names') {
  498. foreach ($args as $name) {
  499. if (isset($cache[$table][$name])) {
  500. $return[$name] = $cache[$table][$name];
  501. }
  502. }
  503. }
  504. // For conditions,
  505. return $return;
  506. }
  507. /**
  508. * Reset all static caches in ctools_export_load_object() or static caches for
  509. * a given table in ctools_export_load_object().
  510. *
  511. * @param $table
  512. * String that is the name of a table. If not defined, all static caches in
  513. * ctools_export_load_object() will be reset.
  514. */
  515. function ctools_export_load_object_reset($table = NULL) {
  516. // Reset plugin cache to make sure new include files are picked up.
  517. ctools_include('plugins');
  518. ctools_get_plugins_reset();
  519. if (empty($table)) {
  520. drupal_static_reset('ctools_export_load_object');
  521. drupal_static_reset('ctools_export_load_object_all');
  522. drupal_static_reset('_ctools_export_get_defaults');
  523. }
  524. else {
  525. $cache = &drupal_static('ctools_export_load_object');
  526. $cached_database = &drupal_static('ctools_export_load_object_all');
  527. $cached_defaults = &drupal_static('_ctools_export_get_defaults');
  528. unset($cache[$table]);
  529. unset($cached_database[$table]);
  530. unset($cached_defaults[$table]);
  531. }
  532. }
  533. /**
  534. * Get the default version of an object, if it exists.
  535. *
  536. * This function doesn't care if an object is in the database or not and
  537. * does not check. This means that export_type could appear to be incorrect,
  538. * because a version could exist in the database. However, it's not
  539. * incorrect for this function as it is *only* used for the default
  540. * in code version.
  541. */
  542. function ctools_get_default_object($table, $name) {
  543. $schema = ctools_export_get_schema($table);
  544. $export = $schema['export'];
  545. if (!$export['default hook']) {
  546. return;
  547. }
  548. // Try to load individually from cache if this cache is enabled.
  549. if (!empty($export['cache defaults'])) {
  550. $defaults = _ctools_export_get_some_defaults($table, $export, array($name));
  551. }
  552. else {
  553. $defaults = _ctools_export_get_defaults($table, $export);
  554. }
  555. $status = variable_get($export['status'], array());
  556. if (!isset($defaults[$name])) {
  557. return;
  558. }
  559. $object = $defaults[$name];
  560. // Determine if default object is enabled or disabled.
  561. if (isset($status[$object->{$export['key']}])) {
  562. $object->disabled = $status[$object->{$export['key']}];
  563. }
  564. $object->{$export['export type string']} = t('Default');
  565. $object->export_type = EXPORT_IN_CODE;
  566. $object->in_code_only = TRUE;
  567. return $object;
  568. }
  569. /**
  570. * Call the hook to get all default objects of the given type from the
  571. * export. If configured properly, this could include loading up an API
  572. * to get default objects.
  573. */
  574. function _ctools_export_get_defaults($table, $export) {
  575. $cache = &drupal_static(__FUNCTION__, array());
  576. // If defaults may be cached, first see if we can load from cache.
  577. if (!isset($cache[$table]) && !empty($export['cache defaults'])) {
  578. $cache[$table] = _ctools_export_get_defaults_from_cache($table, $export);
  579. }
  580. if (!isset($cache[$table])) {
  581. // If we're caching, attempt to get a lock. We will wait a short time
  582. // on the lock, but not too long, because it's better to just rebuild
  583. // and throw away results than wait too long on a lock.
  584. if (!empty($export['cache defaults'])) {
  585. for ($counter = 0; !($lock = lock_acquire('ctools_export:' . $table)) && $counter > 5; $counter++) {
  586. lock_wait('ctools_export:' . $table, 1);
  587. ++$counter;
  588. }
  589. }
  590. $cache[$table] = array();
  591. if ($export['default hook']) {
  592. if (!empty($export['api'])) {
  593. ctools_include('plugins');
  594. $info = ctools_plugin_api_include($export['api']['owner'], $export['api']['api'],
  595. $export['api']['minimum_version'], $export['api']['current_version']);
  596. $modules = array_keys($info);
  597. }
  598. else {
  599. $modules = module_implements($export['default hook']);
  600. }
  601. foreach ($modules as $module) {
  602. $function = $module . '_' . $export['default hook'];
  603. if (function_exists($function)) {
  604. foreach ((array) $function($export) as $name => $object) {
  605. // Record the module that provides this exportable.
  606. $object->export_module = $module;
  607. if (empty($export['api'])) {
  608. $cache[$table][$name] = $object;
  609. }
  610. else {
  611. // If version checking is enabled, ensure that the object can be used.
  612. if (isset($object->api_version) &&
  613. version_compare($object->api_version, $export['api']['minimum_version']) >= 0 &&
  614. version_compare($object->api_version, $export['api']['current_version']) <= 0) {
  615. $cache[$table][$name] = $object;
  616. }
  617. }
  618. }
  619. }
  620. }
  621. drupal_alter($export['default hook'], $cache[$table]);
  622. // If we acquired a lock earlier, cache the results and release the
  623. // lock.
  624. if (!empty($lock)) {
  625. // Cache the index.
  626. $index = array_keys($cache[$table]);
  627. cache_set('ctools_export_index:' . $table, $index, $export['default cache bin']);
  628. // Cache each object.
  629. foreach ($cache[$table] as $name => $object) {
  630. cache_set('ctools_export:' . $table . ':' . $name, $object, $export['default cache bin']);
  631. }
  632. lock_release('ctools_export:' . $table);
  633. }
  634. }
  635. }
  636. return $cache[$table];
  637. }
  638. /**
  639. * Attempt to load default objects from cache.
  640. *
  641. * We can be instructed to cache default objects by the schema. If so
  642. * we cache them as an index which is a list of all default objects, and
  643. * then each default object is cached individually.
  644. *
  645. * @return Either an array of cached objects, or NULL indicating a cache
  646. * rebuild is necessary.
  647. */
  648. function _ctools_export_get_defaults_from_cache($table, $export) {
  649. $data = cache_get('ctools_export_index:' . $table, $export['default cache bin']);
  650. if (!$data || !is_array($data->data)) {
  651. return;
  652. }
  653. // This is the perfectly valid case where there are no default objects,
  654. // and we have cached this state.
  655. if (empty($data->data)) {
  656. return array();
  657. }
  658. $keys = array();
  659. foreach ($data->data as $name) {
  660. $keys[] = 'ctools_export:' . $table . ':' . $name;
  661. }
  662. $data = cache_get_multiple($keys, $export['default cache bin']);
  663. // If any of our indexed keys missed, then we have a fail and we need to
  664. // rebuild.
  665. if (!empty($keys)) {
  666. return;
  667. }
  668. // Now, translate the returned cache objects to actual objects.
  669. $cache = array();
  670. foreach ($data as $cached_object) {
  671. $cache[$cached_object->data->{$export['key']}] = $cached_object->data;
  672. }
  673. return $cache;
  674. }
  675. /**
  676. * Get a limited number of default objects.
  677. *
  678. * This attempts to load the objects directly from cache. If it cannot,
  679. * the cache is rebuilt. This does not disturb the general get defaults
  680. * from cache object.
  681. *
  682. * This function should ONLY be called if default caching is enabled.
  683. * It does not check, it is assumed the caller has already done so.
  684. */
  685. function _ctools_export_get_some_defaults($table, $export, $names) {
  686. foreach ($names as $name) {
  687. $keys[] = 'ctools_export:' . $table . ':' . $name;
  688. }
  689. $data = cache_get_multiple($keys, $export['default cache bin']);
  690. // Cache hits remove the $key from $keys by reference. Cache
  691. // misses do not. A cache miss indicates we may have to rebuild.
  692. if (!empty($keys)) {
  693. return _ctools_export_get_defaults($table, $export);
  694. }
  695. // Now, translate the returned cache objects to actual objects.
  696. $cache = array();
  697. foreach ($data as $cached_object) {
  698. $cache[$cached_object->data->{$export['key']}] = $cached_object->data;
  699. }
  700. return $cache;
  701. }
  702. /**
  703. * Unpack data loaded from the database onto an object.
  704. *
  705. * @param $schema
  706. * The schema from drupal_get_schema().
  707. * @param $data
  708. * The data as loaded from the database.
  709. * @param $object
  710. * If an object, data will be unpacked onto it. If a string
  711. * an object of that type will be created.
  712. */
  713. function _ctools_export_unpack_object($schema, $data, $object = 'stdClass') {
  714. if (is_string($object)) {
  715. if (class_exists($object)) {
  716. $object = new $object;
  717. }
  718. else {
  719. $object = new stdClass;
  720. }
  721. }
  722. // Go through our schema and build correlations.
  723. foreach ($schema['fields'] as $field => $info) {
  724. if (isset($data->$field)) {
  725. $object->$field = empty($info['serialize']) ? $data->$field : unserialize($data->$field);
  726. }
  727. else {
  728. $object->$field = NULL;
  729. }
  730. }
  731. if (isset($schema['join'])) {
  732. foreach ($schema['join'] as $join_key => $join) {
  733. $join_schema = ctools_export_get_schema($join['table']);
  734. if (!empty($join['load'])) {
  735. foreach ($join['load'] as $field) {
  736. $info = $join_schema['fields'][$field];
  737. $object->$field = empty($info['serialize']) ? $data->$field : unserialize($data->$field);
  738. }
  739. }
  740. }
  741. }
  742. return $object;
  743. }
  744. /**
  745. * Unpack data loaded from the database onto an object.
  746. *
  747. * @param $table
  748. * The name of the table this object represents.
  749. * @param $data
  750. * The data as loaded from the database.
  751. */
  752. function ctools_export_unpack_object($table, $data) {
  753. $schema = ctools_export_get_schema($table);
  754. return _ctools_export_unpack_object($schema, $data, $schema['export']['object']);
  755. }
  756. /**
  757. * Export a field.
  758. *
  759. * This is a replacement for var_export(), allowing us to more nicely
  760. * format exports. It will recurse down into arrays and will try to
  761. * properly export bools when it can, though PHP has a hard time with
  762. * this since they often end up as strings or ints.
  763. */
  764. function ctools_var_export($var, $prefix = '') {
  765. if (is_array($var)) {
  766. if (empty($var)) {
  767. $output = 'array()';
  768. }
  769. else {
  770. $output = "array(\n";
  771. foreach ($var as $key => $value) {
  772. $output .= $prefix . " " . ctools_var_export($key) . " => " . ctools_var_export($value, $prefix . ' ') . ",\n";
  773. }
  774. $output .= $prefix . ')';
  775. }
  776. }
  777. else if (is_object($var) && get_class($var) === 'stdClass') {
  778. // var_export() will export stdClass objects using an undefined
  779. // magic method __set_state() leaving the export broken. This
  780. // workaround avoids this by casting the object as an array for
  781. // export and casting it back to an object when evaluated.
  782. $output = '(object) ' . ctools_var_export((array) $var, $prefix);
  783. }
  784. else if (is_bool($var)) {
  785. $output = $var ? 'TRUE' : 'FALSE';
  786. }
  787. else {
  788. $output = var_export($var, TRUE);
  789. }
  790. return $output;
  791. }
  792. /**
  793. * Export an object into code.
  794. */
  795. function ctools_export_object($table, $object, $indent = '', $identifier = NULL, $additions = array(), $additions2 = array()) {
  796. $schema = ctools_export_get_schema($table);
  797. if (!isset($identifier)) {
  798. $identifier = $schema['export']['identifier'];
  799. }
  800. $output = $indent . '$' . $identifier . ' = new ' . get_class($object) . "();\n";
  801. if ($schema['export']['can disable']) {
  802. $output .= $indent . '$' . $identifier . '->disabled = FALSE; /* Edit this to true to make a default ' . $identifier . ' disabled initially */' . "\n";
  803. }
  804. if (!empty($schema['export']['api']['current_version'])) {
  805. $output .= $indent . '$' . $identifier . '->api_version = ' . $schema['export']['api']['current_version'] . ";\n";
  806. }
  807. // Put top additions here:
  808. foreach ($additions as $field => $value) {
  809. $output .= $indent . '$' . $identifier . '->' . $field . ' = ' . ctools_var_export($value, $indent) . ";\n";
  810. }
  811. $fields = $schema['fields'];
  812. if (!empty($schema['join'])) {
  813. foreach ($schema['join'] as $join) {
  814. if (!empty($join['load'])) {
  815. foreach ($join['load'] as $join_field) {
  816. $fields[$join_field] = $join['fields'][$join_field];
  817. }
  818. }
  819. }
  820. }
  821. // Go through our schema and joined tables and build correlations.
  822. foreach ($fields as $field => $info) {
  823. if (!empty($info['no export'])) {
  824. continue;
  825. }
  826. if (!isset($object->$field)) {
  827. if (isset($info['default'])) {
  828. $object->$field = $info['default'];
  829. }
  830. else {
  831. $object->$field = '';
  832. }
  833. }
  834. // Note: This is the *field* export callback, not the table one!
  835. if (!empty($info['export callback']) && function_exists($info['export callback'])) {
  836. $output .= $indent . '$' . $identifier . '->' . $field . ' = ' . $info['export callback']($object, $field, $object->$field, $indent) . ";\n";
  837. }
  838. else {
  839. $value = $object->$field;
  840. if ($info['type'] == 'int') {
  841. if (isset($info['size']) && $info['size'] == 'tiny') {
  842. $info['boolean'] = (!isset($info['boolean'])) ? $schema['export']['boolean'] : $info['boolean'];
  843. $value = ($info['boolean']) ? (bool) $value : (int) $value;
  844. }
  845. else {
  846. $value = (int) $value;
  847. }
  848. }
  849. $output .= $indent . '$' . $identifier . '->' . $field . ' = ' . ctools_var_export($value, $indent) . ";\n";
  850. }
  851. }
  852. // And bottom additions here
  853. foreach ($additions2 as $field => $value) {
  854. $output .= $indent . '$' . $identifier . '->' . $field . ' = ' . ctools_var_export($value, $indent) . ";\n";
  855. }
  856. return $output;
  857. }
  858. /**
  859. * Get the schema for a given table.
  860. *
  861. * This looks for data the export subsystem needs and applies defaults so
  862. * that it's easily available.
  863. */
  864. function ctools_export_get_schema($table) {
  865. static $drupal_static_fast;
  866. if (!isset($drupal_static_fast)) {
  867. $drupal_static_fast['cache'] = &drupal_static(__FUNCTION__);
  868. }
  869. $cache = &$drupal_static_fast['cache'];
  870. if (empty($cache[$table])) {
  871. $schema = drupal_get_schema($table);
  872. // If our schema isn't loaded, it's possible we're in a state where it
  873. // simply hasn't been cached. If we've been asked, let's force the
  874. // issue.
  875. if (!$schema || empty($schema['export'])) {
  876. // force a schema reset:
  877. $schema = drupal_get_schema($table, TRUE);
  878. }
  879. if (!isset($schema['export'])) {
  880. return array();
  881. }
  882. if (empty($schema['module'])) {
  883. return array();
  884. }
  885. // Add some defaults
  886. $schema['export'] += array(
  887. 'key' => 'name',
  888. 'key name' => 'Name',
  889. 'object' => 'stdClass',
  890. 'status' => 'default_' . $table,
  891. 'default hook' => 'default_' . $table,
  892. 'can disable' => TRUE,
  893. 'identifier' => $table,
  894. 'primary key' => !empty($schema['primary key']) ? $schema['primary key'][0] : '',
  895. 'bulk export' => TRUE,
  896. 'list callback' => "$schema[module]_{$table}_list",
  897. 'to hook code callback' => "$schema[module]_{$table}_to_hook_code",
  898. 'cache defaults' => FALSE,
  899. 'default cache bin' => 'cache',
  900. 'export type string' => 'type',
  901. 'boolean' => TRUE,
  902. );
  903. // If the export definition doesn't have the "primary key" then the CRUD
  904. // save callback won't work.
  905. if (empty($schema['export']['primary key']) && user_access('administer site configuration')) {
  906. drupal_set_message(t('The export definition of @table is missing the "primary key" property.', array('@table' => $table)), 'error');
  907. }
  908. // Notes:
  909. // The following callbacks may be defined to override default behavior
  910. // when using CRUD functions:
  911. //
  912. // create callback
  913. // load callback
  914. // load multiple callback
  915. // load all callback
  916. // save callback
  917. // delete callback
  918. // export callback
  919. // import callback
  920. //
  921. // See the appropriate ctools_export_crud function for details on what
  922. // arguments these callbacks should accept. Please do not call these
  923. // directly, always use the ctools_export_crud_* wrappers to ensure
  924. // that default implementations are honored.
  925. $cache[$table] = $schema;
  926. }
  927. return $cache[$table];
  928. }
  929. /**
  930. * Gets the schemas for all tables with ctools object metadata.
  931. */
  932. function ctools_export_get_schemas($for_export = FALSE) {
  933. $export_tables = &drupal_static(__FUNCTION__);
  934. if (is_null($export_tables)) {
  935. $export_tables = array();
  936. $schemas = drupal_get_schema();
  937. foreach ($schemas as $table => $schema) {
  938. if (!isset($schema['export'])) {
  939. unset($schemas[$table]);
  940. continue;
  941. }
  942. $export_tables[$table] = ctools_export_get_schema($table);
  943. }
  944. }
  945. return $for_export ? array_filter($export_tables, '_ctools_export_filter_export_tables') : $export_tables;
  946. }
  947. function _ctools_export_filter_export_tables($schema) {
  948. return !empty($schema['export']['bulk export']);
  949. }
  950. function ctools_export_get_schemas_by_module($modules = array(), $for_export = FALSE) {
  951. $export_tables = array();
  952. $list = ctools_export_get_schemas($for_export);
  953. foreach ($list as $table => $schema) {
  954. $export_tables[$schema['module']][$table] = $schema;
  955. }
  956. return empty($modules) ? $export_tables : array_keys($export_tables, $modules);
  957. }
  958. /**
  959. * Set the status of a default $object as a variable.
  960. *
  961. * The status, in this case, is whether or not it is 'disabled'.
  962. * This function does not check to make sure $object actually
  963. * exists.
  964. */
  965. function ctools_export_set_status($table, $name, $new_status = TRUE) {
  966. $schema = ctools_export_get_schema($table);
  967. $status = variable_get($schema['export']['status'], array());
  968. $status[$name] = $new_status;
  969. variable_set($schema['export']['status'], $status);
  970. }
  971. /**
  972. * Set the status of a default $object as a variable.
  973. *
  974. * This is more efficient than ctools_export_set_status because it
  975. * will actually unset the variable entirely if it's not necessary,
  976. * this saving a bit of space.
  977. */
  978. function ctools_export_set_object_status($object, $new_status = TRUE) {
  979. $table = $object->table;
  980. $schema = ctools_export_get_schema($table);
  981. $export = $schema['export'];
  982. $status = variable_get($export['status'], array());
  983. // Compare
  984. if (!$new_status && $object->export_type & EXPORT_IN_DATABASE) {
  985. unset($status[$object->{$export['key']}]);
  986. }
  987. else {
  988. $status[$object->{$export['key']}] = $new_status;
  989. }
  990. variable_set($export['status'], $status);
  991. }
  992. /**
  993. * Provide a form for displaying an export.
  994. *
  995. * This is a simple form that should be invoked like this:
  996. * @code
  997. * $output = drupal_get_form('ctools_export_form', $code, $object_title);
  998. * @endcode
  999. */
  1000. function ctools_export_form($form, &$form_state, $code, $title = '') {
  1001. $lines = substr_count($code, "\n");
  1002. $form['code'] = array(
  1003. '#type' => 'textarea',
  1004. '#title' => $title,
  1005. '#default_value' => $code,
  1006. '#rows' => $lines,
  1007. );
  1008. return $form;
  1009. }
  1010. /**
  1011. * Create a new object based upon schema values.
  1012. *
  1013. * Because 'default' has ambiguous meaning on some fields, we will actually
  1014. * use 'object default' to fill in default values if default is not set
  1015. * That's a little safer to use as it won't cause weird database default
  1016. * situations.
  1017. */
  1018. function ctools_export_new_object($table, $set_defaults = TRUE) {
  1019. $schema = ctools_export_get_schema($table);
  1020. $export = $schema['export'];
  1021. $object = new $export['object'];
  1022. foreach ($schema['fields'] as $field => $info) {
  1023. if (isset($info['object default'])) {
  1024. $object->$field = $info['object default'];
  1025. }
  1026. else if (isset($info['default'])) {
  1027. $object->$field = $info['default'];
  1028. }
  1029. else {
  1030. $object->$field = NULL;
  1031. }
  1032. }
  1033. if ($set_defaults) {
  1034. // Set some defaults so this data always exists.
  1035. // We don't set the export_type property here, as this object is not saved
  1036. // yet. We do give it NULL so we don't generate notices trying to read it.
  1037. $object->export_type = NULL;
  1038. $object->{$export['export type string']} = t('Local');
  1039. }
  1040. return $object;
  1041. }
  1042. /**
  1043. * Convert a group of objects to code based upon input and return this as a larger
  1044. * export.
  1045. */
  1046. function ctools_export_to_hook_code(&$code, $table, $names = array(), $name = 'foo') {
  1047. $schema = ctools_export_get_schema($table);
  1048. $export = $schema['export'];
  1049. // Use the schema-specified function for generating hook code, if one exists
  1050. if (function_exists($export['to hook code callback'])) {
  1051. $output = $export['to hook code callback']($names, $name);
  1052. }
  1053. // Otherwise, the following code generates basic hook code
  1054. else {
  1055. $output = ctools_export_default_to_hook_code($schema, $table, $names, $name);
  1056. }
  1057. if (!empty($output)) {
  1058. if (isset($export['api'])) {
  1059. if (isset($code[$export['api']['owner']][$export['api']['api']]['version'])) {
  1060. $code[$export['api']['owner']][$export['api']['api']]['version'] = max($code[$export['api']['owner']][$export['api']['api']]['version'], $export['api']['minimum_version']);
  1061. }
  1062. else {
  1063. $code[$export['api']['owner']][$export['api']['api']]['version'] = $export['api']['minimum_version'];
  1064. $code[$export['api']['owner']][$export['api']['api']]['code'] = '';
  1065. }
  1066. $code[$export['api']['owner']][$export['api']['api']]['code'] .= $output;
  1067. }
  1068. else {
  1069. if (empty($code['general'])) {
  1070. $code['general'] = '';
  1071. }
  1072. $code['general'] .= $output;
  1073. }
  1074. }
  1075. }
  1076. /**
  1077. * Default function to export objects to code.
  1078. *
  1079. * Note that if your module provides a 'to hook code callback' then it will
  1080. * receive only $names and $name as arguments. Your module is presumed to
  1081. * already know the rest.
  1082. */
  1083. function ctools_export_default_to_hook_code($schema, $table, $names, $name) {
  1084. $export = $schema['export'];
  1085. $output = '';
  1086. $objects = ctools_export_crud_load_multiple($table, $names);
  1087. if ($objects) {
  1088. $output = "/**\n";
  1089. $output .= " * Implements hook_{$export['default hook']}().\n";
  1090. $output .= " */\n";
  1091. $output .= "function " . $name . "_{$export['default hook']}() {\n";
  1092. $output .= " \${$export['identifier']}s = array();\n\n";
  1093. foreach ($objects as $object) {
  1094. $output .= ctools_export_crud_export($table, $object, ' ');
  1095. $output .= " \${$export['identifier']}s['" . check_plain($object->$export['key']) . "'] = \${$export['identifier']};\n\n";
  1096. }
  1097. $output .= " return \${$export['identifier']}s;\n";
  1098. $output .= "}\n";
  1099. }
  1100. return $output;
  1101. }
  1102. /**
  1103. * Default function for listing bulk exportable objects.
  1104. */
  1105. function ctools_export_default_list($table, $schema) {
  1106. $list = array();
  1107. $items = ctools_export_crud_load_all($table);
  1108. $export_key = $schema['export']['key'];
  1109. foreach ($items as $item) {
  1110. // Try a couple of possible obvious title keys:
  1111. $keys = array('admin_title', 'title');
  1112. if (isset($schema['export']['admin_title'])) {
  1113. array_unshift($keys, $schema['export']['admin_title']);
  1114. }
  1115. $string = '';
  1116. foreach ($keys as $key) {
  1117. if (!empty($item->$key)) {
  1118. $string = $item->$key . " (" . $item->$export_key . ")";
  1119. break;
  1120. }
  1121. }
  1122. if (empty($string)) {
  1123. $string = $item->$export_key;
  1124. }
  1125. $list[$item->$export_key] = check_plain($string);
  1126. }
  1127. return $list;
  1128. }