http_response.inc

<?php


/**
 * @file
 * This is the task handler plugin to handle generating 403, 404, 301 and 302
 * response codes.
 */
// Plugin definition.
$plugin = array(
    // Is a 'context' handler type, meaning it supports the API of the
    // context handlers provided by ctools context plugins.
'handler type' => 'context',
    'visible' => TRUE,
    // may be added up front.
    // Administrative fields.
'title' => t('HTTP response code'),
    'admin summary' => 'page_manager_http_response_admin_summary',
    'admin title' => 'page_manager_http_response_title',
    'operations' => array(
        'settings' => array(
            'title' => t('General'),
            'description' => t('Change general settings for this variant.'),
            'form' => 'page_manager_http_response_edit_settings',
        ),
        'criteria' => array(
            'title' => t('Selection rules'),
            'description' => t('Control the criteria used to decide whether or not this variant is used.'),
            'ajax' => FALSE,
            'form' => array(
                'order' => array(
                    'form' => t('Selection rules'),
                ),
                'forms' => array(
                    'form' => array(
                        'include' => drupal_get_path('module', 'ctools') . '/includes/context-task-handler.inc',
                        'form id' => 'ctools_context_handler_edit_criteria',
                    ),
                ),
            ),
        ),
        'context' => array(
            'title' => t('Contexts'),
            'ajax' => FALSE,
            'description' => t('Add additional context objects to this variant that can be used by the content.'),
            'form' => array(
                'order' => array(
                    'form' => t('Context'),
                ),
                'forms' => array(
                    'form' => array(
                        'include' => drupal_get_path('module', 'ctools') . '/includes/context-task-handler.inc',
                        'form id' => 'ctools_context_handler_edit_context',
                    ),
                ),
            ),
        ),
    ),
    // Callback to render the data.
'render' => 'page_manager_http_response_render',
    'add features' => array(
        'criteria' => t('Selection rules'),
        'context' => t('Contexts'),
    ),
    // Where to go when finished.
'add finish' => 'settings',
    'required forms' => array(
        'settings' => t('Panel settings'),
    ),
    'edit forms' => array(
        'criteria' => t('Selection rules'),
        'settings' => t('General'),
        'context' => t('Contexts'),
    ),
    'forms' => array(
        'settings' => array(
            'form id' => 'page_manager_http_response_edit_settings',
        ),
        'context' => array(
            'include' => drupal_get_path('module', 'ctools') . '/includes/context-task-handler.inc',
            'form id' => 'ctools_context_handler_edit_context',
        ),
        'criteria' => array(
            'include' => drupal_get_path('module', 'ctools') . '/includes/context-task-handler.inc',
            'form id' => 'ctools_context_handler_edit_criteria',
        ),
    ),
    'default conf' => array(
        'title' => t('HTTP response code'),
        'contexts' => array(),
        'relationships' => array(),
        'code' => '404',
        'destination' => '',
    ),
);

/**
 * Provide a list of the response codes we support.
 *
 * Abstracted so it can be more readily used both on input and output.
 */
function page_manager_http_response_codes() {
    return array(
        403 => t('403 Access denied'),
        404 => t('404 Page not found'),
        410 => t('410 Gone'),
        301 => t('301 Permanent redirect'),
        302 => t('302 Temporary redirect'),
    );
}
function page_manager_http_response_admin_summary($handler, $task, $subtask, $page, $show_title = TRUE) {
    $task_name = page_manager_make_task_name($task['name'], $subtask['name']);
    $output = '';
    ctools_include('context');
    ctools_include('context-task-handler');
    // Get the operations.
    $operations = page_manager_get_operations($page);
    // Get operations for just this handler.
    $operations = $operations['handlers']['children'][$handler->name]['children']['actions']['children'];
    $args = array(
        'handlers',
        $handler->name,
        'actions',
    );
    $rendered_operations = page_manager_render_operations($page, $operations, array(), array(
        'class' => array(
            'actions',
        ),
    ), 'actions', $args);
    $plugin = page_manager_get_task_handler($handler->handler);
    $object = ctools_context_handler_get_task_object($task, $subtask, $handler);
    $context = ctools_context_load_contexts($object, TRUE);
    $access = ctools_access_group_summary(!empty($handler->conf['access']) ? $handler->conf['access'] : array(), $context);
    if ($access) {
        $access = t('This panel will be selected if @conditions.', array(
            '@conditions' => $access,
        ));
    }
    else {
        $access = t('This panel will always be selected.');
    }
    $rows = array();
    $type = $handler->type == t('Default') ? t('In code') : $handler->type;
    $rows[] = array(
        array(
            'class' => array(
                'page-summary-label',
            ),
            'data' => t('Storage'),
        ),
        array(
            'class' => array(
                'page-summary-data',
            ),
            'data' => $type,
        ),
        array(
            'class' => array(
                'page-summary-operation',
            ),
            'data' => '',
        ),
    );
    if (!empty($handler->disabled)) {
        $link = l(t('Enable'), page_manager_edit_url($task_name, array(
            'handlers',
            $handler->name,
            'actions',
            'enable',
        )));
        $text = t('Disabled');
    }
    else {
        $link = l(t('Disable'), page_manager_edit_url($task_name, array(
            'handlers',
            $handler->name,
            'actions',
            'disable',
        )));
        $text = t('Enabled');
    }
    $rows[] = array(
        array(
            'class' => array(
                'page-summary-label',
            ),
            'data' => t('Status'),
        ),
        array(
            'class' => array(
                'page-summary-data',
            ),
            'data' => $text,
        ),
        array(
            'class' => array(
                'page-summary-operation',
            ),
            'data' => $link,
        ),
    );
    $link = l(t('Edit'), page_manager_edit_url($task_name, array(
        'handlers',
        $handler->name,
        'criteria',
    )));
    $rows[] = array(
        array(
            'class' => array(
                'page-summary-label',
            ),
            'data' => t('Selection rule'),
        ),
        array(
            'class' => array(
                'page-summary-data',
            ),
            'data' => $access,
        ),
        array(
            'class' => array(
                'page-summary-operation',
            ),
            'data' => $link,
        ),
    );
    $link = l(t('Edit'), page_manager_edit_url($task_name, array(
        'handlers',
        $handler->name,
        'settings',
    )));
    $codes = page_manager_http_response_codes();
    $rows[] = array(
        array(
            'class' => array(
                'page-summary-label',
            ),
            'data' => t('Response code'),
        ),
        array(
            'class' => array(
                'page-summary-data',
            ),
            'data' => $codes[$handler->conf['code']],
        ),
        array(
            'class' => array(
                'page-summary-operation',
            ),
            'data' => $link,
        ),
    );
    $info = theme('table', array(
        'header' => array(),
        'rows' => $rows,
        'attributes' => array(
            'class' => array(
                'page-manager-handler-summary',
            ),
        ),
    ));
    $title = $handler->conf['title'];
    if ($title != t('Panel')) {
        $title = t('Panel: @title', array(
            '@title' => $title,
        ));
    }
    $output .= '<div class="clearfix">';
    if ($show_title) {
        $output .= '<div class="handler-title clearfix">';
        $output .= '<div class="actions handler-actions">' . $rendered_operations['actions'] . '</div>';
        $output .= '<span class="title-label">' . $title . '</span>';
    }
    $output .= '</div>';
    $output .= $info;
    $output .= '</div>';
    return $output;
}

/**
 * Set up a title for the panel based upon the selection rules.
 */
function page_manager_http_response_title($handler, $task, $subtask) {
    if (isset($handler->conf['title'])) {
        return check_plain($handler->conf['title']);
    }
    else {
        return t('HTTP response code');
    }
}

/**
 * General settings for the panel.
 */
function page_manager_http_response_edit_settings($form, &$form_state) {
    ctools_include('page_manager.admin', 'page_manager', '');
    ctools_include('export', 'ctools');
    $conf = $form_state['handler']->conf;
    $form['title'] = array(
        '#type' => 'textfield',
        '#default_value' => $conf['title'],
        '#title' => t('Administrative title'),
        '#description' => t('Administrative title of this variant.'),
    );
    $name = isset($conf['name']) ? $conf['name'] : FALSE;
    $form['name'] = array(
        '#type' => 'machine_name',
        '#title' => t('Machine name'),
        '#required' => FALSE,
        '#default_value' => $name,
        '#description' => t("A unique machine-readable name for this variant. It must only contain lowercase letters, numbers, and underscores. This name will be used when exporting the variant. If left empty the variant's name will be used instead."),
        '#size' => 32,
        '#maxlength' => 32,
        '#machine_name' => array(
            'exists' => 'page_manager_handler_check_machine_name',
            'source' => array(
                'title',
            ),
        ),
        '#field_prefix' => '<span dir="ltr">' . $form_state['task_name'] . '__',
        '#field_suffix' => '</span>&lrm;',
    );
    $form['code'] = array(
        '#title' => t('Response code'),
        '#type' => 'select',
        '#options' => page_manager_http_response_codes(),
        '#default_value' => $conf['code'],
    );
    ctools_include('dependent');
    $form['destination'] = array(
        '#type' => 'textfield',
        '#title' => t('Redirect destination'),
        '#default_value' => $conf['destination'],
        '#dependency' => array(
            'edit-code' => array(
                301,
                302,
            ),
        ),
        '#description' => t('Enter the path to redirect to. You may use keyword substitutions from contexts. You can use external urls (http://www.example.com/foo) or internal urls (node/1).'),
    );
    return $form;
}
function page_manager_http_response_edit_settings_submit($form, &$form_state) {
    $machine_name = $form_state['handler']->name;
    $name = $form_state['task_name'] . '__' . $form_state['values']['name'];
    // If new name doesn't equal machine name, we need to update and redirect.
    if ($machine_name !== $name) {
        $form_state['handler']->name = $name;
        // If there's a trail, we need to replace it for redirection.
        if (isset($form_state['trail'])) {
            $form_state['new trail'] = $form_state['trail'];
            $delta = array_search($machine_name, $form_state['new trail']);
            $form_state['new trail'][$delta] = $name;
        }
        // If handler id is set, replace it.
        if ($form_state['handler_id']) {
            $form_state['handler_id'] = $name;
        }
        // If we're defining a new custom handler, move page handler to new name.
        if (isset($form_state['page']->handlers[$machine_name]) && isset($form_state['page']->handler_info[$machine_name])) {
            $form_state['page']->handlers[$name] = $form_state['page']->handlers[$machine_name];
            unset($form_state['page']->handlers[$machine_name]);
            $form_state['page']->handler_info[$name] = $form_state['page']->handler_info[$machine_name];
            unset($form_state['page']->handler_info[$machine_name]);
        }
    }
    $form_state['handler']->conf['title'] = $form_state['values']['title'];
    $form_state['handler']->conf['name'] = $form_state['values']['name'];
    $form_state['handler']->conf['code'] = $form_state['values']['code'];
    $form_state['handler']->conf['destination'] = $form_state['values']['destination'];
}
function page_manager_http_response_render($handler, $base_contexts, $args, $test = TRUE) {
    // Go through arguments and see if they match.
    ctools_include('context');
    ctools_include('context-task-handler');
    // Add my contexts.
    $contexts = ctools_context_handler_get_handler_contexts($base_contexts, $handler);
    // Test.
    if ($test && !ctools_context_handler_select($handler, $contexts)) {
        return;
    }
    if (isset($handler->handler)) {
        ctools_context_handler_pre_render($handler, $contexts, $args);
    }
    $info['response code'] = $handler->conf['code'];
    if ($info['response code'] == 301 || $info['response code'] == 302) {
        $path = ctools_context_keyword_substitute($handler->conf['destination'], array(), $contexts);
        $url = parse_url($path);
        if (isset($url['query'])) {
            $path = strtr($path, array(
                '?' . $url['query'] => '',
            ));
            $info['query'] = drupal_get_query_array($url['query']);
        }
        if (isset($url['fragment'])) {
            $path = strtr($path, array(
                '#' . $url['fragment'] => '',
            ));
            $info['fragment'] = $url['fragment'];
        }
        $info['destination'] = rtrim($path, '?');
    }
    return $info;
}