Newer
Older
// $Id$
* The core that allows content to be submitted to the site. Modules and scripts may
* programmatically submit nodes using the usual form API pattern.
Kjartan Mannes
committed
define('NODE_NEW_LIMIT', time() - 30 * 24 * 60 * 60);
Gábor Hojtsy
committed
define('NODE_BUILD_NORMAL', 0);
define('NODE_BUILD_PREVIEW', 1);
define('NODE_BUILD_SEARCH_INDEX', 2);
define('NODE_BUILD_SEARCH_RESULT', 3);
define('NODE_BUILD_RSS', 4);
Gábor Hojtsy
committed
Gábor Hojtsy
committed
function node_help($path, $arg) {
// Remind site administrators about the {node_access} table being flagged
// for rebuild. We don't need to issue the message on the confirm form, or
// while the rebuild is being processed.
if ($path != 'admin/content/node-settings/rebuild' && $path != 'batch' && strpos($path, '#') === FALSE
&& user_access('access administration pages') && node_access_needs_rebuild()) {
if ($path == 'admin/content/node-settings') {
$message = t('The content access permissions need to be rebuilt.');
}
else {
$message = t('The content access permissions need to be rebuilt. Please visit <a href="@node_access_rebuild">this page</a>.', array('@node_access_rebuild' => url('admin/content/node-settings/rebuild')));
}
drupal_set_message($message, 'error');
}
Gábor Hojtsy
committed
switch ($path) {
$output = '<p>'. t('The node module manages content on your site, and stores all posts (regardless of type) as a "node". In addition to basic publishing settings, including whether the post has been published, promoted to the site front page, or should remain present (or sticky) at the top of lists, the node module also records basic information about the author of a post. Optional revision control over edits is available. For additional functionality, the node module is often extended by other modules.') .'</p>';
$output .= '<p>'. t('Though each post on your site is a node, each post is also of a particular <a href="@content-type">content type</a>. <a href="@content-type">Content types</a> are used to define the characteristics of a post, including the title and description of the fields displayed on its add and edit pages. Each content type may have different default settings for <em>Publishing options</em> and other workflow controls. By default, the two content types in a standard Drupal installation are <em>Page</em> and <em>Story</em>. Use the <a href="@content-type">content types page</a> to add new or edit existing content types. Additional content types also become available as you enable additional core, contributed and custom modules.', array('@content-type' => url('admin/content/types'))) .'</p>';
$output .= '<p>'. t('The administrative <a href="@content">content page</a> allows you to review and manage your site content. The <a href="@post-settings">post settings page</a> sets certain options for the display of posts. The node module makes a number of permissions available for each content type, which may be set by role on the <a href="@permissions">permissions page</a>.', array('@content' => url('admin/content/node'), '@post-settings' => url('admin/content/node-settings'), '@permissions' => url('admin/user/permissions'))) .'</p>';
Gábor Hojtsy
committed
$output .= '<p>'. t('For more information, see the online handbook entry for <a href="@node">Node module</a>.', array('@node' => 'http://drupal.org/handbook/modules/node/')) .'</p>';
Gábor Hojtsy
committed
case 'admin/content/node':
return ' '; // Return a non-null value so that the 'more help' link is shown.
Neil Drumm
committed
case 'admin/content/types':
return '<p>'. t('Below is a list of all the content types on your site. All posts that exist on your site are instances of one of these content types.') .'</p>';
case 'admin/content/types/add':
return '<p>'. t('To create a new content type, enter the human-readable name, the machine-readable name, and all other relevant fields that are on this page. Once created, users of your site will be able to create posts that are instances of this content type.') .'</p>';
Gábor Hojtsy
committed
case 'node/%/revisions':
return '<p>'. t('The revisions let you track differences between multiple versions of a post.') .'</p>';
case 'node/%/edit':
$node = node_load($arg[1]);
$type = node_get_types('type', $node->type);
Gábor Hojtsy
committed
return (!empty($type->help) ? '<p>'. filter_xss_admin($type->help) .'</p>' : '');
Gábor Hojtsy
committed
if ($arg[0] == 'node' && $arg[1] == 'add' && $arg[2]) {
$type = node_get_types('type', str_replace('-', '_', $arg[2]));
Gábor Hojtsy
committed
return (!empty($type->help) ? '<p>'. filter_xss_admin($type->help) .'</p>' : '');
Dries Buytaert
committed
}
Dries Buytaert
committed
/**
* Implementation of hook_theme()
*/
function node_theme() {
return array(
Dries Buytaert
committed
'node' => array(
'arguments' => array('node' => NULL, 'teaser' => FALSE, 'page' => FALSE),
'template' => 'node',
Dries Buytaert
committed
),
Dries Buytaert
committed
'node_list' => array(
'arguments' => array('items' => NULL, 'title' => NULL),
),
'node_search_admin' => array(
'arguments' => array('form' => NULL),
),
'node_filter_form' => array(
'arguments' => array('form' => NULL),
'file' => 'node.admin.inc',
Dries Buytaert
committed
),
'node_filters' => array(
'arguments' => array('form' => NULL),
'file' => 'node.admin.inc',
Dries Buytaert
committed
),
'node_admin_nodes' => array(
'arguments' => array('form' => NULL),
'file' => 'node.admin.inc',
),
'node_add_list' => array(
'arguments' => array('content' => NULL),
'file' => 'node.pages.inc',
Dries Buytaert
committed
),
'node_form' => array(
'arguments' => array('form' => NULL),
'file' => 'node.pages.inc',
Dries Buytaert
committed
),
'node_preview' => array(
'arguments' => array('node' => NULL),
'file' => 'node.pages.inc',
Dries Buytaert
committed
),
'node_log_message' => array(
'arguments' => array('log' => NULL),
),
Gábor Hojtsy
committed
'node_submitted' => array(
'arguments' => array('node' => NULL),
),
Dries Buytaert
committed
);
}
Kjartan Mannes
committed
function node_cron() {
db_query('DELETE FROM {history} WHERE timestamp < %d', NODE_NEW_LIMIT);
Kjartan Mannes
committed
}
/**
* Gather a listing of links to nodes.
*
* @param $result
Dries Buytaert
committed
* A DB result object from a query to fetch node objects. If your query
* joins the <code>node_comment_statistics</code> table so that the
* <code>comment_count</code> field is available, a title attribute will
* be added to show the number of comments.
* @param $title
* A heading for the resulting list.
*
* @return
Dries Buytaert
committed
* An HTML list suitable as content for a block, or FALSE if no result can
* fetch from DB result object.
Dries Buytaert
committed
$items = array();
Dries Buytaert
committed
$num_rows = FALSE;
Dries Buytaert
committed
$items[] = l($node->title, 'node/'. $node->nid, !empty($node->comment_count) ? array('title' => format_plural($node->comment_count, '1 comment', '@count comments')) : array());
Dries Buytaert
committed
$num_rows = TRUE;
Dries Buytaert
committed
return $num_rows ? theme('node_list', $items, $title) : FALSE;
Gábor Hojtsy
committed
*
* @ingroup themeable
/**
* Update the 'last viewed' timestamp of the specified node for current user.
*/
function node_tag_new($nid) {
global $user;
if ($user->uid) {
db_query('UPDATE {history} SET timestamp = %d WHERE uid = %d AND nid = %d', time(), $user->uid, $nid);
@db_query('INSERT INTO {history} (uid, nid, timestamp) VALUES (%d, %d, %d)', $user->uid, $nid, time());
/**
* Retrieves the timestamp at which the current user last viewed the
* specified node.
*/
$history[$nid] = db_fetch_object(db_query("SELECT timestamp FROM {history} WHERE uid = %d AND nid = %d", $user->uid, $nid));
return (isset($history[$nid]->timestamp) ? $history[$nid]->timestamp : 0);
Dries Buytaert
committed
* Decide on the type of marker to be displayed for a given node.
* @param $nid
* Node ID whose history supplies the "last viewed" timestamp.
* @param $timestamp
* Time which is compared against node's "last viewed" timestamp.
Dries Buytaert
committed
* @return
* One of the MARK constants.
Dries Buytaert
committed
function node_mark($nid, $timestamp) {
Dries Buytaert
committed
if (!$user->uid) {
return MARK_READ;
}
Dries Buytaert
committed
$cache[$nid] = node_last_viewed($nid);
Dries Buytaert
committed
if ($cache[$nid] == 0 && $timestamp > NODE_NEW_LIMIT) {
return MARK_NEW;
}
elseif ($timestamp > $cache[$nid] && $timestamp > NODE_NEW_LIMIT) {
return MARK_UPDATED;
}
return MARK_READ;
/**
* See if the user used JS to submit a teaser.
*/
Dries Buytaert
committed
function node_teaser_js(&$form, &$form_state) {
if (isset($form['#post']['teaser_js'])) {
Gábor Hojtsy
committed
// Glue the teaser to the body.
Dries Buytaert
committed
if (trim($form_state['values']['teaser_js'])) {
// Space the teaser from the body
Dries Buytaert
committed
$body = trim($form_state['values']['teaser_js']) ."\r\n<!--break-->\r\n". trim($form_state['values']['body']);
}
else {
// Empty teaser, no spaces.
Dries Buytaert
committed
$body = '<!--break-->'. $form_state['values']['body'];
Gábor Hojtsy
committed
// Pass updated body value on to preview/submit form processing.
Dries Buytaert
committed
form_set_value($form['body'], $body, $form_state);
Gábor Hojtsy
committed
// Pass updated body value back onto form for those cases
// in which the form is redisplayed.
$form['body']['#value'] = $body;
}
return $form;
}
* Ensure value of "teaser_include" checkbox is consistent with other form data.
Gábor Hojtsy
committed
*
* This handles two situations in which an unchecked checkbox is rejected:
*
* 1. The user defines a teaser (summary) but it is empty;
* 2. The user does not define a teaser (summary) (in this case an
* unchecked checkbox would cause the body to be empty, or missing
* the auto-generated teaser).
*
* If JavaScript is active then it is used to force the checkbox to be
Gábor Hojtsy
committed
* checked when hidden, and so the second case will not arise.
*
* In either case a warning message is output.
*/
function node_teaser_include_verify(&$form, &$form_state) {
$message = '';
Gábor Hojtsy
committed
// $form['#post'] is set only when the form is built for preview/submit.
if (isset($form['#post']['body']) && isset($form_state['values']['teaser_include']) && !$form_state['values']['teaser_include']) {
// "teaser_include" checkbox is present and unchecked.
if (strpos($form_state['values']['body'], '<!--break-->') === 0) {
// Teaser is empty string.
Gábor Hojtsy
committed
$message = t('You specified that the summary should not be shown when this post is displayed in full view. This setting is ignored when the summary is empty.');
}
elseif (strpos($form_state['values']['body'], '<!--break-->') === FALSE) {
// Teaser delimiter is not present in the body.
$message = t('You specified that the summary should not be shown when this post is displayed in full view. This setting has been ignored since you have not defined a summary for the post. (To define a summary, insert the delimiter "<!--break-->" (without the quotes) in the Body of the post to indicate the end of the summary and the start of the main content.)');
}
Gábor Hojtsy
committed
if (!empty($message)) {
drupal_set_message($message, 'warning');
// Pass new checkbox value on to preview/submit form processing.
form_set_value($form['teaser_include'], 1, $form_state);
// Pass new checkbox value back onto form for those cases
// in which form is redisplayed.
$form['teaser_include']['#value'] = 1;
}
}
return $form;
}
/**
* Generate a teaser for a node body.
Gábor Hojtsy
committed
* If the end of the teaser is not indicated using the <!--break--> delimiter
Gábor Hojtsy
committed
* then we generate the teaser automatically, trying to end it at a sensible
* place such as the end of a paragraph, a line break, or the end of a
* sentence (in that order of preference).
Gábor Hojtsy
committed
*
* @param $body
* The content for which a teaser will be generated.
* @param $format
* The format of the content. If the content contains PHP code, we do not
Gábor Hojtsy
committed
* split it up to prevent parse errors. If the line break filter is present
* then we treat newlines embedded in $body as line breaks.
* @param $size
* The desired character length of the teaser. If omitted, the default
Gábor Hojtsy
committed
* value will be used. Ignored if the special delimiter is present
Gábor Hojtsy
committed
* in $body.
* @return
* The generated teaser.
function node_teaser($body, $format = NULL, $size = NULL) {
if (!isset($size)) {
$size = variable_get('teaser_length', 600);
}
// Find where the delimiter is in the body
Steven Wittens
committed
// If the size is zero, and there is no delimiter, the entire body is the teaser.
if ($size == 0 && $delimiter === FALSE) {
// If a valid delimiter has been specified, use it to chop off the teaser.
if ($delimiter !== FALSE) {
return substr($body, 0, $delimiter);
}
Steven Wittens
committed
// We check for the presence of the PHP evaluator filter in the current
// format. If the body contains PHP code, we do not split it up to prevent
// parse errors.
if (isset($format)) {
$filters = filter_list_format($format);
Gábor Hojtsy
committed
if (isset($filters['php/0']) && strpos($body, '<?') !== FALSE) {
Steven Wittens
committed
return $body;
}
Steven Wittens
committed
}
Steven Wittens
committed
// If we have a short body, the entire body is the teaser.
Gábor Hojtsy
committed
if (drupal_strlen($body) <= $size) {
Gábor Hojtsy
committed
// If the delimiter has not been specified, try to split at paragraph or
// sentence boundaries.
Steven Wittens
committed
// The teaser may not be longer than maximum length specified. Initial slice.
$teaser = truncate_utf8($body, $size);
Gábor Hojtsy
committed
// Store the actual length of the UTF8 string -- which might not be the same
// as $size.
$max_rpos = strlen($teaser);
// How much to cut off the end of the teaser so that it doesn't end in the
// middle of a paragraph, sentence, or word.
// Initialize it to maximum in order to find the minimum.
$min_rpos = $max_rpos;
// Store the reverse of the teaser. We use strpos on the reversed needle and
// haystack for speed and convenience.
Steven Wittens
committed
$reversed = strrev($teaser);
Gábor Hojtsy
committed
// Build an array of arrays of break points grouped by preference.
$break_points = array();
// A paragraph near the end of sliced teaser is most preferable.
$break_points[] = array('</p>' => 0);
Gábor Hojtsy
committed
// If no complete paragraph then treat line breaks as paragraphs.
$line_breaks = array('<br />' => 6, '<br>' => 4);
// Newline only indicates a line break if line break converter
// filter is present.
if (isset($filters['filter/1'])) {
$line_breaks["\n"] = 1;
}
$break_points[] = $line_breaks;
Gábor Hojtsy
committed
// If the first paragraph is too long, split at the end of a sentence.
$break_points[] = array('. ' => 1, '! ' => 1, '? ' => 1, '。' => 0, '؟ ' => 1);
// Iterate over the groups of break points until a break point is found.
foreach ($break_points as $points) {
// Look for each break point, starting at the end of the teaser.
foreach ($points as $point => $offset) {
// The teaser is already reversed, but the break point isn't.
$rpos = strpos($reversed, strrev($point));
if ($rpos !== FALSE) {
$min_rpos = min($rpos + $offset, $min_rpos);
}
Steven Wittens
committed
}
Gábor Hojtsy
committed
// If a break point was found in this group, slice and return the teaser.
if ($min_rpos !== $max_rpos) {
// Don't slice with length 0. Length must be <0 to slice from RHS.
return ($min_rpos === 0) ? $teaser : substr($teaser, 0, 0 - $min_rpos);
Steven Wittens
committed
}
}
Gábor Hojtsy
committed
// If a break point was not found, still return a teaser.
return $teaser;
Neil Drumm
committed
/**
* Builds a list of available node types, and returns all of part of this list
* in the specified format.
*
* @param $op
* The format in which to return the list. When this is set to 'type',
* 'module', or 'name', only the specified node type is returned. When set to
* 'types' or 'names', all node types are returned.
* @param $node
* A node object, array, or string that indicates the node type to return.
* Leave at default value (NULL) to return a list of all node types.
* @param $reset
* Whether or not to reset this function's internal cache (defaults to
* FALSE).
*
* @return
* Either an array of all available node types, or a single node type, in a
* variable format. Returns FALSE if the node type is not found.
Neil Drumm
committed
*/
function node_get_types($op = 'types', $node = NULL, $reset = FALSE) {
static $_node_types, $_node_names;
Neil Drumm
committed
if ($reset || !isset($_node_types)) {
list($_node_types, $_node_names) = _node_types_build();
}
Neil Drumm
committed
if ($node) {
if (is_array($node)) {
$type = $node['type'];
}
elseif (is_object($node)) {
$type = $node->type;
}
elseif (is_string($node)) {
$type = $node;
}
Neil Drumm
committed
if (!isset($_node_types[$type])) {
return FALSE;
}
}
switch ($op) {
Neil Drumm
committed
case 'types':
return $_node_types;
case 'type':
return isset($_node_types[$type]) ? $_node_types[$type] : FALSE;
Neil Drumm
committed
case 'module':
return isset($_node_types[$type]->module) ? $_node_types[$type]->module : FALSE;
Neil Drumm
committed
case 'names':
return $_node_names;
case 'name':
return isset($_node_names[$type]) ? $_node_names[$type] : FALSE;
Neil Drumm
committed
}
}
/**
* Resets the database cache of node types, and saves all new or non-modified
* module-defined node types to the database.
*/
function node_types_rebuild() {
_node_types_build();
$node_types = node_get_types('types', NULL, TRUE);
foreach ($node_types as $type => $info) {
if (!empty($info->is_new)) {
node_type_save($info);
}
Dries Buytaert
committed
if (!empty($info->disabled)) {
node_type_delete($info->type);
}
}
Neil Drumm
committed
_node_types_build();
}
Neil Drumm
committed
* Saves a node type to the database.
*
* @param $info
* The node type to save, as an object.
Neil Drumm
committed
* Status flag indicating outcome of the operation.
Neil Drumm
committed
function node_type_save($info) {
$is_existing = FALSE;
$existing_type = !empty($info->old_type) ? $info->old_type : $info->type;
Dries Buytaert
committed
$is_existing = db_result(db_query("SELECT COUNT(*) FROM {node_type} WHERE type = '%s'", $existing_type));
Steven Wittens
committed
if (!isset($info->help)) {
$info->help = '';
}
if (!isset($info->min_word_count)) {
$info->min_word_count = 0;
}
if (!isset($info->body_label)) {
$info->body_label = '';
}
Neil Drumm
committed
if ($is_existing) {
db_query("UPDATE {node_type} SET type = '%s', name = '%s', module = '%s', has_title = %d, title_label = '%s', has_body = %d, body_label = '%s', description = '%s', help = '%s', min_word_count = %d, custom = %d, modified = %d, locked = %d WHERE type = '%s'", $info->type, $info->name, $info->module, $info->has_title, $info->title_label, $info->has_body, $info->body_label, $info->description, $info->help, $info->min_word_count, $info->custom, $info->modified, $info->locked, $existing_type);
Neil Drumm
committed
module_invoke_all('node_type', 'update', $info);
Neil Drumm
committed
return SAVED_UPDATED;
}
else {
db_query("INSERT INTO {node_type} (type, name, module, has_title, title_label, has_body, body_label, description, help, min_word_count, custom, modified, locked, orig_type) VALUES ('%s', '%s', '%s', %d, '%s', %d, '%s', '%s', '%s', %d, %d, %d, %d, '%s')", $info->type, $info->name, $info->module, $info->has_title, $info->title_label, $info->has_body, $info->body_label, $info->description, $info->help, $info->min_word_count, $info->custom, $info->modified, $info->locked, $info->orig_type);
Neil Drumm
committed
module_invoke_all('node_type', 'insert', $info);
Neil Drumm
committed
return SAVED_NEW;
}
}
Dries Buytaert
committed
/**
* Deletes a node type from the database.
*
* @param $type
* The machine-readable name of the node type to be deleted.
*/
function node_type_delete($type) {
$info = node_get_types('type', $type);
db_query("DELETE FROM {node_type} WHERE type = '%s'", $type);
module_invoke_all('node_type', 'delete', $info);
}
/**
Neil Drumm
committed
* Updates all nodes of one type to be of another type.
*
Neil Drumm
committed
* The current node type of the nodes.
* @param $type
* The new node type of the nodes.
*
* @return
Neil Drumm
committed
* The number of nodes whose node type field was modified.
*/
Neil Drumm
committed
function node_type_update_nodes($old_type, $type) {
db_query("UPDATE {node} SET type = '%s' WHERE type = '%s'", $type, $old_type);
return db_affected_rows();
Dries Buytaert
committed
* Builds and returns the list of available node types.
*
* The list of types is built by querying hook_node_info() in all modules, and
* by comparing this information with the node types in the {node_type} table.
Neil Drumm
committed
function _node_types_build() {
$_node_types = array();
$_node_names = array();
$info_array = module_invoke_all('node_info');
foreach ($info_array as $type => $info) {
$info['type'] = $type;
$_node_types[$type] = (object) _node_type_set_defaults($info);
$_node_names[$type] = $info['name'];
}
$type_result = db_query(db_rewrite_sql('SELECT nt.type, nt.* FROM {node_type} nt ORDER BY nt.type ASC', 'nt', 'type'));
while ($type_object = db_fetch_object($type_result)) {
Dries Buytaert
committed
// Check for node types from disabled modules and mark their types for removal.
// Types defined by the node module in the database (rather than by a separate
// module using hook_node_info) have a module value of 'node'.
if ($type_object->module != 'node' && empty($info_array[$type_object->type])) {
Gábor Hojtsy
committed
$type_object->disabled = TRUE;
Dries Buytaert
committed
}
Neil Drumm
committed
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
if (!isset($_node_types[$type_object->type]) || $type_object->modified) {
$_node_types[$type_object->type] = $type_object;
$_node_names[$type_object->type] = $type_object->name;
if ($type_object->type != $type_object->orig_type) {
unset($_node_types[$type_object->orig_type]);
unset($_node_names[$type_object->orig_type]);
}
}
}
asort($_node_names);
return array($_node_types, $_node_names);
}
/**
* Set default values for a node type defined through hook_node_info().
*/
function _node_type_set_defaults($info) {
if (!isset($info['has_title'])) {
$info['has_title'] = TRUE;
}
if ($info['has_title'] && !isset($info['title_label'])) {
$info['title_label'] = t('Title');
}
if (!isset($info['has_body'])) {
$info['has_body'] = TRUE;
}
if ($info['has_body'] && !isset($info['body_label'])) {
$info['body_label'] = t('Body');
}
if (!isset($info['help'])) {
$info['help'] = '';
}
if (!isset($info['min_word_count'])) {
$info['min_word_count'] = 0;
}
Neil Drumm
committed
if (!isset($info['custom'])) {
$info['custom'] = FALSE;
}
if (!isset($info['modified'])) {
$info['modified'] = FALSE;
}
if (!isset($info['locked'])) {
$info['locked'] = TRUE;
}
$info['orig_type'] = $info['type'];
$info['is_new'] = TRUE;
return $info;
* Determine whether a node hook exists.
*
* @param &$node
* Either a node object, node array, or a string containing the node type.
* @param $hook
* A string containing the name of the hook.
* @return
* TRUE iff the $hook exists in the node type of $node.
*/
function node_hook(&$node, $hook) {
Neil Drumm
committed
$module = node_get_types('module', $node);
if ($module == 'node') {
$module = 'node_content'; // Avoid function name collisions.
}
return module_hook($module, $hook);
* Invoke a node hook.
*
* @param &$node
* Either a node object, node array, or a string containing the node type.
* @param $hook
* A string containing the name of the hook.
* @param $a2, $a3, $a4
* Arguments to pass on to the hook, after the $node argument.
* @return
*/
function node_invoke(&$node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
if (node_hook($node, $hook)) {
Neil Drumm
committed
$module = node_get_types('module', $node);
if ($module == 'node') {
$module = 'node_content'; // Avoid function name collisions.
}
$function = $module .'_'. $hook;
/**
* Invoke a hook_nodeapi() operation in all modules.
*
* @param &$node
* @param $op
* A string containing the name of the nodeapi operation.
* @param $a3, $a4
* Arguments to pass on to the hook, after the $node and $op arguments.
* @return
* The returned value of the invoked hooks.
*/
foreach (module_implements('nodeapi') as $name) {
$result = $function($node, $op, $a3, $a4);
Dries Buytaert
committed
if (isset($result) && is_array($result)) {
$return = array_merge($return, $result);
}
else if (isset($result)) {
$return[] = $result;
* @param $param
* Either the nid of the node or an array of conditions to match against in the database query
* @param $revision
* Which numbered revision to load. Defaults to the current version.
function node_load($param = array(), $revision = NULL, $reset = NULL) {
static $nodes = array();
if ($reset) {
$nodes = array();
}
$cachable = ($revision == NULL);
$arguments = array();
if (is_numeric($param)) {
if ($cachable) {
// Is the node statically cached?
if (isset($nodes[$param])) {
Dries Buytaert
committed
return is_object($nodes[$param]) ? clone $nodes[$param] : $nodes[$param];
}
$cond = 'n.nid = %d';
$arguments[] = $param;
Steven Wittens
committed
elseif (is_array($param)) {
// Turn the conditions into a query.
foreach ($param as $key => $value) {
$cond[] = 'n.'. db_escape_string($key) ." = '%s'";
$arguments[] = $value;
}
$cond = implode(' AND ', $cond);
Steven Wittens
committed
else {
return FALSE;
}
Dries Buytaert
committed
// Retrieve a field list based on the site's schema.
$fields = drupal_schema_fields_sql('node', 'n');
$fields = array_merge($fields, drupal_schema_fields_sql('node_revisions', 'r'));
$fields = array_merge($fields, array('u.name', 'u.picture', 'u.data'));
Gábor Hojtsy
committed
// Remove fields not needed in the query: n.vid and r.nid are redundant,
// n.title is unnecessary because the node title comes from the
// node_revisions table. We'll keep r.vid, r.title, and n.nid.
$fields = array_diff($fields, array('n.vid', 'n.title', 'r.nid'));
Dries Buytaert
committed
$fields = implode(', ', $fields);
Gábor Hojtsy
committed
// Rename timestamp field for clarity.
Dries Buytaert
committed
$fields = str_replace('r.timestamp', 'r.timestamp AS revision_timestamp', $fields);
Gábor Hojtsy
committed
// Change name of revision uid so it doesn't conflict with n.uid.
$fields = str_replace('r.uid', 'r.uid AS revision_uid', $fields);
Dries Buytaert
committed
// No db_rewrite_sql is applied so as to get complete indexing for search.
array_unshift($arguments, $revision);
Gábor Hojtsy
committed
$node = db_fetch_object(db_query('SELECT '. $fields .' FROM {node} n INNER JOIN {users} u ON u.uid = n.uid INNER JOIN {node_revisions} r ON r.nid = n.nid AND r.vid = %d WHERE '. $cond, $arguments));
Gábor Hojtsy
committed
$node = db_fetch_object(db_query('SELECT '. $fields .' FROM {node} n INNER JOIN {users} u ON u.uid = n.uid INNER JOIN {node_revisions} r ON r.vid = n.vid WHERE '. $cond, $arguments));
// Call the node specific callback (if any) and piggy-back the
// results to the node or overwrite some values.
if ($extra = node_invoke($node, 'load')) {
foreach ($extra as $key => $value) {
$node->$key = $value;
}
if ($extra = node_invoke_nodeapi($node, 'load')) {
foreach ($extra as $key => $value) {
$node->$key = $value;
}
}
if ($cachable) {
Dries Buytaert
committed
$nodes[$node->nid] = is_object($node) ? clone $node : $node;
/**
* Perform validation checks on the given node.
*/
function node_validate($node, $form = array()) {
// Convert the node to an object, if necessary.
$node = (object)$node;
$type = node_get_types('type', $node);
// Make sure the body has the minimum number of words.
Gábor Hojtsy
committed
// TODO : use a better word counting algorithm that will work in other languages
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
if (!empty($type->min_word_count) && isset($node->body) && count(explode(' ', $node->body)) < $type->min_word_count) {
form_set_error('body', t('The body of your @type is too short. You need at least %words words.', array('%words' => $type->min_word_count, '@type' => $type->name)));
}
if (isset($node->nid) && (node_last_changed($node->nid) > $node->changed)) {
form_set_error('changed', t('This content has been modified by another user, changes cannot be saved.'));
}
if (user_access('administer nodes')) {
// Validate the "authored by" field.
if (!empty($node->name) && !($account = user_load(array('name' => $node->name)))) {
// The use of empty() is mandatory in the context of usernames
// as the empty string denotes the anonymous user. In case we
// are dealing with an anonymous user we set the user ID to 0.
form_set_error('name', t('The username %name does not exist.', array('%name' => $node->name)));
}
// Validate the "authored on" field. As of PHP 5.1.0, strtotime returns FALSE instead of -1 upon failure.
if (!empty($node->date) && strtotime($node->date) <= 0) {
form_set_error('date', t('You have to specify a valid date.'));
}
}
// Do node-type-specific validation checks.
node_invoke($node, 'validate', $form);
node_invoke_nodeapi($node, 'validate', $form);
}
/**
* Prepare node for save and allow modules to make changes.
*/
function node_submit($node) {
global $user;
// Convert the node to an object, if necessary.
$node = (object)$node;
Gábor Hojtsy
committed
// Generate the teaser, but only if it hasn't been set (e.g. by a
// module-provided 'teaser' form item).
if (!isset($node->teaser)) {
if (isset($node->body)) {
$node->teaser = node_teaser($node->body, isset($node->format) ? $node->format : NULL);
Gábor Hojtsy
committed
// Chop off the teaser from the body if needed. The teaser_include
// property might not be set (eg. in Blog API postings), so only act on
// it, if it was set with a given value.
if (isset($node->teaser_include) && !$node->teaser_include && $node->teaser == substr($node->body, 0, strlen($node->teaser))) {
$node->body = substr($node->body, strlen($node->teaser));
}
}
else {
$node->teaser = '';
}
}
if (user_access('administer nodes')) {
// Populate the "authored by" field.
if ($account = user_load(array('name' => $node->name))) {
$node->uid = $account->uid;
}
else {
$node->uid = 0;
}
}
Gábor Hojtsy
committed
$node->created = !empty($node->date) ? strtotime($node->date) : time();
$node->validated = TRUE;
return $node;
}
// Let modules modify the node before it is saved to the database.
node_invoke_nodeapi($node, 'presave');
$node->is_new = FALSE;
$node->is_new = TRUE;
Gábor Hojtsy
committed
// When inserting a node, $node->log must be set because
// {node_revisions}.log does not (and cannot) have a default
// value. If the user does not have permission to create
// revisions, however, the form will not contain an element for
// log so $node->log will be unset at this point.
if (!isset($node->log)) {
$node->log = '';
}
Gábor Hojtsy
committed
// For the same reasons, make sure we have $node->teaser and
// $node->body. We should consider making these fields nullable
// in a future version since node types are not required to use them.
if (!isset($node->teaser)) {
$node->teaser = '';
}
if (!isset($node->body)) {
$node->body = '';
}
Dries Buytaert
committed
elseif (!empty($node->revision)) {
$node->old_vid = $node->vid;
}
Dries Buytaert
committed
// When updating a node, avoid clobberring an existing log entry with an empty one.
if (empty($node->log)) {
unset($node->log);
// Set some required fields:
if (empty($node->created)) {
$node->created = time();
}
// The changed timestamp is always updated for bookkeeping purposes (revisions, searching, ...)
$node->changed = time();
Dries Buytaert
committed
$node->timestamp = time();
$node->format = isset($node->format) ? $node->format : FILTER_FORMAT_DEFAULT;
Dries Buytaert
committed
$update_node = TRUE;
Dries Buytaert
committed
Gábor Hojtsy
committed
// Generate the node table query and the node_revisions table query.
if ($node->is_new) {
Dries Buytaert
committed
drupal_write_record('node', $node);
_node_save_revision($node, $user->uid);
Dries Buytaert
committed
$op = 'insert';
Dries Buytaert
committed
drupal_write_record('node', $node, 'nid');
Dries Buytaert
committed
if (!empty($node->revision)) {
_node_save_revision($node, $user->uid);
_node_save_revision($node, $user->uid, 'vid');
Dries Buytaert
committed
$update_node = FALSE;
Dries Buytaert
committed
$op = 'update';
Dries Buytaert
committed
if ($update_node) {
db_query('UPDATE {node} SET vid = %d WHERE nid = %d', $node->vid, $node->nid);
Dries Buytaert
committed
}
Gábor Hojtsy
committed
// Call the node specific callback (if any).
Dries Buytaert
committed
node_invoke($node, $op);
node_invoke_nodeapi($node, $op);
// Update the node access table for this node.
node_access_acquire_grants($node);
// Clear the page and block caches.
/**
Gábor Hojtsy
committed
* Helper function to save a revision with the uid of the current user.
*
* Node is taken by reference, becuse drupal_write_record() updates the
* $node with the revision id, and we need to pass that back to the caller.
*/
Gábor Hojtsy
committed
function _node_save_revision(&$node, $uid, $update = NULL) {
$temp_uid = $node->uid;
$node->uid = $uid;
if (isset($update)) {
drupal_write_record('node_revisions', $node, $update);
}
else {
drupal_write_record('node_revisions', $node);
}
$node->uid = $temp_uid;
}
/**
* Delete a node.
*/
function node_delete($nid) {
$node = node_load($nid);
if (node_access('delete', $node)) {
db_query('DELETE FROM {node} WHERE nid = %d', $node->nid);
db_query('DELETE FROM {node_revisions} WHERE nid = %d', $node->nid);
// Call the node-specific callback (if any):
node_invoke($node, 'delete');
node_invoke_nodeapi($node, 'delete');
// Clear the page and block caches.
cache_clear_all();
// Remove this node from the search index if needed.
if (function_exists('search_wipe')) {
search_wipe($node->nid, 'node');
}
watchdog('content', '@type: deleted %title.', array('@type' => $node->type, '%title' => $node->title));
Gábor Hojtsy
committed
drupal_set_message(t('@type %title has been deleted.', array('@type' => node_get_types('name', $node), '%title' => $node->title)));
/**
* Generate a display of the given node.
*
* @param $node
* A node array or node object.
* @param $teaser
Dries Buytaert
committed
* Whether to display the teaser only or the full form.
* @param $page
* Whether the node is being displayed by itself as a page.
Dries Buytaert
committed
* @param $links
* Whether or not to display node links. Links are omitted for node previews.
*
* @return
* An HTML representation of the themed node.
*/
Dries Buytaert
committed
function node_view($node, $teaser = FALSE, $page = FALSE, $links = TRUE) {