The core of the Drupal system is the node. All of the contents of the system are placed in nodes, or extensions of nodes.
A base node contains:
A Title
Up to 128 characters of text that titles the node.
A Teaser
A small block of text that is meant to get you interested in the rest of node. Drupal will automatically pull a small amount of the body of the node to make the teaser (To configure how long the teaser will be click here). The teaser can be changed if you don't like what Drupal grabs.
The Body
The main text that comprises your content.
A Type
What kind of node is this? Blog, book, forum, comment, unextended, etc.
An Author
The author's name. It will either be \"anonymous\" or a valid user. You cannot set it to an arbitrary value.
Authored on
The date the node was written.
Changed
The last time this node was changed.
Sticky at top of lists
In listings such as the frontpage or a taxonomy overview the teasers of a selected amount of nodes is displayed. If you want to force a node to appear on the top of such a listing, you must set it to 'sticky'. This way it will float to the top of a listing, and it will not be pushed down by newer content.
Allow user comments
A node can have comments. These comments can be written by other users (Read-write), or only by admins (Read-only).
Revisions
Drupal has a revision system so that you can \"roll back\" to an older version of a post if the new version is not what you want.
Promote to front page
To get people to look at the new stuff on your site you can choose to move it to the front page. The front page is configured to show the teasers from only a few of the total nodes you have on your site (To configure how many teasers click here).
In moderation queue
Drupal has a moderation system. If it is active, a node is in one of three states: approved and published, approved and unpublished, and awaiting approval. If you are moderating a node it should be in the moderation queue.
Votes
If you are moderating a node this counts how many votes the node has gotten. Once a node gets a certain number of vote it will either be approved or dropped.
Score
The score of the node is gotten by the votes it is given.
Users
The list of users who have voted on a moderated node.
Published
When using Drupal's moderation system a node remains unpublished -- unavailable to non-moderators -- until it is marked Published.
Now that you know what is in a node, here are some of the types of nodes available.
", array("%teaser" => url("admin/node/configure/settings")));
if ($mod == 'admin') {
foreach (node_list() as $type) {
$output .= '
';
$output .= implode("\n", module_invoke_all('help', 'node/add#'. $type));
}
}
return $output;
case 'admin/modules#description':
return t('The core that allows content to be submitted to the site.');
case 'admin/node/configure':
case 'admin/node/configure/settings':
return t('Settings for the core of Drupal. Almost everything is a node so these settings will affect most of the site.');
case 'admin/node':
return t('Below is a list of all of the posts on your site. Other forms of content are listed elsewhere (e.g. comments). Clicking a title views the post, while clicking an author\'s name edits their user information. Other post-related tasks are available from the menu.', array('%comments' => url('admin/comment')));
case 'admin/node/search':
return t('Enter a simple pattern to search for a post. This can include the wildcard character *. For example, a search for "br*" might return "bread bakers", "our daily bread" and "brenda".');
case 'admin/node/configure/defaults':
return t('This page lets you set the defaults used during creation of nodes for all the different node types. comment: Read/write setting for comments. publish: Is this post publicly viewable, has it been published? promote: Is this post to be promoted to the front page? moderate: Does this post need approval before it can be viewed? sticky: Is this post always visible at the top of lists? revision: Will this post go into the revision system allowing multiple versions to be saved?');
}
}
/**
* Implementation of hook_cron().
*/
function node_cron() {
db_query('DELETE FROM {history} WHERE timestamp < %d', NODE_NEW_LIMIT);
}
/**
* Menu callback; presents node-specific imformation from admin/help.
*/
function node_help_page() {
print theme('page', node_help('admin/help#node'));
}
/**
* Gather a listing of links to nodes.
*
* @param $result
* A DB result object from a query to fetch node objects.
* @param $title
* A heading for the resulting list.
*
* @return
* An HTML list suitable as content for a block.
*/
function node_title_list($result, $title = NULL) {
while ($node = db_fetch_object($result)) {
$number = module_invoke('comment', 'num_all', $node->nid);
$items[] = l($node->title, "node/$node->nid", array('title' => format_plural($number, '1 comment', '%count comments')));
}
return theme('node_list', $items, $title);
}
/**
* Format a listing of links to nodes.
*/
function theme_node_list($items, $title = NULL) {
return theme('item_list', $items, $title);
}
/**
* Update the 'last viewed' timestamp of the specified node for current user.
*/
function node_tag_new($nid) {
global $user;
if ($user->uid) {
if (node_last_viewed($nid)) {
db_query('UPDATE {history} SET timestamp = %d WHERE uid = %d AND nid = %d', time(), $user->uid, $nid);
}
else {
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.
*/
function node_last_viewed($nid) {
global $user;
static $history;
if (!isset($history[$nid])) {
$history[$nid] = db_fetch_object(db_query("SELECT timestamp FROM {history} WHERE uid = '$user->uid' AND nid = %d", $nid));
}
return ($history[$nid]->timestamp ? $history[$nid]->timestamp : 0);
}
/**
* Determines whether the supplied timestamp is newer than the user's last view
* of 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.
*/
function node_is_new($nid, $timestamp) {
global $user;
static $cache;
if (!isset($cache[$nid])) {
if ($user->uid) {
$cache[$nid] = node_last_viewed($nid);
}
else {
$cache[$nid] = time();
}
}
return ($timestamp > $cache[$nid] && $timestamp > NODE_NEW_LIMIT);
}
/**
* Autogenerate a teaser for the given body text.
*/
function node_teaser($body) {
$size = variable_get('teaser_length', 600);
// find where the delimiter is in the body
$delimiter = strpos($body, '');
// If the size is zero, and there is no delimiter, we return the entire body.
if ($size == 0 && $delimiter == 0) {
return $body;
}
// If a valid delimiter has been specified, use it to chop of the teaser.
if ($delimiter > 0) {
return substr($body, 0, $delimiter);
}
// If we have a short body, return the entire body.
if (strlen($body) < $size) {
return $body;
}
// In some cases, no delimiter has been specified (e.g. when posting using
// the Blogger API). In this case, we try to split at paragraph boundaries.
if ($length = strpos($body, '', $size)) {
return substr($body, 0, $length + 4);
}
if ($length = strpos($body, ' ', $size)) {
return substr($body, 0, $length);
}
if ($length = strpos($body, ' ', $size)) {
return substr($body, 0, $length);
}
if ($length = strpos($body, "\n", $size)) {
return substr($body, 0, $length);
}
// When even the first paragraph is too long, try to split at the end of
// the next sentence.
if ($length = strpos($body, '. ', $size)) {
return substr($body, 0, $length + 1);
}
if ($length = strpos($body, '! ', $size)) {
return substr($body, 0, $length + 1);
}
if ($length = strpos($body, '? ', $size)) {
return substr($body, 0, $length + 1);
}
if ($length = strpos($body, '。', $size)) {
return substr($body, 0, $length + 1);
}
if ($length = strpos($body, '、', $size)) {
return substr($body, 0, $length + 1);
}
if ($length = strpos($body, '؟ ', $size)) {
return substr($body, 0, $length + 1);
}
// If all else fails, simply truncate the string.
return truncate_utf8($body, $size);
}
/**
* Determines the module that defines the node type of the given node.
*
* @param &$node
* Either a node object, a node array, or a string containing the node type.
* @return
* A string containing the name of the defining module.
*/
function node_get_module_name($node) {
if (is_array($node)) {
if ($pos = strpos($node['type'], '-')) {
return substr($node['type'], 0, $pos);
}
else {
return $node['type'];
}
}
else if (is_object($node)) {
if ($pos = strpos($node->type, '-')) {
return substr($node->type, 0, $pos);
}
else {
return $node->type;
}
}
else if (is_string($node)) {
if ($pos = strpos($node, '-')) {
return substr($node, 0, $pos);
}
else {
return $node;
}
}
}
/**
* Get a list of all the defined node types.
*
* @return
* An list of all node types.
*/
function node_list() {
$types = array();
foreach (module_list() as $module) {
if (module_hook($module, 'node_name')) {
$module_types = module_invoke($module, 'node_types');
if ($module_types) {
foreach ($module_types as $type) {
$types[] = $type;
}
}
else {
$types[] = $module;
}
}
}
return $types;
}
/**
* 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) {
$function = node_get_module_name($node) ."_$hook";
return function_exists($function);
}
/**
* 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
* The returned value of the invoked hook.
*/
function node_invoke(&$node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
$function = node_get_module_name($node) ."_$hook";
if (function_exists($function)) {
return ($function($node, $a2, $a3, $a4));
}
}
/**
* Invoke a hook_nodeapi() operation in all modules.
*
* @param &$node
* Either a node object, node array, or a string containing the node type.
* @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.
*/
function node_invoke_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL) {
$return = array();
foreach (module_list() as $name) {
$function = $name .'_nodeapi';
if (function_exists($function)) {
$result = $function($node, $op, $a3, $a4);
if (isset($result)) {
$return = array_merge($return, $result);
}
}
}
return $return;
}
/**
* Load a node object from the database.
*
* @param $conditions
* An array of conditions to match against in the database query. Most calls
* will simply use array('nid' => 52).
* @param $revision
* Which numbered revision to load. Defaults to the current version.
*
* @return
* A fully-populated node object.
*/
function node_load($conditions, $revision = -1) {
// Turn the conditions into a query.
foreach ($conditions as $key => $value) {
$cond[] = 'n.'. check_query($key) ." = '". check_query($value) ."'";
}
// Retrieve the node.
$node = db_fetch_object(db_query('SELECT n.*, u.uid, u.name, u.picture, u.data FROM {node} n INNER JOIN {users} u ON u.uid = n.uid WHERE '. implode(' AND ', $cond)));
$node = drupal_unpack($node);
// Unserialize the revisions and user data fields.
if ($node->revisions) {
$node->revisions = unserialize($node->revisions);
}
// 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;
}
}
// Return the desired revision.
if ($revision != -1 && isset($node->revisions[$revision])) {
$node = $node->revisions[$revision]['node'];
}
return $node;
}
/**
* Save a node object into the database.
*/
function node_save($node) {
// Fetch fields to save to node table:
$fields = node_invoke_nodeapi($node, 'fields');
// Serialize the revisions field:
if ($node->revisions) {
$node->revisions = serialize($node->revisions);
}
// Apply filters to some default node fields:
if (empty($node->nid)) {
// Insert a new node.
// Set some required fields:
if (!$node->created) {
$node->created = time();
}
if (!$node->changed) {
$node->changed = time();
}
$node->nid = db_next_id('{node}_nid');
// Prepare the query:
foreach ($node as $key => $value) {
if (in_array($key, $fields)) {
$k[] = check_query($key);
$v[] = $value;
$s[] = "'%s'";
}
}
$keysfmt = implode(', ', $s);
// We need to quote the placeholders for the values.
$valsfmt = "'". implode("', '", $s) ."'";
// Insert the node into the database:
db_query("INSERT INTO {node} (". implode(", ", $k) .") VALUES(". implode(", ", $s) .")", $v);
// Call the node specific callback (if any):
node_invoke($node, 'insert');
node_invoke_nodeapi($node, 'insert');
}
else {
// Update an existing node.
// Set some required fields:
$node->changed = time();
// Prepare the query:
foreach ($node as $key => $value) {
if (in_array($key, $fields)) {
$q[] = check_query($key) ." = '%s'";
$v[] = $value;
}
}
// Update the node in the database:
db_query("UPDATE {node} SET ". implode(', ', $q) ." WHERE nid = '$node->nid'", $v);
// Call the node specific callback (if any):
node_invoke($node, 'update');
node_invoke_nodeapi($node, 'update');
}
// Clear the cache so an anonymous poster can see the node being added or updated.
cache_clear_all();
// Return the node ID:
return $node->nid;
}
/**
* Generate a display of the given node.
*
* @param $node
* A node array or node object.
* @param $teaser
* Whether to display only the teaser for the node.
* @param $page
* Whether the node is being displayed by itself as a page.
*
* @return
* An HTML representation of the themed node.
*/
function node_view($node, $teaser = FALSE, $page = FALSE) {
$node = array2object($node);
// Remove the delimiter (if any) that seperates the teaser from the body.
// TODO: this strips legitimate uses of '' also.
$node->body = str_replace('', '', $node->body);
// The 'view' hook can be implemented to overwrite the default function
// to display nodes.
if (node_hook($node, 'view')) {
node_invoke($node, 'view', $teaser, $page);
}
else {
$node = node_prepare($node, $teaser);
}
// Allow modules to change $node->body before viewing.
node_invoke_nodeapi($node, 'view', $teaser, $page);
return theme('node', $node, $teaser, $page);
}
/**
* Apply filters to a node in preparation for theming.
*/
function node_prepare($node, $teaser = FALSE) {
$node->readmore = (strlen($node->teaser) < strlen($node->body));
if ($teaser == FALSE) {
$node->body = check_output($node->body);
}
else {
$node->teaser = check_output($node->teaser);
}
return $node;
}
/**
* Generate a page displaying a single node, along with its comments.
*/
function node_show($node, $cid) {
$output = node_view($node, FALSE, TRUE);
if (function_exists('comment_render') && $node->comment) {
$output .= comment_render($node, $cid);
}
// Update the history table, stating that this user viewed this node.
node_tag_new($node->nid);
return $output;
}
/**
* Implementation of hook_perm().
*/
function node_perm() {
return array('administer nodes', 'access content');
}
/**
* Implementation of hook_search().
*
* Return the results of performing a search using the indexed search
* for this particular type of node.
*
* Pass an array to the 'do_search' function which dictates what it
* will search through, and what it will search for
*
* "keys"'s value is the keywords entered by the user
*
* "type"'s value is used to identify the node type in the search
* index.
*
* "select"'s value is used to relate the data from the specific nodes
* table to the data that the search_index table has in it, and the the
* do_search functino will rank it.
*
* The select must always provide the following fields: lno, title,
* created, uid, name, and count.
*/
function node_search($keys) {
$find = do_search(array('keys' => $keys, 'type' => 'node', 'select' => "SELECT DISTINCT s.lno as lno, n.title as title, n.created as created, u.uid as uid, u.name as name, s.count as count FROM {search_index} s, {node} n ". node_access_join_sql() ." INNER JOIN {users} u ON n.uid = u.uid WHERE s.lno = n.nid AND s.type = 'node' AND s.word like '%' AND n.status = 1 AND ". node_access_where_sql()));
return array(t('Matching nodes ranked in order of relevance'), $find);
}
/**
* Menu callback; presents general node configuration options.
*/
function node_configure() {
if ($_POST) {
system_settings_save();
}
$output .= form_select(t('Number of posts on main page'), 'default_nodes_main', variable_get('default_nodes_main', 10), drupal_map_assoc(array(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30)), t('The default maximum number of posts to display per page on overview pages such as the main page.'));
$output .= form_select(t('Length of trimmed posts'), 'teaser_length', variable_get('teaser_length', 600), array(0 => t('Unlimited'), 200 => t('200 characters'), 400 => t('400 characters'), 600 => t('600 characters'), 800 => t('800 characters'), 1000 => t('1000 characters'), 1200 => t('1200 characters'), 1400 => t('1400 characters'), 1600 => t('1600 characters'), 1800 => t('1800 characters'), 2000 => t('2000 characters')), t("The maximum number of characters used in the trimmed version of a post. Drupal will use this setting to determine at which offset long posts should be trimmed. The trimmed version of a post is typically used as a teaser when displaying the post on the main page, in XML feeds, etc. To disable teasers, set to 'Unlimited'. Note that this setting will only affect new or updated content and will not affect existing teasers."));
$output .= form_radios(t('Preview post'), 'node_preview', variable_get('node_preview', 0), array(t('Optional'), t('Required')), t('Must users preview posts before submitting?'));
print theme('page', system_settings_form($output));
}
/**
* Retrieve the comment mode for the given node ID (none, read, or read/write).
*/
function node_comment_mode($nid) {
static $comment_mode;
if (!isset($comment_mode[$nid])) {
$comment_mode[$nid] = db_result(db_query('SELECT comment FROM {node} WHERE nid = %d', $nid));
}
return $comment_mode[$nid];
}
/**
* Implementation of hook_link().
*/
function node_link($type, $node = 0, $main = 0) {
$links = array();
if ($type == 'node') {
if (array_key_exists('links', $node)) {
$links = $node->links;
}
if ($main == 1 && $node->teaser && $node->readmore) {
$links[] = l(t('read more'), "node/$node->nid", array('title' => t('Read the rest of this posting.'), 'class' => 'read-more'));
}
}
return $links;
}
/**
* Implementation of hook_menu().
*/
function node_menu() {
$items = array();
$items[] = array('path' => 'admin/node', 'title' => t('content'),
'callback' => 'node_admin',
'access' => user_access('administer nodes'));
$items[] = array('path' => 'admin/node/overview', 'title' => t('list'),
'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
$items[] = array('path' => 'admin/node/configure', 'title' => t('configure'),
'callback' => 'node_configure',
'access' => user_access('administer nodes'),
'type' => MENU_LOCAL_TASK);
$items[] = array('path' => 'admin/node/configure/settings', 'title' => t('settings'),
'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
$items[] = array('path' => 'admin/node/configure/defaults', 'title' => t('default workflow'),
'callback' => 'node_default_settings',
'access' => user_access('administer nodes'),
'type' => MENU_LOCAL_TASK);
if (module_exist('search')) {
$items[] = array('path' => 'admin/node/search', 'title' => t('search'),
'callback' => 'node_admin',
'access' => user_access('administer nodes'),
'type' => MENU_LOCAL_TASK);
}
$items[] = array('path' => 'node', 'title' => t('content'),
'callback' => 'node_page',
'access' => user_access('access content'),
'type' => MENU_SUGGESTED_ITEM);
$items[] = array('path' => 'node/add', 'title' => t('create content'),
'callback' => 'node_page',
'access' => user_access('access content'),
'type' => MENU_ITEM_GROUPING,
'weight' => 1);
if (arg(0) == 'node' && is_numeric(arg(1))) {
$node = node_load(array('nid' => arg(1)));
$items[] = array('path' => 'node/'. arg(1), 'title' => t('view'),
'callback' => 'node_page',
'access' => node_access('view', $node),
'type' => MENU_CALLBACK);
$items[] = array('path' => 'node/'. arg(1) .'/view', 'title' => t('view'),
'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
$items[] = array('path' => 'node/'. arg(1) .'/edit', 'title' => t('edit'),
'callback' => 'node_page',
'access' => node_access('update', $node),
'weight' => 1,
'type' => MENU_LOCAL_TASK);
if ($node->revisions) {
$items[] = array('path' => 'node/'. arg(1) .'/revisions', 'title' => t('revisions'),
'callback' => 'node_page',
'access' => user_access('administer nodes'),
'weight' => 2,
'type' => MENU_LOCAL_TASK);
}
}
// Legacy handler for old "node/view/52" paths.
$items[] = array('path' => 'node/view', 'title' => t('view'),
'callback' => 'node_old_url',
'access' => user_access('access content'),
'type' => MENU_CALLBACK);
return $items;
}
function node_admin_edit($node) {
if (is_numeric($node)) {
$node = node_load(array('nid' => $node));
}
$output .= node_form($node);
// Display the node form extensions:
$output .= implode("\n", module_invoke_all('node_link', $node));
return $output;
}
/**
* Generate the content administation overview.
*/
function node_admin_nodes() {
$filters = array(
array(t('View posts that are new or updated'), 'ORDER BY n.changed DESC'),
array(t('View posts that need approval'), 'WHERE n.status = 0 OR n.moderate = 1 ORDER BY n.changed DESC'),
array(t('View posts that are promoted'), 'WHERE n.status = 1 AND n.promote = 1 ORDER BY n.changed DESC'),
array(t('View posts that are not promoted'), 'WHERE n.status = 1 AND n.promote = 0 ORDER BY n.changed DESC'),
array(t('View posts that are sticky'), 'WHERE n.status = 1 AND n.sticky = 1 ORDER BY n.changed DESC'),
array(t('View posts that are unpublished'), 'WHERE n.status = 0 AND n.moderate = 0 ORDER BY n.changed DESC')
);
$operations = array(
array(t('Approve the selected posts'), 'UPDATE {node} SET status = 1, moderate = 0 WHERE nid = %d'),
array(t('Promote the selected posts'), 'UPDATE {node} SET status = 1, promote = 1 WHERE nid = %d'),
array(t('Make the selected posts sticky'), 'UPDATE {node} SET status = 1, sticky = 1 WHERE nid = %d'),
array(t('Demote the selected posts'), 'UPDATE {node} SET promote = 0 WHERE nid = %d'),
array(t('Unpublish the selected posts'), 'UPDATE {node} SET status = 0 WHERE nid = %d')
);
// Handle operations:
if (empty($_SESSION['node_overview_filter'])) {
$_SESSION['node_overview_filter'] = 0;
}
$op = $_POST['op'];
if ($op == t('Filter') && isset($_POST['edit']['filter'])) {
$_SESSION['node_overview_filter'] = $_POST['edit']['filter'];
}
if ($op == t('Update') && isset($_POST['edit']['operation']) && isset($_POST['edit']['status'])) {
$operation = $operations[$_POST['edit']['operation']][1];
foreach ($_POST['edit']['status'] as $nid => $value) {
if ($value) {
db_query($operation, $nid);
}
}
drupal_set_message(t('the update has been performed.'));
}
$filter = $_SESSION['node_overview_filter'];
// Render filter form:
$options = array();
foreach ($filters as $key => $value) {
$options[] = $value[0];
}
$form = form_select(NULL, 'filter', $filter, $options);
$form .= form_submit(t('Filter'));
$output .= '
'. t('Filter options') .'
';
$output .= "
$form
";
// Render operations form:
$result = pager_query('SELECT n.*, u.name, u.uid FROM {node} n INNER JOIN {users} u ON n.uid = u.uid '. $filters[$filter][1], 50);
// Make sure the update controls are disabled if we don't have any rows to select from.
$disabled = !db_num_rows($result);
$options = array();
foreach ($operations as $key => $value) {
$options[] = $value[0];
}
$form = form_select(NULL, 'operation', 0, $options, NULL, ($disabled ? 'disabled="disabled"' : ''));
$form .= form_submit(t('Update'), 'op', ($disabled ? array('disabled' => 'disabled') : array()));
$output .= '
';
$output .= theme('table', $header, $rows);
return form($output);
}
/**
* Menu callback; presents the interface for setting node defaults.
*/
function node_default_settings() {
$op = $_POST['op'];
$edit = $_POST['edit'];
if ($op == t('Save configuration')) {
// Save the configuration options:
foreach ($edit as $name => $value) {
variable_set($name, $value);
}
drupal_set_message(t('the content settings have been saved.'));
}
if ($op == t('Reset to defaults')) {
// Reset the configuration options to their default value:
foreach ($edit as $name => $value) {
variable_del($name);
}
drupal_set_message(t('the content settings have been reset to their default values.'));
}
$header = array_merge(array(t('type')), array_keys(node_invoke_nodeapi($node, 'settings')));
foreach (node_list() as $type) {
$node->type = $type;
$cols = array();
foreach (node_invoke_nodeapi($node, 'settings') as $setting) {
$cols[] = array('data' => $setting, 'align' => 'center', 'width' => 55);
}
$rows[] = array_merge(array(node_invoke($node, 'node_name')), $cols);
}
$output .= theme('table', $header, $rows);
$output .= form_submit(t('Save configuration'));
$output .= form_submit(t('Reset to defaults'));
print theme('page', form($output));
}
/**
* Generates an overview table of older revisions of a node.
*/
function node_revision_overview($nid) {
if (user_access('administer nodes')) {
$node = node_load(array('nid' => $nid));
drupal_set_title($node->title);
if ($node->revisions) {
$header = array(t('older revisions'), array('colspan' => '3', 'data' => t('operations')));
foreach ($node->revisions as $key => $revision) {
$rows[] = array(t('revision #%r revised by %u on %d', array('%r' => $key, '%u' => format_name(user_load(array('uid' => $revision['uid']))), '%d' => format_date($revision['timestamp'], 'small'))) . ($revision['history'] ? ' '. $revision['history'] .'' : ''), l(t('view'), "node/$node->nid", array(), "revision=$key"), l(t('rollback'), "node/$node->nid/rollback-revision/$key"), l(t('delete'), "node/$node->nid/delete-revision/$key"));
}
$output .= theme('table', $header, $rows);
}
}
return $output;
}
/**
* Return the revision with the specified revision number.
*/
function node_revision_load($node, $revision) {
return $node->revisions[$revision]['node'];
}
/**
* Create and return a new revision of the given node.
*/
function node_revision_create($node) {
global $user;
// "Revision" is the name of the field used to indicicate that we have to
// create a new revision of a node.
if ($node->nid && $node->revision) {
$prev = node_load(array('nid' => $node->nid));
$node->revisions = $prev->revisions;
unset($prev->revisions);
$node->revisions[] = array('uid' => $user->uid, 'timestamp' => time(), 'node' => $prev, 'history' => $node->history);
}
return $node;
}
/**
* Roll back to the revision with the specified revision number.
*/
function node_revision_rollback($nid, $revision) {
global $user;
if (user_access('administer nodes')) {
$node = node_load(array('nid' => $nid));
// Extract the specified revision:
$rev = $node->revisions[$revision]['node'];
// Inherit all the past revisions:
$rev->revisions = $node->revisions;
// Save the original/current node:
$rev->revisions[] = array('uid' => $user->uid, 'timestamp' => time(), 'node' => $node);
// Remove the specified revision:
unset($rev->revisions[$revision]);
// Save the node:
foreach ($node as $key => $value) {
$filter[] = $key;
}
node_save($rev, $filter);
drupal_set_message(t('rolled back to revision #%revision of "%title"', array('%revision' => $revision, '%title' => $node->title)));
drupal_goto('node/'. $nid .'/revisions');
}
}
/**
* Delete the revision with specified revision number.
*/
function node_revision_delete($nid, $revision) {
if (user_access('administer nodes')) {
$node = node_load(array('nid' => $nid));
unset($node->revisions[$revision]);
node_save($node, array('nid', 'revisions'));
drupal_set_message(t('deleted revision #%revision of "%title"', array('%revision' => $revision, '%title' => $node->title)));
drupal_goto('node/'. $nid . (count($node->revisions) ? '/revisions' : ''));
}
}
/**
* Return a list of all the existing revision numbers.
*/
function node_revision_list($node) {
if (is_array($node->revisions)) {
return array_keys($node->revisions);
}
else {
return array();
}
}
/**
* Menu callback; presents the content administration overview.
*/
function node_admin() {
$op = $_POST['op'];
$edit = $_POST['edit'];
if (empty($op)) {
$op = arg(2);
}
// Compile a list of the administrative links:
switch ($op) {
case 'search':
$output = search_type('node', url('admin/node/search'), $_POST['keys']);
break;
case 'delete':
$output = node_delete(array('nid' => arg(3)));
break;
default:
$output = node_admin_nodes();
}
print theme('page', $output);
}
/**
* Implementation of hook_block().
*/
function node_block($op = 'list', $delta = 0) {
if ($op == 'list') {
$blocks[0]['info'] = t('Syndicate');
return $blocks;
}
else {
$block['subject'] = t('Syndicate');
$block['content'] = theme('xml_icon', url('node/feed'));
return $block;
}
}
/**
* A generic function for generating RSS feeds from a set of nodes.
*
* @param $nodes
* An object as returned by db_query() which contains the nid field.
* @param $channel
* An associative array containing title, link, description and other keys.
* The link should be an absolute URL.
*/
function node_feed($nodes = 0, $channel = array()) {
global $base_url, $languages;
if (!$nodes) {
$nodes = db_query_range('SELECT nid FROM {node} WHERE promote = 1 AND status = 1 ORDER BY created DESC', 0, 15);
}
while ($node = db_fetch_object($nodes)) {
// Load the specified node:
$item = node_load(array('nid' => $node->nid));
$link = url("node/$node->nid", NULL, NULL, 1);
$items .= format_rss_item($item->title, $link, ($item->teaser ? $item->teaser : $item->body), array('pubDate' => date('r', $item->changed)));
}
$channel_defaults = array(
'version' => '0.92',
'title' => variable_get('site_name', 'drupal') .' - '. variable_get('site_slogan', ''),
'link' => $base_url,
'description' => variable_get('site_mission', ''),
'language' => (($key = reset(array_keys($languages))) ? $key : 'en')
);
$channel = array_merge($channel_defaults, $channel);
$output = "\n";
$output .= "]>\n";
$output .= "\n";
$output .= format_rss_channel($channel['title'], $channel['link'], $channel['description'], $items, $channel['language']);
$output .= "\n";
drupal_set_header('Content-Type: text/xml; charset=utf-8');
print $output;
}
/**
* Preform validation checks on the given node.
*/
function node_validate($node) {
global $user;
// Convert the node to an object, if necessary.
$node = array2object($node);
// Validate the title field.
if (isset($node->title)) {
$node->title = strip_tags($node->title);
if (!$node->title) {
form_set_error('title', t('You have to specify a valid title.'));
}
}
// By default, auto-generate the teaser.
$node->teaser = node_teaser($node->body);
// Create a new revision when required.
$node = node_revision_create($node);
if (user_access('administer nodes')) {
// Set up default values, if required.
if (!$node->created) {
$node->created = time();
}
if (!$node->date) {
$node->date = format_date($node->created, 'custom', 'Y-m-d H:i O');
}
if (!is_numeric($node->status)) {
$node->status = 1;
}
// Validate the "authored by" field.
if (empty($node->name) || empty($node->uid)){
// 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 anomymous user we set the user ID to 0.
$node->uid = 0;
}
else if ($account = user_load(array('name' => $node->name))) {
$node->uid = $account->uid;
}
else {
form_set_error('name', t("The name '%u' does not exist.", array ('%u' => $node->name)));
}
// Validate the "authored on" field.
if (strtotime($node->date) != -1) {
$node->created = strtotime($node->date);
}
else {
form_set_error('date', t('You have to specifiy a valid date.'));
}
}
else {
// Validate for normal users:
$node->uid = $user->uid ? $user->uid : 0;
// Force defaults in case people modify the form:
$node->status = variable_get("node_status_$node->type", 1);
$node->promote = variable_get("node_promote_$node->type", 1);
$node->moderate = variable_get("node_moderate_$node->type", 0);
$node->sticky = variable_get("node_sticky_$node->type", 0);
$node->revision = variable_get("node_revision_$node->type", 0);
unset($node->created);
}
// Do node-type-specific validation checks.
node_invoke($node, 'validate');
node_invoke_nodeapi($node, 'validate');
$node->validated = TRUE;
return $node;
}
/**
* Generate the node editing form.
*/
function node_form($edit) {
// Validate the node if we don't already know the errors.
if (!$edit->validated) {
$edit = node_validate($edit);
}
// Prepend extra node form elements.
$form = implode('', node_invoke_nodeapi($edit, 'form pre'));
// Get the node-specific bits.
// We can't use node_invoke() because $param must be passed by reference.
$function = node_get_module_name($edit) .'_form';
if (function_exists($function)) {
$form .= $function($edit, $param);
}
// Append extra node form elements.
$form .= implode('', node_invoke_nodeapi($edit, 'form post'));
$output .= '
';
// Add the admin-specific parts/
if (user_access('administer nodes')) {
$output .= '
';
$output .= form_textfield(t('Title'), 'title', $edit->title, 60, 128, NULL, NULL, TRUE);
// Add the node-type-specific fields.
$output .= $form;
// Add the hidden fields.
if ($edit->nid) {
$output .= form_hidden('nid', $edit->nid);
}
if (isset($edit->uid)) {
// The use of isset() is mandatory in the context of user IDs, because
// user ID 0 denotes the anonymous user.
$output .= form_hidden('uid', $edit->uid);
}
if ($edit->created) {
$output .= form_hidden('created', $edit->created);
}
$output .= form_hidden('type', $edit->type);
// Add the buttons.
$output .= form_submit(t('Preview'));
if (!form_get_errors()) {
if ($edit->title && $edit->type) {
$output .= form_submit(t('Submit'));
}
elseif (!variable_get('node_preview', 0)) {
$output .= form_submit(t('Submit'));
}
}
if ($edit->nid && node_access('delete', $edit)) {
$output .= form_submit(t('Delete'));
}
$output .= '
';
$extra = node_invoke_nodeapi($edit, 'form param');
foreach ($extra as $key => $value) {
if (is_array($value)) {
$param[$key] = array_merge($param[$key], $value);
}
else {
$param[$key] = $value;
}
}
return form($output, ($param['method'] ? $param['method'] : 'post'), $param['action'], array_merge($param['options'], array('id' => 'node-form')));
}
/**
* Present a node submission form or a set of links to such forms.
*/
function node_add($type) {
global $user;
$edit = $_POST['edit'];
// If a node type has been specified, validate its existence.
if ($type && node_access('create', $type)) {
// Initialize settings:
$node = array('uid' => $user->uid, 'name' => $user->name, 'type' => $type);
// Allow the following fields to be initialized via $_GET (e.g. for use
// with a "blog it" bookmarklet):
foreach (array('title', 'teaser', 'body') as $field) {
if ($_GET['edit'][$field]) {
$node[$field] = $_GET['edit'][$field];
}
}
$output = node_form($node);
drupal_set_title(t('Submit %name', array('%name' => node_invoke($node, 'node_name'))));
}
else {
// If no (valid) node type has been provided, display a node type overview.
foreach (node_list() as $type) {
if (node_access('create', $type)) {
$output .= '
';
}
}
$output = t('Choose the appropriate item from the list:') .'
'. $output .'
';
}
return $output;
}
/**
* Present a node editing form.
*/
function node_edit($id) {
global $user;
$node = node_load(array('nid' => $id));
drupal_set_title($node->title);
$output = node_form($node);
return $output;
}
/**
* Generate a node preview, including a form for further edits.
*/
function node_preview($node) {
// Convert the array to an object:
$node = array2object($node);
if (node_access('create', $node) || node_access('update', $node)) {
// Load the user's name when needed:
if (isset($node->name)) {
// The use of isset() is mandatory in the context of user IDs, because
// user ID 0 denotes the anonymous user.
if ($user = user_load(array('name' => $node->name))) {
$node->uid = $user->uid;
}
else {
$node->uid = 0; // anonymous user
}
}
else if ($node->uid) {
$user = user_load(array('uid' => $node->uid));
$node->name = $user->name;
}
// Set the created time when needed:
if (empty($node->created)) {
$node->created = time();
}
$node->changed = time();
// Extract a teaser:
$node->teaser = node_teaser($node->body);
// Display a preview of the node:
if ($node->teaser && $node->teaser != $node->body) {
$output = '
'. t('Preview trimmed version') .'
';
$output .= node_view($node, 1);
$output .= '
'. t('The trimmed version of your post shows what your post looks like when promoted to the main page or when exported for syndication. You can insert the delimiter "<!--break-->" (without the quotes) to fine-tune where your post gets split.') .'
';
$output .= '
'. t('Preview full version') .'
';
$output .= node_view($node, 0);
}
else {
$output .= node_view($node, 0);
}
$output .= node_form($node);
$name = node_invoke($node, 'node_name');
drupal_set_breadcrumb(array(l(t('Home'), NULL), l(t('create content'), 'node/add'), l(t('Submit %name', array('%name' => $name)), 'node/add/'. $node->type)));
return $output;
}
}
/**
* Respond to a user's submission of new or changed node content.
*/
function node_submit($node) {
global $user;
// Fix up the node when required:
$node = node_validate($node);
// If something went wrong, go back to the preview form.
if (form_get_errors()) {
return node_preview($node);
}
// Prepare the node's body:
if ($node->nid) {
// Check whether the current user has the proper access rights to
// perform this operation:
if (node_access('update', $node)) {
$node->nid = node_save($node);
watchdog('special', t('%node-type: updated "%node-title"', array('%node-type' => t($node->type), '%node-title' => $node->title)), l(t('view'), 'node/'. $node->nid));
$msg = t('the %name was updated.', array ('%name' => node_invoke($node, 'node_name')));
}
}
else {
// Check whether the current user has the proper access rights to
// perform this operation:
if (node_access('create', $node)) {
$node->nid = node_save($node);
watchdog('special', t('%node-type: added "%node-title"', array('%node-type' => t("$node->type"), '%node-title' => $node->title)), l(t('view'), "node/$node->nid"));
$msg = t('your %name was created.', array ('%name' => node_invoke($node, 'node_name')));
}
}
// Node was submitted successfully. Redirect to the viewing page.
drupal_set_message($msg);
drupal_goto('node/'. $node->nid);
}
/**
* Ask for confirmation, and delete the node.
*/
function node_delete($edit) {
$node = node_load(array('nid' => $edit['nid']));
if (node_access('delete', $node)) {
if ($edit['confirm']) {
// Delete the specified node:
db_query('DELETE FROM {node} WHERE nid = %d', $node->nid);
// Call the node-specific callback (if any):
node_invoke($node, 'delete');
node_invoke_nodeapi($node, 'delete');
// Clear the cache so an anonymous poster can see the node being deleted.
cache_clear_all();
watchdog('special', t('%node-type: deleted "%node-title"', array('%node-type' => t($node->type), '%node-title' => $node->title)));
$output = t('The node has been deleted.');
}
else {
$output .= form_item(t('Confirm deletion'), $node->title);
$output .= form_hidden('nid', $node->nid);
$output .= form_hidden('confirm', 1);
$output .= form_submit(t('Delete'));
$output = form($output);
}
}
return $output;
}
/**
* Generate a listing of promoted nodes.
*/
function node_page_default() {
$result = pager_query('SELECT DISTINCT(n.nid), n.type, n.sticky, n.created FROM {node} n '. node_access_join_sql() .' WHERE n.promote = 1 AND n.status = 1 AND '. node_access_where_sql() .' ORDER BY n.sticky DESC, n.created DESC', variable_get('default_nodes_main', 10));
if (db_num_rows($result)) {
drupal_set_html_head('');
$output = '';
while ($node = db_fetch_object($result)) {
$output .= node_view(node_load(array('nid' => $node->nid, 'type' => $node->type)), 1);
}
$output .= theme('pager', NULL, variable_get('default_nodes_main', 10));
}
else {
$output = t("
Welcome to your new Drupal-powered website. This message will guide you through your first steps with Drupal, and will disappear once you have posted your first piece of content.
Drupal comes with various modules, each of which contains a specific piece of functionality. You should visit the module list and enable those modules which suit your website's needs.
Themes handle the presentation of your website. You can use one of the existing themes, modify them or create your own from scratch.
We suggest you look around the administration section and explore the various options Drupal offers you. For more information, you can refer to the Drupal handbook online.
", array('%drupal' => 'http://www.drupal.org/', '%register' => url('user/register'), '%admin' => url('admin'), '%config' => url('admin'), '%modules' => url('admin/modules'), '%themes' => url('admin/themes'), '%handbook' => 'http://www.drupal.org/handbook'));
}
return $output;
}
function node_old_url($nid = 0) {
drupal_goto("node/$nid");
}
/**
* Menu callback; dispatches control to the appropriate operation handler.
*/
function node_page() {
$op = $_POST['op'] ? $_POST['op'] : arg(1);
$edit = $_POST['edit'];
// Temporary solution for backward compatibility.
if (is_numeric($op)) {
$op = arg(2) ? arg(2) : 'view';
}
switch ($op) {
case 'feed':
node_feed();
return;
case 'add':
print theme('page', node_add(arg(2)));
break;
case 'edit':
print theme('page', node_edit(arg(1)));
break;
case 'revisions':
print theme('page', node_revision_overview(arg(1)));
break;
case 'rollback-revision':
node_revision_rollback(arg(1), arg(3));
break;
case 'delete-revision':
node_revision_delete(arg(1), arg(3));
break;
case 'view':
if (is_numeric(arg(1))) {
if ($node = node_load(array('nid' => arg(1)), $_GET['revision'])) {
print theme('page', node_show($node, arg(3)), $node->title);
}
else {
drupal_not_found();
}
}
break;
case t('Preview'):
$edit = node_validate($edit);
print theme('page', node_preview($edit), t('Preview %name', array('%name' => $name)));
break;
case t('Submit'):
drupal_set_title(t('Submit %name', array('%name' => $name)));
print theme('page', node_submit($edit));
break;
case t('Delete'):
print theme('page', node_delete($edit), t('Delete %name', array('%name' => $name)));
break;
default:
print theme('page', node_page_default(), '');
}
}
/**
* Implementation of hook_update_index().
*
* Returns an array of values to dictate how to update the search index
* for this particular type of node.
*
* "last_update"'s value is used with variable_set to set the
* last time this node type had an index update run.
*
* "node_type"'s value is used to identify the node type in the search
* index.
*
* "select"'s value is used to select the node id and text fields from
* the table we are indexing. In this case, we also check against the
* last run date for the nodes update.
*/
function node_update_index() {
return array('last_update' => 'node_cron_last',
'node_type' => 'node',
'select' => "SELECT n.nid as lno, n.title as text1, n.body as text2 FROM {node} n WHERE n.status = 1 AND moderate = 0 and (created > " . variable_get('node_cron_last', 1) . " or changed > " . variable_get('node_cron_last', 1) . ")");
}
/**
* Implementation of hook_nodeapi().
*/
function node_nodeapi(&$node, $op, $arg = 0) {
switch ($op) {
case 'settings':
$output[t('publish')] = form_checkbox('', "node_status_$node->type", 1, variable_get("node_status_$node->type", 1));
$output[t('promote')] = form_checkbox('', "node_promote_$node->type", 1, variable_get("node_promote_$node->type", 1));
$output[t('moderate')] = form_checkbox('', "node_moderate_$node->type", 1, variable_get("node_moderate_$node->type", 0));
$output[t('sticky')] = form_checkbox('', "node_sticky_$node->type", 1, variable_get("node_sticky_$node->type", 0));
$output[t('revision')] = form_checkbox('', "node_revision_$node->type", 1, variable_get("node_revision_$node->type", 0));
return $output;
case 'fields':
return array('nid', 'uid', 'type', 'title', 'teaser', 'body', 'revisions', 'status', 'promote', 'moderate', 'sticky', 'created', 'changed');
}
}
/**
* @defgroup node_access Node access rights
* @{
* The node access system determines who can do what to which nodes.
*
* In determining access rights for a node, node_access() first checks
* whether the user has the "administer nodes" permission. Such users have
* unrestricted access to all nodes. Then the node module's hook_access()
* is called, and a TRUE or FALSE return value will grant or deny access.
* This allows, for example, the blog module to always grant access to the
* blog author, and for the book module to always deny editing access to
* PHP pages.
*
* If node module does not intervene (returns NULL), then the
* node_access table is used to determine access. All node access
* modules are queried using hook_node_grants() to assemble a list of
* "grant IDs" for the user. This list is compared against the table.
* If any row contains the node ID in question (or 0, which stands for "all
* nodes"), one of the grant IDs returned, and a value of TRUE for the
* operation in question, then access is granted. Note that this table is a
* list of grants; any matching row is sufficient to grant access to the
* node.
*
* In node listings, the process above is followed except that
* hook_access() is not called on each node for performance reasons and for
* proper functioning of the pager system. When adding a node listing to your
* module, be sure to use node_access_join_sql() and node_access_where_sql() to add
* the appropriate clauses to your query for access checks.
*
* To see how to write a node access module of your own, see
* node_access_example.module.
*/
/**
* Determine whether the current user may perform the given operation on the
* specified node.
*
* @param $op
* The operation to be performed on the node. Possible values are:
* - "view"
* - "update"
* - "delete"
* @param $node
* The node object (or node array) on which the operation is to be performed.
* @return
* TRUE if the operation may be performed.
*/
function node_access($op, $node = NULL) {
if (user_access('administer nodes')) {
return TRUE;
}
// Convert the node to an object if necessary:
$node = array2object($node);
// Can't use node_invoke(), because the access hook takes the $op parameter
// before the $node parameter.
$access = module_invoke(node_get_module_name($node), 'access', $op, $node);
if (!is_null($access)) {
return $access;
}
// If the module did not override the access rights, use those set in the
// node_access table.
if ($node->nid && $node->status) {
$sql = 'SELECT COUNT(*) FROM {node_access} WHERE (nid = 0 OR nid = %d) AND CONCAT(realm, gid) IN (';
$grants = array();
foreach (node_access_grants($op, $uid) as $realm => $gids) {
foreach ($gids as $gid) {
$grants[] = "'". $realm . $gid ."'";
}
}
$sql .= implode(',', $grants) .') AND grant_'. $op .' = 1';
$result = db_query($sql, $node->nid);
return (db_result($result));
}
return FALSE;
}
/**
* Generate an SQL join clause for use in fetching a node listing.
*
* @param $node_alias
* If the node table has been given an SQL alias other than the default
* "n", that must be passed here.
* @param $node_access_alias
* If the node_access table has been given an SQL alias other than the default
* "na", that must be passed here.
* @return
* An SQL join clause.
*/
function node_access_join_sql($node_alias = 'n', $node_access_alias = 'na') {
if (user_access('administer nodes')) {
return '';
}
$sql = 'INNER JOIN {node_access} '. $node_access_alias;
$sql .= ' ON ('. $node_access_alias .'.nid = 0 OR '. $node_access_alias .'.nid = '. $node_alias .'.nid)';
return $sql;
}
/**
* Generate an SQL where clause for use in fetching a node listing.
*
* @param $op
* The operation that must be allowed to return a node.
* @param $node_access_alias
* If the node_access table has been given an SQL alias other than the default
* "na", that must be passed here.
* @return
* An SQL where clause.
*/
function node_access_where_sql($op = 'view', $node_access_alias = 'na') {
if (user_access('administer nodes')) {
/**
* This number is being used in a SQL query in a boolean nature.
* It is "'1'" instead of "1" for database compatibility, as both
* Postgres and Mysql treat it as boolean in this case.
*/
return "'1'";
}
$sql = $node_access_alias .'.grant_'. $op .' = 1 AND CONCAT('. $node_access_alias .'.realm, '. $node_access_alias .'.gid) IN (';
$grants = array();
foreach (node_access_grants($op) as $realm => $gids) {
foreach ($gids as $gid) {
$grants[] = "'". $realm . $gid ."'";
}
}
$sql .= implode(',', $grants) .')';
return $sql;
}
/**
* Fetch an array of permission IDs granted to the given user ID.
*
* The implementation here provides only the universal "all" grant. A node
* access module should implement hook_node_grants() to provide a grant
* list for the user.
*
* @param $op
* The operation that the user is trying to perform.
* @param $uid
* The user ID performing the operation. If omitted, the current user is used.
* @return
* An associative array in which the keys are realms, and the values are
* arrays of grants for those realms.
*/
function node_access_grants($op, $uid = NULL) {
global $user;
if (isset($uid)) {
$user_object = user_load(array('uid' => $uid));
}
else {
$user_object = $user;
}
return array_merge(array('all' => array(0)), module_invoke_all('node_grants', $user_object, $op));
}
/**
* @} end of defgroup node_access
*/
?>