danielebarchiesi@0: <?php
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @file
danielebarchiesi@0:  * Provide a tool for creating UIs for exportable objects.
danielebarchiesi@0:  *
danielebarchiesi@0:  * See Advanced Help for documentation.
danielebarchiesi@0:  */
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Process an export-ui plugin to provide it with defaults.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_export_ui_process(&$plugin, $info) {
danielebarchiesi@0:   ctools_include('export');
danielebarchiesi@0: 
danielebarchiesi@0:   $plugin += array(
danielebarchiesi@0:     'has menu' => TRUE,
danielebarchiesi@0:     'title' => $plugin['name'],
danielebarchiesi@0:     'export' => array(),
danielebarchiesi@0:     'allowed operations' => array(),
danielebarchiesi@0:     'menu' => array(),
danielebarchiesi@0:     'redirect' => array(),
danielebarchiesi@0:     'form' => array(),
danielebarchiesi@0:     'strings' => array(),
danielebarchiesi@0:     'list' => NULL,
danielebarchiesi@0:     'access' => 'administer site configuration',
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   // Provide CRUD access defaults based on the base 'access' setting:
danielebarchiesi@0:   $plugin += array(
danielebarchiesi@0:     'create access' => $plugin['access'],
danielebarchiesi@0:     'delete access' => $plugin['access'],
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   if (empty($plugin['has menu'])) {
danielebarchiesi@0:     return;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // The following keys are required and the plugin cannot be processed
danielebarchiesi@0:   // without them.
danielebarchiesi@0:   $keys = array(
danielebarchiesi@0:     'title singular',
danielebarchiesi@0:     'title plural',
danielebarchiesi@0:     'title singular proper',
danielebarchiesi@0:     'title plural proper',
danielebarchiesi@0:     'schema',
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   foreach ($keys as $key) {
danielebarchiesi@0:     if (empty($plugin[$key])) {
danielebarchiesi@0:       drupal_set_message(t('The plugin definition of @plugin is missing the %key key.', array('%key' => $key, '@plugin' => $plugin['name'])), 'error');
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // If we're on the modules page and building a menu, there is a design flaw
danielebarchiesi@0:   // in Drupal core that causes modules to be installed but the schema does
danielebarchiesi@0:   // not become available until AFTER menu rebuild. This helps smooth that
danielebarchiesi@0:   // out. This is a HACK but it should work:
danielebarchiesi@0:   $schema = ctools_export_get_schema($plugin['schema']);
danielebarchiesi@0: 
danielebarchiesi@0:   if (empty($schema)) {
danielebarchiesi@0:     // If we're updating the schema may not have been read yet, so don't report this error in that case.
danielebarchiesi@0:     if (!defined('MAINTENANCE_MODE')) {
danielebarchiesi@0:       drupal_set_message(t('The plugin definition of @plugin cannot locate schema %schema.', array('%schema' => $plugin['schema'], '@plugin' => $plugin['name'])), 'error');
danielebarchiesi@0:     }
danielebarchiesi@0:     return;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (empty($schema['export'])) {
danielebarchiesi@0:     drupal_set_message(t('The plugin definition of @plugin uses %schema, but it has no export section.', array('%schema' => $plugin['schema'], '@plugin' => $plugin['name'])), 'error');
danielebarchiesi@0:     return;
danielebarchiesi@0:   }
danielebarchiesi@0:   $plugin['export'] += $schema['export'];
danielebarchiesi@0: 
danielebarchiesi@0:   $plugin['export'] += array(
danielebarchiesi@0:     // Add the identifier key from the schema so we don't have to call
danielebarchiesi@0:     // ctools_export_get_schema() just for that.
danielebarchiesi@0:     'key' => $schema['export']['key'],
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   // Add some default fields that appear often in exports
danielebarchiesi@0:   // If these use different keys they can easily be specified in the
danielebarchiesi@0:   // $plugin.
danielebarchiesi@0: 
danielebarchiesi@0:   if (empty($plugin['export']['admin_title']) && !empty($schema['fields']['admin_title'])) {
danielebarchiesi@0:     $plugin['export']['admin_title'] = 'admin_title';
danielebarchiesi@0:   }
danielebarchiesi@0:   if (empty($plugin['export']['admin_description']) && !empty($schema['fields']['admin_description'])) {
danielebarchiesi@0:     $plugin['export']['admin_description'] = 'admin_description';
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Define allowed operations, and the name of the operations.
danielebarchiesi@0:   $plugin['allowed operations'] += array(
danielebarchiesi@0:     'edit'    => array('title' => t('Edit')),
danielebarchiesi@0:     'enable'  => array('title' => t('Enable'), 'ajax' => TRUE, 'token' => TRUE),
danielebarchiesi@0:     'disable' => array('title' => t('Disable'), 'ajax' => TRUE, 'token' => TRUE),
danielebarchiesi@0:     'revert'  => array('title' => t('Revert')),
danielebarchiesi@0:     'delete'  => array('title' => t('Delete')),
danielebarchiesi@0:     'clone'   => array('title' => t('Clone')),
danielebarchiesi@0:     'import'  => array('title' => t('Import')),
danielebarchiesi@0:     'export'  => array('title' => t('Export')),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $plugin['menu'] += array(
danielebarchiesi@0:     'menu item' => str_replace(' ', '-', $plugin['name']),
danielebarchiesi@0:     'menu prefix' => 'admin/structure',
danielebarchiesi@0:     'menu title' => $plugin['title'],
danielebarchiesi@0:     'menu description' => '',
danielebarchiesi@0:   );
danielebarchiesi@0:   $base_path = ctools_export_ui_plugin_base_path($plugin);
danielebarchiesi@0:   $prefix_count = count(explode('/', $plugin['menu']['menu prefix']));
danielebarchiesi@0: 
danielebarchiesi@0:   $plugin['menu'] += array(
danielebarchiesi@0:     // Default menu items that should be declared.
danielebarchiesi@0:     'items' => array(),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $plugin['menu']['items'] += array(
danielebarchiesi@0:     'list callback' => array(),
danielebarchiesi@0:     'list' => array(),
danielebarchiesi@0:     'add' => array(),
danielebarchiesi@0:     'edit callback' => array(),
danielebarchiesi@0:     'edit' => array(),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $plugin['menu']['items']['list callback'] += array(
danielebarchiesi@0:     'path' => '',
danielebarchiesi@0:     // Menu items are translated by the menu system.
danielebarchiesi@0:     // TODO: We need more flexibility in title. The title of the admin page
danielebarchiesi@0:     // is not necessarily the title of the object, plus we need
danielebarchiesi@0:     // plural, singular, proper, not proper, etc.
danielebarchiesi@0:     'title' => $plugin['menu']['menu title'],
danielebarchiesi@0:     'description' => $plugin['menu']['menu description'],
danielebarchiesi@0:     'page callback' => 'ctools_export_ui_switcher_page',
danielebarchiesi@0:     'page arguments' => array($plugin['name'], 'list'),
danielebarchiesi@0:     'access callback' => 'ctools_export_ui_task_access',
danielebarchiesi@0:     'access arguments' => array($plugin['name'], 'list'),
danielebarchiesi@0:     'type' => MENU_NORMAL_ITEM,
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $plugin['menu']['items']['list'] += array(
danielebarchiesi@0:     'path' => 'list',
danielebarchiesi@0:     'title' => 'List',
danielebarchiesi@0:     'page callback' => 'ctools_export_ui_switcher_page',
danielebarchiesi@0:     'page arguments' => array($plugin['name'], 'list'),
danielebarchiesi@0:     'access callback' => 'ctools_export_ui_task_access',
danielebarchiesi@0:     'access arguments' => array($plugin['name'], 'list'),
danielebarchiesi@0:     'type' => MENU_DEFAULT_LOCAL_TASK,
danielebarchiesi@0:     'weight' => -10,
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $plugin['menu']['items']['add'] += array(
danielebarchiesi@0:     'path' => 'add',
danielebarchiesi@0:     'title' => 'Add',
danielebarchiesi@0:     'page callback' => 'ctools_export_ui_switcher_page',
danielebarchiesi@0:     'page arguments' => array($plugin['name'], 'add'),
danielebarchiesi@0:     'access callback' => 'ctools_export_ui_task_access',
danielebarchiesi@0:     'access arguments' => array($plugin['name'], 'add'),
danielebarchiesi@0:     'type' => MENU_LOCAL_ACTION,
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $plugin['menu']['items']['edit callback'] += array(
danielebarchiesi@0:     'path' => 'list/%ctools_export_ui',
danielebarchiesi@0:     'page callback' => 'ctools_export_ui_switcher_page',
danielebarchiesi@0:     'page arguments' => array($plugin['name'], 'edit', $prefix_count + 2),
danielebarchiesi@0:     'load arguments' => array($plugin['name']),
danielebarchiesi@0:     'access callback' => 'ctools_export_ui_task_access',
danielebarchiesi@0:     'access arguments' => array($plugin['name'], 'edit', $prefix_count + 2),
danielebarchiesi@0:     'type' => MENU_CALLBACK,
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $plugin['menu']['items']['edit'] += array(
danielebarchiesi@0:     'path' => 'list/%ctools_export_ui/edit',
danielebarchiesi@0:     'title' => 'Edit',
danielebarchiesi@0:     'page callback' => 'ctools_export_ui_switcher_page',
danielebarchiesi@0:     'page arguments' => array($plugin['name'], 'edit', $prefix_count + 2),
danielebarchiesi@0:     'load arguments' => array($plugin['name']),
danielebarchiesi@0:     'access callback' => 'ctools_export_ui_task_access',
danielebarchiesi@0:     'access arguments' => array($plugin['name'], 'edit', $prefix_count + 2),
danielebarchiesi@0:     'type' => MENU_DEFAULT_LOCAL_TASK,
danielebarchiesi@0:     'weight' => -10,
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   if ($plugin['allowed operations']['import']) {
danielebarchiesi@0:     $plugin['menu']['items'] += array('import' => array());
danielebarchiesi@0:     $plugin['menu']['items']['import'] += array(
danielebarchiesi@0:       'path' => 'import',
danielebarchiesi@0:       'title' => 'Import',
danielebarchiesi@0:       'page callback' => 'ctools_export_ui_switcher_page',
danielebarchiesi@0:       'page arguments' => array($plugin['name'], 'import'),
danielebarchiesi@0:       'access callback' => 'ctools_export_ui_task_access',
danielebarchiesi@0:       'access arguments' => array($plugin['name'], 'import'),
danielebarchiesi@0:       'type' => MENU_LOCAL_ACTION,
danielebarchiesi@0:     );
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if ($plugin['allowed operations']['export']) {
danielebarchiesi@0:     $plugin['menu']['items'] += array('export' => array());
danielebarchiesi@0:     $plugin['menu']['items']['export'] += array(
danielebarchiesi@0:       'path' => 'list/%ctools_export_ui/export',
danielebarchiesi@0:       'title' => 'Export',
danielebarchiesi@0:       'page callback' => 'ctools_export_ui_switcher_page',
danielebarchiesi@0:       'page arguments' => array($plugin['name'], 'export', $prefix_count + 2),
danielebarchiesi@0:       'load arguments' => array($plugin['name']),
danielebarchiesi@0:       'access callback' => 'ctools_export_ui_task_access',
danielebarchiesi@0:       'access arguments' => array($plugin['name'], 'export', $prefix_count + 2),
danielebarchiesi@0:       'type' => MENU_LOCAL_TASK,
danielebarchiesi@0:     );
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if ($plugin['allowed operations']['revert']) {
danielebarchiesi@0:     $plugin['menu']['items'] += array('revert' => array());
danielebarchiesi@0:     $plugin['menu']['items']['revert'] += array(
danielebarchiesi@0:       'path' => 'list/%ctools_export_ui/revert',
danielebarchiesi@0:       'title' => 'Revert',
danielebarchiesi@0:       'page callback' => 'ctools_export_ui_switcher_page',
danielebarchiesi@0:       // Note: Yes, 'delete' op is correct.
danielebarchiesi@0:       'page arguments' => array($plugin['name'], 'delete', $prefix_count + 2),
danielebarchiesi@0:       'load arguments' => array($plugin['name']),
danielebarchiesi@0:       'access callback' => 'ctools_export_ui_task_access',
danielebarchiesi@0:       'access arguments' => array($plugin['name'], 'revert', $prefix_count + 2),
danielebarchiesi@0:       'type' => MENU_CALLBACK,
danielebarchiesi@0:     );
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if ($plugin['allowed operations']['delete']) {
danielebarchiesi@0:     $plugin['menu']['items'] += array('delete' => array());
danielebarchiesi@0:     $plugin['menu']['items']['delete'] += array(
danielebarchiesi@0:       'path' => 'list/%ctools_export_ui/delete',
danielebarchiesi@0:       'title' => 'Delete',
danielebarchiesi@0:       'page callback' => 'ctools_export_ui_switcher_page',
danielebarchiesi@0:       'page arguments' => array($plugin['name'], 'delete', $prefix_count + 2),
danielebarchiesi@0:       'load arguments' => array($plugin['name']),
danielebarchiesi@0:       'access callback' => 'ctools_export_ui_task_access',
danielebarchiesi@0:       'access arguments' => array($plugin['name'], 'delete', $prefix_count + 2),
danielebarchiesi@0:       'type' => MENU_CALLBACK,
danielebarchiesi@0:     );
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if ($plugin['allowed operations']['clone']) {
danielebarchiesi@0:     $plugin['menu']['items'] += array('clone' => array());
danielebarchiesi@0:     $plugin['menu']['items']['clone'] += array(
danielebarchiesi@0:       'path' => 'list/%ctools_export_ui/clone',
danielebarchiesi@0:       'title' => 'Clone',
danielebarchiesi@0:       'page callback' => 'ctools_export_ui_switcher_page',
danielebarchiesi@0:       'page arguments' => array($plugin['name'], 'clone', $prefix_count + 2),
danielebarchiesi@0:       'load arguments' => array($plugin['name']),
danielebarchiesi@0:       'access callback' => 'ctools_export_ui_task_access',
danielebarchiesi@0:       'access arguments' => array($plugin['name'], 'clone', $prefix_count + 2),
danielebarchiesi@0:       'type' => MENU_CALLBACK,
danielebarchiesi@0:     );
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if ($plugin['allowed operations']['enable']) {
danielebarchiesi@0:     $plugin['menu']['items'] += array('enable' => array());
danielebarchiesi@0:     $plugin['menu']['items']['enable'] += array(
danielebarchiesi@0:       'path' => 'list/%ctools_export_ui/enable',
danielebarchiesi@0:       'title' => 'Enable',
danielebarchiesi@0:       'page callback' => 'ctools_export_ui_switcher_page',
danielebarchiesi@0:       'page arguments' => array($plugin['name'], 'enable', $prefix_count + 2),
danielebarchiesi@0:       'load arguments' => array($plugin['name']),
danielebarchiesi@0:       'access callback' => 'ctools_export_ui_task_access',
danielebarchiesi@0:       'access arguments' => array($plugin['name'], 'enable', $prefix_count + 2),
danielebarchiesi@0:       'type' => MENU_CALLBACK,
danielebarchiesi@0:     );
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if ($plugin['allowed operations']['disable']) {
danielebarchiesi@0:     $plugin['menu']['items'] += array('disable' => array());
danielebarchiesi@0:     $plugin['menu']['items']['disable'] += array(
danielebarchiesi@0:       'path' => 'list/%ctools_export_ui/disable',
danielebarchiesi@0:       'title' => 'Disable',
danielebarchiesi@0:       'page callback' => 'ctools_export_ui_switcher_page',
danielebarchiesi@0:       'page arguments' => array($plugin['name'], 'disable', $prefix_count + 2),
danielebarchiesi@0:       'load arguments' => array($plugin['name']),
danielebarchiesi@0:       'access callback' => 'ctools_export_ui_task_access',
danielebarchiesi@0:       'access arguments' => array($plugin['name'], 'disable', $prefix_count + 2),
danielebarchiesi@0:       'type' => MENU_CALLBACK,
danielebarchiesi@0:     );
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Define some redirects that should happen after edit/add/clone/delete operations.
danielebarchiesi@0:   $plugin['redirect'] += array(
danielebarchiesi@0:     'add' => $base_path,
danielebarchiesi@0:     'clone' => $base_path,
danielebarchiesi@0:     'edit' => $base_path,
danielebarchiesi@0:     'delete' => $base_path,
danielebarchiesi@0:     'revert' => $base_path,
danielebarchiesi@0:     'import' => $base_path,
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   // Define form elements.
danielebarchiesi@0:   $plugin['form'] += array(
danielebarchiesi@0:     'settings' => function_exists($plugin['name'] . '_form') ? $plugin['name'] . '_form' : '',
danielebarchiesi@0:     'validate' => function_exists($plugin['name'] . '_form_validate') ? $plugin['name'] . '_form_validate' : '',
danielebarchiesi@0:     'submit' => function_exists($plugin['name'] . '_form_submit') ? $plugin['name'] . '_form_submit' : '',
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   // Define strings.
danielebarchiesi@0: 
danielebarchiesi@0:   // For all strings, %title may be filled in at a later time via str_replace
danielebarchiesi@0:   // since we do not know the title now.
danielebarchiesi@0:   $plugin['strings'] += array(
danielebarchiesi@0:     'title' => array(),
danielebarchiesi@0:     'confirmation' => array(),
danielebarchiesi@0:     'help' => array(),
danielebarchiesi@0:     'message' => array(),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   // Strings used in drupal_set_title().
danielebarchiesi@0:   $plugin['strings']['title'] += array(
danielebarchiesi@0:     'add' => t('Add a new @plugin', array('@plugin' => $plugin['title singular'])),
danielebarchiesi@0:     // The "%title" will be replaced in ctools_export_ui_form(), as in this
danielebarchiesi@0:     // stage we dont have the specific exportable object.
danielebarchiesi@0:     'edit' => t('Edit @plugin %title', array('@plugin' => $plugin['title singular'])),
danielebarchiesi@0:     'clone' => t('Clone @plugin %title', array('@plugin' => $plugin['title singular'])),
danielebarchiesi@0: 
danielebarchiesi@0:     'import' => t('Import @plugin', array('@plugin' => $plugin['title singular'])),
danielebarchiesi@0:     'export' => t('Export @plugin %title', array('@plugin' => $plugin['title singular'])),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   // Strings used in confirmation pages.
danielebarchiesi@0:   $plugin['strings']['confirmation'] += array(
danielebarchiesi@0:     'revert' => array(),
danielebarchiesi@0:     'delete' => array(),
danielebarchiesi@0:     'add' => array(),
danielebarchiesi@0:     'edit' => array(),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $plugin['strings']['confirmation']['revert'] += array(
danielebarchiesi@0:     'question' => t('Are you sure you want to revert %title?'),
danielebarchiesi@0:     'information' => t('This action will permanently remove any customizations made to this item.'),
danielebarchiesi@0:     'success' => t('The item has been reverted.'),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $plugin['strings']['confirmation']['delete'] += array(
danielebarchiesi@0:     'question' => t('Are you sure you want to delete %title?'),
danielebarchiesi@0:     'information' => t('This action will permanently remove this item from your database..'),
danielebarchiesi@0:     'success' => t('The item has been deleted.'),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $plugin['strings']['confirmation']['add'] += array(
danielebarchiesi@0:     'success' => t('%title has been created.'),
danielebarchiesi@0:     'fail' => t('%title could not be created.'),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $plugin['strings']['confirmation']['edit'] += array(
danielebarchiesi@0:     'success' => t('%title has been updated.'),
danielebarchiesi@0:     'fail' => t('%title could not be updated.'),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   // Strings used in $forms.
danielebarchiesi@0:   $plugin['strings']['help'] += array(
danielebarchiesi@0:     'import' => t('You can import an exported definition by pasting the exported object code into the field below.'),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   // Strings used in drupal_set_message().
danielebarchiesi@0:   $plugin['strings']['message'] += array(
danielebarchiesi@0:     'enable' => t('@plugin %title was enabled.', array('@plugin' => $plugin['title singular proper'])),
danielebarchiesi@0:     'disable' => t('@plugin %title was disabled.', array('@plugin' => $plugin['title singular proper'])),
danielebarchiesi@0:     'no items' => t('There are no @titles to display.', array('@titles' => $plugin['title plural'])),
danielebarchiesi@0:   );
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Get the class to handle creating a list of exportable items.
danielebarchiesi@0:  *
danielebarchiesi@0:  * If a plugin does not define a lister class at all, then the default
danielebarchiesi@0:  * lister class will be used.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   Either the lister class or FALSE if one could not be had.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_export_ui_get_handler($plugin) {
danielebarchiesi@0:   $cache = &drupal_static(__FUNCTION__, array());
danielebarchiesi@0:   if (empty($cache[$plugin['name']])) {
danielebarchiesi@0:     // If a list class is not specified by the plugin, fall back to the
danielebarchiesi@0:     // default ctools_export_ui plugin instead.
danielebarchiesi@0:     if (empty($plugin['handler'])) {
danielebarchiesi@0:       $default = ctools_get_export_ui('ctools_export_ui');
danielebarchiesi@0:       $class = ctools_plugin_get_class($default, 'handler');
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       $class = ctools_plugin_get_class($plugin, 'handler');
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if ($class) {
danielebarchiesi@0:       $cache[$plugin['name']] = new $class();
danielebarchiesi@0:       $cache[$plugin['name']]->init($plugin);
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0:   return !empty($cache[$plugin['name']]) ? $cache[$plugin['name']] : FALSE;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Get the base path from a plugin.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $plugin
danielebarchiesi@0:  *   The plugin.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   The menu path to the plugin's list.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_export_ui_plugin_base_path($plugin) {
danielebarchiesi@0:   return $plugin['menu']['menu prefix'] . '/' . $plugin['menu']['menu item'];
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Get the path to a specific menu item from a plugin.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $plugin
danielebarchiesi@0:  *   The plugin name.
danielebarchiesi@0:  * @param $item_id
danielebarchiesi@0:  *   The id in the menu items from the plugin.
danielebarchiesi@0:  * @param $export_key
danielebarchiesi@0:  *   The export key of the item being edited, if it exists.
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   The menu path to the plugin's list.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_export_ui_plugin_menu_path($plugin, $item_id, $export_key = NULL) {
danielebarchiesi@0:   $path = $plugin['menu']['items'][$item_id]['path'];
danielebarchiesi@0:   if ($export_key) {
danielebarchiesi@0:     $path = str_replace('%ctools_export_ui', $export_key, $path);
danielebarchiesi@0:   }
danielebarchiesi@0:   return ctools_export_ui_plugin_base_path($plugin) . '/' . $path;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Helper function to include CTools plugins and get an export-ui exportable.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $plugin_name
danielebarchiesi@0:  *   The plugin that should be laoded.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_get_export_ui($plugin_name) {
danielebarchiesi@0:   ctools_include('plugins');
danielebarchiesi@0:   return ctools_get_plugins('ctools', 'export_ui', $plugin_name);
danielebarchiesi@0: 
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Helper function to include CTools plugins and get all export-ui exportables.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_get_export_uis() {
danielebarchiesi@0:   ctools_include('plugins');
danielebarchiesi@0:   return ctools_get_plugins('ctools', 'export_ui');
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Main page callback to manipulate exportables.
danielebarchiesi@0:  *
danielebarchiesi@0:  * This simply loads the object defined in the plugin and hands it off to
danielebarchiesi@0:  * a method based upon the name of the operation in use. This can easily
danielebarchiesi@0:  * be used to add more ops.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_export_ui_switcher_page($plugin_name, $op) {
danielebarchiesi@0:   $args = func_get_args();
danielebarchiesi@0:   $js = !empty($_REQUEST['js']);
danielebarchiesi@0: 
danielebarchiesi@0:   // Load the $plugin information
danielebarchiesi@0:   $plugin = ctools_get_export_ui($plugin_name);
danielebarchiesi@0:   $handler = ctools_export_ui_get_handler($plugin);
danielebarchiesi@0: 
danielebarchiesi@0:   if ($handler) {
danielebarchiesi@0:     $method = $op . '_page';
danielebarchiesi@0:     if (method_exists($handler, $method)) {
danielebarchiesi@0:       // replace the first two arguments:
danielebarchiesi@0:       $args[0] = $js;
danielebarchiesi@0:       $args[1] = $_POST;
danielebarchiesi@0:       return call_user_func_array(array($handler, $method), $args);
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     return t('Configuration error. No handler found.');
danielebarchiesi@0:   }
danielebarchiesi@0: }