node.inc

<?php


/**
 * @file
 * Plugin to provide a node context. A node context is a node wrapped in a
 * context object that can be utilized by anything that accepts contexts.
 */

/**
 * Plugins are described by creating a $plugin array which will be used
 * by the system that includes this file.
 */
$plugin = array(
    'title' => t("Node"),
    'description' => t('A node object.'),
    'context' => 'ctools_context_create_node',
    'edit form' => 'ctools_context_node_settings_form',
    'defaults' => array(
        'nid' => '',
    ),
    'keyword' => 'node',
    'context name' => 'node',
    'convert list' => 'ctools_context_node_convert_list',
    'convert' => 'ctools_context_node_convert',
    'placeholder form' => array(
        '#type' => 'textfield',
        '#description' => t('Enter the node ID of a node for this context.'),
    ),
    // This context is deprecated and should not be usable in the UI.
'no ui' => TRUE,
    'no required context ui' => TRUE,
    'superceded by' => 'entity:node',
);

/**
 * It's important to remember that $conf is optional here, because contexts
 * are not always created from the UI.
 */
function ctools_context_create_node($empty, $data = NULL, $conf = FALSE) {
    $context = new ctools_context('node');
    $context->plugin = 'node';
    if ($empty) {
        return $context;
    }
    if ($conf) {
        $nid = is_array($data) && isset($data['nid']) ? $data['nid'] : (is_object($data) ? $data->nid : 0);
        if (module_exists('translation')) {
            if ($translation = module_invoke('translation', 'node_nid', $nid, $GLOBALS['language']->language)) {
                $nid = $translation;
                $reload = TRUE;
            }
        }
        if (is_array($data) || !empty($reload)) {
            $data = node_load($nid);
        }
    }
    if (!empty($data)) {
        $context->data = $data;
        $context->title = $data->title;
        $context->argument = $data->nid;
        $context->restrictions['type'] = array(
            $data->type,
        );
        return $context;
    }
}
function ctools_context_node_settings_form($form, &$form_state) {
    $conf =& $form_state['conf'];
    $form['node'] = array(
        '#title' => t('Enter the title or NID of a node'),
        '#type' => 'textfield',
        '#maxlength' => 512,
        '#autocomplete_path' => 'ctools/autocomplete/node',
        '#weight' => -10,
    );
    if (!empty($conf['nid'])) {
        $info = db_query('SELECT * FROM {node} WHERE nid = :nid', array(
            ':nid' => $conf['nid'],
        ))->fetchObject();
        if ($info) {
            $link = l(t("'%title' [node id %nid]", array(
                '%title' => $info->title,
                '%nid' => $info->nid,
            )), "node/{$info->nid}", array(
                'attributes' => array(
                    'target' => '_blank',
                    'title' => t('Open in new window'),
                ),
                'html' => TRUE,
            ));
            $form['node']['#description'] = t('Currently set to !link', array(
                '!link' => $link,
            ));
        }
    }
    $form['nid'] = array(
        '#type' => 'value',
        '#value' => $conf['nid'],
    );
    $form['set_identifier'] = array(
        '#type' => 'checkbox',
        '#default_value' => FALSE,
        '#title' => t('Reset identifier to node title'),
        '#description' => t('If checked, the identifier will be reset to the node title of the selected node.'),
    );
    return $form;
}

/**
 * Validate a node.
 */
function ctools_context_node_settings_form_validate($form, &$form_state) {
    // Validate the autocomplete.
    if (empty($form_state['values']['nid']) && empty($form_state['values']['node'])) {
        form_error($form['node'], t('You must select a node.'));
        return;
    }
    if (empty($form_state['values']['node'])) {
        return;
    }
    $nid = $form_state['values']['node'];
    $preg_matches = array();
    $match = preg_match('/\\[id: (\\d+)\\]/', $nid, $preg_matches);
    if (!$match) {
        $match = preg_match('/^id: (\\d+)/', $nid, $preg_matches);
    }
    if ($match) {
        $nid = $preg_matches[1];
    }
    if (is_numeric($nid)) {
        $node = db_query('SELECT nid, status FROM {node} WHERE nid = :nid', array(
            ':nid' => $nid,
        ))->fetchObject();
    }
    else {
        $node = db_query('SELECT nid, status FROM {node} WHERE LOWER(title) = LOWER(:title)', array(
            ':title' => $nid,
        ))->fetchObject();
    }
    // Do not allow unpublished nodes to be selected by unprivileged users.
    if (!$node || empty($node->status) && !user_access('administer nodes')) {
        form_error($form['node'], t('Invalid node selected.'));
    }
    else {
        form_set_value($form['nid'], $node->nid, $form_state);
    }
}
function ctools_context_node_settings_form_submit($form, &$form_state) {
    if ($form_state['values']['set_identifier']) {
        $node = node_load($form_state['values']['nid']);
        $form_state['values']['identifier'] = $node->title;
    }
    // This will either be the value set previously or a value set by the
    // validator.
    $form_state['conf']['nid'] = $form_state['values']['nid'];
}

/**
 * Provide a list of ways that this context can be converted to a string.
 */
function ctools_context_node_convert_list() {
    $tokens = token_info();
    foreach ($tokens['tokens']['node'] as $id => $info) {
        if (!isset($list[$id])) {
            $list[$id] = $info['name'];
        }
    }
    return $list;
}

/**
 * Convert a context into a string.
 */
function ctools_context_node_convert($context, $type) {
    $tokens = token_info();
    if (isset($tokens['tokens']['node'][$type])) {
        $values = token_generate('node', array(
            $type => $type,
        ), array(
            'node' => $context->data,
        ));
        if (isset($values[$type])) {
            return $values[$type];
        }
    }
}