node_export.pages.inc in Node export 6.3
Same filename and directory in other branches
The Node export pages file.
Functions for page/form interfaces.
File
node_export.pages.incView source
<?php
/**
* @file
* The Node export pages file.
*
* Functions for page/form interfaces.
*/
// Define the files subdirectory
define("NODE_EXPORT", "node-export");
/**
* Implementation of hook_token_values().
*/
function node_export_token_values($type, $object = NULL, $options = array()) {
if ($type == 'Node export filename') {
$tokens['nid-list'] = $object['list'];
$tokens['node-count'] = $object['count'];
$tokens['timestamp'] = $object['time'];
$tokens['format'] = $object['format'];
return $tokens;
}
}
/**
* Implementation of hook_token_list().
*/
function node_export_token_list($type = 'all') {
if ($type == 'Node export filename') {
$tokens['Node export filename']['nid-list'] = t("Comma seperated list of node ids in square brackets (if available).");
$tokens['Node export filename']['node-count'] = t("The number of nodes exported.");
$tokens['Node export filename']['timestamp'] = t("The timestamp when the file was generated.");
$tokens['Node export filename']['format'] = t("The format used to export.");
return $tokens;
}
}
/**
* Handles the bits of the form that are specific to the token module.
*/
function node_export_settings_token_bits(&$form, $key) {
if (module_exists('token')) {
$form[$key . '_token_help'] = array(
'#title' => t('Replacement patterns'),
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#collapsed' => TRUE,
);
$form[$key . '_token_help']['help'] = array(
'#value' => theme('token_help', 'Node export filename'),
);
}
else {
$form[$key]['#description'] = t('Get the <a href="@token">token</a> module for more options.', array(
'@token' => url('http://www.drupal.org/project/token'),
));
}
}
/**
* Menu callback to configure module settings.
*/
function node_export_settings() {
$types = node_get_types('names');
menu_rebuild();
$form['basic'] = array(
'#type' => 'fieldset',
'#title' => t('General settings'),
);
$format_handlers = node_export_format_handlers();
$format_options = array();
foreach ($format_handlers as $format_handler => $format) {
$format_options[$format_handler] = $format['#title'];
}
asort($format_options);
$selected_formats = variable_get('node_export_format', array(
'node_code',
));
if (!count(array_filter($selected_formats))) {
$selected_formats = array(
'node_code',
);
}
if (count($format_options) > 1) {
$form['basic']['node_export_format'] = array(
'#type' => 'checkboxes',
'#title' => t('Format to use when exporting a node'),
'#default_value' => $selected_formats,
'#options' => $format_options,
'#description' => t("If you select multiple formats, they will all be available to the user. If you select none, or the format handler is not found, it will use the default 'Node code'. This does not affect imports, the required import format will be used automatically."),
);
}
else {
$format = key($format_options);
$form['basic']['node_export_format'] = array(
'#type' => 'value',
'#value' => array(
$format => $format,
),
);
}
$form['basic']['node_export_code'] = array(
'#type' => 'radios',
'#title' => t('Node export code delivery'),
'#options' => array(
'all' => t('All of the below options on a page'),
'copy' => t('Textarea filled with export code'),
'file' => t('Text file download'),
),
'#default_value' => variable_get('node_export_code', 'all'),
);
$form['basic']['filename'] = array(
'#type' => 'fieldset',
'#title' => t('Filename settings'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
);
$form['basic']['filename']['node_export_filename'] = array(
'#type' => 'textfield',
'#title' => t('Filename pattern'),
'#default_value' => variable_get('node_export_filename', 'node-export[nid-list]([node-count]-nodes).[timestamp].[format]'),
'#size' => 120,
);
node_export_settings_token_bits($form['basic']['filename'], 'node_export_filename');
$form['basic']['filename']['node_export_file_list'] = array(
'#type' => 'textfield',
'#title' => t('Node ID list max'),
'#default_value' => variable_get('node_export_file_list', 10),
'#size' => 6,
'#maxlength' => 30,
'#description' => t('If there are more than this many nodes, the [nid-list] token for the filename will not be built. This is to prevent very long filenames.'),
);
$form['basic']['node_export_existing'] = array(
'#type' => 'radios',
'#title' => t('When importing a node that already exists'),
'#options' => array(
'new' => t('Create a new node'),
'revision' => t('Create a new revision of the existing node'),
'skip' => t('Skip the node'),
),
'#description' => t('UUIDs are used to uniquely identify nodes.'),
'#default_value' => variable_get('node_export_existing', 'new'),
);
$form['publishing'] = array(
'#type' => 'fieldset',
'#title' => t('Reset values on import'),
);
foreach ($types as $type => $name) {
$form['publishing'][$type] = array(
'#type' => 'fieldset',
'#title' => $name,
'#description' => t('Reset these values when importing nodes of type @s.', array(
'@s' => $name,
)),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
);
$form['publishing'][$type]['node_export_reset_' . $type] = array(
'#type' => 'checkbox',
'#title' => t('Publishing options (status, moderate, promote, sticky, and revision)'),
'#default_value' => variable_get('node_export_reset_' . $type, FALSE),
);
$form['publishing'][$type]['node_export_reset_created_' . $type] = array(
'#type' => 'checkbox',
'#title' => t('Created time (<em>Authored on</em> date/time)'),
'#default_value' => variable_get('node_export_reset_created_' . $type, TRUE),
);
$form['publishing'][$type]['node_export_reset_changed_' . $type] = array(
'#type' => 'checkbox',
'#title' => t('Changed time (<em>Last updated</em> date/time)'),
'#default_value' => variable_get('node_export_reset_changed_' . $type, TRUE),
);
$form['publishing'][$type]['node_export_reset_revision_timestamp_' . $type] = array(
'#type' => 'checkbox',
'#title' => t('Revision changed time'),
'#default_value' => variable_get('node_export_reset_revision_timestamp_' . $type, TRUE),
);
$form['publishing'][$type]['node_export_reset_last_comment_timestamp_' . $type] = array(
'#type' => 'checkbox',
'#title' => t('Last comment time (date/time the last comment was made)'),
'#default_value' => variable_get('node_export_reset_last_comment_timestamp_' . $type, TRUE),
);
$form['publishing'][$type]['node_export_reset_menu_' . $type] = array(
'#type' => 'checkbox',
'#title' => t('Menu link'),
'#default_value' => variable_get('node_export_reset_menu_' . $type, TRUE),
);
$form['publishing'][$type]['node_export_reset_path_' . $type] = array(
'#type' => 'checkbox',
'#title' => t('URL path'),
'#default_value' => variable_get('node_export_reset_path_' . $type, TRUE),
);
$form['publishing'][$type]['node_export_reset_book_mlid_' . $type] = array(
'#type' => 'checkbox',
'#title' => t('Book menu link'),
'#default_value' => variable_get('node_export_reset_book_mlid_' . $type, TRUE),
);
}
return system_settings_form($form);
}
/**
* Export GUI function.
*
* @param $nodes
* A node, an array of nodes, or an array of nids.
* @param $format
* The node export format.
* @param $delivery
* The code delivery format, if NULL will use settings.
*/
function node_export_gui($nodes = NULL, $format = NULL, $delivery = NULL) {
// Get the $code_string.
if ($nodes) {
// $nodes passed in, get the code_string.
$result = node_export($nodes, $format);
if ($result['success']) {
$code_string = $result['output'];
}
else {
foreach ($result['output'] as $output) {
drupal_set_message($output, 'error');
}
return;
}
$nids = node_export_nodes_to_nids($nodes);
$format = $result['format'];
}
elseif (!empty($_SESSION['node_export'])) {
// Nids and code string supplied from session.
$session_data = array_shift($_SESSION['node_export']);
$code_string = $session_data['code_string'];
$nids = $session_data['nids'];
$format = $session_data['format'];
}
$delivery = $delivery ? $delivery : variable_get('node_export_code', 'all');
if ($delivery != 'file') {
if (is_object($nodes)) {
// Single node, output straight away.
drupal_set_title(t('Node export of !title', array(
'!title' => check_plain($nodes->title),
)));
return drupal_get_form('node_export_form', $nids, $code_string, $format);
}
elseif ($nodes) {
// Node operation, add to session and redirect.
$_SESSION['node_export'][] = array(
'code_string' => $code_string,
'nids' => $nids,
);
drupal_goto('admin/content/node_export');
}
elseif (!$nodes) {
// No $nodes passed, but $code_string came from session.
return drupal_get_form('node_export_form', $nids, $code_string, $format);
}
}
else {
// Get file.
node_export_get_file($nids, $code_string, $format);
}
}
/**
* Convert a node, nodes, or nids into an array of nids.
*/
function node_export_nodes_to_nids($nodes) {
if (is_object($nodes)) {
$nids = array(
$nodes->nid,
);
}
else {
$nids = array();
foreach ($nodes as $node) {
if (is_object($node)) {
$nids[] = $node->nid;
}
elseif (is_int($node)) {
$nids[] = $node;
}
}
}
return $nids;
}
/**
* Export form.
*
* @param $form_state
* The form state.
* @param $nids
* An array of node ids that are being exported.
* @param $code_string
* The Node export code.
* @param $format
* The Node export format.
*/
function node_export_form($form_state, $nids, $code_string, $format) {
$form = array();
if (empty($nids)) {
drupal_set_message(t('No content selected.'), 'warning');
$nids = array();
}
if (variable_get('node_export_code', 'all') == 'all') {
$form['nids'] = array(
'#type' => 'hidden',
'#value' => implode(', ', $nids),
);
$form['format'] = array(
'#type' => 'hidden',
'#value' => $format,
);
$form['download_file'] = array(
'#type' => 'submit',
'#value' => t('Download file'),
);
}
$form['export'] = array(
'#type' => 'textarea',
'#title' => t('Node export code'),
'#default_value' => $code_string,
'#rows' => 30,
'#description' => t('Copy this code and then on the site you want to import to, go to the <em>Node export: import</em> link under <em>Create content</em>, and paste it in there.'),
'#attributes' => array(
'wrap' => 'off',
),
'#wysiwyg' => FALSE,
);
return $form;
}
/**
* Export form submit function.
*
* File download was requested.
*/
function node_export_form_submit($form, &$form_state) {
// Get file.
$nids = explode(', ', $form_state['values']['nids']);
$code_string = $form_state['values']['export'];
$format = $form_state['values']['format'];
node_export_get_file($nids, $code_string, $format);
}
/**
* Generate text file.
*
* @param $nids
* An array of node ids.
* @param $code_string
* The text output.
* @param $format
* The format used.
*/
function node_export_get_file($nids, $code_string, $format = NULL) {
$filename_data = array();
$filename_data['count'] = count($nids);
$filename_data['time'] = time();
$filename_data['format'] = $format ? $format : 'export';
// Add a list of nids
if (count($nids) <= variable_get('node_export_file_list', 10)) {
$filename_data['list'] = '[' . implode(',', $nids) . ']';
}
$name = variable_get('node_export_filename', 'node-export[nid-list]([node-count]-nodes).[timestamp].[format]');
if (module_exists('token')) {
$name = token_replace($name, 'Node export filename', $filename_data, '[', ']');
}
else {
// So it works without token.
$name = str_replace('[nid-list]', $filename_data['list'], $name);
$name = str_replace('[node-count]', $filename_data['count'], $name);
$name = str_replace('[timestamp]', $filename_data['time'], $name);
$name = str_replace('[format]', $filename_data['format'], $name);
}
header('Content-type: text/plain');
header('Content-Disposition: attachment; filename="' . $name . '"');
print $code_string;
// Clean exit.
module_invoke_all('exit');
exit;
}
/**
* Import Form
*/
function node_export_import_form($form_state) {
// Initialise to prevent notices
$values = array(
'file' => FALSE,
'code' => FALSE,
);
$form = array();
$form['#attributes'] = array(
'enctype' => "multipart/form-data",
);
$form['#prefix'] = "<p>";
$form['#prefix'] .= t('You may import content by pasting or uploading the code exported from Node export.') . " ";
$form['#prefix'] .= t("Some values may be reset during imports depending on Node export's configuration.");
$form['#prefix'] .= "</p>";
$form['upload'] = array(
'#type' => 'fieldset',
'#title' => t('Upload file'),
'#collapsible' => TRUE,
'#collapsed' => !$values['file'],
);
$form['upload']['file'] = array(
'#type' => 'file',
'#description' => t('To clear this field, <a href="!reset">reset the form</a>.', array(
'!reset' => url($_GET['q']),
)),
);
$form['paste'] = array(
'#type' => 'fieldset',
'#title' => t('Paste code'),
'#collapsible' => TRUE,
'#collapsed' => !$values['code'],
);
$form['paste']['code'] = array(
'#type' => 'textarea',
'#default_value' => '',
'#rows' => 30,
'#description' => t('Cut and paste the code of an exported node here.'),
'#wysiwyg' => FALSE,
);
$form['#redirect'] = FALSE;
$form['submit'] = array(
'#type' => 'submit',
'#value' => t('Import'),
'#suffix' => l(t('Reset the form'), $_GET['q']),
);
return $form;
}
/**
* Validate function for import form.
*/
function node_export_import_form_validate($form, &$form_state) {
if ($form_state['clicked_button']['#id'] == 'edit-submit' && !$_FILES['files']['name']['file'] && !$form_state['values']['code']) {
drupal_set_message(t('Please upload a file or paste code to import.'), 'error');
form_set_error('', NULL);
}
}
/**
* Submit function for import form.
*/
function node_export_import_form_submit($form, &$form_state) {
if ($_FILES['files']['name']['file']) {
$original = $_FILES['files']['name']['file'];
$directory = file_directory_path() . '/' . NODE_EXPORT;
if (file_check_directory($directory, FILE_CREATE_DIRECTORY)) {
$save = file_save_upload('file', array(), $directory, FILE_EXISTS_RENAME);
if (!$save) {
drupal_set_message(t('Error: Node export could not save file.'), 'error');
}
else {
$save->original = $original;
form_set_value($form['upload']['file'], serialize($save), $form_state);
}
}
else {
drupal_set_message(t('Error: Node export could not access files directory.'), 'error');
}
}
if ($form_state['values']['file']) {
$file = unserialize($form_state['values']['file']);
if (file_exists($file->filepath)) {
$code_string = file_get_contents($file->filepath);
unlink($file->filepath);
}
}
elseif ($form_state['values']['code']) {
$code_string = trim($form_state['values']['code']);
}
if (isset($code_string)) {
$result = node_export_import($code_string);
// Output the status or error messages.
foreach ($result['output'] as $output) {
drupal_set_message($output, $result['success'] ? 'status' : 'error');
}
// We need to send this user somewhere, and we know they have permission
// for this page:
drupal_goto('node/add/node_export');
}
}Functions
Name |
Description |
|---|---|
| node_export_form | Export form. |
| node_export_form_submit | Export form submit function. |
| node_export_get_file | Generate text file. |
| node_export_gui | Export GUI function. |
| node_export_import_form | Import Form |
| node_export_import_form_submit | Submit function for import form. |
| node_export_import_form_validate | Validate function for import form. |
| node_export_nodes_to_nids | Convert a node, nodes, or nids into an array of nids. |
| node_export_settings | Menu callback to configure module settings. |
| node_export_settings_token_bits | Handles the bits of the form that are specific to the token module. |
| node_export_token_list | Implementation of hook_token_list(). |
| node_export_token_values | Implementation of hook_token_values(). |
Constants
|
Name |
Description |
|---|---|
| NODE_EXPORT |