danielebarchiesi@0: array( danielebarchiesi@0: * 0 => array( danielebarchiesi@0: * 'name' => 'name of access plugin', danielebarchiesi@0: * 'settings' => array(), // These will be set by the form danielebarchiesi@0: * ), danielebarchiesi@0: * // ... as many as needed danielebarchiesi@0: * ), danielebarchiesi@0: * 'logic' => 'AND', // or 'OR', danielebarchiesi@0: * ), danielebarchiesi@0: * @endcode danielebarchiesi@0: * danielebarchiesi@0: * To add this widget to your UI, you need to do a little bit of setup. danielebarchiesi@0: * danielebarchiesi@0: * The form will utilize two callbacks, one to get the cached version danielebarchiesi@0: * of the access settings, and one to store the cached version of the danielebarchiesi@0: * access settings. These will be used from AJAX forms, so they will danielebarchiesi@0: * be completely out of the context of this page load and will not have danielebarchiesi@0: * knowledge of anything sent to this form (the 'module' and 'argument' danielebarchiesi@0: * will be preserved through the URL only). danielebarchiesi@0: * danielebarchiesi@0: * The 'module' is used to determine the location of the callback. It danielebarchiesi@0: * does not strictly need to be a module, so that if your module defines danielebarchiesi@0: * multiple systems that use this callback, it can use anything within the danielebarchiesi@0: * module's namespace it likes. danielebarchiesi@0: * danielebarchiesi@0: * When retrieving the cache, the cache may not have already been set up; danielebarchiesi@0: * In order to efficiently use cache space, we want to cache the stored danielebarchiesi@0: * settings *only* when they have changed. Therefore, the get access cache danielebarchiesi@0: * callback should first look for cache, and if it finds nothing, return danielebarchiesi@0: * the original settings. danielebarchiesi@0: * danielebarchiesi@0: * The callbacks: danielebarchiesi@0: * - $module . _ctools_access_get($argument) -- get the 'access' settings danielebarchiesi@0: * from cache. Must return array($access, $contexts); This callback can danielebarchiesi@0: * perform access checking to make sure this URL is not being gamed. danielebarchiesi@0: * - $module . _ctools_access_set($argument, $access) -- set the 'access' danielebarchiesi@0: * settings in cache. danielebarchiesi@0: * - $module . _ctools_access_clear($argument) -- clear the cache. danielebarchiesi@0: * danielebarchiesi@0: * The ctools_object_cache is recommended for this purpose, but you can use danielebarchiesi@0: * any caching mechanism you like. An example: danielebarchiesi@0: * danielebarchiesi@0: * @code{ danielebarchiesi@0: * ctools_include('object-cache'); danielebarchiesi@0: * ctools_object_cache_set("$module:argument", $access); danielebarchiesi@0: * } danielebarchiesi@0: * danielebarchiesi@0: * To utilize this form: danielebarchiesi@0: * @code danielebarchiesi@0: * ctools_include('context-access-admin'); danielebarchiesi@0: * $form_state = array( danielebarchiesi@0: * 'access' => $access, danielebarchiesi@0: * 'module' => 'module name', danielebarchiesi@0: * 'callback argument' => 'some string', danielebarchiesi@0: * 'contexts' => $contexts, // an array of contexts. Optional if no contexts. danielebarchiesi@0: * // 'logged-in-user' will be added if not present as the access system danielebarchiesi@0: * // requires this context. danielebarchiesi@0: * ), danielebarchiesi@0: * $output = drupal_build_form('ctools_access_admin_form', $form_state); danielebarchiesi@0: * if (!empty($form_state['executed'])) { danielebarchiesi@0: * // save $form_state['access'] however you like. danielebarchiesi@0: * } danielebarchiesi@0: * @endcode danielebarchiesi@0: * danielebarchiesi@0: * Additionally, you may add 'no buttons' => TRUE if you wish to embed this danielebarchiesi@0: * form into your own, and instead call danielebarchiesi@0: * danielebarchiesi@0: * @code{ danielebarchiesi@0: * $form = ctools_access_admin_form($form, $form_state); danielebarchiesi@0: * } danielebarchiesi@0: * danielebarchiesi@0: * You'll be responsible for adding a submit button. danielebarchiesi@0: * danielebarchiesi@0: * You may use ctools_access($access, $contexts) which will return danielebarchiesi@0: * TRUE if access is passed or FALSE if access is not passed. danielebarchiesi@0: */ danielebarchiesi@0: danielebarchiesi@0: /** danielebarchiesi@0: * Administrative form for access control. danielebarchiesi@0: */ danielebarchiesi@0: function ctools_access_admin_form($form, &$form_state) { danielebarchiesi@0: ctools_include('context'); danielebarchiesi@0: $argument = isset($form_state['callback argument']) ? $form_state['callback argument'] : ''; danielebarchiesi@0: $fragment = $form_state['module']; danielebarchiesi@0: if ($argument) { danielebarchiesi@0: $fragment .= '-' . $argument; danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: $contexts = isset($form_state['contexts']) ? $form_state['contexts'] : array(); danielebarchiesi@0: danielebarchiesi@0: $form['access_table'] = array( danielebarchiesi@0: '#markup' => ctools_access_admin_render_table($form_state['access'], $fragment, $contexts), danielebarchiesi@0: ); danielebarchiesi@0: danielebarchiesi@0: $form['add-button'] = array( danielebarchiesi@0: '#theme' => 'ctools_access_admin_add', danielebarchiesi@0: ); danielebarchiesi@0: // This sets up the URL for the add access modal. danielebarchiesi@0: $form['add-button']['add-url'] = array( danielebarchiesi@0: '#attributes' => array('class' => array("ctools-access-add-url")), danielebarchiesi@0: '#type' => 'hidden', danielebarchiesi@0: '#value' => url("ctools/context/ajax/access/add/$fragment", array('absolute' => TRUE)), danielebarchiesi@0: ); danielebarchiesi@0: danielebarchiesi@0: $plugins = ctools_get_relevant_access_plugins($contexts); danielebarchiesi@0: $options = array(); danielebarchiesi@0: foreach ($plugins as $id => $plugin) { danielebarchiesi@0: $options[$id] = $plugin['title']; danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: asort($options); danielebarchiesi@0: danielebarchiesi@0: $form['add-button']['type'] = array( danielebarchiesi@0: // This ensures that the form item is added to the URL. danielebarchiesi@0: '#attributes' => array('class' => array("ctools-access-add-url")), danielebarchiesi@0: '#type' => 'select', danielebarchiesi@0: '#options' => $options, danielebarchiesi@0: '#required' => FALSE, danielebarchiesi@0: ); danielebarchiesi@0: danielebarchiesi@0: $form['add-button']['add'] = array( danielebarchiesi@0: '#type' => 'submit', danielebarchiesi@0: '#attributes' => array('class' => array('ctools-use-modal')), danielebarchiesi@0: '#id' => "ctools-access-add", danielebarchiesi@0: '#value' => t('Add'), danielebarchiesi@0: ); danielebarchiesi@0: danielebarchiesi@0: $form['logic'] = array( danielebarchiesi@0: '#type' => 'radios', danielebarchiesi@0: '#options' => array( danielebarchiesi@0: 'and' => t('All criteria must pass.'), danielebarchiesi@0: 'or' => t('Only one criteria must pass.'), danielebarchiesi@0: ), danielebarchiesi@0: '#default_value' => isset($form_state['access']['logic']) ? $form_state['access']['logic'] : 'and', danielebarchiesi@0: ); danielebarchiesi@0: danielebarchiesi@0: if (empty($form_state['no buttons'])) { danielebarchiesi@0: $form['buttons']['save'] = array( danielebarchiesi@0: '#type' => 'submit', danielebarchiesi@0: '#value' => t('Save'), danielebarchiesi@0: '#submit' => array('ctools_access_admin_form_submit'), danielebarchiesi@0: ); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: return $form; danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: /** danielebarchiesi@0: * Render the table. This is used both to render it initially and to rerender danielebarchiesi@0: * it upon ajax response. danielebarchiesi@0: */ danielebarchiesi@0: function ctools_access_admin_render_table($access, $fragment, $contexts) { danielebarchiesi@0: ctools_include('ajax'); danielebarchiesi@0: ctools_include('modal'); danielebarchiesi@0: $rows = array(); danielebarchiesi@0: danielebarchiesi@0: if (empty($access['plugins'])) { danielebarchiesi@0: $access['plugins'] = array(); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: foreach ($access['plugins'] as $id => $test) { danielebarchiesi@0: $row = array(); danielebarchiesi@0: $plugin = ctools_get_access_plugin($test['name']); danielebarchiesi@0: $title = isset($plugin['title']) ? $plugin['title'] : t('Broken/missing access plugin %plugin', array('%plugin' => $test['name'])); danielebarchiesi@0: danielebarchiesi@0: $row[] = array('data' => $title, 'class' => array('ctools-access-title')); danielebarchiesi@0: danielebarchiesi@0: $description = ctools_access_summary($plugin, $contexts, $test); danielebarchiesi@0: $row[] = array('data' => $description, 'class' => array('ctools-access-description')); danielebarchiesi@0: danielebarchiesi@0: $operations = ctools_modal_image_button(ctools_image_path('icon-configure.png'), "ctools/context/ajax/access/configure/$fragment/$id", t('Configure settings for this item.')); danielebarchiesi@0: $operations .= ctools_ajax_image_button(ctools_image_path('icon-delete.png'), "ctools/context/ajax/access/delete/$fragment/$id", t('Remove this item.')); danielebarchiesi@0: danielebarchiesi@0: $row[] = array('data' => $operations, 'class' => array('ctools-access-operations'), 'align' => 'right'); danielebarchiesi@0: danielebarchiesi@0: $rows[] = $row; danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: $header = array( danielebarchiesi@0: array('data' => t('Title'), 'class' => array('ctools-access-title')), danielebarchiesi@0: array('data' => t('Description'), 'class' => array('ctools-access-description')), danielebarchiesi@0: array('data' => '', 'class' => array('ctools-access-operations'), 'align' => 'right'), danielebarchiesi@0: ); danielebarchiesi@0: danielebarchiesi@0: if (empty($rows)) { danielebarchiesi@0: $rows[] = array(array('data' => t('No criteria selected, this test will pass.'), 'colspan' => count($header))); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: ctools_modal_add_js(); danielebarchiesi@0: return theme('table', array('header' => $header, 'rows' => $rows, 'attributes' => array('id' => 'ctools-access-table'))); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: /** danielebarchiesi@0: * Theme the 'add' portion of the access form into a table. danielebarchiesi@0: */ danielebarchiesi@0: function theme_ctools_access_admin_add($vars) { danielebarchiesi@0: $rows = array(array(drupal_render_children($vars['form']))); danielebarchiesi@0: $output = '
'; danielebarchiesi@0: $output .= theme('table', array('rows' => $rows)); danielebarchiesi@0: $output .= '
'; danielebarchiesi@0: return $output; danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: function ctools_access_admin_form_submit($form, &$form_state) { danielebarchiesi@0: $form_state['access']['logic'] = $form_state['values']['logic']; danielebarchiesi@0: danielebarchiesi@0: $function = $form_state['module'] . '_ctools_access_clear'; danielebarchiesi@0: if (function_exists($function)) { danielebarchiesi@0: $function($form_state['callback argument']); danielebarchiesi@0: } danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: // -------------------------------------------------------------------------- danielebarchiesi@0: // AJAX menu entry points. danielebarchiesi@0: danielebarchiesi@0: /** danielebarchiesi@0: * AJAX callback to add a new access test to the list. danielebarchiesi@0: */ danielebarchiesi@0: function ctools_access_ajax_add($fragment = NULL, $name = NULL) { danielebarchiesi@0: ctools_include('ajax'); danielebarchiesi@0: ctools_include('modal'); danielebarchiesi@0: ctools_include('context'); danielebarchiesi@0: danielebarchiesi@0: if (empty($fragment) || empty($name)) { danielebarchiesi@0: ctools_ajax_render_error(); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: $plugin = ctools_get_access_plugin($name); danielebarchiesi@0: if (empty($plugin)) { danielebarchiesi@0: ctools_ajax_render_error(); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: // Separate the fragment into 'module' and 'argument' danielebarchiesi@0: if (strpos($fragment, '-') === FALSE) { danielebarchiesi@0: $module = $fragment; danielebarchiesi@0: $argument = NULL; danielebarchiesi@0: } danielebarchiesi@0: else { danielebarchiesi@0: list($module, $argument) = explode('-', $fragment, 2); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: $function = $module . '_ctools_access_get'; danielebarchiesi@0: if (!function_exists($function)) { danielebarchiesi@0: ctools_ajax_render_error(t('Missing callback hooks.')); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: list($access, $contexts) = $function($argument); danielebarchiesi@0: danielebarchiesi@0: // Make sure we have the logged in user context danielebarchiesi@0: if (!isset($contexts['logged-in-user'])) { danielebarchiesi@0: $contexts['logged-in-user'] = ctools_access_get_loggedin_context(); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: if (empty($access['plugins'])) { danielebarchiesi@0: $access['plugins'] = array(); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: $test = ctools_access_new_test($plugin); danielebarchiesi@0: danielebarchiesi@0: $id = $access['plugins'] ? max(array_keys($access['plugins'])) + 1 : 0; danielebarchiesi@0: $access['plugins'][$id] = $test; danielebarchiesi@0: danielebarchiesi@0: $form_state = array( danielebarchiesi@0: 'plugin' => $plugin, danielebarchiesi@0: 'id' => $id, danielebarchiesi@0: 'test' => &$access['plugins'][$id], danielebarchiesi@0: 'access' => &$access, danielebarchiesi@0: 'contexts' => $contexts, danielebarchiesi@0: 'title' => t('Add criteria'), danielebarchiesi@0: 'ajax' => TRUE, danielebarchiesi@0: 'modal' => TRUE, danielebarchiesi@0: 'modal return' => TRUE, danielebarchiesi@0: ); danielebarchiesi@0: danielebarchiesi@0: $output = ctools_modal_form_wrapper('ctools_access_ajax_edit_item', $form_state); danielebarchiesi@0: if (!isset($output[0])) { danielebarchiesi@0: $function = $module . '_ctools_access_set'; danielebarchiesi@0: if (function_exists($function)) { danielebarchiesi@0: $function($argument, $access); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: $table = ctools_access_admin_render_table($access, $fragment, $contexts); danielebarchiesi@0: $output = array(); danielebarchiesi@0: $output[] = ajax_command_replace('table#ctools-access-table', $table); danielebarchiesi@0: $output[] = ctools_modal_command_dismiss(); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: print ajax_render($output); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: /** danielebarchiesi@0: * AJAX callback to edit an access test in the list. danielebarchiesi@0: */ danielebarchiesi@0: function ctools_access_ajax_edit($fragment = NULL, $id = NULL) { danielebarchiesi@0: ctools_include('ajax'); danielebarchiesi@0: ctools_include('modal'); danielebarchiesi@0: ctools_include('context'); danielebarchiesi@0: danielebarchiesi@0: if (empty($fragment) || !isset($id)) { danielebarchiesi@0: ctools_ajax_render_error(); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: // Separate the fragment into 'module' and 'argument' danielebarchiesi@0: if (strpos($fragment, '-') === FALSE) { danielebarchiesi@0: $module = $fragment; danielebarchiesi@0: $argument = NULL; danielebarchiesi@0: } danielebarchiesi@0: else { danielebarchiesi@0: list($module, $argument) = explode('-', $fragment, 2); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: $function = $module . '_ctools_access_get'; danielebarchiesi@0: if (!function_exists($function)) { danielebarchiesi@0: ctools_ajax_render_error(t('Missing callback hooks.')); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: list($access, $contexts) = $function($argument); danielebarchiesi@0: danielebarchiesi@0: if (empty($access['plugins'][$id])) { danielebarchiesi@0: ctools_ajax_render_error(); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: // Make sure we have the logged in user context danielebarchiesi@0: if (!isset($contexts['logged-in-user'])) { danielebarchiesi@0: $contexts['logged-in-user'] = ctools_access_get_loggedin_context(); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: $plugin = ctools_get_access_plugin($access['plugins'][$id]['name']); danielebarchiesi@0: $form_state = array( danielebarchiesi@0: 'plugin' => $plugin, danielebarchiesi@0: 'id' => $id, danielebarchiesi@0: 'test' => &$access['plugins'][$id], danielebarchiesi@0: 'access' => &$access, danielebarchiesi@0: 'contexts' => $contexts, danielebarchiesi@0: 'title' => t('Edit criteria'), danielebarchiesi@0: 'ajax' => TRUE, danielebarchiesi@0: 'ajax' => TRUE, danielebarchiesi@0: 'modal' => TRUE, danielebarchiesi@0: 'modal return' => TRUE, danielebarchiesi@0: ); danielebarchiesi@0: danielebarchiesi@0: $output = ctools_modal_form_wrapper('ctools_access_ajax_edit_item', $form_state); danielebarchiesi@0: if (!isset($output[0])) { danielebarchiesi@0: $function = $module . '_ctools_access_set'; danielebarchiesi@0: if (function_exists($function)) { danielebarchiesi@0: $function($argument, $access); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: $table = ctools_access_admin_render_table($access, $fragment, $contexts); danielebarchiesi@0: $output = array(); danielebarchiesi@0: $output[] = ajax_command_replace('table#ctools-access-table', $table); danielebarchiesi@0: $output[] = ctools_modal_command_dismiss(); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: print ajax_render($output); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: /** danielebarchiesi@0: * Form to edit the settings of an access test. danielebarchiesi@0: */ danielebarchiesi@0: function ctools_access_ajax_edit_item($form, &$form_state) { danielebarchiesi@0: $test = &$form_state['test']; danielebarchiesi@0: $plugin = &$form_state['plugin']; danielebarchiesi@0: if (isset($plugin['required context'])) { danielebarchiesi@0: $form['context'] = ctools_context_selector($form_state['contexts'], $plugin['required context'], $test['context']); danielebarchiesi@0: } danielebarchiesi@0: $form['settings'] = array('#tree' => TRUE); danielebarchiesi@0: if ($function = ctools_plugin_get_function($plugin, 'settings form')) { danielebarchiesi@0: $form = $function($form, $form_state, $test['settings']); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: $form['not'] = array( danielebarchiesi@0: '#type' => 'checkbox', danielebarchiesi@0: '#title' => t('Reverse (NOT)'), danielebarchiesi@0: '#default_value' => !empty($test['not']), danielebarchiesi@0: ); danielebarchiesi@0: danielebarchiesi@0: $form['save'] = array( danielebarchiesi@0: '#type' => 'submit', danielebarchiesi@0: '#value' => t('Save'), danielebarchiesi@0: ); danielebarchiesi@0: danielebarchiesi@0: return $form; danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: /** danielebarchiesi@0: * Validate handler for argument settings. danielebarchiesi@0: */ danielebarchiesi@0: function ctools_access_ajax_edit_item_validate($form, &$form_state) { danielebarchiesi@0: if ($function = ctools_plugin_get_function($form_state['plugin'], 'settings form validate')) { danielebarchiesi@0: $function($form, $form_state); danielebarchiesi@0: } danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: /** danielebarchiesi@0: * Submit handler for argument settings. danielebarchiesi@0: */ danielebarchiesi@0: function ctools_access_ajax_edit_item_submit($form, &$form_state) { danielebarchiesi@0: if ($function = ctools_plugin_get_function($form_state['plugin'], 'settings form submit')) { danielebarchiesi@0: $function($form, $form_state); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: $form_state['test']['settings'] = $form_state['values']['settings']; danielebarchiesi@0: if (isset($form_state['values']['context'])) { danielebarchiesi@0: $form_state['test']['context'] = $form_state['values']['context']; danielebarchiesi@0: } danielebarchiesi@0: $form_state['test']['not'] = !empty($form_state['values']['not']); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: /** danielebarchiesi@0: * AJAX command to remove an access control item. danielebarchiesi@0: */ danielebarchiesi@0: function ctools_access_ajax_delete($fragment = NULL, $id = NULL) { danielebarchiesi@0: ctools_include('ajax'); danielebarchiesi@0: ctools_include('modal'); danielebarchiesi@0: ctools_include('context'); danielebarchiesi@0: danielebarchiesi@0: if (empty($fragment) || !isset($id)) { danielebarchiesi@0: ajax_render_error(); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: // Separate the fragment into 'module' and 'argument' danielebarchiesi@0: if (strpos($fragment, '-') === FALSE) { danielebarchiesi@0: $module = $fragment; danielebarchiesi@0: $argument = NULL; danielebarchiesi@0: } danielebarchiesi@0: else { danielebarchiesi@0: list($module, $argument) = explode('-', $fragment, 2); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: $function = $module . '_ctools_access_get'; danielebarchiesi@0: if (!function_exists($function)) { danielebarchiesi@0: ajax_render_error(t('Missing callback hooks.')); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: list($access, $contexts) = $function($argument); danielebarchiesi@0: danielebarchiesi@0: if (isset($access['plugins'][$id])) { danielebarchiesi@0: unset($access['plugins'][$id]); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: // re-cache danielebarchiesi@0: $function = $module . '_ctools_access_set'; danielebarchiesi@0: if (function_exists($function)) { danielebarchiesi@0: $function($argument, $access); danielebarchiesi@0: } danielebarchiesi@0: danielebarchiesi@0: $table = ctools_access_admin_render_table($access, $fragment, $contexts); danielebarchiesi@0: $output = array(); danielebarchiesi@0: $output[] = ajax_command_replace('table#ctools-access-table', $table); danielebarchiesi@0: danielebarchiesi@0: print ajax_render($output); danielebarchiesi@0: }